blob: 7a957350a385a77890120b9b95835fd692e8c164 [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"
Jaewoong Jung26342642021-03-17 15:56:23 -070027 "github.com/google/blueprint/pathtools"
28 "github.com/google/blueprint/proptools"
29
30 "android/soong/android"
31 "android/soong/dexpreopt"
32 "android/soong/java/config"
33)
34
35// This file contains the definition and the implementation of the base module that most
36// source-based Java module structs embed.
37
38// TODO:
39// Autogenerated files:
40// Renderscript
41// Post-jar passes:
42// Proguard
43// Rmtypedefs
44// DroidDoc
45// Findbugs
46
47// Properties that are common to most Java modules, i.e. whether it's a host or device module.
48type CommonProperties struct {
49 // list of source files used to compile the Java module. May be .java, .kt, .logtags, .proto,
50 // or .aidl files.
51 Srcs []string `android:"path,arch_variant"`
52
53 // list Kotlin of source files containing Kotlin code that should be treated as common code in
54 // a codebase that supports Kotlin multiplatform. See
55 // https://kotlinlang.org/docs/reference/multiplatform.html. May be only be .kt files.
56 Common_srcs []string `android:"path,arch_variant"`
57
58 // list of source files that should not be used to build the Java module.
59 // This is most useful in the arch/multilib variants to remove non-common files
60 Exclude_srcs []string `android:"path,arch_variant"`
61
62 // list of directories containing Java resources
63 Java_resource_dirs []string `android:"arch_variant"`
64
65 // list of directories that should be excluded from java_resource_dirs
66 Exclude_java_resource_dirs []string `android:"arch_variant"`
67
68 // list of files to use as Java resources
69 Java_resources []string `android:"path,arch_variant"`
70
71 // list of files that should be excluded from java_resources and java_resource_dirs
72 Exclude_java_resources []string `android:"path,arch_variant"`
73
74 // list of module-specific flags that will be used for javac compiles
75 Javacflags []string `android:"arch_variant"`
76
77 // list of module-specific flags that will be used for kotlinc compiles
78 Kotlincflags []string `android:"arch_variant"`
79
80 // list of java libraries that will be in the classpath
81 Libs []string `android:"arch_variant"`
82
83 // list of java libraries that will be compiled into the resulting jar
Cole Faustb7493472024-08-28 11:55:52 -070084 Static_libs proptools.Configurable[[]string] `android:"arch_variant"`
Jaewoong Jung26342642021-03-17 15:56:23 -070085
86 // manifest file to be included in resulting jar
87 Manifest *string `android:"path"`
88
89 // if not blank, run jarjar using the specified rules file
90 Jarjar_rules *string `android:"path,arch_variant"`
91
Joe Onoratoa5d17172024-07-20 17:39:56 -070092 // java class names to rename with jarjar when a reverse dependency has a jarjar_prefix
93 // property.
94 Jarjar_rename []string
95
Joe Onorato349ae8d2024-02-05 22:46:00 +000096 // if not blank, used as prefix to generate repackage rule
97 Jarjar_prefix *string
98
Jaewoong Jung26342642021-03-17 15:56:23 -070099 // If not blank, set the java version passed to javac as -source and -target
100 Java_version *string
101
102 // If set to true, allow this module to be dexed and installed on devices. Has no
103 // effect on host modules, which are always considered installable.
104 Installable *bool
105
106 // If set to true, include sources used to compile the module in to the final jar
107 Include_srcs *bool
108
109 // If not empty, classes are restricted to the specified packages and their sub-packages.
110 // This restriction is checked after applying jarjar rules and including static libs.
111 Permitted_packages []string
112
113 // List of modules to use as annotation processors
114 Plugins []string
115
116 // List of modules to export to libraries that directly depend on this library as annotation
117 // processors. Note that if the plugins set generates_api: true this will disable the turbine
118 // optimization on modules that depend on this module, which will reduce parallelism and cause
119 // more recompilation.
120 Exported_plugins []string
121
122 // The number of Java source entries each Javac instance can process
123 Javac_shard_size *int64
124
125 // Add host jdk tools.jar to bootclasspath
126 Use_tools_jar *bool
127
128 Openjdk9 struct {
129 // List of source files that should only be used when passing -source 1.9 or higher
130 Srcs []string `android:"path"`
131
132 // List of javac flags that should only be used when passing -source 1.9 or higher
133 Javacflags []string
134 }
135
136 // When compiling language level 9+ .java code in packages that are part of
137 // a system module, patch_module names the module that your sources and
138 // dependencies should be patched into. The Android runtime currently
139 // doesn't implement the JEP 261 module system so this option is only
140 // supported at compile time. It should only be needed to compile tests in
141 // packages that exist in libcore and which are inconvenient to move
142 // elsewhere.
Liz Kammer0a470a32023-10-05 17:02:00 -0400143 Patch_module *string
Jaewoong Jung26342642021-03-17 15:56:23 -0700144
145 Jacoco struct {
146 // List of classes to include for instrumentation with jacoco to collect coverage
147 // information at runtime when building with coverage enabled. If unset defaults to all
148 // classes.
149 // Supports '*' as the last character of an entry in the list as a wildcard match.
150 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
151 // it matches classes in the package that have the class name as a prefix.
152 Include_filter []string
153
154 // List of classes to exclude from instrumentation with jacoco to collect coverage
155 // information at runtime when building with coverage enabled. Overrides classes selected
156 // by the include_filter property.
157 // Supports '*' as the last character of an entry in the list as a wildcard match.
158 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
159 // it matches classes in the package that have the class name as a prefix.
160 Exclude_filter []string
161 }
162
163 Errorprone struct {
164 // List of javac flags that should only be used when running errorprone.
165 Javacflags []string
166
167 // List of java_plugin modules that provide extra errorprone checks.
168 Extra_check_modules []string
Cole Faust75fffb12021-06-13 15:23:16 -0700169
Cole Faust2b1536e2021-06-18 12:25:54 -0700170 // This property can be in 3 states. When set to true, errorprone will
171 // be run during the regular build. When set to false, errorprone will
172 // never be run. When unset, errorprone will be run when the RUN_ERROR_PRONE
173 // environment variable is true. Setting this to false will improve build
174 // performance more than adding -XepDisableAllChecks in javacflags.
Cole Faust75fffb12021-06-13 15:23:16 -0700175 Enabled *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700176 }
177
178 Proto struct {
179 // List of extra options that will be passed to the proto generator.
180 Output_params []string
181 }
182
Sam Delmericoc7593722022-08-31 15:57:52 -0400183 // If true, then jacocoagent is automatically added as a libs dependency so that
184 // r8 will not strip instrumentation classes out of dexed libraries.
Jaewoong Jung26342642021-03-17 15:56:23 -0700185 Instrument bool `blueprint:"mutated"`
Paul Duffin0038a8d2022-05-03 00:28:40 +0000186 // If true, then the module supports statically including the jacocoagent
187 // into the library.
188 Supports_static_instrumentation bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700189
190 // List of files to include in the META-INF/services folder of the resulting jar.
191 Services []string `android:"path,arch_variant"`
192
193 // If true, package the kotlin stdlib into the jar. Defaults to true.
194 Static_kotlin_stdlib *bool `android:"arch_variant"`
195
196 // A list of java_library instances that provide additional hiddenapi annotations for the library.
197 Hiddenapi_additional_annotations []string
Joe Onorato175073c2023-06-01 14:42:59 -0700198
199 // Additional srcJars tacked in by GeneratedJavaLibraryModule
200 Generated_srcjars []android.Path `android:"mutated"`
Mark Whitea15790a2023-08-22 21:28:11 +0000201
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000202 // intermediate aconfig cache file tacked in by GeneratedJavaLibraryModule
203 Aconfig_Cache_files []android.Path `android:"mutated"`
204
Mark Whitea15790a2023-08-22 21:28:11 +0000205 // If true, then only the headers are built and not the implementation jar.
Liz Kammer60772632023-10-05 17:18:44 -0400206 Headers_only *bool
Cole Faust2b64af82023-12-13 18:22:18 -0800207
208 // A list of files or dependencies to make available to the build sandbox. This is
209 // useful if source files are symlinks, the targets of the symlinks must be listed here.
210 // Note that currently not all actions implemented by android_apps are sandboxed, so you
211 // may only see this being necessary in lint builds.
212 Compile_data []string `android:"path"`
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000213
214 // Property signifying whether the module compiles stubs or not.
215 // Should be set to true when srcs of this module are stub files.
216 // This property does not need to be set to true when the module depends on
217 // the stubs via libs, but should be set to true when the module depends on
218 // the stubs via static libs.
219 Is_stubs_module *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700220
Makoto Onuki7ded3822024-03-28 14:42:20 -0700221 Ravenizer struct {
John Wu989ee842024-10-04 00:21:43 +0000222 // If true, enable the "Ravenizer" tool on the output jar.
223 // "Ravenizer" is a tool for Ravenwood tests, but it can also be enabled on other kinds
224 // of java targets.
Makoto Onuki7ded3822024-03-28 14:42:20 -0700225 Enabled *bool
John Wu989ee842024-10-04 00:21:43 +0000226
227 // If true, the "Ravenizer" tool will remove all Mockito and DexMaker
228 // classes from the output jar.
229 Strip_mockito *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700230 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +0000231
232 // Contributing api surface of the stub module. Is not visible to bp modules, and should
233 // only be set for stub submodules generated by the java_sdk_library
234 Stub_contributing_api *string `blueprint:"mutated"`
Yihan Dong8be09c22024-08-29 15:32:13 +0800235
236 // If true, enable the "ApiMapper" tool on the output jar. "ApiMapper" is a tool to inject
237 // bytecode to log API calls.
238 ApiMapper bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700239}
240
241// Properties that are specific to device modules. Host module factories should not add these when
242// constructing a new module.
243type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000244 // If not blank, set to the version of the sdk to compile against.
Spandan Das1ccf5742022-10-14 16:51:23 +0000245 // Defaults to an empty string, which compiles the module against the private platform APIs.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000246 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000247 // 1) numerical API level, "current", "none", or "core_platform"
248 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
249 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
250 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700251 Sdk_version *string
252
satayev0a420e72021-11-29 17:25:52 +0000253 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
254 // Defaults to empty string "". See sdk_version for possible values.
255 Max_sdk_version *string
256
William Loh5a082f92022-05-17 20:21:50 +0000257 // if not blank, set the maxSdkVersion properties of permission and uses-permission tags.
258 // Defaults to empty string "". See sdk_version for possible values.
259 Replace_max_sdk_version_placeholder *string
260
Jaewoong Jung26342642021-03-17 15:56:23 -0700261 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000262 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700263 Target_sdk_version *string
264
265 // Whether to compile against the platform APIs instead of an SDK.
266 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000267 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700268 Platform_apis *bool
269
270 Aidl struct {
271 // Top level directories to pass to aidl tool
272 Include_dirs []string
273
274 // Directories rooted at the Android.bp file to pass to aidl tool
275 Local_include_dirs []string
276
277 // directories that should be added as include directories for any aidl sources of modules
278 // that depend on this module, as well as to aidl for this module.
279 Export_include_dirs []string
280
281 // whether to generate traces (for systrace) for this interface
282 Generate_traces *bool
283
284 // whether to generate Binder#GetTransaction name method.
285 Generate_get_transaction_name *bool
286
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100287 // whether all interfaces should be annotated with required permissions.
288 Enforce_permissions *bool
289
290 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
291 Enforce_permissions_exceptions []string `android:"path"`
292
Jaewoong Jung26342642021-03-17 15:56:23 -0700293 // list of flags that will be passed to the AIDL compiler
294 Flags []string
295 }
296
297 // If true, export a copy of the module as a -hostdex module for host testing.
298 Hostdex *bool
299
300 Target struct {
301 Hostdex struct {
302 // Additional required dependencies to add to -hostdex modules.
303 Required []string
304 }
305 }
306
307 // When targeting 1.9 and above, override the modules to use with --system,
308 // otherwise provides defaults libraries to add to the bootclasspath.
309 System_modules *string
310
Jaewoong Jung26342642021-03-17 15:56:23 -0700311 IsSDKLibrary bool `blueprint:"mutated"`
312
313 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
314 // Defaults to false.
315 V4_signature *bool
316
317 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
318 // public stubs library.
319 SyspropPublicStub string `blueprint:"mutated"`
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000320
321 HiddenAPIPackageProperties
322 HiddenAPIFlagFileProperties
Jaewoong Jung26342642021-03-17 15:56:23 -0700323}
324
yangbill2af0b6e2024-03-15 09:29:29 +0000325// Properties that can be overridden by overriding module (e.g. override_android_app)
326type OverridableProperties struct {
Jooyung Han01d80d82022-01-08 12:16:32 +0900327 // set the name of the output. If not set, `name` is used.
328 // To override a module with this property set, overriding module might need to set this as well.
329 // Otherwise, both the overridden and the overriding modules will have the same output name, which
330 // can cause the duplicate output error.
331 Stem *string
Spandan Dasb9c58352024-05-13 18:29:45 +0000332
333 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
334 // Defaults to sdk_version if not set. See sdk_version for possible values.
335 Min_sdk_version *string
Jooyung Han01d80d82022-01-08 12:16:32 +0900336}
337
Jaewoong Jung26342642021-03-17 15:56:23 -0700338// Functionality common to Module and Import
339//
340// It is embedded in Module so its functionality can be used by methods in Module
341// but it is currently only initialized by Import and Library.
342type embeddableInModuleAndImport struct {
343
344 // Functionality related to this being used as a component of a java_sdk_library.
345 EmbeddableSdkLibraryComponent
346}
347
Paul Duffin71b33cc2021-06-23 11:39:47 +0100348func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
349 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700350}
351
352// Module/Import's DepIsInSameApex(...) delegates to this method.
353//
354// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
355// the one provided by ApexModuleBase.
356func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
357 // dependencies other than the static linkage are all considered crossing APEX boundary
358 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
359 return true
360 }
361 return false
362}
363
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100364// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
365// or an invalid path describing the reason it is invalid.
366//
367// It is unset if a dex jar isn't applicable, i.e. no build rule has been
368// requested to create one.
369//
370// If a dex jar has been requested to be built then it is set, and it may be
371// either a valid android.Path, or invalid with a reason message. The latter
372// happens if the source that should produce the dex file isn't able to.
373//
374// E.g. it is invalid with a reason message if there is a prebuilt APEX that
375// could produce the dex jar through a deapexer module, but the APEX isn't
376// installable so doing so wouldn't be safe.
377type OptionalDexJarPath struct {
378 isSet bool
379 path android.OptionalPath
380}
381
382// IsSet returns true if a path has been set, either invalid or valid.
383func (o OptionalDexJarPath) IsSet() bool {
384 return o.isSet
385}
386
387// Valid returns true if there is a path that is valid.
388func (o OptionalDexJarPath) Valid() bool {
389 return o.isSet && o.path.Valid()
390}
391
392// Path returns the valid path, or panics if it's either not set or is invalid.
393func (o OptionalDexJarPath) Path() android.Path {
394 if !o.isSet {
395 panic("path isn't set")
396 }
397 return o.path.Path()
398}
399
400// PathOrNil returns the path if it's set and valid, or else nil.
401func (o OptionalDexJarPath) PathOrNil() android.Path {
402 if o.Valid() {
403 return o.Path()
404 }
405 return nil
406}
407
408// InvalidReason returns the reason for an invalid path, which is never "". It
409// returns "" for an unset or valid path.
410func (o OptionalDexJarPath) InvalidReason() string {
411 if !o.isSet {
412 return ""
413 }
414 return o.path.InvalidReason()
415}
416
417func (o OptionalDexJarPath) String() string {
418 if !o.isSet {
419 return "<unset>"
420 }
421 return o.path.String()
422}
423
424// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
425func makeUnsetDexJarPath() OptionalDexJarPath {
426 return OptionalDexJarPath{isSet: false}
427}
428
429// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
430// the given OptionalPath, which may be valid or invalid.
431func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
432 return OptionalDexJarPath{isSet: true, path: path}
433}
434
435// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
436// valid given path. It returns an unset OptionalDexJarPath if the given path is
437// nil.
438func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
439 if path == nil {
440 return makeUnsetDexJarPath()
441 }
442 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
443}
444
Jaewoong Jung26342642021-03-17 15:56:23 -0700445// Module contains the properties and members used by all java module types
446type Module struct {
447 android.ModuleBase
448 android.DefaultableModuleBase
449 android.ApexModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700450
451 // Functionality common to Module and Import.
452 embeddableInModuleAndImport
453
454 properties CommonProperties
455 protoProperties android.ProtoProperties
456 deviceProperties DeviceProperties
457
yangbill2af0b6e2024-03-15 09:29:29 +0000458 overridableProperties OverridableProperties
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700459 sourceProperties android.SourceProperties
Jooyung Han01d80d82022-01-08 12:16:32 +0900460
Jaewoong Jung26342642021-03-17 15:56:23 -0700461 // jar file containing header classes including static library dependencies, suitable for
462 // inserting into the bootclasspath/classpath of another compile
463 headerJarFile android.Path
464
465 // jar file containing implementation classes including static library dependencies but no
466 // resources
467 implementationJarFile android.Path
468
Jaewoong Jung26342642021-03-17 15:56:23 -0700469 // args and dependencies to package source files into a srcjar
470 srcJarArgs []string
471 srcJarDeps android.Paths
472
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000473 // the source files of this module and all its static dependencies
474 transitiveSrcFiles *android.DepSet[android.Path]
475
Jaewoong Jung26342642021-03-17 15:56:23 -0700476 // jar file containing implementation classes and resources including static library
477 // dependencies
478 implementationAndResourcesJar android.Path
479
480 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100481 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700482
483 // output file containing uninstrumented classes that will be instrumented by jacoco
484 jacocoReportClassesFile android.Path
485
486 // output file of the module, which may be a classes jar or a dex jar
487 outputFile android.Path
488 extraOutputFiles android.Paths
489
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100490 exportAidlIncludeDirs android.Paths
491 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700492
493 logtagsSrcs android.Paths
494
495 // installed file for binary dependency
496 installFile android.Path
497
Colin Cross3108ce12021-11-10 14:38:50 -0800498 // installed file for hostdex copy
499 hostdexInstallFile android.InstallPath
500
Chaohui Wangdcbe33c2022-10-11 11:13:30 +0800501 // list of unique .java and .kt source files
502 uniqueSrcFiles android.Paths
503
504 // list of srcjars that was passed to javac
505 compiledSrcJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700506
507 // manifest file to use instead of properties.Manifest
508 overrideManifest android.OptionalPath
509
Jaewoong Jung26342642021-03-17 15:56:23 -0700510 // list of plugins that this java module is exporting
511 exportedPluginJars android.Paths
512
513 // list of plugins that this java module is exporting
514 exportedPluginClasses []string
515
516 // if true, the exported plugins generate API and require disabling turbine.
517 exportedDisableTurbine bool
518
519 // list of source files, collected from srcFiles with unique java and all kt files,
520 // will be used by android.IDEInfo struct
521 expandIDEInfoCompiledSrcs []string
522
523 // expanded Jarjar_rules
524 expandJarjarRules android.Path
525
Joe Onorato349ae8d2024-02-05 22:46:00 +0000526 // jarjar rule for inherited jarjar rules
527 repackageJarjarRules android.Path
528
Jaewoong Jung26342642021-03-17 15:56:23 -0700529 // Extra files generated by the module type to be added as java resources.
530 extraResources android.Paths
531
532 hiddenAPI
533 dexer
534 dexpreopter
535 usesLibrary
536 linter
537
538 // list of the xref extraction files
Spandan Das1028d5a2024-08-19 21:45:48 +0000539 kytheFiles android.Paths
540 kytheKotlinFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700541
Jaewoong Jung26342642021-03-17 15:56:23 -0700542 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900543
544 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000545 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000546 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400547
548 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000549
550 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000551
552 // output file name based on Stem property.
553 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
554 // or the module should override Stem().
555 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700556
Joe Onorato349ae8d2024-02-05 22:46:00 +0000557 // Values that will be set in the JarJarProvider data for jarjar repackaging,
558 // and merged with our dependencies' rules.
559 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000560
561 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000562
563 // Paths to the aconfig intermediate cache files that are provided by the
564 // java_aconfig_library or java_library modules that are statically linked
565 // to this module. Does not contain cache files from all transitive dependencies.
566 aconfigCacheFiles android.Paths
Spandan Das8aac9932024-07-18 23:14:13 +0000567
568 // List of soong module dependencies required to compile the current module.
569 // This information is printed out to `Dependencies` field in module_bp_java_deps.json
570 compileDepNames []string
Makoto Onuki7ded3822024-03-28 14:42:20 -0700571
572 ravenizer struct {
573 enabled bool
574 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700575}
576
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000577var _ android.InstallableModule = (*Module)(nil)
578
579// To satisfy the InstallableModule interface
Jihoon Kang224ea082024-08-12 22:38:16 +0000580func (j *Module) StaticDependencyTags() []blueprint.DependencyTag {
581 return []blueprint.DependencyTag{staticLibTag}
582}
583
584// To satisfy the InstallableModule interface
585func (j *Module) DynamicDependencyTags() []blueprint.DependencyTag {
586 return []blueprint.DependencyTag{libTag, sdkLibTag, bootClasspathTag, systemModulesTag,
587 instrumentationForTag, java9LibTag}
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000588}
589
590// Overrides android.ModuleBase.InstallInProduct()
591func (j *Module) InstallInProduct() bool {
592 return j.ProductSpecific()
593}
594
Jihoon Kang85bc1932024-07-01 17:04:46 +0000595var _ android.StubsAvailableModule = (*Module)(nil)
596
597// To safisfy the StubsAvailableModule interface
598func (j *Module) IsStubsModule() bool {
599 return proptools.Bool(j.properties.Is_stubs_module)
600}
601
Jiyong Park92315372021-04-02 08:45:46 +0900602func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
603 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900604 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700605 return nil
606 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900607 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000608 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700609 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
610 } else {
611 // Treat stable core platform as stable.
612 return nil
613 }
614 } else {
615 return fmt.Errorf("non stable SDK %v", sdkVersion)
616 }
617}
618
619// checkSdkVersions enforces restrictions around SDK dependencies.
620func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
621 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900622 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900623 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700624 ctx.PropertyErrorf("sdk_version",
625 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
626 }
627 }
628 }
629
630 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
631 // See rank() for details.
632 ctx.VisitDirectDeps(func(module android.Module) {
633 tag := ctx.OtherModuleDependencyTag(module)
634 switch module.(type) {
635 // TODO(satayev): cover other types as well, e.g. imports
636 case *Library, *AndroidLibrary:
637 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400638 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700639 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
640 }
641 }
642 })
643}
644
645func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900646 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700647 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900648 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700649 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000650 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 -0700651 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000652 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 -0700653 }
654
655 }
656}
657
Mark Whitea15790a2023-08-22 21:28:11 +0000658func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
659 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400660 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000661 installable := proptools.Bool(j.properties.Installable)
662
663 if headersOnly && installable {
664 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.")
665 }
666 }
667}
668
Jaewoong Jung26342642021-03-17 15:56:23 -0700669func (j *Module) addHostProperties() {
670 j.AddProperties(
671 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000672 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700673 &j.protoProperties,
674 &j.usesLibraryProperties,
675 )
676}
677
678func (j *Module) addHostAndDeviceProperties() {
679 j.addHostProperties()
680 j.AddProperties(
681 &j.deviceProperties,
682 &j.dexer.dexProperties,
683 &j.dexpreoptProperties,
684 &j.linter.properties,
685 )
686}
687
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000688// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
689// makes it available through the hiddenAPIPropertyInfoProvider.
690func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
691 hiddenAPIInfo := newHiddenAPIPropertyInfo()
692
693 // Populate with flag file paths from the properties.
694 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
695
696 // Populate with package rules from the properties.
697 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
698
Colin Cross40213022023-12-13 15:19:49 -0800699 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000700}
701
mrziwang9f7b9f42024-07-10 12:18:06 -0700702// helper method for java modules to set OutputFilesProvider
703func setOutputFiles(ctx android.ModuleContext, m Module) {
704 ctx.SetOutputFiles(append(android.Paths{m.outputFile}, m.extraOutputFiles...), "")
705 ctx.SetOutputFiles(android.Paths{m.outputFile}, android.DefaultDistTag)
706 ctx.SetOutputFiles(android.Paths{m.implementationAndResourcesJar}, ".jar")
707 ctx.SetOutputFiles(android.Paths{m.headerJarFile}, ".hjar")
708 if m.dexer.proguardDictionary.Valid() {
709 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
710 }
711 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
Jaewoong Jung26342642021-03-17 15:56:23 -0700712}
713
Jaewoong Jung26342642021-03-17 15:56:23 -0700714func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
715 initJavaModule(module, hod, false)
716}
717
718func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
719 initJavaModule(module, hod, true)
720}
721
722func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
723 multilib := android.MultilibCommon
724 if multiTargets {
725 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
726 } else {
727 android.InitAndroidArchModule(module, hod, multilib)
728 }
729 android.InitDefaultableModule(module)
730}
731
732func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
733 return j.properties.Instrument &&
734 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
735 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
736}
737
Yihan Dong8be09c22024-08-29 15:32:13 +0800738func (j *Module) shouldApiMapper() bool {
739 return j.properties.ApiMapper
740}
741
Jaewoong Jung26342642021-03-17 15:56:23 -0700742func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000743 return j.properties.Supports_static_instrumentation &&
744 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700745 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
746 ctx.Config().UnbundledBuild())
747}
748
749func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
750 // Force enable the instrumentation for java code that is built for APEXes ...
751 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
752 // 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 -0800753 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700754 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000755
Jihoon Kang46d66de2024-05-22 22:42:39 +0000756 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700757 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
758 return true
759 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
760 return true
761 }
762 }
763 return false
764}
765
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400766func (j *Module) setInstrument(value bool) {
767 j.properties.Instrument = value
768}
769
Yihan Dong8be09c22024-08-29 15:32:13 +0800770func (j *Module) setApiMapper(value bool) {
771 j.properties.ApiMapper = value
772}
773
Jiyong Park92315372021-04-02 08:45:46 +0900774func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
775 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700776}
777
Jiyong Parkf1691d22021-03-29 20:11:58 +0900778func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700779 return proptools.String(j.deviceProperties.System_modules)
780}
781
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000782func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000783 if j.overridableProperties.Min_sdk_version != nil {
784 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700785 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000786 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700787}
788
Yu Liuf2b94012023-09-19 15:09:10 -0700789func (j *Module) GetDeviceProperties() *DeviceProperties {
790 return &j.deviceProperties
791}
792
Spandan Dasa26eda72023-03-02 00:56:06 +0000793func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
794 if j.deviceProperties.Max_sdk_version != nil {
795 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
796 }
797 // Default is PrivateApiLevel
798 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000799}
800
Spandan Dasa26eda72023-03-02 00:56:06 +0000801func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
802 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
803 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
804 }
805 // Default is PrivateApiLevel
806 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000807}
808
Jiyong Parkf1691d22021-03-29 20:11:58 +0900809func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000810 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900811}
812
Spandan Dasca70fc42023-03-01 23:38:49 +0000813func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900814 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000815 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900816 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000817 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700818}
819
820func (j *Module) AvailableFor(what string) bool {
821 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
822 // Exception: for hostdex: true libraries, the platform variant is created
823 // even if it's not marked as available to platform. In that case, the platform
824 // variant is used only for the hostdex and not installed to the device.
825 return true
826 }
827 return j.ApexModuleBase.AvailableFor(what)
828}
829
Cole Faustb7493472024-08-28 11:55:52 -0700830func (j *Module) staticLibs(ctx android.BaseModuleContext) []string {
Jihoon Kang8bce3812024-09-30 18:46:51 +0000831 return j.properties.Static_libs.GetOrDefault(ctx, nil)
Cole Faustb7493472024-08-28 11:55:52 -0700832}
833
Jaewoong Jung26342642021-03-17 15:56:23 -0700834func (j *Module) deps(ctx android.BottomUpMutatorContext) {
835 if ctx.Device() {
836 j.linter.deps(ctx)
837
Jiyong Parkf1691d22021-03-29 20:11:58 +0900838 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700839
840 if j.deviceProperties.SyspropPublicStub != "" {
841 // This is a sysprop implementation library that has a corresponding sysprop public
842 // stubs library, and a dependency on it so that dependencies on the implementation can
843 // be forwarded to the public stubs library when necessary.
844 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
845 }
846 }
847
848 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000849
Cole Faustb7493472024-08-28 11:55:52 -0700850 ctx.AddVariationDependencies(nil, staticLibTag, j.staticLibs(ctx)...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700851
852 // Add dependency on libraries that provide additional hidden api annotations.
853 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
854
Jaewoong Jung26342642021-03-17 15:56:23 -0700855 // For library dependencies that are component libraries (like stubs), add the implementation
856 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
857 for _, dep := range libDeps {
858 if dep != nil {
859 if component, ok := dep.(SdkLibraryComponentDependency); ok {
860 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000861 // Add library as optional if it's one of the optional compatibility libs or it's
862 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100863 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000864 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
865 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100866 tag = usesLibOptTag
867 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100868 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700869 }
870 }
871 }
872 }
873
874 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
875 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
876 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
877
878 android.ProtoDeps(ctx, &j.protoProperties)
879 if j.hasSrcExt(".proto") {
880 protoDeps(ctx, &j.protoProperties)
881 }
882
883 if j.hasSrcExt(".kt") {
884 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
885 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700886 tag := staticLibTag
887 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
888 tag = libTag
889 }
890 ctx.AddVariationDependencies(nil, tag,
891 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700892 }
893
894 // Framework libraries need special handling in static coverage builds: they should not have
895 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
896 // the same jacoco classes coming from different bootclasspath jars.
897 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
898 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
899 j.properties.Instrument = true
900 }
901 } else if j.shouldInstrumentStatic(ctx) {
902 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
903 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700904
Cole Faustb7493472024-08-28 11:55:52 -0700905 if j.useCompose(ctx) {
Colin Crossa1ff7c62021-09-17 14:11:52 -0700906 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
907 "androidx.compose.compiler_compiler-hosted")
908 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700909}
910
911func hasSrcExt(srcs []string, ext string) bool {
912 for _, src := range srcs {
913 if filepath.Ext(src) == ext {
914 return true
915 }
916 }
917
918 return false
919}
920
921func (j *Module) hasSrcExt(ext string) bool {
922 return hasSrcExt(j.properties.Srcs, ext)
923}
924
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100925func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
926 var flags string
927
928 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
929 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
930 flags = "-Wmissing-permission-annotation -Werror"
931 }
932 }
933 return flags
934}
935
Jaewoong Jung26342642021-03-17 15:56:23 -0700936func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000937 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700938
939 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
940 aidlIncludes = append(aidlIncludes,
941 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
942 aidlIncludes = append(aidlIncludes,
943 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
944
945 var flags []string
946 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000947 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700948
949 flags = append(flags, j.deviceProperties.Aidl.Flags...)
950
951 if aidlPreprocess.Valid() {
952 flags = append(flags, "-p"+aidlPreprocess.String())
953 deps = append(deps, aidlPreprocess.Path())
954 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000955 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700956 }
957
958 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000959 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700960 }
961
962 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000963 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700964 }
965
Sam Delmerico2351eac2022-05-24 17:10:02 +0000966 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700967 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000968 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700969 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000970 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
971 // add flags for dirs containing AIDL srcs that haven't been specified yet
972 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -0700973
Zim8774ae12022-08-17 11:46:34 +0100974 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +0000975 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +0100976 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700977 flags = append(flags, "-t")
978 }
979
980 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
981 flags = append(flags, "--transaction_names")
982 }
983
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100984 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
985 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
986 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
987 }
988
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000989 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +0900990 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
991
Jaewoong Jung26342642021-03-17 15:56:23 -0700992 return strings.Join(flags, " "), deps
993}
994
995func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
996
997 var flags javaBuilderFlags
998
999 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001000 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001001
Cole Faust2b1536e2021-06-18 12:25:54 -07001002 epEnabled := j.properties.Errorprone.Enabled
1003 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001004 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001005 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1006 }
1007
1008 errorProneFlags := []string{
1009 "-Xplugin:ErrorProne",
1010 "${config.ErrorProneChecks}",
1011 }
1012 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1013
Colin Cross8bf6cad2022-02-28 13:07:03 -08001014 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001015 "'" + strings.Join(errorProneFlags, " ") + "'"
1016 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1017 }
1018
1019 // classpath
1020 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1021 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001022 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001023 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1024 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1025 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1026
1027 flags.processors = append(flags.processors, deps.processorClasses...)
1028 flags.processors = android.FirstUniqueStrings(flags.processors)
1029
1030 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001031 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001032 // Give host-side tools a version of OpenJDK's standard libraries
1033 // close to what they're targeting. As of Dec 2017, AOSP is only
1034 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1035 //
1036 // When building with OpenJDK 8, the following should have no
1037 // effect since those jars would be available by default.
1038 //
1039 // When building with OpenJDK 9 but targeting a version < 1.8,
1040 // putting them on the bootclasspath means that:
1041 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1042 // b) references to existing APIs are not reinterpreted in an
1043 // OpenJDK 9-specific way, eg. calls to subclasses of
1044 // java.nio.Buffer as in http://b/70862583
1045 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1046 flags.bootClasspath = append(flags.bootClasspath,
1047 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1048 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1049 if Bool(j.properties.Use_tools_jar) {
1050 flags.bootClasspath = append(flags.bootClasspath,
1051 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1052 }
1053 }
1054
1055 // systemModules
1056 flags.systemModules = deps.systemModules
1057
Jaewoong Jung26342642021-03-17 15:56:23 -07001058 return flags
1059}
1060
1061func (j *Module) collectJavacFlags(
1062 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1063 // javac flags.
1064 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001065 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001066
Mythri Alle4b9f6182023-10-25 15:17:11 +00001067 needsDebugInfo = false
1068 for _, flag := range javacFlags {
1069 if strings.HasPrefix(flag, "-g") {
1070 needsDebugInfo = true
1071 }
1072 }
1073
1074 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001075 // For non-host binaries, override the -g flag passed globally to remove
1076 // local variable debug info to reduce disk and memory usage.
1077 javacFlags = append(javacFlags, "-g:source,lines")
1078 }
1079 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1080
1081 if flags.javaVersion.usesJavaModules() {
1082 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001083 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1084 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1085 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1086 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001087
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001088 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001089 if j.properties.Patch_module != nil {
1090 // Manually specify build directory in case it is not under the repo root.
1091 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1092 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001093 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001094
Jaewoong Jung26342642021-03-17 15:56:23 -07001095 classPath := flags.classpath.FormJavaClassPath("")
1096 if classPath != "" {
1097 patchPaths = append(patchPaths, classPath)
1098 }
1099 javacFlags = append(
1100 javacFlags,
1101 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1102 }
1103 }
1104
1105 if len(javacFlags) > 0 {
1106 // optimization.
1107 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1108 flags.javacFlags = "$javacFlags"
1109 }
1110
1111 return flags
1112}
1113
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001114func (j *Module) AddJSONData(d *map[string]interface{}) {
1115 (&j.ModuleBase).AddJSONData(d)
1116 (*d)["Java"] = map[string]interface{}{
1117 "SourceExtensions": j.sourceExtensions,
1118 }
1119
1120}
1121
usta0391ca42023-09-19 15:51:59 -04001122func (j *Module) addGeneratedSrcJars(path android.Path) {
1123 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001124}
1125
Colin Crossfdaa6722024-08-23 11:58:08 -07001126func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars, extraDepCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001127 // Auto-propagating jarjar rules
1128 jarjarProviderData := j.collectJarJarRules(ctx)
1129 if jarjarProviderData != nil {
1130 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wangddb2ee52024-04-02 16:44:02 +00001131 text := getJarJarRuleText(jarjarProviderData)
1132 if text != "" {
1133 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1134 android.WriteFileRule(ctx, ruleTextFile, text)
1135 j.repackageJarjarRules = ruleTextFile
Joe Onorato349ae8d2024-02-05 22:46:00 +00001136 }
1137 }
1138
Jaewoong Jung26342642021-03-17 15:56:23 -07001139 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1140
John Wu989ee842024-10-04 00:21:43 +00001141 // Only override the original value if explicitly set
1142 if j.properties.Ravenizer.Enabled != nil {
1143 j.ravenizer.enabled = *j.properties.Ravenizer.Enabled
Makoto Onuki7ded3822024-03-28 14:42:20 -07001144 }
1145
Jaewoong Jung26342642021-03-17 15:56:23 -07001146 deps := j.collectDeps(ctx)
1147 flags := j.collectBuilderFlags(ctx, deps)
1148
1149 if flags.javaVersion.usesJavaModules() {
1150 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001151 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1152 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1153 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001154 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001155
Jaewoong Jung26342642021-03-17 15:56:23 -07001156 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001157 j.sourceExtensions = []string{}
1158 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1159 if hasSrcExt(srcFiles.Strings(), ext) {
1160 j.sourceExtensions = append(j.sourceExtensions, ext)
1161 }
1162 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001163 if hasSrcExt(srcFiles.Strings(), ".proto") {
1164 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1165 }
1166
1167 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1168 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1169 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1170 }
1171
Sam Delmerico2351eac2022-05-24 17:10:02 +00001172 aidlSrcs := srcFiles.FilterByExt(".aidl")
1173 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1174
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001175 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001176 srcFiles = j.genSources(ctx, srcFiles, flags)
1177
1178 // Collect javac flags only after computing the full set of srcFiles to
1179 // ensure that the --patch-module lookup paths are complete.
1180 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1181
1182 srcJars := srcFiles.FilterByExt(".srcjar")
1183 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001184 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001185 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001186 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001187
1188 if j.properties.Jarjar_rules != nil {
1189 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1190 }
1191
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001192 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001193
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001194 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001195 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001196 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001197 if _, found := set[v.String()]; !found {
1198 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001199 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001200 }
1201 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001202 var uniqueKtFiles android.Paths
1203 for _, v := range srcFiles.FilterByExt(".kt") {
1204 if _, found := set[v.String()]; !found {
1205 set[v.String()] = true
1206 uniqueKtFiles = append(uniqueKtFiles, v)
1207 }
1208 }
1209
1210 var uniqueSrcFiles android.Paths
1211 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1212 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1213 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001214 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001215
Colin Crossb5db4012022-03-28 17:12:39 -07001216 // We don't currently run annotation processors in turbine, which means we can't use turbine
1217 // generated header jars when an annotation processor that generates API is enabled. One
1218 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1219 // is used to run all of the annotation processors.
1220 disableTurbine := deps.disableTurbine
1221
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001222 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001223 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1224
Colin Cross220a9a12022-03-28 17:08:01 -07001225 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001226
Colin Cross4eae06d2023-06-20 22:40:02 -07001227 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1228 // any dependencies so that it can override any non-final R classes from dependencies with the
1229 // final R classes from the app.
1230 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1231
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001232 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1233
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001234 var localImplementationJars android.Paths
1235
Mark Whitea15790a2023-08-22 21:28:11 +00001236 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001237 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001238 if srcFiles.HasExt(".kt") {
1239 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1240 }
1241 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1242 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1243 }
1244
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001245 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1246
1247 localHeaderJars, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
Colin Crossedec77c2024-07-26 15:25:40 -07001248 extraCombinedJars)
1249
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001250 combinedHeaderJarFile, jarjared := j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1251 if jarjared {
1252 localHeaderJars = android.Paths{combinedHeaderJarFile}
1253 transitiveStaticLibsHeaderJars = nil
1254 }
1255 combinedHeaderJarFile, repackaged := j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
1256 if repackaged {
1257 localHeaderJars = android.Paths{combinedHeaderJarFile}
1258 transitiveStaticLibsHeaderJars = nil
1259 }
Mark Whitea15790a2023-08-22 21:28:11 +00001260 if ctx.Failed() {
1261 return
1262 }
Colin Crossedec77c2024-07-26 15:25:40 -07001263 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001264
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001265 if ctx.Config().UseTransitiveJarsInClasspath() {
1266 if len(localHeaderJars) > 0 {
1267 ctx.CheckbuildFile(localHeaderJars...)
1268 } else {
1269 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1270 ctx.UncheckedModule()
1271 }
1272 } else {
1273 ctx.CheckbuildFile(j.headerJarFile)
1274 }
Colin Crossa6182ab2024-08-21 10:47:44 -07001275
Colin Cross7727c7f2024-07-18 15:36:32 -07001276 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001277 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001278 LocalHeaderJars: localHeaderJars,
1279 TransitiveStaticLibsHeaderJars: android.NewDepSet(android.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Cross9ffaf282024-08-12 13:50:09 -07001280 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1281 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001282 AidlIncludeDirs: j.exportAidlIncludeDirs,
1283 ExportedPlugins: j.exportedPluginJars,
1284 ExportedPluginClasses: j.exportedPluginClasses,
1285 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1286 StubsLinkType: j.stubsLinkType,
1287 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001288 })
1289
1290 j.outputFile = j.headerJarFile
1291 return
1292 }
1293
Jaewoong Jung26342642021-03-17 15:56:23 -07001294 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001295 // When using kotlin sources turbine is used to generate annotation processor sources,
1296 // including for annotation processors that generate API, so we can use turbine for
1297 // java sources too.
1298 disableTurbine = false
1299
Jaewoong Jung26342642021-03-17 15:56:23 -07001300 // user defined kotlin flags.
1301 kotlincFlags := j.properties.Kotlincflags
1302 CheckKotlincFlags(ctx, kotlincFlags)
1303
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001304 // Workaround for KT-46512
1305 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001306
1307 // If there are kotlin files, compile them first but pass all the kotlin and java files
1308 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1309 // won't emit any classes for them.
1310 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1311 if ctx.Device() {
1312 kotlincFlags = append(kotlincFlags, "-no-jdk")
1313 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001314
1315 for _, plugin := range deps.kotlinPlugins {
1316 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1317 }
1318 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1319
Jaewoong Jung26342642021-03-17 15:56:23 -07001320 if len(kotlincFlags) > 0 {
1321 // optimization.
1322 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1323 flags.kotlincFlags += "$kotlincFlags"
1324 }
1325
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001326 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001327 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1328
Jaewoong Jung26342642021-03-17 15:56:23 -07001329 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1330 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1331
Isaac Chioua23d9942022-04-06 06:14:38 +00001332 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001333 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001334 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1335 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001336 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001337 srcJars = append(srcJars, kaptSrcJar)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001338 localImplementationJars = append(localImplementationJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001339 // Disable annotation processing in javac, it's already been handled by kapt
1340 flags.processorPath = nil
1341 flags.processors = nil
1342 }
1343
1344 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001345 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Spandan Das1028d5a2024-08-19 21:45:48 +00001346 j.kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001347 if ctx.Failed() {
1348 return
1349 }
1350
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001351 kotlinJarPath, _ := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001352
Isaac Chioua23d9942022-04-06 06:14:38 +00001353 // Make javac rule depend on the kotlinc rule
1354 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1355
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001356 localImplementationJars = append(localImplementationJars, kotlinJarPath)
1357
Colin Cross220a9a12022-03-28 17:08:01 -07001358 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001359 }
1360
Jaewoong Jung26342642021-03-17 15:56:23 -07001361 j.compiledSrcJars = srcJars
1362
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001363 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1364
Jaewoong Jung26342642021-03-17 15:56:23 -07001365 enableSharding := false
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001366 var localHeaderJars android.Paths
1367 var shardingHeaderJars android.Paths
1368 var repackagedHeaderJarFile android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001369 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001370 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1371 enableSharding = true
1372 // Formerly, there was a check here that prevented annotation processors
1373 // from being used when sharding was enabled, as some annotation processors
1374 // do not function correctly in sharded environments. It was removed to
1375 // allow for the use of annotation processors that do function correctly
1376 // with sharding enabled. See: b/77284273.
1377 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001378 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001379 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001380 var combinedHeaderJarFile android.Path
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001381 localHeaderJars, combinedHeaderJarFile = j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
1382 shardingHeaderJars = localHeaderJars
Colin Crossedec77c2024-07-26 15:25:40 -07001383
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001384 var jarjared bool
1385 j.headerJarFile, jarjared = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1386 if jarjared {
1387 // jarjar modifies transitive static dependencies, use the combined header jar and drop the transitive
1388 // static libs header jars.
1389 localHeaderJars = android.Paths{j.headerJarFile}
1390 transitiveStaticLibsHeaderJars = nil
1391 }
1392 var repackaged bool
1393 repackagedHeaderJarFile, repackaged = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
1394 if repackaged {
1395 // repackage modifies transitive static dependencies, use the combined header jar and drop the transitive
1396 // static libs header jars.
1397 // TODO(b/356688296): this shouldn't export both the unmodified and repackaged header jars
1398 localHeaderJars = android.Paths{j.headerJarFile, repackagedHeaderJarFile}
1399 transitiveStaticLibsHeaderJars = nil
1400 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001401 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001402 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001403 hasErrorproneableFiles := false
1404 for _, ext := range j.sourceExtensions {
1405 if ext != ".proto" && ext != ".aidl" {
1406 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1407 // compile, and it's not useful to have warnings on these generated sources.
1408 hasErrorproneableFiles = true
1409 break
1410 }
1411 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001412 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001413 if Bool(j.properties.Errorprone.Enabled) {
1414 // If error-prone is enabled, enable errorprone flags on the regular
1415 // build.
1416 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001417 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001418 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1419 // a new jar file just for compiling with the errorprone compiler to.
1420 // This is because we don't want to cause the java files to get completely
1421 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1422 // We also don't want to run this if errorprone is enabled by default for
1423 // this module, or else we could have duplicated errorprone messages.
1424 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001425 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001426 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001427
Vadim Spivak3c496f02023-06-08 06:14:59 +00001428 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001429 "errorprone", "errorprone")
1430
Jaewoong Jung26342642021-03-17 15:56:23 -07001431 extraJarDeps = append(extraJarDeps, errorprone)
1432 }
1433
1434 if enableSharding {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001435 if len(shardingHeaderJars) > 0 {
1436 flags.classpath = append(classpath(slices.Clone(shardingHeaderJars)), flags.classpath...)
Colin Cross3d56ed52021-11-18 22:23:12 -08001437 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001438 shardSize := int(*(j.properties.Javac_shard_size))
1439 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001440 if len(uniqueJavaFiles) > 0 {
1441 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001442 for idx, shardSrc := range shardSrcs {
1443 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1444 nil, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001445 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
1446 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001447 }
1448 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001449 // Assume approximately 5 sources per srcjar.
1450 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1451 // 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 -07001452 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001453 startIdx := len(shardSrcs)
1454 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1455 for idx, shardSrcJars := range shardSrcJarsList {
1456 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1457 nil, shardSrcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001458 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
1459 localImplementationJars = append(localImplementationJars, classes)
Colin Crossa052ddb2023-09-25 21:46:58 -07001460 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001461 }
1462 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001463 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001464 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
1465 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001466 }
1467 if ctx.Failed() {
1468 return
1469 }
1470 }
1471
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001472 localImplementationJars = append(localImplementationJars, extraCombinedJars...)
Colin Crossfd620b22024-02-23 10:05:21 -08001473
Jaewoong Jung26342642021-03-17 15:56:23 -07001474 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1475
1476 var includeSrcJar android.WritablePath
1477 if Bool(j.properties.Include_srcs) {
1478 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1479 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1480 }
1481
1482 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1483 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1484 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1485 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1486
1487 var resArgs []string
1488 var resDeps android.Paths
1489
1490 resArgs = append(resArgs, dirArgs...)
1491 resDeps = append(resDeps, dirDeps...)
1492
1493 resArgs = append(resArgs, fileArgs...)
1494 resDeps = append(resDeps, fileDeps...)
1495
1496 resArgs = append(resArgs, extraArgs...)
1497 resDeps = append(resDeps, extraDeps...)
1498
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001499 var localResourceJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001500 if len(resArgs) > 0 {
1501 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1502 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001503 if ctx.Failed() {
1504 return
1505 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001506 localResourceJars = append(localResourceJars, resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001507 }
1508
Jaewoong Jung26342642021-03-17 15:56:23 -07001509 if Bool(j.properties.Include_srcs) {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001510 localResourceJars = append(localResourceJars, includeSrcJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001511 }
1512
1513 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1514 if len(services) > 0 {
1515 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1516 var zipargs []string
1517 for _, file := range services {
1518 serviceFile := file.String()
1519 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1520 }
1521 rule := zip
1522 args := map[string]string{
1523 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1524 }
1525 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1526 rule = zipRE
1527 args["implicits"] = strings.Join(services.Strings(), ",")
1528 }
1529 ctx.Build(pctx, android.BuildParams{
1530 Rule: rule,
1531 Output: servicesJar,
1532 Implicits: services,
1533 Args: args,
1534 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001535 localResourceJars = append(localResourceJars, servicesJar)
1536 }
1537
1538 completeStaticLibsResourceJars := android.NewDepSet(android.PREORDER, localResourceJars, deps.transitiveStaticLibsResourceJars)
1539
1540 var combinedResourceJar android.Path
1541 var resourceJars android.Paths
1542 if ctx.Config().UseTransitiveJarsInClasspath() {
1543 resourceJars = completeStaticLibsResourceJars.ToList()
1544 } else {
1545 resourceJars = append(slices.Clone(localResourceJars), deps.staticResourceJars...)
1546 }
1547 if len(resourceJars) == 1 {
1548 combinedResourceJar = resourceJars[0]
1549 } else if len(resourceJars) > 0 {
1550 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1551 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1552 false, nil, nil)
1553 combinedResourceJar = combinedJar
1554 }
1555
1556 manifest := j.overrideManifest
1557 if !manifest.Valid() && j.properties.Manifest != nil {
1558 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Jaewoong Jung26342642021-03-17 15:56:23 -07001559 }
1560
1561 // Combine the classes built from sources, any manifests, and any static libraries into
1562 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001563 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001564
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001565 completeStaticLibsImplementationJars := android.NewDepSet(android.PREORDER, localImplementationJars, deps.transitiveStaticLibsImplementationJars)
1566
1567 var jars android.Paths
1568 if ctx.Config().UseTransitiveJarsInClasspath() {
1569 jars = completeStaticLibsImplementationJars.ToList()
1570 } else {
1571 jars = append(slices.Clone(localImplementationJars), deps.staticJars...)
1572 }
1573
1574 jars = append(jars, extraDepCombinedJars...)
1575
Jaewoong Jung26342642021-03-17 15:56:23 -07001576 if len(jars) == 1 && !manifest.Valid() {
1577 // Optimization: skip the combine step as there is nothing to do
1578 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1579 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001580 // any if len(extraJars) == 0.
Jaewoong Jung26342642021-03-17 15:56:23 -07001581
Jihoon Kang1147b312023-06-08 23:25:57 +00001582 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1583 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1584 // either with .from-source or .from-text suffix.
1585 // outputFile should be agnostic to the build configuration,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001586 // thus copy the single input static lib in order to prevent the static lib from being exposed
Jihoon Kang1147b312023-06-08 23:25:57 +00001587 // to the copy rules.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001588 if stub, _ := moduleStubLinkType(j); stub {
1589 copiedJar := android.PathForModuleOut(ctx, "combined", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001590 ctx.Build(pctx, android.BuildParams{
1591 Rule: android.Cp,
1592 Input: jars[0],
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001593 Output: copiedJar,
Jaewoong Jung26342642021-03-17 15:56:23 -07001594 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001595 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, android.Paths{copiedJar}, nil)
1596 outputFile = copiedJar
Colin Cross7707b242024-07-26 12:02:36 -07001597 } else {
1598 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001599 }
1600 } else {
1601 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1602 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1603 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001604 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001605 }
1606
1607 // jarjar implementation jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001608 jarjarFile, jarjarred := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1609 if jarjarred {
1610 localImplementationJars = android.Paths{jarjarFile}
1611 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
1612 }
Colin Crossedec77c2024-07-26 15:25:40 -07001613 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001614
Colin Crossedec77c2024-07-26 15:25:40 -07001615 // jarjar resource jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001616 if combinedResourceJar != nil {
1617 resourceJarJarFile, jarjarred := j.jarjarIfNecessary(ctx, combinedResourceJar, jarName, "resource")
1618 combinedResourceJar = resourceJarJarFile
1619 if jarjarred {
1620 localResourceJars = android.Paths{resourceJarJarFile}
1621 completeStaticLibsResourceJars = android.NewDepSet(android.PREORDER, localResourceJars, nil)
1622 }
Colin Crossedec77c2024-07-26 15:25:40 -07001623 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001624
Colin Crossedec77c2024-07-26 15:25:40 -07001625 if ctx.Failed() {
1626 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001627 }
1628
Makoto Onuki7ded3822024-03-28 14:42:20 -07001629 if j.ravenizer.enabled {
1630 ravenizerInput := outputFile
John Wub67040d2024-10-07 18:39:06 +00001631 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", "", jarName)
John Wu989ee842024-10-04 00:21:43 +00001632 ravenizerArgs := ""
1633 if proptools.Bool(j.properties.Ravenizer.Strip_mockito) {
1634 ravenizerArgs = "--strip-mockito"
1635 }
1636 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
Makoto Onuki7ded3822024-03-28 14:42:20 -07001637 outputFile = ravenizerOutput
Colin Cross7e863852024-09-06 14:42:38 -07001638 localImplementationJars = android.Paths{ravenizerOutput}
1639 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001640 if combinedResourceJar != nil {
1641 ravenizerInput = combinedResourceJar
1642 ravenizerOutput = android.PathForModuleOut(ctx, "ravenizer", "resources", jarName)
1643 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
1644 combinedResourceJar = ravenizerOutput
1645 localResourceJars = android.Paths{ravenizerOutput}
1646 completeStaticLibsResourceJars = android.NewDepSet(android.PREORDER, localResourceJars, nil)
1647 }
Makoto Onuki7ded3822024-03-28 14:42:20 -07001648 }
1649
Yihan Dong8be09c22024-08-29 15:32:13 +08001650 if j.shouldApiMapper() {
1651 inputFile := outputFile
1652 apiMapperFile := android.PathForModuleOut(ctx, "apimapper", jarName)
1653 ctx.Build(pctx, android.BuildParams{
1654 Rule: apimapper,
1655 Description: "apimapper",
1656 Input: inputFile,
1657 Output: apiMapperFile,
1658 })
1659 outputFile = apiMapperFile
Colin Cross7e863852024-09-06 14:42:38 -07001660 localImplementationJars = android.Paths{apiMapperFile}
1661 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Yihan Dong8be09c22024-08-29 15:32:13 +08001662 }
1663
Jaewoong Jung26342642021-03-17 15:56:23 -07001664 // Check package restrictions if necessary.
1665 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001666 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001667 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001668
1669 // Create a rule to copy the output jar to another path and add a validate dependency that
1670 // will check that the jar only contains the permitted packages. The new location will become
1671 // the output file of this module.
1672 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001673 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001674 ctx.Build(pctx, android.BuildParams{
1675 Rule: android.Cp,
1676 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001677 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001678 // Make sure that any dependency on the output file will cause ninja to run the package check
1679 // rule.
1680 Validation: pkgckFile,
1681 })
Colin Cross7707b242024-07-26 12:02:36 -07001682 outputFile = packageCheckOutputFile
Colin Cross7e863852024-09-06 14:42:38 -07001683 localImplementationJars = android.Paths{packageCheckOutputFile}
1684 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001685
1686 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001687 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001688
1689 if ctx.Failed() {
1690 return
1691 }
1692 }
1693
1694 j.implementationJarFile = outputFile
1695 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001696 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1697 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1698 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1699 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1700 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1701 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1702 j.headerJarFile = headerJarFile
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001703 if len(localImplementationJars) == 1 && ctx.Config().UseTransitiveJarsInClasspath() {
1704 localHeaderJarFile := android.PathForModuleOut(ctx, "local-javac-header", jarName)
1705 convertImplementationJarToHeaderJar(ctx, localImplementationJars[0], localHeaderJarFile)
1706 localHeaderJars = append(localHeaderJars, localHeaderJarFile)
1707 } else {
1708 localHeaderJars = append(localHeaderJars, headerJarFile)
1709 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001710 }
1711
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001712 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1713 specs := j.jacocoModuleToZipCommand(ctx)
1714 if ctx.Failed() {
1715 return
1716 }
1717
Colin Crossb323c912024-09-24 15:21:00 -07001718 completeStaticLibsImplementationJarsToCombine := completeStaticLibsImplementationJars
1719
Jaewoong Jung26342642021-03-17 15:56:23 -07001720 if j.shouldInstrument(ctx) {
Colin Crossb323c912024-09-24 15:21:00 -07001721 instrumentedOutputFile := j.instrument(ctx, flags, outputFile, jarName, specs)
1722 completeStaticLibsImplementationJarsToCombine = android.NewDepSet(android.PREORDER, android.Paths{instrumentedOutputFile}, nil)
1723 outputFile = instrumentedOutputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001724 }
1725
1726 // merge implementation jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001727 var implementationAndResourcesJarsToCombine android.Paths
1728 if ctx.Config().UseTransitiveJarsInClasspath() {
1729 resourceJars := completeStaticLibsResourceJars.ToList()
1730 if len(resourceJars) > 0 {
Colin Crossb323c912024-09-24 15:21:00 -07001731 implementationAndResourcesJarsToCombine = append(resourceJars, completeStaticLibsImplementationJarsToCombine.ToList()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001732 implementationAndResourcesJarsToCombine = append(implementationAndResourcesJarsToCombine, extraDepCombinedJars...)
1733 }
1734 } else {
1735 if combinedResourceJar != nil {
1736 implementationAndResourcesJarsToCombine = android.Paths{combinedResourceJar, outputFile}
1737 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001738 }
1739
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001740 if len(implementationAndResourcesJarsToCombine) > 0 {
1741 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
1742 TransformJarsToJar(ctx, combinedJar, "for resources", implementationAndResourcesJarsToCombine, manifest,
1743 false, nil, nil)
1744 outputFile = combinedJar
1745 }
1746
1747 j.implementationAndResourcesJar = outputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001748
1749 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001750 compileDex := j.dexProperties.Compile_dex
Colin Crossff694a82023-12-13 15:54:49 -08001751 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -07001752 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001753 if compileDex == nil {
1754 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001755 }
1756 if j.deviceProperties.Hostdex == nil {
1757 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1758 }
1759 }
1760
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001761 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001762 if j.hasCode(ctx) {
1763 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001764 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001765 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1766 }
1767 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001768 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001769 params := &compileDexParams{
1770 flags: flags,
1771 sdkVersion: j.SdkVersion(ctx),
1772 minSdkVersion: j.MinSdkVersion(ctx),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001773 classesJar: outputFile,
Spandan Dasc404cc72023-02-23 18:05:05 +00001774 jarName: jarName,
1775 }
Cole Fausteb032462024-09-19 11:12:54 -07001776 if j.GetProfileGuided(ctx) && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting(ctx) {
Spandan Das15a67112024-05-30 00:07:40 +00001777 ctx.PropertyErrorf("enable_profile_rewriting",
1778 "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.",
1779 )
1780 }
Cole Fausteb032462024-09-19 11:12:54 -07001781 if j.EnableProfileRewriting(ctx) {
1782 profile := j.GetProfile(ctx)
1783 if profile == "" || !j.GetProfileGuided(ctx) {
Spandan Das3dbda182024-05-20 22:23:10 +00001784 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1785 }
1786 params.artProfileInput = &profile
1787 }
1788 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001789 if ctx.Failed() {
1790 return
1791 }
1792
Spandan Das3dbda182024-05-20 22:23:10 +00001793 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1794 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001795 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001796 }
1797
Jaewoong Jung26342642021-03-17 15:56:23 -07001798 // merge dex jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001799 var dexAndResourceJarsToCombine android.Paths
1800 if ctx.Config().UseTransitiveJarsInClasspath() {
1801 resourceJars := completeStaticLibsResourceJars.ToList()
1802 if len(resourceJars) > 0 {
1803 dexAndResourceJarsToCombine = append(android.Paths{dexOutputFile}, resourceJars...)
1804 }
1805 } else {
1806 if combinedResourceJar != nil {
1807 dexAndResourceJarsToCombine = android.Paths{dexOutputFile, combinedResourceJar}
1808 }
1809 }
1810 if len(dexAndResourceJarsToCombine) > 0 {
Colin Cross7707b242024-07-26 12:02:36 -07001811 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001812 TransformJarsToJar(ctx, combinedJar, "for dex resources", dexAndResourceJarsToCombine, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001813 false, nil, nil)
1814 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001815 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001816 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001817 dexOutputFile = combinedAlignedJar
1818 } else {
1819 dexOutputFile = combinedJar
1820 }
1821 }
1822
Paul Duffin4de94502021-05-16 05:21:16 +01001823 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001824
1825 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001826
1827 // Encode hidden API flags in dex file, if needed.
1828 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1829
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001830 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001831
1832 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001833 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1834 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1835 libName = strings.TrimSuffix(libName, ".impl")
1836 }
1837 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001838
1839 outputFile = dexOutputFile
Colin Crossa6182ab2024-08-21 10:47:44 -07001840
1841 ctx.CheckbuildFile(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001842 } else {
1843 // There is no code to compile into a dex jar, make sure the resources are propagated
1844 // to the APK if this is an app.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001845 j.dexJarFile = makeDexJarPathFromPath(combinedResourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001846 }
1847
1848 if ctx.Failed() {
1849 return
1850 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001851 }
1852
1853 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001854 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001855 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001856 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001857 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001858 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001859 }
1860 }
1861
1862 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001863 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1864 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001865 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1866 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001867 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001868 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001869 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001870 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001871 j.linter.javaLanguageLevel = flags.javaVersion.String()
1872 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001873 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001874 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1875 j.linter.buildModuleReportZip = true
1876 }
1877 j.linter.lint(ctx)
1878 }
1879
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001880 j.collectTransitiveSrcFiles(ctx, srcFiles)
1881
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001882 if ctx.Config().UseTransitiveJarsInClasspath() {
1883 if len(localImplementationJars) > 0 || len(localResourceJars) > 0 || len(localHeaderJars) > 0 {
1884 ctx.CheckbuildFile(localImplementationJars...)
1885 ctx.CheckbuildFile(localResourceJars...)
1886 ctx.CheckbuildFile(localHeaderJars...)
1887 } else {
1888 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1889 ctx.UncheckedModule()
1890 }
1891 } else {
1892 ctx.CheckbuildFile(j.implementationJarFile)
1893 ctx.CheckbuildFile(j.headerJarFile)
1894 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001895
Colin Cross7727c7f2024-07-18 15:36:32 -07001896 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001897 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1898 RepackagedHeaderJars: android.PathsIfNonNil(repackagedHeaderJarFile),
1899
1900 LocalHeaderJars: localHeaderJars,
1901 TransitiveStaticLibsHeaderJars: android.NewDepSet(android.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
1902 TransitiveStaticLibsImplementationJars: completeStaticLibsImplementationJars,
1903 TransitiveStaticLibsResourceJars: completeStaticLibsResourceJars,
1904
Colin Cross9ffaf282024-08-12 13:50:09 -07001905 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1906 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001907 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1908 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001909 ResourceJars: android.PathsIfNonNil(combinedResourceJar),
Jihoon Kang705e63e2024-03-13 01:21:16 +00001910 AidlIncludeDirs: j.exportAidlIncludeDirs,
1911 SrcJarArgs: j.srcJarArgs,
1912 SrcJarDeps: j.srcJarDeps,
1913 TransitiveSrcFiles: j.transitiveSrcFiles,
1914 ExportedPlugins: j.exportedPluginJars,
1915 ExportedPluginClasses: j.exportedPluginClasses,
1916 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1917 JacocoReportClassesFile: j.jacocoReportClassesFile,
1918 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001919 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001920 })
1921
1922 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1923 j.outputFile = outputFile.WithoutRel()
1924}
1925
Cole Faustb7493472024-08-28 11:55:52 -07001926func (j *Module) useCompose(ctx android.BaseModuleContext) bool {
1927 return android.InList("androidx.compose.runtime_runtime", j.staticLibs(ctx))
Colin Crossa1ff7c62021-09-17 14:11:52 -07001928}
1929
Colin Crosscde55342024-03-27 14:11:51 -07001930func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []*android.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001931 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001932 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001933 depTag := ctx.OtherModuleDependencyTag(m)
1934
1935 if depProguardInfo.UnconditionallyExportedProguardFlags != nil {
1936 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1937 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1938 }
1939
1940 if depTag == staticLibTag && depProguardInfo.ProguardFlagsFiles != nil {
1941 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1942 }
1943 })
1944
Colin Crosscde55342024-03-27 14:11:51 -07001945 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1946}
1947
1948func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1949 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1950
Sam Delmerico95d70942023-08-02 18:00:35 -04001951 directUnconditionalExportedFlags := android.Paths{}
1952 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1953 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1954 if exportUnconditionally {
1955 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1956 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1957 directUnconditionalExportedFlags = proguardFlagsForThisModule
1958 }
1959
1960 return ProguardSpecInfo{
1961 Export_proguard_flags_files: exportUnconditionally,
1962 ProguardFlagsFiles: android.NewDepSet[android.Path](
1963 android.POSTORDER,
1964 proguardFlagsForThisModule,
1965 transitiveProguardFlags,
1966 ),
1967 UnconditionallyExportedProguardFlags: android.NewDepSet[android.Path](
1968 android.POSTORDER,
1969 directUnconditionalExportedFlags,
1970 transitiveUnconditionalExportedFlags,
1971 ),
1972 }
1973
1974}
1975
Cole Faust75fffb12021-06-13 15:23:16 -07001976// Returns a copy of the supplied flags, but with all the errorprone-related
1977// fields copied to the regular build's fields.
1978func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1979 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1980
1981 if len(flags.errorProneExtraJavacFlags) > 0 {
1982 if len(flags.javacFlags) > 0 {
1983 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
1984 } else {
1985 flags.javacFlags = flags.errorProneExtraJavacFlags
1986 }
1987 }
1988 return flags
1989}
1990
Jaewoong Jung26342642021-03-17 15:56:23 -07001991func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07001992 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07001993
1994 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00001995 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001996 if idx >= 0 {
1997 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00001998 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001999 jarName += strconv.Itoa(idx)
2000 }
2001
Colin Cross7707b242024-07-26 12:02:36 -07002002 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00002003 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07002004
Cole Faust9decf832024-06-11 11:45:53 -07002005 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002006 extractionFile := android.PathForModuleOut(ctx, kzipName)
2007 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
2008 j.kytheFiles = append(j.kytheFiles, extractionFile)
2009 }
2010
Vadim Spivak3c496f02023-06-08 06:14:59 +00002011 if len(flags.processorPath) > 0 {
2012 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
2013 }
2014
Jaewoong Jung26342642021-03-17 15:56:23 -07002015 return classes
2016}
2017
2018// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
2019// since some of these flags may be used internally.
2020func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
2021 for _, flag := range flags {
2022 flag = strings.TrimSpace(flag)
2023
2024 if !strings.HasPrefix(flag, "-") {
2025 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
2026 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
2027 ctx.PropertyErrorf("kotlincflags",
2028 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
2029 } else if inList(flag, config.KotlincIllegalFlags) {
2030 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
2031 } else if flag == "-include-runtime" {
2032 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
2033 } else {
2034 args := strings.Split(flag, " ")
2035 if args[0] == "-kotlin-home" {
2036 ctx.PropertyErrorf("kotlincflags",
2037 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
2038 }
2039 }
2040 }
2041}
2042
2043func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
2044 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002045 extraJars android.Paths) (localHeaderJars android.Paths, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002046
Jaewoong Jung26342642021-03-17 15:56:23 -07002047 if len(srcFiles) > 0 || len(srcJars) > 0 {
2048 // Compile java sources into turbine.jar.
2049 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
2050 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002051 localHeaderJars = append(localHeaderJars, turbineJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07002052 }
2053
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002054 localHeaderJars = append(localHeaderJars, extraJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002055
2056 // Combine any static header libraries into classes-header.jar. If there is only
2057 // one input jar this step will be skipped.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002058 var jars android.Paths
2059 if ctx.Config().UseTransitiveJarsInClasspath() {
2060 depSet := android.NewDepSet(android.PREORDER, localHeaderJars, deps.transitiveStaticLibsHeaderJars)
2061 jars = depSet.ToList()
2062 } else {
2063 jars = append(slices.Clone(localHeaderJars), deps.staticHeaderJars...)
2064 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002065
2066 // we cannot skip the combine step for now if there is only one jar
2067 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07002068 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
2069 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07002070 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07002071
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002072 return localHeaderJars, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07002073}
2074
2075func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07002076 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002077
2078 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07002079 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07002080
2081 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
2082
2083 j.jacocoReportClassesFile = jacocoReportClassesFile
2084
2085 return instrumentedJar
2086}
2087
Colin Cross9ffaf282024-08-12 13:50:09 -07002088type providesTransitiveHeaderJarsForR8 struct {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002089 // set of header jars for all transitive libs deps
Colin Cross9ffaf282024-08-12 13:50:09 -07002090 transitiveLibsHeaderJarsForR8 *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002091 // set of header jars for all transitive static libs deps
Colin Cross9ffaf282024-08-12 13:50:09 -07002092 transitiveStaticLibsHeaderJarsForR8 *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002093}
2094
Colin Cross9ffaf282024-08-12 13:50:09 -07002095// collectTransitiveHeaderJarsForR8 visits direct dependencies and collects all transitive libs and static_libs
2096// header jars. The semantics of the collected jars are odd (it collects combined jars that contain the static
2097// libs, but also the static libs, and it collects transitive libs dependencies of static_libs), so these
2098// are only used to expand the --lib arguments to R8.
2099func (j *providesTransitiveHeaderJarsForR8) collectTransitiveHeaderJarsForR8(ctx android.ModuleContext) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002100 directLibs := android.Paths{}
2101 directStaticLibs := android.Paths{}
Colin Crossc85750b2022-04-21 12:50:51 -07002102 transitiveLibs := []*android.DepSet[android.Path]{}
2103 transitiveStaticLibs := []*android.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002104 ctx.VisitDirectDeps(func(module android.Module) {
2105 // don't add deps of the prebuilt version of the same library
2106 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
2107 return
2108 }
2109
Colin Cross7727c7f2024-07-18 15:36:32 -07002110 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2111 tag := ctx.OtherModuleDependencyTag(module)
2112 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2113 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2114 directLibs = append(directLibs, dep.HeaderJars...)
2115 } else if tag == staticLibTag {
2116 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2117 } else {
2118 // Don't propagate transitive libs for other kinds of dependencies.
2119 return
2120 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002121
Colin Cross9ffaf282024-08-12 13:50:09 -07002122 if dep.TransitiveLibsHeaderJarsForR8 != nil {
2123 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJarsForR8)
Colin Cross7727c7f2024-07-18 15:36:32 -07002124 }
Colin Cross9ffaf282024-08-12 13:50:09 -07002125 if dep.TransitiveStaticLibsHeaderJarsForR8 != nil {
2126 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJarsForR8)
Colin Cross7727c7f2024-07-18 15:36:32 -07002127 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002128
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002129 }
2130 })
Colin Cross9ffaf282024-08-12 13:50:09 -07002131 j.transitiveLibsHeaderJarsForR8 = android.NewDepSet(android.POSTORDER, directLibs, transitiveLibs)
2132 j.transitiveStaticLibsHeaderJarsForR8 = android.NewDepSet(android.POSTORDER, directStaticLibs, transitiveStaticLibs)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002133}
2134
Jaewoong Jung26342642021-03-17 15:56:23 -07002135func (j *Module) HeaderJars() android.Paths {
2136 if j.headerJarFile == nil {
2137 return nil
2138 }
2139 return android.Paths{j.headerJarFile}
2140}
2141
2142func (j *Module) ImplementationJars() android.Paths {
2143 if j.implementationJarFile == nil {
2144 return nil
2145 }
2146 return android.Paths{j.implementationJarFile}
2147}
2148
Spandan Das59a4a2b2024-01-09 21:35:56 +00002149func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002150 return j.dexJarFile
2151}
2152
2153func (j *Module) DexJarInstallPath() android.Path {
2154 return j.installFile
2155}
2156
2157func (j *Module) ImplementationAndResourcesJars() android.Paths {
2158 if j.implementationAndResourcesJar == nil {
2159 return nil
2160 }
2161 return android.Paths{j.implementationAndResourcesJar}
2162}
2163
2164func (j *Module) AidlIncludeDirs() android.Paths {
2165 // exportAidlIncludeDirs is type android.Paths already
2166 return j.exportAidlIncludeDirs
2167}
2168
2169func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2170 return j.classLoaderContexts
2171}
2172
2173// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002174func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002175 // jarjar rules will repackage the sources. To prevent misleading results, IdeInfo should contain the
2176 // repackaged jar instead of the input sources.
Jaewoong Jung26342642021-03-17 15:56:23 -07002177 if j.expandJarjarRules != nil {
2178 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002179 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
2180 } else {
2181 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2182 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2183 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002184 }
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002185 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2186 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Cole Faustb7493472024-08-28 11:55:52 -07002187 dpInfo.Static_libs = append(dpInfo.Static_libs, j.staticLibs(ctx)...)
Yikef6282022022-04-13 20:41:01 +08002188 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002189}
2190
2191func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002192 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002193}
2194
2195func (j *Module) hasCode(ctx android.ModuleContext) bool {
2196 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2197 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2198}
2199
2200// Implements android.ApexModule
2201func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2202 return j.depIsInSameApex(ctx, dep)
2203}
2204
2205// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002206func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002207 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002208 minSdkVersion := j.MinSdkVersion(ctx)
2209 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002210 return fmt.Errorf("min_sdk_version is not specified")
2211 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002212 // If the module is compiling against core (via sdk_version), skip comparison check.
2213 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002214 return nil
2215 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002216 if minSdkVersion.GreaterThan(sdkVersion) {
2217 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002218 }
2219 return nil
2220}
2221
2222func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002223 if j.stem == "" {
2224 panic("Stem() called before stem property was set")
2225 }
2226 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002227}
2228
Jaewoong Jung26342642021-03-17 15:56:23 -07002229func (j *Module) JacocoReportClassesFile() android.Path {
2230 return j.jacocoReportClassesFile
2231}
2232
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002233func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
2234 var fromDeps []*android.DepSet[android.Path]
2235 ctx.VisitDirectDeps(func(module android.Module) {
2236 tag := ctx.OtherModuleDependencyTag(module)
2237 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002238 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2239 if depInfo.TransitiveSrcFiles != nil {
2240 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
2241 }
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002242 }
2243 }
2244 })
2245
2246 j.transitiveSrcFiles = android.NewDepSet(android.POSTORDER, mine, fromDeps)
2247}
2248
Jaewoong Jung26342642021-03-17 15:56:23 -07002249func (j *Module) IsInstallable() bool {
2250 return Bool(j.properties.Installable)
2251}
2252
2253type sdkLinkType int
2254
2255const (
2256 // TODO(jiyong) rename these for better readability. Make the allowed
2257 // and disallowed link types explicit
2258 // order is important here. See rank()
2259 javaCore sdkLinkType = iota
2260 javaSdk
2261 javaSystem
2262 javaModule
2263 javaSystemServer
2264 javaPlatform
2265)
2266
2267func (lt sdkLinkType) String() string {
2268 switch lt {
2269 case javaCore:
2270 return "core Java API"
2271 case javaSdk:
2272 return "Android API"
2273 case javaSystem:
2274 return "system API"
2275 case javaModule:
2276 return "module API"
2277 case javaSystemServer:
2278 return "system server API"
2279 case javaPlatform:
2280 return "private API"
2281 default:
2282 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2283 }
2284}
2285
2286// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2287// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2288// can't statically depend on modules that use Platform API.
2289func (lt sdkLinkType) rank() int {
2290 return int(lt)
2291}
2292
2293type moduleWithSdkDep interface {
2294 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002295 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002296}
2297
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002298func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2299 switch k {
2300 case android.SdkCore:
2301 return javaCore
2302 case android.SdkSystem:
2303 return javaSystem
2304 case android.SdkPublic:
2305 return javaSdk
2306 case android.SdkModule:
2307 return javaModule
2308 case android.SdkSystemServer:
2309 return javaSystemServer
2310 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2311 return javaPlatform
2312 default:
2313 return javaSdk
2314 }
2315}
2316
Jiyong Park92315372021-04-02 08:45:46 +09002317func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002318 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002319 case android.SdkCore.DefaultJavaLibraryName(),
2320 "legacy.core.platform.api.stubs",
2321 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002322 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002323 "core-lambda-stubs",
Jihoon Kangb5078312023-03-29 23:25:49 +00002324 "core-generated-annotation-stubs":
Jaewoong Jung26342642021-03-17 15:56:23 -07002325 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002326 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002327 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002328 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002329 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002330 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002331 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002332 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002333 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002334 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002335 return javaSystem, true
2336 }
2337
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002338 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002339 return linkType, true
2340 }
2341
Jiyong Park92315372021-04-02 08:45:46 +09002342 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002343 if !ver.Valid() {
2344 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002345 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002346
2347 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002348}
2349
2350// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2351// this module's. See the comment on rank() for details and an example.
2352func (j *Module) checkSdkLinkType(
2353 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2354 if ctx.Host() {
2355 return
2356 }
2357
Jiyong Park92315372021-04-02 08:45:46 +09002358 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002359 if stubs {
2360 return
2361 }
Jiyong Park92315372021-04-02 08:45:46 +09002362 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002363
2364 if myLinkType.rank() < depLinkType.rank() {
2365 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2366 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2367 "property of the source or target module so that target module is built "+
2368 "with the same or smaller API set when compared to the source.",
2369 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2370 }
2371}
2372
2373func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2374 var deps deps
2375
Jiyong Park92315372021-04-02 08:45:46 +09002376 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002377
Colin Cross9ffaf282024-08-12 13:50:09 -07002378 j.collectTransitiveHeaderJarsForR8(ctx)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002379
2380 var transitiveBootClasspathHeaderJars []*android.DepSet[android.Path]
2381 var transitiveClasspathHeaderJars []*android.DepSet[android.Path]
2382 var transitiveJava9ClasspathHeaderJars []*android.DepSet[android.Path]
2383 var transitiveStaticJarsHeaderLibs []*android.DepSet[android.Path]
2384 var transitiveStaticJarsImplementationLibs []*android.DepSet[android.Path]
2385 var transitiveStaticJarsResourceLibs []*android.DepSet[android.Path]
2386
Jaewoong Jung26342642021-03-17 15:56:23 -07002387 ctx.VisitDirectDeps(func(module android.Module) {
2388 otherName := ctx.OtherModuleName(module)
2389 tag := ctx.OtherModuleDependencyTag(module)
2390
2391 if IsJniDepTag(tag) {
2392 // Handled by AndroidApp.collectAppDeps
2393 return
2394 }
2395 if tag == certificateTag {
2396 // Handled by AndroidApp.collectAppDeps
2397 return
2398 }
2399
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002400 if sdkInfo, ok := android.OtherModuleProvider(ctx, module, SdkLibraryInfoProvider); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -07002401 switch tag {
Jihoon Kang28c96572024-09-11 23:44:44 +00002402 case sdkLibTag, libTag, staticLibTag:
Jihoon Kang28c96572024-09-11 23:44:44 +00002403 generatingLibsString := android.PrettyConcat(
2404 getGeneratingLibs(ctx, j.SdkVersion(ctx), module.Name(), sdkInfo), true, "or")
2405 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 -07002406 }
Colin Cross313aa542023-12-13 13:47:44 -08002407 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2408 if sdkLinkType != javaPlatform {
2409 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2410 // dep is a sysprop implementation library, but this module is not linking against
2411 // the platform, so it gets the sysprop public stubs library instead. Replace
2412 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2413 dep = syspropDep.JavaInfo
2414 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002415 }
2416 switch tag {
2417 case bootClasspathTag:
2418 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002419 if dep.TransitiveStaticLibsHeaderJars != nil {
2420 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2421 }
Liz Kammeref28a4c2022-09-23 16:50:56 -04002422 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002423 if _, ok := module.(*Plugin); ok {
2424 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2425 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002426 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002427 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002428 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2429 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2430 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2431 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002432 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2433 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2434 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002435
2436 if dep.TransitiveStaticLibsHeaderJars != nil {
2437 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2438 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002439 case java9LibTag:
2440 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002441 if dep.TransitiveStaticLibsHeaderJars != nil {
2442 transitiveJava9ClasspathHeaderJars = append(transitiveJava9ClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2443 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002444 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002445 if _, ok := module.(*Plugin); ok {
2446 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2447 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002448 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2449 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2450 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2451 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2452 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2453 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2454 // Turbine doesn't run annotation processors, so any module that uses an
2455 // annotation processor that generates API is incompatible with the turbine
2456 // optimization.
2457 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002458 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002459
2460 if dep.TransitiveStaticLibsHeaderJars != nil {
2461 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2462 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, dep.TransitiveStaticLibsHeaderJars)
2463 }
2464 if dep.TransitiveStaticLibsImplementationJars != nil {
2465 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, dep.TransitiveStaticLibsImplementationJars)
2466 }
2467 if dep.TransitiveStaticLibsResourceJars != nil {
2468 transitiveStaticJarsResourceLibs = append(transitiveStaticJarsResourceLibs, dep.TransitiveStaticLibsResourceJars)
2469 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002470 case pluginTag:
2471 if plugin, ok := module.(*Plugin); ok {
2472 if plugin.pluginProperties.Processor_class != nil {
2473 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2474 } else {
2475 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2476 }
2477 // Turbine doesn't run annotation processors, so any module that uses an
2478 // annotation processor that generates API is incompatible with the turbine
2479 // optimization.
2480 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2481 } else {
2482 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2483 }
2484 case errorpronePluginTag:
2485 if _, ok := module.(*Plugin); ok {
2486 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2487 } else {
2488 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2489 }
2490 case exportedPluginTag:
2491 if plugin, ok := module.(*Plugin); ok {
2492 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2493 if plugin.pluginProperties.Processor_class != nil {
2494 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2495 }
2496 // Turbine doesn't run annotation processors, so any module that uses an
2497 // annotation processor that generates API is incompatible with the turbine
2498 // optimization.
2499 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2500 } else {
2501 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2502 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002503 case kotlinPluginTag:
2504 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002505 case syspropPublicStubDepTag:
2506 // This is a sysprop implementation library, forward the JavaInfoProvider from
2507 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002508 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002509 JavaInfo: dep,
2510 })
2511 }
2512 } else if dep, ok := module.(android.SourceFileProducer); ok {
2513 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002514 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002515 checkProducesJars(ctx, dep)
2516 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002517 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002518 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars,
2519 android.NewDepSet(android.PREORDER, dep.Srcs(), nil))
Jaewoong Jung26342642021-03-17 15:56:23 -07002520 case staticLibTag:
2521 checkProducesJars(ctx, dep)
2522 deps.classpath = append(deps.classpath, dep.Srcs()...)
2523 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2524 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002525
2526 depHeaderJars := android.NewDepSet(android.PREORDER, dep.Srcs(), nil)
2527 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJars)
2528 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, depHeaderJars)
2529 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, depHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002530 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002531 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002532 switch tag {
2533 case staticLibTag:
2534 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2535 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002536 } else {
2537 switch tag {
2538 case bootClasspathTag:
2539 // If a system modules dependency has been added to the bootclasspath
2540 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002541 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002542 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars...)
2543 if sm.TransitiveStaticLibsHeaderJars != nil {
2544 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars,
2545 sm.TransitiveStaticLibsHeaderJars)
2546 }
Colin Crossb61c2262024-08-08 14:04:42 -07002547 } else {
2548 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2549 ctx.OtherModuleName(module))
2550 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002551
2552 case systemModulesTag:
2553 if deps.systemModules != nil {
2554 panic("Found two system module dependencies")
2555 }
Colin Crossb61c2262024-08-08 14:04:42 -07002556 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2557 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2558 } else {
2559 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2560 ctx.OtherModuleName(module))
2561 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002562
2563 case instrumentationForTag:
2564 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 -07002565 }
2566 }
2567
Spandan Das8aac9932024-07-18 23:14:13 +00002568 if android.InList(tag, compileDependencyTags) {
2569 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2570 j.compileDepNames = append(j.compileDepNames, otherName)
2571 }
2572
Jaewoong Jung26342642021-03-17 15:56:23 -07002573 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002574 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002575 })
2576
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002577 deps.transitiveStaticLibsHeaderJars = transitiveStaticJarsHeaderLibs
2578 deps.transitiveStaticLibsImplementationJars = transitiveStaticJarsImplementationLibs
2579 deps.transitiveStaticLibsResourceJars = transitiveStaticJarsResourceLibs
2580
2581 if ctx.Config().UseTransitiveJarsInClasspath() {
2582 depSet := android.NewDepSet(android.PREORDER, nil, transitiveClasspathHeaderJars)
2583 deps.classpath = depSet.ToList()
2584 depSet = android.NewDepSet(android.PREORDER, nil, transitiveBootClasspathHeaderJars)
2585 deps.bootClasspath = depSet.ToList()
2586 depSet = android.NewDepSet(android.PREORDER, nil, transitiveJava9ClasspathHeaderJars)
2587 deps.java9Classpath = depSet.ToList()
2588 }
2589
2590 if ctx.Device() {
2591 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
2592 if sdkDep.invalidVersion {
2593 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2594 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2595 } else if sdkDep.useFiles {
2596 // sdkDep.jar is actually equivalent to turbine header.jar.
2597 deps.classpath = append(slices.Clone(classpath(sdkDep.jars)), deps.classpath...)
2598 deps.dexClasspath = append(slices.Clone(classpath(sdkDep.jars)), deps.dexClasspath...)
2599 deps.aidlPreprocess = sdkDep.aidl
2600 // Add the sdk module dependency to `compileDepNames`.
2601 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2602 // TODO (b/358608607): Move this to decodeSdkDep
2603 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2604 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
2605 } else {
2606 deps.aidlPreprocess = sdkDep.aidl
2607 }
2608 }
2609
Jaewoong Jung26342642021-03-17 15:56:23 -07002610 return deps
2611}
2612
Joe Onorato349ae8d2024-02-05 22:46:00 +00002613// Provider for jarjar renaming rules.
2614//
2615// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2616// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2617// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2618// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2619// be renamed from that module.
2620// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002621type DependencyUse int
2622
2623const (
2624 RenameUseInvalid DependencyUse = iota
2625 RenameUseInclude
2626 RenameUseExclude
2627)
2628
2629type RenameUseElement struct {
2630 DepName string
2631 RenameUse DependencyUse
2632 Why string // token for determining where in the logic the decision was made.
2633}
2634
Joe Onorato349ae8d2024-02-05 22:46:00 +00002635type JarJarProviderData struct {
2636 // Mapping of class names: original --> renamed. If the value is "", the class will be
2637 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2638 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002639 Rename map[string]string
2640 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002641}
2642
2643func (this JarJarProviderData) GetDebugString() string {
2644 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002645 for _, k := range android.SortedKeys(this.Rename) {
2646 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002647 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2648 result += k + "--&gt;" + v + ";"
2649 }
2650 }
2651 return result
2652}
2653
2654var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2655
2656var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2657
2658func init() {
2659 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
Yu Liu26a716d2024-08-30 23:40:32 +00002660
2661 gob.Register(BaseJarJarProviderData{})
Joe Onorato349ae8d2024-02-05 22:46:00 +00002662}
2663
2664// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2665// whether they are java modules or not.
2666type BaseJarJarProviderData struct {
2667 JarJarProviderData JarJarProviderData
2668}
2669
2670func (this BaseJarJarProviderData) GetDebugString() string {
2671 return this.JarJarProviderData.GetDebugString()
2672}
2673
2674var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2675
2676// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2677// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2678// either JarJarProvider or BaseJarJarProvider.
2679func mergeJarJarPrefixes(ctx android.ModuleContext) {
2680 mod := ctx.Module()
2681 // Explicitly avoid propagating into some module types.
2682 switch reflect.TypeOf(mod).String() {
2683 case "*java.Droidstubs":
2684 return
2685 }
2686 jarJarData := collectDirectDepsProviders(ctx)
2687 if jarJarData != nil {
2688 providerData := BaseJarJarProviderData{
2689 JarJarProviderData: *jarJarData,
2690 }
2691 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2692 }
2693
2694}
2695
2696// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2697func (module *Module) addJarJarRenameRule(original string, renamed string) {
2698 if module.jarjarRenameRules == nil {
2699 module.jarjarRenameRules = make(map[string]string)
2700 }
2701 module.jarjarRenameRules[original] = renamed
2702}
2703
2704func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2705 // Gather repackage information from deps
2706 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002707
2708 module := ctx.Module()
2709 moduleName := module.Name()
2710
Colin Cross648daea2024-09-12 14:35:29 -07002711 ctx.VisitDirectDeps(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002712 tag := ctx.OtherModuleDependencyTag(m)
2713 // This logic mirrors that in (*Module).collectDeps above. There are several places
2714 // where we explicitly return RenameUseExclude, even though it is the default, to
2715 // indicate that it has been verified to be the case.
2716 //
2717 // Note well: there are probably cases that are getting to the unconditional return
2718 // and are therefore wrong.
2719 shouldIncludeRenames := func() (DependencyUse, string) {
2720 if moduleName == m.Name() {
2721 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2722 }
2723 if sc, ok := module.(android.SdkContext); ok {
2724 if ctx.Device() {
2725 sdkDep := decodeSdkDep(ctx, sc)
2726 if !sdkDep.invalidVersion && sdkDep.useFiles {
2727 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002728 }
2729 }
LaMont Jones63683e42024-02-08 14:30:45 -08002730 }
2731 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2732 return RenameUseExclude, "tags"
2733 }
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002734 if _, ok := android.OtherModuleProvider(ctx, m, SdkLibraryInfoProvider); ok {
LaMont Jones63683e42024-02-08 14:30:45 -08002735 switch tag {
2736 case sdkLibTag, libTag:
2737 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2738 }
2739 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2740 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2741 switch ji.StubsLinkType {
2742 case Stubs:
2743 return RenameUseExclude, "info"
2744 case Implementation:
2745 return RenameUseInclude, "info"
2746 default:
LaMont Jones09721862024-06-11 10:30:50 -07002747 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002748 // Fall through to the heuristic logic.
2749 }
2750 switch reflect.TypeOf(m).String() {
2751 case "*java.GeneratedJavaLibraryModule":
2752 // Probably a java_aconfig_library module.
2753 // TODO: make this check better.
2754 return RenameUseInclude, "reflect"
2755 }
2756 switch tag {
2757 case bootClasspathTag:
2758 return RenameUseExclude, "tagswitch"
2759 case sdkLibTag, libTag, instrumentationForTag:
2760 return RenameUseInclude, "tagswitch"
2761 case java9LibTag:
2762 return RenameUseExclude, "tagswitch"
2763 case staticLibTag:
2764 return RenameUseInclude, "tagswitch"
2765 case pluginTag:
2766 return RenameUseInclude, "tagswitch"
2767 case errorpronePluginTag:
2768 return RenameUseInclude, "tagswitch"
2769 case exportedPluginTag:
2770 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002771 case kotlinPluginTag:
2772 return RenameUseInclude, "tagswitch"
2773 default:
2774 return RenameUseExclude, "tagswitch"
2775 }
2776 } else if _, ok := m.(android.SourceFileProducer); ok {
2777 switch tag {
2778 case sdkLibTag, libTag, staticLibTag:
2779 return RenameUseInclude, "srcfile"
2780 default:
2781 return RenameUseExclude, "srcfile"
2782 }
Yu Liu67a28422024-03-05 00:36:31 +00002783 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002784 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002785 } else {
2786 switch tag {
2787 case bootClasspathTag:
2788 return RenameUseExclude, "else"
2789 case systemModulesTag:
2790 return RenameUseInclude, "else"
2791 }
2792 }
2793 // If we got here, choose the safer option, which may lead to a build failure, rather
2794 // than runtime failures on the device.
2795 return RenameUseExclude, "end"
2796 }
2797
2798 if result == nil {
2799 result = &JarJarProviderData{
2800 Rename: make(map[string]string),
2801 RenameUse: make([]RenameUseElement, 0),
2802 }
2803 }
2804 how, why := shouldIncludeRenames()
2805 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2806 if how != RenameUseInclude {
2807 // Nothing to merge.
2808 return
2809 }
2810
2811 merge := func(theirs *JarJarProviderData) {
2812 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002813 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2814 result.Rename[orig] = renamed
2815 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2816 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2817 result.Rename[orig] = renamed
2818 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2819 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2820 continue
2821 }
2822 }
2823 }
2824 }
2825 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2826 merge(&theirs)
2827 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2828 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2829 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2830 // to java.Module.
2831 merge(&theirs.JarJarProviderData)
2832 }
2833 })
2834 return
2835}
2836
2837func (this Module) GetDebugString() string {
2838 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2839}
2840
2841// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2842// us, and if it's been set, apply the jarjar_prefix property to rename them.
2843func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2844 // Gather repackage information from deps
2845 result := collectDirectDepsProviders(ctx)
2846
Joe Onoratoa5d17172024-07-20 17:39:56 -07002847 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002848 if result == nil {
2849 result = &JarJarProviderData{
2850 Rename: make(map[string]string),
2851 }
2852 }
2853 if renamed != "" {
2854 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2855 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002856 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002857 }
2858 }
2859 (*result).Rename[orig] = renamed
2860 }
2861
Joe Onoratoa5d17172024-07-20 17:39:56 -07002862 // Update that with entries we've stored for ourself
2863 for orig, renamed := range module.jarjarRenameRules {
2864 add(orig, renamed)
2865 }
2866
2867 // Update that with entries given in the jarjar_rename property.
2868 for _, orig := range module.properties.Jarjar_rename {
2869 add(orig, "")
2870 }
2871
Joe Onorato349ae8d2024-02-05 22:46:00 +00002872 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2873 if result == nil {
2874 return nil
2875 }
2876
2877 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2878 // that have not yet been renamed.
2879 prefix := proptools.String(module.properties.Jarjar_prefix)
2880 if prefix != "" {
2881 if prefix[0] == '.' {
2882 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2883 return nil
2884 }
2885 if prefix[len(prefix)-1] == '.' {
2886 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2887 return nil
2888 }
2889
2890 var updated map[string]string
2891 for orig, renamed := range (*result).Rename {
2892 if renamed == "" {
2893 if updated == nil {
2894 updated = make(map[string]string)
2895 }
2896 updated[orig] = prefix + "." + orig
2897 }
2898 }
2899 for orig, renamed := range updated {
2900 (*result).Rename[orig] = renamed
2901 }
2902 }
2903
2904 return result
2905}
2906
2907// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2908// to "" won't be in this list because they shouldn't be renamed yet.
2909func getJarJarRuleText(provider *JarJarProviderData) string {
2910 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002911 for _, orig := range android.SortedKeys(provider.Rename) {
2912 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002913 if renamed != "" {
2914 result += "rule " + orig + " " + renamed + "\n"
2915 }
2916 }
2917 return result
2918}
2919
Zi Wangddb2ee52024-04-02 16:44:02 +00002920// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002921func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Zi Wangddb2ee52024-04-02 16:44:02 +00002922 if j.repackageJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002923 return infile, false
Zi Wangddb2ee52024-04-02 16:44:02 +00002924 }
Colin Crossedec77c2024-07-26 15:25:40 -07002925 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002926 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002927 return repackagedJarjarFile, true
Zi Wangddb2ee52024-04-02 16:44:02 +00002928}
2929
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002930func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Colin Crossedec77c2024-07-26 15:25:40 -07002931 if j.expandJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002932 return infile, false
Colin Crossedec77c2024-07-26 15:25:40 -07002933 }
2934 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2935 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002936 return jarjarFile, true
Colin Crossedec77c2024-07-26 15:25:40 -07002937
2938}
2939
Jaewoong Jung26342642021-03-17 15:56:23 -07002940func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2941 deps.processorPath = append(deps.processorPath, pluginJars...)
2942 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2943}
2944
2945// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2946// this interface.
2947type ProvidesUsesLib interface {
2948 ProvidesUsesLib() *string
2949}
2950
2951func (j *Module) ProvidesUsesLib() *string {
2952 return j.usesLibraryProperties.Provides_uses_lib
2953}
satayev1c564cc2021-05-25 19:50:30 +01002954
2955type ModuleWithStem interface {
2956 Stem() string
2957}
2958
2959var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002960
2961type ModuleWithUsesLibrary interface {
2962 UsesLibrary() *usesLibrary
2963}
2964
2965func (j *Module) UsesLibrary() *usesLibrary {
2966 return &j.usesLibrary
2967}
2968
2969var _ ModuleWithUsesLibrary = (*Module)(nil)