blob: e7028d1c06665ef4ec3dcdc9ed3853da8816653d [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 Farrage7d29312022-11-10 17:39:16 +0000129 ('whole_static_libs', {
130 'cronet_aml_net_third_party_quiche_quiche',
131 'cronet_aml_base_base',
132 "cronet_aml_crypto_crypto",
Patrick Rohrcc83af22022-11-10 20:00:58 -0800133 "libssl",
Mohannad Farrage7d29312022-11-10 17:39:16 +0000134 }),
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000135 ],
Patrick Rohr92d74122022-10-21 15:50:52 -0700136}
137
138
139def enable_gtest_and_gmock(module):
140 module.static_libs.add('libgmock')
141 module.static_libs.add('libgtest')
142 if module.name != 'perfetto_gtest_logcat_printer':
143 module.whole_static_libs.add('perfetto_gtest_logcat_printer')
144
145
146def enable_protobuf_full(module):
147 if module.type == 'cc_binary_host':
148 module.static_libs.add('libprotobuf-cpp-full')
149 elif module.host_supported:
150 module.host.static_libs.add('libprotobuf-cpp-full')
151 module.android.shared_libs.add('libprotobuf-cpp-full')
Patrick Rohr84b16402022-11-08 19:01:01 -0800152 elif module.type not in ['genrule', 'filegroup']:
Patrick Rohr92d74122022-10-21 15:50:52 -0700153 module.shared_libs.add('libprotobuf-cpp-full')
154
155
156def enable_protobuf_lite(module):
Patrick Rohr84b16402022-11-08 19:01:01 -0800157 if module.type not in ['genrule', 'filegroup']:
158 module.shared_libs.add('libprotobuf-cpp-lite')
Patrick Rohr92d74122022-10-21 15:50:52 -0700159
160
161def enable_protoc_lib(module):
162 if module.type == 'cc_binary_host':
163 module.static_libs.add('libprotoc')
164 else:
165 module.shared_libs.add('libprotoc')
166
167
168def enable_libunwindstack(module):
169 if module.name != 'heapprofd_standalone_client':
170 module.shared_libs.add('libunwindstack')
171 module.shared_libs.add('libprocinfo')
172 module.shared_libs.add('libbase')
173 else:
174 module.static_libs.add('libunwindstack')
175 module.static_libs.add('libprocinfo')
176 module.static_libs.add('libbase')
177 module.static_libs.add('liblzma')
178 module.static_libs.add('libdexfile_support')
179 module.runtime_libs.add('libdexfile') # libdexfile_support dependency
180
181
182def enable_libunwind(module):
183 # libunwind is disabled on Darwin so we cannot depend on it.
184 pass
185
186
187def enable_sqlite(module):
188 if module.type == 'cc_binary_host':
189 module.static_libs.add('libsqlite')
190 module.static_libs.add('sqlite_ext_percentile')
191 elif module.host_supported:
192 # Copy what the sqlite3 command line tool does.
193 module.android.shared_libs.add('libsqlite')
194 module.android.shared_libs.add('libicu')
195 module.android.shared_libs.add('liblog')
196 module.android.shared_libs.add('libutils')
197 module.android.static_libs.add('sqlite_ext_percentile')
198 module.host.static_libs.add('libsqlite')
199 module.host.static_libs.add('sqlite_ext_percentile')
200 else:
201 module.shared_libs.add('libsqlite')
202 module.shared_libs.add('libicu')
203 module.shared_libs.add('liblog')
204 module.shared_libs.add('libutils')
205 module.static_libs.add('sqlite_ext_percentile')
206
207
208def enable_zlib(module):
209 if module.type == 'cc_binary_host':
210 module.static_libs.add('libz')
211 elif module.host_supported:
212 module.android.shared_libs.add('libz')
213 module.host.static_libs.add('libz')
214 else:
215 module.shared_libs.add('libz')
216
217
218def enable_uapi_headers(module):
219 module.include_dirs.add('bionic/libc/kernel')
220
221
222def enable_bionic_libc_platform_headers_on_android(module):
223 module.header_libs.add('bionic_libc_platform_headers')
224
225
Patrick Rohrcc83af22022-11-10 20:00:58 -0800226def enable_boringssl(module):
227 if module.type not in ['genrule', 'filegroup']:
228 module.static_libs.add('libssl')
229
230
Patrick Rohr92d74122022-10-21 15:50:52 -0700231# Android equivalents for third-party libraries that the upstream project
232# depends on.
233builtin_deps = {
234 '//gn:default_deps':
235 lambda x: None,
236 '//gn:gtest_main':
237 lambda x: None,
Patrick Rohr92d74122022-10-21 15:50:52 -0700238 '//gn:gtest_and_gmock':
239 enable_gtest_and_gmock,
240 '//gn:libunwind':
241 enable_libunwind,
Patrick Rohr92d74122022-10-21 15:50:52 -0700242 '//gn:libunwindstack':
243 enable_libunwindstack,
244 '//gn:sqlite':
245 enable_sqlite,
246 '//gn:zlib':
247 enable_zlib,
248 '//gn:bionic_kernel_uapi_headers':
249 enable_uapi_headers,
250 '//src/profiling/memory:bionic_libc_platform_headers_on_android':
251 enable_bionic_libc_platform_headers_on_android,
Motomu Utsumidfc8e6a2022-11-04 18:25:33 +0900252 '//third_party/protobuf:protoc':
253 lambda x: None,
Patrick Rohr84b16402022-11-08 19:01:01 -0800254 '//third_party/protobuf:protobuf_full':
255 enable_protobuf_full,
256 '//third_party/protobuf:protobuf_lite':
257 enable_protobuf_lite,
258 '//third_party/protobuf:protoc_lib':
259 enable_protoc_lib,
Patrick Rohrcc83af22022-11-10 20:00:58 -0800260 '//third_party/boringssl:boringssl':
261 enable_boringssl,
Patrick Rohr92d74122022-10-21 15:50:52 -0700262}
263
264# ----------------------------------------------------------------------------
265# End of configuration.
266# ----------------------------------------------------------------------------
267
268
269class Error(Exception):
270 pass
271
272
273class ThrowingArgumentParser(argparse.ArgumentParser):
274
275 def __init__(self, context):
276 super(ThrowingArgumentParser, self).__init__()
277 self.context = context
278
279 def error(self, message):
280 raise Error('%s: %s' % (self.context, message))
281
282
283def write_blueprint_key_value(output, name, value, sort=True):
284 """Writes a Blueprint key-value pair to the output"""
285
286 if isinstance(value, bool):
287 if value:
288 output.append(' %s: true,' % name)
289 else:
290 output.append(' %s: false,' % name)
291 return
292 if not value:
293 return
294 if isinstance(value, set):
295 value = sorted(value)
296 if isinstance(value, list):
297 output.append(' %s: [' % name)
298 for item in sorted(value) if sort else value:
299 output.append(' "%s",' % item)
300 output.append(' ],')
301 return
302 if isinstance(value, Target):
303 value.to_string(output)
304 return
305 if isinstance(value, dict):
306 kv_output = []
307 for k, v in value.items():
308 write_blueprint_key_value(kv_output, k, v)
309
310 output.append(' %s: {' % name)
311 for line in kv_output:
312 output.append(' %s' % line)
313 output.append(' },')
314 return
315 output.append(' %s: "%s",' % (name, value))
316
317
318class Target(object):
319 """A target-scoped part of a module"""
320
321 def __init__(self, name):
322 self.name = name
323 self.shared_libs = set()
324 self.static_libs = set()
325 self.whole_static_libs = set()
326 self.cflags = set()
327 self.dist = dict()
328 self.strip = dict()
329 self.stl = None
330
331 def to_string(self, output):
332 nested_out = []
333 self._output_field(nested_out, 'shared_libs')
334 self._output_field(nested_out, 'static_libs')
335 self._output_field(nested_out, 'whole_static_libs')
336 self._output_field(nested_out, 'cflags')
337 self._output_field(nested_out, 'stl')
338 self._output_field(nested_out, 'dist')
339 self._output_field(nested_out, 'strip')
340
341 if nested_out:
342 output.append(' %s: {' % self.name)
343 for line in nested_out:
344 output.append(' %s' % line)
345 output.append(' },')
346
347 def _output_field(self, output, name, sort=True):
348 value = getattr(self, name)
349 return write_blueprint_key_value(output, name, value, sort)
350
351
352class Module(object):
353 """A single module (e.g., cc_binary, cc_test) in a blueprint."""
354
355 def __init__(self, mod_type, name, gn_target):
356 self.type = mod_type
357 self.gn_target = gn_target
358 self.name = name
359 self.srcs = set()
360 self.comment = 'GN: ' + gn_utils.label_without_toolchain(gn_target)
361 self.shared_libs = set()
362 self.static_libs = set()
363 self.whole_static_libs = set()
364 self.runtime_libs = set()
365 self.tools = set()
366 self.cmd = None
367 self.host_supported = False
368 self.vendor_available = False
369 self.init_rc = set()
370 self.out = set()
371 self.export_include_dirs = set()
372 self.generated_headers = set()
373 self.export_generated_headers = set()
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800374 self.export_static_lib_headers = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700375 self.defaults = set()
376 self.cflags = set()
377 self.include_dirs = set()
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900378 self.local_include_dirs = []
Patrick Rohr92d74122022-10-21 15:50:52 -0700379 self.header_libs = set()
380 self.required = set()
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700381 self.tool_files = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700382 self.android = Target('android')
383 self.host = Target('host')
Patrick Rohr92d74122022-10-21 15:50:52 -0700384 self.stl = None
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700385 self.cpp_std = None
Patrick Rohr92d74122022-10-21 15:50:52 -0700386 self.dist = dict()
387 self.strip = dict()
388 self.data = set()
389 self.apex_available = set()
390 self.min_sdk_version = None
391 self.proto = dict()
Patrick Rohrd90025f2022-11-11 14:18:35 -0800392 self.linker_scripts = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700393 # The genrule_XXX below are properties that must to be propagated back
394 # on the module(s) that depend on the genrule.
395 self.genrule_headers = set()
396 self.genrule_srcs = set()
397 self.genrule_shared_libs = set()
Patrick Rohra1a27872022-10-31 11:57:14 -0700398 self.genrule_header_libs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700399 self.version_script = None
400 self.test_suites = set()
401 self.test_config = None
402 self.stubs = {}
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000403 self.cppflags = set()
404 self.rtti = False
Patrick Rohr92d74122022-10-21 15:50:52 -0700405
406 def to_string(self, output):
407 if self.comment:
408 output.append('// %s' % self.comment)
409 output.append('%s {' % self.type)
410 self._output_field(output, 'name')
411 self._output_field(output, 'srcs')
412 self._output_field(output, 'shared_libs')
413 self._output_field(output, 'static_libs')
414 self._output_field(output, 'whole_static_libs')
415 self._output_field(output, 'runtime_libs')
416 self._output_field(output, 'tools')
417 self._output_field(output, 'cmd', sort=False)
418 if self.host_supported:
419 self._output_field(output, 'host_supported')
420 if self.vendor_available:
421 self._output_field(output, 'vendor_available')
422 self._output_field(output, 'init_rc')
423 self._output_field(output, 'out')
424 self._output_field(output, 'export_include_dirs')
425 self._output_field(output, 'generated_headers')
426 self._output_field(output, 'export_generated_headers')
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800427 self._output_field(output, 'export_static_lib_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -0700428 self._output_field(output, 'defaults')
429 self._output_field(output, 'cflags')
430 self._output_field(output, 'include_dirs')
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900431 self._output_field(output, 'local_include_dirs', sort=False)
Patrick Rohr92d74122022-10-21 15:50:52 -0700432 self._output_field(output, 'header_libs')
433 self._output_field(output, 'required')
434 self._output_field(output, 'dist')
435 self._output_field(output, 'strip')
436 self._output_field(output, 'tool_files')
437 self._output_field(output, 'data')
438 self._output_field(output, 'stl')
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700439 self._output_field(output, 'cpp_std')
Patrick Rohr92d74122022-10-21 15:50:52 -0700440 self._output_field(output, 'apex_available')
441 self._output_field(output, 'min_sdk_version')
442 self._output_field(output, 'version_script')
443 self._output_field(output, 'test_suites')
444 self._output_field(output, 'test_config')
445 self._output_field(output, 'stubs')
446 self._output_field(output, 'proto')
Patrick Rohrd90025f2022-11-11 14:18:35 -0800447 self._output_field(output, 'linker_scripts')
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000448 self._output_field(output, 'cppflags')
449 if self.rtti:
450 self._output_field(output, 'rtti')
Patrick Rohr92d74122022-10-21 15:50:52 -0700451
452 target_out = []
453 self._output_field(target_out, 'android')
454 self._output_field(target_out, 'host')
455 if target_out:
456 output.append(' target: {')
457 for line in target_out:
458 output.append(' %s' % line)
459 output.append(' },')
460
Patrick Rohr92d74122022-10-21 15:50:52 -0700461 output.append('}')
462 output.append('')
463
464 def add_android_static_lib(self, lib):
465 if self.type == 'cc_binary_host':
466 raise Exception('Adding Android static lib for host tool is unsupported')
467 elif self.host_supported:
468 self.android.static_libs.add(lib)
469 else:
470 self.static_libs.add(lib)
471
472 def add_android_shared_lib(self, lib):
473 if self.type == 'cc_binary_host':
474 raise Exception('Adding Android shared lib for host tool is unsupported')
475 elif self.host_supported:
476 self.android.shared_libs.add(lib)
477 else:
478 self.shared_libs.add(lib)
479
480 def _output_field(self, output, name, sort=True):
481 value = getattr(self, name)
482 return write_blueprint_key_value(output, name, value, sort)
483
484
485class Blueprint(object):
486 """In-memory representation of an Android.bp file."""
487
488 def __init__(self):
489 self.modules = {}
490
491 def add_module(self, module):
492 """Adds a new module to the blueprint, replacing any existing module
493 with the same name.
494
495 Args:
496 module: Module instance.
497 """
498 self.modules[module.name] = module
499
500 def to_string(self, output):
Patrick Rohr23f26192022-10-25 09:45:22 -0700501 for m in sorted(self.modules.values(), key=lambda m: m.name):
Patrick Rohr92d74122022-10-21 15:50:52 -0700502 m.to_string(output)
503
504
505def label_to_module_name(label):
506 """Turn a GN label (e.g., //:perfetto_tests) into a module name."""
507 # If the label is explicibly listed in the default target list, don't prefix
508 # its name and return just the target name. This is so tools like
509 # "traceconv" stay as such in the Android tree.
510 label_without_toolchain = gn_utils.label_without_toolchain(label)
Patrick Rohr92d74122022-10-21 15:50:52 -0700511 module = re.sub(r'^//:?', '', label_without_toolchain)
512 module = re.sub(r'[^a-zA-Z0-9_]', '_', module)
513 if not module.startswith(module_prefix):
514 return module_prefix + module
515 return module
516
517
518def is_supported_source_file(name):
519 """Returns True if |name| can appear in a 'srcs' list."""
Patrick Rohrf9f3a992022-11-10 19:40:32 -0800520 return os.path.splitext(name)[1] in ['.c', '.cc', '.cpp', '.java', '.proto', '.S']
Patrick Rohr92d74122022-10-21 15:50:52 -0700521
522
523def create_proto_modules(blueprint, gn, target):
524 """Generate genrules for a proto GN target.
525
526 GN actions are used to dynamically generate files during the build. The
527 Soong equivalent is a genrule. This function turns a specific kind of
528 genrule which turns .proto files into source and header files into a pair
529 equivalent genrules.
530
531 Args:
532 blueprint: Blueprint instance which is being generated.
533 target: gn_utils.Target object.
534
535 Returns:
536 The source_genrule module.
537 """
538 assert (target.type == 'proto_library')
539
540 tools = {'aprotoc'}
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900541 cpp_out_dir = '$(genDir)/%s/%s/' % (tree_path, target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700542 target_module_name = label_to_module_name(target.name)
543
544 # In GN builds the proto path is always relative to the output directory
545 # (out/tmp.xxx).
Motomu Utsumie8457452022-11-08 18:47:51 +0900546 cmd = ['$(location aprotoc)']
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900547 cmd += ['--proto_path=%s/%s' % (tree_path, target.proto_in_dir)]
Patrick Rohr92d74122022-10-21 15:50:52 -0700548
549 if buildtools_protobuf_src in target.proto_paths:
550 cmd += ['--proto_path=%s' % android_protobuf_src]
551
552 # We don't generate any targets for source_set proto modules because
553 # they will be inlined into other modules if required.
554 if target.proto_plugin == 'source_set':
555 return None
556
557 # Descriptor targets only generate a single target.
558 if target.proto_plugin == 'descriptor':
559 out = '{}.bin'.format(target_module_name)
560
561 cmd += ['--descriptor_set_out=$(out)']
562 cmd += ['$(in)']
563
564 descriptor_module = Module('genrule', target_module_name, target.name)
565 descriptor_module.cmd = ' '.join(cmd)
566 descriptor_module.out = [out]
567 descriptor_module.tools = tools
568 blueprint.add_module(descriptor_module)
569
570 # Recursively extract the .proto files of all the dependencies and
571 # add them to srcs.
572 descriptor_module.srcs.update(
573 gn_utils.label_to_path(src) for src in target.sources)
574 for dep in target.transitive_proto_deps:
575 current_target = gn.get_target(dep)
576 descriptor_module.srcs.update(
577 gn_utils.label_to_path(src) for src in current_target.sources)
578
579 return descriptor_module
580
581 # We create two genrules for each proto target: one for the headers and
582 # another for the sources. This is because the module that depends on the
583 # generated files needs to declare two different types of dependencies --
584 # source files in 'srcs' and headers in 'generated_headers' -- and it's not
585 # valid to generate .h files from a source dependency and vice versa.
586 source_module_name = target_module_name + '_gen'
587 source_module = Module('genrule', source_module_name, target.name)
588 blueprint.add_module(source_module)
589 source_module.srcs.update(
590 gn_utils.label_to_path(src) for src in target.sources)
591
592 header_module = Module('genrule', source_module_name + '_headers',
593 target.name)
594 blueprint.add_module(header_module)
595 header_module.srcs = set(source_module.srcs)
596
597 # TODO(primiano): at some point we should remove this. This was introduced
598 # by aosp/1108421 when adding "protos/" to .proto include paths, in order to
599 # avoid doing multi-repo changes and allow old clients in the android tree
600 # to still do the old #include "perfetto/..." rather than
601 # #include "protos/perfetto/...".
602 header_module.export_include_dirs = {'.', 'protos'}
Patrick Rohr2267a0a2022-11-08 18:59:34 -0800603 # Since the .cc file and .h get created by a different gerule target, they
604 # are not put in the same intermediate path, so local includes do not work
605 # without explictily exporting the include dir.
606 header_module.export_include_dirs.add(target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700607
608 source_module.genrule_srcs.add(':' + source_module.name)
609 source_module.genrule_headers.add(header_module.name)
610
611 if target.proto_plugin == 'proto':
612 suffixes = ['pb']
613 source_module.genrule_shared_libs.add('libprotobuf-cpp-lite')
614 cmd += ['--cpp_out=lite=true:' + cpp_out_dir]
615 elif target.proto_plugin == 'protozero':
616 suffixes = ['pbzero']
617 plugin = create_modules_from_target(blueprint, gn, protozero_plugin)
618 tools.add(plugin.name)
619 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
620 cmd += ['--plugin_out=wrapper_namespace=pbzero:' + cpp_out_dir]
621 elif target.proto_plugin == 'cppgen':
622 suffixes = ['gen']
623 plugin = create_modules_from_target(blueprint, gn, cppgen_plugin)
624 tools.add(plugin.name)
625 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
626 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
627 elif target.proto_plugin == 'ipc':
628 suffixes = ['ipc']
629 plugin = create_modules_from_target(blueprint, gn, ipc_plugin)
630 tools.add(plugin.name)
631 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
632 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
633 else:
634 raise Error('Unsupported proto plugin: %s' % target.proto_plugin)
635
636 cmd += ['$(in)']
637 source_module.cmd = ' '.join(cmd)
638 header_module.cmd = source_module.cmd
639 source_module.tools = tools
640 header_module.tools = tools
641
642 for sfx in suffixes:
643 source_module.out.update('%s/%s' %
644 (tree_path, src.replace('.proto', '.%s.cc' % sfx))
645 for src in source_module.srcs)
646 header_module.out.update('%s/%s' %
647 (tree_path, src.replace('.proto', '.%s.h' % sfx))
648 for src in header_module.srcs)
649 return source_module
650
651
652def create_amalgamated_sql_metrics_module(blueprint, target):
653 bp_module_name = label_to_module_name(target.name)
654 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700655 module.tool_files.add('tools/gen_amalgamated_sql_metrics.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700656 module.cmd = ' '.join([
657 '$(location tools/gen_amalgamated_sql_metrics.py)',
658 '--cpp_out=$(out)',
659 '$(in)',
660 ])
661 module.genrule_headers.add(module.name)
662 module.out.update(target.outputs)
663 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
664 blueprint.add_module(module)
665 return module
666
667
668def create_cc_proto_descriptor_module(blueprint, target):
669 bp_module_name = label_to_module_name(target.name)
670 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700671 module.tool_files.add('tools/gen_cc_proto_descriptor.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700672 module.cmd = ' '.join([
673 '$(location tools/gen_cc_proto_descriptor.py)', '--gen_dir=$(genDir)',
674 '--cpp_out=$(out)', '$(in)'
675 ])
676 module.genrule_headers.add(module.name)
677 module.srcs.update(
678 ':' + label_to_module_name(dep) for dep in target.proto_deps)
679 module.srcs.update(
680 gn_utils.label_to_path(src)
681 for src in target.inputs
682 if "tmp.gn_utils" not in src)
683 module.out.update(target.outputs)
684 blueprint.add_module(module)
685 return module
686
687
688def create_gen_version_module(blueprint, target, bp_module_name):
689 module = Module('genrule', bp_module_name, gn_utils.GEN_VERSION_TARGET)
690 script_path = gn_utils.label_to_path(target.script)
691 module.genrule_headers.add(bp_module_name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700692 module.tool_files.add(script_path)
Patrick Rohr92d74122022-10-21 15:50:52 -0700693 module.out.update(target.outputs)
694 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
695 module.cmd = ' '.join([
696 'python3 $(location %s)' % script_path, '--no_git',
697 '--changelog=$(location CHANGELOG)', '--cpp_out=$(out)'
698 ])
699 blueprint.add_module(module)
700 return module
701
702
703def create_proto_group_modules(blueprint, gn, module_name, target_names):
704 # TODO(lalitm): today, we're only adding a Java lite module because that's
705 # the only one used in practice. In the future, if we need other target types
706 # (e.g. C++, Java full etc.) add them here.
707 bp_module_name = label_to_module_name(module_name) + '_java_protos'
708 module = Module('java_library', bp_module_name, bp_module_name)
709 module.comment = f'''GN: [{', '.join(target_names)}]'''
710 module.proto = {'type': 'lite', 'canonical_path_from_root': False}
711
712 for name in target_names:
713 target = gn.get_target(name)
714 module.srcs.update(gn_utils.label_to_path(src) for src in target.sources)
715 for dep_label in target.transitive_proto_deps:
716 dep = gn.get_target(dep_label)
717 module.srcs.update(gn_utils.label_to_path(src) for src in dep.sources)
718
719 blueprint.add_module(module)
720
Motomu Utsumia6c33152022-11-02 18:21:55 +0900721# HACK: Need to support build_cofig_gen flexibly instead of hardcoding
722# build_config_gen generates srcjar by executing gcc via gcc_preprocess.py but gcc is not
723# available in genrule sandbox. Also gcc path is not configurable.
724# Under the //net:net, gcc_preprocess.py is only used for build_config_gen.
725# So, for now, hardcoding BuildConfig.java and generates srcjar by soong_zip.
726def override_build_config_gen(module):
727 module.tool_files.clear()
728 module.tools.add("soong_zip")
729 cmd = [
730 "echo",
731 "\\\"package org.chromium.build;\\n",
732 "public class BuildConfig {\\n",
733 "public static boolean IS_MULTIDEX_ENABLED ;\\n",
734 "public static boolean ENABLE_ASSERTS = true;\\n",
735 "public static boolean IS_UBSAN ;\\n",
736 "public static boolean IS_CHROME_BRANDED ;\\n",
737 "public static int R_STRING_PRODUCT_VERSION ;\\n",
738 "public static int MIN_SDK_VERSION = 1;\\n",
739 "public static boolean BUNDLES_SUPPORTED ;\\n",
740 "public static boolean IS_INCREMENTAL_INSTALL ;\\n",
741 "public static boolean ISOLATED_SPLITS_ENABLED ;\\n",
742 "public static boolean IS_FOR_TEST ;\\n",
743 "}\\n\\\"",
744 "> $(genDir)/BuildConfig.java &&",
745 "$(location soong_zip) -o $(out) -srcjar -f $(genDir)/BuildConfig.java"
746 ]
747 NEWLINE = ' " +\n "'
748 module.cmd = NEWLINE.join(cmd)
749 return module
750
Mohannad Farragbab6c892022-11-02 14:09:46 +0000751def create_action_foreach_modules(blueprint, target):
752 """ The following assumes that rebase_path exists in the args.
753 The args of an action_foreach contains hints about which output files are generated
754 by which source files.
755 This is copied directly from the args
756 "gen/net/base/registry_controlled_domains/{{source_name_part}}-reversed-inc.cc"
757 So each source file will generate an output whose name is the {source_name-reversed-inc.cc}
758 """
759 new_args = []
Motomu Utsumi56afcac2022-11-04 12:58:30 +0900760 for i, src in enumerate(sorted(target.sources)):
Mohannad Farragbab6c892022-11-02 14:09:46 +0000761 # don't add script arg for the first source -- create_action_module
762 # already does this.
763 if i != 0:
764 new_args.append('&& python3 $(location %s)' %
765 gn_utils.label_to_path(target.script))
766 for arg in target.args:
767 if '{{source}}' in arg:
768 new_args.append('$(location %s)' % (gn_utils.label_to_path(src)))
769 elif '{{source_name_part}}' in arg:
770 source_name_part = src.split("/")[-1] # Get the file name only
771 source_name_part = source_name_part.split(".")[0] # Remove the extension (Ex: .cc)
772 file_name = arg.replace('{{source_name_part}}', source_name_part).split("/")[-1]
773 # file_name represent the output file name. But we need the whole path
774 # This can be found from target.outputs.
775 for out in target.outputs:
776 if out.endswith(file_name):
777 new_args.append('$(location %s)' % out)
778 else:
779 new_args.append(arg)
780
781 target.args = new_args
782 return create_action_module(blueprint, target)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900783
Patrick Rohr7be99032022-10-31 11:54:19 -0700784def create_action_module(blueprint, target):
785 bp_module_name = label_to_module_name(target.name)
786 module = Module('genrule', bp_module_name, target.name)
787
Patrick Rohr9b99a982022-10-28 11:00:57 -0700788 # Convert ['--param=value'] to ['--param', 'value'] for consistency.
789 # TODO: we may want to only do this for python scripts arguments. If argparse
790 # is used, this transformation is safe.
791 target.args = [str for it in target.args for str in it.split('=')]
792
Motomu Utsumibf569d42022-10-28 16:47:34 +0900793 if target.script == "//build/write_buildflag_header.py":
794 # write_buildflag_header.py writes result to args.genDir/args.output
795 # So, override args.genDir by '.' so that args.output=$(out) works
Patrick Rohrde568a22022-10-28 09:22:35 -0700796 for i, val in enumerate(target.args):
797 if val == '--gen-dir':
798 target.args[i + 1] = '.'
Patrick Rohrfa972402022-11-01 11:54:35 -0700799 elif val == '--output':
800 target.args[i + 1] = '$(out)'
801
802 elif target.script == '//build/write_build_date_header.py':
803 target.args[0] = '$(out)'
Patrick Rohr0db9f852022-10-27 13:49:57 -0700804
Patrick Rohr8acccca2022-10-28 10:39:06 -0700805 elif target.script == '//base/android/jni_generator/jni_generator.py':
Patrick Rohrc5cc21a2022-10-31 11:57:49 -0700806 # chromium builds against a prebuilt ndk that contains the jni_headers, so
807 # a dependency is never explicitly created.
808 module.genrule_header_libs.add('jni_headers')
Patrick Rohr131ba282022-10-31 16:36:20 -0700809 needs_javap = False
Patrick Rohr8acccca2022-10-28 10:39:06 -0700810 for i, val in enumerate(target.args):
Motomu Utsumi6f9139d2022-10-31 12:15:19 +0900811 if val == '--output_dir':
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700812 # replace --output_dir gen/jni_headers/... with --output_dir $(genDir)/...
813 target.args[i + 1] = re.sub('^gen/jni_headers', '$(genDir)', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700814 elif val == '--input_file':
Patrick Rohr8acccca2022-10-28 10:39:06 -0700815 # --input_file supports both .class specifiers or source files as arguments.
816 # Only source files need to be wrapped inside a $(location <label>) tag.
817 if re.match('.*\.class$', target.args[i + 1]):
818 continue
819 # replace --input_file ../../... with --input_file $(location ...)
820 # TODO: put inside function
821 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
822 target.args[i + 1] = '$(location %s)' % filename
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700823 elif val == '--includes' and 'jni_generator_helper' in target.args[i + 1]:
Patrick Rohrd89e8bf2022-10-31 14:51:05 -0700824 # delete all leading ../
825 target.args[i + 1] = re.sub('^(\.\./)+', '', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700826 elif val == '--prev_output_dir':
Patrick Rohr131ba282022-10-31 16:36:20 -0700827 # this is not needed for aosp builds.
828 target.args[i] = ''
829 target.args[i + 1] = ''
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700830 elif val == '--jar_file':
Patrick Rohr131ba282022-10-31 16:36:20 -0700831 # delete leading ../../ and add path to javap
832 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
833 target.args[i + 1] = '$(location %s)' % filename
834 needs_javap = True
835
836 if needs_javap:
837 target.args.append('--javap')
838 target.args.append('$$(find out/.path -name javap)')
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700839 # fix target.output directory to match #include statements.
840 target.outputs = [re.sub('^jni_headers/', '', out) for out in target.outputs]
Patrick Rohr8acccca2022-10-28 10:39:06 -0700841
Patrick Rohrf6d2b612022-11-09 12:30:26 -0800842 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
843 # jni_registration_generator.py pulls in some config dependencies that we
844 # do not handle. Remove them.
845 # TODO: find a better way to do this.
846 target.deps.clear()
847
Motomu Utsumied009082022-11-10 16:26:44 +0900848 target.inputs = [file for file in target.inputs if not file.startswith('//out/')]
Motomu Utsumi6b4acaa2022-11-10 16:13:24 +0900849 for i, val in enumerate(target.args):
850 if val in ['--depfile', '--srcjar-path', '--header-path']:
851 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900852 if val == '--sources-files':
853 target.args[i + 1] = '$(genDir)/java.sources'
Motomu Utsumi47d122f2022-11-10 17:32:23 +0900854 elif val == '--sources-exclusions':
855 # update_jni_registration_module removes them from the srcs of the module
856 # It might be better to remove sources by '--sources-exclusions'
857 target.args[i] = ''
858 target.args[i + 1] = ''
Motomu Utsumi6b4acaa2022-11-10 16:13:24 +0900859
Patrick Rohr245df582022-11-01 16:59:45 -0700860 elif target.script == '//build/android/gyp/write_build_config.py':
861 for i, val in enumerate(target.args):
862 if val == '--depfile':
863 # Depfile is not used, so no need to generate it.
864 target.args[i] = ''
865 target.args[i + 1] = ''
866 elif val in ['--deps-configs', '--bundled-srcjars']:
867 args = target.args[i + 1]
868 if args == '[]':
869 continue
870 # strip surrounding [] and split by ", "
871 args = args.strip('[]').split(', ')
872 # strip surrounding ""
873 args = [arg.strip('"') for arg in args]
874 # remove leading gen/
875 args = [re.sub('^gen/', '', arg) for arg in args]
876 # wrap filename in \"$(location filename)\"
877 args = ['\"$(location %s)\"' % arg for arg in args]
878 # join args with ", " and wrap in []
879 target.args[i + 1] = '[%s]' % ', '.join(args)
880
881 elif val == '--public-deps-configs':
882 # TODO: implement.
883 pass
884
885 elif val == '--build-config':
886 # json output of this script
887 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
888
889 elif val in ['--unprocessed-jar-path', '--interface-jar-path',
890 '--device-jar-path', '--host-jar-path']:
891 # jar path can be within sources (../../) or output generated by
892 # another genrule (obj/)
893 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
894 filename = re.sub('^obj/', '', target.args[i + 1])
895 target.args[i + 1] = '$(location %s)' % filename
896
897 elif val == '--proguard-configs':
898 args = target.args[i + 1]
899 if args == '[]':
900 continue
901 # TODO: consider adding helpers to deal with argument lists
902 # strip surrounding [] and split by ", ", then strip surrounding ""
903 args = args.strip('[]').split(', ')
904 args = [arg.strip('"') for arg in args]
905 # remove leading ../../
906 args = [re.sub('^\.\./\.\./', '', arg) for arg in args]
907 # add dependency on proguard config file, so a $(location) wrapper can be used.
908 module.tool_files.update(args)
909 # wrap filename in \"$(location filename)\"
910 args = ['$(location %s)' % arg for arg in args]
911 target.args[i + 1] = '[%s]' % ', '.join(args)
Motomu Utsumi1caa39b2022-11-02 18:38:13 +0900912 elif target.script == "//build/android/gyp/write_native_libraries_java.py":
913 for i, val in enumerate(target.args):
914 if val == '--output':
915 target.args[i + 1] = '$(out)'
Motomu Utsumi26211dc2022-11-02 19:38:47 +0900916 elif target.script == "//tools/grit/stamp_grit_sources.py":
917 target.outputs = [re.sub('^\/\/', '', out) for out in target.outputs]
918 # Directory that contains grit scripts
919 target.args[0] = '`dirname $(location tools/grit/grit.py)`'
920 # Path to the stamp file
921 target.args[1] = '$(out)'
922 # Script tries to create args[2] file but this is not in the output.
923 # Specifying file under $(genDir) so that parent directory exists.
924 # If this file is used by other module, we may need to add this file to the outputs.
925 target.args[2] = '$(genDir)/' + target.args[2].split('/')[-1]
Mohannad Farrag033c9d62022-11-07 14:55:49 +0000926 elif target.script == "//tools/grit/grit.py":
927 for i, val in enumerate(target.args):
928 if val == '-i':
929 # Delete leading ../..
930 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
931 target.args[i + 1] = '$(location %s)' % filename
932 elif val == '-o':
933 filename = re.sub('^gen/', '', target.args[i + 1])
934 if filename == "net":
935 # This is a directory not a file
936 target.args[i + 1] = '$(genDir)/net'
937 else:
938 # This is an output fil
939 target.args[i + 1] = '$(location %s)' % filename
940 elif val == '--depfile':
941 # The depfile is replaced by adding /tools/**/*.py to the tools_files
942 # This is basically just globbing all the needed sources by hardcoding.
943 module.tool_files.update([
944 "tools/grit/**/*.py",
945 "third_party/six/src/six.py" # This is not picked up by default. Must be added
946 ])
947
948 # Delete the depfile argument
949 target.args[i] = ' '
950 target.args[i + 1] = ' '
951 elif val == '--input':
952 # Delete leading ../..
953 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
954 # This is an output file so use $(location %s)
955 target.args[i + 1] = '$(location %s)' % filename
Motomu Utsumia0cc6662022-11-09 15:22:27 +0900956 elif target.script == "//net/tools/dafsa/make_dafsa.py":
957 # This script generates .cc files but source (registry_controlled_domain.cc) in the target that
958 # depends on this target includes .cc file this script generates.
959 module.genrule_headers.add(module.name)
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900960 elif target.script == "//build/util/version.py":
Motomu Utsumib0a49e42022-11-09 18:12:27 +0900961 # android_chrome_version.py is not specified in anywhere but version.py imports this file
962 module.tool_files.add('build/util/android_chrome_version.py')
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900963 for i, val in enumerate(target.args):
964 if val.startswith('../../'):
965 filename = re.sub('^\.\./\.\./', '', val)
966 target.args[i] = '$(location %s)' % filename
Motomu Utsumiee279c52022-11-09 17:46:27 +0900967 elif val == '-e':
968 # arg for -e EVAL option should be passed in -e PATCH_HI=int(PATCH)//256 format.
969 target.args[i + 1] = '%s=\'%s\'' % (target.args[i + 1], target.args[i + 2])
970 target.args[i + 2] = ''
Motomu Utsumi438f2c22022-11-09 18:16:40 +0900971 elif val == '-o':
972 target.args[i + 1] = '$(out)'
Patrick Rohr245df582022-11-01 16:59:45 -0700973
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700974 script = gn_utils.label_to_path(target.script)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700975 module.tool_files.add(script)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700976
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700977 # Handle passing parameters via response file by piping them into the script
978 # and reading them from /dev/stdin.
979 response_file = '{{response_file_name}}'
980 use_response_file = response_file in target.args
981 if use_response_file:
982 # Replace {{response_file_contents}} with /dev/stdin
983 target.args = ['/dev/stdin' if it == response_file else it for it in target.args]
984
Patrick Rohr4b0952d2022-11-01 12:42:31 -0700985 # escape " and \$ in target.args.
986 # once all actions are properly implemented, this may not be necessary anymore.
987 # TODO: is this the right place to do this?
988 target.args = [arg.replace('"', r'\"') for arg in target.args]
989 target.args = [arg.replace(r'\$', r'\\$') for arg in target.args]
990
Patrick Rohr9b99a982022-10-28 11:00:57 -0700991 # put all args on a new line for better diffs.
992 NEWLINE = ' " +\n "'
993 arg_string = NEWLINE.join(target.args)
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700994 module.cmd = '$(location %s) %s' % (script, arg_string)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700995
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700996 if use_response_file:
997 # Pipe response file contents into script
Patrick Rohr9b99a982022-10-28 11:00:57 -0700998 module.cmd = 'echo \'%s\' |%s%s' % (target.response_file_contents, NEWLINE, module.cmd)
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700999
Motomu Utsumi7e983832022-11-10 16:04:46 +09001000 if any(os.path.splitext(it)[1] == '.h' for it in target.outputs):
Patrick Rohr67f4d432022-10-26 16:04:15 -07001001 module.genrule_headers.add(bp_module_name)
Patrick Rohre1a853e2022-10-26 12:31:39 -07001002
Patrick Rohr0db9f852022-10-27 13:49:57 -07001003 # gn treats inputs and sources for actions equally.
1004 # soong only supports source files inside srcs, non-source files are added as
1005 # tool_files dependency.
1006 for it in target.sources or target.inputs:
1007 if is_supported_source_file(it):
1008 module.srcs.add(gn_utils.label_to_path(it))
1009 else:
1010 module.tool_files.add(gn_utils.label_to_path(it))
Patrick Rohre1a853e2022-10-26 12:31:39 -07001011
Patrick Rohr15a2c302022-10-26 15:08:57 -07001012 # Actions using template "action_with_pydeps" also put script inside inputs.
1013 # TODO: it might make sense to filter inputs inside GnParser.
1014 if script in module.srcs:
1015 module.srcs.remove(script)
1016
Patrick Rohre1a853e2022-10-26 12:31:39 -07001017 module.out.update(target.outputs)
Motomu Utsumia6c33152022-11-02 18:21:55 +09001018
1019 if target.name == "//build/android:build_config_gen":
1020 module = override_build_config_gen(module)
Motomu Utsumi26211dc2022-11-02 19:38:47 +09001021 elif target.script == "//tools/grit/stamp_grit_sources.py":
1022 # stamp_grit_sources.py is not executable
1023 module.cmd = "python " + module.cmd
Mohannad Farrag18d7b512022-11-07 13:26:30 +00001024 elif target.script == "//base/android/jni_generator/jni_generator.py":
1025 # android_jar.classes should be part of the tools as it list implicit classes
1026 # for the script to generate JNI headers.
1027 module.tool_files.add("base/android/jni_generator/android_jar.classes")
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +09001028 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
Motomu Utsumi9ca466b2022-11-10 17:12:29 +09001029 # jni_registration_generator.py doesn't work with python2
1030 module.cmd = "python3 " + module.cmd
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +09001031 # Path in the original sources file does not work in genrule.
1032 # So creating sources file in cmd based on the srcs of this target.
1033 # Adding ../$(current_dir)/ to the head because jni_registration_generator.py uses the files
1034 # whose path startswith(..)
1035 commands = ["current_dir=`basename \\\`pwd\\\``;",
1036 "for f in $(in);",
1037 "do",
1038 "echo \\\"../$$current_dir/$$f\\\" >> $(genDir)/java.sources;",
1039 "done;",
1040 module.cmd]
Motomu Utsumi2a892d22022-11-10 18:03:20 +09001041
1042 # .h file jni_registration_generator.py generates has #define with directory name.
1043 # With the genrule env that contains "." which is invalid. So replace that at the end of cmd.
Mohannad Farrag7c0f0982022-11-10 14:39:49 +00001044 commands.append(";sed -i -e 's/OUT_SOONG_.TEMP_SBOX_.*_OUT/GEN/g' ")
Motomu Utsumi2a892d22022-11-10 18:03:20 +09001045 commands.append("$(genDir)/components/cronet/android/cronet_jni_registration.h")
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +09001046 module.cmd = NEWLINE.join(commands)
Motomu Utsumia6c33152022-11-02 18:21:55 +09001047
Patrick Rohre1a853e2022-10-26 12:31:39 -07001048 blueprint.add_module(module)
1049 return module
1050
1051
Patrick Rohr92d74122022-10-21 15:50:52 -07001052
1053def _get_cflags(target):
1054 cflags = {flag for flag in target.cflags if re.match(cflag_allowlist, flag)}
Motomu Utsumifa7e9262022-10-26 19:43:02 +09001055 # Consider proper allowlist or denylist if needed
1056 cflags |= set("-D%s" % define.replace("\"", "\\\"") for define in target.defines)
Patrick Rohr92d74122022-10-21 15:50:52 -07001057 return cflags
1058
1059
1060def create_modules_from_target(blueprint, gn, gn_target_name):
1061 """Generate module(s) for a given GN target.
1062
1063 Given a GN target name, generate one or more corresponding modules into a
1064 blueprint. The only case when this generates >1 module is proto libraries.
1065
1066 Args:
1067 blueprint: Blueprint instance which is being generated.
1068 gn: gn_utils.GnParser object.
1069 gn_target_name: GN target for module generation.
1070 """
1071 bp_module_name = label_to_module_name(gn_target_name)
1072 if bp_module_name in blueprint.modules:
1073 return blueprint.modules[bp_module_name]
1074 target = gn.get_target(gn_target_name)
Patrick Rohr16228942022-10-26 14:00:26 -07001075 log.info('create modules for %s (%s)', target.name, target.type)
Patrick Rohr92d74122022-10-21 15:50:52 -07001076
1077 name_without_toolchain = gn_utils.label_without_toolchain(target.name)
1078 if target.type == 'executable':
1079 if target.toolchain == gn_utils.HOST_TOOLCHAIN:
1080 module_type = 'cc_binary_host'
1081 elif target.testonly:
1082 module_type = 'cc_test'
1083 else:
1084 module_type = 'cc_binary'
1085 module = Module(module_type, bp_module_name, gn_target_name)
1086 elif target.type == 'static_library':
1087 module = Module('cc_library_static', bp_module_name, gn_target_name)
1088 elif target.type == 'shared_library':
1089 module = Module('cc_library_shared', bp_module_name, gn_target_name)
1090 elif target.type == 'source_set':
1091 module = Module('filegroup', bp_module_name, gn_target_name)
1092 elif target.type == 'group':
1093 # "group" targets are resolved recursively by gn_utils.get_target().
1094 # There's nothing we need to do at this level for them.
1095 return None
1096 elif target.type == 'proto_library':
1097 module = create_proto_modules(blueprint, gn, target)
1098 if module is None:
1099 return None
1100 elif target.type == 'action':
1101 if 'gen_amalgamated_sql_metrics' in target.name:
1102 module = create_amalgamated_sql_metrics_module(blueprint, target)
1103 elif re.match('.*gen_cc_.*_descriptor$', name_without_toolchain):
1104 module = create_cc_proto_descriptor_module(blueprint, target)
1105 elif target.type == 'action' and \
1106 name_without_toolchain == gn_utils.GEN_VERSION_TARGET:
1107 module = create_gen_version_module(blueprint, target, bp_module_name)
1108 else:
Patrick Rohre1a853e2022-10-26 12:31:39 -07001109 module = create_action_module(blueprint, target)
Mohannad Farragf076f3e2022-10-31 17:45:28 +00001110 elif target.type == 'action_foreach':
Mohannad Farragbab6c892022-11-02 14:09:46 +00001111 module = create_action_foreach_modules(blueprint, target)
Patrick Rohr59a76652022-10-26 12:36:56 -07001112 elif target.type == 'copy':
1113 # TODO: careful now! copy targets are not supported yet, but this will stop
1114 # traversing the dependency tree. For //base:base, this is not a big
1115 # problem as libicu contains the only copy target which happens to be a
1116 # leaf node.
1117 return None
Patrick Rohrad440602022-11-10 22:09:04 -08001118 elif target.type == 'java_group':
1119 # Java targets are handled outside of create_modules_from_target.
1120 return None
Patrick Rohr92d74122022-10-21 15:50:52 -07001121 else:
1122 raise Error('Unknown target %s (%s)' % (target.name, target.type))
1123
1124 blueprint.add_module(module)
1125 module.host_supported = (name_without_toolchain in target_host_supported)
Patrick Rohr92d74122022-10-21 15:50:52 -07001126 module.init_rc = target_initrc.get(target.name, [])
1127 module.srcs.update(
1128 gn_utils.label_to_path(src)
1129 for src in target.sources
Motomu Utsumif951e502022-11-07 19:31:15 +09001130 if is_supported_source_file(src) and not src.startswith("//out/test"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001131
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001132 local_include_dirs_set = set()
Patrick Rohr92d74122022-10-21 15:50:52 -07001133 if target.type in gn_utils.LINKER_UNIT_TYPES:
1134 module.cflags.update(_get_cflags(target))
Patrick Rohrf22e9d02022-10-28 14:20:46 -07001135 # TODO: implement proper cflag parsing.
1136 for flag in target.cflags:
Patrick Rohrb8f830a2022-10-31 11:18:57 -07001137 if '-std=' in flag:
1138 module.cpp_std = flag[len('-std='):]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001139 if '-isystem' in flag:
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001140 local_include_dirs_set.add(flag[len('-isystem../../'):])
Patrick Rohr5fae90f2022-11-11 08:22:52 -08001141 if '-frtti' in flag:
1142 module.rtti = True
Patrick Rohr0948d1c2022-11-11 11:02:16 -08001143 if '-fexceptions' in flag:
1144 module.cppflags.add('-fexceptions')
1145
Patrick Rohrb8f830a2022-10-31 11:18:57 -07001146
Patrick Rohrd0abc2a2022-10-31 13:29:16 -07001147 # Adding local_include_dirs is necessary due to source_sets / filegroups
1148 # which do not properly propagate include directories.
1149 # Filter any directory inside //out as a) this directory does not exist for
1150 # aosp / soong builds and b) the include directory should already be
1151 # configured via library dependency.
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001152 local_include_dirs_set.update([gn_utils.label_to_path(d)
Patrick Rohrd0abc2a2022-10-31 13:29:16 -07001153 for d in target.include_dirs
1154 if not re.match('^//out/.*', d)])
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001155 module.local_include_dirs = sorted(list(local_include_dirs_set))
1156
1157 # Order matters for some targets. For example, base/time/time_exploded_icu.cc
1158 # in //base:base needs to have sysroot include after icu/source/common
1159 # include. So adding sysroot include at the end.
1160 for flag in target.cflags:
1161 if '--sysroot' in flag:
1162 module.local_include_dirs.append(flag[len('--sysroot=../../'):] + "/usr/include")
Patrick Rohr92d74122022-10-21 15:50:52 -07001163
1164 module_is_compiled = module.type not in ('genrule', 'filegroup')
1165 if module_is_compiled:
1166 # Don't try to inject library/source dependencies into genrules or
1167 # filegroups because they are not compiled in the traditional sense.
1168 module.defaults = [defaults_module]
1169 for lib in target.libs:
1170 # Generally library names should be mangled as 'libXXX', unless they
1171 # are HAL libraries (e.g., android.hardware.health@2.0) or AIDL c++ / NDK
1172 # libraries (e.g. "android.hardware.power.stats-V1-cpp")
1173 android_lib = lib if '@' in lib or "-cpp" in lib or "-ndk" in lib \
1174 else 'lib' + lib
1175 if lib in shared_library_allowlist:
1176 module.add_android_shared_lib(android_lib)
1177 if lib in static_library_allowlist:
1178 module.add_android_static_lib(android_lib)
1179
Patrick Rohrd9dd3b92022-11-09 16:15:30 -08001180 # Remove prohibited include directories
1181 module.local_include_dirs = [d for d in module.local_include_dirs
1182 if d not in local_include_dirs_denylist]
1183
1184
Patrick Rohr92d74122022-10-21 15:50:52 -07001185 # If the module is a static library, export all the generated headers.
1186 if module.type == 'cc_library_static':
1187 module.export_generated_headers = module.generated_headers
1188
Patrick Rohr92d74122022-10-21 15:50:52 -07001189 # dep_name is an unmangled GN target name (e.g. //foo:bar(toolchain)).
Motomu Utsumif1daa232022-11-08 13:28:37 +09001190 # Currently, only one module is generated from target even target has multiple toolchains.
1191 # And module is generated based on the first visited target.
1192 # Sort deps before iteration to make result deterministic.
1193 all_deps = sorted(target.deps | target.source_set_deps | target.transitive_proto_deps)
Patrick Rohr92d74122022-10-21 15:50:52 -07001194 for dep_name in all_deps:
Patrick Rohr5cc46e02022-10-26 14:32:45 -07001195 # |builtin_deps| override GN deps with Android-specific ones. See the
1196 # config in the top of this file.
1197 if gn_utils.label_without_toolchain(dep_name) in builtin_deps:
1198 builtin_deps[gn_utils.label_without_toolchain(dep_name)](module)
1199 continue
1200
Patrick Rohr92d74122022-10-21 15:50:52 -07001201 dep_module = create_modules_from_target(blueprint, gn, dep_name)
1202
Motomu Utsumie246feb2022-11-01 17:25:56 +09001203 # TODO: Proper dependency check for genrule.
1204 # Currently, only propagating genrule dependencies.
1205 # Also, currently, all the dependencies are propagated upwards.
1206 # in gn, public_deps should be propagated but deps should not.
1207 # Not sure this information is available in the desc.json.
1208 # Following rule works for adding android_runtime_jni_headers to base:base.
1209 # If this doesn't work for other target, hardcoding for specific target
1210 # might be better.
1211 if module.type == "genrule" and dep_module.type == "genrule":
1212 module.genrule_headers.add(dep_module.name)
1213 module.genrule_headers.update(dep_module.genrule_headers)
1214
Patrick Rohr92d74122022-10-21 15:50:52 -07001215 # For filegroups and genrule, recurse but don't apply the deps.
1216 if not module_is_compiled:
1217 continue
1218
Patrick Rohr92d74122022-10-21 15:50:52 -07001219 if dep_module is None:
1220 continue
1221 if dep_module.type == 'cc_library_shared':
1222 module.shared_libs.add(dep_module.name)
1223 elif dep_module.type == 'cc_library_static':
1224 module.static_libs.add(dep_module.name)
1225 elif dep_module.type == 'filegroup':
1226 module.srcs.add(':' + dep_module.name)
1227 elif dep_module.type == 'genrule':
1228 module.generated_headers.update(dep_module.genrule_headers)
1229 module.srcs.update(dep_module.genrule_srcs)
1230 module.shared_libs.update(dep_module.genrule_shared_libs)
Patrick Rohra1a27872022-10-31 11:57:14 -07001231 module.header_libs.update(dep_module.genrule_header_libs)
Patrick Rohr92d74122022-10-21 15:50:52 -07001232 elif dep_module.type == 'cc_binary':
1233 continue # Ignore executables deps (used by cmdline integration tests).
1234 else:
1235 raise Error('Unknown dep %s (%s) for target %s' %
1236 (dep_module.name, dep_module.type, module.name))
1237
1238 return module
1239
Patrick Rohrb18aca22022-11-04 15:07:32 -07001240def create_java_module(blueprint, gn):
1241 bp_module_name = module_prefix + 'java'
1242 module = Module('java_library', bp_module_name, '//gn:java')
Mohannad Farrag21562d62022-11-07 13:09:31 +00001243 module.srcs.update([gn_utils.label_to_path(source) for source in gn.java_sources])
Patrick Rohrb18aca22022-11-04 15:07:32 -07001244 blueprint.add_module(module)
Patrick Rohr92d74122022-10-21 15:50:52 -07001245
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001246def update_jni_registration_module(blueprint, gn):
1247 bp_module_name = label_to_module_name('//components/cronet/android:cronet_jni_registration')
Patrick Rohr7f225422022-11-10 21:38:38 -08001248 if bp_module_name not in blueprint.modules:
1249 # To support building targets that might not create the cronet_jni_registration.
1250 return
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001251 module = blueprint.modules[bp_module_name]
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001252
1253 # TODO: deny list is in the arg of jni_registration_generator.py. Should not be hardcoded
1254 deny_list = [
1255 '//base/android/java/src/org/chromium/base/library_loader/LibraryLoader.java',
1256 '//base/android/java/src/org/chromium/base/library_loader/LibraryPrefetcher.java',
1257 '//base/android/java/src/org/chromium/base/process_launcher/ChildProcessService.java',
1258 '//base/android/java/src/org/chromium/base/SysUtils.java']
1259
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001260 # TODO: java_sources might not contain all the required java files
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001261 module.srcs.update([gn_utils.label_to_path(source)
1262 for source in gn.java_sources if source not in deny_list])
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001263
Motomu Utsumi79bd0c82022-11-10 17:52:24 +09001264 # TODO: Remove hardcoded file addition to srcs
1265 # jni_registration_generator.py generates empty .h file if native methods are not found in the
1266 # java files. But android:cronet depends on `RegisterNonMainDexNatives` which is in the template
1267 # of .h file. To make script generate non empty .h file, adding java file which contains native
1268 # method. Once all the required java files are added to the srcs, this can be removed.
1269 module.srcs.update([
1270 "components/cronet/android/java/src/org/chromium/net/impl/CronetUrlRequest.java"])
1271
Patrick Rohr92d74122022-10-21 15:50:52 -07001272def create_blueprint_for_targets(gn, desc, targets):
1273 """Generate a blueprint for a list of GN targets."""
1274 blueprint = Blueprint()
1275
1276 # Default settings used by all modules.
1277 defaults = Module('cc_defaults', defaults_module, '//gn:default_deps')
Patrick Rohr92d74122022-10-21 15:50:52 -07001278 defaults.cflags = [
Patrick Rohr3ce74772022-11-11 14:19:58 -08001279 '-DGOOGLE_PROTOBUF_NO_RTTI',
Patrick Rohr92d74122022-10-21 15:50:52 -07001280 '-Wno-error=return-type',
Patrick Rohr3a1ec1d2022-10-31 13:30:17 -07001281 '-Wno-non-virtual-dtor',
Patrick Rohr5c700022022-11-08 19:33:07 -08001282 '-Wno-macro-redefined',
Patrick Rohr98065152022-10-31 14:49:58 -07001283 '-Wno-missing-field-initializers',
Patrick Rohr92d74122022-10-21 15:50:52 -07001284 '-Wno-sign-compare',
1285 '-Wno-sign-promo',
1286 '-Wno-unused-parameter',
Mohannad Farragd98a96d2022-11-10 14:56:19 +00001287 '-Wno-deprecated-non-prototype', # needed for zlib
Patrick Rohr92d74122022-10-21 15:50:52 -07001288 '-fvisibility=hidden',
1289 '-O2',
1290 ]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001291 defaults.stl = 'none'
Patrick Rohr92d74122022-10-21 15:50:52 -07001292 blueprint.add_module(defaults)
Patrick Rohr344b2472022-10-25 11:32:15 -07001293
Patrick Rohr92d74122022-10-21 15:50:52 -07001294 for target in targets:
1295 create_modules_from_target(blueprint, gn, target)
Patrick Rohrb18aca22022-11-04 15:07:32 -07001296
1297 create_java_module(blueprint, gn)
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001298 update_jni_registration_module(blueprint, gn)
Patrick Rohra7d029d2022-11-08 12:23:11 -08001299
1300 # Merge in additional hardcoded arguments.
1301 for module in blueprint.modules.values():
1302 for key, add_val in additional_args.get(module.name, []):
1303 curr = getattr(module, key)
1304 if add_val and isinstance(add_val, set) and isinstance(curr, set):
1305 curr.update(add_val)
1306 elif isinstance(add_val, str) and (not curr or isinstance(curr, str)):
1307 setattr(module, key, add_val)
1308 elif isinstance(add_val, bool) and (not curr or isinstance(curr, bool)):
1309 setattr(module, key, add_val)
1310 elif isinstance(add_val, dict) and isinstance(curr, dict):
1311 curr.update(add_val)
1312 elif isinstance(add_val, dict) and isinstance(curr, Target):
1313 curr.__dict__.update(add_val)
1314 else:
1315 raise Error('Unimplemented type %r of additional_args: %r' %
1316 (type(add_val), key))
1317
Patrick Rohr92d74122022-10-21 15:50:52 -07001318 return blueprint
1319
1320
1321def main():
1322 parser = argparse.ArgumentParser(
1323 description='Generate Android.bp from a GN description.')
1324 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001325 '--desc',
Patrick Rohr3db246a2022-10-25 10:25:17 -07001326 help='GN description (e.g., gn desc out --format=json --all-toolchains "//*"',
1327 required=True
Patrick Rohr92d74122022-10-21 15:50:52 -07001328 )
1329 parser.add_argument(
1330 '--extras',
1331 help='Extra targets to include at the end of the Blueprint file',
1332 default=os.path.join(gn_utils.repo_root(), 'Android.bp.extras'),
1333 )
1334 parser.add_argument(
1335 '--output',
1336 help='Blueprint file to create',
1337 default=os.path.join(gn_utils.repo_root(), 'Android.bp'),
1338 )
1339 parser.add_argument(
Patrick Rohr16228942022-10-26 14:00:26 -07001340 '-v',
1341 '--verbose',
1342 help='Print debug logs.',
1343 action='store_true',
1344 )
1345 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001346 'targets',
1347 nargs=argparse.REMAINDER,
Patrick Rohr1aa504a2022-10-25 10:30:42 -07001348 help='Targets to include in the blueprint (e.g., "//:perfetto_tests")'
1349 )
Patrick Rohr92d74122022-10-21 15:50:52 -07001350 args = parser.parse_args()
1351
Patrick Rohr16228942022-10-26 14:00:26 -07001352 if args.verbose:
1353 log.basicConfig(format='%(levelname)s:%(funcName)s:%(message)s', level=log.DEBUG)
1354
Patrick Rohr3db246a2022-10-25 10:25:17 -07001355 with open(args.desc) as f:
1356 desc = json.load(f)
Patrick Rohr92d74122022-10-21 15:50:52 -07001357
1358 gn = gn_utils.GnParser(desc)
Patrick Rohr06296362022-11-10 21:37:33 -08001359 blueprint = create_blueprint_for_targets(gn, desc, args.targets or default_targets)
Patrick Rohr92d74122022-10-21 15:50:52 -07001360 project_root = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
1361 tool_name = os.path.relpath(os.path.abspath(__file__), project_root)
1362
Patrick Rohr92d74122022-10-21 15:50:52 -07001363 # Add any proto groups to the blueprint.
1364 for l_name, t_names in proto_groups.items():
1365 create_proto_group_modules(blueprint, gn, l_name, t_names)
1366
1367 output = [
Patrick Rohr5478b392022-10-25 09:58:50 -07001368 """// Copyright (C) 2022 The Android Open Source Project
Patrick Rohr92d74122022-10-21 15:50:52 -07001369//
1370// Licensed under the Apache License, Version 2.0 (the "License");
1371// you may not use this file except in compliance with the License.
1372// You may obtain a copy of the License at
1373//
1374// http://www.apache.org/licenses/LICENSE-2.0
1375//
1376// Unless required by applicable law or agreed to in writing, software
1377// distributed under the License is distributed on an "AS IS" BASIS,
1378// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1379// See the License for the specific language governing permissions and
1380// limitations under the License.
1381//
1382// This file is automatically generated by %s. Do not edit.
1383""" % (tool_name)
1384 ]
1385 blueprint.to_string(output)
Patrick Rohrcb98e9b2022-10-25 09:57:02 -07001386 if os.path.exists(args.extras):
1387 with open(args.extras, 'r') as r:
1388 for line in r:
1389 output.append(line.rstrip("\n\r"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001390
1391 out_files = []
1392
1393 # Generate the Android.bp file.
1394 out_files.append(args.output + '.swp')
1395 with open(out_files[-1], 'w') as f:
1396 f.write('\n'.join(output))
1397 # Text files should have a trailing EOL.
1398 f.write('\n')
1399
Patrick Rohr94693eb2022-10-25 10:09:16 -07001400 return 0
Patrick Rohr92d74122022-10-21 15:50:52 -07001401
1402
1403if __name__ == '__main__':
1404 sys.exit(main())