blob: 729917f009b6de96c35cd68428ccc1d90d4dc8d0 [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
27 "android/soong/android"
28 "android/soong/java"
29
30 "github.com/google/blueprint"
31 "github.com/google/blueprint/proptools"
32)
33
34var (
35 pctx = android.NewPackageContext("android/apex")
36)
37
38func init() {
39 pctx.Import("android/soong/android")
sophiezc80a2b32020-11-12 16:39:19 +000040 pctx.Import("android/soong/cc/config")
Jiyong Park09d77522019-11-18 11:16:27 +090041 pctx.Import("android/soong/java")
42 pctx.HostBinToolVariable("apexer", "apexer")
Dennis Shenaf41bc12022-08-03 16:46:43 +000043 pctx.HostBinToolVariable("apexer_with_DCLA_preprocessing", "apexer_with_DCLA_preprocessing")
Dennis Shene2ed70c2023-01-11 14:15:43 +000044 pctx.HostBinToolVariable("apexer_with_trim_preprocessing", "apexer_with_trim_preprocessing")
45
Jiyong Park09d77522019-11-18 11:16:27 +090046 // ART minimal builds (using the master-art manifest) do not have the "frameworks/base"
Jiyong Parkb81b9902020-11-24 19:51:18 +090047 // projects, and hence cannot build 'aapt2'. Use the SDK prebuilt instead.
Jiyong Park09d77522019-11-18 11:16:27 +090048 hostBinToolVariableWithPrebuilt := func(name, prebuiltDir, tool string) {
49 pctx.VariableFunc(name, func(ctx android.PackageVarContext) string {
50 if !ctx.Config().FrameworksBaseDirExists(ctx) {
51 return filepath.Join(prebuiltDir, runtime.GOOS, "bin", tool)
52 } else {
Martin Stjernholm7260d062019-12-09 21:47:14 +000053 return ctx.Config().HostToolPath(ctx, tool).String()
Jiyong Park09d77522019-11-18 11:16:27 +090054 }
55 })
56 }
57 hostBinToolVariableWithPrebuilt("aapt2", "prebuilts/sdk/tools", "aapt2")
58 pctx.HostBinToolVariable("avbtool", "avbtool")
59 pctx.HostBinToolVariable("e2fsdroid", "e2fsdroid")
60 pctx.HostBinToolVariable("merge_zips", "merge_zips")
61 pctx.HostBinToolVariable("mke2fs", "mke2fs")
62 pctx.HostBinToolVariable("resize2fs", "resize2fs")
63 pctx.HostBinToolVariable("sefcontext_compile", "sefcontext_compile")
64 pctx.HostBinToolVariable("soong_zip", "soong_zip")
65 pctx.HostBinToolVariable("zip2zip", "zip2zip")
66 pctx.HostBinToolVariable("zipalign", "zipalign")
67 pctx.HostBinToolVariable("jsonmodify", "jsonmodify")
68 pctx.HostBinToolVariable("conv_apex_manifest", "conv_apex_manifest")
Jaewoong Jungfa00c062020-05-14 14:15:24 -070069 pctx.HostBinToolVariable("extract_apks", "extract_apks")
Theotime Combes4ba38c12020-06-12 12:46:59 +000070 pctx.HostBinToolVariable("make_f2fs", "make_f2fs")
71 pctx.HostBinToolVariable("sload_f2fs", "sload_f2fs")
Huang Jianan13cac632021-08-02 15:02:17 +080072 pctx.HostBinToolVariable("make_erofs", "make_erofs")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +000073 pctx.HostBinToolVariable("apex_compression_tool", "apex_compression_tool")
sophiez02347372021-11-02 17:58:02 -070074 pctx.HostBinToolVariable("dexdeps", "dexdeps")
Jooyung Han01f5d652023-04-05 16:29:26 +090075 pctx.HostBinToolVariable("apex_sepolicy_tests", "apex_sepolicy_tests")
76 pctx.HostBinToolVariable("deapexer", "deapexer")
77 pctx.HostBinToolVariable("debugfs_static", "debugfs_static")
sophiezc80a2b32020-11-12 16:39:19 +000078 pctx.SourcePathVariable("genNdkUsedbyApexPath", "build/soong/scripts/gen_ndk_usedby_apex.sh")
Jooyung Han4bc10262023-09-08 11:51:45 +090079 pctx.HostBinToolVariable("conv_linker_config", "conv_linker_config")
Jooyung Hane6154412023-09-08 15:25:59 +090080 pctx.HostBinToolVariable("assemble_vintf", "assemble_vintf")
Jiyong Park09d77522019-11-18 11:16:27 +090081}
82
83var (
Jiyong Park09d77522019-11-18 11:16:27 +090084 apexManifestRule = pctx.StaticRule("apexManifestRule", blueprint.RuleParams{
85 Command: `rm -f $out && ${jsonmodify} $in ` +
86 `-a provideNativeLibs ${provideNativeLibs} ` +
87 `-a requireNativeLibs ${requireNativeLibs} ` +
Alexei Nicoarad887e242022-07-11 14:16:28 +010088 `-se version 0 ${default_version} ` +
Jiyong Park09d77522019-11-18 11:16:27 +090089 `${opt} ` +
90 `-o $out`,
91 CommandDeps: []string{"${jsonmodify}"},
92 Description: "prepare ${out}",
Alexei Nicoarad887e242022-07-11 14:16:28 +010093 }, "provideNativeLibs", "requireNativeLibs", "default_version", "opt")
Jiyong Park09d77522019-11-18 11:16:27 +090094
95 stripApexManifestRule = pctx.StaticRule("stripApexManifestRule", blueprint.RuleParams{
96 Command: `rm -f $out && ${conv_apex_manifest} strip $in -o $out`,
97 CommandDeps: []string{"${conv_apex_manifest}"},
98 Description: "strip ${in}=>${out}",
99 })
100
101 pbApexManifestRule = pctx.StaticRule("pbApexManifestRule", blueprint.RuleParams{
102 Command: `rm -f $out && ${conv_apex_manifest} proto $in -o $out`,
103 CommandDeps: []string{"${conv_apex_manifest}"},
104 Description: "convert ${in}=>${out}",
105 })
106
Joe Onoratob4638c12021-10-27 15:47:06 -0700107 // TODO(b/113233103): make sure that file_contexts is as expected, i.e., validate
Jiyong Park09d77522019-11-18 11:16:27 +0900108 // against the binary policy using sefcontext_compiler -p <policy>.
109
110 // TODO(b/114327326): automate the generation of file_contexts
111 apexRule = pctx.StaticRule("apexRule", blueprint.RuleParams{
112 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
113 `(. ${out}.copy_commands) && ` +
114 `APEXER_TOOL_PATH=${tool_path} ` +
115 `${apexer} --force --manifest ${manifest} ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900116 `--file_contexts ${file_contexts} ` +
117 `--canned_fs_config ${canned_fs_config} ` +
Dario Freni0f4ae072020-01-02 15:24:12 +0000118 `--include_build_info ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900119 `--payload_type image ` +
Oriol Prieto Gasco17e22902022-05-05 13:52:25 +0000120 `--key ${key} ${opt_flags} ${image_dir} ${out} `,
Jiyong Park09d77522019-11-18 11:16:27 +0900121 CommandDeps: []string{"${apexer}", "${avbtool}", "${e2fsdroid}", "${merge_zips}",
Huang Jianan13cac632021-08-02 15:02:17 +0800122 "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}", "${sload_f2fs}", "${make_erofs}",
Jiyong Park09d77522019-11-18 11:16:27 +0900123 "${soong_zip}", "${zipalign}", "${aapt2}", "prebuilts/sdk/current/public/android.jar"},
124 Rspfile: "${out}.copy_commands",
125 RspfileContent: "${copy_commands}",
126 Description: "APEX ${image_dir} => ${out}",
Dennis Shenaf41bc12022-08-03 16:46:43 +0000127 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
128 "opt_flags", "manifest")
129
130 DCLAApexRule = pctx.StaticRule("DCLAApexRule", blueprint.RuleParams{
131 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
132 `(. ${out}.copy_commands) && ` +
133 `APEXER_TOOL_PATH=${tool_path} ` +
134 `${apexer_with_DCLA_preprocessing} ` +
135 `--apexer ${apexer} ` +
136 `--canned_fs_config ${canned_fs_config} ` +
137 `${image_dir} ` +
138 `${out} ` +
139 `-- ` +
140 `--include_build_info ` +
141 `--force ` +
142 `--payload_type image ` +
143 `--key ${key} ` +
144 `--file_contexts ${file_contexts} ` +
145 `--manifest ${manifest} ` +
146 `${opt_flags} `,
147 CommandDeps: []string{"${apexer_with_DCLA_preprocessing}", "${apexer}", "${avbtool}", "${e2fsdroid}",
148 "${merge_zips}", "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}",
149 "${sload_f2fs}", "${make_erofs}", "${soong_zip}", "${zipalign}", "${aapt2}",
150 "prebuilts/sdk/current/public/android.jar"},
151 Rspfile: "${out}.copy_commands",
152 RspfileContent: "${copy_commands}",
153 Description: "APEX ${image_dir} => ${out}",
154 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
155 "opt_flags", "manifest", "is_DCLA")
Jiyong Park09d77522019-11-18 11:16:27 +0900156
Dennis Shene2ed70c2023-01-11 14:15:43 +0000157 TrimmedApexRule = pctx.StaticRule("TrimmedApexRule", blueprint.RuleParams{
158 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
159 `(. ${out}.copy_commands) && ` +
160 `APEXER_TOOL_PATH=${tool_path} ` +
161 `${apexer_with_trim_preprocessing} ` +
162 `--apexer ${apexer} ` +
163 `--canned_fs_config ${canned_fs_config} ` +
164 `--manifest ${manifest} ` +
165 `--libs_to_trim ${libs_to_trim} ` +
166 `${image_dir} ` +
167 `${out} ` +
168 `-- ` +
169 `--include_build_info ` +
170 `--force ` +
171 `--payload_type image ` +
172 `--key ${key} ` +
173 `--file_contexts ${file_contexts} ` +
174 `${opt_flags} `,
175 CommandDeps: []string{"${apexer_with_trim_preprocessing}", "${apexer}", "${avbtool}", "${e2fsdroid}",
176 "${merge_zips}", "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}",
177 "${sload_f2fs}", "${make_erofs}", "${soong_zip}", "${zipalign}", "${aapt2}",
178 "prebuilts/sdk/current/public/android.jar"},
179 Rspfile: "${out}.copy_commands",
180 RspfileContent: "${copy_commands}",
181 Description: "APEX ${image_dir} => ${out}",
182 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
183 "opt_flags", "manifest", "libs_to_trim")
184
Jiyong Park09d77522019-11-18 11:16:27 +0900185 apexProtoConvertRule = pctx.AndroidStaticRule("apexProtoConvertRule",
186 blueprint.RuleParams{
187 Command: `${aapt2} convert --output-format proto $in -o $out`,
188 CommandDeps: []string{"${aapt2}"},
189 })
190
191 apexBundleRule = pctx.StaticRule("apexBundleRule", blueprint.RuleParams{
Jiyong Parkbd159612020-02-28 15:22:21 +0900192 Command: `${zip2zip} -i $in -o $out.base ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900193 `apex_payload.img:apex/${abi}.img ` +
Dario Frenida1aefe2020-03-02 21:47:09 +0000194 `apex_build_info.pb:apex/${abi}.build_info.pb ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900195 `apex_manifest.json:root/apex_manifest.json ` +
Jiyong Park53ae3342019-12-08 02:06:24 +0900196 `apex_manifest.pb:root/apex_manifest.pb ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900197 `AndroidManifest.xml:manifest/AndroidManifest.xml ` +
Jiyong Parkbd159612020-02-28 15:22:21 +0900198 `assets/NOTICE.html.gz:assets/NOTICE.html.gz &&` +
199 `${soong_zip} -o $out.config -C $$(dirname ${config}) -f ${config} && ` +
200 `${merge_zips} $out $out.base $out.config`,
201 CommandDeps: []string{"${zip2zip}", "${soong_zip}", "${merge_zips}"},
Jiyong Park09d77522019-11-18 11:16:27 +0900202 Description: "app bundle",
Jiyong Parkbd159612020-02-28 15:22:21 +0900203 }, "abi", "config")
Jiyong Park09d77522019-11-18 11:16:27 +0900204
Jiyong Park09d77522019-11-18 11:16:27 +0900205 diffApexContentRule = pctx.StaticRule("diffApexContentRule", blueprint.RuleParams{
206 Command: `diff --unchanged-group-format='' \` +
207 `--changed-group-format='%<' \` +
Colin Cross440e0d02020-06-11 11:32:11 -0700208 `${image_content_file} ${allowed_files_file} || (` +
Jiyong Park09d77522019-11-18 11:16:27 +0900209 `echo -e "New unexpected files were added to ${apex_module_name}." ` +
210 ` "To fix the build run following command:" && ` +
Colin Cross440e0d02020-06-11 11:32:11 -0700211 `echo "system/apex/tools/update_allowed_list.sh ${allowed_files_file} ${image_content_file}" && ` +
Dan Willemsen81e43c52020-01-28 15:40:19 -0800212 `exit 1); touch ${out}`,
Colin Cross440e0d02020-06-11 11:32:11 -0700213 Description: "Diff ${image_content_file} and ${allowed_files_file}",
214 }, "image_content_file", "allowed_files_file", "apex_module_name")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900215
sophiezc80a2b32020-11-12 16:39:19 +0000216 generateAPIsUsedbyApexRule = pctx.StaticRule("generateAPIsUsedbyApexRule", blueprint.RuleParams{
217 Command: "$genNdkUsedbyApexPath ${image_dir} ${readelf} ${out}",
218 CommandDeps: []string{"${genNdkUsedbyApexPath}"},
219 Description: "Generate symbol list used by Apex",
220 }, "image_dir", "readelf")
221
Jooyung Han01f5d652023-04-05 16:29:26 +0900222 apexSepolicyTestsRule = pctx.StaticRule("apexSepolicyTestsRule", blueprint.RuleParams{
223 Command: `${deapexer} --debugfs_path ${debugfs_static} list -Z ${in} > ${out}.fc` +
Jooyung Hanb7cdbba2023-04-26 14:42:50 +0900224 ` && ${apex_sepolicy_tests} -f ${out}.fc && touch ${out}`,
Jooyung Han01f5d652023-04-05 16:29:26 +0900225 CommandDeps: []string{"${apex_sepolicy_tests}", "${deapexer}", "${debugfs_static}"},
226 Description: "run apex_sepolicy_tests",
227 })
Jooyung Han4bc10262023-09-08 11:51:45 +0900228
229 apexLinkerconfigValidationRule = pctx.StaticRule("apexLinkerconfigValidationRule", blueprint.RuleParams{
230 Command: `${conv_linker_config} validate --type apex ${image_dir} && touch ${out}`,
231 CommandDeps: []string{"${conv_linker_config}"},
232 Description: "run apex_linkerconfig_validation",
233 }, "image_dir")
Jooyung Hane6154412023-09-08 15:25:59 +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 })
Jiyong Park09d77522019-11-18 11:16:27 +0900240)
241
Jiyong Parkb81b9902020-11-24 19:51:18 +0900242// buildManifest creates buile rules to modify the input apex_manifest.json to add information
243// gathered by the build system such as provided/required native libraries. Two output files having
244// different formats are generated. a.manifestJsonOut is JSON format for Q devices, and
245// a.manifest.PbOut is protobuf format for R+ devices.
246// TODO(jiyong): make this to return paths instead of directly storing the paths to apexBundle
Jiyong Park09d77522019-11-18 11:16:27 +0900247func (a *apexBundle) buildManifest(ctx android.ModuleContext, provideNativeLibs, requireNativeLibs []string) {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900248 src := android.PathForModuleSrc(ctx, proptools.StringDefault(a.properties.Manifest, "apex_manifest.json"))
Jiyong Park09d77522019-11-18 11:16:27 +0900249
Jiyong Parkb81b9902020-11-24 19:51:18 +0900250 // Put dependency({provide|require}NativeLibs) in apex_manifest.json
Jiyong Park09d77522019-11-18 11:16:27 +0900251 provideNativeLibs = android.SortedUniqueStrings(provideNativeLibs)
252 requireNativeLibs = android.SortedUniqueStrings(android.RemoveListFromList(requireNativeLibs, provideNativeLibs))
253
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900254 // VNDK APEX name is determined at runtime, so update "name" in apex_manifest
Jiyong Park09d77522019-11-18 11:16:27 +0900255 optCommands := []string{}
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900256 if a.vndkApex {
257 apexName := vndkApexNamePrefix + a.vndkVersion(ctx.DeviceConfig())
258 optCommands = append(optCommands, "-v name "+apexName)
Jiyong Park09d77522019-11-18 11:16:27 +0900259 }
260
Jiyong Parkb81b9902020-11-24 19:51:18 +0900261 // Collect jniLibs. Notice that a.filesInfo is already sorted
Jooyung Han643adc42020-02-27 13:50:06 +0900262 var jniLibs []string
263 for _, fi := range a.filesInfo {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900264 if fi.isJniLib && !android.InList(fi.stem(), jniLibs) {
265 jniLibs = append(jniLibs, fi.stem())
Jooyung Han643adc42020-02-27 13:50:06 +0900266 }
267 }
268 if len(jniLibs) > 0 {
269 optCommands = append(optCommands, "-a jniLibs "+strings.Join(jniLibs, " "))
270 }
271
Jooyung Hand045ebc2022-12-06 15:23:57 +0900272 if android.InList(":vndk", requireNativeLibs) {
273 if _, vndkVersion := a.getImageVariationPair(ctx.DeviceConfig()); vndkVersion != "" {
274 optCommands = append(optCommands, "-v vndkVersion "+vndkVersion)
275 }
276 }
277
Jiyong Parkb81b9902020-11-24 19:51:18 +0900278 manifestJsonFullOut := android.PathForModuleOut(ctx, "apex_manifest_full.json")
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000279 defaultVersion := android.DefaultUpdatableModuleVersion
Sam Delmerico6d65a0f2023-06-05 15:55:57 -0400280 if a.properties.Variant_version != nil {
281 defaultVersionInt, err := strconv.Atoi(defaultVersion)
282 if err != nil {
283 ctx.ModuleErrorf("expected DefaultUpdatableModuleVersion to be an int, but got %s", defaultVersion)
284 }
285 if defaultVersionInt%10 != 0 {
286 ctx.ModuleErrorf("expected DefaultUpdatableModuleVersion to end in a zero, but got %s", defaultVersion)
287 }
288 variantVersion := []rune(*a.properties.Variant_version)
289 if len(variantVersion) != 1 || variantVersion[0] < '0' || variantVersion[0] > '9' {
290 ctx.PropertyErrorf("variant_version", "expected an integer between 0-9; got %s", *a.properties.Variant_version)
291 }
292 defaultVersionRunes := []rune(defaultVersion)
293 defaultVersionRunes[len(defaultVersion)-1] = []rune(variantVersion)[0]
294 defaultVersion = string(defaultVersionRunes)
295 }
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000296 if override := ctx.Config().Getenv("OVERRIDE_APEX_MANIFEST_DEFAULT_VERSION"); override != "" {
297 defaultVersion = override
298 }
Jiyong Park09d77522019-11-18 11:16:27 +0900299 ctx.Build(pctx, android.BuildParams{
300 Rule: apexManifestRule,
Alexei Nicoara0a389202022-07-12 14:35:39 +0100301 Input: src,
Jooyung Han214bf372019-11-12 13:03:50 +0900302 Output: manifestJsonFullOut,
Jiyong Park09d77522019-11-18 11:16:27 +0900303 Args: map[string]string{
304 "provideNativeLibs": strings.Join(provideNativeLibs, " "),
305 "requireNativeLibs": strings.Join(requireNativeLibs, " "),
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000306 "default_version": defaultVersion,
Jiyong Park09d77522019-11-18 11:16:27 +0900307 "opt": strings.Join(optCommands, " "),
308 },
309 })
310
Jiyong Parkb81b9902020-11-24 19:51:18 +0900311 // b/143654022 Q apexd can't understand newly added keys in apex_manifest.json prepare
312 // stripped-down version so that APEX modules built from R+ can be installed to Q
Dan Albertc8060532020-07-22 22:32:17 -0700313 minSdkVersion := a.minSdkVersion(ctx)
314 if minSdkVersion.EqualTo(android.SdkVersion_Android10) {
Jooyung Han214bf372019-11-12 13:03:50 +0900315 a.manifestJsonOut = android.PathForModuleOut(ctx, "apex_manifest.json")
316 ctx.Build(pctx, android.BuildParams{
317 Rule: stripApexManifestRule,
318 Input: manifestJsonFullOut,
319 Output: a.manifestJsonOut,
320 })
321 }
Jiyong Park09d77522019-11-18 11:16:27 +0900322
Jiyong Parkb81b9902020-11-24 19:51:18 +0900323 // From R+, protobuf binary format (.pb) is the standard format for apex_manifest
Jiyong Park09d77522019-11-18 11:16:27 +0900324 a.manifestPbOut = android.PathForModuleOut(ctx, "apex_manifest.pb")
325 ctx.Build(pctx, android.BuildParams{
326 Rule: pbApexManifestRule,
Jooyung Han214bf372019-11-12 13:03:50 +0900327 Input: manifestJsonFullOut,
Jiyong Park09d77522019-11-18 11:16:27 +0900328 Output: a.manifestPbOut,
329 })
330}
331
Jiyong Parkb81b9902020-11-24 19:51:18 +0900332// buildFileContexts create build rules to append an entry for apex_manifest.pb to the file_contexts
333// file for this APEX which is either from /systme/sepolicy/apex/<apexname>-file_contexts or from
334// 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 +0900335// labeled as system_file or vendor_apex_metadata_file.
Jiyong Parkb81b9902020-11-24 19:51:18 +0900336func (a *apexBundle) buildFileContexts(ctx android.ModuleContext) android.OutputPath {
Jooyung Han580eb4f2020-06-24 19:33:06 +0900337 var fileContexts android.Path
Liz Kammer37997c42021-09-14 17:53:38 -0400338 var fileContextsDir string
Jooyung Han580eb4f2020-06-24 19:33:06 +0900339 if a.properties.File_contexts == nil {
340 fileContexts = android.PathForSource(ctx, "system/sepolicy/apex", ctx.ModuleName()+"-file_contexts")
341 } else {
Liz Kammer37997c42021-09-14 17:53:38 -0400342 if m, t := android.SrcIsModuleWithTag(*a.properties.File_contexts); m != "" {
343 otherModule := android.GetModuleFromPathDep(ctx, m, t)
344 fileContextsDir = ctx.OtherModuleDir(otherModule)
345 }
Jooyung Han580eb4f2020-06-24 19:33:06 +0900346 fileContexts = android.PathForModuleSrc(ctx, *a.properties.File_contexts)
347 }
Liz Kammer37997c42021-09-14 17:53:38 -0400348 if fileContextsDir == "" {
349 fileContextsDir = filepath.Dir(fileContexts.String())
350 }
351 fileContextsDir += string(filepath.Separator)
352
Jooyung Han580eb4f2020-06-24 19:33:06 +0900353 if a.Platform() {
Liz Kammer37997c42021-09-14 17:53:38 -0400354 if !strings.HasPrefix(fileContextsDir, "system/sepolicy/") {
355 ctx.PropertyErrorf("file_contexts", "should be under system/sepolicy, but found in %q", fileContextsDir)
Jooyung Han580eb4f2020-06-24 19:33:06 +0900356 }
357 }
358 if !android.ExistentPathForSource(ctx, fileContexts.String()).Valid() {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900359 ctx.PropertyErrorf("file_contexts", "cannot find file_contexts file: %q", fileContexts.String())
Jooyung Han580eb4f2020-06-24 19:33:06 +0900360 }
361
Jooyung Hanaf730952023-02-28 14:13:38 +0900362 useFileContextsAsIs := proptools.Bool(a.properties.Use_file_contexts_as_is)
363
Jooyung Han580eb4f2020-06-24 19:33:06 +0900364 output := android.PathForModuleOut(ctx, "file_contexts")
Colin Crossf1a035e2020-11-16 17:32:30 -0800365 rule := android.NewRuleBuilder(pctx, ctx)
Jooyung Han7f146c02020-09-23 19:15:55 +0900366
Jooyung Hanbe953902023-05-31 16:42:16 +0900367 forceLabel := "u:object_r:system_file:s0"
368 if a.SocSpecific() && !a.vndkApex {
369 // APEX on /vendor should label ./ and ./apex_manifest.pb as vendor_apex_metadata_file.
370 // The reason why we skip VNDK APEX is that aosp_{pixel device} targets install VNDK APEX on /vendor
371 // even though VNDK APEX is supposed to be installed on /system. (See com.android.vndk.current.on_vendor)
372 forceLabel = "u:object_r:vendor_apex_metadata_file:s0"
373 }
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900374 // remove old file
375 rule.Command().Text("rm").FlagWithOutput("-f ", output)
376 // copy file_contexts
377 rule.Command().Text("cat").Input(fileContexts).Text(">>").Output(output)
378 // new line
379 rule.Command().Text("echo").Text(">>").Output(output)
380 if !useFileContextsAsIs {
381 // force-label /apex_manifest.pb and /
382 rule.Command().Text("echo").Text("/apex_manifest\\\\.pb").Text(forceLabel).Text(">>").Output(output)
383 rule.Command().Text("echo").Text("/").Text(forceLabel).Text(">>").Output(output)
Jooyung Han7f146c02020-09-23 19:15:55 +0900384 }
385
Colin Crossf1a035e2020-11-16 17:32:30 -0800386 rule.Build("file_contexts."+a.Name(), "Generate file_contexts")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900387 return output.OutputPath
Jooyung Han580eb4f2020-06-24 19:33:06 +0900388}
389
Jiyong Parkb81b9902020-11-24 19:51:18 +0900390// buildInstalledFilesFile creates a build rule for the installed-files.txt file where the list of
391// files included in this APEX is shown. The text file is dist'ed so that people can see what's
392// included in the APEX without actually downloading and extracting it.
Jiyong Park3a1602e2020-01-14 14:39:19 +0900393func (a *apexBundle) buildInstalledFilesFile(ctx android.ModuleContext, builtApex android.Path, imageDir android.Path) android.OutputPath {
394 output := android.PathForModuleOut(ctx, "installed-files.txt")
Colin Crossf1a035e2020-11-16 17:32:30 -0800395 rule := android.NewRuleBuilder(pctx, ctx)
Jiyong Park3a1602e2020-01-14 14:39:19 +0900396 rule.Command().
397 Implicit(builtApex).
398 Text("(cd " + imageDir.String() + " ; ").
Jiyong Parkbd63a102020-02-08 12:40:05 +0900399 Text("find . \\( -type f -o -type l \\) -printf \"%s %p\\n\") ").
Jiyong Park3a1602e2020-01-14 14:39:19 +0900400 Text(" | sort -nr > ").
401 Output(output)
Colin Crossf1a035e2020-11-16 17:32:30 -0800402 rule.Build("installed-files."+a.Name(), "Installed files")
Jiyong Park3a1602e2020-01-14 14:39:19 +0900403 return output.OutputPath
404}
405
Jiyong Parkb81b9902020-11-24 19:51:18 +0900406// buildBundleConfig creates a build rule for the bundle config file that will control the bundle
407// creation process.
Jiyong Parkbd159612020-02-28 15:22:21 +0900408func (a *apexBundle) buildBundleConfig(ctx android.ModuleContext) android.OutputPath {
409 output := android.PathForModuleOut(ctx, "bundle_config.json")
410
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900411 type ApkConfig struct {
412 Package_name string `json:"package_name"`
413 Apk_path string `json:"path"`
414 }
Jiyong Parkbd159612020-02-28 15:22:21 +0900415 config := struct {
416 Compression struct {
417 Uncompressed_glob []string `json:"uncompressed_glob"`
418 } `json:"compression"`
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900419 Apex_config struct {
420 Apex_embedded_apk_config []ApkConfig `json:"apex_embedded_apk_config,omitempty"`
421 } `json:"apex_config,omitempty"`
Jiyong Parkbd159612020-02-28 15:22:21 +0900422 }{}
423
424 config.Compression.Uncompressed_glob = []string{
425 "apex_payload.img",
426 "apex_manifest.*",
427 }
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900428
Jiyong Parkb81b9902020-11-24 19:51:18 +0900429 // Collect the manifest names and paths of android apps if their manifest names are
430 // overridden.
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900431 for _, fi := range a.filesInfo {
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700432 if fi.class != app && fi.class != appSet {
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900433 continue
434 }
435 packageName := fi.overriddenPackageName
436 if packageName != "" {
437 config.Apex_config.Apex_embedded_apk_config = append(
438 config.Apex_config.Apex_embedded_apk_config,
439 ApkConfig{
440 Package_name: packageName,
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900441 Apk_path: fi.path(),
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900442 })
443 }
444 }
445
Jiyong Parkbd159612020-02-28 15:22:21 +0900446 j, err := json.Marshal(config)
447 if err != nil {
448 panic(fmt.Errorf("error while marshalling to %q: %#v", output, err))
449 }
450
Colin Crosscf371cc2020-11-13 11:48:42 -0800451 android.WriteFileRule(ctx, output, string(j))
Jiyong Parkbd159612020-02-28 15:22:21 +0900452
453 return output.OutputPath
454}
455
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000456func markManifestTestOnly(ctx android.ModuleContext, androidManifestFile android.Path) android.Path {
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000457 return java.ManifestFixer(ctx, androidManifestFile, java.ManifestFixerParams{
458 TestOnly: true,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000459 })
460}
461
Jooyung Han90934ac2023-09-22 14:52:06 +0900462func isVintfFragment(fi apexFile) bool {
463 isVintfFragment, _ := path.Match("etc/vintf/*.xml", fi.path())
464 return isVintfFragment
465}
466
467func runAssembleVintf(ctx android.ModuleContext, vintfFragment android.Path) android.Path {
468 processed := android.PathForModuleOut(ctx, "vintf", vintfFragment.Base())
469 ctx.Build(pctx, android.BuildParams{
470 Rule: assembleVintfRule,
471 Input: vintfFragment,
472 Output: processed,
473 Description: "run assemble_vintf for VINTF in APEX",
474 })
475 return processed
476}
477
Jooyung Haneec1b3f2023-06-20 16:25:59 +0900478// buildApex creates build rules to build an APEX using apexer.
479func (a *apexBundle) buildApex(ctx android.ModuleContext) {
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900480 suffix := imageApexSuffix
Jooyung Han63dff462023-02-09 00:11:27 +0000481 apexName := a.BaseModuleName()
Jiyong Park09d77522019-11-18 11:16:27 +0900482
Jiyong Parkb81b9902020-11-24 19:51:18 +0900483 ////////////////////////////////////////////////////////////////////////////////////////////
484 // Step 1: copy built files to appropriate directories under the image directory
485
486 imageDir := android.PathForModuleOut(ctx, "image"+suffix)
487
Colin Cross02730b92022-04-18 17:42:27 -0700488 installSymbolFiles := (!ctx.Config().KatiEnabled() || a.ExportedToMake()) && a.installable()
Colin Cross6340ea52021-11-04 12:01:18 -0700489
Colin Cross4acaea92021-12-10 23:05:02 +0000490 // set of dependency module:location mappings
491 installMapSet := make(map[string]bool)
Colin Cross6340ea52021-11-04 12:01:18 -0700492
Jiyong Parkb81b9902020-11-24 19:51:18 +0900493 // TODO(jiyong): use the RuleBuilder
Jiyong Park7cd10e32020-01-14 09:22:18 +0900494 var copyCommands []string
Jiyong Parkb81b9902020-11-24 19:51:18 +0900495 var implicitInputs []android.Path
Jooyung Han63dff462023-02-09 00:11:27 +0000496 apexDir := android.PathForModuleInPartitionInstall(ctx, "apex", apexName)
Jiyong Park7cd10e32020-01-14 09:22:18 +0900497 for _, fi := range a.filesInfo {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900498 destPath := imageDir.Join(ctx, fi.path()).String()
Jiyong Parkb81b9902020-11-24 19:51:18 +0900499 // Prepare the destination path
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700500 destPathDir := filepath.Dir(destPath)
501 if fi.class == appSet {
502 copyCommands = append(copyCommands, "rm -rf "+destPathDir)
503 }
504 copyCommands = append(copyCommands, "mkdir -p "+destPathDir)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900505
Colin Cross4acaea92021-12-10 23:05:02 +0000506 installMapPath := fi.builtFile
507
Jiyong Parkb81b9902020-11-24 19:51:18 +0900508 // Copy the built file to the directory. But if the symlink optimization is turned
509 // on, place a symlink to the corresponding file in /system partition instead.
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900510 if a.linkToSystemLib && fi.transitiveDep && fi.availableToPlatform() {
Jiyong Parkce243632023-02-17 18:22:25 +0900511 pathOnDevice := filepath.Join("/", fi.partition, fi.path())
Jiyong Park7cd10e32020-01-14 09:22:18 +0900512 copyCommands = append(copyCommands, "ln -sfn "+pathOnDevice+" "+destPath)
513 } else {
Jiyong Park4169a252022-09-29 21:30:25 +0900514 // Copy the file into APEX
Jooyung Han90934ac2023-09-22 14:52:06 +0900515 if !a.testApex && isVintfFragment(fi) {
516 // copy the output of assemble_vintf instead of the original
517 vintfFragment := runAssembleVintf(ctx, fi.builtFile)
518 copyCommands = append(copyCommands, "cp -f "+vintfFragment.String()+" "+destPath)
519 implicitInputs = append(implicitInputs, vintfFragment)
520 } else {
521 copyCommands = append(copyCommands, "cp -f "+fi.builtFile.String()+" "+destPath)
522 implicitInputs = append(implicitInputs, fi.builtFile)
523 }
Jiyong Park4169a252022-09-29 21:30:25 +0900524
Colin Cross4acaea92021-12-10 23:05:02 +0000525 var installedPath android.InstallPath
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700526 if fi.class == appSet {
Jiyong Park4169a252022-09-29 21:30:25 +0900527 // In case of AppSet, we need to copy additional APKs as well. They
528 // are zipped. So we need to unzip them.
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700529 copyCommands = append(copyCommands,
Colin Crossffbcd1d2021-11-12 12:19:42 -0800530 fmt.Sprintf("unzip -qDD -d %s %s", destPathDir,
531 fi.module.(*java.AndroidAppSet).PackedAdditionalOutputs().String()))
Colin Cross6340ea52021-11-04 12:01:18 -0700532 if installSymbolFiles {
Jooyung Han63dff462023-02-09 00:11:27 +0000533 installedPath = ctx.InstallFileWithExtraFilesZip(apexDir.Join(ctx, fi.installDir),
Colin Cross6340ea52021-11-04 12:01:18 -0700534 fi.stem(), fi.builtFile, fi.module.(*java.AndroidAppSet).PackedAdditionalOutputs())
535 }
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700536 } else {
Colin Cross6340ea52021-11-04 12:01:18 -0700537 if installSymbolFiles {
Jooyung Han63dff462023-02-09 00:11:27 +0000538 installedPath = ctx.InstallFile(apexDir.Join(ctx, fi.installDir), fi.stem(), fi.builtFile)
Colin Cross6340ea52021-11-04 12:01:18 -0700539 }
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700540 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900541
Colin Cross4acaea92021-12-10 23:05:02 +0000542 // Create additional symlinks pointing the file inside the APEX (if any). Note that
543 // this is independent from the symlink optimization.
544 for _, symlinkPath := range fi.symlinkPaths() {
545 symlinkDest := imageDir.Join(ctx, symlinkPath).String()
546 copyCommands = append(copyCommands, "ln -sfn "+filepath.Base(destPath)+" "+symlinkDest)
547 if installSymbolFiles {
Inseob Kim5bedfee2023-04-20 10:16:14 +0900548 ctx.InstallSymlink(apexDir.Join(ctx, filepath.Dir(symlinkPath)), filepath.Base(symlinkPath), installedPath)
Colin Cross4acaea92021-12-10 23:05:02 +0000549 }
Colin Cross6340ea52021-11-04 12:01:18 -0700550 }
Colin Cross4acaea92021-12-10 23:05:02 +0000551
552 installMapPath = installedPath
Jiyong Park7cd10e32020-01-14 09:22:18 +0900553 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900554
555 // Copy the test files (if any)
Liz Kammer1c14a212020-05-12 15:26:55 -0700556 for _, d := range fi.dataPaths {
557 // TODO(eakammer): This is now the third repetition of ~this logic for test paths, refactoring should be possible
Chris Parsons216e10a2020-07-09 17:12:52 -0400558 relPath := d.SrcPath.Rel()
559 dataPath := d.SrcPath.String()
Liz Kammer1c14a212020-05-12 15:26:55 -0700560 if !strings.HasSuffix(dataPath, relPath) {
561 panic(fmt.Errorf("path %q does not end with %q", dataPath, relPath))
562 }
563
Jiyong Parkb81b9902020-11-24 19:51:18 +0900564 dataDest := imageDir.Join(ctx, fi.apexRelativePath(relPath), d.RelativeInstallPath).String()
Liz Kammer1c14a212020-05-12 15:26:55 -0700565
Chris Parsons216e10a2020-07-09 17:12:52 -0400566 copyCommands = append(copyCommands, "cp -f "+d.SrcPath.String()+" "+dataDest)
567 implicitInputs = append(implicitInputs, d.SrcPath)
Liz Kammer1c14a212020-05-12 15:26:55 -0700568 }
Colin Cross4acaea92021-12-10 23:05:02 +0000569
570 installMapSet[installMapPath.String()+":"+fi.installDir+"/"+fi.builtFile.Base()] = true
Jiyong Park09d77522019-11-18 11:16:27 +0900571 }
Jooyung Han214bf372019-11-12 13:03:50 +0900572 implicitInputs = append(implicitInputs, a.manifestPbOut)
Jiyong Park09d77522019-11-18 11:16:27 +0900573
Colin Cross4acaea92021-12-10 23:05:02 +0000574 if len(installMapSet) > 0 {
575 var installs []string
Cole Faust18994c72023-02-28 16:02:16 -0800576 installs = append(installs, android.SortedKeys(installMapSet)...)
Colin Cross4acaea92021-12-10 23:05:02 +0000577 a.SetLicenseInstallMap(installs)
578 }
579
Jiyong Parkb81b9902020-11-24 19:51:18 +0900580 ////////////////////////////////////////////////////////////////////////////////////////////
581 // Step 1.a: Write the list of files in this APEX to a txt file and compare it against
582 // the allowed list given via the allowed_files property. Build fails when the two lists
583 // differ.
584 //
585 // TODO(jiyong): consider removing this. Nobody other than com.android.apex.cts.shim.* seems
586 // to be using this at this moment. Furthermore, this looks very similar to what
587 // buildInstalledFilesFile does. At least, move this to somewhere else so that this doesn't
588 // hurt readability.
Jooyung Han938b5932020-06-20 12:47:47 +0900589 if a.overridableProperties.Allowed_files != nil {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900590 // Build content.txt
Cole Fausta7347492022-12-16 10:56:24 -0800591 var contentLines []string
Jiyong Parkb81b9902020-11-24 19:51:18 +0900592 imageContentFile := android.PathForModuleOut(ctx, "content.txt")
Cole Fausta7347492022-12-16 10:56:24 -0800593 contentLines = append(contentLines, "./apex_manifest.pb")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900594 minSdkVersion := a.minSdkVersion(ctx)
595 if minSdkVersion.EqualTo(android.SdkVersion_Android10) {
Cole Fausta7347492022-12-16 10:56:24 -0800596 contentLines = append(contentLines, "./apex_manifest.json")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900597 }
598 for _, fi := range a.filesInfo {
Cole Fausta7347492022-12-16 10:56:24 -0800599 contentLines = append(contentLines, "./"+fi.path())
Jiyong Parkb81b9902020-11-24 19:51:18 +0900600 }
Cole Fausta7347492022-12-16 10:56:24 -0800601 sort.Strings(contentLines)
602 android.WriteFileRule(ctx, imageContentFile, strings.Join(contentLines, "\n"))
Jiyong Park09d77522019-11-18 11:16:27 +0900603 implicitInputs = append(implicitInputs, imageContentFile)
Jiyong Park09d77522019-11-18 11:16:27 +0900604
Jiyong Parkb81b9902020-11-24 19:51:18 +0900605 // Compare content.txt against allowed_files.
606 allowedFilesFile := android.PathForModuleSrc(ctx, proptools.String(a.overridableProperties.Allowed_files))
Jaewoong Jung1670ca02019-11-22 14:50:42 -0800607 phonyOutput := android.PathForModuleOut(ctx, a.Name()+"-diff-phony-output")
Jiyong Park09d77522019-11-18 11:16:27 +0900608 ctx.Build(pctx, android.BuildParams{
609 Rule: diffApexContentRule,
610 Implicits: implicitInputs,
611 Output: phonyOutput,
612 Description: "diff apex image content",
613 Args: map[string]string{
Colin Cross440e0d02020-06-11 11:32:11 -0700614 "allowed_files_file": allowedFilesFile.String(),
615 "image_content_file": imageContentFile.String(),
616 "apex_module_name": a.Name(),
Jiyong Park09d77522019-11-18 11:16:27 +0900617 },
618 })
Jiyong Park09d77522019-11-18 11:16:27 +0900619 implicitInputs = append(implicitInputs, phonyOutput)
620 }
621
Jiyong Parkb81b9902020-11-24 19:51:18 +0900622 unsignedOutputFile := android.PathForModuleOut(ctx, a.Name()+suffix+".unsigned")
Colin Cross790ef352021-10-25 19:15:55 -0700623 outHostBinDir := ctx.Config().HostToolPath(ctx, "").String()
Jiyong Park09d77522019-11-18 11:16:27 +0900624 prebuiltSdkToolsBinDir := filepath.Join("prebuilts", "sdk", "tools", runtime.GOOS, "bin")
625
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900626 ////////////////////////////////////////////////////////////////////////////////////
627 // Step 2: create canned_fs_config which encodes filemode,uid,gid of each files
628 // in this APEX. The file will be used by apexer in later steps.
629 cannedFsConfig := a.buildCannedFsConfig(ctx)
630 implicitInputs = append(implicitInputs, cannedFsConfig)
Jiyong Park1b0893e2021-12-13 23:40:17 +0900631
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900632 ////////////////////////////////////////////////////////////////////////////////////
633 // Step 3: Prepare option flags for apexer and invoke it to create an unsigned APEX.
634 // TODO(jiyong): use the RuleBuilder
635 optFlags := []string{}
Jiyong Park09d77522019-11-18 11:16:27 +0900636
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900637 fileContexts := a.buildFileContexts(ctx)
638 implicitInputs = append(implicitInputs, fileContexts)
Jiyong Park09d77522019-11-18 11:16:27 +0900639
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900640 implicitInputs = append(implicitInputs, a.privateKeyFile, a.publicKeyFile)
641 optFlags = append(optFlags, "--pubkey "+a.publicKeyFile.String())
Jiyong Parkb81b9902020-11-24 19:51:18 +0900642
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900643 manifestPackageName := a.getOverrideManifestPackageName(ctx)
644 if manifestPackageName != "" {
645 optFlags = append(optFlags, "--override_apk_package_name "+manifestPackageName)
646 }
Jiyong Park09d77522019-11-18 11:16:27 +0900647
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900648 if a.properties.AndroidManifest != nil {
649 androidManifestFile := android.PathForModuleSrc(ctx, proptools.String(a.properties.AndroidManifest))
650
651 if a.testApex {
652 androidManifestFile = markManifestTestOnly(ctx, androidManifestFile)
Jiyong Park09d77522019-11-18 11:16:27 +0900653 }
654
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900655 implicitInputs = append(implicitInputs, androidManifestFile)
656 optFlags = append(optFlags, "--android_manifest "+androidManifestFile.String())
657 } else if a.testApex {
658 optFlags = append(optFlags, "--test_only")
659 }
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000660
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900661 // Determine target/min sdk version from the context
662 // TODO(jiyong): make this as a function
663 moduleMinSdkVersion := a.minSdkVersion(ctx)
664 minSdkVersion := moduleMinSdkVersion.String()
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000665
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900666 // bundletool doesn't understand what "current" is. We need to transform it to
667 // codename
668 if moduleMinSdkVersion.IsCurrent() || moduleMinSdkVersion.IsNone() {
669 minSdkVersion = ctx.Config().DefaultAppTargetSdk(ctx).String()
Nikita Ioffe5d600c92020-02-20 00:43:27 +0000670
Nikita Ioffe1f4f3452020-03-02 16:58:11 +0000671 if java.UseApiFingerprint(ctx) {
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900672 minSdkVersion = ctx.Config().PlatformSdkCodename() + fmt.Sprintf(".$$(cat %s)", java.ApiFingerprintPath(ctx).String())
Baligh Uddinf6201372020-01-24 23:15:44 +0000673 implicitInputs = append(implicitInputs, java.ApiFingerprintPath(ctx))
674 }
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900675 }
676 // apex module doesn't have a concept of target_sdk_version, hence for the time
677 // being targetSdkVersion == default targetSdkVersion of the branch.
678 targetSdkVersion := strconv.Itoa(ctx.Config().DefaultAppTargetSdk(ctx).FinalOrFutureInt())
Jiyong Park09d77522019-11-18 11:16:27 +0900679
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900680 if java.UseApiFingerprint(ctx) {
681 targetSdkVersion = ctx.Config().PlatformSdkCodename() + fmt.Sprintf(".$$(cat %s)", java.ApiFingerprintPath(ctx).String())
682 implicitInputs = append(implicitInputs, java.ApiFingerprintPath(ctx))
683 }
684 optFlags = append(optFlags, "--target_sdk_version "+targetSdkVersion)
685 optFlags = append(optFlags, "--min_sdk_version "+minSdkVersion)
Baligh Uddin004d7172020-02-19 21:29:28 -0800686
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900687 if a.overridableProperties.Logging_parent != "" {
688 optFlags = append(optFlags, "--logging_parent ", a.overridableProperties.Logging_parent)
689 }
Jiyong Park09d77522019-11-18 11:16:27 +0900690
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900691 // Create a NOTICE file, and embed it as an asset file in the APEX.
692 htmlGzNotice := android.PathForModuleOut(ctx, "NOTICE.html.gz")
693 android.BuildNoticeHtmlOutputFromLicenseMetadata(
694 ctx, htmlGzNotice, "", "",
695 []string{
696 android.PathForModuleInstall(ctx).String() + "/",
697 android.PathForModuleInPartitionInstall(ctx, "apex").String() + "/",
Jiyong Park09d77522019-11-18 11:16:27 +0900698 })
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900699 noticeAssetPath := android.PathForModuleOut(ctx, "NOTICE", "NOTICE.html.gz")
700 builder := android.NewRuleBuilder(pctx, ctx)
701 builder.Command().Text("cp").
702 Input(htmlGzNotice).
703 Output(noticeAssetPath)
704 builder.Build("notice_dir", "Building notice dir")
705 implicitInputs = append(implicitInputs, noticeAssetPath)
706 optFlags = append(optFlags, "--assets_dir "+filepath.Dir(noticeAssetPath.String()))
Jiyong Park09d77522019-11-18 11:16:27 +0900707
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900708 // Apexes which are supposed to be installed in builtin dirs(/system, etc)
709 // don't need hashtree for activation. Therefore, by removing hashtree from
710 // apex bundle (filesystem image in it, to be specific), we can save storage.
711 needHashTree := moduleMinSdkVersion.LessThanOrEqualTo(android.SdkVersion_Android10) ||
712 a.shouldGenerateHashtree()
713 if ctx.Config().ApexCompressionEnabled() && a.isCompressable() {
714 needHashTree = true
715 }
716 if !needHashTree {
717 optFlags = append(optFlags, "--no_hashtree")
718 }
sophiezc80a2b32020-11-12 16:39:19 +0000719
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900720 if a.testOnlyShouldSkipPayloadSign() {
721 optFlags = append(optFlags, "--unsigned_payload")
722 }
723
724 if moduleMinSdkVersion == android.SdkVersion_Android10 {
725 implicitInputs = append(implicitInputs, a.manifestJsonOut)
726 optFlags = append(optFlags, "--manifest_json "+a.manifestJsonOut.String())
727 }
728
729 optFlags = append(optFlags, "--payload_fs_type "+a.payloadFsType.string())
730
731 if a.dynamic_common_lib_apex() {
sophiezc80a2b32020-11-12 16:39:19 +0000732 ctx.Build(pctx, android.BuildParams{
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900733 Rule: DCLAApexRule,
Jiyong Park09d77522019-11-18 11:16:27 +0900734 Implicits: implicitInputs,
735 Output: unsignedOutputFile,
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900736 Description: "apex",
Jiyong Park09d77522019-11-18 11:16:27 +0900737 Args: map[string]string{
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900738 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
739 "image_dir": imageDir.String(),
740 "copy_commands": strings.Join(copyCommands, " && "),
741 "manifest": a.manifestPbOut.String(),
742 "file_contexts": fileContexts.String(),
743 "canned_fs_config": cannedFsConfig.String(),
744 "key": a.privateKeyFile.String(),
745 "opt_flags": strings.Join(optFlags, " "),
746 },
747 })
748 } else if ctx.Config().ApexTrimEnabled() && len(a.libs_to_trim(ctx)) > 0 {
749 ctx.Build(pctx, android.BuildParams{
750 Rule: TrimmedApexRule,
751 Implicits: implicitInputs,
752 Output: unsignedOutputFile,
753 Description: "apex",
754 Args: map[string]string{
755 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
756 "image_dir": imageDir.String(),
757 "copy_commands": strings.Join(copyCommands, " && "),
758 "manifest": a.manifestPbOut.String(),
759 "file_contexts": fileContexts.String(),
760 "canned_fs_config": cannedFsConfig.String(),
761 "key": a.privateKeyFile.String(),
762 "opt_flags": strings.Join(optFlags, " "),
763 "libs_to_trim": strings.Join(a.libs_to_trim(ctx), ","),
764 },
765 })
766 } else {
767 ctx.Build(pctx, android.BuildParams{
768 Rule: apexRule,
769 Implicits: implicitInputs,
770 Output: unsignedOutputFile,
771 Description: "apex",
772 Args: map[string]string{
773 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
774 "image_dir": imageDir.String(),
775 "copy_commands": strings.Join(copyCommands, " && "),
776 "manifest": a.manifestPbOut.String(),
777 "file_contexts": fileContexts.String(),
778 "canned_fs_config": cannedFsConfig.String(),
779 "key": a.privateKeyFile.String(),
780 "opt_flags": strings.Join(optFlags, " "),
Jiyong Park09d77522019-11-18 11:16:27 +0900781 },
782 })
783 }
784
Jooyung Han06a8a1c2023-08-23 11:11:43 +0900785 // TODO(jiyong): make the two rules below as separate functions
786 apexProtoFile := android.PathForModuleOut(ctx, a.Name()+".pb"+suffix)
787 bundleModuleFile := android.PathForModuleOut(ctx, a.Name()+suffix+"-base.zip")
788 a.bundleModuleFile = bundleModuleFile
789
790 ctx.Build(pctx, android.BuildParams{
791 Rule: apexProtoConvertRule,
792 Input: unsignedOutputFile,
793 Output: apexProtoFile,
794 Description: "apex proto convert",
795 })
796
797 implicitInputs = append(implicitInputs, unsignedOutputFile)
798
799 // Run coverage analysis
800 apisUsedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_using.txt")
801 ctx.Build(pctx, android.BuildParams{
802 Rule: generateAPIsUsedbyApexRule,
803 Implicits: implicitInputs,
804 Description: "coverage",
805 Output: apisUsedbyOutputFile,
806 Args: map[string]string{
807 "image_dir": imageDir.String(),
808 "readelf": "${config.ClangBin}/llvm-readelf",
809 },
810 })
811 a.nativeApisUsedByModuleFile = apisUsedbyOutputFile
812
813 var nativeLibNames []string
814 for _, f := range a.filesInfo {
815 if f.class == nativeSharedLib {
816 nativeLibNames = append(nativeLibNames, f.stem())
817 }
818 }
819 apisBackedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_backing.txt")
820 rb := android.NewRuleBuilder(pctx, ctx)
821 rb.Command().
822 Tool(android.PathForSource(ctx, "build/soong/scripts/gen_ndk_backedby_apex.sh")).
823 Output(apisBackedbyOutputFile).
824 Flags(nativeLibNames)
825 rb.Build("ndk_backedby_list", "Generate API libraries backed by Apex")
826 a.nativeApisBackedByModuleFile = apisBackedbyOutputFile
827
828 var javaLibOrApkPath []android.Path
829 for _, f := range a.filesInfo {
830 if f.class == javaSharedLib || f.class == app {
831 javaLibOrApkPath = append(javaLibOrApkPath, f.builtFile)
832 }
833 }
834 javaApiUsedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_using.xml")
835 javaUsedByRule := android.NewRuleBuilder(pctx, ctx)
836 javaUsedByRule.Command().
837 Tool(android.PathForSource(ctx, "build/soong/scripts/gen_java_usedby_apex.sh")).
838 BuiltTool("dexdeps").
839 Output(javaApiUsedbyOutputFile).
840 Inputs(javaLibOrApkPath)
841 javaUsedByRule.Build("java_usedby_list", "Generate Java APIs used by Apex")
842 a.javaApisUsedByModuleFile = javaApiUsedbyOutputFile
843
844 bundleConfig := a.buildBundleConfig(ctx)
845
846 var abis []string
847 for _, target := range ctx.MultiTargets() {
848 if len(target.Arch.Abi) > 0 {
849 abis = append(abis, target.Arch.Abi[0])
850 }
851 }
852
853 abis = android.FirstUniqueStrings(abis)
854
855 ctx.Build(pctx, android.BuildParams{
856 Rule: apexBundleRule,
857 Input: apexProtoFile,
858 Implicit: bundleConfig,
859 Output: a.bundleModuleFile,
860 Description: "apex bundle module",
861 Args: map[string]string{
862 "abi": strings.Join(abis, "."),
863 "config": bundleConfig.String(),
864 },
865 })
866
Jiyong Parkb81b9902020-11-24 19:51:18 +0900867 ////////////////////////////////////////////////////////////////////////////////////
868 // Step 4: Sign the APEX using signapk
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000869 signedOutputFile := android.PathForModuleOut(ctx, a.Name()+suffix)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900870
871 pem, key := a.getCertificateAndPrivateKey(ctx)
Kousik Kumar309b1c02020-05-28 06:13:33 -0700872 rule := java.Signapk
873 args := map[string]string{
Jiyong Parkb81b9902020-11-24 19:51:18 +0900874 "certificates": pem.String() + " " + key.String(),
Jooyung Han5d00f502021-07-11 07:26:22 +0900875 "flags": "-a 4096 --align-file-size", //alignment
Kousik Kumar309b1c02020-05-28 06:13:33 -0700876 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900877 implicits := android.Paths{pem, key}
Ramy Medhat16f23a42020-09-03 01:29:49 -0400878 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_SIGNAPK") {
Kousik Kumar309b1c02020-05-28 06:13:33 -0700879 rule = java.SignapkRE
880 args["implicits"] = strings.Join(implicits.Strings(), ",")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000881 args["outCommaList"] = signedOutputFile.String()
Kousik Kumar309b1c02020-05-28 06:13:33 -0700882 }
Jooyung Han01f5d652023-04-05 16:29:26 +0900883 var validations android.Paths
Jooyung Han4bc10262023-09-08 11:51:45 +0900884 validations = append(validations, runApexLinkerconfigValidation(ctx, unsignedOutputFile.OutputPath, imageDir.OutputPath))
Jooyung Hanb7cdbba2023-04-26 14:42:50 +0900885 // TODO(b/279688635) deapexer supports [ext4]
886 if suffix == imageApexSuffix && ext4 == a.payloadFsType {
Jooyung Han01f5d652023-04-05 16:29:26 +0900887 validations = append(validations, runApexSepolicyTests(ctx, unsignedOutputFile.OutputPath))
888 }
Jiyong Park09d77522019-11-18 11:16:27 +0900889 ctx.Build(pctx, android.BuildParams{
Kousik Kumar309b1c02020-05-28 06:13:33 -0700890 Rule: rule,
Jiyong Park09d77522019-11-18 11:16:27 +0900891 Description: "signapk",
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000892 Output: signedOutputFile,
Jiyong Park09d77522019-11-18 11:16:27 +0900893 Input: unsignedOutputFile,
Kousik Kumar309b1c02020-05-28 06:13:33 -0700894 Implicits: implicits,
895 Args: args,
Jooyung Han01f5d652023-04-05 16:29:26 +0900896 Validations: validations,
Jiyong Park09d77522019-11-18 11:16:27 +0900897 })
Jooyung Hana6d36672022-02-24 13:58:07 +0900898 if suffix == imageApexSuffix {
899 a.outputApexFile = signedOutputFile
900 }
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000901 a.outputFile = signedOutputFile
902
Mohammad Samiul Islama8008f92020-12-22 10:47:50 +0000903 if ctx.ModuleDir() != "system/apex/apexd/apexd_testdata" && a.testOnlyShouldForceCompression() {
904 ctx.PropertyErrorf("test_only_force_compression", "not available")
905 return
906 }
Nikita Ioffebc035882021-04-14 21:35:24 +0100907
Sasha Smundakfe9a5b82022-07-27 14:51:45 -0700908 installSuffix := suffix
909 a.setCompression(ctx)
910 if a.isCompressed {
Samiul Islam7c02e262021-09-08 17:48:28 +0100911 unsignedCompressedOutputFile := android.PathForModuleOut(ctx, a.Name()+imageCapexSuffix+".unsigned")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000912
913 compressRule := android.NewRuleBuilder(pctx, ctx)
914 compressRule.Command().
915 Text("rm").
916 FlagWithOutput("-f ", unsignedCompressedOutputFile)
917 compressRule.Command().
918 BuiltTool("apex_compression_tool").
919 Flag("compress").
920 FlagWithArg("--apex_compression_tool ", outHostBinDir+":"+prebuiltSdkToolsBinDir).
921 FlagWithInput("--input ", signedOutputFile).
922 FlagWithOutput("--output ", unsignedCompressedOutputFile)
923 compressRule.Build("compressRule", "Generate unsigned compressed APEX file")
924
Samiul Islam7c02e262021-09-08 17:48:28 +0100925 signedCompressedOutputFile := android.PathForModuleOut(ctx, a.Name()+imageCapexSuffix)
Mohammad Samiul Islam9ac0e322021-01-19 11:32:29 +0000926 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_SIGNAPK") {
927 args["outCommaList"] = signedCompressedOutputFile.String()
928 }
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000929 ctx.Build(pctx, android.BuildParams{
930 Rule: rule,
931 Description: "sign compressedApex",
932 Output: signedCompressedOutputFile,
933 Input: unsignedCompressedOutputFile,
934 Implicits: implicits,
935 Args: args,
936 })
937 a.outputFile = signedCompressedOutputFile
Martin Stjernholm8a3c9142022-07-26 09:35:39 +0000938 installSuffix = imageCapexSuffix
939 }
940
Colin Crossd9ccb6a2022-03-07 18:38:34 -0800941 if !a.installable() {
942 a.SkipInstall()
943 }
944
Jiyong Park17ff2832021-09-27 12:50:30 +0900945 // Install to $OUT/soong/{target,host}/.../apex.
Martin Stjernholm8a3c9142022-07-26 09:35:39 +0000946 a.installedFile = ctx.InstallFile(a.installDir, a.Name()+installSuffix, a.outputFile,
Colin Cross6340ea52021-11-04 12:01:18 -0700947 a.compatSymlinks.Paths()...)
Jiyong Park3a1602e2020-01-14 14:39:19 +0900948
949 // installed-files.txt is dist'ed
950 a.installedFilesFile = a.buildInstalledFilesFile(ctx, a.outputFile, imageDir)
Jiyong Park09d77522019-11-18 11:16:27 +0900951}
952
Jiyong Parkb81b9902020-11-24 19:51:18 +0900953// getCertificateAndPrivateKey retrieves the cert and the private key that will be used to sign
954// the zip container of this APEX. See the description of the 'certificate' property for how
955// the cert and the private key are found.
956func (a *apexBundle) getCertificateAndPrivateKey(ctx android.PathContext) (pem, key android.Path) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800957 if a.containerCertificateFile != nil {
958 return a.containerCertificateFile, a.containerPrivateKeyFile
Jiyong Parkb81b9902020-11-24 19:51:18 +0900959 }
960
Jaewoong Jung4cfdf7d2021-04-20 16:21:24 -0700961 cert := String(a.overridableProperties.Certificate)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900962 if cert == "" {
963 return ctx.Config().DefaultAppCertificate(ctx)
964 }
965
966 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
967 pem = defaultDir.Join(ctx, cert+".x509.pem")
968 key = defaultDir.Join(ctx, cert+".pk8")
969 return pem, key
Jiyong Park09d77522019-11-18 11:16:27 +0900970}
Jooyung Han27151d92019-12-16 17:45:32 +0900971
972func (a *apexBundle) getOverrideManifestPackageName(ctx android.ModuleContext) string {
973 // For VNDK APEXes, check "com.android.vndk" in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES
974 // to see if it should be overridden because their <apex name> is dynamically generated
975 // according to its VNDK version.
976 if a.vndkApex {
977 overrideName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(vndkApexName)
978 if overridden {
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900979 return overrideName + ".v" + a.vndkVersion(ctx.DeviceConfig())
Jooyung Han27151d92019-12-16 17:45:32 +0900980 }
981 return ""
982 }
Baligh Uddin5b57dba2020-03-15 13:01:05 -0700983 if a.overridableProperties.Package_name != "" {
984 return a.overridableProperties.Package_name
985 }
Jiyong Park20bacab2020-03-03 11:45:41 +0900986 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jooyung Han27151d92019-12-16 17:45:32 +0900987 if overridden {
988 return manifestPackageName
989 }
990 return ""
991}
Jiyong Park83dc74b2020-01-14 18:38:44 +0900992
993func (a *apexBundle) buildApexDependencyInfo(ctx android.ModuleContext) {
Jiyong Park83dc74b2020-01-14 18:38:44 +0900994 if a.properties.IsCoverageVariant {
995 // Otherwise, we will have duplicated rules for coverage and
996 // non-coverage variants of the same APEX
997 return
998 }
999
Artur Satayev872a1442020-04-27 17:08:37 +01001000 depInfos := android.DepNameToDepInfoMap{}
Jooyung Han749dc692020-04-15 11:03:39 +09001001 a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
Artur Satayev872a1442020-04-27 17:08:37 +01001002 if from.Name() == to.Name() {
1003 // This can happen for cc.reuseObjTag. We are not interested in tracking this.
1004 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1005 return !externalDep
Jiyong Park678c8812020-02-07 17:25:49 +09001006 }
Jiyong Park83dc74b2020-01-14 18:38:44 +09001007
Artur Satayev533b98c2021-03-11 18:03:42 +00001008 // Skip dependencies that are only available to APEXes; they are developed with updatability
1009 // in mind and don't need manual approval.
1010 if to.(android.ApexModule).NotAvailableForPlatform() {
1011 return !externalDep
1012 }
1013
Cindy Zhou18417cb2020-12-10 07:12:38 -08001014 depTag := ctx.OtherModuleDependencyTag(to)
Artur Satayev533b98c2021-03-11 18:03:42 +00001015 // Check to see if dependency been marked to skip the dependency check
Cindy Zhou18417cb2020-12-10 07:12:38 -08001016 if skipDepCheck, ok := depTag.(android.SkipApexAllowedDependenciesCheck); ok && skipDepCheck.SkipApexAllowedDependenciesCheck() {
Cindy Zhou18417cb2020-12-10 07:12:38 -08001017 return !externalDep
1018 }
1019
Artur Satayev872a1442020-04-27 17:08:37 +01001020 if info, exists := depInfos[to.Name()]; exists {
1021 if !android.InList(from.Name(), info.From) {
1022 info.From = append(info.From, from.Name())
1023 }
1024 info.IsExternal = info.IsExternal && externalDep
1025 depInfos[to.Name()] = info
1026 } else {
Artur Satayev480e25b2020-04-27 18:53:18 +01001027 toMinSdkVersion := "(no version)"
Jiyong Park92315372021-04-02 08:45:46 +09001028 if m, ok := to.(interface {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001029 MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel
Jiyong Park92315372021-04-02 08:45:46 +09001030 }); ok {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001031 if v := m.MinSdkVersion(ctx); !v.IsNone() {
1032 toMinSdkVersion = v.String()
Jiyong Park92315372021-04-02 08:45:46 +09001033 }
1034 } else if m, ok := to.(interface{ MinSdkVersion() string }); ok {
1035 // TODO(b/175678607) eliminate the use of MinSdkVersion returning
1036 // string
Artur Satayev480e25b2020-04-27 18:53:18 +01001037 if v := m.MinSdkVersion(); v != "" {
1038 toMinSdkVersion = v
1039 }
1040 }
Artur Satayev872a1442020-04-27 17:08:37 +01001041 depInfos[to.Name()] = android.ApexModuleDepInfo{
Artur Satayev480e25b2020-04-27 18:53:18 +01001042 To: to.Name(),
1043 From: []string{from.Name()},
1044 IsExternal: externalDep,
1045 MinSdkVersion: toMinSdkVersion,
Artur Satayev872a1442020-04-27 17:08:37 +01001046 }
1047 }
1048
1049 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1050 return !externalDep
Jiyong Park83dc74b2020-01-14 18:38:44 +09001051 })
1052
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001053 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(ctx).String(), depInfos)
Artur Satayev872a1442020-04-27 17:08:37 +01001054
Jiyong Park83dc74b2020-01-14 18:38:44 +09001055 ctx.Build(pctx, android.BuildParams{
1056 Rule: android.Phony,
1057 Output: android.PathForPhony(ctx, a.Name()+"-deps-info"),
Artur Satayeva8bd1132020-04-27 18:07:06 +01001058 Inputs: []android.Path{
1059 a.ApexBundleDepsInfo.FullListPath(),
1060 a.ApexBundleDepsInfo.FlatListPath(),
1061 },
Jiyong Park83dc74b2020-01-14 18:38:44 +09001062 })
1063}
Colin Cross08dca382020-07-21 20:31:17 -07001064
1065func (a *apexBundle) buildLintReports(ctx android.ModuleContext) {
1066 depSetsBuilder := java.NewLintDepSetBuilder()
1067 for _, fi := range a.filesInfo {
1068 depSetsBuilder.Transitive(fi.lintDepSets)
1069 }
1070
1071 a.lintReports = java.BuildModuleLintReportZips(ctx, depSetsBuilder.Build())
1072}
Jiyong Park1b0893e2021-12-13 23:40:17 +09001073
1074func (a *apexBundle) buildCannedFsConfig(ctx android.ModuleContext) android.OutputPath {
1075 var readOnlyPaths = []string{"apex_manifest.json", "apex_manifest.pb"}
1076 var executablePaths []string // this also includes dirs
1077 var appSetDirs []string
1078 appSetFiles := make(map[string]android.Path)
1079 for _, f := range a.filesInfo {
1080 pathInApex := f.path()
1081 if f.installDir == "bin" || strings.HasPrefix(f.installDir, "bin/") {
1082 executablePaths = append(executablePaths, pathInApex)
1083 for _, d := range f.dataPaths {
1084 readOnlyPaths = append(readOnlyPaths, filepath.Join(f.installDir, d.RelativeInstallPath, d.SrcPath.Rel()))
1085 }
1086 for _, s := range f.symlinks {
1087 executablePaths = append(executablePaths, filepath.Join(f.installDir, s))
1088 }
1089 } else if f.class == appSet {
Jiyong Park4169a252022-09-29 21:30:25 +09001090 // base APK
1091 readOnlyPaths = append(readOnlyPaths, pathInApex)
1092 // Additional APKs
Jiyong Park1b0893e2021-12-13 23:40:17 +09001093 appSetDirs = append(appSetDirs, f.installDir)
Jiyong Parke1b69142022-09-26 14:48:56 +09001094 appSetFiles[f.installDir] = f.module.(*java.AndroidAppSet).PackedAdditionalOutputs()
Jiyong Park1b0893e2021-12-13 23:40:17 +09001095 } else {
1096 readOnlyPaths = append(readOnlyPaths, pathInApex)
1097 }
1098 dir := f.installDir
1099 for !android.InList(dir, executablePaths) && dir != "" {
1100 executablePaths = append(executablePaths, dir)
1101 dir, _ = filepath.Split(dir) // move up to the parent
1102 if len(dir) > 0 {
1103 // remove trailing slash
1104 dir = dir[:len(dir)-1]
1105 }
1106 }
1107 }
1108 sort.Strings(readOnlyPaths)
1109 sort.Strings(executablePaths)
1110 sort.Strings(appSetDirs)
1111
1112 cannedFsConfig := android.PathForModuleOut(ctx, "canned_fs_config")
1113 builder := android.NewRuleBuilder(pctx, ctx)
1114 cmd := builder.Command()
1115 cmd.Text("(")
1116 cmd.Text("echo '/ 1000 1000 0755';")
1117 for _, p := range readOnlyPaths {
1118 cmd.Textf("echo '/%s 1000 1000 0644';", p)
1119 }
1120 for _, p := range executablePaths {
1121 cmd.Textf("echo '/%s 0 2000 0755';", p)
1122 }
1123 for _, dir := range appSetDirs {
1124 cmd.Textf("echo '/%s 0 2000 0755';", dir)
1125 file := appSetFiles[dir]
1126 cmd.Text("zipinfo -1").Input(file).Textf(`| sed "s:\(.*\):/%s/\1 1000 1000 0644:";`, dir)
1127 }
Jiyong Park038e8522021-12-13 23:56:35 +09001128 // Custom fs_config is "appended" to the last so that entries from the file are preferred
1129 // over default ones set above.
1130 if a.properties.Canned_fs_config != nil {
1131 cmd.Text("cat").Input(android.PathForModuleSrc(ctx, *a.properties.Canned_fs_config))
1132 }
Maciej Żenczykowski67e2f792023-03-27 07:03:43 +00001133 cmd.Text(")").FlagWithOutput("> ", cannedFsConfig)
Jiyong Park1b0893e2021-12-13 23:40:17 +09001134 builder.Build("generateFsConfig", fmt.Sprintf("Generating canned fs config for %s", a.BaseModuleName()))
1135
1136 return cannedFsConfig.OutputPath
1137}
Jooyung Han01f5d652023-04-05 16:29:26 +09001138
Jooyung Han4bc10262023-09-08 11:51:45 +09001139func runApexLinkerconfigValidation(ctx android.ModuleContext, apexFile android.OutputPath, imageDir android.OutputPath) android.Path {
1140 timestamp := android.PathForModuleOut(ctx, "apex_linkerconfig_validation.timestamp")
1141 ctx.Build(pctx, android.BuildParams{
1142 Rule: apexLinkerconfigValidationRule,
1143 Input: apexFile,
1144 Output: timestamp,
1145 Args: map[string]string{
1146 "image_dir": imageDir.String(),
1147 },
1148 })
1149 return timestamp
1150}
1151
Jooyung Han01f5d652023-04-05 16:29:26 +09001152// Runs apex_sepolicy_tests
1153//
1154// $ deapexer list -Z {apex_file} > {file_contexts}
1155// $ apex_sepolicy_tests -f {file_contexts}
1156func runApexSepolicyTests(ctx android.ModuleContext, apexFile android.OutputPath) android.Path {
1157 timestamp := android.PathForModuleOut(ctx, "sepolicy_tests.timestamp")
1158 ctx.Build(pctx, android.BuildParams{
1159 Rule: apexSepolicyTestsRule,
1160 Input: apexFile,
1161 Output: timestamp,
1162 })
1163 return timestamp
1164}