| // 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, apexBundleName, apexName, moduleDir string) []string { |
| // apexBundleName comes from the 'name' property; apexName comes from 'apex_name' property. |
| // An apex is installed to /system/apex/<apexBundleName> and is activated at /apex/<apexName> |
| // In many cases, the two names are the same, but could be different in general. |
| |
| 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 |
| } |
| |
| // b/140136207. When there are overriding APEXes for a VNDK APEX, the symbols file for the overridden |
| // APEX and the overriding APEX will have the same installation paths at /apex/com.android.vndk.v<ver> |
| // as their apexName will be the same. To avoid the path conflicts, skip installing the symbol files |
| // for the overriding VNDK APEXes. |
| symbolFilesNotNeeded := a.vndkApex && len(a.overridableProperties.Overrides) > 0 |
| if symbolFilesNotNeeded && apexType != flattenedApex { |
| return moduleNames |
| } |
| |
| var postInstallCommands []string |
| for _, fi := range a.filesInfo { |
| if a.linkToSystemLib && fi.transitiveDep && fi.AvailableToPlatform() { |
| // TODO(jiyong): pathOnDevice should come from fi.module, not being calculated here |
| linkTarget := filepath.Join("/system", fi.Path()) |
| linkPath := filepath.Join(a.installDir.ToMakePath().String(), apexBundleName, fi.Path()) |
| mkdirCmd := "mkdir -p " + filepath.Dir(linkPath) |
| linkCmd := "ln -sfn " + linkTarget + " " + linkPath |
| postInstallCommands = append(postInstallCommands, mkdirCmd, linkCmd) |
| } |
| } |
| |
| seenDataOutPaths := make(map[string]bool) |
| |
| for _, fi := range a.filesInfo { |
| if cc, ok := fi.module.(*cc.Module); ok && cc.Properties.HideFromMake { |
| continue |
| } |
| |
| linkToSystemLib := a.linkToSystemLib && fi.transitiveDep && fi.AvailableToPlatform() |
| |
| var moduleName string |
| if linkToSystemLib { |
| moduleName = fi.moduleName |
| } else { |
| moduleName = fi.moduleName + "." + apexBundleName + a.suffix |
| } |
| |
| if !android.InList(moduleName, moduleNames) { |
| moduleNames = append(moduleNames, moduleName) |
| } |
| |
| if linkToSystemLib { |
| // No need to copy the file since it's linked to the system file |
| continue |
| } |
| |
| fmt.Fprintln(w, "\ninclude $(CLEAR_VARS)") |
| if fi.moduleDir != "" { |
| fmt.Fprintln(w, "LOCAL_PATH :=", fi.moduleDir) |
| } else { |
| fmt.Fprintln(w, "LOCAL_PATH :=", moduleDir) |
| } |
| fmt.Fprintln(w, "LOCAL_MODULE :=", moduleName) |
| // /apex/<apex_name>/{lib|framework|...} |
| pathWhenActivated := filepath.Join("$(PRODUCT_OUT)", "apex", apexName, fi.installDir) |
| if apexType == flattenedApex { |
| // /system/apex/<name>/{lib|framework|...} |
| modulePath := filepath.Join(a.installDir.ToMakePath().String(), apexBundleName, fi.installDir) |
| fmt.Fprintln(w, "LOCAL_MODULE_PATH :=", modulePath) |
| if a.primaryApexType && !symbolFilesNotNeeded { |
| fmt.Fprintln(w, "LOCAL_SOONG_SYMBOL_PATH :=", pathWhenActivated) |
| } |
| if len(fi.symlinks) > 0 { |
| fmt.Fprintln(w, "LOCAL_MODULE_SYMLINKS :=", strings.Join(fi.symlinks, " ")) |
| } |
| newDataPaths := []android.Path{} |
| for _, path := range fi.dataPaths { |
| dataOutPath := modulePath + ":" + path.Rel() |
| if ok := seenDataOutPaths[dataOutPath]; !ok { |
| newDataPaths = append(newDataPaths, path) |
| seenDataOutPaths[dataOutPath] = true |
| } |
| } |
| if len(newDataPaths) > 0 { |
| fmt.Fprintln(w, "LOCAL_TEST_DATA :=", strings.Join(cc.AndroidMkDataPaths(newDataPaths), " ")) |
| } |
| |
| if fi.module != nil && len(fi.module.NoticeFiles()) > 0 { |
| fmt.Fprintln(w, "LOCAL_NOTICE_FILE :=", strings.Join(fi.module.NoticeFiles().Strings(), " ")) |
| } |
| } else { |
| fmt.Fprintln(w, "LOCAL_MODULE_PATH :=", pathWhenActivated) |
| |
| // For non-flattend APEXes, the merged notice file is attached to the APEX itself. |
| // We don't need to have notice file for the individual modules in it. Otherwise, |
| // we will have duplicated notice entries. |
| fmt.Fprintln(w, "LOCAL_NO_NOTICE_FILE := true") |
| } |
| 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.jacocoReportClassesFile != nil { |
| fmt.Fprintln(w, "LOCAL_SOONG_JACOCO_REPORT_CLASSES_JAR :=", fi.jacocoReportClassesFile.String()) |
| } |
| if fi.class == javaSharedLib { |
| javaModule := fi.module.(java.Dependency) |
| // 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 == app { |
| fmt.Fprintln(w, "LOCAL_CERTIFICATE :=", fi.certificate.AndroidMkString()) |
| // soong_app_prebuilt.mk sets LOCAL_MODULE_SUFFIX := .apk Therefore |
| // we need to remove the suffix from LOCAL_MODULE_STEM, otherwise |
| // we will have foo.apk.apk |
| fmt.Fprintln(w, "LOCAL_MODULE_STEM :=", strings.TrimSuffix(fi.builtFile.Base(), ".apk")) |
| if app, ok := fi.module.(*java.AndroidApp); ok && len(app.JniCoverageOutputs()) > 0 { |
| fmt.Fprintln(w, "LOCAL_PREBUILT_COVERAGE_ARCHIVE :=", strings.Join(app.JniCoverageOutputs().Strings(), " ")) |
| } |
| fmt.Fprintln(w, "include $(BUILD_SYSTEM)/soong_app_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()) |
| if fi.builtFile == a.manifestPbOut && apexType == flattenedApex { |
| if a.primaryApexType { |
| // Make apex_manifest.pb module for this APEX to override all other |
| // modules in the APEXes being overridden by this APEX |
| var patterns []string |
| for _, o := range a.overridableProperties.Overrides { |
| patterns = append(patterns, "%."+o+a.suffix) |
| } |
| fmt.Fprintln(w, "LOCAL_OVERRIDES_MODULES :=", strings.Join(patterns, " ")) |
| |
| if len(a.compatSymlinks) > 0 { |
| // For flattened apexes, compat symlinks are attached to apex_manifest.json which is guaranteed for every apex |
| 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)") |
| } |
| |
| // m <module_name> will build <module_name>.<apex_name> as well. |
| if fi.moduleName != moduleName && a.primaryApexType { |
| fmt.Fprintln(w, ".PHONY: "+fi.moduleName) |
| fmt.Fprintln(w, fi.moduleName+": "+moduleName) |
| } |
| } |
| return moduleNames |
| } |
| |
| func (a *apexBundle) writeRequiredModules(w io.Writer) { |
| var required []string |
| var targetRequired []string |
| var hostRequired []string |
| for _, fi := range a.filesInfo { |
| required = append(required, fi.requiredModuleNames...) |
| targetRequired = append(targetRequired, fi.targetRequiredModuleNames...) |
| hostRequired = append(hostRequired, fi.hostRequiredModuleNames...) |
| } |
| |
| if len(required) > 0 { |
| fmt.Fprintln(w, "LOCAL_REQUIRED_MODULES +=", strings.Join(required, " ")) |
| } |
| if len(targetRequired) > 0 { |
| fmt.Fprintln(w, "LOCAL_TARGET_REQUIRED_MODULES +=", strings.Join(targetRequired, " ")) |
| } |
| if len(hostRequired) > 0 { |
| fmt.Fprintln(w, "LOCAL_HOST_REQUIRED_MODULES +=", strings.Join(hostRequired, " ")) |
| } |
| } |
| |
| 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, name, 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, " ")) |
| } |
| a.writeRequiredModules(w) |
| fmt.Fprintln(w, "include $(BUILD_PHONY_PACKAGE)") |
| |
| } 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()) |
| fmt.Fprintln(w, "LOCAL_OVERRIDES_MODULES :=", strings.Join(a.overridableProperties.Overrides, " ")) |
| if len(moduleNames) > 0 { |
| fmt.Fprintln(w, "LOCAL_REQUIRED_MODULES +=", strings.Join(moduleNames, " ")) |
| } |
| if len(a.requiredDeps) > 0 { |
| fmt.Fprintln(w, "LOCAL_REQUIRED_MODULES +=", strings.Join(a.requiredDeps, " ")) |
| } |
| a.writeRequiredModules(w) |
| 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, " && ")) |
| } |
| |
| if a.mergedNotices.Merged.Valid() { |
| fmt.Fprintln(w, "LOCAL_NOTICE_FILE :=", a.mergedNotices.Merged.Path().String()) |
| } |
| |
| fmt.Fprintln(w, "include $(BUILD_PREBUILT)") |
| |
| if apexType == imageApex { |
| fmt.Fprintln(w, "ALL_MODULES.$(my_register_name).BUNDLE :=", a.bundleModuleFile.String()) |
| } |
| |
| if a.installedFilesFile != nil { |
| goal := "checkbuild" |
| distFile := name + "-installed-files.txt" |
| fmt.Fprintln(w, ".PHONY:", goal) |
| fmt.Fprintf(w, "$(call dist-for-goals,%s,%s:%s)\n", |
| goal, a.installedFilesFile.String(), distFile) |
| } |
| } |
| }} |
| } |