| The Android Open Source Project | 1dc9e47 | 2009-03-03 19:28:35 -0800 | [diff] [blame] | 1 | #!/usr/bin/env python | 
 | 2 | # | 
| Christopher Ferris | 5956b4e | 2016-07-20 12:28:56 -0700 | [diff] [blame] | 3 | import sys, cpp, kernel, glob, os, re, getopt, clean_header, subprocess, shutil | 
| The Android Open Source Project | 1dc9e47 | 2009-03-03 19:28:35 -0800 | [diff] [blame] | 4 | from defaults import * | 
 | 5 | from utils import * | 
 | 6 |  | 
| Elliott Hughes | c4c2e24 | 2019-04-11 14:09:30 -0700 | [diff] [blame] | 7 | def Usage(): | 
| The Android Open Source Project | 1dc9e47 | 2009-03-03 19:28:35 -0800 | [diff] [blame] | 8 |     print """\ | 
| Christopher Ferris | d12c332 | 2015-09-15 14:13:17 -0700 | [diff] [blame] | 9 |   usage: %(progname)s [kernel-original-path] [kernel-modified-path] | 
| The Android Open Source Project | 1dc9e47 | 2009-03-03 19:28:35 -0800 | [diff] [blame] | 10 |  | 
 | 11 |     this program is used to update all the auto-generated clean headers | 
 | 12 |     used by the Bionic C library. it assumes the following: | 
 | 13 |  | 
| Christopher Ferris | d12c332 | 2015-09-15 14:13:17 -0700 | [diff] [blame] | 14 |       - a set of source kernel headers is located in | 
 | 15 |         'external/kernel-headers/original', relative to the current | 
 | 16 |         android tree | 
| The Android Open Source Project | 1dc9e47 | 2009-03-03 19:28:35 -0800 | [diff] [blame] | 17 |  | 
| Christopher Ferris | d12c332 | 2015-09-15 14:13:17 -0700 | [diff] [blame] | 18 |       - a set of manually modified kernel header files located in | 
 | 19 |         'external/kernel-headers/modified', relative to the current | 
 | 20 |         android tree | 
 | 21 |  | 
 | 22 |       - the clean headers will be placed in 'bionic/libc/kernel/arch-<arch>/asm', | 
| Christopher Ferris | 5956b4e | 2016-07-20 12:28:56 -0700 | [diff] [blame] | 23 |         'bionic/libc/kernel/android', etc.. | 
| The Android Open Source Project | 1dc9e47 | 2009-03-03 19:28:35 -0800 | [diff] [blame] | 24 | """ % { "progname" : os.path.basename(sys.argv[0]) } | 
 | 25 |     sys.exit(0) | 
 | 26 |  | 
| Elliott Hughes | c4c2e24 | 2019-04-11 14:09:30 -0700 | [diff] [blame] | 27 | def ProcessFiles(updater, original_dir, modified_dir, src_rel_dir, update_rel_dir): | 
| Christopher Ferris | 15d3fef | 2017-02-24 12:26:48 -0800 | [diff] [blame] | 28 |     # Delete the old headers before updating to the new headers. | 
 | 29 |     update_dir = os.path.join(get_kernel_dir(), update_rel_dir) | 
 | 30 |     shutil.rmtree(update_dir) | 
 | 31 |     os.mkdir(update_dir, 0755) | 
 | 32 |  | 
 | 33 |     src_dir = os.path.normpath(os.path.join(original_dir, src_rel_dir)) | 
 | 34 |     src_dir_len = len(src_dir) + 1 | 
 | 35 |     mod_src_dir = os.path.join(modified_dir, src_rel_dir) | 
 | 36 |     update_dir = os.path.join(get_kernel_dir(), update_rel_dir) | 
 | 37 |  | 
 | 38 |     kernel_dir = get_kernel_dir() | 
 | 39 |     for root, _, files in os.walk(src_dir): | 
 | 40 |         for file in sorted(files): | 
 | 41 |             _, ext = os.path.splitext(file) | 
 | 42 |             if ext != ".h": | 
 | 43 |                 continue | 
 | 44 |             src_file = os.path.normpath(os.path.join(root, file)) | 
 | 45 |             rel_path = src_file[src_dir_len:] | 
 | 46 |             # Check to see if there is a modified header to use instead. | 
 | 47 |             if os.path.exists(os.path.join(mod_src_dir, rel_path)): | 
 | 48 |                 src_file = os.path.join(mod_src_dir, rel_path) | 
 | 49 |                 src_str = os.path.join("<modified>", src_rel_dir, rel_path) | 
 | 50 |             else: | 
 | 51 |                 src_str = os.path.join("<original>", src_rel_dir, rel_path) | 
 | 52 |             dst_file = os.path.join(update_dir, rel_path) | 
 | 53 |             new_data = clean_header.cleanupFile(dst_file, src_file, rel_path) | 
 | 54 |             if not new_data: | 
 | 55 |                 continue | 
 | 56 |             updater.readFile(dst_file) | 
 | 57 |             ret_val = updater.editFile(dst_file, new_data) | 
 | 58 |             if ret_val == 0: | 
 | 59 |                 state = "unchanged" | 
 | 60 |             elif ret_val == 1: | 
 | 61 |                 state = "edited" | 
 | 62 |             else: | 
 | 63 |                 state = "added" | 
 | 64 |             update_path = os.path.join(update_rel_dir, rel_path) | 
 | 65 |             print "cleaning %s -> %s (%s)" % (src_str, update_path, state) | 
 | 66 |  | 
| Elliott Hughes | c4c2e24 | 2019-04-11 14:09:30 -0700 | [diff] [blame] | 67 |  | 
 | 68 | # This lets us support regular system calls like __NR_write and also weird | 
 | 69 | # ones like __ARM_NR_cacheflush, where the NR doesn't come at the start. | 
 | 70 | def make__NR_name(name): | 
 | 71 |     if name.startswith('__ARM_NR_'): | 
 | 72 |         return name | 
 | 73 |     else: | 
 | 74 |         return '__NR_%s' % (name) | 
 | 75 |  | 
 | 76 |  | 
 | 77 | # Scan Linux kernel asm/unistd.h files containing __NR_* constants | 
 | 78 | # and write out equivalent SYS_* constants for glibc source compatibility. | 
 | 79 | def GenerateGlibcSyscallsHeader(updater): | 
 | 80 |     libc_root = '%s/bionic/libc/' % os.environ['ANDROID_BUILD_TOP'] | 
 | 81 |  | 
 | 82 |     # Collect the set of all syscalls for all architectures. | 
 | 83 |     syscalls = set() | 
 | 84 |     pattern = re.compile(r'^\s*#\s*define\s*__NR_([a-z_]\S+)') | 
 | 85 |     for unistd_h in ['kernel/uapi/asm-generic/unistd.h', | 
 | 86 |                      'kernel/uapi/asm-arm/asm/unistd.h', | 
 | 87 |                      'kernel/uapi/asm-arm/asm/unistd-common.h', | 
 | 88 |                      'kernel/uapi/asm-arm/asm/unistd-eabi.h', | 
 | 89 |                      'kernel/uapi/asm-arm/asm/unistd-oabi.h', | 
 | 90 |                      'kernel/uapi/asm-x86/asm/unistd_32.h', | 
 | 91 |                      'kernel/uapi/asm-x86/asm/unistd_64.h', | 
 | 92 |                      'kernel/uapi/asm-x86/asm/unistd_x32.h']: | 
 | 93 |         for line in open(os.path.join(libc_root, unistd_h)): | 
 | 94 |             m = re.search(pattern, line) | 
 | 95 |             if m: | 
 | 96 |                 nr_name = m.group(1) | 
 | 97 |                 if 'reserved' not in nr_name and 'unused' not in nr_name: | 
 | 98 |                     syscalls.add(nr_name) | 
 | 99 |  | 
 | 100 |     # Create a single file listing them all. | 
 | 101 |     # Note that the input files include #if trickery, so even for a single | 
 | 102 |     # architecture we don't know exactly which ones are available. | 
 | 103 |     # https://b.corp.google.com/issues/37110151 | 
 | 104 |     content = '/* Generated file. Do not edit. */\n' | 
 | 105 |     content += '#pragma once\n' | 
 | 106 |  | 
 | 107 |     for syscall in sorted(syscalls): | 
 | 108 |         nr_name = make__NR_name(syscall) | 
 | 109 |         content += '#if defined(%s)\n' % nr_name | 
 | 110 |         content += '  #define SYS_%s %s\n' % (syscall, nr_name) | 
 | 111 |         content += '#endif\n' | 
 | 112 |  | 
| Christopher Ferris | fa59a10 | 2019-08-05 12:58:49 -0700 | [diff] [blame] | 113 |     syscall_file = os.path.join(libc_root, 'include/bits/glibc-syscalls.h') | 
 | 114 |     updater.readFile(syscall_file) | 
 | 115 |     updater.editFile(syscall_file, content) | 
| Elliott Hughes | c4c2e24 | 2019-04-11 14:09:30 -0700 | [diff] [blame] | 116 |  | 
 | 117 |  | 
| The Android Open Source Project | 1dc9e47 | 2009-03-03 19:28:35 -0800 | [diff] [blame] | 118 | try: | 
| Christopher Ferris | d12c332 | 2015-09-15 14:13:17 -0700 | [diff] [blame] | 119 |     optlist, args = getopt.getopt(sys.argv[1:], '') | 
| The Android Open Source Project | 1dc9e47 | 2009-03-03 19:28:35 -0800 | [diff] [blame] | 120 | except: | 
| Christopher Ferris | 15d3fef | 2017-02-24 12:26:48 -0800 | [diff] [blame] | 121 |     # Unrecognized option | 
| Christopher Ferris | d12c332 | 2015-09-15 14:13:17 -0700 | [diff] [blame] | 122 |     sys.stderr.write("error: unrecognized option\n") | 
| Elliott Hughes | c4c2e24 | 2019-04-11 14:09:30 -0700 | [diff] [blame] | 123 |     Usage() | 
| The Android Open Source Project | 1dc9e47 | 2009-03-03 19:28:35 -0800 | [diff] [blame] | 124 |  | 
| Christopher Ferris | d12c332 | 2015-09-15 14:13:17 -0700 | [diff] [blame] | 125 | if len(optlist) > 0 or len(args) > 2: | 
| Elliott Hughes | c4c2e24 | 2019-04-11 14:09:30 -0700 | [diff] [blame] | 126 |     Usage() | 
| The Android Open Source Project | 1dc9e47 | 2009-03-03 19:28:35 -0800 | [diff] [blame] | 127 |  | 
| Christopher Ferris | 15d3fef | 2017-02-24 12:26:48 -0800 | [diff] [blame] | 128 | if len(args) > 0: | 
| Glenn Kasten | c61f990 | 2011-12-19 11:27:50 -0800 | [diff] [blame] | 129 |     original_dir = args[0] | 
| David 'Digit' Turner | fc26931 | 2010-10-11 22:11:06 +0200 | [diff] [blame] | 130 | else: | 
| Christopher Ferris | d12c332 | 2015-09-15 14:13:17 -0700 | [diff] [blame] | 131 |     original_dir = get_kernel_headers_original_dir() | 
| Christopher Ferris | 15d3fef | 2017-02-24 12:26:48 -0800 | [diff] [blame] | 132 |  | 
 | 133 | if len(args) > 1: | 
 | 134 |     modified_dir = args[1] | 
 | 135 | else: | 
 | 136 |     modified_dir = get_kernel_headers_modified_dir() | 
 | 137 |  | 
 | 138 | if not os.path.isdir(original_dir): | 
 | 139 |     panic("The kernel directory %s is not a directory\n" % original_dir) | 
| The Android Open Source Project | 1dc9e47 | 2009-03-03 19:28:35 -0800 | [diff] [blame] | 140 |  | 
| Christopher Ferris | d12c332 | 2015-09-15 14:13:17 -0700 | [diff] [blame] | 141 | if not os.path.isdir(modified_dir): | 
| Christopher Ferris | 15d3fef | 2017-02-24 12:26:48 -0800 | [diff] [blame] | 142 |     panic("The kernel modified directory %s is not a directory\n" % modified_dir) | 
| Christopher Ferris | 38062f9 | 2014-07-09 15:33:25 -0700 | [diff] [blame] | 143 |  | 
| Christopher Ferris | 15d3fef | 2017-02-24 12:26:48 -0800 | [diff] [blame] | 144 | updater = BatchFileUpdater() | 
| Elliott Hughes | c4c2e24 | 2019-04-11 14:09:30 -0700 | [diff] [blame] | 145 |  | 
| Christopher Ferris | 15d3fef | 2017-02-24 12:26:48 -0800 | [diff] [blame] | 146 | # Process the original uapi headers first. | 
| Elliott Hughes | c4c2e24 | 2019-04-11 14:09:30 -0700 | [diff] [blame] | 147 | ProcessFiles(updater, original_dir, modified_dir, "uapi", "uapi"), | 
| Christopher Ferris | d12c332 | 2015-09-15 14:13:17 -0700 | [diff] [blame] | 148 |  | 
| Christopher Ferris | 15d3fef | 2017-02-24 12:26:48 -0800 | [diff] [blame] | 149 | # Now process the special files. | 
| Elliott Hughes | c4c2e24 | 2019-04-11 14:09:30 -0700 | [diff] [blame] | 150 | ProcessFiles(updater, original_dir, modified_dir, "scsi", os.path.join("android", "scsi", "scsi")) | 
| The Android Open Source Project | 1dc9e47 | 2009-03-03 19:28:35 -0800 | [diff] [blame] | 151 |  | 
| Christopher Ferris | 15d3fef | 2017-02-24 12:26:48 -0800 | [diff] [blame] | 152 | updater.updateGitFiles() | 
| Elliott Hughes | c4c2e24 | 2019-04-11 14:09:30 -0700 | [diff] [blame] | 153 |  | 
 | 154 | # Now re-generate the <bits/glibc-syscalls.h> from the new uapi headers. | 
 | 155 | updater = BatchFileUpdater() | 
 | 156 | GenerateGlibcSyscallsHeader(updater) | 
 | 157 | updater.updateGitFiles() |