blob: 03a0bb90254a84a37e36a6d81ec6f9598d4ad9a0 [file] [log] [blame]
Jiyong Park09d77522019-11-18 11:16:27 +09001// Copyright (C) 2019 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 (
Jiyong Parkbd159612020-02-28 15:22:21 +090018 "encoding/json"
Jiyong Park09d77522019-11-18 11:16:27 +090019 "fmt"
Jooyung Han90934ac2023-09-22 14:52:06 +090020 "path"
Jiyong Park09d77522019-11-18 11:16:27 +090021 "path/filepath"
22 "runtime"
Colin Cross388c6612025-01-28 14:00:12 -080023 "slices"
Jiyong Park09d77522019-11-18 11:16:27 +090024 "sort"
Nikita Ioffe5335bc42020-10-20 00:02:15 +010025 "strconv"
Jiyong Park09d77522019-11-18 11:16:27 +090026 "strings"
27
Yu Liueae7b362023-11-16 17:05:47 -080028 "android/soong/aconfig"
Jiyong Park09d77522019-11-18 11:16:27 +090029 "android/soong/android"
Colin Cross388c6612025-01-28 14:00:12 -080030 "android/soong/dexpreopt"
Jiyong Park09d77522019-11-18 11:16:27 +090031 "android/soong/java"
32
33 "github.com/google/blueprint"
34 "github.com/google/blueprint/proptools"
35)
36
37var (
38 pctx = android.NewPackageContext("android/apex")
39)
40
41func init() {
Yu Liueae7b362023-11-16 17:05:47 -080042 pctx.Import("android/soong/aconfig")
Jiyong Park09d77522019-11-18 11:16:27 +090043 pctx.Import("android/soong/android")
sophiezc80a2b32020-11-12 16:39:19 +000044 pctx.Import("android/soong/cc/config")
Jiyong Park09d77522019-11-18 11:16:27 +090045 pctx.Import("android/soong/java")
46 pctx.HostBinToolVariable("apexer", "apexer")
Dennis Shenaf41bc12022-08-03 16:46:43 +000047 pctx.HostBinToolVariable("apexer_with_DCLA_preprocessing", "apexer_with_DCLA_preprocessing")
Dennis Shene2ed70c2023-01-11 14:15:43 +000048
Jiyong Park09d77522019-11-18 11:16:27 +090049 // ART minimal builds (using the master-art manifest) do not have the "frameworks/base"
Jiyong Parkb81b9902020-11-24 19:51:18 +090050 // projects, and hence cannot build 'aapt2'. Use the SDK prebuilt instead.
Jiyong Park09d77522019-11-18 11:16:27 +090051 hostBinToolVariableWithPrebuilt := func(name, prebuiltDir, tool string) {
52 pctx.VariableFunc(name, func(ctx android.PackageVarContext) string {
53 if !ctx.Config().FrameworksBaseDirExists(ctx) {
54 return filepath.Join(prebuiltDir, runtime.GOOS, "bin", tool)
55 } else {
Martin Stjernholm7260d062019-12-09 21:47:14 +000056 return ctx.Config().HostToolPath(ctx, tool).String()
Jiyong Park09d77522019-11-18 11:16:27 +090057 }
58 })
59 }
60 hostBinToolVariableWithPrebuilt("aapt2", "prebuilts/sdk/tools", "aapt2")
61 pctx.HostBinToolVariable("avbtool", "avbtool")
62 pctx.HostBinToolVariable("e2fsdroid", "e2fsdroid")
63 pctx.HostBinToolVariable("merge_zips", "merge_zips")
64 pctx.HostBinToolVariable("mke2fs", "mke2fs")
65 pctx.HostBinToolVariable("resize2fs", "resize2fs")
66 pctx.HostBinToolVariable("sefcontext_compile", "sefcontext_compile")
67 pctx.HostBinToolVariable("soong_zip", "soong_zip")
68 pctx.HostBinToolVariable("zip2zip", "zip2zip")
69 pctx.HostBinToolVariable("zipalign", "zipalign")
70 pctx.HostBinToolVariable("jsonmodify", "jsonmodify")
71 pctx.HostBinToolVariable("conv_apex_manifest", "conv_apex_manifest")
Jaewoong Jungfa00c062020-05-14 14:15:24 -070072 pctx.HostBinToolVariable("extract_apks", "extract_apks")
Theotime Combes4ba38c12020-06-12 12:46:59 +000073 pctx.HostBinToolVariable("make_f2fs", "make_f2fs")
74 pctx.HostBinToolVariable("sload_f2fs", "sload_f2fs")
Jooyung Han7cff05d2024-12-13 14:57:56 +090075 pctx.HostBinToolVariable("make_erofs", "mkfs.erofs")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +000076 pctx.HostBinToolVariable("apex_compression_tool", "apex_compression_tool")
sophiez02347372021-11-02 17:58:02 -070077 pctx.HostBinToolVariable("dexdeps", "dexdeps")
Jooyung Han852545a2025-01-09 17:45:45 +090078 pctx.HostBinToolVariable("apex_ls", "apex-ls")
Jooyung Han01f5d652023-04-05 16:29:26 +090079 pctx.HostBinToolVariable("apex_sepolicy_tests", "apex_sepolicy_tests")
80 pctx.HostBinToolVariable("deapexer", "deapexer")
81 pctx.HostBinToolVariable("debugfs_static", "debugfs_static")
Jooyung Han55a73062023-11-07 13:09:56 +090082 pctx.HostBinToolVariable("fsck_erofs", "fsck.erofs")
sophiezc80a2b32020-11-12 16:39:19 +000083 pctx.SourcePathVariable("genNdkUsedbyApexPath", "build/soong/scripts/gen_ndk_usedby_apex.sh")
Jooyung Han4bc10262023-09-08 11:51:45 +090084 pctx.HostBinToolVariable("conv_linker_config", "conv_linker_config")
Jooyung Hane6154412023-09-08 15:25:59 +090085 pctx.HostBinToolVariable("assemble_vintf", "assemble_vintf")
Jooyung Han55a73062023-11-07 13:09:56 +090086 pctx.HostBinToolVariable("apex_elf_checker", "apex_elf_checker")
Yu Liueae7b362023-11-16 17:05:47 -080087 pctx.HostBinToolVariable("aconfig", "aconfig")
Jooyung Han2adba482024-02-22 17:27:53 +090088 pctx.HostBinToolVariable("host_apex_verifier", "host_apex_verifier")
Jiyong Park09d77522019-11-18 11:16:27 +090089}
90
Yu Liubba555e2024-02-17 00:36:42 +000091type createStorageStruct struct {
92 Output_file string
93 Desc string
94 File_type string
95}
96
97var createStorageInfo = []createStorageStruct{
98 {"package.map", "create_aconfig_package_map_file", "package_map"},
99 {"flag.map", "create_aconfig_flag_map_file", "flag_map"},
100 {"flag.val", "create_aconfig_flag_val_file", "flag_val"},
Dennis Shen343d09e2024-09-23 17:19:15 +0000101 {"flag.info", "create_aconfig_flag_info_file", "flag_info"},
Yu Liubba555e2024-02-17 00:36:42 +0000102}
103
Jiyong Park09d77522019-11-18 11:16:27 +0900104var (
Jiyong Park09d77522019-11-18 11:16:27 +0900105 apexManifestRule = pctx.StaticRule("apexManifestRule", blueprint.RuleParams{
106 Command: `rm -f $out && ${jsonmodify} $in ` +
107 `-a provideNativeLibs ${provideNativeLibs} ` +
108 `-a requireNativeLibs ${requireNativeLibs} ` +
Alexei Nicoarad887e242022-07-11 14:16:28 +0100109 `-se version 0 ${default_version} ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900110 `${opt} ` +
111 `-o $out`,
112 CommandDeps: []string{"${jsonmodify}"},
113 Description: "prepare ${out}",
Alexei Nicoarad887e242022-07-11 14:16:28 +0100114 }, "provideNativeLibs", "requireNativeLibs", "default_version", "opt")
Jiyong Park09d77522019-11-18 11:16:27 +0900115
116 stripApexManifestRule = pctx.StaticRule("stripApexManifestRule", blueprint.RuleParams{
117 Command: `rm -f $out && ${conv_apex_manifest} strip $in -o $out`,
118 CommandDeps: []string{"${conv_apex_manifest}"},
119 Description: "strip ${in}=>${out}",
120 })
121
122 pbApexManifestRule = pctx.StaticRule("pbApexManifestRule", blueprint.RuleParams{
123 Command: `rm -f $out && ${conv_apex_manifest} proto $in -o $out`,
124 CommandDeps: []string{"${conv_apex_manifest}"},
125 Description: "convert ${in}=>${out}",
126 })
127
Joe Onoratob4638c12021-10-27 15:47:06 -0700128 // TODO(b/113233103): make sure that file_contexts is as expected, i.e., validate
Jiyong Park09d77522019-11-18 11:16:27 +0900129 // against the binary policy using sefcontext_compiler -p <policy>.
130
131 // TODO(b/114327326): automate the generation of file_contexts
132 apexRule = pctx.StaticRule("apexRule", blueprint.RuleParams{
133 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
134 `(. ${out}.copy_commands) && ` +
135 `APEXER_TOOL_PATH=${tool_path} ` +
136 `${apexer} --force --manifest ${manifest} ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900137 `--file_contexts ${file_contexts} ` +
138 `--canned_fs_config ${canned_fs_config} ` +
Dario Freni0f4ae072020-01-02 15:24:12 +0000139 `--include_build_info ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900140 `--payload_type image ` +
Oriol Prieto Gasco17e22902022-05-05 13:52:25 +0000141 `--key ${key} ${opt_flags} ${image_dir} ${out} `,
Jiyong Park09d77522019-11-18 11:16:27 +0900142 CommandDeps: []string{"${apexer}", "${avbtool}", "${e2fsdroid}", "${merge_zips}",
Huang Jianan13cac632021-08-02 15:02:17 +0800143 "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}", "${sload_f2fs}", "${make_erofs}",
Jiyong Park09d77522019-11-18 11:16:27 +0900144 "${soong_zip}", "${zipalign}", "${aapt2}", "prebuilts/sdk/current/public/android.jar"},
145 Rspfile: "${out}.copy_commands",
146 RspfileContent: "${copy_commands}",
147 Description: "APEX ${image_dir} => ${out}",
Dennis Shenaf41bc12022-08-03 16:46:43 +0000148 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
149 "opt_flags", "manifest")
150
151 DCLAApexRule = pctx.StaticRule("DCLAApexRule", blueprint.RuleParams{
152 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
153 `(. ${out}.copy_commands) && ` +
154 `APEXER_TOOL_PATH=${tool_path} ` +
155 `${apexer_with_DCLA_preprocessing} ` +
156 `--apexer ${apexer} ` +
157 `--canned_fs_config ${canned_fs_config} ` +
158 `${image_dir} ` +
159 `${out} ` +
160 `-- ` +
161 `--include_build_info ` +
162 `--force ` +
163 `--payload_type image ` +
164 `--key ${key} ` +
165 `--file_contexts ${file_contexts} ` +
166 `--manifest ${manifest} ` +
167 `${opt_flags} `,
168 CommandDeps: []string{"${apexer_with_DCLA_preprocessing}", "${apexer}", "${avbtool}", "${e2fsdroid}",
169 "${merge_zips}", "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}",
170 "${sload_f2fs}", "${make_erofs}", "${soong_zip}", "${zipalign}", "${aapt2}",
171 "prebuilts/sdk/current/public/android.jar"},
172 Rspfile: "${out}.copy_commands",
173 RspfileContent: "${copy_commands}",
174 Description: "APEX ${image_dir} => ${out}",
175 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
176 "opt_flags", "manifest", "is_DCLA")
Jiyong Park09d77522019-11-18 11:16:27 +0900177
Jiyong Park09d77522019-11-18 11:16:27 +0900178 apexProtoConvertRule = pctx.AndroidStaticRule("apexProtoConvertRule",
179 blueprint.RuleParams{
180 Command: `${aapt2} convert --output-format proto $in -o $out`,
181 CommandDeps: []string{"${aapt2}"},
182 })
183
184 apexBundleRule = pctx.StaticRule("apexBundleRule", blueprint.RuleParams{
Jiyong Parkbd159612020-02-28 15:22:21 +0900185 Command: `${zip2zip} -i $in -o $out.base ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900186 `apex_payload.img:apex/${abi}.img ` +
Dario Frenida1aefe2020-03-02 21:47:09 +0000187 `apex_build_info.pb:apex/${abi}.build_info.pb ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900188 `apex_manifest.json:root/apex_manifest.json ` +
Jiyong Park53ae3342019-12-08 02:06:24 +0900189 `apex_manifest.pb:root/apex_manifest.pb ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900190 `AndroidManifest.xml:manifest/AndroidManifest.xml ` +
Jiyong Parkbd159612020-02-28 15:22:21 +0900191 `assets/NOTICE.html.gz:assets/NOTICE.html.gz &&` +
192 `${soong_zip} -o $out.config -C $$(dirname ${config}) -f ${config} && ` +
193 `${merge_zips} $out $out.base $out.config`,
194 CommandDeps: []string{"${zip2zip}", "${soong_zip}", "${merge_zips}"},
Jiyong Park09d77522019-11-18 11:16:27 +0900195 Description: "app bundle",
Jiyong Parkbd159612020-02-28 15:22:21 +0900196 }, "abi", "config")
Jiyong Park09d77522019-11-18 11:16:27 +0900197
Jiyong Park09d77522019-11-18 11:16:27 +0900198 diffApexContentRule = pctx.StaticRule("diffApexContentRule", blueprint.RuleParams{
199 Command: `diff --unchanged-group-format='' \` +
200 `--changed-group-format='%<' \` +
Colin Cross440e0d02020-06-11 11:32:11 -0700201 `${image_content_file} ${allowed_files_file} || (` +
Colin Cross7cd1d422024-11-13 13:05:49 -0800202 `echo "New unexpected files were added to ${apex_module_name}." ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900203 ` "To fix the build run following command:" && ` +
Colin Cross440e0d02020-06-11 11:32:11 -0700204 `echo "system/apex/tools/update_allowed_list.sh ${allowed_files_file} ${image_content_file}" && ` +
Dan Willemsen81e43c52020-01-28 15:40:19 -0800205 `exit 1); touch ${out}`,
Colin Cross440e0d02020-06-11 11:32:11 -0700206 Description: "Diff ${image_content_file} and ${allowed_files_file}",
207 }, "image_content_file", "allowed_files_file", "apex_module_name")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900208
sophiezc80a2b32020-11-12 16:39:19 +0000209 generateAPIsUsedbyApexRule = pctx.StaticRule("generateAPIsUsedbyApexRule", blueprint.RuleParams{
210 Command: "$genNdkUsedbyApexPath ${image_dir} ${readelf} ${out}",
211 CommandDeps: []string{"${genNdkUsedbyApexPath}"},
212 Description: "Generate symbol list used by Apex",
213 }, "image_dir", "readelf")
214
Jooyung Han01f5d652023-04-05 16:29:26 +0900215 apexSepolicyTestsRule = pctx.StaticRule("apexSepolicyTestsRule", blueprint.RuleParams{
Jooyung Han852545a2025-01-09 17:45:45 +0900216 Command: `${apex_ls} -Z ${in} > ${out}.fc` +
Jooyung Han3ae653b2025-01-03 17:42:12 +0900217 ` && ${apex_sepolicy_tests} -f ${out}.fc --partition ${partition_tag} && touch ${out}`,
Jooyung Han852545a2025-01-09 17:45:45 +0900218 CommandDeps: []string{"${apex_sepolicy_tests}", "${apex_ls}"},
Jooyung Han01f5d652023-04-05 16:29:26 +0900219 Description: "run apex_sepolicy_tests",
Jooyung Han3ae653b2025-01-03 17:42:12 +0900220 }, "partition_tag")
Jooyung Han4bc10262023-09-08 11:51:45 +0900221
222 apexLinkerconfigValidationRule = pctx.StaticRule("apexLinkerconfigValidationRule", blueprint.RuleParams{
223 Command: `${conv_linker_config} validate --type apex ${image_dir} && touch ${out}`,
224 CommandDeps: []string{"${conv_linker_config}"},
225 Description: "run apex_linkerconfig_validation",
226 }, "image_dir")
Jooyung Hane6154412023-09-08 15:25:59 +0900227
Jooyung Han2adba482024-02-22 17:27:53 +0900228 apexHostVerifierRule = pctx.StaticRule("apexHostVerifierRule", blueprint.RuleParams{
229 Command: `${host_apex_verifier} --deapexer=${deapexer} --debugfs=${debugfs_static} ` +
Jooyung Hanb6ac8222024-10-14 18:20:14 +0900230 `--fsckerofs=${fsck_erofs} --apex=${in} --partition_tag=${partition_tag} && touch ${out}`,
Jooyung Han2adba482024-02-22 17:27:53 +0900231 CommandDeps: []string{"${host_apex_verifier}", "${deapexer}", "${debugfs_static}", "${fsck_erofs}"},
232 Description: "run host_apex_verifier",
Jooyung Hanb6ac8222024-10-14 18:20:14 +0900233 }, "partition_tag")
Jooyung Han2adba482024-02-22 17:27:53 +0900234
Jooyung Han90934ac2023-09-22 14:52:06 +0900235 assembleVintfRule = pctx.StaticRule("assembleVintfRule", blueprint.RuleParams{
236 Command: `rm -f $out && VINTF_IGNORE_TARGET_FCM_VERSION=true ${assemble_vintf} -i $in -o $out`,
Jooyung Hane6154412023-09-08 15:25:59 +0900237 CommandDeps: []string{"${assemble_vintf}"},
Jooyung Han90934ac2023-09-22 14:52:06 +0900238 Description: "run assemble_vintf",
239 })
Jooyung Han55a73062023-11-07 13:09:56 +0900240
241 apexElfCheckerUnwantedRule = pctx.StaticRule("apexElfCheckerUnwantedRule", blueprint.RuleParams{
242 Command: `${apex_elf_checker} --tool_path ${tool_path} --unwanted ${unwanted} ${in} && touch ${out}`,
243 CommandDeps: []string{"${apex_elf_checker}", "${deapexer}", "${debugfs_static}", "${fsck_erofs}", "${config.ClangBin}/llvm-readelf"},
244 Description: "run apex_elf_checker --unwanted",
245 }, "tool_path", "unwanted")
Jiyong Park09d77522019-11-18 11:16:27 +0900246)
247
Jooyung Hana3fddf42024-09-03 13:22:21 +0900248func (a *apexBundle) buildAconfigFiles(ctx android.ModuleContext) []apexFile {
249 var aconfigFiles android.Paths
250 for _, file := range a.filesInfo {
251 if file.module == nil {
252 continue
253 }
254 if dep, ok := android.OtherModuleProvider(ctx, file.module, android.AconfigPropagatingProviderKey); ok {
255 if len(dep.AconfigFiles) > 0 && dep.AconfigFiles[ctx.ModuleName()] != nil {
256 aconfigFiles = append(aconfigFiles, dep.AconfigFiles[ctx.ModuleName()]...)
257 }
258 }
259
260 validationFlag := ctx.DeviceConfig().AconfigContainerValidation()
261 if validationFlag == "error" || validationFlag == "warning" {
262 android.VerifyAconfigBuildMode(ctx, ctx.ModuleName(), file.module, validationFlag == "error")
263 }
264 }
265 aconfigFiles = android.FirstUniquePaths(aconfigFiles)
266
267 var files []apexFile
268 if len(aconfigFiles) > 0 {
269 apexAconfigFile := android.PathForModuleOut(ctx, "aconfig_flags.pb")
270 ctx.Build(pctx, android.BuildParams{
271 Rule: aconfig.AllDeclarationsRule,
272 Inputs: aconfigFiles,
273 Output: apexAconfigFile,
274 Description: "combine_aconfig_declarations",
275 Args: map[string]string{
276 "cache_files": android.JoinPathsWithPrefix(aconfigFiles, "--cache "),
277 },
278 })
279 files = append(files, newApexFile(ctx, apexAconfigFile, "aconfig_flags", "etc", etc, nil))
280
Marybeth Fairc8c74d62024-12-04 14:22:40 -0500281 // To enable fingerprint, we need to have v2 storage files. The default version is 1.
282 storageFilesVersion := 1
283 if ctx.Config().ReleaseFingerprintAconfigPackages() {
284 storageFilesVersion = 2
285 }
286
Jooyung Hana3fddf42024-09-03 13:22:21 +0900287 for _, info := range createStorageInfo {
288 outputFile := android.PathForModuleOut(ctx, info.Output_file)
289 ctx.Build(pctx, android.BuildParams{
290 Rule: aconfig.CreateStorageRule,
291 Inputs: aconfigFiles,
292 Output: outputFile,
293 Description: info.Desc,
294 Args: map[string]string{
295 "container": ctx.ModuleName(),
296 "file_type": info.File_type,
297 "cache_files": android.JoinPathsWithPrefix(aconfigFiles, "--cache "),
Marybeth Fairc8c74d62024-12-04 14:22:40 -0500298 "version": strconv.Itoa(storageFilesVersion),
Jooyung Hana3fddf42024-09-03 13:22:21 +0900299 },
300 })
301 files = append(files, newApexFile(ctx, outputFile, info.File_type, "etc", etc, nil))
302 }
303 }
304 return files
305}
306
Jiyong Parkb81b9902020-11-24 19:51:18 +0900307// buildManifest creates buile rules to modify the input apex_manifest.json to add information
308// gathered by the build system such as provided/required native libraries. Two output files having
309// different formats are generated. a.manifestJsonOut is JSON format for Q devices, and
310// a.manifest.PbOut is protobuf format for R+ devices.
311// TODO(jiyong): make this to return paths instead of directly storing the paths to apexBundle
Jiyong Park09d77522019-11-18 11:16:27 +0900312func (a *apexBundle) buildManifest(ctx android.ModuleContext, provideNativeLibs, requireNativeLibs []string) {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900313 src := android.PathForModuleSrc(ctx, proptools.StringDefault(a.properties.Manifest, "apex_manifest.json"))
Jiyong Park09d77522019-11-18 11:16:27 +0900314
Jiyong Parkb81b9902020-11-24 19:51:18 +0900315 // Put dependency({provide|require}NativeLibs) in apex_manifest.json
Jiyong Park09d77522019-11-18 11:16:27 +0900316 provideNativeLibs = android.SortedUniqueStrings(provideNativeLibs)
317 requireNativeLibs = android.SortedUniqueStrings(android.RemoveListFromList(requireNativeLibs, provideNativeLibs))
318
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900319 // VNDK APEX name is determined at runtime, so update "name" in apex_manifest
Jiyong Park09d77522019-11-18 11:16:27 +0900320 optCommands := []string{}
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900321 if a.vndkApex {
Kiyoung Kimfa13ff12024-03-18 16:01:19 +0900322 apexName := vndkApexNamePrefix + a.vndkVersion()
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900323 optCommands = append(optCommands, "-v name "+apexName)
Jiyong Park09d77522019-11-18 11:16:27 +0900324 }
325
Jiyong Parkb81b9902020-11-24 19:51:18 +0900326 // Collect jniLibs. Notice that a.filesInfo is already sorted
Jooyung Han643adc42020-02-27 13:50:06 +0900327 var jniLibs []string
328 for _, fi := range a.filesInfo {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900329 if fi.isJniLib && !android.InList(fi.stem(), jniLibs) {
330 jniLibs = append(jniLibs, fi.stem())
Jooyung Han643adc42020-02-27 13:50:06 +0900331 }
332 }
333 if len(jniLibs) > 0 {
334 optCommands = append(optCommands, "-a jniLibs "+strings.Join(jniLibs, " "))
335 }
336
Jooyung Hand045ebc2022-12-06 15:23:57 +0900337 if android.InList(":vndk", requireNativeLibs) {
Kiyoung Kim4e765b12024-04-04 17:33:42 +0900338 if _, vndkVersion := a.getImageVariationPair(); vndkVersion != "" {
Jooyung Hand045ebc2022-12-06 15:23:57 +0900339 optCommands = append(optCommands, "-v vndkVersion "+vndkVersion)
340 }
341 }
342
Jiyong Parkb81b9902020-11-24 19:51:18 +0900343 manifestJsonFullOut := android.PathForModuleOut(ctx, "apex_manifest_full.json")
Alyssa Ketpreechasawat3a6eced2024-08-22 15:09:16 +0000344 defaultVersion := ctx.Config().ReleaseDefaultUpdatableModuleVersion()
Sam Delmerico6d65a0f2023-06-05 15:55:57 -0400345 if a.properties.Variant_version != nil {
346 defaultVersionInt, err := strconv.Atoi(defaultVersion)
347 if err != nil {
Alyssa Ketpreechasawat3a6eced2024-08-22 15:09:16 +0000348 ctx.ModuleErrorf("expected RELEASE_DEFAULT_UPDATABLE_MODULE_VERSION to be an int, but got %s", defaultVersion)
Sam Delmerico6d65a0f2023-06-05 15:55:57 -0400349 }
Alyssa Ketpreechasawat0c89ca32024-12-08 21:15:25 +0000350 if defaultVersionInt%10 != 0 && defaultVersionInt%10 != 9 {
351 ctx.ModuleErrorf("expected RELEASE_DEFAULT_UPDATABLE_MODULE_VERSION to end in a zero or a nine, but got %s", defaultVersion)
Sam Delmerico6d65a0f2023-06-05 15:55:57 -0400352 }
353 variantVersion := []rune(*a.properties.Variant_version)
354 if len(variantVersion) != 1 || variantVersion[0] < '0' || variantVersion[0] > '9' {
355 ctx.PropertyErrorf("variant_version", "expected an integer between 0-9; got %s", *a.properties.Variant_version)
356 }
357 defaultVersionRunes := []rune(defaultVersion)
358 defaultVersionRunes[len(defaultVersion)-1] = []rune(variantVersion)[0]
359 defaultVersion = string(defaultVersionRunes)
360 }
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000361 if override := ctx.Config().Getenv("OVERRIDE_APEX_MANIFEST_DEFAULT_VERSION"); override != "" {
362 defaultVersion = override
363 }
Jiyong Park09d77522019-11-18 11:16:27 +0900364 ctx.Build(pctx, android.BuildParams{
365 Rule: apexManifestRule,
Alexei Nicoara0a389202022-07-12 14:35:39 +0100366 Input: src,
Jooyung Han214bf372019-11-12 13:03:50 +0900367 Output: manifestJsonFullOut,
Jiyong Park09d77522019-11-18 11:16:27 +0900368 Args: map[string]string{
369 "provideNativeLibs": strings.Join(provideNativeLibs, " "),
370 "requireNativeLibs": strings.Join(requireNativeLibs, " "),
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000371 "default_version": defaultVersion,
Jiyong Park09d77522019-11-18 11:16:27 +0900372 "opt": strings.Join(optCommands, " "),
373 },
374 })
375
Jiyong Parkb81b9902020-11-24 19:51:18 +0900376 // b/143654022 Q apexd can't understand newly added keys in apex_manifest.json prepare
377 // stripped-down version so that APEX modules built from R+ can be installed to Q
Dan Albertc8060532020-07-22 22:32:17 -0700378 minSdkVersion := a.minSdkVersion(ctx)
379 if minSdkVersion.EqualTo(android.SdkVersion_Android10) {
Jooyung Han214bf372019-11-12 13:03:50 +0900380 a.manifestJsonOut = android.PathForModuleOut(ctx, "apex_manifest.json")
381 ctx.Build(pctx, android.BuildParams{
382 Rule: stripApexManifestRule,
383 Input: manifestJsonFullOut,
384 Output: a.manifestJsonOut,
385 })
386 }
Jiyong Park09d77522019-11-18 11:16:27 +0900387
Jiyong Parkb81b9902020-11-24 19:51:18 +0900388 // From R+, protobuf binary format (.pb) is the standard format for apex_manifest
Jiyong Park09d77522019-11-18 11:16:27 +0900389 a.manifestPbOut = android.PathForModuleOut(ctx, "apex_manifest.pb")
390 ctx.Build(pctx, android.BuildParams{
391 Rule: pbApexManifestRule,
Jooyung Han214bf372019-11-12 13:03:50 +0900392 Input: manifestJsonFullOut,
Jiyong Park09d77522019-11-18 11:16:27 +0900393 Output: a.manifestPbOut,
394 })
395}
396
Jiyong Parkb81b9902020-11-24 19:51:18 +0900397// buildFileContexts create build rules to append an entry for apex_manifest.pb to the file_contexts
398// file for this APEX which is either from /systme/sepolicy/apex/<apexname>-file_contexts or from
399// the file_contexts property of this APEX. This is to make sure that the manifest file is correctly
Jooyung Hanbe953902023-05-31 16:42:16 +0900400// labeled as system_file or vendor_apex_metadata_file.
Cole Faust4e9f5922024-11-13 16:09:23 -0800401func (a *apexBundle) buildFileContexts(ctx android.ModuleContext) android.Path {
Jooyung Han580eb4f2020-06-24 19:33:06 +0900402 var fileContexts android.Path
Liz Kammer37997c42021-09-14 17:53:38 -0400403 var fileContextsDir string
Inseob Kim28d06d22023-11-17 18:04:42 +0900404 isFileContextsModule := false
Jooyung Han580eb4f2020-06-24 19:33:06 +0900405 if a.properties.File_contexts == nil {
406 fileContexts = android.PathForSource(ctx, "system/sepolicy/apex", ctx.ModuleName()+"-file_contexts")
407 } else {
Liz Kammer37997c42021-09-14 17:53:38 -0400408 if m, t := android.SrcIsModuleWithTag(*a.properties.File_contexts); m != "" {
Inseob Kim28d06d22023-11-17 18:04:42 +0900409 isFileContextsModule = true
Yu Liud3228ac2024-11-08 23:11:47 +0000410 otherModule := android.GetModuleProxyFromPathDep(ctx, m, t)
411 if otherModule != nil {
412 fileContextsDir = ctx.OtherModuleDir(*otherModule)
413 }
Liz Kammer37997c42021-09-14 17:53:38 -0400414 }
Jooyung Han580eb4f2020-06-24 19:33:06 +0900415 fileContexts = android.PathForModuleSrc(ctx, *a.properties.File_contexts)
416 }
Liz Kammer37997c42021-09-14 17:53:38 -0400417 if fileContextsDir == "" {
418 fileContextsDir = filepath.Dir(fileContexts.String())
419 }
420 fileContextsDir += string(filepath.Separator)
421
Jooyung Han580eb4f2020-06-24 19:33:06 +0900422 if a.Platform() {
Liz Kammer37997c42021-09-14 17:53:38 -0400423 if !strings.HasPrefix(fileContextsDir, "system/sepolicy/") {
424 ctx.PropertyErrorf("file_contexts", "should be under system/sepolicy, but found in %q", fileContextsDir)
Jooyung Han580eb4f2020-06-24 19:33:06 +0900425 }
426 }
Inseob Kim28d06d22023-11-17 18:04:42 +0900427 if !isFileContextsModule && !android.ExistentPathForSource(ctx, fileContexts.String()).Valid() {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900428 ctx.PropertyErrorf("file_contexts", "cannot find file_contexts file: %q", fileContexts.String())
Jooyung Han580eb4f2020-06-24 19:33:06 +0900429 }
430
Jooyung Hanaf730952023-02-28 14:13:38 +0900431 useFileContextsAsIs := proptools.Bool(a.properties.Use_file_contexts_as_is)
432
Jooyung Han580eb4f2020-06-24 19:33:06 +0900433 output := android.PathForModuleOut(ctx, "file_contexts")
Colin Crossf1a035e2020-11-16 17:32:30 -0800434 rule := android.NewRuleBuilder(pctx, ctx)
Jooyung Han7f146c02020-09-23 19:15:55 +0900435
Jooyung Hanfed9cce2023-11-14 13:52:51 +0900436 labelForRoot := "u:object_r:system_file:s0"
437 labelForManifest := "u:object_r:system_file:s0"
Jooyung Hanbe953902023-05-31 16:42:16 +0900438 if a.SocSpecific() && !a.vndkApex {
Jooyung Hanfed9cce2023-11-14 13:52:51 +0900439 // APEX on /vendor should label ./ and ./apex_manifest.pb as vendor file.
440 labelForRoot = "u:object_r:vendor_file:s0"
441 labelForManifest = "u:object_r:vendor_apex_metadata_file:s0"
Jooyung Hanbe953902023-05-31 16:42:16 +0900442 }
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900443 // remove old file
444 rule.Command().Text("rm").FlagWithOutput("-f ", output)
445 // copy file_contexts
446 rule.Command().Text("cat").Input(fileContexts).Text(">>").Output(output)
447 // new line
448 rule.Command().Text("echo").Text(">>").Output(output)
449 if !useFileContextsAsIs {
450 // force-label /apex_manifest.pb and /
Jooyung Hanfed9cce2023-11-14 13:52:51 +0900451 rule.Command().Text("echo").Text("/apex_manifest\\\\.pb").Text(labelForManifest).Text(">>").Output(output)
452 rule.Command().Text("echo").Text("/").Text(labelForRoot).Text(">>").Output(output)
Jooyung Han7f146c02020-09-23 19:15:55 +0900453 }
454
Colin Crossf1a035e2020-11-16 17:32:30 -0800455 rule.Build("file_contexts."+a.Name(), "Generate file_contexts")
Cole Faust4e9f5922024-11-13 16:09:23 -0800456 return output
Jooyung Han580eb4f2020-06-24 19:33:06 +0900457}
458
Jiyong Parkb81b9902020-11-24 19:51:18 +0900459// buildInstalledFilesFile creates a build rule for the installed-files.txt file where the list of
460// files included in this APEX is shown. The text file is dist'ed so that people can see what's
461// included in the APEX without actually downloading and extracting it.
Cole Faust4e9f5922024-11-13 16:09:23 -0800462func (a *apexBundle) buildInstalledFilesFile(ctx android.ModuleContext, builtApex android.Path, imageDir android.Path) android.Path {
Jiyong Park3a1602e2020-01-14 14:39:19 +0900463 output := android.PathForModuleOut(ctx, "installed-files.txt")
Colin Crossf1a035e2020-11-16 17:32:30 -0800464 rule := android.NewRuleBuilder(pctx, ctx)
Jiyong Park3a1602e2020-01-14 14:39:19 +0900465 rule.Command().
466 Implicit(builtApex).
467 Text("(cd " + imageDir.String() + " ; ").
Jiyong Parkbd63a102020-02-08 12:40:05 +0900468 Text("find . \\( -type f -o -type l \\) -printf \"%s %p\\n\") ").
Jiyong Park3a1602e2020-01-14 14:39:19 +0900469 Text(" | sort -nr > ").
470 Output(output)
Colin Crossf1a035e2020-11-16 17:32:30 -0800471 rule.Build("installed-files."+a.Name(), "Installed files")
Cole Faust4e9f5922024-11-13 16:09:23 -0800472 return output
Jiyong Park3a1602e2020-01-14 14:39:19 +0900473}
474
Jiyong Parkb81b9902020-11-24 19:51:18 +0900475// buildBundleConfig creates a build rule for the bundle config file that will control the bundle
476// creation process.
Cole Faust4e9f5922024-11-13 16:09:23 -0800477func (a *apexBundle) buildBundleConfig(ctx android.ModuleContext) android.Path {
Jiyong Parkbd159612020-02-28 15:22:21 +0900478 output := android.PathForModuleOut(ctx, "bundle_config.json")
479
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900480 type ApkConfig struct {
481 Package_name string `json:"package_name"`
482 Apk_path string `json:"path"`
483 }
Jiyong Parkbd159612020-02-28 15:22:21 +0900484 config := struct {
485 Compression struct {
486 Uncompressed_glob []string `json:"uncompressed_glob"`
487 } `json:"compression"`
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900488 Apex_config struct {
489 Apex_embedded_apk_config []ApkConfig `json:"apex_embedded_apk_config,omitempty"`
490 } `json:"apex_config,omitempty"`
Jiyong Parkbd159612020-02-28 15:22:21 +0900491 }{}
492
493 config.Compression.Uncompressed_glob = []string{
494 "apex_payload.img",
495 "apex_manifest.*",
496 }
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900497
Jiyong Parkb81b9902020-11-24 19:51:18 +0900498 // Collect the manifest names and paths of android apps if their manifest names are
499 // overridden.
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900500 for _, fi := range a.filesInfo {
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700501 if fi.class != app && fi.class != appSet {
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900502 continue
503 }
504 packageName := fi.overriddenPackageName
505 if packageName != "" {
506 config.Apex_config.Apex_embedded_apk_config = append(
507 config.Apex_config.Apex_embedded_apk_config,
508 ApkConfig{
509 Package_name: packageName,
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900510 Apk_path: fi.path(),
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900511 })
512 }
513 }
514
Jiyong Parkbd159612020-02-28 15:22:21 +0900515 j, err := json.Marshal(config)
516 if err != nil {
517 panic(fmt.Errorf("error while marshalling to %q: %#v", output, err))
518 }
519
Colin Crosscf371cc2020-11-13 11:48:42 -0800520 android.WriteFileRule(ctx, output, string(j))
Jiyong Parkbd159612020-02-28 15:22:21 +0900521
Cole Faust4e9f5922024-11-13 16:09:23 -0800522 return output
Jiyong Parkbd159612020-02-28 15:22:21 +0900523}
524
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000525func markManifestTestOnly(ctx android.ModuleContext, androidManifestFile android.Path) android.Path {
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000526 return java.ManifestFixer(ctx, androidManifestFile, java.ManifestFixerParams{
527 TestOnly: true,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000528 })
529}
530
Kiyoung Kim11ad4e92024-09-04 14:16:47 +0900531func shouldApplyAssembleVintf(fi apexFile) bool {
Jooyung Han262f73c2024-03-28 11:29:47 +0900532 isVintfFragment, _ := path.Match("etc/vintf/*", fi.path())
Kiyoung Kim11ad4e92024-09-04 14:16:47 +0900533 _, fromVintfFragmentModule := fi.module.(*android.VintfFragmentModule)
534 return isVintfFragment && !fromVintfFragmentModule
Jooyung Han90934ac2023-09-22 14:52:06 +0900535}
536
537func runAssembleVintf(ctx android.ModuleContext, vintfFragment android.Path) android.Path {
538 processed := android.PathForModuleOut(ctx, "vintf", vintfFragment.Base())
539 ctx.Build(pctx, android.BuildParams{
540 Rule: assembleVintfRule,
541 Input: vintfFragment,
542 Output: processed,
543 Description: "run assemble_vintf for VINTF in APEX",
544 })
545 return processed
546}
547
Colin Cross388c6612025-01-28 14:00:12 -0800548// installApexSystemServerFiles installs dexpreopt and dexjar files for system server classpath entries
549// provided by the apex. They are installed here instead of in library module because there may be multiple
550// variants of the library, generally one for the "main" apex and another with a different min_sdk_version
551// for the Android Go version of the apex. Both variants would attempt to install to the same locations,
552// and the library variants cannot determine which one should. The apex module is better equipped to determine
553// if it is "selected".
554// This assumes that the jars produced by different min_sdk_version values are identical, which is currently
555// true but may not be true if the min_sdk_version difference between the variants spans version that changed
556// the dex format.
557func (a *apexBundle) installApexSystemServerFiles(ctx android.ModuleContext) {
558 // If performInstalls is set this module is responsible for creating the install rules.
559 performInstalls := a.GetOverriddenBy() == "" && !a.testApex && a.installable()
560 // TODO(b/234351700): Remove once ART does not have separated debug APEX, or make the selection
561 // explicit in the ART Android.bp files.
562 if ctx.Config().UseDebugArt() {
563 if ctx.ModuleName() == "com.android.art" {
564 performInstalls = false
565 }
566 } else {
567 if ctx.ModuleName() == "com.android.art.debug" {
568 performInstalls = false
569 }
570 }
571
572 psi := android.PrebuiltSelectionInfoMap{}
573 ctx.VisitDirectDeps(func(am android.Module) {
574 if info, exists := android.OtherModuleProvider(ctx, am, android.PrebuiltSelectionInfoProvider); exists {
575 psi = info
576 }
577 })
578
579 if len(psi.GetSelectedModulesForApiDomain(ctx.ModuleName())) > 0 {
580 performInstalls = false
581 }
582
583 for _, fi := range a.filesInfo {
584 for _, install := range fi.systemServerDexpreoptInstalls {
585 var installedFile android.InstallPath
586 if performInstalls {
587 installedFile = ctx.InstallFile(install.InstallDirOnDevice, install.InstallFileOnDevice, install.OutputPathOnHost)
588 } else {
589 // Another module created the install rules, but this module should still depend on
590 // the installed locations.
591 installedFile = install.InstallDirOnDevice.Join(ctx, install.InstallFileOnDevice)
592 }
593 a.extraInstalledFiles = append(a.extraInstalledFiles, installedFile)
594 a.extraInstalledPairs = append(a.extraInstalledPairs, installPair{install.OutputPathOnHost, installedFile})
595 }
596 if performInstalls {
597 for _, dexJar := range fi.systemServerDexJars {
598 // Copy the system server dex jar to a predefined location where dex2oat will find it.
599 android.CopyFileRule(ctx, dexJar,
600 android.PathForOutput(ctx, dexpreopt.SystemServerDexjarsDir, dexJar.Base()))
601 }
602 }
603 }
604}
605
Jooyung Haneec1b3f2023-06-20 16:25:59 +0900606// buildApex creates build rules to build an APEX using apexer.
607func (a *apexBundle) buildApex(ctx android.ModuleContext) {
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900608 suffix := imageApexSuffix
Jooyung Han63dff462023-02-09 00:11:27 +0000609 apexName := a.BaseModuleName()
Jiyong Park09d77522019-11-18 11:16:27 +0900610
Jiyong Parkb81b9902020-11-24 19:51:18 +0900611 ////////////////////////////////////////////////////////////////////////////////////////////
612 // Step 1: copy built files to appropriate directories under the image directory
613
614 imageDir := android.PathForModuleOut(ctx, "image"+suffix)
615
Spandan Das61755e82025-01-22 18:48:05 +0000616 installSymbolFiles := a.ExportedToMake() && a.installable()
Colin Cross6340ea52021-11-04 12:01:18 -0700617
Colin Cross4acaea92021-12-10 23:05:02 +0000618 // set of dependency module:location mappings
619 installMapSet := make(map[string]bool)
Colin Cross6340ea52021-11-04 12:01:18 -0700620
Jiyong Parkb81b9902020-11-24 19:51:18 +0900621 // TODO(jiyong): use the RuleBuilder
Jiyong Park7cd10e32020-01-14 09:22:18 +0900622 var copyCommands []string
Jiyong Parkb81b9902020-11-24 19:51:18 +0900623 var implicitInputs []android.Path
Jooyung Han63dff462023-02-09 00:11:27 +0000624 apexDir := android.PathForModuleInPartitionInstall(ctx, "apex", apexName)
Jiyong Park7cd10e32020-01-14 09:22:18 +0900625 for _, fi := range a.filesInfo {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900626 destPath := imageDir.Join(ctx, fi.path()).String()
Jiyong Parkb81b9902020-11-24 19:51:18 +0900627 // Prepare the destination path
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700628 destPathDir := filepath.Dir(destPath)
629 if fi.class == appSet {
630 copyCommands = append(copyCommands, "rm -rf "+destPathDir)
631 }
632 copyCommands = append(copyCommands, "mkdir -p "+destPathDir)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900633
Colin Cross4acaea92021-12-10 23:05:02 +0000634 installMapPath := fi.builtFile
635
Jiyong Parkb81b9902020-11-24 19:51:18 +0900636 // Copy the built file to the directory. But if the symlink optimization is turned
637 // on, place a symlink to the corresponding file in /system partition instead.
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900638 if a.linkToSystemLib && fi.transitiveDep && fi.availableToPlatform() {
Jiyong Parkce243632023-02-17 18:22:25 +0900639 pathOnDevice := filepath.Join("/", fi.partition, fi.path())
Jiyong Park7cd10e32020-01-14 09:22:18 +0900640 copyCommands = append(copyCommands, "ln -sfn "+pathOnDevice+" "+destPath)
641 } else {
Jiyong Park4169a252022-09-29 21:30:25 +0900642 // Copy the file into APEX
Kiyoung Kim11ad4e92024-09-04 14:16:47 +0900643 if !a.testApex && shouldApplyAssembleVintf(fi) {
Jooyung Han90934ac2023-09-22 14:52:06 +0900644 // copy the output of assemble_vintf instead of the original
645 vintfFragment := runAssembleVintf(ctx, fi.builtFile)
646 copyCommands = append(copyCommands, "cp -f "+vintfFragment.String()+" "+destPath)
647 implicitInputs = append(implicitInputs, vintfFragment)
648 } else {
649 copyCommands = append(copyCommands, "cp -f "+fi.builtFile.String()+" "+destPath)
650 implicitInputs = append(implicitInputs, fi.builtFile)
651 }
Jiyong Park4169a252022-09-29 21:30:25 +0900652
Colin Cross4acaea92021-12-10 23:05:02 +0000653 var installedPath android.InstallPath
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700654 if fi.class == appSet {
Jiyong Park4169a252022-09-29 21:30:25 +0900655 // In case of AppSet, we need to copy additional APKs as well. They
656 // are zipped. So we need to unzip them.
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700657 copyCommands = append(copyCommands,
Colin Crossffbcd1d2021-11-12 12:19:42 -0800658 fmt.Sprintf("unzip -qDD -d %s %s", destPathDir,
659 fi.module.(*java.AndroidAppSet).PackedAdditionalOutputs().String()))
Colin Cross6340ea52021-11-04 12:01:18 -0700660 if installSymbolFiles {
Jooyung Han63dff462023-02-09 00:11:27 +0000661 installedPath = ctx.InstallFileWithExtraFilesZip(apexDir.Join(ctx, fi.installDir),
Colin Cross6340ea52021-11-04 12:01:18 -0700662 fi.stem(), fi.builtFile, fi.module.(*java.AndroidAppSet).PackedAdditionalOutputs())
663 }
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700664 } else {
Colin Cross6340ea52021-11-04 12:01:18 -0700665 if installSymbolFiles {
Spandan Das72d86c62024-10-15 19:27:41 +0000666 // store installedPath. symlinks might be created if required.
Cole Faust0d3fd562025-01-31 13:17:58 -0800667 installedPath = ctx.InstallFile(apexDir.Join(ctx, fi.installDir), fi.stem(), fi.builtFile)
Colin Cross6340ea52021-11-04 12:01:18 -0700668 }
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700669 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900670
Colin Cross4acaea92021-12-10 23:05:02 +0000671 // Create additional symlinks pointing the file inside the APEX (if any). Note that
672 // this is independent from the symlink optimization.
673 for _, symlinkPath := range fi.symlinkPaths() {
674 symlinkDest := imageDir.Join(ctx, symlinkPath).String()
675 copyCommands = append(copyCommands, "ln -sfn "+filepath.Base(destPath)+" "+symlinkDest)
676 if installSymbolFiles {
Inseob Kim5bedfee2023-04-20 10:16:14 +0900677 ctx.InstallSymlink(apexDir.Join(ctx, filepath.Dir(symlinkPath)), filepath.Base(symlinkPath), installedPath)
Colin Cross4acaea92021-12-10 23:05:02 +0000678 }
Colin Cross6340ea52021-11-04 12:01:18 -0700679 }
Colin Cross4acaea92021-12-10 23:05:02 +0000680
681 installMapPath = installedPath
Jiyong Park7cd10e32020-01-14 09:22:18 +0900682 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900683
684 // Copy the test files (if any)
Liz Kammer1c14a212020-05-12 15:26:55 -0700685 for _, d := range fi.dataPaths {
686 // TODO(eakammer): This is now the third repetition of ~this logic for test paths, refactoring should be possible
Colin Crossd442a0e2023-11-16 11:19:26 -0800687 relPath := d.ToRelativeInstallPath()
688 dataDest := imageDir.Join(ctx, fi.apexRelativePath(relPath)).String()
Liz Kammer1c14a212020-05-12 15:26:55 -0700689
Chris Parsons216e10a2020-07-09 17:12:52 -0400690 copyCommands = append(copyCommands, "cp -f "+d.SrcPath.String()+" "+dataDest)
691 implicitInputs = append(implicitInputs, d.SrcPath)
Liz Kammer1c14a212020-05-12 15:26:55 -0700692 }
Colin Cross4acaea92021-12-10 23:05:02 +0000693
694 installMapSet[installMapPath.String()+":"+fi.installDir+"/"+fi.builtFile.Base()] = true
Jiyong Park09d77522019-11-18 11:16:27 +0900695 }
Yu Liueae7b362023-11-16 17:05:47 -0800696
Jooyung Han214bf372019-11-12 13:03:50 +0900697 implicitInputs = append(implicitInputs, a.manifestPbOut)
Jiyong Park09d77522019-11-18 11:16:27 +0900698
Colin Cross4acaea92021-12-10 23:05:02 +0000699 if len(installMapSet) > 0 {
700 var installs []string
Cole Faust18994c72023-02-28 16:02:16 -0800701 installs = append(installs, android.SortedKeys(installMapSet)...)
Yu Liubad1eef2024-08-21 22:37:35 +0000702 ctx.SetLicenseInstallMap(installs)
Colin Cross4acaea92021-12-10 23:05:02 +0000703 }
704
Jiyong Parkb81b9902020-11-24 19:51:18 +0900705 ////////////////////////////////////////////////////////////////////////////////////////////
706 // Step 1.a: Write the list of files in this APEX to a txt file and compare it against
707 // the allowed list given via the allowed_files property. Build fails when the two lists
708 // differ.
709 //
710 // TODO(jiyong): consider removing this. Nobody other than com.android.apex.cts.shim.* seems
711 // to be using this at this moment. Furthermore, this looks very similar to what
712 // buildInstalledFilesFile does. At least, move this to somewhere else so that this doesn't
713 // hurt readability.
Jooyung Han938b5932020-06-20 12:47:47 +0900714 if a.overridableProperties.Allowed_files != nil {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900715 // Build content.txt
Cole Fausta7347492022-12-16 10:56:24 -0800716 var contentLines []string
Jiyong Parkb81b9902020-11-24 19:51:18 +0900717 imageContentFile := android.PathForModuleOut(ctx, "content.txt")
Cole Fausta7347492022-12-16 10:56:24 -0800718 contentLines = append(contentLines, "./apex_manifest.pb")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900719 minSdkVersion := a.minSdkVersion(ctx)
720 if minSdkVersion.EqualTo(android.SdkVersion_Android10) {
Cole Fausta7347492022-12-16 10:56:24 -0800721 contentLines = append(contentLines, "./apex_manifest.json")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900722 }
723 for _, fi := range a.filesInfo {
Cole Fausta7347492022-12-16 10:56:24 -0800724 contentLines = append(contentLines, "./"+fi.path())
Jiyong Parkb81b9902020-11-24 19:51:18 +0900725 }
Cole Fausta7347492022-12-16 10:56:24 -0800726 sort.Strings(contentLines)
727 android.WriteFileRule(ctx, imageContentFile, strings.Join(contentLines, "\n"))
Jiyong Park09d77522019-11-18 11:16:27 +0900728 implicitInputs = append(implicitInputs, imageContentFile)
Jiyong Park09d77522019-11-18 11:16:27 +0900729
Jiyong Parkb81b9902020-11-24 19:51:18 +0900730 // Compare content.txt against allowed_files.
731 allowedFilesFile := android.PathForModuleSrc(ctx, proptools.String(a.overridableProperties.Allowed_files))
Jaewoong Jung1670ca02019-11-22 14:50:42 -0800732 phonyOutput := android.PathForModuleOut(ctx, a.Name()+"-diff-phony-output")
Jiyong Park09d77522019-11-18 11:16:27 +0900733 ctx.Build(pctx, android.BuildParams{
734 Rule: diffApexContentRule,
735 Implicits: implicitInputs,
736 Output: phonyOutput,
737 Description: "diff apex image content",
738 Args: map[string]string{
Colin Cross440e0d02020-06-11 11:32:11 -0700739 "allowed_files_file": allowedFilesFile.String(),
740 "image_content_file": imageContentFile.String(),
741 "apex_module_name": a.Name(),
Jiyong Park09d77522019-11-18 11:16:27 +0900742 },
743 })
Jiyong Park09d77522019-11-18 11:16:27 +0900744 implicitInputs = append(implicitInputs, phonyOutput)
745 }
746
Jiyong Parkb81b9902020-11-24 19:51:18 +0900747 unsignedOutputFile := android.PathForModuleOut(ctx, a.Name()+suffix+".unsigned")
Colin Cross790ef352021-10-25 19:15:55 -0700748 outHostBinDir := ctx.Config().HostToolPath(ctx, "").String()
Jiyong Park09d77522019-11-18 11:16:27 +0900749 prebuiltSdkToolsBinDir := filepath.Join("prebuilts", "sdk", "tools", runtime.GOOS, "bin")
750
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900751 ////////////////////////////////////////////////////////////////////////////////////
752 // Step 2: create canned_fs_config which encodes filemode,uid,gid of each files
753 // in this APEX. The file will be used by apexer in later steps.
Jooyung Hana3fddf42024-09-03 13:22:21 +0900754 cannedFsConfig := a.buildCannedFsConfig(ctx)
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900755 implicitInputs = append(implicitInputs, cannedFsConfig)
Jiyong Park1b0893e2021-12-13 23:40:17 +0900756
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900757 ////////////////////////////////////////////////////////////////////////////////////
758 // Step 3: Prepare option flags for apexer and invoke it to create an unsigned APEX.
759 // TODO(jiyong): use the RuleBuilder
760 optFlags := []string{}
Jiyong Park09d77522019-11-18 11:16:27 +0900761
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900762 fileContexts := a.buildFileContexts(ctx)
763 implicitInputs = append(implicitInputs, fileContexts)
Jiyong Park09d77522019-11-18 11:16:27 +0900764
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900765 implicitInputs = append(implicitInputs, a.privateKeyFile, a.publicKeyFile)
766 optFlags = append(optFlags, "--pubkey "+a.publicKeyFile.String())
Jiyong Parkb81b9902020-11-24 19:51:18 +0900767
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900768 manifestPackageName := a.getOverrideManifestPackageName(ctx)
769 if manifestPackageName != "" {
770 optFlags = append(optFlags, "--override_apk_package_name "+manifestPackageName)
771 }
Jiyong Park09d77522019-11-18 11:16:27 +0900772
Cole Faustbf1d92a2024-07-29 12:24:25 -0700773 androidManifest := a.properties.AndroidManifest.GetOrDefault(ctx, "")
Inseob Kimb1142342024-07-23 13:39:54 +0900774 if androidManifest != "" {
775 androidManifestFile := android.PathForModuleSrc(ctx, androidManifest)
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900776
777 if a.testApex {
778 androidManifestFile = markManifestTestOnly(ctx, androidManifestFile)
Jiyong Park09d77522019-11-18 11:16:27 +0900779 }
780
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900781 implicitInputs = append(implicitInputs, androidManifestFile)
782 optFlags = append(optFlags, "--android_manifest "+androidManifestFile.String())
783 } else if a.testApex {
784 optFlags = append(optFlags, "--test_only")
785 }
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000786
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900787 // Determine target/min sdk version from the context
788 // TODO(jiyong): make this as a function
789 moduleMinSdkVersion := a.minSdkVersion(ctx)
790 minSdkVersion := moduleMinSdkVersion.String()
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000791
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900792 // bundletool doesn't understand what "current" is. We need to transform it to
793 // codename
794 if moduleMinSdkVersion.IsCurrent() || moduleMinSdkVersion.IsNone() {
795 minSdkVersion = ctx.Config().DefaultAppTargetSdk(ctx).String()
Nikita Ioffe5d600c92020-02-20 00:43:27 +0000796
Jihoon Kang842b9992024-02-08 01:41:51 +0000797 if useApiFingerprint, fingerprintMinSdkVersion, fingerprintDeps :=
798 java.UseApiFingerprint(ctx); useApiFingerprint {
799 minSdkVersion = fingerprintMinSdkVersion
800 implicitInputs = append(implicitInputs, fingerprintDeps)
Baligh Uddinf6201372020-01-24 23:15:44 +0000801 }
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900802 }
803 // apex module doesn't have a concept of target_sdk_version, hence for the time
804 // being targetSdkVersion == default targetSdkVersion of the branch.
805 targetSdkVersion := strconv.Itoa(ctx.Config().DefaultAppTargetSdk(ctx).FinalOrFutureInt())
Jiyong Park09d77522019-11-18 11:16:27 +0900806
Jihoon Kang842b9992024-02-08 01:41:51 +0000807 if useApiFingerprint, fingerprintTargetSdkVersion, fingerprintDeps :=
808 java.UseApiFingerprint(ctx); useApiFingerprint {
809 targetSdkVersion = fingerprintTargetSdkVersion
810 implicitInputs = append(implicitInputs, fingerprintDeps)
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900811 }
812 optFlags = append(optFlags, "--target_sdk_version "+targetSdkVersion)
813 optFlags = append(optFlags, "--min_sdk_version "+minSdkVersion)
Baligh Uddin004d7172020-02-19 21:29:28 -0800814
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900815 if a.overridableProperties.Logging_parent != "" {
816 optFlags = append(optFlags, "--logging_parent ", a.overridableProperties.Logging_parent)
817 }
Jiyong Park09d77522019-11-18 11:16:27 +0900818
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900819 // Create a NOTICE file, and embed it as an asset file in the APEX.
820 htmlGzNotice := android.PathForModuleOut(ctx, "NOTICE.html.gz")
821 android.BuildNoticeHtmlOutputFromLicenseMetadata(
822 ctx, htmlGzNotice, "", "",
823 []string{
824 android.PathForModuleInstall(ctx).String() + "/",
825 android.PathForModuleInPartitionInstall(ctx, "apex").String() + "/",
Jiyong Park09d77522019-11-18 11:16:27 +0900826 })
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900827 noticeAssetPath := android.PathForModuleOut(ctx, "NOTICE", "NOTICE.html.gz")
828 builder := android.NewRuleBuilder(pctx, ctx)
829 builder.Command().Text("cp").
830 Input(htmlGzNotice).
831 Output(noticeAssetPath)
832 builder.Build("notice_dir", "Building notice dir")
833 implicitInputs = append(implicitInputs, noticeAssetPath)
834 optFlags = append(optFlags, "--assets_dir "+filepath.Dir(noticeAssetPath.String()))
Jiyong Park09d77522019-11-18 11:16:27 +0900835
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900836 if a.testOnlyShouldSkipPayloadSign() {
837 optFlags = append(optFlags, "--unsigned_payload")
838 }
839
840 if moduleMinSdkVersion == android.SdkVersion_Android10 {
841 implicitInputs = append(implicitInputs, a.manifestJsonOut)
842 optFlags = append(optFlags, "--manifest_json "+a.manifestJsonOut.String())
843 }
844
845 optFlags = append(optFlags, "--payload_fs_type "+a.payloadFsType.string())
846
847 if a.dynamic_common_lib_apex() {
sophiezc80a2b32020-11-12 16:39:19 +0000848 ctx.Build(pctx, android.BuildParams{
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900849 Rule: DCLAApexRule,
Jiyong Park09d77522019-11-18 11:16:27 +0900850 Implicits: implicitInputs,
851 Output: unsignedOutputFile,
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900852 Description: "apex",
Jiyong Park09d77522019-11-18 11:16:27 +0900853 Args: map[string]string{
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900854 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
855 "image_dir": imageDir.String(),
856 "copy_commands": strings.Join(copyCommands, " && "),
857 "manifest": a.manifestPbOut.String(),
858 "file_contexts": fileContexts.String(),
859 "canned_fs_config": cannedFsConfig.String(),
860 "key": a.privateKeyFile.String(),
861 "opt_flags": strings.Join(optFlags, " "),
862 },
863 })
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900864 } else {
865 ctx.Build(pctx, android.BuildParams{
866 Rule: apexRule,
867 Implicits: implicitInputs,
868 Output: unsignedOutputFile,
869 Description: "apex",
870 Args: map[string]string{
871 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
872 "image_dir": imageDir.String(),
873 "copy_commands": strings.Join(copyCommands, " && "),
874 "manifest": a.manifestPbOut.String(),
875 "file_contexts": fileContexts.String(),
876 "canned_fs_config": cannedFsConfig.String(),
877 "key": a.privateKeyFile.String(),
878 "opt_flags": strings.Join(optFlags, " "),
Jiyong Park09d77522019-11-18 11:16:27 +0900879 },
880 })
881 }
882
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900883 // TODO(jiyong): make the two rules below as separate functions
884 apexProtoFile := android.PathForModuleOut(ctx, a.Name()+".pb"+suffix)
885 bundleModuleFile := android.PathForModuleOut(ctx, a.Name()+suffix+"-base.zip")
886 a.bundleModuleFile = bundleModuleFile
887
888 ctx.Build(pctx, android.BuildParams{
889 Rule: apexProtoConvertRule,
890 Input: unsignedOutputFile,
891 Output: apexProtoFile,
892 Description: "apex proto convert",
893 })
894
895 implicitInputs = append(implicitInputs, unsignedOutputFile)
896
897 // Run coverage analysis
898 apisUsedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_using.txt")
899 ctx.Build(pctx, android.BuildParams{
900 Rule: generateAPIsUsedbyApexRule,
901 Implicits: implicitInputs,
902 Description: "coverage",
903 Output: apisUsedbyOutputFile,
904 Args: map[string]string{
905 "image_dir": imageDir.String(),
906 "readelf": "${config.ClangBin}/llvm-readelf",
907 },
908 })
909 a.nativeApisUsedByModuleFile = apisUsedbyOutputFile
910
911 var nativeLibNames []string
912 for _, f := range a.filesInfo {
913 if f.class == nativeSharedLib {
914 nativeLibNames = append(nativeLibNames, f.stem())
915 }
916 }
917 apisBackedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_backing.txt")
918 rb := android.NewRuleBuilder(pctx, ctx)
919 rb.Command().
920 Tool(android.PathForSource(ctx, "build/soong/scripts/gen_ndk_backedby_apex.sh")).
921 Output(apisBackedbyOutputFile).
922 Flags(nativeLibNames)
923 rb.Build("ndk_backedby_list", "Generate API libraries backed by Apex")
924 a.nativeApisBackedByModuleFile = apisBackedbyOutputFile
925
926 var javaLibOrApkPath []android.Path
927 for _, f := range a.filesInfo {
928 if f.class == javaSharedLib || f.class == app {
929 javaLibOrApkPath = append(javaLibOrApkPath, f.builtFile)
930 }
931 }
932 javaApiUsedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_using.xml")
933 javaUsedByRule := android.NewRuleBuilder(pctx, ctx)
934 javaUsedByRule.Command().
935 Tool(android.PathForSource(ctx, "build/soong/scripts/gen_java_usedby_apex.sh")).
936 BuiltTool("dexdeps").
937 Output(javaApiUsedbyOutputFile).
938 Inputs(javaLibOrApkPath)
939 javaUsedByRule.Build("java_usedby_list", "Generate Java APIs used by Apex")
940 a.javaApisUsedByModuleFile = javaApiUsedbyOutputFile
941
942 bundleConfig := a.buildBundleConfig(ctx)
943
944 var abis []string
945 for _, target := range ctx.MultiTargets() {
946 if len(target.Arch.Abi) > 0 {
947 abis = append(abis, target.Arch.Abi[0])
948 }
949 }
950
951 abis = android.FirstUniqueStrings(abis)
952
953 ctx.Build(pctx, android.BuildParams{
954 Rule: apexBundleRule,
955 Input: apexProtoFile,
956 Implicit: bundleConfig,
957 Output: a.bundleModuleFile,
958 Description: "apex bundle module",
959 Args: map[string]string{
960 "abi": strings.Join(abis, "."),
961 "config": bundleConfig.String(),
962 },
963 })
964
Jiyong Parkb81b9902020-11-24 19:51:18 +0900965 ////////////////////////////////////////////////////////////////////////////////////
966 // Step 4: Sign the APEX using signapk
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000967 signedOutputFile := android.PathForModuleOut(ctx, a.Name()+suffix)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900968
969 pem, key := a.getCertificateAndPrivateKey(ctx)
Kousik Kumar309b1c02020-05-28 06:13:33 -0700970 rule := java.Signapk
971 args := map[string]string{
Jiyong Parkb81b9902020-11-24 19:51:18 +0900972 "certificates": pem.String() + " " + key.String(),
Jooyung Han5d00f502021-07-11 07:26:22 +0900973 "flags": "-a 4096 --align-file-size", //alignment
Kousik Kumar309b1c02020-05-28 06:13:33 -0700974 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900975 implicits := android.Paths{pem, key}
Ramy Medhat16f23a42020-09-03 01:29:49 -0400976 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_SIGNAPK") {
Kousik Kumar309b1c02020-05-28 06:13:33 -0700977 rule = java.SignapkRE
978 args["implicits"] = strings.Join(implicits.Strings(), ",")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000979 args["outCommaList"] = signedOutputFile.String()
Kousik Kumar309b1c02020-05-28 06:13:33 -0700980 }
Jooyung Han01f5d652023-04-05 16:29:26 +0900981 var validations android.Paths
Cole Faust4e9f5922024-11-13 16:09:23 -0800982 validations = append(validations, runApexLinkerconfigValidation(ctx, unsignedOutputFile, imageDir))
Jooyung Han852545a2025-01-09 17:45:45 +0900983 if !a.skipValidation(apexSepolicyTests) && android.InList(a.payloadFsType, []fsType{ext4, erofs}) {
Jooyung Han3ae653b2025-01-03 17:42:12 +0900984 validations = append(validations, runApexSepolicyTests(ctx, a, unsignedOutputFile))
Jooyung Han01f5d652023-04-05 16:29:26 +0900985 }
Jooyung Han55a73062023-11-07 13:09:56 +0900986 if !a.testApex && len(a.properties.Unwanted_transitive_deps) > 0 {
987 validations = append(validations,
Cole Faust4e9f5922024-11-13 16:09:23 -0800988 runApexElfCheckerUnwanted(ctx, unsignedOutputFile, a.properties.Unwanted_transitive_deps))
Jooyung Han55a73062023-11-07 13:09:56 +0900989 }
Jooyung Hanb9518072024-11-22 14:05:20 +0900990 if !a.skipValidation(hostApexVerifier) && android.InList(a.payloadFsType, []fsType{ext4, erofs}) {
Cole Faust4e9f5922024-11-13 16:09:23 -0800991 validations = append(validations, runApexHostVerifier(ctx, a, unsignedOutputFile))
Jooyung Han2adba482024-02-22 17:27:53 +0900992 }
Jiyong Park09d77522019-11-18 11:16:27 +0900993 ctx.Build(pctx, android.BuildParams{
Kousik Kumar309b1c02020-05-28 06:13:33 -0700994 Rule: rule,
Jiyong Park09d77522019-11-18 11:16:27 +0900995 Description: "signapk",
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000996 Output: signedOutputFile,
Jiyong Park09d77522019-11-18 11:16:27 +0900997 Input: unsignedOutputFile,
Kousik Kumar309b1c02020-05-28 06:13:33 -0700998 Implicits: implicits,
999 Args: args,
Jooyung Han01f5d652023-04-05 16:29:26 +09001000 Validations: validations,
Jiyong Park09d77522019-11-18 11:16:27 +09001001 })
Jooyung Hana6d36672022-02-24 13:58:07 +09001002 if suffix == imageApexSuffix {
1003 a.outputApexFile = signedOutputFile
1004 }
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +00001005 a.outputFile = signedOutputFile
1006
Mohammad Samiul Islama8008f92020-12-22 10:47:50 +00001007 if ctx.ModuleDir() != "system/apex/apexd/apexd_testdata" && a.testOnlyShouldForceCompression() {
1008 ctx.PropertyErrorf("test_only_force_compression", "not available")
1009 return
1010 }
Nikita Ioffebc035882021-04-14 21:35:24 +01001011
Sasha Smundakfe9a5b82022-07-27 14:51:45 -07001012 installSuffix := suffix
1013 a.setCompression(ctx)
1014 if a.isCompressed {
Samiul Islam7c02e262021-09-08 17:48:28 +01001015 unsignedCompressedOutputFile := android.PathForModuleOut(ctx, a.Name()+imageCapexSuffix+".unsigned")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +00001016
1017 compressRule := android.NewRuleBuilder(pctx, ctx)
1018 compressRule.Command().
1019 Text("rm").
1020 FlagWithOutput("-f ", unsignedCompressedOutputFile)
1021 compressRule.Command().
1022 BuiltTool("apex_compression_tool").
1023 Flag("compress").
1024 FlagWithArg("--apex_compression_tool ", outHostBinDir+":"+prebuiltSdkToolsBinDir).
1025 FlagWithInput("--input ", signedOutputFile).
1026 FlagWithOutput("--output ", unsignedCompressedOutputFile)
1027 compressRule.Build("compressRule", "Generate unsigned compressed APEX file")
1028
Samiul Islam7c02e262021-09-08 17:48:28 +01001029 signedCompressedOutputFile := android.PathForModuleOut(ctx, a.Name()+imageCapexSuffix)
Mohammad Samiul Islam9ac0e322021-01-19 11:32:29 +00001030 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_SIGNAPK") {
1031 args["outCommaList"] = signedCompressedOutputFile.String()
1032 }
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +00001033 ctx.Build(pctx, android.BuildParams{
1034 Rule: rule,
1035 Description: "sign compressedApex",
1036 Output: signedCompressedOutputFile,
1037 Input: unsignedCompressedOutputFile,
1038 Implicits: implicits,
1039 Args: args,
1040 })
1041 a.outputFile = signedCompressedOutputFile
Martin Stjernholm8a3c9142022-07-26 09:35:39 +00001042 installSuffix = imageCapexSuffix
1043 }
1044
Colin Crossd9ccb6a2022-03-07 18:38:34 -08001045 if !a.installable() {
1046 a.SkipInstall()
1047 }
1048
Colin Cross388c6612025-01-28 14:00:12 -08001049 installDeps := slices.Concat(a.compatSymlinks, a.extraInstalledFiles)
Jiyong Park17ff2832021-09-27 12:50:30 +09001050 // Install to $OUT/soong/{target,host}/.../apex.
Colin Cross388c6612025-01-28 14:00:12 -08001051 a.installedFile = ctx.InstallFile(a.installDir, a.Name()+installSuffix, a.outputFile, installDeps...)
Jiyong Park3a1602e2020-01-14 14:39:19 +09001052
1053 // installed-files.txt is dist'ed
1054 a.installedFilesFile = a.buildInstalledFilesFile(ctx, a.outputFile, imageDir)
Jooyung Han286957d2023-10-30 16:17:56 +09001055
1056 a.apexKeysPath = writeApexKeys(ctx, a)
Jiyong Park09d77522019-11-18 11:16:27 +09001057}
1058
Jiyong Parkb81b9902020-11-24 19:51:18 +09001059// getCertificateAndPrivateKey retrieves the cert and the private key that will be used to sign
1060// the zip container of this APEX. See the description of the 'certificate' property for how
1061// the cert and the private key are found.
1062func (a *apexBundle) getCertificateAndPrivateKey(ctx android.PathContext) (pem, key android.Path) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001063 if a.containerCertificateFile != nil {
1064 return a.containerCertificateFile, a.containerPrivateKeyFile
Jiyong Parkb81b9902020-11-24 19:51:18 +09001065 }
1066
Jaewoong Jung4cfdf7d2021-04-20 16:21:24 -07001067 cert := String(a.overridableProperties.Certificate)
Jiyong Parkb81b9902020-11-24 19:51:18 +09001068 if cert == "" {
1069 return ctx.Config().DefaultAppCertificate(ctx)
1070 }
1071
1072 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
1073 pem = defaultDir.Join(ctx, cert+".x509.pem")
1074 key = defaultDir.Join(ctx, cert+".pk8")
1075 return pem, key
Jiyong Park09d77522019-11-18 11:16:27 +09001076}
Jooyung Han27151d92019-12-16 17:45:32 +09001077
1078func (a *apexBundle) getOverrideManifestPackageName(ctx android.ModuleContext) string {
1079 // For VNDK APEXes, check "com.android.vndk" in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES
1080 // to see if it should be overridden because their <apex name> is dynamically generated
1081 // according to its VNDK version.
1082 if a.vndkApex {
1083 overrideName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(vndkApexName)
1084 if overridden {
Kiyoung Kimfa13ff12024-03-18 16:01:19 +09001085 return overrideName + ".v" + a.vndkVersion()
Jooyung Han27151d92019-12-16 17:45:32 +09001086 }
1087 return ""
1088 }
Cole Faust12f6ec92024-10-03 13:32:43 -07001089 packageNameFromProp := a.overridableProperties.Package_name.GetOrDefault(ctx, "")
1090 if packageNameFromProp != "" {
1091 return packageNameFromProp
Baligh Uddin5b57dba2020-03-15 13:01:05 -07001092 }
Jiyong Park20bacab2020-03-03 11:45:41 +09001093 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jooyung Han27151d92019-12-16 17:45:32 +09001094 if overridden {
1095 return manifestPackageName
1096 }
1097 return ""
1098}
Jiyong Park83dc74b2020-01-14 18:38:44 +09001099
1100func (a *apexBundle) buildApexDependencyInfo(ctx android.ModuleContext) {
Jiyong Park83dc74b2020-01-14 18:38:44 +09001101 if a.properties.IsCoverageVariant {
1102 // Otherwise, we will have duplicated rules for coverage and
1103 // non-coverage variants of the same APEX
1104 return
1105 }
1106
Artur Satayev872a1442020-04-27 17:08:37 +01001107 depInfos := android.DepNameToDepInfoMap{}
Colin Cross1cea5302024-12-03 16:40:08 -08001108 a.WalkPayloadDeps(ctx, func(ctx android.BaseModuleContext, from android.Module, to android.ApexModule, externalDep bool) bool {
Artur Satayev872a1442020-04-27 17:08:37 +01001109 if from.Name() == to.Name() {
1110 // This can happen for cc.reuseObjTag. We are not interested in tracking this.
1111 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1112 return !externalDep
Jiyong Park678c8812020-02-07 17:25:49 +09001113 }
Jiyong Park83dc74b2020-01-14 18:38:44 +09001114
Artur Satayev533b98c2021-03-11 18:03:42 +00001115 // Skip dependencies that are only available to APEXes; they are developed with updatability
1116 // in mind and don't need manual approval.
Yu Liu8f2c5c02024-12-06 00:40:39 +00001117 if android.OtherModuleProviderOrDefault(ctx, to, android.CommonModuleInfoKey).NotAvailableForPlatform {
Artur Satayev533b98c2021-03-11 18:03:42 +00001118 return !externalDep
1119 }
1120
Cindy Zhou18417cb2020-12-10 07:12:38 -08001121 depTag := ctx.OtherModuleDependencyTag(to)
Artur Satayev533b98c2021-03-11 18:03:42 +00001122 // Check to see if dependency been marked to skip the dependency check
Cindy Zhou18417cb2020-12-10 07:12:38 -08001123 if skipDepCheck, ok := depTag.(android.SkipApexAllowedDependenciesCheck); ok && skipDepCheck.SkipApexAllowedDependenciesCheck() {
Cindy Zhou18417cb2020-12-10 07:12:38 -08001124 return !externalDep
1125 }
1126
Artur Satayev872a1442020-04-27 17:08:37 +01001127 if info, exists := depInfos[to.Name()]; exists {
1128 if !android.InList(from.Name(), info.From) {
1129 info.From = append(info.From, from.Name())
1130 }
1131 info.IsExternal = info.IsExternal && externalDep
1132 depInfos[to.Name()] = info
1133 } else {
Artur Satayev480e25b2020-04-27 18:53:18 +01001134 toMinSdkVersion := "(no version)"
Yu Liu8f2c5c02024-12-06 00:40:39 +00001135 if info, ok := android.OtherModuleProvider(ctx, to, android.CommonModuleInfoKey); ok {
1136 if v := info.MinSdkVersion; v != "" {
Artur Satayev480e25b2020-04-27 18:53:18 +01001137 toMinSdkVersion = v
1138 }
1139 }
Artur Satayev872a1442020-04-27 17:08:37 +01001140 depInfos[to.Name()] = android.ApexModuleDepInfo{
Artur Satayev480e25b2020-04-27 18:53:18 +01001141 To: to.Name(),
1142 From: []string{from.Name()},
1143 IsExternal: externalDep,
1144 MinSdkVersion: toMinSdkVersion,
Artur Satayev872a1442020-04-27 17:08:37 +01001145 }
1146 }
1147
1148 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1149 return !externalDep
Jiyong Park83dc74b2020-01-14 18:38:44 +09001150 })
1151
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001152 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(ctx).String(), depInfos)
Artur Satayev872a1442020-04-27 17:08:37 +01001153
Jiyong Park83dc74b2020-01-14 18:38:44 +09001154 ctx.Build(pctx, android.BuildParams{
1155 Rule: android.Phony,
1156 Output: android.PathForPhony(ctx, a.Name()+"-deps-info"),
Artur Satayeva8bd1132020-04-27 18:07:06 +01001157 Inputs: []android.Path{
1158 a.ApexBundleDepsInfo.FullListPath(),
1159 a.ApexBundleDepsInfo.FlatListPath(),
1160 },
Jiyong Park83dc74b2020-01-14 18:38:44 +09001161 })
1162}
Colin Cross08dca382020-07-21 20:31:17 -07001163
1164func (a *apexBundle) buildLintReports(ctx android.ModuleContext) {
1165 depSetsBuilder := java.NewLintDepSetBuilder()
1166 for _, fi := range a.filesInfo {
Colin Crossb79aa8f2024-09-25 15:41:01 -07001167 if fi.lintInfo != nil {
1168 depSetsBuilder.Transitive(fi.lintInfo)
1169 }
Colin Cross08dca382020-07-21 20:31:17 -07001170 }
1171
Colin Cross87427352024-09-25 15:41:19 -07001172 depSets := depSetsBuilder.Build()
1173 var validations android.Paths
1174
1175 if a.checkStrictUpdatabilityLinting(ctx) {
1176 baselines := depSets.Baseline.ToList()
1177 if len(baselines) > 0 {
1178 outputFile := java.VerifyStrictUpdatabilityChecks(ctx, baselines)
1179 validations = append(validations, outputFile)
1180 }
1181 }
1182
1183 a.lintReports = java.BuildModuleLintReportZips(ctx, depSets, validations)
Colin Cross08dca382020-07-21 20:31:17 -07001184}
Jiyong Park1b0893e2021-12-13 23:40:17 +09001185
Cole Faust4e9f5922024-11-13 16:09:23 -08001186func (a *apexBundle) buildCannedFsConfig(ctx android.ModuleContext) android.Path {
Jooyung Hana3fddf42024-09-03 13:22:21 +09001187 var readOnlyPaths = []string{"apex_manifest.json", "apex_manifest.pb"}
Jiyong Park1b0893e2021-12-13 23:40:17 +09001188 var executablePaths []string // this also includes dirs
1189 var appSetDirs []string
1190 appSetFiles := make(map[string]android.Path)
1191 for _, f := range a.filesInfo {
1192 pathInApex := f.path()
1193 if f.installDir == "bin" || strings.HasPrefix(f.installDir, "bin/") {
1194 executablePaths = append(executablePaths, pathInApex)
1195 for _, d := range f.dataPaths {
Colin Crossd442a0e2023-11-16 11:19:26 -08001196 rel := d.ToRelativeInstallPath()
1197 readOnlyPaths = append(readOnlyPaths, filepath.Join(f.installDir, rel))
Jiyong Park1b0893e2021-12-13 23:40:17 +09001198 }
1199 for _, s := range f.symlinks {
1200 executablePaths = append(executablePaths, filepath.Join(f.installDir, s))
1201 }
1202 } else if f.class == appSet {
Jiyong Park4169a252022-09-29 21:30:25 +09001203 // base APK
1204 readOnlyPaths = append(readOnlyPaths, pathInApex)
1205 // Additional APKs
Jiyong Park1b0893e2021-12-13 23:40:17 +09001206 appSetDirs = append(appSetDirs, f.installDir)
Jiyong Parke1b69142022-09-26 14:48:56 +09001207 appSetFiles[f.installDir] = f.module.(*java.AndroidAppSet).PackedAdditionalOutputs()
Jiyong Park1b0893e2021-12-13 23:40:17 +09001208 } else {
1209 readOnlyPaths = append(readOnlyPaths, pathInApex)
1210 }
1211 dir := f.installDir
1212 for !android.InList(dir, executablePaths) && dir != "" {
1213 executablePaths = append(executablePaths, dir)
1214 dir, _ = filepath.Split(dir) // move up to the parent
1215 if len(dir) > 0 {
1216 // remove trailing slash
1217 dir = dir[:len(dir)-1]
1218 }
1219 }
1220 }
1221 sort.Strings(readOnlyPaths)
1222 sort.Strings(executablePaths)
1223 sort.Strings(appSetDirs)
1224
1225 cannedFsConfig := android.PathForModuleOut(ctx, "canned_fs_config")
1226 builder := android.NewRuleBuilder(pctx, ctx)
1227 cmd := builder.Command()
1228 cmd.Text("(")
1229 cmd.Text("echo '/ 1000 1000 0755';")
1230 for _, p := range readOnlyPaths {
1231 cmd.Textf("echo '/%s 1000 1000 0644';", p)
1232 }
1233 for _, p := range executablePaths {
1234 cmd.Textf("echo '/%s 0 2000 0755';", p)
1235 }
1236 for _, dir := range appSetDirs {
1237 cmd.Textf("echo '/%s 0 2000 0755';", dir)
1238 file := appSetFiles[dir]
1239 cmd.Text("zipinfo -1").Input(file).Textf(`| sed "s:\(.*\):/%s/\1 1000 1000 0644:";`, dir)
1240 }
Jiyong Park038e8522021-12-13 23:56:35 +09001241 // Custom fs_config is "appended" to the last so that entries from the file are preferred
1242 // over default ones set above.
Cole Faustbf1d92a2024-07-29 12:24:25 -07001243 customFsConfig := a.properties.Canned_fs_config.GetOrDefault(ctx, "")
Inseob Kimb1142342024-07-23 13:39:54 +09001244 if customFsConfig != "" {
1245 cmd.Text("cat").Input(android.PathForModuleSrc(ctx, customFsConfig))
Jiyong Park038e8522021-12-13 23:56:35 +09001246 }
Maciej Żenczykowski67e2f792023-03-27 07:03:43 +00001247 cmd.Text(")").FlagWithOutput("> ", cannedFsConfig)
Jiyong Park1b0893e2021-12-13 23:40:17 +09001248 builder.Build("generateFsConfig", fmt.Sprintf("Generating canned fs config for %s", a.BaseModuleName()))
1249
Cole Faust4e9f5922024-11-13 16:09:23 -08001250 return cannedFsConfig
Jiyong Park1b0893e2021-12-13 23:40:17 +09001251}
Jooyung Han01f5d652023-04-05 16:29:26 +09001252
Cole Faust4e9f5922024-11-13 16:09:23 -08001253func runApexLinkerconfigValidation(ctx android.ModuleContext, apexFile android.Path, imageDir android.Path) android.Path {
Jooyung Han4bc10262023-09-08 11:51:45 +09001254 timestamp := android.PathForModuleOut(ctx, "apex_linkerconfig_validation.timestamp")
1255 ctx.Build(pctx, android.BuildParams{
1256 Rule: apexLinkerconfigValidationRule,
1257 Input: apexFile,
1258 Output: timestamp,
1259 Args: map[string]string{
1260 "image_dir": imageDir.String(),
1261 },
1262 })
1263 return timestamp
1264}
1265
Jooyung Han5f7fa502025-01-14 16:52:14 +09001266// Can't use PartitionTag() because PartitionTag() returns the partition this module is actually
1267// installed (e.g. PartitionTag() may return "system" for vendor apex when vendor is linked to /system/vendor)
1268func (a *apexBundle) partition() string {
1269 if a.SocSpecific() {
1270 return "vendor"
1271 } else if a.DeviceSpecific() {
1272 return "odm"
1273 } else if a.ProductSpecific() {
1274 return "product"
1275 } else if a.SystemExtSpecific() {
1276 return "system_ext"
1277 } else {
1278 return "system"
1279 }
1280}
1281
Jooyung Han01f5d652023-04-05 16:29:26 +09001282// Runs apex_sepolicy_tests
1283//
Jooyung Han852545a2025-01-09 17:45:45 +09001284// $ apex-ls -Z {apex_file} > {file_contexts}
Jooyung Han01f5d652023-04-05 16:29:26 +09001285// $ apex_sepolicy_tests -f {file_contexts}
Jooyung Han3ae653b2025-01-03 17:42:12 +09001286func runApexSepolicyTests(ctx android.ModuleContext, a *apexBundle, apexFile android.Path) android.Path {
Jooyung Hanb9518072024-11-22 14:05:20 +09001287 timestamp := android.PathForModuleOut(ctx, "apex_sepolicy_tests.timestamp")
Jooyung Han01f5d652023-04-05 16:29:26 +09001288 ctx.Build(pctx, android.BuildParams{
1289 Rule: apexSepolicyTestsRule,
1290 Input: apexFile,
1291 Output: timestamp,
Jooyung Han3ae653b2025-01-03 17:42:12 +09001292 Args: map[string]string{
Jooyung Han5f7fa502025-01-14 16:52:14 +09001293 "partition_tag": a.partition(),
Jooyung Han3ae653b2025-01-03 17:42:12 +09001294 },
Jooyung Han01f5d652023-04-05 16:29:26 +09001295 })
1296 return timestamp
1297}
Jooyung Han55a73062023-11-07 13:09:56 +09001298
Cole Faust4e9f5922024-11-13 16:09:23 -08001299func runApexElfCheckerUnwanted(ctx android.ModuleContext, apexFile android.Path, unwanted []string) android.Path {
Jooyung Han55a73062023-11-07 13:09:56 +09001300 timestamp := android.PathForModuleOut(ctx, "apex_elf_unwanted.timestamp")
1301 ctx.Build(pctx, android.BuildParams{
1302 Rule: apexElfCheckerUnwantedRule,
1303 Input: apexFile,
1304 Output: timestamp,
1305 Args: map[string]string{
1306 "unwanted": android.JoinWithSuffixAndSeparator(unwanted, ".so", ":"),
1307 "tool_path": ctx.Config().HostToolPath(ctx, "").String() + ":${config.ClangBin}",
1308 },
1309 })
1310 return timestamp
1311}
Jooyung Han2adba482024-02-22 17:27:53 +09001312
Cole Faust4e9f5922024-11-13 16:09:23 -08001313func runApexHostVerifier(ctx android.ModuleContext, a *apexBundle, apexFile android.Path) android.Path {
Jooyung Han2adba482024-02-22 17:27:53 +09001314 timestamp := android.PathForModuleOut(ctx, "host_apex_verifier.timestamp")
1315 ctx.Build(pctx, android.BuildParams{
1316 Rule: apexHostVerifierRule,
1317 Input: apexFile,
1318 Output: timestamp,
Jooyung Hanb6ac8222024-10-14 18:20:14 +09001319 Args: map[string]string{
Jooyung Han5f7fa502025-01-14 16:52:14 +09001320 "partition_tag": a.partition(),
Jooyung Hanb6ac8222024-10-14 18:20:14 +09001321 },
Jooyung Han2adba482024-02-22 17:27:53 +09001322 })
1323 return timestamp
1324}