blob: 9867a7a81c086a6d031b58be28809f482a88c008 [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
15package apex
16
17import (
18 "fmt"
Jooyung Han54aca7b2019-11-20 02:26:02 +090019 "path"
Jiyong Park48ca7dc2018-10-10 14:01:00 +090020 "path/filepath"
Jiyong Parkab3ceb32018-10-10 14:05:29 +090021 "sort"
Jiyong Park48ca7dc2018-10-10 14:01:00 +090022 "strings"
Jooyung Han344d5432019-08-23 11:17:39 +090023 "sync"
Jiyong Park48ca7dc2018-10-10 14:01:00 +090024
25 "android/soong/android"
26 "android/soong/cc"
27 "android/soong/java"
Alex Light778127a2019-02-27 14:19:50 -080028 "android/soong/python"
Jiyong Park48ca7dc2018-10-10 14:01:00 +090029
30 "github.com/google/blueprint"
Alex Light778127a2019-02-27 14:19:50 -080031 "github.com/google/blueprint/bootstrap"
Jiyong Park48ca7dc2018-10-10 14:01:00 +090032 "github.com/google/blueprint/proptools"
33)
34
Jooyung Han72bd2f82019-10-23 16:46:38 +090035const (
36 imageApexSuffix = ".apex"
37 zipApexSuffix = ".zipapex"
Sundong Ahnabb64432019-10-22 13:58:29 +090038 flattenedSuffix = ".flattened"
Alex Light5098a612018-11-29 17:12:15 -080039
Sundong Ahnabb64432019-10-22 13:58:29 +090040 imageApexType = "image"
41 zipApexType = "zip"
42 flattenedApexType = "flattened"
Jooyung Han72bd2f82019-10-23 16:46:38 +090043)
Jiyong Park48ca7dc2018-10-10 14:01:00 +090044
45type dependencyTag struct {
46 blueprint.BaseDependencyTag
47 name string
48}
49
50var (
Jiyong Parkc00cbd92018-10-30 21:20:05 +090051 sharedLibTag = dependencyTag{name: "sharedLib"}
52 executableTag = dependencyTag{name: "executable"}
53 javaLibTag = dependencyTag{name: "javaLib"}
54 prebuiltTag = dependencyTag{name: "prebuilt"}
Roland Levillain630846d2019-06-26 12:48:34 +010055 testTag = dependencyTag{name: "test"}
Jiyong Parkc00cbd92018-10-30 21:20:05 +090056 keyTag = dependencyTag{name: "key"}
57 certificateTag = dependencyTag{name: "certificate"}
Jooyung Han5c998b92019-06-27 11:30:33 +090058 usesTag = dependencyTag{name: "uses"}
Sundong Ahne1f05aa2019-08-27 13:55:42 +090059 androidAppTag = dependencyTag{name: "androidApp"}
Jiyong Park48ca7dc2018-10-10 14:01:00 +090060)
61
62func init() {
Jiyong Parkd1063c12019-07-17 20:08:41 +090063 android.RegisterModuleType("apex", BundleFactory)
Alex Light0851b882019-02-07 13:20:53 -080064 android.RegisterModuleType("apex_test", testApexBundleFactory)
Jooyung Han344d5432019-08-23 11:17:39 +090065 android.RegisterModuleType("apex_vndk", vndkApexBundleFactory)
Jiyong Park30ca9372019-02-07 16:27:23 +090066 android.RegisterModuleType("apex_defaults", defaultsFactory)
Jaewoong Jung939ebd52019-03-26 15:07:36 -070067 android.RegisterModuleType("prebuilt_apex", PrebuiltFactory)
Jiyong Park5d790c32019-11-15 18:40:32 +090068 android.RegisterModuleType("override_apex", overrideApexFactory)
Jiyong Park48ca7dc2018-10-10 14:01:00 +090069
Jooyung Han31c470b2019-10-18 16:26:59 +090070 android.PreDepsMutators(RegisterPreDepsMutators)
Jiyong Parkd1063c12019-07-17 20:08:41 +090071 android.PostDepsMutators(RegisterPostDepsMutators)
Jooyung Han7a78a922019-10-08 21:59:58 +090072
73 android.RegisterMakeVarsProvider(pctx, func(ctx android.MakeVarsContext) {
74 apexFileContextsInfos := apexFileContextsInfos(ctx.Config())
75 sort.Strings(*apexFileContextsInfos)
76 ctx.Strict("APEX_FILE_CONTEXTS_INFOS", strings.Join(*apexFileContextsInfos, " "))
77 })
Jiyong Parkd1063c12019-07-17 20:08:41 +090078}
79
Jooyung Han31c470b2019-10-18 16:26:59 +090080func RegisterPreDepsMutators(ctx android.RegisterMutatorsContext) {
81 ctx.TopDown("apex_vndk", apexVndkMutator).Parallel()
82 ctx.BottomUp("apex_vndk_deps", apexVndkDepsMutator).Parallel()
83}
84
Jiyong Parkd1063c12019-07-17 20:08:41 +090085func RegisterPostDepsMutators(ctx android.RegisterMutatorsContext) {
Jiyong Parka308ea12019-11-15 10:38:39 +090086 ctx.BottomUp("apex_deps", apexDepsMutator)
Jiyong Parkd1063c12019-07-17 20:08:41 +090087 ctx.BottomUp("apex", apexMutator).Parallel()
88 ctx.BottomUp("apex_flattened", apexFlattenedMutator).Parallel()
89 ctx.BottomUp("apex_uses", apexUsesMutator).Parallel()
Jiyong Park48ca7dc2018-10-10 14:01:00 +090090}
91
Jiyong Park48ca7dc2018-10-10 14:01:00 +090092// Mark the direct and transitive dependencies of apex bundles so that they
93// can be built for the apex bundles.
Jiyong Parka308ea12019-11-15 10:38:39 +090094func apexDepsMutator(mctx android.BottomUpMutatorContext) {
Alex Lightf98087f2019-02-04 14:45:06 -080095 if a, ok := mctx.Module().(*apexBundle); ok {
Colin Crossa4925902018-11-16 11:36:28 -080096 apexBundleName := mctx.ModuleName()
Jiyong Park48ca7dc2018-10-10 14:01:00 +090097 mctx.WalkDeps(func(child, parent android.Module) bool {
Jiyong Park0ddfcd12018-12-11 01:35:25 +090098 depName := mctx.OtherModuleName(child)
99 // If the parent is apexBundle, this child is directly depended.
100 _, directDep := parent.(*apexBundle)
Alex Light0851b882019-02-07 13:20:53 -0800101 if a.installable() && !a.testApex {
Alex Lightf98087f2019-02-04 14:45:06 -0800102 // TODO(b/123892969): Workaround for not having any way to annotate test-apexs
103 // non-installable apex's cannot be installed and so should not prevent libraries from being
104 // installed to the system.
105 android.UpdateApexDependency(apexBundleName, depName, directDep)
106 }
Jiyong Park0ddfcd12018-12-11 01:35:25 +0900107
Jiyong Park3ff16992019-12-27 14:11:47 +0900108 if am, ok := child.(android.ApexModule); ok && am.CanHaveApexVariants() &&
109 (directDep || am.DepIsInSameApex(mctx, child)) {
Jiyong Park0ddfcd12018-12-11 01:35:25 +0900110 am.BuildForApex(apexBundleName)
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900111 return true
112 } else {
113 return false
114 }
115 })
116 }
117}
118
119// Create apex variations if a module is included in APEX(s).
120func apexMutator(mctx android.BottomUpMutatorContext) {
121 if am, ok := mctx.Module().(android.ApexModule); ok && am.CanHaveApexVariants() {
Jiyong Park0ddfcd12018-12-11 01:35:25 +0900122 am.CreateApexVariations(mctx)
Jooyung Han54aca7b2019-11-20 02:26:02 +0900123 } else if _, ok := mctx.Module().(*apexBundle); ok {
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900124 // apex bundle itself is mutated so that it and its modules have same
125 // apex variant.
126 apexBundleName := mctx.ModuleName()
127 mctx.CreateVariations(apexBundleName)
Jiyong Park5d790c32019-11-15 18:40:32 +0900128 } else if o, ok := mctx.Module().(*OverrideApex); ok {
129 apexBundleName := o.GetOverriddenModuleName()
130 if apexBundleName == "" {
131 mctx.ModuleErrorf("base property is not set")
132 return
133 }
134 mctx.CreateVariations(apexBundleName)
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900135 }
Jiyong Park5d790c32019-11-15 18:40:32 +0900136
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900137}
Sundong Ahne9b55722019-09-06 17:37:42 +0900138
Jooyung Han7a78a922019-10-08 21:59:58 +0900139var (
140 apexFileContextsInfosKey = android.NewOnceKey("apexFileContextsInfosKey")
141 apexFileContextsInfosMutex sync.Mutex
142)
143
144func apexFileContextsInfos(config android.Config) *[]string {
145 return config.Once(apexFileContextsInfosKey, func() interface{} {
146 return &[]string{}
147 }).(*[]string)
148}
149
Jooyung Han54aca7b2019-11-20 02:26:02 +0900150func addFlattenedFileContextsInfos(ctx android.BaseModuleContext, fileContextsInfo string) {
Jooyung Han7a78a922019-10-08 21:59:58 +0900151 apexFileContextsInfosMutex.Lock()
152 defer apexFileContextsInfosMutex.Unlock()
153 apexFileContextsInfos := apexFileContextsInfos(ctx.Config())
Jooyung Han54aca7b2019-11-20 02:26:02 +0900154 *apexFileContextsInfos = append(*apexFileContextsInfos, fileContextsInfo)
Jooyung Han7a78a922019-10-08 21:59:58 +0900155}
156
Sundong Ahne9b55722019-09-06 17:37:42 +0900157func apexFlattenedMutator(mctx android.BottomUpMutatorContext) {
Sundong Ahne8fb7242019-09-17 13:50:45 +0900158 if ab, ok := mctx.Module().(*apexBundle); ok {
Sundong Ahnabb64432019-10-22 13:58:29 +0900159 var variants []string
160 switch proptools.StringDefault(ab.properties.Payload_type, "image") {
161 case "image":
162 variants = append(variants, imageApexType, flattenedApexType)
163 case "zip":
164 variants = append(variants, zipApexType)
165 case "both":
166 variants = append(variants, imageApexType, zipApexType, flattenedApexType)
167 default:
Sundong Ahnd95aa2d2019-10-08 19:34:03 +0900168 mctx.PropertyErrorf("type", "%q is not one of \"image\", \"zip\", or \"both\".", *ab.properties.Payload_type)
Sundong Ahnabb64432019-10-22 13:58:29 +0900169 return
170 }
171
172 modules := mctx.CreateLocalVariations(variants...)
173
174 for i, v := range variants {
175 switch v {
176 case imageApexType:
177 modules[i].(*apexBundle).properties.ApexType = imageApex
178 case zipApexType:
179 modules[i].(*apexBundle).properties.ApexType = zipApex
180 case flattenedApexType:
181 modules[i].(*apexBundle).properties.ApexType = flattenedApex
Jooyung Han91df2082019-11-20 01:49:42 +0900182 if !mctx.Config().FlattenApex() && ab.Platform() {
Sundong Ahnd95aa2d2019-10-08 19:34:03 +0900183 modules[i].(*apexBundle).MakeAsSystemExt()
184 }
Sundong Ahnabb64432019-10-22 13:58:29 +0900185 }
Sundong Ahne9b55722019-09-06 17:37:42 +0900186 }
Jiyong Park5d790c32019-11-15 18:40:32 +0900187 } else if _, ok := mctx.Module().(*OverrideApex); ok {
188 mctx.CreateVariations(imageApexType, flattenedApexType)
Sundong Ahne9b55722019-09-06 17:37:42 +0900189 }
190}
191
Jooyung Han5c998b92019-06-27 11:30:33 +0900192func apexUsesMutator(mctx android.BottomUpMutatorContext) {
193 if ab, ok := mctx.Module().(*apexBundle); ok {
194 mctx.AddFarVariationDependencies(nil, usesTag, ab.properties.Uses...)
195 }
196}
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900197
Jooyung Handc782442019-11-01 03:14:38 +0900198var (
199 useVendorWhitelistKey = android.NewOnceKey("useVendorWhitelist")
200)
201
202// useVendorWhitelist returns the list of APEXes which are allowed to use_vendor.
203// When use_vendor is used, native modules are built with __ANDROID_VNDK__ and __ANDROID_APEX__,
204// which may cause compatibility issues. (e.g. libbinder)
205// Even though libbinder restricts its availability via 'apex_available' property and relies on
206// yet another macro __ANDROID_APEX_<NAME>__, we restrict usage of "use_vendor:" from other APEX modules
207// to avoid similar problems.
208func useVendorWhitelist(config android.Config) []string {
209 return config.Once(useVendorWhitelistKey, func() interface{} {
210 return []string{
211 // swcodec uses "vendor" variants for smaller size
212 "com.android.media.swcodec",
213 "test_com.android.media.swcodec",
214 }
215 }).([]string)
216}
217
218// setUseVendorWhitelistForTest overrides useVendorWhitelist and must be
219// called before the first call to useVendorWhitelist()
220func setUseVendorWhitelistForTest(config android.Config, whitelist []string) {
221 config.Once(useVendorWhitelistKey, func() interface{} {
222 return whitelist
223 })
224}
225
Alex Light9670d332019-01-29 18:07:33 -0800226type apexNativeDependencies struct {
227 // List of native libraries
228 Native_shared_libs []string
Jooyung Han344d5432019-08-23 11:17:39 +0900229
Alex Light9670d332019-01-29 18:07:33 -0800230 // List of native executables
231 Binaries []string
Jooyung Han344d5432019-08-23 11:17:39 +0900232
Roland Levillain630846d2019-06-26 12:48:34 +0100233 // List of native tests
234 Tests []string
Alex Light9670d332019-01-29 18:07:33 -0800235}
Jooyung Han344d5432019-08-23 11:17:39 +0900236
Alex Light9670d332019-01-29 18:07:33 -0800237type apexMultilibProperties struct {
238 // Native dependencies whose compile_multilib is "first"
239 First apexNativeDependencies
240
241 // Native dependencies whose compile_multilib is "both"
242 Both apexNativeDependencies
243
244 // Native dependencies whose compile_multilib is "prefer32"
245 Prefer32 apexNativeDependencies
246
247 // Native dependencies whose compile_multilib is "32"
248 Lib32 apexNativeDependencies
249
250 // Native dependencies whose compile_multilib is "64"
251 Lib64 apexNativeDependencies
252}
253
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900254type apexBundleProperties struct {
255 // Json manifest file describing meta info of this APEX bundle. Default:
Dario Freni4abb1dc2018-11-20 18:04:58 +0000256 // "apex_manifest.json"
Colin Cross27b922f2019-03-04 22:35:41 -0800257 Manifest *string `android:"path"`
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900258
Jiyong Park40e26a22019-02-08 02:53:06 +0900259 // AndroidManifest.xml file used for the zip container of this APEX bundle.
260 // If unspecified, a default one is automatically generated.
Colin Cross27b922f2019-03-04 22:35:41 -0800261 AndroidManifest *string `android:"path"`
Jiyong Park40e26a22019-02-08 02:53:06 +0900262
Roland Levillain411c5842019-09-19 16:37:20 +0100263 // Canonical name of the APEX bundle. Used to determine the path to the activated APEX on
264 // device (/apex/<apex_name>).
265 // If unspecified, defaults to the value of name.
Jiyong Park05e70dd2019-03-18 14:26:32 +0900266 Apex_name *string
267
Jiyong Parkd0a65ba2018-11-10 06:37:15 +0900268 // Determines the file contexts file for setting security context to each file in this APEX bundle.
Jooyung Han54aca7b2019-11-20 02:26:02 +0900269 // For platform APEXes, this should points to a file under /system/sepolicy
270 // Default: /system/sepolicy/apex/<module_name>_file_contexts.
271 File_contexts *string `android:"path"`
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900272
273 // List of native shared libs that are embedded inside this APEX bundle
274 Native_shared_libs []string
275
Roland Levillain630846d2019-06-26 12:48:34 +0100276 // List of executables that are embedded inside this APEX bundle
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900277 Binaries []string
278
279 // List of java libraries that are embedded inside this APEX bundle
280 Java_libs []string
281
282 // List of prebuilt files that are embedded inside this APEX bundle
283 Prebuilts []string
Jiyong Parkff1458f2018-10-12 21:49:38 +0900284
Roland Levillain630846d2019-06-26 12:48:34 +0100285 // List of tests that are embedded inside this APEX bundle
286 Tests []string
287
Jiyong Parkff1458f2018-10-12 21:49:38 +0900288 // Name of the apex_key module that provides the private key to sign APEX
289 Key *string
Jiyong Park397e55e2018-10-24 21:09:55 +0900290
Alex Light5098a612018-11-29 17:12:15 -0800291 // The type of APEX to build. Controls what the APEX payload is. Either
292 // 'image', 'zip' or 'both'. Default: 'image'.
293 Payload_type *string
294
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900295 // The name of a certificate in the default certificate directory, blank to use the default product certificate,
296 // or an android_app_certificate module name in the form ":module".
297 Certificate *string
298
Jiyong Park92c0f9c2018-12-13 23:14:57 +0900299 // Whether this APEX is installable to one of the partitions. Default: true.
300 Installable *bool
301
Jiyong Parkda6eb592018-12-19 17:12:36 +0900302 // For native libraries and binaries, use the vendor variant instead of the core (platform) variant.
303 // Default is false.
304 Use_vendor *bool
305
Alex Lightfc0bd7c2019-01-29 18:31:59 -0800306 // For telling the apex to ignore special handling for system libraries such as bionic. Default is false.
307 Ignore_system_library_special_case *bool
308
Alex Light9670d332019-01-29 18:07:33 -0800309 Multilib apexMultilibProperties
Jiyong Park235e67c2019-02-09 11:50:56 +0900310
Jiyong Parkf97782b2019-02-13 20:28:58 +0900311 // List of sanitizer names that this APEX is enabled for
312 SanitizerNames []string `blueprint:"mutated"`
Jooyung Han5c998b92019-06-27 11:30:33 +0900313
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900314 PreventInstall bool `blueprint:"mutated"`
315
316 HideFromMake bool `blueprint:"mutated"`
317
Jooyung Han5c998b92019-06-27 11:30:33 +0900318 // Indicates this APEX provides C++ shared libaries to other APEXes. Default: false.
319 Provide_cpp_shared_libs *bool
320
321 // List of providing APEXes' names so that this APEX can depend on provided shared libraries.
322 Uses []string
Nikita Ioffe5d5ae762019-08-31 14:38:05 +0100323
324 // A txt file containing list of files that are whitelisted to be included in this APEX.
325 Whitelisted_files *string
Sundong Ahne1f05aa2019-08-27 13:55:42 +0900326
Sundong Ahnabb64432019-10-22 13:58:29 +0900327 // package format of this apex variant; could be non-flattened, flattened, or zip.
328 // imageApex, zipApex or flattened
329 ApexType apexPackaging `blueprint:"mutated"`
Sundong Ahne8fb7242019-09-17 13:50:45 +0900330
Jiyong Parkd1063c12019-07-17 20:08:41 +0900331 // List of SDKs that are used to build this APEX. A reference to an SDK should be either
332 // `name#version` or `name` which is an alias for `name#current`. If left empty, `platform#current`
333 // is implied. This value affects all modules included in this APEX. In other words, they are
334 // also built with the SDKs specified here.
335 Uses_sdks []string
Jiyong Park5d790c32019-11-15 18:40:32 +0900336
Nikita Ioffec72b5dd2019-12-07 17:30:22 +0000337 // Whenever apex_payload.img of the APEX should include dm-verity hashtree.
338 // Should be only used in tests#.
339 Test_only_no_hashtree *bool
Jooyung Han214bf372019-11-12 13:03:50 +0900340
341 // Whether this APEX should support Android10. Default is false. If this is set true, then apex_manifest.json is bundled as well
342 // because Android10 requires legacy apex_manifest.json instead of apex_manifest.pb
343 Legacy_android10_support *bool
Alex Light9670d332019-01-29 18:07:33 -0800344}
345
346type apexTargetBundleProperties struct {
347 Target struct {
348 // Multilib properties only for android.
349 Android struct {
350 Multilib apexMultilibProperties
Jiyong Park397e55e2018-10-24 21:09:55 +0900351 }
Jooyung Han344d5432019-08-23 11:17:39 +0900352
Alex Light9670d332019-01-29 18:07:33 -0800353 // Multilib properties only for host.
354 Host struct {
355 Multilib apexMultilibProperties
Jiyong Park397e55e2018-10-24 21:09:55 +0900356 }
Jooyung Han344d5432019-08-23 11:17:39 +0900357
Alex Light9670d332019-01-29 18:07:33 -0800358 // Multilib properties only for host linux_bionic.
359 Linux_bionic struct {
360 Multilib apexMultilibProperties
Jiyong Park397e55e2018-10-24 21:09:55 +0900361 }
Jooyung Han344d5432019-08-23 11:17:39 +0900362
Alex Light9670d332019-01-29 18:07:33 -0800363 // Multilib properties only for host linux_glibc.
364 Linux_glibc struct {
365 Multilib apexMultilibProperties
Jiyong Park397e55e2018-10-24 21:09:55 +0900366 }
367 }
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900368}
369
Jiyong Park5d790c32019-11-15 18:40:32 +0900370type overridableProperties struct {
371 // List of APKs to package inside APEX
372 Apps []string
Jaewoong Jung7abcf8e2019-12-19 17:32:06 -0800373
374 // Names of modules to be overridden. Listed modules can only be other binaries
375 // (in Make or Soong).
376 // This does not completely prevent installation of the overridden binaries, but if both
377 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
378 // from PRODUCT_PACKAGES.
379 Overrides []string
Jiyong Park5d790c32019-11-15 18:40:32 +0900380}
381
Alex Light5098a612018-11-29 17:12:15 -0800382type apexPackaging int
383
384const (
385 imageApex apexPackaging = iota
386 zipApex
Sundong Ahnabb64432019-10-22 13:58:29 +0900387 flattenedApex
Alex Light5098a612018-11-29 17:12:15 -0800388)
389
Sundong Ahnabb64432019-10-22 13:58:29 +0900390// The suffix for the output "file", not the module
Alex Light5098a612018-11-29 17:12:15 -0800391func (a apexPackaging) suffix() string {
392 switch a {
393 case imageApex:
394 return imageApexSuffix
395 case zipApex:
396 return zipApexSuffix
Alex Light5098a612018-11-29 17:12:15 -0800397 default:
Roland Levillain4644b222019-07-31 14:09:17 +0100398 panic(fmt.Errorf("unknown APEX type %d", a))
Alex Light5098a612018-11-29 17:12:15 -0800399 }
400}
401
402func (a apexPackaging) name() string {
403 switch a {
404 case imageApex:
405 return imageApexType
406 case zipApex:
407 return zipApexType
Alex Light5098a612018-11-29 17:12:15 -0800408 default:
Roland Levillain4644b222019-07-31 14:09:17 +0100409 panic(fmt.Errorf("unknown APEX type %d", a))
Alex Light5098a612018-11-29 17:12:15 -0800410 }
411}
412
Jiyong Parkf653b052019-11-18 15:39:01 +0900413type apexFileClass int
414
415const (
416 etc apexFileClass = iota
417 nativeSharedLib
418 nativeExecutable
419 shBinary
420 pyBinary
421 goBinary
422 javaSharedLib
423 nativeTest
424 app
425)
426
Jiyong Park8fd61922018-11-08 02:50:25 +0900427func (class apexFileClass) NameInMake() string {
428 switch class {
429 case etc:
430 return "ETC"
431 case nativeSharedLib:
432 return "SHARED_LIBRARIES"
Alex Light778127a2019-02-27 14:19:50 -0800433 case nativeExecutable, shBinary, pyBinary, goBinary:
Jiyong Park8fd61922018-11-08 02:50:25 +0900434 return "EXECUTABLES"
435 case javaSharedLib:
436 return "JAVA_LIBRARIES"
Roland Levillain630846d2019-06-26 12:48:34 +0100437 case nativeTest:
438 return "NATIVE_TESTS"
Sundong Ahne1f05aa2019-08-27 13:55:42 +0900439 case app:
Jiyong Parkf383f7c2019-10-11 20:46:25 +0900440 // b/142537672 Why isn't this APP? We want to have full control over
441 // the paths and file names of the apk file under the flattend APEX.
442 // If this is set to APP, then the paths and file names are modified
443 // by the Make build system. For example, it is installed to
444 // /system/apex/<apexname>/app/<Appname>/<apexname>.<Appname>/ instead of
445 // /system/apex/<apexname>/app/<Appname> because the build system automatically
446 // appends module name (which is <apexname>.<Appname> to the path.
447 return "ETC"
Jiyong Park8fd61922018-11-08 02:50:25 +0900448 default:
Roland Levillain4644b222019-07-31 14:09:17 +0100449 panic(fmt.Errorf("unknown class %d", class))
Jiyong Park8fd61922018-11-08 02:50:25 +0900450 }
451}
452
Jiyong Parkf653b052019-11-18 15:39:01 +0900453// apexFile represents a file in an APEX bundle
Jiyong Park8fd61922018-11-08 02:50:25 +0900454type apexFile struct {
455 builtFile android.Path
456 moduleName string
Jiyong Park8fd61922018-11-08 02:50:25 +0900457 installDir string
458 class apexFileClass
Jiyong Parka8894842018-12-19 17:36:39 +0900459 module android.Module
Jiyong Parkf653b052019-11-18 15:39:01 +0900460 // list of symlinks that will be created in installDir that point to this apexFile
461 symlinks []string
462 transitiveDep bool
Jiyong Park1833cef2019-12-13 13:28:36 +0900463 moduleDir string
Jiyong Park7afd1072019-12-30 16:56:33 +0900464
465 requiredModuleNames []string
466 targetRequiredModuleNames []string
467 hostRequiredModuleNames []string
Jiyong Parkf653b052019-11-18 15:39:01 +0900468}
469
Jiyong Park1833cef2019-12-13 13:28:36 +0900470func newApexFile(ctx android.BaseModuleContext, builtFile android.Path, moduleName string, installDir string, class apexFileClass, module android.Module) apexFile {
471 ret := apexFile{
Jiyong Parkf653b052019-11-18 15:39:01 +0900472 builtFile: builtFile,
473 moduleName: moduleName,
474 installDir: installDir,
475 class: class,
476 module: module,
477 }
Jiyong Park1833cef2019-12-13 13:28:36 +0900478 if module != nil {
479 ret.moduleDir = ctx.OtherModuleDir(module)
Jiyong Park7afd1072019-12-30 16:56:33 +0900480 ret.requiredModuleNames = module.RequiredModuleNames()
481 ret.targetRequiredModuleNames = module.TargetRequiredModuleNames()
482 ret.hostRequiredModuleNames = module.HostRequiredModuleNames()
Jiyong Park1833cef2019-12-13 13:28:36 +0900483 }
484 return ret
Jiyong Parkf653b052019-11-18 15:39:01 +0900485}
486
487func (af *apexFile) Ok() bool {
Jiyong Park479321d2019-12-16 11:47:12 +0900488 return af.builtFile != nil && af.builtFile.String() != ""
Jiyong Park8fd61922018-11-08 02:50:25 +0900489}
490
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900491type apexBundle struct {
492 android.ModuleBase
493 android.DefaultableModuleBase
Jiyong Park5d790c32019-11-15 18:40:32 +0900494 android.OverridableModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900495 android.SdkBase
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900496
Jiyong Park5d790c32019-11-15 18:40:32 +0900497 properties apexBundleProperties
498 targetProperties apexTargetBundleProperties
Jiyong Park5d790c32019-11-15 18:40:32 +0900499 overridableProperties overridableProperties
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900500
Jooyung Hanf21c7972019-12-16 22:32:06 +0900501 // specific to apex_vndk modules
502 vndkProperties apexVndkProperties
503
Colin Crossa4925902018-11-16 11:36:28 -0800504 bundleModuleFile android.WritablePath
Sundong Ahnabb64432019-10-22 13:58:29 +0900505 outputFile android.WritablePath
Colin Cross70dda7e2019-10-01 22:05:35 -0700506 installDir android.InstallPath
Jiyong Park8fd61922018-11-08 02:50:25 +0900507
Jiyong Park03b68dd2019-07-26 23:20:40 +0900508 prebuiltFileToDelete string
509
Jiyong Park42cca6c2019-04-01 11:15:50 +0900510 public_key_file android.Path
511 private_key_file android.Path
Jiyong Park0ca3ce82019-02-18 15:25:04 +0900512
513 container_certificate_file android.Path
514 container_private_key_file android.Path
515
Jooyung Han54aca7b2019-11-20 02:26:02 +0900516 fileContexts android.Path
517
Jiyong Park8fd61922018-11-08 02:50:25 +0900518 // list of files to be included in this apex
519 filesInfo []apexFile
520
Jiyong Parkac2bacd2019-02-20 21:49:26 +0900521 // list of module names that this APEX is depending on
522 externalDeps []string
523
Sundong Ahnabb64432019-10-22 13:58:29 +0900524 testApex bool
525 vndkApex bool
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000526 artApex bool
Sundong Ahnabb64432019-10-22 13:58:29 +0900527 primaryApexType bool
Jooyung Hane1633032019-08-01 17:41:43 +0900528
Jooyung Han214bf372019-11-12 13:03:50 +0900529 manifestJsonOut android.WritablePath
530 manifestPbOut android.WritablePath
Jooyung Han72bd2f82019-10-23 16:46:38 +0900531
532 // list of commands to create symlinks for backward compatibility
533 // these commands will be attached as LOCAL_POST_INSTALL_CMD to
534 // apex package itself(for unflattened build) or apex_manifest.json(for flattened build)
535 // so that compat symlinks are always installed regardless of TARGET_FLATTEN_APEX setting.
536 compatSymlinks []string
Sundong Ahnabb64432019-10-22 13:58:29 +0900537
538 // Suffix of module name in Android.mk
539 // ".flattened", ".apex", ".zipapex", or ""
540 suffix string
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900541}
542
Jiyong Park397e55e2018-10-24 21:09:55 +0900543func addDependenciesForNativeModules(ctx android.BottomUpMutatorContext,
Roland Levillain630846d2019-06-26 12:48:34 +0100544 native_shared_libs []string, binaries []string, tests []string,
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700545 target android.Target, imageVariation string) {
Jiyong Park397e55e2018-10-24 21:09:55 +0900546 // Use *FarVariation* to be able to depend on modules having
547 // conflicting variations with this module. This is required since
548 // arch variant of an APEX bundle is 'common' but it is 'arm' or 'arm64'
549 // for native shared libs.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700550 ctx.AddFarVariationDependencies(append(target.Variations(), []blueprint.Variation{
Jiyong Parkda6eb592018-12-19 17:12:36 +0900551 {Mutator: "image", Variation: imageVariation},
Jiyong Park397e55e2018-10-24 21:09:55 +0900552 {Mutator: "link", Variation: "shared"},
Jiyong Park28d395a2018-12-07 22:42:47 +0900553 {Mutator: "version", Variation: ""}, // "" is the non-stub variant
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700554 }...), sharedLibTag, native_shared_libs...)
Jiyong Park397e55e2018-10-24 21:09:55 +0900555
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700556 ctx.AddFarVariationDependencies(append(target.Variations(),
557 blueprint.Variation{Mutator: "image", Variation: imageVariation}),
558 executableTag, binaries...)
Roland Levillain630846d2019-06-26 12:48:34 +0100559
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700560 ctx.AddFarVariationDependencies(append(target.Variations(), []blueprint.Variation{
Roland Levillain630846d2019-06-26 12:48:34 +0100561 {Mutator: "image", Variation: imageVariation},
Roland Levillain9b5fde92019-06-28 15:41:19 +0100562 {Mutator: "test_per_src", Variation: ""}, // "" is the all-tests variant
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700563 }...), testTag, tests...)
Jiyong Park397e55e2018-10-24 21:09:55 +0900564}
565
Alex Light9670d332019-01-29 18:07:33 -0800566func (a *apexBundle) combineProperties(ctx android.BottomUpMutatorContext) {
567 if ctx.Os().Class == android.Device {
568 proptools.AppendProperties(&a.properties.Multilib, &a.targetProperties.Target.Android.Multilib, nil)
569 } else {
570 proptools.AppendProperties(&a.properties.Multilib, &a.targetProperties.Target.Host.Multilib, nil)
571 if ctx.Os().Bionic() {
572 proptools.AppendProperties(&a.properties.Multilib, &a.targetProperties.Target.Linux_bionic.Multilib, nil)
573 } else {
574 proptools.AppendProperties(&a.properties.Multilib, &a.targetProperties.Target.Linux_glibc.Multilib, nil)
575 }
576 }
577}
578
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900579func (a *apexBundle) DepsMutator(ctx android.BottomUpMutatorContext) {
Jooyung Handc782442019-11-01 03:14:38 +0900580 if proptools.Bool(a.properties.Use_vendor) && !android.InList(a.Name(), useVendorWhitelist(ctx.Config())) {
581 ctx.PropertyErrorf("use_vendor", "not allowed to set use_vendor: true")
582 }
583
Jiyong Park397e55e2018-10-24 21:09:55 +0900584 targets := ctx.MultiTargets()
Jiyong Park7c1dc612019-01-05 11:15:24 +0900585 config := ctx.DeviceConfig()
Alex Light9670d332019-01-29 18:07:33 -0800586
587 a.combineProperties(ctx)
588
Jiyong Park397e55e2018-10-24 21:09:55 +0900589 has32BitTarget := false
590 for _, target := range targets {
591 if target.Arch.ArchType.Multilib == "lib32" {
592 has32BitTarget = true
593 }
594 }
595 for i, target := range targets {
596 // When multilib.* is omitted for native_shared_libs, it implies
597 // multilib.both.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700598 ctx.AddFarVariationDependencies(append(target.Variations(), []blueprint.Variation{
Jiyong Park7c1dc612019-01-05 11:15:24 +0900599 {Mutator: "image", Variation: a.getImageVariation(config)},
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900600 {Mutator: "link", Variation: "shared"},
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700601 }...), sharedLibTag, a.properties.Native_shared_libs...)
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900602
Roland Levillain630846d2019-06-26 12:48:34 +0100603 // When multilib.* is omitted for tests, it implies
604 // multilib.both.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700605 ctx.AddFarVariationDependencies(append(target.Variations(), []blueprint.Variation{
Roland Levillain630846d2019-06-26 12:48:34 +0100606 {Mutator: "image", Variation: a.getImageVariation(config)},
Roland Levillain9b5fde92019-06-28 15:41:19 +0100607 {Mutator: "test_per_src", Variation: ""}, // "" is the all-tests variant
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700608 }...), testTag, a.properties.Tests...)
Roland Levillain630846d2019-06-26 12:48:34 +0100609
Jiyong Park397e55e2018-10-24 21:09:55 +0900610 // Add native modules targetting both ABIs
611 addDependenciesForNativeModules(ctx,
612 a.properties.Multilib.Both.Native_shared_libs,
Roland Levillain630846d2019-06-26 12:48:34 +0100613 a.properties.Multilib.Both.Binaries,
614 a.properties.Multilib.Both.Tests,
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700615 target,
Jiyong Park7c1dc612019-01-05 11:15:24 +0900616 a.getImageVariation(config))
Jiyong Park397e55e2018-10-24 21:09:55 +0900617
Alex Light3d673592019-01-18 14:37:31 -0800618 isPrimaryAbi := i == 0
619 if isPrimaryAbi {
Jiyong Park397e55e2018-10-24 21:09:55 +0900620 // When multilib.* is omitted for binaries, it implies
621 // multilib.first.
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700622 ctx.AddFarVariationDependencies(append(target.Variations(),
623 blueprint.Variation{Mutator: "image", Variation: a.getImageVariation(config)}),
624 executableTag, a.properties.Binaries...)
Jiyong Park397e55e2018-10-24 21:09:55 +0900625
626 // Add native modules targetting the first ABI
627 addDependenciesForNativeModules(ctx,
628 a.properties.Multilib.First.Native_shared_libs,
Roland Levillain630846d2019-06-26 12:48:34 +0100629 a.properties.Multilib.First.Binaries,
630 a.properties.Multilib.First.Tests,
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700631 target,
Jiyong Park7c1dc612019-01-05 11:15:24 +0900632 a.getImageVariation(config))
Jiyong Park397e55e2018-10-24 21:09:55 +0900633 }
634
635 switch target.Arch.ArchType.Multilib {
636 case "lib32":
637 // Add native modules targetting 32-bit ABI
638 addDependenciesForNativeModules(ctx,
639 a.properties.Multilib.Lib32.Native_shared_libs,
Roland Levillain630846d2019-06-26 12:48:34 +0100640 a.properties.Multilib.Lib32.Binaries,
641 a.properties.Multilib.Lib32.Tests,
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700642 target,
Jiyong Park7c1dc612019-01-05 11:15:24 +0900643 a.getImageVariation(config))
Jiyong Park397e55e2018-10-24 21:09:55 +0900644
645 addDependenciesForNativeModules(ctx,
646 a.properties.Multilib.Prefer32.Native_shared_libs,
Roland Levillain630846d2019-06-26 12:48:34 +0100647 a.properties.Multilib.Prefer32.Binaries,
648 a.properties.Multilib.Prefer32.Tests,
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700649 target,
Jiyong Park7c1dc612019-01-05 11:15:24 +0900650 a.getImageVariation(config))
Jiyong Park397e55e2018-10-24 21:09:55 +0900651 case "lib64":
652 // Add native modules targetting 64-bit ABI
653 addDependenciesForNativeModules(ctx,
654 a.properties.Multilib.Lib64.Native_shared_libs,
Roland Levillain630846d2019-06-26 12:48:34 +0100655 a.properties.Multilib.Lib64.Binaries,
656 a.properties.Multilib.Lib64.Tests,
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700657 target,
Jiyong Park7c1dc612019-01-05 11:15:24 +0900658 a.getImageVariation(config))
Jiyong Park397e55e2018-10-24 21:09:55 +0900659
660 if !has32BitTarget {
661 addDependenciesForNativeModules(ctx,
662 a.properties.Multilib.Prefer32.Native_shared_libs,
Roland Levillain630846d2019-06-26 12:48:34 +0100663 a.properties.Multilib.Prefer32.Binaries,
664 a.properties.Multilib.Prefer32.Tests,
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700665 target,
Jiyong Park7c1dc612019-01-05 11:15:24 +0900666 a.getImageVariation(config))
Jiyong Park397e55e2018-10-24 21:09:55 +0900667 }
Peter Collingbourne3478bb22019-04-24 14:41:12 -0700668
669 if strings.HasPrefix(ctx.ModuleName(), "com.android.runtime") && target.Os.Class == android.Device {
670 for _, sanitizer := range ctx.Config().SanitizeDevice() {
671 if sanitizer == "hwaddress" {
672 addDependenciesForNativeModules(ctx,
673 []string{"libclang_rt.hwasan-aarch64-android"},
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700674 nil, nil, target, a.getImageVariation(config))
Peter Collingbourne3478bb22019-04-24 14:41:12 -0700675 break
676 }
677 }
678 }
Jiyong Park397e55e2018-10-24 21:09:55 +0900679 }
680
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900681 }
682
Jiyong Parkce6aadc2019-11-20 13:58:28 +0900683 // For prebuilt_etc, use the first variant (64 on 64/32bit device,
684 // 32 on 32bit device) regardless of the TARGET_PREFER_* setting.
685 // b/144532908
686 archForPrebuiltEtc := config.Arches()[0]
687 for _, arch := range config.Arches() {
688 // Prefer 64-bit arch if there is any
689 if arch.ArchType.Multilib == "lib64" {
690 archForPrebuiltEtc = arch
691 break
692 }
693 }
694 ctx.AddFarVariationDependencies([]blueprint.Variation{
695 {Mutator: "os", Variation: ctx.Os().String()},
696 {Mutator: "arch", Variation: archForPrebuiltEtc.String()},
697 }, prebuiltTag, a.properties.Prebuilts...)
698
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700699 ctx.AddFarVariationDependencies(ctx.Config().AndroidCommonTarget.Variations(),
700 javaLibTag, a.properties.Java_libs...)
Jiyong Parkff1458f2018-10-12 21:49:38 +0900701
Jiyong Park23c52b02019-02-02 13:13:47 +0900702 if String(a.properties.Key) == "" {
703 ctx.ModuleErrorf("key is missing")
704 return
705 }
706 ctx.AddDependency(ctx.Module(), keyTag, String(a.properties.Key))
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900707
Jiyong Parkb2742fd2019-02-11 11:38:15 +0900708 cert := android.SrcIsModule(a.getCertString(ctx))
Jiyong Park23c52b02019-02-02 13:13:47 +0900709 if cert != "" {
710 ctx.AddDependency(ctx.Module(), certificateTag, cert)
Jiyong Parkc00cbd92018-10-30 21:20:05 +0900711 }
Jiyong Parkd1063c12019-07-17 20:08:41 +0900712
713 // TODO(jiyong): ensure that all apexes are with non-empty uses_sdks
714 if len(a.properties.Uses_sdks) > 0 {
715 sdkRefs := []android.SdkRef{}
716 for _, str := range a.properties.Uses_sdks {
717 parsed := android.ParseSdkRef(ctx, str, "uses_sdks")
718 sdkRefs = append(sdkRefs, parsed)
719 }
720 a.BuildWithSdks(sdkRefs)
721 }
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900722}
723
Jiyong Park5d790c32019-11-15 18:40:32 +0900724func (a *apexBundle) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
725 ctx.AddFarVariationDependencies(ctx.Config().AndroidCommonTarget.Variations(),
726 androidAppTag, a.overridableProperties.Apps...)
727}
728
Jiyong Parka7bc8ad2019-10-15 15:20:07 +0900729func (a *apexBundle) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
730 // direct deps of an APEX bundle are all part of the APEX bundle
731 return true
732}
733
Colin Cross0ea8ba82019-06-06 14:33:29 -0700734func (a *apexBundle) getCertString(ctx android.BaseModuleContext) string {
Jooyung Han27151d92019-12-16 17:45:32 +0900735 moduleName := ctx.ModuleName()
736 // VNDK APEXes share the same certificate. To avoid adding a new VNDK version to the OVERRIDE_* list,
737 // we check with the pseudo module name to see if its certificate is overridden.
738 if a.vndkApex {
739 moduleName = vndkApexName
740 }
741 certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(moduleName)
Jiyong Parkb2742fd2019-02-11 11:38:15 +0900742 if overridden {
Jaewoong Jungacb6db32019-02-28 16:22:30 +0000743 return ":" + certificate
Jiyong Parkb2742fd2019-02-11 11:38:15 +0900744 }
745 return String(a.properties.Certificate)
746}
747
Colin Cross41955e82019-05-29 14:40:35 -0700748func (a *apexBundle) OutputFiles(tag string) (android.Paths, error) {
749 switch tag {
750 case "":
Sundong Ahnabb64432019-10-22 13:58:29 +0900751 return android.Paths{a.outputFile}, nil
Colin Cross41955e82019-05-29 14:40:35 -0700752 default:
753 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Jiyong Park5a832022018-12-20 09:54:35 +0900754 }
Jiyong Park74e240b2018-11-27 21:27:08 +0900755}
756
Jiyong Park92c0f9c2018-12-13 23:14:57 +0900757func (a *apexBundle) installable() bool {
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900758 return !a.properties.PreventInstall && (a.properties.Installable == nil || proptools.Bool(a.properties.Installable))
Jiyong Park92c0f9c2018-12-13 23:14:57 +0900759}
760
Nikita Ioffec72b5dd2019-12-07 17:30:22 +0000761func (a *apexBundle) testOnlyShouldSkipHashtreeGeneration() bool {
762 return proptools.Bool(a.properties.Test_only_no_hashtree)
763}
764
Jiyong Park7c1dc612019-01-05 11:15:24 +0900765func (a *apexBundle) getImageVariation(config android.DeviceConfig) string {
Jooyung Han31c470b2019-10-18 16:26:59 +0900766 if a.vndkApex {
Colin Cross7228ecd2019-11-18 16:00:16 -0800767 return cc.VendorVariationPrefix + a.vndkVersion(config)
Jooyung Han31c470b2019-10-18 16:26:59 +0900768 }
Jiyong Park7c1dc612019-01-05 11:15:24 +0900769 if config.VndkVersion() != "" && proptools.Bool(a.properties.Use_vendor) {
Colin Cross7228ecd2019-11-18 16:00:16 -0800770 return cc.VendorVariationPrefix + config.PlatformVndkVersion()
Jiyong Parkda6eb592018-12-19 17:12:36 +0900771 } else {
Colin Cross7228ecd2019-11-18 16:00:16 -0800772 return android.CoreVariation
Jiyong Parkda6eb592018-12-19 17:12:36 +0900773 }
774}
775
Jiyong Parkf97782b2019-02-13 20:28:58 +0900776func (a *apexBundle) EnableSanitizer(sanitizerName string) {
777 if !android.InList(sanitizerName, a.properties.SanitizerNames) {
778 a.properties.SanitizerNames = append(a.properties.SanitizerNames, sanitizerName)
779 }
780}
781
Jiyong Park388ef3f2019-01-28 19:47:32 +0900782func (a *apexBundle) IsSanitizerEnabled(ctx android.BaseModuleContext, sanitizerName string) bool {
Jiyong Parkf97782b2019-02-13 20:28:58 +0900783 if android.InList(sanitizerName, a.properties.SanitizerNames) {
784 return true
Jiyong Park235e67c2019-02-09 11:50:56 +0900785 }
786
787 // Then follow the global setting
Jiyong Park388ef3f2019-01-28 19:47:32 +0900788 globalSanitizerNames := []string{}
789 if a.Host() {
790 globalSanitizerNames = ctx.Config().SanitizeHost()
791 } else {
792 arches := ctx.Config().SanitizeDeviceArch()
793 if len(arches) == 0 || android.InList(a.Arch().ArchType.Name, arches) {
794 globalSanitizerNames = ctx.Config().SanitizeDevice()
795 }
796 }
797 return android.InList(sanitizerName, globalSanitizerNames)
Jiyong Park379de2f2018-12-19 02:47:14 +0900798}
799
Jiyong Parkee9a98d2019-08-09 14:44:36 +0900800func (a *apexBundle) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool {
801 return ctx.Device() && ctx.DeviceConfig().NativeCoverageEnabled()
802}
803
804func (a *apexBundle) PreventInstall() {
805 a.properties.PreventInstall = true
806}
807
808func (a *apexBundle) HideFromMake() {
809 a.properties.HideFromMake = true
810}
811
Jiyong Parkf653b052019-11-18 15:39:01 +0900812// TODO(jiyong) move apexFileFor* close to the apexFile type definition
Jiyong Park1833cef2019-12-13 13:28:36 +0900813func apexFileForNativeLibrary(ctx android.BaseModuleContext, ccMod *cc.Module, handleSpecialLibs bool) apexFile {
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900814 // Decide the APEX-local directory by the multilib of the library
815 // In the future, we may query this to the module.
Jiyong Parkf653b052019-11-18 15:39:01 +0900816 var dirInApex string
Martin Stjernholm279de572019-09-10 23:18:20 +0100817 switch ccMod.Arch().ArchType.Multilib {
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900818 case "lib32":
819 dirInApex = "lib"
820 case "lib64":
821 dirInApex = "lib64"
822 }
Martin Stjernholm279de572019-09-10 23:18:20 +0100823 dirInApex = filepath.Join(dirInApex, ccMod.RelativeInstallPath())
Colin Cross3b19f5d2019-09-17 14:45:31 -0700824 if ccMod.Target().NativeBridge == android.NativeBridgeEnabled {
Martin Stjernholm279de572019-09-10 23:18:20 +0100825 dirInApex = filepath.Join(dirInApex, ccMod.Target().NativeBridgeRelativePath)
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900826 }
Jiyong Park1833cef2019-12-13 13:28:36 +0900827 if handleSpecialLibs && cc.InstallToBootstrap(ccMod.BaseModuleName(), ctx.Config()) {
Martin Stjernholm279de572019-09-10 23:18:20 +0100828 // Special case for Bionic libs and other libs installed with them. This is
829 // to prevent those libs from being included in the search path
830 // /apex/com.android.runtime/${LIB}. This exclusion is required because
831 // those libs in the Runtime APEX are available via the legacy paths in
832 // /system/lib/. By the init process, the libs in the APEX are bind-mounted
833 // to the legacy paths and thus will be loaded into the default linker
834 // namespace (aka "platform" namespace). If the libs are directly in
835 // /apex/com.android.runtime/${LIB} then the same libs will be loaded again
836 // into the runtime linker namespace, which will result in double loading of
837 // them, which isn't supported.
838 dirInApex = filepath.Join(dirInApex, "bionic")
Jiyong Parkb0788572018-12-20 22:10:17 +0900839 }
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900840
Jiyong Parkf653b052019-11-18 15:39:01 +0900841 fileToCopy := ccMod.OutputFile().Path()
Jiyong Park1833cef2019-12-13 13:28:36 +0900842 return newApexFile(ctx, fileToCopy, ccMod.Name(), dirInApex, nativeSharedLib, ccMod)
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900843}
844
Jiyong Park1833cef2019-12-13 13:28:36 +0900845func apexFileForExecutable(ctx android.BaseModuleContext, cc *cc.Module) apexFile {
Jiyong Parkf653b052019-11-18 15:39:01 +0900846 dirInApex := filepath.Join("bin", cc.RelativeInstallPath())
Colin Cross3b19f5d2019-09-17 14:45:31 -0700847 if cc.Target().NativeBridge == android.NativeBridgeEnabled {
dimitry8d6dde82019-07-11 10:23:53 +0200848 dirInApex = filepath.Join(dirInApex, cc.Target().NativeBridgeRelativePath)
Jiyong Parkacbf6c72019-07-09 16:19:16 +0900849 }
Jiyong Parkf653b052019-11-18 15:39:01 +0900850 fileToCopy := cc.OutputFile().Path()
Jiyong Park1833cef2019-12-13 13:28:36 +0900851 af := newApexFile(ctx, fileToCopy, cc.Name(), dirInApex, nativeExecutable, cc)
Jiyong Parkf653b052019-11-18 15:39:01 +0900852 af.symlinks = cc.Symlinks()
853 return af
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900854}
855
Jiyong Park1833cef2019-12-13 13:28:36 +0900856func apexFileForPyBinary(ctx android.BaseModuleContext, py *python.Module) apexFile {
Jiyong Parkf653b052019-11-18 15:39:01 +0900857 dirInApex := "bin"
858 fileToCopy := py.HostToolPath().Path()
Jiyong Park1833cef2019-12-13 13:28:36 +0900859 return newApexFile(ctx, fileToCopy, py.Name(), dirInApex, pyBinary, py)
Alex Light778127a2019-02-27 14:19:50 -0800860}
Jiyong Park1833cef2019-12-13 13:28:36 +0900861func apexFileForGoBinary(ctx android.BaseModuleContext, depName string, gb bootstrap.GoBinaryTool) apexFile {
Jiyong Parkf653b052019-11-18 15:39:01 +0900862 dirInApex := "bin"
Alex Light778127a2019-02-27 14:19:50 -0800863 s, err := filepath.Rel(android.PathForOutput(ctx).String(), gb.InstallPath())
864 if err != nil {
865 ctx.ModuleErrorf("Unable to use compiled binary at %s", gb.InstallPath())
Jiyong Parkf653b052019-11-18 15:39:01 +0900866 return apexFile{}
Alex Light778127a2019-02-27 14:19:50 -0800867 }
Jiyong Parkf653b052019-11-18 15:39:01 +0900868 fileToCopy := android.PathForOutput(ctx, s)
869 // NB: Since go binaries are static we don't need the module for anything here, which is
870 // good since the go tool is a blueprint.Module not an android.Module like we would
871 // normally use.
Jiyong Park1833cef2019-12-13 13:28:36 +0900872 return newApexFile(ctx, fileToCopy, depName, dirInApex, goBinary, nil)
Alex Light778127a2019-02-27 14:19:50 -0800873}
874
Jiyong Park1833cef2019-12-13 13:28:36 +0900875func apexFileForShBinary(ctx android.BaseModuleContext, sh *android.ShBinary) apexFile {
Jiyong Parkf653b052019-11-18 15:39:01 +0900876 dirInApex := filepath.Join("bin", sh.SubDir())
877 fileToCopy := sh.OutputFile()
Jiyong Park1833cef2019-12-13 13:28:36 +0900878 af := newApexFile(ctx, fileToCopy, sh.Name(), dirInApex, shBinary, sh)
Jiyong Parkf653b052019-11-18 15:39:01 +0900879 af.symlinks = sh.Symlinks()
880 return af
Jiyong Park04480cf2019-02-06 00:16:29 +0900881}
882
Jooyung Han58f26ab2019-12-18 15:34:32 +0900883// TODO(b/146586360): replace javaLibrary(in apex/apex.go) with java.Dependency
884type javaLibrary interface {
885 android.Module
886 java.Dependency
887}
888
889func apexFileForJavaLibrary(ctx android.BaseModuleContext, lib javaLibrary) apexFile {
Jiyong Parkf653b052019-11-18 15:39:01 +0900890 dirInApex := "javalib"
Jooyung Han58f26ab2019-12-18 15:34:32 +0900891 fileToCopy := lib.DexJar()
892 return newApexFile(ctx, fileToCopy, lib.Name(), dirInApex, javaSharedLib, lib)
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900893}
894
Jiyong Park1833cef2019-12-13 13:28:36 +0900895func apexFileForPrebuiltEtc(ctx android.BaseModuleContext, prebuilt android.PrebuiltEtcModule, depName string) apexFile {
Jiyong Parkf653b052019-11-18 15:39:01 +0900896 dirInApex := filepath.Join("etc", prebuilt.SubDir())
897 fileToCopy := prebuilt.OutputFile()
Jiyong Park1833cef2019-12-13 13:28:36 +0900898 return newApexFile(ctx, fileToCopy, depName, dirInApex, etc, prebuilt)
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900899}
900
Jiyong Park1833cef2019-12-13 13:28:36 +0900901func apexFileForAndroidApp(ctx android.BaseModuleContext, aapp interface {
Jiyong Parkf653b052019-11-18 15:39:01 +0900902 android.Module
903 Privileged() bool
904 OutputFile() android.Path
905}, pkgName string) apexFile {
Jiyong Parkf7487312019-10-17 12:54:30 +0900906 appDir := "app"
Jiyong Parkf653b052019-11-18 15:39:01 +0900907 if aapp.Privileged() {
Jiyong Parkf7487312019-10-17 12:54:30 +0900908 appDir = "priv-app"
909 }
Jiyong Parkf653b052019-11-18 15:39:01 +0900910 dirInApex := filepath.Join(appDir, pkgName)
911 fileToCopy := aapp.OutputFile()
Jiyong Park1833cef2019-12-13 13:28:36 +0900912 return newApexFile(ctx, fileToCopy, aapp.Name(), dirInApex, app, aapp)
Dario Frenicde2a032019-10-27 00:29:22 +0100913}
914
Roland Levillain935639d2019-08-13 14:55:28 +0100915// Context "decorator", overriding the InstallBypassMake method to always reply `true`.
916type flattenedApexContext struct {
917 android.ModuleContext
918}
919
920func (c *flattenedApexContext) InstallBypassMake() bool {
921 return true
922}
923
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900924func (a *apexBundle) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Sundong Ahnabb64432019-10-22 13:58:29 +0900925 buildFlattenedAsDefault := ctx.Config().FlattenApex() && !ctx.Config().UnbundledBuild()
926 switch a.properties.ApexType {
927 case imageApex:
928 if buildFlattenedAsDefault {
929 a.suffix = imageApexSuffix
930 } else {
931 a.suffix = ""
932 a.primaryApexType = true
Jooyung Han3ab2c3e2019-12-05 16:27:44 +0900933
934 if ctx.Config().InstallExtraFlattenedApexes() {
935 a.externalDeps = append(a.externalDeps, a.Name()+flattenedSuffix)
936 }
Sundong Ahnabb64432019-10-22 13:58:29 +0900937 }
938 case zipApex:
939 if proptools.String(a.properties.Payload_type) == "zip" {
940 a.suffix = ""
941 a.primaryApexType = true
942 } else {
943 a.suffix = zipApexSuffix
944 }
945 case flattenedApex:
946 if buildFlattenedAsDefault {
947 a.suffix = ""
948 a.primaryApexType = true
949 } else {
950 a.suffix = flattenedSuffix
951 }
Alex Light5098a612018-11-29 17:12:15 -0800952 }
953
Roland Levillain630846d2019-06-26 12:48:34 +0100954 if len(a.properties.Tests) > 0 && !a.testApex {
955 ctx.PropertyErrorf("tests", "property not allowed in apex module type")
956 return
957 }
958
Alex Lightfc0bd7c2019-01-29 18:31:59 -0800959 handleSpecialLibs := !android.Bool(a.properties.Ignore_system_library_special_case)
960
Jooyung Hane1633032019-08-01 17:41:43 +0900961 // native lib dependencies
962 var provideNativeLibs []string
963 var requireNativeLibs []string
964
Jooyung Han5c998b92019-06-27 11:30:33 +0900965 // Check if "uses" requirements are met with dependent apexBundles
966 var providedNativeSharedLibs []string
967 useVendor := proptools.Bool(a.properties.Use_vendor)
968 ctx.VisitDirectDepsBlueprint(func(m blueprint.Module) {
969 if ctx.OtherModuleDependencyTag(m) != usesTag {
970 return
971 }
972 otherName := ctx.OtherModuleName(m)
973 other, ok := m.(*apexBundle)
974 if !ok {
975 ctx.PropertyErrorf("uses", "%q is not a provider", otherName)
976 return
977 }
978 if proptools.Bool(other.properties.Use_vendor) != useVendor {
979 ctx.PropertyErrorf("use_vendor", "%q has different value of use_vendor", otherName)
980 return
981 }
982 if !proptools.Bool(other.properties.Provide_cpp_shared_libs) {
983 ctx.PropertyErrorf("uses", "%q does not provide native_shared_libs", otherName)
984 return
985 }
986 providedNativeSharedLibs = append(providedNativeSharedLibs, other.properties.Native_shared_libs...)
987 })
988
Jiyong Parkf653b052019-11-18 15:39:01 +0900989 var filesInfo []apexFile
Alex Light778127a2019-02-27 14:19:50 -0800990 ctx.WalkDepsBlueprint(func(child, parent blueprint.Module) bool {
Roland Levillainf89cd092019-07-29 16:22:59 +0100991 depTag := ctx.OtherModuleDependencyTag(child)
992 depName := ctx.OtherModuleName(child)
Jiyong Parkf653b052019-11-18 15:39:01 +0900993 if _, isDirectDep := parent.(*apexBundle); isDirectDep {
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900994 switch depTag {
995 case sharedLibTag:
996 if cc, ok := child.(*cc.Module); ok {
Jooyung Hane1633032019-08-01 17:41:43 +0900997 if cc.HasStubsVariants() {
998 provideNativeLibs = append(provideNativeLibs, cc.OutputFile().Path().Base())
999 }
Jiyong Park1833cef2019-12-13 13:28:36 +09001000 filesInfo = append(filesInfo, apexFileForNativeLibrary(ctx, cc, handleSpecialLibs))
Jiyong Parkf653b052019-11-18 15:39:01 +09001001 return true // track transitive dependencies
Jiyong Parkff1458f2018-10-12 21:49:38 +09001002 } else {
1003 ctx.PropertyErrorf("native_shared_libs", "%q is not a cc_library or cc_library_shared module", depName)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001004 }
1005 case executableTag:
1006 if cc, ok := child.(*cc.Module); ok {
Jiyong Park1833cef2019-12-13 13:28:36 +09001007 filesInfo = append(filesInfo, apexFileForExecutable(ctx, cc))
Jiyong Parkf653b052019-11-18 15:39:01 +09001008 return true // track transitive dependencies
Jiyong Park04480cf2019-02-06 00:16:29 +09001009 } else if sh, ok := child.(*android.ShBinary); ok {
Jiyong Park1833cef2019-12-13 13:28:36 +09001010 filesInfo = append(filesInfo, apexFileForShBinary(ctx, sh))
Alex Light778127a2019-02-27 14:19:50 -08001011 } else if py, ok := child.(*python.Module); ok && py.HostToolPath().Valid() {
Jiyong Park1833cef2019-12-13 13:28:36 +09001012 filesInfo = append(filesInfo, apexFileForPyBinary(ctx, py))
Alex Light778127a2019-02-27 14:19:50 -08001013 } else if gb, ok := child.(bootstrap.GoBinaryTool); ok && a.Host() {
Jiyong Parkf653b052019-11-18 15:39:01 +09001014 filesInfo = append(filesInfo, apexFileForGoBinary(ctx, depName, gb))
Jiyong Parkff1458f2018-10-12 21:49:38 +09001015 } else {
Alex Light778127a2019-02-27 14:19:50 -08001016 ctx.PropertyErrorf("binaries", "%q is neither cc_binary, (embedded) py_binary, (host) blueprint_go_binary, (host) bootstrap_go_binary, nor sh_binary", depName)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001017 }
1018 case javaLibTag:
Jiyong Park9e6c2422019-08-09 20:39:45 +09001019 if javaLib, ok := child.(*java.Library); ok {
Jiyong Park1833cef2019-12-13 13:28:36 +09001020 af := apexFileForJavaLibrary(ctx, javaLib)
Jiyong Parkf653b052019-11-18 15:39:01 +09001021 if !af.Ok() {
Jiyong Park8fd61922018-11-08 02:50:25 +09001022 ctx.PropertyErrorf("java_libs", "%q is not configured to be compiled into dex", depName)
1023 } else {
Jiyong Parkf653b052019-11-18 15:39:01 +09001024 filesInfo = append(filesInfo, af)
1025 return true // track transitive dependencies
Jiyong Park9e6c2422019-08-09 20:39:45 +09001026 }
Jooyung Han58f26ab2019-12-18 15:34:32 +09001027 } else if sdkLib, ok := child.(*java.SdkLibrary); ok {
1028 af := apexFileForJavaLibrary(ctx, sdkLib)
1029 if !af.Ok() {
1030 ctx.PropertyErrorf("java_libs", "%q is not configured to be compiled into dex", depName)
1031 return false
1032 }
1033 filesInfo = append(filesInfo, af)
1034
Jooyung Han624058e2019-12-24 18:38:06 +09001035 pf, _ := sdkLib.OutputFiles(".xml")
1036 if len(pf) != 1 {
Jooyung Han58f26ab2019-12-18 15:34:32 +09001037 ctx.PropertyErrorf("java_libs", "%q failed to generate permission XML", depName)
1038 return false
1039 }
Jooyung Han624058e2019-12-24 18:38:06 +09001040 filesInfo = append(filesInfo, newApexFile(ctx, pf[0], pf[0].Base(), "etc/permissions", etc, nil))
Jooyung Han58f26ab2019-12-18 15:34:32 +09001041 return true // track transitive dependencies
Jiyong Parkff1458f2018-10-12 21:49:38 +09001042 } else {
Jiyong Park9e6c2422019-08-09 20:39:45 +09001043 ctx.PropertyErrorf("java_libs", "%q of type %q is not supported", depName, ctx.OtherModuleType(child))
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001044 }
Jiyong Parkf653b052019-11-18 15:39:01 +09001045 case androidAppTag:
1046 pkgName := ctx.DeviceConfig().OverridePackageNameFor(depName)
1047 if ap, ok := child.(*java.AndroidApp); ok {
Jiyong Park1833cef2019-12-13 13:28:36 +09001048 filesInfo = append(filesInfo, apexFileForAndroidApp(ctx, ap, pkgName))
Jiyong Parkf653b052019-11-18 15:39:01 +09001049 return true // track transitive dependencies
1050 } else if ap, ok := child.(*java.AndroidAppImport); ok {
Jiyong Park1833cef2019-12-13 13:28:36 +09001051 filesInfo = append(filesInfo, apexFileForAndroidApp(ctx, ap, pkgName))
Dario Freni6f3937c2019-12-20 22:58:03 +00001052 } else if ap, ok := child.(*java.AndroidTestHelperApp); ok {
1053 filesInfo = append(filesInfo, apexFileForAndroidApp(ctx, ap, pkgName))
Jiyong Parkf653b052019-11-18 15:39:01 +09001054 } else {
1055 ctx.PropertyErrorf("apps", "%q is not an android_app module", depName)
1056 }
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001057 case prebuiltTag:
Jooyung Han39edb6c2019-11-06 16:53:07 +09001058 if prebuilt, ok := child.(android.PrebuiltEtcModule); ok {
Jiyong Park1833cef2019-12-13 13:28:36 +09001059 filesInfo = append(filesInfo, apexFileForPrebuiltEtc(ctx, prebuilt, depName))
Jiyong Parkff1458f2018-10-12 21:49:38 +09001060 } else {
1061 ctx.PropertyErrorf("prebuilts", "%q is not a prebuilt_etc module", depName)
1062 }
Roland Levillain630846d2019-06-26 12:48:34 +01001063 case testTag:
Roland Levillainf89cd092019-07-29 16:22:59 +01001064 if ccTest, ok := child.(*cc.Module); ok {
1065 if ccTest.IsTestPerSrcAllTestsVariation() {
1066 // Multiple-output test module (where `test_per_src: true`).
1067 //
1068 // `ccTest` is the "" ("all tests") variation of a `test_per_src` module.
1069 // We do not add this variation to `filesInfo`, as it has no output;
1070 // however, we do add the other variations of this module as indirect
1071 // dependencies (see below).
1072 return true
Roland Levillain9b5fde92019-06-28 15:41:19 +01001073 } else {
Roland Levillainf89cd092019-07-29 16:22:59 +01001074 // Single-output test module (where `test_per_src: false`).
Jiyong Park1833cef2019-12-13 13:28:36 +09001075 af := apexFileForExecutable(ctx, ccTest)
Jiyong Parkf653b052019-11-18 15:39:01 +09001076 af.class = nativeTest
1077 filesInfo = append(filesInfo, af)
Roland Levillain9b5fde92019-06-28 15:41:19 +01001078 }
Roland Levillain630846d2019-06-26 12:48:34 +01001079 } else {
1080 ctx.PropertyErrorf("tests", "%q is not a cc module", depName)
1081 }
Jiyong Parkff1458f2018-10-12 21:49:38 +09001082 case keyTag:
1083 if key, ok := child.(*apexKey); ok {
Jiyong Park0ca3ce82019-02-18 15:25:04 +09001084 a.private_key_file = key.private_key_file
1085 a.public_key_file = key.public_key_file
Jiyong Parkff1458f2018-10-12 21:49:38 +09001086 } else {
1087 ctx.PropertyErrorf("key", "%q is not an apex_key module", depName)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001088 }
Jiyong Parkf653b052019-11-18 15:39:01 +09001089 return false
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001090 case certificateTag:
1091 if dep, ok := child.(*java.AndroidAppCertificate); ok {
Jiyong Park0ca3ce82019-02-18 15:25:04 +09001092 a.container_certificate_file = dep.Certificate.Pem
1093 a.container_private_key_file = dep.Certificate.Key
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001094 } else {
1095 ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", depName)
1096 }
Jiyong Park03b68dd2019-07-26 23:20:40 +09001097 case android.PrebuiltDepTag:
1098 // If the prebuilt is force disabled, remember to delete the prebuilt file
1099 // that might have been installed in the previous builds
1100 if prebuilt, ok := child.(*Prebuilt); ok && prebuilt.isForceDisabled() {
1101 a.prebuiltFileToDelete = prebuilt.InstallFilename()
1102 }
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001103 }
Jooyung Han8aee2042019-10-29 05:08:31 +09001104 } else if !a.vndkApex {
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001105 // indirect dependencies
Jooyung Han9c80bae2019-08-20 17:30:57 +09001106 if am, ok := child.(android.ApexModule); ok {
Roland Levillainf89cd092019-07-29 16:22:59 +01001107 // We cannot use a switch statement on `depTag` here as the checked
1108 // tags used below are private (e.g. `cc.sharedDepTag`).
Jiyong Park52cd06f2019-11-11 10:14:32 +09001109 if cc.IsSharedDepTag(depTag) || cc.IsRuntimeDepTag(depTag) {
Roland Levillainf89cd092019-07-29 16:22:59 +01001110 if cc, ok := child.(*cc.Module); ok {
1111 if android.InList(cc.Name(), providedNativeSharedLibs) {
1112 // If we're using a shared library which is provided from other APEX,
1113 // don't include it in this APEX
1114 return false
Jiyong Parkac2bacd2019-02-20 21:49:26 +09001115 }
Jooyung Han671f1ce2019-12-17 12:47:13 +09001116 if !a.Host() && !android.DirectlyInApex(ctx.ModuleName(), ctx.OtherModuleName(cc)) && (cc.IsStubs() || cc.HasStubsVariants()) {
Roland Levillainf89cd092019-07-29 16:22:59 +01001117 // If the dependency is a stubs lib, don't include it in this APEX,
1118 // but make sure that the lib is installed on the device.
1119 // In case no APEX is having the lib, the lib is installed to the system
1120 // partition.
1121 //
1122 // Always include if we are a host-apex however since those won't have any
1123 // system libraries.
1124 if !android.DirectlyInAnyApex(ctx, cc.Name()) && !android.InList(cc.Name(), a.externalDeps) {
1125 a.externalDeps = append(a.externalDeps, cc.Name())
1126 }
Jooyung Hane1633032019-08-01 17:41:43 +09001127 requireNativeLibs = append(requireNativeLibs, cc.OutputFile().Path().Base())
Roland Levillainf89cd092019-07-29 16:22:59 +01001128 // Don't track further
1129 return false
1130 }
Jiyong Park1833cef2019-12-13 13:28:36 +09001131 af := apexFileForNativeLibrary(ctx, cc, handleSpecialLibs)
Jiyong Parkf653b052019-11-18 15:39:01 +09001132 af.transitiveDep = true
1133 filesInfo = append(filesInfo, af)
1134 return true // track transitive dependencies
Jiyong Park25fc6a92018-11-18 18:02:45 +09001135 }
Roland Levillainf89cd092019-07-29 16:22:59 +01001136 } else if cc.IsTestPerSrcDepTag(depTag) {
1137 if cc, ok := child.(*cc.Module); ok {
Jiyong Park1833cef2019-12-13 13:28:36 +09001138 af := apexFileForExecutable(ctx, cc)
Roland Levillainf89cd092019-07-29 16:22:59 +01001139 // Handle modules created as `test_per_src` variations of a single test module:
1140 // use the name of the generated test binary (`fileToCopy`) instead of the name
1141 // of the original test module (`depName`, shared by all `test_per_src`
1142 // variations of that module).
Jiyong Parkf653b052019-11-18 15:39:01 +09001143 af.moduleName = filepath.Base(af.builtFile.String())
1144 af.transitiveDep = true
1145 filesInfo = append(filesInfo, af)
1146 return true // track transitive dependencies
Roland Levillainf89cd092019-07-29 16:22:59 +01001147 }
Jiyong Park52cd06f2019-11-11 10:14:32 +09001148 } else if java.IsJniDepTag(depTag) {
1149 // Do nothing for JNI dep. JNI libraries are always embedded in APK-in-APEX.
Jiyong Parkf653b052019-11-18 15:39:01 +09001150 return true
Jooyung Han9c80bae2019-08-20 17:30:57 +09001151 } else if am.CanHaveApexVariants() && am.IsInstallableToApex() {
Roland Levillainf89cd092019-07-29 16:22:59 +01001152 ctx.ModuleErrorf("unexpected tag %q for indirect dependency %q", depTag, depName)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001153 }
1154 }
1155 }
1156 return false
1157 })
1158
Ulyana Trafimovichde534412019-11-08 10:51:01 +00001159 // Specific to the ART apex: dexpreopt artifacts for libcore Java libraries.
1160 // Build rules are generated by the dexpreopt singleton, and here we access build artifacts
1161 // via the global boot image config.
1162 if a.artApex {
1163 for arch, files := range java.DexpreoptedArtApexJars(ctx) {
1164 dirInApex := filepath.Join("javalib", arch.String())
1165 for _, f := range files {
1166 localModule := "javalib_" + arch.String() + "_" + filepath.Base(f.String())
Jiyong Park1833cef2019-12-13 13:28:36 +09001167 af := newApexFile(ctx, f, localModule, dirInApex, etc, nil)
Jiyong Parkf653b052019-11-18 15:39:01 +09001168 filesInfo = append(filesInfo, af)
Ulyana Trafimovichde534412019-11-08 10:51:01 +00001169 }
1170 }
1171 }
1172
Jiyong Park0ca3ce82019-02-18 15:25:04 +09001173 if a.private_key_file == nil {
Jiyong Parkfa0a3732018-11-09 05:52:26 +09001174 ctx.PropertyErrorf("key", "private_key for %q could not be found", String(a.properties.Key))
1175 return
1176 }
1177
Jiyong Park8fd61922018-11-08 02:50:25 +09001178 // remove duplicates in filesInfo
1179 removeDup := func(filesInfo []apexFile) []apexFile {
Jooyung Han344d5432019-08-23 11:17:39 +09001180 encountered := make(map[string]bool)
Jiyong Park8fd61922018-11-08 02:50:25 +09001181 result := []apexFile{}
1182 for _, f := range filesInfo {
Jooyung Han344d5432019-08-23 11:17:39 +09001183 dest := filepath.Join(f.installDir, f.builtFile.Base())
1184 if !encountered[dest] {
1185 encountered[dest] = true
Jiyong Park8fd61922018-11-08 02:50:25 +09001186 result = append(result, f)
1187 }
1188 }
1189 return result
1190 }
1191 filesInfo = removeDup(filesInfo)
1192
1193 // to have consistent build rules
1194 sort.Slice(filesInfo, func(i, j int) bool {
1195 return filesInfo[i].builtFile.String() < filesInfo[j].builtFile.String()
1196 })
1197
Jiyong Park127b40b2019-09-30 16:04:35 +09001198 // check apex_available requirements
Jiyong Park3814f4d2019-12-02 13:08:53 +09001199 if !ctx.Host() && !a.testApex {
Jiyong Park583a2262019-10-08 20:55:38 +09001200 for _, fi := range filesInfo {
1201 if am, ok := fi.module.(android.ApexModule); ok {
1202 if !am.AvailableFor(ctx.ModuleName()) {
1203 ctx.ModuleErrorf("requires %q that is not available for the APEX", fi.module.Name())
Jiyong Park3814f4d2019-12-02 13:08:53 +09001204 // don't stop so that we can report other violations in the same run
Jiyong Park583a2262019-10-08 20:55:38 +09001205 }
Jiyong Park127b40b2019-09-30 16:04:35 +09001206 }
1207 }
1208 }
1209
Jiyong Park8fd61922018-11-08 02:50:25 +09001210 // prepend the name of this APEX to the module names. These names will be the names of
1211 // modules that will be defined if the APEX is flattened.
1212 for i := range filesInfo {
Jaewoong Jung1670ca02019-11-22 14:50:42 -08001213 filesInfo[i].moduleName = filesInfo[i].moduleName + "." + a.Name() + a.suffix
Jiyong Park8fd61922018-11-08 02:50:25 +09001214 }
1215
Jiyong Park8fd61922018-11-08 02:50:25 +09001216 a.installDir = android.PathForModuleInstall(ctx, "apex")
1217 a.filesInfo = filesInfo
Alex Light5098a612018-11-29 17:12:15 -08001218
Jooyung Han54aca7b2019-11-20 02:26:02 +09001219 if a.properties.ApexType != zipApex {
1220 if a.properties.File_contexts == nil {
1221 a.fileContexts = android.PathForSource(ctx, "system/sepolicy/apex", ctx.ModuleName()+"-file_contexts")
1222 } else {
1223 a.fileContexts = android.PathForModuleSrc(ctx, *a.properties.File_contexts)
1224 if a.Platform() {
1225 if matched, err := path.Match("system/sepolicy/**/*", a.fileContexts.String()); err != nil || !matched {
1226 ctx.PropertyErrorf("file_contexts", "should be under system/sepolicy, but %q", a.fileContexts)
1227 }
1228 }
1229 }
1230 if !android.ExistentPathForSource(ctx, a.fileContexts.String()).Valid() {
1231 ctx.PropertyErrorf("file_contexts", "cannot find file_contexts file: %q", a.fileContexts)
1232 return
1233 }
1234 }
1235
Jooyung Hand15aa1f2019-09-27 00:38:03 +09001236 // prepare apex_manifest.json
Jooyung Han01a3ee22019-11-02 02:52:25 +09001237 a.buildManifest(ctx, provideNativeLibs, requireNativeLibs)
1238
1239 a.setCertificateAndPrivateKey(ctx)
1240 if a.properties.ApexType == flattenedApex {
1241 a.buildFlattenedApex(ctx)
1242 } else {
1243 a.buildUnflattenedApex(ctx)
1244 }
1245
Jaewoong Jung1670ca02019-11-22 14:50:42 -08001246 apexName := proptools.StringDefault(a.properties.Apex_name, a.Name())
Jooyung Han01a3ee22019-11-02 02:52:25 +09001247 a.compatSymlinks = makeCompatSymlinks(apexName, ctx)
1248}
1249
Jooyung Han344d5432019-08-23 11:17:39 +09001250func newApexBundle() *apexBundle {
Sundong Ahnabb64432019-10-22 13:58:29 +09001251 module := &apexBundle{}
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001252 module.AddProperties(&module.properties)
Alex Light9670d332019-01-29 18:07:33 -08001253 module.AddProperties(&module.targetProperties)
Jiyong Park5d790c32019-11-15 18:40:32 +09001254 module.AddProperties(&module.overridableProperties)
Alex Light5098a612018-11-29 17:12:15 -08001255 module.Prefer32(func(ctx android.BaseModuleContext, base *android.ModuleBase, class android.OsClass) bool {
Jiyong Park397e55e2018-10-24 21:09:55 +09001256 return class == android.Device && ctx.Config().DevicePrefer32BitExecutables()
1257 })
Alex Light5098a612018-11-29 17:12:15 -08001258 android.InitAndroidMultiTargetsArchModule(module, android.HostAndDeviceSupported, android.MultilibCommon)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001259 android.InitDefaultableModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09001260 android.InitSdkAwareModule(module)
Jaewoong Jung7abcf8e2019-12-19 17:32:06 -08001261 android.InitOverridableModule(module, &module.overridableProperties.Overrides)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001262 return module
1263}
Jiyong Park30ca9372019-02-07 16:27:23 +09001264
Ulyana Trafimovichde534412019-11-08 10:51:01 +00001265func ApexBundleFactory(testApex bool, artApex bool) android.Module {
Jooyung Han344d5432019-08-23 11:17:39 +09001266 bundle := newApexBundle()
1267 bundle.testApex = testApex
Ulyana Trafimovichde534412019-11-08 10:51:01 +00001268 bundle.artApex = artApex
Jooyung Han344d5432019-08-23 11:17:39 +09001269 return bundle
1270}
1271
1272func testApexBundleFactory() android.Module {
1273 bundle := newApexBundle()
1274 bundle.testApex = true
1275 return bundle
1276}
1277
Jiyong Parkd1063c12019-07-17 20:08:41 +09001278func BundleFactory() android.Module {
Jooyung Han344d5432019-08-23 11:17:39 +09001279 return newApexBundle()
1280}
1281
Jiyong Park30ca9372019-02-07 16:27:23 +09001282//
1283// Defaults
1284//
1285type Defaults struct {
1286 android.ModuleBase
1287 android.DefaultsModuleBase
1288}
1289
Jiyong Park30ca9372019-02-07 16:27:23 +09001290func defaultsFactory() android.Module {
1291 return DefaultsFactory()
1292}
1293
1294func DefaultsFactory(props ...interface{}) android.Module {
1295 module := &Defaults{}
1296
1297 module.AddProperties(props...)
1298 module.AddProperties(
1299 &apexBundleProperties{},
1300 &apexTargetBundleProperties{},
Jooyung Hanf21c7972019-12-16 22:32:06 +09001301 &overridableProperties{},
Jiyong Park30ca9372019-02-07 16:27:23 +09001302 )
1303
1304 android.InitDefaultsModule(module)
1305 return module
1306}
Jiyong Park5d790c32019-11-15 18:40:32 +09001307
1308//
1309// OverrideApex
1310//
1311type OverrideApex struct {
1312 android.ModuleBase
1313 android.OverrideModuleBase
1314}
1315
1316func (o *OverrideApex) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1317 // All the overrides happen in the base module.
1318}
1319
1320// override_apex is used to create an apex module based on another apex module
1321// by overriding some of its properties.
1322func overrideApexFactory() android.Module {
1323 m := &OverrideApex{}
1324 m.AddProperties(&overridableProperties{})
1325
1326 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
1327 android.InitOverrideModule(m)
1328 return m
1329}