Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1 | #!/usr/bin/env python3 |
| 2 | # Copyright (C) 2022 The Android Open Source Project |
| 3 | # |
| 4 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | # you may not use this file except in compliance with the License. |
| 6 | # You may obtain a copy of the License at |
| 7 | # |
| 8 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | # |
| 10 | # Unless required by applicable law or agreed to in writing, software |
| 11 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | # See the License for the specific language governing permissions and |
| 14 | # limitations under the License. |
| 15 | |
| 16 | # This tool translates a collection of BUILD.gn files into a mostly equivalent |
| 17 | # Android.bp file for the Android Soong build system. The input to the tool is a |
| 18 | # JSON description of the GN build definition generated with the following |
| 19 | # command: |
| 20 | # |
| 21 | # gn desc out --format=json --all-toolchains "//*" > desc.json |
| 22 | # |
| 23 | # The tool is then given a list of GN labels for which to generate Android.bp |
| 24 | # build rules. The dependencies for the GN labels are squashed to the generated |
| 25 | # Android.bp target, except for actions which get their own genrule. Some |
| 26 | # libraries are also mapped to their Android equivalents -- see |builtin_deps|. |
| 27 | |
| 28 | import argparse |
| 29 | import collections |
| 30 | import json |
Patrick Rohr | 1622894 | 2022-10-26 14:00:26 -0700 | [diff] [blame] | 31 | import logging as log |
Patrick Rohr | 3a2c3dd | 2022-11-29 22:29:36 -0800 | [diff] [blame] | 32 | import operator |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 33 | import os |
| 34 | import re |
| 35 | import sys |
Motomu Utsumi | c6277d9 | 2022-11-07 15:15:17 +0900 | [diff] [blame] | 36 | import copy |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 37 | |
| 38 | import gn_utils |
| 39 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 40 | ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) |
| 41 | |
Patrick Rohr | 0629636 | 2022-11-10 21:37:33 -0800 | [diff] [blame] | 42 | # Default targets to translate to the blueprint file. |
| 43 | default_targets = [ |
| 44 | '//components/cronet/android:cronet', |
Motomu Utsumi | abbfdc3 | 2022-11-25 12:19:23 +0900 | [diff] [blame] | 45 | '//components/cronet:cronet_package', |
Patrick Rohr | 0629636 | 2022-11-10 21:37:33 -0800 | [diff] [blame] | 46 | ] |
| 47 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 48 | # Defines a custom init_rc argument to be applied to the corresponding output |
| 49 | # blueprint target. |
| 50 | target_initrc = { |
Patrick Rohr | c36ef42 | 2022-10-25 10:38:05 -0700 | [diff] [blame] | 51 | # TODO: this can probably be removed. |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 52 | } |
| 53 | |
| 54 | target_host_supported = [ |
Patrick Rohr | dc38394 | 2022-10-25 10:45:29 -0700 | [diff] [blame] | 55 | # TODO: remove if this is not useful for the cronet build. |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 56 | ] |
| 57 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 58 | # Proto target groups which will be made public. |
| 59 | proto_groups = { |
Patrick Rohr | 95212a2 | 2022-10-25 09:53:13 -0700 | [diff] [blame] | 60 | # TODO: remove if this is not used for the cronet build. |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 61 | } |
| 62 | |
| 63 | # All module names are prefixed with this string to avoid collisions. |
Patrick Rohr | 61b2bad | 2022-10-25 10:49:20 -0700 | [diff] [blame] | 64 | module_prefix = 'cronet_aml_' |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 65 | |
| 66 | # Shared libraries which are directly translated to Android system equivalents. |
| 67 | shared_library_allowlist = [ |
| 68 | 'android', |
| 69 | 'android.hardware.atrace@1.0', |
| 70 | 'android.hardware.health@2.0', |
| 71 | 'android.hardware.health-V1-ndk', |
| 72 | 'android.hardware.power.stats@1.0', |
| 73 | "android.hardware.power.stats-V1-cpp", |
| 74 | 'base', |
| 75 | 'binder', |
| 76 | 'binder_ndk', |
| 77 | 'cutils', |
| 78 | 'hidlbase', |
| 79 | 'hidltransport', |
| 80 | 'hwbinder', |
| 81 | 'incident', |
| 82 | 'log', |
| 83 | 'services', |
| 84 | 'statssocket', |
| 85 | "tracingproxy", |
| 86 | 'utils', |
| 87 | ] |
| 88 | |
| 89 | # Static libraries which are directly translated to Android system equivalents. |
| 90 | static_library_allowlist = [ |
| 91 | 'statslog_perfetto', |
| 92 | ] |
| 93 | |
Patrick Rohr | d9dd3b9 | 2022-11-09 16:15:30 -0800 | [diff] [blame] | 94 | # Include directories that will be removed from all targets. |
| 95 | local_include_dirs_denylist = [ |
Patrick Rohr | d9dd3b9 | 2022-11-09 16:15:30 -0800 | [diff] [blame] | 96 | ] |
| 97 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 98 | # Name of the module which settings such as compiler flags for all other |
| 99 | # modules. |
| 100 | defaults_module = module_prefix + 'defaults' |
| 101 | |
| 102 | # Location of the project in the Android source tree. |
Patrick Rohr | 76ceeb5 | 2022-11-07 14:18:58 -0800 | [diff] [blame] | 103 | tree_path = 'external/chromium_org' |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 104 | |
| 105 | # Path for the protobuf sources in the standalone build. |
| 106 | buildtools_protobuf_src = '//buildtools/protobuf/src' |
| 107 | |
| 108 | # Location of the protobuf src dir in the Android source tree. |
| 109 | android_protobuf_src = 'external/protobuf/src' |
| 110 | |
Mohannad Farrag | c739dda | 2022-12-02 15:43:46 +0000 | [diff] [blame] | 111 | # put all args on a new line for better diffs. |
| 112 | NEWLINE = ' " +\n "' |
Mohannad Farrag | 00ecfb5 | 2022-12-02 14:44:15 +0000 | [diff] [blame] | 113 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 114 | # Compiler flags which are passed through to the blueprint. |
Motomu Utsumi | c8b7bea | 2022-11-16 18:12:44 +0900 | [diff] [blame] | 115 | cflag_allowlist = [ |
Motomu Utsumi | cf68d73 | 2022-11-16 18:15:21 +0900 | [diff] [blame] | 116 | # needed for zlib:zlib |
| 117 | "-mpclmul", |
| 118 | # needed for zlib:zlib |
| 119 | "-mssse3", |
Mohannad Farrag | 7f29d83 | 2022-11-23 19:52:41 +0000 | [diff] [blame] | 120 | # needed for zlib:zlib |
| 121 | "-msse3", |
| 122 | # needed for zlib:zlib |
| 123 | "-msse4.2", |
Motomu Utsumi | c8b7bea | 2022-11-16 18:12:44 +0900 | [diff] [blame] | 124 | ] |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 125 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 126 | # Additional arguments to apply to Android.bp rules. |
| 127 | additional_args = { |
Patrick Rohr | 2267a0a | 2022-11-08 18:59:34 -0800 | [diff] [blame] | 128 | # TODO: remove if not needed. |
Patrick Rohr | d90025f | 2022-11-11 14:18:35 -0800 | [diff] [blame] | 129 | 'cronet_aml_components_cronet_android_cronet': [ |
| 130 | ('linker_scripts', { |
| 131 | 'base/android/library_loader/anchor_functions.lds', |
| 132 | }), |
| 133 | ], |
Patrick Rohr | bb0956e | 2022-11-09 15:37:16 -0800 | [diff] [blame] | 134 | 'cronet_aml_net_net': [ |
Patrick Rohr | 9f4d3e3 | 2022-11-09 16:37:31 -0800 | [diff] [blame] | 135 | ('export_static_lib_headers', { |
| 136 | 'cronet_aml_net_third_party_quiche_quiche', |
| 137 | 'cronet_aml_crypto_crypto', |
| 138 | }), |
Mohannad Farrag | 37388fa | 2022-11-10 20:42:13 +0000 | [diff] [blame] | 139 | ], |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 140 | } |
| 141 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 142 | # Android equivalents for third-party libraries that the upstream project |
| 143 | # depends on. |
| 144 | builtin_deps = { |
Patrick Rohr | 14ee093 | 2022-11-15 12:10:27 -0800 | [diff] [blame] | 145 | '//net/tools/root_store_tool:root_store_tool': |
| 146 | lambda x: None, |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 147 | } |
| 148 | |
Motomu Utsumi | 8ca1241 | 2022-11-30 16:27:30 +0900 | [diff] [blame] | 149 | # Name of tethering apex module |
| 150 | tethering_apex = "com.android.tethering" |
| 151 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 152 | # ---------------------------------------------------------------------------- |
| 153 | # End of configuration. |
| 154 | # ---------------------------------------------------------------------------- |
| 155 | |
| 156 | |
| 157 | class Error(Exception): |
| 158 | pass |
| 159 | |
| 160 | |
| 161 | class ThrowingArgumentParser(argparse.ArgumentParser): |
| 162 | |
| 163 | def __init__(self, context): |
| 164 | super(ThrowingArgumentParser, self).__init__() |
| 165 | self.context = context |
| 166 | |
| 167 | def error(self, message): |
| 168 | raise Error('%s: %s' % (self.context, message)) |
| 169 | |
| 170 | |
| 171 | def write_blueprint_key_value(output, name, value, sort=True): |
| 172 | """Writes a Blueprint key-value pair to the output""" |
| 173 | |
| 174 | if isinstance(value, bool): |
| 175 | if value: |
| 176 | output.append(' %s: true,' % name) |
| 177 | else: |
| 178 | output.append(' %s: false,' % name) |
| 179 | return |
| 180 | if not value: |
| 181 | return |
| 182 | if isinstance(value, set): |
| 183 | value = sorted(value) |
| 184 | if isinstance(value, list): |
| 185 | output.append(' %s: [' % name) |
| 186 | for item in sorted(value) if sort else value: |
| 187 | output.append(' "%s",' % item) |
| 188 | output.append(' ],') |
| 189 | return |
| 190 | if isinstance(value, Target): |
| 191 | value.to_string(output) |
| 192 | return |
| 193 | if isinstance(value, dict): |
| 194 | kv_output = [] |
| 195 | for k, v in value.items(): |
| 196 | write_blueprint_key_value(kv_output, k, v) |
| 197 | |
| 198 | output.append(' %s: {' % name) |
| 199 | for line in kv_output: |
| 200 | output.append(' %s' % line) |
| 201 | output.append(' },') |
| 202 | return |
| 203 | output.append(' %s: "%s",' % (name, value)) |
| 204 | |
| 205 | |
| 206 | class Target(object): |
| 207 | """A target-scoped part of a module""" |
| 208 | |
| 209 | def __init__(self, name): |
| 210 | self.name = name |
Patrick Rohr | 5d399b3 | 2022-11-16 10:19:55 -0800 | [diff] [blame] | 211 | self.srcs = set() |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 212 | self.shared_libs = set() |
| 213 | self.static_libs = set() |
| 214 | self.whole_static_libs = set() |
Patrick Rohr | c03f1bb | 2022-11-18 16:13:17 -0800 | [diff] [blame] | 215 | self.header_libs = set() |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 216 | self.cflags = set() |
| 217 | self.dist = dict() |
| 218 | self.strip = dict() |
| 219 | self.stl = None |
Motomu Utsumi | 50ad217 | 2022-11-17 22:29:53 +0900 | [diff] [blame] | 220 | self.cppflags = set() |
Patrick Rohr | 3cd5ffb | 2022-11-18 17:40:55 -0800 | [diff] [blame] | 221 | self.local_include_dirs = set() |
Patrick Rohr | 8143516 | 2022-11-17 19:34:32 -0800 | [diff] [blame] | 222 | self.export_system_include_dirs = set() |
Mohannad Farrag | 631443e | 2022-11-21 16:17:01 +0000 | [diff] [blame] | 223 | self.generated_headers = set() |
| 224 | self.export_generated_headers = set() |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 225 | |
| 226 | def to_string(self, output): |
| 227 | nested_out = [] |
Patrick Rohr | 5d399b3 | 2022-11-16 10:19:55 -0800 | [diff] [blame] | 228 | self._output_field(nested_out, 'srcs') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 229 | self._output_field(nested_out, 'shared_libs') |
| 230 | self._output_field(nested_out, 'static_libs') |
| 231 | self._output_field(nested_out, 'whole_static_libs') |
Patrick Rohr | c03f1bb | 2022-11-18 16:13:17 -0800 | [diff] [blame] | 232 | self._output_field(nested_out, 'header_libs') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 233 | self._output_field(nested_out, 'cflags') |
| 234 | self._output_field(nested_out, 'stl') |
| 235 | self._output_field(nested_out, 'dist') |
| 236 | self._output_field(nested_out, 'strip') |
Motomu Utsumi | 50ad217 | 2022-11-17 22:29:53 +0900 | [diff] [blame] | 237 | self._output_field(nested_out, 'cppflags') |
| 238 | self._output_field(nested_out, 'local_include_dirs') |
Patrick Rohr | 8143516 | 2022-11-17 19:34:32 -0800 | [diff] [blame] | 239 | self._output_field(nested_out, 'export_system_include_dirs') |
Mohannad Farrag | 631443e | 2022-11-21 16:17:01 +0000 | [diff] [blame] | 240 | self._output_field(nested_out, 'generated_headers') |
| 241 | self._output_field(nested_out, 'export_generated_headers') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 242 | |
| 243 | if nested_out: |
| 244 | output.append(' %s: {' % self.name) |
| 245 | for line in nested_out: |
| 246 | output.append(' %s' % line) |
| 247 | output.append(' },') |
| 248 | |
| 249 | def _output_field(self, output, name, sort=True): |
| 250 | value = getattr(self, name) |
| 251 | return write_blueprint_key_value(output, name, value, sort) |
| 252 | |
| 253 | |
| 254 | class Module(object): |
| 255 | """A single module (e.g., cc_binary, cc_test) in a blueprint.""" |
| 256 | |
| 257 | def __init__(self, mod_type, name, gn_target): |
| 258 | self.type = mod_type |
| 259 | self.gn_target = gn_target |
| 260 | self.name = name |
| 261 | self.srcs = set() |
Patrick Rohr | 0787666 | 2022-11-15 22:55:23 -0800 | [diff] [blame] | 262 | self.comment = 'GN: ' + gn_target |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 263 | self.shared_libs = set() |
| 264 | self.static_libs = set() |
| 265 | self.whole_static_libs = set() |
| 266 | self.runtime_libs = set() |
| 267 | self.tools = set() |
| 268 | self.cmd = None |
| 269 | self.host_supported = False |
Patrick Rohr | cdda632 | 2022-11-15 22:44:16 -0800 | [diff] [blame] | 270 | self.device_supported = True |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 271 | self.vendor_available = False |
| 272 | self.init_rc = set() |
| 273 | self.out = set() |
| 274 | self.export_include_dirs = set() |
| 275 | self.generated_headers = set() |
| 276 | self.export_generated_headers = set() |
Patrick Rohr | bb0956e | 2022-11-09 15:37:16 -0800 | [diff] [blame] | 277 | self.export_static_lib_headers = set() |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 278 | self.defaults = set() |
| 279 | self.cflags = set() |
| 280 | self.include_dirs = set() |
Patrick Rohr | 3cd5ffb | 2022-11-18 17:40:55 -0800 | [diff] [blame] | 281 | self.local_include_dirs = set() |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 282 | self.header_libs = set() |
| 283 | self.required = set() |
Patrick Rohr | 3d8c728 | 2022-10-27 13:36:31 -0700 | [diff] [blame] | 284 | self.tool_files = set() |
Patrick Rohr | bfdc5fd | 2022-11-16 10:03:49 -0800 | [diff] [blame] | 285 | # target contains a dict of Targets indexed by os_arch. |
| 286 | # example: { 'android_x86': Target('android_x86') |
| 287 | self.target = dict() |
| 288 | self.target['android'] = Target('android') |
Patrick Rohr | 82e4074 | 2022-11-16 10:20:39 -0800 | [diff] [blame] | 289 | self.target['android_x86'] = Target('android_x86') |
| 290 | self.target['android_x86_64'] = Target('android_x86_64') |
| 291 | self.target['android_arm'] = Target('android_arm') |
| 292 | self.target['android_arm64'] = Target('android_arm64') |
Patrick Rohr | bfdc5fd | 2022-11-16 10:03:49 -0800 | [diff] [blame] | 293 | self.target['host'] = Target('host') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 294 | self.stl = None |
Patrick Rohr | b8f830a | 2022-10-31 11:18:57 -0700 | [diff] [blame] | 295 | self.cpp_std = None |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 296 | self.dist = dict() |
| 297 | self.strip = dict() |
| 298 | self.data = set() |
| 299 | self.apex_available = set() |
| 300 | self.min_sdk_version = None |
| 301 | self.proto = dict() |
Patrick Rohr | d90025f | 2022-11-11 14:18:35 -0800 | [diff] [blame] | 302 | self.linker_scripts = set() |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 303 | # The genrule_XXX below are properties that must to be propagated back |
| 304 | # on the module(s) that depend on the genrule. |
| 305 | self.genrule_headers = set() |
| 306 | self.genrule_srcs = set() |
| 307 | self.genrule_shared_libs = set() |
Patrick Rohr | a1a2787 | 2022-10-31 11:57:14 -0700 | [diff] [blame] | 308 | self.genrule_header_libs = set() |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 309 | self.version_script = None |
| 310 | self.test_suites = set() |
| 311 | self.test_config = None |
| 312 | self.stubs = {} |
Mohannad Farrag | 37388fa | 2022-11-10 20:42:13 +0000 | [diff] [blame] | 313 | self.cppflags = set() |
| 314 | self.rtti = False |
Motomu Utsumi | ee47af6 | 2022-11-30 16:41:15 +0900 | [diff] [blame] | 315 | # Name of the output. Used for setting .so file name for libcronet |
| 316 | self.stem = None |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 317 | |
| 318 | def to_string(self, output): |
| 319 | if self.comment: |
| 320 | output.append('// %s' % self.comment) |
| 321 | output.append('%s {' % self.type) |
| 322 | self._output_field(output, 'name') |
| 323 | self._output_field(output, 'srcs') |
| 324 | self._output_field(output, 'shared_libs') |
| 325 | self._output_field(output, 'static_libs') |
| 326 | self._output_field(output, 'whole_static_libs') |
| 327 | self._output_field(output, 'runtime_libs') |
| 328 | self._output_field(output, 'tools') |
| 329 | self._output_field(output, 'cmd', sort=False) |
| 330 | if self.host_supported: |
| 331 | self._output_field(output, 'host_supported') |
Patrick Rohr | cdda632 | 2022-11-15 22:44:16 -0800 | [diff] [blame] | 332 | if not self.device_supported: |
| 333 | self._output_field(output, 'device_supported') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 334 | if self.vendor_available: |
| 335 | self._output_field(output, 'vendor_available') |
| 336 | self._output_field(output, 'init_rc') |
| 337 | self._output_field(output, 'out') |
| 338 | self._output_field(output, 'export_include_dirs') |
| 339 | self._output_field(output, 'generated_headers') |
| 340 | self._output_field(output, 'export_generated_headers') |
Patrick Rohr | bb0956e | 2022-11-09 15:37:16 -0800 | [diff] [blame] | 341 | self._output_field(output, 'export_static_lib_headers') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 342 | self._output_field(output, 'defaults') |
| 343 | self._output_field(output, 'cflags') |
| 344 | self._output_field(output, 'include_dirs') |
Patrick Rohr | 3cd5ffb | 2022-11-18 17:40:55 -0800 | [diff] [blame] | 345 | self._output_field(output, 'local_include_dirs') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 346 | self._output_field(output, 'header_libs') |
| 347 | self._output_field(output, 'required') |
| 348 | self._output_field(output, 'dist') |
| 349 | self._output_field(output, 'strip') |
| 350 | self._output_field(output, 'tool_files') |
| 351 | self._output_field(output, 'data') |
| 352 | self._output_field(output, 'stl') |
Patrick Rohr | b8f830a | 2022-10-31 11:18:57 -0700 | [diff] [blame] | 353 | self._output_field(output, 'cpp_std') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 354 | self._output_field(output, 'apex_available') |
| 355 | self._output_field(output, 'min_sdk_version') |
| 356 | self._output_field(output, 'version_script') |
| 357 | self._output_field(output, 'test_suites') |
| 358 | self._output_field(output, 'test_config') |
| 359 | self._output_field(output, 'stubs') |
| 360 | self._output_field(output, 'proto') |
Patrick Rohr | d90025f | 2022-11-11 14:18:35 -0800 | [diff] [blame] | 361 | self._output_field(output, 'linker_scripts') |
Mohannad Farrag | 37388fa | 2022-11-10 20:42:13 +0000 | [diff] [blame] | 362 | self._output_field(output, 'cppflags') |
Motomu Utsumi | ee47af6 | 2022-11-30 16:41:15 +0900 | [diff] [blame] | 363 | self._output_field(output, 'stem') |
Mohannad Farrag | 37388fa | 2022-11-10 20:42:13 +0000 | [diff] [blame] | 364 | if self.rtti: |
| 365 | self._output_field(output, 'rtti') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 366 | |
| 367 | target_out = [] |
Patrick Rohr | 09ee70e | 2022-11-16 15:20:03 -0800 | [diff] [blame] | 368 | for arch, target in sorted(self.target.items()): |
Patrick Rohr | bfdc5fd | 2022-11-16 10:03:49 -0800 | [diff] [blame] | 369 | # _output_field calls getattr(self, arch). |
| 370 | setattr(self, arch, target) |
| 371 | self._output_field(target_out, arch) |
| 372 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 373 | if target_out: |
| 374 | output.append(' target: {') |
| 375 | for line in target_out: |
| 376 | output.append(' %s' % line) |
| 377 | output.append(' },') |
| 378 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 379 | output.append('}') |
| 380 | output.append('') |
| 381 | |
| 382 | def add_android_static_lib(self, lib): |
| 383 | if self.type == 'cc_binary_host': |
| 384 | raise Exception('Adding Android static lib for host tool is unsupported') |
| 385 | elif self.host_supported: |
Patrick Rohr | bfdc5fd | 2022-11-16 10:03:49 -0800 | [diff] [blame] | 386 | self.target['android'].static_libs.add(lib) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 387 | else: |
| 388 | self.static_libs.add(lib) |
| 389 | |
| 390 | def add_android_shared_lib(self, lib): |
| 391 | if self.type == 'cc_binary_host': |
| 392 | raise Exception('Adding Android shared lib for host tool is unsupported') |
| 393 | elif self.host_supported: |
Patrick Rohr | bfdc5fd | 2022-11-16 10:03:49 -0800 | [diff] [blame] | 394 | self.target['android'].shared_libs.add(lib) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 395 | else: |
| 396 | self.shared_libs.add(lib) |
| 397 | |
| 398 | def _output_field(self, output, name, sort=True): |
| 399 | value = getattr(self, name) |
| 400 | return write_blueprint_key_value(output, name, value, sort) |
| 401 | |
Patrick Rohr | a6ce023 | 2022-11-16 22:09:01 -0800 | [diff] [blame] | 402 | def is_compiled(self): |
Mohannad Farrag | 7ff9991 | 2022-11-29 17:16:00 +0000 | [diff] [blame] | 403 | return self.type not in ('cc_genrule', 'filegroup', 'java_genrule') |
Mohannad Farrag | 1de6cb1 | 2022-11-28 12:27:26 +0000 | [diff] [blame] | 404 | |
| 405 | def is_genrule(self): |
| 406 | return self.type == "cc_genrule" |
Patrick Rohr | a6ce023 | 2022-11-16 22:09:01 -0800 | [diff] [blame] | 407 | |
Mohannad Farrag | 7f29d83 | 2022-11-23 19:52:41 +0000 | [diff] [blame] | 408 | def has_input_files(self): |
Mohannad Farrag | 7f29d83 | 2022-11-23 19:52:41 +0000 | [diff] [blame] | 409 | return len(self.srcs) > 0 or any([len(target.srcs) > 0 for target in self.target.values()]) |
| 410 | |
Mohannad Farrag | f2391cc | 2022-11-29 13:26:32 +0000 | [diff] [blame] | 411 | def merge_attribute(self, key, source_module, allowed_archs, source_key = None): |
| 412 | """ |
| 413 | Merges the value of the attribute `source_key` for the `dep_module` with |
| 414 | the value of the attribute `key` for this module. If the value of the |
| 415 | `source_key` is equal to None. Then `key` is used for both modules. |
| 416 | |
| 417 | This merges the attribute for both non-arch and archs |
| 418 | specified in `allowed_archs`. |
| 419 | :param key: The attribute used for merging in the calling module. Also |
| 420 | used for `dep_module` if the `source_key` is None. |
| 421 | :param source_module: The module where data is propagated from. |
| 422 | :param allowed_archs: A list of archs to merge the attribute on. |
| 423 | :param source_key: if the attribute merged from the `dep_module` |
| 424 | is different from the `key` |
| 425 | """ |
| 426 | if not source_key: |
| 427 | source_key = key |
| 428 | self.__dict__[key].update(source_module.__dict__[source_key]) |
| 429 | for arch_name in source_module.target.keys(): |
| 430 | if arch_name in allowed_archs: |
| 431 | self.target[arch_name].__dict__[key].update( |
| 432 | source_module.target[arch_name].__dict__[source_key]) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 433 | |
| 434 | class Blueprint(object): |
| 435 | """In-memory representation of an Android.bp file.""" |
| 436 | |
| 437 | def __init__(self): |
| 438 | self.modules = {} |
| 439 | |
| 440 | def add_module(self, module): |
| 441 | """Adds a new module to the blueprint, replacing any existing module |
| 442 | with the same name. |
| 443 | |
| 444 | Args: |
| 445 | module: Module instance. |
| 446 | """ |
| 447 | self.modules[module.name] = module |
| 448 | |
| 449 | def to_string(self, output): |
Patrick Rohr | 23f2619 | 2022-10-25 09:45:22 -0700 | [diff] [blame] | 450 | for m in sorted(self.modules.values(), key=lambda m: m.name): |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 451 | m.to_string(output) |
| 452 | |
| 453 | |
| 454 | def label_to_module_name(label): |
| 455 | """Turn a GN label (e.g., //:perfetto_tests) into a module name.""" |
Patrick Rohr | 0787666 | 2022-11-15 22:55:23 -0800 | [diff] [blame] | 456 | module = re.sub(r'^//:?', '', label) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 457 | module = re.sub(r'[^a-zA-Z0-9_]', '_', module) |
Motomu Utsumi | 3fde148 | 2022-11-14 15:55:21 +0900 | [diff] [blame] | 458 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 459 | if not module.startswith(module_prefix): |
| 460 | return module_prefix + module |
| 461 | return module |
| 462 | |
| 463 | |
| 464 | def is_supported_source_file(name): |
| 465 | """Returns True if |name| can appear in a 'srcs' list.""" |
Patrick Rohr | f9f3a99 | 2022-11-10 19:40:32 -0800 | [diff] [blame] | 466 | return os.path.splitext(name)[1] in ['.c', '.cc', '.cpp', '.java', '.proto', '.S'] |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 467 | |
| 468 | |
| 469 | def create_proto_modules(blueprint, gn, target): |
| 470 | """Generate genrules for a proto GN target. |
| 471 | |
| 472 | GN actions are used to dynamically generate files during the build. The |
| 473 | Soong equivalent is a genrule. This function turns a specific kind of |
| 474 | genrule which turns .proto files into source and header files into a pair |
| 475 | equivalent genrules. |
| 476 | |
| 477 | Args: |
| 478 | blueprint: Blueprint instance which is being generated. |
| 479 | target: gn_utils.Target object. |
| 480 | |
| 481 | Returns: |
| 482 | The source_genrule module. |
| 483 | """ |
| 484 | assert (target.type == 'proto_library') |
| 485 | |
Motomu Utsumi | bd4013f | 2022-11-17 16:06:05 +0900 | [diff] [blame] | 486 | protoc_gn_target_name = gn.get_target('//third_party/protobuf:protoc').name |
Motomu Utsumi | d58c1dc | 2022-11-16 18:04:46 +0900 | [diff] [blame] | 487 | protoc_module_name = label_to_module_name(protoc_gn_target_name) |
| 488 | tools = {protoc_module_name} |
Motomu Utsumi | d7e0e42 | 2022-11-08 17:49:52 +0900 | [diff] [blame] | 489 | cpp_out_dir = '$(genDir)/%s/%s/' % (tree_path, target.proto_in_dir) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 490 | target_module_name = label_to_module_name(target.name) |
| 491 | |
| 492 | # In GN builds the proto path is always relative to the output directory |
| 493 | # (out/tmp.xxx). |
Motomu Utsumi | d58c1dc | 2022-11-16 18:04:46 +0900 | [diff] [blame] | 494 | cmd = ['$(location %s)' % protoc_module_name] |
Motomu Utsumi | d7e0e42 | 2022-11-08 17:49:52 +0900 | [diff] [blame] | 495 | cmd += ['--proto_path=%s/%s' % (tree_path, target.proto_in_dir)] |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 496 | |
| 497 | if buildtools_protobuf_src in target.proto_paths: |
| 498 | cmd += ['--proto_path=%s' % android_protobuf_src] |
| 499 | |
| 500 | # We don't generate any targets for source_set proto modules because |
| 501 | # they will be inlined into other modules if required. |
| 502 | if target.proto_plugin == 'source_set': |
| 503 | return None |
| 504 | |
| 505 | # Descriptor targets only generate a single target. |
| 506 | if target.proto_plugin == 'descriptor': |
| 507 | out = '{}.bin'.format(target_module_name) |
| 508 | |
| 509 | cmd += ['--descriptor_set_out=$(out)'] |
| 510 | cmd += ['$(in)'] |
| 511 | |
Mohannad Farrag | 1de6cb1 | 2022-11-28 12:27:26 +0000 | [diff] [blame] | 512 | descriptor_module = Module('cc_genrule', target_module_name, target.name) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 513 | descriptor_module.cmd = ' '.join(cmd) |
| 514 | descriptor_module.out = [out] |
| 515 | descriptor_module.tools = tools |
| 516 | blueprint.add_module(descriptor_module) |
| 517 | |
| 518 | # Recursively extract the .proto files of all the dependencies and |
| 519 | # add them to srcs. |
| 520 | descriptor_module.srcs.update( |
| 521 | gn_utils.label_to_path(src) for src in target.sources) |
| 522 | for dep in target.transitive_proto_deps: |
| 523 | current_target = gn.get_target(dep) |
| 524 | descriptor_module.srcs.update( |
| 525 | gn_utils.label_to_path(src) for src in current_target.sources) |
| 526 | |
| 527 | return descriptor_module |
| 528 | |
| 529 | # We create two genrules for each proto target: one for the headers and |
| 530 | # another for the sources. This is because the module that depends on the |
| 531 | # generated files needs to declare two different types of dependencies -- |
| 532 | # source files in 'srcs' and headers in 'generated_headers' -- and it's not |
| 533 | # valid to generate .h files from a source dependency and vice versa. |
| 534 | source_module_name = target_module_name + '_gen' |
Mohannad Farrag | 1de6cb1 | 2022-11-28 12:27:26 +0000 | [diff] [blame] | 535 | source_module = Module('cc_genrule', source_module_name, target.name) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 536 | blueprint.add_module(source_module) |
| 537 | source_module.srcs.update( |
| 538 | gn_utils.label_to_path(src) for src in target.sources) |
| 539 | |
Mohannad Farrag | 1de6cb1 | 2022-11-28 12:27:26 +0000 | [diff] [blame] | 540 | header_module = Module('cc_genrule', source_module_name + '_headers', |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 541 | target.name) |
| 542 | blueprint.add_module(header_module) |
| 543 | header_module.srcs = set(source_module.srcs) |
| 544 | |
| 545 | # TODO(primiano): at some point we should remove this. This was introduced |
| 546 | # by aosp/1108421 when adding "protos/" to .proto include paths, in order to |
| 547 | # avoid doing multi-repo changes and allow old clients in the android tree |
| 548 | # to still do the old #include "perfetto/..." rather than |
| 549 | # #include "protos/perfetto/...". |
| 550 | header_module.export_include_dirs = {'.', 'protos'} |
Patrick Rohr | 2267a0a | 2022-11-08 18:59:34 -0800 | [diff] [blame] | 551 | # Since the .cc file and .h get created by a different gerule target, they |
| 552 | # are not put in the same intermediate path, so local includes do not work |
| 553 | # without explictily exporting the include dir. |
| 554 | header_module.export_include_dirs.add(target.proto_in_dir) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 555 | |
Motomu Utsumi | 8ca1241 | 2022-11-30 16:27:30 +0900 | [diff] [blame] | 556 | # This function does not return header_module so setting apex_available attribute here. |
| 557 | header_module.apex_available.add(tethering_apex) |
| 558 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 559 | source_module.genrule_srcs.add(':' + source_module.name) |
| 560 | source_module.genrule_headers.add(header_module.name) |
| 561 | |
| 562 | if target.proto_plugin == 'proto': |
| 563 | suffixes = ['pb'] |
| 564 | source_module.genrule_shared_libs.add('libprotobuf-cpp-lite') |
| 565 | cmd += ['--cpp_out=lite=true:' + cpp_out_dir] |
| 566 | elif target.proto_plugin == 'protozero': |
| 567 | suffixes = ['pbzero'] |
| 568 | plugin = create_modules_from_target(blueprint, gn, protozero_plugin) |
| 569 | tools.add(plugin.name) |
| 570 | cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name] |
| 571 | cmd += ['--plugin_out=wrapper_namespace=pbzero:' + cpp_out_dir] |
| 572 | elif target.proto_plugin == 'cppgen': |
| 573 | suffixes = ['gen'] |
| 574 | plugin = create_modules_from_target(blueprint, gn, cppgen_plugin) |
| 575 | tools.add(plugin.name) |
| 576 | cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name] |
| 577 | cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir] |
| 578 | elif target.proto_plugin == 'ipc': |
| 579 | suffixes = ['ipc'] |
| 580 | plugin = create_modules_from_target(blueprint, gn, ipc_plugin) |
| 581 | tools.add(plugin.name) |
| 582 | cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name] |
| 583 | cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir] |
| 584 | else: |
| 585 | raise Error('Unsupported proto plugin: %s' % target.proto_plugin) |
| 586 | |
| 587 | cmd += ['$(in)'] |
| 588 | source_module.cmd = ' '.join(cmd) |
| 589 | header_module.cmd = source_module.cmd |
| 590 | source_module.tools = tools |
| 591 | header_module.tools = tools |
| 592 | |
| 593 | for sfx in suffixes: |
| 594 | source_module.out.update('%s/%s' % |
| 595 | (tree_path, src.replace('.proto', '.%s.cc' % sfx)) |
| 596 | for src in source_module.srcs) |
| 597 | header_module.out.update('%s/%s' % |
| 598 | (tree_path, src.replace('.proto', '.%s.h' % sfx)) |
| 599 | for src in header_module.srcs) |
| 600 | return source_module |
| 601 | |
| 602 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 603 | def create_proto_group_modules(blueprint, gn, module_name, target_names): |
| 604 | # TODO(lalitm): today, we're only adding a Java lite module because that's |
| 605 | # the only one used in practice. In the future, if we need other target types |
| 606 | # (e.g. C++, Java full etc.) add them here. |
| 607 | bp_module_name = label_to_module_name(module_name) + '_java_protos' |
| 608 | module = Module('java_library', bp_module_name, bp_module_name) |
| 609 | module.comment = f'''GN: [{', '.join(target_names)}]''' |
| 610 | module.proto = {'type': 'lite', 'canonical_path_from_root': False} |
| 611 | |
| 612 | for name in target_names: |
| 613 | target = gn.get_target(name) |
| 614 | module.srcs.update(gn_utils.label_to_path(src) for src in target.sources) |
| 615 | for dep_label in target.transitive_proto_deps: |
| 616 | dep = gn.get_target(dep_label) |
| 617 | module.srcs.update(gn_utils.label_to_path(src) for src in dep.sources) |
| 618 | |
| 619 | blueprint.add_module(module) |
| 620 | |
Patrick Rohr | f6de33f | 2022-11-29 22:02:55 -0800 | [diff] [blame] | 621 | |
Mohannad Farrag | 420c14e | 2022-11-30 17:13:15 +0000 | [diff] [blame] | 622 | class BaseActionSanitizer(): |
Patrick Rohr | f6de33f | 2022-11-29 22:02:55 -0800 | [diff] [blame] | 623 | def __init__(self, target): |
Patrick Rohr | 9e414b5 | 2022-11-29 22:12:18 -0800 | [diff] [blame] | 624 | # Just to be on the safe side, create a deep-copy. |
| 625 | self.target = copy.deepcopy(target) |
Motomu Utsumi | 9752bd3 | 2022-12-02 15:16:55 +0900 | [diff] [blame] | 626 | self.target.args = self._normalize_args() |
| 627 | |
Mohannad Farrag | 7f7c9b4 | 2022-12-02 14:37:56 +0000 | [diff] [blame] | 628 | def get_name(self): |
| 629 | return label_to_module_name(self.target.name) |
| 630 | |
Motomu Utsumi | 9752bd3 | 2022-12-02 15:16:55 +0900 | [diff] [blame] | 631 | def _normalize_args(self): |
Patrick Rohr | 9e414b5 | 2022-11-29 22:12:18 -0800 | [diff] [blame] | 632 | # Convert ['--param=value'] to ['--param', 'value'] for consistency. |
Mohannad Farrag | 60b3770 | 2022-12-02 14:07:33 +0000 | [diff] [blame] | 633 | # Escape quotations. |
Motomu Utsumi | 9752bd3 | 2022-12-02 15:16:55 +0900 | [diff] [blame] | 634 | normalized_args = [] |
| 635 | for arg in self.target.args: |
Mohannad Farrag | 60b3770 | 2022-12-02 14:07:33 +0000 | [diff] [blame] | 636 | arg = arg.replace('"', r'\"') |
Motomu Utsumi | 1339932 | 2022-12-02 15:36:48 +0900 | [diff] [blame] | 637 | if arg.startswith('-'): |
| 638 | normalized_args.extend(arg.split('=')) |
| 639 | else: |
| 640 | normalized_args.append(arg) |
Motomu Utsumi | 9752bd3 | 2022-12-02 15:16:55 +0900 | [diff] [blame] | 641 | return normalized_args |
Patrick Rohr | f6de33f | 2022-11-29 22:02:55 -0800 | [diff] [blame] | 642 | |
Patrick Rohr | 2cad933 | 2022-11-30 14:27:40 -0800 | [diff] [blame] | 643 | # There are three types of args: |
| 644 | # - flags (--flag) |
| 645 | # - value args (--arg value) |
| 646 | # - list args (--arg value1 --arg value2) |
Motomu Utsumi | 8be8a26 | 2022-12-02 14:35:15 +0900 | [diff] [blame] | 647 | # value args have exactly one arg value pair and list args have one or more arg value pairs. |
Motomu Utsumi | 923688c | 2022-12-01 15:51:05 +0900 | [diff] [blame] | 648 | # Note that the set of list args contains the set of value args. |
Motomu Utsumi | 8be8a26 | 2022-12-02 14:35:15 +0900 | [diff] [blame] | 649 | # This is because list and value args are identical when the list args has only one arg value pair |
Patrick Rohr | 2cad933 | 2022-11-30 14:27:40 -0800 | [diff] [blame] | 650 | # Some functions provide special implementations for each type, while others |
| 651 | # work on all of them. |
Patrick Rohr | f6de33f | 2022-11-29 22:02:55 -0800 | [diff] [blame] | 652 | def _has_arg(self, arg): |
| 653 | return arg in self.target.args |
| 654 | |
Motomu Utsumi | 923688c | 2022-12-01 15:51:05 +0900 | [diff] [blame] | 655 | def _get_arg_indices(self, target_arg): |
| 656 | return [i for i, arg in enumerate(self.target.args) if arg == target_arg] |
Patrick Rohr | 3a2c3dd | 2022-11-29 22:29:36 -0800 | [diff] [blame] | 657 | |
Motomu Utsumi | 923688c | 2022-12-01 15:51:05 +0900 | [diff] [blame] | 658 | # Whether an arg value pair appears once or more times |
| 659 | def _is_list_arg(self, arg): |
| 660 | indices = self._get_arg_indices(arg) |
| 661 | return len(indices) > 0 and all([not self.target.args[i + 1].startswith('--') for i in indices]) |
| 662 | |
Motomu Utsumi | c363b41 | 2022-12-01 16:01:58 +0900 | [diff] [blame] | 663 | def _update_list_arg(self, arg, func, throw_if_absent = True): |
| 664 | if self._should_fail_silently(arg, throw_if_absent): |
| 665 | return |
| 666 | assert(self._is_list_arg(arg)) |
| 667 | indices = self._get_arg_indices(arg) |
| 668 | for i in indices: |
| 669 | self._set_arg_at(i + 1, func(self.target.args[i + 1])) |
| 670 | |
Motomu Utsumi | 923688c | 2022-12-01 15:51:05 +0900 | [diff] [blame] | 671 | # Whether an arg value pair appears exactly once |
Patrick Rohr | ef4f2bf | 2022-11-30 14:22:40 -0800 | [diff] [blame] | 672 | def _is_value_arg(self, arg): |
Motomu Utsumi | d75b8b5 | 2022-12-02 14:29:00 +0900 | [diff] [blame] | 673 | return operator.countOf(self.target.args, arg) == 1 and self._is_list_arg(arg) |
Patrick Rohr | f6de33f | 2022-11-29 22:02:55 -0800 | [diff] [blame] | 674 | |
Patrick Rohr | 2cad933 | 2022-11-30 14:27:40 -0800 | [diff] [blame] | 675 | def _get_value_arg(self, arg): |
Patrick Rohr | ef4f2bf | 2022-11-30 14:22:40 -0800 | [diff] [blame] | 676 | assert(self._is_value_arg(arg)) |
Patrick Rohr | f6de33f | 2022-11-29 22:02:55 -0800 | [diff] [blame] | 677 | i = self.target.args.index(arg) |
| 678 | return self.target.args[i + 1] |
| 679 | |
Patrick Rohr | f0abead | 2022-11-30 19:44:10 -0800 | [diff] [blame] | 680 | # used to check whether a function call should cause an error when an arg is |
| 681 | # missing. |
| 682 | def _should_fail_silently(self, arg, throw_if_absent): |
| 683 | return not throw_if_absent and not self._has_arg(arg) |
| 684 | |
| 685 | def _set_value_arg(self, arg, value, throw_if_absent = True): |
| 686 | if self._should_fail_silently(arg, throw_if_absent): |
Patrick Rohr | 4d74aed | 2022-11-30 15:42:16 -0800 | [diff] [blame] | 687 | return |
Patrick Rohr | ef4f2bf | 2022-11-30 14:22:40 -0800 | [diff] [blame] | 688 | assert(self._is_value_arg(arg)) |
Patrick Rohr | f6de33f | 2022-11-29 22:02:55 -0800 | [diff] [blame] | 689 | i = self.target.args.index(arg) |
| 690 | self.target.args[i + 1] = value |
| 691 | |
Patrick Rohr | f0abead | 2022-11-30 19:44:10 -0800 | [diff] [blame] | 692 | def _update_value_arg(self, arg, func, throw_if_absent = True): |
| 693 | if self._should_fail_silently(arg, throw_if_absent): |
Patrick Rohr | 4d74aed | 2022-11-30 15:42:16 -0800 | [diff] [blame] | 694 | return |
Patrick Rohr | 1bedf6c | 2022-11-30 15:12:57 -0800 | [diff] [blame] | 695 | self._set_value_arg(arg, func(self._get_value_arg(arg))) |
| 696 | |
Patrick Rohr | 77c4f5c | 2022-11-30 12:56:29 -0800 | [diff] [blame] | 697 | def _set_arg_at(self, position, value): |
Mohannad Farrag | 9ab1793 | 2022-11-30 17:28:35 +0000 | [diff] [blame] | 698 | self.target.args[position] = value |
| 699 | |
Patrick Rohr | 357b25c | 2022-11-30 19:46:26 -0800 | [diff] [blame] | 700 | def _delete_value_arg(self, arg, throw_if_absent = True): |
Patrick Rohr | f0abead | 2022-11-30 19:44:10 -0800 | [diff] [blame] | 701 | if self._should_fail_silently(arg, throw_if_absent): |
Patrick Rohr | 4d74aed | 2022-11-30 15:42:16 -0800 | [diff] [blame] | 702 | return |
Patrick Rohr | 357b25c | 2022-11-30 19:46:26 -0800 | [diff] [blame] | 703 | assert(self._is_value_arg(arg)) |
Patrick Rohr | 9f43932 | 2022-11-30 15:56:15 -0800 | [diff] [blame] | 704 | i = self.target.args.index(arg) |
Patrick Rohr | f6de33f | 2022-11-29 22:02:55 -0800 | [diff] [blame] | 705 | self.target.args.pop(i) |
Patrick Rohr | 357b25c | 2022-11-30 19:46:26 -0800 | [diff] [blame] | 706 | self.target.args.pop(i) |
Patrick Rohr | f6de33f | 2022-11-29 22:02:55 -0800 | [diff] [blame] | 707 | |
Patrick Rohr | 1f7dd58 | 2022-11-30 13:44:07 -0800 | [diff] [blame] | 708 | def _append_arg(self, arg, value): |
| 709 | self.target.args.append(arg) |
| 710 | self.target.args.append(value) |
| 711 | |
Mohannad Farrag | 8fa9065 | 2022-12-01 15:40:40 +0000 | [diff] [blame] | 712 | def _sanitize_filepath_with_location_tag(self, arg): |
| 713 | if arg.startswith('../../'): |
| 714 | arg = self._sanitize_filepath(arg) |
| 715 | arg = self._add_location_tag(arg) |
| 716 | return arg |
| 717 | |
Patrick Rohr | 73ef7ae | 2022-11-29 22:33:09 -0800 | [diff] [blame] | 718 | # wrap filename in location tag. |
Patrick Rohr | fda02673 | 2022-11-30 16:07:11 -0800 | [diff] [blame] | 719 | def _add_location_tag(self, filename): |
Patrick Rohr | 73ef7ae | 2022-11-29 22:33:09 -0800 | [diff] [blame] | 720 | return '$(location %s)' % filename |
| 721 | |
Patrick Rohr | 0e24c5f | 2022-11-30 15:20:21 -0800 | [diff] [blame] | 722 | # applies common directory transformation that *should* be universally applicable. |
| 723 | # TODO: verify if it actually *is* universally applicable. |
Patrick Rohr | 872a281 | 2022-11-30 19:28:22 -0800 | [diff] [blame] | 724 | def _sanitize_filepath(self, filepath): |
Patrick Rohr | 0e24c5f | 2022-11-30 15:20:21 -0800 | [diff] [blame] | 725 | # Careful, order matters! |
Patrick Rohr | 8bcd783 | 2022-11-30 19:48:56 -0800 | [diff] [blame] | 726 | # delete all leading ../ |
Patrick Rohr | 9e5a3c7 | 2022-11-30 15:51:30 -0800 | [diff] [blame] | 727 | filepath = re.sub('^(\.\./)+', '', filepath) |
Patrick Rohr | 0e24c5f | 2022-11-30 15:20:21 -0800 | [diff] [blame] | 728 | filepath = re.sub('^gen/jni_headers', '$(genDir)', filepath) |
| 729 | filepath = re.sub('^gen', '$(genDir)', filepath) |
| 730 | return filepath |
Patrick Rohr | 3227689 | 2022-11-29 22:38:13 -0800 | [diff] [blame] | 731 | |
Motomu Utsumi | 21485ba | 2022-12-01 17:01:50 +0900 | [diff] [blame] | 732 | # Iterate through all the args and apply function |
| 733 | def _update_all_args(self, func): |
| 734 | self.target.args = [func(arg) for arg in self.target.args] |
| 735 | |
Mohannad Farrag | d5515ca | 2022-12-02 15:39:53 +0000 | [diff] [blame] | 736 | def get_cmd(self): |
Mohannad Farrag | c739dda | 2022-12-02 15:43:46 +0000 | [diff] [blame] | 737 | arg_string = NEWLINE.join(self.target.args) |
| 738 | cmd = '$(location %s) %s' % ( |
| 739 | gn_utils.label_to_path(self.target.script), arg_string) |
| 740 | |
| 741 | if self.use_response_file: |
| 742 | # Pipe response file contents into script |
| 743 | cmd = 'echo \'%s\' |%s%s' % (self.target.response_file_contents, NEWLINE, cmd) |
| 744 | return cmd |
Mohannad Farrag | d5515ca | 2022-12-02 15:39:53 +0000 | [diff] [blame] | 745 | |
Motomu Utsumi | 5afd081 | 2022-12-02 15:43:36 +0900 | [diff] [blame] | 746 | def get_outputs(self): |
| 747 | return self.target.outputs |
| 748 | |
Motomu Utsumi | 80fa0b0 | 2022-12-05 12:50:57 +0900 | [diff] [blame] | 749 | def get_srcs(self): |
| 750 | # gn treats inputs and sources for actions equally. |
| 751 | # soong only supports source files inside srcs, non-source files are added as |
| 752 | # tool_files dependency. |
| 753 | files = self.target.sources.union(self.target.inputs) |
| 754 | return {gn_utils.label_to_path(file) for file in files if is_supported_source_file(file)} |
| 755 | |
Motomu Utsumi | aaf42cf | 2022-12-05 12:55:02 +0900 | [diff] [blame] | 756 | def get_tool_files(self): |
| 757 | # gn treats inputs and sources for actions equally. |
| 758 | # soong only supports source files inside srcs, non-source files are added as |
| 759 | # tool_files dependency. |
| 760 | files = self.target.sources.union(self.target.inputs) |
Motomu Utsumi | 6997586 | 2022-12-05 12:59:06 +0900 | [diff] [blame] | 761 | tool_files = {gn_utils.label_to_path(file) |
| 762 | for file in files if not is_supported_source_file(file)} |
| 763 | tool_files.add(gn_utils.label_to_path(self.target.script)) |
| 764 | return tool_files |
Motomu Utsumi | aaf42cf | 2022-12-05 12:55:02 +0900 | [diff] [blame] | 765 | |
Motomu Utsumi | cdb45ea | 2022-12-02 17:05:07 +0900 | [diff] [blame] | 766 | def _sanitize_args(self): |
Mohannad Farrag | 00ecfb5 | 2022-12-02 14:44:15 +0000 | [diff] [blame] | 767 | # Handle passing parameters via response file by piping them into the script |
| 768 | # and reading them from /dev/stdin. |
| 769 | |
Mohannad Farrag | a0e37c1 | 2022-12-02 14:46:08 +0000 | [diff] [blame] | 770 | self.use_response_file = gn_utils.RESPONSE_FILE in self.target.args |
Mohannad Farrag | 00ecfb5 | 2022-12-02 14:44:15 +0000 | [diff] [blame] | 771 | if self.use_response_file: |
| 772 | # Replace {{response_file_contents}} with /dev/stdin |
Mohannad Farrag | a0e37c1 | 2022-12-02 14:46:08 +0000 | [diff] [blame] | 773 | self.target.args = ['/dev/stdin' if it == gn_utils.RESPONSE_FILE else it |
| 774 | for it in self.target.args] |
Motomu Utsumi | cdb45ea | 2022-12-02 17:05:07 +0900 | [diff] [blame] | 775 | |
| 776 | def _sanitize_outputs(self): |
| 777 | pass |
| 778 | |
Motomu Utsumi | 735a5a4 | 2022-12-05 12:15:07 +0900 | [diff] [blame] | 779 | def _sanitize_inputs(self): |
| 780 | pass |
| 781 | |
Motomu Utsumi | cdb45ea | 2022-12-02 17:05:07 +0900 | [diff] [blame] | 782 | def sanitize(self): |
| 783 | self._sanitize_args() |
| 784 | self._sanitize_outputs() |
Motomu Utsumi | 735a5a4 | 2022-12-05 12:15:07 +0900 | [diff] [blame] | 785 | self._sanitize_inputs() |
Motomu Utsumi | cdb45ea | 2022-12-02 17:05:07 +0900 | [diff] [blame] | 786 | |
Motomu Utsumi | 7db7583 | 2022-12-02 16:46:22 +0900 | [diff] [blame] | 787 | # Whether this target generates header files |
| 788 | def is_header_generated(self): |
Motomu Utsumi | a91ade6 | 2022-12-02 16:58:36 +0900 | [diff] [blame] | 789 | return any(os.path.splitext(it)[1] == '.h' for it in self.target.outputs) |
Motomu Utsumi | 7db7583 | 2022-12-02 16:46:22 +0900 | [diff] [blame] | 790 | |
Mohannad Farrag | 9ab1793 | 2022-11-30 17:28:35 +0000 | [diff] [blame] | 791 | class WriteBuildDateHeaderSanitizer(BaseActionSanitizer): |
Motomu Utsumi | 805591d | 2022-12-02 17:17:16 +0900 | [diff] [blame] | 792 | def _sanitize_args(self): |
Patrick Rohr | 77c4f5c | 2022-11-30 12:56:29 -0800 | [diff] [blame] | 793 | self._set_arg_at(0, '$(out)') |
Motomu Utsumi | 805591d | 2022-12-02 17:17:16 +0900 | [diff] [blame] | 794 | super()._sanitize_args() |
Mohannad Farrag | 9ab1793 | 2022-11-30 17:28:35 +0000 | [diff] [blame] | 795 | |
Mohannad Farrag | 71353f9 | 2022-11-30 17:20:48 +0000 | [diff] [blame] | 796 | class WriteBuildFlagHeaderSanitizer(BaseActionSanitizer): |
Motomu Utsumi | 805591d | 2022-12-02 17:17:16 +0900 | [diff] [blame] | 797 | def _sanitize_args(self): |
Patrick Rohr | 2cad933 | 2022-11-30 14:27:40 -0800 | [diff] [blame] | 798 | self._set_value_arg('--gen-dir', '.') |
| 799 | self._set_value_arg('--output', '$(out)') |
Motomu Utsumi | 805591d | 2022-12-02 17:17:16 +0900 | [diff] [blame] | 800 | super()._sanitize_args() |
Patrick Rohr | f6de33f | 2022-11-29 22:02:55 -0800 | [diff] [blame] | 801 | |
Patrick Rohr | 0242a3f | 2022-11-30 13:48:59 -0800 | [diff] [blame] | 802 | class JniGeneratorSanitizer(BaseActionSanitizer): |
Motomu Utsumi | 4d551d7 | 2022-12-01 16:18:23 +0900 | [diff] [blame] | 803 | def _add_location_tag_to_filepath(self, arg): |
| 804 | if not arg.endswith('.class'): |
| 805 | # --input_file supports both .class specifiers or source files as arguments. |
| 806 | # Only source files need to be wrapped inside a $(location <label>) tag. |
| 807 | arg = self._add_location_tag(arg) |
| 808 | return arg |
| 809 | |
Motomu Utsumi | 805591d | 2022-12-02 17:17:16 +0900 | [diff] [blame] | 810 | def _sanitize_args(self): |
Patrick Rohr | f0abead | 2022-11-30 19:44:10 -0800 | [diff] [blame] | 811 | self._update_value_arg('--jar_file', self._sanitize_filepath, False) |
| 812 | self._update_value_arg('--jar_file', self._add_location_tag, False) |
Patrick Rohr | 0242a3f | 2022-11-30 13:48:59 -0800 | [diff] [blame] | 813 | if self._has_arg('--jar_file'): |
| 814 | self._append_arg('--javap', '$$(find out/.path -name javap)') |
Patrick Rohr | 872a281 | 2022-11-30 19:28:22 -0800 | [diff] [blame] | 815 | self._update_value_arg('--output_dir', self._sanitize_filepath) |
Patrick Rohr | f0abead | 2022-11-30 19:44:10 -0800 | [diff] [blame] | 816 | self._update_value_arg('--includes', self._sanitize_filepath, False) |
Patrick Rohr | 357b25c | 2022-11-30 19:46:26 -0800 | [diff] [blame] | 817 | self._delete_value_arg('--prev_output_dir', False) |
Motomu Utsumi | 4d551d7 | 2022-12-01 16:18:23 +0900 | [diff] [blame] | 818 | self._update_list_arg('--input_file', self._sanitize_filepath) |
| 819 | self._update_list_arg('--input_file', self._add_location_tag_to_filepath) |
Motomu Utsumi | 805591d | 2022-12-02 17:17:16 +0900 | [diff] [blame] | 820 | super()._sanitize_args() |
Patrick Rohr | 0242a3f | 2022-11-30 13:48:59 -0800 | [diff] [blame] | 821 | |
Motomu Utsumi | 9401996 | 2022-12-02 17:18:58 +0900 | [diff] [blame] | 822 | def _sanitize_outputs(self): |
Motomu Utsumi | d4f7264 | 2022-12-02 16:01:59 +0900 | [diff] [blame] | 823 | # fix target.output directory to match #include statements. |
| 824 | self.target.outputs = {re.sub('^jni_headers/', '', out) for out in self.target.outputs} |
Motomu Utsumi | 9401996 | 2022-12-02 17:18:58 +0900 | [diff] [blame] | 825 | super()._sanitize_outputs() |
Motomu Utsumi | d4f7264 | 2022-12-02 16:01:59 +0900 | [diff] [blame] | 826 | |
Motomu Utsumi | a6824ea | 2022-12-05 14:53:11 +0900 | [diff] [blame] | 827 | def get_tool_files(self): |
| 828 | tool_files = super().get_tool_files() |
| 829 | # android_jar.classes should be part of the tools as it list implicit classes |
| 830 | # for the script to generate JNI headers. |
| 831 | tool_files.add("base/android/jni_generator/android_jar.classes") |
| 832 | return tool_files |
| 833 | |
Motomu Utsumi | b80903c | 2022-12-01 16:21:55 +0900 | [diff] [blame] | 834 | class JniRegistrationGeneratorSanitizer(BaseActionSanitizer): |
Motomu Utsumi | 07027f6 | 2022-12-05 12:16:53 +0900 | [diff] [blame] | 835 | def _sanitize_inputs(self): |
| 836 | self.target.inputs = [file for file in self.target.inputs if not file.startswith('//out/')] |
| 837 | |
Motomu Utsumi | 805591d | 2022-12-02 17:17:16 +0900 | [diff] [blame] | 838 | def _sanitize_args(self): |
Motomu Utsumi | 28cbf2f | 2022-12-01 16:24:29 +0900 | [diff] [blame] | 839 | self._update_value_arg('--depfile', self._sanitize_filepath) |
| 840 | self._update_value_arg('--srcjar-path', self._sanitize_filepath) |
| 841 | self._update_value_arg('--header-path', self._sanitize_filepath) |
Motomu Utsumi | 5590747 | 2022-12-01 16:26:21 +0900 | [diff] [blame] | 842 | self._set_value_arg('--sources-files', '$(genDir)/java.sources') |
Motomu Utsumi | 4fe0b95 | 2022-12-01 16:29:15 +0900 | [diff] [blame] | 843 | # update_jni_registration_module removes them from the srcs of the module |
| 844 | # It might be better to remove sources by '--sources-exclusions' |
| 845 | self._delete_value_arg('--sources-exclusions') |
Motomu Utsumi | 805591d | 2022-12-02 17:17:16 +0900 | [diff] [blame] | 846 | super()._sanitize_args() |
Patrick Rohr | 0242a3f | 2022-11-30 13:48:59 -0800 | [diff] [blame] | 847 | |
Mohannad Farrag | 291f567 | 2022-12-02 15:49:00 +0000 | [diff] [blame] | 848 | def get_cmd(self): |
| 849 | # jni_registration_generator.py doesn't work with python2 |
| 850 | cmd = "python3 " + super().get_cmd() |
| 851 | # Path in the original sources file does not work in genrule. |
| 852 | # So creating sources file in cmd based on the srcs of this target. |
| 853 | # Adding ../$(current_dir)/ to the head because jni_registration_generator.py uses the files |
| 854 | # whose path startswith(..) |
| 855 | commands = ["current_dir=`basename \\\`pwd\\\``;", |
| 856 | "for f in $(in);", |
| 857 | "do", |
| 858 | "echo \\\"../$$current_dir/$$f\\\" >> $(genDir)/java.sources;", |
| 859 | "done;", |
| 860 | cmd] |
| 861 | |
| 862 | # .h file jni_registration_generator.py generates has #define with directory name. |
| 863 | # With the genrule env that contains "." which is invalid. So replace that at the end of cmd. |
| 864 | commands.append(";sed -i -e 's/OUT_SOONG_.TEMP_SBOX_.*_OUT/GEN/g' ") |
| 865 | commands.append("$(genDir)/components/cronet/android/cronet_jni_registration.h") |
| 866 | return NEWLINE.join(commands) |
| 867 | |
Mohannad Farrag | 457bc02 | 2022-12-02 14:31:22 +0000 | [diff] [blame] | 868 | class JavaJniRegistrationGeneratorSanitizer(JniRegistrationGeneratorSanitizer): |
Mohannad Farrag | 7f7c9b4 | 2022-12-02 14:37:56 +0000 | [diff] [blame] | 869 | def get_name(self): |
| 870 | return label_to_module_name(self.target.name) + "__java" |
| 871 | |
Mohannad Farrag | 457bc02 | 2022-12-02 14:31:22 +0000 | [diff] [blame] | 872 | def _sanitize_outputs(self): |
| 873 | self.target.outputs = [out for out in self.target.outputs if |
| 874 | out.endswith(".srcjar")] |
| 875 | super()._sanitize_outputs() |
| 876 | |
Motomu Utsumi | 6af5b2a | 2022-12-01 16:33:42 +0900 | [diff] [blame] | 877 | class VersionSanitizer(BaseActionSanitizer): |
Motomu Utsumi | 805591d | 2022-12-02 17:17:16 +0900 | [diff] [blame] | 878 | def _sanitize_args(self): |
Motomu Utsumi | c6b08b8 | 2022-12-01 16:48:19 +0900 | [diff] [blame] | 879 | self._set_value_arg('-o', '$(out)') |
Motomu Utsumi | 21485ba | 2022-12-01 17:01:50 +0900 | [diff] [blame] | 880 | # args for the version.py contain file path without leading --arg key. So apply sanitize |
| 881 | # function for all the args. |
Mohannad Farrag | 8fa9065 | 2022-12-01 15:40:40 +0000 | [diff] [blame] | 882 | self._update_all_args(self._sanitize_filepath_with_location_tag) |
Mohannad Farrag | 2569734 | 2022-12-02 18:01:48 +0000 | [diff] [blame] | 883 | self._set_value_arg('-e', "'%s'" % self._get_value_arg('-e')) |
Motomu Utsumi | 805591d | 2022-12-02 17:17:16 +0900 | [diff] [blame] | 884 | super()._sanitize_args() |
Motomu Utsumi | 6af5b2a | 2022-12-01 16:33:42 +0900 | [diff] [blame] | 885 | |
Motomu Utsumi | df63414 | 2022-12-05 15:02:44 +0900 | [diff] [blame] | 886 | def get_tool_files(self): |
| 887 | tool_files = super().get_tool_files() |
| 888 | # android_chrome_version.py is not specified in anywhere but version.py imports this file |
| 889 | tool_files.add('build/util/android_chrome_version.py') |
| 890 | return tool_files |
| 891 | |
Mohannad Farrag | b73ce0f | 2022-12-01 15:43:58 +0000 | [diff] [blame] | 892 | class JavaCppEnumSanitizer(BaseActionSanitizer): |
Motomu Utsumi | 805591d | 2022-12-02 17:17:16 +0900 | [diff] [blame] | 893 | def _sanitize_args(self): |
Mohannad Farrag | b73ce0f | 2022-12-01 15:43:58 +0000 | [diff] [blame] | 894 | self._update_all_args(self._sanitize_filepath_with_location_tag) |
| 895 | self._set_value_arg('--srcjar', '$(out)') |
Motomu Utsumi | 805591d | 2022-12-02 17:17:16 +0900 | [diff] [blame] | 896 | super()._sanitize_args() |
Mohannad Farrag | b73ce0f | 2022-12-01 15:43:58 +0000 | [diff] [blame] | 897 | |
Motomu Utsumi | 9701d2f | 2022-12-02 16:53:06 +0900 | [diff] [blame] | 898 | class MakeDafsaSanitizer(BaseActionSanitizer): |
| 899 | def is_header_generated(self): |
Motomu Utsumi | 1e028b8 | 2022-12-02 16:54:20 +0900 | [diff] [blame] | 900 | # This script generates .cc files but they are #included by other sources |
| 901 | # (e.g. registry_controlled_domain.cc) |
| 902 | return True |
Motomu Utsumi | 9701d2f | 2022-12-02 16:53:06 +0900 | [diff] [blame] | 903 | |
Motomu Utsumi | 56a2f44 | 2022-12-05 16:01:34 +0900 | [diff] [blame] | 904 | class JavaCppFeatureSanitizer(BaseActionSanitizer): |
Motomu Utsumi | d7c3677 | 2022-12-05 16:04:37 +0900 | [diff] [blame^] | 905 | def _sanitize_args(self): |
| 906 | self._update_all_args(self._sanitize_filepath_with_location_tag) |
| 907 | self._set_value_arg('--srcjar', '$(out)') |
| 908 | super()._sanitize_args() |
Motomu Utsumi | 56a2f44 | 2022-12-05 16:01:34 +0900 | [diff] [blame] | 909 | |
Mohannad Farrag | 457bc02 | 2022-12-02 14:31:22 +0000 | [diff] [blame] | 910 | def get_action_sanitizer(target, type): |
Patrick Rohr | 7f11715 | 2022-11-30 13:58:05 -0800 | [diff] [blame] | 911 | if target.script == "//build/write_buildflag_header.py": |
| 912 | return WriteBuildFlagHeaderSanitizer(target) |
| 913 | elif target.script == "//build/write_build_date_header.py": |
| 914 | return WriteBuildDateHeaderSanitizer(target) |
| 915 | elif target.script == '//base/android/jni_generator/jni_generator.py': |
| 916 | return JniGeneratorSanitizer(target) |
Motomu Utsumi | b80903c | 2022-12-01 16:21:55 +0900 | [diff] [blame] | 917 | elif target.script == '//base/android/jni_generator/jni_registration_generator.py': |
Mohannad Farrag | 457bc02 | 2022-12-02 14:31:22 +0000 | [diff] [blame] | 918 | if type == 'java_genrule': |
| 919 | return JavaJniRegistrationGeneratorSanitizer(target) |
| 920 | else: |
| 921 | return JniRegistrationGeneratorSanitizer(target) |
Motomu Utsumi | 6af5b2a | 2022-12-01 16:33:42 +0900 | [diff] [blame] | 922 | elif target.script == "//build/util/version.py": |
| 923 | return VersionSanitizer(target) |
Mohannad Farrag | b73ce0f | 2022-12-01 15:43:58 +0000 | [diff] [blame] | 924 | elif target.script == "//build/android/gyp/java_cpp_enum.py": |
| 925 | return JavaCppEnumSanitizer(target) |
Motomu Utsumi | 9701d2f | 2022-12-02 16:53:06 +0900 | [diff] [blame] | 926 | elif target.script == "//net/tools/dafsa/make_dafsa.py": |
| 927 | return MakeDafsaSanitizer(target) |
Motomu Utsumi | 56a2f44 | 2022-12-05 16:01:34 +0900 | [diff] [blame] | 928 | elif target.script == '//build/android/gyp/java_cpp_features.py': |
| 929 | return JavaCppFeatureSanitizer(target) |
Patrick Rohr | 7f11715 | 2022-11-30 13:58:05 -0800 | [diff] [blame] | 930 | else: |
| 931 | # TODO: throw exception here once all script hacks have been converted. |
| 932 | return BaseActionSanitizer(target) |
| 933 | |
Mohannad Farrag | bab6c89 | 2022-11-02 14:09:46 +0000 | [diff] [blame] | 934 | def create_action_foreach_modules(blueprint, target): |
| 935 | """ The following assumes that rebase_path exists in the args. |
| 936 | The args of an action_foreach contains hints about which output files are generated |
| 937 | by which source files. |
| 938 | This is copied directly from the args |
| 939 | "gen/net/base/registry_controlled_domains/{{source_name_part}}-reversed-inc.cc" |
| 940 | So each source file will generate an output whose name is the {source_name-reversed-inc.cc} |
| 941 | """ |
| 942 | new_args = [] |
Motomu Utsumi | 56afcac | 2022-11-04 12:58:30 +0900 | [diff] [blame] | 943 | for i, src in enumerate(sorted(target.sources)): |
Mohannad Farrag | bab6c89 | 2022-11-02 14:09:46 +0000 | [diff] [blame] | 944 | # don't add script arg for the first source -- create_action_module |
| 945 | # already does this. |
| 946 | if i != 0: |
| 947 | new_args.append('&& python3 $(location %s)' % |
| 948 | gn_utils.label_to_path(target.script)) |
| 949 | for arg in target.args: |
| 950 | if '{{source}}' in arg: |
| 951 | new_args.append('$(location %s)' % (gn_utils.label_to_path(src))) |
| 952 | elif '{{source_name_part}}' in arg: |
| 953 | source_name_part = src.split("/")[-1] # Get the file name only |
| 954 | source_name_part = source_name_part.split(".")[0] # Remove the extension (Ex: .cc) |
| 955 | file_name = arg.replace('{{source_name_part}}', source_name_part).split("/")[-1] |
| 956 | # file_name represent the output file name. But we need the whole path |
| 957 | # This can be found from target.outputs. |
| 958 | for out in target.outputs: |
| 959 | if out.endswith(file_name): |
| 960 | new_args.append('$(location %s)' % out) |
| 961 | else: |
| 962 | new_args.append(arg) |
| 963 | |
| 964 | target.args = new_args |
Mohannad Farrag | 7ff9991 | 2022-11-29 17:16:00 +0000 | [diff] [blame] | 965 | return create_action_module(blueprint, target, 'cc_genrule') |
Motomu Utsumi | a6c3315 | 2022-11-02 18:21:55 +0900 | [diff] [blame] | 966 | |
Mohannad Farrag | 7ff9991 | 2022-11-29 17:16:00 +0000 | [diff] [blame] | 967 | def create_action_module(blueprint, target, type): |
Mohannad Farrag | 457bc02 | 2022-12-02 14:31:22 +0000 | [diff] [blame] | 968 | sanitizer = get_action_sanitizer(target, type) |
Motomu Utsumi | cdb45ea | 2022-12-02 17:05:07 +0900 | [diff] [blame] | 969 | sanitizer.sanitize() |
Motomu Utsumi | 47fd40a | 2022-12-05 15:07:31 +0900 | [diff] [blame] | 970 | |
Mohannad Farrag | 7f7c9b4 | 2022-12-02 14:37:56 +0000 | [diff] [blame] | 971 | module = Module(type, sanitizer.get_name(), target.name) |
Mohannad Farrag | c739dda | 2022-12-02 15:43:46 +0000 | [diff] [blame] | 972 | module.cmd = sanitizer.get_cmd() |
Motomu Utsumi | 2421323 | 2022-12-02 16:04:05 +0900 | [diff] [blame] | 973 | module.out = sanitizer.get_outputs() |
Motomu Utsumi | 7db7583 | 2022-12-02 16:46:22 +0900 | [diff] [blame] | 974 | if sanitizer.is_header_generated(): |
| 975 | module.genrule_headers.add(module.name) |
Motomu Utsumi | 80fa0b0 | 2022-12-05 12:50:57 +0900 | [diff] [blame] | 976 | module.srcs = sanitizer.get_srcs() |
Motomu Utsumi | aaf42cf | 2022-12-05 12:55:02 +0900 | [diff] [blame] | 977 | module.tool_files = sanitizer.get_tool_files() |
Patrick Rohr | 9b99a98 | 2022-10-28 11:00:57 -0700 | [diff] [blame] | 978 | |
Patrick Rohr | e1a853e | 2022-10-26 12:31:39 -0700 | [diff] [blame] | 979 | blueprint.add_module(module) |
| 980 | return module |
| 981 | |
| 982 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 983 | |
Motomu Utsumi | c34b137 | 2022-11-17 22:15:51 +0900 | [diff] [blame] | 984 | def _get_cflags(cflags, defines): |
| 985 | cflags = {flag for flag in cflags if flag in cflag_allowlist} |
Motomu Utsumi | fa7e926 | 2022-10-26 19:43:02 +0900 | [diff] [blame] | 986 | # Consider proper allowlist or denylist if needed |
Motomu Utsumi | c34b137 | 2022-11-17 22:15:51 +0900 | [diff] [blame] | 987 | cflags |= set("-D%s" % define.replace("\"", "\\\"") for define in defines) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 988 | return cflags |
| 989 | |
Motomu Utsumi | c34b137 | 2022-11-17 22:15:51 +0900 | [diff] [blame] | 990 | def set_module_flags(module, cflags, defines): |
| 991 | module.cflags.update(_get_cflags(cflags, defines)) |
| 992 | # TODO: implement proper cflag parsing. |
| 993 | for flag in cflags: |
| 994 | if '-std=' in flag: |
| 995 | module.cpp_std = flag[len('-std='):] |
Motomu Utsumi | c34b137 | 2022-11-17 22:15:51 +0900 | [diff] [blame] | 996 | if '-fexceptions' in flag: |
| 997 | module.cppflags.add('-fexceptions') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 998 | |
Mohannad Farrag | 631443e | 2022-11-21 16:17:01 +0000 | [diff] [blame] | 999 | def add_genrule_per_arch(module, dep_module, type): |
| 1000 | module.generated_headers.update(dep_module.genrule_headers) |
| 1001 | # If the module is a static library, export all the generated headers. |
| 1002 | if type == 'cc_library_static': |
| 1003 | module.export_generated_headers.update(dep_module.genrule_headers) |
| 1004 | module.srcs.update(dep_module.genrule_srcs) |
| 1005 | module.shared_libs.update(dep_module.genrule_shared_libs) |
| 1006 | module.header_libs.update(dep_module.genrule_header_libs) |
| 1007 | |
Motomu Utsumi | 88efbb4 | 2022-11-17 22:18:15 +0900 | [diff] [blame] | 1008 | def set_module_include_dirs(module, cflags, include_dirs): |
Motomu Utsumi | 88efbb4 | 2022-11-17 22:18:15 +0900 | [diff] [blame] | 1009 | for flag in cflags: |
| 1010 | if '-isystem' in flag: |
Patrick Rohr | 3cd5ffb | 2022-11-18 17:40:55 -0800 | [diff] [blame] | 1011 | module.local_include_dirs.add(flag[len('-isystem../../'):]) |
Motomu Utsumi | 88efbb4 | 2022-11-17 22:18:15 +0900 | [diff] [blame] | 1012 | |
| 1013 | # Adding local_include_dirs is necessary due to source_sets / filegroups |
| 1014 | # which do not properly propagate include directories. |
| 1015 | # Filter any directory inside //out as a) this directory does not exist for |
| 1016 | # aosp / soong builds and b) the include directory should already be |
| 1017 | # configured via library dependency. |
Patrick Rohr | 3cd5ffb | 2022-11-18 17:40:55 -0800 | [diff] [blame] | 1018 | module.local_include_dirs.update([gn_utils.label_to_path(d) |
Motomu Utsumi | 88efbb4 | 2022-11-17 22:18:15 +0900 | [diff] [blame] | 1019 | for d in include_dirs |
| 1020 | if not re.match('^//out/.*', d)]) |
Motomu Utsumi | 88efbb4 | 2022-11-17 22:18:15 +0900 | [diff] [blame] | 1021 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1022 | def create_modules_from_target(blueprint, gn, gn_target_name): |
| 1023 | """Generate module(s) for a given GN target. |
| 1024 | |
| 1025 | Given a GN target name, generate one or more corresponding modules into a |
| 1026 | blueprint. The only case when this generates >1 module is proto libraries. |
| 1027 | |
| 1028 | Args: |
| 1029 | blueprint: Blueprint instance which is being generated. |
| 1030 | gn: gn_utils.GnParser object. |
| 1031 | gn_target_name: GN target for module generation. |
| 1032 | """ |
| 1033 | bp_module_name = label_to_module_name(gn_target_name) |
| 1034 | if bp_module_name in blueprint.modules: |
| 1035 | return blueprint.modules[bp_module_name] |
| 1036 | target = gn.get_target(gn_target_name) |
Patrick Rohr | 1622894 | 2022-10-26 14:00:26 -0700 | [diff] [blame] | 1037 | log.info('create modules for %s (%s)', target.name, target.type) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1038 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1039 | if target.type == 'executable': |
Patrick Rohr | c8f41cd | 2022-11-15 22:46:10 -0800 | [diff] [blame] | 1040 | if target.testonly: |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1041 | module_type = 'cc_test' |
| 1042 | else: |
Patrick Rohr | c8f41cd | 2022-11-15 22:46:10 -0800 | [diff] [blame] | 1043 | # Can be used for both host and device targets. |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1044 | module_type = 'cc_binary' |
| 1045 | module = Module(module_type, bp_module_name, gn_target_name) |
| 1046 | elif target.type == 'static_library': |
| 1047 | module = Module('cc_library_static', bp_module_name, gn_target_name) |
| 1048 | elif target.type == 'shared_library': |
| 1049 | module = Module('cc_library_shared', bp_module_name, gn_target_name) |
| 1050 | elif target.type == 'source_set': |
Mohannad Farrag | 7f29d83 | 2022-11-23 19:52:41 +0000 | [diff] [blame] | 1051 | module = Module('cc_object', bp_module_name, gn_target_name) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1052 | elif target.type == 'group': |
| 1053 | # "group" targets are resolved recursively by gn_utils.get_target(). |
| 1054 | # There's nothing we need to do at this level for them. |
| 1055 | return None |
| 1056 | elif target.type == 'proto_library': |
| 1057 | module = create_proto_modules(blueprint, gn, target) |
| 1058 | if module is None: |
| 1059 | return None |
| 1060 | elif target.type == 'action': |
Mohannad Farrag | 4b89a82 | 2022-12-02 14:25:44 +0000 | [diff] [blame] | 1061 | module = create_action_module(blueprint, target, 'cc_genrule') |
Mohannad Farrag | f076f3e | 2022-10-31 17:45:28 +0000 | [diff] [blame] | 1062 | elif target.type == 'action_foreach': |
Mohannad Farrag | bab6c89 | 2022-11-02 14:09:46 +0000 | [diff] [blame] | 1063 | module = create_action_foreach_modules(blueprint, target) |
Patrick Rohr | 59a7665 | 2022-10-26 12:36:56 -0700 | [diff] [blame] | 1064 | elif target.type == 'copy': |
| 1065 | # TODO: careful now! copy targets are not supported yet, but this will stop |
| 1066 | # traversing the dependency tree. For //base:base, this is not a big |
| 1067 | # problem as libicu contains the only copy target which happens to be a |
| 1068 | # leaf node. |
| 1069 | return None |
Patrick Rohr | ad44060 | 2022-11-10 22:09:04 -0800 | [diff] [blame] | 1070 | elif target.type == 'java_group': |
| 1071 | # Java targets are handled outside of create_modules_from_target. |
| 1072 | return None |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1073 | else: |
| 1074 | raise Error('Unknown target %s (%s)' % (target.name, target.type)) |
| 1075 | |
| 1076 | blueprint.add_module(module) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1077 | module.init_rc = target_initrc.get(target.name, []) |
| 1078 | module.srcs.update( |
| 1079 | gn_utils.label_to_path(src) |
| 1080 | for src in target.sources |
Motomu Utsumi | f951e50 | 2022-11-07 19:31:15 +0900 | [diff] [blame] | 1081 | if is_supported_source_file(src) and not src.startswith("//out/test")) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1082 | |
Patrick Rohr | 3b5ff76 | 2022-11-16 10:22:16 -0800 | [diff] [blame] | 1083 | # Add arch-specific properties |
| 1084 | for arch_name, arch in target.arch.items(): |
Motomu Utsumi | 40f95c5 | 2022-11-17 19:39:13 +0900 | [diff] [blame] | 1085 | module.target[arch_name].srcs.update( |
| 1086 | gn_utils.label_to_path(src) |
| 1087 | for src in arch.sources |
| 1088 | if is_supported_source_file(src) and not src.startswith("//out/test")) |
Patrick Rohr | 3b5ff76 | 2022-11-16 10:22:16 -0800 | [diff] [blame] | 1089 | |
Mohannad Farrag | baf0d57 | 2022-11-22 11:53:54 +0000 | [diff] [blame] | 1090 | module.rtti = target.rtti |
| 1091 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1092 | if target.type in gn_utils.LINKER_UNIT_TYPES: |
Motomu Utsumi | c34b137 | 2022-11-17 22:15:51 +0900 | [diff] [blame] | 1093 | set_module_flags(module, target.cflags, target.defines) |
Motomu Utsumi | 88efbb4 | 2022-11-17 22:18:15 +0900 | [diff] [blame] | 1094 | set_module_include_dirs(module, target.cflags, target.include_dirs) |
Motomu Utsumi | f0f4768 | 2022-11-17 22:34:39 +0900 | [diff] [blame] | 1095 | # TODO: set_module_xxx is confusing, apply similar function to module and target in better way. |
| 1096 | for arch_name, arch in target.arch.items(): |
| 1097 | set_module_flags(module.target[arch_name], arch.cflags, arch.defines) |
Motomu Utsumi | 3371d68 | 2022-11-28 16:56:52 +0900 | [diff] [blame] | 1098 | # -Xclang -target-feature -Xclang +mte are used to enable MTE (Memory Tagging Extensions). |
| 1099 | # Flags which does not start with '-' could not be in the cflags so enabling MTE by |
| 1100 | # -march and -mcpu Feature Modifiers. MTE is only available on arm64. This is needed for |
| 1101 | # building //base/allocator/partition_allocator:partition_alloc for arm64. |
| 1102 | if '+mte' in arch.cflags and arch_name == 'android_arm64': |
| 1103 | module.target[arch_name].cflags.add('-march=armv8-a+memtag') |
Motomu Utsumi | f0f4768 | 2022-11-17 22:34:39 +0900 | [diff] [blame] | 1104 | set_module_include_dirs(module.target[arch_name], arch.cflags, arch.include_dirs) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1105 | |
Mohannad Farrag | f2391cc | 2022-11-29 13:26:32 +0000 | [diff] [blame] | 1106 | module.host_supported = target.host_supported() |
| 1107 | module.device_supported = target.device_supported() |
Mohannad Farrag | 1de6cb1 | 2022-11-28 12:27:26 +0000 | [diff] [blame] | 1108 | |
Motomu Utsumi | 8ca1241 | 2022-11-30 16:27:30 +0900 | [diff] [blame] | 1109 | if module.is_genrule(): |
| 1110 | module.apex_available.add(tethering_apex) |
| 1111 | |
Mohannad Farrag | f2391cc | 2022-11-29 13:26:32 +0000 | [diff] [blame] | 1112 | if module.is_compiled(): |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1113 | # Don't try to inject library/source dependencies into genrules or |
| 1114 | # filegroups because they are not compiled in the traditional sense. |
| 1115 | module.defaults = [defaults_module] |
| 1116 | for lib in target.libs: |
| 1117 | # Generally library names should be mangled as 'libXXX', unless they |
| 1118 | # are HAL libraries (e.g., android.hardware.health@2.0) or AIDL c++ / NDK |
| 1119 | # libraries (e.g. "android.hardware.power.stats-V1-cpp") |
| 1120 | android_lib = lib if '@' in lib or "-cpp" in lib or "-ndk" in lib \ |
| 1121 | else 'lib' + lib |
| 1122 | if lib in shared_library_allowlist: |
| 1123 | module.add_android_shared_lib(android_lib) |
| 1124 | if lib in static_library_allowlist: |
| 1125 | module.add_android_static_lib(android_lib) |
| 1126 | |
Patrick Rohr | d9dd3b9 | 2022-11-09 16:15:30 -0800 | [diff] [blame] | 1127 | # Remove prohibited include directories |
| 1128 | module.local_include_dirs = [d for d in module.local_include_dirs |
| 1129 | if d not in local_include_dirs_denylist] |
| 1130 | |
Mohannad Farrag | 1de6cb1 | 2022-11-28 12:27:26 +0000 | [diff] [blame] | 1131 | # If the module is a static library, export all the generated headers. |
| 1132 | if module.type == 'cc_library_static': |
| 1133 | module.export_generated_headers = module.generated_headers |
| 1134 | |
Motomu Utsumi | ee47af6 | 2022-11-30 16:41:15 +0900 | [diff] [blame] | 1135 | if module.name == 'cronet_aml_components_cronet_android_cronet': |
| 1136 | if target.output_name is None: |
| 1137 | raise Error('Failed to get output_name for libcronet name') |
| 1138 | # .so file name needs to match with CronetLibraryLoader.java (e.g. libcronet.109.0.5386.0.so) |
| 1139 | # So setting the output name based on the output_name from the desc.json |
| 1140 | module.stem = 'lib' + target.output_name |
| 1141 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1142 | # dep_name is an unmangled GN target name (e.g. //foo:bar(toolchain)). |
Motomu Utsumi | f1daa23 | 2022-11-08 13:28:37 +0900 | [diff] [blame] | 1143 | # Currently, only one module is generated from target even target has multiple toolchains. |
| 1144 | # And module is generated based on the first visited target. |
| 1145 | # Sort deps before iteration to make result deterministic. |
| 1146 | all_deps = sorted(target.deps | target.source_set_deps | target.transitive_proto_deps) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1147 | for dep_name in all_deps: |
Patrick Rohr | 5cc46e0 | 2022-10-26 14:32:45 -0700 | [diff] [blame] | 1148 | # |builtin_deps| override GN deps with Android-specific ones. See the |
| 1149 | # config in the top of this file. |
Patrick Rohr | 0787666 | 2022-11-15 22:55:23 -0800 | [diff] [blame] | 1150 | if dep_name in builtin_deps: |
| 1151 | builtin_deps[dep_name](module) |
Patrick Rohr | 5cc46e0 | 2022-10-26 14:32:45 -0700 | [diff] [blame] | 1152 | continue |
| 1153 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1154 | dep_module = create_modules_from_target(blueprint, gn, dep_name) |
| 1155 | |
Mohannad Farrag | 7f29d83 | 2022-11-23 19:52:41 +0000 | [diff] [blame] | 1156 | if dep_module is None: |
| 1157 | continue |
Motomu Utsumi | e246feb | 2022-11-01 17:25:56 +0900 | [diff] [blame] | 1158 | # TODO: Proper dependency check for genrule. |
| 1159 | # Currently, only propagating genrule dependencies. |
| 1160 | # Also, currently, all the dependencies are propagated upwards. |
| 1161 | # in gn, public_deps should be propagated but deps should not. |
| 1162 | # Not sure this information is available in the desc.json. |
| 1163 | # Following rule works for adding android_runtime_jni_headers to base:base. |
| 1164 | # If this doesn't work for other target, hardcoding for specific target |
| 1165 | # might be better. |
Mohannad Farrag | 1de6cb1 | 2022-11-28 12:27:26 +0000 | [diff] [blame] | 1166 | if module.is_genrule() and dep_module.is_genrule(): |
| 1167 | module.genrule_headers.add(dep_module.name) |
| 1168 | module.genrule_headers.update(dep_module.genrule_headers) |
Motomu Utsumi | e246feb | 2022-11-01 17:25:56 +0900 | [diff] [blame] | 1169 | |
Mohannad Farrag | 7f29d83 | 2022-11-23 19:52:41 +0000 | [diff] [blame] | 1170 | # For filegroups, and genrule, recurse but don't apply the |
Patrick Rohr | a6ce023 | 2022-11-16 22:09:01 -0800 | [diff] [blame] | 1171 | # deps. |
Mohannad Farrag | 1de6cb1 | 2022-11-28 12:27:26 +0000 | [diff] [blame] | 1172 | if not module.is_compiled() or module.is_genrule(): |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1173 | continue |
Mohannad Farrag | 1de6cb1 | 2022-11-28 12:27:26 +0000 | [diff] [blame] | 1174 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1175 | if dep_module.type == 'cc_library_shared': |
| 1176 | module.shared_libs.add(dep_module.name) |
| 1177 | elif dep_module.type == 'cc_library_static': |
| 1178 | module.static_libs.add(dep_module.name) |
Mohannad Farrag | 7f29d83 | 2022-11-23 19:52:41 +0000 | [diff] [blame] | 1179 | elif dep_module.type == 'cc_object': |
Mohannad Farrag | f2391cc | 2022-11-29 13:26:32 +0000 | [diff] [blame] | 1180 | module.merge_attribute('generated_headers', dep_module, target.arch.keys()) |
Mohannad Farrag | 7f29d83 | 2022-11-23 19:52:41 +0000 | [diff] [blame] | 1181 | if module.type != 'cc_object': |
| 1182 | if dep_module.has_input_files(): |
| 1183 | # Only add it as part of srcs if the dep_module has input files otherwise |
| 1184 | # this would throw an error. |
| 1185 | module.srcs.add(":" + dep_module.name) |
Mohannad Farrag | f2391cc | 2022-11-29 13:26:32 +0000 | [diff] [blame] | 1186 | module.merge_attribute('export_generated_headers', dep_module, |
Mohannad Farrag | 7f29d83 | 2022-11-23 19:52:41 +0000 | [diff] [blame] | 1187 | target.arch.keys(), 'generated_headers') |
Mohannad Farrag | 1de6cb1 | 2022-11-28 12:27:26 +0000 | [diff] [blame] | 1188 | elif dep_module.type == 'cc_genrule': |
Mohannad Farrag | f2391cc | 2022-11-29 13:26:32 +0000 | [diff] [blame] | 1189 | module.merge_attribute('generated_headers', dep_module, [], 'genrule_headers') |
| 1190 | module.merge_attribute('srcs', dep_module, [], 'genrule_srcs') |
| 1191 | module.merge_attribute('shared_libs', dep_module, [], 'genrule_shared_libs') |
| 1192 | module.merge_attribute('header_libs', dep_module, [], 'genrule_header_libs') |
Mohannad Farrag | 1de6cb1 | 2022-11-28 12:27:26 +0000 | [diff] [blame] | 1193 | if module.type not in ["cc_object"]: |
Mohannad Farrag | f2391cc | 2022-11-29 13:26:32 +0000 | [diff] [blame] | 1194 | module.merge_attribute('export_generated_headers', dep_module, [], |
Mohannad Farrag | 1de6cb1 | 2022-11-28 12:27:26 +0000 | [diff] [blame] | 1195 | 'genrule_headers') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1196 | elif dep_module.type == 'cc_binary': |
| 1197 | continue # Ignore executables deps (used by cmdline integration tests). |
| 1198 | else: |
| 1199 | raise Error('Unknown dep %s (%s) for target %s' % |
| 1200 | (dep_module.name, dep_module.type, module.name)) |
| 1201 | |
Patrick Rohr | b51878f | 2022-11-16 23:49:03 -0800 | [diff] [blame] | 1202 | for arch_name, arch in target.arch.items(): |
| 1203 | for dep_name in arch.deps: |
| 1204 | dep_module = create_modules_from_target(blueprint, gn, dep_name) |
| 1205 | # Arch-specific dependencies currently only include cc_library_static. |
| 1206 | # Revisit this approach once we need to support more target types. |
| 1207 | if dep_module.type == 'cc_library_static': |
| 1208 | module.target[arch_name].static_libs.add(dep_module.name) |
Mohannad Farrag | 1de6cb1 | 2022-11-28 12:27:26 +0000 | [diff] [blame] | 1209 | elif dep_module.type == 'cc_genrule': |
| 1210 | if dep_module.name.endswith(arch_name): |
| 1211 | module.target[arch_name].generated_headers.update(dep_module.genrule_headers) |
| 1212 | module.target[arch_name].srcs.update(dep_module.genrule_srcs) |
| 1213 | module.target[arch_name].shared_libs.update(dep_module.genrule_shared_libs) |
| 1214 | module.target[arch_name].header_libs.update(dep_module.genrule_header_libs) |
| 1215 | if module.type not in ["cc_object"]: |
| 1216 | module.target[arch_name].export_generated_headers.update( |
| 1217 | dep_module.genrule_headers) |
Patrick Rohr | b51878f | 2022-11-16 23:49:03 -0800 | [diff] [blame] | 1218 | else: |
| 1219 | raise Error('Unsupported arch-specific dependency %s of target %s with type %s' % |
| 1220 | (dep_module.name, target.name, dep_module.type)) |
Mohannad Farrag | 7f29d83 | 2022-11-23 19:52:41 +0000 | [diff] [blame] | 1221 | for dep_name in arch.source_set_deps: |
| 1222 | dep_module = create_modules_from_target(blueprint, gn, dep_name) |
| 1223 | if dep_module.type == 'cc_object': |
| 1224 | if module.type != 'cc_object': |
| 1225 | # We only want to bubble up cc_objects for modules that are not cc_objects |
| 1226 | # otherwise they'd be recompiled and that would cause multiple symbol redefinitions. |
| 1227 | if dep_module.has_input_files(): |
| 1228 | # Only add it as part of srcs if the dep_module has input files otherwise |
| 1229 | # this would throw an error. |
| 1230 | module.target[arch_name].srcs.add(":" + dep_module.name) |
| 1231 | else: |
| 1232 | raise Error('Unsupported arch-specific dependency %s of target %s with type %s' % |
| 1233 | (dep_module.name, target.name, dep_module.type)) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1234 | return module |
| 1235 | |
Patrick Rohr | b18aca2 | 2022-11-04 15:07:32 -0700 | [diff] [blame] | 1236 | def create_java_module(blueprint, gn): |
| 1237 | bp_module_name = module_prefix + 'java' |
| 1238 | module = Module('java_library', bp_module_name, '//gn:java') |
Mohannad Farrag | 21562d6 | 2022-11-07 13:09:31 +0000 | [diff] [blame] | 1239 | module.srcs.update([gn_utils.label_to_path(source) for source in gn.java_sources]) |
Mohannad Farrag | 6a2d88a | 2022-11-28 19:33:48 +0000 | [diff] [blame] | 1240 | for dep in gn.java_actions: |
Mohannad Farrag | 4b89a82 | 2022-12-02 14:25:44 +0000 | [diff] [blame] | 1241 | dep_module = create_action_module(blueprint, gn.get_target(dep), 'java_genrule') |
Patrick Rohr | b18aca2 | 2022-11-04 15:07:32 -0700 | [diff] [blame] | 1242 | blueprint.add_module(module) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1243 | |
Patrick Rohr | 6ef2272 | 2022-11-18 18:24:01 -0800 | [diff] [blame] | 1244 | def update_jni_registration_module(module, gn): |
Motomu Utsumi | 47d122f | 2022-11-10 17:32:23 +0900 | [diff] [blame] | 1245 | # TODO: deny list is in the arg of jni_registration_generator.py. Should not be hardcoded |
| 1246 | deny_list = [ |
| 1247 | '//base/android/java/src/org/chromium/base/library_loader/LibraryLoader.java', |
| 1248 | '//base/android/java/src/org/chromium/base/library_loader/LibraryPrefetcher.java', |
| 1249 | '//base/android/java/src/org/chromium/base/process_launcher/ChildProcessService.java', |
| 1250 | '//base/android/java/src/org/chromium/base/SysUtils.java'] |
| 1251 | |
Motomu Utsumi | e3ce770 | 2022-11-10 16:22:11 +0900 | [diff] [blame] | 1252 | # TODO: java_sources might not contain all the required java files |
Motomu Utsumi | 47d122f | 2022-11-10 17:32:23 +0900 | [diff] [blame] | 1253 | module.srcs.update([gn_utils.label_to_path(source) |
| 1254 | for source in gn.java_sources if source not in deny_list]) |
Motomu Utsumi | e3ce770 | 2022-11-10 16:22:11 +0900 | [diff] [blame] | 1255 | |
Motomu Utsumi | a71281c | 2022-11-18 15:19:00 +0900 | [diff] [blame] | 1256 | def create_blueprint_for_targets(gn, targets): |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1257 | """Generate a blueprint for a list of GN targets.""" |
| 1258 | blueprint = Blueprint() |
| 1259 | |
| 1260 | # Default settings used by all modules. |
| 1261 | defaults = Module('cc_defaults', defaults_module, '//gn:default_deps') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1262 | defaults.cflags = [ |
Patrick Rohr | 3ce7477 | 2022-11-11 14:19:58 -0800 | [diff] [blame] | 1263 | '-DGOOGLE_PROTOBUF_NO_RTTI', |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1264 | '-Wno-error=return-type', |
Patrick Rohr | 3a1ec1d | 2022-10-31 13:30:17 -0700 | [diff] [blame] | 1265 | '-Wno-non-virtual-dtor', |
Patrick Rohr | 5c70002 | 2022-11-08 19:33:07 -0800 | [diff] [blame] | 1266 | '-Wno-macro-redefined', |
Patrick Rohr | 9806515 | 2022-10-31 14:49:58 -0700 | [diff] [blame] | 1267 | '-Wno-missing-field-initializers', |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1268 | '-Wno-sign-compare', |
| 1269 | '-Wno-sign-promo', |
| 1270 | '-Wno-unused-parameter', |
Mohannad Farrag | 54d5244 | 2022-11-21 16:27:02 +0000 | [diff] [blame] | 1271 | '-Wno-null-pointer-subtraction', # Needed to libevent |
Mohannad Farrag | d98a96d | 2022-11-10 14:56:19 +0000 | [diff] [blame] | 1272 | '-Wno-deprecated-non-prototype', # needed for zlib |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1273 | '-fvisibility=hidden', |
Motomu Utsumi | ba02094 | 2022-11-14 15:15:41 +0900 | [diff] [blame] | 1274 | '-Wno-ambiguous-reversed-operator', # needed for icui18n |
Motomu Utsumi | b1ec878 | 2022-11-14 15:25:57 +0900 | [diff] [blame] | 1275 | '-Wno-unreachable-code-loop-increment', # needed for icui18n |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1276 | '-O2', |
Mohannad Farrag | 7f29d83 | 2022-11-23 19:52:41 +0000 | [diff] [blame] | 1277 | '-fPIC', |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1278 | ] |
Patrick Rohr | c03f1bb | 2022-11-18 16:13:17 -0800 | [diff] [blame] | 1279 | # Chromium builds do not add a dependency for headers found inside the |
| 1280 | # sysroot, so they are added globally via defaults. |
| 1281 | defaults.target['android'].header_libs = [ |
| 1282 | 'media_ndk_headers', |
| 1283 | 'jni_headers', |
| 1284 | ] |
Patrick Rohr | 5446df8 | 2022-11-18 14:54:55 -0800 | [diff] [blame] | 1285 | defaults.target['host'].cflags = [ |
| 1286 | # -DANDROID is added by default but target.defines contain -DANDROID if |
| 1287 | # it's required. So adding -UANDROID to cancel default -DANDROID if it's |
| 1288 | # not specified. |
| 1289 | # Note: -DANDROID is not consistently applied across the chromium code |
| 1290 | # base, so it is removed unconditionally for host targets. |
| 1291 | '-UANDROID', |
| 1292 | ] |
Patrick Rohr | 61f2acb | 2022-10-31 14:08:18 -0700 | [diff] [blame] | 1293 | defaults.stl = 'none' |
Motomu Utsumi | 8ca1241 | 2022-11-30 16:27:30 +0900 | [diff] [blame] | 1294 | defaults.min_sdk_version = 29 |
| 1295 | defaults.apex_available.add(tethering_apex) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1296 | blueprint.add_module(defaults) |
Patrick Rohr | 344b247 | 2022-10-25 11:32:15 -0700 | [diff] [blame] | 1297 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1298 | for target in targets: |
| 1299 | create_modules_from_target(blueprint, gn, target) |
Patrick Rohr | b18aca2 | 2022-11-04 15:07:32 -0700 | [diff] [blame] | 1300 | |
| 1301 | create_java_module(blueprint, gn) |
Patrick Rohr | 6ef2272 | 2022-11-18 18:24:01 -0800 | [diff] [blame] | 1302 | for module in blueprint.modules.values(): |
| 1303 | if 'cronet_jni_registration' in module.name: |
| 1304 | update_jni_registration_module(module, gn) |
Patrick Rohr | a7d029d | 2022-11-08 12:23:11 -0800 | [diff] [blame] | 1305 | |
| 1306 | # Merge in additional hardcoded arguments. |
| 1307 | for module in blueprint.modules.values(): |
| 1308 | for key, add_val in additional_args.get(module.name, []): |
| 1309 | curr = getattr(module, key) |
| 1310 | if add_val and isinstance(add_val, set) and isinstance(curr, set): |
| 1311 | curr.update(add_val) |
| 1312 | elif isinstance(add_val, str) and (not curr or isinstance(curr, str)): |
| 1313 | setattr(module, key, add_val) |
| 1314 | elif isinstance(add_val, bool) and (not curr or isinstance(curr, bool)): |
| 1315 | setattr(module, key, add_val) |
| 1316 | elif isinstance(add_val, dict) and isinstance(curr, dict): |
| 1317 | curr.update(add_val) |
| 1318 | elif isinstance(add_val, dict) and isinstance(curr, Target): |
| 1319 | curr.__dict__.update(add_val) |
| 1320 | else: |
| 1321 | raise Error('Unimplemented type %r of additional_args: %r' % |
| 1322 | (type(add_val), key)) |
| 1323 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1324 | return blueprint |
| 1325 | |
| 1326 | |
| 1327 | def main(): |
| 1328 | parser = argparse.ArgumentParser( |
| 1329 | description='Generate Android.bp from a GN description.') |
| 1330 | parser.add_argument( |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1331 | '--desc', |
Motomu Utsumi | 879dec8 | 2022-11-18 15:25:12 +0900 | [diff] [blame] | 1332 | help='GN description (e.g., gn desc out --format=json --all-toolchains "//*".' + |
| 1333 | 'You can specify multiple --desc options for different target_cpu', |
| 1334 | required=True, |
| 1335 | action='append' |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1336 | ) |
| 1337 | parser.add_argument( |
| 1338 | '--extras', |
| 1339 | help='Extra targets to include at the end of the Blueprint file', |
| 1340 | default=os.path.join(gn_utils.repo_root(), 'Android.bp.extras'), |
| 1341 | ) |
| 1342 | parser.add_argument( |
| 1343 | '--output', |
| 1344 | help='Blueprint file to create', |
| 1345 | default=os.path.join(gn_utils.repo_root(), 'Android.bp'), |
| 1346 | ) |
| 1347 | parser.add_argument( |
Patrick Rohr | 1622894 | 2022-10-26 14:00:26 -0700 | [diff] [blame] | 1348 | '-v', |
| 1349 | '--verbose', |
| 1350 | help='Print debug logs.', |
| 1351 | action='store_true', |
| 1352 | ) |
| 1353 | parser.add_argument( |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1354 | 'targets', |
| 1355 | nargs=argparse.REMAINDER, |
Patrick Rohr | 1aa504a | 2022-10-25 10:30:42 -0700 | [diff] [blame] | 1356 | help='Targets to include in the blueprint (e.g., "//:perfetto_tests")' |
| 1357 | ) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1358 | args = parser.parse_args() |
| 1359 | |
Patrick Rohr | 1622894 | 2022-10-26 14:00:26 -0700 | [diff] [blame] | 1360 | if args.verbose: |
| 1361 | log.basicConfig(format='%(levelname)s:%(funcName)s:%(message)s', level=log.DEBUG) |
| 1362 | |
Patrick Rohr | d0077b7 | 2022-11-15 12:43:26 -0800 | [diff] [blame] | 1363 | targets = args.targets or default_targets |
Motomu Utsumi | 879dec8 | 2022-11-18 15:25:12 +0900 | [diff] [blame] | 1364 | gn = gn_utils.GnParser() |
| 1365 | for desc_file in args.desc: |
| 1366 | with open(desc_file) as f: |
| 1367 | desc = json.load(f) |
| 1368 | for target in targets: |
| 1369 | gn.parse_gn_desc(desc, target) |
Motomu Utsumi | a71281c | 2022-11-18 15:19:00 +0900 | [diff] [blame] | 1370 | blueprint = create_blueprint_for_targets(gn, targets) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1371 | project_root = os.path.abspath(os.path.dirname(os.path.dirname(__file__))) |
| 1372 | tool_name = os.path.relpath(os.path.abspath(__file__), project_root) |
| 1373 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1374 | # Add any proto groups to the blueprint. |
| 1375 | for l_name, t_names in proto_groups.items(): |
| 1376 | create_proto_group_modules(blueprint, gn, l_name, t_names) |
| 1377 | |
| 1378 | output = [ |
Patrick Rohr | 5478b39 | 2022-10-25 09:58:50 -0700 | [diff] [blame] | 1379 | """// Copyright (C) 2022 The Android Open Source Project |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1380 | // |
| 1381 | // Licensed under the Apache License, Version 2.0 (the "License"); |
| 1382 | // you may not use this file except in compliance with the License. |
| 1383 | // You may obtain a copy of the License at |
| 1384 | // |
| 1385 | // http://www.apache.org/licenses/LICENSE-2.0 |
| 1386 | // |
| 1387 | // Unless required by applicable law or agreed to in writing, software |
| 1388 | // distributed under the License is distributed on an "AS IS" BASIS, |
| 1389 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 1390 | // See the License for the specific language governing permissions and |
| 1391 | // limitations under the License. |
| 1392 | // |
| 1393 | // This file is automatically generated by %s. Do not edit. |
| 1394 | """ % (tool_name) |
| 1395 | ] |
| 1396 | blueprint.to_string(output) |
Patrick Rohr | cb98e9b | 2022-10-25 09:57:02 -0700 | [diff] [blame] | 1397 | if os.path.exists(args.extras): |
| 1398 | with open(args.extras, 'r') as r: |
| 1399 | for line in r: |
| 1400 | output.append(line.rstrip("\n\r")) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1401 | |
| 1402 | out_files = [] |
| 1403 | |
| 1404 | # Generate the Android.bp file. |
| 1405 | out_files.append(args.output + '.swp') |
| 1406 | with open(out_files[-1], 'w') as f: |
| 1407 | f.write('\n'.join(output)) |
| 1408 | # Text files should have a trailing EOL. |
| 1409 | f.write('\n') |
| 1410 | |
Patrick Rohr | 94693eb | 2022-10-25 10:09:16 -0700 | [diff] [blame] | 1411 | return 0 |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1412 | |
| 1413 | |
| 1414 | if __name__ == '__main__': |
| 1415 | sys.exit(main()) |