blob: c05426facf660708ea921df832cb1779620f58c0 [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 = [
94 'third_party/protobuf/src/',
95]
96
Patrick Rohr92d74122022-10-21 15:50:52 -070097# Name of the module which settings such as compiler flags for all other
98# modules.
99defaults_module = module_prefix + 'defaults'
100
101# Location of the project in the Android source tree.
Patrick Rohr76ceeb52022-11-07 14:18:58 -0800102tree_path = 'external/chromium_org'
Patrick Rohr92d74122022-10-21 15:50:52 -0700103
104# Path for the protobuf sources in the standalone build.
105buildtools_protobuf_src = '//buildtools/protobuf/src'
106
107# Location of the protobuf src dir in the Android source tree.
108android_protobuf_src = 'external/protobuf/src'
109
110# Compiler flags which are passed through to the blueprint.
111cflag_allowlist = r'^-DPERFETTO.*$'
112
Patrick Rohr92d74122022-10-21 15:50:52 -0700113# Additional arguments to apply to Android.bp rules.
114additional_args = {
Patrick Rohr2267a0a2022-11-08 18:59:34 -0800115 # TODO: remove if not needed.
Patrick Rohrd90025f2022-11-11 14:18:35 -0800116 'cronet_aml_components_cronet_android_cronet': [
117 ('linker_scripts', {
118 'base/android/library_loader/anchor_functions.lds',
119 }),
120 ],
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800121 'cronet_aml_net_net': [
Patrick Rohr9f4d3e32022-11-09 16:37:31 -0800122 ('export_static_lib_headers', {
123 'cronet_aml_net_third_party_quiche_quiche',
124 'cronet_aml_crypto_crypto',
125 }),
Mohannad Farrag627dc912022-11-11 19:00:26 +0000126 # When a code is compiled under rtti(cronet) that depends on another code(net)
127 # that doesn't depend on rtti. undefined symbol: typeinfo 'class' errors appears.
128 ('rtti', True), # go/undefined-symbol-typeinfo
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000129 ],
Patrick Rohr92d74122022-10-21 15:50:52 -0700130}
131
132
133def enable_gtest_and_gmock(module):
134 module.static_libs.add('libgmock')
135 module.static_libs.add('libgtest')
136 if module.name != 'perfetto_gtest_logcat_printer':
137 module.whole_static_libs.add('perfetto_gtest_logcat_printer')
138
139
140def enable_protobuf_full(module):
141 if module.type == 'cc_binary_host':
142 module.static_libs.add('libprotobuf-cpp-full')
143 elif module.host_supported:
144 module.host.static_libs.add('libprotobuf-cpp-full')
145 module.android.shared_libs.add('libprotobuf-cpp-full')
Patrick Rohr84b16402022-11-08 19:01:01 -0800146 elif module.type not in ['genrule', 'filegroup']:
Patrick Rohr92d74122022-10-21 15:50:52 -0700147 module.shared_libs.add('libprotobuf-cpp-full')
148
149
150def enable_protobuf_lite(module):
Patrick Rohr84b16402022-11-08 19:01:01 -0800151 if module.type not in ['genrule', 'filegroup']:
152 module.shared_libs.add('libprotobuf-cpp-lite')
Patrick Rohr92d74122022-10-21 15:50:52 -0700153
154
155def enable_protoc_lib(module):
156 if module.type == 'cc_binary_host':
157 module.static_libs.add('libprotoc')
158 else:
159 module.shared_libs.add('libprotoc')
160
161
162def enable_libunwindstack(module):
163 if module.name != 'heapprofd_standalone_client':
164 module.shared_libs.add('libunwindstack')
165 module.shared_libs.add('libprocinfo')
166 module.shared_libs.add('libbase')
167 else:
168 module.static_libs.add('libunwindstack')
169 module.static_libs.add('libprocinfo')
170 module.static_libs.add('libbase')
171 module.static_libs.add('liblzma')
172 module.static_libs.add('libdexfile_support')
173 module.runtime_libs.add('libdexfile') # libdexfile_support dependency
174
175
176def enable_libunwind(module):
177 # libunwind is disabled on Darwin so we cannot depend on it.
178 pass
179
180
181def enable_sqlite(module):
182 if module.type == 'cc_binary_host':
183 module.static_libs.add('libsqlite')
184 module.static_libs.add('sqlite_ext_percentile')
185 elif module.host_supported:
186 # Copy what the sqlite3 command line tool does.
187 module.android.shared_libs.add('libsqlite')
188 module.android.shared_libs.add('libicu')
189 module.android.shared_libs.add('liblog')
190 module.android.shared_libs.add('libutils')
191 module.android.static_libs.add('sqlite_ext_percentile')
192 module.host.static_libs.add('libsqlite')
193 module.host.static_libs.add('sqlite_ext_percentile')
194 else:
195 module.shared_libs.add('libsqlite')
196 module.shared_libs.add('libicu')
197 module.shared_libs.add('liblog')
198 module.shared_libs.add('libutils')
199 module.static_libs.add('sqlite_ext_percentile')
200
201
202def enable_zlib(module):
203 if module.type == 'cc_binary_host':
204 module.static_libs.add('libz')
205 elif module.host_supported:
206 module.android.shared_libs.add('libz')
207 module.host.static_libs.add('libz')
208 else:
209 module.shared_libs.add('libz')
210
211
212def enable_uapi_headers(module):
213 module.include_dirs.add('bionic/libc/kernel')
214
215
216def enable_bionic_libc_platform_headers_on_android(module):
217 module.header_libs.add('bionic_libc_platform_headers')
218
219
Patrick Rohrcc83af22022-11-10 20:00:58 -0800220def enable_boringssl(module):
221 if module.type not in ['genrule', 'filegroup']:
222 module.static_libs.add('libssl')
223
224
Patrick Rohr92d74122022-10-21 15:50:52 -0700225# Android equivalents for third-party libraries that the upstream project
226# depends on.
227builtin_deps = {
228 '//gn:default_deps':
229 lambda x: None,
230 '//gn:gtest_main':
231 lambda x: None,
Patrick Rohr92d74122022-10-21 15:50:52 -0700232 '//gn:gtest_and_gmock':
233 enable_gtest_and_gmock,
234 '//gn:libunwind':
235 enable_libunwind,
Patrick Rohr92d74122022-10-21 15:50:52 -0700236 '//gn:libunwindstack':
237 enable_libunwindstack,
238 '//gn:sqlite':
239 enable_sqlite,
240 '//gn:zlib':
241 enable_zlib,
242 '//gn:bionic_kernel_uapi_headers':
243 enable_uapi_headers,
244 '//src/profiling/memory:bionic_libc_platform_headers_on_android':
245 enable_bionic_libc_platform_headers_on_android,
Motomu Utsumidfc8e6a2022-11-04 18:25:33 +0900246 '//third_party/protobuf:protoc':
247 lambda x: None,
Patrick Rohr84b16402022-11-08 19:01:01 -0800248 '//third_party/protobuf:protobuf_full':
249 enable_protobuf_full,
250 '//third_party/protobuf:protobuf_lite':
251 enable_protobuf_lite,
252 '//third_party/protobuf:protoc_lib':
253 enable_protoc_lib,
Patrick Rohrcc83af22022-11-10 20:00:58 -0800254 '//third_party/boringssl:boringssl':
255 enable_boringssl,
Patrick Rohr92d74122022-10-21 15:50:52 -0700256}
257
258# ----------------------------------------------------------------------------
259# End of configuration.
260# ----------------------------------------------------------------------------
261
262
263class Error(Exception):
264 pass
265
266
267class ThrowingArgumentParser(argparse.ArgumentParser):
268
269 def __init__(self, context):
270 super(ThrowingArgumentParser, self).__init__()
271 self.context = context
272
273 def error(self, message):
274 raise Error('%s: %s' % (self.context, message))
275
276
277def write_blueprint_key_value(output, name, value, sort=True):
278 """Writes a Blueprint key-value pair to the output"""
279
280 if isinstance(value, bool):
281 if value:
282 output.append(' %s: true,' % name)
283 else:
284 output.append(' %s: false,' % name)
285 return
286 if not value:
287 return
288 if isinstance(value, set):
289 value = sorted(value)
290 if isinstance(value, list):
291 output.append(' %s: [' % name)
292 for item in sorted(value) if sort else value:
293 output.append(' "%s",' % item)
294 output.append(' ],')
295 return
296 if isinstance(value, Target):
297 value.to_string(output)
298 return
299 if isinstance(value, dict):
300 kv_output = []
301 for k, v in value.items():
302 write_blueprint_key_value(kv_output, k, v)
303
304 output.append(' %s: {' % name)
305 for line in kv_output:
306 output.append(' %s' % line)
307 output.append(' },')
308 return
309 output.append(' %s: "%s",' % (name, value))
310
311
312class Target(object):
313 """A target-scoped part of a module"""
314
315 def __init__(self, name):
316 self.name = name
317 self.shared_libs = set()
318 self.static_libs = set()
319 self.whole_static_libs = set()
320 self.cflags = set()
321 self.dist = dict()
322 self.strip = dict()
323 self.stl = None
324
325 def to_string(self, output):
326 nested_out = []
327 self._output_field(nested_out, 'shared_libs')
328 self._output_field(nested_out, 'static_libs')
329 self._output_field(nested_out, 'whole_static_libs')
330 self._output_field(nested_out, 'cflags')
331 self._output_field(nested_out, 'stl')
332 self._output_field(nested_out, 'dist')
333 self._output_field(nested_out, 'strip')
334
335 if nested_out:
336 output.append(' %s: {' % self.name)
337 for line in nested_out:
338 output.append(' %s' % line)
339 output.append(' },')
340
341 def _output_field(self, output, name, sort=True):
342 value = getattr(self, name)
343 return write_blueprint_key_value(output, name, value, sort)
344
345
346class Module(object):
347 """A single module (e.g., cc_binary, cc_test) in a blueprint."""
348
349 def __init__(self, mod_type, name, gn_target):
350 self.type = mod_type
351 self.gn_target = gn_target
352 self.name = name
353 self.srcs = set()
354 self.comment = 'GN: ' + gn_utils.label_without_toolchain(gn_target)
355 self.shared_libs = set()
356 self.static_libs = set()
357 self.whole_static_libs = set()
358 self.runtime_libs = set()
359 self.tools = set()
360 self.cmd = None
361 self.host_supported = False
362 self.vendor_available = False
363 self.init_rc = set()
364 self.out = set()
365 self.export_include_dirs = set()
366 self.generated_headers = set()
367 self.export_generated_headers = set()
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800368 self.export_static_lib_headers = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700369 self.defaults = set()
370 self.cflags = set()
371 self.include_dirs = set()
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900372 self.local_include_dirs = []
Patrick Rohr92d74122022-10-21 15:50:52 -0700373 self.header_libs = set()
374 self.required = set()
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700375 self.tool_files = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700376 self.android = Target('android')
377 self.host = Target('host')
Patrick Rohr92d74122022-10-21 15:50:52 -0700378 self.stl = None
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700379 self.cpp_std = None
Patrick Rohr92d74122022-10-21 15:50:52 -0700380 self.dist = dict()
381 self.strip = dict()
382 self.data = set()
383 self.apex_available = set()
384 self.min_sdk_version = None
385 self.proto = dict()
Patrick Rohrd90025f2022-11-11 14:18:35 -0800386 self.linker_scripts = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700387 # The genrule_XXX below are properties that must to be propagated back
388 # on the module(s) that depend on the genrule.
389 self.genrule_headers = set()
390 self.genrule_srcs = set()
391 self.genrule_shared_libs = set()
Patrick Rohra1a27872022-10-31 11:57:14 -0700392 self.genrule_header_libs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700393 self.version_script = None
394 self.test_suites = set()
395 self.test_config = None
396 self.stubs = {}
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000397 self.cppflags = set()
398 self.rtti = False
Motomu Utsumi87c2a482022-11-14 14:57:46 +0900399 self.arch = dict()
Patrick Rohr92d74122022-10-21 15:50:52 -0700400
401 def to_string(self, output):
402 if self.comment:
403 output.append('// %s' % self.comment)
404 output.append('%s {' % self.type)
405 self._output_field(output, 'name')
406 self._output_field(output, 'srcs')
407 self._output_field(output, 'shared_libs')
408 self._output_field(output, 'static_libs')
409 self._output_field(output, 'whole_static_libs')
410 self._output_field(output, 'runtime_libs')
411 self._output_field(output, 'tools')
412 self._output_field(output, 'cmd', sort=False)
413 if self.host_supported:
414 self._output_field(output, 'host_supported')
415 if self.vendor_available:
416 self._output_field(output, 'vendor_available')
417 self._output_field(output, 'init_rc')
418 self._output_field(output, 'out')
419 self._output_field(output, 'export_include_dirs')
420 self._output_field(output, 'generated_headers')
421 self._output_field(output, 'export_generated_headers')
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800422 self._output_field(output, 'export_static_lib_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -0700423 self._output_field(output, 'defaults')
424 self._output_field(output, 'cflags')
425 self._output_field(output, 'include_dirs')
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900426 self._output_field(output, 'local_include_dirs', sort=False)
Patrick Rohr92d74122022-10-21 15:50:52 -0700427 self._output_field(output, 'header_libs')
428 self._output_field(output, 'required')
429 self._output_field(output, 'dist')
430 self._output_field(output, 'strip')
431 self._output_field(output, 'tool_files')
432 self._output_field(output, 'data')
433 self._output_field(output, 'stl')
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700434 self._output_field(output, 'cpp_std')
Patrick Rohr92d74122022-10-21 15:50:52 -0700435 self._output_field(output, 'apex_available')
436 self._output_field(output, 'min_sdk_version')
437 self._output_field(output, 'version_script')
438 self._output_field(output, 'test_suites')
439 self._output_field(output, 'test_config')
440 self._output_field(output, 'stubs')
441 self._output_field(output, 'proto')
Patrick Rohrd90025f2022-11-11 14:18:35 -0800442 self._output_field(output, 'linker_scripts')
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000443 self._output_field(output, 'cppflags')
444 if self.rtti:
445 self._output_field(output, 'rtti')
Motomu Utsumi87c2a482022-11-14 14:57:46 +0900446 self._output_field(output, 'arch')
Patrick Rohr92d74122022-10-21 15:50:52 -0700447
448 target_out = []
449 self._output_field(target_out, 'android')
450 self._output_field(target_out, 'host')
451 if target_out:
452 output.append(' target: {')
453 for line in target_out:
454 output.append(' %s' % line)
455 output.append(' },')
456
Patrick Rohr92d74122022-10-21 15:50:52 -0700457 output.append('}')
458 output.append('')
459
460 def add_android_static_lib(self, lib):
461 if self.type == 'cc_binary_host':
462 raise Exception('Adding Android static lib for host tool is unsupported')
463 elif self.host_supported:
464 self.android.static_libs.add(lib)
465 else:
466 self.static_libs.add(lib)
467
468 def add_android_shared_lib(self, lib):
469 if self.type == 'cc_binary_host':
470 raise Exception('Adding Android shared lib for host tool is unsupported')
471 elif self.host_supported:
472 self.android.shared_libs.add(lib)
473 else:
474 self.shared_libs.add(lib)
475
476 def _output_field(self, output, name, sort=True):
477 value = getattr(self, name)
478 return write_blueprint_key_value(output, name, value, sort)
479
480
481class Blueprint(object):
482 """In-memory representation of an Android.bp file."""
483
484 def __init__(self):
485 self.modules = {}
486
487 def add_module(self, module):
488 """Adds a new module to the blueprint, replacing any existing module
489 with the same name.
490
491 Args:
492 module: Module instance.
493 """
494 self.modules[module.name] = module
495
496 def to_string(self, output):
Patrick Rohr23f26192022-10-25 09:45:22 -0700497 for m in sorted(self.modules.values(), key=lambda m: m.name):
Patrick Rohr92d74122022-10-21 15:50:52 -0700498 m.to_string(output)
499
500
501def label_to_module_name(label):
502 """Turn a GN label (e.g., //:perfetto_tests) into a module name."""
503 # If the label is explicibly listed in the default target list, don't prefix
504 # its name and return just the target name. This is so tools like
505 # "traceconv" stay as such in the Android tree.
506 label_without_toolchain = gn_utils.label_without_toolchain(label)
Patrick Rohr92d74122022-10-21 15:50:52 -0700507 module = re.sub(r'^//:?', '', label_without_toolchain)
508 module = re.sub(r'[^a-zA-Z0-9_]', '_', module)
509 if not module.startswith(module_prefix):
510 return module_prefix + module
511 return module
512
513
514def is_supported_source_file(name):
515 """Returns True if |name| can appear in a 'srcs' list."""
Patrick Rohrf9f3a992022-11-10 19:40:32 -0800516 return os.path.splitext(name)[1] in ['.c', '.cc', '.cpp', '.java', '.proto', '.S']
Patrick Rohr92d74122022-10-21 15:50:52 -0700517
518
519def create_proto_modules(blueprint, gn, target):
520 """Generate genrules for a proto GN target.
521
522 GN actions are used to dynamically generate files during the build. The
523 Soong equivalent is a genrule. This function turns a specific kind of
524 genrule which turns .proto files into source and header files into a pair
525 equivalent genrules.
526
527 Args:
528 blueprint: Blueprint instance which is being generated.
529 target: gn_utils.Target object.
530
531 Returns:
532 The source_genrule module.
533 """
534 assert (target.type == 'proto_library')
535
536 tools = {'aprotoc'}
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900537 cpp_out_dir = '$(genDir)/%s/%s/' % (tree_path, target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700538 target_module_name = label_to_module_name(target.name)
539
540 # In GN builds the proto path is always relative to the output directory
541 # (out/tmp.xxx).
Motomu Utsumie8457452022-11-08 18:47:51 +0900542 cmd = ['$(location aprotoc)']
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900543 cmd += ['--proto_path=%s/%s' % (tree_path, target.proto_in_dir)]
Patrick Rohr92d74122022-10-21 15:50:52 -0700544
545 if buildtools_protobuf_src in target.proto_paths:
546 cmd += ['--proto_path=%s' % android_protobuf_src]
547
548 # We don't generate any targets for source_set proto modules because
549 # they will be inlined into other modules if required.
550 if target.proto_plugin == 'source_set':
551 return None
552
553 # Descriptor targets only generate a single target.
554 if target.proto_plugin == 'descriptor':
555 out = '{}.bin'.format(target_module_name)
556
557 cmd += ['--descriptor_set_out=$(out)']
558 cmd += ['$(in)']
559
560 descriptor_module = Module('genrule', target_module_name, target.name)
561 descriptor_module.cmd = ' '.join(cmd)
562 descriptor_module.out = [out]
563 descriptor_module.tools = tools
564 blueprint.add_module(descriptor_module)
565
566 # Recursively extract the .proto files of all the dependencies and
567 # add them to srcs.
568 descriptor_module.srcs.update(
569 gn_utils.label_to_path(src) for src in target.sources)
570 for dep in target.transitive_proto_deps:
571 current_target = gn.get_target(dep)
572 descriptor_module.srcs.update(
573 gn_utils.label_to_path(src) for src in current_target.sources)
574
575 return descriptor_module
576
577 # We create two genrules for each proto target: one for the headers and
578 # another for the sources. This is because the module that depends on the
579 # generated files needs to declare two different types of dependencies --
580 # source files in 'srcs' and headers in 'generated_headers' -- and it's not
581 # valid to generate .h files from a source dependency and vice versa.
582 source_module_name = target_module_name + '_gen'
583 source_module = Module('genrule', source_module_name, target.name)
584 blueprint.add_module(source_module)
585 source_module.srcs.update(
586 gn_utils.label_to_path(src) for src in target.sources)
587
588 header_module = Module('genrule', source_module_name + '_headers',
589 target.name)
590 blueprint.add_module(header_module)
591 header_module.srcs = set(source_module.srcs)
592
593 # TODO(primiano): at some point we should remove this. This was introduced
594 # by aosp/1108421 when adding "protos/" to .proto include paths, in order to
595 # avoid doing multi-repo changes and allow old clients in the android tree
596 # to still do the old #include "perfetto/..." rather than
597 # #include "protos/perfetto/...".
598 header_module.export_include_dirs = {'.', 'protos'}
Patrick Rohr2267a0a2022-11-08 18:59:34 -0800599 # Since the .cc file and .h get created by a different gerule target, they
600 # are not put in the same intermediate path, so local includes do not work
601 # without explictily exporting the include dir.
602 header_module.export_include_dirs.add(target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700603
604 source_module.genrule_srcs.add(':' + source_module.name)
605 source_module.genrule_headers.add(header_module.name)
606
607 if target.proto_plugin == 'proto':
608 suffixes = ['pb']
609 source_module.genrule_shared_libs.add('libprotobuf-cpp-lite')
610 cmd += ['--cpp_out=lite=true:' + cpp_out_dir]
611 elif target.proto_plugin == 'protozero':
612 suffixes = ['pbzero']
613 plugin = create_modules_from_target(blueprint, gn, protozero_plugin)
614 tools.add(plugin.name)
615 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
616 cmd += ['--plugin_out=wrapper_namespace=pbzero:' + cpp_out_dir]
617 elif target.proto_plugin == 'cppgen':
618 suffixes = ['gen']
619 plugin = create_modules_from_target(blueprint, gn, cppgen_plugin)
620 tools.add(plugin.name)
621 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
622 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
623 elif target.proto_plugin == 'ipc':
624 suffixes = ['ipc']
625 plugin = create_modules_from_target(blueprint, gn, ipc_plugin)
626 tools.add(plugin.name)
627 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
628 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
629 else:
630 raise Error('Unsupported proto plugin: %s' % target.proto_plugin)
631
632 cmd += ['$(in)']
633 source_module.cmd = ' '.join(cmd)
634 header_module.cmd = source_module.cmd
635 source_module.tools = tools
636 header_module.tools = tools
637
638 for sfx in suffixes:
639 source_module.out.update('%s/%s' %
640 (tree_path, src.replace('.proto', '.%s.cc' % sfx))
641 for src in source_module.srcs)
642 header_module.out.update('%s/%s' %
643 (tree_path, src.replace('.proto', '.%s.h' % sfx))
644 for src in header_module.srcs)
645 return source_module
646
647
648def create_amalgamated_sql_metrics_module(blueprint, target):
649 bp_module_name = label_to_module_name(target.name)
650 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700651 module.tool_files.add('tools/gen_amalgamated_sql_metrics.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700652 module.cmd = ' '.join([
653 '$(location tools/gen_amalgamated_sql_metrics.py)',
654 '--cpp_out=$(out)',
655 '$(in)',
656 ])
657 module.genrule_headers.add(module.name)
658 module.out.update(target.outputs)
659 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
660 blueprint.add_module(module)
661 return module
662
663
664def create_cc_proto_descriptor_module(blueprint, target):
665 bp_module_name = label_to_module_name(target.name)
666 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700667 module.tool_files.add('tools/gen_cc_proto_descriptor.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700668 module.cmd = ' '.join([
669 '$(location tools/gen_cc_proto_descriptor.py)', '--gen_dir=$(genDir)',
670 '--cpp_out=$(out)', '$(in)'
671 ])
672 module.genrule_headers.add(module.name)
673 module.srcs.update(
674 ':' + label_to_module_name(dep) for dep in target.proto_deps)
675 module.srcs.update(
676 gn_utils.label_to_path(src)
677 for src in target.inputs
678 if "tmp.gn_utils" not in src)
679 module.out.update(target.outputs)
680 blueprint.add_module(module)
681 return module
682
683
684def create_gen_version_module(blueprint, target, bp_module_name):
685 module = Module('genrule', bp_module_name, gn_utils.GEN_VERSION_TARGET)
686 script_path = gn_utils.label_to_path(target.script)
687 module.genrule_headers.add(bp_module_name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700688 module.tool_files.add(script_path)
Patrick Rohr92d74122022-10-21 15:50:52 -0700689 module.out.update(target.outputs)
690 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
691 module.cmd = ' '.join([
692 'python3 $(location %s)' % script_path, '--no_git',
693 '--changelog=$(location CHANGELOG)', '--cpp_out=$(out)'
694 ])
695 blueprint.add_module(module)
696 return module
697
698
699def create_proto_group_modules(blueprint, gn, module_name, target_names):
700 # TODO(lalitm): today, we're only adding a Java lite module because that's
701 # the only one used in practice. In the future, if we need other target types
702 # (e.g. C++, Java full etc.) add them here.
703 bp_module_name = label_to_module_name(module_name) + '_java_protos'
704 module = Module('java_library', bp_module_name, bp_module_name)
705 module.comment = f'''GN: [{', '.join(target_names)}]'''
706 module.proto = {'type': 'lite', 'canonical_path_from_root': False}
707
708 for name in target_names:
709 target = gn.get_target(name)
710 module.srcs.update(gn_utils.label_to_path(src) for src in target.sources)
711 for dep_label in target.transitive_proto_deps:
712 dep = gn.get_target(dep_label)
713 module.srcs.update(gn_utils.label_to_path(src) for src in dep.sources)
714
715 blueprint.add_module(module)
716
Motomu Utsumia6c33152022-11-02 18:21:55 +0900717# HACK: Need to support build_cofig_gen flexibly instead of hardcoding
718# build_config_gen generates srcjar by executing gcc via gcc_preprocess.py but gcc is not
719# available in genrule sandbox. Also gcc path is not configurable.
720# Under the //net:net, gcc_preprocess.py is only used for build_config_gen.
721# So, for now, hardcoding BuildConfig.java and generates srcjar by soong_zip.
722def override_build_config_gen(module):
723 module.tool_files.clear()
724 module.tools.add("soong_zip")
725 cmd = [
726 "echo",
727 "\\\"package org.chromium.build;\\n",
728 "public class BuildConfig {\\n",
729 "public static boolean IS_MULTIDEX_ENABLED ;\\n",
730 "public static boolean ENABLE_ASSERTS = true;\\n",
731 "public static boolean IS_UBSAN ;\\n",
732 "public static boolean IS_CHROME_BRANDED ;\\n",
733 "public static int R_STRING_PRODUCT_VERSION ;\\n",
734 "public static int MIN_SDK_VERSION = 1;\\n",
735 "public static boolean BUNDLES_SUPPORTED ;\\n",
736 "public static boolean IS_INCREMENTAL_INSTALL ;\\n",
737 "public static boolean ISOLATED_SPLITS_ENABLED ;\\n",
738 "public static boolean IS_FOR_TEST ;\\n",
739 "}\\n\\\"",
740 "> $(genDir)/BuildConfig.java &&",
741 "$(location soong_zip) -o $(out) -srcjar -f $(genDir)/BuildConfig.java"
742 ]
743 NEWLINE = ' " +\n "'
744 module.cmd = NEWLINE.join(cmd)
745 return module
746
Mohannad Farragbab6c892022-11-02 14:09:46 +0000747def create_action_foreach_modules(blueprint, target):
748 """ The following assumes that rebase_path exists in the args.
749 The args of an action_foreach contains hints about which output files are generated
750 by which source files.
751 This is copied directly from the args
752 "gen/net/base/registry_controlled_domains/{{source_name_part}}-reversed-inc.cc"
753 So each source file will generate an output whose name is the {source_name-reversed-inc.cc}
754 """
755 new_args = []
Motomu Utsumi56afcac2022-11-04 12:58:30 +0900756 for i, src in enumerate(sorted(target.sources)):
Mohannad Farragbab6c892022-11-02 14:09:46 +0000757 # don't add script arg for the first source -- create_action_module
758 # already does this.
759 if i != 0:
760 new_args.append('&& python3 $(location %s)' %
761 gn_utils.label_to_path(target.script))
762 for arg in target.args:
763 if '{{source}}' in arg:
764 new_args.append('$(location %s)' % (gn_utils.label_to_path(src)))
765 elif '{{source_name_part}}' in arg:
766 source_name_part = src.split("/")[-1] # Get the file name only
767 source_name_part = source_name_part.split(".")[0] # Remove the extension (Ex: .cc)
768 file_name = arg.replace('{{source_name_part}}', source_name_part).split("/")[-1]
769 # file_name represent the output file name. But we need the whole path
770 # This can be found from target.outputs.
771 for out in target.outputs:
772 if out.endswith(file_name):
773 new_args.append('$(location %s)' % out)
774 else:
775 new_args.append(arg)
776
777 target.args = new_args
778 return create_action_module(blueprint, target)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900779
Patrick Rohr7be99032022-10-31 11:54:19 -0700780def create_action_module(blueprint, target):
781 bp_module_name = label_to_module_name(target.name)
782 module = Module('genrule', bp_module_name, target.name)
783
Patrick Rohr9b99a982022-10-28 11:00:57 -0700784 # Convert ['--param=value'] to ['--param', 'value'] for consistency.
785 # TODO: we may want to only do this for python scripts arguments. If argparse
786 # is used, this transformation is safe.
787 target.args = [str for it in target.args for str in it.split('=')]
788
Motomu Utsumibf569d42022-10-28 16:47:34 +0900789 if target.script == "//build/write_buildflag_header.py":
790 # write_buildflag_header.py writes result to args.genDir/args.output
791 # So, override args.genDir by '.' so that args.output=$(out) works
Patrick Rohrde568a22022-10-28 09:22:35 -0700792 for i, val in enumerate(target.args):
793 if val == '--gen-dir':
794 target.args[i + 1] = '.'
Patrick Rohrfa972402022-11-01 11:54:35 -0700795 elif val == '--output':
796 target.args[i + 1] = '$(out)'
797
798 elif target.script == '//build/write_build_date_header.py':
799 target.args[0] = '$(out)'
Patrick Rohr0db9f852022-10-27 13:49:57 -0700800
Patrick Rohr8acccca2022-10-28 10:39:06 -0700801 elif target.script == '//base/android/jni_generator/jni_generator.py':
Patrick Rohrc5cc21a2022-10-31 11:57:49 -0700802 # chromium builds against a prebuilt ndk that contains the jni_headers, so
803 # a dependency is never explicitly created.
804 module.genrule_header_libs.add('jni_headers')
Patrick Rohr131ba282022-10-31 16:36:20 -0700805 needs_javap = False
Patrick Rohr8acccca2022-10-28 10:39:06 -0700806 for i, val in enumerate(target.args):
Motomu Utsumi6f9139d2022-10-31 12:15:19 +0900807 if val == '--output_dir':
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700808 # replace --output_dir gen/jni_headers/... with --output_dir $(genDir)/...
809 target.args[i + 1] = re.sub('^gen/jni_headers', '$(genDir)', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700810 elif val == '--input_file':
Patrick Rohr8acccca2022-10-28 10:39:06 -0700811 # --input_file supports both .class specifiers or source files as arguments.
812 # Only source files need to be wrapped inside a $(location <label>) tag.
813 if re.match('.*\.class$', target.args[i + 1]):
814 continue
815 # replace --input_file ../../... with --input_file $(location ...)
816 # TODO: put inside function
817 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
818 target.args[i + 1] = '$(location %s)' % filename
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700819 elif val == '--includes' and 'jni_generator_helper' in target.args[i + 1]:
Patrick Rohrd89e8bf2022-10-31 14:51:05 -0700820 # delete all leading ../
821 target.args[i + 1] = re.sub('^(\.\./)+', '', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700822 elif val == '--prev_output_dir':
Patrick Rohr131ba282022-10-31 16:36:20 -0700823 # this is not needed for aosp builds.
824 target.args[i] = ''
825 target.args[i + 1] = ''
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700826 elif val == '--jar_file':
Patrick Rohr131ba282022-10-31 16:36:20 -0700827 # delete leading ../../ and add path to javap
828 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
829 target.args[i + 1] = '$(location %s)' % filename
830 needs_javap = True
831
832 if needs_javap:
833 target.args.append('--javap')
834 target.args.append('$$(find out/.path -name javap)')
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700835 # fix target.output directory to match #include statements.
836 target.outputs = [re.sub('^jni_headers/', '', out) for out in target.outputs]
Patrick Rohr8acccca2022-10-28 10:39:06 -0700837
Patrick Rohrf6d2b612022-11-09 12:30:26 -0800838 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
839 # jni_registration_generator.py pulls in some config dependencies that we
840 # do not handle. Remove them.
841 # TODO: find a better way to do this.
842 target.deps.clear()
843
Motomu Utsumied009082022-11-10 16:26:44 +0900844 target.inputs = [file for file in target.inputs if not file.startswith('//out/')]
Motomu Utsumi6b4acaa2022-11-10 16:13:24 +0900845 for i, val in enumerate(target.args):
846 if val in ['--depfile', '--srcjar-path', '--header-path']:
847 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900848 if val == '--sources-files':
849 target.args[i + 1] = '$(genDir)/java.sources'
Motomu Utsumi47d122f2022-11-10 17:32:23 +0900850 elif val == '--sources-exclusions':
851 # update_jni_registration_module removes them from the srcs of the module
852 # It might be better to remove sources by '--sources-exclusions'
853 target.args[i] = ''
854 target.args[i + 1] = ''
Motomu Utsumi6b4acaa2022-11-10 16:13:24 +0900855
Patrick Rohr245df582022-11-01 16:59:45 -0700856 elif target.script == '//build/android/gyp/write_build_config.py':
857 for i, val in enumerate(target.args):
858 if val == '--depfile':
859 # Depfile is not used, so no need to generate it.
860 target.args[i] = ''
861 target.args[i + 1] = ''
862 elif val in ['--deps-configs', '--bundled-srcjars']:
863 args = target.args[i + 1]
864 if args == '[]':
865 continue
866 # strip surrounding [] and split by ", "
867 args = args.strip('[]').split(', ')
868 # strip surrounding ""
869 args = [arg.strip('"') for arg in args]
870 # remove leading gen/
871 args = [re.sub('^gen/', '', arg) for arg in args]
872 # wrap filename in \"$(location filename)\"
873 args = ['\"$(location %s)\"' % arg for arg in args]
874 # join args with ", " and wrap in []
875 target.args[i + 1] = '[%s]' % ', '.join(args)
876
877 elif val == '--public-deps-configs':
878 # TODO: implement.
879 pass
880
881 elif val == '--build-config':
882 # json output of this script
883 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
884
885 elif val in ['--unprocessed-jar-path', '--interface-jar-path',
886 '--device-jar-path', '--host-jar-path']:
887 # jar path can be within sources (../../) or output generated by
888 # another genrule (obj/)
889 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
890 filename = re.sub('^obj/', '', target.args[i + 1])
891 target.args[i + 1] = '$(location %s)' % filename
892
893 elif val == '--proguard-configs':
894 args = target.args[i + 1]
895 if args == '[]':
896 continue
897 # TODO: consider adding helpers to deal with argument lists
898 # strip surrounding [] and split by ", ", then strip surrounding ""
899 args = args.strip('[]').split(', ')
900 args = [arg.strip('"') for arg in args]
901 # remove leading ../../
902 args = [re.sub('^\.\./\.\./', '', arg) for arg in args]
903 # add dependency on proguard config file, so a $(location) wrapper can be used.
904 module.tool_files.update(args)
905 # wrap filename in \"$(location filename)\"
906 args = ['$(location %s)' % arg for arg in args]
907 target.args[i + 1] = '[%s]' % ', '.join(args)
Motomu Utsumi1caa39b2022-11-02 18:38:13 +0900908 elif target.script == "//build/android/gyp/write_native_libraries_java.py":
909 for i, val in enumerate(target.args):
910 if val == '--output':
911 target.args[i + 1] = '$(out)'
Motomu Utsumi26211dc2022-11-02 19:38:47 +0900912 elif target.script == "//tools/grit/stamp_grit_sources.py":
913 target.outputs = [re.sub('^\/\/', '', out) for out in target.outputs]
914 # Directory that contains grit scripts
915 target.args[0] = '`dirname $(location tools/grit/grit.py)`'
916 # Path to the stamp file
917 target.args[1] = '$(out)'
918 # Script tries to create args[2] file but this is not in the output.
919 # Specifying file under $(genDir) so that parent directory exists.
920 # If this file is used by other module, we may need to add this file to the outputs.
921 target.args[2] = '$(genDir)/' + target.args[2].split('/')[-1]
Mohannad Farrag033c9d62022-11-07 14:55:49 +0000922 elif target.script == "//tools/grit/grit.py":
923 for i, val in enumerate(target.args):
924 if val == '-i':
925 # Delete leading ../..
926 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
927 target.args[i + 1] = '$(location %s)' % filename
928 elif val == '-o':
929 filename = re.sub('^gen/', '', target.args[i + 1])
930 if filename == "net":
931 # This is a directory not a file
932 target.args[i + 1] = '$(genDir)/net'
933 else:
934 # This is an output fil
935 target.args[i + 1] = '$(location %s)' % filename
936 elif val == '--depfile':
937 # The depfile is replaced by adding /tools/**/*.py to the tools_files
938 # This is basically just globbing all the needed sources by hardcoding.
939 module.tool_files.update([
940 "tools/grit/**/*.py",
941 "third_party/six/src/six.py" # This is not picked up by default. Must be added
942 ])
943
944 # Delete the depfile argument
945 target.args[i] = ' '
946 target.args[i + 1] = ' '
947 elif val == '--input':
948 # Delete leading ../..
949 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
950 # This is an output file so use $(location %s)
951 target.args[i + 1] = '$(location %s)' % filename
Motomu Utsumia0cc6662022-11-09 15:22:27 +0900952 elif target.script == "//net/tools/dafsa/make_dafsa.py":
953 # This script generates .cc files but source (registry_controlled_domain.cc) in the target that
954 # depends on this target includes .cc file this script generates.
955 module.genrule_headers.add(module.name)
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900956 elif target.script == "//build/util/version.py":
Motomu Utsumib0a49e42022-11-09 18:12:27 +0900957 # android_chrome_version.py is not specified in anywhere but version.py imports this file
958 module.tool_files.add('build/util/android_chrome_version.py')
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900959 for i, val in enumerate(target.args):
960 if val.startswith('../../'):
961 filename = re.sub('^\.\./\.\./', '', val)
962 target.args[i] = '$(location %s)' % filename
Motomu Utsumiee279c52022-11-09 17:46:27 +0900963 elif val == '-e':
964 # arg for -e EVAL option should be passed in -e PATCH_HI=int(PATCH)//256 format.
965 target.args[i + 1] = '%s=\'%s\'' % (target.args[i + 1], target.args[i + 2])
966 target.args[i + 2] = ''
Motomu Utsumi438f2c22022-11-09 18:16:40 +0900967 elif val == '-o':
968 target.args[i + 1] = '$(out)'
Patrick Rohr245df582022-11-01 16:59:45 -0700969
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700970 script = gn_utils.label_to_path(target.script)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700971 module.tool_files.add(script)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700972
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700973 # Handle passing parameters via response file by piping them into the script
974 # and reading them from /dev/stdin.
975 response_file = '{{response_file_name}}'
976 use_response_file = response_file in target.args
977 if use_response_file:
978 # Replace {{response_file_contents}} with /dev/stdin
979 target.args = ['/dev/stdin' if it == response_file else it for it in target.args]
980
Patrick Rohr4b0952d2022-11-01 12:42:31 -0700981 # escape " and \$ in target.args.
982 # once all actions are properly implemented, this may not be necessary anymore.
983 # TODO: is this the right place to do this?
984 target.args = [arg.replace('"', r'\"') for arg in target.args]
985 target.args = [arg.replace(r'\$', r'\\$') for arg in target.args]
986
Patrick Rohr9b99a982022-10-28 11:00:57 -0700987 # put all args on a new line for better diffs.
988 NEWLINE = ' " +\n "'
989 arg_string = NEWLINE.join(target.args)
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700990 module.cmd = '$(location %s) %s' % (script, arg_string)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700991
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700992 if use_response_file:
993 # Pipe response file contents into script
Patrick Rohr9b99a982022-10-28 11:00:57 -0700994 module.cmd = 'echo \'%s\' |%s%s' % (target.response_file_contents, NEWLINE, module.cmd)
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700995
Motomu Utsumi7e983832022-11-10 16:04:46 +0900996 if any(os.path.splitext(it)[1] == '.h' for it in target.outputs):
Patrick Rohr67f4d432022-10-26 16:04:15 -0700997 module.genrule_headers.add(bp_module_name)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700998
Patrick Rohr0db9f852022-10-27 13:49:57 -0700999 # gn treats inputs and sources for actions equally.
1000 # soong only supports source files inside srcs, non-source files are added as
1001 # tool_files dependency.
1002 for it in target.sources or target.inputs:
1003 if is_supported_source_file(it):
1004 module.srcs.add(gn_utils.label_to_path(it))
1005 else:
1006 module.tool_files.add(gn_utils.label_to_path(it))
Patrick Rohre1a853e2022-10-26 12:31:39 -07001007
Patrick Rohr15a2c302022-10-26 15:08:57 -07001008 # Actions using template "action_with_pydeps" also put script inside inputs.
1009 # TODO: it might make sense to filter inputs inside GnParser.
1010 if script in module.srcs:
1011 module.srcs.remove(script)
1012
Patrick Rohre1a853e2022-10-26 12:31:39 -07001013 module.out.update(target.outputs)
Motomu Utsumia6c33152022-11-02 18:21:55 +09001014
1015 if target.name == "//build/android:build_config_gen":
1016 module = override_build_config_gen(module)
Motomu Utsumi26211dc2022-11-02 19:38:47 +09001017 elif target.script == "//tools/grit/stamp_grit_sources.py":
1018 # stamp_grit_sources.py is not executable
1019 module.cmd = "python " + module.cmd
Mohannad Farrag18d7b512022-11-07 13:26:30 +00001020 elif target.script == "//base/android/jni_generator/jni_generator.py":
1021 # android_jar.classes should be part of the tools as it list implicit classes
1022 # for the script to generate JNI headers.
1023 module.tool_files.add("base/android/jni_generator/android_jar.classes")
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +09001024 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
Motomu Utsumi9ca466b2022-11-10 17:12:29 +09001025 # jni_registration_generator.py doesn't work with python2
1026 module.cmd = "python3 " + module.cmd
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +09001027 # Path in the original sources file does not work in genrule.
1028 # So creating sources file in cmd based on the srcs of this target.
1029 # Adding ../$(current_dir)/ to the head because jni_registration_generator.py uses the files
1030 # whose path startswith(..)
1031 commands = ["current_dir=`basename \\\`pwd\\\``;",
1032 "for f in $(in);",
1033 "do",
1034 "echo \\\"../$$current_dir/$$f\\\" >> $(genDir)/java.sources;",
1035 "done;",
1036 module.cmd]
Motomu Utsumi2a892d22022-11-10 18:03:20 +09001037
1038 # .h file jni_registration_generator.py generates has #define with directory name.
1039 # With the genrule env that contains "." which is invalid. So replace that at the end of cmd.
Mohannad Farrag7c0f0982022-11-10 14:39:49 +00001040 commands.append(";sed -i -e 's/OUT_SOONG_.TEMP_SBOX_.*_OUT/GEN/g' ")
Motomu Utsumi2a892d22022-11-10 18:03:20 +09001041 commands.append("$(genDir)/components/cronet/android/cronet_jni_registration.h")
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +09001042 module.cmd = NEWLINE.join(commands)
Motomu Utsumia6c33152022-11-02 18:21:55 +09001043
Patrick Rohre1a853e2022-10-26 12:31:39 -07001044 blueprint.add_module(module)
1045 return module
1046
1047
Patrick Rohr92d74122022-10-21 15:50:52 -07001048
1049def _get_cflags(target):
1050 cflags = {flag for flag in target.cflags if re.match(cflag_allowlist, flag)}
Motomu Utsumifa7e9262022-10-26 19:43:02 +09001051 # Consider proper allowlist or denylist if needed
1052 cflags |= set("-D%s" % define.replace("\"", "\\\"") for define in target.defines)
Patrick Rohr92d74122022-10-21 15:50:52 -07001053 return cflags
1054
1055
1056def create_modules_from_target(blueprint, gn, gn_target_name):
1057 """Generate module(s) for a given GN target.
1058
1059 Given a GN target name, generate one or more corresponding modules into a
1060 blueprint. The only case when this generates >1 module is proto libraries.
1061
1062 Args:
1063 blueprint: Blueprint instance which is being generated.
1064 gn: gn_utils.GnParser object.
1065 gn_target_name: GN target for module generation.
1066 """
1067 bp_module_name = label_to_module_name(gn_target_name)
1068 if bp_module_name in blueprint.modules:
1069 return blueprint.modules[bp_module_name]
1070 target = gn.get_target(gn_target_name)
Patrick Rohr16228942022-10-26 14:00:26 -07001071 log.info('create modules for %s (%s)', target.name, target.type)
Patrick Rohr92d74122022-10-21 15:50:52 -07001072
1073 name_without_toolchain = gn_utils.label_without_toolchain(target.name)
1074 if target.type == 'executable':
1075 if target.toolchain == gn_utils.HOST_TOOLCHAIN:
1076 module_type = 'cc_binary_host'
1077 elif target.testonly:
1078 module_type = 'cc_test'
1079 else:
1080 module_type = 'cc_binary'
1081 module = Module(module_type, bp_module_name, gn_target_name)
1082 elif target.type == 'static_library':
1083 module = Module('cc_library_static', bp_module_name, gn_target_name)
1084 elif target.type == 'shared_library':
1085 module = Module('cc_library_shared', bp_module_name, gn_target_name)
1086 elif target.type == 'source_set':
1087 module = Module('filegroup', bp_module_name, gn_target_name)
1088 elif target.type == 'group':
1089 # "group" targets are resolved recursively by gn_utils.get_target().
1090 # There's nothing we need to do at this level for them.
1091 return None
1092 elif target.type == 'proto_library':
1093 module = create_proto_modules(blueprint, gn, target)
1094 if module is None:
1095 return None
1096 elif target.type == 'action':
1097 if 'gen_amalgamated_sql_metrics' in target.name:
1098 module = create_amalgamated_sql_metrics_module(blueprint, target)
1099 elif re.match('.*gen_cc_.*_descriptor$', name_without_toolchain):
1100 module = create_cc_proto_descriptor_module(blueprint, target)
1101 elif target.type == 'action' and \
1102 name_without_toolchain == gn_utils.GEN_VERSION_TARGET:
1103 module = create_gen_version_module(blueprint, target, bp_module_name)
1104 else:
Patrick Rohre1a853e2022-10-26 12:31:39 -07001105 module = create_action_module(blueprint, target)
Mohannad Farragf076f3e2022-10-31 17:45:28 +00001106 elif target.type == 'action_foreach':
Mohannad Farragbab6c892022-11-02 14:09:46 +00001107 module = create_action_foreach_modules(blueprint, target)
Patrick Rohr59a76652022-10-26 12:36:56 -07001108 elif target.type == 'copy':
1109 # TODO: careful now! copy targets are not supported yet, but this will stop
1110 # traversing the dependency tree. For //base:base, this is not a big
1111 # problem as libicu contains the only copy target which happens to be a
1112 # leaf node.
1113 return None
Patrick Rohrad440602022-11-10 22:09:04 -08001114 elif target.type == 'java_group':
1115 # Java targets are handled outside of create_modules_from_target.
1116 return None
Patrick Rohr92d74122022-10-21 15:50:52 -07001117 else:
1118 raise Error('Unknown target %s (%s)' % (target.name, target.type))
1119
1120 blueprint.add_module(module)
1121 module.host_supported = (name_without_toolchain in target_host_supported)
Patrick Rohr92d74122022-10-21 15:50:52 -07001122 module.init_rc = target_initrc.get(target.name, [])
1123 module.srcs.update(
1124 gn_utils.label_to_path(src)
1125 for src in target.sources
Motomu Utsumif951e502022-11-07 19:31:15 +09001126 if is_supported_source_file(src) and not src.startswith("//out/test"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001127
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001128 local_include_dirs_set = set()
Patrick Rohr92d74122022-10-21 15:50:52 -07001129 if target.type in gn_utils.LINKER_UNIT_TYPES:
1130 module.cflags.update(_get_cflags(target))
Patrick Rohrf22e9d02022-10-28 14:20:46 -07001131 # TODO: implement proper cflag parsing.
1132 for flag in target.cflags:
Patrick Rohrb8f830a2022-10-31 11:18:57 -07001133 if '-std=' in flag:
1134 module.cpp_std = flag[len('-std='):]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001135 if '-isystem' in flag:
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001136 local_include_dirs_set.add(flag[len('-isystem../../'):])
Patrick Rohr5fae90f2022-11-11 08:22:52 -08001137 if '-frtti' in flag:
1138 module.rtti = True
Patrick Rohr0948d1c2022-11-11 11:02:16 -08001139 if '-fexceptions' in flag:
1140 module.cppflags.add('-fexceptions')
1141
Patrick Rohrb8f830a2022-10-31 11:18:57 -07001142
Patrick Rohrd0abc2a2022-10-31 13:29:16 -07001143 # Adding local_include_dirs is necessary due to source_sets / filegroups
1144 # which do not properly propagate include directories.
1145 # Filter any directory inside //out as a) this directory does not exist for
1146 # aosp / soong builds and b) the include directory should already be
1147 # configured via library dependency.
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001148 local_include_dirs_set.update([gn_utils.label_to_path(d)
Patrick Rohrd0abc2a2022-10-31 13:29:16 -07001149 for d in target.include_dirs
1150 if not re.match('^//out/.*', d)])
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001151 module.local_include_dirs = sorted(list(local_include_dirs_set))
1152
1153 # Order matters for some targets. For example, base/time/time_exploded_icu.cc
1154 # in //base:base needs to have sysroot include after icu/source/common
1155 # include. So adding sysroot include at the end.
1156 for flag in target.cflags:
1157 if '--sysroot' in flag:
1158 module.local_include_dirs.append(flag[len('--sysroot=../../'):] + "/usr/include")
Patrick Rohr92d74122022-10-21 15:50:52 -07001159
1160 module_is_compiled = module.type not in ('genrule', 'filegroup')
1161 if module_is_compiled:
1162 # Don't try to inject library/source dependencies into genrules or
1163 # filegroups because they are not compiled in the traditional sense.
1164 module.defaults = [defaults_module]
1165 for lib in target.libs:
1166 # Generally library names should be mangled as 'libXXX', unless they
1167 # are HAL libraries (e.g., android.hardware.health@2.0) or AIDL c++ / NDK
1168 # libraries (e.g. "android.hardware.power.stats-V1-cpp")
1169 android_lib = lib if '@' in lib or "-cpp" in lib or "-ndk" in lib \
1170 else 'lib' + lib
1171 if lib in shared_library_allowlist:
1172 module.add_android_shared_lib(android_lib)
1173 if lib in static_library_allowlist:
1174 module.add_android_static_lib(android_lib)
1175
Patrick Rohrd9dd3b92022-11-09 16:15:30 -08001176 # Remove prohibited include directories
1177 module.local_include_dirs = [d for d in module.local_include_dirs
1178 if d not in local_include_dirs_denylist]
1179
1180
Patrick Rohr92d74122022-10-21 15:50:52 -07001181 # If the module is a static library, export all the generated headers.
1182 if module.type == 'cc_library_static':
1183 module.export_generated_headers = module.generated_headers
1184
Patrick Rohr92d74122022-10-21 15:50:52 -07001185 # dep_name is an unmangled GN target name (e.g. //foo:bar(toolchain)).
Motomu Utsumif1daa232022-11-08 13:28:37 +09001186 # Currently, only one module is generated from target even target has multiple toolchains.
1187 # And module is generated based on the first visited target.
1188 # Sort deps before iteration to make result deterministic.
1189 all_deps = sorted(target.deps | target.source_set_deps | target.transitive_proto_deps)
Patrick Rohr92d74122022-10-21 15:50:52 -07001190 for dep_name in all_deps:
Patrick Rohr5cc46e02022-10-26 14:32:45 -07001191 # |builtin_deps| override GN deps with Android-specific ones. See the
1192 # config in the top of this file.
1193 if gn_utils.label_without_toolchain(dep_name) in builtin_deps:
1194 builtin_deps[gn_utils.label_without_toolchain(dep_name)](module)
1195 continue
1196
Patrick Rohr92d74122022-10-21 15:50:52 -07001197 dep_module = create_modules_from_target(blueprint, gn, dep_name)
1198
Motomu Utsumie246feb2022-11-01 17:25:56 +09001199 # TODO: Proper dependency check for genrule.
1200 # Currently, only propagating genrule dependencies.
1201 # Also, currently, all the dependencies are propagated upwards.
1202 # in gn, public_deps should be propagated but deps should not.
1203 # Not sure this information is available in the desc.json.
1204 # Following rule works for adding android_runtime_jni_headers to base:base.
1205 # If this doesn't work for other target, hardcoding for specific target
1206 # might be better.
1207 if module.type == "genrule" and dep_module.type == "genrule":
1208 module.genrule_headers.add(dep_module.name)
1209 module.genrule_headers.update(dep_module.genrule_headers)
1210
Patrick Rohr92d74122022-10-21 15:50:52 -07001211 # For filegroups and genrule, recurse but don't apply the deps.
1212 if not module_is_compiled:
1213 continue
1214
Patrick Rohr92d74122022-10-21 15:50:52 -07001215 if dep_module is None:
1216 continue
1217 if dep_module.type == 'cc_library_shared':
1218 module.shared_libs.add(dep_module.name)
1219 elif dep_module.type == 'cc_library_static':
1220 module.static_libs.add(dep_module.name)
1221 elif dep_module.type == 'filegroup':
1222 module.srcs.add(':' + dep_module.name)
1223 elif dep_module.type == 'genrule':
1224 module.generated_headers.update(dep_module.genrule_headers)
1225 module.srcs.update(dep_module.genrule_srcs)
1226 module.shared_libs.update(dep_module.genrule_shared_libs)
Patrick Rohra1a27872022-10-31 11:57:14 -07001227 module.header_libs.update(dep_module.genrule_header_libs)
Patrick Rohr92d74122022-10-21 15:50:52 -07001228 elif dep_module.type == 'cc_binary':
1229 continue # Ignore executables deps (used by cmdline integration tests).
1230 else:
1231 raise Error('Unknown dep %s (%s) for target %s' %
1232 (dep_module.name, dep_module.type, module.name))
1233
Motomu Utsumi87c2a482022-11-14 14:57:46 +09001234 # TODO: support arch difference in generic way
1235 # Currently, it is expected that only a couple of modules (e.g. partition_alloc, boringssl)
1236 # need arch condition. So, for now, hardcoding arch condition
1237 if module.name == "cronet_aml_base_allocator_partition_allocator_partition_alloc":
1238 x86_srcs = module.srcs.copy()
1239 x86_srcs.remove(
1240 "base/allocator/partition_allocator/starscan/stack/asm/x64/push_registers_asm.cc")
1241 x86_srcs.add("base/allocator/partition_allocator/starscan/stack/asm/x86/push_registers_asm.cc")
1242 module.arch['x86'] = {'srcs': x86_srcs}
1243 module.arch['x86_64'] = {'srcs': module.srcs.copy()}
1244 module.srcs.clear()
1245
Patrick Rohr92d74122022-10-21 15:50:52 -07001246 return module
1247
Patrick Rohrb18aca22022-11-04 15:07:32 -07001248def create_java_module(blueprint, gn):
1249 bp_module_name = module_prefix + 'java'
1250 module = Module('java_library', bp_module_name, '//gn:java')
Mohannad Farrag21562d62022-11-07 13:09:31 +00001251 module.srcs.update([gn_utils.label_to_path(source) for source in gn.java_sources])
Patrick Rohrb18aca22022-11-04 15:07:32 -07001252 blueprint.add_module(module)
Patrick Rohr92d74122022-10-21 15:50:52 -07001253
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001254def update_jni_registration_module(blueprint, gn):
1255 bp_module_name = label_to_module_name('//components/cronet/android:cronet_jni_registration')
Patrick Rohr7f225422022-11-10 21:38:38 -08001256 if bp_module_name not in blueprint.modules:
1257 # To support building targets that might not create the cronet_jni_registration.
1258 return
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001259 module = blueprint.modules[bp_module_name]
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001260
1261 # TODO: deny list is in the arg of jni_registration_generator.py. Should not be hardcoded
1262 deny_list = [
1263 '//base/android/java/src/org/chromium/base/library_loader/LibraryLoader.java',
1264 '//base/android/java/src/org/chromium/base/library_loader/LibraryPrefetcher.java',
1265 '//base/android/java/src/org/chromium/base/process_launcher/ChildProcessService.java',
1266 '//base/android/java/src/org/chromium/base/SysUtils.java']
1267
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001268 # TODO: java_sources might not contain all the required java files
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001269 module.srcs.update([gn_utils.label_to_path(source)
1270 for source in gn.java_sources if source not in deny_list])
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001271
Motomu Utsumi79bd0c82022-11-10 17:52:24 +09001272 # TODO: Remove hardcoded file addition to srcs
1273 # jni_registration_generator.py generates empty .h file if native methods are not found in the
1274 # java files. But android:cronet depends on `RegisterNonMainDexNatives` which is in the template
1275 # of .h file. To make script generate non empty .h file, adding java file which contains native
1276 # method. Once all the required java files are added to the srcs, this can be removed.
1277 module.srcs.update([
1278 "components/cronet/android/java/src/org/chromium/net/impl/CronetUrlRequest.java"])
1279
Patrick Rohr92d74122022-10-21 15:50:52 -07001280def create_blueprint_for_targets(gn, desc, targets):
1281 """Generate a blueprint for a list of GN targets."""
1282 blueprint = Blueprint()
1283
1284 # Default settings used by all modules.
1285 defaults = Module('cc_defaults', defaults_module, '//gn:default_deps')
Patrick Rohr92d74122022-10-21 15:50:52 -07001286 defaults.cflags = [
Patrick Rohr3ce74772022-11-11 14:19:58 -08001287 '-DGOOGLE_PROTOBUF_NO_RTTI',
Patrick Rohr92d74122022-10-21 15:50:52 -07001288 '-Wno-error=return-type',
Patrick Rohr3a1ec1d2022-10-31 13:30:17 -07001289 '-Wno-non-virtual-dtor',
Patrick Rohr5c700022022-11-08 19:33:07 -08001290 '-Wno-macro-redefined',
Patrick Rohr98065152022-10-31 14:49:58 -07001291 '-Wno-missing-field-initializers',
Patrick Rohr92d74122022-10-21 15:50:52 -07001292 '-Wno-sign-compare',
1293 '-Wno-sign-promo',
1294 '-Wno-unused-parameter',
Mohannad Farragd98a96d2022-11-10 14:56:19 +00001295 '-Wno-deprecated-non-prototype', # needed for zlib
Patrick Rohr92d74122022-10-21 15:50:52 -07001296 '-fvisibility=hidden',
Motomu Utsumiba020942022-11-14 15:15:41 +09001297 '-Wno-ambiguous-reversed-operator', # needed for icui18n
Motomu Utsumib1ec8782022-11-14 15:25:57 +09001298 '-Wno-unreachable-code-loop-increment', # needed for icui18n
Patrick Rohr92d74122022-10-21 15:50:52 -07001299 '-O2',
1300 ]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001301 defaults.stl = 'none'
Patrick Rohr92d74122022-10-21 15:50:52 -07001302 blueprint.add_module(defaults)
Patrick Rohr344b2472022-10-25 11:32:15 -07001303
Patrick Rohr92d74122022-10-21 15:50:52 -07001304 for target in targets:
1305 create_modules_from_target(blueprint, gn, target)
Patrick Rohrb18aca22022-11-04 15:07:32 -07001306
1307 create_java_module(blueprint, gn)
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001308 update_jni_registration_module(blueprint, gn)
Patrick Rohra7d029d2022-11-08 12:23:11 -08001309
1310 # Merge in additional hardcoded arguments.
1311 for module in blueprint.modules.values():
1312 for key, add_val in additional_args.get(module.name, []):
1313 curr = getattr(module, key)
1314 if add_val and isinstance(add_val, set) and isinstance(curr, set):
1315 curr.update(add_val)
1316 elif isinstance(add_val, str) and (not curr or isinstance(curr, str)):
1317 setattr(module, key, add_val)
1318 elif isinstance(add_val, bool) and (not curr or isinstance(curr, bool)):
1319 setattr(module, key, add_val)
1320 elif isinstance(add_val, dict) and isinstance(curr, dict):
1321 curr.update(add_val)
1322 elif isinstance(add_val, dict) and isinstance(curr, Target):
1323 curr.__dict__.update(add_val)
1324 else:
1325 raise Error('Unimplemented type %r of additional_args: %r' %
1326 (type(add_val), key))
1327
Patrick Rohr92d74122022-10-21 15:50:52 -07001328 return blueprint
1329
1330
1331def main():
1332 parser = argparse.ArgumentParser(
1333 description='Generate Android.bp from a GN description.')
1334 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001335 '--desc',
Patrick Rohr3db246a2022-10-25 10:25:17 -07001336 help='GN description (e.g., gn desc out --format=json --all-toolchains "//*"',
1337 required=True
Patrick Rohr92d74122022-10-21 15:50:52 -07001338 )
1339 parser.add_argument(
1340 '--extras',
1341 help='Extra targets to include at the end of the Blueprint file',
1342 default=os.path.join(gn_utils.repo_root(), 'Android.bp.extras'),
1343 )
1344 parser.add_argument(
1345 '--output',
1346 help='Blueprint file to create',
1347 default=os.path.join(gn_utils.repo_root(), 'Android.bp'),
1348 )
1349 parser.add_argument(
Patrick Rohr16228942022-10-26 14:00:26 -07001350 '-v',
1351 '--verbose',
1352 help='Print debug logs.',
1353 action='store_true',
1354 )
1355 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001356 'targets',
1357 nargs=argparse.REMAINDER,
Patrick Rohr1aa504a2022-10-25 10:30:42 -07001358 help='Targets to include in the blueprint (e.g., "//:perfetto_tests")'
1359 )
Patrick Rohr92d74122022-10-21 15:50:52 -07001360 args = parser.parse_args()
1361
Patrick Rohr16228942022-10-26 14:00:26 -07001362 if args.verbose:
1363 log.basicConfig(format='%(levelname)s:%(funcName)s:%(message)s', level=log.DEBUG)
1364
Patrick Rohr3db246a2022-10-25 10:25:17 -07001365 with open(args.desc) as f:
1366 desc = json.load(f)
Patrick Rohr92d74122022-10-21 15:50:52 -07001367
1368 gn = gn_utils.GnParser(desc)
Patrick Rohr06296362022-11-10 21:37:33 -08001369 blueprint = create_blueprint_for_targets(gn, desc, args.targets or default_targets)
Patrick Rohr92d74122022-10-21 15:50:52 -07001370 project_root = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
1371 tool_name = os.path.relpath(os.path.abspath(__file__), project_root)
1372
Patrick Rohr92d74122022-10-21 15:50:52 -07001373 # Add any proto groups to the blueprint.
1374 for l_name, t_names in proto_groups.items():
1375 create_proto_group_modules(blueprint, gn, l_name, t_names)
1376
1377 output = [
Patrick Rohr5478b392022-10-25 09:58:50 -07001378 """// Copyright (C) 2022 The Android Open Source Project
Patrick Rohr92d74122022-10-21 15:50:52 -07001379//
1380// Licensed under the Apache License, Version 2.0 (the "License");
1381// you may not use this file except in compliance with the License.
1382// You may obtain a copy of the License at
1383//
1384// http://www.apache.org/licenses/LICENSE-2.0
1385//
1386// Unless required by applicable law or agreed to in writing, software
1387// distributed under the License is distributed on an "AS IS" BASIS,
1388// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1389// See the License for the specific language governing permissions and
1390// limitations under the License.
1391//
1392// This file is automatically generated by %s. Do not edit.
1393""" % (tool_name)
1394 ]
1395 blueprint.to_string(output)
Patrick Rohrcb98e9b2022-10-25 09:57:02 -07001396 if os.path.exists(args.extras):
1397 with open(args.extras, 'r') as r:
1398 for line in r:
1399 output.append(line.rstrip("\n\r"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001400
1401 out_files = []
1402
1403 # Generate the Android.bp file.
1404 out_files.append(args.output + '.swp')
1405 with open(out_files[-1], 'w') as f:
1406 f.write('\n'.join(output))
1407 # Text files should have a trailing EOL.
1408 f.write('\n')
1409
Patrick Rohr94693eb2022-10-25 10:09:16 -07001410 return 0
Patrick Rohr92d74122022-10-21 15:50:52 -07001411
1412
1413if __name__ == '__main__':
1414 sys.exit(main())