| Message ID | 20220329223956.486608-1-ndesaulniers@google.com (mailing list archive) |
|---|---|
| State | Superseded |
| Headers | show |
| Series | [v2] net, uapi: remove inclusion of arpa/inet.h | expand |
| Context | Check | Description |
|---|---|---|
| netdev/tree_selection | success | Not a local patch |
On Tue, 29 Mar 2022 15:39:56 -0700 Nick Desaulniers wrote: > Testing out CONFIG_UAPI_HEADER_TEST=y with a prebuilt Bionic sysroot > from Android's SDK, I encountered an error: > > HDRTEST usr/include/linux/fsi.h > In file included from <built-in>:1: > In file included from ./usr/include/linux/tipc_config.h:46: > prebuilts/ndk/toolchains/llvm/prebuilt/linux-x86_64/sysroot/usr/include/arpa/inet.h:39:1: > error: unknown type name 'in_addr_t' > in_addr_t inet_addr(const char* __s); > ^ > > This is because Bionic has a bug in its inclusion chain. I sent a patch > to fix that, but looking closer at include/uapi/linux/tipc_config.h, > there's a comment that it includes arpa/inet.h for ntohs; > but ntohs is not defined in any UAPI header. For now, reuse the > definitions from include/linux/byteorder/generic.h, since the various > conversion functions do exist in UAPI headers: > include/uapi/linux/byteorder/big_endian.h > include/uapi/linux/byteorder/little_endian.h > > Link: https://android-review.googlesource.com/c/platform/bionic/+/2048127 > Signed-off-by: Nick Desaulniers <ndesaulniers@google.com> > --- > include/uapi/linux/tipc_config.h | 32 ++++++++++++++++---------------- > 1 file changed, 16 insertions(+), 16 deletions(-) > > diff --git a/include/uapi/linux/tipc_config.h b/include/uapi/linux/tipc_config.h > index 4dfc05651c98..2c494b7ae008 100644 > --- a/include/uapi/linux/tipc_config.h > +++ b/include/uapi/linux/tipc_config.h > @@ -43,10 +43,6 @@ > #include <linux/tipc.h> > #include <asm/byteorder.h> > > -#ifndef __KERNEL__ > -#include <arpa/inet.h> /* for ntohs etc. */ > -#endif Hm, how do we know no user space depends on this include? If nobody screams at us we can try, but then it needs to go into -next, and net-next is closed ATM, you'll need to repost once the merge window is over. > /* > * Configuration > * > @@ -257,6 +253,10 @@ struct tlv_desc { > #define TLV_SPACE(datalen) (TLV_ALIGN(TLV_LENGTH(datalen))) > #define TLV_DATA(tlv) ((void *)((char *)(tlv) + TLV_LENGTH(0))) > > +#define __htonl(x) __cpu_to_be32(x) > +#define __htons(x) __cpu_to_be16(x) > +#define __ntohs(x) __be16_to_cpu(x) > + > static inline int TLV_OK(const void *tlv, __u16 space) > { > /* > @@ -269,33 +269,33 @@ static inline int TLV_OK(const void *tlv, __u16 space) > */ > > return (space >= TLV_SPACE(0)) && > - (ntohs(((struct tlv_desc *)tlv)->tlv_len) <= space); > + (__ntohs(((struct tlv_desc *)tlv)->tlv_len) <= space); Also why add the defines / macros? We could switch to __cpu_to_be16() etc. directly, it seems.
On Tue, Mar 29, 2022 at 4:01 PM Jakub Kicinski <kuba@kernel.org> wrote: > > On Tue, 29 Mar 2022 15:39:56 -0700 Nick Desaulniers wrote: > > Testing out CONFIG_UAPI_HEADER_TEST=y with a prebuilt Bionic sysroot > > from Android's SDK, I encountered an error: > > > > HDRTEST usr/include/linux/fsi.h > > In file included from <built-in>:1: > > In file included from ./usr/include/linux/tipc_config.h:46: > > prebuilts/ndk/toolchains/llvm/prebuilt/linux-x86_64/sysroot/usr/include/arpa/inet.h:39:1: > > error: unknown type name 'in_addr_t' > > in_addr_t inet_addr(const char* __s); > > ^ > > > > This is because Bionic has a bug in its inclusion chain. I sent a patch > > to fix that, but looking closer at include/uapi/linux/tipc_config.h, > > there's a comment that it includes arpa/inet.h for ntohs; > > but ntohs is not defined in any UAPI header. For now, reuse the > > definitions from include/linux/byteorder/generic.h, since the various > > conversion functions do exist in UAPI headers: > > include/uapi/linux/byteorder/big_endian.h > > include/uapi/linux/byteorder/little_endian.h > > > > Link: https://android-review.googlesource.com/c/platform/bionic/+/2048127 > > Signed-off-by: Nick Desaulniers <ndesaulniers@google.com> > > --- > > include/uapi/linux/tipc_config.h | 32 ++++++++++++++++---------------- > > 1 file changed, 16 insertions(+), 16 deletions(-) > > > > diff --git a/include/uapi/linux/tipc_config.h b/include/uapi/linux/tipc_config.h > > index 4dfc05651c98..2c494b7ae008 100644 > > --- a/include/uapi/linux/tipc_config.h > > +++ b/include/uapi/linux/tipc_config.h > > @@ -43,10 +43,6 @@ > > #include <linux/tipc.h> > > #include <asm/byteorder.h> > > > > -#ifndef __KERNEL__ > > -#include <arpa/inet.h> /* for ntohs etc. */ > > -#endif > > Hm, how do we know no user space depends on this include? Without the ability to scan all source code in existence, I guess I can't prove or disprove that either way. If this is a reference to "thou shall not break userspace," I don't think that was in reference to UAPI headers, libc's, or inclusion chains. Worst case, someone might have to #include <arpa/inet.h> if they were relying on transitive dependencies from <linux/tipc_config.h>. I don't think we should be helping people write bad code with such transitive dependencies though. > > If nobody screams at us we can try, but then it needs to go into -next, > and net-next is closed ATM, you'll need to repost once the merge window > is over. Ack. > > > /* > > * Configuration > > * > > @@ -257,6 +253,10 @@ struct tlv_desc { > > #define TLV_SPACE(datalen) (TLV_ALIGN(TLV_LENGTH(datalen))) > > #define TLV_DATA(tlv) ((void *)((char *)(tlv) + TLV_LENGTH(0))) > > > > +#define __htonl(x) __cpu_to_be32(x) > > +#define __htons(x) __cpu_to_be16(x) > > +#define __ntohs(x) __be16_to_cpu(x) > > + > > static inline int TLV_OK(const void *tlv, __u16 space) > > { > > /* > > @@ -269,33 +269,33 @@ static inline int TLV_OK(const void *tlv, __u16 space) > > */ > > > > return (space >= TLV_SPACE(0)) && > > - (ntohs(((struct tlv_desc *)tlv)->tlv_len) <= space); > > + (__ntohs(((struct tlv_desc *)tlv)->tlv_len) <= space); > > Also why add the defines / macros? > We could switch to __cpu_to_be16() etc. directly, it seems. Sure, I thought they might be more readable, but whatever you all prefer. Will send a v3 once the merge window closes.
diff --git a/include/uapi/linux/tipc_config.h b/include/uapi/linux/tipc_config.h index 4dfc05651c98..2c494b7ae008 100644 --- a/include/uapi/linux/tipc_config.h +++ b/include/uapi/linux/tipc_config.h @@ -43,10 +43,6 @@ #include <linux/tipc.h> #include <asm/byteorder.h> -#ifndef __KERNEL__ -#include <arpa/inet.h> /* for ntohs etc. */ -#endif - /* * Configuration * @@ -257,6 +253,10 @@ struct tlv_desc { #define TLV_SPACE(datalen) (TLV_ALIGN(TLV_LENGTH(datalen))) #define TLV_DATA(tlv) ((void *)((char *)(tlv) + TLV_LENGTH(0))) +#define __htonl(x) __cpu_to_be32(x) +#define __htons(x) __cpu_to_be16(x) +#define __ntohs(x) __be16_to_cpu(x) + static inline int TLV_OK(const void *tlv, __u16 space) { /* @@ -269,33 +269,33 @@ static inline int TLV_OK(const void *tlv, __u16 space) */ return (space >= TLV_SPACE(0)) && - (ntohs(((struct tlv_desc *)tlv)->tlv_len) <= space); + (__ntohs(((struct tlv_desc *)tlv)->tlv_len) <= space); } static inline int TLV_CHECK(const void *tlv, __u16 space, __u16 exp_type) { return TLV_OK(tlv, space) && - (ntohs(((struct tlv_desc *)tlv)->tlv_type) == exp_type); + (__ntohs(((struct tlv_desc *)tlv)->tlv_type) == exp_type); } static inline int TLV_GET_LEN(struct tlv_desc *tlv) { - return ntohs(tlv->tlv_len); + return __ntohs(tlv->tlv_len); } static inline void TLV_SET_LEN(struct tlv_desc *tlv, __u16 len) { - tlv->tlv_len = htons(len); + tlv->tlv_len = __htons(len); } static inline int TLV_CHECK_TYPE(struct tlv_desc *tlv, __u16 type) { - return (ntohs(tlv->tlv_type) == type); + return (__ntohs(tlv->tlv_type) == type); } static inline void TLV_SET_TYPE(struct tlv_desc *tlv, __u16 type) { - tlv->tlv_type = htons(type); + tlv->tlv_type = __htons(type); } static inline int TLV_SET(void *tlv, __u16 type, void *data, __u16 len) @@ -305,8 +305,8 @@ static inline int TLV_SET(void *tlv, __u16 type, void *data, __u16 len) tlv_len = TLV_LENGTH(len); tlv_ptr = (struct tlv_desc *)tlv; - tlv_ptr->tlv_type = htons(type); - tlv_ptr->tlv_len = htons(tlv_len); + tlv_ptr->tlv_type = __htons(type); + tlv_ptr->tlv_len = __htons(tlv_len); if (len && data) { memcpy(TLV_DATA(tlv_ptr), data, len); memset((char *)TLV_DATA(tlv_ptr) + len, 0, TLV_SPACE(len) - tlv_len); @@ -348,7 +348,7 @@ static inline void *TLV_LIST_DATA(struct tlv_list_desc *list) static inline void TLV_LIST_STEP(struct tlv_list_desc *list) { - __u16 tlv_space = TLV_ALIGN(ntohs(list->tlv_ptr->tlv_len)); + __u16 tlv_space = TLV_ALIGN(__ntohs(list->tlv_ptr->tlv_len)); list->tlv_ptr = (struct tlv_desc *)((char *)list->tlv_ptr + tlv_space); list->tlv_space -= tlv_space; @@ -404,9 +404,9 @@ static inline int TCM_SET(void *msg, __u16 cmd, __u16 flags, msg_len = TCM_LENGTH(data_len); tcm_hdr = (struct tipc_cfg_msg_hdr *)msg; - tcm_hdr->tcm_len = htonl(msg_len); - tcm_hdr->tcm_type = htons(cmd); - tcm_hdr->tcm_flags = htons(flags); + tcm_hdr->tcm_len = __htonl(msg_len); + tcm_hdr->tcm_type = __htons(cmd); + tcm_hdr->tcm_flags = __htons(flags); if (data_len && data) { memcpy(TCM_DATA(msg), data, data_len); memset((char *)TCM_DATA(msg) + data_len, 0, TCM_SPACE(data_len) - msg_len);
Testing out CONFIG_UAPI_HEADER_TEST=y with a prebuilt Bionic sysroot from Android's SDK, I encountered an error: HDRTEST usr/include/linux/fsi.h In file included from <built-in>:1: In file included from ./usr/include/linux/tipc_config.h:46: prebuilts/ndk/toolchains/llvm/prebuilt/linux-x86_64/sysroot/usr/include/arpa/inet.h:39:1: error: unknown type name 'in_addr_t' in_addr_t inet_addr(const char* __s); ^ This is because Bionic has a bug in its inclusion chain. I sent a patch to fix that, but looking closer at include/uapi/linux/tipc_config.h, there's a comment that it includes arpa/inet.h for ntohs; but ntohs is not defined in any UAPI header. For now, reuse the definitions from include/linux/byteorder/generic.h, since the various conversion functions do exist in UAPI headers: include/uapi/linux/byteorder/big_endian.h include/uapi/linux/byteorder/little_endian.h Link: https://android-review.googlesource.com/c/platform/bionic/+/2048127 Signed-off-by: Nick Desaulniers <ndesaulniers@google.com> --- include/uapi/linux/tipc_config.h | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) base-commit: 5efabdadcf4a5b9a37847ecc85ba71cf2eff0fcf