blob: fc8cf95ba661ce6624d33f31d981e7f0b9536ef0 [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
Jihoon Kang381c2fa2023-06-01 22:17:32 +000086 // list of java libraries that should not be used to build this module
87 Exclude_static_libs []string `android:"arch_variant"`
88
Jaewoong Jung26342642021-03-17 15:56:23 -070089 // manifest file to be included in resulting jar
90 Manifest *string `android:"path"`
91
92 // if not blank, run jarjar using the specified rules file
93 Jarjar_rules *string `android:"path,arch_variant"`
94
Joe Onoratoa5d17172024-07-20 17:39:56 -070095 // java class names to rename with jarjar when a reverse dependency has a jarjar_prefix
96 // property.
97 Jarjar_rename []string
98
Joe Onorato349ae8d2024-02-05 22:46:00 +000099 // if not blank, used as prefix to generate repackage rule
100 Jarjar_prefix *string
101
Jaewoong Jung26342642021-03-17 15:56:23 -0700102 // If not blank, set the java version passed to javac as -source and -target
103 Java_version *string
104
105 // If set to true, allow this module to be dexed and installed on devices. Has no
106 // effect on host modules, which are always considered installable.
107 Installable *bool
108
109 // If set to true, include sources used to compile the module in to the final jar
110 Include_srcs *bool
111
112 // If not empty, classes are restricted to the specified packages and their sub-packages.
113 // This restriction is checked after applying jarjar rules and including static libs.
114 Permitted_packages []string
115
116 // List of modules to use as annotation processors
117 Plugins []string
118
119 // List of modules to export to libraries that directly depend on this library as annotation
120 // processors. Note that if the plugins set generates_api: true this will disable the turbine
121 // optimization on modules that depend on this module, which will reduce parallelism and cause
122 // more recompilation.
123 Exported_plugins []string
124
125 // The number of Java source entries each Javac instance can process
126 Javac_shard_size *int64
127
128 // Add host jdk tools.jar to bootclasspath
129 Use_tools_jar *bool
130
131 Openjdk9 struct {
132 // List of source files that should only be used when passing -source 1.9 or higher
133 Srcs []string `android:"path"`
134
135 // List of javac flags that should only be used when passing -source 1.9 or higher
136 Javacflags []string
137 }
138
139 // When compiling language level 9+ .java code in packages that are part of
140 // a system module, patch_module names the module that your sources and
141 // dependencies should be patched into. The Android runtime currently
142 // doesn't implement the JEP 261 module system so this option is only
143 // supported at compile time. It should only be needed to compile tests in
144 // packages that exist in libcore and which are inconvenient to move
145 // elsewhere.
Liz Kammer0a470a32023-10-05 17:02:00 -0400146 Patch_module *string
Jaewoong Jung26342642021-03-17 15:56:23 -0700147
148 Jacoco struct {
149 // List of classes to include for instrumentation with jacoco to collect coverage
150 // information at runtime when building with coverage enabled. If unset defaults to all
151 // classes.
152 // Supports '*' as the last character of an entry in the list as a wildcard match.
153 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
154 // it matches classes in the package that have the class name as a prefix.
155 Include_filter []string
156
157 // List of classes to exclude from instrumentation with jacoco to collect coverage
158 // information at runtime when building with coverage enabled. Overrides classes selected
159 // by the include_filter property.
160 // Supports '*' as the last character of an entry in the list as a wildcard match.
161 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
162 // it matches classes in the package that have the class name as a prefix.
163 Exclude_filter []string
164 }
165
166 Errorprone struct {
167 // List of javac flags that should only be used when running errorprone.
168 Javacflags []string
169
170 // List of java_plugin modules that provide extra errorprone checks.
171 Extra_check_modules []string
Cole Faust75fffb12021-06-13 15:23:16 -0700172
Cole Faust2b1536e2021-06-18 12:25:54 -0700173 // This property can be in 3 states. When set to true, errorprone will
174 // be run during the regular build. When set to false, errorprone will
175 // never be run. When unset, errorprone will be run when the RUN_ERROR_PRONE
176 // environment variable is true. Setting this to false will improve build
177 // performance more than adding -XepDisableAllChecks in javacflags.
Cole Faust75fffb12021-06-13 15:23:16 -0700178 Enabled *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700179 }
180
181 Proto struct {
182 // List of extra options that will be passed to the proto generator.
183 Output_params []string
184 }
185
Sam Delmericoc7593722022-08-31 15:57:52 -0400186 // If true, then jacocoagent is automatically added as a libs dependency so that
187 // r8 will not strip instrumentation classes out of dexed libraries.
Jaewoong Jung26342642021-03-17 15:56:23 -0700188 Instrument bool `blueprint:"mutated"`
Paul Duffin0038a8d2022-05-03 00:28:40 +0000189 // If true, then the module supports statically including the jacocoagent
190 // into the library.
191 Supports_static_instrumentation bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700192
193 // List of files to include in the META-INF/services folder of the resulting jar.
194 Services []string `android:"path,arch_variant"`
195
196 // If true, package the kotlin stdlib into the jar. Defaults to true.
197 Static_kotlin_stdlib *bool `android:"arch_variant"`
198
199 // A list of java_library instances that provide additional hiddenapi annotations for the library.
200 Hiddenapi_additional_annotations []string
Joe Onorato175073c2023-06-01 14:42:59 -0700201
202 // Additional srcJars tacked in by GeneratedJavaLibraryModule
203 Generated_srcjars []android.Path `android:"mutated"`
Mark Whitea15790a2023-08-22 21:28:11 +0000204
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000205 // intermediate aconfig cache file tacked in by GeneratedJavaLibraryModule
206 Aconfig_Cache_files []android.Path `android:"mutated"`
207
Mark Whitea15790a2023-08-22 21:28:11 +0000208 // If true, then only the headers are built and not the implementation jar.
Liz Kammer60772632023-10-05 17:18:44 -0400209 Headers_only *bool
Cole Faust2b64af82023-12-13 18:22:18 -0800210
211 // A list of files or dependencies to make available to the build sandbox. This is
212 // useful if source files are symlinks, the targets of the symlinks must be listed here.
213 // Note that currently not all actions implemented by android_apps are sandboxed, so you
214 // may only see this being necessary in lint builds.
215 Compile_data []string `android:"path"`
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000216
217 // Property signifying whether the module compiles stubs or not.
218 // Should be set to true when srcs of this module are stub files.
219 // This property does not need to be set to true when the module depends on
220 // the stubs via libs, but should be set to true when the module depends on
221 // the stubs via static libs.
222 Is_stubs_module *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700223
224 // If true, enable the "Ravenizer" tool on the output jar.
225 // "Ravenizer" is a tool for Ravenwood tests, but it can also be enabled on other kinds
226 // of java targets.
227 Ravenizer struct {
228 Enabled *bool
229 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +0000230
231 // Contributing api surface of the stub module. Is not visible to bp modules, and should
232 // only be set for stub submodules generated by the java_sdk_library
233 Stub_contributing_api *string `blueprint:"mutated"`
Yihan Dong8be09c22024-08-29 15:32:13 +0800234
235 // If true, enable the "ApiMapper" tool on the output jar. "ApiMapper" is a tool to inject
236 // bytecode to log API calls.
237 ApiMapper bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700238}
239
240// Properties that are specific to device modules. Host module factories should not add these when
241// constructing a new module.
242type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000243 // If not blank, set to the version of the sdk to compile against.
Spandan Das1ccf5742022-10-14 16:51:23 +0000244 // Defaults to an empty string, which compiles the module against the private platform APIs.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000245 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000246 // 1) numerical API level, "current", "none", or "core_platform"
247 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
248 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
249 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700250 Sdk_version *string
251
satayev0a420e72021-11-29 17:25:52 +0000252 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
253 // Defaults to empty string "". See sdk_version for possible values.
254 Max_sdk_version *string
255
William Loh5a082f92022-05-17 20:21:50 +0000256 // if not blank, set the maxSdkVersion properties of permission and uses-permission tags.
257 // Defaults to empty string "". See sdk_version for possible values.
258 Replace_max_sdk_version_placeholder *string
259
Jaewoong Jung26342642021-03-17 15:56:23 -0700260 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000261 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700262 Target_sdk_version *string
263
264 // Whether to compile against the platform APIs instead of an SDK.
265 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000266 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700267 Platform_apis *bool
268
269 Aidl struct {
270 // Top level directories to pass to aidl tool
271 Include_dirs []string
272
273 // Directories rooted at the Android.bp file to pass to aidl tool
274 Local_include_dirs []string
275
276 // directories that should be added as include directories for any aidl sources of modules
277 // that depend on this module, as well as to aidl for this module.
278 Export_include_dirs []string
279
280 // whether to generate traces (for systrace) for this interface
281 Generate_traces *bool
282
283 // whether to generate Binder#GetTransaction name method.
284 Generate_get_transaction_name *bool
285
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100286 // whether all interfaces should be annotated with required permissions.
287 Enforce_permissions *bool
288
289 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
290 Enforce_permissions_exceptions []string `android:"path"`
291
Jaewoong Jung26342642021-03-17 15:56:23 -0700292 // list of flags that will be passed to the AIDL compiler
293 Flags []string
294 }
295
296 // If true, export a copy of the module as a -hostdex module for host testing.
297 Hostdex *bool
298
299 Target struct {
300 Hostdex struct {
301 // Additional required dependencies to add to -hostdex modules.
302 Required []string
303 }
304 }
305
306 // When targeting 1.9 and above, override the modules to use with --system,
307 // otherwise provides defaults libraries to add to the bootclasspath.
308 System_modules *string
309
Jaewoong Jung26342642021-03-17 15:56:23 -0700310 IsSDKLibrary bool `blueprint:"mutated"`
311
312 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
313 // Defaults to false.
314 V4_signature *bool
315
316 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
317 // public stubs library.
318 SyspropPublicStub string `blueprint:"mutated"`
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000319
320 HiddenAPIPackageProperties
321 HiddenAPIFlagFileProperties
Jaewoong Jung26342642021-03-17 15:56:23 -0700322}
323
yangbill2af0b6e2024-03-15 09:29:29 +0000324// Properties that can be overridden by overriding module (e.g. override_android_app)
325type OverridableProperties struct {
Jooyung Han01d80d82022-01-08 12:16:32 +0900326 // set the name of the output. If not set, `name` is used.
327 // To override a module with this property set, overriding module might need to set this as well.
328 // Otherwise, both the overridden and the overriding modules will have the same output name, which
329 // can cause the duplicate output error.
330 Stem *string
Spandan Dasb9c58352024-05-13 18:29:45 +0000331
332 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
333 // Defaults to sdk_version if not set. See sdk_version for possible values.
334 Min_sdk_version *string
Jooyung Han01d80d82022-01-08 12:16:32 +0900335}
336
Jaewoong Jung26342642021-03-17 15:56:23 -0700337// Functionality common to Module and Import
338//
339// It is embedded in Module so its functionality can be used by methods in Module
340// but it is currently only initialized by Import and Library.
341type embeddableInModuleAndImport struct {
342
343 // Functionality related to this being used as a component of a java_sdk_library.
344 EmbeddableSdkLibraryComponent
345}
346
Paul Duffin71b33cc2021-06-23 11:39:47 +0100347func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
348 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700349}
350
351// Module/Import's DepIsInSameApex(...) delegates to this method.
352//
353// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
354// the one provided by ApexModuleBase.
355func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
356 // dependencies other than the static linkage are all considered crossing APEX boundary
357 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
358 return true
359 }
360 return false
361}
362
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100363// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
364// or an invalid path describing the reason it is invalid.
365//
366// It is unset if a dex jar isn't applicable, i.e. no build rule has been
367// requested to create one.
368//
369// If a dex jar has been requested to be built then it is set, and it may be
370// either a valid android.Path, or invalid with a reason message. The latter
371// happens if the source that should produce the dex file isn't able to.
372//
373// E.g. it is invalid with a reason message if there is a prebuilt APEX that
374// could produce the dex jar through a deapexer module, but the APEX isn't
375// installable so doing so wouldn't be safe.
376type OptionalDexJarPath struct {
377 isSet bool
378 path android.OptionalPath
379}
380
381// IsSet returns true if a path has been set, either invalid or valid.
382func (o OptionalDexJarPath) IsSet() bool {
383 return o.isSet
384}
385
386// Valid returns true if there is a path that is valid.
387func (o OptionalDexJarPath) Valid() bool {
388 return o.isSet && o.path.Valid()
389}
390
391// Path returns the valid path, or panics if it's either not set or is invalid.
392func (o OptionalDexJarPath) Path() android.Path {
393 if !o.isSet {
394 panic("path isn't set")
395 }
396 return o.path.Path()
397}
398
399// PathOrNil returns the path if it's set and valid, or else nil.
400func (o OptionalDexJarPath) PathOrNil() android.Path {
401 if o.Valid() {
402 return o.Path()
403 }
404 return nil
405}
406
407// InvalidReason returns the reason for an invalid path, which is never "". It
408// returns "" for an unset or valid path.
409func (o OptionalDexJarPath) InvalidReason() string {
410 if !o.isSet {
411 return ""
412 }
413 return o.path.InvalidReason()
414}
415
416func (o OptionalDexJarPath) String() string {
417 if !o.isSet {
418 return "<unset>"
419 }
420 return o.path.String()
421}
422
423// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
424func makeUnsetDexJarPath() OptionalDexJarPath {
425 return OptionalDexJarPath{isSet: false}
426}
427
428// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
429// the given OptionalPath, which may be valid or invalid.
430func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
431 return OptionalDexJarPath{isSet: true, path: path}
432}
433
434// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
435// valid given path. It returns an unset OptionalDexJarPath if the given path is
436// nil.
437func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
438 if path == nil {
439 return makeUnsetDexJarPath()
440 }
441 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
442}
443
Jaewoong Jung26342642021-03-17 15:56:23 -0700444// Module contains the properties and members used by all java module types
445type Module struct {
446 android.ModuleBase
447 android.DefaultableModuleBase
448 android.ApexModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700449
450 // Functionality common to Module and Import.
451 embeddableInModuleAndImport
452
453 properties CommonProperties
454 protoProperties android.ProtoProperties
455 deviceProperties DeviceProperties
456
yangbill2af0b6e2024-03-15 09:29:29 +0000457 overridableProperties OverridableProperties
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700458 sourceProperties android.SourceProperties
Jooyung Han01d80d82022-01-08 12:16:32 +0900459
Jaewoong Jung26342642021-03-17 15:56:23 -0700460 // jar file containing header classes including static library dependencies, suitable for
461 // inserting into the bootclasspath/classpath of another compile
462 headerJarFile android.Path
463
464 // jar file containing implementation classes including static library dependencies but no
465 // resources
466 implementationJarFile android.Path
467
Jaewoong Jung26342642021-03-17 15:56:23 -0700468 // args and dependencies to package source files into a srcjar
469 srcJarArgs []string
470 srcJarDeps android.Paths
471
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000472 // the source files of this module and all its static dependencies
473 transitiveSrcFiles *android.DepSet[android.Path]
474
Jaewoong Jung26342642021-03-17 15:56:23 -0700475 // jar file containing implementation classes and resources including static library
476 // dependencies
477 implementationAndResourcesJar android.Path
478
479 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100480 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700481
482 // output file containing uninstrumented classes that will be instrumented by jacoco
483 jacocoReportClassesFile android.Path
484
485 // output file of the module, which may be a classes jar or a dex jar
486 outputFile android.Path
487 extraOutputFiles android.Paths
488
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100489 exportAidlIncludeDirs android.Paths
490 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700491
492 logtagsSrcs android.Paths
493
494 // installed file for binary dependency
495 installFile android.Path
496
Colin Cross3108ce12021-11-10 14:38:50 -0800497 // installed file for hostdex copy
498 hostdexInstallFile android.InstallPath
499
Chaohui Wangdcbe33c2022-10-11 11:13:30 +0800500 // list of unique .java and .kt source files
501 uniqueSrcFiles android.Paths
502
503 // list of srcjars that was passed to javac
504 compiledSrcJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700505
506 // manifest file to use instead of properties.Manifest
507 overrideManifest android.OptionalPath
508
Jaewoong Jung26342642021-03-17 15:56:23 -0700509 // list of plugins that this java module is exporting
510 exportedPluginJars android.Paths
511
512 // list of plugins that this java module is exporting
513 exportedPluginClasses []string
514
515 // if true, the exported plugins generate API and require disabling turbine.
516 exportedDisableTurbine bool
517
518 // list of source files, collected from srcFiles with unique java and all kt files,
519 // will be used by android.IDEInfo struct
520 expandIDEInfoCompiledSrcs []string
521
522 // expanded Jarjar_rules
523 expandJarjarRules android.Path
524
Joe Onorato349ae8d2024-02-05 22:46:00 +0000525 // jarjar rule for inherited jarjar rules
526 repackageJarjarRules android.Path
527
Jaewoong Jung26342642021-03-17 15:56:23 -0700528 // Extra files generated by the module type to be added as java resources.
529 extraResources android.Paths
530
531 hiddenAPI
532 dexer
533 dexpreopter
534 usesLibrary
535 linter
536
537 // list of the xref extraction files
538 kytheFiles android.Paths
539
Jaewoong Jung26342642021-03-17 15:56:23 -0700540 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900541
542 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000543 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000544 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400545
546 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000547
548 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000549
550 // output file name based on Stem property.
551 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
552 // or the module should override Stem().
553 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700554
Joe Onorato349ae8d2024-02-05 22:46:00 +0000555 // Values that will be set in the JarJarProvider data for jarjar repackaging,
556 // and merged with our dependencies' rules.
557 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000558
559 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000560
561 // Paths to the aconfig intermediate cache files that are provided by the
562 // java_aconfig_library or java_library modules that are statically linked
563 // to this module. Does not contain cache files from all transitive dependencies.
564 aconfigCacheFiles android.Paths
Spandan Das8aac9932024-07-18 23:14:13 +0000565
566 // List of soong module dependencies required to compile the current module.
567 // This information is printed out to `Dependencies` field in module_bp_java_deps.json
568 compileDepNames []string
Makoto Onuki7ded3822024-03-28 14:42:20 -0700569
570 ravenizer struct {
571 enabled bool
572 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700573}
574
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000575var _ android.InstallableModule = (*Module)(nil)
576
577// To satisfy the InstallableModule interface
Jihoon Kang224ea082024-08-12 22:38:16 +0000578func (j *Module) StaticDependencyTags() []blueprint.DependencyTag {
579 return []blueprint.DependencyTag{staticLibTag}
580}
581
582// To satisfy the InstallableModule interface
583func (j *Module) DynamicDependencyTags() []blueprint.DependencyTag {
584 return []blueprint.DependencyTag{libTag, sdkLibTag, bootClasspathTag, systemModulesTag,
585 instrumentationForTag, java9LibTag}
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000586}
587
588// Overrides android.ModuleBase.InstallInProduct()
589func (j *Module) InstallInProduct() bool {
590 return j.ProductSpecific()
591}
592
Jihoon Kang85bc1932024-07-01 17:04:46 +0000593var _ android.StubsAvailableModule = (*Module)(nil)
594
595// To safisfy the StubsAvailableModule interface
596func (j *Module) IsStubsModule() bool {
597 return proptools.Bool(j.properties.Is_stubs_module)
598}
599
Jiyong Park92315372021-04-02 08:45:46 +0900600func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
601 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900602 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700603 return nil
604 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900605 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000606 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700607 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
608 } else {
609 // Treat stable core platform as stable.
610 return nil
611 }
612 } else {
613 return fmt.Errorf("non stable SDK %v", sdkVersion)
614 }
615}
616
617// checkSdkVersions enforces restrictions around SDK dependencies.
618func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
619 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900620 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900621 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700622 ctx.PropertyErrorf("sdk_version",
623 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
624 }
625 }
626 }
627
628 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
629 // See rank() for details.
630 ctx.VisitDirectDeps(func(module android.Module) {
631 tag := ctx.OtherModuleDependencyTag(module)
632 switch module.(type) {
633 // TODO(satayev): cover other types as well, e.g. imports
634 case *Library, *AndroidLibrary:
635 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400636 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700637 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
638 }
639 }
640 })
641}
642
643func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900644 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700645 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900646 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700647 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000648 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 -0700649 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000650 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 -0700651 }
652
653 }
654}
655
Mark Whitea15790a2023-08-22 21:28:11 +0000656func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
657 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400658 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000659 installable := proptools.Bool(j.properties.Installable)
660
661 if headersOnly && installable {
662 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.")
663 }
664 }
665}
666
Jaewoong Jung26342642021-03-17 15:56:23 -0700667func (j *Module) addHostProperties() {
668 j.AddProperties(
669 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000670 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700671 &j.protoProperties,
672 &j.usesLibraryProperties,
673 )
674}
675
676func (j *Module) addHostAndDeviceProperties() {
677 j.addHostProperties()
678 j.AddProperties(
679 &j.deviceProperties,
680 &j.dexer.dexProperties,
681 &j.dexpreoptProperties,
682 &j.linter.properties,
683 )
684}
685
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000686// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
687// makes it available through the hiddenAPIPropertyInfoProvider.
688func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
689 hiddenAPIInfo := newHiddenAPIPropertyInfo()
690
691 // Populate with flag file paths from the properties.
692 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
693
694 // Populate with package rules from the properties.
695 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
696
Colin Cross40213022023-12-13 15:19:49 -0800697 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000698}
699
mrziwang9f7b9f42024-07-10 12:18:06 -0700700// helper method for java modules to set OutputFilesProvider
701func setOutputFiles(ctx android.ModuleContext, m Module) {
702 ctx.SetOutputFiles(append(android.Paths{m.outputFile}, m.extraOutputFiles...), "")
703 ctx.SetOutputFiles(android.Paths{m.outputFile}, android.DefaultDistTag)
704 ctx.SetOutputFiles(android.Paths{m.implementationAndResourcesJar}, ".jar")
705 ctx.SetOutputFiles(android.Paths{m.headerJarFile}, ".hjar")
706 if m.dexer.proguardDictionary.Valid() {
707 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
708 }
709 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
Jaewoong Jung26342642021-03-17 15:56:23 -0700710}
711
Jaewoong Jung26342642021-03-17 15:56:23 -0700712func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
713 initJavaModule(module, hod, false)
714}
715
716func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
717 initJavaModule(module, hod, true)
718}
719
720func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
721 multilib := android.MultilibCommon
722 if multiTargets {
723 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
724 } else {
725 android.InitAndroidArchModule(module, hod, multilib)
726 }
727 android.InitDefaultableModule(module)
728}
729
730func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
731 return j.properties.Instrument &&
732 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
733 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
734}
735
Yihan Dong8be09c22024-08-29 15:32:13 +0800736func (j *Module) shouldApiMapper() bool {
737 return j.properties.ApiMapper
738}
739
Jaewoong Jung26342642021-03-17 15:56:23 -0700740func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000741 return j.properties.Supports_static_instrumentation &&
742 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700743 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
744 ctx.Config().UnbundledBuild())
745}
746
747func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
748 // Force enable the instrumentation for java code that is built for APEXes ...
749 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
750 // 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 -0800751 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700752 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000753
Jihoon Kang46d66de2024-05-22 22:42:39 +0000754 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700755 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
756 return true
757 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
758 return true
759 }
760 }
761 return false
762}
763
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400764func (j *Module) setInstrument(value bool) {
765 j.properties.Instrument = value
766}
767
Yihan Dong8be09c22024-08-29 15:32:13 +0800768func (j *Module) setApiMapper(value bool) {
769 j.properties.ApiMapper = value
770}
771
Jiyong Park92315372021-04-02 08:45:46 +0900772func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
773 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700774}
775
Jiyong Parkf1691d22021-03-29 20:11:58 +0900776func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700777 return proptools.String(j.deviceProperties.System_modules)
778}
779
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000780func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000781 if j.overridableProperties.Min_sdk_version != nil {
782 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700783 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000784 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700785}
786
Yu Liuf2b94012023-09-19 15:09:10 -0700787func (j *Module) GetDeviceProperties() *DeviceProperties {
788 return &j.deviceProperties
789}
790
Spandan Dasa26eda72023-03-02 00:56:06 +0000791func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
792 if j.deviceProperties.Max_sdk_version != nil {
793 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
794 }
795 // Default is PrivateApiLevel
796 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000797}
798
Spandan Dasa26eda72023-03-02 00:56:06 +0000799func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
800 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
801 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
802 }
803 // Default is PrivateApiLevel
804 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000805}
806
Jiyong Parkf1691d22021-03-29 20:11:58 +0900807func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000808 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900809}
810
Spandan Dasca70fc42023-03-01 23:38:49 +0000811func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900812 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000813 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900814 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000815 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700816}
817
818func (j *Module) AvailableFor(what string) bool {
819 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
820 // Exception: for hostdex: true libraries, the platform variant is created
821 // even if it's not marked as available to platform. In that case, the platform
822 // variant is used only for the hostdex and not installed to the device.
823 return true
824 }
825 return j.ApexModuleBase.AvailableFor(what)
826}
827
Cole Faustb7493472024-08-28 11:55:52 -0700828func (j *Module) staticLibs(ctx android.BaseModuleContext) []string {
829 return android.RemoveListFromList(j.properties.Static_libs.GetOrDefault(ctx, nil), j.properties.Exclude_static_libs)
830}
831
Jaewoong Jung26342642021-03-17 15:56:23 -0700832func (j *Module) deps(ctx android.BottomUpMutatorContext) {
833 if ctx.Device() {
834 j.linter.deps(ctx)
835
Jiyong Parkf1691d22021-03-29 20:11:58 +0900836 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700837
838 if j.deviceProperties.SyspropPublicStub != "" {
839 // This is a sysprop implementation library that has a corresponding sysprop public
840 // stubs library, and a dependency on it so that dependencies on the implementation can
841 // be forwarded to the public stubs library when necessary.
842 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
843 }
844 }
845
846 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000847
Cole Faustb7493472024-08-28 11:55:52 -0700848 ctx.AddVariationDependencies(nil, staticLibTag, j.staticLibs(ctx)...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700849
850 // Add dependency on libraries that provide additional hidden api annotations.
851 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
852
Kiyoung Kim9743bab2024-03-28 15:44:56 +0900853 if ctx.Config().EnforceInterPartitionJavaSdkLibrary() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700854 // Require java_sdk_library at inter-partition java dependency to ensure stable
855 // interface between partitions. If inter-partition java_library dependency is detected,
856 // raise build error because java_library doesn't have a stable interface.
857 //
858 // Inputs:
859 // PRODUCT_ENFORCE_INTER_PARTITION_JAVA_SDK_LIBRARY
860 // if true, enable enforcement
861 // PRODUCT_INTER_PARTITION_JAVA_LIBRARY_ALLOWLIST
862 // exception list of java_library names to allow inter-partition dependency
863 for idx := range j.properties.Libs {
864 if libDeps[idx] == nil {
865 continue
866 }
867
868 if javaDep, ok := libDeps[idx].(javaSdkLibraryEnforceContext); ok {
869 // java_sdk_library is always allowed at inter-partition dependency.
870 // So, skip check.
871 if _, ok := javaDep.(*SdkLibrary); ok {
872 continue
873 }
874
875 j.checkPartitionsForJavaDependency(ctx, "libs", javaDep)
876 }
877 }
878 }
879
880 // For library dependencies that are component libraries (like stubs), add the implementation
881 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
882 for _, dep := range libDeps {
883 if dep != nil {
884 if component, ok := dep.(SdkLibraryComponentDependency); ok {
885 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000886 // Add library as optional if it's one of the optional compatibility libs or it's
887 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100888 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000889 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
890 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100891 tag = usesLibOptTag
892 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100893 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700894 }
895 }
896 }
897 }
898
899 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
900 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
901 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
902
903 android.ProtoDeps(ctx, &j.protoProperties)
904 if j.hasSrcExt(".proto") {
905 protoDeps(ctx, &j.protoProperties)
906 }
907
908 if j.hasSrcExt(".kt") {
909 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
910 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700911 tag := staticLibTag
912 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
913 tag = libTag
914 }
915 ctx.AddVariationDependencies(nil, tag,
916 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700917 }
918
919 // Framework libraries need special handling in static coverage builds: they should not have
920 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
921 // the same jacoco classes coming from different bootclasspath jars.
922 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
923 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
924 j.properties.Instrument = true
925 }
926 } else if j.shouldInstrumentStatic(ctx) {
927 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
928 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700929
Cole Faustb7493472024-08-28 11:55:52 -0700930 if j.useCompose(ctx) {
Colin Crossa1ff7c62021-09-17 14:11:52 -0700931 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
932 "androidx.compose.compiler_compiler-hosted")
933 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700934}
935
936func hasSrcExt(srcs []string, ext string) bool {
937 for _, src := range srcs {
938 if filepath.Ext(src) == ext {
939 return true
940 }
941 }
942
943 return false
944}
945
946func (j *Module) hasSrcExt(ext string) bool {
947 return hasSrcExt(j.properties.Srcs, ext)
948}
949
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100950func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
951 var flags string
952
953 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
954 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
955 flags = "-Wmissing-permission-annotation -Werror"
956 }
957 }
958 return flags
959}
960
Jaewoong Jung26342642021-03-17 15:56:23 -0700961func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000962 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700963
964 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
965 aidlIncludes = append(aidlIncludes,
966 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
967 aidlIncludes = append(aidlIncludes,
968 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
969
970 var flags []string
971 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000972 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700973
974 flags = append(flags, j.deviceProperties.Aidl.Flags...)
975
976 if aidlPreprocess.Valid() {
977 flags = append(flags, "-p"+aidlPreprocess.String())
978 deps = append(deps, aidlPreprocess.Path())
979 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000980 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700981 }
982
983 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000984 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700985 }
986
987 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000988 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700989 }
990
Sam Delmerico2351eac2022-05-24 17:10:02 +0000991 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700992 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000993 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700994 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000995 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
996 // add flags for dirs containing AIDL srcs that haven't been specified yet
997 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -0700998
Zim8774ae12022-08-17 11:46:34 +0100999 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +00001000 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +01001001 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001002 flags = append(flags, "-t")
1003 }
1004
1005 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
1006 flags = append(flags, "--transaction_names")
1007 }
1008
Thiébaud Weksteende8417c2022-02-10 15:41:46 +11001009 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
1010 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
1011 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1012 }
1013
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001014 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001015 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1016
Jaewoong Jung26342642021-03-17 15:56:23 -07001017 return strings.Join(flags, " "), deps
1018}
1019
1020func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1021
1022 var flags javaBuilderFlags
1023
1024 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001025 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001026
Cole Faust2b1536e2021-06-18 12:25:54 -07001027 epEnabled := j.properties.Errorprone.Enabled
1028 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001029 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001030 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1031 }
1032
1033 errorProneFlags := []string{
1034 "-Xplugin:ErrorProne",
1035 "${config.ErrorProneChecks}",
1036 }
1037 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1038
Colin Cross8bf6cad2022-02-28 13:07:03 -08001039 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001040 "'" + strings.Join(errorProneFlags, " ") + "'"
1041 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1042 }
1043
1044 // classpath
1045 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1046 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001047 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001048 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1049 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1050 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1051
1052 flags.processors = append(flags.processors, deps.processorClasses...)
1053 flags.processors = android.FirstUniqueStrings(flags.processors)
1054
1055 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001056 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001057 // Give host-side tools a version of OpenJDK's standard libraries
1058 // close to what they're targeting. As of Dec 2017, AOSP is only
1059 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1060 //
1061 // When building with OpenJDK 8, the following should have no
1062 // effect since those jars would be available by default.
1063 //
1064 // When building with OpenJDK 9 but targeting a version < 1.8,
1065 // putting them on the bootclasspath means that:
1066 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1067 // b) references to existing APIs are not reinterpreted in an
1068 // OpenJDK 9-specific way, eg. calls to subclasses of
1069 // java.nio.Buffer as in http://b/70862583
1070 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1071 flags.bootClasspath = append(flags.bootClasspath,
1072 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1073 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1074 if Bool(j.properties.Use_tools_jar) {
1075 flags.bootClasspath = append(flags.bootClasspath,
1076 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1077 }
1078 }
1079
1080 // systemModules
1081 flags.systemModules = deps.systemModules
1082
Jaewoong Jung26342642021-03-17 15:56:23 -07001083 return flags
1084}
1085
1086func (j *Module) collectJavacFlags(
1087 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1088 // javac flags.
1089 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001090 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001091
Mythri Alle4b9f6182023-10-25 15:17:11 +00001092 needsDebugInfo = false
1093 for _, flag := range javacFlags {
1094 if strings.HasPrefix(flag, "-g") {
1095 needsDebugInfo = true
1096 }
1097 }
1098
1099 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001100 // For non-host binaries, override the -g flag passed globally to remove
1101 // local variable debug info to reduce disk and memory usage.
1102 javacFlags = append(javacFlags, "-g:source,lines")
1103 }
1104 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1105
1106 if flags.javaVersion.usesJavaModules() {
1107 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001108 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1109 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1110 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1111 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001112
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001113 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001114 if j.properties.Patch_module != nil {
1115 // Manually specify build directory in case it is not under the repo root.
1116 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1117 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001118 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001119
Jaewoong Jung26342642021-03-17 15:56:23 -07001120 classPath := flags.classpath.FormJavaClassPath("")
1121 if classPath != "" {
1122 patchPaths = append(patchPaths, classPath)
1123 }
1124 javacFlags = append(
1125 javacFlags,
1126 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1127 }
1128 }
1129
1130 if len(javacFlags) > 0 {
1131 // optimization.
1132 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1133 flags.javacFlags = "$javacFlags"
1134 }
1135
1136 return flags
1137}
1138
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001139func (j *Module) AddJSONData(d *map[string]interface{}) {
1140 (&j.ModuleBase).AddJSONData(d)
1141 (*d)["Java"] = map[string]interface{}{
1142 "SourceExtensions": j.sourceExtensions,
1143 }
1144
1145}
1146
usta0391ca42023-09-19 15:51:59 -04001147func (j *Module) addGeneratedSrcJars(path android.Path) {
1148 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001149}
1150
Colin Crossfdaa6722024-08-23 11:58:08 -07001151func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars, extraDepCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001152 // Auto-propagating jarjar rules
1153 jarjarProviderData := j.collectJarJarRules(ctx)
1154 if jarjarProviderData != nil {
1155 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wangddb2ee52024-04-02 16:44:02 +00001156 text := getJarJarRuleText(jarjarProviderData)
1157 if text != "" {
1158 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1159 android.WriteFileRule(ctx, ruleTextFile, text)
1160 j.repackageJarjarRules = ruleTextFile
Joe Onorato349ae8d2024-02-05 22:46:00 +00001161 }
1162 }
1163
Jaewoong Jung26342642021-03-17 15:56:23 -07001164 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1165
Makoto Onuki7ded3822024-03-28 14:42:20 -07001166 if re := proptools.Bool(j.properties.Ravenizer.Enabled); re {
1167 j.ravenizer.enabled = re
1168 }
1169
Jaewoong Jung26342642021-03-17 15:56:23 -07001170 deps := j.collectDeps(ctx)
1171 flags := j.collectBuilderFlags(ctx, deps)
1172
1173 if flags.javaVersion.usesJavaModules() {
1174 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001175 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1176 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1177 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001178 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001179
Jaewoong Jung26342642021-03-17 15:56:23 -07001180 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001181 j.sourceExtensions = []string{}
1182 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1183 if hasSrcExt(srcFiles.Strings(), ext) {
1184 j.sourceExtensions = append(j.sourceExtensions, ext)
1185 }
1186 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001187 if hasSrcExt(srcFiles.Strings(), ".proto") {
1188 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1189 }
1190
1191 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1192 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1193 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1194 }
1195
Sam Delmerico2351eac2022-05-24 17:10:02 +00001196 aidlSrcs := srcFiles.FilterByExt(".aidl")
1197 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1198
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001199 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001200 srcFiles = j.genSources(ctx, srcFiles, flags)
1201
1202 // Collect javac flags only after computing the full set of srcFiles to
1203 // ensure that the --patch-module lookup paths are complete.
1204 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1205
1206 srcJars := srcFiles.FilterByExt(".srcjar")
1207 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001208 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001209 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001210 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001211
1212 if j.properties.Jarjar_rules != nil {
1213 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1214 }
1215
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001216 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001217
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001218 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001219 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001220 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001221 if _, found := set[v.String()]; !found {
1222 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001223 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001224 }
1225 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001226 var uniqueKtFiles android.Paths
1227 for _, v := range srcFiles.FilterByExt(".kt") {
1228 if _, found := set[v.String()]; !found {
1229 set[v.String()] = true
1230 uniqueKtFiles = append(uniqueKtFiles, v)
1231 }
1232 }
1233
1234 var uniqueSrcFiles android.Paths
1235 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1236 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1237 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001238 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001239
Colin Crossb5db4012022-03-28 17:12:39 -07001240 // We don't currently run annotation processors in turbine, which means we can't use turbine
1241 // generated header jars when an annotation processor that generates API is enabled. One
1242 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1243 // is used to run all of the annotation processors.
1244 disableTurbine := deps.disableTurbine
1245
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001246 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001247 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1248
Colin Cross220a9a12022-03-28 17:08:01 -07001249 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001250
Colin Cross4eae06d2023-06-20 22:40:02 -07001251 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1252 // any dependencies so that it can override any non-final R classes from dependencies with the
1253 // final R classes from the app.
1254 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1255
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001256 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1257
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001258 var localImplementationJars android.Paths
1259
Mark Whitea15790a2023-08-22 21:28:11 +00001260 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001261 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001262 if srcFiles.HasExt(".kt") {
1263 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1264 }
1265 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1266 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1267 }
1268
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001269 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1270
1271 localHeaderJars, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
Colin Crossedec77c2024-07-26 15:25:40 -07001272 extraCombinedJars)
1273
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001274 combinedHeaderJarFile, jarjared := j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1275 if jarjared {
1276 localHeaderJars = android.Paths{combinedHeaderJarFile}
1277 transitiveStaticLibsHeaderJars = nil
1278 }
1279 combinedHeaderJarFile, repackaged := j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
1280 if repackaged {
1281 localHeaderJars = android.Paths{combinedHeaderJarFile}
1282 transitiveStaticLibsHeaderJars = nil
1283 }
Mark Whitea15790a2023-08-22 21:28:11 +00001284 if ctx.Failed() {
1285 return
1286 }
Colin Crossedec77c2024-07-26 15:25:40 -07001287 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001288
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001289 if ctx.Config().UseTransitiveJarsInClasspath() {
1290 if len(localHeaderJars) > 0 {
1291 ctx.CheckbuildFile(localHeaderJars...)
1292 } else {
1293 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1294 ctx.UncheckedModule()
1295 }
1296 } else {
1297 ctx.CheckbuildFile(j.headerJarFile)
1298 }
Colin Crossa6182ab2024-08-21 10:47:44 -07001299
Colin Cross7727c7f2024-07-18 15:36:32 -07001300 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001301 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001302 LocalHeaderJars: localHeaderJars,
1303 TransitiveStaticLibsHeaderJars: android.NewDepSet(android.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Cross9ffaf282024-08-12 13:50:09 -07001304 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1305 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001306 AidlIncludeDirs: j.exportAidlIncludeDirs,
1307 ExportedPlugins: j.exportedPluginJars,
1308 ExportedPluginClasses: j.exportedPluginClasses,
1309 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1310 StubsLinkType: j.stubsLinkType,
1311 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001312 })
1313
1314 j.outputFile = j.headerJarFile
1315 return
1316 }
1317
Jaewoong Jung26342642021-03-17 15:56:23 -07001318 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001319 // When using kotlin sources turbine is used to generate annotation processor sources,
1320 // including for annotation processors that generate API, so we can use turbine for
1321 // java sources too.
1322 disableTurbine = false
1323
Jaewoong Jung26342642021-03-17 15:56:23 -07001324 // user defined kotlin flags.
1325 kotlincFlags := j.properties.Kotlincflags
1326 CheckKotlincFlags(ctx, kotlincFlags)
1327
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001328 // Workaround for KT-46512
1329 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001330
1331 // If there are kotlin files, compile them first but pass all the kotlin and java files
1332 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1333 // won't emit any classes for them.
1334 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1335 if ctx.Device() {
1336 kotlincFlags = append(kotlincFlags, "-no-jdk")
1337 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001338
1339 for _, plugin := range deps.kotlinPlugins {
1340 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1341 }
1342 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1343
Jaewoong Jung26342642021-03-17 15:56:23 -07001344 if len(kotlincFlags) > 0 {
1345 // optimization.
1346 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1347 flags.kotlincFlags += "$kotlincFlags"
1348 }
1349
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001350 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001351 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1352
Jaewoong Jung26342642021-03-17 15:56:23 -07001353 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1354 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1355
Isaac Chioua23d9942022-04-06 06:14:38 +00001356 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001357 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001358 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1359 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001360 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001361 srcJars = append(srcJars, kaptSrcJar)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001362 localImplementationJars = append(localImplementationJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001363 // Disable annotation processing in javac, it's already been handled by kapt
1364 flags.processorPath = nil
1365 flags.processors = nil
1366 }
1367
1368 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001369 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001370 kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001371 if ctx.Failed() {
1372 return
1373 }
1374
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001375 kotlinJarPath, _ := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001376
Isaac Chioua23d9942022-04-06 06:14:38 +00001377 // Make javac rule depend on the kotlinc rule
1378 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1379
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001380 localImplementationJars = append(localImplementationJars, kotlinJarPath)
1381
Colin Cross220a9a12022-03-28 17:08:01 -07001382 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001383 }
1384
Jaewoong Jung26342642021-03-17 15:56:23 -07001385 j.compiledSrcJars = srcJars
1386
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001387 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1388
Jaewoong Jung26342642021-03-17 15:56:23 -07001389 enableSharding := false
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001390 var localHeaderJars android.Paths
1391 var shardingHeaderJars android.Paths
1392 var repackagedHeaderJarFile android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001393 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001394 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1395 enableSharding = true
1396 // Formerly, there was a check here that prevented annotation processors
1397 // from being used when sharding was enabled, as some annotation processors
1398 // do not function correctly in sharded environments. It was removed to
1399 // allow for the use of annotation processors that do function correctly
1400 // with sharding enabled. See: b/77284273.
1401 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001402 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001403 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001404 var combinedHeaderJarFile android.Path
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001405 localHeaderJars, combinedHeaderJarFile = j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
1406 shardingHeaderJars = localHeaderJars
Colin Crossedec77c2024-07-26 15:25:40 -07001407
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001408 var jarjared bool
1409 j.headerJarFile, jarjared = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1410 if jarjared {
1411 // jarjar modifies transitive static dependencies, use the combined header jar and drop the transitive
1412 // static libs header jars.
1413 localHeaderJars = android.Paths{j.headerJarFile}
1414 transitiveStaticLibsHeaderJars = nil
1415 }
1416 var repackaged bool
1417 repackagedHeaderJarFile, repackaged = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
1418 if repackaged {
1419 // repackage modifies transitive static dependencies, use the combined header jar and drop the transitive
1420 // static libs header jars.
1421 // TODO(b/356688296): this shouldn't export both the unmodified and repackaged header jars
1422 localHeaderJars = android.Paths{j.headerJarFile, repackagedHeaderJarFile}
1423 transitiveStaticLibsHeaderJars = nil
1424 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001425 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001426 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001427 hasErrorproneableFiles := false
1428 for _, ext := range j.sourceExtensions {
1429 if ext != ".proto" && ext != ".aidl" {
1430 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1431 // compile, and it's not useful to have warnings on these generated sources.
1432 hasErrorproneableFiles = true
1433 break
1434 }
1435 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001436 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001437 if Bool(j.properties.Errorprone.Enabled) {
1438 // If error-prone is enabled, enable errorprone flags on the regular
1439 // build.
1440 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001441 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001442 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1443 // a new jar file just for compiling with the errorprone compiler to.
1444 // This is because we don't want to cause the java files to get completely
1445 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1446 // We also don't want to run this if errorprone is enabled by default for
1447 // this module, or else we could have duplicated errorprone messages.
1448 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001449 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001450 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001451
Vadim Spivak3c496f02023-06-08 06:14:59 +00001452 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001453 "errorprone", "errorprone")
1454
Jaewoong Jung26342642021-03-17 15:56:23 -07001455 extraJarDeps = append(extraJarDeps, errorprone)
1456 }
1457
1458 if enableSharding {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001459 if len(shardingHeaderJars) > 0 {
1460 flags.classpath = append(classpath(slices.Clone(shardingHeaderJars)), flags.classpath...)
Colin Cross3d56ed52021-11-18 22:23:12 -08001461 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001462 shardSize := int(*(j.properties.Javac_shard_size))
1463 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001464 if len(uniqueJavaFiles) > 0 {
1465 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001466 for idx, shardSrc := range shardSrcs {
1467 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1468 nil, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001469 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
1470 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001471 }
1472 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001473 // Assume approximately 5 sources per srcjar.
1474 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1475 // 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 -07001476 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001477 startIdx := len(shardSrcs)
1478 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1479 for idx, shardSrcJars := range shardSrcJarsList {
1480 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1481 nil, shardSrcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001482 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
1483 localImplementationJars = append(localImplementationJars, classes)
Colin Crossa052ddb2023-09-25 21:46:58 -07001484 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001485 }
1486 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001487 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001488 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
1489 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001490 }
1491 if ctx.Failed() {
1492 return
1493 }
1494 }
1495
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001496 localImplementationJars = append(localImplementationJars, extraCombinedJars...)
Colin Crossfd620b22024-02-23 10:05:21 -08001497
Jaewoong Jung26342642021-03-17 15:56:23 -07001498 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1499
1500 var includeSrcJar android.WritablePath
1501 if Bool(j.properties.Include_srcs) {
1502 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1503 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1504 }
1505
1506 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1507 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1508 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1509 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1510
1511 var resArgs []string
1512 var resDeps android.Paths
1513
1514 resArgs = append(resArgs, dirArgs...)
1515 resDeps = append(resDeps, dirDeps...)
1516
1517 resArgs = append(resArgs, fileArgs...)
1518 resDeps = append(resDeps, fileDeps...)
1519
1520 resArgs = append(resArgs, extraArgs...)
1521 resDeps = append(resDeps, extraDeps...)
1522
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001523 var localResourceJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001524 if len(resArgs) > 0 {
1525 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1526 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001527 if ctx.Failed() {
1528 return
1529 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001530 localResourceJars = append(localResourceJars, resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001531 }
1532
Jaewoong Jung26342642021-03-17 15:56:23 -07001533 if Bool(j.properties.Include_srcs) {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001534 localResourceJars = append(localResourceJars, includeSrcJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001535 }
1536
1537 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1538 if len(services) > 0 {
1539 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1540 var zipargs []string
1541 for _, file := range services {
1542 serviceFile := file.String()
1543 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1544 }
1545 rule := zip
1546 args := map[string]string{
1547 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1548 }
1549 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1550 rule = zipRE
1551 args["implicits"] = strings.Join(services.Strings(), ",")
1552 }
1553 ctx.Build(pctx, android.BuildParams{
1554 Rule: rule,
1555 Output: servicesJar,
1556 Implicits: services,
1557 Args: args,
1558 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001559 localResourceJars = append(localResourceJars, servicesJar)
1560 }
1561
1562 completeStaticLibsResourceJars := android.NewDepSet(android.PREORDER, localResourceJars, deps.transitiveStaticLibsResourceJars)
1563
1564 var combinedResourceJar android.Path
1565 var resourceJars android.Paths
1566 if ctx.Config().UseTransitiveJarsInClasspath() {
1567 resourceJars = completeStaticLibsResourceJars.ToList()
1568 } else {
1569 resourceJars = append(slices.Clone(localResourceJars), deps.staticResourceJars...)
1570 }
1571 if len(resourceJars) == 1 {
1572 combinedResourceJar = resourceJars[0]
1573 } else if len(resourceJars) > 0 {
1574 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1575 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1576 false, nil, nil)
1577 combinedResourceJar = combinedJar
1578 }
1579
1580 manifest := j.overrideManifest
1581 if !manifest.Valid() && j.properties.Manifest != nil {
1582 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Jaewoong Jung26342642021-03-17 15:56:23 -07001583 }
1584
1585 // Combine the classes built from sources, any manifests, and any static libraries into
1586 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001587 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001588
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001589 completeStaticLibsImplementationJars := android.NewDepSet(android.PREORDER, localImplementationJars, deps.transitiveStaticLibsImplementationJars)
1590
1591 var jars android.Paths
1592 if ctx.Config().UseTransitiveJarsInClasspath() {
1593 jars = completeStaticLibsImplementationJars.ToList()
1594 } else {
1595 jars = append(slices.Clone(localImplementationJars), deps.staticJars...)
1596 }
1597
1598 jars = append(jars, extraDepCombinedJars...)
1599
Jaewoong Jung26342642021-03-17 15:56:23 -07001600 if len(jars) == 1 && !manifest.Valid() {
1601 // Optimization: skip the combine step as there is nothing to do
1602 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1603 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001604 // any if len(extraJars) == 0.
Jaewoong Jung26342642021-03-17 15:56:23 -07001605
Jihoon Kang1147b312023-06-08 23:25:57 +00001606 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1607 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1608 // either with .from-source or .from-text suffix.
1609 // outputFile should be agnostic to the build configuration,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001610 // thus copy the single input static lib in order to prevent the static lib from being exposed
Jihoon Kang1147b312023-06-08 23:25:57 +00001611 // to the copy rules.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001612 if stub, _ := moduleStubLinkType(j); stub {
1613 copiedJar := android.PathForModuleOut(ctx, "combined", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001614 ctx.Build(pctx, android.BuildParams{
1615 Rule: android.Cp,
1616 Input: jars[0],
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001617 Output: copiedJar,
Jaewoong Jung26342642021-03-17 15:56:23 -07001618 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001619 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, android.Paths{copiedJar}, nil)
1620 outputFile = copiedJar
Colin Cross7707b242024-07-26 12:02:36 -07001621 } else {
1622 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001623 }
1624 } else {
1625 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1626 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1627 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001628 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001629 }
1630
1631 // jarjar implementation jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001632 jarjarFile, jarjarred := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1633 if jarjarred {
1634 localImplementationJars = android.Paths{jarjarFile}
1635 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
1636 }
Colin Crossedec77c2024-07-26 15:25:40 -07001637 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001638
Colin Crossedec77c2024-07-26 15:25:40 -07001639 // jarjar resource jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001640 if combinedResourceJar != nil {
1641 resourceJarJarFile, jarjarred := j.jarjarIfNecessary(ctx, combinedResourceJar, jarName, "resource")
1642 combinedResourceJar = resourceJarJarFile
1643 if jarjarred {
1644 localResourceJars = android.Paths{resourceJarJarFile}
1645 completeStaticLibsResourceJars = android.NewDepSet(android.PREORDER, localResourceJars, nil)
1646 }
Colin Crossedec77c2024-07-26 15:25:40 -07001647 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001648
Colin Crossedec77c2024-07-26 15:25:40 -07001649 if ctx.Failed() {
1650 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001651 }
1652
Makoto Onuki7ded3822024-03-28 14:42:20 -07001653 if j.ravenizer.enabled {
1654 ravenizerInput := outputFile
1655 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", jarName)
1656 ctx.Build(pctx, android.BuildParams{
1657 Rule: ravenizer,
1658 Description: "ravenizer",
1659 Input: ravenizerInput,
1660 Output: ravenizerOutput,
1661 })
1662 outputFile = ravenizerOutput
Colin Cross7e863852024-09-06 14:42:38 -07001663 localImplementationJars = android.Paths{ravenizerOutput}
1664 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Makoto Onuki7ded3822024-03-28 14:42:20 -07001665 }
1666
Yihan Dong8be09c22024-08-29 15:32:13 +08001667 if j.shouldApiMapper() {
1668 inputFile := outputFile
1669 apiMapperFile := android.PathForModuleOut(ctx, "apimapper", jarName)
1670 ctx.Build(pctx, android.BuildParams{
1671 Rule: apimapper,
1672 Description: "apimapper",
1673 Input: inputFile,
1674 Output: apiMapperFile,
1675 })
1676 outputFile = apiMapperFile
Colin Cross7e863852024-09-06 14:42:38 -07001677 localImplementationJars = android.Paths{apiMapperFile}
1678 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Yihan Dong8be09c22024-08-29 15:32:13 +08001679 }
1680
Jaewoong Jung26342642021-03-17 15:56:23 -07001681 // Check package restrictions if necessary.
1682 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001683 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001684 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001685
1686 // Create a rule to copy the output jar to another path and add a validate dependency that
1687 // will check that the jar only contains the permitted packages. The new location will become
1688 // the output file of this module.
1689 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001690 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001691 ctx.Build(pctx, android.BuildParams{
1692 Rule: android.Cp,
1693 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001694 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001695 // Make sure that any dependency on the output file will cause ninja to run the package check
1696 // rule.
1697 Validation: pkgckFile,
1698 })
Colin Cross7707b242024-07-26 12:02:36 -07001699 outputFile = packageCheckOutputFile
Colin Cross7e863852024-09-06 14:42:38 -07001700 localImplementationJars = android.Paths{packageCheckOutputFile}
1701 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001702
1703 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001704 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001705
1706 if ctx.Failed() {
1707 return
1708 }
1709 }
1710
1711 j.implementationJarFile = outputFile
1712 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001713 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1714 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1715 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1716 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1717 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1718 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1719 j.headerJarFile = headerJarFile
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001720 if len(localImplementationJars) == 1 && ctx.Config().UseTransitiveJarsInClasspath() {
1721 localHeaderJarFile := android.PathForModuleOut(ctx, "local-javac-header", jarName)
1722 convertImplementationJarToHeaderJar(ctx, localImplementationJars[0], localHeaderJarFile)
1723 localHeaderJars = append(localHeaderJars, localHeaderJarFile)
1724 } else {
1725 localHeaderJars = append(localHeaderJars, headerJarFile)
1726 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001727 }
1728
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001729 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1730 specs := j.jacocoModuleToZipCommand(ctx)
1731 if ctx.Failed() {
1732 return
1733 }
1734
Colin Crossb323c912024-09-24 15:21:00 -07001735 completeStaticLibsImplementationJarsToCombine := completeStaticLibsImplementationJars
1736
Jaewoong Jung26342642021-03-17 15:56:23 -07001737 if j.shouldInstrument(ctx) {
Colin Crossb323c912024-09-24 15:21:00 -07001738 instrumentedOutputFile := j.instrument(ctx, flags, outputFile, jarName, specs)
1739 completeStaticLibsImplementationJarsToCombine = android.NewDepSet(android.PREORDER, android.Paths{instrumentedOutputFile}, nil)
1740 outputFile = instrumentedOutputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001741 }
1742
1743 // merge implementation jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001744 var implementationAndResourcesJarsToCombine android.Paths
1745 if ctx.Config().UseTransitiveJarsInClasspath() {
1746 resourceJars := completeStaticLibsResourceJars.ToList()
1747 if len(resourceJars) > 0 {
Colin Crossb323c912024-09-24 15:21:00 -07001748 implementationAndResourcesJarsToCombine = append(resourceJars, completeStaticLibsImplementationJarsToCombine.ToList()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001749 implementationAndResourcesJarsToCombine = append(implementationAndResourcesJarsToCombine, extraDepCombinedJars...)
1750 }
1751 } else {
1752 if combinedResourceJar != nil {
1753 implementationAndResourcesJarsToCombine = android.Paths{combinedResourceJar, outputFile}
1754 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001755 }
1756
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001757 if len(implementationAndResourcesJarsToCombine) > 0 {
1758 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
1759 TransformJarsToJar(ctx, combinedJar, "for resources", implementationAndResourcesJarsToCombine, manifest,
1760 false, nil, nil)
1761 outputFile = combinedJar
1762 }
1763
1764 j.implementationAndResourcesJar = outputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001765
1766 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001767 compileDex := j.dexProperties.Compile_dex
Colin Crossff694a82023-12-13 15:54:49 -08001768 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -07001769 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001770 if compileDex == nil {
1771 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001772 }
1773 if j.deviceProperties.Hostdex == nil {
1774 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1775 }
1776 }
1777
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001778 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001779 if j.hasCode(ctx) {
1780 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001781 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001782 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1783 }
1784 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001785 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001786 params := &compileDexParams{
1787 flags: flags,
1788 sdkVersion: j.SdkVersion(ctx),
1789 minSdkVersion: j.MinSdkVersion(ctx),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001790 classesJar: outputFile,
Spandan Dasc404cc72023-02-23 18:05:05 +00001791 jarName: jarName,
1792 }
Spandan Das15a67112024-05-30 00:07:40 +00001793 if j.GetProfileGuided() && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting() {
1794 ctx.PropertyErrorf("enable_profile_rewriting",
1795 "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.",
1796 )
1797 }
Spandan Das3dbda182024-05-20 22:23:10 +00001798 if j.EnableProfileRewriting() {
1799 profile := j.GetProfile()
1800 if profile == "" || !j.GetProfileGuided() {
1801 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1802 }
1803 params.artProfileInput = &profile
1804 }
1805 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001806 if ctx.Failed() {
1807 return
1808 }
1809
Spandan Das3dbda182024-05-20 22:23:10 +00001810 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1811 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001812 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001813 }
1814
Jaewoong Jung26342642021-03-17 15:56:23 -07001815 // merge dex jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001816 var dexAndResourceJarsToCombine android.Paths
1817 if ctx.Config().UseTransitiveJarsInClasspath() {
1818 resourceJars := completeStaticLibsResourceJars.ToList()
1819 if len(resourceJars) > 0 {
1820 dexAndResourceJarsToCombine = append(android.Paths{dexOutputFile}, resourceJars...)
1821 }
1822 } else {
1823 if combinedResourceJar != nil {
1824 dexAndResourceJarsToCombine = android.Paths{dexOutputFile, combinedResourceJar}
1825 }
1826 }
1827 if len(dexAndResourceJarsToCombine) > 0 {
Colin Cross7707b242024-07-26 12:02:36 -07001828 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001829 TransformJarsToJar(ctx, combinedJar, "for dex resources", dexAndResourceJarsToCombine, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001830 false, nil, nil)
1831 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001832 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001833 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001834 dexOutputFile = combinedAlignedJar
1835 } else {
1836 dexOutputFile = combinedJar
1837 }
1838 }
1839
Paul Duffin4de94502021-05-16 05:21:16 +01001840 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001841
1842 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001843
1844 // Encode hidden API flags in dex file, if needed.
1845 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1846
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001847 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001848
1849 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001850 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1851 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1852 libName = strings.TrimSuffix(libName, ".impl")
1853 }
1854 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001855
1856 outputFile = dexOutputFile
Colin Crossa6182ab2024-08-21 10:47:44 -07001857
1858 ctx.CheckbuildFile(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001859 } else {
1860 // There is no code to compile into a dex jar, make sure the resources are propagated
1861 // to the APK if this is an app.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001862 j.dexJarFile = makeDexJarPathFromPath(combinedResourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001863 }
1864
1865 if ctx.Failed() {
1866 return
1867 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001868 }
1869
1870 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001871 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001872 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001873 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001874 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001875 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001876 }
1877 }
1878
1879 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001880 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1881 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001882 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1883 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001884 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001885 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001886 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001887 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001888 j.linter.javaLanguageLevel = flags.javaVersion.String()
1889 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001890 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001891 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1892 j.linter.buildModuleReportZip = true
1893 }
1894 j.linter.lint(ctx)
1895 }
1896
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001897 j.collectTransitiveSrcFiles(ctx, srcFiles)
1898
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001899 if ctx.Config().UseTransitiveJarsInClasspath() {
1900 if len(localImplementationJars) > 0 || len(localResourceJars) > 0 || len(localHeaderJars) > 0 {
1901 ctx.CheckbuildFile(localImplementationJars...)
1902 ctx.CheckbuildFile(localResourceJars...)
1903 ctx.CheckbuildFile(localHeaderJars...)
1904 } else {
1905 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1906 ctx.UncheckedModule()
1907 }
1908 } else {
1909 ctx.CheckbuildFile(j.implementationJarFile)
1910 ctx.CheckbuildFile(j.headerJarFile)
1911 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001912
Colin Cross7727c7f2024-07-18 15:36:32 -07001913 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001914 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1915 RepackagedHeaderJars: android.PathsIfNonNil(repackagedHeaderJarFile),
1916
1917 LocalHeaderJars: localHeaderJars,
1918 TransitiveStaticLibsHeaderJars: android.NewDepSet(android.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
1919 TransitiveStaticLibsImplementationJars: completeStaticLibsImplementationJars,
1920 TransitiveStaticLibsResourceJars: completeStaticLibsResourceJars,
1921
Colin Cross9ffaf282024-08-12 13:50:09 -07001922 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1923 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001924 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1925 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001926 ResourceJars: android.PathsIfNonNil(combinedResourceJar),
Jihoon Kang705e63e2024-03-13 01:21:16 +00001927 AidlIncludeDirs: j.exportAidlIncludeDirs,
1928 SrcJarArgs: j.srcJarArgs,
1929 SrcJarDeps: j.srcJarDeps,
1930 TransitiveSrcFiles: j.transitiveSrcFiles,
1931 ExportedPlugins: j.exportedPluginJars,
1932 ExportedPluginClasses: j.exportedPluginClasses,
1933 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1934 JacocoReportClassesFile: j.jacocoReportClassesFile,
1935 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001936 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001937 })
1938
1939 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1940 j.outputFile = outputFile.WithoutRel()
1941}
1942
Cole Faustb7493472024-08-28 11:55:52 -07001943func (j *Module) useCompose(ctx android.BaseModuleContext) bool {
1944 return android.InList("androidx.compose.runtime_runtime", j.staticLibs(ctx))
Colin Crossa1ff7c62021-09-17 14:11:52 -07001945}
1946
Colin Crosscde55342024-03-27 14:11:51 -07001947func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []*android.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001948 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001949 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001950 depTag := ctx.OtherModuleDependencyTag(m)
1951
1952 if depProguardInfo.UnconditionallyExportedProguardFlags != nil {
1953 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1954 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1955 }
1956
1957 if depTag == staticLibTag && depProguardInfo.ProguardFlagsFiles != nil {
1958 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1959 }
1960 })
1961
Colin Crosscde55342024-03-27 14:11:51 -07001962 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1963}
1964
1965func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1966 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1967
Sam Delmerico95d70942023-08-02 18:00:35 -04001968 directUnconditionalExportedFlags := android.Paths{}
1969 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1970 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1971 if exportUnconditionally {
1972 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1973 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1974 directUnconditionalExportedFlags = proguardFlagsForThisModule
1975 }
1976
1977 return ProguardSpecInfo{
1978 Export_proguard_flags_files: exportUnconditionally,
1979 ProguardFlagsFiles: android.NewDepSet[android.Path](
1980 android.POSTORDER,
1981 proguardFlagsForThisModule,
1982 transitiveProguardFlags,
1983 ),
1984 UnconditionallyExportedProguardFlags: android.NewDepSet[android.Path](
1985 android.POSTORDER,
1986 directUnconditionalExportedFlags,
1987 transitiveUnconditionalExportedFlags,
1988 ),
1989 }
1990
1991}
1992
Cole Faust75fffb12021-06-13 15:23:16 -07001993// Returns a copy of the supplied flags, but with all the errorprone-related
1994// fields copied to the regular build's fields.
1995func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1996 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1997
1998 if len(flags.errorProneExtraJavacFlags) > 0 {
1999 if len(flags.javacFlags) > 0 {
2000 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
2001 } else {
2002 flags.javacFlags = flags.errorProneExtraJavacFlags
2003 }
2004 }
2005 return flags
2006}
2007
Jaewoong Jung26342642021-03-17 15:56:23 -07002008func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07002009 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002010
2011 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00002012 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002013 if idx >= 0 {
2014 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00002015 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002016 jarName += strconv.Itoa(idx)
2017 }
2018
Colin Cross7707b242024-07-26 12:02:36 -07002019 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00002020 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07002021
Cole Faust9decf832024-06-11 11:45:53 -07002022 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002023 extractionFile := android.PathForModuleOut(ctx, kzipName)
2024 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
2025 j.kytheFiles = append(j.kytheFiles, extractionFile)
2026 }
2027
Vadim Spivak3c496f02023-06-08 06:14:59 +00002028 if len(flags.processorPath) > 0 {
2029 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
2030 }
2031
Jaewoong Jung26342642021-03-17 15:56:23 -07002032 return classes
2033}
2034
2035// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
2036// since some of these flags may be used internally.
2037func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
2038 for _, flag := range flags {
2039 flag = strings.TrimSpace(flag)
2040
2041 if !strings.HasPrefix(flag, "-") {
2042 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
2043 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
2044 ctx.PropertyErrorf("kotlincflags",
2045 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
2046 } else if inList(flag, config.KotlincIllegalFlags) {
2047 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
2048 } else if flag == "-include-runtime" {
2049 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
2050 } else {
2051 args := strings.Split(flag, " ")
2052 if args[0] == "-kotlin-home" {
2053 ctx.PropertyErrorf("kotlincflags",
2054 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
2055 }
2056 }
2057 }
2058}
2059
2060func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
2061 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002062 extraJars android.Paths) (localHeaderJars android.Paths, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002063
Jaewoong Jung26342642021-03-17 15:56:23 -07002064 if len(srcFiles) > 0 || len(srcJars) > 0 {
2065 // Compile java sources into turbine.jar.
2066 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
2067 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002068 localHeaderJars = append(localHeaderJars, turbineJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07002069 }
2070
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002071 localHeaderJars = append(localHeaderJars, extraJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002072
2073 // Combine any static header libraries into classes-header.jar. If there is only
2074 // one input jar this step will be skipped.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002075 var jars android.Paths
2076 if ctx.Config().UseTransitiveJarsInClasspath() {
2077 depSet := android.NewDepSet(android.PREORDER, localHeaderJars, deps.transitiveStaticLibsHeaderJars)
2078 jars = depSet.ToList()
2079 } else {
2080 jars = append(slices.Clone(localHeaderJars), deps.staticHeaderJars...)
2081 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002082
2083 // we cannot skip the combine step for now if there is only one jar
2084 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07002085 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
2086 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07002087 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07002088
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002089 return localHeaderJars, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07002090}
2091
2092func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07002093 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002094
2095 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07002096 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07002097
2098 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
2099
2100 j.jacocoReportClassesFile = jacocoReportClassesFile
2101
2102 return instrumentedJar
2103}
2104
Colin Cross9ffaf282024-08-12 13:50:09 -07002105type providesTransitiveHeaderJarsForR8 struct {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002106 // set of header jars for all transitive libs deps
Colin Cross9ffaf282024-08-12 13:50:09 -07002107 transitiveLibsHeaderJarsForR8 *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002108 // set of header jars for all transitive static libs deps
Colin Cross9ffaf282024-08-12 13:50:09 -07002109 transitiveStaticLibsHeaderJarsForR8 *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002110}
2111
Colin Cross9ffaf282024-08-12 13:50:09 -07002112// collectTransitiveHeaderJarsForR8 visits direct dependencies and collects all transitive libs and static_libs
2113// header jars. The semantics of the collected jars are odd (it collects combined jars that contain the static
2114// libs, but also the static libs, and it collects transitive libs dependencies of static_libs), so these
2115// are only used to expand the --lib arguments to R8.
2116func (j *providesTransitiveHeaderJarsForR8) collectTransitiveHeaderJarsForR8(ctx android.ModuleContext) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002117 directLibs := android.Paths{}
2118 directStaticLibs := android.Paths{}
Colin Crossc85750b2022-04-21 12:50:51 -07002119 transitiveLibs := []*android.DepSet[android.Path]{}
2120 transitiveStaticLibs := []*android.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002121 ctx.VisitDirectDeps(func(module android.Module) {
2122 // don't add deps of the prebuilt version of the same library
2123 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
2124 return
2125 }
2126
Colin Cross7727c7f2024-07-18 15:36:32 -07002127 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2128 tag := ctx.OtherModuleDependencyTag(module)
2129 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2130 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2131 directLibs = append(directLibs, dep.HeaderJars...)
2132 } else if tag == staticLibTag {
2133 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2134 } else {
2135 // Don't propagate transitive libs for other kinds of dependencies.
2136 return
2137 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002138
Colin Cross9ffaf282024-08-12 13:50:09 -07002139 if dep.TransitiveLibsHeaderJarsForR8 != nil {
2140 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJarsForR8)
Colin Cross7727c7f2024-07-18 15:36:32 -07002141 }
Colin Cross9ffaf282024-08-12 13:50:09 -07002142 if dep.TransitiveStaticLibsHeaderJarsForR8 != nil {
2143 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJarsForR8)
Colin Cross7727c7f2024-07-18 15:36:32 -07002144 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002145
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002146 }
2147 })
Colin Cross9ffaf282024-08-12 13:50:09 -07002148 j.transitiveLibsHeaderJarsForR8 = android.NewDepSet(android.POSTORDER, directLibs, transitiveLibs)
2149 j.transitiveStaticLibsHeaderJarsForR8 = android.NewDepSet(android.POSTORDER, directStaticLibs, transitiveStaticLibs)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002150}
2151
Jaewoong Jung26342642021-03-17 15:56:23 -07002152func (j *Module) HeaderJars() android.Paths {
2153 if j.headerJarFile == nil {
2154 return nil
2155 }
2156 return android.Paths{j.headerJarFile}
2157}
2158
2159func (j *Module) ImplementationJars() android.Paths {
2160 if j.implementationJarFile == nil {
2161 return nil
2162 }
2163 return android.Paths{j.implementationJarFile}
2164}
2165
Spandan Das59a4a2b2024-01-09 21:35:56 +00002166func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002167 return j.dexJarFile
2168}
2169
2170func (j *Module) DexJarInstallPath() android.Path {
2171 return j.installFile
2172}
2173
2174func (j *Module) ImplementationAndResourcesJars() android.Paths {
2175 if j.implementationAndResourcesJar == nil {
2176 return nil
2177 }
2178 return android.Paths{j.implementationAndResourcesJar}
2179}
2180
2181func (j *Module) AidlIncludeDirs() android.Paths {
2182 // exportAidlIncludeDirs is type android.Paths already
2183 return j.exportAidlIncludeDirs
2184}
2185
2186func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2187 return j.classLoaderContexts
2188}
2189
2190// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002191func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002192 // jarjar rules will repackage the sources. To prevent misleading results, IdeInfo should contain the
2193 // repackaged jar instead of the input sources.
Jaewoong Jung26342642021-03-17 15:56:23 -07002194 if j.expandJarjarRules != nil {
2195 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002196 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
2197 } else {
2198 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2199 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2200 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002201 }
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002202 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2203 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Cole Faustb7493472024-08-28 11:55:52 -07002204 dpInfo.Static_libs = append(dpInfo.Static_libs, j.staticLibs(ctx)...)
Yikef6282022022-04-13 20:41:01 +08002205 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002206}
2207
2208func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002209 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002210}
2211
2212func (j *Module) hasCode(ctx android.ModuleContext) bool {
2213 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2214 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2215}
2216
2217// Implements android.ApexModule
2218func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2219 return j.depIsInSameApex(ctx, dep)
2220}
2221
2222// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002223func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002224 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002225 minSdkVersion := j.MinSdkVersion(ctx)
2226 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002227 return fmt.Errorf("min_sdk_version is not specified")
2228 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002229 // If the module is compiling against core (via sdk_version), skip comparison check.
2230 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002231 return nil
2232 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002233 if minSdkVersion.GreaterThan(sdkVersion) {
2234 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002235 }
2236 return nil
2237}
2238
2239func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002240 if j.stem == "" {
2241 panic("Stem() called before stem property was set")
2242 }
2243 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002244}
2245
Jaewoong Jung26342642021-03-17 15:56:23 -07002246func (j *Module) JacocoReportClassesFile() android.Path {
2247 return j.jacocoReportClassesFile
2248}
2249
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002250func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
2251 var fromDeps []*android.DepSet[android.Path]
2252 ctx.VisitDirectDeps(func(module android.Module) {
2253 tag := ctx.OtherModuleDependencyTag(module)
2254 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002255 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2256 if depInfo.TransitiveSrcFiles != nil {
2257 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
2258 }
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002259 }
2260 }
2261 })
2262
2263 j.transitiveSrcFiles = android.NewDepSet(android.POSTORDER, mine, fromDeps)
2264}
2265
Jaewoong Jung26342642021-03-17 15:56:23 -07002266func (j *Module) IsInstallable() bool {
2267 return Bool(j.properties.Installable)
2268}
2269
2270type sdkLinkType int
2271
2272const (
2273 // TODO(jiyong) rename these for better readability. Make the allowed
2274 // and disallowed link types explicit
2275 // order is important here. See rank()
2276 javaCore sdkLinkType = iota
2277 javaSdk
2278 javaSystem
2279 javaModule
2280 javaSystemServer
2281 javaPlatform
2282)
2283
2284func (lt sdkLinkType) String() string {
2285 switch lt {
2286 case javaCore:
2287 return "core Java API"
2288 case javaSdk:
2289 return "Android API"
2290 case javaSystem:
2291 return "system API"
2292 case javaModule:
2293 return "module API"
2294 case javaSystemServer:
2295 return "system server API"
2296 case javaPlatform:
2297 return "private API"
2298 default:
2299 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2300 }
2301}
2302
2303// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2304// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2305// can't statically depend on modules that use Platform API.
2306func (lt sdkLinkType) rank() int {
2307 return int(lt)
2308}
2309
2310type moduleWithSdkDep interface {
2311 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002312 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002313}
2314
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002315func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2316 switch k {
2317 case android.SdkCore:
2318 return javaCore
2319 case android.SdkSystem:
2320 return javaSystem
2321 case android.SdkPublic:
2322 return javaSdk
2323 case android.SdkModule:
2324 return javaModule
2325 case android.SdkSystemServer:
2326 return javaSystemServer
2327 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2328 return javaPlatform
2329 default:
2330 return javaSdk
2331 }
2332}
2333
Jiyong Park92315372021-04-02 08:45:46 +09002334func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002335 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002336 case android.SdkCore.DefaultJavaLibraryName(),
2337 "legacy.core.platform.api.stubs",
2338 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002339 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002340 "core-lambda-stubs",
Jihoon Kangb5078312023-03-29 23:25:49 +00002341 "core-generated-annotation-stubs":
Jaewoong Jung26342642021-03-17 15:56:23 -07002342 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002343 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002344 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002345 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002346 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002347 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002348 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002349 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002350 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002351 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002352 return javaSystem, true
2353 }
2354
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002355 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002356 return linkType, true
2357 }
2358
Jiyong Park92315372021-04-02 08:45:46 +09002359 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002360 if !ver.Valid() {
2361 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002362 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002363
2364 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002365}
2366
2367// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2368// this module's. See the comment on rank() for details and an example.
2369func (j *Module) checkSdkLinkType(
2370 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2371 if ctx.Host() {
2372 return
2373 }
2374
Jiyong Park92315372021-04-02 08:45:46 +09002375 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002376 if stubs {
2377 return
2378 }
Jiyong Park92315372021-04-02 08:45:46 +09002379 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002380
2381 if myLinkType.rank() < depLinkType.rank() {
2382 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2383 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2384 "property of the source or target module so that target module is built "+
2385 "with the same or smaller API set when compared to the source.",
2386 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2387 }
2388}
2389
2390func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2391 var deps deps
2392
Jiyong Park92315372021-04-02 08:45:46 +09002393 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002394
Colin Cross9ffaf282024-08-12 13:50:09 -07002395 j.collectTransitiveHeaderJarsForR8(ctx)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002396
2397 var transitiveBootClasspathHeaderJars []*android.DepSet[android.Path]
2398 var transitiveClasspathHeaderJars []*android.DepSet[android.Path]
2399 var transitiveJava9ClasspathHeaderJars []*android.DepSet[android.Path]
2400 var transitiveStaticJarsHeaderLibs []*android.DepSet[android.Path]
2401 var transitiveStaticJarsImplementationLibs []*android.DepSet[android.Path]
2402 var transitiveStaticJarsResourceLibs []*android.DepSet[android.Path]
2403
Jaewoong Jung26342642021-03-17 15:56:23 -07002404 ctx.VisitDirectDeps(func(module android.Module) {
2405 otherName := ctx.OtherModuleName(module)
2406 tag := ctx.OtherModuleDependencyTag(module)
2407
2408 if IsJniDepTag(tag) {
2409 // Handled by AndroidApp.collectAppDeps
2410 return
2411 }
2412 if tag == certificateTag {
2413 // Handled by AndroidApp.collectAppDeps
2414 return
2415 }
2416
2417 if dep, ok := module.(SdkLibraryDependency); ok {
2418 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002419 case sdkLibTag, libTag:
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002420 depHeaderJars := dep.SdkHeaderJars(ctx, j.SdkVersion(ctx))
2421 deps.classpath = append(deps.classpath, depHeaderJars...)
2422 deps.dexClasspath = append(deps.dexClasspath, depHeaderJars...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002423
2424 // TODO: SDK libraries should export a provider with TransitiveClasspathHeaderJars
2425 depHeaderJarsSet := android.NewDepSet(android.PREORDER, depHeaderJars, nil)
2426 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJarsSet)
Jaewoong Jung26342642021-03-17 15:56:23 -07002427 case staticLibTag:
2428 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
2429 }
Colin Cross313aa542023-12-13 13:47:44 -08002430 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2431 if sdkLinkType != javaPlatform {
2432 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2433 // dep is a sysprop implementation library, but this module is not linking against
2434 // the platform, so it gets the sysprop public stubs library instead. Replace
2435 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2436 dep = syspropDep.JavaInfo
2437 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002438 }
2439 switch tag {
2440 case bootClasspathTag:
2441 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002442 if dep.TransitiveStaticLibsHeaderJars != nil {
2443 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2444 }
Liz Kammeref28a4c2022-09-23 16:50:56 -04002445 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002446 if _, ok := module.(*Plugin); ok {
2447 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2448 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002449 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002450 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002451 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2452 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2453 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2454 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002455 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2456 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2457 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002458
2459 if dep.TransitiveStaticLibsHeaderJars != nil {
2460 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2461 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002462 case java9LibTag:
2463 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002464 if dep.TransitiveStaticLibsHeaderJars != nil {
2465 transitiveJava9ClasspathHeaderJars = append(transitiveJava9ClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2466 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002467 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002468 if _, ok := module.(*Plugin); ok {
2469 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2470 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002471 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2472 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2473 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2474 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2475 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2476 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
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 || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002481 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002482
2483 if dep.TransitiveStaticLibsHeaderJars != nil {
2484 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2485 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, dep.TransitiveStaticLibsHeaderJars)
2486 }
2487 if dep.TransitiveStaticLibsImplementationJars != nil {
2488 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, dep.TransitiveStaticLibsImplementationJars)
2489 }
2490 if dep.TransitiveStaticLibsResourceJars != nil {
2491 transitiveStaticJarsResourceLibs = append(transitiveStaticJarsResourceLibs, dep.TransitiveStaticLibsResourceJars)
2492 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002493 case pluginTag:
2494 if plugin, ok := module.(*Plugin); ok {
2495 if plugin.pluginProperties.Processor_class != nil {
2496 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2497 } else {
2498 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2499 }
2500 // Turbine doesn't run annotation processors, so any module that uses an
2501 // annotation processor that generates API is incompatible with the turbine
2502 // optimization.
2503 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2504 } else {
2505 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2506 }
2507 case errorpronePluginTag:
2508 if _, ok := module.(*Plugin); ok {
2509 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2510 } else {
2511 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2512 }
2513 case exportedPluginTag:
2514 if plugin, ok := module.(*Plugin); ok {
2515 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2516 if plugin.pluginProperties.Processor_class != nil {
2517 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2518 }
2519 // Turbine doesn't run annotation processors, so any module that uses an
2520 // annotation processor that generates API is incompatible with the turbine
2521 // optimization.
2522 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2523 } else {
2524 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2525 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002526 case kotlinPluginTag:
2527 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002528 case syspropPublicStubDepTag:
2529 // This is a sysprop implementation library, forward the JavaInfoProvider from
2530 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002531 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002532 JavaInfo: dep,
2533 })
2534 }
2535 } else if dep, ok := module.(android.SourceFileProducer); ok {
2536 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002537 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002538 checkProducesJars(ctx, dep)
2539 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002540 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002541 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars,
2542 android.NewDepSet(android.PREORDER, dep.Srcs(), nil))
Jaewoong Jung26342642021-03-17 15:56:23 -07002543 case staticLibTag:
2544 checkProducesJars(ctx, dep)
2545 deps.classpath = append(deps.classpath, dep.Srcs()...)
2546 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2547 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002548
2549 depHeaderJars := android.NewDepSet(android.PREORDER, dep.Srcs(), nil)
2550 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJars)
2551 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, depHeaderJars)
2552 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, depHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002553 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002554 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002555 switch tag {
2556 case staticLibTag:
2557 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2558 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002559 } else {
2560 switch tag {
2561 case bootClasspathTag:
2562 // If a system modules dependency has been added to the bootclasspath
2563 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002564 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002565 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars...)
2566 if sm.TransitiveStaticLibsHeaderJars != nil {
2567 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars,
2568 sm.TransitiveStaticLibsHeaderJars)
2569 }
Colin Crossb61c2262024-08-08 14:04:42 -07002570 } else {
2571 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2572 ctx.OtherModuleName(module))
2573 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002574
2575 case systemModulesTag:
2576 if deps.systemModules != nil {
2577 panic("Found two system module dependencies")
2578 }
Colin Crossb61c2262024-08-08 14:04:42 -07002579 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2580 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2581 } else {
2582 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2583 ctx.OtherModuleName(module))
2584 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002585
2586 case instrumentationForTag:
2587 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 -07002588 }
2589 }
2590
Spandan Das8aac9932024-07-18 23:14:13 +00002591 if android.InList(tag, compileDependencyTags) {
2592 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2593 j.compileDepNames = append(j.compileDepNames, otherName)
2594 }
2595
Jaewoong Jung26342642021-03-17 15:56:23 -07002596 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002597 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002598 })
2599
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002600 deps.transitiveStaticLibsHeaderJars = transitiveStaticJarsHeaderLibs
2601 deps.transitiveStaticLibsImplementationJars = transitiveStaticJarsImplementationLibs
2602 deps.transitiveStaticLibsResourceJars = transitiveStaticJarsResourceLibs
2603
2604 if ctx.Config().UseTransitiveJarsInClasspath() {
2605 depSet := android.NewDepSet(android.PREORDER, nil, transitiveClasspathHeaderJars)
2606 deps.classpath = depSet.ToList()
2607 depSet = android.NewDepSet(android.PREORDER, nil, transitiveBootClasspathHeaderJars)
2608 deps.bootClasspath = depSet.ToList()
2609 depSet = android.NewDepSet(android.PREORDER, nil, transitiveJava9ClasspathHeaderJars)
2610 deps.java9Classpath = depSet.ToList()
2611 }
2612
2613 if ctx.Device() {
2614 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
2615 if sdkDep.invalidVersion {
2616 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2617 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2618 } else if sdkDep.useFiles {
2619 // sdkDep.jar is actually equivalent to turbine header.jar.
2620 deps.classpath = append(slices.Clone(classpath(sdkDep.jars)), deps.classpath...)
2621 deps.dexClasspath = append(slices.Clone(classpath(sdkDep.jars)), deps.dexClasspath...)
2622 deps.aidlPreprocess = sdkDep.aidl
2623 // Add the sdk module dependency to `compileDepNames`.
2624 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2625 // TODO (b/358608607): Move this to decodeSdkDep
2626 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2627 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
2628 } else {
2629 deps.aidlPreprocess = sdkDep.aidl
2630 }
2631 }
2632
Jaewoong Jung26342642021-03-17 15:56:23 -07002633 return deps
2634}
2635
Joe Onorato349ae8d2024-02-05 22:46:00 +00002636// Provider for jarjar renaming rules.
2637//
2638// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2639// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2640// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2641// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2642// be renamed from that module.
2643// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002644type DependencyUse int
2645
2646const (
2647 RenameUseInvalid DependencyUse = iota
2648 RenameUseInclude
2649 RenameUseExclude
2650)
2651
2652type RenameUseElement struct {
2653 DepName string
2654 RenameUse DependencyUse
2655 Why string // token for determining where in the logic the decision was made.
2656}
2657
Joe Onorato349ae8d2024-02-05 22:46:00 +00002658type JarJarProviderData struct {
2659 // Mapping of class names: original --> renamed. If the value is "", the class will be
2660 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2661 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002662 Rename map[string]string
2663 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002664}
2665
2666func (this JarJarProviderData) GetDebugString() string {
2667 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002668 for _, k := range android.SortedKeys(this.Rename) {
2669 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002670 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2671 result += k + "--&gt;" + v + ";"
2672 }
2673 }
2674 return result
2675}
2676
2677var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2678
2679var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2680
2681func init() {
2682 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
Yu Liu26a716d2024-08-30 23:40:32 +00002683
2684 gob.Register(BaseJarJarProviderData{})
Joe Onorato349ae8d2024-02-05 22:46:00 +00002685}
2686
2687// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2688// whether they are java modules or not.
2689type BaseJarJarProviderData struct {
2690 JarJarProviderData JarJarProviderData
2691}
2692
2693func (this BaseJarJarProviderData) GetDebugString() string {
2694 return this.JarJarProviderData.GetDebugString()
2695}
2696
2697var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2698
2699// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2700// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2701// either JarJarProvider or BaseJarJarProvider.
2702func mergeJarJarPrefixes(ctx android.ModuleContext) {
2703 mod := ctx.Module()
2704 // Explicitly avoid propagating into some module types.
2705 switch reflect.TypeOf(mod).String() {
2706 case "*java.Droidstubs":
2707 return
2708 }
2709 jarJarData := collectDirectDepsProviders(ctx)
2710 if jarJarData != nil {
2711 providerData := BaseJarJarProviderData{
2712 JarJarProviderData: *jarJarData,
2713 }
2714 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2715 }
2716
2717}
2718
2719// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2720func (module *Module) addJarJarRenameRule(original string, renamed string) {
2721 if module.jarjarRenameRules == nil {
2722 module.jarjarRenameRules = make(map[string]string)
2723 }
2724 module.jarjarRenameRules[original] = renamed
2725}
2726
2727func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2728 // Gather repackage information from deps
2729 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002730
2731 module := ctx.Module()
2732 moduleName := module.Name()
2733
Joe Onorato349ae8d2024-02-05 22:46:00 +00002734 ctx.VisitDirectDepsIgnoreBlueprint(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002735 tag := ctx.OtherModuleDependencyTag(m)
2736 // This logic mirrors that in (*Module).collectDeps above. There are several places
2737 // where we explicitly return RenameUseExclude, even though it is the default, to
2738 // indicate that it has been verified to be the case.
2739 //
2740 // Note well: there are probably cases that are getting to the unconditional return
2741 // and are therefore wrong.
2742 shouldIncludeRenames := func() (DependencyUse, string) {
2743 if moduleName == m.Name() {
2744 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2745 }
2746 if sc, ok := module.(android.SdkContext); ok {
2747 if ctx.Device() {
2748 sdkDep := decodeSdkDep(ctx, sc)
2749 if !sdkDep.invalidVersion && sdkDep.useFiles {
2750 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002751 }
2752 }
LaMont Jones63683e42024-02-08 14:30:45 -08002753 }
2754 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2755 return RenameUseExclude, "tags"
2756 }
2757 if _, ok := m.(SdkLibraryDependency); ok {
2758 switch tag {
2759 case sdkLibTag, libTag:
2760 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2761 }
2762 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2763 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2764 switch ji.StubsLinkType {
2765 case Stubs:
2766 return RenameUseExclude, "info"
2767 case Implementation:
2768 return RenameUseInclude, "info"
2769 default:
LaMont Jones09721862024-06-11 10:30:50 -07002770 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002771 // Fall through to the heuristic logic.
2772 }
2773 switch reflect.TypeOf(m).String() {
2774 case "*java.GeneratedJavaLibraryModule":
2775 // Probably a java_aconfig_library module.
2776 // TODO: make this check better.
2777 return RenameUseInclude, "reflect"
2778 }
2779 switch tag {
2780 case bootClasspathTag:
2781 return RenameUseExclude, "tagswitch"
2782 case sdkLibTag, libTag, instrumentationForTag:
2783 return RenameUseInclude, "tagswitch"
2784 case java9LibTag:
2785 return RenameUseExclude, "tagswitch"
2786 case staticLibTag:
2787 return RenameUseInclude, "tagswitch"
2788 case pluginTag:
2789 return RenameUseInclude, "tagswitch"
2790 case errorpronePluginTag:
2791 return RenameUseInclude, "tagswitch"
2792 case exportedPluginTag:
2793 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002794 case kotlinPluginTag:
2795 return RenameUseInclude, "tagswitch"
2796 default:
2797 return RenameUseExclude, "tagswitch"
2798 }
2799 } else if _, ok := m.(android.SourceFileProducer); ok {
2800 switch tag {
2801 case sdkLibTag, libTag, staticLibTag:
2802 return RenameUseInclude, "srcfile"
2803 default:
2804 return RenameUseExclude, "srcfile"
2805 }
Yu Liu67a28422024-03-05 00:36:31 +00002806 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002807 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002808 } else {
2809 switch tag {
2810 case bootClasspathTag:
2811 return RenameUseExclude, "else"
2812 case systemModulesTag:
2813 return RenameUseInclude, "else"
2814 }
2815 }
2816 // If we got here, choose the safer option, which may lead to a build failure, rather
2817 // than runtime failures on the device.
2818 return RenameUseExclude, "end"
2819 }
2820
2821 if result == nil {
2822 result = &JarJarProviderData{
2823 Rename: make(map[string]string),
2824 RenameUse: make([]RenameUseElement, 0),
2825 }
2826 }
2827 how, why := shouldIncludeRenames()
2828 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2829 if how != RenameUseInclude {
2830 // Nothing to merge.
2831 return
2832 }
2833
2834 merge := func(theirs *JarJarProviderData) {
2835 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002836 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2837 result.Rename[orig] = renamed
2838 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2839 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2840 result.Rename[orig] = renamed
2841 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2842 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2843 continue
2844 }
2845 }
2846 }
2847 }
2848 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2849 merge(&theirs)
2850 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2851 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2852 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2853 // to java.Module.
2854 merge(&theirs.JarJarProviderData)
2855 }
2856 })
2857 return
2858}
2859
2860func (this Module) GetDebugString() string {
2861 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2862}
2863
2864// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2865// us, and if it's been set, apply the jarjar_prefix property to rename them.
2866func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2867 // Gather repackage information from deps
2868 result := collectDirectDepsProviders(ctx)
2869
Joe Onoratoa5d17172024-07-20 17:39:56 -07002870 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002871 if result == nil {
2872 result = &JarJarProviderData{
2873 Rename: make(map[string]string),
2874 }
2875 }
2876 if renamed != "" {
2877 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2878 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002879 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002880 }
2881 }
2882 (*result).Rename[orig] = renamed
2883 }
2884
Joe Onoratoa5d17172024-07-20 17:39:56 -07002885 // Update that with entries we've stored for ourself
2886 for orig, renamed := range module.jarjarRenameRules {
2887 add(orig, renamed)
2888 }
2889
2890 // Update that with entries given in the jarjar_rename property.
2891 for _, orig := range module.properties.Jarjar_rename {
2892 add(orig, "")
2893 }
2894
Joe Onorato349ae8d2024-02-05 22:46:00 +00002895 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2896 if result == nil {
2897 return nil
2898 }
2899
2900 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2901 // that have not yet been renamed.
2902 prefix := proptools.String(module.properties.Jarjar_prefix)
2903 if prefix != "" {
2904 if prefix[0] == '.' {
2905 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2906 return nil
2907 }
2908 if prefix[len(prefix)-1] == '.' {
2909 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2910 return nil
2911 }
2912
2913 var updated map[string]string
2914 for orig, renamed := range (*result).Rename {
2915 if renamed == "" {
2916 if updated == nil {
2917 updated = make(map[string]string)
2918 }
2919 updated[orig] = prefix + "." + orig
2920 }
2921 }
2922 for orig, renamed := range updated {
2923 (*result).Rename[orig] = renamed
2924 }
2925 }
2926
2927 return result
2928}
2929
2930// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2931// to "" won't be in this list because they shouldn't be renamed yet.
2932func getJarJarRuleText(provider *JarJarProviderData) string {
2933 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002934 for _, orig := range android.SortedKeys(provider.Rename) {
2935 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002936 if renamed != "" {
2937 result += "rule " + orig + " " + renamed + "\n"
2938 }
2939 }
2940 return result
2941}
2942
Zi Wangddb2ee52024-04-02 16:44:02 +00002943// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002944func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Zi Wangddb2ee52024-04-02 16:44:02 +00002945 if j.repackageJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002946 return infile, false
Zi Wangddb2ee52024-04-02 16:44:02 +00002947 }
Colin Crossedec77c2024-07-26 15:25:40 -07002948 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002949 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002950 return repackagedJarjarFile, true
Zi Wangddb2ee52024-04-02 16:44:02 +00002951}
2952
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002953func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Colin Crossedec77c2024-07-26 15:25:40 -07002954 if j.expandJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002955 return infile, false
Colin Crossedec77c2024-07-26 15:25:40 -07002956 }
2957 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2958 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002959 return jarjarFile, true
Colin Crossedec77c2024-07-26 15:25:40 -07002960
2961}
2962
Jaewoong Jung26342642021-03-17 15:56:23 -07002963func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2964 deps.processorPath = append(deps.processorPath, pluginJars...)
2965 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2966}
2967
2968// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2969// this interface.
2970type ProvidesUsesLib interface {
2971 ProvidesUsesLib() *string
2972}
2973
2974func (j *Module) ProvidesUsesLib() *string {
2975 return j.usesLibraryProperties.Provides_uses_lib
2976}
satayev1c564cc2021-05-25 19:50:30 +01002977
2978type ModuleWithStem interface {
2979 Stem() string
2980}
2981
2982var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002983
2984type ModuleWithUsesLibrary interface {
2985 UsesLibrary() *usesLibrary
2986}
2987
2988func (j *Module) UsesLibrary() *usesLibrary {
2989 return &j.usesLibrary
2990}
2991
2992var _ ModuleWithUsesLibrary = (*Module)(nil)