blob: 5c6f0361b36d6474663cacd7e6ed253e54966ea0 [file] [log] [blame]
Patrick Rohr92d74122022-10-21 15:50:52 -07001#!/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
28import argparse
29import collections
30import json
Patrick Rohr16228942022-10-26 14:00:26 -070031import logging as log
Patrick Rohr3a2c3dd2022-11-29 22:29:36 -080032import operator
Patrick Rohr92d74122022-10-21 15:50:52 -070033import os
34import re
35import sys
Motomu Utsumic6277d92022-11-07 15:15:17 +090036import copy
Patrick Rohr92d74122022-10-21 15:50:52 -070037
38import gn_utils
39
Patrick Rohr92d74122022-10-21 15:50:52 -070040ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
41
Patrick Rohr06296362022-11-10 21:37:33 -080042# Default targets to translate to the blueprint file.
43default_targets = [
44 '//components/cronet/android:cronet',
Motomu Utsumiabbfdc32022-11-25 12:19:23 +090045 '//components/cronet:cronet_package',
Patrick Rohr06296362022-11-10 21:37:33 -080046]
47
Patrick Rohr92d74122022-10-21 15:50:52 -070048# Defines a custom init_rc argument to be applied to the corresponding output
49# blueprint target.
50target_initrc = {
Patrick Rohrc36ef422022-10-25 10:38:05 -070051 # TODO: this can probably be removed.
Patrick Rohr92d74122022-10-21 15:50:52 -070052}
53
54target_host_supported = [
Patrick Rohrdc383942022-10-25 10:45:29 -070055 # TODO: remove if this is not useful for the cronet build.
Patrick Rohr92d74122022-10-21 15:50:52 -070056]
57
Patrick Rohr92d74122022-10-21 15:50:52 -070058# Proto target groups which will be made public.
59proto_groups = {
Patrick Rohr95212a22022-10-25 09:53:13 -070060 # TODO: remove if this is not used for the cronet build.
Patrick Rohr92d74122022-10-21 15:50:52 -070061}
62
63# All module names are prefixed with this string to avoid collisions.
Patrick Rohr61b2bad2022-10-25 10:49:20 -070064module_prefix = 'cronet_aml_'
Patrick Rohr92d74122022-10-21 15:50:52 -070065
66# Shared libraries which are directly translated to Android system equivalents.
67shared_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.
90static_library_allowlist = [
91 'statslog_perfetto',
92]
93
Patrick Rohrd9dd3b92022-11-09 16:15:30 -080094# Include directories that will be removed from all targets.
95local_include_dirs_denylist = [
Patrick Rohrd9dd3b92022-11-09 16:15:30 -080096]
97
Patrick Rohr92d74122022-10-21 15:50:52 -070098# Name of the module which settings such as compiler flags for all other
99# modules.
100defaults_module = module_prefix + 'defaults'
101
102# Location of the project in the Android source tree.
Patrick Rohr76ceeb52022-11-07 14:18:58 -0800103tree_path = 'external/chromium_org'
Patrick Rohr92d74122022-10-21 15:50:52 -0700104
105# Path for the protobuf sources in the standalone build.
106buildtools_protobuf_src = '//buildtools/protobuf/src'
107
108# Location of the protobuf src dir in the Android source tree.
109android_protobuf_src = 'external/protobuf/src'
110
111# Compiler flags which are passed through to the blueprint.
Motomu Utsumic8b7bea2022-11-16 18:12:44 +0900112cflag_allowlist = [
Motomu Utsumicf68d732022-11-16 18:15:21 +0900113 # needed for zlib:zlib
114 "-mpclmul",
115 # needed for zlib:zlib
116 "-mssse3",
Mohannad Farrag7f29d832022-11-23 19:52:41 +0000117 # needed for zlib:zlib
118 "-msse3",
119 # needed for zlib:zlib
120 "-msse4.2",
Motomu Utsumic8b7bea2022-11-16 18:12:44 +0900121]
Patrick Rohr92d74122022-10-21 15:50:52 -0700122
Patrick Rohr92d74122022-10-21 15:50:52 -0700123# Additional arguments to apply to Android.bp rules.
124additional_args = {
Patrick Rohr2267a0a2022-11-08 18:59:34 -0800125 # TODO: remove if not needed.
Patrick Rohrd90025f2022-11-11 14:18:35 -0800126 'cronet_aml_components_cronet_android_cronet': [
127 ('linker_scripts', {
128 'base/android/library_loader/anchor_functions.lds',
129 }),
130 ],
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800131 'cronet_aml_net_net': [
Patrick Rohr9f4d3e32022-11-09 16:37:31 -0800132 ('export_static_lib_headers', {
133 'cronet_aml_net_third_party_quiche_quiche',
134 'cronet_aml_crypto_crypto',
135 }),
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000136 ],
Patrick Rohr92d74122022-10-21 15:50:52 -0700137}
138
Patrick Rohr92d74122022-10-21 15:50:52 -0700139# Android equivalents for third-party libraries that the upstream project
140# depends on.
141builtin_deps = {
Patrick Rohr14ee0932022-11-15 12:10:27 -0800142 '//net/tools/root_store_tool:root_store_tool':
143 lambda x: None,
Patrick Rohr92d74122022-10-21 15:50:52 -0700144}
145
Motomu Utsumi8ca12412022-11-30 16:27:30 +0900146# Name of tethering apex module
147tethering_apex = "com.android.tethering"
148
Patrick Rohr92d74122022-10-21 15:50:52 -0700149# ----------------------------------------------------------------------------
150# End of configuration.
151# ----------------------------------------------------------------------------
152
153
154class Error(Exception):
155 pass
156
157
158class ThrowingArgumentParser(argparse.ArgumentParser):
159
160 def __init__(self, context):
161 super(ThrowingArgumentParser, self).__init__()
162 self.context = context
163
164 def error(self, message):
165 raise Error('%s: %s' % (self.context, message))
166
167
168def write_blueprint_key_value(output, name, value, sort=True):
169 """Writes a Blueprint key-value pair to the output"""
170
171 if isinstance(value, bool):
172 if value:
173 output.append(' %s: true,' % name)
174 else:
175 output.append(' %s: false,' % name)
176 return
177 if not value:
178 return
179 if isinstance(value, set):
180 value = sorted(value)
181 if isinstance(value, list):
182 output.append(' %s: [' % name)
183 for item in sorted(value) if sort else value:
184 output.append(' "%s",' % item)
185 output.append(' ],')
186 return
187 if isinstance(value, Target):
188 value.to_string(output)
189 return
190 if isinstance(value, dict):
191 kv_output = []
192 for k, v in value.items():
193 write_blueprint_key_value(kv_output, k, v)
194
195 output.append(' %s: {' % name)
196 for line in kv_output:
197 output.append(' %s' % line)
198 output.append(' },')
199 return
200 output.append(' %s: "%s",' % (name, value))
201
202
203class Target(object):
204 """A target-scoped part of a module"""
205
206 def __init__(self, name):
207 self.name = name
Patrick Rohr5d399b32022-11-16 10:19:55 -0800208 self.srcs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700209 self.shared_libs = set()
210 self.static_libs = set()
211 self.whole_static_libs = set()
Patrick Rohrc03f1bb2022-11-18 16:13:17 -0800212 self.header_libs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700213 self.cflags = set()
214 self.dist = dict()
215 self.strip = dict()
216 self.stl = None
Motomu Utsumi50ad2172022-11-17 22:29:53 +0900217 self.cppflags = set()
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -0800218 self.local_include_dirs = set()
Patrick Rohr81435162022-11-17 19:34:32 -0800219 self.export_system_include_dirs = set()
Mohannad Farrag631443e2022-11-21 16:17:01 +0000220 self.generated_headers = set()
221 self.export_generated_headers = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700222
223 def to_string(self, output):
224 nested_out = []
Patrick Rohr5d399b32022-11-16 10:19:55 -0800225 self._output_field(nested_out, 'srcs')
Patrick Rohr92d74122022-10-21 15:50:52 -0700226 self._output_field(nested_out, 'shared_libs')
227 self._output_field(nested_out, 'static_libs')
228 self._output_field(nested_out, 'whole_static_libs')
Patrick Rohrc03f1bb2022-11-18 16:13:17 -0800229 self._output_field(nested_out, 'header_libs')
Patrick Rohr92d74122022-10-21 15:50:52 -0700230 self._output_field(nested_out, 'cflags')
231 self._output_field(nested_out, 'stl')
232 self._output_field(nested_out, 'dist')
233 self._output_field(nested_out, 'strip')
Motomu Utsumi50ad2172022-11-17 22:29:53 +0900234 self._output_field(nested_out, 'cppflags')
235 self._output_field(nested_out, 'local_include_dirs')
Patrick Rohr81435162022-11-17 19:34:32 -0800236 self._output_field(nested_out, 'export_system_include_dirs')
Mohannad Farrag631443e2022-11-21 16:17:01 +0000237 self._output_field(nested_out, 'generated_headers')
238 self._output_field(nested_out, 'export_generated_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -0700239
240 if nested_out:
241 output.append(' %s: {' % self.name)
242 for line in nested_out:
243 output.append(' %s' % line)
244 output.append(' },')
245
246 def _output_field(self, output, name, sort=True):
247 value = getattr(self, name)
248 return write_blueprint_key_value(output, name, value, sort)
249
250
251class Module(object):
252 """A single module (e.g., cc_binary, cc_test) in a blueprint."""
253
254 def __init__(self, mod_type, name, gn_target):
255 self.type = mod_type
256 self.gn_target = gn_target
257 self.name = name
258 self.srcs = set()
Patrick Rohr07876662022-11-15 22:55:23 -0800259 self.comment = 'GN: ' + gn_target
Patrick Rohr92d74122022-10-21 15:50:52 -0700260 self.shared_libs = set()
261 self.static_libs = set()
262 self.whole_static_libs = set()
263 self.runtime_libs = set()
264 self.tools = set()
265 self.cmd = None
266 self.host_supported = False
Patrick Rohrcdda6322022-11-15 22:44:16 -0800267 self.device_supported = True
Patrick Rohr92d74122022-10-21 15:50:52 -0700268 self.vendor_available = False
269 self.init_rc = set()
270 self.out = set()
271 self.export_include_dirs = set()
272 self.generated_headers = set()
273 self.export_generated_headers = set()
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800274 self.export_static_lib_headers = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700275 self.defaults = set()
276 self.cflags = set()
277 self.include_dirs = set()
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -0800278 self.local_include_dirs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700279 self.header_libs = set()
280 self.required = set()
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700281 self.tool_files = set()
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800282 # target contains a dict of Targets indexed by os_arch.
283 # example: { 'android_x86': Target('android_x86')
284 self.target = dict()
285 self.target['android'] = Target('android')
Patrick Rohr82e40742022-11-16 10:20:39 -0800286 self.target['android_x86'] = Target('android_x86')
287 self.target['android_x86_64'] = Target('android_x86_64')
288 self.target['android_arm'] = Target('android_arm')
289 self.target['android_arm64'] = Target('android_arm64')
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800290 self.target['host'] = Target('host')
Patrick Rohr92d74122022-10-21 15:50:52 -0700291 self.stl = None
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700292 self.cpp_std = None
Patrick Rohr92d74122022-10-21 15:50:52 -0700293 self.dist = dict()
294 self.strip = dict()
295 self.data = set()
296 self.apex_available = set()
297 self.min_sdk_version = None
298 self.proto = dict()
Patrick Rohrd90025f2022-11-11 14:18:35 -0800299 self.linker_scripts = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700300 # The genrule_XXX below are properties that must to be propagated back
301 # on the module(s) that depend on the genrule.
302 self.genrule_headers = set()
303 self.genrule_srcs = set()
304 self.genrule_shared_libs = set()
Patrick Rohra1a27872022-10-31 11:57:14 -0700305 self.genrule_header_libs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700306 self.version_script = None
307 self.test_suites = set()
308 self.test_config = None
309 self.stubs = {}
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000310 self.cppflags = set()
311 self.rtti = False
Motomu Utsumiee47af62022-11-30 16:41:15 +0900312 # Name of the output. Used for setting .so file name for libcronet
313 self.stem = None
Patrick Rohr92d74122022-10-21 15:50:52 -0700314
315 def to_string(self, output):
316 if self.comment:
317 output.append('// %s' % self.comment)
318 output.append('%s {' % self.type)
319 self._output_field(output, 'name')
320 self._output_field(output, 'srcs')
321 self._output_field(output, 'shared_libs')
322 self._output_field(output, 'static_libs')
323 self._output_field(output, 'whole_static_libs')
324 self._output_field(output, 'runtime_libs')
325 self._output_field(output, 'tools')
326 self._output_field(output, 'cmd', sort=False)
327 if self.host_supported:
328 self._output_field(output, 'host_supported')
Patrick Rohrcdda6322022-11-15 22:44:16 -0800329 if not self.device_supported:
330 self._output_field(output, 'device_supported')
Patrick Rohr92d74122022-10-21 15:50:52 -0700331 if self.vendor_available:
332 self._output_field(output, 'vendor_available')
333 self._output_field(output, 'init_rc')
334 self._output_field(output, 'out')
335 self._output_field(output, 'export_include_dirs')
336 self._output_field(output, 'generated_headers')
337 self._output_field(output, 'export_generated_headers')
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800338 self._output_field(output, 'export_static_lib_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -0700339 self._output_field(output, 'defaults')
340 self._output_field(output, 'cflags')
341 self._output_field(output, 'include_dirs')
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -0800342 self._output_field(output, 'local_include_dirs')
Patrick Rohr92d74122022-10-21 15:50:52 -0700343 self._output_field(output, 'header_libs')
344 self._output_field(output, 'required')
345 self._output_field(output, 'dist')
346 self._output_field(output, 'strip')
347 self._output_field(output, 'tool_files')
348 self._output_field(output, 'data')
349 self._output_field(output, 'stl')
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700350 self._output_field(output, 'cpp_std')
Patrick Rohr92d74122022-10-21 15:50:52 -0700351 self._output_field(output, 'apex_available')
352 self._output_field(output, 'min_sdk_version')
353 self._output_field(output, 'version_script')
354 self._output_field(output, 'test_suites')
355 self._output_field(output, 'test_config')
356 self._output_field(output, 'stubs')
357 self._output_field(output, 'proto')
Patrick Rohrd90025f2022-11-11 14:18:35 -0800358 self._output_field(output, 'linker_scripts')
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000359 self._output_field(output, 'cppflags')
Motomu Utsumiee47af62022-11-30 16:41:15 +0900360 self._output_field(output, 'stem')
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000361 if self.rtti:
362 self._output_field(output, 'rtti')
Patrick Rohr92d74122022-10-21 15:50:52 -0700363
364 target_out = []
Patrick Rohr09ee70e2022-11-16 15:20:03 -0800365 for arch, target in sorted(self.target.items()):
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800366 # _output_field calls getattr(self, arch).
367 setattr(self, arch, target)
368 self._output_field(target_out, arch)
369
Patrick Rohr92d74122022-10-21 15:50:52 -0700370 if target_out:
371 output.append(' target: {')
372 for line in target_out:
373 output.append(' %s' % line)
374 output.append(' },')
375
Patrick Rohr92d74122022-10-21 15:50:52 -0700376 output.append('}')
377 output.append('')
378
379 def add_android_static_lib(self, lib):
380 if self.type == 'cc_binary_host':
381 raise Exception('Adding Android static lib for host tool is unsupported')
382 elif self.host_supported:
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800383 self.target['android'].static_libs.add(lib)
Patrick Rohr92d74122022-10-21 15:50:52 -0700384 else:
385 self.static_libs.add(lib)
386
387 def add_android_shared_lib(self, lib):
388 if self.type == 'cc_binary_host':
389 raise Exception('Adding Android shared lib for host tool is unsupported')
390 elif self.host_supported:
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800391 self.target['android'].shared_libs.add(lib)
Patrick Rohr92d74122022-10-21 15:50:52 -0700392 else:
393 self.shared_libs.add(lib)
394
395 def _output_field(self, output, name, sort=True):
396 value = getattr(self, name)
397 return write_blueprint_key_value(output, name, value, sort)
398
Patrick Rohra6ce0232022-11-16 22:09:01 -0800399 def is_compiled(self):
Mohannad Farragf2391cc2022-11-29 13:26:32 +0000400 return self.type not in ('cc_genrule', 'filegroup', 'cc_defaults')
Mohannad Farrag1de6cb12022-11-28 12:27:26 +0000401
402 def is_genrule(self):
403 return self.type == "cc_genrule"
Patrick Rohra6ce0232022-11-16 22:09:01 -0800404
Mohannad Farrag7f29d832022-11-23 19:52:41 +0000405 def has_input_files(self):
406 for target in self.target.values():
407 if len(target.srcs) > 0:
408 return True
409 return len(self.srcs) > 0 or any([len(target.srcs) > 0 for target in self.target.values()])
410
Mohannad Farragf2391cc2022-11-29 13:26:32 +0000411 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 Rohr92d74122022-10-21 15:50:52 -0700433
434class 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 Rohr23f26192022-10-25 09:45:22 -0700450 for m in sorted(self.modules.values(), key=lambda m: m.name):
Patrick Rohr92d74122022-10-21 15:50:52 -0700451 m.to_string(output)
452
453
454def label_to_module_name(label):
455 """Turn a GN label (e.g., //:perfetto_tests) into a module name."""
Patrick Rohr07876662022-11-15 22:55:23 -0800456 module = re.sub(r'^//:?', '', label)
Patrick Rohr92d74122022-10-21 15:50:52 -0700457 module = re.sub(r'[^a-zA-Z0-9_]', '_', module)
Motomu Utsumi3fde1482022-11-14 15:55:21 +0900458
Patrick Rohr92d74122022-10-21 15:50:52 -0700459 if not module.startswith(module_prefix):
460 return module_prefix + module
461 return module
462
463
464def is_supported_source_file(name):
465 """Returns True if |name| can appear in a 'srcs' list."""
Patrick Rohrf9f3a992022-11-10 19:40:32 -0800466 return os.path.splitext(name)[1] in ['.c', '.cc', '.cpp', '.java', '.proto', '.S']
Patrick Rohr92d74122022-10-21 15:50:52 -0700467
468
469def 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 Utsumibd4013f2022-11-17 16:06:05 +0900486 protoc_gn_target_name = gn.get_target('//third_party/protobuf:protoc').name
Motomu Utsumid58c1dc2022-11-16 18:04:46 +0900487 protoc_module_name = label_to_module_name(protoc_gn_target_name)
488 tools = {protoc_module_name}
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900489 cpp_out_dir = '$(genDir)/%s/%s/' % (tree_path, target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700490 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 Utsumid58c1dc2022-11-16 18:04:46 +0900494 cmd = ['$(location %s)' % protoc_module_name]
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900495 cmd += ['--proto_path=%s/%s' % (tree_path, target.proto_in_dir)]
Patrick Rohr92d74122022-10-21 15:50:52 -0700496
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 Farrag1de6cb12022-11-28 12:27:26 +0000512 descriptor_module = Module('cc_genrule', target_module_name, target.name)
Patrick Rohr92d74122022-10-21 15:50:52 -0700513 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 Farrag1de6cb12022-11-28 12:27:26 +0000535 source_module = Module('cc_genrule', source_module_name, target.name)
Patrick Rohr92d74122022-10-21 15:50:52 -0700536 blueprint.add_module(source_module)
537 source_module.srcs.update(
538 gn_utils.label_to_path(src) for src in target.sources)
539
Mohannad Farrag1de6cb12022-11-28 12:27:26 +0000540 header_module = Module('cc_genrule', source_module_name + '_headers',
Patrick Rohr92d74122022-10-21 15:50:52 -0700541 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 Rohr2267a0a2022-11-08 18:59:34 -0800551 # 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 Rohr92d74122022-10-21 15:50:52 -0700555
Motomu Utsumi8ca12412022-11-30 16:27:30 +0900556 # This function does not return header_module so setting apex_available attribute here.
557 header_module.apex_available.add(tethering_apex)
558
Patrick Rohr92d74122022-10-21 15:50:52 -0700559 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 Rohr92d74122022-10-21 15:50:52 -0700603def 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 Rohrf6de33f2022-11-29 22:02:55 -0800621
Mohannad Farrag420c14e2022-11-30 17:13:15 +0000622class BaseActionSanitizer():
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800623 def __init__(self, target):
Patrick Rohr9e414b52022-11-29 22:12:18 -0800624 # Just to be on the safe side, create a deep-copy.
625 self.target = copy.deepcopy(target)
626 # Convert ['--param=value'] to ['--param', 'value'] for consistency.
Patrick Rohr3d377802022-11-30 13:42:02 -0800627 self.target.args = [str for it in self.target.args for str in it.split('=')]
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800628
Patrick Rohr2cad9332022-11-30 14:27:40 -0800629 # There are three types of args:
630 # - flags (--flag)
631 # - value args (--arg value)
632 # - list args (--arg value1 --arg value2)
633 # Some functions provide special implementations for each type, while others
634 # work on all of them.
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800635 def _has_arg(self, arg):
636 return arg in self.target.args
637
Patrick Rohr501af222022-11-30 13:38:13 -0800638 # Whether an arg has multiple occurences (e.g. see argparse action='append')
639 def _is_list_arg(self, arg):
Patrick Rohr3a2c3dd2022-11-29 22:29:36 -0800640 return operator.countOf(arg, self.target.args) > 1
641
Patrick Rohref4f2bf2022-11-30 14:22:40 -0800642 def _is_value_arg(self, arg):
Patrick Rohr3a2c3dd2022-11-29 22:29:36 -0800643 # TODO: we'll probably need a set of helper functions to deal with append
644 # args as well.
Patrick Rohr501af222022-11-30 13:38:13 -0800645 assert(not self._is_list_arg(arg))
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800646 i = self.target.args.index(arg)
647 return not self.target.args[i + 1].startswith('--')
648
Patrick Rohr2cad9332022-11-30 14:27:40 -0800649 def _get_value_arg(self, arg):
Patrick Rohref4f2bf2022-11-30 14:22:40 -0800650 assert(self._is_value_arg(arg))
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800651 i = self.target.args.index(arg)
652 return self.target.args[i + 1]
653
Patrick Rohrf0abead2022-11-30 19:44:10 -0800654 # used to check whether a function call should cause an error when an arg is
655 # missing.
656 def _should_fail_silently(self, arg, throw_if_absent):
657 return not throw_if_absent and not self._has_arg(arg)
658
659 def _set_value_arg(self, arg, value, throw_if_absent = True):
660 if self._should_fail_silently(arg, throw_if_absent):
Patrick Rohr4d74aed2022-11-30 15:42:16 -0800661 return
Patrick Rohref4f2bf2022-11-30 14:22:40 -0800662 assert(self._is_value_arg(arg))
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800663 i = self.target.args.index(arg)
664 self.target.args[i + 1] = value
665
Patrick Rohrf0abead2022-11-30 19:44:10 -0800666 def _update_value_arg(self, arg, func, throw_if_absent = True):
667 if self._should_fail_silently(arg, throw_if_absent):
Patrick Rohr4d74aed2022-11-30 15:42:16 -0800668 return
Patrick Rohr1bedf6c2022-11-30 15:12:57 -0800669 self._set_value_arg(arg, func(self._get_value_arg(arg)))
670
Patrick Rohr77c4f5c2022-11-30 12:56:29 -0800671 def _set_arg_at(self, position, value):
Mohannad Farrag9ab17932022-11-30 17:28:35 +0000672 self.target.args[position] = value
673
Patrick Rohrf0abead2022-11-30 19:44:10 -0800674 def _delete_arg(self, arg, throw_if_absent = True):
675 if self._should_fail_silently(arg, throw_if_absent):
Patrick Rohr4d74aed2022-11-30 15:42:16 -0800676 return
Patrick Rohr501af222022-11-30 13:38:13 -0800677 assert(not self._is_list_arg(arg))
Patrick Rohref4f2bf2022-11-30 14:22:40 -0800678 hasValue = self._is_value_arg(arg)
Patrick Rohr9f439322022-11-30 15:56:15 -0800679 i = self.target.args.index(arg)
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800680 self.target.args.pop(i)
681 if hasValue:
682 self.target.args.pop(i)
683
Patrick Rohr1f7dd582022-11-30 13:44:07 -0800684 def _append_arg(self, arg, value):
685 self.target.args.append(arg)
686 self.target.args.append(value)
687
Patrick Rohr73ef7ae2022-11-29 22:33:09 -0800688 # wrap filename in location tag.
Patrick Rohrfda026732022-11-30 16:07:11 -0800689 def _add_location_tag(self, filename):
Patrick Rohr73ef7ae2022-11-29 22:33:09 -0800690 return '$(location %s)' % filename
691
Patrick Rohr0e24c5f2022-11-30 15:20:21 -0800692 # applies common directory transformation that *should* be universally applicable.
693 # TODO: verify if it actually *is* universally applicable.
Patrick Rohr872a2812022-11-30 19:28:22 -0800694 def _sanitize_filepath(self, filepath):
Patrick Rohr0e24c5f2022-11-30 15:20:21 -0800695 # Careful, order matters!
Patrick Rohr9e5a3c72022-11-30 15:51:30 -0800696 filepath = re.sub('^(\.\./)+', '', filepath)
Patrick Rohr0e24c5f2022-11-30 15:20:21 -0800697 filepath = re.sub('^gen/jni_headers', '$(genDir)', filepath)
698 filepath = re.sub('^gen', '$(genDir)', filepath)
699 return filepath
Patrick Rohr32276892022-11-29 22:38:13 -0800700
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800701 def get_args(self):
Patrick Rohr9e414b52022-11-29 22:12:18 -0800702 return self.target.args
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800703
Mohannad Farrag9ab17932022-11-30 17:28:35 +0000704class WriteBuildDateHeaderSanitizer(BaseActionSanitizer):
705 def get_args(self):
Patrick Rohr77c4f5c2022-11-30 12:56:29 -0800706 self._set_arg_at(0, '$(out)')
Mohannad Farrag9ab17932022-11-30 17:28:35 +0000707 return super().get_args()
708
Mohannad Farrag71353f92022-11-30 17:20:48 +0000709class WriteBuildFlagHeaderSanitizer(BaseActionSanitizer):
710 def get_args(self):
Patrick Rohr2cad9332022-11-30 14:27:40 -0800711 self._set_value_arg('--gen-dir', '.')
712 self._set_value_arg('--output', '$(out)')
Mohannad Farrag71353f92022-11-30 17:20:48 +0000713 return super().get_args()
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800714
Patrick Rohr0242a3f2022-11-30 13:48:59 -0800715class JniGeneratorSanitizer(BaseActionSanitizer):
716 def get_args(self):
Patrick Rohrf0abead2022-11-30 19:44:10 -0800717 self._update_value_arg('--jar_file', self._sanitize_filepath, False)
718 self._update_value_arg('--jar_file', self._add_location_tag, False)
Patrick Rohr0242a3f2022-11-30 13:48:59 -0800719 if self._has_arg('--jar_file'):
720 self._append_arg('--javap', '$$(find out/.path -name javap)')
Patrick Rohr872a2812022-11-30 19:28:22 -0800721 self._update_value_arg('--output_dir', self._sanitize_filepath)
Patrick Rohrf0abead2022-11-30 19:44:10 -0800722 self._update_value_arg('--includes', self._sanitize_filepath, False)
723 self._delete_arg('--prev_output_dir', False)
Patrick Rohr0242a3f2022-11-30 13:48:59 -0800724 return super().get_args()
725
726
Patrick Rohr7f117152022-11-30 13:58:05 -0800727def get_action_sanitizer(target):
728 if target.script == "//build/write_buildflag_header.py":
729 return WriteBuildFlagHeaderSanitizer(target)
730 elif target.script == "//build/write_build_date_header.py":
731 return WriteBuildDateHeaderSanitizer(target)
732 elif target.script == '//base/android/jni_generator/jni_generator.py':
733 return JniGeneratorSanitizer(target)
734 else:
735 # TODO: throw exception here once all script hacks have been converted.
736 return BaseActionSanitizer(target)
737
Mohannad Farragbab6c892022-11-02 14:09:46 +0000738def create_action_foreach_modules(blueprint, target):
739 """ The following assumes that rebase_path exists in the args.
740 The args of an action_foreach contains hints about which output files are generated
741 by which source files.
742 This is copied directly from the args
743 "gen/net/base/registry_controlled_domains/{{source_name_part}}-reversed-inc.cc"
744 So each source file will generate an output whose name is the {source_name-reversed-inc.cc}
745 """
746 new_args = []
Motomu Utsumi56afcac2022-11-04 12:58:30 +0900747 for i, src in enumerate(sorted(target.sources)):
Mohannad Farragbab6c892022-11-02 14:09:46 +0000748 # don't add script arg for the first source -- create_action_module
749 # already does this.
750 if i != 0:
751 new_args.append('&& python3 $(location %s)' %
752 gn_utils.label_to_path(target.script))
753 for arg in target.args:
754 if '{{source}}' in arg:
755 new_args.append('$(location %s)' % (gn_utils.label_to_path(src)))
756 elif '{{source_name_part}}' in arg:
757 source_name_part = src.split("/")[-1] # Get the file name only
758 source_name_part = source_name_part.split(".")[0] # Remove the extension (Ex: .cc)
759 file_name = arg.replace('{{source_name_part}}', source_name_part).split("/")[-1]
760 # file_name represent the output file name. But we need the whole path
761 # This can be found from target.outputs.
762 for out in target.outputs:
763 if out.endswith(file_name):
764 new_args.append('$(location %s)' % out)
765 else:
766 new_args.append(arg)
767
768 target.args = new_args
769 return create_action_module(blueprint, target)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900770
Patrick Rohr7be99032022-10-31 11:54:19 -0700771def create_action_module(blueprint, target):
772 bp_module_name = label_to_module_name(target.name)
Mohannad Farrag1de6cb12022-11-28 12:27:26 +0000773 module = Module('cc_genrule', bp_module_name, target.name)
Patrick Rohr7be99032022-10-31 11:54:19 -0700774
Patrick Rohrd7de3dd2022-11-30 12:53:26 -0800775 sanitizer = get_action_sanitizer(target)
Patrick Rohr9e414b52022-11-29 22:12:18 -0800776 target.args = sanitizer.get_args()
Patrick Rohr9b99a982022-10-28 11:00:57 -0700777
Mohannad Farrag9ab17932022-11-30 17:28:35 +0000778 if target.script == '//base/android/jni_generator/jni_generator.py':
Patrick Rohr8acccca2022-10-28 10:39:06 -0700779 for i, val in enumerate(target.args):
Patrick Rohr3e374ef2022-11-30 15:27:52 -0800780 if val == '--input_file':
Patrick Rohr8acccca2022-10-28 10:39:06 -0700781 # --input_file supports both .class specifiers or source files as arguments.
782 # Only source files need to be wrapped inside a $(location <label>) tag.
783 if re.match('.*\.class$', target.args[i + 1]):
784 continue
785 # replace --input_file ../../... with --input_file $(location ...)
786 # TODO: put inside function
787 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
788 target.args[i + 1] = '$(location %s)' % filename
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700789 # fix target.output directory to match #include statements.
790 target.outputs = [re.sub('^jni_headers/', '', out) for out in target.outputs]
Patrick Rohr8acccca2022-10-28 10:39:06 -0700791
Patrick Rohrf6d2b612022-11-09 12:30:26 -0800792 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
793 # jni_registration_generator.py pulls in some config dependencies that we
794 # do not handle. Remove them.
795 # TODO: find a better way to do this.
796 target.deps.clear()
797
Motomu Utsumied009082022-11-10 16:26:44 +0900798 target.inputs = [file for file in target.inputs if not file.startswith('//out/')]
Motomu Utsumi6b4acaa2022-11-10 16:13:24 +0900799 for i, val in enumerate(target.args):
800 if val in ['--depfile', '--srcjar-path', '--header-path']:
801 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900802 if val == '--sources-files':
803 target.args[i + 1] = '$(genDir)/java.sources'
Motomu Utsumi47d122f2022-11-10 17:32:23 +0900804 elif val == '--sources-exclusions':
805 # update_jni_registration_module removes them from the srcs of the module
806 # It might be better to remove sources by '--sources-exclusions'
807 target.args[i] = ''
808 target.args[i + 1] = ''
Motomu Utsumia0cc6662022-11-09 15:22:27 +0900809 elif target.script == "//net/tools/dafsa/make_dafsa.py":
810 # This script generates .cc files but source (registry_controlled_domain.cc) in the target that
811 # depends on this target includes .cc file this script generates.
812 module.genrule_headers.add(module.name)
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900813 elif target.script == "//build/util/version.py":
Motomu Utsumib0a49e42022-11-09 18:12:27 +0900814 # android_chrome_version.py is not specified in anywhere but version.py imports this file
815 module.tool_files.add('build/util/android_chrome_version.py')
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900816 for i, val in enumerate(target.args):
817 if val.startswith('../../'):
818 filename = re.sub('^\.\./\.\./', '', val)
819 target.args[i] = '$(location %s)' % filename
Motomu Utsumiee279c52022-11-09 17:46:27 +0900820 elif val == '-e':
821 # arg for -e EVAL option should be passed in -e PATCH_HI=int(PATCH)//256 format.
822 target.args[i + 1] = '%s=\'%s\'' % (target.args[i + 1], target.args[i + 2])
823 target.args[i + 2] = ''
Motomu Utsumi438f2c22022-11-09 18:16:40 +0900824 elif val == '-o':
825 target.args[i + 1] = '$(out)'
Patrick Rohr245df582022-11-01 16:59:45 -0700826
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700827 script = gn_utils.label_to_path(target.script)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700828 module.tool_files.add(script)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700829
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700830 # Handle passing parameters via response file by piping them into the script
831 # and reading them from /dev/stdin.
832 response_file = '{{response_file_name}}'
833 use_response_file = response_file in target.args
834 if use_response_file:
835 # Replace {{response_file_contents}} with /dev/stdin
836 target.args = ['/dev/stdin' if it == response_file else it for it in target.args]
837
Patrick Rohr4b0952d2022-11-01 12:42:31 -0700838 # escape " and \$ in target.args.
839 # once all actions are properly implemented, this may not be necessary anymore.
840 # TODO: is this the right place to do this?
841 target.args = [arg.replace('"', r'\"') for arg in target.args]
842 target.args = [arg.replace(r'\$', r'\\$') for arg in target.args]
843
Patrick Rohr9b99a982022-10-28 11:00:57 -0700844 # put all args on a new line for better diffs.
845 NEWLINE = ' " +\n "'
846 arg_string = NEWLINE.join(target.args)
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700847 module.cmd = '$(location %s) %s' % (script, arg_string)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700848
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700849 if use_response_file:
850 # Pipe response file contents into script
Patrick Rohr9b99a982022-10-28 11:00:57 -0700851 module.cmd = 'echo \'%s\' |%s%s' % (target.response_file_contents, NEWLINE, module.cmd)
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700852
Motomu Utsumi7e983832022-11-10 16:04:46 +0900853 if any(os.path.splitext(it)[1] == '.h' for it in target.outputs):
Patrick Rohr67f4d432022-10-26 16:04:15 -0700854 module.genrule_headers.add(bp_module_name)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700855
Patrick Rohr0db9f852022-10-27 13:49:57 -0700856 # gn treats inputs and sources for actions equally.
857 # soong only supports source files inside srcs, non-source files are added as
858 # tool_files dependency.
859 for it in target.sources or target.inputs:
860 if is_supported_source_file(it):
861 module.srcs.add(gn_utils.label_to_path(it))
862 else:
863 module.tool_files.add(gn_utils.label_to_path(it))
Patrick Rohre1a853e2022-10-26 12:31:39 -0700864
Patrick Rohr15a2c302022-10-26 15:08:57 -0700865 # Actions using template "action_with_pydeps" also put script inside inputs.
866 # TODO: it might make sense to filter inputs inside GnParser.
867 if script in module.srcs:
868 module.srcs.remove(script)
869
Patrick Rohre1a853e2022-10-26 12:31:39 -0700870 module.out.update(target.outputs)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900871
Motomu Utsumi4b35a322022-11-25 11:55:37 +0900872 if target.script == "//base/android/jni_generator/jni_generator.py":
Mohannad Farrag18d7b512022-11-07 13:26:30 +0000873 # android_jar.classes should be part of the tools as it list implicit classes
874 # for the script to generate JNI headers.
875 module.tool_files.add("base/android/jni_generator/android_jar.classes")
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900876 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
Motomu Utsumi9ca466b2022-11-10 17:12:29 +0900877 # jni_registration_generator.py doesn't work with python2
878 module.cmd = "python3 " + module.cmd
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900879 # Path in the original sources file does not work in genrule.
880 # So creating sources file in cmd based on the srcs of this target.
881 # Adding ../$(current_dir)/ to the head because jni_registration_generator.py uses the files
882 # whose path startswith(..)
883 commands = ["current_dir=`basename \\\`pwd\\\``;",
884 "for f in $(in);",
885 "do",
886 "echo \\\"../$$current_dir/$$f\\\" >> $(genDir)/java.sources;",
887 "done;",
888 module.cmd]
Motomu Utsumi2a892d22022-11-10 18:03:20 +0900889
890 # .h file jni_registration_generator.py generates has #define with directory name.
891 # With the genrule env that contains "." which is invalid. So replace that at the end of cmd.
Mohannad Farrag7c0f0982022-11-10 14:39:49 +0000892 commands.append(";sed -i -e 's/OUT_SOONG_.TEMP_SBOX_.*_OUT/GEN/g' ")
Motomu Utsumi2a892d22022-11-10 18:03:20 +0900893 commands.append("$(genDir)/components/cronet/android/cronet_jni_registration.h")
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900894 module.cmd = NEWLINE.join(commands)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900895
Patrick Rohre1a853e2022-10-26 12:31:39 -0700896 blueprint.add_module(module)
897 return module
898
899
Patrick Rohr92d74122022-10-21 15:50:52 -0700900
Motomu Utsumic34b1372022-11-17 22:15:51 +0900901def _get_cflags(cflags, defines):
902 cflags = {flag for flag in cflags if flag in cflag_allowlist}
Motomu Utsumifa7e9262022-10-26 19:43:02 +0900903 # Consider proper allowlist or denylist if needed
Motomu Utsumic34b1372022-11-17 22:15:51 +0900904 cflags |= set("-D%s" % define.replace("\"", "\\\"") for define in defines)
Patrick Rohr92d74122022-10-21 15:50:52 -0700905 return cflags
906
Motomu Utsumic34b1372022-11-17 22:15:51 +0900907def set_module_flags(module, cflags, defines):
908 module.cflags.update(_get_cflags(cflags, defines))
909 # TODO: implement proper cflag parsing.
910 for flag in cflags:
911 if '-std=' in flag:
912 module.cpp_std = flag[len('-std='):]
Motomu Utsumic34b1372022-11-17 22:15:51 +0900913 if '-fexceptions' in flag:
914 module.cppflags.add('-fexceptions')
Patrick Rohr92d74122022-10-21 15:50:52 -0700915
Mohannad Farrag631443e2022-11-21 16:17:01 +0000916def add_genrule_per_arch(module, dep_module, type):
917 module.generated_headers.update(dep_module.genrule_headers)
918 # If the module is a static library, export all the generated headers.
919 if type == 'cc_library_static':
920 module.export_generated_headers.update(dep_module.genrule_headers)
921 module.srcs.update(dep_module.genrule_srcs)
922 module.shared_libs.update(dep_module.genrule_shared_libs)
923 module.header_libs.update(dep_module.genrule_header_libs)
924
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900925def set_module_include_dirs(module, cflags, include_dirs):
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900926 for flag in cflags:
927 if '-isystem' in flag:
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -0800928 module.local_include_dirs.add(flag[len('-isystem../../'):])
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900929
930 # Adding local_include_dirs is necessary due to source_sets / filegroups
931 # which do not properly propagate include directories.
932 # Filter any directory inside //out as a) this directory does not exist for
933 # aosp / soong builds and b) the include directory should already be
934 # configured via library dependency.
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -0800935 module.local_include_dirs.update([gn_utils.label_to_path(d)
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900936 for d in include_dirs
937 if not re.match('^//out/.*', d)])
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900938
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900939
Patrick Rohr92d74122022-10-21 15:50:52 -0700940def create_modules_from_target(blueprint, gn, gn_target_name):
941 """Generate module(s) for a given GN target.
942
943 Given a GN target name, generate one or more corresponding modules into a
944 blueprint. The only case when this generates >1 module is proto libraries.
945
946 Args:
947 blueprint: Blueprint instance which is being generated.
948 gn: gn_utils.GnParser object.
949 gn_target_name: GN target for module generation.
950 """
951 bp_module_name = label_to_module_name(gn_target_name)
952 if bp_module_name in blueprint.modules:
953 return blueprint.modules[bp_module_name]
954 target = gn.get_target(gn_target_name)
Patrick Rohr16228942022-10-26 14:00:26 -0700955 log.info('create modules for %s (%s)', target.name, target.type)
Patrick Rohr92d74122022-10-21 15:50:52 -0700956
Patrick Rohr92d74122022-10-21 15:50:52 -0700957 if target.type == 'executable':
Patrick Rohrc8f41cd2022-11-15 22:46:10 -0800958 if target.testonly:
Patrick Rohr92d74122022-10-21 15:50:52 -0700959 module_type = 'cc_test'
960 else:
Patrick Rohrc8f41cd2022-11-15 22:46:10 -0800961 # Can be used for both host and device targets.
Patrick Rohr92d74122022-10-21 15:50:52 -0700962 module_type = 'cc_binary'
963 module = Module(module_type, bp_module_name, gn_target_name)
964 elif target.type == 'static_library':
965 module = Module('cc_library_static', bp_module_name, gn_target_name)
966 elif target.type == 'shared_library':
967 module = Module('cc_library_shared', bp_module_name, gn_target_name)
968 elif target.type == 'source_set':
Mohannad Farrag7f29d832022-11-23 19:52:41 +0000969 module = Module('cc_object', bp_module_name, gn_target_name)
Patrick Rohr92d74122022-10-21 15:50:52 -0700970 elif target.type == 'group':
971 # "group" targets are resolved recursively by gn_utils.get_target().
972 # There's nothing we need to do at this level for them.
973 return None
974 elif target.type == 'proto_library':
975 module = create_proto_modules(blueprint, gn, target)
976 if module is None:
977 return None
978 elif target.type == 'action':
Motomu Utsumi7f765cf2022-11-25 13:42:42 +0900979 module = create_action_module(blueprint, target)
Mohannad Farragf076f3e2022-10-31 17:45:28 +0000980 elif target.type == 'action_foreach':
Mohannad Farragbab6c892022-11-02 14:09:46 +0000981 module = create_action_foreach_modules(blueprint, target)
Patrick Rohr59a76652022-10-26 12:36:56 -0700982 elif target.type == 'copy':
983 # TODO: careful now! copy targets are not supported yet, but this will stop
984 # traversing the dependency tree. For //base:base, this is not a big
985 # problem as libicu contains the only copy target which happens to be a
986 # leaf node.
987 return None
Patrick Rohrad440602022-11-10 22:09:04 -0800988 elif target.type == 'java_group':
989 # Java targets are handled outside of create_modules_from_target.
990 return None
Patrick Rohr92d74122022-10-21 15:50:52 -0700991 else:
992 raise Error('Unknown target %s (%s)' % (target.name, target.type))
993
994 blueprint.add_module(module)
Patrick Rohr92d74122022-10-21 15:50:52 -0700995 module.init_rc = target_initrc.get(target.name, [])
996 module.srcs.update(
997 gn_utils.label_to_path(src)
998 for src in target.sources
Motomu Utsumif951e502022-11-07 19:31:15 +0900999 if is_supported_source_file(src) and not src.startswith("//out/test"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001000
Patrick Rohr3b5ff762022-11-16 10:22:16 -08001001 # Add arch-specific properties
1002 for arch_name, arch in target.arch.items():
Motomu Utsumi40f95c52022-11-17 19:39:13 +09001003 module.target[arch_name].srcs.update(
1004 gn_utils.label_to_path(src)
1005 for src in arch.sources
1006 if is_supported_source_file(src) and not src.startswith("//out/test"))
Patrick Rohr3b5ff762022-11-16 10:22:16 -08001007
Mohannad Farragbaf0d572022-11-22 11:53:54 +00001008 module.rtti = target.rtti
1009
Patrick Rohr92d74122022-10-21 15:50:52 -07001010 if target.type in gn_utils.LINKER_UNIT_TYPES:
Motomu Utsumic34b1372022-11-17 22:15:51 +09001011 set_module_flags(module, target.cflags, target.defines)
Motomu Utsumi88efbb42022-11-17 22:18:15 +09001012 set_module_include_dirs(module, target.cflags, target.include_dirs)
Motomu Utsumif0f47682022-11-17 22:34:39 +09001013 # TODO: set_module_xxx is confusing, apply similar function to module and target in better way.
1014 for arch_name, arch in target.arch.items():
1015 set_module_flags(module.target[arch_name], arch.cflags, arch.defines)
Motomu Utsumi3371d682022-11-28 16:56:52 +09001016 # -Xclang -target-feature -Xclang +mte are used to enable MTE (Memory Tagging Extensions).
1017 # Flags which does not start with '-' could not be in the cflags so enabling MTE by
1018 # -march and -mcpu Feature Modifiers. MTE is only available on arm64. This is needed for
1019 # building //base/allocator/partition_allocator:partition_alloc for arm64.
1020 if '+mte' in arch.cflags and arch_name == 'android_arm64':
1021 module.target[arch_name].cflags.add('-march=armv8-a+memtag')
Motomu Utsumif0f47682022-11-17 22:34:39 +09001022 set_module_include_dirs(module.target[arch_name], arch.cflags, arch.include_dirs)
Patrick Rohr92d74122022-10-21 15:50:52 -07001023
Mohannad Farragf2391cc2022-11-29 13:26:32 +00001024 module.host_supported = target.host_supported()
1025 module.device_supported = target.device_supported()
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001026
Motomu Utsumi8ca12412022-11-30 16:27:30 +09001027 if module.is_genrule():
1028 module.apex_available.add(tethering_apex)
1029
Mohannad Farragf2391cc2022-11-29 13:26:32 +00001030 if module.is_compiled():
Patrick Rohr92d74122022-10-21 15:50:52 -07001031 # Don't try to inject library/source dependencies into genrules or
1032 # filegroups because they are not compiled in the traditional sense.
1033 module.defaults = [defaults_module]
1034 for lib in target.libs:
1035 # Generally library names should be mangled as 'libXXX', unless they
1036 # are HAL libraries (e.g., android.hardware.health@2.0) or AIDL c++ / NDK
1037 # libraries (e.g. "android.hardware.power.stats-V1-cpp")
1038 android_lib = lib if '@' in lib or "-cpp" in lib or "-ndk" in lib \
1039 else 'lib' + lib
1040 if lib in shared_library_allowlist:
1041 module.add_android_shared_lib(android_lib)
1042 if lib in static_library_allowlist:
1043 module.add_android_static_lib(android_lib)
1044
Patrick Rohrd9dd3b92022-11-09 16:15:30 -08001045 # Remove prohibited include directories
1046 module.local_include_dirs = [d for d in module.local_include_dirs
1047 if d not in local_include_dirs_denylist]
1048
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001049 # If the module is a static library, export all the generated headers.
1050 if module.type == 'cc_library_static':
1051 module.export_generated_headers = module.generated_headers
1052
Motomu Utsumiee47af62022-11-30 16:41:15 +09001053 if module.name == 'cronet_aml_components_cronet_android_cronet':
1054 if target.output_name is None:
1055 raise Error('Failed to get output_name for libcronet name')
1056 # .so file name needs to match with CronetLibraryLoader.java (e.g. libcronet.109.0.5386.0.so)
1057 # So setting the output name based on the output_name from the desc.json
1058 module.stem = 'lib' + target.output_name
1059
Patrick Rohr92d74122022-10-21 15:50:52 -07001060 # dep_name is an unmangled GN target name (e.g. //foo:bar(toolchain)).
Motomu Utsumif1daa232022-11-08 13:28:37 +09001061 # Currently, only one module is generated from target even target has multiple toolchains.
1062 # And module is generated based on the first visited target.
1063 # Sort deps before iteration to make result deterministic.
1064 all_deps = sorted(target.deps | target.source_set_deps | target.transitive_proto_deps)
Patrick Rohr92d74122022-10-21 15:50:52 -07001065 for dep_name in all_deps:
Patrick Rohr5cc46e02022-10-26 14:32:45 -07001066 # |builtin_deps| override GN deps with Android-specific ones. See the
1067 # config in the top of this file.
Patrick Rohr07876662022-11-15 22:55:23 -08001068 if dep_name in builtin_deps:
1069 builtin_deps[dep_name](module)
Patrick Rohr5cc46e02022-10-26 14:32:45 -07001070 continue
1071
Patrick Rohr92d74122022-10-21 15:50:52 -07001072 dep_module = create_modules_from_target(blueprint, gn, dep_name)
1073
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001074 if dep_module is None:
1075 continue
Motomu Utsumie246feb2022-11-01 17:25:56 +09001076 # TODO: Proper dependency check for genrule.
1077 # Currently, only propagating genrule dependencies.
1078 # Also, currently, all the dependencies are propagated upwards.
1079 # in gn, public_deps should be propagated but deps should not.
1080 # Not sure this information is available in the desc.json.
1081 # Following rule works for adding android_runtime_jni_headers to base:base.
1082 # If this doesn't work for other target, hardcoding for specific target
1083 # might be better.
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001084 if module.is_genrule() and dep_module.is_genrule():
1085 module.genrule_headers.add(dep_module.name)
1086 module.genrule_headers.update(dep_module.genrule_headers)
Motomu Utsumie246feb2022-11-01 17:25:56 +09001087
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001088 # For filegroups, and genrule, recurse but don't apply the
Patrick Rohra6ce0232022-11-16 22:09:01 -08001089 # deps.
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001090 if not module.is_compiled() or module.is_genrule():
Patrick Rohr92d74122022-10-21 15:50:52 -07001091 continue
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001092
Patrick Rohr92d74122022-10-21 15:50:52 -07001093 if dep_module.type == 'cc_library_shared':
1094 module.shared_libs.add(dep_module.name)
1095 elif dep_module.type == 'cc_library_static':
1096 module.static_libs.add(dep_module.name)
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001097 elif dep_module.type == 'cc_object':
Mohannad Farragf2391cc2022-11-29 13:26:32 +00001098 module.merge_attribute('generated_headers', dep_module, target.arch.keys())
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001099 if module.type != 'cc_object':
1100 if dep_module.has_input_files():
1101 # Only add it as part of srcs if the dep_module has input files otherwise
1102 # this would throw an error.
1103 module.srcs.add(":" + dep_module.name)
Mohannad Farragf2391cc2022-11-29 13:26:32 +00001104 module.merge_attribute('export_generated_headers', dep_module,
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001105 target.arch.keys(), 'generated_headers')
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001106 elif dep_module.type == 'cc_genrule':
Mohannad Farragf2391cc2022-11-29 13:26:32 +00001107 module.merge_attribute('generated_headers', dep_module, [], 'genrule_headers')
1108 module.merge_attribute('srcs', dep_module, [], 'genrule_srcs')
1109 module.merge_attribute('shared_libs', dep_module, [], 'genrule_shared_libs')
1110 module.merge_attribute('header_libs', dep_module, [], 'genrule_header_libs')
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001111 if module.type not in ["cc_object"]:
Mohannad Farragf2391cc2022-11-29 13:26:32 +00001112 module.merge_attribute('export_generated_headers', dep_module, [],
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001113 'genrule_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -07001114 elif dep_module.type == 'cc_binary':
1115 continue # Ignore executables deps (used by cmdline integration tests).
1116 else:
1117 raise Error('Unknown dep %s (%s) for target %s' %
1118 (dep_module.name, dep_module.type, module.name))
1119
Patrick Rohrb51878f2022-11-16 23:49:03 -08001120 for arch_name, arch in target.arch.items():
1121 for dep_name in arch.deps:
1122 dep_module = create_modules_from_target(blueprint, gn, dep_name)
1123 # Arch-specific dependencies currently only include cc_library_static.
1124 # Revisit this approach once we need to support more target types.
1125 if dep_module.type == 'cc_library_static':
1126 module.target[arch_name].static_libs.add(dep_module.name)
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001127 elif dep_module.type == 'cc_genrule':
1128 if dep_module.name.endswith(arch_name):
1129 module.target[arch_name].generated_headers.update(dep_module.genrule_headers)
1130 module.target[arch_name].srcs.update(dep_module.genrule_srcs)
1131 module.target[arch_name].shared_libs.update(dep_module.genrule_shared_libs)
1132 module.target[arch_name].header_libs.update(dep_module.genrule_header_libs)
1133 if module.type not in ["cc_object"]:
1134 module.target[arch_name].export_generated_headers.update(
1135 dep_module.genrule_headers)
Patrick Rohrb51878f2022-11-16 23:49:03 -08001136 else:
1137 raise Error('Unsupported arch-specific dependency %s of target %s with type %s' %
1138 (dep_module.name, target.name, dep_module.type))
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001139 for dep_name in arch.source_set_deps:
1140 dep_module = create_modules_from_target(blueprint, gn, dep_name)
1141 if dep_module.type == 'cc_object':
1142 if module.type != 'cc_object':
1143 # We only want to bubble up cc_objects for modules that are not cc_objects
1144 # otherwise they'd be recompiled and that would cause multiple symbol redefinitions.
1145 if dep_module.has_input_files():
1146 # Only add it as part of srcs if the dep_module has input files otherwise
1147 # this would throw an error.
1148 module.target[arch_name].srcs.add(":" + dep_module.name)
1149 else:
1150 raise Error('Unsupported arch-specific dependency %s of target %s with type %s' %
1151 (dep_module.name, target.name, dep_module.type))
Patrick Rohr92d74122022-10-21 15:50:52 -07001152 return module
1153
Patrick Rohrb18aca22022-11-04 15:07:32 -07001154def create_java_module(blueprint, gn):
1155 bp_module_name = module_prefix + 'java'
1156 module = Module('java_library', bp_module_name, '//gn:java')
Mohannad Farrag21562d62022-11-07 13:09:31 +00001157 module.srcs.update([gn_utils.label_to_path(source) for source in gn.java_sources])
Patrick Rohrb18aca22022-11-04 15:07:32 -07001158 blueprint.add_module(module)
Patrick Rohr92d74122022-10-21 15:50:52 -07001159
Patrick Rohr6ef22722022-11-18 18:24:01 -08001160def update_jni_registration_module(module, gn):
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001161 # TODO: deny list is in the arg of jni_registration_generator.py. Should not be hardcoded
1162 deny_list = [
1163 '//base/android/java/src/org/chromium/base/library_loader/LibraryLoader.java',
1164 '//base/android/java/src/org/chromium/base/library_loader/LibraryPrefetcher.java',
1165 '//base/android/java/src/org/chromium/base/process_launcher/ChildProcessService.java',
1166 '//base/android/java/src/org/chromium/base/SysUtils.java']
1167
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001168 # TODO: java_sources might not contain all the required java files
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001169 module.srcs.update([gn_utils.label_to_path(source)
1170 for source in gn.java_sources if source not in deny_list])
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001171
Motomu Utsumia71281c2022-11-18 15:19:00 +09001172def create_blueprint_for_targets(gn, targets):
Patrick Rohr92d74122022-10-21 15:50:52 -07001173 """Generate a blueprint for a list of GN targets."""
1174 blueprint = Blueprint()
1175
1176 # Default settings used by all modules.
1177 defaults = Module('cc_defaults', defaults_module, '//gn:default_deps')
Patrick Rohr92d74122022-10-21 15:50:52 -07001178 defaults.cflags = [
Patrick Rohr3ce74772022-11-11 14:19:58 -08001179 '-DGOOGLE_PROTOBUF_NO_RTTI',
Patrick Rohr92d74122022-10-21 15:50:52 -07001180 '-Wno-error=return-type',
Patrick Rohr3a1ec1d2022-10-31 13:30:17 -07001181 '-Wno-non-virtual-dtor',
Patrick Rohr5c700022022-11-08 19:33:07 -08001182 '-Wno-macro-redefined',
Patrick Rohr98065152022-10-31 14:49:58 -07001183 '-Wno-missing-field-initializers',
Patrick Rohr92d74122022-10-21 15:50:52 -07001184 '-Wno-sign-compare',
1185 '-Wno-sign-promo',
1186 '-Wno-unused-parameter',
Mohannad Farrag54d52442022-11-21 16:27:02 +00001187 '-Wno-null-pointer-subtraction', # Needed to libevent
Mohannad Farragd98a96d2022-11-10 14:56:19 +00001188 '-Wno-deprecated-non-prototype', # needed for zlib
Patrick Rohr92d74122022-10-21 15:50:52 -07001189 '-fvisibility=hidden',
Motomu Utsumiba020942022-11-14 15:15:41 +09001190 '-Wno-ambiguous-reversed-operator', # needed for icui18n
Motomu Utsumib1ec8782022-11-14 15:25:57 +09001191 '-Wno-unreachable-code-loop-increment', # needed for icui18n
Patrick Rohr92d74122022-10-21 15:50:52 -07001192 '-O2',
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001193 '-fPIC',
Patrick Rohr92d74122022-10-21 15:50:52 -07001194 ]
Patrick Rohrc03f1bb2022-11-18 16:13:17 -08001195 # Chromium builds do not add a dependency for headers found inside the
1196 # sysroot, so they are added globally via defaults.
1197 defaults.target['android'].header_libs = [
1198 'media_ndk_headers',
1199 'jni_headers',
1200 ]
Patrick Rohr5446df82022-11-18 14:54:55 -08001201 defaults.target['host'].cflags = [
1202 # -DANDROID is added by default but target.defines contain -DANDROID if
1203 # it's required. So adding -UANDROID to cancel default -DANDROID if it's
1204 # not specified.
1205 # Note: -DANDROID is not consistently applied across the chromium code
1206 # base, so it is removed unconditionally for host targets.
1207 '-UANDROID',
1208 ]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001209 defaults.stl = 'none'
Motomu Utsumi8ca12412022-11-30 16:27:30 +09001210 defaults.min_sdk_version = 29
1211 defaults.apex_available.add(tethering_apex)
Patrick Rohr92d74122022-10-21 15:50:52 -07001212 blueprint.add_module(defaults)
Patrick Rohr344b2472022-10-25 11:32:15 -07001213
Patrick Rohr92d74122022-10-21 15:50:52 -07001214 for target in targets:
1215 create_modules_from_target(blueprint, gn, target)
Patrick Rohrb18aca22022-11-04 15:07:32 -07001216
1217 create_java_module(blueprint, gn)
Patrick Rohr6ef22722022-11-18 18:24:01 -08001218 for module in blueprint.modules.values():
1219 if 'cronet_jni_registration' in module.name:
1220 update_jni_registration_module(module, gn)
Patrick Rohra7d029d2022-11-08 12:23:11 -08001221
1222 # Merge in additional hardcoded arguments.
1223 for module in blueprint.modules.values():
1224 for key, add_val in additional_args.get(module.name, []):
1225 curr = getattr(module, key)
1226 if add_val and isinstance(add_val, set) and isinstance(curr, set):
1227 curr.update(add_val)
1228 elif isinstance(add_val, str) and (not curr or isinstance(curr, str)):
1229 setattr(module, key, add_val)
1230 elif isinstance(add_val, bool) and (not curr or isinstance(curr, bool)):
1231 setattr(module, key, add_val)
1232 elif isinstance(add_val, dict) and isinstance(curr, dict):
1233 curr.update(add_val)
1234 elif isinstance(add_val, dict) and isinstance(curr, Target):
1235 curr.__dict__.update(add_val)
1236 else:
1237 raise Error('Unimplemented type %r of additional_args: %r' %
1238 (type(add_val), key))
1239
Patrick Rohr92d74122022-10-21 15:50:52 -07001240 return blueprint
1241
1242
1243def main():
1244 parser = argparse.ArgumentParser(
1245 description='Generate Android.bp from a GN description.')
1246 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001247 '--desc',
Motomu Utsumi879dec82022-11-18 15:25:12 +09001248 help='GN description (e.g., gn desc out --format=json --all-toolchains "//*".' +
1249 'You can specify multiple --desc options for different target_cpu',
1250 required=True,
1251 action='append'
Patrick Rohr92d74122022-10-21 15:50:52 -07001252 )
1253 parser.add_argument(
1254 '--extras',
1255 help='Extra targets to include at the end of the Blueprint file',
1256 default=os.path.join(gn_utils.repo_root(), 'Android.bp.extras'),
1257 )
1258 parser.add_argument(
1259 '--output',
1260 help='Blueprint file to create',
1261 default=os.path.join(gn_utils.repo_root(), 'Android.bp'),
1262 )
1263 parser.add_argument(
Patrick Rohr16228942022-10-26 14:00:26 -07001264 '-v',
1265 '--verbose',
1266 help='Print debug logs.',
1267 action='store_true',
1268 )
1269 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001270 'targets',
1271 nargs=argparse.REMAINDER,
Patrick Rohr1aa504a2022-10-25 10:30:42 -07001272 help='Targets to include in the blueprint (e.g., "//:perfetto_tests")'
1273 )
Patrick Rohr92d74122022-10-21 15:50:52 -07001274 args = parser.parse_args()
1275
Patrick Rohr16228942022-10-26 14:00:26 -07001276 if args.verbose:
1277 log.basicConfig(format='%(levelname)s:%(funcName)s:%(message)s', level=log.DEBUG)
1278
Patrick Rohrd0077b72022-11-15 12:43:26 -08001279 targets = args.targets or default_targets
Motomu Utsumi879dec82022-11-18 15:25:12 +09001280 gn = gn_utils.GnParser()
1281 for desc_file in args.desc:
1282 with open(desc_file) as f:
1283 desc = json.load(f)
1284 for target in targets:
1285 gn.parse_gn_desc(desc, target)
Motomu Utsumia71281c2022-11-18 15:19:00 +09001286 blueprint = create_blueprint_for_targets(gn, targets)
Patrick Rohr92d74122022-10-21 15:50:52 -07001287 project_root = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
1288 tool_name = os.path.relpath(os.path.abspath(__file__), project_root)
1289
Patrick Rohr92d74122022-10-21 15:50:52 -07001290 # Add any proto groups to the blueprint.
1291 for l_name, t_names in proto_groups.items():
1292 create_proto_group_modules(blueprint, gn, l_name, t_names)
1293
1294 output = [
Patrick Rohr5478b392022-10-25 09:58:50 -07001295 """// Copyright (C) 2022 The Android Open Source Project
Patrick Rohr92d74122022-10-21 15:50:52 -07001296//
1297// Licensed under the Apache License, Version 2.0 (the "License");
1298// you may not use this file except in compliance with the License.
1299// You may obtain a copy of the License at
1300//
1301// http://www.apache.org/licenses/LICENSE-2.0
1302//
1303// Unless required by applicable law or agreed to in writing, software
1304// distributed under the License is distributed on an "AS IS" BASIS,
1305// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1306// See the License for the specific language governing permissions and
1307// limitations under the License.
1308//
1309// This file is automatically generated by %s. Do not edit.
1310""" % (tool_name)
1311 ]
1312 blueprint.to_string(output)
Patrick Rohrcb98e9b2022-10-25 09:57:02 -07001313 if os.path.exists(args.extras):
1314 with open(args.extras, 'r') as r:
1315 for line in r:
1316 output.append(line.rstrip("\n\r"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001317
1318 out_files = []
1319
1320 # Generate the Android.bp file.
1321 out_files.append(args.output + '.swp')
1322 with open(out_files[-1], 'w') as f:
1323 f.write('\n'.join(output))
1324 # Text files should have a trailing EOL.
1325 f.write('\n')
1326
Patrick Rohr94693eb2022-10-25 10:09:16 -07001327 return 0
Patrick Rohr92d74122022-10-21 15:50:52 -07001328
1329
1330if __name__ == '__main__':
1331 sys.exit(main())