blob: 46b461bf2447c8ee1ccbb075a7ebf688be456635 [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 Rohr92d74122022-10-21 15:50:52 -070041# Defines a custom init_rc argument to be applied to the corresponding output
42# blueprint target.
43target_initrc = {
Patrick Rohrc36ef422022-10-25 10:38:05 -070044 # TODO: this can probably be removed.
Patrick Rohr92d74122022-10-21 15:50:52 -070045}
46
47target_host_supported = [
Patrick Rohrdc383942022-10-25 10:45:29 -070048 # TODO: remove if this is not useful for the cronet build.
Patrick Rohr92d74122022-10-21 15:50:52 -070049]
50
Patrick Rohr92d74122022-10-21 15:50:52 -070051# Proto target groups which will be made public.
52proto_groups = {
Patrick Rohr95212a22022-10-25 09:53:13 -070053 # TODO: remove if this is not used for the cronet build.
Patrick Rohr92d74122022-10-21 15:50:52 -070054}
55
56# All module names are prefixed with this string to avoid collisions.
Patrick Rohr61b2bad2022-10-25 10:49:20 -070057module_prefix = 'cronet_aml_'
Patrick Rohr92d74122022-10-21 15:50:52 -070058
59# Shared libraries which are directly translated to Android system equivalents.
60shared_library_allowlist = [
61 'android',
62 'android.hardware.atrace@1.0',
63 'android.hardware.health@2.0',
64 'android.hardware.health-V1-ndk',
65 'android.hardware.power.stats@1.0',
66 "android.hardware.power.stats-V1-cpp",
67 'base',
68 'binder',
69 'binder_ndk',
70 'cutils',
71 'hidlbase',
72 'hidltransport',
73 'hwbinder',
74 'incident',
75 'log',
76 'services',
77 'statssocket',
78 "tracingproxy",
79 'utils',
80]
81
82# Static libraries which are directly translated to Android system equivalents.
83static_library_allowlist = [
84 'statslog_perfetto',
85]
86
Patrick Rohrd9dd3b92022-11-09 16:15:30 -080087# Include directories that will be removed from all targets.
88local_include_dirs_denylist = [
89 'third_party/protobuf/src/',
90]
91
Patrick Rohr92d74122022-10-21 15:50:52 -070092# Name of the module which settings such as compiler flags for all other
93# modules.
94defaults_module = module_prefix + 'defaults'
95
96# Location of the project in the Android source tree.
Patrick Rohr76ceeb52022-11-07 14:18:58 -080097tree_path = 'external/chromium_org'
Patrick Rohr92d74122022-10-21 15:50:52 -070098
99# Path for the protobuf sources in the standalone build.
100buildtools_protobuf_src = '//buildtools/protobuf/src'
101
102# Location of the protobuf src dir in the Android source tree.
103android_protobuf_src = 'external/protobuf/src'
104
105# Compiler flags which are passed through to the blueprint.
106cflag_allowlist = r'^-DPERFETTO.*$'
107
Patrick Rohr92d74122022-10-21 15:50:52 -0700108# Additional arguments to apply to Android.bp rules.
109additional_args = {
Patrick Rohr2267a0a2022-11-08 18:59:34 -0800110 # TODO: remove if not needed.
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800111 'cronet_aml_net_net': [
Patrick Rohr9f4d3e32022-11-09 16:37:31 -0800112 ('export_static_lib_headers', {
113 'cronet_aml_net_third_party_quiche_quiche',
114 'cronet_aml_crypto_crypto',
115 }),
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800116 ]
Patrick Rohr92d74122022-10-21 15:50:52 -0700117}
118
119
120def enable_gtest_and_gmock(module):
121 module.static_libs.add('libgmock')
122 module.static_libs.add('libgtest')
123 if module.name != 'perfetto_gtest_logcat_printer':
124 module.whole_static_libs.add('perfetto_gtest_logcat_printer')
125
126
127def enable_protobuf_full(module):
128 if module.type == 'cc_binary_host':
129 module.static_libs.add('libprotobuf-cpp-full')
130 elif module.host_supported:
131 module.host.static_libs.add('libprotobuf-cpp-full')
132 module.android.shared_libs.add('libprotobuf-cpp-full')
Patrick Rohr84b16402022-11-08 19:01:01 -0800133 elif module.type not in ['genrule', 'filegroup']:
Patrick Rohr92d74122022-10-21 15:50:52 -0700134 module.shared_libs.add('libprotobuf-cpp-full')
135
136
137def enable_protobuf_lite(module):
Patrick Rohr84b16402022-11-08 19:01:01 -0800138 if module.type not in ['genrule', 'filegroup']:
139 module.shared_libs.add('libprotobuf-cpp-lite')
Patrick Rohr92d74122022-10-21 15:50:52 -0700140
141
142def enable_protoc_lib(module):
143 if module.type == 'cc_binary_host':
144 module.static_libs.add('libprotoc')
145 else:
146 module.shared_libs.add('libprotoc')
147
148
149def enable_libunwindstack(module):
150 if module.name != 'heapprofd_standalone_client':
151 module.shared_libs.add('libunwindstack')
152 module.shared_libs.add('libprocinfo')
153 module.shared_libs.add('libbase')
154 else:
155 module.static_libs.add('libunwindstack')
156 module.static_libs.add('libprocinfo')
157 module.static_libs.add('libbase')
158 module.static_libs.add('liblzma')
159 module.static_libs.add('libdexfile_support')
160 module.runtime_libs.add('libdexfile') # libdexfile_support dependency
161
162
163def enable_libunwind(module):
164 # libunwind is disabled on Darwin so we cannot depend on it.
165 pass
166
167
168def enable_sqlite(module):
169 if module.type == 'cc_binary_host':
170 module.static_libs.add('libsqlite')
171 module.static_libs.add('sqlite_ext_percentile')
172 elif module.host_supported:
173 # Copy what the sqlite3 command line tool does.
174 module.android.shared_libs.add('libsqlite')
175 module.android.shared_libs.add('libicu')
176 module.android.shared_libs.add('liblog')
177 module.android.shared_libs.add('libutils')
178 module.android.static_libs.add('sqlite_ext_percentile')
179 module.host.static_libs.add('libsqlite')
180 module.host.static_libs.add('sqlite_ext_percentile')
181 else:
182 module.shared_libs.add('libsqlite')
183 module.shared_libs.add('libicu')
184 module.shared_libs.add('liblog')
185 module.shared_libs.add('libutils')
186 module.static_libs.add('sqlite_ext_percentile')
187
188
189def enable_zlib(module):
190 if module.type == 'cc_binary_host':
191 module.static_libs.add('libz')
192 elif module.host_supported:
193 module.android.shared_libs.add('libz')
194 module.host.static_libs.add('libz')
195 else:
196 module.shared_libs.add('libz')
197
198
199def enable_uapi_headers(module):
200 module.include_dirs.add('bionic/libc/kernel')
201
202
203def enable_bionic_libc_platform_headers_on_android(module):
204 module.header_libs.add('bionic_libc_platform_headers')
205
206
207# Android equivalents for third-party libraries that the upstream project
208# depends on.
209builtin_deps = {
210 '//gn:default_deps':
211 lambda x: None,
212 '//gn:gtest_main':
213 lambda x: None,
Patrick Rohr92d74122022-10-21 15:50:52 -0700214 '//gn:gtest_and_gmock':
215 enable_gtest_and_gmock,
216 '//gn:libunwind':
217 enable_libunwind,
Patrick Rohr92d74122022-10-21 15:50:52 -0700218 '//gn:libunwindstack':
219 enable_libunwindstack,
220 '//gn:sqlite':
221 enable_sqlite,
222 '//gn:zlib':
223 enable_zlib,
224 '//gn:bionic_kernel_uapi_headers':
225 enable_uapi_headers,
226 '//src/profiling/memory:bionic_libc_platform_headers_on_android':
227 enable_bionic_libc_platform_headers_on_android,
Motomu Utsumidfc8e6a2022-11-04 18:25:33 +0900228 '//third_party/protobuf:protoc':
229 lambda x: None,
Patrick Rohr84b16402022-11-08 19:01:01 -0800230 '//third_party/protobuf:protobuf_full':
231 enable_protobuf_full,
232 '//third_party/protobuf:protobuf_lite':
233 enable_protobuf_lite,
234 '//third_party/protobuf:protoc_lib':
235 enable_protoc_lib,
Patrick Rohr92d74122022-10-21 15:50:52 -0700236}
237
238# ----------------------------------------------------------------------------
239# End of configuration.
240# ----------------------------------------------------------------------------
241
242
243class Error(Exception):
244 pass
245
246
247class ThrowingArgumentParser(argparse.ArgumentParser):
248
249 def __init__(self, context):
250 super(ThrowingArgumentParser, self).__init__()
251 self.context = context
252
253 def error(self, message):
254 raise Error('%s: %s' % (self.context, message))
255
256
257def write_blueprint_key_value(output, name, value, sort=True):
258 """Writes a Blueprint key-value pair to the output"""
259
260 if isinstance(value, bool):
261 if value:
262 output.append(' %s: true,' % name)
263 else:
264 output.append(' %s: false,' % name)
265 return
266 if not value:
267 return
268 if isinstance(value, set):
269 value = sorted(value)
270 if isinstance(value, list):
271 output.append(' %s: [' % name)
272 for item in sorted(value) if sort else value:
273 output.append(' "%s",' % item)
274 output.append(' ],')
275 return
276 if isinstance(value, Target):
277 value.to_string(output)
278 return
279 if isinstance(value, dict):
280 kv_output = []
281 for k, v in value.items():
282 write_blueprint_key_value(kv_output, k, v)
283
284 output.append(' %s: {' % name)
285 for line in kv_output:
286 output.append(' %s' % line)
287 output.append(' },')
288 return
289 output.append(' %s: "%s",' % (name, value))
290
291
292class Target(object):
293 """A target-scoped part of a module"""
294
295 def __init__(self, name):
296 self.name = name
297 self.shared_libs = set()
298 self.static_libs = set()
299 self.whole_static_libs = set()
300 self.cflags = set()
301 self.dist = dict()
302 self.strip = dict()
303 self.stl = None
304
305 def to_string(self, output):
306 nested_out = []
307 self._output_field(nested_out, 'shared_libs')
308 self._output_field(nested_out, 'static_libs')
309 self._output_field(nested_out, 'whole_static_libs')
310 self._output_field(nested_out, 'cflags')
311 self._output_field(nested_out, 'stl')
312 self._output_field(nested_out, 'dist')
313 self._output_field(nested_out, 'strip')
314
315 if nested_out:
316 output.append(' %s: {' % self.name)
317 for line in nested_out:
318 output.append(' %s' % line)
319 output.append(' },')
320
321 def _output_field(self, output, name, sort=True):
322 value = getattr(self, name)
323 return write_blueprint_key_value(output, name, value, sort)
324
325
326class Module(object):
327 """A single module (e.g., cc_binary, cc_test) in a blueprint."""
328
329 def __init__(self, mod_type, name, gn_target):
330 self.type = mod_type
331 self.gn_target = gn_target
332 self.name = name
333 self.srcs = set()
334 self.comment = 'GN: ' + gn_utils.label_without_toolchain(gn_target)
335 self.shared_libs = set()
336 self.static_libs = set()
337 self.whole_static_libs = set()
338 self.runtime_libs = set()
339 self.tools = set()
340 self.cmd = None
341 self.host_supported = False
342 self.vendor_available = False
343 self.init_rc = set()
344 self.out = set()
345 self.export_include_dirs = set()
346 self.generated_headers = set()
347 self.export_generated_headers = set()
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800348 self.export_static_lib_headers = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700349 self.defaults = set()
350 self.cflags = set()
351 self.include_dirs = set()
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900352 self.local_include_dirs = []
Patrick Rohr92d74122022-10-21 15:50:52 -0700353 self.header_libs = set()
354 self.required = set()
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700355 self.tool_files = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700356 self.android = Target('android')
357 self.host = Target('host')
Patrick Rohr92d74122022-10-21 15:50:52 -0700358 self.stl = None
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700359 self.cpp_std = None
Patrick Rohr92d74122022-10-21 15:50:52 -0700360 self.dist = dict()
361 self.strip = dict()
362 self.data = set()
363 self.apex_available = set()
364 self.min_sdk_version = None
365 self.proto = dict()
366 # The genrule_XXX below are properties that must to be propagated back
367 # on the module(s) that depend on the genrule.
368 self.genrule_headers = set()
369 self.genrule_srcs = set()
370 self.genrule_shared_libs = set()
Patrick Rohra1a27872022-10-31 11:57:14 -0700371 self.genrule_header_libs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700372 self.version_script = None
373 self.test_suites = set()
374 self.test_config = None
375 self.stubs = {}
376
377 def to_string(self, output):
378 if self.comment:
379 output.append('// %s' % self.comment)
380 output.append('%s {' % self.type)
381 self._output_field(output, 'name')
382 self._output_field(output, 'srcs')
383 self._output_field(output, 'shared_libs')
384 self._output_field(output, 'static_libs')
385 self._output_field(output, 'whole_static_libs')
386 self._output_field(output, 'runtime_libs')
387 self._output_field(output, 'tools')
388 self._output_field(output, 'cmd', sort=False)
389 if self.host_supported:
390 self._output_field(output, 'host_supported')
391 if self.vendor_available:
392 self._output_field(output, 'vendor_available')
393 self._output_field(output, 'init_rc')
394 self._output_field(output, 'out')
395 self._output_field(output, 'export_include_dirs')
396 self._output_field(output, 'generated_headers')
397 self._output_field(output, 'export_generated_headers')
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800398 self._output_field(output, 'export_static_lib_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -0700399 self._output_field(output, 'defaults')
400 self._output_field(output, 'cflags')
401 self._output_field(output, 'include_dirs')
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900402 self._output_field(output, 'local_include_dirs', sort=False)
Patrick Rohr92d74122022-10-21 15:50:52 -0700403 self._output_field(output, 'header_libs')
404 self._output_field(output, 'required')
405 self._output_field(output, 'dist')
406 self._output_field(output, 'strip')
407 self._output_field(output, 'tool_files')
408 self._output_field(output, 'data')
409 self._output_field(output, 'stl')
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700410 self._output_field(output, 'cpp_std')
Patrick Rohr92d74122022-10-21 15:50:52 -0700411 self._output_field(output, 'apex_available')
412 self._output_field(output, 'min_sdk_version')
413 self._output_field(output, 'version_script')
414 self._output_field(output, 'test_suites')
415 self._output_field(output, 'test_config')
416 self._output_field(output, 'stubs')
417 self._output_field(output, 'proto')
418
419 target_out = []
420 self._output_field(target_out, 'android')
421 self._output_field(target_out, 'host')
422 if target_out:
423 output.append(' target: {')
424 for line in target_out:
425 output.append(' %s' % line)
426 output.append(' },')
427
Patrick Rohr92d74122022-10-21 15:50:52 -0700428 output.append('}')
429 output.append('')
430
431 def add_android_static_lib(self, lib):
432 if self.type == 'cc_binary_host':
433 raise Exception('Adding Android static lib for host tool is unsupported')
434 elif self.host_supported:
435 self.android.static_libs.add(lib)
436 else:
437 self.static_libs.add(lib)
438
439 def add_android_shared_lib(self, lib):
440 if self.type == 'cc_binary_host':
441 raise Exception('Adding Android shared lib for host tool is unsupported')
442 elif self.host_supported:
443 self.android.shared_libs.add(lib)
444 else:
445 self.shared_libs.add(lib)
446
447 def _output_field(self, output, name, sort=True):
448 value = getattr(self, name)
449 return write_blueprint_key_value(output, name, value, sort)
450
451
452class Blueprint(object):
453 """In-memory representation of an Android.bp file."""
454
455 def __init__(self):
456 self.modules = {}
457
458 def add_module(self, module):
459 """Adds a new module to the blueprint, replacing any existing module
460 with the same name.
461
462 Args:
463 module: Module instance.
464 """
465 self.modules[module.name] = module
466
467 def to_string(self, output):
Patrick Rohr23f26192022-10-25 09:45:22 -0700468 for m in sorted(self.modules.values(), key=lambda m: m.name):
Patrick Rohr92d74122022-10-21 15:50:52 -0700469 m.to_string(output)
470
471
472def label_to_module_name(label):
473 """Turn a GN label (e.g., //:perfetto_tests) into a module name."""
474 # If the label is explicibly listed in the default target list, don't prefix
475 # its name and return just the target name. This is so tools like
476 # "traceconv" stay as such in the Android tree.
477 label_without_toolchain = gn_utils.label_without_toolchain(label)
Patrick Rohr92d74122022-10-21 15:50:52 -0700478 module = re.sub(r'^//:?', '', label_without_toolchain)
479 module = re.sub(r'[^a-zA-Z0-9_]', '_', module)
480 if not module.startswith(module_prefix):
481 return module_prefix + module
482 return module
483
484
485def is_supported_source_file(name):
486 """Returns True if |name| can appear in a 'srcs' list."""
Patrick Rohrd604f9f2022-10-27 13:56:42 -0700487 return os.path.splitext(name)[1] in ['.c', '.cc', '.java', '.proto']
Patrick Rohr92d74122022-10-21 15:50:52 -0700488
489
490def create_proto_modules(blueprint, gn, target):
491 """Generate genrules for a proto GN target.
492
493 GN actions are used to dynamically generate files during the build. The
494 Soong equivalent is a genrule. This function turns a specific kind of
495 genrule which turns .proto files into source and header files into a pair
496 equivalent genrules.
497
498 Args:
499 blueprint: Blueprint instance which is being generated.
500 target: gn_utils.Target object.
501
502 Returns:
503 The source_genrule module.
504 """
505 assert (target.type == 'proto_library')
506
507 tools = {'aprotoc'}
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900508 cpp_out_dir = '$(genDir)/%s/%s/' % (tree_path, target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700509 target_module_name = label_to_module_name(target.name)
510
511 # In GN builds the proto path is always relative to the output directory
512 # (out/tmp.xxx).
Motomu Utsumie8457452022-11-08 18:47:51 +0900513 cmd = ['$(location aprotoc)']
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900514 cmd += ['--proto_path=%s/%s' % (tree_path, target.proto_in_dir)]
Patrick Rohr92d74122022-10-21 15:50:52 -0700515
516 if buildtools_protobuf_src in target.proto_paths:
517 cmd += ['--proto_path=%s' % android_protobuf_src]
518
519 # We don't generate any targets for source_set proto modules because
520 # they will be inlined into other modules if required.
521 if target.proto_plugin == 'source_set':
522 return None
523
524 # Descriptor targets only generate a single target.
525 if target.proto_plugin == 'descriptor':
526 out = '{}.bin'.format(target_module_name)
527
528 cmd += ['--descriptor_set_out=$(out)']
529 cmd += ['$(in)']
530
531 descriptor_module = Module('genrule', target_module_name, target.name)
532 descriptor_module.cmd = ' '.join(cmd)
533 descriptor_module.out = [out]
534 descriptor_module.tools = tools
535 blueprint.add_module(descriptor_module)
536
537 # Recursively extract the .proto files of all the dependencies and
538 # add them to srcs.
539 descriptor_module.srcs.update(
540 gn_utils.label_to_path(src) for src in target.sources)
541 for dep in target.transitive_proto_deps:
542 current_target = gn.get_target(dep)
543 descriptor_module.srcs.update(
544 gn_utils.label_to_path(src) for src in current_target.sources)
545
546 return descriptor_module
547
548 # We create two genrules for each proto target: one for the headers and
549 # another for the sources. This is because the module that depends on the
550 # generated files needs to declare two different types of dependencies --
551 # source files in 'srcs' and headers in 'generated_headers' -- and it's not
552 # valid to generate .h files from a source dependency and vice versa.
553 source_module_name = target_module_name + '_gen'
554 source_module = Module('genrule', source_module_name, target.name)
555 blueprint.add_module(source_module)
556 source_module.srcs.update(
557 gn_utils.label_to_path(src) for src in target.sources)
558
559 header_module = Module('genrule', source_module_name + '_headers',
560 target.name)
561 blueprint.add_module(header_module)
562 header_module.srcs = set(source_module.srcs)
563
564 # TODO(primiano): at some point we should remove this. This was introduced
565 # by aosp/1108421 when adding "protos/" to .proto include paths, in order to
566 # avoid doing multi-repo changes and allow old clients in the android tree
567 # to still do the old #include "perfetto/..." rather than
568 # #include "protos/perfetto/...".
569 header_module.export_include_dirs = {'.', 'protos'}
Patrick Rohr2267a0a2022-11-08 18:59:34 -0800570 # Since the .cc file and .h get created by a different gerule target, they
571 # are not put in the same intermediate path, so local includes do not work
572 # without explictily exporting the include dir.
573 header_module.export_include_dirs.add(target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700574
575 source_module.genrule_srcs.add(':' + source_module.name)
576 source_module.genrule_headers.add(header_module.name)
577
578 if target.proto_plugin == 'proto':
579 suffixes = ['pb']
580 source_module.genrule_shared_libs.add('libprotobuf-cpp-lite')
581 cmd += ['--cpp_out=lite=true:' + cpp_out_dir]
582 elif target.proto_plugin == 'protozero':
583 suffixes = ['pbzero']
584 plugin = create_modules_from_target(blueprint, gn, protozero_plugin)
585 tools.add(plugin.name)
586 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
587 cmd += ['--plugin_out=wrapper_namespace=pbzero:' + cpp_out_dir]
588 elif target.proto_plugin == 'cppgen':
589 suffixes = ['gen']
590 plugin = create_modules_from_target(blueprint, gn, cppgen_plugin)
591 tools.add(plugin.name)
592 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
593 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
594 elif target.proto_plugin == 'ipc':
595 suffixes = ['ipc']
596 plugin = create_modules_from_target(blueprint, gn, ipc_plugin)
597 tools.add(plugin.name)
598 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
599 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
600 else:
601 raise Error('Unsupported proto plugin: %s' % target.proto_plugin)
602
603 cmd += ['$(in)']
604 source_module.cmd = ' '.join(cmd)
605 header_module.cmd = source_module.cmd
606 source_module.tools = tools
607 header_module.tools = tools
608
609 for sfx in suffixes:
610 source_module.out.update('%s/%s' %
611 (tree_path, src.replace('.proto', '.%s.cc' % sfx))
612 for src in source_module.srcs)
613 header_module.out.update('%s/%s' %
614 (tree_path, src.replace('.proto', '.%s.h' % sfx))
615 for src in header_module.srcs)
616 return source_module
617
618
619def create_amalgamated_sql_metrics_module(blueprint, target):
620 bp_module_name = label_to_module_name(target.name)
621 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700622 module.tool_files.add('tools/gen_amalgamated_sql_metrics.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700623 module.cmd = ' '.join([
624 '$(location tools/gen_amalgamated_sql_metrics.py)',
625 '--cpp_out=$(out)',
626 '$(in)',
627 ])
628 module.genrule_headers.add(module.name)
629 module.out.update(target.outputs)
630 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
631 blueprint.add_module(module)
632 return module
633
634
635def create_cc_proto_descriptor_module(blueprint, target):
636 bp_module_name = label_to_module_name(target.name)
637 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700638 module.tool_files.add('tools/gen_cc_proto_descriptor.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700639 module.cmd = ' '.join([
640 '$(location tools/gen_cc_proto_descriptor.py)', '--gen_dir=$(genDir)',
641 '--cpp_out=$(out)', '$(in)'
642 ])
643 module.genrule_headers.add(module.name)
644 module.srcs.update(
645 ':' + label_to_module_name(dep) for dep in target.proto_deps)
646 module.srcs.update(
647 gn_utils.label_to_path(src)
648 for src in target.inputs
649 if "tmp.gn_utils" not in src)
650 module.out.update(target.outputs)
651 blueprint.add_module(module)
652 return module
653
654
655def create_gen_version_module(blueprint, target, bp_module_name):
656 module = Module('genrule', bp_module_name, gn_utils.GEN_VERSION_TARGET)
657 script_path = gn_utils.label_to_path(target.script)
658 module.genrule_headers.add(bp_module_name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700659 module.tool_files.add(script_path)
Patrick Rohr92d74122022-10-21 15:50:52 -0700660 module.out.update(target.outputs)
661 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
662 module.cmd = ' '.join([
663 'python3 $(location %s)' % script_path, '--no_git',
664 '--changelog=$(location CHANGELOG)', '--cpp_out=$(out)'
665 ])
666 blueprint.add_module(module)
667 return module
668
669
670def create_proto_group_modules(blueprint, gn, module_name, target_names):
671 # TODO(lalitm): today, we're only adding a Java lite module because that's
672 # the only one used in practice. In the future, if we need other target types
673 # (e.g. C++, Java full etc.) add them here.
674 bp_module_name = label_to_module_name(module_name) + '_java_protos'
675 module = Module('java_library', bp_module_name, bp_module_name)
676 module.comment = f'''GN: [{', '.join(target_names)}]'''
677 module.proto = {'type': 'lite', 'canonical_path_from_root': False}
678
679 for name in target_names:
680 target = gn.get_target(name)
681 module.srcs.update(gn_utils.label_to_path(src) for src in target.sources)
682 for dep_label in target.transitive_proto_deps:
683 dep = gn.get_target(dep_label)
684 module.srcs.update(gn_utils.label_to_path(src) for src in dep.sources)
685
686 blueprint.add_module(module)
687
Motomu Utsumia6c33152022-11-02 18:21:55 +0900688# HACK: Need to support build_cofig_gen flexibly instead of hardcoding
689# build_config_gen generates srcjar by executing gcc via gcc_preprocess.py but gcc is not
690# available in genrule sandbox. Also gcc path is not configurable.
691# Under the //net:net, gcc_preprocess.py is only used for build_config_gen.
692# So, for now, hardcoding BuildConfig.java and generates srcjar by soong_zip.
693def override_build_config_gen(module):
694 module.tool_files.clear()
695 module.tools.add("soong_zip")
696 cmd = [
697 "echo",
698 "\\\"package org.chromium.build;\\n",
699 "public class BuildConfig {\\n",
700 "public static boolean IS_MULTIDEX_ENABLED ;\\n",
701 "public static boolean ENABLE_ASSERTS = true;\\n",
702 "public static boolean IS_UBSAN ;\\n",
703 "public static boolean IS_CHROME_BRANDED ;\\n",
704 "public static int R_STRING_PRODUCT_VERSION ;\\n",
705 "public static int MIN_SDK_VERSION = 1;\\n",
706 "public static boolean BUNDLES_SUPPORTED ;\\n",
707 "public static boolean IS_INCREMENTAL_INSTALL ;\\n",
708 "public static boolean ISOLATED_SPLITS_ENABLED ;\\n",
709 "public static boolean IS_FOR_TEST ;\\n",
710 "}\\n\\\"",
711 "> $(genDir)/BuildConfig.java &&",
712 "$(location soong_zip) -o $(out) -srcjar -f $(genDir)/BuildConfig.java"
713 ]
714 NEWLINE = ' " +\n "'
715 module.cmd = NEWLINE.join(cmd)
716 return module
717
Mohannad Farragbab6c892022-11-02 14:09:46 +0000718def create_action_foreach_modules(blueprint, target):
719 """ The following assumes that rebase_path exists in the args.
720 The args of an action_foreach contains hints about which output files are generated
721 by which source files.
722 This is copied directly from the args
723 "gen/net/base/registry_controlled_domains/{{source_name_part}}-reversed-inc.cc"
724 So each source file will generate an output whose name is the {source_name-reversed-inc.cc}
725 """
726 new_args = []
Motomu Utsumi56afcac2022-11-04 12:58:30 +0900727 for i, src in enumerate(sorted(target.sources)):
Mohannad Farragbab6c892022-11-02 14:09:46 +0000728 # don't add script arg for the first source -- create_action_module
729 # already does this.
730 if i != 0:
731 new_args.append('&& python3 $(location %s)' %
732 gn_utils.label_to_path(target.script))
733 for arg in target.args:
734 if '{{source}}' in arg:
735 new_args.append('$(location %s)' % (gn_utils.label_to_path(src)))
736 elif '{{source_name_part}}' in arg:
737 source_name_part = src.split("/")[-1] # Get the file name only
738 source_name_part = source_name_part.split(".")[0] # Remove the extension (Ex: .cc)
739 file_name = arg.replace('{{source_name_part}}', source_name_part).split("/")[-1]
740 # file_name represent the output file name. But we need the whole path
741 # This can be found from target.outputs.
742 for out in target.outputs:
743 if out.endswith(file_name):
744 new_args.append('$(location %s)' % out)
745 else:
746 new_args.append(arg)
747
748 target.args = new_args
749 return create_action_module(blueprint, target)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900750
Patrick Rohr7be99032022-10-31 11:54:19 -0700751def create_action_module(blueprint, target):
752 bp_module_name = label_to_module_name(target.name)
753 module = Module('genrule', bp_module_name, target.name)
754
Patrick Rohr9b99a982022-10-28 11:00:57 -0700755 # Convert ['--param=value'] to ['--param', 'value'] for consistency.
756 # TODO: we may want to only do this for python scripts arguments. If argparse
757 # is used, this transformation is safe.
758 target.args = [str for it in target.args for str in it.split('=')]
759
Motomu Utsumibf569d42022-10-28 16:47:34 +0900760 if target.script == "//build/write_buildflag_header.py":
761 # write_buildflag_header.py writes result to args.genDir/args.output
762 # So, override args.genDir by '.' so that args.output=$(out) works
Patrick Rohrde568a22022-10-28 09:22:35 -0700763 for i, val in enumerate(target.args):
764 if val == '--gen-dir':
765 target.args[i + 1] = '.'
Patrick Rohrfa972402022-11-01 11:54:35 -0700766 elif val == '--output':
767 target.args[i + 1] = '$(out)'
768
769 elif target.script == '//build/write_build_date_header.py':
770 target.args[0] = '$(out)'
Patrick Rohr0db9f852022-10-27 13:49:57 -0700771
Patrick Rohr8acccca2022-10-28 10:39:06 -0700772 elif target.script == '//base/android/jni_generator/jni_generator.py':
Patrick Rohrc5cc21a2022-10-31 11:57:49 -0700773 # chromium builds against a prebuilt ndk that contains the jni_headers, so
774 # a dependency is never explicitly created.
775 module.genrule_header_libs.add('jni_headers')
Patrick Rohr131ba282022-10-31 16:36:20 -0700776 needs_javap = False
Patrick Rohr8acccca2022-10-28 10:39:06 -0700777 for i, val in enumerate(target.args):
Motomu Utsumi6f9139d2022-10-31 12:15:19 +0900778 if val == '--output_dir':
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700779 # replace --output_dir gen/jni_headers/... with --output_dir $(genDir)/...
780 target.args[i + 1] = re.sub('^gen/jni_headers', '$(genDir)', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700781 elif val == '--input_file':
Patrick Rohr8acccca2022-10-28 10:39:06 -0700782 # --input_file supports both .class specifiers or source files as arguments.
783 # Only source files need to be wrapped inside a $(location <label>) tag.
784 if re.match('.*\.class$', target.args[i + 1]):
785 continue
786 # replace --input_file ../../... with --input_file $(location ...)
787 # TODO: put inside function
788 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
789 target.args[i + 1] = '$(location %s)' % filename
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700790 elif val == '--includes' and 'jni_generator_helper' in target.args[i + 1]:
Patrick Rohrd89e8bf2022-10-31 14:51:05 -0700791 # delete all leading ../
792 target.args[i + 1] = re.sub('^(\.\./)+', '', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700793 elif val == '--prev_output_dir':
Patrick Rohr131ba282022-10-31 16:36:20 -0700794 # this is not needed for aosp builds.
795 target.args[i] = ''
796 target.args[i + 1] = ''
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700797 elif val == '--jar_file':
Patrick Rohr131ba282022-10-31 16:36:20 -0700798 # delete leading ../../ and add path to javap
799 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
800 target.args[i + 1] = '$(location %s)' % filename
801 needs_javap = True
802
803 if needs_javap:
804 target.args.append('--javap')
805 target.args.append('$$(find out/.path -name javap)')
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700806 # fix target.output directory to match #include statements.
807 target.outputs = [re.sub('^jni_headers/', '', out) for out in target.outputs]
Patrick Rohr8acccca2022-10-28 10:39:06 -0700808
Patrick Rohrf6d2b612022-11-09 12:30:26 -0800809 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
810 # jni_registration_generator.py pulls in some config dependencies that we
811 # do not handle. Remove them.
812 # TODO: find a better way to do this.
813 target.deps.clear()
814
Motomu Utsumied009082022-11-10 16:26:44 +0900815 target.inputs = [file for file in target.inputs if not file.startswith('//out/')]
Motomu Utsumi6b4acaa2022-11-10 16:13:24 +0900816 for i, val in enumerate(target.args):
817 if val in ['--depfile', '--srcjar-path', '--header-path']:
818 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900819 if val == '--sources-files':
820 target.args[i + 1] = '$(genDir)/java.sources'
Motomu Utsumi47d122f2022-11-10 17:32:23 +0900821 elif val == '--sources-exclusions':
822 # update_jni_registration_module removes them from the srcs of the module
823 # It might be better to remove sources by '--sources-exclusions'
824 target.args[i] = ''
825 target.args[i + 1] = ''
Motomu Utsumi6b4acaa2022-11-10 16:13:24 +0900826
Patrick Rohr245df582022-11-01 16:59:45 -0700827 elif target.script == '//build/android/gyp/write_build_config.py':
828 for i, val in enumerate(target.args):
829 if val == '--depfile':
830 # Depfile is not used, so no need to generate it.
831 target.args[i] = ''
832 target.args[i + 1] = ''
833 elif val in ['--deps-configs', '--bundled-srcjars']:
834 args = target.args[i + 1]
835 if args == '[]':
836 continue
837 # strip surrounding [] and split by ", "
838 args = args.strip('[]').split(', ')
839 # strip surrounding ""
840 args = [arg.strip('"') for arg in args]
841 # remove leading gen/
842 args = [re.sub('^gen/', '', arg) for arg in args]
843 # wrap filename in \"$(location filename)\"
844 args = ['\"$(location %s)\"' % arg for arg in args]
845 # join args with ", " and wrap in []
846 target.args[i + 1] = '[%s]' % ', '.join(args)
847
848 elif val == '--public-deps-configs':
849 # TODO: implement.
850 pass
851
852 elif val == '--build-config':
853 # json output of this script
854 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
855
856 elif val in ['--unprocessed-jar-path', '--interface-jar-path',
857 '--device-jar-path', '--host-jar-path']:
858 # jar path can be within sources (../../) or output generated by
859 # another genrule (obj/)
860 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
861 filename = re.sub('^obj/', '', target.args[i + 1])
862 target.args[i + 1] = '$(location %s)' % filename
863
864 elif val == '--proguard-configs':
865 args = target.args[i + 1]
866 if args == '[]':
867 continue
868 # TODO: consider adding helpers to deal with argument lists
869 # strip surrounding [] and split by ", ", then strip surrounding ""
870 args = args.strip('[]').split(', ')
871 args = [arg.strip('"') for arg in args]
872 # remove leading ../../
873 args = [re.sub('^\.\./\.\./', '', arg) for arg in args]
874 # add dependency on proguard config file, so a $(location) wrapper can be used.
875 module.tool_files.update(args)
876 # wrap filename in \"$(location filename)\"
877 args = ['$(location %s)' % arg for arg in args]
878 target.args[i + 1] = '[%s]' % ', '.join(args)
Motomu Utsumi1caa39b2022-11-02 18:38:13 +0900879 elif target.script == "//build/android/gyp/write_native_libraries_java.py":
880 for i, val in enumerate(target.args):
881 if val == '--output':
882 target.args[i + 1] = '$(out)'
Motomu Utsumi26211dc2022-11-02 19:38:47 +0900883 elif target.script == "//tools/grit/stamp_grit_sources.py":
884 target.outputs = [re.sub('^\/\/', '', out) for out in target.outputs]
885 # Directory that contains grit scripts
886 target.args[0] = '`dirname $(location tools/grit/grit.py)`'
887 # Path to the stamp file
888 target.args[1] = '$(out)'
889 # Script tries to create args[2] file but this is not in the output.
890 # Specifying file under $(genDir) so that parent directory exists.
891 # If this file is used by other module, we may need to add this file to the outputs.
892 target.args[2] = '$(genDir)/' + target.args[2].split('/')[-1]
Mohannad Farrag033c9d62022-11-07 14:55:49 +0000893 elif target.script == "//tools/grit/grit.py":
894 for i, val in enumerate(target.args):
895 if val == '-i':
896 # Delete leading ../..
897 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
898 target.args[i + 1] = '$(location %s)' % filename
899 elif val == '-o':
900 filename = re.sub('^gen/', '', target.args[i + 1])
901 if filename == "net":
902 # This is a directory not a file
903 target.args[i + 1] = '$(genDir)/net'
904 else:
905 # This is an output fil
906 target.args[i + 1] = '$(location %s)' % filename
907 elif val == '--depfile':
908 # The depfile is replaced by adding /tools/**/*.py to the tools_files
909 # This is basically just globbing all the needed sources by hardcoding.
910 module.tool_files.update([
911 "tools/grit/**/*.py",
912 "third_party/six/src/six.py" # This is not picked up by default. Must be added
913 ])
914
915 # Delete the depfile argument
916 target.args[i] = ' '
917 target.args[i + 1] = ' '
918 elif val == '--input':
919 # Delete leading ../..
920 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
921 # This is an output file so use $(location %s)
922 target.args[i + 1] = '$(location %s)' % filename
Motomu Utsumia0cc6662022-11-09 15:22:27 +0900923 elif target.script == "//net/tools/dafsa/make_dafsa.py":
924 # This script generates .cc files but source (registry_controlled_domain.cc) in the target that
925 # depends on this target includes .cc file this script generates.
926 module.genrule_headers.add(module.name)
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900927 elif target.script == "//build/util/version.py":
Motomu Utsumib0a49e42022-11-09 18:12:27 +0900928 # android_chrome_version.py is not specified in anywhere but version.py imports this file
929 module.tool_files.add('build/util/android_chrome_version.py')
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900930 for i, val in enumerate(target.args):
931 if val.startswith('../../'):
932 filename = re.sub('^\.\./\.\./', '', val)
933 target.args[i] = '$(location %s)' % filename
Motomu Utsumiee279c52022-11-09 17:46:27 +0900934 elif val == '-e':
935 # arg for -e EVAL option should be passed in -e PATCH_HI=int(PATCH)//256 format.
936 target.args[i + 1] = '%s=\'%s\'' % (target.args[i + 1], target.args[i + 2])
937 target.args[i + 2] = ''
Motomu Utsumi438f2c22022-11-09 18:16:40 +0900938 elif val == '-o':
939 target.args[i + 1] = '$(out)'
Patrick Rohr245df582022-11-01 16:59:45 -0700940
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700941 script = gn_utils.label_to_path(target.script)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700942 module.tool_files.add(script)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700943
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700944 # Handle passing parameters via response file by piping them into the script
945 # and reading them from /dev/stdin.
946 response_file = '{{response_file_name}}'
947 use_response_file = response_file in target.args
948 if use_response_file:
949 # Replace {{response_file_contents}} with /dev/stdin
950 target.args = ['/dev/stdin' if it == response_file else it for it in target.args]
951
Patrick Rohr4b0952d2022-11-01 12:42:31 -0700952 # escape " and \$ in target.args.
953 # once all actions are properly implemented, this may not be necessary anymore.
954 # TODO: is this the right place to do this?
955 target.args = [arg.replace('"', r'\"') for arg in target.args]
956 target.args = [arg.replace(r'\$', r'\\$') for arg in target.args]
957
Patrick Rohr9b99a982022-10-28 11:00:57 -0700958 # put all args on a new line for better diffs.
959 NEWLINE = ' " +\n "'
960 arg_string = NEWLINE.join(target.args)
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700961 module.cmd = '$(location %s) %s' % (script, arg_string)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700962
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700963 if use_response_file:
964 # Pipe response file contents into script
Patrick Rohr9b99a982022-10-28 11:00:57 -0700965 module.cmd = 'echo \'%s\' |%s%s' % (target.response_file_contents, NEWLINE, module.cmd)
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700966
Motomu Utsumi7e983832022-11-10 16:04:46 +0900967 if any(os.path.splitext(it)[1] == '.h' for it in target.outputs):
Patrick Rohr67f4d432022-10-26 16:04:15 -0700968 module.genrule_headers.add(bp_module_name)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700969
Patrick Rohr0db9f852022-10-27 13:49:57 -0700970 # gn treats inputs and sources for actions equally.
971 # soong only supports source files inside srcs, non-source files are added as
972 # tool_files dependency.
973 for it in target.sources or target.inputs:
974 if is_supported_source_file(it):
975 module.srcs.add(gn_utils.label_to_path(it))
976 else:
977 module.tool_files.add(gn_utils.label_to_path(it))
Patrick Rohre1a853e2022-10-26 12:31:39 -0700978
Patrick Rohr15a2c302022-10-26 15:08:57 -0700979 # Actions using template "action_with_pydeps" also put script inside inputs.
980 # TODO: it might make sense to filter inputs inside GnParser.
981 if script in module.srcs:
982 module.srcs.remove(script)
983
Patrick Rohre1a853e2022-10-26 12:31:39 -0700984 module.out.update(target.outputs)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900985
986 if target.name == "//build/android:build_config_gen":
987 module = override_build_config_gen(module)
Motomu Utsumi26211dc2022-11-02 19:38:47 +0900988 elif target.script == "//tools/grit/stamp_grit_sources.py":
989 # stamp_grit_sources.py is not executable
990 module.cmd = "python " + module.cmd
Mohannad Farrag18d7b512022-11-07 13:26:30 +0000991 elif target.script == "//base/android/jni_generator/jni_generator.py":
992 # android_jar.classes should be part of the tools as it list implicit classes
993 # for the script to generate JNI headers.
994 module.tool_files.add("base/android/jni_generator/android_jar.classes")
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900995 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
Motomu Utsumi9ca466b2022-11-10 17:12:29 +0900996 # jni_registration_generator.py doesn't work with python2
997 module.cmd = "python3 " + module.cmd
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900998 # Path in the original sources file does not work in genrule.
999 # So creating sources file in cmd based on the srcs of this target.
1000 # Adding ../$(current_dir)/ to the head because jni_registration_generator.py uses the files
1001 # whose path startswith(..)
1002 commands = ["current_dir=`basename \\\`pwd\\\``;",
1003 "for f in $(in);",
1004 "do",
1005 "echo \\\"../$$current_dir/$$f\\\" >> $(genDir)/java.sources;",
1006 "done;",
1007 module.cmd]
Motomu Utsumi2a892d22022-11-10 18:03:20 +09001008
1009 # .h file jni_registration_generator.py generates has #define with directory name.
1010 # With the genrule env that contains "." which is invalid. So replace that at the end of cmd.
1011 commands.append(";sed -i -e 's/OUT_SOONG_.TEMP/OUT_SOONG_DOTTEMP/g' ")
1012 commands.append("$(genDir)/components/cronet/android/cronet_jni_registration.h")
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +09001013 module.cmd = NEWLINE.join(commands)
Motomu Utsumia6c33152022-11-02 18:21:55 +09001014
Patrick Rohre1a853e2022-10-26 12:31:39 -07001015 blueprint.add_module(module)
1016 return module
1017
1018
Patrick Rohr92d74122022-10-21 15:50:52 -07001019
1020def _get_cflags(target):
1021 cflags = {flag for flag in target.cflags if re.match(cflag_allowlist, flag)}
Motomu Utsumifa7e9262022-10-26 19:43:02 +09001022 # Consider proper allowlist or denylist if needed
1023 cflags |= set("-D%s" % define.replace("\"", "\\\"") for define in target.defines)
Patrick Rohr92d74122022-10-21 15:50:52 -07001024 return cflags
1025
1026
1027def create_modules_from_target(blueprint, gn, gn_target_name):
1028 """Generate module(s) for a given GN target.
1029
1030 Given a GN target name, generate one or more corresponding modules into a
1031 blueprint. The only case when this generates >1 module is proto libraries.
1032
1033 Args:
1034 blueprint: Blueprint instance which is being generated.
1035 gn: gn_utils.GnParser object.
1036 gn_target_name: GN target for module generation.
1037 """
1038 bp_module_name = label_to_module_name(gn_target_name)
1039 if bp_module_name in blueprint.modules:
1040 return blueprint.modules[bp_module_name]
1041 target = gn.get_target(gn_target_name)
Patrick Rohr16228942022-10-26 14:00:26 -07001042 log.info('create modules for %s (%s)', target.name, target.type)
Patrick Rohr92d74122022-10-21 15:50:52 -07001043
1044 name_without_toolchain = gn_utils.label_without_toolchain(target.name)
1045 if target.type == 'executable':
1046 if target.toolchain == gn_utils.HOST_TOOLCHAIN:
1047 module_type = 'cc_binary_host'
1048 elif target.testonly:
1049 module_type = 'cc_test'
1050 else:
1051 module_type = 'cc_binary'
1052 module = Module(module_type, bp_module_name, gn_target_name)
1053 elif target.type == 'static_library':
1054 module = Module('cc_library_static', bp_module_name, gn_target_name)
1055 elif target.type == 'shared_library':
1056 module = Module('cc_library_shared', bp_module_name, gn_target_name)
1057 elif target.type == 'source_set':
1058 module = Module('filegroup', bp_module_name, gn_target_name)
1059 elif target.type == 'group':
1060 # "group" targets are resolved recursively by gn_utils.get_target().
1061 # There's nothing we need to do at this level for them.
1062 return None
1063 elif target.type == 'proto_library':
1064 module = create_proto_modules(blueprint, gn, target)
1065 if module is None:
1066 return None
1067 elif target.type == 'action':
1068 if 'gen_amalgamated_sql_metrics' in target.name:
1069 module = create_amalgamated_sql_metrics_module(blueprint, target)
1070 elif re.match('.*gen_cc_.*_descriptor$', name_without_toolchain):
1071 module = create_cc_proto_descriptor_module(blueprint, target)
1072 elif target.type == 'action' and \
1073 name_without_toolchain == gn_utils.GEN_VERSION_TARGET:
1074 module = create_gen_version_module(blueprint, target, bp_module_name)
1075 else:
Patrick Rohre1a853e2022-10-26 12:31:39 -07001076 module = create_action_module(blueprint, target)
Mohannad Farragf076f3e2022-10-31 17:45:28 +00001077 elif target.type == 'action_foreach':
Mohannad Farragbab6c892022-11-02 14:09:46 +00001078 module = create_action_foreach_modules(blueprint, target)
Patrick Rohr59a76652022-10-26 12:36:56 -07001079 elif target.type == 'copy':
1080 # TODO: careful now! copy targets are not supported yet, but this will stop
1081 # traversing the dependency tree. For //base:base, this is not a big
1082 # problem as libicu contains the only copy target which happens to be a
1083 # leaf node.
1084 return None
Patrick Rohr92d74122022-10-21 15:50:52 -07001085 else:
1086 raise Error('Unknown target %s (%s)' % (target.name, target.type))
1087
1088 blueprint.add_module(module)
1089 module.host_supported = (name_without_toolchain in target_host_supported)
Patrick Rohr92d74122022-10-21 15:50:52 -07001090 module.init_rc = target_initrc.get(target.name, [])
1091 module.srcs.update(
1092 gn_utils.label_to_path(src)
1093 for src in target.sources
Motomu Utsumif951e502022-11-07 19:31:15 +09001094 if is_supported_source_file(src) and not src.startswith("//out/test"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001095
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001096 local_include_dirs_set = set()
Patrick Rohr92d74122022-10-21 15:50:52 -07001097 if target.type in gn_utils.LINKER_UNIT_TYPES:
1098 module.cflags.update(_get_cflags(target))
Patrick Rohrf22e9d02022-10-28 14:20:46 -07001099 # TODO: implement proper cflag parsing.
1100 for flag in target.cflags:
Patrick Rohrb8f830a2022-10-31 11:18:57 -07001101 if '-std=' in flag:
1102 module.cpp_std = flag[len('-std='):]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001103 if '-isystem' in flag:
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001104 local_include_dirs_set.add(flag[len('-isystem../../'):])
Patrick Rohrb8f830a2022-10-31 11:18:57 -07001105
Patrick Rohrd0abc2a2022-10-31 13:29:16 -07001106 # Adding local_include_dirs is necessary due to source_sets / filegroups
1107 # which do not properly propagate include directories.
1108 # Filter any directory inside //out as a) this directory does not exist for
1109 # aosp / soong builds and b) the include directory should already be
1110 # configured via library dependency.
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001111 local_include_dirs_set.update([gn_utils.label_to_path(d)
Patrick Rohrd0abc2a2022-10-31 13:29:16 -07001112 for d in target.include_dirs
1113 if not re.match('^//out/.*', d)])
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001114 module.local_include_dirs = sorted(list(local_include_dirs_set))
1115
1116 # Order matters for some targets. For example, base/time/time_exploded_icu.cc
1117 # in //base:base needs to have sysroot include after icu/source/common
1118 # include. So adding sysroot include at the end.
1119 for flag in target.cflags:
1120 if '--sysroot' in flag:
1121 module.local_include_dirs.append(flag[len('--sysroot=../../'):] + "/usr/include")
Patrick Rohr92d74122022-10-21 15:50:52 -07001122
1123 module_is_compiled = module.type not in ('genrule', 'filegroup')
1124 if module_is_compiled:
1125 # Don't try to inject library/source dependencies into genrules or
1126 # filegroups because they are not compiled in the traditional sense.
1127 module.defaults = [defaults_module]
1128 for lib in target.libs:
1129 # Generally library names should be mangled as 'libXXX', unless they
1130 # are HAL libraries (e.g., android.hardware.health@2.0) or AIDL c++ / NDK
1131 # libraries (e.g. "android.hardware.power.stats-V1-cpp")
1132 android_lib = lib if '@' in lib or "-cpp" in lib or "-ndk" in lib \
1133 else 'lib' + lib
1134 if lib in shared_library_allowlist:
1135 module.add_android_shared_lib(android_lib)
1136 if lib in static_library_allowlist:
1137 module.add_android_static_lib(android_lib)
1138
Patrick Rohrd9dd3b92022-11-09 16:15:30 -08001139 # Remove prohibited include directories
1140 module.local_include_dirs = [d for d in module.local_include_dirs
1141 if d not in local_include_dirs_denylist]
1142
1143
Patrick Rohr92d74122022-10-21 15:50:52 -07001144 # If the module is a static library, export all the generated headers.
1145 if module.type == 'cc_library_static':
1146 module.export_generated_headers = module.generated_headers
1147
Patrick Rohr92d74122022-10-21 15:50:52 -07001148 # dep_name is an unmangled GN target name (e.g. //foo:bar(toolchain)).
Motomu Utsumif1daa232022-11-08 13:28:37 +09001149 # Currently, only one module is generated from target even target has multiple toolchains.
1150 # And module is generated based on the first visited target.
1151 # Sort deps before iteration to make result deterministic.
1152 all_deps = sorted(target.deps | target.source_set_deps | target.transitive_proto_deps)
Patrick Rohr92d74122022-10-21 15:50:52 -07001153 for dep_name in all_deps:
Patrick Rohr5cc46e02022-10-26 14:32:45 -07001154 # |builtin_deps| override GN deps with Android-specific ones. See the
1155 # config in the top of this file.
1156 if gn_utils.label_without_toolchain(dep_name) in builtin_deps:
1157 builtin_deps[gn_utils.label_without_toolchain(dep_name)](module)
1158 continue
1159
Patrick Rohr92d74122022-10-21 15:50:52 -07001160 dep_module = create_modules_from_target(blueprint, gn, dep_name)
1161
Motomu Utsumie246feb2022-11-01 17:25:56 +09001162 # TODO: Proper dependency check for genrule.
1163 # Currently, only propagating genrule dependencies.
1164 # Also, currently, all the dependencies are propagated upwards.
1165 # in gn, public_deps should be propagated but deps should not.
1166 # Not sure this information is available in the desc.json.
1167 # Following rule works for adding android_runtime_jni_headers to base:base.
1168 # If this doesn't work for other target, hardcoding for specific target
1169 # might be better.
1170 if module.type == "genrule" and dep_module.type == "genrule":
1171 module.genrule_headers.add(dep_module.name)
1172 module.genrule_headers.update(dep_module.genrule_headers)
1173
Patrick Rohr92d74122022-10-21 15:50:52 -07001174 # For filegroups and genrule, recurse but don't apply the deps.
1175 if not module_is_compiled:
1176 continue
1177
Patrick Rohr92d74122022-10-21 15:50:52 -07001178 if dep_module is None:
1179 continue
1180 if dep_module.type == 'cc_library_shared':
1181 module.shared_libs.add(dep_module.name)
1182 elif dep_module.type == 'cc_library_static':
1183 module.static_libs.add(dep_module.name)
1184 elif dep_module.type == 'filegroup':
1185 module.srcs.add(':' + dep_module.name)
1186 elif dep_module.type == 'genrule':
1187 module.generated_headers.update(dep_module.genrule_headers)
1188 module.srcs.update(dep_module.genrule_srcs)
1189 module.shared_libs.update(dep_module.genrule_shared_libs)
Patrick Rohra1a27872022-10-31 11:57:14 -07001190 module.header_libs.update(dep_module.genrule_header_libs)
Patrick Rohr92d74122022-10-21 15:50:52 -07001191 elif dep_module.type == 'cc_binary':
1192 continue # Ignore executables deps (used by cmdline integration tests).
1193 else:
1194 raise Error('Unknown dep %s (%s) for target %s' %
1195 (dep_module.name, dep_module.type, module.name))
1196
1197 return module
1198
Patrick Rohrb18aca22022-11-04 15:07:32 -07001199def create_java_module(blueprint, gn):
1200 bp_module_name = module_prefix + 'java'
1201 module = Module('java_library', bp_module_name, '//gn:java')
Mohannad Farrag21562d62022-11-07 13:09:31 +00001202 module.srcs.update([gn_utils.label_to_path(source) for source in gn.java_sources])
Patrick Rohrb18aca22022-11-04 15:07:32 -07001203 blueprint.add_module(module)
Patrick Rohr92d74122022-10-21 15:50:52 -07001204
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001205def update_jni_registration_module(blueprint, gn):
1206 bp_module_name = label_to_module_name('//components/cronet/android:cronet_jni_registration')
1207 module = blueprint.modules[bp_module_name]
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001208
1209 # TODO: deny list is in the arg of jni_registration_generator.py. Should not be hardcoded
1210 deny_list = [
1211 '//base/android/java/src/org/chromium/base/library_loader/LibraryLoader.java',
1212 '//base/android/java/src/org/chromium/base/library_loader/LibraryPrefetcher.java',
1213 '//base/android/java/src/org/chromium/base/process_launcher/ChildProcessService.java',
1214 '//base/android/java/src/org/chromium/base/SysUtils.java']
1215
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001216 # TODO: java_sources might not contain all the required java files
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001217 module.srcs.update([gn_utils.label_to_path(source)
1218 for source in gn.java_sources if source not in deny_list])
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001219
Motomu Utsumi79bd0c82022-11-10 17:52:24 +09001220 # TODO: Remove hardcoded file addition to srcs
1221 # jni_registration_generator.py generates empty .h file if native methods are not found in the
1222 # java files. But android:cronet depends on `RegisterNonMainDexNatives` which is in the template
1223 # of .h file. To make script generate non empty .h file, adding java file which contains native
1224 # method. Once all the required java files are added to the srcs, this can be removed.
1225 module.srcs.update([
1226 "components/cronet/android/java/src/org/chromium/net/impl/CronetUrlRequest.java"])
1227
Patrick Rohr92d74122022-10-21 15:50:52 -07001228def create_blueprint_for_targets(gn, desc, targets):
1229 """Generate a blueprint for a list of GN targets."""
1230 blueprint = Blueprint()
1231
1232 # Default settings used by all modules.
1233 defaults = Module('cc_defaults', defaults_module, '//gn:default_deps')
Patrick Rohr92d74122022-10-21 15:50:52 -07001234 defaults.cflags = [
1235 '-Wno-error=return-type',
Patrick Rohr3a1ec1d2022-10-31 13:30:17 -07001236 '-Wno-non-virtual-dtor',
Patrick Rohr5c700022022-11-08 19:33:07 -08001237 '-Wno-macro-redefined',
Patrick Rohr98065152022-10-31 14:49:58 -07001238 '-Wno-missing-field-initializers',
Patrick Rohr92d74122022-10-21 15:50:52 -07001239 '-Wno-sign-compare',
1240 '-Wno-sign-promo',
1241 '-Wno-unused-parameter',
1242 '-fvisibility=hidden',
1243 '-O2',
1244 ]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001245 defaults.stl = 'none'
Patrick Rohr92d74122022-10-21 15:50:52 -07001246 blueprint.add_module(defaults)
Patrick Rohr344b2472022-10-25 11:32:15 -07001247
Patrick Rohr92d74122022-10-21 15:50:52 -07001248 for target in targets:
1249 create_modules_from_target(blueprint, gn, target)
Patrick Rohrb18aca22022-11-04 15:07:32 -07001250
1251 create_java_module(blueprint, gn)
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001252 update_jni_registration_module(blueprint, gn)
Patrick Rohra7d029d2022-11-08 12:23:11 -08001253
1254 # Merge in additional hardcoded arguments.
1255 for module in blueprint.modules.values():
1256 for key, add_val in additional_args.get(module.name, []):
1257 curr = getattr(module, key)
1258 if add_val and isinstance(add_val, set) and isinstance(curr, set):
1259 curr.update(add_val)
1260 elif isinstance(add_val, str) and (not curr or isinstance(curr, str)):
1261 setattr(module, key, add_val)
1262 elif isinstance(add_val, bool) and (not curr or isinstance(curr, bool)):
1263 setattr(module, key, add_val)
1264 elif isinstance(add_val, dict) and isinstance(curr, dict):
1265 curr.update(add_val)
1266 elif isinstance(add_val, dict) and isinstance(curr, Target):
1267 curr.__dict__.update(add_val)
1268 else:
1269 raise Error('Unimplemented type %r of additional_args: %r' %
1270 (type(add_val), key))
1271
Patrick Rohr92d74122022-10-21 15:50:52 -07001272 return blueprint
1273
1274
1275def main():
1276 parser = argparse.ArgumentParser(
1277 description='Generate Android.bp from a GN description.')
1278 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001279 '--desc',
Patrick Rohr3db246a2022-10-25 10:25:17 -07001280 help='GN description (e.g., gn desc out --format=json --all-toolchains "//*"',
1281 required=True
Patrick Rohr92d74122022-10-21 15:50:52 -07001282 )
1283 parser.add_argument(
1284 '--extras',
1285 help='Extra targets to include at the end of the Blueprint file',
1286 default=os.path.join(gn_utils.repo_root(), 'Android.bp.extras'),
1287 )
1288 parser.add_argument(
1289 '--output',
1290 help='Blueprint file to create',
1291 default=os.path.join(gn_utils.repo_root(), 'Android.bp'),
1292 )
1293 parser.add_argument(
Patrick Rohr16228942022-10-26 14:00:26 -07001294 '-v',
1295 '--verbose',
1296 help='Print debug logs.',
1297 action='store_true',
1298 )
1299 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001300 'targets',
1301 nargs=argparse.REMAINDER,
Patrick Rohr1aa504a2022-10-25 10:30:42 -07001302 help='Targets to include in the blueprint (e.g., "//:perfetto_tests")'
1303 )
Patrick Rohr92d74122022-10-21 15:50:52 -07001304 args = parser.parse_args()
1305
Patrick Rohr16228942022-10-26 14:00:26 -07001306 if args.verbose:
1307 log.basicConfig(format='%(levelname)s:%(funcName)s:%(message)s', level=log.DEBUG)
1308
Patrick Rohr3db246a2022-10-25 10:25:17 -07001309 with open(args.desc) as f:
1310 desc = json.load(f)
Patrick Rohr92d74122022-10-21 15:50:52 -07001311
1312 gn = gn_utils.GnParser(desc)
Patrick Rohr1aa504a2022-10-25 10:30:42 -07001313 blueprint = create_blueprint_for_targets(gn, desc, args.targets)
Patrick Rohr92d74122022-10-21 15:50:52 -07001314 project_root = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
1315 tool_name = os.path.relpath(os.path.abspath(__file__), project_root)
1316
Patrick Rohr92d74122022-10-21 15:50:52 -07001317 # Add any proto groups to the blueprint.
1318 for l_name, t_names in proto_groups.items():
1319 create_proto_group_modules(blueprint, gn, l_name, t_names)
1320
1321 output = [
Patrick Rohr5478b392022-10-25 09:58:50 -07001322 """// Copyright (C) 2022 The Android Open Source Project
Patrick Rohr92d74122022-10-21 15:50:52 -07001323//
1324// Licensed under the Apache License, Version 2.0 (the "License");
1325// you may not use this file except in compliance with the License.
1326// You may obtain a copy of the License at
1327//
1328// http://www.apache.org/licenses/LICENSE-2.0
1329//
1330// Unless required by applicable law or agreed to in writing, software
1331// distributed under the License is distributed on an "AS IS" BASIS,
1332// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1333// See the License for the specific language governing permissions and
1334// limitations under the License.
1335//
1336// This file is automatically generated by %s. Do not edit.
1337""" % (tool_name)
1338 ]
1339 blueprint.to_string(output)
Patrick Rohrcb98e9b2022-10-25 09:57:02 -07001340 if os.path.exists(args.extras):
1341 with open(args.extras, 'r') as r:
1342 for line in r:
1343 output.append(line.rstrip("\n\r"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001344
1345 out_files = []
1346
1347 # Generate the Android.bp file.
1348 out_files.append(args.output + '.swp')
1349 with open(out_files[-1], 'w') as f:
1350 f.write('\n'.join(output))
1351 # Text files should have a trailing EOL.
1352 f.write('\n')
1353
Patrick Rohr94693eb2022-10-25 10:09:16 -07001354 return 0
Patrick Rohr92d74122022-10-21 15:50:52 -07001355
1356
1357if __name__ == '__main__':
1358 sys.exit(main())