blob: faf51a36aade82aa823b534b1c5bec63db333b78 [file] [log] [blame]
Colin Crossf0056cb2017-12-22 15:56:08 -08001// Copyright 2017 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 (
Jiyong Park54105c42021-03-31 18:17:53 +090018 "strconv"
Colin Crossf0056cb2017-12-22 15:56:08 -080019 "strings"
20
21 "github.com/google/blueprint"
David Srbeckye033cba2020-05-20 22:20:28 +010022 "github.com/google/blueprint/proptools"
Colin Crossf0056cb2017-12-22 15:56:08 -080023
24 "android/soong/android"
Ramy Medhat1dcc27e2020-04-21 21:36:23 -040025 "android/soong/remoteexec"
Colin Crossf0056cb2017-12-22 15:56:08 -080026)
27
Liz Kammera7a64f32020-07-09 15:16:41 -070028type DexProperties struct {
29 // If set to true, compile dex regardless of installable. Defaults to false.
30 Compile_dex *bool
31
32 // list of module-specific flags that will be used for dex compiles
33 Dxflags []string `android:"arch_variant"`
34
Colin Cross5ea963e2021-09-16 19:13:43 -070035 // A list of files containing rules that specify the classes to keep in the main dex file.
36 Main_dex_rules []string `android:"path"`
37
Liz Kammera7a64f32020-07-09 15:16:41 -070038 Optimize struct {
Jared Duke63a3da92022-06-02 19:11:14 +000039 // If false, disable all optimization. Defaults to true for android_app and
40 // android_test_helper_app modules, false for android_test, java_library, and java_test modules.
Liz Kammera7a64f32020-07-09 15:16:41 -070041 Enabled *bool
42 // True if the module containing this has it set by default.
43 EnabledByDefault bool `blueprint:"mutated"`
44
Ajinkya Chalkeddad41b2023-02-09 14:09:58 +000045 // Whether to continue building even if warnings are emitted. Defaults to true.
Remi NGUYEN VANbdad3142022-08-04 13:19:03 +090046 Ignore_warnings *bool
47
Jared Dukeaa88b3d2023-08-29 17:07:20 +000048 // If true, runs R8 in Proguard compatibility mode, otherwise runs R8 in full mode.
49 // Defaults to false for apps, true for libraries and tests.
Christoffer Quist Adamsenf2d7b162020-08-24 15:56:16 +020050 Proguard_compatibility *bool
51
Liz Kammera7a64f32020-07-09 15:16:41 -070052 // If true, optimize for size by removing unused code. Defaults to true for apps,
53 // false for libraries and tests.
54 Shrink *bool
55
56 // If true, optimize bytecode. Defaults to false.
57 Optimize *bool
58
59 // If true, obfuscate bytecode. Defaults to false.
60 Obfuscate *bool
61
62 // If true, do not use the flag files generated by aapt that automatically keep
63 // classes referenced by the app manifest. Defaults to false.
64 No_aapt_flags *bool
65
Jared Duke51b0a102022-09-27 16:53:11 -070066 // If true, optimize for size by removing unused resources. Defaults to false.
Rico Wind351bac92022-09-22 10:41:42 +020067 Shrink_resources *bool
68
Rico Winda2fa2632024-03-13 13:09:17 +010069 // If true, use optimized resource shrinking in R8, overriding the
70 // Shrink_resources setting. Defaults to false.
71 // Optimized shrinking means that R8 will trace and treeshake resources together with code
72 // and apply additional optimizations. This implies non final fields in the R classes.
73 Optimized_shrink_resources *bool
74
Liz Kammera7a64f32020-07-09 15:16:41 -070075 // Flags to pass to proguard.
76 Proguard_flags []string
77
78 // Specifies the locations of files containing proguard flags.
79 Proguard_flags_files []string `android:"path"`
Sam Delmerico95d70942023-08-02 18:00:35 -040080
81 // If true, transitive reverse dependencies of this module will have this
82 // module's proguard spec appended to their optimization action
83 Export_proguard_flags_files *bool
Liz Kammera7a64f32020-07-09 15:16:41 -070084 }
85
86 // Keep the data uncompressed. We always need uncompressed dex for execution,
87 // so this might actually save space by avoiding storing the same data twice.
88 // This defaults to reasonable value based on module and should not be set.
89 // It exists only to support ART tests.
90 Uncompress_dex *bool
Wei Li1e73c652021-12-06 13:35:11 -080091
Wei Li92cd54b2022-01-12 13:22:55 -080092 // Exclude kotlinc generate files: *.kotlin_module, *.kotlin_builtins. Defaults to false.
Wei Li1e73c652021-12-06 13:35:11 -080093 Exclude_kotlinc_generated_files *bool
Ulya Trafimovichc8160582024-07-10 08:32:45 +010094
95 // Disable dex container (also known as "multi-dex").
96 // This may be necessary as a temporary workaround to mask toolchain bugs (see b/341652226).
97 No_dex_container *bool
Liz Kammera7a64f32020-07-09 15:16:41 -070098}
99
100type dexer struct {
101 dexProperties DexProperties
102
103 // list of extra proguard flag files
Colin Cross312634e2023-11-21 15:13:56 -0800104 extraProguardFlagsFiles android.Paths
105 proguardDictionary android.OptionalPath
106 proguardConfiguration android.OptionalPath
107 proguardUsageZip android.OptionalPath
108 resourcesInput android.OptionalPath
109 resourcesOutput android.OptionalPath
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500110
Colin Cross9ffaf282024-08-12 13:50:09 -0700111 providesTransitiveHeaderJarsForR8
Liz Kammera7a64f32020-07-09 15:16:41 -0700112}
113
114func (d *dexer) effectiveOptimizeEnabled() bool {
115 return BoolDefault(d.dexProperties.Optimize.Enabled, d.dexProperties.Optimize.EnabledByDefault)
116}
117
Rico Wind936754c2024-05-07 09:08:31 +0200118func (d *DexProperties) resourceShrinkingEnabled(ctx android.ModuleContext) bool {
119 return !ctx.Config().Eng() && BoolDefault(d.Optimize.Optimized_shrink_resources, Bool(d.Optimize.Shrink_resources))
120}
121
122func (d *DexProperties) optimizedResourceShrinkingEnabled(ctx android.ModuleContext) bool {
Rico Winda7b38592024-08-26 12:10:44 +0200123 return d.resourceShrinkingEnabled(ctx) && BoolDefault(d.Optimize.Optimized_shrink_resources, ctx.Config().UseOptimizedResourceShrinkingByDefault())
Rico Winda2fa2632024-03-13 13:09:17 +0100124}
125
Spandan Das15a67112024-05-30 00:07:40 +0000126func (d *dexer) optimizeOrObfuscateEnabled() bool {
127 return d.effectiveOptimizeEnabled() && (proptools.Bool(d.dexProperties.Optimize.Optimize) || proptools.Bool(d.dexProperties.Optimize.Obfuscate))
128}
129
Colin Cross77cdcfd2021-03-12 11:28:25 -0800130var d8, d8RE = pctx.MultiCommandRemoteStaticRules("d8",
Colin Crossf0056cb2017-12-22 15:56:08 -0800131 blueprint.RuleParams{
132 Command: `rm -rf "$outDir" && mkdir -p "$outDir" && ` +
David Srbeckybda964c2023-11-24 15:57:54 +0000133 `$d8Template${config.D8Cmd} ${config.D8Flags} $d8Flags --output $outDir --no-dex-input-jar $in && ` +
Kousik Kumar366afc52020-05-20 11:27:16 -0700134 `$zipTemplate${config.SoongZipCmd} $zipFlags -o $outDir/classes.dex.jar -C $outDir -f "$outDir/classes*.dex" && ` +
Colin Cross56e28402023-09-28 14:38:06 -0700135 `${config.MergeZipsCmd} -D -stripFile "**/*.class" $mergeZipsFlags $out $outDir/classes.dex.jar $in && ` +
Ian Zernydb2d35b2023-10-10 12:22:39 +0200136 `rm -f "$outDir/classes*.dex" "$outDir/classes.dex.jar"`,
Colin Crossf0056cb2017-12-22 15:56:08 -0800137 CommandDeps: []string{
138 "${config.D8Cmd}",
139 "${config.SoongZipCmd}",
140 "${config.MergeZipsCmd}",
141 },
Kousik Kumar366afc52020-05-20 11:27:16 -0700142 }, map[string]*remoteexec.REParams{
143 "$d8Template": &remoteexec.REParams{
144 Labels: map[string]string{"type": "compile", "compiler": "d8"},
145 Inputs: []string{"${config.D8Jar}"},
146 ExecStrategy: "${config.RED8ExecStrategy}",
147 ToolchainInputs: []string{"${config.JavaCmd}"},
148 Platform: map[string]string{remoteexec.PoolKey: "${config.REJavaPool}"},
149 },
150 "$zipTemplate": &remoteexec.REParams{
151 Labels: map[string]string{"type": "tool", "name": "soong_zip"},
152 Inputs: []string{"${config.SoongZipCmd}", "$outDir"},
153 OutputFiles: []string{"$outDir/classes.dex.jar"},
154 ExecStrategy: "${config.RED8ExecStrategy}",
155 Platform: map[string]string{remoteexec.PoolKey: "${config.REJavaPool}"},
156 },
Ian Zernydb2d35b2023-10-10 12:22:39 +0200157 }, []string{"outDir", "d8Flags", "zipFlags", "mergeZipsFlags"}, nil)
Colin Crossf0056cb2017-12-22 15:56:08 -0800158
Colin Cross77cdcfd2021-03-12 11:28:25 -0800159var r8, r8RE = pctx.MultiCommandRemoteStaticRules("r8",
Colin Cross66dbc0b2017-12-28 12:23:20 -0800160 blueprint.RuleParams{
161 Command: `rm -rf "$outDir" && mkdir -p "$outDir" && ` +
Ian Zerny82044f12023-01-25 12:11:27 +0100162 `rm -f "$outDict" && rm -f "$outConfig" && rm -rf "${outUsageDir}" && ` +
Colin Crosscb6143a2020-08-14 17:39:29 -0700163 `mkdir -p $$(dirname ${outUsage}) && ` +
David Srbeckybda964c2023-11-24 15:57:54 +0000164 `$r8Template${config.R8Cmd} ${config.R8Flags} $r8Flags -injars $in --output $outDir ` +
Søren Gjesse24f17022018-09-14 15:20:42 +0200165 `--no-data-resources ` +
Colin Crosscb6143a2020-08-14 17:39:29 -0700166 `-printmapping ${outDict} ` +
Jared Duke34c6d7d2023-05-05 20:40:20 +0000167 `-printconfiguration ${outConfig} ` +
Colin Crosscb6143a2020-08-14 17:39:29 -0700168 `-printusage ${outUsage} ` +
David Srbeckybda964c2023-11-24 15:57:54 +0000169 `--deps-file ${out}.d && ` +
Ian Zerny82044f12023-01-25 12:11:27 +0100170 `touch "${outDict}" "${outConfig}" "${outUsage}" && ` +
Colin Crosscb6143a2020-08-14 17:39:29 -0700171 `${config.SoongZipCmd} -o ${outUsageZip} -C ${outUsageDir} -f ${outUsage} && ` +
172 `rm -rf ${outUsageDir} && ` +
Kousik Kumar366afc52020-05-20 11:27:16 -0700173 `$zipTemplate${config.SoongZipCmd} $zipFlags -o $outDir/classes.dex.jar -C $outDir -f "$outDir/classes*.dex" && ` +
Colin Cross56e28402023-09-28 14:38:06 -0700174 `${config.MergeZipsCmd} -D -stripFile "**/*.class" $mergeZipsFlags $out $outDir/classes.dex.jar $in && ` +
Colin Crossb716ceb2023-10-03 09:40:06 -0700175 `rm -f "$outDir/classes*.dex" "$outDir/classes.dex.jar"`,
Colin Cross22e6a6f2022-03-21 12:19:44 -0700176 Depfile: "${out}.d",
177 Deps: blueprint.DepsGCC,
Colin Cross66dbc0b2017-12-28 12:23:20 -0800178 CommandDeps: []string{
Colin Crossa832a042021-08-05 16:56:18 -0700179 "${config.R8Cmd}",
Colin Cross66dbc0b2017-12-28 12:23:20 -0800180 "${config.SoongZipCmd}",
181 "${config.MergeZipsCmd}",
182 },
Kousik Kumar366afc52020-05-20 11:27:16 -0700183 }, map[string]*remoteexec.REParams{
184 "$r8Template": &remoteexec.REParams{
185 Labels: map[string]string{"type": "compile", "compiler": "r8"},
186 Inputs: []string{"$implicits", "${config.R8Jar}"},
Spandan Dasd447bbb2024-06-24 17:13:30 +0000187 OutputFiles: []string{"${outUsage}", "${outConfig}", "${outDict}", "${resourcesOutput}", "${outR8ArtProfile}"},
Kousik Kumar366afc52020-05-20 11:27:16 -0700188 ExecStrategy: "${config.RER8ExecStrategy}",
189 ToolchainInputs: []string{"${config.JavaCmd}"},
190 Platform: map[string]string{remoteexec.PoolKey: "${config.REJavaPool}"},
191 },
192 "$zipTemplate": &remoteexec.REParams{
193 Labels: map[string]string{"type": "tool", "name": "soong_zip"},
194 Inputs: []string{"${config.SoongZipCmd}", "$outDir"},
195 OutputFiles: []string{"$outDir/classes.dex.jar"},
196 ExecStrategy: "${config.RER8ExecStrategy}",
197 Platform: map[string]string{remoteexec.PoolKey: "${config.REJavaPool}"},
198 },
Colin Crosscb6143a2020-08-14 17:39:29 -0700199 "$zipUsageTemplate": &remoteexec.REParams{
200 Labels: map[string]string{"type": "tool", "name": "soong_zip"},
201 Inputs: []string{"${config.SoongZipCmd}", "${outUsage}"},
202 OutputFiles: []string{"${outUsageZip}"},
203 ExecStrategy: "${config.RER8ExecStrategy}",
204 Platform: map[string]string{remoteexec.PoolKey: "${config.REJavaPool}"},
205 },
Ian Zerny82044f12023-01-25 12:11:27 +0100206 }, []string{"outDir", "outDict", "outConfig", "outUsage", "outUsageZip", "outUsageDir",
Spandan Dasd447bbb2024-06-24 17:13:30 +0000207 "r8Flags", "zipFlags", "mergeZipsFlags", "resourcesOutput", "outR8ArtProfile"}, []string{"implicits"})
Colin Cross66dbc0b2017-12-28 12:23:20 -0800208
Colin Cross5ea963e2021-09-16 19:13:43 -0700209func (d *dexer) dexCommonFlags(ctx android.ModuleContext,
Spandan Dasc404cc72023-02-23 18:05:05 +0000210 dexParams *compileDexParams) (flags []string, deps android.Paths) {
Colin Cross5ea963e2021-09-16 19:13:43 -0700211
212 flags = d.dexProperties.Dxflags
Colin Crossbafb8972018-06-06 21:46:32 +0000213 // Translate all the DX flags to D8 ones until all the build files have been migrated
214 // to D8 flags. See: b/69377755
215 flags = android.RemoveListFromList(flags,
216 []string{"--core-library", "--dex", "--multi-dex"})
Colin Crossf0056cb2017-12-22 15:56:08 -0800217
Colin Cross5ea963e2021-09-16 19:13:43 -0700218 for _, f := range android.PathsForModuleSrc(ctx, d.dexProperties.Main_dex_rules) {
219 flags = append(flags, "--main-dex-rules", f.String())
220 deps = append(deps, f)
221 }
222
Jared Duked32e85f2024-09-25 23:54:30 +0000223 var requestReleaseMode bool
224 requestReleaseMode, flags = android.RemoveFromList("--release", flags)
225
Colin Crossf0056cb2017-12-22 15:56:08 -0800226 if ctx.Config().Getenv("NO_OPTIMIZE_DX") != "" {
Colin Crossbafb8972018-06-06 21:46:32 +0000227 flags = append(flags, "--debug")
Jared Duked32e85f2024-09-25 23:54:30 +0000228 requestReleaseMode = false
Colin Crossf0056cb2017-12-22 15:56:08 -0800229 }
230
231 if ctx.Config().Getenv("GENERATE_DEX_DEBUG") != "" {
232 flags = append(flags,
233 "--debug",
234 "--verbose")
Jared Duked32e85f2024-09-25 23:54:30 +0000235 requestReleaseMode = false
236 }
237
238 // Don't strip out debug information for eng builds, unless the target
239 // explicitly provided the `--release` build flag. This allows certain
240 // test targets to remain optimized as part of eng test_suites builds.
241 if requestReleaseMode {
242 flags = append(flags, "--release")
243 } else if ctx.Config().Eng() {
244 flags = append(flags, "--debug")
Colin Crossf0056cb2017-12-22 15:56:08 -0800245 }
246
Jared Duke40d731a2022-09-20 15:32:14 -0700247 // Supplying the platform build flag disables various features like API modeling and desugaring.
248 // For targets with a stable min SDK version (i.e., when the min SDK is both explicitly specified
249 // and managed+versioned), we suppress this flag to ensure portability.
250 // Note: Targets with a min SDK kind of core_platform (e.g., framework.jar) or unspecified (e.g.,
251 // services.jar), are not classified as stable, which is WAI.
252 // TODO(b/232073181): Expand to additional min SDK cases after validation.
Ian Zernyc26029b2023-08-25 13:43:44 +0200253 var addAndroidPlatformBuildFlag = false
Spandan Dasc404cc72023-02-23 18:05:05 +0000254 if !dexParams.sdkVersion.Stable() {
Ian Zernyc26029b2023-08-25 13:43:44 +0200255 addAndroidPlatformBuildFlag = true
Jared Duke40d731a2022-09-20 15:32:14 -0700256 }
257
Spandan Dasc404cc72023-02-23 18:05:05 +0000258 effectiveVersion, err := dexParams.minSdkVersion.EffectiveVersion(ctx)
Colin Cross83bb3162018-06-25 15:48:06 -0700259 if err != nil {
260 ctx.PropertyErrorf("min_sdk_version", "%s", err)
261 }
Ulya Trofimovich5bb46812024-08-07 19:25:58 +0000262 if !Bool(d.dexProperties.No_dex_container) && effectiveVersion.FinalOrFutureInt() >= 36 {
263 // W is 36, but we have not bumped the SDK version yet, so check for both.
264 if ctx.Config().PlatformSdkVersion().FinalInt() >= 36 ||
265 ctx.Config().PlatformSdkCodename() == "Wear" {
266 // TODO(b/329465418): Skip this module since it causes issue with app DRM
267 if ctx.ModuleName() != "framework-minus-apex" {
268 flags = append([]string{"-JDcom.android.tools.r8.dexContainerExperiment"}, flags...)
269 }
270 }
271 }
Colin Cross83bb3162018-06-25 15:48:06 -0700272
Ian Zernyc26029b2023-08-25 13:43:44 +0200273 // If the specified SDK level is 10000, then configure the compiler to use the
274 // current platform SDK level and to compile the build as a platform build.
275 var minApiFlagValue = effectiveVersion.FinalOrFutureInt()
276 if minApiFlagValue == 10000 {
277 minApiFlagValue = ctx.Config().PlatformSdkVersion().FinalInt()
278 addAndroidPlatformBuildFlag = true
279 }
280 flags = append(flags, "--min-api "+strconv.Itoa(minApiFlagValue))
281
282 if addAndroidPlatformBuildFlag {
283 flags = append(flags, "--android-platform-build")
284 }
Colin Cross5ea963e2021-09-16 19:13:43 -0700285 return flags, deps
Colin Crossf0056cb2017-12-22 15:56:08 -0800286}
287
Spandan Das3dbda182024-05-20 22:23:10 +0000288func (d *dexer) d8Flags(ctx android.ModuleContext, dexParams *compileDexParams) (d8Flags []string, d8Deps android.Paths, artProfileOutput *android.OutputPath) {
289 flags := dexParams.flags
Colin Crossc2557d12019-10-31 15:22:57 -0700290 d8Flags = append(d8Flags, flags.bootClasspath.FormRepeatedClassPath("--lib ")...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -0700291 d8Flags = append(d8Flags, flags.dexClasspath.FormRepeatedClassPath("--lib ")...)
Colin Crossffb657e2018-09-21 12:29:22 -0700292
Colin Cross6dab9bd2018-09-28 08:06:24 -0700293 d8Deps = append(d8Deps, flags.bootClasspath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -0700294 d8Deps = append(d8Deps, flags.dexClasspath...)
Colin Cross6dab9bd2018-09-28 08:06:24 -0700295
Spandan Das3dbda182024-05-20 22:23:10 +0000296 if flags, deps, profileOutput := d.addArtProfile(ctx, dexParams); profileOutput != nil {
297 d8Flags = append(d8Flags, flags...)
298 d8Deps = append(d8Deps, deps...)
299 artProfileOutput = profileOutput
300 }
301
302 return d8Flags, d8Deps, artProfileOutput
Colin Crossffb657e2018-09-21 12:29:22 -0700303}
304
Spandan Das3dbda182024-05-20 22:23:10 +0000305func (d *dexer) r8Flags(ctx android.ModuleContext, dexParams *compileDexParams) (r8Flags []string, r8Deps android.Paths, artProfileOutput *android.OutputPath) {
306 flags := dexParams.flags
Liz Kammera7a64f32020-07-09 15:16:41 -0700307 opt := d.dexProperties.Optimize
Colin Cross66dbc0b2017-12-28 12:23:20 -0800308
309 // When an app contains references to APIs that are not in the SDK specified by
310 // its LOCAL_SDK_VERSION for example added by support library or by runtime
Colin Crossbafb8972018-06-06 21:46:32 +0000311 // classes added by desugaring, we artifically raise the "SDK version" "linked" by
Colin Cross66dbc0b2017-12-28 12:23:20 -0800312 // ProGuard, to
313 // - suppress ProGuard warnings of referencing symbols unknown to the lower SDK version.
314 // - prevent ProGuard stripping subclass in the support library that extends class added in the higher SDK version.
315 // See b/20667396
Jared Duke22468442024-08-20 20:45:35 +0000316 // TODO(b/360905238): Remove SdkSystemServer exception after resolving missing class references.
317 if !dexParams.sdkVersion.Stable() || dexParams.sdkVersion.Kind == android.SdkSystemServer {
318 var proguardRaiseDeps classpath
319 ctx.VisitDirectDepsWithTag(proguardRaiseTag, func(m android.Module) {
320 if dep, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
321 proguardRaiseDeps = append(proguardRaiseDeps, dep.RepackagedHeaderJars...)
322 }
323 })
324 r8Flags = append(r8Flags, proguardRaiseDeps.FormJavaClassPath("-libraryjars"))
325 r8Deps = append(r8Deps, proguardRaiseDeps...)
326 }
Colin Cross66dbc0b2017-12-28 12:23:20 -0800327
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500328 r8Flags = append(r8Flags, flags.bootClasspath.FormJavaClassPath("-libraryjars"))
Colin Cross6dab9bd2018-09-28 08:06:24 -0700329 r8Deps = append(r8Deps, flags.bootClasspath...)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500330 r8Flags = append(r8Flags, flags.dexClasspath.FormJavaClassPath("-libraryjars"))
Colin Cross9bb9bfb2022-03-17 11:12:32 -0700331 r8Deps = append(r8Deps, flags.dexClasspath...)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500332
333 transitiveStaticLibsLookupMap := map[android.Path]bool{}
Colin Cross9ffaf282024-08-12 13:50:09 -0700334 if d.transitiveStaticLibsHeaderJarsForR8 != nil {
335 for _, jar := range d.transitiveStaticLibsHeaderJarsForR8.ToList() {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500336 transitiveStaticLibsLookupMap[jar] = true
337 }
338 }
339 transitiveHeaderJars := android.Paths{}
Colin Cross9ffaf282024-08-12 13:50:09 -0700340 if d.transitiveLibsHeaderJarsForR8 != nil {
341 for _, jar := range d.transitiveLibsHeaderJarsForR8.ToList() {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500342 if _, ok := transitiveStaticLibsLookupMap[jar]; ok {
343 // don't include a lib if it is already packaged in the current JAR as a static lib
344 continue
345 }
346 transitiveHeaderJars = append(transitiveHeaderJars, jar)
347 }
348 }
349 transitiveClasspath := classpath(transitiveHeaderJars)
350 r8Flags = append(r8Flags, transitiveClasspath.FormJavaClassPath("-libraryjars"))
351 r8Deps = append(r8Deps, transitiveClasspath...)
Colin Cross6dab9bd2018-09-28 08:06:24 -0700352
Colin Cross66dbc0b2017-12-28 12:23:20 -0800353 flagFiles := android.Paths{
354 android.PathForSource(ctx, "build/make/core/proguard.flags"),
355 }
356
Colin Cross312634e2023-11-21 15:13:56 -0800357 flagFiles = append(flagFiles, d.extraProguardFlagsFiles...)
Colin Cross66dbc0b2017-12-28 12:23:20 -0800358 // TODO(ccross): static android library proguard files
359
Liz Kammera7a64f32020-07-09 15:16:41 -0700360 flagFiles = append(flagFiles, android.PathsForModuleSrc(ctx, opt.Proguard_flags_files)...)
Colin Crossbd1cef52018-08-13 10:28:18 -0700361
Sam Delmericoc8e040c2023-10-31 17:27:02 +0000362 flagFiles = android.FirstUniquePaths(flagFiles)
363
Colin Cross66dbc0b2017-12-28 12:23:20 -0800364 r8Flags = append(r8Flags, android.JoinWithPrefix(flagFiles.Strings(), "-include "))
365 r8Deps = append(r8Deps, flagFiles...)
366
367 // TODO(b/70942988): This is included from build/make/core/proguard.flags
368 r8Deps = append(r8Deps, android.PathForSource(ctx,
369 "build/make/core/proguard_basic_keeps.flags"))
370
Liz Kammera7a64f32020-07-09 15:16:41 -0700371 r8Flags = append(r8Flags, opt.Proguard_flags...)
Colin Cross66dbc0b2017-12-28 12:23:20 -0800372
Christoffer Quist Adamsenf2d7b162020-08-24 15:56:16 +0200373 if BoolDefault(opt.Proguard_compatibility, true) {
374 r8Flags = append(r8Flags, "--force-proguard-compatibility")
Jared Dukeb832fbb2023-09-15 17:16:36 +0000375 }
376
377 if Bool(opt.Optimize) || Bool(opt.Obfuscate) {
Ian Zernyfc7df612021-11-02 15:37:06 +0100378 // TODO(b/213833843): Allow configuration of the prefix via a build variable.
379 var sourceFilePrefix = "go/retraceme "
380 var sourceFileTemplate = "\"" + sourceFilePrefix + "%MAP_ID\""
Jared Dukeb832fbb2023-09-15 17:16:36 +0000381 r8Flags = append(r8Flags, "--map-id-template", "%MAP_HASH")
382 r8Flags = append(r8Flags, "--source-file-template", sourceFileTemplate)
Christoffer Quist Adamsenf2d7b162020-08-24 15:56:16 +0200383 }
384
Colin Cross66dbc0b2017-12-28 12:23:20 -0800385 // TODO(ccross): Don't shrink app instrumentation tests by default.
386 if !Bool(opt.Shrink) {
387 r8Flags = append(r8Flags, "-dontshrink")
388 }
389
390 if !Bool(opt.Optimize) {
391 r8Flags = append(r8Flags, "-dontoptimize")
392 }
393
394 // TODO(ccross): error if obufscation + app instrumentation test.
395 if !Bool(opt.Obfuscate) {
396 r8Flags = append(r8Flags, "-dontobfuscate")
397 }
Colin Cross4b964c02018-10-15 16:18:06 -0700398 // TODO(ccross): if this is an instrumentation test of an obfuscated app, use the
399 // dictionary of the app and move the app from libraryjars to injars.
Colin Cross66dbc0b2017-12-28 12:23:20 -0800400
Christoffer Quist Adamsene8507372021-02-22 09:44:09 +0100401 // TODO(b/180878971): missing classes should be added to the relevant builds.
Ajinkya Chalkeddad41b2023-02-09 14:09:58 +0000402 // TODO(b/229727645): do not use true as default for Android platform builds.
403 if proptools.BoolDefault(opt.Ignore_warnings, true) {
Remi NGUYEN VANbdad3142022-08-04 13:19:03 +0900404 r8Flags = append(r8Flags, "-ignorewarnings")
405 }
Christoffer Quist Adamsene8507372021-02-22 09:44:09 +0100406
Rico Winda2fa2632024-03-13 13:09:17 +0100407 // resourcesInput is empty when we don't use resource shrinking, if on, pass these to R8
Rico Wind98e7fa82023-11-27 09:44:03 +0100408 if d.resourcesInput.Valid() {
409 r8Flags = append(r8Flags, "--resource-input", d.resourcesInput.Path().String())
410 r8Deps = append(r8Deps, d.resourcesInput.Path())
411 r8Flags = append(r8Flags, "--resource-output", d.resourcesOutput.Path().String())
Rico Winda7b38592024-08-26 12:10:44 +0200412 if d.dexProperties.optimizedResourceShrinkingEnabled(ctx) {
Rico Winda2fa2632024-03-13 13:09:17 +0100413 r8Flags = append(r8Flags, "--optimized-resource-shrinking")
414 }
Rico Wind98e7fa82023-11-27 09:44:03 +0100415 }
416
Spandan Das3dbda182024-05-20 22:23:10 +0000417 if flags, deps, profileOutput := d.addArtProfile(ctx, dexParams); profileOutput != nil {
418 r8Flags = append(r8Flags, flags...)
419 r8Deps = append(r8Deps, deps...)
420 artProfileOutput = profileOutput
421 }
422
423 return r8Flags, r8Deps, artProfileOutput
Colin Cross66dbc0b2017-12-28 12:23:20 -0800424}
425
Spandan Dasc404cc72023-02-23 18:05:05 +0000426type compileDexParams struct {
Spandan Das3dbda182024-05-20 22:23:10 +0000427 flags javaBuilderFlags
428 sdkVersion android.SdkSpec
429 minSdkVersion android.ApiLevel
430 classesJar android.Path
431 jarName string
432 artProfileInput *string
Spandan Dasc404cc72023-02-23 18:05:05 +0000433}
434
Spandan Das3dbda182024-05-20 22:23:10 +0000435// Adds --art-profile to r8/d8 command.
436// r8/d8 will output a generated profile file to match the optimized dex code.
437func (d *dexer) addArtProfile(ctx android.ModuleContext, dexParams *compileDexParams) (flags []string, deps android.Paths, artProfileOutputPath *android.OutputPath) {
438 if dexParams.artProfileInput != nil {
439 artProfileInputPath := android.PathForModuleSrc(ctx, *dexParams.artProfileInput)
440 artProfileOutputPathValue := android.PathForModuleOut(ctx, "profile.prof.txt").OutputPath
441 artProfileOutputPath = &artProfileOutputPathValue
442 flags = []string{
443 "--art-profile",
444 artProfileInputPath.String(),
445 artProfileOutputPath.String(),
446 }
447 deps = append(deps, artProfileInputPath)
448 }
449 return flags, deps, artProfileOutputPath
450
451}
452
453// Return the compiled dex jar and (optional) profile _after_ r8 optimization
Colin Cross7707b242024-07-26 12:02:36 -0700454func (d *dexer) compileDex(ctx android.ModuleContext, dexParams *compileDexParams) (android.Path, android.Path) {
Colin Crossf0056cb2017-12-22 15:56:08 -0800455
Colin Crossf0056cb2017-12-22 15:56:08 -0800456 // Compile classes.jar into classes.dex and then javalib.jar
Spandan Dasc404cc72023-02-23 18:05:05 +0000457 javalibJar := android.PathForModuleOut(ctx, "dex", dexParams.jarName).OutputPath
Colin Crossf0056cb2017-12-22 15:56:08 -0800458 outDir := android.PathForModuleOut(ctx, "dex")
459
Sasha Smundakd3cf4ee2019-02-15 10:14:23 -0800460 zipFlags := "--ignore_missing_files"
Liz Kammera7a64f32020-07-09 15:16:41 -0700461 if proptools.Bool(d.dexProperties.Uncompress_dex) {
Sasha Smundakd3cf4ee2019-02-15 10:14:23 -0800462 zipFlags += " -L 0"
Colin Cross5a0dcd52018-10-05 14:20:06 -0700463 }
464
Spandan Dasc404cc72023-02-23 18:05:05 +0000465 commonFlags, commonDeps := d.dexCommonFlags(ctx, dexParams)
Liz Kammera7a64f32020-07-09 15:16:41 -0700466
Wei Li1e73c652021-12-06 13:35:11 -0800467 // Exclude kotlinc generated files when "exclude_kotlinc_generated_files" is set to true.
468 mergeZipsFlags := ""
469 if proptools.BoolDefault(d.dexProperties.Exclude_kotlinc_generated_files, false) {
470 mergeZipsFlags = "-stripFile META-INF/*.kotlin_module -stripFile **/*.kotlin_builtins"
471 }
472
Liz Kammera7a64f32020-07-09 15:16:41 -0700473 useR8 := d.effectiveOptimizeEnabled()
Spandan Das3dbda182024-05-20 22:23:10 +0000474 var artProfileOutputPath *android.OutputPath
Colin Cross66dbc0b2017-12-28 12:23:20 -0800475 if useR8 {
Colin Crossc0c664c2018-05-16 16:47:21 -0700476 proguardDictionary := android.PathForModuleOut(ctx, "proguard_dictionary")
Liz Kammera7a64f32020-07-09 15:16:41 -0700477 d.proguardDictionary = android.OptionalPathForPath(proguardDictionary)
Ian Zerny82044f12023-01-25 12:11:27 +0100478 proguardConfiguration := android.PathForModuleOut(ctx, "proguard_configuration")
479 d.proguardConfiguration = android.OptionalPathForPath(proguardConfiguration)
Colin Crosscb6143a2020-08-14 17:39:29 -0700480 proguardUsageDir := android.PathForModuleOut(ctx, "proguard_usage")
481 proguardUsage := proguardUsageDir.Join(ctx, ctx.Namespace().Path,
482 android.ModuleNameWithPossibleOverride(ctx), "unused.txt")
483 proguardUsageZip := android.PathForModuleOut(ctx, "proguard_usage.zip")
484 d.proguardUsageZip = android.OptionalPathForPath(proguardUsageZip)
Rico Wind98e7fa82023-11-27 09:44:03 +0100485 resourcesOutput := android.PathForModuleOut(ctx, "package-res-shrunken.apk")
486 d.resourcesOutput = android.OptionalPathForPath(resourcesOutput)
Spandan Das3dbda182024-05-20 22:23:10 +0000487 implicitOutputs := android.WritablePaths{
488 proguardDictionary,
489 proguardUsageZip,
490 proguardConfiguration,
491 }
492 r8Flags, r8Deps, r8ArtProfileOutputPath := d.r8Flags(ctx, dexParams)
Ramy Medhat1dcc27e2020-04-21 21:36:23 -0400493 rule := r8
494 args := map[string]string{
Wei Li1e73c652021-12-06 13:35:11 -0800495 "r8Flags": strings.Join(append(commonFlags, r8Flags...), " "),
496 "zipFlags": zipFlags,
497 "outDict": proguardDictionary.String(),
Ian Zerny82044f12023-01-25 12:11:27 +0100498 "outConfig": proguardConfiguration.String(),
Wei Li1e73c652021-12-06 13:35:11 -0800499 "outUsageDir": proguardUsageDir.String(),
500 "outUsage": proguardUsage.String(),
501 "outUsageZip": proguardUsageZip.String(),
502 "outDir": outDir.String(),
Wei Li1e73c652021-12-06 13:35:11 -0800503 "mergeZipsFlags": mergeZipsFlags,
Ramy Medhat1dcc27e2020-04-21 21:36:23 -0400504 }
Spandan Dasd447bbb2024-06-24 17:13:30 +0000505 if r8ArtProfileOutputPath != nil {
506 artProfileOutputPath = r8ArtProfileOutputPath
507 implicitOutputs = append(
508 implicitOutputs,
509 artProfileOutputPath,
510 )
511 // Add the implicit r8 Art profile output to args so that r8RE knows
512 // about this implicit output
513 args["outR8ArtProfile"] = artProfileOutputPath.String()
514 }
515
Ramy Medhat16f23a42020-09-03 01:29:49 -0400516 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_R8") {
Ramy Medhat1dcc27e2020-04-21 21:36:23 -0400517 rule = r8RE
518 args["implicits"] = strings.Join(r8Deps.Strings(), ",")
519 }
Rico Wind98e7fa82023-11-27 09:44:03 +0100520 if d.resourcesInput.Valid() {
521 implicitOutputs = append(implicitOutputs, resourcesOutput)
522 args["resourcesOutput"] = resourcesOutput.String()
523 }
Colin Cross66dbc0b2017-12-28 12:23:20 -0800524 ctx.Build(pctx, android.BuildParams{
Rico Wind98e7fa82023-11-27 09:44:03 +0100525 Rule: rule,
526 Description: "r8",
527 Output: javalibJar,
528 ImplicitOutputs: implicitOutputs,
529 Input: dexParams.classesJar,
530 Implicits: r8Deps,
531 Args: args,
Colin Cross66dbc0b2017-12-28 12:23:20 -0800532 })
533 } else {
Spandan Das3dbda182024-05-20 22:23:10 +0000534 implicitOutputs := android.WritablePaths{}
535 d8Flags, d8Deps, d8ArtProfileOutputPath := d.d8Flags(ctx, dexParams)
536 if d8ArtProfileOutputPath != nil {
537 artProfileOutputPath = d8ArtProfileOutputPath
538 implicitOutputs = append(
539 implicitOutputs,
540 artProfileOutputPath,
541 )
542 }
Colin Cross5ea963e2021-09-16 19:13:43 -0700543 d8Deps = append(d8Deps, commonDeps...)
Ramy Medhat1dcc27e2020-04-21 21:36:23 -0400544 rule := d8
Ramy Medhat16f23a42020-09-03 01:29:49 -0400545 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_D8") {
Ramy Medhat1dcc27e2020-04-21 21:36:23 -0400546 rule = d8RE
547 }
Colin Cross66dbc0b2017-12-28 12:23:20 -0800548 ctx.Build(pctx, android.BuildParams{
Spandan Das3dbda182024-05-20 22:23:10 +0000549 Rule: rule,
550 Description: "d8",
551 Output: javalibJar,
552 Input: dexParams.classesJar,
553 ImplicitOutputs: implicitOutputs,
554 Implicits: d8Deps,
Colin Cross66dbc0b2017-12-28 12:23:20 -0800555 Args: map[string]string{
Wei Li1e73c652021-12-06 13:35:11 -0800556 "d8Flags": strings.Join(append(commonFlags, d8Flags...), " "),
557 "zipFlags": zipFlags,
558 "outDir": outDir.String(),
Wei Li1e73c652021-12-06 13:35:11 -0800559 "mergeZipsFlags": mergeZipsFlags,
Colin Cross66dbc0b2017-12-28 12:23:20 -0800560 },
561 })
Colin Crossf0056cb2017-12-22 15:56:08 -0800562 }
Liz Kammera7a64f32020-07-09 15:16:41 -0700563 if proptools.Bool(d.dexProperties.Uncompress_dex) {
Spandan Dasc404cc72023-02-23 18:05:05 +0000564 alignedJavalibJar := android.PathForModuleOut(ctx, "aligned", dexParams.jarName).OutputPath
Cole Faust51d7bfd2023-09-07 05:31:32 +0000565 TransformZipAlign(ctx, alignedJavalibJar, javalibJar, nil)
Nicolas Geoffray65fd8ba2019-01-21 23:20:23 +0000566 javalibJar = alignedJavalibJar
567 }
Colin Crossf0056cb2017-12-22 15:56:08 -0800568
Spandan Das3dbda182024-05-20 22:23:10 +0000569 return javalibJar, artProfileOutputPath
Colin Crossf0056cb2017-12-22 15:56:08 -0800570}