blob: 96bd16f7bd20c6006c0a5f8d01228a91d3597138 [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 Rohr92d74122022-10-21 15:50:52 -070032import os
33import re
34import sys
Motomu Utsumic6277d92022-11-07 15:15:17 +090035import copy
Patrick Rohr92d74122022-10-21 15:50:52 -070036
37import gn_utils
38
Patrick Rohr92d74122022-10-21 15:50:52 -070039ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
40
Patrick Rohr06296362022-11-10 21:37:33 -080041# Default targets to translate to the blueprint file.
42default_targets = [
43 '//components/cronet/android:cronet',
44]
45
Patrick Rohr92d74122022-10-21 15:50:52 -070046# Defines a custom init_rc argument to be applied to the corresponding output
47# blueprint target.
48target_initrc = {
Patrick Rohrc36ef422022-10-25 10:38:05 -070049 # TODO: this can probably be removed.
Patrick Rohr92d74122022-10-21 15:50:52 -070050}
51
52target_host_supported = [
Patrick Rohrdc383942022-10-25 10:45:29 -070053 # TODO: remove if this is not useful for the cronet build.
Patrick Rohr92d74122022-10-21 15:50:52 -070054]
55
Patrick Rohr92d74122022-10-21 15:50:52 -070056# Proto target groups which will be made public.
57proto_groups = {
Patrick Rohr95212a22022-10-25 09:53:13 -070058 # TODO: remove if this is not used for the cronet build.
Patrick Rohr92d74122022-10-21 15:50:52 -070059}
60
61# All module names are prefixed with this string to avoid collisions.
Patrick Rohr61b2bad2022-10-25 10:49:20 -070062module_prefix = 'cronet_aml_'
Patrick Rohr92d74122022-10-21 15:50:52 -070063
64# Shared libraries which are directly translated to Android system equivalents.
65shared_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.
88static_library_allowlist = [
89 'statslog_perfetto',
90]
91
Patrick Rohrd9dd3b92022-11-09 16:15:30 -080092# Include directories that will be removed from all targets.
93local_include_dirs_denylist = [
Patrick Rohrd9dd3b92022-11-09 16:15:30 -080094]
95
Patrick Rohr92d74122022-10-21 15:50:52 -070096# Name of the module which settings such as compiler flags for all other
97# modules.
98defaults_module = module_prefix + 'defaults'
99
100# Location of the project in the Android source tree.
Patrick Rohr76ceeb52022-11-07 14:18:58 -0800101tree_path = 'external/chromium_org'
Patrick Rohr92d74122022-10-21 15:50:52 -0700102
103# Path for the protobuf sources in the standalone build.
104buildtools_protobuf_src = '//buildtools/protobuf/src'
105
106# Location of the protobuf src dir in the Android source tree.
107android_protobuf_src = 'external/protobuf/src'
108
109# Compiler flags which are passed through to the blueprint.
Motomu Utsumic8b7bea2022-11-16 18:12:44 +0900110cflag_allowlist = [
Motomu Utsumicf68d732022-11-16 18:15:21 +0900111 # needed for zlib:zlib
112 "-mpclmul",
113 # needed for zlib:zlib
114 "-mssse3",
Motomu Utsumic8b7bea2022-11-16 18:12:44 +0900115]
Patrick Rohr92d74122022-10-21 15:50:52 -0700116
Patrick Rohr92d74122022-10-21 15:50:52 -0700117# Additional arguments to apply to Android.bp rules.
118additional_args = {
Patrick Rohr2267a0a2022-11-08 18:59:34 -0800119 # TODO: remove if not needed.
Patrick Rohrd90025f2022-11-11 14:18:35 -0800120 'cronet_aml_components_cronet_android_cronet': [
121 ('linker_scripts', {
122 'base/android/library_loader/anchor_functions.lds',
123 }),
124 ],
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800125 'cronet_aml_net_net': [
Patrick Rohr9f4d3e32022-11-09 16:37:31 -0800126 ('export_static_lib_headers', {
127 'cronet_aml_net_third_party_quiche_quiche',
128 'cronet_aml_crypto_crypto',
129 }),
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000130 ],
Patrick Rohr92d74122022-10-21 15:50:52 -0700131}
132
Patrick Rohr92d74122022-10-21 15:50:52 -0700133# Android equivalents for third-party libraries that the upstream project
134# depends on.
135builtin_deps = {
Patrick Rohr14ee0932022-11-15 12:10:27 -0800136 '//net/tools/root_store_tool:root_store_tool':
137 lambda x: None,
Patrick Rohr92d74122022-10-21 15:50:52 -0700138}
139
140# ----------------------------------------------------------------------------
141# End of configuration.
142# ----------------------------------------------------------------------------
143
144
145class Error(Exception):
146 pass
147
148
149class ThrowingArgumentParser(argparse.ArgumentParser):
150
151 def __init__(self, context):
152 super(ThrowingArgumentParser, self).__init__()
153 self.context = context
154
155 def error(self, message):
156 raise Error('%s: %s' % (self.context, message))
157
158
159def write_blueprint_key_value(output, name, value, sort=True):
160 """Writes a Blueprint key-value pair to the output"""
161
162 if isinstance(value, bool):
163 if value:
164 output.append(' %s: true,' % name)
165 else:
166 output.append(' %s: false,' % name)
167 return
168 if not value:
169 return
170 if isinstance(value, set):
171 value = sorted(value)
172 if isinstance(value, list):
173 output.append(' %s: [' % name)
174 for item in sorted(value) if sort else value:
175 output.append(' "%s",' % item)
176 output.append(' ],')
177 return
178 if isinstance(value, Target):
179 value.to_string(output)
180 return
181 if isinstance(value, dict):
182 kv_output = []
183 for k, v in value.items():
184 write_blueprint_key_value(kv_output, k, v)
185
186 output.append(' %s: {' % name)
187 for line in kv_output:
188 output.append(' %s' % line)
189 output.append(' },')
190 return
191 output.append(' %s: "%s",' % (name, value))
192
193
194class Target(object):
195 """A target-scoped part of a module"""
196
197 def __init__(self, name):
198 self.name = name
Patrick Rohr5d399b32022-11-16 10:19:55 -0800199 self.srcs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700200 self.shared_libs = set()
201 self.static_libs = set()
202 self.whole_static_libs = set()
Patrick Rohrc03f1bb2022-11-18 16:13:17 -0800203 self.header_libs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700204 self.cflags = set()
205 self.dist = dict()
206 self.strip = dict()
207 self.stl = None
Motomu Utsumi50ad2172022-11-17 22:29:53 +0900208 self.cppflags = set()
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -0800209 self.local_include_dirs = set()
Patrick Rohr81435162022-11-17 19:34:32 -0800210 self.export_system_include_dirs = set()
Mohannad Farrag631443e2022-11-21 16:17:01 +0000211 self.generated_headers = set()
212 self.export_generated_headers = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700213
214 def to_string(self, output):
215 nested_out = []
Patrick Rohr5d399b32022-11-16 10:19:55 -0800216 self._output_field(nested_out, 'srcs')
Patrick Rohr92d74122022-10-21 15:50:52 -0700217 self._output_field(nested_out, 'shared_libs')
218 self._output_field(nested_out, 'static_libs')
219 self._output_field(nested_out, 'whole_static_libs')
Patrick Rohrc03f1bb2022-11-18 16:13:17 -0800220 self._output_field(nested_out, 'header_libs')
Patrick Rohr92d74122022-10-21 15:50:52 -0700221 self._output_field(nested_out, 'cflags')
222 self._output_field(nested_out, 'stl')
223 self._output_field(nested_out, 'dist')
224 self._output_field(nested_out, 'strip')
Motomu Utsumi50ad2172022-11-17 22:29:53 +0900225 self._output_field(nested_out, 'cppflags')
226 self._output_field(nested_out, 'local_include_dirs')
Patrick Rohr81435162022-11-17 19:34:32 -0800227 self._output_field(nested_out, 'export_system_include_dirs')
Mohannad Farrag631443e2022-11-21 16:17:01 +0000228 self._output_field(nested_out, 'generated_headers')
229 self._output_field(nested_out, 'export_generated_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -0700230
231 if nested_out:
232 output.append(' %s: {' % self.name)
233 for line in nested_out:
234 output.append(' %s' % line)
235 output.append(' },')
236
237 def _output_field(self, output, name, sort=True):
238 value = getattr(self, name)
239 return write_blueprint_key_value(output, name, value, sort)
240
241
242class Module(object):
243 """A single module (e.g., cc_binary, cc_test) in a blueprint."""
244
245 def __init__(self, mod_type, name, gn_target):
246 self.type = mod_type
247 self.gn_target = gn_target
248 self.name = name
249 self.srcs = set()
Patrick Rohr07876662022-11-15 22:55:23 -0800250 self.comment = 'GN: ' + gn_target
Patrick Rohr92d74122022-10-21 15:50:52 -0700251 self.shared_libs = set()
252 self.static_libs = set()
253 self.whole_static_libs = set()
254 self.runtime_libs = set()
255 self.tools = set()
256 self.cmd = None
257 self.host_supported = False
Patrick Rohrcdda6322022-11-15 22:44:16 -0800258 self.device_supported = True
Patrick Rohr92d74122022-10-21 15:50:52 -0700259 self.vendor_available = False
260 self.init_rc = set()
261 self.out = set()
262 self.export_include_dirs = set()
263 self.generated_headers = set()
264 self.export_generated_headers = set()
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800265 self.export_static_lib_headers = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700266 self.defaults = set()
267 self.cflags = set()
268 self.include_dirs = set()
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -0800269 self.local_include_dirs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700270 self.header_libs = set()
271 self.required = set()
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700272 self.tool_files = set()
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800273 # target contains a dict of Targets indexed by os_arch.
274 # example: { 'android_x86': Target('android_x86')
275 self.target = dict()
276 self.target['android'] = Target('android')
Patrick Rohr82e40742022-11-16 10:20:39 -0800277 self.target['android_x86'] = Target('android_x86')
278 self.target['android_x86_64'] = Target('android_x86_64')
279 self.target['android_arm'] = Target('android_arm')
280 self.target['android_arm64'] = Target('android_arm64')
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800281 self.target['host'] = Target('host')
Patrick Rohr92d74122022-10-21 15:50:52 -0700282 self.stl = None
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700283 self.cpp_std = None
Patrick Rohr92d74122022-10-21 15:50:52 -0700284 self.dist = dict()
285 self.strip = dict()
286 self.data = set()
287 self.apex_available = set()
288 self.min_sdk_version = None
289 self.proto = dict()
Patrick Rohrd90025f2022-11-11 14:18:35 -0800290 self.linker_scripts = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700291 # The genrule_XXX below are properties that must to be propagated back
292 # on the module(s) that depend on the genrule.
293 self.genrule_headers = set()
294 self.genrule_srcs = set()
295 self.genrule_shared_libs = set()
Patrick Rohra1a27872022-10-31 11:57:14 -0700296 self.genrule_header_libs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700297 self.version_script = None
298 self.test_suites = set()
299 self.test_config = None
300 self.stubs = {}
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000301 self.cppflags = set()
302 self.rtti = False
Patrick Rohr92d74122022-10-21 15:50:52 -0700303
304 def to_string(self, output):
305 if self.comment:
306 output.append('// %s' % self.comment)
307 output.append('%s {' % self.type)
308 self._output_field(output, 'name')
309 self._output_field(output, 'srcs')
310 self._output_field(output, 'shared_libs')
311 self._output_field(output, 'static_libs')
312 self._output_field(output, 'whole_static_libs')
313 self._output_field(output, 'runtime_libs')
314 self._output_field(output, 'tools')
315 self._output_field(output, 'cmd', sort=False)
316 if self.host_supported:
317 self._output_field(output, 'host_supported')
Patrick Rohrcdda6322022-11-15 22:44:16 -0800318 if not self.device_supported:
319 self._output_field(output, 'device_supported')
Patrick Rohr92d74122022-10-21 15:50:52 -0700320 if self.vendor_available:
321 self._output_field(output, 'vendor_available')
322 self._output_field(output, 'init_rc')
323 self._output_field(output, 'out')
324 self._output_field(output, 'export_include_dirs')
325 self._output_field(output, 'generated_headers')
326 self._output_field(output, 'export_generated_headers')
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800327 self._output_field(output, 'export_static_lib_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -0700328 self._output_field(output, 'defaults')
329 self._output_field(output, 'cflags')
330 self._output_field(output, 'include_dirs')
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -0800331 self._output_field(output, 'local_include_dirs')
Patrick Rohr92d74122022-10-21 15:50:52 -0700332 self._output_field(output, 'header_libs')
333 self._output_field(output, 'required')
334 self._output_field(output, 'dist')
335 self._output_field(output, 'strip')
336 self._output_field(output, 'tool_files')
337 self._output_field(output, 'data')
338 self._output_field(output, 'stl')
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700339 self._output_field(output, 'cpp_std')
Patrick Rohr92d74122022-10-21 15:50:52 -0700340 self._output_field(output, 'apex_available')
341 self._output_field(output, 'min_sdk_version')
342 self._output_field(output, 'version_script')
343 self._output_field(output, 'test_suites')
344 self._output_field(output, 'test_config')
345 self._output_field(output, 'stubs')
346 self._output_field(output, 'proto')
Patrick Rohrd90025f2022-11-11 14:18:35 -0800347 self._output_field(output, 'linker_scripts')
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000348 self._output_field(output, 'cppflags')
349 if self.rtti:
350 self._output_field(output, 'rtti')
Patrick Rohr92d74122022-10-21 15:50:52 -0700351
352 target_out = []
Patrick Rohr09ee70e2022-11-16 15:20:03 -0800353 for arch, target in sorted(self.target.items()):
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800354 # _output_field calls getattr(self, arch).
355 setattr(self, arch, target)
356 self._output_field(target_out, arch)
357
Patrick Rohr92d74122022-10-21 15:50:52 -0700358 if target_out:
359 output.append(' target: {')
360 for line in target_out:
361 output.append(' %s' % line)
362 output.append(' },')
363
Patrick Rohr92d74122022-10-21 15:50:52 -0700364 output.append('}')
365 output.append('')
366
367 def add_android_static_lib(self, lib):
368 if self.type == 'cc_binary_host':
369 raise Exception('Adding Android static lib for host tool is unsupported')
370 elif self.host_supported:
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800371 self.target['android'].static_libs.add(lib)
Patrick Rohr92d74122022-10-21 15:50:52 -0700372 else:
373 self.static_libs.add(lib)
374
375 def add_android_shared_lib(self, lib):
376 if self.type == 'cc_binary_host':
377 raise Exception('Adding Android shared lib for host tool is unsupported')
378 elif self.host_supported:
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800379 self.target['android'].shared_libs.add(lib)
Patrick Rohr92d74122022-10-21 15:50:52 -0700380 else:
381 self.shared_libs.add(lib)
382
383 def _output_field(self, output, name, sort=True):
384 value = getattr(self, name)
385 return write_blueprint_key_value(output, name, value, sort)
386
Patrick Rohra6ce0232022-11-16 22:09:01 -0800387 def is_compiled(self):
388 return self.type not in ('genrule', 'filegroup', 'cc_defaults')
389
Patrick Rohr92d74122022-10-21 15:50:52 -0700390
391class Blueprint(object):
392 """In-memory representation of an Android.bp file."""
393
394 def __init__(self):
395 self.modules = {}
396
397 def add_module(self, module):
398 """Adds a new module to the blueprint, replacing any existing module
399 with the same name.
400
401 Args:
402 module: Module instance.
403 """
404 self.modules[module.name] = module
405
406 def to_string(self, output):
Patrick Rohr23f26192022-10-25 09:45:22 -0700407 for m in sorted(self.modules.values(), key=lambda m: m.name):
Patrick Rohr92d74122022-10-21 15:50:52 -0700408 m.to_string(output)
409
410
411def label_to_module_name(label):
412 """Turn a GN label (e.g., //:perfetto_tests) into a module name."""
Patrick Rohr07876662022-11-15 22:55:23 -0800413 module = re.sub(r'^//:?', '', label)
Patrick Rohr92d74122022-10-21 15:50:52 -0700414 module = re.sub(r'[^a-zA-Z0-9_]', '_', module)
Motomu Utsumi3fde1482022-11-14 15:55:21 +0900415
Patrick Rohr92d74122022-10-21 15:50:52 -0700416 if not module.startswith(module_prefix):
417 return module_prefix + module
418 return module
419
420
421def is_supported_source_file(name):
422 """Returns True if |name| can appear in a 'srcs' list."""
Patrick Rohrf9f3a992022-11-10 19:40:32 -0800423 return os.path.splitext(name)[1] in ['.c', '.cc', '.cpp', '.java', '.proto', '.S']
Patrick Rohr92d74122022-10-21 15:50:52 -0700424
425
426def create_proto_modules(blueprint, gn, target):
427 """Generate genrules for a proto GN target.
428
429 GN actions are used to dynamically generate files during the build. The
430 Soong equivalent is a genrule. This function turns a specific kind of
431 genrule which turns .proto files into source and header files into a pair
432 equivalent genrules.
433
434 Args:
435 blueprint: Blueprint instance which is being generated.
436 target: gn_utils.Target object.
437
438 Returns:
439 The source_genrule module.
440 """
441 assert (target.type == 'proto_library')
442
Motomu Utsumibd4013f2022-11-17 16:06:05 +0900443 protoc_gn_target_name = gn.get_target('//third_party/protobuf:protoc').name
Motomu Utsumid58c1dc2022-11-16 18:04:46 +0900444 protoc_module_name = label_to_module_name(protoc_gn_target_name)
445 tools = {protoc_module_name}
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900446 cpp_out_dir = '$(genDir)/%s/%s/' % (tree_path, target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700447 target_module_name = label_to_module_name(target.name)
448
449 # In GN builds the proto path is always relative to the output directory
450 # (out/tmp.xxx).
Motomu Utsumid58c1dc2022-11-16 18:04:46 +0900451 cmd = ['$(location %s)' % protoc_module_name]
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900452 cmd += ['--proto_path=%s/%s' % (tree_path, target.proto_in_dir)]
Patrick Rohr92d74122022-10-21 15:50:52 -0700453
454 if buildtools_protobuf_src in target.proto_paths:
455 cmd += ['--proto_path=%s' % android_protobuf_src]
456
457 # We don't generate any targets for source_set proto modules because
458 # they will be inlined into other modules if required.
459 if target.proto_plugin == 'source_set':
460 return None
461
462 # Descriptor targets only generate a single target.
463 if target.proto_plugin == 'descriptor':
464 out = '{}.bin'.format(target_module_name)
465
466 cmd += ['--descriptor_set_out=$(out)']
467 cmd += ['$(in)']
468
469 descriptor_module = Module('genrule', target_module_name, target.name)
470 descriptor_module.cmd = ' '.join(cmd)
471 descriptor_module.out = [out]
472 descriptor_module.tools = tools
473 blueprint.add_module(descriptor_module)
474
475 # Recursively extract the .proto files of all the dependencies and
476 # add them to srcs.
477 descriptor_module.srcs.update(
478 gn_utils.label_to_path(src) for src in target.sources)
479 for dep in target.transitive_proto_deps:
480 current_target = gn.get_target(dep)
481 descriptor_module.srcs.update(
482 gn_utils.label_to_path(src) for src in current_target.sources)
483
484 return descriptor_module
485
486 # We create two genrules for each proto target: one for the headers and
487 # another for the sources. This is because the module that depends on the
488 # generated files needs to declare two different types of dependencies --
489 # source files in 'srcs' and headers in 'generated_headers' -- and it's not
490 # valid to generate .h files from a source dependency and vice versa.
491 source_module_name = target_module_name + '_gen'
492 source_module = Module('genrule', source_module_name, target.name)
493 blueprint.add_module(source_module)
494 source_module.srcs.update(
495 gn_utils.label_to_path(src) for src in target.sources)
496
497 header_module = Module('genrule', source_module_name + '_headers',
498 target.name)
499 blueprint.add_module(header_module)
500 header_module.srcs = set(source_module.srcs)
501
502 # TODO(primiano): at some point we should remove this. This was introduced
503 # by aosp/1108421 when adding "protos/" to .proto include paths, in order to
504 # avoid doing multi-repo changes and allow old clients in the android tree
505 # to still do the old #include "perfetto/..." rather than
506 # #include "protos/perfetto/...".
507 header_module.export_include_dirs = {'.', 'protos'}
Patrick Rohr2267a0a2022-11-08 18:59:34 -0800508 # Since the .cc file and .h get created by a different gerule target, they
509 # are not put in the same intermediate path, so local includes do not work
510 # without explictily exporting the include dir.
511 header_module.export_include_dirs.add(target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700512
513 source_module.genrule_srcs.add(':' + source_module.name)
514 source_module.genrule_headers.add(header_module.name)
515
516 if target.proto_plugin == 'proto':
517 suffixes = ['pb']
518 source_module.genrule_shared_libs.add('libprotobuf-cpp-lite')
519 cmd += ['--cpp_out=lite=true:' + cpp_out_dir]
520 elif target.proto_plugin == 'protozero':
521 suffixes = ['pbzero']
522 plugin = create_modules_from_target(blueprint, gn, protozero_plugin)
523 tools.add(plugin.name)
524 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
525 cmd += ['--plugin_out=wrapper_namespace=pbzero:' + cpp_out_dir]
526 elif target.proto_plugin == 'cppgen':
527 suffixes = ['gen']
528 plugin = create_modules_from_target(blueprint, gn, cppgen_plugin)
529 tools.add(plugin.name)
530 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
531 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
532 elif target.proto_plugin == 'ipc':
533 suffixes = ['ipc']
534 plugin = create_modules_from_target(blueprint, gn, ipc_plugin)
535 tools.add(plugin.name)
536 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
537 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
538 else:
539 raise Error('Unsupported proto plugin: %s' % target.proto_plugin)
540
541 cmd += ['$(in)']
542 source_module.cmd = ' '.join(cmd)
543 header_module.cmd = source_module.cmd
544 source_module.tools = tools
545 header_module.tools = tools
546
547 for sfx in suffixes:
548 source_module.out.update('%s/%s' %
549 (tree_path, src.replace('.proto', '.%s.cc' % sfx))
550 for src in source_module.srcs)
551 header_module.out.update('%s/%s' %
552 (tree_path, src.replace('.proto', '.%s.h' % sfx))
553 for src in header_module.srcs)
554 return source_module
555
556
557def create_amalgamated_sql_metrics_module(blueprint, target):
558 bp_module_name = label_to_module_name(target.name)
559 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700560 module.tool_files.add('tools/gen_amalgamated_sql_metrics.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700561 module.cmd = ' '.join([
562 '$(location tools/gen_amalgamated_sql_metrics.py)',
563 '--cpp_out=$(out)',
564 '$(in)',
565 ])
566 module.genrule_headers.add(module.name)
567 module.out.update(target.outputs)
568 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
569 blueprint.add_module(module)
570 return module
571
572
573def create_cc_proto_descriptor_module(blueprint, target):
574 bp_module_name = label_to_module_name(target.name)
575 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700576 module.tool_files.add('tools/gen_cc_proto_descriptor.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700577 module.cmd = ' '.join([
578 '$(location tools/gen_cc_proto_descriptor.py)', '--gen_dir=$(genDir)',
579 '--cpp_out=$(out)', '$(in)'
580 ])
581 module.genrule_headers.add(module.name)
582 module.srcs.update(
583 ':' + label_to_module_name(dep) for dep in target.proto_deps)
584 module.srcs.update(
585 gn_utils.label_to_path(src)
586 for src in target.inputs
587 if "tmp.gn_utils" not in src)
588 module.out.update(target.outputs)
589 blueprint.add_module(module)
590 return module
591
592
593def create_gen_version_module(blueprint, target, bp_module_name):
594 module = Module('genrule', bp_module_name, gn_utils.GEN_VERSION_TARGET)
595 script_path = gn_utils.label_to_path(target.script)
596 module.genrule_headers.add(bp_module_name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700597 module.tool_files.add(script_path)
Patrick Rohr92d74122022-10-21 15:50:52 -0700598 module.out.update(target.outputs)
599 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
600 module.cmd = ' '.join([
601 'python3 $(location %s)' % script_path, '--no_git',
602 '--changelog=$(location CHANGELOG)', '--cpp_out=$(out)'
603 ])
604 blueprint.add_module(module)
605 return module
606
607
608def create_proto_group_modules(blueprint, gn, module_name, target_names):
609 # TODO(lalitm): today, we're only adding a Java lite module because that's
610 # the only one used in practice. In the future, if we need other target types
611 # (e.g. C++, Java full etc.) add them here.
612 bp_module_name = label_to_module_name(module_name) + '_java_protos'
613 module = Module('java_library', bp_module_name, bp_module_name)
614 module.comment = f'''GN: [{', '.join(target_names)}]'''
615 module.proto = {'type': 'lite', 'canonical_path_from_root': False}
616
617 for name in target_names:
618 target = gn.get_target(name)
619 module.srcs.update(gn_utils.label_to_path(src) for src in target.sources)
620 for dep_label in target.transitive_proto_deps:
621 dep = gn.get_target(dep_label)
622 module.srcs.update(gn_utils.label_to_path(src) for src in dep.sources)
623
624 blueprint.add_module(module)
625
Mohannad Farragbab6c892022-11-02 14:09:46 +0000626def create_action_foreach_modules(blueprint, target):
627 """ The following assumes that rebase_path exists in the args.
628 The args of an action_foreach contains hints about which output files are generated
629 by which source files.
630 This is copied directly from the args
631 "gen/net/base/registry_controlled_domains/{{source_name_part}}-reversed-inc.cc"
632 So each source file will generate an output whose name is the {source_name-reversed-inc.cc}
633 """
634 new_args = []
Motomu Utsumi56afcac2022-11-04 12:58:30 +0900635 for i, src in enumerate(sorted(target.sources)):
Mohannad Farragbab6c892022-11-02 14:09:46 +0000636 # don't add script arg for the first source -- create_action_module
637 # already does this.
638 if i != 0:
639 new_args.append('&& python3 $(location %s)' %
640 gn_utils.label_to_path(target.script))
641 for arg in target.args:
642 if '{{source}}' in arg:
643 new_args.append('$(location %s)' % (gn_utils.label_to_path(src)))
644 elif '{{source_name_part}}' in arg:
645 source_name_part = src.split("/")[-1] # Get the file name only
646 source_name_part = source_name_part.split(".")[0] # Remove the extension (Ex: .cc)
647 file_name = arg.replace('{{source_name_part}}', source_name_part).split("/")[-1]
648 # file_name represent the output file name. But we need the whole path
649 # This can be found from target.outputs.
650 for out in target.outputs:
651 if out.endswith(file_name):
652 new_args.append('$(location %s)' % out)
653 else:
654 new_args.append(arg)
655
656 target.args = new_args
657 return create_action_module(blueprint, target)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900658
Patrick Rohr7be99032022-10-31 11:54:19 -0700659def create_action_module(blueprint, target):
660 bp_module_name = label_to_module_name(target.name)
661 module = Module('genrule', bp_module_name, target.name)
662
Patrick Rohr9b99a982022-10-28 11:00:57 -0700663 # Convert ['--param=value'] to ['--param', 'value'] for consistency.
664 # TODO: we may want to only do this for python scripts arguments. If argparse
665 # is used, this transformation is safe.
666 target.args = [str for it in target.args for str in it.split('=')]
667
Motomu Utsumibf569d42022-10-28 16:47:34 +0900668 if target.script == "//build/write_buildflag_header.py":
669 # write_buildflag_header.py writes result to args.genDir/args.output
670 # So, override args.genDir by '.' so that args.output=$(out) works
Patrick Rohrde568a22022-10-28 09:22:35 -0700671 for i, val in enumerate(target.args):
672 if val == '--gen-dir':
673 target.args[i + 1] = '.'
Patrick Rohrfa972402022-11-01 11:54:35 -0700674 elif val == '--output':
675 target.args[i + 1] = '$(out)'
676
677 elif target.script == '//build/write_build_date_header.py':
678 target.args[0] = '$(out)'
Patrick Rohr0db9f852022-10-27 13:49:57 -0700679
Patrick Rohr8acccca2022-10-28 10:39:06 -0700680 elif target.script == '//base/android/jni_generator/jni_generator.py':
Patrick Rohr131ba282022-10-31 16:36:20 -0700681 needs_javap = False
Patrick Rohr8acccca2022-10-28 10:39:06 -0700682 for i, val in enumerate(target.args):
Motomu Utsumi6f9139d2022-10-31 12:15:19 +0900683 if val == '--output_dir':
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700684 # replace --output_dir gen/jni_headers/... with --output_dir $(genDir)/...
685 target.args[i + 1] = re.sub('^gen/jni_headers', '$(genDir)', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700686 elif val == '--input_file':
Patrick Rohr8acccca2022-10-28 10:39:06 -0700687 # --input_file supports both .class specifiers or source files as arguments.
688 # Only source files need to be wrapped inside a $(location <label>) tag.
689 if re.match('.*\.class$', target.args[i + 1]):
690 continue
691 # replace --input_file ../../... with --input_file $(location ...)
692 # TODO: put inside function
693 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
694 target.args[i + 1] = '$(location %s)' % filename
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700695 elif val == '--includes' and 'jni_generator_helper' in target.args[i + 1]:
Patrick Rohrd89e8bf2022-10-31 14:51:05 -0700696 # delete all leading ../
697 target.args[i + 1] = re.sub('^(\.\./)+', '', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700698 elif val == '--prev_output_dir':
Patrick Rohr131ba282022-10-31 16:36:20 -0700699 # this is not needed for aosp builds.
700 target.args[i] = ''
701 target.args[i + 1] = ''
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700702 elif val == '--jar_file':
Patrick Rohr131ba282022-10-31 16:36:20 -0700703 # delete leading ../../ and add path to javap
704 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
705 target.args[i + 1] = '$(location %s)' % filename
706 needs_javap = True
707
708 if needs_javap:
709 target.args.append('--javap')
710 target.args.append('$$(find out/.path -name javap)')
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700711 # fix target.output directory to match #include statements.
712 target.outputs = [re.sub('^jni_headers/', '', out) for out in target.outputs]
Patrick Rohr8acccca2022-10-28 10:39:06 -0700713
Patrick Rohrf6d2b612022-11-09 12:30:26 -0800714 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
715 # jni_registration_generator.py pulls in some config dependencies that we
716 # do not handle. Remove them.
717 # TODO: find a better way to do this.
718 target.deps.clear()
719
Motomu Utsumied009082022-11-10 16:26:44 +0900720 target.inputs = [file for file in target.inputs if not file.startswith('//out/')]
Motomu Utsumi6b4acaa2022-11-10 16:13:24 +0900721 for i, val in enumerate(target.args):
722 if val in ['--depfile', '--srcjar-path', '--header-path']:
723 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900724 if val == '--sources-files':
725 target.args[i + 1] = '$(genDir)/java.sources'
Motomu Utsumi47d122f2022-11-10 17:32:23 +0900726 elif val == '--sources-exclusions':
727 # update_jni_registration_module removes them from the srcs of the module
728 # It might be better to remove sources by '--sources-exclusions'
729 target.args[i] = ''
730 target.args[i + 1] = ''
Motomu Utsumi6b4acaa2022-11-10 16:13:24 +0900731
Patrick Rohr245df582022-11-01 16:59:45 -0700732 elif target.script == '//build/android/gyp/write_build_config.py':
733 for i, val in enumerate(target.args):
734 if val == '--depfile':
735 # Depfile is not used, so no need to generate it.
736 target.args[i] = ''
737 target.args[i + 1] = ''
738 elif val in ['--deps-configs', '--bundled-srcjars']:
739 args = target.args[i + 1]
740 if args == '[]':
741 continue
742 # strip surrounding [] and split by ", "
743 args = args.strip('[]').split(', ')
744 # strip surrounding ""
745 args = [arg.strip('"') for arg in args]
746 # remove leading gen/
747 args = [re.sub('^gen/', '', arg) for arg in args]
748 # wrap filename in \"$(location filename)\"
749 args = ['\"$(location %s)\"' % arg for arg in args]
750 # join args with ", " and wrap in []
751 target.args[i + 1] = '[%s]' % ', '.join(args)
752
753 elif val == '--public-deps-configs':
754 # TODO: implement.
755 pass
756
757 elif val == '--build-config':
758 # json output of this script
759 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
760
761 elif val in ['--unprocessed-jar-path', '--interface-jar-path',
762 '--device-jar-path', '--host-jar-path']:
763 # jar path can be within sources (../../) or output generated by
764 # another genrule (obj/)
765 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
766 filename = re.sub('^obj/', '', target.args[i + 1])
767 target.args[i + 1] = '$(location %s)' % filename
768
769 elif val == '--proguard-configs':
770 args = target.args[i + 1]
771 if args == '[]':
772 continue
773 # TODO: consider adding helpers to deal with argument lists
774 # strip surrounding [] and split by ", ", then strip surrounding ""
775 args = args.strip('[]').split(', ')
776 args = [arg.strip('"') for arg in args]
777 # remove leading ../../
778 args = [re.sub('^\.\./\.\./', '', arg) for arg in args]
779 # add dependency on proguard config file, so a $(location) wrapper can be used.
780 module.tool_files.update(args)
781 # wrap filename in \"$(location filename)\"
782 args = ['$(location %s)' % arg for arg in args]
783 target.args[i + 1] = '[%s]' % ', '.join(args)
Motomu Utsumi1caa39b2022-11-02 18:38:13 +0900784 elif target.script == "//build/android/gyp/write_native_libraries_java.py":
785 for i, val in enumerate(target.args):
786 if val == '--output':
787 target.args[i + 1] = '$(out)'
Motomu Utsumia0cc6662022-11-09 15:22:27 +0900788 elif target.script == "//net/tools/dafsa/make_dafsa.py":
789 # This script generates .cc files but source (registry_controlled_domain.cc) in the target that
790 # depends on this target includes .cc file this script generates.
791 module.genrule_headers.add(module.name)
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900792 elif target.script == "//build/util/version.py":
Motomu Utsumib0a49e42022-11-09 18:12:27 +0900793 # android_chrome_version.py is not specified in anywhere but version.py imports this file
794 module.tool_files.add('build/util/android_chrome_version.py')
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900795 for i, val in enumerate(target.args):
796 if val.startswith('../../'):
797 filename = re.sub('^\.\./\.\./', '', val)
798 target.args[i] = '$(location %s)' % filename
Motomu Utsumiee279c52022-11-09 17:46:27 +0900799 elif val == '-e':
800 # arg for -e EVAL option should be passed in -e PATCH_HI=int(PATCH)//256 format.
801 target.args[i + 1] = '%s=\'%s\'' % (target.args[i + 1], target.args[i + 2])
802 target.args[i + 2] = ''
Motomu Utsumi438f2c22022-11-09 18:16:40 +0900803 elif val == '-o':
804 target.args[i + 1] = '$(out)'
Patrick Rohr245df582022-11-01 16:59:45 -0700805
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700806 script = gn_utils.label_to_path(target.script)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700807 module.tool_files.add(script)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700808
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700809 # Handle passing parameters via response file by piping them into the script
810 # and reading them from /dev/stdin.
811 response_file = '{{response_file_name}}'
812 use_response_file = response_file in target.args
813 if use_response_file:
814 # Replace {{response_file_contents}} with /dev/stdin
815 target.args = ['/dev/stdin' if it == response_file else it for it in target.args]
816
Patrick Rohr4b0952d2022-11-01 12:42:31 -0700817 # escape " and \$ in target.args.
818 # once all actions are properly implemented, this may not be necessary anymore.
819 # TODO: is this the right place to do this?
820 target.args = [arg.replace('"', r'\"') for arg in target.args]
821 target.args = [arg.replace(r'\$', r'\\$') for arg in target.args]
822
Patrick Rohr9b99a982022-10-28 11:00:57 -0700823 # put all args on a new line for better diffs.
824 NEWLINE = ' " +\n "'
825 arg_string = NEWLINE.join(target.args)
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700826 module.cmd = '$(location %s) %s' % (script, arg_string)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700827
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700828 if use_response_file:
829 # Pipe response file contents into script
Patrick Rohr9b99a982022-10-28 11:00:57 -0700830 module.cmd = 'echo \'%s\' |%s%s' % (target.response_file_contents, NEWLINE, module.cmd)
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700831
Motomu Utsumi7e983832022-11-10 16:04:46 +0900832 if any(os.path.splitext(it)[1] == '.h' for it in target.outputs):
Patrick Rohr67f4d432022-10-26 16:04:15 -0700833 module.genrule_headers.add(bp_module_name)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700834
Patrick Rohr0db9f852022-10-27 13:49:57 -0700835 # gn treats inputs and sources for actions equally.
836 # soong only supports source files inside srcs, non-source files are added as
837 # tool_files dependency.
838 for it in target.sources or target.inputs:
839 if is_supported_source_file(it):
840 module.srcs.add(gn_utils.label_to_path(it))
841 else:
842 module.tool_files.add(gn_utils.label_to_path(it))
Patrick Rohre1a853e2022-10-26 12:31:39 -0700843
Patrick Rohr15a2c302022-10-26 15:08:57 -0700844 # Actions using template "action_with_pydeps" also put script inside inputs.
845 # TODO: it might make sense to filter inputs inside GnParser.
846 if script in module.srcs:
847 module.srcs.remove(script)
848
Patrick Rohre1a853e2022-10-26 12:31:39 -0700849 module.out.update(target.outputs)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900850
Motomu Utsumi4b35a322022-11-25 11:55:37 +0900851 if target.script == "//base/android/jni_generator/jni_generator.py":
Mohannad Farrag18d7b512022-11-07 13:26:30 +0000852 # android_jar.classes should be part of the tools as it list implicit classes
853 # for the script to generate JNI headers.
854 module.tool_files.add("base/android/jni_generator/android_jar.classes")
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900855 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
Motomu Utsumi9ca466b2022-11-10 17:12:29 +0900856 # jni_registration_generator.py doesn't work with python2
857 module.cmd = "python3 " + module.cmd
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900858 # Path in the original sources file does not work in genrule.
859 # So creating sources file in cmd based on the srcs of this target.
860 # Adding ../$(current_dir)/ to the head because jni_registration_generator.py uses the files
861 # whose path startswith(..)
862 commands = ["current_dir=`basename \\\`pwd\\\``;",
863 "for f in $(in);",
864 "do",
865 "echo \\\"../$$current_dir/$$f\\\" >> $(genDir)/java.sources;",
866 "done;",
867 module.cmd]
Motomu Utsumi2a892d22022-11-10 18:03:20 +0900868
869 # .h file jni_registration_generator.py generates has #define with directory name.
870 # With the genrule env that contains "." which is invalid. So replace that at the end of cmd.
Mohannad Farrag7c0f0982022-11-10 14:39:49 +0000871 commands.append(";sed -i -e 's/OUT_SOONG_.TEMP_SBOX_.*_OUT/GEN/g' ")
Motomu Utsumi2a892d22022-11-10 18:03:20 +0900872 commands.append("$(genDir)/components/cronet/android/cronet_jni_registration.h")
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900873 module.cmd = NEWLINE.join(commands)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900874
Patrick Rohre1a853e2022-10-26 12:31:39 -0700875 blueprint.add_module(module)
876 return module
877
878
Patrick Rohr92d74122022-10-21 15:50:52 -0700879
Motomu Utsumic34b1372022-11-17 22:15:51 +0900880def _get_cflags(cflags, defines):
881 cflags = {flag for flag in cflags if flag in cflag_allowlist}
Motomu Utsumifa7e9262022-10-26 19:43:02 +0900882 # Consider proper allowlist or denylist if needed
Motomu Utsumic34b1372022-11-17 22:15:51 +0900883 cflags |= set("-D%s" % define.replace("\"", "\\\"") for define in defines)
Patrick Rohr92d74122022-10-21 15:50:52 -0700884 return cflags
885
Motomu Utsumic34b1372022-11-17 22:15:51 +0900886def set_module_flags(module, cflags, defines):
887 module.cflags.update(_get_cflags(cflags, defines))
888 # TODO: implement proper cflag parsing.
889 for flag in cflags:
890 if '-std=' in flag:
891 module.cpp_std = flag[len('-std='):]
Motomu Utsumic34b1372022-11-17 22:15:51 +0900892 if '-fexceptions' in flag:
893 module.cppflags.add('-fexceptions')
Patrick Rohr92d74122022-10-21 15:50:52 -0700894
Mohannad Farrag631443e2022-11-21 16:17:01 +0000895def add_genrule_per_arch(module, dep_module, type):
896 module.generated_headers.update(dep_module.genrule_headers)
897 # If the module is a static library, export all the generated headers.
898 if type == 'cc_library_static':
899 module.export_generated_headers.update(dep_module.genrule_headers)
900 module.srcs.update(dep_module.genrule_srcs)
901 module.shared_libs.update(dep_module.genrule_shared_libs)
902 module.header_libs.update(dep_module.genrule_header_libs)
903
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900904def set_module_include_dirs(module, cflags, include_dirs):
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900905 for flag in cflags:
906 if '-isystem' in flag:
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -0800907 module.local_include_dirs.add(flag[len('-isystem../../'):])
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900908
909 # Adding local_include_dirs is necessary due to source_sets / filegroups
910 # which do not properly propagate include directories.
911 # Filter any directory inside //out as a) this directory does not exist for
912 # aosp / soong builds and b) the include directory should already be
913 # configured via library dependency.
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -0800914 module.local_include_dirs.update([gn_utils.label_to_path(d)
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900915 for d in include_dirs
916 if not re.match('^//out/.*', d)])
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900917
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900918
Patrick Rohr92d74122022-10-21 15:50:52 -0700919def create_modules_from_target(blueprint, gn, gn_target_name):
920 """Generate module(s) for a given GN target.
921
922 Given a GN target name, generate one or more corresponding modules into a
923 blueprint. The only case when this generates >1 module is proto libraries.
924
925 Args:
926 blueprint: Blueprint instance which is being generated.
927 gn: gn_utils.GnParser object.
928 gn_target_name: GN target for module generation.
929 """
930 bp_module_name = label_to_module_name(gn_target_name)
931 if bp_module_name in blueprint.modules:
932 return blueprint.modules[bp_module_name]
933 target = gn.get_target(gn_target_name)
Patrick Rohr16228942022-10-26 14:00:26 -0700934 log.info('create modules for %s (%s)', target.name, target.type)
Patrick Rohr92d74122022-10-21 15:50:52 -0700935
Patrick Rohr92d74122022-10-21 15:50:52 -0700936 if target.type == 'executable':
Patrick Rohrc8f41cd2022-11-15 22:46:10 -0800937 if target.testonly:
Patrick Rohr92d74122022-10-21 15:50:52 -0700938 module_type = 'cc_test'
939 else:
Patrick Rohrc8f41cd2022-11-15 22:46:10 -0800940 # Can be used for both host and device targets.
Patrick Rohr92d74122022-10-21 15:50:52 -0700941 module_type = 'cc_binary'
942 module = Module(module_type, bp_module_name, gn_target_name)
943 elif target.type == 'static_library':
944 module = Module('cc_library_static', bp_module_name, gn_target_name)
945 elif target.type == 'shared_library':
946 module = Module('cc_library_shared', bp_module_name, gn_target_name)
947 elif target.type == 'source_set':
Patrick Rohr82e96f32022-11-16 22:09:48 -0800948 module = Module('cc_defaults', bp_module_name, gn_target_name)
Patrick Rohr92d74122022-10-21 15:50:52 -0700949 elif target.type == 'group':
950 # "group" targets are resolved recursively by gn_utils.get_target().
951 # There's nothing we need to do at this level for them.
952 return None
953 elif target.type == 'proto_library':
954 module = create_proto_modules(blueprint, gn, target)
955 if module is None:
956 return None
957 elif target.type == 'action':
958 if 'gen_amalgamated_sql_metrics' in target.name:
959 module = create_amalgamated_sql_metrics_module(blueprint, target)
Patrick Rohr07876662022-11-15 22:55:23 -0800960 elif re.match('.*gen_cc_.*_descriptor$', target.name):
Patrick Rohr92d74122022-10-21 15:50:52 -0700961 module = create_cc_proto_descriptor_module(blueprint, target)
962 elif target.type == 'action' and \
Patrick Rohr07876662022-11-15 22:55:23 -0800963 target.name == gn_utils.GEN_VERSION_TARGET:
Patrick Rohr92d74122022-10-21 15:50:52 -0700964 module = create_gen_version_module(blueprint, target, bp_module_name)
965 else:
Patrick Rohre1a853e2022-10-26 12:31:39 -0700966 module = create_action_module(blueprint, target)
Mohannad Farragf076f3e2022-10-31 17:45:28 +0000967 elif target.type == 'action_foreach':
Mohannad Farragbab6c892022-11-02 14:09:46 +0000968 module = create_action_foreach_modules(blueprint, target)
Patrick Rohr59a76652022-10-26 12:36:56 -0700969 elif target.type == 'copy':
970 # TODO: careful now! copy targets are not supported yet, but this will stop
971 # traversing the dependency tree. For //base:base, this is not a big
972 # problem as libicu contains the only copy target which happens to be a
973 # leaf node.
974 return None
Patrick Rohrad440602022-11-10 22:09:04 -0800975 elif target.type == 'java_group':
976 # Java targets are handled outside of create_modules_from_target.
977 return None
Patrick Rohr92d74122022-10-21 15:50:52 -0700978 else:
979 raise Error('Unknown target %s (%s)' % (target.name, target.type))
980
981 blueprint.add_module(module)
Patrick Rohr92d74122022-10-21 15:50:52 -0700982 module.init_rc = target_initrc.get(target.name, [])
983 module.srcs.update(
984 gn_utils.label_to_path(src)
985 for src in target.sources
Motomu Utsumif951e502022-11-07 19:31:15 +0900986 if is_supported_source_file(src) and not src.startswith("//out/test"))
Patrick Rohr92d74122022-10-21 15:50:52 -0700987
Patrick Rohr3b5ff762022-11-16 10:22:16 -0800988 # Add arch-specific properties
989 for arch_name, arch in target.arch.items():
Motomu Utsumi40f95c52022-11-17 19:39:13 +0900990 module.target[arch_name].srcs.update(
991 gn_utils.label_to_path(src)
992 for src in arch.sources
993 if is_supported_source_file(src) and not src.startswith("//out/test"))
Patrick Rohr3b5ff762022-11-16 10:22:16 -0800994
Mohannad Farragbaf0d572022-11-22 11:53:54 +0000995 module.rtti = target.rtti
996
Patrick Rohr92d74122022-10-21 15:50:52 -0700997 if target.type in gn_utils.LINKER_UNIT_TYPES:
Motomu Utsumic34b1372022-11-17 22:15:51 +0900998 set_module_flags(module, target.cflags, target.defines)
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900999 set_module_include_dirs(module, target.cflags, target.include_dirs)
Motomu Utsumif0f47682022-11-17 22:34:39 +09001000 # TODO: set_module_xxx is confusing, apply similar function to module and target in better way.
1001 for arch_name, arch in target.arch.items():
1002 set_module_flags(module.target[arch_name], arch.cflags, arch.defines)
1003 set_module_include_dirs(module.target[arch_name], arch.cflags, arch.include_dirs)
Patrick Rohr92d74122022-10-21 15:50:52 -07001004
Patrick Rohra6ce0232022-11-16 22:09:01 -08001005 if module.is_compiled():
Patrick Rohrc8f41cd2022-11-15 22:46:10 -08001006 module.host_supported = target.host_supported()
1007 module.device_supported = target.device_supported()
1008
Patrick Rohr92d74122022-10-21 15:50:52 -07001009 # Don't try to inject library/source dependencies into genrules or
1010 # filegroups because they are not compiled in the traditional sense.
1011 module.defaults = [defaults_module]
1012 for lib in target.libs:
1013 # Generally library names should be mangled as 'libXXX', unless they
1014 # are HAL libraries (e.g., android.hardware.health@2.0) or AIDL c++ / NDK
1015 # libraries (e.g. "android.hardware.power.stats-V1-cpp")
1016 android_lib = lib if '@' in lib or "-cpp" in lib or "-ndk" in lib \
1017 else 'lib' + lib
1018 if lib in shared_library_allowlist:
1019 module.add_android_shared_lib(android_lib)
1020 if lib in static_library_allowlist:
1021 module.add_android_static_lib(android_lib)
1022
Patrick Rohrd9dd3b92022-11-09 16:15:30 -08001023 # Remove prohibited include directories
1024 module.local_include_dirs = [d for d in module.local_include_dirs
1025 if d not in local_include_dirs_denylist]
1026
Patrick Rohr92d74122022-10-21 15:50:52 -07001027 # dep_name is an unmangled GN target name (e.g. //foo:bar(toolchain)).
Motomu Utsumif1daa232022-11-08 13:28:37 +09001028 # Currently, only one module is generated from target even target has multiple toolchains.
1029 # And module is generated based on the first visited target.
1030 # Sort deps before iteration to make result deterministic.
1031 all_deps = sorted(target.deps | target.source_set_deps | target.transitive_proto_deps)
Patrick Rohr92d74122022-10-21 15:50:52 -07001032 for dep_name in all_deps:
Patrick Rohr5cc46e02022-10-26 14:32:45 -07001033 # |builtin_deps| override GN deps with Android-specific ones. See the
1034 # config in the top of this file.
Patrick Rohr07876662022-11-15 22:55:23 -08001035 if dep_name in builtin_deps:
1036 builtin_deps[dep_name](module)
Patrick Rohr5cc46e02022-10-26 14:32:45 -07001037 continue
1038
Patrick Rohr92d74122022-10-21 15:50:52 -07001039 dep_module = create_modules_from_target(blueprint, gn, dep_name)
1040
Motomu Utsumie246feb2022-11-01 17:25:56 +09001041 # TODO: Proper dependency check for genrule.
1042 # Currently, only propagating genrule dependencies.
1043 # Also, currently, all the dependencies are propagated upwards.
1044 # in gn, public_deps should be propagated but deps should not.
1045 # Not sure this information is available in the desc.json.
1046 # Following rule works for adding android_runtime_jni_headers to base:base.
1047 # If this doesn't work for other target, hardcoding for specific target
1048 # might be better.
1049 if module.type == "genrule" and dep_module.type == "genrule":
1050 module.genrule_headers.add(dep_module.name)
1051 module.genrule_headers.update(dep_module.genrule_headers)
1052
Patrick Rohra6ce0232022-11-16 22:09:01 -08001053 # For cc_defaults, filegroups, and genrule, recurse but don't apply the
1054 # deps.
1055 if not module.is_compiled():
Patrick Rohr92d74122022-10-21 15:50:52 -07001056 continue
1057
Patrick Rohr92d74122022-10-21 15:50:52 -07001058 if dep_module is None:
1059 continue
1060 if dep_module.type == 'cc_library_shared':
1061 module.shared_libs.add(dep_module.name)
1062 elif dep_module.type == 'cc_library_static':
1063 module.static_libs.add(dep_module.name)
Patrick Rohr82e96f32022-11-16 22:09:48 -08001064 elif dep_module.type == 'cc_defaults':
1065 module.defaults.append(dep_module.name)
Patrick Rohr92d74122022-10-21 15:50:52 -07001066 elif dep_module.type == 'genrule':
Mohannad Farrag631443e2022-11-21 16:17:01 +00001067 for arch_name, arch in target.arch.items():
1068 if dep_module.name.endswith(arch_name):
1069 add_genrule_per_arch(module.target[arch_name], dep_module, module.type)
1070 if dep_module.name.endswith("_gen"):
1071 module.srcs.update(dep_module.genrule_srcs)
1072 module.generated_headers.update(dep_module.genrule_headers)
1073 module.export_generated_headers.update(dep_module.genrule_headers)
Patrick Rohr92d74122022-10-21 15:50:52 -07001074 elif dep_module.type == 'cc_binary':
1075 continue # Ignore executables deps (used by cmdline integration tests).
1076 else:
1077 raise Error('Unknown dep %s (%s) for target %s' %
1078 (dep_module.name, dep_module.type, module.name))
1079
Patrick Rohrb51878f2022-11-16 23:49:03 -08001080 for arch_name, arch in target.arch.items():
1081 for dep_name in arch.deps:
1082 dep_module = create_modules_from_target(blueprint, gn, dep_name)
1083 # Arch-specific dependencies currently only include cc_library_static.
1084 # Revisit this approach once we need to support more target types.
1085 if dep_module.type == 'cc_library_static':
1086 module.target[arch_name].static_libs.add(dep_module.name)
1087 else:
1088 raise Error('Unsupported arch-specific dependency %s of target %s with type %s' %
1089 (dep_module.name, target.name, dep_module.type))
1090
Patrick Rohr92d74122022-10-21 15:50:52 -07001091 return module
1092
Patrick Rohrb18aca22022-11-04 15:07:32 -07001093def create_java_module(blueprint, gn):
1094 bp_module_name = module_prefix + 'java'
1095 module = Module('java_library', bp_module_name, '//gn:java')
Mohannad Farrag21562d62022-11-07 13:09:31 +00001096 module.srcs.update([gn_utils.label_to_path(source) for source in gn.java_sources])
Patrick Rohrb18aca22022-11-04 15:07:32 -07001097 blueprint.add_module(module)
Patrick Rohr92d74122022-10-21 15:50:52 -07001098
Patrick Rohr6ef22722022-11-18 18:24:01 -08001099def update_jni_registration_module(module, gn):
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001100 # TODO: deny list is in the arg of jni_registration_generator.py. Should not be hardcoded
1101 deny_list = [
1102 '//base/android/java/src/org/chromium/base/library_loader/LibraryLoader.java',
1103 '//base/android/java/src/org/chromium/base/library_loader/LibraryPrefetcher.java',
1104 '//base/android/java/src/org/chromium/base/process_launcher/ChildProcessService.java',
1105 '//base/android/java/src/org/chromium/base/SysUtils.java']
1106
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001107 # TODO: java_sources might not contain all the required java files
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001108 module.srcs.update([gn_utils.label_to_path(source)
1109 for source in gn.java_sources if source not in deny_list])
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001110
Motomu Utsumia71281c2022-11-18 15:19:00 +09001111def create_blueprint_for_targets(gn, targets):
Patrick Rohr92d74122022-10-21 15:50:52 -07001112 """Generate a blueprint for a list of GN targets."""
1113 blueprint = Blueprint()
1114
1115 # Default settings used by all modules.
1116 defaults = Module('cc_defaults', defaults_module, '//gn:default_deps')
Patrick Rohr92d74122022-10-21 15:50:52 -07001117 defaults.cflags = [
Patrick Rohr3ce74772022-11-11 14:19:58 -08001118 '-DGOOGLE_PROTOBUF_NO_RTTI',
Patrick Rohr92d74122022-10-21 15:50:52 -07001119 '-Wno-error=return-type',
Patrick Rohr3a1ec1d2022-10-31 13:30:17 -07001120 '-Wno-non-virtual-dtor',
Patrick Rohr5c700022022-11-08 19:33:07 -08001121 '-Wno-macro-redefined',
Patrick Rohr98065152022-10-31 14:49:58 -07001122 '-Wno-missing-field-initializers',
Patrick Rohr92d74122022-10-21 15:50:52 -07001123 '-Wno-sign-compare',
1124 '-Wno-sign-promo',
1125 '-Wno-unused-parameter',
Mohannad Farrag54d52442022-11-21 16:27:02 +00001126 '-Wno-null-pointer-subtraction', # Needed to libevent
Mohannad Farragd98a96d2022-11-10 14:56:19 +00001127 '-Wno-deprecated-non-prototype', # needed for zlib
Patrick Rohr92d74122022-10-21 15:50:52 -07001128 '-fvisibility=hidden',
Motomu Utsumiba020942022-11-14 15:15:41 +09001129 '-Wno-ambiguous-reversed-operator', # needed for icui18n
Motomu Utsumib1ec8782022-11-14 15:25:57 +09001130 '-Wno-unreachable-code-loop-increment', # needed for icui18n
Patrick Rohr92d74122022-10-21 15:50:52 -07001131 '-O2',
1132 ]
Patrick Rohrc03f1bb2022-11-18 16:13:17 -08001133 # Chromium builds do not add a dependency for headers found inside the
1134 # sysroot, so they are added globally via defaults.
1135 defaults.target['android'].header_libs = [
1136 'media_ndk_headers',
1137 'jni_headers',
1138 ]
Patrick Rohr5446df82022-11-18 14:54:55 -08001139 defaults.target['host'].cflags = [
1140 # -DANDROID is added by default but target.defines contain -DANDROID if
1141 # it's required. So adding -UANDROID to cancel default -DANDROID if it's
1142 # not specified.
1143 # Note: -DANDROID is not consistently applied across the chromium code
1144 # base, so it is removed unconditionally for host targets.
1145 '-UANDROID',
1146 ]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001147 defaults.stl = 'none'
Patrick Rohr92d74122022-10-21 15:50:52 -07001148 blueprint.add_module(defaults)
Patrick Rohr344b2472022-10-25 11:32:15 -07001149
Patrick Rohr92d74122022-10-21 15:50:52 -07001150 for target in targets:
1151 create_modules_from_target(blueprint, gn, target)
Patrick Rohrb18aca22022-11-04 15:07:32 -07001152
1153 create_java_module(blueprint, gn)
Patrick Rohr6ef22722022-11-18 18:24:01 -08001154 for module in blueprint.modules.values():
1155 if 'cronet_jni_registration' in module.name:
1156 update_jni_registration_module(module, gn)
Patrick Rohra7d029d2022-11-08 12:23:11 -08001157
1158 # Merge in additional hardcoded arguments.
1159 for module in blueprint.modules.values():
1160 for key, add_val in additional_args.get(module.name, []):
1161 curr = getattr(module, key)
1162 if add_val and isinstance(add_val, set) and isinstance(curr, set):
1163 curr.update(add_val)
1164 elif isinstance(add_val, str) and (not curr or isinstance(curr, str)):
1165 setattr(module, key, add_val)
1166 elif isinstance(add_val, bool) and (not curr or isinstance(curr, bool)):
1167 setattr(module, key, add_val)
1168 elif isinstance(add_val, dict) and isinstance(curr, dict):
1169 curr.update(add_val)
1170 elif isinstance(add_val, dict) and isinstance(curr, Target):
1171 curr.__dict__.update(add_val)
1172 else:
1173 raise Error('Unimplemented type %r of additional_args: %r' %
1174 (type(add_val), key))
1175
Patrick Rohr92d74122022-10-21 15:50:52 -07001176 return blueprint
1177
1178
1179def main():
1180 parser = argparse.ArgumentParser(
1181 description='Generate Android.bp from a GN description.')
1182 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001183 '--desc',
Motomu Utsumi879dec82022-11-18 15:25:12 +09001184 help='GN description (e.g., gn desc out --format=json --all-toolchains "//*".' +
1185 'You can specify multiple --desc options for different target_cpu',
1186 required=True,
1187 action='append'
Patrick Rohr92d74122022-10-21 15:50:52 -07001188 )
1189 parser.add_argument(
1190 '--extras',
1191 help='Extra targets to include at the end of the Blueprint file',
1192 default=os.path.join(gn_utils.repo_root(), 'Android.bp.extras'),
1193 )
1194 parser.add_argument(
1195 '--output',
1196 help='Blueprint file to create',
1197 default=os.path.join(gn_utils.repo_root(), 'Android.bp'),
1198 )
1199 parser.add_argument(
Patrick Rohr16228942022-10-26 14:00:26 -07001200 '-v',
1201 '--verbose',
1202 help='Print debug logs.',
1203 action='store_true',
1204 )
1205 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001206 'targets',
1207 nargs=argparse.REMAINDER,
Patrick Rohr1aa504a2022-10-25 10:30:42 -07001208 help='Targets to include in the blueprint (e.g., "//:perfetto_tests")'
1209 )
Patrick Rohr92d74122022-10-21 15:50:52 -07001210 args = parser.parse_args()
1211
Patrick Rohr16228942022-10-26 14:00:26 -07001212 if args.verbose:
1213 log.basicConfig(format='%(levelname)s:%(funcName)s:%(message)s', level=log.DEBUG)
1214
Patrick Rohrd0077b72022-11-15 12:43:26 -08001215 targets = args.targets or default_targets
Motomu Utsumi879dec82022-11-18 15:25:12 +09001216 gn = gn_utils.GnParser()
1217 for desc_file in args.desc:
1218 with open(desc_file) as f:
1219 desc = json.load(f)
1220 for target in targets:
1221 gn.parse_gn_desc(desc, target)
Motomu Utsumia71281c2022-11-18 15:19:00 +09001222 blueprint = create_blueprint_for_targets(gn, targets)
Patrick Rohr92d74122022-10-21 15:50:52 -07001223 project_root = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
1224 tool_name = os.path.relpath(os.path.abspath(__file__), project_root)
1225
Patrick Rohr92d74122022-10-21 15:50:52 -07001226 # Add any proto groups to the blueprint.
1227 for l_name, t_names in proto_groups.items():
1228 create_proto_group_modules(blueprint, gn, l_name, t_names)
1229
1230 output = [
Patrick Rohr5478b392022-10-25 09:58:50 -07001231 """// Copyright (C) 2022 The Android Open Source Project
Patrick Rohr92d74122022-10-21 15:50:52 -07001232//
1233// Licensed under the Apache License, Version 2.0 (the "License");
1234// you may not use this file except in compliance with the License.
1235// You may obtain a copy of the License at
1236//
1237// http://www.apache.org/licenses/LICENSE-2.0
1238//
1239// Unless required by applicable law or agreed to in writing, software
1240// distributed under the License is distributed on an "AS IS" BASIS,
1241// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1242// See the License for the specific language governing permissions and
1243// limitations under the License.
1244//
1245// This file is automatically generated by %s. Do not edit.
1246""" % (tool_name)
1247 ]
1248 blueprint.to_string(output)
Patrick Rohrcb98e9b2022-10-25 09:57:02 -07001249 if os.path.exists(args.extras):
1250 with open(args.extras, 'r') as r:
1251 for line in r:
1252 output.append(line.rstrip("\n\r"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001253
1254 out_files = []
1255
1256 # Generate the Android.bp file.
1257 out_files.append(args.output + '.swp')
1258 with open(out_files[-1], 'w') as f:
1259 f.write('\n'.join(output))
1260 # Text files should have a trailing EOL.
1261 f.write('\n')
1262
Patrick Rohr94693eb2022-10-25 10:09:16 -07001263 return 0
Patrick Rohr92d74122022-10-21 15:50:52 -07001264
1265
1266if __name__ == '__main__':
1267 sys.exit(main())