Use fs_config_generator.py to generate fs_config_files/dirs directly

We want to remove target specific host tools and since
fs_config_generate is compiled with a target specific header file, we
instead remove fs_config_generate entirely and allow python to build
the fs_config_files/dirs files directly from config.fs files and
parsed C headers.

Test: associated unit tests and new end to end test
Test: aosp_sailfish, aosp_crosshatch build produces valid fs_config files
Test: aosp_cf_x86_phone build correctly produces empty fs_config files
Change-Id: Idbc63ff56c0979e1e4c17721371de9d9d02dc8ff
This commit is contained in:
Tom Cherry
2019-02-13 14:02:30 -08:00
parent 1a9f8356fd
commit 9d924f67d3
16 changed files with 518 additions and 723 deletions

View File

@@ -12,6 +12,7 @@ Further documentation can be found in the README.
import argparse
import ConfigParser
import ctypes
import re
import sys
import textwrap
@@ -252,6 +253,46 @@ class FSConfig(object):
self.path, self.filename)
class CapabilityHeaderParser(object):
"""Parses capability.h file
Parses a C header file and extracts lines starting with #define CAP_<name>.
"""
_CAP_DEFINE = re.compile(r'\s*#define\s+(CAP_\S+)\s+(\S+)')
_SKIP_CAPS = ['CAP_LAST_CAP', 'CAP_TO_INDEX(x)', 'CAP_TO_MASK(x)']
def __init__(self, capability_header):
"""
Args:
capability_header (str): file name for the header file containing AID entries.
"""
self.caps = {}
with open(capability_header) as open_file:
self._parse(open_file)
def _parse(self, capability_file):
"""Parses a capability header file. Internal use only.
Args:
capability_file (file): The open capability header file to parse.
"""
for line in capability_file:
match = CapabilityHeaderParser._CAP_DEFINE.match(line)
if match:
cap = match.group(1)
value = match.group(2)
if not cap in self._SKIP_CAPS:
try:
self.caps[cap] = int(value, 0)
except ValueError:
sys.exit('Could not parse capability define "%s":"%s"'
% (cap, value))
class AIDHeaderParser(object):
"""Parses an android_filesystem_config.h file.
@@ -728,9 +769,9 @@ class FSConfigFileParser(object):
try:
# test if string is int, if it is, use as is.
int(cap, 0)
tmp.append('(' + cap + ')')
tmp.append(cap)
except ValueError:
tmp.append('CAP_MASK_LONG(CAP_' + cap.upper() + ')')
tmp.append('CAP_' + cap.upper())
caps = tmp
@@ -745,7 +786,7 @@ class FSConfigFileParser(object):
if len(mode) != 4:
sys.exit('Mode must be 3 or 4 characters, got: "%s"' % mode)
caps_str = '|'.join(caps)
caps_str = ','.join(caps)
entry = FSConfig(mode, user, group, caps_str, section_name, file_name)
if section_name[-1] == '/':
@@ -903,41 +944,20 @@ class FSConfigGen(BaseGenerator):
Output is used in generating fs_config_files and fs_config_dirs.
"""
_GENERATED = textwrap.dedent("""\
/*
* THIS IS AN AUTOGENERATED FILE! DO NOT MODIFY
*/
""")
_INCLUDES = [
'<private/android_filesystem_config.h>', '"generated_oem_aid.h"'
]
_DEFINE_NO_DIRS = '#define NO_ANDROID_FILESYSTEM_CONFIG_DEVICE_DIRS'
_DEFINE_NO_FILES = '#define NO_ANDROID_FILESYSTEM_CONFIG_DEVICE_FILES'
_DEFAULT_WARNING = (
'#warning No device-supplied android_filesystem_config.h,'
' using empty default.')
_OPEN_FILE_STRUCT = (
'static const struct fs_path_config android_device_files[] = {')
_OPEN_DIR_STRUCT = (
'static const struct fs_path_config android_device_dirs[] = {')
_CLOSE_FILE_STRUCT = '};'
_GENERIC_DEFINE = "#define %s\t%s"
_FILE_COMMENT = '// Defined in file: \"%s\"'
def __init__(self, *args, **kwargs):
BaseGenerator.__init__(args, kwargs)
self._oem_parser = None
self._base_parser = None
self._friendly_to_aid = None
self._id_to_aid = None
self._capability_parser = None
self._partition = None
self._all_partitions = None
self._out_file = None
self._generate_files = False
self._generate_dirs = False
def add_opts(self, opt_group):
@@ -950,11 +970,56 @@ class FSConfigGen(BaseGenerator):
help='An android_filesystem_config.h file'
' to parse AIDs and OEM Ranges from')
opt_group.add_argument(
'--capability-header',
required=True,
help='A capability.h file to parse capability defines from')
opt_group.add_argument(
'--partition',
required=True,
help='Partition to generate contents for')
opt_group.add_argument(
'--all-partitions',
help='Comma separated list of all possible partitions, used to'
' ignore these partitions when generating the output for the system partition'
)
opt_group.add_argument(
'--files', action='store_true', help='Output fs_config_files')
opt_group.add_argument(
'--dirs', action='store_true', help='Output fs_config_dirs')
opt_group.add_argument('--out_file', required=True, help='Output file')
def __call__(self, args):
self._capability_parser = CapabilityHeaderParser(
args['capability_header'])
self._base_parser = AIDHeaderParser(args['aid_header'])
self._oem_parser = FSConfigFileParser(args['fsconfig'],
self._base_parser.oem_ranges)
self._partition = args['partition']
self._all_partitions = args['all_partitions']
if self._partition == 'system' and self._all_partitions is None:
sys.exit(
'All other partitions must be provided if generating output'
' for the system partition')
self._out_file = args['out_file']
self._generate_files = args['files']
self._generate_dirs = args['dirs']
if self._generate_files and self._generate_dirs:
sys.exit('Only one of --files or --dirs can be provided')
if not self._generate_files and not self._generate_dirs:
sys.exit('One of --files or --dirs must be provided')
base_aids = self._base_parser.aids
oem_aids = self._oem_parser.aids
@@ -984,53 +1049,105 @@ class FSConfigGen(BaseGenerator):
self._friendly_to_aid = oem_friendly
self._friendly_to_aid.update(base_friendly)
self._id_to_aid = {aid.identifier: aid for aid in base_aids}
self._id_to_aid.update({aid.identifier: aid for aid in oem_aids})
self._generate()
def _to_fs_entry(self, fs_config):
def _to_fs_entry(self, fs_config, out_file):
"""Converts an FSConfig entry to an fs entry.
Prints '{ mode, user, group, caps, "path" },'.
Writes the fs_config contents to the output file.
Calls sys.exit() on error.
Args:
fs_config (FSConfig): The entry to convert to
a valid C array entry.
fs_config (FSConfig): The entry to convert to write to file.
file (File): The file to write to.
"""
# Get some short names
mode = fs_config.mode
user = fs_config.user
group = fs_config.group
fname = fs_config.filename
caps = fs_config.caps
path = fs_config.path
emsg = 'Cannot convert friendly name "%s" to identifier!'
emsg = 'Cannot convert "%s" to identifier!'
# remap friendly names to identifier names
# convert mode from octal string to integer
mode = int(mode, 8)
# remap names to values
if AID.is_friendly(user):
if user not in self._friendly_to_aid:
sys.exit(emsg % user)
user = self._friendly_to_aid[user].identifier
user = self._friendly_to_aid[user].value
else:
if user not in self._id_to_aid:
sys.exit(emsg % user)
user = self._id_to_aid[user].value
if AID.is_friendly(group):
if group not in self._friendly_to_aid:
sys.exit(emsg % group)
group = self._friendly_to_aid[group].identifier
group = self._friendly_to_aid[group].value
else:
if group not in self._id_to_aid:
sys.exit(emsg % group)
group = self._id_to_aid[group].value
fmt = '{ %s, %s, %s, %s, "%s" },'
caps_dict = self._capability_parser.caps
expanded = fmt % (mode, user, group, caps, path)
caps_value = 0
print FSConfigGen._FILE_COMMENT % fname
print ' ' + expanded
try:
# test if caps is an int
caps_value = int(caps, 0)
except ValueError:
caps_split = caps.split(',')
for cap in caps_split:
if cap not in caps_dict:
sys.exit('Unkonwn cap "%s" found!' % cap)
caps_value += 1 << caps_dict[cap]
@staticmethod
def _gen_inc():
"""Generate the include header lines and print to stdout."""
for include in FSConfigGen._INCLUDES:
print '#include %s' % include
path_length_with_null = len(path) + 1
path_length_aligned_64 = (path_length_with_null + 7) & ~7
# 16 bytes of header plus the path length with alignment
length = 16 + path_length_aligned_64
length_binary = bytearray(ctypes.c_uint16(length))
mode_binary = bytearray(ctypes.c_uint16(mode))
user_binary = bytearray(ctypes.c_uint16(int(user, 0)))
group_binary = bytearray(ctypes.c_uint16(int(group, 0)))
caps_binary = bytearray(ctypes.c_uint64(caps_value))
path_binary = ctypes.create_string_buffer(path,
path_length_aligned_64).raw
out_file.write(length_binary)
out_file.write(mode_binary)
out_file.write(user_binary)
out_file.write(group_binary)
out_file.write(caps_binary)
out_file.write(path_binary)
def _emit_entry(self, fs_config):
"""Returns a boolean whether or not to emit the input fs_config"""
path = fs_config.path
if self._partition == 'system':
for skip_partition in self._all_partitions.split(','):
if path.startswith(skip_partition) or path.startswith(
'system/' + skip_partition):
return False
return True
else:
if path.startswith(
self._partition) or path.startswith('system/' +
self._partition):
return True
return False
def _generate(self):
"""Generates an OEM android_filesystem_config.h header file to stdout.
@@ -1041,50 +1158,20 @@ class FSConfigGen(BaseGenerator):
entries.
aids ([AIDS]): A list of AID objects for Android Id entries.
"""
print FSConfigGen._GENERATED
print
FSConfigGen._gen_inc()
print
dirs = self._oem_parser.dirs
files = self._oem_parser.files
aids = self._oem_parser.aids
are_dirs = len(dirs) > 0
are_files = len(files) > 0
are_aids = len(aids) > 0
if self._generate_files:
with open(self._out_file, 'wb') as open_file:
for fs_config in files:
if self._emit_entry(fs_config):
self._to_fs_entry(fs_config, open_file)
if are_aids:
for aid in aids:
# use the preserved _path value
print FSConfigGen._FILE_COMMENT % aid.found
print FSConfigGen._GENERIC_DEFINE % (aid.identifier, aid.value)
print
if not are_dirs:
print FSConfigGen._DEFINE_NO_DIRS + '\n'
if not are_files:
print FSConfigGen._DEFINE_NO_FILES + '\n'
if not are_files and not are_dirs and not are_aids:
return
if are_files:
print FSConfigGen._OPEN_FILE_STRUCT
for fs_config in files:
self._to_fs_entry(fs_config)
print FSConfigGen._CLOSE_FILE_STRUCT
if are_dirs:
print FSConfigGen._OPEN_DIR_STRUCT
for dir_entry in dirs:
self._to_fs_entry(dir_entry)
print FSConfigGen._CLOSE_FILE_STRUCT
if self._generate_dirs:
with open(self._out_file, 'wb') as open_file:
for dir_entry in dirs:
if self._emit_entry(dir_entry):
self._to_fs_entry(dir_entry, open_file)
@generator('aidarray')