From b858c6d49791bf1879983a7873c7d2a2224504cb Mon Sep 17 00:00:00 2001 From: sophiez Date: Wed, 6 May 2020 15:57:32 -0700 Subject: [PATCH] Add ndk api parser for ndk api coverage. Test: m test_ndk_api_coverage_parser Change-Id: I7be4f505757b1ca915de5e378952f8b104e1d362 --- OWNERS | 1 + cc/ndk_library.go | 2 +- cc/scriptlib/Android.bp | 23 ++++ cc/scriptlib/__init__.py | 0 cc/{ => scriptlib}/gen_stub_libs.py | 1 + cc/scriptlib/ndk_api_coverage_parser.py | 134 +++++++++++++++++++ cc/{ => scriptlib}/test_gen_stub_libs.py | 0 cc/scriptlib/test_ndk_api_coverage_parser.py | 66 +++++++++ 8 files changed, 226 insertions(+), 1 deletion(-) create mode 100644 cc/scriptlib/Android.bp create mode 100644 cc/scriptlib/__init__.py rename cc/{ => scriptlib}/gen_stub_libs.py (99%) create mode 100755 cc/scriptlib/ndk_api_coverage_parser.py rename cc/{ => scriptlib}/test_gen_stub_libs.py (100%) create mode 100644 cc/scriptlib/test_ndk_api_coverage_parser.py diff --git a/OWNERS b/OWNERS index e1db45940..4cecb3dc1 100644 --- a/OWNERS +++ b/OWNERS @@ -5,3 +5,4 @@ per-file clang.go,global.go = srhines@google.com, chh@google.com, pirama@google. per-file tidy.go = srhines@google.com, chh@google.com per-file lto.go,pgo.go = srhines@google.com, pirama@google.com, yikong@google.com per-file docs/map_files.md = danalbert@google.com, enh@google.com, jiyong@google.com +per-file *ndk_api_coverage_parser.py = sophiez@google.com \ No newline at end of file diff --git a/cc/ndk_library.go b/cc/ndk_library.go index 1597b88d0..3759329ee 100644 --- a/cc/ndk_library.go +++ b/cc/ndk_library.go @@ -26,7 +26,7 @@ import ( ) var ( - toolPath = pctx.SourcePathVariable("toolPath", "build/soong/cc/gen_stub_libs.py") + toolPath = pctx.SourcePathVariable("toolPath", "build/soong/cc/scriptlib/gen_stub_libs.py") genStubSrc = pctx.AndroidStaticRule("genStubSrc", blueprint.RuleParams{ diff --git a/cc/scriptlib/Android.bp b/cc/scriptlib/Android.bp new file mode 100644 index 000000000..daebfe156 --- /dev/null +++ b/cc/scriptlib/Android.bp @@ -0,0 +1,23 @@ +// +// Copyright (C) 2020 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +python_test_host { + name: "test_ndk_api_coverage_parser", + main: "test_ndk_api_coverage_parser.py", + srcs: [ + "test_ndk_api_coverage_parser.py", + ], +} diff --git a/cc/scriptlib/__init__.py b/cc/scriptlib/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/cc/gen_stub_libs.py b/cc/scriptlib/gen_stub_libs.py similarity index 99% rename from cc/gen_stub_libs.py rename to cc/scriptlib/gen_stub_libs.py index 7deb804c3..d61dfbb07 100755 --- a/cc/gen_stub_libs.py +++ b/cc/scriptlib/gen_stub_libs.py @@ -246,6 +246,7 @@ class Symbol(object): def __eq__(self, other): return self.name == other.name and set(self.tags) == set(other.tags) + class SymbolFileParser(object): """Parses NDK symbol files.""" def __init__(self, input_file, api_map, arch, api, llndk, apex): diff --git a/cc/scriptlib/ndk_api_coverage_parser.py b/cc/scriptlib/ndk_api_coverage_parser.py new file mode 100755 index 000000000..d74035b2a --- /dev/null +++ b/cc/scriptlib/ndk_api_coverage_parser.py @@ -0,0 +1,134 @@ +#!/usr/bin/env python +# +# Copyright (C) 2020 The Android Open Source Project +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +"""Generates xml of NDK libraries used for API coverage analysis.""" +import argparse +import json +import os +import sys + +from xml.etree.ElementTree import Element, SubElement, tostring +from gen_stub_libs import ALL_ARCHITECTURES, FUTURE_API_LEVEL, MultiplyDefinedSymbolError, SymbolFileParser + + +ROOT_ELEMENT_TAG = 'ndk-library' +SYMBOL_ELEMENT_TAG = 'symbol' +ARCHITECTURE_ATTRIBUTE_KEY = 'arch' +DEPRECATED_ATTRIBUTE_KEY = 'is_deprecated' +PLATFORM_ATTRIBUTE_KEY = 'is_platform' +NAME_ATTRIBUTE_KEY = 'name' +VARIABLE_TAG = 'var' +EXPOSED_TARGET_TAGS = ( + 'vndk', + 'apex', + 'llndk', +) +API_LEVEL_TAG_PREFIXES = ( + 'introduced=', + 'introduced-', +) + + +def parse_tags(tags): + """Parses tags and save needed tags in the created attributes. + + Return attributes dictionary. + """ + attributes = {} + arch = [] + for tag in tags: + if tag.startswith(tuple(API_LEVEL_TAG_PREFIXES)): + key, _, value = tag.partition('=') + attributes.update({key: value}) + elif tag in ALL_ARCHITECTURES: + arch.append(tag) + elif tag in EXPOSED_TARGET_TAGS: + attributes.update({tag: 'True'}) + attributes.update({ARCHITECTURE_ATTRIBUTE_KEY: ','.join(arch)}) + return attributes + + +class XmlGenerator(object): + """Output generator that writes parsed symbol file to a xml file.""" + def __init__(self, output_file): + self.output_file = output_file + + def convertToXml(self, versions): + """Writes all symbol data to the output file.""" + root = Element(ROOT_ELEMENT_TAG) + for version in versions: + if VARIABLE_TAG in version.tags: + continue + version_attributes = parse_tags(version.tags) + _, _, postfix = version.name.partition('_') + is_platform = postfix == 'PRIVATE' or postfix == 'PLATFORM' + is_deprecated = postfix == 'DEPRECATED' + version_attributes.update({PLATFORM_ATTRIBUTE_KEY: str(is_platform)}) + version_attributes.update({DEPRECATED_ATTRIBUTE_KEY: str(is_deprecated)}) + for symbol in version.symbols: + if VARIABLE_TAG in symbol.tags: + continue + attributes = {NAME_ATTRIBUTE_KEY: symbol.name} + attributes.update(version_attributes) + # If same version tags already exist, it will be overwrite here. + attributes.update(parse_tags(symbol.tags)) + SubElement(root, SYMBOL_ELEMENT_TAG, attributes) + return root + + def write_xml_to_file(self, root): + """Write xml element root to output_file.""" + parsed_data = tostring(root) + output_file = open(self.output_file, "wb") + output_file.write(parsed_data) + + def write(self, versions): + root = self.convertToXml(versions) + self.write_xml_to_file(root) + + +def parse_args(): + """Parses and returns command line arguments.""" + parser = argparse.ArgumentParser() + + parser.add_argument('symbol_file', type=os.path.realpath, help='Path to symbol file.') + parser.add_argument( + 'output_file', type=os.path.realpath, + help='The output parsed api coverage file.') + parser.add_argument( + '--api-map', type=os.path.realpath, required=True, + help='Path to the API level map JSON file.') + return parser.parse_args() + + +def main(): + """Program entry point.""" + args = parse_args() + + with open(args.api_map) as map_file: + api_map = json.load(map_file) + + with open(args.symbol_file) as symbol_file: + try: + versions = SymbolFileParser(symbol_file, api_map, "", FUTURE_API_LEVEL, + True, True).parse() + except MultiplyDefinedSymbolError as ex: + sys.exit('{}: error: {}'.format(args.symbol_file, ex)) + + generator = XmlGenerator(args.output_file) + generator.write(versions) + +if __name__ == '__main__': + main() diff --git a/cc/test_gen_stub_libs.py b/cc/scriptlib/test_gen_stub_libs.py similarity index 100% rename from cc/test_gen_stub_libs.py rename to cc/scriptlib/test_gen_stub_libs.py diff --git a/cc/scriptlib/test_ndk_api_coverage_parser.py b/cc/scriptlib/test_ndk_api_coverage_parser.py new file mode 100644 index 000000000..a3c9b708c --- /dev/null +++ b/cc/scriptlib/test_ndk_api_coverage_parser.py @@ -0,0 +1,66 @@ +#!/usr/bin/env python +# +# Copyright (C) 2016 The Android Open Source Project +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# +"""Tests for ndk_api_coverage_parser.py.""" +import io +import textwrap +import unittest + +from xml.etree.ElementTree import tostring +from gen_stub_libs import FUTURE_API_LEVEL, SymbolFileParser +import ndk_api_coverage_parser as nparser + + +# pylint: disable=missing-docstring + + +class ApiCoverageSymbolFileParserTest(unittest.TestCase): + def test_parse(self): + input_file = io.StringIO(textwrap.dedent(u"""\ + LIBLOG { # introduced-arm64=24 introduced-x86=24 introduced-x86_64=24 + global: + android_name_to_log_id; # apex llndk introduced=23 + android_log_id_to_name; # llndk arm + __android_log_assert; # introduced-x86=23 + __android_log_buf_print; # var + __android_log_buf_write; + local: + *; + }; + + LIBLOG_PLATFORM { + android_fdtrack; # llndk + android_net; # introduced=23 + }; + + LIBLOG_FOO { # var + android_var; + }; + """)) + parser = SymbolFileParser(input_file, {}, "", FUTURE_API_LEVEL, True, True) + generator = nparser.XmlGenerator(io.StringIO()) + result = tostring(generator.convertToXml(parser.parse())).decode() + expected = '' + self.assertEqual(expected, result) + + +def main(): + suite = unittest.TestLoader().loadTestsFromName(__name__) + unittest.TextTestRunner(verbosity=3).run(suite) + + +if __name__ == '__main__': + main()