From 09d77522fec392b5b94e5819438315447d70012a Mon Sep 17 00:00:00 2001 From: Jiyong Park Date: Mon, 18 Nov 2019 11:16:27 +0900 Subject: [PATCH] split apex.go apex.go is too big. Separate the build rule and android.mk generation logic into builder.go and androidmk.go, respectively. prebuilt_apex is moved to prebuilt.go as well. No refactoring has been made other than the splitting. Test: m Change-Id: I839ab0a1ba2b70ce82d98ac1fa8e3534808b5fd3 --- Android.bp | 4 + apex/androidmk.go | 205 ++++++++++ apex/apex.go | 958 ---------------------------------------------- apex/builder.go | 531 +++++++++++++++++++++++++ apex/prebuilt.go | 198 ++++++++++ apex/vndk.go | 132 +++++++ 6 files changed, 1070 insertions(+), 958 deletions(-) create mode 100644 apex/androidmk.go create mode 100644 apex/builder.go create mode 100644 apex/prebuilt.go create mode 100644 apex/vndk.go diff --git a/Android.bp b/Android.bp index c73c3dace..72592554b 100644 --- a/Android.bp +++ b/Android.bp @@ -458,8 +458,12 @@ bootstrap_go_package { "soong-python", ], srcs: [ + "apex/androidmk.go", "apex/apex.go", + "apex/builder.go", "apex/key.go", + "apex/prebuilt.go", + "apex/vndk.go", ], testSrcs: [ "apex/apex_test.go", diff --git a/apex/androidmk.go b/apex/androidmk.go new file mode 100644 index 000000000..8ebf80295 --- /dev/null +++ b/apex/androidmk.go @@ -0,0 +1,205 @@ +// Copyright (C) 2019 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package apex + +import ( + "fmt" + "io" + "path/filepath" + "strings" + + "android/soong/android" + "android/soong/cc" + "android/soong/java" + + "github.com/google/blueprint/proptools" +) + +func (a *apexBundle) AndroidMk() android.AndroidMkData { + if a.properties.HideFromMake { + return android.AndroidMkData{ + Disabled: true, + } + } + writers := []android.AndroidMkData{} + writers = append(writers, a.androidMkForType()) + return android.AndroidMkData{ + Custom: func(w io.Writer, name, prefix, moduleDir string, data android.AndroidMkData) { + for _, data := range writers { + data.Custom(w, name, prefix, moduleDir, data) + } + }} +} + +func (a *apexBundle) androidMkForFiles(w io.Writer, apexName, moduleDir string) []string { + moduleNames := []string{} + apexType := a.properties.ApexType + // To avoid creating duplicate build rules, run this function only when primaryApexType is true + // to install symbol files in $(PRODUCT_OUT}/apex. + // And if apexType is flattened, run this function to install files in $(PRODUCT_OUT}/system/apex. + if !a.primaryApexType && apexType != flattenedApex { + return moduleNames + } + + for _, fi := range a.filesInfo { + if cc, ok := fi.module.(*cc.Module); ok && cc.Properties.HideFromMake { + continue + } + + if !android.InList(fi.moduleName, moduleNames) { + moduleNames = append(moduleNames, fi.moduleName) + } + + fmt.Fprintln(w, "\ninclude $(CLEAR_VARS)") + fmt.Fprintln(w, "LOCAL_PATH :=", moduleDir) + fmt.Fprintln(w, "LOCAL_MODULE :=", fi.moduleName) + // /apex//{lib|framework|...} + pathWhenActivated := filepath.Join("$(PRODUCT_OUT)", "apex", apexName, fi.installDir) + if apexType == flattenedApex { + // /system/apex//{lib|framework|...} + fmt.Fprintln(w, "LOCAL_MODULE_PATH :=", filepath.Join(a.installDir.ToMakePath().String(), + apexName, fi.installDir)) + if a.primaryApexType { + fmt.Fprintln(w, "LOCAL_SOONG_SYMBOL_PATH :=", pathWhenActivated) + } + if len(fi.symlinks) > 0 { + fmt.Fprintln(w, "LOCAL_MODULE_SYMLINKS :=", strings.Join(fi.symlinks, " ")) + } + + if fi.module != nil && fi.module.NoticeFile().Valid() { + fmt.Fprintln(w, "LOCAL_NOTICE_FILE :=", fi.module.NoticeFile().Path().String()) + } + } else { + fmt.Fprintln(w, "LOCAL_MODULE_PATH :=", pathWhenActivated) + } + fmt.Fprintln(w, "LOCAL_PREBUILT_MODULE_FILE :=", fi.builtFile.String()) + fmt.Fprintln(w, "LOCAL_MODULE_CLASS :=", fi.class.NameInMake()) + if fi.module != nil { + archStr := fi.module.Target().Arch.ArchType.String() + host := false + switch fi.module.Target().Os.Class { + case android.Host: + if fi.module.Target().Arch.ArchType != android.Common { + fmt.Fprintln(w, "LOCAL_MODULE_HOST_ARCH :=", archStr) + } + host = true + case android.HostCross: + if fi.module.Target().Arch.ArchType != android.Common { + fmt.Fprintln(w, "LOCAL_MODULE_HOST_CROSS_ARCH :=", archStr) + } + host = true + case android.Device: + if fi.module.Target().Arch.ArchType != android.Common { + fmt.Fprintln(w, "LOCAL_MODULE_TARGET_ARCH :=", archStr) + } + } + if host { + makeOs := fi.module.Target().Os.String() + if fi.module.Target().Os == android.Linux || fi.module.Target().Os == android.LinuxBionic { + makeOs = "linux" + } + fmt.Fprintln(w, "LOCAL_MODULE_HOST_OS :=", makeOs) + fmt.Fprintln(w, "LOCAL_IS_HOST_MODULE := true") + } + } + if fi.class == javaSharedLib { + javaModule := fi.module.(*java.Library) + // soong_java_prebuilt.mk sets LOCAL_MODULE_SUFFIX := .jar Therefore + // we need to remove the suffix from LOCAL_MODULE_STEM, otherwise + // we will have foo.jar.jar + fmt.Fprintln(w, "LOCAL_MODULE_STEM :=", strings.TrimSuffix(fi.builtFile.Base(), ".jar")) + fmt.Fprintln(w, "LOCAL_SOONG_CLASSES_JAR :=", javaModule.ImplementationAndResourcesJars()[0].String()) + fmt.Fprintln(w, "LOCAL_SOONG_HEADER_JAR :=", javaModule.HeaderJars()[0].String()) + fmt.Fprintln(w, "LOCAL_SOONG_DEX_JAR :=", fi.builtFile.String()) + fmt.Fprintln(w, "LOCAL_DEX_PREOPT := false") + fmt.Fprintln(w, "include $(BUILD_SYSTEM)/soong_java_prebuilt.mk") + } else if fi.class == nativeSharedLib || fi.class == nativeExecutable || fi.class == nativeTest { + fmt.Fprintln(w, "LOCAL_MODULE_STEM :=", fi.builtFile.Base()) + if cc, ok := fi.module.(*cc.Module); ok { + if cc.UnstrippedOutputFile() != nil { + fmt.Fprintln(w, "LOCAL_SOONG_UNSTRIPPED_BINARY :=", cc.UnstrippedOutputFile().String()) + } + cc.AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w) + if cc.CoverageOutputFile().Valid() { + fmt.Fprintln(w, "LOCAL_PREBUILT_COVERAGE_ARCHIVE :=", cc.CoverageOutputFile().String()) + } + } + fmt.Fprintln(w, "include $(BUILD_SYSTEM)/soong_cc_prebuilt.mk") + } else { + fmt.Fprintln(w, "LOCAL_MODULE_STEM :=", fi.builtFile.Base()) + // For flattened apexes, compat symlinks are attached to apex_manifest.json which is guaranteed for every apex + if a.primaryApexType && fi.builtFile == a.manifestPbOut && len(a.compatSymlinks) > 0 { + fmt.Fprintln(w, "LOCAL_POST_INSTALL_CMD :=", strings.Join(a.compatSymlinks, " && ")) + } + fmt.Fprintln(w, "include $(BUILD_PREBUILT)") + } + } + return moduleNames +} + +func (a *apexBundle) androidMkForType() android.AndroidMkData { + return android.AndroidMkData{ + Custom: func(w io.Writer, name, prefix, moduleDir string, data android.AndroidMkData) { + moduleNames := []string{} + apexType := a.properties.ApexType + if a.installable() { + apexName := proptools.StringDefault(a.properties.Apex_name, name) + moduleNames = a.androidMkForFiles(w, apexName, moduleDir) + } + + if apexType == flattenedApex { + // Only image APEXes can be flattened. + fmt.Fprintln(w, "\ninclude $(CLEAR_VARS)") + fmt.Fprintln(w, "LOCAL_PATH :=", moduleDir) + fmt.Fprintln(w, "LOCAL_MODULE :=", name+a.suffix) + if len(moduleNames) > 0 { + fmt.Fprintln(w, "LOCAL_REQUIRED_MODULES :=", strings.Join(moduleNames, " ")) + } + fmt.Fprintln(w, "include $(BUILD_PHONY_PACKAGE)") + fmt.Fprintln(w, "$(LOCAL_INSTALLED_MODULE): .KATI_IMPLICIT_OUTPUTS :=", a.outputFile.String()) + + } else { + fmt.Fprintln(w, "\ninclude $(CLEAR_VARS)") + fmt.Fprintln(w, "LOCAL_PATH :=", moduleDir) + fmt.Fprintln(w, "LOCAL_MODULE :=", name+a.suffix) + fmt.Fprintln(w, "LOCAL_MODULE_CLASS := ETC") // do we need a new class? + fmt.Fprintln(w, "LOCAL_PREBUILT_MODULE_FILE :=", a.outputFile.String()) + fmt.Fprintln(w, "LOCAL_MODULE_PATH :=", a.installDir.ToMakePath().String()) + fmt.Fprintln(w, "LOCAL_MODULE_STEM :=", name+apexType.suffix()) + fmt.Fprintln(w, "LOCAL_UNINSTALLABLE_MODULE :=", !a.installable()) + if len(moduleNames) > 0 { + fmt.Fprintln(w, "LOCAL_REQUIRED_MODULES +=", strings.Join(moduleNames, " ")) + } + if len(a.externalDeps) > 0 { + fmt.Fprintln(w, "LOCAL_REQUIRED_MODULES +=", strings.Join(a.externalDeps, " ")) + } + var postInstallCommands []string + if a.prebuiltFileToDelete != "" { + postInstallCommands = append(postInstallCommands, "rm -rf "+ + filepath.Join(a.installDir.ToMakePath().String(), a.prebuiltFileToDelete)) + } + // For unflattened apexes, compat symlinks are attached to apex package itself as LOCAL_POST_INSTALL_CMD + postInstallCommands = append(postInstallCommands, a.compatSymlinks...) + if len(postInstallCommands) > 0 { + fmt.Fprintln(w, "LOCAL_POST_INSTALL_CMD :=", strings.Join(postInstallCommands, " && ")) + } + fmt.Fprintln(w, "include $(BUILD_PREBUILT)") + + if apexType == imageApex { + fmt.Fprintln(w, "ALL_MODULES.$(LOCAL_MODULE).BUNDLE :=", a.bundleModuleFile.String()) + } + } + }} +} diff --git a/apex/apex.go b/apex/apex.go index d9dd5a936..c021e1de9 100644 --- a/apex/apex.go +++ b/apex/apex.go @@ -16,9 +16,7 @@ package apex import ( "fmt" - "io" "path/filepath" - "runtime" "sort" "strings" "sync" @@ -33,113 +31,6 @@ import ( "github.com/google/blueprint/proptools" ) -var ( - pctx = android.NewPackageContext("android/apex") - - // Create a canned fs config file where all files and directories are - // by default set to (uid/gid/mode) = (1000/1000/0644) - // TODO(b/113082813) make this configurable using config.fs syntax - generateFsConfig = pctx.StaticRule("generateFsConfig", blueprint.RuleParams{ - Command: `echo '/ 1000 1000 0755' > ${out} && ` + - `echo ${ro_paths} | tr ' ' '\n' | awk '{print "/"$$1 " 1000 1000 0644"}' >> ${out} && ` + - `echo ${exec_paths} | tr ' ' '\n' | awk '{print "/"$$1 " 0 2000 0755"}' >> ${out}`, - Description: "fs_config ${out}", - }, "ro_paths", "exec_paths") - - apexManifestRule = pctx.StaticRule("apexManifestRule", blueprint.RuleParams{ - Command: `rm -f $out && ${jsonmodify} $in ` + - `-a provideNativeLibs ${provideNativeLibs} ` + - `-a requireNativeLibs ${requireNativeLibs} ` + - `${opt} ` + - `-o $out`, - CommandDeps: []string{"${jsonmodify}"}, - Description: "prepare ${out}", - }, "provideNativeLibs", "requireNativeLibs", "opt") - - stripApexManifestRule = pctx.StaticRule("stripApexManifestRule", blueprint.RuleParams{ - Command: `rm -f $out && ${conv_apex_manifest} strip $in -o $out`, - CommandDeps: []string{"${conv_apex_manifest}"}, - Description: "strip ${in}=>${out}", - }) - - pbApexManifestRule = pctx.StaticRule("pbApexManifestRule", blueprint.RuleParams{ - Command: `rm -f $out && ${conv_apex_manifest} proto $in -o $out`, - CommandDeps: []string{"${conv_apex_manifest}"}, - Description: "convert ${in}=>${out}", - }) - - // TODO(b/113233103): make sure that file_contexts is sane, i.e., validate - // against the binary policy using sefcontext_compiler -p . - - // TODO(b/114327326): automate the generation of file_contexts - apexRule = pctx.StaticRule("apexRule", blueprint.RuleParams{ - Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` + - `(. ${out}.copy_commands) && ` + - `APEXER_TOOL_PATH=${tool_path} ` + - `${apexer} --force --manifest ${manifest} ` + - `--manifest_json ${manifest_json} --manifest_json_full ${manifest_json_full} ` + - `--file_contexts ${file_contexts} ` + - `--canned_fs_config ${canned_fs_config} ` + - `--payload_type image ` + - `--key ${key} ${opt_flags} ${image_dir} ${out} `, - CommandDeps: []string{"${apexer}", "${avbtool}", "${e2fsdroid}", "${merge_zips}", - "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", - "${soong_zip}", "${zipalign}", "${aapt2}", "prebuilts/sdk/current/public/android.jar"}, - Rspfile: "${out}.copy_commands", - RspfileContent: "${copy_commands}", - Description: "APEX ${image_dir} => ${out}", - }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key", "opt_flags", - "manifest", "manifest_json", "manifest_json_full", - ) - - zipApexRule = pctx.StaticRule("zipApexRule", blueprint.RuleParams{ - Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` + - `(. ${out}.copy_commands) && ` + - `APEXER_TOOL_PATH=${tool_path} ` + - `${apexer} --force --manifest ${manifest} --manifest_json_full ${manifest_json_full} ` + - `--payload_type zip ` + - `${image_dir} ${out} `, - CommandDeps: []string{"${apexer}", "${merge_zips}", "${soong_zip}", "${zipalign}", "${aapt2}"}, - Rspfile: "${out}.copy_commands", - RspfileContent: "${copy_commands}", - Description: "ZipAPEX ${image_dir} => ${out}", - }, "tool_path", "image_dir", "copy_commands", "manifest", "manifest_json_full") - - apexProtoConvertRule = pctx.AndroidStaticRule("apexProtoConvertRule", - blueprint.RuleParams{ - Command: `${aapt2} convert --output-format proto $in -o $out`, - CommandDeps: []string{"${aapt2}"}, - }) - - apexBundleRule = pctx.StaticRule("apexBundleRule", blueprint.RuleParams{ - Command: `${zip2zip} -i $in -o $out ` + - `apex_payload.img:apex/${abi}.img ` + - `apex_manifest.json:root/apex_manifest.json ` + - `AndroidManifest.xml:manifest/AndroidManifest.xml ` + - `assets/NOTICE.html.gz:assets/NOTICE.html.gz`, - CommandDeps: []string{"${zip2zip}"}, - Description: "app bundle", - }, "abi") - - emitApexContentRule = pctx.StaticRule("emitApexContentRule", blueprint.RuleParams{ - Command: `rm -f ${out} && touch ${out} && (. ${out}.emit_commands)`, - Rspfile: "${out}.emit_commands", - RspfileContent: "${emit_commands}", - Description: "Emit APEX image content", - }, "emit_commands") - - diffApexContentRule = pctx.StaticRule("diffApexContentRule", blueprint.RuleParams{ - Command: `diff --unchanged-group-format='' \` + - `--changed-group-format='%<' \` + - `${image_content_file} ${whitelisted_files_file} || (` + - `echo -e "New unexpected files were added to ${apex_module_name}." ` + - ` "To fix the build run following command:" && ` + - `echo "system/apex/tools/update_whitelist.sh ${whitelisted_files_file} ${image_content_file}" && ` + - `exit 1)`, - Description: "Diff ${image_content_file} and ${whitelisted_files_file}", - }, "image_content_file", "whitelisted_files_file", "apex_module_name") -) - const ( imageApexSuffix = ".apex" zipApexSuffix = ".zipapex" @@ -148,8 +39,6 @@ const ( imageApexType = "image" zipApexType = "zip" flattenedApexType = "flattened" - - vndkApexNamePrefix = "com.android.vndk.v" ) type dependencyTag struct { @@ -170,33 +59,6 @@ var ( ) func init() { - pctx.Import("android/soong/android") - pctx.Import("android/soong/java") - pctx.HostBinToolVariable("apexer", "apexer") - // ART minimal builds (using the master-art manifest) do not have the "frameworks/base" - // projects, and hence cannot built 'aapt2'. Use the SDK prebuilt instead. - hostBinToolVariableWithPrebuilt := func(name, prebuiltDir, tool string) { - pctx.VariableFunc(name, func(ctx android.PackageVarContext) string { - if !ctx.Config().FrameworksBaseDirExists(ctx) { - return filepath.Join(prebuiltDir, runtime.GOOS, "bin", tool) - } else { - return pctx.HostBinToolPath(ctx, tool).String() - } - }) - } - hostBinToolVariableWithPrebuilt("aapt2", "prebuilts/sdk/tools", "aapt2") - pctx.HostBinToolVariable("avbtool", "avbtool") - pctx.HostBinToolVariable("e2fsdroid", "e2fsdroid") - pctx.HostBinToolVariable("merge_zips", "merge_zips") - pctx.HostBinToolVariable("mke2fs", "mke2fs") - pctx.HostBinToolVariable("resize2fs", "resize2fs") - pctx.HostBinToolVariable("sefcontext_compile", "sefcontext_compile") - pctx.HostBinToolVariable("soong_zip", "soong_zip") - pctx.HostBinToolVariable("zip2zip", "zip2zip") - pctx.HostBinToolVariable("zipalign", "zipalign") - pctx.HostBinToolVariable("jsonmodify", "jsonmodify") - pctx.HostBinToolVariable("conv_apex_manifest", "conv_apex_manifest") - android.RegisterModuleType("apex", BundleFactory) android.RegisterModuleType("apex_test", testApexBundleFactory) android.RegisterModuleType("apex_vndk", vndkApexBundleFactory) @@ -225,51 +87,6 @@ func RegisterPostDepsMutators(ctx android.RegisterMutatorsContext) { ctx.BottomUp("apex_uses", apexUsesMutator).Parallel() } -var ( - vndkApexListKey = android.NewOnceKey("vndkApexList") - vndkApexListMutex sync.Mutex -) - -func vndkApexList(config android.Config) map[string]string { - return config.Once(vndkApexListKey, func() interface{} { - return map[string]string{} - }).(map[string]string) -} - -func apexVndkMutator(mctx android.TopDownMutatorContext) { - if ab, ok := mctx.Module().(*apexBundle); ok && ab.vndkApex { - if ab.IsNativeBridgeSupported() { - mctx.PropertyErrorf("native_bridge_supported", "%q doesn't support native bridge binary.", mctx.ModuleType()) - } - - vndkVersion := ab.vndkVersion(mctx.DeviceConfig()) - // Ensure VNDK APEX mount point is formatted as com.android.vndk.v### - ab.properties.Apex_name = proptools.StringPtr(vndkApexNamePrefix + vndkVersion) - - // vndk_version should be unique - vndkApexListMutex.Lock() - defer vndkApexListMutex.Unlock() - vndkApexList := vndkApexList(mctx.Config()) - if other, ok := vndkApexList[vndkVersion]; ok { - mctx.PropertyErrorf("vndk_version", "%v is already defined in %q", vndkVersion, other) - } - vndkApexList[vndkVersion] = mctx.ModuleName() - } -} - -func apexVndkDepsMutator(mctx android.BottomUpMutatorContext) { - if m, ok := mctx.Module().(*cc.Module); ok && cc.IsForVndkApex(mctx, m) { - vndkVersion := m.VndkVersion() - vndkApexList := vndkApexList(mctx.Config()) - if vndkApex, ok := vndkApexList[vndkVersion]; ok { - mctx.AddReverseDependency(mctx.Module(), sharedLibTag, vndkApex) - } - } else if a, ok := mctx.Module().(*apexBundle); ok && a.vndkApex { - vndkVersion := proptools.StringDefault(a.vndkProperties.Vndk_version, "current") - mctx.AddDependency(mctx.Module(), prebuiltTag, cc.VndkLibrariesTxtModules(vndkVersion)...) - } -} - // Mark the direct and transitive dependencies of apex bundles so that they // can be built for the apex bundles. func apexDepsMutator(mctx android.BottomUpMutatorContext) { @@ -541,11 +358,6 @@ type apexTargetBundleProperties struct { } } -type apexVndkProperties struct { - // Indicates VNDK version of which this VNDK APEX bundles VNDK libs. Default is Platform VNDK Version. - Vndk_version *string -} - type apexFileClass int const ( @@ -1340,547 +1152,6 @@ func (a *apexBundle) GenerateAndroidBuildActions(ctx android.ModuleContext) { a.compatSymlinks = makeCompatSymlinks(apexName, ctx) } -func (a *apexBundle) buildManifest(ctx android.ModuleContext, provideNativeLibs, requireNativeLibs []string) { - manifestSrc := android.PathForModuleSrc(ctx, proptools.StringDefault(a.properties.Manifest, "apex_manifest.json")) - - a.manifestJsonFullOut = android.PathForModuleOut(ctx, "apex_manifest_full.json") - - // put dependency({provide|require}NativeLibs) in apex_manifest.json - provideNativeLibs = android.SortedUniqueStrings(provideNativeLibs) - requireNativeLibs = android.SortedUniqueStrings(android.RemoveListFromList(requireNativeLibs, provideNativeLibs)) - - // apex name can be overridden - optCommands := []string{} - if a.properties.Apex_name != nil { - optCommands = append(optCommands, "-v name "+*a.properties.Apex_name) - } - - ctx.Build(pctx, android.BuildParams{ - Rule: apexManifestRule, - Input: manifestSrc, - Output: a.manifestJsonFullOut, - Args: map[string]string{ - "provideNativeLibs": strings.Join(provideNativeLibs, " "), - "requireNativeLibs": strings.Join(requireNativeLibs, " "), - "opt": strings.Join(optCommands, " "), - }, - }) - - // b/143654022 Q apexd can't understand newly added keys in apex_manifest.json - // prepare stripped-down version so that APEX modules built from R+ can be installed to Q - a.manifestJsonOut = android.PathForModuleOut(ctx, "apex_manifest.json") - ctx.Build(pctx, android.BuildParams{ - Rule: stripApexManifestRule, - Input: a.manifestJsonFullOut, - Output: a.manifestJsonOut, - }) - - // from R+, protobuf binary format (.pb) is the standard format for apex_manifest - a.manifestPbOut = android.PathForModuleOut(ctx, "apex_manifest.pb") - ctx.Build(pctx, android.BuildParams{ - Rule: pbApexManifestRule, - Input: a.manifestJsonFullOut, - Output: a.manifestPbOut, - }) -} - -func (a *apexBundle) buildNoticeFile(ctx android.ModuleContext, apexFileName string) android.OptionalPath { - noticeFiles := []android.Path{} - for _, f := range a.filesInfo { - if f.module != nil { - notice := f.module.NoticeFile() - if notice.Valid() { - noticeFiles = append(noticeFiles, notice.Path()) - } - } - } - // append the notice file specified in the apex module itself - if a.NoticeFile().Valid() { - noticeFiles = append(noticeFiles, a.NoticeFile().Path()) - } - - if len(noticeFiles) == 0 { - return android.OptionalPath{} - } - - return android.BuildNoticeOutput(ctx, a.installDir, apexFileName, android.FirstUniquePaths(noticeFiles)).HtmlGzOutput -} - -func (a *apexBundle) buildUnflattenedApex(ctx android.ModuleContext) { - var abis []string - for _, target := range ctx.MultiTargets() { - if len(target.Arch.Abi) > 0 { - abis = append(abis, target.Arch.Abi[0]) - } - } - - abis = android.FirstUniqueStrings(abis) - - apexType := a.properties.ApexType - suffix := apexType.suffix() - unsignedOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+suffix+".unsigned") - - filesToCopy := []android.Path{} - for _, f := range a.filesInfo { - filesToCopy = append(filesToCopy, f.builtFile) - } - - copyCommands := []string{} - emitCommands := []string{} - imageContentFile := android.PathForModuleOut(ctx, ctx.ModuleName()+"-content.txt") - emitCommands = append(emitCommands, "echo ./apex_manifest.json >> "+imageContentFile.String()) - for i, src := range filesToCopy { - dest := filepath.Join(a.filesInfo[i].installDir, src.Base()) - emitCommands = append(emitCommands, "echo './"+dest+"' >> "+imageContentFile.String()) - dest_path := filepath.Join(android.PathForModuleOut(ctx, "image"+suffix).String(), dest) - copyCommands = append(copyCommands, "mkdir -p "+filepath.Dir(dest_path)) - copyCommands = append(copyCommands, "cp "+src.String()+" "+dest_path) - for _, sym := range a.filesInfo[i].symlinks { - symlinkDest := filepath.Join(filepath.Dir(dest_path), sym) - copyCommands = append(copyCommands, "ln -s "+filepath.Base(dest)+" "+symlinkDest) - } - } - emitCommands = append(emitCommands, "sort -o "+imageContentFile.String()+" "+imageContentFile.String()) - - implicitInputs := append(android.Paths(nil), filesToCopy...) - implicitInputs = append(implicitInputs, a.manifestPbOut, a.manifestJsonFullOut, a.manifestJsonOut) - - if a.properties.Whitelisted_files != nil { - ctx.Build(pctx, android.BuildParams{ - Rule: emitApexContentRule, - Implicits: implicitInputs, - Output: imageContentFile, - Description: "emit apex image content", - Args: map[string]string{ - "emit_commands": strings.Join(emitCommands, " && "), - }, - }) - implicitInputs = append(implicitInputs, imageContentFile) - whitelistedFilesFile := android.PathForModuleSrc(ctx, proptools.String(a.properties.Whitelisted_files)) - - phonyOutput := android.PathForModuleOut(ctx, ctx.ModuleName()+"-diff-phony-output") - ctx.Build(pctx, android.BuildParams{ - Rule: diffApexContentRule, - Implicits: implicitInputs, - Output: phonyOutput, - Description: "diff apex image content", - Args: map[string]string{ - "whitelisted_files_file": whitelistedFilesFile.String(), - "image_content_file": imageContentFile.String(), - "apex_module_name": ctx.ModuleName(), - }, - }) - - implicitInputs = append(implicitInputs, phonyOutput) - } - - outHostBinDir := android.PathForOutput(ctx, "host", ctx.Config().PrebuiltOS(), "bin").String() - prebuiltSdkToolsBinDir := filepath.Join("prebuilts", "sdk", "tools", runtime.GOOS, "bin") - - if apexType == imageApex { - // files and dirs that will be created in APEX - var readOnlyPaths = []string{"apex_manifest.json", "apex_manifest.pb"} - var executablePaths []string // this also includes dirs - for _, f := range a.filesInfo { - pathInApex := filepath.Join(f.installDir, f.builtFile.Base()) - if f.installDir == "bin" || strings.HasPrefix(f.installDir, "bin/") { - executablePaths = append(executablePaths, pathInApex) - for _, s := range f.symlinks { - executablePaths = append(executablePaths, filepath.Join(f.installDir, s)) - } - } else { - readOnlyPaths = append(readOnlyPaths, pathInApex) - } - dir := f.installDir - for !android.InList(dir, executablePaths) && dir != "" { - executablePaths = append(executablePaths, dir) - dir, _ = filepath.Split(dir) // move up to the parent - if len(dir) > 0 { - // remove trailing slash - dir = dir[:len(dir)-1] - } - } - } - sort.Strings(readOnlyPaths) - sort.Strings(executablePaths) - cannedFsConfig := android.PathForModuleOut(ctx, "canned_fs_config") - ctx.Build(pctx, android.BuildParams{ - Rule: generateFsConfig, - Output: cannedFsConfig, - Description: "generate fs config", - Args: map[string]string{ - "ro_paths": strings.Join(readOnlyPaths, " "), - "exec_paths": strings.Join(executablePaths, " "), - }, - }) - - fcName := proptools.StringDefault(a.properties.File_contexts, ctx.ModuleName()) - fileContextsPath := "system/sepolicy/apex/" + fcName + "-file_contexts" - fileContextsOptionalPath := android.ExistentPathForSource(ctx, fileContextsPath) - if !fileContextsOptionalPath.Valid() { - ctx.ModuleErrorf("Cannot find file_contexts file: %q", fileContextsPath) - return - } - fileContexts := fileContextsOptionalPath.Path() - - optFlags := []string{} - - // Additional implicit inputs. - implicitInputs = append(implicitInputs, cannedFsConfig, fileContexts, a.private_key_file, a.public_key_file) - optFlags = append(optFlags, "--pubkey "+a.public_key_file.String()) - - manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName()) - if overridden { - optFlags = append(optFlags, "--override_apk_package_name "+manifestPackageName) - } - - if a.properties.AndroidManifest != nil { - androidManifestFile := android.PathForModuleSrc(ctx, proptools.String(a.properties.AndroidManifest)) - implicitInputs = append(implicitInputs, androidManifestFile) - optFlags = append(optFlags, "--android_manifest "+androidManifestFile.String()) - } - - targetSdkVersion := ctx.Config().DefaultAppTargetSdk() - if targetSdkVersion == ctx.Config().PlatformSdkCodename() && - ctx.Config().UnbundledBuild() && - !ctx.Config().UnbundledBuildUsePrebuiltSdks() && - ctx.Config().IsEnvTrue("UNBUNDLED_BUILD_TARGET_SDK_WITH_API_FINGERPRINT") { - apiFingerprint := java.ApiFingerprintPath(ctx) - targetSdkVersion += fmt.Sprintf(".$$(cat %s)", apiFingerprint.String()) - implicitInputs = append(implicitInputs, apiFingerprint) - } - optFlags = append(optFlags, "--target_sdk_version "+targetSdkVersion) - - noticeFile := a.buildNoticeFile(ctx, ctx.ModuleName()+suffix) - if noticeFile.Valid() { - // If there's a NOTICE file, embed it as an asset file in the APEX. - implicitInputs = append(implicitInputs, noticeFile.Path()) - optFlags = append(optFlags, "--assets_dir "+filepath.Dir(noticeFile.String())) - } - - if !ctx.Config().UnbundledBuild() && a.installable() { - // Apexes which are supposed to be installed in builtin dirs(/system, etc) - // don't need hashtree for activation. Therefore, by removing hashtree from - // apex bundle (filesystem image in it, to be specific), we can save storage. - optFlags = append(optFlags, "--no_hashtree") - } - - if a.properties.Apex_name != nil { - // If apex_name is set, apexer can skip checking if key name matches with apex name. - // Note that apex_manifest is also mended. - optFlags = append(optFlags, "--do_not_check_keyname") - } - - ctx.Build(pctx, android.BuildParams{ - Rule: apexRule, - Implicits: implicitInputs, - Output: unsignedOutputFile, - Description: "apex (" + apexType.name() + ")", - Args: map[string]string{ - "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir, - "image_dir": android.PathForModuleOut(ctx, "image"+suffix).String(), - "copy_commands": strings.Join(copyCommands, " && "), - "manifest_json_full": a.manifestJsonFullOut.String(), - "manifest_json": a.manifestJsonOut.String(), - "manifest": a.manifestPbOut.String(), - "file_contexts": fileContexts.String(), - "canned_fs_config": cannedFsConfig.String(), - "key": a.private_key_file.String(), - "opt_flags": strings.Join(optFlags, " "), - }, - }) - - apexProtoFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".pb"+suffix) - bundleModuleFile := android.PathForModuleOut(ctx, ctx.ModuleName()+suffix+"-base.zip") - a.bundleModuleFile = bundleModuleFile - - ctx.Build(pctx, android.BuildParams{ - Rule: apexProtoConvertRule, - Input: unsignedOutputFile, - Output: apexProtoFile, - Description: "apex proto convert", - }) - - ctx.Build(pctx, android.BuildParams{ - Rule: apexBundleRule, - Input: apexProtoFile, - Output: a.bundleModuleFile, - Description: "apex bundle module", - Args: map[string]string{ - "abi": strings.Join(abis, "."), - }, - }) - } else { - ctx.Build(pctx, android.BuildParams{ - Rule: zipApexRule, - Implicits: implicitInputs, - Output: unsignedOutputFile, - Description: "apex (" + apexType.name() + ")", - Args: map[string]string{ - "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir, - "image_dir": android.PathForModuleOut(ctx, "image"+suffix).String(), - "copy_commands": strings.Join(copyCommands, " && "), - "manifest": a.manifestPbOut.String(), - "manifest_json_full": a.manifestJsonFullOut.String(), - }, - }) - } - - a.outputFile = android.PathForModuleOut(ctx, ctx.ModuleName()+suffix) - ctx.Build(pctx, android.BuildParams{ - Rule: java.Signapk, - Description: "signapk", - Output: a.outputFile, - Input: unsignedOutputFile, - Implicits: []android.Path{ - a.container_certificate_file, - a.container_private_key_file, - }, - Args: map[string]string{ - "certificates": a.container_certificate_file.String() + " " + a.container_private_key_file.String(), - "flags": "-a 4096", //alignment - }, - }) - - // Install to $OUT/soong/{target,host}/.../apex - if a.installable() { - ctx.InstallFile(a.installDir, ctx.ModuleName()+suffix, a.outputFile) - } - a.buildFilesInfo(ctx) -} - -func (a *apexBundle) buildFlattenedApex(ctx android.ModuleContext) { - // Temporarily wrap the original `ctx` into a `flattenedApexContext` to have it - // reply true to `InstallBypassMake()` (thus making the call - // `android.PathForModuleInstall` below use `android.pathForInstallInMakeDir` - // instead of `android.PathForOutput`) to return the correct path to the flattened - // APEX (as its contents is installed by Make, not Soong). - factx := flattenedApexContext{ctx} - apexName := proptools.StringDefault(a.properties.Apex_name, ctx.ModuleName()) - a.outputFile = android.PathForModuleInstall(&factx, "apex", apexName) - - a.buildFilesInfo(ctx) -} - -func (a *apexBundle) setCertificateAndPrivateKey(ctx android.ModuleContext) { - cert := String(a.properties.Certificate) - if cert != "" && android.SrcIsModule(cert) == "" { - defaultDir := ctx.Config().DefaultAppCertificateDir(ctx) - a.container_certificate_file = defaultDir.Join(ctx, cert+".x509.pem") - a.container_private_key_file = defaultDir.Join(ctx, cert+".pk8") - } else if cert == "" { - pem, key := ctx.Config().DefaultAppCertificate(ctx) - a.container_certificate_file = pem - a.container_private_key_file = key - } -} - -func (a *apexBundle) buildFilesInfo(ctx android.ModuleContext) { - if a.installable() { - // For flattened APEX, do nothing but make sure that apex_manifest.json and apex_pubkey are also copied along - // with other ordinary files. - a.filesInfo = append(a.filesInfo, apexFile{a.manifestJsonOut, "apex_manifest.json." + ctx.ModuleName() + a.suffix, ".", etc, nil, nil}) - a.filesInfo = append(a.filesInfo, apexFile{a.manifestPbOut, "apex_manifest.pb." + ctx.ModuleName() + a.suffix, ".", etc, nil, nil}) - - // rename to apex_pubkey - copiedPubkey := android.PathForModuleOut(ctx, "apex_pubkey") - ctx.Build(pctx, android.BuildParams{ - Rule: android.Cp, - Input: a.public_key_file, - Output: copiedPubkey, - }) - a.filesInfo = append(a.filesInfo, apexFile{copiedPubkey, "apex_pubkey." + ctx.ModuleName() + a.suffix, ".", etc, nil, nil}) - - if a.properties.ApexType == flattenedApex { - apexName := proptools.StringDefault(a.properties.Apex_name, ctx.ModuleName()) - for _, fi := range a.filesInfo { - dir := filepath.Join("apex", apexName, fi.installDir) - target := ctx.InstallFile(android.PathForModuleInstall(ctx, dir), fi.builtFile.Base(), fi.builtFile) - for _, sym := range fi.symlinks { - ctx.InstallSymlink(android.PathForModuleInstall(ctx, dir), sym, target) - } - } - } - } -} - -func (a *apexBundle) AndroidMk() android.AndroidMkData { - if a.properties.HideFromMake { - return android.AndroidMkData{ - Disabled: true, - } - } - writers := []android.AndroidMkData{} - writers = append(writers, a.androidMkForType()) - return android.AndroidMkData{ - Custom: func(w io.Writer, name, prefix, moduleDir string, data android.AndroidMkData) { - for _, data := range writers { - data.Custom(w, name, prefix, moduleDir, data) - } - }} -} - -func (a *apexBundle) androidMkForFiles(w io.Writer, apexName, moduleDir string) []string { - moduleNames := []string{} - apexType := a.properties.ApexType - // To avoid creating duplicate build rules, run this function only when primaryApexType is true - // to install symbol files in $(PRODUCT_OUT}/apex. - // And if apexType is flattened, run this function to install files in $(PRODUCT_OUT}/system/apex. - if !a.primaryApexType && apexType != flattenedApex { - return moduleNames - } - - for _, fi := range a.filesInfo { - if cc, ok := fi.module.(*cc.Module); ok && cc.Properties.HideFromMake { - continue - } - - if !android.InList(fi.moduleName, moduleNames) { - moduleNames = append(moduleNames, fi.moduleName) - } - - fmt.Fprintln(w, "\ninclude $(CLEAR_VARS)") - fmt.Fprintln(w, "LOCAL_PATH :=", moduleDir) - fmt.Fprintln(w, "LOCAL_MODULE :=", fi.moduleName) - // /apex//{lib|framework|...} - pathWhenActivated := filepath.Join("$(PRODUCT_OUT)", "apex", apexName, fi.installDir) - if apexType == flattenedApex { - // /system/apex//{lib|framework|...} - fmt.Fprintln(w, "LOCAL_MODULE_PATH :=", filepath.Join(a.installDir.ToMakePath().String(), - apexName, fi.installDir)) - if a.primaryApexType { - fmt.Fprintln(w, "LOCAL_SOONG_SYMBOL_PATH :=", pathWhenActivated) - } - if len(fi.symlinks) > 0 { - fmt.Fprintln(w, "LOCAL_MODULE_SYMLINKS :=", strings.Join(fi.symlinks, " ")) - } - - if fi.module != nil && fi.module.NoticeFile().Valid() { - fmt.Fprintln(w, "LOCAL_NOTICE_FILE :=", fi.module.NoticeFile().Path().String()) - } - } else { - fmt.Fprintln(w, "LOCAL_MODULE_PATH :=", pathWhenActivated) - } - fmt.Fprintln(w, "LOCAL_PREBUILT_MODULE_FILE :=", fi.builtFile.String()) - fmt.Fprintln(w, "LOCAL_MODULE_CLASS :=", fi.class.NameInMake()) - if fi.module != nil { - archStr := fi.module.Target().Arch.ArchType.String() - host := false - switch fi.module.Target().Os.Class { - case android.Host: - if fi.module.Target().Arch.ArchType != android.Common { - fmt.Fprintln(w, "LOCAL_MODULE_HOST_ARCH :=", archStr) - } - host = true - case android.HostCross: - if fi.module.Target().Arch.ArchType != android.Common { - fmt.Fprintln(w, "LOCAL_MODULE_HOST_CROSS_ARCH :=", archStr) - } - host = true - case android.Device: - if fi.module.Target().Arch.ArchType != android.Common { - fmt.Fprintln(w, "LOCAL_MODULE_TARGET_ARCH :=", archStr) - } - } - if host { - makeOs := fi.module.Target().Os.String() - if fi.module.Target().Os == android.Linux || fi.module.Target().Os == android.LinuxBionic { - makeOs = "linux" - } - fmt.Fprintln(w, "LOCAL_MODULE_HOST_OS :=", makeOs) - fmt.Fprintln(w, "LOCAL_IS_HOST_MODULE := true") - } - } - if fi.class == javaSharedLib { - javaModule := fi.module.(*java.Library) - // soong_java_prebuilt.mk sets LOCAL_MODULE_SUFFIX := .jar Therefore - // we need to remove the suffix from LOCAL_MODULE_STEM, otherwise - // we will have foo.jar.jar - fmt.Fprintln(w, "LOCAL_MODULE_STEM :=", strings.TrimSuffix(fi.builtFile.Base(), ".jar")) - fmt.Fprintln(w, "LOCAL_SOONG_CLASSES_JAR :=", javaModule.ImplementationAndResourcesJars()[0].String()) - fmt.Fprintln(w, "LOCAL_SOONG_HEADER_JAR :=", javaModule.HeaderJars()[0].String()) - fmt.Fprintln(w, "LOCAL_SOONG_DEX_JAR :=", fi.builtFile.String()) - fmt.Fprintln(w, "LOCAL_DEX_PREOPT := false") - fmt.Fprintln(w, "include $(BUILD_SYSTEM)/soong_java_prebuilt.mk") - } else if fi.class == nativeSharedLib || fi.class == nativeExecutable || fi.class == nativeTest { - fmt.Fprintln(w, "LOCAL_MODULE_STEM :=", fi.builtFile.Base()) - if cc, ok := fi.module.(*cc.Module); ok { - if cc.UnstrippedOutputFile() != nil { - fmt.Fprintln(w, "LOCAL_SOONG_UNSTRIPPED_BINARY :=", cc.UnstrippedOutputFile().String()) - } - cc.AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w) - if cc.CoverageOutputFile().Valid() { - fmt.Fprintln(w, "LOCAL_PREBUILT_COVERAGE_ARCHIVE :=", cc.CoverageOutputFile().String()) - } - } - fmt.Fprintln(w, "include $(BUILD_SYSTEM)/soong_cc_prebuilt.mk") - } else { - fmt.Fprintln(w, "LOCAL_MODULE_STEM :=", fi.builtFile.Base()) - // For flattened apexes, compat symlinks are attached to apex_manifest.json which is guaranteed for every apex - if a.primaryApexType && fi.builtFile == a.manifestPbOut && len(a.compatSymlinks) > 0 { - fmt.Fprintln(w, "LOCAL_POST_INSTALL_CMD :=", strings.Join(a.compatSymlinks, " && ")) - } - fmt.Fprintln(w, "include $(BUILD_PREBUILT)") - } - } - return moduleNames -} - -func (a *apexBundle) androidMkForType() android.AndroidMkData { - return android.AndroidMkData{ - Custom: func(w io.Writer, name, prefix, moduleDir string, data android.AndroidMkData) { - moduleNames := []string{} - apexType := a.properties.ApexType - if a.installable() { - apexName := proptools.StringDefault(a.properties.Apex_name, name) - moduleNames = a.androidMkForFiles(w, apexName, moduleDir) - } - - if apexType == flattenedApex { - // Only image APEXes can be flattened. - fmt.Fprintln(w, "\ninclude $(CLEAR_VARS)") - fmt.Fprintln(w, "LOCAL_PATH :=", moduleDir) - fmt.Fprintln(w, "LOCAL_MODULE :=", name+a.suffix) - if len(moduleNames) > 0 { - fmt.Fprintln(w, "LOCAL_REQUIRED_MODULES :=", strings.Join(moduleNames, " ")) - } - fmt.Fprintln(w, "include $(BUILD_PHONY_PACKAGE)") - fmt.Fprintln(w, "$(LOCAL_INSTALLED_MODULE): .KATI_IMPLICIT_OUTPUTS :=", a.outputFile.String()) - - } else { - fmt.Fprintln(w, "\ninclude $(CLEAR_VARS)") - fmt.Fprintln(w, "LOCAL_PATH :=", moduleDir) - fmt.Fprintln(w, "LOCAL_MODULE :=", name+a.suffix) - fmt.Fprintln(w, "LOCAL_MODULE_CLASS := ETC") // do we need a new class? - fmt.Fprintln(w, "LOCAL_PREBUILT_MODULE_FILE :=", a.outputFile.String()) - fmt.Fprintln(w, "LOCAL_MODULE_PATH :=", a.installDir.ToMakePath().String()) - fmt.Fprintln(w, "LOCAL_MODULE_STEM :=", name+apexType.suffix()) - fmt.Fprintln(w, "LOCAL_UNINSTALLABLE_MODULE :=", !a.installable()) - if len(moduleNames) > 0 { - fmt.Fprintln(w, "LOCAL_REQUIRED_MODULES +=", strings.Join(moduleNames, " ")) - } - if len(a.externalDeps) > 0 { - fmt.Fprintln(w, "LOCAL_REQUIRED_MODULES +=", strings.Join(a.externalDeps, " ")) - } - var postInstallCommands []string - if a.prebuiltFileToDelete != "" { - postInstallCommands = append(postInstallCommands, "rm -rf "+ - filepath.Join(a.installDir.ToMakePath().String(), a.prebuiltFileToDelete)) - } - // For unflattened apexes, compat symlinks are attached to apex package itself as LOCAL_POST_INSTALL_CMD - postInstallCommands = append(postInstallCommands, a.compatSymlinks...) - if len(postInstallCommands) > 0 { - fmt.Fprintln(w, "LOCAL_POST_INSTALL_CMD :=", strings.Join(postInstallCommands, " && ")) - } - fmt.Fprintln(w, "include $(BUILD_PREBUILT)") - - if apexType == imageApex { - fmt.Fprintln(w, "ALL_MODULES.$(LOCAL_MODULE).BUNDLE :=", a.bundleModuleFile.String()) - } - } - }} -} - func newApexBundle() *apexBundle { module := &apexBundle{} module.AddProperties(&module.properties) @@ -1911,31 +1182,6 @@ func BundleFactory() android.Module { return newApexBundle() } -// apex_vndk creates a special variant of apex modules which contains only VNDK libraries. -// If `vndk_version` is specified, the VNDK libraries of the specified VNDK version are gathered automatically. -// If not specified, then the "current" versions are gathered. -func vndkApexBundleFactory() android.Module { - bundle := newApexBundle() - bundle.vndkApex = true - bundle.AddProperties(&bundle.vndkProperties) - android.AddLoadHook(bundle, func(ctx android.LoadHookContext) { - ctx.AppendProperties(&struct { - Compile_multilib *string - }{ - proptools.StringPtr("both"), - }) - }) - return bundle -} - -func (a *apexBundle) vndkVersion(config android.DeviceConfig) string { - vndkVersion := proptools.StringDefault(a.vndkProperties.Vndk_version, "current") - if vndkVersion == "current" { - vndkVersion = config.PlatformVndkVersion() - } - return vndkVersion -} - // // Defaults // @@ -1960,207 +1206,3 @@ func DefaultsFactory(props ...interface{}) android.Module { android.InitDefaultsModule(module) return module } - -// -// Prebuilt APEX -// -type Prebuilt struct { - android.ModuleBase - prebuilt android.Prebuilt - - properties PrebuiltProperties - - inputApex android.Path - installDir android.InstallPath - installFilename string - outputApex android.WritablePath -} - -type PrebuiltProperties struct { - // the path to the prebuilt .apex file to import. - Source string `blueprint:"mutated"` - ForceDisable bool `blueprint:"mutated"` - - Src *string - Arch struct { - Arm struct { - Src *string - } - Arm64 struct { - Src *string - } - X86 struct { - Src *string - } - X86_64 struct { - Src *string - } - } - - Installable *bool - // Optional name for the installed apex. If unspecified, name of the - // module is used as the file name - Filename *string - - // Names of modules to be overridden. Listed modules can only be other binaries - // (in Make or Soong). - // This does not completely prevent installation of the overridden binaries, but if both - // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed - // from PRODUCT_PACKAGES. - Overrides []string -} - -func (p *Prebuilt) installable() bool { - return p.properties.Installable == nil || proptools.Bool(p.properties.Installable) -} - -func (p *Prebuilt) DepsMutator(ctx android.BottomUpMutatorContext) { - // If the device is configured to use flattened APEX, force disable the prebuilt because - // the prebuilt is a non-flattened one. - forceDisable := ctx.Config().FlattenApex() - - // Force disable the prebuilts when we are doing unbundled build. We do unbundled build - // to build the prebuilts themselves. - forceDisable = forceDisable || ctx.Config().UnbundledBuild() - - // Force disable the prebuilts when coverage is enabled. - forceDisable = forceDisable || ctx.DeviceConfig().NativeCoverageEnabled() - forceDisable = forceDisable || ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") - - // b/137216042 don't use prebuilts when address sanitizer is on - forceDisable = forceDisable || android.InList("address", ctx.Config().SanitizeDevice()) || - android.InList("hwaddress", ctx.Config().SanitizeDevice()) - - if forceDisable && p.prebuilt.SourceExists() { - p.properties.ForceDisable = true - return - } - - // This is called before prebuilt_select and prebuilt_postdeps mutators - // The mutators requires that src to be set correctly for each arch so that - // arch variants are disabled when src is not provided for the arch. - if len(ctx.MultiTargets()) != 1 { - ctx.ModuleErrorf("compile_multilib shouldn't be \"both\" for prebuilt_apex") - return - } - var src string - switch ctx.MultiTargets()[0].Arch.ArchType { - case android.Arm: - src = String(p.properties.Arch.Arm.Src) - case android.Arm64: - src = String(p.properties.Arch.Arm64.Src) - case android.X86: - src = String(p.properties.Arch.X86.Src) - case android.X86_64: - src = String(p.properties.Arch.X86_64.Src) - default: - ctx.ModuleErrorf("prebuilt_apex does not support %q", ctx.MultiTargets()[0].Arch.String()) - return - } - if src == "" { - src = String(p.properties.Src) - } - p.properties.Source = src -} - -func (p *Prebuilt) isForceDisabled() bool { - return p.properties.ForceDisable -} - -func (p *Prebuilt) OutputFiles(tag string) (android.Paths, error) { - switch tag { - case "": - return android.Paths{p.outputApex}, nil - default: - return nil, fmt.Errorf("unsupported module reference tag %q", tag) - } -} - -func (p *Prebuilt) InstallFilename() string { - return proptools.StringDefault(p.properties.Filename, p.BaseModuleName()+imageApexSuffix) -} - -func (p *Prebuilt) GenerateAndroidBuildActions(ctx android.ModuleContext) { - if p.properties.ForceDisable { - return - } - - // TODO(jungjw): Check the key validity. - p.inputApex = p.Prebuilt().SingleSourcePath(ctx) - p.installDir = android.PathForModuleInstall(ctx, "apex") - p.installFilename = p.InstallFilename() - if !strings.HasSuffix(p.installFilename, imageApexSuffix) { - ctx.ModuleErrorf("filename should end in %s for prebuilt_apex", imageApexSuffix) - } - p.outputApex = android.PathForModuleOut(ctx, p.installFilename) - ctx.Build(pctx, android.BuildParams{ - Rule: android.Cp, - Input: p.inputApex, - Output: p.outputApex, - }) - if p.installable() { - ctx.InstallFile(p.installDir, p.installFilename, p.inputApex) - } - - // TODO(b/143192278): Add compat symlinks for prebuilt_apex -} - -func (p *Prebuilt) Prebuilt() *android.Prebuilt { - return &p.prebuilt -} - -func (p *Prebuilt) Name() string { - return p.prebuilt.Name(p.ModuleBase.Name()) -} - -func (p *Prebuilt) AndroidMkEntries() android.AndroidMkEntries { - return android.AndroidMkEntries{ - Class: "ETC", - OutputFile: android.OptionalPathForPath(p.inputApex), - Include: "$(BUILD_PREBUILT)", - ExtraEntries: []android.AndroidMkExtraEntriesFunc{ - func(entries *android.AndroidMkEntries) { - entries.SetString("LOCAL_MODULE_PATH", p.installDir.ToMakePath().String()) - entries.SetString("LOCAL_MODULE_STEM", p.installFilename) - entries.SetBoolIfTrue("LOCAL_UNINSTALLABLE_MODULE", !p.installable()) - entries.AddStrings("LOCAL_OVERRIDES_MODULES", p.properties.Overrides...) - }, - }, - } -} - -// prebuilt_apex imports an `.apex` file into the build graph as if it was built with apex. -func PrebuiltFactory() android.Module { - module := &Prebuilt{} - module.AddProperties(&module.properties) - android.InitSingleSourcePrebuiltModule(module, &module.properties, "Source") - android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon) - return module -} - -func makeCompatSymlinks(apexName string, ctx android.ModuleContext) (symlinks []string) { - // small helper to add symlink commands - addSymlink := func(target, dir, linkName string) { - outDir := filepath.Join("$(PRODUCT_OUT)", dir) - link := filepath.Join(outDir, linkName) - symlinks = append(symlinks, "mkdir -p "+outDir+" && rm -rf "+link+" && ln -sf "+target+" "+link) - } - - // TODO(b/142911355): [VNDK APEX] Fix hard-coded references to /system/lib/vndk - // When all hard-coded references are fixed, remove symbolic links - // Note that we should keep following symlinks for older VNDKs (<=29) - // Since prebuilt vndk libs still depend on system/lib/vndk path - if strings.HasPrefix(apexName, vndkApexNamePrefix) { - // the name of vndk apex is formatted "com.android.vndk.v" + version - vndkVersion := strings.TrimPrefix(apexName, vndkApexNamePrefix) - if ctx.Config().Android64() { - addSymlink("/apex/"+apexName+"/lib64", "/system/lib64", "vndk-sp-"+vndkVersion) - addSymlink("/apex/"+apexName+"/lib64", "/system/lib64", "vndk-"+vndkVersion) - } - if !ctx.Config().Android64() || ctx.DeviceConfig().DeviceSecondaryArch() != "" { - addSymlink("/apex/"+apexName+"/lib", "/system/lib", "vndk-sp-"+vndkVersion) - addSymlink("/apex/"+apexName+"/lib", "/system/lib", "vndk-"+vndkVersion) - } - } - return -} diff --git a/apex/builder.go b/apex/builder.go new file mode 100644 index 000000000..b29bc2c78 --- /dev/null +++ b/apex/builder.go @@ -0,0 +1,531 @@ +// Copyright (C) 2019 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package apex + +import ( + "fmt" + "path/filepath" + "runtime" + "sort" + "strings" + + "android/soong/android" + "android/soong/java" + + "github.com/google/blueprint" + "github.com/google/blueprint/proptools" +) + +var ( + pctx = android.NewPackageContext("android/apex") +) + +func init() { + pctx.Import("android/soong/android") + pctx.Import("android/soong/java") + pctx.HostBinToolVariable("apexer", "apexer") + // ART minimal builds (using the master-art manifest) do not have the "frameworks/base" + // projects, and hence cannot built 'aapt2'. Use the SDK prebuilt instead. + hostBinToolVariableWithPrebuilt := func(name, prebuiltDir, tool string) { + pctx.VariableFunc(name, func(ctx android.PackageVarContext) string { + if !ctx.Config().FrameworksBaseDirExists(ctx) { + return filepath.Join(prebuiltDir, runtime.GOOS, "bin", tool) + } else { + return pctx.HostBinToolPath(ctx, tool).String() + } + }) + } + hostBinToolVariableWithPrebuilt("aapt2", "prebuilts/sdk/tools", "aapt2") + pctx.HostBinToolVariable("avbtool", "avbtool") + pctx.HostBinToolVariable("e2fsdroid", "e2fsdroid") + pctx.HostBinToolVariable("merge_zips", "merge_zips") + pctx.HostBinToolVariable("mke2fs", "mke2fs") + pctx.HostBinToolVariable("resize2fs", "resize2fs") + pctx.HostBinToolVariable("sefcontext_compile", "sefcontext_compile") + pctx.HostBinToolVariable("soong_zip", "soong_zip") + pctx.HostBinToolVariable("zip2zip", "zip2zip") + pctx.HostBinToolVariable("zipalign", "zipalign") + pctx.HostBinToolVariable("jsonmodify", "jsonmodify") + pctx.HostBinToolVariable("conv_apex_manifest", "conv_apex_manifest") +} + +var ( + // Create a canned fs config file where all files and directories are + // by default set to (uid/gid/mode) = (1000/1000/0644) + // TODO(b/113082813) make this configurable using config.fs syntax + generateFsConfig = pctx.StaticRule("generateFsConfig", blueprint.RuleParams{ + Command: `echo '/ 1000 1000 0755' > ${out} && ` + + `echo ${ro_paths} | tr ' ' '\n' | awk '{print "/"$$1 " 1000 1000 0644"}' >> ${out} && ` + + `echo ${exec_paths} | tr ' ' '\n' | awk '{print "/"$$1 " 0 2000 0755"}' >> ${out}`, + Description: "fs_config ${out}", + }, "ro_paths", "exec_paths") + + apexManifestRule = pctx.StaticRule("apexManifestRule", blueprint.RuleParams{ + Command: `rm -f $out && ${jsonmodify} $in ` + + `-a provideNativeLibs ${provideNativeLibs} ` + + `-a requireNativeLibs ${requireNativeLibs} ` + + `${opt} ` + + `-o $out`, + CommandDeps: []string{"${jsonmodify}"}, + Description: "prepare ${out}", + }, "provideNativeLibs", "requireNativeLibs", "opt") + + stripApexManifestRule = pctx.StaticRule("stripApexManifestRule", blueprint.RuleParams{ + Command: `rm -f $out && ${conv_apex_manifest} strip $in -o $out`, + CommandDeps: []string{"${conv_apex_manifest}"}, + Description: "strip ${in}=>${out}", + }) + + pbApexManifestRule = pctx.StaticRule("pbApexManifestRule", blueprint.RuleParams{ + Command: `rm -f $out && ${conv_apex_manifest} proto $in -o $out`, + CommandDeps: []string{"${conv_apex_manifest}"}, + Description: "convert ${in}=>${out}", + }) + + // TODO(b/113233103): make sure that file_contexts is sane, i.e., validate + // against the binary policy using sefcontext_compiler -p . + + // TODO(b/114327326): automate the generation of file_contexts + apexRule = pctx.StaticRule("apexRule", blueprint.RuleParams{ + Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` + + `(. ${out}.copy_commands) && ` + + `APEXER_TOOL_PATH=${tool_path} ` + + `${apexer} --force --manifest ${manifest} ` + + `--manifest_json ${manifest_json} --manifest_json_full ${manifest_json_full} ` + + `--file_contexts ${file_contexts} ` + + `--canned_fs_config ${canned_fs_config} ` + + `--payload_type image ` + + `--key ${key} ${opt_flags} ${image_dir} ${out} `, + CommandDeps: []string{"${apexer}", "${avbtool}", "${e2fsdroid}", "${merge_zips}", + "${mke2fs}", "${resize2fs}", "${sefcontext_compile}", + "${soong_zip}", "${zipalign}", "${aapt2}", "prebuilts/sdk/current/public/android.jar"}, + Rspfile: "${out}.copy_commands", + RspfileContent: "${copy_commands}", + Description: "APEX ${image_dir} => ${out}", + }, "tool_path", "image_dir", "copy_commands", "file_contexts", "canned_fs_config", "key", "opt_flags", + "manifest", "manifest_json", "manifest_json_full", + ) + + zipApexRule = pctx.StaticRule("zipApexRule", blueprint.RuleParams{ + Command: `rm -rf ${image_dir} && mkdir -p ${image_dir} && ` + + `(. ${out}.copy_commands) && ` + + `APEXER_TOOL_PATH=${tool_path} ` + + `${apexer} --force --manifest ${manifest} --manifest_json_full ${manifest_json_full} ` + + `--payload_type zip ` + + `${image_dir} ${out} `, + CommandDeps: []string{"${apexer}", "${merge_zips}", "${soong_zip}", "${zipalign}", "${aapt2}"}, + Rspfile: "${out}.copy_commands", + RspfileContent: "${copy_commands}", + Description: "ZipAPEX ${image_dir} => ${out}", + }, "tool_path", "image_dir", "copy_commands", "manifest", "manifest_json_full") + + apexProtoConvertRule = pctx.AndroidStaticRule("apexProtoConvertRule", + blueprint.RuleParams{ + Command: `${aapt2} convert --output-format proto $in -o $out`, + CommandDeps: []string{"${aapt2}"}, + }) + + apexBundleRule = pctx.StaticRule("apexBundleRule", blueprint.RuleParams{ + Command: `${zip2zip} -i $in -o $out ` + + `apex_payload.img:apex/${abi}.img ` + + `apex_manifest.json:root/apex_manifest.json ` + + `AndroidManifest.xml:manifest/AndroidManifest.xml ` + + `assets/NOTICE.html.gz:assets/NOTICE.html.gz`, + CommandDeps: []string{"${zip2zip}"}, + Description: "app bundle", + }, "abi") + + emitApexContentRule = pctx.StaticRule("emitApexContentRule", blueprint.RuleParams{ + Command: `rm -f ${out} && touch ${out} && (. ${out}.emit_commands)`, + Rspfile: "${out}.emit_commands", + RspfileContent: "${emit_commands}", + Description: "Emit APEX image content", + }, "emit_commands") + + diffApexContentRule = pctx.StaticRule("diffApexContentRule", blueprint.RuleParams{ + Command: `diff --unchanged-group-format='' \` + + `--changed-group-format='%<' \` + + `${image_content_file} ${whitelisted_files_file} || (` + + `echo -e "New unexpected files were added to ${apex_module_name}." ` + + ` "To fix the build run following command:" && ` + + `echo "system/apex/tools/update_whitelist.sh ${whitelisted_files_file} ${image_content_file}" && ` + + `exit 1)`, + Description: "Diff ${image_content_file} and ${whitelisted_files_file}", + }, "image_content_file", "whitelisted_files_file", "apex_module_name") +) + +func (a *apexBundle) buildManifest(ctx android.ModuleContext, provideNativeLibs, requireNativeLibs []string) { + manifestSrc := android.PathForModuleSrc(ctx, proptools.StringDefault(a.properties.Manifest, "apex_manifest.json")) + + a.manifestJsonFullOut = android.PathForModuleOut(ctx, "apex_manifest_full.json") + + // put dependency({provide|require}NativeLibs) in apex_manifest.json + provideNativeLibs = android.SortedUniqueStrings(provideNativeLibs) + requireNativeLibs = android.SortedUniqueStrings(android.RemoveListFromList(requireNativeLibs, provideNativeLibs)) + + // apex name can be overridden + optCommands := []string{} + if a.properties.Apex_name != nil { + optCommands = append(optCommands, "-v name "+*a.properties.Apex_name) + } + + ctx.Build(pctx, android.BuildParams{ + Rule: apexManifestRule, + Input: manifestSrc, + Output: a.manifestJsonFullOut, + Args: map[string]string{ + "provideNativeLibs": strings.Join(provideNativeLibs, " "), + "requireNativeLibs": strings.Join(requireNativeLibs, " "), + "opt": strings.Join(optCommands, " "), + }, + }) + + // b/143654022 Q apexd can't understand newly added keys in apex_manifest.json + // prepare stripped-down version so that APEX modules built from R+ can be installed to Q + a.manifestJsonOut = android.PathForModuleOut(ctx, "apex_manifest.json") + ctx.Build(pctx, android.BuildParams{ + Rule: stripApexManifestRule, + Input: a.manifestJsonFullOut, + Output: a.manifestJsonOut, + }) + + // from R+, protobuf binary format (.pb) is the standard format for apex_manifest + a.manifestPbOut = android.PathForModuleOut(ctx, "apex_manifest.pb") + ctx.Build(pctx, android.BuildParams{ + Rule: pbApexManifestRule, + Input: a.manifestJsonFullOut, + Output: a.manifestPbOut, + }) +} + +func (a *apexBundle) buildNoticeFile(ctx android.ModuleContext, apexFileName string) android.OptionalPath { + noticeFiles := []android.Path{} + for _, f := range a.filesInfo { + if f.module != nil { + notice := f.module.NoticeFile() + if notice.Valid() { + noticeFiles = append(noticeFiles, notice.Path()) + } + } + } + // append the notice file specified in the apex module itself + if a.NoticeFile().Valid() { + noticeFiles = append(noticeFiles, a.NoticeFile().Path()) + } + + if len(noticeFiles) == 0 { + return android.OptionalPath{} + } + + return android.BuildNoticeOutput(ctx, a.installDir, apexFileName, android.FirstUniquePaths(noticeFiles)).HtmlGzOutput +} + +func (a *apexBundle) buildUnflattenedApex(ctx android.ModuleContext) { + var abis []string + for _, target := range ctx.MultiTargets() { + if len(target.Arch.Abi) > 0 { + abis = append(abis, target.Arch.Abi[0]) + } + } + + abis = android.FirstUniqueStrings(abis) + + apexType := a.properties.ApexType + suffix := apexType.suffix() + unsignedOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+suffix+".unsigned") + + filesToCopy := []android.Path{} + for _, f := range a.filesInfo { + filesToCopy = append(filesToCopy, f.builtFile) + } + + copyCommands := []string{} + emitCommands := []string{} + imageContentFile := android.PathForModuleOut(ctx, ctx.ModuleName()+"-content.txt") + emitCommands = append(emitCommands, "echo ./apex_manifest.json >> "+imageContentFile.String()) + for i, src := range filesToCopy { + dest := filepath.Join(a.filesInfo[i].installDir, src.Base()) + emitCommands = append(emitCommands, "echo './"+dest+"' >> "+imageContentFile.String()) + dest_path := filepath.Join(android.PathForModuleOut(ctx, "image"+suffix).String(), dest) + copyCommands = append(copyCommands, "mkdir -p "+filepath.Dir(dest_path)) + copyCommands = append(copyCommands, "cp "+src.String()+" "+dest_path) + for _, sym := range a.filesInfo[i].symlinks { + symlinkDest := filepath.Join(filepath.Dir(dest_path), sym) + copyCommands = append(copyCommands, "ln -s "+filepath.Base(dest)+" "+symlinkDest) + } + } + emitCommands = append(emitCommands, "sort -o "+imageContentFile.String()+" "+imageContentFile.String()) + + implicitInputs := append(android.Paths(nil), filesToCopy...) + implicitInputs = append(implicitInputs, a.manifestPbOut, a.manifestJsonFullOut, a.manifestJsonOut) + + if a.properties.Whitelisted_files != nil { + ctx.Build(pctx, android.BuildParams{ + Rule: emitApexContentRule, + Implicits: implicitInputs, + Output: imageContentFile, + Description: "emit apex image content", + Args: map[string]string{ + "emit_commands": strings.Join(emitCommands, " && "), + }, + }) + implicitInputs = append(implicitInputs, imageContentFile) + whitelistedFilesFile := android.PathForModuleSrc(ctx, proptools.String(a.properties.Whitelisted_files)) + + phonyOutput := android.PathForModuleOut(ctx, ctx.ModuleName()+"-diff-phony-output") + ctx.Build(pctx, android.BuildParams{ + Rule: diffApexContentRule, + Implicits: implicitInputs, + Output: phonyOutput, + Description: "diff apex image content", + Args: map[string]string{ + "whitelisted_files_file": whitelistedFilesFile.String(), + "image_content_file": imageContentFile.String(), + "apex_module_name": ctx.ModuleName(), + }, + }) + + implicitInputs = append(implicitInputs, phonyOutput) + } + + outHostBinDir := android.PathForOutput(ctx, "host", ctx.Config().PrebuiltOS(), "bin").String() + prebuiltSdkToolsBinDir := filepath.Join("prebuilts", "sdk", "tools", runtime.GOOS, "bin") + + if apexType == imageApex { + // files and dirs that will be created in APEX + var readOnlyPaths = []string{"apex_manifest.json", "apex_manifest.pb"} + var executablePaths []string // this also includes dirs + for _, f := range a.filesInfo { + pathInApex := filepath.Join(f.installDir, f.builtFile.Base()) + if f.installDir == "bin" || strings.HasPrefix(f.installDir, "bin/") { + executablePaths = append(executablePaths, pathInApex) + for _, s := range f.symlinks { + executablePaths = append(executablePaths, filepath.Join(f.installDir, s)) + } + } else { + readOnlyPaths = append(readOnlyPaths, pathInApex) + } + dir := f.installDir + for !android.InList(dir, executablePaths) && dir != "" { + executablePaths = append(executablePaths, dir) + dir, _ = filepath.Split(dir) // move up to the parent + if len(dir) > 0 { + // remove trailing slash + dir = dir[:len(dir)-1] + } + } + } + sort.Strings(readOnlyPaths) + sort.Strings(executablePaths) + cannedFsConfig := android.PathForModuleOut(ctx, "canned_fs_config") + ctx.Build(pctx, android.BuildParams{ + Rule: generateFsConfig, + Output: cannedFsConfig, + Description: "generate fs config", + Args: map[string]string{ + "ro_paths": strings.Join(readOnlyPaths, " "), + "exec_paths": strings.Join(executablePaths, " "), + }, + }) + + fcName := proptools.StringDefault(a.properties.File_contexts, ctx.ModuleName()) + fileContextsPath := "system/sepolicy/apex/" + fcName + "-file_contexts" + fileContextsOptionalPath := android.ExistentPathForSource(ctx, fileContextsPath) + if !fileContextsOptionalPath.Valid() { + ctx.ModuleErrorf("Cannot find file_contexts file: %q", fileContextsPath) + return + } + fileContexts := fileContextsOptionalPath.Path() + + optFlags := []string{} + + // Additional implicit inputs. + implicitInputs = append(implicitInputs, cannedFsConfig, fileContexts, a.private_key_file, a.public_key_file) + optFlags = append(optFlags, "--pubkey "+a.public_key_file.String()) + + manifestPackageName, overridden := ctx.DeviceConfig().OverrideManifestPackageNameFor(ctx.ModuleName()) + if overridden { + optFlags = append(optFlags, "--override_apk_package_name "+manifestPackageName) + } + + if a.properties.AndroidManifest != nil { + androidManifestFile := android.PathForModuleSrc(ctx, proptools.String(a.properties.AndroidManifest)) + implicitInputs = append(implicitInputs, androidManifestFile) + optFlags = append(optFlags, "--android_manifest "+androidManifestFile.String()) + } + + targetSdkVersion := ctx.Config().DefaultAppTargetSdk() + if targetSdkVersion == ctx.Config().PlatformSdkCodename() && + ctx.Config().UnbundledBuild() && + !ctx.Config().UnbundledBuildUsePrebuiltSdks() && + ctx.Config().IsEnvTrue("UNBUNDLED_BUILD_TARGET_SDK_WITH_API_FINGERPRINT") { + apiFingerprint := java.ApiFingerprintPath(ctx) + targetSdkVersion += fmt.Sprintf(".$$(cat %s)", apiFingerprint.String()) + implicitInputs = append(implicitInputs, apiFingerprint) + } + optFlags = append(optFlags, "--target_sdk_version "+targetSdkVersion) + + noticeFile := a.buildNoticeFile(ctx, ctx.ModuleName()+suffix) + if noticeFile.Valid() { + // If there's a NOTICE file, embed it as an asset file in the APEX. + implicitInputs = append(implicitInputs, noticeFile.Path()) + optFlags = append(optFlags, "--assets_dir "+filepath.Dir(noticeFile.String())) + } + + if !ctx.Config().UnbundledBuild() && a.installable() { + // Apexes which are supposed to be installed in builtin dirs(/system, etc) + // don't need hashtree for activation. Therefore, by removing hashtree from + // apex bundle (filesystem image in it, to be specific), we can save storage. + optFlags = append(optFlags, "--no_hashtree") + } + + if a.properties.Apex_name != nil { + // If apex_name is set, apexer can skip checking if key name matches with apex name. + // Note that apex_manifest is also mended. + optFlags = append(optFlags, "--do_not_check_keyname") + } + + ctx.Build(pctx, android.BuildParams{ + Rule: apexRule, + Implicits: implicitInputs, + Output: unsignedOutputFile, + Description: "apex (" + apexType.name() + ")", + Args: map[string]string{ + "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir, + "image_dir": android.PathForModuleOut(ctx, "image"+suffix).String(), + "copy_commands": strings.Join(copyCommands, " && "), + "manifest_json_full": a.manifestJsonFullOut.String(), + "manifest_json": a.manifestJsonOut.String(), + "manifest": a.manifestPbOut.String(), + "file_contexts": fileContexts.String(), + "canned_fs_config": cannedFsConfig.String(), + "key": a.private_key_file.String(), + "opt_flags": strings.Join(optFlags, " "), + }, + }) + + apexProtoFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".pb"+suffix) + bundleModuleFile := android.PathForModuleOut(ctx, ctx.ModuleName()+suffix+"-base.zip") + a.bundleModuleFile = bundleModuleFile + + ctx.Build(pctx, android.BuildParams{ + Rule: apexProtoConvertRule, + Input: unsignedOutputFile, + Output: apexProtoFile, + Description: "apex proto convert", + }) + + ctx.Build(pctx, android.BuildParams{ + Rule: apexBundleRule, + Input: apexProtoFile, + Output: a.bundleModuleFile, + Description: "apex bundle module", + Args: map[string]string{ + "abi": strings.Join(abis, "."), + }, + }) + } else { + ctx.Build(pctx, android.BuildParams{ + Rule: zipApexRule, + Implicits: implicitInputs, + Output: unsignedOutputFile, + Description: "apex (" + apexType.name() + ")", + Args: map[string]string{ + "tool_path": outHostBinDir + ":" + prebuiltSdkToolsBinDir, + "image_dir": android.PathForModuleOut(ctx, "image"+suffix).String(), + "copy_commands": strings.Join(copyCommands, " && "), + "manifest": a.manifestPbOut.String(), + "manifest_json_full": a.manifestJsonFullOut.String(), + }, + }) + } + + a.outputFile = android.PathForModuleOut(ctx, ctx.ModuleName()+suffix) + ctx.Build(pctx, android.BuildParams{ + Rule: java.Signapk, + Description: "signapk", + Output: a.outputFile, + Input: unsignedOutputFile, + Implicits: []android.Path{ + a.container_certificate_file, + a.container_private_key_file, + }, + Args: map[string]string{ + "certificates": a.container_certificate_file.String() + " " + a.container_private_key_file.String(), + "flags": "-a 4096", //alignment + }, + }) + + // Install to $OUT/soong/{target,host}/.../apex + if a.installable() { + ctx.InstallFile(a.installDir, ctx.ModuleName()+suffix, a.outputFile) + } + a.buildFilesInfo(ctx) +} + +func (a *apexBundle) buildFlattenedApex(ctx android.ModuleContext) { + // Temporarily wrap the original `ctx` into a `flattenedApexContext` to have it + // reply true to `InstallBypassMake()` (thus making the call + // `android.PathForModuleInstall` below use `android.pathForInstallInMakeDir` + // instead of `android.PathForOutput`) to return the correct path to the flattened + // APEX (as its contents is installed by Make, not Soong). + factx := flattenedApexContext{ctx} + apexName := proptools.StringDefault(a.properties.Apex_name, ctx.ModuleName()) + a.outputFile = android.PathForModuleInstall(&factx, "apex", apexName) + + a.buildFilesInfo(ctx) +} + +func (a *apexBundle) setCertificateAndPrivateKey(ctx android.ModuleContext) { + cert := String(a.properties.Certificate) + if cert != "" && android.SrcIsModule(cert) == "" { + defaultDir := ctx.Config().DefaultAppCertificateDir(ctx) + a.container_certificate_file = defaultDir.Join(ctx, cert+".x509.pem") + a.container_private_key_file = defaultDir.Join(ctx, cert+".pk8") + } else if cert == "" { + pem, key := ctx.Config().DefaultAppCertificate(ctx) + a.container_certificate_file = pem + a.container_private_key_file = key + } +} + +func (a *apexBundle) buildFilesInfo(ctx android.ModuleContext) { + if a.installable() { + // For flattened APEX, do nothing but make sure that apex_manifest.json and apex_pubkey are also copied along + // with other ordinary files. + a.filesInfo = append(a.filesInfo, apexFile{a.manifestJsonOut, "apex_manifest.json." + ctx.ModuleName() + a.suffix, ".", etc, nil, nil}) + a.filesInfo = append(a.filesInfo, apexFile{a.manifestPbOut, "apex_manifest.pb." + ctx.ModuleName() + a.suffix, ".", etc, nil, nil}) + + // rename to apex_pubkey + copiedPubkey := android.PathForModuleOut(ctx, "apex_pubkey") + ctx.Build(pctx, android.BuildParams{ + Rule: android.Cp, + Input: a.public_key_file, + Output: copiedPubkey, + }) + a.filesInfo = append(a.filesInfo, apexFile{copiedPubkey, "apex_pubkey." + ctx.ModuleName() + a.suffix, ".", etc, nil, nil}) + + if a.properties.ApexType == flattenedApex { + apexName := proptools.StringDefault(a.properties.Apex_name, ctx.ModuleName()) + for _, fi := range a.filesInfo { + dir := filepath.Join("apex", apexName, fi.installDir) + target := ctx.InstallFile(android.PathForModuleInstall(ctx, dir), fi.builtFile.Base(), fi.builtFile) + for _, sym := range fi.symlinks { + ctx.InstallSymlink(android.PathForModuleInstall(ctx, dir), sym, target) + } + } + } + } +} diff --git a/apex/prebuilt.go b/apex/prebuilt.go new file mode 100644 index 000000000..db3b5ef88 --- /dev/null +++ b/apex/prebuilt.go @@ -0,0 +1,198 @@ +// Copyright (C) 2019 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package apex + +import ( + "fmt" + "strings" + + "android/soong/android" + + "github.com/google/blueprint/proptools" +) + +type Prebuilt struct { + android.ModuleBase + prebuilt android.Prebuilt + + properties PrebuiltProperties + + inputApex android.Path + installDir android.InstallPath + installFilename string + outputApex android.WritablePath +} + +type PrebuiltProperties struct { + // the path to the prebuilt .apex file to import. + Source string `blueprint:"mutated"` + ForceDisable bool `blueprint:"mutated"` + + Src *string + Arch struct { + Arm struct { + Src *string + } + Arm64 struct { + Src *string + } + X86 struct { + Src *string + } + X86_64 struct { + Src *string + } + } + + Installable *bool + // Optional name for the installed apex. If unspecified, name of the + // module is used as the file name + Filename *string + + // Names of modules to be overridden. Listed modules can only be other binaries + // (in Make or Soong). + // This does not completely prevent installation of the overridden binaries, but if both + // binaries would be installed by default (in PRODUCT_PACKAGES) the other binary will be removed + // from PRODUCT_PACKAGES. + Overrides []string +} + +func (p *Prebuilt) installable() bool { + return p.properties.Installable == nil || proptools.Bool(p.properties.Installable) +} + +func (p *Prebuilt) isForceDisabled() bool { + return p.properties.ForceDisable +} + +func (p *Prebuilt) OutputFiles(tag string) (android.Paths, error) { + switch tag { + case "": + return android.Paths{p.outputApex}, nil + default: + return nil, fmt.Errorf("unsupported module reference tag %q", tag) + } +} + +func (p *Prebuilt) InstallFilename() string { + return proptools.StringDefault(p.properties.Filename, p.BaseModuleName()+imageApexSuffix) +} + +func (p *Prebuilt) Prebuilt() *android.Prebuilt { + return &p.prebuilt +} + +func (p *Prebuilt) Name() string { + return p.prebuilt.Name(p.ModuleBase.Name()) +} + +// prebuilt_apex imports an `.apex` file into the build graph as if it was built with apex. +func PrebuiltFactory() android.Module { + module := &Prebuilt{} + module.AddProperties(&module.properties) + android.InitSingleSourcePrebuiltModule(module, &module.properties, "Source") + android.InitAndroidMultiTargetsArchModule(module, android.DeviceSupported, android.MultilibCommon) + return module +} + +func (p *Prebuilt) DepsMutator(ctx android.BottomUpMutatorContext) { + // If the device is configured to use flattened APEX, force disable the prebuilt because + // the prebuilt is a non-flattened one. + forceDisable := ctx.Config().FlattenApex() + + // Force disable the prebuilts when we are doing unbundled build. We do unbundled build + // to build the prebuilts themselves. + forceDisable = forceDisable || ctx.Config().UnbundledBuild() + + // Force disable the prebuilts when coverage is enabled. + forceDisable = forceDisable || ctx.DeviceConfig().NativeCoverageEnabled() + forceDisable = forceDisable || ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") + + // b/137216042 don't use prebuilts when address sanitizer is on + forceDisable = forceDisable || android.InList("address", ctx.Config().SanitizeDevice()) || + android.InList("hwaddress", ctx.Config().SanitizeDevice()) + + if forceDisable && p.prebuilt.SourceExists() { + p.properties.ForceDisable = true + return + } + + // This is called before prebuilt_select and prebuilt_postdeps mutators + // The mutators requires that src to be set correctly for each arch so that + // arch variants are disabled when src is not provided for the arch. + if len(ctx.MultiTargets()) != 1 { + ctx.ModuleErrorf("compile_multilib shouldn't be \"both\" for prebuilt_apex") + return + } + var src string + switch ctx.MultiTargets()[0].Arch.ArchType { + case android.Arm: + src = String(p.properties.Arch.Arm.Src) + case android.Arm64: + src = String(p.properties.Arch.Arm64.Src) + case android.X86: + src = String(p.properties.Arch.X86.Src) + case android.X86_64: + src = String(p.properties.Arch.X86_64.Src) + default: + ctx.ModuleErrorf("prebuilt_apex does not support %q", ctx.MultiTargets()[0].Arch.String()) + return + } + if src == "" { + src = String(p.properties.Src) + } + p.properties.Source = src +} + +func (p *Prebuilt) GenerateAndroidBuildActions(ctx android.ModuleContext) { + if p.properties.ForceDisable { + return + } + + // TODO(jungjw): Check the key validity. + p.inputApex = p.Prebuilt().SingleSourcePath(ctx) + p.installDir = android.PathForModuleInstall(ctx, "apex") + p.installFilename = p.InstallFilename() + if !strings.HasSuffix(p.installFilename, imageApexSuffix) { + ctx.ModuleErrorf("filename should end in %s for prebuilt_apex", imageApexSuffix) + } + p.outputApex = android.PathForModuleOut(ctx, p.installFilename) + ctx.Build(pctx, android.BuildParams{ + Rule: android.Cp, + Input: p.inputApex, + Output: p.outputApex, + }) + if p.installable() { + ctx.InstallFile(p.installDir, p.installFilename, p.inputApex) + } + + // TODO(b/143192278): Add compat symlinks for prebuilt_apex +} + +func (p *Prebuilt) AndroidMkEntries() android.AndroidMkEntries { + return android.AndroidMkEntries{ + Class: "ETC", + OutputFile: android.OptionalPathForPath(p.inputApex), + Include: "$(BUILD_PREBUILT)", + ExtraEntries: []android.AndroidMkExtraEntriesFunc{ + func(entries *android.AndroidMkEntries) { + entries.SetString("LOCAL_MODULE_PATH", p.installDir.ToMakePath().String()) + entries.SetString("LOCAL_MODULE_STEM", p.installFilename) + entries.SetBoolIfTrue("LOCAL_UNINSTALLABLE_MODULE", !p.installable()) + entries.AddStrings("LOCAL_OVERRIDES_MODULES", p.properties.Overrides...) + }, + }, + } +} diff --git a/apex/vndk.go b/apex/vndk.go new file mode 100644 index 000000000..15f7f87fe --- /dev/null +++ b/apex/vndk.go @@ -0,0 +1,132 @@ +// Copyright (C) 2019 The Android Open Source Project +// +// Licensed under the Apache License, Version 2.0 (the "License"); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package apex + +import ( + "path/filepath" + "strings" + "sync" + + "android/soong/android" + "android/soong/cc" + + "github.com/google/blueprint/proptools" +) + +const ( + vndkApexNamePrefix = "com.android.vndk.v" +) + +// apex_vndk creates a special variant of apex modules which contains only VNDK libraries. +// If `vndk_version` is specified, the VNDK libraries of the specified VNDK version are gathered automatically. +// If not specified, then the "current" versions are gathered. +func vndkApexBundleFactory() android.Module { + bundle := newApexBundle() + bundle.vndkApex = true + bundle.AddProperties(&bundle.vndkProperties) + android.AddLoadHook(bundle, func(ctx android.LoadHookContext) { + ctx.AppendProperties(&struct { + Compile_multilib *string + }{ + proptools.StringPtr("both"), + }) + }) + return bundle +} + +func (a *apexBundle) vndkVersion(config android.DeviceConfig) string { + vndkVersion := proptools.StringDefault(a.vndkProperties.Vndk_version, "current") + if vndkVersion == "current" { + vndkVersion = config.PlatformVndkVersion() + } + return vndkVersion +} + +type apexVndkProperties struct { + // Indicates VNDK version of which this VNDK APEX bundles VNDK libs. Default is Platform VNDK Version. + Vndk_version *string +} + +var ( + vndkApexListKey = android.NewOnceKey("vndkApexList") + vndkApexListMutex sync.Mutex +) + +func vndkApexList(config android.Config) map[string]string { + return config.Once(vndkApexListKey, func() interface{} { + return map[string]string{} + }).(map[string]string) +} + +func apexVndkMutator(mctx android.TopDownMutatorContext) { + if ab, ok := mctx.Module().(*apexBundle); ok && ab.vndkApex { + if ab.IsNativeBridgeSupported() { + mctx.PropertyErrorf("native_bridge_supported", "%q doesn't support native bridge binary.", mctx.ModuleType()) + } + + vndkVersion := ab.vndkVersion(mctx.DeviceConfig()) + // Ensure VNDK APEX mount point is formatted as com.android.vndk.v### + ab.properties.Apex_name = proptools.StringPtr(vndkApexNamePrefix + vndkVersion) + + // vndk_version should be unique + vndkApexListMutex.Lock() + defer vndkApexListMutex.Unlock() + vndkApexList := vndkApexList(mctx.Config()) + if other, ok := vndkApexList[vndkVersion]; ok { + mctx.PropertyErrorf("vndk_version", "%v is already defined in %q", vndkVersion, other) + } + vndkApexList[vndkVersion] = mctx.ModuleName() + } +} + +func apexVndkDepsMutator(mctx android.BottomUpMutatorContext) { + if m, ok := mctx.Module().(*cc.Module); ok && cc.IsForVndkApex(mctx, m) { + vndkVersion := m.VndkVersion() + vndkApexList := vndkApexList(mctx.Config()) + if vndkApex, ok := vndkApexList[vndkVersion]; ok { + mctx.AddReverseDependency(mctx.Module(), sharedLibTag, vndkApex) + } + } else if a, ok := mctx.Module().(*apexBundle); ok && a.vndkApex { + vndkVersion := proptools.StringDefault(a.vndkProperties.Vndk_version, "current") + mctx.AddDependency(mctx.Module(), prebuiltTag, cc.VndkLibrariesTxtModules(vndkVersion)...) + } +} + +func makeCompatSymlinks(apexName string, ctx android.ModuleContext) (symlinks []string) { + // small helper to add symlink commands + addSymlink := func(target, dir, linkName string) { + outDir := filepath.Join("$(PRODUCT_OUT)", dir) + link := filepath.Join(outDir, linkName) + symlinks = append(symlinks, "mkdir -p "+outDir+" && rm -rf "+link+" && ln -sf "+target+" "+link) + } + + // TODO(b/142911355): [VNDK APEX] Fix hard-coded references to /system/lib/vndk + // When all hard-coded references are fixed, remove symbolic links + // Note that we should keep following symlinks for older VNDKs (<=29) + // Since prebuilt vndk libs still depend on system/lib/vndk path + if strings.HasPrefix(apexName, vndkApexNamePrefix) { + // the name of vndk apex is formatted "com.android.vndk.v" + version + vndkVersion := strings.TrimPrefix(apexName, vndkApexNamePrefix) + if ctx.Config().Android64() { + addSymlink("/apex/"+apexName+"/lib64", "/system/lib64", "vndk-sp-"+vndkVersion) + addSymlink("/apex/"+apexName+"/lib64", "/system/lib64", "vndk-"+vndkVersion) + } + if !ctx.Config().Android64() || ctx.DeviceConfig().DeviceSecondaryArch() != "" { + addSymlink("/apex/"+apexName+"/lib", "/system/lib", "vndk-sp-"+vndkVersion) + addSymlink("/apex/"+apexName+"/lib", "/system/lib", "vndk-"+vndkVersion) + } + } + return +}