[PATCH] uapi: add bit-field padding for field alignment

[PATCH] uapi: add bit-field padding for field alignment

[James Tucker]

The C language does not specify the layout behavior of bit-fields. As a
consequence, compilers are free to do interesting things with these
fields, including reorder, split, pick size, etc. In this case, it was
observed that on x64, gcc and clang were using only two bytes between
tx_bytes and num_ipmasks in wgpeer, causing interoperability issues.

While non-native clients (i.e. wireguard-go) could be fixed, the problem
will keep on giving, as the layouts can be changed by compiler flags and
architectures, which will make portability for all non-C implementations
extremely difficult. Compilers also do not document their behavior well
in this regard.

Signed-off-by: James Tucker <jftucker@gmail.com>
---
 src/uapi.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/uapi.h b/src/uapi.h
index cd4b86b..bf38f48 100644
--- a/src/uapi.h
+++ b/src/uapi.h
@@ -107,6 +107,7 @@ struct wgpeer {
 
 	__u32 remove_me : 1; /* Set */
 	__u32 replace_ipmasks : 1; /* Set */
+	__u32 : 32-2; /* pad to force portable field size */
 
 	__u16 num_ipmasks; /* Get/Set */
 	__u16 persistent_keepalive_interval; /* Get/Set -- 0 = off, 0xffff = unset */
@@ -124,6 +125,7 @@ struct wgdevice {
 	__u32 replace_peer_list : 1; /* Set */
 	__u32 remove_private_key : 1; /* Set */
 	__u32 remove_preshared_key : 1; /* Set */
+	__u32 : 32-3; /* pad to force portable field size */
 
 	union {
 		__u16 num_peers; /* Get/Set */
-- 
2.11.0

Re: [PATCH] uapi: add bit-field padding for field alignment

[Jason A. Donenfeld]

I think I'm going to roll with a flags fix instead, like this:
https://git.zx2c4.com/WireGuard/commit/?id=45bd499f15debb0e2443b15f7ff1d0ef93950acc

This should eliminate all portability issues.

Re: [PATCH] uapi: add bit-field padding for field alignment

[James Tucker]

[-- Attachment #1: Type: text/plain, Size: 298 bytes --]

Thanks Jason!

On Mon, Jan 9, 2017 at 8:22 PM, Jason A. Donenfeld <Jason@zx2c4.com> wrote:

> I think I'm going to roll with a flags fix instead, like this:
> https://git.zx2c4.com/WireGuard/commit/?id=45bd499f15debb0e2443b15f7ff1d0
> ef93950acc
>
> This should eliminate all portability issues.
>

[-- Attachment #2: Type: text/html, Size: 746 bytes --]