blob: 33a06c0ea5e198a34fd1cac191e8673fd30c9506 [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
87# Name of the module which settings such as compiler flags for all other
88# modules.
89defaults_module = module_prefix + 'defaults'
90
91# Location of the project in the Android source tree.
Patrick Rohr76ceeb52022-11-07 14:18:58 -080092tree_path = 'external/chromium_org'
Patrick Rohr92d74122022-10-21 15:50:52 -070093
94# Path for the protobuf sources in the standalone build.
95buildtools_protobuf_src = '//buildtools/protobuf/src'
96
97# Location of the protobuf src dir in the Android source tree.
98android_protobuf_src = 'external/protobuf/src'
99
100# Compiler flags which are passed through to the blueprint.
101cflag_allowlist = r'^-DPERFETTO.*$'
102
Patrick Rohr92d74122022-10-21 15:50:52 -0700103# Additional arguments to apply to Android.bp rules.
104additional_args = {
Patrick Rohr2267a0a2022-11-08 18:59:34 -0800105 # TODO: remove if not needed.
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800106 'cronet_aml_net_net': [
107 ('export_static_lib_headers', {'cronet_aml_net_third_party_quiche_quiche'}),
108 ]
Patrick Rohr92d74122022-10-21 15:50:52 -0700109}
110
111
112def enable_gtest_and_gmock(module):
113 module.static_libs.add('libgmock')
114 module.static_libs.add('libgtest')
115 if module.name != 'perfetto_gtest_logcat_printer':
116 module.whole_static_libs.add('perfetto_gtest_logcat_printer')
117
118
Patrick Rohr8344c8b92022-11-08 19:25:39 -0800119def remove_local_protobuf_include(module):
120 # remove all third_party/protobuf includes as they conflict with libprotobuf
121 # in Android.
122 module.local_include_dirs = [it for it in module.local_include_dirs
123 if not it.startswith('third_party/protobuf')]
124
125
Patrick Rohr92d74122022-10-21 15:50:52 -0700126def enable_protobuf_full(module):
Patrick Rohr8344c8b92022-11-08 19:25:39 -0800127 remove_local_protobuf_include(module)
Patrick Rohr92d74122022-10-21 15:50:52 -0700128 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 Rohr8344c8b92022-11-08 19:25:39 -0800138 remove_local_protobuf_include(module)
Patrick Rohr84b16402022-11-08 19:01:01 -0800139 if module.type not in ['genrule', 'filegroup']:
140 module.shared_libs.add('libprotobuf-cpp-lite')
Patrick Rohr92d74122022-10-21 15:50:52 -0700141
142
143def enable_protoc_lib(module):
Patrick Rohr8344c8b92022-11-08 19:25:39 -0800144 remove_local_protobuf_include(module)
Patrick Rohr92d74122022-10-21 15:50:52 -0700145 if module.type == 'cc_binary_host':
146 module.static_libs.add('libprotoc')
147 else:
148 module.shared_libs.add('libprotoc')
149
150
151def enable_libunwindstack(module):
152 if module.name != 'heapprofd_standalone_client':
153 module.shared_libs.add('libunwindstack')
154 module.shared_libs.add('libprocinfo')
155 module.shared_libs.add('libbase')
156 else:
157 module.static_libs.add('libunwindstack')
158 module.static_libs.add('libprocinfo')
159 module.static_libs.add('libbase')
160 module.static_libs.add('liblzma')
161 module.static_libs.add('libdexfile_support')
162 module.runtime_libs.add('libdexfile') # libdexfile_support dependency
163
164
165def enable_libunwind(module):
166 # libunwind is disabled on Darwin so we cannot depend on it.
167 pass
168
169
170def enable_sqlite(module):
171 if module.type == 'cc_binary_host':
172 module.static_libs.add('libsqlite')
173 module.static_libs.add('sqlite_ext_percentile')
174 elif module.host_supported:
175 # Copy what the sqlite3 command line tool does.
176 module.android.shared_libs.add('libsqlite')
177 module.android.shared_libs.add('libicu')
178 module.android.shared_libs.add('liblog')
179 module.android.shared_libs.add('libutils')
180 module.android.static_libs.add('sqlite_ext_percentile')
181 module.host.static_libs.add('libsqlite')
182 module.host.static_libs.add('sqlite_ext_percentile')
183 else:
184 module.shared_libs.add('libsqlite')
185 module.shared_libs.add('libicu')
186 module.shared_libs.add('liblog')
187 module.shared_libs.add('libutils')
188 module.static_libs.add('sqlite_ext_percentile')
189
190
191def enable_zlib(module):
192 if module.type == 'cc_binary_host':
193 module.static_libs.add('libz')
194 elif module.host_supported:
195 module.android.shared_libs.add('libz')
196 module.host.static_libs.add('libz')
197 else:
198 module.shared_libs.add('libz')
199
200
201def enable_uapi_headers(module):
202 module.include_dirs.add('bionic/libc/kernel')
203
204
205def enable_bionic_libc_platform_headers_on_android(module):
206 module.header_libs.add('bionic_libc_platform_headers')
207
208
209# Android equivalents for third-party libraries that the upstream project
210# depends on.
211builtin_deps = {
212 '//gn:default_deps':
213 lambda x: None,
214 '//gn:gtest_main':
215 lambda x: None,
Patrick Rohr92d74122022-10-21 15:50:52 -0700216 '//gn:gtest_and_gmock':
217 enable_gtest_and_gmock,
218 '//gn:libunwind':
219 enable_libunwind,
Patrick Rohr92d74122022-10-21 15:50:52 -0700220 '//gn:libunwindstack':
221 enable_libunwindstack,
222 '//gn:sqlite':
223 enable_sqlite,
224 '//gn:zlib':
225 enable_zlib,
226 '//gn:bionic_kernel_uapi_headers':
227 enable_uapi_headers,
228 '//src/profiling/memory:bionic_libc_platform_headers_on_android':
229 enable_bionic_libc_platform_headers_on_android,
Motomu Utsumidfc8e6a2022-11-04 18:25:33 +0900230 '//third_party/protobuf:protoc':
231 lambda x: None,
Patrick Rohr84b16402022-11-08 19:01:01 -0800232 '//third_party/protobuf:protobuf_full':
233 enable_protobuf_full,
234 '//third_party/protobuf:protobuf_lite':
235 enable_protobuf_lite,
236 '//third_party/protobuf:protoc_lib':
237 enable_protoc_lib,
Patrick Rohr92d74122022-10-21 15:50:52 -0700238}
239
240# ----------------------------------------------------------------------------
241# End of configuration.
242# ----------------------------------------------------------------------------
243
244
245class Error(Exception):
246 pass
247
248
249class ThrowingArgumentParser(argparse.ArgumentParser):
250
251 def __init__(self, context):
252 super(ThrowingArgumentParser, self).__init__()
253 self.context = context
254
255 def error(self, message):
256 raise Error('%s: %s' % (self.context, message))
257
258
259def write_blueprint_key_value(output, name, value, sort=True):
260 """Writes a Blueprint key-value pair to the output"""
261
262 if isinstance(value, bool):
263 if value:
264 output.append(' %s: true,' % name)
265 else:
266 output.append(' %s: false,' % name)
267 return
268 if not value:
269 return
270 if isinstance(value, set):
271 value = sorted(value)
272 if isinstance(value, list):
273 output.append(' %s: [' % name)
274 for item in sorted(value) if sort else value:
275 output.append(' "%s",' % item)
276 output.append(' ],')
277 return
278 if isinstance(value, Target):
279 value.to_string(output)
280 return
281 if isinstance(value, dict):
282 kv_output = []
283 for k, v in value.items():
284 write_blueprint_key_value(kv_output, k, v)
285
286 output.append(' %s: {' % name)
287 for line in kv_output:
288 output.append(' %s' % line)
289 output.append(' },')
290 return
291 output.append(' %s: "%s",' % (name, value))
292
293
294class Target(object):
295 """A target-scoped part of a module"""
296
297 def __init__(self, name):
298 self.name = name
299 self.shared_libs = set()
300 self.static_libs = set()
301 self.whole_static_libs = set()
302 self.cflags = set()
303 self.dist = dict()
304 self.strip = dict()
305 self.stl = None
306
307 def to_string(self, output):
308 nested_out = []
309 self._output_field(nested_out, 'shared_libs')
310 self._output_field(nested_out, 'static_libs')
311 self._output_field(nested_out, 'whole_static_libs')
312 self._output_field(nested_out, 'cflags')
313 self._output_field(nested_out, 'stl')
314 self._output_field(nested_out, 'dist')
315 self._output_field(nested_out, 'strip')
316
317 if nested_out:
318 output.append(' %s: {' % self.name)
319 for line in nested_out:
320 output.append(' %s' % line)
321 output.append(' },')
322
323 def _output_field(self, output, name, sort=True):
324 value = getattr(self, name)
325 return write_blueprint_key_value(output, name, value, sort)
326
327
328class Module(object):
329 """A single module (e.g., cc_binary, cc_test) in a blueprint."""
330
331 def __init__(self, mod_type, name, gn_target):
332 self.type = mod_type
333 self.gn_target = gn_target
334 self.name = name
335 self.srcs = set()
336 self.comment = 'GN: ' + gn_utils.label_without_toolchain(gn_target)
337 self.shared_libs = set()
338 self.static_libs = set()
339 self.whole_static_libs = set()
340 self.runtime_libs = set()
341 self.tools = set()
342 self.cmd = None
343 self.host_supported = False
344 self.vendor_available = False
345 self.init_rc = set()
346 self.out = set()
347 self.export_include_dirs = set()
348 self.generated_headers = set()
349 self.export_generated_headers = set()
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800350 self.export_static_lib_headers = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700351 self.defaults = set()
352 self.cflags = set()
353 self.include_dirs = set()
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900354 self.local_include_dirs = []
Patrick Rohr92d74122022-10-21 15:50:52 -0700355 self.header_libs = set()
356 self.required = set()
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700357 self.tool_files = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700358 self.android = Target('android')
359 self.host = Target('host')
Patrick Rohr92d74122022-10-21 15:50:52 -0700360 self.stl = None
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700361 self.cpp_std = None
Patrick Rohr92d74122022-10-21 15:50:52 -0700362 self.dist = dict()
363 self.strip = dict()
364 self.data = set()
365 self.apex_available = set()
366 self.min_sdk_version = None
367 self.proto = dict()
368 # The genrule_XXX below are properties that must to be propagated back
369 # on the module(s) that depend on the genrule.
370 self.genrule_headers = set()
371 self.genrule_srcs = set()
372 self.genrule_shared_libs = set()
Patrick Rohra1a27872022-10-31 11:57:14 -0700373 self.genrule_header_libs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700374 self.version_script = None
375 self.test_suites = set()
376 self.test_config = None
377 self.stubs = {}
378
379 def to_string(self, output):
380 if self.comment:
381 output.append('// %s' % self.comment)
382 output.append('%s {' % self.type)
383 self._output_field(output, 'name')
384 self._output_field(output, 'srcs')
385 self._output_field(output, 'shared_libs')
386 self._output_field(output, 'static_libs')
387 self._output_field(output, 'whole_static_libs')
388 self._output_field(output, 'runtime_libs')
389 self._output_field(output, 'tools')
390 self._output_field(output, 'cmd', sort=False)
391 if self.host_supported:
392 self._output_field(output, 'host_supported')
393 if self.vendor_available:
394 self._output_field(output, 'vendor_available')
395 self._output_field(output, 'init_rc')
396 self._output_field(output, 'out')
397 self._output_field(output, 'export_include_dirs')
398 self._output_field(output, 'generated_headers')
399 self._output_field(output, 'export_generated_headers')
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800400 self._output_field(output, 'export_static_lib_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -0700401 self._output_field(output, 'defaults')
402 self._output_field(output, 'cflags')
403 self._output_field(output, 'include_dirs')
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900404 self._output_field(output, 'local_include_dirs', sort=False)
Patrick Rohr92d74122022-10-21 15:50:52 -0700405 self._output_field(output, 'header_libs')
406 self._output_field(output, 'required')
407 self._output_field(output, 'dist')
408 self._output_field(output, 'strip')
409 self._output_field(output, 'tool_files')
410 self._output_field(output, 'data')
411 self._output_field(output, 'stl')
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700412 self._output_field(output, 'cpp_std')
Patrick Rohr92d74122022-10-21 15:50:52 -0700413 self._output_field(output, 'apex_available')
414 self._output_field(output, 'min_sdk_version')
415 self._output_field(output, 'version_script')
416 self._output_field(output, 'test_suites')
417 self._output_field(output, 'test_config')
418 self._output_field(output, 'stubs')
419 self._output_field(output, 'proto')
420
421 target_out = []
422 self._output_field(target_out, 'android')
423 self._output_field(target_out, 'host')
424 if target_out:
425 output.append(' target: {')
426 for line in target_out:
427 output.append(' %s' % line)
428 output.append(' },')
429
Patrick Rohr92d74122022-10-21 15:50:52 -0700430 output.append('}')
431 output.append('')
432
433 def add_android_static_lib(self, lib):
434 if self.type == 'cc_binary_host':
435 raise Exception('Adding Android static lib for host tool is unsupported')
436 elif self.host_supported:
437 self.android.static_libs.add(lib)
438 else:
439 self.static_libs.add(lib)
440
441 def add_android_shared_lib(self, lib):
442 if self.type == 'cc_binary_host':
443 raise Exception('Adding Android shared lib for host tool is unsupported')
444 elif self.host_supported:
445 self.android.shared_libs.add(lib)
446 else:
447 self.shared_libs.add(lib)
448
449 def _output_field(self, output, name, sort=True):
450 value = getattr(self, name)
451 return write_blueprint_key_value(output, name, value, sort)
452
453
454class Blueprint(object):
455 """In-memory representation of an Android.bp file."""
456
457 def __init__(self):
458 self.modules = {}
459
460 def add_module(self, module):
461 """Adds a new module to the blueprint, replacing any existing module
462 with the same name.
463
464 Args:
465 module: Module instance.
466 """
467 self.modules[module.name] = module
468
469 def to_string(self, output):
Patrick Rohr23f26192022-10-25 09:45:22 -0700470 for m in sorted(self.modules.values(), key=lambda m: m.name):
Patrick Rohr92d74122022-10-21 15:50:52 -0700471 m.to_string(output)
472
473
474def label_to_module_name(label):
475 """Turn a GN label (e.g., //:perfetto_tests) into a module name."""
476 # If the label is explicibly listed in the default target list, don't prefix
477 # its name and return just the target name. This is so tools like
478 # "traceconv" stay as such in the Android tree.
479 label_without_toolchain = gn_utils.label_without_toolchain(label)
Patrick Rohr92d74122022-10-21 15:50:52 -0700480 module = re.sub(r'^//:?', '', label_without_toolchain)
481 module = re.sub(r'[^a-zA-Z0-9_]', '_', module)
482 if not module.startswith(module_prefix):
483 return module_prefix + module
484 return module
485
486
487def is_supported_source_file(name):
488 """Returns True if |name| can appear in a 'srcs' list."""
Patrick Rohrd604f9f2022-10-27 13:56:42 -0700489 return os.path.splitext(name)[1] in ['.c', '.cc', '.java', '.proto']
Patrick Rohr92d74122022-10-21 15:50:52 -0700490
491
492def create_proto_modules(blueprint, gn, target):
493 """Generate genrules for a proto GN target.
494
495 GN actions are used to dynamically generate files during the build. The
496 Soong equivalent is a genrule. This function turns a specific kind of
497 genrule which turns .proto files into source and header files into a pair
498 equivalent genrules.
499
500 Args:
501 blueprint: Blueprint instance which is being generated.
502 target: gn_utils.Target object.
503
504 Returns:
505 The source_genrule module.
506 """
507 assert (target.type == 'proto_library')
508
509 tools = {'aprotoc'}
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900510 cpp_out_dir = '$(genDir)/%s/%s/' % (tree_path, target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700511 target_module_name = label_to_module_name(target.name)
512
513 # In GN builds the proto path is always relative to the output directory
514 # (out/tmp.xxx).
Motomu Utsumie8457452022-11-08 18:47:51 +0900515 cmd = ['$(location aprotoc)']
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900516 cmd += ['--proto_path=%s/%s' % (tree_path, target.proto_in_dir)]
Patrick Rohr92d74122022-10-21 15:50:52 -0700517
518 if buildtools_protobuf_src in target.proto_paths:
519 cmd += ['--proto_path=%s' % android_protobuf_src]
520
521 # We don't generate any targets for source_set proto modules because
522 # they will be inlined into other modules if required.
523 if target.proto_plugin == 'source_set':
524 return None
525
526 # Descriptor targets only generate a single target.
527 if target.proto_plugin == 'descriptor':
528 out = '{}.bin'.format(target_module_name)
529
530 cmd += ['--descriptor_set_out=$(out)']
531 cmd += ['$(in)']
532
533 descriptor_module = Module('genrule', target_module_name, target.name)
534 descriptor_module.cmd = ' '.join(cmd)
535 descriptor_module.out = [out]
536 descriptor_module.tools = tools
537 blueprint.add_module(descriptor_module)
538
539 # Recursively extract the .proto files of all the dependencies and
540 # add them to srcs.
541 descriptor_module.srcs.update(
542 gn_utils.label_to_path(src) for src in target.sources)
543 for dep in target.transitive_proto_deps:
544 current_target = gn.get_target(dep)
545 descriptor_module.srcs.update(
546 gn_utils.label_to_path(src) for src in current_target.sources)
547
548 return descriptor_module
549
550 # We create two genrules for each proto target: one for the headers and
551 # another for the sources. This is because the module that depends on the
552 # generated files needs to declare two different types of dependencies --
553 # source files in 'srcs' and headers in 'generated_headers' -- and it's not
554 # valid to generate .h files from a source dependency and vice versa.
555 source_module_name = target_module_name + '_gen'
556 source_module = Module('genrule', source_module_name, target.name)
557 blueprint.add_module(source_module)
558 source_module.srcs.update(
559 gn_utils.label_to_path(src) for src in target.sources)
560
561 header_module = Module('genrule', source_module_name + '_headers',
562 target.name)
563 blueprint.add_module(header_module)
564 header_module.srcs = set(source_module.srcs)
565
566 # TODO(primiano): at some point we should remove this. This was introduced
567 # by aosp/1108421 when adding "protos/" to .proto include paths, in order to
568 # avoid doing multi-repo changes and allow old clients in the android tree
569 # to still do the old #include "perfetto/..." rather than
570 # #include "protos/perfetto/...".
571 header_module.export_include_dirs = {'.', 'protos'}
Patrick Rohr2267a0a2022-11-08 18:59:34 -0800572 # Since the .cc file and .h get created by a different gerule target, they
573 # are not put in the same intermediate path, so local includes do not work
574 # without explictily exporting the include dir.
575 header_module.export_include_dirs.add(target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700576
577 source_module.genrule_srcs.add(':' + source_module.name)
578 source_module.genrule_headers.add(header_module.name)
579
580 if target.proto_plugin == 'proto':
581 suffixes = ['pb']
582 source_module.genrule_shared_libs.add('libprotobuf-cpp-lite')
583 cmd += ['--cpp_out=lite=true:' + cpp_out_dir]
584 elif target.proto_plugin == 'protozero':
585 suffixes = ['pbzero']
586 plugin = create_modules_from_target(blueprint, gn, protozero_plugin)
587 tools.add(plugin.name)
588 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
589 cmd += ['--plugin_out=wrapper_namespace=pbzero:' + cpp_out_dir]
590 elif target.proto_plugin == 'cppgen':
591 suffixes = ['gen']
592 plugin = create_modules_from_target(blueprint, gn, cppgen_plugin)
593 tools.add(plugin.name)
594 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
595 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
596 elif target.proto_plugin == 'ipc':
597 suffixes = ['ipc']
598 plugin = create_modules_from_target(blueprint, gn, ipc_plugin)
599 tools.add(plugin.name)
600 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
601 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
602 else:
603 raise Error('Unsupported proto plugin: %s' % target.proto_plugin)
604
605 cmd += ['$(in)']
606 source_module.cmd = ' '.join(cmd)
607 header_module.cmd = source_module.cmd
608 source_module.tools = tools
609 header_module.tools = tools
610
611 for sfx in suffixes:
612 source_module.out.update('%s/%s' %
613 (tree_path, src.replace('.proto', '.%s.cc' % sfx))
614 for src in source_module.srcs)
615 header_module.out.update('%s/%s' %
616 (tree_path, src.replace('.proto', '.%s.h' % sfx))
617 for src in header_module.srcs)
618 return source_module
619
620
621def create_amalgamated_sql_metrics_module(blueprint, target):
622 bp_module_name = label_to_module_name(target.name)
623 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700624 module.tool_files.add('tools/gen_amalgamated_sql_metrics.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700625 module.cmd = ' '.join([
626 '$(location tools/gen_amalgamated_sql_metrics.py)',
627 '--cpp_out=$(out)',
628 '$(in)',
629 ])
630 module.genrule_headers.add(module.name)
631 module.out.update(target.outputs)
632 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
633 blueprint.add_module(module)
634 return module
635
636
637def create_cc_proto_descriptor_module(blueprint, target):
638 bp_module_name = label_to_module_name(target.name)
639 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700640 module.tool_files.add('tools/gen_cc_proto_descriptor.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700641 module.cmd = ' '.join([
642 '$(location tools/gen_cc_proto_descriptor.py)', '--gen_dir=$(genDir)',
643 '--cpp_out=$(out)', '$(in)'
644 ])
645 module.genrule_headers.add(module.name)
646 module.srcs.update(
647 ':' + label_to_module_name(dep) for dep in target.proto_deps)
648 module.srcs.update(
649 gn_utils.label_to_path(src)
650 for src in target.inputs
651 if "tmp.gn_utils" not in src)
652 module.out.update(target.outputs)
653 blueprint.add_module(module)
654 return module
655
656
657def create_gen_version_module(blueprint, target, bp_module_name):
658 module = Module('genrule', bp_module_name, gn_utils.GEN_VERSION_TARGET)
659 script_path = gn_utils.label_to_path(target.script)
660 module.genrule_headers.add(bp_module_name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700661 module.tool_files.add(script_path)
Patrick Rohr92d74122022-10-21 15:50:52 -0700662 module.out.update(target.outputs)
663 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
664 module.cmd = ' '.join([
665 'python3 $(location %s)' % script_path, '--no_git',
666 '--changelog=$(location CHANGELOG)', '--cpp_out=$(out)'
667 ])
668 blueprint.add_module(module)
669 return module
670
671
672def create_proto_group_modules(blueprint, gn, module_name, target_names):
673 # TODO(lalitm): today, we're only adding a Java lite module because that's
674 # the only one used in practice. In the future, if we need other target types
675 # (e.g. C++, Java full etc.) add them here.
676 bp_module_name = label_to_module_name(module_name) + '_java_protos'
677 module = Module('java_library', bp_module_name, bp_module_name)
678 module.comment = f'''GN: [{', '.join(target_names)}]'''
679 module.proto = {'type': 'lite', 'canonical_path_from_root': False}
680
681 for name in target_names:
682 target = gn.get_target(name)
683 module.srcs.update(gn_utils.label_to_path(src) for src in target.sources)
684 for dep_label in target.transitive_proto_deps:
685 dep = gn.get_target(dep_label)
686 module.srcs.update(gn_utils.label_to_path(src) for src in dep.sources)
687
688 blueprint.add_module(module)
689
Motomu Utsumia6c33152022-11-02 18:21:55 +0900690# HACK: Need to support build_cofig_gen flexibly instead of hardcoding
691# build_config_gen generates srcjar by executing gcc via gcc_preprocess.py but gcc is not
692# available in genrule sandbox. Also gcc path is not configurable.
693# Under the //net:net, gcc_preprocess.py is only used for build_config_gen.
694# So, for now, hardcoding BuildConfig.java and generates srcjar by soong_zip.
695def override_build_config_gen(module):
696 module.tool_files.clear()
697 module.tools.add("soong_zip")
698 cmd = [
699 "echo",
700 "\\\"package org.chromium.build;\\n",
701 "public class BuildConfig {\\n",
702 "public static boolean IS_MULTIDEX_ENABLED ;\\n",
703 "public static boolean ENABLE_ASSERTS = true;\\n",
704 "public static boolean IS_UBSAN ;\\n",
705 "public static boolean IS_CHROME_BRANDED ;\\n",
706 "public static int R_STRING_PRODUCT_VERSION ;\\n",
707 "public static int MIN_SDK_VERSION = 1;\\n",
708 "public static boolean BUNDLES_SUPPORTED ;\\n",
709 "public static boolean IS_INCREMENTAL_INSTALL ;\\n",
710 "public static boolean ISOLATED_SPLITS_ENABLED ;\\n",
711 "public static boolean IS_FOR_TEST ;\\n",
712 "}\\n\\\"",
713 "> $(genDir)/BuildConfig.java &&",
714 "$(location soong_zip) -o $(out) -srcjar -f $(genDir)/BuildConfig.java"
715 ]
716 NEWLINE = ' " +\n "'
717 module.cmd = NEWLINE.join(cmd)
718 return module
719
Mohannad Farragbab6c892022-11-02 14:09:46 +0000720def create_action_foreach_modules(blueprint, target):
721 """ The following assumes that rebase_path exists in the args.
722 The args of an action_foreach contains hints about which output files are generated
723 by which source files.
724 This is copied directly from the args
725 "gen/net/base/registry_controlled_domains/{{source_name_part}}-reversed-inc.cc"
726 So each source file will generate an output whose name is the {source_name-reversed-inc.cc}
727 """
728 new_args = []
Motomu Utsumi56afcac2022-11-04 12:58:30 +0900729 for i, src in enumerate(sorted(target.sources)):
Mohannad Farragbab6c892022-11-02 14:09:46 +0000730 # don't add script arg for the first source -- create_action_module
731 # already does this.
732 if i != 0:
733 new_args.append('&& python3 $(location %s)' %
734 gn_utils.label_to_path(target.script))
735 for arg in target.args:
736 if '{{source}}' in arg:
737 new_args.append('$(location %s)' % (gn_utils.label_to_path(src)))
738 elif '{{source_name_part}}' in arg:
739 source_name_part = src.split("/")[-1] # Get the file name only
740 source_name_part = source_name_part.split(".")[0] # Remove the extension (Ex: .cc)
741 file_name = arg.replace('{{source_name_part}}', source_name_part).split("/")[-1]
742 # file_name represent the output file name. But we need the whole path
743 # This can be found from target.outputs.
744 for out in target.outputs:
745 if out.endswith(file_name):
746 new_args.append('$(location %s)' % out)
747 else:
748 new_args.append(arg)
749
750 target.args = new_args
751 return create_action_module(blueprint, target)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900752
Patrick Rohr7be99032022-10-31 11:54:19 -0700753def create_action_module(blueprint, target):
754 bp_module_name = label_to_module_name(target.name)
755 module = Module('genrule', bp_module_name, target.name)
756
Patrick Rohr9b99a982022-10-28 11:00:57 -0700757 # Convert ['--param=value'] to ['--param', 'value'] for consistency.
758 # TODO: we may want to only do this for python scripts arguments. If argparse
759 # is used, this transformation is safe.
760 target.args = [str for it in target.args for str in it.split('=')]
761
Motomu Utsumibf569d42022-10-28 16:47:34 +0900762 if target.script == "//build/write_buildflag_header.py":
763 # write_buildflag_header.py writes result to args.genDir/args.output
764 # So, override args.genDir by '.' so that args.output=$(out) works
Patrick Rohrde568a22022-10-28 09:22:35 -0700765 for i, val in enumerate(target.args):
766 if val == '--gen-dir':
767 target.args[i + 1] = '.'
Patrick Rohrfa972402022-11-01 11:54:35 -0700768 elif val == '--output':
769 target.args[i + 1] = '$(out)'
770
771 elif target.script == '//build/write_build_date_header.py':
772 target.args[0] = '$(out)'
Patrick Rohr0db9f852022-10-27 13:49:57 -0700773
Patrick Rohr8acccca2022-10-28 10:39:06 -0700774 elif target.script == '//base/android/jni_generator/jni_generator.py':
Patrick Rohrc5cc21a2022-10-31 11:57:49 -0700775 # chromium builds against a prebuilt ndk that contains the jni_headers, so
776 # a dependency is never explicitly created.
777 module.genrule_header_libs.add('jni_headers')
Patrick Rohr131ba282022-10-31 16:36:20 -0700778 needs_javap = False
Patrick Rohr8acccca2022-10-28 10:39:06 -0700779 for i, val in enumerate(target.args):
Motomu Utsumi6f9139d2022-10-31 12:15:19 +0900780 if val == '--output_dir':
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700781 # replace --output_dir gen/jni_headers/... with --output_dir $(genDir)/...
782 target.args[i + 1] = re.sub('^gen/jni_headers', '$(genDir)', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700783 elif val == '--input_file':
Patrick Rohr8acccca2022-10-28 10:39:06 -0700784 # --input_file supports both .class specifiers or source files as arguments.
785 # Only source files need to be wrapped inside a $(location <label>) tag.
786 if re.match('.*\.class$', target.args[i + 1]):
787 continue
788 # replace --input_file ../../... with --input_file $(location ...)
789 # TODO: put inside function
790 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
791 target.args[i + 1] = '$(location %s)' % filename
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700792 elif val == '--includes' and 'jni_generator_helper' in target.args[i + 1]:
Patrick Rohrd89e8bf2022-10-31 14:51:05 -0700793 # delete all leading ../
794 target.args[i + 1] = re.sub('^(\.\./)+', '', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700795 elif val == '--prev_output_dir':
Patrick Rohr131ba282022-10-31 16:36:20 -0700796 # this is not needed for aosp builds.
797 target.args[i] = ''
798 target.args[i + 1] = ''
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700799 elif val == '--jar_file':
Patrick Rohr131ba282022-10-31 16:36:20 -0700800 # delete leading ../../ and add path to javap
801 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
802 target.args[i + 1] = '$(location %s)' % filename
803 needs_javap = True
804
805 if needs_javap:
806 target.args.append('--javap')
807 target.args.append('$$(find out/.path -name javap)')
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700808 # fix target.output directory to match #include statements.
809 target.outputs = [re.sub('^jni_headers/', '', out) for out in target.outputs]
Patrick Rohr8acccca2022-10-28 10:39:06 -0700810
Patrick Rohrf6d2b612022-11-09 12:30:26 -0800811 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
812 # jni_registration_generator.py pulls in some config dependencies that we
813 # do not handle. Remove them.
814 # TODO: find a better way to do this.
815 target.deps.clear()
816
Patrick Rohr245df582022-11-01 16:59:45 -0700817 elif target.script == '//build/android/gyp/write_build_config.py':
818 for i, val in enumerate(target.args):
819 if val == '--depfile':
820 # Depfile is not used, so no need to generate it.
821 target.args[i] = ''
822 target.args[i + 1] = ''
823 elif val in ['--deps-configs', '--bundled-srcjars']:
824 args = target.args[i + 1]
825 if args == '[]':
826 continue
827 # strip surrounding [] and split by ", "
828 args = args.strip('[]').split(', ')
829 # strip surrounding ""
830 args = [arg.strip('"') for arg in args]
831 # remove leading gen/
832 args = [re.sub('^gen/', '', arg) for arg in args]
833 # wrap filename in \"$(location filename)\"
834 args = ['\"$(location %s)\"' % arg for arg in args]
835 # join args with ", " and wrap in []
836 target.args[i + 1] = '[%s]' % ', '.join(args)
837
838 elif val == '--public-deps-configs':
839 # TODO: implement.
840 pass
841
842 elif val == '--build-config':
843 # json output of this script
844 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
845
846 elif val in ['--unprocessed-jar-path', '--interface-jar-path',
847 '--device-jar-path', '--host-jar-path']:
848 # jar path can be within sources (../../) or output generated by
849 # another genrule (obj/)
850 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
851 filename = re.sub('^obj/', '', target.args[i + 1])
852 target.args[i + 1] = '$(location %s)' % filename
853
854 elif val == '--proguard-configs':
855 args = target.args[i + 1]
856 if args == '[]':
857 continue
858 # TODO: consider adding helpers to deal with argument lists
859 # strip surrounding [] and split by ", ", then strip surrounding ""
860 args = args.strip('[]').split(', ')
861 args = [arg.strip('"') for arg in args]
862 # remove leading ../../
863 args = [re.sub('^\.\./\.\./', '', arg) for arg in args]
864 # add dependency on proguard config file, so a $(location) wrapper can be used.
865 module.tool_files.update(args)
866 # wrap filename in \"$(location filename)\"
867 args = ['$(location %s)' % arg for arg in args]
868 target.args[i + 1] = '[%s]' % ', '.join(args)
Motomu Utsumi1caa39b2022-11-02 18:38:13 +0900869 elif target.script == "//build/android/gyp/write_native_libraries_java.py":
870 for i, val in enumerate(target.args):
871 if val == '--output':
872 target.args[i + 1] = '$(out)'
Motomu Utsumi26211dc2022-11-02 19:38:47 +0900873 elif target.script == "//tools/grit/stamp_grit_sources.py":
874 target.outputs = [re.sub('^\/\/', '', out) for out in target.outputs]
875 # Directory that contains grit scripts
876 target.args[0] = '`dirname $(location tools/grit/grit.py)`'
877 # Path to the stamp file
878 target.args[1] = '$(out)'
879 # Script tries to create args[2] file but this is not in the output.
880 # Specifying file under $(genDir) so that parent directory exists.
881 # If this file is used by other module, we may need to add this file to the outputs.
882 target.args[2] = '$(genDir)/' + target.args[2].split('/')[-1]
Mohannad Farrag033c9d62022-11-07 14:55:49 +0000883 elif target.script == "//tools/grit/grit.py":
884 for i, val in enumerate(target.args):
885 if val == '-i':
886 # Delete leading ../..
887 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
888 target.args[i + 1] = '$(location %s)' % filename
889 elif val == '-o':
890 filename = re.sub('^gen/', '', target.args[i + 1])
891 if filename == "net":
892 # This is a directory not a file
893 target.args[i + 1] = '$(genDir)/net'
894 else:
895 # This is an output fil
896 target.args[i + 1] = '$(location %s)' % filename
897 elif val == '--depfile':
898 # The depfile is replaced by adding /tools/**/*.py to the tools_files
899 # This is basically just globbing all the needed sources by hardcoding.
900 module.tool_files.update([
901 "tools/grit/**/*.py",
902 "third_party/six/src/six.py" # This is not picked up by default. Must be added
903 ])
904
905 # Delete the depfile argument
906 target.args[i] = ' '
907 target.args[i + 1] = ' '
908 elif val == '--input':
909 # Delete leading ../..
910 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
911 # This is an output file so use $(location %s)
912 target.args[i + 1] = '$(location %s)' % filename
Motomu Utsumia0cc6662022-11-09 15:22:27 +0900913 elif target.script == "//net/tools/dafsa/make_dafsa.py":
914 # This script generates .cc files but source (registry_controlled_domain.cc) in the target that
915 # depends on this target includes .cc file this script generates.
916 module.genrule_headers.add(module.name)
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900917 elif target.script == "//build/util/version.py":
Motomu Utsumib0a49e42022-11-09 18:12:27 +0900918 # android_chrome_version.py is not specified in anywhere but version.py imports this file
919 module.tool_files.add('build/util/android_chrome_version.py')
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900920 for i, val in enumerate(target.args):
921 if val.startswith('../../'):
922 filename = re.sub('^\.\./\.\./', '', val)
923 target.args[i] = '$(location %s)' % filename
Motomu Utsumiee279c52022-11-09 17:46:27 +0900924 elif val == '-e':
925 # arg for -e EVAL option should be passed in -e PATCH_HI=int(PATCH)//256 format.
926 target.args[i + 1] = '%s=\'%s\'' % (target.args[i + 1], target.args[i + 2])
927 target.args[i + 2] = ''
Motomu Utsumi438f2c22022-11-09 18:16:40 +0900928 elif val == '-o':
929 target.args[i + 1] = '$(out)'
Patrick Rohr245df582022-11-01 16:59:45 -0700930
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700931 script = gn_utils.label_to_path(target.script)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700932 module.tool_files.add(script)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700933
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700934 # Handle passing parameters via response file by piping them into the script
935 # and reading them from /dev/stdin.
936 response_file = '{{response_file_name}}'
937 use_response_file = response_file in target.args
938 if use_response_file:
939 # Replace {{response_file_contents}} with /dev/stdin
940 target.args = ['/dev/stdin' if it == response_file else it for it in target.args]
941
Patrick Rohr4b0952d2022-11-01 12:42:31 -0700942 # escape " and \$ in target.args.
943 # once all actions are properly implemented, this may not be necessary anymore.
944 # TODO: is this the right place to do this?
945 target.args = [arg.replace('"', r'\"') for arg in target.args]
946 target.args = [arg.replace(r'\$', r'\\$') for arg in target.args]
947
Patrick Rohr9b99a982022-10-28 11:00:57 -0700948 # put all args on a new line for better diffs.
949 NEWLINE = ' " +\n "'
950 arg_string = NEWLINE.join(target.args)
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700951 module.cmd = '$(location %s) %s' % (script, arg_string)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700952
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700953 if use_response_file:
954 # Pipe response file contents into script
Patrick Rohr9b99a982022-10-28 11:00:57 -0700955 module.cmd = 'echo \'%s\' |%s%s' % (target.response_file_contents, NEWLINE, module.cmd)
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700956
Patrick Rohr67f4d432022-10-26 16:04:15 -0700957 if all(os.path.splitext(it)[1] == '.h' for it in target.outputs):
958 module.genrule_headers.add(bp_module_name)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700959
Patrick Rohr0db9f852022-10-27 13:49:57 -0700960 # gn treats inputs and sources for actions equally.
961 # soong only supports source files inside srcs, non-source files are added as
962 # tool_files dependency.
963 for it in target.sources or target.inputs:
964 if is_supported_source_file(it):
965 module.srcs.add(gn_utils.label_to_path(it))
966 else:
967 module.tool_files.add(gn_utils.label_to_path(it))
Patrick Rohre1a853e2022-10-26 12:31:39 -0700968
Patrick Rohr15a2c302022-10-26 15:08:57 -0700969 # Actions using template "action_with_pydeps" also put script inside inputs.
970 # TODO: it might make sense to filter inputs inside GnParser.
971 if script in module.srcs:
972 module.srcs.remove(script)
973
Patrick Rohre1a853e2022-10-26 12:31:39 -0700974 module.out.update(target.outputs)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900975
976 if target.name == "//build/android:build_config_gen":
977 module = override_build_config_gen(module)
Motomu Utsumi26211dc2022-11-02 19:38:47 +0900978 elif target.script == "//tools/grit/stamp_grit_sources.py":
979 # stamp_grit_sources.py is not executable
980 module.cmd = "python " + module.cmd
Mohannad Farrag18d7b512022-11-07 13:26:30 +0000981 elif target.script == "//base/android/jni_generator/jni_generator.py":
982 # android_jar.classes should be part of the tools as it list implicit classes
983 # for the script to generate JNI headers.
984 module.tool_files.add("base/android/jni_generator/android_jar.classes")
Motomu Utsumia6c33152022-11-02 18:21:55 +0900985
Patrick Rohre1a853e2022-10-26 12:31:39 -0700986 blueprint.add_module(module)
987 return module
988
989
Patrick Rohr92d74122022-10-21 15:50:52 -0700990
991def _get_cflags(target):
992 cflags = {flag for flag in target.cflags if re.match(cflag_allowlist, flag)}
Motomu Utsumifa7e9262022-10-26 19:43:02 +0900993 # Consider proper allowlist or denylist if needed
994 cflags |= set("-D%s" % define.replace("\"", "\\\"") for define in target.defines)
Patrick Rohr92d74122022-10-21 15:50:52 -0700995 return cflags
996
997
998def create_modules_from_target(blueprint, gn, gn_target_name):
999 """Generate module(s) for a given GN target.
1000
1001 Given a GN target name, generate one or more corresponding modules into a
1002 blueprint. The only case when this generates >1 module is proto libraries.
1003
1004 Args:
1005 blueprint: Blueprint instance which is being generated.
1006 gn: gn_utils.GnParser object.
1007 gn_target_name: GN target for module generation.
1008 """
1009 bp_module_name = label_to_module_name(gn_target_name)
1010 if bp_module_name in blueprint.modules:
1011 return blueprint.modules[bp_module_name]
1012 target = gn.get_target(gn_target_name)
Patrick Rohr16228942022-10-26 14:00:26 -07001013 log.info('create modules for %s (%s)', target.name, target.type)
Patrick Rohr92d74122022-10-21 15:50:52 -07001014
1015 name_without_toolchain = gn_utils.label_without_toolchain(target.name)
1016 if target.type == 'executable':
1017 if target.toolchain == gn_utils.HOST_TOOLCHAIN:
1018 module_type = 'cc_binary_host'
1019 elif target.testonly:
1020 module_type = 'cc_test'
1021 else:
1022 module_type = 'cc_binary'
1023 module = Module(module_type, bp_module_name, gn_target_name)
1024 elif target.type == 'static_library':
1025 module = Module('cc_library_static', bp_module_name, gn_target_name)
1026 elif target.type == 'shared_library':
1027 module = Module('cc_library_shared', bp_module_name, gn_target_name)
1028 elif target.type == 'source_set':
1029 module = Module('filegroup', bp_module_name, gn_target_name)
1030 elif target.type == 'group':
1031 # "group" targets are resolved recursively by gn_utils.get_target().
1032 # There's nothing we need to do at this level for them.
1033 return None
1034 elif target.type == 'proto_library':
1035 module = create_proto_modules(blueprint, gn, target)
1036 if module is None:
1037 return None
1038 elif target.type == 'action':
1039 if 'gen_amalgamated_sql_metrics' in target.name:
1040 module = create_amalgamated_sql_metrics_module(blueprint, target)
1041 elif re.match('.*gen_cc_.*_descriptor$', name_without_toolchain):
1042 module = create_cc_proto_descriptor_module(blueprint, target)
1043 elif target.type == 'action' and \
1044 name_without_toolchain == gn_utils.GEN_VERSION_TARGET:
1045 module = create_gen_version_module(blueprint, target, bp_module_name)
1046 else:
Patrick Rohre1a853e2022-10-26 12:31:39 -07001047 module = create_action_module(blueprint, target)
Mohannad Farragf076f3e2022-10-31 17:45:28 +00001048 elif target.type == 'action_foreach':
Mohannad Farragbab6c892022-11-02 14:09:46 +00001049 module = create_action_foreach_modules(blueprint, target)
Patrick Rohr59a76652022-10-26 12:36:56 -07001050 elif target.type == 'copy':
1051 # TODO: careful now! copy targets are not supported yet, but this will stop
1052 # traversing the dependency tree. For //base:base, this is not a big
1053 # problem as libicu contains the only copy target which happens to be a
1054 # leaf node.
1055 return None
Patrick Rohr92d74122022-10-21 15:50:52 -07001056 else:
1057 raise Error('Unknown target %s (%s)' % (target.name, target.type))
1058
1059 blueprint.add_module(module)
1060 module.host_supported = (name_without_toolchain in target_host_supported)
Patrick Rohr92d74122022-10-21 15:50:52 -07001061 module.init_rc = target_initrc.get(target.name, [])
1062 module.srcs.update(
1063 gn_utils.label_to_path(src)
1064 for src in target.sources
Motomu Utsumif951e502022-11-07 19:31:15 +09001065 if is_supported_source_file(src) and not src.startswith("//out/test"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001066
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001067 local_include_dirs_set = set()
Patrick Rohr92d74122022-10-21 15:50:52 -07001068 if target.type in gn_utils.LINKER_UNIT_TYPES:
1069 module.cflags.update(_get_cflags(target))
Patrick Rohrf22e9d02022-10-28 14:20:46 -07001070 # TODO: implement proper cflag parsing.
1071 for flag in target.cflags:
Patrick Rohrb8f830a2022-10-31 11:18:57 -07001072 if '-std=' in flag:
1073 module.cpp_std = flag[len('-std='):]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001074 if '-isystem' in flag:
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001075 local_include_dirs_set.add(flag[len('-isystem../../'):])
Patrick Rohrb8f830a2022-10-31 11:18:57 -07001076
Patrick Rohrd0abc2a2022-10-31 13:29:16 -07001077 # Adding local_include_dirs is necessary due to source_sets / filegroups
1078 # which do not properly propagate include directories.
1079 # Filter any directory inside //out as a) this directory does not exist for
1080 # aosp / soong builds and b) the include directory should already be
1081 # configured via library dependency.
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001082 local_include_dirs_set.update([gn_utils.label_to_path(d)
Patrick Rohrd0abc2a2022-10-31 13:29:16 -07001083 for d in target.include_dirs
1084 if not re.match('^//out/.*', d)])
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001085 module.local_include_dirs = sorted(list(local_include_dirs_set))
1086
1087 # Order matters for some targets. For example, base/time/time_exploded_icu.cc
1088 # in //base:base needs to have sysroot include after icu/source/common
1089 # include. So adding sysroot include at the end.
1090 for flag in target.cflags:
1091 if '--sysroot' in flag:
1092 module.local_include_dirs.append(flag[len('--sysroot=../../'):] + "/usr/include")
Patrick Rohr92d74122022-10-21 15:50:52 -07001093
1094 module_is_compiled = module.type not in ('genrule', 'filegroup')
1095 if module_is_compiled:
1096 # Don't try to inject library/source dependencies into genrules or
1097 # filegroups because they are not compiled in the traditional sense.
1098 module.defaults = [defaults_module]
1099 for lib in target.libs:
1100 # Generally library names should be mangled as 'libXXX', unless they
1101 # are HAL libraries (e.g., android.hardware.health@2.0) or AIDL c++ / NDK
1102 # libraries (e.g. "android.hardware.power.stats-V1-cpp")
1103 android_lib = lib if '@' in lib or "-cpp" in lib or "-ndk" in lib \
1104 else 'lib' + lib
1105 if lib in shared_library_allowlist:
1106 module.add_android_shared_lib(android_lib)
1107 if lib in static_library_allowlist:
1108 module.add_android_static_lib(android_lib)
1109
1110 # If the module is a static library, export all the generated headers.
1111 if module.type == 'cc_library_static':
1112 module.export_generated_headers = module.generated_headers
1113
Patrick Rohr92d74122022-10-21 15:50:52 -07001114 # dep_name is an unmangled GN target name (e.g. //foo:bar(toolchain)).
Motomu Utsumif1daa232022-11-08 13:28:37 +09001115 # Currently, only one module is generated from target even target has multiple toolchains.
1116 # And module is generated based on the first visited target.
1117 # Sort deps before iteration to make result deterministic.
1118 all_deps = sorted(target.deps | target.source_set_deps | target.transitive_proto_deps)
Patrick Rohr92d74122022-10-21 15:50:52 -07001119 for dep_name in all_deps:
Patrick Rohr5cc46e02022-10-26 14:32:45 -07001120 # |builtin_deps| override GN deps with Android-specific ones. See the
1121 # config in the top of this file.
1122 if gn_utils.label_without_toolchain(dep_name) in builtin_deps:
1123 builtin_deps[gn_utils.label_without_toolchain(dep_name)](module)
1124 continue
1125
Patrick Rohr92d74122022-10-21 15:50:52 -07001126 dep_module = create_modules_from_target(blueprint, gn, dep_name)
1127
Motomu Utsumie246feb2022-11-01 17:25:56 +09001128 # TODO: Proper dependency check for genrule.
1129 # Currently, only propagating genrule dependencies.
1130 # Also, currently, all the dependencies are propagated upwards.
1131 # in gn, public_deps should be propagated but deps should not.
1132 # Not sure this information is available in the desc.json.
1133 # Following rule works for adding android_runtime_jni_headers to base:base.
1134 # If this doesn't work for other target, hardcoding for specific target
1135 # might be better.
1136 if module.type == "genrule" and dep_module.type == "genrule":
1137 module.genrule_headers.add(dep_module.name)
1138 module.genrule_headers.update(dep_module.genrule_headers)
1139
Patrick Rohr92d74122022-10-21 15:50:52 -07001140 # For filegroups and genrule, recurse but don't apply the deps.
1141 if not module_is_compiled:
1142 continue
1143
Patrick Rohr92d74122022-10-21 15:50:52 -07001144 if dep_module is None:
1145 continue
1146 if dep_module.type == 'cc_library_shared':
1147 module.shared_libs.add(dep_module.name)
1148 elif dep_module.type == 'cc_library_static':
1149 module.static_libs.add(dep_module.name)
1150 elif dep_module.type == 'filegroup':
1151 module.srcs.add(':' + dep_module.name)
1152 elif dep_module.type == 'genrule':
1153 module.generated_headers.update(dep_module.genrule_headers)
1154 module.srcs.update(dep_module.genrule_srcs)
1155 module.shared_libs.update(dep_module.genrule_shared_libs)
Patrick Rohra1a27872022-10-31 11:57:14 -07001156 module.header_libs.update(dep_module.genrule_header_libs)
Patrick Rohr92d74122022-10-21 15:50:52 -07001157 elif dep_module.type == 'cc_binary':
1158 continue # Ignore executables deps (used by cmdline integration tests).
1159 else:
1160 raise Error('Unknown dep %s (%s) for target %s' %
1161 (dep_module.name, dep_module.type, module.name))
1162
1163 return module
1164
Patrick Rohrb18aca22022-11-04 15:07:32 -07001165def create_java_module(blueprint, gn):
1166 bp_module_name = module_prefix + 'java'
1167 module = Module('java_library', bp_module_name, '//gn:java')
Mohannad Farrag21562d62022-11-07 13:09:31 +00001168 module.srcs.update([gn_utils.label_to_path(source) for source in gn.java_sources])
Patrick Rohrb18aca22022-11-04 15:07:32 -07001169 blueprint.add_module(module)
Patrick Rohr92d74122022-10-21 15:50:52 -07001170
1171def create_blueprint_for_targets(gn, desc, targets):
1172 """Generate a blueprint for a list of GN targets."""
1173 blueprint = Blueprint()
1174
1175 # Default settings used by all modules.
1176 defaults = Module('cc_defaults', defaults_module, '//gn:default_deps')
Patrick Rohr92d74122022-10-21 15:50:52 -07001177 defaults.cflags = [
1178 '-Wno-error=return-type',
Patrick Rohr3a1ec1d2022-10-31 13:30:17 -07001179 '-Wno-non-virtual-dtor',
Patrick Rohr5c700022022-11-08 19:33:07 -08001180 '-Wno-macro-redefined',
Patrick Rohr98065152022-10-31 14:49:58 -07001181 '-Wno-missing-field-initializers',
Patrick Rohr92d74122022-10-21 15:50:52 -07001182 '-Wno-sign-compare',
1183 '-Wno-sign-promo',
1184 '-Wno-unused-parameter',
1185 '-fvisibility=hidden',
1186 '-O2',
1187 ]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001188 defaults.stl = 'none'
Patrick Rohr92d74122022-10-21 15:50:52 -07001189 blueprint.add_module(defaults)
Patrick Rohr344b2472022-10-25 11:32:15 -07001190
Patrick Rohr92d74122022-10-21 15:50:52 -07001191 for target in targets:
1192 create_modules_from_target(blueprint, gn, target)
Patrick Rohrb18aca22022-11-04 15:07:32 -07001193
1194 create_java_module(blueprint, gn)
Patrick Rohra7d029d2022-11-08 12:23:11 -08001195
1196 # Merge in additional hardcoded arguments.
1197 for module in blueprint.modules.values():
1198 for key, add_val in additional_args.get(module.name, []):
1199 curr = getattr(module, key)
1200 if add_val and isinstance(add_val, set) and isinstance(curr, set):
1201 curr.update(add_val)
1202 elif isinstance(add_val, str) and (not curr or isinstance(curr, str)):
1203 setattr(module, key, add_val)
1204 elif isinstance(add_val, bool) and (not curr or isinstance(curr, bool)):
1205 setattr(module, key, add_val)
1206 elif isinstance(add_val, dict) and isinstance(curr, dict):
1207 curr.update(add_val)
1208 elif isinstance(add_val, dict) and isinstance(curr, Target):
1209 curr.__dict__.update(add_val)
1210 else:
1211 raise Error('Unimplemented type %r of additional_args: %r' %
1212 (type(add_val), key))
1213
Patrick Rohr92d74122022-10-21 15:50:52 -07001214 return blueprint
1215
1216
1217def main():
1218 parser = argparse.ArgumentParser(
1219 description='Generate Android.bp from a GN description.')
1220 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001221 '--desc',
Patrick Rohr3db246a2022-10-25 10:25:17 -07001222 help='GN description (e.g., gn desc out --format=json --all-toolchains "//*"',
1223 required=True
Patrick Rohr92d74122022-10-21 15:50:52 -07001224 )
1225 parser.add_argument(
1226 '--extras',
1227 help='Extra targets to include at the end of the Blueprint file',
1228 default=os.path.join(gn_utils.repo_root(), 'Android.bp.extras'),
1229 )
1230 parser.add_argument(
1231 '--output',
1232 help='Blueprint file to create',
1233 default=os.path.join(gn_utils.repo_root(), 'Android.bp'),
1234 )
1235 parser.add_argument(
Patrick Rohr16228942022-10-26 14:00:26 -07001236 '-v',
1237 '--verbose',
1238 help='Print debug logs.',
1239 action='store_true',
1240 )
1241 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001242 'targets',
1243 nargs=argparse.REMAINDER,
Patrick Rohr1aa504a2022-10-25 10:30:42 -07001244 help='Targets to include in the blueprint (e.g., "//:perfetto_tests")'
1245 )
Patrick Rohr92d74122022-10-21 15:50:52 -07001246 args = parser.parse_args()
1247
Patrick Rohr16228942022-10-26 14:00:26 -07001248 if args.verbose:
1249 log.basicConfig(format='%(levelname)s:%(funcName)s:%(message)s', level=log.DEBUG)
1250
Patrick Rohr3db246a2022-10-25 10:25:17 -07001251 with open(args.desc) as f:
1252 desc = json.load(f)
Patrick Rohr92d74122022-10-21 15:50:52 -07001253
1254 gn = gn_utils.GnParser(desc)
Patrick Rohr1aa504a2022-10-25 10:30:42 -07001255 blueprint = create_blueprint_for_targets(gn, desc, args.targets)
Patrick Rohr92d74122022-10-21 15:50:52 -07001256 project_root = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
1257 tool_name = os.path.relpath(os.path.abspath(__file__), project_root)
1258
Patrick Rohr92d74122022-10-21 15:50:52 -07001259 # Add any proto groups to the blueprint.
1260 for l_name, t_names in proto_groups.items():
1261 create_proto_group_modules(blueprint, gn, l_name, t_names)
1262
1263 output = [
Patrick Rohr5478b392022-10-25 09:58:50 -07001264 """// Copyright (C) 2022 The Android Open Source Project
Patrick Rohr92d74122022-10-21 15:50:52 -07001265//
1266// Licensed under the Apache License, Version 2.0 (the "License");
1267// you may not use this file except in compliance with the License.
1268// You may obtain a copy of the License at
1269//
1270// http://www.apache.org/licenses/LICENSE-2.0
1271//
1272// Unless required by applicable law or agreed to in writing, software
1273// distributed under the License is distributed on an "AS IS" BASIS,
1274// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1275// See the License for the specific language governing permissions and
1276// limitations under the License.
1277//
1278// This file is automatically generated by %s. Do not edit.
1279""" % (tool_name)
1280 ]
1281 blueprint.to_string(output)
Patrick Rohrcb98e9b2022-10-25 09:57:02 -07001282 if os.path.exists(args.extras):
1283 with open(args.extras, 'r') as r:
1284 for line in r:
1285 output.append(line.rstrip("\n\r"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001286
1287 out_files = []
1288
1289 # Generate the Android.bp file.
1290 out_files.append(args.output + '.swp')
1291 with open(out_files[-1], 'w') as f:
1292 f.write('\n'.join(output))
1293 # Text files should have a trailing EOL.
1294 f.write('\n')
1295
Patrick Rohr94693eb2022-10-25 10:09:16 -07001296 return 0
Patrick Rohr92d74122022-10-21 15:50:52 -07001297
1298
1299if __name__ == '__main__':
1300 sys.exit(main())