blob: 8a42011df69cba01be5e46a64ef45212cb8e855c [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 Farrag627dc912022-11-11 19:00:26 +0000130 # When a code is compiled under rtti(cronet) that depends on another code(net)
131 # that doesn't depend on rtti. undefined symbol: typeinfo 'class' errors appears.
132 ('rtti', True), # go/undefined-symbol-typeinfo
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000133 ],
Patrick Rohr92d74122022-10-21 15:50:52 -0700134}
135
Patrick Rohr92d74122022-10-21 15:50:52 -0700136# Android equivalents for third-party libraries that the upstream project
137# depends on.
138builtin_deps = {
Patrick Rohr14ee0932022-11-15 12:10:27 -0800139 '//net/tools/root_store_tool:root_store_tool':
140 lambda x: None,
Patrick Rohr92d74122022-10-21 15:50:52 -0700141}
142
143# ----------------------------------------------------------------------------
144# End of configuration.
145# ----------------------------------------------------------------------------
146
147
148class Error(Exception):
149 pass
150
151
152class ThrowingArgumentParser(argparse.ArgumentParser):
153
154 def __init__(self, context):
155 super(ThrowingArgumentParser, self).__init__()
156 self.context = context
157
158 def error(self, message):
159 raise Error('%s: %s' % (self.context, message))
160
161
162def write_blueprint_key_value(output, name, value, sort=True):
163 """Writes a Blueprint key-value pair to the output"""
164
165 if isinstance(value, bool):
166 if value:
167 output.append(' %s: true,' % name)
168 else:
169 output.append(' %s: false,' % name)
170 return
171 if not value:
172 return
173 if isinstance(value, set):
174 value = sorted(value)
175 if isinstance(value, list):
176 output.append(' %s: [' % name)
177 for item in sorted(value) if sort else value:
178 output.append(' "%s",' % item)
179 output.append(' ],')
180 return
181 if isinstance(value, Target):
182 value.to_string(output)
183 return
184 if isinstance(value, dict):
185 kv_output = []
186 for k, v in value.items():
187 write_blueprint_key_value(kv_output, k, v)
188
189 output.append(' %s: {' % name)
190 for line in kv_output:
191 output.append(' %s' % line)
192 output.append(' },')
193 return
194 output.append(' %s: "%s",' % (name, value))
195
196
197class Target(object):
198 """A target-scoped part of a module"""
199
200 def __init__(self, name):
201 self.name = name
Patrick Rohr5d399b32022-11-16 10:19:55 -0800202 self.srcs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700203 self.shared_libs = set()
204 self.static_libs = set()
205 self.whole_static_libs = set()
206 self.cflags = set()
207 self.dist = dict()
208 self.strip = dict()
209 self.stl = None
210
211 def to_string(self, output):
212 nested_out = []
Patrick Rohr5d399b32022-11-16 10:19:55 -0800213 self._output_field(nested_out, 'srcs')
Patrick Rohr92d74122022-10-21 15:50:52 -0700214 self._output_field(nested_out, 'shared_libs')
215 self._output_field(nested_out, 'static_libs')
216 self._output_field(nested_out, 'whole_static_libs')
217 self._output_field(nested_out, 'cflags')
218 self._output_field(nested_out, 'stl')
219 self._output_field(nested_out, 'dist')
220 self._output_field(nested_out, 'strip')
221
222 if nested_out:
223 output.append(' %s: {' % self.name)
224 for line in nested_out:
225 output.append(' %s' % line)
226 output.append(' },')
227
228 def _output_field(self, output, name, sort=True):
229 value = getattr(self, name)
230 return write_blueprint_key_value(output, name, value, sort)
231
232
233class Module(object):
234 """A single module (e.g., cc_binary, cc_test) in a blueprint."""
235
236 def __init__(self, mod_type, name, gn_target):
237 self.type = mod_type
238 self.gn_target = gn_target
239 self.name = name
240 self.srcs = set()
Patrick Rohr07876662022-11-15 22:55:23 -0800241 self.comment = 'GN: ' + gn_target
Patrick Rohr92d74122022-10-21 15:50:52 -0700242 self.shared_libs = set()
243 self.static_libs = set()
244 self.whole_static_libs = set()
245 self.runtime_libs = set()
246 self.tools = set()
247 self.cmd = None
248 self.host_supported = False
Patrick Rohrcdda6322022-11-15 22:44:16 -0800249 self.device_supported = True
Patrick Rohr92d74122022-10-21 15:50:52 -0700250 self.vendor_available = False
251 self.init_rc = set()
252 self.out = set()
253 self.export_include_dirs = set()
254 self.generated_headers = set()
255 self.export_generated_headers = set()
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800256 self.export_static_lib_headers = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700257 self.defaults = set()
258 self.cflags = set()
259 self.include_dirs = set()
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900260 self.local_include_dirs = []
Patrick Rohr92d74122022-10-21 15:50:52 -0700261 self.header_libs = set()
262 self.required = set()
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700263 self.tool_files = set()
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800264 # target contains a dict of Targets indexed by os_arch.
265 # example: { 'android_x86': Target('android_x86')
266 self.target = dict()
267 self.target['android'] = Target('android')
Patrick Rohr82e40742022-11-16 10:20:39 -0800268 self.target['android_x86'] = Target('android_x86')
269 self.target['android_x86_64'] = Target('android_x86_64')
270 self.target['android_arm'] = Target('android_arm')
271 self.target['android_arm64'] = Target('android_arm64')
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800272 self.target['host'] = Target('host')
Patrick Rohr92d74122022-10-21 15:50:52 -0700273 self.stl = None
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700274 self.cpp_std = None
Patrick Rohr92d74122022-10-21 15:50:52 -0700275 self.dist = dict()
276 self.strip = dict()
277 self.data = set()
278 self.apex_available = set()
279 self.min_sdk_version = None
280 self.proto = dict()
Patrick Rohrd90025f2022-11-11 14:18:35 -0800281 self.linker_scripts = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700282 # The genrule_XXX below are properties that must to be propagated back
283 # on the module(s) that depend on the genrule.
284 self.genrule_headers = set()
285 self.genrule_srcs = set()
286 self.genrule_shared_libs = set()
Patrick Rohra1a27872022-10-31 11:57:14 -0700287 self.genrule_header_libs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700288 self.version_script = None
289 self.test_suites = set()
290 self.test_config = None
291 self.stubs = {}
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000292 self.cppflags = set()
293 self.rtti = False
Patrick Rohr92d74122022-10-21 15:50:52 -0700294
295 def to_string(self, output):
296 if self.comment:
297 output.append('// %s' % self.comment)
298 output.append('%s {' % self.type)
299 self._output_field(output, 'name')
300 self._output_field(output, 'srcs')
301 self._output_field(output, 'shared_libs')
302 self._output_field(output, 'static_libs')
303 self._output_field(output, 'whole_static_libs')
304 self._output_field(output, 'runtime_libs')
305 self._output_field(output, 'tools')
306 self._output_field(output, 'cmd', sort=False)
307 if self.host_supported:
308 self._output_field(output, 'host_supported')
Patrick Rohrcdda6322022-11-15 22:44:16 -0800309 if not self.device_supported:
310 self._output_field(output, 'device_supported')
Patrick Rohr92d74122022-10-21 15:50:52 -0700311 if self.vendor_available:
312 self._output_field(output, 'vendor_available')
313 self._output_field(output, 'init_rc')
314 self._output_field(output, 'out')
315 self._output_field(output, 'export_include_dirs')
316 self._output_field(output, 'generated_headers')
317 self._output_field(output, 'export_generated_headers')
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800318 self._output_field(output, 'export_static_lib_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -0700319 self._output_field(output, 'defaults')
320 self._output_field(output, 'cflags')
321 self._output_field(output, 'include_dirs')
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900322 self._output_field(output, 'local_include_dirs', sort=False)
Patrick Rohr92d74122022-10-21 15:50:52 -0700323 self._output_field(output, 'header_libs')
324 self._output_field(output, 'required')
325 self._output_field(output, 'dist')
326 self._output_field(output, 'strip')
327 self._output_field(output, 'tool_files')
328 self._output_field(output, 'data')
329 self._output_field(output, 'stl')
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700330 self._output_field(output, 'cpp_std')
Patrick Rohr92d74122022-10-21 15:50:52 -0700331 self._output_field(output, 'apex_available')
332 self._output_field(output, 'min_sdk_version')
333 self._output_field(output, 'version_script')
334 self._output_field(output, 'test_suites')
335 self._output_field(output, 'test_config')
336 self._output_field(output, 'stubs')
337 self._output_field(output, 'proto')
Patrick Rohrd90025f2022-11-11 14:18:35 -0800338 self._output_field(output, 'linker_scripts')
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000339 self._output_field(output, 'cppflags')
340 if self.rtti:
341 self._output_field(output, 'rtti')
Patrick Rohr92d74122022-10-21 15:50:52 -0700342
343 target_out = []
Patrick Rohr09ee70e2022-11-16 15:20:03 -0800344 for arch, target in sorted(self.target.items()):
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800345 # _output_field calls getattr(self, arch).
346 setattr(self, arch, target)
347 self._output_field(target_out, arch)
348
Patrick Rohr92d74122022-10-21 15:50:52 -0700349 if target_out:
350 output.append(' target: {')
351 for line in target_out:
352 output.append(' %s' % line)
353 output.append(' },')
354
Patrick Rohr92d74122022-10-21 15:50:52 -0700355 output.append('}')
356 output.append('')
357
358 def add_android_static_lib(self, lib):
359 if self.type == 'cc_binary_host':
360 raise Exception('Adding Android static lib for host tool is unsupported')
361 elif self.host_supported:
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800362 self.target['android'].static_libs.add(lib)
Patrick Rohr92d74122022-10-21 15:50:52 -0700363 else:
364 self.static_libs.add(lib)
365
366 def add_android_shared_lib(self, lib):
367 if self.type == 'cc_binary_host':
368 raise Exception('Adding Android shared lib for host tool is unsupported')
369 elif self.host_supported:
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800370 self.target['android'].shared_libs.add(lib)
Patrick Rohr92d74122022-10-21 15:50:52 -0700371 else:
372 self.shared_libs.add(lib)
373
374 def _output_field(self, output, name, sort=True):
375 value = getattr(self, name)
376 return write_blueprint_key_value(output, name, value, sort)
377
Patrick Rohra6ce0232022-11-16 22:09:01 -0800378 def is_compiled(self):
379 return self.type not in ('genrule', 'filegroup', 'cc_defaults')
380
Patrick Rohr92d74122022-10-21 15:50:52 -0700381
382class Blueprint(object):
383 """In-memory representation of an Android.bp file."""
384
385 def __init__(self):
386 self.modules = {}
387
388 def add_module(self, module):
389 """Adds a new module to the blueprint, replacing any existing module
390 with the same name.
391
392 Args:
393 module: Module instance.
394 """
395 self.modules[module.name] = module
396
397 def to_string(self, output):
Patrick Rohr23f26192022-10-25 09:45:22 -0700398 for m in sorted(self.modules.values(), key=lambda m: m.name):
Patrick Rohr92d74122022-10-21 15:50:52 -0700399 m.to_string(output)
400
401
402def label_to_module_name(label):
403 """Turn a GN label (e.g., //:perfetto_tests) into a module name."""
Patrick Rohr07876662022-11-15 22:55:23 -0800404 module = re.sub(r'^//:?', '', label)
Patrick Rohr92d74122022-10-21 15:50:52 -0700405 module = re.sub(r'[^a-zA-Z0-9_]', '_', module)
Motomu Utsumi3fde1482022-11-14 15:55:21 +0900406
Patrick Rohr92d74122022-10-21 15:50:52 -0700407 if not module.startswith(module_prefix):
408 return module_prefix + module
409 return module
410
411
412def is_supported_source_file(name):
413 """Returns True if |name| can appear in a 'srcs' list."""
Patrick Rohrf9f3a992022-11-10 19:40:32 -0800414 return os.path.splitext(name)[1] in ['.c', '.cc', '.cpp', '.java', '.proto', '.S']
Patrick Rohr92d74122022-10-21 15:50:52 -0700415
416
417def create_proto_modules(blueprint, gn, target):
418 """Generate genrules for a proto GN target.
419
420 GN actions are used to dynamically generate files during the build. The
421 Soong equivalent is a genrule. This function turns a specific kind of
422 genrule which turns .proto files into source and header files into a pair
423 equivalent genrules.
424
425 Args:
426 blueprint: Blueprint instance which is being generated.
427 target: gn_utils.Target object.
428
429 Returns:
430 The source_genrule module.
431 """
432 assert (target.type == 'proto_library')
433
Motomu Utsumibd4013f2022-11-17 16:06:05 +0900434 protoc_gn_target_name = gn.get_target('//third_party/protobuf:protoc').name
Motomu Utsumid58c1dc2022-11-16 18:04:46 +0900435 protoc_module_name = label_to_module_name(protoc_gn_target_name)
436 tools = {protoc_module_name}
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900437 cpp_out_dir = '$(genDir)/%s/%s/' % (tree_path, target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700438 target_module_name = label_to_module_name(target.name)
439
440 # In GN builds the proto path is always relative to the output directory
441 # (out/tmp.xxx).
Motomu Utsumid58c1dc2022-11-16 18:04:46 +0900442 cmd = ['$(location %s)' % protoc_module_name]
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900443 cmd += ['--proto_path=%s/%s' % (tree_path, target.proto_in_dir)]
Patrick Rohr92d74122022-10-21 15:50:52 -0700444
445 if buildtools_protobuf_src in target.proto_paths:
446 cmd += ['--proto_path=%s' % android_protobuf_src]
447
448 # We don't generate any targets for source_set proto modules because
449 # they will be inlined into other modules if required.
450 if target.proto_plugin == 'source_set':
451 return None
452
453 # Descriptor targets only generate a single target.
454 if target.proto_plugin == 'descriptor':
455 out = '{}.bin'.format(target_module_name)
456
457 cmd += ['--descriptor_set_out=$(out)']
458 cmd += ['$(in)']
459
460 descriptor_module = Module('genrule', target_module_name, target.name)
461 descriptor_module.cmd = ' '.join(cmd)
462 descriptor_module.out = [out]
463 descriptor_module.tools = tools
464 blueprint.add_module(descriptor_module)
465
466 # Recursively extract the .proto files of all the dependencies and
467 # add them to srcs.
468 descriptor_module.srcs.update(
469 gn_utils.label_to_path(src) for src in target.sources)
470 for dep in target.transitive_proto_deps:
471 current_target = gn.get_target(dep)
472 descriptor_module.srcs.update(
473 gn_utils.label_to_path(src) for src in current_target.sources)
474
475 return descriptor_module
476
477 # We create two genrules for each proto target: one for the headers and
478 # another for the sources. This is because the module that depends on the
479 # generated files needs to declare two different types of dependencies --
480 # source files in 'srcs' and headers in 'generated_headers' -- and it's not
481 # valid to generate .h files from a source dependency and vice versa.
482 source_module_name = target_module_name + '_gen'
483 source_module = Module('genrule', source_module_name, target.name)
484 blueprint.add_module(source_module)
485 source_module.srcs.update(
486 gn_utils.label_to_path(src) for src in target.sources)
487
488 header_module = Module('genrule', source_module_name + '_headers',
489 target.name)
490 blueprint.add_module(header_module)
491 header_module.srcs = set(source_module.srcs)
492
493 # TODO(primiano): at some point we should remove this. This was introduced
494 # by aosp/1108421 when adding "protos/" to .proto include paths, in order to
495 # avoid doing multi-repo changes and allow old clients in the android tree
496 # to still do the old #include "perfetto/..." rather than
497 # #include "protos/perfetto/...".
498 header_module.export_include_dirs = {'.', 'protos'}
Patrick Rohr2267a0a2022-11-08 18:59:34 -0800499 # Since the .cc file and .h get created by a different gerule target, they
500 # are not put in the same intermediate path, so local includes do not work
501 # without explictily exporting the include dir.
502 header_module.export_include_dirs.add(target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700503
504 source_module.genrule_srcs.add(':' + source_module.name)
505 source_module.genrule_headers.add(header_module.name)
506
507 if target.proto_plugin == 'proto':
508 suffixes = ['pb']
509 source_module.genrule_shared_libs.add('libprotobuf-cpp-lite')
510 cmd += ['--cpp_out=lite=true:' + cpp_out_dir]
511 elif target.proto_plugin == 'protozero':
512 suffixes = ['pbzero']
513 plugin = create_modules_from_target(blueprint, gn, protozero_plugin)
514 tools.add(plugin.name)
515 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
516 cmd += ['--plugin_out=wrapper_namespace=pbzero:' + cpp_out_dir]
517 elif target.proto_plugin == 'cppgen':
518 suffixes = ['gen']
519 plugin = create_modules_from_target(blueprint, gn, cppgen_plugin)
520 tools.add(plugin.name)
521 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
522 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
523 elif target.proto_plugin == 'ipc':
524 suffixes = ['ipc']
525 plugin = create_modules_from_target(blueprint, gn, ipc_plugin)
526 tools.add(plugin.name)
527 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
528 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
529 else:
530 raise Error('Unsupported proto plugin: %s' % target.proto_plugin)
531
532 cmd += ['$(in)']
533 source_module.cmd = ' '.join(cmd)
534 header_module.cmd = source_module.cmd
535 source_module.tools = tools
536 header_module.tools = tools
537
538 for sfx in suffixes:
539 source_module.out.update('%s/%s' %
540 (tree_path, src.replace('.proto', '.%s.cc' % sfx))
541 for src in source_module.srcs)
542 header_module.out.update('%s/%s' %
543 (tree_path, src.replace('.proto', '.%s.h' % sfx))
544 for src in header_module.srcs)
545 return source_module
546
547
548def create_amalgamated_sql_metrics_module(blueprint, target):
549 bp_module_name = label_to_module_name(target.name)
550 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700551 module.tool_files.add('tools/gen_amalgamated_sql_metrics.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700552 module.cmd = ' '.join([
553 '$(location tools/gen_amalgamated_sql_metrics.py)',
554 '--cpp_out=$(out)',
555 '$(in)',
556 ])
557 module.genrule_headers.add(module.name)
558 module.out.update(target.outputs)
559 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
560 blueprint.add_module(module)
561 return module
562
563
564def create_cc_proto_descriptor_module(blueprint, target):
565 bp_module_name = label_to_module_name(target.name)
566 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700567 module.tool_files.add('tools/gen_cc_proto_descriptor.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700568 module.cmd = ' '.join([
569 '$(location tools/gen_cc_proto_descriptor.py)', '--gen_dir=$(genDir)',
570 '--cpp_out=$(out)', '$(in)'
571 ])
572 module.genrule_headers.add(module.name)
573 module.srcs.update(
574 ':' + label_to_module_name(dep) for dep in target.proto_deps)
575 module.srcs.update(
576 gn_utils.label_to_path(src)
577 for src in target.inputs
578 if "tmp.gn_utils" not in src)
579 module.out.update(target.outputs)
580 blueprint.add_module(module)
581 return module
582
583
584def create_gen_version_module(blueprint, target, bp_module_name):
585 module = Module('genrule', bp_module_name, gn_utils.GEN_VERSION_TARGET)
586 script_path = gn_utils.label_to_path(target.script)
587 module.genrule_headers.add(bp_module_name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700588 module.tool_files.add(script_path)
Patrick Rohr92d74122022-10-21 15:50:52 -0700589 module.out.update(target.outputs)
590 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
591 module.cmd = ' '.join([
592 'python3 $(location %s)' % script_path, '--no_git',
593 '--changelog=$(location CHANGELOG)', '--cpp_out=$(out)'
594 ])
595 blueprint.add_module(module)
596 return module
597
598
599def create_proto_group_modules(blueprint, gn, module_name, target_names):
600 # TODO(lalitm): today, we're only adding a Java lite module because that's
601 # the only one used in practice. In the future, if we need other target types
602 # (e.g. C++, Java full etc.) add them here.
603 bp_module_name = label_to_module_name(module_name) + '_java_protos'
604 module = Module('java_library', bp_module_name, bp_module_name)
605 module.comment = f'''GN: [{', '.join(target_names)}]'''
606 module.proto = {'type': 'lite', 'canonical_path_from_root': False}
607
608 for name in target_names:
609 target = gn.get_target(name)
610 module.srcs.update(gn_utils.label_to_path(src) for src in target.sources)
611 for dep_label in target.transitive_proto_deps:
612 dep = gn.get_target(dep_label)
613 module.srcs.update(gn_utils.label_to_path(src) for src in dep.sources)
614
615 blueprint.add_module(module)
616
Motomu Utsumia6c33152022-11-02 18:21:55 +0900617# HACK: Need to support build_cofig_gen flexibly instead of hardcoding
618# build_config_gen generates srcjar by executing gcc via gcc_preprocess.py but gcc is not
619# available in genrule sandbox. Also gcc path is not configurable.
620# Under the //net:net, gcc_preprocess.py is only used for build_config_gen.
621# So, for now, hardcoding BuildConfig.java and generates srcjar by soong_zip.
622def override_build_config_gen(module):
623 module.tool_files.clear()
624 module.tools.add("soong_zip")
625 cmd = [
626 "echo",
627 "\\\"package org.chromium.build;\\n",
628 "public class BuildConfig {\\n",
629 "public static boolean IS_MULTIDEX_ENABLED ;\\n",
630 "public static boolean ENABLE_ASSERTS = true;\\n",
631 "public static boolean IS_UBSAN ;\\n",
632 "public static boolean IS_CHROME_BRANDED ;\\n",
633 "public static int R_STRING_PRODUCT_VERSION ;\\n",
634 "public static int MIN_SDK_VERSION = 1;\\n",
635 "public static boolean BUNDLES_SUPPORTED ;\\n",
636 "public static boolean IS_INCREMENTAL_INSTALL ;\\n",
637 "public static boolean ISOLATED_SPLITS_ENABLED ;\\n",
638 "public static boolean IS_FOR_TEST ;\\n",
639 "}\\n\\\"",
640 "> $(genDir)/BuildConfig.java &&",
641 "$(location soong_zip) -o $(out) -srcjar -f $(genDir)/BuildConfig.java"
642 ]
643 NEWLINE = ' " +\n "'
644 module.cmd = NEWLINE.join(cmd)
645 return module
646
Mohannad Farragbab6c892022-11-02 14:09:46 +0000647def create_action_foreach_modules(blueprint, target):
648 """ The following assumes that rebase_path exists in the args.
649 The args of an action_foreach contains hints about which output files are generated
650 by which source files.
651 This is copied directly from the args
652 "gen/net/base/registry_controlled_domains/{{source_name_part}}-reversed-inc.cc"
653 So each source file will generate an output whose name is the {source_name-reversed-inc.cc}
654 """
655 new_args = []
Motomu Utsumi56afcac2022-11-04 12:58:30 +0900656 for i, src in enumerate(sorted(target.sources)):
Mohannad Farragbab6c892022-11-02 14:09:46 +0000657 # don't add script arg for the first source -- create_action_module
658 # already does this.
659 if i != 0:
660 new_args.append('&& python3 $(location %s)' %
661 gn_utils.label_to_path(target.script))
662 for arg in target.args:
663 if '{{source}}' in arg:
664 new_args.append('$(location %s)' % (gn_utils.label_to_path(src)))
665 elif '{{source_name_part}}' in arg:
666 source_name_part = src.split("/")[-1] # Get the file name only
667 source_name_part = source_name_part.split(".")[0] # Remove the extension (Ex: .cc)
668 file_name = arg.replace('{{source_name_part}}', source_name_part).split("/")[-1]
669 # file_name represent the output file name. But we need the whole path
670 # This can be found from target.outputs.
671 for out in target.outputs:
672 if out.endswith(file_name):
673 new_args.append('$(location %s)' % out)
674 else:
675 new_args.append(arg)
676
677 target.args = new_args
678 return create_action_module(blueprint, target)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900679
Patrick Rohr7be99032022-10-31 11:54:19 -0700680def create_action_module(blueprint, target):
681 bp_module_name = label_to_module_name(target.name)
682 module = Module('genrule', bp_module_name, target.name)
683
Patrick Rohr9b99a982022-10-28 11:00:57 -0700684 # Convert ['--param=value'] to ['--param', 'value'] for consistency.
685 # TODO: we may want to only do this for python scripts arguments. If argparse
686 # is used, this transformation is safe.
687 target.args = [str for it in target.args for str in it.split('=')]
688
Motomu Utsumibf569d42022-10-28 16:47:34 +0900689 if target.script == "//build/write_buildflag_header.py":
690 # write_buildflag_header.py writes result to args.genDir/args.output
691 # So, override args.genDir by '.' so that args.output=$(out) works
Patrick Rohrde568a22022-10-28 09:22:35 -0700692 for i, val in enumerate(target.args):
693 if val == '--gen-dir':
694 target.args[i + 1] = '.'
Patrick Rohrfa972402022-11-01 11:54:35 -0700695 elif val == '--output':
696 target.args[i + 1] = '$(out)'
697
698 elif target.script == '//build/write_build_date_header.py':
699 target.args[0] = '$(out)'
Patrick Rohr0db9f852022-10-27 13:49:57 -0700700
Patrick Rohr8acccca2022-10-28 10:39:06 -0700701 elif target.script == '//base/android/jni_generator/jni_generator.py':
Patrick Rohrc5cc21a2022-10-31 11:57:49 -0700702 # chromium builds against a prebuilt ndk that contains the jni_headers, so
703 # a dependency is never explicitly created.
704 module.genrule_header_libs.add('jni_headers')
Patrick Rohr131ba282022-10-31 16:36:20 -0700705 needs_javap = False
Patrick Rohr8acccca2022-10-28 10:39:06 -0700706 for i, val in enumerate(target.args):
Motomu Utsumi6f9139d2022-10-31 12:15:19 +0900707 if val == '--output_dir':
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700708 # replace --output_dir gen/jni_headers/... with --output_dir $(genDir)/...
709 target.args[i + 1] = re.sub('^gen/jni_headers', '$(genDir)', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700710 elif val == '--input_file':
Patrick Rohr8acccca2022-10-28 10:39:06 -0700711 # --input_file supports both .class specifiers or source files as arguments.
712 # Only source files need to be wrapped inside a $(location <label>) tag.
713 if re.match('.*\.class$', target.args[i + 1]):
714 continue
715 # replace --input_file ../../... with --input_file $(location ...)
716 # TODO: put inside function
717 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
718 target.args[i + 1] = '$(location %s)' % filename
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700719 elif val == '--includes' and 'jni_generator_helper' in target.args[i + 1]:
Patrick Rohrd89e8bf2022-10-31 14:51:05 -0700720 # delete all leading ../
721 target.args[i + 1] = re.sub('^(\.\./)+', '', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700722 elif val == '--prev_output_dir':
Patrick Rohr131ba282022-10-31 16:36:20 -0700723 # this is not needed for aosp builds.
724 target.args[i] = ''
725 target.args[i + 1] = ''
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700726 elif val == '--jar_file':
Patrick Rohr131ba282022-10-31 16:36:20 -0700727 # delete leading ../../ and add path to javap
728 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
729 target.args[i + 1] = '$(location %s)' % filename
730 needs_javap = True
731
732 if needs_javap:
733 target.args.append('--javap')
734 target.args.append('$$(find out/.path -name javap)')
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700735 # fix target.output directory to match #include statements.
736 target.outputs = [re.sub('^jni_headers/', '', out) for out in target.outputs]
Patrick Rohr8acccca2022-10-28 10:39:06 -0700737
Patrick Rohrf6d2b612022-11-09 12:30:26 -0800738 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
739 # jni_registration_generator.py pulls in some config dependencies that we
740 # do not handle. Remove them.
741 # TODO: find a better way to do this.
742 target.deps.clear()
743
Motomu Utsumied009082022-11-10 16:26:44 +0900744 target.inputs = [file for file in target.inputs if not file.startswith('//out/')]
Motomu Utsumi6b4acaa2022-11-10 16:13:24 +0900745 for i, val in enumerate(target.args):
746 if val in ['--depfile', '--srcjar-path', '--header-path']:
747 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900748 if val == '--sources-files':
749 target.args[i + 1] = '$(genDir)/java.sources'
Motomu Utsumi47d122f2022-11-10 17:32:23 +0900750 elif val == '--sources-exclusions':
751 # update_jni_registration_module removes them from the srcs of the module
752 # It might be better to remove sources by '--sources-exclusions'
753 target.args[i] = ''
754 target.args[i + 1] = ''
Motomu Utsumi6b4acaa2022-11-10 16:13:24 +0900755
Patrick Rohr245df582022-11-01 16:59:45 -0700756 elif target.script == '//build/android/gyp/write_build_config.py':
757 for i, val in enumerate(target.args):
758 if val == '--depfile':
759 # Depfile is not used, so no need to generate it.
760 target.args[i] = ''
761 target.args[i + 1] = ''
762 elif val in ['--deps-configs', '--bundled-srcjars']:
763 args = target.args[i + 1]
764 if args == '[]':
765 continue
766 # strip surrounding [] and split by ", "
767 args = args.strip('[]').split(', ')
768 # strip surrounding ""
769 args = [arg.strip('"') for arg in args]
770 # remove leading gen/
771 args = [re.sub('^gen/', '', arg) for arg in args]
772 # wrap filename in \"$(location filename)\"
773 args = ['\"$(location %s)\"' % arg for arg in args]
774 # join args with ", " and wrap in []
775 target.args[i + 1] = '[%s]' % ', '.join(args)
776
777 elif val == '--public-deps-configs':
778 # TODO: implement.
779 pass
780
781 elif val == '--build-config':
782 # json output of this script
783 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
784
785 elif val in ['--unprocessed-jar-path', '--interface-jar-path',
786 '--device-jar-path', '--host-jar-path']:
787 # jar path can be within sources (../../) or output generated by
788 # another genrule (obj/)
789 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
790 filename = re.sub('^obj/', '', target.args[i + 1])
791 target.args[i + 1] = '$(location %s)' % filename
792
793 elif val == '--proguard-configs':
794 args = target.args[i + 1]
795 if args == '[]':
796 continue
797 # TODO: consider adding helpers to deal with argument lists
798 # strip surrounding [] and split by ", ", then strip surrounding ""
799 args = args.strip('[]').split(', ')
800 args = [arg.strip('"') for arg in args]
801 # remove leading ../../
802 args = [re.sub('^\.\./\.\./', '', arg) for arg in args]
803 # add dependency on proguard config file, so a $(location) wrapper can be used.
804 module.tool_files.update(args)
805 # wrap filename in \"$(location filename)\"
806 args = ['$(location %s)' % arg for arg in args]
807 target.args[i + 1] = '[%s]' % ', '.join(args)
Motomu Utsumi1caa39b2022-11-02 18:38:13 +0900808 elif target.script == "//build/android/gyp/write_native_libraries_java.py":
809 for i, val in enumerate(target.args):
810 if val == '--output':
811 target.args[i + 1] = '$(out)'
Motomu Utsumi26211dc2022-11-02 19:38:47 +0900812 elif target.script == "//tools/grit/stamp_grit_sources.py":
813 target.outputs = [re.sub('^\/\/', '', out) for out in target.outputs]
814 # Directory that contains grit scripts
815 target.args[0] = '`dirname $(location tools/grit/grit.py)`'
816 # Path to the stamp file
817 target.args[1] = '$(out)'
818 # Script tries to create args[2] file but this is not in the output.
819 # Specifying file under $(genDir) so that parent directory exists.
820 # If this file is used by other module, we may need to add this file to the outputs.
821 target.args[2] = '$(genDir)/' + target.args[2].split('/')[-1]
Mohannad Farrag033c9d62022-11-07 14:55:49 +0000822 elif target.script == "//tools/grit/grit.py":
823 for i, val in enumerate(target.args):
824 if val == '-i':
825 # Delete leading ../..
826 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
827 target.args[i + 1] = '$(location %s)' % filename
828 elif val == '-o':
829 filename = re.sub('^gen/', '', target.args[i + 1])
830 if filename == "net":
831 # This is a directory not a file
832 target.args[i + 1] = '$(genDir)/net'
833 else:
834 # This is an output fil
835 target.args[i + 1] = '$(location %s)' % filename
836 elif val == '--depfile':
837 # The depfile is replaced by adding /tools/**/*.py to the tools_files
838 # This is basically just globbing all the needed sources by hardcoding.
839 module.tool_files.update([
840 "tools/grit/**/*.py",
841 "third_party/six/src/six.py" # This is not picked up by default. Must be added
842 ])
843
844 # Delete the depfile argument
845 target.args[i] = ' '
846 target.args[i + 1] = ' '
847 elif val == '--input':
848 # Delete leading ../..
849 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
850 # This is an output file so use $(location %s)
851 target.args[i + 1] = '$(location %s)' % filename
Motomu Utsumia0cc6662022-11-09 15:22:27 +0900852 elif target.script == "//net/tools/dafsa/make_dafsa.py":
853 # This script generates .cc files but source (registry_controlled_domain.cc) in the target that
854 # depends on this target includes .cc file this script generates.
855 module.genrule_headers.add(module.name)
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900856 elif target.script == "//build/util/version.py":
Motomu Utsumib0a49e42022-11-09 18:12:27 +0900857 # android_chrome_version.py is not specified in anywhere but version.py imports this file
858 module.tool_files.add('build/util/android_chrome_version.py')
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900859 for i, val in enumerate(target.args):
860 if val.startswith('../../'):
861 filename = re.sub('^\.\./\.\./', '', val)
862 target.args[i] = '$(location %s)' % filename
Motomu Utsumiee279c52022-11-09 17:46:27 +0900863 elif val == '-e':
864 # arg for -e EVAL option should be passed in -e PATCH_HI=int(PATCH)//256 format.
865 target.args[i + 1] = '%s=\'%s\'' % (target.args[i + 1], target.args[i + 2])
866 target.args[i + 2] = ''
Motomu Utsumi438f2c22022-11-09 18:16:40 +0900867 elif val == '-o':
868 target.args[i + 1] = '$(out)'
Patrick Rohr245df582022-11-01 16:59:45 -0700869
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700870 script = gn_utils.label_to_path(target.script)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700871 module.tool_files.add(script)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700872
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700873 # Handle passing parameters via response file by piping them into the script
874 # and reading them from /dev/stdin.
875 response_file = '{{response_file_name}}'
876 use_response_file = response_file in target.args
877 if use_response_file:
878 # Replace {{response_file_contents}} with /dev/stdin
879 target.args = ['/dev/stdin' if it == response_file else it for it in target.args]
880
Patrick Rohr4b0952d2022-11-01 12:42:31 -0700881 # escape " and \$ in target.args.
882 # once all actions are properly implemented, this may not be necessary anymore.
883 # TODO: is this the right place to do this?
884 target.args = [arg.replace('"', r'\"') for arg in target.args]
885 target.args = [arg.replace(r'\$', r'\\$') for arg in target.args]
886
Patrick Rohr9b99a982022-10-28 11:00:57 -0700887 # put all args on a new line for better diffs.
888 NEWLINE = ' " +\n "'
889 arg_string = NEWLINE.join(target.args)
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700890 module.cmd = '$(location %s) %s' % (script, arg_string)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700891
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700892 if use_response_file:
893 # Pipe response file contents into script
Patrick Rohr9b99a982022-10-28 11:00:57 -0700894 module.cmd = 'echo \'%s\' |%s%s' % (target.response_file_contents, NEWLINE, module.cmd)
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700895
Motomu Utsumi7e983832022-11-10 16:04:46 +0900896 if any(os.path.splitext(it)[1] == '.h' for it in target.outputs):
Patrick Rohr67f4d432022-10-26 16:04:15 -0700897 module.genrule_headers.add(bp_module_name)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700898
Patrick Rohr0db9f852022-10-27 13:49:57 -0700899 # gn treats inputs and sources for actions equally.
900 # soong only supports source files inside srcs, non-source files are added as
901 # tool_files dependency.
902 for it in target.sources or target.inputs:
903 if is_supported_source_file(it):
904 module.srcs.add(gn_utils.label_to_path(it))
905 else:
906 module.tool_files.add(gn_utils.label_to_path(it))
Patrick Rohre1a853e2022-10-26 12:31:39 -0700907
Patrick Rohr15a2c302022-10-26 15:08:57 -0700908 # Actions using template "action_with_pydeps" also put script inside inputs.
909 # TODO: it might make sense to filter inputs inside GnParser.
910 if script in module.srcs:
911 module.srcs.remove(script)
912
Patrick Rohre1a853e2022-10-26 12:31:39 -0700913 module.out.update(target.outputs)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900914
915 if target.name == "//build/android:build_config_gen":
916 module = override_build_config_gen(module)
Motomu Utsumi26211dc2022-11-02 19:38:47 +0900917 elif target.script == "//tools/grit/stamp_grit_sources.py":
918 # stamp_grit_sources.py is not executable
919 module.cmd = "python " + module.cmd
Mohannad Farrag18d7b512022-11-07 13:26:30 +0000920 elif target.script == "//base/android/jni_generator/jni_generator.py":
921 # android_jar.classes should be part of the tools as it list implicit classes
922 # for the script to generate JNI headers.
923 module.tool_files.add("base/android/jni_generator/android_jar.classes")
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900924 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
Motomu Utsumi9ca466b2022-11-10 17:12:29 +0900925 # jni_registration_generator.py doesn't work with python2
926 module.cmd = "python3 " + module.cmd
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900927 # Path in the original sources file does not work in genrule.
928 # So creating sources file in cmd based on the srcs of this target.
929 # Adding ../$(current_dir)/ to the head because jni_registration_generator.py uses the files
930 # whose path startswith(..)
931 commands = ["current_dir=`basename \\\`pwd\\\``;",
932 "for f in $(in);",
933 "do",
934 "echo \\\"../$$current_dir/$$f\\\" >> $(genDir)/java.sources;",
935 "done;",
936 module.cmd]
Motomu Utsumi2a892d22022-11-10 18:03:20 +0900937
938 # .h file jni_registration_generator.py generates has #define with directory name.
939 # With the genrule env that contains "." which is invalid. So replace that at the end of cmd.
Mohannad Farrag7c0f0982022-11-10 14:39:49 +0000940 commands.append(";sed -i -e 's/OUT_SOONG_.TEMP_SBOX_.*_OUT/GEN/g' ")
Motomu Utsumi2a892d22022-11-10 18:03:20 +0900941 commands.append("$(genDir)/components/cronet/android/cronet_jni_registration.h")
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900942 module.cmd = NEWLINE.join(commands)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900943
Patrick Rohre1a853e2022-10-26 12:31:39 -0700944 blueprint.add_module(module)
945 return module
946
947
Patrick Rohr92d74122022-10-21 15:50:52 -0700948
Motomu Utsumic34b1372022-11-17 22:15:51 +0900949def _get_cflags(cflags, defines):
950 cflags = {flag for flag in cflags if flag in cflag_allowlist}
Motomu Utsumifa7e9262022-10-26 19:43:02 +0900951 # Consider proper allowlist or denylist if needed
Motomu Utsumic34b1372022-11-17 22:15:51 +0900952 cflags |= set("-D%s" % define.replace("\"", "\\\"") for define in defines)
Motomu Utsumi50cf83e2022-11-15 20:26:37 +0900953 # -DANDROID is added by default but target.defines contain -DANDROID if it's required.
954 # So adding -UANDROID to cancel default -DANDROID if it's not specified.
955 # This is needed for some targets(e.g. symbolize)
Motomu Utsumic34b1372022-11-17 22:15:51 +0900956 if "ANDROID" not in defines:
Motomu Utsumi50cf83e2022-11-15 20:26:37 +0900957 cflags.add("-UANDROID")
Patrick Rohr92d74122022-10-21 15:50:52 -0700958 return cflags
959
Motomu Utsumic34b1372022-11-17 22:15:51 +0900960def set_module_flags(module, cflags, defines):
961 module.cflags.update(_get_cflags(cflags, defines))
962 # TODO: implement proper cflag parsing.
963 for flag in cflags:
964 if '-std=' in flag:
965 module.cpp_std = flag[len('-std='):]
966 if '-frtti' in flag:
967 module.rtti = True
968 if '-fexceptions' in flag:
969 module.cppflags.add('-fexceptions')
Patrick Rohr92d74122022-10-21 15:50:52 -0700970
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900971def set_module_include_dirs(module, cflags, include_dirs):
972 local_include_dirs_set = set()
973 for flag in cflags:
974 if '-isystem' in flag:
975 local_include_dirs_set.add(flag[len('-isystem../../'):])
976
977 # Adding local_include_dirs is necessary due to source_sets / filegroups
978 # which do not properly propagate include directories.
979 # Filter any directory inside //out as a) this directory does not exist for
980 # aosp / soong builds and b) the include directory should already be
981 # configured via library dependency.
982 local_include_dirs_set.update([gn_utils.label_to_path(d)
983 for d in include_dirs
984 if not re.match('^//out/.*', d)])
985 module.local_include_dirs = sorted(list(local_include_dirs_set))
986
987 # Order matters for some targets. For example, base/time/time_exploded_icu.cc
988 # in //base:base needs to have sysroot include after icu/source/common
989 # include. So adding sysroot include at the end.
990 for flag in sorted(cflags):
991 if '--sysroot' in flag:
992 sysroot = flag[len('--sysroot=../../'):]
993 if sysroot == "build/linux/debian_bullseye_amd64-sysroot":
994 module.local_include_dirs.append(sysroot + "/usr/include/x86_64-linux-gnu")
995 module.local_include_dirs.append(sysroot + "/usr/include")
996
Patrick Rohr92d74122022-10-21 15:50:52 -0700997def create_modules_from_target(blueprint, gn, gn_target_name):
998 """Generate module(s) for a given GN target.
999
1000 Given a GN target name, generate one or more corresponding modules into a
1001 blueprint. The only case when this generates >1 module is proto libraries.
1002
1003 Args:
1004 blueprint: Blueprint instance which is being generated.
1005 gn: gn_utils.GnParser object.
1006 gn_target_name: GN target for module generation.
1007 """
1008 bp_module_name = label_to_module_name(gn_target_name)
1009 if bp_module_name in blueprint.modules:
1010 return blueprint.modules[bp_module_name]
1011 target = gn.get_target(gn_target_name)
Patrick Rohr16228942022-10-26 14:00:26 -07001012 log.info('create modules for %s (%s)', target.name, target.type)
Patrick Rohr92d74122022-10-21 15:50:52 -07001013
Patrick Rohr92d74122022-10-21 15:50:52 -07001014 if target.type == 'executable':
Patrick Rohrc8f41cd2022-11-15 22:46:10 -08001015 if target.testonly:
Patrick Rohr92d74122022-10-21 15:50:52 -07001016 module_type = 'cc_test'
1017 else:
Patrick Rohrc8f41cd2022-11-15 22:46:10 -08001018 # Can be used for both host and device targets.
Patrick Rohr92d74122022-10-21 15:50:52 -07001019 module_type = 'cc_binary'
1020 module = Module(module_type, bp_module_name, gn_target_name)
1021 elif target.type == 'static_library':
1022 module = Module('cc_library_static', bp_module_name, gn_target_name)
1023 elif target.type == 'shared_library':
1024 module = Module('cc_library_shared', bp_module_name, gn_target_name)
1025 elif target.type == 'source_set':
Patrick Rohr82e96f32022-11-16 22:09:48 -08001026 module = Module('cc_defaults', bp_module_name, gn_target_name)
Patrick Rohr92d74122022-10-21 15:50:52 -07001027 elif target.type == 'group':
1028 # "group" targets are resolved recursively by gn_utils.get_target().
1029 # There's nothing we need to do at this level for them.
1030 return None
1031 elif target.type == 'proto_library':
1032 module = create_proto_modules(blueprint, gn, target)
1033 if module is None:
1034 return None
1035 elif target.type == 'action':
1036 if 'gen_amalgamated_sql_metrics' in target.name:
1037 module = create_amalgamated_sql_metrics_module(blueprint, target)
Patrick Rohr07876662022-11-15 22:55:23 -08001038 elif re.match('.*gen_cc_.*_descriptor$', target.name):
Patrick Rohr92d74122022-10-21 15:50:52 -07001039 module = create_cc_proto_descriptor_module(blueprint, target)
1040 elif target.type == 'action' and \
Patrick Rohr07876662022-11-15 22:55:23 -08001041 target.name == gn_utils.GEN_VERSION_TARGET:
Patrick Rohr92d74122022-10-21 15:50:52 -07001042 module = create_gen_version_module(blueprint, target, bp_module_name)
1043 else:
Patrick Rohre1a853e2022-10-26 12:31:39 -07001044 module = create_action_module(blueprint, target)
Mohannad Farragf076f3e2022-10-31 17:45:28 +00001045 elif target.type == 'action_foreach':
Mohannad Farragbab6c892022-11-02 14:09:46 +00001046 module = create_action_foreach_modules(blueprint, target)
Patrick Rohr59a76652022-10-26 12:36:56 -07001047 elif target.type == 'copy':
1048 # TODO: careful now! copy targets are not supported yet, but this will stop
1049 # traversing the dependency tree. For //base:base, this is not a big
1050 # problem as libicu contains the only copy target which happens to be a
1051 # leaf node.
1052 return None
Patrick Rohrad440602022-11-10 22:09:04 -08001053 elif target.type == 'java_group':
1054 # Java targets are handled outside of create_modules_from_target.
1055 return None
Patrick Rohr92d74122022-10-21 15:50:52 -07001056 else:
1057 raise Error('Unknown target %s (%s)' % (target.name, target.type))
1058
1059 blueprint.add_module(module)
Patrick Rohr92d74122022-10-21 15:50:52 -07001060 module.init_rc = target_initrc.get(target.name, [])
1061 module.srcs.update(
1062 gn_utils.label_to_path(src)
1063 for src in target.sources
Motomu Utsumif951e502022-11-07 19:31:15 +09001064 if is_supported_source_file(src) and not src.startswith("//out/test"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001065
Patrick Rohr3b5ff762022-11-16 10:22:16 -08001066 # Add arch-specific properties
1067 for arch_name, arch in target.arch.items():
Motomu Utsumi40f95c52022-11-17 19:39:13 +09001068 module.target[arch_name].srcs.update(
1069 gn_utils.label_to_path(src)
1070 for src in arch.sources
1071 if is_supported_source_file(src) and not src.startswith("//out/test"))
Patrick Rohr3b5ff762022-11-16 10:22:16 -08001072
Patrick Rohr92d74122022-10-21 15:50:52 -07001073 if target.type in gn_utils.LINKER_UNIT_TYPES:
Motomu Utsumic34b1372022-11-17 22:15:51 +09001074 set_module_flags(module, target.cflags, target.defines)
Motomu Utsumi88efbb42022-11-17 22:18:15 +09001075 set_module_include_dirs(module, target.cflags, target.include_dirs)
Patrick Rohr92d74122022-10-21 15:50:52 -07001076
Patrick Rohra6ce0232022-11-16 22:09:01 -08001077 if module.is_compiled():
Patrick Rohrc8f41cd2022-11-15 22:46:10 -08001078 module.host_supported = target.host_supported()
1079 module.device_supported = target.device_supported()
1080
Patrick Rohr92d74122022-10-21 15:50:52 -07001081 # Don't try to inject library/source dependencies into genrules or
1082 # filegroups because they are not compiled in the traditional sense.
1083 module.defaults = [defaults_module]
1084 for lib in target.libs:
1085 # Generally library names should be mangled as 'libXXX', unless they
1086 # are HAL libraries (e.g., android.hardware.health@2.0) or AIDL c++ / NDK
1087 # libraries (e.g. "android.hardware.power.stats-V1-cpp")
1088 android_lib = lib if '@' in lib or "-cpp" in lib or "-ndk" in lib \
1089 else 'lib' + lib
1090 if lib in shared_library_allowlist:
1091 module.add_android_shared_lib(android_lib)
1092 if lib in static_library_allowlist:
1093 module.add_android_static_lib(android_lib)
1094
Patrick Rohrd9dd3b92022-11-09 16:15:30 -08001095 # Remove prohibited include directories
1096 module.local_include_dirs = [d for d in module.local_include_dirs
1097 if d not in local_include_dirs_denylist]
1098
1099
Patrick Rohr92d74122022-10-21 15:50:52 -07001100 # If the module is a static library, export all the generated headers.
1101 if module.type == 'cc_library_static':
1102 module.export_generated_headers = module.generated_headers
1103
Patrick Rohr92d74122022-10-21 15:50:52 -07001104 # dep_name is an unmangled GN target name (e.g. //foo:bar(toolchain)).
Motomu Utsumif1daa232022-11-08 13:28:37 +09001105 # Currently, only one module is generated from target even target has multiple toolchains.
1106 # And module is generated based on the first visited target.
1107 # Sort deps before iteration to make result deterministic.
1108 all_deps = sorted(target.deps | target.source_set_deps | target.transitive_proto_deps)
Patrick Rohr92d74122022-10-21 15:50:52 -07001109 for dep_name in all_deps:
Patrick Rohr5cc46e02022-10-26 14:32:45 -07001110 # |builtin_deps| override GN deps with Android-specific ones. See the
1111 # config in the top of this file.
Patrick Rohr07876662022-11-15 22:55:23 -08001112 if dep_name in builtin_deps:
1113 builtin_deps[dep_name](module)
Patrick Rohr5cc46e02022-10-26 14:32:45 -07001114 continue
1115
Patrick Rohr92d74122022-10-21 15:50:52 -07001116 dep_module = create_modules_from_target(blueprint, gn, dep_name)
1117
Motomu Utsumie246feb2022-11-01 17:25:56 +09001118 # TODO: Proper dependency check for genrule.
1119 # Currently, only propagating genrule dependencies.
1120 # Also, currently, all the dependencies are propagated upwards.
1121 # in gn, public_deps should be propagated but deps should not.
1122 # Not sure this information is available in the desc.json.
1123 # Following rule works for adding android_runtime_jni_headers to base:base.
1124 # If this doesn't work for other target, hardcoding for specific target
1125 # might be better.
1126 if module.type == "genrule" and dep_module.type == "genrule":
1127 module.genrule_headers.add(dep_module.name)
1128 module.genrule_headers.update(dep_module.genrule_headers)
1129
Patrick Rohra6ce0232022-11-16 22:09:01 -08001130 # For cc_defaults, filegroups, and genrule, recurse but don't apply the
1131 # deps.
1132 if not module.is_compiled():
Patrick Rohr92d74122022-10-21 15:50:52 -07001133 continue
1134
Patrick Rohr92d74122022-10-21 15:50:52 -07001135 if dep_module is None:
1136 continue
1137 if dep_module.type == 'cc_library_shared':
1138 module.shared_libs.add(dep_module.name)
1139 elif dep_module.type == 'cc_library_static':
1140 module.static_libs.add(dep_module.name)
Patrick Rohr82e96f32022-11-16 22:09:48 -08001141 elif dep_module.type == 'cc_defaults':
1142 module.defaults.append(dep_module.name)
Patrick Rohr92d74122022-10-21 15:50:52 -07001143 elif dep_module.type == 'genrule':
1144 module.generated_headers.update(dep_module.genrule_headers)
1145 module.srcs.update(dep_module.genrule_srcs)
1146 module.shared_libs.update(dep_module.genrule_shared_libs)
Patrick Rohra1a27872022-10-31 11:57:14 -07001147 module.header_libs.update(dep_module.genrule_header_libs)
Patrick Rohr92d74122022-10-21 15:50:52 -07001148 elif dep_module.type == 'cc_binary':
1149 continue # Ignore executables deps (used by cmdline integration tests).
1150 else:
1151 raise Error('Unknown dep %s (%s) for target %s' %
1152 (dep_module.name, dep_module.type, module.name))
1153
1154 return module
1155
Patrick Rohrb18aca22022-11-04 15:07:32 -07001156def create_java_module(blueprint, gn):
1157 bp_module_name = module_prefix + 'java'
1158 module = Module('java_library', bp_module_name, '//gn:java')
Mohannad Farrag21562d62022-11-07 13:09:31 +00001159 module.srcs.update([gn_utils.label_to_path(source) for source in gn.java_sources])
Patrick Rohrb18aca22022-11-04 15:07:32 -07001160 blueprint.add_module(module)
Patrick Rohr92d74122022-10-21 15:50:52 -07001161
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001162def update_jni_registration_module(blueprint, gn):
1163 bp_module_name = label_to_module_name('//components/cronet/android:cronet_jni_registration')
Patrick Rohr7f225422022-11-10 21:38:38 -08001164 if bp_module_name not in blueprint.modules:
1165 # To support building targets that might not create the cronet_jni_registration.
1166 return
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001167 module = blueprint.modules[bp_module_name]
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001168
1169 # TODO: deny list is in the arg of jni_registration_generator.py. Should not be hardcoded
1170 deny_list = [
1171 '//base/android/java/src/org/chromium/base/library_loader/LibraryLoader.java',
1172 '//base/android/java/src/org/chromium/base/library_loader/LibraryPrefetcher.java',
1173 '//base/android/java/src/org/chromium/base/process_launcher/ChildProcessService.java',
1174 '//base/android/java/src/org/chromium/base/SysUtils.java']
1175
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001176 # TODO: java_sources might not contain all the required java files
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001177 module.srcs.update([gn_utils.label_to_path(source)
1178 for source in gn.java_sources if source not in deny_list])
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001179
Motomu Utsumi79bd0c82022-11-10 17:52:24 +09001180 # TODO: Remove hardcoded file addition to srcs
1181 # jni_registration_generator.py generates empty .h file if native methods are not found in the
1182 # java files. But android:cronet depends on `RegisterNonMainDexNatives` which is in the template
1183 # of .h file. To make script generate non empty .h file, adding java file which contains native
1184 # method. Once all the required java files are added to the srcs, this can be removed.
1185 module.srcs.update([
1186 "components/cronet/android/java/src/org/chromium/net/impl/CronetUrlRequest.java"])
1187
Patrick Rohr92d74122022-10-21 15:50:52 -07001188def create_blueprint_for_targets(gn, desc, targets):
1189 """Generate a blueprint for a list of GN targets."""
1190 blueprint = Blueprint()
1191
1192 # Default settings used by all modules.
1193 defaults = Module('cc_defaults', defaults_module, '//gn:default_deps')
Patrick Rohr92d74122022-10-21 15:50:52 -07001194 defaults.cflags = [
Patrick Rohr3ce74772022-11-11 14:19:58 -08001195 '-DGOOGLE_PROTOBUF_NO_RTTI',
Patrick Rohr92d74122022-10-21 15:50:52 -07001196 '-Wno-error=return-type',
Patrick Rohr3a1ec1d2022-10-31 13:30:17 -07001197 '-Wno-non-virtual-dtor',
Patrick Rohr5c700022022-11-08 19:33:07 -08001198 '-Wno-macro-redefined',
Patrick Rohr98065152022-10-31 14:49:58 -07001199 '-Wno-missing-field-initializers',
Patrick Rohr92d74122022-10-21 15:50:52 -07001200 '-Wno-sign-compare',
1201 '-Wno-sign-promo',
1202 '-Wno-unused-parameter',
Mohannad Farragd98a96d2022-11-10 14:56:19 +00001203 '-Wno-deprecated-non-prototype', # needed for zlib
Patrick Rohr92d74122022-10-21 15:50:52 -07001204 '-fvisibility=hidden',
Motomu Utsumiba020942022-11-14 15:15:41 +09001205 '-Wno-ambiguous-reversed-operator', # needed for icui18n
Motomu Utsumib1ec8782022-11-14 15:25:57 +09001206 '-Wno-unreachable-code-loop-increment', # needed for icui18n
Patrick Rohr92d74122022-10-21 15:50:52 -07001207 '-O2',
1208 ]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001209 defaults.stl = 'none'
Patrick Rohr92d74122022-10-21 15:50:52 -07001210 blueprint.add_module(defaults)
Patrick Rohr344b2472022-10-25 11:32:15 -07001211
Patrick Rohr92d74122022-10-21 15:50:52 -07001212 for target in targets:
1213 create_modules_from_target(blueprint, gn, target)
Patrick Rohrb18aca22022-11-04 15:07:32 -07001214
1215 create_java_module(blueprint, gn)
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001216 update_jni_registration_module(blueprint, gn)
Patrick Rohra7d029d2022-11-08 12:23:11 -08001217
1218 # Merge in additional hardcoded arguments.
1219 for module in blueprint.modules.values():
1220 for key, add_val in additional_args.get(module.name, []):
1221 curr = getattr(module, key)
1222 if add_val and isinstance(add_val, set) and isinstance(curr, set):
1223 curr.update(add_val)
1224 elif isinstance(add_val, str) and (not curr or isinstance(curr, str)):
1225 setattr(module, key, add_val)
1226 elif isinstance(add_val, bool) and (not curr or isinstance(curr, bool)):
1227 setattr(module, key, add_val)
1228 elif isinstance(add_val, dict) and isinstance(curr, dict):
1229 curr.update(add_val)
1230 elif isinstance(add_val, dict) and isinstance(curr, Target):
1231 curr.__dict__.update(add_val)
1232 else:
1233 raise Error('Unimplemented type %r of additional_args: %r' %
1234 (type(add_val), key))
1235
Patrick Rohr92d74122022-10-21 15:50:52 -07001236 return blueprint
1237
1238
1239def main():
1240 parser = argparse.ArgumentParser(
1241 description='Generate Android.bp from a GN description.')
1242 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001243 '--desc',
Patrick Rohr3db246a2022-10-25 10:25:17 -07001244 help='GN description (e.g., gn desc out --format=json --all-toolchains "//*"',
1245 required=True
Patrick Rohr92d74122022-10-21 15:50:52 -07001246 )
1247 parser.add_argument(
1248 '--extras',
1249 help='Extra targets to include at the end of the Blueprint file',
1250 default=os.path.join(gn_utils.repo_root(), 'Android.bp.extras'),
1251 )
1252 parser.add_argument(
1253 '--output',
1254 help='Blueprint file to create',
1255 default=os.path.join(gn_utils.repo_root(), 'Android.bp'),
1256 )
1257 parser.add_argument(
Patrick Rohr16228942022-10-26 14:00:26 -07001258 '-v',
1259 '--verbose',
1260 help='Print debug logs.',
1261 action='store_true',
1262 )
1263 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001264 'targets',
1265 nargs=argparse.REMAINDER,
Patrick Rohr1aa504a2022-10-25 10:30:42 -07001266 help='Targets to include in the blueprint (e.g., "//:perfetto_tests")'
1267 )
Patrick Rohr92d74122022-10-21 15:50:52 -07001268 args = parser.parse_args()
1269
Patrick Rohr16228942022-10-26 14:00:26 -07001270 if args.verbose:
1271 log.basicConfig(format='%(levelname)s:%(funcName)s:%(message)s', level=log.DEBUG)
1272
Patrick Rohr3db246a2022-10-25 10:25:17 -07001273 with open(args.desc) as f:
1274 desc = json.load(f)
Patrick Rohr92d74122022-10-21 15:50:52 -07001275
Patrick Rohr564d6be2022-11-15 12:57:57 -08001276 gn = gn_utils.GnParser()
Patrick Rohrd0077b72022-11-15 12:43:26 -08001277 targets = args.targets or default_targets
1278 for target in targets:
1279 # TODO: pass desc to parse_gn_desc() to support parsing multiple desc files
1280 # for different target architectures.
Patrick Rohr564d6be2022-11-15 12:57:57 -08001281 gn.parse_gn_desc(desc, target)
Patrick Rohrd0077b72022-11-15 12:43:26 -08001282 blueprint = create_blueprint_for_targets(gn, desc, targets)
Patrick Rohr92d74122022-10-21 15:50:52 -07001283 project_root = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
1284 tool_name = os.path.relpath(os.path.abspath(__file__), project_root)
1285
Patrick Rohr92d74122022-10-21 15:50:52 -07001286 # Add any proto groups to the blueprint.
1287 for l_name, t_names in proto_groups.items():
1288 create_proto_group_modules(blueprint, gn, l_name, t_names)
1289
1290 output = [
Patrick Rohr5478b392022-10-25 09:58:50 -07001291 """// Copyright (C) 2022 The Android Open Source Project
Patrick Rohr92d74122022-10-21 15:50:52 -07001292//
1293// Licensed under the Apache License, Version 2.0 (the "License");
1294// you may not use this file except in compliance with the License.
1295// You may obtain a copy of the License at
1296//
1297// http://www.apache.org/licenses/LICENSE-2.0
1298//
1299// Unless required by applicable law or agreed to in writing, software
1300// distributed under the License is distributed on an "AS IS" BASIS,
1301// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1302// See the License for the specific language governing permissions and
1303// limitations under the License.
1304//
1305// This file is automatically generated by %s. Do not edit.
1306""" % (tool_name)
1307 ]
1308 blueprint.to_string(output)
Patrick Rohrcb98e9b2022-10-25 09:57:02 -07001309 if os.path.exists(args.extras):
1310 with open(args.extras, 'r') as r:
1311 for line in r:
1312 output.append(line.rstrip("\n\r"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001313
1314 out_files = []
1315
1316 # Generate the Android.bp file.
1317 out_files.append(args.output + '.swp')
1318 with open(out_files[-1], 'w') as f:
1319 f.write('\n'.join(output))
1320 # Text files should have a trailing EOL.
1321 f.write('\n')
1322
Patrick Rohr94693eb2022-10-25 10:09:16 -07001323 return 0
Patrick Rohr92d74122022-10-21 15:50:52 -07001324
1325
1326if __name__ == '__main__':
1327 sys.exit(main())