Home | History | Annotate | Download | only in tools 
      1 # this module contains all the defaults used by the generation of cleaned-up headers
      2 # for the Bionic C library
      3 #
      4 
      5 import time, os, sys
      6 from utils import *
      7 
      8 # the list of supported architectures
      9 kernel_archs = [ 'arm', 'arm64', 'mips', 'x86' ]
     10 
     11 # the list of include directories that belong to the kernel
     12 # tree. used when looking for sources...
     13 kernel_dirs = [ "linux", "asm", "asm-generic", "mtd" ]
     14 
     15 # a special value that is used to indicate that a given macro is known to be
     16 # undefined during optimization
     17 kCppUndefinedMacro = "<<<undefined>>>"
     18 
     19 # this is the set of known macros we want to totally optimize out from the
     20 # final headers
     21 kernel_known_macros = {
     22     "__KERNEL__": kCppUndefinedMacro,
     23     "__KERNEL_STRICT_NAMES":"1",
     24     "__CHECKER__": kCppUndefinedMacro,
     25     "__CHECK_ENDIAN__": kCppUndefinedMacro,
     26     "CONFIG_64BIT": "__LP64__",
     27     "CONFIG_X86_32": "__i386__",
     28     "__EXPORTED_HEADERS__": "1",
     29     }
     30 
     31 # define to true if you want to remove all defined(CONFIG_FOO) tests
     32 # from the clean headers. testing shows that this is not strictly necessary
     33 # but just generates cleaner results
     34 kernel_remove_config_macros = True
     35 
     36 # maps an architecture to a set of default macros that would be provided by
     37 # toolchain preprocessor
     38 kernel_default_arch_macros = {
     39     "arm": {"__ARMEB__": kCppUndefinedMacro, "__ARM_EABI__": "1"},
     40     "arm64": {},
     41     "mips": {"__MIPSEB__": kCppUndefinedMacro,
     42              "__MIPSEL__": "1",
     43              "CONFIG_32BIT": "_ABIO32",
     44              "CONFIG_CPU_LITTLE_ENDIAN": "1",
     45              "__SANE_USERSPACE_TYPES__": "1",},
     46     "x86": {},
     47     }
     48 
     49 kernel_arch_token_replacements = {
     50     "arm": {},
     51     "arm64": {},
     52     "mips": {"off_t":"__kernel_off_t"},
     53     "x86": {},
     54     }
     55 
     56 # Replace tokens in the output according to this mapping
     57 kernel_token_replacements = {
     58     "asm": "__asm__",
     59     # The kernel usage of __unused for unused struct fields conflicts with the macro defined in <sys/cdefs.h>.
     60     "__unused": "__linux_unused",
     61     # The kernel's _NSIG/NSIG are one less than the userspace value, so we need to move them aside.
     62     "_NSIG": "_KERNEL__NSIG",
     63     "NSIG": "_KERNEL_NSIG",
     64     # The kernel's SIGRTMIN/SIGRTMAX are absolute limits; userspace steals a few.
     65     "SIGRTMIN": "__SIGRTMIN",
     66     "SIGRTMAX": "__SIGRTMAX",
     67     # We want to support both BSD and Linux member names in struct udphdr.
     68     "udphdr": "__kernel_udphdr",
     69     }
     70 
     71 # 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.
     74 # TODO: this isn't working!
     75 kernel_known_arm_statics = set(
     76         [ "___arch__swab32",    # asm-arm/byteorder.h
     77         ]
     78     )
     79 
     80 kernel_known_arm64_statics = set(
     81         [
     82         ]
     83     )
     84 
     85 kernel_known_mips_statics = set(
     86         [
     87         ]
     88     )
     89 
     90 kernel_known_x86_statics = set(
     91         [ "___arch__swab32",  # asm-x86/byteorder.h
     92           "___arch__swab64",  # asm-x86/byteorder.h
     93         ]
     94     )
     95 
     96 kernel_known_generic_statics = set(
     97         [
     98           "ipt_get_target",  # uapi/linux/netfilter_ipv4/ip_tables.h
     99           "ip6t_get_target", # uapi/linux/netfilter_ipv6/ip6_tables.h
    100         ]
    101     )
    102 
    103 # this maps an architecture to the set of static inline functions that
    104 # we want to keep in the final headers
    105 #
    106 kernel_known_statics = {
    107         "arm" : kernel_known_arm_statics,
    108         "arm64" : kernel_known_arm64_statics,
    109         "mips" : kernel_known_mips_statics,
    110         "x86" : kernel_known_x86_statics,
    111     }
    112 
    113 # this is a list of macros which we want to specifically exclude from
    114 # the generated files.
    115 #
    116 kernel_ignored_macros = set(
    117         [
    118 
    119         ]
    120     )
    121 
    122 # this is the standard disclaimer
    123 #
    124 kernel_disclaimer = """\
    125 /****************************************************************************
    126  ****************************************************************************
    127  ***
    128  ***   This header was automatically generated from a Linux kernel header
    129  ***   of the same name, to make information necessary for userspace to
    130  ***   call into the kernel available to libc.  It contains only constants,
    131  ***   structures, and macros generated from the original header, and thus,
    132  ***   contains no copyrightable information.
    133  ***
    134  ***   To edit the content of this header, modify the corresponding
    135  ***   source file (e.g. under external/kernel-headers/original/) then
    136  ***   run bionic/libc/kernel/tools/update_all.py
    137  ***
    138  ***   Any manual change here will be lost the next time this script will
    139  ***   be run. You've been warned!
    140  ***
    141  ****************************************************************************
    142  ****************************************************************************/
    143 """
    144 
    145 # This is the warning line that will be inserted every N-th line in the output
    146 kernel_warning = """\
    147 /* WARNING: DO NOT EDIT, AUTO-GENERATED CODE - SEE TOP FOR INSTRUCTIONS */
    148 """
    149