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