blob: 9c2c679a0abc15fd4afcb67bc6b1f79d8766398f [file] [log] [blame]
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001// Copyright (C) 2018 The Android Open Source Project
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
Jiyong Parkc0ec6f92020-11-19 23:00:52 +090015// package apex implements build rules for creating the APEX files which are container for
16// lower-level system components. See https://source.android.com/devices/tech/ota/apex
Jiyong Park48ca7dc2018-10-10 14:01:00 +090017package apex
18
19import (
20 "fmt"
Jiyong Park48ca7dc2018-10-10 14:01:00 +090021 "path/filepath"
Jiyong Parkab3ceb32018-10-10 14:05:29 +090022 "sort"
Jiyong Park48ca7dc2018-10-10 14:01:00 +090023 "strings"
24
Jiyong Park48ca7dc2018-10-10 14:01:00 +090025 "github.com/google/blueprint"
Alex Light778127a2019-02-27 14:19:50 -080026 "github.com/google/blueprint/bootstrap"
Jiyong Park48ca7dc2018-10-10 14:01:00 +090027 "github.com/google/blueprint/proptools"
Jaewoong Jung4b79e982020-06-01 10:45:49 -070028
29 "android/soong/android"
Rupert Shuttlewortha9d76dd2021-07-02 07:17:16 -040030 "android/soong/bazel"
markchien2f59ec92020-09-02 16:23:38 +080031 "android/soong/bpf"
Jaewoong Jung4b79e982020-06-01 10:45:49 -070032 "android/soong/cc"
33 prebuilt_etc "android/soong/etc"
Jiyong Park12a719c2021-01-07 15:31:24 +090034 "android/soong/filesystem"
Jaewoong Jung4b79e982020-06-01 10:45:49 -070035 "android/soong/java"
36 "android/soong/python"
Jiyong Park99644e92020-11-17 22:21:02 +090037 "android/soong/rust"
Jaewoong Jung4b79e982020-06-01 10:45:49 -070038 "android/soong/sh"
Jiyong Park48ca7dc2018-10-10 14:01:00 +090039)
40
Jiyong Park8e6d52f2020-11-19 14:37:47 +090041func init() {
Paul Duffin667893c2021-03-09 22:34:13 +000042 registerApexBuildComponents(android.InitRegistrationContext)
43}
Jiyong Park8e6d52f2020-11-19 14:37:47 +090044
Paul Duffin667893c2021-03-09 22:34:13 +000045func registerApexBuildComponents(ctx android.RegistrationContext) {
46 ctx.RegisterModuleType("apex", BundleFactory)
47 ctx.RegisterModuleType("apex_test", testApexBundleFactory)
48 ctx.RegisterModuleType("apex_vndk", vndkApexBundleFactory)
49 ctx.RegisterModuleType("apex_defaults", defaultsFactory)
50 ctx.RegisterModuleType("prebuilt_apex", PrebuiltFactory)
51 ctx.RegisterModuleType("override_apex", overrideApexFactory)
52 ctx.RegisterModuleType("apex_set", apexSetFactory)
53
Paul Duffin5dda3e32021-05-05 14:13:27 +010054 ctx.PreArchMutators(registerPreArchMutators)
Paul Duffin667893c2021-03-09 22:34:13 +000055 ctx.PreDepsMutators(RegisterPreDepsMutators)
56 ctx.PostDepsMutators(RegisterPostDepsMutators)
Rupert Shuttlewortha9d76dd2021-07-02 07:17:16 -040057
58 android.RegisterBp2BuildMutator("apex", ApexBundleBp2Build)
Jiyong Park8e6d52f2020-11-19 14:37:47 +090059}
60
Paul Duffin5dda3e32021-05-05 14:13:27 +010061func registerPreArchMutators(ctx android.RegisterMutatorsContext) {
62 ctx.TopDown("prebuilt_apex_module_creator", prebuiltApexModuleCreatorMutator).Parallel()
63}
64
Jiyong Park8e6d52f2020-11-19 14:37:47 +090065func RegisterPreDepsMutators(ctx android.RegisterMutatorsContext) {
66 ctx.TopDown("apex_vndk", apexVndkMutator).Parallel()
67 ctx.BottomUp("apex_vndk_deps", apexVndkDepsMutator).Parallel()
68}
69
70func RegisterPostDepsMutators(ctx android.RegisterMutatorsContext) {
Paul Duffin949abc02020-12-08 10:34:30 +000071 ctx.TopDown("apex_info", apexInfoMutator).Parallel()
Jiyong Park8e6d52f2020-11-19 14:37:47 +090072 ctx.BottomUp("apex_unique", apexUniqueVariationsMutator).Parallel()
73 ctx.BottomUp("apex_test_for_deps", apexTestForDepsMutator).Parallel()
74 ctx.BottomUp("apex_test_for", apexTestForMutator).Parallel()
Paul Duffin28bf7ee2021-05-12 16:41:35 +010075 // Run mark_platform_availability before the apexMutator as the apexMutator needs to know whether
76 // it should create a platform variant.
77 ctx.BottomUp("mark_platform_availability", markPlatformAvailability).Parallel()
Jiyong Park8e6d52f2020-11-19 14:37:47 +090078 ctx.BottomUp("apex", apexMutator).Parallel()
79 ctx.BottomUp("apex_directly_in_any", apexDirectlyInAnyMutator).Parallel()
80 ctx.BottomUp("apex_flattened", apexFlattenedMutator).Parallel()
Jiyong Park8e6d52f2020-11-19 14:37:47 +090081}
82
83type apexBundleProperties struct {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +090084 // Json manifest file describing meta info of this APEX bundle. Refer to
85 // system/apex/proto/apex_manifest.proto for the schema. Default: "apex_manifest.json"
Jiyong Park8e6d52f2020-11-19 14:37:47 +090086 Manifest *string `android:"path"`
87
Jiyong Parkc0ec6f92020-11-19 23:00:52 +090088 // AndroidManifest.xml file used for the zip container of this APEX bundle. If unspecified,
89 // a default one is automatically generated.
Jiyong Park8e6d52f2020-11-19 14:37:47 +090090 AndroidManifest *string `android:"path"`
91
Jiyong Parkc0ec6f92020-11-19 23:00:52 +090092 // Canonical name of this APEX bundle. Used to determine the path to the activated APEX on
93 // device (/apex/<apex_name>). If unspecified, follows the name property.
Jiyong Park8e6d52f2020-11-19 14:37:47 +090094 Apex_name *string
95
Jiyong Parkc0ec6f92020-11-19 23:00:52 +090096 // Determines the file contexts file for setting the security contexts to files in this APEX
97 // bundle. For platform APEXes, this should points to a file under /system/sepolicy Default:
98 // /system/sepolicy/apex/<module_name>_file_contexts.
Jiyong Park8e6d52f2020-11-19 14:37:47 +090099 File_contexts *string `android:"path"`
100
101 ApexNativeDependencies
102
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900103 Multilib apexMultilibProperties
104
Paul Duffin4b64ba02021-03-29 11:02:53 +0100105 // List of bootclasspath fragments that are embedded inside this APEX bundle.
106 Bootclasspath_fragments []string
107
satayev333a1732021-05-17 21:35:26 +0100108 // List of systemserverclasspath fragments that are embedded inside this APEX bundle.
109 Systemserverclasspath_fragments []string
110
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900111 // List of java libraries that are embedded inside this APEX bundle.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900112 Java_libs []string
113
Paul Duffin3abc1742021-03-15 19:32:23 +0000114 // List of platform_compat_config files that are embedded inside this APEX bundle.
115 Compat_configs []string
116
Jiyong Park12a719c2021-01-07 15:31:24 +0900117 // List of filesystem images that are embedded inside this APEX bundle.
118 Filesystems []string
119
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900120 // The minimum SDK version that this APEX must support at minimum. This is usually set to
121 // the SDK version that the APEX was first introduced.
122 Min_sdk_version *string
123
124 // Whether this APEX is considered updatable or not. When set to true, this will enforce
125 // additional rules for making sure that the APEX is truly updatable. To be updatable,
126 // min_sdk_version should be set as well. This will also disable the size optimizations like
Mathew Inwoodf8dcf5e2021-02-16 11:40:16 +0000127 // symlinking to the system libs. Default is true.
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900128 Updatable *bool
129
Jiyong Park1bc84122021-06-22 20:23:05 +0900130 // Whether this APEX can use platform APIs or not. Can be set to true only when `updatable:
131 // false`. Default is false.
132 Platform_apis *bool
133
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900134 // Whether this APEX is installable to one of the partitions like system, vendor, etc.
135 // Default: true.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900136 Installable *bool
137
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000138 // Whether this APEX can be compressed or not. Setting this property to false means this
139 // APEX will never be compressed. When set to true, APEX will be compressed if other
140 // conditions, e.g, target device needs to support APEX compression, are also fulfilled.
141 // Default: true.
142 Compressible *bool
143
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900144 // If set true, VNDK libs are considered as stable libs and are not included in this APEX.
145 // Should be only used in non-system apexes (e.g. vendor: true). Default is false.
146 Use_vndk_as_stable *bool
147
148 // List of SDKs that are used to build this APEX. A reference to an SDK should be either
149 // `name#version` or `name` which is an alias for `name#current`. If left empty,
150 // `platform#current` is implied. This value affects all modules included in this APEX. In
151 // other words, they are also built with the SDKs specified here.
152 Uses_sdks []string
153
154 // The type of APEX to build. Controls what the APEX payload is. Either 'image', 'zip' or
155 // 'both'. When set to image, contents are stored in a filesystem image inside a zip
156 // container. When set to zip, contents are stored in a zip container directly. This type is
157 // mostly for host-side debugging. When set to both, the two types are both built. Default
158 // is 'image'.
159 Payload_type *string
160
Huang Jianan13cac632021-08-02 15:02:17 +0800161 // The type of filesystem to use when the payload_type is 'image'. Either 'ext4', 'f2fs'
162 // or 'erofs'. Default 'ext4'.
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900163 Payload_fs_type *string
164
165 // For telling the APEX to ignore special handling for system libraries such as bionic.
166 // Default is false.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900167 Ignore_system_library_special_case *bool
168
Nikita Ioffeda6dc312021-06-09 19:43:46 +0100169 // Whenever apex_payload.img of the APEX should include dm-verity hashtree.
Nikita Ioffee261ae62021-06-16 18:15:03 +0100170 // Default value is true.
Nikita Ioffeda6dc312021-06-09 19:43:46 +0100171 Generate_hashtree *bool
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900172
173 // Whenever apex_payload.img of the APEX should not be dm-verity signed. Should be only
174 // used in tests.
175 Test_only_unsigned_payload *bool
176
Mohammad Samiul Islama8008f92020-12-22 10:47:50 +0000177 // Whenever apex should be compressed, regardless of product flag used. Should be only
178 // used in tests.
179 Test_only_force_compression *bool
180
Martin Stjernholmbfffae72021-06-24 14:37:13 +0100181 // Canonical name of this APEX bundle. Used to determine the path to the
182 // activated APEX on device (i.e. /apex/<apexVariationName>), and used for the
183 // apex mutator variations. For override_apex modules, this is the name of the
184 // overridden base module.
185 ApexVariationName string `blueprint:"mutated"`
186
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900187 IsCoverageVariant bool `blueprint:"mutated"`
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900188
189 // List of sanitizer names that this APEX is enabled for
190 SanitizerNames []string `blueprint:"mutated"`
191
192 PreventInstall bool `blueprint:"mutated"`
193
194 HideFromMake bool `blueprint:"mutated"`
195
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900196 // Internal package method for this APEX. When payload_type is image, this can be either
197 // imageApex or flattenedApex depending on Config.FlattenApex(). When payload_type is zip,
198 // this becomes zipApex.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900199 ApexType apexPackaging `blueprint:"mutated"`
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900200}
201
202type ApexNativeDependencies struct {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900203 // List of native libraries that are embedded inside this APEX.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900204 Native_shared_libs []string
205
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900206 // List of JNI libraries that are embedded inside this APEX.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900207 Jni_libs []string
208
Jiyong Park99644e92020-11-17 22:21:02 +0900209 // List of rust dyn libraries
210 Rust_dyn_libs []string
211
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900212 // List of native executables that are embedded inside this APEX.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900213 Binaries []string
214
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900215 // List of native tests that are embedded inside this APEX.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900216 Tests []string
Jiyong Park06711462021-02-15 17:54:43 +0900217
218 // List of filesystem images that are embedded inside this APEX bundle.
219 Filesystems []string
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900220}
221
222type apexMultilibProperties struct {
223 // Native dependencies whose compile_multilib is "first"
224 First ApexNativeDependencies
225
226 // Native dependencies whose compile_multilib is "both"
227 Both ApexNativeDependencies
228
229 // Native dependencies whose compile_multilib is "prefer32"
230 Prefer32 ApexNativeDependencies
231
232 // Native dependencies whose compile_multilib is "32"
233 Lib32 ApexNativeDependencies
234
235 // Native dependencies whose compile_multilib is "64"
236 Lib64 ApexNativeDependencies
237}
238
239type apexTargetBundleProperties struct {
240 Target struct {
241 // Multilib properties only for android.
242 Android struct {
243 Multilib apexMultilibProperties
244 }
245
246 // Multilib properties only for host.
247 Host struct {
248 Multilib apexMultilibProperties
249 }
250
251 // Multilib properties only for host linux_bionic.
252 Linux_bionic struct {
253 Multilib apexMultilibProperties
254 }
255
256 // Multilib properties only for host linux_glibc.
257 Linux_glibc struct {
258 Multilib apexMultilibProperties
259 }
260 }
261}
262
Jiyong Park59140302020-12-14 18:44:04 +0900263type apexArchBundleProperties struct {
264 Arch struct {
265 Arm struct {
266 ApexNativeDependencies
267 }
268 Arm64 struct {
269 ApexNativeDependencies
270 }
271 X86 struct {
272 ApexNativeDependencies
273 }
274 X86_64 struct {
275 ApexNativeDependencies
276 }
277 }
278}
279
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900280// These properties can be used in override_apex to override the corresponding properties in the
281// base apex.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900282type overridableProperties struct {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900283 // List of APKs that are embedded inside this APEX.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900284 Apps []string
285
Daniel Norman5a3ce132021-08-26 15:44:43 -0700286 // List of prebuilt files that are embedded inside this APEX bundle.
287 Prebuilts []string
288
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900289 // List of runtime resource overlays (RROs) that are embedded inside this APEX.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900290 Rros []string
291
markchien7c803b82021-08-26 22:10:06 +0800292 // List of BPF programs inside this APEX bundle.
293 Bpfs []string
294
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900295 // Names of modules to be overridden. Listed modules can only be other binaries (in Make or
296 // Soong). This does not completely prevent installation of the overridden binaries, but if
297 // both binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will
298 // be removed from PRODUCT_PACKAGES.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900299 Overrides []string
300
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900301 // Logging parent value.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900302 Logging_parent string
303
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900304 // Apex Container package name. Override value for attribute package:name in
305 // AndroidManifest.xml
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900306 Package_name string
307
308 // A txt file containing list of files that are allowed to be included in this APEX.
309 Allowed_files *string `android:"path"`
Jaewoong Jung4cfdf7d2021-04-20 16:21:24 -0700310
311 // Name of the apex_key module that provides the private key to sign this APEX bundle.
312 Key *string
313
314 // Specifies the certificate and the private key to sign the zip container of this APEX. If
315 // this is "foo", foo.x509.pem and foo.pk8 under PRODUCT_DEFAULT_DEV_CERTIFICATE are used
316 // as the certificate and the private key, respectively. If this is ":module", then the
317 // certificate and the private key are provided from the android_app_certificate module
318 // named "module".
319 Certificate *string
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900320}
321
322type apexBundle struct {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900323 // Inherited structs
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900324 android.ModuleBase
325 android.DefaultableModuleBase
326 android.OverridableModuleBase
327 android.SdkBase
Rupert Shuttlewortha9d76dd2021-07-02 07:17:16 -0400328 android.BazelModuleBase
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900329
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900330 // Properties
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900331 properties apexBundleProperties
332 targetProperties apexTargetBundleProperties
Jiyong Park59140302020-12-14 18:44:04 +0900333 archProperties apexArchBundleProperties
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900334 overridableProperties overridableProperties
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900335 vndkProperties apexVndkProperties // only for apex_vndk modules
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900336
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900337 ///////////////////////////////////////////////////////////////////////////////////////////
338 // Inputs
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900339
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900340 // Keys for apex_paylaod.img
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800341 publicKeyFile android.Path
342 privateKeyFile android.Path
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900343
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900344 // Cert/priv-key for the zip container
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800345 containerCertificateFile android.Path
346 containerPrivateKeyFile android.Path
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900347
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900348 // Flags for special variants of APEX
349 testApex bool
350 vndkApex bool
351 artApex bool
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900352
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900353 // Tells whether this variant of the APEX bundle is the primary one or not. Only the primary
354 // one gets installed to the device.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900355 primaryApexType bool
356
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900357 // Suffix of module name in Android.mk ".flattened", ".apex", ".zipapex", or ""
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900358 suffix string
359
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900360 // File system type of apex_payload.img
361 payloadFsType fsType
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900362
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900363 // Whether to create symlink to the system file instead of having a file inside the apex or
364 // not
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900365 linkToSystemLib bool
366
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900367 // List of files to be included in this APEX. This is filled in the first part of
368 // GenerateAndroidBuildActions.
369 filesInfo []apexFile
370
371 // List of other module names that should be installed when this APEX gets installed.
372 requiredDeps []string
373
374 ///////////////////////////////////////////////////////////////////////////////////////////
375 // Outputs (final and intermediates)
376
377 // Processed apex manifest in JSONson format (for Q)
378 manifestJsonOut android.WritablePath
379
380 // Processed apex manifest in PB format (for R+)
381 manifestPbOut android.WritablePath
382
383 // Processed file_contexts files
384 fileContexts android.WritablePath
385
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900386 // Struct holding the merged notice file paths in different formats
387 mergedNotices android.NoticeOutputs
388
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900389 // The built APEX file. This is the main product.
390 outputFile android.WritablePath
391
392 // The built APEX file in app bundle format. This file is not directly installed to the
393 // device. For an APEX, multiple app bundles are created each of which is for a specific ABI
394 // like arm, arm64, x86, etc. Then they are processed again (outside of the Android build
395 // system) to be merged into a single app bundle file that Play accepts. See
396 // vendor/google/build/build_unbundled_mainline_module.sh for more detail.
397 bundleModuleFile android.WritablePath
398
399 // Target path to install this APEX. Usually out/target/product/<device>/<partition>/apex.
400 installDir android.InstallPath
401
402 // List of commands to create symlinks for backward compatibility. These commands will be
403 // attached as LOCAL_POST_INSTALL_CMD to apex package itself (for unflattened build) or
404 // apex_manifest (for flattened build) so that compat symlinks are always installed
405 // regardless of TARGET_FLATTEN_APEX setting.
406 compatSymlinks []string
407
408 // Text file having the list of individual files that are included in this APEX. Used for
409 // debugging purpose.
410 installedFilesFile android.WritablePath
411
412 // List of module names that this APEX is including (to be shown via *-deps-info target).
413 // Used for debugging purpose.
414 android.ApexBundleDepsInfo
415
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900416 // Optional list of lint report zip files for apexes that contain java or app modules
417 lintReports android.Paths
418
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900419 prebuiltFileToDelete string
sophiezc80a2b32020-11-12 16:39:19 +0000420
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000421 isCompressed bool
422
sophiezc80a2b32020-11-12 16:39:19 +0000423 // Path of API coverage generate file
sophiez6bde0b52021-01-09 01:03:42 +0000424 apisUsedByModuleFile android.ModuleOutPath
425 apisBackedByModuleFile android.ModuleOutPath
braleeb0c1f0c2021-06-07 22:49:13 +0800426
427 // Collect the module directory for IDE info in java/jdeps.go.
428 modulePaths []string
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900429}
430
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900431// apexFileClass represents a type of file that can be included in APEX.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900432type apexFileClass int
433
Jooyung Han72bd2f82019-10-23 16:46:38 +0900434const (
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900435 app apexFileClass = iota
436 appSet
437 etc
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900438 goBinary
439 javaSharedLib
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900440 nativeExecutable
441 nativeSharedLib
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900442 nativeTest
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900443 pyBinary
444 shBinary
Jooyung Han72bd2f82019-10-23 16:46:38 +0900445)
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900446
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900447// apexFile represents a file in an APEX bundle. This is created during the first half of
448// GenerateAndroidBuildActions by traversing the dependencies of the APEX. Then in the second half
449// of the function, this is used to create commands that copies the files into a staging directory,
450// where they are packaged into the APEX file. This struct is also used for creating Make modules
451// for each of the files in case when the APEX is flattened.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900452type apexFile struct {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900453 // buildFile is put in the installDir inside the APEX.
454 builtFile android.Path
455 noticeFiles android.Paths
456 installDir string
457 customStem string
458 symlinks []string // additional symlinks
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900459
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900460 // Info for Android.mk Module name of `module` in AndroidMk. Note the generated AndroidMk
461 // module for apexFile is named something like <AndroidMk module name>.<apex name>[<apex
462 // suffix>]
463 androidMkModuleName string // becomes LOCAL_MODULE
464 class apexFileClass // becomes LOCAL_MODULE_CLASS
465 moduleDir string // becomes LOCAL_PATH
466 requiredModuleNames []string // becomes LOCAL_REQUIRED_MODULES
467 targetRequiredModuleNames []string // becomes LOCAL_TARGET_REQUIRED_MODULES
468 hostRequiredModuleNames []string // becomes LOCAL_HOST_REQUIRED_MODULES
469 dataPaths []android.DataPath // becomes LOCAL_TEST_DATA
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900470
471 jacocoReportClassesFile android.Path // only for javalibs and apps
472 lintDepSets java.LintDepSets // only for javalibs and apps
473 certificate java.Certificate // only for apps
474 overriddenPackageName string // only for apps
475
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900476 transitiveDep bool
477 isJniLib bool
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900478
Jiyong Park57621b22021-01-20 20:33:11 +0900479 multilib string
480
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900481 // TODO(jiyong): remove this
482 module android.Module
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900483}
484
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900485// TODO(jiyong): shorten the arglist using an option struct
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900486func newApexFile(ctx android.BaseModuleContext, builtFile android.Path, androidMkModuleName string, installDir string, class apexFileClass, module android.Module) apexFile {
487 ret := apexFile{
488 builtFile: builtFile,
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900489 installDir: installDir,
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900490 androidMkModuleName: androidMkModuleName,
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900491 class: class,
492 module: module,
493 }
494 if module != nil {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900495 ret.noticeFiles = module.NoticeFiles()
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900496 ret.moduleDir = ctx.OtherModuleDir(module)
497 ret.requiredModuleNames = module.RequiredModuleNames()
498 ret.targetRequiredModuleNames = module.TargetRequiredModuleNames()
499 ret.hostRequiredModuleNames = module.HostRequiredModuleNames()
Jiyong Park57621b22021-01-20 20:33:11 +0900500 ret.multilib = module.Target().Arch.ArchType.Multilib
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900501 }
502 return ret
503}
504
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900505func (af *apexFile) ok() bool {
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900506 return af.builtFile != nil && af.builtFile.String() != ""
507}
508
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900509// apexRelativePath returns the relative path of the given path from the install directory of this
510// apexFile.
511// TODO(jiyong): rename this
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900512func (af *apexFile) apexRelativePath(path string) string {
513 return filepath.Join(af.installDir, path)
514}
515
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900516// path returns path of this apex file relative to the APEX root
517func (af *apexFile) path() string {
518 return af.apexRelativePath(af.stem())
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900519}
520
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900521// stem returns the base filename of this apex file
522func (af *apexFile) stem() string {
523 if af.customStem != "" {
524 return af.customStem
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900525 }
526 return af.builtFile.Base()
527}
528
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900529// symlinkPaths returns paths of the symlinks (if any) relative to the APEX root
530func (af *apexFile) symlinkPaths() []string {
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900531 var ret []string
532 for _, symlink := range af.symlinks {
533 ret = append(ret, af.apexRelativePath(symlink))
534 }
535 return ret
536}
537
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900538// availableToPlatform tests whether this apexFile is from a module that can be installed to the
539// platform.
540func (af *apexFile) availableToPlatform() bool {
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900541 if af.module == nil {
542 return false
543 }
544 if am, ok := af.module.(android.ApexModule); ok {
545 return am.AvailableFor(android.AvailableToPlatform)
546 }
547 return false
548}
549
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900550////////////////////////////////////////////////////////////////////////////////////////////////////
551// Mutators
552//
553// Brief description about mutators for APEX. The following three mutators are the most important
554// ones.
555//
556// 1) DepsMutator: from the properties like native_shared_libs, java_libs, etc., modules are added
557// to the (direct) dependencies of this APEX bundle.
558//
Paul Duffin949abc02020-12-08 10:34:30 +0000559// 2) apexInfoMutator: this is a post-deps mutator, so runs after DepsMutator. Its goal is to
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900560// collect modules that are direct and transitive dependencies of each APEX bundle. The collected
561// modules are marked as being included in the APEX via BuildForApex().
562//
Paul Duffin949abc02020-12-08 10:34:30 +0000563// 3) apexMutator: this is a post-deps mutator that runs after apexInfoMutator. For each module that
564// are marked by the apexInfoMutator, apex variations are created using CreateApexVariations().
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900565
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900566type dependencyTag struct {
567 blueprint.BaseDependencyTag
568 name string
569
570 // Determines if the dependent will be part of the APEX payload. Can be false for the
571 // dependencies to the signing key module, etc.
572 payload bool
Paul Duffin8c535da2021-03-17 14:51:03 +0000573
574 // True if the dependent can only be a source module, false if a prebuilt module is a suitable
575 // replacement. This is needed because some prebuilt modules do not provide all the information
576 // needed by the apex.
577 sourceOnly bool
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900578}
579
Paul Duffin8c535da2021-03-17 14:51:03 +0000580func (d dependencyTag) ReplaceSourceWithPrebuilt() bool {
581 return !d.sourceOnly
582}
583
584var _ android.ReplaceSourceWithPrebuilt = &dependencyTag{}
585
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900586var (
Paul Duffin0b817782021-03-17 15:02:19 +0000587 androidAppTag = dependencyTag{name: "androidApp", payload: true}
588 bpfTag = dependencyTag{name: "bpf", payload: true}
589 certificateTag = dependencyTag{name: "certificate"}
590 executableTag = dependencyTag{name: "executable", payload: true}
591 fsTag = dependencyTag{name: "filesystem", payload: true}
Paul Duffin94f19632021-04-20 12:40:07 +0100592 bcpfTag = dependencyTag{name: "bootclasspathFragment", payload: true, sourceOnly: true}
satayev333a1732021-05-17 21:35:26 +0100593 sscpfTag = dependencyTag{name: "systemserverclasspathFragment", payload: true, sourceOnly: true}
Paul Duffin1b29e002021-03-16 15:06:54 +0000594 compatConfigTag = dependencyTag{name: "compatConfig", payload: true, sourceOnly: true}
Paul Duffin0b817782021-03-17 15:02:19 +0000595 javaLibTag = dependencyTag{name: "javaLib", payload: true}
596 jniLibTag = dependencyTag{name: "jniLib", payload: true}
597 keyTag = dependencyTag{name: "key"}
598 prebuiltTag = dependencyTag{name: "prebuilt", payload: true}
599 rroTag = dependencyTag{name: "rro", payload: true}
600 sharedLibTag = dependencyTag{name: "sharedLib", payload: true}
601 testForTag = dependencyTag{name: "test for"}
602 testTag = dependencyTag{name: "test", payload: true}
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900603)
604
605// TODO(jiyong): shorten this function signature
606func addDependenciesForNativeModules(ctx android.BottomUpMutatorContext, nativeModules ApexNativeDependencies, target android.Target, imageVariation string) {
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900607 binVariations := target.Variations()
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900608 libVariations := append(target.Variations(), blueprint.Variation{Mutator: "link", Variation: "shared"})
Jiyong Park99644e92020-11-17 22:21:02 +0900609 rustLibVariations := append(target.Variations(), blueprint.Variation{Mutator: "rust_libraries", Variation: "dylib"})
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900610
611 if ctx.Device() {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900612 binVariations = append(binVariations, blueprint.Variation{Mutator: "image", Variation: imageVariation})
Jiyong Parkf2cc1b72020-12-09 00:20:45 +0900613 libVariations = append(libVariations, blueprint.Variation{Mutator: "image", Variation: imageVariation})
614 rustLibVariations = append(rustLibVariations, blueprint.Variation{Mutator: "image", Variation: imageVariation})
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900615 }
616
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900617 // Use *FarVariation* to be able to depend on modules having conflicting variations with
618 // this module. This is required since arch variant of an APEX bundle is 'common' but it is
619 // 'arm' or 'arm64' for native shared libs.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900620 ctx.AddFarVariationDependencies(binVariations, executableTag, nativeModules.Binaries...)
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900621 ctx.AddFarVariationDependencies(binVariations, testTag, nativeModules.Tests...)
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900622 ctx.AddFarVariationDependencies(libVariations, jniLibTag, nativeModules.Jni_libs...)
623 ctx.AddFarVariationDependencies(libVariations, sharedLibTag, nativeModules.Native_shared_libs...)
Jiyong Park99644e92020-11-17 22:21:02 +0900624 ctx.AddFarVariationDependencies(rustLibVariations, sharedLibTag, nativeModules.Rust_dyn_libs...)
Jiyong Park06711462021-02-15 17:54:43 +0900625 ctx.AddFarVariationDependencies(target.Variations(), fsTag, nativeModules.Filesystems...)
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900626}
627
628func (a *apexBundle) combineProperties(ctx android.BottomUpMutatorContext) {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900629 if ctx.Device() {
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900630 proptools.AppendProperties(&a.properties.Multilib, &a.targetProperties.Target.Android.Multilib, nil)
631 } else {
632 proptools.AppendProperties(&a.properties.Multilib, &a.targetProperties.Target.Host.Multilib, nil)
633 if ctx.Os().Bionic() {
634 proptools.AppendProperties(&a.properties.Multilib, &a.targetProperties.Target.Linux_bionic.Multilib, nil)
635 } else {
636 proptools.AppendProperties(&a.properties.Multilib, &a.targetProperties.Target.Linux_glibc.Multilib, nil)
637 }
638 }
639}
640
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900641// getImageVariation returns the image variant name for this apexBundle. In most cases, it's simply
642// android.CoreVariation, but gets complicated for the vendor APEXes and the VNDK APEX.
643func (a *apexBundle) getImageVariation(ctx android.BottomUpMutatorContext) string {
644 deviceConfig := ctx.DeviceConfig()
645 if a.vndkApex {
646 return cc.VendorVariationPrefix + a.vndkVersion(deviceConfig)
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900647 }
648
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900649 var prefix string
650 var vndkVersion string
651 if deviceConfig.VndkVersion() != "" {
Steven Moreland2c4000c2021-04-27 02:08:49 +0000652 if a.SocSpecific() || a.DeviceSpecific() {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900653 prefix = cc.VendorVariationPrefix
654 vndkVersion = deviceConfig.VndkVersion()
655 } else if a.ProductSpecific() {
656 prefix = cc.ProductVariationPrefix
657 vndkVersion = deviceConfig.ProductVndkVersion()
658 }
659 }
660 if vndkVersion == "current" {
661 vndkVersion = deviceConfig.PlatformVndkVersion()
662 }
663 if vndkVersion != "" {
664 return prefix + vndkVersion
665 }
666
667 return android.CoreVariation // The usual case
668}
669
670func (a *apexBundle) DepsMutator(ctx android.BottomUpMutatorContext) {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900671 // apexBundle is a multi-arch targets module. Arch variant of apexBundle is set to 'common'.
672 // arch-specific targets are enabled by the compile_multilib setting of the apex bundle. For
673 // each target os/architectures, appropriate dependencies are selected by their
674 // target.<os>.multilib.<type> groups and are added as (direct) dependencies.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900675 targets := ctx.MultiTargets()
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900676 imageVariation := a.getImageVariation(ctx)
677
678 a.combineProperties(ctx)
679
680 has32BitTarget := false
681 for _, target := range targets {
682 if target.Arch.ArchType.Multilib == "lib32" {
683 has32BitTarget = true
Paul Duffin7d74e7b2020-03-06 12:30:13 +0000684 }
685 }
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900686 for i, target := range targets {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900687 // Don't include artifacts for the host cross targets because there is no way for us
688 // to run those artifacts natively on host
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900689 if target.HostCross {
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900690 continue
691 }
Paul Duffin7d74e7b2020-03-06 12:30:13 +0000692
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900693 var depsList []ApexNativeDependencies
Paul Duffin7d74e7b2020-03-06 12:30:13 +0000694
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900695 // Add native modules targeting both ABIs. When multilib.* is omitted for
696 // native_shared_libs/jni_libs/tests, it implies multilib.both
697 depsList = append(depsList, a.properties.Multilib.Both)
698 depsList = append(depsList, ApexNativeDependencies{
699 Native_shared_libs: a.properties.Native_shared_libs,
700 Tests: a.properties.Tests,
701 Jni_libs: a.properties.Jni_libs,
702 Binaries: nil,
703 })
Jooyung Hanacc7bbe2020-05-20 09:06:00 +0900704
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900705 // Add native modules targeting the first ABI When multilib.* is omitted for
706 // binaries, it implies multilib.first
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900707 isPrimaryAbi := i == 0
708 if isPrimaryAbi {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900709 depsList = append(depsList, a.properties.Multilib.First)
710 depsList = append(depsList, ApexNativeDependencies{
711 Native_shared_libs: nil,
712 Tests: nil,
713 Jni_libs: nil,
714 Binaries: a.properties.Binaries,
715 })
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900716 }
717
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900718 // Add native modules targeting either 32-bit or 64-bit ABI
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900719 switch target.Arch.ArchType.Multilib {
720 case "lib32":
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900721 depsList = append(depsList, a.properties.Multilib.Lib32)
722 depsList = append(depsList, a.properties.Multilib.Prefer32)
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900723 case "lib64":
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900724 depsList = append(depsList, a.properties.Multilib.Lib64)
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900725 if !has32BitTarget {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900726 depsList = append(depsList, a.properties.Multilib.Prefer32)
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900727 }
728 }
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900729
Jiyong Park59140302020-12-14 18:44:04 +0900730 // Add native modules targeting a specific arch variant
731 switch target.Arch.ArchType {
732 case android.Arm:
733 depsList = append(depsList, a.archProperties.Arch.Arm.ApexNativeDependencies)
734 case android.Arm64:
735 depsList = append(depsList, a.archProperties.Arch.Arm64.ApexNativeDependencies)
736 case android.X86:
737 depsList = append(depsList, a.archProperties.Arch.X86.ApexNativeDependencies)
738 case android.X86_64:
739 depsList = append(depsList, a.archProperties.Arch.X86_64.ApexNativeDependencies)
740 default:
741 panic(fmt.Errorf("unsupported arch %v\n", ctx.Arch().ArchType))
742 }
743
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900744 for _, d := range depsList {
745 addDependenciesForNativeModules(ctx, d, target, imageVariation)
746 }
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900747 }
748
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900749 // Common-arch dependencies come next
750 commonVariation := ctx.Config().AndroidCommonTarget.Variations()
Paul Duffin94f19632021-04-20 12:40:07 +0100751 ctx.AddFarVariationDependencies(commonVariation, bcpfTag, a.properties.Bootclasspath_fragments...)
satayev333a1732021-05-17 21:35:26 +0100752 ctx.AddFarVariationDependencies(commonVariation, sscpfTag, a.properties.Systemserverclasspath_fragments...)
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900753 ctx.AddFarVariationDependencies(commonVariation, javaLibTag, a.properties.Java_libs...)
Jiyong Park12a719c2021-01-07 15:31:24 +0900754 ctx.AddFarVariationDependencies(commonVariation, fsTag, a.properties.Filesystems...)
Paul Duffin0b817782021-03-17 15:02:19 +0000755 ctx.AddFarVariationDependencies(commonVariation, compatConfigTag, a.properties.Compat_configs...)
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900756
Ulya Trafimovicha4a1c4e2021-01-15 18:40:04 +0000757 if a.artApex {
758 // With EMMA_INSTRUMENT_FRAMEWORK=true the ART boot image includes jacoco library.
759 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
760 ctx.AddFarVariationDependencies(commonVariation, javaLibTag, "jacocoagent")
761 }
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900762 }
763
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900764 // Marks that this APEX (in fact all the modules in it) has to be built with the given SDKs.
765 // This field currently isn't used.
766 // TODO(jiyong): consider dropping this feature
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900767 // TODO(jiyong): ensure that all apexes are with non-empty uses_sdks
768 if len(a.properties.Uses_sdks) > 0 {
769 sdkRefs := []android.SdkRef{}
770 for _, str := range a.properties.Uses_sdks {
771 parsed := android.ParseSdkRef(ctx, str, "uses_sdks")
772 sdkRefs = append(sdkRefs, parsed)
773 }
774 a.BuildWithSdks(sdkRefs)
Andrei Onea115e7e72020-06-05 21:14:03 +0100775 }
776}
777
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900778// DepsMutator for the overridden properties.
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900779func (a *apexBundle) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
780 if a.overridableProperties.Allowed_files != nil {
781 android.ExtractSourceDeps(ctx, a.overridableProperties.Allowed_files)
Andrei Onea115e7e72020-06-05 21:14:03 +0100782 }
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900783
784 commonVariation := ctx.Config().AndroidCommonTarget.Variations()
785 ctx.AddFarVariationDependencies(commonVariation, androidAppTag, a.overridableProperties.Apps...)
markchien7c803b82021-08-26 22:10:06 +0800786 ctx.AddFarVariationDependencies(commonVariation, bpfTag, a.overridableProperties.Bpfs...)
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900787 ctx.AddFarVariationDependencies(commonVariation, rroTag, a.overridableProperties.Rros...)
Daniel Norman5a3ce132021-08-26 15:44:43 -0700788 if prebuilts := a.overridableProperties.Prebuilts; len(prebuilts) > 0 {
789 // For prebuilt_etc, use the first variant (64 on 64/32bit device, 32 on 32bit device)
790 // regardless of the TARGET_PREFER_* setting. See b/144532908
791 arches := ctx.DeviceConfig().Arches()
792 if len(arches) != 0 {
793 archForPrebuiltEtc := arches[0]
794 for _, arch := range arches {
795 // Prefer 64-bit arch if there is any
796 if arch.ArchType.Multilib == "lib64" {
797 archForPrebuiltEtc = arch
798 break
799 }
800 }
801 ctx.AddFarVariationDependencies([]blueprint.Variation{
802 {Mutator: "os", Variation: ctx.Os().String()},
803 {Mutator: "arch", Variation: archForPrebuiltEtc.String()},
804 }, prebuiltTag, prebuilts...)
805 }
806 }
Jaewoong Jung4cfdf7d2021-04-20 16:21:24 -0700807
808 // Dependencies for signing
809 if String(a.overridableProperties.Key) == "" {
810 ctx.PropertyErrorf("key", "missing")
811 return
812 }
813 ctx.AddDependency(ctx.Module(), keyTag, String(a.overridableProperties.Key))
814
815 cert := android.SrcIsModule(a.getCertString(ctx))
816 if cert != "" {
817 ctx.AddDependency(ctx.Module(), certificateTag, cert)
818 // empty cert is not an error. Cert and private keys will be directly found under
819 // PRODUCT_DEFAULT_DEV_CERTIFICATE
820 }
Andrei Onea115e7e72020-06-05 21:14:03 +0100821}
822
Jiyong Park8e6d52f2020-11-19 14:37:47 +0900823type ApexBundleInfo struct {
824 Contents *android.ApexContents
Andrei Onea115e7e72020-06-05 21:14:03 +0100825}
826
Paul Duffin949abc02020-12-08 10:34:30 +0000827var ApexBundleInfoProvider = blueprint.NewMutatorProvider(ApexBundleInfo{}, "apex_info")
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900828
Paul Duffina7d6a892020-12-07 17:39:59 +0000829var _ ApexInfoMutator = (*apexBundle)(nil)
830
Martin Stjernholmbfffae72021-06-24 14:37:13 +0100831func (a *apexBundle) ApexVariationName() string {
832 return a.properties.ApexVariationName
833}
834
Paul Duffina7d6a892020-12-07 17:39:59 +0000835// ApexInfoMutator is responsible for collecting modules that need to have apex variants. They are
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900836// identified by doing a graph walk starting from an apexBundle. Basically, all the (direct and
837// indirect) dependencies are collected. But a few types of modules that shouldn't be included in
838// the apexBundle (e.g. stub libraries) are not collected. Note that a single module can be depended
839// on by multiple apexBundles. In that case, the module is collected for all of the apexBundles.
Paul Duffin949abc02020-12-08 10:34:30 +0000840//
841// For each dependency between an apex and an ApexModule an ApexInfo object describing the apex
842// is passed to that module's BuildForApex(ApexInfo) method which collates them all in a list.
843// The apexMutator uses that list to create module variants for the apexes to which it belongs.
844// The relationship between module variants and apexes is not one-to-one as variants will be
845// shared between compatible apexes.
Paul Duffina7d6a892020-12-07 17:39:59 +0000846func (a *apexBundle) ApexInfoMutator(mctx android.TopDownMutatorContext) {
Jooyung Handf78e212020-07-22 15:54:47 +0900847
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900848 // The VNDK APEX is special. For the APEX, the membership is described in a very different
849 // way. There is no dependency from the VNDK APEX to the VNDK libraries. Instead, VNDK
850 // libraries are self-identified by their vndk.enabled properties. There is no need to run
851 // this mutator for the APEX as nothing will be collected. So, let's return fast.
852 if a.vndkApex {
853 return
854 }
855
856 // Special casing for APEXes on non-system (e.g., vendor, odm, etc.) partitions. They are
857 // provided with a property named use_vndk_as_stable, which when set to true doesn't collect
858 // VNDK libraries as transitive dependencies. This option is useful for reducing the size of
859 // the non-system APEXes because the VNDK libraries won't be included (and duped) in the
860 // APEX, but shared across APEXes via the VNDK APEX.
Jooyung Handf78e212020-07-22 15:54:47 +0900861 useVndk := a.SocSpecific() || a.DeviceSpecific() || (a.ProductSpecific() && mctx.Config().EnforceProductPartitionInterface())
862 excludeVndkLibs := useVndk && proptools.Bool(a.properties.Use_vndk_as_stable)
863 if !useVndk && proptools.Bool(a.properties.Use_vndk_as_stable) {
864 mctx.PropertyErrorf("use_vndk_as_stable", "not supported for system/system_ext APEXes")
865 return
866 }
867
Colin Cross56a83212020-09-15 18:30:11 -0700868 continueApexDepsWalk := func(child, parent android.Module) bool {
Jooyung Han698dd9f2020-07-22 15:17:19 +0900869 am, ok := child.(android.ApexModule)
870 if !ok || !am.CanHaveApexVariants() {
871 return false
Jiyong Parkf760cae2020-02-12 07:53:12 +0900872 }
Paul Duffin573989d2021-03-17 13:25:29 +0000873 depTag := mctx.OtherModuleDependencyTag(child)
874
875 // Check to see if the tag always requires that the child module has an apex variant for every
876 // apex variant of the parent module. If it does not then it is still possible for something
877 // else, e.g. the DepIsInSameApex(...) method to decide that a variant is required.
878 if required, ok := depTag.(android.AlwaysRequireApexVariantTag); ok && required.AlwaysRequireApexVariant() {
879 return true
880 }
Paul Duffin4c3e8e22021-03-18 15:41:29 +0000881 if !android.IsDepInSameApex(mctx, parent, child) {
Jooyung Han698dd9f2020-07-22 15:17:19 +0900882 return false
883 }
Jooyung Handf78e212020-07-22 15:54:47 +0900884 if excludeVndkLibs {
885 if c, ok := child.(*cc.Module); ok && c.IsVndk() {
886 return false
887 }
888 }
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900889 // By default, all the transitive dependencies are collected, unless filtered out
890 // above.
Colin Cross56a83212020-09-15 18:30:11 -0700891 return true
892 }
893
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900894 // Records whether a certain module is included in this apexBundle via direct dependency or
895 // inndirect dependency.
896 contents := make(map[string]android.ApexMembership)
Colin Cross56a83212020-09-15 18:30:11 -0700897 mctx.WalkDeps(func(child, parent android.Module) bool {
898 if !continueApexDepsWalk(child, parent) {
899 return false
900 }
Jooyung Han698dd9f2020-07-22 15:17:19 +0900901 // If the parent is apexBundle, this child is directly depended.
902 _, directDep := parent.(*apexBundle)
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900903 depName := mctx.OtherModuleName(child)
Colin Cross56a83212020-09-15 18:30:11 -0700904 contents[depName] = contents[depName].Add(directDep)
905 return true
906 })
907
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900908 // The membership information is saved for later access
Jiyong Parke4758ed2020-11-18 01:34:22 +0900909 apexContents := android.NewApexContents(contents)
Colin Cross56a83212020-09-15 18:30:11 -0700910 mctx.SetProvider(ApexBundleInfoProvider, ApexBundleInfo{
911 Contents: apexContents,
912 })
913
Jooyung Haned124c32021-01-26 11:43:46 +0900914 minSdkVersion := a.minSdkVersion(mctx)
915 // When min_sdk_version is not set, the apex is built against FutureApiLevel.
916 if minSdkVersion.IsNone() {
917 minSdkVersion = android.FutureApiLevel
918 }
919
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900920 // This is the main part of this mutator. Mark the collected dependencies that they need to
921 // be built for this apexBundle.
Jiyong Park78349b52021-05-12 17:13:56 +0900922
Martin Stjernholmbfffae72021-06-24 14:37:13 +0100923 apexVariationName := proptools.StringDefault(a.properties.Apex_name, mctx.ModuleName()) // could be com.android.foo
924 a.properties.ApexVariationName = apexVariationName
Colin Cross56a83212020-09-15 18:30:11 -0700925 apexInfo := android.ApexInfo{
Martin Stjernholmbfffae72021-06-24 14:37:13 +0100926 ApexVariationName: apexVariationName,
Jiyong Park4eab21d2021-04-15 15:17:54 +0900927 MinSdkVersion: minSdkVersion,
Colin Cross56a83212020-09-15 18:30:11 -0700928 RequiredSdks: a.RequiredSdks(),
929 Updatable: a.Updatable(),
Jiyong Park1bc84122021-06-22 20:23:05 +0900930 UsePlatformApis: a.UsePlatformApis(),
Martin Stjernholmbfffae72021-06-24 14:37:13 +0100931 InApexVariants: []string{apexVariationName},
932 InApexModules: []string{a.Name()}, // could be com.mycompany.android.foo
Colin Cross56a83212020-09-15 18:30:11 -0700933 ApexContents: []*android.ApexContents{apexContents},
934 }
Colin Cross56a83212020-09-15 18:30:11 -0700935 mctx.WalkDeps(func(child, parent android.Module) bool {
936 if !continueApexDepsWalk(child, parent) {
937 return false
938 }
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900939 child.(android.ApexModule).BuildForApex(apexInfo) // leave a mark!
Jooyung Han698dd9f2020-07-22 15:17:19 +0900940 return true
Jiyong Parkf760cae2020-02-12 07:53:12 +0900941 })
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900942}
943
Paul Duffina7d6a892020-12-07 17:39:59 +0000944type ApexInfoMutator interface {
Martin Stjernholmbfffae72021-06-24 14:37:13 +0100945 // ApexVariationName returns the name of the APEX variation to use in the apex
946 // mutator etc. It is the same name as ApexInfo.ApexVariationName.
947 ApexVariationName() string
948
Paul Duffina7d6a892020-12-07 17:39:59 +0000949 // ApexInfoMutator implementations must call BuildForApex(ApexInfo) on any modules that are
950 // depended upon by an apex and which require an apex specific variant.
951 ApexInfoMutator(android.TopDownMutatorContext)
952}
953
954// apexInfoMutator delegates the work of identifying which modules need an ApexInfo and apex
955// specific variant to modules that support the ApexInfoMutator.
956func apexInfoMutator(mctx android.TopDownMutatorContext) {
957 if !mctx.Module().Enabled() {
958 return
959 }
960
961 if a, ok := mctx.Module().(ApexInfoMutator); ok {
962 a.ApexInfoMutator(mctx)
963 return
964 }
965}
966
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900967// apexUniqueVariationsMutator checks if any dependencies use unique apex variations. If so, use
968// unique apex variations for this module. See android/apex.go for more about unique apex variant.
969// TODO(jiyong): move this to android/apex.go?
Colin Crossaede88c2020-08-11 12:17:01 -0700970func apexUniqueVariationsMutator(mctx android.BottomUpMutatorContext) {
971 if !mctx.Module().Enabled() {
972 return
973 }
974 if am, ok := mctx.Module().(android.ApexModule); ok {
Colin Cross56a83212020-09-15 18:30:11 -0700975 android.UpdateUniqueApexVariationsForDeps(mctx, am)
976 }
977}
978
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900979// apexTestForDepsMutator checks if this module is a test for an apex. If so, add a dependency on
980// the apex in order to retrieve its contents later.
981// TODO(jiyong): move this to android/apex.go?
Colin Cross56a83212020-09-15 18:30:11 -0700982func apexTestForDepsMutator(mctx android.BottomUpMutatorContext) {
983 if !mctx.Module().Enabled() {
984 return
985 }
Colin Cross56a83212020-09-15 18:30:11 -0700986 if am, ok := mctx.Module().(android.ApexModule); ok {
987 if testFor := am.TestFor(); len(testFor) > 0 {
988 mctx.AddFarVariationDependencies([]blueprint.Variation{
989 {Mutator: "os", Variation: am.Target().OsVariation()},
990 {"arch", "common"},
991 }, testForTag, testFor...)
992 }
993 }
994}
995
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900996// TODO(jiyong): move this to android/apex.go?
Colin Cross56a83212020-09-15 18:30:11 -0700997func apexTestForMutator(mctx android.BottomUpMutatorContext) {
998 if !mctx.Module().Enabled() {
999 return
1000 }
Colin Cross56a83212020-09-15 18:30:11 -07001001 if _, ok := mctx.Module().(android.ApexModule); ok {
1002 var contents []*android.ApexContents
1003 for _, testFor := range mctx.GetDirectDepsWithTag(testForTag) {
1004 abInfo := mctx.OtherModuleProvider(testFor, ApexBundleInfoProvider).(ApexBundleInfo)
1005 contents = append(contents, abInfo.Contents)
1006 }
1007 mctx.SetProvider(android.ApexTestForInfoProvider, android.ApexTestForInfo{
1008 ApexContents: contents,
1009 })
Colin Crossaede88c2020-08-11 12:17:01 -07001010 }
1011}
1012
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001013// markPlatformAvailability marks whether or not a module can be available to platform. A module
1014// cannot be available to platform if 1) it is explicitly marked as not available (i.e.
1015// "//apex_available:platform" is absent) or 2) it depends on another module that isn't (or can't
1016// be) available to platform
1017// TODO(jiyong): move this to android/apex.go?
Jiyong Park89e850a2020-04-07 16:37:39 +09001018func markPlatformAvailability(mctx android.BottomUpMutatorContext) {
1019 // Host and recovery are not considered as platform
1020 if mctx.Host() || mctx.Module().InstallInRecovery() {
1021 return
1022 }
1023
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001024 am, ok := mctx.Module().(android.ApexModule)
1025 if !ok {
1026 return
1027 }
Jiyong Park89e850a2020-04-07 16:37:39 +09001028
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001029 availableToPlatform := am.AvailableFor(android.AvailableToPlatform)
Jiyong Park89e850a2020-04-07 16:37:39 +09001030
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001031 // If any of the dep is not available to platform, this module is also considered as being
1032 // not available to platform even if it has "//apex_available:platform"
1033 mctx.VisitDirectDeps(func(child android.Module) {
Paul Duffin4c3e8e22021-03-18 15:41:29 +00001034 if !android.IsDepInSameApex(mctx, am, child) {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001035 // if the dependency crosses apex boundary, don't consider it
1036 return
Jiyong Park89e850a2020-04-07 16:37:39 +09001037 }
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001038 if dep, ok := child.(android.ApexModule); ok && dep.NotAvailableForPlatform() {
1039 availableToPlatform = false
1040 // TODO(b/154889534) trigger an error when 'am' has
1041 // "//apex_available:platform"
Jiyong Park89e850a2020-04-07 16:37:39 +09001042 }
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001043 })
Jiyong Park89e850a2020-04-07 16:37:39 +09001044
Paul Duffinb5769c12021-05-12 16:16:51 +01001045 // Exception 1: check to see if the module always requires it.
1046 if am.AlwaysRequiresPlatformApexVariant() {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001047 availableToPlatform = true
1048 }
1049
1050 // Exception 2: bootstrap bionic libraries are also always available to platform
1051 if cc.InstallToBootstrap(mctx.ModuleName(), mctx.Config()) {
1052 availableToPlatform = true
1053 }
1054
1055 if !availableToPlatform {
1056 am.SetNotAvailableForPlatform()
Jiyong Park89e850a2020-04-07 16:37:39 +09001057 }
1058}
1059
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001060// apexMutator visits each module and creates apex variations if the module was marked in the
Paul Duffin949abc02020-12-08 10:34:30 +00001061// previous run of apexInfoMutator.
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001062func apexMutator(mctx android.BottomUpMutatorContext) {
Jooyung Han49f67012020-04-17 13:43:10 +09001063 if !mctx.Module().Enabled() {
1064 return
1065 }
Colin Cross56a83212020-09-15 18:30:11 -07001066
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001067 // This is the usual path.
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001068 if am, ok := mctx.Module().(android.ApexModule); ok && am.CanHaveApexVariants() {
Colin Cross56a83212020-09-15 18:30:11 -07001069 android.CreateApexVariations(mctx, am)
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001070 return
1071 }
1072
1073 // apexBundle itself is mutated so that it and its dependencies have the same apex variant.
Martin Stjernholmbfffae72021-06-24 14:37:13 +01001074 if ai, ok := mctx.Module().(ApexInfoMutator); ok && apexModuleTypeRequiresVariant(ai) {
1075 apexBundleName := ai.ApexVariationName()
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001076 mctx.CreateVariations(apexBundleName)
Martin Stjernholmec009002021-03-27 15:18:31 +00001077 if strings.HasPrefix(apexBundleName, "com.android.art") {
1078 // Create an alias from the platform variant. This is done to make
1079 // test_for dependencies work for modules that are split by the APEX
1080 // mutator, since test_for dependencies always go to the platform variant.
1081 // This doesn't happen for normal APEXes that are disjunct, so only do
1082 // this for the overlapping ART APEXes.
1083 // TODO(b/183882457): Remove this if the test_for functionality is
1084 // refactored to depend on the proper APEX variants instead of platform.
1085 mctx.CreateAliasVariation("", apexBundleName)
1086 }
Jiyong Park5d790c32019-11-15 18:40:32 +09001087 } else if o, ok := mctx.Module().(*OverrideApex); ok {
1088 apexBundleName := o.GetOverriddenModuleName()
1089 if apexBundleName == "" {
1090 mctx.ModuleErrorf("base property is not set")
1091 return
1092 }
1093 mctx.CreateVariations(apexBundleName)
Martin Stjernholmec009002021-03-27 15:18:31 +00001094 if strings.HasPrefix(apexBundleName, "com.android.art") {
1095 // TODO(b/183882457): See note for CreateAliasVariation above.
1096 mctx.CreateAliasVariation("", apexBundleName)
1097 }
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001098 }
1099}
Sundong Ahne9b55722019-09-06 17:37:42 +09001100
Paul Duffin6717d882021-06-15 19:09:41 +01001101// apexModuleTypeRequiresVariant determines whether the module supplied requires an apex specific
1102// variant.
Martin Stjernholmbfffae72021-06-24 14:37:13 +01001103func apexModuleTypeRequiresVariant(module ApexInfoMutator) bool {
Paul Duffin6717d882021-06-15 19:09:41 +01001104 if a, ok := module.(*apexBundle); ok {
Martin Stjernholmbfffae72021-06-24 14:37:13 +01001105 // TODO(jiyong): document the reason why the VNDK APEX is an exception here.
Paul Duffin6717d882021-06-15 19:09:41 +01001106 return !a.vndkApex
1107 }
1108
Martin Stjernholmbfffae72021-06-24 14:37:13 +01001109 return true
Paul Duffin6717d882021-06-15 19:09:41 +01001110}
1111
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001112// See android.UpdateDirectlyInAnyApex
1113// TODO(jiyong): move this to android/apex.go?
Colin Cross56a83212020-09-15 18:30:11 -07001114func apexDirectlyInAnyMutator(mctx android.BottomUpMutatorContext) {
1115 if !mctx.Module().Enabled() {
1116 return
1117 }
1118 if am, ok := mctx.Module().(android.ApexModule); ok {
1119 android.UpdateDirectlyInAnyApex(mctx, am)
1120 }
1121}
1122
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001123// apexPackaging represents a specific packaging method for an APEX.
Jiyong Park8e6d52f2020-11-19 14:37:47 +09001124type apexPackaging int
1125
1126const (
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001127 // imageApex is a packaging method where contents are included in a filesystem image which
1128 // is then included in a zip container. This is the most typical way of packaging.
Jiyong Park8e6d52f2020-11-19 14:37:47 +09001129 imageApex apexPackaging = iota
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001130
1131 // zipApex is a packaging method where contents are directly included in the zip container.
1132 // This is used for host-side testing - because the contents are easily accessible by
1133 // unzipping the container.
Jiyong Park8e6d52f2020-11-19 14:37:47 +09001134 zipApex
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001135
1136 // flattendApex is a packaging method where contents are not included in the APEX file, but
1137 // installed to /apex/<apexname> directory on the device. This packaging method is used for
1138 // old devices where the filesystem-based APEX file can't be supported.
Jiyong Park8e6d52f2020-11-19 14:37:47 +09001139 flattenedApex
1140)
1141
1142const (
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001143 // File extensions of an APEX for different packaging methods
Samiul Islam7c02e262021-09-08 17:48:28 +01001144 imageApexSuffix = ".apex"
1145 imageCapexSuffix = ".capex"
1146 zipApexSuffix = ".zipapex"
1147 flattenedSuffix = ".flattened"
Jiyong Park8e6d52f2020-11-19 14:37:47 +09001148
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001149 // variant names each of which is for a packaging method
Jiyong Park8e6d52f2020-11-19 14:37:47 +09001150 imageApexType = "image"
1151 zipApexType = "zip"
1152 flattenedApexType = "flattened"
1153
1154 ext4FsType = "ext4"
1155 f2fsFsType = "f2fs"
Huang Jianan13cac632021-08-02 15:02:17 +08001156 erofsFsType = "erofs"
Jiyong Park8e6d52f2020-11-19 14:37:47 +09001157)
1158
1159// The suffix for the output "file", not the module
1160func (a apexPackaging) suffix() string {
1161 switch a {
1162 case imageApex:
1163 return imageApexSuffix
1164 case zipApex:
1165 return zipApexSuffix
1166 default:
1167 panic(fmt.Errorf("unknown APEX type %d", a))
1168 }
1169}
1170
1171func (a apexPackaging) name() string {
1172 switch a {
1173 case imageApex:
1174 return imageApexType
1175 case zipApex:
1176 return zipApexType
1177 default:
1178 panic(fmt.Errorf("unknown APEX type %d", a))
1179 }
1180}
1181
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001182// apexFlattenedMutator creates one or more variations each of which is for a packaging method.
1183// TODO(jiyong): give a better name to this mutator
Sundong Ahne9b55722019-09-06 17:37:42 +09001184func apexFlattenedMutator(mctx android.BottomUpMutatorContext) {
Jooyung Han49f67012020-04-17 13:43:10 +09001185 if !mctx.Module().Enabled() {
1186 return
1187 }
Sundong Ahne8fb7242019-09-17 13:50:45 +09001188 if ab, ok := mctx.Module().(*apexBundle); ok {
Sundong Ahnabb64432019-10-22 13:58:29 +09001189 var variants []string
1190 switch proptools.StringDefault(ab.properties.Payload_type, "image") {
1191 case "image":
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001192 // This is the normal case. Note that both image and flattend APEXes are
1193 // created. The image type is installed to the system partition, while the
1194 // flattened APEX is (optionally) installed to the system_ext partition.
1195 // This is mostly for GSI which has to support wide range of devices. If GSI
1196 // is installed on a newer (APEX-capable) device, the image APEX in the
1197 // system will be used. However, if the same GSI is installed on an old
1198 // device which can't support image APEX, the flattened APEX in the
1199 // system_ext partion (which still is part of GSI) is used instead.
Sundong Ahnabb64432019-10-22 13:58:29 +09001200 variants = append(variants, imageApexType, flattenedApexType)
1201 case "zip":
1202 variants = append(variants, zipApexType)
1203 case "both":
1204 variants = append(variants, imageApexType, zipApexType, flattenedApexType)
1205 default:
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001206 mctx.PropertyErrorf("payload_type", "%q is not one of \"image\", \"zip\", or \"both\".", *ab.properties.Payload_type)
Sundong Ahnabb64432019-10-22 13:58:29 +09001207 return
1208 }
1209
1210 modules := mctx.CreateLocalVariations(variants...)
1211
1212 for i, v := range variants {
1213 switch v {
1214 case imageApexType:
1215 modules[i].(*apexBundle).properties.ApexType = imageApex
1216 case zipApexType:
1217 modules[i].(*apexBundle).properties.ApexType = zipApex
1218 case flattenedApexType:
1219 modules[i].(*apexBundle).properties.ApexType = flattenedApex
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001220 // See the comment above for why system_ext.
Jooyung Han91df2082019-11-20 01:49:42 +09001221 if !mctx.Config().FlattenApex() && ab.Platform() {
Sundong Ahnd95aa2d2019-10-08 19:34:03 +09001222 modules[i].(*apexBundle).MakeAsSystemExt()
1223 }
Sundong Ahnabb64432019-10-22 13:58:29 +09001224 }
Sundong Ahne9b55722019-09-06 17:37:42 +09001225 }
Jiyong Park5d790c32019-11-15 18:40:32 +09001226 } else if _, ok := mctx.Module().(*OverrideApex); ok {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001227 // payload_type is forcibly overridden to "image"
1228 // TODO(jiyong): is this the right decision?
Jiyong Park5d790c32019-11-15 18:40:32 +09001229 mctx.CreateVariations(imageApexType, flattenedApexType)
Sundong Ahne9b55722019-09-06 17:37:42 +09001230 }
1231}
1232
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001233var _ android.DepIsInSameApex = (*apexBundle)(nil)
Theotime Combes4ba38c12020-06-12 12:46:59 +00001234
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001235// Implements android.DepInInSameApex
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001236func (a *apexBundle) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1237 // direct deps of an APEX bundle are all part of the APEX bundle
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001238 // TODO(jiyong): shouldn't we look into the payload field of the dependencyTag?
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001239 return true
1240}
1241
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001242var _ android.OutputFileProducer = (*apexBundle)(nil)
1243
1244// Implements android.OutputFileProducer
1245func (a *apexBundle) OutputFiles(tag string) (android.Paths, error) {
1246 switch tag {
Paul Duffin74f05592020-11-25 16:37:46 +00001247 case "", android.DefaultDistTag:
1248 // This is the default dist path.
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001249 return android.Paths{a.outputFile}, nil
1250 default:
1251 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
1252 }
1253}
1254
1255var _ cc.Coverage = (*apexBundle)(nil)
1256
1257// Implements cc.Coverage
1258func (a *apexBundle) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool {
1259 return ctx.Device() && ctx.DeviceConfig().NativeCoverageEnabled()
1260}
1261
1262// Implements cc.Coverage
Ivan Lozanod7586b62021-04-01 09:49:36 -04001263func (a *apexBundle) SetPreventInstall() {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001264 a.properties.PreventInstall = true
1265}
1266
1267// Implements cc.Coverage
1268func (a *apexBundle) HideFromMake() {
1269 a.properties.HideFromMake = true
Colin Crosse6a83e62020-12-17 18:22:34 -08001270 // This HideFromMake is shadowing the ModuleBase one, call through to it for now.
1271 // TODO(ccross): untangle these
1272 a.ModuleBase.HideFromMake()
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001273}
1274
1275// Implements cc.Coverage
1276func (a *apexBundle) MarkAsCoverageVariant(coverage bool) {
1277 a.properties.IsCoverageVariant = coverage
1278}
1279
1280// Implements cc.Coverage
1281func (a *apexBundle) EnableCoverageIfNeeded() {}
1282
1283var _ android.ApexBundleDepsInfoIntf = (*apexBundle)(nil)
1284
1285// Implements android.ApexBudleDepsInfoIntf
1286func (a *apexBundle) Updatable() bool {
Mathew Inwoodf8dcf5e2021-02-16 11:40:16 +00001287 return proptools.BoolDefault(a.properties.Updatable, true)
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001288}
1289
Jiyong Park1bc84122021-06-22 20:23:05 +09001290func (a *apexBundle) UsePlatformApis() bool {
1291 return proptools.BoolDefault(a.properties.Platform_apis, false)
1292}
1293
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001294// getCertString returns the name of the cert that should be used to sign this APEX. This is
1295// basically from the "certificate" property, but could be overridden by the device config.
Colin Cross0ea8ba82019-06-06 14:33:29 -07001296func (a *apexBundle) getCertString(ctx android.BaseModuleContext) string {
Jooyung Han27151d92019-12-16 17:45:32 +09001297 moduleName := ctx.ModuleName()
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001298 // VNDK APEXes share the same certificate. To avoid adding a new VNDK version to the
1299 // OVERRIDE_* list, we check with the pseudo module name to see if its certificate is
1300 // overridden.
Jooyung Han27151d92019-12-16 17:45:32 +09001301 if a.vndkApex {
1302 moduleName = vndkApexName
1303 }
1304 certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(moduleName)
Jiyong Parkb2742fd2019-02-11 11:38:15 +09001305 if overridden {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001306 return ":" + certificate
Jiyong Parkb2742fd2019-02-11 11:38:15 +09001307 }
Jaewoong Jung4cfdf7d2021-04-20 16:21:24 -07001308 return String(a.overridableProperties.Certificate)
Jiyong Parkb2742fd2019-02-11 11:38:15 +09001309}
1310
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001311// See the installable property
Jiyong Park92c0f9c2018-12-13 23:14:57 +09001312func (a *apexBundle) installable() bool {
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001313 return !a.properties.PreventInstall && (a.properties.Installable == nil || proptools.Bool(a.properties.Installable))
Jiyong Park92c0f9c2018-12-13 23:14:57 +09001314}
1315
Nikita Ioffeda6dc312021-06-09 19:43:46 +01001316// See the generate_hashtree property
1317func (a *apexBundle) shouldGenerateHashtree() bool {
Nikita Ioffee261ae62021-06-16 18:15:03 +01001318 return proptools.BoolDefault(a.properties.Generate_hashtree, true)
Nikita Ioffec72b5dd2019-12-07 17:30:22 +00001319}
1320
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001321// See the test_only_unsigned_payload property
Dario Frenica913392020-04-27 18:21:11 +01001322func (a *apexBundle) testOnlyShouldSkipPayloadSign() bool {
1323 return proptools.Bool(a.properties.Test_only_unsigned_payload)
1324}
1325
Mohammad Samiul Islama8008f92020-12-22 10:47:50 +00001326// See the test_only_force_compression property
1327func (a *apexBundle) testOnlyShouldForceCompression() bool {
1328 return proptools.Bool(a.properties.Test_only_force_compression)
1329}
1330
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001331// These functions are interfacing with cc/sanitizer.go. The entire APEX (along with all of its
1332// members) can be sanitized, either forcibly, or by the global configuration. For some of the
1333// sanitizers, extra dependencies can be forcibly added as well.
Jiyong Parkda6eb592018-12-19 17:12:36 +09001334
Jiyong Parkf97782b2019-02-13 20:28:58 +09001335func (a *apexBundle) EnableSanitizer(sanitizerName string) {
1336 if !android.InList(sanitizerName, a.properties.SanitizerNames) {
1337 a.properties.SanitizerNames = append(a.properties.SanitizerNames, sanitizerName)
1338 }
1339}
1340
Jiyong Park388ef3f2019-01-28 19:47:32 +09001341func (a *apexBundle) IsSanitizerEnabled(ctx android.BaseModuleContext, sanitizerName string) bool {
Jiyong Parkf97782b2019-02-13 20:28:58 +09001342 if android.InList(sanitizerName, a.properties.SanitizerNames) {
1343 return true
Jiyong Park235e67c2019-02-09 11:50:56 +09001344 }
1345
1346 // Then follow the global setting
Jiyong Park388ef3f2019-01-28 19:47:32 +09001347 globalSanitizerNames := []string{}
1348 if a.Host() {
1349 globalSanitizerNames = ctx.Config().SanitizeHost()
1350 } else {
1351 arches := ctx.Config().SanitizeDeviceArch()
1352 if len(arches) == 0 || android.InList(a.Arch().ArchType.Name, arches) {
1353 globalSanitizerNames = ctx.Config().SanitizeDevice()
1354 }
1355 }
1356 return android.InList(sanitizerName, globalSanitizerNames)
Jiyong Park379de2f2018-12-19 02:47:14 +09001357}
1358
Jooyung Han8ce8db92020-05-15 19:05:05 +09001359func (a *apexBundle) AddSanitizerDependencies(ctx android.BottomUpMutatorContext, sanitizerName string) {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001360 // TODO(jiyong): move this info (the sanitizer name, the lib name, etc.) to cc/sanitize.go
1361 // Keep only the mechanism here.
Jooyung Han8ce8db92020-05-15 19:05:05 +09001362 if ctx.Device() && sanitizerName == "hwaddress" && strings.HasPrefix(a.Name(), "com.android.runtime") {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001363 imageVariation := a.getImageVariation(ctx)
Jooyung Han8ce8db92020-05-15 19:05:05 +09001364 for _, target := range ctx.MultiTargets() {
1365 if target.Arch.ArchType.Multilib == "lib64" {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001366 addDependenciesForNativeModules(ctx, ApexNativeDependencies{
1367 Native_shared_libs: []string{"libclang_rt.hwasan-aarch64-android"},
1368 Tests: nil,
1369 Jni_libs: nil,
1370 Binaries: nil,
1371 }, target, imageVariation)
Jooyung Han8ce8db92020-05-15 19:05:05 +09001372 break
1373 }
1374 }
1375 }
1376}
1377
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001378// apexFileFor<Type> functions below create an apexFile struct for a given Soong module. The
1379// returned apexFile saves information about the Soong module that will be used for creating the
1380// build rules.
Jiyong Park1833cef2019-12-13 13:28:36 +09001381func apexFileForNativeLibrary(ctx android.BaseModuleContext, ccMod *cc.Module, handleSpecialLibs bool) apexFile {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001382 // Decide the APEX-local directory by the multilib of the library In the future, we may
1383 // query this to the module.
1384 // TODO(jiyong): use the new PackagingSpec
Jiyong Parkf653b052019-11-18 15:39:01 +09001385 var dirInApex string
Martin Stjernholm279de572019-09-10 23:18:20 +01001386 switch ccMod.Arch().ArchType.Multilib {
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001387 case "lib32":
1388 dirInApex = "lib"
1389 case "lib64":
1390 dirInApex = "lib64"
1391 }
Colin Cross3b19f5d2019-09-17 14:45:31 -07001392 if ccMod.Target().NativeBridge == android.NativeBridgeEnabled {
Martin Stjernholm279de572019-09-10 23:18:20 +01001393 dirInApex = filepath.Join(dirInApex, ccMod.Target().NativeBridgeRelativePath)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001394 }
Jooyung Han35155c42020-02-06 17:33:20 +09001395 dirInApex = filepath.Join(dirInApex, ccMod.RelativeInstallPath())
Jiyong Park1833cef2019-12-13 13:28:36 +09001396 if handleSpecialLibs && cc.InstallToBootstrap(ccMod.BaseModuleName(), ctx.Config()) {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001397 // Special case for Bionic libs and other libs installed with them. This is to
1398 // prevent those libs from being included in the search path
1399 // /apex/com.android.runtime/${LIB}. This exclusion is required because those libs
1400 // in the Runtime APEX are available via the legacy paths in /system/lib/. By the
1401 // init process, the libs in the APEX are bind-mounted to the legacy paths and thus
1402 // will be loaded into the default linker namespace (aka "platform" namespace). If
1403 // the libs are directly in /apex/com.android.runtime/${LIB} then the same libs will
1404 // be loaded again into the runtime linker namespace, which will result in double
1405 // loading of them, which isn't supported.
Martin Stjernholm279de572019-09-10 23:18:20 +01001406 dirInApex = filepath.Join(dirInApex, "bionic")
Jiyong Parkb0788572018-12-20 22:10:17 +09001407 }
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001408
Jiyong Parkf653b052019-11-18 15:39:01 +09001409 fileToCopy := ccMod.OutputFile().Path()
Yo Chiange8128052020-07-23 20:09:18 +08001410 androidMkModuleName := ccMod.BaseModuleName() + ccMod.Properties.SubName
1411 return newApexFile(ctx, fileToCopy, androidMkModuleName, dirInApex, nativeSharedLib, ccMod)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001412}
1413
Jiyong Park1833cef2019-12-13 13:28:36 +09001414func apexFileForExecutable(ctx android.BaseModuleContext, cc *cc.Module) apexFile {
Jooyung Han35155c42020-02-06 17:33:20 +09001415 dirInApex := "bin"
Colin Cross3b19f5d2019-09-17 14:45:31 -07001416 if cc.Target().NativeBridge == android.NativeBridgeEnabled {
dimitry8d6dde82019-07-11 10:23:53 +02001417 dirInApex = filepath.Join(dirInApex, cc.Target().NativeBridgeRelativePath)
Jiyong Parkacbf6c72019-07-09 16:19:16 +09001418 }
Jooyung Han35155c42020-02-06 17:33:20 +09001419 dirInApex = filepath.Join(dirInApex, cc.RelativeInstallPath())
Jiyong Parkf653b052019-11-18 15:39:01 +09001420 fileToCopy := cc.OutputFile().Path()
Yo Chiange8128052020-07-23 20:09:18 +08001421 androidMkModuleName := cc.BaseModuleName() + cc.Properties.SubName
1422 af := newApexFile(ctx, fileToCopy, androidMkModuleName, dirInApex, nativeExecutable, cc)
Jiyong Parkf653b052019-11-18 15:39:01 +09001423 af.symlinks = cc.Symlinks()
Liz Kammer1c14a212020-05-12 15:26:55 -07001424 af.dataPaths = cc.DataPaths()
Jiyong Parkf653b052019-11-18 15:39:01 +09001425 return af
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001426}
1427
Jiyong Park99644e92020-11-17 22:21:02 +09001428func apexFileForRustExecutable(ctx android.BaseModuleContext, rustm *rust.Module) apexFile {
1429 dirInApex := "bin"
1430 if rustm.Target().NativeBridge == android.NativeBridgeEnabled {
1431 dirInApex = filepath.Join(dirInApex, rustm.Target().NativeBridgeRelativePath)
1432 }
1433 fileToCopy := rustm.OutputFile().Path()
1434 androidMkModuleName := rustm.BaseModuleName() + rustm.Properties.SubName
1435 af := newApexFile(ctx, fileToCopy, androidMkModuleName, dirInApex, nativeExecutable, rustm)
1436 return af
1437}
1438
1439func apexFileForRustLibrary(ctx android.BaseModuleContext, rustm *rust.Module) apexFile {
1440 // Decide the APEX-local directory by the multilib of the library
1441 // In the future, we may query this to the module.
1442 var dirInApex string
1443 switch rustm.Arch().ArchType.Multilib {
1444 case "lib32":
1445 dirInApex = "lib"
1446 case "lib64":
1447 dirInApex = "lib64"
1448 }
1449 if rustm.Target().NativeBridge == android.NativeBridgeEnabled {
1450 dirInApex = filepath.Join(dirInApex, rustm.Target().NativeBridgeRelativePath)
1451 }
1452 fileToCopy := rustm.OutputFile().Path()
1453 androidMkModuleName := rustm.BaseModuleName() + rustm.Properties.SubName
1454 return newApexFile(ctx, fileToCopy, androidMkModuleName, dirInApex, nativeSharedLib, rustm)
1455}
1456
Jiyong Park1833cef2019-12-13 13:28:36 +09001457func apexFileForPyBinary(ctx android.BaseModuleContext, py *python.Module) apexFile {
Jiyong Parkf653b052019-11-18 15:39:01 +09001458 dirInApex := "bin"
1459 fileToCopy := py.HostToolPath().Path()
Yo Chiange8128052020-07-23 20:09:18 +08001460 return newApexFile(ctx, fileToCopy, py.BaseModuleName(), dirInApex, pyBinary, py)
Alex Light778127a2019-02-27 14:19:50 -08001461}
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001462
Jiyong Park1833cef2019-12-13 13:28:36 +09001463func apexFileForGoBinary(ctx android.BaseModuleContext, depName string, gb bootstrap.GoBinaryTool) apexFile {
Jiyong Parkf653b052019-11-18 15:39:01 +09001464 dirInApex := "bin"
Alex Light778127a2019-02-27 14:19:50 -08001465 s, err := filepath.Rel(android.PathForOutput(ctx).String(), gb.InstallPath())
1466 if err != nil {
1467 ctx.ModuleErrorf("Unable to use compiled binary at %s", gb.InstallPath())
Jiyong Parkf653b052019-11-18 15:39:01 +09001468 return apexFile{}
Alex Light778127a2019-02-27 14:19:50 -08001469 }
Jiyong Parkf653b052019-11-18 15:39:01 +09001470 fileToCopy := android.PathForOutput(ctx, s)
1471 // NB: Since go binaries are static we don't need the module for anything here, which is
1472 // good since the go tool is a blueprint.Module not an android.Module like we would
1473 // normally use.
Jiyong Park1833cef2019-12-13 13:28:36 +09001474 return newApexFile(ctx, fileToCopy, depName, dirInApex, goBinary, nil)
Alex Light778127a2019-02-27 14:19:50 -08001475}
1476
Jaewoong Jung4b79e982020-06-01 10:45:49 -07001477func apexFileForShBinary(ctx android.BaseModuleContext, sh *sh.ShBinary) apexFile {
Jiyong Parkf653b052019-11-18 15:39:01 +09001478 dirInApex := filepath.Join("bin", sh.SubDir())
1479 fileToCopy := sh.OutputFile()
Yo Chiange8128052020-07-23 20:09:18 +08001480 af := newApexFile(ctx, fileToCopy, sh.BaseModuleName(), dirInApex, shBinary, sh)
Jiyong Parkf653b052019-11-18 15:39:01 +09001481 af.symlinks = sh.Symlinks()
1482 return af
Jiyong Park04480cf2019-02-06 00:16:29 +09001483}
1484
Jaewoong Jung4b79e982020-06-01 10:45:49 -07001485func apexFileForPrebuiltEtc(ctx android.BaseModuleContext, prebuilt prebuilt_etc.PrebuiltEtcModule, depName string) apexFile {
Jooyung Han0703fd82020-08-26 22:11:53 +09001486 dirInApex := filepath.Join(prebuilt.BaseDir(), prebuilt.SubDir())
Jiyong Parkf653b052019-11-18 15:39:01 +09001487 fileToCopy := prebuilt.OutputFile()
Jiyong Park1833cef2019-12-13 13:28:36 +09001488 return newApexFile(ctx, fileToCopy, depName, dirInApex, etc, prebuilt)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001489}
1490
atrost6e126252020-01-27 17:01:16 +00001491func apexFileForCompatConfig(ctx android.BaseModuleContext, config java.PlatformCompatConfigIntf, depName string) apexFile {
1492 dirInApex := filepath.Join("etc", config.SubDir())
1493 fileToCopy := config.CompatConfig()
1494 return newApexFile(ctx, fileToCopy, depName, dirInApex, etc, config)
1495}
1496
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001497// javaModule is an interface to handle all Java modules (java_library, dex_import, etc) in the same
1498// way.
1499type javaModule interface {
1500 android.Module
1501 BaseModuleName() string
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001502 DexJarBuildPath() java.OptionalDexJarPath
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001503 JacocoReportClassesFile() android.Path
1504 LintDepSets() java.LintDepSets
1505 Stem() string
1506}
1507
1508var _ javaModule = (*java.Library)(nil)
Bill Peckhama41a6962021-01-11 10:58:54 -08001509var _ javaModule = (*java.Import)(nil)
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001510var _ javaModule = (*java.SdkLibrary)(nil)
1511var _ javaModule = (*java.DexImport)(nil)
1512var _ javaModule = (*java.SdkLibraryImport)(nil)
1513
Paul Duffin190fdef2021-04-26 10:33:59 +01001514// apexFileForJavaModule creates an apexFile for a java module's dex implementation jar.
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001515func apexFileForJavaModule(ctx android.BaseModuleContext, module javaModule) apexFile {
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001516 return apexFileForJavaModuleWithFile(ctx, module, module.DexJarBuildPath().PathOrNil())
Paul Duffin190fdef2021-04-26 10:33:59 +01001517}
1518
1519// apexFileForJavaModuleWithFile creates an apexFile for a java module with the supplied file.
1520func apexFileForJavaModuleWithFile(ctx android.BaseModuleContext, module javaModule, dexImplementationJar android.Path) apexFile {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001521 dirInApex := "javalib"
Paul Duffin190fdef2021-04-26 10:33:59 +01001522 af := newApexFile(ctx, dexImplementationJar, module.BaseModuleName(), dirInApex, javaSharedLib, module)
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001523 af.jacocoReportClassesFile = module.JacocoReportClassesFile()
1524 af.lintDepSets = module.LintDepSets()
1525 af.customStem = module.Stem() + ".jar"
Jiakai Zhang519c5c82021-09-16 06:15:39 +00001526 if dexpreopter, ok := module.(java.DexpreopterInterface); ok {
1527 for _, install := range dexpreopter.DexpreoptBuiltInstalledForApex() {
1528 af.requiredModuleNames = append(af.requiredModuleNames, install.FullModuleName())
1529 }
1530 }
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001531 return af
1532}
1533
1534// androidApp is an interface to handle all app modules (android_app, android_app_import, etc.) in
1535// the same way.
1536type androidApp interface {
Jiyong Parkf653b052019-11-18 15:39:01 +09001537 android.Module
1538 Privileged() bool
Jooyung Han39ee1192020-03-23 20:21:11 +09001539 InstallApkName() string
Jiyong Parkf653b052019-11-18 15:39:01 +09001540 OutputFile() android.Path
Jiyong Park618922e2020-01-08 13:35:43 +09001541 JacocoReportClassesFile() android.Path
Colin Cross503c1d02020-01-28 14:00:53 -08001542 Certificate() java.Certificate
Yo Chiange8128052020-07-23 20:09:18 +08001543 BaseModuleName() string
Colin Cross8355c152021-08-10 19:24:07 -07001544 LintDepSets() java.LintDepSets
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001545}
1546
1547var _ androidApp = (*java.AndroidApp)(nil)
1548var _ androidApp = (*java.AndroidAppImport)(nil)
1549
1550func apexFileForAndroidApp(ctx android.BaseModuleContext, aapp androidApp) apexFile {
Jiyong Parkf7487312019-10-17 12:54:30 +09001551 appDir := "app"
Jiyong Parkf653b052019-11-18 15:39:01 +09001552 if aapp.Privileged() {
Jiyong Parkf7487312019-10-17 12:54:30 +09001553 appDir = "priv-app"
1554 }
Jooyung Han39ee1192020-03-23 20:21:11 +09001555 dirInApex := filepath.Join(appDir, aapp.InstallApkName())
Jiyong Parkf653b052019-11-18 15:39:01 +09001556 fileToCopy := aapp.OutputFile()
Yo Chiange8128052020-07-23 20:09:18 +08001557 af := newApexFile(ctx, fileToCopy, aapp.BaseModuleName(), dirInApex, app, aapp)
Jiyong Park618922e2020-01-08 13:35:43 +09001558 af.jacocoReportClassesFile = aapp.JacocoReportClassesFile()
Colin Cross8355c152021-08-10 19:24:07 -07001559 af.lintDepSets = aapp.LintDepSets()
Colin Cross503c1d02020-01-28 14:00:53 -08001560 af.certificate = aapp.Certificate()
Jiyong Parkcfaa1642020-02-28 16:51:07 +09001561
1562 if app, ok := aapp.(interface {
1563 OverriddenManifestPackageName() string
1564 }); ok {
1565 af.overriddenPackageName = app.OverriddenManifestPackageName()
1566 }
Jiyong Park618922e2020-01-08 13:35:43 +09001567 return af
Dario Frenicde2a032019-10-27 00:29:22 +01001568}
1569
Jiyong Park69aeba92020-04-24 21:16:36 +09001570func apexFileForRuntimeResourceOverlay(ctx android.BaseModuleContext, rro java.RuntimeResourceOverlayModule) apexFile {
1571 rroDir := "overlay"
1572 dirInApex := filepath.Join(rroDir, rro.Theme())
1573 fileToCopy := rro.OutputFile()
1574 af := newApexFile(ctx, fileToCopy, rro.Name(), dirInApex, app, rro)
1575 af.certificate = rro.Certificate()
1576
1577 if a, ok := rro.(interface {
1578 OverriddenManifestPackageName() string
1579 }); ok {
1580 af.overriddenPackageName = a.OverriddenManifestPackageName()
1581 }
1582 return af
1583}
1584
markchien2f59ec92020-09-02 16:23:38 +08001585func apexFileForBpfProgram(ctx android.BaseModuleContext, builtFile android.Path, bpfProgram bpf.BpfModule) apexFile {
1586 dirInApex := filepath.Join("etc", "bpf")
1587 return newApexFile(ctx, builtFile, builtFile.Base(), dirInApex, etc, bpfProgram)
1588}
1589
Jiyong Park12a719c2021-01-07 15:31:24 +09001590func apexFileForFilesystem(ctx android.BaseModuleContext, buildFile android.Path, fs filesystem.Filesystem) apexFile {
1591 dirInApex := filepath.Join("etc", "fs")
1592 return newApexFile(ctx, buildFile, buildFile.Base(), dirInApex, etc, fs)
1593}
1594
Paul Duffin064b70c2020-11-02 17:32:38 +00001595// WalkPayloadDeps visits dependencies that contributes to the payload of this APEX. For each of the
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001596// visited module, the `do` callback is executed. Returning true in the callback continues the visit
1597// to the child modules. Returning false makes the visit to continue in the sibling or the parent
1598// modules. This is used in check* functions below.
Jooyung Han749dc692020-04-15 11:03:39 +09001599func (a *apexBundle) WalkPayloadDeps(ctx android.ModuleContext, do android.PayloadDepsCallback) {
Paul Duffindf915ff2020-03-30 17:58:21 +01001600 ctx.WalkDeps(func(child, parent android.Module) bool {
Jiyong Park0f80c182020-01-31 02:49:53 +09001601 am, ok := child.(android.ApexModule)
1602 if !ok || !am.CanHaveApexVariants() {
1603 return false
1604 }
1605
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001606 // Filter-out unwanted depedendencies
1607 depTag := ctx.OtherModuleDependencyTag(child)
1608 if _, ok := depTag.(android.ExcludeFromApexContentsTag); ok {
1609 return false
1610 }
1611 if dt, ok := depTag.(dependencyTag); ok && !dt.payload {
Martin Stjernholm58c33f02020-07-06 22:56:01 +01001612 return false
1613 }
1614
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001615 ai := ctx.OtherModuleProvider(child, android.ApexInfoProvider).(android.ApexInfo)
Jiyong Parkab50b072021-05-12 17:13:56 +09001616 externalDep := !android.InList(ctx.ModuleName(), ai.InApexVariants)
Jiyong Park0f80c182020-01-31 02:49:53 +09001617
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001618 // Visit actually
1619 return do(ctx, parent, am, externalDep)
Jiyong Park0f80c182020-01-31 02:49:53 +09001620 })
1621}
1622
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001623// filesystem type of the apex_payload.img inside the APEX. Currently, ext4 and f2fs are supported.
1624type fsType int
Jooyung Han03b51852020-02-26 22:45:42 +09001625
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001626const (
1627 ext4 fsType = iota
1628 f2fs
Huang Jianan13cac632021-08-02 15:02:17 +08001629 erofs
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001630)
Artur Satayev849f8442020-04-28 14:57:42 +01001631
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001632func (f fsType) string() string {
1633 switch f {
1634 case ext4:
1635 return ext4FsType
1636 case f2fs:
1637 return f2fsFsType
Huang Jianan13cac632021-08-02 15:02:17 +08001638 case erofs:
1639 return erofsFsType
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001640 default:
1641 panic(fmt.Errorf("unknown APEX payload type %d", f))
Jooyung Han548640b2020-04-27 12:10:30 +09001642 }
1643}
1644
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001645// Creates build rules for an APEX. It consists of the following major steps:
1646//
1647// 1) do some validity checks such as apex_available, min_sdk_version, etc.
1648// 2) traverse the dependency tree to collect apexFile structs from them.
1649// 3) some fields in apexBundle struct are configured
1650// 4) generate the build rules to create the APEX. This is mostly done in builder.go.
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001651func (a *apexBundle) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001652 ////////////////////////////////////////////////////////////////////////////////////////////
1653 // 1) do some validity checks such as apex_available, min_sdk_version, etc.
Jiyong Park0f80c182020-01-31 02:49:53 +09001654 a.checkApexAvailability(ctx)
Jooyung Han548640b2020-04-27 12:10:30 +09001655 a.checkUpdatable(ctx)
Jooyung Han749dc692020-04-15 11:03:39 +09001656 a.checkMinSdkVersion(ctx)
Jiyong Park7d95a512020-05-10 15:16:24 +09001657 a.checkStaticLinkingToStubLibraries(ctx)
Jiyong Park192600a2021-08-03 07:52:17 +00001658 a.checkStaticExecutables(ctx)
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001659 if len(a.properties.Tests) > 0 && !a.testApex {
1660 ctx.PropertyErrorf("tests", "property allowed only in apex_test module type")
1661 return
1662 }
Jiyong Park678c8812020-02-07 17:25:49 +09001663
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001664 ////////////////////////////////////////////////////////////////////////////////////////////
1665 // 2) traverse the dependency tree to collect apexFile structs from them.
1666
1667 // all the files that will be included in this APEX
1668 var filesInfo []apexFile
Alex Lightfc0bd7c2019-01-29 18:31:59 -08001669
Jooyung Hane1633032019-08-01 17:41:43 +09001670 // native lib dependencies
1671 var provideNativeLibs []string
1672 var requireNativeLibs []string
1673
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001674 handleSpecialLibs := !android.Bool(a.properties.Ignore_system_library_special_case)
1675
braleeb0c1f0c2021-06-07 22:49:13 +08001676 // Collect the module directory for IDE info in java/jdeps.go.
1677 a.modulePaths = append(a.modulePaths, ctx.ModuleDir())
1678
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001679 // TODO(jiyong): do this using WalkPayloadDeps
1680 // TODO(jiyong): make this clean!!!
Alex Light778127a2019-02-27 14:19:50 -08001681 ctx.WalkDepsBlueprint(func(child, parent blueprint.Module) bool {
Roland Levillainf89cd092019-07-29 16:22:59 +01001682 depTag := ctx.OtherModuleDependencyTag(child)
Paul Duffindddd5462020-04-07 15:25:44 +01001683 if _, ok := depTag.(android.ExcludeFromApexContentsTag); ok {
1684 return false
1685 }
Roland Levillainf89cd092019-07-29 16:22:59 +01001686 depName := ctx.OtherModuleName(child)
Jiyong Parkf653b052019-11-18 15:39:01 +09001687 if _, isDirectDep := parent.(*apexBundle); isDirectDep {
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001688 switch depTag {
Jooyung Han643adc42020-02-27 13:50:06 +09001689 case sharedLibTag, jniLibTag:
1690 isJniLib := depTag == jniLibTag
Jooyung Hanfaa2d5f2020-02-06 17:42:40 +09001691 if c, ok := child.(*cc.Module); ok {
Jooyung Han643adc42020-02-27 13:50:06 +09001692 fi := apexFileForNativeLibrary(ctx, c, handleSpecialLibs)
1693 fi.isJniLib = isJniLib
1694 filesInfo = append(filesInfo, fi)
Jooyung Han45a96772020-06-15 14:59:42 +09001695 // Collect the list of stub-providing libs except:
1696 // - VNDK libs are only for vendors
1697 // - bootstrap bionic libs are treated as provided by system
1698 if c.HasStubsVariants() && !a.vndkApex && !cc.InstallToBootstrap(c.BaseModuleName(), ctx.Config()) {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001699 provideNativeLibs = append(provideNativeLibs, fi.stem())
Jiyong Parkf1493cc2020-05-29 21:29:20 +09001700 }
Jiyong Parkf653b052019-11-18 15:39:01 +09001701 return true // track transitive dependencies
Jiyong Parkf2cc1b72020-12-09 00:20:45 +09001702 } else if r, ok := child.(*rust.Module); ok {
1703 fi := apexFileForRustLibrary(ctx, r)
1704 filesInfo = append(filesInfo, fi)
Jiyong Parkff1458f2018-10-12 21:49:38 +09001705 } else {
Jooyung Han643adc42020-02-27 13:50:06 +09001706 propertyName := "native_shared_libs"
1707 if isJniLib {
1708 propertyName = "jni_libs"
1709 }
1710 ctx.PropertyErrorf(propertyName, "%q is not a cc_library or cc_library_shared module", depName)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001711 }
1712 case executableTag:
1713 if cc, ok := child.(*cc.Module); ok {
Jiyong Park1833cef2019-12-13 13:28:36 +09001714 filesInfo = append(filesInfo, apexFileForExecutable(ctx, cc))
Jiyong Parkf653b052019-11-18 15:39:01 +09001715 return true // track transitive dependencies
Jaewoong Jung4b79e982020-06-01 10:45:49 -07001716 } else if sh, ok := child.(*sh.ShBinary); ok {
Jiyong Park1833cef2019-12-13 13:28:36 +09001717 filesInfo = append(filesInfo, apexFileForShBinary(ctx, sh))
Alex Light778127a2019-02-27 14:19:50 -08001718 } else if py, ok := child.(*python.Module); ok && py.HostToolPath().Valid() {
Jiyong Park1833cef2019-12-13 13:28:36 +09001719 filesInfo = append(filesInfo, apexFileForPyBinary(ctx, py))
Alex Light778127a2019-02-27 14:19:50 -08001720 } else if gb, ok := child.(bootstrap.GoBinaryTool); ok && a.Host() {
Jiyong Parkf653b052019-11-18 15:39:01 +09001721 filesInfo = append(filesInfo, apexFileForGoBinary(ctx, depName, gb))
Jiyong Park99644e92020-11-17 22:21:02 +09001722 } else if rust, ok := child.(*rust.Module); ok {
1723 filesInfo = append(filesInfo, apexFileForRustExecutable(ctx, rust))
1724 return true // track transitive dependencies
Jiyong Parkff1458f2018-10-12 21:49:38 +09001725 } else {
Jiyong Park99644e92020-11-17 22:21:02 +09001726 ctx.PropertyErrorf("binaries", "%q is neither cc_binary, rust_binary, (embedded) py_binary, (host) blueprint_go_binary, (host) bootstrap_go_binary, nor sh_binary", depName)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001727 }
Paul Duffin94f19632021-04-20 12:40:07 +01001728 case bcpfTag:
Paul Duffina1d60252021-01-21 18:13:43 +00001729 {
Paul Duffin7771eba2021-04-23 14:25:28 +01001730 if _, ok := child.(*java.BootclasspathFragmentModule); !ok {
Paul Duffincc33ec82021-04-25 23:14:55 +01001731 ctx.PropertyErrorf("bootclasspath_fragments", "%q is not a bootclasspath_fragment module", depName)
Paul Duffina1d60252021-01-21 18:13:43 +00001732 return false
1733 }
Paul Duffin4d101b62021-03-24 15:42:20 +00001734
Paul Duffincc33ec82021-04-25 23:14:55 +01001735 filesToAdd := apexBootclasspathFragmentFiles(ctx, child)
1736 filesInfo = append(filesInfo, filesToAdd...)
Paul Duffin4d101b62021-03-24 15:42:20 +00001737 return true
Paul Duffina1d60252021-01-21 18:13:43 +00001738 }
satayev333a1732021-05-17 21:35:26 +01001739 case sscpfTag:
1740 {
1741 if _, ok := child.(*java.SystemServerClasspathModule); !ok {
1742 ctx.PropertyErrorf("systemserverclasspath_fragments", "%q is not a systemserverclasspath_fragment module", depName)
1743 return false
1744 }
satayevb98371c2021-06-15 16:49:50 +01001745 if af := apexClasspathFragmentProtoFile(ctx, child); af != nil {
1746 filesInfo = append(filesInfo, *af)
1747 }
satayev333a1732021-05-17 21:35:26 +01001748 return true
1749 }
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001750 case javaLibTag:
Jiyong Park77acec62020-06-01 21:39:15 +09001751 switch child.(type) {
Bill Peckhama41a6962021-01-11 10:58:54 -08001752 case *java.Library, *java.SdkLibrary, *java.DexImport, *java.SdkLibraryImport, *java.Import:
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001753 af := apexFileForJavaModule(ctx, child.(javaModule))
1754 if !af.ok() {
Jooyung Han58f26ab2019-12-18 15:34:32 +09001755 ctx.PropertyErrorf("java_libs", "%q is not configured to be compiled into dex", depName)
1756 return false
1757 }
1758 filesInfo = append(filesInfo, af)
Jooyung Han58f26ab2019-12-18 15:34:32 +09001759 return true // track transitive dependencies
Jiyong Park77acec62020-06-01 21:39:15 +09001760 default:
Jiyong Park9e6c2422019-08-09 20:39:45 +09001761 ctx.PropertyErrorf("java_libs", "%q of type %q is not supported", depName, ctx.OtherModuleType(child))
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001762 }
Jiyong Parkf653b052019-11-18 15:39:01 +09001763 case androidAppTag:
Jiyong Parkf653b052019-11-18 15:39:01 +09001764 if ap, ok := child.(*java.AndroidApp); ok {
Jooyung Han39ee1192020-03-23 20:21:11 +09001765 filesInfo = append(filesInfo, apexFileForAndroidApp(ctx, ap))
Jiyong Parkf653b052019-11-18 15:39:01 +09001766 return true // track transitive dependencies
1767 } else if ap, ok := child.(*java.AndroidAppImport); ok {
Jooyung Han39ee1192020-03-23 20:21:11 +09001768 filesInfo = append(filesInfo, apexFileForAndroidApp(ctx, ap))
Dario Freni6f3937c2019-12-20 22:58:03 +00001769 } else if ap, ok := child.(*java.AndroidTestHelperApp); ok {
Jooyung Han39ee1192020-03-23 20:21:11 +09001770 filesInfo = append(filesInfo, apexFileForAndroidApp(ctx, ap))
Sasha Smundak18d98bc2020-05-27 16:36:07 -07001771 } else if ap, ok := child.(*java.AndroidAppSet); ok {
1772 appDir := "app"
1773 if ap.Privileged() {
1774 appDir = "priv-app"
1775 }
Yo Chiange8128052020-07-23 20:09:18 +08001776 af := newApexFile(ctx, ap.OutputFile(), ap.BaseModuleName(),
Sasha Smundak18d98bc2020-05-27 16:36:07 -07001777 filepath.Join(appDir, ap.BaseModuleName()), appSet, ap)
1778 af.certificate = java.PresignedCertificate
1779 filesInfo = append(filesInfo, af)
Jiyong Parkf653b052019-11-18 15:39:01 +09001780 } else {
1781 ctx.PropertyErrorf("apps", "%q is not an android_app module", depName)
1782 }
Jiyong Park69aeba92020-04-24 21:16:36 +09001783 case rroTag:
1784 if rro, ok := child.(java.RuntimeResourceOverlayModule); ok {
1785 filesInfo = append(filesInfo, apexFileForRuntimeResourceOverlay(ctx, rro))
1786 } else {
1787 ctx.PropertyErrorf("rros", "%q is not an runtime_resource_overlay module", depName)
1788 }
markchien2f59ec92020-09-02 16:23:38 +08001789 case bpfTag:
1790 if bpfProgram, ok := child.(bpf.BpfModule); ok {
1791 filesToCopy, _ := bpfProgram.OutputFiles("")
1792 for _, bpfFile := range filesToCopy {
1793 filesInfo = append(filesInfo, apexFileForBpfProgram(ctx, bpfFile, bpfProgram))
1794 }
1795 } else {
1796 ctx.PropertyErrorf("bpfs", "%q is not a bpf module", depName)
1797 }
Jiyong Park12a719c2021-01-07 15:31:24 +09001798 case fsTag:
1799 if fs, ok := child.(filesystem.Filesystem); ok {
1800 filesInfo = append(filesInfo, apexFileForFilesystem(ctx, fs.OutputPath(), fs))
1801 } else {
1802 ctx.PropertyErrorf("filesystems", "%q is not a filesystem module", depName)
1803 }
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001804 case prebuiltTag:
Jaewoong Jung4b79e982020-06-01 10:45:49 -07001805 if prebuilt, ok := child.(prebuilt_etc.PrebuiltEtcModule); ok {
Jiyong Park1833cef2019-12-13 13:28:36 +09001806 filesInfo = append(filesInfo, apexFileForPrebuiltEtc(ctx, prebuilt, depName))
Jiyong Parkff1458f2018-10-12 21:49:38 +09001807 } else {
Paul Duffin1bc21dc2021-03-15 19:43:17 +00001808 ctx.PropertyErrorf("prebuilts", "%q is not a prebuilt_etc module", depName)
Jiyong Parkff1458f2018-10-12 21:49:38 +09001809 }
Paul Duffin0b817782021-03-17 15:02:19 +00001810 case compatConfigTag:
Paul Duffin3abc1742021-03-15 19:32:23 +00001811 if compatConfig, ok := child.(java.PlatformCompatConfigIntf); ok {
1812 filesInfo = append(filesInfo, apexFileForCompatConfig(ctx, compatConfig, depName))
1813 } else {
1814 ctx.PropertyErrorf("compat_configs", "%q is not a platform_compat_config module", depName)
1815 }
Roland Levillain630846d2019-06-26 12:48:34 +01001816 case testTag:
Roland Levillainf89cd092019-07-29 16:22:59 +01001817 if ccTest, ok := child.(*cc.Module); ok {
1818 if ccTest.IsTestPerSrcAllTestsVariation() {
1819 // Multiple-output test module (where `test_per_src: true`).
1820 //
1821 // `ccTest` is the "" ("all tests") variation of a `test_per_src` module.
1822 // We do not add this variation to `filesInfo`, as it has no output;
1823 // however, we do add the other variations of this module as indirect
1824 // dependencies (see below).
Roland Levillain9b5fde92019-06-28 15:41:19 +01001825 } else {
Roland Levillainf89cd092019-07-29 16:22:59 +01001826 // Single-output test module (where `test_per_src: false`).
Jiyong Park1833cef2019-12-13 13:28:36 +09001827 af := apexFileForExecutable(ctx, ccTest)
Jiyong Parkf653b052019-11-18 15:39:01 +09001828 af.class = nativeTest
1829 filesInfo = append(filesInfo, af)
Roland Levillain9b5fde92019-06-28 15:41:19 +01001830 }
Jiyong Parkaf9539f2020-05-04 10:31:32 +09001831 return true // track transitive dependencies
Roland Levillain630846d2019-06-26 12:48:34 +01001832 } else {
1833 ctx.PropertyErrorf("tests", "%q is not a cc module", depName)
1834 }
Jiyong Parkff1458f2018-10-12 21:49:38 +09001835 case keyTag:
1836 if key, ok := child.(*apexKey); ok {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001837 a.privateKeyFile = key.privateKeyFile
1838 a.publicKeyFile = key.publicKeyFile
Jiyong Parkff1458f2018-10-12 21:49:38 +09001839 } else {
1840 ctx.PropertyErrorf("key", "%q is not an apex_key module", depName)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001841 }
Jiyong Parkf653b052019-11-18 15:39:01 +09001842 return false
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001843 case certificateTag:
1844 if dep, ok := child.(*java.AndroidAppCertificate); ok {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001845 a.containerCertificateFile = dep.Certificate.Pem
1846 a.containerPrivateKeyFile = dep.Certificate.Key
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001847 } else {
1848 ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", depName)
1849 }
Jiyong Park03b68dd2019-07-26 23:20:40 +09001850 case android.PrebuiltDepTag:
1851 // If the prebuilt is force disabled, remember to delete the prebuilt file
1852 // that might have been installed in the previous builds
Jiyong Park10e926b2020-07-16 21:38:56 +09001853 if prebuilt, ok := child.(prebuilt); ok && prebuilt.isForceDisabled() {
Jiyong Park03b68dd2019-07-26 23:20:40 +09001854 a.prebuiltFileToDelete = prebuilt.InstallFilename()
1855 }
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001856 }
Jooyung Han8aee2042019-10-29 05:08:31 +09001857 } else if !a.vndkApex {
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001858 // indirect dependencies
Jooyung Han9c80bae2019-08-20 17:30:57 +09001859 if am, ok := child.(android.ApexModule); ok {
Roland Levillainf89cd092019-07-29 16:22:59 +01001860 // We cannot use a switch statement on `depTag` here as the checked
1861 // tags used below are private (e.g. `cc.sharedDepTag`).
Jiyong Park52cd06f2019-11-11 10:14:32 +09001862 if cc.IsSharedDepTag(depTag) || cc.IsRuntimeDepTag(depTag) {
Roland Levillainf89cd092019-07-29 16:22:59 +01001863 if cc, ok := child.(*cc.Module); ok {
Jooyung Handf78e212020-07-22 15:54:47 +09001864 if cc.UseVndk() && proptools.Bool(a.properties.Use_vndk_as_stable) && cc.IsVndk() {
Jooyung Han6c4cc9c2020-07-29 16:00:54 +09001865 requireNativeLibs = append(requireNativeLibs, ":vndk")
Jooyung Handf78e212020-07-22 15:54:47 +09001866 return false
1867 }
Jiyong Parkf1493cc2020-05-29 21:29:20 +09001868 af := apexFileForNativeLibrary(ctx, cc, handleSpecialLibs)
1869 af.transitiveDep = true
Martin Stjernholmf2635ec2020-12-16 01:01:59 +00001870
1871 // Always track transitive dependencies for host.
1872 if a.Host() {
1873 filesInfo = append(filesInfo, af)
1874 return true
1875 }
1876
Colin Cross56a83212020-09-15 18:30:11 -07001877 abInfo := ctx.Provider(ApexBundleInfoProvider).(ApexBundleInfo)
Martin Stjernholmf2635ec2020-12-16 01:01:59 +00001878 if !abInfo.Contents.DirectlyInApex(depName) && (cc.IsStubs() || cc.HasStubsVariants()) {
Roland Levillainf89cd092019-07-29 16:22:59 +01001879 // If the dependency is a stubs lib, don't include it in this APEX,
1880 // but make sure that the lib is installed on the device.
1881 // In case no APEX is having the lib, the lib is installed to the system
1882 // partition.
1883 //
1884 // Always include if we are a host-apex however since those won't have any
1885 // system libraries.
Colin Cross56a83212020-09-15 18:30:11 -07001886 if !am.DirectlyInAnyApex() {
Jooyung Hanefb184e2020-06-25 17:14:25 +09001887 // we need a module name for Make
Steven Moreland2c4000c2021-04-27 02:08:49 +00001888 name := cc.ImplementationModuleNameForMake(ctx) + cc.Properties.SubName
Jooyung Hanefb184e2020-06-25 17:14:25 +09001889 if !android.InList(name, a.requiredDeps) {
1890 a.requiredDeps = append(a.requiredDeps, name)
1891 }
Roland Levillainf89cd092019-07-29 16:22:59 +01001892 }
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001893 requireNativeLibs = append(requireNativeLibs, af.stem())
Roland Levillainf89cd092019-07-29 16:22:59 +01001894 // Don't track further
1895 return false
1896 }
Jiyong Parke3867542020-12-03 17:28:25 +09001897
1898 // If the dep is not considered to be in the same
1899 // apex, don't add it to filesInfo so that it is not
1900 // included in this APEX.
1901 // TODO(jiyong): move this to at the top of the
1902 // else-if clause for the indirect dependencies.
1903 // Currently, that's impossible because we would
1904 // like to record requiredNativeLibs even when
Martin Stjernholmf2635ec2020-12-16 01:01:59 +00001905 // DepIsInSameAPex is false. We also shouldn't do
1906 // this for host.
Paul Duffin4c3e8e22021-03-18 15:41:29 +00001907 //
1908 // TODO(jiyong): explain why the same module is passed in twice.
1909 // Switching the first am to parent breaks lots of tests.
1910 if !android.IsDepInSameApex(ctx, am, am) {
Jiyong Parke3867542020-12-03 17:28:25 +09001911 return false
1912 }
1913
Jiyong Parkf653b052019-11-18 15:39:01 +09001914 filesInfo = append(filesInfo, af)
1915 return true // track transitive dependencies
Jiyong Parkf2cc1b72020-12-09 00:20:45 +09001916 } else if rm, ok := child.(*rust.Module); ok {
1917 af := apexFileForRustLibrary(ctx, rm)
1918 af.transitiveDep = true
1919 filesInfo = append(filesInfo, af)
1920 return true // track transitive dependencies
Jiyong Park25fc6a92018-11-18 18:02:45 +09001921 }
Roland Levillainf89cd092019-07-29 16:22:59 +01001922 } else if cc.IsTestPerSrcDepTag(depTag) {
1923 if cc, ok := child.(*cc.Module); ok {
Jiyong Park1833cef2019-12-13 13:28:36 +09001924 af := apexFileForExecutable(ctx, cc)
Roland Levillainf89cd092019-07-29 16:22:59 +01001925 // Handle modules created as `test_per_src` variations of a single test module:
1926 // use the name of the generated test binary (`fileToCopy`) instead of the name
1927 // of the original test module (`depName`, shared by all `test_per_src`
1928 // variations of that module).
Yo Chiange8128052020-07-23 20:09:18 +08001929 af.androidMkModuleName = filepath.Base(af.builtFile.String())
Jiyong Park7cd10e32020-01-14 09:22:18 +09001930 // these are not considered transitive dep
1931 af.transitiveDep = false
Jiyong Parkf653b052019-11-18 15:39:01 +09001932 filesInfo = append(filesInfo, af)
1933 return true // track transitive dependencies
Roland Levillainf89cd092019-07-29 16:22:59 +01001934 }
Jiyong Park1ad8e162020-12-01 23:40:09 +09001935 } else if cc.IsHeaderDepTag(depTag) {
1936 // nothing
Jiyong Park52cd06f2019-11-11 10:14:32 +09001937 } else if java.IsJniDepTag(depTag) {
Jooyung Hanb7bebe22020-02-25 16:59:29 +09001938 // Because APK-in-APEX embeds jni_libs transitively, we don't need to track transitive deps
1939 return false
Jiyong Parke3833882020-02-17 17:28:10 +09001940 } else if java.IsXmlPermissionsFileDepTag(depTag) {
Jaewoong Jung4b79e982020-06-01 10:45:49 -07001941 if prebuilt, ok := child.(prebuilt_etc.PrebuiltEtcModule); ok {
Jiyong Parke3833882020-02-17 17:28:10 +09001942 filesInfo = append(filesInfo, apexFileForPrebuiltEtc(ctx, prebuilt, depName))
1943 }
Jiyong Park99644e92020-11-17 22:21:02 +09001944 } else if rust.IsDylibDepTag(depTag) {
1945 if rustm, ok := child.(*rust.Module); ok && rustm.IsInstallableToApex() {
1946 af := apexFileForRustLibrary(ctx, rustm)
1947 af.transitiveDep = true
1948 filesInfo = append(filesInfo, af)
1949 return true // track transitive dependencies
1950 }
Jiyong Park94e22fd2021-04-08 18:19:15 +09001951 } else if rust.IsRlibDepTag(depTag) {
1952 // Rlib is statically linked, but it might have shared lib
1953 // dependencies. Track them.
1954 return true
Paul Duffin65898052021-04-20 22:47:03 +01001955 } else if java.IsBootclasspathFragmentContentDepTag(depTag) {
Paul Duffin94f19632021-04-20 12:40:07 +01001956 // Add the contents of the bootclasspath fragment to the apex.
Paul Duffin4d101b62021-03-24 15:42:20 +00001957 switch child.(type) {
1958 case *java.Library, *java.SdkLibrary:
Paul Duffincc33ec82021-04-25 23:14:55 +01001959 javaModule := child.(javaModule)
Paul Duffin190fdef2021-04-26 10:33:59 +01001960 af := apexFileForBootclasspathFragmentContentModule(ctx, parent, javaModule)
Paul Duffin4d101b62021-03-24 15:42:20 +00001961 if !af.ok() {
Paul Duffin94f19632021-04-20 12:40:07 +01001962 ctx.PropertyErrorf("bootclasspath_fragments", "bootclasspath_fragment content %q is not configured to be compiled into dex", depName)
Paul Duffin4d101b62021-03-24 15:42:20 +00001963 return false
1964 }
1965 filesInfo = append(filesInfo, af)
1966 return true // track transitive dependencies
1967 default:
Paul Duffin94f19632021-04-20 12:40:07 +01001968 ctx.PropertyErrorf("bootclasspath_fragments", "bootclasspath_fragment content %q of type %q is not supported", depName, ctx.OtherModuleType(child))
Paul Duffin4d101b62021-03-24 15:42:20 +00001969 }
satayev333a1732021-05-17 21:35:26 +01001970 } else if java.IsSystemServerClasspathFragmentContentDepTag(depTag) {
1971 // Add the contents of the systemserverclasspath fragment to the apex.
1972 switch child.(type) {
1973 case *java.Library, *java.SdkLibrary:
1974 af := apexFileForJavaModule(ctx, child.(javaModule))
1975 filesInfo = append(filesInfo, af)
1976 return true // track transitive dependencies
1977 default:
1978 ctx.PropertyErrorf("systemserverclasspath_fragments", "systemserverclasspath_fragment content %q of type %q is not supported", depName, ctx.OtherModuleType(child))
1979 }
Colin Cross56a83212020-09-15 18:30:11 -07001980 } else if _, ok := depTag.(android.CopyDirectlyInAnyApexTag); ok {
1981 // nothing
Jooyung Han9c80bae2019-08-20 17:30:57 +09001982 } else if am.CanHaveApexVariants() && am.IsInstallableToApex() {
Jiyong Park1c7e9622020-05-07 16:12:13 +09001983 ctx.ModuleErrorf("unexpected tag %s for indirect dependency %q", android.PrettyPrintTag(depTag), depName)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001984 }
1985 }
1986 }
1987 return false
1988 })
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001989 if a.privateKeyFile == nil {
Jaewoong Jung4cfdf7d2021-04-20 16:21:24 -07001990 ctx.PropertyErrorf("key", "private_key for %q could not be found", String(a.overridableProperties.Key))
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001991 return
1992 }
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001993
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09001994 // Remove duplicates in filesInfo
Jiyong Park8fd61922018-11-08 02:50:25 +09001995 removeDup := func(filesInfo []apexFile) []apexFile {
Jiyong Park7cd10e32020-01-14 09:22:18 +09001996 encountered := make(map[string]apexFile)
Jiyong Park8fd61922018-11-08 02:50:25 +09001997 for _, f := range filesInfo {
Jooyung Han344d5432019-08-23 11:17:39 +09001998 dest := filepath.Join(f.installDir, f.builtFile.Base())
Jiyong Park7cd10e32020-01-14 09:22:18 +09001999 if e, ok := encountered[dest]; !ok {
2000 encountered[dest] = f
2001 } else {
2002 // If a module is directly included and also transitively depended on
2003 // consider it as directly included.
2004 e.transitiveDep = e.transitiveDep && f.transitiveDep
2005 encountered[dest] = e
Jiyong Park8fd61922018-11-08 02:50:25 +09002006 }
2007 }
Jiyong Park7cd10e32020-01-14 09:22:18 +09002008 var result []apexFile
2009 for _, v := range encountered {
2010 result = append(result, v)
2011 }
Jiyong Park8fd61922018-11-08 02:50:25 +09002012 return result
2013 }
2014 filesInfo = removeDup(filesInfo)
2015
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002016 // Sort to have consistent build rules
Jiyong Park8fd61922018-11-08 02:50:25 +09002017 sort.Slice(filesInfo, func(i, j int) bool {
Paul Duffin56060292021-05-15 19:34:05 +01002018 // Sort by destination path so as to ensure consistent ordering even if the source of the files
2019 // changes.
2020 return filesInfo[i].path() < filesInfo[j].path()
Jiyong Park8fd61922018-11-08 02:50:25 +09002021 })
2022
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002023 ////////////////////////////////////////////////////////////////////////////////////////////
2024 // 3) some fields in apexBundle struct are configured
Jiyong Park8fd61922018-11-08 02:50:25 +09002025 a.installDir = android.PathForModuleInstall(ctx, "apex")
2026 a.filesInfo = filesInfo
Alex Light5098a612018-11-29 17:12:15 -08002027
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002028 // Set suffix and primaryApexType depending on the ApexType
Martin Stjernholmcb3ff1e2021-05-25 00:28:27 +01002029 buildFlattenedAsDefault := ctx.Config().FlattenApex()
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002030 switch a.properties.ApexType {
2031 case imageApex:
2032 if buildFlattenedAsDefault {
2033 a.suffix = imageApexSuffix
2034 } else {
2035 a.suffix = ""
2036 a.primaryApexType = true
2037
2038 if ctx.Config().InstallExtraFlattenedApexes() {
2039 a.requiredDeps = append(a.requiredDeps, a.Name()+flattenedSuffix)
2040 }
2041 }
2042 case zipApex:
2043 if proptools.String(a.properties.Payload_type) == "zip" {
2044 a.suffix = ""
2045 a.primaryApexType = true
2046 } else {
2047 a.suffix = zipApexSuffix
2048 }
2049 case flattenedApex:
2050 if buildFlattenedAsDefault {
2051 a.suffix = ""
2052 a.primaryApexType = true
2053 } else {
2054 a.suffix = flattenedSuffix
2055 }
2056 }
2057
Theotime Combes4ba38c12020-06-12 12:46:59 +00002058 switch proptools.StringDefault(a.properties.Payload_fs_type, ext4FsType) {
2059 case ext4FsType:
2060 a.payloadFsType = ext4
2061 case f2fsFsType:
2062 a.payloadFsType = f2fs
Huang Jianan13cac632021-08-02 15:02:17 +08002063 case erofsFsType:
2064 a.payloadFsType = erofs
Theotime Combes4ba38c12020-06-12 12:46:59 +00002065 default:
Huang Jianan13cac632021-08-02 15:02:17 +08002066 ctx.PropertyErrorf("payload_fs_type", "%q is not a valid filesystem for apex [ext4, f2fs, erofs]", *a.properties.Payload_fs_type)
Theotime Combes4ba38c12020-06-12 12:46:59 +00002067 }
2068
Jiyong Park7cd10e32020-01-14 09:22:18 +09002069 // Optimization. If we are building bundled APEX, for the files that are gathered due to the
2070 // transitive dependencies, don't place them inside the APEX, but place a symlink pointing
2071 // the same library in the system partition, thus effectively sharing the same libraries
2072 // across the APEX boundary. For unbundled APEX, all the gathered files are actually placed
2073 // in the APEX.
Steven Moreland2c4000c2021-04-27 02:08:49 +00002074 a.linkToSystemLib = !ctx.Config().UnbundledBuild() && a.installable()
Jooyung Han54aca7b2019-11-20 02:26:02 +09002075
Jooyung Han85d61762020-06-24 23:50:26 +09002076 // APEXes targeting other than system/system_ext partitions use vendor/product variants.
2077 // So we can't link them to /system/lib libs which are core variants.
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002078 if a.SocSpecific() || a.DeviceSpecific() || (a.ProductSpecific() && ctx.Config().EnforceProductPartitionInterface()) {
Jooyung Han85d61762020-06-24 23:50:26 +09002079 a.linkToSystemLib = false
2080 }
2081
Jiyong Park4da07972021-01-05 21:01:11 +09002082 forced := ctx.Config().ForceApexSymlinkOptimization()
2083
Jiyong Park9d677202020-02-19 16:29:35 +09002084 // We don't need the optimization for updatable APEXes, as it might give false signal
Jiyong Park4da07972021-01-05 21:01:11 +09002085 // to the system health when the APEXes are still bundled (b/149805758).
2086 if !forced && a.Updatable() && a.properties.ApexType == imageApex {
Jiyong Park9d677202020-02-19 16:29:35 +09002087 a.linkToSystemLib = false
2088 }
2089
Jiyong Park638d30e2020-02-26 18:27:19 +09002090 // We also don't want the optimization for host APEXes, because it doesn't make sense.
2091 if ctx.Host() {
2092 a.linkToSystemLib = false
2093 }
2094
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002095 a.compatSymlinks = makeCompatSymlinks(a.BaseModuleName(), ctx)
2096
2097 ////////////////////////////////////////////////////////////////////////////////////////////
2098 // 4) generate the build rules to create the APEX. This is done in builder.go.
2099 a.buildManifest(ctx, provideNativeLibs, requireNativeLibs)
Jooyung Han01a3ee22019-11-02 02:52:25 +09002100 if a.properties.ApexType == flattenedApex {
2101 a.buildFlattenedApex(ctx)
2102 } else {
2103 a.buildUnflattenedApex(ctx)
2104 }
Jiyong Park956305c2020-01-09 12:32:06 +09002105 a.buildApexDependencyInfo(ctx)
Colin Cross08dca382020-07-21 20:31:17 -07002106 a.buildLintReports(ctx)
Jiyong Parkb81b9902020-11-24 19:51:18 +09002107
2108 // Append meta-files to the filesInfo list so that they are reflected in Android.mk as well.
2109 if a.installable() {
2110 // For flattened APEX, make sure that APEX manifest and apex_pubkey are also copied
2111 // along with other ordinary files. (Note that this is done by apexer for
2112 // non-flattened APEXes)
2113 a.filesInfo = append(a.filesInfo, newApexFile(ctx, a.manifestPbOut, "apex_manifest.pb", ".", etc, nil))
2114
2115 // Place the public key as apex_pubkey. This is also done by apexer for
2116 // non-flattened APEXes case.
2117 // TODO(jiyong): Why do we need this CP rule?
2118 copiedPubkey := android.PathForModuleOut(ctx, "apex_pubkey")
2119 ctx.Build(pctx, android.BuildParams{
2120 Rule: android.Cp,
Jaewoong Jung18aefc12020-12-21 09:11:10 -08002121 Input: a.publicKeyFile,
Jiyong Parkb81b9902020-11-24 19:51:18 +09002122 Output: copiedPubkey,
2123 })
2124 a.filesInfo = append(a.filesInfo, newApexFile(ctx, copiedPubkey, "apex_pubkey", ".", etc, nil))
2125 }
Jooyung Han01a3ee22019-11-02 02:52:25 +09002126}
2127
Paul Duffincc33ec82021-04-25 23:14:55 +01002128// apexBootclasspathFragmentFiles returns the list of apexFile structures defining the files that
2129// the bootclasspath_fragment contributes to the apex.
2130func apexBootclasspathFragmentFiles(ctx android.ModuleContext, module blueprint.Module) []apexFile {
2131 bootclasspathFragmentInfo := ctx.OtherModuleProvider(module, java.BootclasspathFragmentApexContentInfoProvider).(java.BootclasspathFragmentApexContentInfo)
2132 var filesToAdd []apexFile
2133
2134 // Add the boot image files, e.g. .art, .oat and .vdex files.
2135 for arch, files := range bootclasspathFragmentInfo.AndroidBootImageFilesByArchType() {
2136 dirInApex := filepath.Join("javalib", arch.String())
2137 for _, f := range files {
2138 androidMkModuleName := "javalib_" + arch.String() + "_" + filepath.Base(f.String())
2139 // TODO(b/177892522) - consider passing in the bootclasspath fragment module here instead of nil
2140 af := newApexFile(ctx, f, androidMkModuleName, dirInApex, etc, nil)
2141 filesToAdd = append(filesToAdd, af)
2142 }
2143 }
2144
satayev3db35472021-05-06 23:59:58 +01002145 // Add classpaths.proto config.
satayevb98371c2021-06-15 16:49:50 +01002146 if af := apexClasspathFragmentProtoFile(ctx, module); af != nil {
2147 filesToAdd = append(filesToAdd, *af)
2148 }
satayev3db35472021-05-06 23:59:58 +01002149
Paul Duffincc33ec82021-04-25 23:14:55 +01002150 return filesToAdd
2151}
2152
satayevb98371c2021-06-15 16:49:50 +01002153// apexClasspathFragmentProtoFile returns *apexFile structure defining the classpath.proto config that
2154// the module contributes to the apex; or nil if the proto config was not generated.
2155func apexClasspathFragmentProtoFile(ctx android.ModuleContext, module blueprint.Module) *apexFile {
2156 info := ctx.OtherModuleProvider(module, java.ClasspathFragmentProtoContentInfoProvider).(java.ClasspathFragmentProtoContentInfo)
2157 if !info.ClasspathFragmentProtoGenerated {
2158 return nil
2159 }
2160 classpathProtoOutput := info.ClasspathFragmentProtoOutput
2161 af := newApexFile(ctx, classpathProtoOutput, classpathProtoOutput.Base(), info.ClasspathFragmentProtoInstallDir.Rel(), etc, nil)
2162 return &af
satayev14e49132021-05-17 21:03:07 +01002163}
2164
Paul Duffincc33ec82021-04-25 23:14:55 +01002165// apexFileForBootclasspathFragmentContentModule creates an apexFile for a bootclasspath_fragment
2166// content module, i.e. a library that is part of the bootclasspath.
Paul Duffin190fdef2021-04-26 10:33:59 +01002167func apexFileForBootclasspathFragmentContentModule(ctx android.ModuleContext, fragmentModule blueprint.Module, javaModule javaModule) apexFile {
2168 bootclasspathFragmentInfo := ctx.OtherModuleProvider(fragmentModule, java.BootclasspathFragmentApexContentInfoProvider).(java.BootclasspathFragmentApexContentInfo)
2169
2170 // Get the dexBootJar from the bootclasspath_fragment as that is responsible for performing the
2171 // hidden API encpding.
Paul Duffin1a8010a2021-05-15 12:39:23 +01002172 dexBootJar, err := bootclasspathFragmentInfo.DexBootJarPathForContentModule(javaModule)
2173 if err != nil {
2174 ctx.ModuleErrorf("%s", err)
2175 }
Paul Duffin190fdef2021-04-26 10:33:59 +01002176
2177 // Create an apexFile as for a normal java module but with the dex boot jar provided by the
2178 // bootclasspath_fragment.
2179 af := apexFileForJavaModuleWithFile(ctx, javaModule, dexBootJar)
2180 return af
Paul Duffincc33ec82021-04-25 23:14:55 +01002181}
2182
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002183///////////////////////////////////////////////////////////////////////////////////////////////////
2184// Factory functions
2185//
2186
2187func newApexBundle() *apexBundle {
2188 module := &apexBundle{}
2189
2190 module.AddProperties(&module.properties)
2191 module.AddProperties(&module.targetProperties)
Jiyong Park59140302020-12-14 18:44:04 +09002192 module.AddProperties(&module.archProperties)
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002193 module.AddProperties(&module.overridableProperties)
2194
2195 android.InitAndroidMultiTargetsArchModule(module, android.HostAndDeviceSupported, android.MultilibCommon)
2196 android.InitDefaultableModule(module)
2197 android.InitSdkAwareModule(module)
2198 android.InitOverridableModule(module, &module.overridableProperties.Overrides)
Jingwen Chenf59a8e12021-07-16 09:28:53 +00002199 android.InitBazelModule(module)
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002200 return module
2201}
2202
2203func ApexBundleFactory(testApex bool, artApex bool) android.Module {
2204 bundle := newApexBundle()
2205 bundle.testApex = testApex
2206 bundle.artApex = artApex
2207 return bundle
2208}
2209
2210// apex_test is an APEX for testing. The difference from the ordinary apex module type is that
2211// certain compatibility checks such as apex_available are not done for apex_test.
2212func testApexBundleFactory() android.Module {
2213 bundle := newApexBundle()
2214 bundle.testApex = true
2215 return bundle
2216}
2217
2218// apex packages other modules into an APEX file which is a packaging format for system-level
2219// components like binaries, shared libraries, etc.
2220func BundleFactory() android.Module {
2221 return newApexBundle()
2222}
2223
2224type Defaults struct {
2225 android.ModuleBase
2226 android.DefaultsModuleBase
2227}
2228
2229// apex_defaults provides defaultable properties to other apex modules.
2230func defaultsFactory() android.Module {
2231 return DefaultsFactory()
2232}
2233
2234func DefaultsFactory(props ...interface{}) android.Module {
2235 module := &Defaults{}
2236
2237 module.AddProperties(props...)
2238 module.AddProperties(
2239 &apexBundleProperties{},
2240 &apexTargetBundleProperties{},
2241 &overridableProperties{},
2242 )
2243
2244 android.InitDefaultsModule(module)
2245 return module
2246}
2247
2248type OverrideApex struct {
2249 android.ModuleBase
2250 android.OverrideModuleBase
2251}
2252
2253func (o *OverrideApex) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2254 // All the overrides happen in the base module.
2255}
2256
2257// override_apex is used to create an apex module based on another apex module by overriding some of
2258// its properties.
2259func overrideApexFactory() android.Module {
2260 m := &OverrideApex{}
2261
2262 m.AddProperties(&overridableProperties{})
2263
2264 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
2265 android.InitOverrideModule(m)
2266 return m
2267}
2268
2269///////////////////////////////////////////////////////////////////////////////////////////////////
2270// Vality check routines
2271//
2272// These are called in at the very beginning of GenerateAndroidBuildActions to flag an error when
2273// certain conditions are not met.
2274//
2275// TODO(jiyong): move these checks to a separate go file.
2276
2277// Entures that min_sdk_version of the included modules are equal or less than the min_sdk_version
2278// of this apexBundle.
2279func (a *apexBundle) checkMinSdkVersion(ctx android.ModuleContext) {
2280 if a.testApex || a.vndkApex {
2281 return
2282 }
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002283 // apexBundle::minSdkVersion reports its own errors.
2284 minSdkVersion := a.minSdkVersion(ctx)
2285 android.CheckMinSdkVersion(a, ctx, minSdkVersion)
2286}
2287
2288func (a *apexBundle) minSdkVersion(ctx android.BaseModuleContext) android.ApiLevel {
2289 ver := proptools.String(a.properties.Min_sdk_version)
2290 if ver == "" {
Jooyung Haned124c32021-01-26 11:43:46 +09002291 return android.NoneApiLevel
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002292 }
2293 apiLevel, err := android.ApiLevelFromUser(ctx, ver)
2294 if err != nil {
2295 ctx.PropertyErrorf("min_sdk_version", "%s", err.Error())
2296 return android.NoneApiLevel
2297 }
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002298 return apiLevel
2299}
2300
2301// Ensures that a lib providing stub isn't statically linked
2302func (a *apexBundle) checkStaticLinkingToStubLibraries(ctx android.ModuleContext) {
2303 // Practically, we only care about regular APEXes on the device.
2304 if ctx.Host() || a.testApex || a.vndkApex {
2305 return
2306 }
2307
2308 abInfo := ctx.Provider(ApexBundleInfoProvider).(ApexBundleInfo)
2309
2310 a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
2311 if ccm, ok := to.(*cc.Module); ok {
2312 apexName := ctx.ModuleName()
2313 fromName := ctx.OtherModuleName(from)
2314 toName := ctx.OtherModuleName(to)
2315
2316 // If `to` is not actually in the same APEX as `from` then it does not need
2317 // apex_available and neither do any of its dependencies.
Paul Duffin4c3e8e22021-03-18 15:41:29 +00002318 //
2319 // It is ok to call DepIsInSameApex() directly from within WalkPayloadDeps().
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002320 if am, ok := from.(android.DepIsInSameApex); ok && !am.DepIsInSameApex(ctx, to) {
2321 // As soon as the dependency graph crosses the APEX boundary, don't go further.
2322 return false
2323 }
2324
2325 // The dynamic linker and crash_dump tool in the runtime APEX is the only
2326 // exception to this rule. It can't make the static dependencies dynamic
2327 // because it can't do the dynamic linking for itself.
Kiyoung Kim4098c7e2020-11-30 14:42:14 +09002328 // Same rule should be applied to linkerconfig, because it should be executed
2329 // only with static linked libraries before linker is available with ld.config.txt
2330 if apexName == "com.android.runtime" && (fromName == "linker" || fromName == "crash_dump" || fromName == "linkerconfig") {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002331 return false
2332 }
2333
2334 isStubLibraryFromOtherApex := ccm.HasStubsVariants() && !abInfo.Contents.DirectlyInApex(toName)
2335 if isStubLibraryFromOtherApex && !externalDep {
2336 ctx.ModuleErrorf("%q required by %q is a native library providing stub. "+
2337 "It shouldn't be included in this APEX via static linking. Dependency path: %s", to.String(), fromName, ctx.GetPathString(false))
2338 }
2339
2340 }
2341 return true
2342 })
2343}
2344
satayevb98371c2021-06-15 16:49:50 +01002345// checkUpdatable enforces APEX and its transitive dep properties to have desired values for updatable APEXes.
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002346func (a *apexBundle) checkUpdatable(ctx android.ModuleContext) {
2347 if a.Updatable() {
2348 if String(a.properties.Min_sdk_version) == "" {
2349 ctx.PropertyErrorf("updatable", "updatable APEXes should set min_sdk_version as well")
2350 }
Jiyong Park1bc84122021-06-22 20:23:05 +09002351 if a.UsePlatformApis() {
2352 ctx.PropertyErrorf("updatable", "updatable APEXes can't use platform APIs")
2353 }
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002354 a.checkJavaStableSdkVersion(ctx)
satayevb98371c2021-06-15 16:49:50 +01002355 a.checkClasspathFragments(ctx)
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002356 }
2357}
2358
satayevb98371c2021-06-15 16:49:50 +01002359// checkClasspathFragments enforces that all classpath fragments in deps generate classpaths.proto config.
2360func (a *apexBundle) checkClasspathFragments(ctx android.ModuleContext) {
2361 ctx.VisitDirectDeps(func(module android.Module) {
2362 if tag := ctx.OtherModuleDependencyTag(module); tag == bcpfTag || tag == sscpfTag {
2363 info := ctx.OtherModuleProvider(module, java.ClasspathFragmentProtoContentInfoProvider).(java.ClasspathFragmentProtoContentInfo)
2364 if !info.ClasspathFragmentProtoGenerated {
2365 ctx.OtherModuleErrorf(module, "is included in updatable apex %v, it must not set generate_classpaths_proto to false", ctx.ModuleName())
2366 }
2367 }
2368 })
2369}
2370
2371// checkJavaStableSdkVersion enforces that all Java deps are using stable SDKs to compile.
Artur Satayev8cf899a2020-04-15 17:29:42 +01002372func (a *apexBundle) checkJavaStableSdkVersion(ctx android.ModuleContext) {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002373 // Visit direct deps only. As long as we guarantee top-level deps are using stable SDKs,
2374 // java's checkLinkType guarantees correct usage for transitive deps
Artur Satayev8cf899a2020-04-15 17:29:42 +01002375 ctx.VisitDirectDepsBlueprint(func(module blueprint.Module) {
2376 tag := ctx.OtherModuleDependencyTag(module)
2377 switch tag {
2378 case javaLibTag, androidAppTag:
Jiyong Parkdbd710c2021-04-02 08:45:46 +09002379 if m, ok := module.(interface {
2380 CheckStableSdkVersion(ctx android.BaseModuleContext) error
2381 }); ok {
2382 if err := m.CheckStableSdkVersion(ctx); err != nil {
Artur Satayev8cf899a2020-04-15 17:29:42 +01002383 ctx.ModuleErrorf("cannot depend on \"%v\": %v", ctx.OtherModuleName(module), err)
2384 }
2385 }
2386 }
2387 })
2388}
2389
satayevb98371c2021-06-15 16:49:50 +01002390// checkApexAvailability ensures that the all the dependencies are marked as available for this APEX.
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002391func (a *apexBundle) checkApexAvailability(ctx android.ModuleContext) {
2392 // Let's be practical. Availability for test, host, and the VNDK apex isn't important
2393 if ctx.Host() || a.testApex || a.vndkApex {
2394 return
2395 }
2396
2397 // Because APEXes targeting other than system/system_ext partitions can't set
2398 // apex_available, we skip checks for these APEXes
2399 if a.SocSpecific() || a.DeviceSpecific() || (a.ProductSpecific() && ctx.Config().EnforceProductPartitionInterface()) {
2400 return
2401 }
2402
2403 // Coverage build adds additional dependencies for the coverage-only runtime libraries.
2404 // Requiring them and their transitive depencies with apex_available is not right
2405 // because they just add noise.
2406 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") || a.IsNativeCoverageNeeded(ctx) {
2407 return
2408 }
2409
2410 a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
2411 // As soon as the dependency graph crosses the APEX boundary, don't go further.
2412 if externalDep {
2413 return false
2414 }
2415
2416 apexName := ctx.ModuleName()
2417 fromName := ctx.OtherModuleName(from)
2418 toName := ctx.OtherModuleName(to)
2419
2420 // If `to` is not actually in the same APEX as `from` then it does not need
2421 // apex_available and neither do any of its dependencies.
Paul Duffin4c3e8e22021-03-18 15:41:29 +00002422 //
2423 // It is ok to call DepIsInSameApex() directly from within WalkPayloadDeps().
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002424 if am, ok := from.(android.DepIsInSameApex); ok && !am.DepIsInSameApex(ctx, to) {
2425 // As soon as the dependency graph crosses the APEX boundary, don't go
2426 // further.
2427 return false
2428 }
2429
2430 if to.AvailableFor(apexName) || baselineApexAvailable(apexName, toName) {
2431 return true
2432 }
Jiyong Park767dbd92021-03-04 13:03:10 +09002433 ctx.ModuleErrorf("%q requires %q that doesn't list the APEX under 'apex_available'."+
2434 "\n\nDependency path:%s\n\n"+
2435 "Consider adding %q to 'apex_available' property of %q",
2436 fromName, toName, ctx.GetPathString(true), apexName, toName)
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002437 // Visit this module's dependencies to check and report any issues with their availability.
2438 return true
2439 })
2440}
2441
Jiyong Park192600a2021-08-03 07:52:17 +00002442// checkStaticExecutable ensures that executables in an APEX are not static.
2443func (a *apexBundle) checkStaticExecutables(ctx android.ModuleContext) {
Jiyong Parkd12979d2021-08-03 13:36:09 +09002444 // No need to run this for host APEXes
2445 if ctx.Host() {
2446 return
2447 }
2448
Jiyong Park192600a2021-08-03 07:52:17 +00002449 ctx.VisitDirectDepsBlueprint(func(module blueprint.Module) {
2450 if ctx.OtherModuleDependencyTag(module) != executableTag {
2451 return
2452 }
Jiyong Parkd12979d2021-08-03 13:36:09 +09002453
2454 if l, ok := module.(cc.LinkableInterface); ok && l.StaticExecutable() {
Jiyong Park192600a2021-08-03 07:52:17 +00002455 apex := a.ApexVariationName()
2456 exec := ctx.OtherModuleName(module)
2457 if isStaticExecutableAllowed(apex, exec) {
2458 return
2459 }
2460 ctx.ModuleErrorf("executable %s is static", ctx.OtherModuleName(module))
2461 }
2462 })
2463}
2464
2465// A small list of exceptions where static executables are allowed in APEXes.
2466func isStaticExecutableAllowed(apex string, exec string) bool {
2467 m := map[string][]string{
2468 "com.android.runtime": []string{
2469 "linker",
2470 "linkerconfig",
2471 },
2472 }
2473 execNames, ok := m[apex]
2474 return ok && android.InList(exec, execNames)
2475}
2476
braleeb0c1f0c2021-06-07 22:49:13 +08002477// Collect information for opening IDE project files in java/jdeps.go.
2478func (a *apexBundle) IDEInfo(dpInfo *android.IdeInfo) {
2479 dpInfo.Deps = append(dpInfo.Deps, a.properties.Java_libs...)
2480 dpInfo.Deps = append(dpInfo.Deps, a.properties.Bootclasspath_fragments...)
2481 dpInfo.Deps = append(dpInfo.Deps, a.properties.Systemserverclasspath_fragments...)
2482 dpInfo.Paths = append(dpInfo.Paths, a.modulePaths...)
2483}
2484
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002485var (
2486 apexAvailBaseline = makeApexAvailableBaseline()
2487 inverseApexAvailBaseline = invertApexBaseline(apexAvailBaseline)
2488)
2489
Colin Cross440e0d02020-06-11 11:32:11 -07002490func baselineApexAvailable(apex, moduleName string) bool {
Anton Hanssoneec79eb2020-01-10 15:12:39 +00002491 key := apex
Paul Duffin7d74e7b2020-03-06 12:30:13 +00002492 moduleName = normalizeModuleName(moduleName)
2493
Colin Cross440e0d02020-06-11 11:32:11 -07002494 if val, ok := apexAvailBaseline[key]; ok && android.InList(moduleName, val) {
Paul Duffin7d74e7b2020-03-06 12:30:13 +00002495 return true
2496 }
2497
2498 key = android.AvailableToAnyApex
Colin Cross440e0d02020-06-11 11:32:11 -07002499 if val, ok := apexAvailBaseline[key]; ok && android.InList(moduleName, val) {
Paul Duffin7d74e7b2020-03-06 12:30:13 +00002500 return true
2501 }
2502
2503 return false
2504}
2505
2506func normalizeModuleName(moduleName string) string {
Jiyong Park0f80c182020-01-31 02:49:53 +09002507 // Prebuilt modules (e.g. java_import, etc.) have "prebuilt_" prefix added by the build
2508 // system. Trim the prefix for the check since they are confusing
Paul Duffind23c7262020-12-11 18:13:08 +00002509 moduleName = android.RemoveOptionalPrebuiltPrefix(moduleName)
Jiyong Park0f80c182020-01-31 02:49:53 +09002510 if strings.HasPrefix(moduleName, "libclang_rt.") {
2511 // This module has many arch variants that depend on the product being built.
2512 // We don't want to list them all
2513 moduleName = "libclang_rt"
Anton Hanssoneec79eb2020-01-10 15:12:39 +00002514 }
Jooyung Hanacc7bbe2020-05-20 09:06:00 +09002515 if strings.HasPrefix(moduleName, "androidx.") {
2516 // TODO(b/156996905) Set apex_available/min_sdk_version for androidx support libraries
2517 moduleName = "androidx"
2518 }
Paul Duffin7d74e7b2020-03-06 12:30:13 +00002519 return moduleName
Anton Hanssoneec79eb2020-01-10 15:12:39 +00002520}
2521
Jiyong Park8e6d52f2020-11-19 14:37:47 +09002522// Transform the map of apex -> modules to module -> apexes.
2523func invertApexBaseline(m map[string][]string) map[string][]string {
2524 r := make(map[string][]string)
2525 for apex, modules := range m {
2526 for _, module := range modules {
2527 r[module] = append(r[module], apex)
2528 }
2529 }
2530 return r
2531}
2532
2533// Retrieve the baseline of apexes to which the supplied module belongs.
2534func BaselineApexAvailable(moduleName string) []string {
2535 return inverseApexAvailBaseline[normalizeModuleName(moduleName)]
2536}
2537
Jiyong Parkc0ec6f92020-11-19 23:00:52 +09002538// This is a map from apex to modules, which overrides the apex_available setting for that
2539// particular module to make it available for the apex regardless of its setting.
Jiyong Park8e6d52f2020-11-19 14:37:47 +09002540// TODO(b/147364041): remove this
2541func makeApexAvailableBaseline() map[string][]string {
2542 // The "Module separator"s below are employed to minimize merge conflicts.
2543 m := make(map[string][]string)
2544 //
2545 // Module separator
2546 //
2547 m["com.android.appsearch"] = []string{
2548 "icing-java-proto-lite",
2549 "libprotobuf-java-lite",
2550 }
2551 //
2552 // Module separator
2553 //
2554 m["com.android.bluetooth.updatable"] = []string{
2555 "android.hardware.audio.common@5.0",
2556 "android.hardware.bluetooth.a2dp@1.0",
2557 "android.hardware.bluetooth.audio@2.0",
2558 "android.hardware.bluetooth@1.0",
2559 "android.hardware.bluetooth@1.1",
2560 "android.hardware.graphics.bufferqueue@1.0",
2561 "android.hardware.graphics.bufferqueue@2.0",
2562 "android.hardware.graphics.common@1.0",
2563 "android.hardware.graphics.common@1.1",
2564 "android.hardware.graphics.common@1.2",
2565 "android.hardware.media@1.0",
2566 "android.hidl.safe_union@1.0",
2567 "android.hidl.token@1.0",
2568 "android.hidl.token@1.0-utils",
2569 "avrcp-target-service",
2570 "avrcp_headers",
2571 "bluetooth-protos-lite",
2572 "bluetooth.mapsapi",
2573 "com.android.vcard",
2574 "dnsresolver_aidl_interface-V2-java",
2575 "ipmemorystore-aidl-interfaces-V5-java",
2576 "ipmemorystore-aidl-interfaces-java",
2577 "internal_include_headers",
2578 "lib-bt-packets",
2579 "lib-bt-packets-avrcp",
2580 "lib-bt-packets-base",
2581 "libFraunhoferAAC",
2582 "libaudio-a2dp-hw-utils",
2583 "libaudio-hearing-aid-hw-utils",
Jiyong Park8e6d52f2020-11-19 14:37:47 +09002584 "libbluetooth",
2585 "libbluetooth-types",
2586 "libbluetooth-types-header",
2587 "libbluetooth_gd",
2588 "libbluetooth_headers",
2589 "libbluetooth_jni",
2590 "libbt-audio-hal-interface",
2591 "libbt-bta",
2592 "libbt-common",
2593 "libbt-hci",
2594 "libbt-platform-protos-lite",
2595 "libbt-protos-lite",
2596 "libbt-sbc-decoder",
2597 "libbt-sbc-encoder",
2598 "libbt-stack",
2599 "libbt-utils",
2600 "libbtcore",
2601 "libbtdevice",
2602 "libbte",
2603 "libbtif",
2604 "libchrome",
2605 "libevent",
2606 "libfmq",
2607 "libg722codec",
2608 "libgui_headers",
2609 "libmedia_headers",
2610 "libmodpb64",
2611 "libosi",
2612 "libstagefright_foundation_headers",
2613 "libstagefright_headers",
2614 "libstatslog",
2615 "libstatssocket",
2616 "libtinyxml2",
2617 "libudrv-uipc",
2618 "libz",
2619 "media_plugin_headers",
2620 "net-utils-services-common",
2621 "netd_aidl_interface-unstable-java",
2622 "netd_event_listener_interface-java",
2623 "netlink-client",
2624 "networkstack-client",
2625 "sap-api-java-static",
2626 "services.net",
2627 }
2628 //
2629 // Module separator
2630 //
2631 m["com.android.cellbroadcast"] = []string{"CellBroadcastApp", "CellBroadcastServiceModule"}
2632 //
2633 // Module separator
2634 //
2635 m["com.android.extservices"] = []string{
2636 "error_prone_annotations",
2637 "ExtServices-core",
2638 "ExtServices",
2639 "libtextclassifier-java",
2640 "libz_current",
2641 "textclassifier-statsd",
2642 "TextClassifierNotificationLibNoManifest",
2643 "TextClassifierServiceLibNoManifest",
2644 }
2645 //
2646 // Module separator
2647 //
2648 m["com.android.neuralnetworks"] = []string{
2649 "android.hardware.neuralnetworks@1.0",
2650 "android.hardware.neuralnetworks@1.1",
2651 "android.hardware.neuralnetworks@1.2",
2652 "android.hardware.neuralnetworks@1.3",
2653 "android.hidl.allocator@1.0",
2654 "android.hidl.memory.token@1.0",
2655 "android.hidl.memory@1.0",
2656 "android.hidl.safe_union@1.0",
2657 "libarect",
2658 "libbuildversion",
2659 "libmath",
2660 "libprocpartition",
2661 "libsync",
2662 }
2663 //
2664 // Module separator
2665 //
2666 m["com.android.media"] = []string{
2667 "android.frameworks.bufferhub@1.0",
2668 "android.hardware.cas.native@1.0",
2669 "android.hardware.cas@1.0",
2670 "android.hardware.configstore-utils",
2671 "android.hardware.configstore@1.0",
2672 "android.hardware.configstore@1.1",
2673 "android.hardware.graphics.allocator@2.0",
2674 "android.hardware.graphics.allocator@3.0",
2675 "android.hardware.graphics.bufferqueue@1.0",
2676 "android.hardware.graphics.bufferqueue@2.0",
2677 "android.hardware.graphics.common@1.0",
2678 "android.hardware.graphics.common@1.1",
2679 "android.hardware.graphics.common@1.2",
2680 "android.hardware.graphics.mapper@2.0",
2681 "android.hardware.graphics.mapper@2.1",
2682 "android.hardware.graphics.mapper@3.0",
2683 "android.hardware.media.omx@1.0",
2684 "android.hardware.media@1.0",
2685 "android.hidl.allocator@1.0",
2686 "android.hidl.memory.token@1.0",
2687 "android.hidl.memory@1.0",
2688 "android.hidl.token@1.0",
2689 "android.hidl.token@1.0-utils",
2690 "bionic_libc_platform_headers",
2691 "exoplayer2-extractor",
2692 "exoplayer2-extractor-annotation-stubs",
2693 "gl_headers",
2694 "jsr305",
2695 "libEGL",
2696 "libEGL_blobCache",
2697 "libEGL_getProcAddress",
2698 "libFLAC",
2699 "libFLAC-config",
2700 "libFLAC-headers",
2701 "libGLESv2",
2702 "libaacextractor",
2703 "libamrextractor",
2704 "libarect",
2705 "libaudio_system_headers",
2706 "libaudioclient",
2707 "libaudioclient_headers",
2708 "libaudiofoundation",
2709 "libaudiofoundation_headers",
2710 "libaudiomanager",
2711 "libaudiopolicy",
2712 "libaudioutils",
2713 "libaudioutils_fixedfft",
Jiyong Park8e6d52f2020-11-19 14:37:47 +09002714 "libbluetooth-types-header",
2715 "libbufferhub",
2716 "libbufferhub_headers",
2717 "libbufferhubqueue",
2718 "libc_malloc_debug_backtrace",
2719 "libcamera_client",
2720 "libcamera_metadata",
2721 "libdvr_headers",
2722 "libexpat",
2723 "libfifo",
2724 "libflacextractor",
2725 "libgrallocusage",
2726 "libgraphicsenv",
2727 "libgui",
2728 "libgui_headers",
2729 "libhardware_headers",
2730 "libinput",
2731 "liblzma",
2732 "libmath",
2733 "libmedia",
2734 "libmedia_codeclist",
2735 "libmedia_headers",
2736 "libmedia_helper",
2737 "libmedia_helper_headers",
2738 "libmedia_midiiowrapper",
2739 "libmedia_omx",
2740 "libmediautils",
2741 "libmidiextractor",
2742 "libmkvextractor",
2743 "libmp3extractor",
2744 "libmp4extractor",
2745 "libmpeg2extractor",
2746 "libnativebase_headers",
2747 "libnativewindow_headers",
2748 "libnblog",
2749 "liboggextractor",
2750 "libpackagelistparser",
2751 "libpdx",
2752 "libpdx_default_transport",
2753 "libpdx_headers",
2754 "libpdx_uds",
2755 "libprocinfo",
2756 "libspeexresampler",
2757 "libspeexresampler",
2758 "libstagefright_esds",
2759 "libstagefright_flacdec",
2760 "libstagefright_flacdec",
2761 "libstagefright_foundation",
2762 "libstagefright_foundation_headers",
2763 "libstagefright_foundation_without_imemory",
2764 "libstagefright_headers",
2765 "libstagefright_id3",
2766 "libstagefright_metadatautils",
2767 "libstagefright_mpeg2extractor",
2768 "libstagefright_mpeg2support",
2769 "libsync",
2770 "libui",
2771 "libui_headers",
2772 "libunwindstack",
2773 "libvibrator",
2774 "libvorbisidec",
2775 "libwavextractor",
2776 "libwebm",
2777 "media_ndk_headers",
2778 "media_plugin_headers",
2779 "updatable-media",
2780 }
2781 //
2782 // Module separator
2783 //
2784 m["com.android.media.swcodec"] = []string{
2785 "android.frameworks.bufferhub@1.0",
2786 "android.hardware.common-ndk_platform",
2787 "android.hardware.configstore-utils",
2788 "android.hardware.configstore@1.0",
2789 "android.hardware.configstore@1.1",
2790 "android.hardware.graphics.allocator@2.0",
2791 "android.hardware.graphics.allocator@3.0",
2792 "android.hardware.graphics.allocator@4.0",
2793 "android.hardware.graphics.bufferqueue@1.0",
2794 "android.hardware.graphics.bufferqueue@2.0",
2795 "android.hardware.graphics.common-ndk_platform",
2796 "android.hardware.graphics.common@1.0",
2797 "android.hardware.graphics.common@1.1",
2798 "android.hardware.graphics.common@1.2",
2799 "android.hardware.graphics.mapper@2.0",
2800 "android.hardware.graphics.mapper@2.1",
2801 "android.hardware.graphics.mapper@3.0",
2802 "android.hardware.graphics.mapper@4.0",
2803 "android.hardware.media.bufferpool@2.0",
2804 "android.hardware.media.c2@1.0",
2805 "android.hardware.media.c2@1.1",
2806 "android.hardware.media.omx@1.0",
2807 "android.hardware.media@1.0",
2808 "android.hardware.media@1.0",
2809 "android.hidl.memory.token@1.0",
2810 "android.hidl.memory@1.0",
2811 "android.hidl.safe_union@1.0",
2812 "android.hidl.token@1.0",
2813 "android.hidl.token@1.0-utils",
2814 "libEGL",
2815 "libFLAC",
2816 "libFLAC-config",
2817 "libFLAC-headers",
2818 "libFraunhoferAAC",
2819 "libLibGuiProperties",
2820 "libarect",
2821 "libaudio_system_headers",
2822 "libaudioutils",
2823 "libaudioutils",
2824 "libaudioutils_fixedfft",
2825 "libavcdec",
2826 "libavcenc",
2827 "libavservices_minijail",
2828 "libavservices_minijail",
Jiyong Park8e6d52f2020-11-19 14:37:47 +09002829 "libbinderthreadstateutils",
2830 "libbluetooth-types-header",
2831 "libbufferhub_headers",
2832 "libcodec2",
2833 "libcodec2_headers",
2834 "libcodec2_hidl@1.0",
2835 "libcodec2_hidl@1.1",
2836 "libcodec2_internal",
2837 "libcodec2_soft_aacdec",
2838 "libcodec2_soft_aacenc",
2839 "libcodec2_soft_amrnbdec",
2840 "libcodec2_soft_amrnbenc",
2841 "libcodec2_soft_amrwbdec",
2842 "libcodec2_soft_amrwbenc",
2843 "libcodec2_soft_av1dec_gav1",
2844 "libcodec2_soft_avcdec",
2845 "libcodec2_soft_avcenc",
2846 "libcodec2_soft_common",
2847 "libcodec2_soft_flacdec",
2848 "libcodec2_soft_flacenc",
2849 "libcodec2_soft_g711alawdec",
2850 "libcodec2_soft_g711mlawdec",
2851 "libcodec2_soft_gsmdec",
2852 "libcodec2_soft_h263dec",
2853 "libcodec2_soft_h263enc",
2854 "libcodec2_soft_hevcdec",
2855 "libcodec2_soft_hevcenc",
2856 "libcodec2_soft_mp3dec",
2857 "libcodec2_soft_mpeg2dec",
2858 "libcodec2_soft_mpeg4dec",
2859 "libcodec2_soft_mpeg4enc",
2860 "libcodec2_soft_opusdec",
2861 "libcodec2_soft_opusenc",
2862 "libcodec2_soft_rawdec",
2863 "libcodec2_soft_vorbisdec",
2864 "libcodec2_soft_vp8dec",
2865 "libcodec2_soft_vp8enc",
2866 "libcodec2_soft_vp9dec",
2867 "libcodec2_soft_vp9enc",
2868 "libcodec2_vndk",
2869 "libdvr_headers",
2870 "libfmq",
2871 "libfmq",
2872 "libgav1",
2873 "libgralloctypes",
2874 "libgrallocusage",
2875 "libgraphicsenv",
2876 "libgsm",
2877 "libgui_bufferqueue_static",
2878 "libgui_headers",
2879 "libhardware",
2880 "libhardware_headers",
2881 "libhevcdec",
2882 "libhevcenc",
2883 "libion",
2884 "libjpeg",
2885 "liblzma",
2886 "libmath",
2887 "libmedia_codecserviceregistrant",
2888 "libmedia_headers",
2889 "libmpeg2dec",
2890 "libnativebase_headers",
2891 "libnativewindow_headers",
2892 "libpdx_headers",
2893 "libscudo_wrapper",
2894 "libsfplugin_ccodec_utils",
2895 "libspeexresampler",
2896 "libstagefright_amrnb_common",
2897 "libstagefright_amrnbdec",
2898 "libstagefright_amrnbenc",
2899 "libstagefright_amrwbdec",
2900 "libstagefright_amrwbenc",
2901 "libstagefright_bufferpool@2.0.1",
Jiyong Park8e6d52f2020-11-19 14:37:47 +09002902 "libstagefright_enc_common",
2903 "libstagefright_flacdec",
2904 "libstagefright_foundation",
2905 "libstagefright_foundation_headers",
2906 "libstagefright_headers",
2907 "libstagefright_m4vh263dec",
2908 "libstagefright_m4vh263enc",
2909 "libstagefright_mp3dec",
2910 "libsync",
2911 "libui",
2912 "libui_headers",
2913 "libunwindstack",
2914 "libvorbisidec",
2915 "libvpx",
2916 "libyuv",
2917 "libyuv_static",
2918 "media_ndk_headers",
2919 "media_plugin_headers",
2920 "mediaswcodec",
2921 }
2922 //
2923 // Module separator
2924 //
2925 m["com.android.mediaprovider"] = []string{
2926 "MediaProvider",
2927 "MediaProviderGoogle",
2928 "fmtlib_ndk",
2929 "libbase_ndk",
2930 "libfuse",
2931 "libfuse_jni",
2932 }
2933 //
2934 // Module separator
2935 //
2936 m["com.android.permission"] = []string{
2937 "car-ui-lib",
2938 "iconloader",
2939 "kotlin-annotations",
2940 "kotlin-stdlib",
2941 "kotlin-stdlib-jdk7",
2942 "kotlin-stdlib-jdk8",
2943 "kotlinx-coroutines-android",
2944 "kotlinx-coroutines-android-nodeps",
2945 "kotlinx-coroutines-core",
2946 "kotlinx-coroutines-core-nodeps",
2947 "permissioncontroller-statsd",
2948 "GooglePermissionController",
2949 "PermissionController",
2950 "SettingsLibActionBarShadow",
2951 "SettingsLibAppPreference",
2952 "SettingsLibBarChartPreference",
2953 "SettingsLibLayoutPreference",
2954 "SettingsLibProgressBar",
2955 "SettingsLibSearchWidget",
2956 "SettingsLibSettingsTheme",
2957 "SettingsLibRestrictedLockUtils",
2958 "SettingsLibHelpUtils",
2959 }
2960 //
2961 // Module separator
2962 //
2963 m["com.android.runtime"] = []string{
2964 "bionic_libc_platform_headers",
2965 "libarm-optimized-routines-math",
2966 "libc_aeabi",
2967 "libc_bionic",
2968 "libc_bionic_ndk",
2969 "libc_bootstrap",
2970 "libc_common",
2971 "libc_common_shared",
2972 "libc_common_static",
2973 "libc_dns",
2974 "libc_dynamic_dispatch",
2975 "libc_fortify",
2976 "libc_freebsd",
2977 "libc_freebsd_large_stack",
2978 "libc_gdtoa",
2979 "libc_init_dynamic",
2980 "libc_init_static",
2981 "libc_jemalloc_wrapper",
2982 "libc_netbsd",
2983 "libc_nomalloc",
2984 "libc_nopthread",
2985 "libc_openbsd",
2986 "libc_openbsd_large_stack",
2987 "libc_openbsd_ndk",
2988 "libc_pthread",
2989 "libc_static_dispatch",
2990 "libc_syscalls",
2991 "libc_tzcode",
2992 "libc_unwind_static",
2993 "libdebuggerd",
2994 "libdebuggerd_common_headers",
2995 "libdebuggerd_handler_core",
2996 "libdebuggerd_handler_fallback",
2997 "libdl_static",
2998 "libjemalloc5",
2999 "liblinker_main",
3000 "liblinker_malloc",
3001 "liblz4",
3002 "liblzma",
3003 "libprocinfo",
3004 "libpropertyinfoparser",
3005 "libscudo",
3006 "libstdc++",
3007 "libsystemproperties",
3008 "libtombstoned_client_static",
3009 "libunwindstack",
3010 "libz",
3011 "libziparchive",
3012 }
3013 //
3014 // Module separator
3015 //
3016 m["com.android.tethering"] = []string{
3017 "android.hardware.tetheroffload.config-V1.0-java",
3018 "android.hardware.tetheroffload.control-V1.0-java",
3019 "android.hidl.base-V1.0-java",
3020 "libcgrouprc",
3021 "libcgrouprc_format",
3022 "libtetherutilsjni",
3023 "libvndksupport",
3024 "net-utils-framework-common",
3025 "netd_aidl_interface-V3-java",
3026 "netlink-client",
3027 "networkstack-aidl-interfaces-java",
3028 "tethering-aidl-interfaces-java",
3029 "TetheringApiCurrentLib",
3030 }
3031 //
3032 // Module separator
3033 //
3034 m["com.android.wifi"] = []string{
3035 "PlatformProperties",
3036 "android.hardware.wifi-V1.0-java",
3037 "android.hardware.wifi-V1.0-java-constants",
3038 "android.hardware.wifi-V1.1-java",
3039 "android.hardware.wifi-V1.2-java",
3040 "android.hardware.wifi-V1.3-java",
3041 "android.hardware.wifi-V1.4-java",
3042 "android.hardware.wifi.hostapd-V1.0-java",
3043 "android.hardware.wifi.hostapd-V1.1-java",
3044 "android.hardware.wifi.hostapd-V1.2-java",
3045 "android.hardware.wifi.supplicant-V1.0-java",
3046 "android.hardware.wifi.supplicant-V1.1-java",
3047 "android.hardware.wifi.supplicant-V1.2-java",
3048 "android.hardware.wifi.supplicant-V1.3-java",
3049 "android.hidl.base-V1.0-java",
3050 "android.hidl.manager-V1.0-java",
3051 "android.hidl.manager-V1.1-java",
3052 "android.hidl.manager-V1.2-java",
3053 "bouncycastle-unbundled",
3054 "dnsresolver_aidl_interface-V2-java",
3055 "error_prone_annotations",
3056 "framework-wifi-pre-jarjar",
3057 "framework-wifi-util-lib",
3058 "ipmemorystore-aidl-interfaces-V3-java",
3059 "ipmemorystore-aidl-interfaces-java",
3060 "ksoap2",
3061 "libnanohttpd",
3062 "libwifi-jni",
3063 "net-utils-services-common",
3064 "netd_aidl_interface-V2-java",
3065 "netd_aidl_interface-unstable-java",
3066 "netd_event_listener_interface-java",
3067 "netlink-client",
3068 "networkstack-client",
3069 "services.net",
3070 "wifi-lite-protos",
3071 "wifi-nano-protos",
3072 "wifi-service-pre-jarjar",
3073 "wifi-service-resources",
3074 }
3075 //
3076 // Module separator
3077 //
Jiyong Park8e6d52f2020-11-19 14:37:47 +09003078 m["com.android.os.statsd"] = []string{
3079 "libstatssocket",
3080 }
3081 //
3082 // Module separator
3083 //
3084 m[android.AvailableToAnyApex] = []string{
3085 // TODO(b/156996905) Set apex_available/min_sdk_version for androidx/extras support libraries
3086 "androidx",
3087 "androidx-constraintlayout_constraintlayout",
3088 "androidx-constraintlayout_constraintlayout-nodeps",
3089 "androidx-constraintlayout_constraintlayout-solver",
3090 "androidx-constraintlayout_constraintlayout-solver-nodeps",
3091 "com.google.android.material_material",
3092 "com.google.android.material_material-nodeps",
3093
Jiyong Park8e6d52f2020-11-19 14:37:47 +09003094 "libclang_rt",
Jiyong Park8e6d52f2020-11-19 14:37:47 +09003095 "libprofile-clang-extras",
3096 "libprofile-clang-extras_ndk",
3097 "libprofile-extras",
3098 "libprofile-extras_ndk",
Ryan Prichardb35a85e2021-01-13 19:18:53 -08003099 "libunwind",
Jiyong Park8e6d52f2020-11-19 14:37:47 +09003100 }
3101 return m
3102}
3103
3104func init() {
3105 android.AddNeverAllowRules(createApexPermittedPackagesRules(qModulesPackages())...)
3106 android.AddNeverAllowRules(createApexPermittedPackagesRules(rModulesPackages())...)
3107}
3108
3109func createApexPermittedPackagesRules(modules_packages map[string][]string) []android.Rule {
3110 rules := make([]android.Rule, 0, len(modules_packages))
3111 for module_name, module_packages := range modules_packages {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08003112 permittedPackagesRule := android.NeverAllow().
Jiyong Park8e6d52f2020-11-19 14:37:47 +09003113 BootclasspathJar().
3114 With("apex_available", module_name).
3115 WithMatcher("permitted_packages", android.NotInList(module_packages)).
3116 Because("jars that are part of the " + module_name +
3117 " module may only allow these packages: " + strings.Join(module_packages, ",") +
3118 ". Please jarjar or move code around.")
Jaewoong Jung18aefc12020-12-21 09:11:10 -08003119 rules = append(rules, permittedPackagesRule)
Jiyong Park8e6d52f2020-11-19 14:37:47 +09003120 }
3121 return rules
3122}
3123
3124// DO NOT EDIT! These are the package prefixes that are exempted from being AOT'ed by ART.
3125// Adding code to the bootclasspath in new packages will cause issues on module update.
3126func qModulesPackages() map[string][]string {
3127 return map[string][]string{
3128 "com.android.conscrypt": []string{
3129 "android.net.ssl",
3130 "com.android.org.conscrypt",
3131 },
3132 "com.android.media": []string{
3133 "android.media",
3134 },
3135 }
3136}
3137
3138// DO NOT EDIT! These are the package prefixes that are exempted from being AOT'ed by ART.
3139// Adding code to the bootclasspath in new packages will cause issues on module update.
3140func rModulesPackages() map[string][]string {
3141 return map[string][]string{
3142 "com.android.mediaprovider": []string{
3143 "android.provider",
3144 },
3145 "com.android.permission": []string{
3146 "android.permission",
3147 "android.app.role",
3148 "com.android.permission",
3149 "com.android.role",
3150 },
3151 "com.android.sdkext": []string{
3152 "android.os.ext",
3153 },
3154 "com.android.os.statsd": []string{
3155 "android.app",
3156 "android.os",
3157 "android.util",
3158 "com.android.internal.statsd",
3159 "com.android.server.stats",
3160 },
3161 "com.android.wifi": []string{
3162 "com.android.server.wifi",
3163 "com.android.wifi.x",
3164 "android.hardware.wifi",
3165 "android.net.wifi",
3166 },
3167 "com.android.tethering": []string{
3168 "android.net",
3169 },
3170 }
3171}
Rupert Shuttlewortha9d76dd2021-07-02 07:17:16 -04003172
3173// For Bazel / bp2build
3174
3175type bazelApexBundleAttributes struct {
Rupert Shuttleworth6e4950a2021-07-27 01:34:59 -04003176 Manifest bazel.LabelAttribute
3177 Android_manifest bazel.LabelAttribute
3178 File_contexts bazel.LabelAttribute
3179 Key bazel.LabelAttribute
3180 Certificate bazel.LabelAttribute
3181 Min_sdk_version string
3182 Updatable bazel.BoolAttribute
3183 Installable bazel.BoolAttribute
3184 Native_shared_libs bazel.LabelListAttribute
3185 Binaries bazel.StringListAttribute
Rupert Shuttleworth9447e1e2021-07-28 05:53:42 -04003186 Prebuilts bazel.LabelListAttribute
Rupert Shuttlewortha9d76dd2021-07-02 07:17:16 -04003187}
3188
Rupert Shuttlewortha9d76dd2021-07-02 07:17:16 -04003189func ApexBundleBp2Build(ctx android.TopDownMutatorContext) {
3190 module, ok := ctx.Module().(*apexBundle)
3191 if !ok {
3192 // Not an APEX bundle
3193 return
3194 }
3195 if !module.ConvertWithBp2build(ctx) {
3196 return
3197 }
3198 if ctx.ModuleType() != "apex" {
3199 return
3200 }
3201
3202 apexBundleBp2BuildInternal(ctx, module)
3203}
3204
3205func apexBundleBp2BuildInternal(ctx android.TopDownMutatorContext, module *apexBundle) {
3206 var manifestLabelAttribute bazel.LabelAttribute
Rupert Shuttlewortha9d76dd2021-07-02 07:17:16 -04003207 if module.properties.Manifest != nil {
Rupert Shuttleworth6e4950a2021-07-27 01:34:59 -04003208 manifestLabelAttribute.SetValue(android.BazelLabelForModuleSrcSingle(ctx, *module.properties.Manifest))
3209 }
3210
3211 var androidManifestLabelAttribute bazel.LabelAttribute
3212 if module.properties.AndroidManifest != nil {
3213 androidManifestLabelAttribute.SetValue(android.BazelLabelForModuleSrcSingle(ctx, *module.properties.AndroidManifest))
3214 }
3215
3216 var fileContextsLabelAttribute bazel.LabelAttribute
3217 if module.properties.File_contexts != nil {
3218 fileContextsLabelAttribute.SetValue(android.BazelLabelForModuleDepSingle(ctx, *module.properties.File_contexts))
3219 }
3220
3221 var minSdkVersion string
3222 if module.properties.Min_sdk_version != nil {
3223 minSdkVersion = *module.properties.Min_sdk_version
3224 }
3225
3226 var keyLabelAttribute bazel.LabelAttribute
3227 if module.overridableProperties.Key != nil {
3228 keyLabelAttribute.SetValue(android.BazelLabelForModuleDepSingle(ctx, *module.overridableProperties.Key))
3229 }
3230
3231 var certificateLabelAttribute bazel.LabelAttribute
3232 if module.overridableProperties.Certificate != nil {
3233 certificateLabelAttribute.SetValue(android.BazelLabelForModuleDepSingle(ctx, *module.overridableProperties.Certificate))
3234 }
3235
3236 nativeSharedLibs := module.properties.ApexNativeDependencies.Native_shared_libs
3237 nativeSharedLibsLabelList := android.BazelLabelForModuleDeps(ctx, nativeSharedLibs)
3238 nativeSharedLibsLabelListAttribute := bazel.MakeLabelListAttribute(nativeSharedLibsLabelList)
3239
Daniel Norman5a3ce132021-08-26 15:44:43 -07003240 prebuilts := module.overridableProperties.Prebuilts
Rupert Shuttleworth9447e1e2021-07-28 05:53:42 -04003241 prebuiltsLabelList := android.BazelLabelForModuleDeps(ctx, prebuilts)
3242 prebuiltsLabelListAttribute := bazel.MakeLabelListAttribute(prebuiltsLabelList)
3243
Rupert Shuttleworth6e4950a2021-07-27 01:34:59 -04003244 binaries := module.properties.ApexNativeDependencies.Binaries
3245 binariesStringListAttribute := bazel.MakeStringListAttribute(binaries)
3246
3247 var updatableAttribute bazel.BoolAttribute
3248 if module.properties.Updatable != nil {
3249 updatableAttribute.Value = module.properties.Updatable
3250 }
3251
3252 var installableAttribute bazel.BoolAttribute
3253 if module.properties.Installable != nil {
3254 installableAttribute.Value = module.properties.Installable
Rupert Shuttlewortha9d76dd2021-07-02 07:17:16 -04003255 }
3256
3257 attrs := &bazelApexBundleAttributes{
Rupert Shuttleworth6e4950a2021-07-27 01:34:59 -04003258 Manifest: manifestLabelAttribute,
3259 Android_manifest: androidManifestLabelAttribute,
3260 File_contexts: fileContextsLabelAttribute,
3261 Min_sdk_version: minSdkVersion,
3262 Key: keyLabelAttribute,
3263 Certificate: certificateLabelAttribute,
3264 Updatable: updatableAttribute,
3265 Installable: installableAttribute,
3266 Native_shared_libs: nativeSharedLibsLabelListAttribute,
3267 Binaries: binariesStringListAttribute,
Rupert Shuttleworth9447e1e2021-07-28 05:53:42 -04003268 Prebuilts: prebuiltsLabelListAttribute,
Rupert Shuttlewortha9d76dd2021-07-02 07:17:16 -04003269 }
3270
3271 props := bazel.BazelTargetModuleProperties{
3272 Rule_class: "apex",
3273 Bzl_load_location: "//build/bazel/rules:apex.bzl",
3274 }
3275
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux447f6c92021-08-31 20:30:36 +00003276 ctx.CreateBazelTargetModule(props, android.CommonAttributes{Name: module.Name()}, attrs)
Rupert Shuttlewortha9d76dd2021-07-02 07:17:16 -04003277}