vndk/tools/header-checker/utils/utils.py - platform/development - Git at Google

 #!/usr/bin/env python3

 import gzip
 import os
 import subprocess
 import sys
 import tempfile


 SCRIPT_DIR = os.path.abspath(os.path.dirname(__file__))

 try:
     AOSP_DIR = os.environ['ANDROID_BUILD_TOP']
 except KeyError:
     print('error: ANDROID_BUILD_TOP environment variable is not set.',
           file=sys.stderr)
     sys.exit(1)

 BUILTIN_HEADERS_DIR = (
     os.path.join(AOSP_DIR, 'bionic', 'libc', 'include'),
     os.path.join(AOSP_DIR, 'external', 'libcxx', 'include'),
     os.path.join(AOSP_DIR, 'prebuilts', 'clang-tools', 'linux-x86', 'clang-headers'),
 )

 EXPORTED_HEADERS_DIR = (
     os.path.join(AOSP_DIR, 'development', 'vndk', 'tools', 'header-checker',
                  'tests'),
 )

 SO_EXT = '.so'
 SOURCE_ABI_DUMP_EXT_END = '.lsdump'
 SOURCE_ABI_DUMP_EXT = SO_EXT + SOURCE_ABI_DUMP_EXT_END
 COMPRESSED_SOURCE_ABI_DUMP_EXT = SOURCE_ABI_DUMP_EXT + '.gz'
 VENDOR_SUFFIX = '.vendor'

 DEFAULT_CPPFLAGS = ['-x', 'c++', '-std=c++11']
 DEFAULT_CFLAGS = ['-std=gnu99']
 DEFAULT_HEADER_FLAGS = ["-dump-function-declarations"]
 DEFAULT_FORMAT = 'ProtobufTextFormat'

 TARGET_ARCHS = ['arm', 'arm64', 'x86', 'x86_64', 'mips', 'mips64']


 def get_reference_dump_dir(reference_dump_dir_stem,
                            reference_dump_dir_insertion, lib_arch):
     reference_dump_dir = os.path.join(reference_dump_dir_stem, lib_arch)
     reference_dump_dir = os.path.join(reference_dump_dir,
                                       reference_dump_dir_insertion)
     return reference_dump_dir


 def copy_reference_dumps(lib_paths, reference_dir_stem,
                          reference_dump_dir_insertion, lib_arch, compress):
     reference_dump_dir = get_reference_dump_dir(reference_dir_stem,
                                                 reference_dump_dir_insertion,
                                                 lib_arch)
     num_created = 0
     for lib_path in lib_paths:
         copy_reference_dump(lib_path, reference_dump_dir, compress)
         num_created += 1
     return num_created


 def copy_reference_dump(lib_path, reference_dump_dir, compress):
     reference_dump_path = os.path.join(
         reference_dump_dir, os.path.basename(lib_path))
     if compress:
         reference_dump_path += '.gz'
     os.makedirs(os.path.dirname(reference_dump_path), exist_ok=True)
     output_content = read_output_content(lib_path, AOSP_DIR)
     if compress:
         with gzip.open(reference_dump_path, 'wb') as f:
             f.write(bytes(output_content, 'utf-8'))
     else:
         with open(reference_dump_path, 'wb') as f:
             f.write(bytes(output_content, 'utf-8'))
     print('Created abi dump at', reference_dump_path)
     return reference_dump_path


 def copy_reference_dump_content(file_name, output_content,
                                 reference_dump_dir_stem,
                                 reference_dump_dir_insertion, lib_arch):
     reference_dump_dir = get_reference_dump_dir(reference_dump_dir_stem,
                                                 reference_dump_dir_insertion,
                                                 lib_arch)
     reference_dump_path = os.path.join(reference_dump_dir, file_name)
     os.makedirs(os.path.dirname(reference_dump_path), exist_ok=True)
     with open(reference_dump_path, 'w') as f:
         f.write(output_content)

     print('Created abi dump at', reference_dump_path)
     return reference_dump_path


 def read_output_content(output_path, replace_str):
     with open(output_path, 'r') as f:
         return f.read().replace(replace_str, '')


 def run_header_abi_dumper(input_path, remove_absolute_paths, cflags=tuple(),
                           export_include_dirs=EXPORTED_HEADERS_DIR,
                           flags=tuple()):
     with tempfile.TemporaryDirectory() as tmp:
         output_path = os.path.join(tmp, os.path.basename(input_path)) + '.dump'
         run_header_abi_dumper_on_file(input_path, output_path,
                                       export_include_dirs, cflags, flags)
         if remove_absolute_paths:
             return read_output_content(output_path, AOSP_DIR)
         with open(output_path, 'r') as f:
             return f.read()


 def run_header_abi_dumper_on_file(input_path, output_path,
                                   export_include_dirs=tuple(), cflags=tuple(),
                                   flags=tuple()):
     input_ext = os.path.splitext(input_path)[1]
     cmd = ['header-abi-dumper', '-o', output_path, input_path,]
     for dir in export_include_dirs:
         cmd += ['-I', dir]
     cmd += flags
     if '-output-format' not in flags:
         cmd += ['-output-format', DEFAULT_FORMAT]
     if input_ext == ".h":
         cmd += DEFAULT_HEADER_FLAGS
     cmd += ['--']
     cmd += cflags
     if input_ext in ('.cpp', '.cc', '.h'):
         cmd += DEFAULT_CPPFLAGS
     else:
         cmd += DEFAULT_CFLAGS

     for dir in BUILTIN_HEADERS_DIR:
         cmd += ['-isystem', dir]
     # The export include dirs imply local include dirs.
     for dir in export_include_dirs:
         cmd += ['-I', dir]
     subprocess.check_call(cmd)


 def run_header_abi_linker(output_path, inputs, version_script, api, arch,
                           flags=tuple()):
     """Link inputs, taking version_script into account"""
     cmd = ['header-abi-linker', '-o', output_path, '-v', version_script,
            '-api', api, '-arch', arch]
     cmd += flags
     if '-input-format' not in flags:
         cmd += ['-input-format', DEFAULT_FORMAT]
     if '-output-format' not in flags:
         cmd += ['-output-format', DEFAULT_FORMAT]
     cmd += inputs
     subprocess.check_call(cmd)
     return read_output_content(output_path, AOSP_DIR)


 def make_tree(product):
     # To aid creation of reference dumps.
     make_cmd = ['build/soong/soong_ui.bash', '--make-mode', '-j',
                 'vndk', 'findlsdumps', 'TARGET_PRODUCT=' + product]
     subprocess.check_call(make_cmd, cwd=AOSP_DIR)


 def make_targets(targets, product):
     make_cmd = ['build/soong/soong_ui.bash', '--make-mode', '-j']
     for target in targets:
         make_cmd.append(target)
     make_cmd.append('TARGET_PRODUCT=' + product)
     subprocess.check_call(make_cmd, cwd=AOSP_DIR, stdout=subprocess.DEVNULL,
                           stderr=subprocess.STDOUT)


 def make_libraries(libs, product, llndk_mode):
     # To aid creation of reference dumps. Makes lib.vendor for the current
     # configuration.
     lib_targets = []
     for lib in libs:
         lib = lib if llndk_mode else lib + VENDOR_SUFFIX
         lib_targets.append(lib)
     make_targets(lib_targets, product)


 def find_lib_lsdumps(target_arch, target_arch_variant,
                      target_cpu_variant, lsdump_paths,
                      core_or_vendor_shared_str, libs):
     """ Find the lsdump corresponding to lib_name for the given arch parameters
         if it exists"""
     assert 'ANDROID_PRODUCT_OUT' in os.environ
     cpu_variant = '_' + target_cpu_variant
     arch_variant = '_' + target_arch_variant
     arch_lsdump_paths = []
     if target_cpu_variant == 'generic' or target_cpu_variant is None or\
         target_cpu_variant == '':
         cpu_variant = ''
     if target_arch_variant == target_arch or target_arch_variant is None or\
         target_arch_variant == '':
         arch_variant = ''

     target_dir = 'android_' + target_arch + arch_variant +\
         cpu_variant + core_or_vendor_shared_str
     for key in lsdump_paths:
         if libs and key not in libs:
             continue
         for path in lsdump_paths[key]:
             if target_dir in path:
                 arch_lsdump_paths.append(os.path.join(AOSP_DIR, path.strip()))
     return arch_lsdump_paths


 def run_abi_diff(old_test_dump_path, new_test_dump_path, arch, lib_name,
                  flags=tuple()):
     abi_diff_cmd = ['header-abi-diff', '-new', new_test_dump_path, '-old',
                     old_test_dump_path, '-arch', arch, '-lib', lib_name]
     with tempfile.TemporaryDirectory() as tmp:
         output_name = os.path.join(tmp, lib_name) + '.abidiff'
         abi_diff_cmd += ['-o', output_name]
         abi_diff_cmd += flags
         if '-input-format-old' not in flags:
             abi_diff_cmd += ['-input-format-old', DEFAULT_FORMAT]
         if '-input-format-new' not in flags:
             abi_diff_cmd += ['-input-format-new', DEFAULT_FORMAT]
         try:
             subprocess.check_call(abi_diff_cmd)
         except subprocess.CalledProcessError as err:
             return err.returncode

     return 0


 def get_build_vars_for_product(names, product=None):
     """ Get build system variable for the launched target."""

     if product is None and 'ANDROID_PRODUCT_OUT' not in os.environ:
         return None

     cmd = ''
     if product is not None:
         cmd += 'source build/envsetup.sh > /dev/null && '
         cmd += 'lunch ' + product + ' > /dev/null && '
     cmd += 'build/soong/soong_ui.bash --dumpvars-mode -vars \"'
     cmd += ' '.join(names)
     cmd += '\"'

     proc = subprocess.Popen(cmd, stdout=subprocess.PIPE,
                             stderr=subprocess.DEVNULL, cwd=AOSP_DIR, shell=True)
     out, _ = proc.communicate()

     build_vars = out.decode('utf-8').strip().splitlines()

     build_vars_list = []
     for build_var in build_vars:
         value = build_var.partition('=')[2]
         build_vars_list.append(value.replace('\'', ''))
     return build_vars_list
	#!/usr/bin/env python3

	import gzip
	import os
	import subprocess
	import sys
	import tempfile


	SCRIPT_DIR = os.path.abspath(os.path.dirname(__file__))

	try:
	AOSP_DIR = os.environ['ANDROID_BUILD_TOP']
	except KeyError:
	print('error: ANDROID_BUILD_TOP environment variable is not set.',
	file=sys.stderr)
	sys.exit(1)

	BUILTIN_HEADERS_DIR = (
	os.path.join(AOSP_DIR, 'bionic', 'libc', 'include'),
	os.path.join(AOSP_DIR, 'external', 'libcxx', 'include'),
	os.path.join(AOSP_DIR, 'prebuilts', 'clang-tools', 'linux-x86', 'clang-headers'),
	)

	EXPORTED_HEADERS_DIR = (
	os.path.join(AOSP_DIR, 'development', 'vndk', 'tools', 'header-checker',
	'tests'),
	)

	SO_EXT = '.so'
	SOURCE_ABI_DUMP_EXT_END = '.lsdump'
	SOURCE_ABI_DUMP_EXT = SO_EXT + SOURCE_ABI_DUMP_EXT_END
	COMPRESSED_SOURCE_ABI_DUMP_EXT = SOURCE_ABI_DUMP_EXT + '.gz'
	VENDOR_SUFFIX = '.vendor'

	DEFAULT_CPPFLAGS = ['-x', 'c++', '-std=c++11']
	DEFAULT_CFLAGS = ['-std=gnu99']
	DEFAULT_HEADER_FLAGS = ["-dump-function-declarations"]
	DEFAULT_FORMAT = 'ProtobufTextFormat'

	TARGET_ARCHS = ['arm', 'arm64', 'x86', 'x86_64', 'mips', 'mips64']


	def get_reference_dump_dir(reference_dump_dir_stem,
	reference_dump_dir_insertion, lib_arch):
	reference_dump_dir = os.path.join(reference_dump_dir_stem, lib_arch)
	reference_dump_dir = os.path.join(reference_dump_dir,
	reference_dump_dir_insertion)
	return reference_dump_dir


	def copy_reference_dumps(lib_paths, reference_dir_stem,
	reference_dump_dir_insertion, lib_arch, compress):
	reference_dump_dir = get_reference_dump_dir(reference_dir_stem,
	reference_dump_dir_insertion,
	lib_arch)
	num_created = 0
	for lib_path in lib_paths:
	copy_reference_dump(lib_path, reference_dump_dir, compress)
	num_created += 1
	return num_created


	def copy_reference_dump(lib_path, reference_dump_dir, compress):
	reference_dump_path = os.path.join(
	reference_dump_dir, os.path.basename(lib_path))
	if compress:
	reference_dump_path += '.gz'
	os.makedirs(os.path.dirname(reference_dump_path), exist_ok=True)
	output_content = read_output_content(lib_path, AOSP_DIR)
	if compress:
	with gzip.open(reference_dump_path, 'wb') as f:
	f.write(bytes(output_content, 'utf-8'))
	else:
	with open(reference_dump_path, 'wb') as f:
	f.write(bytes(output_content, 'utf-8'))
	print('Created abi dump at', reference_dump_path)
	return reference_dump_path


	def copy_reference_dump_content(file_name, output_content,
	reference_dump_dir_stem,
	reference_dump_dir_insertion, lib_arch):
	reference_dump_dir = get_reference_dump_dir(reference_dump_dir_stem,
	reference_dump_dir_insertion,
	lib_arch)
	reference_dump_path = os.path.join(reference_dump_dir, file_name)
	os.makedirs(os.path.dirname(reference_dump_path), exist_ok=True)
	with open(reference_dump_path, 'w') as f:
	f.write(output_content)

	print('Created abi dump at', reference_dump_path)
	return reference_dump_path


	def read_output_content(output_path, replace_str):
	with open(output_path, 'r') as f:
	return f.read().replace(replace_str, '')


	def run_header_abi_dumper(input_path, remove_absolute_paths, cflags=tuple(),
	export_include_dirs=EXPORTED_HEADERS_DIR,
	flags=tuple()):
	with tempfile.TemporaryDirectory() as tmp:
	output_path = os.path.join(tmp, os.path.basename(input_path)) + '.dump'
	run_header_abi_dumper_on_file(input_path, output_path,
	export_include_dirs, cflags, flags)
	if remove_absolute_paths:
	return read_output_content(output_path, AOSP_DIR)
	with open(output_path, 'r') as f:
	return f.read()


	def run_header_abi_dumper_on_file(input_path, output_path,
	export_include_dirs=tuple(), cflags=tuple(),
	flags=tuple()):
	input_ext = os.path.splitext(input_path)[1]
	cmd = ['header-abi-dumper', '-o', output_path, input_path,]
	for dir in export_include_dirs:
	cmd += ['-I', dir]
	cmd += flags
	if '-output-format' not in flags:
	cmd += ['-output-format', DEFAULT_FORMAT]
	if input_ext == ".h":
	cmd += DEFAULT_HEADER_FLAGS
	cmd += ['--']
	cmd += cflags
	if input_ext in ('.cpp', '.cc', '.h'):
	cmd += DEFAULT_CPPFLAGS
	else:
	cmd += DEFAULT_CFLAGS

	for dir in BUILTIN_HEADERS_DIR:
	cmd += ['-isystem', dir]
	# The export include dirs imply local include dirs.
	for dir in export_include_dirs:
	cmd += ['-I', dir]
	subprocess.check_call(cmd)


	def run_header_abi_linker(output_path, inputs, version_script, api, arch,
	flags=tuple()):
	"""Link inputs, taking version_script into account"""
	cmd = ['header-abi-linker', '-o', output_path, '-v', version_script,
	'-api', api, '-arch', arch]
	cmd += flags
	if '-input-format' not in flags:
	cmd += ['-input-format', DEFAULT_FORMAT]
	if '-output-format' not in flags:
	cmd += ['-output-format', DEFAULT_FORMAT]
	cmd += inputs
	subprocess.check_call(cmd)
	return read_output_content(output_path, AOSP_DIR)


	def make_tree(product):
	# To aid creation of reference dumps.
	make_cmd = ['build/soong/soong_ui.bash', '--make-mode', '-j',
	'vndk', 'findlsdumps', 'TARGET_PRODUCT=' + product]
	subprocess.check_call(make_cmd, cwd=AOSP_DIR)


	def make_targets(targets, product):
	make_cmd = ['build/soong/soong_ui.bash', '--make-mode', '-j']
	for target in targets:
	make_cmd.append(target)
	make_cmd.append('TARGET_PRODUCT=' + product)
	subprocess.check_call(make_cmd, cwd=AOSP_DIR, stdout=subprocess.DEVNULL,
	stderr=subprocess.STDOUT)


	def make_libraries(libs, product, llndk_mode):
	# To aid creation of reference dumps. Makes lib.vendor for the current
	# configuration.
	lib_targets = []
	for lib in libs:
	lib = lib if llndk_mode else lib + VENDOR_SUFFIX
	lib_targets.append(lib)
	make_targets(lib_targets, product)


	def find_lib_lsdumps(target_arch, target_arch_variant,
	target_cpu_variant, lsdump_paths,
	core_or_vendor_shared_str, libs):
	""" Find the lsdump corresponding to lib_name for the given arch parameters
	if it exists"""
	assert 'ANDROID_PRODUCT_OUT' in os.environ
	cpu_variant = '_' + target_cpu_variant
	arch_variant = '_' + target_arch_variant
	arch_lsdump_paths = []
	if target_cpu_variant == 'generic' or target_cpu_variant is None or\
	target_cpu_variant == '':
	cpu_variant = ''
	if target_arch_variant == target_arch or target_arch_variant is None or\
	target_arch_variant == '':
	arch_variant = ''

	target_dir = 'android_' + target_arch + arch_variant +\
	cpu_variant + core_or_vendor_shared_str
	for key in lsdump_paths:
	if libs and key not in libs:
	continue
	for path in lsdump_paths[key]:
	if target_dir in path:
	arch_lsdump_paths.append(os.path.join(AOSP_DIR, path.strip()))
	return arch_lsdump_paths


	def run_abi_diff(old_test_dump_path, new_test_dump_path, arch, lib_name,
	flags=tuple()):
	abi_diff_cmd = ['header-abi-diff', '-new', new_test_dump_path, '-old',
	old_test_dump_path, '-arch', arch, '-lib', lib_name]
	with tempfile.TemporaryDirectory() as tmp:
	output_name = os.path.join(tmp, lib_name) + '.abidiff'
	abi_diff_cmd += ['-o', output_name]
	abi_diff_cmd += flags
	if '-input-format-old' not in flags:
	abi_diff_cmd += ['-input-format-old', DEFAULT_FORMAT]
	if '-input-format-new' not in flags:
	abi_diff_cmd += ['-input-format-new', DEFAULT_FORMAT]
	try:
	subprocess.check_call(abi_diff_cmd)
	except subprocess.CalledProcessError as err:
	return err.returncode

	return 0


	def get_build_vars_for_product(names, product=None):
	""" Get build system variable for the launched target."""

	if product is None and 'ANDROID_PRODUCT_OUT' not in os.environ:
	return None

	cmd = ''
	if product is not None:
	cmd += 'source build/envsetup.sh > /dev/null && '
	cmd += 'lunch ' + product + ' > /dev/null && '
	cmd += 'build/soong/soong_ui.bash --dumpvars-mode -vars \"'
	cmd += ' '.join(names)
	cmd += '\"'

	proc = subprocess.Popen(cmd, stdout=subprocess.PIPE,
	stderr=subprocess.DEVNULL, cwd=AOSP_DIR, shell=True)
	out, _ = proc.communicate()

	build_vars = out.decode('utf-8').strip().splitlines()

	build_vars_list = []
	for build_var in build_vars:
	value = build_var.partition('=')[2]
	build_vars_list.append(value.replace('\'', ''))
	return build_vars_list