blob: c4fc21040b76d836413502888ecb1b556e0fbded [file] [log] [blame]
Jaewoong Jung26342642021-03-17 15:56:23 -07001// Copyright 2021 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 (
Yu Liu26a716d2024-08-30 23:40:32 +000018 "encoding/gob"
Jaewoong Jung26342642021-03-17 15:56:23 -070019 "fmt"
20 "path/filepath"
Joe Onorato349ae8d2024-02-05 22:46:00 +000021 "reflect"
22 "slices"
Jaewoong Jung26342642021-03-17 15:56:23 -070023 "strconv"
24 "strings"
25
Colin Crossd788b3e2023-11-28 13:14:56 -080026 "github.com/google/blueprint"
Colin Crossa14fb6a2024-10-23 16:57:06 -070027 "github.com/google/blueprint/depset"
Jaewoong Jung26342642021-03-17 15:56:23 -070028 "github.com/google/blueprint/pathtools"
29 "github.com/google/blueprint/proptools"
30
31 "android/soong/android"
32 "android/soong/dexpreopt"
33 "android/soong/java/config"
34)
35
36// This file contains the definition and the implementation of the base module that most
37// source-based Java module structs embed.
38
39// TODO:
40// Autogenerated files:
41// Renderscript
42// Post-jar passes:
43// Proguard
44// Rmtypedefs
45// DroidDoc
46// Findbugs
47
48// Properties that are common to most Java modules, i.e. whether it's a host or device module.
49type CommonProperties struct {
50 // list of source files used to compile the Java module. May be .java, .kt, .logtags, .proto,
51 // or .aidl files.
52 Srcs []string `android:"path,arch_variant"`
53
54 // list Kotlin of source files containing Kotlin code that should be treated as common code in
55 // a codebase that supports Kotlin multiplatform. See
56 // https://kotlinlang.org/docs/reference/multiplatform.html. May be only be .kt files.
57 Common_srcs []string `android:"path,arch_variant"`
58
59 // list of source files that should not be used to build the Java module.
60 // This is most useful in the arch/multilib variants to remove non-common files
61 Exclude_srcs []string `android:"path,arch_variant"`
62
63 // list of directories containing Java resources
64 Java_resource_dirs []string `android:"arch_variant"`
65
66 // list of directories that should be excluded from java_resource_dirs
67 Exclude_java_resource_dirs []string `android:"arch_variant"`
68
69 // list of files to use as Java resources
70 Java_resources []string `android:"path,arch_variant"`
71
72 // list of files that should be excluded from java_resources and java_resource_dirs
73 Exclude_java_resources []string `android:"path,arch_variant"`
74
75 // list of module-specific flags that will be used for javac compiles
76 Javacflags []string `android:"arch_variant"`
77
78 // list of module-specific flags that will be used for kotlinc compiles
79 Kotlincflags []string `android:"arch_variant"`
80
81 // list of java libraries that will be in the classpath
82 Libs []string `android:"arch_variant"`
83
84 // list of java libraries that will be compiled into the resulting jar
Cole Faustb7493472024-08-28 11:55:52 -070085 Static_libs proptools.Configurable[[]string] `android:"arch_variant"`
Jaewoong Jung26342642021-03-17 15:56:23 -070086
87 // manifest file to be included in resulting jar
88 Manifest *string `android:"path"`
89
90 // if not blank, run jarjar using the specified rules file
91 Jarjar_rules *string `android:"path,arch_variant"`
92
Joe Onoratoa5d17172024-07-20 17:39:56 -070093 // java class names to rename with jarjar when a reverse dependency has a jarjar_prefix
94 // property.
95 Jarjar_rename []string
96
Joe Onorato349ae8d2024-02-05 22:46:00 +000097 // if not blank, used as prefix to generate repackage rule
98 Jarjar_prefix *string
99
Jaewoong Jung26342642021-03-17 15:56:23 -0700100 // If not blank, set the java version passed to javac as -source and -target
101 Java_version *string
102
103 // If set to true, allow this module to be dexed and installed on devices. Has no
104 // effect on host modules, which are always considered installable.
105 Installable *bool
106
107 // If set to true, include sources used to compile the module in to the final jar
108 Include_srcs *bool
109
110 // If not empty, classes are restricted to the specified packages and their sub-packages.
111 // This restriction is checked after applying jarjar rules and including static libs.
112 Permitted_packages []string
113
114 // List of modules to use as annotation processors
115 Plugins []string
116
117 // List of modules to export to libraries that directly depend on this library as annotation
118 // processors. Note that if the plugins set generates_api: true this will disable the turbine
119 // optimization on modules that depend on this module, which will reduce parallelism and cause
120 // more recompilation.
121 Exported_plugins []string
122
123 // The number of Java source entries each Javac instance can process
124 Javac_shard_size *int64
125
126 // Add host jdk tools.jar to bootclasspath
127 Use_tools_jar *bool
128
129 Openjdk9 struct {
130 // List of source files that should only be used when passing -source 1.9 or higher
131 Srcs []string `android:"path"`
132
133 // List of javac flags that should only be used when passing -source 1.9 or higher
134 Javacflags []string
135 }
136
137 // When compiling language level 9+ .java code in packages that are part of
138 // a system module, patch_module names the module that your sources and
139 // dependencies should be patched into. The Android runtime currently
140 // doesn't implement the JEP 261 module system so this option is only
141 // supported at compile time. It should only be needed to compile tests in
142 // packages that exist in libcore and which are inconvenient to move
143 // elsewhere.
Liz Kammer0a470a32023-10-05 17:02:00 -0400144 Patch_module *string
Jaewoong Jung26342642021-03-17 15:56:23 -0700145
146 Jacoco struct {
147 // List of classes to include for instrumentation with jacoco to collect coverage
148 // information at runtime when building with coverage enabled. If unset defaults to all
149 // classes.
150 // Supports '*' as the last character of an entry in the list as a wildcard match.
151 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
152 // it matches classes in the package that have the class name as a prefix.
153 Include_filter []string
154
155 // List of classes to exclude from instrumentation with jacoco to collect coverage
156 // information at runtime when building with coverage enabled. Overrides classes selected
157 // by the include_filter property.
158 // Supports '*' as the last character of an entry in the list as a wildcard match.
159 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
160 // it matches classes in the package that have the class name as a prefix.
161 Exclude_filter []string
162 }
163
164 Errorprone struct {
165 // List of javac flags that should only be used when running errorprone.
166 Javacflags []string
167
168 // List of java_plugin modules that provide extra errorprone checks.
169 Extra_check_modules []string
Cole Faust75fffb12021-06-13 15:23:16 -0700170
Cole Faust2b1536e2021-06-18 12:25:54 -0700171 // This property can be in 3 states. When set to true, errorprone will
172 // be run during the regular build. When set to false, errorprone will
173 // never be run. When unset, errorprone will be run when the RUN_ERROR_PRONE
174 // environment variable is true. Setting this to false will improve build
175 // performance more than adding -XepDisableAllChecks in javacflags.
Cole Faust75fffb12021-06-13 15:23:16 -0700176 Enabled *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700177 }
178
179 Proto struct {
180 // List of extra options that will be passed to the proto generator.
181 Output_params []string
182 }
183
Sam Delmericoc7593722022-08-31 15:57:52 -0400184 // If true, then jacocoagent is automatically added as a libs dependency so that
185 // r8 will not strip instrumentation classes out of dexed libraries.
Jaewoong Jung26342642021-03-17 15:56:23 -0700186 Instrument bool `blueprint:"mutated"`
Paul Duffin0038a8d2022-05-03 00:28:40 +0000187 // If true, then the module supports statically including the jacocoagent
188 // into the library.
189 Supports_static_instrumentation bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700190
191 // List of files to include in the META-INF/services folder of the resulting jar.
192 Services []string `android:"path,arch_variant"`
193
194 // If true, package the kotlin stdlib into the jar. Defaults to true.
195 Static_kotlin_stdlib *bool `android:"arch_variant"`
196
197 // A list of java_library instances that provide additional hiddenapi annotations for the library.
198 Hiddenapi_additional_annotations []string
Joe Onorato175073c2023-06-01 14:42:59 -0700199
200 // Additional srcJars tacked in by GeneratedJavaLibraryModule
201 Generated_srcjars []android.Path `android:"mutated"`
Mark Whitea15790a2023-08-22 21:28:11 +0000202
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000203 // intermediate aconfig cache file tacked in by GeneratedJavaLibraryModule
204 Aconfig_Cache_files []android.Path `android:"mutated"`
205
Mark Whitea15790a2023-08-22 21:28:11 +0000206 // If true, then only the headers are built and not the implementation jar.
Liz Kammer60772632023-10-05 17:18:44 -0400207 Headers_only *bool
Cole Faust2b64af82023-12-13 18:22:18 -0800208
209 // A list of files or dependencies to make available to the build sandbox. This is
210 // useful if source files are symlinks, the targets of the symlinks must be listed here.
211 // Note that currently not all actions implemented by android_apps are sandboxed, so you
212 // may only see this being necessary in lint builds.
213 Compile_data []string `android:"path"`
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000214
215 // Property signifying whether the module compiles stubs or not.
216 // Should be set to true when srcs of this module are stub files.
217 // This property does not need to be set to true when the module depends on
218 // the stubs via libs, but should be set to true when the module depends on
219 // the stubs via static libs.
220 Is_stubs_module *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700221
Makoto Onuki7ded3822024-03-28 14:42:20 -0700222 Ravenizer struct {
John Wu989ee842024-10-04 00:21:43 +0000223 // If true, enable the "Ravenizer" tool on the output jar.
224 // "Ravenizer" is a tool for Ravenwood tests, but it can also be enabled on other kinds
225 // of java targets.
Makoto Onuki7ded3822024-03-28 14:42:20 -0700226 Enabled *bool
John Wu989ee842024-10-04 00:21:43 +0000227
228 // If true, the "Ravenizer" tool will remove all Mockito and DexMaker
229 // classes from the output jar.
230 Strip_mockito *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700231 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +0000232
233 // Contributing api surface of the stub module. Is not visible to bp modules, and should
234 // only be set for stub submodules generated by the java_sdk_library
235 Stub_contributing_api *string `blueprint:"mutated"`
Yihan Dong8be09c22024-08-29 15:32:13 +0800236
237 // If true, enable the "ApiMapper" tool on the output jar. "ApiMapper" is a tool to inject
238 // bytecode to log API calls.
239 ApiMapper bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700240}
241
242// Properties that are specific to device modules. Host module factories should not add these when
243// constructing a new module.
244type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000245 // If not blank, set to the version of the sdk to compile against.
Spandan Das1ccf5742022-10-14 16:51:23 +0000246 // Defaults to an empty string, which compiles the module against the private platform APIs.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000247 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000248 // 1) numerical API level, "current", "none", or "core_platform"
249 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
250 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
251 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700252 Sdk_version *string
253
satayev0a420e72021-11-29 17:25:52 +0000254 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
255 // Defaults to empty string "". See sdk_version for possible values.
256 Max_sdk_version *string
257
William Loh5a082f92022-05-17 20:21:50 +0000258 // if not blank, set the maxSdkVersion properties of permission and uses-permission tags.
259 // Defaults to empty string "". See sdk_version for possible values.
260 Replace_max_sdk_version_placeholder *string
261
Jaewoong Jung26342642021-03-17 15:56:23 -0700262 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000263 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700264 Target_sdk_version *string
265
266 // Whether to compile against the platform APIs instead of an SDK.
267 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000268 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700269 Platform_apis *bool
270
271 Aidl struct {
272 // Top level directories to pass to aidl tool
273 Include_dirs []string
274
275 // Directories rooted at the Android.bp file to pass to aidl tool
276 Local_include_dirs []string
277
278 // directories that should be added as include directories for any aidl sources of modules
279 // that depend on this module, as well as to aidl for this module.
280 Export_include_dirs []string
281
282 // whether to generate traces (for systrace) for this interface
283 Generate_traces *bool
284
285 // whether to generate Binder#GetTransaction name method.
286 Generate_get_transaction_name *bool
287
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100288 // whether all interfaces should be annotated with required permissions.
289 Enforce_permissions *bool
290
291 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
292 Enforce_permissions_exceptions []string `android:"path"`
293
Jaewoong Jung26342642021-03-17 15:56:23 -0700294 // list of flags that will be passed to the AIDL compiler
295 Flags []string
296 }
297
298 // If true, export a copy of the module as a -hostdex module for host testing.
299 Hostdex *bool
300
301 Target struct {
302 Hostdex struct {
303 // Additional required dependencies to add to -hostdex modules.
304 Required []string
305 }
306 }
307
308 // When targeting 1.9 and above, override the modules to use with --system,
309 // otherwise provides defaults libraries to add to the bootclasspath.
310 System_modules *string
311
Jaewoong Jung26342642021-03-17 15:56:23 -0700312 IsSDKLibrary bool `blueprint:"mutated"`
313
314 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
315 // Defaults to false.
316 V4_signature *bool
317
318 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
319 // public stubs library.
320 SyspropPublicStub string `blueprint:"mutated"`
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000321
322 HiddenAPIPackageProperties
323 HiddenAPIFlagFileProperties
Jaewoong Jung26342642021-03-17 15:56:23 -0700324}
325
yangbill2af0b6e2024-03-15 09:29:29 +0000326// Properties that can be overridden by overriding module (e.g. override_android_app)
327type OverridableProperties struct {
Jooyung Han01d80d82022-01-08 12:16:32 +0900328 // set the name of the output. If not set, `name` is used.
329 // To override a module with this property set, overriding module might need to set this as well.
330 // Otherwise, both the overridden and the overriding modules will have the same output name, which
331 // can cause the duplicate output error.
332 Stem *string
Spandan Dasb9c58352024-05-13 18:29:45 +0000333
334 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
335 // Defaults to sdk_version if not set. See sdk_version for possible values.
336 Min_sdk_version *string
Jooyung Han01d80d82022-01-08 12:16:32 +0900337}
338
Jaewoong Jung26342642021-03-17 15:56:23 -0700339// Functionality common to Module and Import
340//
341// It is embedded in Module so its functionality can be used by methods in Module
342// but it is currently only initialized by Import and Library.
343type embeddableInModuleAndImport struct {
344
345 // Functionality related to this being used as a component of a java_sdk_library.
346 EmbeddableSdkLibraryComponent
347}
348
Paul Duffin71b33cc2021-06-23 11:39:47 +0100349func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
350 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700351}
352
353// Module/Import's DepIsInSameApex(...) delegates to this method.
354//
355// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
356// the one provided by ApexModuleBase.
357func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
358 // dependencies other than the static linkage are all considered crossing APEX boundary
359 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
360 return true
361 }
362 return false
363}
364
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100365// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
366// or an invalid path describing the reason it is invalid.
367//
368// It is unset if a dex jar isn't applicable, i.e. no build rule has been
369// requested to create one.
370//
371// If a dex jar has been requested to be built then it is set, and it may be
372// either a valid android.Path, or invalid with a reason message. The latter
373// happens if the source that should produce the dex file isn't able to.
374//
375// E.g. it is invalid with a reason message if there is a prebuilt APEX that
376// could produce the dex jar through a deapexer module, but the APEX isn't
377// installable so doing so wouldn't be safe.
378type OptionalDexJarPath struct {
379 isSet bool
380 path android.OptionalPath
381}
382
383// IsSet returns true if a path has been set, either invalid or valid.
384func (o OptionalDexJarPath) IsSet() bool {
385 return o.isSet
386}
387
388// Valid returns true if there is a path that is valid.
389func (o OptionalDexJarPath) Valid() bool {
390 return o.isSet && o.path.Valid()
391}
392
393// Path returns the valid path, or panics if it's either not set or is invalid.
394func (o OptionalDexJarPath) Path() android.Path {
395 if !o.isSet {
396 panic("path isn't set")
397 }
398 return o.path.Path()
399}
400
401// PathOrNil returns the path if it's set and valid, or else nil.
402func (o OptionalDexJarPath) PathOrNil() android.Path {
403 if o.Valid() {
404 return o.Path()
405 }
406 return nil
407}
408
409// InvalidReason returns the reason for an invalid path, which is never "". It
410// returns "" for an unset or valid path.
411func (o OptionalDexJarPath) InvalidReason() string {
412 if !o.isSet {
413 return ""
414 }
415 return o.path.InvalidReason()
416}
417
418func (o OptionalDexJarPath) String() string {
419 if !o.isSet {
420 return "<unset>"
421 }
422 return o.path.String()
423}
424
425// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
426func makeUnsetDexJarPath() OptionalDexJarPath {
427 return OptionalDexJarPath{isSet: false}
428}
429
430// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
431// the given OptionalPath, which may be valid or invalid.
432func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
433 return OptionalDexJarPath{isSet: true, path: path}
434}
435
436// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
437// valid given path. It returns an unset OptionalDexJarPath if the given path is
438// nil.
439func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
440 if path == nil {
441 return makeUnsetDexJarPath()
442 }
443 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
444}
445
Jaewoong Jung26342642021-03-17 15:56:23 -0700446// Module contains the properties and members used by all java module types
447type Module struct {
448 android.ModuleBase
449 android.DefaultableModuleBase
450 android.ApexModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700451
452 // Functionality common to Module and Import.
453 embeddableInModuleAndImport
454
455 properties CommonProperties
456 protoProperties android.ProtoProperties
457 deviceProperties DeviceProperties
458
yangbill2af0b6e2024-03-15 09:29:29 +0000459 overridableProperties OverridableProperties
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700460 sourceProperties android.SourceProperties
Jooyung Han01d80d82022-01-08 12:16:32 +0900461
Jaewoong Jung26342642021-03-17 15:56:23 -0700462 // jar file containing header classes including static library dependencies, suitable for
463 // inserting into the bootclasspath/classpath of another compile
464 headerJarFile android.Path
465
466 // jar file containing implementation classes including static library dependencies but no
467 // resources
468 implementationJarFile android.Path
469
Jaewoong Jung26342642021-03-17 15:56:23 -0700470 // args and dependencies to package source files into a srcjar
471 srcJarArgs []string
472 srcJarDeps android.Paths
473
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000474 // the source files of this module and all its static dependencies
Colin Crossa14fb6a2024-10-23 16:57:06 -0700475 transitiveSrcFiles depset.DepSet[android.Path]
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000476
Jaewoong Jung26342642021-03-17 15:56:23 -0700477 // jar file containing implementation classes and resources including static library
478 // dependencies
479 implementationAndResourcesJar android.Path
480
481 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100482 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700483
484 // output file containing uninstrumented classes that will be instrumented by jacoco
485 jacocoReportClassesFile android.Path
486
487 // output file of the module, which may be a classes jar or a dex jar
488 outputFile android.Path
489 extraOutputFiles android.Paths
490
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100491 exportAidlIncludeDirs android.Paths
492 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700493
494 logtagsSrcs android.Paths
495
496 // installed file for binary dependency
497 installFile android.Path
498
Colin Cross3108ce12021-11-10 14:38:50 -0800499 // installed file for hostdex copy
500 hostdexInstallFile android.InstallPath
501
Chaohui Wangdcbe33c2022-10-11 11:13:30 +0800502 // list of unique .java and .kt source files
503 uniqueSrcFiles android.Paths
504
505 // list of srcjars that was passed to javac
506 compiledSrcJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700507
508 // manifest file to use instead of properties.Manifest
509 overrideManifest android.OptionalPath
510
Jaewoong Jung26342642021-03-17 15:56:23 -0700511 // list of plugins that this java module is exporting
512 exportedPluginJars android.Paths
513
514 // list of plugins that this java module is exporting
515 exportedPluginClasses []string
516
517 // if true, the exported plugins generate API and require disabling turbine.
518 exportedDisableTurbine bool
519
520 // list of source files, collected from srcFiles with unique java and all kt files,
521 // will be used by android.IDEInfo struct
522 expandIDEInfoCompiledSrcs []string
523
524 // expanded Jarjar_rules
525 expandJarjarRules android.Path
526
Joe Onorato349ae8d2024-02-05 22:46:00 +0000527 // jarjar rule for inherited jarjar rules
528 repackageJarjarRules android.Path
529
Jaewoong Jung26342642021-03-17 15:56:23 -0700530 // Extra files generated by the module type to be added as java resources.
531 extraResources android.Paths
532
533 hiddenAPI
534 dexer
535 dexpreopter
536 usesLibrary
537 linter
538
539 // list of the xref extraction files
Spandan Das1028d5a2024-08-19 21:45:48 +0000540 kytheFiles android.Paths
541 kytheKotlinFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700542
Jaewoong Jung26342642021-03-17 15:56:23 -0700543 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900544
545 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000546 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000547 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400548
549 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000550
551 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000552
553 // output file name based on Stem property.
554 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
555 // or the module should override Stem().
556 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700557
Joe Onorato349ae8d2024-02-05 22:46:00 +0000558 // Values that will be set in the JarJarProvider data for jarjar repackaging,
559 // and merged with our dependencies' rules.
560 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000561
562 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000563
564 // Paths to the aconfig intermediate cache files that are provided by the
565 // java_aconfig_library or java_library modules that are statically linked
566 // to this module. Does not contain cache files from all transitive dependencies.
567 aconfigCacheFiles android.Paths
Spandan Das8aac9932024-07-18 23:14:13 +0000568
569 // List of soong module dependencies required to compile the current module.
570 // This information is printed out to `Dependencies` field in module_bp_java_deps.json
571 compileDepNames []string
Makoto Onuki7ded3822024-03-28 14:42:20 -0700572
573 ravenizer struct {
574 enabled bool
575 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700576}
577
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000578var _ android.InstallableModule = (*Module)(nil)
579
580// To satisfy the InstallableModule interface
Jihoon Kang224ea082024-08-12 22:38:16 +0000581func (j *Module) StaticDependencyTags() []blueprint.DependencyTag {
582 return []blueprint.DependencyTag{staticLibTag}
583}
584
585// To satisfy the InstallableModule interface
586func (j *Module) DynamicDependencyTags() []blueprint.DependencyTag {
587 return []blueprint.DependencyTag{libTag, sdkLibTag, bootClasspathTag, systemModulesTag,
588 instrumentationForTag, java9LibTag}
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000589}
590
591// Overrides android.ModuleBase.InstallInProduct()
592func (j *Module) InstallInProduct() bool {
593 return j.ProductSpecific()
594}
595
Jihoon Kang85bc1932024-07-01 17:04:46 +0000596var _ android.StubsAvailableModule = (*Module)(nil)
597
598// To safisfy the StubsAvailableModule interface
599func (j *Module) IsStubsModule() bool {
600 return proptools.Bool(j.properties.Is_stubs_module)
601}
602
Jiyong Park92315372021-04-02 08:45:46 +0900603func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
604 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900605 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700606 return nil
607 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900608 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000609 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700610 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
611 } else {
612 // Treat stable core platform as stable.
613 return nil
614 }
615 } else {
616 return fmt.Errorf("non stable SDK %v", sdkVersion)
617 }
618}
619
620// checkSdkVersions enforces restrictions around SDK dependencies.
621func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
622 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900623 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900624 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700625 ctx.PropertyErrorf("sdk_version",
626 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
627 }
628 }
629 }
630
631 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
632 // See rank() for details.
633 ctx.VisitDirectDeps(func(module android.Module) {
634 tag := ctx.OtherModuleDependencyTag(module)
635 switch module.(type) {
636 // TODO(satayev): cover other types as well, e.g. imports
637 case *Library, *AndroidLibrary:
638 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400639 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700640 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
641 }
642 }
643 })
644}
645
646func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900647 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700648 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900649 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700650 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000651 ctx.PropertyErrorf("platform_apis", "This module has conflicting settings. sdk_version is not empty, which means this module cannot use platform APIs. However platform_apis is set to true.")
Jaewoong Jung26342642021-03-17 15:56:23 -0700652 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000653 ctx.PropertyErrorf("platform_apis", "This module has conflicting settings. sdk_version is empty, which means that this module is build against platform APIs. However platform_apis is not set to true")
Jaewoong Jung26342642021-03-17 15:56:23 -0700654 }
655
656 }
657}
658
Mark Whitea15790a2023-08-22 21:28:11 +0000659func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
660 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400661 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000662 installable := proptools.Bool(j.properties.Installable)
663
664 if headersOnly && installable {
665 ctx.PropertyErrorf("headers_only", "This module has conflicting settings. headers_only is true which, which means this module doesn't generate an implementation jar. However installable is set to true.")
666 }
667 }
668}
669
Jaewoong Jung26342642021-03-17 15:56:23 -0700670func (j *Module) addHostProperties() {
671 j.AddProperties(
672 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000673 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700674 &j.protoProperties,
675 &j.usesLibraryProperties,
676 )
677}
678
679func (j *Module) addHostAndDeviceProperties() {
680 j.addHostProperties()
681 j.AddProperties(
682 &j.deviceProperties,
683 &j.dexer.dexProperties,
684 &j.dexpreoptProperties,
685 &j.linter.properties,
686 )
687}
688
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000689// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
690// makes it available through the hiddenAPIPropertyInfoProvider.
691func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
692 hiddenAPIInfo := newHiddenAPIPropertyInfo()
693
694 // Populate with flag file paths from the properties.
695 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
696
697 // Populate with package rules from the properties.
698 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
699
Colin Cross40213022023-12-13 15:19:49 -0800700 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000701}
702
mrziwang9f7b9f42024-07-10 12:18:06 -0700703// helper method for java modules to set OutputFilesProvider
704func setOutputFiles(ctx android.ModuleContext, m Module) {
705 ctx.SetOutputFiles(append(android.Paths{m.outputFile}, m.extraOutputFiles...), "")
706 ctx.SetOutputFiles(android.Paths{m.outputFile}, android.DefaultDistTag)
707 ctx.SetOutputFiles(android.Paths{m.implementationAndResourcesJar}, ".jar")
708 ctx.SetOutputFiles(android.Paths{m.headerJarFile}, ".hjar")
709 if m.dexer.proguardDictionary.Valid() {
710 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
711 }
712 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
Jaewoong Jung26342642021-03-17 15:56:23 -0700713}
714
Jaewoong Jung26342642021-03-17 15:56:23 -0700715func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
716 initJavaModule(module, hod, false)
717}
718
719func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
720 initJavaModule(module, hod, true)
721}
722
723func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
724 multilib := android.MultilibCommon
725 if multiTargets {
726 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
727 } else {
728 android.InitAndroidArchModule(module, hod, multilib)
729 }
730 android.InitDefaultableModule(module)
731}
732
733func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
734 return j.properties.Instrument &&
735 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
736 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
737}
738
Yihan Dong8be09c22024-08-29 15:32:13 +0800739func (j *Module) shouldApiMapper() bool {
740 return j.properties.ApiMapper
741}
742
Jaewoong Jung26342642021-03-17 15:56:23 -0700743func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000744 return j.properties.Supports_static_instrumentation &&
745 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700746 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
747 ctx.Config().UnbundledBuild())
748}
749
750func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
751 // Force enable the instrumentation for java code that is built for APEXes ...
752 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
753 // doesn't make sense) or framework libraries (e.g. libraries found in the InstrumentFrameworkModules list) unless EMMA_INSTRUMENT_FRAMEWORK is true.
Colin Crossff694a82023-12-13 15:54:49 -0800754 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700755 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000756
Jihoon Kang46d66de2024-05-22 22:42:39 +0000757 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700758 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
759 return true
760 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
761 return true
762 }
763 }
764 return false
765}
766
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400767func (j *Module) setInstrument(value bool) {
768 j.properties.Instrument = value
769}
770
Yihan Dong8be09c22024-08-29 15:32:13 +0800771func (j *Module) setApiMapper(value bool) {
772 j.properties.ApiMapper = value
773}
774
Jiyong Park92315372021-04-02 08:45:46 +0900775func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
776 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700777}
778
Jiyong Parkf1691d22021-03-29 20:11:58 +0900779func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700780 return proptools.String(j.deviceProperties.System_modules)
781}
782
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000783func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000784 if j.overridableProperties.Min_sdk_version != nil {
785 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700786 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000787 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700788}
789
Yu Liuf2b94012023-09-19 15:09:10 -0700790func (j *Module) GetDeviceProperties() *DeviceProperties {
791 return &j.deviceProperties
792}
793
Spandan Dasa26eda72023-03-02 00:56:06 +0000794func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
795 if j.deviceProperties.Max_sdk_version != nil {
796 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
797 }
798 // Default is PrivateApiLevel
799 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000800}
801
Spandan Dasa26eda72023-03-02 00:56:06 +0000802func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
803 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
804 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
805 }
806 // Default is PrivateApiLevel
807 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000808}
809
Jiyong Parkf1691d22021-03-29 20:11:58 +0900810func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000811 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900812}
813
Spandan Dasca70fc42023-03-01 23:38:49 +0000814func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900815 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000816 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900817 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000818 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700819}
820
821func (j *Module) AvailableFor(what string) bool {
822 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
823 // Exception: for hostdex: true libraries, the platform variant is created
824 // even if it's not marked as available to platform. In that case, the platform
825 // variant is used only for the hostdex and not installed to the device.
826 return true
827 }
828 return j.ApexModuleBase.AvailableFor(what)
829}
830
Cole Faustb7493472024-08-28 11:55:52 -0700831func (j *Module) staticLibs(ctx android.BaseModuleContext) []string {
Jihoon Kang8bce3812024-09-30 18:46:51 +0000832 return j.properties.Static_libs.GetOrDefault(ctx, nil)
Cole Faustb7493472024-08-28 11:55:52 -0700833}
834
Jaewoong Jung26342642021-03-17 15:56:23 -0700835func (j *Module) deps(ctx android.BottomUpMutatorContext) {
836 if ctx.Device() {
837 j.linter.deps(ctx)
838
Jiyong Parkf1691d22021-03-29 20:11:58 +0900839 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700840
841 if j.deviceProperties.SyspropPublicStub != "" {
842 // This is a sysprop implementation library that has a corresponding sysprop public
843 // stubs library, and a dependency on it so that dependencies on the implementation can
844 // be forwarded to the public stubs library when necessary.
845 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
846 }
847 }
848
849 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000850
Cole Faustb7493472024-08-28 11:55:52 -0700851 ctx.AddVariationDependencies(nil, staticLibTag, j.staticLibs(ctx)...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700852
853 // Add dependency on libraries that provide additional hidden api annotations.
854 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
855
Jaewoong Jung26342642021-03-17 15:56:23 -0700856 // For library dependencies that are component libraries (like stubs), add the implementation
857 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
858 for _, dep := range libDeps {
859 if dep != nil {
860 if component, ok := dep.(SdkLibraryComponentDependency); ok {
861 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000862 // Add library as optional if it's one of the optional compatibility libs or it's
863 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100864 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000865 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
Cole Faust64f2d842024-10-17 13:28:34 -0700866 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs.GetOrDefault(ctx, nil)) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100867 tag = usesLibOptTag
868 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100869 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700870 }
871 }
872 }
873 }
874
875 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
876 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
877 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
878
879 android.ProtoDeps(ctx, &j.protoProperties)
880 if j.hasSrcExt(".proto") {
881 protoDeps(ctx, &j.protoProperties)
882 }
883
884 if j.hasSrcExt(".kt") {
885 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
886 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700887 tag := staticLibTag
888 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
889 tag = libTag
890 }
891 ctx.AddVariationDependencies(nil, tag,
892 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700893 }
894
895 // Framework libraries need special handling in static coverage builds: they should not have
896 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
897 // the same jacoco classes coming from different bootclasspath jars.
898 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
899 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
900 j.properties.Instrument = true
901 }
902 } else if j.shouldInstrumentStatic(ctx) {
903 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
904 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700905
Cole Faustb7493472024-08-28 11:55:52 -0700906 if j.useCompose(ctx) {
Colin Crossa1ff7c62021-09-17 14:11:52 -0700907 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
908 "androidx.compose.compiler_compiler-hosted")
909 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700910}
911
912func hasSrcExt(srcs []string, ext string) bool {
913 for _, src := range srcs {
914 if filepath.Ext(src) == ext {
915 return true
916 }
917 }
918
919 return false
920}
921
922func (j *Module) hasSrcExt(ext string) bool {
923 return hasSrcExt(j.properties.Srcs, ext)
924}
925
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100926func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
927 var flags string
928
929 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
930 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
931 flags = "-Wmissing-permission-annotation -Werror"
932 }
933 }
934 return flags
935}
936
Jaewoong Jung26342642021-03-17 15:56:23 -0700937func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000938 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700939
940 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
941 aidlIncludes = append(aidlIncludes,
942 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
943 aidlIncludes = append(aidlIncludes,
944 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
945
946 var flags []string
947 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000948 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700949
950 flags = append(flags, j.deviceProperties.Aidl.Flags...)
951
952 if aidlPreprocess.Valid() {
953 flags = append(flags, "-p"+aidlPreprocess.String())
954 deps = append(deps, aidlPreprocess.Path())
955 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000956 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700957 }
958
959 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000960 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700961 }
962
963 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000964 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700965 }
966
Sam Delmerico2351eac2022-05-24 17:10:02 +0000967 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700968 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000969 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700970 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000971 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
972 // add flags for dirs containing AIDL srcs that haven't been specified yet
973 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -0700974
Zim8774ae12022-08-17 11:46:34 +0100975 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +0000976 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +0100977 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700978 flags = append(flags, "-t")
979 }
980
981 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
982 flags = append(flags, "--transaction_names")
983 }
984
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100985 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
986 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
987 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
988 }
989
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000990 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +0900991 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
992
Jaewoong Jung26342642021-03-17 15:56:23 -0700993 return strings.Join(flags, " "), deps
994}
995
996func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
997
998 var flags javaBuilderFlags
999
1000 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001001 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001002
Cole Faust2b1536e2021-06-18 12:25:54 -07001003 epEnabled := j.properties.Errorprone.Enabled
1004 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001005 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001006 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1007 }
1008
1009 errorProneFlags := []string{
1010 "-Xplugin:ErrorProne",
1011 "${config.ErrorProneChecks}",
1012 }
1013 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1014
Colin Cross8bf6cad2022-02-28 13:07:03 -08001015 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001016 "'" + strings.Join(errorProneFlags, " ") + "'"
1017 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1018 }
1019
1020 // classpath
1021 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1022 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001023 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001024 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1025 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1026 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1027
1028 flags.processors = append(flags.processors, deps.processorClasses...)
1029 flags.processors = android.FirstUniqueStrings(flags.processors)
1030
1031 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001032 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001033 // Give host-side tools a version of OpenJDK's standard libraries
1034 // close to what they're targeting. As of Dec 2017, AOSP is only
1035 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1036 //
1037 // When building with OpenJDK 8, the following should have no
1038 // effect since those jars would be available by default.
1039 //
1040 // When building with OpenJDK 9 but targeting a version < 1.8,
1041 // putting them on the bootclasspath means that:
1042 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1043 // b) references to existing APIs are not reinterpreted in an
1044 // OpenJDK 9-specific way, eg. calls to subclasses of
1045 // java.nio.Buffer as in http://b/70862583
1046 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1047 flags.bootClasspath = append(flags.bootClasspath,
1048 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1049 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1050 if Bool(j.properties.Use_tools_jar) {
1051 flags.bootClasspath = append(flags.bootClasspath,
1052 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1053 }
1054 }
1055
1056 // systemModules
1057 flags.systemModules = deps.systemModules
1058
Jaewoong Jung26342642021-03-17 15:56:23 -07001059 return flags
1060}
1061
1062func (j *Module) collectJavacFlags(
1063 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1064 // javac flags.
1065 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001066 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001067
Mythri Alle4b9f6182023-10-25 15:17:11 +00001068 needsDebugInfo = false
1069 for _, flag := range javacFlags {
1070 if strings.HasPrefix(flag, "-g") {
1071 needsDebugInfo = true
1072 }
1073 }
1074
1075 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001076 // For non-host binaries, override the -g flag passed globally to remove
1077 // local variable debug info to reduce disk and memory usage.
1078 javacFlags = append(javacFlags, "-g:source,lines")
1079 }
1080 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1081
1082 if flags.javaVersion.usesJavaModules() {
1083 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001084 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1085 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1086 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1087 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001088
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001089 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001090 if j.properties.Patch_module != nil {
1091 // Manually specify build directory in case it is not under the repo root.
1092 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1093 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001094 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001095
Jaewoong Jung26342642021-03-17 15:56:23 -07001096 classPath := flags.classpath.FormJavaClassPath("")
1097 if classPath != "" {
1098 patchPaths = append(patchPaths, classPath)
1099 }
1100 javacFlags = append(
1101 javacFlags,
1102 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1103 }
1104 }
1105
1106 if len(javacFlags) > 0 {
1107 // optimization.
1108 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1109 flags.javacFlags = "$javacFlags"
1110 }
1111
1112 return flags
1113}
1114
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001115func (j *Module) AddJSONData(d *map[string]interface{}) {
1116 (&j.ModuleBase).AddJSONData(d)
1117 (*d)["Java"] = map[string]interface{}{
1118 "SourceExtensions": j.sourceExtensions,
1119 }
1120
1121}
1122
usta0391ca42023-09-19 15:51:59 -04001123func (j *Module) addGeneratedSrcJars(path android.Path) {
1124 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001125}
1126
Colin Crossfdaa6722024-08-23 11:58:08 -07001127func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars, extraDepCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001128 // Auto-propagating jarjar rules
1129 jarjarProviderData := j.collectJarJarRules(ctx)
1130 if jarjarProviderData != nil {
1131 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wangddb2ee52024-04-02 16:44:02 +00001132 text := getJarJarRuleText(jarjarProviderData)
1133 if text != "" {
1134 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1135 android.WriteFileRule(ctx, ruleTextFile, text)
1136 j.repackageJarjarRules = ruleTextFile
Joe Onorato349ae8d2024-02-05 22:46:00 +00001137 }
1138 }
1139
Jaewoong Jung26342642021-03-17 15:56:23 -07001140 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1141
John Wu989ee842024-10-04 00:21:43 +00001142 // Only override the original value if explicitly set
1143 if j.properties.Ravenizer.Enabled != nil {
1144 j.ravenizer.enabled = *j.properties.Ravenizer.Enabled
Makoto Onuki7ded3822024-03-28 14:42:20 -07001145 }
1146
Jaewoong Jung26342642021-03-17 15:56:23 -07001147 deps := j.collectDeps(ctx)
1148 flags := j.collectBuilderFlags(ctx, deps)
1149
1150 if flags.javaVersion.usesJavaModules() {
1151 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001152 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1153 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1154 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001155 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001156
Jaewoong Jung26342642021-03-17 15:56:23 -07001157 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001158 j.sourceExtensions = []string{}
1159 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1160 if hasSrcExt(srcFiles.Strings(), ext) {
1161 j.sourceExtensions = append(j.sourceExtensions, ext)
1162 }
1163 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001164 if hasSrcExt(srcFiles.Strings(), ".proto") {
1165 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1166 }
1167
1168 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1169 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1170 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1171 }
1172
Sam Delmerico2351eac2022-05-24 17:10:02 +00001173 aidlSrcs := srcFiles.FilterByExt(".aidl")
1174 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1175
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001176 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001177 srcFiles = j.genSources(ctx, srcFiles, flags)
1178
1179 // Collect javac flags only after computing the full set of srcFiles to
1180 // ensure that the --patch-module lookup paths are complete.
1181 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1182
1183 srcJars := srcFiles.FilterByExt(".srcjar")
1184 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001185 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001186 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001187 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001188
1189 if j.properties.Jarjar_rules != nil {
1190 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1191 }
1192
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001193 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001194
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001195 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001196 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001197 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001198 if _, found := set[v.String()]; !found {
1199 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001200 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001201 }
1202 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001203 var uniqueKtFiles android.Paths
1204 for _, v := range srcFiles.FilterByExt(".kt") {
1205 if _, found := set[v.String()]; !found {
1206 set[v.String()] = true
1207 uniqueKtFiles = append(uniqueKtFiles, v)
1208 }
1209 }
1210
1211 var uniqueSrcFiles android.Paths
1212 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1213 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1214 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001215 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001216
Colin Crossb5db4012022-03-28 17:12:39 -07001217 // We don't currently run annotation processors in turbine, which means we can't use turbine
1218 // generated header jars when an annotation processor that generates API is enabled. One
1219 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1220 // is used to run all of the annotation processors.
1221 disableTurbine := deps.disableTurbine
1222
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001223 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001224 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1225
Colin Cross220a9a12022-03-28 17:08:01 -07001226 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001227
Colin Cross4eae06d2023-06-20 22:40:02 -07001228 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1229 // any dependencies so that it can override any non-final R classes from dependencies with the
1230 // final R classes from the app.
1231 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1232
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001233 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1234
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001235 var localImplementationJars android.Paths
1236
Mark Whitea15790a2023-08-22 21:28:11 +00001237 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001238 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001239 if srcFiles.HasExt(".kt") {
1240 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1241 }
1242 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1243 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1244 }
1245
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001246 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1247
1248 localHeaderJars, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
Colin Crossedec77c2024-07-26 15:25:40 -07001249 extraCombinedJars)
1250
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001251 combinedHeaderJarFile, jarjared := j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1252 if jarjared {
1253 localHeaderJars = android.Paths{combinedHeaderJarFile}
1254 transitiveStaticLibsHeaderJars = nil
1255 }
1256 combinedHeaderJarFile, repackaged := j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
1257 if repackaged {
1258 localHeaderJars = android.Paths{combinedHeaderJarFile}
1259 transitiveStaticLibsHeaderJars = nil
1260 }
Mark Whitea15790a2023-08-22 21:28:11 +00001261 if ctx.Failed() {
1262 return
1263 }
Colin Crossedec77c2024-07-26 15:25:40 -07001264 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001265
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001266 if ctx.Config().UseTransitiveJarsInClasspath() {
1267 if len(localHeaderJars) > 0 {
1268 ctx.CheckbuildFile(localHeaderJars...)
1269 } else {
1270 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1271 ctx.UncheckedModule()
1272 }
1273 } else {
1274 ctx.CheckbuildFile(j.headerJarFile)
1275 }
Colin Crossa6182ab2024-08-21 10:47:44 -07001276
Colin Cross7727c7f2024-07-18 15:36:32 -07001277 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001278 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001279 LocalHeaderJars: localHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001280 TransitiveStaticLibsHeaderJars: depset.New(depset.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Cross9ffaf282024-08-12 13:50:09 -07001281 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1282 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001283 AidlIncludeDirs: j.exportAidlIncludeDirs,
1284 ExportedPlugins: j.exportedPluginJars,
1285 ExportedPluginClasses: j.exportedPluginClasses,
1286 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1287 StubsLinkType: j.stubsLinkType,
1288 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001289 })
1290
1291 j.outputFile = j.headerJarFile
1292 return
1293 }
1294
Jaewoong Jung26342642021-03-17 15:56:23 -07001295 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001296 // When using kotlin sources turbine is used to generate annotation processor sources,
1297 // including for annotation processors that generate API, so we can use turbine for
1298 // java sources too.
1299 disableTurbine = false
1300
Jaewoong Jung26342642021-03-17 15:56:23 -07001301 // user defined kotlin flags.
1302 kotlincFlags := j.properties.Kotlincflags
1303 CheckKotlincFlags(ctx, kotlincFlags)
1304
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001305 // Workaround for KT-46512
1306 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001307
1308 // If there are kotlin files, compile them first but pass all the kotlin and java files
1309 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1310 // won't emit any classes for them.
1311 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1312 if ctx.Device() {
1313 kotlincFlags = append(kotlincFlags, "-no-jdk")
1314 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001315
1316 for _, plugin := range deps.kotlinPlugins {
1317 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1318 }
1319 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1320
Jaewoong Jung26342642021-03-17 15:56:23 -07001321 if len(kotlincFlags) > 0 {
1322 // optimization.
1323 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1324 flags.kotlincFlags += "$kotlincFlags"
1325 }
1326
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001327 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001328 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1329
Jaewoong Jung26342642021-03-17 15:56:23 -07001330 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1331 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1332
Isaac Chioua23d9942022-04-06 06:14:38 +00001333 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001334 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001335 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1336 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001337 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001338 srcJars = append(srcJars, kaptSrcJar)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001339 localImplementationJars = append(localImplementationJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001340 // Disable annotation processing in javac, it's already been handled by kapt
1341 flags.processorPath = nil
1342 flags.processors = nil
1343 }
1344
1345 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001346 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Spandan Das1028d5a2024-08-19 21:45:48 +00001347 j.kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001348 if ctx.Failed() {
1349 return
1350 }
1351
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001352 kotlinJarPath, _ := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001353
Isaac Chioua23d9942022-04-06 06:14:38 +00001354 // Make javac rule depend on the kotlinc rule
1355 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1356
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001357 localImplementationJars = append(localImplementationJars, kotlinJarPath)
1358
Colin Cross220a9a12022-03-28 17:08:01 -07001359 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001360 }
1361
Jaewoong Jung26342642021-03-17 15:56:23 -07001362 j.compiledSrcJars = srcJars
1363
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001364 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1365
Jaewoong Jung26342642021-03-17 15:56:23 -07001366 enableSharding := false
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001367 var localHeaderJars android.Paths
1368 var shardingHeaderJars android.Paths
1369 var repackagedHeaderJarFile android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001370 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001371 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1372 enableSharding = true
1373 // Formerly, there was a check here that prevented annotation processors
1374 // from being used when sharding was enabled, as some annotation processors
1375 // do not function correctly in sharded environments. It was removed to
1376 // allow for the use of annotation processors that do function correctly
1377 // with sharding enabled. See: b/77284273.
1378 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001379 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001380 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001381 var combinedHeaderJarFile android.Path
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001382 localHeaderJars, combinedHeaderJarFile = j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
1383 shardingHeaderJars = localHeaderJars
Colin Crossedec77c2024-07-26 15:25:40 -07001384
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001385 var jarjared bool
1386 j.headerJarFile, jarjared = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1387 if jarjared {
1388 // jarjar modifies transitive static dependencies, use the combined header jar and drop the transitive
1389 // static libs header jars.
1390 localHeaderJars = android.Paths{j.headerJarFile}
1391 transitiveStaticLibsHeaderJars = nil
1392 }
1393 var repackaged bool
1394 repackagedHeaderJarFile, repackaged = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
1395 if repackaged {
1396 // repackage modifies transitive static dependencies, use the combined header jar and drop the transitive
1397 // static libs header jars.
1398 // TODO(b/356688296): this shouldn't export both the unmodified and repackaged header jars
1399 localHeaderJars = android.Paths{j.headerJarFile, repackagedHeaderJarFile}
1400 transitiveStaticLibsHeaderJars = nil
1401 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001402 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001403 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001404 hasErrorproneableFiles := false
1405 for _, ext := range j.sourceExtensions {
1406 if ext != ".proto" && ext != ".aidl" {
1407 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1408 // compile, and it's not useful to have warnings on these generated sources.
1409 hasErrorproneableFiles = true
1410 break
1411 }
1412 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001413 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001414 if Bool(j.properties.Errorprone.Enabled) {
1415 // If error-prone is enabled, enable errorprone flags on the regular
1416 // build.
1417 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001418 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001419 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1420 // a new jar file just for compiling with the errorprone compiler to.
1421 // This is because we don't want to cause the java files to get completely
1422 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1423 // We also don't want to run this if errorprone is enabled by default for
1424 // this module, or else we could have duplicated errorprone messages.
1425 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001426 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001427 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001428
Vadim Spivak3c496f02023-06-08 06:14:59 +00001429 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001430 "errorprone", "errorprone")
1431
Jaewoong Jung26342642021-03-17 15:56:23 -07001432 extraJarDeps = append(extraJarDeps, errorprone)
1433 }
1434
1435 if enableSharding {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001436 if len(shardingHeaderJars) > 0 {
1437 flags.classpath = append(classpath(slices.Clone(shardingHeaderJars)), flags.classpath...)
Colin Cross3d56ed52021-11-18 22:23:12 -08001438 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001439 shardSize := int(*(j.properties.Javac_shard_size))
1440 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001441 if len(uniqueJavaFiles) > 0 {
1442 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001443 for idx, shardSrc := range shardSrcs {
1444 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1445 nil, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001446 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
1447 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001448 }
1449 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001450 // Assume approximately 5 sources per srcjar.
1451 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1452 // of 5.8 sources per srcjar, but a median of 1, a standard deviation of 10, and a max of 48 source files.
Jaewoong Jung26342642021-03-17 15:56:23 -07001453 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001454 startIdx := len(shardSrcs)
1455 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1456 for idx, shardSrcJars := range shardSrcJarsList {
1457 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1458 nil, shardSrcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001459 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
1460 localImplementationJars = append(localImplementationJars, classes)
Colin Crossa052ddb2023-09-25 21:46:58 -07001461 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001462 }
1463 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001464 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001465 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
1466 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001467 }
1468 if ctx.Failed() {
1469 return
1470 }
1471 }
1472
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001473 localImplementationJars = append(localImplementationJars, extraCombinedJars...)
Colin Crossfd620b22024-02-23 10:05:21 -08001474
Jaewoong Jung26342642021-03-17 15:56:23 -07001475 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1476
1477 var includeSrcJar android.WritablePath
1478 if Bool(j.properties.Include_srcs) {
1479 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1480 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1481 }
1482
1483 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1484 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1485 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1486 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1487
1488 var resArgs []string
1489 var resDeps android.Paths
1490
1491 resArgs = append(resArgs, dirArgs...)
1492 resDeps = append(resDeps, dirDeps...)
1493
1494 resArgs = append(resArgs, fileArgs...)
1495 resDeps = append(resDeps, fileDeps...)
1496
1497 resArgs = append(resArgs, extraArgs...)
1498 resDeps = append(resDeps, extraDeps...)
1499
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001500 var localResourceJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001501 if len(resArgs) > 0 {
1502 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1503 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001504 if ctx.Failed() {
1505 return
1506 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001507 localResourceJars = append(localResourceJars, resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001508 }
1509
Jaewoong Jung26342642021-03-17 15:56:23 -07001510 if Bool(j.properties.Include_srcs) {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001511 localResourceJars = append(localResourceJars, includeSrcJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001512 }
1513
1514 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1515 if len(services) > 0 {
1516 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1517 var zipargs []string
1518 for _, file := range services {
1519 serviceFile := file.String()
1520 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1521 }
1522 rule := zip
1523 args := map[string]string{
1524 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1525 }
1526 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1527 rule = zipRE
1528 args["implicits"] = strings.Join(services.Strings(), ",")
1529 }
1530 ctx.Build(pctx, android.BuildParams{
1531 Rule: rule,
1532 Output: servicesJar,
1533 Implicits: services,
1534 Args: args,
1535 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001536 localResourceJars = append(localResourceJars, servicesJar)
1537 }
1538
Colin Crossa14fb6a2024-10-23 16:57:06 -07001539 completeStaticLibsResourceJars := depset.New(depset.PREORDER, localResourceJars, deps.transitiveStaticLibsResourceJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001540
1541 var combinedResourceJar android.Path
1542 var resourceJars android.Paths
1543 if ctx.Config().UseTransitiveJarsInClasspath() {
1544 resourceJars = completeStaticLibsResourceJars.ToList()
1545 } else {
1546 resourceJars = append(slices.Clone(localResourceJars), deps.staticResourceJars...)
1547 }
1548 if len(resourceJars) == 1 {
1549 combinedResourceJar = resourceJars[0]
1550 } else if len(resourceJars) > 0 {
1551 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1552 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1553 false, nil, nil)
1554 combinedResourceJar = combinedJar
1555 }
1556
1557 manifest := j.overrideManifest
1558 if !manifest.Valid() && j.properties.Manifest != nil {
1559 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Jaewoong Jung26342642021-03-17 15:56:23 -07001560 }
1561
1562 // Combine the classes built from sources, any manifests, and any static libraries into
1563 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001564 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001565
Colin Crossa14fb6a2024-10-23 16:57:06 -07001566 completeStaticLibsImplementationJars := depset.New(depset.PREORDER, localImplementationJars, deps.transitiveStaticLibsImplementationJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001567
1568 var jars android.Paths
1569 if ctx.Config().UseTransitiveJarsInClasspath() {
1570 jars = completeStaticLibsImplementationJars.ToList()
1571 } else {
1572 jars = append(slices.Clone(localImplementationJars), deps.staticJars...)
1573 }
1574
1575 jars = append(jars, extraDepCombinedJars...)
1576
Jaewoong Jung26342642021-03-17 15:56:23 -07001577 if len(jars) == 1 && !manifest.Valid() {
1578 // Optimization: skip the combine step as there is nothing to do
1579 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1580 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001581 // any if len(extraJars) == 0.
Jaewoong Jung26342642021-03-17 15:56:23 -07001582
Jihoon Kang1147b312023-06-08 23:25:57 +00001583 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1584 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1585 // either with .from-source or .from-text suffix.
1586 // outputFile should be agnostic to the build configuration,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001587 // thus copy the single input static lib in order to prevent the static lib from being exposed
Jihoon Kang1147b312023-06-08 23:25:57 +00001588 // to the copy rules.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001589 if stub, _ := moduleStubLinkType(j); stub {
1590 copiedJar := android.PathForModuleOut(ctx, "combined", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001591 ctx.Build(pctx, android.BuildParams{
1592 Rule: android.Cp,
1593 Input: jars[0],
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001594 Output: copiedJar,
Jaewoong Jung26342642021-03-17 15:56:23 -07001595 })
Colin Crossa14fb6a2024-10-23 16:57:06 -07001596 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, android.Paths{copiedJar}, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001597 outputFile = copiedJar
Colin Cross7707b242024-07-26 12:02:36 -07001598 } else {
1599 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001600 }
1601 } else {
1602 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1603 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1604 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001605 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001606 }
1607
1608 // jarjar implementation jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001609 jarjarFile, jarjarred := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1610 if jarjarred {
1611 localImplementationJars = android.Paths{jarjarFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001612 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001613 }
Colin Crossedec77c2024-07-26 15:25:40 -07001614 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001615
Colin Crossedec77c2024-07-26 15:25:40 -07001616 // jarjar resource jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001617 if combinedResourceJar != nil {
1618 resourceJarJarFile, jarjarred := j.jarjarIfNecessary(ctx, combinedResourceJar, jarName, "resource")
1619 combinedResourceJar = resourceJarJarFile
1620 if jarjarred {
1621 localResourceJars = android.Paths{resourceJarJarFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001622 completeStaticLibsResourceJars = depset.New(depset.PREORDER, localResourceJars, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001623 }
Colin Crossedec77c2024-07-26 15:25:40 -07001624 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001625
Colin Crossedec77c2024-07-26 15:25:40 -07001626 if ctx.Failed() {
1627 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001628 }
1629
Makoto Onuki7ded3822024-03-28 14:42:20 -07001630 if j.ravenizer.enabled {
1631 ravenizerInput := outputFile
John Wub67040d2024-10-07 18:39:06 +00001632 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", "", jarName)
John Wu989ee842024-10-04 00:21:43 +00001633 ravenizerArgs := ""
1634 if proptools.Bool(j.properties.Ravenizer.Strip_mockito) {
1635 ravenizerArgs = "--strip-mockito"
1636 }
1637 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
Makoto Onuki7ded3822024-03-28 14:42:20 -07001638 outputFile = ravenizerOutput
Colin Cross7e863852024-09-06 14:42:38 -07001639 localImplementationJars = android.Paths{ravenizerOutput}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001640 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001641 if combinedResourceJar != nil {
1642 ravenizerInput = combinedResourceJar
1643 ravenizerOutput = android.PathForModuleOut(ctx, "ravenizer", "resources", jarName)
1644 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
1645 combinedResourceJar = ravenizerOutput
1646 localResourceJars = android.Paths{ravenizerOutput}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001647 completeStaticLibsResourceJars = depset.New(depset.PREORDER, localResourceJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001648 }
Makoto Onuki7ded3822024-03-28 14:42:20 -07001649 }
1650
Yihan Dong8be09c22024-08-29 15:32:13 +08001651 if j.shouldApiMapper() {
1652 inputFile := outputFile
1653 apiMapperFile := android.PathForModuleOut(ctx, "apimapper", jarName)
1654 ctx.Build(pctx, android.BuildParams{
1655 Rule: apimapper,
1656 Description: "apimapper",
1657 Input: inputFile,
1658 Output: apiMapperFile,
1659 })
1660 outputFile = apiMapperFile
Colin Cross7e863852024-09-06 14:42:38 -07001661 localImplementationJars = android.Paths{apiMapperFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001662 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Yihan Dong8be09c22024-08-29 15:32:13 +08001663 }
1664
Jaewoong Jung26342642021-03-17 15:56:23 -07001665 // Check package restrictions if necessary.
1666 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001667 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001668 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001669
1670 // Create a rule to copy the output jar to another path and add a validate dependency that
1671 // will check that the jar only contains the permitted packages. The new location will become
1672 // the output file of this module.
1673 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001674 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001675 ctx.Build(pctx, android.BuildParams{
1676 Rule: android.Cp,
1677 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001678 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001679 // Make sure that any dependency on the output file will cause ninja to run the package check
1680 // rule.
1681 Validation: pkgckFile,
1682 })
Colin Cross7707b242024-07-26 12:02:36 -07001683 outputFile = packageCheckOutputFile
Colin Cross7e863852024-09-06 14:42:38 -07001684 localImplementationJars = android.Paths{packageCheckOutputFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001685 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001686
1687 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001688 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001689
1690 if ctx.Failed() {
1691 return
1692 }
1693 }
1694
1695 j.implementationJarFile = outputFile
1696 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001697 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1698 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1699 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1700 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1701 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1702 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1703 j.headerJarFile = headerJarFile
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001704 if len(localImplementationJars) == 1 && ctx.Config().UseTransitiveJarsInClasspath() {
1705 localHeaderJarFile := android.PathForModuleOut(ctx, "local-javac-header", jarName)
1706 convertImplementationJarToHeaderJar(ctx, localImplementationJars[0], localHeaderJarFile)
1707 localHeaderJars = append(localHeaderJars, localHeaderJarFile)
1708 } else {
1709 localHeaderJars = append(localHeaderJars, headerJarFile)
1710 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001711 }
1712
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001713 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1714 specs := j.jacocoModuleToZipCommand(ctx)
1715 if ctx.Failed() {
1716 return
1717 }
1718
Colin Crossb323c912024-09-24 15:21:00 -07001719 completeStaticLibsImplementationJarsToCombine := completeStaticLibsImplementationJars
1720
Jaewoong Jung26342642021-03-17 15:56:23 -07001721 if j.shouldInstrument(ctx) {
Colin Crossb323c912024-09-24 15:21:00 -07001722 instrumentedOutputFile := j.instrument(ctx, flags, outputFile, jarName, specs)
Colin Crossa14fb6a2024-10-23 16:57:06 -07001723 completeStaticLibsImplementationJarsToCombine = depset.New(depset.PREORDER, android.Paths{instrumentedOutputFile}, nil)
Colin Crossb323c912024-09-24 15:21:00 -07001724 outputFile = instrumentedOutputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001725 }
1726
1727 // merge implementation jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001728 var implementationAndResourcesJarsToCombine android.Paths
1729 if ctx.Config().UseTransitiveJarsInClasspath() {
1730 resourceJars := completeStaticLibsResourceJars.ToList()
1731 if len(resourceJars) > 0 {
Colin Crossb323c912024-09-24 15:21:00 -07001732 implementationAndResourcesJarsToCombine = append(resourceJars, completeStaticLibsImplementationJarsToCombine.ToList()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001733 implementationAndResourcesJarsToCombine = append(implementationAndResourcesJarsToCombine, extraDepCombinedJars...)
1734 }
1735 } else {
1736 if combinedResourceJar != nil {
1737 implementationAndResourcesJarsToCombine = android.Paths{combinedResourceJar, outputFile}
1738 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001739 }
1740
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001741 if len(implementationAndResourcesJarsToCombine) > 0 {
1742 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
1743 TransformJarsToJar(ctx, combinedJar, "for resources", implementationAndResourcesJarsToCombine, manifest,
1744 false, nil, nil)
1745 outputFile = combinedJar
1746 }
1747
1748 j.implementationAndResourcesJar = outputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001749
1750 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001751 compileDex := j.dexProperties.Compile_dex
Colin Crossff694a82023-12-13 15:54:49 -08001752 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -07001753 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001754 if compileDex == nil {
1755 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001756 }
1757 if j.deviceProperties.Hostdex == nil {
1758 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1759 }
1760 }
1761
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001762 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001763 if j.hasCode(ctx) {
1764 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001765 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001766 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1767 }
1768 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001769 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001770 params := &compileDexParams{
1771 flags: flags,
1772 sdkVersion: j.SdkVersion(ctx),
1773 minSdkVersion: j.MinSdkVersion(ctx),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001774 classesJar: outputFile,
Spandan Dasc404cc72023-02-23 18:05:05 +00001775 jarName: jarName,
1776 }
Cole Fausteb032462024-09-19 11:12:54 -07001777 if j.GetProfileGuided(ctx) && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting(ctx) {
Spandan Das15a67112024-05-30 00:07:40 +00001778 ctx.PropertyErrorf("enable_profile_rewriting",
1779 "Enable_profile_rewriting must be true when profile_guided dexpreopt and R8 optimization/obfuscation is turned on. The attached profile should be sourced from an unoptimized/unobfuscated APK.",
1780 )
1781 }
Cole Fausteb032462024-09-19 11:12:54 -07001782 if j.EnableProfileRewriting(ctx) {
1783 profile := j.GetProfile(ctx)
1784 if profile == "" || !j.GetProfileGuided(ctx) {
Spandan Das3dbda182024-05-20 22:23:10 +00001785 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1786 }
1787 params.artProfileInput = &profile
1788 }
1789 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001790 if ctx.Failed() {
1791 return
1792 }
1793
Spandan Das3dbda182024-05-20 22:23:10 +00001794 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1795 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001796 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001797 }
1798
Jaewoong Jung26342642021-03-17 15:56:23 -07001799 // merge dex jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001800 var dexAndResourceJarsToCombine android.Paths
1801 if ctx.Config().UseTransitiveJarsInClasspath() {
1802 resourceJars := completeStaticLibsResourceJars.ToList()
1803 if len(resourceJars) > 0 {
1804 dexAndResourceJarsToCombine = append(android.Paths{dexOutputFile}, resourceJars...)
1805 }
1806 } else {
1807 if combinedResourceJar != nil {
1808 dexAndResourceJarsToCombine = android.Paths{dexOutputFile, combinedResourceJar}
1809 }
1810 }
1811 if len(dexAndResourceJarsToCombine) > 0 {
Colin Cross7707b242024-07-26 12:02:36 -07001812 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001813 TransformJarsToJar(ctx, combinedJar, "for dex resources", dexAndResourceJarsToCombine, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001814 false, nil, nil)
1815 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001816 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001817 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001818 dexOutputFile = combinedAlignedJar
1819 } else {
1820 dexOutputFile = combinedJar
1821 }
1822 }
1823
Paul Duffin4de94502021-05-16 05:21:16 +01001824 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001825
1826 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001827
1828 // Encode hidden API flags in dex file, if needed.
1829 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1830
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001831 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001832
1833 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001834 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1835 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1836 libName = strings.TrimSuffix(libName, ".impl")
1837 }
1838 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001839
1840 outputFile = dexOutputFile
Colin Crossa6182ab2024-08-21 10:47:44 -07001841
1842 ctx.CheckbuildFile(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001843 } else {
1844 // There is no code to compile into a dex jar, make sure the resources are propagated
1845 // to the APK if this is an app.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001846 j.dexJarFile = makeDexJarPathFromPath(combinedResourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001847 }
1848
1849 if ctx.Failed() {
1850 return
1851 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001852 }
1853
1854 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001855 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001856 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001857 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001858 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001859 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001860 }
1861 }
1862
1863 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001864 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1865 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001866 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1867 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001868 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001869 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001870 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001871 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001872 j.linter.javaLanguageLevel = flags.javaVersion.String()
1873 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001874 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001875 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1876 j.linter.buildModuleReportZip = true
1877 }
1878 j.linter.lint(ctx)
1879 }
1880
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001881 j.collectTransitiveSrcFiles(ctx, srcFiles)
1882
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001883 if ctx.Config().UseTransitiveJarsInClasspath() {
1884 if len(localImplementationJars) > 0 || len(localResourceJars) > 0 || len(localHeaderJars) > 0 {
1885 ctx.CheckbuildFile(localImplementationJars...)
1886 ctx.CheckbuildFile(localResourceJars...)
1887 ctx.CheckbuildFile(localHeaderJars...)
1888 } else {
1889 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1890 ctx.UncheckedModule()
1891 }
1892 } else {
1893 ctx.CheckbuildFile(j.implementationJarFile)
1894 ctx.CheckbuildFile(j.headerJarFile)
1895 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001896
Colin Cross7727c7f2024-07-18 15:36:32 -07001897 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001898 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1899 RepackagedHeaderJars: android.PathsIfNonNil(repackagedHeaderJarFile),
1900
1901 LocalHeaderJars: localHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001902 TransitiveStaticLibsHeaderJars: depset.New(depset.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001903 TransitiveStaticLibsImplementationJars: completeStaticLibsImplementationJars,
1904 TransitiveStaticLibsResourceJars: completeStaticLibsResourceJars,
1905
Colin Cross9ffaf282024-08-12 13:50:09 -07001906 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1907 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001908 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1909 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001910 ResourceJars: android.PathsIfNonNil(combinedResourceJar),
Jihoon Kang705e63e2024-03-13 01:21:16 +00001911 AidlIncludeDirs: j.exportAidlIncludeDirs,
1912 SrcJarArgs: j.srcJarArgs,
1913 SrcJarDeps: j.srcJarDeps,
1914 TransitiveSrcFiles: j.transitiveSrcFiles,
1915 ExportedPlugins: j.exportedPluginJars,
1916 ExportedPluginClasses: j.exportedPluginClasses,
1917 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1918 JacocoReportClassesFile: j.jacocoReportClassesFile,
1919 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001920 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001921 })
1922
1923 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1924 j.outputFile = outputFile.WithoutRel()
1925}
1926
Cole Faustb7493472024-08-28 11:55:52 -07001927func (j *Module) useCompose(ctx android.BaseModuleContext) bool {
1928 return android.InList("androidx.compose.runtime_runtime", j.staticLibs(ctx))
Colin Crossa1ff7c62021-09-17 14:11:52 -07001929}
1930
Colin Crossa14fb6a2024-10-23 16:57:06 -07001931func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []depset.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001932 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001933 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001934 depTag := ctx.OtherModuleDependencyTag(m)
1935
Colin Crossa14fb6a2024-10-23 16:57:06 -07001936 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1937 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
Sam Delmerico95d70942023-08-02 18:00:35 -04001938
Colin Crossa14fb6a2024-10-23 16:57:06 -07001939 if depTag == staticLibTag {
Sam Delmerico95d70942023-08-02 18:00:35 -04001940 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1941 }
1942 })
1943
Colin Crosscde55342024-03-27 14:11:51 -07001944 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1945}
1946
1947func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1948 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1949
Sam Delmerico95d70942023-08-02 18:00:35 -04001950 directUnconditionalExportedFlags := android.Paths{}
1951 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1952 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1953 if exportUnconditionally {
1954 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1955 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1956 directUnconditionalExportedFlags = proguardFlagsForThisModule
1957 }
1958
1959 return ProguardSpecInfo{
1960 Export_proguard_flags_files: exportUnconditionally,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001961 ProguardFlagsFiles: depset.New[android.Path](
1962 depset.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04001963 proguardFlagsForThisModule,
1964 transitiveProguardFlags,
1965 ),
Colin Crossa14fb6a2024-10-23 16:57:06 -07001966 UnconditionallyExportedProguardFlags: depset.New[android.Path](
1967 depset.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04001968 directUnconditionalExportedFlags,
1969 transitiveUnconditionalExportedFlags,
1970 ),
1971 }
1972
1973}
1974
Cole Faust75fffb12021-06-13 15:23:16 -07001975// Returns a copy of the supplied flags, but with all the errorprone-related
1976// fields copied to the regular build's fields.
1977func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1978 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1979
1980 if len(flags.errorProneExtraJavacFlags) > 0 {
1981 if len(flags.javacFlags) > 0 {
1982 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
1983 } else {
1984 flags.javacFlags = flags.errorProneExtraJavacFlags
1985 }
1986 }
1987 return flags
1988}
1989
Jaewoong Jung26342642021-03-17 15:56:23 -07001990func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07001991 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07001992
1993 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00001994 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001995 if idx >= 0 {
1996 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00001997 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001998 jarName += strconv.Itoa(idx)
1999 }
2000
Colin Cross7707b242024-07-26 12:02:36 -07002001 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00002002 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07002003
Cole Faust9decf832024-06-11 11:45:53 -07002004 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002005 extractionFile := android.PathForModuleOut(ctx, kzipName)
2006 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
2007 j.kytheFiles = append(j.kytheFiles, extractionFile)
2008 }
2009
Vadim Spivak3c496f02023-06-08 06:14:59 +00002010 if len(flags.processorPath) > 0 {
2011 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
2012 }
2013
Jaewoong Jung26342642021-03-17 15:56:23 -07002014 return classes
2015}
2016
2017// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
2018// since some of these flags may be used internally.
2019func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
2020 for _, flag := range flags {
2021 flag = strings.TrimSpace(flag)
2022
2023 if !strings.HasPrefix(flag, "-") {
2024 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
2025 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
2026 ctx.PropertyErrorf("kotlincflags",
2027 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
2028 } else if inList(flag, config.KotlincIllegalFlags) {
2029 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
2030 } else if flag == "-include-runtime" {
2031 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
2032 } else {
2033 args := strings.Split(flag, " ")
2034 if args[0] == "-kotlin-home" {
2035 ctx.PropertyErrorf("kotlincflags",
2036 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
2037 }
2038 }
2039 }
2040}
2041
2042func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
2043 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002044 extraJars android.Paths) (localHeaderJars android.Paths, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002045
Jaewoong Jung26342642021-03-17 15:56:23 -07002046 if len(srcFiles) > 0 || len(srcJars) > 0 {
2047 // Compile java sources into turbine.jar.
2048 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
2049 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002050 localHeaderJars = append(localHeaderJars, turbineJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07002051 }
2052
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002053 localHeaderJars = append(localHeaderJars, extraJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002054
2055 // Combine any static header libraries into classes-header.jar. If there is only
2056 // one input jar this step will be skipped.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002057 var jars android.Paths
2058 if ctx.Config().UseTransitiveJarsInClasspath() {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002059 depSet := depset.New(depset.PREORDER, localHeaderJars, deps.transitiveStaticLibsHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002060 jars = depSet.ToList()
2061 } else {
2062 jars = append(slices.Clone(localHeaderJars), deps.staticHeaderJars...)
2063 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002064
2065 // we cannot skip the combine step for now if there is only one jar
2066 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07002067 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
2068 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07002069 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07002070
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002071 return localHeaderJars, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07002072}
2073
2074func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07002075 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002076
2077 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07002078 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07002079
2080 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
2081
2082 j.jacocoReportClassesFile = jacocoReportClassesFile
2083
2084 return instrumentedJar
2085}
2086
Colin Cross9ffaf282024-08-12 13:50:09 -07002087type providesTransitiveHeaderJarsForR8 struct {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002088 // set of header jars for all transitive libs deps
Colin Crossa14fb6a2024-10-23 16:57:06 -07002089 transitiveLibsHeaderJarsForR8 depset.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002090 // set of header jars for all transitive static libs deps
Colin Crossa14fb6a2024-10-23 16:57:06 -07002091 transitiveStaticLibsHeaderJarsForR8 depset.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002092}
2093
Colin Cross9ffaf282024-08-12 13:50:09 -07002094// collectTransitiveHeaderJarsForR8 visits direct dependencies and collects all transitive libs and static_libs
2095// header jars. The semantics of the collected jars are odd (it collects combined jars that contain the static
2096// libs, but also the static libs, and it collects transitive libs dependencies of static_libs), so these
2097// are only used to expand the --lib arguments to R8.
2098func (j *providesTransitiveHeaderJarsForR8) collectTransitiveHeaderJarsForR8(ctx android.ModuleContext) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002099 directLibs := android.Paths{}
2100 directStaticLibs := android.Paths{}
Colin Crossa14fb6a2024-10-23 16:57:06 -07002101 transitiveLibs := []depset.DepSet[android.Path]{}
2102 transitiveStaticLibs := []depset.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002103 ctx.VisitDirectDeps(func(module android.Module) {
2104 // don't add deps of the prebuilt version of the same library
2105 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
2106 return
2107 }
2108
Colin Cross7727c7f2024-07-18 15:36:32 -07002109 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2110 tag := ctx.OtherModuleDependencyTag(module)
2111 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2112 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2113 directLibs = append(directLibs, dep.HeaderJars...)
2114 } else if tag == staticLibTag {
2115 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2116 } else {
2117 // Don't propagate transitive libs for other kinds of dependencies.
2118 return
2119 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002120
Colin Crossa14fb6a2024-10-23 16:57:06 -07002121 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJarsForR8)
2122 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJarsForR8)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002123 }
2124 })
Colin Crossa14fb6a2024-10-23 16:57:06 -07002125 j.transitiveLibsHeaderJarsForR8 = depset.New(depset.POSTORDER, directLibs, transitiveLibs)
2126 j.transitiveStaticLibsHeaderJarsForR8 = depset.New(depset.POSTORDER, directStaticLibs, transitiveStaticLibs)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002127}
2128
Jaewoong Jung26342642021-03-17 15:56:23 -07002129func (j *Module) HeaderJars() android.Paths {
2130 if j.headerJarFile == nil {
2131 return nil
2132 }
2133 return android.Paths{j.headerJarFile}
2134}
2135
2136func (j *Module) ImplementationJars() android.Paths {
2137 if j.implementationJarFile == nil {
2138 return nil
2139 }
2140 return android.Paths{j.implementationJarFile}
2141}
2142
Spandan Das59a4a2b2024-01-09 21:35:56 +00002143func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002144 return j.dexJarFile
2145}
2146
2147func (j *Module) DexJarInstallPath() android.Path {
2148 return j.installFile
2149}
2150
2151func (j *Module) ImplementationAndResourcesJars() android.Paths {
2152 if j.implementationAndResourcesJar == nil {
2153 return nil
2154 }
2155 return android.Paths{j.implementationAndResourcesJar}
2156}
2157
2158func (j *Module) AidlIncludeDirs() android.Paths {
2159 // exportAidlIncludeDirs is type android.Paths already
2160 return j.exportAidlIncludeDirs
2161}
2162
2163func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2164 return j.classLoaderContexts
2165}
2166
2167// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002168func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002169 if j.expandJarjarRules != nil {
2170 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Das096b8d62024-10-08 22:41:26 +00002171 // Add the header jar so that the rdeps can be resolved to the repackaged classes.
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002172 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
Jaewoong Jung26342642021-03-17 15:56:23 -07002173 }
Spandan Das096b8d62024-10-08 22:41:26 +00002174 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2175 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2176 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002177 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2178 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Cole Faustb7493472024-08-28 11:55:52 -07002179 dpInfo.Static_libs = append(dpInfo.Static_libs, j.staticLibs(ctx)...)
Yikef6282022022-04-13 20:41:01 +08002180 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002181}
2182
2183func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002184 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002185}
2186
2187func (j *Module) hasCode(ctx android.ModuleContext) bool {
2188 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2189 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2190}
2191
2192// Implements android.ApexModule
2193func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2194 return j.depIsInSameApex(ctx, dep)
2195}
2196
2197// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002198func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002199 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002200 minSdkVersion := j.MinSdkVersion(ctx)
2201 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002202 return fmt.Errorf("min_sdk_version is not specified")
2203 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002204 // If the module is compiling against core (via sdk_version), skip comparison check.
2205 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002206 return nil
2207 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002208 if minSdkVersion.GreaterThan(sdkVersion) {
2209 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002210 }
2211 return nil
2212}
2213
2214func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002215 if j.stem == "" {
2216 panic("Stem() called before stem property was set")
2217 }
2218 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002219}
2220
Jaewoong Jung26342642021-03-17 15:56:23 -07002221func (j *Module) JacocoReportClassesFile() android.Path {
2222 return j.jacocoReportClassesFile
2223}
2224
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002225func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002226 var fromDeps []depset.DepSet[android.Path]
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002227 ctx.VisitDirectDeps(func(module android.Module) {
2228 tag := ctx.OtherModuleDependencyTag(module)
2229 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002230 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002231 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002232 }
2233 }
2234 })
2235
Colin Crossa14fb6a2024-10-23 16:57:06 -07002236 j.transitiveSrcFiles = depset.New(depset.POSTORDER, mine, fromDeps)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002237}
2238
Jaewoong Jung26342642021-03-17 15:56:23 -07002239func (j *Module) IsInstallable() bool {
2240 return Bool(j.properties.Installable)
2241}
2242
2243type sdkLinkType int
2244
2245const (
2246 // TODO(jiyong) rename these for better readability. Make the allowed
2247 // and disallowed link types explicit
2248 // order is important here. See rank()
2249 javaCore sdkLinkType = iota
2250 javaSdk
2251 javaSystem
2252 javaModule
2253 javaSystemServer
2254 javaPlatform
2255)
2256
2257func (lt sdkLinkType) String() string {
2258 switch lt {
2259 case javaCore:
2260 return "core Java API"
2261 case javaSdk:
2262 return "Android API"
2263 case javaSystem:
2264 return "system API"
2265 case javaModule:
2266 return "module API"
2267 case javaSystemServer:
2268 return "system server API"
2269 case javaPlatform:
2270 return "private API"
2271 default:
2272 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2273 }
2274}
2275
2276// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2277// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2278// can't statically depend on modules that use Platform API.
2279func (lt sdkLinkType) rank() int {
2280 return int(lt)
2281}
2282
2283type moduleWithSdkDep interface {
2284 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002285 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002286}
2287
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002288func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2289 switch k {
2290 case android.SdkCore:
2291 return javaCore
2292 case android.SdkSystem:
2293 return javaSystem
2294 case android.SdkPublic:
2295 return javaSdk
2296 case android.SdkModule:
2297 return javaModule
2298 case android.SdkSystemServer:
2299 return javaSystemServer
2300 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2301 return javaPlatform
2302 default:
2303 return javaSdk
2304 }
2305}
2306
Jiyong Park92315372021-04-02 08:45:46 +09002307func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002308 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002309 case android.SdkCore.DefaultJavaLibraryName(),
2310 "legacy.core.platform.api.stubs",
2311 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002312 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002313 "core-lambda-stubs",
Jihoon Kangb5078312023-03-29 23:25:49 +00002314 "core-generated-annotation-stubs":
Jaewoong Jung26342642021-03-17 15:56:23 -07002315 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002316 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002317 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002318 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002319 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002320 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002321 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002322 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002323 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002324 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002325 return javaSystem, true
2326 }
2327
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002328 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002329 return linkType, true
2330 }
2331
Jiyong Park92315372021-04-02 08:45:46 +09002332 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002333 if !ver.Valid() {
2334 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002335 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002336
2337 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002338}
2339
2340// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2341// this module's. See the comment on rank() for details and an example.
2342func (j *Module) checkSdkLinkType(
2343 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2344 if ctx.Host() {
2345 return
2346 }
2347
Jiyong Park92315372021-04-02 08:45:46 +09002348 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002349 if stubs {
2350 return
2351 }
Jiyong Park92315372021-04-02 08:45:46 +09002352 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002353
2354 if myLinkType.rank() < depLinkType.rank() {
2355 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2356 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2357 "property of the source or target module so that target module is built "+
2358 "with the same or smaller API set when compared to the source.",
2359 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2360 }
2361}
2362
2363func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2364 var deps deps
2365
Jiyong Park92315372021-04-02 08:45:46 +09002366 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002367
Colin Cross9ffaf282024-08-12 13:50:09 -07002368 j.collectTransitiveHeaderJarsForR8(ctx)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002369
Colin Crossa14fb6a2024-10-23 16:57:06 -07002370 var transitiveBootClasspathHeaderJars []depset.DepSet[android.Path]
2371 var transitiveClasspathHeaderJars []depset.DepSet[android.Path]
2372 var transitiveJava9ClasspathHeaderJars []depset.DepSet[android.Path]
2373 var transitiveStaticJarsHeaderLibs []depset.DepSet[android.Path]
2374 var transitiveStaticJarsImplementationLibs []depset.DepSet[android.Path]
2375 var transitiveStaticJarsResourceLibs []depset.DepSet[android.Path]
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002376
Jaewoong Jung26342642021-03-17 15:56:23 -07002377 ctx.VisitDirectDeps(func(module android.Module) {
2378 otherName := ctx.OtherModuleName(module)
2379 tag := ctx.OtherModuleDependencyTag(module)
2380
2381 if IsJniDepTag(tag) {
2382 // Handled by AndroidApp.collectAppDeps
2383 return
2384 }
2385 if tag == certificateTag {
2386 // Handled by AndroidApp.collectAppDeps
2387 return
2388 }
2389
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002390 if sdkInfo, ok := android.OtherModuleProvider(ctx, module, SdkLibraryInfoProvider); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -07002391 switch tag {
Jihoon Kang28c96572024-09-11 23:44:44 +00002392 case sdkLibTag, libTag, staticLibTag:
Jihoon Kang28c96572024-09-11 23:44:44 +00002393 generatingLibsString := android.PrettyConcat(
2394 getGeneratingLibs(ctx, j.SdkVersion(ctx), module.Name(), sdkInfo), true, "or")
2395 ctx.ModuleErrorf("cannot depend directly on java_sdk_library %q; try depending on %s instead", module.Name(), generatingLibsString)
Jaewoong Jung26342642021-03-17 15:56:23 -07002396 }
Colin Cross313aa542023-12-13 13:47:44 -08002397 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2398 if sdkLinkType != javaPlatform {
2399 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2400 // dep is a sysprop implementation library, but this module is not linking against
2401 // the platform, so it gets the sysprop public stubs library instead. Replace
2402 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2403 dep = syspropDep.JavaInfo
2404 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002405 }
2406 switch tag {
2407 case bootClasspathTag:
2408 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002409 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002410 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002411 if _, ok := module.(*Plugin); ok {
2412 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2413 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002414 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002415 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002416 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2417 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2418 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2419 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002420 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2421 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2422 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002423
Colin Crossa14fb6a2024-10-23 16:57:06 -07002424 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002425 case java9LibTag:
2426 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002427 transitiveJava9ClasspathHeaderJars = append(transitiveJava9ClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002428 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002429 if _, ok := module.(*Plugin); ok {
2430 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2431 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002432 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2433 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2434 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2435 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2436 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2437 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2438 // Turbine doesn't run annotation processors, so any module that uses an
2439 // annotation processor that generates API is incompatible with the turbine
2440 // optimization.
2441 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002442 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002443
Colin Crossa14fb6a2024-10-23 16:57:06 -07002444 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2445 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, dep.TransitiveStaticLibsHeaderJars)
2446 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, dep.TransitiveStaticLibsImplementationJars)
2447 transitiveStaticJarsResourceLibs = append(transitiveStaticJarsResourceLibs, dep.TransitiveStaticLibsResourceJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002448 case pluginTag:
2449 if plugin, ok := module.(*Plugin); ok {
2450 if plugin.pluginProperties.Processor_class != nil {
2451 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2452 } else {
2453 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2454 }
2455 // Turbine doesn't run annotation processors, so any module that uses an
2456 // annotation processor that generates API is incompatible with the turbine
2457 // optimization.
2458 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2459 } else {
2460 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2461 }
2462 case errorpronePluginTag:
2463 if _, ok := module.(*Plugin); ok {
2464 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2465 } else {
2466 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2467 }
2468 case exportedPluginTag:
2469 if plugin, ok := module.(*Plugin); ok {
2470 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2471 if plugin.pluginProperties.Processor_class != nil {
2472 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2473 }
2474 // Turbine doesn't run annotation processors, so any module that uses an
2475 // annotation processor that generates API is incompatible with the turbine
2476 // optimization.
2477 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2478 } else {
2479 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2480 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002481 case kotlinPluginTag:
2482 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002483 case syspropPublicStubDepTag:
2484 // This is a sysprop implementation library, forward the JavaInfoProvider from
2485 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002486 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002487 JavaInfo: dep,
2488 })
2489 }
2490 } else if dep, ok := module.(android.SourceFileProducer); ok {
2491 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002492 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002493 checkProducesJars(ctx, dep)
2494 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002495 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002496 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07002497 depset.New(depset.PREORDER, dep.Srcs(), nil))
Jaewoong Jung26342642021-03-17 15:56:23 -07002498 case staticLibTag:
2499 checkProducesJars(ctx, dep)
2500 deps.classpath = append(deps.classpath, dep.Srcs()...)
2501 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2502 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002503
Colin Crossa14fb6a2024-10-23 16:57:06 -07002504 depHeaderJars := depset.New(depset.PREORDER, dep.Srcs(), nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002505 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJars)
2506 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, depHeaderJars)
2507 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, depHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002508 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002509 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002510 switch tag {
2511 case staticLibTag:
2512 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2513 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002514 } else {
2515 switch tag {
2516 case bootClasspathTag:
2517 // If a system modules dependency has been added to the bootclasspath
2518 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002519 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002520 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002521 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars,
2522 sm.TransitiveStaticLibsHeaderJars)
Colin Crossb61c2262024-08-08 14:04:42 -07002523 } else {
2524 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2525 ctx.OtherModuleName(module))
2526 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002527
2528 case systemModulesTag:
2529 if deps.systemModules != nil {
2530 panic("Found two system module dependencies")
2531 }
Colin Crossb61c2262024-08-08 14:04:42 -07002532 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2533 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2534 } else {
2535 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2536 ctx.OtherModuleName(module))
2537 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002538
2539 case instrumentationForTag:
2540 ctx.PropertyErrorf("instrumentation_for", "dependency %q of type %q does not provide JavaInfo so is unsuitable for use with this property", ctx.OtherModuleName(module), ctx.OtherModuleType(module))
Jaewoong Jung26342642021-03-17 15:56:23 -07002541 }
2542 }
2543
Spandan Das8aac9932024-07-18 23:14:13 +00002544 if android.InList(tag, compileDependencyTags) {
2545 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2546 j.compileDepNames = append(j.compileDepNames, otherName)
2547 }
2548
Jaewoong Jung26342642021-03-17 15:56:23 -07002549 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002550 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002551 })
2552
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002553 deps.transitiveStaticLibsHeaderJars = transitiveStaticJarsHeaderLibs
2554 deps.transitiveStaticLibsImplementationJars = transitiveStaticJarsImplementationLibs
2555 deps.transitiveStaticLibsResourceJars = transitiveStaticJarsResourceLibs
2556
2557 if ctx.Config().UseTransitiveJarsInClasspath() {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002558 depSet := depset.New(depset.PREORDER, nil, transitiveClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002559 deps.classpath = depSet.ToList()
Colin Crossa14fb6a2024-10-23 16:57:06 -07002560 depSet = depset.New(depset.PREORDER, nil, transitiveBootClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002561 deps.bootClasspath = depSet.ToList()
Colin Crossa14fb6a2024-10-23 16:57:06 -07002562 depSet = depset.New(depset.PREORDER, nil, transitiveJava9ClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002563 deps.java9Classpath = depSet.ToList()
2564 }
2565
2566 if ctx.Device() {
2567 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
2568 if sdkDep.invalidVersion {
2569 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2570 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2571 } else if sdkDep.useFiles {
2572 // sdkDep.jar is actually equivalent to turbine header.jar.
2573 deps.classpath = append(slices.Clone(classpath(sdkDep.jars)), deps.classpath...)
2574 deps.dexClasspath = append(slices.Clone(classpath(sdkDep.jars)), deps.dexClasspath...)
2575 deps.aidlPreprocess = sdkDep.aidl
2576 // Add the sdk module dependency to `compileDepNames`.
2577 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2578 // TODO (b/358608607): Move this to decodeSdkDep
2579 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2580 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
2581 } else {
2582 deps.aidlPreprocess = sdkDep.aidl
2583 }
2584 }
2585
Jaewoong Jung26342642021-03-17 15:56:23 -07002586 return deps
2587}
2588
Joe Onorato349ae8d2024-02-05 22:46:00 +00002589// Provider for jarjar renaming rules.
2590//
2591// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2592// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2593// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2594// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2595// be renamed from that module.
2596// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002597type DependencyUse int
2598
2599const (
2600 RenameUseInvalid DependencyUse = iota
2601 RenameUseInclude
2602 RenameUseExclude
2603)
2604
2605type RenameUseElement struct {
2606 DepName string
2607 RenameUse DependencyUse
2608 Why string // token for determining where in the logic the decision was made.
2609}
2610
Joe Onorato349ae8d2024-02-05 22:46:00 +00002611type JarJarProviderData struct {
2612 // Mapping of class names: original --> renamed. If the value is "", the class will be
2613 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2614 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002615 Rename map[string]string
2616 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002617}
2618
2619func (this JarJarProviderData) GetDebugString() string {
2620 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002621 for _, k := range android.SortedKeys(this.Rename) {
2622 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002623 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2624 result += k + "--&gt;" + v + ";"
2625 }
2626 }
2627 return result
2628}
2629
2630var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2631
2632var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2633
2634func init() {
2635 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
Yu Liu26a716d2024-08-30 23:40:32 +00002636
2637 gob.Register(BaseJarJarProviderData{})
Joe Onorato349ae8d2024-02-05 22:46:00 +00002638}
2639
2640// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2641// whether they are java modules or not.
2642type BaseJarJarProviderData struct {
2643 JarJarProviderData JarJarProviderData
2644}
2645
2646func (this BaseJarJarProviderData) GetDebugString() string {
2647 return this.JarJarProviderData.GetDebugString()
2648}
2649
2650var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2651
2652// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2653// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2654// either JarJarProvider or BaseJarJarProvider.
2655func mergeJarJarPrefixes(ctx android.ModuleContext) {
2656 mod := ctx.Module()
2657 // Explicitly avoid propagating into some module types.
2658 switch reflect.TypeOf(mod).String() {
2659 case "*java.Droidstubs":
2660 return
2661 }
2662 jarJarData := collectDirectDepsProviders(ctx)
2663 if jarJarData != nil {
2664 providerData := BaseJarJarProviderData{
2665 JarJarProviderData: *jarJarData,
2666 }
2667 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2668 }
2669
2670}
2671
2672// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2673func (module *Module) addJarJarRenameRule(original string, renamed string) {
2674 if module.jarjarRenameRules == nil {
2675 module.jarjarRenameRules = make(map[string]string)
2676 }
2677 module.jarjarRenameRules[original] = renamed
2678}
2679
2680func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2681 // Gather repackage information from deps
2682 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002683
2684 module := ctx.Module()
2685 moduleName := module.Name()
2686
Colin Cross648daea2024-09-12 14:35:29 -07002687 ctx.VisitDirectDeps(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002688 tag := ctx.OtherModuleDependencyTag(m)
2689 // This logic mirrors that in (*Module).collectDeps above. There are several places
2690 // where we explicitly return RenameUseExclude, even though it is the default, to
2691 // indicate that it has been verified to be the case.
2692 //
2693 // Note well: there are probably cases that are getting to the unconditional return
2694 // and are therefore wrong.
2695 shouldIncludeRenames := func() (DependencyUse, string) {
2696 if moduleName == m.Name() {
2697 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2698 }
2699 if sc, ok := module.(android.SdkContext); ok {
2700 if ctx.Device() {
2701 sdkDep := decodeSdkDep(ctx, sc)
2702 if !sdkDep.invalidVersion && sdkDep.useFiles {
2703 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002704 }
2705 }
LaMont Jones63683e42024-02-08 14:30:45 -08002706 }
2707 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2708 return RenameUseExclude, "tags"
2709 }
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002710 if _, ok := android.OtherModuleProvider(ctx, m, SdkLibraryInfoProvider); ok {
LaMont Jones63683e42024-02-08 14:30:45 -08002711 switch tag {
2712 case sdkLibTag, libTag:
2713 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2714 }
2715 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2716 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2717 switch ji.StubsLinkType {
2718 case Stubs:
2719 return RenameUseExclude, "info"
2720 case Implementation:
2721 return RenameUseInclude, "info"
2722 default:
LaMont Jones09721862024-06-11 10:30:50 -07002723 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002724 // Fall through to the heuristic logic.
2725 }
2726 switch reflect.TypeOf(m).String() {
2727 case "*java.GeneratedJavaLibraryModule":
2728 // Probably a java_aconfig_library module.
2729 // TODO: make this check better.
2730 return RenameUseInclude, "reflect"
2731 }
2732 switch tag {
2733 case bootClasspathTag:
2734 return RenameUseExclude, "tagswitch"
2735 case sdkLibTag, libTag, instrumentationForTag:
2736 return RenameUseInclude, "tagswitch"
2737 case java9LibTag:
2738 return RenameUseExclude, "tagswitch"
2739 case staticLibTag:
2740 return RenameUseInclude, "tagswitch"
2741 case pluginTag:
2742 return RenameUseInclude, "tagswitch"
2743 case errorpronePluginTag:
2744 return RenameUseInclude, "tagswitch"
2745 case exportedPluginTag:
2746 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002747 case kotlinPluginTag:
2748 return RenameUseInclude, "tagswitch"
2749 default:
2750 return RenameUseExclude, "tagswitch"
2751 }
2752 } else if _, ok := m.(android.SourceFileProducer); ok {
2753 switch tag {
2754 case sdkLibTag, libTag, staticLibTag:
2755 return RenameUseInclude, "srcfile"
2756 default:
2757 return RenameUseExclude, "srcfile"
2758 }
Yu Liu67a28422024-03-05 00:36:31 +00002759 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002760 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002761 } else {
2762 switch tag {
2763 case bootClasspathTag:
2764 return RenameUseExclude, "else"
2765 case systemModulesTag:
2766 return RenameUseInclude, "else"
2767 }
2768 }
2769 // If we got here, choose the safer option, which may lead to a build failure, rather
2770 // than runtime failures on the device.
2771 return RenameUseExclude, "end"
2772 }
2773
2774 if result == nil {
2775 result = &JarJarProviderData{
2776 Rename: make(map[string]string),
2777 RenameUse: make([]RenameUseElement, 0),
2778 }
2779 }
2780 how, why := shouldIncludeRenames()
2781 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2782 if how != RenameUseInclude {
2783 // Nothing to merge.
2784 return
2785 }
2786
2787 merge := func(theirs *JarJarProviderData) {
2788 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002789 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2790 result.Rename[orig] = renamed
2791 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2792 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2793 result.Rename[orig] = renamed
2794 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2795 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2796 continue
2797 }
2798 }
2799 }
2800 }
2801 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2802 merge(&theirs)
2803 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2804 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2805 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2806 // to java.Module.
2807 merge(&theirs.JarJarProviderData)
2808 }
2809 })
2810 return
2811}
2812
2813func (this Module) GetDebugString() string {
2814 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2815}
2816
2817// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2818// us, and if it's been set, apply the jarjar_prefix property to rename them.
2819func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2820 // Gather repackage information from deps
2821 result := collectDirectDepsProviders(ctx)
2822
Joe Onoratoa5d17172024-07-20 17:39:56 -07002823 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002824 if result == nil {
2825 result = &JarJarProviderData{
2826 Rename: make(map[string]string),
2827 }
2828 }
2829 if renamed != "" {
2830 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2831 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002832 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002833 }
2834 }
2835 (*result).Rename[orig] = renamed
2836 }
2837
Joe Onoratoa5d17172024-07-20 17:39:56 -07002838 // Update that with entries we've stored for ourself
2839 for orig, renamed := range module.jarjarRenameRules {
2840 add(orig, renamed)
2841 }
2842
2843 // Update that with entries given in the jarjar_rename property.
2844 for _, orig := range module.properties.Jarjar_rename {
2845 add(orig, "")
2846 }
2847
Joe Onorato349ae8d2024-02-05 22:46:00 +00002848 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2849 if result == nil {
2850 return nil
2851 }
2852
2853 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2854 // that have not yet been renamed.
2855 prefix := proptools.String(module.properties.Jarjar_prefix)
2856 if prefix != "" {
2857 if prefix[0] == '.' {
2858 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2859 return nil
2860 }
2861 if prefix[len(prefix)-1] == '.' {
2862 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2863 return nil
2864 }
2865
2866 var updated map[string]string
2867 for orig, renamed := range (*result).Rename {
2868 if renamed == "" {
2869 if updated == nil {
2870 updated = make(map[string]string)
2871 }
2872 updated[orig] = prefix + "." + orig
2873 }
2874 }
2875 for orig, renamed := range updated {
2876 (*result).Rename[orig] = renamed
2877 }
2878 }
2879
2880 return result
2881}
2882
2883// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2884// to "" won't be in this list because they shouldn't be renamed yet.
2885func getJarJarRuleText(provider *JarJarProviderData) string {
2886 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002887 for _, orig := range android.SortedKeys(provider.Rename) {
2888 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002889 if renamed != "" {
2890 result += "rule " + orig + " " + renamed + "\n"
2891 }
2892 }
2893 return result
2894}
2895
Zi Wangddb2ee52024-04-02 16:44:02 +00002896// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002897func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Zi Wangddb2ee52024-04-02 16:44:02 +00002898 if j.repackageJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002899 return infile, false
Zi Wangddb2ee52024-04-02 16:44:02 +00002900 }
Colin Crossedec77c2024-07-26 15:25:40 -07002901 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002902 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002903 return repackagedJarjarFile, true
Zi Wangddb2ee52024-04-02 16:44:02 +00002904}
2905
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002906func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Colin Crossedec77c2024-07-26 15:25:40 -07002907 if j.expandJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002908 return infile, false
Colin Crossedec77c2024-07-26 15:25:40 -07002909 }
2910 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2911 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002912 return jarjarFile, true
Colin Crossedec77c2024-07-26 15:25:40 -07002913
2914}
2915
Jaewoong Jung26342642021-03-17 15:56:23 -07002916func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2917 deps.processorPath = append(deps.processorPath, pluginJars...)
2918 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2919}
2920
2921// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2922// this interface.
2923type ProvidesUsesLib interface {
2924 ProvidesUsesLib() *string
2925}
2926
2927func (j *Module) ProvidesUsesLib() *string {
2928 return j.usesLibraryProperties.Provides_uses_lib
2929}
satayev1c564cc2021-05-25 19:50:30 +01002930
2931type ModuleWithStem interface {
2932 Stem() string
2933}
2934
2935var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002936
2937type ModuleWithUsesLibrary interface {
2938 UsesLibrary() *usesLibrary
2939}
2940
2941func (j *Module) UsesLibrary() *usesLibrary {
2942 return &j.usesLibrary
2943}
2944
2945var _ ModuleWithUsesLibrary = (*Module)(nil)