blob: 6d6b41d4b22de1d3c5921f90677890551522388c [file] [log] [blame]
Colin Cross43f08db2018-11-12 10:13:39 -08001// Copyright 2018 Google Inc. All rights reserved.
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 dexpreopt
16
17import (
18 "encoding/json"
Martin Stjernholmd90676f2020-01-11 00:37:30 +000019 "fmt"
Paul Duffin7d1d0832021-04-23 11:39:41 +010020 "reflect"
Colin Cross69f59a32019-02-15 10:39:37 -080021 "strings"
Colin Cross74ba9622019-02-11 15:11:14 -080022
Martin Stjernholmd90676f2020-01-11 00:37:30 +000023 "github.com/google/blueprint"
24
Colin Cross74ba9622019-02-11 15:11:14 -080025 "android/soong/android"
Colin Cross43f08db2018-11-12 10:13:39 -080026)
27
Martin Stjernholmc52aaf12020-01-06 23:11:37 +000028// GlobalConfig stores the configuration for dex preopting. The fields are set
Martin Stjernholm75a48d82020-01-10 20:32:59 +000029// from product variables via dex_preopt_config.mk.
Colin Cross43f08db2018-11-12 10:13:39 -080030type GlobalConfig struct {
Ulya Trafimovicha4a1c4e2021-01-15 18:40:04 +000031 DisablePreopt bool // disable preopt for all modules (excluding boot images)
32 DisablePreoptBootImages bool // disable prepot for boot images
33 DisablePreoptModules []string // modules with preopt disabled by product-specific config
Colin Cross43f08db2018-11-12 10:13:39 -080034
35 OnlyPreoptBootImageAndSystemServer bool // only preopt jars in the boot image or system server
36
Ulya Trafimovich9023b022021-03-22 16:02:28 +000037 PreoptWithUpdatableBcp bool // If updatable boot jars are included in dexpreopt or not.
38
Vladimir Marko40139d62020-02-06 15:14:29 +000039 UseArtImage bool // use the art image (use other boot class path dex files without image)
40
Colin Cross43f08db2018-11-12 10:13:39 -080041 HasSystemOther bool // store odex files that match PatternsOnSystemOther on the system_other partition
42 PatternsOnSystemOther []string // patterns (using '%' to denote a prefix match) to put odex on the system_other partition
43
Colin Cross69f59a32019-02-15 10:39:37 -080044 DisableGenerateProfile bool // don't generate profiles
45 ProfileDir string // directory to find profiles in
Colin Cross43f08db2018-11-12 10:13:39 -080046
satayevd604b212021-07-21 14:23:52 +010047 BootJars android.ConfiguredJarList // modules for jars that form the boot class path
48 ApexBootJars android.ConfiguredJarList // jars within apex that form the boot class path
Vladimir Markod2ee5322018-12-19 17:57:57 +000049
Ulya Trafimovich249386a2020-07-01 14:31:13 +010050 ArtApexJars android.ConfiguredJarList // modules for jars that are in the ART APEX
Colin Cross800fe132019-02-11 14:21:24 -080051
Jiakai Zhangcee9e192021-10-29 19:46:45 +000052 SystemServerJars android.ConfiguredJarList // system_server classpath jars on the platform
53 SystemServerApps []string // apps that are loaded into system server
54 ApexSystemServerJars android.ConfiguredJarList // system_server classpath jars delivered via apex
55 StandaloneSystemServerJars android.ConfiguredJarList // jars on the platform that system_server loads dynamically using separate classloaders
56 ApexStandaloneSystemServerJars android.ConfiguredJarList // jars delivered via apex that system_server loads dynamically using separate classloaders
57 SpeedApps []string // apps that should be speed optimized
Colin Cross43f08db2018-11-12 10:13:39 -080058
Ulya Trafimovichcd3203f2020-03-27 11:30:00 +000059 BrokenSuboptimalOrderOfSystemServerJars bool // if true, sub-optimal order does not cause a build error
60
Colin Cross43f08db2018-11-12 10:13:39 -080061 PreoptFlags []string // global dex2oat flags that should be used if no module-specific dex2oat flags are specified
62
63 DefaultCompilerFilter string // default compiler filter to pass to dex2oat, overridden by --compiler-filter= in module-specific dex2oat flags
64 SystemServerCompilerFilter string // default compiler filter to pass to dex2oat for system server jars
65
Nicolas Geoffrayc1bf7242019-10-18 14:51:38 +010066 GenerateDMFiles bool // generate Dex Metadata files
Colin Cross43f08db2018-11-12 10:13:39 -080067
68 NoDebugInfo bool // don't generate debug info by default
Mathieu Chartier3f7ddbb2019-04-29 09:33:50 -070069 DontResolveStartupStrings bool // don't resolve string literals loaded during application startup.
Colin Cross43f08db2018-11-12 10:13:39 -080070 AlwaysSystemServerDebugInfo bool // always generate mini debug info for system server modules (overrides NoDebugInfo=true)
71 NeverSystemServerDebugInfo bool // never generate mini debug info for system server modules (overrides NoDebugInfo=false)
72 AlwaysOtherDebugInfo bool // always generate mini debug info for non-system server modules (overrides NoDebugInfo=true)
73 NeverOtherDebugInfo bool // never generate mini debug info for non-system server modules (overrides NoDebugInfo=true)
74
Colin Cross43f08db2018-11-12 10:13:39 -080075 IsEng bool // build is a eng variant
76 SanitizeLite bool // build is the second phase of a SANITIZE_LITE build
77
78 DefaultAppImages bool // build app images (TODO: .art files?) by default
79
Colin Cross800fe132019-02-11 14:21:24 -080080 Dex2oatXmx string // max heap size for dex2oat
81 Dex2oatXms string // initial heap size for dex2oat
Colin Cross43f08db2018-11-12 10:13:39 -080082
83 EmptyDirectory string // path to an empty directory
84
Colin Cross74ba9622019-02-11 15:11:14 -080085 CpuVariant map[android.ArchType]string // cpu variant for each architecture
86 InstructionSetFeatures map[android.ArchType]string // instruction set for each architecture
Colin Cross43f08db2018-11-12 10:13:39 -080087
Nicolas Geoffray1086e602021-01-20 14:30:40 +000088 BootImageProfiles android.Paths // path to a boot-image-profile.txt file
89 BootFlags string // extra flags to pass to dex2oat for the boot image
90 Dex2oatImageXmx string // max heap size for dex2oat for the boot image
91 Dex2oatImageXms string // initial heap size for dex2oat for the boot image
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +000092
Ulya Trafimovich4a13acb2021-03-02 12:25:02 +000093 // If true, downgrade the compiler filter of dexpreopt to "verify" when verify_uses_libraries
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +000094 // check fails, instead of failing the build. This will disable any AOT-compilation.
95 //
96 // The intended use case for this flag is to have a smoother migration path for the Java
97 // modules that need to add <uses-library> information in their build files. The flag allows to
98 // quickly silence build errors. This flag should be used with caution and only as a temporary
99 // measure, as it masks real errors and affects performance.
100 RelaxUsesLibraryCheck bool
Colin Cross43f08db2018-11-12 10:13:39 -0800101}
102
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000103// GlobalSoongConfig contains the global config that is generated from Soong,
104// stored in dexpreopt_soong.config.
105type GlobalSoongConfig struct {
106 // Paths to tools possibly used by the generated commands.
107 Profman android.Path
108 Dex2oat android.Path
109 Aapt android.Path
110 SoongZip android.Path
111 Zip2zip android.Path
112 ManifestCheck android.Path
Colin Cross38b96852019-05-22 10:21:09 -0700113 ConstructContext android.Path
Colin Cross43f08db2018-11-12 10:13:39 -0800114}
115
116type ModuleConfig struct {
Victor Hsiehd181c8b2019-01-29 13:00:33 -0800117 Name string
118 DexLocation string // dex location on device
Colin Cross69f59a32019-02-15 10:39:37 -0800119 BuildPath android.OutputPath
120 DexPath android.Path
Jeongik Cha33a3a812021-04-15 09:12:49 +0900121 ManifestPath android.OptionalPath
Victor Hsiehd181c8b2019-01-29 13:00:33 -0800122 UncompressedDex bool
123 HasApkLibraries bool
124 PreoptFlags []string
Colin Cross43f08db2018-11-12 10:13:39 -0800125
Colin Cross69f59a32019-02-15 10:39:37 -0800126 ProfileClassListing android.OptionalPath
Colin Cross43f08db2018-11-12 10:13:39 -0800127 ProfileIsTextListing bool
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100128 ProfileBootListing android.OptionalPath
Colin Cross43f08db2018-11-12 10:13:39 -0800129
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +0000130 EnforceUsesLibraries bool // turn on build-time verify_uses_libraries check
131 EnforceUsesLibrariesStatusFile android.Path // a file with verify_uses_libraries errors (if any)
132 ProvidesUsesLibrary string // library name (usually the same as module name)
133 ClassLoaderContexts ClassLoaderContextMap
Colin Cross43f08db2018-11-12 10:13:39 -0800134
Jeongik Cha4dda75e2021-04-27 23:56:44 +0900135 Archs []android.ArchType
136 DexPreoptImagesDeps []android.OutputPaths
137
138 DexPreoptImageLocationsOnHost []string // boot image location on host (file path without the arch subdirectory)
139 DexPreoptImageLocationsOnDevice []string // boot image location on device (file path without the arch subdirectory)
Colin Cross43f08db2018-11-12 10:13:39 -0800140
Colin Cross69f59a32019-02-15 10:39:37 -0800141 PreoptBootClassPathDexFiles android.Paths // file paths of boot class path files
142 PreoptBootClassPathDexLocations []string // virtual locations of boot class path files
Colin Cross800fe132019-02-11 14:21:24 -0800143
Colin Cross43f08db2018-11-12 10:13:39 -0800144 PreoptExtractedApk bool // Overrides OnlyPreoptModules
145
146 NoCreateAppImage bool
147 ForceCreateAppImage bool
148
149 PresignedPrebuilt bool
Colin Cross43f08db2018-11-12 10:13:39 -0800150}
151
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000152type globalSoongConfigSingleton struct{}
153
154var pctx = android.NewPackageContext("android/soong/dexpreopt")
155
156func init() {
157 pctx.Import("android/soong/android")
158 android.RegisterSingletonType("dexpreopt-soong-config", func() android.Singleton {
159 return &globalSoongConfigSingleton{}
160 })
161}
162
Colin Cross69f59a32019-02-15 10:39:37 -0800163func constructPath(ctx android.PathContext, path string) android.Path {
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200164 buildDirPrefix := ctx.Config().SoongOutDir() + "/"
Colin Cross69f59a32019-02-15 10:39:37 -0800165 if path == "" {
166 return nil
167 } else if strings.HasPrefix(path, buildDirPrefix) {
168 return android.PathForOutput(ctx, strings.TrimPrefix(path, buildDirPrefix))
169 } else {
170 return android.PathForSource(ctx, path)
171 }
Colin Cross43f08db2018-11-12 10:13:39 -0800172}
173
Colin Cross69f59a32019-02-15 10:39:37 -0800174func constructPaths(ctx android.PathContext, paths []string) android.Paths {
175 var ret android.Paths
176 for _, path := range paths {
177 ret = append(ret, constructPath(ctx, path))
178 }
179 return ret
Colin Cross43f08db2018-11-12 10:13:39 -0800180}
181
Colin Cross69f59a32019-02-15 10:39:37 -0800182func constructWritablePath(ctx android.PathContext, path string) android.WritablePath {
183 if path == "" {
184 return nil
185 }
186 return constructPath(ctx, path).(android.WritablePath)
187}
188
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000189// ParseGlobalConfig parses the given data assumed to be read from the global
190// dexpreopt.config file into a GlobalConfig struct.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000191func ParseGlobalConfig(ctx android.PathContext, data []byte) (*GlobalConfig, error) {
Colin Cross69f59a32019-02-15 10:39:37 -0800192 type GlobalJSONConfig struct {
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000193 *GlobalConfig
Colin Cross69f59a32019-02-15 10:39:37 -0800194
195 // Copies of entries in GlobalConfig that are not constructable without extra parameters. They will be
196 // used to construct the real value manually below.
Paul Duffin7ccacae2020-10-23 21:14:20 +0100197 BootImageProfiles []string
Colin Cross69f59a32019-02-15 10:39:37 -0800198 }
199
200 config := GlobalJSONConfig{}
Colin Cross988414c2020-01-11 01:11:46 +0000201 err := json.Unmarshal(data, &config)
Colin Cross69f59a32019-02-15 10:39:37 -0800202 if err != nil {
Colin Cross988414c2020-01-11 01:11:46 +0000203 return config.GlobalConfig, err
Colin Cross69f59a32019-02-15 10:39:37 -0800204 }
205
206 // Construct paths that require a PathContext.
Colin Cross69f59a32019-02-15 10:39:37 -0800207 config.GlobalConfig.BootImageProfiles = constructPaths(ctx, config.BootImageProfiles)
208
Colin Cross988414c2020-01-11 01:11:46 +0000209 return config.GlobalConfig, nil
Colin Cross69f59a32019-02-15 10:39:37 -0800210}
211
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000212type globalConfigAndRaw struct {
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000213 global *GlobalConfig
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000214 data []byte
215}
216
217// GetGlobalConfig returns the global dexpreopt.config that's created in the
218// make config phase. It is loaded once the first time it is called for any
219// ctx.Config(), and returns the same data for all future calls with the same
220// ctx.Config(). A value can be inserted for tests using
221// setDexpreoptTestGlobalConfig.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000222func GetGlobalConfig(ctx android.PathContext) *GlobalConfig {
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000223 return getGlobalConfigRaw(ctx).global
224}
225
226// GetGlobalConfigRawData is the same as GetGlobalConfig, except that it returns
227// the literal content of dexpreopt.config.
228func GetGlobalConfigRawData(ctx android.PathContext) []byte {
229 return getGlobalConfigRaw(ctx).data
230}
231
232var globalConfigOnceKey = android.NewOnceKey("DexpreoptGlobalConfig")
233var testGlobalConfigOnceKey = android.NewOnceKey("TestDexpreoptGlobalConfig")
234
235func getGlobalConfigRaw(ctx android.PathContext) globalConfigAndRaw {
236 return ctx.Config().Once(globalConfigOnceKey, func() interface{} {
237 if data, err := ctx.Config().DexpreoptGlobalConfig(ctx); err != nil {
238 panic(err)
239 } else if data != nil {
240 globalConfig, err := ParseGlobalConfig(ctx, data)
241 if err != nil {
242 panic(err)
243 }
244 return globalConfigAndRaw{globalConfig, data}
245 }
246
247 // No global config filename set, see if there is a test config set
248 return ctx.Config().Once(testGlobalConfigOnceKey, func() interface{} {
249 // Nope, return a config with preopting disabled
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000250 return globalConfigAndRaw{&GlobalConfig{
Ulya Trafimovicha4a1c4e2021-01-15 18:40:04 +0000251 DisablePreopt: true,
252 DisablePreoptBootImages: true,
253 DisableGenerateProfile: true,
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000254 }, nil}
255 })
256 }).(globalConfigAndRaw)
257}
258
259// SetTestGlobalConfig sets a GlobalConfig that future calls to GetGlobalConfig
260// will return. It must be called before the first call to GetGlobalConfig for
261// the config.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000262func SetTestGlobalConfig(config android.Config, globalConfig *GlobalConfig) {
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000263 config.Once(testGlobalConfigOnceKey, func() interface{} { return globalConfigAndRaw{globalConfig, nil} })
264}
265
Jeongik Chac6246672021-04-08 00:00:19 +0900266// This struct is required to convert ModuleConfig from/to JSON.
267// The types of fields in ModuleConfig are not convertible,
268// so moduleJSONConfig has those fields as a convertible type.
269type moduleJSONConfig struct {
270 *ModuleConfig
271
272 BuildPath string
273 DexPath string
274 ManifestPath string
275
276 ProfileClassListing string
277 ProfileBootListing string
278
279 EnforceUsesLibrariesStatusFile string
280 ClassLoaderContexts jsonClassLoaderContextMap
281
Jeongik Chac6246672021-04-08 00:00:19 +0900282 DexPreoptImagesDeps [][]string
283
284 PreoptBootClassPathDexFiles []string
285}
286
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000287// ParseModuleConfig parses a per-module dexpreopt.config file into a
288// ModuleConfig struct. It is not used in Soong, which receives a ModuleConfig
289// struct directly from java/dexpreopt.go. It is used in dexpreopt_gen called
290// from Make to read the module dexpreopt.config written in the Make config
291// stage.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000292func ParseModuleConfig(ctx android.PathContext, data []byte) (*ModuleConfig, error) {
Jeongik Chac6246672021-04-08 00:00:19 +0900293 config := moduleJSONConfig{}
Colin Cross69f59a32019-02-15 10:39:37 -0800294
Colin Cross988414c2020-01-11 01:11:46 +0000295 err := json.Unmarshal(data, &config)
Colin Cross69f59a32019-02-15 10:39:37 -0800296 if err != nil {
297 return config.ModuleConfig, err
298 }
299
300 // Construct paths that require a PathContext.
301 config.ModuleConfig.BuildPath = constructPath(ctx, config.BuildPath).(android.OutputPath)
302 config.ModuleConfig.DexPath = constructPath(ctx, config.DexPath)
Jeongik Cha33a3a812021-04-15 09:12:49 +0900303 config.ModuleConfig.ManifestPath = android.OptionalPathForPath(constructPath(ctx, config.ManifestPath))
Colin Cross69f59a32019-02-15 10:39:37 -0800304 config.ModuleConfig.ProfileClassListing = android.OptionalPathForPath(constructPath(ctx, config.ProfileClassListing))
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +0000305 config.ModuleConfig.EnforceUsesLibrariesStatusFile = constructPath(ctx, config.EnforceUsesLibrariesStatusFile)
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +0000306 config.ModuleConfig.ClassLoaderContexts = fromJsonClassLoaderContext(ctx, config.ClassLoaderContexts)
Colin Cross69f59a32019-02-15 10:39:37 -0800307 config.ModuleConfig.PreoptBootClassPathDexFiles = constructPaths(ctx, config.PreoptBootClassPathDexFiles)
Colin Cross69f59a32019-02-15 10:39:37 -0800308
Dan Willemsen0f416782019-06-13 21:44:53 +0000309 // This needs to exist, but dependencies are already handled in Make, so we don't need to pass them through JSON.
Jeongik Chab19b58a2021-04-26 22:57:27 +0900310 config.ModuleConfig.DexPreoptImagesDeps = make([]android.OutputPaths, len(config.ModuleConfig.Archs))
Dan Willemsen0f416782019-06-13 21:44:53 +0000311
Colin Cross69f59a32019-02-15 10:39:37 -0800312 return config.ModuleConfig, nil
313}
314
Jeongik Chac6246672021-04-08 00:00:19 +0900315func pathsListToStringLists(pathsList []android.OutputPaths) [][]string {
316 ret := make([][]string, 0, len(pathsList))
317 for _, paths := range pathsList {
318 ret = append(ret, paths.Strings())
319 }
320 return ret
321}
322
323func moduleConfigToJSON(config *ModuleConfig) ([]byte, error) {
324 return json.MarshalIndent(&moduleJSONConfig{
325 BuildPath: config.BuildPath.String(),
326 DexPath: config.DexPath.String(),
327 ManifestPath: config.ManifestPath.String(),
328 ProfileClassListing: config.ProfileClassListing.String(),
329 ProfileBootListing: config.ProfileBootListing.String(),
330 EnforceUsesLibrariesStatusFile: config.EnforceUsesLibrariesStatusFile.String(),
331 ClassLoaderContexts: toJsonClassLoaderContext(config.ClassLoaderContexts),
Jeongik Chac6246672021-04-08 00:00:19 +0900332 DexPreoptImagesDeps: pathsListToStringLists(config.DexPreoptImagesDeps),
333 PreoptBootClassPathDexFiles: config.PreoptBootClassPathDexFiles.Strings(),
334 ModuleConfig: config,
335 }, "", " ")
336}
337
338// WriteModuleConfig serializes a ModuleConfig into a per-module dexpreopt.config JSON file.
339// These config files are used for post-processing.
340func WriteModuleConfig(ctx android.ModuleContext, config *ModuleConfig, path android.WritablePath) {
Ulya Trafimovich76b08522021-01-14 17:52:43 +0000341 if path == nil {
342 return
343 }
344
Jeongik Chac6246672021-04-08 00:00:19 +0900345 data, err := moduleConfigToJSON(config)
Ulya Trafimovich76b08522021-01-14 17:52:43 +0000346 if err != nil {
347 ctx.ModuleErrorf("failed to JSON marshal module dexpreopt.config: %v", err)
348 return
349 }
350
351 android.WriteFileRule(ctx, path, string(data))
352}
353
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000354// dex2oatModuleName returns the name of the module to use for the dex2oat host
355// tool. It should be a binary module with public visibility that is compiled
356// and installed for host.
357func dex2oatModuleName(config android.Config) string {
358 // Default to the debug variant of dex2oat to help find bugs.
359 // Set USE_DEX2OAT_DEBUG to false for only building non-debug versions.
360 if config.Getenv("USE_DEX2OAT_DEBUG") == "false" {
361 return "dex2oat"
362 } else {
363 return "dex2oatd"
364 }
365}
366
Paul Duffinb506c9d2021-03-24 14:34:40 +0000367type dex2oatDependencyTag struct {
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000368 blueprint.BaseDependencyTag
Paul Duffinb506c9d2021-03-24 14:34:40 +0000369}
370
371func (d dex2oatDependencyTag) ExcludeFromVisibilityEnforcement() {
372}
373
374func (d dex2oatDependencyTag) ExcludeFromApexContents() {
375}
376
Martin Stjernholm0e4cceb2021-05-13 02:38:35 +0100377func (d dex2oatDependencyTag) AllowDisabledModuleDependency(target android.Module) bool {
378 // RegisterToolDeps may run after the prebuilt mutators and hence register a
379 // dependency on the source module even when the prebuilt is to be used.
380 // dex2oatPathFromDep takes that into account when it retrieves the path to
381 // the binary, but we also need to disable the check for dependencies on
382 // disabled modules.
383 return target.IsReplacedByPrebuilt()
384}
385
Paul Duffinb506c9d2021-03-24 14:34:40 +0000386// Dex2oatDepTag represents the dependency onto the dex2oatd module. It is added to any module that
387// needs dexpreopting and so it makes no sense for it to be checked for visibility or included in
388// the apex.
389var Dex2oatDepTag = dex2oatDependencyTag{}
390
391var _ android.ExcludeFromVisibilityEnforcementTag = Dex2oatDepTag
392var _ android.ExcludeFromApexContentsTag = Dex2oatDepTag
Martin Stjernholm0e4cceb2021-05-13 02:38:35 +0100393var _ android.AllowDisabledModuleDependency = Dex2oatDepTag
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000394
Martin Stjernholm6d415272020-01-31 17:10:36 +0000395// RegisterToolDeps adds the necessary dependencies to binary modules for tools
396// that are required later when Get(Cached)GlobalSoongConfig is called. It
397// should be called from a mutator that's registered with
398// android.RegistrationContext.FinalDepsMutators.
399func RegisterToolDeps(ctx android.BottomUpMutatorContext) {
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000400 dex2oatBin := dex2oatModuleName(ctx.Config())
401 v := ctx.Config().BuildOSTarget.Variations()
Ulya Trafimovicha4a1c4e2021-01-15 18:40:04 +0000402 ctx.AddFarVariationDependencies(v, Dex2oatDepTag, dex2oatBin)
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000403}
404
405func dex2oatPathFromDep(ctx android.ModuleContext) android.Path {
406 dex2oatBin := dex2oatModuleName(ctx.Config())
407
Martin Stjernholmc0048622020-08-18 17:37:41 +0100408 // Find the right dex2oat module, trying to follow PrebuiltDepTag from source
409 // to prebuilt if there is one. We wouldn't have to do this if the
410 // prebuilt_postdeps mutator that replaces source deps with prebuilt deps was
411 // run after RegisterToolDeps above, but changing that leads to ordering
412 // problems between mutators (RegisterToolDeps needs to run late to act on
413 // final variants, while prebuilt_postdeps needs to run before many of the
414 // PostDeps mutators, like the APEX mutators). Hence we need to dig out the
415 // prebuilt explicitly here instead.
416 var dex2oatModule android.Module
417 ctx.WalkDeps(func(child, parent android.Module) bool {
Ulya Trafimovicha4a1c4e2021-01-15 18:40:04 +0000418 if parent == ctx.Module() && ctx.OtherModuleDependencyTag(child) == Dex2oatDepTag {
Martin Stjernholmc0048622020-08-18 17:37:41 +0100419 // Found the source module, or prebuilt module that has replaced the source.
420 dex2oatModule = child
Paul Duffinf7c99f52021-04-28 10:41:21 +0100421 if android.IsModulePrebuilt(child) {
Martin Stjernholmc0048622020-08-18 17:37:41 +0100422 return false // If it's the prebuilt we're done.
423 } else {
424 return true // Recurse to check if the source has a prebuilt dependency.
425 }
426 }
427 if parent == dex2oatModule && ctx.OtherModuleDependencyTag(child) == android.PrebuiltDepTag {
Paul Duffinf7c99f52021-04-28 10:41:21 +0100428 if p := android.GetEmbeddedPrebuilt(child); p != nil && p.UsePrebuilt() {
Martin Stjernholmc0048622020-08-18 17:37:41 +0100429 dex2oatModule = child // Found a prebuilt that should be used.
430 }
431 }
432 return false
433 })
434
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000435 if dex2oatModule == nil {
436 // If this happens there's probably a missing call to AddToolDeps in DepsMutator.
437 panic(fmt.Sprintf("Failed to lookup %s dependency", dex2oatBin))
438 }
439
440 dex2oatPath := dex2oatModule.(android.HostToolProvider).HostToolPath()
441 if !dex2oatPath.Valid() {
442 panic(fmt.Sprintf("Failed to find host tool path in %s", dex2oatModule))
443 }
444
445 return dex2oatPath.Path()
446}
447
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000448// createGlobalSoongConfig creates a GlobalSoongConfig from the current context.
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000449// Should not be used in dexpreopt_gen.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000450func createGlobalSoongConfig(ctx android.ModuleContext) *GlobalSoongConfig {
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000451 return &GlobalSoongConfig{
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000452 Profman: ctx.Config().HostToolPath(ctx, "profman"),
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000453 Dex2oat: dex2oatPathFromDep(ctx),
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000454 Aapt: ctx.Config().HostToolPath(ctx, "aapt"),
455 SoongZip: ctx.Config().HostToolPath(ctx, "soong_zip"),
456 Zip2zip: ctx.Config().HostToolPath(ctx, "zip2zip"),
457 ManifestCheck: ctx.Config().HostToolPath(ctx, "manifest_check"),
Ulya Trafimovich5f364b62020-06-30 12:39:01 +0100458 ConstructContext: ctx.Config().HostToolPath(ctx, "construct_context"),
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000459 }
460}
461
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000462// The main reason for this Once cache for GlobalSoongConfig is to make the
463// dex2oat path available to singletons. In ordinary modules we get it through a
Ulya Trafimovicha4a1c4e2021-01-15 18:40:04 +0000464// Dex2oatDepTag dependency, but in singletons there's no simple way to do the
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000465// same thing and ensure the right variant is selected, hence this cache to make
466// the resolved path available to singletons. This means we depend on there
Ulya Trafimovicha4a1c4e2021-01-15 18:40:04 +0000467// being at least one ordinary module with a Dex2oatDepTag dependency.
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000468//
469// TODO(b/147613152): Implement a way to deal with dependencies from singletons,
Paul Duffin9f045242021-01-21 15:05:11 +0000470// and then possibly remove this cache altogether.
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000471var globalSoongConfigOnceKey = android.NewOnceKey("DexpreoptGlobalSoongConfig")
472
473// GetGlobalSoongConfig creates a GlobalSoongConfig the first time it's called,
474// and later returns the same cached instance.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000475func GetGlobalSoongConfig(ctx android.ModuleContext) *GlobalSoongConfig {
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000476 globalSoong := ctx.Config().Once(globalSoongConfigOnceKey, func() interface{} {
477 return createGlobalSoongConfig(ctx)
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000478 }).(*GlobalSoongConfig)
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000479
480 // Always resolve the tool path from the dependency, to ensure that every
481 // module has the dependency added properly.
482 myDex2oat := dex2oatPathFromDep(ctx)
483 if myDex2oat != globalSoong.Dex2oat {
484 panic(fmt.Sprintf("Inconsistent dex2oat path in cached config: expected %s, got %s", globalSoong.Dex2oat, myDex2oat))
485 }
486
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000487 return globalSoong
488}
489
490// GetCachedGlobalSoongConfig returns a cached GlobalSoongConfig created by an
491// earlier GetGlobalSoongConfig call. This function works with any context
492// compatible with a basic PathContext, since it doesn't try to create a
Martin Stjernholm6d415272020-01-31 17:10:36 +0000493// GlobalSoongConfig with the proper paths (which requires a full
494// ModuleContext). If there has been no prior call to GetGlobalSoongConfig, nil
495// is returned.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000496func GetCachedGlobalSoongConfig(ctx android.PathContext) *GlobalSoongConfig {
Martin Stjernholm6d415272020-01-31 17:10:36 +0000497 return ctx.Config().Once(globalSoongConfigOnceKey, func() interface{} {
498 return (*GlobalSoongConfig)(nil)
499 }).(*GlobalSoongConfig)
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000500}
501
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000502type globalJsonSoongConfig struct {
503 Profman string
504 Dex2oat string
505 Aapt string
506 SoongZip string
507 Zip2zip string
508 ManifestCheck string
509 ConstructContext string
510}
511
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000512// ParseGlobalSoongConfig parses the given data assumed to be read from the
513// global dexpreopt_soong.config file into a GlobalSoongConfig struct. It is
514// only used in dexpreopt_gen.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000515func ParseGlobalSoongConfig(ctx android.PathContext, data []byte) (*GlobalSoongConfig, error) {
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000516 var jc globalJsonSoongConfig
517
Colin Cross988414c2020-01-11 01:11:46 +0000518 err := json.Unmarshal(data, &jc)
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000519 if err != nil {
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000520 return &GlobalSoongConfig{}, err
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000521 }
522
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000523 config := &GlobalSoongConfig{
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000524 Profman: constructPath(ctx, jc.Profman),
525 Dex2oat: constructPath(ctx, jc.Dex2oat),
526 Aapt: constructPath(ctx, jc.Aapt),
527 SoongZip: constructPath(ctx, jc.SoongZip),
528 Zip2zip: constructPath(ctx, jc.Zip2zip),
529 ManifestCheck: constructPath(ctx, jc.ManifestCheck),
530 ConstructContext: constructPath(ctx, jc.ConstructContext),
531 }
532
533 return config, nil
534}
535
satayevd604b212021-07-21 14:23:52 +0100536// checkBootJarsConfigConsistency checks the consistency of BootJars and ApexBootJars fields in
Paul Duffin7d1d0832021-04-23 11:39:41 +0100537// DexpreoptGlobalConfig and Config.productVariables.
538func checkBootJarsConfigConsistency(ctx android.SingletonContext, dexpreoptConfig *GlobalConfig, config android.Config) {
539 compareBootJars := func(property string, dexpreoptJars, variableJars android.ConfiguredJarList) {
540 dexpreoptPairs := dexpreoptJars.CopyOfApexJarPairs()
541 variablePairs := variableJars.CopyOfApexJarPairs()
542 if !reflect.DeepEqual(dexpreoptPairs, variablePairs) {
543 ctx.Errorf("Inconsistent configuration of %[1]s\n"+
544 " dexpreopt.GlobalConfig.%[1]s = %[2]s\n"+
545 " productVariables.%[1]s = %[3]s",
546 property, dexpreoptPairs, variablePairs)
547 }
548 }
549
satayevd604b212021-07-21 14:23:52 +0100550 compareBootJars("BootJars", dexpreoptConfig.BootJars, config.NonApexBootJars())
551 compareBootJars("ApexBootJars", dexpreoptConfig.ApexBootJars, config.ApexBootJars())
Paul Duffin7d1d0832021-04-23 11:39:41 +0100552}
553
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000554func (s *globalSoongConfigSingleton) GenerateBuildActions(ctx android.SingletonContext) {
Paul Duffin7d1d0832021-04-23 11:39:41 +0100555 checkBootJarsConfigConsistency(ctx, GetGlobalConfig(ctx), ctx.Config())
556
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000557 if GetGlobalConfig(ctx).DisablePreopt {
558 return
559 }
560
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000561 config := GetCachedGlobalSoongConfig(ctx)
Martin Stjernholm6d415272020-01-31 17:10:36 +0000562 if config == nil {
563 // No module has enabled dexpreopting, so we assume there will be no calls
564 // to dexpreopt_gen.
565 return
566 }
567
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000568 jc := globalJsonSoongConfig{
569 Profman: config.Profman.String(),
570 Dex2oat: config.Dex2oat.String(),
571 Aapt: config.Aapt.String(),
572 SoongZip: config.SoongZip.String(),
573 Zip2zip: config.Zip2zip.String(),
574 ManifestCheck: config.ManifestCheck.String(),
575 ConstructContext: config.ConstructContext.String(),
576 }
577
578 data, err := json.Marshal(jc)
579 if err != nil {
580 ctx.Errorf("failed to JSON marshal GlobalSoongConfig: %v", err)
581 return
582 }
583
Colin Crosscf371cc2020-11-13 11:48:42 -0800584 android.WriteFileRule(ctx, android.PathForOutput(ctx, "dexpreopt_soong.config"), string(data))
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000585}
586
587func (s *globalSoongConfigSingleton) MakeVars(ctx android.MakeVarsContext) {
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000588 if GetGlobalConfig(ctx).DisablePreopt {
589 return
590 }
591
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000592 config := GetCachedGlobalSoongConfig(ctx)
Martin Stjernholm6d415272020-01-31 17:10:36 +0000593 if config == nil {
594 return
595 }
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000596
597 ctx.Strict("DEX2OAT", config.Dex2oat.String())
598 ctx.Strict("DEXPREOPT_GEN_DEPS", strings.Join([]string{
599 config.Profman.String(),
600 config.Dex2oat.String(),
601 config.Aapt.String(),
602 config.SoongZip.String(),
603 config.Zip2zip.String(),
604 config.ManifestCheck.String(),
605 config.ConstructContext.String(),
606 }, " "))
607}
608
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000609func GlobalConfigForTests(ctx android.PathContext) *GlobalConfig {
610 return &GlobalConfig{
Colin Cross69f59a32019-02-15 10:39:37 -0800611 DisablePreopt: false,
612 DisablePreoptModules: nil,
613 OnlyPreoptBootImageAndSystemServer: false,
614 HasSystemOther: false,
615 PatternsOnSystemOther: nil,
616 DisableGenerateProfile: false,
617 ProfileDir: "",
Ulya Trafimovich249386a2020-07-01 14:31:13 +0100618 BootJars: android.EmptyConfiguredJarList(),
satayevd604b212021-07-21 14:23:52 +0100619 ApexBootJars: android.EmptyConfiguredJarList(),
Ulya Trafimovich249386a2020-07-01 14:31:13 +0100620 ArtApexJars: android.EmptyConfiguredJarList(),
satayev9a6f87e2021-05-04 16:14:48 +0100621 SystemServerJars: android.EmptyConfiguredJarList(),
Colin Cross69f59a32019-02-15 10:39:37 -0800622 SystemServerApps: nil,
satayev492b17d2021-07-28 14:04:49 +0100623 ApexSystemServerJars: android.EmptyConfiguredJarList(),
Jiakai Zhangcee9e192021-10-29 19:46:45 +0000624 StandaloneSystemServerJars: android.EmptyConfiguredJarList(),
625 ApexStandaloneSystemServerJars: android.EmptyConfiguredJarList(),
Colin Cross69f59a32019-02-15 10:39:37 -0800626 SpeedApps: nil,
627 PreoptFlags: nil,
628 DefaultCompilerFilter: "",
629 SystemServerCompilerFilter: "",
630 GenerateDMFiles: false,
Colin Cross69f59a32019-02-15 10:39:37 -0800631 NoDebugInfo: false,
Mathieu Chartier3f7ddbb2019-04-29 09:33:50 -0700632 DontResolveStartupStrings: false,
Colin Cross69f59a32019-02-15 10:39:37 -0800633 AlwaysSystemServerDebugInfo: false,
634 NeverSystemServerDebugInfo: false,
635 AlwaysOtherDebugInfo: false,
636 NeverOtherDebugInfo: false,
Colin Cross69f59a32019-02-15 10:39:37 -0800637 IsEng: false,
638 SanitizeLite: false,
639 DefaultAppImages: false,
640 Dex2oatXmx: "",
641 Dex2oatXms: "",
642 EmptyDirectory: "empty_dir",
643 CpuVariant: nil,
644 InstructionSetFeatures: nil,
Colin Cross69f59a32019-02-15 10:39:37 -0800645 BootImageProfiles: nil,
Colin Cross69f59a32019-02-15 10:39:37 -0800646 BootFlags: "",
647 Dex2oatImageXmx: "",
648 Dex2oatImageXms: "",
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000649 }
650}
651
Paul Duffin9f045242021-01-21 15:05:11 +0000652func globalSoongConfigForTests() *GlobalSoongConfig {
653 return &GlobalSoongConfig{
654 Profman: android.PathForTesting("profman"),
655 Dex2oat: android.PathForTesting("dex2oat"),
656 Aapt: android.PathForTesting("aapt"),
657 SoongZip: android.PathForTesting("soong_zip"),
658 Zip2zip: android.PathForTesting("zip2zip"),
659 ManifestCheck: android.PathForTesting("manifest_check"),
660 ConstructContext: android.PathForTesting("construct_context"),
661 }
Colin Cross69f59a32019-02-15 10:39:37 -0800662}