blob: 4a7e9dcc40e0c1db9f53ed2171f606a032060b04 [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
Christoffer Adamsenc8fd1f12025-01-06 19:04:03 +010045 // Whether to allow that library classes inherit from program classes.
46 // Defaults to false.
47 Ignore_library_extends_program *bool
48
Ajinkya Chalkeddad41b2023-02-09 14:09:58 +000049 // Whether to continue building even if warnings are emitted. Defaults to true.
Remi NGUYEN VANbdad3142022-08-04 13:19:03 +090050 Ignore_warnings *bool
51
Christoffer Adamsen8ec5f612025-01-09 11:05:11 +010052 // Whether runtime invisible annotations should be kept by R8. Defaults to false.
53 // This is equivalent to:
54 // -keepattributes RuntimeInvisibleAnnotations,
55 // RuntimeInvisibleParameterAnnotations,
56 // RuntimeInvisibleTypeAnnotations
57 // This is only applicable when RELEASE_R8_ONLY_RUNTIME_VISIBLE_ANNOTATIONS is
58 // enabled and will be used to migrate away from keeping runtime invisible
59 // annotations (b/387958004).
60 Keep_runtime_invisible_annotations *bool
61
Jared Dukeaa88b3d2023-08-29 17:07:20 +000062 // If true, runs R8 in Proguard compatibility mode, otherwise runs R8 in full mode.
Christoffer Adamsenc8fd1f12025-01-06 19:04:03 +010063 // Defaults to false for apps and tests, true for libraries.
Christoffer Quist Adamsenf2d7b162020-08-24 15:56:16 +020064 Proguard_compatibility *bool
65
Liz Kammera7a64f32020-07-09 15:16:41 -070066 // If true, optimize for size by removing unused code. Defaults to true for apps,
67 // false for libraries and tests.
68 Shrink *bool
69
70 // If true, optimize bytecode. Defaults to false.
71 Optimize *bool
72
73 // If true, obfuscate bytecode. Defaults to false.
74 Obfuscate *bool
75
76 // If true, do not use the flag files generated by aapt that automatically keep
77 // classes referenced by the app manifest. Defaults to false.
78 No_aapt_flags *bool
79
Jared Duke51b0a102022-09-27 16:53:11 -070080 // If true, optimize for size by removing unused resources. Defaults to false.
Rico Wind351bac92022-09-22 10:41:42 +020081 Shrink_resources *bool
82
Rico Winda2fa2632024-03-13 13:09:17 +010083 // If true, use optimized resource shrinking in R8, overriding the
84 // Shrink_resources setting. Defaults to false.
85 // Optimized shrinking means that R8 will trace and treeshake resources together with code
86 // and apply additional optimizations. This implies non final fields in the R classes.
87 Optimized_shrink_resources *bool
88
Liz Kammera7a64f32020-07-09 15:16:41 -070089 // Flags to pass to proguard.
90 Proguard_flags []string
91
92 // Specifies the locations of files containing proguard flags.
93 Proguard_flags_files []string `android:"path"`
Sam Delmerico95d70942023-08-02 18:00:35 -040094
95 // If true, transitive reverse dependencies of this module will have this
96 // module's proguard spec appended to their optimization action
97 Export_proguard_flags_files *bool
Liz Kammera7a64f32020-07-09 15:16:41 -070098 }
99
100 // Keep the data uncompressed. We always need uncompressed dex for execution,
101 // so this might actually save space by avoiding storing the same data twice.
102 // This defaults to reasonable value based on module and should not be set.
103 // It exists only to support ART tests.
104 Uncompress_dex *bool
Wei Li1e73c652021-12-06 13:35:11 -0800105
Wei Li92cd54b2022-01-12 13:22:55 -0800106 // Exclude kotlinc generate files: *.kotlin_module, *.kotlin_builtins. Defaults to false.
Wei Li1e73c652021-12-06 13:35:11 -0800107 Exclude_kotlinc_generated_files *bool
Ulya Trafimovichc8160582024-07-10 08:32:45 +0100108
109 // Disable dex container (also known as "multi-dex").
110 // This may be necessary as a temporary workaround to mask toolchain bugs (see b/341652226).
111 No_dex_container *bool
Liz Kammera7a64f32020-07-09 15:16:41 -0700112}
113
114type dexer struct {
115 dexProperties DexProperties
116
117 // list of extra proguard flag files
Colin Cross312634e2023-11-21 15:13:56 -0800118 extraProguardFlagsFiles android.Paths
119 proguardDictionary android.OptionalPath
120 proguardConfiguration android.OptionalPath
121 proguardUsageZip android.OptionalPath
122 resourcesInput android.OptionalPath
123 resourcesOutput android.OptionalPath
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500124
Colin Cross9ffaf282024-08-12 13:50:09 -0700125 providesTransitiveHeaderJarsForR8
Liz Kammera7a64f32020-07-09 15:16:41 -0700126}
127
128func (d *dexer) effectiveOptimizeEnabled() bool {
129 return BoolDefault(d.dexProperties.Optimize.Enabled, d.dexProperties.Optimize.EnabledByDefault)
130}
131
Rico Wind936754c2024-05-07 09:08:31 +0200132func (d *DexProperties) resourceShrinkingEnabled(ctx android.ModuleContext) bool {
133 return !ctx.Config().Eng() && BoolDefault(d.Optimize.Optimized_shrink_resources, Bool(d.Optimize.Shrink_resources))
134}
135
136func (d *DexProperties) optimizedResourceShrinkingEnabled(ctx android.ModuleContext) bool {
Rico Winda7b38592024-08-26 12:10:44 +0200137 return d.resourceShrinkingEnabled(ctx) && BoolDefault(d.Optimize.Optimized_shrink_resources, ctx.Config().UseOptimizedResourceShrinkingByDefault())
Rico Winda2fa2632024-03-13 13:09:17 +0100138}
139
Spandan Das15a67112024-05-30 00:07:40 +0000140func (d *dexer) optimizeOrObfuscateEnabled() bool {
141 return d.effectiveOptimizeEnabled() && (proptools.Bool(d.dexProperties.Optimize.Optimize) || proptools.Bool(d.dexProperties.Optimize.Obfuscate))
142}
143
Colin Cross77cdcfd2021-03-12 11:28:25 -0800144var d8, d8RE = pctx.MultiCommandRemoteStaticRules("d8",
Colin Crossf0056cb2017-12-22 15:56:08 -0800145 blueprint.RuleParams{
146 Command: `rm -rf "$outDir" && mkdir -p "$outDir" && ` +
David Srbeckybda964c2023-11-24 15:57:54 +0000147 `$d8Template${config.D8Cmd} ${config.D8Flags} $d8Flags --output $outDir --no-dex-input-jar $in && ` +
Kousik Kumar366afc52020-05-20 11:27:16 -0700148 `$zipTemplate${config.SoongZipCmd} $zipFlags -o $outDir/classes.dex.jar -C $outDir -f "$outDir/classes*.dex" && ` +
Colin Cross56e28402023-09-28 14:38:06 -0700149 `${config.MergeZipsCmd} -D -stripFile "**/*.class" $mergeZipsFlags $out $outDir/classes.dex.jar $in && ` +
Haamed Gheibie90a6712024-10-04 12:37:21 -0700150 `rm -f "$outDir"/classes*.dex "$outDir/classes.dex.jar"`,
Colin Crossf0056cb2017-12-22 15:56:08 -0800151 CommandDeps: []string{
152 "${config.D8Cmd}",
153 "${config.SoongZipCmd}",
154 "${config.MergeZipsCmd}",
155 },
Kousik Kumar366afc52020-05-20 11:27:16 -0700156 }, map[string]*remoteexec.REParams{
157 "$d8Template": &remoteexec.REParams{
158 Labels: map[string]string{"type": "compile", "compiler": "d8"},
159 Inputs: []string{"${config.D8Jar}"},
160 ExecStrategy: "${config.RED8ExecStrategy}",
161 ToolchainInputs: []string{"${config.JavaCmd}"},
162 Platform: map[string]string{remoteexec.PoolKey: "${config.REJavaPool}"},
163 },
164 "$zipTemplate": &remoteexec.REParams{
165 Labels: map[string]string{"type": "tool", "name": "soong_zip"},
166 Inputs: []string{"${config.SoongZipCmd}", "$outDir"},
167 OutputFiles: []string{"$outDir/classes.dex.jar"},
168 ExecStrategy: "${config.RED8ExecStrategy}",
169 Platform: map[string]string{remoteexec.PoolKey: "${config.REJavaPool}"},
170 },
Ian Zernydb2d35b2023-10-10 12:22:39 +0200171 }, []string{"outDir", "d8Flags", "zipFlags", "mergeZipsFlags"}, nil)
Colin Crossf0056cb2017-12-22 15:56:08 -0800172
Colin Cross77cdcfd2021-03-12 11:28:25 -0800173var r8, r8RE = pctx.MultiCommandRemoteStaticRules("r8",
Colin Cross66dbc0b2017-12-28 12:23:20 -0800174 blueprint.RuleParams{
175 Command: `rm -rf "$outDir" && mkdir -p "$outDir" && ` +
Ian Zerny82044f12023-01-25 12:11:27 +0100176 `rm -f "$outDict" && rm -f "$outConfig" && rm -rf "${outUsageDir}" && ` +
Colin Crosscb6143a2020-08-14 17:39:29 -0700177 `mkdir -p $$(dirname ${outUsage}) && ` +
David Srbeckybda964c2023-11-24 15:57:54 +0000178 `$r8Template${config.R8Cmd} ${config.R8Flags} $r8Flags -injars $in --output $outDir ` +
Søren Gjesse24f17022018-09-14 15:20:42 +0200179 `--no-data-resources ` +
Colin Crosscb6143a2020-08-14 17:39:29 -0700180 `-printmapping ${outDict} ` +
Jared Duke34c6d7d2023-05-05 20:40:20 +0000181 `-printconfiguration ${outConfig} ` +
Colin Crosscb6143a2020-08-14 17:39:29 -0700182 `-printusage ${outUsage} ` +
David Srbeckybda964c2023-11-24 15:57:54 +0000183 `--deps-file ${out}.d && ` +
Ian Zerny82044f12023-01-25 12:11:27 +0100184 `touch "${outDict}" "${outConfig}" "${outUsage}" && ` +
Colin Crosscb6143a2020-08-14 17:39:29 -0700185 `${config.SoongZipCmd} -o ${outUsageZip} -C ${outUsageDir} -f ${outUsage} && ` +
186 `rm -rf ${outUsageDir} && ` +
Kousik Kumar366afc52020-05-20 11:27:16 -0700187 `$zipTemplate${config.SoongZipCmd} $zipFlags -o $outDir/classes.dex.jar -C $outDir -f "$outDir/classes*.dex" && ` +
Colin Cross56e28402023-09-28 14:38:06 -0700188 `${config.MergeZipsCmd} -D -stripFile "**/*.class" $mergeZipsFlags $out $outDir/classes.dex.jar $in && ` +
Haamed Gheibie90a6712024-10-04 12:37:21 -0700189 `rm -f "$outDir"/classes*.dex "$outDir/classes.dex.jar"`,
Colin Cross22e6a6f2022-03-21 12:19:44 -0700190 Depfile: "${out}.d",
191 Deps: blueprint.DepsGCC,
Colin Cross66dbc0b2017-12-28 12:23:20 -0800192 CommandDeps: []string{
Colin Crossa832a042021-08-05 16:56:18 -0700193 "${config.R8Cmd}",
Colin Cross66dbc0b2017-12-28 12:23:20 -0800194 "${config.SoongZipCmd}",
195 "${config.MergeZipsCmd}",
196 },
Kousik Kumar366afc52020-05-20 11:27:16 -0700197 }, map[string]*remoteexec.REParams{
198 "$r8Template": &remoteexec.REParams{
199 Labels: map[string]string{"type": "compile", "compiler": "r8"},
200 Inputs: []string{"$implicits", "${config.R8Jar}"},
Spandan Dasd447bbb2024-06-24 17:13:30 +0000201 OutputFiles: []string{"${outUsage}", "${outConfig}", "${outDict}", "${resourcesOutput}", "${outR8ArtProfile}"},
Kousik Kumar366afc52020-05-20 11:27:16 -0700202 ExecStrategy: "${config.RER8ExecStrategy}",
203 ToolchainInputs: []string{"${config.JavaCmd}"},
204 Platform: map[string]string{remoteexec.PoolKey: "${config.REJavaPool}"},
205 },
206 "$zipTemplate": &remoteexec.REParams{
207 Labels: map[string]string{"type": "tool", "name": "soong_zip"},
208 Inputs: []string{"${config.SoongZipCmd}", "$outDir"},
209 OutputFiles: []string{"$outDir/classes.dex.jar"},
210 ExecStrategy: "${config.RER8ExecStrategy}",
211 Platform: map[string]string{remoteexec.PoolKey: "${config.REJavaPool}"},
212 },
Colin Crosscb6143a2020-08-14 17:39:29 -0700213 "$zipUsageTemplate": &remoteexec.REParams{
214 Labels: map[string]string{"type": "tool", "name": "soong_zip"},
215 Inputs: []string{"${config.SoongZipCmd}", "${outUsage}"},
216 OutputFiles: []string{"${outUsageZip}"},
217 ExecStrategy: "${config.RER8ExecStrategy}",
218 Platform: map[string]string{remoteexec.PoolKey: "${config.REJavaPool}"},
219 },
Ian Zerny82044f12023-01-25 12:11:27 +0100220 }, []string{"outDir", "outDict", "outConfig", "outUsage", "outUsageZip", "outUsageDir",
Spandan Dasd447bbb2024-06-24 17:13:30 +0000221 "r8Flags", "zipFlags", "mergeZipsFlags", "resourcesOutput", "outR8ArtProfile"}, []string{"implicits"})
Colin Cross66dbc0b2017-12-28 12:23:20 -0800222
Colin Cross5ea963e2021-09-16 19:13:43 -0700223func (d *dexer) dexCommonFlags(ctx android.ModuleContext,
Spandan Dasc404cc72023-02-23 18:05:05 +0000224 dexParams *compileDexParams) (flags []string, deps android.Paths) {
Colin Cross5ea963e2021-09-16 19:13:43 -0700225
226 flags = d.dexProperties.Dxflags
Colin Crossbafb8972018-06-06 21:46:32 +0000227 // Translate all the DX flags to D8 ones until all the build files have been migrated
228 // to D8 flags. See: b/69377755
229 flags = android.RemoveListFromList(flags,
230 []string{"--core-library", "--dex", "--multi-dex"})
Colin Crossf0056cb2017-12-22 15:56:08 -0800231
Colin Cross5ea963e2021-09-16 19:13:43 -0700232 for _, f := range android.PathsForModuleSrc(ctx, d.dexProperties.Main_dex_rules) {
233 flags = append(flags, "--main-dex-rules", f.String())
234 deps = append(deps, f)
235 }
236
Jared Duked32e85f2024-09-25 23:54:30 +0000237 var requestReleaseMode bool
238 requestReleaseMode, flags = android.RemoveFromList("--release", flags)
239
Abdelrahman Daim1cde8fc2024-10-01 06:55:58 -0700240 if ctx.Config().Getenv("NO_OPTIMIZE_DX") != "" || ctx.Config().Getenv("GENERATE_DEX_DEBUG") != "" {
Colin Crossbafb8972018-06-06 21:46:32 +0000241 flags = append(flags, "--debug")
Jared Duked32e85f2024-09-25 23:54:30 +0000242 requestReleaseMode = false
Colin Crossf0056cb2017-12-22 15:56:08 -0800243 }
244
Jared Duked32e85f2024-09-25 23:54:30 +0000245 // Don't strip out debug information for eng builds, unless the target
246 // explicitly provided the `--release` build flag. This allows certain
247 // test targets to remain optimized as part of eng test_suites builds.
248 if requestReleaseMode {
249 flags = append(flags, "--release")
250 } else if ctx.Config().Eng() {
251 flags = append(flags, "--debug")
Colin Crossf0056cb2017-12-22 15:56:08 -0800252 }
253
Jared Duke40d731a2022-09-20 15:32:14 -0700254 // Supplying the platform build flag disables various features like API modeling and desugaring.
255 // For targets with a stable min SDK version (i.e., when the min SDK is both explicitly specified
256 // and managed+versioned), we suppress this flag to ensure portability.
257 // Note: Targets with a min SDK kind of core_platform (e.g., framework.jar) or unspecified (e.g.,
258 // services.jar), are not classified as stable, which is WAI.
259 // TODO(b/232073181): Expand to additional min SDK cases after validation.
Ian Zernyc26029b2023-08-25 13:43:44 +0200260 var addAndroidPlatformBuildFlag = false
Spandan Dasc404cc72023-02-23 18:05:05 +0000261 if !dexParams.sdkVersion.Stable() {
Ian Zernyc26029b2023-08-25 13:43:44 +0200262 addAndroidPlatformBuildFlag = true
Jared Duke40d731a2022-09-20 15:32:14 -0700263 }
264
Spandan Dasc404cc72023-02-23 18:05:05 +0000265 effectiveVersion, err := dexParams.minSdkVersion.EffectiveVersion(ctx)
Colin Cross83bb3162018-06-25 15:48:06 -0700266 if err != nil {
267 ctx.PropertyErrorf("min_sdk_version", "%s", err)
268 }
David Srbecky55b46b02024-11-26 17:16:16 +0000269 if !Bool(d.dexProperties.No_dex_container) && effectiveVersion.FinalOrFutureInt() >= 36 && ctx.Config().UseDexV41() {
Ulya Trofimovich5bb46812024-08-07 19:25:58 +0000270 // W is 36, but we have not bumped the SDK version yet, so check for both.
271 if ctx.Config().PlatformSdkVersion().FinalInt() >= 36 ||
David Srbecky55b46b02024-11-26 17:16:16 +0000272 ctx.Config().PlatformSdkCodename() == "Baklava" {
273 flags = append([]string{"-JDcom.android.tools.r8.dexContainerExperiment"}, flags...)
Ulya Trofimovich5bb46812024-08-07 19:25:58 +0000274 }
275 }
Colin Cross83bb3162018-06-25 15:48:06 -0700276
Ian Zernyc26029b2023-08-25 13:43:44 +0200277 // If the specified SDK level is 10000, then configure the compiler to use the
278 // current platform SDK level and to compile the build as a platform build.
279 var minApiFlagValue = effectiveVersion.FinalOrFutureInt()
280 if minApiFlagValue == 10000 {
281 minApiFlagValue = ctx.Config().PlatformSdkVersion().FinalInt()
282 addAndroidPlatformBuildFlag = true
283 }
284 flags = append(flags, "--min-api "+strconv.Itoa(minApiFlagValue))
285
286 if addAndroidPlatformBuildFlag {
287 flags = append(flags, "--android-platform-build")
288 }
Colin Cross5ea963e2021-09-16 19:13:43 -0700289 return flags, deps
Colin Crossf0056cb2017-12-22 15:56:08 -0800290}
291
Spandan Das3dbda182024-05-20 22:23:10 +0000292func (d *dexer) d8Flags(ctx android.ModuleContext, dexParams *compileDexParams) (d8Flags []string, d8Deps android.Paths, artProfileOutput *android.OutputPath) {
293 flags := dexParams.flags
Colin Crossc2557d12019-10-31 15:22:57 -0700294 d8Flags = append(d8Flags, flags.bootClasspath.FormRepeatedClassPath("--lib ")...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -0700295 d8Flags = append(d8Flags, flags.dexClasspath.FormRepeatedClassPath("--lib ")...)
Colin Crossffb657e2018-09-21 12:29:22 -0700296
Colin Cross6dab9bd2018-09-28 08:06:24 -0700297 d8Deps = append(d8Deps, flags.bootClasspath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -0700298 d8Deps = append(d8Deps, flags.dexClasspath...)
Colin Cross6dab9bd2018-09-28 08:06:24 -0700299
Spandan Das3dbda182024-05-20 22:23:10 +0000300 if flags, deps, profileOutput := d.addArtProfile(ctx, dexParams); profileOutput != nil {
301 d8Flags = append(d8Flags, flags...)
302 d8Deps = append(d8Deps, deps...)
303 artProfileOutput = profileOutput
304 }
305
306 return d8Flags, d8Deps, artProfileOutput
Colin Crossffb657e2018-09-21 12:29:22 -0700307}
308
Jared Duke91d0bee2024-11-14 23:10:09 +0000309func (d *dexer) r8Flags(ctx android.ModuleContext, dexParams *compileDexParams, debugMode bool) (r8Flags []string, r8Deps android.Paths, artProfileOutput *android.OutputPath) {
Spandan Das3dbda182024-05-20 22:23:10 +0000310 flags := dexParams.flags
Liz Kammera7a64f32020-07-09 15:16:41 -0700311 opt := d.dexProperties.Optimize
Colin Cross66dbc0b2017-12-28 12:23:20 -0800312
313 // When an app contains references to APIs that are not in the SDK specified by
314 // its LOCAL_SDK_VERSION for example added by support library or by runtime
Colin Crossbafb8972018-06-06 21:46:32 +0000315 // classes added by desugaring, we artifically raise the "SDK version" "linked" by
Colin Cross66dbc0b2017-12-28 12:23:20 -0800316 // ProGuard, to
317 // - suppress ProGuard warnings of referencing symbols unknown to the lower SDK version.
318 // - prevent ProGuard stripping subclass in the support library that extends class added in the higher SDK version.
319 // See b/20667396
Jared Duke22468442024-08-20 20:45:35 +0000320 // TODO(b/360905238): Remove SdkSystemServer exception after resolving missing class references.
321 if !dexParams.sdkVersion.Stable() || dexParams.sdkVersion.Kind == android.SdkSystemServer {
322 var proguardRaiseDeps classpath
323 ctx.VisitDirectDepsWithTag(proguardRaiseTag, func(m android.Module) {
324 if dep, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
325 proguardRaiseDeps = append(proguardRaiseDeps, dep.RepackagedHeaderJars...)
326 }
327 })
328 r8Flags = append(r8Flags, proguardRaiseDeps.FormJavaClassPath("-libraryjars"))
329 r8Deps = append(r8Deps, proguardRaiseDeps...)
330 }
Colin Cross66dbc0b2017-12-28 12:23:20 -0800331
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500332 r8Flags = append(r8Flags, flags.bootClasspath.FormJavaClassPath("-libraryjars"))
Colin Cross6dab9bd2018-09-28 08:06:24 -0700333 r8Deps = append(r8Deps, flags.bootClasspath...)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500334 r8Flags = append(r8Flags, flags.dexClasspath.FormJavaClassPath("-libraryjars"))
Colin Cross9bb9bfb2022-03-17 11:12:32 -0700335 r8Deps = append(r8Deps, flags.dexClasspath...)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500336
337 transitiveStaticLibsLookupMap := map[android.Path]bool{}
Colin Crossa14fb6a2024-10-23 16:57:06 -0700338 for _, jar := range d.transitiveStaticLibsHeaderJarsForR8.ToList() {
339 transitiveStaticLibsLookupMap[jar] = true
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500340 }
341 transitiveHeaderJars := android.Paths{}
Colin Crossa14fb6a2024-10-23 16:57:06 -0700342 for _, jar := range d.transitiveLibsHeaderJarsForR8.ToList() {
343 if _, ok := transitiveStaticLibsLookupMap[jar]; ok {
344 // don't include a lib if it is already packaged in the current JAR as a static lib
345 continue
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500346 }
Colin Crossa14fb6a2024-10-23 16:57:06 -0700347 transitiveHeaderJars = append(transitiveHeaderJars, jar)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -0500348 }
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 Adamsenc8fd1f12025-01-06 19:04:03 +0100373 if BoolDefault(opt.Ignore_library_extends_program, false) {
374 r8Flags = append(r8Flags, "--ignore-library-extends-program")
375 }
376
Christoffer Adamsen8ec5f612025-01-09 11:05:11 +0100377 if BoolDefault(opt.Keep_runtime_invisible_annotations, false) {
378 r8Flags = append(r8Flags, "--keep-runtime-invisible-annotations")
379 }
380
Christoffer Quist Adamsenf2d7b162020-08-24 15:56:16 +0200381 if BoolDefault(opt.Proguard_compatibility, true) {
382 r8Flags = append(r8Flags, "--force-proguard-compatibility")
Jared Dukeb832fbb2023-09-15 17:16:36 +0000383 }
384
Jared Duke91d0bee2024-11-14 23:10:09 +0000385 // Avoid unnecessary stack frame noise by only injecting source map ids for non-debug
386 // optimized or obfuscated targets.
387 if (Bool(opt.Optimize) || Bool(opt.Obfuscate)) && !debugMode {
Ian Zernyfc7df612021-11-02 15:37:06 +0100388 // TODO(b/213833843): Allow configuration of the prefix via a build variable.
389 var sourceFilePrefix = "go/retraceme "
390 var sourceFileTemplate = "\"" + sourceFilePrefix + "%MAP_ID\""
Jared Dukeb832fbb2023-09-15 17:16:36 +0000391 r8Flags = append(r8Flags, "--map-id-template", "%MAP_HASH")
392 r8Flags = append(r8Flags, "--source-file-template", sourceFileTemplate)
Christoffer Quist Adamsenf2d7b162020-08-24 15:56:16 +0200393 }
394
Colin Cross66dbc0b2017-12-28 12:23:20 -0800395 // TODO(ccross): Don't shrink app instrumentation tests by default.
396 if !Bool(opt.Shrink) {
397 r8Flags = append(r8Flags, "-dontshrink")
398 }
399
400 if !Bool(opt.Optimize) {
401 r8Flags = append(r8Flags, "-dontoptimize")
402 }
403
404 // TODO(ccross): error if obufscation + app instrumentation test.
405 if !Bool(opt.Obfuscate) {
406 r8Flags = append(r8Flags, "-dontobfuscate")
407 }
Colin Cross4b964c02018-10-15 16:18:06 -0700408 // TODO(ccross): if this is an instrumentation test of an obfuscated app, use the
409 // dictionary of the app and move the app from libraryjars to injars.
Colin Cross66dbc0b2017-12-28 12:23:20 -0800410
Christoffer Quist Adamsene8507372021-02-22 09:44:09 +0100411 // TODO(b/180878971): missing classes should be added to the relevant builds.
Ajinkya Chalkeddad41b2023-02-09 14:09:58 +0000412 // TODO(b/229727645): do not use true as default for Android platform builds.
413 if proptools.BoolDefault(opt.Ignore_warnings, true) {
Remi NGUYEN VANbdad3142022-08-04 13:19:03 +0900414 r8Flags = append(r8Flags, "-ignorewarnings")
415 }
Christoffer Quist Adamsene8507372021-02-22 09:44:09 +0100416
Rico Winda2fa2632024-03-13 13:09:17 +0100417 // resourcesInput is empty when we don't use resource shrinking, if on, pass these to R8
Rico Wind98e7fa82023-11-27 09:44:03 +0100418 if d.resourcesInput.Valid() {
419 r8Flags = append(r8Flags, "--resource-input", d.resourcesInput.Path().String())
420 r8Deps = append(r8Deps, d.resourcesInput.Path())
421 r8Flags = append(r8Flags, "--resource-output", d.resourcesOutput.Path().String())
Rico Winda7b38592024-08-26 12:10:44 +0200422 if d.dexProperties.optimizedResourceShrinkingEnabled(ctx) {
Rico Winda2fa2632024-03-13 13:09:17 +0100423 r8Flags = append(r8Flags, "--optimized-resource-shrinking")
Rico Wind619ed5c2024-10-22 14:00:23 +0200424 if Bool(d.dexProperties.Optimize.Optimized_shrink_resources) {
425 // Explicitly opted into optimized shrinking, no need for keeping R$id entries
426 r8Flags = append(r8Flags, "--force-optimized-resource-shrinking")
427 }
Rico Winda2fa2632024-03-13 13:09:17 +0100428 }
Rico Wind98e7fa82023-11-27 09:44:03 +0100429 }
430
Spandan Das3dbda182024-05-20 22:23:10 +0000431 if flags, deps, profileOutput := d.addArtProfile(ctx, dexParams); profileOutput != nil {
432 r8Flags = append(r8Flags, flags...)
433 r8Deps = append(r8Deps, deps...)
434 artProfileOutput = profileOutput
435 }
436
Christoffer Adamsenb81fc912024-12-17 14:30:47 +0100437 if ctx.Config().UseR8StoreStoreFenceConstructorInlining() {
438 r8Flags = append(r8Flags, "--store-store-fence-constructor-inlining")
439 }
440
Spandan Das3dbda182024-05-20 22:23:10 +0000441 return r8Flags, r8Deps, artProfileOutput
Colin Cross66dbc0b2017-12-28 12:23:20 -0800442}
443
Spandan Dasc404cc72023-02-23 18:05:05 +0000444type compileDexParams struct {
Spandan Das3dbda182024-05-20 22:23:10 +0000445 flags javaBuilderFlags
446 sdkVersion android.SdkSpec
447 minSdkVersion android.ApiLevel
448 classesJar android.Path
449 jarName string
450 artProfileInput *string
Spandan Dasc404cc72023-02-23 18:05:05 +0000451}
452
Spandan Das3dbda182024-05-20 22:23:10 +0000453// Adds --art-profile to r8/d8 command.
454// r8/d8 will output a generated profile file to match the optimized dex code.
455func (d *dexer) addArtProfile(ctx android.ModuleContext, dexParams *compileDexParams) (flags []string, deps android.Paths, artProfileOutputPath *android.OutputPath) {
Cole Faust4e9f5922024-11-13 16:09:23 -0800456 if dexParams.artProfileInput == nil {
457 return nil, nil, nil
Spandan Das3dbda182024-05-20 22:23:10 +0000458 }
Cole Faust4e9f5922024-11-13 16:09:23 -0800459 artProfileInputPath := android.PathForModuleSrc(ctx, *dexParams.artProfileInput)
460 artProfileOutputPathValue := android.PathForModuleOut(ctx, "profile.prof.txt").OutputPath
461 artProfileOutputPath = &artProfileOutputPathValue
462 flags = []string{
463 "--art-profile",
464 artProfileInputPath.String(),
465 artProfileOutputPath.String(),
466 }
467 deps = append(deps, artProfileInputPath)
Spandan Das3dbda182024-05-20 22:23:10 +0000468 return flags, deps, artProfileOutputPath
469
470}
471
472// Return the compiled dex jar and (optional) profile _after_ r8 optimization
Colin Cross7707b242024-07-26 12:02:36 -0700473func (d *dexer) compileDex(ctx android.ModuleContext, dexParams *compileDexParams) (android.Path, android.Path) {
Colin Crossf0056cb2017-12-22 15:56:08 -0800474
Colin Crossf0056cb2017-12-22 15:56:08 -0800475 // Compile classes.jar into classes.dex and then javalib.jar
Spandan Dasc404cc72023-02-23 18:05:05 +0000476 javalibJar := android.PathForModuleOut(ctx, "dex", dexParams.jarName).OutputPath
Colin Crossf0056cb2017-12-22 15:56:08 -0800477 outDir := android.PathForModuleOut(ctx, "dex")
478
Sasha Smundakd3cf4ee2019-02-15 10:14:23 -0800479 zipFlags := "--ignore_missing_files"
Liz Kammera7a64f32020-07-09 15:16:41 -0700480 if proptools.Bool(d.dexProperties.Uncompress_dex) {
Sasha Smundakd3cf4ee2019-02-15 10:14:23 -0800481 zipFlags += " -L 0"
Colin Cross5a0dcd52018-10-05 14:20:06 -0700482 }
483
Spandan Dasc404cc72023-02-23 18:05:05 +0000484 commonFlags, commonDeps := d.dexCommonFlags(ctx, dexParams)
Liz Kammera7a64f32020-07-09 15:16:41 -0700485
Wei Li1e73c652021-12-06 13:35:11 -0800486 // Exclude kotlinc generated files when "exclude_kotlinc_generated_files" is set to true.
487 mergeZipsFlags := ""
488 if proptools.BoolDefault(d.dexProperties.Exclude_kotlinc_generated_files, false) {
489 mergeZipsFlags = "-stripFile META-INF/*.kotlin_module -stripFile **/*.kotlin_builtins"
490 }
491
Liz Kammera7a64f32020-07-09 15:16:41 -0700492 useR8 := d.effectiveOptimizeEnabled()
Spandan Das3dbda182024-05-20 22:23:10 +0000493 var artProfileOutputPath *android.OutputPath
Colin Cross66dbc0b2017-12-28 12:23:20 -0800494 if useR8 {
Colin Crossc0c664c2018-05-16 16:47:21 -0700495 proguardDictionary := android.PathForModuleOut(ctx, "proguard_dictionary")
Liz Kammera7a64f32020-07-09 15:16:41 -0700496 d.proguardDictionary = android.OptionalPathForPath(proguardDictionary)
Ian Zerny82044f12023-01-25 12:11:27 +0100497 proguardConfiguration := android.PathForModuleOut(ctx, "proguard_configuration")
498 d.proguardConfiguration = android.OptionalPathForPath(proguardConfiguration)
Colin Crosscb6143a2020-08-14 17:39:29 -0700499 proguardUsageDir := android.PathForModuleOut(ctx, "proguard_usage")
500 proguardUsage := proguardUsageDir.Join(ctx, ctx.Namespace().Path,
501 android.ModuleNameWithPossibleOverride(ctx), "unused.txt")
502 proguardUsageZip := android.PathForModuleOut(ctx, "proguard_usage.zip")
503 d.proguardUsageZip = android.OptionalPathForPath(proguardUsageZip)
Rico Wind98e7fa82023-11-27 09:44:03 +0100504 resourcesOutput := android.PathForModuleOut(ctx, "package-res-shrunken.apk")
505 d.resourcesOutput = android.OptionalPathForPath(resourcesOutput)
Spandan Das3dbda182024-05-20 22:23:10 +0000506 implicitOutputs := android.WritablePaths{
507 proguardDictionary,
508 proguardUsageZip,
509 proguardConfiguration,
510 }
Jared Duke91d0bee2024-11-14 23:10:09 +0000511 debugMode := android.InList("--debug", commonFlags)
512 r8Flags, r8Deps, r8ArtProfileOutputPath := d.r8Flags(ctx, dexParams, debugMode)
Ramy Medhat1dcc27e2020-04-21 21:36:23 -0400513 rule := r8
514 args := map[string]string{
Wei Li1e73c652021-12-06 13:35:11 -0800515 "r8Flags": strings.Join(append(commonFlags, r8Flags...), " "),
516 "zipFlags": zipFlags,
517 "outDict": proguardDictionary.String(),
Ian Zerny82044f12023-01-25 12:11:27 +0100518 "outConfig": proguardConfiguration.String(),
Wei Li1e73c652021-12-06 13:35:11 -0800519 "outUsageDir": proguardUsageDir.String(),
520 "outUsage": proguardUsage.String(),
521 "outUsageZip": proguardUsageZip.String(),
522 "outDir": outDir.String(),
Wei Li1e73c652021-12-06 13:35:11 -0800523 "mergeZipsFlags": mergeZipsFlags,
Ramy Medhat1dcc27e2020-04-21 21:36:23 -0400524 }
Spandan Dasd447bbb2024-06-24 17:13:30 +0000525 if r8ArtProfileOutputPath != nil {
526 artProfileOutputPath = r8ArtProfileOutputPath
527 implicitOutputs = append(
528 implicitOutputs,
529 artProfileOutputPath,
530 )
531 // Add the implicit r8 Art profile output to args so that r8RE knows
532 // about this implicit output
533 args["outR8ArtProfile"] = artProfileOutputPath.String()
534 }
535
Ramy Medhat16f23a42020-09-03 01:29:49 -0400536 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_R8") {
Ramy Medhat1dcc27e2020-04-21 21:36:23 -0400537 rule = r8RE
538 args["implicits"] = strings.Join(r8Deps.Strings(), ",")
539 }
Rico Wind98e7fa82023-11-27 09:44:03 +0100540 if d.resourcesInput.Valid() {
541 implicitOutputs = append(implicitOutputs, resourcesOutput)
542 args["resourcesOutput"] = resourcesOutput.String()
543 }
Colin Cross66dbc0b2017-12-28 12:23:20 -0800544 ctx.Build(pctx, android.BuildParams{
Rico Wind98e7fa82023-11-27 09:44:03 +0100545 Rule: rule,
546 Description: "r8",
547 Output: javalibJar,
548 ImplicitOutputs: implicitOutputs,
549 Input: dexParams.classesJar,
550 Implicits: r8Deps,
551 Args: args,
Colin Cross66dbc0b2017-12-28 12:23:20 -0800552 })
553 } else {
Spandan Das3dbda182024-05-20 22:23:10 +0000554 implicitOutputs := android.WritablePaths{}
555 d8Flags, d8Deps, d8ArtProfileOutputPath := d.d8Flags(ctx, dexParams)
556 if d8ArtProfileOutputPath != nil {
557 artProfileOutputPath = d8ArtProfileOutputPath
558 implicitOutputs = append(
559 implicitOutputs,
560 artProfileOutputPath,
561 )
562 }
Colin Cross5ea963e2021-09-16 19:13:43 -0700563 d8Deps = append(d8Deps, commonDeps...)
Ramy Medhat1dcc27e2020-04-21 21:36:23 -0400564 rule := d8
Ramy Medhat16f23a42020-09-03 01:29:49 -0400565 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_D8") {
Ramy Medhat1dcc27e2020-04-21 21:36:23 -0400566 rule = d8RE
567 }
Colin Cross66dbc0b2017-12-28 12:23:20 -0800568 ctx.Build(pctx, android.BuildParams{
Spandan Das3dbda182024-05-20 22:23:10 +0000569 Rule: rule,
570 Description: "d8",
571 Output: javalibJar,
572 Input: dexParams.classesJar,
573 ImplicitOutputs: implicitOutputs,
574 Implicits: d8Deps,
Colin Cross66dbc0b2017-12-28 12:23:20 -0800575 Args: map[string]string{
Wei Li1e73c652021-12-06 13:35:11 -0800576 "d8Flags": strings.Join(append(commonFlags, d8Flags...), " "),
577 "zipFlags": zipFlags,
578 "outDir": outDir.String(),
Wei Li1e73c652021-12-06 13:35:11 -0800579 "mergeZipsFlags": mergeZipsFlags,
Colin Cross66dbc0b2017-12-28 12:23:20 -0800580 },
581 })
Colin Crossf0056cb2017-12-22 15:56:08 -0800582 }
Liz Kammera7a64f32020-07-09 15:16:41 -0700583 if proptools.Bool(d.dexProperties.Uncompress_dex) {
Spandan Dasc404cc72023-02-23 18:05:05 +0000584 alignedJavalibJar := android.PathForModuleOut(ctx, "aligned", dexParams.jarName).OutputPath
Cole Faust51d7bfd2023-09-07 05:31:32 +0000585 TransformZipAlign(ctx, alignedJavalibJar, javalibJar, nil)
Nicolas Geoffray65fd8ba2019-01-21 23:20:23 +0000586 javalibJar = alignedJavalibJar
587 }
Colin Crossf0056cb2017-12-22 15:56:08 -0800588
Spandan Das3dbda182024-05-20 22:23:10 +0000589 return javalibJar, artProfileOutputPath
Colin Crossf0056cb2017-12-22 15:56:08 -0800590}