blob: 09556c9e6a953871d52ae355be433eeeba9a9f1c [file] [log] [blame]
The Android Open Source Projecta27d2ba2008-10-21 07:00:00 -07001# this module contains all the defaults used by the generation of cleaned-up headers
2# for the Bionic C library
3#
4
5import time, os, sys
6from utils import *
7
8# the list of supported architectures
9#
Colin Crossd1973ca2014-01-21 19:50:58 -080010kernel_archs = [ 'arm', 'arm64', 'mips', 'x86' ]
The Android Open Source Projecta27d2ba2008-10-21 07:00:00 -070011
12# the list of include directories that belong to the kernel
13# tree. used when looking for sources...
14#
15kernel_dirs = [ "linux", "asm", "asm-generic", "mtd" ]
16
17# path to the directory containing the original kernel headers
18#
David 'Digit' Turnerfc269312010-10-11 22:11:06 +020019kernel_original_path = os.path.normpath( find_program_dir() + '/../../../../external/kernel-headers/original' )
20
21# path to the default location of the cleaned-up headers
22#
23kernel_cleaned_path = os.path.normpath( find_program_dir() + '/..' )
The Android Open Source Projecta27d2ba2008-10-21 07:00:00 -070024
25# a special value that is used to indicate that a given macro is known to be
26# undefined during optimization
27kCppUndefinedMacro = "<<<undefined>>>"
28
29# this is the set of known macros we want to totally optimize out from the
30# final headers
31kernel_known_macros = {
32 "__KERNEL__": kCppUndefinedMacro,
33 "__KERNEL_STRICT_NAMES":"1",
34 "__CHECKER__": kCppUndefinedMacro,
35 "__CHECK_ENDIAN__": kCppUndefinedMacro,
Elliott Hughesd3e64a32013-09-30 17:41:08 -070036 "CONFIG_X86_32": "__i386__",
Ben Cheng460fa702013-10-23 14:38:25 -070037 "__EXPORTED_HEADERS__": "1",
The Android Open Source Projecta27d2ba2008-10-21 07:00:00 -070038 }
39
40# define to true if you want to remove all defined(CONFIG_FOO) tests
41# from the clean headers. testing shows that this is not strictly necessary
42# but just generates cleaner results
43kernel_remove_config_macros = True
44
The Android Open Source Project4e468ed2008-12-17 18:03:48 -080045# maps an architecture to a set of default macros that would be provided by
46# toolchain preprocessor
47kernel_default_arch_macros = {
48 "arm": {},
Colin Crossd1973ca2014-01-21 19:50:58 -080049 "arm64": {},
Raghu Gandham988ff8f2012-09-21 17:13:25 -070050 "mips": {"CONFIG_32BIT":"1"},
Elliott Hughesd3e64a32013-09-30 17:41:08 -070051 "x86": {},
The Android Open Source Project4e468ed2008-12-17 18:03:48 -080052 }
53
Raghu Gandhama864c2c2013-01-16 16:42:47 -080054kernel_arch_token_replacements = {
55 "arm": {},
Colin Crossd1973ca2014-01-21 19:50:58 -080056 "arm64": {},
Raghu Gandhama864c2c2013-01-16 16:42:47 -080057 "mips": {"off_t":"__kernel_off_t"},
Elliott Hughesd3e64a32013-09-30 17:41:08 -070058 "x86": {},
Raghu Gandhama864c2c2013-01-16 16:42:47 -080059 }
Elliott Hughes199346a2014-02-11 20:01:11 -080060
Martin Storsjoc9205db2010-12-08 11:39:05 +010061# Replace tokens in the output according to this mapping
62kernel_token_replacements = {
David 'Digit' Turnerb969b5a2011-01-11 17:23:10 +010063 "asm": "__asm__",
Elliott Hughes199346a2014-02-11 20:01:11 -080064 # The kernel usage of __unused for unused struct fields conflicts with the macro defined in <sys/cdefs.h>.
65 "__unused": "__linux_unused",
66 # The kernel's _NSIG/NSIG are one less than the userspace value, so we need to move them aside.
67 "_NSIG": "_KERNEL__NSIG",
68 "NSIG": "_KERNEL_NSIG",
Martin Storsjoc9205db2010-12-08 11:39:05 +010069 }
70
The Android Open Source Projecta27d2ba2008-10-21 07:00:00 -070071# this is the set of known static inline functions that we want to keep
72# in the final ARM headers. this is only used to keep optimized byteswapping
73# static functions and stuff like that.
Colin Crossd1973ca2014-01-21 19:50:58 -080074kernel_known_arm_statics = set(
75 [ "___arch__swab32", # asm-arm/byteorder.h
Ben Cheng8bea2b62013-10-16 15:28:56 -070076 ]
77 )
78
Colin Crossd1973ca2014-01-21 19:50:58 -080079kernel_known_arm64_statics = set(
80 [
The Android Open Source Projecta27d2ba2008-10-21 07:00:00 -070081 ]
82 )
83
Raghu Gandham82fa43f2012-03-27 11:37:17 -070084kernel_known_mips_statics = set(
85 [
86 ]
87 )
88
Elliott Hughesd3e64a32013-09-30 17:41:08 -070089kernel_known_x86_statics = set(
90 [ "___arch__swab32", # asm-x86/byteorder.h
91 "___arch__swab64", # asm-x86/byteorder.h
92 ]
93 )
94
The Android Open Source Projecta27d2ba2008-10-21 07:00:00 -070095kernel_known_generic_statics = set(
96 [ "__invalid_size_argument_for_IOC", # asm-generic/ioctl.h
97 "__cmsg_nxthdr", # linux/socket.h
98 "cmsg_nxthdr", # linux/socket.h
99 "ipt_get_target",
Vilmos Nebehajc1a534b2010-06-28 15:13:23 +0200100 "ip6t_get_target",
The Android Open Source Projecta27d2ba2008-10-21 07:00:00 -0700101 ]
102 )
103
104# this maps an architecture to the set of static inline functions that
105# we want to keep in the final headers
106#
107kernel_known_statics = {
108 "arm" : kernel_known_arm_statics,
Colin Crossd1973ca2014-01-21 19:50:58 -0800109 "arm64" : kernel_known_arm64_statics,
Elliott Hughesd3e64a32013-09-30 17:41:08 -0700110 "mips" : kernel_known_mips_statics,
Shin-ichiro KAWASAKI37429ff2009-07-01 15:41:52 +0900111 "x86" : kernel_known_x86_statics,
The Android Open Source Projecta27d2ba2008-10-21 07:00:00 -0700112 }
113
The Android Open Source Project6d6c82c2009-01-09 17:50:54 -0800114# this is a list of macros which we want to specifically exclude from
115# the generated files.
116#
117kernel_ignored_macros = set(
118 [ "MAXHOSTNAMELEN", # for some reason, Linux defines it to 64
119 # while most of the BSD code expects this to be 256
120 # so ignore the kernel-provided definition and
121 # define it in the Bionic headers instead
122 ]
123 )
124
The Android Open Source Projecta27d2ba2008-10-21 07:00:00 -0700125# this is the standard disclaimer
126#
127kernel_disclaimer = """\
128/****************************************************************************
129 ****************************************************************************
130 ***
131 *** This header was automatically generated from a Linux kernel header
132 *** of the same name, to make information necessary for userspace to
133 *** call into the kernel available to libc. It contains only constants,
134 *** structures, and macros generated from the original header, and thus,
135 *** contains no copyrightable information.
136 ***
David 'Digit' Turnerfc269312010-10-11 22:11:06 +0200137 *** To edit the content of this header, modify the corresponding
138 *** source file (e.g. under external/kernel-headers/original/) then
139 *** run bionic/libc/kernel/tools/update_all.py
140 ***
141 *** Any manual change here will be lost the next time this script will
142 *** be run. You've been warned!
143 ***
The Android Open Source Projecta27d2ba2008-10-21 07:00:00 -0700144 ****************************************************************************
145 ****************************************************************************/
146"""
David 'Digit' Turnerfc269312010-10-11 22:11:06 +0200147
148# This is the warning line that will be inserted every N-th line in the output
149kernel_warning = """\
150/* WARNING: DO NOT EDIT, AUTO-GENERATED CODE - SEE TOP FOR INSTRUCTIONS */
151"""