defaults.py revision d1973ca51325393f304e82a4d79874f33e54ac16 
1# 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#
10kernel_archs = [ 'arm', 'arm64', 'mips', 'x86' ]
11
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#
19kernel_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() + '/..' )
24
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,
36    "CONFIG_X86_32": "__i386__",
37    "__EXPORTED_HEADERS__": "1",
38    }
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
45# maps an architecture to a set of default macros that would be provided by
46# toolchain preprocessor
47kernel_default_arch_macros = {
48    "arm": {},
49    "arm64": {},
50    "mips": {"CONFIG_32BIT":"1"},
51    "x86": {},
52    }
53
54kernel_arch_token_replacements = {
55    "arm": {},
56    "arm64": {},
57    "mips": {"off_t":"__kernel_off_t"},
58    "x86": {},
59    }
60# Replace tokens in the output according to this mapping
61kernel_token_replacements = {
62    "asm": "__asm__",
63    "__unused": "__linux_unused", # The kernel usage of __unused conflicts with the macro defined in sys/cdefs.h
64    }
65
66# this is the set of known static inline functions that we want to keep
67# in the final ARM headers. this is only used to keep optimized byteswapping
68# static functions and stuff like that.
69kernel_known_arm_statics = set(
70        [ "___arch__swab32",    # asm-arm/byteorder.h
71        ]
72    )
73
74kernel_known_arm64_statics = set(
75        [
76        ]
77    )
78
79kernel_known_mips_statics = set(
80        [
81        ]
82    )
83
84kernel_known_x86_statics = set(
85        [ "___arch__swab32",  # asm-x86/byteorder.h
86          "___arch__swab64",  # asm-x86/byteorder.h
87        ]
88    )
89
90kernel_known_generic_statics = set(
91        [ "__invalid_size_argument_for_IOC",  # asm-generic/ioctl.h
92          "__cmsg_nxthdr",                    # linux/socket.h
93          "cmsg_nxthdr",                      # linux/socket.h
94          "ipt_get_target",
95          "ip6t_get_target",
96        ]
97    )
98
99# this maps an architecture to the set of static inline functions that
100# we want to keep in the final headers
101#
102kernel_known_statics = {
103        "arm" : kernel_known_arm_statics,
104        "arm64" : kernel_known_arm64_statics,
105        "mips" : kernel_known_mips_statics,
106        "x86" : kernel_known_x86_statics,
107    }
108
109# this is a list of macros which we want to specifically exclude from
110# the generated files.
111#
112kernel_ignored_macros = set(
113        [ "MAXHOSTNAMELEN",  # for some reason, Linux defines it to 64
114                             # while most of the BSD code expects this to be 256
115                             # so ignore the kernel-provided definition and
116                             # define it in the Bionic headers instead
117        ]
118    )
119
120# this is the standard disclaimer
121#
122kernel_disclaimer = """\
123/****************************************************************************
124 ****************************************************************************
125 ***
126 ***   This header was automatically generated from a Linux kernel header
127 ***   of the same name, to make information necessary for userspace to
128 ***   call into the kernel available to libc.  It contains only constants,
129 ***   structures, and macros generated from the original header, and thus,
130 ***   contains no copyrightable information.
131 ***
132 ***   To edit the content of this header, modify the corresponding
133 ***   source file (e.g. under external/kernel-headers/original/) then
134 ***   run bionic/libc/kernel/tools/update_all.py
135 ***
136 ***   Any manual change here will be lost the next time this script will
137 ***   be run. You've been warned!
138 ***
139 ****************************************************************************
140 ****************************************************************************/
141"""
142
143# This is the warning line that will be inserted every N-th line in the output
144kernel_warning = """\
145/* WARNING: DO NOT EDIT, AUTO-GENERATED CODE - SEE TOP FOR INSTRUCTIONS */
146"""
147