blob: 6ec919c930fe64bc8a7a4d2962002e80a256e826 [file] [log] [blame]
Colin Cross800fe132019-02-11 14:21:24 -08001// Copyright 2019 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 java
16
17import (
18 "path/filepath"
19 "strings"
20
21 "android/soong/android"
22 "android/soong/dexpreopt"
23
Colin Cross800fe132019-02-11 14:21:24 -080024 "github.com/google/blueprint/proptools"
25)
26
27func init() {
28 android.RegisterSingletonType("dex_bootjars", dexpreoptBootJarsFactory)
29}
30
31// The image "location" is a symbolic path that with multiarchitecture
32// support doesn't really exist on the device. Typically it is
33// /system/framework/boot.art and should be the same for all supported
34// architectures on the device. The concrete architecture specific
35// content actually ends up in a "filename" that contains an
36// architecture specific directory name such as arm, arm64, mips,
37// mips64, x86, x86_64.
38//
39// Here are some example values for an x86_64 / x86 configuration:
40//
41// bootImages["x86_64"] = "out/soong/generic_x86_64/dex_bootjars/system/framework/x86_64/boot.art"
42// dexpreopt.PathToLocation(bootImages["x86_64"], "x86_64") = "out/soong/generic_x86_64/dex_bootjars/system/framework/boot.art"
43//
44// bootImages["x86"] = "out/soong/generic_x86_64/dex_bootjars/system/framework/x86/boot.art"
45// dexpreopt.PathToLocation(bootImages["x86"])= "out/soong/generic_x86_64/dex_bootjars/system/framework/boot.art"
46//
47// The location is passed as an argument to the ART tools like dex2oat instead of the real path. The ART tools
48// will then reconstruct the real path, so the rules must have a dependency on the real path.
49
David Srbeckyc177ebe2020-02-18 20:43:06 +000050// Target-independent description of pre-compiled boot image.
Colin Cross44df5812019-02-15 23:06:46 -080051type bootImageConfig struct {
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000052 // Whether this image is an extension.
53 extension bool
54
55 // Image name (used in directory names and ninja rule names).
56 name string
57
58 // Basename of the image: the resulting filenames are <stem>[-<jar>].{art,oat,vdex}.
59 stem string
60
61 // Output directory for the image files.
62 dir android.OutputPath
63
64 // Output directory for the image files with debug symbols.
65 symbolsDir android.OutputPath
66
67 // Subdirectory where the image files are installed.
68 installSubdir string
69
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000070 // The names of jars that constitute this image.
71 modules []string
72
73 // The "locations" of jars.
74 dexLocations []string // for this image
75 dexLocationsDeps []string // for the dependency images and in this image
76
77 // File paths to jars.
78 dexPaths android.WritablePaths // for this image
79 dexPathsDeps android.WritablePaths // for the dependency images and in this image
80
81 // The "locations" of the dependency images and in this image.
82 imageLocations []string
83
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000084 // File path to a zip archive with all image files (or nil, if not needed).
85 zip android.WritablePath
David Srbeckyc177ebe2020-02-18 20:43:06 +000086
87 // Rules which should be used in make to install the outputs.
88 profileInstalls android.RuleBuilderInstalls
89
90 // Target-dependent fields.
91 variants []*bootImageVariant
92}
93
94// Target-dependent description of pre-compiled boot image.
95type bootImageVariant struct {
96 *bootImageConfig
97
98 // Target for which the image is generated.
99 target android.Target
100
101 // Paths to image files.
102 images android.OutputPath // first image file
103 imagesDeps android.OutputPaths // all files
104
105 // Only for extensions, paths to the primary boot images.
106 primaryImages android.OutputPath
107
108 // Rules which should be used in make to install the outputs.
109 installs android.RuleBuilderInstalls
110 vdexInstalls android.RuleBuilderInstalls
111 unstrippedInstalls android.RuleBuilderInstalls
112}
113
114func (image bootImageConfig) getVariant(target android.Target) *bootImageVariant {
115 for _, variant := range image.variants {
116 if variant.target.Os == target.Os && variant.target.Arch.ArchType == target.Arch.ArchType {
117 return variant
118 }
119 }
120 return nil
Colin Cross800fe132019-02-11 14:21:24 -0800121}
122
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000123func (image bootImageConfig) moduleName(idx int) string {
124 // Dexpreopt on the boot class path produces multiple files. The first dex file
125 // is converted into 'name'.art (to match the legacy assumption that 'name'.art
Dan Willemsen0f416782019-06-13 21:44:53 +0000126 // exists), and the rest are converted to 'name'-<jar>.art.
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000127 m := image.modules[idx]
128 name := image.stem
129 if idx != 0 || image.extension {
130 name += "-" + stemOf(m)
131 }
132 return name
133}
Dan Willemsen0f416782019-06-13 21:44:53 +0000134
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000135func (image bootImageConfig) firstModuleNameOrStem() string {
136 if len(image.modules) > 0 {
137 return image.moduleName(0)
138 } else {
139 return image.stem
140 }
141}
142
143func (image bootImageConfig) moduleFiles(ctx android.PathContext, dir android.OutputPath, exts ...string) android.OutputPaths {
144 ret := make(android.OutputPaths, 0, len(image.modules)*len(exts))
145 for i := range image.modules {
146 name := image.moduleName(i)
Dan Willemsen0f416782019-06-13 21:44:53 +0000147 for _, ext := range exts {
148 ret = append(ret, dir.Join(ctx, name+ext))
149 }
150 }
Dan Willemsen0f416782019-06-13 21:44:53 +0000151 return ret
152}
153
Colin Cross800fe132019-02-11 14:21:24 -0800154func concat(lists ...[]string) []string {
155 var size int
156 for _, l := range lists {
157 size += len(l)
158 }
159 ret := make([]string, 0, size)
160 for _, l := range lists {
161 ret = append(ret, l...)
162 }
163 return ret
164}
165
Colin Cross800fe132019-02-11 14:21:24 -0800166func dexpreoptBootJarsFactory() android.Singleton {
Colin Cross44df5812019-02-15 23:06:46 -0800167 return &dexpreoptBootJars{}
Colin Cross800fe132019-02-11 14:21:24 -0800168}
169
170func skipDexpreoptBootJars(ctx android.PathContext) bool {
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000171 if dexpreopt.GetGlobalConfig(ctx).DisablePreopt {
Ulya Trafimovichacb33e02019-11-01 17:57:29 +0000172 return true
173 }
174
Colin Cross800fe132019-02-11 14:21:24 -0800175 if ctx.Config().UnbundledBuild() {
176 return true
177 }
178
179 if len(ctx.Config().Targets[android.Android]) == 0 {
180 // Host-only build
181 return true
182 }
183
184 return false
185}
186
Colin Cross44df5812019-02-15 23:06:46 -0800187type dexpreoptBootJars struct {
David Srbeckyc177ebe2020-02-18 20:43:06 +0000188 defaultBootImage *bootImageConfig
189 otherImages []*bootImageConfig
Colin Cross2d00f0d2019-05-09 21:50:00 -0700190
191 dexpreoptConfigForMake android.WritablePath
Colin Cross44df5812019-02-15 23:06:46 -0800192}
Colin Cross800fe132019-02-11 14:21:24 -0800193
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000194// Accessor function for the apex package. Returns nil if dexpreopt is disabled.
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000195func DexpreoptedArtApexJars(ctx android.BuilderContext) map[android.ArchType]android.OutputPaths {
Ulya Trafimovich44561882020-01-03 13:25:54 +0000196 if skipDexpreoptBootJars(ctx) {
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000197 return nil
198 }
Ulya Trafimovich7eebb4f2020-01-22 13:41:06 +0000199 // Include dexpreopt files for the primary boot image.
David Srbeckyc177ebe2020-02-18 20:43:06 +0000200 files := map[android.ArchType]android.OutputPaths{}
201 for _, variant := range artBootImageConfig(ctx).variants {
202 files[variant.target.Arch.ArchType] = variant.imagesDeps
203 }
Ulya Trafimovich7eebb4f2020-01-22 13:41:06 +0000204 return files
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000205}
206
Colin Cross800fe132019-02-11 14:21:24 -0800207// dexpreoptBoot singleton rules
Colin Cross44df5812019-02-15 23:06:46 -0800208func (d *dexpreoptBootJars) GenerateBuildActions(ctx android.SingletonContext) {
Colin Cross800fe132019-02-11 14:21:24 -0800209 if skipDexpreoptBootJars(ctx) {
210 return
211 }
Martin Stjernholm6d415272020-01-31 17:10:36 +0000212 if dexpreopt.GetCachedGlobalSoongConfig(ctx) == nil {
213 // No module has enabled dexpreopting, so we assume there will be no boot image to make.
214 return
215 }
Colin Cross800fe132019-02-11 14:21:24 -0800216
Colin Cross2d00f0d2019-05-09 21:50:00 -0700217 d.dexpreoptConfigForMake = android.PathForOutput(ctx, ctx.Config().DeviceName(), "dexpreopt.config")
218 writeGlobalConfigForMake(ctx, d.dexpreoptConfigForMake)
219
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000220 global := dexpreopt.GetGlobalConfig(ctx)
Colin Cross800fe132019-02-11 14:21:24 -0800221
222 // Skip recompiling the boot image for the second sanitization phase. We'll get separate paths
223 // and invalidate first-stage artifacts which are crucial to SANITIZE_LITE builds.
224 // Note: this is technically incorrect. Compiled code contains stack checks which may depend
225 // on ASAN settings.
226 if len(ctx.Config().SanitizeDevice()) == 1 &&
227 ctx.Config().SanitizeDevice()[0] == "address" &&
Colin Cross44df5812019-02-15 23:06:46 -0800228 global.SanitizeLite {
Colin Cross800fe132019-02-11 14:21:24 -0800229 return
230 }
231
Lingfeng Yang54191fa2019-12-19 16:40:09 +0000232 // Always create the default boot image first, to get a unique profile rule for all images.
233 d.defaultBootImage = buildBootImage(ctx, defaultBootImageConfig(ctx))
Ulya Trafimovich44561882020-01-03 13:25:54 +0000234 // Create boot image for the ART apex (build artifacts are accessed via the global boot image config).
235 d.otherImages = append(d.otherImages, buildBootImage(ctx, artBootImageConfig(ctx)))
Colin Crossc9a4c362019-02-26 21:13:48 -0800236
237 dumpOatRules(ctx, d.defaultBootImage)
Colin Cross44df5812019-02-15 23:06:46 -0800238}
239
David Srbeckyc177ebe2020-02-18 20:43:06 +0000240// buildBootImage takes a bootImageConfig, creates rules to build it, and returns the image.
241func buildBootImage(ctx android.SingletonContext, image *bootImageConfig) *bootImageConfig {
Colin Cross44df5812019-02-15 23:06:46 -0800242 bootDexJars := make(android.Paths, len(image.modules))
Colin Cross800fe132019-02-11 14:21:24 -0800243 ctx.VisitAllModules(func(module android.Module) {
244 // Collect dex jar paths for the modules listed above.
Colin Cross42be7612019-02-21 18:12:14 -0800245 if j, ok := module.(interface{ DexJar() android.Path }); ok {
Colin Cross800fe132019-02-11 14:21:24 -0800246 name := ctx.ModuleName(module)
Colin Cross44df5812019-02-15 23:06:46 -0800247 if i := android.IndexList(name, image.modules); i != -1 {
Colin Cross800fe132019-02-11 14:21:24 -0800248 bootDexJars[i] = j.DexJar()
249 }
250 }
251 })
252
253 var missingDeps []string
254 // Ensure all modules were converted to paths
255 for i := range bootDexJars {
256 if bootDexJars[i] == nil {
257 if ctx.Config().AllowMissingDependencies() {
Colin Cross44df5812019-02-15 23:06:46 -0800258 missingDeps = append(missingDeps, image.modules[i])
Colin Cross800fe132019-02-11 14:21:24 -0800259 bootDexJars[i] = android.PathForOutput(ctx, "missing")
260 } else {
261 ctx.Errorf("failed to find dex jar path for module %q",
Colin Cross44df5812019-02-15 23:06:46 -0800262 image.modules[i])
Colin Cross800fe132019-02-11 14:21:24 -0800263 }
264 }
265 }
266
267 // The path to bootclasspath dex files needs to be known at module GenerateAndroidBuildAction time, before
268 // the bootclasspath modules have been compiled. Copy the dex jars there so the module rules that have
269 // already been set up can find them.
270 for i := range bootDexJars {
271 ctx.Build(pctx, android.BuildParams{
272 Rule: android.Cp,
273 Input: bootDexJars[i],
Colin Cross44df5812019-02-15 23:06:46 -0800274 Output: image.dexPaths[i],
Colin Cross800fe132019-02-11 14:21:24 -0800275 })
276 }
277
Colin Cross44df5812019-02-15 23:06:46 -0800278 profile := bootImageProfileRule(ctx, image, missingDeps)
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100279 bootFrameworkProfileRule(ctx, image, missingDeps)
Colin Cross800fe132019-02-11 14:21:24 -0800280
Colin Crossdf8eebe2019-04-09 15:29:41 -0700281 var allFiles android.Paths
David Srbeckyc177ebe2020-02-18 20:43:06 +0000282 for _, variant := range image.variants {
283 files := buildBootImageVariant(ctx, variant, profile, missingDeps)
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000284 allFiles = append(allFiles, files.Paths()...)
Colin Cross800fe132019-02-11 14:21:24 -0800285 }
Colin Cross44df5812019-02-15 23:06:46 -0800286
Colin Crossdf8eebe2019-04-09 15:29:41 -0700287 if image.zip != nil {
288 rule := android.NewRuleBuilder()
289 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -0700290 BuiltTool(ctx, "soong_zip").
Colin Crossdf8eebe2019-04-09 15:29:41 -0700291 FlagWithOutput("-o ", image.zip).
292 FlagWithArg("-C ", image.dir.String()).
293 FlagWithInputList("-f ", allFiles, " -f ")
294
295 rule.Build(pctx, ctx, "zip_"+image.name, "zip "+image.name+" image")
296 }
297
Colin Cross44df5812019-02-15 23:06:46 -0800298 return image
Colin Cross800fe132019-02-11 14:21:24 -0800299}
300
David Srbeckyc177ebe2020-02-18 20:43:06 +0000301func buildBootImageVariant(ctx android.SingletonContext, image *bootImageVariant,
302 profile android.Path, missingDeps []string) android.WritablePaths {
Colin Cross800fe132019-02-11 14:21:24 -0800303
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000304 globalSoong := dexpreopt.GetCachedGlobalSoongConfig(ctx)
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000305 global := dexpreopt.GetGlobalConfig(ctx)
Colin Cross44df5812019-02-15 23:06:46 -0800306
David Srbeckyc177ebe2020-02-18 20:43:06 +0000307 arch := image.target.Arch.ArchType
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000308 symbolsDir := image.symbolsDir.Join(ctx, image.installSubdir, arch.String())
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000309 symbolsFile := symbolsDir.Join(ctx, image.stem+".oat")
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000310 outputDir := image.dir.Join(ctx, image.installSubdir, arch.String())
311 outputPath := outputDir.Join(ctx, image.stem+".oat")
312 oatLocation := dexpreopt.PathToLocation(outputPath, arch)
313 imagePath := outputPath.ReplaceExtension(ctx, "art")
Colin Cross800fe132019-02-11 14:21:24 -0800314
315 rule := android.NewRuleBuilder()
316 rule.MissingDeps(missingDeps)
317
318 rule.Command().Text("mkdir").Flag("-p").Flag(symbolsDir.String())
319 rule.Command().Text("rm").Flag("-f").
320 Flag(symbolsDir.Join(ctx, "*.art").String()).
321 Flag(symbolsDir.Join(ctx, "*.oat").String()).
322 Flag(symbolsDir.Join(ctx, "*.invocation").String())
323 rule.Command().Text("rm").Flag("-f").
324 Flag(outputDir.Join(ctx, "*.art").String()).
325 Flag(outputDir.Join(ctx, "*.oat").String()).
326 Flag(outputDir.Join(ctx, "*.invocation").String())
327
328 cmd := rule.Command()
329
330 extraFlags := ctx.Config().Getenv("ART_BOOT_IMAGE_EXTRA_ARGS")
331 if extraFlags == "" {
332 // Use ANDROID_LOG_TAGS to suppress most logging by default...
333 cmd.Text(`ANDROID_LOG_TAGS="*:e"`)
334 } else {
335 // ...unless the boot image is generated specifically for testing, then allow all logging.
336 cmd.Text(`ANDROID_LOG_TAGS="*:v"`)
337 }
338
339 invocationPath := outputPath.ReplaceExtension(ctx, "invocation")
340
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000341 cmd.Tool(globalSoong.Dex2oat).
Colin Cross800fe132019-02-11 14:21:24 -0800342 Flag("--avoid-storing-invocation").
Colin Cross69f59a32019-02-15 10:39:37 -0800343 FlagWithOutput("--write-invocation-to=", invocationPath).ImplicitOutput(invocationPath).
Colin Cross44df5812019-02-15 23:06:46 -0800344 Flag("--runtime-arg").FlagWithArg("-Xms", global.Dex2oatImageXms).
345 Flag("--runtime-arg").FlagWithArg("-Xmx", global.Dex2oatImageXmx)
Colin Cross800fe132019-02-11 14:21:24 -0800346
Colin Cross69f59a32019-02-15 10:39:37 -0800347 if profile != nil {
Colin Cross800fe132019-02-11 14:21:24 -0800348 cmd.FlagWithArg("--compiler-filter=", "speed-profile")
Colin Cross69f59a32019-02-15 10:39:37 -0800349 cmd.FlagWithInput("--profile-file=", profile)
Colin Cross800fe132019-02-11 14:21:24 -0800350 }
351
Colin Cross44df5812019-02-15 23:06:46 -0800352 if global.DirtyImageObjects.Valid() {
353 cmd.FlagWithInput("--dirty-image-objects=", global.DirtyImageObjects.Path())
Colin Cross800fe132019-02-11 14:21:24 -0800354 }
355
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000356 if image.extension {
David Srbeckyc177ebe2020-02-18 20:43:06 +0000357 artImage := image.primaryImages
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000358 cmd.
359 Flag("--runtime-arg").FlagWithInputList("-Xbootclasspath:", image.dexPathsDeps.Paths(), ":").
360 Flag("--runtime-arg").FlagWithList("-Xbootclasspath-locations:", image.dexLocationsDeps, ":").
361 FlagWithArg("--boot-image=", dexpreopt.PathToLocation(artImage, arch)).Implicit(artImage)
362 } else {
363 cmd.FlagWithArg("--base=", ctx.Config().LibartImgDeviceBaseAddress())
364 }
365
Colin Cross800fe132019-02-11 14:21:24 -0800366 cmd.
Colin Cross44df5812019-02-15 23:06:46 -0800367 FlagForEachInput("--dex-file=", image.dexPaths.Paths()).
368 FlagForEachArg("--dex-location=", image.dexLocations).
Colin Cross800fe132019-02-11 14:21:24 -0800369 Flag("--generate-debug-info").
370 Flag("--generate-build-id").
Mathieu Chartier54fd8072019-07-26 13:50:04 -0700371 Flag("--image-format=lz4hc").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000372 FlagWithArg("--oat-symbols=", symbolsFile.String()).
Colin Cross800fe132019-02-11 14:21:24 -0800373 Flag("--strip").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000374 FlagWithArg("--oat-file=", outputPath.String()).
Colin Cross800fe132019-02-11 14:21:24 -0800375 FlagWithArg("--oat-location=", oatLocation).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000376 FlagWithArg("--image=", imagePath.String()).
Colin Cross800fe132019-02-11 14:21:24 -0800377 FlagWithArg("--instruction-set=", arch.String()).
Colin Cross44df5812019-02-15 23:06:46 -0800378 FlagWithArg("--instruction-set-variant=", global.CpuVariant[arch]).
379 FlagWithArg("--instruction-set-features=", global.InstructionSetFeatures[arch]).
380 FlagWithArg("--android-root=", global.EmptyDirectory).
Colin Cross800fe132019-02-11 14:21:24 -0800381 FlagWithArg("--no-inline-from=", "core-oj.jar").
Ulya Trafimovichc0c98d52020-03-09 12:46:06 +0000382 Flag("--force-determinism").
Colin Cross800fe132019-02-11 14:21:24 -0800383 Flag("--abort-on-hard-verifier-error")
384
Colin Cross44df5812019-02-15 23:06:46 -0800385 if global.BootFlags != "" {
386 cmd.Flag(global.BootFlags)
Colin Cross800fe132019-02-11 14:21:24 -0800387 }
388
389 if extraFlags != "" {
390 cmd.Flag(extraFlags)
391 }
392
Colin Cross0b9f31f2019-02-28 11:00:01 -0800393 cmd.Textf(`|| ( echo %s ; false )`, proptools.ShellEscape(failureMessage))
Colin Cross800fe132019-02-11 14:21:24 -0800394
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000395 installDir := filepath.Join("/", image.installSubdir, arch.String())
396 vdexInstallDir := filepath.Join("/", image.installSubdir)
Colin Cross800fe132019-02-11 14:21:24 -0800397
Colin Cross800fe132019-02-11 14:21:24 -0800398 var vdexInstalls android.RuleBuilderInstalls
399 var unstrippedInstalls android.RuleBuilderInstalls
400
Colin Crossdf8eebe2019-04-09 15:29:41 -0700401 var zipFiles android.WritablePaths
402
Dan Willemsen0f416782019-06-13 21:44:53 +0000403 for _, artOrOat := range image.moduleFiles(ctx, outputDir, ".art", ".oat") {
404 cmd.ImplicitOutput(artOrOat)
405 zipFiles = append(zipFiles, artOrOat)
Colin Cross800fe132019-02-11 14:21:24 -0800406
Dan Willemsen0f416782019-06-13 21:44:53 +0000407 // Install the .oat and .art files
408 rule.Install(artOrOat, filepath.Join(installDir, artOrOat.Base()))
409 }
Colin Cross800fe132019-02-11 14:21:24 -0800410
Dan Willemsen0f416782019-06-13 21:44:53 +0000411 for _, vdex := range image.moduleFiles(ctx, outputDir, ".vdex") {
412 cmd.ImplicitOutput(vdex)
413 zipFiles = append(zipFiles, vdex)
Colin Cross800fe132019-02-11 14:21:24 -0800414
415 // The vdex files are identical between architectures, install them to a shared location. The Make rules will
416 // only use the install rules for one architecture, and will create symlinks into the architecture-specific
417 // directories.
418 vdexInstalls = append(vdexInstalls,
Colin Cross69f59a32019-02-15 10:39:37 -0800419 android.RuleBuilderInstall{vdex, filepath.Join(vdexInstallDir, vdex.Base())})
Dan Willemsen0f416782019-06-13 21:44:53 +0000420 }
421
422 for _, unstrippedOat := range image.moduleFiles(ctx, symbolsDir, ".oat") {
423 cmd.ImplicitOutput(unstrippedOat)
Colin Cross800fe132019-02-11 14:21:24 -0800424
425 // Install the unstripped oat files. The Make rules will put these in $(TARGET_OUT_UNSTRIPPED)
426 unstrippedInstalls = append(unstrippedInstalls,
Colin Cross69f59a32019-02-15 10:39:37 -0800427 android.RuleBuilderInstall{unstrippedOat, filepath.Join(installDir, unstrippedOat.Base())})
Colin Cross800fe132019-02-11 14:21:24 -0800428 }
429
Colin Cross44df5812019-02-15 23:06:46 -0800430 rule.Build(pctx, ctx, image.name+"JarsDexpreopt_"+arch.String(), "dexpreopt "+image.name+" jars "+arch.String())
Colin Cross800fe132019-02-11 14:21:24 -0800431
432 // save output and installed files for makevars
David Srbeckyc177ebe2020-02-18 20:43:06 +0000433 image.installs = rule.Installs()
434 image.vdexInstalls = vdexInstalls
435 image.unstrippedInstalls = unstrippedInstalls
Colin Crossdf8eebe2019-04-09 15:29:41 -0700436
437 return zipFiles
Colin Cross800fe132019-02-11 14:21:24 -0800438}
439
440const failureMessage = `ERROR: Dex2oat failed to compile a boot image.
441It is likely that the boot classpath is inconsistent.
442Rebuild with ART_BOOT_IMAGE_EXTRA_ARGS="--runtime-arg -verbose:verifier" to see verification errors.`
443
David Srbeckyc177ebe2020-02-18 20:43:06 +0000444func bootImageProfileRule(ctx android.SingletonContext, image *bootImageConfig, missingDeps []string) android.WritablePath {
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000445 globalSoong := dexpreopt.GetCachedGlobalSoongConfig(ctx)
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000446 global := dexpreopt.GetGlobalConfig(ctx)
Nicolas Geoffray27c7cc62019-02-24 16:04:52 +0000447
Mathieu Chartier6adeee12019-06-26 10:01:36 -0700448 if global.DisableGenerateProfile || ctx.Config().IsPdkBuild() || ctx.Config().UnbundledBuild() {
Nicolas Geoffray27c7cc62019-02-24 16:04:52 +0000449 return nil
450 }
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000451 profile := ctx.Config().Once(bootImageProfileRuleKey, func() interface{} {
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000452 defaultProfile := "frameworks/base/config/boot-image-profile.txt"
Colin Cross800fe132019-02-11 14:21:24 -0800453
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000454 rule := android.NewRuleBuilder()
455 rule.MissingDeps(missingDeps)
Colin Cross800fe132019-02-11 14:21:24 -0800456
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000457 var bootImageProfile android.Path
458 if len(global.BootImageProfiles) > 1 {
459 combinedBootImageProfile := image.dir.Join(ctx, "boot-image-profile.txt")
460 rule.Command().Text("cat").Inputs(global.BootImageProfiles).Text(">").Output(combinedBootImageProfile)
461 bootImageProfile = combinedBootImageProfile
462 } else if len(global.BootImageProfiles) == 1 {
463 bootImageProfile = global.BootImageProfiles[0]
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000464 } else if path := android.ExistentPathForSource(ctx, defaultProfile); path.Valid() {
465 bootImageProfile = path.Path()
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000466 } else {
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000467 // No profile (not even a default one, which is the case on some branches
468 // like master-art-host that don't have frameworks/base).
469 // Return nil and continue without profile.
470 return nil
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000471 }
Colin Cross800fe132019-02-11 14:21:24 -0800472
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000473 profile := image.dir.Join(ctx, "boot.prof")
Colin Cross800fe132019-02-11 14:21:24 -0800474
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000475 rule.Command().
476 Text(`ANDROID_LOG_TAGS="*:e"`).
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000477 Tool(globalSoong.Profman).
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000478 FlagWithInput("--create-profile-from=", bootImageProfile).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000479 FlagForEachInput("--apk=", image.dexPathsDeps.Paths()).
480 FlagForEachArg("--dex-location=", image.dexLocationsDeps).
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000481 FlagWithOutput("--reference-profile-file=", profile)
Colin Cross800fe132019-02-11 14:21:24 -0800482
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000483 rule.Install(profile, "/system/etc/boot-image.prof")
484
485 rule.Build(pctx, ctx, "bootJarsProfile", "profile boot jars")
486
487 image.profileInstalls = rule.Installs()
488
489 return profile
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000490 })
491 if profile == nil {
492 return nil // wrap nil into a typed pointer with value nil
493 }
494 return profile.(android.WritablePath)
Colin Cross800fe132019-02-11 14:21:24 -0800495}
496
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000497var bootImageProfileRuleKey = android.NewOnceKey("bootImageProfileRule")
498
David Srbeckyc177ebe2020-02-18 20:43:06 +0000499func bootFrameworkProfileRule(ctx android.SingletonContext, image *bootImageConfig, missingDeps []string) android.WritablePath {
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000500 globalSoong := dexpreopt.GetCachedGlobalSoongConfig(ctx)
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000501 global := dexpreopt.GetGlobalConfig(ctx)
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100502
503 if global.DisableGenerateProfile || ctx.Config().IsPdkBuild() || ctx.Config().UnbundledBuild() {
504 return nil
505 }
506 return ctx.Config().Once(bootFrameworkProfileRuleKey, func() interface{} {
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100507 rule := android.NewRuleBuilder()
508 rule.MissingDeps(missingDeps)
509
510 // Some branches like master-art-host don't have frameworks/base, so manually
511 // handle the case that the default is missing. Those branches won't attempt to build the profile rule,
512 // and if they do they'll get a missing deps error.
513 defaultProfile := "frameworks/base/config/boot-profile.txt"
514 path := android.ExistentPathForSource(ctx, defaultProfile)
515 var bootFrameworkProfile android.Path
516 if path.Valid() {
517 bootFrameworkProfile = path.Path()
518 } else {
519 missingDeps = append(missingDeps, defaultProfile)
520 bootFrameworkProfile = android.PathForOutput(ctx, "missing")
521 }
522
523 profile := image.dir.Join(ctx, "boot.bprof")
524
525 rule.Command().
526 Text(`ANDROID_LOG_TAGS="*:e"`).
Martin Stjernholm75a48d82020-01-10 20:32:59 +0000527 Tool(globalSoong.Profman).
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100528 Flag("--generate-boot-profile").
529 FlagWithInput("--create-profile-from=", bootFrameworkProfile).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000530 FlagForEachInput("--apk=", image.dexPathsDeps.Paths()).
531 FlagForEachArg("--dex-location=", image.dexLocationsDeps).
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100532 FlagWithOutput("--reference-profile-file=", profile)
533
534 rule.Install(profile, "/system/etc/boot-image.bprof")
535 rule.Build(pctx, ctx, "bootFrameworkProfile", "profile boot framework jars")
536 image.profileInstalls = append(image.profileInstalls, rule.Installs()...)
537
538 return profile
539 }).(android.WritablePath)
540}
541
542var bootFrameworkProfileRuleKey = android.NewOnceKey("bootFrameworkProfileRule")
543
David Srbeckyc177ebe2020-02-18 20:43:06 +0000544func dumpOatRules(ctx android.SingletonContext, image *bootImageConfig) {
Colin Crossc9a4c362019-02-26 21:13:48 -0800545 var allPhonies android.Paths
David Srbeckyc177ebe2020-02-18 20:43:06 +0000546 for _, image := range image.variants {
547 arch := image.target.Arch.ArchType
Colin Crossc9a4c362019-02-26 21:13:48 -0800548 // Create a rule to call oatdump.
549 output := android.PathForOutput(ctx, "boot."+arch.String()+".oatdump.txt")
550 rule := android.NewRuleBuilder()
551 rule.Command().
552 // TODO: for now, use the debug version for better error reporting
Colin Crossee94d6a2019-07-08 17:08:34 -0700553 BuiltTool(ctx, "oatdumpd").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000554 FlagWithInputList("--runtime-arg -Xbootclasspath:", image.dexPathsDeps.Paths(), ":").
555 FlagWithList("--runtime-arg -Xbootclasspath-locations:", image.dexLocationsDeps, ":").
David Srbeckyc177ebe2020-02-18 20:43:06 +0000556 FlagWithArg("--image=", strings.Join(image.imageLocations, ":")).Implicits(image.imagesDeps.Paths()).
Colin Crossc9a4c362019-02-26 21:13:48 -0800557 FlagWithOutput("--output=", output).
558 FlagWithArg("--instruction-set=", arch.String())
559 rule.Build(pctx, ctx, "dump-oat-boot-"+arch.String(), "dump oat boot "+arch.String())
560
561 // Create a phony rule that depends on the output file and prints the path.
562 phony := android.PathForPhony(ctx, "dump-oat-boot-"+arch.String())
563 rule = android.NewRuleBuilder()
564 rule.Command().
565 Implicit(output).
566 ImplicitOutput(phony).
567 Text("echo").FlagWithArg("Output in ", output.String())
568 rule.Build(pctx, ctx, "phony-dump-oat-boot-"+arch.String(), "dump oat boot "+arch.String())
569
570 allPhonies = append(allPhonies, phony)
571 }
572
573 phony := android.PathForPhony(ctx, "dump-oat-boot")
574 ctx.Build(pctx, android.BuildParams{
575 Rule: android.Phony,
576 Output: phony,
577 Inputs: allPhonies,
578 Description: "dump-oat-boot",
579 })
580
581}
582
Colin Cross2d00f0d2019-05-09 21:50:00 -0700583func writeGlobalConfigForMake(ctx android.SingletonContext, path android.WritablePath) {
Martin Stjernholm40f9f3c2020-01-20 18:12:23 +0000584 data := dexpreopt.GetGlobalConfigRawData(ctx)
Colin Cross2d00f0d2019-05-09 21:50:00 -0700585
586 ctx.Build(pctx, android.BuildParams{
587 Rule: android.WriteFile,
588 Output: path,
589 Args: map[string]string{
590 "content": string(data),
591 },
592 })
593}
594
Colin Cross44df5812019-02-15 23:06:46 -0800595// Export paths for default boot image to Make
596func (d *dexpreoptBootJars) MakeVars(ctx android.MakeVarsContext) {
Colin Cross2d00f0d2019-05-09 21:50:00 -0700597 if d.dexpreoptConfigForMake != nil {
598 ctx.Strict("DEX_PREOPT_CONFIG_FOR_MAKE", d.dexpreoptConfigForMake.String())
Martin Stjernholmc52aaf12020-01-06 23:11:37 +0000599 ctx.Strict("DEX_PREOPT_SOONG_CONFIG_FOR_MAKE", android.PathForOutput(ctx, "dexpreopt_soong.config").String())
Colin Cross2d00f0d2019-05-09 21:50:00 -0700600 }
601
Colin Cross44df5812019-02-15 23:06:46 -0800602 image := d.defaultBootImage
603 if image != nil {
Colin Cross44df5812019-02-15 23:06:46 -0800604 ctx.Strict("DEXPREOPT_IMAGE_PROFILE_BUILT_INSTALLED", image.profileInstalls.String())
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000605 ctx.Strict("DEXPREOPT_BOOTCLASSPATH_DEX_FILES", strings.Join(image.dexPathsDeps.Strings(), " "))
606 ctx.Strict("DEXPREOPT_BOOTCLASSPATH_DEX_LOCATIONS", strings.Join(image.dexLocationsDeps, " "))
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000607
608 var imageNames []string
609 for _, current := range append(d.otherImages, image) {
610 imageNames = append(imageNames, current.name)
David Srbeckyc177ebe2020-02-18 20:43:06 +0000611 for _, current := range current.variants {
612 sfx := current.name + "_" + current.target.Arch.ArchType.String()
613 ctx.Strict("DEXPREOPT_IMAGE_VDEX_BUILT_INSTALLED_"+sfx, current.vdexInstalls.String())
614 ctx.Strict("DEXPREOPT_IMAGE_"+sfx, current.images.String())
615 ctx.Strict("DEXPREOPT_IMAGE_DEPS_"+sfx, strings.Join(current.imagesDeps.Strings(), " "))
616 ctx.Strict("DEXPREOPT_IMAGE_BUILT_INSTALLED_"+sfx, current.installs.String())
617 ctx.Strict("DEXPREOPT_IMAGE_UNSTRIPPED_BUILT_INSTALLED_"+sfx, current.unstrippedInstalls.String())
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000618 }
Colin Cross31bf00d2019-12-04 13:16:01 -0800619
Ulya Trafimovich3391a1e2020-01-03 17:33:17 +0000620 ctx.Strict("DEXPREOPT_IMAGE_LOCATIONS_"+current.name, strings.Join(current.imageLocations, ":"))
Colin Cross31bf00d2019-12-04 13:16:01 -0800621 ctx.Strict("DEXPREOPT_IMAGE_ZIP_"+current.name, current.zip.String())
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000622 }
623 ctx.Strict("DEXPREOPT_IMAGE_NAMES", strings.Join(imageNames, " "))
Colin Cross800fe132019-02-11 14:21:24 -0800624 }
Colin Cross800fe132019-02-11 14:21:24 -0800625}