blob: 5714531024fd86fe093ab9a43578d52ee052bbe2 [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"
Colin Crossc9a4c362019-02-26 21:13:48 -080019 "sort"
Colin Cross800fe132019-02-11 14:21:24 -080020 "strings"
21
22 "android/soong/android"
23 "android/soong/dexpreopt"
24
Colin Cross800fe132019-02-11 14:21:24 -080025 "github.com/google/blueprint/proptools"
26)
27
28func init() {
29 android.RegisterSingletonType("dex_bootjars", dexpreoptBootJarsFactory)
30}
31
32// The image "location" is a symbolic path that with multiarchitecture
33// support doesn't really exist on the device. Typically it is
34// /system/framework/boot.art and should be the same for all supported
35// architectures on the device. The concrete architecture specific
36// content actually ends up in a "filename" that contains an
37// architecture specific directory name such as arm, arm64, mips,
38// mips64, x86, x86_64.
39//
40// Here are some example values for an x86_64 / x86 configuration:
41//
42// bootImages["x86_64"] = "out/soong/generic_x86_64/dex_bootjars/system/framework/x86_64/boot.art"
43// dexpreopt.PathToLocation(bootImages["x86_64"], "x86_64") = "out/soong/generic_x86_64/dex_bootjars/system/framework/boot.art"
44//
45// bootImages["x86"] = "out/soong/generic_x86_64/dex_bootjars/system/framework/x86/boot.art"
46// dexpreopt.PathToLocation(bootImages["x86"])= "out/soong/generic_x86_64/dex_bootjars/system/framework/boot.art"
47//
48// The location is passed as an argument to the ART tools like dex2oat instead of the real path. The ART tools
49// will then reconstruct the real path, so the rules must have a dependency on the real path.
50
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
70 // Targets for which the image is generated.
71 targets []android.Target
72
73 // The names of jars that constitute this image.
74 modules []string
75
76 // The "locations" of jars.
77 dexLocations []string // for this image
78 dexLocationsDeps []string // for the dependency images and in this image
79
80 // File paths to jars.
81 dexPaths android.WritablePaths // for this image
82 dexPathsDeps android.WritablePaths // for the dependency images and in this image
83
84 // The "locations" of the dependency images and in this image.
85 imageLocations []string
86
87 // Paths to image files (grouped by target).
88 images map[android.ArchType]android.OutputPath // first image file
89 imagesDeps map[android.ArchType]android.OutputPaths // all files
90
91 // File path to a zip archive with all image files (or nil, if not needed).
92 zip android.WritablePath
Colin Cross800fe132019-02-11 14:21:24 -080093}
94
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000095func (image bootImageConfig) moduleName(idx int) string {
96 // Dexpreopt on the boot class path produces multiple files. The first dex file
97 // is converted into 'name'.art (to match the legacy assumption that 'name'.art
Dan Willemsen0f416782019-06-13 21:44:53 +000098 // exists), and the rest are converted to 'name'-<jar>.art.
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +000099 m := image.modules[idx]
100 name := image.stem
101 if idx != 0 || image.extension {
102 name += "-" + stemOf(m)
103 }
104 return name
105}
Dan Willemsen0f416782019-06-13 21:44:53 +0000106
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000107func (image bootImageConfig) firstModuleNameOrStem() string {
108 if len(image.modules) > 0 {
109 return image.moduleName(0)
110 } else {
111 return image.stem
112 }
113}
114
115func (image bootImageConfig) moduleFiles(ctx android.PathContext, dir android.OutputPath, exts ...string) android.OutputPaths {
116 ret := make(android.OutputPaths, 0, len(image.modules)*len(exts))
117 for i := range image.modules {
118 name := image.moduleName(i)
Dan Willemsen0f416782019-06-13 21:44:53 +0000119 for _, ext := range exts {
120 ret = append(ret, dir.Join(ctx, name+ext))
121 }
122 }
Dan Willemsen0f416782019-06-13 21:44:53 +0000123 return ret
124}
125
Colin Cross44df5812019-02-15 23:06:46 -0800126type bootImage struct {
127 bootImageConfig
Colin Cross800fe132019-02-11 14:21:24 -0800128
Colin Cross44df5812019-02-15 23:06:46 -0800129 installs map[android.ArchType]android.RuleBuilderInstalls
130 vdexInstalls map[android.ArchType]android.RuleBuilderInstalls
131 unstrippedInstalls map[android.ArchType]android.RuleBuilderInstalls
Colin Cross800fe132019-02-11 14:21:24 -0800132
Colin Cross44df5812019-02-15 23:06:46 -0800133 profileInstalls android.RuleBuilderInstalls
134}
Colin Cross800fe132019-02-11 14:21:24 -0800135
Colin Cross44df5812019-02-15 23:06:46 -0800136func newBootImage(ctx android.PathContext, config bootImageConfig) *bootImage {
137 image := &bootImage{
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000138 bootImageConfig: config,
Colin Cross800fe132019-02-11 14:21:24 -0800139
Colin Cross44df5812019-02-15 23:06:46 -0800140 installs: make(map[android.ArchType]android.RuleBuilderInstalls),
141 vdexInstalls: make(map[android.ArchType]android.RuleBuilderInstalls),
142 unstrippedInstalls: make(map[android.ArchType]android.RuleBuilderInstalls),
143 }
Colin Cross800fe132019-02-11 14:21:24 -0800144
Colin Cross44df5812019-02-15 23:06:46 -0800145 return image
Colin Cross800fe132019-02-11 14:21:24 -0800146}
147
148func concat(lists ...[]string) []string {
149 var size int
150 for _, l := range lists {
151 size += len(l)
152 }
153 ret := make([]string, 0, size)
154 for _, l := range lists {
155 ret = append(ret, l...)
156 }
157 return ret
158}
159
Colin Cross800fe132019-02-11 14:21:24 -0800160func dexpreoptBootJarsFactory() android.Singleton {
Colin Cross44df5812019-02-15 23:06:46 -0800161 return &dexpreoptBootJars{}
Colin Cross800fe132019-02-11 14:21:24 -0800162}
163
164func skipDexpreoptBootJars(ctx android.PathContext) bool {
Ulya Trafimovichacb33e02019-11-01 17:57:29 +0000165 if dexpreoptGlobalConfig(ctx).DisablePreopt {
166 return true
167 }
168
Colin Cross800fe132019-02-11 14:21:24 -0800169 if ctx.Config().UnbundledBuild() {
170 return true
171 }
172
173 if len(ctx.Config().Targets[android.Android]) == 0 {
174 // Host-only build
175 return true
176 }
177
178 return false
179}
180
Ulyana Trafimovich3fae7662019-12-11 10:31:32 +0000181func skipDexpreoptArtBootJars(ctx android.BuilderContext) bool {
182 // with EMMA_INSTRUMENT_FRAMEWORK=true ART boot class path libraries have dependencies on framework,
183 // therefore dexpreopt ART libraries cannot be dexpreopted in isolation => no ART boot image
184 return ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK")
185}
186
Colin Cross44df5812019-02-15 23:06:46 -0800187type dexpreoptBootJars struct {
188 defaultBootImage *bootImage
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000189 otherImages []*bootImage
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 {
Ulyana Trafimovich3fae7662019-12-11 10:31:32 +0000196 if skipDexpreoptBootJars(ctx) || skipDexpreoptArtBootJars(ctx) {
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000197 return nil
198 }
199 return artBootImageConfig(ctx).imagesDeps
200}
201
Colin Cross800fe132019-02-11 14:21:24 -0800202// dexpreoptBoot singleton rules
Colin Cross44df5812019-02-15 23:06:46 -0800203func (d *dexpreoptBootJars) GenerateBuildActions(ctx android.SingletonContext) {
Colin Cross800fe132019-02-11 14:21:24 -0800204 if skipDexpreoptBootJars(ctx) {
205 return
206 }
207
Colin Cross2d00f0d2019-05-09 21:50:00 -0700208 d.dexpreoptConfigForMake = android.PathForOutput(ctx, ctx.Config().DeviceName(), "dexpreopt.config")
209 writeGlobalConfigForMake(ctx, d.dexpreoptConfigForMake)
210
Colin Cross44df5812019-02-15 23:06:46 -0800211 global := dexpreoptGlobalConfig(ctx)
Colin Cross800fe132019-02-11 14:21:24 -0800212
213 // Skip recompiling the boot image for the second sanitization phase. We'll get separate paths
214 // and invalidate first-stage artifacts which are crucial to SANITIZE_LITE builds.
215 // Note: this is technically incorrect. Compiled code contains stack checks which may depend
216 // on ASAN settings.
217 if len(ctx.Config().SanitizeDevice()) == 1 &&
218 ctx.Config().SanitizeDevice()[0] == "address" &&
Colin Cross44df5812019-02-15 23:06:46 -0800219 global.SanitizeLite {
Colin Cross800fe132019-02-11 14:21:24 -0800220 return
221 }
222
Ulya Trafimovich48b3b3c2019-12-13 13:34:06 +0000223 // Default boot image is either the framework one, or the JIT-zygote one.
224 // The boot image that is created first is used to get a unique profile rule for all images.
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000225 if global.GenerateApexImage {
Ulya Trafimovich48b3b3c2019-12-13 13:34:06 +0000226 d.defaultBootImage = buildBootImage(ctx, apexBootImageConfig(ctx))
227 d.otherImages = append(d.otherImages, buildBootImage(ctx, frameworkBootImageConfig(ctx)))
228 } else {
229 d.defaultBootImage = buildBootImage(ctx, frameworkBootImageConfig(ctx))
230 }
231
232 // Create the ART boot image.
233 if !skipDexpreoptArtBootJars(ctx) {
234 d.otherImages = append(d.otherImages, buildBootImage(ctx, artBootImageConfig(ctx)))
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000235 }
Colin Crossc9a4c362019-02-26 21:13:48 -0800236
237 dumpOatRules(ctx, d.defaultBootImage)
Colin Cross44df5812019-02-15 23:06:46 -0800238}
239
240// buildBootImage takes a bootImageConfig, creates rules to build it, and returns a *bootImage.
241func buildBootImage(ctx android.SingletonContext, config bootImageConfig) *bootImage {
Colin Cross44df5812019-02-15 23:06:46 -0800242 image := newBootImage(ctx, config)
243
244 bootDexJars := make(android.Paths, len(image.modules))
Colin Cross800fe132019-02-11 14:21:24 -0800245 ctx.VisitAllModules(func(module android.Module) {
246 // Collect dex jar paths for the modules listed above.
Colin Cross42be7612019-02-21 18:12:14 -0800247 if j, ok := module.(interface{ DexJar() android.Path }); ok {
Colin Cross800fe132019-02-11 14:21:24 -0800248 name := ctx.ModuleName(module)
Colin Cross44df5812019-02-15 23:06:46 -0800249 if i := android.IndexList(name, image.modules); i != -1 {
Colin Cross800fe132019-02-11 14:21:24 -0800250 bootDexJars[i] = j.DexJar()
251 }
252 }
253 })
254
255 var missingDeps []string
256 // Ensure all modules were converted to paths
257 for i := range bootDexJars {
258 if bootDexJars[i] == nil {
259 if ctx.Config().AllowMissingDependencies() {
Colin Cross44df5812019-02-15 23:06:46 -0800260 missingDeps = append(missingDeps, image.modules[i])
Colin Cross800fe132019-02-11 14:21:24 -0800261 bootDexJars[i] = android.PathForOutput(ctx, "missing")
262 } else {
263 ctx.Errorf("failed to find dex jar path for module %q",
Colin Cross44df5812019-02-15 23:06:46 -0800264 image.modules[i])
Colin Cross800fe132019-02-11 14:21:24 -0800265 }
266 }
267 }
268
269 // The path to bootclasspath dex files needs to be known at module GenerateAndroidBuildAction time, before
270 // the bootclasspath modules have been compiled. Copy the dex jars there so the module rules that have
271 // already been set up can find them.
272 for i := range bootDexJars {
273 ctx.Build(pctx, android.BuildParams{
274 Rule: android.Cp,
275 Input: bootDexJars[i],
Colin Cross44df5812019-02-15 23:06:46 -0800276 Output: image.dexPaths[i],
Colin Cross800fe132019-02-11 14:21:24 -0800277 })
278 }
279
Colin Cross44df5812019-02-15 23:06:46 -0800280 profile := bootImageProfileRule(ctx, image, missingDeps)
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100281 bootFrameworkProfileRule(ctx, image, missingDeps)
Colin Cross800fe132019-02-11 14:21:24 -0800282
Colin Crossdf8eebe2019-04-09 15:29:41 -0700283 var allFiles android.Paths
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000284 for _, target := range image.targets {
285 files := buildBootImageRuleForArch(ctx, image, target.Arch.ArchType, profile, missingDeps)
286 allFiles = append(allFiles, files.Paths()...)
Colin Cross800fe132019-02-11 14:21:24 -0800287 }
Colin Cross44df5812019-02-15 23:06:46 -0800288
Colin Crossdf8eebe2019-04-09 15:29:41 -0700289 if image.zip != nil {
290 rule := android.NewRuleBuilder()
291 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -0700292 BuiltTool(ctx, "soong_zip").
Colin Crossdf8eebe2019-04-09 15:29:41 -0700293 FlagWithOutput("-o ", image.zip).
294 FlagWithArg("-C ", image.dir.String()).
295 FlagWithInputList("-f ", allFiles, " -f ")
296
297 rule.Build(pctx, ctx, "zip_"+image.name, "zip "+image.name+" image")
298 }
299
Colin Cross44df5812019-02-15 23:06:46 -0800300 return image
Colin Cross800fe132019-02-11 14:21:24 -0800301}
302
Colin Cross44df5812019-02-15 23:06:46 -0800303func buildBootImageRuleForArch(ctx android.SingletonContext, image *bootImage,
Colin Crossdf8eebe2019-04-09 15:29:41 -0700304 arch android.ArchType, profile android.Path, missingDeps []string) android.WritablePaths {
Colin Cross800fe132019-02-11 14:21:24 -0800305
Colin Cross44df5812019-02-15 23:06:46 -0800306 global := dexpreoptGlobalConfig(ctx)
307
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
Colin Cross44df5812019-02-15 23:06:46 -0800341 cmd.Tool(global.Tools.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 {
357 artImage := artBootImageConfig(ctx).images[arch]
358 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").
382 Flag("--abort-on-hard-verifier-error")
383
Colin Cross44df5812019-02-15 23:06:46 -0800384 if global.BootFlags != "" {
385 cmd.Flag(global.BootFlags)
Colin Cross800fe132019-02-11 14:21:24 -0800386 }
387
388 if extraFlags != "" {
389 cmd.Flag(extraFlags)
390 }
391
Colin Cross0b9f31f2019-02-28 11:00:01 -0800392 cmd.Textf(`|| ( echo %s ; false )`, proptools.ShellEscape(failureMessage))
Colin Cross800fe132019-02-11 14:21:24 -0800393
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000394 installDir := filepath.Join("/", image.installSubdir, arch.String())
395 vdexInstallDir := filepath.Join("/", image.installSubdir)
Colin Cross800fe132019-02-11 14:21:24 -0800396
Colin Cross800fe132019-02-11 14:21:24 -0800397 var vdexInstalls android.RuleBuilderInstalls
398 var unstrippedInstalls android.RuleBuilderInstalls
399
Colin Crossdf8eebe2019-04-09 15:29:41 -0700400 var zipFiles android.WritablePaths
401
Dan Willemsen0f416782019-06-13 21:44:53 +0000402 for _, artOrOat := range image.moduleFiles(ctx, outputDir, ".art", ".oat") {
403 cmd.ImplicitOutput(artOrOat)
404 zipFiles = append(zipFiles, artOrOat)
Colin Cross800fe132019-02-11 14:21:24 -0800405
Dan Willemsen0f416782019-06-13 21:44:53 +0000406 // Install the .oat and .art files
407 rule.Install(artOrOat, filepath.Join(installDir, artOrOat.Base()))
408 }
Colin Cross800fe132019-02-11 14:21:24 -0800409
Dan Willemsen0f416782019-06-13 21:44:53 +0000410 for _, vdex := range image.moduleFiles(ctx, outputDir, ".vdex") {
411 cmd.ImplicitOutput(vdex)
412 zipFiles = append(zipFiles, vdex)
Colin Cross800fe132019-02-11 14:21:24 -0800413
414 // The vdex files are identical between architectures, install them to a shared location. The Make rules will
415 // only use the install rules for one architecture, and will create symlinks into the architecture-specific
416 // directories.
417 vdexInstalls = append(vdexInstalls,
Colin Cross69f59a32019-02-15 10:39:37 -0800418 android.RuleBuilderInstall{vdex, filepath.Join(vdexInstallDir, vdex.Base())})
Dan Willemsen0f416782019-06-13 21:44:53 +0000419 }
420
421 for _, unstrippedOat := range image.moduleFiles(ctx, symbolsDir, ".oat") {
422 cmd.ImplicitOutput(unstrippedOat)
Colin Cross800fe132019-02-11 14:21:24 -0800423
424 // Install the unstripped oat files. The Make rules will put these in $(TARGET_OUT_UNSTRIPPED)
425 unstrippedInstalls = append(unstrippedInstalls,
Colin Cross69f59a32019-02-15 10:39:37 -0800426 android.RuleBuilderInstall{unstrippedOat, filepath.Join(installDir, unstrippedOat.Base())})
Colin Cross800fe132019-02-11 14:21:24 -0800427 }
428
Colin Cross44df5812019-02-15 23:06:46 -0800429 rule.Build(pctx, ctx, image.name+"JarsDexpreopt_"+arch.String(), "dexpreopt "+image.name+" jars "+arch.String())
Colin Cross800fe132019-02-11 14:21:24 -0800430
431 // save output and installed files for makevars
Colin Cross44df5812019-02-15 23:06:46 -0800432 image.installs[arch] = rule.Installs()
433 image.vdexInstalls[arch] = vdexInstalls
434 image.unstrippedInstalls[arch] = unstrippedInstalls
Colin Crossdf8eebe2019-04-09 15:29:41 -0700435
436 return zipFiles
Colin Cross800fe132019-02-11 14:21:24 -0800437}
438
439const failureMessage = `ERROR: Dex2oat failed to compile a boot image.
440It is likely that the boot classpath is inconsistent.
441Rebuild with ART_BOOT_IMAGE_EXTRA_ARGS="--runtime-arg -verbose:verifier" to see verification errors.`
442
Colin Cross44df5812019-02-15 23:06:46 -0800443func bootImageProfileRule(ctx android.SingletonContext, image *bootImage, missingDeps []string) android.WritablePath {
Nicolas Geoffray27c7cc62019-02-24 16:04:52 +0000444 global := dexpreoptGlobalConfig(ctx)
445
Mathieu Chartier6adeee12019-06-26 10:01:36 -0700446 if global.DisableGenerateProfile || ctx.Config().IsPdkBuild() || ctx.Config().UnbundledBuild() {
Nicolas Geoffray27c7cc62019-02-24 16:04:52 +0000447 return nil
448 }
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000449 profile := ctx.Config().Once(bootImageProfileRuleKey, func() interface{} {
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000450 tools := global.Tools
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000451 defaultProfile := "frameworks/base/config/boot-image-profile.txt"
Colin Cross800fe132019-02-11 14:21:24 -0800452
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000453 rule := android.NewRuleBuilder()
454 rule.MissingDeps(missingDeps)
Colin Cross800fe132019-02-11 14:21:24 -0800455
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000456 var bootImageProfile android.Path
457 if len(global.BootImageProfiles) > 1 {
458 combinedBootImageProfile := image.dir.Join(ctx, "boot-image-profile.txt")
459 rule.Command().Text("cat").Inputs(global.BootImageProfiles).Text(">").Output(combinedBootImageProfile)
460 bootImageProfile = combinedBootImageProfile
461 } else if len(global.BootImageProfiles) == 1 {
462 bootImageProfile = global.BootImageProfiles[0]
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000463 } else if path := android.ExistentPathForSource(ctx, defaultProfile); path.Valid() {
464 bootImageProfile = path.Path()
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000465 } else {
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000466 // No profile (not even a default one, which is the case on some branches
467 // like master-art-host that don't have frameworks/base).
468 // Return nil and continue without profile.
469 return nil
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000470 }
Colin Cross800fe132019-02-11 14:21:24 -0800471
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000472 profile := image.dir.Join(ctx, "boot.prof")
Colin Cross800fe132019-02-11 14:21:24 -0800473
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000474 rule.Command().
475 Text(`ANDROID_LOG_TAGS="*:e"`).
476 Tool(tools.Profman).
477 FlagWithInput("--create-profile-from=", bootImageProfile).
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000478 FlagForEachInput("--apk=", image.dexPathsDeps.Paths()).
479 FlagForEachArg("--dex-location=", image.dexLocationsDeps).
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000480 FlagWithOutput("--reference-profile-file=", profile)
Colin Cross800fe132019-02-11 14:21:24 -0800481
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000482 rule.Install(profile, "/system/etc/boot-image.prof")
483
484 rule.Build(pctx, ctx, "bootJarsProfile", "profile boot jars")
485
486 image.profileInstalls = rule.Installs()
487
488 return profile
Ulyana Trafimovichde534412019-11-08 10:51:01 +0000489 })
490 if profile == nil {
491 return nil // wrap nil into a typed pointer with value nil
492 }
493 return profile.(android.WritablePath)
Colin Cross800fe132019-02-11 14:21:24 -0800494}
495
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000496var bootImageProfileRuleKey = android.NewOnceKey("bootImageProfileRule")
497
Nicolas Geoffraye7102422019-07-24 13:19:29 +0100498func bootFrameworkProfileRule(ctx android.SingletonContext, image *bootImage, missingDeps []string) android.WritablePath {
499 global := dexpreoptGlobalConfig(ctx)
500
501 if global.DisableGenerateProfile || ctx.Config().IsPdkBuild() || ctx.Config().UnbundledBuild() {
502 return nil
503 }
504 return ctx.Config().Once(bootFrameworkProfileRuleKey, func() interface{} {
505 tools := global.Tools
506
507 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"`).
527 Tool(tools.Profman).
528 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
Colin Crossc9a4c362019-02-26 21:13:48 -0800544func dumpOatRules(ctx android.SingletonContext, image *bootImage) {
545 var archs []android.ArchType
546 for arch := range image.images {
547 archs = append(archs, arch)
548 }
549 sort.Slice(archs, func(i, j int) bool { return archs[i].String() < archs[j].String() })
550
551 var allPhonies android.Paths
552 for _, arch := range archs {
553 // Create a rule to call oatdump.
554 output := android.PathForOutput(ctx, "boot."+arch.String()+".oatdump.txt")
555 rule := android.NewRuleBuilder()
556 rule.Command().
557 // TODO: for now, use the debug version for better error reporting
Colin Crossee94d6a2019-07-08 17:08:34 -0700558 BuiltTool(ctx, "oatdumpd").
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000559 FlagWithInputList("--runtime-arg -Xbootclasspath:", image.dexPathsDeps.Paths(), ":").
560 FlagWithList("--runtime-arg -Xbootclasspath-locations:", image.dexLocationsDeps, ":").
Ulya Trafimovich163664a2019-12-06 13:42:21 +0000561 FlagWithArg("--image=", strings.Join(image.imageLocations, ":")).Implicits(image.imagesDeps[arch].Paths()).
Colin Crossc9a4c362019-02-26 21:13:48 -0800562 FlagWithOutput("--output=", output).
563 FlagWithArg("--instruction-set=", arch.String())
564 rule.Build(pctx, ctx, "dump-oat-boot-"+arch.String(), "dump oat boot "+arch.String())
565
566 // Create a phony rule that depends on the output file and prints the path.
567 phony := android.PathForPhony(ctx, "dump-oat-boot-"+arch.String())
568 rule = android.NewRuleBuilder()
569 rule.Command().
570 Implicit(output).
571 ImplicitOutput(phony).
572 Text("echo").FlagWithArg("Output in ", output.String())
573 rule.Build(pctx, ctx, "phony-dump-oat-boot-"+arch.String(), "dump oat boot "+arch.String())
574
575 allPhonies = append(allPhonies, phony)
576 }
577
578 phony := android.PathForPhony(ctx, "dump-oat-boot")
579 ctx.Build(pctx, android.BuildParams{
580 Rule: android.Phony,
581 Output: phony,
582 Inputs: allPhonies,
583 Description: "dump-oat-boot",
584 })
585
586}
587
Colin Cross2d00f0d2019-05-09 21:50:00 -0700588func writeGlobalConfigForMake(ctx android.SingletonContext, path android.WritablePath) {
589 data := dexpreoptGlobalConfigRaw(ctx).data
590
591 ctx.Build(pctx, android.BuildParams{
592 Rule: android.WriteFile,
593 Output: path,
594 Args: map[string]string{
595 "content": string(data),
596 },
597 })
598}
599
Colin Cross44df5812019-02-15 23:06:46 -0800600// Export paths for default boot image to Make
601func (d *dexpreoptBootJars) MakeVars(ctx android.MakeVarsContext) {
Colin Cross2d00f0d2019-05-09 21:50:00 -0700602 if d.dexpreoptConfigForMake != nil {
603 ctx.Strict("DEX_PREOPT_CONFIG_FOR_MAKE", d.dexpreoptConfigForMake.String())
604 }
605
Colin Cross44df5812019-02-15 23:06:46 -0800606 image := d.defaultBootImage
607 if image != nil {
Colin Cross44df5812019-02-15 23:06:46 -0800608 ctx.Strict("DEXPREOPT_IMAGE_PROFILE_BUILT_INSTALLED", image.profileInstalls.String())
Ulya Trafimovich4d2eeed2019-11-08 10:54:21 +0000609 ctx.Strict("DEXPREOPT_BOOTCLASSPATH_DEX_FILES", strings.Join(image.dexPathsDeps.Strings(), " "))
610 ctx.Strict("DEXPREOPT_BOOTCLASSPATH_DEX_LOCATIONS", strings.Join(image.dexLocationsDeps, " "))
611 ctx.Strict("DEXPREOPT_IMAGE_LOCATIONS", strings.Join(image.imageLocations, ":"))
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000612
613 var imageNames []string
614 for _, current := range append(d.otherImages, image) {
615 imageNames = append(imageNames, current.name)
Colin Cross91268c62019-04-11 14:07:04 -0700616 var arches []android.ArchType
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000617 for arch, _ := range current.images {
Colin Cross91268c62019-04-11 14:07:04 -0700618 arches = append(arches, arch)
619 }
620
621 sort.Slice(arches, func(i, j int) bool { return arches[i].String() < arches[j].String() })
622
623 for _, arch := range arches {
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000624 ctx.Strict("DEXPREOPT_IMAGE_VDEX_BUILT_INSTALLED_"+current.name+"_"+arch.String(), current.vdexInstalls[arch].String())
625 ctx.Strict("DEXPREOPT_IMAGE_"+current.name+"_"+arch.String(), current.images[arch].String())
Dan Willemsen0f416782019-06-13 21:44:53 +0000626 ctx.Strict("DEXPREOPT_IMAGE_DEPS_"+current.name+"_"+arch.String(), strings.Join(current.imagesDeps[arch].Strings(), " "))
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000627 ctx.Strict("DEXPREOPT_IMAGE_BUILT_INSTALLED_"+current.name+"_"+arch.String(), current.installs[arch].String())
628 ctx.Strict("DEXPREOPT_IMAGE_UNSTRIPPED_BUILT_INSTALLED_"+current.name+"_"+arch.String(), current.unstrippedInstalls[arch].String())
Colin Crossdf8eebe2019-04-09 15:29:41 -0700629 if current.zip != nil {
630 }
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000631 }
Colin Cross31bf00d2019-12-04 13:16:01 -0800632
633 ctx.Strict("DEXPREOPT_IMAGE_ZIP_"+current.name, current.zip.String())
Nicolas Geoffray72892f12019-02-22 15:34:40 +0000634 }
635 ctx.Strict("DEXPREOPT_IMAGE_NAMES", strings.Join(imageNames, " "))
Colin Cross800fe132019-02-11 14:21:24 -0800636 }
Colin Cross800fe132019-02-11 14:21:24 -0800637}