blob: 218ea2a294d15f61758711069c6695f0031fee70 [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 Rohr3a2c3dd2022-11-29 22:29:36 -080032import operator
Patrick Rohr92d74122022-10-21 15:50:52 -070033import os
34import re
35import sys
Motomu Utsumic6277d92022-11-07 15:15:17 +090036import copy
Patrick Rohr92d74122022-10-21 15:50:52 -070037
38import gn_utils
39
Patrick Rohr92d74122022-10-21 15:50:52 -070040ROOT_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
41
Patrick Rohr06296362022-11-10 21:37:33 -080042# Default targets to translate to the blueprint file.
43default_targets = [
44 '//components/cronet/android:cronet',
Motomu Utsumiabbfdc32022-11-25 12:19:23 +090045 '//components/cronet:cronet_package',
Patrick Rohr06296362022-11-10 21:37:33 -080046]
47
Patrick Rohr92d74122022-10-21 15:50:52 -070048# Defines a custom init_rc argument to be applied to the corresponding output
49# blueprint target.
50target_initrc = {
Patrick Rohrc36ef422022-10-25 10:38:05 -070051 # TODO: this can probably be removed.
Patrick Rohr92d74122022-10-21 15:50:52 -070052}
53
54target_host_supported = [
Patrick Rohrdc383942022-10-25 10:45:29 -070055 # TODO: remove if this is not useful for the cronet build.
Patrick Rohr92d74122022-10-21 15:50:52 -070056]
57
Patrick Rohr92d74122022-10-21 15:50:52 -070058# Proto target groups which will be made public.
59proto_groups = {
Patrick Rohr95212a22022-10-25 09:53:13 -070060 # TODO: remove if this is not used for the cronet build.
Patrick Rohr92d74122022-10-21 15:50:52 -070061}
62
63# All module names are prefixed with this string to avoid collisions.
Patrick Rohr61b2bad2022-10-25 10:49:20 -070064module_prefix = 'cronet_aml_'
Patrick Rohr92d74122022-10-21 15:50:52 -070065
66# Shared libraries which are directly translated to Android system equivalents.
67shared_library_allowlist = [
68 'android',
69 'android.hardware.atrace@1.0',
70 'android.hardware.health@2.0',
71 'android.hardware.health-V1-ndk',
72 'android.hardware.power.stats@1.0',
73 "android.hardware.power.stats-V1-cpp",
74 'base',
75 'binder',
76 'binder_ndk',
77 'cutils',
78 'hidlbase',
79 'hidltransport',
80 'hwbinder',
81 'incident',
82 'log',
83 'services',
84 'statssocket',
85 "tracingproxy",
86 'utils',
87]
88
89# Static libraries which are directly translated to Android system equivalents.
90static_library_allowlist = [
91 'statslog_perfetto',
92]
93
Patrick Rohrd9dd3b92022-11-09 16:15:30 -080094# Include directories that will be removed from all targets.
95local_include_dirs_denylist = [
Patrick Rohrd9dd3b92022-11-09 16:15:30 -080096]
97
Patrick Rohr92d74122022-10-21 15:50:52 -070098# Name of the module which settings such as compiler flags for all other
99# modules.
100defaults_module = module_prefix + 'defaults'
101
102# Location of the project in the Android source tree.
Patrick Rohr76ceeb52022-11-07 14:18:58 -0800103tree_path = 'external/chromium_org'
Patrick Rohr92d74122022-10-21 15:50:52 -0700104
105# Path for the protobuf sources in the standalone build.
106buildtools_protobuf_src = '//buildtools/protobuf/src'
107
108# Location of the protobuf src dir in the Android source tree.
109android_protobuf_src = 'external/protobuf/src'
110
Mohannad Farragc739dda2022-12-02 15:43:46 +0000111# put all args on a new line for better diffs.
112NEWLINE = ' " +\n "'
Mohannad Farrag00ecfb52022-12-02 14:44:15 +0000113
Patrick Rohr92d74122022-10-21 15:50:52 -0700114# Compiler flags which are passed through to the blueprint.
Motomu Utsumic8b7bea2022-11-16 18:12:44 +0900115cflag_allowlist = [
Motomu Utsumicf68d732022-11-16 18:15:21 +0900116 # needed for zlib:zlib
117 "-mpclmul",
118 # needed for zlib:zlib
119 "-mssse3",
Mohannad Farrag7f29d832022-11-23 19:52:41 +0000120 # needed for zlib:zlib
121 "-msse3",
122 # needed for zlib:zlib
123 "-msse4.2",
Motomu Utsumic8b7bea2022-11-16 18:12:44 +0900124]
Patrick Rohr92d74122022-10-21 15:50:52 -0700125
Patrick Rohr92d74122022-10-21 15:50:52 -0700126# Additional arguments to apply to Android.bp rules.
127additional_args = {
Patrick Rohr2267a0a2022-11-08 18:59:34 -0800128 # TODO: remove if not needed.
Patrick Rohrd90025f2022-11-11 14:18:35 -0800129 'cronet_aml_components_cronet_android_cronet': [
130 ('linker_scripts', {
131 'base/android/library_loader/anchor_functions.lds',
132 }),
133 ],
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800134 'cronet_aml_net_net': [
Patrick Rohr9f4d3e32022-11-09 16:37:31 -0800135 ('export_static_lib_headers', {
136 'cronet_aml_net_third_party_quiche_quiche',
137 'cronet_aml_crypto_crypto',
138 }),
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000139 ],
Patrick Rohr92d74122022-10-21 15:50:52 -0700140}
141
Patrick Rohr92d74122022-10-21 15:50:52 -0700142# Android equivalents for third-party libraries that the upstream project
143# depends on.
144builtin_deps = {
Patrick Rohr14ee0932022-11-15 12:10:27 -0800145 '//net/tools/root_store_tool:root_store_tool':
146 lambda x: None,
Patrick Rohr92d74122022-10-21 15:50:52 -0700147}
148
Motomu Utsumi8ca12412022-11-30 16:27:30 +0900149# Name of tethering apex module
150tethering_apex = "com.android.tethering"
151
Patrick Rohr92d74122022-10-21 15:50:52 -0700152# ----------------------------------------------------------------------------
153# End of configuration.
154# ----------------------------------------------------------------------------
155
156
157class Error(Exception):
158 pass
159
160
161class ThrowingArgumentParser(argparse.ArgumentParser):
162
163 def __init__(self, context):
164 super(ThrowingArgumentParser, self).__init__()
165 self.context = context
166
167 def error(self, message):
168 raise Error('%s: %s' % (self.context, message))
169
170
171def write_blueprint_key_value(output, name, value, sort=True):
172 """Writes a Blueprint key-value pair to the output"""
173
174 if isinstance(value, bool):
175 if value:
176 output.append(' %s: true,' % name)
177 else:
178 output.append(' %s: false,' % name)
179 return
180 if not value:
181 return
182 if isinstance(value, set):
183 value = sorted(value)
184 if isinstance(value, list):
185 output.append(' %s: [' % name)
186 for item in sorted(value) if sort else value:
187 output.append(' "%s",' % item)
188 output.append(' ],')
189 return
190 if isinstance(value, Target):
191 value.to_string(output)
192 return
193 if isinstance(value, dict):
194 kv_output = []
195 for k, v in value.items():
196 write_blueprint_key_value(kv_output, k, v)
197
198 output.append(' %s: {' % name)
199 for line in kv_output:
200 output.append(' %s' % line)
201 output.append(' },')
202 return
203 output.append(' %s: "%s",' % (name, value))
204
205
206class Target(object):
207 """A target-scoped part of a module"""
208
209 def __init__(self, name):
210 self.name = name
Patrick Rohr5d399b32022-11-16 10:19:55 -0800211 self.srcs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700212 self.shared_libs = set()
213 self.static_libs = set()
214 self.whole_static_libs = set()
Patrick Rohrc03f1bb2022-11-18 16:13:17 -0800215 self.header_libs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700216 self.cflags = set()
217 self.dist = dict()
218 self.strip = dict()
219 self.stl = None
Motomu Utsumi50ad2172022-11-17 22:29:53 +0900220 self.cppflags = set()
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -0800221 self.local_include_dirs = set()
Patrick Rohr81435162022-11-17 19:34:32 -0800222 self.export_system_include_dirs = set()
Mohannad Farrag631443e2022-11-21 16:17:01 +0000223 self.generated_headers = set()
224 self.export_generated_headers = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700225
226 def to_string(self, output):
227 nested_out = []
Patrick Rohr5d399b32022-11-16 10:19:55 -0800228 self._output_field(nested_out, 'srcs')
Patrick Rohr92d74122022-10-21 15:50:52 -0700229 self._output_field(nested_out, 'shared_libs')
230 self._output_field(nested_out, 'static_libs')
231 self._output_field(nested_out, 'whole_static_libs')
Patrick Rohrc03f1bb2022-11-18 16:13:17 -0800232 self._output_field(nested_out, 'header_libs')
Patrick Rohr92d74122022-10-21 15:50:52 -0700233 self._output_field(nested_out, 'cflags')
234 self._output_field(nested_out, 'stl')
235 self._output_field(nested_out, 'dist')
236 self._output_field(nested_out, 'strip')
Motomu Utsumi50ad2172022-11-17 22:29:53 +0900237 self._output_field(nested_out, 'cppflags')
238 self._output_field(nested_out, 'local_include_dirs')
Patrick Rohr81435162022-11-17 19:34:32 -0800239 self._output_field(nested_out, 'export_system_include_dirs')
Mohannad Farrag631443e2022-11-21 16:17:01 +0000240 self._output_field(nested_out, 'generated_headers')
241 self._output_field(nested_out, 'export_generated_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -0700242
243 if nested_out:
244 output.append(' %s: {' % self.name)
245 for line in nested_out:
246 output.append(' %s' % line)
247 output.append(' },')
248
249 def _output_field(self, output, name, sort=True):
250 value = getattr(self, name)
251 return write_blueprint_key_value(output, name, value, sort)
252
253
254class Module(object):
255 """A single module (e.g., cc_binary, cc_test) in a blueprint."""
256
257 def __init__(self, mod_type, name, gn_target):
258 self.type = mod_type
259 self.gn_target = gn_target
260 self.name = name
261 self.srcs = set()
Patrick Rohr07876662022-11-15 22:55:23 -0800262 self.comment = 'GN: ' + gn_target
Patrick Rohr92d74122022-10-21 15:50:52 -0700263 self.shared_libs = set()
264 self.static_libs = set()
265 self.whole_static_libs = set()
266 self.runtime_libs = set()
267 self.tools = set()
268 self.cmd = None
269 self.host_supported = False
Patrick Rohrcdda6322022-11-15 22:44:16 -0800270 self.device_supported = True
Patrick Rohr92d74122022-10-21 15:50:52 -0700271 self.vendor_available = False
272 self.init_rc = set()
273 self.out = set()
274 self.export_include_dirs = set()
275 self.generated_headers = set()
276 self.export_generated_headers = set()
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800277 self.export_static_lib_headers = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700278 self.defaults = set()
279 self.cflags = set()
280 self.include_dirs = set()
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -0800281 self.local_include_dirs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700282 self.header_libs = set()
283 self.required = set()
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700284 self.tool_files = set()
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800285 # target contains a dict of Targets indexed by os_arch.
286 # example: { 'android_x86': Target('android_x86')
287 self.target = dict()
288 self.target['android'] = Target('android')
Patrick Rohr82e40742022-11-16 10:20:39 -0800289 self.target['android_x86'] = Target('android_x86')
290 self.target['android_x86_64'] = Target('android_x86_64')
291 self.target['android_arm'] = Target('android_arm')
292 self.target['android_arm64'] = Target('android_arm64')
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800293 self.target['host'] = Target('host')
Patrick Rohr92d74122022-10-21 15:50:52 -0700294 self.stl = None
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700295 self.cpp_std = None
Patrick Rohr92d74122022-10-21 15:50:52 -0700296 self.dist = dict()
297 self.strip = dict()
298 self.data = set()
299 self.apex_available = set()
300 self.min_sdk_version = None
301 self.proto = dict()
Patrick Rohrd90025f2022-11-11 14:18:35 -0800302 self.linker_scripts = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700303 # The genrule_XXX below are properties that must to be propagated back
304 # on the module(s) that depend on the genrule.
305 self.genrule_headers = set()
306 self.genrule_srcs = set()
307 self.genrule_shared_libs = set()
Patrick Rohra1a27872022-10-31 11:57:14 -0700308 self.genrule_header_libs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700309 self.version_script = None
310 self.test_suites = set()
311 self.test_config = None
312 self.stubs = {}
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000313 self.cppflags = set()
314 self.rtti = False
Motomu Utsumiee47af62022-11-30 16:41:15 +0900315 # Name of the output. Used for setting .so file name for libcronet
316 self.stem = None
Patrick Rohr92d74122022-10-21 15:50:52 -0700317
318 def to_string(self, output):
319 if self.comment:
320 output.append('// %s' % self.comment)
321 output.append('%s {' % self.type)
322 self._output_field(output, 'name')
323 self._output_field(output, 'srcs')
324 self._output_field(output, 'shared_libs')
325 self._output_field(output, 'static_libs')
326 self._output_field(output, 'whole_static_libs')
327 self._output_field(output, 'runtime_libs')
328 self._output_field(output, 'tools')
329 self._output_field(output, 'cmd', sort=False)
330 if self.host_supported:
331 self._output_field(output, 'host_supported')
Patrick Rohrcdda6322022-11-15 22:44:16 -0800332 if not self.device_supported:
333 self._output_field(output, 'device_supported')
Patrick Rohr92d74122022-10-21 15:50:52 -0700334 if self.vendor_available:
335 self._output_field(output, 'vendor_available')
336 self._output_field(output, 'init_rc')
337 self._output_field(output, 'out')
338 self._output_field(output, 'export_include_dirs')
339 self._output_field(output, 'generated_headers')
340 self._output_field(output, 'export_generated_headers')
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800341 self._output_field(output, 'export_static_lib_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -0700342 self._output_field(output, 'defaults')
343 self._output_field(output, 'cflags')
344 self._output_field(output, 'include_dirs')
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -0800345 self._output_field(output, 'local_include_dirs')
Patrick Rohr92d74122022-10-21 15:50:52 -0700346 self._output_field(output, 'header_libs')
347 self._output_field(output, 'required')
348 self._output_field(output, 'dist')
349 self._output_field(output, 'strip')
350 self._output_field(output, 'tool_files')
351 self._output_field(output, 'data')
352 self._output_field(output, 'stl')
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700353 self._output_field(output, 'cpp_std')
Patrick Rohr92d74122022-10-21 15:50:52 -0700354 self._output_field(output, 'apex_available')
355 self._output_field(output, 'min_sdk_version')
356 self._output_field(output, 'version_script')
357 self._output_field(output, 'test_suites')
358 self._output_field(output, 'test_config')
359 self._output_field(output, 'stubs')
360 self._output_field(output, 'proto')
Patrick Rohrd90025f2022-11-11 14:18:35 -0800361 self._output_field(output, 'linker_scripts')
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000362 self._output_field(output, 'cppflags')
Motomu Utsumiee47af62022-11-30 16:41:15 +0900363 self._output_field(output, 'stem')
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000364 if self.rtti:
365 self._output_field(output, 'rtti')
Patrick Rohr92d74122022-10-21 15:50:52 -0700366
367 target_out = []
Patrick Rohr09ee70e2022-11-16 15:20:03 -0800368 for arch, target in sorted(self.target.items()):
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800369 # _output_field calls getattr(self, arch).
370 setattr(self, arch, target)
371 self._output_field(target_out, arch)
372
Patrick Rohr92d74122022-10-21 15:50:52 -0700373 if target_out:
374 output.append(' target: {')
375 for line in target_out:
376 output.append(' %s' % line)
377 output.append(' },')
378
Patrick Rohr92d74122022-10-21 15:50:52 -0700379 output.append('}')
380 output.append('')
381
382 def add_android_static_lib(self, lib):
383 if self.type == 'cc_binary_host':
384 raise Exception('Adding Android static lib for host tool is unsupported')
385 elif self.host_supported:
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800386 self.target['android'].static_libs.add(lib)
Patrick Rohr92d74122022-10-21 15:50:52 -0700387 else:
388 self.static_libs.add(lib)
389
390 def add_android_shared_lib(self, lib):
391 if self.type == 'cc_binary_host':
392 raise Exception('Adding Android shared lib for host tool is unsupported')
393 elif self.host_supported:
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800394 self.target['android'].shared_libs.add(lib)
Patrick Rohr92d74122022-10-21 15:50:52 -0700395 else:
396 self.shared_libs.add(lib)
397
398 def _output_field(self, output, name, sort=True):
399 value = getattr(self, name)
400 return write_blueprint_key_value(output, name, value, sort)
401
Patrick Rohra6ce0232022-11-16 22:09:01 -0800402 def is_compiled(self):
Mohannad Farrag7ff99912022-11-29 17:16:00 +0000403 return self.type not in ('cc_genrule', 'filegroup', 'java_genrule')
Mohannad Farrag1de6cb12022-11-28 12:27:26 +0000404
405 def is_genrule(self):
406 return self.type == "cc_genrule"
Patrick Rohra6ce0232022-11-16 22:09:01 -0800407
Mohannad Farrag7f29d832022-11-23 19:52:41 +0000408 def has_input_files(self):
Mohannad Farrag7f29d832022-11-23 19:52:41 +0000409 return len(self.srcs) > 0 or any([len(target.srcs) > 0 for target in self.target.values()])
410
Mohannad Farragf2391cc2022-11-29 13:26:32 +0000411 def merge_attribute(self, key, source_module, allowed_archs, source_key = None):
412 """
413 Merges the value of the attribute `source_key` for the `dep_module` with
414 the value of the attribute `key` for this module. If the value of the
415 `source_key` is equal to None. Then `key` is used for both modules.
416
417 This merges the attribute for both non-arch and archs
418 specified in `allowed_archs`.
419 :param key: The attribute used for merging in the calling module. Also
420 used for `dep_module` if the `source_key` is None.
421 :param source_module: The module where data is propagated from.
422 :param allowed_archs: A list of archs to merge the attribute on.
423 :param source_key: if the attribute merged from the `dep_module`
424 is different from the `key`
425 """
426 if not source_key:
427 source_key = key
428 self.__dict__[key].update(source_module.__dict__[source_key])
429 for arch_name in source_module.target.keys():
430 if arch_name in allowed_archs:
431 self.target[arch_name].__dict__[key].update(
432 source_module.target[arch_name].__dict__[source_key])
Patrick Rohr92d74122022-10-21 15:50:52 -0700433
434class Blueprint(object):
435 """In-memory representation of an Android.bp file."""
436
437 def __init__(self):
438 self.modules = {}
439
440 def add_module(self, module):
441 """Adds a new module to the blueprint, replacing any existing module
442 with the same name.
443
444 Args:
445 module: Module instance.
446 """
447 self.modules[module.name] = module
448
449 def to_string(self, output):
Patrick Rohr23f26192022-10-25 09:45:22 -0700450 for m in sorted(self.modules.values(), key=lambda m: m.name):
Patrick Rohr92d74122022-10-21 15:50:52 -0700451 m.to_string(output)
452
453
454def label_to_module_name(label):
455 """Turn a GN label (e.g., //:perfetto_tests) into a module name."""
Patrick Rohr07876662022-11-15 22:55:23 -0800456 module = re.sub(r'^//:?', '', label)
Patrick Rohr92d74122022-10-21 15:50:52 -0700457 module = re.sub(r'[^a-zA-Z0-9_]', '_', module)
Motomu Utsumi3fde1482022-11-14 15:55:21 +0900458
Patrick Rohr92d74122022-10-21 15:50:52 -0700459 if not module.startswith(module_prefix):
460 return module_prefix + module
461 return module
462
463
464def is_supported_source_file(name):
465 """Returns True if |name| can appear in a 'srcs' list."""
Patrick Rohrf9f3a992022-11-10 19:40:32 -0800466 return os.path.splitext(name)[1] in ['.c', '.cc', '.cpp', '.java', '.proto', '.S']
Patrick Rohr92d74122022-10-21 15:50:52 -0700467
468
469def create_proto_modules(blueprint, gn, target):
470 """Generate genrules for a proto GN target.
471
472 GN actions are used to dynamically generate files during the build. The
473 Soong equivalent is a genrule. This function turns a specific kind of
474 genrule which turns .proto files into source and header files into a pair
475 equivalent genrules.
476
477 Args:
478 blueprint: Blueprint instance which is being generated.
479 target: gn_utils.Target object.
480
481 Returns:
482 The source_genrule module.
483 """
484 assert (target.type == 'proto_library')
485
Motomu Utsumibd4013f2022-11-17 16:06:05 +0900486 protoc_gn_target_name = gn.get_target('//third_party/protobuf:protoc').name
Motomu Utsumid58c1dc2022-11-16 18:04:46 +0900487 protoc_module_name = label_to_module_name(protoc_gn_target_name)
488 tools = {protoc_module_name}
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900489 cpp_out_dir = '$(genDir)/%s/%s/' % (tree_path, target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700490 target_module_name = label_to_module_name(target.name)
491
492 # In GN builds the proto path is always relative to the output directory
493 # (out/tmp.xxx).
Motomu Utsumid58c1dc2022-11-16 18:04:46 +0900494 cmd = ['$(location %s)' % protoc_module_name]
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900495 cmd += ['--proto_path=%s/%s' % (tree_path, target.proto_in_dir)]
Patrick Rohr92d74122022-10-21 15:50:52 -0700496
497 if buildtools_protobuf_src in target.proto_paths:
498 cmd += ['--proto_path=%s' % android_protobuf_src]
499
500 # We don't generate any targets for source_set proto modules because
501 # they will be inlined into other modules if required.
502 if target.proto_plugin == 'source_set':
503 return None
504
505 # Descriptor targets only generate a single target.
506 if target.proto_plugin == 'descriptor':
507 out = '{}.bin'.format(target_module_name)
508
509 cmd += ['--descriptor_set_out=$(out)']
510 cmd += ['$(in)']
511
Mohannad Farrag1de6cb12022-11-28 12:27:26 +0000512 descriptor_module = Module('cc_genrule', target_module_name, target.name)
Patrick Rohr92d74122022-10-21 15:50:52 -0700513 descriptor_module.cmd = ' '.join(cmd)
514 descriptor_module.out = [out]
515 descriptor_module.tools = tools
516 blueprint.add_module(descriptor_module)
517
518 # Recursively extract the .proto files of all the dependencies and
519 # add them to srcs.
520 descriptor_module.srcs.update(
521 gn_utils.label_to_path(src) for src in target.sources)
522 for dep in target.transitive_proto_deps:
523 current_target = gn.get_target(dep)
524 descriptor_module.srcs.update(
525 gn_utils.label_to_path(src) for src in current_target.sources)
526
527 return descriptor_module
528
529 # We create two genrules for each proto target: one for the headers and
530 # another for the sources. This is because the module that depends on the
531 # generated files needs to declare two different types of dependencies --
532 # source files in 'srcs' and headers in 'generated_headers' -- and it's not
533 # valid to generate .h files from a source dependency and vice versa.
534 source_module_name = target_module_name + '_gen'
Mohannad Farrag1de6cb12022-11-28 12:27:26 +0000535 source_module = Module('cc_genrule', source_module_name, target.name)
Patrick Rohr92d74122022-10-21 15:50:52 -0700536 blueprint.add_module(source_module)
537 source_module.srcs.update(
538 gn_utils.label_to_path(src) for src in target.sources)
539
Mohannad Farrag1de6cb12022-11-28 12:27:26 +0000540 header_module = Module('cc_genrule', source_module_name + '_headers',
Patrick Rohr92d74122022-10-21 15:50:52 -0700541 target.name)
542 blueprint.add_module(header_module)
543 header_module.srcs = set(source_module.srcs)
544
545 # TODO(primiano): at some point we should remove this. This was introduced
546 # by aosp/1108421 when adding "protos/" to .proto include paths, in order to
547 # avoid doing multi-repo changes and allow old clients in the android tree
548 # to still do the old #include "perfetto/..." rather than
549 # #include "protos/perfetto/...".
550 header_module.export_include_dirs = {'.', 'protos'}
Patrick Rohr2267a0a2022-11-08 18:59:34 -0800551 # Since the .cc file and .h get created by a different gerule target, they
552 # are not put in the same intermediate path, so local includes do not work
553 # without explictily exporting the include dir.
554 header_module.export_include_dirs.add(target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700555
Motomu Utsumi8ca12412022-11-30 16:27:30 +0900556 # This function does not return header_module so setting apex_available attribute here.
557 header_module.apex_available.add(tethering_apex)
558
Patrick Rohr92d74122022-10-21 15:50:52 -0700559 source_module.genrule_srcs.add(':' + source_module.name)
560 source_module.genrule_headers.add(header_module.name)
561
562 if target.proto_plugin == 'proto':
563 suffixes = ['pb']
564 source_module.genrule_shared_libs.add('libprotobuf-cpp-lite')
565 cmd += ['--cpp_out=lite=true:' + cpp_out_dir]
566 elif target.proto_plugin == 'protozero':
567 suffixes = ['pbzero']
568 plugin = create_modules_from_target(blueprint, gn, protozero_plugin)
569 tools.add(plugin.name)
570 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
571 cmd += ['--plugin_out=wrapper_namespace=pbzero:' + cpp_out_dir]
572 elif target.proto_plugin == 'cppgen':
573 suffixes = ['gen']
574 plugin = create_modules_from_target(blueprint, gn, cppgen_plugin)
575 tools.add(plugin.name)
576 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
577 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
578 elif target.proto_plugin == 'ipc':
579 suffixes = ['ipc']
580 plugin = create_modules_from_target(blueprint, gn, ipc_plugin)
581 tools.add(plugin.name)
582 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
583 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
584 else:
585 raise Error('Unsupported proto plugin: %s' % target.proto_plugin)
586
587 cmd += ['$(in)']
588 source_module.cmd = ' '.join(cmd)
589 header_module.cmd = source_module.cmd
590 source_module.tools = tools
591 header_module.tools = tools
592
593 for sfx in suffixes:
594 source_module.out.update('%s/%s' %
595 (tree_path, src.replace('.proto', '.%s.cc' % sfx))
596 for src in source_module.srcs)
597 header_module.out.update('%s/%s' %
598 (tree_path, src.replace('.proto', '.%s.h' % sfx))
599 for src in header_module.srcs)
600 return source_module
601
602
Patrick Rohr92d74122022-10-21 15:50:52 -0700603def create_proto_group_modules(blueprint, gn, module_name, target_names):
604 # TODO(lalitm): today, we're only adding a Java lite module because that's
605 # the only one used in practice. In the future, if we need other target types
606 # (e.g. C++, Java full etc.) add them here.
607 bp_module_name = label_to_module_name(module_name) + '_java_protos'
608 module = Module('java_library', bp_module_name, bp_module_name)
609 module.comment = f'''GN: [{', '.join(target_names)}]'''
610 module.proto = {'type': 'lite', 'canonical_path_from_root': False}
611
612 for name in target_names:
613 target = gn.get_target(name)
614 module.srcs.update(gn_utils.label_to_path(src) for src in target.sources)
615 for dep_label in target.transitive_proto_deps:
616 dep = gn.get_target(dep_label)
617 module.srcs.update(gn_utils.label_to_path(src) for src in dep.sources)
618
619 blueprint.add_module(module)
620
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800621
Mohannad Farrag420c14e2022-11-30 17:13:15 +0000622class BaseActionSanitizer():
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800623 def __init__(self, target):
Patrick Rohr9e414b52022-11-29 22:12:18 -0800624 # Just to be on the safe side, create a deep-copy.
625 self.target = copy.deepcopy(target)
Motomu Utsumi9752bd32022-12-02 15:16:55 +0900626 self.target.args = self._normalize_args()
627
628 def _normalize_args(self):
Patrick Rohr9e414b52022-11-29 22:12:18 -0800629 # Convert ['--param=value'] to ['--param', 'value'] for consistency.
Motomu Utsumi9752bd32022-12-02 15:16:55 +0900630 normalized_args = []
631 for arg in self.target.args:
Motomu Utsumi13399322022-12-02 15:36:48 +0900632 if arg.startswith('-'):
633 normalized_args.extend(arg.split('='))
634 else:
635 normalized_args.append(arg)
Motomu Utsumi9752bd32022-12-02 15:16:55 +0900636 return normalized_args
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800637
Patrick Rohr2cad9332022-11-30 14:27:40 -0800638 # There are three types of args:
639 # - flags (--flag)
640 # - value args (--arg value)
641 # - list args (--arg value1 --arg value2)
Motomu Utsumi8be8a262022-12-02 14:35:15 +0900642 # value args have exactly one arg value pair and list args have one or more arg value pairs.
Motomu Utsumi923688c2022-12-01 15:51:05 +0900643 # Note that the set of list args contains the set of value args.
Motomu Utsumi8be8a262022-12-02 14:35:15 +0900644 # This is because list and value args are identical when the list args has only one arg value pair
Patrick Rohr2cad9332022-11-30 14:27:40 -0800645 # Some functions provide special implementations for each type, while others
646 # work on all of them.
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800647 def _has_arg(self, arg):
648 return arg in self.target.args
649
Motomu Utsumi923688c2022-12-01 15:51:05 +0900650 def _get_arg_indices(self, target_arg):
651 return [i for i, arg in enumerate(self.target.args) if arg == target_arg]
Patrick Rohr3a2c3dd2022-11-29 22:29:36 -0800652
Motomu Utsumi923688c2022-12-01 15:51:05 +0900653 # Whether an arg value pair appears once or more times
654 def _is_list_arg(self, arg):
655 indices = self._get_arg_indices(arg)
656 return len(indices) > 0 and all([not self.target.args[i + 1].startswith('--') for i in indices])
657
Motomu Utsumic363b412022-12-01 16:01:58 +0900658 def _update_list_arg(self, arg, func, throw_if_absent = True):
659 if self._should_fail_silently(arg, throw_if_absent):
660 return
661 assert(self._is_list_arg(arg))
662 indices = self._get_arg_indices(arg)
663 for i in indices:
664 self._set_arg_at(i + 1, func(self.target.args[i + 1]))
665
Motomu Utsumi923688c2022-12-01 15:51:05 +0900666 # Whether an arg value pair appears exactly once
Patrick Rohref4f2bf2022-11-30 14:22:40 -0800667 def _is_value_arg(self, arg):
Motomu Utsumid75b8b52022-12-02 14:29:00 +0900668 return operator.countOf(self.target.args, arg) == 1 and self._is_list_arg(arg)
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800669
Patrick Rohr2cad9332022-11-30 14:27:40 -0800670 def _get_value_arg(self, arg):
Patrick Rohref4f2bf2022-11-30 14:22:40 -0800671 assert(self._is_value_arg(arg))
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800672 i = self.target.args.index(arg)
673 return self.target.args[i + 1]
674
Patrick Rohrf0abead2022-11-30 19:44:10 -0800675 # used to check whether a function call should cause an error when an arg is
676 # missing.
677 def _should_fail_silently(self, arg, throw_if_absent):
678 return not throw_if_absent and not self._has_arg(arg)
679
680 def _set_value_arg(self, arg, value, throw_if_absent = True):
681 if self._should_fail_silently(arg, throw_if_absent):
Patrick Rohr4d74aed2022-11-30 15:42:16 -0800682 return
Patrick Rohref4f2bf2022-11-30 14:22:40 -0800683 assert(self._is_value_arg(arg))
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800684 i = self.target.args.index(arg)
685 self.target.args[i + 1] = value
686
Patrick Rohrf0abead2022-11-30 19:44:10 -0800687 def _update_value_arg(self, arg, func, throw_if_absent = True):
688 if self._should_fail_silently(arg, throw_if_absent):
Patrick Rohr4d74aed2022-11-30 15:42:16 -0800689 return
Patrick Rohr1bedf6c2022-11-30 15:12:57 -0800690 self._set_value_arg(arg, func(self._get_value_arg(arg)))
691
Patrick Rohr77c4f5c2022-11-30 12:56:29 -0800692 def _set_arg_at(self, position, value):
Mohannad Farrag9ab17932022-11-30 17:28:35 +0000693 self.target.args[position] = value
694
Patrick Rohr357b25c2022-11-30 19:46:26 -0800695 def _delete_value_arg(self, arg, throw_if_absent = True):
Patrick Rohrf0abead2022-11-30 19:44:10 -0800696 if self._should_fail_silently(arg, throw_if_absent):
Patrick Rohr4d74aed2022-11-30 15:42:16 -0800697 return
Patrick Rohr357b25c2022-11-30 19:46:26 -0800698 assert(self._is_value_arg(arg))
Patrick Rohr9f439322022-11-30 15:56:15 -0800699 i = self.target.args.index(arg)
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800700 self.target.args.pop(i)
Patrick Rohr357b25c2022-11-30 19:46:26 -0800701 self.target.args.pop(i)
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800702
Patrick Rohr1f7dd582022-11-30 13:44:07 -0800703 def _append_arg(self, arg, value):
704 self.target.args.append(arg)
705 self.target.args.append(value)
706
Mohannad Farrag8fa90652022-12-01 15:40:40 +0000707 def _sanitize_filepath_with_location_tag(self, arg):
708 if arg.startswith('../../'):
709 arg = self._sanitize_filepath(arg)
710 arg = self._add_location_tag(arg)
711 return arg
712
Patrick Rohr73ef7ae2022-11-29 22:33:09 -0800713 # wrap filename in location tag.
Patrick Rohrfda026732022-11-30 16:07:11 -0800714 def _add_location_tag(self, filename):
Patrick Rohr73ef7ae2022-11-29 22:33:09 -0800715 return '$(location %s)' % filename
716
Patrick Rohr0e24c5f2022-11-30 15:20:21 -0800717 # applies common directory transformation that *should* be universally applicable.
718 # TODO: verify if it actually *is* universally applicable.
Patrick Rohr872a2812022-11-30 19:28:22 -0800719 def _sanitize_filepath(self, filepath):
Patrick Rohr0e24c5f2022-11-30 15:20:21 -0800720 # Careful, order matters!
Patrick Rohr8bcd7832022-11-30 19:48:56 -0800721 # delete all leading ../
Patrick Rohr9e5a3c72022-11-30 15:51:30 -0800722 filepath = re.sub('^(\.\./)+', '', filepath)
Patrick Rohr0e24c5f2022-11-30 15:20:21 -0800723 filepath = re.sub('^gen/jni_headers', '$(genDir)', filepath)
724 filepath = re.sub('^gen', '$(genDir)', filepath)
725 return filepath
Patrick Rohr32276892022-11-29 22:38:13 -0800726
Motomu Utsumi21485ba2022-12-01 17:01:50 +0900727 # Iterate through all the args and apply function
728 def _update_all_args(self, func):
729 self.target.args = [func(arg) for arg in self.target.args]
730
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800731 def get_args(self):
Patrick Rohr9e414b52022-11-29 22:12:18 -0800732 return self.target.args
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800733
Mohannad Farragd5515ca2022-12-02 15:39:53 +0000734 def get_cmd(self):
Mohannad Farragc739dda2022-12-02 15:43:46 +0000735 arg_string = NEWLINE.join(self.target.args)
736 cmd = '$(location %s) %s' % (
737 gn_utils.label_to_path(self.target.script), arg_string)
738
739 if self.use_response_file:
740 # Pipe response file contents into script
741 cmd = 'echo \'%s\' |%s%s' % (self.target.response_file_contents, NEWLINE, cmd)
742 return cmd
Mohannad Farragd5515ca2022-12-02 15:39:53 +0000743
Motomu Utsumi5afd0812022-12-02 15:43:36 +0900744 def get_outputs(self):
745 return self.target.outputs
746
Motomu Utsumicdb45ea2022-12-02 17:05:07 +0900747 def _sanitize_args(self):
Mohannad Farrag00ecfb52022-12-02 14:44:15 +0000748 # Handle passing parameters via response file by piping them into the script
749 # and reading them from /dev/stdin.
750
Mohannad Farraga0e37c12022-12-02 14:46:08 +0000751 self.use_response_file = gn_utils.RESPONSE_FILE in self.target.args
Mohannad Farrag00ecfb52022-12-02 14:44:15 +0000752 if self.use_response_file:
753 # Replace {{response_file_contents}} with /dev/stdin
Mohannad Farraga0e37c12022-12-02 14:46:08 +0000754 self.target.args = ['/dev/stdin' if it == gn_utils.RESPONSE_FILE else it
755 for it in self.target.args]
Motomu Utsumicdb45ea2022-12-02 17:05:07 +0900756
757 def _sanitize_outputs(self):
758 pass
759
760 def sanitize(self):
761 self._sanitize_args()
762 self._sanitize_outputs()
763
Motomu Utsumi7db75832022-12-02 16:46:22 +0900764 # Whether this target generates header files
765 def is_header_generated(self):
Motomu Utsumia91ade62022-12-02 16:58:36 +0900766 return any(os.path.splitext(it)[1] == '.h' for it in self.target.outputs)
Motomu Utsumi7db75832022-12-02 16:46:22 +0900767
Mohannad Farrag9ab17932022-11-30 17:28:35 +0000768class WriteBuildDateHeaderSanitizer(BaseActionSanitizer):
Motomu Utsumi805591d2022-12-02 17:17:16 +0900769 def _sanitize_args(self):
Patrick Rohr77c4f5c2022-11-30 12:56:29 -0800770 self._set_arg_at(0, '$(out)')
Motomu Utsumi805591d2022-12-02 17:17:16 +0900771 super()._sanitize_args()
Mohannad Farrag9ab17932022-11-30 17:28:35 +0000772
Mohannad Farrag71353f92022-11-30 17:20:48 +0000773class WriteBuildFlagHeaderSanitizer(BaseActionSanitizer):
Motomu Utsumi805591d2022-12-02 17:17:16 +0900774 def _sanitize_args(self):
Patrick Rohr2cad9332022-11-30 14:27:40 -0800775 self._set_value_arg('--gen-dir', '.')
776 self._set_value_arg('--output', '$(out)')
Motomu Utsumi805591d2022-12-02 17:17:16 +0900777 super()._sanitize_args()
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800778
Patrick Rohr0242a3f2022-11-30 13:48:59 -0800779class JniGeneratorSanitizer(BaseActionSanitizer):
Motomu Utsumi4d551d72022-12-01 16:18:23 +0900780 def _add_location_tag_to_filepath(self, arg):
781 if not arg.endswith('.class'):
782 # --input_file supports both .class specifiers or source files as arguments.
783 # Only source files need to be wrapped inside a $(location <label>) tag.
784 arg = self._add_location_tag(arg)
785 return arg
786
Motomu Utsumi805591d2022-12-02 17:17:16 +0900787 def _sanitize_args(self):
Patrick Rohrf0abead2022-11-30 19:44:10 -0800788 self._update_value_arg('--jar_file', self._sanitize_filepath, False)
789 self._update_value_arg('--jar_file', self._add_location_tag, False)
Patrick Rohr0242a3f2022-11-30 13:48:59 -0800790 if self._has_arg('--jar_file'):
791 self._append_arg('--javap', '$$(find out/.path -name javap)')
Patrick Rohr872a2812022-11-30 19:28:22 -0800792 self._update_value_arg('--output_dir', self._sanitize_filepath)
Patrick Rohrf0abead2022-11-30 19:44:10 -0800793 self._update_value_arg('--includes', self._sanitize_filepath, False)
Patrick Rohr357b25c2022-11-30 19:46:26 -0800794 self._delete_value_arg('--prev_output_dir', False)
Motomu Utsumi4d551d72022-12-01 16:18:23 +0900795 self._update_list_arg('--input_file', self._sanitize_filepath)
796 self._update_list_arg('--input_file', self._add_location_tag_to_filepath)
Motomu Utsumi805591d2022-12-02 17:17:16 +0900797 super()._sanitize_args()
Patrick Rohr0242a3f2022-11-30 13:48:59 -0800798
Motomu Utsumi94019962022-12-02 17:18:58 +0900799 def _sanitize_outputs(self):
Motomu Utsumid4f72642022-12-02 16:01:59 +0900800 # fix target.output directory to match #include statements.
801 self.target.outputs = {re.sub('^jni_headers/', '', out) for out in self.target.outputs}
Motomu Utsumi94019962022-12-02 17:18:58 +0900802 super()._sanitize_outputs()
Motomu Utsumid4f72642022-12-02 16:01:59 +0900803
Motomu Utsumib80903c2022-12-01 16:21:55 +0900804class JniRegistrationGeneratorSanitizer(BaseActionSanitizer):
Motomu Utsumi805591d2022-12-02 17:17:16 +0900805 def _sanitize_args(self):
Motomu Utsumi28cbf2f2022-12-01 16:24:29 +0900806 self._update_value_arg('--depfile', self._sanitize_filepath)
807 self._update_value_arg('--srcjar-path', self._sanitize_filepath)
808 self._update_value_arg('--header-path', self._sanitize_filepath)
Motomu Utsumi55907472022-12-01 16:26:21 +0900809 self._set_value_arg('--sources-files', '$(genDir)/java.sources')
Motomu Utsumi4fe0b952022-12-01 16:29:15 +0900810 # update_jni_registration_module removes them from the srcs of the module
811 # It might be better to remove sources by '--sources-exclusions'
812 self._delete_value_arg('--sources-exclusions')
Motomu Utsumi805591d2022-12-02 17:17:16 +0900813 super()._sanitize_args()
Patrick Rohr0242a3f2022-11-30 13:48:59 -0800814
Mohannad Farrag291f5672022-12-02 15:49:00 +0000815 def get_cmd(self):
816 # jni_registration_generator.py doesn't work with python2
817 cmd = "python3 " + super().get_cmd()
818 # Path in the original sources file does not work in genrule.
819 # So creating sources file in cmd based on the srcs of this target.
820 # Adding ../$(current_dir)/ to the head because jni_registration_generator.py uses the files
821 # whose path startswith(..)
822 commands = ["current_dir=`basename \\\`pwd\\\``;",
823 "for f in $(in);",
824 "do",
825 "echo \\\"../$$current_dir/$$f\\\" >> $(genDir)/java.sources;",
826 "done;",
827 cmd]
828
829 # .h file jni_registration_generator.py generates has #define with directory name.
830 # With the genrule env that contains "." which is invalid. So replace that at the end of cmd.
831 commands.append(";sed -i -e 's/OUT_SOONG_.TEMP_SBOX_.*_OUT/GEN/g' ")
832 commands.append("$(genDir)/components/cronet/android/cronet_jni_registration.h")
833 return NEWLINE.join(commands)
834
Motomu Utsumi6af5b2a2022-12-01 16:33:42 +0900835class VersionSanitizer(BaseActionSanitizer):
Motomu Utsumi805591d2022-12-02 17:17:16 +0900836 def _sanitize_args(self):
Motomu Utsumic6b08b82022-12-01 16:48:19 +0900837 self._set_value_arg('-o', '$(out)')
Motomu Utsumi21485ba2022-12-01 17:01:50 +0900838 # args for the version.py contain file path without leading --arg key. So apply sanitize
839 # function for all the args.
Mohannad Farrag8fa90652022-12-01 15:40:40 +0000840 self._update_all_args(self._sanitize_filepath_with_location_tag)
Motomu Utsumi13399322022-12-02 15:36:48 +0900841 self._update_value_arg('-e', lambda arg: arg.replace('"', r'\"'))
Motomu Utsumi805591d2022-12-02 17:17:16 +0900842 super()._sanitize_args()
Motomu Utsumi6af5b2a2022-12-01 16:33:42 +0900843
Mohannad Farragb73ce0f2022-12-01 15:43:58 +0000844class JavaCppEnumSanitizer(BaseActionSanitizer):
Motomu Utsumi805591d2022-12-02 17:17:16 +0900845 def _sanitize_args(self):
Mohannad Farragb73ce0f2022-12-01 15:43:58 +0000846 self._update_all_args(self._sanitize_filepath_with_location_tag)
847 self._set_value_arg('--srcjar', '$(out)')
Motomu Utsumi805591d2022-12-02 17:17:16 +0900848 super()._sanitize_args()
Mohannad Farragb73ce0f2022-12-01 15:43:58 +0000849
Motomu Utsumi9701d2f2022-12-02 16:53:06 +0900850class MakeDafsaSanitizer(BaseActionSanitizer):
851 def is_header_generated(self):
Motomu Utsumi1e028b82022-12-02 16:54:20 +0900852 # This script generates .cc files but they are #included by other sources
853 # (e.g. registry_controlled_domain.cc)
854 return True
Motomu Utsumi9701d2f2022-12-02 16:53:06 +0900855
Patrick Rohr7f117152022-11-30 13:58:05 -0800856def get_action_sanitizer(target):
857 if target.script == "//build/write_buildflag_header.py":
858 return WriteBuildFlagHeaderSanitizer(target)
859 elif target.script == "//build/write_build_date_header.py":
860 return WriteBuildDateHeaderSanitizer(target)
861 elif target.script == '//base/android/jni_generator/jni_generator.py':
862 return JniGeneratorSanitizer(target)
Motomu Utsumib80903c2022-12-01 16:21:55 +0900863 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
864 return JniRegistrationGeneratorSanitizer(target)
Motomu Utsumi6af5b2a2022-12-01 16:33:42 +0900865 elif target.script == "//build/util/version.py":
866 return VersionSanitizer(target)
Mohannad Farragb73ce0f2022-12-01 15:43:58 +0000867 elif target.script == "//build/android/gyp/java_cpp_enum.py":
868 return JavaCppEnumSanitizer(target)
Motomu Utsumi9701d2f2022-12-02 16:53:06 +0900869 elif target.script == "//net/tools/dafsa/make_dafsa.py":
870 return MakeDafsaSanitizer(target)
Patrick Rohr7f117152022-11-30 13:58:05 -0800871 else:
872 # TODO: throw exception here once all script hacks have been converted.
873 return BaseActionSanitizer(target)
874
Mohannad Farragbab6c892022-11-02 14:09:46 +0000875def create_action_foreach_modules(blueprint, target):
876 """ The following assumes that rebase_path exists in the args.
877 The args of an action_foreach contains hints about which output files are generated
878 by which source files.
879 This is copied directly from the args
880 "gen/net/base/registry_controlled_domains/{{source_name_part}}-reversed-inc.cc"
881 So each source file will generate an output whose name is the {source_name-reversed-inc.cc}
882 """
883 new_args = []
Motomu Utsumi56afcac2022-11-04 12:58:30 +0900884 for i, src in enumerate(sorted(target.sources)):
Mohannad Farragbab6c892022-11-02 14:09:46 +0000885 # don't add script arg for the first source -- create_action_module
886 # already does this.
887 if i != 0:
888 new_args.append('&& python3 $(location %s)' %
889 gn_utils.label_to_path(target.script))
890 for arg in target.args:
891 if '{{source}}' in arg:
892 new_args.append('$(location %s)' % (gn_utils.label_to_path(src)))
893 elif '{{source_name_part}}' in arg:
894 source_name_part = src.split("/")[-1] # Get the file name only
895 source_name_part = source_name_part.split(".")[0] # Remove the extension (Ex: .cc)
896 file_name = arg.replace('{{source_name_part}}', source_name_part).split("/")[-1]
897 # file_name represent the output file name. But we need the whole path
898 # This can be found from target.outputs.
899 for out in target.outputs:
900 if out.endswith(file_name):
901 new_args.append('$(location %s)' % out)
902 else:
903 new_args.append(arg)
904
905 target.args = new_args
Mohannad Farrag7ff99912022-11-29 17:16:00 +0000906 return create_action_module(blueprint, target, 'cc_genrule')
Motomu Utsumia6c33152022-11-02 18:21:55 +0900907
Mohannad Farrag7ff99912022-11-29 17:16:00 +0000908def create_action_module(blueprint, target, type):
Patrick Rohr7be99032022-10-31 11:54:19 -0700909 bp_module_name = label_to_module_name(target.name)
Mohannad Farrag7ff99912022-11-29 17:16:00 +0000910 module = Module(type, bp_module_name, target.name)
Patrick Rohr7be99032022-10-31 11:54:19 -0700911
Patrick Rohrd7de3dd2022-11-30 12:53:26 -0800912 sanitizer = get_action_sanitizer(target)
Motomu Utsumicdb45ea2022-12-02 17:05:07 +0900913 sanitizer.sanitize()
Patrick Rohr9e414b52022-11-29 22:12:18 -0800914 target.args = sanitizer.get_args()
Mohannad Farragc739dda2022-12-02 15:43:46 +0000915 module.cmd = sanitizer.get_cmd()
Motomu Utsumi24213232022-12-02 16:04:05 +0900916 module.out = sanitizer.get_outputs()
Motomu Utsumi7db75832022-12-02 16:46:22 +0900917 if sanitizer.is_header_generated():
918 module.genrule_headers.add(module.name)
Patrick Rohr9b99a982022-10-28 11:00:57 -0700919
Mohannad Farrag9ab17932022-11-30 17:28:35 +0000920 if target.script == '//base/android/jni_generator/jni_generator.py':
Motomu Utsumi747030b2022-12-01 17:47:57 +0900921 # android_jar.classes should be part of the tools as it list implicit classes
922 # for the script to generate JNI headers.
923 module.tool_files.add("base/android/jni_generator/android_jar.classes")
924
Patrick Rohrf6d2b612022-11-09 12:30:26 -0800925 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
926 # jni_registration_generator.py pulls in some config dependencies that we
927 # do not handle. Remove them.
928 # TODO: find a better way to do this.
929 target.deps.clear()
930
Motomu Utsumied009082022-11-10 16:26:44 +0900931 target.inputs = [file for file in target.inputs if not file.startswith('//out/')]
Motomu Utsumi847a6d32022-11-09 17:32:06 +0900932 elif target.script == "//build/util/version.py":
Motomu Utsumib0a49e42022-11-09 18:12:27 +0900933 # android_chrome_version.py is not specified in anywhere but version.py imports this file
934 module.tool_files.add('build/util/android_chrome_version.py')
Patrick Rohr245df582022-11-01 16:59:45 -0700935
Patrick Rohr2041d5b2022-10-26 15:07:53 -0700936 script = gn_utils.label_to_path(target.script)
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700937 module.tool_files.add(script)
Patrick Rohre1a853e2022-10-26 12:31:39 -0700938
Patrick Rohr0db9f852022-10-27 13:49:57 -0700939 # gn treats inputs and sources for actions equally.
940 # soong only supports source files inside srcs, non-source files are added as
941 # tool_files dependency.
942 for it in target.sources or target.inputs:
943 if is_supported_source_file(it):
944 module.srcs.add(gn_utils.label_to_path(it))
945 else:
946 module.tool_files.add(gn_utils.label_to_path(it))
Patrick Rohre1a853e2022-10-26 12:31:39 -0700947
Patrick Rohre1a853e2022-10-26 12:31:39 -0700948 blueprint.add_module(module)
949 return module
950
951
Patrick Rohr92d74122022-10-21 15:50:52 -0700952
Motomu Utsumic34b1372022-11-17 22:15:51 +0900953def _get_cflags(cflags, defines):
954 cflags = {flag for flag in cflags if flag in cflag_allowlist}
Motomu Utsumifa7e9262022-10-26 19:43:02 +0900955 # Consider proper allowlist or denylist if needed
Motomu Utsumic34b1372022-11-17 22:15:51 +0900956 cflags |= set("-D%s" % define.replace("\"", "\\\"") for define in defines)
Patrick Rohr92d74122022-10-21 15:50:52 -0700957 return cflags
958
Motomu Utsumic34b1372022-11-17 22:15:51 +0900959def set_module_flags(module, cflags, defines):
960 module.cflags.update(_get_cflags(cflags, defines))
961 # TODO: implement proper cflag parsing.
962 for flag in cflags:
963 if '-std=' in flag:
964 module.cpp_std = flag[len('-std='):]
Motomu Utsumic34b1372022-11-17 22:15:51 +0900965 if '-fexceptions' in flag:
966 module.cppflags.add('-fexceptions')
Patrick Rohr92d74122022-10-21 15:50:52 -0700967
Mohannad Farrag631443e2022-11-21 16:17:01 +0000968def add_genrule_per_arch(module, dep_module, type):
969 module.generated_headers.update(dep_module.genrule_headers)
970 # If the module is a static library, export all the generated headers.
971 if type == 'cc_library_static':
972 module.export_generated_headers.update(dep_module.genrule_headers)
973 module.srcs.update(dep_module.genrule_srcs)
974 module.shared_libs.update(dep_module.genrule_shared_libs)
975 module.header_libs.update(dep_module.genrule_header_libs)
976
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900977def set_module_include_dirs(module, cflags, include_dirs):
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900978 for flag in cflags:
979 if '-isystem' in flag:
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -0800980 module.local_include_dirs.add(flag[len('-isystem../../'):])
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900981
982 # Adding local_include_dirs is necessary due to source_sets / filegroups
983 # which do not properly propagate include directories.
984 # Filter any directory inside //out as a) this directory does not exist for
985 # aosp / soong builds and b) the include directory should already be
986 # configured via library dependency.
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -0800987 module.local_include_dirs.update([gn_utils.label_to_path(d)
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900988 for d in include_dirs
989 if not re.match('^//out/.*', d)])
Motomu Utsumi88efbb42022-11-17 22:18:15 +0900990
Patrick Rohr92d74122022-10-21 15:50:52 -0700991def create_modules_from_target(blueprint, gn, gn_target_name):
992 """Generate module(s) for a given GN target.
993
994 Given a GN target name, generate one or more corresponding modules into a
995 blueprint. The only case when this generates >1 module is proto libraries.
996
997 Args:
998 blueprint: Blueprint instance which is being generated.
999 gn: gn_utils.GnParser object.
1000 gn_target_name: GN target for module generation.
1001 """
1002 bp_module_name = label_to_module_name(gn_target_name)
1003 if bp_module_name in blueprint.modules:
1004 return blueprint.modules[bp_module_name]
1005 target = gn.get_target(gn_target_name)
Patrick Rohr16228942022-10-26 14:00:26 -07001006 log.info('create modules for %s (%s)', target.name, target.type)
Patrick Rohr92d74122022-10-21 15:50:52 -07001007
Patrick Rohr92d74122022-10-21 15:50:52 -07001008 if target.type == 'executable':
Patrick Rohrc8f41cd2022-11-15 22:46:10 -08001009 if target.testonly:
Patrick Rohr92d74122022-10-21 15:50:52 -07001010 module_type = 'cc_test'
1011 else:
Patrick Rohrc8f41cd2022-11-15 22:46:10 -08001012 # Can be used for both host and device targets.
Patrick Rohr92d74122022-10-21 15:50:52 -07001013 module_type = 'cc_binary'
1014 module = Module(module_type, bp_module_name, gn_target_name)
1015 elif target.type == 'static_library':
1016 module = Module('cc_library_static', bp_module_name, gn_target_name)
1017 elif target.type == 'shared_library':
1018 module = Module('cc_library_shared', bp_module_name, gn_target_name)
1019 elif target.type == 'source_set':
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001020 module = Module('cc_object', bp_module_name, gn_target_name)
Patrick Rohr92d74122022-10-21 15:50:52 -07001021 elif target.type == 'group':
1022 # "group" targets are resolved recursively by gn_utils.get_target().
1023 # There's nothing we need to do at this level for them.
1024 return None
1025 elif target.type == 'proto_library':
1026 module = create_proto_modules(blueprint, gn, target)
1027 if module is None:
1028 return None
1029 elif target.type == 'action':
Mohannad Farrag7ff99912022-11-29 17:16:00 +00001030 if gn_utils.is_java_action(target.script, target.outputs) and \
1031 target.name != "//components/cronet/android:cronet_jni_registration":
1032 # This is a cc_genrule that generates both a c++ header file and
1033 # srcjar for java. Treat it as a cc_genrule for the time being while
1034 # making anothe deep copy of the module and append _java to it for
1035 # the java_library.
1036 module = create_action_module(blueprint, target, 'java_genrule')
1037 else:
1038 module = create_action_module(blueprint, target, 'cc_genrule')
Mohannad Farragf076f3e2022-10-31 17:45:28 +00001039 elif target.type == 'action_foreach':
Mohannad Farragbab6c892022-11-02 14:09:46 +00001040 module = create_action_foreach_modules(blueprint, target)
Patrick Rohr59a76652022-10-26 12:36:56 -07001041 elif target.type == 'copy':
1042 # TODO: careful now! copy targets are not supported yet, but this will stop
1043 # traversing the dependency tree. For //base:base, this is not a big
1044 # problem as libicu contains the only copy target which happens to be a
1045 # leaf node.
1046 return None
Patrick Rohrad440602022-11-10 22:09:04 -08001047 elif target.type == 'java_group':
1048 # Java targets are handled outside of create_modules_from_target.
1049 return None
Patrick Rohr92d74122022-10-21 15:50:52 -07001050 else:
1051 raise Error('Unknown target %s (%s)' % (target.name, target.type))
1052
1053 blueprint.add_module(module)
Patrick Rohr92d74122022-10-21 15:50:52 -07001054 module.init_rc = target_initrc.get(target.name, [])
1055 module.srcs.update(
1056 gn_utils.label_to_path(src)
1057 for src in target.sources
Motomu Utsumif951e502022-11-07 19:31:15 +09001058 if is_supported_source_file(src) and not src.startswith("//out/test"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001059
Patrick Rohr3b5ff762022-11-16 10:22:16 -08001060 # Add arch-specific properties
1061 for arch_name, arch in target.arch.items():
Motomu Utsumi40f95c52022-11-17 19:39:13 +09001062 module.target[arch_name].srcs.update(
1063 gn_utils.label_to_path(src)
1064 for src in arch.sources
1065 if is_supported_source_file(src) and not src.startswith("//out/test"))
Patrick Rohr3b5ff762022-11-16 10:22:16 -08001066
Mohannad Farragbaf0d572022-11-22 11:53:54 +00001067 module.rtti = target.rtti
1068
Patrick Rohr92d74122022-10-21 15:50:52 -07001069 if target.type in gn_utils.LINKER_UNIT_TYPES:
Motomu Utsumic34b1372022-11-17 22:15:51 +09001070 set_module_flags(module, target.cflags, target.defines)
Motomu Utsumi88efbb42022-11-17 22:18:15 +09001071 set_module_include_dirs(module, target.cflags, target.include_dirs)
Motomu Utsumif0f47682022-11-17 22:34:39 +09001072 # TODO: set_module_xxx is confusing, apply similar function to module and target in better way.
1073 for arch_name, arch in target.arch.items():
1074 set_module_flags(module.target[arch_name], arch.cflags, arch.defines)
Motomu Utsumi3371d682022-11-28 16:56:52 +09001075 # -Xclang -target-feature -Xclang +mte are used to enable MTE (Memory Tagging Extensions).
1076 # Flags which does not start with '-' could not be in the cflags so enabling MTE by
1077 # -march and -mcpu Feature Modifiers. MTE is only available on arm64. This is needed for
1078 # building //base/allocator/partition_allocator:partition_alloc for arm64.
1079 if '+mte' in arch.cflags and arch_name == 'android_arm64':
1080 module.target[arch_name].cflags.add('-march=armv8-a+memtag')
Motomu Utsumif0f47682022-11-17 22:34:39 +09001081 set_module_include_dirs(module.target[arch_name], arch.cflags, arch.include_dirs)
Patrick Rohr92d74122022-10-21 15:50:52 -07001082
Mohannad Farragf2391cc2022-11-29 13:26:32 +00001083 module.host_supported = target.host_supported()
1084 module.device_supported = target.device_supported()
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001085
Motomu Utsumi8ca12412022-11-30 16:27:30 +09001086 if module.is_genrule():
1087 module.apex_available.add(tethering_apex)
1088
Mohannad Farragf2391cc2022-11-29 13:26:32 +00001089 if module.is_compiled():
Patrick Rohr92d74122022-10-21 15:50:52 -07001090 # Don't try to inject library/source dependencies into genrules or
1091 # filegroups because they are not compiled in the traditional sense.
1092 module.defaults = [defaults_module]
1093 for lib in target.libs:
1094 # Generally library names should be mangled as 'libXXX', unless they
1095 # are HAL libraries (e.g., android.hardware.health@2.0) or AIDL c++ / NDK
1096 # libraries (e.g. "android.hardware.power.stats-V1-cpp")
1097 android_lib = lib if '@' in lib or "-cpp" in lib or "-ndk" in lib \
1098 else 'lib' + lib
1099 if lib in shared_library_allowlist:
1100 module.add_android_shared_lib(android_lib)
1101 if lib in static_library_allowlist:
1102 module.add_android_static_lib(android_lib)
1103
Patrick Rohrd9dd3b92022-11-09 16:15:30 -08001104 # Remove prohibited include directories
1105 module.local_include_dirs = [d for d in module.local_include_dirs
1106 if d not in local_include_dirs_denylist]
1107
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001108 # If the module is a static library, export all the generated headers.
1109 if module.type == 'cc_library_static':
1110 module.export_generated_headers = module.generated_headers
1111
Motomu Utsumiee47af62022-11-30 16:41:15 +09001112 if module.name == 'cronet_aml_components_cronet_android_cronet':
1113 if target.output_name is None:
1114 raise Error('Failed to get output_name for libcronet name')
1115 # .so file name needs to match with CronetLibraryLoader.java (e.g. libcronet.109.0.5386.0.so)
1116 # So setting the output name based on the output_name from the desc.json
1117 module.stem = 'lib' + target.output_name
1118
Patrick Rohr92d74122022-10-21 15:50:52 -07001119 # dep_name is an unmangled GN target name (e.g. //foo:bar(toolchain)).
Motomu Utsumif1daa232022-11-08 13:28:37 +09001120 # Currently, only one module is generated from target even target has multiple toolchains.
1121 # And module is generated based on the first visited target.
1122 # Sort deps before iteration to make result deterministic.
1123 all_deps = sorted(target.deps | target.source_set_deps | target.transitive_proto_deps)
Patrick Rohr92d74122022-10-21 15:50:52 -07001124 for dep_name in all_deps:
Patrick Rohr5cc46e02022-10-26 14:32:45 -07001125 # |builtin_deps| override GN deps with Android-specific ones. See the
1126 # config in the top of this file.
Patrick Rohr07876662022-11-15 22:55:23 -08001127 if dep_name in builtin_deps:
1128 builtin_deps[dep_name](module)
Patrick Rohr5cc46e02022-10-26 14:32:45 -07001129 continue
1130
Patrick Rohr92d74122022-10-21 15:50:52 -07001131 dep_module = create_modules_from_target(blueprint, gn, dep_name)
1132
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001133 if dep_module is None:
1134 continue
Motomu Utsumie246feb2022-11-01 17:25:56 +09001135 # TODO: Proper dependency check for genrule.
1136 # Currently, only propagating genrule dependencies.
1137 # Also, currently, all the dependencies are propagated upwards.
1138 # in gn, public_deps should be propagated but deps should not.
1139 # Not sure this information is available in the desc.json.
1140 # Following rule works for adding android_runtime_jni_headers to base:base.
1141 # If this doesn't work for other target, hardcoding for specific target
1142 # might be better.
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001143 if module.is_genrule() and dep_module.is_genrule():
1144 module.genrule_headers.add(dep_module.name)
1145 module.genrule_headers.update(dep_module.genrule_headers)
Motomu Utsumie246feb2022-11-01 17:25:56 +09001146
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001147 # For filegroups, and genrule, recurse but don't apply the
Patrick Rohra6ce0232022-11-16 22:09:01 -08001148 # deps.
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001149 if not module.is_compiled() or module.is_genrule():
Patrick Rohr92d74122022-10-21 15:50:52 -07001150 continue
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001151
Patrick Rohr92d74122022-10-21 15:50:52 -07001152 if dep_module.type == 'cc_library_shared':
1153 module.shared_libs.add(dep_module.name)
1154 elif dep_module.type == 'cc_library_static':
1155 module.static_libs.add(dep_module.name)
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001156 elif dep_module.type == 'cc_object':
Mohannad Farragf2391cc2022-11-29 13:26:32 +00001157 module.merge_attribute('generated_headers', dep_module, target.arch.keys())
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001158 if module.type != 'cc_object':
1159 if dep_module.has_input_files():
1160 # Only add it as part of srcs if the dep_module has input files otherwise
1161 # this would throw an error.
1162 module.srcs.add(":" + dep_module.name)
Mohannad Farragf2391cc2022-11-29 13:26:32 +00001163 module.merge_attribute('export_generated_headers', dep_module,
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001164 target.arch.keys(), 'generated_headers')
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001165 elif dep_module.type == 'cc_genrule':
Mohannad Farragf2391cc2022-11-29 13:26:32 +00001166 module.merge_attribute('generated_headers', dep_module, [], 'genrule_headers')
1167 module.merge_attribute('srcs', dep_module, [], 'genrule_srcs')
1168 module.merge_attribute('shared_libs', dep_module, [], 'genrule_shared_libs')
1169 module.merge_attribute('header_libs', dep_module, [], 'genrule_header_libs')
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001170 if module.type not in ["cc_object"]:
Mohannad Farragf2391cc2022-11-29 13:26:32 +00001171 module.merge_attribute('export_generated_headers', dep_module, [],
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001172 'genrule_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -07001173 elif dep_module.type == 'cc_binary':
1174 continue # Ignore executables deps (used by cmdline integration tests).
1175 else:
1176 raise Error('Unknown dep %s (%s) for target %s' %
1177 (dep_module.name, dep_module.type, module.name))
1178
Patrick Rohrb51878f2022-11-16 23:49:03 -08001179 for arch_name, arch in target.arch.items():
1180 for dep_name in arch.deps:
1181 dep_module = create_modules_from_target(blueprint, gn, dep_name)
1182 # Arch-specific dependencies currently only include cc_library_static.
1183 # Revisit this approach once we need to support more target types.
1184 if dep_module.type == 'cc_library_static':
1185 module.target[arch_name].static_libs.add(dep_module.name)
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001186 elif dep_module.type == 'cc_genrule':
1187 if dep_module.name.endswith(arch_name):
1188 module.target[arch_name].generated_headers.update(dep_module.genrule_headers)
1189 module.target[arch_name].srcs.update(dep_module.genrule_srcs)
1190 module.target[arch_name].shared_libs.update(dep_module.genrule_shared_libs)
1191 module.target[arch_name].header_libs.update(dep_module.genrule_header_libs)
1192 if module.type not in ["cc_object"]:
1193 module.target[arch_name].export_generated_headers.update(
1194 dep_module.genrule_headers)
Patrick Rohrb51878f2022-11-16 23:49:03 -08001195 else:
1196 raise Error('Unsupported arch-specific dependency %s of target %s with type %s' %
1197 (dep_module.name, target.name, dep_module.type))
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001198 for dep_name in arch.source_set_deps:
1199 dep_module = create_modules_from_target(blueprint, gn, dep_name)
1200 if dep_module.type == 'cc_object':
1201 if module.type != 'cc_object':
1202 # We only want to bubble up cc_objects for modules that are not cc_objects
1203 # otherwise they'd be recompiled and that would cause multiple symbol redefinitions.
1204 if dep_module.has_input_files():
1205 # Only add it as part of srcs if the dep_module has input files otherwise
1206 # this would throw an error.
1207 module.target[arch_name].srcs.add(":" + dep_module.name)
1208 else:
1209 raise Error('Unsupported arch-specific dependency %s of target %s with type %s' %
1210 (dep_module.name, target.name, dep_module.type))
Patrick Rohr92d74122022-10-21 15:50:52 -07001211 return module
1212
Patrick Rohrb18aca22022-11-04 15:07:32 -07001213def create_java_module(blueprint, gn):
1214 bp_module_name = module_prefix + 'java'
1215 module = Module('java_library', bp_module_name, '//gn:java')
Mohannad Farrag21562d62022-11-07 13:09:31 +00001216 module.srcs.update([gn_utils.label_to_path(source) for source in gn.java_sources])
Mohannad Farrag6a2d88a2022-11-28 19:33:48 +00001217 for dep in gn.java_actions:
Mohannad Farragc1a0d612022-12-01 17:33:02 +00001218 dep_module = create_modules_from_target(blueprint, gn, dep)
1219 if "cronet_jni_registration" in dep_module.name:
1220 dep_module = copy.deepcopy(dep_module)
1221 dep_module.name += "_java"
1222 dep_module.type = 'java_genrule'
1223 dep_module.out = [out for out in dep_module.out if out.endswith(".srcjar")]
Patrick Rohrb18aca22022-11-04 15:07:32 -07001224 blueprint.add_module(module)
Patrick Rohr92d74122022-10-21 15:50:52 -07001225
Patrick Rohr6ef22722022-11-18 18:24:01 -08001226def update_jni_registration_module(module, gn):
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001227 # TODO: deny list is in the arg of jni_registration_generator.py. Should not be hardcoded
1228 deny_list = [
1229 '//base/android/java/src/org/chromium/base/library_loader/LibraryLoader.java',
1230 '//base/android/java/src/org/chromium/base/library_loader/LibraryPrefetcher.java',
1231 '//base/android/java/src/org/chromium/base/process_launcher/ChildProcessService.java',
1232 '//base/android/java/src/org/chromium/base/SysUtils.java']
1233
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001234 # TODO: java_sources might not contain all the required java files
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001235 module.srcs.update([gn_utils.label_to_path(source)
1236 for source in gn.java_sources if source not in deny_list])
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001237
Motomu Utsumia71281c2022-11-18 15:19:00 +09001238def create_blueprint_for_targets(gn, targets):
Patrick Rohr92d74122022-10-21 15:50:52 -07001239 """Generate a blueprint for a list of GN targets."""
1240 blueprint = Blueprint()
1241
1242 # Default settings used by all modules.
1243 defaults = Module('cc_defaults', defaults_module, '//gn:default_deps')
Patrick Rohr92d74122022-10-21 15:50:52 -07001244 defaults.cflags = [
Patrick Rohr3ce74772022-11-11 14:19:58 -08001245 '-DGOOGLE_PROTOBUF_NO_RTTI',
Patrick Rohr92d74122022-10-21 15:50:52 -07001246 '-Wno-error=return-type',
Patrick Rohr3a1ec1d2022-10-31 13:30:17 -07001247 '-Wno-non-virtual-dtor',
Patrick Rohr5c700022022-11-08 19:33:07 -08001248 '-Wno-macro-redefined',
Patrick Rohr98065152022-10-31 14:49:58 -07001249 '-Wno-missing-field-initializers',
Patrick Rohr92d74122022-10-21 15:50:52 -07001250 '-Wno-sign-compare',
1251 '-Wno-sign-promo',
1252 '-Wno-unused-parameter',
Mohannad Farrag54d52442022-11-21 16:27:02 +00001253 '-Wno-null-pointer-subtraction', # Needed to libevent
Mohannad Farragd98a96d2022-11-10 14:56:19 +00001254 '-Wno-deprecated-non-prototype', # needed for zlib
Patrick Rohr92d74122022-10-21 15:50:52 -07001255 '-fvisibility=hidden',
Motomu Utsumiba020942022-11-14 15:15:41 +09001256 '-Wno-ambiguous-reversed-operator', # needed for icui18n
Motomu Utsumib1ec8782022-11-14 15:25:57 +09001257 '-Wno-unreachable-code-loop-increment', # needed for icui18n
Patrick Rohr92d74122022-10-21 15:50:52 -07001258 '-O2',
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001259 '-fPIC',
Patrick Rohr92d74122022-10-21 15:50:52 -07001260 ]
Patrick Rohrc03f1bb2022-11-18 16:13:17 -08001261 # Chromium builds do not add a dependency for headers found inside the
1262 # sysroot, so they are added globally via defaults.
1263 defaults.target['android'].header_libs = [
1264 'media_ndk_headers',
1265 'jni_headers',
1266 ]
Patrick Rohr5446df82022-11-18 14:54:55 -08001267 defaults.target['host'].cflags = [
1268 # -DANDROID is added by default but target.defines contain -DANDROID if
1269 # it's required. So adding -UANDROID to cancel default -DANDROID if it's
1270 # not specified.
1271 # Note: -DANDROID is not consistently applied across the chromium code
1272 # base, so it is removed unconditionally for host targets.
1273 '-UANDROID',
1274 ]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001275 defaults.stl = 'none'
Motomu Utsumi8ca12412022-11-30 16:27:30 +09001276 defaults.min_sdk_version = 29
1277 defaults.apex_available.add(tethering_apex)
Patrick Rohr92d74122022-10-21 15:50:52 -07001278 blueprint.add_module(defaults)
Patrick Rohr344b2472022-10-25 11:32:15 -07001279
Patrick Rohr92d74122022-10-21 15:50:52 -07001280 for target in targets:
1281 create_modules_from_target(blueprint, gn, target)
Patrick Rohrb18aca22022-11-04 15:07:32 -07001282
1283 create_java_module(blueprint, gn)
Patrick Rohr6ef22722022-11-18 18:24:01 -08001284 for module in blueprint.modules.values():
1285 if 'cronet_jni_registration' in module.name:
1286 update_jni_registration_module(module, gn)
Patrick Rohra7d029d2022-11-08 12:23:11 -08001287
1288 # Merge in additional hardcoded arguments.
1289 for module in blueprint.modules.values():
1290 for key, add_val in additional_args.get(module.name, []):
1291 curr = getattr(module, key)
1292 if add_val and isinstance(add_val, set) and isinstance(curr, set):
1293 curr.update(add_val)
1294 elif isinstance(add_val, str) and (not curr or isinstance(curr, str)):
1295 setattr(module, key, add_val)
1296 elif isinstance(add_val, bool) and (not curr or isinstance(curr, bool)):
1297 setattr(module, key, add_val)
1298 elif isinstance(add_val, dict) and isinstance(curr, dict):
1299 curr.update(add_val)
1300 elif isinstance(add_val, dict) and isinstance(curr, Target):
1301 curr.__dict__.update(add_val)
1302 else:
1303 raise Error('Unimplemented type %r of additional_args: %r' %
1304 (type(add_val), key))
1305
Patrick Rohr92d74122022-10-21 15:50:52 -07001306 return blueprint
1307
1308
1309def main():
1310 parser = argparse.ArgumentParser(
1311 description='Generate Android.bp from a GN description.')
1312 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001313 '--desc',
Motomu Utsumi879dec82022-11-18 15:25:12 +09001314 help='GN description (e.g., gn desc out --format=json --all-toolchains "//*".' +
1315 'You can specify multiple --desc options for different target_cpu',
1316 required=True,
1317 action='append'
Patrick Rohr92d74122022-10-21 15:50:52 -07001318 )
1319 parser.add_argument(
1320 '--extras',
1321 help='Extra targets to include at the end of the Blueprint file',
1322 default=os.path.join(gn_utils.repo_root(), 'Android.bp.extras'),
1323 )
1324 parser.add_argument(
1325 '--output',
1326 help='Blueprint file to create',
1327 default=os.path.join(gn_utils.repo_root(), 'Android.bp'),
1328 )
1329 parser.add_argument(
Patrick Rohr16228942022-10-26 14:00:26 -07001330 '-v',
1331 '--verbose',
1332 help='Print debug logs.',
1333 action='store_true',
1334 )
1335 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001336 'targets',
1337 nargs=argparse.REMAINDER,
Patrick Rohr1aa504a2022-10-25 10:30:42 -07001338 help='Targets to include in the blueprint (e.g., "//:perfetto_tests")'
1339 )
Patrick Rohr92d74122022-10-21 15:50:52 -07001340 args = parser.parse_args()
1341
Patrick Rohr16228942022-10-26 14:00:26 -07001342 if args.verbose:
1343 log.basicConfig(format='%(levelname)s:%(funcName)s:%(message)s', level=log.DEBUG)
1344
Patrick Rohrd0077b72022-11-15 12:43:26 -08001345 targets = args.targets or default_targets
Motomu Utsumi879dec82022-11-18 15:25:12 +09001346 gn = gn_utils.GnParser()
1347 for desc_file in args.desc:
1348 with open(desc_file) as f:
1349 desc = json.load(f)
1350 for target in targets:
1351 gn.parse_gn_desc(desc, target)
Motomu Utsumia71281c2022-11-18 15:19:00 +09001352 blueprint = create_blueprint_for_targets(gn, targets)
Patrick Rohr92d74122022-10-21 15:50:52 -07001353 project_root = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
1354 tool_name = os.path.relpath(os.path.abspath(__file__), project_root)
1355
Patrick Rohr92d74122022-10-21 15:50:52 -07001356 # Add any proto groups to the blueprint.
1357 for l_name, t_names in proto_groups.items():
1358 create_proto_group_modules(blueprint, gn, l_name, t_names)
1359
1360 output = [
Patrick Rohr5478b392022-10-25 09:58:50 -07001361 """// Copyright (C) 2022 The Android Open Source Project
Patrick Rohr92d74122022-10-21 15:50:52 -07001362//
1363// Licensed under the Apache License, Version 2.0 (the "License");
1364// you may not use this file except in compliance with the License.
1365// You may obtain a copy of the License at
1366//
1367// http://www.apache.org/licenses/LICENSE-2.0
1368//
1369// Unless required by applicable law or agreed to in writing, software
1370// distributed under the License is distributed on an "AS IS" BASIS,
1371// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1372// See the License for the specific language governing permissions and
1373// limitations under the License.
1374//
1375// This file is automatically generated by %s. Do not edit.
1376""" % (tool_name)
1377 ]
1378 blueprint.to_string(output)
Patrick Rohrcb98e9b2022-10-25 09:57:02 -07001379 if os.path.exists(args.extras):
1380 with open(args.extras, 'r') as r:
1381 for line in r:
1382 output.append(line.rstrip("\n\r"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001383
1384 out_files = []
1385
1386 # Generate the Android.bp file.
1387 out_files.append(args.output + '.swp')
1388 with open(out_files[-1], 'w') as f:
1389 f.write('\n'.join(output))
1390 # Text files should have a trailing EOL.
1391 f.write('\n')
1392
Patrick Rohr94693eb2022-10-25 10:09:16 -07001393 return 0
Patrick Rohr92d74122022-10-21 15:50:52 -07001394
1395
1396if __name__ == '__main__':
1397 sys.exit(main())