diff options
author | Zack Weinberg <zackw@panix.com> | 2016-07-13 15:20:29 -0400 |
---|---|---|
committer | Zack Weinberg <zackw@panix.com> | 2016-09-23 08:43:56 -0400 |
commit | f2bea4da2e65b5d91a23a01fb2062bcec33974aa (patch) | |
tree | 466d8cc7eb9f7baa3a54a3aed84c12264d40bceb | |
parent | 11160cb76f56e0a711686e34881a4eaf1ad2fa0e (diff) | |
download | glibc-f2bea4da2e65b5d91a23a01fb2062bcec33974aa.zip glibc-f2bea4da2e65b5d91a23a01fb2062bcec33974aa.tar.gz glibc-f2bea4da2e65b5d91a23a01fb2062bcec33974aa.tar.bz2 |
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.
-rw-r--r-- | ChangeLog | 17 | ||||
-rw-r--r-- | include/bits/types/struct_osockaddr.h | 1 | ||||
-rw-r--r-- | inet/netinet/ether.h | 2 | ||||
-rw-r--r-- | inet/protocols/talkd.h | 1 | ||||
-rw-r--r-- | socket/Makefile | 3 | ||||
-rw-r--r-- | socket/bits/types/struct_osockaddr.h | 12 | ||||
-rw-r--r-- | socket/sys/socket.h | 8 | ||||
-rw-r--r-- | sysdeps/mach/hurd/net/if_ppp.h | 3 | ||||
-rw-r--r-- | sysdeps/unix/sysv/linux/net/if_ppp.h | 3 |
9 files changed, 42 insertions, 8 deletions
@@ -1,5 +1,22 @@ 2016-09-23 Zack Weinberg <zackw@panix.com> + * 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 <zackw@panix.com> + * bits/in.h, gmon/sys/gmon.h, inet/netinet/igmp.h * inet/protocols/routed.h, inet/protocols/talkd.h * inet/protocols/timed.h, io/fts.h, nptl_db/thread_db.h diff --git a/include/bits/types/struct_osockaddr.h b/include/bits/types/struct_osockaddr.h new file mode 100644 index 0000000..78f3188 --- /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 3dff523..0952b23 100644 --- a/inet/netinet/ether.h +++ b/inet/netinet/ether.h @@ -24,6 +24,7 @@ /* Get definition of `struct ether_addr'. */ #include <netinet/if_ether.h> +#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 34e2654..09bd8a9 100644 --- a/inet/protocols/talkd.h +++ b/inet/protocols/talkd.h @@ -53,6 +53,7 @@ #include <sys/types.h> #include <sys/socket.h> #include <stdint.h> +#include <bits/types/struct_osockaddr.h> /* * Client->server request message format. diff --git a/socket/Makefile b/socket/Makefile index 92450e8..6be5ec7 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 0000000..e0bf59d --- /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 c9f0f50..5be1b91 100644 --- a/socket/sys/socket.h +++ b/socket/sys/socket.h @@ -38,13 +38,7 @@ __BEGIN_DECLS #include <bits/socket.h> #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 <bits/types/struct_osockaddr.h> #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 b210d7f..8ee620b 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 9994982..31a20766 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. |