blob: 1b550bcb200adb50c15a313fd411188cdbe52c1c [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
220# Android equivalents for third-party libraries that the upstream project
221# depends on.
222builtin_deps = {
223 '//gn:default_deps':
224 lambda x: None,
225 '//gn:gtest_main':
226 lambda x: None,
Patrick Rohr92d74122022-10-21 15:50:52 -0700227 '//gn:gtest_and_gmock':
228 enable_gtest_and_gmock,
229 '//gn:libunwind':
230 enable_libunwind,
Patrick Rohr92d74122022-10-21 15:50:52 -0700231 '//gn:libunwindstack':
232 enable_libunwindstack,
233 '//gn:sqlite':
234 enable_sqlite,
235 '//gn:zlib':
236 enable_zlib,
237 '//gn:bionic_kernel_uapi_headers':
238 enable_uapi_headers,
239 '//src/profiling/memory:bionic_libc_platform_headers_on_android':
240 enable_bionic_libc_platform_headers_on_android,
Motomu Utsumidfc8e6a2022-11-04 18:25:33 +0900241 '//third_party/protobuf:protoc':
242 lambda x: None,
Patrick Rohr84b16402022-11-08 19:01:01 -0800243 '//third_party/protobuf:protobuf_full':
244 enable_protobuf_full,
245 '//third_party/protobuf:protobuf_lite':
246 enable_protobuf_lite,
247 '//third_party/protobuf:protoc_lib':
248 enable_protoc_lib,
Patrick Rohr92d74122022-10-21 15:50:52 -0700249}
250
251# ----------------------------------------------------------------------------
252# End of configuration.
253# ----------------------------------------------------------------------------
254
255
256class Error(Exception):
257 pass
258
259
260class ThrowingArgumentParser(argparse.ArgumentParser):
261
262 def __init__(self, context):
263 super(ThrowingArgumentParser, self).__init__()
264 self.context = context
265
266 def error(self, message):
267 raise Error('%s: %s' % (self.context, message))
268
269
270def write_blueprint_key_value(output, name, value, sort=True):
271 """Writes a Blueprint key-value pair to the output"""
272
273 if isinstance(value, bool):
274 if value:
275 output.append(' %s: true,' % name)
276 else:
277 output.append(' %s: false,' % name)
278 return
279 if not value:
280 return
281 if isinstance(value, set):
282 value = sorted(value)
283 if isinstance(value, list):
284 output.append(' %s: [' % name)
285 for item in sorted(value) if sort else value:
286 output.append(' "%s",' % item)
287 output.append(' ],')
288 return
289 if isinstance(value, Target):
290 value.to_string(output)
291 return
292 if isinstance(value, dict):
293 kv_output = []
294 for k, v in value.items():
295 write_blueprint_key_value(kv_output, k, v)
296
297 output.append(' %s: {' % name)
298 for line in kv_output:
299 output.append(' %s' % line)
300 output.append(' },')
301 return
302 output.append(' %s: "%s",' % (name, value))
303
304
305class Target(object):
306 """A target-scoped part of a module"""
307
308 def __init__(self, name):
309 self.name = name
310 self.shared_libs = set()
311 self.static_libs = set()
312 self.whole_static_libs = set()
313 self.cflags = set()
314 self.dist = dict()
315 self.strip = dict()
316 self.stl = None
317
318 def to_string(self, output):
319 nested_out = []
320 self._output_field(nested_out, 'shared_libs')
321 self._output_field(nested_out, 'static_libs')
322 self._output_field(nested_out, 'whole_static_libs')
323 self._output_field(nested_out, 'cflags')
324 self._output_field(nested_out, 'stl')
325 self._output_field(nested_out, 'dist')
326 self._output_field(nested_out, 'strip')
327
328 if nested_out:
329 output.append(' %s: {' % self.name)
330 for line in nested_out:
331 output.append(' %s' % line)
332 output.append(' },')
333
334 def _output_field(self, output, name, sort=True):
335 value = getattr(self, name)
336 return write_blueprint_key_value(output, name, value, sort)
337
338
339class Module(object):
340 """A single module (e.g., cc_binary, cc_test) in a blueprint."""
341
342 def __init__(self, mod_type, name, gn_target):
343 self.type = mod_type
344 self.gn_target = gn_target
345 self.name = name
346 self.srcs = set()
347 self.comment = 'GN: ' + gn_utils.label_without_toolchain(gn_target)
348 self.shared_libs = set()
349 self.static_libs = set()
350 self.whole_static_libs = set()
351 self.runtime_libs = set()
352 self.tools = set()
353 self.cmd = None
354 self.host_supported = False
355 self.vendor_available = False
356 self.init_rc = set()
357 self.out = set()
358 self.export_include_dirs = set()
359 self.generated_headers = set()
360 self.export_generated_headers = set()
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800361 self.export_static_lib_headers = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700362 self.defaults = set()
363 self.cflags = set()
364 self.include_dirs = set()
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900365 self.local_include_dirs = []
Patrick Rohr92d74122022-10-21 15:50:52 -0700366 self.header_libs = set()
367 self.required = set()
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700368 self.tool_files = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700369 self.android = Target('android')
370 self.host = Target('host')
Patrick Rohr92d74122022-10-21 15:50:52 -0700371 self.stl = None
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700372 self.cpp_std = None
Patrick Rohr92d74122022-10-21 15:50:52 -0700373 self.dist = dict()
374 self.strip = dict()
375 self.data = set()
376 self.apex_available = set()
377 self.min_sdk_version = None
378 self.proto = dict()
Patrick Rohrd90025f2022-11-11 14:18:35 -0800379 self.linker_scripts = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700380 # The genrule_XXX below are properties that must to be propagated back
381 # on the module(s) that depend on the genrule.
382 self.genrule_headers = set()
383 self.genrule_srcs = set()
384 self.genrule_shared_libs = set()
Patrick Rohra1a27872022-10-31 11:57:14 -0700385 self.genrule_header_libs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700386 self.version_script = None
387 self.test_suites = set()
388 self.test_config = None
389 self.stubs = {}
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000390 self.cppflags = set()
391 self.rtti = False
Motomu Utsumi87c2a482022-11-14 14:57:46 +0900392 self.arch = dict()
Patrick Rohr92d74122022-10-21 15:50:52 -0700393
394 def to_string(self, output):
395 if self.comment:
396 output.append('// %s' % self.comment)
397 output.append('%s {' % self.type)
398 self._output_field(output, 'name')
399 self._output_field(output, 'srcs')
400 self._output_field(output, 'shared_libs')
401 self._output_field(output, 'static_libs')
402 self._output_field(output, 'whole_static_libs')
403 self._output_field(output, 'runtime_libs')
404 self._output_field(output, 'tools')
405 self._output_field(output, 'cmd', sort=False)
406 if self.host_supported:
407 self._output_field(output, 'host_supported')
408 if self.vendor_available:
409 self._output_field(output, 'vendor_available')
410 self._output_field(output, 'init_rc')
411 self._output_field(output, 'out')
412 self._output_field(output, 'export_include_dirs')
413 self._output_field(output, 'generated_headers')
414 self._output_field(output, 'export_generated_headers')
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800415 self._output_field(output, 'export_static_lib_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -0700416 self._output_field(output, 'defaults')
417 self._output_field(output, 'cflags')
418 self._output_field(output, 'include_dirs')
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900419 self._output_field(output, 'local_include_dirs', sort=False)
Patrick Rohr92d74122022-10-21 15:50:52 -0700420 self._output_field(output, 'header_libs')
421 self._output_field(output, 'required')
422 self._output_field(output, 'dist')
423 self._output_field(output, 'strip')
424 self._output_field(output, 'tool_files')
425 self._output_field(output, 'data')
426 self._output_field(output, 'stl')
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700427 self._output_field(output, 'cpp_std')
Patrick Rohr92d74122022-10-21 15:50:52 -0700428 self._output_field(output, 'apex_available')
429 self._output_field(output, 'min_sdk_version')
430 self._output_field(output, 'version_script')
431 self._output_field(output, 'test_suites')
432 self._output_field(output, 'test_config')
433 self._output_field(output, 'stubs')
434 self._output_field(output, 'proto')
Patrick Rohrd90025f2022-11-11 14:18:35 -0800435 self._output_field(output, 'linker_scripts')
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000436 self._output_field(output, 'cppflags')
437 if self.rtti:
438 self._output_field(output, 'rtti')
Motomu Utsumi87c2a482022-11-14 14:57:46 +0900439 self._output_field(output, 'arch')
Patrick Rohr92d74122022-10-21 15:50:52 -0700440
441 target_out = []
442 self._output_field(target_out, 'android')
443 self._output_field(target_out, 'host')
444 if target_out:
445 output.append(' target: {')
446 for line in target_out:
447 output.append(' %s' % line)
448 output.append(' },')
449
Patrick Rohr92d74122022-10-21 15:50:52 -0700450 output.append('}')
451 output.append('')
452
453 def add_android_static_lib(self, lib):
454 if self.type == 'cc_binary_host':
455 raise Exception('Adding Android static lib for host tool is unsupported')
456 elif self.host_supported:
457 self.android.static_libs.add(lib)
458 else:
459 self.static_libs.add(lib)
460
461 def add_android_shared_lib(self, lib):
462 if self.type == 'cc_binary_host':
463 raise Exception('Adding Android shared lib for host tool is unsupported')
464 elif self.host_supported:
465 self.android.shared_libs.add(lib)
466 else:
467 self.shared_libs.add(lib)
468
469 def _output_field(self, output, name, sort=True):
470 value = getattr(self, name)
471 return write_blueprint_key_value(output, name, value, sort)
472
473
474class Blueprint(object):
475 """In-memory representation of an Android.bp file."""
476
477 def __init__(self):
478 self.modules = {}
479
480 def add_module(self, module):
481 """Adds a new module to the blueprint, replacing any existing module
482 with the same name.
483
484 Args:
485 module: Module instance.
486 """
487 self.modules[module.name] = module
488
489 def to_string(self, output):
Patrick Rohr23f26192022-10-25 09:45:22 -0700490 for m in sorted(self.modules.values(), key=lambda m: m.name):
Patrick Rohr92d74122022-10-21 15:50:52 -0700491 m.to_string(output)
492
493
494def label_to_module_name(label):
495 """Turn a GN label (e.g., //:perfetto_tests) into a module name."""
496 # If the label is explicibly listed in the default target list, don't prefix
497 # its name and return just the target name. This is so tools like
498 # "traceconv" stay as such in the Android tree.
499 label_without_toolchain = gn_utils.label_without_toolchain(label)
Patrick Rohr92d74122022-10-21 15:50:52 -0700500 module = re.sub(r'^//:?', '', label_without_toolchain)
501 module = re.sub(r'[^a-zA-Z0-9_]', '_', module)
502 if not module.startswith(module_prefix):
503 return module_prefix + module
504 return module
505
506
507def is_supported_source_file(name):
508 """Returns True if |name| can appear in a 'srcs' list."""
Patrick Rohrf9f3a992022-11-10 19:40:32 -0800509 return os.path.splitext(name)[1] in ['.c', '.cc', '.cpp', '.java', '.proto', '.S']
Patrick Rohr92d74122022-10-21 15:50:52 -0700510
511
512def create_proto_modules(blueprint, gn, target):
513 """Generate genrules for a proto GN target.
514
515 GN actions are used to dynamically generate files during the build. The
516 Soong equivalent is a genrule. This function turns a specific kind of
517 genrule which turns .proto files into source and header files into a pair
518 equivalent genrules.
519
520 Args:
521 blueprint: Blueprint instance which is being generated.
522 target: gn_utils.Target object.
523
524 Returns:
525 The source_genrule module.
526 """
527 assert (target.type == 'proto_library')
528
529 tools = {'aprotoc'}
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900530 cpp_out_dir = '$(genDir)/%s/%s/' % (tree_path, target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700531 target_module_name = label_to_module_name(target.name)
532
533 # In GN builds the proto path is always relative to the output directory
534 # (out/tmp.xxx).
Motomu Utsumie8457452022-11-08 18:47:51 +0900535 cmd = ['$(location aprotoc)']
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900536 cmd += ['--proto_path=%s/%s' % (tree_path, target.proto_in_dir)]
Patrick Rohr92d74122022-10-21 15:50:52 -0700537
538 if buildtools_protobuf_src in target.proto_paths:
539 cmd += ['--proto_path=%s' % android_protobuf_src]
540
541 # We don't generate any targets for source_set proto modules because
542 # they will be inlined into other modules if required.
543 if target.proto_plugin == 'source_set':
544 return None
545
546 # Descriptor targets only generate a single target.
547 if target.proto_plugin == 'descriptor':
548 out = '{}.bin'.format(target_module_name)
549
550 cmd += ['--descriptor_set_out=$(out)']
551 cmd += ['$(in)']
552
553 descriptor_module = Module('genrule', target_module_name, target.name)
554 descriptor_module.cmd = ' '.join(cmd)
555 descriptor_module.out = [out]
556 descriptor_module.tools = tools
557 blueprint.add_module(descriptor_module)
558
559 # Recursively extract the .proto files of all the dependencies and
560 # add them to srcs.
561 descriptor_module.srcs.update(
562 gn_utils.label_to_path(src) for src in target.sources)
563 for dep in target.transitive_proto_deps:
564 current_target = gn.get_target(dep)
565 descriptor_module.srcs.update(
566 gn_utils.label_to_path(src) for src in current_target.sources)
567
568 return descriptor_module
569
570 # We create two genrules for each proto target: one for the headers and
571 # another for the sources. This is because the module that depends on the
572 # generated files needs to declare two different types of dependencies --
573 # source files in 'srcs' and headers in 'generated_headers' -- and it's not
574 # valid to generate .h files from a source dependency and vice versa.
575 source_module_name = target_module_name + '_gen'
576 source_module = Module('genrule', source_module_name, target.name)
577 blueprint.add_module(source_module)
578 source_module.srcs.update(
579 gn_utils.label_to_path(src) for src in target.sources)
580
581 header_module = Module('genrule', source_module_name + '_headers',
582 target.name)
583 blueprint.add_module(header_module)
584 header_module.srcs = set(source_module.srcs)
585
586 # TODO(primiano): at some point we should remove this. This was introduced
587 # by aosp/1108421 when adding "protos/" to .proto include paths, in order to
588 # avoid doing multi-repo changes and allow old clients in the android tree
589 # to still do the old #include "perfetto/..." rather than
590 # #include "protos/perfetto/...".
591 header_module.export_include_dirs = {'.', 'protos'}
Patrick Rohr2267a0a2022-11-08 18:59:34 -0800592 # Since the .cc file and .h get created by a different gerule target, they
593 # are not put in the same intermediate path, so local includes do not work
594 # without explictily exporting the include dir.
595 header_module.export_include_dirs.add(target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700596
597 source_module.genrule_srcs.add(':' + source_module.name)
598 source_module.genrule_headers.add(header_module.name)
599
600 if target.proto_plugin == 'proto':
601 suffixes = ['pb']
602 source_module.genrule_shared_libs.add('libprotobuf-cpp-lite')
603 cmd += ['--cpp_out=lite=true:' + cpp_out_dir]
604 elif target.proto_plugin == 'protozero':
605 suffixes = ['pbzero']
606 plugin = create_modules_from_target(blueprint, gn, protozero_plugin)
607 tools.add(plugin.name)
608 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
609 cmd += ['--plugin_out=wrapper_namespace=pbzero:' + cpp_out_dir]
610 elif target.proto_plugin == 'cppgen':
611 suffixes = ['gen']
612 plugin = create_modules_from_target(blueprint, gn, cppgen_plugin)
613 tools.add(plugin.name)
614 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
615 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
616 elif target.proto_plugin == 'ipc':
617 suffixes = ['ipc']
618 plugin = create_modules_from_target(blueprint, gn, ipc_plugin)
619 tools.add(plugin.name)
620 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
621 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
622 else:
623 raise Error('Unsupported proto plugin: %s' % target.proto_plugin)
624
625 cmd += ['$(in)']
626 source_module.cmd = ' '.join(cmd)
627 header_module.cmd = source_module.cmd
628 source_module.tools = tools
629 header_module.tools = tools
630
631 for sfx in suffixes:
632 source_module.out.update('%s/%s' %
633 (tree_path, src.replace('.proto', '.%s.cc' % sfx))
634 for src in source_module.srcs)
635 header_module.out.update('%s/%s' %
636 (tree_path, src.replace('.proto', '.%s.h' % sfx))
637 for src in header_module.srcs)
638 return source_module
639
640
641def create_amalgamated_sql_metrics_module(blueprint, target):
642 bp_module_name = label_to_module_name(target.name)
643 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700644 module.tool_files.add('tools/gen_amalgamated_sql_metrics.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700645 module.cmd = ' '.join([
646 '$(location tools/gen_amalgamated_sql_metrics.py)',
647 '--cpp_out=$(out)',
648 '$(in)',
649 ])
650 module.genrule_headers.add(module.name)
651 module.out.update(target.outputs)
652 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
653 blueprint.add_module(module)
654 return module
655
656
657def create_cc_proto_descriptor_module(blueprint, target):
658 bp_module_name = label_to_module_name(target.name)
659 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700660 module.tool_files.add('tools/gen_cc_proto_descriptor.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700661 module.cmd = ' '.join([
662 '$(location tools/gen_cc_proto_descriptor.py)', '--gen_dir=$(genDir)',
663 '--cpp_out=$(out)', '$(in)'
664 ])
665 module.genrule_headers.add(module.name)
666 module.srcs.update(
667 ':' + label_to_module_name(dep) for dep in target.proto_deps)
668 module.srcs.update(
669 gn_utils.label_to_path(src)
670 for src in target.inputs
671 if "tmp.gn_utils" not in src)
672 module.out.update(target.outputs)
673 blueprint.add_module(module)
674 return module
675
676
677def create_gen_version_module(blueprint, target, bp_module_name):
678 module = Module('genrule', bp_module_name, gn_utils.GEN_VERSION_TARGET)
679 script_path = gn_utils.label_to_path(target.script)
680 module.genrule_headers.add(bp_module_name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700681 module.tool_files.add(script_path)
Patrick Rohr92d74122022-10-21 15:50:52 -0700682 module.out.update(target.outputs)
683 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
684 module.cmd = ' '.join([
685 'python3 $(location %s)' % script_path, '--no_git',
686 '--changelog=$(location CHANGELOG)', '--cpp_out=$(out)'
687 ])
688 blueprint.add_module(module)
689 return module
690
691
692def create_proto_group_modules(blueprint, gn, module_name, target_names):
693 # TODO(lalitm): today, we're only adding a Java lite module because that's
694 # the only one used in practice. In the future, if we need other target types
695 # (e.g. C++, Java full etc.) add them here.
696 bp_module_name = label_to_module_name(module_name) + '_java_protos'
697 module = Module('java_library', bp_module_name, bp_module_name)
698 module.comment = f'''GN: [{', '.join(target_names)}]'''
699 module.proto = {'type': 'lite', 'canonical_path_from_root': False}
700
701 for name in target_names:
702 target = gn.get_target(name)
703 module.srcs.update(gn_utils.label_to_path(src) for src in target.sources)
704 for dep_label in target.transitive_proto_deps:
705 dep = gn.get_target(dep_label)
706 module.srcs.update(gn_utils.label_to_path(src) for src in dep.sources)
707
708 blueprint.add_module(module)
709
Motomu Utsumia6c33152022-11-02 18:21:55 +0900710# HACK: Need to support build_cofig_gen flexibly instead of hardcoding
711# build_config_gen generates srcjar by executing gcc via gcc_preprocess.py but gcc is not
712# available in genrule sandbox. Also gcc path is not configurable.
713# Under the //net:net, gcc_preprocess.py is only used for build_config_gen.
714# So, for now, hardcoding BuildConfig.java and generates srcjar by soong_zip.
715def override_build_config_gen(module):
716 module.tool_files.clear()
717 module.tools.add("soong_zip")
718 cmd = [
719 "echo",
720 "\\\"package org.chromium.build;\\n",
721 "public class BuildConfig {\\n",
722 "public static boolean IS_MULTIDEX_ENABLED ;\\n",
723 "public static boolean ENABLE_ASSERTS = true;\\n",
724 "public static boolean IS_UBSAN ;\\n",
725 "public static boolean IS_CHROME_BRANDED ;\\n",
726 "public static int R_STRING_PRODUCT_VERSION ;\\n",
727 "public static int MIN_SDK_VERSION = 1;\\n",
728 "public static boolean BUNDLES_SUPPORTED ;\\n",
729 "public static boolean IS_INCREMENTAL_INSTALL ;\\n",
730 "public static boolean ISOLATED_SPLITS_ENABLED ;\\n",
731 "public static boolean IS_FOR_TEST ;\\n",
732 "}\\n\\\"",
733 "> $(genDir)/BuildConfig.java &&",
734 "$(location soong_zip) -o $(out) -srcjar -f $(genDir)/BuildConfig.java"
735 ]
736 NEWLINE = ' " +\n "'
737 module.cmd = NEWLINE.join(cmd)
738 return module
739
Mohannad Farragbab6c892022-11-02 14:09:46 +0000740def create_action_foreach_modules(blueprint, target):
741 """ The following assumes that rebase_path exists in the args.
742 The args of an action_foreach contains hints about which output files are generated
743 by which source files.
744 This is copied directly from the args
745 "gen/net/base/registry_controlled_domains/{{source_name_part}}-reversed-inc.cc"
746 So each source file will generate an output whose name is the {source_name-reversed-inc.cc}
747 """
748 new_args = []
Motomu Utsumi56afcac2022-11-04 12:58:30 +0900749 for i, src in enumerate(sorted(target.sources)):
Mohannad Farragbab6c892022-11-02 14:09:46 +0000750 # don't add script arg for the first source -- create_action_module
751 # already does this.
752 if i != 0:
753 new_args.append('&& python3 $(location %s)' %
754 gn_utils.label_to_path(target.script))
755 for arg in target.args:
756 if '{{source}}' in arg:
757 new_args.append('$(location %s)' % (gn_utils.label_to_path(src)))
758 elif '{{source_name_part}}' in arg:
759 source_name_part = src.split("/")[-1] # Get the file name only
760 source_name_part = source_name_part.split(".")[0] # Remove the extension (Ex: .cc)
761 file_name = arg.replace('{{source_name_part}}', source_name_part).split("/")[-1]
762 # file_name represent the output file name. But we need the whole path
763 # This can be found from target.outputs.
764 for out in target.outputs:
765 if out.endswith(file_name):
766 new_args.append('$(location %s)' % out)
767 else:
768 new_args.append(arg)
769
770 target.args = new_args
771 return create_action_module(blueprint, target)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900772
Patrick Rohr7be99032022-10-31 11:54:19 -0700773def create_action_module(blueprint, target):
774 bp_module_name = label_to_module_name(target.name)
775 module = Module('genrule', bp_module_name, target.name)
776
Patrick Rohr9b99a982022-10-28 11:00:57 -0700777 # Convert ['--param=value'] to ['--param', 'value'] for consistency.
778 # TODO: we may want to only do this for python scripts arguments. If argparse
779 # is used, this transformation is safe.
780 target.args = [str for it in target.args for str in it.split('=')]
781
Motomu Utsumibf569d42022-10-28 16:47:34 +0900782 if target.script == "//build/write_buildflag_header.py":
783 # write_buildflag_header.py writes result to args.genDir/args.output
784 # So, override args.genDir by '.' so that args.output=$(out) works
Patrick Rohrde568a22022-10-28 09:22:35 -0700785 for i, val in enumerate(target.args):
786 if val == '--gen-dir':
787 target.args[i + 1] = '.'
Patrick Rohrfa972402022-11-01 11:54:35 -0700788 elif val == '--output':
789 target.args[i + 1] = '$(out)'
790
791 elif target.script == '//build/write_build_date_header.py':
792 target.args[0] = '$(out)'
Patrick Rohr0db9f852022-10-27 13:49:57 -0700793
Patrick Rohr8acccca2022-10-28 10:39:06 -0700794 elif target.script == '//base/android/jni_generator/jni_generator.py':
Patrick Rohrc5cc21a2022-10-31 11:57:49 -0700795 # chromium builds against a prebuilt ndk that contains the jni_headers, so
796 # a dependency is never explicitly created.
797 module.genrule_header_libs.add('jni_headers')
Patrick Rohr131ba282022-10-31 16:36:20 -0700798 needs_javap = False
Patrick Rohr8acccca2022-10-28 10:39:06 -0700799 for i, val in enumerate(target.args):
Motomu Utsumi6f9139d2022-10-31 12:15:19 +0900800 if val == '--output_dir':
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700801 # replace --output_dir gen/jni_headers/... with --output_dir $(genDir)/...
802 target.args[i + 1] = re.sub('^gen/jni_headers', '$(genDir)', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700803 elif val == '--input_file':
Patrick Rohr8acccca2022-10-28 10:39:06 -0700804 # --input_file supports both .class specifiers or source files as arguments.
805 # Only source files need to be wrapped inside a $(location <label>) tag.
806 if re.match('.*\.class$', target.args[i + 1]):
807 continue
808 # replace --input_file ../../... with --input_file $(location ...)
809 # TODO: put inside function
810 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
811 target.args[i + 1] = '$(location %s)' % filename
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700812 elif val == '--includes' and 'jni_generator_helper' in target.args[i + 1]:
Patrick Rohrd89e8bf2022-10-31 14:51:05 -0700813 # delete all leading ../
814 target.args[i + 1] = re.sub('^(\.\./)+', '', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700815 elif val == '--prev_output_dir':
Patrick Rohr131ba282022-10-31 16:36:20 -0700816 # this is not needed for aosp builds.
817 target.args[i] = ''
818 target.args[i + 1] = ''
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700819 elif val == '--jar_file':
Patrick Rohr131ba282022-10-31 16:36:20 -0700820 # delete leading ../../ and add path to javap
821 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
822 target.args[i + 1] = '$(location %s)' % filename
823 needs_javap = True
824
825 if needs_javap:
826 target.args.append('--javap')
827 target.args.append('$$(find out/.path -name javap)')
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700828 # fix target.output directory to match #include statements.
829 target.outputs = [re.sub('^jni_headers/', '', out) for out in target.outputs]
Patrick Rohr8acccca2022-10-28 10:39:06 -0700830
Patrick Rohrf6d2b612022-11-09 12:30:26 -0800831 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
832 # jni_registration_generator.py pulls in some config dependencies that we
833 # do not handle. Remove them.
834 # TODO: find a better way to do this.
835 target.deps.clear()
836
Motomu Utsumied009082022-11-10 16:26:44 +0900837 target.inputs = [file for file in target.inputs if not file.startswith('//out/')]
Motomu Utsumi6b4acaa2022-11-10 16:13:24 +0900838 for i, val in enumerate(target.args):
839 if val in ['--depfile', '--srcjar-path', '--header-path']:
840 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900841 if val == '--sources-files':
842 target.args[i + 1] = '$(genDir)/java.sources'
Motomu Utsumi47d122f2022-11-10 17:32:23 +0900843 elif val == '--sources-exclusions':
844 # update_jni_registration_module removes them from the srcs of the module
845 # It might be better to remove sources by '--sources-exclusions'
846 target.args[i] = ''
847 target.args[i + 1] = ''
Motomu Utsumi6b4acaa2022-11-10 16:13:24 +0900848
Patrick Rohr245df582022-11-01 16:59:45 -0700849 elif target.script == '//build/android/gyp/write_build_config.py':
850 for i, val in enumerate(target.args):
851 if val == '--depfile':
852 # Depfile is not used, so no need to generate it.
853 target.args[i] = ''
854 target.args[i + 1] = ''
855 elif val in ['--deps-configs', '--bundled-srcjars']:
856 args = target.args[i + 1]
857 if args == '[]':
858 continue
859 # strip surrounding [] and split by ", "
860 args = args.strip('[]').split(', ')
861 # strip surrounding ""
862 args = [arg.strip('"') for arg in args]
863 # remove leading gen/
864 args = [re.sub('^gen/', '', arg) for arg in args]
865 # wrap filename in \"$(location filename)\"
866 args = ['\"$(location %s)\"' % arg for arg in args]
867 # join args with ", " and wrap in []
868 target.args[i + 1] = '[%s]' % ', '.join(args)
869
870 elif val == '--public-deps-configs':
871 # TODO: implement.
872 pass
873
874 elif val == '--build-config':
875 # json output of this script
876 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
877
878 elif val in ['--unprocessed-jar-path', '--interface-jar-path',
879 '--device-jar-path', '--host-jar-path']:
880 # jar path can be within sources (../../) or output generated by
881 # another genrule (obj/)
882 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
883 filename = re.sub('^obj/', '', target.args[i + 1])
884 target.args[i + 1] = '$(location %s)' % filename
885
886 elif val == '--proguard-configs':
887 args = target.args[i + 1]
888 if args == '[]':
889 continue
890 # TODO: consider adding helpers to deal with argument lists
891 # strip surrounding [] and split by ", ", then strip surrounding ""
892 args = args.strip('[]').split(', ')
893 args = [arg.strip('"') for arg in args]
894 # remove leading ../../
895 args = [re.sub('^\.\./\.\./', '', arg) for arg in args]
896 # add dependency on proguard config file, so a $(location) wrapper can be used.
897 module.tool_files.update(args)
898 # wrap filename in \"$(location filename)\"
899 args = ['$(location %s)' % arg for arg in args]
900 target.args[i + 1] = '[%s]' % ', '.join(args)
Motomu Utsumi1caa39b2022-11-02 18:38:13 +0900901 elif target.script == "//build/android/gyp/write_native_libraries_java.py":
902 for i, val in enumerate(target.args):
903 if val == '--output':
904 target.args[i + 1] = '$(out)'
Motomu Utsumi26211dc2022-11-02 19:38:47 +0900905 elif target.script == "//tools/grit/stamp_grit_sources.py":
906 target.outputs = [re.sub('^\/\/', '', out) for out in target.outputs]
907 # Directory that contains grit scripts
908 target.args[0] = '`dirname $(location tools/grit/grit.py)`'
909 # Path to the stamp file
910 target.args[1] = '$(out)'
911 # Script tries to create args[2] file but this is not in the output.
912 # Specifying file under $(genDir) so that parent directory exists.
913 # If this file is used by other module, we may need to add this file to the outputs.
914 target.args[2] = '$(genDir)/' + target.args[2].split('/')[-1]
Mohannad Farrag033c9d62022-11-07 14:55:49 +0000915 elif target.script == "//tools/grit/grit.py":
916 for i, val in enumerate(target.args):
917 if val == '-i':
918 # Delete leading ../..
919 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
920 target.args[i + 1] = '$(location %s)' % filename
921 elif val == '-o':
922 filename = re.sub('^gen/', '', target.args[i + 1])
923 if filename == "net":
924 # This is a directory not a file
925 target.args[i + 1] = '$(genDir)/net'
926 else:
927 # This is an output fil
928 target.args[i + 1] = '$(location %s)' % filename
929 elif val == '--depfile':
930 # The depfile is replaced by adding /tools/**/*.py to the tools_files
931 # This is basically just globbing all the needed sources by hardcoding.
932 module.tool_files.update([
933 "tools/grit/**/*.py",
934 "third_party/six/src/six.py" # This is not picked up by default. Must be added
935 ])
936
937 # Delete the depfile argument
938 target.args[i] = ' '
939 target.args[i + 1] = ' '
940 elif val == '--input':
941 # Delete leading ../..
942 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
943 # This is an output file so use $(location %s)
944 target.args[i + 1] = '$(location %s)' % filename
Motomu Utsumia0cc6662022-11-09 15:22:27 +0900945 elif target.script == "//net/tools/dafsa/make_dafsa.py":
946 # This script generates .cc files but source (registry_controlled_domain.cc) in the target that
947 # depends on this target includes .cc file this script generates.
948 module.genrule_headers.add(module.name)
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900949 elif target.script == "//build/util/version.py":
Motomu Utsumib0a49e42022-11-09 18:12:27 +0900950 # android_chrome_version.py is not specified in anywhere but version.py imports this file
951 module.tool_files.add('build/util/android_chrome_version.py')
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900952 for i, val in enumerate(target.args):
953 if val.startswith('../../'):
954 filename = re.sub('^\.\./\.\./', '', val)
955 target.args[i] = '$(location %s)' % filename
Motomu Utsumiee279c52022-11-09 17:46:27 +0900956 elif val == '-e':
957 # arg for -e EVAL option should be passed in -e PATCH_HI=int(PATCH)//256 format.
958 target.args[i + 1] = '%s=\'%s\'' % (target.args[i + 1], target.args[i + 2])
959 target.args[i + 2] = ''
Motomu Utsumi438f2c22022-11-09 18:16:40 +0900960 elif val == '-o':
961 target.args[i + 1] = '$(out)'
Patrick Rohr245df582022-11-01 16:59:45 -0700962
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700963 script = gn_utils.label_to_path(target.script)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700964 module.tool_files.add(script)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700965
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700966 # Handle passing parameters via response file by piping them into the script
967 # and reading them from /dev/stdin.
968 response_file = '{{response_file_name}}'
969 use_response_file = response_file in target.args
970 if use_response_file:
971 # Replace {{response_file_contents}} with /dev/stdin
972 target.args = ['/dev/stdin' if it == response_file else it for it in target.args]
973
Patrick Rohr4b0952d2022-11-01 12:42:31 -0700974 # escape " and \$ in target.args.
975 # once all actions are properly implemented, this may not be necessary anymore.
976 # TODO: is this the right place to do this?
977 target.args = [arg.replace('"', r'\"') for arg in target.args]
978 target.args = [arg.replace(r'\$', r'\\$') for arg in target.args]
979
Patrick Rohr9b99a982022-10-28 11:00:57 -0700980 # put all args on a new line for better diffs.
981 NEWLINE = ' " +\n "'
982 arg_string = NEWLINE.join(target.args)
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700983 module.cmd = '$(location %s) %s' % (script, arg_string)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700984
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700985 if use_response_file:
986 # Pipe response file contents into script
Patrick Rohr9b99a982022-10-28 11:00:57 -0700987 module.cmd = 'echo \'%s\' |%s%s' % (target.response_file_contents, NEWLINE, module.cmd)
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700988
Motomu Utsumi7e983832022-11-10 16:04:46 +0900989 if any(os.path.splitext(it)[1] == '.h' for it in target.outputs):
Patrick Rohr67f4d432022-10-26 16:04:15 -0700990 module.genrule_headers.add(bp_module_name)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700991
Patrick Rohr0db9f852022-10-27 13:49:57 -0700992 # gn treats inputs and sources for actions equally.
993 # soong only supports source files inside srcs, non-source files are added as
994 # tool_files dependency.
995 for it in target.sources or target.inputs:
996 if is_supported_source_file(it):
997 module.srcs.add(gn_utils.label_to_path(it))
998 else:
999 module.tool_files.add(gn_utils.label_to_path(it))
Patrick Rohre1a853e2022-10-26 12:31:39 -07001000
Patrick Rohr15a2c302022-10-26 15:08:57 -07001001 # Actions using template "action_with_pydeps" also put script inside inputs.
1002 # TODO: it might make sense to filter inputs inside GnParser.
1003 if script in module.srcs:
1004 module.srcs.remove(script)
1005
Patrick Rohre1a853e2022-10-26 12:31:39 -07001006 module.out.update(target.outputs)
Motomu Utsumia6c33152022-11-02 18:21:55 +09001007
1008 if target.name == "//build/android:build_config_gen":
1009 module = override_build_config_gen(module)
Motomu Utsumi26211dc2022-11-02 19:38:47 +09001010 elif target.script == "//tools/grit/stamp_grit_sources.py":
1011 # stamp_grit_sources.py is not executable
1012 module.cmd = "python " + module.cmd
Mohannad Farrag18d7b512022-11-07 13:26:30 +00001013 elif target.script == "//base/android/jni_generator/jni_generator.py":
1014 # android_jar.classes should be part of the tools as it list implicit classes
1015 # for the script to generate JNI headers.
1016 module.tool_files.add("base/android/jni_generator/android_jar.classes")
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +09001017 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
Motomu Utsumi9ca466b2022-11-10 17:12:29 +09001018 # jni_registration_generator.py doesn't work with python2
1019 module.cmd = "python3 " + module.cmd
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +09001020 # Path in the original sources file does not work in genrule.
1021 # So creating sources file in cmd based on the srcs of this target.
1022 # Adding ../$(current_dir)/ to the head because jni_registration_generator.py uses the files
1023 # whose path startswith(..)
1024 commands = ["current_dir=`basename \\\`pwd\\\``;",
1025 "for f in $(in);",
1026 "do",
1027 "echo \\\"../$$current_dir/$$f\\\" >> $(genDir)/java.sources;",
1028 "done;",
1029 module.cmd]
Motomu Utsumi2a892d22022-11-10 18:03:20 +09001030
1031 # .h file jni_registration_generator.py generates has #define with directory name.
1032 # With the genrule env that contains "." which is invalid. So replace that at the end of cmd.
Mohannad Farrag7c0f0982022-11-10 14:39:49 +00001033 commands.append(";sed -i -e 's/OUT_SOONG_.TEMP_SBOX_.*_OUT/GEN/g' ")
Motomu Utsumi2a892d22022-11-10 18:03:20 +09001034 commands.append("$(genDir)/components/cronet/android/cronet_jni_registration.h")
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +09001035 module.cmd = NEWLINE.join(commands)
Motomu Utsumia6c33152022-11-02 18:21:55 +09001036
Patrick Rohre1a853e2022-10-26 12:31:39 -07001037 blueprint.add_module(module)
1038 return module
1039
1040
Patrick Rohr92d74122022-10-21 15:50:52 -07001041
1042def _get_cflags(target):
1043 cflags = {flag for flag in target.cflags if re.match(cflag_allowlist, flag)}
Motomu Utsumifa7e9262022-10-26 19:43:02 +09001044 # Consider proper allowlist or denylist if needed
1045 cflags |= set("-D%s" % define.replace("\"", "\\\"") for define in target.defines)
Patrick Rohr92d74122022-10-21 15:50:52 -07001046 return cflags
1047
1048
1049def create_modules_from_target(blueprint, gn, gn_target_name):
1050 """Generate module(s) for a given GN target.
1051
1052 Given a GN target name, generate one or more corresponding modules into a
1053 blueprint. The only case when this generates >1 module is proto libraries.
1054
1055 Args:
1056 blueprint: Blueprint instance which is being generated.
1057 gn: gn_utils.GnParser object.
1058 gn_target_name: GN target for module generation.
1059 """
1060 bp_module_name = label_to_module_name(gn_target_name)
1061 if bp_module_name in blueprint.modules:
1062 return blueprint.modules[bp_module_name]
1063 target = gn.get_target(gn_target_name)
Patrick Rohr16228942022-10-26 14:00:26 -07001064 log.info('create modules for %s (%s)', target.name, target.type)
Patrick Rohr92d74122022-10-21 15:50:52 -07001065
1066 name_without_toolchain = gn_utils.label_without_toolchain(target.name)
1067 if target.type == 'executable':
1068 if target.toolchain == gn_utils.HOST_TOOLCHAIN:
1069 module_type = 'cc_binary_host'
1070 elif target.testonly:
1071 module_type = 'cc_test'
1072 else:
1073 module_type = 'cc_binary'
1074 module = Module(module_type, bp_module_name, gn_target_name)
1075 elif target.type == 'static_library':
1076 module = Module('cc_library_static', bp_module_name, gn_target_name)
1077 elif target.type == 'shared_library':
1078 module = Module('cc_library_shared', bp_module_name, gn_target_name)
1079 elif target.type == 'source_set':
1080 module = Module('filegroup', bp_module_name, gn_target_name)
1081 elif target.type == 'group':
1082 # "group" targets are resolved recursively by gn_utils.get_target().
1083 # There's nothing we need to do at this level for them.
1084 return None
1085 elif target.type == 'proto_library':
1086 module = create_proto_modules(blueprint, gn, target)
1087 if module is None:
1088 return None
1089 elif target.type == 'action':
1090 if 'gen_amalgamated_sql_metrics' in target.name:
1091 module = create_amalgamated_sql_metrics_module(blueprint, target)
1092 elif re.match('.*gen_cc_.*_descriptor$', name_without_toolchain):
1093 module = create_cc_proto_descriptor_module(blueprint, target)
1094 elif target.type == 'action' and \
1095 name_without_toolchain == gn_utils.GEN_VERSION_TARGET:
1096 module = create_gen_version_module(blueprint, target, bp_module_name)
1097 else:
Patrick Rohre1a853e2022-10-26 12:31:39 -07001098 module = create_action_module(blueprint, target)
Mohannad Farragf076f3e2022-10-31 17:45:28 +00001099 elif target.type == 'action_foreach':
Mohannad Farragbab6c892022-11-02 14:09:46 +00001100 module = create_action_foreach_modules(blueprint, target)
Patrick Rohr59a76652022-10-26 12:36:56 -07001101 elif target.type == 'copy':
1102 # TODO: careful now! copy targets are not supported yet, but this will stop
1103 # traversing the dependency tree. For //base:base, this is not a big
1104 # problem as libicu contains the only copy target which happens to be a
1105 # leaf node.
1106 return None
Patrick Rohrad440602022-11-10 22:09:04 -08001107 elif target.type == 'java_group':
1108 # Java targets are handled outside of create_modules_from_target.
1109 return None
Patrick Rohr92d74122022-10-21 15:50:52 -07001110 else:
1111 raise Error('Unknown target %s (%s)' % (target.name, target.type))
1112
1113 blueprint.add_module(module)
1114 module.host_supported = (name_without_toolchain in target_host_supported)
Patrick Rohr92d74122022-10-21 15:50:52 -07001115 module.init_rc = target_initrc.get(target.name, [])
1116 module.srcs.update(
1117 gn_utils.label_to_path(src)
1118 for src in target.sources
Motomu Utsumif951e502022-11-07 19:31:15 +09001119 if is_supported_source_file(src) and not src.startswith("//out/test"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001120
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001121 local_include_dirs_set = set()
Patrick Rohr92d74122022-10-21 15:50:52 -07001122 if target.type in gn_utils.LINKER_UNIT_TYPES:
1123 module.cflags.update(_get_cflags(target))
Patrick Rohrf22e9d02022-10-28 14:20:46 -07001124 # TODO: implement proper cflag parsing.
1125 for flag in target.cflags:
Patrick Rohrb8f830a2022-10-31 11:18:57 -07001126 if '-std=' in flag:
1127 module.cpp_std = flag[len('-std='):]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001128 if '-isystem' in flag:
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001129 local_include_dirs_set.add(flag[len('-isystem../../'):])
Patrick Rohr5fae90f2022-11-11 08:22:52 -08001130 if '-frtti' in flag:
1131 module.rtti = True
Patrick Rohr0948d1c2022-11-11 11:02:16 -08001132 if '-fexceptions' in flag:
1133 module.cppflags.add('-fexceptions')
1134
Patrick Rohrb8f830a2022-10-31 11:18:57 -07001135
Patrick Rohrd0abc2a2022-10-31 13:29:16 -07001136 # Adding local_include_dirs is necessary due to source_sets / filegroups
1137 # which do not properly propagate include directories.
1138 # Filter any directory inside //out as a) this directory does not exist for
1139 # aosp / soong builds and b) the include directory should already be
1140 # configured via library dependency.
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001141 local_include_dirs_set.update([gn_utils.label_to_path(d)
Patrick Rohrd0abc2a2022-10-31 13:29:16 -07001142 for d in target.include_dirs
1143 if not re.match('^//out/.*', d)])
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001144 module.local_include_dirs = sorted(list(local_include_dirs_set))
1145
1146 # Order matters for some targets. For example, base/time/time_exploded_icu.cc
1147 # in //base:base needs to have sysroot include after icu/source/common
1148 # include. So adding sysroot include at the end.
1149 for flag in target.cflags:
1150 if '--sysroot' in flag:
1151 module.local_include_dirs.append(flag[len('--sysroot=../../'):] + "/usr/include")
Patrick Rohr92d74122022-10-21 15:50:52 -07001152
1153 module_is_compiled = module.type not in ('genrule', 'filegroup')
1154 if module_is_compiled:
1155 # Don't try to inject library/source dependencies into genrules or
1156 # filegroups because they are not compiled in the traditional sense.
1157 module.defaults = [defaults_module]
1158 for lib in target.libs:
1159 # Generally library names should be mangled as 'libXXX', unless they
1160 # are HAL libraries (e.g., android.hardware.health@2.0) or AIDL c++ / NDK
1161 # libraries (e.g. "android.hardware.power.stats-V1-cpp")
1162 android_lib = lib if '@' in lib or "-cpp" in lib or "-ndk" in lib \
1163 else 'lib' + lib
1164 if lib in shared_library_allowlist:
1165 module.add_android_shared_lib(android_lib)
1166 if lib in static_library_allowlist:
1167 module.add_android_static_lib(android_lib)
1168
Patrick Rohrd9dd3b92022-11-09 16:15:30 -08001169 # Remove prohibited include directories
1170 module.local_include_dirs = [d for d in module.local_include_dirs
1171 if d not in local_include_dirs_denylist]
1172
1173
Patrick Rohr92d74122022-10-21 15:50:52 -07001174 # If the module is a static library, export all the generated headers.
1175 if module.type == 'cc_library_static':
1176 module.export_generated_headers = module.generated_headers
1177
Patrick Rohr92d74122022-10-21 15:50:52 -07001178 # dep_name is an unmangled GN target name (e.g. //foo:bar(toolchain)).
Motomu Utsumif1daa232022-11-08 13:28:37 +09001179 # Currently, only one module is generated from target even target has multiple toolchains.
1180 # And module is generated based on the first visited target.
1181 # Sort deps before iteration to make result deterministic.
1182 all_deps = sorted(target.deps | target.source_set_deps | target.transitive_proto_deps)
Patrick Rohr92d74122022-10-21 15:50:52 -07001183 for dep_name in all_deps:
Patrick Rohr5cc46e02022-10-26 14:32:45 -07001184 # |builtin_deps| override GN deps with Android-specific ones. See the
1185 # config in the top of this file.
1186 if gn_utils.label_without_toolchain(dep_name) in builtin_deps:
1187 builtin_deps[gn_utils.label_without_toolchain(dep_name)](module)
1188 continue
1189
Patrick Rohr92d74122022-10-21 15:50:52 -07001190 dep_module = create_modules_from_target(blueprint, gn, dep_name)
1191
Motomu Utsumie246feb2022-11-01 17:25:56 +09001192 # TODO: Proper dependency check for genrule.
1193 # Currently, only propagating genrule dependencies.
1194 # Also, currently, all the dependencies are propagated upwards.
1195 # in gn, public_deps should be propagated but deps should not.
1196 # Not sure this information is available in the desc.json.
1197 # Following rule works for adding android_runtime_jni_headers to base:base.
1198 # If this doesn't work for other target, hardcoding for specific target
1199 # might be better.
1200 if module.type == "genrule" and dep_module.type == "genrule":
1201 module.genrule_headers.add(dep_module.name)
1202 module.genrule_headers.update(dep_module.genrule_headers)
1203
Patrick Rohr92d74122022-10-21 15:50:52 -07001204 # For filegroups and genrule, recurse but don't apply the deps.
1205 if not module_is_compiled:
1206 continue
1207
Patrick Rohr92d74122022-10-21 15:50:52 -07001208 if dep_module is None:
1209 continue
1210 if dep_module.type == 'cc_library_shared':
1211 module.shared_libs.add(dep_module.name)
1212 elif dep_module.type == 'cc_library_static':
1213 module.static_libs.add(dep_module.name)
1214 elif dep_module.type == 'filegroup':
1215 module.srcs.add(':' + dep_module.name)
1216 elif dep_module.type == 'genrule':
1217 module.generated_headers.update(dep_module.genrule_headers)
1218 module.srcs.update(dep_module.genrule_srcs)
1219 module.shared_libs.update(dep_module.genrule_shared_libs)
Patrick Rohra1a27872022-10-31 11:57:14 -07001220 module.header_libs.update(dep_module.genrule_header_libs)
Patrick Rohr92d74122022-10-21 15:50:52 -07001221 elif dep_module.type == 'cc_binary':
1222 continue # Ignore executables deps (used by cmdline integration tests).
1223 else:
1224 raise Error('Unknown dep %s (%s) for target %s' %
1225 (dep_module.name, dep_module.type, module.name))
1226
Motomu Utsumi87c2a482022-11-14 14:57:46 +09001227 # TODO: support arch difference in generic way
1228 # Currently, it is expected that only a couple of modules (e.g. partition_alloc, boringssl)
1229 # need arch condition. So, for now, hardcoding arch condition
1230 if module.name == "cronet_aml_base_allocator_partition_allocator_partition_alloc":
1231 x86_srcs = module.srcs.copy()
1232 x86_srcs.remove(
1233 "base/allocator/partition_allocator/starscan/stack/asm/x64/push_registers_asm.cc")
1234 x86_srcs.add("base/allocator/partition_allocator/starscan/stack/asm/x86/push_registers_asm.cc")
1235 module.arch['x86'] = {'srcs': x86_srcs}
1236 module.arch['x86_64'] = {'srcs': module.srcs.copy()}
1237 module.srcs.clear()
1238
Patrick Rohr92d74122022-10-21 15:50:52 -07001239 return module
1240
Patrick Rohrb18aca22022-11-04 15:07:32 -07001241def create_java_module(blueprint, gn):
1242 bp_module_name = module_prefix + 'java'
1243 module = Module('java_library', bp_module_name, '//gn:java')
Mohannad Farrag21562d62022-11-07 13:09:31 +00001244 module.srcs.update([gn_utils.label_to_path(source) for source in gn.java_sources])
Patrick Rohrb18aca22022-11-04 15:07:32 -07001245 blueprint.add_module(module)
Patrick Rohr92d74122022-10-21 15:50:52 -07001246
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001247def update_jni_registration_module(blueprint, gn):
1248 bp_module_name = label_to_module_name('//components/cronet/android:cronet_jni_registration')
Patrick Rohr7f225422022-11-10 21:38:38 -08001249 if bp_module_name not in blueprint.modules:
1250 # To support building targets that might not create the cronet_jni_registration.
1251 return
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001252 module = blueprint.modules[bp_module_name]
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001253
1254 # TODO: deny list is in the arg of jni_registration_generator.py. Should not be hardcoded
1255 deny_list = [
1256 '//base/android/java/src/org/chromium/base/library_loader/LibraryLoader.java',
1257 '//base/android/java/src/org/chromium/base/library_loader/LibraryPrefetcher.java',
1258 '//base/android/java/src/org/chromium/base/process_launcher/ChildProcessService.java',
1259 '//base/android/java/src/org/chromium/base/SysUtils.java']
1260
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001261 # TODO: java_sources might not contain all the required java files
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001262 module.srcs.update([gn_utils.label_to_path(source)
1263 for source in gn.java_sources if source not in deny_list])
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001264
Motomu Utsumi79bd0c82022-11-10 17:52:24 +09001265 # TODO: Remove hardcoded file addition to srcs
1266 # jni_registration_generator.py generates empty .h file if native methods are not found in the
1267 # java files. But android:cronet depends on `RegisterNonMainDexNatives` which is in the template
1268 # of .h file. To make script generate non empty .h file, adding java file which contains native
1269 # method. Once all the required java files are added to the srcs, this can be removed.
1270 module.srcs.update([
1271 "components/cronet/android/java/src/org/chromium/net/impl/CronetUrlRequest.java"])
1272
Patrick Rohr92d74122022-10-21 15:50:52 -07001273def create_blueprint_for_targets(gn, desc, targets):
1274 """Generate a blueprint for a list of GN targets."""
1275 blueprint = Blueprint()
1276
1277 # Default settings used by all modules.
1278 defaults = Module('cc_defaults', defaults_module, '//gn:default_deps')
Patrick Rohr92d74122022-10-21 15:50:52 -07001279 defaults.cflags = [
Patrick Rohr3ce74772022-11-11 14:19:58 -08001280 '-DGOOGLE_PROTOBUF_NO_RTTI',
Patrick Rohr92d74122022-10-21 15:50:52 -07001281 '-Wno-error=return-type',
Patrick Rohr3a1ec1d2022-10-31 13:30:17 -07001282 '-Wno-non-virtual-dtor',
Patrick Rohr5c700022022-11-08 19:33:07 -08001283 '-Wno-macro-redefined',
Patrick Rohr98065152022-10-31 14:49:58 -07001284 '-Wno-missing-field-initializers',
Patrick Rohr92d74122022-10-21 15:50:52 -07001285 '-Wno-sign-compare',
1286 '-Wno-sign-promo',
1287 '-Wno-unused-parameter',
Mohannad Farragd98a96d2022-11-10 14:56:19 +00001288 '-Wno-deprecated-non-prototype', # needed for zlib
Patrick Rohr92d74122022-10-21 15:50:52 -07001289 '-fvisibility=hidden',
Motomu Utsumiba020942022-11-14 15:15:41 +09001290 '-Wno-ambiguous-reversed-operator', # needed for icui18n
Motomu Utsumib1ec8782022-11-14 15:25:57 +09001291 '-Wno-unreachable-code-loop-increment', # needed for icui18n
Patrick Rohr92d74122022-10-21 15:50:52 -07001292 '-O2',
1293 ]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001294 defaults.stl = 'none'
Patrick Rohr92d74122022-10-21 15:50:52 -07001295 blueprint.add_module(defaults)
Patrick Rohr344b2472022-10-25 11:32:15 -07001296
Patrick Rohr92d74122022-10-21 15:50:52 -07001297 for target in targets:
1298 create_modules_from_target(blueprint, gn, target)
Patrick Rohrb18aca22022-11-04 15:07:32 -07001299
1300 create_java_module(blueprint, gn)
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001301 update_jni_registration_module(blueprint, gn)
Patrick Rohra7d029d2022-11-08 12:23:11 -08001302
1303 # Merge in additional hardcoded arguments.
1304 for module in blueprint.modules.values():
1305 for key, add_val in additional_args.get(module.name, []):
1306 curr = getattr(module, key)
1307 if add_val and isinstance(add_val, set) and isinstance(curr, set):
1308 curr.update(add_val)
1309 elif isinstance(add_val, str) and (not curr or isinstance(curr, str)):
1310 setattr(module, key, add_val)
1311 elif isinstance(add_val, bool) and (not curr or isinstance(curr, bool)):
1312 setattr(module, key, add_val)
1313 elif isinstance(add_val, dict) and isinstance(curr, dict):
1314 curr.update(add_val)
1315 elif isinstance(add_val, dict) and isinstance(curr, Target):
1316 curr.__dict__.update(add_val)
1317 else:
1318 raise Error('Unimplemented type %r of additional_args: %r' %
1319 (type(add_val), key))
1320
Patrick Rohr92d74122022-10-21 15:50:52 -07001321 return blueprint
1322
1323
1324def main():
1325 parser = argparse.ArgumentParser(
1326 description='Generate Android.bp from a GN description.')
1327 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001328 '--desc',
Patrick Rohr3db246a2022-10-25 10:25:17 -07001329 help='GN description (e.g., gn desc out --format=json --all-toolchains "//*"',
1330 required=True
Patrick Rohr92d74122022-10-21 15:50:52 -07001331 )
1332 parser.add_argument(
1333 '--extras',
1334 help='Extra targets to include at the end of the Blueprint file',
1335 default=os.path.join(gn_utils.repo_root(), 'Android.bp.extras'),
1336 )
1337 parser.add_argument(
1338 '--output',
1339 help='Blueprint file to create',
1340 default=os.path.join(gn_utils.repo_root(), 'Android.bp'),
1341 )
1342 parser.add_argument(
Patrick Rohr16228942022-10-26 14:00:26 -07001343 '-v',
1344 '--verbose',
1345 help='Print debug logs.',
1346 action='store_true',
1347 )
1348 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001349 'targets',
1350 nargs=argparse.REMAINDER,
Patrick Rohr1aa504a2022-10-25 10:30:42 -07001351 help='Targets to include in the blueprint (e.g., "//:perfetto_tests")'
1352 )
Patrick Rohr92d74122022-10-21 15:50:52 -07001353 args = parser.parse_args()
1354
Patrick Rohr16228942022-10-26 14:00:26 -07001355 if args.verbose:
1356 log.basicConfig(format='%(levelname)s:%(funcName)s:%(message)s', level=log.DEBUG)
1357
Patrick Rohr3db246a2022-10-25 10:25:17 -07001358 with open(args.desc) as f:
1359 desc = json.load(f)
Patrick Rohr92d74122022-10-21 15:50:52 -07001360
1361 gn = gn_utils.GnParser(desc)
Patrick Rohr06296362022-11-10 21:37:33 -08001362 blueprint = create_blueprint_for_targets(gn, desc, args.targets or default_targets)
Patrick Rohr92d74122022-10-21 15:50:52 -07001363 project_root = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
1364 tool_name = os.path.relpath(os.path.abspath(__file__), project_root)
1365
Patrick Rohr92d74122022-10-21 15:50:52 -07001366 # Add any proto groups to the blueprint.
1367 for l_name, t_names in proto_groups.items():
1368 create_proto_group_modules(blueprint, gn, l_name, t_names)
1369
1370 output = [
Patrick Rohr5478b392022-10-25 09:58:50 -07001371 """// Copyright (C) 2022 The Android Open Source Project
Patrick Rohr92d74122022-10-21 15:50:52 -07001372//
1373// Licensed under the Apache License, Version 2.0 (the "License");
1374// you may not use this file except in compliance with the License.
1375// You may obtain a copy of the License at
1376//
1377// http://www.apache.org/licenses/LICENSE-2.0
1378//
1379// Unless required by applicable law or agreed to in writing, software
1380// distributed under the License is distributed on an "AS IS" BASIS,
1381// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1382// See the License for the specific language governing permissions and
1383// limitations under the License.
1384//
1385// This file is automatically generated by %s. Do not edit.
1386""" % (tool_name)
1387 ]
1388 blueprint.to_string(output)
Patrick Rohrcb98e9b2022-10-25 09:57:02 -07001389 if os.path.exists(args.extras):
1390 with open(args.extras, 'r') as r:
1391 for line in r:
1392 output.append(line.rstrip("\n\r"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001393
1394 out_files = []
1395
1396 # Generate the Android.bp file.
1397 out_files.append(args.output + '.swp')
1398 with open(out_files[-1], 'w') as f:
1399 f.write('\n'.join(output))
1400 # Text files should have a trailing EOL.
1401 f.write('\n')
1402
Patrick Rohr94693eb2022-10-25 10:09:16 -07001403 return 0
Patrick Rohr92d74122022-10-21 15:50:52 -07001404
1405
1406if __name__ == '__main__':
1407 sys.exit(main())