#!/usr/bin/env python3 from __future__ import print_function import os import sys sys.path.append(os.path.dirname(os.path.dirname(os.path.abspath(__file__)))) import unittest from compat import StringIO from vndk_definition_tool import (BannedLibDict, ELF, ELFLinker, GenericRefs, PT_SYSTEM, PT_VENDOR) class GraphBuilder(object): _PARTITION_NAMES = { PT_SYSTEM: 'system', PT_VENDOR: 'vendor', } _LIB_DIRS = { ELF.ELFCLASS32: 'lib', ELF.ELFCLASS64: 'lib64', } def __init__(self): self.graph = ELFLinker() def add_lib(self, partition, klass, name, dt_needed=[], exported_symbols=set(), imported_symbols=set(), extra_dir=None): """Create and add a shared library to ELFLinker.""" lib_dir = os.path.join('/', self._PARTITION_NAMES[partition], self._LIB_DIRS[klass]) if extra_dir: lib_dir = os.path.join(lib_dir, extra_dir) path = os.path.join(lib_dir, name + '.so') elf = ELF(klass, ELF.ELFDATA2LSB, dt_needed=dt_needed, exported_symbols=exported_symbols, imported_symbols=imported_symbols) node = self.graph.add_lib(partition, path, elf) setattr(self, name + '_' + elf.elf_class_name, node) return node def add_multilib(self, partition, name, dt_needed=[], exported_symbols=set(), imported_symbols=set(), extra_dir=None): """Add 32-bit / 64-bit shared libraries to ELFLinker.""" return ( self.add_lib(partition, ELF.ELFCLASS32, name, dt_needed, exported_symbols, imported_symbols, extra_dir), self.add_lib(partition, ELF.ELFCLASS64, name, dt_needed, exported_symbols, imported_symbols, extra_dir) ) def resolve(self): self.graph.resolve_deps() class ELFLinkerTest(unittest.TestCase): def _create_normal_graph(self): gb = GraphBuilder() gb.add_multilib(PT_SYSTEM, 'libdl', exported_symbols={'dlclose', 'dlopen', 'dlsym'}) gb.add_multilib(PT_SYSTEM, 'libm', exported_symbols={'cos', 'sin'}) gb.add_multilib(PT_SYSTEM, 'libc', dt_needed=['libdl.so', 'libm.so'], exported_symbols={'fclose', 'fopen', 'fread'}, imported_symbols={'dlclose', 'dlopen', 'cos', 'sin'}) gb.add_multilib(PT_SYSTEM, 'libRS', dt_needed=['libdl.so'], exported_symbols={'rsContextCreate'}, imported_symbols={'dlclose', 'dlopen', 'dlsym'}) gb.add_multilib(PT_SYSTEM, 'libcutils', dt_needed=['libc.so', 'libdl.so'], imported_symbols={'dlclose', 'dlopen', 'fclose', 'fopen'}) gb.add_multilib(PT_VENDOR, 'libEGL', dt_needed=['libc.so', 'libcutils.so', 'libdl.so'], exported_symbols={'eglGetDisplay'}, imported_symbols={'fclose', 'fopen'}) gb.resolve() return gb def _get_paths_from_nodes(self, nodes): return sorted([node.path for node in nodes]) def test_get_lib(self): gb = self._create_normal_graph() graph = gb.graph node = graph.get_lib('/system/lib/libc.so') self.assertEqual(gb.libc_32, node) self.assertEqual('/system/lib/libc.so', node.path) node = graph.get_lib('/system/lib64/libdl.so') self.assertEqual(gb.libdl_64, node) self.assertEqual('/system/lib64/libdl.so', node.path) node = graph.get_lib('/vendor/lib64/libEGL.so') self.assertEqual(gb.libEGL_64, node) self.assertEqual('/vendor/lib64/libEGL.so', node.path) self.assertEqual(None, graph.get_lib('/no/such/path.so')) def test_map_paths_to_libs(self): gb = self._create_normal_graph() graph = gb.graph bad = [] paths = ['/system/lib/libc.so', '/system/lib/libdl.so'] nodes = graph.get_libs(paths, bad.append) self.assertEqual([], bad) self.assertEqual(2, len(nodes)) self.assertEqual(paths, self._get_paths_from_nodes(nodes)) bad = [] paths = ['/no/such/path.so', '/system/lib64/libdl.so'] nodes = graph.get_libs(paths, bad.append) self.assertEqual(['/no/such/path.so'], bad) self.assertEqual(['/system/lib64/libdl.so'], self._get_paths_from_nodes(nodes)) def test_elf_class_and_partitions(self): gb = self._create_normal_graph() graph = gb.graph self.assertEqual(5, len(graph.lib_pt[PT_SYSTEM].lib32)) self.assertEqual(5, len(graph.lib_pt[PT_SYSTEM].lib64)) self.assertEqual(1, len(graph.lib_pt[PT_VENDOR].lib32)) self.assertEqual(1, len(graph.lib_pt[PT_VENDOR].lib64)) def test_deps(self): gb = self._create_normal_graph() graph = gb.graph # Check the dependencies of libc.so. node = gb.graph.get_lib('/system/lib/libc.so') self.assertEqual(['/system/lib/libdl.so', '/system/lib/libm.so'], self._get_paths_from_nodes(node.deps)) # Check the dependencies of libRS.so. node = gb.graph.get_lib('/system/lib64/libRS.so') self.assertEqual(['/system/lib64/libdl.so'], self._get_paths_from_nodes(node.deps)) # Check the dependencies of libEGL.so. node = gb.graph.get_lib('/vendor/lib64/libEGL.so') self.assertEqual(['/system/lib64/libc.so', '/system/lib64/libcutils.so', '/system/lib64/libdl.so'], self._get_paths_from_nodes(node.deps)) def test_linked_symbols(self): gb = self._create_normal_graph() graph = gb.graph # Check the unresolved symbols. for lib_set in graph.lib_pt: for lib in lib_set.values(): self.assertEqual(set(), lib.unresolved_symbols) # Check the linked symbols. for lib in ('lib', 'lib64'): libdl = graph.get_lib('/system/' + lib + '/libdl.so') libm = graph.get_lib('/system/' + lib + '/libm.so') libc = graph.get_lib('/system/' + lib + '/libc.so') libRS = graph.get_lib('/system/' + lib + '/libRS.so') libcutils = \ graph.get_lib('/system/' + lib + '/libcutils.so') libEGL = graph.get_lib('/vendor/' + lib + '/libEGL.so') # Check the linked symbols for libc.so. self.assertIs(libdl, libc.linked_symbols['dlclose']) self.assertIs(libdl, libc.linked_symbols['dlopen']) self.assertIs(libm, libc.linked_symbols['cos']) self.assertIs(libm, libc.linked_symbols['sin']) # Check the linked symbols for libRS.so. self.assertIs(libdl, libRS.linked_symbols['dlclose']) self.assertIs(libdl, libRS.linked_symbols['dlopen']) self.assertIs(libdl, libRS.linked_symbols['dlsym']) # Check the linked symbols for libcutils.so. self.assertIs(libdl, libcutils.linked_symbols['dlclose']) self.assertIs(libdl, libcutils.linked_symbols['dlopen']) self.assertIs(libc, libcutils.linked_symbols['fclose']) self.assertIs(libc, libcutils.linked_symbols['fopen']) # Check the linked symbols for libEGL.so. self.assertIs(libc, libEGL.linked_symbols['fclose']) self.assertIs(libc, libEGL.linked_symbols['fopen']) def test_unresolved_symbols(self): gb = GraphBuilder() gb.add_lib(PT_SYSTEM, ELF.ELFCLASS64, 'libfoo', dt_needed=[], exported_symbols={'foo', 'bar'}, imported_symbols={'__does_not_exist'}) gb.resolve() lib = gb.graph.get_lib('/system/lib64/libfoo.so') self.assertEqual({'__does_not_exist'}, lib.unresolved_symbols) def test_users(self): gb = self._create_normal_graph() graph = gb.graph # Check the users of libc.so. node = graph.get_lib('/system/lib/libc.so') self.assertEqual(['/system/lib/libcutils.so', '/vendor/lib/libEGL.so'], self._get_paths_from_nodes(node.users)) # Check the users of libdl.so. node = graph.get_lib('/system/lib/libdl.so') self.assertEqual(['/system/lib/libRS.so', '/system/lib/libc.so', '/system/lib/libcutils.so', '/vendor/lib/libEGL.so'], self._get_paths_from_nodes(node.users)) # Check the users of libRS.so. node = graph.get_lib('/system/lib64/libRS.so') self.assertEqual([], self._get_paths_from_nodes(node.users)) # Check the users of libEGL.so. node = graph.get_lib('/vendor/lib64/libEGL.so') self.assertEqual([], self._get_paths_from_nodes(node.users)) def test_compute_predefined_fwk_only_rs(self): lib_names = ( 'libft2', 'libmediandk', ) # Add VNDK-SP libraries. gb = GraphBuilder() for name in lib_names: gb.add_multilib(PT_SYSTEM, name) gb.resolve() # Compute FWK-ONLY-RS and check the result. fwk_only_rs = gb.graph.compute_predefined_fwk_only_rs() fwk_only_rs = set(lib.path for lib in fwk_only_rs) for lib_dir_name in ('lib', 'lib64'): lib_dir = '/system/' + lib_dir_name for name in lib_names: self.assertIn(os.path.join(lib_dir, name + '.so'), fwk_only_rs) def test_compute_predefined_vndk_sp(self): lib_names = ( 'android.hardware.graphics.allocator@2.0', 'android.hardware.graphics.common@1.0', 'android.hardware.graphics.mapper@2.0', 'android.hardware.renderscript@1.0', 'libRSCpuRef', 'libRSDriver', 'libRS_internal', 'libbase', 'libbcinfo', 'libc++', 'libcompiler_rt', 'libcutils', 'libhardware', 'libhidlbase', 'libhidltransport', 'libhwbinder', 'libutils', ) # Add VNDK-SP libraries. gb = GraphBuilder() for name in lib_names: gb.add_multilib(PT_SYSTEM, name, extra_dir='vndk-sp') # Add some unrelated libraries. gb.add_multilib(PT_SYSTEM, 'libfoo') gb.add_multilib(PT_SYSTEM, 'libbar', extra_dir='vndk-sp') gb.resolve() # Compute VNDK-SP and check the result. vndk_sp = set(lib.path for lib in gb.graph.compute_predefined_vndk_sp()) for lib_dir_name in ('lib', 'lib64'): lib_dir = '/system/' + lib_dir_name + '/vndk-sp' for name in lib_names: self.assertIn(os.path.join(lib_dir, name + '.so'), vndk_sp) self.assertNotIn('/system/lib/libfoo.so', vndk_sp) self.assertNotIn('/system/lib64/libfoo.so', vndk_sp) self.assertNotIn('/system/lib/vndk-sp/libbar.so', vndk_sp) self.assertNotIn('/system/lib64/vndk-sp/libbar.so', vndk_sp) def test_compute_predefined_vndk_sp_indirect(self): lib_names = ( 'libbacktrace', 'libblas', 'liblzma', 'libpng', 'libunwind', ) # Add VNDK-SP-Indirect libraries. gb = GraphBuilder() for name in lib_names: gb.add_multilib(PT_SYSTEM, name, extra_dir='vndk-sp') # Add some unrelated libraries. gb.add_multilib(PT_SYSTEM, 'libfoo') gb.add_multilib(PT_SYSTEM, 'libbar', extra_dir='vndk-sp') gb.resolve() # Compute VNDK-SP-Indirect and check the result. vndk_sp_indirect = gb.graph.compute_predefined_vndk_sp_indirect() vndk_sp_indirect = set(lib.path for lib in vndk_sp_indirect) for lib_dir_name in ('lib', 'lib64'): lib_dir = '/system/' + lib_dir_name + '/vndk-sp' for name in lib_names: self.assertIn(os.path.join(lib_dir, name + '.so'), vndk_sp_indirect) self.assertNotIn('/system/lib/libfoo.so', vndk_sp_indirect) self.assertNotIn('/system/lib64/libfoo.so', vndk_sp_indirect) self.assertNotIn('/system/lib/vndk-sp/libbar.so', vndk_sp_indirect) self.assertNotIn('/system/lib64/vndk-sp/libbar.so', vndk_sp_indirect) def test_compute_predefined_sp_hal(self): gb = GraphBuilder() # HIDL SP-HAL implementation. gb.add_multilib(PT_SYSTEM, 'gralloc.default', extra_dir='hw') gb.add_multilib(PT_SYSTEM, 'gralloc.chipset', extra_dir='hw') gb.add_multilib(PT_SYSTEM, 'android.hardware.graphics.mapper@2.0-impl', extra_dir='hw') # NDK loader libraries should not be considered as SP-HALs. gb.add_multilib(PT_SYSTEM, 'libvulkan') gb.add_multilib(PT_SYSTEM, 'libEGL') gb.add_multilib(PT_SYSTEM, 'libGLESv1_CM') gb.add_multilib(PT_SYSTEM, 'libGLESv2') gb.add_multilib(PT_SYSTEM, 'libGLESv3') # OpenGL implementation. gb.add_multilib(PT_VENDOR, 'libEGL_chipset', extra_dir='egl') gb.add_multilib(PT_VENDOR, 'libGLES_chipset', extra_dir='egl') gb.add_multilib(PT_VENDOR, 'libGLESv1_CM_chipset', extra_dir='egl') gb.add_multilib(PT_VENDOR, 'libGLESv2_chipset', extra_dir='egl') gb.add_multilib(PT_VENDOR, 'libGLESv3_chipset', extra_dir='egl') # Renderscript implementation. gb.add_multilib(PT_VENDOR, 'libRSDriver_chipset') gb.add_multilib(PT_VENDOR, 'libPVRRS') # Vulkan implementation. gb.add_multilib(PT_VENDOR, 'vulkan.chipset', extra_dir='hw') # Some un-related libraries. gb.add_multilib(PT_SYSTEM, 'libfoo') gb.add_multilib(PT_VENDOR, 'libfoo') gb.resolve() # Compute SP-HAL. sp_hals = set(lib.path for lib in gb.graph.compute_predefined_sp_hal()) for lib in ('lib', 'lib64'): # Check HIDL SP-HAL implementation. self.assertIn('/system/' + lib + '/hw/gralloc.default.so', sp_hals) self.assertIn('/system/' + lib + '/hw/gralloc.chipset.so', sp_hals) self.assertIn('/system/' + lib + '/hw/' 'android.hardware.graphics.mapper@2.0-impl.so', sp_hals) # Check that NDK loaders are not SP-HALs. self.assertNotIn('/system/' + lib + '/libvulkan.so', sp_hals) self.assertNotIn('/system/' + lib + '/libEGL.so', sp_hals) self.assertNotIn('/system/' + lib + '/libGLESv1_CM.so', sp_hals) self.assertNotIn('/system/' + lib + '/libGLESv2.so', sp_hals) self.assertNotIn('/system/' + lib + '/libGLESv3.so', sp_hals) # Check that OpenGL implementations are SP-HALs. self.assertIn('/vendor/' + lib + '/egl/libEGL_chipset.so', sp_hals) self.assertIn('/vendor/' + lib + '/egl/libGLES_chipset.so', sp_hals) self.assertIn('/vendor/' + lib + '/egl/libGLESv1_CM_chipset.so', sp_hals) self.assertIn('/vendor/' + lib + '/egl/libGLESv2_chipset.so', sp_hals) self.assertIn('/vendor/' + lib + '/egl/libGLESv3_chipset.so', sp_hals) # Check that Renderscript implementations are SP-HALs. self.assertIn('/vendor/' + lib + '/libRSDriver_chipset.so', sp_hals) self.assertIn('/vendor/' + lib + '/libPVRRS.so', sp_hals) # Check that vulkan implementation are SP-HALs. self.assertIn('/vendor/' + lib + '/libPVRRS.so', sp_hals) # Check that un-related libraries are not SP-HALs. self.assertNotIn('/system/' + lib + '/libfoo.so', sp_hals) self.assertNotIn('/vendor/' + lib + '/libfoo.so', sp_hals) def test_compute_sp_lib(self): # Create graph. gb = GraphBuilder() # LL-NDK (should be excluded from result) gb.add_multilib(PT_SYSTEM, 'libc') # SP-Both VNDK-SP gb.add_multilib(PT_SYSTEM, 'libsp_both_vs') # SP-NDK VNDK-SP gb.add_multilib(PT_SYSTEM, 'libcutils_dep', dt_needed=['libc.so']) gb.add_multilib(PT_SYSTEM, 'libcutils', dt_needed=['libc.so', 'libcutils_dep.so', 'libsp_both_vs.so']) # SP-NDK dependencies gb.add_multilib(PT_SYSTEM, 'libutils', dt_needed=['libc.so', 'libcutils.so']) # SP-NDK gb.add_multilib(PT_SYSTEM, 'libEGL', dt_needed=['libc.so', 'libutils.so']) # SP-HAL dependencies gb.add_multilib(PT_VENDOR, 'libllvm_vendor_dep') gb.add_multilib(PT_VENDOR, 'libllvm_vendor', dt_needed=['libc.so', 'libllvm_vendor_dep.so']) # SP-HAL VNDK-SP gb.add_multilib(PT_SYSTEM, 'libhidlbase') gb.add_multilib(PT_SYSTEM, 'libhidlmemory', dt_needed=['libhidlbase.so', 'libsp_both_vs.so']) # SP-HAL gb.add_multilib(PT_VENDOR, 'libEGL_chipset', extra_dir='egl', dt_needed=['libc.so', 'libllvm_vendor.so', 'libhidlmemory.so']) gb.resolve() # Create generic reference. class MockGenericRefs(object): def classify_lib(self, lib): if 'libllvm_vendor' in lib.path: return GenericRefs.NEW_LIB return GenericRefs.EXPORT_EQUAL sp_lib = gb.graph.compute_sp_lib(MockGenericRefs()) self.assertEqual(2 * 1, len(sp_lib.sp_hal)) self.assertEqual(2 * 2, len(sp_lib.sp_hal_dep)) self.assertEqual(2 * 2, len(sp_lib.vndk_sp_hal)) self.assertEqual(2 * 1, len(sp_lib.sp_ndk)) self.assertEqual(2 * 3, len(sp_lib.sp_ndk_indirect)) self.assertEqual(2 * 1, len(sp_lib.vndk_sp_both)) sp_hal = self._get_paths_from_nodes(sp_lib.sp_hal) sp_hal_dep = self._get_paths_from_nodes(sp_lib.sp_hal_dep) vndk_sp_hal = self._get_paths_from_nodes(sp_lib.vndk_sp_hal) sp_ndk = self._get_paths_from_nodes(sp_lib.sp_ndk) sp_ndk_indirect = self._get_paths_from_nodes(sp_lib.sp_ndk_indirect) vndk_sp_both = self._get_paths_from_nodes(sp_lib.vndk_sp_both) for lib_dir in ('lib', 'lib64'): # SP-Both self.assertIn('/system/{}/libsp_both_vs.so'.format(lib_dir), vndk_sp_both) # SP-NDK dependencies self.assertIn('/system/{}/libcutils.so'.format(lib_dir), sp_ndk_indirect) self.assertIn('/system/{}/libcutils_dep.so'.format(lib_dir), sp_ndk_indirect) self.assertIn('/system/{}/libutils.so'.format(lib_dir), sp_ndk_indirect) # SP-NDK self.assertIn('/system/{}/libEGL.so'.format(lib_dir), sp_ndk) # SP-HAL dependencies self.assertIn('/vendor/{}/libllvm_vendor.so'.format(lib_dir), sp_hal_dep) self.assertIn('/vendor/{}/libllvm_vendor_dep.so'.format(lib_dir), sp_hal_dep) # SP-HAL VNDK-SP self.assertIn('/system/{}/libhidlbase.so'.format(lib_dir), vndk_sp_hal) self.assertIn('/system/{}/libhidlmemory.so'.format(lib_dir), vndk_sp_hal) # SP-HAL self.assertIn('/vendor/{}/egl/libEGL_chipset.so'.format(lib_dir), sp_hal) # LL-NDK must be excluded. libc_path = '/system/{}/libc.so'.format(lib_dir) self.assertNotIn(libc_path, sp_hal) self.assertNotIn(libc_path, sp_hal_dep) self.assertNotIn(libc_path, vndk_sp_hal) self.assertNotIn(libc_path, sp_ndk) self.assertNotIn(libc_path, sp_ndk_indirect) def test_compute_vndk_cap(self): gb = GraphBuilder() # Add LL-NDK libraries. gb.add_multilib(PT_SYSTEM, 'libc') gb.add_multilib(PT_SYSTEM, 'libdl') gb.add_multilib(PT_SYSTEM, 'liblog') gb.add_multilib(PT_SYSTEM, 'libm') gb.add_multilib(PT_SYSTEM, 'libstdc++') # Add SP-NDK libraries. gb.add_multilib(PT_SYSTEM, 'libEGL') gb.add_multilib(PT_SYSTEM, 'libGLES_v2') # Add banned libraries. gb.add_multilib(PT_SYSTEM, 'libbinder') gb.add_multilib(PT_SYSTEM, 'libselinux') # Add good examples. gb.add_multilib(PT_SYSTEM, 'libgood_a', dt_needed=['libc.so']) gb.add_multilib(PT_SYSTEM, 'libgood_b', dt_needed=['libEGL.so']) gb.add_multilib(PT_SYSTEM, 'libgood_c', dt_needed=['libGLES_v2.so']) # Add bad examples. gb.add_multilib(PT_SYSTEM, 'libbad_a', dt_needed=['libbinder.so']) gb.add_multilib(PT_SYSTEM, 'libbad_b', dt_needed=['libselinux.so']) gb.add_multilib(PT_SYSTEM, 'libbad_c', dt_needed=['libbad_a.so']) gb.add_multilib(PT_SYSTEM, 'libbad_d', dt_needed=['libbad_c.so']) gb.add_multilib(PT_VENDOR, 'libbad_e', dt_needed=['libc.so']) gb.resolve() # Compute VNDK cap. banned_libs = BannedLibDict.create_default() vndk_cap = gb.graph.compute_vndk_cap(banned_libs) vndk_cap = set(lib.path for lib in vndk_cap) # Check the existence of good examples. self.assertIn('/system/lib/libgood_a.so', vndk_cap) self.assertIn('/system/lib/libgood_b.so', vndk_cap) self.assertIn('/system/lib/libgood_c.so', vndk_cap) self.assertIn('/system/lib64/libgood_a.so', vndk_cap) self.assertIn('/system/lib64/libgood_b.so', vndk_cap) self.assertIn('/system/lib64/libgood_c.so', vndk_cap) # Check the absence of bad examples. self.assertNotIn('/system/lib/libbad_a.so', vndk_cap) self.assertNotIn('/system/lib/libbad_b.so', vndk_cap) self.assertNotIn('/system/lib/libbad_c.so', vndk_cap) self.assertNotIn('/system/lib/libbad_d.so', vndk_cap) self.assertNotIn('/vendor/lib/libbad_e.so', vndk_cap) self.assertNotIn('/system/lib64/libbad_a.so', vndk_cap) self.assertNotIn('/system/lib64/libbad_b.so', vndk_cap) self.assertNotIn('/system/lib64/libbad_c.so', vndk_cap) self.assertNotIn('/system/lib64/libbad_d.so', vndk_cap) self.assertNotIn('/vendor/lib64/libbad_e.so', vndk_cap) # Check the absence of banned libraries. self.assertNotIn('/system/lib/libbinder.so', vndk_cap) self.assertNotIn('/system/lib/libselinux.so', vndk_cap) self.assertNotIn('/system/lib64/libbinder.so', vndk_cap) self.assertNotIn('/system/lib64/libselinux.so', vndk_cap) # Check the absence of NDK libraries. Although LL-NDK and SP-NDK # libraries are not banned, they are not VNDK libraries either. self.assertNotIn('/system/lib/libEGL.so', vndk_cap) self.assertNotIn('/system/lib/libOpenGLES_v2.so', vndk_cap) self.assertNotIn('/system/lib/libc.so', vndk_cap) self.assertNotIn('/system/lib/libdl.so', vndk_cap) self.assertNotIn('/system/lib/liblog.so', vndk_cap) self.assertNotIn('/system/lib/libm.so', vndk_cap) self.assertNotIn('/system/lib/libstdc++.so', vndk_cap) self.assertNotIn('/system/lib64/libEGL.so', vndk_cap) self.assertNotIn('/system/lib64/libOpenGLES_v2.so', vndk_cap) self.assertNotIn('/system/lib64/libc.so', vndk_cap) self.assertNotIn('/system/lib64/libdl.so', vndk_cap) self.assertNotIn('/system/lib64/liblog.so', vndk_cap) self.assertNotIn('/system/lib64/libm.so', vndk_cap) self.assertNotIn('/system/lib64/libstdc++.so', vndk_cap) if __name__ == '__main__': unittest.main()