blob: 30788630b2ef4c6e1f6b4e123498272cb358734c [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"
23 "sort"
Nikita Ioffe5335bc42020-10-20 00:02:15 +010024 "strconv"
Jiyong Park09d77522019-11-18 11:16:27 +090025 "strings"
26
Yu Liueae7b362023-11-16 17:05:47 -080027 "android/soong/aconfig"
Jiyong Park09d77522019-11-18 11:16:27 +090028 "android/soong/android"
29 "android/soong/java"
30
31 "github.com/google/blueprint"
32 "github.com/google/blueprint/proptools"
33)
34
35var (
36 pctx = android.NewPackageContext("android/apex")
37)
38
39func init() {
Yu Liueae7b362023-11-16 17:05:47 -080040 pctx.Import("android/soong/aconfig")
Jiyong Park09d77522019-11-18 11:16:27 +090041 pctx.Import("android/soong/android")
sophiezc80a2b32020-11-12 16:39:19 +000042 pctx.Import("android/soong/cc/config")
Jiyong Park09d77522019-11-18 11:16:27 +090043 pctx.Import("android/soong/java")
44 pctx.HostBinToolVariable("apexer", "apexer")
Dennis Shenaf41bc12022-08-03 16:46:43 +000045 pctx.HostBinToolVariable("apexer_with_DCLA_preprocessing", "apexer_with_DCLA_preprocessing")
Dennis Shene2ed70c2023-01-11 14:15:43 +000046 pctx.HostBinToolVariable("apexer_with_trim_preprocessing", "apexer_with_trim_preprocessing")
47
Jiyong Park09d77522019-11-18 11:16:27 +090048 // ART minimal builds (using the master-art manifest) do not have the "frameworks/base"
Jiyong Parkb81b9902020-11-24 19:51:18 +090049 // projects, and hence cannot build 'aapt2'. Use the SDK prebuilt instead.
Jiyong Park09d77522019-11-18 11:16:27 +090050 hostBinToolVariableWithPrebuilt := func(name, prebuiltDir, tool string) {
51 pctx.VariableFunc(name, func(ctx android.PackageVarContext) string {
52 if !ctx.Config().FrameworksBaseDirExists(ctx) {
53 return filepath.Join(prebuiltDir, runtime.GOOS, "bin", tool)
54 } else {
Martin Stjernholm7260d062019-12-09 21:47:14 +000055 return ctx.Config().HostToolPath(ctx, tool).String()
Jiyong Park09d77522019-11-18 11:16:27 +090056 }
57 })
58 }
59 hostBinToolVariableWithPrebuilt("aapt2", "prebuilts/sdk/tools", "aapt2")
60 pctx.HostBinToolVariable("avbtool", "avbtool")
61 pctx.HostBinToolVariable("e2fsdroid", "e2fsdroid")
62 pctx.HostBinToolVariable("merge_zips", "merge_zips")
63 pctx.HostBinToolVariable("mke2fs", "mke2fs")
64 pctx.HostBinToolVariable("resize2fs", "resize2fs")
65 pctx.HostBinToolVariable("sefcontext_compile", "sefcontext_compile")
66 pctx.HostBinToolVariable("soong_zip", "soong_zip")
67 pctx.HostBinToolVariable("zip2zip", "zip2zip")
68 pctx.HostBinToolVariable("zipalign", "zipalign")
69 pctx.HostBinToolVariable("jsonmodify", "jsonmodify")
70 pctx.HostBinToolVariable("conv_apex_manifest", "conv_apex_manifest")
Jaewoong Jungfa00c062020-05-14 14:15:24 -070071 pctx.HostBinToolVariable("extract_apks", "extract_apks")
Theotime Combes4ba38c12020-06-12 12:46:59 +000072 pctx.HostBinToolVariable("make_f2fs", "make_f2fs")
73 pctx.HostBinToolVariable("sload_f2fs", "sload_f2fs")
Huang Jianan13cac632021-08-02 15:02:17 +080074 pctx.HostBinToolVariable("make_erofs", "make_erofs")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +000075 pctx.HostBinToolVariable("apex_compression_tool", "apex_compression_tool")
sophiez02347372021-11-02 17:58:02 -070076 pctx.HostBinToolVariable("dexdeps", "dexdeps")
Jooyung Han01f5d652023-04-05 16:29:26 +090077 pctx.HostBinToolVariable("apex_sepolicy_tests", "apex_sepolicy_tests")
78 pctx.HostBinToolVariable("deapexer", "deapexer")
79 pctx.HostBinToolVariable("debugfs_static", "debugfs_static")
Jooyung Han55a73062023-11-07 13:09:56 +090080 pctx.HostBinToolVariable("fsck_erofs", "fsck.erofs")
sophiezc80a2b32020-11-12 16:39:19 +000081 pctx.SourcePathVariable("genNdkUsedbyApexPath", "build/soong/scripts/gen_ndk_usedby_apex.sh")
Jooyung Han4bc10262023-09-08 11:51:45 +090082 pctx.HostBinToolVariable("conv_linker_config", "conv_linker_config")
Jooyung Hane6154412023-09-08 15:25:59 +090083 pctx.HostBinToolVariable("assemble_vintf", "assemble_vintf")
Jooyung Han55a73062023-11-07 13:09:56 +090084 pctx.HostBinToolVariable("apex_elf_checker", "apex_elf_checker")
Yu Liueae7b362023-11-16 17:05:47 -080085 pctx.HostBinToolVariable("aconfig", "aconfig")
Jiyong Park09d77522019-11-18 11:16:27 +090086}
87
88var (
Jiyong Park09d77522019-11-18 11:16:27 +090089 apexManifestRule = pctx.StaticRule("apexManifestRule", blueprint.RuleParams{
90 Command: `rm -f $out && ${jsonmodify} $in ` +
91 `-a provideNativeLibs ${provideNativeLibs} ` +
92 `-a requireNativeLibs ${requireNativeLibs} ` +
Alexei Nicoarad887e242022-07-11 14:16:28 +010093 `-se version 0 ${default_version} ` +
Jiyong Park09d77522019-11-18 11:16:27 +090094 `${opt} ` +
95 `-o $out`,
96 CommandDeps: []string{"${jsonmodify}"},
97 Description: "prepare ${out}",
Alexei Nicoarad887e242022-07-11 14:16:28 +010098 }, "provideNativeLibs", "requireNativeLibs", "default_version", "opt")
Jiyong Park09d77522019-11-18 11:16:27 +090099
100 stripApexManifestRule = pctx.StaticRule("stripApexManifestRule", blueprint.RuleParams{
101 Command: `rm -f $out && ${conv_apex_manifest} strip $in -o $out`,
102 CommandDeps: []string{"${conv_apex_manifest}"},
103 Description: "strip ${in}=>${out}",
104 })
105
106 pbApexManifestRule = pctx.StaticRule("pbApexManifestRule", blueprint.RuleParams{
107 Command: `rm -f $out && ${conv_apex_manifest} proto $in -o $out`,
108 CommandDeps: []string{"${conv_apex_manifest}"},
109 Description: "convert ${in}=>${out}",
110 })
111
Joe Onoratob4638c12021-10-27 15:47:06 -0700112 // TODO(b/113233103): make sure that file_contexts is as expected, i.e., validate
Jiyong Park09d77522019-11-18 11:16:27 +0900113 // against the binary policy using sefcontext_compiler -p <policy>.
114
115 // TODO(b/114327326): automate the generation of file_contexts
116 apexRule = pctx.StaticRule("apexRule", blueprint.RuleParams{
117 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
118 `(. ${out}.copy_commands) && ` +
119 `APEXER_TOOL_PATH=${tool_path} ` +
120 `${apexer} --force --manifest ${manifest} ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900121 `--file_contexts ${file_contexts} ` +
122 `--canned_fs_config ${canned_fs_config} ` +
Dario Freni0f4ae072020-01-02 15:24:12 +0000123 `--include_build_info ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900124 `--payload_type image ` +
Oriol Prieto Gasco17e22902022-05-05 13:52:25 +0000125 `--key ${key} ${opt_flags} ${image_dir} ${out} `,
Jiyong Park09d77522019-11-18 11:16:27 +0900126 CommandDeps: []string{"${apexer}", "${avbtool}", "${e2fsdroid}", "${merge_zips}",
Huang Jianan13cac632021-08-02 15:02:17 +0800127 "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}", "${sload_f2fs}", "${make_erofs}",
Jiyong Park09d77522019-11-18 11:16:27 +0900128 "${soong_zip}", "${zipalign}", "${aapt2}", "prebuilts/sdk/current/public/android.jar"},
129 Rspfile: "${out}.copy_commands",
130 RspfileContent: "${copy_commands}",
131 Description: "APEX ${image_dir} => ${out}",
Dennis Shenaf41bc12022-08-03 16:46:43 +0000132 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
133 "opt_flags", "manifest")
134
135 DCLAApexRule = pctx.StaticRule("DCLAApexRule", blueprint.RuleParams{
136 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
137 `(. ${out}.copy_commands) && ` +
138 `APEXER_TOOL_PATH=${tool_path} ` +
139 `${apexer_with_DCLA_preprocessing} ` +
140 `--apexer ${apexer} ` +
141 `--canned_fs_config ${canned_fs_config} ` +
142 `${image_dir} ` +
143 `${out} ` +
144 `-- ` +
145 `--include_build_info ` +
146 `--force ` +
147 `--payload_type image ` +
148 `--key ${key} ` +
149 `--file_contexts ${file_contexts} ` +
150 `--manifest ${manifest} ` +
151 `${opt_flags} `,
152 CommandDeps: []string{"${apexer_with_DCLA_preprocessing}", "${apexer}", "${avbtool}", "${e2fsdroid}",
153 "${merge_zips}", "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}",
154 "${sload_f2fs}", "${make_erofs}", "${soong_zip}", "${zipalign}", "${aapt2}",
155 "prebuilts/sdk/current/public/android.jar"},
156 Rspfile: "${out}.copy_commands",
157 RspfileContent: "${copy_commands}",
158 Description: "APEX ${image_dir} => ${out}",
159 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
160 "opt_flags", "manifest", "is_DCLA")
Jiyong Park09d77522019-11-18 11:16:27 +0900161
Dennis Shene2ed70c2023-01-11 14:15:43 +0000162 TrimmedApexRule = pctx.StaticRule("TrimmedApexRule", blueprint.RuleParams{
163 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
164 `(. ${out}.copy_commands) && ` +
165 `APEXER_TOOL_PATH=${tool_path} ` +
166 `${apexer_with_trim_preprocessing} ` +
167 `--apexer ${apexer} ` +
168 `--canned_fs_config ${canned_fs_config} ` +
169 `--manifest ${manifest} ` +
170 `--libs_to_trim ${libs_to_trim} ` +
171 `${image_dir} ` +
172 `${out} ` +
173 `-- ` +
174 `--include_build_info ` +
175 `--force ` +
176 `--payload_type image ` +
177 `--key ${key} ` +
178 `--file_contexts ${file_contexts} ` +
179 `${opt_flags} `,
180 CommandDeps: []string{"${apexer_with_trim_preprocessing}", "${apexer}", "${avbtool}", "${e2fsdroid}",
181 "${merge_zips}", "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}",
182 "${sload_f2fs}", "${make_erofs}", "${soong_zip}", "${zipalign}", "${aapt2}",
183 "prebuilts/sdk/current/public/android.jar"},
184 Rspfile: "${out}.copy_commands",
185 RspfileContent: "${copy_commands}",
186 Description: "APEX ${image_dir} => ${out}",
187 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
188 "opt_flags", "manifest", "libs_to_trim")
189
Jiyong Park09d77522019-11-18 11:16:27 +0900190 apexProtoConvertRule = pctx.AndroidStaticRule("apexProtoConvertRule",
191 blueprint.RuleParams{
192 Command: `${aapt2} convert --output-format proto $in -o $out`,
193 CommandDeps: []string{"${aapt2}"},
194 })
195
196 apexBundleRule = pctx.StaticRule("apexBundleRule", blueprint.RuleParams{
Jiyong Parkbd159612020-02-28 15:22:21 +0900197 Command: `${zip2zip} -i $in -o $out.base ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900198 `apex_payload.img:apex/${abi}.img ` +
Dario Frenida1aefe2020-03-02 21:47:09 +0000199 `apex_build_info.pb:apex/${abi}.build_info.pb ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900200 `apex_manifest.json:root/apex_manifest.json ` +
Jiyong Park53ae3342019-12-08 02:06:24 +0900201 `apex_manifest.pb:root/apex_manifest.pb ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900202 `AndroidManifest.xml:manifest/AndroidManifest.xml ` +
Jiyong Parkbd159612020-02-28 15:22:21 +0900203 `assets/NOTICE.html.gz:assets/NOTICE.html.gz &&` +
204 `${soong_zip} -o $out.config -C $$(dirname ${config}) -f ${config} && ` +
205 `${merge_zips} $out $out.base $out.config`,
206 CommandDeps: []string{"${zip2zip}", "${soong_zip}", "${merge_zips}"},
Jiyong Park09d77522019-11-18 11:16:27 +0900207 Description: "app bundle",
Jiyong Parkbd159612020-02-28 15:22:21 +0900208 }, "abi", "config")
Jiyong Park09d77522019-11-18 11:16:27 +0900209
Jiyong Park09d77522019-11-18 11:16:27 +0900210 diffApexContentRule = pctx.StaticRule("diffApexContentRule", blueprint.RuleParams{
211 Command: `diff --unchanged-group-format='' \` +
212 `--changed-group-format='%<' \` +
Colin Cross440e0d02020-06-11 11:32:11 -0700213 `${image_content_file} ${allowed_files_file} || (` +
Jiyong Park09d77522019-11-18 11:16:27 +0900214 `echo -e "New unexpected files were added to ${apex_module_name}." ` +
215 ` "To fix the build run following command:" && ` +
Colin Cross440e0d02020-06-11 11:32:11 -0700216 `echo "system/apex/tools/update_allowed_list.sh ${allowed_files_file} ${image_content_file}" && ` +
Dan Willemsen81e43c52020-01-28 15:40:19 -0800217 `exit 1); touch ${out}`,
Colin Cross440e0d02020-06-11 11:32:11 -0700218 Description: "Diff ${image_content_file} and ${allowed_files_file}",
219 }, "image_content_file", "allowed_files_file", "apex_module_name")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900220
sophiezc80a2b32020-11-12 16:39:19 +0000221 generateAPIsUsedbyApexRule = pctx.StaticRule("generateAPIsUsedbyApexRule", blueprint.RuleParams{
222 Command: "$genNdkUsedbyApexPath ${image_dir} ${readelf} ${out}",
223 CommandDeps: []string{"${genNdkUsedbyApexPath}"},
224 Description: "Generate symbol list used by Apex",
225 }, "image_dir", "readelf")
226
Jooyung Han01f5d652023-04-05 16:29:26 +0900227 apexSepolicyTestsRule = pctx.StaticRule("apexSepolicyTestsRule", blueprint.RuleParams{
228 Command: `${deapexer} --debugfs_path ${debugfs_static} list -Z ${in} > ${out}.fc` +
Jooyung Hanb7cdbba2023-04-26 14:42:50 +0900229 ` && ${apex_sepolicy_tests} -f ${out}.fc && touch ${out}`,
Jooyung Han01f5d652023-04-05 16:29:26 +0900230 CommandDeps: []string{"${apex_sepolicy_tests}", "${deapexer}", "${debugfs_static}"},
231 Description: "run apex_sepolicy_tests",
232 })
Jooyung Han4bc10262023-09-08 11:51:45 +0900233
234 apexLinkerconfigValidationRule = pctx.StaticRule("apexLinkerconfigValidationRule", blueprint.RuleParams{
235 Command: `${conv_linker_config} validate --type apex ${image_dir} && touch ${out}`,
236 CommandDeps: []string{"${conv_linker_config}"},
237 Description: "run apex_linkerconfig_validation",
238 }, "image_dir")
Jooyung Hane6154412023-09-08 15:25:59 +0900239
Jooyung Han90934ac2023-09-22 14:52:06 +0900240 assembleVintfRule = pctx.StaticRule("assembleVintfRule", blueprint.RuleParams{
241 Command: `rm -f $out && VINTF_IGNORE_TARGET_FCM_VERSION=true ${assemble_vintf} -i $in -o $out`,
Jooyung Hane6154412023-09-08 15:25:59 +0900242 CommandDeps: []string{"${assemble_vintf}"},
Jooyung Han90934ac2023-09-22 14:52:06 +0900243 Description: "run assemble_vintf",
244 })
Jooyung Han55a73062023-11-07 13:09:56 +0900245
246 apexElfCheckerUnwantedRule = pctx.StaticRule("apexElfCheckerUnwantedRule", blueprint.RuleParams{
247 Command: `${apex_elf_checker} --tool_path ${tool_path} --unwanted ${unwanted} ${in} && touch ${out}`,
248 CommandDeps: []string{"${apex_elf_checker}", "${deapexer}", "${debugfs_static}", "${fsck_erofs}", "${config.ClangBin}/llvm-readelf"},
249 Description: "run apex_elf_checker --unwanted",
250 }, "tool_path", "unwanted")
Jiyong Park09d77522019-11-18 11:16:27 +0900251)
252
Jiyong Parkb81b9902020-11-24 19:51:18 +0900253// buildManifest creates buile rules to modify the input apex_manifest.json to add information
254// gathered by the build system such as provided/required native libraries. Two output files having
255// different formats are generated. a.manifestJsonOut is JSON format for Q devices, and
256// a.manifest.PbOut is protobuf format for R+ devices.
257// TODO(jiyong): make this to return paths instead of directly storing the paths to apexBundle
Jiyong Park09d77522019-11-18 11:16:27 +0900258func (a *apexBundle) buildManifest(ctx android.ModuleContext, provideNativeLibs, requireNativeLibs []string) {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900259 src := android.PathForModuleSrc(ctx, proptools.StringDefault(a.properties.Manifest, "apex_manifest.json"))
Jiyong Park09d77522019-11-18 11:16:27 +0900260
Jiyong Parkb81b9902020-11-24 19:51:18 +0900261 // Put dependency({provide|require}NativeLibs) in apex_manifest.json
Jiyong Park09d77522019-11-18 11:16:27 +0900262 provideNativeLibs = android.SortedUniqueStrings(provideNativeLibs)
263 requireNativeLibs = android.SortedUniqueStrings(android.RemoveListFromList(requireNativeLibs, provideNativeLibs))
264
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900265 // VNDK APEX name is determined at runtime, so update "name" in apex_manifest
Jiyong Park09d77522019-11-18 11:16:27 +0900266 optCommands := []string{}
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900267 if a.vndkApex {
268 apexName := vndkApexNamePrefix + a.vndkVersion(ctx.DeviceConfig())
269 optCommands = append(optCommands, "-v name "+apexName)
Jiyong Park09d77522019-11-18 11:16:27 +0900270 }
271
Jiyong Parkb81b9902020-11-24 19:51:18 +0900272 // Collect jniLibs. Notice that a.filesInfo is already sorted
Jooyung Han643adc42020-02-27 13:50:06 +0900273 var jniLibs []string
274 for _, fi := range a.filesInfo {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900275 if fi.isJniLib && !android.InList(fi.stem(), jniLibs) {
276 jniLibs = append(jniLibs, fi.stem())
Jooyung Han643adc42020-02-27 13:50:06 +0900277 }
278 }
279 if len(jniLibs) > 0 {
280 optCommands = append(optCommands, "-a jniLibs "+strings.Join(jniLibs, " "))
281 }
282
Jooyung Hand045ebc2022-12-06 15:23:57 +0900283 if android.InList(":vndk", requireNativeLibs) {
284 if _, vndkVersion := a.getImageVariationPair(ctx.DeviceConfig()); vndkVersion != "" {
285 optCommands = append(optCommands, "-v vndkVersion "+vndkVersion)
286 }
287 }
288
Jiyong Parkb81b9902020-11-24 19:51:18 +0900289 manifestJsonFullOut := android.PathForModuleOut(ctx, "apex_manifest_full.json")
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000290 defaultVersion := android.DefaultUpdatableModuleVersion
Sam Delmerico6d65a0f2023-06-05 15:55:57 -0400291 if a.properties.Variant_version != nil {
292 defaultVersionInt, err := strconv.Atoi(defaultVersion)
293 if err != nil {
294 ctx.ModuleErrorf("expected DefaultUpdatableModuleVersion to be an int, but got %s", defaultVersion)
295 }
296 if defaultVersionInt%10 != 0 {
297 ctx.ModuleErrorf("expected DefaultUpdatableModuleVersion to end in a zero, but got %s", defaultVersion)
298 }
299 variantVersion := []rune(*a.properties.Variant_version)
300 if len(variantVersion) != 1 || variantVersion[0] < '0' || variantVersion[0] > '9' {
301 ctx.PropertyErrorf("variant_version", "expected an integer between 0-9; got %s", *a.properties.Variant_version)
302 }
303 defaultVersionRunes := []rune(defaultVersion)
304 defaultVersionRunes[len(defaultVersion)-1] = []rune(variantVersion)[0]
305 defaultVersion = string(defaultVersionRunes)
306 }
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000307 if override := ctx.Config().Getenv("OVERRIDE_APEX_MANIFEST_DEFAULT_VERSION"); override != "" {
308 defaultVersion = override
309 }
Jiyong Park09d77522019-11-18 11:16:27 +0900310 ctx.Build(pctx, android.BuildParams{
311 Rule: apexManifestRule,
Alexei Nicoara0a389202022-07-12 14:35:39 +0100312 Input: src,
Jooyung Han214bf372019-11-12 13:03:50 +0900313 Output: manifestJsonFullOut,
Jiyong Park09d77522019-11-18 11:16:27 +0900314 Args: map[string]string{
315 "provideNativeLibs": strings.Join(provideNativeLibs, " "),
316 "requireNativeLibs": strings.Join(requireNativeLibs, " "),
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000317 "default_version": defaultVersion,
Jiyong Park09d77522019-11-18 11:16:27 +0900318 "opt": strings.Join(optCommands, " "),
319 },
320 })
321
Jiyong Parkb81b9902020-11-24 19:51:18 +0900322 // b/143654022 Q apexd can't understand newly added keys in apex_manifest.json prepare
323 // stripped-down version so that APEX modules built from R+ can be installed to Q
Dan Albertc8060532020-07-22 22:32:17 -0700324 minSdkVersion := a.minSdkVersion(ctx)
325 if minSdkVersion.EqualTo(android.SdkVersion_Android10) {
Jooyung Han214bf372019-11-12 13:03:50 +0900326 a.manifestJsonOut = android.PathForModuleOut(ctx, "apex_manifest.json")
327 ctx.Build(pctx, android.BuildParams{
328 Rule: stripApexManifestRule,
329 Input: manifestJsonFullOut,
330 Output: a.manifestJsonOut,
331 })
332 }
Jiyong Park09d77522019-11-18 11:16:27 +0900333
Jiyong Parkb81b9902020-11-24 19:51:18 +0900334 // From R+, protobuf binary format (.pb) is the standard format for apex_manifest
Jiyong Park09d77522019-11-18 11:16:27 +0900335 a.manifestPbOut = android.PathForModuleOut(ctx, "apex_manifest.pb")
336 ctx.Build(pctx, android.BuildParams{
337 Rule: pbApexManifestRule,
Jooyung Han214bf372019-11-12 13:03:50 +0900338 Input: manifestJsonFullOut,
Jiyong Park09d77522019-11-18 11:16:27 +0900339 Output: a.manifestPbOut,
340 })
341}
342
Jiyong Parkb81b9902020-11-24 19:51:18 +0900343// buildFileContexts create build rules to append an entry for apex_manifest.pb to the file_contexts
344// file for this APEX which is either from /systme/sepolicy/apex/<apexname>-file_contexts or from
345// 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 +0900346// labeled as system_file or vendor_apex_metadata_file.
Jiyong Parkb81b9902020-11-24 19:51:18 +0900347func (a *apexBundle) buildFileContexts(ctx android.ModuleContext) android.OutputPath {
Jooyung Han580eb4f2020-06-24 19:33:06 +0900348 var fileContexts android.Path
Liz Kammer37997c42021-09-14 17:53:38 -0400349 var fileContextsDir string
Inseob Kim28d06d22023-11-17 18:04:42 +0900350 isFileContextsModule := false
Jooyung Han580eb4f2020-06-24 19:33:06 +0900351 if a.properties.File_contexts == nil {
352 fileContexts = android.PathForSource(ctx, "system/sepolicy/apex", ctx.ModuleName()+"-file_contexts")
353 } else {
Liz Kammer37997c42021-09-14 17:53:38 -0400354 if m, t := android.SrcIsModuleWithTag(*a.properties.File_contexts); m != "" {
Inseob Kim28d06d22023-11-17 18:04:42 +0900355 isFileContextsModule = true
Liz Kammer37997c42021-09-14 17:53:38 -0400356 otherModule := android.GetModuleFromPathDep(ctx, m, t)
357 fileContextsDir = ctx.OtherModuleDir(otherModule)
358 }
Jooyung Han580eb4f2020-06-24 19:33:06 +0900359 fileContexts = android.PathForModuleSrc(ctx, *a.properties.File_contexts)
360 }
Liz Kammer37997c42021-09-14 17:53:38 -0400361 if fileContextsDir == "" {
362 fileContextsDir = filepath.Dir(fileContexts.String())
363 }
364 fileContextsDir += string(filepath.Separator)
365
Jooyung Han580eb4f2020-06-24 19:33:06 +0900366 if a.Platform() {
Liz Kammer37997c42021-09-14 17:53:38 -0400367 if !strings.HasPrefix(fileContextsDir, "system/sepolicy/") {
368 ctx.PropertyErrorf("file_contexts", "should be under system/sepolicy, but found in %q", fileContextsDir)
Jooyung Han580eb4f2020-06-24 19:33:06 +0900369 }
370 }
Inseob Kim28d06d22023-11-17 18:04:42 +0900371 if !isFileContextsModule && !android.ExistentPathForSource(ctx, fileContexts.String()).Valid() {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900372 ctx.PropertyErrorf("file_contexts", "cannot find file_contexts file: %q", fileContexts.String())
Jooyung Han580eb4f2020-06-24 19:33:06 +0900373 }
374
Jooyung Hanaf730952023-02-28 14:13:38 +0900375 useFileContextsAsIs := proptools.Bool(a.properties.Use_file_contexts_as_is)
376
Jooyung Han580eb4f2020-06-24 19:33:06 +0900377 output := android.PathForModuleOut(ctx, "file_contexts")
Colin Crossf1a035e2020-11-16 17:32:30 -0800378 rule := android.NewRuleBuilder(pctx, ctx)
Jooyung Han7f146c02020-09-23 19:15:55 +0900379
Jooyung Hanfed9cce2023-11-14 13:52:51 +0900380 labelForRoot := "u:object_r:system_file:s0"
381 labelForManifest := "u:object_r:system_file:s0"
Jooyung Hanbe953902023-05-31 16:42:16 +0900382 if a.SocSpecific() && !a.vndkApex {
Jooyung Hanfed9cce2023-11-14 13:52:51 +0900383 // APEX on /vendor should label ./ and ./apex_manifest.pb as vendor file.
384 labelForRoot = "u:object_r:vendor_file:s0"
385 labelForManifest = "u:object_r:vendor_apex_metadata_file:s0"
Jooyung Hanbe953902023-05-31 16:42:16 +0900386 }
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900387 // remove old file
388 rule.Command().Text("rm").FlagWithOutput("-f ", output)
389 // copy file_contexts
390 rule.Command().Text("cat").Input(fileContexts).Text(">>").Output(output)
391 // new line
392 rule.Command().Text("echo").Text(">>").Output(output)
393 if !useFileContextsAsIs {
394 // force-label /apex_manifest.pb and /
Jooyung Hanfed9cce2023-11-14 13:52:51 +0900395 rule.Command().Text("echo").Text("/apex_manifest\\\\.pb").Text(labelForManifest).Text(">>").Output(output)
396 rule.Command().Text("echo").Text("/").Text(labelForRoot).Text(">>").Output(output)
Jooyung Han7f146c02020-09-23 19:15:55 +0900397 }
398
Colin Crossf1a035e2020-11-16 17:32:30 -0800399 rule.Build("file_contexts."+a.Name(), "Generate file_contexts")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900400 return output.OutputPath
Jooyung Han580eb4f2020-06-24 19:33:06 +0900401}
402
Jiyong Parkb81b9902020-11-24 19:51:18 +0900403// buildInstalledFilesFile creates a build rule for the installed-files.txt file where the list of
404// files included in this APEX is shown. The text file is dist'ed so that people can see what's
405// included in the APEX without actually downloading and extracting it.
Jiyong Park3a1602e2020-01-14 14:39:19 +0900406func (a *apexBundle) buildInstalledFilesFile(ctx android.ModuleContext, builtApex android.Path, imageDir android.Path) android.OutputPath {
407 output := android.PathForModuleOut(ctx, "installed-files.txt")
Colin Crossf1a035e2020-11-16 17:32:30 -0800408 rule := android.NewRuleBuilder(pctx, ctx)
Jiyong Park3a1602e2020-01-14 14:39:19 +0900409 rule.Command().
410 Implicit(builtApex).
411 Text("(cd " + imageDir.String() + " ; ").
Jiyong Parkbd63a102020-02-08 12:40:05 +0900412 Text("find . \\( -type f -o -type l \\) -printf \"%s %p\\n\") ").
Jiyong Park3a1602e2020-01-14 14:39:19 +0900413 Text(" | sort -nr > ").
414 Output(output)
Colin Crossf1a035e2020-11-16 17:32:30 -0800415 rule.Build("installed-files."+a.Name(), "Installed files")
Jiyong Park3a1602e2020-01-14 14:39:19 +0900416 return output.OutputPath
417}
418
Jiyong Parkb81b9902020-11-24 19:51:18 +0900419// buildBundleConfig creates a build rule for the bundle config file that will control the bundle
420// creation process.
Jiyong Parkbd159612020-02-28 15:22:21 +0900421func (a *apexBundle) buildBundleConfig(ctx android.ModuleContext) android.OutputPath {
422 output := android.PathForModuleOut(ctx, "bundle_config.json")
423
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900424 type ApkConfig struct {
425 Package_name string `json:"package_name"`
426 Apk_path string `json:"path"`
427 }
Jiyong Parkbd159612020-02-28 15:22:21 +0900428 config := struct {
429 Compression struct {
430 Uncompressed_glob []string `json:"uncompressed_glob"`
431 } `json:"compression"`
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900432 Apex_config struct {
433 Apex_embedded_apk_config []ApkConfig `json:"apex_embedded_apk_config,omitempty"`
434 } `json:"apex_config,omitempty"`
Jiyong Parkbd159612020-02-28 15:22:21 +0900435 }{}
436
437 config.Compression.Uncompressed_glob = []string{
438 "apex_payload.img",
439 "apex_manifest.*",
440 }
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900441
Jiyong Parkb81b9902020-11-24 19:51:18 +0900442 // Collect the manifest names and paths of android apps if their manifest names are
443 // overridden.
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900444 for _, fi := range a.filesInfo {
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700445 if fi.class != app && fi.class != appSet {
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900446 continue
447 }
448 packageName := fi.overriddenPackageName
449 if packageName != "" {
450 config.Apex_config.Apex_embedded_apk_config = append(
451 config.Apex_config.Apex_embedded_apk_config,
452 ApkConfig{
453 Package_name: packageName,
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900454 Apk_path: fi.path(),
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900455 })
456 }
457 }
458
Jiyong Parkbd159612020-02-28 15:22:21 +0900459 j, err := json.Marshal(config)
460 if err != nil {
461 panic(fmt.Errorf("error while marshalling to %q: %#v", output, err))
462 }
463
Colin Crosscf371cc2020-11-13 11:48:42 -0800464 android.WriteFileRule(ctx, output, string(j))
Jiyong Parkbd159612020-02-28 15:22:21 +0900465
466 return output.OutputPath
467}
468
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000469func markManifestTestOnly(ctx android.ModuleContext, androidManifestFile android.Path) android.Path {
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000470 return java.ManifestFixer(ctx, androidManifestFile, java.ManifestFixerParams{
471 TestOnly: true,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000472 })
473}
474
Jooyung Han90934ac2023-09-22 14:52:06 +0900475func isVintfFragment(fi apexFile) bool {
476 isVintfFragment, _ := path.Match("etc/vintf/*.xml", fi.path())
477 return isVintfFragment
478}
479
480func runAssembleVintf(ctx android.ModuleContext, vintfFragment android.Path) android.Path {
481 processed := android.PathForModuleOut(ctx, "vintf", vintfFragment.Base())
482 ctx.Build(pctx, android.BuildParams{
483 Rule: assembleVintfRule,
484 Input: vintfFragment,
485 Output: processed,
486 Description: "run assemble_vintf for VINTF in APEX",
487 })
488 return processed
489}
490
Jooyung Haneec1b3f2023-06-20 16:25:59 +0900491// buildApex creates build rules to build an APEX using apexer.
492func (a *apexBundle) buildApex(ctx android.ModuleContext) {
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900493 suffix := imageApexSuffix
Jooyung Han63dff462023-02-09 00:11:27 +0000494 apexName := a.BaseModuleName()
Jiyong Park09d77522019-11-18 11:16:27 +0900495
Jiyong Parkb81b9902020-11-24 19:51:18 +0900496 ////////////////////////////////////////////////////////////////////////////////////////////
497 // Step 1: copy built files to appropriate directories under the image directory
498
499 imageDir := android.PathForModuleOut(ctx, "image"+suffix)
500
Colin Cross02730b92022-04-18 17:42:27 -0700501 installSymbolFiles := (!ctx.Config().KatiEnabled() || a.ExportedToMake()) && a.installable()
Colin Cross6340ea52021-11-04 12:01:18 -0700502
Colin Cross4acaea92021-12-10 23:05:02 +0000503 // set of dependency module:location mappings
504 installMapSet := make(map[string]bool)
Colin Cross6340ea52021-11-04 12:01:18 -0700505
Jiyong Parkb81b9902020-11-24 19:51:18 +0900506 // TODO(jiyong): use the RuleBuilder
Jiyong Park7cd10e32020-01-14 09:22:18 +0900507 var copyCommands []string
Jiyong Parkb81b9902020-11-24 19:51:18 +0900508 var implicitInputs []android.Path
Jooyung Han63dff462023-02-09 00:11:27 +0000509 apexDir := android.PathForModuleInPartitionInstall(ctx, "apex", apexName)
Jiyong Park7cd10e32020-01-14 09:22:18 +0900510 for _, fi := range a.filesInfo {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900511 destPath := imageDir.Join(ctx, fi.path()).String()
Jiyong Parkb81b9902020-11-24 19:51:18 +0900512 // Prepare the destination path
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700513 destPathDir := filepath.Dir(destPath)
514 if fi.class == appSet {
515 copyCommands = append(copyCommands, "rm -rf "+destPathDir)
516 }
517 copyCommands = append(copyCommands, "mkdir -p "+destPathDir)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900518
Colin Cross4acaea92021-12-10 23:05:02 +0000519 installMapPath := fi.builtFile
520
Jiyong Parkb81b9902020-11-24 19:51:18 +0900521 // Copy the built file to the directory. But if the symlink optimization is turned
522 // on, place a symlink to the corresponding file in /system partition instead.
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900523 if a.linkToSystemLib && fi.transitiveDep && fi.availableToPlatform() {
Jiyong Parkce243632023-02-17 18:22:25 +0900524 pathOnDevice := filepath.Join("/", fi.partition, fi.path())
Jiyong Park7cd10e32020-01-14 09:22:18 +0900525 copyCommands = append(copyCommands, "ln -sfn "+pathOnDevice+" "+destPath)
526 } else {
Jiyong Park4169a252022-09-29 21:30:25 +0900527 // Copy the file into APEX
Jooyung Han90934ac2023-09-22 14:52:06 +0900528 if !a.testApex && isVintfFragment(fi) {
529 // copy the output of assemble_vintf instead of the original
530 vintfFragment := runAssembleVintf(ctx, fi.builtFile)
531 copyCommands = append(copyCommands, "cp -f "+vintfFragment.String()+" "+destPath)
532 implicitInputs = append(implicitInputs, vintfFragment)
533 } else {
534 copyCommands = append(copyCommands, "cp -f "+fi.builtFile.String()+" "+destPath)
535 implicitInputs = append(implicitInputs, fi.builtFile)
536 }
Jiyong Park4169a252022-09-29 21:30:25 +0900537
Colin Cross4acaea92021-12-10 23:05:02 +0000538 var installedPath android.InstallPath
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700539 if fi.class == appSet {
Jiyong Park4169a252022-09-29 21:30:25 +0900540 // In case of AppSet, we need to copy additional APKs as well. They
541 // are zipped. So we need to unzip them.
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700542 copyCommands = append(copyCommands,
Colin Crossffbcd1d2021-11-12 12:19:42 -0800543 fmt.Sprintf("unzip -qDD -d %s %s", destPathDir,
544 fi.module.(*java.AndroidAppSet).PackedAdditionalOutputs().String()))
Colin Cross6340ea52021-11-04 12:01:18 -0700545 if installSymbolFiles {
Jooyung Han63dff462023-02-09 00:11:27 +0000546 installedPath = ctx.InstallFileWithExtraFilesZip(apexDir.Join(ctx, fi.installDir),
Colin Cross6340ea52021-11-04 12:01:18 -0700547 fi.stem(), fi.builtFile, fi.module.(*java.AndroidAppSet).PackedAdditionalOutputs())
548 }
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700549 } else {
Colin Cross6340ea52021-11-04 12:01:18 -0700550 if installSymbolFiles {
Jooyung Han63dff462023-02-09 00:11:27 +0000551 installedPath = ctx.InstallFile(apexDir.Join(ctx, fi.installDir), fi.stem(), fi.builtFile)
Colin Cross6340ea52021-11-04 12:01:18 -0700552 }
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700553 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900554
Colin Cross4acaea92021-12-10 23:05:02 +0000555 // Create additional symlinks pointing the file inside the APEX (if any). Note that
556 // this is independent from the symlink optimization.
557 for _, symlinkPath := range fi.symlinkPaths() {
558 symlinkDest := imageDir.Join(ctx, symlinkPath).String()
559 copyCommands = append(copyCommands, "ln -sfn "+filepath.Base(destPath)+" "+symlinkDest)
560 if installSymbolFiles {
Inseob Kim5bedfee2023-04-20 10:16:14 +0900561 ctx.InstallSymlink(apexDir.Join(ctx, filepath.Dir(symlinkPath)), filepath.Base(symlinkPath), installedPath)
Colin Cross4acaea92021-12-10 23:05:02 +0000562 }
Colin Cross6340ea52021-11-04 12:01:18 -0700563 }
Colin Cross4acaea92021-12-10 23:05:02 +0000564
565 installMapPath = installedPath
Jiyong Park7cd10e32020-01-14 09:22:18 +0900566 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900567
568 // Copy the test files (if any)
Liz Kammer1c14a212020-05-12 15:26:55 -0700569 for _, d := range fi.dataPaths {
570 // 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 -0800571 relPath := d.ToRelativeInstallPath()
572 dataDest := imageDir.Join(ctx, fi.apexRelativePath(relPath)).String()
Liz Kammer1c14a212020-05-12 15:26:55 -0700573
Chris Parsons216e10a2020-07-09 17:12:52 -0400574 copyCommands = append(copyCommands, "cp -f "+d.SrcPath.String()+" "+dataDest)
575 implicitInputs = append(implicitInputs, d.SrcPath)
Liz Kammer1c14a212020-05-12 15:26:55 -0700576 }
Colin Cross4acaea92021-12-10 23:05:02 +0000577
578 installMapSet[installMapPath.String()+":"+fi.installDir+"/"+fi.builtFile.Base()] = true
Jiyong Park09d77522019-11-18 11:16:27 +0900579 }
Yu Liueae7b362023-11-16 17:05:47 -0800580
Jooyung Han214bf372019-11-12 13:03:50 +0900581 implicitInputs = append(implicitInputs, a.manifestPbOut)
Jiyong Park09d77522019-11-18 11:16:27 +0900582
Colin Cross4acaea92021-12-10 23:05:02 +0000583 if len(installMapSet) > 0 {
584 var installs []string
Cole Faust18994c72023-02-28 16:02:16 -0800585 installs = append(installs, android.SortedKeys(installMapSet)...)
Colin Cross4acaea92021-12-10 23:05:02 +0000586 a.SetLicenseInstallMap(installs)
587 }
588
Jiyong Parkb81b9902020-11-24 19:51:18 +0900589 ////////////////////////////////////////////////////////////////////////////////////////////
590 // Step 1.a: Write the list of files in this APEX to a txt file and compare it against
591 // the allowed list given via the allowed_files property. Build fails when the two lists
592 // differ.
593 //
594 // TODO(jiyong): consider removing this. Nobody other than com.android.apex.cts.shim.* seems
595 // to be using this at this moment. Furthermore, this looks very similar to what
596 // buildInstalledFilesFile does. At least, move this to somewhere else so that this doesn't
597 // hurt readability.
Jooyung Han938b5932020-06-20 12:47:47 +0900598 if a.overridableProperties.Allowed_files != nil {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900599 // Build content.txt
Cole Fausta7347492022-12-16 10:56:24 -0800600 var contentLines []string
Jiyong Parkb81b9902020-11-24 19:51:18 +0900601 imageContentFile := android.PathForModuleOut(ctx, "content.txt")
Cole Fausta7347492022-12-16 10:56:24 -0800602 contentLines = append(contentLines, "./apex_manifest.pb")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900603 minSdkVersion := a.minSdkVersion(ctx)
604 if minSdkVersion.EqualTo(android.SdkVersion_Android10) {
Cole Fausta7347492022-12-16 10:56:24 -0800605 contentLines = append(contentLines, "./apex_manifest.json")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900606 }
607 for _, fi := range a.filesInfo {
Cole Fausta7347492022-12-16 10:56:24 -0800608 contentLines = append(contentLines, "./"+fi.path())
Jiyong Parkb81b9902020-11-24 19:51:18 +0900609 }
Cole Fausta7347492022-12-16 10:56:24 -0800610 sort.Strings(contentLines)
611 android.WriteFileRule(ctx, imageContentFile, strings.Join(contentLines, "\n"))
Jiyong Park09d77522019-11-18 11:16:27 +0900612 implicitInputs = append(implicitInputs, imageContentFile)
Jiyong Park09d77522019-11-18 11:16:27 +0900613
Jiyong Parkb81b9902020-11-24 19:51:18 +0900614 // Compare content.txt against allowed_files.
615 allowedFilesFile := android.PathForModuleSrc(ctx, proptools.String(a.overridableProperties.Allowed_files))
Jaewoong Jung1670ca02019-11-22 14:50:42 -0800616 phonyOutput := android.PathForModuleOut(ctx, a.Name()+"-diff-phony-output")
Jiyong Park09d77522019-11-18 11:16:27 +0900617 ctx.Build(pctx, android.BuildParams{
618 Rule: diffApexContentRule,
619 Implicits: implicitInputs,
620 Output: phonyOutput,
621 Description: "diff apex image content",
622 Args: map[string]string{
Colin Cross440e0d02020-06-11 11:32:11 -0700623 "allowed_files_file": allowedFilesFile.String(),
624 "image_content_file": imageContentFile.String(),
625 "apex_module_name": a.Name(),
Jiyong Park09d77522019-11-18 11:16:27 +0900626 },
627 })
Jiyong Park09d77522019-11-18 11:16:27 +0900628 implicitInputs = append(implicitInputs, phonyOutput)
629 }
630
Jiyong Parkb81b9902020-11-24 19:51:18 +0900631 unsignedOutputFile := android.PathForModuleOut(ctx, a.Name()+suffix+".unsigned")
Colin Cross790ef352021-10-25 19:15:55 -0700632 outHostBinDir := ctx.Config().HostToolPath(ctx, "").String()
Jiyong Park09d77522019-11-18 11:16:27 +0900633 prebuiltSdkToolsBinDir := filepath.Join("prebuilts", "sdk", "tools", runtime.GOOS, "bin")
634
Yu Liueae7b362023-11-16 17:05:47 -0800635 defaultReadOnlyFiles := []string{"apex_manifest.json", "apex_manifest.pb"}
636 if len(a.aconfigFiles) > 0 {
637 apexAconfigFile := android.PathForModuleOut(ctx, "aconfig_flags.pb")
638 ctx.Build(pctx, android.BuildParams{
639 Rule: aconfig.AllDeclarationsRule,
640 Inputs: a.aconfigFiles,
641 Output: apexAconfigFile,
642 Description: "combine_aconfig_declarations",
643 Args: map[string]string{
644 "cache_files": android.JoinPathsWithPrefix(a.aconfigFiles, "--cache "),
645 },
646 })
647
648 copyCommands = append(copyCommands, "cp -f "+apexAconfigFile.String()+" "+imageDir.String())
649 implicitInputs = append(implicitInputs, apexAconfigFile)
650 defaultReadOnlyFiles = append(defaultReadOnlyFiles, apexAconfigFile.Base())
651 }
652
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900653 ////////////////////////////////////////////////////////////////////////////////////
654 // Step 2: create canned_fs_config which encodes filemode,uid,gid of each files
655 // in this APEX. The file will be used by apexer in later steps.
Yu Liueae7b362023-11-16 17:05:47 -0800656 cannedFsConfig := a.buildCannedFsConfig(ctx, defaultReadOnlyFiles)
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900657 implicitInputs = append(implicitInputs, cannedFsConfig)
Jiyong Park1b0893e2021-12-13 23:40:17 +0900658
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900659 ////////////////////////////////////////////////////////////////////////////////////
660 // Step 3: Prepare option flags for apexer and invoke it to create an unsigned APEX.
661 // TODO(jiyong): use the RuleBuilder
662 optFlags := []string{}
Jiyong Park09d77522019-11-18 11:16:27 +0900663
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900664 fileContexts := a.buildFileContexts(ctx)
665 implicitInputs = append(implicitInputs, fileContexts)
Jiyong Park09d77522019-11-18 11:16:27 +0900666
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900667 implicitInputs = append(implicitInputs, a.privateKeyFile, a.publicKeyFile)
668 optFlags = append(optFlags, "--pubkey "+a.publicKeyFile.String())
Jiyong Parkb81b9902020-11-24 19:51:18 +0900669
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900670 manifestPackageName := a.getOverrideManifestPackageName(ctx)
671 if manifestPackageName != "" {
672 optFlags = append(optFlags, "--override_apk_package_name "+manifestPackageName)
673 }
Jiyong Park09d77522019-11-18 11:16:27 +0900674
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900675 if a.properties.AndroidManifest != nil {
676 androidManifestFile := android.PathForModuleSrc(ctx, proptools.String(a.properties.AndroidManifest))
677
678 if a.testApex {
679 androidManifestFile = markManifestTestOnly(ctx, androidManifestFile)
Jiyong Park09d77522019-11-18 11:16:27 +0900680 }
681
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900682 implicitInputs = append(implicitInputs, androidManifestFile)
683 optFlags = append(optFlags, "--android_manifest "+androidManifestFile.String())
684 } else if a.testApex {
685 optFlags = append(optFlags, "--test_only")
686 }
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000687
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900688 // Determine target/min sdk version from the context
689 // TODO(jiyong): make this as a function
690 moduleMinSdkVersion := a.minSdkVersion(ctx)
691 minSdkVersion := moduleMinSdkVersion.String()
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000692
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900693 // bundletool doesn't understand what "current" is. We need to transform it to
694 // codename
695 if moduleMinSdkVersion.IsCurrent() || moduleMinSdkVersion.IsNone() {
696 minSdkVersion = ctx.Config().DefaultAppTargetSdk(ctx).String()
Nikita Ioffe5d600c92020-02-20 00:43:27 +0000697
Nikita Ioffe1f4f3452020-03-02 16:58:11 +0000698 if java.UseApiFingerprint(ctx) {
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900699 minSdkVersion = ctx.Config().PlatformSdkCodename() + fmt.Sprintf(".$$(cat %s)", java.ApiFingerprintPath(ctx).String())
Baligh Uddinf6201372020-01-24 23:15:44 +0000700 implicitInputs = append(implicitInputs, java.ApiFingerprintPath(ctx))
701 }
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900702 }
703 // apex module doesn't have a concept of target_sdk_version, hence for the time
704 // being targetSdkVersion == default targetSdkVersion of the branch.
705 targetSdkVersion := strconv.Itoa(ctx.Config().DefaultAppTargetSdk(ctx).FinalOrFutureInt())
Jiyong Park09d77522019-11-18 11:16:27 +0900706
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900707 if java.UseApiFingerprint(ctx) {
708 targetSdkVersion = ctx.Config().PlatformSdkCodename() + fmt.Sprintf(".$$(cat %s)", java.ApiFingerprintPath(ctx).String())
709 implicitInputs = append(implicitInputs, java.ApiFingerprintPath(ctx))
710 }
711 optFlags = append(optFlags, "--target_sdk_version "+targetSdkVersion)
712 optFlags = append(optFlags, "--min_sdk_version "+minSdkVersion)
Baligh Uddin004d7172020-02-19 21:29:28 -0800713
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900714 if a.overridableProperties.Logging_parent != "" {
715 optFlags = append(optFlags, "--logging_parent ", a.overridableProperties.Logging_parent)
716 }
Jiyong Park09d77522019-11-18 11:16:27 +0900717
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900718 // Create a NOTICE file, and embed it as an asset file in the APEX.
719 htmlGzNotice := android.PathForModuleOut(ctx, "NOTICE.html.gz")
720 android.BuildNoticeHtmlOutputFromLicenseMetadata(
721 ctx, htmlGzNotice, "", "",
722 []string{
723 android.PathForModuleInstall(ctx).String() + "/",
724 android.PathForModuleInPartitionInstall(ctx, "apex").String() + "/",
Jiyong Park09d77522019-11-18 11:16:27 +0900725 })
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900726 noticeAssetPath := android.PathForModuleOut(ctx, "NOTICE", "NOTICE.html.gz")
727 builder := android.NewRuleBuilder(pctx, ctx)
728 builder.Command().Text("cp").
729 Input(htmlGzNotice).
730 Output(noticeAssetPath)
731 builder.Build("notice_dir", "Building notice dir")
732 implicitInputs = append(implicitInputs, noticeAssetPath)
733 optFlags = append(optFlags, "--assets_dir "+filepath.Dir(noticeAssetPath.String()))
Jiyong Park09d77522019-11-18 11:16:27 +0900734
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900735 // Apexes which are supposed to be installed in builtin dirs(/system, etc)
736 // don't need hashtree for activation. Therefore, by removing hashtree from
737 // apex bundle (filesystem image in it, to be specific), we can save storage.
738 needHashTree := moduleMinSdkVersion.LessThanOrEqualTo(android.SdkVersion_Android10) ||
739 a.shouldGenerateHashtree()
740 if ctx.Config().ApexCompressionEnabled() && a.isCompressable() {
741 needHashTree = true
742 }
743 if !needHashTree {
744 optFlags = append(optFlags, "--no_hashtree")
745 }
sophiezc80a2b32020-11-12 16:39:19 +0000746
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900747 if a.testOnlyShouldSkipPayloadSign() {
748 optFlags = append(optFlags, "--unsigned_payload")
749 }
750
751 if moduleMinSdkVersion == android.SdkVersion_Android10 {
752 implicitInputs = append(implicitInputs, a.manifestJsonOut)
753 optFlags = append(optFlags, "--manifest_json "+a.manifestJsonOut.String())
754 }
755
756 optFlags = append(optFlags, "--payload_fs_type "+a.payloadFsType.string())
757
758 if a.dynamic_common_lib_apex() {
sophiezc80a2b32020-11-12 16:39:19 +0000759 ctx.Build(pctx, android.BuildParams{
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900760 Rule: DCLAApexRule,
Jiyong Park09d77522019-11-18 11:16:27 +0900761 Implicits: implicitInputs,
762 Output: unsignedOutputFile,
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900763 Description: "apex",
Jiyong Park09d77522019-11-18 11:16:27 +0900764 Args: map[string]string{
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900765 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
766 "image_dir": imageDir.String(),
767 "copy_commands": strings.Join(copyCommands, " && "),
768 "manifest": a.manifestPbOut.String(),
769 "file_contexts": fileContexts.String(),
770 "canned_fs_config": cannedFsConfig.String(),
771 "key": a.privateKeyFile.String(),
772 "opt_flags": strings.Join(optFlags, " "),
773 },
774 })
775 } else if ctx.Config().ApexTrimEnabled() && len(a.libs_to_trim(ctx)) > 0 {
776 ctx.Build(pctx, android.BuildParams{
777 Rule: TrimmedApexRule,
778 Implicits: implicitInputs,
779 Output: unsignedOutputFile,
780 Description: "apex",
781 Args: map[string]string{
782 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
783 "image_dir": imageDir.String(),
784 "copy_commands": strings.Join(copyCommands, " && "),
785 "manifest": a.manifestPbOut.String(),
786 "file_contexts": fileContexts.String(),
787 "canned_fs_config": cannedFsConfig.String(),
788 "key": a.privateKeyFile.String(),
789 "opt_flags": strings.Join(optFlags, " "),
790 "libs_to_trim": strings.Join(a.libs_to_trim(ctx), ","),
791 },
792 })
793 } else {
794 ctx.Build(pctx, android.BuildParams{
795 Rule: apexRule,
796 Implicits: implicitInputs,
797 Output: unsignedOutputFile,
798 Description: "apex",
799 Args: map[string]string{
800 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
801 "image_dir": imageDir.String(),
802 "copy_commands": strings.Join(copyCommands, " && "),
803 "manifest": a.manifestPbOut.String(),
804 "file_contexts": fileContexts.String(),
805 "canned_fs_config": cannedFsConfig.String(),
806 "key": a.privateKeyFile.String(),
807 "opt_flags": strings.Join(optFlags, " "),
Jiyong Park09d77522019-11-18 11:16:27 +0900808 },
809 })
810 }
811
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900812 // TODO(jiyong): make the two rules below as separate functions
813 apexProtoFile := android.PathForModuleOut(ctx, a.Name()+".pb"+suffix)
814 bundleModuleFile := android.PathForModuleOut(ctx, a.Name()+suffix+"-base.zip")
815 a.bundleModuleFile = bundleModuleFile
816
817 ctx.Build(pctx, android.BuildParams{
818 Rule: apexProtoConvertRule,
819 Input: unsignedOutputFile,
820 Output: apexProtoFile,
821 Description: "apex proto convert",
822 })
823
824 implicitInputs = append(implicitInputs, unsignedOutputFile)
825
826 // Run coverage analysis
827 apisUsedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_using.txt")
828 ctx.Build(pctx, android.BuildParams{
829 Rule: generateAPIsUsedbyApexRule,
830 Implicits: implicitInputs,
831 Description: "coverage",
832 Output: apisUsedbyOutputFile,
833 Args: map[string]string{
834 "image_dir": imageDir.String(),
835 "readelf": "${config.ClangBin}/llvm-readelf",
836 },
837 })
838 a.nativeApisUsedByModuleFile = apisUsedbyOutputFile
839
840 var nativeLibNames []string
841 for _, f := range a.filesInfo {
842 if f.class == nativeSharedLib {
843 nativeLibNames = append(nativeLibNames, f.stem())
844 }
845 }
846 apisBackedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_backing.txt")
847 rb := android.NewRuleBuilder(pctx, ctx)
848 rb.Command().
849 Tool(android.PathForSource(ctx, "build/soong/scripts/gen_ndk_backedby_apex.sh")).
850 Output(apisBackedbyOutputFile).
851 Flags(nativeLibNames)
852 rb.Build("ndk_backedby_list", "Generate API libraries backed by Apex")
853 a.nativeApisBackedByModuleFile = apisBackedbyOutputFile
854
855 var javaLibOrApkPath []android.Path
856 for _, f := range a.filesInfo {
857 if f.class == javaSharedLib || f.class == app {
858 javaLibOrApkPath = append(javaLibOrApkPath, f.builtFile)
859 }
860 }
861 javaApiUsedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_using.xml")
862 javaUsedByRule := android.NewRuleBuilder(pctx, ctx)
863 javaUsedByRule.Command().
864 Tool(android.PathForSource(ctx, "build/soong/scripts/gen_java_usedby_apex.sh")).
865 BuiltTool("dexdeps").
866 Output(javaApiUsedbyOutputFile).
867 Inputs(javaLibOrApkPath)
868 javaUsedByRule.Build("java_usedby_list", "Generate Java APIs used by Apex")
869 a.javaApisUsedByModuleFile = javaApiUsedbyOutputFile
870
871 bundleConfig := a.buildBundleConfig(ctx)
872
873 var abis []string
874 for _, target := range ctx.MultiTargets() {
875 if len(target.Arch.Abi) > 0 {
876 abis = append(abis, target.Arch.Abi[0])
877 }
878 }
879
880 abis = android.FirstUniqueStrings(abis)
881
882 ctx.Build(pctx, android.BuildParams{
883 Rule: apexBundleRule,
884 Input: apexProtoFile,
885 Implicit: bundleConfig,
886 Output: a.bundleModuleFile,
887 Description: "apex bundle module",
888 Args: map[string]string{
889 "abi": strings.Join(abis, "."),
890 "config": bundleConfig.String(),
891 },
892 })
893
Jiyong Parkb81b9902020-11-24 19:51:18 +0900894 ////////////////////////////////////////////////////////////////////////////////////
895 // Step 4: Sign the APEX using signapk
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000896 signedOutputFile := android.PathForModuleOut(ctx, a.Name()+suffix)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900897
898 pem, key := a.getCertificateAndPrivateKey(ctx)
Kousik Kumar309b1c02020-05-28 06:13:33 -0700899 rule := java.Signapk
900 args := map[string]string{
Jiyong Parkb81b9902020-11-24 19:51:18 +0900901 "certificates": pem.String() + " " + key.String(),
Jooyung Han5d00f502021-07-11 07:26:22 +0900902 "flags": "-a 4096 --align-file-size", //alignment
Kousik Kumar309b1c02020-05-28 06:13:33 -0700903 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900904 implicits := android.Paths{pem, key}
Ramy Medhat16f23a42020-09-03 01:29:49 -0400905 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_SIGNAPK") {
Kousik Kumar309b1c02020-05-28 06:13:33 -0700906 rule = java.SignapkRE
907 args["implicits"] = strings.Join(implicits.Strings(), ",")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000908 args["outCommaList"] = signedOutputFile.String()
Kousik Kumar309b1c02020-05-28 06:13:33 -0700909 }
Jooyung Han01f5d652023-04-05 16:29:26 +0900910 var validations android.Paths
Jooyung Han4bc10262023-09-08 11:51:45 +0900911 validations = append(validations, runApexLinkerconfigValidation(ctx, unsignedOutputFile.OutputPath, imageDir.OutputPath))
Jooyung Hanb7cdbba2023-04-26 14:42:50 +0900912 // TODO(b/279688635) deapexer supports [ext4]
913 if suffix == imageApexSuffix && ext4 == a.payloadFsType {
Jooyung Han01f5d652023-04-05 16:29:26 +0900914 validations = append(validations, runApexSepolicyTests(ctx, unsignedOutputFile.OutputPath))
915 }
Jooyung Han55a73062023-11-07 13:09:56 +0900916 if !a.testApex && len(a.properties.Unwanted_transitive_deps) > 0 {
917 validations = append(validations,
918 runApexElfCheckerUnwanted(ctx, unsignedOutputFile.OutputPath, a.properties.Unwanted_transitive_deps))
919 }
Jiyong Park09d77522019-11-18 11:16:27 +0900920 ctx.Build(pctx, android.BuildParams{
Kousik Kumar309b1c02020-05-28 06:13:33 -0700921 Rule: rule,
Jiyong Park09d77522019-11-18 11:16:27 +0900922 Description: "signapk",
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000923 Output: signedOutputFile,
Jiyong Park09d77522019-11-18 11:16:27 +0900924 Input: unsignedOutputFile,
Kousik Kumar309b1c02020-05-28 06:13:33 -0700925 Implicits: implicits,
926 Args: args,
Jooyung Han01f5d652023-04-05 16:29:26 +0900927 Validations: validations,
Jiyong Park09d77522019-11-18 11:16:27 +0900928 })
Jooyung Hana6d36672022-02-24 13:58:07 +0900929 if suffix == imageApexSuffix {
930 a.outputApexFile = signedOutputFile
931 }
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000932 a.outputFile = signedOutputFile
933
Mohammad Samiul Islama8008f92020-12-22 10:47:50 +0000934 if ctx.ModuleDir() != "system/apex/apexd/apexd_testdata" && a.testOnlyShouldForceCompression() {
935 ctx.PropertyErrorf("test_only_force_compression", "not available")
936 return
937 }
Nikita Ioffebc035882021-04-14 21:35:24 +0100938
Sasha Smundakfe9a5b82022-07-27 14:51:45 -0700939 installSuffix := suffix
940 a.setCompression(ctx)
941 if a.isCompressed {
Samiul Islam7c02e262021-09-08 17:48:28 +0100942 unsignedCompressedOutputFile := android.PathForModuleOut(ctx, a.Name()+imageCapexSuffix+".unsigned")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000943
944 compressRule := android.NewRuleBuilder(pctx, ctx)
945 compressRule.Command().
946 Text("rm").
947 FlagWithOutput("-f ", unsignedCompressedOutputFile)
948 compressRule.Command().
949 BuiltTool("apex_compression_tool").
950 Flag("compress").
951 FlagWithArg("--apex_compression_tool ", outHostBinDir+":"+prebuiltSdkToolsBinDir).
952 FlagWithInput("--input ", signedOutputFile).
953 FlagWithOutput("--output ", unsignedCompressedOutputFile)
954 compressRule.Build("compressRule", "Generate unsigned compressed APEX file")
955
Samiul Islam7c02e262021-09-08 17:48:28 +0100956 signedCompressedOutputFile := android.PathForModuleOut(ctx, a.Name()+imageCapexSuffix)
Mohammad Samiul Islam9ac0e322021-01-19 11:32:29 +0000957 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_SIGNAPK") {
958 args["outCommaList"] = signedCompressedOutputFile.String()
959 }
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000960 ctx.Build(pctx, android.BuildParams{
961 Rule: rule,
962 Description: "sign compressedApex",
963 Output: signedCompressedOutputFile,
964 Input: unsignedCompressedOutputFile,
965 Implicits: implicits,
966 Args: args,
967 })
968 a.outputFile = signedCompressedOutputFile
Martin Stjernholm8a3c9142022-07-26 09:35:39 +0000969 installSuffix = imageCapexSuffix
970 }
971
Colin Crossd9ccb6a2022-03-07 18:38:34 -0800972 if !a.installable() {
973 a.SkipInstall()
974 }
975
Jiyong Park17ff2832021-09-27 12:50:30 +0900976 // Install to $OUT/soong/{target,host}/.../apex.
Martin Stjernholm8a3c9142022-07-26 09:35:39 +0000977 a.installedFile = ctx.InstallFile(a.installDir, a.Name()+installSuffix, a.outputFile,
Colin Cross09ad3a62023-11-15 12:29:33 -0800978 a.compatSymlinks...)
Jiyong Park3a1602e2020-01-14 14:39:19 +0900979
980 // installed-files.txt is dist'ed
981 a.installedFilesFile = a.buildInstalledFilesFile(ctx, a.outputFile, imageDir)
Jooyung Han286957d2023-10-30 16:17:56 +0900982
983 a.apexKeysPath = writeApexKeys(ctx, a)
Jiyong Park09d77522019-11-18 11:16:27 +0900984}
985
Jiyong Parkb81b9902020-11-24 19:51:18 +0900986// getCertificateAndPrivateKey retrieves the cert and the private key that will be used to sign
987// the zip container of this APEX. See the description of the 'certificate' property for how
988// the cert and the private key are found.
989func (a *apexBundle) getCertificateAndPrivateKey(ctx android.PathContext) (pem, key android.Path) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800990 if a.containerCertificateFile != nil {
991 return a.containerCertificateFile, a.containerPrivateKeyFile
Jiyong Parkb81b9902020-11-24 19:51:18 +0900992 }
993
Jaewoong Jung4cfdf7d2021-04-20 16:21:24 -0700994 cert := String(a.overridableProperties.Certificate)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900995 if cert == "" {
996 return ctx.Config().DefaultAppCertificate(ctx)
997 }
998
999 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
1000 pem = defaultDir.Join(ctx, cert+".x509.pem")
1001 key = defaultDir.Join(ctx, cert+".pk8")
1002 return pem, key
Jiyong Park09d77522019-11-18 11:16:27 +09001003}
Jooyung Han27151d92019-12-16 17:45:32 +09001004
1005func (a *apexBundle) getOverrideManifestPackageName(ctx android.ModuleContext) string {
1006 // For VNDK APEXes, check "com.android.vndk" in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES
1007 // to see if it should be overridden because their <apex name> is dynamically generated
1008 // according to its VNDK version.
1009 if a.vndkApex {
1010 overrideName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(vndkApexName)
1011 if overridden {
Jooyung Han2cd2f9a2023-02-06 18:29:08 +09001012 return overrideName + ".v" + a.vndkVersion(ctx.DeviceConfig())
Jooyung Han27151d92019-12-16 17:45:32 +09001013 }
1014 return ""
1015 }
Baligh Uddin5b57dba2020-03-15 13:01:05 -07001016 if a.overridableProperties.Package_name != "" {
1017 return a.overridableProperties.Package_name
1018 }
Jiyong Park20bacab2020-03-03 11:45:41 +09001019 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jooyung Han27151d92019-12-16 17:45:32 +09001020 if overridden {
1021 return manifestPackageName
1022 }
1023 return ""
1024}
Jiyong Park83dc74b2020-01-14 18:38:44 +09001025
1026func (a *apexBundle) buildApexDependencyInfo(ctx android.ModuleContext) {
Jiyong Park83dc74b2020-01-14 18:38:44 +09001027 if a.properties.IsCoverageVariant {
1028 // Otherwise, we will have duplicated rules for coverage and
1029 // non-coverage variants of the same APEX
1030 return
1031 }
1032
Artur Satayev872a1442020-04-27 17:08:37 +01001033 depInfos := android.DepNameToDepInfoMap{}
Jooyung Han749dc692020-04-15 11:03:39 +09001034 a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
Artur Satayev872a1442020-04-27 17:08:37 +01001035 if from.Name() == to.Name() {
1036 // This can happen for cc.reuseObjTag. We are not interested in tracking this.
1037 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1038 return !externalDep
Jiyong Park678c8812020-02-07 17:25:49 +09001039 }
Jiyong Park83dc74b2020-01-14 18:38:44 +09001040
Artur Satayev533b98c2021-03-11 18:03:42 +00001041 // Skip dependencies that are only available to APEXes; they are developed with updatability
1042 // in mind and don't need manual approval.
1043 if to.(android.ApexModule).NotAvailableForPlatform() {
1044 return !externalDep
1045 }
1046
Cindy Zhou18417cb2020-12-10 07:12:38 -08001047 depTag := ctx.OtherModuleDependencyTag(to)
Artur Satayev533b98c2021-03-11 18:03:42 +00001048 // Check to see if dependency been marked to skip the dependency check
Cindy Zhou18417cb2020-12-10 07:12:38 -08001049 if skipDepCheck, ok := depTag.(android.SkipApexAllowedDependenciesCheck); ok && skipDepCheck.SkipApexAllowedDependenciesCheck() {
Cindy Zhou18417cb2020-12-10 07:12:38 -08001050 return !externalDep
1051 }
1052
Artur Satayev872a1442020-04-27 17:08:37 +01001053 if info, exists := depInfos[to.Name()]; exists {
1054 if !android.InList(from.Name(), info.From) {
1055 info.From = append(info.From, from.Name())
1056 }
1057 info.IsExternal = info.IsExternal && externalDep
1058 depInfos[to.Name()] = info
1059 } else {
Artur Satayev480e25b2020-04-27 18:53:18 +01001060 toMinSdkVersion := "(no version)"
Jiyong Park92315372021-04-02 08:45:46 +09001061 if m, ok := to.(interface {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001062 MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
Jiyong Park92315372021-04-02 08:45:46 +09001063 }); ok {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001064 if v := m.MinSdkVersion(ctx); !v.IsNone() {
1065 toMinSdkVersion = v.String()
Jiyong Park92315372021-04-02 08:45:46 +09001066 }
1067 } else if m, ok := to.(interface{ MinSdkVersion() string }); ok {
1068 // TODO(b/175678607) eliminate the use of MinSdkVersion returning
1069 // string
Artur Satayev480e25b2020-04-27 18:53:18 +01001070 if v := m.MinSdkVersion(); v != "" {
1071 toMinSdkVersion = v
1072 }
1073 }
Artur Satayev872a1442020-04-27 17:08:37 +01001074 depInfos[to.Name()] = android.ApexModuleDepInfo{
Artur Satayev480e25b2020-04-27 18:53:18 +01001075 To: to.Name(),
1076 From: []string{from.Name()},
1077 IsExternal: externalDep,
1078 MinSdkVersion: toMinSdkVersion,
Artur Satayev872a1442020-04-27 17:08:37 +01001079 }
1080 }
1081
1082 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1083 return !externalDep
Jiyong Park83dc74b2020-01-14 18:38:44 +09001084 })
1085
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001086 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(ctx).String(), depInfos)
Artur Satayev872a1442020-04-27 17:08:37 +01001087
Jiyong Park83dc74b2020-01-14 18:38:44 +09001088 ctx.Build(pctx, android.BuildParams{
1089 Rule: android.Phony,
1090 Output: android.PathForPhony(ctx, a.Name()+"-deps-info"),
Artur Satayeva8bd1132020-04-27 18:07:06 +01001091 Inputs: []android.Path{
1092 a.ApexBundleDepsInfo.FullListPath(),
1093 a.ApexBundleDepsInfo.FlatListPath(),
1094 },
Jiyong Park83dc74b2020-01-14 18:38:44 +09001095 })
1096}
Colin Cross08dca382020-07-21 20:31:17 -07001097
1098func (a *apexBundle) buildLintReports(ctx android.ModuleContext) {
1099 depSetsBuilder := java.NewLintDepSetBuilder()
1100 for _, fi := range a.filesInfo {
1101 depSetsBuilder.Transitive(fi.lintDepSets)
1102 }
1103
1104 a.lintReports = java.BuildModuleLintReportZips(ctx, depSetsBuilder.Build())
1105}
Jiyong Park1b0893e2021-12-13 23:40:17 +09001106
Yu Liueae7b362023-11-16 17:05:47 -08001107func (a *apexBundle) buildCannedFsConfig(ctx android.ModuleContext, defaultReadOnlyFiles []string) android.OutputPath {
1108 var readOnlyPaths = defaultReadOnlyFiles
Jiyong Park1b0893e2021-12-13 23:40:17 +09001109 var executablePaths []string // this also includes dirs
1110 var appSetDirs []string
1111 appSetFiles := make(map[string]android.Path)
1112 for _, f := range a.filesInfo {
1113 pathInApex := f.path()
1114 if f.installDir == "bin" || strings.HasPrefix(f.installDir, "bin/") {
1115 executablePaths = append(executablePaths, pathInApex)
1116 for _, d := range f.dataPaths {
Colin Crossd442a0e2023-11-16 11:19:26 -08001117 rel := d.ToRelativeInstallPath()
1118 readOnlyPaths = append(readOnlyPaths, filepath.Join(f.installDir, rel))
Jiyong Park1b0893e2021-12-13 23:40:17 +09001119 }
1120 for _, s := range f.symlinks {
1121 executablePaths = append(executablePaths, filepath.Join(f.installDir, s))
1122 }
1123 } else if f.class == appSet {
Jiyong Park4169a252022-09-29 21:30:25 +09001124 // base APK
1125 readOnlyPaths = append(readOnlyPaths, pathInApex)
1126 // Additional APKs
Jiyong Park1b0893e2021-12-13 23:40:17 +09001127 appSetDirs = append(appSetDirs, f.installDir)
Jiyong Parke1b69142022-09-26 14:48:56 +09001128 appSetFiles[f.installDir] = f.module.(*java.AndroidAppSet).PackedAdditionalOutputs()
Jiyong Park1b0893e2021-12-13 23:40:17 +09001129 } else {
1130 readOnlyPaths = append(readOnlyPaths, pathInApex)
1131 }
1132 dir := f.installDir
1133 for !android.InList(dir, executablePaths) && dir != "" {
1134 executablePaths = append(executablePaths, dir)
1135 dir, _ = filepath.Split(dir) // move up to the parent
1136 if len(dir) > 0 {
1137 // remove trailing slash
1138 dir = dir[:len(dir)-1]
1139 }
1140 }
1141 }
1142 sort.Strings(readOnlyPaths)
1143 sort.Strings(executablePaths)
1144 sort.Strings(appSetDirs)
1145
1146 cannedFsConfig := android.PathForModuleOut(ctx, "canned_fs_config")
1147 builder := android.NewRuleBuilder(pctx, ctx)
1148 cmd := builder.Command()
1149 cmd.Text("(")
1150 cmd.Text("echo '/ 1000 1000 0755';")
1151 for _, p := range readOnlyPaths {
1152 cmd.Textf("echo '/%s 1000 1000 0644';", p)
1153 }
1154 for _, p := range executablePaths {
1155 cmd.Textf("echo '/%s 0 2000 0755';", p)
1156 }
1157 for _, dir := range appSetDirs {
1158 cmd.Textf("echo '/%s 0 2000 0755';", dir)
1159 file := appSetFiles[dir]
1160 cmd.Text("zipinfo -1").Input(file).Textf(`| sed "s:\(.*\):/%s/\1 1000 1000 0644:";`, dir)
1161 }
Jiyong Park038e8522021-12-13 23:56:35 +09001162 // Custom fs_config is "appended" to the last so that entries from the file are preferred
1163 // over default ones set above.
1164 if a.properties.Canned_fs_config != nil {
1165 cmd.Text("cat").Input(android.PathForModuleSrc(ctx, *a.properties.Canned_fs_config))
1166 }
Maciej Żenczykowski67e2f792023-03-27 07:03:43 +00001167 cmd.Text(")").FlagWithOutput("> ", cannedFsConfig)
Jiyong Park1b0893e2021-12-13 23:40:17 +09001168 builder.Build("generateFsConfig", fmt.Sprintf("Generating canned fs config for %s", a.BaseModuleName()))
1169
1170 return cannedFsConfig.OutputPath
1171}
Jooyung Han01f5d652023-04-05 16:29:26 +09001172
Jooyung Han4bc10262023-09-08 11:51:45 +09001173func runApexLinkerconfigValidation(ctx android.ModuleContext, apexFile android.OutputPath, imageDir android.OutputPath) android.Path {
1174 timestamp := android.PathForModuleOut(ctx, "apex_linkerconfig_validation.timestamp")
1175 ctx.Build(pctx, android.BuildParams{
1176 Rule: apexLinkerconfigValidationRule,
1177 Input: apexFile,
1178 Output: timestamp,
1179 Args: map[string]string{
1180 "image_dir": imageDir.String(),
1181 },
1182 })
1183 return timestamp
1184}
1185
Jooyung Han01f5d652023-04-05 16:29:26 +09001186// Runs apex_sepolicy_tests
1187//
1188// $ deapexer list -Z {apex_file} > {file_contexts}
1189// $ apex_sepolicy_tests -f {file_contexts}
1190func runApexSepolicyTests(ctx android.ModuleContext, apexFile android.OutputPath) android.Path {
1191 timestamp := android.PathForModuleOut(ctx, "sepolicy_tests.timestamp")
1192 ctx.Build(pctx, android.BuildParams{
1193 Rule: apexSepolicyTestsRule,
1194 Input: apexFile,
1195 Output: timestamp,
1196 })
1197 return timestamp
1198}
Jooyung Han55a73062023-11-07 13:09:56 +09001199
1200func runApexElfCheckerUnwanted(ctx android.ModuleContext, apexFile android.OutputPath, unwanted []string) android.Path {
1201 timestamp := android.PathForModuleOut(ctx, "apex_elf_unwanted.timestamp")
1202 ctx.Build(pctx, android.BuildParams{
1203 Rule: apexElfCheckerUnwantedRule,
1204 Input: apexFile,
1205 Output: timestamp,
1206 Args: map[string]string{
1207 "unwanted": android.JoinWithSuffixAndSeparator(unwanted, ".so", ":"),
1208 "tool_path": ctx.Config().HostToolPath(ctx, "").String() + ":${config.ClangBin}",
1209 },
1210 })
1211 return timestamp
1212}