xref: /aosp_15_r20/bionic/libc/kernel/tools/defaults.py (revision 8d67ca893c1523eb926b9080dbe4e2ffd2a27ba1) 
1# All the defaults used to generate the cleaned-up uapi headers for bionic.
2
3# the list of include directories that belong to the kernel
4# tree. used when looking for sources...
5kernel_dirs = [ "linux", "asm", "asm-generic", "mtd" ]
6
7# a special value that is used to indicate that a given macro is known to be
8# undefined during optimization
9kCppUndefinedMacro = "<<<undefined>>>"
10
11# this is the set of known macros we want to totally optimize out from the
12# final headers
13kernel_known_macros = {
14    "__KERNEL__": kCppUndefinedMacro,
15    "__KERNEL_STRICT_NAMES":"1",
16    "__CHECKER__": kCppUndefinedMacro,
17    "__CHECK_ENDIAN__": kCppUndefinedMacro,
18    "CONFIG_64BIT": "__LP64__",
19    "CONFIG_X86_32": "__i386__",
20    "__EXPORTED_HEADERS__": "1",
21    "__HAVE_BUILTIN_BSWAP16__": "1",
22    "__HAVE_BUILTIN_BSWAP32__": "1",
23    "__HAVE_BUILTIN_BSWAP64__": "1",
24    # Use this to remove the struct __kernel_old_timeval definition.
25    # Otherwise, there will be two struct timeval definitions when
26    # __kernel_old_timeval is renamed to timeval.
27    "__kernel_old_timeval": "1",
28    # Drop the custom byte swap functions and just use the clang builtins.
29    # https://github.com/android/ndk/issues/2107
30    "__arch_swab16": kCppUndefinedMacro,
31    "__arch_swab16p": kCppUndefinedMacro,
32    "__arch_swab16s": kCppUndefinedMacro,
33    "__arch_swab32": kCppUndefinedMacro,
34    "__arch_swab32p": kCppUndefinedMacro,
35    "__arch_swab32s": kCppUndefinedMacro,
36    "__arch_swab64": kCppUndefinedMacro,
37    "__arch_swab64p": kCppUndefinedMacro,
38    "__arch_swab64s": kCppUndefinedMacro,
39    "__arch_swahb32": kCppUndefinedMacro,
40    "__arch_swahb32p": kCppUndefinedMacro,
41    "__arch_swahb32s": kCppUndefinedMacro,
42    "__arch_swahw32": kCppUndefinedMacro,
43    "__arch_swahw32p": kCppUndefinedMacro,
44    "__arch_swahw32s": kCppUndefinedMacro,
45    }
46
47# This is the set of known kernel data structures we want to remove from
48# the final headers. If the map value is non-empty, that means that in
49# addition to removing the structure, add a #include to the file.
50kernel_structs_to_remove = {
51    # Remove these structures since they are still the same as
52    # timeval, itimerval. Also, add an include of linux/time.h
53    # since __kernel_old_timeval is being changed to timeval, and
54    # is only present in linux/time.h.
55    "__kernel_old_timeval": "linux/time.h",
56    "__kernel_old_itimerval": None,
57    # Replace all of the below structures with #include <bits/STRUCT.h>
58    "__kernel_sockaddr_storage": "bits/sockaddr_storage.h",
59    "epoll_event": "bits/epoll_event.h",
60    "flock": "bits/flock.h",
61    "flock64": "bits/flock64.h",
62    "in_addr": "bits/in_addr.h",
63    "ip_mreq_source": "bits/ip_mreq_source.h",
64    "ip_msfilter": "bits/ip_msfilter.h",
65    "tcphdr": "bits/tcphdr.h",
66    "timespec": "bits/timespec.h",
67    }
68
69# define to true if you want to remove all defined(CONFIG_FOO) tests
70# from the clean headers. testing shows that this is not strictly necessary
71# but just generates cleaner results
72kernel_remove_config_macros = True
73
74# Maps an architecture to a set of default macros that would be provided by
75# the toolchain's preprocessor. Currently only used to remove confusing
76# big-endian junk from the 32-bit arm headers.
77kernel_default_arch_macros = {
78    "arm": {"__ARMEB__": kCppUndefinedMacro, "__ARM_EABI__": "1"},
79    }
80
81# Replace tokens in the output according to this mapping.
82kernel_token_replacements = {
83    # The kernel usage of __unused for unused struct fields conflicts with the macro defined in <sys/cdefs.h>.
84    "__unused": "__linux_unused",
85    # The kernel usage of C++ keywords causes problems for C++ code so rename.
86    "class": "__linux_class",
87    "private": "__linux_private",
88    "virtual": "__linux_virtual",
89    # The non-64 stuff is legacy; msqid64_ds/ipc64_perm is what userspace wants.
90    "msqid_ds": "__kernel_legacy_msqid_ds",
91    "semid_ds": "__kernel_legacy_semid_ds",
92    "shmid_ds": "__kernel_legacy_shmid_ds",
93    "ipc_perm": "__kernel_legacy_ipc_perm",
94    # The kernel semun isn't usable (https://github.com/android-ndk/ndk/issues/400).
95    "semun": "__kernel_legacy_semun",
96    # The kernel's _NSIG/NSIG are one less than the userspace value, so we need to move them aside.
97    "_NSIG": "_KERNEL__NSIG",
98    "NSIG": "_KERNEL_NSIG",
99    # The kernel's SIGRTMIN/SIGRTMAX are absolute limits; userspace steals a few.
100    "SIGRTMIN": "__SIGRTMIN",
101    "SIGRTMAX": "__SIGRTMAX",
102    # We want to support both BSD and Linux member names in struct udphdr.
103    "udphdr": "__kernel_udphdr",
104    # This causes problems when trying to export the headers for the ndk.
105    "__attribute_const__": "__attribute__((__const__))",
106    # The kernel started using struct __kernel_old_timeval in some places,
107    # which is the exact same as struct timeval. Replace that name with
108    # timeval so that kernel structures all use the same named structure.
109    # If struct __kernel_old_timeval and struct timeval become different,
110    # then a different solution needs to be implemented.
111    "__kernel_old_timeval": "timeval",
112    # Do the same for __kernel_old_itimerval as for timeval.
113    "__kernel_old_itimerval": "itimerval",
114    # Do the same for __kernel_sockaddr_storage.
115    "__kernel_sockaddr_storage": "sockaddr_storage",
116    # Replace __packed with __attribute__((__packed__)) to avoid depending
117    # on sys/cdefs.h
118    "__packed": "__attribute__((__packed__))",
119    # Remove unused macros (http://b/262917450).
120    "__force": "",
121    "__user": "",
122    # Rename the kernel's sigaction so we can expose our POSIX one publicly,
123    # but translate to the kernel's one internally.
124    "sigaction": "__kernel_sigaction",
125    }
126
127
128# Static inline functions that we want to keep.
129kernel_known_generic_statics = set(
130        [
131          "ipt_get_target",  # uapi/linux/netfilter_ipv4/ip_tables.h
132          "ip6t_get_target", # uapi/linux/netfilter_ipv6/ip6_tables.h
133          # Byte swapping inlines from uapi/linux/swab.h
134          # The below functions are the ones we are guaranting we export.
135          "__swab16",
136          "__swab32",
137          "__swab64",
138          "__swab16p",
139          "__swab32p",
140          "__swab64p",
141          "__swab16s",
142          "__swab32s",
143          "__swab64s",
144          "__swahw32",
145          "__swahb32",
146          "__swahw32p",
147          "__swahb32p",
148          "__swahw32s",
149          "__swahb32s",
150          # These are required to support the above functions.
151          "__fswahw32",
152          "__fswahb32",
153          # This is used by various macros in <linux/ioprio.h>.
154          "ioprio_value",
155
156          # Contact opensource-licensing@ before adding to this set.
157        ]
158    )
159