blob: b222d6fd42609602e73d4993101d5c5116fbc7c2 [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 Rohrbb0956e2022-11-09 15:37:16 -0800116 'cronet_aml_net_net': [
Patrick Rohr9f4d3e32022-11-09 16:37:31 -0800117 ('export_static_lib_headers', {
118 'cronet_aml_net_third_party_quiche_quiche',
119 'cronet_aml_crypto_crypto',
120 }),
Mohannad Farrag627dc912022-11-11 19:00:26 +0000121 # When a code is compiled under rtti(cronet) that depends on another code(net)
122 # that doesn't depend on rtti. undefined symbol: typeinfo 'class' errors appears.
123 ('rtti', True), # go/undefined-symbol-typeinfo
Mohannad Farrage7d29312022-11-10 17:39:16 +0000124 ('whole_static_libs', {
125 'cronet_aml_net_third_party_quiche_quiche',
126 'cronet_aml_base_base',
127 "cronet_aml_crypto_crypto",
Patrick Rohrcc83af22022-11-10 20:00:58 -0800128 "libssl",
Mohannad Farrage7d29312022-11-10 17:39:16 +0000129 }),
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000130 ],
131 'cronet_aml_components_cronet_android_cronet': [
132 ('rtti', True),
133 ('cppflags', {
134 # TODO: figure out if there is no way around this and if this is
135 # allowed for platform code.
136 "-fexceptions",
137 })
Mohannad Farrag627dc912022-11-11 19:00:26 +0000138 ],
Patrick Rohr92d74122022-10-21 15:50:52 -0700139}
140
141
142def enable_gtest_and_gmock(module):
143 module.static_libs.add('libgmock')
144 module.static_libs.add('libgtest')
145 if module.name != 'perfetto_gtest_logcat_printer':
146 module.whole_static_libs.add('perfetto_gtest_logcat_printer')
147
148
149def enable_protobuf_full(module):
150 if module.type == 'cc_binary_host':
151 module.static_libs.add('libprotobuf-cpp-full')
152 elif module.host_supported:
153 module.host.static_libs.add('libprotobuf-cpp-full')
154 module.android.shared_libs.add('libprotobuf-cpp-full')
Patrick Rohr84b16402022-11-08 19:01:01 -0800155 elif module.type not in ['genrule', 'filegroup']:
Patrick Rohr92d74122022-10-21 15:50:52 -0700156 module.shared_libs.add('libprotobuf-cpp-full')
157
158
159def enable_protobuf_lite(module):
Patrick Rohr84b16402022-11-08 19:01:01 -0800160 if module.type not in ['genrule', 'filegroup']:
161 module.shared_libs.add('libprotobuf-cpp-lite')
Patrick Rohr92d74122022-10-21 15:50:52 -0700162
163
164def enable_protoc_lib(module):
165 if module.type == 'cc_binary_host':
166 module.static_libs.add('libprotoc')
167 else:
168 module.shared_libs.add('libprotoc')
169
170
171def enable_libunwindstack(module):
172 if module.name != 'heapprofd_standalone_client':
173 module.shared_libs.add('libunwindstack')
174 module.shared_libs.add('libprocinfo')
175 module.shared_libs.add('libbase')
176 else:
177 module.static_libs.add('libunwindstack')
178 module.static_libs.add('libprocinfo')
179 module.static_libs.add('libbase')
180 module.static_libs.add('liblzma')
181 module.static_libs.add('libdexfile_support')
182 module.runtime_libs.add('libdexfile') # libdexfile_support dependency
183
184
185def enable_libunwind(module):
186 # libunwind is disabled on Darwin so we cannot depend on it.
187 pass
188
189
190def enable_sqlite(module):
191 if module.type == 'cc_binary_host':
192 module.static_libs.add('libsqlite')
193 module.static_libs.add('sqlite_ext_percentile')
194 elif module.host_supported:
195 # Copy what the sqlite3 command line tool does.
196 module.android.shared_libs.add('libsqlite')
197 module.android.shared_libs.add('libicu')
198 module.android.shared_libs.add('liblog')
199 module.android.shared_libs.add('libutils')
200 module.android.static_libs.add('sqlite_ext_percentile')
201 module.host.static_libs.add('libsqlite')
202 module.host.static_libs.add('sqlite_ext_percentile')
203 else:
204 module.shared_libs.add('libsqlite')
205 module.shared_libs.add('libicu')
206 module.shared_libs.add('liblog')
207 module.shared_libs.add('libutils')
208 module.static_libs.add('sqlite_ext_percentile')
209
210
211def enable_zlib(module):
212 if module.type == 'cc_binary_host':
213 module.static_libs.add('libz')
214 elif module.host_supported:
215 module.android.shared_libs.add('libz')
216 module.host.static_libs.add('libz')
217 else:
218 module.shared_libs.add('libz')
219
220
221def enable_uapi_headers(module):
222 module.include_dirs.add('bionic/libc/kernel')
223
224
225def enable_bionic_libc_platform_headers_on_android(module):
226 module.header_libs.add('bionic_libc_platform_headers')
227
228
Patrick Rohrcc83af22022-11-10 20:00:58 -0800229def enable_boringssl(module):
230 if module.type not in ['genrule', 'filegroup']:
231 module.static_libs.add('libssl')
232
233
Patrick Rohr92d74122022-10-21 15:50:52 -0700234# Android equivalents for third-party libraries that the upstream project
235# depends on.
236builtin_deps = {
237 '//gn:default_deps':
238 lambda x: None,
239 '//gn:gtest_main':
240 lambda x: None,
Patrick Rohr92d74122022-10-21 15:50:52 -0700241 '//gn:gtest_and_gmock':
242 enable_gtest_and_gmock,
243 '//gn:libunwind':
244 enable_libunwind,
Patrick Rohr92d74122022-10-21 15:50:52 -0700245 '//gn:libunwindstack':
246 enable_libunwindstack,
247 '//gn:sqlite':
248 enable_sqlite,
249 '//gn:zlib':
250 enable_zlib,
251 '//gn:bionic_kernel_uapi_headers':
252 enable_uapi_headers,
253 '//src/profiling/memory:bionic_libc_platform_headers_on_android':
254 enable_bionic_libc_platform_headers_on_android,
Motomu Utsumidfc8e6a2022-11-04 18:25:33 +0900255 '//third_party/protobuf:protoc':
256 lambda x: None,
Patrick Rohr84b16402022-11-08 19:01:01 -0800257 '//third_party/protobuf:protobuf_full':
258 enable_protobuf_full,
259 '//third_party/protobuf:protobuf_lite':
260 enable_protobuf_lite,
261 '//third_party/protobuf:protoc_lib':
262 enable_protoc_lib,
Patrick Rohrcc83af22022-11-10 20:00:58 -0800263 '//third_party/boringssl:boringssl':
264 enable_boringssl,
Patrick Rohr92d74122022-10-21 15:50:52 -0700265}
266
267# ----------------------------------------------------------------------------
268# End of configuration.
269# ----------------------------------------------------------------------------
270
271
272class Error(Exception):
273 pass
274
275
276class ThrowingArgumentParser(argparse.ArgumentParser):
277
278 def __init__(self, context):
279 super(ThrowingArgumentParser, self).__init__()
280 self.context = context
281
282 def error(self, message):
283 raise Error('%s: %s' % (self.context, message))
284
285
286def write_blueprint_key_value(output, name, value, sort=True):
287 """Writes a Blueprint key-value pair to the output"""
288
289 if isinstance(value, bool):
290 if value:
291 output.append(' %s: true,' % name)
292 else:
293 output.append(' %s: false,' % name)
294 return
295 if not value:
296 return
297 if isinstance(value, set):
298 value = sorted(value)
299 if isinstance(value, list):
300 output.append(' %s: [' % name)
301 for item in sorted(value) if sort else value:
302 output.append(' "%s",' % item)
303 output.append(' ],')
304 return
305 if isinstance(value, Target):
306 value.to_string(output)
307 return
308 if isinstance(value, dict):
309 kv_output = []
310 for k, v in value.items():
311 write_blueprint_key_value(kv_output, k, v)
312
313 output.append(' %s: {' % name)
314 for line in kv_output:
315 output.append(' %s' % line)
316 output.append(' },')
317 return
318 output.append(' %s: "%s",' % (name, value))
319
320
321class Target(object):
322 """A target-scoped part of a module"""
323
324 def __init__(self, name):
325 self.name = name
326 self.shared_libs = set()
327 self.static_libs = set()
328 self.whole_static_libs = set()
329 self.cflags = set()
330 self.dist = dict()
331 self.strip = dict()
332 self.stl = None
333
334 def to_string(self, output):
335 nested_out = []
336 self._output_field(nested_out, 'shared_libs')
337 self._output_field(nested_out, 'static_libs')
338 self._output_field(nested_out, 'whole_static_libs')
339 self._output_field(nested_out, 'cflags')
340 self._output_field(nested_out, 'stl')
341 self._output_field(nested_out, 'dist')
342 self._output_field(nested_out, 'strip')
343
344 if nested_out:
345 output.append(' %s: {' % self.name)
346 for line in nested_out:
347 output.append(' %s' % line)
348 output.append(' },')
349
350 def _output_field(self, output, name, sort=True):
351 value = getattr(self, name)
352 return write_blueprint_key_value(output, name, value, sort)
353
354
355class Module(object):
356 """A single module (e.g., cc_binary, cc_test) in a blueprint."""
357
358 def __init__(self, mod_type, name, gn_target):
359 self.type = mod_type
360 self.gn_target = gn_target
361 self.name = name
362 self.srcs = set()
363 self.comment = 'GN: ' + gn_utils.label_without_toolchain(gn_target)
364 self.shared_libs = set()
365 self.static_libs = set()
366 self.whole_static_libs = set()
367 self.runtime_libs = set()
368 self.tools = set()
369 self.cmd = None
370 self.host_supported = False
371 self.vendor_available = False
372 self.init_rc = set()
373 self.out = set()
374 self.export_include_dirs = set()
375 self.generated_headers = set()
376 self.export_generated_headers = set()
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800377 self.export_static_lib_headers = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700378 self.defaults = set()
379 self.cflags = set()
380 self.include_dirs = set()
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900381 self.local_include_dirs = []
Patrick Rohr92d74122022-10-21 15:50:52 -0700382 self.header_libs = set()
383 self.required = set()
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700384 self.tool_files = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700385 self.android = Target('android')
386 self.host = Target('host')
Patrick Rohr92d74122022-10-21 15:50:52 -0700387 self.stl = None
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700388 self.cpp_std = None
Patrick Rohr92d74122022-10-21 15:50:52 -0700389 self.dist = dict()
390 self.strip = dict()
391 self.data = set()
392 self.apex_available = set()
393 self.min_sdk_version = None
394 self.proto = dict()
395 # The genrule_XXX below are properties that must to be propagated back
396 # on the module(s) that depend on the genrule.
397 self.genrule_headers = set()
398 self.genrule_srcs = set()
399 self.genrule_shared_libs = set()
Patrick Rohra1a27872022-10-31 11:57:14 -0700400 self.genrule_header_libs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700401 self.version_script = None
402 self.test_suites = set()
403 self.test_config = None
404 self.stubs = {}
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000405 self.cppflags = set()
406 self.rtti = False
Patrick Rohr92d74122022-10-21 15:50:52 -0700407
408 def to_string(self, output):
409 if self.comment:
410 output.append('// %s' % self.comment)
411 output.append('%s {' % self.type)
412 self._output_field(output, 'name')
413 self._output_field(output, 'srcs')
414 self._output_field(output, 'shared_libs')
415 self._output_field(output, 'static_libs')
416 self._output_field(output, 'whole_static_libs')
417 self._output_field(output, 'runtime_libs')
418 self._output_field(output, 'tools')
419 self._output_field(output, 'cmd', sort=False)
420 if self.host_supported:
421 self._output_field(output, 'host_supported')
422 if self.vendor_available:
423 self._output_field(output, 'vendor_available')
424 self._output_field(output, 'init_rc')
425 self._output_field(output, 'out')
426 self._output_field(output, 'export_include_dirs')
427 self._output_field(output, 'generated_headers')
428 self._output_field(output, 'export_generated_headers')
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800429 self._output_field(output, 'export_static_lib_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -0700430 self._output_field(output, 'defaults')
431 self._output_field(output, 'cflags')
432 self._output_field(output, 'include_dirs')
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900433 self._output_field(output, 'local_include_dirs', sort=False)
Patrick Rohr92d74122022-10-21 15:50:52 -0700434 self._output_field(output, 'header_libs')
435 self._output_field(output, 'required')
436 self._output_field(output, 'dist')
437 self._output_field(output, 'strip')
438 self._output_field(output, 'tool_files')
439 self._output_field(output, 'data')
440 self._output_field(output, 'stl')
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700441 self._output_field(output, 'cpp_std')
Patrick Rohr92d74122022-10-21 15:50:52 -0700442 self._output_field(output, 'apex_available')
443 self._output_field(output, 'min_sdk_version')
444 self._output_field(output, 'version_script')
445 self._output_field(output, 'test_suites')
446 self._output_field(output, 'test_config')
447 self._output_field(output, 'stubs')
448 self._output_field(output, 'proto')
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000449 self._output_field(output, 'cppflags')
450 if self.rtti:
451 self._output_field(output, 'rtti')
Patrick Rohr92d74122022-10-21 15:50:52 -0700452
453 target_out = []
454 self._output_field(target_out, 'android')
455 self._output_field(target_out, 'host')
456 if target_out:
457 output.append(' target: {')
458 for line in target_out:
459 output.append(' %s' % line)
460 output.append(' },')
461
Patrick Rohr92d74122022-10-21 15:50:52 -0700462 output.append('}')
463 output.append('')
464
465 def add_android_static_lib(self, lib):
466 if self.type == 'cc_binary_host':
467 raise Exception('Adding Android static lib for host tool is unsupported')
468 elif self.host_supported:
469 self.android.static_libs.add(lib)
470 else:
471 self.static_libs.add(lib)
472
473 def add_android_shared_lib(self, lib):
474 if self.type == 'cc_binary_host':
475 raise Exception('Adding Android shared lib for host tool is unsupported')
476 elif self.host_supported:
477 self.android.shared_libs.add(lib)
478 else:
479 self.shared_libs.add(lib)
480
481 def _output_field(self, output, name, sort=True):
482 value = getattr(self, name)
483 return write_blueprint_key_value(output, name, value, sort)
484
485
486class Blueprint(object):
487 """In-memory representation of an Android.bp file."""
488
489 def __init__(self):
490 self.modules = {}
491
492 def add_module(self, module):
493 """Adds a new module to the blueprint, replacing any existing module
494 with the same name.
495
496 Args:
497 module: Module instance.
498 """
499 self.modules[module.name] = module
500
501 def to_string(self, output):
Patrick Rohr23f26192022-10-25 09:45:22 -0700502 for m in sorted(self.modules.values(), key=lambda m: m.name):
Patrick Rohr92d74122022-10-21 15:50:52 -0700503 m.to_string(output)
504
505
506def label_to_module_name(label):
507 """Turn a GN label (e.g., //:perfetto_tests) into a module name."""
508 # If the label is explicibly listed in the default target list, don't prefix
509 # its name and return just the target name. This is so tools like
510 # "traceconv" stay as such in the Android tree.
511 label_without_toolchain = gn_utils.label_without_toolchain(label)
Patrick Rohr92d74122022-10-21 15:50:52 -0700512 module = re.sub(r'^//:?', '', label_without_toolchain)
513 module = re.sub(r'[^a-zA-Z0-9_]', '_', module)
514 if not module.startswith(module_prefix):
515 return module_prefix + module
516 return module
517
518
519def is_supported_source_file(name):
520 """Returns True if |name| can appear in a 'srcs' list."""
Patrick Rohrf9f3a992022-11-10 19:40:32 -0800521 return os.path.splitext(name)[1] in ['.c', '.cc', '.cpp', '.java', '.proto', '.S']
Patrick Rohr92d74122022-10-21 15:50:52 -0700522
523
524def create_proto_modules(blueprint, gn, target):
525 """Generate genrules for a proto GN target.
526
527 GN actions are used to dynamically generate files during the build. The
528 Soong equivalent is a genrule. This function turns a specific kind of
529 genrule which turns .proto files into source and header files into a pair
530 equivalent genrules.
531
532 Args:
533 blueprint: Blueprint instance which is being generated.
534 target: gn_utils.Target object.
535
536 Returns:
537 The source_genrule module.
538 """
539 assert (target.type == 'proto_library')
540
541 tools = {'aprotoc'}
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900542 cpp_out_dir = '$(genDir)/%s/%s/' % (tree_path, target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700543 target_module_name = label_to_module_name(target.name)
544
545 # In GN builds the proto path is always relative to the output directory
546 # (out/tmp.xxx).
Motomu Utsumie8457452022-11-08 18:47:51 +0900547 cmd = ['$(location aprotoc)']
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900548 cmd += ['--proto_path=%s/%s' % (tree_path, target.proto_in_dir)]
Patrick Rohr92d74122022-10-21 15:50:52 -0700549
550 if buildtools_protobuf_src in target.proto_paths:
551 cmd += ['--proto_path=%s' % android_protobuf_src]
552
553 # We don't generate any targets for source_set proto modules because
554 # they will be inlined into other modules if required.
555 if target.proto_plugin == 'source_set':
556 return None
557
558 # Descriptor targets only generate a single target.
559 if target.proto_plugin == 'descriptor':
560 out = '{}.bin'.format(target_module_name)
561
562 cmd += ['--descriptor_set_out=$(out)']
563 cmd += ['$(in)']
564
565 descriptor_module = Module('genrule', target_module_name, target.name)
566 descriptor_module.cmd = ' '.join(cmd)
567 descriptor_module.out = [out]
568 descriptor_module.tools = tools
569 blueprint.add_module(descriptor_module)
570
571 # Recursively extract the .proto files of all the dependencies and
572 # add them to srcs.
573 descriptor_module.srcs.update(
574 gn_utils.label_to_path(src) for src in target.sources)
575 for dep in target.transitive_proto_deps:
576 current_target = gn.get_target(dep)
577 descriptor_module.srcs.update(
578 gn_utils.label_to_path(src) for src in current_target.sources)
579
580 return descriptor_module
581
582 # We create two genrules for each proto target: one for the headers and
583 # another for the sources. This is because the module that depends on the
584 # generated files needs to declare two different types of dependencies --
585 # source files in 'srcs' and headers in 'generated_headers' -- and it's not
586 # valid to generate .h files from a source dependency and vice versa.
587 source_module_name = target_module_name + '_gen'
588 source_module = Module('genrule', source_module_name, target.name)
589 blueprint.add_module(source_module)
590 source_module.srcs.update(
591 gn_utils.label_to_path(src) for src in target.sources)
592
593 header_module = Module('genrule', source_module_name + '_headers',
594 target.name)
595 blueprint.add_module(header_module)
596 header_module.srcs = set(source_module.srcs)
597
598 # TODO(primiano): at some point we should remove this. This was introduced
599 # by aosp/1108421 when adding "protos/" to .proto include paths, in order to
600 # avoid doing multi-repo changes and allow old clients in the android tree
601 # to still do the old #include "perfetto/..." rather than
602 # #include "protos/perfetto/...".
603 header_module.export_include_dirs = {'.', 'protos'}
Patrick Rohr2267a0a2022-11-08 18:59:34 -0800604 # Since the .cc file and .h get created by a different gerule target, they
605 # are not put in the same intermediate path, so local includes do not work
606 # without explictily exporting the include dir.
607 header_module.export_include_dirs.add(target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700608
609 source_module.genrule_srcs.add(':' + source_module.name)
610 source_module.genrule_headers.add(header_module.name)
611
612 if target.proto_plugin == 'proto':
613 suffixes = ['pb']
614 source_module.genrule_shared_libs.add('libprotobuf-cpp-lite')
615 cmd += ['--cpp_out=lite=true:' + cpp_out_dir]
616 elif target.proto_plugin == 'protozero':
617 suffixes = ['pbzero']
618 plugin = create_modules_from_target(blueprint, gn, protozero_plugin)
619 tools.add(plugin.name)
620 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
621 cmd += ['--plugin_out=wrapper_namespace=pbzero:' + cpp_out_dir]
622 elif target.proto_plugin == 'cppgen':
623 suffixes = ['gen']
624 plugin = create_modules_from_target(blueprint, gn, cppgen_plugin)
625 tools.add(plugin.name)
626 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
627 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
628 elif target.proto_plugin == 'ipc':
629 suffixes = ['ipc']
630 plugin = create_modules_from_target(blueprint, gn, ipc_plugin)
631 tools.add(plugin.name)
632 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
633 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
634 else:
635 raise Error('Unsupported proto plugin: %s' % target.proto_plugin)
636
637 cmd += ['$(in)']
638 source_module.cmd = ' '.join(cmd)
639 header_module.cmd = source_module.cmd
640 source_module.tools = tools
641 header_module.tools = tools
642
643 for sfx in suffixes:
644 source_module.out.update('%s/%s' %
645 (tree_path, src.replace('.proto', '.%s.cc' % sfx))
646 for src in source_module.srcs)
647 header_module.out.update('%s/%s' %
648 (tree_path, src.replace('.proto', '.%s.h' % sfx))
649 for src in header_module.srcs)
650 return source_module
651
652
653def create_amalgamated_sql_metrics_module(blueprint, target):
654 bp_module_name = label_to_module_name(target.name)
655 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700656 module.tool_files.add('tools/gen_amalgamated_sql_metrics.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700657 module.cmd = ' '.join([
658 '$(location tools/gen_amalgamated_sql_metrics.py)',
659 '--cpp_out=$(out)',
660 '$(in)',
661 ])
662 module.genrule_headers.add(module.name)
663 module.out.update(target.outputs)
664 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
665 blueprint.add_module(module)
666 return module
667
668
669def create_cc_proto_descriptor_module(blueprint, target):
670 bp_module_name = label_to_module_name(target.name)
671 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700672 module.tool_files.add('tools/gen_cc_proto_descriptor.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700673 module.cmd = ' '.join([
674 '$(location tools/gen_cc_proto_descriptor.py)', '--gen_dir=$(genDir)',
675 '--cpp_out=$(out)', '$(in)'
676 ])
677 module.genrule_headers.add(module.name)
678 module.srcs.update(
679 ':' + label_to_module_name(dep) for dep in target.proto_deps)
680 module.srcs.update(
681 gn_utils.label_to_path(src)
682 for src in target.inputs
683 if "tmp.gn_utils" not in src)
684 module.out.update(target.outputs)
685 blueprint.add_module(module)
686 return module
687
688
689def create_gen_version_module(blueprint, target, bp_module_name):
690 module = Module('genrule', bp_module_name, gn_utils.GEN_VERSION_TARGET)
691 script_path = gn_utils.label_to_path(target.script)
692 module.genrule_headers.add(bp_module_name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700693 module.tool_files.add(script_path)
Patrick Rohr92d74122022-10-21 15:50:52 -0700694 module.out.update(target.outputs)
695 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
696 module.cmd = ' '.join([
697 'python3 $(location %s)' % script_path, '--no_git',
698 '--changelog=$(location CHANGELOG)', '--cpp_out=$(out)'
699 ])
700 blueprint.add_module(module)
701 return module
702
703
704def create_proto_group_modules(blueprint, gn, module_name, target_names):
705 # TODO(lalitm): today, we're only adding a Java lite module because that's
706 # the only one used in practice. In the future, if we need other target types
707 # (e.g. C++, Java full etc.) add them here.
708 bp_module_name = label_to_module_name(module_name) + '_java_protos'
709 module = Module('java_library', bp_module_name, bp_module_name)
710 module.comment = f'''GN: [{', '.join(target_names)}]'''
711 module.proto = {'type': 'lite', 'canonical_path_from_root': False}
712
713 for name in target_names:
714 target = gn.get_target(name)
715 module.srcs.update(gn_utils.label_to_path(src) for src in target.sources)
716 for dep_label in target.transitive_proto_deps:
717 dep = gn.get_target(dep_label)
718 module.srcs.update(gn_utils.label_to_path(src) for src in dep.sources)
719
720 blueprint.add_module(module)
721
Motomu Utsumia6c33152022-11-02 18:21:55 +0900722# HACK: Need to support build_cofig_gen flexibly instead of hardcoding
723# build_config_gen generates srcjar by executing gcc via gcc_preprocess.py but gcc is not
724# available in genrule sandbox. Also gcc path is not configurable.
725# Under the //net:net, gcc_preprocess.py is only used for build_config_gen.
726# So, for now, hardcoding BuildConfig.java and generates srcjar by soong_zip.
727def override_build_config_gen(module):
728 module.tool_files.clear()
729 module.tools.add("soong_zip")
730 cmd = [
731 "echo",
732 "\\\"package org.chromium.build;\\n",
733 "public class BuildConfig {\\n",
734 "public static boolean IS_MULTIDEX_ENABLED ;\\n",
735 "public static boolean ENABLE_ASSERTS = true;\\n",
736 "public static boolean IS_UBSAN ;\\n",
737 "public static boolean IS_CHROME_BRANDED ;\\n",
738 "public static int R_STRING_PRODUCT_VERSION ;\\n",
739 "public static int MIN_SDK_VERSION = 1;\\n",
740 "public static boolean BUNDLES_SUPPORTED ;\\n",
741 "public static boolean IS_INCREMENTAL_INSTALL ;\\n",
742 "public static boolean ISOLATED_SPLITS_ENABLED ;\\n",
743 "public static boolean IS_FOR_TEST ;\\n",
744 "}\\n\\\"",
745 "> $(genDir)/BuildConfig.java &&",
746 "$(location soong_zip) -o $(out) -srcjar -f $(genDir)/BuildConfig.java"
747 ]
748 NEWLINE = ' " +\n "'
749 module.cmd = NEWLINE.join(cmd)
750 return module
751
Mohannad Farragbab6c892022-11-02 14:09:46 +0000752def create_action_foreach_modules(blueprint, target):
753 """ The following assumes that rebase_path exists in the args.
754 The args of an action_foreach contains hints about which output files are generated
755 by which source files.
756 This is copied directly from the args
757 "gen/net/base/registry_controlled_domains/{{source_name_part}}-reversed-inc.cc"
758 So each source file will generate an output whose name is the {source_name-reversed-inc.cc}
759 """
760 new_args = []
Motomu Utsumi56afcac2022-11-04 12:58:30 +0900761 for i, src in enumerate(sorted(target.sources)):
Mohannad Farragbab6c892022-11-02 14:09:46 +0000762 # don't add script arg for the first source -- create_action_module
763 # already does this.
764 if i != 0:
765 new_args.append('&& python3 $(location %s)' %
766 gn_utils.label_to_path(target.script))
767 for arg in target.args:
768 if '{{source}}' in arg:
769 new_args.append('$(location %s)' % (gn_utils.label_to_path(src)))
770 elif '{{source_name_part}}' in arg:
771 source_name_part = src.split("/")[-1] # Get the file name only
772 source_name_part = source_name_part.split(".")[0] # Remove the extension (Ex: .cc)
773 file_name = arg.replace('{{source_name_part}}', source_name_part).split("/")[-1]
774 # file_name represent the output file name. But we need the whole path
775 # This can be found from target.outputs.
776 for out in target.outputs:
777 if out.endswith(file_name):
778 new_args.append('$(location %s)' % out)
779 else:
780 new_args.append(arg)
781
782 target.args = new_args
783 return create_action_module(blueprint, target)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900784
Patrick Rohr7be99032022-10-31 11:54:19 -0700785def create_action_module(blueprint, target):
786 bp_module_name = label_to_module_name(target.name)
787 module = Module('genrule', bp_module_name, target.name)
788
Patrick Rohr9b99a982022-10-28 11:00:57 -0700789 # Convert ['--param=value'] to ['--param', 'value'] for consistency.
790 # TODO: we may want to only do this for python scripts arguments. If argparse
791 # is used, this transformation is safe.
792 target.args = [str for it in target.args for str in it.split('=')]
793
Motomu Utsumibf569d42022-10-28 16:47:34 +0900794 if target.script == "//build/write_buildflag_header.py":
795 # write_buildflag_header.py writes result to args.genDir/args.output
796 # So, override args.genDir by '.' so that args.output=$(out) works
Patrick Rohrde568a22022-10-28 09:22:35 -0700797 for i, val in enumerate(target.args):
798 if val == '--gen-dir':
799 target.args[i + 1] = '.'
Patrick Rohrfa972402022-11-01 11:54:35 -0700800 elif val == '--output':
801 target.args[i + 1] = '$(out)'
802
803 elif target.script == '//build/write_build_date_header.py':
804 target.args[0] = '$(out)'
Patrick Rohr0db9f852022-10-27 13:49:57 -0700805
Patrick Rohr8acccca2022-10-28 10:39:06 -0700806 elif target.script == '//base/android/jni_generator/jni_generator.py':
Patrick Rohrc5cc21a2022-10-31 11:57:49 -0700807 # chromium builds against a prebuilt ndk that contains the jni_headers, so
808 # a dependency is never explicitly created.
809 module.genrule_header_libs.add('jni_headers')
Patrick Rohr131ba282022-10-31 16:36:20 -0700810 needs_javap = False
Patrick Rohr8acccca2022-10-28 10:39:06 -0700811 for i, val in enumerate(target.args):
Motomu Utsumi6f9139d2022-10-31 12:15:19 +0900812 if val == '--output_dir':
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700813 # replace --output_dir gen/jni_headers/... with --output_dir $(genDir)/...
814 target.args[i + 1] = re.sub('^gen/jni_headers', '$(genDir)', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700815 elif val == '--input_file':
Patrick Rohr8acccca2022-10-28 10:39:06 -0700816 # --input_file supports both .class specifiers or source files as arguments.
817 # Only source files need to be wrapped inside a $(location <label>) tag.
818 if re.match('.*\.class$', target.args[i + 1]):
819 continue
820 # replace --input_file ../../... with --input_file $(location ...)
821 # TODO: put inside function
822 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
823 target.args[i + 1] = '$(location %s)' % filename
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700824 elif val == '--includes' and 'jni_generator_helper' in target.args[i + 1]:
Patrick Rohrd89e8bf2022-10-31 14:51:05 -0700825 # delete all leading ../
826 target.args[i + 1] = re.sub('^(\.\./)+', '', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700827 elif val == '--prev_output_dir':
Patrick Rohr131ba282022-10-31 16:36:20 -0700828 # this is not needed for aosp builds.
829 target.args[i] = ''
830 target.args[i + 1] = ''
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700831 elif val == '--jar_file':
Patrick Rohr131ba282022-10-31 16:36:20 -0700832 # delete leading ../../ and add path to javap
833 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
834 target.args[i + 1] = '$(location %s)' % filename
835 needs_javap = True
836
837 if needs_javap:
838 target.args.append('--javap')
839 target.args.append('$$(find out/.path -name javap)')
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700840 # fix target.output directory to match #include statements.
841 target.outputs = [re.sub('^jni_headers/', '', out) for out in target.outputs]
Patrick Rohr8acccca2022-10-28 10:39:06 -0700842
Patrick Rohrf6d2b612022-11-09 12:30:26 -0800843 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
844 # jni_registration_generator.py pulls in some config dependencies that we
845 # do not handle. Remove them.
846 # TODO: find a better way to do this.
847 target.deps.clear()
848
Motomu Utsumied009082022-11-10 16:26:44 +0900849 target.inputs = [file for file in target.inputs if not file.startswith('//out/')]
Motomu Utsumi6b4acaa2022-11-10 16:13:24 +0900850 for i, val in enumerate(target.args):
851 if val in ['--depfile', '--srcjar-path', '--header-path']:
852 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900853 if val == '--sources-files':
854 target.args[i + 1] = '$(genDir)/java.sources'
Motomu Utsumi47d122f2022-11-10 17:32:23 +0900855 elif val == '--sources-exclusions':
856 # update_jni_registration_module removes them from the srcs of the module
857 # It might be better to remove sources by '--sources-exclusions'
858 target.args[i] = ''
859 target.args[i + 1] = ''
Motomu Utsumi6b4acaa2022-11-10 16:13:24 +0900860
Patrick Rohr245df582022-11-01 16:59:45 -0700861 elif target.script == '//build/android/gyp/write_build_config.py':
862 for i, val in enumerate(target.args):
863 if val == '--depfile':
864 # Depfile is not used, so no need to generate it.
865 target.args[i] = ''
866 target.args[i + 1] = ''
867 elif val in ['--deps-configs', '--bundled-srcjars']:
868 args = target.args[i + 1]
869 if args == '[]':
870 continue
871 # strip surrounding [] and split by ", "
872 args = args.strip('[]').split(', ')
873 # strip surrounding ""
874 args = [arg.strip('"') for arg in args]
875 # remove leading gen/
876 args = [re.sub('^gen/', '', arg) for arg in args]
877 # wrap filename in \"$(location filename)\"
878 args = ['\"$(location %s)\"' % arg for arg in args]
879 # join args with ", " and wrap in []
880 target.args[i + 1] = '[%s]' % ', '.join(args)
881
882 elif val == '--public-deps-configs':
883 # TODO: implement.
884 pass
885
886 elif val == '--build-config':
887 # json output of this script
888 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
889
890 elif val in ['--unprocessed-jar-path', '--interface-jar-path',
891 '--device-jar-path', '--host-jar-path']:
892 # jar path can be within sources (../../) or output generated by
893 # another genrule (obj/)
894 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
895 filename = re.sub('^obj/', '', target.args[i + 1])
896 target.args[i + 1] = '$(location %s)' % filename
897
898 elif val == '--proguard-configs':
899 args = target.args[i + 1]
900 if args == '[]':
901 continue
902 # TODO: consider adding helpers to deal with argument lists
903 # strip surrounding [] and split by ", ", then strip surrounding ""
904 args = args.strip('[]').split(', ')
905 args = [arg.strip('"') for arg in args]
906 # remove leading ../../
907 args = [re.sub('^\.\./\.\./', '', arg) for arg in args]
908 # add dependency on proguard config file, so a $(location) wrapper can be used.
909 module.tool_files.update(args)
910 # wrap filename in \"$(location filename)\"
911 args = ['$(location %s)' % arg for arg in args]
912 target.args[i + 1] = '[%s]' % ', '.join(args)
Motomu Utsumi1caa39b2022-11-02 18:38:13 +0900913 elif target.script == "//build/android/gyp/write_native_libraries_java.py":
914 for i, val in enumerate(target.args):
915 if val == '--output':
916 target.args[i + 1] = '$(out)'
Motomu Utsumi26211dc2022-11-02 19:38:47 +0900917 elif target.script == "//tools/grit/stamp_grit_sources.py":
918 target.outputs = [re.sub('^\/\/', '', out) for out in target.outputs]
919 # Directory that contains grit scripts
920 target.args[0] = '`dirname $(location tools/grit/grit.py)`'
921 # Path to the stamp file
922 target.args[1] = '$(out)'
923 # Script tries to create args[2] file but this is not in the output.
924 # Specifying file under $(genDir) so that parent directory exists.
925 # If this file is used by other module, we may need to add this file to the outputs.
926 target.args[2] = '$(genDir)/' + target.args[2].split('/')[-1]
Mohannad Farrag033c9d62022-11-07 14:55:49 +0000927 elif target.script == "//tools/grit/grit.py":
928 for i, val in enumerate(target.args):
929 if val == '-i':
930 # Delete leading ../..
931 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
932 target.args[i + 1] = '$(location %s)' % filename
933 elif val == '-o':
934 filename = re.sub('^gen/', '', target.args[i + 1])
935 if filename == "net":
936 # This is a directory not a file
937 target.args[i + 1] = '$(genDir)/net'
938 else:
939 # This is an output fil
940 target.args[i + 1] = '$(location %s)' % filename
941 elif val == '--depfile':
942 # The depfile is replaced by adding /tools/**/*.py to the tools_files
943 # This is basically just globbing all the needed sources by hardcoding.
944 module.tool_files.update([
945 "tools/grit/**/*.py",
946 "third_party/six/src/six.py" # This is not picked up by default. Must be added
947 ])
948
949 # Delete the depfile argument
950 target.args[i] = ' '
951 target.args[i + 1] = ' '
952 elif val == '--input':
953 # Delete leading ../..
954 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
955 # This is an output file so use $(location %s)
956 target.args[i + 1] = '$(location %s)' % filename
Motomu Utsumia0cc6662022-11-09 15:22:27 +0900957 elif target.script == "//net/tools/dafsa/make_dafsa.py":
958 # This script generates .cc files but source (registry_controlled_domain.cc) in the target that
959 # depends on this target includes .cc file this script generates.
960 module.genrule_headers.add(module.name)
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900961 elif target.script == "//build/util/version.py":
Motomu Utsumib0a49e42022-11-09 18:12:27 +0900962 # android_chrome_version.py is not specified in anywhere but version.py imports this file
963 module.tool_files.add('build/util/android_chrome_version.py')
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900964 for i, val in enumerate(target.args):
965 if val.startswith('../../'):
966 filename = re.sub('^\.\./\.\./', '', val)
967 target.args[i] = '$(location %s)' % filename
Motomu Utsumiee279c52022-11-09 17:46:27 +0900968 elif val == '-e':
969 # arg for -e EVAL option should be passed in -e PATCH_HI=int(PATCH)//256 format.
970 target.args[i + 1] = '%s=\'%s\'' % (target.args[i + 1], target.args[i + 2])
971 target.args[i + 2] = ''
Motomu Utsumi438f2c22022-11-09 18:16:40 +0900972 elif val == '-o':
973 target.args[i + 1] = '$(out)'
Patrick Rohr245df582022-11-01 16:59:45 -0700974
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700975 script = gn_utils.label_to_path(target.script)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700976 module.tool_files.add(script)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700977
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700978 # Handle passing parameters via response file by piping them into the script
979 # and reading them from /dev/stdin.
980 response_file = '{{response_file_name}}'
981 use_response_file = response_file in target.args
982 if use_response_file:
983 # Replace {{response_file_contents}} with /dev/stdin
984 target.args = ['/dev/stdin' if it == response_file else it for it in target.args]
985
Patrick Rohr4b0952d2022-11-01 12:42:31 -0700986 # escape " and \$ in target.args.
987 # once all actions are properly implemented, this may not be necessary anymore.
988 # TODO: is this the right place to do this?
989 target.args = [arg.replace('"', r'\"') for arg in target.args]
990 target.args = [arg.replace(r'\$', r'\\$') for arg in target.args]
991
Patrick Rohr9b99a982022-10-28 11:00:57 -0700992 # put all args on a new line for better diffs.
993 NEWLINE = ' " +\n "'
994 arg_string = NEWLINE.join(target.args)
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700995 module.cmd = '$(location %s) %s' % (script, arg_string)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700996
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700997 if use_response_file:
998 # Pipe response file contents into script
Patrick Rohr9b99a982022-10-28 11:00:57 -0700999 module.cmd = 'echo \'%s\' |%s%s' % (target.response_file_contents, NEWLINE, module.cmd)
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -07001000
Motomu Utsumi7e983832022-11-10 16:04:46 +09001001 if any(os.path.splitext(it)[1] == '.h' for it in target.outputs):
Patrick Rohr67f4d432022-10-26 16:04:15 -07001002 module.genrule_headers.add(bp_module_name)
Patrick Rohre1a853e2022-10-26 12:31:39 -07001003
Patrick Rohr0db9f852022-10-27 13:49:57 -07001004 # gn treats inputs and sources for actions equally.
1005 # soong only supports source files inside srcs, non-source files are added as
1006 # tool_files dependency.
1007 for it in target.sources or target.inputs:
1008 if is_supported_source_file(it):
1009 module.srcs.add(gn_utils.label_to_path(it))
1010 else:
1011 module.tool_files.add(gn_utils.label_to_path(it))
Patrick Rohre1a853e2022-10-26 12:31:39 -07001012
Patrick Rohr15a2c302022-10-26 15:08:57 -07001013 # Actions using template "action_with_pydeps" also put script inside inputs.
1014 # TODO: it might make sense to filter inputs inside GnParser.
1015 if script in module.srcs:
1016 module.srcs.remove(script)
1017
Patrick Rohre1a853e2022-10-26 12:31:39 -07001018 module.out.update(target.outputs)
Motomu Utsumia6c33152022-11-02 18:21:55 +09001019
1020 if target.name == "//build/android:build_config_gen":
1021 module = override_build_config_gen(module)
Motomu Utsumi26211dc2022-11-02 19:38:47 +09001022 elif target.script == "//tools/grit/stamp_grit_sources.py":
1023 # stamp_grit_sources.py is not executable
1024 module.cmd = "python " + module.cmd
Mohannad Farrag18d7b512022-11-07 13:26:30 +00001025 elif target.script == "//base/android/jni_generator/jni_generator.py":
1026 # android_jar.classes should be part of the tools as it list implicit classes
1027 # for the script to generate JNI headers.
1028 module.tool_files.add("base/android/jni_generator/android_jar.classes")
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +09001029 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
Motomu Utsumi9ca466b2022-11-10 17:12:29 +09001030 # jni_registration_generator.py doesn't work with python2
1031 module.cmd = "python3 " + module.cmd
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +09001032 # Path in the original sources file does not work in genrule.
1033 # So creating sources file in cmd based on the srcs of this target.
1034 # Adding ../$(current_dir)/ to the head because jni_registration_generator.py uses the files
1035 # whose path startswith(..)
1036 commands = ["current_dir=`basename \\\`pwd\\\``;",
1037 "for f in $(in);",
1038 "do",
1039 "echo \\\"../$$current_dir/$$f\\\" >> $(genDir)/java.sources;",
1040 "done;",
1041 module.cmd]
Motomu Utsumi2a892d22022-11-10 18:03:20 +09001042
1043 # .h file jni_registration_generator.py generates has #define with directory name.
1044 # With the genrule env that contains "." which is invalid. So replace that at the end of cmd.
Mohannad Farrag7c0f0982022-11-10 14:39:49 +00001045 commands.append(";sed -i -e 's/OUT_SOONG_.TEMP_SBOX_.*_OUT/GEN/g' ")
Motomu Utsumi2a892d22022-11-10 18:03:20 +09001046 commands.append("$(genDir)/components/cronet/android/cronet_jni_registration.h")
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +09001047 module.cmd = NEWLINE.join(commands)
Motomu Utsumia6c33152022-11-02 18:21:55 +09001048
Patrick Rohre1a853e2022-10-26 12:31:39 -07001049 blueprint.add_module(module)
1050 return module
1051
1052
Patrick Rohr92d74122022-10-21 15:50:52 -07001053
1054def _get_cflags(target):
1055 cflags = {flag for flag in target.cflags if re.match(cflag_allowlist, flag)}
Motomu Utsumifa7e9262022-10-26 19:43:02 +09001056 # Consider proper allowlist or denylist if needed
1057 cflags |= set("-D%s" % define.replace("\"", "\\\"") for define in target.defines)
Patrick Rohr92d74122022-10-21 15:50:52 -07001058 return cflags
1059
1060
1061def create_modules_from_target(blueprint, gn, gn_target_name):
1062 """Generate module(s) for a given GN target.
1063
1064 Given a GN target name, generate one or more corresponding modules into a
1065 blueprint. The only case when this generates >1 module is proto libraries.
1066
1067 Args:
1068 blueprint: Blueprint instance which is being generated.
1069 gn: gn_utils.GnParser object.
1070 gn_target_name: GN target for module generation.
1071 """
1072 bp_module_name = label_to_module_name(gn_target_name)
1073 if bp_module_name in blueprint.modules:
1074 return blueprint.modules[bp_module_name]
1075 target = gn.get_target(gn_target_name)
Patrick Rohr16228942022-10-26 14:00:26 -07001076 log.info('create modules for %s (%s)', target.name, target.type)
Patrick Rohr92d74122022-10-21 15:50:52 -07001077
1078 name_without_toolchain = gn_utils.label_without_toolchain(target.name)
1079 if target.type == 'executable':
1080 if target.toolchain == gn_utils.HOST_TOOLCHAIN:
1081 module_type = 'cc_binary_host'
1082 elif target.testonly:
1083 module_type = 'cc_test'
1084 else:
1085 module_type = 'cc_binary'
1086 module = Module(module_type, bp_module_name, gn_target_name)
1087 elif target.type == 'static_library':
1088 module = Module('cc_library_static', bp_module_name, gn_target_name)
1089 elif target.type == 'shared_library':
1090 module = Module('cc_library_shared', bp_module_name, gn_target_name)
1091 elif target.type == 'source_set':
1092 module = Module('filegroup', bp_module_name, gn_target_name)
1093 elif target.type == 'group':
1094 # "group" targets are resolved recursively by gn_utils.get_target().
1095 # There's nothing we need to do at this level for them.
1096 return None
1097 elif target.type == 'proto_library':
1098 module = create_proto_modules(blueprint, gn, target)
1099 if module is None:
1100 return None
1101 elif target.type == 'action':
1102 if 'gen_amalgamated_sql_metrics' in target.name:
1103 module = create_amalgamated_sql_metrics_module(blueprint, target)
1104 elif re.match('.*gen_cc_.*_descriptor$', name_without_toolchain):
1105 module = create_cc_proto_descriptor_module(blueprint, target)
1106 elif target.type == 'action' and \
1107 name_without_toolchain == gn_utils.GEN_VERSION_TARGET:
1108 module = create_gen_version_module(blueprint, target, bp_module_name)
1109 else:
Patrick Rohre1a853e2022-10-26 12:31:39 -07001110 module = create_action_module(blueprint, target)
Mohannad Farragf076f3e2022-10-31 17:45:28 +00001111 elif target.type == 'action_foreach':
Mohannad Farragbab6c892022-11-02 14:09:46 +00001112 module = create_action_foreach_modules(blueprint, target)
Patrick Rohr59a76652022-10-26 12:36:56 -07001113 elif target.type == 'copy':
1114 # TODO: careful now! copy targets are not supported yet, but this will stop
1115 # traversing the dependency tree. For //base:base, this is not a big
1116 # problem as libicu contains the only copy target which happens to be a
1117 # leaf node.
1118 return None
Patrick Rohrad440602022-11-10 22:09:04 -08001119 elif target.type == 'java_group':
1120 # Java targets are handled outside of create_modules_from_target.
1121 return None
Patrick Rohr92d74122022-10-21 15:50:52 -07001122 else:
1123 raise Error('Unknown target %s (%s)' % (target.name, target.type))
1124
1125 blueprint.add_module(module)
1126 module.host_supported = (name_without_toolchain in target_host_supported)
Patrick Rohr92d74122022-10-21 15:50:52 -07001127 module.init_rc = target_initrc.get(target.name, [])
1128 module.srcs.update(
1129 gn_utils.label_to_path(src)
1130 for src in target.sources
Motomu Utsumif951e502022-11-07 19:31:15 +09001131 if is_supported_source_file(src) and not src.startswith("//out/test"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001132
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001133 local_include_dirs_set = set()
Patrick Rohr92d74122022-10-21 15:50:52 -07001134 if target.type in gn_utils.LINKER_UNIT_TYPES:
1135 module.cflags.update(_get_cflags(target))
Patrick Rohrf22e9d02022-10-28 14:20:46 -07001136 # TODO: implement proper cflag parsing.
1137 for flag in target.cflags:
Patrick Rohrb8f830a2022-10-31 11:18:57 -07001138 if '-std=' in flag:
1139 module.cpp_std = flag[len('-std='):]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001140 if '-isystem' in flag:
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001141 local_include_dirs_set.add(flag[len('-isystem../../'):])
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
1234 return module
1235
Patrick Rohrb18aca22022-11-04 15:07:32 -07001236def create_java_module(blueprint, gn):
1237 bp_module_name = module_prefix + 'java'
1238 module = Module('java_library', bp_module_name, '//gn:java')
Mohannad Farrag21562d62022-11-07 13:09:31 +00001239 module.srcs.update([gn_utils.label_to_path(source) for source in gn.java_sources])
Patrick Rohrb18aca22022-11-04 15:07:32 -07001240 blueprint.add_module(module)
Patrick Rohr92d74122022-10-21 15:50:52 -07001241
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001242def update_jni_registration_module(blueprint, gn):
1243 bp_module_name = label_to_module_name('//components/cronet/android:cronet_jni_registration')
Patrick Rohr7f225422022-11-10 21:38:38 -08001244 if bp_module_name not in blueprint.modules:
1245 # To support building targets that might not create the cronet_jni_registration.
1246 return
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001247 module = blueprint.modules[bp_module_name]
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001248
1249 # TODO: deny list is in the arg of jni_registration_generator.py. Should not be hardcoded
1250 deny_list = [
1251 '//base/android/java/src/org/chromium/base/library_loader/LibraryLoader.java',
1252 '//base/android/java/src/org/chromium/base/library_loader/LibraryPrefetcher.java',
1253 '//base/android/java/src/org/chromium/base/process_launcher/ChildProcessService.java',
1254 '//base/android/java/src/org/chromium/base/SysUtils.java']
1255
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001256 # TODO: java_sources might not contain all the required java files
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001257 module.srcs.update([gn_utils.label_to_path(source)
1258 for source in gn.java_sources if source not in deny_list])
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001259
Motomu Utsumi79bd0c82022-11-10 17:52:24 +09001260 # TODO: Remove hardcoded file addition to srcs
1261 # jni_registration_generator.py generates empty .h file if native methods are not found in the
1262 # java files. But android:cronet depends on `RegisterNonMainDexNatives` which is in the template
1263 # of .h file. To make script generate non empty .h file, adding java file which contains native
1264 # method. Once all the required java files are added to the srcs, this can be removed.
1265 module.srcs.update([
1266 "components/cronet/android/java/src/org/chromium/net/impl/CronetUrlRequest.java"])
1267
Patrick Rohr92d74122022-10-21 15:50:52 -07001268def create_blueprint_for_targets(gn, desc, targets):
1269 """Generate a blueprint for a list of GN targets."""
1270 blueprint = Blueprint()
1271
1272 # Default settings used by all modules.
1273 defaults = Module('cc_defaults', defaults_module, '//gn:default_deps')
Patrick Rohr92d74122022-10-21 15:50:52 -07001274 defaults.cflags = [
1275 '-Wno-error=return-type',
Patrick Rohr3a1ec1d2022-10-31 13:30:17 -07001276 '-Wno-non-virtual-dtor',
Patrick Rohr5c700022022-11-08 19:33:07 -08001277 '-Wno-macro-redefined',
Patrick Rohr98065152022-10-31 14:49:58 -07001278 '-Wno-missing-field-initializers',
Patrick Rohr92d74122022-10-21 15:50:52 -07001279 '-Wno-sign-compare',
1280 '-Wno-sign-promo',
1281 '-Wno-unused-parameter',
Mohannad Farragd98a96d2022-11-10 14:56:19 +00001282 '-Wno-deprecated-non-prototype', # needed for zlib
Patrick Rohr92d74122022-10-21 15:50:52 -07001283 '-fvisibility=hidden',
1284 '-O2',
1285 ]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001286 defaults.stl = 'none'
Patrick Rohr92d74122022-10-21 15:50:52 -07001287 blueprint.add_module(defaults)
Patrick Rohr344b2472022-10-25 11:32:15 -07001288
Patrick Rohr92d74122022-10-21 15:50:52 -07001289 for target in targets:
1290 create_modules_from_target(blueprint, gn, target)
Patrick Rohrb18aca22022-11-04 15:07:32 -07001291
1292 create_java_module(blueprint, gn)
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001293 update_jni_registration_module(blueprint, gn)
Patrick Rohra7d029d2022-11-08 12:23:11 -08001294
1295 # Merge in additional hardcoded arguments.
1296 for module in blueprint.modules.values():
1297 for key, add_val in additional_args.get(module.name, []):
1298 curr = getattr(module, key)
1299 if add_val and isinstance(add_val, set) and isinstance(curr, set):
1300 curr.update(add_val)
1301 elif isinstance(add_val, str) and (not curr or isinstance(curr, str)):
1302 setattr(module, key, add_val)
1303 elif isinstance(add_val, bool) and (not curr or isinstance(curr, bool)):
1304 setattr(module, key, add_val)
1305 elif isinstance(add_val, dict) and isinstance(curr, dict):
1306 curr.update(add_val)
1307 elif isinstance(add_val, dict) and isinstance(curr, Target):
1308 curr.__dict__.update(add_val)
1309 else:
1310 raise Error('Unimplemented type %r of additional_args: %r' %
1311 (type(add_val), key))
1312
Patrick Rohr92d74122022-10-21 15:50:52 -07001313 return blueprint
1314
1315
1316def main():
1317 parser = argparse.ArgumentParser(
1318 description='Generate Android.bp from a GN description.')
1319 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001320 '--desc',
Patrick Rohr3db246a2022-10-25 10:25:17 -07001321 help='GN description (e.g., gn desc out --format=json --all-toolchains "//*"',
1322 required=True
Patrick Rohr92d74122022-10-21 15:50:52 -07001323 )
1324 parser.add_argument(
1325 '--extras',
1326 help='Extra targets to include at the end of the Blueprint file',
1327 default=os.path.join(gn_utils.repo_root(), 'Android.bp.extras'),
1328 )
1329 parser.add_argument(
1330 '--output',
1331 help='Blueprint file to create',
1332 default=os.path.join(gn_utils.repo_root(), 'Android.bp'),
1333 )
1334 parser.add_argument(
Patrick Rohr16228942022-10-26 14:00:26 -07001335 '-v',
1336 '--verbose',
1337 help='Print debug logs.',
1338 action='store_true',
1339 )
1340 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001341 'targets',
1342 nargs=argparse.REMAINDER,
Patrick Rohr1aa504a2022-10-25 10:30:42 -07001343 help='Targets to include in the blueprint (e.g., "//:perfetto_tests")'
1344 )
Patrick Rohr92d74122022-10-21 15:50:52 -07001345 args = parser.parse_args()
1346
Patrick Rohr16228942022-10-26 14:00:26 -07001347 if args.verbose:
1348 log.basicConfig(format='%(levelname)s:%(funcName)s:%(message)s', level=log.DEBUG)
1349
Patrick Rohr3db246a2022-10-25 10:25:17 -07001350 with open(args.desc) as f:
1351 desc = json.load(f)
Patrick Rohr92d74122022-10-21 15:50:52 -07001352
1353 gn = gn_utils.GnParser(desc)
Patrick Rohr06296362022-11-10 21:37:33 -08001354 blueprint = create_blueprint_for_targets(gn, desc, args.targets or default_targets)
Patrick Rohr92d74122022-10-21 15:50:52 -07001355 project_root = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
1356 tool_name = os.path.relpath(os.path.abspath(__file__), project_root)
1357
Patrick Rohr92d74122022-10-21 15:50:52 -07001358 # Add any proto groups to the blueprint.
1359 for l_name, t_names in proto_groups.items():
1360 create_proto_group_modules(blueprint, gn, l_name, t_names)
1361
1362 output = [
Patrick Rohr5478b392022-10-25 09:58:50 -07001363 """// Copyright (C) 2022 The Android Open Source Project
Patrick Rohr92d74122022-10-21 15:50:52 -07001364//
1365// Licensed under the Apache License, Version 2.0 (the "License");
1366// you may not use this file except in compliance with the License.
1367// You may obtain a copy of the License at
1368//
1369// http://www.apache.org/licenses/LICENSE-2.0
1370//
1371// Unless required by applicable law or agreed to in writing, software
1372// distributed under the License is distributed on an "AS IS" BASIS,
1373// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1374// See the License for the specific language governing permissions and
1375// limitations under the License.
1376//
1377// This file is automatically generated by %s. Do not edit.
1378""" % (tool_name)
1379 ]
1380 blueprint.to_string(output)
Patrick Rohrcb98e9b2022-10-25 09:57:02 -07001381 if os.path.exists(args.extras):
1382 with open(args.extras, 'r') as r:
1383 for line in r:
1384 output.append(line.rstrip("\n\r"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001385
1386 out_files = []
1387
1388 # Generate the Android.bp file.
1389 out_files.append(args.output + '.swp')
1390 with open(out_files[-1], 'w') as f:
1391 f.write('\n'.join(output))
1392 # Text files should have a trailing EOL.
1393 f.write('\n')
1394
Patrick Rohr94693eb2022-10-25 10:09:16 -07001395 return 0
Patrick Rohr92d74122022-10-21 15:50:52 -07001396
1397
1398if __name__ == '__main__':
1399 sys.exit(main())