blob: b616db10b82b431ce4b9988acbe377085d56069c [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
35
36import gn_utils
37
Patrick Rohr92d74122022-10-21 15:50:52 -070038ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
39
Patrick Rohr92d74122022-10-21 15:50:52 -070040# Defines a custom init_rc argument to be applied to the corresponding output
41# blueprint target.
42target_initrc = {
Patrick Rohrc36ef422022-10-25 10:38:05 -070043 # TODO: this can probably be removed.
Patrick Rohr92d74122022-10-21 15:50:52 -070044}
45
46target_host_supported = [
Patrick Rohrdc383942022-10-25 10:45:29 -070047 # TODO: remove if this is not useful for the cronet build.
Patrick Rohr92d74122022-10-21 15:50:52 -070048]
49
Patrick Rohr92d74122022-10-21 15:50:52 -070050# Proto target groups which will be made public.
51proto_groups = {
Patrick Rohr95212a22022-10-25 09:53:13 -070052 # TODO: remove if this is not used for the cronet build.
Patrick Rohr92d74122022-10-21 15:50:52 -070053}
54
55# All module names are prefixed with this string to avoid collisions.
Patrick Rohr61b2bad2022-10-25 10:49:20 -070056module_prefix = 'cronet_aml_'
Patrick Rohr92d74122022-10-21 15:50:52 -070057
58# Shared libraries which are directly translated to Android system equivalents.
59shared_library_allowlist = [
60 'android',
61 'android.hardware.atrace@1.0',
62 'android.hardware.health@2.0',
63 'android.hardware.health-V1-ndk',
64 'android.hardware.power.stats@1.0',
65 "android.hardware.power.stats-V1-cpp",
66 'base',
67 'binder',
68 'binder_ndk',
69 'cutils',
70 'hidlbase',
71 'hidltransport',
72 'hwbinder',
73 'incident',
74 'log',
75 'services',
76 'statssocket',
77 "tracingproxy",
78 'utils',
79]
80
81# Static libraries which are directly translated to Android system equivalents.
82static_library_allowlist = [
83 'statslog_perfetto',
84]
85
86# Name of the module which settings such as compiler flags for all other
87# modules.
88defaults_module = module_prefix + 'defaults'
89
90# Location of the project in the Android source tree.
91tree_path = 'external/perfetto'
92
93# Path for the protobuf sources in the standalone build.
94buildtools_protobuf_src = '//buildtools/protobuf/src'
95
96# Location of the protobuf src dir in the Android source tree.
97android_protobuf_src = 'external/protobuf/src'
98
99# Compiler flags which are passed through to the blueprint.
100cflag_allowlist = r'^-DPERFETTO.*$'
101
Patrick Rohr92d74122022-10-21 15:50:52 -0700102# Additional arguments to apply to Android.bp rules.
103additional_args = {
Patrick Rohr29ba3052022-10-25 11:30:49 -0700104 # TODO: remove if this is not useful for the cronet build.
105 # Consider using additional_args for overriding the genrule cmd property for gn actions.
Patrick Rohr92d74122022-10-21 15:50:52 -0700106}
107
108
109def enable_gtest_and_gmock(module):
110 module.static_libs.add('libgmock')
111 module.static_libs.add('libgtest')
112 if module.name != 'perfetto_gtest_logcat_printer':
113 module.whole_static_libs.add('perfetto_gtest_logcat_printer')
114
115
116def enable_protobuf_full(module):
117 if module.type == 'cc_binary_host':
118 module.static_libs.add('libprotobuf-cpp-full')
119 elif module.host_supported:
120 module.host.static_libs.add('libprotobuf-cpp-full')
121 module.android.shared_libs.add('libprotobuf-cpp-full')
122 else:
123 module.shared_libs.add('libprotobuf-cpp-full')
124
125
126def enable_protobuf_lite(module):
127 module.shared_libs.add('libprotobuf-cpp-lite')
128
129
130def enable_protoc_lib(module):
131 if module.type == 'cc_binary_host':
132 module.static_libs.add('libprotoc')
133 else:
134 module.shared_libs.add('libprotoc')
135
136
137def enable_libunwindstack(module):
138 if module.name != 'heapprofd_standalone_client':
139 module.shared_libs.add('libunwindstack')
140 module.shared_libs.add('libprocinfo')
141 module.shared_libs.add('libbase')
142 else:
143 module.static_libs.add('libunwindstack')
144 module.static_libs.add('libprocinfo')
145 module.static_libs.add('libbase')
146 module.static_libs.add('liblzma')
147 module.static_libs.add('libdexfile_support')
148 module.runtime_libs.add('libdexfile') # libdexfile_support dependency
149
150
151def enable_libunwind(module):
152 # libunwind is disabled on Darwin so we cannot depend on it.
153 pass
154
155
156def enable_sqlite(module):
157 if module.type == 'cc_binary_host':
158 module.static_libs.add('libsqlite')
159 module.static_libs.add('sqlite_ext_percentile')
160 elif module.host_supported:
161 # Copy what the sqlite3 command line tool does.
162 module.android.shared_libs.add('libsqlite')
163 module.android.shared_libs.add('libicu')
164 module.android.shared_libs.add('liblog')
165 module.android.shared_libs.add('libutils')
166 module.android.static_libs.add('sqlite_ext_percentile')
167 module.host.static_libs.add('libsqlite')
168 module.host.static_libs.add('sqlite_ext_percentile')
169 else:
170 module.shared_libs.add('libsqlite')
171 module.shared_libs.add('libicu')
172 module.shared_libs.add('liblog')
173 module.shared_libs.add('libutils')
174 module.static_libs.add('sqlite_ext_percentile')
175
176
177def enable_zlib(module):
178 if module.type == 'cc_binary_host':
179 module.static_libs.add('libz')
180 elif module.host_supported:
181 module.android.shared_libs.add('libz')
182 module.host.static_libs.add('libz')
183 else:
184 module.shared_libs.add('libz')
185
186
187def enable_uapi_headers(module):
188 module.include_dirs.add('bionic/libc/kernel')
189
190
191def enable_bionic_libc_platform_headers_on_android(module):
192 module.header_libs.add('bionic_libc_platform_headers')
193
194
195# Android equivalents for third-party libraries that the upstream project
196# depends on.
197builtin_deps = {
198 '//gn:default_deps':
199 lambda x: None,
200 '//gn:gtest_main':
201 lambda x: None,
202 '//gn:protoc':
203 lambda x: None,
204 '//gn:gtest_and_gmock':
205 enable_gtest_and_gmock,
206 '//gn:libunwind':
207 enable_libunwind,
208 '//gn:protobuf_full':
209 enable_protobuf_full,
210 '//gn:protobuf_lite':
211 enable_protobuf_lite,
212 '//gn:protoc_lib':
213 enable_protoc_lib,
214 '//gn:libunwindstack':
215 enable_libunwindstack,
216 '//gn:sqlite':
217 enable_sqlite,
218 '//gn:zlib':
219 enable_zlib,
220 '//gn:bionic_kernel_uapi_headers':
221 enable_uapi_headers,
222 '//src/profiling/memory:bionic_libc_platform_headers_on_android':
223 enable_bionic_libc_platform_headers_on_android,
224}
225
226# ----------------------------------------------------------------------------
227# End of configuration.
228# ----------------------------------------------------------------------------
229
230
231class Error(Exception):
232 pass
233
234
235class ThrowingArgumentParser(argparse.ArgumentParser):
236
237 def __init__(self, context):
238 super(ThrowingArgumentParser, self).__init__()
239 self.context = context
240
241 def error(self, message):
242 raise Error('%s: %s' % (self.context, message))
243
244
245def write_blueprint_key_value(output, name, value, sort=True):
246 """Writes a Blueprint key-value pair to the output"""
247
248 if isinstance(value, bool):
249 if value:
250 output.append(' %s: true,' % name)
251 else:
252 output.append(' %s: false,' % name)
253 return
254 if not value:
255 return
256 if isinstance(value, set):
257 value = sorted(value)
258 if isinstance(value, list):
259 output.append(' %s: [' % name)
260 for item in sorted(value) if sort else value:
261 output.append(' "%s",' % item)
262 output.append(' ],')
263 return
264 if isinstance(value, Target):
265 value.to_string(output)
266 return
267 if isinstance(value, dict):
268 kv_output = []
269 for k, v in value.items():
270 write_blueprint_key_value(kv_output, k, v)
271
272 output.append(' %s: {' % name)
273 for line in kv_output:
274 output.append(' %s' % line)
275 output.append(' },')
276 return
277 output.append(' %s: "%s",' % (name, value))
278
279
280class Target(object):
281 """A target-scoped part of a module"""
282
283 def __init__(self, name):
284 self.name = name
285 self.shared_libs = set()
286 self.static_libs = set()
287 self.whole_static_libs = set()
288 self.cflags = set()
289 self.dist = dict()
290 self.strip = dict()
291 self.stl = None
292
293 def to_string(self, output):
294 nested_out = []
295 self._output_field(nested_out, 'shared_libs')
296 self._output_field(nested_out, 'static_libs')
297 self._output_field(nested_out, 'whole_static_libs')
298 self._output_field(nested_out, 'cflags')
299 self._output_field(nested_out, 'stl')
300 self._output_field(nested_out, 'dist')
301 self._output_field(nested_out, 'strip')
302
303 if nested_out:
304 output.append(' %s: {' % self.name)
305 for line in nested_out:
306 output.append(' %s' % line)
307 output.append(' },')
308
309 def _output_field(self, output, name, sort=True):
310 value = getattr(self, name)
311 return write_blueprint_key_value(output, name, value, sort)
312
313
314class Module(object):
315 """A single module (e.g., cc_binary, cc_test) in a blueprint."""
316
317 def __init__(self, mod_type, name, gn_target):
318 self.type = mod_type
319 self.gn_target = gn_target
320 self.name = name
321 self.srcs = set()
322 self.comment = 'GN: ' + gn_utils.label_without_toolchain(gn_target)
323 self.shared_libs = set()
324 self.static_libs = set()
325 self.whole_static_libs = set()
326 self.runtime_libs = set()
327 self.tools = set()
328 self.cmd = None
329 self.host_supported = False
330 self.vendor_available = False
331 self.init_rc = set()
332 self.out = set()
333 self.export_include_dirs = set()
334 self.generated_headers = set()
335 self.export_generated_headers = set()
336 self.defaults = set()
337 self.cflags = set()
338 self.include_dirs = set()
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900339 self.local_include_dirs = []
Patrick Rohr92d74122022-10-21 15:50:52 -0700340 self.header_libs = set()
341 self.required = set()
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700342 self.tool_files = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700343 self.android = Target('android')
344 self.host = Target('host')
Patrick Rohr92d74122022-10-21 15:50:52 -0700345 self.stl = None
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700346 self.cpp_std = None
Patrick Rohr92d74122022-10-21 15:50:52 -0700347 self.dist = dict()
348 self.strip = dict()
349 self.data = set()
350 self.apex_available = set()
351 self.min_sdk_version = None
352 self.proto = dict()
353 # The genrule_XXX below are properties that must to be propagated back
354 # on the module(s) that depend on the genrule.
355 self.genrule_headers = set()
356 self.genrule_srcs = set()
357 self.genrule_shared_libs = set()
Patrick Rohra1a27872022-10-31 11:57:14 -0700358 self.genrule_header_libs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700359 self.version_script = None
360 self.test_suites = set()
361 self.test_config = None
362 self.stubs = {}
363
364 def to_string(self, output):
365 if self.comment:
366 output.append('// %s' % self.comment)
367 output.append('%s {' % self.type)
368 self._output_field(output, 'name')
369 self._output_field(output, 'srcs')
370 self._output_field(output, 'shared_libs')
371 self._output_field(output, 'static_libs')
372 self._output_field(output, 'whole_static_libs')
373 self._output_field(output, 'runtime_libs')
374 self._output_field(output, 'tools')
375 self._output_field(output, 'cmd', sort=False)
376 if self.host_supported:
377 self._output_field(output, 'host_supported')
378 if self.vendor_available:
379 self._output_field(output, 'vendor_available')
380 self._output_field(output, 'init_rc')
381 self._output_field(output, 'out')
382 self._output_field(output, 'export_include_dirs')
383 self._output_field(output, 'generated_headers')
384 self._output_field(output, 'export_generated_headers')
385 self._output_field(output, 'defaults')
386 self._output_field(output, 'cflags')
387 self._output_field(output, 'include_dirs')
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900388 self._output_field(output, 'local_include_dirs', sort=False)
Patrick Rohr92d74122022-10-21 15:50:52 -0700389 self._output_field(output, 'header_libs')
390 self._output_field(output, 'required')
391 self._output_field(output, 'dist')
392 self._output_field(output, 'strip')
393 self._output_field(output, 'tool_files')
394 self._output_field(output, 'data')
395 self._output_field(output, 'stl')
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700396 self._output_field(output, 'cpp_std')
Patrick Rohr92d74122022-10-21 15:50:52 -0700397 self._output_field(output, 'apex_available')
398 self._output_field(output, 'min_sdk_version')
399 self._output_field(output, 'version_script')
400 self._output_field(output, 'test_suites')
401 self._output_field(output, 'test_config')
402 self._output_field(output, 'stubs')
403 self._output_field(output, 'proto')
404
405 target_out = []
406 self._output_field(target_out, 'android')
407 self._output_field(target_out, 'host')
408 if target_out:
409 output.append(' target: {')
410 for line in target_out:
411 output.append(' %s' % line)
412 output.append(' },')
413
Patrick Rohr92d74122022-10-21 15:50:52 -0700414 output.append('}')
415 output.append('')
416
417 def add_android_static_lib(self, lib):
418 if self.type == 'cc_binary_host':
419 raise Exception('Adding Android static lib for host tool is unsupported')
420 elif self.host_supported:
421 self.android.static_libs.add(lib)
422 else:
423 self.static_libs.add(lib)
424
425 def add_android_shared_lib(self, lib):
426 if self.type == 'cc_binary_host':
427 raise Exception('Adding Android shared lib for host tool is unsupported')
428 elif self.host_supported:
429 self.android.shared_libs.add(lib)
430 else:
431 self.shared_libs.add(lib)
432
433 def _output_field(self, output, name, sort=True):
434 value = getattr(self, name)
435 return write_blueprint_key_value(output, name, value, sort)
436
437
438class Blueprint(object):
439 """In-memory representation of an Android.bp file."""
440
441 def __init__(self):
442 self.modules = {}
443
444 def add_module(self, module):
445 """Adds a new module to the blueprint, replacing any existing module
446 with the same name.
447
448 Args:
449 module: Module instance.
450 """
451 self.modules[module.name] = module
452
453 def to_string(self, output):
Patrick Rohr23f26192022-10-25 09:45:22 -0700454 for m in sorted(self.modules.values(), key=lambda m: m.name):
Patrick Rohr92d74122022-10-21 15:50:52 -0700455 m.to_string(output)
456
457
458def label_to_module_name(label):
459 """Turn a GN label (e.g., //:perfetto_tests) into a module name."""
460 # If the label is explicibly listed in the default target list, don't prefix
461 # its name and return just the target name. This is so tools like
462 # "traceconv" stay as such in the Android tree.
463 label_without_toolchain = gn_utils.label_without_toolchain(label)
Patrick Rohr92d74122022-10-21 15:50:52 -0700464 module = re.sub(r'^//:?', '', label_without_toolchain)
465 module = re.sub(r'[^a-zA-Z0-9_]', '_', module)
466 if not module.startswith(module_prefix):
467 return module_prefix + module
468 return module
469
470
471def is_supported_source_file(name):
472 """Returns True if |name| can appear in a 'srcs' list."""
Patrick Rohrd604f9f2022-10-27 13:56:42 -0700473 return os.path.splitext(name)[1] in ['.c', '.cc', '.java', '.proto']
Patrick Rohr92d74122022-10-21 15:50:52 -0700474
475
476def create_proto_modules(blueprint, gn, target):
477 """Generate genrules for a proto GN target.
478
479 GN actions are used to dynamically generate files during the build. The
480 Soong equivalent is a genrule. This function turns a specific kind of
481 genrule which turns .proto files into source and header files into a pair
482 equivalent genrules.
483
484 Args:
485 blueprint: Blueprint instance which is being generated.
486 target: gn_utils.Target object.
487
488 Returns:
489 The source_genrule module.
490 """
491 assert (target.type == 'proto_library')
492
493 tools = {'aprotoc'}
494 cpp_out_dir = '$(genDir)/%s/' % tree_path
495 target_module_name = label_to_module_name(target.name)
496
497 # In GN builds the proto path is always relative to the output directory
498 # (out/tmp.xxx).
499 cmd = ['mkdir -p %s &&' % cpp_out_dir, '$(location aprotoc)']
500 cmd += ['--proto_path=%s' % tree_path]
501
502 if buildtools_protobuf_src in target.proto_paths:
503 cmd += ['--proto_path=%s' % android_protobuf_src]
504
505 # We don't generate any targets for source_set proto modules because
506 # they will be inlined into other modules if required.
507 if target.proto_plugin == 'source_set':
508 return None
509
510 # Descriptor targets only generate a single target.
511 if target.proto_plugin == 'descriptor':
512 out = '{}.bin'.format(target_module_name)
513
514 cmd += ['--descriptor_set_out=$(out)']
515 cmd += ['$(in)']
516
517 descriptor_module = Module('genrule', target_module_name, target.name)
518 descriptor_module.cmd = ' '.join(cmd)
519 descriptor_module.out = [out]
520 descriptor_module.tools = tools
521 blueprint.add_module(descriptor_module)
522
523 # Recursively extract the .proto files of all the dependencies and
524 # add them to srcs.
525 descriptor_module.srcs.update(
526 gn_utils.label_to_path(src) for src in target.sources)
527 for dep in target.transitive_proto_deps:
528 current_target = gn.get_target(dep)
529 descriptor_module.srcs.update(
530 gn_utils.label_to_path(src) for src in current_target.sources)
531
532 return descriptor_module
533
534 # We create two genrules for each proto target: one for the headers and
535 # another for the sources. This is because the module that depends on the
536 # generated files needs to declare two different types of dependencies --
537 # source files in 'srcs' and headers in 'generated_headers' -- and it's not
538 # valid to generate .h files from a source dependency and vice versa.
539 source_module_name = target_module_name + '_gen'
540 source_module = Module('genrule', source_module_name, target.name)
541 blueprint.add_module(source_module)
542 source_module.srcs.update(
543 gn_utils.label_to_path(src) for src in target.sources)
544
545 header_module = Module('genrule', source_module_name + '_headers',
546 target.name)
547 blueprint.add_module(header_module)
548 header_module.srcs = set(source_module.srcs)
549
550 # TODO(primiano): at some point we should remove this. This was introduced
551 # by aosp/1108421 when adding "protos/" to .proto include paths, in order to
552 # avoid doing multi-repo changes and allow old clients in the android tree
553 # to still do the old #include "perfetto/..." rather than
554 # #include "protos/perfetto/...".
555 header_module.export_include_dirs = {'.', 'protos'}
556
557 source_module.genrule_srcs.add(':' + source_module.name)
558 source_module.genrule_headers.add(header_module.name)
559
560 if target.proto_plugin == 'proto':
561 suffixes = ['pb']
562 source_module.genrule_shared_libs.add('libprotobuf-cpp-lite')
563 cmd += ['--cpp_out=lite=true:' + cpp_out_dir]
564 elif target.proto_plugin == 'protozero':
565 suffixes = ['pbzero']
566 plugin = create_modules_from_target(blueprint, gn, protozero_plugin)
567 tools.add(plugin.name)
568 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
569 cmd += ['--plugin_out=wrapper_namespace=pbzero:' + cpp_out_dir]
570 elif target.proto_plugin == 'cppgen':
571 suffixes = ['gen']
572 plugin = create_modules_from_target(blueprint, gn, cppgen_plugin)
573 tools.add(plugin.name)
574 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
575 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
576 elif target.proto_plugin == 'ipc':
577 suffixes = ['ipc']
578 plugin = create_modules_from_target(blueprint, gn, ipc_plugin)
579 tools.add(plugin.name)
580 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
581 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
582 else:
583 raise Error('Unsupported proto plugin: %s' % target.proto_plugin)
584
585 cmd += ['$(in)']
586 source_module.cmd = ' '.join(cmd)
587 header_module.cmd = source_module.cmd
588 source_module.tools = tools
589 header_module.tools = tools
590
591 for sfx in suffixes:
592 source_module.out.update('%s/%s' %
593 (tree_path, src.replace('.proto', '.%s.cc' % sfx))
594 for src in source_module.srcs)
595 header_module.out.update('%s/%s' %
596 (tree_path, src.replace('.proto', '.%s.h' % sfx))
597 for src in header_module.srcs)
598 return source_module
599
600
601def create_amalgamated_sql_metrics_module(blueprint, target):
602 bp_module_name = label_to_module_name(target.name)
603 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700604 module.tool_files.add('tools/gen_amalgamated_sql_metrics.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700605 module.cmd = ' '.join([
606 '$(location tools/gen_amalgamated_sql_metrics.py)',
607 '--cpp_out=$(out)',
608 '$(in)',
609 ])
610 module.genrule_headers.add(module.name)
611 module.out.update(target.outputs)
612 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
613 blueprint.add_module(module)
614 return module
615
616
617def create_cc_proto_descriptor_module(blueprint, target):
618 bp_module_name = label_to_module_name(target.name)
619 module = Module('genrule', bp_module_name, target.name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700620 module.tool_files.add('tools/gen_cc_proto_descriptor.py')
Patrick Rohr92d74122022-10-21 15:50:52 -0700621 module.cmd = ' '.join([
622 '$(location tools/gen_cc_proto_descriptor.py)', '--gen_dir=$(genDir)',
623 '--cpp_out=$(out)', '$(in)'
624 ])
625 module.genrule_headers.add(module.name)
626 module.srcs.update(
627 ':' + label_to_module_name(dep) for dep in target.proto_deps)
628 module.srcs.update(
629 gn_utils.label_to_path(src)
630 for src in target.inputs
631 if "tmp.gn_utils" not in src)
632 module.out.update(target.outputs)
633 blueprint.add_module(module)
634 return module
635
636
637def create_gen_version_module(blueprint, target, bp_module_name):
638 module = Module('genrule', bp_module_name, gn_utils.GEN_VERSION_TARGET)
639 script_path = gn_utils.label_to_path(target.script)
640 module.genrule_headers.add(bp_module_name)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700641 module.tool_files.add(script_path)
Patrick Rohr92d74122022-10-21 15:50:52 -0700642 module.out.update(target.outputs)
643 module.srcs.update(gn_utils.label_to_path(src) for src in target.inputs)
644 module.cmd = ' '.join([
645 'python3 $(location %s)' % script_path, '--no_git',
646 '--changelog=$(location CHANGELOG)', '--cpp_out=$(out)'
647 ])
648 blueprint.add_module(module)
649 return module
650
651
652def create_proto_group_modules(blueprint, gn, module_name, target_names):
653 # TODO(lalitm): today, we're only adding a Java lite module because that's
654 # the only one used in practice. In the future, if we need other target types
655 # (e.g. C++, Java full etc.) add them here.
656 bp_module_name = label_to_module_name(module_name) + '_java_protos'
657 module = Module('java_library', bp_module_name, bp_module_name)
658 module.comment = f'''GN: [{', '.join(target_names)}]'''
659 module.proto = {'type': 'lite', 'canonical_path_from_root': False}
660
661 for name in target_names:
662 target = gn.get_target(name)
663 module.srcs.update(gn_utils.label_to_path(src) for src in target.sources)
664 for dep_label in target.transitive_proto_deps:
665 dep = gn.get_target(dep_label)
666 module.srcs.update(gn_utils.label_to_path(src) for src in dep.sources)
667
668 blueprint.add_module(module)
669
Motomu Utsumia6c33152022-11-02 18:21:55 +0900670# HACK: Need to support build_cofig_gen flexibly instead of hardcoding
671# build_config_gen generates srcjar by executing gcc via gcc_preprocess.py but gcc is not
672# available in genrule sandbox. Also gcc path is not configurable.
673# Under the //net:net, gcc_preprocess.py is only used for build_config_gen.
674# So, for now, hardcoding BuildConfig.java and generates srcjar by soong_zip.
675def override_build_config_gen(module):
676 module.tool_files.clear()
677 module.tools.add("soong_zip")
678 cmd = [
679 "echo",
680 "\\\"package org.chromium.build;\\n",
681 "public class BuildConfig {\\n",
682 "public static boolean IS_MULTIDEX_ENABLED ;\\n",
683 "public static boolean ENABLE_ASSERTS = true;\\n",
684 "public static boolean IS_UBSAN ;\\n",
685 "public static boolean IS_CHROME_BRANDED ;\\n",
686 "public static int R_STRING_PRODUCT_VERSION ;\\n",
687 "public static int MIN_SDK_VERSION = 1;\\n",
688 "public static boolean BUNDLES_SUPPORTED ;\\n",
689 "public static boolean IS_INCREMENTAL_INSTALL ;\\n",
690 "public static boolean ISOLATED_SPLITS_ENABLED ;\\n",
691 "public static boolean IS_FOR_TEST ;\\n",
692 "}\\n\\\"",
693 "> $(genDir)/BuildConfig.java &&",
694 "$(location soong_zip) -o $(out) -srcjar -f $(genDir)/BuildConfig.java"
695 ]
696 NEWLINE = ' " +\n "'
697 module.cmd = NEWLINE.join(cmd)
698 return module
699
Mohannad Farragbab6c892022-11-02 14:09:46 +0000700def create_action_foreach_modules(blueprint, target):
701 """ The following assumes that rebase_path exists in the args.
702 The args of an action_foreach contains hints about which output files are generated
703 by which source files.
704 This is copied directly from the args
705 "gen/net/base/registry_controlled_domains/{{source_name_part}}-reversed-inc.cc"
706 So each source file will generate an output whose name is the {source_name-reversed-inc.cc}
707 """
708 new_args = []
Motomu Utsumi56afcac2022-11-04 12:58:30 +0900709 for i, src in enumerate(sorted(target.sources)):
Mohannad Farragbab6c892022-11-02 14:09:46 +0000710 # don't add script arg for the first source -- create_action_module
711 # already does this.
712 if i != 0:
713 new_args.append('&& python3 $(location %s)' %
714 gn_utils.label_to_path(target.script))
715 for arg in target.args:
716 if '{{source}}' in arg:
717 new_args.append('$(location %s)' % (gn_utils.label_to_path(src)))
718 elif '{{source_name_part}}' in arg:
719 source_name_part = src.split("/")[-1] # Get the file name only
720 source_name_part = source_name_part.split(".")[0] # Remove the extension (Ex: .cc)
721 file_name = arg.replace('{{source_name_part}}', source_name_part).split("/")[-1]
722 # file_name represent the output file name. But we need the whole path
723 # This can be found from target.outputs.
724 for out in target.outputs:
725 if out.endswith(file_name):
726 new_args.append('$(location %s)' % out)
727 else:
728 new_args.append(arg)
729
730 target.args = new_args
731 return create_action_module(blueprint, target)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900732
Patrick Rohr7be99032022-10-31 11:54:19 -0700733def create_action_module(blueprint, target):
734 bp_module_name = label_to_module_name(target.name)
735 module = Module('genrule', bp_module_name, target.name)
736
Patrick Rohr9b99a982022-10-28 11:00:57 -0700737 # Convert ['--param=value'] to ['--param', 'value'] for consistency.
738 # TODO: we may want to only do this for python scripts arguments. If argparse
739 # is used, this transformation is safe.
740 target.args = [str for it in target.args for str in it.split('=')]
741
Motomu Utsumibf569d42022-10-28 16:47:34 +0900742 if target.script == "//build/write_buildflag_header.py":
743 # write_buildflag_header.py writes result to args.genDir/args.output
744 # So, override args.genDir by '.' so that args.output=$(out) works
Patrick Rohrde568a22022-10-28 09:22:35 -0700745 for i, val in enumerate(target.args):
746 if val == '--gen-dir':
747 target.args[i + 1] = '.'
Patrick Rohrfa972402022-11-01 11:54:35 -0700748 elif val == '--output':
749 target.args[i + 1] = '$(out)'
750
751 elif target.script == '//build/write_build_date_header.py':
752 target.args[0] = '$(out)'
Patrick Rohr0db9f852022-10-27 13:49:57 -0700753
Patrick Rohr8acccca2022-10-28 10:39:06 -0700754 elif target.script == '//base/android/jni_generator/jni_generator.py':
Patrick Rohrc5cc21a2022-10-31 11:57:49 -0700755 # chromium builds against a prebuilt ndk that contains the jni_headers, so
756 # a dependency is never explicitly created.
757 module.genrule_header_libs.add('jni_headers')
Patrick Rohr131ba282022-10-31 16:36:20 -0700758 needs_javap = False
Patrick Rohr8acccca2022-10-28 10:39:06 -0700759 for i, val in enumerate(target.args):
Motomu Utsumi6f9139d2022-10-31 12:15:19 +0900760 if val == '--output_dir':
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700761 # replace --output_dir gen/jni_headers/... with --output_dir $(genDir)/...
762 target.args[i + 1] = re.sub('^gen/jni_headers', '$(genDir)', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700763 elif val == '--input_file':
Patrick Rohr8acccca2022-10-28 10:39:06 -0700764 # --input_file supports both .class specifiers or source files as arguments.
765 # Only source files need to be wrapped inside a $(location <label>) tag.
766 if re.match('.*\.class$', target.args[i + 1]):
767 continue
768 # replace --input_file ../../... with --input_file $(location ...)
769 # TODO: put inside function
770 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
771 target.args[i + 1] = '$(location %s)' % filename
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700772 elif val == '--includes' and 'jni_generator_helper' in target.args[i + 1]:
Patrick Rohrd89e8bf2022-10-31 14:51:05 -0700773 # delete all leading ../
774 target.args[i + 1] = re.sub('^(\.\./)+', '', target.args[i + 1])
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700775 elif val == '--prev_output_dir':
Patrick Rohr131ba282022-10-31 16:36:20 -0700776 # this is not needed for aosp builds.
777 target.args[i] = ''
778 target.args[i + 1] = ''
Patrick Rohrbec0c8c2022-11-01 11:56:38 -0700779 elif val == '--jar_file':
Patrick Rohr131ba282022-10-31 16:36:20 -0700780 # delete leading ../../ and add path to javap
781 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
782 target.args[i + 1] = '$(location %s)' % filename
783 needs_javap = True
784
785 if needs_javap:
786 target.args.append('--javap')
787 target.args.append('$$(find out/.path -name javap)')
Patrick Rohrf1d08f82022-10-31 14:43:59 -0700788 # fix target.output directory to match #include statements.
789 target.outputs = [re.sub('^jni_headers/', '', out) for out in target.outputs]
Patrick Rohr8acccca2022-10-28 10:39:06 -0700790
Patrick Rohr245df582022-11-01 16:59:45 -0700791 elif target.script == '//build/android/gyp/write_build_config.py':
792 for i, val in enumerate(target.args):
793 if val == '--depfile':
794 # Depfile is not used, so no need to generate it.
795 target.args[i] = ''
796 target.args[i + 1] = ''
797 elif val in ['--deps-configs', '--bundled-srcjars']:
798 args = target.args[i + 1]
799 if args == '[]':
800 continue
801 # strip surrounding [] and split by ", "
802 args = args.strip('[]').split(', ')
803 # strip surrounding ""
804 args = [arg.strip('"') for arg in args]
805 # remove leading gen/
806 args = [re.sub('^gen/', '', arg) for arg in args]
807 # wrap filename in \"$(location filename)\"
808 args = ['\"$(location %s)\"' % arg for arg in args]
809 # join args with ", " and wrap in []
810 target.args[i + 1] = '[%s]' % ', '.join(args)
811
812 elif val == '--public-deps-configs':
813 # TODO: implement.
814 pass
815
816 elif val == '--build-config':
817 # json output of this script
818 target.args[i + 1] = re.sub('^gen', '$(genDir)', target.args[i + 1])
819
820 elif val in ['--unprocessed-jar-path', '--interface-jar-path',
821 '--device-jar-path', '--host-jar-path']:
822 # jar path can be within sources (../../) or output generated by
823 # another genrule (obj/)
824 filename = re.sub('^\.\./\.\./', '', target.args[i + 1])
825 filename = re.sub('^obj/', '', target.args[i + 1])
826 target.args[i + 1] = '$(location %s)' % filename
827
828 elif val == '--proguard-configs':
829 args = target.args[i + 1]
830 if args == '[]':
831 continue
832 # TODO: consider adding helpers to deal with argument lists
833 # strip surrounding [] and split by ", ", then strip surrounding ""
834 args = args.strip('[]').split(', ')
835 args = [arg.strip('"') for arg in args]
836 # remove leading ../../
837 args = [re.sub('^\.\./\.\./', '', arg) for arg in args]
838 # add dependency on proguard config file, so a $(location) wrapper can be used.
839 module.tool_files.update(args)
840 # wrap filename in \"$(location filename)\"
841 args = ['$(location %s)' % arg for arg in args]
842 target.args[i + 1] = '[%s]' % ', '.join(args)
Motomu Utsumi1caa39b2022-11-02 18:38:13 +0900843 elif target.script == "//build/android/gyp/write_native_libraries_java.py":
844 for i, val in enumerate(target.args):
845 if val == '--output':
846 target.args[i + 1] = '$(out)'
Motomu Utsumi26211dc2022-11-02 19:38:47 +0900847 elif target.script == "//tools/grit/stamp_grit_sources.py":
848 target.outputs = [re.sub('^\/\/', '', out) for out in target.outputs]
849 # Directory that contains grit scripts
850 target.args[0] = '`dirname $(location tools/grit/grit.py)`'
851 # Path to the stamp file
852 target.args[1] = '$(out)'
853 # Script tries to create args[2] file but this is not in the output.
854 # Specifying file under $(genDir) so that parent directory exists.
855 # If this file is used by other module, we may need to add this file to the outputs.
856 target.args[2] = '$(genDir)/' + target.args[2].split('/')[-1]
Patrick Rohr245df582022-11-01 16:59:45 -0700857
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700858 script = gn_utils.label_to_path(target.script)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700859 module.tool_files.add(script)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700860
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700861 # Handle passing parameters via response file by piping them into the script
862 # and reading them from /dev/stdin.
863 response_file = '{{response_file_name}}'
864 use_response_file = response_file in target.args
865 if use_response_file:
866 # Replace {{response_file_contents}} with /dev/stdin
867 target.args = ['/dev/stdin' if it == response_file else it for it in target.args]
868
Patrick Rohr4b0952d2022-11-01 12:42:31 -0700869 # escape " and \$ in target.args.
870 # once all actions are properly implemented, this may not be necessary anymore.
871 # TODO: is this the right place to do this?
872 target.args = [arg.replace('"', r'\"') for arg in target.args]
873 target.args = [arg.replace(r'\$', r'\\$') for arg in target.args]
874
Patrick Rohr9b99a982022-10-28 11:00:57 -0700875 # put all args on a new line for better diffs.
876 NEWLINE = ' " +\n "'
877 arg_string = NEWLINE.join(target.args)
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700878 module.cmd = '$(location %s) %s' % (script, arg_string)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700879
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700880 if use_response_file:
881 # Pipe response file contents into script
Patrick Rohr9b99a982022-10-28 11:00:57 -0700882 module.cmd = 'echo \'%s\' |%s%s' % (target.response_file_contents, NEWLINE, module.cmd)
Patrick Rohr8a4e2bd2022-10-27 13:06:16 -0700883
Patrick Rohr67f4d432022-10-26 16:04:15 -0700884 if all(os.path.splitext(it)[1] == '.h' for it in target.outputs):
885 module.genrule_headers.add(bp_module_name)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700886
Patrick Rohr0db9f852022-10-27 13:49:57 -0700887 # gn treats inputs and sources for actions equally.
888 # soong only supports source files inside srcs, non-source files are added as
889 # tool_files dependency.
890 for it in target.sources or target.inputs:
891 if is_supported_source_file(it):
892 module.srcs.add(gn_utils.label_to_path(it))
893 else:
894 module.tool_files.add(gn_utils.label_to_path(it))
Patrick Rohre1a853e2022-10-26 12:31:39 -0700895
Patrick Rohr15a2c302022-10-26 15:08:57 -0700896 # Actions using template "action_with_pydeps" also put script inside inputs.
897 # TODO: it might make sense to filter inputs inside GnParser.
898 if script in module.srcs:
899 module.srcs.remove(script)
900
Patrick Rohre1a853e2022-10-26 12:31:39 -0700901 module.out.update(target.outputs)
Motomu Utsumia6c33152022-11-02 18:21:55 +0900902
903 if target.name == "//build/android:build_config_gen":
904 module = override_build_config_gen(module)
Motomu Utsumi26211dc2022-11-02 19:38:47 +0900905 elif target.script == "//tools/grit/stamp_grit_sources.py":
906 # stamp_grit_sources.py is not executable
907 module.cmd = "python " + module.cmd
Motomu Utsumia6c33152022-11-02 18:21:55 +0900908
Patrick Rohre1a853e2022-10-26 12:31:39 -0700909 blueprint.add_module(module)
910 return module
911
912
Patrick Rohr92d74122022-10-21 15:50:52 -0700913
914def _get_cflags(target):
915 cflags = {flag for flag in target.cflags if re.match(cflag_allowlist, flag)}
Motomu Utsumifa7e9262022-10-26 19:43:02 +0900916 # Consider proper allowlist or denylist if needed
917 cflags |= set("-D%s" % define.replace("\"", "\\\"") for define in target.defines)
Patrick Rohr92d74122022-10-21 15:50:52 -0700918 return cflags
919
920
921def create_modules_from_target(blueprint, gn, gn_target_name):
922 """Generate module(s) for a given GN target.
923
924 Given a GN target name, generate one or more corresponding modules into a
925 blueprint. The only case when this generates >1 module is proto libraries.
926
927 Args:
928 blueprint: Blueprint instance which is being generated.
929 gn: gn_utils.GnParser object.
930 gn_target_name: GN target for module generation.
931 """
932 bp_module_name = label_to_module_name(gn_target_name)
933 if bp_module_name in blueprint.modules:
934 return blueprint.modules[bp_module_name]
935 target = gn.get_target(gn_target_name)
Patrick Rohr16228942022-10-26 14:00:26 -0700936 log.info('create modules for %s (%s)', target.name, target.type)
Patrick Rohr92d74122022-10-21 15:50:52 -0700937
938 name_without_toolchain = gn_utils.label_without_toolchain(target.name)
939 if target.type == 'executable':
940 if target.toolchain == gn_utils.HOST_TOOLCHAIN:
941 module_type = 'cc_binary_host'
942 elif target.testonly:
943 module_type = 'cc_test'
944 else:
945 module_type = 'cc_binary'
946 module = Module(module_type, bp_module_name, gn_target_name)
947 elif target.type == 'static_library':
948 module = Module('cc_library_static', bp_module_name, gn_target_name)
949 elif target.type == 'shared_library':
950 module = Module('cc_library_shared', bp_module_name, gn_target_name)
951 elif target.type == 'source_set':
952 module = Module('filegroup', bp_module_name, gn_target_name)
953 elif target.type == 'group':
954 # "group" targets are resolved recursively by gn_utils.get_target().
955 # There's nothing we need to do at this level for them.
956 return None
957 elif target.type == 'proto_library':
958 module = create_proto_modules(blueprint, gn, target)
959 if module is None:
960 return None
961 elif target.type == 'action':
962 if 'gen_amalgamated_sql_metrics' in target.name:
963 module = create_amalgamated_sql_metrics_module(blueprint, target)
964 elif re.match('.*gen_cc_.*_descriptor$', name_without_toolchain):
965 module = create_cc_proto_descriptor_module(blueprint, target)
966 elif target.type == 'action' and \
967 name_without_toolchain == gn_utils.GEN_VERSION_TARGET:
968 module = create_gen_version_module(blueprint, target, bp_module_name)
969 else:
Patrick Rohre1a853e2022-10-26 12:31:39 -0700970 module = create_action_module(blueprint, target)
Mohannad Farragf076f3e2022-10-31 17:45:28 +0000971 elif target.type == 'action_foreach':
Mohannad Farragbab6c892022-11-02 14:09:46 +0000972 module = create_action_foreach_modules(blueprint, target)
Patrick Rohr59a76652022-10-26 12:36:56 -0700973 elif target.type == 'copy':
974 # TODO: careful now! copy targets are not supported yet, but this will stop
975 # traversing the dependency tree. For //base:base, this is not a big
976 # problem as libicu contains the only copy target which happens to be a
977 # leaf node.
978 return None
Patrick Rohr92d74122022-10-21 15:50:52 -0700979 else:
980 raise Error('Unknown target %s (%s)' % (target.name, target.type))
981
982 blueprint.add_module(module)
983 module.host_supported = (name_without_toolchain in target_host_supported)
Patrick Rohr92d74122022-10-21 15:50:52 -0700984 module.init_rc = target_initrc.get(target.name, [])
985 module.srcs.update(
986 gn_utils.label_to_path(src)
987 for src in target.sources
988 if is_supported_source_file(src))
989
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900990 local_include_dirs_set = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700991 if target.type in gn_utils.LINKER_UNIT_TYPES:
992 module.cflags.update(_get_cflags(target))
Patrick Rohrf22e9d02022-10-28 14:20:46 -0700993 # TODO: implement proper cflag parsing.
994 for flag in target.cflags:
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700995 if '-std=' in flag:
996 module.cpp_std = flag[len('-std='):]
Patrick Rohr61f2acb2022-10-31 14:08:18 -0700997 if '-isystem' in flag:
Motomu Utsumi97fb1812022-11-01 13:08:10 +0900998 local_include_dirs_set.add(flag[len('-isystem../../'):])
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700999
Patrick Rohrd0abc2a2022-10-31 13:29:16 -07001000 # Adding local_include_dirs is necessary due to source_sets / filegroups
1001 # which do not properly propagate include directories.
1002 # Filter any directory inside //out as a) this directory does not exist for
1003 # aosp / soong builds and b) the include directory should already be
1004 # configured via library dependency.
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001005 local_include_dirs_set.update([gn_utils.label_to_path(d)
Patrick Rohrd0abc2a2022-10-31 13:29:16 -07001006 for d in target.include_dirs
1007 if not re.match('^//out/.*', d)])
Motomu Utsumi97fb1812022-11-01 13:08:10 +09001008 module.local_include_dirs = sorted(list(local_include_dirs_set))
1009
1010 # Order matters for some targets. For example, base/time/time_exploded_icu.cc
1011 # in //base:base needs to have sysroot include after icu/source/common
1012 # include. So adding sysroot include at the end.
1013 for flag in target.cflags:
1014 if '--sysroot' in flag:
1015 module.local_include_dirs.append(flag[len('--sysroot=../../'):] + "/usr/include")
Patrick Rohr92d74122022-10-21 15:50:52 -07001016
1017 module_is_compiled = module.type not in ('genrule', 'filegroup')
1018 if module_is_compiled:
1019 # Don't try to inject library/source dependencies into genrules or
1020 # filegroups because they are not compiled in the traditional sense.
1021 module.defaults = [defaults_module]
1022 for lib in target.libs:
1023 # Generally library names should be mangled as 'libXXX', unless they
1024 # are HAL libraries (e.g., android.hardware.health@2.0) or AIDL c++ / NDK
1025 # libraries (e.g. "android.hardware.power.stats-V1-cpp")
1026 android_lib = lib if '@' in lib or "-cpp" in lib or "-ndk" in lib \
1027 else 'lib' + lib
1028 if lib in shared_library_allowlist:
1029 module.add_android_shared_lib(android_lib)
1030 if lib in static_library_allowlist:
1031 module.add_android_static_lib(android_lib)
1032
1033 # If the module is a static library, export all the generated headers.
1034 if module.type == 'cc_library_static':
1035 module.export_generated_headers = module.generated_headers
1036
1037 # Merge in additional hardcoded arguments.
1038 for key, add_val in additional_args.get(module.name, []):
1039 curr = getattr(module, key)
1040 if add_val and isinstance(add_val, set) and isinstance(curr, set):
1041 curr.update(add_val)
1042 elif isinstance(add_val, str) and (not curr or isinstance(curr, str)):
1043 setattr(module, key, add_val)
1044 elif isinstance(add_val, bool) and (not curr or isinstance(curr, bool)):
1045 setattr(module, key, add_val)
1046 elif isinstance(add_val, dict) and isinstance(curr, dict):
1047 curr.update(add_val)
1048 elif isinstance(add_val, dict) and isinstance(curr, Target):
1049 curr.__dict__.update(add_val)
1050 else:
1051 raise Error('Unimplemented type %r of additional_args: %r' %
1052 (type(add_val), key))
1053
1054 # dep_name is an unmangled GN target name (e.g. //foo:bar(toolchain)).
1055 all_deps = target.deps | target.source_set_deps | target.transitive_proto_deps
1056 for dep_name in all_deps:
Patrick Rohr5cc46e02022-10-26 14:32:45 -07001057 # |builtin_deps| override GN deps with Android-specific ones. See the
1058 # config in the top of this file.
1059 if gn_utils.label_without_toolchain(dep_name) in builtin_deps:
1060 builtin_deps[gn_utils.label_without_toolchain(dep_name)](module)
1061 continue
1062
Patrick Rohr92d74122022-10-21 15:50:52 -07001063 dep_module = create_modules_from_target(blueprint, gn, dep_name)
1064
Motomu Utsumie246feb2022-11-01 17:25:56 +09001065 # TODO: Proper dependency check for genrule.
1066 # Currently, only propagating genrule dependencies.
1067 # Also, currently, all the dependencies are propagated upwards.
1068 # in gn, public_deps should be propagated but deps should not.
1069 # Not sure this information is available in the desc.json.
1070 # Following rule works for adding android_runtime_jni_headers to base:base.
1071 # If this doesn't work for other target, hardcoding for specific target
1072 # might be better.
1073 if module.type == "genrule" and dep_module.type == "genrule":
1074 module.genrule_headers.add(dep_module.name)
1075 module.genrule_headers.update(dep_module.genrule_headers)
1076
Patrick Rohr92d74122022-10-21 15:50:52 -07001077 # For filegroups and genrule, recurse but don't apply the deps.
1078 if not module_is_compiled:
1079 continue
1080
Patrick Rohr92d74122022-10-21 15:50:52 -07001081 if dep_module is None:
1082 continue
1083 if dep_module.type == 'cc_library_shared':
1084 module.shared_libs.add(dep_module.name)
1085 elif dep_module.type == 'cc_library_static':
1086 module.static_libs.add(dep_module.name)
1087 elif dep_module.type == 'filegroup':
1088 module.srcs.add(':' + dep_module.name)
1089 elif dep_module.type == 'genrule':
1090 module.generated_headers.update(dep_module.genrule_headers)
1091 module.srcs.update(dep_module.genrule_srcs)
1092 module.shared_libs.update(dep_module.genrule_shared_libs)
Patrick Rohra1a27872022-10-31 11:57:14 -07001093 module.header_libs.update(dep_module.genrule_header_libs)
Patrick Rohr92d74122022-10-21 15:50:52 -07001094 elif dep_module.type == 'cc_binary':
1095 continue # Ignore executables deps (used by cmdline integration tests).
1096 else:
1097 raise Error('Unknown dep %s (%s) for target %s' %
1098 (dep_module.name, dep_module.type, module.name))
1099
1100 return module
1101
1102
1103def create_blueprint_for_targets(gn, desc, targets):
1104 """Generate a blueprint for a list of GN targets."""
1105 blueprint = Blueprint()
1106
1107 # Default settings used by all modules.
1108 defaults = Module('cc_defaults', defaults_module, '//gn:default_deps')
Patrick Rohr92d74122022-10-21 15:50:52 -07001109 defaults.cflags = [
1110 '-Wno-error=return-type',
Patrick Rohr3a1ec1d2022-10-31 13:30:17 -07001111 '-Wno-non-virtual-dtor',
Patrick Rohr98065152022-10-31 14:49:58 -07001112 '-Wno-missing-field-initializers',
Patrick Rohr92d74122022-10-21 15:50:52 -07001113 '-Wno-sign-compare',
1114 '-Wno-sign-promo',
1115 '-Wno-unused-parameter',
1116 '-fvisibility=hidden',
1117 '-O2',
1118 ]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001119 defaults.stl = 'none'
Patrick Rohr92d74122022-10-21 15:50:52 -07001120 blueprint.add_module(defaults)
Patrick Rohr344b2472022-10-25 11:32:15 -07001121
Patrick Rohr92d74122022-10-21 15:50:52 -07001122 for target in targets:
1123 create_modules_from_target(blueprint, gn, target)
1124 return blueprint
1125
1126
1127def main():
1128 parser = argparse.ArgumentParser(
1129 description='Generate Android.bp from a GN description.')
1130 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001131 '--desc',
Patrick Rohr3db246a2022-10-25 10:25:17 -07001132 help='GN description (e.g., gn desc out --format=json --all-toolchains "//*"',
1133 required=True
Patrick Rohr92d74122022-10-21 15:50:52 -07001134 )
1135 parser.add_argument(
1136 '--extras',
1137 help='Extra targets to include at the end of the Blueprint file',
1138 default=os.path.join(gn_utils.repo_root(), 'Android.bp.extras'),
1139 )
1140 parser.add_argument(
1141 '--output',
1142 help='Blueprint file to create',
1143 default=os.path.join(gn_utils.repo_root(), 'Android.bp'),
1144 )
1145 parser.add_argument(
Patrick Rohr16228942022-10-26 14:00:26 -07001146 '-v',
1147 '--verbose',
1148 help='Print debug logs.',
1149 action='store_true',
1150 )
1151 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001152 'targets',
1153 nargs=argparse.REMAINDER,
Patrick Rohr1aa504a2022-10-25 10:30:42 -07001154 help='Targets to include in the blueprint (e.g., "//:perfetto_tests")'
1155 )
Patrick Rohr92d74122022-10-21 15:50:52 -07001156 args = parser.parse_args()
1157
Patrick Rohr16228942022-10-26 14:00:26 -07001158 if args.verbose:
1159 log.basicConfig(format='%(levelname)s:%(funcName)s:%(message)s', level=log.DEBUG)
1160
Patrick Rohr3db246a2022-10-25 10:25:17 -07001161 with open(args.desc) as f:
1162 desc = json.load(f)
Patrick Rohr92d74122022-10-21 15:50:52 -07001163
1164 gn = gn_utils.GnParser(desc)
Patrick Rohr1aa504a2022-10-25 10:30:42 -07001165 blueprint = create_blueprint_for_targets(gn, desc, args.targets)
Patrick Rohr92d74122022-10-21 15:50:52 -07001166 project_root = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
1167 tool_name = os.path.relpath(os.path.abspath(__file__), project_root)
1168
Patrick Rohr92d74122022-10-21 15:50:52 -07001169 # Add any proto groups to the blueprint.
1170 for l_name, t_names in proto_groups.items():
1171 create_proto_group_modules(blueprint, gn, l_name, t_names)
1172
1173 output = [
Patrick Rohr5478b392022-10-25 09:58:50 -07001174 """// Copyright (C) 2022 The Android Open Source Project
Patrick Rohr92d74122022-10-21 15:50:52 -07001175//
1176// Licensed under the Apache License, Version 2.0 (the "License");
1177// you may not use this file except in compliance with the License.
1178// You may obtain a copy of the License at
1179//
1180// http://www.apache.org/licenses/LICENSE-2.0
1181//
1182// Unless required by applicable law or agreed to in writing, software
1183// distributed under the License is distributed on an "AS IS" BASIS,
1184// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1185// See the License for the specific language governing permissions and
1186// limitations under the License.
1187//
1188// This file is automatically generated by %s. Do not edit.
1189""" % (tool_name)
1190 ]
1191 blueprint.to_string(output)
Patrick Rohrcb98e9b2022-10-25 09:57:02 -07001192 if os.path.exists(args.extras):
1193 with open(args.extras, 'r') as r:
1194 for line in r:
1195 output.append(line.rstrip("\n\r"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001196
1197 out_files = []
1198
1199 # Generate the Android.bp file.
1200 out_files.append(args.output + '.swp')
1201 with open(out_files[-1], 'w') as f:
1202 f.write('\n'.join(output))
1203 # Text files should have a trailing EOL.
1204 f.write('\n')
1205
Patrick Rohr94693eb2022-10-25 10:09:16 -07001206 return 0
Patrick Rohr92d74122022-10-21 15:50:52 -07001207
1208
1209if __name__ == '__main__':
1210 sys.exit(main())