blob: 6ae6cd9591c6f13ab3d63165c8f3fa8928a55be5 [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"
Paul Duffinf0207962020-03-31 11:31:36 +010021 "regexp"
Jiyong Parkab3ceb32018-10-10 14:05:29 +090022 "sort"
Jiyong Park48ca7dc2018-10-10 14:01:00 +090023 "strings"
Jooyung Han344d5432019-08-23 11:17:39 +090024 "sync"
Jiyong Park48ca7dc2018-10-10 14:01:00 +090025
26 "android/soong/android"
27 "android/soong/cc"
28 "android/soong/java"
Alex Light778127a2019-02-27 14:19:50 -080029 "android/soong/python"
Jiyong Park48ca7dc2018-10-10 14:01:00 +090030
31 "github.com/google/blueprint"
Alex Light778127a2019-02-27 14:19:50 -080032 "github.com/google/blueprint/bootstrap"
Jiyong Park48ca7dc2018-10-10 14:01:00 +090033 "github.com/google/blueprint/proptools"
34)
35
Jooyung Han72bd2f82019-10-23 16:46:38 +090036const (
37 imageApexSuffix = ".apex"
38 zipApexSuffix = ".zipapex"
Sundong Ahnabb64432019-10-22 13:58:29 +090039 flattenedSuffix = ".flattened"
Alex Light5098a612018-11-29 17:12:15 -080040
Sundong Ahnabb64432019-10-22 13:58:29 +090041 imageApexType = "image"
42 zipApexType = "zip"
43 flattenedApexType = "flattened"
Jooyung Han72bd2f82019-10-23 16:46:38 +090044)
Jiyong Park48ca7dc2018-10-10 14:01:00 +090045
46type dependencyTag struct {
47 blueprint.BaseDependencyTag
48 name string
Jiyong Parkfa899442020-01-31 02:49:53 +090049
50 // determines if the dependent will be part of the APEX payload
51 payload bool
Jiyong Park48ca7dc2018-10-10 14:01:00 +090052}
53
54var (
Jiyong Parkfa899442020-01-31 02:49:53 +090055 sharedLibTag = dependencyTag{name: "sharedLib", payload: true}
56 executableTag = dependencyTag{name: "executable", payload: true}
57 javaLibTag = dependencyTag{name: "javaLib", payload: true}
58 prebuiltTag = dependencyTag{name: "prebuilt", payload: true}
59 testTag = dependencyTag{name: "test", payload: true}
Jiyong Parkc00cbd92018-10-30 21:20:05 +090060 keyTag = dependencyTag{name: "key"}
61 certificateTag = dependencyTag{name: "certificate"}
Jooyung Han5c998b92019-06-27 11:30:33 +090062 usesTag = dependencyTag{name: "uses"}
Jiyong Parkfa899442020-01-31 02:49:53 +090063 androidAppTag = dependencyTag{name: "androidApp", payload: true}
Anton Hansson5053c292020-01-10 15:12:39 +000064 apexAvailWl = makeApexAvailableWhitelist()
Paul Duffin404db3f2020-03-06 12:30:13 +000065
66 inverseApexAvailWl = invertApexWhiteList(apexAvailWl)
Jiyong Park48ca7dc2018-10-10 14:01:00 +090067)
68
Paul Duffin404db3f2020-03-06 12:30:13 +000069// Transform the map of apex -> modules to module -> apexes.
70func invertApexWhiteList(m map[string][]string) map[string][]string {
71 r := make(map[string][]string)
72 for apex, modules := range m {
73 for _, module := range modules {
74 r[module] = append(r[module], apex)
75 }
76 }
77 return r
78}
79
80// Retrieve the while list of apexes to which the supplied module belongs.
81func WhitelistedApexAvailable(moduleName string) []string {
82 return inverseApexAvailWl[normalizeModuleName(moduleName)]
83}
84
Anton Hansson5053c292020-01-10 15:12:39 +000085// This is a map from apex to modules, which overrides the
86// apex_available setting for that particular module to make
87// it available for the apex regardless of its setting.
88// TODO(b/147364041): remove this
89func makeApexAvailableWhitelist() map[string][]string {
90 // The "Module separator"s below are employed to minimize merge conflicts.
91 m := make(map[string][]string)
92 //
93 // Module separator
94 //
Jiyong Park8b399192020-04-29 22:34:13 +090095 m["com.android.appsearch"] = []string{
96 "icing-java-proto-lite",
97 "libprotobuf-java-lite",
Anton Hansson5053c292020-01-10 15:12:39 +000098 }
99 //
100 // Module separator
101 //
102 m["com.android.bluetooth.updatable"] = []string{
103 "android.hardware.audio.common@5.0",
Anton Hansson5053c292020-01-10 15:12:39 +0000104 "android.hardware.bluetooth.a2dp@1.0",
105 "android.hardware.bluetooth.audio@2.0",
Jiyong Parkfa899442020-01-31 02:49:53 +0900106 "android.hardware.bluetooth@1.0",
107 "android.hardware.bluetooth@1.1",
108 "android.hardware.graphics.bufferqueue@1.0",
109 "android.hardware.graphics.bufferqueue@2.0",
110 "android.hardware.graphics.common@1.0",
111 "android.hardware.graphics.common@1.1",
112 "android.hardware.graphics.common@1.2",
113 "android.hardware.media@1.0",
Anton Hansson5053c292020-01-10 15:12:39 +0000114 "android.hidl.safe_union@1.0",
Jiyong Parkfa899442020-01-31 02:49:53 +0900115 "android.hidl.token@1.0",
116 "android.hidl.token@1.0-utils",
117 "avrcp-target-service",
118 "avrcp_headers",
Jiyong Parkfa899442020-01-31 02:49:53 +0900119 "bluetooth-protos-lite",
120 "bluetooth.mapsapi",
121 "com.android.vcard",
Jooyung Hanb8fa86a2020-03-10 06:23:13 +0900122 "dnsresolver_aidl_interface-V2-java",
Jooyung Hanb8fa86a2020-03-10 06:23:13 +0900123 "ipmemorystore-aidl-interfaces-V5-java",
124 "ipmemorystore-aidl-interfaces-java",
Jiyong Parkfa899442020-01-31 02:49:53 +0900125 "internal_include_headers",
126 "lib-bt-packets",
127 "lib-bt-packets-avrcp",
128 "lib-bt-packets-base",
129 "libFraunhoferAAC",
130 "libaudio-a2dp-hw-utils",
131 "libaudio-hearing-aid-hw-utils",
Jiyong Parkfa899442020-01-31 02:49:53 +0900132 "libbinder_headers",
Anton Hansson5053c292020-01-10 15:12:39 +0000133 "libbluetooth",
Jiyong Parkfa899442020-01-31 02:49:53 +0900134 "libbluetooth-types",
135 "libbluetooth-types-header",
136 "libbluetooth_gd",
137 "libbluetooth_headers",
Anton Hansson5053c292020-01-10 15:12:39 +0000138 "libbluetooth_jni",
Jiyong Parkfa899442020-01-31 02:49:53 +0900139 "libbt-audio-hal-interface",
140 "libbt-bta",
141 "libbt-common",
142 "libbt-hci",
143 "libbt-platform-protos-lite",
144 "libbt-protos-lite",
145 "libbt-sbc-decoder",
146 "libbt-sbc-encoder",
147 "libbt-stack",
148 "libbt-utils",
149 "libbtcore",
150 "libbtdevice",
151 "libbte",
152 "libbtif",
Anton Hansson5053c292020-01-10 15:12:39 +0000153 "libchrome",
Anton Hansson5053c292020-01-10 15:12:39 +0000154 "libevent",
155 "libfmq",
Jiyong Parkfa899442020-01-31 02:49:53 +0900156 "libg722codec",
Jiyong Parkfa899442020-01-31 02:49:53 +0900157 "libgui_headers",
Jiyong Parkfa899442020-01-31 02:49:53 +0900158 "libmedia_headers",
159 "libmodpb64",
160 "libosi",
Jiyong Parkfa899442020-01-31 02:49:53 +0900161 "libstagefright_foundation_headers",
162 "libstagefright_headers",
Anton Hansson5053c292020-01-10 15:12:39 +0000163 "libstatslog",
Jiyong Parkfa899442020-01-31 02:49:53 +0900164 "libstatssocket",
Anton Hansson5053c292020-01-10 15:12:39 +0000165 "libtinyxml2",
Jiyong Parkfa899442020-01-31 02:49:53 +0900166 "libudrv-uipc",
Anton Hansson5053c292020-01-10 15:12:39 +0000167 "libz",
Jiyong Parkfa899442020-01-31 02:49:53 +0900168 "media_plugin_headers",
Jooyung Hanb8fa86a2020-03-10 06:23:13 +0900169 "net-utils-services-common",
170 "netd_aidl_interface-unstable-java",
171 "netd_event_listener_interface-java",
172 "netlink-client",
Jooyung Hanb8fa86a2020-03-10 06:23:13 +0900173 "networkstack-client",
Jiyong Parkfa899442020-01-31 02:49:53 +0900174 "sap-api-java-static",
175 "services.net",
Anton Hansson5053c292020-01-10 15:12:39 +0000176 }
177 //
178 // Module separator
179 //
180 m["com.android.cellbroadcast"] = []string{"CellBroadcastApp", "CellBroadcastServiceModule"}
181 //
182 // Module separator
183 //
Jiyong Parkfa899442020-01-31 02:49:53 +0900184 m["com.android.conscrypt"] = []string{
Jiyong Parkfa899442020-01-31 02:49:53 +0900185 "libnativehelper_header_only",
Jiyong Parkfa899442020-01-31 02:49:53 +0900186 }
Anton Hansson5053c292020-01-10 15:12:39 +0000187 //
188 // Module separator
189 //
Jiyong Parkfa899442020-01-31 02:49:53 +0900190 m["com.android.extservices"] = []string{
Jooyung Han11c20932020-05-19 15:47:01 +0900191 "error_prone_annotations",
192 "ExtServices-core",
193 "ExtServices",
194 "libtextclassifier-java",
Jiyong Parkfa899442020-01-31 02:49:53 +0900195 "libz_current",
Jooyung Han11c20932020-05-19 15:47:01 +0900196 "textclassifier-statsd",
197 "TextClassifierNotificationLibNoManifest",
198 "TextClassifierServiceLibNoManifest",
Jiyong Parkfa899442020-01-31 02:49:53 +0900199 }
200 //
201 // Module separator
202 //
Jiyong Parkfa899442020-01-31 02:49:53 +0900203 m["com.android.neuralnetworks"] = []string{
204 "android.hardware.neuralnetworks@1.0",
205 "android.hardware.neuralnetworks@1.1",
206 "android.hardware.neuralnetworks@1.2",
207 "android.hardware.neuralnetworks@1.3",
208 "android.hidl.allocator@1.0",
209 "android.hidl.memory.token@1.0",
210 "android.hidl.memory@1.0",
211 "android.hidl.safe_union@1.0",
Jiyong Parkfa899442020-01-31 02:49:53 +0900212 "libarect",
Jiyong Parkfa899442020-01-31 02:49:53 +0900213 "libbuildversion",
Jiyong Parkfa899442020-01-31 02:49:53 +0900214 "libmath",
Jiyong Parkfa899442020-01-31 02:49:53 +0900215 "libprocpartition",
216 "libsync",
Jiyong Parkfa899442020-01-31 02:49:53 +0900217 }
Anton Hansson5053c292020-01-10 15:12:39 +0000218 //
219 // Module separator
220 //
Anton Hansson5053c292020-01-10 15:12:39 +0000221 m["com.android.media"] = []string{
Jiyong Parkfa899442020-01-31 02:49:53 +0900222 "android.frameworks.bufferhub@1.0",
Anton Hansson5053c292020-01-10 15:12:39 +0000223 "android.hardware.cas.native@1.0",
Jiyong Parkfa899442020-01-31 02:49:53 +0900224 "android.hardware.cas@1.0",
225 "android.hardware.configstore-utils",
226 "android.hardware.configstore@1.0",
227 "android.hardware.configstore@1.1",
228 "android.hardware.graphics.allocator@2.0",
229 "android.hardware.graphics.allocator@3.0",
230 "android.hardware.graphics.bufferqueue@1.0",
231 "android.hardware.graphics.bufferqueue@2.0",
232 "android.hardware.graphics.common@1.0",
233 "android.hardware.graphics.common@1.1",
234 "android.hardware.graphics.common@1.2",
235 "android.hardware.graphics.mapper@2.0",
236 "android.hardware.graphics.mapper@2.1",
237 "android.hardware.graphics.mapper@3.0",
238 "android.hardware.media.omx@1.0",
239 "android.hardware.media@1.0",
Anton Hansson5053c292020-01-10 15:12:39 +0000240 "android.hidl.allocator@1.0",
Anton Hansson5053c292020-01-10 15:12:39 +0000241 "android.hidl.memory.token@1.0",
Jiyong Parkfa899442020-01-31 02:49:53 +0900242 "android.hidl.memory@1.0",
Anton Hansson5053c292020-01-10 15:12:39 +0000243 "android.hidl.token@1.0",
244 "android.hidl.token@1.0-utils",
Jiyong Parkfa899442020-01-31 02:49:53 +0900245 "bionic_libc_platform_headers",
Jooyung Han11c20932020-05-19 15:47:01 +0900246 "exoplayer2-extractor",
247 "exoplayer2-extractor-annotation-stubs",
Jiyong Parkfa899442020-01-31 02:49:53 +0900248 "gl_headers",
Jooyung Han11c20932020-05-19 15:47:01 +0900249 "jsr305",
Jiyong Parkfa899442020-01-31 02:49:53 +0900250 "libEGL",
251 "libEGL_blobCache",
252 "libEGL_getProcAddress",
253 "libFLAC",
254 "libFLAC-config",
255 "libFLAC-headers",
256 "libGLESv2",
Anton Hansson5053c292020-01-10 15:12:39 +0000257 "libaacextractor",
258 "libamrextractor",
Jiyong Parkfa899442020-01-31 02:49:53 +0900259 "libarect",
Jiyong Parkfa899442020-01-31 02:49:53 +0900260 "libaudio_system_headers",
261 "libaudioclient",
262 "libaudioclient_headers",
263 "libaudiofoundation",
264 "libaudiofoundation_headers",
265 "libaudiomanager",
266 "libaudiopolicy",
Anton Hansson5053c292020-01-10 15:12:39 +0000267 "libaudioutils",
Jiyong Parkfa899442020-01-31 02:49:53 +0900268 "libaudioutils_fixedfft",
Jiyong Parkfa899442020-01-31 02:49:53 +0900269 "libbinder_headers",
Jiyong Parkfa899442020-01-31 02:49:53 +0900270 "libbluetooth-types-header",
271 "libbufferhub",
272 "libbufferhub_headers",
273 "libbufferhubqueue",
Jiyong Parkfa899442020-01-31 02:49:53 +0900274 "libc_malloc_debug_backtrace",
275 "libcamera_client",
276 "libcamera_metadata",
Jiyong Parkfa899442020-01-31 02:49:53 +0900277 "libdexfile_external_headers",
278 "libdexfile_support",
279 "libdvr_headers",
280 "libexpat",
281 "libfifo",
Anton Hansson5053c292020-01-10 15:12:39 +0000282 "libflacextractor",
Jiyong Parkfa899442020-01-31 02:49:53 +0900283 "libgrallocusage",
284 "libgraphicsenv",
285 "libgui",
286 "libgui_headers",
287 "libhardware_headers",
Jiyong Parkfa899442020-01-31 02:49:53 +0900288 "libinput",
Jiyong Parkfa899442020-01-31 02:49:53 +0900289 "liblzma",
290 "libmath",
291 "libmedia",
292 "libmedia_codeclist",
293 "libmedia_headers",
294 "libmedia_helper",
295 "libmedia_helper_headers",
296 "libmedia_midiiowrapper",
297 "libmedia_omx",
298 "libmediautils",
Anton Hansson5053c292020-01-10 15:12:39 +0000299 "libmidiextractor",
300 "libmkvextractor",
301 "libmp3extractor",
302 "libmp4extractor",
303 "libmpeg2extractor",
Jiyong Parkfa899442020-01-31 02:49:53 +0900304 "libnativebase_headers",
305 "libnativebridge-headers",
306 "libnativebridge_lazy",
307 "libnativeloader-headers",
308 "libnativeloader_lazy",
309 "libnativewindow_headers",
310 "libnblog",
Anton Hansson5053c292020-01-10 15:12:39 +0000311 "liboggextractor",
Jiyong Parkfa899442020-01-31 02:49:53 +0900312 "libpackagelistparser",
Jiyong Parkfa899442020-01-31 02:49:53 +0900313 "libpdx",
314 "libpdx_default_transport",
315 "libpdx_headers",
316 "libpdx_uds",
Jiyong Parkfa899442020-01-31 02:49:53 +0900317 "libprocinfo",
Anton Hansson5053c292020-01-10 15:12:39 +0000318 "libspeexresampler",
Jiyong Parkfa899442020-01-31 02:49:53 +0900319 "libspeexresampler",
320 "libstagefright_esds",
Anton Hansson5053c292020-01-10 15:12:39 +0000321 "libstagefright_flacdec",
Jiyong Parkfa899442020-01-31 02:49:53 +0900322 "libstagefright_flacdec",
323 "libstagefright_foundation",
324 "libstagefright_foundation_headers",
325 "libstagefright_foundation_without_imemory",
326 "libstagefright_headers",
327 "libstagefright_id3",
328 "libstagefright_metadatautils",
329 "libstagefright_mpeg2extractor",
330 "libstagefright_mpeg2support",
331 "libsync",
Jiyong Parkfa899442020-01-31 02:49:53 +0900332 "libui",
333 "libui_headers",
334 "libunwindstack",
Jiyong Parkfa899442020-01-31 02:49:53 +0900335 "libvibrator",
336 "libvorbisidec",
Anton Hansson5053c292020-01-10 15:12:39 +0000337 "libwavextractor",
Jiyong Parkfa899442020-01-31 02:49:53 +0900338 "libwebm",
339 "media_ndk_headers",
340 "media_plugin_headers",
Anton Hansson5053c292020-01-10 15:12:39 +0000341 "updatable-media",
342 }
343 //
344 // Module separator
345 //
346 m["com.android.media.swcodec"] = []string{
347 "android.frameworks.bufferhub@1.0",
348 "android.hardware.common-ndk_platform",
Jiyong Parkfa899442020-01-31 02:49:53 +0900349 "android.hardware.configstore-utils",
350 "android.hardware.configstore@1.0",
351 "android.hardware.configstore@1.1",
Anton Hansson5053c292020-01-10 15:12:39 +0000352 "android.hardware.graphics.allocator@2.0",
353 "android.hardware.graphics.allocator@3.0",
354 "android.hardware.graphics.allocator@4.0",
355 "android.hardware.graphics.bufferqueue@1.0",
356 "android.hardware.graphics.bufferqueue@2.0",
Jiyong Parkfa899442020-01-31 02:49:53 +0900357 "android.hardware.graphics.common-ndk_platform",
Anton Hansson5053c292020-01-10 15:12:39 +0000358 "android.hardware.graphics.common@1.0",
359 "android.hardware.graphics.common@1.1",
360 "android.hardware.graphics.common@1.2",
Anton Hansson5053c292020-01-10 15:12:39 +0000361 "android.hardware.graphics.mapper@2.0",
362 "android.hardware.graphics.mapper@2.1",
363 "android.hardware.graphics.mapper@3.0",
364 "android.hardware.graphics.mapper@4.0",
Anton Hansson5053c292020-01-10 15:12:39 +0000365 "android.hardware.media.bufferpool@2.0",
366 "android.hardware.media.c2@1.0",
367 "android.hardware.media.c2@1.1",
368 "android.hardware.media.omx@1.0",
Jiyong Parkfa899442020-01-31 02:49:53 +0900369 "android.hardware.media@1.0",
370 "android.hardware.media@1.0",
Anton Hansson5053c292020-01-10 15:12:39 +0000371 "android.hidl.memory.token@1.0",
Jiyong Parkfa899442020-01-31 02:49:53 +0900372 "android.hidl.memory@1.0",
Anton Hansson5053c292020-01-10 15:12:39 +0000373 "android.hidl.safe_union@1.0",
374 "android.hidl.token@1.0",
375 "android.hidl.token@1.0-utils",
Jiyong Parkfa899442020-01-31 02:49:53 +0900376 "libEGL",
377 "libFLAC",
378 "libFLAC-config",
379 "libFLAC-headers",
380 "libFraunhoferAAC",
Jooyung Hanb8fa86a2020-03-10 06:23:13 +0900381 "libLibGuiProperties",
Jiyong Parkfa899442020-01-31 02:49:53 +0900382 "libarect",
Jiyong Parkfa899442020-01-31 02:49:53 +0900383 "libaudio_system_headers",
Anton Hansson5053c292020-01-10 15:12:39 +0000384 "libaudioutils",
Jiyong Parkfa899442020-01-31 02:49:53 +0900385 "libaudioutils",
386 "libaudioutils_fixedfft",
387 "libavcdec",
388 "libavcenc",
Anton Hansson5053c292020-01-10 15:12:39 +0000389 "libavservices_minijail",
Jiyong Parkfa899442020-01-31 02:49:53 +0900390 "libavservices_minijail",
Jiyong Parkfa899442020-01-31 02:49:53 +0900391 "libbinder_headers",
Jooyung Hanb8fa86a2020-03-10 06:23:13 +0900392 "libbinderthreadstateutils",
Jiyong Parkfa899442020-01-31 02:49:53 +0900393 "libbluetooth-types-header",
394 "libbufferhub_headers",
Jiyong Parkfa899442020-01-31 02:49:53 +0900395 "libc_scudo",
Anton Hansson5053c292020-01-10 15:12:39 +0000396 "libcodec2",
Jiyong Parkfa899442020-01-31 02:49:53 +0900397 "libcodec2_headers",
Anton Hansson5053c292020-01-10 15:12:39 +0000398 "libcodec2_hidl@1.0",
399 "libcodec2_hidl@1.1",
Jiyong Parkfa899442020-01-31 02:49:53 +0900400 "libcodec2_internal",
Anton Hansson5053c292020-01-10 15:12:39 +0000401 "libcodec2_soft_aacdec",
402 "libcodec2_soft_aacenc",
403 "libcodec2_soft_amrnbdec",
404 "libcodec2_soft_amrnbenc",
405 "libcodec2_soft_amrwbdec",
406 "libcodec2_soft_amrwbenc",
407 "libcodec2_soft_av1dec_gav1",
408 "libcodec2_soft_avcdec",
409 "libcodec2_soft_avcenc",
410 "libcodec2_soft_common",
411 "libcodec2_soft_flacdec",
412 "libcodec2_soft_flacenc",
413 "libcodec2_soft_g711alawdec",
414 "libcodec2_soft_g711mlawdec",
415 "libcodec2_soft_gsmdec",
416 "libcodec2_soft_h263dec",
417 "libcodec2_soft_h263enc",
418 "libcodec2_soft_hevcdec",
419 "libcodec2_soft_hevcenc",
420 "libcodec2_soft_mp3dec",
421 "libcodec2_soft_mpeg2dec",
422 "libcodec2_soft_mpeg4dec",
423 "libcodec2_soft_mpeg4enc",
424 "libcodec2_soft_opusdec",
425 "libcodec2_soft_opusenc",
426 "libcodec2_soft_rawdec",
427 "libcodec2_soft_vorbisdec",
428 "libcodec2_soft_vp8dec",
429 "libcodec2_soft_vp8enc",
430 "libcodec2_soft_vp9dec",
431 "libcodec2_soft_vp9enc",
432 "libcodec2_vndk",
Jiyong Parkfa899442020-01-31 02:49:53 +0900433 "libdexfile_support",
434 "libdvr_headers",
Anton Hansson5053c292020-01-10 15:12:39 +0000435 "libfmq",
Jiyong Parkfa899442020-01-31 02:49:53 +0900436 "libfmq",
437 "libgav1",
Anton Hansson5053c292020-01-10 15:12:39 +0000438 "libgralloctypes",
Jiyong Parkfa899442020-01-31 02:49:53 +0900439 "libgrallocusage",
440 "libgraphicsenv",
441 "libgsm",
442 "libgui_bufferqueue_static",
443 "libgui_headers",
Anton Hansson5053c292020-01-10 15:12:39 +0000444 "libhardware",
Jiyong Parkfa899442020-01-31 02:49:53 +0900445 "libhardware_headers",
446 "libhevcdec",
447 "libhevcenc",
Anton Hansson5053c292020-01-10 15:12:39 +0000448 "libion",
Jiyong Parkfa899442020-01-31 02:49:53 +0900449 "libjpeg",
Jiyong Parkfa899442020-01-31 02:49:53 +0900450 "liblzma",
451 "libmath",
Anton Hansson5053c292020-01-10 15:12:39 +0000452 "libmedia_codecserviceregistrant",
Jiyong Parkfa899442020-01-31 02:49:53 +0900453 "libmedia_headers",
Jiyong Parkfa899442020-01-31 02:49:53 +0900454 "libmpeg2dec",
455 "libnativebase_headers",
456 "libnativebridge_lazy",
457 "libnativeloader_lazy",
458 "libnativewindow_headers",
Jiyong Parkfa899442020-01-31 02:49:53 +0900459 "libpdx_headers",
Anton Hansson5053c292020-01-10 15:12:39 +0000460 "libscudo_wrapper",
461 "libsfplugin_ccodec_utils",
462 "libspeexresampler",
463 "libstagefright_amrnb_common",
Jiyong Parkfa899442020-01-31 02:49:53 +0900464 "libstagefright_amrnbdec",
465 "libstagefright_amrnbenc",
466 "libstagefright_amrwbdec",
467 "libstagefright_amrwbenc",
Anton Hansson5053c292020-01-10 15:12:39 +0000468 "libstagefright_bufferpool@2.0.1",
469 "libstagefright_bufferqueue_helper",
470 "libstagefright_enc_common",
471 "libstagefright_flacdec",
472 "libstagefright_foundation",
Jiyong Parkfa899442020-01-31 02:49:53 +0900473 "libstagefright_foundation_headers",
474 "libstagefright_headers",
475 "libstagefright_m4vh263dec",
476 "libstagefright_m4vh263enc",
477 "libstagefright_mp3dec",
Anton Hansson5053c292020-01-10 15:12:39 +0000478 "libsync",
479 "libui",
Jiyong Parkfa899442020-01-31 02:49:53 +0900480 "libui_headers",
481 "libunwindstack",
Anton Hansson5053c292020-01-10 15:12:39 +0000482 "libvorbisidec",
483 "libvpx",
Jiyong Parkfa899442020-01-31 02:49:53 +0900484 "libyuv",
485 "libyuv_static",
486 "media_ndk_headers",
487 "media_plugin_headers",
Anton Hansson5053c292020-01-10 15:12:39 +0000488 "mediaswcodec",
Anton Hansson5053c292020-01-10 15:12:39 +0000489 }
490 //
491 // Module separator
492 //
Jiyong Parkfa899442020-01-31 02:49:53 +0900493 m["com.android.mediaprovider"] = []string{
494 "MediaProvider",
495 "MediaProviderGoogle",
496 "fmtlib_ndk",
Jiyong Parkfa899442020-01-31 02:49:53 +0900497 "libbase_ndk",
498 "libfuse",
499 "libfuse_jni",
500 "libnativehelper_header_only",
501 }
502 //
503 // Module separator
504 //
505 m["com.android.permission"] = []string{
Jooyung Han11c20932020-05-19 15:47:01 +0900506 "car-ui-lib",
507 "iconloader",
Jiyong Parkfa899442020-01-31 02:49:53 +0900508 "kotlin-annotations",
509 "kotlin-stdlib",
510 "kotlin-stdlib-jdk7",
511 "kotlin-stdlib-jdk8",
512 "kotlinx-coroutines-android",
513 "kotlinx-coroutines-android-nodeps",
514 "kotlinx-coroutines-core",
515 "kotlinx-coroutines-core-nodeps",
Jiyong Parkfa899442020-01-31 02:49:53 +0900516 "permissioncontroller-statsd",
Jiyong Park26fb6bd2020-02-06 16:47:54 +0900517 "GooglePermissionController",
518 "PermissionController",
Jooyung Han11c20932020-05-19 15:47:01 +0900519 "SettingsLibActionBarShadow",
520 "SettingsLibAppPreference",
521 "SettingsLibBarChartPreference",
522 "SettingsLibLayoutPreference",
523 "SettingsLibProgressBar",
524 "SettingsLibSearchWidget",
525 "SettingsLibSettingsTheme",
526 "SettingsLibRestrictedLockUtils",
527 "SettingsLibHelpUtils",
Jiyong Parkfa899442020-01-31 02:49:53 +0900528 }
Anton Hansson5053c292020-01-10 15:12:39 +0000529 //
530 // Module separator
531 //
Anton Hansson5053c292020-01-10 15:12:39 +0000532 m["com.android.runtime"] = []string{
Jiyong Parkfa899442020-01-31 02:49:53 +0900533 "bionic_libc_platform_headers",
Jiyong Parkfa899442020-01-31 02:49:53 +0900534 "libarm-optimized-routines-math",
Jiyong Parkfa899442020-01-31 02:49:53 +0900535 "libc_aeabi",
536 "libc_bionic",
537 "libc_bionic_ndk",
538 "libc_bootstrap",
539 "libc_common",
540 "libc_common_shared",
541 "libc_common_static",
542 "libc_dns",
543 "libc_dynamic_dispatch",
544 "libc_fortify",
545 "libc_freebsd",
546 "libc_freebsd_large_stack",
547 "libc_gdtoa",
Jiyong Parkfa899442020-01-31 02:49:53 +0900548 "libc_init_dynamic",
549 "libc_init_static",
550 "libc_jemalloc_wrapper",
551 "libc_netbsd",
552 "libc_nomalloc",
553 "libc_nopthread",
554 "libc_openbsd",
555 "libc_openbsd_large_stack",
556 "libc_openbsd_ndk",
557 "libc_pthread",
558 "libc_static_dispatch",
559 "libc_syscalls",
560 "libc_tzcode",
561 "libc_unwind_static",
Jiyong Parkfa899442020-01-31 02:49:53 +0900562 "libdebuggerd",
563 "libdebuggerd_common_headers",
564 "libdebuggerd_handler_core",
565 "libdebuggerd_handler_fallback",
566 "libdexfile_external_headers",
Anton Hansson5053c292020-01-10 15:12:39 +0000567 "libdexfile_support",
Jiyong Parkfa899442020-01-31 02:49:53 +0900568 "libdexfile_support_static",
Jooyung Hanb8fa86a2020-03-10 06:23:13 +0900569 "libdl_static",
Jiyong Parkfa899442020-01-31 02:49:53 +0900570 "libjemalloc5",
571 "liblinker_main",
572 "liblinker_malloc",
Jiyong Parkfa899442020-01-31 02:49:53 +0900573 "liblz4",
Anton Hansson5053c292020-01-10 15:12:39 +0000574 "liblzma",
Jiyong Parkfa899442020-01-31 02:49:53 +0900575 "libprocinfo",
576 "libpropertyinfoparser",
577 "libscudo",
578 "libstdc++",
Jiyong Parkfa899442020-01-31 02:49:53 +0900579 "libsystemproperties",
580 "libtombstoned_client_static",
Anton Hansson5053c292020-01-10 15:12:39 +0000581 "libunwindstack",
Jiyong Parkfa899442020-01-31 02:49:53 +0900582 "libz",
583 "libziparchive",
Anton Hansson5053c292020-01-10 15:12:39 +0000584 }
585 //
586 // Module separator
587 //
Jiyong Parkfa899442020-01-31 02:49:53 +0900588 m["com.android.tethering"] = []string{
Jooyung Han11c20932020-05-19 15:47:01 +0900589 "android.hardware.tetheroffload.config-V1.0-java",
590 "android.hardware.tetheroffload.control-V1.0-java",
591 "android.hidl.base-V1.0-java",
592 "ipmemorystore-aidl-interfaces-java",
Jiyong Parkfa899442020-01-31 02:49:53 +0900593 "libcgrouprc",
594 "libcgrouprc_format",
Jooyung Han11c20932020-05-19 15:47:01 +0900595 "libnativehelper_compat_libc++",
Jiyong Parkfa899442020-01-31 02:49:53 +0900596 "libtetherutilsjni",
Jiyong Parkfa899442020-01-31 02:49:53 +0900597 "libvndksupport",
Jooyung Han11c20932020-05-19 15:47:01 +0900598 "net-utils-framework-common",
599 "netd_aidl_interface-V3-java",
600 "netlink-client",
601 "networkstack-aidl-interfaces-java",
Jiyong Parkfa899442020-01-31 02:49:53 +0900602 "tethering-aidl-interfaces-java",
Jooyung Han11c20932020-05-19 15:47:01 +0900603 "TetheringApiCurrentLib",
Jiyong Parkfa899442020-01-31 02:49:53 +0900604 }
Anton Hansson5053c292020-01-10 15:12:39 +0000605 //
606 // Module separator
607 //
608 m["com.android.wifi"] = []string{
Jiyong Parkfa899442020-01-31 02:49:53 +0900609 "PlatformProperties",
610 "android.hardware.wifi-V1.0-java",
Jooyung Hanb8fa86a2020-03-10 06:23:13 +0900611 "android.hardware.wifi-V1.0-java-constants",
Jiyong Parkfa899442020-01-31 02:49:53 +0900612 "android.hardware.wifi-V1.1-java",
613 "android.hardware.wifi-V1.2-java",
614 "android.hardware.wifi-V1.3-java",
615 "android.hardware.wifi-V1.4-java",
616 "android.hardware.wifi.hostapd-V1.0-java",
617 "android.hardware.wifi.hostapd-V1.1-java",
618 "android.hardware.wifi.hostapd-V1.2-java",
619 "android.hardware.wifi.supplicant-V1.0-java",
620 "android.hardware.wifi.supplicant-V1.1-java",
621 "android.hardware.wifi.supplicant-V1.2-java",
622 "android.hardware.wifi.supplicant-V1.3-java",
623 "android.hidl.base-V1.0-java",
624 "android.hidl.manager-V1.0-java",
625 "android.hidl.manager-V1.1-java",
626 "android.hidl.manager-V1.2-java",
Jiyong Parkfa899442020-01-31 02:49:53 +0900627 "bouncycastle-unbundled",
628 "dnsresolver_aidl_interface-V2-java",
629 "error_prone_annotations",
Jooyung Hanb8fa86a2020-03-10 06:23:13 +0900630 "framework-wifi-pre-jarjar",
631 "framework-wifi-util-lib",
Jiyong Parkfa899442020-01-31 02:49:53 +0900632 "ipmemorystore-aidl-interfaces-V3-java",
633 "ipmemorystore-aidl-interfaces-java",
634 "ksoap2",
Jiyong Parkfa899442020-01-31 02:49:53 +0900635 "libnanohttpd",
Anton Hansson5053c292020-01-10 15:12:39 +0000636 "libwifi-jni",
Jiyong Parkfa899442020-01-31 02:49:53 +0900637 "net-utils-services-common",
638 "netd_aidl_interface-V2-java",
639 "netd_aidl_interface-unstable-java",
640 "netd_event_listener_interface-java",
641 "netlink-client",
Jiyong Parkfa899442020-01-31 02:49:53 +0900642 "networkstack-client",
643 "services.net",
644 "wifi-lite-protos",
645 "wifi-nano-protos",
646 "wifi-service-pre-jarjar",
Anton Hansson5053c292020-01-10 15:12:39 +0000647 "wifi-service-resources",
648 }
649 //
650 // Module separator
651 //
Jiyong Parkfa899442020-01-31 02:49:53 +0900652 m["com.android.sdkext"] = []string{
653 "fmtlib_ndk",
654 "libbase_ndk",
655 "libprotobuf-cpp-lite-ndk",
656 }
657 //
658 // Module separator
659 //
660 m["com.android.os.statsd"] = []string{
Jiyong Parkfa899442020-01-31 02:49:53 +0900661 "libstatssocket",
Jiyong Parkfa899442020-01-31 02:49:53 +0900662 }
663 //
664 // Module separator
665 //
Paul Duffin404db3f2020-03-06 12:30:13 +0000666 m[android.AvailableToAnyApex] = []string{
Jooyung Han11c20932020-05-19 15:47:01 +0900667 // TODO(b/156996905) Set apex_available/min_sdk_version for androidx/extras support libraries
668 "androidx",
669 "androidx-constraintlayout_constraintlayout",
670 "androidx-constraintlayout_constraintlayout-nodeps",
671 "androidx-constraintlayout_constraintlayout-solver",
672 "androidx-constraintlayout_constraintlayout-solver-nodeps",
673 "com.google.android.material_material",
674 "com.google.android.material_material-nodeps",
675
Jiyong Parkfa899442020-01-31 02:49:53 +0900676 "libatomic",
Jiyong Parkfa899442020-01-31 02:49:53 +0900677 "libclang_rt",
678 "libgcc_stripped",
679 "libprofile-clang-extras",
680 "libprofile-clang-extras_ndk",
681 "libprofile-extras",
682 "libprofile-extras_ndk",
683 "libunwind_llvm",
Jiyong Parkfa899442020-01-31 02:49:53 +0900684 }
Anton Hansson5053c292020-01-10 15:12:39 +0000685 return m
686}
687
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900688func init() {
Jiyong Parkd1063c12019-07-17 20:08:41 +0900689 android.RegisterModuleType("apex", BundleFactory)
Alex Light0851b882019-02-07 13:20:53 -0800690 android.RegisterModuleType("apex_test", testApexBundleFactory)
Jooyung Han344d5432019-08-23 11:17:39 +0900691 android.RegisterModuleType("apex_vndk", vndkApexBundleFactory)
Jiyong Park30ca9372019-02-07 16:27:23 +0900692 android.RegisterModuleType("apex_defaults", defaultsFactory)
Jaewoong Jung939ebd52019-03-26 15:07:36 -0700693 android.RegisterModuleType("prebuilt_apex", PrebuiltFactory)
Jiyong Park5d790c32019-11-15 18:40:32 +0900694 android.RegisterModuleType("override_apex", overrideApexFactory)
Jaewoong Jung8cf307e2020-05-14 14:15:24 -0700695 android.RegisterModuleType("apex_set", apexSetFactory)
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900696
Jooyung Han31c470b2019-10-18 16:26:59 +0900697 android.PreDepsMutators(RegisterPreDepsMutators)
Jiyong Parkd1063c12019-07-17 20:08:41 +0900698 android.PostDepsMutators(RegisterPostDepsMutators)
Jooyung Han7a78a922019-10-08 21:59:58 +0900699
700 android.RegisterMakeVarsProvider(pctx, func(ctx android.MakeVarsContext) {
701 apexFileContextsInfos := apexFileContextsInfos(ctx.Config())
702 sort.Strings(*apexFileContextsInfos)
703 ctx.Strict("APEX_FILE_CONTEXTS_INFOS", strings.Join(*apexFileContextsInfos, " "))
704 })
Jiyong Parkd1063c12019-07-17 20:08:41 +0900705}
706
Jooyung Han31c470b2019-10-18 16:26:59 +0900707func RegisterPreDepsMutators(ctx android.RegisterMutatorsContext) {
708 ctx.TopDown("apex_vndk", apexVndkMutator).Parallel()
709 ctx.BottomUp("apex_vndk_deps", apexVndkDepsMutator).Parallel()
710}
711
Jiyong Parkd1063c12019-07-17 20:08:41 +0900712func RegisterPostDepsMutators(ctx android.RegisterMutatorsContext) {
Jiyong Parkf760cae2020-02-12 07:53:12 +0900713 ctx.TopDown("apex_deps", apexDepsMutator)
Jiyong Parkd1063c12019-07-17 20:08:41 +0900714 ctx.BottomUp("apex", apexMutator).Parallel()
715 ctx.BottomUp("apex_flattened", apexFlattenedMutator).Parallel()
716 ctx.BottomUp("apex_uses", apexUsesMutator).Parallel()
Jiyong Park6a9ddc32020-04-07 16:37:39 +0900717 ctx.BottomUp("mark_platform_availability", markPlatformAvailability).Parallel()
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900718}
719
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900720// Mark the direct and transitive dependencies of apex bundles so that they
721// can be built for the apex bundles.
Jiyong Parkf760cae2020-02-12 07:53:12 +0900722func apexDepsMutator(mctx android.TopDownMutatorContext) {
Jooyung Han40b286c2020-04-17 13:43:10 +0900723 if !mctx.Module().Enabled() {
724 return
725 }
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800726 var apexBundles []android.ApexInfo
Jiyong Parkf760cae2020-02-12 07:53:12 +0900727 var directDep bool
Jooyung Hana57af4a2020-01-23 05:36:59 +0000728 if a, ok := mctx.Module().(*apexBundle); ok && !a.vndkApex {
Jooyung Han40b286c2020-04-17 13:43:10 +0900729 apexBundles = []android.ApexInfo{{
Jooyung Han23b0adf2020-03-12 18:37:20 +0900730 ApexName: mctx.ModuleName(),
731 MinSdkVersion: a.minSdkVersion(mctx),
Artur Satayev2b4b7bb2020-04-28 14:57:42 +0100732 Updatable: a.Updatable(),
Jooyung Hanb8fa86a2020-03-10 06:23:13 +0900733 }}
Jiyong Parkf760cae2020-02-12 07:53:12 +0900734 directDep = true
735 } else if am, ok := mctx.Module().(android.ApexModule); ok {
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800736 apexBundles = am.ApexVariations()
Jiyong Parkf760cae2020-02-12 07:53:12 +0900737 directDep = false
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900738 }
Jiyong Parkf760cae2020-02-12 07:53:12 +0900739
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800740 if len(apexBundles) == 0 {
Jiyong Parkf760cae2020-02-12 07:53:12 +0900741 return
742 }
743
Paul Duffin03e7d0c2020-03-30 15:33:32 +0100744 cur := mctx.Module().(android.DepIsInSameApex)
Jooyung Hanb8fa86a2020-03-10 06:23:13 +0900745
Jiyong Parkf760cae2020-02-12 07:53:12 +0900746 mctx.VisitDirectDeps(func(child android.Module) {
747 depName := mctx.OtherModuleName(child)
748 if am, ok := child.(android.ApexModule); ok && am.CanHaveApexVariants() &&
Paul Duffinb20ad0a2020-03-31 15:23:40 +0100749 (cur.DepIsInSameApex(mctx, child) || inAnySdk(child)) {
Peter Collingbournedc4f9862020-02-12 17:13:25 -0800750 android.UpdateApexDependency(apexBundles, depName, directDep)
751 am.BuildForApexes(apexBundles)
Jiyong Parkf760cae2020-02-12 07:53:12 +0900752 }
753 })
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900754}
755
Jiyong Park6a9ddc32020-04-07 16:37:39 +0900756// mark if a module cannot be available to platform. A module cannot be available
757// to platform if 1) it is explicitly marked as not available (i.e. "//apex_available:platform"
758// is absent) or 2) it depends on another module that isn't (or can't be) available to platform
759func markPlatformAvailability(mctx android.BottomUpMutatorContext) {
760 // Host and recovery are not considered as platform
761 if mctx.Host() || mctx.Module().InstallInRecovery() {
762 return
763 }
764
765 if am, ok := mctx.Module().(android.ApexModule); ok {
766 availableToPlatform := am.AvailableFor(android.AvailableToPlatform)
767
768 // In a rare case when a lib is marked as available only to an apex
769 // but the apex doesn't exist. This can happen in a partial manifest branch
770 // like master-art. Currently, libstatssocket in the stats APEX is causing
771 // this problem.
772 // Include the lib in platform because the module SDK that ought to provide
773 // it doesn't exist, so it would otherwise be left out completely.
774 // TODO(b/154888298) remove this by adding those libraries in module SDKS and skipping
775 // this check for libraries provided by SDKs.
776 if !availableToPlatform && !android.InAnyApex(am.Name()) {
777 availableToPlatform = true
778 }
779
780 // If any of the dep is not available to platform, this module is also considered
781 // as being not available to platform even if it has "//apex_available:platform"
782 mctx.VisitDirectDeps(func(child android.Module) {
783 if !am.DepIsInSameApex(mctx, child) {
784 // if the dependency crosses apex boundary, don't consider it
785 return
786 }
787 if dep, ok := child.(android.ApexModule); ok && dep.NotAvailableForPlatform() {
788 availableToPlatform = false
789 // TODO(b/154889534) trigger an error when 'am' has "//apex_available:platform"
790 }
791 })
792
793 // Exception 1: stub libraries and native bridge libraries are always available to platform
794 if cc, ok := mctx.Module().(*cc.Module); ok &&
795 (cc.IsStubs() || cc.Target().NativeBridge == android.NativeBridgeEnabled) {
796 availableToPlatform = true
797 }
798
799 // Exception 2: bootstrap bionic libraries are also always available to platform
800 if cc.InstallToBootstrap(mctx.ModuleName(), mctx.Config()) {
801 availableToPlatform = true
802 }
803
804 if !availableToPlatform {
805 am.SetNotAvailableForPlatform()
806 }
807 }
808}
809
Paul Duffinb20ad0a2020-03-31 15:23:40 +0100810// If a module in an APEX depends on a module from an SDK then it needs an APEX
811// specific variant created for it. Refer to sdk.sdkDepsReplaceMutator.
812func inAnySdk(module android.Module) bool {
813 if sa, ok := module.(android.SdkAware); ok {
814 return sa.IsInAnySdk()
815 }
816
817 return false
818}
819
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900820// Create apex variations if a module is included in APEX(s).
821func apexMutator(mctx android.BottomUpMutatorContext) {
Jooyung Han40b286c2020-04-17 13:43:10 +0900822 if !mctx.Module().Enabled() {
823 return
824 }
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900825 if am, ok := mctx.Module().(android.ApexModule); ok && am.CanHaveApexVariants() {
Jiyong Park0ddfcd12018-12-11 01:35:25 +0900826 am.CreateApexVariations(mctx)
Jooyung Hana57af4a2020-01-23 05:36:59 +0000827 } else if a, ok := mctx.Module().(*apexBundle); ok && !a.vndkApex {
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900828 // apex bundle itself is mutated so that it and its modules have same
829 // apex variant.
830 apexBundleName := mctx.ModuleName()
831 mctx.CreateVariations(apexBundleName)
Jiyong Park5d790c32019-11-15 18:40:32 +0900832 } else if o, ok := mctx.Module().(*OverrideApex); ok {
833 apexBundleName := o.GetOverriddenModuleName()
834 if apexBundleName == "" {
835 mctx.ModuleErrorf("base property is not set")
836 return
837 }
838 mctx.CreateVariations(apexBundleName)
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900839 }
Jiyong Park5d790c32019-11-15 18:40:32 +0900840
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900841}
Sundong Ahne9b55722019-09-06 17:37:42 +0900842
Jooyung Han7a78a922019-10-08 21:59:58 +0900843var (
844 apexFileContextsInfosKey = android.NewOnceKey("apexFileContextsInfosKey")
845 apexFileContextsInfosMutex sync.Mutex
846)
847
848func apexFileContextsInfos(config android.Config) *[]string {
849 return config.Once(apexFileContextsInfosKey, func() interface{} {
850 return &[]string{}
851 }).(*[]string)
852}
853
Jooyung Han54aca7b2019-11-20 02:26:02 +0900854func addFlattenedFileContextsInfos(ctx android.BaseModuleContext, fileContextsInfo string) {
Jooyung Han7a78a922019-10-08 21:59:58 +0900855 apexFileContextsInfosMutex.Lock()
856 defer apexFileContextsInfosMutex.Unlock()
857 apexFileContextsInfos := apexFileContextsInfos(ctx.Config())
Jooyung Han54aca7b2019-11-20 02:26:02 +0900858 *apexFileContextsInfos = append(*apexFileContextsInfos, fileContextsInfo)
Jooyung Han7a78a922019-10-08 21:59:58 +0900859}
860
Sundong Ahne9b55722019-09-06 17:37:42 +0900861func apexFlattenedMutator(mctx android.BottomUpMutatorContext) {
Jooyung Han40b286c2020-04-17 13:43:10 +0900862 if !mctx.Module().Enabled() {
863 return
864 }
Sundong Ahne8fb7242019-09-17 13:50:45 +0900865 if ab, ok := mctx.Module().(*apexBundle); ok {
Sundong Ahnabb64432019-10-22 13:58:29 +0900866 var variants []string
867 switch proptools.StringDefault(ab.properties.Payload_type, "image") {
868 case "image":
869 variants = append(variants, imageApexType, flattenedApexType)
870 case "zip":
871 variants = append(variants, zipApexType)
872 case "both":
873 variants = append(variants, imageApexType, zipApexType, flattenedApexType)
874 default:
Sundong Ahnd95aa2d2019-10-08 19:34:03 +0900875 mctx.PropertyErrorf("type", "%q is not one of \"image\", \"zip\", or \"both\".", *ab.properties.Payload_type)
Sundong Ahnabb64432019-10-22 13:58:29 +0900876 return
877 }
878
879 modules := mctx.CreateLocalVariations(variants...)
880
881 for i, v := range variants {
882 switch v {
883 case imageApexType:
884 modules[i].(*apexBundle).properties.ApexType = imageApex
885 case zipApexType:
886 modules[i].(*apexBundle).properties.ApexType = zipApex
887 case flattenedApexType:
888 modules[i].(*apexBundle).properties.ApexType = flattenedApex
Jooyung Han91df2082019-11-20 01:49:42 +0900889 if !mctx.Config().FlattenApex() && ab.Platform() {
Sundong Ahnd95aa2d2019-10-08 19:34:03 +0900890 modules[i].(*apexBundle).MakeAsSystemExt()
891 }
Sundong Ahnabb64432019-10-22 13:58:29 +0900892 }
Sundong Ahne9b55722019-09-06 17:37:42 +0900893 }
Jiyong Park5d790c32019-11-15 18:40:32 +0900894 } else if _, ok := mctx.Module().(*OverrideApex); ok {
895 mctx.CreateVariations(imageApexType, flattenedApexType)
Sundong Ahne9b55722019-09-06 17:37:42 +0900896 }
897}
898
Jooyung Han5c998b92019-06-27 11:30:33 +0900899func apexUsesMutator(mctx android.BottomUpMutatorContext) {
900 if ab, ok := mctx.Module().(*apexBundle); ok {
901 mctx.AddFarVariationDependencies(nil, usesTag, ab.properties.Uses...)
902 }
903}
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900904
Jooyung Handc782442019-11-01 03:14:38 +0900905var (
906 useVendorWhitelistKey = android.NewOnceKey("useVendorWhitelist")
907)
908
909// useVendorWhitelist returns the list of APEXes which are allowed to use_vendor.
910// When use_vendor is used, native modules are built with __ANDROID_VNDK__ and __ANDROID_APEX__,
911// which may cause compatibility issues. (e.g. libbinder)
912// Even though libbinder restricts its availability via 'apex_available' property and relies on
913// yet another macro __ANDROID_APEX_<NAME>__, we restrict usage of "use_vendor:" from other APEX modules
914// to avoid similar problems.
915func useVendorWhitelist(config android.Config) []string {
916 return config.Once(useVendorWhitelistKey, func() interface{} {
917 return []string{
918 // swcodec uses "vendor" variants for smaller size
919 "com.android.media.swcodec",
920 "test_com.android.media.swcodec",
921 }
922 }).([]string)
923}
924
925// setUseVendorWhitelistForTest overrides useVendorWhitelist and must be
926// called before the first call to useVendorWhitelist()
927func setUseVendorWhitelistForTest(config android.Config, whitelist []string) {
928 config.Once(useVendorWhitelistKey, func() interface{} {
929 return whitelist
930 })
931}
932
Alex Light9670d332019-01-29 18:07:33 -0800933type apexNativeDependencies struct {
934 // List of native libraries
935 Native_shared_libs []string
Jooyung Han344d5432019-08-23 11:17:39 +0900936
Alex Light9670d332019-01-29 18:07:33 -0800937 // List of native executables
938 Binaries []string
Jooyung Han344d5432019-08-23 11:17:39 +0900939
Roland Levillain630846d2019-06-26 12:48:34 +0100940 // List of native tests
941 Tests []string
Alex Light9670d332019-01-29 18:07:33 -0800942}
Jooyung Han344d5432019-08-23 11:17:39 +0900943
Alex Light9670d332019-01-29 18:07:33 -0800944type apexMultilibProperties struct {
945 // Native dependencies whose compile_multilib is "first"
946 First apexNativeDependencies
947
948 // Native dependencies whose compile_multilib is "both"
949 Both apexNativeDependencies
950
951 // Native dependencies whose compile_multilib is "prefer32"
952 Prefer32 apexNativeDependencies
953
954 // Native dependencies whose compile_multilib is "32"
955 Lib32 apexNativeDependencies
956
957 // Native dependencies whose compile_multilib is "64"
958 Lib64 apexNativeDependencies
959}
960
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900961type apexBundleProperties struct {
962 // Json manifest file describing meta info of this APEX bundle. Default:
Dario Freni4abb1dc2018-11-20 18:04:58 +0000963 // "apex_manifest.json"
Colin Cross27b922f2019-03-04 22:35:41 -0800964 Manifest *string `android:"path"`
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900965
Jiyong Park40e26a22019-02-08 02:53:06 +0900966 // AndroidManifest.xml file used for the zip container of this APEX bundle.
967 // If unspecified, a default one is automatically generated.
Colin Cross27b922f2019-03-04 22:35:41 -0800968 AndroidManifest *string `android:"path"`
Jiyong Park40e26a22019-02-08 02:53:06 +0900969
Roland Levillain411c5842019-09-19 16:37:20 +0100970 // Canonical name of the APEX bundle. Used to determine the path to the activated APEX on
971 // device (/apex/<apex_name>).
972 // If unspecified, defaults to the value of name.
Jiyong Park05e70dd2019-03-18 14:26:32 +0900973 Apex_name *string
974
Jiyong Parkd0a65ba2018-11-10 06:37:15 +0900975 // Determines the file contexts file for setting security context to each file in this APEX bundle.
Jooyung Han54aca7b2019-11-20 02:26:02 +0900976 // For platform APEXes, this should points to a file under /system/sepolicy
977 // Default: /system/sepolicy/apex/<module_name>_file_contexts.
978 File_contexts *string `android:"path"`
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900979
980 // List of native shared libs that are embedded inside this APEX bundle
981 Native_shared_libs []string
982
Roland Levillain630846d2019-06-26 12:48:34 +0100983 // List of executables that are embedded inside this APEX bundle
Jiyong Park48ca7dc2018-10-10 14:01:00 +0900984 Binaries []string
985
986 // List of java libraries that are embedded inside this APEX bundle
987 Java_libs []string
988
989 // List of prebuilt files that are embedded inside this APEX bundle
990 Prebuilts []string
Jiyong Parkff1458f2018-10-12 21:49:38 +0900991
Roland Levillain630846d2019-06-26 12:48:34 +0100992 // List of tests that are embedded inside this APEX bundle
993 Tests []string
994
Jiyong Parkff1458f2018-10-12 21:49:38 +0900995 // Name of the apex_key module that provides the private key to sign APEX
996 Key *string
Jiyong Park397e55e2018-10-24 21:09:55 +0900997
Alex Light5098a612018-11-29 17:12:15 -0800998 // The type of APEX to build. Controls what the APEX payload is. Either
999 // 'image', 'zip' or 'both'. Default: 'image'.
1000 Payload_type *string
1001
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001002 // The name of a certificate in the default certificate directory, blank to use the default product certificate,
1003 // or an android_app_certificate module name in the form ":module".
1004 Certificate *string
1005
Jiyong Park92c0f9c2018-12-13 23:14:57 +09001006 // Whether this APEX is installable to one of the partitions. Default: true.
1007 Installable *bool
1008
Jiyong Parkda6eb592018-12-19 17:12:36 +09001009 // For native libraries and binaries, use the vendor variant instead of the core (platform) variant.
1010 // Default is false.
1011 Use_vendor *bool
1012
Alex Lightfc0bd7c2019-01-29 18:31:59 -08001013 // For telling the apex to ignore special handling for system libraries such as bionic. Default is false.
1014 Ignore_system_library_special_case *bool
1015
Alex Light9670d332019-01-29 18:07:33 -08001016 Multilib apexMultilibProperties
Jiyong Park235e67c2019-02-09 11:50:56 +09001017
Jiyong Parkf97782b2019-02-13 20:28:58 +09001018 // List of sanitizer names that this APEX is enabled for
1019 SanitizerNames []string `blueprint:"mutated"`
Jooyung Han5c998b92019-06-27 11:30:33 +09001020
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001021 PreventInstall bool `blueprint:"mutated"`
1022
1023 HideFromMake bool `blueprint:"mutated"`
1024
Jooyung Han5c998b92019-06-27 11:30:33 +09001025 // Indicates this APEX provides C++ shared libaries to other APEXes. Default: false.
1026 Provide_cpp_shared_libs *bool
1027
1028 // List of providing APEXes' names so that this APEX can depend on provided shared libraries.
1029 Uses []string
Nikita Ioffe5d5ae762019-08-31 14:38:05 +01001030
1031 // A txt file containing list of files that are whitelisted to be included in this APEX.
1032 Whitelisted_files *string
Sundong Ahne1f05aa2019-08-27 13:55:42 +09001033
Sundong Ahnabb64432019-10-22 13:58:29 +09001034 // package format of this apex variant; could be non-flattened, flattened, or zip.
1035 // imageApex, zipApex or flattened
1036 ApexType apexPackaging `blueprint:"mutated"`
Sundong Ahne8fb7242019-09-17 13:50:45 +09001037
Jiyong Parkd1063c12019-07-17 20:08:41 +09001038 // List of SDKs that are used to build this APEX. A reference to an SDK should be either
1039 // `name#version` or `name` which is an alias for `name#current`. If left empty, `platform#current`
1040 // is implied. This value affects all modules included in this APEX. In other words, they are
1041 // also built with the SDKs specified here.
1042 Uses_sdks []string
Jiyong Park5d790c32019-11-15 18:40:32 +09001043
Nikita Ioffec72b5dd2019-12-07 17:30:22 +00001044 // Whenever apex_payload.img of the APEX should include dm-verity hashtree.
1045 // Should be only used in tests#.
1046 Test_only_no_hashtree *bool
Jooyung Han214bf372019-11-12 13:03:50 +09001047
Dario Freni98410fd2020-04-27 18:21:11 +01001048 // Whenever apex_payload.img of the APEX should not be dm-verity signed.
1049 // Should be only used in tests#.
1050 Test_only_unsigned_payload *bool
1051
Jiyong Park956305c2020-01-09 12:32:06 +09001052 IsCoverageVariant bool `blueprint:"mutated"`
Jiyong Park9d677202020-02-19 16:29:35 +09001053
1054 // Whether this APEX is considered updatable or not. When set to true, this will enforce additional
Jooyung Hanced674e2020-04-27 12:10:30 +09001055 // rules for making sure that the APEX is truly updatable.
1056 // - To be updatable, min_sdk_version should be set as well
1057 // This will also disable the size optimizations like symlinking to the system libs.
1058 // Default is false.
Jiyong Park9d677202020-02-19 16:29:35 +09001059 Updatable *bool
Colin Cross7365eaa2020-02-19 20:41:10 -08001060
1061 // The minimum SDK version that this apex must be compatible with.
1062 Min_sdk_version *string
Alex Light9670d332019-01-29 18:07:33 -08001063}
1064
1065type apexTargetBundleProperties struct {
1066 Target struct {
1067 // Multilib properties only for android.
1068 Android struct {
1069 Multilib apexMultilibProperties
Jiyong Park397e55e2018-10-24 21:09:55 +09001070 }
Jooyung Han344d5432019-08-23 11:17:39 +09001071
Alex Light9670d332019-01-29 18:07:33 -08001072 // Multilib properties only for host.
1073 Host struct {
1074 Multilib apexMultilibProperties
Jiyong Park397e55e2018-10-24 21:09:55 +09001075 }
Jooyung Han344d5432019-08-23 11:17:39 +09001076
Alex Light9670d332019-01-29 18:07:33 -08001077 // Multilib properties only for host linux_bionic.
1078 Linux_bionic struct {
1079 Multilib apexMultilibProperties
Jiyong Park397e55e2018-10-24 21:09:55 +09001080 }
Jooyung Han344d5432019-08-23 11:17:39 +09001081
Alex Light9670d332019-01-29 18:07:33 -08001082 // Multilib properties only for host linux_glibc.
1083 Linux_glibc struct {
1084 Multilib apexMultilibProperties
Jiyong Park397e55e2018-10-24 21:09:55 +09001085 }
1086 }
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001087}
1088
Jiyong Park5d790c32019-11-15 18:40:32 +09001089type overridableProperties struct {
1090 // List of APKs to package inside APEX
1091 Apps []string
Jaewoong Jung7abcf8e2019-12-19 17:32:06 -08001092
1093 // Names of modules to be overridden. Listed modules can only be other binaries
1094 // (in Make or Soong).
1095 // This does not completely prevent installation of the overridden binaries, but if both
1096 // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed
1097 // from PRODUCT_PACKAGES.
1098 Overrides []string
Baligh Uddin004d7172020-02-19 21:29:28 -08001099
1100 // Logging Parent value
1101 Logging_parent string
Baligh Uddincb6aa122020-03-15 13:01:05 -07001102
1103 // Apex Container Package Name.
1104 // Override value for attribute package:name in AndroidManifest.xml
1105 Package_name string
Jiyong Park5d790c32019-11-15 18:40:32 +09001106}
1107
Alex Light5098a612018-11-29 17:12:15 -08001108type apexPackaging int
1109
1110const (
1111 imageApex apexPackaging = iota
1112 zipApex
Sundong Ahnabb64432019-10-22 13:58:29 +09001113 flattenedApex
Alex Light5098a612018-11-29 17:12:15 -08001114)
1115
Sundong Ahnabb64432019-10-22 13:58:29 +09001116// The suffix for the output "file", not the module
Alex Light5098a612018-11-29 17:12:15 -08001117func (a apexPackaging) suffix() string {
1118 switch a {
1119 case imageApex:
1120 return imageApexSuffix
1121 case zipApex:
1122 return zipApexSuffix
Alex Light5098a612018-11-29 17:12:15 -08001123 default:
Roland Levillain4644b222019-07-31 14:09:17 +01001124 panic(fmt.Errorf("unknown APEX type %d", a))
Alex Light5098a612018-11-29 17:12:15 -08001125 }
1126}
1127
1128func (a apexPackaging) name() string {
1129 switch a {
1130 case imageApex:
1131 return imageApexType
1132 case zipApex:
1133 return zipApexType
Alex Light5098a612018-11-29 17:12:15 -08001134 default:
Roland Levillain4644b222019-07-31 14:09:17 +01001135 panic(fmt.Errorf("unknown APEX type %d", a))
Alex Light5098a612018-11-29 17:12:15 -08001136 }
1137}
1138
Jiyong Parkf653b052019-11-18 15:39:01 +09001139type apexFileClass int
1140
1141const (
1142 etc apexFileClass = iota
1143 nativeSharedLib
1144 nativeExecutable
1145 shBinary
1146 pyBinary
1147 goBinary
1148 javaSharedLib
1149 nativeTest
1150 app
1151)
1152
Jiyong Park8fd61922018-11-08 02:50:25 +09001153func (class apexFileClass) NameInMake() string {
1154 switch class {
1155 case etc:
1156 return "ETC"
1157 case nativeSharedLib:
1158 return "SHARED_LIBRARIES"
Alex Light778127a2019-02-27 14:19:50 -08001159 case nativeExecutable, shBinary, pyBinary, goBinary:
Jiyong Park8fd61922018-11-08 02:50:25 +09001160 return "EXECUTABLES"
1161 case javaSharedLib:
1162 return "JAVA_LIBRARIES"
Roland Levillain630846d2019-06-26 12:48:34 +01001163 case nativeTest:
1164 return "NATIVE_TESTS"
Sundong Ahne1f05aa2019-08-27 13:55:42 +09001165 case app:
Jiyong Parkf383f7c2019-10-11 20:46:25 +09001166 // b/142537672 Why isn't this APP? We want to have full control over
1167 // the paths and file names of the apk file under the flattend APEX.
1168 // If this is set to APP, then the paths and file names are modified
1169 // by the Make build system. For example, it is installed to
1170 // /system/apex/<apexname>/app/<Appname>/<apexname>.<Appname>/ instead of
1171 // /system/apex/<apexname>/app/<Appname> because the build system automatically
1172 // appends module name (which is <apexname>.<Appname> to the path.
1173 return "ETC"
Jiyong Park8fd61922018-11-08 02:50:25 +09001174 default:
Roland Levillain4644b222019-07-31 14:09:17 +01001175 panic(fmt.Errorf("unknown class %d", class))
Jiyong Park8fd61922018-11-08 02:50:25 +09001176 }
1177}
1178
Jiyong Parkf653b052019-11-18 15:39:01 +09001179// apexFile represents a file in an APEX bundle
Jiyong Park8fd61922018-11-08 02:50:25 +09001180type apexFile struct {
1181 builtFile android.Path
1182 moduleName string
Jiyong Park8fd61922018-11-08 02:50:25 +09001183 installDir string
1184 class apexFileClass
Jiyong Parka8894842018-12-19 17:36:39 +09001185 module android.Module
Jiyong Parkf653b052019-11-18 15:39:01 +09001186 // list of symlinks that will be created in installDir that point to this apexFile
1187 symlinks []string
1188 transitiveDep bool
Jiyong Park1833cef2019-12-13 13:28:36 +09001189 moduleDir string
Jiyong Park7afd1072019-12-30 16:56:33 +09001190
1191 requiredModuleNames []string
1192 targetRequiredModuleNames []string
1193 hostRequiredModuleNames []string
Jiyong Park618922e2020-01-08 13:35:43 +09001194
Colin Cross503c1d02020-01-28 14:00:53 -08001195 jacocoReportClassesFile android.Path // only for javalibs and apps
1196 certificate java.Certificate // only for apps
Jiyong Parkaf8998c2020-02-28 16:51:07 +09001197 overriddenPackageName string // only for apps
Jiyong Parkf653b052019-11-18 15:39:01 +09001198}
1199
Jiyong Park1833cef2019-12-13 13:28:36 +09001200func newApexFile(ctx android.BaseModuleContext, builtFile android.Path, moduleName string, installDir string, class apexFileClass, module android.Module) apexFile {
1201 ret := apexFile{
Jiyong Parkf653b052019-11-18 15:39:01 +09001202 builtFile: builtFile,
1203 moduleName: moduleName,
1204 installDir: installDir,
1205 class: class,
1206 module: module,
1207 }
Jiyong Park1833cef2019-12-13 13:28:36 +09001208 if module != nil {
1209 ret.moduleDir = ctx.OtherModuleDir(module)
Jiyong Park7afd1072019-12-30 16:56:33 +09001210 ret.requiredModuleNames = module.RequiredModuleNames()
1211 ret.targetRequiredModuleNames = module.TargetRequiredModuleNames()
1212 ret.hostRequiredModuleNames = module.HostRequiredModuleNames()
Jiyong Park1833cef2019-12-13 13:28:36 +09001213 }
1214 return ret
Jiyong Parkf653b052019-11-18 15:39:01 +09001215}
1216
1217func (af *apexFile) Ok() bool {
Jiyong Park479321d2019-12-16 11:47:12 +09001218 return af.builtFile != nil && af.builtFile.String() != ""
Jiyong Park8fd61922018-11-08 02:50:25 +09001219}
1220
Jiyong Park7cd10e32020-01-14 09:22:18 +09001221// Path() returns path of this apex file relative to the APEX root
1222func (af *apexFile) Path() string {
1223 return filepath.Join(af.installDir, af.builtFile.Base())
1224}
1225
1226// SymlinkPaths() returns paths of the symlinks (if any) relative to the APEX root
1227func (af *apexFile) SymlinkPaths() []string {
1228 var ret []string
1229 for _, symlink := range af.symlinks {
1230 ret = append(ret, filepath.Join(af.installDir, symlink))
1231 }
1232 return ret
1233}
1234
1235func (af *apexFile) AvailableToPlatform() bool {
1236 if af.module == nil {
1237 return false
1238 }
1239 if am, ok := af.module.(android.ApexModule); ok {
1240 return am.AvailableFor(android.AvailableToPlatform)
1241 }
1242 return false
1243}
1244
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001245type apexBundle struct {
1246 android.ModuleBase
1247 android.DefaultableModuleBase
Jiyong Park5d790c32019-11-15 18:40:32 +09001248 android.OverridableModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +09001249 android.SdkBase
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001250
Jiyong Park5d790c32019-11-15 18:40:32 +09001251 properties apexBundleProperties
1252 targetProperties apexTargetBundleProperties
Jiyong Park5d790c32019-11-15 18:40:32 +09001253 overridableProperties overridableProperties
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001254
Jooyung Hanf21c7972019-12-16 22:32:06 +09001255 // specific to apex_vndk modules
1256 vndkProperties apexVndkProperties
1257
Colin Crossa4925902018-11-16 11:36:28 -08001258 bundleModuleFile android.WritablePath
Sundong Ahnabb64432019-10-22 13:58:29 +09001259 outputFile android.WritablePath
Colin Cross70dda7e2019-10-01 22:05:35 -07001260 installDir android.InstallPath
Jiyong Park8fd61922018-11-08 02:50:25 +09001261
Jiyong Park03b68dd2019-07-26 23:20:40 +09001262 prebuiltFileToDelete string
1263
Jiyong Park42cca6c2019-04-01 11:15:50 +09001264 public_key_file android.Path
1265 private_key_file android.Path
Jiyong Park0ca3ce82019-02-18 15:25:04 +09001266
1267 container_certificate_file android.Path
1268 container_private_key_file android.Path
1269
Jooyung Han54aca7b2019-11-20 02:26:02 +09001270 fileContexts android.Path
1271
Jiyong Park8fd61922018-11-08 02:50:25 +09001272 // list of files to be included in this apex
1273 filesInfo []apexFile
1274
Jiyong Park956305c2020-01-09 12:32:06 +09001275 // list of module names that should be installed along with this APEX
1276 requiredDeps []string
1277
Jiyong Park956305c2020-01-09 12:32:06 +09001278 // list of module names that this APEX is including (to be shown via *-deps-info target)
Artur Satayev334b5172020-04-27 17:08:37 +01001279 android.ApexBundleDepsInfo
Jiyong Parkac2bacd2019-02-20 21:49:26 +09001280
Sundong Ahnabb64432019-10-22 13:58:29 +09001281 testApex bool
1282 vndkApex bool
Ulyana Trafimovichde534412019-11-08 10:51:01 +00001283 artApex bool
Sundong Ahnabb64432019-10-22 13:58:29 +09001284 primaryApexType bool
Jooyung Hane1633032019-08-01 17:41:43 +09001285
Jooyung Han214bf372019-11-12 13:03:50 +09001286 manifestJsonOut android.WritablePath
1287 manifestPbOut android.WritablePath
Jooyung Han72bd2f82019-10-23 16:46:38 +09001288
Jooyung Han002ab682020-01-08 01:57:58 +09001289 // list of commands to create symlinks for backward compatibility.
Jooyung Han72bd2f82019-10-23 16:46:38 +09001290 // these commands will be attached as LOCAL_POST_INSTALL_CMD to
Jooyung Han002ab682020-01-08 01:57:58 +09001291 // apex package itself(for unflattened build) or apex_manifest(for flattened build)
Jooyung Han72bd2f82019-10-23 16:46:38 +09001292 // so that compat symlinks are always installed regardless of TARGET_FLATTEN_APEX setting.
1293 compatSymlinks []string
Sundong Ahnabb64432019-10-22 13:58:29 +09001294
1295 // Suffix of module name in Android.mk
1296 // ".flattened", ".apex", ".zipapex", or ""
1297 suffix string
Jiyong Park3a1602e2020-01-14 14:39:19 +09001298
1299 installedFilesFile android.WritablePath
Jiyong Park7cd10e32020-01-14 09:22:18 +09001300
1301 // Whether to create symlink to the system file instead of having a file
1302 // inside the apex or not
1303 linkToSystemLib bool
Jiyong Park19972c72020-01-28 20:05:29 +09001304
1305 // Struct holding the merged notice file paths in different formats
1306 mergedNotices android.NoticeOutputs
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001307}
1308
Jiyong Park397e55e2018-10-24 21:09:55 +09001309func addDependenciesForNativeModules(ctx android.BottomUpMutatorContext,
Roland Levillain630846d2019-06-26 12:48:34 +01001310 native_shared_libs []string, binaries []string, tests []string,
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001311 target android.Target, imageVariation string) {
Jiyong Park397e55e2018-10-24 21:09:55 +09001312 // Use *FarVariation* to be able to depend on modules having
1313 // conflicting variations with this module. This is required since
1314 // arch variant of an APEX bundle is 'common' but it is 'arm' or 'arm64'
1315 // for native shared libs.
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001316 ctx.AddFarVariationDependencies(append(target.Variations(), []blueprint.Variation{
Jiyong Parkda6eb592018-12-19 17:12:36 +09001317 {Mutator: "image", Variation: imageVariation},
Jiyong Park397e55e2018-10-24 21:09:55 +09001318 {Mutator: "link", Variation: "shared"},
Jiyong Park28d395a2018-12-07 22:42:47 +09001319 {Mutator: "version", Variation: ""}, // "" is the non-stub variant
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001320 }...), sharedLibTag, native_shared_libs...)
Jiyong Park397e55e2018-10-24 21:09:55 +09001321
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001322 ctx.AddFarVariationDependencies(append(target.Variations(),
1323 blueprint.Variation{Mutator: "image", Variation: imageVariation}),
1324 executableTag, binaries...)
Roland Levillain630846d2019-06-26 12:48:34 +01001325
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001326 ctx.AddFarVariationDependencies(append(target.Variations(), []blueprint.Variation{
Roland Levillain630846d2019-06-26 12:48:34 +01001327 {Mutator: "image", Variation: imageVariation},
Roland Levillain9b5fde92019-06-28 15:41:19 +01001328 {Mutator: "test_per_src", Variation: ""}, // "" is the all-tests variant
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001329 }...), testTag, tests...)
Jiyong Park397e55e2018-10-24 21:09:55 +09001330}
1331
Alex Light9670d332019-01-29 18:07:33 -08001332func (a *apexBundle) combineProperties(ctx android.BottomUpMutatorContext) {
1333 if ctx.Os().Class == android.Device {
1334 proptools.AppendProperties(&a.properties.Multilib, &a.targetProperties.Target.Android.Multilib, nil)
1335 } else {
1336 proptools.AppendProperties(&a.properties.Multilib, &a.targetProperties.Target.Host.Multilib, nil)
1337 if ctx.Os().Bionic() {
1338 proptools.AppendProperties(&a.properties.Multilib, &a.targetProperties.Target.Linux_bionic.Multilib, nil)
1339 } else {
1340 proptools.AppendProperties(&a.properties.Multilib, &a.targetProperties.Target.Linux_glibc.Multilib, nil)
1341 }
1342 }
1343}
1344
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001345func (a *apexBundle) DepsMutator(ctx android.BottomUpMutatorContext) {
Jooyung Handc782442019-11-01 03:14:38 +09001346 if proptools.Bool(a.properties.Use_vendor) && !android.InList(a.Name(), useVendorWhitelist(ctx.Config())) {
1347 ctx.PropertyErrorf("use_vendor", "not allowed to set use_vendor: true")
1348 }
1349
Jiyong Park397e55e2018-10-24 21:09:55 +09001350 targets := ctx.MultiTargets()
Jiyong Park7c1dc612019-01-05 11:15:24 +09001351 config := ctx.DeviceConfig()
Alex Light9670d332019-01-29 18:07:33 -08001352
1353 a.combineProperties(ctx)
1354
Jiyong Park397e55e2018-10-24 21:09:55 +09001355 has32BitTarget := false
1356 for _, target := range targets {
1357 if target.Arch.ArchType.Multilib == "lib32" {
1358 has32BitTarget = true
1359 }
1360 }
1361 for i, target := range targets {
1362 // When multilib.* is omitted for native_shared_libs, it implies
1363 // multilib.both.
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001364 ctx.AddFarVariationDependencies(append(target.Variations(), []blueprint.Variation{
Jiyong Park7c1dc612019-01-05 11:15:24 +09001365 {Mutator: "image", Variation: a.getImageVariation(config)},
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001366 {Mutator: "link", Variation: "shared"},
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001367 }...), sharedLibTag, a.properties.Native_shared_libs...)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001368
Roland Levillain630846d2019-06-26 12:48:34 +01001369 // When multilib.* is omitted for tests, it implies
1370 // multilib.both.
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001371 ctx.AddFarVariationDependencies(append(target.Variations(), []blueprint.Variation{
Roland Levillain630846d2019-06-26 12:48:34 +01001372 {Mutator: "image", Variation: a.getImageVariation(config)},
Roland Levillain9b5fde92019-06-28 15:41:19 +01001373 {Mutator: "test_per_src", Variation: ""}, // "" is the all-tests variant
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001374 }...), testTag, a.properties.Tests...)
Roland Levillain630846d2019-06-26 12:48:34 +01001375
Jiyong Park397e55e2018-10-24 21:09:55 +09001376 // Add native modules targetting both ABIs
1377 addDependenciesForNativeModules(ctx,
1378 a.properties.Multilib.Both.Native_shared_libs,
Roland Levillain630846d2019-06-26 12:48:34 +01001379 a.properties.Multilib.Both.Binaries,
1380 a.properties.Multilib.Both.Tests,
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001381 target,
Jiyong Park7c1dc612019-01-05 11:15:24 +09001382 a.getImageVariation(config))
Jiyong Park397e55e2018-10-24 21:09:55 +09001383
Alex Light3d673592019-01-18 14:37:31 -08001384 isPrimaryAbi := i == 0
1385 if isPrimaryAbi {
Jiyong Park397e55e2018-10-24 21:09:55 +09001386 // When multilib.* is omitted for binaries, it implies
1387 // multilib.first.
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001388 ctx.AddFarVariationDependencies(append(target.Variations(),
1389 blueprint.Variation{Mutator: "image", Variation: a.getImageVariation(config)}),
1390 executableTag, a.properties.Binaries...)
Jiyong Park397e55e2018-10-24 21:09:55 +09001391
1392 // Add native modules targetting the first ABI
1393 addDependenciesForNativeModules(ctx,
1394 a.properties.Multilib.First.Native_shared_libs,
Roland Levillain630846d2019-06-26 12:48:34 +01001395 a.properties.Multilib.First.Binaries,
1396 a.properties.Multilib.First.Tests,
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001397 target,
Jiyong Park7c1dc612019-01-05 11:15:24 +09001398 a.getImageVariation(config))
Jiyong Park397e55e2018-10-24 21:09:55 +09001399 }
1400
1401 switch target.Arch.ArchType.Multilib {
1402 case "lib32":
1403 // Add native modules targetting 32-bit ABI
1404 addDependenciesForNativeModules(ctx,
1405 a.properties.Multilib.Lib32.Native_shared_libs,
Roland Levillain630846d2019-06-26 12:48:34 +01001406 a.properties.Multilib.Lib32.Binaries,
1407 a.properties.Multilib.Lib32.Tests,
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001408 target,
Jiyong Park7c1dc612019-01-05 11:15:24 +09001409 a.getImageVariation(config))
Jiyong Park397e55e2018-10-24 21:09:55 +09001410
1411 addDependenciesForNativeModules(ctx,
1412 a.properties.Multilib.Prefer32.Native_shared_libs,
Roland Levillain630846d2019-06-26 12:48:34 +01001413 a.properties.Multilib.Prefer32.Binaries,
1414 a.properties.Multilib.Prefer32.Tests,
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001415 target,
Jiyong Park7c1dc612019-01-05 11:15:24 +09001416 a.getImageVariation(config))
Jiyong Park397e55e2018-10-24 21:09:55 +09001417 case "lib64":
1418 // Add native modules targetting 64-bit ABI
1419 addDependenciesForNativeModules(ctx,
1420 a.properties.Multilib.Lib64.Native_shared_libs,
Roland Levillain630846d2019-06-26 12:48:34 +01001421 a.properties.Multilib.Lib64.Binaries,
1422 a.properties.Multilib.Lib64.Tests,
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001423 target,
Jiyong Park7c1dc612019-01-05 11:15:24 +09001424 a.getImageVariation(config))
Jiyong Park397e55e2018-10-24 21:09:55 +09001425
1426 if !has32BitTarget {
1427 addDependenciesForNativeModules(ctx,
1428 a.properties.Multilib.Prefer32.Native_shared_libs,
Roland Levillain630846d2019-06-26 12:48:34 +01001429 a.properties.Multilib.Prefer32.Binaries,
1430 a.properties.Multilib.Prefer32.Tests,
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001431 target,
Jiyong Park7c1dc612019-01-05 11:15:24 +09001432 a.getImageVariation(config))
Jiyong Park397e55e2018-10-24 21:09:55 +09001433 }
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001434
1435 if strings.HasPrefix(ctx.ModuleName(), "com.android.runtime") && target.Os.Class == android.Device {
1436 for _, sanitizer := range ctx.Config().SanitizeDevice() {
1437 if sanitizer == "hwaddress" {
1438 addDependenciesForNativeModules(ctx,
1439 []string{"libclang_rt.hwasan-aarch64-android"},
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001440 nil, nil, target, a.getImageVariation(config))
Peter Collingbourne3478bb22019-04-24 14:41:12 -07001441 break
1442 }
1443 }
1444 }
Jiyong Park397e55e2018-10-24 21:09:55 +09001445 }
1446
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001447 }
1448
Jiyong Parkce6aadc2019-11-20 13:58:28 +09001449 // For prebuilt_etc, use the first variant (64 on 64/32bit device,
1450 // 32 on 32bit device) regardless of the TARGET_PREFER_* setting.
1451 // b/144532908
1452 archForPrebuiltEtc := config.Arches()[0]
1453 for _, arch := range config.Arches() {
1454 // Prefer 64-bit arch if there is any
1455 if arch.ArchType.Multilib == "lib64" {
1456 archForPrebuiltEtc = arch
1457 break
1458 }
1459 }
1460 ctx.AddFarVariationDependencies([]blueprint.Variation{
1461 {Mutator: "os", Variation: ctx.Os().String()},
1462 {Mutator: "arch", Variation: archForPrebuiltEtc.String()},
1463 }, prebuiltTag, a.properties.Prebuilts...)
1464
Colin Cross0f7d2ef2019-10-16 11:03:10 -07001465 ctx.AddFarVariationDependencies(ctx.Config().AndroidCommonTarget.Variations(),
1466 javaLibTag, a.properties.Java_libs...)
Jiyong Parkff1458f2018-10-12 21:49:38 +09001467
Ulya Trafimovich44561882020-01-03 13:25:54 +00001468 // With EMMA_INSTRUMENT_FRAMEWORK=true the ART boot image includes jacoco library.
1469 if a.artApex && ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
1470 ctx.AddFarVariationDependencies(ctx.Config().AndroidCommonTarget.Variations(),
1471 javaLibTag, "jacocoagent")
1472 }
1473
Jiyong Park23c52b02019-02-02 13:13:47 +09001474 if String(a.properties.Key) == "" {
1475 ctx.ModuleErrorf("key is missing")
1476 return
1477 }
1478 ctx.AddDependency(ctx.Module(), keyTag, String(a.properties.Key))
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001479
Jiyong Parkb2742fd2019-02-11 11:38:15 +09001480 cert := android.SrcIsModule(a.getCertString(ctx))
Jiyong Park23c52b02019-02-02 13:13:47 +09001481 if cert != "" {
1482 ctx.AddDependency(ctx.Module(), certificateTag, cert)
Jiyong Parkc00cbd92018-10-30 21:20:05 +09001483 }
Jiyong Parkd1063c12019-07-17 20:08:41 +09001484
1485 // TODO(jiyong): ensure that all apexes are with non-empty uses_sdks
1486 if len(a.properties.Uses_sdks) > 0 {
1487 sdkRefs := []android.SdkRef{}
1488 for _, str := range a.properties.Uses_sdks {
1489 parsed := android.ParseSdkRef(ctx, str, "uses_sdks")
1490 sdkRefs = append(sdkRefs, parsed)
1491 }
1492 a.BuildWithSdks(sdkRefs)
1493 }
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001494}
1495
Jiyong Park5d790c32019-11-15 18:40:32 +09001496func (a *apexBundle) OverridablePropertiesDepsMutator(ctx android.BottomUpMutatorContext) {
1497 ctx.AddFarVariationDependencies(ctx.Config().AndroidCommonTarget.Variations(),
1498 androidAppTag, a.overridableProperties.Apps...)
1499}
1500
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001501func (a *apexBundle) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1502 // direct deps of an APEX bundle are all part of the APEX bundle
1503 return true
1504}
1505
Colin Cross0ea8ba82019-06-06 14:33:29 -07001506func (a *apexBundle) getCertString(ctx android.BaseModuleContext) string {
Jooyung Han27151d92019-12-16 17:45:32 +09001507 moduleName := ctx.ModuleName()
1508 // VNDK APEXes share the same certificate. To avoid adding a new VNDK version to the OVERRIDE_* list,
1509 // we check with the pseudo module name to see if its certificate is overridden.
1510 if a.vndkApex {
1511 moduleName = vndkApexName
1512 }
1513 certificate, overridden := ctx.DeviceConfig().OverrideCertificateFor(moduleName)
Jiyong Parkb2742fd2019-02-11 11:38:15 +09001514 if overridden {
Jaewoong Jungacb6db32019-02-28 16:22:30 +00001515 return ":" + certificate
Jiyong Parkb2742fd2019-02-11 11:38:15 +09001516 }
1517 return String(a.properties.Certificate)
1518}
1519
Colin Cross41955e82019-05-29 14:40:35 -07001520func (a *apexBundle) OutputFiles(tag string) (android.Paths, error) {
1521 switch tag {
1522 case "":
Sundong Ahnabb64432019-10-22 13:58:29 +09001523 return android.Paths{a.outputFile}, nil
Colin Cross41955e82019-05-29 14:40:35 -07001524 default:
1525 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
Jiyong Park5a832022018-12-20 09:54:35 +09001526 }
Jiyong Park74e240b2018-11-27 21:27:08 +09001527}
1528
Jiyong Park92c0f9c2018-12-13 23:14:57 +09001529func (a *apexBundle) installable() bool {
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001530 return !a.properties.PreventInstall && (a.properties.Installable == nil || proptools.Bool(a.properties.Installable))
Jiyong Park92c0f9c2018-12-13 23:14:57 +09001531}
1532
Nikita Ioffec72b5dd2019-12-07 17:30:22 +00001533func (a *apexBundle) testOnlyShouldSkipHashtreeGeneration() bool {
1534 return proptools.Bool(a.properties.Test_only_no_hashtree)
1535}
1536
Dario Freni98410fd2020-04-27 18:21:11 +01001537func (a *apexBundle) testOnlyShouldSkipPayloadSign() bool {
1538 return proptools.Bool(a.properties.Test_only_unsigned_payload)
1539}
1540
Jiyong Park7c1dc612019-01-05 11:15:24 +09001541func (a *apexBundle) getImageVariation(config android.DeviceConfig) string {
Jooyung Han31c470b2019-10-18 16:26:59 +09001542 if a.vndkApex {
Colin Cross7228ecd2019-11-18 16:00:16 -08001543 return cc.VendorVariationPrefix + a.vndkVersion(config)
Jooyung Han31c470b2019-10-18 16:26:59 +09001544 }
Jiyong Park7c1dc612019-01-05 11:15:24 +09001545 if config.VndkVersion() != "" && proptools.Bool(a.properties.Use_vendor) {
Colin Cross7228ecd2019-11-18 16:00:16 -08001546 return cc.VendorVariationPrefix + config.PlatformVndkVersion()
Jiyong Parkda6eb592018-12-19 17:12:36 +09001547 } else {
Colin Cross7228ecd2019-11-18 16:00:16 -08001548 return android.CoreVariation
Jiyong Parkda6eb592018-12-19 17:12:36 +09001549 }
1550}
1551
Jiyong Parkf97782b2019-02-13 20:28:58 +09001552func (a *apexBundle) EnableSanitizer(sanitizerName string) {
1553 if !android.InList(sanitizerName, a.properties.SanitizerNames) {
1554 a.properties.SanitizerNames = append(a.properties.SanitizerNames, sanitizerName)
1555 }
1556}
1557
Jiyong Park388ef3f2019-01-28 19:47:32 +09001558func (a *apexBundle) IsSanitizerEnabled(ctx android.BaseModuleContext, sanitizerName string) bool {
Jiyong Parkf97782b2019-02-13 20:28:58 +09001559 if android.InList(sanitizerName, a.properties.SanitizerNames) {
1560 return true
Jiyong Park235e67c2019-02-09 11:50:56 +09001561 }
1562
1563 // Then follow the global setting
Jiyong Park388ef3f2019-01-28 19:47:32 +09001564 globalSanitizerNames := []string{}
1565 if a.Host() {
1566 globalSanitizerNames = ctx.Config().SanitizeHost()
1567 } else {
1568 arches := ctx.Config().SanitizeDeviceArch()
1569 if len(arches) == 0 || android.InList(a.Arch().ArchType.Name, arches) {
1570 globalSanitizerNames = ctx.Config().SanitizeDevice()
1571 }
1572 }
1573 return android.InList(sanitizerName, globalSanitizerNames)
Jiyong Park379de2f2018-12-19 02:47:14 +09001574}
1575
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001576func (a *apexBundle) IsNativeCoverageNeeded(ctx android.BaseModuleContext) bool {
Oliver Nguyen1382ab62019-12-06 15:22:41 -08001577 return ctx.Device() && (ctx.DeviceConfig().NativeCoverageEnabled() || ctx.DeviceConfig().ClangCoverageEnabled())
Jiyong Parkee9a98d2019-08-09 14:44:36 +09001578}
1579
1580func (a *apexBundle) PreventInstall() {
1581 a.properties.PreventInstall = true
1582}
1583
1584func (a *apexBundle) HideFromMake() {
1585 a.properties.HideFromMake = true
1586}
1587
Jiyong Park956305c2020-01-09 12:32:06 +09001588func (a *apexBundle) MarkAsCoverageVariant(coverage bool) {
1589 a.properties.IsCoverageVariant = coverage
1590}
1591
Jiyong Parkf653b052019-11-18 15:39:01 +09001592// TODO(jiyong) move apexFileFor* close to the apexFile type definition
Jiyong Park1833cef2019-12-13 13:28:36 +09001593func apexFileForNativeLibrary(ctx android.BaseModuleContext, ccMod *cc.Module, handleSpecialLibs bool) apexFile {
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001594 // Decide the APEX-local directory by the multilib of the library
1595 // In the future, we may query this to the module.
Jiyong Parkf653b052019-11-18 15:39:01 +09001596 var dirInApex string
Martin Stjernholm279de572019-09-10 23:18:20 +01001597 switch ccMod.Arch().ArchType.Multilib {
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001598 case "lib32":
1599 dirInApex = "lib"
1600 case "lib64":
1601 dirInApex = "lib64"
1602 }
Martin Stjernholm279de572019-09-10 23:18:20 +01001603 dirInApex = filepath.Join(dirInApex, ccMod.RelativeInstallPath())
Colin Cross3b19f5d2019-09-17 14:45:31 -07001604 if ccMod.Target().NativeBridge == android.NativeBridgeEnabled {
Martin Stjernholm279de572019-09-10 23:18:20 +01001605 dirInApex = filepath.Join(dirInApex, ccMod.Target().NativeBridgeRelativePath)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001606 }
Jiyong Park1833cef2019-12-13 13:28:36 +09001607 if handleSpecialLibs && cc.InstallToBootstrap(ccMod.BaseModuleName(), ctx.Config()) {
Martin Stjernholm279de572019-09-10 23:18:20 +01001608 // Special case for Bionic libs and other libs installed with them. This is
1609 // to prevent those libs from being included in the search path
1610 // /apex/com.android.runtime/${LIB}. This exclusion is required because
1611 // those libs in the Runtime APEX are available via the legacy paths in
1612 // /system/lib/. By the init process, the libs in the APEX are bind-mounted
1613 // to the legacy paths and thus will be loaded into the default linker
1614 // namespace (aka "platform" namespace). If the libs are directly in
1615 // /apex/com.android.runtime/${LIB} then the same libs will be loaded again
1616 // into the runtime linker namespace, which will result in double loading of
1617 // them, which isn't supported.
1618 dirInApex = filepath.Join(dirInApex, "bionic")
Jiyong Parkb0788572018-12-20 22:10:17 +09001619 }
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001620
Jiyong Parkf653b052019-11-18 15:39:01 +09001621 fileToCopy := ccMod.OutputFile().Path()
Jiyong Park1833cef2019-12-13 13:28:36 +09001622 return newApexFile(ctx, fileToCopy, ccMod.Name(), dirInApex, nativeSharedLib, ccMod)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001623}
1624
Jiyong Park1833cef2019-12-13 13:28:36 +09001625func apexFileForExecutable(ctx android.BaseModuleContext, cc *cc.Module) apexFile {
Jiyong Parkf653b052019-11-18 15:39:01 +09001626 dirInApex := filepath.Join("bin", cc.RelativeInstallPath())
Colin Cross3b19f5d2019-09-17 14:45:31 -07001627 if cc.Target().NativeBridge == android.NativeBridgeEnabled {
dimitry8d6dde82019-07-11 10:23:53 +02001628 dirInApex = filepath.Join(dirInApex, cc.Target().NativeBridgeRelativePath)
Jiyong Parkacbf6c72019-07-09 16:19:16 +09001629 }
Jiyong Parkf653b052019-11-18 15:39:01 +09001630 fileToCopy := cc.OutputFile().Path()
Jiyong Park1833cef2019-12-13 13:28:36 +09001631 af := newApexFile(ctx, fileToCopy, cc.Name(), dirInApex, nativeExecutable, cc)
Jiyong Parkf653b052019-11-18 15:39:01 +09001632 af.symlinks = cc.Symlinks()
1633 return af
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001634}
1635
Jiyong Park1833cef2019-12-13 13:28:36 +09001636func apexFileForPyBinary(ctx android.BaseModuleContext, py *python.Module) apexFile {
Jiyong Parkf653b052019-11-18 15:39:01 +09001637 dirInApex := "bin"
1638 fileToCopy := py.HostToolPath().Path()
Jiyong Park1833cef2019-12-13 13:28:36 +09001639 return newApexFile(ctx, fileToCopy, py.Name(), dirInApex, pyBinary, py)
Alex Light778127a2019-02-27 14:19:50 -08001640}
Jiyong Park1833cef2019-12-13 13:28:36 +09001641func apexFileForGoBinary(ctx android.BaseModuleContext, depName string, gb bootstrap.GoBinaryTool) apexFile {
Jiyong Parkf653b052019-11-18 15:39:01 +09001642 dirInApex := "bin"
Alex Light778127a2019-02-27 14:19:50 -08001643 s, err := filepath.Rel(android.PathForOutput(ctx).String(), gb.InstallPath())
1644 if err != nil {
1645 ctx.ModuleErrorf("Unable to use compiled binary at %s", gb.InstallPath())
Jiyong Parkf653b052019-11-18 15:39:01 +09001646 return apexFile{}
Alex Light778127a2019-02-27 14:19:50 -08001647 }
Jiyong Parkf653b052019-11-18 15:39:01 +09001648 fileToCopy := android.PathForOutput(ctx, s)
1649 // NB: Since go binaries are static we don't need the module for anything here, which is
1650 // good since the go tool is a blueprint.Module not an android.Module like we would
1651 // normally use.
Jiyong Park1833cef2019-12-13 13:28:36 +09001652 return newApexFile(ctx, fileToCopy, depName, dirInApex, goBinary, nil)
Alex Light778127a2019-02-27 14:19:50 -08001653}
1654
Jiyong Park1833cef2019-12-13 13:28:36 +09001655func apexFileForShBinary(ctx android.BaseModuleContext, sh *android.ShBinary) apexFile {
Jiyong Parkf653b052019-11-18 15:39:01 +09001656 dirInApex := filepath.Join("bin", sh.SubDir())
1657 fileToCopy := sh.OutputFile()
Jiyong Park1833cef2019-12-13 13:28:36 +09001658 af := newApexFile(ctx, fileToCopy, sh.Name(), dirInApex, shBinary, sh)
Jiyong Parkf653b052019-11-18 15:39:01 +09001659 af.symlinks = sh.Symlinks()
1660 return af
Jiyong Park04480cf2019-02-06 00:16:29 +09001661}
1662
Paul Duffinf299cbe2020-05-14 20:49:32 +01001663func apexFileForJavaLibrary(ctx android.BaseModuleContext, lib java.Dependency, module android.Module) apexFile {
Jiyong Parkf653b052019-11-18 15:39:01 +09001664 dirInApex := "javalib"
Jooyung Han58f26ab2019-12-18 15:34:32 +09001665 fileToCopy := lib.DexJar()
Paul Duffinf299cbe2020-05-14 20:49:32 +01001666 af := newApexFile(ctx, fileToCopy, module.Name(), dirInApex, javaSharedLib, module)
Jiyong Park618922e2020-01-08 13:35:43 +09001667 af.jacocoReportClassesFile = lib.JacocoReportClassesFile()
1668 return af
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001669}
1670
Jiyong Park1833cef2019-12-13 13:28:36 +09001671func apexFileForPrebuiltEtc(ctx android.BaseModuleContext, prebuilt android.PrebuiltEtcModule, depName string) apexFile {
Jiyong Parkf653b052019-11-18 15:39:01 +09001672 dirInApex := filepath.Join("etc", prebuilt.SubDir())
1673 fileToCopy := prebuilt.OutputFile()
Jiyong Park1833cef2019-12-13 13:28:36 +09001674 return newApexFile(ctx, fileToCopy, depName, dirInApex, etc, prebuilt)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001675}
1676
atrost6e126252020-01-27 17:01:16 +00001677func apexFileForCompatConfig(ctx android.BaseModuleContext, config java.PlatformCompatConfigIntf, depName string) apexFile {
1678 dirInApex := filepath.Join("etc", config.SubDir())
1679 fileToCopy := config.CompatConfig()
1680 return newApexFile(ctx, fileToCopy, depName, dirInApex, etc, config)
1681}
1682
Jiyong Park1833cef2019-12-13 13:28:36 +09001683func apexFileForAndroidApp(ctx android.BaseModuleContext, aapp interface {
Jiyong Parkf653b052019-11-18 15:39:01 +09001684 android.Module
1685 Privileged() bool
Jooyung Han65cd0f02020-03-23 20:21:11 +09001686 InstallApkName() string
Jiyong Parkf653b052019-11-18 15:39:01 +09001687 OutputFile() android.Path
Jiyong Park618922e2020-01-08 13:35:43 +09001688 JacocoReportClassesFile() android.Path
Colin Cross503c1d02020-01-28 14:00:53 -08001689 Certificate() java.Certificate
Jooyung Han65cd0f02020-03-23 20:21:11 +09001690}) apexFile {
Jiyong Parkf7487312019-10-17 12:54:30 +09001691 appDir := "app"
Jiyong Parkf653b052019-11-18 15:39:01 +09001692 if aapp.Privileged() {
Jiyong Parkf7487312019-10-17 12:54:30 +09001693 appDir = "priv-app"
1694 }
Jooyung Han65cd0f02020-03-23 20:21:11 +09001695 dirInApex := filepath.Join(appDir, aapp.InstallApkName())
Jiyong Parkf653b052019-11-18 15:39:01 +09001696 fileToCopy := aapp.OutputFile()
Jiyong Park618922e2020-01-08 13:35:43 +09001697 af := newApexFile(ctx, fileToCopy, aapp.Name(), dirInApex, app, aapp)
1698 af.jacocoReportClassesFile = aapp.JacocoReportClassesFile()
Colin Cross503c1d02020-01-28 14:00:53 -08001699 af.certificate = aapp.Certificate()
Jiyong Parkaf8998c2020-02-28 16:51:07 +09001700
1701 if app, ok := aapp.(interface {
1702 OverriddenManifestPackageName() string
1703 }); ok {
1704 af.overriddenPackageName = app.OverriddenManifestPackageName()
1705 }
Jiyong Park618922e2020-01-08 13:35:43 +09001706 return af
Dario Frenicde2a032019-10-27 00:29:22 +01001707}
1708
Roland Levillain935639d2019-08-13 14:55:28 +01001709// Context "decorator", overriding the InstallBypassMake method to always reply `true`.
1710type flattenedApexContext struct {
1711 android.ModuleContext
1712}
1713
1714func (c *flattenedApexContext) InstallBypassMake() bool {
1715 return true
1716}
1717
Paul Duffin133608f2020-03-30 15:54:08 +01001718// Function called while walking an APEX's payload dependencies.
1719//
1720// Return true if the `to` module should be visited, false otherwise.
1721type payloadDepsCallback func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool
1722
Jiyong Park201cedd2020-02-07 17:25:49 +09001723// Visit dependencies that contributes to the payload of this APEX
Paul Duffin133608f2020-03-30 15:54:08 +01001724func (a *apexBundle) walkPayloadDeps(ctx android.ModuleContext, do payloadDepsCallback) {
Paul Duffin868ecfd2020-03-30 17:58:21 +01001725 ctx.WalkDeps(func(child, parent android.Module) bool {
Jiyong Parkfa899442020-01-31 02:49:53 +09001726 am, ok := child.(android.ApexModule)
1727 if !ok || !am.CanHaveApexVariants() {
1728 return false
1729 }
1730
1731 // Check for the direct dependencies that contribute to the payload
1732 if dt, ok := ctx.OtherModuleDependencyTag(child).(dependencyTag); ok {
1733 if dt.payload {
Paul Duffin133608f2020-03-30 15:54:08 +01001734 return do(ctx, parent, am, false /* externalDep */)
Jiyong Parkfa899442020-01-31 02:49:53 +09001735 }
Paul Duffin133608f2020-03-30 15:54:08 +01001736 // As soon as the dependency graph crosses the APEX boundary, don't go further.
Jiyong Parkfa899442020-01-31 02:49:53 +09001737 return false
1738 }
1739
1740 // Check for the indirect dependencies if it is considered as part of the APEX
Jooyung Hanb8fa86a2020-03-10 06:23:13 +09001741 if am.ApexName() != "" {
Paul Duffin133608f2020-03-30 15:54:08 +01001742 return do(ctx, parent, am, false /* externalDep */)
Jiyong Parkfa899442020-01-31 02:49:53 +09001743 }
1744
Paul Duffin133608f2020-03-30 15:54:08 +01001745 return do(ctx, parent, am, true /* externalDep */)
Jiyong Parkfa899442020-01-31 02:49:53 +09001746 })
1747}
1748
Jooyung Han0c4e0162020-02-26 22:45:42 +09001749func (a *apexBundle) minSdkVersion(ctx android.BaseModuleContext) int {
1750 ver := proptools.StringDefault(a.properties.Min_sdk_version, "current")
Jooyung Han29e91d22020-04-02 01:41:41 +09001751 intVer, err := android.ApiStrToNum(ctx, ver)
1752 if err != nil {
1753 ctx.PropertyErrorf("min_sdk_version", "%s", err.Error())
Jooyung Han0c4e0162020-02-26 22:45:42 +09001754 }
Jooyung Han29e91d22020-04-02 01:41:41 +09001755 return intVer
Jooyung Han0c4e0162020-02-26 22:45:42 +09001756}
1757
Paul Duffinf0207962020-03-31 11:31:36 +01001758// A regexp for removing boilerplate from BaseDependencyTag from the string representation of
1759// a dependency tag.
1760var tagCleaner = regexp.MustCompile(`\QBaseDependencyTag:blueprint.BaseDependencyTag{}\E(, )?`)
1761
1762func PrettyPrintTag(tag blueprint.DependencyTag) string {
1763 // Use tag's custom String() method if available.
1764 if stringer, ok := tag.(fmt.Stringer); ok {
1765 return stringer.String()
1766 }
1767
1768 // Otherwise, get a default string representation of the tag's struct.
1769 tagString := fmt.Sprintf("%#v", tag)
1770
1771 // Remove the boilerplate from BaseDependencyTag as it adds no value.
1772 tagString = tagCleaner.ReplaceAllString(tagString, "")
1773 return tagString
1774}
1775
Artur Satayev2b4b7bb2020-04-28 14:57:42 +01001776func (a *apexBundle) Updatable() bool {
1777 return proptools.Bool(a.properties.Updatable)
1778}
1779
1780var _ android.ApexBundleDepsInfoIntf = (*apexBundle)(nil)
1781
Jiyong Park201cedd2020-02-07 17:25:49 +09001782// Ensures that the dependencies are marked as available for this APEX
1783func (a *apexBundle) checkApexAvailability(ctx android.ModuleContext) {
1784 // Let's be practical. Availability for test, host, and the VNDK apex isn't important
1785 if ctx.Host() || a.testApex || a.vndkApex {
1786 return
1787 }
1788
Jiyong Parkd5e0ea22020-03-28 14:43:19 +09001789 // Coverage build adds additional dependencies for the coverage-only runtime libraries.
1790 // Requiring them and their transitive depencies with apex_available is not right
1791 // because they just add noise.
1792 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") || a.IsNativeCoverageNeeded(ctx) {
1793 return
1794 }
1795
Paul Duffin133608f2020-03-30 15:54:08 +01001796 a.walkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
1797 if externalDep {
1798 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1799 return false
1800 }
1801
Jiyong Park201cedd2020-02-07 17:25:49 +09001802 apexName := ctx.ModuleName()
Jooyung Hanb8fa86a2020-03-10 06:23:13 +09001803 fromName := ctx.OtherModuleName(from)
1804 toName := ctx.OtherModuleName(to)
Paul Duffinb20ad0a2020-03-31 15:23:40 +01001805
1806 // If `to` is not actually in the same APEX as `from` then it does not need apex_available and neither
1807 // do any of its dependencies.
1808 if am, ok := from.(android.DepIsInSameApex); ok && !am.DepIsInSameApex(ctx, to) {
1809 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1810 return false
1811 }
1812
Paul Duffin133608f2020-03-30 15:54:08 +01001813 if to.AvailableFor(apexName) || whitelistedApexAvailable(apexName, toName) {
1814 return true
Jiyong Park201cedd2020-02-07 17:25:49 +09001815 }
Paul Duffin868ecfd2020-03-30 17:58:21 +01001816 message := ""
Paul Duffinf0207962020-03-31 11:31:36 +01001817 tagPath := ctx.GetTagPath()
1818 // Skip the first module as that will be added at the start of the error message by ctx.ModuleErrorf().
1819 walkPath := ctx.GetWalkPath()[1:]
1820 for i, m := range walkPath {
1821 message = fmt.Sprintf("%s\n via tag %s\n -> %s", message, PrettyPrintTag(tagPath[i]), m.String())
Paul Duffin868ecfd2020-03-30 17:58:21 +01001822 }
1823 ctx.ModuleErrorf("%q requires %q that is not available for the APEX. Dependency path:%s", fromName, toName, message)
Paul Duffin133608f2020-03-30 15:54:08 +01001824 // Visit this module's dependencies to check and report any issues with their availability.
1825 return true
Jiyong Park201cedd2020-02-07 17:25:49 +09001826 })
1827}
1828
Jooyung Hanced674e2020-04-27 12:10:30 +09001829func (a *apexBundle) checkUpdatable(ctx android.ModuleContext) {
Artur Satayev2b4b7bb2020-04-28 14:57:42 +01001830 if a.Updatable() {
Jooyung Hanced674e2020-04-27 12:10:30 +09001831 if String(a.properties.Min_sdk_version) == "" {
1832 ctx.PropertyErrorf("updatable", "updatable APEXes should set min_sdk_version as well")
1833 }
Artur Satayev2eedf622020-04-15 17:29:42 +01001834
1835 a.checkJavaStableSdkVersion(ctx)
Jooyung Hanced674e2020-04-27 12:10:30 +09001836 }
1837}
1838
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001839func (a *apexBundle) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Sundong Ahnabb64432019-10-22 13:58:29 +09001840 buildFlattenedAsDefault := ctx.Config().FlattenApex() && !ctx.Config().UnbundledBuild()
1841 switch a.properties.ApexType {
1842 case imageApex:
1843 if buildFlattenedAsDefault {
1844 a.suffix = imageApexSuffix
1845 } else {
1846 a.suffix = ""
1847 a.primaryApexType = true
Jooyung Han3ab2c3e2019-12-05 16:27:44 +09001848
1849 if ctx.Config().InstallExtraFlattenedApexes() {
Jiyong Park956305c2020-01-09 12:32:06 +09001850 a.requiredDeps = append(a.requiredDeps, a.Name()+flattenedSuffix)
Jooyung Han3ab2c3e2019-12-05 16:27:44 +09001851 }
Sundong Ahnabb64432019-10-22 13:58:29 +09001852 }
1853 case zipApex:
1854 if proptools.String(a.properties.Payload_type) == "zip" {
1855 a.suffix = ""
1856 a.primaryApexType = true
1857 } else {
1858 a.suffix = zipApexSuffix
1859 }
1860 case flattenedApex:
1861 if buildFlattenedAsDefault {
1862 a.suffix = ""
1863 a.primaryApexType = true
1864 } else {
1865 a.suffix = flattenedSuffix
1866 }
Alex Light5098a612018-11-29 17:12:15 -08001867 }
1868
Roland Levillain630846d2019-06-26 12:48:34 +01001869 if len(a.properties.Tests) > 0 && !a.testApex {
1870 ctx.PropertyErrorf("tests", "property not allowed in apex module type")
1871 return
1872 }
1873
Jiyong Parkfa899442020-01-31 02:49:53 +09001874 a.checkApexAvailability(ctx)
Jooyung Hanced674e2020-04-27 12:10:30 +09001875 a.checkUpdatable(ctx)
Jiyong Park678c8812020-02-07 17:25:49 +09001876
Alex Lightfc0bd7c2019-01-29 18:31:59 -08001877 handleSpecialLibs := !android.Bool(a.properties.Ignore_system_library_special_case)
1878
Jooyung Hane1633032019-08-01 17:41:43 +09001879 // native lib dependencies
1880 var provideNativeLibs []string
1881 var requireNativeLibs []string
1882
Jooyung Han5c998b92019-06-27 11:30:33 +09001883 // Check if "uses" requirements are met with dependent apexBundles
1884 var providedNativeSharedLibs []string
1885 useVendor := proptools.Bool(a.properties.Use_vendor)
1886 ctx.VisitDirectDepsBlueprint(func(m blueprint.Module) {
1887 if ctx.OtherModuleDependencyTag(m) != usesTag {
1888 return
1889 }
1890 otherName := ctx.OtherModuleName(m)
1891 other, ok := m.(*apexBundle)
1892 if !ok {
1893 ctx.PropertyErrorf("uses", "%q is not a provider", otherName)
1894 return
1895 }
1896 if proptools.Bool(other.properties.Use_vendor) != useVendor {
1897 ctx.PropertyErrorf("use_vendor", "%q has different value of use_vendor", otherName)
1898 return
1899 }
1900 if !proptools.Bool(other.properties.Provide_cpp_shared_libs) {
1901 ctx.PropertyErrorf("uses", "%q does not provide native_shared_libs", otherName)
1902 return
1903 }
1904 providedNativeSharedLibs = append(providedNativeSharedLibs, other.properties.Native_shared_libs...)
1905 })
1906
Jiyong Parkf653b052019-11-18 15:39:01 +09001907 var filesInfo []apexFile
Jiyong Park678c8812020-02-07 17:25:49 +09001908 // TODO(jiyong) do this using walkPayloadDeps
Alex Light778127a2019-02-27 14:19:50 -08001909 ctx.WalkDepsBlueprint(func(child, parent blueprint.Module) bool {
Roland Levillainf89cd092019-07-29 16:22:59 +01001910 depTag := ctx.OtherModuleDependencyTag(child)
Paul Duffin3766cb72020-04-07 15:25:44 +01001911 if _, ok := depTag.(android.ExcludeFromApexContentsTag); ok {
1912 return false
1913 }
Roland Levillainf89cd092019-07-29 16:22:59 +01001914 depName := ctx.OtherModuleName(child)
Jiyong Parkf653b052019-11-18 15:39:01 +09001915 if _, isDirectDep := parent.(*apexBundle); isDirectDep {
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001916 switch depTag {
1917 case sharedLibTag:
Jooyung Hanfaa2d5f2020-02-06 17:42:40 +09001918 if c, ok := child.(*cc.Module); ok {
1919 // bootstrap bionic libs are treated as provided by system
1920 if c.HasStubsVariants() && !cc.InstallToBootstrap(c.BaseModuleName(), ctx.Config()) {
1921 provideNativeLibs = append(provideNativeLibs, c.OutputFile().Path().Base())
Jooyung Hane1633032019-08-01 17:41:43 +09001922 }
Jooyung Hanfaa2d5f2020-02-06 17:42:40 +09001923 filesInfo = append(filesInfo, apexFileForNativeLibrary(ctx, c, handleSpecialLibs))
Jiyong Parkf653b052019-11-18 15:39:01 +09001924 return true // track transitive dependencies
Jiyong Parkff1458f2018-10-12 21:49:38 +09001925 } else {
1926 ctx.PropertyErrorf("native_shared_libs", "%q is not a cc_library or cc_library_shared module", depName)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001927 }
1928 case executableTag:
1929 if cc, ok := child.(*cc.Module); ok {
Jiyong Park1833cef2019-12-13 13:28:36 +09001930 filesInfo = append(filesInfo, apexFileForExecutable(ctx, cc))
Jiyong Parkf653b052019-11-18 15:39:01 +09001931 return true // track transitive dependencies
Jiyong Park04480cf2019-02-06 00:16:29 +09001932 } else if sh, ok := child.(*android.ShBinary); ok {
Jiyong Park1833cef2019-12-13 13:28:36 +09001933 filesInfo = append(filesInfo, apexFileForShBinary(ctx, sh))
Alex Light778127a2019-02-27 14:19:50 -08001934 } else if py, ok := child.(*python.Module); ok && py.HostToolPath().Valid() {
Jiyong Park1833cef2019-12-13 13:28:36 +09001935 filesInfo = append(filesInfo, apexFileForPyBinary(ctx, py))
Alex Light778127a2019-02-27 14:19:50 -08001936 } else if gb, ok := child.(bootstrap.GoBinaryTool); ok && a.Host() {
Jiyong Parkf653b052019-11-18 15:39:01 +09001937 filesInfo = append(filesInfo, apexFileForGoBinary(ctx, depName, gb))
Jiyong Parkff1458f2018-10-12 21:49:38 +09001938 } else {
Alex Light778127a2019-02-27 14:19:50 -08001939 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 +09001940 }
1941 case javaLibTag:
Jiyong Park9e6c2422019-08-09 20:39:45 +09001942 if javaLib, ok := child.(*java.Library); ok {
Paul Duffinf299cbe2020-05-14 20:49:32 +01001943 af := apexFileForJavaLibrary(ctx, javaLib, javaLib)
Jiyong Parkf653b052019-11-18 15:39:01 +09001944 if !af.Ok() {
Jiyong Park8fd61922018-11-08 02:50:25 +09001945 ctx.PropertyErrorf("java_libs", "%q is not configured to be compiled into dex", depName)
1946 } else {
Jiyong Parkf653b052019-11-18 15:39:01 +09001947 filesInfo = append(filesInfo, af)
1948 return true // track transitive dependencies
Jiyong Park9e6c2422019-08-09 20:39:45 +09001949 }
Jooyung Han58f26ab2019-12-18 15:34:32 +09001950 } else if sdkLib, ok := child.(*java.SdkLibrary); ok {
Paul Duffinf299cbe2020-05-14 20:49:32 +01001951 af := apexFileForJavaLibrary(ctx, sdkLib, sdkLib)
Jooyung Han58f26ab2019-12-18 15:34:32 +09001952 if !af.Ok() {
1953 ctx.PropertyErrorf("java_libs", "%q is not configured to be compiled into dex", depName)
1954 return false
1955 }
1956 filesInfo = append(filesInfo, af)
Jooyung Han58f26ab2019-12-18 15:34:32 +09001957 return true // track transitive dependencies
Jiyong Parkff1458f2018-10-12 21:49:38 +09001958 } else {
Jiyong Park9e6c2422019-08-09 20:39:45 +09001959 ctx.PropertyErrorf("java_libs", "%q of type %q is not supported", depName, ctx.OtherModuleType(child))
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001960 }
Jiyong Parkf653b052019-11-18 15:39:01 +09001961 case androidAppTag:
Jiyong Parkf653b052019-11-18 15:39:01 +09001962 if ap, ok := child.(*java.AndroidApp); ok {
Jooyung Han65cd0f02020-03-23 20:21:11 +09001963 filesInfo = append(filesInfo, apexFileForAndroidApp(ctx, ap))
Jiyong Parkf653b052019-11-18 15:39:01 +09001964 return true // track transitive dependencies
1965 } else if ap, ok := child.(*java.AndroidAppImport); ok {
Jooyung Han65cd0f02020-03-23 20:21:11 +09001966 filesInfo = append(filesInfo, apexFileForAndroidApp(ctx, ap))
Dario Freni6f3937c2019-12-20 22:58:03 +00001967 } else if ap, ok := child.(*java.AndroidTestHelperApp); ok {
Jooyung Han65cd0f02020-03-23 20:21:11 +09001968 filesInfo = append(filesInfo, apexFileForAndroidApp(ctx, ap))
Jiyong Parkf653b052019-11-18 15:39:01 +09001969 } else {
1970 ctx.PropertyErrorf("apps", "%q is not an android_app module", depName)
1971 }
Jiyong Park48ca7dc2018-10-10 14:01:00 +09001972 case prebuiltTag:
Jooyung Han39edb6c2019-11-06 16:53:07 +09001973 if prebuilt, ok := child.(android.PrebuiltEtcModule); ok {
Jiyong Park1833cef2019-12-13 13:28:36 +09001974 filesInfo = append(filesInfo, apexFileForPrebuiltEtc(ctx, prebuilt, depName))
atrost6e126252020-01-27 17:01:16 +00001975 } else if prebuilt, ok := child.(java.PlatformCompatConfigIntf); ok {
1976 filesInfo = append(filesInfo, apexFileForCompatConfig(ctx, prebuilt, depName))
Jiyong Parkff1458f2018-10-12 21:49:38 +09001977 } else {
atrost6e126252020-01-27 17:01:16 +00001978 ctx.PropertyErrorf("prebuilts", "%q is not a prebuilt_etc and not a platform_compat_config module", depName)
Jiyong Parkff1458f2018-10-12 21:49:38 +09001979 }
Roland Levillain630846d2019-06-26 12:48:34 +01001980 case testTag:
Roland Levillainf89cd092019-07-29 16:22:59 +01001981 if ccTest, ok := child.(*cc.Module); ok {
1982 if ccTest.IsTestPerSrcAllTestsVariation() {
1983 // Multiple-output test module (where `test_per_src: true`).
1984 //
1985 // `ccTest` is the "" ("all tests") variation of a `test_per_src` module.
1986 // We do not add this variation to `filesInfo`, as it has no output;
1987 // however, we do add the other variations of this module as indirect
1988 // dependencies (see below).
1989 return true
Roland Levillain9b5fde92019-06-28 15:41:19 +01001990 } else {
Roland Levillainf89cd092019-07-29 16:22:59 +01001991 // Single-output test module (where `test_per_src: false`).
Jiyong Park1833cef2019-12-13 13:28:36 +09001992 af := apexFileForExecutable(ctx, ccTest)
Jiyong Parkf653b052019-11-18 15:39:01 +09001993 af.class = nativeTest
1994 filesInfo = append(filesInfo, af)
Roland Levillain9b5fde92019-06-28 15:41:19 +01001995 }
Roland Levillain630846d2019-06-26 12:48:34 +01001996 } else {
1997 ctx.PropertyErrorf("tests", "%q is not a cc module", depName)
1998 }
Jiyong Parkff1458f2018-10-12 21:49:38 +09001999 case keyTag:
2000 if key, ok := child.(*apexKey); ok {
Jiyong Park0ca3ce82019-02-18 15:25:04 +09002001 a.private_key_file = key.private_key_file
2002 a.public_key_file = key.public_key_file
Jiyong Parkff1458f2018-10-12 21:49:38 +09002003 } else {
2004 ctx.PropertyErrorf("key", "%q is not an apex_key module", depName)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09002005 }
Jiyong Parkf653b052019-11-18 15:39:01 +09002006 return false
Jiyong Parkc00cbd92018-10-30 21:20:05 +09002007 case certificateTag:
2008 if dep, ok := child.(*java.AndroidAppCertificate); ok {
Jiyong Park0ca3ce82019-02-18 15:25:04 +09002009 a.container_certificate_file = dep.Certificate.Pem
2010 a.container_private_key_file = dep.Certificate.Key
Jiyong Parkc00cbd92018-10-30 21:20:05 +09002011 } else {
2012 ctx.ModuleErrorf("certificate dependency %q must be an android_app_certificate module", depName)
2013 }
Jiyong Park03b68dd2019-07-26 23:20:40 +09002014 case android.PrebuiltDepTag:
2015 // If the prebuilt is force disabled, remember to delete the prebuilt file
2016 // that might have been installed in the previous builds
2017 if prebuilt, ok := child.(*Prebuilt); ok && prebuilt.isForceDisabled() {
2018 a.prebuiltFileToDelete = prebuilt.InstallFilename()
2019 }
Jiyong Park48ca7dc2018-10-10 14:01:00 +09002020 }
Jooyung Han8aee2042019-10-29 05:08:31 +09002021 } else if !a.vndkApex {
Jiyong Park48ca7dc2018-10-10 14:01:00 +09002022 // indirect dependencies
Jooyung Han9c80bae2019-08-20 17:30:57 +09002023 if am, ok := child.(android.ApexModule); ok {
Roland Levillainf89cd092019-07-29 16:22:59 +01002024 // We cannot use a switch statement on `depTag` here as the checked
2025 // tags used below are private (e.g. `cc.sharedDepTag`).
Jiyong Park52cd06f2019-11-11 10:14:32 +09002026 if cc.IsSharedDepTag(depTag) || cc.IsRuntimeDepTag(depTag) {
Roland Levillainf89cd092019-07-29 16:22:59 +01002027 if cc, ok := child.(*cc.Module); ok {
2028 if android.InList(cc.Name(), providedNativeSharedLibs) {
2029 // If we're using a shared library which is provided from other APEX,
2030 // don't include it in this APEX
2031 return false
Jiyong Parkac2bacd2019-02-20 21:49:26 +09002032 }
Jooyung Han671f1ce2019-12-17 12:47:13 +09002033 if !a.Host() && !android.DirectlyInApex(ctx.ModuleName(), ctx.OtherModuleName(cc)) && (cc.IsStubs() || cc.HasStubsVariants()) {
Roland Levillainf89cd092019-07-29 16:22:59 +01002034 // If the dependency is a stubs lib, don't include it in this APEX,
2035 // but make sure that the lib is installed on the device.
2036 // In case no APEX is having the lib, the lib is installed to the system
2037 // partition.
2038 //
2039 // Always include if we are a host-apex however since those won't have any
2040 // system libraries.
Jiyong Park956305c2020-01-09 12:32:06 +09002041 if !android.DirectlyInAnyApex(ctx, cc.Name()) && !android.InList(cc.Name(), a.requiredDeps) {
2042 a.requiredDeps = append(a.requiredDeps, cc.Name())
Roland Levillainf89cd092019-07-29 16:22:59 +01002043 }
Jooyung Hane1633032019-08-01 17:41:43 +09002044 requireNativeLibs = append(requireNativeLibs, cc.OutputFile().Path().Base())
Roland Levillainf89cd092019-07-29 16:22:59 +01002045 // Don't track further
2046 return false
2047 }
Jiyong Park1833cef2019-12-13 13:28:36 +09002048 af := apexFileForNativeLibrary(ctx, cc, handleSpecialLibs)
Jiyong Parkf653b052019-11-18 15:39:01 +09002049 af.transitiveDep = true
2050 filesInfo = append(filesInfo, af)
2051 return true // track transitive dependencies
Jiyong Park25fc6a92018-11-18 18:02:45 +09002052 }
Roland Levillainf89cd092019-07-29 16:22:59 +01002053 } else if cc.IsTestPerSrcDepTag(depTag) {
2054 if cc, ok := child.(*cc.Module); ok {
Jiyong Park1833cef2019-12-13 13:28:36 +09002055 af := apexFileForExecutable(ctx, cc)
Roland Levillainf89cd092019-07-29 16:22:59 +01002056 // Handle modules created as `test_per_src` variations of a single test module:
2057 // use the name of the generated test binary (`fileToCopy`) instead of the name
2058 // of the original test module (`depName`, shared by all `test_per_src`
2059 // variations of that module).
Jiyong Parkf653b052019-11-18 15:39:01 +09002060 af.moduleName = filepath.Base(af.builtFile.String())
Jiyong Park7cd10e32020-01-14 09:22:18 +09002061 // these are not considered transitive dep
2062 af.transitiveDep = false
Jiyong Parkf653b052019-11-18 15:39:01 +09002063 filesInfo = append(filesInfo, af)
2064 return true // track transitive dependencies
Roland Levillainf89cd092019-07-29 16:22:59 +01002065 }
Jiyong Park52cd06f2019-11-11 10:14:32 +09002066 } else if java.IsJniDepTag(depTag) {
Jooyung Han65041792020-02-25 16:59:29 +09002067 // Because APK-in-APEX embeds jni_libs transitively, we don't need to track transitive deps
2068 return false
Jiyong Parke3833882020-02-17 17:28:10 +09002069 } else if java.IsXmlPermissionsFileDepTag(depTag) {
2070 if prebuilt, ok := child.(android.PrebuiltEtcModule); ok {
2071 filesInfo = append(filesInfo, apexFileForPrebuiltEtc(ctx, prebuilt, depName))
2072 }
Jooyung Han9c80bae2019-08-20 17:30:57 +09002073 } else if am.CanHaveApexVariants() && am.IsInstallableToApex() {
Paul Duffin3766cb72020-04-07 15:25:44 +01002074 ctx.ModuleErrorf("unexpected tag %s for indirect dependency %q", PrettyPrintTag(depTag), depName)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09002075 }
2076 }
2077 }
2078 return false
2079 })
2080
Ulyana Trafimovichde534412019-11-08 10:51:01 +00002081 // Specific to the ART apex: dexpreopt artifacts for libcore Java libraries.
2082 // Build rules are generated by the dexpreopt singleton, and here we access build artifacts
2083 // via the global boot image config.
2084 if a.artApex {
2085 for arch, files := range java.DexpreoptedArtApexJars(ctx) {
2086 dirInApex := filepath.Join("javalib", arch.String())
2087 for _, f := range files {
2088 localModule := "javalib_" + arch.String() + "_" + filepath.Base(f.String())
Jiyong Park1833cef2019-12-13 13:28:36 +09002089 af := newApexFile(ctx, f, localModule, dirInApex, etc, nil)
Jiyong Parkf653b052019-11-18 15:39:01 +09002090 filesInfo = append(filesInfo, af)
Ulyana Trafimovichde534412019-11-08 10:51:01 +00002091 }
2092 }
2093 }
2094
Jiyong Park0ca3ce82019-02-18 15:25:04 +09002095 if a.private_key_file == nil {
Jiyong Parkfa0a3732018-11-09 05:52:26 +09002096 ctx.PropertyErrorf("key", "private_key for %q could not be found", String(a.properties.Key))
2097 return
2098 }
2099
Jiyong Park8fd61922018-11-08 02:50:25 +09002100 // remove duplicates in filesInfo
2101 removeDup := func(filesInfo []apexFile) []apexFile {
Jiyong Park7cd10e32020-01-14 09:22:18 +09002102 encountered := make(map[string]apexFile)
Jiyong Park8fd61922018-11-08 02:50:25 +09002103 for _, f := range filesInfo {
Jooyung Han344d5432019-08-23 11:17:39 +09002104 dest := filepath.Join(f.installDir, f.builtFile.Base())
Jiyong Park7cd10e32020-01-14 09:22:18 +09002105 if e, ok := encountered[dest]; !ok {
2106 encountered[dest] = f
2107 } else {
2108 // If a module is directly included and also transitively depended on
2109 // consider it as directly included.
2110 e.transitiveDep = e.transitiveDep && f.transitiveDep
2111 encountered[dest] = e
Jiyong Park8fd61922018-11-08 02:50:25 +09002112 }
2113 }
Jiyong Park7cd10e32020-01-14 09:22:18 +09002114 var result []apexFile
2115 for _, v := range encountered {
2116 result = append(result, v)
2117 }
Jiyong Park8fd61922018-11-08 02:50:25 +09002118 return result
2119 }
2120 filesInfo = removeDup(filesInfo)
2121
2122 // to have consistent build rules
2123 sort.Slice(filesInfo, func(i, j int) bool {
2124 return filesInfo[i].builtFile.String() < filesInfo[j].builtFile.String()
2125 })
2126
Jiyong Park8fd61922018-11-08 02:50:25 +09002127 a.installDir = android.PathForModuleInstall(ctx, "apex")
2128 a.filesInfo = filesInfo
Alex Light5098a612018-11-29 17:12:15 -08002129
Jooyung Han54aca7b2019-11-20 02:26:02 +09002130 if a.properties.ApexType != zipApex {
2131 if a.properties.File_contexts == nil {
2132 a.fileContexts = android.PathForSource(ctx, "system/sepolicy/apex", ctx.ModuleName()+"-file_contexts")
2133 } else {
2134 a.fileContexts = android.PathForModuleSrc(ctx, *a.properties.File_contexts)
2135 if a.Platform() {
2136 if matched, err := path.Match("system/sepolicy/**/*", a.fileContexts.String()); err != nil || !matched {
2137 ctx.PropertyErrorf("file_contexts", "should be under system/sepolicy, but %q", a.fileContexts)
2138 }
2139 }
2140 }
2141 if !android.ExistentPathForSource(ctx, a.fileContexts.String()).Valid() {
2142 ctx.PropertyErrorf("file_contexts", "cannot find file_contexts file: %q", a.fileContexts)
2143 return
2144 }
2145 }
Jiyong Park7cd10e32020-01-14 09:22:18 +09002146 // Optimization. If we are building bundled APEX, for the files that are gathered due to the
2147 // transitive dependencies, don't place them inside the APEX, but place a symlink pointing
2148 // the same library in the system partition, thus effectively sharing the same libraries
2149 // across the APEX boundary. For unbundled APEX, all the gathered files are actually placed
2150 // in the APEX.
2151 a.linkToSystemLib = !ctx.Config().UnbundledBuild() &&
2152 a.installable() &&
2153 !proptools.Bool(a.properties.Use_vendor)
Jooyung Han54aca7b2019-11-20 02:26:02 +09002154
Jiyong Park9d677202020-02-19 16:29:35 +09002155 // We don't need the optimization for updatable APEXes, as it might give false signal
2156 // to the system health when the APEXes are still bundled (b/149805758)
Artur Satayev2b4b7bb2020-04-28 14:57:42 +01002157 if a.Updatable() && a.properties.ApexType == imageApex {
Jiyong Park9d677202020-02-19 16:29:35 +09002158 a.linkToSystemLib = false
2159 }
2160
Jiyong Park9b964182020-02-26 18:27:19 +09002161 // We also don't want the optimization for host APEXes, because it doesn't make sense.
2162 if ctx.Host() {
2163 a.linkToSystemLib = false
2164 }
2165
Jooyung Hand15aa1f2019-09-27 00:38:03 +09002166 // prepare apex_manifest.json
Jooyung Han01a3ee22019-11-02 02:52:25 +09002167 a.buildManifest(ctx, provideNativeLibs, requireNativeLibs)
2168
2169 a.setCertificateAndPrivateKey(ctx)
2170 if a.properties.ApexType == flattenedApex {
2171 a.buildFlattenedApex(ctx)
2172 } else {
2173 a.buildUnflattenedApex(ctx)
2174 }
2175
Jooyung Han002ab682020-01-08 01:57:58 +09002176 a.compatSymlinks = makeCompatSymlinks(a.BaseModuleName(), ctx)
Jiyong Park956305c2020-01-09 12:32:06 +09002177
2178 a.buildApexDependencyInfo(ctx)
Jooyung Han01a3ee22019-11-02 02:52:25 +09002179}
2180
Artur Satayev2eedf622020-04-15 17:29:42 +01002181// Enforce that Java deps of the apex are using stable SDKs to compile
2182func (a *apexBundle) checkJavaStableSdkVersion(ctx android.ModuleContext) {
2183 // Visit direct deps only. As long as we guarantee top-level deps are using
2184 // stable SDKs, java's checkLinkType guarantees correct usage for transitive deps
2185 ctx.VisitDirectDepsBlueprint(func(module blueprint.Module) {
2186 tag := ctx.OtherModuleDependencyTag(module)
2187 switch tag {
2188 case javaLibTag, androidAppTag:
2189 if m, ok := module.(interface{ CheckStableSdkVersion() error }); ok {
2190 if err := m.CheckStableSdkVersion(); err != nil {
2191 ctx.ModuleErrorf("cannot depend on \"%v\": %v", ctx.OtherModuleName(module), err)
2192 }
2193 }
2194 }
2195 })
2196}
2197
Jooyung Hanb8fa86a2020-03-10 06:23:13 +09002198func whitelistedApexAvailable(apex, moduleName string) bool {
Anton Hansson5053c292020-01-10 15:12:39 +00002199 key := apex
Paul Duffin404db3f2020-03-06 12:30:13 +00002200 moduleName = normalizeModuleName(moduleName)
2201
2202 if val, ok := apexAvailWl[key]; ok && android.InList(moduleName, val) {
2203 return true
2204 }
2205
2206 key = android.AvailableToAnyApex
2207 if val, ok := apexAvailWl[key]; ok && android.InList(moduleName, val) {
2208 return true
2209 }
2210
2211 return false
2212}
2213
2214func normalizeModuleName(moduleName string) string {
Jiyong Parkfa899442020-01-31 02:49:53 +09002215 // Prebuilt modules (e.g. java_import, etc.) have "prebuilt_" prefix added by the build
2216 // system. Trim the prefix for the check since they are confusing
2217 moduleName = strings.TrimPrefix(moduleName, "prebuilt_")
2218 if strings.HasPrefix(moduleName, "libclang_rt.") {
2219 // This module has many arch variants that depend on the product being built.
2220 // We don't want to list them all
2221 moduleName = "libclang_rt"
Anton Hansson5053c292020-01-10 15:12:39 +00002222 }
Jooyung Han11c20932020-05-19 15:47:01 +09002223 if strings.HasPrefix(moduleName, "androidx.") {
2224 // TODO(b/156996905) Set apex_available/min_sdk_version for androidx support libraries
2225 moduleName = "androidx"
2226 }
Paul Duffin404db3f2020-03-06 12:30:13 +00002227 return moduleName
Anton Hansson5053c292020-01-10 15:12:39 +00002228}
2229
Jooyung Han344d5432019-08-23 11:17:39 +09002230func newApexBundle() *apexBundle {
Sundong Ahnabb64432019-10-22 13:58:29 +09002231 module := &apexBundle{}
Jiyong Park48ca7dc2018-10-10 14:01:00 +09002232 module.AddProperties(&module.properties)
Alex Light9670d332019-01-29 18:07:33 -08002233 module.AddProperties(&module.targetProperties)
Jiyong Park5d790c32019-11-15 18:40:32 +09002234 module.AddProperties(&module.overridableProperties)
Alex Light5098a612018-11-29 17:12:15 -08002235 module.Prefer32(func(ctx android.BaseModuleContext, base *android.ModuleBase, class android.OsClass) bool {
Jiyong Park397e55e2018-10-24 21:09:55 +09002236 return class == android.Device && ctx.Config().DevicePrefer32BitExecutables()
2237 })
Alex Light5098a612018-11-29 17:12:15 -08002238 android.InitAndroidMultiTargetsArchModule(module, android.HostAndDeviceSupported, android.MultilibCommon)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09002239 android.InitDefaultableModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002240 android.InitSdkAwareModule(module)
Jaewoong Jung7abcf8e2019-12-19 17:32:06 -08002241 android.InitOverridableModule(module, &module.overridableProperties.Overrides)
Jiyong Park48ca7dc2018-10-10 14:01:00 +09002242 return module
2243}
Jiyong Park30ca9372019-02-07 16:27:23 +09002244
Ulyana Trafimovichde534412019-11-08 10:51:01 +00002245func ApexBundleFactory(testApex bool, artApex bool) android.Module {
Jooyung Han344d5432019-08-23 11:17:39 +09002246 bundle := newApexBundle()
2247 bundle.testApex = testApex
Ulyana Trafimovichde534412019-11-08 10:51:01 +00002248 bundle.artApex = artApex
Jooyung Han344d5432019-08-23 11:17:39 +09002249 return bundle
2250}
2251
Jiyong Parkfce0b422020-02-11 03:56:06 +09002252// apex_test is an APEX for testing. The difference from the ordinary apex module type is that
2253// certain compatibility checks such as apex_available are not done for apex_test.
Jooyung Han344d5432019-08-23 11:17:39 +09002254func testApexBundleFactory() android.Module {
2255 bundle := newApexBundle()
2256 bundle.testApex = true
2257 return bundle
2258}
2259
Jiyong Parkfce0b422020-02-11 03:56:06 +09002260// apex packages other modules into an APEX file which is a packaging format for system-level
2261// components like binaries, shared libraries, etc.
Jiyong Parkd1063c12019-07-17 20:08:41 +09002262func BundleFactory() android.Module {
Jooyung Han344d5432019-08-23 11:17:39 +09002263 return newApexBundle()
2264}
2265
Jiyong Park30ca9372019-02-07 16:27:23 +09002266//
2267// Defaults
2268//
2269type Defaults struct {
2270 android.ModuleBase
2271 android.DefaultsModuleBase
2272}
2273
Jiyong Park30ca9372019-02-07 16:27:23 +09002274func defaultsFactory() android.Module {
2275 return DefaultsFactory()
2276}
2277
2278func DefaultsFactory(props ...interface{}) android.Module {
2279 module := &Defaults{}
2280
2281 module.AddProperties(props...)
2282 module.AddProperties(
2283 &apexBundleProperties{},
2284 &apexTargetBundleProperties{},
Jooyung Hanf21c7972019-12-16 22:32:06 +09002285 &overridableProperties{},
Jiyong Park30ca9372019-02-07 16:27:23 +09002286 )
2287
2288 android.InitDefaultsModule(module)
2289 return module
2290}
Jiyong Park5d790c32019-11-15 18:40:32 +09002291
2292//
2293// OverrideApex
2294//
2295type OverrideApex struct {
2296 android.ModuleBase
2297 android.OverrideModuleBase
2298}
2299
2300func (o *OverrideApex) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2301 // All the overrides happen in the base module.
2302}
2303
2304// override_apex is used to create an apex module based on another apex module
2305// by overriding some of its properties.
2306func overrideApexFactory() android.Module {
2307 m := &OverrideApex{}
2308 m.AddProperties(&overridableProperties{})
2309
2310 android.InitAndroidMultiTargetsArchModule(m, android.DeviceSupported, android.MultilibCommon)
2311 android.InitOverrideModule(m)
2312 return m
2313}