am 6cdab387: Merge "Restore <nsswitch.h> which is BSD API, not private."
[android-sdk/platform-bionic.git] / HACKING.txt
1 Working on bionic
2 =================
4 What are the big pieces of bionic?
5 ----------------------------------
7 libc/ ---, libc.a
8   The C library. Stuff like fopen(3) and kill(2).
9 libm/ ---, libm.a
10   The math library. Traditionally Unix systems kept stuff like sin(3) and
11   cos(3) in a separate library to save space in the days before shared
12   libraries.
13 libdl/ ---
14   The dynamic linker interface library. This is actually just a bunch of
15   stubs that the dynamic linker replaces with pointers to its own
16   implementation at runtime. This is where stuff like dlopen(3) lives.
17 libstdc++/ ---
18   The C++ ABI support functions. The C++ compiler doesn't know how to
19   implement thread-safe static initialization and the like, so it just calls
20   functions that are supplied by the system. Stuff like __cxa_guard_acquire
21   and __cxa_pure_virtual live here.
23 linker/ --- /system/bin/linker and /system/bin/linker64
24   The dynamic linker. When you run a dynamically-linked executable, its ELF
25   file has a DT_INTERP entry that says "use the following program to start me".
26   On Android, that's either linker or linker64 (depending on whether it's a
27   32-bit or 64-bit executable). It's responsible for loading the ELF executable
28   into memory and resolving references to symbols (so that when your code tries
29   to jump to fopen(3), say, it lands in the right place).
31 tests/ --- unit tests
32   The tests/ directory contains unit tests. Roughly arranged as one file per
33   publicly-exported header file.
34 benchmarks/ --- benchmarks
35   The benchmarks/ directory contains benchmarks.
38 What's in libc/?
39 ----------------
41 libc/
42   arch-arm/
43   arch-arm64/
44   arch-common/
45   arch-mips/
46   arch-mips64/
47   arch-x86/
48   arch-x86_64/
49     # Each architecture has its own subdirectory for stuff that isn't shared
50     # because it's architecture-specific. There will be a .mk file in here that
51     # drags in all the architecture-specific files.
52     bionic/
53       # Every architecture needs a handful of machine-specific assembler files.
54       # They live here.
55     include/
56       machine/
57         # The majority of header files are actually in libc/include/, but many
58         # of them pull in a <machine/something.h> for things like limits,
59         # endianness, and how floating point numbers are represented. Those
60         # headers live here.
61     string/
62       # Most architectures have a handful of optional assembler files
63       # implementing optimized versions of various routines. The <string.h>
64       # functions are particular favorites.
65     syscalls/
66       # The syscalls directories contain script-generated assembler files.
67       # See 'Adding system calls' later.
69   include/
70     # The public header files on everyone's include path. These are a mixture of
71     # files written by us and files taken from BSD.
73   kernel/
74     # The kernel uapi header files. These are scrubbed copies of the originals
75     # in external/kernel-headers/. These files must not be edited directly. The
76     # script should be used to go from a kernel tree to
77     # external/kernel-headers/ --- this takes care of the architecture-specific
78     # details. The script should be used to regenerate bionic's
79     # scrubbed headers from external/kernel-headers/.
81   private/
82     # These are private header files meant for use within bionic itself.
84   stdio/
85   stdlib/
86   unistd/
87     # These are legacy files of unknown provenance. In the past, bionic was a
88     # mess of random versions of random files from all three of FreeBSD, NetBSD,
89     # and OpenBSD! We've been working to clean that up, but these directories
90     # are basically where all the stuff we haven't got to yet lives.
91   dns/
92     # Contains the DNS resolver (originates from NetBSD code).
94   upstream-dlmalloc/
95   upstream-freebsd/
96   upstream-netbsd/
97   upstream-openbsd/
98     # These directories contain unmolested upstream source. Any time we can
99     # just use a BSD implementation of something unmodified, we should.
100     # The structure under these directories mimics the upstream tree,
101     # but there's also...
102     android/
103       include/
104         # This is where we keep the hacks necessary to build BSD source
105         # in our world. The *-compat.h files are automatically included
106         # using -include, but we also provide equivalents for missing
107         # header/source files needed by the BSD implementation.
109   bionic/
110     # This is the biggest mess. The C++ files are files we own, typically
111     # because the Linux kernel interface is sufficiently different that we
112     # can't use any of the BSD implementations. The C files are usually
113     # legacy mess that needs to be sorted out, either by replacing it with
114     # current upstream source in one of the upstream directories or by
115     # switching the file to C++ and cleaning it up.
117   tools/
118     # Various tools used to maintain bionic.
120   tzcode/
121     # A modified superset of the IANA tzcode. Most of the modifications relate
122     # to Android's use of a single file (with corresponding index) to contain
123     # time zone data.
124   zoneinfo/
125     # Android-format time zone data.
126     # See 'Updating tzdata' later.
129 Adding system calls
130 -------------------
132 Adding a system call usually involves:
134   1. Add entries to SYSCALLS.TXT.
135      See SYSCALLS.TXT itself for documentation on the format.
136   2. Run the script.
137   3. Add constants (and perhaps types) to the appropriate header file.
138      Note that you should check to see whether the constants are already in
139      kernel uapi header files, in which case you just need to make sure that
140      the appropriate POSIX header file in libc/include/ includes the
141      relevant file or files.
142   4. Add function declarations to the appropriate header file.
143   5. Add at least basic tests. Even a test that deliberately supplies
144      an invalid argument helps check that we're generating the right symbol
145      and have the right declaration in the header file. (And strace(1) can
146      confirm that the correct system call is being made.)
149 Updating kernel header files
150 ----------------------------
152 As mentioned above, this is currently a two-step process:
154   1. Use to go from a Linux source tree to appropriate
155      contents for external/kernel-headers/.
156   2. Run to scrub those headers and import them into bionic.
159 Updating tzdata
160 ---------------
162 This is fully automated:
164   1. Run