blob: c750c2adc75bf7f250177cd52a903acb2cd1d09a [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
Patrick Rohr92d74122022-10-21 15:50:52 -070029import json
Patrick Rohr16228942022-10-26 14:00:26 -070030import logging as log
Patrick Rohr3a2c3dd2022-11-29 22:29:36 -080031import operator
Patrick Rohr92d74122022-10-21 15:50:52 -070032import os
33import re
34import sys
Motomu Utsumic6277d92022-11-07 15:15:17 +090035import copy
Mohannad Farrag9c2cee12022-12-06 17:11:25 +000036from pathlib import Path
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 Utsumiddcc9082022-12-22 15:53:28 +090045 '//components/cronet/android:cronet_android_mainline',
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 Rohr3d1059c2022-12-21 11:04:33 -080096 'third_party/zlib/',
Patrick Rohrd9dd3b92022-11-09 16:15:30 -080097]
98
Patrick Rohr3d1059c2022-12-21 11:04:33 -080099experimental_include_dirs_denylist = [
Patrick Rohrfeed2232022-12-15 11:38:12 -0800100 'third_party/brotli/include/',
Patrick Rohr10b746f2022-12-14 20:08:43 -0800101]
102
Patrick Rohr92d74122022-10-21 15:50:52 -0700103# Name of the module which settings such as compiler flags for all other
104# modules.
105defaults_module = module_prefix + 'defaults'
106
107# Location of the project in the Android source tree.
Motomu Utsumiad6323c2022-12-22 19:20:01 +0900108tree_path = 'external/cronet'
Patrick Rohr92d74122022-10-21 15:50:52 -0700109
110# Path for the protobuf sources in the standalone build.
111buildtools_protobuf_src = '//buildtools/protobuf/src'
112
113# Location of the protobuf src dir in the Android source tree.
114android_protobuf_src = 'external/protobuf/src'
115
Mohannad Farragc739dda2022-12-02 15:43:46 +0000116# put all args on a new line for better diffs.
117NEWLINE = ' " +\n "'
Mohannad Farrag00ecfb52022-12-02 14:44:15 +0000118
Patrick Rohr92d74122022-10-21 15:50:52 -0700119# Compiler flags which are passed through to the blueprint.
Motomu Utsumic8b7bea2022-11-16 18:12:44 +0900120cflag_allowlist = [
Motomu Utsumicf68d732022-11-16 18:15:21 +0900121 # needed for zlib:zlib
122 "-mpclmul",
123 # needed for zlib:zlib
124 "-mssse3",
Mohannad Farrag7f29d832022-11-23 19:52:41 +0000125 # needed for zlib:zlib
126 "-msse3",
127 # needed for zlib:zlib
128 "-msse4.2",
Motomu Utsumic8b7bea2022-11-16 18:12:44 +0900129]
Patrick Rohr92d74122022-10-21 15:50:52 -0700130
Patrick Rohr92d74122022-10-21 15:50:52 -0700131# Additional arguments to apply to Android.bp rules.
132additional_args = {
Patrick Rohr2267a0a2022-11-08 18:59:34 -0800133 # TODO: remove if not needed.
Patrick Rohrd90025f2022-11-11 14:18:35 -0800134 'cronet_aml_components_cronet_android_cronet': [
135 ('linker_scripts', {
136 'base/android/library_loader/anchor_functions.lds',
137 }),
138 ],
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800139 'cronet_aml_net_net': [
Patrick Rohr9f4d3e32022-11-09 16:37:31 -0800140 ('export_static_lib_headers', {
141 'cronet_aml_net_third_party_quiche_quiche',
142 'cronet_aml_crypto_crypto',
143 }),
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000144 ],
Patrick Rohrbaaf1602022-12-22 14:02:48 -0800145 # TODO: fix upstream. Both //base:base and
146 # //base/allocator/partition_allocator:partition_alloc do not create a
147 # dependency on gtest despite using gtest_prod.h.
148 'cronet_aml_base_base': [
149 ('header_libs', {
150 'libgtest_prod_headers',
151 }),
152 ('export_header_lib_headers', {
153 'libgtest_prod_headers',
154 }),
155 ],
156 'cronet_aml_base_allocator_partition_allocator_partition_alloc': [
157 ('header_libs', {
158 'libgtest_prod_headers',
159 }),
160 ],
Patrick Rohr92d74122022-10-21 15:50:52 -0700161}
162
Patrick Rohrfeed2232022-12-15 11:38:12 -0800163def enable_brotli(module, arch):
164 # Requires crrev/c/4111690
165 if arch is None:
166 module.static_libs.add('libbrotli')
167 else:
168 module.arch[arch].static_libs.add('libbrotli')
169
Patrick Rohrce210882022-12-15 16:24:39 -0800170def enable_modp_b64(module, arch):
171 # Requires crrev/c/4112845
172 # Requires aosp/2359455
173 # Requires aosp/2359456
174 if not module.is_compiled():
175 return
176 if arch is None:
177 module.static_libs.add('libmodpb64')
178 else:
179 module.arch[arch].static_libs.add('libmodpb64')
Patrick Rohrfeed2232022-12-15 11:38:12 -0800180
Patrick Rohr10b746f2022-12-14 20:08:43 -0800181def enable_zlib(module, arch):
182 # Requires crrev/c/4109079
183 if arch is None:
184 module.shared_libs.add('libz')
185 else:
186 module.arch[arch].shared_libs.add('libz')
187
Patrick Rohr92d74122022-10-21 15:50:52 -0700188# Android equivalents for third-party libraries that the upstream project
189# depends on.
190builtin_deps = {
Patrick Rohrdd10b432022-12-13 14:46:16 -0800191 '//buildtools/third_party/libunwind:libunwind':
Patrick Rohr25926e62022-12-14 19:55:57 -0800192 lambda m, a: None, # disable libunwind
Patrick Rohr14ee0932022-11-15 12:10:27 -0800193 '//net/tools/root_store_tool:root_store_tool':
Patrick Rohr25926e62022-12-14 19:55:57 -0800194 lambda m, a: None,
Patrick Rohr3d1059c2022-12-21 11:04:33 -0800195 '//third_party/zlib:zlib':
196 enable_zlib,
Patrick Rohr92d74122022-10-21 15:50:52 -0700197}
198
Patrick Rohr3d1059c2022-12-21 11:04:33 -0800199experimental_android_deps = {
Patrick Rohrfeed2232022-12-15 11:38:12 -0800200 '//third_party/brotli:common':
201 enable_brotli,
202 '//third_party/brotli:dec':
203 enable_brotli,
Patrick Rohrce210882022-12-15 16:24:39 -0800204 '//third_party/modp_b64:modp_b64':
205 enable_modp_b64,
Patrick Rohr10b746f2022-12-14 20:08:43 -0800206}
207
208# Uncomment the following lines to use Android deps rather than their Chromium
209# equivalent:
Patrick Rohr3d1059c2022-12-21 11:04:33 -0800210#builtin_deps.update(experimental_android_deps)
211#local_include_dirs_denylist.extend(experimental_include_dirs_denylist)
Patrick Rohr10b746f2022-12-14 20:08:43 -0800212
Motomu Utsumi8ca12412022-11-30 16:27:30 +0900213# Name of tethering apex module
214tethering_apex = "com.android.tethering"
215
Motomu Utsumi1002cd82022-12-23 17:19:03 +0900216# Name of cronet api target
217java_api_target_name = "//components/cronet/android:cronet_api_java"
218
Patrick Rohr92d74122022-10-21 15:50:52 -0700219# ----------------------------------------------------------------------------
220# End of configuration.
221# ----------------------------------------------------------------------------
222
223
224class Error(Exception):
225 pass
226
227
228class ThrowingArgumentParser(argparse.ArgumentParser):
229
230 def __init__(self, context):
231 super(ThrowingArgumentParser, self).__init__()
232 self.context = context
233
234 def error(self, message):
235 raise Error('%s: %s' % (self.context, message))
236
237
238def write_blueprint_key_value(output, name, value, sort=True):
239 """Writes a Blueprint key-value pair to the output"""
240
241 if isinstance(value, bool):
242 if value:
243 output.append(' %s: true,' % name)
244 else:
245 output.append(' %s: false,' % name)
246 return
247 if not value:
248 return
249 if isinstance(value, set):
250 value = sorted(value)
251 if isinstance(value, list):
252 output.append(' %s: [' % name)
253 for item in sorted(value) if sort else value:
254 output.append(' "%s",' % item)
255 output.append(' ],')
256 return
257 if isinstance(value, Target):
258 value.to_string(output)
259 return
260 if isinstance(value, dict):
261 kv_output = []
262 for k, v in value.items():
263 write_blueprint_key_value(kv_output, k, v)
264
265 output.append(' %s: {' % name)
266 for line in kv_output:
267 output.append(' %s' % line)
268 output.append(' },')
269 return
270 output.append(' %s: "%s",' % (name, value))
271
272
273class Target(object):
274 """A target-scoped part of a module"""
275
276 def __init__(self, name):
277 self.name = name
Patrick Rohr5d399b32022-11-16 10:19:55 -0800278 self.srcs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700279 self.shared_libs = set()
280 self.static_libs = set()
281 self.whole_static_libs = set()
Patrick Rohrc03f1bb2022-11-18 16:13:17 -0800282 self.header_libs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700283 self.cflags = set()
284 self.dist = dict()
285 self.strip = dict()
286 self.stl = None
Motomu Utsumi50ad2172022-11-17 22:29:53 +0900287 self.cppflags = set()
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -0800288 self.local_include_dirs = set()
Patrick Rohr81435162022-11-17 19:34:32 -0800289 self.export_system_include_dirs = set()
Mohannad Farrag631443e2022-11-21 16:17:01 +0000290 self.generated_headers = set()
291 self.export_generated_headers = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700292
293 def to_string(self, output):
294 nested_out = []
Patrick Rohr5d399b32022-11-16 10:19:55 -0800295 self._output_field(nested_out, 'srcs')
Patrick Rohr92d74122022-10-21 15:50:52 -0700296 self._output_field(nested_out, 'shared_libs')
297 self._output_field(nested_out, 'static_libs')
298 self._output_field(nested_out, 'whole_static_libs')
Patrick Rohrc03f1bb2022-11-18 16:13:17 -0800299 self._output_field(nested_out, 'header_libs')
Patrick Rohr92d74122022-10-21 15:50:52 -0700300 self._output_field(nested_out, 'cflags')
301 self._output_field(nested_out, 'stl')
302 self._output_field(nested_out, 'dist')
303 self._output_field(nested_out, 'strip')
Motomu Utsumi50ad2172022-11-17 22:29:53 +0900304 self._output_field(nested_out, 'cppflags')
305 self._output_field(nested_out, 'local_include_dirs')
Patrick Rohr81435162022-11-17 19:34:32 -0800306 self._output_field(nested_out, 'export_system_include_dirs')
Mohannad Farrag631443e2022-11-21 16:17:01 +0000307 self._output_field(nested_out, 'generated_headers')
308 self._output_field(nested_out, 'export_generated_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -0700309
310 if nested_out:
311 output.append(' %s: {' % self.name)
312 for line in nested_out:
313 output.append(' %s' % line)
314 output.append(' },')
315
316 def _output_field(self, output, name, sort=True):
317 value = getattr(self, name)
318 return write_blueprint_key_value(output, name, value, sort)
319
320
321class Module(object):
322 """A single module (e.g., cc_binary, cc_test) in a blueprint."""
323
324 def __init__(self, mod_type, name, gn_target):
325 self.type = mod_type
326 self.gn_target = gn_target
327 self.name = name
328 self.srcs = set()
Patrick Rohr07876662022-11-15 22:55:23 -0800329 self.comment = 'GN: ' + gn_target
Patrick Rohr92d74122022-10-21 15:50:52 -0700330 self.shared_libs = set()
331 self.static_libs = set()
332 self.whole_static_libs = set()
333 self.runtime_libs = set()
334 self.tools = set()
335 self.cmd = None
336 self.host_supported = False
Patrick Rohrcdda6322022-11-15 22:44:16 -0800337 self.device_supported = True
Patrick Rohr92d74122022-10-21 15:50:52 -0700338 self.vendor_available = False
339 self.init_rc = set()
340 self.out = set()
341 self.export_include_dirs = set()
342 self.generated_headers = set()
343 self.export_generated_headers = set()
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800344 self.export_static_lib_headers = set()
Patrick Rohrbaaf1602022-12-22 14:02:48 -0800345 self.export_header_lib_headers = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700346 self.defaults = set()
347 self.cflags = set()
348 self.include_dirs = set()
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -0800349 self.local_include_dirs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700350 self.header_libs = set()
351 self.required = set()
Patrick Rohr3d8c7282022-10-27 13:36:31 -0700352 self.tool_files = set()
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800353 # target contains a dict of Targets indexed by os_arch.
354 # example: { 'android_x86': Target('android_x86')
355 self.target = dict()
356 self.target['android'] = Target('android')
Patrick Rohr82e40742022-11-16 10:20:39 -0800357 self.target['android_x86'] = Target('android_x86')
358 self.target['android_x86_64'] = Target('android_x86_64')
359 self.target['android_arm'] = Target('android_arm')
360 self.target['android_arm64'] = Target('android_arm64')
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800361 self.target['host'] = Target('host')
Patrick Rohr92d74122022-10-21 15:50:52 -0700362 self.stl = None
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700363 self.cpp_std = None
Patrick Rohr92d74122022-10-21 15:50:52 -0700364 self.dist = dict()
365 self.strip = dict()
366 self.data = set()
367 self.apex_available = set()
368 self.min_sdk_version = None
369 self.proto = dict()
Patrick Rohrd90025f2022-11-11 14:18:35 -0800370 self.linker_scripts = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700371 # The genrule_XXX below are properties that must to be propagated back
372 # on the module(s) that depend on the genrule.
373 self.genrule_headers = set()
374 self.genrule_srcs = set()
375 self.genrule_shared_libs = set()
Patrick Rohra1a27872022-10-31 11:57:14 -0700376 self.genrule_header_libs = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700377 self.version_script = None
378 self.test_suites = set()
379 self.test_config = None
380 self.stubs = {}
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000381 self.cppflags = set()
382 self.rtti = False
Motomu Utsumiee47af62022-11-30 16:41:15 +0900383 # Name of the output. Used for setting .so file name for libcronet
Mohannad Farrage815d862022-12-06 17:51:43 +0000384 self.libs = set()
Motomu Utsumiee47af62022-11-30 16:41:15 +0900385 self.stem = None
Motomu Utsumi81bb8342022-12-08 11:47:42 +0900386 self.compile_multilib = None
Mohannad Farragb30d3712022-12-06 17:27:04 +0000387 self.aidl = dict()
Mohannad Farrag3d3d6132022-12-06 18:11:48 +0000388 self.plugins = set()
Mohannad Farrag89f38e42022-12-06 18:54:46 +0000389 self.processor_class = None
Motomu Utsumiba3be9e2022-12-09 15:32:12 +0900390 self.sdk_version = None
Patrick Rohr8d393192022-12-22 14:50:20 -0800391 self.javacflags = set()
Patrick Rohr92d74122022-10-21 15:50:52 -0700392
393 def to_string(self, output):
394 if self.comment:
395 output.append('// %s' % self.comment)
396 output.append('%s {' % self.type)
397 self._output_field(output, 'name')
398 self._output_field(output, 'srcs')
399 self._output_field(output, 'shared_libs')
400 self._output_field(output, 'static_libs')
401 self._output_field(output, 'whole_static_libs')
402 self._output_field(output, 'runtime_libs')
403 self._output_field(output, 'tools')
404 self._output_field(output, 'cmd', sort=False)
405 if self.host_supported:
406 self._output_field(output, 'host_supported')
Patrick Rohrcdda6322022-11-15 22:44:16 -0800407 if not self.device_supported:
408 self._output_field(output, 'device_supported')
Patrick Rohr92d74122022-10-21 15:50:52 -0700409 if self.vendor_available:
410 self._output_field(output, 'vendor_available')
411 self._output_field(output, 'init_rc')
412 self._output_field(output, 'out')
413 self._output_field(output, 'export_include_dirs')
414 self._output_field(output, 'generated_headers')
415 self._output_field(output, 'export_generated_headers')
Patrick Rohrbb0956e2022-11-09 15:37:16 -0800416 self._output_field(output, 'export_static_lib_headers')
Patrick Rohrbaaf1602022-12-22 14:02:48 -0800417 self._output_field(output, 'export_header_lib_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -0700418 self._output_field(output, 'defaults')
419 self._output_field(output, 'cflags')
420 self._output_field(output, 'include_dirs')
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -0800421 self._output_field(output, 'local_include_dirs')
Patrick Rohr92d74122022-10-21 15:50:52 -0700422 self._output_field(output, 'header_libs')
423 self._output_field(output, 'required')
424 self._output_field(output, 'dist')
425 self._output_field(output, 'strip')
426 self._output_field(output, 'tool_files')
427 self._output_field(output, 'data')
428 self._output_field(output, 'stl')
Patrick Rohrb8f830a2022-10-31 11:18:57 -0700429 self._output_field(output, 'cpp_std')
Patrick Rohr92d74122022-10-21 15:50:52 -0700430 self._output_field(output, 'apex_available')
431 self._output_field(output, 'min_sdk_version')
432 self._output_field(output, 'version_script')
433 self._output_field(output, 'test_suites')
434 self._output_field(output, 'test_config')
435 self._output_field(output, 'stubs')
436 self._output_field(output, 'proto')
Patrick Rohrd90025f2022-11-11 14:18:35 -0800437 self._output_field(output, 'linker_scripts')
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000438 self._output_field(output, 'cppflags')
Mohannad Farrage815d862022-12-06 17:51:43 +0000439 self._output_field(output, 'libs')
Motomu Utsumiee47af62022-11-30 16:41:15 +0900440 self._output_field(output, 'stem')
Motomu Utsumi81bb8342022-12-08 11:47:42 +0900441 self._output_field(output, 'compile_multilib')
Mohannad Farragb30d3712022-12-06 17:27:04 +0000442 self._output_field(output, 'aidl')
Mohannad Farrag3d3d6132022-12-06 18:11:48 +0000443 self._output_field(output, 'plugins')
Mohannad Farrag89f38e42022-12-06 18:54:46 +0000444 self._output_field(output, 'processor_class')
Motomu Utsumiba3be9e2022-12-09 15:32:12 +0900445 self._output_field(output, 'sdk_version')
Patrick Rohr8d393192022-12-22 14:50:20 -0800446 self._output_field(output, 'javacflags')
Mohannad Farrag37388fa2022-11-10 20:42:13 +0000447 if self.rtti:
448 self._output_field(output, 'rtti')
Patrick Rohr92d74122022-10-21 15:50:52 -0700449
450 target_out = []
Patrick Rohr09ee70e2022-11-16 15:20:03 -0800451 for arch, target in sorted(self.target.items()):
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800452 # _output_field calls getattr(self, arch).
453 setattr(self, arch, target)
454 self._output_field(target_out, arch)
455
Patrick Rohr92d74122022-10-21 15:50:52 -0700456 if target_out:
457 output.append(' target: {')
458 for line in target_out:
459 output.append(' %s' % line)
460 output.append(' },')
461
Patrick Rohr92d74122022-10-21 15:50:52 -0700462 output.append('}')
463 output.append('')
464
465 def add_android_static_lib(self, lib):
466 if self.type == 'cc_binary_host':
467 raise Exception('Adding Android static lib for host tool is unsupported')
468 elif self.host_supported:
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800469 self.target['android'].static_libs.add(lib)
Patrick Rohr92d74122022-10-21 15:50:52 -0700470 else:
471 self.static_libs.add(lib)
472
473 def add_android_shared_lib(self, lib):
474 if self.type == 'cc_binary_host':
475 raise Exception('Adding Android shared lib for host tool is unsupported')
476 elif self.host_supported:
Patrick Rohrbfdc5fd2022-11-16 10:03:49 -0800477 self.target['android'].shared_libs.add(lib)
Patrick Rohr92d74122022-10-21 15:50:52 -0700478 else:
479 self.shared_libs.add(lib)
480
481 def _output_field(self, output, name, sort=True):
482 value = getattr(self, name)
483 return write_blueprint_key_value(output, name, value, sort)
484
Patrick Rohra6ce0232022-11-16 22:09:01 -0800485 def is_compiled(self):
Mohannad Farrag7ff99912022-11-29 17:16:00 +0000486 return self.type not in ('cc_genrule', 'filegroup', 'java_genrule')
Mohannad Farrag1de6cb12022-11-28 12:27:26 +0000487
488 def is_genrule(self):
489 return self.type == "cc_genrule"
Patrick Rohra6ce0232022-11-16 22:09:01 -0800490
Mohannad Farrag7f29d832022-11-23 19:52:41 +0000491 def has_input_files(self):
Mohannad Farrag7f29d832022-11-23 19:52:41 +0000492 return len(self.srcs) > 0 or any([len(target.srcs) > 0 for target in self.target.values()])
493
Mohannad Farragf2391cc2022-11-29 13:26:32 +0000494 def merge_attribute(self, key, source_module, allowed_archs, source_key = None):
495 """
496 Merges the value of the attribute `source_key` for the `dep_module` with
497 the value of the attribute `key` for this module. If the value of the
498 `source_key` is equal to None. Then `key` is used for both modules.
499
500 This merges the attribute for both non-arch and archs
501 specified in `allowed_archs`.
502 :param key: The attribute used for merging in the calling module. Also
503 used for `dep_module` if the `source_key` is None.
504 :param source_module: The module where data is propagated from.
505 :param allowed_archs: A list of archs to merge the attribute on.
506 :param source_key: if the attribute merged from the `dep_module`
507 is different from the `key`
508 """
509 if not source_key:
510 source_key = key
511 self.__dict__[key].update(source_module.__dict__[source_key])
512 for arch_name in source_module.target.keys():
513 if arch_name in allowed_archs:
514 self.target[arch_name].__dict__[key].update(
515 source_module.target[arch_name].__dict__[source_key])
Patrick Rohr92d74122022-10-21 15:50:52 -0700516
517class Blueprint(object):
518 """In-memory representation of an Android.bp file."""
519
520 def __init__(self):
521 self.modules = {}
522
523 def add_module(self, module):
524 """Adds a new module to the blueprint, replacing any existing module
525 with the same name.
526
527 Args:
528 module: Module instance.
529 """
530 self.modules[module.name] = module
531
532 def to_string(self, output):
Patrick Rohr23f26192022-10-25 09:45:22 -0700533 for m in sorted(self.modules.values(), key=lambda m: m.name):
Mohannad Farragb6dbca92022-12-29 11:49:04 +0000534 if m.type != "cc_object" or m.has_input_files():
535 # Don't print cc_object with empty srcs. These attributes are already
536 # propagated up the tree. Printing them messes the presubmits because
537 # every module is compiled while those targets are not reachable in
538 # a normal compilation path.
539 m.to_string(output)
Patrick Rohr92d74122022-10-21 15:50:52 -0700540
541
542def label_to_module_name(label):
543 """Turn a GN label (e.g., //:perfetto_tests) into a module name."""
Patrick Rohr07876662022-11-15 22:55:23 -0800544 module = re.sub(r'^//:?', '', label)
Patrick Rohr92d74122022-10-21 15:50:52 -0700545 module = re.sub(r'[^a-zA-Z0-9_]', '_', module)
Motomu Utsumi3fde1482022-11-14 15:55:21 +0900546
Patrick Rohr92d74122022-10-21 15:50:52 -0700547 if not module.startswith(module_prefix):
548 return module_prefix + module
549 return module
550
551
552def is_supported_source_file(name):
553 """Returns True if |name| can appear in a 'srcs' list."""
Patrick Rohrf9f3a992022-11-10 19:40:32 -0800554 return os.path.splitext(name)[1] in ['.c', '.cc', '.cpp', '.java', '.proto', '.S']
Patrick Rohr92d74122022-10-21 15:50:52 -0700555
556
557def create_proto_modules(blueprint, gn, target):
558 """Generate genrules for a proto GN target.
559
560 GN actions are used to dynamically generate files during the build. The
561 Soong equivalent is a genrule. This function turns a specific kind of
562 genrule which turns .proto files into source and header files into a pair
563 equivalent genrules.
564
565 Args:
566 blueprint: Blueprint instance which is being generated.
567 target: gn_utils.Target object.
568
569 Returns:
570 The source_genrule module.
571 """
572 assert (target.type == 'proto_library')
573
Motomu Utsumibd4013f2022-11-17 16:06:05 +0900574 protoc_gn_target_name = gn.get_target('//third_party/protobuf:protoc').name
Motomu Utsumid58c1dc2022-11-16 18:04:46 +0900575 protoc_module_name = label_to_module_name(protoc_gn_target_name)
576 tools = {protoc_module_name}
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900577 cpp_out_dir = '$(genDir)/%s/%s/' % (tree_path, target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700578 target_module_name = label_to_module_name(target.name)
579
580 # In GN builds the proto path is always relative to the output directory
581 # (out/tmp.xxx).
Motomu Utsumid58c1dc2022-11-16 18:04:46 +0900582 cmd = ['$(location %s)' % protoc_module_name]
Motomu Utsumid7e0e422022-11-08 17:49:52 +0900583 cmd += ['--proto_path=%s/%s' % (tree_path, target.proto_in_dir)]
Patrick Rohr92d74122022-10-21 15:50:52 -0700584
585 if buildtools_protobuf_src in target.proto_paths:
586 cmd += ['--proto_path=%s' % android_protobuf_src]
587
588 # We don't generate any targets for source_set proto modules because
589 # they will be inlined into other modules if required.
590 if target.proto_plugin == 'source_set':
591 return None
592
593 # Descriptor targets only generate a single target.
594 if target.proto_plugin == 'descriptor':
595 out = '{}.bin'.format(target_module_name)
596
597 cmd += ['--descriptor_set_out=$(out)']
598 cmd += ['$(in)']
599
Mohannad Farrag1de6cb12022-11-28 12:27:26 +0000600 descriptor_module = Module('cc_genrule', target_module_name, target.name)
Patrick Rohr92d74122022-10-21 15:50:52 -0700601 descriptor_module.cmd = ' '.join(cmd)
602 descriptor_module.out = [out]
603 descriptor_module.tools = tools
604 blueprint.add_module(descriptor_module)
605
606 # Recursively extract the .proto files of all the dependencies and
607 # add them to srcs.
608 descriptor_module.srcs.update(
609 gn_utils.label_to_path(src) for src in target.sources)
610 for dep in target.transitive_proto_deps:
611 current_target = gn.get_target(dep)
612 descriptor_module.srcs.update(
613 gn_utils.label_to_path(src) for src in current_target.sources)
614
615 return descriptor_module
616
617 # We create two genrules for each proto target: one for the headers and
618 # another for the sources. This is because the module that depends on the
619 # generated files needs to declare two different types of dependencies --
620 # source files in 'srcs' and headers in 'generated_headers' -- and it's not
621 # valid to generate .h files from a source dependency and vice versa.
622 source_module_name = target_module_name + '_gen'
Mohannad Farrag1de6cb12022-11-28 12:27:26 +0000623 source_module = Module('cc_genrule', source_module_name, target.name)
Patrick Rohr92d74122022-10-21 15:50:52 -0700624 blueprint.add_module(source_module)
625 source_module.srcs.update(
626 gn_utils.label_to_path(src) for src in target.sources)
627
Mohannad Farrag1de6cb12022-11-28 12:27:26 +0000628 header_module = Module('cc_genrule', source_module_name + '_headers',
Patrick Rohr92d74122022-10-21 15:50:52 -0700629 target.name)
630 blueprint.add_module(header_module)
631 header_module.srcs = set(source_module.srcs)
632
633 # TODO(primiano): at some point we should remove this. This was introduced
634 # by aosp/1108421 when adding "protos/" to .proto include paths, in order to
635 # avoid doing multi-repo changes and allow old clients in the android tree
636 # to still do the old #include "perfetto/..." rather than
637 # #include "protos/perfetto/...".
638 header_module.export_include_dirs = {'.', 'protos'}
Patrick Rohr2267a0a2022-11-08 18:59:34 -0800639 # Since the .cc file and .h get created by a different gerule target, they
640 # are not put in the same intermediate path, so local includes do not work
641 # without explictily exporting the include dir.
642 header_module.export_include_dirs.add(target.proto_in_dir)
Patrick Rohr92d74122022-10-21 15:50:52 -0700643
Motomu Utsumi8ca12412022-11-30 16:27:30 +0900644 # This function does not return header_module so setting apex_available attribute here.
645 header_module.apex_available.add(tethering_apex)
646
Patrick Rohr92d74122022-10-21 15:50:52 -0700647 source_module.genrule_srcs.add(':' + source_module.name)
648 source_module.genrule_headers.add(header_module.name)
649
650 if target.proto_plugin == 'proto':
651 suffixes = ['pb']
652 source_module.genrule_shared_libs.add('libprotobuf-cpp-lite')
653 cmd += ['--cpp_out=lite=true:' + cpp_out_dir]
654 elif target.proto_plugin == 'protozero':
655 suffixes = ['pbzero']
656 plugin = create_modules_from_target(blueprint, gn, protozero_plugin)
657 tools.add(plugin.name)
658 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
659 cmd += ['--plugin_out=wrapper_namespace=pbzero:' + cpp_out_dir]
660 elif target.proto_plugin == 'cppgen':
661 suffixes = ['gen']
662 plugin = create_modules_from_target(blueprint, gn, cppgen_plugin)
663 tools.add(plugin.name)
664 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
665 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
666 elif target.proto_plugin == 'ipc':
667 suffixes = ['ipc']
668 plugin = create_modules_from_target(blueprint, gn, ipc_plugin)
669 tools.add(plugin.name)
670 cmd += ['--plugin=protoc-gen-plugin=$(location %s)' % plugin.name]
671 cmd += ['--plugin_out=wrapper_namespace=gen:' + cpp_out_dir]
672 else:
673 raise Error('Unsupported proto plugin: %s' % target.proto_plugin)
674
675 cmd += ['$(in)']
676 source_module.cmd = ' '.join(cmd)
677 header_module.cmd = source_module.cmd
678 source_module.tools = tools
679 header_module.tools = tools
680
681 for sfx in suffixes:
682 source_module.out.update('%s/%s' %
683 (tree_path, src.replace('.proto', '.%s.cc' % sfx))
684 for src in source_module.srcs)
685 header_module.out.update('%s/%s' %
686 (tree_path, src.replace('.proto', '.%s.h' % sfx))
687 for src in header_module.srcs)
688 return source_module
689
690
Patrick Rohr92d74122022-10-21 15:50:52 -0700691def create_proto_group_modules(blueprint, gn, module_name, target_names):
692 # TODO(lalitm): today, we're only adding a Java lite module because that's
693 # the only one used in practice. In the future, if we need other target types
694 # (e.g. C++, Java full etc.) add them here.
695 bp_module_name = label_to_module_name(module_name) + '_java_protos'
696 module = Module('java_library', bp_module_name, bp_module_name)
697 module.comment = f'''GN: [{', '.join(target_names)}]'''
698 module.proto = {'type': 'lite', 'canonical_path_from_root': False}
699
700 for name in target_names:
701 target = gn.get_target(name)
702 module.srcs.update(gn_utils.label_to_path(src) for src in target.sources)
703 for dep_label in target.transitive_proto_deps:
704 dep = gn.get_target(dep_label)
705 module.srcs.update(gn_utils.label_to_path(src) for src in dep.sources)
706
707 blueprint.add_module(module)
708
Mohannad Farrag9c2cee12022-12-06 17:11:25 +0000709def create_gcc_preprocess_modules(blueprint, target):
710 # gcc_preprocess.py internally execute host gcc which is not allowed in genrule.
711 # So, this function create multiple modules and realize equivalent processing
712 # TODO: Consider to support gcc_preprocess.py in different way
713 # It's not great to have genrule and cc_object in the dependency from java_library
714 assert (len(target.sources) == 1)
715 source = list(target.sources)[0]
716 assert (Path(source).suffix == '.template')
717 stem = Path(source).stem
718
719 bp_module_name = label_to_module_name(target.name)
720
721 # Rename .template to .cc since cc_object does not accept .template file as srcs
722 rename_module = Module('genrule', bp_module_name + '_rename', target.name)
723 rename_module.srcs.add(gn_utils.label_to_path(source))
724 rename_module.out.add(stem + '.cc')
725 rename_module.cmd = 'cp $(in) $(out)'
726 blueprint.add_module(rename_module)
727
728 # Preprocess template file and generates java file
729 preprocess_module = Module('cc_object', bp_module_name + '_preprocess', target.name)
730 # -E: stop after preprocessing.
731 # -P: disable line markers, i.e. '#line 309'
732 preprocess_module.cflags.update(['-E', '-P', '-DANDROID'])
733 preprocess_module.srcs.add(':' + rename_module.name)
734 defines = ['-D' + target.args[i+1] for i, arg in enumerate(target.args) if arg == '--define']
735 preprocess_module.cflags.update(defines)
736 # HACK: Specifying compile_multilib to build cc_object only once.
737 # Without this, soong complain to genrule that depends on cc_object when built for 64bit target.
738 # It seems this is because cc object is a module with per-architecture variants and genrule is a
739 # module with default variant. For 64bit target, cc_object is built multiple times for 32/64bit
740 # modes and genrule doesn't know which one to depend on.
Motomu Utsumi4fb65c72022-12-09 17:08:48 +0900741 preprocess_module.compile_multilib = 'first'
Mohannad Farrag9c2cee12022-12-06 17:11:25 +0000742 blueprint.add_module(preprocess_module)
743
744 # Generates srcjar using soong_zip
745 module = Module('genrule', bp_module_name, target.name)
746 module.srcs.add(':' + preprocess_module.name)
747 module.out.add(stem + '.srcjar')
748 module.cmd = NEWLINE.join([
749 f'cp $(in) $(genDir)/{stem}.java &&',
750 f'$(location soong_zip) -o $(out) -srcjar -f $(genDir)/{stem}.java'
751 ])
752 module.tools.add('soong_zip')
753 blueprint.add_module(module)
754 return module
755
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800756
Mohannad Farrag420c14e2022-11-30 17:13:15 +0000757class BaseActionSanitizer():
Motomu Utsumi0facea52022-12-16 17:25:30 +0900758 def __init__(self, target, arch):
Patrick Rohr9e414b52022-11-29 22:12:18 -0800759 # Just to be on the safe side, create a deep-copy.
760 self.target = copy.deepcopy(target)
Motomu Utsumi0facea52022-12-16 17:25:30 +0900761 if arch:
762 # Merge arch specific attributes
763 self.target.sources |= arch.sources
764 self.target.inputs |= arch.inputs
765 self.target.outputs |= arch.outputs
766 self.target.script = self.target.script or arch.script
767 self.target.args = self.target.args or arch.args
768 self.target.response_file_contents = \
769 self.target.response_file_contents or arch.response_file_contents
Motomu Utsumi9752bd32022-12-02 15:16:55 +0900770 self.target.args = self._normalize_args()
771
Mohannad Farrag7f7c9b42022-12-02 14:37:56 +0000772 def get_name(self):
773 return label_to_module_name(self.target.name)
774
Motomu Utsumi9752bd32022-12-02 15:16:55 +0900775 def _normalize_args(self):
Patrick Rohr9e414b52022-11-29 22:12:18 -0800776 # Convert ['--param=value'] to ['--param', 'value'] for consistency.
Mohannad Farrag60b37702022-12-02 14:07:33 +0000777 # Escape quotations.
Motomu Utsumi9752bd32022-12-02 15:16:55 +0900778 normalized_args = []
779 for arg in self.target.args:
Mohannad Farrag60b37702022-12-02 14:07:33 +0000780 arg = arg.replace('"', r'\"')
Motomu Utsumi13399322022-12-02 15:36:48 +0900781 if arg.startswith('-'):
782 normalized_args.extend(arg.split('='))
783 else:
784 normalized_args.append(arg)
Motomu Utsumi9752bd32022-12-02 15:16:55 +0900785 return normalized_args
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800786
Patrick Rohr2cad9332022-11-30 14:27:40 -0800787 # There are three types of args:
788 # - flags (--flag)
789 # - value args (--arg value)
790 # - list args (--arg value1 --arg value2)
Motomu Utsumi8be8a262022-12-02 14:35:15 +0900791 # 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 +0900792 # Note that the set of list args contains the set of value args.
Motomu Utsumi8be8a262022-12-02 14:35:15 +0900793 # 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 -0800794 # Some functions provide special implementations for each type, while others
795 # work on all of them.
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800796 def _has_arg(self, arg):
797 return arg in self.target.args
798
Motomu Utsumi923688c2022-12-01 15:51:05 +0900799 def _get_arg_indices(self, target_arg):
800 return [i for i, arg in enumerate(self.target.args) if arg == target_arg]
Patrick Rohr3a2c3dd2022-11-29 22:29:36 -0800801
Motomu Utsumi923688c2022-12-01 15:51:05 +0900802 # Whether an arg value pair appears once or more times
803 def _is_list_arg(self, arg):
804 indices = self._get_arg_indices(arg)
805 return len(indices) > 0 and all([not self.target.args[i + 1].startswith('--') for i in indices])
806
Motomu Utsumic363b412022-12-01 16:01:58 +0900807 def _update_list_arg(self, arg, func, throw_if_absent = True):
808 if self._should_fail_silently(arg, throw_if_absent):
809 return
810 assert(self._is_list_arg(arg))
811 indices = self._get_arg_indices(arg)
812 for i in indices:
813 self._set_arg_at(i + 1, func(self.target.args[i + 1]))
814
Motomu Utsumi923688c2022-12-01 15:51:05 +0900815 # Whether an arg value pair appears exactly once
Patrick Rohref4f2bf2022-11-30 14:22:40 -0800816 def _is_value_arg(self, arg):
Motomu Utsumid75b8b52022-12-02 14:29:00 +0900817 return operator.countOf(self.target.args, arg) == 1 and self._is_list_arg(arg)
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800818
Patrick Rohr2cad9332022-11-30 14:27:40 -0800819 def _get_value_arg(self, arg):
Patrick Rohref4f2bf2022-11-30 14:22:40 -0800820 assert(self._is_value_arg(arg))
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800821 i = self.target.args.index(arg)
822 return self.target.args[i + 1]
823
Patrick Rohrf0abead2022-11-30 19:44:10 -0800824 # used to check whether a function call should cause an error when an arg is
825 # missing.
826 def _should_fail_silently(self, arg, throw_if_absent):
827 return not throw_if_absent and not self._has_arg(arg)
828
829 def _set_value_arg(self, arg, value, throw_if_absent = True):
830 if self._should_fail_silently(arg, throw_if_absent):
Patrick Rohr4d74aed2022-11-30 15:42:16 -0800831 return
Patrick Rohref4f2bf2022-11-30 14:22:40 -0800832 assert(self._is_value_arg(arg))
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800833 i = self.target.args.index(arg)
834 self.target.args[i + 1] = value
835
Patrick Rohrf0abead2022-11-30 19:44:10 -0800836 def _update_value_arg(self, arg, func, throw_if_absent = True):
837 if self._should_fail_silently(arg, throw_if_absent):
Patrick Rohr4d74aed2022-11-30 15:42:16 -0800838 return
Patrick Rohr1bedf6c2022-11-30 15:12:57 -0800839 self._set_value_arg(arg, func(self._get_value_arg(arg)))
840
Patrick Rohr77c4f5c2022-11-30 12:56:29 -0800841 def _set_arg_at(self, position, value):
Mohannad Farrag9ab17932022-11-30 17:28:35 +0000842 self.target.args[position] = value
843
Patrick Rohr357b25c2022-11-30 19:46:26 -0800844 def _delete_value_arg(self, arg, throw_if_absent = True):
Patrick Rohrf0abead2022-11-30 19:44:10 -0800845 if self._should_fail_silently(arg, throw_if_absent):
Patrick Rohr4d74aed2022-11-30 15:42:16 -0800846 return
Patrick Rohr357b25c2022-11-30 19:46:26 -0800847 assert(self._is_value_arg(arg))
Patrick Rohr9f439322022-11-30 15:56:15 -0800848 i = self.target.args.index(arg)
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800849 self.target.args.pop(i)
Patrick Rohr357b25c2022-11-30 19:46:26 -0800850 self.target.args.pop(i)
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800851
Patrick Rohr1f7dd582022-11-30 13:44:07 -0800852 def _append_arg(self, arg, value):
853 self.target.args.append(arg)
854 self.target.args.append(value)
855
Mohannad Farrag8fa90652022-12-01 15:40:40 +0000856 def _sanitize_filepath_with_location_tag(self, arg):
857 if arg.startswith('../../'):
858 arg = self._sanitize_filepath(arg)
859 arg = self._add_location_tag(arg)
860 return arg
861
Patrick Rohr73ef7ae2022-11-29 22:33:09 -0800862 # wrap filename in location tag.
Patrick Rohrfda026732022-11-30 16:07:11 -0800863 def _add_location_tag(self, filename):
Patrick Rohr73ef7ae2022-11-29 22:33:09 -0800864 return '$(location %s)' % filename
865
Patrick Rohr0e24c5f2022-11-30 15:20:21 -0800866 # applies common directory transformation that *should* be universally applicable.
867 # TODO: verify if it actually *is* universally applicable.
Patrick Rohr872a2812022-11-30 19:28:22 -0800868 def _sanitize_filepath(self, filepath):
Patrick Rohr0e24c5f2022-11-30 15:20:21 -0800869 # Careful, order matters!
Patrick Rohr8bcd7832022-11-30 19:48:56 -0800870 # delete all leading ../
Patrick Rohr9e5a3c72022-11-30 15:51:30 -0800871 filepath = re.sub('^(\.\./)+', '', filepath)
Patrick Rohr0e24c5f2022-11-30 15:20:21 -0800872 filepath = re.sub('^gen/jni_headers', '$(genDir)', filepath)
873 filepath = re.sub('^gen', '$(genDir)', filepath)
874 return filepath
Patrick Rohr32276892022-11-29 22:38:13 -0800875
Motomu Utsumi21485ba2022-12-01 17:01:50 +0900876 # Iterate through all the args and apply function
877 def _update_all_args(self, func):
878 self.target.args = [func(arg) for arg in self.target.args]
879
Mohannad Farragd5515ca2022-12-02 15:39:53 +0000880 def get_cmd(self):
Mohannad Farragc739dda2022-12-02 15:43:46 +0000881 arg_string = NEWLINE.join(self.target.args)
882 cmd = '$(location %s) %s' % (
883 gn_utils.label_to_path(self.target.script), arg_string)
884
885 if self.use_response_file:
886 # Pipe response file contents into script
887 cmd = 'echo \'%s\' |%s%s' % (self.target.response_file_contents, NEWLINE, cmd)
888 return cmd
Mohannad Farragd5515ca2022-12-02 15:39:53 +0000889
Motomu Utsumi5afd0812022-12-02 15:43:36 +0900890 def get_outputs(self):
891 return self.target.outputs
892
Motomu Utsumi80fa0b02022-12-05 12:50:57 +0900893 def get_srcs(self):
894 # gn treats inputs and sources for actions equally.
895 # soong only supports source files inside srcs, non-source files are added as
896 # tool_files dependency.
897 files = self.target.sources.union(self.target.inputs)
898 return {gn_utils.label_to_path(file) for file in files if is_supported_source_file(file)}
899
Motomu Utsumiaaf42cf2022-12-05 12:55:02 +0900900 def get_tool_files(self):
901 # gn treats inputs and sources for actions equally.
902 # soong only supports source files inside srcs, non-source files are added as
903 # tool_files dependency.
904 files = self.target.sources.union(self.target.inputs)
Motomu Utsumi69975862022-12-05 12:59:06 +0900905 tool_files = {gn_utils.label_to_path(file)
906 for file in files if not is_supported_source_file(file)}
907 tool_files.add(gn_utils.label_to_path(self.target.script))
908 return tool_files
Motomu Utsumiaaf42cf2022-12-05 12:55:02 +0900909
Motomu Utsumicdb45ea2022-12-02 17:05:07 +0900910 def _sanitize_args(self):
Mohannad Farrag00ecfb52022-12-02 14:44:15 +0000911 # Handle passing parameters via response file by piping them into the script
912 # and reading them from /dev/stdin.
913
Mohannad Farraga0e37c12022-12-02 14:46:08 +0000914 self.use_response_file = gn_utils.RESPONSE_FILE in self.target.args
Mohannad Farrag00ecfb52022-12-02 14:44:15 +0000915 if self.use_response_file:
916 # Replace {{response_file_contents}} with /dev/stdin
Mohannad Farraga0e37c12022-12-02 14:46:08 +0000917 self.target.args = ['/dev/stdin' if it == gn_utils.RESPONSE_FILE else it
918 for it in self.target.args]
Motomu Utsumicdb45ea2022-12-02 17:05:07 +0900919
920 def _sanitize_outputs(self):
921 pass
922
Motomu Utsumi735a5a42022-12-05 12:15:07 +0900923 def _sanitize_inputs(self):
924 pass
925
Motomu Utsumicdb45ea2022-12-02 17:05:07 +0900926 def sanitize(self):
927 self._sanitize_args()
928 self._sanitize_outputs()
Motomu Utsumi735a5a42022-12-05 12:15:07 +0900929 self._sanitize_inputs()
Motomu Utsumicdb45ea2022-12-02 17:05:07 +0900930
Motomu Utsumi7db75832022-12-02 16:46:22 +0900931 # Whether this target generates header files
932 def is_header_generated(self):
Motomu Utsumia91ade62022-12-02 16:58:36 +0900933 return any(os.path.splitext(it)[1] == '.h' for it in self.target.outputs)
Motomu Utsumi7db75832022-12-02 16:46:22 +0900934
Mohannad Farrag9ab17932022-11-30 17:28:35 +0000935class WriteBuildDateHeaderSanitizer(BaseActionSanitizer):
Motomu Utsumi805591d2022-12-02 17:17:16 +0900936 def _sanitize_args(self):
Patrick Rohr77c4f5c2022-11-30 12:56:29 -0800937 self._set_arg_at(0, '$(out)')
Motomu Utsumi805591d2022-12-02 17:17:16 +0900938 super()._sanitize_args()
Mohannad Farrag9ab17932022-11-30 17:28:35 +0000939
Mohannad Farrag71353f92022-11-30 17:20:48 +0000940class WriteBuildFlagHeaderSanitizer(BaseActionSanitizer):
Motomu Utsumi805591d2022-12-02 17:17:16 +0900941 def _sanitize_args(self):
Patrick Rohr2cad9332022-11-30 14:27:40 -0800942 self._set_value_arg('--gen-dir', '.')
943 self._set_value_arg('--output', '$(out)')
Motomu Utsumi805591d2022-12-02 17:17:16 +0900944 super()._sanitize_args()
Patrick Rohrf6de33f2022-11-29 22:02:55 -0800945
Patrick Rohr0242a3f2022-11-30 13:48:59 -0800946class JniGeneratorSanitizer(BaseActionSanitizer):
Motomu Utsumi4d551d72022-12-01 16:18:23 +0900947 def _add_location_tag_to_filepath(self, arg):
948 if not arg.endswith('.class'):
949 # --input_file supports both .class specifiers or source files as arguments.
950 # Only source files need to be wrapped inside a $(location <label>) tag.
951 arg = self._add_location_tag(arg)
952 return arg
953
Motomu Utsumi805591d2022-12-02 17:17:16 +0900954 def _sanitize_args(self):
Patrick Rohr7d2cdf42022-12-22 11:39:35 -0800955 self._set_value_arg('--jar_file', '$(location :current_android_jar)', False)
Patrick Rohr0242a3f2022-11-30 13:48:59 -0800956 if self._has_arg('--jar_file'):
957 self._append_arg('--javap', '$$(find out/.path -name javap)')
Patrick Rohr872a2812022-11-30 19:28:22 -0800958 self._update_value_arg('--output_dir', self._sanitize_filepath)
Patrick Rohrf0abead2022-11-30 19:44:10 -0800959 self._update_value_arg('--includes', self._sanitize_filepath, False)
Patrick Rohr357b25c2022-11-30 19:46:26 -0800960 self._delete_value_arg('--prev_output_dir', False)
Motomu Utsumi4d551d72022-12-01 16:18:23 +0900961 self._update_list_arg('--input_file', self._sanitize_filepath)
962 self._update_list_arg('--input_file', self._add_location_tag_to_filepath)
Motomu Utsumi805591d2022-12-02 17:17:16 +0900963 super()._sanitize_args()
Patrick Rohr0242a3f2022-11-30 13:48:59 -0800964
Motomu Utsumi94019962022-12-02 17:18:58 +0900965 def _sanitize_outputs(self):
Motomu Utsumid4f72642022-12-02 16:01:59 +0900966 # fix target.output directory to match #include statements.
967 self.target.outputs = {re.sub('^jni_headers/', '', out) for out in self.target.outputs}
Motomu Utsumi94019962022-12-02 17:18:58 +0900968 super()._sanitize_outputs()
Motomu Utsumid4f72642022-12-02 16:01:59 +0900969
Motomu Utsumia6824ea2022-12-05 14:53:11 +0900970 def get_tool_files(self):
971 tool_files = super().get_tool_files()
972 # android_jar.classes should be part of the tools as it list implicit classes
973 # for the script to generate JNI headers.
974 tool_files.add("base/android/jni_generator/android_jar.classes")
Patrick Rohr7d2cdf42022-12-22 11:39:35 -0800975
976 # Filter android.jar and add :current_android_jar
977 tool_files = {file if not file.endswith('android.jar') else ':current_android_jar'
978 for file in tool_files }
Motomu Utsumia6824ea2022-12-05 14:53:11 +0900979 return tool_files
980
Motomu Utsumib80903c2022-12-01 16:21:55 +0900981class JniRegistrationGeneratorSanitizer(BaseActionSanitizer):
Motomu Utsumi07027f62022-12-05 12:16:53 +0900982 def _sanitize_inputs(self):
983 self.target.inputs = [file for file in self.target.inputs if not file.startswith('//out/')]
984
Motomu Utsumi805591d2022-12-02 17:17:16 +0900985 def _sanitize_args(self):
Motomu Utsumi28cbf2f2022-12-01 16:24:29 +0900986 self._update_value_arg('--depfile', self._sanitize_filepath)
987 self._update_value_arg('--srcjar-path', self._sanitize_filepath)
988 self._update_value_arg('--header-path', self._sanitize_filepath)
Motomu Utsumi55907472022-12-01 16:26:21 +0900989 self._set_value_arg('--sources-files', '$(genDir)/java.sources')
Motomu Utsumi4fe0b952022-12-01 16:29:15 +0900990 # update_jni_registration_module removes them from the srcs of the module
991 # It might be better to remove sources by '--sources-exclusions'
992 self._delete_value_arg('--sources-exclusions')
Motomu Utsumi805591d2022-12-02 17:17:16 +0900993 super()._sanitize_args()
Patrick Rohr0242a3f2022-11-30 13:48:59 -0800994
Mohannad Farrag291f5672022-12-02 15:49:00 +0000995 def get_cmd(self):
996 # jni_registration_generator.py doesn't work with python2
997 cmd = "python3 " + super().get_cmd()
998 # Path in the original sources file does not work in genrule.
999 # So creating sources file in cmd based on the srcs of this target.
1000 # Adding ../$(current_dir)/ to the head because jni_registration_generator.py uses the files
1001 # whose path startswith(..)
1002 commands = ["current_dir=`basename \\\`pwd\\\``;",
1003 "for f in $(in);",
1004 "do",
1005 "echo \\\"../$$current_dir/$$f\\\" >> $(genDir)/java.sources;",
1006 "done;",
1007 cmd]
1008
1009 # .h file jni_registration_generator.py generates has #define with directory name.
1010 # With the genrule env that contains "." which is invalid. So replace that at the end of cmd.
1011 commands.append(";sed -i -e 's/OUT_SOONG_.TEMP_SBOX_.*_OUT/GEN/g' ")
1012 commands.append("$(genDir)/components/cronet/android/cronet_jni_registration.h")
1013 return NEWLINE.join(commands)
1014
Mohannad Farrag457bc022022-12-02 14:31:22 +00001015class JavaJniRegistrationGeneratorSanitizer(JniRegistrationGeneratorSanitizer):
Mohannad Farrag7f7c9b42022-12-02 14:37:56 +00001016 def get_name(self):
1017 return label_to_module_name(self.target.name) + "__java"
1018
Mohannad Farrag457bc022022-12-02 14:31:22 +00001019 def _sanitize_outputs(self):
1020 self.target.outputs = [out for out in self.target.outputs if
1021 out.endswith(".srcjar")]
1022 super()._sanitize_outputs()
1023
Motomu Utsumi6af5b2a2022-12-01 16:33:42 +09001024class VersionSanitizer(BaseActionSanitizer):
Motomu Utsumi805591d2022-12-02 17:17:16 +09001025 def _sanitize_args(self):
Motomu Utsumic6b08b82022-12-01 16:48:19 +09001026 self._set_value_arg('-o', '$(out)')
Motomu Utsumi21485ba2022-12-01 17:01:50 +09001027 # args for the version.py contain file path without leading --arg key. So apply sanitize
1028 # function for all the args.
Mohannad Farrag8fa90652022-12-01 15:40:40 +00001029 self._update_all_args(self._sanitize_filepath_with_location_tag)
Mohannad Farrag25697342022-12-02 18:01:48 +00001030 self._set_value_arg('-e', "'%s'" % self._get_value_arg('-e'))
Motomu Utsumi805591d2022-12-02 17:17:16 +09001031 super()._sanitize_args()
Motomu Utsumi6af5b2a2022-12-01 16:33:42 +09001032
Motomu Utsumidf634142022-12-05 15:02:44 +09001033 def get_tool_files(self):
1034 tool_files = super().get_tool_files()
1035 # android_chrome_version.py is not specified in anywhere but version.py imports this file
1036 tool_files.add('build/util/android_chrome_version.py')
1037 return tool_files
1038
Mohannad Farragb73ce0f2022-12-01 15:43:58 +00001039class JavaCppEnumSanitizer(BaseActionSanitizer):
Motomu Utsumi805591d2022-12-02 17:17:16 +09001040 def _sanitize_args(self):
Mohannad Farragb73ce0f2022-12-01 15:43:58 +00001041 self._update_all_args(self._sanitize_filepath_with_location_tag)
1042 self._set_value_arg('--srcjar', '$(out)')
Motomu Utsumi805591d2022-12-02 17:17:16 +09001043 super()._sanitize_args()
Mohannad Farragb73ce0f2022-12-01 15:43:58 +00001044
Motomu Utsumi9701d2f2022-12-02 16:53:06 +09001045class MakeDafsaSanitizer(BaseActionSanitizer):
1046 def is_header_generated(self):
Motomu Utsumi1e028b82022-12-02 16:54:20 +09001047 # This script generates .cc files but they are #included by other sources
1048 # (e.g. registry_controlled_domain.cc)
1049 return True
Motomu Utsumi9701d2f2022-12-02 16:53:06 +09001050
Motomu Utsumi56a2f442022-12-05 16:01:34 +09001051class JavaCppFeatureSanitizer(BaseActionSanitizer):
Motomu Utsumid7c36772022-12-05 16:04:37 +09001052 def _sanitize_args(self):
1053 self._update_all_args(self._sanitize_filepath_with_location_tag)
1054 self._set_value_arg('--srcjar', '$(out)')
1055 super()._sanitize_args()
Motomu Utsumi56a2f442022-12-05 16:01:34 +09001056
Motomu Utsumice5166b2022-12-05 16:08:37 +09001057class JavaCppStringSanitizer(BaseActionSanitizer):
Motomu Utsumi3f7ab312022-12-05 16:12:21 +09001058 def _sanitize_args(self):
1059 self._update_all_args(self._sanitize_filepath_with_location_tag)
1060 self._set_value_arg('--srcjar', '$(out)')
1061 super()._sanitize_args()
Motomu Utsumice5166b2022-12-05 16:08:37 +09001062
Motomu Utsumib90a76b2022-12-05 16:17:26 +09001063class WriteNativeLibrariesJavaSanitizer(BaseActionSanitizer):
Motomu Utsumi3dbc2762022-12-05 16:20:21 +09001064 def _sanitize_args(self):
1065 self._set_value_arg('--output', '$(out)')
1066 super()._sanitize_args()
Motomu Utsumib90a76b2022-12-05 16:17:26 +09001067
Motomu Utsumi0facea52022-12-16 17:25:30 +09001068def get_action_sanitizer(target, type, arch):
Patrick Rohr7f117152022-11-30 13:58:05 -08001069 if target.script == "//build/write_buildflag_header.py":
Motomu Utsumi0facea52022-12-16 17:25:30 +09001070 return WriteBuildFlagHeaderSanitizer(target, arch)
Patrick Rohr7f117152022-11-30 13:58:05 -08001071 elif target.script == "//build/write_build_date_header.py":
Motomu Utsumi0facea52022-12-16 17:25:30 +09001072 return WriteBuildDateHeaderSanitizer(target, arch)
Patrick Rohr7f117152022-11-30 13:58:05 -08001073 elif target.script == '//base/android/jni_generator/jni_generator.py':
Motomu Utsumi0facea52022-12-16 17:25:30 +09001074 return JniGeneratorSanitizer(target, arch)
Motomu Utsumib80903c2022-12-01 16:21:55 +09001075 elif target.script == '//base/android/jni_generator/jni_registration_generator.py':
Mohannad Farrag457bc022022-12-02 14:31:22 +00001076 if type == 'java_genrule':
Motomu Utsumi0facea52022-12-16 17:25:30 +09001077 return JavaJniRegistrationGeneratorSanitizer(target, arch)
Mohannad Farrag457bc022022-12-02 14:31:22 +00001078 else:
Motomu Utsumi0facea52022-12-16 17:25:30 +09001079 return JniRegistrationGeneratorSanitizer(target, arch)
Motomu Utsumi6af5b2a2022-12-01 16:33:42 +09001080 elif target.script == "//build/util/version.py":
Motomu Utsumi0facea52022-12-16 17:25:30 +09001081 return VersionSanitizer(target, arch)
Mohannad Farragb73ce0f2022-12-01 15:43:58 +00001082 elif target.script == "//build/android/gyp/java_cpp_enum.py":
Motomu Utsumi0facea52022-12-16 17:25:30 +09001083 return JavaCppEnumSanitizer(target, arch)
Motomu Utsumi9701d2f2022-12-02 16:53:06 +09001084 elif target.script == "//net/tools/dafsa/make_dafsa.py":
Motomu Utsumi0facea52022-12-16 17:25:30 +09001085 return MakeDafsaSanitizer(target, arch)
Motomu Utsumi56a2f442022-12-05 16:01:34 +09001086 elif target.script == '//build/android/gyp/java_cpp_features.py':
Motomu Utsumi0facea52022-12-16 17:25:30 +09001087 return JavaCppFeatureSanitizer(target, arch)
Motomu Utsumice5166b2022-12-05 16:08:37 +09001088 elif target.script == '//build/android/gyp/java_cpp_strings.py':
Motomu Utsumi0facea52022-12-16 17:25:30 +09001089 return JavaCppStringSanitizer(target, arch)
Motomu Utsumib90a76b2022-12-05 16:17:26 +09001090 elif target.script == '//build/android/gyp/write_native_libraries_java.py':
Motomu Utsumi0facea52022-12-16 17:25:30 +09001091 return WriteNativeLibrariesJavaSanitizer(target, arch)
Patrick Rohr7f117152022-11-30 13:58:05 -08001092 else:
1093 # TODO: throw exception here once all script hacks have been converted.
Motomu Utsumi0facea52022-12-16 17:25:30 +09001094 return BaseActionSanitizer(target, arch)
Patrick Rohr7f117152022-11-30 13:58:05 -08001095
Mohannad Farragbab6c892022-11-02 14:09:46 +00001096def create_action_foreach_modules(blueprint, target):
1097 """ The following assumes that rebase_path exists in the args.
1098 The args of an action_foreach contains hints about which output files are generated
1099 by which source files.
1100 This is copied directly from the args
1101 "gen/net/base/registry_controlled_domains/{{source_name_part}}-reversed-inc.cc"
1102 So each source file will generate an output whose name is the {source_name-reversed-inc.cc}
1103 """
1104 new_args = []
Motomu Utsumi56afcac2022-11-04 12:58:30 +09001105 for i, src in enumerate(sorted(target.sources)):
Mohannad Farragbab6c892022-11-02 14:09:46 +00001106 # don't add script arg for the first source -- create_action_module
1107 # already does this.
1108 if i != 0:
1109 new_args.append('&& python3 $(location %s)' %
1110 gn_utils.label_to_path(target.script))
1111 for arg in target.args:
1112 if '{{source}}' in arg:
1113 new_args.append('$(location %s)' % (gn_utils.label_to_path(src)))
1114 elif '{{source_name_part}}' in arg:
1115 source_name_part = src.split("/")[-1] # Get the file name only
1116 source_name_part = source_name_part.split(".")[0] # Remove the extension (Ex: .cc)
1117 file_name = arg.replace('{{source_name_part}}', source_name_part).split("/")[-1]
1118 # file_name represent the output file name. But we need the whole path
1119 # This can be found from target.outputs.
1120 for out in target.outputs:
1121 if out.endswith(file_name):
1122 new_args.append('$(location %s)' % out)
1123 else:
1124 new_args.append(arg)
1125
1126 target.args = new_args
Mohannad Farrag7ff99912022-11-29 17:16:00 +00001127 return create_action_module(blueprint, target, 'cc_genrule')
Motomu Utsumia6c33152022-11-02 18:21:55 +09001128
Motomu Utsumi877e6f02022-12-16 17:53:51 +09001129def create_action_module_internal(target, type, arch=None):
Motomu Utsumi0facea52022-12-16 17:25:30 +09001130 sanitizer = get_action_sanitizer(target, type, arch)
Motomu Utsumicdb45ea2022-12-02 17:05:07 +09001131 sanitizer.sanitize()
Motomu Utsumi47fd40a2022-12-05 15:07:31 +09001132
Mohannad Farrag7f7c9b42022-12-02 14:37:56 +00001133 module = Module(type, sanitizer.get_name(), target.name)
Mohannad Farragc739dda2022-12-02 15:43:46 +00001134 module.cmd = sanitizer.get_cmd()
Motomu Utsumi24213232022-12-02 16:04:05 +09001135 module.out = sanitizer.get_outputs()
Motomu Utsumi7db75832022-12-02 16:46:22 +09001136 if sanitizer.is_header_generated():
1137 module.genrule_headers.add(module.name)
Motomu Utsumi80fa0b02022-12-05 12:50:57 +09001138 module.srcs = sanitizer.get_srcs()
Motomu Utsumiaaf42cf2022-12-05 12:55:02 +09001139 module.tool_files = sanitizer.get_tool_files()
Patrick Rohr9b99a982022-10-28 11:00:57 -07001140
Patrick Rohre1a853e2022-10-26 12:31:39 -07001141 return module
1142
Motomu Utsumi170cc2d2022-12-16 17:31:28 +09001143def get_cmd_condition(arch):
1144 '''
1145 :param arch: archtecture name e.g. android_x86_64, android_arm64
1146 :return: condition that can be used in cc_genrule cmd to switch the behavior based on arch
1147 '''
1148 if arch == "android_x86_64":
1149 return "( $$CC_ARCH == 'x86_64' && $$CC_OS == 'android' )"
1150 elif arch == "android_x86":
1151 return "( $$CC_ARCH == 'x86' && $$CC_OS == 'android' )"
1152 elif arch == "android_arm":
1153 return "( $$CC_ARCH == 'arm' && $$CC_OS == 'android' )"
1154 elif arch == "android_arm64":
1155 return "( $$CC_ARCH == 'arm64' && $$CC_OS == 'android' )"
1156 elif arch == "host":
1157 return "$$CC_OS != 'android'"
1158 else:
1159 raise Error(f'Unknown architecture type {arch}')
Patrick Rohre1a853e2022-10-26 12:31:39 -07001160
Motomu Utsumid32f9aa2022-12-16 17:41:26 +09001161def merge_cmd(modules, genrule_type):
1162 '''
1163 :param modules: dictionary whose key is arch name and value is module
1164 :param genrule_type: cc_genrule or java_genrule
1165 :return: merged command or common command if all the archs have the same command.
1166 '''
1167 commands = list({module.cmd for module in modules.values()})
1168 if len(commands) == 1:
1169 # If all the archs have the same command, return the command
1170 return commands[0]
1171
1172 if genrule_type != 'cc_genrule':
1173 raise Error(f'{genrule_type} can not have different cmd between archs')
1174
1175 merged_cmd = []
1176 for arch, module in modules.items():
1177 merged_cmd.append(f'if [[ {get_cmd_condition(arch)} ]];')
1178 merged_cmd.append('then')
1179 merged_cmd.append(module.cmd + ';')
1180 merged_cmd.append('fi;')
1181 return NEWLINE.join(merged_cmd)
Patrick Rohr92d74122022-10-21 15:50:52 -07001182
Motomu Utsumi822bfc42022-12-16 17:48:00 +09001183def merge_modules(modules, genrule_type):
1184 '''
1185 :param modules: dictionary whose key is arch name and value is module
1186 :param genrule_type: cc_genrule or java_genrule
1187 :return: merged module of input modules
1188 '''
1189 merged_module = list(modules.values())[0]
1190
1191 # Following attributes must be the same between archs
1192 for key in ('out', 'genrule_headers', 'srcs', 'tool_files'):
1193 if any([getattr(merged_module, key) != getattr(module, key) for module in modules.values()]):
1194 raise Error(f'{merged_module.name} has different values for {key} between archs')
1195
1196 merged_module.cmd = merge_cmd(modules, genrule_type)
1197 return merged_module
1198
Motomu Utsumi877e6f02022-12-16 17:53:51 +09001199def create_action_module(blueprint, target, genrule_type):
1200 '''
1201 Create module for action target and add to the blueprint. If target has arch specific attributes
1202 this function merge them and create a single module.
1203 :param blueprint:
1204 :param target: target which is converted to the module.
1205 :param genrule_type: cc_genrule or java_genrule
1206 :return: created module
1207 '''
Motomu Utsumi3029ac92022-12-16 18:04:57 +09001208 # TODO: Handle this target correctly, this target generates java_genrule but this target has
1209 # different value for cpu-family arg between archs
1210 if target.name == '//build/android:native_libraries_gen':
1211 module = create_action_module_internal(target, genrule_type, target.arch['android_arm'])
1212 blueprint.add_module(module)
1213 return module
1214
Motomu Utsumi877e6f02022-12-16 17:53:51 +09001215 modules = {arch_name: create_action_module_internal(target, genrule_type, arch)
1216 for arch_name, arch in target.arch.items()}
1217 module = merge_modules(modules, genrule_type)
1218 blueprint.add_module(module)
1219 return module
1220
1221
Motomu Utsumic34b1372022-11-17 22:15:51 +09001222def _get_cflags(cflags, defines):
1223 cflags = {flag for flag in cflags if flag in cflag_allowlist}
Motomu Utsumifa7e9262022-10-26 19:43:02 +09001224 # Consider proper allowlist or denylist if needed
Motomu Utsumic34b1372022-11-17 22:15:51 +09001225 cflags |= set("-D%s" % define.replace("\"", "\\\"") for define in defines)
Patrick Rohr92d74122022-10-21 15:50:52 -07001226 return cflags
1227
Motomu Utsumic34b1372022-11-17 22:15:51 +09001228def set_module_flags(module, cflags, defines):
1229 module.cflags.update(_get_cflags(cflags, defines))
1230 # TODO: implement proper cflag parsing.
1231 for flag in cflags:
1232 if '-std=' in flag:
1233 module.cpp_std = flag[len('-std='):]
Motomu Utsumic34b1372022-11-17 22:15:51 +09001234 if '-fexceptions' in flag:
1235 module.cppflags.add('-fexceptions')
Patrick Rohr92d74122022-10-21 15:50:52 -07001236
Motomu Utsumi88efbb42022-11-17 22:18:15 +09001237def set_module_include_dirs(module, cflags, include_dirs):
Motomu Utsumi88efbb42022-11-17 22:18:15 +09001238 for flag in cflags:
1239 if '-isystem' in flag:
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -08001240 module.local_include_dirs.add(flag[len('-isystem../../'):])
Motomu Utsumi88efbb42022-11-17 22:18:15 +09001241
1242 # Adding local_include_dirs is necessary due to source_sets / filegroups
1243 # which do not properly propagate include directories.
1244 # Filter any directory inside //out as a) this directory does not exist for
1245 # aosp / soong builds and b) the include directory should already be
1246 # configured via library dependency.
Patrick Rohr3cd5ffb2022-11-18 17:40:55 -08001247 module.local_include_dirs.update([gn_utils.label_to_path(d)
Motomu Utsumi88efbb42022-11-17 22:18:15 +09001248 for d in include_dirs
1249 if not re.match('^//out/.*', d)])
Patrick Rohr9d7539e2022-12-14 19:31:33 -08001250 # Remove prohibited include directories
1251 module.local_include_dirs = [d for d in module.local_include_dirs
1252 if d not in local_include_dirs_denylist]
1253
Motomu Utsumi88efbb42022-11-17 22:18:15 +09001254
Patrick Rohr92d74122022-10-21 15:50:52 -07001255def create_modules_from_target(blueprint, gn, gn_target_name):
1256 """Generate module(s) for a given GN target.
1257
1258 Given a GN target name, generate one or more corresponding modules into a
1259 blueprint. The only case when this generates >1 module is proto libraries.
1260
1261 Args:
1262 blueprint: Blueprint instance which is being generated.
1263 gn: gn_utils.GnParser object.
1264 gn_target_name: GN target for module generation.
1265 """
1266 bp_module_name = label_to_module_name(gn_target_name)
1267 if bp_module_name in blueprint.modules:
1268 return blueprint.modules[bp_module_name]
1269 target = gn.get_target(gn_target_name)
Patrick Rohr16228942022-10-26 14:00:26 -07001270 log.info('create modules for %s (%s)', target.name, target.type)
Patrick Rohr92d74122022-10-21 15:50:52 -07001271
Patrick Rohr92d74122022-10-21 15:50:52 -07001272 if target.type == 'executable':
Patrick Rohrc8f41cd2022-11-15 22:46:10 -08001273 if target.testonly:
Patrick Rohr92d74122022-10-21 15:50:52 -07001274 module_type = 'cc_test'
1275 else:
Patrick Rohrc8f41cd2022-11-15 22:46:10 -08001276 # Can be used for both host and device targets.
Patrick Rohr92d74122022-10-21 15:50:52 -07001277 module_type = 'cc_binary'
1278 module = Module(module_type, bp_module_name, gn_target_name)
1279 elif target.type == 'static_library':
1280 module = Module('cc_library_static', bp_module_name, gn_target_name)
1281 elif target.type == 'shared_library':
1282 module = Module('cc_library_shared', bp_module_name, gn_target_name)
1283 elif target.type == 'source_set':
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001284 module = Module('cc_object', bp_module_name, gn_target_name)
Patrick Rohr92d74122022-10-21 15:50:52 -07001285 elif target.type == 'group':
1286 # "group" targets are resolved recursively by gn_utils.get_target().
1287 # There's nothing we need to do at this level for them.
1288 return None
1289 elif target.type == 'proto_library':
1290 module = create_proto_modules(blueprint, gn, target)
1291 if module is None:
1292 return None
1293 elif target.type == 'action':
Mohannad Farrag4b89a822022-12-02 14:25:44 +00001294 module = create_action_module(blueprint, target, 'cc_genrule')
Mohannad Farragf076f3e2022-10-31 17:45:28 +00001295 elif target.type == 'action_foreach':
Mohannad Farragbab6c892022-11-02 14:09:46 +00001296 module = create_action_foreach_modules(blueprint, target)
Patrick Rohr59a76652022-10-26 12:36:56 -07001297 elif target.type == 'copy':
1298 # TODO: careful now! copy targets are not supported yet, but this will stop
1299 # traversing the dependency tree. For //base:base, this is not a big
1300 # problem as libicu contains the only copy target which happens to be a
1301 # leaf node.
1302 return None
Patrick Rohrad440602022-11-10 22:09:04 -08001303 elif target.type == 'java_group':
1304 # Java targets are handled outside of create_modules_from_target.
1305 return None
Patrick Rohr92d74122022-10-21 15:50:52 -07001306 else:
1307 raise Error('Unknown target %s (%s)' % (target.name, target.type))
1308
1309 blueprint.add_module(module)
Patrick Rohr92d74122022-10-21 15:50:52 -07001310 module.init_rc = target_initrc.get(target.name, [])
1311 module.srcs.update(
1312 gn_utils.label_to_path(src)
1313 for src in target.sources
Motomu Utsumif951e502022-11-07 19:31:15 +09001314 if is_supported_source_file(src) and not src.startswith("//out/test"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001315
Patrick Rohr3b5ff762022-11-16 10:22:16 -08001316 # Add arch-specific properties
1317 for arch_name, arch in target.arch.items():
Motomu Utsumi40f95c52022-11-17 19:39:13 +09001318 module.target[arch_name].srcs.update(
1319 gn_utils.label_to_path(src)
1320 for src in arch.sources
1321 if is_supported_source_file(src) and not src.startswith("//out/test"))
Patrick Rohr3b5ff762022-11-16 10:22:16 -08001322
Mohannad Farragbaf0d572022-11-22 11:53:54 +00001323 module.rtti = target.rtti
1324
Patrick Rohr92d74122022-10-21 15:50:52 -07001325 if target.type in gn_utils.LINKER_UNIT_TYPES:
Motomu Utsumic34b1372022-11-17 22:15:51 +09001326 set_module_flags(module, target.cflags, target.defines)
Motomu Utsumi88efbb42022-11-17 22:18:15 +09001327 set_module_include_dirs(module, target.cflags, target.include_dirs)
Motomu Utsumif0f47682022-11-17 22:34:39 +09001328 # TODO: set_module_xxx is confusing, apply similar function to module and target in better way.
1329 for arch_name, arch in target.arch.items():
1330 set_module_flags(module.target[arch_name], arch.cflags, arch.defines)
Motomu Utsumi3371d682022-11-28 16:56:52 +09001331 # -Xclang -target-feature -Xclang +mte are used to enable MTE (Memory Tagging Extensions).
1332 # Flags which does not start with '-' could not be in the cflags so enabling MTE by
1333 # -march and -mcpu Feature Modifiers. MTE is only available on arm64. This is needed for
1334 # building //base/allocator/partition_allocator:partition_alloc for arm64.
1335 if '+mte' in arch.cflags and arch_name == 'android_arm64':
1336 module.target[arch_name].cflags.add('-march=armv8-a+memtag')
Motomu Utsumif0f47682022-11-17 22:34:39 +09001337 set_module_include_dirs(module.target[arch_name], arch.cflags, arch.include_dirs)
Patrick Rohr92d74122022-10-21 15:50:52 -07001338
Mohannad Farragf2391cc2022-11-29 13:26:32 +00001339 module.host_supported = target.host_supported()
1340 module.device_supported = target.device_supported()
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001341
Motomu Utsumi8ca12412022-11-30 16:27:30 +09001342 if module.is_genrule():
1343 module.apex_available.add(tethering_apex)
1344
Mohannad Farragf2391cc2022-11-29 13:26:32 +00001345 if module.is_compiled():
Patrick Rohr92d74122022-10-21 15:50:52 -07001346 # Don't try to inject library/source dependencies into genrules or
1347 # filegroups because they are not compiled in the traditional sense.
1348 module.defaults = [defaults_module]
1349 for lib in target.libs:
1350 # Generally library names should be mangled as 'libXXX', unless they
1351 # are HAL libraries (e.g., android.hardware.health@2.0) or AIDL c++ / NDK
1352 # libraries (e.g. "android.hardware.power.stats-V1-cpp")
1353 android_lib = lib if '@' in lib or "-cpp" in lib or "-ndk" in lib \
1354 else 'lib' + lib
1355 if lib in shared_library_allowlist:
1356 module.add_android_shared_lib(android_lib)
1357 if lib in static_library_allowlist:
1358 module.add_android_static_lib(android_lib)
1359
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001360 # If the module is a static library, export all the generated headers.
1361 if module.type == 'cc_library_static':
1362 module.export_generated_headers = module.generated_headers
1363
Motomu Utsumiee47af62022-11-30 16:41:15 +09001364 if module.name == 'cronet_aml_components_cronet_android_cronet':
1365 if target.output_name is None:
1366 raise Error('Failed to get output_name for libcronet name')
1367 # .so file name needs to match with CronetLibraryLoader.java (e.g. libcronet.109.0.5386.0.so)
1368 # So setting the output name based on the output_name from the desc.json
1369 module.stem = 'lib' + target.output_name
1370
Patrick Rohr92d74122022-10-21 15:50:52 -07001371 # dep_name is an unmangled GN target name (e.g. //foo:bar(toolchain)).
Motomu Utsumif1daa232022-11-08 13:28:37 +09001372 # Currently, only one module is generated from target even target has multiple toolchains.
1373 # And module is generated based on the first visited target.
1374 # Sort deps before iteration to make result deterministic.
1375 all_deps = sorted(target.deps | target.source_set_deps | target.transitive_proto_deps)
Patrick Rohr92d74122022-10-21 15:50:52 -07001376 for dep_name in all_deps:
Patrick Rohr5cc46e02022-10-26 14:32:45 -07001377 # |builtin_deps| override GN deps with Android-specific ones. See the
1378 # config in the top of this file.
Patrick Rohr07876662022-11-15 22:55:23 -08001379 if dep_name in builtin_deps:
Patrick Rohr25926e62022-12-14 19:55:57 -08001380 builtin_deps[dep_name](module, None)
Patrick Rohr5cc46e02022-10-26 14:32:45 -07001381 continue
1382
Patrick Rohr92d74122022-10-21 15:50:52 -07001383 dep_module = create_modules_from_target(blueprint, gn, dep_name)
1384
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001385 if dep_module is None:
1386 continue
Motomu Utsumie246feb2022-11-01 17:25:56 +09001387 # TODO: Proper dependency check for genrule.
1388 # Currently, only propagating genrule dependencies.
1389 # Also, currently, all the dependencies are propagated upwards.
1390 # in gn, public_deps should be propagated but deps should not.
1391 # Not sure this information is available in the desc.json.
1392 # Following rule works for adding android_runtime_jni_headers to base:base.
1393 # If this doesn't work for other target, hardcoding for specific target
1394 # might be better.
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001395 if module.is_genrule() and dep_module.is_genrule():
1396 module.genrule_headers.add(dep_module.name)
1397 module.genrule_headers.update(dep_module.genrule_headers)
Motomu Utsumie246feb2022-11-01 17:25:56 +09001398
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001399 # For filegroups, and genrule, recurse but don't apply the
Patrick Rohra6ce0232022-11-16 22:09:01 -08001400 # deps.
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001401 if not module.is_compiled() or module.is_genrule():
Patrick Rohr92d74122022-10-21 15:50:52 -07001402 continue
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001403
Patrick Rohr92d74122022-10-21 15:50:52 -07001404 if dep_module.type == 'cc_library_shared':
1405 module.shared_libs.add(dep_module.name)
1406 elif dep_module.type == 'cc_library_static':
1407 module.static_libs.add(dep_module.name)
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001408 elif dep_module.type == 'cc_object':
Mohannad Farragf2391cc2022-11-29 13:26:32 +00001409 module.merge_attribute('generated_headers', dep_module, target.arch.keys())
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001410 if module.type != 'cc_object':
1411 if dep_module.has_input_files():
1412 # Only add it as part of srcs if the dep_module has input files otherwise
1413 # this would throw an error.
1414 module.srcs.add(":" + dep_module.name)
Mohannad Farragf2391cc2022-11-29 13:26:32 +00001415 module.merge_attribute('export_generated_headers', dep_module,
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001416 target.arch.keys(), 'generated_headers')
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001417 elif dep_module.type == 'cc_genrule':
Mohannad Farragf2391cc2022-11-29 13:26:32 +00001418 module.merge_attribute('generated_headers', dep_module, [], 'genrule_headers')
1419 module.merge_attribute('srcs', dep_module, [], 'genrule_srcs')
1420 module.merge_attribute('shared_libs', dep_module, [], 'genrule_shared_libs')
1421 module.merge_attribute('header_libs', dep_module, [], 'genrule_header_libs')
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001422 if module.type not in ["cc_object"]:
Mohannad Farragf2391cc2022-11-29 13:26:32 +00001423 module.merge_attribute('export_generated_headers', dep_module, [],
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001424 'genrule_headers')
Patrick Rohr92d74122022-10-21 15:50:52 -07001425 elif dep_module.type == 'cc_binary':
1426 continue # Ignore executables deps (used by cmdline integration tests).
1427 else:
1428 raise Error('Unknown dep %s (%s) for target %s' %
1429 (dep_module.name, dep_module.type, module.name))
1430
Patrick Rohrb51878f2022-11-16 23:49:03 -08001431 for arch_name, arch in target.arch.items():
1432 for dep_name in arch.deps:
Patrick Rohr25926e62022-12-14 19:55:57 -08001433 # |builtin_deps| override GN deps with Android-specific ones. See the
1434 # config in the top of this file.
1435 if dep_name in builtin_deps:
1436 builtin_deps[dep_name](module, arch_name)
1437 continue
Patrick Rohrb51878f2022-11-16 23:49:03 -08001438 dep_module = create_modules_from_target(blueprint, gn, dep_name)
1439 # Arch-specific dependencies currently only include cc_library_static.
1440 # Revisit this approach once we need to support more target types.
1441 if dep_module.type == 'cc_library_static':
1442 module.target[arch_name].static_libs.add(dep_module.name)
Mohannad Farrag1de6cb12022-11-28 12:27:26 +00001443 elif dep_module.type == 'cc_genrule':
1444 if dep_module.name.endswith(arch_name):
1445 module.target[arch_name].generated_headers.update(dep_module.genrule_headers)
1446 module.target[arch_name].srcs.update(dep_module.genrule_srcs)
1447 module.target[arch_name].shared_libs.update(dep_module.genrule_shared_libs)
1448 module.target[arch_name].header_libs.update(dep_module.genrule_header_libs)
1449 if module.type not in ["cc_object"]:
1450 module.target[arch_name].export_generated_headers.update(
1451 dep_module.genrule_headers)
Patrick Rohr70695562022-12-14 19:45:34 -08001452 elif dep_module.type == 'cc_object':
1453 if dep_module.has_input_files():
1454 # Only add it as part of srcs if the dep_module has input files otherwise
1455 # this would throw an error.
1456 module.target[arch_name].srcs.add(":" + dep_module.name)
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001457 else:
1458 raise Error('Unsupported arch-specific dependency %s of target %s with type %s' %
1459 (dep_module.name, target.name, dep_module.type))
Patrick Rohr92d74122022-10-21 15:50:52 -07001460 return module
1461
Mohannad Farrag3d3d6132022-12-06 18:11:48 +00001462def create_java_jni_preprocessor(blueprint):
1463 bp_module_name = module_prefix + 'java_jni_annotation_preprocessor'
1464 module = Module('java_plugin', bp_module_name, '//base/android/jni_generator:jni_processor')
1465 module.srcs.update(
1466 [
1467 "base/android/jni_generator/java/src/org/chromium/jni_generator/JniProcessor.java",
1468 # Avoids a circular dependency with base:base_java. This is okay because
1469 # no target should ever expect to package an annotation processor.
1470 "build/android/java/src/org/chromium/build/annotations/CheckDiscard.java",
1471 "build/android/java/src/org/chromium/build/annotations/MainDex.java",
Mohannad Farrag89f38e42022-12-06 18:54:46 +00001472 "base/android/java/src/org/chromium/base/JniStaticTestMocker.java",
1473 "base/android/java/src/org/chromium/base/NativeLibraryLoadedStatus.java",
1474 "base/android/java/src/org/chromium/base/annotations/NativeMethods.java",
1475 "base/android/java/src/org/chromium/base/JniException.java",
1476 ":cronet_aml_build_android_build_config_gen",
Mohannad Farrag3d3d6132022-12-06 18:11:48 +00001477 ])
Mohannad Farrag89f38e42022-12-06 18:54:46 +00001478 module.static_libs.update({
1479 "javapoet",
1480 "guava",
1481 "auto_service_annotations",
1482 })
1483 module.processor_class = "org.chromium.jni_generator.JniProcessor"
Mohannad Farrag3d3d6132022-12-06 18:11:48 +00001484 blueprint.add_module(module)
1485 return module
1486
Motomu Utsumi1002cd82022-12-23 17:19:03 +09001487def get_java_sources(gn, predicate):
Motomu Utsumiea729d32022-12-23 17:06:41 +09001488 java_sources = set()
Motomu Utsumi1002cd82022-12-23 17:19:03 +09001489 for target_name, sources in gn.java_sources.items():
1490 if predicate(target_name):
1491 java_sources.update(sources)
Motomu Utsumiea729d32022-12-23 17:06:41 +09001492 return java_sources
1493
Motomu Utsumi1002cd82022-12-23 17:19:03 +09001494def get_java_actions(gn, predicate):
Motomu Utsumiea729d32022-12-23 17:06:41 +09001495 java_actions = set()
Motomu Utsumi1002cd82022-12-23 17:19:03 +09001496 for target_name, actions in gn.java_actions.items():
1497 if predicate(target_name):
1498 java_actions.update(actions)
Motomu Utsumiea729d32022-12-23 17:06:41 +09001499 return java_actions
1500
Motomu Utsumi1002cd82022-12-23 17:19:03 +09001501def get_non_api_java_sources(gn):
1502 return get_java_sources(gn, lambda name: name != java_api_target_name)
1503
1504def get_non_api_java_actions(gn):
1505 return get_java_actions(gn, lambda name: name != java_api_target_name)
1506
Motomu Utsumia0a3dbe2022-12-23 17:23:34 +09001507def get_api_java_sources(gn):
1508 return get_java_sources(gn, lambda name: name == java_api_target_name)
1509
1510def get_api_java_actions(gn):
1511 return get_java_actions(gn, lambda name: name == java_api_target_name)
1512
Patrick Rohrb18aca22022-11-04 15:07:32 -07001513def create_java_module(blueprint, gn):
1514 bp_module_name = module_prefix + 'java'
1515 module = Module('java_library', bp_module_name, '//gn:java')
Motomu Utsumi1002cd82022-12-23 17:19:03 +09001516 module.srcs.update([gn_utils.label_to_path(source) for source in get_non_api_java_sources(gn)])
Mohannad Farrage815d862022-12-06 17:51:43 +00001517 module.libs = {
Motomu Utsumidf6024d2022-12-07 16:39:11 +09001518 "androidx.annotation_annotation",
1519 "jsr305",
Motomu Utsumi05a49a52022-12-09 18:21:13 +09001520 "androidx.core_core-nodeps",
Motomu Utsumidf6024d2022-12-07 16:39:11 +09001521 "androidx.collection_collection",
Motomu Utsumi05a49a52022-12-09 18:21:13 +09001522 "androidx.annotation_annotation-experimental-nodeps",
Motomu Utsumidf6024d2022-12-07 16:39:11 +09001523 "android-support-multidex",
Motomu Utsumif985e032022-12-09 15:53:39 +09001524 "framework-connectivity.stubs.module_lib",
1525 "framework-connectivity-t.stubs.module_lib",
1526 "framework-tethering.stubs.module_lib",
1527 "framework-wifi.stubs.module_lib",
1528 "framework-mediaprovider.stubs.module_lib",
Mohannad Farrage815d862022-12-06 17:51:43 +00001529 }
Mohannad Farragb30d3712022-12-06 17:27:04 +00001530 module.aidl["include_dirs"] = {"frameworks/base/core/java/"}
1531 module.aidl["local_include_dirs"] = {"base/android/java/src/"}
Motomu Utsumif985e032022-12-09 15:53:39 +09001532 module.sdk_version = "module_current"
Motomu Utsumi42acf6d2022-12-09 16:04:10 +09001533 module.apex_available.add(tethering_apex)
Patrick Rohr8d393192022-12-22 14:50:20 -08001534 # TODO: support for this flag is removed upstream in crrev/c/4062652.
1535 # Consider reverting this change upstream, or worst-case downstream. As an
1536 # alternative hack, we could rename the generated file to not conflict. This
1537 # would be less likely to conflict with upstream changes if the revert is not
1538 # accepted.
1539 module.javacflags.add("-Aorg.chromium.chrome.skipGenJni")
Motomu Utsumi42acf6d2022-12-09 16:04:10 +09001540 # TODO: remove following workaround required to make this module visible to make (b/203203405)
1541 module.apex_available.add("//apex_available:platform")
Motomu Utsumi1002cd82022-12-23 17:19:03 +09001542 for dep in get_non_api_java_actions(gn):
Mohannad Farrag9c2cee12022-12-06 17:11:25 +00001543 target = gn.get_target(dep)
1544 if target.script == '//build/android/gyp/gcc_preprocess.py':
1545 module.srcs.add(':' + create_gcc_preprocess_modules(blueprint, target).name)
1546 else:
1547 module.srcs.add(':' + create_action_module(blueprint, target, 'java_genrule').name)
Mohannad Farrag3d3d6132022-12-06 18:11:48 +00001548 preprocessor_module = create_java_jni_preprocessor(blueprint)
1549 module.plugins.add(preprocessor_module.name)
Patrick Rohrb18aca22022-11-04 15:07:32 -07001550 blueprint.add_module(module)
Motomu Utsumi46ec15c2022-12-23 19:41:02 +09001551 return module
Patrick Rohr92d74122022-10-21 15:50:52 -07001552
Motomu Utsumia0a3dbe2022-12-23 17:23:34 +09001553def create_java_api_module(blueprint, gn):
1554 source_module = Module('filegroup', module_prefix + 'api_sources', java_api_target_name)
1555 source_module.srcs.update([gn_utils.label_to_path(source)
1556 for source in get_api_java_sources(gn)])
1557 source_module.srcs.update([
1558 ':' + create_action_module(blueprint, gn.get_target(dep), 'java_genrule').name
1559 for dep in get_api_java_actions(gn)])
1560 blueprint.add_module(source_module)
1561
Motomu Utsumi46ec15c2022-12-23 19:41:02 +09001562 java_module = Module('java_library', module_prefix + 'api_java', java_api_target_name)
1563 java_module.srcs.add(":" + source_module.name)
1564 java_module.sdk_version = "module_current"
1565 java_module.libs = {
1566 "androidx.annotation_annotation",
1567 }
1568 blueprint.add_module(java_module)
1569 return java_module
1570
Patrick Rohr6ef22722022-11-18 18:24:01 -08001571def update_jni_registration_module(module, gn):
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001572 # TODO: java_sources might not contain all the required java files
Motomu Utsumi47d122f2022-11-10 17:32:23 +09001573 module.srcs.update([gn_utils.label_to_path(source)
Motomu Utsumi1002cd82022-12-23 17:19:03 +09001574 for source in get_non_api_java_sources(gn)
Patrick Rohrf20b5ed2022-12-22 14:57:50 -08001575 if source.endswith('.java')])
Motomu Utsumie3ce7702022-11-10 16:22:11 +09001576
Motomu Utsumia71281c2022-11-18 15:19:00 +09001577def create_blueprint_for_targets(gn, targets):
Patrick Rohr92d74122022-10-21 15:50:52 -07001578 """Generate a blueprint for a list of GN targets."""
1579 blueprint = Blueprint()
1580
1581 # Default settings used by all modules.
1582 defaults = Module('cc_defaults', defaults_module, '//gn:default_deps')
Patrick Rohr92d74122022-10-21 15:50:52 -07001583 defaults.cflags = [
Patrick Rohr3ce74772022-11-11 14:19:58 -08001584 '-DGOOGLE_PROTOBUF_NO_RTTI',
Patrick Rohr92d74122022-10-21 15:50:52 -07001585 '-Wno-error=return-type',
Patrick Rohr3a1ec1d2022-10-31 13:30:17 -07001586 '-Wno-non-virtual-dtor',
Patrick Rohr5c700022022-11-08 19:33:07 -08001587 '-Wno-macro-redefined',
Patrick Rohr98065152022-10-31 14:49:58 -07001588 '-Wno-missing-field-initializers',
Patrick Rohr92d74122022-10-21 15:50:52 -07001589 '-Wno-sign-compare',
1590 '-Wno-sign-promo',
1591 '-Wno-unused-parameter',
Mohannad Farrag54d52442022-11-21 16:27:02 +00001592 '-Wno-null-pointer-subtraction', # Needed to libevent
Mohannad Farragd98a96d2022-11-10 14:56:19 +00001593 '-Wno-deprecated-non-prototype', # needed for zlib
Patrick Rohr92d74122022-10-21 15:50:52 -07001594 '-fvisibility=hidden',
Motomu Utsumiba020942022-11-14 15:15:41 +09001595 '-Wno-ambiguous-reversed-operator', # needed for icui18n
Motomu Utsumib1ec8782022-11-14 15:25:57 +09001596 '-Wno-unreachable-code-loop-increment', # needed for icui18n
Patrick Rohr92d74122022-10-21 15:50:52 -07001597 '-O2',
Mohannad Farrag7f29d832022-11-23 19:52:41 +00001598 '-fPIC',
Patrick Rohr92d74122022-10-21 15:50:52 -07001599 ]
Patrick Rohrc03f1bb2022-11-18 16:13:17 -08001600 # Chromium builds do not add a dependency for headers found inside the
1601 # sysroot, so they are added globally via defaults.
1602 defaults.target['android'].header_libs = [
Patrick Rohrc03f1bb2022-11-18 16:13:17 -08001603 'jni_headers',
1604 ]
Motomu Utsumidbf28632022-12-23 21:03:21 +09001605 defaults.target['android'].shared_libs = [
1606 'libmediandk'
1607 ]
Patrick Rohr5446df82022-11-18 14:54:55 -08001608 defaults.target['host'].cflags = [
1609 # -DANDROID is added by default but target.defines contain -DANDROID if
1610 # it's required. So adding -UANDROID to cancel default -DANDROID if it's
1611 # not specified.
1612 # Note: -DANDROID is not consistently applied across the chromium code
1613 # base, so it is removed unconditionally for host targets.
1614 '-UANDROID',
1615 ]
Patrick Rohr61f2acb2022-10-31 14:08:18 -07001616 defaults.stl = 'none'
Motomu Utsumi8ca12412022-11-30 16:27:30 +09001617 defaults.min_sdk_version = 29
1618 defaults.apex_available.add(tethering_apex)
Patrick Rohr92d74122022-10-21 15:50:52 -07001619 blueprint.add_module(defaults)
Patrick Rohr344b2472022-10-25 11:32:15 -07001620
Patrick Rohr92d74122022-10-21 15:50:52 -07001621 for target in targets:
1622 create_modules_from_target(blueprint, gn, target)
Patrick Rohrb18aca22022-11-04 15:07:32 -07001623
Motomu Utsumi46ec15c2022-12-23 19:41:02 +09001624 java_api_module = create_java_api_module(blueprint, gn)
1625 java_module = create_java_module(blueprint, gn)
1626 java_module.libs.add(java_api_module.name)
Patrick Rohr6ef22722022-11-18 18:24:01 -08001627 for module in blueprint.modules.values():
1628 if 'cronet_jni_registration' in module.name:
1629 update_jni_registration_module(module, gn)
Patrick Rohra7d029d2022-11-08 12:23:11 -08001630
1631 # Merge in additional hardcoded arguments.
1632 for module in blueprint.modules.values():
1633 for key, add_val in additional_args.get(module.name, []):
1634 curr = getattr(module, key)
1635 if add_val and isinstance(add_val, set) and isinstance(curr, set):
1636 curr.update(add_val)
1637 elif isinstance(add_val, str) and (not curr or isinstance(curr, str)):
1638 setattr(module, key, add_val)
1639 elif isinstance(add_val, bool) and (not curr or isinstance(curr, bool)):
1640 setattr(module, key, add_val)
1641 elif isinstance(add_val, dict) and isinstance(curr, dict):
1642 curr.update(add_val)
1643 elif isinstance(add_val, dict) and isinstance(curr, Target):
1644 curr.__dict__.update(add_val)
1645 else:
1646 raise Error('Unimplemented type %r of additional_args: %r' %
1647 (type(add_val), key))
1648
Patrick Rohr92d74122022-10-21 15:50:52 -07001649 return blueprint
1650
1651
1652def main():
1653 parser = argparse.ArgumentParser(
1654 description='Generate Android.bp from a GN description.')
1655 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001656 '--desc',
Motomu Utsumi879dec82022-11-18 15:25:12 +09001657 help='GN description (e.g., gn desc out --format=json --all-toolchains "//*".' +
1658 'You can specify multiple --desc options for different target_cpu',
1659 required=True,
1660 action='append'
Patrick Rohr92d74122022-10-21 15:50:52 -07001661 )
1662 parser.add_argument(
1663 '--extras',
1664 help='Extra targets to include at the end of the Blueprint file',
1665 default=os.path.join(gn_utils.repo_root(), 'Android.bp.extras'),
1666 )
1667 parser.add_argument(
1668 '--output',
1669 help='Blueprint file to create',
1670 default=os.path.join(gn_utils.repo_root(), 'Android.bp'),
1671 )
1672 parser.add_argument(
Patrick Rohr16228942022-10-26 14:00:26 -07001673 '-v',
1674 '--verbose',
1675 help='Print debug logs.',
1676 action='store_true',
1677 )
1678 parser.add_argument(
Patrick Rohr92d74122022-10-21 15:50:52 -07001679 'targets',
1680 nargs=argparse.REMAINDER,
Patrick Rohr1aa504a2022-10-25 10:30:42 -07001681 help='Targets to include in the blueprint (e.g., "//:perfetto_tests")'
1682 )
Patrick Rohr92d74122022-10-21 15:50:52 -07001683 args = parser.parse_args()
1684
Patrick Rohr16228942022-10-26 14:00:26 -07001685 if args.verbose:
1686 log.basicConfig(format='%(levelname)s:%(funcName)s:%(message)s', level=log.DEBUG)
1687
Patrick Rohrd0077b72022-11-15 12:43:26 -08001688 targets = args.targets or default_targets
Patrick Rohr0913f0b2022-12-13 09:13:20 -08001689 gn = gn_utils.GnParser(builtin_deps)
Motomu Utsumi879dec82022-11-18 15:25:12 +09001690 for desc_file in args.desc:
1691 with open(desc_file) as f:
1692 desc = json.load(f)
1693 for target in targets:
1694 gn.parse_gn_desc(desc, target)
Motomu Utsumia71281c2022-11-18 15:19:00 +09001695 blueprint = create_blueprint_for_targets(gn, targets)
Patrick Rohr92d74122022-10-21 15:50:52 -07001696 project_root = os.path.abspath(os.path.dirname(os.path.dirname(__file__)))
1697 tool_name = os.path.relpath(os.path.abspath(__file__), project_root)
1698
Patrick Rohr92d74122022-10-21 15:50:52 -07001699 # Add any proto groups to the blueprint.
1700 for l_name, t_names in proto_groups.items():
1701 create_proto_group_modules(blueprint, gn, l_name, t_names)
1702
1703 output = [
Patrick Rohr5478b392022-10-25 09:58:50 -07001704 """// Copyright (C) 2022 The Android Open Source Project
Patrick Rohr92d74122022-10-21 15:50:52 -07001705//
1706// Licensed under the Apache License, Version 2.0 (the "License");
1707// you may not use this file except in compliance with the License.
1708// You may obtain a copy of the License at
1709//
1710// http://www.apache.org/licenses/LICENSE-2.0
1711//
1712// Unless required by applicable law or agreed to in writing, software
1713// distributed under the License is distributed on an "AS IS" BASIS,
1714// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1715// See the License for the specific language governing permissions and
1716// limitations under the License.
1717//
1718// This file is automatically generated by %s. Do not edit.
1719""" % (tool_name)
1720 ]
1721 blueprint.to_string(output)
Patrick Rohrcb98e9b2022-10-25 09:57:02 -07001722 if os.path.exists(args.extras):
1723 with open(args.extras, 'r') as r:
1724 for line in r:
1725 output.append(line.rstrip("\n\r"))
Patrick Rohr92d74122022-10-21 15:50:52 -07001726
1727 out_files = []
1728
1729 # Generate the Android.bp file.
1730 out_files.append(args.output + '.swp')
1731 with open(out_files[-1], 'w') as f:
1732 f.write('\n'.join(output))
1733 # Text files should have a trailing EOL.
1734 f.write('\n')
1735
Patrick Rohr94693eb2022-10-25 10:09:16 -07001736 return 0
Patrick Rohr92d74122022-10-21 15:50:52 -07001737
1738
1739if __name__ == '__main__':
1740 sys.exit(main())