Commit | Line | Data |
---|---|---|
6f52b16c | 1 | /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ |
cfd280c9 CD |
2 | /* |
3 | * Compatibility interface for userspace libc header coordination: | |
4 | * | |
5 | * Define compatibility macros that are used to control the inclusion or | |
6 | * exclusion of UAPI structures and definitions in coordination with another | |
7 | * userspace C library. | |
8 | * | |
9 | * This header is intended to solve the problem of UAPI definitions that | |
10 | * conflict with userspace definitions. If a UAPI header has such conflicting | |
11 | * definitions then the solution is as follows: | |
12 | * | |
13 | * * Synchronize the UAPI header and the libc headers so either one can be | |
14 | * used and such that the ABI is preserved. If this is not possible then | |
15 | * no simple compatibility interface exists (you need to write translating | |
16 | * wrappers and rename things) and you can't use this interface. | |
17 | * | |
18 | * Then follow this process: | |
19 | * | |
20 | * (a) Include libc-compat.h in the UAPI header. | |
21 | * e.g. #include <linux/libc-compat.h> | |
22 | * This include must be as early as possible. | |
23 | * | |
24 | * (b) In libc-compat.h add enough code to detect that the comflicting | |
25 | * userspace libc header has been included first. | |
26 | * | |
27 | * (c) If the userspace libc header has been included first define a set of | |
28 | * guard macros of the form __UAPI_DEF_FOO and set their values to 1, else | |
29 | * set their values to 0. | |
30 | * | |
31 | * (d) Back in the UAPI header with the conflicting definitions, guard the | |
32 | * definitions with: | |
33 | * #if __UAPI_DEF_FOO | |
34 | * ... | |
35 | * #endif | |
36 | * | |
37 | * This fixes the situation where the linux headers are included *after* the | |
38 | * libc headers. To fix the problem with the inclusion in the other order the | |
39 | * userspace libc headers must be fixed like this: | |
40 | * | |
41 | * * For all definitions that conflict with kernel definitions wrap those | |
42 | * defines in the following: | |
43 | * #if !__UAPI_DEF_FOO | |
44 | * ... | |
45 | * #endif | |
46 | * | |
47 | * This prevents the redefinition of a construct already defined by the kernel. | |
48 | */ | |
49 | #ifndef _UAPI_LIBC_COMPAT_H | |
50 | #define _UAPI_LIBC_COMPAT_H | |
51 | ||
52 | /* We have included glibc headers... */ | |
53 | #if defined(__GLIBC__) | |
54 | ||
4a91cb61 | 55 | /* Coordinate with glibc net/if.h header. */ |
f0a3fdca | 56 | #if defined(_NET_IF_H) && defined(__USE_MISC) |
4a91cb61 MR |
57 | |
58 | /* GLIBC headers included first so don't define anything | |
59 | * that would already be defined. */ | |
60 | ||
61 | #define __UAPI_DEF_IF_IFCONF 0 | |
62 | #define __UAPI_DEF_IF_IFMAP 0 | |
63 | #define __UAPI_DEF_IF_IFNAMSIZ 0 | |
64 | #define __UAPI_DEF_IF_IFREQ 0 | |
65 | /* Everything up to IFF_DYNAMIC, matches net/if.h until glibc 2.23 */ | |
66 | #define __UAPI_DEF_IF_NET_DEVICE_FLAGS 0 | |
67 | /* For the future if glibc adds IFF_LOWER_UP, IFF_DORMANT and IFF_ECHO */ | |
68 | #ifndef __UAPI_DEF_IF_NET_DEVICE_FLAGS_LOWER_UP_DORMANT_ECHO | |
69 | #define __UAPI_DEF_IF_NET_DEVICE_FLAGS_LOWER_UP_DORMANT_ECHO 1 | |
70 | #endif /* __UAPI_DEF_IF_NET_DEVICE_FLAGS_LOWER_UP_DORMANT_ECHO */ | |
71 | ||
72 | #else /* _NET_IF_H */ | |
73 | ||
74 | /* Linux headers included first, and we must define everything | |
75 | * we need. The expectation is that glibc will check the | |
76 | * __UAPI_DEF_* defines and adjust appropriately. */ | |
77 | ||
78 | #define __UAPI_DEF_IF_IFCONF 1 | |
79 | #define __UAPI_DEF_IF_IFMAP 1 | |
80 | #define __UAPI_DEF_IF_IFNAMSIZ 1 | |
81 | #define __UAPI_DEF_IF_IFREQ 1 | |
82 | /* Everything up to IFF_DYNAMIC, matches net/if.h until glibc 2.23 */ | |
83 | #define __UAPI_DEF_IF_NET_DEVICE_FLAGS 1 | |
84 | /* For the future if glibc adds IFF_LOWER_UP, IFF_DORMANT and IFF_ECHO */ | |
85 | #define __UAPI_DEF_IF_NET_DEVICE_FLAGS_LOWER_UP_DORMANT_ECHO 1 | |
86 | ||
87 | #endif /* _NET_IF_H */ | |
88 | ||
cfd280c9 CD |
89 | /* Coordinate with glibc netinet/in.h header. */ |
90 | #if defined(_NETINET_IN_H) | |
91 | ||
92 | /* GLIBC headers included first so don't define anything | |
93 | * that would already be defined. */ | |
279c6c7f SH |
94 | #define __UAPI_DEF_IN_ADDR 0 |
95 | #define __UAPI_DEF_IN_IPPROTO 0 | |
96 | #define __UAPI_DEF_IN_PKTINFO 0 | |
97 | #define __UAPI_DEF_IP_MREQ 0 | |
98 | #define __UAPI_DEF_SOCKADDR_IN 0 | |
99 | #define __UAPI_DEF_IN_CLASS 0 | |
100 | ||
cfd280c9 CD |
101 | #define __UAPI_DEF_IN6_ADDR 0 |
102 | /* The exception is the in6_addr macros which must be defined | |
103 | * if the glibc code didn't define them. This guard matches | |
104 | * the guard in glibc/inet/netinet/in.h which defines the | |
105 | * additional in6_addr macros e.g. s6_addr16, and s6_addr32. */ | |
106 | #if defined(__USE_MISC) || defined (__USE_GNU) | |
107 | #define __UAPI_DEF_IN6_ADDR_ALT 0 | |
108 | #else | |
109 | #define __UAPI_DEF_IN6_ADDR_ALT 1 | |
110 | #endif | |
111 | #define __UAPI_DEF_SOCKADDR_IN6 0 | |
112 | #define __UAPI_DEF_IPV6_MREQ 0 | |
113 | #define __UAPI_DEF_IPPROTO_V6 0 | |
6d08acd2 | 114 | #define __UAPI_DEF_IPV6_OPTIONS 0 |
3b50d902 WC |
115 | #define __UAPI_DEF_IN6_PKTINFO 0 |
116 | #define __UAPI_DEF_IP6_MTUINFO 0 | |
cfd280c9 CD |
117 | |
118 | #else | |
119 | ||
120 | /* Linux headers included first, and we must define everything | |
121 | * we need. The expectation is that glibc will check the | |
122 | * __UAPI_DEF_* defines and adjust appropriately. */ | |
279c6c7f SH |
123 | #define __UAPI_DEF_IN_ADDR 1 |
124 | #define __UAPI_DEF_IN_IPPROTO 1 | |
125 | #define __UAPI_DEF_IN_PKTINFO 1 | |
126 | #define __UAPI_DEF_IP_MREQ 1 | |
127 | #define __UAPI_DEF_SOCKADDR_IN 1 | |
128 | #define __UAPI_DEF_IN_CLASS 1 | |
129 | ||
cfd280c9 CD |
130 | #define __UAPI_DEF_IN6_ADDR 1 |
131 | /* We unconditionally define the in6_addr macros and glibc must | |
132 | * coordinate. */ | |
133 | #define __UAPI_DEF_IN6_ADDR_ALT 1 | |
134 | #define __UAPI_DEF_SOCKADDR_IN6 1 | |
135 | #define __UAPI_DEF_IPV6_MREQ 1 | |
136 | #define __UAPI_DEF_IPPROTO_V6 1 | |
6d08acd2 | 137 | #define __UAPI_DEF_IPV6_OPTIONS 1 |
3b50d902 WC |
138 | #define __UAPI_DEF_IN6_PKTINFO 1 |
139 | #define __UAPI_DEF_IP6_MTUINFO 1 | |
cfd280c9 CD |
140 | |
141 | #endif /* _NETINET_IN_H */ | |
142 | ||
53dc65d4 MR |
143 | /* Coordinate with glibc netipx/ipx.h header. */ |
144 | #if defined(__NETIPX_IPX_H) | |
145 | ||
146 | #define __UAPI_DEF_SOCKADDR_IPX 0 | |
147 | #define __UAPI_DEF_IPX_ROUTE_DEFINITION 0 | |
148 | #define __UAPI_DEF_IPX_INTERFACE_DEFINITION 0 | |
149 | #define __UAPI_DEF_IPX_CONFIG_DATA 0 | |
150 | #define __UAPI_DEF_IPX_ROUTE_DEF 0 | |
151 | ||
152 | #else /* defined(__NETIPX_IPX_H) */ | |
153 | ||
154 | #define __UAPI_DEF_SOCKADDR_IPX 1 | |
155 | #define __UAPI_DEF_IPX_ROUTE_DEFINITION 1 | |
156 | #define __UAPI_DEF_IPX_INTERFACE_DEFINITION 1 | |
157 | #define __UAPI_DEF_IPX_CONFIG_DATA 1 | |
158 | #define __UAPI_DEF_IPX_ROUTE_DEF 1 | |
159 | ||
160 | #endif /* defined(__NETIPX_IPX_H) */ | |
161 | ||
ea1a8217 SH |
162 | /* Definitions for xattr.h */ |
163 | #if defined(_SYS_XATTR_H) | |
164 | #define __UAPI_DEF_XATTR 0 | |
165 | #else | |
166 | #define __UAPI_DEF_XATTR 1 | |
167 | #endif | |
cfd280c9 CD |
168 | |
169 | /* If we did not see any headers from any supported C libraries, | |
170 | * or we are being included in the kernel, then define everything | |
c0bace79 FJ |
171 | * that we need. Check for previous __UAPI_* definitions to give |
172 | * unsupported C libraries a way to opt out of any kernel definition. */ | |
cfd280c9 CD |
173 | #else /* !defined(__GLIBC__) */ |
174 | ||
4a91cb61 | 175 | /* Definitions for if.h */ |
c0bace79 | 176 | #ifndef __UAPI_DEF_IF_IFCONF |
4a91cb61 | 177 | #define __UAPI_DEF_IF_IFCONF 1 |
c0bace79 FJ |
178 | #endif |
179 | #ifndef __UAPI_DEF_IF_IFMAP | |
4a91cb61 | 180 | #define __UAPI_DEF_IF_IFMAP 1 |
c0bace79 FJ |
181 | #endif |
182 | #ifndef __UAPI_DEF_IF_IFNAMSIZ | |
4a91cb61 | 183 | #define __UAPI_DEF_IF_IFNAMSIZ 1 |
c0bace79 FJ |
184 | #endif |
185 | #ifndef __UAPI_DEF_IF_IFREQ | |
4a91cb61 | 186 | #define __UAPI_DEF_IF_IFREQ 1 |
c0bace79 | 187 | #endif |
4a91cb61 | 188 | /* Everything up to IFF_DYNAMIC, matches net/if.h until glibc 2.23 */ |
c0bace79 | 189 | #ifndef __UAPI_DEF_IF_NET_DEVICE_FLAGS |
4a91cb61 | 190 | #define __UAPI_DEF_IF_NET_DEVICE_FLAGS 1 |
c0bace79 | 191 | #endif |
4a91cb61 | 192 | /* For the future if glibc adds IFF_LOWER_UP, IFF_DORMANT and IFF_ECHO */ |
c0bace79 | 193 | #ifndef __UAPI_DEF_IF_NET_DEVICE_FLAGS_LOWER_UP_DORMANT_ECHO |
4a91cb61 | 194 | #define __UAPI_DEF_IF_NET_DEVICE_FLAGS_LOWER_UP_DORMANT_ECHO 1 |
c0bace79 | 195 | #endif |
4a91cb61 | 196 | |
279c6c7f | 197 | /* Definitions for in.h */ |
c0bace79 | 198 | #ifndef __UAPI_DEF_IN_ADDR |
279c6c7f | 199 | #define __UAPI_DEF_IN_ADDR 1 |
c0bace79 FJ |
200 | #endif |
201 | #ifndef __UAPI_DEF_IN_IPPROTO | |
279c6c7f | 202 | #define __UAPI_DEF_IN_IPPROTO 1 |
c0bace79 FJ |
203 | #endif |
204 | #ifndef __UAPI_DEF_IN_PKTINFO | |
279c6c7f | 205 | #define __UAPI_DEF_IN_PKTINFO 1 |
c0bace79 FJ |
206 | #endif |
207 | #ifndef __UAPI_DEF_IP_MREQ | |
279c6c7f | 208 | #define __UAPI_DEF_IP_MREQ 1 |
c0bace79 FJ |
209 | #endif |
210 | #ifndef __UAPI_DEF_SOCKADDR_IN | |
279c6c7f | 211 | #define __UAPI_DEF_SOCKADDR_IN 1 |
c0bace79 FJ |
212 | #endif |
213 | #ifndef __UAPI_DEF_IN_CLASS | |
279c6c7f | 214 | #define __UAPI_DEF_IN_CLASS 1 |
c0bace79 | 215 | #endif |
279c6c7f | 216 | |
cfd280c9 | 217 | /* Definitions for in6.h */ |
c0bace79 | 218 | #ifndef __UAPI_DEF_IN6_ADDR |
cfd280c9 | 219 | #define __UAPI_DEF_IN6_ADDR 1 |
c0bace79 FJ |
220 | #endif |
221 | #ifndef __UAPI_DEF_IN6_ADDR_ALT | |
cfd280c9 | 222 | #define __UAPI_DEF_IN6_ADDR_ALT 1 |
c0bace79 FJ |
223 | #endif |
224 | #ifndef __UAPI_DEF_SOCKADDR_IN6 | |
cfd280c9 | 225 | #define __UAPI_DEF_SOCKADDR_IN6 1 |
c0bace79 FJ |
226 | #endif |
227 | #ifndef __UAPI_DEF_IPV6_MREQ | |
cfd280c9 | 228 | #define __UAPI_DEF_IPV6_MREQ 1 |
c0bace79 FJ |
229 | #endif |
230 | #ifndef __UAPI_DEF_IPPROTO_V6 | |
cfd280c9 | 231 | #define __UAPI_DEF_IPPROTO_V6 1 |
c0bace79 FJ |
232 | #endif |
233 | #ifndef __UAPI_DEF_IPV6_OPTIONS | |
6d08acd2 | 234 | #define __UAPI_DEF_IPV6_OPTIONS 1 |
c0bace79 FJ |
235 | #endif |
236 | #ifndef __UAPI_DEF_IN6_PKTINFO | |
3b50d902 | 237 | #define __UAPI_DEF_IN6_PKTINFO 1 |
c0bace79 FJ |
238 | #endif |
239 | #ifndef __UAPI_DEF_IP6_MTUINFO | |
3b50d902 | 240 | #define __UAPI_DEF_IP6_MTUINFO 1 |
c0bace79 | 241 | #endif |
cfd280c9 | 242 | |
53dc65d4 | 243 | /* Definitions for ipx.h */ |
c0bace79 | 244 | #ifndef __UAPI_DEF_SOCKADDR_IPX |
53dc65d4 | 245 | #define __UAPI_DEF_SOCKADDR_IPX 1 |
c0bace79 FJ |
246 | #endif |
247 | #ifndef __UAPI_DEF_IPX_ROUTE_DEFINITION | |
53dc65d4 | 248 | #define __UAPI_DEF_IPX_ROUTE_DEFINITION 1 |
c0bace79 FJ |
249 | #endif |
250 | #ifndef __UAPI_DEF_IPX_INTERFACE_DEFINITION | |
53dc65d4 | 251 | #define __UAPI_DEF_IPX_INTERFACE_DEFINITION 1 |
c0bace79 FJ |
252 | #endif |
253 | #ifndef __UAPI_DEF_IPX_CONFIG_DATA | |
53dc65d4 | 254 | #define __UAPI_DEF_IPX_CONFIG_DATA 1 |
c0bace79 FJ |
255 | #endif |
256 | #ifndef __UAPI_DEF_IPX_ROUTE_DEF | |
53dc65d4 | 257 | #define __UAPI_DEF_IPX_ROUTE_DEF 1 |
c0bace79 | 258 | #endif |
53dc65d4 | 259 | |
ea1a8217 | 260 | /* Definitions for xattr.h */ |
c0bace79 | 261 | #ifndef __UAPI_DEF_XATTR |
ea1a8217 | 262 | #define __UAPI_DEF_XATTR 1 |
c0bace79 | 263 | #endif |
ea1a8217 | 264 | |
cfd280c9 CD |
265 | #endif /* __GLIBC__ */ |
266 | ||
267 | #endif /* _UAPI_LIBC_COMPAT_H */ |