blob: 8a15ee1ba6489b25ba50da1945b0a4ed2c174bab [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 }),
Mohannad Farrage7d29312022-11-10 17:39:16 +0000116 ('whole_static_libs', {
117 'cronet_aml_net_third_party_quiche_quiche',
118 'cronet_aml_base_base',
119 "cronet_aml_crypto_crypto",
120 "cronet_aml_third_party_boringssl_boringssl",
121 }),
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000122 ],
123 'cronet_aml_components_cronet_android_cronet': [
124 ('rtti', True),
125 ('cppflags', {
126 # TODO: figure out if there is no way around this and if this is
127 # allowed for platform code.
128 "-fexceptions",
129 })
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800130 ]
Patrick Rohr92d74122022-10-21 15:50:52 -0700131}
132
133
134def enable_gtest_and_gmock(module):
135 module.static_libs.add('libgmock')
136 module.static_libs.add('libgtest')
137 if module.name != 'perfetto_gtest_logcat_printer':
138 module.whole_static_libs.add('perfetto_gtest_logcat_printer')
139
140
141def enable_protobuf_full(module):
142 if module.type == 'cc_binary_host':
143 module.static_libs.add('libprotobuf-cpp-full')
144 elif module.host_supported:
145 module.host.static_libs.add('libprotobuf-cpp-full')
146 module.android.shared_libs.add('libprotobuf-cpp-full')
Patrick Rohr84b16402022-11-08 19:01:01 -0800147 elif module.type not in ['genrule', 'filegroup']:
Patrick Rohr92d74122022-10-21 15:50:52 -0700148 module.shared_libs.add('libprotobuf-cpp-full')
149
150
151def enable_protobuf_lite(module):
Patrick Rohr84b16402022-11-08 19:01:01 -0800152 if module.type not in ['genrule', 'filegroup']:
153 module.shared_libs.add('libprotobuf-cpp-lite')
Patrick Rohr92d74122022-10-21 15:50:52 -0700154
155
156def enable_protoc_lib(module):
157 if module.type == 'cc_binary_host':
158 module.static_libs.add('libprotoc')
159 else:
160 module.shared_libs.add('libprotoc')
161
162
163def enable_libunwindstack(module):
164 if module.name != 'heapprofd_standalone_client':
165 module.shared_libs.add('libunwindstack')
166 module.shared_libs.add('libprocinfo')
167 module.shared_libs.add('libbase')
168 else:
169 module.static_libs.add('libunwindstack')
170 module.static_libs.add('libprocinfo')
171 module.static_libs.add('libbase')
172 module.static_libs.add('liblzma')
173 module.static_libs.add('libdexfile_support')
174 module.runtime_libs.add('libdexfile') # libdexfile_support dependency
175
176
177def enable_libunwind(module):
178 # libunwind is disabled on Darwin so we cannot depend on it.
179 pass
180
181
182def enable_sqlite(module):
183 if module.type == 'cc_binary_host':
184 module.static_libs.add('libsqlite')
185 module.static_libs.add('sqlite_ext_percentile')
186 elif module.host_supported:
187 # Copy what the sqlite3 command line tool does.
188 module.android.shared_libs.add('libsqlite')
189 module.android.shared_libs.add('libicu')
190 module.android.shared_libs.add('liblog')
191 module.android.shared_libs.add('libutils')
192 module.android.static_libs.add('sqlite_ext_percentile')
193 module.host.static_libs.add('libsqlite')
194 module.host.static_libs.add('sqlite_ext_percentile')
195 else:
196 module.shared_libs.add('libsqlite')
197 module.shared_libs.add('libicu')
198 module.shared_libs.add('liblog')
199 module.shared_libs.add('libutils')
200 module.static_libs.add('sqlite_ext_percentile')
201
202
203def enable_zlib(module):
204 if module.type == 'cc_binary_host':
205 module.static_libs.add('libz')
206 elif module.host_supported:
207 module.android.shared_libs.add('libz')
208 module.host.static_libs.add('libz')
209 else:
210 module.shared_libs.add('libz')
211
212
213def enable_uapi_headers(module):
214 module.include_dirs.add('bionic/libc/kernel')
215
216
217def enable_bionic_libc_platform_headers_on_android(module):
218 module.header_libs.add('bionic_libc_platform_headers')
219
220
221# Android equivalents for third-party libraries that the upstream project
222# depends on.
223builtin_deps = {
224 '//gn:default_deps':
225 lambda x: None,
226 '//gn:gtest_main':
227 lambda x: None,
Patrick Rohr92d74122022-10-21 15:50:52 -0700228 '//gn:gtest_and_gmock':
229 enable_gtest_and_gmock,
230 '//gn:libunwind':
231 enable_libunwind,
Patrick Rohr92d74122022-10-21 15:50:52 -0700232 '//gn:libunwindstack':
233 enable_libunwindstack,
234 '//gn:sqlite':
235 enable_sqlite,
236 '//gn:zlib':
237 enable_zlib,
238 '//gn:bionic_kernel_uapi_headers':
239 enable_uapi_headers,
240 '//src/profiling/memory:bionic_libc_platform_headers_on_android':
241 enable_bionic_libc_platform_headers_on_android,
Motomu Utsumidfc8e6a2022-11-04 18:25:33 +0900242 '//third_party/protobuf:protoc':
243 lambda x: None,
Patrick Rohr84b16402022-11-08 19:01:01 -0800244 '//third_party/protobuf:protobuf_full':
245 enable_protobuf_full,
246 '//third_party/protobuf:protobuf_lite':
247 enable_protobuf_lite,
248 '//third_party/protobuf:protoc_lib':
249 enable_protoc_lib,
Patrick Rohr92d74122022-10-21 15:50:52 -0700250}
251
252# ----------------------------------------------------------------------------
253# End of configuration.
254# ----------------------------------------------------------------------------
255
256
257class Error(Exception):
258 pass
259
260
261class ThrowingArgumentParser(argparse.ArgumentParser):
262
263 def __init__(self, context):
264 super(ThrowingArgumentParser, self).__init__()
265 self.context = context
266
267 def error(self, message):
268 raise Error('%s: %s' % (self.context, message))
269
270
271def write_blueprint_key_value(output, name, value, sort=True):
272 """Writes a Blueprint key-value pair to the output"""
273
274 if isinstance(value, bool):
275 if value:
276 output.append(' %s: true,' % name)
277 else:
278 output.append(' %s: false,' % name)
279 return
280 if not value:
281 return
282 if isinstance(value, set):
283 value = sorted(value)
284 if isinstance(value, list):
285 output.append(' %s: [' % name)
286 for item in sorted(value) if sort else value:
287 output.append(' "%s",' % item)
288 output.append(' ],')
289 return
290 if isinstance(value, Target):
291 value.to_string(output)
292 return
293 if isinstance(value, dict):
294 kv_output = []
295 for k, v in value.items():
296 write_blueprint_key_value(kv_output, k, v)
297
298 output.append(' %s: {' % name)
299 for line in kv_output:
300 output.append(' %s' % line)
301 output.append(' },')
302 return
303 output.append(' %s: "%s",' % (name, value))
304
305
306class Target(object):
307 """A target-scoped part of a module"""
308
309 def __init__(self, name):
310 self.name = name
311 self.shared_libs = set()
312 self.static_libs = set()
313 self.whole_static_libs = set()
314 self.cflags = set()
315 self.dist = dict()
316 self.strip = dict()
317 self.stl = None
318
319 def to_string(self, output):
320 nested_out = []
321 self._output_field(nested_out, 'shared_libs')
322 self._output_field(nested_out, 'static_libs')
323 self._output_field(nested_out, 'whole_static_libs')
324 self._output_field(nested_out, 'cflags')
325 self._output_field(nested_out, 'stl')
326 self._output_field(nested_out, 'dist')
327 self._output_field(nested_out, 'strip')
328
329 if nested_out:
330 output.append(' %s: {' % self.name)
331 for line in nested_out:
332 output.append(' %s' % line)
333 output.append(' },')
334
335 def _output_field(self, output, name, sort=True):
336 value = getattr(self, name)
337 return write_blueprint_key_value(output, name, value, sort)
338
339
340class Module(object):
341 """A single module (e.g., cc_binary, cc_test) in a blueprint."""
342
343 def __init__(self, mod_type, name, gn_target):
344 self.type = mod_type
345 self.gn_target = gn_target
346 self.name = name
347 self.srcs = set()
348 self.comment = 'GN: ' + gn_utils.label_without_toolchain(gn_target)
349 self.shared_libs = set()
350 self.static_libs = set()
351 self.whole_static_libs = set()
352 self.runtime_libs = set()
353 self.tools = set()
354 self.cmd = None
355 self.host_supported = False
356 self.vendor_available = False
357 self.init_rc = set()
358 self.out = set()
359 self.export_include_dirs = set()
360 self.generated_headers = set()
361 self.export_generated_headers = set()
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800362 self.export_static_lib_headers = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700363 self.defaults = set()
364 self.cflags = set()
365 self.include_dirs = set()
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900366 self.local_include_dirs = []
Patrick Rohr92d74122022-10-21 15:50:52 -0700367 self.header_libs = set()
368 self.required = set()
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700369 self.tool_files = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700370 self.android = Target('android')
371 self.host = Target('host')
Patrick Rohr92d74122022-10-21 15:50:52 -0700372 self.stl = None
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700373 self.cpp_std = None
Patrick Rohr92d74122022-10-21 15:50:52 -0700374 self.dist = dict()
375 self.strip = dict()
376 self.data = set()
377 self.apex_available = set()
378 self.min_sdk_version = None
379 self.proto = dict()
380 # The genrule_XXX below are properties that must to be propagated back
381 # on the module(s) that depend on the genrule.
382 self.genrule_headers = set()
383 self.genrule_srcs = set()
384 self.genrule_shared_libs = set()
Patrick Rohra1a27872022-10-31 11:57:14 -0700385 self.genrule_header_libs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700386 self.version_script = None
387 self.test_suites = set()
388 self.test_config = None
389 self.stubs = {}
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000390 self.cppflags = set()
391 self.rtti = False
Patrick Rohr92d74122022-10-21 15:50:52 -0700392
393 def to_string(self, output):
394 if self.comment:
395 output.append('// %s' % self.comment)
396 output.append('%s {' % self.type)
397 self._output_field(output, 'name')
398 self._output_field(output, 'srcs')
399 self._output_field(output, 'shared_libs')
400 self._output_field(output, 'static_libs')
401 self._output_field(output, 'whole_static_libs')
402 self._output_field(output, 'runtime_libs')
403 self._output_field(output, 'tools')
404 self._output_field(output, 'cmd', sort=False)
405 if self.host_supported:
406 self._output_field(output, 'host_supported')
407 if self.vendor_available:
408 self._output_field(output, 'vendor_available')
409 self._output_field(output, 'init_rc')
410 self._output_field(output, 'out')
411 self._output_field(output, 'export_include_dirs')
412 self._output_field(output, 'generated_headers')
413 self._output_field(output, 'export_generated_headers')
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800414 self._output_field(output, 'export_static_lib_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -0700415 self._output_field(output, 'defaults')
416 self._output_field(output, 'cflags')
417 self._output_field(output, 'include_dirs')
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900418 self._output_field(output, 'local_include_dirs', sort=False)
Patrick Rohr92d74122022-10-21 15:50:52 -0700419 self._output_field(output, 'header_libs')
420 self._output_field(output, 'required')
421 self._output_field(output, 'dist')
422 self._output_field(output, 'strip')
423 self._output_field(output, 'tool_files')
424 self._output_field(output, 'data')
425 self._output_field(output, 'stl')
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700426 self._output_field(output, 'cpp_std')
Patrick Rohr92d74122022-10-21 15:50:52 -0700427 self._output_field(output, 'apex_available')
428 self._output_field(output, 'min_sdk_version')
429 self._output_field(output, 'version_script')
430 self._output_field(output, 'test_suites')
431 self._output_field(output, 'test_config')
432 self._output_field(output, 'stubs')
433 self._output_field(output, 'proto')
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000434 self._output_field(output, 'cppflags')
435 if self.rtti:
436 self._output_field(output, 'rtti')
Patrick Rohr92d74122022-10-21 15:50:52 -0700437
438 target_out = []
439 self._output_field(target_out, 'android')
440 self._output_field(target_out, 'host')
441 if target_out:
442 output.append(' target: {')
443 for line in target_out:
444 output.append(' %s' % line)
445 output.append(' },')
446
Patrick Rohr92d74122022-10-21 15:50:52 -0700447 output.append('}')
448 output.append('')
449
450 def add_android_static_lib(self, lib):
451 if self.type == 'cc_binary_host':
452 raise Exception('Adding Android static lib for host tool is unsupported')
453 elif self.host_supported:
454 self.android.static_libs.add(lib)
455 else:
456 self.static_libs.add(lib)
457
458 def add_android_shared_lib(self, lib):
459 if self.type == 'cc_binary_host':
460 raise Exception('Adding Android shared lib for host tool is unsupported')
461 elif self.host_supported:
462 self.android.shared_libs.add(lib)
463 else:
464 self.shared_libs.add(lib)
465
466 def _output_field(self, output, name, sort=True):
467 value = getattr(self, name)
468 return write_blueprint_key_value(output, name, value, sort)
469
470
471class Blueprint(object):
472 """In-memory representation of an Android.bp file."""
473
474 def __init__(self):
475 self.modules = {}
476
477 def add_module(self, module):
478 """Adds a new module to the blueprint, replacing any existing module
479 with the same name.
480
481 Args:
482 module: Module instance.
483 """
484 self.modules[module.name] = module
485
486 def to_string(self, output):
Patrick Rohr23f26192022-10-25 09:45:22 -0700487 for m in sorted(self.modules.values(), key=lambda m: m.name):
Patrick Rohr92d74122022-10-21 15:50:52 -0700488 m.to_string(output)
489
490
491def label_to_module_name(label):
492 """Turn a GN label (e.g., //:perfetto_tests) into a module name."""
493 # If the label is explicibly listed in the default target list, don't prefix
494 # its name and return just the target name. This is so tools like
495 # "traceconv" stay as such in the Android tree.
496 label_without_toolchain = gn_utils.label_without_toolchain(label)
Patrick Rohr92d74122022-10-21 15:50:52 -0700497 module = re.sub(r'^//:?', '', label_without_toolchain)
498 module = re.sub(r'[^a-zA-Z0-9_]', '_', module)
499 if not module.startswith(module_prefix):
500 return module_prefix + module
501 return module
502
503
504def is_supported_source_file(name):
505 """Returns True if |name| can appear in a 'srcs' list."""
Patrick Rohrf9f3a992022-11-10 19:40:32 -0800506 return os.path.splitext(name)[1] in ['.c', '.cc', '.cpp', '.java', '.proto', '.S']
Patrick Rohr92d74122022-10-21 15:50:52 -0700507
508
509def create_proto_modules(blueprint, gn, target):
510 """Generate genrules for a proto GN target.
511
512 GN actions are used to dynamically generate files during the build. The
513 Soong equivalent is a genrule. This function turns a specific kind of
514 genrule which turns .proto files into source and header files into a pair
515 equivalent genrules.
516
517 Args:
518 blueprint: Blueprint instance which is being generated.
519 target: gn_utils.Target object.
520
521 Returns:
522 The source_genrule module.
523 """
524 assert (target.type == 'proto_library')
525
526 tools = {'aprotoc'}
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900527 cpp_out_dir = '$(genDir)/%s/%s/' % (tree_path, target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700528 target_module_name = label_to_module_name(target.name)
529
530 # In GN builds the proto path is always relative to the output directory
531 # (out/tmp.xxx).
Motomu Utsumie8457452022-11-08 18:47:51 +0900532 cmd = ['$(location aprotoc)']
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900533 cmd += ['--proto_path=%s/%s' % (tree_path, target.proto_in_dir)]
Patrick Rohr92d74122022-10-21 15:50:52 -0700534
535 if buildtools_protobuf_src in target.proto_paths:
536 cmd += ['--proto_path=%s' % android_protobuf_src]
537
538 # We don't generate any targets for source_set proto modules because
539 # they will be inlined into other modules if required.
540 if target.proto_plugin == 'source_set':
541 return None
542
543 # Descriptor targets only generate a single target.
544 if target.proto_plugin == 'descriptor':
545 out = '{}.bin'.format(target_module_name)
546
547 cmd += ['--descriptor_set_out=$(out)']
548 cmd += ['$(in)']
549
550 descriptor_module = Module('genrule', target_module_name, target.name)
551 descriptor_module.cmd = ' '.join(cmd)
552 descriptor_module.out = [out]
553 descriptor_module.tools = tools
554 blueprint.add_module(descriptor_module)
555
556 # Recursively extract the .proto files of all the dependencies and
557 # add them to srcs.
558 descriptor_module.srcs.update(
559 gn_utils.label_to_path(src) for src in target.sources)
560 for dep in target.transitive_proto_deps:
561 current_target = gn.get_target(dep)
562 descriptor_module.srcs.update(
563 gn_utils.label_to_path(src) for src in current_target.sources)
564
565 return descriptor_module
566
567 # We create two genrules for each proto target: one for the headers and
568 # another for the sources. This is because the module that depends on the
569 # generated files needs to declare two different types of dependencies --
570 # source files in 'srcs' and headers in 'generated_headers' -- and it's not
571 # valid to generate .h files from a source dependency and vice versa.
572 source_module_name = target_module_name + '_gen'
573 source_module = Module('genrule', source_module_name, target.name)
574 blueprint.add_module(source_module)
575 source_module.srcs.update(
576 gn_utils.label_to_path(src) for src in target.sources)
577
578 header_module = Module('genrule', source_module_name + '_headers',
579 target.name)
580 blueprint.add_module(header_module)
581 header_module.srcs = set(source_module.srcs)
582
583 # TODO(primiano): at some point we should remove this. This was introduced
584 # by aosp/1108421 when adding "protos/" to .proto include paths, in order to
585 # avoid doing multi-repo changes and allow old clients in the android tree
586 # to still do the old #include "perfetto/..." rather than
587 # #include "protos/perfetto/...".
588 header_module.export_include_dirs = {'.', 'protos'}
Patrick Rohr2267a0a2022-11-08 18:59:34 -0800589 # Since the .cc file and .h get created by a different gerule target, they
590 # are not put in the same intermediate path, so local includes do not work
591 # without explictily exporting the include dir.
592 header_module.export_include_dirs.add(target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700593
594 source_module.genrule_srcs.add(':' + source_module.name)
595 source_module.genrule_headers.add(header_module.name)
596
597 if target.proto_plugin == 'proto':
598 suffixes = ['pb']
599 source_module.genrule_shared_libs.add('libprotobuf-cpp-lite')
600 cmd += ['--cpp_out=lite=true:' + cpp_out_dir]
601 elif target.proto_plugin == 'protozero':
602 suffixes = ['pbzero']
603 plugin = create_modules_from_target(blueprint, gn, protozero_plugin)
604 tools.add(plugin.name)
605 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
606 cmd += ['--plugin_out=wrapper_namespace=pbzero:' + cpp_out_dir]
607 elif target.proto_plugin == 'cppgen':
608 suffixes = ['gen']
609 plugin = create_modules_from_target(blueprint, gn, cppgen_plugin)
610 tools.add(plugin.name)
611 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
612 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
613 elif target.proto_plugin == 'ipc':
614 suffixes = ['ipc']
615 plugin = create_modules_from_target(blueprint, gn, ipc_plugin)
616 tools.add(plugin.name)
617 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
618 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
619 else:
620 raise Error('Unsupported proto plugin: %s' % target.proto_plugin)
621
622 cmd += ['$(in)']
623 source_module.cmd = ' '.join(cmd)
624 header_module.cmd = source_module.cmd
625 source_module.tools = tools
626 header_module.tools = tools
627
628 for sfx in suffixes:
629 source_module.out.update('%s/%s' %
630 (tree_path, src.replace('.proto', '.%s.cc' % sfx))
631 for src in source_module.srcs)
632 header_module.out.update('%s/%s' %
633 (tree_path, src.replace('.proto', '.%s.h' % sfx))
634 for src in header_module.srcs)
635 return source_module
636
637
638def create_amalgamated_sql_metrics_module(blueprint, target):
639 bp_module_name = label_to_module_name(target.name)
640 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700641 module.tool_files.add('tools/gen_amalgamated_sql_metrics.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700642 module.cmd = ' '.join([
643 '$(location tools/gen_amalgamated_sql_metrics.py)',
644 '--cpp_out=$(out)',
645 '$(in)',
646 ])
647 module.genrule_headers.add(module.name)
648 module.out.update(target.outputs)
649 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
650 blueprint.add_module(module)
651 return module
652
653
654def create_cc_proto_descriptor_module(blueprint, target):
655 bp_module_name = label_to_module_name(target.name)
656 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700657 module.tool_files.add('tools/gen_cc_proto_descriptor.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700658 module.cmd = ' '.join([
659 '$(location tools/gen_cc_proto_descriptor.py)', '--gen_dir=$(genDir)',
660 '--cpp_out=$(out)', '$(in)'
661 ])
662 module.genrule_headers.add(module.name)
663 module.srcs.update(
664 ':' + label_to_module_name(dep) for dep in target.proto_deps)
665 module.srcs.update(
666 gn_utils.label_to_path(src)
667 for src in target.inputs
668 if "tmp.gn_utils" not in src)
669 module.out.update(target.outputs)
670 blueprint.add_module(module)
671 return module
672
673
674def create_gen_version_module(blueprint, target, bp_module_name):
675 module = Module('genrule', bp_module_name, gn_utils.GEN_VERSION_TARGET)
676 script_path = gn_utils.label_to_path(target.script)
677 module.genrule_headers.add(bp_module_name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700678 module.tool_files.add(script_path)
Patrick Rohr92d74122022-10-21 15:50:52 -0700679 module.out.update(target.outputs)
680 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
681 module.cmd = ' '.join([
682 'python3 $(location %s)' % script_path, '--no_git',
683 '--changelog=$(location CHANGELOG)', '--cpp_out=$(out)'
684 ])
685 blueprint.add_module(module)
686 return module
687
688
689def create_proto_group_modules(blueprint, gn, module_name, target_names):
690 # TODO(lalitm): today, we're only adding a Java lite module because that's
691 # the only one used in practice. In the future, if we need other target types
692 # (e.g. C++, Java full etc.) add them here.
693 bp_module_name = label_to_module_name(module_name) + '_java_protos'
694 module = Module('java_library', bp_module_name, bp_module_name)
695 module.comment = f'''GN: [{', '.join(target_names)}]'''
696 module.proto = {'type': 'lite', 'canonical_path_from_root': False}
697
698 for name in target_names:
699 target = gn.get_target(name)
700 module.srcs.update(gn_utils.label_to_path(src) for src in target.sources)
701 for dep_label in target.transitive_proto_deps:
702 dep = gn.get_target(dep_label)
703 module.srcs.update(gn_utils.label_to_path(src) for src in dep.sources)
704
705 blueprint.add_module(module)
706
Motomu Utsumia6c33152022-11-02 18:21:55 +0900707# HACK: Need to support build_cofig_gen flexibly instead of hardcoding
708# build_config_gen generates srcjar by executing gcc via gcc_preprocess.py but gcc is not
709# available in genrule sandbox. Also gcc path is not configurable.
710# Under the //net:net, gcc_preprocess.py is only used for build_config_gen.
711# So, for now, hardcoding BuildConfig.java and generates srcjar by soong_zip.
712def override_build_config_gen(module):
713 module.tool_files.clear()
714 module.tools.add("soong_zip")
715 cmd = [
716 "echo",
717 "\\\"package org.chromium.build;\\n",
718 "public class BuildConfig {\\n",
719 "public static boolean IS_MULTIDEX_ENABLED ;\\n",
720 "public static boolean ENABLE_ASSERTS = true;\\n",
721 "public static boolean IS_UBSAN ;\\n",
722 "public static boolean IS_CHROME_BRANDED ;\\n",
723 "public static int R_STRING_PRODUCT_VERSION ;\\n",
724 "public static int MIN_SDK_VERSION = 1;\\n",
725 "public static boolean BUNDLES_SUPPORTED ;\\n",
726 "public static boolean IS_INCREMENTAL_INSTALL ;\\n",
727 "public static boolean ISOLATED_SPLITS_ENABLED ;\\n",
728 "public static boolean IS_FOR_TEST ;\\n",
729 "}\\n\\\"",
730 "> $(genDir)/BuildConfig.java &&",
731 "$(location soong_zip) -o $(out) -srcjar -f $(genDir)/BuildConfig.java"
732 ]
733 NEWLINE = ' " +\n "'
734 module.cmd = NEWLINE.join(cmd)
735 return module
736
Mohannad Farragbab6c892022-11-02 14:09:46 +0000737def create_action_foreach_modules(blueprint, target):
738 """ The following assumes that rebase_path exists in the args.
739 The args of an action_foreach contains hints about which output files are generated
740 by which source files.
741 This is copied directly from the args
742 "gen/net/base/registry_controlled_domains/{{source_name_part}}-reversed-inc.cc"
743 So each source file will generate an output whose name is the {source_name-reversed-inc.cc}
744 """
745 new_args = []
Motomu Utsumi56afcac2022-11-04 12:58:30 +0900746 for i, src in enumerate(sorted(target.sources)):
Mohannad Farragbab6c892022-11-02 14:09:46 +0000747 # don't add script arg for the first source -- create_action_module
748 # already does this.
749 if i != 0:
750 new_args.append('&& python3 $(location %s)' %
751 gn_utils.label_to_path(target.script))
752 for arg in target.args:
753 if '{{source}}' in arg:
754 new_args.append('$(location %s)' % (gn_utils.label_to_path(src)))
755 elif '{{source_name_part}}' in arg:
756 source_name_part = src.split("/")[-1] # Get the file name only
757 source_name_part = source_name_part.split(".")[0] # Remove the extension (Ex: .cc)
758 file_name = arg.replace('{{source_name_part}}', source_name_part).split("/")[-1]
759 # file_name represent the output file name. But we need the whole path
760 # This can be found from target.outputs.
761 for out in target.outputs:
762 if out.endswith(file_name):
763 new_args.append('$(location %s)' % out)
764 else:
765 new_args.append(arg)
766
767 target.args = new_args
768 return create_action_module(blueprint, target)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900769
Patrick Rohr7be99032022-10-31 11:54:19 -0700770def create_action_module(blueprint, target):
771 bp_module_name = label_to_module_name(target.name)
772 module = Module('genrule', bp_module_name, target.name)
773
Patrick Rohr9b99a982022-10-28 11:00:57 -0700774 # Convert ['--param=value'] to ['--param', 'value'] for consistency.
775 # TODO: we may want to only do this for python scripts arguments. If argparse
776 # is used, this transformation is safe.
777 target.args = [str for it in target.args for str in it.split('=')]
778
Motomu Utsumibf569d42022-10-28 16:47:34 +0900779 if target.script == "//build/write_buildflag_header.py":
780 # write_buildflag_header.py writes result to args.genDir/args.output
781 # So, override args.genDir by '.' so that args.output=$(out) works
Patrick Rohrde568a22022-10-28 09:22:35 -0700782 for i, val in enumerate(target.args):
783 if val == '--gen-dir':
784 target.args[i + 1] = '.'
Patrick Rohrfa972402022-11-01 11:54:35 -0700785 elif val == '--output':
786 target.args[i + 1] = '$(out)'
787
788 elif target.script == '//build/write_build_date_header.py':
789 target.args[0] = '$(out)'
Patrick Rohr0db9f852022-10-27 13:49:57 -0700790
Patrick Rohr8acccca2022-10-28 10:39:06 -0700791 elif target.script == '//base/android/jni_generator/jni_generator.py':
Patrick Rohrc5cc21a2022-10-31 11:57:49 -0700792 # chromium builds against a prebuilt ndk that contains the jni_headers, so
793 # a dependency is never explicitly created.
794 module.genrule_header_libs.add('jni_headers')
Patrick Rohr131ba282022-10-31 16:36:20 -0700795 needs_javap = False
Patrick Rohr8acccca2022-10-28 10:39:06 -0700796 for i, val in enumerate(target.args):
Motomu Utsumi6f9139d2022-10-31 12:15:19 +0900797 if val == '--output_dir':
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700798 # replace --output_dir gen/jni_headers/... with --output_dir $(genDir)/...
799 target.args[i + 1] = re.sub('^gen/jni_headers', '$(genDir)', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700800 elif val == '--input_file':
Patrick Rohr8acccca2022-10-28 10:39:06 -0700801 # --input_file supports both .class specifiers or source files as arguments.
802 # Only source files need to be wrapped inside a $(location <label>) tag.
803 if re.match('.*\.class$', target.args[i + 1]):
804 continue
805 # replace --input_file ../../... with --input_file $(location ...)
806 # TODO: put inside function
807 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
808 target.args[i + 1] = '$(location %s)' % filename
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700809 elif val == '--includes' and 'jni_generator_helper' in target.args[i + 1]:
Patrick Rohrd89e8bf2022-10-31 14:51:05 -0700810 # delete all leading ../
811 target.args[i + 1] = re.sub('^(\.\./)+', '', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700812 elif val == '--prev_output_dir':
Patrick Rohr131ba282022-10-31 16:36:20 -0700813 # this is not needed for aosp builds.
814 target.args[i] = ''
815 target.args[i + 1] = ''
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700816 elif val == '--jar_file':
Patrick Rohr131ba282022-10-31 16:36:20 -0700817 # delete leading ../../ and add path to javap
818 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
819 target.args[i + 1] = '$(location %s)' % filename
820 needs_javap = True
821
822 if needs_javap:
823 target.args.append('--javap')
824 target.args.append('$$(find out/.path -name javap)')
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700825 # fix target.output directory to match #include statements.
826 target.outputs = [re.sub('^jni_headers/', '', out) for out in target.outputs]
Patrick Rohr8acccca2022-10-28 10:39:06 -0700827
Patrick Rohrf6d2b612022-11-09 12:30:26 -0800828 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
829 # jni_registration_generator.py pulls in some config dependencies that we
830 # do not handle. Remove them.
831 # TODO: find a better way to do this.
832 target.deps.clear()
833
Motomu Utsumied009082022-11-10 16:26:44 +0900834 target.inputs = [file for file in target.inputs if not file.startswith('//out/')]
Motomu Utsumi6b4acaa2022-11-10 16:13:24 +0900835 for i, val in enumerate(target.args):
836 if val in ['--depfile', '--srcjar-path', '--header-path']:
837 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +0900838 if val == '--sources-files':
839 target.args[i + 1] = '$(genDir)/java.sources'
Motomu Utsumi47d122f2022-11-10 17:32:23 +0900840 elif val == '--sources-exclusions':
841 # update_jni_registration_module removes them from the srcs of the module
842 # It might be better to remove sources by '--sources-exclusions'
843 target.args[i] = ''
844 target.args[i + 1] = ''
Motomu Utsumi6b4acaa2022-11-10 16:13:24 +0900845
Patrick Rohr245df582022-11-01 16:59:45 -0700846 elif target.script == '//build/android/gyp/write_build_config.py':
847 for i, val in enumerate(target.args):
848 if val == '--depfile':
849 # Depfile is not used, so no need to generate it.
850 target.args[i] = ''
851 target.args[i + 1] = ''
852 elif val in ['--deps-configs', '--bundled-srcjars']:
853 args = target.args[i + 1]
854 if args == '[]':
855 continue
856 # strip surrounding [] and split by ", "
857 args = args.strip('[]').split(', ')
858 # strip surrounding ""
859 args = [arg.strip('"') for arg in args]
860 # remove leading gen/
861 args = [re.sub('^gen/', '', arg) for arg in args]
862 # wrap filename in \"$(location filename)\"
863 args = ['\"$(location %s)\"' % arg for arg in args]
864 # join args with ", " and wrap in []
865 target.args[i + 1] = '[%s]' % ', '.join(args)
866
867 elif val == '--public-deps-configs':
868 # TODO: implement.
869 pass
870
871 elif val == '--build-config':
872 # json output of this script
873 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
874
875 elif val in ['--unprocessed-jar-path', '--interface-jar-path',
876 '--device-jar-path', '--host-jar-path']:
877 # jar path can be within sources (../../) or output generated by
878 # another genrule (obj/)
879 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
880 filename = re.sub('^obj/', '', target.args[i + 1])
881 target.args[i + 1] = '$(location %s)' % filename
882
883 elif val == '--proguard-configs':
884 args = target.args[i + 1]
885 if args == '[]':
886 continue
887 # TODO: consider adding helpers to deal with argument lists
888 # strip surrounding [] and split by ", ", then strip surrounding ""
889 args = args.strip('[]').split(', ')
890 args = [arg.strip('"') for arg in args]
891 # remove leading ../../
892 args = [re.sub('^\.\./\.\./', '', arg) for arg in args]
893 # add dependency on proguard config file, so a $(location) wrapper can be used.
894 module.tool_files.update(args)
895 # wrap filename in \"$(location filename)\"
896 args = ['$(location %s)' % arg for arg in args]
897 target.args[i + 1] = '[%s]' % ', '.join(args)
Motomu Utsumi1caa39b2022-11-02 18:38:13 +0900898 elif target.script == "//build/android/gyp/write_native_libraries_java.py":
899 for i, val in enumerate(target.args):
900 if val == '--output':
901 target.args[i + 1] = '$(out)'
Motomu Utsumi26211dc2022-11-02 19:38:47 +0900902 elif target.script == "//tools/grit/stamp_grit_sources.py":
903 target.outputs = [re.sub('^\/\/', '', out) for out in target.outputs]
904 # Directory that contains grit scripts
905 target.args[0] = '`dirname $(location tools/grit/grit.py)`'
906 # Path to the stamp file
907 target.args[1] = '$(out)'
908 # Script tries to create args[2] file but this is not in the output.
909 # Specifying file under $(genDir) so that parent directory exists.
910 # If this file is used by other module, we may need to add this file to the outputs.
911 target.args[2] = '$(genDir)/' + target.args[2].split('/')[-1]
Mohannad Farrag033c9d62022-11-07 14:55:49 +0000912 elif target.script == "//tools/grit/grit.py":
913 for i, val in enumerate(target.args):
914 if val == '-i':
915 # Delete leading ../..
916 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
917 target.args[i + 1] = '$(location %s)' % filename
918 elif val == '-o':
919 filename = re.sub('^gen/', '', target.args[i + 1])
920 if filename == "net":
921 # This is a directory not a file
922 target.args[i + 1] = '$(genDir)/net'
923 else:
924 # This is an output fil
925 target.args[i + 1] = '$(location %s)' % filename
926 elif val == '--depfile':
927 # The depfile is replaced by adding /tools/**/*.py to the tools_files
928 # This is basically just globbing all the needed sources by hardcoding.
929 module.tool_files.update([
930 "tools/grit/**/*.py",
931 "third_party/six/src/six.py" # This is not picked up by default. Must be added
932 ])
933
934 # Delete the depfile argument
935 target.args[i] = ' '
936 target.args[i + 1] = ' '
937 elif val == '--input':
938 # Delete leading ../..
939 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
940 # This is an output file so use $(location %s)
941 target.args[i + 1] = '$(location %s)' % filename
Motomu Utsumia0cc6662022-11-09 15:22:27 +0900942 elif target.script == "//net/tools/dafsa/make_dafsa.py":
943 # This script generates .cc files but source (registry_controlled_domain.cc) in the target that
944 # depends on this target includes .cc file this script generates.
945 module.genrule_headers.add(module.name)
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900946 elif target.script == "//build/util/version.py":
Motomu Utsumib0a49e42022-11-09 18:12:27 +0900947 # android_chrome_version.py is not specified in anywhere but version.py imports this file
948 module.tool_files.add('build/util/android_chrome_version.py')
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900949 for i, val in enumerate(target.args):
950 if val.startswith('../../'):
951 filename = re.sub('^\.\./\.\./', '', val)
952 target.args[i] = '$(location %s)' % filename
Motomu Utsumiee279c52022-11-09 17:46:27 +0900953 elif val == '-e':
954 # arg for -e EVAL option should be passed in -e PATCH_HI=int(PATCH)//256 format.
955 target.args[i + 1] = '%s=\'%s\'' % (target.args[i + 1], target.args[i + 2])
956 target.args[i + 2] = ''
Motomu Utsumi438f2c22022-11-09 18:16:40 +0900957 elif val == '-o':
958 target.args[i + 1] = '$(out)'
Patrick Rohr245df582022-11-01 16:59:45 -0700959
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700960 script = gn_utils.label_to_path(target.script)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700961 module.tool_files.add(script)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700962
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700963 # Handle passing parameters via response file by piping them into the script
964 # and reading them from /dev/stdin.
965 response_file = '{{response_file_name}}'
966 use_response_file = response_file in target.args
967 if use_response_file:
968 # Replace {{response_file_contents}} with /dev/stdin
969 target.args = ['/dev/stdin' if it == response_file else it for it in target.args]
970
Patrick Rohr4b0952d2022-11-01 12:42:31 -0700971 # escape " and \$ in target.args.
972 # once all actions are properly implemented, this may not be necessary anymore.
973 # TODO: is this the right place to do this?
974 target.args = [arg.replace('"', r'\"') for arg in target.args]
975 target.args = [arg.replace(r'\$', r'\\$') for arg in target.args]
976
Patrick Rohr9b99a982022-10-28 11:00:57 -0700977 # put all args on a new line for better diffs.
978 NEWLINE = ' " +\n "'
979 arg_string = NEWLINE.join(target.args)
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700980 module.cmd = '$(location %s) %s' % (script, arg_string)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700981
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700982 if use_response_file:
983 # Pipe response file contents into script
Patrick Rohr9b99a982022-10-28 11:00:57 -0700984 module.cmd = 'echo \'%s\' |%s%s' % (target.response_file_contents, NEWLINE, module.cmd)
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700985
Motomu Utsumi7e983832022-11-10 16:04:46 +0900986 if any(os.path.splitext(it)[1] == '.h' for it in target.outputs):
Patrick Rohr67f4d432022-10-26 16:04:15 -0700987 module.genrule_headers.add(bp_module_name)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700988
Patrick Rohr0db9f852022-10-27 13:49:57 -0700989 # gn treats inputs and sources for actions equally.
990 # soong only supports source files inside srcs, non-source files are added as
991 # tool_files dependency.
992 for it in target.sources or target.inputs:
993 if is_supported_source_file(it):
994 module.srcs.add(gn_utils.label_to_path(it))
995 else:
996 module.tool_files.add(gn_utils.label_to_path(it))
Patrick Rohre1a853e2022-10-26 12:31:39 -0700997
Patrick Rohr15a2c302022-10-26 15:08:57 -0700998 # Actions using template "action_with_pydeps" also put script inside inputs.
999 # TODO: it might make sense to filter inputs inside GnParser.
1000 if script in module.srcs:
1001 module.srcs.remove(script)
1002
Patrick Rohre1a853e2022-10-26 12:31:39 -07001003 module.out.update(target.outputs)
Motomu Utsumia6c33152022-11-02 18:21:55 +09001004
1005 if target.name == "//build/android:build_config_gen":
1006 module = override_build_config_gen(module)
Motomu Utsumi26211dc2022-11-02 19:38:47 +09001007 elif target.script == "//tools/grit/stamp_grit_sources.py":
1008 # stamp_grit_sources.py is not executable
1009 module.cmd = "python " + module.cmd
Mohannad Farrag18d7b512022-11-07 13:26:30 +00001010 elif target.script == "//base/android/jni_generator/jni_generator.py":
1011 # android_jar.classes should be part of the tools as it list implicit classes
1012 # for the script to generate JNI headers.
1013 module.tool_files.add("base/android/jni_generator/android_jar.classes")
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +09001014 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
Motomu Utsumi9ca466b2022-11-10 17:12:29 +09001015 # jni_registration_generator.py doesn't work with python2
1016 module.cmd = "python3 " + module.cmd
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +09001017 # Path in the original sources file does not work in genrule.
1018 # So creating sources file in cmd based on the srcs of this target.
1019 # Adding ../$(current_dir)/ to the head because jni_registration_generator.py uses the files
1020 # whose path startswith(..)
1021 commands = ["current_dir=`basename \\\`pwd\\\``;",
1022 "for f in $(in);",
1023 "do",
1024 "echo \\\"../$$current_dir/$$f\\\" >> $(genDir)/java.sources;",
1025 "done;",
1026 module.cmd]
Motomu Utsumi2a892d22022-11-10 18:03:20 +09001027
1028 # .h file jni_registration_generator.py generates has #define with directory name.
1029 # With the genrule env that contains "." which is invalid. So replace that at the end of cmd.
Mohannad Farrag7c0f0982022-11-10 14:39:49 +00001030 commands.append(";sed -i -e 's/OUT_SOONG_.TEMP_SBOX_.*_OUT/GEN/g' ")
Motomu Utsumi2a892d22022-11-10 18:03:20 +09001031 commands.append("$(genDir)/components/cronet/android/cronet_jni_registration.h")
Motomu Utsumi7bc2fcc2022-11-10 17:09:54 +09001032 module.cmd = NEWLINE.join(commands)
Motomu Utsumia6c33152022-11-02 18:21:55 +09001033
Patrick Rohre1a853e2022-10-26 12:31:39 -07001034 blueprint.add_module(module)
1035 return module
1036
1037
Patrick Rohr92d74122022-10-21 15:50:52 -07001038
1039def _get_cflags(target):
1040 cflags = {flag for flag in target.cflags if re.match(cflag_allowlist, flag)}
Motomu Utsumifa7e9262022-10-26 19:43:02 +09001041 # Consider proper allowlist or denylist if needed
1042 cflags |= set("-D%s" % define.replace("\"", "\\\"") for define in target.defines)
Patrick Rohr92d74122022-10-21 15:50:52 -07001043 return cflags
1044
1045
1046def create_modules_from_target(blueprint, gn, gn_target_name):
1047 """Generate module(s) for a given GN target.
1048
1049 Given a GN target name, generate one or more corresponding modules into a
1050 blueprint. The only case when this generates >1 module is proto libraries.
1051
1052 Args:
1053 blueprint: Blueprint instance which is being generated.
1054 gn: gn_utils.GnParser object.
1055 gn_target_name: GN target for module generation.
1056 """
1057 bp_module_name = label_to_module_name(gn_target_name)
1058 if bp_module_name in blueprint.modules:
1059 return blueprint.modules[bp_module_name]
1060 target = gn.get_target(gn_target_name)
Patrick Rohr16228942022-10-26 14:00:26 -07001061 log.info('create modules for %s (%s)', target.name, target.type)
Patrick Rohr92d74122022-10-21 15:50:52 -07001062
1063 name_without_toolchain = gn_utils.label_without_toolchain(target.name)
1064 if target.type == 'executable':
1065 if target.toolchain == gn_utils.HOST_TOOLCHAIN:
1066 module_type = 'cc_binary_host'
1067 elif target.testonly:
1068 module_type = 'cc_test'
1069 else:
1070 module_type = 'cc_binary'
1071 module = Module(module_type, bp_module_name, gn_target_name)
1072 elif target.type == 'static_library':
1073 module = Module('cc_library_static', bp_module_name, gn_target_name)
1074 elif target.type == 'shared_library':
1075 module = Module('cc_library_shared', bp_module_name, gn_target_name)
1076 elif target.type == 'source_set':
1077 module = Module('filegroup', bp_module_name, gn_target_name)
1078 elif target.type == 'group':
1079 # "group" targets are resolved recursively by gn_utils.get_target().
1080 # There's nothing we need to do at this level for them.
1081 return None
1082 elif target.type == 'proto_library':
1083 module = create_proto_modules(blueprint, gn, target)
1084 if module is None:
1085 return None
1086 elif target.type == 'action':
1087 if 'gen_amalgamated_sql_metrics' in target.name:
1088 module = create_amalgamated_sql_metrics_module(blueprint, target)
1089 elif re.match('.*gen_cc_.*_descriptor$', name_without_toolchain):
1090 module = create_cc_proto_descriptor_module(blueprint, target)
1091 elif target.type == 'action' and \
1092 name_without_toolchain == gn_utils.GEN_VERSION_TARGET:
1093 module = create_gen_version_module(blueprint, target, bp_module_name)
1094 else:
Patrick Rohre1a853e2022-10-26 12:31:39 -07001095 module = create_action_module(blueprint, target)
Mohannad Farragf076f3e2022-10-31 17:45:28 +00001096 elif target.type == 'action_foreach':
Mohannad Farragbab6c892022-11-02 14:09:46 +00001097 module = create_action_foreach_modules(blueprint, target)
Patrick Rohr59a76652022-10-26 12:36:56 -07001098 elif target.type == 'copy':
1099 # TODO: careful now! copy targets are not supported yet, but this will stop
1100 # traversing the dependency tree. For //base:base, this is not a big
1101 # problem as libicu contains the only copy target which happens to be a
1102 # leaf node.
1103 return None
Patrick Rohr92d74122022-10-21 15:50:52 -07001104 else:
1105 raise Error('Unknown target %s (%s)' % (target.name, target.type))
1106
1107 blueprint.add_module(module)
1108 module.host_supported = (name_without_toolchain in target_host_supported)
Patrick Rohr92d74122022-10-21 15:50:52 -07001109 module.init_rc = target_initrc.get(target.name, [])
1110 module.srcs.update(
1111 gn_utils.label_to_path(src)
1112 for src in target.sources
Motomu Utsumif951e502022-11-07 19:31:15 +09001113 if is_supported_source_file(src) and not src.startswith("//out/test"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001114
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001115 local_include_dirs_set = set()
Patrick Rohr92d74122022-10-21 15:50:52 -07001116 if target.type in gn_utils.LINKER_UNIT_TYPES:
1117 module.cflags.update(_get_cflags(target))
Patrick Rohrf22e9d02022-10-28 14:20:46 -07001118 # TODO: implement proper cflag parsing.
1119 for flag in target.cflags:
Patrick Rohrb8f830a2022-10-31 11:18:57 -07001120 if '-std=' in flag:
1121 module.cpp_std = flag[len('-std='):]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001122 if '-isystem' in flag:
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001123 local_include_dirs_set.add(flag[len('-isystem../../'):])
Patrick Rohrb8f830a2022-10-31 11:18:57 -07001124
Patrick Rohrd0abc2a2022-10-31 13:29:16 -07001125 # Adding local_include_dirs is necessary due to source_sets / filegroups
1126 # which do not properly propagate include directories.
1127 # Filter any directory inside //out as a) this directory does not exist for
1128 # aosp / soong builds and b) the include directory should already be
1129 # configured via library dependency.
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001130 local_include_dirs_set.update([gn_utils.label_to_path(d)
Patrick Rohrd0abc2a2022-10-31 13:29:16 -07001131 for d in target.include_dirs
1132 if not re.match('^//out/.*', d)])
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001133 module.local_include_dirs = sorted(list(local_include_dirs_set))
1134
1135 # Order matters for some targets. For example, base/time/time_exploded_icu.cc
1136 # in //base:base needs to have sysroot include after icu/source/common
1137 # include. So adding sysroot include at the end.
1138 for flag in target.cflags:
1139 if '--sysroot' in flag:
1140 module.local_include_dirs.append(flag[len('--sysroot=../../'):] + "/usr/include")
Patrick Rohr92d74122022-10-21 15:50:52 -07001141
1142 module_is_compiled = module.type not in ('genrule', 'filegroup')
1143 if module_is_compiled:
1144 # Don't try to inject library/source dependencies into genrules or
1145 # filegroups because they are not compiled in the traditional sense.
1146 module.defaults = [defaults_module]
1147 for lib in target.libs:
1148 # Generally library names should be mangled as 'libXXX', unless they
1149 # are HAL libraries (e.g., android.hardware.health@2.0) or AIDL c++ / NDK
1150 # libraries (e.g. "android.hardware.power.stats-V1-cpp")
1151 android_lib = lib if '@' in lib or "-cpp" in lib or "-ndk" in lib \
1152 else 'lib' + lib
1153 if lib in shared_library_allowlist:
1154 module.add_android_shared_lib(android_lib)
1155 if lib in static_library_allowlist:
1156 module.add_android_static_lib(android_lib)
1157
Patrick Rohrd9dd3b92022-11-09 16:15:30 -08001158 # Remove prohibited include directories
1159 module.local_include_dirs = [d for d in module.local_include_dirs
1160 if d not in local_include_dirs_denylist]
1161
1162
Patrick Rohr92d74122022-10-21 15:50:52 -07001163 # If the module is a static library, export all the generated headers.
1164 if module.type == 'cc_library_static':
1165 module.export_generated_headers = module.generated_headers
1166
Patrick Rohr92d74122022-10-21 15:50:52 -07001167 # dep_name is an unmangled GN target name (e.g. //foo:bar(toolchain)).
Motomu Utsumif1daa232022-11-08 13:28:37 +09001168 # Currently, only one module is generated from target even target has multiple toolchains.
1169 # And module is generated based on the first visited target.
1170 # Sort deps before iteration to make result deterministic.
1171 all_deps = sorted(target.deps | target.source_set_deps | target.transitive_proto_deps)
Patrick Rohr92d74122022-10-21 15:50:52 -07001172 for dep_name in all_deps:
Patrick Rohr5cc46e02022-10-26 14:32:45 -07001173 # |builtin_deps| override GN deps with Android-specific ones. See the
1174 # config in the top of this file.
1175 if gn_utils.label_without_toolchain(dep_name) in builtin_deps:
1176 builtin_deps[gn_utils.label_without_toolchain(dep_name)](module)
1177 continue
1178
Patrick Rohr92d74122022-10-21 15:50:52 -07001179 dep_module = create_modules_from_target(blueprint, gn, dep_name)
1180
Motomu Utsumie246feb2022-11-01 17:25:56 +09001181 # TODO: Proper dependency check for genrule.
1182 # Currently, only propagating genrule dependencies.
1183 # Also, currently, all the dependencies are propagated upwards.
1184 # in gn, public_deps should be propagated but deps should not.
1185 # Not sure this information is available in the desc.json.
1186 # Following rule works for adding android_runtime_jni_headers to base:base.
1187 # If this doesn't work for other target, hardcoding for specific target
1188 # might be better.
1189 if module.type == "genrule" and dep_module.type == "genrule":
1190 module.genrule_headers.add(dep_module.name)
1191 module.genrule_headers.update(dep_module.genrule_headers)
1192
Patrick Rohr92d74122022-10-21 15:50:52 -07001193 # For filegroups and genrule, recurse but don't apply the deps.
1194 if not module_is_compiled:
1195 continue
1196
Patrick Rohr92d74122022-10-21 15:50:52 -07001197 if dep_module is None:
1198 continue
1199 if dep_module.type == 'cc_library_shared':
1200 module.shared_libs.add(dep_module.name)
1201 elif dep_module.type == 'cc_library_static':
1202 module.static_libs.add(dep_module.name)
1203 elif dep_module.type == 'filegroup':
1204 module.srcs.add(':' + dep_module.name)
1205 elif dep_module.type == 'genrule':
1206 module.generated_headers.update(dep_module.genrule_headers)
1207 module.srcs.update(dep_module.genrule_srcs)
1208 module.shared_libs.update(dep_module.genrule_shared_libs)
Patrick Rohra1a27872022-10-31 11:57:14 -07001209 module.header_libs.update(dep_module.genrule_header_libs)
Patrick Rohr92d74122022-10-21 15:50:52 -07001210 elif dep_module.type == 'cc_binary':
1211 continue # Ignore executables deps (used by cmdline integration tests).
1212 else:
1213 raise Error('Unknown dep %s (%s) for target %s' %
1214 (dep_module.name, dep_module.type, module.name))
1215
1216 return module
1217
Patrick Rohrb18aca22022-11-04 15:07:32 -07001218def create_java_module(blueprint, gn):
1219 bp_module_name = module_prefix + 'java'
1220 module = Module('java_library', bp_module_name, '//gn:java')
Mohannad Farrag21562d62022-11-07 13:09:31 +00001221 module.srcs.update([gn_utils.label_to_path(source) for source in gn.java_sources])
Patrick Rohrb18aca22022-11-04 15:07:32 -07001222 blueprint.add_module(module)
Patrick Rohr92d74122022-10-21 15:50:52 -07001223
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001224def update_jni_registration_module(blueprint, gn):
1225 bp_module_name = label_to_module_name('//components/cronet/android:cronet_jni_registration')
1226 module = blueprint.modules[bp_module_name]
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001227
1228 # TODO: deny list is in the arg of jni_registration_generator.py. Should not be hardcoded
1229 deny_list = [
1230 '//base/android/java/src/org/chromium/base/library_loader/LibraryLoader.java',
1231 '//base/android/java/src/org/chromium/base/library_loader/LibraryPrefetcher.java',
1232 '//base/android/java/src/org/chromium/base/process_launcher/ChildProcessService.java',
1233 '//base/android/java/src/org/chromium/base/SysUtils.java']
1234
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001235 # TODO: java_sources might not contain all the required java files
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001236 module.srcs.update([gn_utils.label_to_path(source)
1237 for source in gn.java_sources if source not in deny_list])
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001238
Motomu Utsumi79bd0c82022-11-10 17:52:24 +09001239 # TODO: Remove hardcoded file addition to srcs
1240 # jni_registration_generator.py generates empty .h file if native methods are not found in the
1241 # java files. But android:cronet depends on `RegisterNonMainDexNatives` which is in the template
1242 # of .h file. To make script generate non empty .h file, adding java file which contains native
1243 # method. Once all the required java files are added to the srcs, this can be removed.
1244 module.srcs.update([
1245 "components/cronet/android/java/src/org/chromium/net/impl/CronetUrlRequest.java"])
1246
Patrick Rohr92d74122022-10-21 15:50:52 -07001247def create_blueprint_for_targets(gn, desc, targets):
1248 """Generate a blueprint for a list of GN targets."""
1249 blueprint = Blueprint()
1250
1251 # Default settings used by all modules.
1252 defaults = Module('cc_defaults', defaults_module, '//gn:default_deps')
Patrick Rohr92d74122022-10-21 15:50:52 -07001253 defaults.cflags = [
1254 '-Wno-error=return-type',
Patrick Rohr3a1ec1d2022-10-31 13:30:17 -07001255 '-Wno-non-virtual-dtor',
Patrick Rohr5c700022022-11-08 19:33:07 -08001256 '-Wno-macro-redefined',
Patrick Rohr98065152022-10-31 14:49:58 -07001257 '-Wno-missing-field-initializers',
Patrick Rohr92d74122022-10-21 15:50:52 -07001258 '-Wno-sign-compare',
1259 '-Wno-sign-promo',
1260 '-Wno-unused-parameter',
Mohannad Farragd98a96d2022-11-10 14:56:19 +00001261 '-Wno-deprecated-non-prototype', # needed for zlib
Patrick Rohr92d74122022-10-21 15:50:52 -07001262 '-fvisibility=hidden',
1263 '-O2',
1264 ]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001265 defaults.stl = 'none'
Patrick Rohr92d74122022-10-21 15:50:52 -07001266 blueprint.add_module(defaults)
Patrick Rohr344b2472022-10-25 11:32:15 -07001267
Patrick Rohr92d74122022-10-21 15:50:52 -07001268 for target in targets:
1269 create_modules_from_target(blueprint, gn, target)
Patrick Rohrb18aca22022-11-04 15:07:32 -07001270
1271 create_java_module(blueprint, gn)
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001272 update_jni_registration_module(blueprint, gn)
Patrick Rohra7d029d2022-11-08 12:23:11 -08001273
1274 # Merge in additional hardcoded arguments.
1275 for module in blueprint.modules.values():
1276 for key, add_val in additional_args.get(module.name, []):
1277 curr = getattr(module, key)
1278 if add_val and isinstance(add_val, set) and isinstance(curr, set):
1279 curr.update(add_val)
1280 elif isinstance(add_val, str) and (not curr or isinstance(curr, str)):
1281 setattr(module, key, add_val)
1282 elif isinstance(add_val, bool) and (not curr or isinstance(curr, bool)):
1283 setattr(module, key, add_val)
1284 elif isinstance(add_val, dict) and isinstance(curr, dict):
1285 curr.update(add_val)
1286 elif isinstance(add_val, dict) and isinstance(curr, Target):
1287 curr.__dict__.update(add_val)
1288 else:
1289 raise Error('Unimplemented type %r of additional_args: %r' %
1290 (type(add_val), key))
1291
Patrick Rohr92d74122022-10-21 15:50:52 -07001292 return blueprint
1293
1294
1295def main():
1296 parser = argparse.ArgumentParser(
1297 description='Generate Android.bp from a GN description.')
1298 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001299 '--desc',
Patrick Rohr3db246a2022-10-25 10:25:17 -07001300 help='GN description (e.g., gn desc out --format=json --all-toolchains "//*"',
1301 required=True
Patrick Rohr92d74122022-10-21 15:50:52 -07001302 )
1303 parser.add_argument(
1304 '--extras',
1305 help='Extra targets to include at the end of the Blueprint file',
1306 default=os.path.join(gn_utils.repo_root(), 'Android.bp.extras'),
1307 )
1308 parser.add_argument(
1309 '--output',
1310 help='Blueprint file to create',
1311 default=os.path.join(gn_utils.repo_root(), 'Android.bp'),
1312 )
1313 parser.add_argument(
Patrick Rohr16228942022-10-26 14:00:26 -07001314 '-v',
1315 '--verbose',
1316 help='Print debug logs.',
1317 action='store_true',
1318 )
1319 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001320 'targets',
1321 nargs=argparse.REMAINDER,
Patrick Rohr1aa504a2022-10-25 10:30:42 -07001322 help='Targets to include in the blueprint (e.g., "//:perfetto_tests")'
1323 )
Patrick Rohr92d74122022-10-21 15:50:52 -07001324 args = parser.parse_args()
1325
Patrick Rohr16228942022-10-26 14:00:26 -07001326 if args.verbose:
1327 log.basicConfig(format='%(levelname)s:%(funcName)s:%(message)s', level=log.DEBUG)
1328
Patrick Rohr3db246a2022-10-25 10:25:17 -07001329 with open(args.desc) as f:
1330 desc = json.load(f)
Patrick Rohr92d74122022-10-21 15:50:52 -07001331
1332 gn = gn_utils.GnParser(desc)
Patrick Rohr1aa504a2022-10-25 10:30:42 -07001333 blueprint = create_blueprint_for_targets(gn, desc, args.targets)
Patrick Rohr92d74122022-10-21 15:50:52 -07001334 project_root = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
1335 tool_name = os.path.relpath(os.path.abspath(__file__), project_root)
1336
Patrick Rohr92d74122022-10-21 15:50:52 -07001337 # Add any proto groups to the blueprint.
1338 for l_name, t_names in proto_groups.items():
1339 create_proto_group_modules(blueprint, gn, l_name, t_names)
1340
1341 output = [
Patrick Rohr5478b392022-10-25 09:58:50 -07001342 """// Copyright (C) 2022 The Android Open Source Project
Patrick Rohr92d74122022-10-21 15:50:52 -07001343//
1344// Licensed under the Apache License, Version 2.0 (the "License");
1345// you may not use this file except in compliance with the License.
1346// You may obtain a copy of the License at
1347//
1348// http://www.apache.org/licenses/LICENSE-2.0
1349//
1350// Unless required by applicable law or agreed to in writing, software
1351// distributed under the License is distributed on an "AS IS" BASIS,
1352// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1353// See the License for the specific language governing permissions and
1354// limitations under the License.
1355//
1356// This file is automatically generated by %s. Do not edit.
1357""" % (tool_name)
1358 ]
1359 blueprint.to_string(output)
Patrick Rohrcb98e9b2022-10-25 09:57:02 -07001360 if os.path.exists(args.extras):
1361 with open(args.extras, 'r') as r:
1362 for line in r:
1363 output.append(line.rstrip("\n\r"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001364
1365 out_files = []
1366
1367 # Generate the Android.bp file.
1368 out_files.append(args.output + '.swp')
1369 with open(out_files[-1], 'w') as f:
1370 f.write('\n'.join(output))
1371 # Text files should have a trailing EOL.
1372 f.write('\n')
1373
Patrick Rohr94693eb2022-10-25 10:09:16 -07001374 return 0
Patrick Rohr92d74122022-10-21 15:50:52 -07001375
1376
1377if __name__ == '__main__':
1378 sys.exit(main())