blob: 0bcec17b54dc17e0f6096c1a9265ae24c146696b [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
Ulya Trafimovich249386a2020-07-01 14:31:13 +010047 BootJars android.ConfiguredJarList // modules for jars that form the boot class path
48 UpdatableBootJars 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
satayev9a6f87e2021-05-04 16:14:48 +010052 SystemServerJars android.ConfiguredJarList // jars that form the system server
Ulya Trafimovich249386a2020-07-01 14:31:13 +010053 SystemServerApps []string // apps that are loaded into system server
54 UpdatableSystemServerJars android.ConfiguredJarList // jars within apex that are loaded into system server
55 SpeedApps []string // apps that should be speed optimized
Colin Cross43f08db2018-11-12 10:13:39 -080056
Ulya Trafimovichcd3203f2020-03-27 11:30:00 +000057 BrokenSuboptimalOrderOfSystemServerJars bool // if true, sub-optimal order does not cause a build error
58
Colin Cross43f08db2018-11-12 10:13:39 -080059 PreoptFlags []string // global dex2oat flags that should be used if no module-specific dex2oat flags are specified
60
61 DefaultCompilerFilter string // default compiler filter to pass to dex2oat, overridden by --compiler-filter= in module-specific dex2oat flags
62 SystemServerCompilerFilter string // default compiler filter to pass to dex2oat for system server jars
63
Nicolas Geoffrayc1bf7242019-10-18 14:51:38 +010064 GenerateDMFiles bool // generate Dex Metadata files
Colin Cross43f08db2018-11-12 10:13:39 -080065
66 NoDebugInfo bool // don't generate debug info by default
Mathieu Chartier3f7ddbb2019-04-29 09:33:50 -070067 DontResolveStartupStrings bool // don't resolve string literals loaded during application startup.
Colin Cross43f08db2018-11-12 10:13:39 -080068 AlwaysSystemServerDebugInfo bool // always generate mini debug info for system server modules (overrides NoDebugInfo=true)
69 NeverSystemServerDebugInfo bool // never generate mini debug info for system server modules (overrides NoDebugInfo=false)
70 AlwaysOtherDebugInfo bool // always generate mini debug info for non-system server modules (overrides NoDebugInfo=true)
71 NeverOtherDebugInfo bool // never generate mini debug info for non-system server modules (overrides NoDebugInfo=true)
72
Colin Cross43f08db2018-11-12 10:13:39 -080073 IsEng bool // build is a eng variant
74 SanitizeLite bool // build is the second phase of a SANITIZE_LITE build
75
76 DefaultAppImages bool // build app images (TODO: .art files?) by default
77
Colin Cross800fe132019-02-11 14:21:24 -080078 Dex2oatXmx string // max heap size for dex2oat
79 Dex2oatXms string // initial heap size for dex2oat
Colin Cross43f08db2018-11-12 10:13:39 -080080
81 EmptyDirectory string // path to an empty directory
82
Colin Cross74ba9622019-02-11 15:11:14 -080083 CpuVariant map[android.ArchType]string // cpu variant for each architecture
84 InstructionSetFeatures map[android.ArchType]string // instruction set for each architecture
Colin Cross43f08db2018-11-12 10:13:39 -080085
Nicolas Geoffray1086e602021-01-20 14:30:40 +000086 BootImageProfiles android.Paths // path to a boot-image-profile.txt file
87 BootFlags string // extra flags to pass to dex2oat for the boot image
88 Dex2oatImageXmx string // max heap size for dex2oat for the boot image
89 Dex2oatImageXms string // initial heap size for dex2oat for the boot image
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +000090
Ulya Trafimovich4a13acb2021-03-02 12:25:02 +000091 // If true, downgrade the compiler filter of dexpreopt to "verify" when verify_uses_libraries
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +000092 // check fails, instead of failing the build. This will disable any AOT-compilation.
93 //
94 // The intended use case for this flag is to have a smoother migration path for the Java
95 // modules that need to add <uses-library> information in their build files. The flag allows to
96 // quickly silence build errors. This flag should be used with caution and only as a temporary
97 // measure, as it masks real errors and affects performance.
98 RelaxUsesLibraryCheck bool
Colin Cross43f08db2018-11-12 10:13:39 -080099}
100
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000101// GlobalSoongConfig contains the global config that is generated from Soong,
102// stored in dexpreopt_soong.config.
103type GlobalSoongConfig struct {
104 // Paths to tools possibly used by the generated commands.
105 Profman android.Path
106 Dex2oat android.Path
107 Aapt android.Path
108 SoongZip android.Path
109 Zip2zip android.Path
110 ManifestCheck android.Path
Colin Cross38b96852019-05-22 10:21:09 -0700111 ConstructContext android.Path
Colin Cross43f08db2018-11-12 10:13:39 -0800112}
113
114type ModuleConfig struct {
Victor Hsiehd181c8b2019-01-29 13:00:33 -0800115 Name string
116 DexLocation string // dex location on device
Colin Cross69f59a32019-02-15 10:39:37 -0800117 BuildPath android.OutputPath
118 DexPath android.Path
Jeongik Cha33a3a812021-04-15 09:12:49 +0900119 ManifestPath android.OptionalPath
Victor Hsiehd181c8b2019-01-29 13:00:33 -0800120 UncompressedDex bool
121 HasApkLibraries bool
122 PreoptFlags []string
Colin Cross43f08db2018-11-12 10:13:39 -0800123
Colin Cross69f59a32019-02-15 10:39:37 -0800124 ProfileClassListing android.OptionalPath
Colin Cross43f08db2018-11-12 10:13:39 -0800125 ProfileIsTextListing bool
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100126 ProfileBootListing android.OptionalPath
Colin Cross43f08db2018-11-12 10:13:39 -0800127
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +0000128 EnforceUsesLibraries bool // turn on build-time verify_uses_libraries check
129 EnforceUsesLibrariesStatusFile android.Path // a file with verify_uses_libraries errors (if any)
130 ProvidesUsesLibrary string // library name (usually the same as module name)
131 ClassLoaderContexts ClassLoaderContextMap
Colin Cross43f08db2018-11-12 10:13:39 -0800132
Jeongik Cha4dda75e2021-04-27 23:56:44 +0900133 Archs []android.ArchType
134 DexPreoptImagesDeps []android.OutputPaths
135
136 DexPreoptImageLocationsOnHost []string // boot image location on host (file path without the arch subdirectory)
137 DexPreoptImageLocationsOnDevice []string // boot image location on device (file path without the arch subdirectory)
Colin Cross43f08db2018-11-12 10:13:39 -0800138
Colin Cross69f59a32019-02-15 10:39:37 -0800139 PreoptBootClassPathDexFiles android.Paths // file paths of boot class path files
140 PreoptBootClassPathDexLocations []string // virtual locations of boot class path files
Colin Cross800fe132019-02-11 14:21:24 -0800141
Colin Cross43f08db2018-11-12 10:13:39 -0800142 PreoptExtractedApk bool // Overrides OnlyPreoptModules
143
144 NoCreateAppImage bool
145 ForceCreateAppImage bool
146
147 PresignedPrebuilt bool
Colin Cross43f08db2018-11-12 10:13:39 -0800148}
149
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000150type globalSoongConfigSingleton struct{}
151
152var pctx = android.NewPackageContext("android/soong/dexpreopt")
153
154func init() {
155 pctx.Import("android/soong/android")
156 android.RegisterSingletonType("dexpreopt-soong-config", func() android.Singleton {
157 return &globalSoongConfigSingleton{}
158 })
159}
160
Colin Cross69f59a32019-02-15 10:39:37 -0800161func constructPath(ctx android.PathContext, path string) android.Path {
162 buildDirPrefix := ctx.Config().BuildDir() + "/"
163 if path == "" {
164 return nil
165 } else if strings.HasPrefix(path, buildDirPrefix) {
166 return android.PathForOutput(ctx, strings.TrimPrefix(path, buildDirPrefix))
167 } else {
168 return android.PathForSource(ctx, path)
169 }
Colin Cross43f08db2018-11-12 10:13:39 -0800170}
171
Colin Cross69f59a32019-02-15 10:39:37 -0800172func constructPaths(ctx android.PathContext, paths []string) android.Paths {
173 var ret android.Paths
174 for _, path := range paths {
175 ret = append(ret, constructPath(ctx, path))
176 }
177 return ret
Colin Cross43f08db2018-11-12 10:13:39 -0800178}
179
Colin Cross69f59a32019-02-15 10:39:37 -0800180func constructWritablePath(ctx android.PathContext, path string) android.WritablePath {
181 if path == "" {
182 return nil
183 }
184 return constructPath(ctx, path).(android.WritablePath)
185}
186
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000187// ParseGlobalConfig parses the given data assumed to be read from the global
188// dexpreopt.config file into a GlobalConfig struct.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000189func ParseGlobalConfig(ctx android.PathContext, data []byte) (*GlobalConfig, error) {
Colin Cross69f59a32019-02-15 10:39:37 -0800190 type GlobalJSONConfig struct {
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000191 *GlobalConfig
Colin Cross69f59a32019-02-15 10:39:37 -0800192
193 // Copies of entries in GlobalConfig that are not constructable without extra parameters. They will be
194 // used to construct the real value manually below.
Paul Duffin7ccacae2020-10-23 21:14:20 +0100195 BootImageProfiles []string
Colin Cross69f59a32019-02-15 10:39:37 -0800196 }
197
198 config := GlobalJSONConfig{}
Colin Cross988414c2020-01-11 01:11:46 +0000199 err := json.Unmarshal(data, &config)
Colin Cross69f59a32019-02-15 10:39:37 -0800200 if err != nil {
Colin Cross988414c2020-01-11 01:11:46 +0000201 return config.GlobalConfig, err
Colin Cross69f59a32019-02-15 10:39:37 -0800202 }
203
204 // Construct paths that require a PathContext.
Colin Cross69f59a32019-02-15 10:39:37 -0800205 config.GlobalConfig.BootImageProfiles = constructPaths(ctx, config.BootImageProfiles)
206
Colin Cross988414c2020-01-11 01:11:46 +0000207 return config.GlobalConfig, nil
Colin Cross69f59a32019-02-15 10:39:37 -0800208}
209
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000210type globalConfigAndRaw struct {
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000211 global *GlobalConfig
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000212 data []byte
213}
214
215// GetGlobalConfig returns the global dexpreopt.config that's created in the
216// make config phase. It is loaded once the first time it is called for any
217// ctx.Config(), and returns the same data for all future calls with the same
218// ctx.Config(). A value can be inserted for tests using
219// setDexpreoptTestGlobalConfig.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000220func GetGlobalConfig(ctx android.PathContext) *GlobalConfig {
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000221 return getGlobalConfigRaw(ctx).global
222}
223
224// GetGlobalConfigRawData is the same as GetGlobalConfig, except that it returns
225// the literal content of dexpreopt.config.
226func GetGlobalConfigRawData(ctx android.PathContext) []byte {
227 return getGlobalConfigRaw(ctx).data
228}
229
230var globalConfigOnceKey = android.NewOnceKey("DexpreoptGlobalConfig")
231var testGlobalConfigOnceKey = android.NewOnceKey("TestDexpreoptGlobalConfig")
232
233func getGlobalConfigRaw(ctx android.PathContext) globalConfigAndRaw {
234 return ctx.Config().Once(globalConfigOnceKey, func() interface{} {
235 if data, err := ctx.Config().DexpreoptGlobalConfig(ctx); err != nil {
236 panic(err)
237 } else if data != nil {
238 globalConfig, err := ParseGlobalConfig(ctx, data)
239 if err != nil {
240 panic(err)
241 }
242 return globalConfigAndRaw{globalConfig, data}
243 }
244
245 // No global config filename set, see if there is a test config set
246 return ctx.Config().Once(testGlobalConfigOnceKey, func() interface{} {
247 // Nope, return a config with preopting disabled
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000248 return globalConfigAndRaw{&GlobalConfig{
Ulya Trafimovicha4a1c4e2021-01-15 18:40:04 +0000249 DisablePreopt: true,
250 DisablePreoptBootImages: true,
251 DisableGenerateProfile: true,
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000252 }, nil}
253 })
254 }).(globalConfigAndRaw)
255}
256
257// SetTestGlobalConfig sets a GlobalConfig that future calls to GetGlobalConfig
258// will return. It must be called before the first call to GetGlobalConfig for
259// the config.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000260func SetTestGlobalConfig(config android.Config, globalConfig *GlobalConfig) {
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000261 config.Once(testGlobalConfigOnceKey, func() interface{} { return globalConfigAndRaw{globalConfig, nil} })
262}
263
Jeongik Chac6246672021-04-08 00:00:19 +0900264// This struct is required to convert ModuleConfig from/to JSON.
265// The types of fields in ModuleConfig are not convertible,
266// so moduleJSONConfig has those fields as a convertible type.
267type moduleJSONConfig struct {
268 *ModuleConfig
269
270 BuildPath string
271 DexPath string
272 ManifestPath string
273
274 ProfileClassListing string
275 ProfileBootListing string
276
277 EnforceUsesLibrariesStatusFile string
278 ClassLoaderContexts jsonClassLoaderContextMap
279
Jeongik Chac6246672021-04-08 00:00:19 +0900280 DexPreoptImagesDeps [][]string
281
282 PreoptBootClassPathDexFiles []string
283}
284
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000285// ParseModuleConfig parses a per-module dexpreopt.config file into a
286// ModuleConfig struct. It is not used in Soong, which receives a ModuleConfig
287// struct directly from java/dexpreopt.go. It is used in dexpreopt_gen called
288// from Make to read the module dexpreopt.config written in the Make config
289// stage.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000290func ParseModuleConfig(ctx android.PathContext, data []byte) (*ModuleConfig, error) {
Jeongik Chac6246672021-04-08 00:00:19 +0900291 config := moduleJSONConfig{}
Colin Cross69f59a32019-02-15 10:39:37 -0800292
Colin Cross988414c2020-01-11 01:11:46 +0000293 err := json.Unmarshal(data, &config)
Colin Cross69f59a32019-02-15 10:39:37 -0800294 if err != nil {
295 return config.ModuleConfig, err
296 }
297
298 // Construct paths that require a PathContext.
299 config.ModuleConfig.BuildPath = constructPath(ctx, config.BuildPath).(android.OutputPath)
300 config.ModuleConfig.DexPath = constructPath(ctx, config.DexPath)
Jeongik Cha33a3a812021-04-15 09:12:49 +0900301 config.ModuleConfig.ManifestPath = android.OptionalPathForPath(constructPath(ctx, config.ManifestPath))
Colin Cross69f59a32019-02-15 10:39:37 -0800302 config.ModuleConfig.ProfileClassListing = android.OptionalPathForPath(constructPath(ctx, config.ProfileClassListing))
Ulya Trafimovich8c35fcf2021-02-17 16:23:28 +0000303 config.ModuleConfig.EnforceUsesLibrariesStatusFile = constructPath(ctx, config.EnforceUsesLibrariesStatusFile)
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +0000304 config.ModuleConfig.ClassLoaderContexts = fromJsonClassLoaderContext(ctx, config.ClassLoaderContexts)
Colin Cross69f59a32019-02-15 10:39:37 -0800305 config.ModuleConfig.PreoptBootClassPathDexFiles = constructPaths(ctx, config.PreoptBootClassPathDexFiles)
Colin Cross69f59a32019-02-15 10:39:37 -0800306
Dan Willemsen0f416782019-06-13 21:44:53 +0000307 // 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 +0900308 config.ModuleConfig.DexPreoptImagesDeps = make([]android.OutputPaths, len(config.ModuleConfig.Archs))
Dan Willemsen0f416782019-06-13 21:44:53 +0000309
Colin Cross69f59a32019-02-15 10:39:37 -0800310 return config.ModuleConfig, nil
311}
312
Jeongik Chac6246672021-04-08 00:00:19 +0900313func pathsListToStringLists(pathsList []android.OutputPaths) [][]string {
314 ret := make([][]string, 0, len(pathsList))
315 for _, paths := range pathsList {
316 ret = append(ret, paths.Strings())
317 }
318 return ret
319}
320
321func moduleConfigToJSON(config *ModuleConfig) ([]byte, error) {
322 return json.MarshalIndent(&moduleJSONConfig{
323 BuildPath: config.BuildPath.String(),
324 DexPath: config.DexPath.String(),
325 ManifestPath: config.ManifestPath.String(),
326 ProfileClassListing: config.ProfileClassListing.String(),
327 ProfileBootListing: config.ProfileBootListing.String(),
328 EnforceUsesLibrariesStatusFile: config.EnforceUsesLibrariesStatusFile.String(),
329 ClassLoaderContexts: toJsonClassLoaderContext(config.ClassLoaderContexts),
Jeongik Chac6246672021-04-08 00:00:19 +0900330 DexPreoptImagesDeps: pathsListToStringLists(config.DexPreoptImagesDeps),
331 PreoptBootClassPathDexFiles: config.PreoptBootClassPathDexFiles.Strings(),
332 ModuleConfig: config,
333 }, "", " ")
334}
335
336// WriteModuleConfig serializes a ModuleConfig into a per-module dexpreopt.config JSON file.
337// These config files are used for post-processing.
338func WriteModuleConfig(ctx android.ModuleContext, config *ModuleConfig, path android.WritablePath) {
Ulya Trafimovich76b08522021-01-14 17:52:43 +0000339 if path == nil {
340 return
341 }
342
Jeongik Chac6246672021-04-08 00:00:19 +0900343 data, err := moduleConfigToJSON(config)
Ulya Trafimovich76b08522021-01-14 17:52:43 +0000344 if err != nil {
345 ctx.ModuleErrorf("failed to JSON marshal module dexpreopt.config: %v", err)
346 return
347 }
348
349 android.WriteFileRule(ctx, path, string(data))
350}
351
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000352// dex2oatModuleName returns the name of the module to use for the dex2oat host
353// tool. It should be a binary module with public visibility that is compiled
354// and installed for host.
355func dex2oatModuleName(config android.Config) string {
356 // Default to the debug variant of dex2oat to help find bugs.
357 // Set USE_DEX2OAT_DEBUG to false for only building non-debug versions.
358 if config.Getenv("USE_DEX2OAT_DEBUG") == "false" {
359 return "dex2oat"
360 } else {
361 return "dex2oatd"
362 }
363}
364
Paul Duffinb506c9d2021-03-24 14:34:40 +0000365type dex2oatDependencyTag struct {
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000366 blueprint.BaseDependencyTag
Paul Duffinb506c9d2021-03-24 14:34:40 +0000367}
368
369func (d dex2oatDependencyTag) ExcludeFromVisibilityEnforcement() {
370}
371
372func (d dex2oatDependencyTag) ExcludeFromApexContents() {
373}
374
Martin Stjernholm0e4cceb2021-05-13 02:38:35 +0100375func (d dex2oatDependencyTag) AllowDisabledModuleDependency(target android.Module) bool {
376 // RegisterToolDeps may run after the prebuilt mutators and hence register a
377 // dependency on the source module even when the prebuilt is to be used.
378 // dex2oatPathFromDep takes that into account when it retrieves the path to
379 // the binary, but we also need to disable the check for dependencies on
380 // disabled modules.
381 return target.IsReplacedByPrebuilt()
382}
383
Paul Duffinb506c9d2021-03-24 14:34:40 +0000384// Dex2oatDepTag represents the dependency onto the dex2oatd module. It is added to any module that
385// needs dexpreopting and so it makes no sense for it to be checked for visibility or included in
386// the apex.
387var Dex2oatDepTag = dex2oatDependencyTag{}
388
389var _ android.ExcludeFromVisibilityEnforcementTag = Dex2oatDepTag
390var _ android.ExcludeFromApexContentsTag = Dex2oatDepTag
Martin Stjernholm0e4cceb2021-05-13 02:38:35 +0100391var _ android.AllowDisabledModuleDependency = Dex2oatDepTag
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000392
Martin Stjernholm6d415272020-01-31 17:10:36 +0000393// RegisterToolDeps adds the necessary dependencies to binary modules for tools
394// that are required later when Get(Cached)GlobalSoongConfig is called. It
395// should be called from a mutator that's registered with
396// android.RegistrationContext.FinalDepsMutators.
397func RegisterToolDeps(ctx android.BottomUpMutatorContext) {
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000398 dex2oatBin := dex2oatModuleName(ctx.Config())
399 v := ctx.Config().BuildOSTarget.Variations()
Ulya Trafimovicha4a1c4e2021-01-15 18:40:04 +0000400 ctx.AddFarVariationDependencies(v, Dex2oatDepTag, dex2oatBin)
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000401}
402
403func dex2oatPathFromDep(ctx android.ModuleContext) android.Path {
404 dex2oatBin := dex2oatModuleName(ctx.Config())
405
Martin Stjernholmc0048622020-08-18 17:37:41 +0100406 // Find the right dex2oat module, trying to follow PrebuiltDepTag from source
407 // to prebuilt if there is one. We wouldn't have to do this if the
408 // prebuilt_postdeps mutator that replaces source deps with prebuilt deps was
409 // run after RegisterToolDeps above, but changing that leads to ordering
410 // problems between mutators (RegisterToolDeps needs to run late to act on
411 // final variants, while prebuilt_postdeps needs to run before many of the
412 // PostDeps mutators, like the APEX mutators). Hence we need to dig out the
413 // prebuilt explicitly here instead.
414 var dex2oatModule android.Module
415 ctx.WalkDeps(func(child, parent android.Module) bool {
Ulya Trafimovicha4a1c4e2021-01-15 18:40:04 +0000416 if parent == ctx.Module() && ctx.OtherModuleDependencyTag(child) == Dex2oatDepTag {
Martin Stjernholmc0048622020-08-18 17:37:41 +0100417 // Found the source module, or prebuilt module that has replaced the source.
418 dex2oatModule = child
Paul Duffinf7c99f52021-04-28 10:41:21 +0100419 if android.IsModulePrebuilt(child) {
Martin Stjernholmc0048622020-08-18 17:37:41 +0100420 return false // If it's the prebuilt we're done.
421 } else {
422 return true // Recurse to check if the source has a prebuilt dependency.
423 }
424 }
425 if parent == dex2oatModule && ctx.OtherModuleDependencyTag(child) == android.PrebuiltDepTag {
Paul Duffinf7c99f52021-04-28 10:41:21 +0100426 if p := android.GetEmbeddedPrebuilt(child); p != nil && p.UsePrebuilt() {
Martin Stjernholmc0048622020-08-18 17:37:41 +0100427 dex2oatModule = child // Found a prebuilt that should be used.
428 }
429 }
430 return false
431 })
432
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000433 if dex2oatModule == nil {
434 // If this happens there's probably a missing call to AddToolDeps in DepsMutator.
435 panic(fmt.Sprintf("Failed to lookup %s dependency", dex2oatBin))
436 }
437
438 dex2oatPath := dex2oatModule.(android.HostToolProvider).HostToolPath()
439 if !dex2oatPath.Valid() {
440 panic(fmt.Sprintf("Failed to find host tool path in %s", dex2oatModule))
441 }
442
443 return dex2oatPath.Path()
444}
445
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000446// createGlobalSoongConfig creates a GlobalSoongConfig from the current context.
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000447// Should not be used in dexpreopt_gen.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000448func createGlobalSoongConfig(ctx android.ModuleContext) *GlobalSoongConfig {
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000449 return &GlobalSoongConfig{
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000450 Profman: ctx.Config().HostToolPath(ctx, "profman"),
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000451 Dex2oat: dex2oatPathFromDep(ctx),
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000452 Aapt: ctx.Config().HostToolPath(ctx, "aapt"),
453 SoongZip: ctx.Config().HostToolPath(ctx, "soong_zip"),
454 Zip2zip: ctx.Config().HostToolPath(ctx, "zip2zip"),
455 ManifestCheck: ctx.Config().HostToolPath(ctx, "manifest_check"),
Ulya Trafimovich5f364b62020-06-30 12:39:01 +0100456 ConstructContext: ctx.Config().HostToolPath(ctx, "construct_context"),
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000457 }
458}
459
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000460// The main reason for this Once cache for GlobalSoongConfig is to make the
461// dex2oat path available to singletons. In ordinary modules we get it through a
Ulya Trafimovicha4a1c4e2021-01-15 18:40:04 +0000462// Dex2oatDepTag dependency, but in singletons there's no simple way to do the
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000463// same thing and ensure the right variant is selected, hence this cache to make
464// the resolved path available to singletons. This means we depend on there
Ulya Trafimovicha4a1c4e2021-01-15 18:40:04 +0000465// being at least one ordinary module with a Dex2oatDepTag dependency.
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000466//
467// TODO(b/147613152): Implement a way to deal with dependencies from singletons,
Paul Duffin9f045242021-01-21 15:05:11 +0000468// and then possibly remove this cache altogether.
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000469var globalSoongConfigOnceKey = android.NewOnceKey("DexpreoptGlobalSoongConfig")
470
471// GetGlobalSoongConfig creates a GlobalSoongConfig the first time it's called,
472// and later returns the same cached instance.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000473func GetGlobalSoongConfig(ctx android.ModuleContext) *GlobalSoongConfig {
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000474 globalSoong := ctx.Config().Once(globalSoongConfigOnceKey, func() interface{} {
475 return createGlobalSoongConfig(ctx)
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000476 }).(*GlobalSoongConfig)
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000477
478 // Always resolve the tool path from the dependency, to ensure that every
479 // module has the dependency added properly.
480 myDex2oat := dex2oatPathFromDep(ctx)
481 if myDex2oat != globalSoong.Dex2oat {
482 panic(fmt.Sprintf("Inconsistent dex2oat path in cached config: expected %s, got %s", globalSoong.Dex2oat, myDex2oat))
483 }
484
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000485 return globalSoong
486}
487
488// GetCachedGlobalSoongConfig returns a cached GlobalSoongConfig created by an
489// earlier GetGlobalSoongConfig call. This function works with any context
490// compatible with a basic PathContext, since it doesn't try to create a
Martin Stjernholm6d415272020-01-31 17:10:36 +0000491// GlobalSoongConfig with the proper paths (which requires a full
492// ModuleContext). If there has been no prior call to GetGlobalSoongConfig, nil
493// is returned.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000494func GetCachedGlobalSoongConfig(ctx android.PathContext) *GlobalSoongConfig {
Martin Stjernholm6d415272020-01-31 17:10:36 +0000495 return ctx.Config().Once(globalSoongConfigOnceKey, func() interface{} {
496 return (*GlobalSoongConfig)(nil)
497 }).(*GlobalSoongConfig)
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000498}
499
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000500type globalJsonSoongConfig struct {
501 Profman string
502 Dex2oat string
503 Aapt string
504 SoongZip string
505 Zip2zip string
506 ManifestCheck string
507 ConstructContext string
508}
509
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000510// ParseGlobalSoongConfig parses the given data assumed to be read from the
511// global dexpreopt_soong.config file into a GlobalSoongConfig struct. It is
512// only used in dexpreopt_gen.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000513func ParseGlobalSoongConfig(ctx android.PathContext, data []byte) (*GlobalSoongConfig, error) {
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000514 var jc globalJsonSoongConfig
515
Colin Cross988414c2020-01-11 01:11:46 +0000516 err := json.Unmarshal(data, &jc)
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000517 if err != nil {
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000518 return &GlobalSoongConfig{}, err
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000519 }
520
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000521 config := &GlobalSoongConfig{
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000522 Profman: constructPath(ctx, jc.Profman),
523 Dex2oat: constructPath(ctx, jc.Dex2oat),
524 Aapt: constructPath(ctx, jc.Aapt),
525 SoongZip: constructPath(ctx, jc.SoongZip),
526 Zip2zip: constructPath(ctx, jc.Zip2zip),
527 ManifestCheck: constructPath(ctx, jc.ManifestCheck),
528 ConstructContext: constructPath(ctx, jc.ConstructContext),
529 }
530
531 return config, nil
532}
533
Paul Duffin7d1d0832021-04-23 11:39:41 +0100534// checkBootJarsConfigConsistency checks the consistency of BootJars and UpdatableBootJars fields in
535// DexpreoptGlobalConfig and Config.productVariables.
536func checkBootJarsConfigConsistency(ctx android.SingletonContext, dexpreoptConfig *GlobalConfig, config android.Config) {
537 compareBootJars := func(property string, dexpreoptJars, variableJars android.ConfiguredJarList) {
538 dexpreoptPairs := dexpreoptJars.CopyOfApexJarPairs()
539 variablePairs := variableJars.CopyOfApexJarPairs()
540 if !reflect.DeepEqual(dexpreoptPairs, variablePairs) {
541 ctx.Errorf("Inconsistent configuration of %[1]s\n"+
542 " dexpreopt.GlobalConfig.%[1]s = %[2]s\n"+
543 " productVariables.%[1]s = %[3]s",
544 property, dexpreoptPairs, variablePairs)
545 }
546 }
547
548 compareBootJars("BootJars", dexpreoptConfig.BootJars, config.NonUpdatableBootJars())
549 compareBootJars("UpdatableBootJars", dexpreoptConfig.UpdatableBootJars, config.UpdatableBootJars())
550}
551
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000552func (s *globalSoongConfigSingleton) GenerateBuildActions(ctx android.SingletonContext) {
Paul Duffin7d1d0832021-04-23 11:39:41 +0100553 checkBootJarsConfigConsistency(ctx, GetGlobalConfig(ctx), ctx.Config())
554
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000555 if GetGlobalConfig(ctx).DisablePreopt {
556 return
557 }
558
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000559 config := GetCachedGlobalSoongConfig(ctx)
Martin Stjernholm6d415272020-01-31 17:10:36 +0000560 if config == nil {
561 // No module has enabled dexpreopting, so we assume there will be no calls
562 // to dexpreopt_gen.
563 return
564 }
565
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000566 jc := globalJsonSoongConfig{
567 Profman: config.Profman.String(),
568 Dex2oat: config.Dex2oat.String(),
569 Aapt: config.Aapt.String(),
570 SoongZip: config.SoongZip.String(),
571 Zip2zip: config.Zip2zip.String(),
572 ManifestCheck: config.ManifestCheck.String(),
573 ConstructContext: config.ConstructContext.String(),
574 }
575
576 data, err := json.Marshal(jc)
577 if err != nil {
578 ctx.Errorf("failed to JSON marshal GlobalSoongConfig: %v", err)
579 return
580 }
581
Colin Crosscf371cc2020-11-13 11:48:42 -0800582 android.WriteFileRule(ctx, android.PathForOutput(ctx, "dexpreopt_soong.config"), string(data))
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000583}
584
585func (s *globalSoongConfigSingleton) MakeVars(ctx android.MakeVarsContext) {
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000586 if GetGlobalConfig(ctx).DisablePreopt {
587 return
588 }
589
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000590 config := GetCachedGlobalSoongConfig(ctx)
Martin Stjernholm6d415272020-01-31 17:10:36 +0000591 if config == nil {
592 return
593 }
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000594
595 ctx.Strict("DEX2OAT", config.Dex2oat.String())
596 ctx.Strict("DEXPREOPT_GEN_DEPS", strings.Join([]string{
597 config.Profman.String(),
598 config.Dex2oat.String(),
599 config.Aapt.String(),
600 config.SoongZip.String(),
601 config.Zip2zip.String(),
602 config.ManifestCheck.String(),
603 config.ConstructContext.String(),
604 }, " "))
605}
606
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000607func GlobalConfigForTests(ctx android.PathContext) *GlobalConfig {
608 return &GlobalConfig{
Colin Cross69f59a32019-02-15 10:39:37 -0800609 DisablePreopt: false,
610 DisablePreoptModules: nil,
611 OnlyPreoptBootImageAndSystemServer: false,
612 HasSystemOther: false,
613 PatternsOnSystemOther: nil,
614 DisableGenerateProfile: false,
615 ProfileDir: "",
Ulya Trafimovich249386a2020-07-01 14:31:13 +0100616 BootJars: android.EmptyConfiguredJarList(),
617 UpdatableBootJars: android.EmptyConfiguredJarList(),
618 ArtApexJars: android.EmptyConfiguredJarList(),
satayev9a6f87e2021-05-04 16:14:48 +0100619 SystemServerJars: android.EmptyConfiguredJarList(),
Colin Cross69f59a32019-02-15 10:39:37 -0800620 SystemServerApps: nil,
Ulya Trafimovich249386a2020-07-01 14:31:13 +0100621 UpdatableSystemServerJars: android.EmptyConfiguredJarList(),
Colin Cross69f59a32019-02-15 10:39:37 -0800622 SpeedApps: nil,
623 PreoptFlags: nil,
624 DefaultCompilerFilter: "",
625 SystemServerCompilerFilter: "",
626 GenerateDMFiles: false,
Colin Cross69f59a32019-02-15 10:39:37 -0800627 NoDebugInfo: false,
Mathieu Chartier3f7ddbb2019-04-29 09:33:50 -0700628 DontResolveStartupStrings: false,
Colin Cross69f59a32019-02-15 10:39:37 -0800629 AlwaysSystemServerDebugInfo: false,
630 NeverSystemServerDebugInfo: false,
631 AlwaysOtherDebugInfo: false,
632 NeverOtherDebugInfo: false,
Colin Cross69f59a32019-02-15 10:39:37 -0800633 IsEng: false,
634 SanitizeLite: false,
635 DefaultAppImages: false,
636 Dex2oatXmx: "",
637 Dex2oatXms: "",
638 EmptyDirectory: "empty_dir",
639 CpuVariant: nil,
640 InstructionSetFeatures: nil,
Colin Cross69f59a32019-02-15 10:39:37 -0800641 BootImageProfiles: nil,
Colin Cross69f59a32019-02-15 10:39:37 -0800642 BootFlags: "",
643 Dex2oatImageXmx: "",
644 Dex2oatImageXms: "",
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000645 }
646}
647
Paul Duffin9f045242021-01-21 15:05:11 +0000648func globalSoongConfigForTests() *GlobalSoongConfig {
649 return &GlobalSoongConfig{
650 Profman: android.PathForTesting("profman"),
651 Dex2oat: android.PathForTesting("dex2oat"),
652 Aapt: android.PathForTesting("aapt"),
653 SoongZip: android.PathForTesting("soong_zip"),
654 Zip2zip: android.PathForTesting("zip2zip"),
655 ManifestCheck: android.PathForTesting("manifest_check"),
656 ConstructContext: android.PathForTesting("construct_context"),
657 }
Colin Cross69f59a32019-02-15 10:39:37 -0800658}