From f2bea4da2e65b5d91a23a01fb2062bcec33974aa Mon Sep 17 00:00:00 2001 From: Zack Weinberg Date: Wed, 13 Jul 2016 15:20:29 -0400 Subject: [PATCH] Installed-header hygiene (BZ#20366): conditionally defined structures. Several network-related structures are defined conditionally under __USE_MISC, but unconditionally used by other headers. The path of least resistance is usually to condition the uses on __USE_MISC as well. * sysdeps/mach/hurd/net/if_ppp.h * sysdeps/unix/sysv/linux/net/if_ppp.h: Only define struct ifpppstatsreq and struct ifpppcstatsreq if __USE_MISC is defined, to ensure struct ifreq is declared. * inet/netinet/ether.h: Condition all function prototypes on __USE_MISC, to ensure struct ether_addr is declared. sys/socket.h defines struct osockaddr only under __USE_MISC, whereas protocols/talkd.h requires it unconditionally. Here it doesn't make sense to condition the entire body of protocols/talkd.h on __USE_MISC. Rather than complicate sys/socket.h with a __need macro or duplicate the definition, I am introducing a new concept: tiny headers named bits/types/TYPE.h that define TYPE and nothing else. This can, I hope, ultimately replace *all* the __need macros. The guard macro for such headers will be __TYPE_defined, just in case application or third-party library code is looking at them. * socket/bits/types/struct_osockaddr.h: New header. * include/bits/types/struct_osockaddr.h: New wrapper. * socket/Makefile: Install the new header. * socket/sys/socket.h, inet/protocols/talkd.h: Refer to bits/types/struct_osockaddr.h for the definition of struct osockaddr. --- ChangeLog | 17 +++++++++++++++++ include/bits/types/struct_osockaddr.h | 1 + inet/netinet/ether.h | 2 ++ inet/protocols/talkd.h | 1 + socket/Makefile | 3 ++- socket/bits/types/struct_osockaddr.h | 12 ++++++++++++ socket/sys/socket.h | 8 +------- sysdeps/mach/hurd/net/if_ppp.h | 3 +++ sysdeps/unix/sysv/linux/net/if_ppp.h | 3 +++ 9 files changed, 42 insertions(+), 8 deletions(-) create mode 100644 include/bits/types/struct_osockaddr.h create mode 100644 socket/bits/types/struct_osockaddr.h diff --git a/ChangeLog b/ChangeLog index 81456f80d0..60500b47c8 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,20 @@ +2016-09-23 Zack Weinberg + + * sysdeps/mach/hurd/net/if_ppp.h + * sysdeps/unix/sysv/linux/net/if_ppp.h: + Only define struct ifpppstatsreq and struct ifpppcstatsreq + if __USE_MISC is defined, to ensure struct ifreq is declared. + + * inet/netinet/ether.h: Condition all function prototypes + on __USE_MISC, to ensure struct ether_addr is declared. + + * socket/bits/types/struct_osockaddr.h: New header. + * include/bits/types/struct_osockaddr.h: New wrapper. + * socket/Makefile: Install the new header. + * socket/sys/socket.h, inet/protocols/talkd.h: + Refer to bits/types/struct_osockaddr.h for the definition of + struct osockaddr. + 2016-09-23 Zack Weinberg * bits/in.h, gmon/sys/gmon.h, inet/netinet/igmp.h diff --git a/include/bits/types/struct_osockaddr.h b/include/bits/types/struct_osockaddr.h new file mode 100644 index 0000000000..78f3188596 --- /dev/null +++ b/include/bits/types/struct_osockaddr.h @@ -0,0 +1 @@ +#include "../../socket/bits/types/struct_osockaddr.h" diff --git a/inet/netinet/ether.h b/inet/netinet/ether.h index 3dff523b2f..0952b23f97 100644 --- a/inet/netinet/ether.h +++ b/inet/netinet/ether.h @@ -24,6 +24,7 @@ /* Get definition of `struct ether_addr'. */ #include +#ifdef __USE_MISC __BEGIN_DECLS /* Convert 48 bit Ethernet ADDRess to ASCII. */ @@ -49,5 +50,6 @@ extern int ether_line (const char *__line, struct ether_addr *__addr, char *__hostname) __THROW; __END_DECLS +#endif /* Use misc. */ #endif /* netinet/ether.h */ diff --git a/inet/protocols/talkd.h b/inet/protocols/talkd.h index 34e2654cfc..09bd8a90ba 100644 --- a/inet/protocols/talkd.h +++ b/inet/protocols/talkd.h @@ -53,6 +53,7 @@ #include #include #include +#include /* * Client->server request message format. diff --git a/socket/Makefile b/socket/Makefile index 92450e8522..6be5ec78f7 100644 --- a/socket/Makefile +++ b/socket/Makefile @@ -23,7 +23,8 @@ subdir := socket include ../Makeconfig headers := sys/socket.h sys/un.h bits/sockaddr.h bits/socket.h \ - bits/socket2.h sys/socketvar.h net/if.h + bits/socket2.h bits/types/struct_osockaddr.h \ + sys/socketvar.h net/if.h routines := accept bind connect getpeername getsockname getsockopt \ listen recv recvfrom recvmsg send sendmsg sendto \ diff --git a/socket/bits/types/struct_osockaddr.h b/socket/bits/types/struct_osockaddr.h new file mode 100644 index 0000000000..e0bf59d383 --- /dev/null +++ b/socket/bits/types/struct_osockaddr.h @@ -0,0 +1,12 @@ +#ifndef __osockaddr_defined +#define __osockaddr_defined 1 + +/* This is the 4.3 BSD `struct sockaddr' format, which is used as wire + format in the grotty old 4.3 `talk' protocol. */ +struct osockaddr +{ + unsigned short int sa_family; + unsigned char sa_data[14]; +}; + +#endif diff --git a/socket/sys/socket.h b/socket/sys/socket.h index c9f0f5080d..5be1b91a93 100644 --- a/socket/sys/socket.h +++ b/socket/sys/socket.h @@ -38,13 +38,7 @@ __BEGIN_DECLS #include #ifdef __USE_MISC -/* This is the 4.3 BSD `struct sockaddr' format, which is used as wire - format in the grotty old 4.3 `talk' protocol. */ -struct osockaddr - { - unsigned short int sa_family; - unsigned char sa_data[14]; - }; +# include #endif /* The following constants should be used for the second parameter of diff --git a/sysdeps/mach/hurd/net/if_ppp.h b/sysdeps/mach/hurd/net/if_ppp.h index b210d7fd06..8ee620bd03 100644 --- a/sysdeps/mach/hurd/net/if_ppp.h +++ b/sysdeps/mach/hurd/net/if_ppp.h @@ -119,6 +119,8 @@ struct ppp_option_data { int transmit; }; +/* 'struct ifreq' is only available from net/if.h under __USE_MISC. */ +#ifdef __USE_MISC struct ifpppstatsreq { struct ifreq b; struct ppp_stats stats; /* statistic information */ @@ -131,6 +133,7 @@ struct ifpppcstatsreq { #define ifr__name b.ifr_ifrn.ifrn_name #define stats_ptr b.ifr_ifru.ifru_data +#endif /* * Ioctl definitions. diff --git a/sysdeps/unix/sysv/linux/net/if_ppp.h b/sysdeps/unix/sysv/linux/net/if_ppp.h index 9994982fc0..31a20766f0 100644 --- a/sysdeps/unix/sysv/linux/net/if_ppp.h +++ b/sysdeps/unix/sysv/linux/net/if_ppp.h @@ -118,6 +118,8 @@ struct ppp_option_data { int transmit; }; +/* 'struct ifreq' is only available from net/if.h under __USE_MISC. */ +#ifdef __USE_MISC struct ifpppstatsreq { struct ifreq b; struct ppp_stats stats; /* statistic information */ @@ -130,6 +132,7 @@ struct ifpppcstatsreq { #define ifr__name b.ifr_ifrn.ifrn_name #define stats_ptr b.ifr_ifru.ifru_data +#endif /* * Ioctl definitions.