blob: 7d8fbbc9025c093c3009705a2df00338aa0e77cd [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"
Colin Cross69f59a32019-02-15 10:39:37 -080020 "strings"
Colin Cross74ba9622019-02-11 15:11:14 -080021
Martin Stjernholmd90676f2020-01-11 00:37:30 +000022 "github.com/google/blueprint"
23
Colin Cross74ba9622019-02-11 15:11:14 -080024 "android/soong/android"
Colin Cross43f08db2018-11-12 10:13:39 -080025)
26
Martin Stjernholmc52aaf12020-01-06 23:11:37 +000027// GlobalConfig stores the configuration for dex preopting. The fields are set
Martin Stjernholm75a48d82020-01-10 20:32:59 +000028// from product variables via dex_preopt_config.mk.
Colin Cross43f08db2018-11-12 10:13:39 -080029type GlobalConfig struct {
Colin Cross69f59a32019-02-15 10:39:37 -080030 DisablePreopt bool // disable preopt for all modules
Colin Cross43f08db2018-11-12 10:13:39 -080031 DisablePreoptModules []string // modules with preopt disabled by product-specific config
32
33 OnlyPreoptBootImageAndSystemServer bool // only preopt jars in the boot image or system server
34
Vladimir Marko40139d62020-02-06 15:14:29 +000035 UseArtImage bool // use the art image (use other boot class path dex files without image)
36
Colin Cross43f08db2018-11-12 10:13:39 -080037 HasSystemOther bool // store odex files that match PatternsOnSystemOther on the system_other partition
38 PatternsOnSystemOther []string // patterns (using '%' to denote a prefix match) to put odex on the system_other partition
39
Colin Cross69f59a32019-02-15 10:39:37 -080040 DisableGenerateProfile bool // don't generate profiles
41 ProfileDir string // directory to find profiles in
Colin Cross43f08db2018-11-12 10:13:39 -080042
Ulya Trafimovich249386a2020-07-01 14:31:13 +010043 BootJars android.ConfiguredJarList // modules for jars that form the boot class path
44 UpdatableBootJars android.ConfiguredJarList // jars within apex that form the boot class path
Vladimir Markod2ee5322018-12-19 17:57:57 +000045
Ulya Trafimovich249386a2020-07-01 14:31:13 +010046 ArtApexJars android.ConfiguredJarList // modules for jars that are in the ART APEX
Colin Cross800fe132019-02-11 14:21:24 -080047
Ulya Trafimovich249386a2020-07-01 14:31:13 +010048 SystemServerJars []string // jars that form the system server
49 SystemServerApps []string // apps that are loaded into system server
50 UpdatableSystemServerJars android.ConfiguredJarList // jars within apex that are loaded into system server
51 SpeedApps []string // apps that should be speed optimized
Colin Cross43f08db2018-11-12 10:13:39 -080052
Ulya Trafimovichcd3203f2020-03-27 11:30:00 +000053 BrokenSuboptimalOrderOfSystemServerJars bool // if true, sub-optimal order does not cause a build error
54
Colin Cross43f08db2018-11-12 10:13:39 -080055 PreoptFlags []string // global dex2oat flags that should be used if no module-specific dex2oat flags are specified
56
57 DefaultCompilerFilter string // default compiler filter to pass to dex2oat, overridden by --compiler-filter= in module-specific dex2oat flags
58 SystemServerCompilerFilter string // default compiler filter to pass to dex2oat for system server jars
59
Nicolas Geoffrayc1bf7242019-10-18 14:51:38 +010060 GenerateDMFiles bool // generate Dex Metadata files
Colin Cross43f08db2018-11-12 10:13:39 -080061
62 NoDebugInfo bool // don't generate debug info by default
Mathieu Chartier3f7ddbb2019-04-29 09:33:50 -070063 DontResolveStartupStrings bool // don't resolve string literals loaded during application startup.
Colin Cross43f08db2018-11-12 10:13:39 -080064 AlwaysSystemServerDebugInfo bool // always generate mini debug info for system server modules (overrides NoDebugInfo=true)
65 NeverSystemServerDebugInfo bool // never generate mini debug info for system server modules (overrides NoDebugInfo=false)
66 AlwaysOtherDebugInfo bool // always generate mini debug info for non-system server modules (overrides NoDebugInfo=true)
67 NeverOtherDebugInfo bool // never generate mini debug info for non-system server modules (overrides NoDebugInfo=true)
68
Colin Cross43f08db2018-11-12 10:13:39 -080069 IsEng bool // build is a eng variant
70 SanitizeLite bool // build is the second phase of a SANITIZE_LITE build
71
72 DefaultAppImages bool // build app images (TODO: .art files?) by default
73
Colin Cross800fe132019-02-11 14:21:24 -080074 Dex2oatXmx string // max heap size for dex2oat
75 Dex2oatXms string // initial heap size for dex2oat
Colin Cross43f08db2018-11-12 10:13:39 -080076
77 EmptyDirectory string // path to an empty directory
78
Colin Cross74ba9622019-02-11 15:11:14 -080079 CpuVariant map[android.ArchType]string // cpu variant for each architecture
80 InstructionSetFeatures map[android.ArchType]string // instruction set for each architecture
Colin Cross43f08db2018-11-12 10:13:39 -080081
Colin Cross800fe132019-02-11 14:21:24 -080082 // Only used for boot image
Mathieu Chartier6adeee12019-06-26 10:01:36 -070083 DirtyImageObjects android.OptionalPath // path to a dirty-image-objects file
84 BootImageProfiles android.Paths // path to a boot-image-profile.txt file
85 BootFlags string // extra flags to pass to dex2oat for the boot image
86 Dex2oatImageXmx string // max heap size for dex2oat for the boot image
87 Dex2oatImageXms string // initial heap size for dex2oat for the boot image
Colin Cross43f08db2018-11-12 10:13:39 -080088}
89
Martin Stjernholmc52aaf12020-01-06 23:11:37 +000090// GlobalSoongConfig contains the global config that is generated from Soong,
91// stored in dexpreopt_soong.config.
92type GlobalSoongConfig struct {
93 // Paths to tools possibly used by the generated commands.
94 Profman android.Path
95 Dex2oat android.Path
96 Aapt android.Path
97 SoongZip android.Path
98 Zip2zip android.Path
99 ManifestCheck android.Path
Colin Cross38b96852019-05-22 10:21:09 -0700100 ConstructContext android.Path
Colin Cross43f08db2018-11-12 10:13:39 -0800101}
102
Ulya Trafimoviche3bb01d2020-09-11 12:17:29 +0100103// These libs are added as optional dependencies (<uses-library> with android:required set to false).
104// This is because they haven't existed prior to certain SDK version, but classes in them were in
105// bootclasspath jars, etc. So making them hard dependencies (android:required=true) would prevent
106// apps from being installed to such legacy devices.
Ulya Trafimovich663dc532020-09-10 12:48:53 +0100107var OptionalCompatUsesLibs = []string{
Ulya Trafimoviche3bb01d2020-09-11 12:17:29 +0100108 "org.apache.http.legacy",
Ulya Trafimovich663dc532020-09-10 12:48:53 +0100109 "android.test.base",
110 "android.test.mock",
111}
112
113var CompatUsesLibs = []string{
Ulya Trafimovich663dc532020-09-10 12:48:53 +0100114 "android.hidl.base-V1.0-java",
115 "android.hidl.manager-V1.0-java",
116}
117
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100118const UnknownInstallLibraryPath = "error"
119
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +0100120// LibraryPath contains paths to the library DEX jar on host and on device.
121type LibraryPath struct {
122 Host android.Path
123 Device string
124}
125
126// LibraryPaths is a map from library name to on-host and on-device paths to its DEX jar.
127type LibraryPaths map[string]*LibraryPath
128
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100129// Add a new library path to the map, unless a path for this library already exists.
Ulya Trafimovich663dc532020-09-10 12:48:53 +0100130// If necessary, check that the build and install paths exist.
131func (libPaths LibraryPaths) addLibraryPath(ctx android.ModuleContext, lib string,
132 hostPath, installPath android.Path, strict bool) {
133
134 // If missing dependencies are allowed, the build shouldn't fail when a <uses-library> is
135 // not found. However, this is likely to result is disabling dexpreopt, as it won't be
136 // possible to construct class loader context without on-host and on-device library paths.
137 strict = strict && !ctx.Config().AllowMissingDependencies()
138
139 if hostPath == nil && strict {
140 android.ReportPathErrorf(ctx, "unknown build path to <uses-library> '%s'", lib)
141 }
142
143 if installPath == nil {
144 if android.InList(lib, CompatUsesLibs) || android.InList(lib, OptionalCompatUsesLibs) {
145 // Assume that compatibility libraries are installed in /system/framework.
146 installPath = android.PathForModuleInstall(ctx, "framework", lib+".jar")
147 } else if strict {
148 android.ReportPathErrorf(ctx, "unknown install path to <uses-library> '%s'", lib)
149 }
150 }
151
152 // Add a library only if the build and install path to it is known.
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100153 if _, present := libPaths[lib]; !present {
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100154 var devicePath string
155 if installPath != nil {
156 devicePath = android.InstallPathToOnDevicePath(ctx, installPath.(android.InstallPath))
157 } else {
158 // For some stub libraries the only known thing is the name of their implementation
159 // library, but the library itself is unavailable (missing or part of a prebuilt). In
160 // such cases we still need to add the library to <uses-library> tags in the manifest,
161 // but we cannot use if for dexpreopt.
162 devicePath = UnknownInstallLibraryPath
163 }
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100164 libPaths[lib] = &LibraryPath{hostPath, devicePath}
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100165 }
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100166}
167
Ulya Trafimovich663dc532020-09-10 12:48:53 +0100168// Add a new library path to the map. Enforce checks that the library paths exist.
169func (libPaths LibraryPaths) AddLibraryPath(ctx android.ModuleContext, lib string, hostPath, installPath android.Path) {
170 libPaths.addLibraryPath(ctx, lib, hostPath, installPath, true)
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100171}
172
173// Add a new library path to the map, if the library exists (name is not nil).
Ulya Trafimovich663dc532020-09-10 12:48:53 +0100174// Don't enforce checks that the library paths exist. Some libraries may be missing from the build,
175// but their names still need to be added to <uses-library> tags in the manifest.
176func (libPaths LibraryPaths) MaybeAddLibraryPath(ctx android.ModuleContext, lib *string, hostPath, installPath android.Path) {
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100177 if lib != nil {
Ulya Trafimovich663dc532020-09-10 12:48:53 +0100178 libPaths.addLibraryPath(ctx, *lib, hostPath, installPath, false)
Ulya Trafimovichfc24ad32020-08-19 16:32:54 +0100179 }
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100180}
181
182// Add library paths from the second map to the first map (do not override existing entries).
183func (libPaths LibraryPaths) AddLibraryPaths(otherPaths LibraryPaths) {
184 for lib, path := range otherPaths {
185 if _, present := libPaths[lib]; !present {
186 libPaths[lib] = path
187 }
188 }
189}
190
Colin Cross43f08db2018-11-12 10:13:39 -0800191type ModuleConfig struct {
Victor Hsiehd181c8b2019-01-29 13:00:33 -0800192 Name string
193 DexLocation string // dex location on device
Colin Cross69f59a32019-02-15 10:39:37 -0800194 BuildPath android.OutputPath
195 DexPath android.Path
Colin Cross38b96852019-05-22 10:21:09 -0700196 ManifestPath android.Path
Victor Hsiehd181c8b2019-01-29 13:00:33 -0800197 UncompressedDex bool
198 HasApkLibraries bool
199 PreoptFlags []string
Colin Cross43f08db2018-11-12 10:13:39 -0800200
Colin Cross69f59a32019-02-15 10:39:37 -0800201 ProfileClassListing android.OptionalPath
Colin Cross43f08db2018-11-12 10:13:39 -0800202 ProfileIsTextListing bool
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100203 ProfileBootListing android.OptionalPath
Colin Cross43f08db2018-11-12 10:13:39 -0800204
Ulya Trafimovich6e827482020-06-12 14:32:24 +0100205 EnforceUsesLibraries bool
206 OptionalUsesLibraries []string
207 UsesLibraries []string
208 LibraryPaths LibraryPaths
Colin Cross43f08db2018-11-12 10:13:39 -0800209
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000210 Archs []android.ArchType
211 DexPreoptImages []android.Path
212 DexPreoptImagesDeps []android.OutputPaths
213 DexPreoptImageLocations []string
Colin Cross43f08db2018-11-12 10:13:39 -0800214
Colin Cross69f59a32019-02-15 10:39:37 -0800215 PreoptBootClassPathDexFiles android.Paths // file paths of boot class path files
216 PreoptBootClassPathDexLocations []string // virtual locations of boot class path files
Colin Cross800fe132019-02-11 14:21:24 -0800217
Colin Cross43f08db2018-11-12 10:13:39 -0800218 PreoptExtractedApk bool // Overrides OnlyPreoptModules
219
220 NoCreateAppImage bool
221 ForceCreateAppImage bool
222
223 PresignedPrebuilt bool
Colin Cross43f08db2018-11-12 10:13:39 -0800224}
225
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000226type globalSoongConfigSingleton struct{}
227
228var pctx = android.NewPackageContext("android/soong/dexpreopt")
229
230func init() {
231 pctx.Import("android/soong/android")
232 android.RegisterSingletonType("dexpreopt-soong-config", func() android.Singleton {
233 return &globalSoongConfigSingleton{}
234 })
235}
236
Colin Cross69f59a32019-02-15 10:39:37 -0800237func constructPath(ctx android.PathContext, path string) android.Path {
238 buildDirPrefix := ctx.Config().BuildDir() + "/"
239 if path == "" {
240 return nil
241 } else if strings.HasPrefix(path, buildDirPrefix) {
242 return android.PathForOutput(ctx, strings.TrimPrefix(path, buildDirPrefix))
243 } else {
244 return android.PathForSource(ctx, path)
245 }
Colin Cross43f08db2018-11-12 10:13:39 -0800246}
247
Colin Cross69f59a32019-02-15 10:39:37 -0800248func constructPaths(ctx android.PathContext, paths []string) android.Paths {
249 var ret android.Paths
250 for _, path := range paths {
251 ret = append(ret, constructPath(ctx, path))
252 }
253 return ret
Colin Cross43f08db2018-11-12 10:13:39 -0800254}
255
Colin Cross69f59a32019-02-15 10:39:37 -0800256func constructWritablePath(ctx android.PathContext, path string) android.WritablePath {
257 if path == "" {
258 return nil
259 }
260 return constructPath(ctx, path).(android.WritablePath)
261}
262
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000263// ParseGlobalConfig parses the given data assumed to be read from the global
264// dexpreopt.config file into a GlobalConfig struct.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000265func ParseGlobalConfig(ctx android.PathContext, data []byte) (*GlobalConfig, error) {
Colin Cross69f59a32019-02-15 10:39:37 -0800266 type GlobalJSONConfig struct {
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000267 *GlobalConfig
Colin Cross69f59a32019-02-15 10:39:37 -0800268
269 // Copies of entries in GlobalConfig that are not constructable without extra parameters. They will be
270 // used to construct the real value manually below.
Paul Duffin7ccacae2020-10-23 21:14:20 +0100271 DirtyImageObjects string
272 BootImageProfiles []string
Colin Cross69f59a32019-02-15 10:39:37 -0800273 }
274
275 config := GlobalJSONConfig{}
Colin Cross988414c2020-01-11 01:11:46 +0000276 err := json.Unmarshal(data, &config)
Colin Cross69f59a32019-02-15 10:39:37 -0800277 if err != nil {
Colin Cross988414c2020-01-11 01:11:46 +0000278 return config.GlobalConfig, err
Colin Cross69f59a32019-02-15 10:39:37 -0800279 }
280
281 // Construct paths that require a PathContext.
282 config.GlobalConfig.DirtyImageObjects = android.OptionalPathForPath(constructPath(ctx, config.DirtyImageObjects))
Colin Cross69f59a32019-02-15 10:39:37 -0800283 config.GlobalConfig.BootImageProfiles = constructPaths(ctx, config.BootImageProfiles)
284
Colin Cross988414c2020-01-11 01:11:46 +0000285 return config.GlobalConfig, nil
Colin Cross69f59a32019-02-15 10:39:37 -0800286}
287
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000288type globalConfigAndRaw struct {
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000289 global *GlobalConfig
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000290 data []byte
291}
292
293// GetGlobalConfig returns the global dexpreopt.config that's created in the
294// make config phase. It is loaded once the first time it is called for any
295// ctx.Config(), and returns the same data for all future calls with the same
296// ctx.Config(). A value can be inserted for tests using
297// setDexpreoptTestGlobalConfig.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000298func GetGlobalConfig(ctx android.PathContext) *GlobalConfig {
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000299 return getGlobalConfigRaw(ctx).global
300}
301
302// GetGlobalConfigRawData is the same as GetGlobalConfig, except that it returns
303// the literal content of dexpreopt.config.
304func GetGlobalConfigRawData(ctx android.PathContext) []byte {
305 return getGlobalConfigRaw(ctx).data
306}
307
308var globalConfigOnceKey = android.NewOnceKey("DexpreoptGlobalConfig")
309var testGlobalConfigOnceKey = android.NewOnceKey("TestDexpreoptGlobalConfig")
310
311func getGlobalConfigRaw(ctx android.PathContext) globalConfigAndRaw {
312 return ctx.Config().Once(globalConfigOnceKey, func() interface{} {
313 if data, err := ctx.Config().DexpreoptGlobalConfig(ctx); err != nil {
314 panic(err)
315 } else if data != nil {
316 globalConfig, err := ParseGlobalConfig(ctx, data)
317 if err != nil {
318 panic(err)
319 }
320 return globalConfigAndRaw{globalConfig, data}
321 }
322
323 // No global config filename set, see if there is a test config set
324 return ctx.Config().Once(testGlobalConfigOnceKey, func() interface{} {
325 // Nope, return a config with preopting disabled
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000326 return globalConfigAndRaw{&GlobalConfig{
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000327 DisablePreopt: true,
328 DisableGenerateProfile: true,
329 }, nil}
330 })
331 }).(globalConfigAndRaw)
332}
333
334// SetTestGlobalConfig sets a GlobalConfig that future calls to GetGlobalConfig
335// will return. It must be called before the first call to GetGlobalConfig for
336// the config.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000337func SetTestGlobalConfig(config android.Config, globalConfig *GlobalConfig) {
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000338 config.Once(testGlobalConfigOnceKey, func() interface{} { return globalConfigAndRaw{globalConfig, nil} })
339}
340
341// ParseModuleConfig parses a per-module dexpreopt.config file into a
342// ModuleConfig struct. It is not used in Soong, which receives a ModuleConfig
343// struct directly from java/dexpreopt.go. It is used in dexpreopt_gen called
344// from Make to read the module dexpreopt.config written in the Make config
345// stage.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000346func ParseModuleConfig(ctx android.PathContext, data []byte) (*ModuleConfig, error) {
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +0100347 type jsonLibraryPath struct {
348 Host string
349 Device string
350 }
351
352 type jsonLibraryPaths map[string]jsonLibraryPath
353
Colin Cross69f59a32019-02-15 10:39:37 -0800354 type ModuleJSONConfig struct {
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000355 *ModuleConfig
Colin Cross69f59a32019-02-15 10:39:37 -0800356
357 // Copies of entries in ModuleConfig that are not constructable without extra parameters. They will be
358 // used to construct the real value manually below.
359 BuildPath string
360 DexPath string
Colin Cross38b96852019-05-22 10:21:09 -0700361 ManifestPath string
Colin Cross69f59a32019-02-15 10:39:37 -0800362 ProfileClassListing string
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +0100363 LibraryPaths jsonLibraryPaths
Colin Cross69f59a32019-02-15 10:39:37 -0800364 DexPreoptImages []string
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000365 DexPreoptImageLocations []string
Colin Cross69f59a32019-02-15 10:39:37 -0800366 PreoptBootClassPathDexFiles []string
Colin Cross69f59a32019-02-15 10:39:37 -0800367 }
368
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +0100369 // convert JSON map of library paths to LibraryPaths
370 constructLibraryPaths := func(ctx android.PathContext, paths jsonLibraryPaths) LibraryPaths {
371 m := LibraryPaths{}
372 for lib, path := range paths {
373 m[lib] = &LibraryPath{
374 constructPath(ctx, path.Host),
375 path.Device,
376 }
377 }
378 return m
379 }
380
Colin Cross69f59a32019-02-15 10:39:37 -0800381 config := ModuleJSONConfig{}
382
Colin Cross988414c2020-01-11 01:11:46 +0000383 err := json.Unmarshal(data, &config)
Colin Cross69f59a32019-02-15 10:39:37 -0800384 if err != nil {
385 return config.ModuleConfig, err
386 }
387
388 // Construct paths that require a PathContext.
389 config.ModuleConfig.BuildPath = constructPath(ctx, config.BuildPath).(android.OutputPath)
390 config.ModuleConfig.DexPath = constructPath(ctx, config.DexPath)
Colin Cross38b96852019-05-22 10:21:09 -0700391 config.ModuleConfig.ManifestPath = constructPath(ctx, config.ManifestPath)
Colin Cross69f59a32019-02-15 10:39:37 -0800392 config.ModuleConfig.ProfileClassListing = android.OptionalPathForPath(constructPath(ctx, config.ProfileClassListing))
Ulya Trafimovichd4bcea42020-06-03 14:57:22 +0100393 config.ModuleConfig.LibraryPaths = constructLibraryPaths(ctx, config.LibraryPaths)
Colin Cross69f59a32019-02-15 10:39:37 -0800394 config.ModuleConfig.DexPreoptImages = constructPaths(ctx, config.DexPreoptImages)
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000395 config.ModuleConfig.DexPreoptImageLocations = config.DexPreoptImageLocations
Colin Cross69f59a32019-02-15 10:39:37 -0800396 config.ModuleConfig.PreoptBootClassPathDexFiles = constructPaths(ctx, config.PreoptBootClassPathDexFiles)
Colin Cross69f59a32019-02-15 10:39:37 -0800397
Dan Willemsen0f416782019-06-13 21:44:53 +0000398 // This needs to exist, but dependencies are already handled in Make, so we don't need to pass them through JSON.
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000399 config.ModuleConfig.DexPreoptImagesDeps = make([]android.OutputPaths, len(config.ModuleConfig.DexPreoptImages))
Dan Willemsen0f416782019-06-13 21:44:53 +0000400
Colin Cross69f59a32019-02-15 10:39:37 -0800401 return config.ModuleConfig, nil
402}
403
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000404// dex2oatModuleName returns the name of the module to use for the dex2oat host
405// tool. It should be a binary module with public visibility that is compiled
406// and installed for host.
407func dex2oatModuleName(config android.Config) string {
408 // Default to the debug variant of dex2oat to help find bugs.
409 // Set USE_DEX2OAT_DEBUG to false for only building non-debug versions.
410 if config.Getenv("USE_DEX2OAT_DEBUG") == "false" {
411 return "dex2oat"
412 } else {
413 return "dex2oatd"
414 }
415}
416
417var dex2oatDepTag = struct {
418 blueprint.BaseDependencyTag
419}{}
420
Martin Stjernholm6d415272020-01-31 17:10:36 +0000421// RegisterToolDeps adds the necessary dependencies to binary modules for tools
422// that are required later when Get(Cached)GlobalSoongConfig is called. It
423// should be called from a mutator that's registered with
424// android.RegistrationContext.FinalDepsMutators.
425func RegisterToolDeps(ctx android.BottomUpMutatorContext) {
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000426 dex2oatBin := dex2oatModuleName(ctx.Config())
427 v := ctx.Config().BuildOSTarget.Variations()
428 ctx.AddFarVariationDependencies(v, dex2oatDepTag, dex2oatBin)
429}
430
431func dex2oatPathFromDep(ctx android.ModuleContext) android.Path {
432 dex2oatBin := dex2oatModuleName(ctx.Config())
433
Martin Stjernholmc0048622020-08-18 17:37:41 +0100434 // Find the right dex2oat module, trying to follow PrebuiltDepTag from source
435 // to prebuilt if there is one. We wouldn't have to do this if the
436 // prebuilt_postdeps mutator that replaces source deps with prebuilt deps was
437 // run after RegisterToolDeps above, but changing that leads to ordering
438 // problems between mutators (RegisterToolDeps needs to run late to act on
439 // final variants, while prebuilt_postdeps needs to run before many of the
440 // PostDeps mutators, like the APEX mutators). Hence we need to dig out the
441 // prebuilt explicitly here instead.
442 var dex2oatModule android.Module
443 ctx.WalkDeps(func(child, parent android.Module) bool {
444 if parent == ctx.Module() && ctx.OtherModuleDependencyTag(child) == dex2oatDepTag {
445 // Found the source module, or prebuilt module that has replaced the source.
446 dex2oatModule = child
447 if p, ok := child.(android.PrebuiltInterface); ok && p.Prebuilt() != nil {
448 return false // If it's the prebuilt we're done.
449 } else {
450 return true // Recurse to check if the source has a prebuilt dependency.
451 }
452 }
453 if parent == dex2oatModule && ctx.OtherModuleDependencyTag(child) == android.PrebuiltDepTag {
454 if p, ok := child.(android.PrebuiltInterface); ok && p.Prebuilt() != nil && p.Prebuilt().UsePrebuilt() {
455 dex2oatModule = child // Found a prebuilt that should be used.
456 }
457 }
458 return false
459 })
460
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000461 if dex2oatModule == nil {
462 // If this happens there's probably a missing call to AddToolDeps in DepsMutator.
463 panic(fmt.Sprintf("Failed to lookup %s dependency", dex2oatBin))
464 }
465
466 dex2oatPath := dex2oatModule.(android.HostToolProvider).HostToolPath()
467 if !dex2oatPath.Valid() {
468 panic(fmt.Sprintf("Failed to find host tool path in %s", dex2oatModule))
469 }
470
471 return dex2oatPath.Path()
472}
473
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000474// createGlobalSoongConfig creates a GlobalSoongConfig from the current context.
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000475// Should not be used in dexpreopt_gen.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000476func createGlobalSoongConfig(ctx android.ModuleContext) *GlobalSoongConfig {
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000477 if ctx.Config().TestProductVariables != nil {
478 // If we're called in a test there'll be a confusing error from the path
479 // functions below that gets reported without a stack trace, so let's panic
480 // properly with a more helpful message.
481 panic("This should not be called from tests. Please call GlobalSoongConfigForTests somewhere in the test setup.")
482 }
483
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000484 return &GlobalSoongConfig{
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000485 Profman: ctx.Config().HostToolPath(ctx, "profman"),
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000486 Dex2oat: dex2oatPathFromDep(ctx),
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000487 Aapt: ctx.Config().HostToolPath(ctx, "aapt"),
488 SoongZip: ctx.Config().HostToolPath(ctx, "soong_zip"),
489 Zip2zip: ctx.Config().HostToolPath(ctx, "zip2zip"),
490 ManifestCheck: ctx.Config().HostToolPath(ctx, "manifest_check"),
Ulya Trafimovich5f364b62020-06-30 12:39:01 +0100491 ConstructContext: ctx.Config().HostToolPath(ctx, "construct_context"),
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000492 }
493}
494
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000495// The main reason for this Once cache for GlobalSoongConfig is to make the
496// dex2oat path available to singletons. In ordinary modules we get it through a
497// dex2oatDepTag dependency, but in singletons there's no simple way to do the
498// same thing and ensure the right variant is selected, hence this cache to make
499// the resolved path available to singletons. This means we depend on there
500// being at least one ordinary module with a dex2oatDepTag dependency.
501//
502// TODO(b/147613152): Implement a way to deal with dependencies from singletons,
503// and then possibly remove this cache altogether (but the use in
504// GlobalSoongConfigForTests also needs to be rethought).
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000505var globalSoongConfigOnceKey = android.NewOnceKey("DexpreoptGlobalSoongConfig")
506
507// GetGlobalSoongConfig creates a GlobalSoongConfig the first time it's called,
508// and later returns the same cached instance.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000509func GetGlobalSoongConfig(ctx android.ModuleContext) *GlobalSoongConfig {
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000510 globalSoong := ctx.Config().Once(globalSoongConfigOnceKey, func() interface{} {
511 return createGlobalSoongConfig(ctx)
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000512 }).(*GlobalSoongConfig)
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000513
514 // Always resolve the tool path from the dependency, to ensure that every
515 // module has the dependency added properly.
516 myDex2oat := dex2oatPathFromDep(ctx)
517 if myDex2oat != globalSoong.Dex2oat {
518 panic(fmt.Sprintf("Inconsistent dex2oat path in cached config: expected %s, got %s", globalSoong.Dex2oat, myDex2oat))
519 }
520
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000521 return globalSoong
522}
523
524// GetCachedGlobalSoongConfig returns a cached GlobalSoongConfig created by an
525// earlier GetGlobalSoongConfig call. This function works with any context
526// compatible with a basic PathContext, since it doesn't try to create a
Martin Stjernholm6d415272020-01-31 17:10:36 +0000527// GlobalSoongConfig with the proper paths (which requires a full
528// ModuleContext). If there has been no prior call to GetGlobalSoongConfig, nil
529// is returned.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000530func GetCachedGlobalSoongConfig(ctx android.PathContext) *GlobalSoongConfig {
Martin Stjernholm6d415272020-01-31 17:10:36 +0000531 return ctx.Config().Once(globalSoongConfigOnceKey, func() interface{} {
532 return (*GlobalSoongConfig)(nil)
533 }).(*GlobalSoongConfig)
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000534}
535
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000536type globalJsonSoongConfig struct {
537 Profman string
538 Dex2oat string
539 Aapt string
540 SoongZip string
541 Zip2zip string
542 ManifestCheck string
543 ConstructContext string
544}
545
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000546// ParseGlobalSoongConfig parses the given data assumed to be read from the
547// global dexpreopt_soong.config file into a GlobalSoongConfig struct. It is
548// only used in dexpreopt_gen.
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000549func ParseGlobalSoongConfig(ctx android.PathContext, data []byte) (*GlobalSoongConfig, error) {
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000550 var jc globalJsonSoongConfig
551
Colin Cross988414c2020-01-11 01:11:46 +0000552 err := json.Unmarshal(data, &jc)
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000553 if err != nil {
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000554 return &GlobalSoongConfig{}, err
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000555 }
556
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000557 config := &GlobalSoongConfig{
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000558 Profman: constructPath(ctx, jc.Profman),
559 Dex2oat: constructPath(ctx, jc.Dex2oat),
560 Aapt: constructPath(ctx, jc.Aapt),
561 SoongZip: constructPath(ctx, jc.SoongZip),
562 Zip2zip: constructPath(ctx, jc.Zip2zip),
563 ManifestCheck: constructPath(ctx, jc.ManifestCheck),
564 ConstructContext: constructPath(ctx, jc.ConstructContext),
565 }
566
567 return config, nil
568}
569
570func (s *globalSoongConfigSingleton) GenerateBuildActions(ctx android.SingletonContext) {
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000571 if GetGlobalConfig(ctx).DisablePreopt {
572 return
573 }
574
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000575 config := GetCachedGlobalSoongConfig(ctx)
Martin Stjernholm6d415272020-01-31 17:10:36 +0000576 if config == nil {
577 // No module has enabled dexpreopting, so we assume there will be no calls
578 // to dexpreopt_gen.
579 return
580 }
581
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000582 jc := globalJsonSoongConfig{
583 Profman: config.Profman.String(),
584 Dex2oat: config.Dex2oat.String(),
585 Aapt: config.Aapt.String(),
586 SoongZip: config.SoongZip.String(),
587 Zip2zip: config.Zip2zip.String(),
588 ManifestCheck: config.ManifestCheck.String(),
589 ConstructContext: config.ConstructContext.String(),
590 }
591
592 data, err := json.Marshal(jc)
593 if err != nil {
594 ctx.Errorf("failed to JSON marshal GlobalSoongConfig: %v", err)
595 return
596 }
597
598 ctx.Build(pctx, android.BuildParams{
599 Rule: android.WriteFile,
600 Output: android.PathForOutput(ctx, "dexpreopt_soong.config"),
601 Args: map[string]string{
602 "content": string(data),
603 },
604 })
605}
606
607func (s *globalSoongConfigSingleton) MakeVars(ctx android.MakeVarsContext) {
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000608 if GetGlobalConfig(ctx).DisablePreopt {
609 return
610 }
611
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000612 config := GetCachedGlobalSoongConfig(ctx)
Martin Stjernholm6d415272020-01-31 17:10:36 +0000613 if config == nil {
614 return
615 }
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000616
617 ctx.Strict("DEX2OAT", config.Dex2oat.String())
618 ctx.Strict("DEXPREOPT_GEN_DEPS", strings.Join([]string{
619 config.Profman.String(),
620 config.Dex2oat.String(),
621 config.Aapt.String(),
622 config.SoongZip.String(),
623 config.Zip2zip.String(),
624 config.ManifestCheck.String(),
625 config.ConstructContext.String(),
626 }, " "))
627}
628
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000629func GlobalConfigForTests(ctx android.PathContext) *GlobalConfig {
630 return &GlobalConfig{
Colin Cross69f59a32019-02-15 10:39:37 -0800631 DisablePreopt: false,
632 DisablePreoptModules: nil,
633 OnlyPreoptBootImageAndSystemServer: false,
634 HasSystemOther: false,
635 PatternsOnSystemOther: nil,
636 DisableGenerateProfile: false,
637 ProfileDir: "",
Ulya Trafimovich249386a2020-07-01 14:31:13 +0100638 BootJars: android.EmptyConfiguredJarList(),
639 UpdatableBootJars: android.EmptyConfiguredJarList(),
640 ArtApexJars: android.EmptyConfiguredJarList(),
Colin Cross69f59a32019-02-15 10:39:37 -0800641 SystemServerJars: nil,
642 SystemServerApps: nil,
Ulya Trafimovich249386a2020-07-01 14:31:13 +0100643 UpdatableSystemServerJars: android.EmptyConfiguredJarList(),
Colin Cross69f59a32019-02-15 10:39:37 -0800644 SpeedApps: nil,
645 PreoptFlags: nil,
646 DefaultCompilerFilter: "",
647 SystemServerCompilerFilter: "",
648 GenerateDMFiles: false,
Colin Cross69f59a32019-02-15 10:39:37 -0800649 NoDebugInfo: false,
Mathieu Chartier3f7ddbb2019-04-29 09:33:50 -0700650 DontResolveStartupStrings: false,
Colin Cross69f59a32019-02-15 10:39:37 -0800651 AlwaysSystemServerDebugInfo: false,
652 NeverSystemServerDebugInfo: false,
653 AlwaysOtherDebugInfo: false,
654 NeverOtherDebugInfo: false,
Colin Cross69f59a32019-02-15 10:39:37 -0800655 IsEng: false,
656 SanitizeLite: false,
657 DefaultAppImages: false,
658 Dex2oatXmx: "",
659 Dex2oatXms: "",
660 EmptyDirectory: "empty_dir",
661 CpuVariant: nil,
662 InstructionSetFeatures: nil,
663 DirtyImageObjects: android.OptionalPath{},
Colin Cross69f59a32019-02-15 10:39:37 -0800664 BootImageProfiles: nil,
Colin Cross69f59a32019-02-15 10:39:37 -0800665 BootFlags: "",
666 Dex2oatImageXmx: "",
667 Dex2oatImageXms: "",
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000668 }
669}
670
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000671func GlobalSoongConfigForTests(config android.Config) *GlobalSoongConfig {
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000672 // Install the test GlobalSoongConfig in the Once cache so that later calls to
673 // Get(Cached)GlobalSoongConfig returns it without trying to create a real one.
674 return config.Once(globalSoongConfigOnceKey, func() interface{} {
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000675 return &GlobalSoongConfig{
Colin Cross38b96852019-05-22 10:21:09 -0700676 Profman: android.PathForTesting("profman"),
677 Dex2oat: android.PathForTesting("dex2oat"),
678 Aapt: android.PathForTesting("aapt"),
679 SoongZip: android.PathForTesting("soong_zip"),
680 Zip2zip: android.PathForTesting("zip2zip"),
681 ManifestCheck: android.PathForTesting("manifest_check"),
Ulya Trafimovich5f364b62020-06-30 12:39:01 +0100682 ConstructContext: android.PathForTesting("construct_context"),
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000683 }
Martin Stjernholm8d80cee2020-01-31 17:44:54 +0000684 }).(*GlobalSoongConfig)
Colin Cross69f59a32019-02-15 10:39:37 -0800685}