1// Copyright (C) 2019 The Android Open Source Project 2// 3// Licensed under the Apache License, Version 2.0 (the "License"); 4// you may not use this file except in compliance with the License. 5// You may obtain a copy of the License at 6// 7// http://www.apache.org/licenses/LICENSE-2.0 8// 9// Unless required by applicable law or agreed to in writing, software 10// distributed under the License is distributed on an "AS IS" BASIS, 11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12// See the License for the specific language governing permissions and 13// limitations under the License. 14 15package apex 16 17import ( 18 "fmt" 19 "io" 20 "path/filepath" 21 "strings" 22 23 "android/soong/android" 24 "android/soong/cc" 25 "android/soong/java" 26 "android/soong/rust" 27) 28 29func (a *apexBundle) AndroidMk() android.AndroidMkData { 30 if a.properties.HideFromMake { 31 return android.AndroidMkData{ 32 Disabled: true, 33 } 34 } 35 return a.androidMkForType() 36} 37 38// nameInMake converts apexFileClass into the corresponding class name in Make. 39func (class apexFileClass) nameInMake() string { 40 switch class { 41 case etc: 42 return "ETC" 43 case nativeSharedLib: 44 return "SHARED_LIBRARIES" 45 case nativeExecutable, shBinary: 46 return "EXECUTABLES" 47 case javaSharedLib: 48 return "JAVA_LIBRARIES" 49 case nativeTest: 50 return "NATIVE_TESTS" 51 case app, appSet: 52 // b/142537672 Why isn't this APP? We want to have full control over 53 // the paths and file names of the apk file under the flattend APEX. 54 // If this is set to APP, then the paths and file names are modified 55 // by the Make build system. For example, it is installed to 56 // /system/apex/<apexname>/app/<Appname>/<apexname>.<Appname>/ instead of 57 // /system/apex/<apexname>/app/<Appname> because the build system automatically 58 // appends module name (which is <apexname>.<Appname> to the path. 59 return "ETC" 60 default: 61 panic(fmt.Errorf("unknown class %d", class)) 62 } 63} 64 65// Return the full module name for a dependency module, which appends the apex module name unless re-using a system lib. 66func (a *apexBundle) fullModuleName(apexBundleName string, linkToSystemLib bool, fi *apexFile) string { 67 if linkToSystemLib { 68 return fi.androidMkModuleName 69 } 70 return fi.androidMkModuleName + "." + apexBundleName 71} 72 73// androidMkForFiles generates Make definitions for the contents of an 74// apexBundle (apexBundle#filesInfo). The filesInfo structure can either be 75// populated by Soong for unconverted APEXes, or Bazel in mixed mode. Use 76// apexFile#isBazelPrebuilt to differentiate. 77func (a *apexBundle) androidMkForFiles(w io.Writer, apexBundleName, moduleDir string, 78 apexAndroidMkData android.AndroidMkData) (archSpecificModuleNames []string, moduleNames []string) { 79 80 // apexBundleName comes from the 'name' property or soong module. 81 // apexName comes from 'name' property of apex_manifest. 82 // An apex is installed to /system/apex/<apexBundleName> and is activated at /apex/<apexName> 83 // In many cases, the two names are the same, but could be different in general. 84 // However, symbol files for apex files are installed under /apex/<apexBundleName> to avoid 85 // conflicts between two apexes with the same apexName. 86 87 for _, fi := range a.filesInfo { 88 linkToSystemLib := a.linkToSystemLib && fi.transitiveDep && fi.availableToPlatform() 89 moduleName := a.fullModuleName(apexBundleName, linkToSystemLib, &fi) 90 if !android.InList(moduleName, moduleNames) { 91 moduleNames = append(moduleNames, moduleName) 92 } 93 94 // This name will be added to LOCAL_REQUIRED_MODULES of the APEX. We need to be 95 // arch-specific otherwise we will end up installing both ABIs even when only 96 // either of the ABI is requested. 97 aName := moduleName 98 switch fi.multilib { 99 case "lib32": 100 aName = aName + ":32" 101 case "lib64": 102 aName = aName + ":64" 103 } 104 if !android.InList(aName, archSpecificModuleNames) { 105 archSpecificModuleNames = append(archSpecificModuleNames, aName) 106 } 107 108 if linkToSystemLib { 109 // No need to copy the file since it's linked to the system file 110 continue 111 } 112 113 fmt.Fprintln(w, "\ninclude $(CLEAR_VARS) # apex.apexBundle.files") 114 if fi.moduleDir != "" { 115 fmt.Fprintln(w, "LOCAL_PATH :=", fi.moduleDir) 116 } else { 117 fmt.Fprintln(w, "LOCAL_PATH :=", moduleDir) 118 } 119 fmt.Fprintln(w, "LOCAL_MODULE :=", moduleName) 120 121 if fi.module != nil && fi.module.Owner() != "" { 122 fmt.Fprintln(w, "LOCAL_MODULE_OWNER :=", fi.module.Owner()) 123 } 124 // /apex/<apexBundleName>/{lib|framework|...} 125 pathForSymbol := filepath.Join("$(PRODUCT_OUT)", "apex", apexBundleName, fi.installDir) 126 modulePath := pathForSymbol 127 fmt.Fprintln(w, "LOCAL_MODULE_PATH :=", modulePath) 128 // AconfigUpdateAndroidMkData may have added elements to Extra. Process them here. 129 for _, extra := range apexAndroidMkData.Extra { 130 extra(w, fi.builtFile) 131 } 132 133 // For non-flattend APEXes, the merged notice file is attached to the APEX itself. 134 // We don't need to have notice file for the individual modules in it. Otherwise, 135 // we will have duplicated notice entries. 136 fmt.Fprintln(w, "LOCAL_NO_NOTICE_FILE := true") 137 fmt.Fprintln(w, "LOCAL_SOONG_INSTALLED_MODULE :=", filepath.Join(modulePath, fi.stem())) 138 fmt.Fprintln(w, "LOCAL_SOONG_INSTALL_PAIRS :=", fi.builtFile.String()+":"+filepath.Join(modulePath, fi.stem())) 139 fmt.Fprintln(w, "LOCAL_PREBUILT_MODULE_FILE :=", fi.builtFile.String()) 140 if fi.checkbuildTarget != nil { 141 fmt.Fprintln(w, "LOCAL_CHECKED_MODULE :=", fi.checkbuildTarget.String()) 142 } else { 143 fmt.Fprintln(w, "LOCAL_CHECKED_MODULE :=", fi.builtFile.String()) 144 } 145 fmt.Fprintln(w, "LOCAL_MODULE_CLASS :=", fi.class.nameInMake()) 146 if fi.module != nil { 147 // This apexFile's module comes from Soong 148 if fi.module.Target().Arch.ArchType != android.Common { 149 archStr := fi.module.Target().Arch.ArchType.String() 150 fmt.Fprintln(w, "LOCAL_MODULE_TARGET_ARCH :=", archStr) 151 } 152 } 153 if fi.jacocoReportClassesFile != nil { 154 fmt.Fprintln(w, "LOCAL_SOONG_JACOCO_REPORT_CLASSES_JAR :=", fi.jacocoReportClassesFile.String()) 155 } 156 switch fi.class { 157 case javaSharedLib: 158 // soong_java_prebuilt.mk sets LOCAL_MODULE_SUFFIX := .jar Therefore 159 // we need to remove the suffix from LOCAL_MODULE_STEM, otherwise 160 // we will have foo.jar.jar 161 fmt.Fprintln(w, "LOCAL_MODULE_STEM :=", strings.TrimSuffix(fi.stem(), ".jar")) 162 if javaModule, ok := fi.module.(java.ApexDependency); ok { 163 fmt.Fprintln(w, "LOCAL_SOONG_CLASSES_JAR :=", javaModule.ImplementationAndResourcesJars()[0].String()) 164 fmt.Fprintln(w, "LOCAL_SOONG_HEADER_JAR :=", javaModule.HeaderJars()[0].String()) 165 } else { 166 fmt.Fprintln(w, "LOCAL_SOONG_CLASSES_JAR :=", fi.builtFile.String()) 167 fmt.Fprintln(w, "LOCAL_SOONG_HEADER_JAR :=", fi.builtFile.String()) 168 } 169 fmt.Fprintln(w, "LOCAL_SOONG_DEX_JAR :=", fi.builtFile.String()) 170 fmt.Fprintln(w, "LOCAL_DEX_PREOPT := false") 171 fmt.Fprintln(w, "include $(BUILD_SYSTEM)/soong_java_prebuilt.mk") 172 case app: 173 fmt.Fprintln(w, "LOCAL_CERTIFICATE :=", fi.certificate.AndroidMkString()) 174 // soong_app_prebuilt.mk sets LOCAL_MODULE_SUFFIX := .apk Therefore 175 // we need to remove the suffix from LOCAL_MODULE_STEM, otherwise 176 // we will have foo.apk.apk 177 fmt.Fprintln(w, "LOCAL_MODULE_STEM :=", strings.TrimSuffix(fi.stem(), ".apk")) 178 if app, ok := fi.module.(*java.AndroidApp); ok { 179 android.AndroidMkEmitAssignList(w, "LOCAL_PREBUILT_COVERAGE_ARCHIVE", app.JniCoverageOutputs().Strings()) 180 if jniLibSymbols := app.JNISymbolsInstalls(modulePath); len(jniLibSymbols) > 0 { 181 fmt.Fprintln(w, "LOCAL_SOONG_JNI_LIBS_SYMBOLS :=", jniLibSymbols.String()) 182 } 183 } 184 fmt.Fprintln(w, "include $(BUILD_SYSTEM)/soong_app_prebuilt.mk") 185 case appSet: 186 as, ok := fi.module.(*java.AndroidAppSet) 187 if !ok { 188 panic(fmt.Sprintf("Expected %s to be AndroidAppSet", fi.module)) 189 } 190 fmt.Fprintln(w, "LOCAL_APK_SET_INSTALL_FILE :=", as.PackedAdditionalOutputs().String()) 191 fmt.Fprintln(w, "LOCAL_APKCERTS_FILE :=", as.APKCertsFile().String()) 192 fmt.Fprintln(w, "include $(BUILD_SYSTEM)/soong_android_app_set.mk") 193 case nativeSharedLib, nativeExecutable, nativeTest: 194 fmt.Fprintln(w, "LOCAL_MODULE_STEM :=", fi.stem()) 195 if ccMod, ok := fi.module.(*cc.Module); ok { 196 if ccMod.UnstrippedOutputFile() != nil { 197 fmt.Fprintln(w, "LOCAL_SOONG_UNSTRIPPED_BINARY :=", ccMod.UnstrippedOutputFile().String()) 198 } 199 ccMod.AndroidMkWriteAdditionalDependenciesForSourceAbiDiff(w) 200 if ccMod.CoverageOutputFile().Valid() { 201 fmt.Fprintln(w, "LOCAL_PREBUILT_COVERAGE_ARCHIVE :=", ccMod.CoverageOutputFile().String()) 202 } 203 } else if rustMod, ok := fi.module.(*rust.Module); ok { 204 if rustMod.UnstrippedOutputFile() != nil { 205 fmt.Fprintln(w, "LOCAL_SOONG_UNSTRIPPED_BINARY :=", rustMod.UnstrippedOutputFile().String()) 206 } 207 } 208 fmt.Fprintln(w, "include $(BUILD_SYSTEM)/soong_cc_rust_prebuilt.mk") 209 default: 210 fmt.Fprintln(w, "LOCAL_MODULE_STEM :=", fi.stem()) 211 fmt.Fprintln(w, "include $(BUILD_PREBUILT)") 212 } 213 214 // m <module_name> will build <module_name>.<apex_name> as well. 215 if fi.androidMkModuleName != moduleName { 216 fmt.Fprintf(w, ".PHONY: %s\n", fi.androidMkModuleName) 217 fmt.Fprintf(w, "%s: %s\n", fi.androidMkModuleName, moduleName) 218 } 219 } 220 return 221} 222 223func (a *apexBundle) writeRequiredModules(w io.Writer, moduleNames []string) { 224 var required []string 225 var targetRequired []string 226 var hostRequired []string 227 required = append(required, a.required...) 228 targetRequired = append(targetRequired, a.TargetRequiredModuleNames()...) 229 hostRequired = append(hostRequired, a.HostRequiredModuleNames()...) 230 android.AndroidMkEmitAssignList(w, "LOCAL_REQUIRED_MODULES", moduleNames, a.makeModulesToInstall, required) 231 android.AndroidMkEmitAssignList(w, "LOCAL_TARGET_REQUIRED_MODULES", targetRequired) 232 android.AndroidMkEmitAssignList(w, "LOCAL_HOST_REQUIRED_MODULES", hostRequired) 233} 234 235func (a *apexBundle) androidMkForType() android.AndroidMkData { 236 return android.AndroidMkData{ 237 // While we do not provide a value for `Extra`, AconfigUpdateAndroidMkData may add some, which we must honor. 238 Custom: func(w io.Writer, name, prefix, moduleDir string, data android.AndroidMkData) { 239 archSpecificModuleNames := []string{} 240 moduleNames := []string{} 241 if a.installable() { 242 archSpecificModuleNames, moduleNames = a.androidMkForFiles(w, name, moduleDir, data) 243 } 244 245 fmt.Fprintln(w, "\ninclude $(CLEAR_VARS) # apex.apexBundle") 246 fmt.Fprintln(w, "LOCAL_PATH :=", moduleDir) 247 fmt.Fprintln(w, "LOCAL_MODULE :=", name) 248 fmt.Fprintln(w, "LOCAL_MODULE_CLASS := ETC") // do we need a new class? 249 fmt.Fprintln(w, "LOCAL_PREBUILT_MODULE_FILE :=", a.outputFile.String()) 250 fmt.Fprintln(w, "LOCAL_MODULE_PATH :=", a.installDir.String()) 251 stemSuffix := imageApexSuffix 252 if a.isCompressed { 253 stemSuffix = imageCapexSuffix 254 } 255 fmt.Fprintln(w, "LOCAL_MODULE_STEM :=", name+stemSuffix) 256 fmt.Fprintln(w, "LOCAL_UNINSTALLABLE_MODULE :=", !a.installable()) 257 if a.installable() { 258 fmt.Fprintln(w, "LOCAL_SOONG_INSTALLED_MODULE :=", a.installedFile.String()) 259 fmt.Fprintln(w, "LOCAL_SOONG_INSTALL_PAIRS :=", a.outputFile.String()+":"+a.installedFile.String()) 260 fmt.Fprintln(w, "LOCAL_SOONG_INSTALL_SYMLINKS := ", strings.Join(a.compatSymlinks.Strings(), " ")) 261 fmt.Fprintln(w, "LOCAL_SOONG_INSTALL_PAIRS +=", a.extraInstalledPairs.String()) 262 } 263 fmt.Fprintln(w, "LOCAL_APEX_KEY_PATH := ", a.apexKeysPath.String()) 264 265 // Because apex writes .mk with Custom(), we need to write manually some common properties 266 // which are available via data.Entries 267 commonProperties := []string{ 268 "LOCAL_FULL_INIT_RC", "LOCAL_FULL_VINTF_FRAGMENTS", 269 "LOCAL_PROPRIETARY_MODULE", "LOCAL_VENDOR_MODULE", "LOCAL_ODM_MODULE", "LOCAL_PRODUCT_MODULE", "LOCAL_SYSTEM_EXT_MODULE", 270 "LOCAL_MODULE_OWNER", 271 } 272 for _, name := range commonProperties { 273 if value, ok := data.Entries.EntryMap[name]; ok { 274 android.AndroidMkEmitAssignList(w, name, value) 275 } 276 } 277 278 android.AndroidMkEmitAssignList(w, "LOCAL_OVERRIDES_MODULES", a.overridableProperties.Overrides) 279 a.writeRequiredModules(w, archSpecificModuleNames) 280 // AconfigUpdateAndroidMkData may have added elements to Extra. Process them here. 281 for _, extra := range data.Extra { 282 extra(w, a.outputFile) 283 } 284 285 fmt.Fprintln(w, "include $(BUILD_PREBUILT)") 286 fmt.Fprintln(w, "ALL_MODULES.$(my_register_name).BUNDLE :=", a.bundleModuleFile.String()) 287 android.AndroidMkEmitAssignList(w, "ALL_MODULES.$(my_register_name).LINT_REPORTS", a.lintReports.Strings()) 288 289 if a.installedFilesFile != nil { 290 goal := "checkbuild" 291 distFile := name + "-installed-files.txt" 292 fmt.Fprintln(w, ".PHONY:", goal) 293 fmt.Fprintf(w, "$(call dist-for-goals,%s,%s:%s)\n", 294 goal, a.installedFilesFile.String(), distFile) 295 fmt.Fprintf(w, "$(call declare-0p-target,%s)\n", a.installedFilesFile.String()) 296 } 297 for _, dist := range data.Entries.GetDistForGoals(a) { 298 fmt.Fprintln(w, dist) 299 } 300 301 fmt.Fprintf(w, "ALL_MODULES.$(my_register_name).SYMBOLIC_OUTPUT_PATH := $(foreach m,%s,$(ALL_MODULES.$(m).SYMBOLIC_OUTPUT_PATH))\n", strings.Join(moduleNames, " ")) 302 fmt.Fprintf(w, "ALL_MODULES.$(my_register_name).ELF_SYMBOL_MAPPING_PATH := $(foreach m,%s,$(ALL_MODULES.$(m).ELF_SYMBOL_MAPPING_PATH))\n", strings.Join(moduleNames, " ")) 303 304 distCoverageFiles(w, "ndk_apis_usedby_apex", a.nativeApisUsedByModuleFile.String()) 305 distCoverageFiles(w, "ndk_apis_backedby_apex", a.nativeApisBackedByModuleFile.String()) 306 distCoverageFiles(w, "java_apis_used_by_apex", a.javaApisUsedByModuleFile.String()) 307 }} 308} 309 310func distCoverageFiles(w io.Writer, dir string, distfile string) { 311 if distfile != "" { 312 goal := "apps_only" 313 fmt.Fprintf(w, "ifneq (,$(filter $(my_register_name),$(TARGET_BUILD_APPS)))\n"+ 314 " $(call dist-for-goals,%s,%s:%s/$(notdir %s))\n"+ 315 "endif\n", goal, distfile, dir, distfile) 316 } 317} 318