blob: 06f1dd0f57ed64910ebebe6b16a9212683aa72d4 [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"
20 "path/filepath"
21 "runtime"
22 "sort"
Nikita Ioffe5335bc42020-10-20 00:02:15 +010023 "strconv"
Jiyong Park09d77522019-11-18 11:16:27 +090024 "strings"
25
26 "android/soong/android"
27 "android/soong/java"
28
29 "github.com/google/blueprint"
30 "github.com/google/blueprint/proptools"
31)
32
33var (
34 pctx = android.NewPackageContext("android/apex")
35)
36
37func init() {
38 pctx.Import("android/soong/android")
sophiezc80a2b32020-11-12 16:39:19 +000039 pctx.Import("android/soong/cc/config")
Jiyong Park09d77522019-11-18 11:16:27 +090040 pctx.Import("android/soong/java")
41 pctx.HostBinToolVariable("apexer", "apexer")
Dennis Shenaf41bc12022-08-03 16:46:43 +000042 pctx.HostBinToolVariable("apexer_with_DCLA_preprocessing", "apexer_with_DCLA_preprocessing")
Dennis Shene2ed70c2023-01-11 14:15:43 +000043 pctx.HostBinToolVariable("apexer_with_trim_preprocessing", "apexer_with_trim_preprocessing")
44
Jiyong Park09d77522019-11-18 11:16:27 +090045 // ART minimal builds (using the master-art manifest) do not have the "frameworks/base"
Jiyong Parkb81b9902020-11-24 19:51:18 +090046 // projects, and hence cannot build 'aapt2'. Use the SDK prebuilt instead.
Jiyong Park09d77522019-11-18 11:16:27 +090047 hostBinToolVariableWithPrebuilt := func(name, prebuiltDir, tool string) {
48 pctx.VariableFunc(name, func(ctx android.PackageVarContext) string {
49 if !ctx.Config().FrameworksBaseDirExists(ctx) {
50 return filepath.Join(prebuiltDir, runtime.GOOS, "bin", tool)
51 } else {
Martin Stjernholm7260d062019-12-09 21:47:14 +000052 return ctx.Config().HostToolPath(ctx, tool).String()
Jiyong Park09d77522019-11-18 11:16:27 +090053 }
54 })
55 }
56 hostBinToolVariableWithPrebuilt("aapt2", "prebuilts/sdk/tools", "aapt2")
57 pctx.HostBinToolVariable("avbtool", "avbtool")
58 pctx.HostBinToolVariable("e2fsdroid", "e2fsdroid")
59 pctx.HostBinToolVariable("merge_zips", "merge_zips")
60 pctx.HostBinToolVariable("mke2fs", "mke2fs")
61 pctx.HostBinToolVariable("resize2fs", "resize2fs")
62 pctx.HostBinToolVariable("sefcontext_compile", "sefcontext_compile")
63 pctx.HostBinToolVariable("soong_zip", "soong_zip")
64 pctx.HostBinToolVariable("zip2zip", "zip2zip")
65 pctx.HostBinToolVariable("zipalign", "zipalign")
66 pctx.HostBinToolVariable("jsonmodify", "jsonmodify")
67 pctx.HostBinToolVariable("conv_apex_manifest", "conv_apex_manifest")
Jaewoong Jungfa00c062020-05-14 14:15:24 -070068 pctx.HostBinToolVariable("extract_apks", "extract_apks")
Theotime Combes4ba38c12020-06-12 12:46:59 +000069 pctx.HostBinToolVariable("make_f2fs", "make_f2fs")
70 pctx.HostBinToolVariable("sload_f2fs", "sload_f2fs")
Huang Jianan13cac632021-08-02 15:02:17 +080071 pctx.HostBinToolVariable("make_erofs", "make_erofs")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +000072 pctx.HostBinToolVariable("apex_compression_tool", "apex_compression_tool")
sophiez02347372021-11-02 17:58:02 -070073 pctx.HostBinToolVariable("dexdeps", "dexdeps")
sophiezc80a2b32020-11-12 16:39:19 +000074 pctx.SourcePathVariable("genNdkUsedbyApexPath", "build/soong/scripts/gen_ndk_usedby_apex.sh")
Jiyong Park09d77522019-11-18 11:16:27 +090075}
76
77var (
Jiyong Park09d77522019-11-18 11:16:27 +090078 apexManifestRule = pctx.StaticRule("apexManifestRule", blueprint.RuleParams{
79 Command: `rm -f $out && ${jsonmodify} $in ` +
80 `-a provideNativeLibs ${provideNativeLibs} ` +
81 `-a requireNativeLibs ${requireNativeLibs} ` +
Alexei Nicoarad887e242022-07-11 14:16:28 +010082 `-se version 0 ${default_version} ` +
Jiyong Park09d77522019-11-18 11:16:27 +090083 `${opt} ` +
84 `-o $out`,
85 CommandDeps: []string{"${jsonmodify}"},
86 Description: "prepare ${out}",
Alexei Nicoarad887e242022-07-11 14:16:28 +010087 }, "provideNativeLibs", "requireNativeLibs", "default_version", "opt")
Jiyong Park09d77522019-11-18 11:16:27 +090088
89 stripApexManifestRule = pctx.StaticRule("stripApexManifestRule", blueprint.RuleParams{
90 Command: `rm -f $out && ${conv_apex_manifest} strip $in -o $out`,
91 CommandDeps: []string{"${conv_apex_manifest}"},
92 Description: "strip ${in}=>${out}",
93 })
94
95 pbApexManifestRule = pctx.StaticRule("pbApexManifestRule", blueprint.RuleParams{
96 Command: `rm -f $out && ${conv_apex_manifest} proto $in -o $out`,
97 CommandDeps: []string{"${conv_apex_manifest}"},
98 Description: "convert ${in}=>${out}",
99 })
100
Joe Onoratob4638c12021-10-27 15:47:06 -0700101 // TODO(b/113233103): make sure that file_contexts is as expected, i.e., validate
Jiyong Park09d77522019-11-18 11:16:27 +0900102 // against the binary policy using sefcontext_compiler -p <policy>.
103
104 // TODO(b/114327326): automate the generation of file_contexts
105 apexRule = pctx.StaticRule("apexRule", blueprint.RuleParams{
106 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
107 `(. ${out}.copy_commands) && ` +
108 `APEXER_TOOL_PATH=${tool_path} ` +
109 `${apexer} --force --manifest ${manifest} ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900110 `--file_contexts ${file_contexts} ` +
111 `--canned_fs_config ${canned_fs_config} ` +
Dario Freni0f4ae072020-01-02 15:24:12 +0000112 `--include_build_info ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900113 `--payload_type image ` +
Oriol Prieto Gasco17e22902022-05-05 13:52:25 +0000114 `--key ${key} ${opt_flags} ${image_dir} ${out} `,
Jiyong Park09d77522019-11-18 11:16:27 +0900115 CommandDeps: []string{"${apexer}", "${avbtool}", "${e2fsdroid}", "${merge_zips}",
Huang Jianan13cac632021-08-02 15:02:17 +0800116 "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}", "${sload_f2fs}", "${make_erofs}",
Jiyong Park09d77522019-11-18 11:16:27 +0900117 "${soong_zip}", "${zipalign}", "${aapt2}", "prebuilts/sdk/current/public/android.jar"},
118 Rspfile: "${out}.copy_commands",
119 RspfileContent: "${copy_commands}",
120 Description: "APEX ${image_dir} => ${out}",
Dennis Shenaf41bc12022-08-03 16:46:43 +0000121 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
122 "opt_flags", "manifest")
123
124 DCLAApexRule = pctx.StaticRule("DCLAApexRule", blueprint.RuleParams{
125 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
126 `(. ${out}.copy_commands) && ` +
127 `APEXER_TOOL_PATH=${tool_path} ` +
128 `${apexer_with_DCLA_preprocessing} ` +
129 `--apexer ${apexer} ` +
130 `--canned_fs_config ${canned_fs_config} ` +
131 `${image_dir} ` +
132 `${out} ` +
133 `-- ` +
134 `--include_build_info ` +
135 `--force ` +
136 `--payload_type image ` +
137 `--key ${key} ` +
138 `--file_contexts ${file_contexts} ` +
139 `--manifest ${manifest} ` +
140 `${opt_flags} `,
141 CommandDeps: []string{"${apexer_with_DCLA_preprocessing}", "${apexer}", "${avbtool}", "${e2fsdroid}",
142 "${merge_zips}", "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}",
143 "${sload_f2fs}", "${make_erofs}", "${soong_zip}", "${zipalign}", "${aapt2}",
144 "prebuilts/sdk/current/public/android.jar"},
145 Rspfile: "${out}.copy_commands",
146 RspfileContent: "${copy_commands}",
147 Description: "APEX ${image_dir} => ${out}",
148 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
149 "opt_flags", "manifest", "is_DCLA")
Jiyong Park09d77522019-11-18 11:16:27 +0900150
Dennis Shene2ed70c2023-01-11 14:15:43 +0000151 TrimmedApexRule = pctx.StaticRule("TrimmedApexRule", blueprint.RuleParams{
152 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
153 `(. ${out}.copy_commands) && ` +
154 `APEXER_TOOL_PATH=${tool_path} ` +
155 `${apexer_with_trim_preprocessing} ` +
156 `--apexer ${apexer} ` +
157 `--canned_fs_config ${canned_fs_config} ` +
158 `--manifest ${manifest} ` +
159 `--libs_to_trim ${libs_to_trim} ` +
160 `${image_dir} ` +
161 `${out} ` +
162 `-- ` +
163 `--include_build_info ` +
164 `--force ` +
165 `--payload_type image ` +
166 `--key ${key} ` +
167 `--file_contexts ${file_contexts} ` +
168 `${opt_flags} `,
169 CommandDeps: []string{"${apexer_with_trim_preprocessing}", "${apexer}", "${avbtool}", "${e2fsdroid}",
170 "${merge_zips}", "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", "${make_f2fs}",
171 "${sload_f2fs}", "${make_erofs}", "${soong_zip}", "${zipalign}", "${aapt2}",
172 "prebuilts/sdk/current/public/android.jar"},
173 Rspfile: "${out}.copy_commands",
174 RspfileContent: "${copy_commands}",
175 Description: "APEX ${image_dir} => ${out}",
176 }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key",
177 "opt_flags", "manifest", "libs_to_trim")
178
Jiyong Park09d77522019-11-18 11:16:27 +0900179 zipApexRule = pctx.StaticRule("zipApexRule", blueprint.RuleParams{
180 Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` +
181 `(. ${out}.copy_commands) && ` +
182 `APEXER_TOOL_PATH=${tool_path} ` +
Jooyung Han214bf372019-11-12 13:03:50 +0900183 `${apexer} --force --manifest ${manifest} ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900184 `--payload_type zip ` +
185 `${image_dir} ${out} `,
186 CommandDeps: []string{"${apexer}", "${merge_zips}", "${soong_zip}", "${zipalign}", "${aapt2}"},
187 Rspfile: "${out}.copy_commands",
188 RspfileContent: "${copy_commands}",
189 Description: "ZipAPEX ${image_dir} => ${out}",
Alexei Nicoara0a389202022-07-12 14:35:39 +0100190 }, "tool_path", "image_dir", "copy_commands", "manifest")
Jiyong Park09d77522019-11-18 11:16:27 +0900191
192 apexProtoConvertRule = pctx.AndroidStaticRule("apexProtoConvertRule",
193 blueprint.RuleParams{
194 Command: `${aapt2} convert --output-format proto $in -o $out`,
195 CommandDeps: []string{"${aapt2}"},
196 })
197
198 apexBundleRule = pctx.StaticRule("apexBundleRule", blueprint.RuleParams{
Jiyong Parkbd159612020-02-28 15:22:21 +0900199 Command: `${zip2zip} -i $in -o $out.base ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900200 `apex_payload.img:apex/${abi}.img ` +
Dario Frenida1aefe2020-03-02 21:47:09 +0000201 `apex_build_info.pb:apex/${abi}.build_info.pb ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900202 `apex_manifest.json:root/apex_manifest.json ` +
Jiyong Park53ae3342019-12-08 02:06:24 +0900203 `apex_manifest.pb:root/apex_manifest.pb ` +
Jiyong Park09d77522019-11-18 11:16:27 +0900204 `AndroidManifest.xml:manifest/AndroidManifest.xml ` +
Jiyong Parkbd159612020-02-28 15:22:21 +0900205 `assets/NOTICE.html.gz:assets/NOTICE.html.gz &&` +
206 `${soong_zip} -o $out.config -C $$(dirname ${config}) -f ${config} && ` +
207 `${merge_zips} $out $out.base $out.config`,
208 CommandDeps: []string{"${zip2zip}", "${soong_zip}", "${merge_zips}"},
Jiyong Park09d77522019-11-18 11:16:27 +0900209 Description: "app bundle",
Jiyong Parkbd159612020-02-28 15:22:21 +0900210 }, "abi", "config")
Jiyong Park09d77522019-11-18 11:16:27 +0900211
Jiyong Park09d77522019-11-18 11:16:27 +0900212 diffApexContentRule = pctx.StaticRule("diffApexContentRule", blueprint.RuleParams{
213 Command: `diff --unchanged-group-format='' \` +
214 `--changed-group-format='%<' \` +
Colin Cross440e0d02020-06-11 11:32:11 -0700215 `${image_content_file} ${allowed_files_file} || (` +
Jiyong Park09d77522019-11-18 11:16:27 +0900216 `echo -e "New unexpected files were added to ${apex_module_name}." ` +
217 ` "To fix the build run following command:" && ` +
Colin Cross440e0d02020-06-11 11:32:11 -0700218 `echo "system/apex/tools/update_allowed_list.sh ${allowed_files_file} ${image_content_file}" && ` +
Dan Willemsen81e43c52020-01-28 15:40:19 -0800219 `exit 1); touch ${out}`,
Colin Cross440e0d02020-06-11 11:32:11 -0700220 Description: "Diff ${image_content_file} and ${allowed_files_file}",
221 }, "image_content_file", "allowed_files_file", "apex_module_name")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900222
sophiezc80a2b32020-11-12 16:39:19 +0000223 generateAPIsUsedbyApexRule = pctx.StaticRule("generateAPIsUsedbyApexRule", blueprint.RuleParams{
224 Command: "$genNdkUsedbyApexPath ${image_dir} ${readelf} ${out}",
225 CommandDeps: []string{"${genNdkUsedbyApexPath}"},
226 Description: "Generate symbol list used by Apex",
227 }, "image_dir", "readelf")
228
Jiyong Parkb81b9902020-11-24 19:51:18 +0900229 // Don't add more rules here. Consider using android.NewRuleBuilder instead.
Jiyong Park09d77522019-11-18 11:16:27 +0900230)
231
Jiyong Parkb81b9902020-11-24 19:51:18 +0900232// buildManifest creates buile rules to modify the input apex_manifest.json to add information
233// gathered by the build system such as provided/required native libraries. Two output files having
234// different formats are generated. a.manifestJsonOut is JSON format for Q devices, and
235// a.manifest.PbOut is protobuf format for R+ devices.
236// TODO(jiyong): make this to return paths instead of directly storing the paths to apexBundle
Jiyong Park09d77522019-11-18 11:16:27 +0900237func (a *apexBundle) buildManifest(ctx android.ModuleContext, provideNativeLibs, requireNativeLibs []string) {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900238 src := android.PathForModuleSrc(ctx, proptools.StringDefault(a.properties.Manifest, "apex_manifest.json"))
Jiyong Park09d77522019-11-18 11:16:27 +0900239
Jiyong Parkb81b9902020-11-24 19:51:18 +0900240 // Put dependency({provide|require}NativeLibs) in apex_manifest.json
Jiyong Park09d77522019-11-18 11:16:27 +0900241 provideNativeLibs = android.SortedUniqueStrings(provideNativeLibs)
242 requireNativeLibs = android.SortedUniqueStrings(android.RemoveListFromList(requireNativeLibs, provideNativeLibs))
243
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900244 // VNDK APEX name is determined at runtime, so update "name" in apex_manifest
Jiyong Park09d77522019-11-18 11:16:27 +0900245 optCommands := []string{}
Jooyung Han2cd2f9a2023-02-06 18:29:08 +0900246 if a.vndkApex {
247 apexName := vndkApexNamePrefix + a.vndkVersion(ctx.DeviceConfig())
248 optCommands = append(optCommands, "-v name "+apexName)
Jiyong Park09d77522019-11-18 11:16:27 +0900249 }
250
Jiyong Parkb81b9902020-11-24 19:51:18 +0900251 // Collect jniLibs. Notice that a.filesInfo is already sorted
Jooyung Han643adc42020-02-27 13:50:06 +0900252 var jniLibs []string
253 for _, fi := range a.filesInfo {
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900254 if fi.isJniLib && !android.InList(fi.stem(), jniLibs) {
255 jniLibs = append(jniLibs, fi.stem())
Jooyung Han643adc42020-02-27 13:50:06 +0900256 }
257 }
258 if len(jniLibs) > 0 {
259 optCommands = append(optCommands, "-a jniLibs "+strings.Join(jniLibs, " "))
260 }
261
Jooyung Hand045ebc2022-12-06 15:23:57 +0900262 if android.InList(":vndk", requireNativeLibs) {
263 if _, vndkVersion := a.getImageVariationPair(ctx.DeviceConfig()); vndkVersion != "" {
264 optCommands = append(optCommands, "-v vndkVersion "+vndkVersion)
265 }
266 }
267
Jiyong Parkb81b9902020-11-24 19:51:18 +0900268 manifestJsonFullOut := android.PathForModuleOut(ctx, "apex_manifest_full.json")
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000269 defaultVersion := android.DefaultUpdatableModuleVersion
270 if override := ctx.Config().Getenv("OVERRIDE_APEX_MANIFEST_DEFAULT_VERSION"); override != "" {
271 defaultVersion = override
272 }
Jiyong Park09d77522019-11-18 11:16:27 +0900273 ctx.Build(pctx, android.BuildParams{
274 Rule: apexManifestRule,
Alexei Nicoara0a389202022-07-12 14:35:39 +0100275 Input: src,
Jooyung Han214bf372019-11-12 13:03:50 +0900276 Output: manifestJsonFullOut,
Jiyong Park09d77522019-11-18 11:16:27 +0900277 Args: map[string]string{
278 "provideNativeLibs": strings.Join(provideNativeLibs, " "),
279 "requireNativeLibs": strings.Join(requireNativeLibs, " "),
Sahana Rao16ebdfd2022-12-02 17:00:22 +0000280 "default_version": defaultVersion,
Jiyong Park09d77522019-11-18 11:16:27 +0900281 "opt": strings.Join(optCommands, " "),
282 },
283 })
284
Jiyong Parkb81b9902020-11-24 19:51:18 +0900285 // b/143654022 Q apexd can't understand newly added keys in apex_manifest.json prepare
286 // stripped-down version so that APEX modules built from R+ can be installed to Q
Dan Albertc8060532020-07-22 22:32:17 -0700287 minSdkVersion := a.minSdkVersion(ctx)
288 if minSdkVersion.EqualTo(android.SdkVersion_Android10) {
Jooyung Han214bf372019-11-12 13:03:50 +0900289 a.manifestJsonOut = android.PathForModuleOut(ctx, "apex_manifest.json")
290 ctx.Build(pctx, android.BuildParams{
291 Rule: stripApexManifestRule,
292 Input: manifestJsonFullOut,
293 Output: a.manifestJsonOut,
294 })
295 }
Jiyong Park09d77522019-11-18 11:16:27 +0900296
Jiyong Parkb81b9902020-11-24 19:51:18 +0900297 // From R+, protobuf binary format (.pb) is the standard format for apex_manifest
Jiyong Park09d77522019-11-18 11:16:27 +0900298 a.manifestPbOut = android.PathForModuleOut(ctx, "apex_manifest.pb")
299 ctx.Build(pctx, android.BuildParams{
300 Rule: pbApexManifestRule,
Jooyung Han214bf372019-11-12 13:03:50 +0900301 Input: manifestJsonFullOut,
Jiyong Park09d77522019-11-18 11:16:27 +0900302 Output: a.manifestPbOut,
303 })
304}
305
Jiyong Parkb81b9902020-11-24 19:51:18 +0900306// buildFileContexts create build rules to append an entry for apex_manifest.pb to the file_contexts
307// file for this APEX which is either from /systme/sepolicy/apex/<apexname>-file_contexts or from
308// the file_contexts property of this APEX. This is to make sure that the manifest file is correctly
309// labeled as system_file.
310func (a *apexBundle) buildFileContexts(ctx android.ModuleContext) android.OutputPath {
Jooyung Han580eb4f2020-06-24 19:33:06 +0900311 var fileContexts android.Path
Liz Kammer37997c42021-09-14 17:53:38 -0400312 var fileContextsDir string
Jooyung Han580eb4f2020-06-24 19:33:06 +0900313 if a.properties.File_contexts == nil {
314 fileContexts = android.PathForSource(ctx, "system/sepolicy/apex", ctx.ModuleName()+"-file_contexts")
315 } else {
Liz Kammer37997c42021-09-14 17:53:38 -0400316 if m, t := android.SrcIsModuleWithTag(*a.properties.File_contexts); m != "" {
317 otherModule := android.GetModuleFromPathDep(ctx, m, t)
318 fileContextsDir = ctx.OtherModuleDir(otherModule)
319 }
Jooyung Han580eb4f2020-06-24 19:33:06 +0900320 fileContexts = android.PathForModuleSrc(ctx, *a.properties.File_contexts)
321 }
Liz Kammer37997c42021-09-14 17:53:38 -0400322 if fileContextsDir == "" {
323 fileContextsDir = filepath.Dir(fileContexts.String())
324 }
325 fileContextsDir += string(filepath.Separator)
326
Jooyung Han580eb4f2020-06-24 19:33:06 +0900327 if a.Platform() {
Liz Kammer37997c42021-09-14 17:53:38 -0400328 if !strings.HasPrefix(fileContextsDir, "system/sepolicy/") {
329 ctx.PropertyErrorf("file_contexts", "should be under system/sepolicy, but found in %q", fileContextsDir)
Jooyung Han580eb4f2020-06-24 19:33:06 +0900330 }
331 }
332 if !android.ExistentPathForSource(ctx, fileContexts.String()).Valid() {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900333 ctx.PropertyErrorf("file_contexts", "cannot find file_contexts file: %q", fileContexts.String())
Jooyung Han580eb4f2020-06-24 19:33:06 +0900334 }
335
336 output := android.PathForModuleOut(ctx, "file_contexts")
Colin Crossf1a035e2020-11-16 17:32:30 -0800337 rule := android.NewRuleBuilder(pctx, ctx)
Jooyung Han7f146c02020-09-23 19:15:55 +0900338
Jiyong Parkb81b9902020-11-24 19:51:18 +0900339 switch a.properties.ApexType {
340 case imageApex:
Jooyung Han7f146c02020-09-23 19:15:55 +0900341 // remove old file
342 rule.Command().Text("rm").FlagWithOutput("-f ", output)
343 // copy file_contexts
344 rule.Command().Text("cat").Input(fileContexts).Text(">>").Output(output)
345 // new line
346 rule.Command().Text("echo").Text(">>").Output(output)
347 // force-label /apex_manifest.pb and / as system_file so that apexd can read them
348 rule.Command().Text("echo").Flag("/apex_manifest\\\\.pb u:object_r:system_file:s0").Text(">>").Output(output)
349 rule.Command().Text("echo").Flag("/ u:object_r:system_file:s0").Text(">>").Output(output)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900350 case flattenedApex:
Jooyung Han7f146c02020-09-23 19:15:55 +0900351 // For flattened apexes, install path should be prepended.
352 // File_contexts file should be emiited to make via LOCAL_FILE_CONTEXTS
353 // so that it can be merged into file_contexts.bin
354 apexPath := android.InstallPathToOnDevicePath(ctx, a.installDir.Join(ctx, a.Name()))
355 apexPath = strings.ReplaceAll(apexPath, ".", `\\.`)
356 // remove old file
357 rule.Command().Text("rm").FlagWithOutput("-f ", output)
358 // copy file_contexts
359 rule.Command().Text("awk").Text(`'/object_r/{printf("` + apexPath + `%s\n", $0)}'`).Input(fileContexts).Text(">").Output(output)
360 // new line
361 rule.Command().Text("echo").Text(">>").Output(output)
362 // force-label /apex_manifest.pb and / as system_file so that apexd can read them
363 rule.Command().Text("echo").Flag(apexPath + `/apex_manifest\\.pb u:object_r:system_file:s0`).Text(">>").Output(output)
364 rule.Command().Text("echo").Flag(apexPath + "/ u:object_r:system_file:s0").Text(">>").Output(output)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900365 default:
366 panic(fmt.Errorf("unsupported type %v", a.properties.ApexType))
Jooyung Han7f146c02020-09-23 19:15:55 +0900367 }
368
Colin Crossf1a035e2020-11-16 17:32:30 -0800369 rule.Build("file_contexts."+a.Name(), "Generate file_contexts")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900370 return output.OutputPath
Jooyung Han580eb4f2020-06-24 19:33:06 +0900371}
372
Jiyong Parkb81b9902020-11-24 19:51:18 +0900373// buildInstalledFilesFile creates a build rule for the installed-files.txt file where the list of
374// files included in this APEX is shown. The text file is dist'ed so that people can see what's
375// included in the APEX without actually downloading and extracting it.
Jiyong Park3a1602e2020-01-14 14:39:19 +0900376func (a *apexBundle) buildInstalledFilesFile(ctx android.ModuleContext, builtApex android.Path, imageDir android.Path) android.OutputPath {
377 output := android.PathForModuleOut(ctx, "installed-files.txt")
Colin Crossf1a035e2020-11-16 17:32:30 -0800378 rule := android.NewRuleBuilder(pctx, ctx)
Jiyong Park3a1602e2020-01-14 14:39:19 +0900379 rule.Command().
380 Implicit(builtApex).
381 Text("(cd " + imageDir.String() + " ; ").
Jiyong Parkbd63a102020-02-08 12:40:05 +0900382 Text("find . \\( -type f -o -type l \\) -printf \"%s %p\\n\") ").
Jiyong Park3a1602e2020-01-14 14:39:19 +0900383 Text(" | sort -nr > ").
384 Output(output)
Colin Crossf1a035e2020-11-16 17:32:30 -0800385 rule.Build("installed-files."+a.Name(), "Installed files")
Jiyong Park3a1602e2020-01-14 14:39:19 +0900386 return output.OutputPath
387}
388
Jiyong Parkb81b9902020-11-24 19:51:18 +0900389// buildBundleConfig creates a build rule for the bundle config file that will control the bundle
390// creation process.
Jiyong Parkbd159612020-02-28 15:22:21 +0900391func (a *apexBundle) buildBundleConfig(ctx android.ModuleContext) android.OutputPath {
392 output := android.PathForModuleOut(ctx, "bundle_config.json")
393
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900394 type ApkConfig struct {
395 Package_name string `json:"package_name"`
396 Apk_path string `json:"path"`
397 }
Jiyong Parkbd159612020-02-28 15:22:21 +0900398 config := struct {
399 Compression struct {
400 Uncompressed_glob []string `json:"uncompressed_glob"`
401 } `json:"compression"`
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900402 Apex_config struct {
403 Apex_embedded_apk_config []ApkConfig `json:"apex_embedded_apk_config,omitempty"`
404 } `json:"apex_config,omitempty"`
Jiyong Parkbd159612020-02-28 15:22:21 +0900405 }{}
406
407 config.Compression.Uncompressed_glob = []string{
408 "apex_payload.img",
409 "apex_manifest.*",
410 }
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900411
Jiyong Parkb81b9902020-11-24 19:51:18 +0900412 // Collect the manifest names and paths of android apps if their manifest names are
413 // overridden.
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900414 for _, fi := range a.filesInfo {
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700415 if fi.class != app && fi.class != appSet {
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900416 continue
417 }
418 packageName := fi.overriddenPackageName
419 if packageName != "" {
420 config.Apex_config.Apex_embedded_apk_config = append(
421 config.Apex_config.Apex_embedded_apk_config,
422 ApkConfig{
423 Package_name: packageName,
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900424 Apk_path: fi.path(),
Jiyong Parkcfaa1642020-02-28 16:51:07 +0900425 })
426 }
427 }
428
Jiyong Parkbd159612020-02-28 15:22:21 +0900429 j, err := json.Marshal(config)
430 if err != nil {
431 panic(fmt.Errorf("error while marshalling to %q: %#v", output, err))
432 }
433
Colin Crosscf371cc2020-11-13 11:48:42 -0800434 android.WriteFileRule(ctx, output, string(j))
Jiyong Parkbd159612020-02-28 15:22:21 +0900435
436 return output.OutputPath
437}
438
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000439func markManifestTestOnly(ctx android.ModuleContext, androidManifestFile android.Path) android.Path {
Gurpreet Singh7deabfa2022-02-10 13:28:35 +0000440 return java.ManifestFixer(ctx, androidManifestFile, java.ManifestFixerParams{
441 TestOnly: true,
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000442 })
443}
444
Jiyong Parkb81b9902020-11-24 19:51:18 +0900445// buildUnflattendApex creates build rules to build an APEX using apexer.
Jiyong Park09d77522019-11-18 11:16:27 +0900446func (a *apexBundle) buildUnflattenedApex(ctx android.ModuleContext) {
Jiyong Park09d77522019-11-18 11:16:27 +0900447 apexType := a.properties.ApexType
448 suffix := apexType.suffix()
Colin Cross6340ea52021-11-04 12:01:18 -0700449 apexName := proptools.StringDefault(a.properties.Apex_name, a.BaseModuleName())
Jiyong Park09d77522019-11-18 11:16:27 +0900450
Jiyong Parkb81b9902020-11-24 19:51:18 +0900451 ////////////////////////////////////////////////////////////////////////////////////////////
452 // Step 1: copy built files to appropriate directories under the image directory
453
454 imageDir := android.PathForModuleOut(ctx, "image"+suffix)
455
Colin Cross02730b92022-04-18 17:42:27 -0700456 installSymbolFiles := (!ctx.Config().KatiEnabled() || a.ExportedToMake()) && a.installable()
Colin Cross6340ea52021-11-04 12:01:18 -0700457
Colin Cross6340ea52021-11-04 12:01:18 -0700458 // Avoid creating duplicate build rules for multi-installed APEXes.
459 if proptools.BoolDefault(a.properties.Multi_install_skip_symbol_files, false) {
460 installSymbolFiles = false
Colin Cross4acaea92021-12-10 23:05:02 +0000461
Colin Cross6340ea52021-11-04 12:01:18 -0700462 }
Colin Cross4acaea92021-12-10 23:05:02 +0000463 // set of dependency module:location mappings
464 installMapSet := make(map[string]bool)
Colin Cross6340ea52021-11-04 12:01:18 -0700465
Jiyong Parkb81b9902020-11-24 19:51:18 +0900466 // TODO(jiyong): use the RuleBuilder
Jiyong Park7cd10e32020-01-14 09:22:18 +0900467 var copyCommands []string
Jiyong Parkb81b9902020-11-24 19:51:18 +0900468 var implicitInputs []android.Path
Colin Cross6340ea52021-11-04 12:01:18 -0700469 pathWhenActivated := android.PathForModuleInPartitionInstall(ctx, "apex", apexName)
Jiyong Park7cd10e32020-01-14 09:22:18 +0900470 for _, fi := range a.filesInfo {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900471 destPath := imageDir.Join(ctx, fi.path()).String()
Jiyong Parkb81b9902020-11-24 19:51:18 +0900472 // Prepare the destination path
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700473 destPathDir := filepath.Dir(destPath)
474 if fi.class == appSet {
475 copyCommands = append(copyCommands, "rm -rf "+destPathDir)
476 }
477 copyCommands = append(copyCommands, "mkdir -p "+destPathDir)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900478
Colin Cross4acaea92021-12-10 23:05:02 +0000479 installMapPath := fi.builtFile
480
Jiyong Parkb81b9902020-11-24 19:51:18 +0900481 // Copy the built file to the directory. But if the symlink optimization is turned
482 // on, place a symlink to the corresponding file in /system partition instead.
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900483 if a.linkToSystemLib && fi.transitiveDep && fi.availableToPlatform() {
Jiyong Park7cd10e32020-01-14 09:22:18 +0900484 // TODO(jiyong): pathOnDevice should come from fi.module, not being calculated here
Jiyong Parkc0ec6f92020-11-19 23:00:52 +0900485 pathOnDevice := filepath.Join("/system", fi.path())
Jiyong Park7cd10e32020-01-14 09:22:18 +0900486 copyCommands = append(copyCommands, "ln -sfn "+pathOnDevice+" "+destPath)
487 } else {
Jiyong Park4169a252022-09-29 21:30:25 +0900488 // Copy the file into APEX
489 copyCommands = append(copyCommands, "cp -f "+fi.builtFile.String()+" "+destPath)
490
Colin Cross4acaea92021-12-10 23:05:02 +0000491 var installedPath android.InstallPath
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700492 if fi.class == appSet {
Jiyong Park4169a252022-09-29 21:30:25 +0900493 // In case of AppSet, we need to copy additional APKs as well. They
494 // are zipped. So we need to unzip them.
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700495 copyCommands = append(copyCommands,
Colin Crossffbcd1d2021-11-12 12:19:42 -0800496 fmt.Sprintf("unzip -qDD -d %s %s", destPathDir,
497 fi.module.(*java.AndroidAppSet).PackedAdditionalOutputs().String()))
Colin Cross6340ea52021-11-04 12:01:18 -0700498 if installSymbolFiles {
499 installedPath = ctx.InstallFileWithExtraFilesZip(pathWhenActivated.Join(ctx, fi.installDir),
500 fi.stem(), fi.builtFile, fi.module.(*java.AndroidAppSet).PackedAdditionalOutputs())
501 }
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700502 } else {
Colin Cross6340ea52021-11-04 12:01:18 -0700503 if installSymbolFiles {
504 installedPath = ctx.InstallFile(pathWhenActivated.Join(ctx, fi.installDir), fi.stem(), fi.builtFile)
505 }
Sasha Smundak18d98bc2020-05-27 16:36:07 -0700506 }
Jiyong Park7cd10e32020-01-14 09:22:18 +0900507 implicitInputs = append(implicitInputs, fi.builtFile)
Colin Cross6340ea52021-11-04 12:01:18 -0700508 if installSymbolFiles {
509 implicitInputs = append(implicitInputs, installedPath)
510 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900511
Colin Cross4acaea92021-12-10 23:05:02 +0000512 // Create additional symlinks pointing the file inside the APEX (if any). Note that
513 // this is independent from the symlink optimization.
514 for _, symlinkPath := range fi.symlinkPaths() {
515 symlinkDest := imageDir.Join(ctx, symlinkPath).String()
516 copyCommands = append(copyCommands, "ln -sfn "+filepath.Base(destPath)+" "+symlinkDest)
517 if installSymbolFiles {
518 installedSymlink := ctx.InstallSymlink(pathWhenActivated.Join(ctx, filepath.Dir(symlinkPath)), filepath.Base(symlinkPath), installedPath)
519 implicitInputs = append(implicitInputs, installedSymlink)
520 }
Colin Cross6340ea52021-11-04 12:01:18 -0700521 }
Colin Cross4acaea92021-12-10 23:05:02 +0000522
523 installMapPath = installedPath
Jiyong Park7cd10e32020-01-14 09:22:18 +0900524 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900525
526 // Copy the test files (if any)
Liz Kammer1c14a212020-05-12 15:26:55 -0700527 for _, d := range fi.dataPaths {
528 // 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 -0400529 relPath := d.SrcPath.Rel()
530 dataPath := d.SrcPath.String()
Liz Kammer1c14a212020-05-12 15:26:55 -0700531 if !strings.HasSuffix(dataPath, relPath) {
532 panic(fmt.Errorf("path %q does not end with %q", dataPath, relPath))
533 }
534
Jiyong Parkb81b9902020-11-24 19:51:18 +0900535 dataDest := imageDir.Join(ctx, fi.apexRelativePath(relPath), d.RelativeInstallPath).String()
Liz Kammer1c14a212020-05-12 15:26:55 -0700536
Chris Parsons216e10a2020-07-09 17:12:52 -0400537 copyCommands = append(copyCommands, "cp -f "+d.SrcPath.String()+" "+dataDest)
538 implicitInputs = append(implicitInputs, d.SrcPath)
Liz Kammer1c14a212020-05-12 15:26:55 -0700539 }
Colin Cross4acaea92021-12-10 23:05:02 +0000540
541 installMapSet[installMapPath.String()+":"+fi.installDir+"/"+fi.builtFile.Base()] = true
Jiyong Park09d77522019-11-18 11:16:27 +0900542 }
Jooyung Han214bf372019-11-12 13:03:50 +0900543 implicitInputs = append(implicitInputs, a.manifestPbOut)
Colin Cross6340ea52021-11-04 12:01:18 -0700544 if installSymbolFiles {
545 installedManifest := ctx.InstallFile(pathWhenActivated, "apex_manifest.pb", a.manifestPbOut)
546 installedKey := ctx.InstallFile(pathWhenActivated, "apex_pubkey", a.publicKeyFile)
547 implicitInputs = append(implicitInputs, installedManifest, installedKey)
548 }
Jiyong Park09d77522019-11-18 11:16:27 +0900549
Colin Cross4acaea92021-12-10 23:05:02 +0000550 if len(installMapSet) > 0 {
551 var installs []string
552 installs = append(installs, android.SortedStringKeys(installMapSet)...)
553 a.SetLicenseInstallMap(installs)
554 }
555
Jiyong Parkb81b9902020-11-24 19:51:18 +0900556 ////////////////////////////////////////////////////////////////////////////////////////////
557 // Step 1.a: Write the list of files in this APEX to a txt file and compare it against
558 // the allowed list given via the allowed_files property. Build fails when the two lists
559 // differ.
560 //
561 // TODO(jiyong): consider removing this. Nobody other than com.android.apex.cts.shim.* seems
562 // to be using this at this moment. Furthermore, this looks very similar to what
563 // buildInstalledFilesFile does. At least, move this to somewhere else so that this doesn't
564 // hurt readability.
Jooyung Han938b5932020-06-20 12:47:47 +0900565 if a.overridableProperties.Allowed_files != nil {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900566 // Build content.txt
Cole Fausta7347492022-12-16 10:56:24 -0800567 var contentLines []string
Jiyong Parkb81b9902020-11-24 19:51:18 +0900568 imageContentFile := android.PathForModuleOut(ctx, "content.txt")
Cole Fausta7347492022-12-16 10:56:24 -0800569 contentLines = append(contentLines, "./apex_manifest.pb")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900570 minSdkVersion := a.minSdkVersion(ctx)
571 if minSdkVersion.EqualTo(android.SdkVersion_Android10) {
Cole Fausta7347492022-12-16 10:56:24 -0800572 contentLines = append(contentLines, "./apex_manifest.json")
Jiyong Parkb81b9902020-11-24 19:51:18 +0900573 }
574 for _, fi := range a.filesInfo {
Cole Fausta7347492022-12-16 10:56:24 -0800575 contentLines = append(contentLines, "./"+fi.path())
Jiyong Parkb81b9902020-11-24 19:51:18 +0900576 }
Cole Fausta7347492022-12-16 10:56:24 -0800577 sort.Strings(contentLines)
578 android.WriteFileRule(ctx, imageContentFile, strings.Join(contentLines, "\n"))
Jiyong Park09d77522019-11-18 11:16:27 +0900579 implicitInputs = append(implicitInputs, imageContentFile)
Jiyong Park09d77522019-11-18 11:16:27 +0900580
Jiyong Parkb81b9902020-11-24 19:51:18 +0900581 // Compare content.txt against allowed_files.
582 allowedFilesFile := android.PathForModuleSrc(ctx, proptools.String(a.overridableProperties.Allowed_files))
Jaewoong Jung1670ca02019-11-22 14:50:42 -0800583 phonyOutput := android.PathForModuleOut(ctx, a.Name()+"-diff-phony-output")
Jiyong Park09d77522019-11-18 11:16:27 +0900584 ctx.Build(pctx, android.BuildParams{
585 Rule: diffApexContentRule,
586 Implicits: implicitInputs,
587 Output: phonyOutput,
588 Description: "diff apex image content",
589 Args: map[string]string{
Colin Cross440e0d02020-06-11 11:32:11 -0700590 "allowed_files_file": allowedFilesFile.String(),
591 "image_content_file": imageContentFile.String(),
592 "apex_module_name": a.Name(),
Jiyong Park09d77522019-11-18 11:16:27 +0900593 },
594 })
Jiyong Park09d77522019-11-18 11:16:27 +0900595 implicitInputs = append(implicitInputs, phonyOutput)
596 }
597
Jiyong Parkb81b9902020-11-24 19:51:18 +0900598 unsignedOutputFile := android.PathForModuleOut(ctx, a.Name()+suffix+".unsigned")
Colin Cross790ef352021-10-25 19:15:55 -0700599 outHostBinDir := ctx.Config().HostToolPath(ctx, "").String()
Jiyong Park09d77522019-11-18 11:16:27 +0900600 prebuiltSdkToolsBinDir := filepath.Join("prebuilts", "sdk", "tools", runtime.GOOS, "bin")
601
602 if apexType == imageApex {
Jiyong Park1b0893e2021-12-13 23:40:17 +0900603
Jiyong Parkb81b9902020-11-24 19:51:18 +0900604 ////////////////////////////////////////////////////////////////////////////////////
605 // Step 2: create canned_fs_config which encodes filemode,uid,gid of each files
606 // in this APEX. The file will be used by apexer in later steps.
Jiyong Park1b0893e2021-12-13 23:40:17 +0900607 cannedFsConfig := a.buildCannedFsConfig(ctx)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900608 implicitInputs = append(implicitInputs, cannedFsConfig)
Jiyong Park09d77522019-11-18 11:16:27 +0900609
Jiyong Parkb81b9902020-11-24 19:51:18 +0900610 ////////////////////////////////////////////////////////////////////////////////////
611 // Step 3: Prepare option flags for apexer and invoke it to create an unsigned APEX.
612 // TODO(jiyong): use the RuleBuilder
Jiyong Park09d77522019-11-18 11:16:27 +0900613 optFlags := []string{}
614
Jiyong Parkb81b9902020-11-24 19:51:18 +0900615 fileContexts := a.buildFileContexts(ctx)
616 implicitInputs = append(implicitInputs, fileContexts)
617
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800618 implicitInputs = append(implicitInputs, a.privateKeyFile, a.publicKeyFile)
619 optFlags = append(optFlags, "--pubkey "+a.publicKeyFile.String())
Jiyong Park09d77522019-11-18 11:16:27 +0900620
Jooyung Han27151d92019-12-16 17:45:32 +0900621 manifestPackageName := a.getOverrideManifestPackageName(ctx)
622 if manifestPackageName != "" {
Jiyong Park09d77522019-11-18 11:16:27 +0900623 optFlags = append(optFlags, "--override_apk_package_name "+manifestPackageName)
624 }
625
626 if a.properties.AndroidManifest != nil {
627 androidManifestFile := android.PathForModuleSrc(ctx, proptools.String(a.properties.AndroidManifest))
Gurpreet Singh75d65f32022-01-24 17:44:05 +0000628
629 if a.testApex {
630 androidManifestFile = markManifestTestOnly(ctx, androidManifestFile)
631 }
632
Jiyong Park09d77522019-11-18 11:16:27 +0900633 implicitInputs = append(implicitInputs, androidManifestFile)
634 optFlags = append(optFlags, "--android_manifest "+androidManifestFile.String())
Gurpreet Singha76f8742022-02-03 21:01:51 +0000635 } else if a.testApex {
636 optFlags = append(optFlags, "--test_only")
Jiyong Park09d77522019-11-18 11:16:27 +0900637 }
638
Jiyong Parkb81b9902020-11-24 19:51:18 +0900639 // Determine target/min sdk version from the context
640 // TODO(jiyong): make this as a function
Dan Albertc8060532020-07-22 22:32:17 -0700641 moduleMinSdkVersion := a.minSdkVersion(ctx)
Nikita Ioffe5335bc42020-10-20 00:02:15 +0100642 minSdkVersion := moduleMinSdkVersion.String()
643
Jiyong Parkb81b9902020-11-24 19:51:18 +0900644 // bundletool doesn't understand what "current" is. We need to transform it to
645 // codename
Jooyung Haned124c32021-01-26 11:43:46 +0900646 if moduleMinSdkVersion.IsCurrent() || moduleMinSdkVersion.IsNone() {
Nikita Ioffe5335bc42020-10-20 00:02:15 +0100647 minSdkVersion = ctx.Config().DefaultAppTargetSdk(ctx).String()
Liz Kammer4854a7d2021-05-27 14:28:27 -0400648
649 if java.UseApiFingerprint(ctx) {
650 minSdkVersion = ctx.Config().PlatformSdkCodename() + fmt.Sprintf(".$$(cat %s)", java.ApiFingerprintPath(ctx).String())
651 implicitInputs = append(implicitInputs, java.ApiFingerprintPath(ctx))
652 }
Nikita Ioffe5d600c92020-02-20 00:43:27 +0000653 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900654 // apex module doesn't have a concept of target_sdk_version, hence for the time
655 // being targetSdkVersion == default targetSdkVersion of the branch.
Nikita Ioffe5335bc42020-10-20 00:02:15 +0100656 targetSdkVersion := strconv.Itoa(ctx.Config().DefaultAppTargetSdk(ctx).FinalOrFutureInt())
Nikita Ioffe5d600c92020-02-20 00:43:27 +0000657
Nikita Ioffe1f4f3452020-03-02 16:58:11 +0000658 if java.UseApiFingerprint(ctx) {
659 targetSdkVersion = ctx.Config().PlatformSdkCodename() + fmt.Sprintf(".$$(cat %s)", java.ApiFingerprintPath(ctx).String())
Baligh Uddinf6201372020-01-24 23:15:44 +0000660 implicitInputs = append(implicitInputs, java.ApiFingerprintPath(ctx))
661 }
Jiyong Park09d77522019-11-18 11:16:27 +0900662 optFlags = append(optFlags, "--target_sdk_version "+targetSdkVersion)
Baligh Uddinf6201372020-01-24 23:15:44 +0000663 optFlags = append(optFlags, "--min_sdk_version "+minSdkVersion)
Jiyong Park09d77522019-11-18 11:16:27 +0900664
Baligh Uddin004d7172020-02-19 21:29:28 -0800665 if a.overridableProperties.Logging_parent != "" {
666 optFlags = append(optFlags, "--logging_parent ", a.overridableProperties.Logging_parent)
667 }
668
Bob Badourde6a0872022-04-01 18:00:00 +0000669 // Create a NOTICE file, and embed it as an asset file in the APEX.
Jingwen Chen4a9630b2022-11-16 19:12:35 +0000670 htmlGzNotice := android.PathForModuleOut(ctx, "NOTICE.html.gz")
Bob Badourc6ec9fb2022-06-08 15:59:35 -0700671 android.BuildNoticeHtmlOutputFromLicenseMetadata(
Jingwen Chen4a9630b2022-11-16 19:12:35 +0000672 ctx, htmlGzNotice, "", "",
Bob Badourc6ec9fb2022-06-08 15:59:35 -0700673 []string{
674 android.PathForModuleInstall(ctx).String() + "/",
675 android.PathForModuleInPartitionInstall(ctx, "apex").String() + "/",
676 })
Bob Badour2c8888e2022-04-04 16:12:21 -0700677 noticeAssetPath := android.PathForModuleOut(ctx, "NOTICE", "NOTICE.html.gz")
678 builder := android.NewRuleBuilder(pctx, ctx)
679 builder.Command().Text("cp").
Jingwen Chen4a9630b2022-11-16 19:12:35 +0000680 Input(htmlGzNotice).
Bob Badour2c8888e2022-04-04 16:12:21 -0700681 Output(noticeAssetPath)
682 builder.Build("notice_dir", "Building notice dir")
683 implicitInputs = append(implicitInputs, noticeAssetPath)
684 optFlags = append(optFlags, "--assets_dir "+filepath.Dir(noticeAssetPath.String()))
Jiyong Park09d77522019-11-18 11:16:27 +0900685
Sasha Smundakfe9a5b82022-07-27 14:51:45 -0700686 // Apexes which are supposed to be installed in builtin dirs(/system, etc)
687 // don't need hashtree for activation. Therefore, by removing hashtree from
688 // apex bundle (filesystem image in it, to be specific), we can save storage.
689 needHashTree := moduleMinSdkVersion.LessThanOrEqualTo(android.SdkVersion_Android10) ||
690 a.shouldGenerateHashtree()
691 if ctx.Config().ApexCompressionEnabled() && a.isCompressable() {
692 needHashTree = true
693 }
694 if !needHashTree {
Jiyong Park09d77522019-11-18 11:16:27 +0900695 optFlags = append(optFlags, "--no_hashtree")
696 }
697
Dario Frenica913392020-04-27 18:21:11 +0100698 if a.testOnlyShouldSkipPayloadSign() {
699 optFlags = append(optFlags, "--unsigned_payload")
700 }
701
Dan Albertc8060532020-07-22 22:32:17 -0700702 if moduleMinSdkVersion == android.SdkVersion_Android10 {
Jooyung Han214bf372019-11-12 13:03:50 +0900703 implicitInputs = append(implicitInputs, a.manifestJsonOut)
704 optFlags = append(optFlags, "--manifest_json "+a.manifestJsonOut.String())
705 }
706
Theotime Combes4ba38c12020-06-12 12:46:59 +0000707 optFlags = append(optFlags, "--payload_fs_type "+a.payloadFsType.string())
708
Dennis Shenaf41bc12022-08-03 16:46:43 +0000709 if a.dynamic_common_lib_apex() {
710 ctx.Build(pctx, android.BuildParams{
711 Rule: DCLAApexRule,
712 Implicits: implicitInputs,
713 Output: unsignedOutputFile,
714 Description: "apex (" + apexType.name() + ")",
715 Args: map[string]string{
716 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
717 "image_dir": imageDir.String(),
718 "copy_commands": strings.Join(copyCommands, " && "),
719 "manifest": a.manifestPbOut.String(),
720 "file_contexts": fileContexts.String(),
721 "canned_fs_config": cannedFsConfig.String(),
722 "key": a.privateKeyFile.String(),
723 "opt_flags": strings.Join(optFlags, " "),
724 },
725 })
Dennis Shene2ed70c2023-01-11 14:15:43 +0000726 } else if ctx.Config().ApexTrimEnabled() && len(a.libs_to_trim(ctx)) > 0 {
727 ctx.Build(pctx, android.BuildParams{
728 Rule: TrimmedApexRule,
729 Implicits: implicitInputs,
730 Output: unsignedOutputFile,
731 Description: "apex (" + apexType.name() + ")",
732 Args: map[string]string{
733 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
734 "image_dir": imageDir.String(),
735 "copy_commands": strings.Join(copyCommands, " && "),
736 "manifest": a.manifestPbOut.String(),
737 "file_contexts": fileContexts.String(),
738 "canned_fs_config": cannedFsConfig.String(),
739 "key": a.privateKeyFile.String(),
740 "opt_flags": strings.Join(optFlags, " "),
741 "libs_to_trim": strings.Join(a.libs_to_trim(ctx), ","),
742 },
743 })
Dennis Shenaf41bc12022-08-03 16:46:43 +0000744 } else {
745 ctx.Build(pctx, android.BuildParams{
746 Rule: apexRule,
747 Implicits: implicitInputs,
748 Output: unsignedOutputFile,
749 Description: "apex (" + apexType.name() + ")",
750 Args: map[string]string{
751 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
752 "image_dir": imageDir.String(),
753 "copy_commands": strings.Join(copyCommands, " && "),
754 "manifest": a.manifestPbOut.String(),
755 "file_contexts": fileContexts.String(),
756 "canned_fs_config": cannedFsConfig.String(),
757 "key": a.privateKeyFile.String(),
758 "opt_flags": strings.Join(optFlags, " "),
759 },
760 })
761 }
Jiyong Park09d77522019-11-18 11:16:27 +0900762
Jiyong Parkb81b9902020-11-24 19:51:18 +0900763 // TODO(jiyong): make the two rules below as separate functions
Jaewoong Jung1670ca02019-11-22 14:50:42 -0800764 apexProtoFile := android.PathForModuleOut(ctx, a.Name()+".pb"+suffix)
765 bundleModuleFile := android.PathForModuleOut(ctx, a.Name()+suffix+"-base.zip")
Jiyong Park09d77522019-11-18 11:16:27 +0900766 a.bundleModuleFile = bundleModuleFile
767
768 ctx.Build(pctx, android.BuildParams{
769 Rule: apexProtoConvertRule,
770 Input: unsignedOutputFile,
771 Output: apexProtoFile,
772 Description: "apex proto convert",
773 })
774
sophiezc80a2b32020-11-12 16:39:19 +0000775 implicitInputs = append(implicitInputs, unsignedOutputFile)
776
777 // Run coverage analysis
sophiez6bde0b52021-01-09 01:03:42 +0000778 apisUsedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_using.txt")
sophiezc80a2b32020-11-12 16:39:19 +0000779 ctx.Build(pctx, android.BuildParams{
780 Rule: generateAPIsUsedbyApexRule,
781 Implicits: implicitInputs,
782 Description: "coverage",
783 Output: apisUsedbyOutputFile,
784 Args: map[string]string{
785 "image_dir": imageDir.String(),
786 "readelf": "${config.ClangBin}/llvm-readelf",
787 },
788 })
sophiez02347372021-11-02 17:58:02 -0700789 a.nativeApisUsedByModuleFile = apisUsedbyOutputFile
sophiez6bde0b52021-01-09 01:03:42 +0000790
sophiez02347372021-11-02 17:58:02 -0700791 var nativeLibNames []string
Colin Cross69f0a242021-02-08 16:49:57 -0800792 for _, f := range a.filesInfo {
793 if f.class == nativeSharedLib {
sophiez02347372021-11-02 17:58:02 -0700794 nativeLibNames = append(nativeLibNames, f.stem())
Colin Cross69f0a242021-02-08 16:49:57 -0800795 }
796 }
sophiez6bde0b52021-01-09 01:03:42 +0000797 apisBackedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_backing.txt")
sophiez6bde0b52021-01-09 01:03:42 +0000798 rule := android.NewRuleBuilder(pctx, ctx)
799 rule.Command().
800 Tool(android.PathForSource(ctx, "build/soong/scripts/gen_ndk_backedby_apex.sh")).
sophiez6bde0b52021-01-09 01:03:42 +0000801 Output(apisBackedbyOutputFile).
sophiez02347372021-11-02 17:58:02 -0700802 Flags(nativeLibNames)
sophiez6bde0b52021-01-09 01:03:42 +0000803 rule.Build("ndk_backedby_list", "Generate API libraries backed by Apex")
sophiez02347372021-11-02 17:58:02 -0700804 a.nativeApisBackedByModuleFile = apisBackedbyOutputFile
805
806 var javaLibOrApkPath []android.Path
807 for _, f := range a.filesInfo {
808 if f.class == javaSharedLib || f.class == app {
809 javaLibOrApkPath = append(javaLibOrApkPath, f.builtFile)
810 }
811 }
812 javaApiUsedbyOutputFile := android.PathForModuleOut(ctx, a.Name()+"_using.xml")
813 javaUsedByRule := android.NewRuleBuilder(pctx, ctx)
814 javaUsedByRule.Command().
815 Tool(android.PathForSource(ctx, "build/soong/scripts/gen_java_usedby_apex.sh")).
816 BuiltTool("dexdeps").
817 Output(javaApiUsedbyOutputFile).
818 Inputs(javaLibOrApkPath)
819 javaUsedByRule.Build("java_usedby_list", "Generate Java APIs used by Apex")
820 a.javaApisUsedByModuleFile = javaApiUsedbyOutputFile
sophiezc80a2b32020-11-12 16:39:19 +0000821
Jiyong Parkbd159612020-02-28 15:22:21 +0900822 bundleConfig := a.buildBundleConfig(ctx)
823
Jiyong Parkb81b9902020-11-24 19:51:18 +0900824 var abis []string
825 for _, target := range ctx.MultiTargets() {
826 if len(target.Arch.Abi) > 0 {
827 abis = append(abis, target.Arch.Abi[0])
828 }
829 }
830
831 abis = android.FirstUniqueStrings(abis)
832
Jiyong Park09d77522019-11-18 11:16:27 +0900833 ctx.Build(pctx, android.BuildParams{
834 Rule: apexBundleRule,
835 Input: apexProtoFile,
Jiyong Parkbd159612020-02-28 15:22:21 +0900836 Implicit: bundleConfig,
Jiyong Park09d77522019-11-18 11:16:27 +0900837 Output: a.bundleModuleFile,
838 Description: "apex bundle module",
839 Args: map[string]string{
Jiyong Parkbd159612020-02-28 15:22:21 +0900840 "abi": strings.Join(abis, "."),
841 "config": bundleConfig.String(),
Jiyong Park09d77522019-11-18 11:16:27 +0900842 },
843 })
Jiyong Parkb81b9902020-11-24 19:51:18 +0900844 } else { // zipApex
Jiyong Park09d77522019-11-18 11:16:27 +0900845 ctx.Build(pctx, android.BuildParams{
846 Rule: zipApexRule,
847 Implicits: implicitInputs,
848 Output: unsignedOutputFile,
849 Description: "apex (" + apexType.name() + ")",
850 Args: map[string]string{
Oriol Prieto Gasco17e22902022-05-05 13:52:25 +0000851 "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir,
852 "image_dir": imageDir.String(),
853 "copy_commands": strings.Join(copyCommands, " && "),
854 "manifest": a.manifestPbOut.String(),
Jiyong Park09d77522019-11-18 11:16:27 +0900855 },
856 })
857 }
858
Jiyong Parkb81b9902020-11-24 19:51:18 +0900859 ////////////////////////////////////////////////////////////////////////////////////
860 // Step 4: Sign the APEX using signapk
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000861 signedOutputFile := android.PathForModuleOut(ctx, a.Name()+suffix)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900862
863 pem, key := a.getCertificateAndPrivateKey(ctx)
Kousik Kumar309b1c02020-05-28 06:13:33 -0700864 rule := java.Signapk
865 args := map[string]string{
Jiyong Parkb81b9902020-11-24 19:51:18 +0900866 "certificates": pem.String() + " " + key.String(),
Jooyung Han5d00f502021-07-11 07:26:22 +0900867 "flags": "-a 4096 --align-file-size", //alignment
Kousik Kumar309b1c02020-05-28 06:13:33 -0700868 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900869 implicits := android.Paths{pem, key}
Ramy Medhat16f23a42020-09-03 01:29:49 -0400870 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_SIGNAPK") {
Kousik Kumar309b1c02020-05-28 06:13:33 -0700871 rule = java.SignapkRE
872 args["implicits"] = strings.Join(implicits.Strings(), ",")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000873 args["outCommaList"] = signedOutputFile.String()
Kousik Kumar309b1c02020-05-28 06:13:33 -0700874 }
Jiyong Park09d77522019-11-18 11:16:27 +0900875 ctx.Build(pctx, android.BuildParams{
Kousik Kumar309b1c02020-05-28 06:13:33 -0700876 Rule: rule,
Jiyong Park09d77522019-11-18 11:16:27 +0900877 Description: "signapk",
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000878 Output: signedOutputFile,
Jiyong Park09d77522019-11-18 11:16:27 +0900879 Input: unsignedOutputFile,
Kousik Kumar309b1c02020-05-28 06:13:33 -0700880 Implicits: implicits,
881 Args: args,
Jiyong Park09d77522019-11-18 11:16:27 +0900882 })
Jooyung Hana6d36672022-02-24 13:58:07 +0900883 if suffix == imageApexSuffix {
884 a.outputApexFile = signedOutputFile
885 }
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000886 a.outputFile = signedOutputFile
887
Mohammad Samiul Islama8008f92020-12-22 10:47:50 +0000888 if ctx.ModuleDir() != "system/apex/apexd/apexd_testdata" && a.testOnlyShouldForceCompression() {
889 ctx.PropertyErrorf("test_only_force_compression", "not available")
890 return
891 }
Nikita Ioffebc035882021-04-14 21:35:24 +0100892
Sasha Smundakfe9a5b82022-07-27 14:51:45 -0700893 installSuffix := suffix
894 a.setCompression(ctx)
895 if a.isCompressed {
Samiul Islam7c02e262021-09-08 17:48:28 +0100896 unsignedCompressedOutputFile := android.PathForModuleOut(ctx, a.Name()+imageCapexSuffix+".unsigned")
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000897
898 compressRule := android.NewRuleBuilder(pctx, ctx)
899 compressRule.Command().
900 Text("rm").
901 FlagWithOutput("-f ", unsignedCompressedOutputFile)
902 compressRule.Command().
903 BuiltTool("apex_compression_tool").
904 Flag("compress").
905 FlagWithArg("--apex_compression_tool ", outHostBinDir+":"+prebuiltSdkToolsBinDir).
906 FlagWithInput("--input ", signedOutputFile).
907 FlagWithOutput("--output ", unsignedCompressedOutputFile)
908 compressRule.Build("compressRule", "Generate unsigned compressed APEX file")
909
Samiul Islam7c02e262021-09-08 17:48:28 +0100910 signedCompressedOutputFile := android.PathForModuleOut(ctx, a.Name()+imageCapexSuffix)
Mohammad Samiul Islam9ac0e322021-01-19 11:32:29 +0000911 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_SIGNAPK") {
912 args["outCommaList"] = signedCompressedOutputFile.String()
913 }
Mohammad Samiul Islam3cd005d2020-11-26 13:32:26 +0000914 ctx.Build(pctx, android.BuildParams{
915 Rule: rule,
916 Description: "sign compressedApex",
917 Output: signedCompressedOutputFile,
918 Input: unsignedCompressedOutputFile,
919 Implicits: implicits,
920 Args: args,
921 })
922 a.outputFile = signedCompressedOutputFile
Martin Stjernholm8a3c9142022-07-26 09:35:39 +0000923 installSuffix = imageCapexSuffix
924 }
925
Colin Crossd9ccb6a2022-03-07 18:38:34 -0800926 if !a.installable() {
927 a.SkipInstall()
928 }
929
Jiyong Park17ff2832021-09-27 12:50:30 +0900930 // Install to $OUT/soong/{target,host}/.../apex.
Martin Stjernholm8a3c9142022-07-26 09:35:39 +0000931 a.installedFile = ctx.InstallFile(a.installDir, a.Name()+installSuffix, a.outputFile,
Colin Cross6340ea52021-11-04 12:01:18 -0700932 a.compatSymlinks.Paths()...)
Jiyong Park3a1602e2020-01-14 14:39:19 +0900933
934 // installed-files.txt is dist'ed
935 a.installedFilesFile = a.buildInstalledFilesFile(ctx, a.outputFile, imageDir)
Jiyong Park09d77522019-11-18 11:16:27 +0900936}
937
Jiyong Parkb81b9902020-11-24 19:51:18 +0900938// buildFlattenedApex creates rules for a flattened APEX. Flattened APEX actually doesn't have a
939// single output file. It is a phony target for all the files under /system/apex/<name> directory.
940// This function creates the installation rules for the files.
Jiyong Park09d77522019-11-18 11:16:27 +0900941func (a *apexBundle) buildFlattenedApex(ctx android.ModuleContext) {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900942 bundleName := a.Name()
Colin Cross6340ea52021-11-04 12:01:18 -0700943 installedSymlinks := append(android.InstallPaths(nil), a.compatSymlinks...)
Jiyong Park09d77522019-11-18 11:16:27 +0900944 if a.installable() {
Jiyong Parkb81b9902020-11-24 19:51:18 +0900945 for _, fi := range a.filesInfo {
946 dir := filepath.Join("apex", bundleName, fi.installDir)
Colin Cross6340ea52021-11-04 12:01:18 -0700947 installDir := android.PathForModuleInstall(ctx, dir)
948 if a.linkToSystemLib && fi.transitiveDep && fi.availableToPlatform() {
949 // TODO(jiyong): pathOnDevice should come from fi.module, not being calculated here
950 pathOnDevice := filepath.Join("/system", fi.path())
951 installedSymlinks = append(installedSymlinks,
952 ctx.InstallAbsoluteSymlink(installDir, fi.stem(), pathOnDevice))
953 } else {
Jiyong Parkf648d532022-10-19 18:18:56 +0900954 if fi.class == appSet {
955 as := fi.module.(*java.AndroidAppSet)
956 ctx.InstallFileWithExtraFilesZip(installDir, as.BaseModuleName()+".apk",
957 as.OutputFile(), as.PackedAdditionalOutputs())
958 } else {
959 target := ctx.InstallFile(installDir, fi.stem(), fi.builtFile)
960 for _, sym := range fi.symlinks {
961 installedSymlinks = append(installedSymlinks,
962 ctx.InstallSymlink(installDir, sym, target))
963 }
Colin Cross6340ea52021-11-04 12:01:18 -0700964 }
Jiyong Park09d77522019-11-18 11:16:27 +0900965 }
966 }
Colin Cross6340ea52021-11-04 12:01:18 -0700967
968 // Create install rules for the files added in GenerateAndroidBuildActions after
969 // buildFlattenedApex is called. Add the links to system libs (if any) as dependencies
970 // of the apex_manifest.pb file since it is always present.
971 dir := filepath.Join("apex", bundleName)
972 installDir := android.PathForModuleInstall(ctx, dir)
973 ctx.InstallFile(installDir, "apex_manifest.pb", a.manifestPbOut, installedSymlinks.Paths()...)
974 ctx.InstallFile(installDir, "apex_pubkey", a.publicKeyFile)
Jiyong Park09d77522019-11-18 11:16:27 +0900975 }
Jiyong Parkb81b9902020-11-24 19:51:18 +0900976
977 a.fileContexts = a.buildFileContexts(ctx)
978
Colin Cross6340ea52021-11-04 12:01:18 -0700979 a.outputFile = android.PathForModuleInstall(ctx, "apex", bundleName)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900980}
981
982// getCertificateAndPrivateKey retrieves the cert and the private key that will be used to sign
983// the zip container of this APEX. See the description of the 'certificate' property for how
984// the cert and the private key are found.
985func (a *apexBundle) getCertificateAndPrivateKey(ctx android.PathContext) (pem, key android.Path) {
Jaewoong Jung18aefc12020-12-21 09:11:10 -0800986 if a.containerCertificateFile != nil {
987 return a.containerCertificateFile, a.containerPrivateKeyFile
Jiyong Parkb81b9902020-11-24 19:51:18 +0900988 }
989
Jaewoong Jung4cfdf7d2021-04-20 16:21:24 -0700990 cert := String(a.overridableProperties.Certificate)
Jiyong Parkb81b9902020-11-24 19:51:18 +0900991 if cert == "" {
992 return ctx.Config().DefaultAppCertificate(ctx)
993 }
994
995 defaultDir := ctx.Config().DefaultAppCertificateDir(ctx)
996 pem = defaultDir.Join(ctx, cert+".x509.pem")
997 key = defaultDir.Join(ctx, cert+".pk8")
998 return pem, key
Jiyong Park09d77522019-11-18 11:16:27 +0900999}
Jooyung Han27151d92019-12-16 17:45:32 +09001000
1001func (a *apexBundle) getOverrideManifestPackageName(ctx android.ModuleContext) string {
1002 // For VNDK APEXes, check "com.android.vndk" in PRODUCT_MANIFEST_PACKAGE_NAME_OVERRIDES
1003 // to see if it should be overridden because their <apex name> is dynamically generated
1004 // according to its VNDK version.
1005 if a.vndkApex {
1006 overrideName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(vndkApexName)
1007 if overridden {
Jooyung Han2cd2f9a2023-02-06 18:29:08 +09001008 return overrideName + ".v" + a.vndkVersion(ctx.DeviceConfig())
Jooyung Han27151d92019-12-16 17:45:32 +09001009 }
1010 return ""
1011 }
Baligh Uddin5b57dba2020-03-15 13:01:05 -07001012 if a.overridableProperties.Package_name != "" {
1013 return a.overridableProperties.Package_name
1014 }
Jiyong Park20bacab2020-03-03 11:45:41 +09001015 manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName())
Jooyung Han27151d92019-12-16 17:45:32 +09001016 if overridden {
1017 return manifestPackageName
1018 }
1019 return ""
1020}
Jiyong Park83dc74b2020-01-14 18:38:44 +09001021
1022func (a *apexBundle) buildApexDependencyInfo(ctx android.ModuleContext) {
1023 if !a.primaryApexType {
1024 return
1025 }
1026
1027 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
1033 if ctx.Host() {
1034 // No need to generate dependency info for host variant
1035 return
1036 }
1037
Artur Satayev872a1442020-04-27 17:08:37 +01001038 depInfos := android.DepNameToDepInfoMap{}
Jooyung Han749dc692020-04-15 11:03:39 +09001039 a.WalkPayloadDeps(ctx, func(ctx android.ModuleContext, from blueprint.Module, to android.ApexModule, externalDep bool) bool {
Artur Satayev872a1442020-04-27 17:08:37 +01001040 if from.Name() == to.Name() {
1041 // This can happen for cc.reuseObjTag. We are not interested in tracking this.
1042 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1043 return !externalDep
Jiyong Park678c8812020-02-07 17:25:49 +09001044 }
Jiyong Park83dc74b2020-01-14 18:38:44 +09001045
Artur Satayev533b98c2021-03-11 18:03:42 +00001046 // Skip dependencies that are only available to APEXes; they are developed with updatability
1047 // in mind and don't need manual approval.
1048 if to.(android.ApexModule).NotAvailableForPlatform() {
1049 return !externalDep
1050 }
1051
Cindy Zhou18417cb2020-12-10 07:12:38 -08001052 depTag := ctx.OtherModuleDependencyTag(to)
Artur Satayev533b98c2021-03-11 18:03:42 +00001053 // Check to see if dependency been marked to skip the dependency check
Cindy Zhou18417cb2020-12-10 07:12:38 -08001054 if skipDepCheck, ok := depTag.(android.SkipApexAllowedDependenciesCheck); ok && skipDepCheck.SkipApexAllowedDependenciesCheck() {
Cindy Zhou18417cb2020-12-10 07:12:38 -08001055 return !externalDep
1056 }
1057
Artur Satayev872a1442020-04-27 17:08:37 +01001058 if info, exists := depInfos[to.Name()]; exists {
1059 if !android.InList(from.Name(), info.From) {
1060 info.From = append(info.From, from.Name())
1061 }
1062 info.IsExternal = info.IsExternal && externalDep
1063 depInfos[to.Name()] = info
1064 } else {
Artur Satayev480e25b2020-04-27 18:53:18 +01001065 toMinSdkVersion := "(no version)"
Jiyong Park92315372021-04-02 08:45:46 +09001066 if m, ok := to.(interface {
1067 MinSdkVersion(ctx android.EarlyModuleContext) android.SdkSpec
1068 }); ok {
1069 if v := m.MinSdkVersion(ctx); !v.ApiLevel.IsNone() {
1070 toMinSdkVersion = v.ApiLevel.String()
1071 }
1072 } else if m, ok := to.(interface{ MinSdkVersion() string }); ok {
1073 // TODO(b/175678607) eliminate the use of MinSdkVersion returning
1074 // string
Artur Satayev480e25b2020-04-27 18:53:18 +01001075 if v := m.MinSdkVersion(); v != "" {
1076 toMinSdkVersion = v
1077 }
1078 }
Artur Satayev872a1442020-04-27 17:08:37 +01001079 depInfos[to.Name()] = android.ApexModuleDepInfo{
Artur Satayev480e25b2020-04-27 18:53:18 +01001080 To: to.Name(),
1081 From: []string{from.Name()},
1082 IsExternal: externalDep,
1083 MinSdkVersion: toMinSdkVersion,
Artur Satayev872a1442020-04-27 17:08:37 +01001084 }
1085 }
1086
1087 // As soon as the dependency graph crosses the APEX boundary, don't go further.
1088 return !externalDep
Jiyong Park83dc74b2020-01-14 18:38:44 +09001089 })
1090
Albert Martineefabcf2022-03-21 20:11:16 +00001091 a.ApexBundleDepsInfo.BuildDepsInfoLists(ctx, a.MinSdkVersion(ctx).Raw, depInfos)
Artur Satayev872a1442020-04-27 17:08:37 +01001092
Jiyong Park83dc74b2020-01-14 18:38:44 +09001093 ctx.Build(pctx, android.BuildParams{
1094 Rule: android.Phony,
1095 Output: android.PathForPhony(ctx, a.Name()+"-deps-info"),
Artur Satayeva8bd1132020-04-27 18:07:06 +01001096 Inputs: []android.Path{
1097 a.ApexBundleDepsInfo.FullListPath(),
1098 a.ApexBundleDepsInfo.FlatListPath(),
1099 },
Jiyong Park83dc74b2020-01-14 18:38:44 +09001100 })
1101}
Colin Cross08dca382020-07-21 20:31:17 -07001102
1103func (a *apexBundle) buildLintReports(ctx android.ModuleContext) {
1104 depSetsBuilder := java.NewLintDepSetBuilder()
1105 for _, fi := range a.filesInfo {
1106 depSetsBuilder.Transitive(fi.lintDepSets)
1107 }
1108
1109 a.lintReports = java.BuildModuleLintReportZips(ctx, depSetsBuilder.Build())
1110}
Jiyong Park1b0893e2021-12-13 23:40:17 +09001111
1112func (a *apexBundle) buildCannedFsConfig(ctx android.ModuleContext) android.OutputPath {
1113 var readOnlyPaths = []string{"apex_manifest.json", "apex_manifest.pb"}
1114 var executablePaths []string // this also includes dirs
1115 var appSetDirs []string
1116 appSetFiles := make(map[string]android.Path)
1117 for _, f := range a.filesInfo {
1118 pathInApex := f.path()
1119 if f.installDir == "bin" || strings.HasPrefix(f.installDir, "bin/") {
1120 executablePaths = append(executablePaths, pathInApex)
1121 for _, d := range f.dataPaths {
1122 readOnlyPaths = append(readOnlyPaths, filepath.Join(f.installDir, d.RelativeInstallPath, d.SrcPath.Rel()))
1123 }
1124 for _, s := range f.symlinks {
1125 executablePaths = append(executablePaths, filepath.Join(f.installDir, s))
1126 }
1127 } else if f.class == appSet {
Jiyong Park4169a252022-09-29 21:30:25 +09001128 // base APK
1129 readOnlyPaths = append(readOnlyPaths, pathInApex)
1130 // Additional APKs
Jiyong Park1b0893e2021-12-13 23:40:17 +09001131 appSetDirs = append(appSetDirs, f.installDir)
Jiyong Parke1b69142022-09-26 14:48:56 +09001132 appSetFiles[f.installDir] = f.module.(*java.AndroidAppSet).PackedAdditionalOutputs()
Jiyong Park1b0893e2021-12-13 23:40:17 +09001133 } else {
1134 readOnlyPaths = append(readOnlyPaths, pathInApex)
1135 }
1136 dir := f.installDir
1137 for !android.InList(dir, executablePaths) && dir != "" {
1138 executablePaths = append(executablePaths, dir)
1139 dir, _ = filepath.Split(dir) // move up to the parent
1140 if len(dir) > 0 {
1141 // remove trailing slash
1142 dir = dir[:len(dir)-1]
1143 }
1144 }
1145 }
1146 sort.Strings(readOnlyPaths)
1147 sort.Strings(executablePaths)
1148 sort.Strings(appSetDirs)
1149
1150 cannedFsConfig := android.PathForModuleOut(ctx, "canned_fs_config")
1151 builder := android.NewRuleBuilder(pctx, ctx)
1152 cmd := builder.Command()
1153 cmd.Text("(")
1154 cmd.Text("echo '/ 1000 1000 0755';")
1155 for _, p := range readOnlyPaths {
1156 cmd.Textf("echo '/%s 1000 1000 0644';", p)
1157 }
1158 for _, p := range executablePaths {
1159 cmd.Textf("echo '/%s 0 2000 0755';", p)
1160 }
1161 for _, dir := range appSetDirs {
1162 cmd.Textf("echo '/%s 0 2000 0755';", dir)
1163 file := appSetFiles[dir]
1164 cmd.Text("zipinfo -1").Input(file).Textf(`| sed "s:\(.*\):/%s/\1 1000 1000 0644:";`, dir)
1165 }
Jiyong Park038e8522021-12-13 23:56:35 +09001166 // Custom fs_config is "appended" to the last so that entries from the file are preferred
1167 // over default ones set above.
1168 if a.properties.Canned_fs_config != nil {
1169 cmd.Text("cat").Input(android.PathForModuleSrc(ctx, *a.properties.Canned_fs_config))
1170 }
Sasha Smundakd6322932023-01-11 19:37:31 -08001171 cmd.Text(") | LC_ALL=C sort ").FlagWithOutput("> ", cannedFsConfig)
Jiyong Park1b0893e2021-12-13 23:40:17 +09001172 builder.Build("generateFsConfig", fmt.Sprintf("Generating canned fs config for %s", a.BaseModuleName()))
1173
1174 return cannedFsConfig.OutputPath
1175}