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 | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 32 | import os |
| 33 | import re |
| 34 | import sys |
Motomu Utsumi | c6277d9 | 2022-11-07 15:15:17 +0900 | [diff] [blame] | 35 | import copy |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 36 | |
| 37 | import gn_utils |
| 38 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 39 | ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) |
| 40 | |
Patrick Rohr | 0629636 | 2022-11-10 21:37:33 -0800 | [diff] [blame] | 41 | # Default targets to translate to the blueprint file. |
| 42 | default_targets = [ |
| 43 | '//components/cronet/android:cronet', |
| 44 | ] |
| 45 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 46 | # Defines a custom init_rc argument to be applied to the corresponding output |
| 47 | # blueprint target. |
| 48 | target_initrc = { |
Patrick Rohr | c36ef42 | 2022-10-25 10:38:05 -0700 | [diff] [blame] | 49 | # TODO: this can probably be removed. |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 50 | } |
| 51 | |
| 52 | target_host_supported = [ |
Patrick Rohr | dc38394 | 2022-10-25 10:45:29 -0700 | [diff] [blame] | 53 | # TODO: remove if this is not useful for the cronet build. |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 54 | ] |
| 55 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 56 | # Proto target groups which will be made public. |
| 57 | proto_groups = { |
Patrick Rohr | 95212a2 | 2022-10-25 09:53:13 -0700 | [diff] [blame] | 58 | # TODO: remove if this is not used for the cronet build. |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 59 | } |
| 60 | |
| 61 | # All module names are prefixed with this string to avoid collisions. |
Patrick Rohr | 61b2bad | 2022-10-25 10:49:20 -0700 | [diff] [blame] | 62 | module_prefix = 'cronet_aml_' |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 63 | |
| 64 | # Shared libraries which are directly translated to Android system equivalents. |
| 65 | shared_library_allowlist = [ |
| 66 | 'android', |
| 67 | 'android.hardware.atrace@1.0', |
| 68 | 'android.hardware.health@2.0', |
| 69 | 'android.hardware.health-V1-ndk', |
| 70 | 'android.hardware.power.stats@1.0', |
| 71 | "android.hardware.power.stats-V1-cpp", |
| 72 | 'base', |
| 73 | 'binder', |
| 74 | 'binder_ndk', |
| 75 | 'cutils', |
| 76 | 'hidlbase', |
| 77 | 'hidltransport', |
| 78 | 'hwbinder', |
| 79 | 'incident', |
| 80 | 'log', |
| 81 | 'services', |
| 82 | 'statssocket', |
| 83 | "tracingproxy", |
| 84 | 'utils', |
| 85 | ] |
| 86 | |
| 87 | # Static libraries which are directly translated to Android system equivalents. |
| 88 | static_library_allowlist = [ |
| 89 | 'statslog_perfetto', |
| 90 | ] |
| 91 | |
Patrick Rohr | d9dd3b9 | 2022-11-09 16:15:30 -0800 | [diff] [blame] | 92 | # Include directories that will be removed from all targets. |
| 93 | local_include_dirs_denylist = [ |
| 94 | 'third_party/protobuf/src/', |
| 95 | ] |
| 96 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 97 | # Name of the module which settings such as compiler flags for all other |
| 98 | # modules. |
| 99 | defaults_module = module_prefix + 'defaults' |
| 100 | |
| 101 | # Location of the project in the Android source tree. |
Patrick Rohr | 76ceeb5 | 2022-11-07 14:18:58 -0800 | [diff] [blame] | 102 | tree_path = 'external/chromium_org' |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 103 | |
| 104 | # Path for the protobuf sources in the standalone build. |
| 105 | buildtools_protobuf_src = '//buildtools/protobuf/src' |
| 106 | |
| 107 | # Location of the protobuf src dir in the Android source tree. |
| 108 | android_protobuf_src = 'external/protobuf/src' |
| 109 | |
| 110 | # Compiler flags which are passed through to the blueprint. |
| 111 | cflag_allowlist = r'^-DPERFETTO.*$' |
| 112 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 113 | # Additional arguments to apply to Android.bp rules. |
| 114 | additional_args = { |
Patrick Rohr | 2267a0a | 2022-11-08 18:59:34 -0800 | [diff] [blame] | 115 | # TODO: remove if not needed. |
Patrick Rohr | bb0956e | 2022-11-09 15:37:16 -0800 | [diff] [blame] | 116 | 'cronet_aml_net_net': [ |
Patrick Rohr | 9f4d3e3 | 2022-11-09 16:37:31 -0800 | [diff] [blame] | 117 | ('export_static_lib_headers', { |
| 118 | 'cronet_aml_net_third_party_quiche_quiche', |
| 119 | 'cronet_aml_crypto_crypto', |
| 120 | }), |
Mohannad Farrag | 627dc91 | 2022-11-11 19:00:26 +0000 | [diff] [blame] | 121 | # When a code is compiled under rtti(cronet) that depends on another code(net) |
| 122 | # that doesn't depend on rtti. undefined symbol: typeinfo 'class' errors appears. |
| 123 | ('rtti', True), # go/undefined-symbol-typeinfo |
Mohannad Farrag | e7d2931 | 2022-11-10 17:39:16 +0000 | [diff] [blame] | 124 | ('whole_static_libs', { |
| 125 | 'cronet_aml_net_third_party_quiche_quiche', |
| 126 | 'cronet_aml_base_base', |
| 127 | "cronet_aml_crypto_crypto", |
Patrick Rohr | cc83af2 | 2022-11-10 20:00:58 -0800 | [diff] [blame] | 128 | "libssl", |
Mohannad Farrag | e7d2931 | 2022-11-10 17:39:16 +0000 | [diff] [blame] | 129 | }), |
Mohannad Farrag | 37388fa | 2022-11-10 20:42:13 +0000 | [diff] [blame] | 130 | ], |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 131 | } |
| 132 | |
| 133 | |
| 134 | def enable_gtest_and_gmock(module): |
| 135 | module.static_libs.add('libgmock') |
| 136 | module.static_libs.add('libgtest') |
| 137 | if module.name != 'perfetto_gtest_logcat_printer': |
| 138 | module.whole_static_libs.add('perfetto_gtest_logcat_printer') |
| 139 | |
| 140 | |
| 141 | def enable_protobuf_full(module): |
| 142 | if module.type == 'cc_binary_host': |
| 143 | module.static_libs.add('libprotobuf-cpp-full') |
| 144 | elif module.host_supported: |
| 145 | module.host.static_libs.add('libprotobuf-cpp-full') |
| 146 | module.android.shared_libs.add('libprotobuf-cpp-full') |
Patrick Rohr | 84b1640 | 2022-11-08 19:01:01 -0800 | [diff] [blame] | 147 | elif module.type not in ['genrule', 'filegroup']: |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 148 | module.shared_libs.add('libprotobuf-cpp-full') |
| 149 | |
| 150 | |
| 151 | def enable_protobuf_lite(module): |
Patrick Rohr | 84b1640 | 2022-11-08 19:01:01 -0800 | [diff] [blame] | 152 | if module.type not in ['genrule', 'filegroup']: |
| 153 | module.shared_libs.add('libprotobuf-cpp-lite') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 154 | |
| 155 | |
| 156 | def enable_protoc_lib(module): |
| 157 | if module.type == 'cc_binary_host': |
| 158 | module.static_libs.add('libprotoc') |
| 159 | else: |
| 160 | module.shared_libs.add('libprotoc') |
| 161 | |
| 162 | |
| 163 | def enable_libunwindstack(module): |
| 164 | if module.name != 'heapprofd_standalone_client': |
| 165 | module.shared_libs.add('libunwindstack') |
| 166 | module.shared_libs.add('libprocinfo') |
| 167 | module.shared_libs.add('libbase') |
| 168 | else: |
| 169 | module.static_libs.add('libunwindstack') |
| 170 | module.static_libs.add('libprocinfo') |
| 171 | module.static_libs.add('libbase') |
| 172 | module.static_libs.add('liblzma') |
| 173 | module.static_libs.add('libdexfile_support') |
| 174 | module.runtime_libs.add('libdexfile') # libdexfile_support dependency |
| 175 | |
| 176 | |
| 177 | def enable_libunwind(module): |
| 178 | # libunwind is disabled on Darwin so we cannot depend on it. |
| 179 | pass |
| 180 | |
| 181 | |
| 182 | def enable_sqlite(module): |
| 183 | if module.type == 'cc_binary_host': |
| 184 | module.static_libs.add('libsqlite') |
| 185 | module.static_libs.add('sqlite_ext_percentile') |
| 186 | elif module.host_supported: |
| 187 | # Copy what the sqlite3 command line tool does. |
| 188 | module.android.shared_libs.add('libsqlite') |
| 189 | module.android.shared_libs.add('libicu') |
| 190 | module.android.shared_libs.add('liblog') |
| 191 | module.android.shared_libs.add('libutils') |
| 192 | module.android.static_libs.add('sqlite_ext_percentile') |
| 193 | module.host.static_libs.add('libsqlite') |
| 194 | module.host.static_libs.add('sqlite_ext_percentile') |
| 195 | else: |
| 196 | module.shared_libs.add('libsqlite') |
| 197 | module.shared_libs.add('libicu') |
| 198 | module.shared_libs.add('liblog') |
| 199 | module.shared_libs.add('libutils') |
| 200 | module.static_libs.add('sqlite_ext_percentile') |
| 201 | |
| 202 | |
| 203 | def enable_zlib(module): |
| 204 | if module.type == 'cc_binary_host': |
| 205 | module.static_libs.add('libz') |
| 206 | elif module.host_supported: |
| 207 | module.android.shared_libs.add('libz') |
| 208 | module.host.static_libs.add('libz') |
| 209 | else: |
| 210 | module.shared_libs.add('libz') |
| 211 | |
| 212 | |
| 213 | def enable_uapi_headers(module): |
| 214 | module.include_dirs.add('bionic/libc/kernel') |
| 215 | |
| 216 | |
| 217 | def enable_bionic_libc_platform_headers_on_android(module): |
| 218 | module.header_libs.add('bionic_libc_platform_headers') |
| 219 | |
| 220 | |
Patrick Rohr | cc83af2 | 2022-11-10 20:00:58 -0800 | [diff] [blame] | 221 | def enable_boringssl(module): |
| 222 | if module.type not in ['genrule', 'filegroup']: |
| 223 | module.static_libs.add('libssl') |
| 224 | |
| 225 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 226 | # Android equivalents for third-party libraries that the upstream project |
| 227 | # depends on. |
| 228 | builtin_deps = { |
| 229 | '//gn:default_deps': |
| 230 | lambda x: None, |
| 231 | '//gn:gtest_main': |
| 232 | lambda x: None, |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 233 | '//gn:gtest_and_gmock': |
| 234 | enable_gtest_and_gmock, |
| 235 | '//gn:libunwind': |
| 236 | enable_libunwind, |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 237 | '//gn:libunwindstack': |
| 238 | enable_libunwindstack, |
| 239 | '//gn:sqlite': |
| 240 | enable_sqlite, |
| 241 | '//gn:zlib': |
| 242 | enable_zlib, |
| 243 | '//gn:bionic_kernel_uapi_headers': |
| 244 | enable_uapi_headers, |
| 245 | '//src/profiling/memory:bionic_libc_platform_headers_on_android': |
| 246 | enable_bionic_libc_platform_headers_on_android, |
Motomu Utsumi | dfc8e6a | 2022-11-04 18:25:33 +0900 | [diff] [blame] | 247 | '//third_party/protobuf:protoc': |
| 248 | lambda x: None, |
Patrick Rohr | 84b1640 | 2022-11-08 19:01:01 -0800 | [diff] [blame] | 249 | '//third_party/protobuf:protobuf_full': |
| 250 | enable_protobuf_full, |
| 251 | '//third_party/protobuf:protobuf_lite': |
| 252 | enable_protobuf_lite, |
| 253 | '//third_party/protobuf:protoc_lib': |
| 254 | enable_protoc_lib, |
Patrick Rohr | cc83af2 | 2022-11-10 20:00:58 -0800 | [diff] [blame] | 255 | '//third_party/boringssl:boringssl': |
| 256 | enable_boringssl, |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 257 | } |
| 258 | |
| 259 | # ---------------------------------------------------------------------------- |
| 260 | # End of configuration. |
| 261 | # ---------------------------------------------------------------------------- |
| 262 | |
| 263 | |
| 264 | class Error(Exception): |
| 265 | pass |
| 266 | |
| 267 | |
| 268 | class ThrowingArgumentParser(argparse.ArgumentParser): |
| 269 | |
| 270 | def __init__(self, context): |
| 271 | super(ThrowingArgumentParser, self).__init__() |
| 272 | self.context = context |
| 273 | |
| 274 | def error(self, message): |
| 275 | raise Error('%s: %s' % (self.context, message)) |
| 276 | |
| 277 | |
| 278 | def write_blueprint_key_value(output, name, value, sort=True): |
| 279 | """Writes a Blueprint key-value pair to the output""" |
| 280 | |
| 281 | if isinstance(value, bool): |
| 282 | if value: |
| 283 | output.append(' %s: true,' % name) |
| 284 | else: |
| 285 | output.append(' %s: false,' % name) |
| 286 | return |
| 287 | if not value: |
| 288 | return |
| 289 | if isinstance(value, set): |
| 290 | value = sorted(value) |
| 291 | if isinstance(value, list): |
| 292 | output.append(' %s: [' % name) |
| 293 | for item in sorted(value) if sort else value: |
| 294 | output.append(' "%s",' % item) |
| 295 | output.append(' ],') |
| 296 | return |
| 297 | if isinstance(value, Target): |
| 298 | value.to_string(output) |
| 299 | return |
| 300 | if isinstance(value, dict): |
| 301 | kv_output = [] |
| 302 | for k, v in value.items(): |
| 303 | write_blueprint_key_value(kv_output, k, v) |
| 304 | |
| 305 | output.append(' %s: {' % name) |
| 306 | for line in kv_output: |
| 307 | output.append(' %s' % line) |
| 308 | output.append(' },') |
| 309 | return |
| 310 | output.append(' %s: "%s",' % (name, value)) |
| 311 | |
| 312 | |
| 313 | class Target(object): |
| 314 | """A target-scoped part of a module""" |
| 315 | |
| 316 | def __init__(self, name): |
| 317 | self.name = name |
| 318 | self.shared_libs = set() |
| 319 | self.static_libs = set() |
| 320 | self.whole_static_libs = set() |
| 321 | self.cflags = set() |
| 322 | self.dist = dict() |
| 323 | self.strip = dict() |
| 324 | self.stl = None |
| 325 | |
| 326 | def to_string(self, output): |
| 327 | nested_out = [] |
| 328 | self._output_field(nested_out, 'shared_libs') |
| 329 | self._output_field(nested_out, 'static_libs') |
| 330 | self._output_field(nested_out, 'whole_static_libs') |
| 331 | self._output_field(nested_out, 'cflags') |
| 332 | self._output_field(nested_out, 'stl') |
| 333 | self._output_field(nested_out, 'dist') |
| 334 | self._output_field(nested_out, 'strip') |
| 335 | |
| 336 | if nested_out: |
| 337 | output.append(' %s: {' % self.name) |
| 338 | for line in nested_out: |
| 339 | output.append(' %s' % line) |
| 340 | output.append(' },') |
| 341 | |
| 342 | def _output_field(self, output, name, sort=True): |
| 343 | value = getattr(self, name) |
| 344 | return write_blueprint_key_value(output, name, value, sort) |
| 345 | |
| 346 | |
| 347 | class Module(object): |
| 348 | """A single module (e.g., cc_binary, cc_test) in a blueprint.""" |
| 349 | |
| 350 | def __init__(self, mod_type, name, gn_target): |
| 351 | self.type = mod_type |
| 352 | self.gn_target = gn_target |
| 353 | self.name = name |
| 354 | self.srcs = set() |
| 355 | self.comment = 'GN: ' + gn_utils.label_without_toolchain(gn_target) |
| 356 | self.shared_libs = set() |
| 357 | self.static_libs = set() |
| 358 | self.whole_static_libs = set() |
| 359 | self.runtime_libs = set() |
| 360 | self.tools = set() |
| 361 | self.cmd = None |
| 362 | self.host_supported = False |
| 363 | self.vendor_available = False |
| 364 | self.init_rc = set() |
| 365 | self.out = set() |
| 366 | self.export_include_dirs = set() |
| 367 | self.generated_headers = set() |
| 368 | self.export_generated_headers = set() |
Patrick Rohr | bb0956e | 2022-11-09 15:37:16 -0800 | [diff] [blame] | 369 | self.export_static_lib_headers = set() |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 370 | self.defaults = set() |
| 371 | self.cflags = set() |
| 372 | self.include_dirs = set() |
Motomu Utsumi | 97fb181 | 2022-11-01 13:08:10 +0900 | [diff] [blame] | 373 | self.local_include_dirs = [] |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 374 | self.header_libs = set() |
| 375 | self.required = set() |
Patrick Rohr | 3d8c728 | 2022-10-27 13:36:31 -0700 | [diff] [blame] | 376 | self.tool_files = set() |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 377 | self.android = Target('android') |
| 378 | self.host = Target('host') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 379 | self.stl = None |
Patrick Rohr | b8f830a | 2022-10-31 11:18:57 -0700 | [diff] [blame] | 380 | self.cpp_std = None |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 381 | self.dist = dict() |
| 382 | self.strip = dict() |
| 383 | self.data = set() |
| 384 | self.apex_available = set() |
| 385 | self.min_sdk_version = None |
| 386 | self.proto = dict() |
| 387 | # The genrule_XXX below are properties that must to be propagated back |
| 388 | # on the module(s) that depend on the genrule. |
| 389 | self.genrule_headers = set() |
| 390 | self.genrule_srcs = set() |
| 391 | self.genrule_shared_libs = set() |
Patrick Rohr | a1a2787 | 2022-10-31 11:57:14 -0700 | [diff] [blame] | 392 | self.genrule_header_libs = set() |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 393 | self.version_script = None |
| 394 | self.test_suites = set() |
| 395 | self.test_config = None |
| 396 | self.stubs = {} |
Mohannad Farrag | 37388fa | 2022-11-10 20:42:13 +0000 | [diff] [blame] | 397 | self.cppflags = set() |
| 398 | self.rtti = False |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 399 | |
| 400 | def to_string(self, output): |
| 401 | if self.comment: |
| 402 | output.append('// %s' % self.comment) |
| 403 | output.append('%s {' % self.type) |
| 404 | self._output_field(output, 'name') |
| 405 | self._output_field(output, 'srcs') |
| 406 | self._output_field(output, 'shared_libs') |
| 407 | self._output_field(output, 'static_libs') |
| 408 | self._output_field(output, 'whole_static_libs') |
| 409 | self._output_field(output, 'runtime_libs') |
| 410 | self._output_field(output, 'tools') |
| 411 | self._output_field(output, 'cmd', sort=False) |
| 412 | if self.host_supported: |
| 413 | self._output_field(output, 'host_supported') |
| 414 | if self.vendor_available: |
| 415 | self._output_field(output, 'vendor_available') |
| 416 | self._output_field(output, 'init_rc') |
| 417 | self._output_field(output, 'out') |
| 418 | self._output_field(output, 'export_include_dirs') |
| 419 | self._output_field(output, 'generated_headers') |
| 420 | self._output_field(output, 'export_generated_headers') |
Patrick Rohr | bb0956e | 2022-11-09 15:37:16 -0800 | [diff] [blame] | 421 | self._output_field(output, 'export_static_lib_headers') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 422 | self._output_field(output, 'defaults') |
| 423 | self._output_field(output, 'cflags') |
| 424 | self._output_field(output, 'include_dirs') |
Motomu Utsumi | 97fb181 | 2022-11-01 13:08:10 +0900 | [diff] [blame] | 425 | self._output_field(output, 'local_include_dirs', sort=False) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 426 | self._output_field(output, 'header_libs') |
| 427 | self._output_field(output, 'required') |
| 428 | self._output_field(output, 'dist') |
| 429 | self._output_field(output, 'strip') |
| 430 | self._output_field(output, 'tool_files') |
| 431 | self._output_field(output, 'data') |
| 432 | self._output_field(output, 'stl') |
Patrick Rohr | b8f830a | 2022-10-31 11:18:57 -0700 | [diff] [blame] | 433 | self._output_field(output, 'cpp_std') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 434 | self._output_field(output, 'apex_available') |
| 435 | self._output_field(output, 'min_sdk_version') |
| 436 | self._output_field(output, 'version_script') |
| 437 | self._output_field(output, 'test_suites') |
| 438 | self._output_field(output, 'test_config') |
| 439 | self._output_field(output, 'stubs') |
| 440 | self._output_field(output, 'proto') |
Mohannad Farrag | 37388fa | 2022-11-10 20:42:13 +0000 | [diff] [blame] | 441 | self._output_field(output, 'cppflags') |
| 442 | if self.rtti: |
| 443 | self._output_field(output, 'rtti') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 444 | |
| 445 | target_out = [] |
| 446 | self._output_field(target_out, 'android') |
| 447 | self._output_field(target_out, 'host') |
| 448 | if target_out: |
| 449 | output.append(' target: {') |
| 450 | for line in target_out: |
| 451 | output.append(' %s' % line) |
| 452 | output.append(' },') |
| 453 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 454 | output.append('}') |
| 455 | output.append('') |
| 456 | |
| 457 | def add_android_static_lib(self, lib): |
| 458 | if self.type == 'cc_binary_host': |
| 459 | raise Exception('Adding Android static lib for host tool is unsupported') |
| 460 | elif self.host_supported: |
| 461 | self.android.static_libs.add(lib) |
| 462 | else: |
| 463 | self.static_libs.add(lib) |
| 464 | |
| 465 | def add_android_shared_lib(self, lib): |
| 466 | if self.type == 'cc_binary_host': |
| 467 | raise Exception('Adding Android shared lib for host tool is unsupported') |
| 468 | elif self.host_supported: |
| 469 | self.android.shared_libs.add(lib) |
| 470 | else: |
| 471 | self.shared_libs.add(lib) |
| 472 | |
| 473 | def _output_field(self, output, name, sort=True): |
| 474 | value = getattr(self, name) |
| 475 | return write_blueprint_key_value(output, name, value, sort) |
| 476 | |
| 477 | |
| 478 | class Blueprint(object): |
| 479 | """In-memory representation of an Android.bp file.""" |
| 480 | |
| 481 | def __init__(self): |
| 482 | self.modules = {} |
| 483 | |
| 484 | def add_module(self, module): |
| 485 | """Adds a new module to the blueprint, replacing any existing module |
| 486 | with the same name. |
| 487 | |
| 488 | Args: |
| 489 | module: Module instance. |
| 490 | """ |
| 491 | self.modules[module.name] = module |
| 492 | |
| 493 | def to_string(self, output): |
Patrick Rohr | 23f2619 | 2022-10-25 09:45:22 -0700 | [diff] [blame] | 494 | for m in sorted(self.modules.values(), key=lambda m: m.name): |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 495 | m.to_string(output) |
| 496 | |
| 497 | |
| 498 | def label_to_module_name(label): |
| 499 | """Turn a GN label (e.g., //:perfetto_tests) into a module name.""" |
| 500 | # If the label is explicibly listed in the default target list, don't prefix |
| 501 | # its name and return just the target name. This is so tools like |
| 502 | # "traceconv" stay as such in the Android tree. |
| 503 | label_without_toolchain = gn_utils.label_without_toolchain(label) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 504 | module = re.sub(r'^//:?', '', label_without_toolchain) |
| 505 | module = re.sub(r'[^a-zA-Z0-9_]', '_', module) |
| 506 | if not module.startswith(module_prefix): |
| 507 | return module_prefix + module |
| 508 | return module |
| 509 | |
| 510 | |
| 511 | def is_supported_source_file(name): |
| 512 | """Returns True if |name| can appear in a 'srcs' list.""" |
Patrick Rohr | f9f3a99 | 2022-11-10 19:40:32 -0800 | [diff] [blame] | 513 | 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] | 514 | |
| 515 | |
| 516 | def create_proto_modules(blueprint, gn, target): |
| 517 | """Generate genrules for a proto GN target. |
| 518 | |
| 519 | GN actions are used to dynamically generate files during the build. The |
| 520 | Soong equivalent is a genrule. This function turns a specific kind of |
| 521 | genrule which turns .proto files into source and header files into a pair |
| 522 | equivalent genrules. |
| 523 | |
| 524 | Args: |
| 525 | blueprint: Blueprint instance which is being generated. |
| 526 | target: gn_utils.Target object. |
| 527 | |
| 528 | Returns: |
| 529 | The source_genrule module. |
| 530 | """ |
| 531 | assert (target.type == 'proto_library') |
| 532 | |
| 533 | tools = {'aprotoc'} |
Motomu Utsumi | d7e0e42 | 2022-11-08 17:49:52 +0900 | [diff] [blame] | 534 | cpp_out_dir = '$(genDir)/%s/%s/' % (tree_path, target.proto_in_dir) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 535 | target_module_name = label_to_module_name(target.name) |
| 536 | |
| 537 | # In GN builds the proto path is always relative to the output directory |
| 538 | # (out/tmp.xxx). |
Motomu Utsumi | e845745 | 2022-11-08 18:47:51 +0900 | [diff] [blame] | 539 | cmd = ['$(location aprotoc)'] |
Motomu Utsumi | d7e0e42 | 2022-11-08 17:49:52 +0900 | [diff] [blame] | 540 | cmd += ['--proto_path=%s/%s' % (tree_path, target.proto_in_dir)] |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 541 | |
| 542 | if buildtools_protobuf_src in target.proto_paths: |
| 543 | cmd += ['--proto_path=%s' % android_protobuf_src] |
| 544 | |
| 545 | # We don't generate any targets for source_set proto modules because |
| 546 | # they will be inlined into other modules if required. |
| 547 | if target.proto_plugin == 'source_set': |
| 548 | return None |
| 549 | |
| 550 | # Descriptor targets only generate a single target. |
| 551 | if target.proto_plugin == 'descriptor': |
| 552 | out = '{}.bin'.format(target_module_name) |
| 553 | |
| 554 | cmd += ['--descriptor_set_out=$(out)'] |
| 555 | cmd += ['$(in)'] |
| 556 | |
| 557 | descriptor_module = Module('genrule', target_module_name, target.name) |
| 558 | descriptor_module.cmd = ' '.join(cmd) |
| 559 | descriptor_module.out = [out] |
| 560 | descriptor_module.tools = tools |
| 561 | blueprint.add_module(descriptor_module) |
| 562 | |
| 563 | # Recursively extract the .proto files of all the dependencies and |
| 564 | # add them to srcs. |
| 565 | descriptor_module.srcs.update( |
| 566 | gn_utils.label_to_path(src) for src in target.sources) |
| 567 | for dep in target.transitive_proto_deps: |
| 568 | current_target = gn.get_target(dep) |
| 569 | descriptor_module.srcs.update( |
| 570 | gn_utils.label_to_path(src) for src in current_target.sources) |
| 571 | |
| 572 | return descriptor_module |
| 573 | |
| 574 | # We create two genrules for each proto target: one for the headers and |
| 575 | # another for the sources. This is because the module that depends on the |
| 576 | # generated files needs to declare two different types of dependencies -- |
| 577 | # source files in 'srcs' and headers in 'generated_headers' -- and it's not |
| 578 | # valid to generate .h files from a source dependency and vice versa. |
| 579 | source_module_name = target_module_name + '_gen' |
| 580 | source_module = Module('genrule', source_module_name, target.name) |
| 581 | blueprint.add_module(source_module) |
| 582 | source_module.srcs.update( |
| 583 | gn_utils.label_to_path(src) for src in target.sources) |
| 584 | |
| 585 | header_module = Module('genrule', source_module_name + '_headers', |
| 586 | target.name) |
| 587 | blueprint.add_module(header_module) |
| 588 | header_module.srcs = set(source_module.srcs) |
| 589 | |
| 590 | # TODO(primiano): at some point we should remove this. This was introduced |
| 591 | # by aosp/1108421 when adding "protos/" to .proto include paths, in order to |
| 592 | # avoid doing multi-repo changes and allow old clients in the android tree |
| 593 | # to still do the old #include "perfetto/..." rather than |
| 594 | # #include "protos/perfetto/...". |
| 595 | header_module.export_include_dirs = {'.', 'protos'} |
Patrick Rohr | 2267a0a | 2022-11-08 18:59:34 -0800 | [diff] [blame] | 596 | # Since the .cc file and .h get created by a different gerule target, they |
| 597 | # are not put in the same intermediate path, so local includes do not work |
| 598 | # without explictily exporting the include dir. |
| 599 | header_module.export_include_dirs.add(target.proto_in_dir) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 600 | |
| 601 | source_module.genrule_srcs.add(':' + source_module.name) |
| 602 | source_module.genrule_headers.add(header_module.name) |
| 603 | |
| 604 | if target.proto_plugin == 'proto': |
| 605 | suffixes = ['pb'] |
| 606 | source_module.genrule_shared_libs.add('libprotobuf-cpp-lite') |
| 607 | cmd += ['--cpp_out=lite=true:' + cpp_out_dir] |
| 608 | elif target.proto_plugin == 'protozero': |
| 609 | suffixes = ['pbzero'] |
| 610 | plugin = create_modules_from_target(blueprint, gn, protozero_plugin) |
| 611 | tools.add(plugin.name) |
| 612 | cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name] |
| 613 | cmd += ['--plugin_out=wrapper_namespace=pbzero:' + cpp_out_dir] |
| 614 | elif target.proto_plugin == 'cppgen': |
| 615 | suffixes = ['gen'] |
| 616 | plugin = create_modules_from_target(blueprint, gn, cppgen_plugin) |
| 617 | tools.add(plugin.name) |
| 618 | cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name] |
| 619 | cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir] |
| 620 | elif target.proto_plugin == 'ipc': |
| 621 | suffixes = ['ipc'] |
| 622 | plugin = create_modules_from_target(blueprint, gn, ipc_plugin) |
| 623 | tools.add(plugin.name) |
| 624 | cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name] |
| 625 | cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir] |
| 626 | else: |
| 627 | raise Error('Unsupported proto plugin: %s' % target.proto_plugin) |
| 628 | |
| 629 | cmd += ['$(in)'] |
| 630 | source_module.cmd = ' '.join(cmd) |
| 631 | header_module.cmd = source_module.cmd |
| 632 | source_module.tools = tools |
| 633 | header_module.tools = tools |
| 634 | |
| 635 | for sfx in suffixes: |
| 636 | source_module.out.update('%s/%s' % |
| 637 | (tree_path, src.replace('.proto', '.%s.cc' % sfx)) |
| 638 | for src in source_module.srcs) |
| 639 | header_module.out.update('%s/%s' % |
| 640 | (tree_path, src.replace('.proto', '.%s.h' % sfx)) |
| 641 | for src in header_module.srcs) |
| 642 | return source_module |
| 643 | |
| 644 | |
| 645 | def create_amalgamated_sql_metrics_module(blueprint, target): |
| 646 | bp_module_name = label_to_module_name(target.name) |
| 647 | module = Module('genrule', bp_module_name, target.name) |
Patrick Rohr | 3d8c728 | 2022-10-27 13:36:31 -0700 | [diff] [blame] | 648 | module.tool_files.add('tools/gen_amalgamated_sql_metrics.py') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 649 | module.cmd = ' '.join([ |
| 650 | '$(location tools/gen_amalgamated_sql_metrics.py)', |
| 651 | '--cpp_out=$(out)', |
| 652 | '$(in)', |
| 653 | ]) |
| 654 | module.genrule_headers.add(module.name) |
| 655 | module.out.update(target.outputs) |
| 656 | module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs) |
| 657 | blueprint.add_module(module) |
| 658 | return module |
| 659 | |
| 660 | |
| 661 | def create_cc_proto_descriptor_module(blueprint, target): |
| 662 | bp_module_name = label_to_module_name(target.name) |
| 663 | module = Module('genrule', bp_module_name, target.name) |
Patrick Rohr | 3d8c728 | 2022-10-27 13:36:31 -0700 | [diff] [blame] | 664 | module.tool_files.add('tools/gen_cc_proto_descriptor.py') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 665 | module.cmd = ' '.join([ |
| 666 | '$(location tools/gen_cc_proto_descriptor.py)', '--gen_dir=$(genDir)', |
| 667 | '--cpp_out=$(out)', '$(in)' |
| 668 | ]) |
| 669 | module.genrule_headers.add(module.name) |
| 670 | module.srcs.update( |
| 671 | ':' + label_to_module_name(dep) for dep in target.proto_deps) |
| 672 | module.srcs.update( |
| 673 | gn_utils.label_to_path(src) |
| 674 | for src in target.inputs |
| 675 | if "tmp.gn_utils" not in src) |
| 676 | module.out.update(target.outputs) |
| 677 | blueprint.add_module(module) |
| 678 | return module |
| 679 | |
| 680 | |
| 681 | def create_gen_version_module(blueprint, target, bp_module_name): |
| 682 | module = Module('genrule', bp_module_name, gn_utils.GEN_VERSION_TARGET) |
| 683 | script_path = gn_utils.label_to_path(target.script) |
| 684 | module.genrule_headers.add(bp_module_name) |
Patrick Rohr | 3d8c728 | 2022-10-27 13:36:31 -0700 | [diff] [blame] | 685 | module.tool_files.add(script_path) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 686 | module.out.update(target.outputs) |
| 687 | module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs) |
| 688 | module.cmd = ' '.join([ |
| 689 | 'python3 $(location %s)' % script_path, '--no_git', |
| 690 | '--changelog=$(location CHANGELOG)', '--cpp_out=$(out)' |
| 691 | ]) |
| 692 | blueprint.add_module(module) |
| 693 | return module |
| 694 | |
| 695 | |
| 696 | def create_proto_group_modules(blueprint, gn, module_name, target_names): |
| 697 | # TODO(lalitm): today, we're only adding a Java lite module because that's |
| 698 | # the only one used in practice. In the future, if we need other target types |
| 699 | # (e.g. C++, Java full etc.) add them here. |
| 700 | bp_module_name = label_to_module_name(module_name) + '_java_protos' |
| 701 | module = Module('java_library', bp_module_name, bp_module_name) |
| 702 | module.comment = f'''GN: [{', '.join(target_names)}]''' |
| 703 | module.proto = {'type': 'lite', 'canonical_path_from_root': False} |
| 704 | |
| 705 | for name in target_names: |
| 706 | target = gn.get_target(name) |
| 707 | module.srcs.update(gn_utils.label_to_path(src) for src in target.sources) |
| 708 | for dep_label in target.transitive_proto_deps: |
| 709 | dep = gn.get_target(dep_label) |
| 710 | module.srcs.update(gn_utils.label_to_path(src) for src in dep.sources) |
| 711 | |
| 712 | blueprint.add_module(module) |
| 713 | |
Motomu Utsumi | a6c3315 | 2022-11-02 18:21:55 +0900 | [diff] [blame] | 714 | # HACK: Need to support build_cofig_gen flexibly instead of hardcoding |
| 715 | # build_config_gen generates srcjar by executing gcc via gcc_preprocess.py but gcc is not |
| 716 | # available in genrule sandbox. Also gcc path is not configurable. |
| 717 | # Under the //net:net, gcc_preprocess.py is only used for build_config_gen. |
| 718 | # So, for now, hardcoding BuildConfig.java and generates srcjar by soong_zip. |
| 719 | def override_build_config_gen(module): |
| 720 | module.tool_files.clear() |
| 721 | module.tools.add("soong_zip") |
| 722 | cmd = [ |
| 723 | "echo", |
| 724 | "\\\"package org.chromium.build;\\n", |
| 725 | "public class BuildConfig {\\n", |
| 726 | "public static boolean IS_MULTIDEX_ENABLED ;\\n", |
| 727 | "public static boolean ENABLE_ASSERTS = true;\\n", |
| 728 | "public static boolean IS_UBSAN ;\\n", |
| 729 | "public static boolean IS_CHROME_BRANDED ;\\n", |
| 730 | "public static int R_STRING_PRODUCT_VERSION ;\\n", |
| 731 | "public static int MIN_SDK_VERSION = 1;\\n", |
| 732 | "public static boolean BUNDLES_SUPPORTED ;\\n", |
| 733 | "public static boolean IS_INCREMENTAL_INSTALL ;\\n", |
| 734 | "public static boolean ISOLATED_SPLITS_ENABLED ;\\n", |
| 735 | "public static boolean IS_FOR_TEST ;\\n", |
| 736 | "}\\n\\\"", |
| 737 | "> $(genDir)/BuildConfig.java &&", |
| 738 | "$(location soong_zip) -o $(out) -srcjar -f $(genDir)/BuildConfig.java" |
| 739 | ] |
| 740 | NEWLINE = ' " +\n "' |
| 741 | module.cmd = NEWLINE.join(cmd) |
| 742 | return module |
| 743 | |
Mohannad Farrag | bab6c89 | 2022-11-02 14:09:46 +0000 | [diff] [blame] | 744 | def create_action_foreach_modules(blueprint, target): |
| 745 | """ The following assumes that rebase_path exists in the args. |
| 746 | The args of an action_foreach contains hints about which output files are generated |
| 747 | by which source files. |
| 748 | This is copied directly from the args |
| 749 | "gen/net/base/registry_controlled_domains/{{source_name_part}}-reversed-inc.cc" |
| 750 | So each source file will generate an output whose name is the {source_name-reversed-inc.cc} |
| 751 | """ |
| 752 | new_args = [] |
Motomu Utsumi | 56afcac | 2022-11-04 12:58:30 +0900 | [diff] [blame] | 753 | for i, src in enumerate(sorted(target.sources)): |
Mohannad Farrag | bab6c89 | 2022-11-02 14:09:46 +0000 | [diff] [blame] | 754 | # don't add script arg for the first source -- create_action_module |
| 755 | # already does this. |
| 756 | if i != 0: |
| 757 | new_args.append('&& python3 $(location %s)' % |
| 758 | gn_utils.label_to_path(target.script)) |
| 759 | for arg in target.args: |
| 760 | if '{{source}}' in arg: |
| 761 | new_args.append('$(location %s)' % (gn_utils.label_to_path(src))) |
| 762 | elif '{{source_name_part}}' in arg: |
| 763 | source_name_part = src.split("/")[-1] # Get the file name only |
| 764 | source_name_part = source_name_part.split(".")[0] # Remove the extension (Ex: .cc) |
| 765 | file_name = arg.replace('{{source_name_part}}', source_name_part).split("/")[-1] |
| 766 | # file_name represent the output file name. But we need the whole path |
| 767 | # This can be found from target.outputs. |
| 768 | for out in target.outputs: |
| 769 | if out.endswith(file_name): |
| 770 | new_args.append('$(location %s)' % out) |
| 771 | else: |
| 772 | new_args.append(arg) |
| 773 | |
| 774 | target.args = new_args |
| 775 | return create_action_module(blueprint, target) |
Motomu Utsumi | a6c3315 | 2022-11-02 18:21:55 +0900 | [diff] [blame] | 776 | |
Patrick Rohr | 7be9903 | 2022-10-31 11:54:19 -0700 | [diff] [blame] | 777 | def create_action_module(blueprint, target): |
| 778 | bp_module_name = label_to_module_name(target.name) |
| 779 | module = Module('genrule', bp_module_name, target.name) |
| 780 | |
Patrick Rohr | 9b99a98 | 2022-10-28 11:00:57 -0700 | [diff] [blame] | 781 | # Convert ['--param=value'] to ['--param', 'value'] for consistency. |
| 782 | # TODO: we may want to only do this for python scripts arguments. If argparse |
| 783 | # is used, this transformation is safe. |
| 784 | target.args = [str for it in target.args for str in it.split('=')] |
| 785 | |
Motomu Utsumi | bf569d4 | 2022-10-28 16:47:34 +0900 | [diff] [blame] | 786 | if target.script == "//build/write_buildflag_header.py": |
| 787 | # write_buildflag_header.py writes result to args.genDir/args.output |
| 788 | # So, override args.genDir by '.' so that args.output=$(out) works |
Patrick Rohr | de568a2 | 2022-10-28 09:22:35 -0700 | [diff] [blame] | 789 | for i, val in enumerate(target.args): |
| 790 | if val == '--gen-dir': |
| 791 | target.args[i + 1] = '.' |
Patrick Rohr | fa97240 | 2022-11-01 11:54:35 -0700 | [diff] [blame] | 792 | elif val == '--output': |
| 793 | target.args[i + 1] = '$(out)' |
| 794 | |
| 795 | elif target.script == '//build/write_build_date_header.py': |
| 796 | target.args[0] = '$(out)' |
Patrick Rohr | 0db9f85 | 2022-10-27 13:49:57 -0700 | [diff] [blame] | 797 | |
Patrick Rohr | 8acccca | 2022-10-28 10:39:06 -0700 | [diff] [blame] | 798 | elif target.script == '//base/android/jni_generator/jni_generator.py': |
Patrick Rohr | c5cc21a | 2022-10-31 11:57:49 -0700 | [diff] [blame] | 799 | # chromium builds against a prebuilt ndk that contains the jni_headers, so |
| 800 | # a dependency is never explicitly created. |
| 801 | module.genrule_header_libs.add('jni_headers') |
Patrick Rohr | 131ba28 | 2022-10-31 16:36:20 -0700 | [diff] [blame] | 802 | needs_javap = False |
Patrick Rohr | 8acccca | 2022-10-28 10:39:06 -0700 | [diff] [blame] | 803 | for i, val in enumerate(target.args): |
Motomu Utsumi | 6f9139d | 2022-10-31 12:15:19 +0900 | [diff] [blame] | 804 | if val == '--output_dir': |
Patrick Rohr | f1d08f8 | 2022-10-31 14:43:59 -0700 | [diff] [blame] | 805 | # replace --output_dir gen/jni_headers/... with --output_dir $(genDir)/... |
| 806 | target.args[i + 1] = re.sub('^gen/jni_headers', '$(genDir)', target.args[i + 1]) |
Patrick Rohr | bec0c8c | 2022-11-01 11:56:38 -0700 | [diff] [blame] | 807 | elif val == '--input_file': |
Patrick Rohr | 8acccca | 2022-10-28 10:39:06 -0700 | [diff] [blame] | 808 | # --input_file supports both .class specifiers or source files as arguments. |
| 809 | # Only source files need to be wrapped inside a $(location <label>) tag. |
| 810 | if re.match('.*\.class$', target.args[i + 1]): |
| 811 | continue |
| 812 | # replace --input_file ../../... with --input_file $(location ...) |
| 813 | # TODO: put inside function |
| 814 | filename = re.sub('^\.\./\.\./', '', target.args[i + 1]) |
| 815 | target.args[i + 1] = '$(location %s)' % filename |
Patrick Rohr | bec0c8c | 2022-11-01 11:56:38 -0700 | [diff] [blame] | 816 | elif val == '--includes' and 'jni_generator_helper' in target.args[i + 1]: |
Patrick Rohr | d89e8bf | 2022-10-31 14:51:05 -0700 | [diff] [blame] | 817 | # delete all leading ../ |
| 818 | target.args[i + 1] = re.sub('^(\.\./)+', '', target.args[i + 1]) |
Patrick Rohr | bec0c8c | 2022-11-01 11:56:38 -0700 | [diff] [blame] | 819 | elif val == '--prev_output_dir': |
Patrick Rohr | 131ba28 | 2022-10-31 16:36:20 -0700 | [diff] [blame] | 820 | # this is not needed for aosp builds. |
| 821 | target.args[i] = '' |
| 822 | target.args[i + 1] = '' |
Patrick Rohr | bec0c8c | 2022-11-01 11:56:38 -0700 | [diff] [blame] | 823 | elif val == '--jar_file': |
Patrick Rohr | 131ba28 | 2022-10-31 16:36:20 -0700 | [diff] [blame] | 824 | # delete leading ../../ and add path to javap |
| 825 | filename = re.sub('^\.\./\.\./', '', target.args[i + 1]) |
| 826 | target.args[i + 1] = '$(location %s)' % filename |
| 827 | needs_javap = True |
| 828 | |
| 829 | if needs_javap: |
| 830 | target.args.append('--javap') |
| 831 | target.args.append('$$(find out/.path -name javap)') |
Patrick Rohr | f1d08f8 | 2022-10-31 14:43:59 -0700 | [diff] [blame] | 832 | # fix target.output directory to match #include statements. |
| 833 | target.outputs = [re.sub('^jni_headers/', '', out) for out in target.outputs] |
Patrick Rohr | 8acccca | 2022-10-28 10:39:06 -0700 | [diff] [blame] | 834 | |
Patrick Rohr | f6d2b61 | 2022-11-09 12:30:26 -0800 | [diff] [blame] | 835 | elif target.script == '//base/android/jni_generator/jni_registration_generator.py': |
| 836 | # jni_registration_generator.py pulls in some config dependencies that we |
| 837 | # do not handle. Remove them. |
| 838 | # TODO: find a better way to do this. |
| 839 | target.deps.clear() |
| 840 | |
Motomu Utsumi | ed00908 | 2022-11-10 16:26:44 +0900 | [diff] [blame] | 841 | target.inputs = [file for file in target.inputs if not file.startswith('//out/')] |
Motomu Utsumi | 6b4acaa | 2022-11-10 16:13:24 +0900 | [diff] [blame] | 842 | for i, val in enumerate(target.args): |
| 843 | if val in ['--depfile', '--srcjar-path', '--header-path']: |
| 844 | target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1]) |
Motomu Utsumi | 7bc2fcc | 2022-11-10 17:09:54 +0900 | [diff] [blame] | 845 | if val == '--sources-files': |
| 846 | target.args[i + 1] = '$(genDir)/java.sources' |
Motomu Utsumi | 47d122f | 2022-11-10 17:32:23 +0900 | [diff] [blame] | 847 | elif val == '--sources-exclusions': |
| 848 | # update_jni_registration_module removes them from the srcs of the module |
| 849 | # It might be better to remove sources by '--sources-exclusions' |
| 850 | target.args[i] = '' |
| 851 | target.args[i + 1] = '' |
Motomu Utsumi | 6b4acaa | 2022-11-10 16:13:24 +0900 | [diff] [blame] | 852 | |
Patrick Rohr | 245df58 | 2022-11-01 16:59:45 -0700 | [diff] [blame] | 853 | elif target.script == '//build/android/gyp/write_build_config.py': |
| 854 | for i, val in enumerate(target.args): |
| 855 | if val == '--depfile': |
| 856 | # Depfile is not used, so no need to generate it. |
| 857 | target.args[i] = '' |
| 858 | target.args[i + 1] = '' |
| 859 | elif val in ['--deps-configs', '--bundled-srcjars']: |
| 860 | args = target.args[i + 1] |
| 861 | if args == '[]': |
| 862 | continue |
| 863 | # strip surrounding [] and split by ", " |
| 864 | args = args.strip('[]').split(', ') |
| 865 | # strip surrounding "" |
| 866 | args = [arg.strip('"') for arg in args] |
| 867 | # remove leading gen/ |
| 868 | args = [re.sub('^gen/', '', arg) for arg in args] |
| 869 | # wrap filename in \"$(location filename)\" |
| 870 | args = ['\"$(location %s)\"' % arg for arg in args] |
| 871 | # join args with ", " and wrap in [] |
| 872 | target.args[i + 1] = '[%s]' % ', '.join(args) |
| 873 | |
| 874 | elif val == '--public-deps-configs': |
| 875 | # TODO: implement. |
| 876 | pass |
| 877 | |
| 878 | elif val == '--build-config': |
| 879 | # json output of this script |
| 880 | target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1]) |
| 881 | |
| 882 | elif val in ['--unprocessed-jar-path', '--interface-jar-path', |
| 883 | '--device-jar-path', '--host-jar-path']: |
| 884 | # jar path can be within sources (../../) or output generated by |
| 885 | # another genrule (obj/) |
| 886 | filename = re.sub('^\.\./\.\./', '', target.args[i + 1]) |
| 887 | filename = re.sub('^obj/', '', target.args[i + 1]) |
| 888 | target.args[i + 1] = '$(location %s)' % filename |
| 889 | |
| 890 | elif val == '--proguard-configs': |
| 891 | args = target.args[i + 1] |
| 892 | if args == '[]': |
| 893 | continue |
| 894 | # TODO: consider adding helpers to deal with argument lists |
| 895 | # strip surrounding [] and split by ", ", then strip surrounding "" |
| 896 | args = args.strip('[]').split(', ') |
| 897 | args = [arg.strip('"') for arg in args] |
| 898 | # remove leading ../../ |
| 899 | args = [re.sub('^\.\./\.\./', '', arg) for arg in args] |
| 900 | # add dependency on proguard config file, so a $(location) wrapper can be used. |
| 901 | module.tool_files.update(args) |
| 902 | # wrap filename in \"$(location filename)\" |
| 903 | args = ['$(location %s)' % arg for arg in args] |
| 904 | target.args[i + 1] = '[%s]' % ', '.join(args) |
Motomu Utsumi | 1caa39b | 2022-11-02 18:38:13 +0900 | [diff] [blame] | 905 | elif target.script == "//build/android/gyp/write_native_libraries_java.py": |
| 906 | for i, val in enumerate(target.args): |
| 907 | if val == '--output': |
| 908 | target.args[i + 1] = '$(out)' |
Motomu Utsumi | 26211dc | 2022-11-02 19:38:47 +0900 | [diff] [blame] | 909 | elif target.script == "//tools/grit/stamp_grit_sources.py": |
| 910 | target.outputs = [re.sub('^\/\/', '', out) for out in target.outputs] |
| 911 | # Directory that contains grit scripts |
| 912 | target.args[0] = '`dirname $(location tools/grit/grit.py)`' |
| 913 | # Path to the stamp file |
| 914 | target.args[1] = '$(out)' |
| 915 | # Script tries to create args[2] file but this is not in the output. |
| 916 | # Specifying file under $(genDir) so that parent directory exists. |
| 917 | # If this file is used by other module, we may need to add this file to the outputs. |
| 918 | target.args[2] = '$(genDir)/' + target.args[2].split('/')[-1] |
Mohannad Farrag | 033c9d6 | 2022-11-07 14:55:49 +0000 | [diff] [blame] | 919 | elif target.script == "//tools/grit/grit.py": |
| 920 | for i, val in enumerate(target.args): |
| 921 | if val == '-i': |
| 922 | # Delete leading ../.. |
| 923 | filename = re.sub('^\.\./\.\./', '', target.args[i + 1]) |
| 924 | target.args[i + 1] = '$(location %s)' % filename |
| 925 | elif val == '-o': |
| 926 | filename = re.sub('^gen/', '', target.args[i + 1]) |
| 927 | if filename == "net": |
| 928 | # This is a directory not a file |
| 929 | target.args[i + 1] = '$(genDir)/net' |
| 930 | else: |
| 931 | # This is an output fil |
| 932 | target.args[i + 1] = '$(location %s)' % filename |
| 933 | elif val == '--depfile': |
| 934 | # The depfile is replaced by adding /tools/**/*.py to the tools_files |
| 935 | # This is basically just globbing all the needed sources by hardcoding. |
| 936 | module.tool_files.update([ |
| 937 | "tools/grit/**/*.py", |
| 938 | "third_party/six/src/six.py" # This is not picked up by default. Must be added |
| 939 | ]) |
| 940 | |
| 941 | # Delete the depfile argument |
| 942 | target.args[i] = ' ' |
| 943 | target.args[i + 1] = ' ' |
| 944 | elif val == '--input': |
| 945 | # Delete leading ../.. |
| 946 | filename = re.sub('^\.\./\.\./', '', target.args[i + 1]) |
| 947 | # This is an output file so use $(location %s) |
| 948 | target.args[i + 1] = '$(location %s)' % filename |
Motomu Utsumi | a0cc666 | 2022-11-09 15:22:27 +0900 | [diff] [blame] | 949 | elif target.script == "//net/tools/dafsa/make_dafsa.py": |
| 950 | # This script generates .cc files but source (registry_controlled_domain.cc) in the target that |
| 951 | # depends on this target includes .cc file this script generates. |
| 952 | module.genrule_headers.add(module.name) |
Motomu Utsumi | 847a6d3 | 2022-11-09 17:32:06 +0900 | [diff] [blame] | 953 | elif target.script == "//build/util/version.py": |
Motomu Utsumi | b0a49e4 | 2022-11-09 18:12:27 +0900 | [diff] [blame] | 954 | # android_chrome_version.py is not specified in anywhere but version.py imports this file |
| 955 | module.tool_files.add('build/util/android_chrome_version.py') |
Motomu Utsumi | 847a6d3 | 2022-11-09 17:32:06 +0900 | [diff] [blame] | 956 | for i, val in enumerate(target.args): |
| 957 | if val.startswith('../../'): |
| 958 | filename = re.sub('^\.\./\.\./', '', val) |
| 959 | target.args[i] = '$(location %s)' % filename |
Motomu Utsumi | ee279c5 | 2022-11-09 17:46:27 +0900 | [diff] [blame] | 960 | elif val == '-e': |
| 961 | # arg for -e EVAL option should be passed in -e PATCH_HI=int(PATCH)//256 format. |
| 962 | target.args[i + 1] = '%s=\'%s\'' % (target.args[i + 1], target.args[i + 2]) |
| 963 | target.args[i + 2] = '' |
Motomu Utsumi | 438f2c2 | 2022-11-09 18:16:40 +0900 | [diff] [blame] | 964 | elif val == '-o': |
| 965 | target.args[i + 1] = '$(out)' |
Patrick Rohr | 245df58 | 2022-11-01 16:59:45 -0700 | [diff] [blame] | 966 | |
Patrick Rohr | 2041d5b | 2022-10-26 15:07:53 -0700 | [diff] [blame] | 967 | script = gn_utils.label_to_path(target.script) |
Patrick Rohr | 3d8c728 | 2022-10-27 13:36:31 -0700 | [diff] [blame] | 968 | module.tool_files.add(script) |
Patrick Rohr | e1a853e | 2022-10-26 12:31:39 -0700 | [diff] [blame] | 969 | |
Patrick Rohr | 8a4e2bd | 2022-10-27 13:06:16 -0700 | [diff] [blame] | 970 | # Handle passing parameters via response file by piping them into the script |
| 971 | # and reading them from /dev/stdin. |
| 972 | response_file = '{{response_file_name}}' |
| 973 | use_response_file = response_file in target.args |
| 974 | if use_response_file: |
| 975 | # Replace {{response_file_contents}} with /dev/stdin |
| 976 | target.args = ['/dev/stdin' if it == response_file else it for it in target.args] |
| 977 | |
Patrick Rohr | 4b0952d | 2022-11-01 12:42:31 -0700 | [diff] [blame] | 978 | # escape " and \$ in target.args. |
| 979 | # once all actions are properly implemented, this may not be necessary anymore. |
| 980 | # TODO: is this the right place to do this? |
| 981 | target.args = [arg.replace('"', r'\"') for arg in target.args] |
| 982 | target.args = [arg.replace(r'\$', r'\\$') for arg in target.args] |
| 983 | |
Patrick Rohr | 9b99a98 | 2022-10-28 11:00:57 -0700 | [diff] [blame] | 984 | # put all args on a new line for better diffs. |
| 985 | NEWLINE = ' " +\n "' |
| 986 | arg_string = NEWLINE.join(target.args) |
Patrick Rohr | 2041d5b | 2022-10-26 15:07:53 -0700 | [diff] [blame] | 987 | module.cmd = '$(location %s) %s' % (script, arg_string) |
Patrick Rohr | e1a853e | 2022-10-26 12:31:39 -0700 | [diff] [blame] | 988 | |
Patrick Rohr | 8a4e2bd | 2022-10-27 13:06:16 -0700 | [diff] [blame] | 989 | if use_response_file: |
| 990 | # Pipe response file contents into script |
Patrick Rohr | 9b99a98 | 2022-10-28 11:00:57 -0700 | [diff] [blame] | 991 | module.cmd = 'echo \'%s\' |%s%s' % (target.response_file_contents, NEWLINE, module.cmd) |
Patrick Rohr | 8a4e2bd | 2022-10-27 13:06:16 -0700 | [diff] [blame] | 992 | |
Motomu Utsumi | 7e98383 | 2022-11-10 16:04:46 +0900 | [diff] [blame] | 993 | if any(os.path.splitext(it)[1] == '.h' for it in target.outputs): |
Patrick Rohr | 67f4d43 | 2022-10-26 16:04:15 -0700 | [diff] [blame] | 994 | module.genrule_headers.add(bp_module_name) |
Patrick Rohr | e1a853e | 2022-10-26 12:31:39 -0700 | [diff] [blame] | 995 | |
Patrick Rohr | 0db9f85 | 2022-10-27 13:49:57 -0700 | [diff] [blame] | 996 | # gn treats inputs and sources for actions equally. |
| 997 | # soong only supports source files inside srcs, non-source files are added as |
| 998 | # tool_files dependency. |
| 999 | for it in target.sources or target.inputs: |
| 1000 | if is_supported_source_file(it): |
| 1001 | module.srcs.add(gn_utils.label_to_path(it)) |
| 1002 | else: |
| 1003 | module.tool_files.add(gn_utils.label_to_path(it)) |
Patrick Rohr | e1a853e | 2022-10-26 12:31:39 -0700 | [diff] [blame] | 1004 | |
Patrick Rohr | 15a2c30 | 2022-10-26 15:08:57 -0700 | [diff] [blame] | 1005 | # Actions using template "action_with_pydeps" also put script inside inputs. |
| 1006 | # TODO: it might make sense to filter inputs inside GnParser. |
| 1007 | if script in module.srcs: |
| 1008 | module.srcs.remove(script) |
| 1009 | |
Patrick Rohr | e1a853e | 2022-10-26 12:31:39 -0700 | [diff] [blame] | 1010 | module.out.update(target.outputs) |
Motomu Utsumi | a6c3315 | 2022-11-02 18:21:55 +0900 | [diff] [blame] | 1011 | |
| 1012 | if target.name == "//build/android:build_config_gen": |
| 1013 | module = override_build_config_gen(module) |
Motomu Utsumi | 26211dc | 2022-11-02 19:38:47 +0900 | [diff] [blame] | 1014 | elif target.script == "//tools/grit/stamp_grit_sources.py": |
| 1015 | # stamp_grit_sources.py is not executable |
| 1016 | module.cmd = "python " + module.cmd |
Mohannad Farrag | 18d7b51 | 2022-11-07 13:26:30 +0000 | [diff] [blame] | 1017 | elif target.script == "//base/android/jni_generator/jni_generator.py": |
| 1018 | # android_jar.classes should be part of the tools as it list implicit classes |
| 1019 | # for the script to generate JNI headers. |
| 1020 | module.tool_files.add("base/android/jni_generator/android_jar.classes") |
Motomu Utsumi | 7bc2fcc | 2022-11-10 17:09:54 +0900 | [diff] [blame] | 1021 | elif target.script == '//base/android/jni_generator/jni_registration_generator.py': |
Motomu Utsumi | 9ca466b | 2022-11-10 17:12:29 +0900 | [diff] [blame] | 1022 | # jni_registration_generator.py doesn't work with python2 |
| 1023 | module.cmd = "python3 " + module.cmd |
Motomu Utsumi | 7bc2fcc | 2022-11-10 17:09:54 +0900 | [diff] [blame] | 1024 | # Path in the original sources file does not work in genrule. |
| 1025 | # So creating sources file in cmd based on the srcs of this target. |
| 1026 | # Adding ../$(current_dir)/ to the head because jni_registration_generator.py uses the files |
| 1027 | # whose path startswith(..) |
| 1028 | commands = ["current_dir=`basename \\\`pwd\\\``;", |
| 1029 | "for f in $(in);", |
| 1030 | "do", |
| 1031 | "echo \\\"../$$current_dir/$$f\\\" >> $(genDir)/java.sources;", |
| 1032 | "done;", |
| 1033 | module.cmd] |
Motomu Utsumi | 2a892d2 | 2022-11-10 18:03:20 +0900 | [diff] [blame] | 1034 | |
| 1035 | # .h file jni_registration_generator.py generates has #define with directory name. |
| 1036 | # With the genrule env that contains "." which is invalid. So replace that at the end of cmd. |
Mohannad Farrag | 7c0f098 | 2022-11-10 14:39:49 +0000 | [diff] [blame] | 1037 | commands.append(";sed -i -e 's/OUT_SOONG_.TEMP_SBOX_.*_OUT/GEN/g' ") |
Motomu Utsumi | 2a892d2 | 2022-11-10 18:03:20 +0900 | [diff] [blame] | 1038 | commands.append("$(genDir)/components/cronet/android/cronet_jni_registration.h") |
Motomu Utsumi | 7bc2fcc | 2022-11-10 17:09:54 +0900 | [diff] [blame] | 1039 | module.cmd = NEWLINE.join(commands) |
Motomu Utsumi | a6c3315 | 2022-11-02 18:21:55 +0900 | [diff] [blame] | 1040 | |
Patrick Rohr | e1a853e | 2022-10-26 12:31:39 -0700 | [diff] [blame] | 1041 | blueprint.add_module(module) |
| 1042 | return module |
| 1043 | |
| 1044 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1045 | |
| 1046 | def _get_cflags(target): |
| 1047 | cflags = {flag for flag in target.cflags if re.match(cflag_allowlist, flag)} |
Motomu Utsumi | fa7e926 | 2022-10-26 19:43:02 +0900 | [diff] [blame] | 1048 | # Consider proper allowlist or denylist if needed |
| 1049 | cflags |= set("-D%s" % define.replace("\"", "\\\"") for define in target.defines) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1050 | return cflags |
| 1051 | |
| 1052 | |
| 1053 | def create_modules_from_target(blueprint, gn, gn_target_name): |
| 1054 | """Generate module(s) for a given GN target. |
| 1055 | |
| 1056 | Given a GN target name, generate one or more corresponding modules into a |
| 1057 | blueprint. The only case when this generates >1 module is proto libraries. |
| 1058 | |
| 1059 | Args: |
| 1060 | blueprint: Blueprint instance which is being generated. |
| 1061 | gn: gn_utils.GnParser object. |
| 1062 | gn_target_name: GN target for module generation. |
| 1063 | """ |
| 1064 | bp_module_name = label_to_module_name(gn_target_name) |
| 1065 | if bp_module_name in blueprint.modules: |
| 1066 | return blueprint.modules[bp_module_name] |
| 1067 | target = gn.get_target(gn_target_name) |
Patrick Rohr | 1622894 | 2022-10-26 14:00:26 -0700 | [diff] [blame] | 1068 | log.info('create modules for %s (%s)', target.name, target.type) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1069 | |
| 1070 | name_without_toolchain = gn_utils.label_without_toolchain(target.name) |
| 1071 | if target.type == 'executable': |
| 1072 | if target.toolchain == gn_utils.HOST_TOOLCHAIN: |
| 1073 | module_type = 'cc_binary_host' |
| 1074 | elif target.testonly: |
| 1075 | module_type = 'cc_test' |
| 1076 | else: |
| 1077 | module_type = 'cc_binary' |
| 1078 | module = Module(module_type, bp_module_name, gn_target_name) |
| 1079 | elif target.type == 'static_library': |
| 1080 | module = Module('cc_library_static', bp_module_name, gn_target_name) |
| 1081 | elif target.type == 'shared_library': |
| 1082 | module = Module('cc_library_shared', bp_module_name, gn_target_name) |
| 1083 | elif target.type == 'source_set': |
| 1084 | module = Module('filegroup', bp_module_name, gn_target_name) |
| 1085 | elif target.type == 'group': |
| 1086 | # "group" targets are resolved recursively by gn_utils.get_target(). |
| 1087 | # There's nothing we need to do at this level for them. |
| 1088 | return None |
| 1089 | elif target.type == 'proto_library': |
| 1090 | module = create_proto_modules(blueprint, gn, target) |
| 1091 | if module is None: |
| 1092 | return None |
| 1093 | elif target.type == 'action': |
| 1094 | if 'gen_amalgamated_sql_metrics' in target.name: |
| 1095 | module = create_amalgamated_sql_metrics_module(blueprint, target) |
| 1096 | elif re.match('.*gen_cc_.*_descriptor$', name_without_toolchain): |
| 1097 | module = create_cc_proto_descriptor_module(blueprint, target) |
| 1098 | elif target.type == 'action' and \ |
| 1099 | name_without_toolchain == gn_utils.GEN_VERSION_TARGET: |
| 1100 | module = create_gen_version_module(blueprint, target, bp_module_name) |
| 1101 | else: |
Patrick Rohr | e1a853e | 2022-10-26 12:31:39 -0700 | [diff] [blame] | 1102 | module = create_action_module(blueprint, target) |
Mohannad Farrag | f076f3e | 2022-10-31 17:45:28 +0000 | [diff] [blame] | 1103 | elif target.type == 'action_foreach': |
Mohannad Farrag | bab6c89 | 2022-11-02 14:09:46 +0000 | [diff] [blame] | 1104 | module = create_action_foreach_modules(blueprint, target) |
Patrick Rohr | 59a7665 | 2022-10-26 12:36:56 -0700 | [diff] [blame] | 1105 | elif target.type == 'copy': |
| 1106 | # TODO: careful now! copy targets are not supported yet, but this will stop |
| 1107 | # traversing the dependency tree. For //base:base, this is not a big |
| 1108 | # problem as libicu contains the only copy target which happens to be a |
| 1109 | # leaf node. |
| 1110 | return None |
Patrick Rohr | ad44060 | 2022-11-10 22:09:04 -0800 | [diff] [blame] | 1111 | elif target.type == 'java_group': |
| 1112 | # Java targets are handled outside of create_modules_from_target. |
| 1113 | return None |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1114 | else: |
| 1115 | raise Error('Unknown target %s (%s)' % (target.name, target.type)) |
| 1116 | |
| 1117 | blueprint.add_module(module) |
| 1118 | module.host_supported = (name_without_toolchain in target_host_supported) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1119 | module.init_rc = target_initrc.get(target.name, []) |
| 1120 | module.srcs.update( |
| 1121 | gn_utils.label_to_path(src) |
| 1122 | for src in target.sources |
Motomu Utsumi | f951e50 | 2022-11-07 19:31:15 +0900 | [diff] [blame] | 1123 | if is_supported_source_file(src) and not src.startswith("//out/test")) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1124 | |
Motomu Utsumi | 97fb181 | 2022-11-01 13:08:10 +0900 | [diff] [blame] | 1125 | local_include_dirs_set = set() |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1126 | if target.type in gn_utils.LINKER_UNIT_TYPES: |
| 1127 | module.cflags.update(_get_cflags(target)) |
Patrick Rohr | f22e9d0 | 2022-10-28 14:20:46 -0700 | [diff] [blame] | 1128 | # TODO: implement proper cflag parsing. |
| 1129 | for flag in target.cflags: |
Patrick Rohr | b8f830a | 2022-10-31 11:18:57 -0700 | [diff] [blame] | 1130 | if '-std=' in flag: |
| 1131 | module.cpp_std = flag[len('-std='):] |
Patrick Rohr | 61f2acb | 2022-10-31 14:08:18 -0700 | [diff] [blame] | 1132 | if '-isystem' in flag: |
Motomu Utsumi | 97fb181 | 2022-11-01 13:08:10 +0900 | [diff] [blame] | 1133 | local_include_dirs_set.add(flag[len('-isystem../../'):]) |
Patrick Rohr | 5fae90f | 2022-11-11 08:22:52 -0800 | [diff] [blame] | 1134 | if '-frtti' in flag: |
| 1135 | module.rtti = True |
Patrick Rohr | 0948d1c | 2022-11-11 11:02:16 -0800 | [diff] [blame^] | 1136 | if '-fexceptions' in flag: |
| 1137 | module.cppflags.add('-fexceptions') |
| 1138 | |
Patrick Rohr | b8f830a | 2022-10-31 11:18:57 -0700 | [diff] [blame] | 1139 | |
Patrick Rohr | d0abc2a | 2022-10-31 13:29:16 -0700 | [diff] [blame] | 1140 | # Adding local_include_dirs is necessary due to source_sets / filegroups |
| 1141 | # which do not properly propagate include directories. |
| 1142 | # Filter any directory inside //out as a) this directory does not exist for |
| 1143 | # aosp / soong builds and b) the include directory should already be |
| 1144 | # configured via library dependency. |
Motomu Utsumi | 97fb181 | 2022-11-01 13:08:10 +0900 | [diff] [blame] | 1145 | local_include_dirs_set.update([gn_utils.label_to_path(d) |
Patrick Rohr | d0abc2a | 2022-10-31 13:29:16 -0700 | [diff] [blame] | 1146 | for d in target.include_dirs |
| 1147 | if not re.match('^//out/.*', d)]) |
Motomu Utsumi | 97fb181 | 2022-11-01 13:08:10 +0900 | [diff] [blame] | 1148 | module.local_include_dirs = sorted(list(local_include_dirs_set)) |
| 1149 | |
| 1150 | # Order matters for some targets. For example, base/time/time_exploded_icu.cc |
| 1151 | # in //base:base needs to have sysroot include after icu/source/common |
| 1152 | # include. So adding sysroot include at the end. |
| 1153 | for flag in target.cflags: |
| 1154 | if '--sysroot' in flag: |
| 1155 | module.local_include_dirs.append(flag[len('--sysroot=../../'):] + "/usr/include") |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1156 | |
| 1157 | module_is_compiled = module.type not in ('genrule', 'filegroup') |
| 1158 | if module_is_compiled: |
| 1159 | # Don't try to inject library/source dependencies into genrules or |
| 1160 | # filegroups because they are not compiled in the traditional sense. |
| 1161 | module.defaults = [defaults_module] |
| 1162 | for lib in target.libs: |
| 1163 | # Generally library names should be mangled as 'libXXX', unless they |
| 1164 | # are HAL libraries (e.g., android.hardware.health@2.0) or AIDL c++ / NDK |
| 1165 | # libraries (e.g. "android.hardware.power.stats-V1-cpp") |
| 1166 | android_lib = lib if '@' in lib or "-cpp" in lib or "-ndk" in lib \ |
| 1167 | else 'lib' + lib |
| 1168 | if lib in shared_library_allowlist: |
| 1169 | module.add_android_shared_lib(android_lib) |
| 1170 | if lib in static_library_allowlist: |
| 1171 | module.add_android_static_lib(android_lib) |
| 1172 | |
Patrick Rohr | d9dd3b9 | 2022-11-09 16:15:30 -0800 | [diff] [blame] | 1173 | # Remove prohibited include directories |
| 1174 | module.local_include_dirs = [d for d in module.local_include_dirs |
| 1175 | if d not in local_include_dirs_denylist] |
| 1176 | |
| 1177 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1178 | # If the module is a static library, export all the generated headers. |
| 1179 | if module.type == 'cc_library_static': |
| 1180 | module.export_generated_headers = module.generated_headers |
| 1181 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1182 | # 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] | 1183 | # Currently, only one module is generated from target even target has multiple toolchains. |
| 1184 | # And module is generated based on the first visited target. |
| 1185 | # Sort deps before iteration to make result deterministic. |
| 1186 | 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] | 1187 | for dep_name in all_deps: |
Patrick Rohr | 5cc46e0 | 2022-10-26 14:32:45 -0700 | [diff] [blame] | 1188 | # |builtin_deps| override GN deps with Android-specific ones. See the |
| 1189 | # config in the top of this file. |
| 1190 | if gn_utils.label_without_toolchain(dep_name) in builtin_deps: |
| 1191 | builtin_deps[gn_utils.label_without_toolchain(dep_name)](module) |
| 1192 | continue |
| 1193 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1194 | dep_module = create_modules_from_target(blueprint, gn, dep_name) |
| 1195 | |
Motomu Utsumi | e246feb | 2022-11-01 17:25:56 +0900 | [diff] [blame] | 1196 | # TODO: Proper dependency check for genrule. |
| 1197 | # Currently, only propagating genrule dependencies. |
| 1198 | # Also, currently, all the dependencies are propagated upwards. |
| 1199 | # in gn, public_deps should be propagated but deps should not. |
| 1200 | # Not sure this information is available in the desc.json. |
| 1201 | # Following rule works for adding android_runtime_jni_headers to base:base. |
| 1202 | # If this doesn't work for other target, hardcoding for specific target |
| 1203 | # might be better. |
| 1204 | if module.type == "genrule" and dep_module.type == "genrule": |
| 1205 | module.genrule_headers.add(dep_module.name) |
| 1206 | module.genrule_headers.update(dep_module.genrule_headers) |
| 1207 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1208 | # For filegroups and genrule, recurse but don't apply the deps. |
| 1209 | if not module_is_compiled: |
| 1210 | continue |
| 1211 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1212 | if dep_module is None: |
| 1213 | continue |
| 1214 | if dep_module.type == 'cc_library_shared': |
| 1215 | module.shared_libs.add(dep_module.name) |
| 1216 | elif dep_module.type == 'cc_library_static': |
| 1217 | module.static_libs.add(dep_module.name) |
| 1218 | elif dep_module.type == 'filegroup': |
| 1219 | module.srcs.add(':' + dep_module.name) |
| 1220 | elif dep_module.type == 'genrule': |
| 1221 | module.generated_headers.update(dep_module.genrule_headers) |
| 1222 | module.srcs.update(dep_module.genrule_srcs) |
| 1223 | module.shared_libs.update(dep_module.genrule_shared_libs) |
Patrick Rohr | a1a2787 | 2022-10-31 11:57:14 -0700 | [diff] [blame] | 1224 | module.header_libs.update(dep_module.genrule_header_libs) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1225 | elif dep_module.type == 'cc_binary': |
| 1226 | continue # Ignore executables deps (used by cmdline integration tests). |
| 1227 | else: |
| 1228 | raise Error('Unknown dep %s (%s) for target %s' % |
| 1229 | (dep_module.name, dep_module.type, module.name)) |
| 1230 | |
| 1231 | return module |
| 1232 | |
Patrick Rohr | b18aca2 | 2022-11-04 15:07:32 -0700 | [diff] [blame] | 1233 | def create_java_module(blueprint, gn): |
| 1234 | bp_module_name = module_prefix + 'java' |
| 1235 | module = Module('java_library', bp_module_name, '//gn:java') |
Mohannad Farrag | 21562d6 | 2022-11-07 13:09:31 +0000 | [diff] [blame] | 1236 | module.srcs.update([gn_utils.label_to_path(source) for source in gn.java_sources]) |
Patrick Rohr | b18aca2 | 2022-11-04 15:07:32 -0700 | [diff] [blame] | 1237 | blueprint.add_module(module) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1238 | |
Motomu Utsumi | e3ce770 | 2022-11-10 16:22:11 +0900 | [diff] [blame] | 1239 | def update_jni_registration_module(blueprint, gn): |
| 1240 | bp_module_name = label_to_module_name('//components/cronet/android:cronet_jni_registration') |
Patrick Rohr | 7f22542 | 2022-11-10 21:38:38 -0800 | [diff] [blame] | 1241 | if bp_module_name not in blueprint.modules: |
| 1242 | # To support building targets that might not create the cronet_jni_registration. |
| 1243 | return |
Motomu Utsumi | e3ce770 | 2022-11-10 16:22:11 +0900 | [diff] [blame] | 1244 | module = blueprint.modules[bp_module_name] |
Motomu Utsumi | 47d122f | 2022-11-10 17:32:23 +0900 | [diff] [blame] | 1245 | |
| 1246 | # TODO: deny list is in the arg of jni_registration_generator.py. Should not be hardcoded |
| 1247 | deny_list = [ |
| 1248 | '//base/android/java/src/org/chromium/base/library_loader/LibraryLoader.java', |
| 1249 | '//base/android/java/src/org/chromium/base/library_loader/LibraryPrefetcher.java', |
| 1250 | '//base/android/java/src/org/chromium/base/process_launcher/ChildProcessService.java', |
| 1251 | '//base/android/java/src/org/chromium/base/SysUtils.java'] |
| 1252 | |
Motomu Utsumi | e3ce770 | 2022-11-10 16:22:11 +0900 | [diff] [blame] | 1253 | # TODO: java_sources might not contain all the required java files |
Motomu Utsumi | 47d122f | 2022-11-10 17:32:23 +0900 | [diff] [blame] | 1254 | module.srcs.update([gn_utils.label_to_path(source) |
| 1255 | for source in gn.java_sources if source not in deny_list]) |
Motomu Utsumi | e3ce770 | 2022-11-10 16:22:11 +0900 | [diff] [blame] | 1256 | |
Motomu Utsumi | 79bd0c8 | 2022-11-10 17:52:24 +0900 | [diff] [blame] | 1257 | # TODO: Remove hardcoded file addition to srcs |
| 1258 | # jni_registration_generator.py generates empty .h file if native methods are not found in the |
| 1259 | # java files. But android:cronet depends on `RegisterNonMainDexNatives` which is in the template |
| 1260 | # of .h file. To make script generate non empty .h file, adding java file which contains native |
| 1261 | # method. Once all the required java files are added to the srcs, this can be removed. |
| 1262 | module.srcs.update([ |
| 1263 | "components/cronet/android/java/src/org/chromium/net/impl/CronetUrlRequest.java"]) |
| 1264 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1265 | def create_blueprint_for_targets(gn, desc, targets): |
| 1266 | """Generate a blueprint for a list of GN targets.""" |
| 1267 | blueprint = Blueprint() |
| 1268 | |
| 1269 | # Default settings used by all modules. |
| 1270 | defaults = Module('cc_defaults', defaults_module, '//gn:default_deps') |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1271 | defaults.cflags = [ |
| 1272 | '-Wno-error=return-type', |
Patrick Rohr | 3a1ec1d | 2022-10-31 13:30:17 -0700 | [diff] [blame] | 1273 | '-Wno-non-virtual-dtor', |
Patrick Rohr | 5c70002 | 2022-11-08 19:33:07 -0800 | [diff] [blame] | 1274 | '-Wno-macro-redefined', |
Patrick Rohr | 9806515 | 2022-10-31 14:49:58 -0700 | [diff] [blame] | 1275 | '-Wno-missing-field-initializers', |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1276 | '-Wno-sign-compare', |
| 1277 | '-Wno-sign-promo', |
| 1278 | '-Wno-unused-parameter', |
Mohannad Farrag | d98a96d | 2022-11-10 14:56:19 +0000 | [diff] [blame] | 1279 | '-Wno-deprecated-non-prototype', # needed for zlib |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1280 | '-fvisibility=hidden', |
| 1281 | '-O2', |
| 1282 | ] |
Patrick Rohr | 61f2acb | 2022-10-31 14:08:18 -0700 | [diff] [blame] | 1283 | defaults.stl = 'none' |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1284 | blueprint.add_module(defaults) |
Patrick Rohr | 344b247 | 2022-10-25 11:32:15 -0700 | [diff] [blame] | 1285 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1286 | for target in targets: |
| 1287 | create_modules_from_target(blueprint, gn, target) |
Patrick Rohr | b18aca2 | 2022-11-04 15:07:32 -0700 | [diff] [blame] | 1288 | |
| 1289 | create_java_module(blueprint, gn) |
Motomu Utsumi | e3ce770 | 2022-11-10 16:22:11 +0900 | [diff] [blame] | 1290 | update_jni_registration_module(blueprint, gn) |
Patrick Rohr | a7d029d | 2022-11-08 12:23:11 -0800 | [diff] [blame] | 1291 | |
| 1292 | # Merge in additional hardcoded arguments. |
| 1293 | for module in blueprint.modules.values(): |
| 1294 | for key, add_val in additional_args.get(module.name, []): |
| 1295 | curr = getattr(module, key) |
| 1296 | if add_val and isinstance(add_val, set) and isinstance(curr, set): |
| 1297 | curr.update(add_val) |
| 1298 | elif isinstance(add_val, str) and (not curr or isinstance(curr, str)): |
| 1299 | setattr(module, key, add_val) |
| 1300 | elif isinstance(add_val, bool) and (not curr or isinstance(curr, bool)): |
| 1301 | setattr(module, key, add_val) |
| 1302 | elif isinstance(add_val, dict) and isinstance(curr, dict): |
| 1303 | curr.update(add_val) |
| 1304 | elif isinstance(add_val, dict) and isinstance(curr, Target): |
| 1305 | curr.__dict__.update(add_val) |
| 1306 | else: |
| 1307 | raise Error('Unimplemented type %r of additional_args: %r' % |
| 1308 | (type(add_val), key)) |
| 1309 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1310 | return blueprint |
| 1311 | |
| 1312 | |
| 1313 | def main(): |
| 1314 | parser = argparse.ArgumentParser( |
| 1315 | description='Generate Android.bp from a GN description.') |
| 1316 | parser.add_argument( |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1317 | '--desc', |
Patrick Rohr | 3db246a | 2022-10-25 10:25:17 -0700 | [diff] [blame] | 1318 | help='GN description (e.g., gn desc out --format=json --all-toolchains "//*"', |
| 1319 | required=True |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1320 | ) |
| 1321 | parser.add_argument( |
| 1322 | '--extras', |
| 1323 | help='Extra targets to include at the end of the Blueprint file', |
| 1324 | default=os.path.join(gn_utils.repo_root(), 'Android.bp.extras'), |
| 1325 | ) |
| 1326 | parser.add_argument( |
| 1327 | '--output', |
| 1328 | help='Blueprint file to create', |
| 1329 | default=os.path.join(gn_utils.repo_root(), 'Android.bp'), |
| 1330 | ) |
| 1331 | parser.add_argument( |
Patrick Rohr | 1622894 | 2022-10-26 14:00:26 -0700 | [diff] [blame] | 1332 | '-v', |
| 1333 | '--verbose', |
| 1334 | help='Print debug logs.', |
| 1335 | action='store_true', |
| 1336 | ) |
| 1337 | parser.add_argument( |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1338 | 'targets', |
| 1339 | nargs=argparse.REMAINDER, |
Patrick Rohr | 1aa504a | 2022-10-25 10:30:42 -0700 | [diff] [blame] | 1340 | help='Targets to include in the blueprint (e.g., "//:perfetto_tests")' |
| 1341 | ) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1342 | args = parser.parse_args() |
| 1343 | |
Patrick Rohr | 1622894 | 2022-10-26 14:00:26 -0700 | [diff] [blame] | 1344 | if args.verbose: |
| 1345 | log.basicConfig(format='%(levelname)s:%(funcName)s:%(message)s', level=log.DEBUG) |
| 1346 | |
Patrick Rohr | 3db246a | 2022-10-25 10:25:17 -0700 | [diff] [blame] | 1347 | with open(args.desc) as f: |
| 1348 | desc = json.load(f) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1349 | |
| 1350 | gn = gn_utils.GnParser(desc) |
Patrick Rohr | 0629636 | 2022-11-10 21:37:33 -0800 | [diff] [blame] | 1351 | blueprint = create_blueprint_for_targets(gn, desc, args.targets or default_targets) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1352 | project_root = os.path.abspath(os.path.dirname(os.path.dirname(__file__))) |
| 1353 | tool_name = os.path.relpath(os.path.abspath(__file__), project_root) |
| 1354 | |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1355 | # Add any proto groups to the blueprint. |
| 1356 | for l_name, t_names in proto_groups.items(): |
| 1357 | create_proto_group_modules(blueprint, gn, l_name, t_names) |
| 1358 | |
| 1359 | output = [ |
Patrick Rohr | 5478b39 | 2022-10-25 09:58:50 -0700 | [diff] [blame] | 1360 | """// Copyright (C) 2022 The Android Open Source Project |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1361 | // |
| 1362 | // Licensed under the Apache License, Version 2.0 (the "License"); |
| 1363 | // you may not use this file except in compliance with the License. |
| 1364 | // You may obtain a copy of the License at |
| 1365 | // |
| 1366 | // http://www.apache.org/licenses/LICENSE-2.0 |
| 1367 | // |
| 1368 | // Unless required by applicable law or agreed to in writing, software |
| 1369 | // distributed under the License is distributed on an "AS IS" BASIS, |
| 1370 | // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 1371 | // See the License for the specific language governing permissions and |
| 1372 | // limitations under the License. |
| 1373 | // |
| 1374 | // This file is automatically generated by %s. Do not edit. |
| 1375 | """ % (tool_name) |
| 1376 | ] |
| 1377 | blueprint.to_string(output) |
Patrick Rohr | cb98e9b | 2022-10-25 09:57:02 -0700 | [diff] [blame] | 1378 | if os.path.exists(args.extras): |
| 1379 | with open(args.extras, 'r') as r: |
| 1380 | for line in r: |
| 1381 | output.append(line.rstrip("\n\r")) |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1382 | |
| 1383 | out_files = [] |
| 1384 | |
| 1385 | # Generate the Android.bp file. |
| 1386 | out_files.append(args.output + '.swp') |
| 1387 | with open(out_files[-1], 'w') as f: |
| 1388 | f.write('\n'.join(output)) |
| 1389 | # Text files should have a trailing EOL. |
| 1390 | f.write('\n') |
| 1391 | |
Patrick Rohr | 94693eb | 2022-10-25 10:09:16 -0700 | [diff] [blame] | 1392 | return 0 |
Patrick Rohr | 92d7412 | 2022-10-21 15:50:52 -0700 | [diff] [blame] | 1393 | |
| 1394 | |
| 1395 | if __name__ == '__main__': |
| 1396 | sys.exit(main()) |