blob: 71be239925fda6f4aca6d974ed60269af6a7b2ba [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
84 Static_libs []string `android:"arch_variant"`
85
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
Zi Wang9bdd4222024-02-26 18:21:01 -0800102 // if set to true, skip the jarjar repackaging
103 Skip_jarjar_repackage *bool
104
Jaewoong Jung26342642021-03-17 15:56:23 -0700105 // If not blank, set the java version passed to javac as -source and -target
106 Java_version *string
107
108 // If set to true, allow this module to be dexed and installed on devices. Has no
109 // effect on host modules, which are always considered installable.
110 Installable *bool
111
112 // If set to true, include sources used to compile the module in to the final jar
113 Include_srcs *bool
114
115 // If not empty, classes are restricted to the specified packages and their sub-packages.
116 // This restriction is checked after applying jarjar rules and including static libs.
117 Permitted_packages []string
118
119 // List of modules to use as annotation processors
120 Plugins []string
121
122 // List of modules to export to libraries that directly depend on this library as annotation
123 // processors. Note that if the plugins set generates_api: true this will disable the turbine
124 // optimization on modules that depend on this module, which will reduce parallelism and cause
125 // more recompilation.
126 Exported_plugins []string
127
128 // The number of Java source entries each Javac instance can process
129 Javac_shard_size *int64
130
131 // Add host jdk tools.jar to bootclasspath
132 Use_tools_jar *bool
133
134 Openjdk9 struct {
135 // List of source files that should only be used when passing -source 1.9 or higher
136 Srcs []string `android:"path"`
137
138 // List of javac flags that should only be used when passing -source 1.9 or higher
139 Javacflags []string
140 }
141
142 // When compiling language level 9+ .java code in packages that are part of
143 // a system module, patch_module names the module that your sources and
144 // dependencies should be patched into. The Android runtime currently
145 // doesn't implement the JEP 261 module system so this option is only
146 // supported at compile time. It should only be needed to compile tests in
147 // packages that exist in libcore and which are inconvenient to move
148 // elsewhere.
Liz Kammer0a470a32023-10-05 17:02:00 -0400149 Patch_module *string
Jaewoong Jung26342642021-03-17 15:56:23 -0700150
151 Jacoco struct {
152 // List of classes to include for instrumentation with jacoco to collect coverage
153 // information at runtime when building with coverage enabled. If unset defaults to all
154 // classes.
155 // Supports '*' as the last character of an entry in the list as a wildcard match.
156 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
157 // it matches classes in the package that have the class name as a prefix.
158 Include_filter []string
159
160 // List of classes to exclude from instrumentation with jacoco to collect coverage
161 // information at runtime when building with coverage enabled. Overrides classes selected
162 // by the include_filter property.
163 // Supports '*' as the last character of an entry in the list as a wildcard match.
164 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
165 // it matches classes in the package that have the class name as a prefix.
166 Exclude_filter []string
167 }
168
169 Errorprone struct {
170 // List of javac flags that should only be used when running errorprone.
171 Javacflags []string
172
173 // List of java_plugin modules that provide extra errorprone checks.
174 Extra_check_modules []string
Cole Faust75fffb12021-06-13 15:23:16 -0700175
Cole Faust2b1536e2021-06-18 12:25:54 -0700176 // This property can be in 3 states. When set to true, errorprone will
177 // be run during the regular build. When set to false, errorprone will
178 // never be run. When unset, errorprone will be run when the RUN_ERROR_PRONE
179 // environment variable is true. Setting this to false will improve build
180 // performance more than adding -XepDisableAllChecks in javacflags.
Cole Faust75fffb12021-06-13 15:23:16 -0700181 Enabled *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700182 }
183
184 Proto struct {
185 // List of extra options that will be passed to the proto generator.
186 Output_params []string
187 }
188
Sam Delmericoc7593722022-08-31 15:57:52 -0400189 // If true, then jacocoagent is automatically added as a libs dependency so that
190 // r8 will not strip instrumentation classes out of dexed libraries.
Jaewoong Jung26342642021-03-17 15:56:23 -0700191 Instrument bool `blueprint:"mutated"`
Paul Duffin0038a8d2022-05-03 00:28:40 +0000192 // If true, then the module supports statically including the jacocoagent
193 // into the library.
194 Supports_static_instrumentation bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700195
196 // List of files to include in the META-INF/services folder of the resulting jar.
197 Services []string `android:"path,arch_variant"`
198
199 // If true, package the kotlin stdlib into the jar. Defaults to true.
200 Static_kotlin_stdlib *bool `android:"arch_variant"`
201
202 // A list of java_library instances that provide additional hiddenapi annotations for the library.
203 Hiddenapi_additional_annotations []string
Joe Onorato175073c2023-06-01 14:42:59 -0700204
205 // Additional srcJars tacked in by GeneratedJavaLibraryModule
206 Generated_srcjars []android.Path `android:"mutated"`
Mark Whitea15790a2023-08-22 21:28:11 +0000207
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000208 // intermediate aconfig cache file tacked in by GeneratedJavaLibraryModule
209 Aconfig_Cache_files []android.Path `android:"mutated"`
210
Mark Whitea15790a2023-08-22 21:28:11 +0000211 // If true, then only the headers are built and not the implementation jar.
Liz Kammer60772632023-10-05 17:18:44 -0400212 Headers_only *bool
Cole Faust2b64af82023-12-13 18:22:18 -0800213
214 // A list of files or dependencies to make available to the build sandbox. This is
215 // useful if source files are symlinks, the targets of the symlinks must be listed here.
216 // Note that currently not all actions implemented by android_apps are sandboxed, so you
217 // may only see this being necessary in lint builds.
218 Compile_data []string `android:"path"`
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000219
220 // Property signifying whether the module compiles stubs or not.
221 // Should be set to true when srcs of this module are stub files.
222 // This property does not need to be set to true when the module depends on
223 // the stubs via libs, but should be set to true when the module depends on
224 // the stubs via static libs.
225 Is_stubs_module *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700226
227 // If true, enable the "Ravenizer" tool on the output jar.
228 // "Ravenizer" is a tool for Ravenwood tests, but it can also be enabled on other kinds
229 // of java targets.
230 Ravenizer struct {
231 Enabled *bool
232 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +0000233
234 // Contributing api surface of the stub module. Is not visible to bp modules, and should
235 // only be set for stub submodules generated by the java_sdk_library
236 Stub_contributing_api *string `blueprint:"mutated"`
Yihan Dong8be09c22024-08-29 15:32:13 +0800237
238 // If true, enable the "ApiMapper" tool on the output jar. "ApiMapper" is a tool to inject
239 // bytecode to log API calls.
240 ApiMapper bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700241}
242
243// Properties that are specific to device modules. Host module factories should not add these when
244// constructing a new module.
245type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000246 // If not blank, set to the version of the sdk to compile against.
Spandan Das1ccf5742022-10-14 16:51:23 +0000247 // Defaults to an empty string, which compiles the module against the private platform APIs.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000248 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000249 // 1) numerical API level, "current", "none", or "core_platform"
250 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
251 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
252 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700253 Sdk_version *string
254
satayev0a420e72021-11-29 17:25:52 +0000255 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
256 // Defaults to empty string "". See sdk_version for possible values.
257 Max_sdk_version *string
258
William Loh5a082f92022-05-17 20:21:50 +0000259 // if not blank, set the maxSdkVersion properties of permission and uses-permission tags.
260 // Defaults to empty string "". See sdk_version for possible values.
261 Replace_max_sdk_version_placeholder *string
262
Jaewoong Jung26342642021-03-17 15:56:23 -0700263 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000264 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700265 Target_sdk_version *string
266
267 // Whether to compile against the platform APIs instead of an SDK.
268 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000269 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700270 Platform_apis *bool
271
272 Aidl struct {
273 // Top level directories to pass to aidl tool
274 Include_dirs []string
275
276 // Directories rooted at the Android.bp file to pass to aidl tool
277 Local_include_dirs []string
278
279 // directories that should be added as include directories for any aidl sources of modules
280 // that depend on this module, as well as to aidl for this module.
281 Export_include_dirs []string
282
283 // whether to generate traces (for systrace) for this interface
284 Generate_traces *bool
285
286 // whether to generate Binder#GetTransaction name method.
287 Generate_get_transaction_name *bool
288
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100289 // whether all interfaces should be annotated with required permissions.
290 Enforce_permissions *bool
291
292 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
293 Enforce_permissions_exceptions []string `android:"path"`
294
Jaewoong Jung26342642021-03-17 15:56:23 -0700295 // list of flags that will be passed to the AIDL compiler
296 Flags []string
297 }
298
299 // If true, export a copy of the module as a -hostdex module for host testing.
300 Hostdex *bool
301
302 Target struct {
303 Hostdex struct {
304 // Additional required dependencies to add to -hostdex modules.
305 Required []string
306 }
307 }
308
309 // When targeting 1.9 and above, override the modules to use with --system,
310 // otherwise provides defaults libraries to add to the bootclasspath.
311 System_modules *string
312
Jaewoong Jung26342642021-03-17 15:56:23 -0700313 IsSDKLibrary bool `blueprint:"mutated"`
314
315 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
316 // Defaults to false.
317 V4_signature *bool
318
319 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
320 // public stubs library.
321 SyspropPublicStub string `blueprint:"mutated"`
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000322
323 HiddenAPIPackageProperties
324 HiddenAPIFlagFileProperties
Jaewoong Jung26342642021-03-17 15:56:23 -0700325}
326
yangbill2af0b6e2024-03-15 09:29:29 +0000327// Properties that can be overridden by overriding module (e.g. override_android_app)
328type OverridableProperties struct {
Jooyung Han01d80d82022-01-08 12:16:32 +0900329 // set the name of the output. If not set, `name` is used.
330 // To override a module with this property set, overriding module might need to set this as well.
331 // Otherwise, both the overridden and the overriding modules will have the same output name, which
332 // can cause the duplicate output error.
333 Stem *string
Spandan Dasb9c58352024-05-13 18:29:45 +0000334
335 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
336 // Defaults to sdk_version if not set. See sdk_version for possible values.
337 Min_sdk_version *string
Jooyung Han01d80d82022-01-08 12:16:32 +0900338}
339
Jaewoong Jung26342642021-03-17 15:56:23 -0700340// Functionality common to Module and Import
341//
342// It is embedded in Module so its functionality can be used by methods in Module
343// but it is currently only initialized by Import and Library.
344type embeddableInModuleAndImport struct {
345
346 // Functionality related to this being used as a component of a java_sdk_library.
347 EmbeddableSdkLibraryComponent
348}
349
Paul Duffin71b33cc2021-06-23 11:39:47 +0100350func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
351 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700352}
353
354// Module/Import's DepIsInSameApex(...) delegates to this method.
355//
356// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
357// the one provided by ApexModuleBase.
358func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
359 // dependencies other than the static linkage are all considered crossing APEX boundary
360 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
361 return true
362 }
363 return false
364}
365
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100366// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
367// or an invalid path describing the reason it is invalid.
368//
369// It is unset if a dex jar isn't applicable, i.e. no build rule has been
370// requested to create one.
371//
372// If a dex jar has been requested to be built then it is set, and it may be
373// either a valid android.Path, or invalid with a reason message. The latter
374// happens if the source that should produce the dex file isn't able to.
375//
376// E.g. it is invalid with a reason message if there is a prebuilt APEX that
377// could produce the dex jar through a deapexer module, but the APEX isn't
378// installable so doing so wouldn't be safe.
379type OptionalDexJarPath struct {
380 isSet bool
381 path android.OptionalPath
382}
383
384// IsSet returns true if a path has been set, either invalid or valid.
385func (o OptionalDexJarPath) IsSet() bool {
386 return o.isSet
387}
388
389// Valid returns true if there is a path that is valid.
390func (o OptionalDexJarPath) Valid() bool {
391 return o.isSet && o.path.Valid()
392}
393
394// Path returns the valid path, or panics if it's either not set or is invalid.
395func (o OptionalDexJarPath) Path() android.Path {
396 if !o.isSet {
397 panic("path isn't set")
398 }
399 return o.path.Path()
400}
401
402// PathOrNil returns the path if it's set and valid, or else nil.
403func (o OptionalDexJarPath) PathOrNil() android.Path {
404 if o.Valid() {
405 return o.Path()
406 }
407 return nil
408}
409
410// InvalidReason returns the reason for an invalid path, which is never "". It
411// returns "" for an unset or valid path.
412func (o OptionalDexJarPath) InvalidReason() string {
413 if !o.isSet {
414 return ""
415 }
416 return o.path.InvalidReason()
417}
418
419func (o OptionalDexJarPath) String() string {
420 if !o.isSet {
421 return "<unset>"
422 }
423 return o.path.String()
424}
425
426// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
427func makeUnsetDexJarPath() OptionalDexJarPath {
428 return OptionalDexJarPath{isSet: false}
429}
430
431// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
432// the given OptionalPath, which may be valid or invalid.
433func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
434 return OptionalDexJarPath{isSet: true, path: path}
435}
436
437// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
438// valid given path. It returns an unset OptionalDexJarPath if the given path is
439// nil.
440func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
441 if path == nil {
442 return makeUnsetDexJarPath()
443 }
444 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
445}
446
Jaewoong Jung26342642021-03-17 15:56:23 -0700447// Module contains the properties and members used by all java module types
448type Module struct {
449 android.ModuleBase
450 android.DefaultableModuleBase
451 android.ApexModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700452
453 // Functionality common to Module and Import.
454 embeddableInModuleAndImport
455
456 properties CommonProperties
457 protoProperties android.ProtoProperties
458 deviceProperties DeviceProperties
459
yangbill2af0b6e2024-03-15 09:29:29 +0000460 overridableProperties OverridableProperties
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700461 sourceProperties android.SourceProperties
Jooyung Han01d80d82022-01-08 12:16:32 +0900462
Jaewoong Jung26342642021-03-17 15:56:23 -0700463 // jar file containing header classes including static library dependencies, suitable for
464 // inserting into the bootclasspath/classpath of another compile
465 headerJarFile android.Path
466
467 // jar file containing implementation classes including static library dependencies but no
468 // resources
469 implementationJarFile android.Path
470
Jaewoong Jung26342642021-03-17 15:56:23 -0700471 // args and dependencies to package source files into a srcjar
472 srcJarArgs []string
473 srcJarDeps android.Paths
474
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000475 // the source files of this module and all its static dependencies
476 transitiveSrcFiles *android.DepSet[android.Path]
477
Jaewoong Jung26342642021-03-17 15:56:23 -0700478 // jar file containing implementation classes and resources including static library
479 // dependencies
480 implementationAndResourcesJar android.Path
481
482 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100483 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700484
485 // output file containing uninstrumented classes that will be instrumented by jacoco
486 jacocoReportClassesFile android.Path
487
488 // output file of the module, which may be a classes jar or a dex jar
489 outputFile android.Path
490 extraOutputFiles android.Paths
491
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100492 exportAidlIncludeDirs android.Paths
493 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700494
495 logtagsSrcs android.Paths
496
497 // installed file for binary dependency
498 installFile android.Path
499
Colin Cross3108ce12021-11-10 14:38:50 -0800500 // installed file for hostdex copy
501 hostdexInstallFile android.InstallPath
502
Chaohui Wangdcbe33c2022-10-11 11:13:30 +0800503 // list of unique .java and .kt source files
504 uniqueSrcFiles android.Paths
505
506 // list of srcjars that was passed to javac
507 compiledSrcJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700508
509 // manifest file to use instead of properties.Manifest
510 overrideManifest android.OptionalPath
511
Jaewoong Jung26342642021-03-17 15:56:23 -0700512 // list of plugins that this java module is exporting
513 exportedPluginJars android.Paths
514
515 // list of plugins that this java module is exporting
516 exportedPluginClasses []string
517
518 // if true, the exported plugins generate API and require disabling turbine.
519 exportedDisableTurbine bool
520
521 // list of source files, collected from srcFiles with unique java and all kt files,
522 // will be used by android.IDEInfo struct
523 expandIDEInfoCompiledSrcs []string
524
525 // expanded Jarjar_rules
526 expandJarjarRules android.Path
527
Joe Onorato349ae8d2024-02-05 22:46:00 +0000528 // jarjar rule for inherited jarjar rules
529 repackageJarjarRules android.Path
530
Jaewoong Jung26342642021-03-17 15:56:23 -0700531 // Extra files generated by the module type to be added as java resources.
532 extraResources android.Paths
533
534 hiddenAPI
535 dexer
536 dexpreopter
537 usesLibrary
538 linter
539
540 // list of the xref extraction files
541 kytheFiles android.Paths
542
Jaewoong Jung26342642021-03-17 15:56:23 -0700543 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900544
545 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000546 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000547 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400548
549 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000550
551 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000552
553 // output file name based on Stem property.
554 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
555 // or the module should override Stem().
556 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700557
Joe Onorato349ae8d2024-02-05 22:46:00 +0000558 // Values that will be set in the JarJarProvider data for jarjar repackaging,
559 // and merged with our dependencies' rules.
560 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000561
562 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000563
564 // Paths to the aconfig intermediate cache files that are provided by the
565 // java_aconfig_library or java_library modules that are statically linked
566 // to this module. Does not contain cache files from all transitive dependencies.
567 aconfigCacheFiles android.Paths
Spandan Das8aac9932024-07-18 23:14:13 +0000568
569 // List of soong module dependencies required to compile the current module.
570 // This information is printed out to `Dependencies` field in module_bp_java_deps.json
571 compileDepNames []string
Makoto Onuki7ded3822024-03-28 14:42:20 -0700572
573 ravenizer struct {
574 enabled bool
575 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700576}
577
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000578var _ android.InstallableModule = (*Module)(nil)
579
580// To satisfy the InstallableModule interface
Jihoon Kang224ea082024-08-12 22:38:16 +0000581func (j *Module) StaticDependencyTags() []blueprint.DependencyTag {
582 return []blueprint.DependencyTag{staticLibTag}
583}
584
585// To satisfy the InstallableModule interface
586func (j *Module) DynamicDependencyTags() []blueprint.DependencyTag {
587 return []blueprint.DependencyTag{libTag, sdkLibTag, bootClasspathTag, systemModulesTag,
588 instrumentationForTag, java9LibTag}
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000589}
590
591// Overrides android.ModuleBase.InstallInProduct()
592func (j *Module) InstallInProduct() bool {
593 return j.ProductSpecific()
594}
595
Jihoon Kang85bc1932024-07-01 17:04:46 +0000596var _ android.StubsAvailableModule = (*Module)(nil)
597
598// To safisfy the StubsAvailableModule interface
599func (j *Module) IsStubsModule() bool {
600 return proptools.Bool(j.properties.Is_stubs_module)
601}
602
Jiyong Park92315372021-04-02 08:45:46 +0900603func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
604 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900605 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700606 return nil
607 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900608 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000609 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700610 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
611 } else {
612 // Treat stable core platform as stable.
613 return nil
614 }
615 } else {
616 return fmt.Errorf("non stable SDK %v", sdkVersion)
617 }
618}
619
620// checkSdkVersions enforces restrictions around SDK dependencies.
621func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
622 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900623 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900624 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700625 ctx.PropertyErrorf("sdk_version",
626 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
627 }
628 }
629 }
630
631 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
632 // See rank() for details.
633 ctx.VisitDirectDeps(func(module android.Module) {
634 tag := ctx.OtherModuleDependencyTag(module)
635 switch module.(type) {
636 // TODO(satayev): cover other types as well, e.g. imports
637 case *Library, *AndroidLibrary:
638 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400639 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700640 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
641 }
642 }
643 })
644}
645
646func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900647 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700648 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900649 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700650 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000651 ctx.PropertyErrorf("platform_apis", "This module has conflicting settings. sdk_version is not empty, which means this module cannot use platform APIs. However platform_apis is set to true.")
Jaewoong Jung26342642021-03-17 15:56:23 -0700652 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000653 ctx.PropertyErrorf("platform_apis", "This module has conflicting settings. sdk_version is empty, which means that this module is build against platform APIs. However platform_apis is not set to true")
Jaewoong Jung26342642021-03-17 15:56:23 -0700654 }
655
656 }
657}
658
Mark Whitea15790a2023-08-22 21:28:11 +0000659func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
660 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400661 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000662 installable := proptools.Bool(j.properties.Installable)
663
664 if headersOnly && installable {
665 ctx.PropertyErrorf("headers_only", "This module has conflicting settings. headers_only is true which, which means this module doesn't generate an implementation jar. However installable is set to true.")
666 }
667 }
668}
669
Jaewoong Jung26342642021-03-17 15:56:23 -0700670func (j *Module) addHostProperties() {
671 j.AddProperties(
672 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000673 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700674 &j.protoProperties,
675 &j.usesLibraryProperties,
676 )
677}
678
679func (j *Module) addHostAndDeviceProperties() {
680 j.addHostProperties()
681 j.AddProperties(
682 &j.deviceProperties,
683 &j.dexer.dexProperties,
684 &j.dexpreoptProperties,
685 &j.linter.properties,
686 )
687}
688
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000689// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
690// makes it available through the hiddenAPIPropertyInfoProvider.
691func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
692 hiddenAPIInfo := newHiddenAPIPropertyInfo()
693
694 // Populate with flag file paths from the properties.
695 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
696
697 // Populate with package rules from the properties.
698 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
699
Colin Cross40213022023-12-13 15:19:49 -0800700 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000701}
702
mrziwang9f7b9f42024-07-10 12:18:06 -0700703// helper method for java modules to set OutputFilesProvider
704func setOutputFiles(ctx android.ModuleContext, m Module) {
705 ctx.SetOutputFiles(append(android.Paths{m.outputFile}, m.extraOutputFiles...), "")
706 ctx.SetOutputFiles(android.Paths{m.outputFile}, android.DefaultDistTag)
707 ctx.SetOutputFiles(android.Paths{m.implementationAndResourcesJar}, ".jar")
708 ctx.SetOutputFiles(android.Paths{m.headerJarFile}, ".hjar")
709 if m.dexer.proguardDictionary.Valid() {
710 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
711 }
712 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
713 if m.linter.outputs.xml != nil {
714 ctx.SetOutputFiles(android.Paths{m.linter.outputs.xml}, ".lint")
Jaewoong Jung26342642021-03-17 15:56:23 -0700715 }
716}
717
Jaewoong Jung26342642021-03-17 15:56:23 -0700718func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
719 initJavaModule(module, hod, false)
720}
721
722func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
723 initJavaModule(module, hod, true)
724}
725
726func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
727 multilib := android.MultilibCommon
728 if multiTargets {
729 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
730 } else {
731 android.InitAndroidArchModule(module, hod, multilib)
732 }
733 android.InitDefaultableModule(module)
734}
735
736func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
737 return j.properties.Instrument &&
738 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
739 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
740}
741
Yihan Dong8be09c22024-08-29 15:32:13 +0800742func (j *Module) shouldApiMapper() bool {
743 return j.properties.ApiMapper
744}
745
Jaewoong Jung26342642021-03-17 15:56:23 -0700746func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000747 return j.properties.Supports_static_instrumentation &&
748 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700749 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
750 ctx.Config().UnbundledBuild())
751}
752
753func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
754 // Force enable the instrumentation for java code that is built for APEXes ...
755 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
756 // 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 -0800757 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700758 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000759
Jihoon Kang46d66de2024-05-22 22:42:39 +0000760 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700761 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
762 return true
763 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
764 return true
765 }
766 }
767 return false
768}
769
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400770func (j *Module) setInstrument(value bool) {
771 j.properties.Instrument = value
772}
773
Yihan Dong8be09c22024-08-29 15:32:13 +0800774func (j *Module) setApiMapper(value bool) {
775 j.properties.ApiMapper = value
776}
777
Jiyong Park92315372021-04-02 08:45:46 +0900778func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
779 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700780}
781
Jiyong Parkf1691d22021-03-29 20:11:58 +0900782func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700783 return proptools.String(j.deviceProperties.System_modules)
784}
785
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000786func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000787 if j.overridableProperties.Min_sdk_version != nil {
788 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700789 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000790 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700791}
792
Yu Liuf2b94012023-09-19 15:09:10 -0700793func (j *Module) GetDeviceProperties() *DeviceProperties {
794 return &j.deviceProperties
795}
796
Spandan Dasa26eda72023-03-02 00:56:06 +0000797func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
798 if j.deviceProperties.Max_sdk_version != nil {
799 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
800 }
801 // Default is PrivateApiLevel
802 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000803}
804
Spandan Dasa26eda72023-03-02 00:56:06 +0000805func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
806 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
807 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
808 }
809 // Default is PrivateApiLevel
810 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000811}
812
Jiyong Parkf1691d22021-03-29 20:11:58 +0900813func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000814 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900815}
816
Spandan Dasca70fc42023-03-01 23:38:49 +0000817func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900818 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000819 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900820 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000821 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700822}
823
824func (j *Module) AvailableFor(what string) bool {
825 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
826 // Exception: for hostdex: true libraries, the platform variant is created
827 // even if it's not marked as available to platform. In that case, the platform
828 // variant is used only for the hostdex and not installed to the device.
829 return true
830 }
831 return j.ApexModuleBase.AvailableFor(what)
832}
833
834func (j *Module) deps(ctx android.BottomUpMutatorContext) {
835 if ctx.Device() {
836 j.linter.deps(ctx)
837
Jiyong Parkf1691d22021-03-29 20:11:58 +0900838 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700839
840 if j.deviceProperties.SyspropPublicStub != "" {
841 // This is a sysprop implementation library that has a corresponding sysprop public
842 // stubs library, and a dependency on it so that dependencies on the implementation can
843 // be forwarded to the public stubs library when necessary.
844 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
845 }
846 }
847
848 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000849
850 j.properties.Static_libs = android.RemoveListFromList(j.properties.Static_libs, j.properties.Exclude_static_libs)
Jaewoong Jung26342642021-03-17 15:56:23 -0700851 ctx.AddVariationDependencies(nil, staticLibTag, j.properties.Static_libs...)
852
853 // Add dependency on libraries that provide additional hidden api annotations.
854 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
855
Kiyoung Kim9743bab2024-03-28 15:44:56 +0900856 if ctx.Config().EnforceInterPartitionJavaSdkLibrary() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700857 // Require java_sdk_library at inter-partition java dependency to ensure stable
858 // interface between partitions. If inter-partition java_library dependency is detected,
859 // raise build error because java_library doesn't have a stable interface.
860 //
861 // Inputs:
862 // PRODUCT_ENFORCE_INTER_PARTITION_JAVA_SDK_LIBRARY
863 // if true, enable enforcement
864 // PRODUCT_INTER_PARTITION_JAVA_LIBRARY_ALLOWLIST
865 // exception list of java_library names to allow inter-partition dependency
866 for idx := range j.properties.Libs {
867 if libDeps[idx] == nil {
868 continue
869 }
870
871 if javaDep, ok := libDeps[idx].(javaSdkLibraryEnforceContext); ok {
872 // java_sdk_library is always allowed at inter-partition dependency.
873 // So, skip check.
874 if _, ok := javaDep.(*SdkLibrary); ok {
875 continue
876 }
877
878 j.checkPartitionsForJavaDependency(ctx, "libs", javaDep)
879 }
880 }
881 }
882
883 // For library dependencies that are component libraries (like stubs), add the implementation
884 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
885 for _, dep := range libDeps {
886 if dep != nil {
887 if component, ok := dep.(SdkLibraryComponentDependency); ok {
888 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000889 // Add library as optional if it's one of the optional compatibility libs or it's
890 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100891 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000892 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
893 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100894 tag = usesLibOptTag
895 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100896 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700897 }
898 }
899 }
900 }
901
902 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
903 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
904 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
905
906 android.ProtoDeps(ctx, &j.protoProperties)
907 if j.hasSrcExt(".proto") {
908 protoDeps(ctx, &j.protoProperties)
909 }
910
911 if j.hasSrcExt(".kt") {
912 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
913 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700914 tag := staticLibTag
915 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
916 tag = libTag
917 }
918 ctx.AddVariationDependencies(nil, tag,
919 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700920 }
921
922 // Framework libraries need special handling in static coverage builds: they should not have
923 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
924 // the same jacoco classes coming from different bootclasspath jars.
925 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
926 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
927 j.properties.Instrument = true
928 }
929 } else if j.shouldInstrumentStatic(ctx) {
930 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
931 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700932
933 if j.useCompose() {
934 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
935 "androidx.compose.compiler_compiler-hosted")
936 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700937}
938
939func hasSrcExt(srcs []string, ext string) bool {
940 for _, src := range srcs {
941 if filepath.Ext(src) == ext {
942 return true
943 }
944 }
945
946 return false
947}
948
949func (j *Module) hasSrcExt(ext string) bool {
950 return hasSrcExt(j.properties.Srcs, ext)
951}
952
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100953func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
954 var flags string
955
956 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
957 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
958 flags = "-Wmissing-permission-annotation -Werror"
959 }
960 }
961 return flags
962}
963
Jaewoong Jung26342642021-03-17 15:56:23 -0700964func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000965 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700966
967 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
968 aidlIncludes = append(aidlIncludes,
969 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
970 aidlIncludes = append(aidlIncludes,
971 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
972
973 var flags []string
974 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000975 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700976
977 flags = append(flags, j.deviceProperties.Aidl.Flags...)
978
979 if aidlPreprocess.Valid() {
980 flags = append(flags, "-p"+aidlPreprocess.String())
981 deps = append(deps, aidlPreprocess.Path())
982 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000983 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700984 }
985
986 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000987 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700988 }
989
990 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000991 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700992 }
993
Sam Delmerico2351eac2022-05-24 17:10:02 +0000994 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700995 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000996 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700997 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000998 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
999 // add flags for dirs containing AIDL srcs that haven't been specified yet
1000 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -07001001
Zim8774ae12022-08-17 11:46:34 +01001002 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +00001003 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +01001004 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001005 flags = append(flags, "-t")
1006 }
1007
1008 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
1009 flags = append(flags, "--transaction_names")
1010 }
1011
Thiébaud Weksteende8417c2022-02-10 15:41:46 +11001012 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
1013 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
1014 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1015 }
1016
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001017 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001018 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1019
Jaewoong Jung26342642021-03-17 15:56:23 -07001020 return strings.Join(flags, " "), deps
1021}
1022
1023func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1024
1025 var flags javaBuilderFlags
1026
1027 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001028 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001029
Cole Faust2b1536e2021-06-18 12:25:54 -07001030 epEnabled := j.properties.Errorprone.Enabled
1031 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001032 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001033 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1034 }
1035
1036 errorProneFlags := []string{
1037 "-Xplugin:ErrorProne",
1038 "${config.ErrorProneChecks}",
1039 }
1040 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1041
Colin Cross8bf6cad2022-02-28 13:07:03 -08001042 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001043 "'" + strings.Join(errorProneFlags, " ") + "'"
1044 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1045 }
1046
1047 // classpath
1048 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1049 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001050 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001051 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1052 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1053 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1054
1055 flags.processors = append(flags.processors, deps.processorClasses...)
1056 flags.processors = android.FirstUniqueStrings(flags.processors)
1057
1058 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001059 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001060 // Give host-side tools a version of OpenJDK's standard libraries
1061 // close to what they're targeting. As of Dec 2017, AOSP is only
1062 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1063 //
1064 // When building with OpenJDK 8, the following should have no
1065 // effect since those jars would be available by default.
1066 //
1067 // When building with OpenJDK 9 but targeting a version < 1.8,
1068 // putting them on the bootclasspath means that:
1069 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1070 // b) references to existing APIs are not reinterpreted in an
1071 // OpenJDK 9-specific way, eg. calls to subclasses of
1072 // java.nio.Buffer as in http://b/70862583
1073 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1074 flags.bootClasspath = append(flags.bootClasspath,
1075 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1076 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1077 if Bool(j.properties.Use_tools_jar) {
1078 flags.bootClasspath = append(flags.bootClasspath,
1079 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1080 }
1081 }
1082
1083 // systemModules
1084 flags.systemModules = deps.systemModules
1085
Jaewoong Jung26342642021-03-17 15:56:23 -07001086 return flags
1087}
1088
1089func (j *Module) collectJavacFlags(
1090 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1091 // javac flags.
1092 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001093 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001094
Mythri Alle4b9f6182023-10-25 15:17:11 +00001095 needsDebugInfo = false
1096 for _, flag := range javacFlags {
1097 if strings.HasPrefix(flag, "-g") {
1098 needsDebugInfo = true
1099 }
1100 }
1101
1102 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001103 // For non-host binaries, override the -g flag passed globally to remove
1104 // local variable debug info to reduce disk and memory usage.
1105 javacFlags = append(javacFlags, "-g:source,lines")
1106 }
1107 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1108
1109 if flags.javaVersion.usesJavaModules() {
1110 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001111 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1112 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1113 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1114 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001115
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001116 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001117 if j.properties.Patch_module != nil {
1118 // Manually specify build directory in case it is not under the repo root.
1119 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1120 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001121 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001122
Jaewoong Jung26342642021-03-17 15:56:23 -07001123 classPath := flags.classpath.FormJavaClassPath("")
1124 if classPath != "" {
1125 patchPaths = append(patchPaths, classPath)
1126 }
1127 javacFlags = append(
1128 javacFlags,
1129 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1130 }
1131 }
1132
1133 if len(javacFlags) > 0 {
1134 // optimization.
1135 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1136 flags.javacFlags = "$javacFlags"
1137 }
1138
1139 return flags
1140}
1141
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001142func (j *Module) AddJSONData(d *map[string]interface{}) {
1143 (&j.ModuleBase).AddJSONData(d)
1144 (*d)["Java"] = map[string]interface{}{
1145 "SourceExtensions": j.sourceExtensions,
1146 }
1147
1148}
1149
usta0391ca42023-09-19 15:51:59 -04001150func (j *Module) addGeneratedSrcJars(path android.Path) {
1151 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001152}
1153
Colin Crossfdaa6722024-08-23 11:58:08 -07001154func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars, extraDepCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001155 // Auto-propagating jarjar rules
1156 jarjarProviderData := j.collectJarJarRules(ctx)
1157 if jarjarProviderData != nil {
1158 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wang9bdd4222024-02-26 18:21:01 -08001159 if !proptools.Bool(j.properties.Skip_jarjar_repackage) {
1160 text := getJarJarRuleText(jarjarProviderData)
1161 if text != "" {
1162 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1163 android.WriteFileRule(ctx, ruleTextFile, text)
1164 j.repackageJarjarRules = ruleTextFile
1165 }
Joe Onorato349ae8d2024-02-05 22:46:00 +00001166 }
1167 }
1168
Jaewoong Jung26342642021-03-17 15:56:23 -07001169 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1170
Makoto Onuki7ded3822024-03-28 14:42:20 -07001171 if re := proptools.Bool(j.properties.Ravenizer.Enabled); re {
1172 j.ravenizer.enabled = re
1173 }
1174
Jaewoong Jung26342642021-03-17 15:56:23 -07001175 deps := j.collectDeps(ctx)
1176 flags := j.collectBuilderFlags(ctx, deps)
1177
1178 if flags.javaVersion.usesJavaModules() {
1179 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001180 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1181 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1182 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001183 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001184
Jaewoong Jung26342642021-03-17 15:56:23 -07001185 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001186 j.sourceExtensions = []string{}
1187 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1188 if hasSrcExt(srcFiles.Strings(), ext) {
1189 j.sourceExtensions = append(j.sourceExtensions, ext)
1190 }
1191 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001192 if hasSrcExt(srcFiles.Strings(), ".proto") {
1193 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1194 }
1195
1196 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1197 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1198 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1199 }
1200
Sam Delmerico2351eac2022-05-24 17:10:02 +00001201 aidlSrcs := srcFiles.FilterByExt(".aidl")
1202 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1203
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001204 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001205 srcFiles = j.genSources(ctx, srcFiles, flags)
1206
1207 // Collect javac flags only after computing the full set of srcFiles to
1208 // ensure that the --patch-module lookup paths are complete.
1209 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1210
1211 srcJars := srcFiles.FilterByExt(".srcjar")
1212 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001213 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001214 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001215 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001216
1217 if j.properties.Jarjar_rules != nil {
1218 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1219 }
1220
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001221 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001222
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001223 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001224 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001225 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001226 if _, found := set[v.String()]; !found {
1227 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001228 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001229 }
1230 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001231 var uniqueKtFiles android.Paths
1232 for _, v := range srcFiles.FilterByExt(".kt") {
1233 if _, found := set[v.String()]; !found {
1234 set[v.String()] = true
1235 uniqueKtFiles = append(uniqueKtFiles, v)
1236 }
1237 }
1238
1239 var uniqueSrcFiles android.Paths
1240 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1241 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1242 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001243 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001244
Colin Crossb5db4012022-03-28 17:12:39 -07001245 // We don't currently run annotation processors in turbine, which means we can't use turbine
1246 // generated header jars when an annotation processor that generates API is enabled. One
1247 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1248 // is used to run all of the annotation processors.
1249 disableTurbine := deps.disableTurbine
1250
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001251 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001252 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1253
Colin Cross220a9a12022-03-28 17:08:01 -07001254 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001255
Colin Cross4eae06d2023-06-20 22:40:02 -07001256 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1257 // any dependencies so that it can override any non-final R classes from dependencies with the
1258 // final R classes from the app.
1259 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1260
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001261 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1262
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001263 var localImplementationJars android.Paths
1264
Mark Whitea15790a2023-08-22 21:28:11 +00001265 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001266 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001267 if srcFiles.HasExt(".kt") {
1268 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1269 }
1270 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1271 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1272 }
1273
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001274 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1275
1276 localHeaderJars, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
Colin Crossedec77c2024-07-26 15:25:40 -07001277 extraCombinedJars)
1278
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001279 combinedHeaderJarFile, jarjared := j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1280 if jarjared {
1281 localHeaderJars = android.Paths{combinedHeaderJarFile}
1282 transitiveStaticLibsHeaderJars = nil
1283 }
1284 combinedHeaderJarFile, repackaged := j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
1285 if repackaged {
1286 localHeaderJars = android.Paths{combinedHeaderJarFile}
1287 transitiveStaticLibsHeaderJars = nil
1288 }
Mark Whitea15790a2023-08-22 21:28:11 +00001289 if ctx.Failed() {
1290 return
1291 }
Colin Crossedec77c2024-07-26 15:25:40 -07001292 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001293
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001294 if ctx.Config().UseTransitiveJarsInClasspath() {
1295 if len(localHeaderJars) > 0 {
1296 ctx.CheckbuildFile(localHeaderJars...)
1297 } else {
1298 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1299 ctx.UncheckedModule()
1300 }
1301 } else {
1302 ctx.CheckbuildFile(j.headerJarFile)
1303 }
Colin Crossa6182ab2024-08-21 10:47:44 -07001304
Colin Cross7727c7f2024-07-18 15:36:32 -07001305 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001306 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001307 LocalHeaderJars: localHeaderJars,
1308 TransitiveStaticLibsHeaderJars: android.NewDepSet(android.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Cross9ffaf282024-08-12 13:50:09 -07001309 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1310 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001311 AidlIncludeDirs: j.exportAidlIncludeDirs,
1312 ExportedPlugins: j.exportedPluginJars,
1313 ExportedPluginClasses: j.exportedPluginClasses,
1314 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1315 StubsLinkType: j.stubsLinkType,
1316 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001317 })
1318
1319 j.outputFile = j.headerJarFile
1320 return
1321 }
1322
Jaewoong Jung26342642021-03-17 15:56:23 -07001323 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001324 // When using kotlin sources turbine is used to generate annotation processor sources,
1325 // including for annotation processors that generate API, so we can use turbine for
1326 // java sources too.
1327 disableTurbine = false
1328
Jaewoong Jung26342642021-03-17 15:56:23 -07001329 // user defined kotlin flags.
1330 kotlincFlags := j.properties.Kotlincflags
1331 CheckKotlincFlags(ctx, kotlincFlags)
1332
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001333 // Workaround for KT-46512
1334 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001335
1336 // If there are kotlin files, compile them first but pass all the kotlin and java files
1337 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1338 // won't emit any classes for them.
1339 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1340 if ctx.Device() {
1341 kotlincFlags = append(kotlincFlags, "-no-jdk")
1342 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001343
1344 for _, plugin := range deps.kotlinPlugins {
1345 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1346 }
1347 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1348
Jaewoong Jung26342642021-03-17 15:56:23 -07001349 if len(kotlincFlags) > 0 {
1350 // optimization.
1351 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1352 flags.kotlincFlags += "$kotlincFlags"
1353 }
1354
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001355 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001356 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1357
Jaewoong Jung26342642021-03-17 15:56:23 -07001358 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1359 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1360
Isaac Chioua23d9942022-04-06 06:14:38 +00001361 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001362 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001363 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1364 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001365 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001366 srcJars = append(srcJars, kaptSrcJar)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001367 localImplementationJars = append(localImplementationJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001368 // Disable annotation processing in javac, it's already been handled by kapt
1369 flags.processorPath = nil
1370 flags.processors = nil
1371 }
1372
1373 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001374 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001375 kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001376 if ctx.Failed() {
1377 return
1378 }
1379
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001380 kotlinJarPath, _ := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001381
Isaac Chioua23d9942022-04-06 06:14:38 +00001382 // Make javac rule depend on the kotlinc rule
1383 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1384
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001385 localImplementationJars = append(localImplementationJars, kotlinJarPath)
1386
Colin Cross220a9a12022-03-28 17:08:01 -07001387 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001388 }
1389
Jaewoong Jung26342642021-03-17 15:56:23 -07001390 j.compiledSrcJars = srcJars
1391
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001392 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1393
Jaewoong Jung26342642021-03-17 15:56:23 -07001394 enableSharding := false
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001395 var localHeaderJars android.Paths
1396 var shardingHeaderJars android.Paths
1397 var repackagedHeaderJarFile android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001398 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001399 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1400 enableSharding = true
1401 // Formerly, there was a check here that prevented annotation processors
1402 // from being used when sharding was enabled, as some annotation processors
1403 // do not function correctly in sharded environments. It was removed to
1404 // allow for the use of annotation processors that do function correctly
1405 // with sharding enabled. See: b/77284273.
1406 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001407 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001408 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001409 var combinedHeaderJarFile android.Path
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001410 localHeaderJars, combinedHeaderJarFile = j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
1411 shardingHeaderJars = localHeaderJars
Colin Crossedec77c2024-07-26 15:25:40 -07001412
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001413 var jarjared bool
1414 j.headerJarFile, jarjared = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1415 if jarjared {
1416 // jarjar modifies transitive static dependencies, use the combined header jar and drop the transitive
1417 // static libs header jars.
1418 localHeaderJars = android.Paths{j.headerJarFile}
1419 transitiveStaticLibsHeaderJars = nil
1420 }
1421 var repackaged bool
1422 repackagedHeaderJarFile, repackaged = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
1423 if repackaged {
1424 // repackage modifies transitive static dependencies, use the combined header jar and drop the transitive
1425 // static libs header jars.
1426 // TODO(b/356688296): this shouldn't export both the unmodified and repackaged header jars
1427 localHeaderJars = android.Paths{j.headerJarFile, repackagedHeaderJarFile}
1428 transitiveStaticLibsHeaderJars = nil
1429 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001430 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001431 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001432 hasErrorproneableFiles := false
1433 for _, ext := range j.sourceExtensions {
1434 if ext != ".proto" && ext != ".aidl" {
1435 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1436 // compile, and it's not useful to have warnings on these generated sources.
1437 hasErrorproneableFiles = true
1438 break
1439 }
1440 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001441 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001442 if Bool(j.properties.Errorprone.Enabled) {
1443 // If error-prone is enabled, enable errorprone flags on the regular
1444 // build.
1445 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001446 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001447 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1448 // a new jar file just for compiling with the errorprone compiler to.
1449 // This is because we don't want to cause the java files to get completely
1450 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1451 // We also don't want to run this if errorprone is enabled by default for
1452 // this module, or else we could have duplicated errorprone messages.
1453 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001454 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001455 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001456
Vadim Spivak3c496f02023-06-08 06:14:59 +00001457 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001458 "errorprone", "errorprone")
1459
Jaewoong Jung26342642021-03-17 15:56:23 -07001460 extraJarDeps = append(extraJarDeps, errorprone)
1461 }
1462
1463 if enableSharding {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001464 if len(shardingHeaderJars) > 0 {
1465 flags.classpath = append(classpath(slices.Clone(shardingHeaderJars)), flags.classpath...)
Colin Cross3d56ed52021-11-18 22:23:12 -08001466 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001467 shardSize := int(*(j.properties.Javac_shard_size))
1468 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001469 if len(uniqueJavaFiles) > 0 {
1470 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001471 for idx, shardSrc := range shardSrcs {
1472 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1473 nil, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001474 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
1475 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001476 }
1477 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001478 // Assume approximately 5 sources per srcjar.
1479 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1480 // 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 -07001481 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001482 startIdx := len(shardSrcs)
1483 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1484 for idx, shardSrcJars := range shardSrcJarsList {
1485 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1486 nil, shardSrcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001487 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
1488 localImplementationJars = append(localImplementationJars, classes)
Colin Crossa052ddb2023-09-25 21:46:58 -07001489 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001490 }
1491 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001492 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001493 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
1494 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001495 }
1496 if ctx.Failed() {
1497 return
1498 }
1499 }
1500
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001501 localImplementationJars = append(localImplementationJars, extraCombinedJars...)
Colin Crossfd620b22024-02-23 10:05:21 -08001502
Jaewoong Jung26342642021-03-17 15:56:23 -07001503 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1504
1505 var includeSrcJar android.WritablePath
1506 if Bool(j.properties.Include_srcs) {
1507 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1508 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1509 }
1510
1511 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1512 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1513 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1514 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1515
1516 var resArgs []string
1517 var resDeps android.Paths
1518
1519 resArgs = append(resArgs, dirArgs...)
1520 resDeps = append(resDeps, dirDeps...)
1521
1522 resArgs = append(resArgs, fileArgs...)
1523 resDeps = append(resDeps, fileDeps...)
1524
1525 resArgs = append(resArgs, extraArgs...)
1526 resDeps = append(resDeps, extraDeps...)
1527
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001528 var localResourceJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001529 if len(resArgs) > 0 {
1530 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1531 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001532 if ctx.Failed() {
1533 return
1534 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001535 localResourceJars = append(localResourceJars, resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001536 }
1537
Jaewoong Jung26342642021-03-17 15:56:23 -07001538 if Bool(j.properties.Include_srcs) {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001539 localResourceJars = append(localResourceJars, includeSrcJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001540 }
1541
1542 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1543 if len(services) > 0 {
1544 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1545 var zipargs []string
1546 for _, file := range services {
1547 serviceFile := file.String()
1548 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1549 }
1550 rule := zip
1551 args := map[string]string{
1552 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1553 }
1554 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1555 rule = zipRE
1556 args["implicits"] = strings.Join(services.Strings(), ",")
1557 }
1558 ctx.Build(pctx, android.BuildParams{
1559 Rule: rule,
1560 Output: servicesJar,
1561 Implicits: services,
1562 Args: args,
1563 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001564 localResourceJars = append(localResourceJars, servicesJar)
1565 }
1566
1567 completeStaticLibsResourceJars := android.NewDepSet(android.PREORDER, localResourceJars, deps.transitiveStaticLibsResourceJars)
1568
1569 var combinedResourceJar android.Path
1570 var resourceJars android.Paths
1571 if ctx.Config().UseTransitiveJarsInClasspath() {
1572 resourceJars = completeStaticLibsResourceJars.ToList()
1573 } else {
1574 resourceJars = append(slices.Clone(localResourceJars), deps.staticResourceJars...)
1575 }
1576 if len(resourceJars) == 1 {
1577 combinedResourceJar = resourceJars[0]
1578 } else if len(resourceJars) > 0 {
1579 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1580 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1581 false, nil, nil)
1582 combinedResourceJar = combinedJar
1583 }
1584
1585 manifest := j.overrideManifest
1586 if !manifest.Valid() && j.properties.Manifest != nil {
1587 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Jaewoong Jung26342642021-03-17 15:56:23 -07001588 }
1589
1590 // Combine the classes built from sources, any manifests, and any static libraries into
1591 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001592 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001593
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001594 completeStaticLibsImplementationJars := android.NewDepSet(android.PREORDER, localImplementationJars, deps.transitiveStaticLibsImplementationJars)
1595
1596 var jars android.Paths
1597 if ctx.Config().UseTransitiveJarsInClasspath() {
1598 jars = completeStaticLibsImplementationJars.ToList()
1599 } else {
1600 jars = append(slices.Clone(localImplementationJars), deps.staticJars...)
1601 }
1602
1603 jars = append(jars, extraDepCombinedJars...)
1604
Jaewoong Jung26342642021-03-17 15:56:23 -07001605 if len(jars) == 1 && !manifest.Valid() {
1606 // Optimization: skip the combine step as there is nothing to do
1607 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1608 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001609 // any if len(extraJars) == 0.
Jaewoong Jung26342642021-03-17 15:56:23 -07001610
Jihoon Kang1147b312023-06-08 23:25:57 +00001611 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1612 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1613 // either with .from-source or .from-text suffix.
1614 // outputFile should be agnostic to the build configuration,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001615 // thus copy the single input static lib in order to prevent the static lib from being exposed
Jihoon Kang1147b312023-06-08 23:25:57 +00001616 // to the copy rules.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001617 if stub, _ := moduleStubLinkType(j); stub {
1618 copiedJar := android.PathForModuleOut(ctx, "combined", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001619 ctx.Build(pctx, android.BuildParams{
1620 Rule: android.Cp,
1621 Input: jars[0],
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001622 Output: copiedJar,
Jaewoong Jung26342642021-03-17 15:56:23 -07001623 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001624 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, android.Paths{copiedJar}, nil)
1625 outputFile = copiedJar
Colin Cross7707b242024-07-26 12:02:36 -07001626 } else {
1627 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001628 }
1629 } else {
1630 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1631 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1632 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001633 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001634 }
1635
1636 // jarjar implementation jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001637 jarjarFile, jarjarred := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1638 if jarjarred {
1639 localImplementationJars = android.Paths{jarjarFile}
1640 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
1641 }
Colin Crossedec77c2024-07-26 15:25:40 -07001642 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001643
Colin Crossedec77c2024-07-26 15:25:40 -07001644 // jarjar resource jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001645 if combinedResourceJar != nil {
1646 resourceJarJarFile, jarjarred := j.jarjarIfNecessary(ctx, combinedResourceJar, jarName, "resource")
1647 combinedResourceJar = resourceJarJarFile
1648 if jarjarred {
1649 localResourceJars = android.Paths{resourceJarJarFile}
1650 completeStaticLibsResourceJars = android.NewDepSet(android.PREORDER, localResourceJars, nil)
1651 }
Colin Crossedec77c2024-07-26 15:25:40 -07001652 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001653
Colin Crossedec77c2024-07-26 15:25:40 -07001654 if ctx.Failed() {
1655 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001656 }
1657
Makoto Onuki7ded3822024-03-28 14:42:20 -07001658 if j.ravenizer.enabled {
1659 ravenizerInput := outputFile
1660 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", jarName)
1661 ctx.Build(pctx, android.BuildParams{
1662 Rule: ravenizer,
1663 Description: "ravenizer",
1664 Input: ravenizerInput,
1665 Output: ravenizerOutput,
1666 })
1667 outputFile = ravenizerOutput
Colin Cross7e863852024-09-06 14:42:38 -07001668 localImplementationJars = android.Paths{ravenizerOutput}
1669 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Makoto Onuki7ded3822024-03-28 14:42:20 -07001670 }
1671
Yihan Dong8be09c22024-08-29 15:32:13 +08001672 if j.shouldApiMapper() {
1673 inputFile := outputFile
1674 apiMapperFile := android.PathForModuleOut(ctx, "apimapper", jarName)
1675 ctx.Build(pctx, android.BuildParams{
1676 Rule: apimapper,
1677 Description: "apimapper",
1678 Input: inputFile,
1679 Output: apiMapperFile,
1680 })
1681 outputFile = apiMapperFile
Colin Cross7e863852024-09-06 14:42:38 -07001682 localImplementationJars = android.Paths{apiMapperFile}
1683 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Yihan Dong8be09c22024-08-29 15:32:13 +08001684 }
1685
Jaewoong Jung26342642021-03-17 15:56:23 -07001686 // Check package restrictions if necessary.
1687 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001688 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001689 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001690
1691 // Create a rule to copy the output jar to another path and add a validate dependency that
1692 // will check that the jar only contains the permitted packages. The new location will become
1693 // the output file of this module.
1694 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001695 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001696 ctx.Build(pctx, android.BuildParams{
1697 Rule: android.Cp,
1698 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001699 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001700 // Make sure that any dependency on the output file will cause ninja to run the package check
1701 // rule.
1702 Validation: pkgckFile,
1703 })
Colin Cross7707b242024-07-26 12:02:36 -07001704 outputFile = packageCheckOutputFile
Colin Cross7e863852024-09-06 14:42:38 -07001705 localImplementationJars = android.Paths{packageCheckOutputFile}
1706 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001707
1708 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001709 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001710
1711 if ctx.Failed() {
1712 return
1713 }
1714 }
1715
1716 j.implementationJarFile = outputFile
1717 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001718 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1719 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1720 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1721 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1722 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1723 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1724 j.headerJarFile = headerJarFile
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001725 if len(localImplementationJars) == 1 && ctx.Config().UseTransitiveJarsInClasspath() {
1726 localHeaderJarFile := android.PathForModuleOut(ctx, "local-javac-header", jarName)
1727 convertImplementationJarToHeaderJar(ctx, localImplementationJars[0], localHeaderJarFile)
1728 localHeaderJars = append(localHeaderJars, localHeaderJarFile)
1729 } else {
1730 localHeaderJars = append(localHeaderJars, headerJarFile)
1731 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001732 }
1733
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001734 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1735 specs := j.jacocoModuleToZipCommand(ctx)
1736 if ctx.Failed() {
1737 return
1738 }
1739
Jaewoong Jung26342642021-03-17 15:56:23 -07001740 if j.shouldInstrument(ctx) {
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001741 outputFile = j.instrument(ctx, flags, outputFile, jarName, specs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001742 }
1743
1744 // merge implementation jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001745 var implementationAndResourcesJarsToCombine android.Paths
1746 if ctx.Config().UseTransitiveJarsInClasspath() {
1747 resourceJars := completeStaticLibsResourceJars.ToList()
1748 if len(resourceJars) > 0 {
1749 implementationAndResourcesJarsToCombine = append(resourceJars, completeStaticLibsImplementationJars.ToList()...)
1750 implementationAndResourcesJarsToCombine = append(implementationAndResourcesJarsToCombine, extraDepCombinedJars...)
1751 }
1752 } else {
1753 if combinedResourceJar != nil {
1754 implementationAndResourcesJarsToCombine = android.Paths{combinedResourceJar, outputFile}
1755 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001756 }
1757
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001758 if len(implementationAndResourcesJarsToCombine) > 0 {
1759 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
1760 TransformJarsToJar(ctx, combinedJar, "for resources", implementationAndResourcesJarsToCombine, manifest,
1761 false, nil, nil)
1762 outputFile = combinedJar
1763 }
1764
1765 j.implementationAndResourcesJar = outputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001766
1767 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001768 compileDex := j.dexProperties.Compile_dex
Colin Crossff694a82023-12-13 15:54:49 -08001769 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -07001770 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001771 if compileDex == nil {
1772 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001773 }
1774 if j.deviceProperties.Hostdex == nil {
1775 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1776 }
1777 }
1778
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001779 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001780 if j.hasCode(ctx) {
1781 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001782 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001783 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1784 }
1785 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001786 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001787 params := &compileDexParams{
1788 flags: flags,
1789 sdkVersion: j.SdkVersion(ctx),
1790 minSdkVersion: j.MinSdkVersion(ctx),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001791 classesJar: outputFile,
Spandan Dasc404cc72023-02-23 18:05:05 +00001792 jarName: jarName,
1793 }
Spandan Das15a67112024-05-30 00:07:40 +00001794 if j.GetProfileGuided() && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting() {
1795 ctx.PropertyErrorf("enable_profile_rewriting",
1796 "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.",
1797 )
1798 }
Spandan Das3dbda182024-05-20 22:23:10 +00001799 if j.EnableProfileRewriting() {
1800 profile := j.GetProfile()
1801 if profile == "" || !j.GetProfileGuided() {
1802 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1803 }
1804 params.artProfileInput = &profile
1805 }
1806 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001807 if ctx.Failed() {
1808 return
1809 }
1810
Spandan Das3dbda182024-05-20 22:23:10 +00001811 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1812 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001813 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001814 }
1815
Jaewoong Jung26342642021-03-17 15:56:23 -07001816 // merge dex jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001817 var dexAndResourceJarsToCombine android.Paths
1818 if ctx.Config().UseTransitiveJarsInClasspath() {
1819 resourceJars := completeStaticLibsResourceJars.ToList()
1820 if len(resourceJars) > 0 {
1821 dexAndResourceJarsToCombine = append(android.Paths{dexOutputFile}, resourceJars...)
1822 }
1823 } else {
1824 if combinedResourceJar != nil {
1825 dexAndResourceJarsToCombine = android.Paths{dexOutputFile, combinedResourceJar}
1826 }
1827 }
1828 if len(dexAndResourceJarsToCombine) > 0 {
Colin Cross7707b242024-07-26 12:02:36 -07001829 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001830 TransformJarsToJar(ctx, combinedJar, "for dex resources", dexAndResourceJarsToCombine, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001831 false, nil, nil)
1832 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001833 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001834 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001835 dexOutputFile = combinedAlignedJar
1836 } else {
1837 dexOutputFile = combinedJar
1838 }
1839 }
1840
Paul Duffin4de94502021-05-16 05:21:16 +01001841 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001842
1843 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001844
1845 // Encode hidden API flags in dex file, if needed.
1846 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1847
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001848 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001849
1850 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001851 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1852 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1853 libName = strings.TrimSuffix(libName, ".impl")
1854 }
1855 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001856
1857 outputFile = dexOutputFile
Colin Crossa6182ab2024-08-21 10:47:44 -07001858
1859 ctx.CheckbuildFile(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001860 } else {
1861 // There is no code to compile into a dex jar, make sure the resources are propagated
1862 // to the APK if this is an app.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001863 j.dexJarFile = makeDexJarPathFromPath(combinedResourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001864 }
1865
1866 if ctx.Failed() {
1867 return
1868 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001869 }
1870
1871 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001872 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001873 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001874 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001875 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001876 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001877 }
1878 }
1879
1880 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001881 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1882 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001883 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1884 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001885 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001886 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001887 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001888 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001889 j.linter.javaLanguageLevel = flags.javaVersion.String()
1890 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001891 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001892 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1893 j.linter.buildModuleReportZip = true
1894 }
1895 j.linter.lint(ctx)
1896 }
1897
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001898 j.collectTransitiveSrcFiles(ctx, srcFiles)
1899
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001900 if ctx.Config().UseTransitiveJarsInClasspath() {
1901 if len(localImplementationJars) > 0 || len(localResourceJars) > 0 || len(localHeaderJars) > 0 {
1902 ctx.CheckbuildFile(localImplementationJars...)
1903 ctx.CheckbuildFile(localResourceJars...)
1904 ctx.CheckbuildFile(localHeaderJars...)
1905 } else {
1906 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1907 ctx.UncheckedModule()
1908 }
1909 } else {
1910 ctx.CheckbuildFile(j.implementationJarFile)
1911 ctx.CheckbuildFile(j.headerJarFile)
1912 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001913
Colin Cross7727c7f2024-07-18 15:36:32 -07001914 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001915 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1916 RepackagedHeaderJars: android.PathsIfNonNil(repackagedHeaderJarFile),
1917
1918 LocalHeaderJars: localHeaderJars,
1919 TransitiveStaticLibsHeaderJars: android.NewDepSet(android.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
1920 TransitiveStaticLibsImplementationJars: completeStaticLibsImplementationJars,
1921 TransitiveStaticLibsResourceJars: completeStaticLibsResourceJars,
1922
Colin Cross9ffaf282024-08-12 13:50:09 -07001923 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1924 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001925 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1926 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001927 ResourceJars: android.PathsIfNonNil(combinedResourceJar),
Jihoon Kang705e63e2024-03-13 01:21:16 +00001928 AidlIncludeDirs: j.exportAidlIncludeDirs,
1929 SrcJarArgs: j.srcJarArgs,
1930 SrcJarDeps: j.srcJarDeps,
1931 TransitiveSrcFiles: j.transitiveSrcFiles,
1932 ExportedPlugins: j.exportedPluginJars,
1933 ExportedPluginClasses: j.exportedPluginClasses,
1934 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1935 JacocoReportClassesFile: j.jacocoReportClassesFile,
1936 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001937 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001938 })
1939
1940 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1941 j.outputFile = outputFile.WithoutRel()
1942}
1943
Colin Crossa1ff7c62021-09-17 14:11:52 -07001944func (j *Module) useCompose() bool {
1945 return android.InList("androidx.compose.runtime_runtime", j.properties.Static_libs)
1946}
1947
Colin Crosscde55342024-03-27 14:11:51 -07001948func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []*android.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001949 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001950 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001951 depTag := ctx.OtherModuleDependencyTag(m)
1952
1953 if depProguardInfo.UnconditionallyExportedProguardFlags != nil {
1954 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1955 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1956 }
1957
1958 if depTag == staticLibTag && depProguardInfo.ProguardFlagsFiles != nil {
1959 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1960 }
1961 })
1962
Colin Crosscde55342024-03-27 14:11:51 -07001963 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1964}
1965
1966func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1967 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1968
Sam Delmerico95d70942023-08-02 18:00:35 -04001969 directUnconditionalExportedFlags := android.Paths{}
1970 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1971 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1972 if exportUnconditionally {
1973 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1974 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1975 directUnconditionalExportedFlags = proguardFlagsForThisModule
1976 }
1977
1978 return ProguardSpecInfo{
1979 Export_proguard_flags_files: exportUnconditionally,
1980 ProguardFlagsFiles: android.NewDepSet[android.Path](
1981 android.POSTORDER,
1982 proguardFlagsForThisModule,
1983 transitiveProguardFlags,
1984 ),
1985 UnconditionallyExportedProguardFlags: android.NewDepSet[android.Path](
1986 android.POSTORDER,
1987 directUnconditionalExportedFlags,
1988 transitiveUnconditionalExportedFlags,
1989 ),
1990 }
1991
1992}
1993
Cole Faust75fffb12021-06-13 15:23:16 -07001994// Returns a copy of the supplied flags, but with all the errorprone-related
1995// fields copied to the regular build's fields.
1996func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1997 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1998
1999 if len(flags.errorProneExtraJavacFlags) > 0 {
2000 if len(flags.javacFlags) > 0 {
2001 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
2002 } else {
2003 flags.javacFlags = flags.errorProneExtraJavacFlags
2004 }
2005 }
2006 return flags
2007}
2008
Jaewoong Jung26342642021-03-17 15:56:23 -07002009func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07002010 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002011
2012 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00002013 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002014 if idx >= 0 {
2015 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00002016 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002017 jarName += strconv.Itoa(idx)
2018 }
2019
Colin Cross7707b242024-07-26 12:02:36 -07002020 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00002021 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07002022
Cole Faust9decf832024-06-11 11:45:53 -07002023 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002024 extractionFile := android.PathForModuleOut(ctx, kzipName)
2025 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
2026 j.kytheFiles = append(j.kytheFiles, extractionFile)
2027 }
2028
Vadim Spivak3c496f02023-06-08 06:14:59 +00002029 if len(flags.processorPath) > 0 {
2030 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
2031 }
2032
Jaewoong Jung26342642021-03-17 15:56:23 -07002033 return classes
2034}
2035
2036// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
2037// since some of these flags may be used internally.
2038func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
2039 for _, flag := range flags {
2040 flag = strings.TrimSpace(flag)
2041
2042 if !strings.HasPrefix(flag, "-") {
2043 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
2044 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
2045 ctx.PropertyErrorf("kotlincflags",
2046 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
2047 } else if inList(flag, config.KotlincIllegalFlags) {
2048 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
2049 } else if flag == "-include-runtime" {
2050 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
2051 } else {
2052 args := strings.Split(flag, " ")
2053 if args[0] == "-kotlin-home" {
2054 ctx.PropertyErrorf("kotlincflags",
2055 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
2056 }
2057 }
2058 }
2059}
2060
2061func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
2062 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002063 extraJars android.Paths) (localHeaderJars android.Paths, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002064
Jaewoong Jung26342642021-03-17 15:56:23 -07002065 if len(srcFiles) > 0 || len(srcJars) > 0 {
2066 // Compile java sources into turbine.jar.
2067 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
2068 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002069 localHeaderJars = append(localHeaderJars, turbineJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07002070 }
2071
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002072 localHeaderJars = append(localHeaderJars, extraJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002073
2074 // Combine any static header libraries into classes-header.jar. If there is only
2075 // one input jar this step will be skipped.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002076 var jars android.Paths
2077 if ctx.Config().UseTransitiveJarsInClasspath() {
2078 depSet := android.NewDepSet(android.PREORDER, localHeaderJars, deps.transitiveStaticLibsHeaderJars)
2079 jars = depSet.ToList()
2080 } else {
2081 jars = append(slices.Clone(localHeaderJars), deps.staticHeaderJars...)
2082 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002083
2084 // we cannot skip the combine step for now if there is only one jar
2085 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07002086 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
2087 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07002088 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07002089
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002090 return localHeaderJars, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07002091}
2092
2093func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07002094 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002095
2096 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07002097 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07002098
2099 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
2100
2101 j.jacocoReportClassesFile = jacocoReportClassesFile
2102
2103 return instrumentedJar
2104}
2105
Colin Cross9ffaf282024-08-12 13:50:09 -07002106type providesTransitiveHeaderJarsForR8 struct {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002107 // set of header jars for all transitive libs deps
Colin Cross9ffaf282024-08-12 13:50:09 -07002108 transitiveLibsHeaderJarsForR8 *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002109 // set of header jars for all transitive static libs deps
Colin Cross9ffaf282024-08-12 13:50:09 -07002110 transitiveStaticLibsHeaderJarsForR8 *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002111}
2112
Colin Cross9ffaf282024-08-12 13:50:09 -07002113// collectTransitiveHeaderJarsForR8 visits direct dependencies and collects all transitive libs and static_libs
2114// header jars. The semantics of the collected jars are odd (it collects combined jars that contain the static
2115// libs, but also the static libs, and it collects transitive libs dependencies of static_libs), so these
2116// are only used to expand the --lib arguments to R8.
2117func (j *providesTransitiveHeaderJarsForR8) collectTransitiveHeaderJarsForR8(ctx android.ModuleContext) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002118 directLibs := android.Paths{}
2119 directStaticLibs := android.Paths{}
Colin Crossc85750b2022-04-21 12:50:51 -07002120 transitiveLibs := []*android.DepSet[android.Path]{}
2121 transitiveStaticLibs := []*android.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002122 ctx.VisitDirectDeps(func(module android.Module) {
2123 // don't add deps of the prebuilt version of the same library
2124 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
2125 return
2126 }
2127
Colin Cross7727c7f2024-07-18 15:36:32 -07002128 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2129 tag := ctx.OtherModuleDependencyTag(module)
2130 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2131 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2132 directLibs = append(directLibs, dep.HeaderJars...)
2133 } else if tag == staticLibTag {
2134 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2135 } else {
2136 // Don't propagate transitive libs for other kinds of dependencies.
2137 return
2138 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002139
Colin Cross9ffaf282024-08-12 13:50:09 -07002140 if dep.TransitiveLibsHeaderJarsForR8 != nil {
2141 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJarsForR8)
Colin Cross7727c7f2024-07-18 15:36:32 -07002142 }
Colin Cross9ffaf282024-08-12 13:50:09 -07002143 if dep.TransitiveStaticLibsHeaderJarsForR8 != nil {
2144 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJarsForR8)
Colin Cross7727c7f2024-07-18 15:36:32 -07002145 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002146
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002147 }
2148 })
Colin Cross9ffaf282024-08-12 13:50:09 -07002149 j.transitiveLibsHeaderJarsForR8 = android.NewDepSet(android.POSTORDER, directLibs, transitiveLibs)
2150 j.transitiveStaticLibsHeaderJarsForR8 = android.NewDepSet(android.POSTORDER, directStaticLibs, transitiveStaticLibs)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002151}
2152
Jaewoong Jung26342642021-03-17 15:56:23 -07002153func (j *Module) HeaderJars() android.Paths {
2154 if j.headerJarFile == nil {
2155 return nil
2156 }
2157 return android.Paths{j.headerJarFile}
2158}
2159
2160func (j *Module) ImplementationJars() android.Paths {
2161 if j.implementationJarFile == nil {
2162 return nil
2163 }
2164 return android.Paths{j.implementationJarFile}
2165}
2166
Spandan Das59a4a2b2024-01-09 21:35:56 +00002167func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002168 return j.dexJarFile
2169}
2170
2171func (j *Module) DexJarInstallPath() android.Path {
2172 return j.installFile
2173}
2174
2175func (j *Module) ImplementationAndResourcesJars() android.Paths {
2176 if j.implementationAndResourcesJar == nil {
2177 return nil
2178 }
2179 return android.Paths{j.implementationAndResourcesJar}
2180}
2181
2182func (j *Module) AidlIncludeDirs() android.Paths {
2183 // exportAidlIncludeDirs is type android.Paths already
2184 return j.exportAidlIncludeDirs
2185}
2186
2187func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2188 return j.classLoaderContexts
2189}
2190
2191// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002192func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002193 // jarjar rules will repackage the sources. To prevent misleading results, IdeInfo should contain the
2194 // repackaged jar instead of the input sources.
Jaewoong Jung26342642021-03-17 15:56:23 -07002195 if j.expandJarjarRules != nil {
2196 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002197 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
2198 } else {
2199 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2200 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2201 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002202 }
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002203 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2204 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Yikef6282022022-04-13 20:41:01 +08002205 dpInfo.Static_libs = append(dpInfo.Static_libs, j.properties.Static_libs...)
2206 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002207}
2208
2209func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002210 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002211}
2212
2213func (j *Module) hasCode(ctx android.ModuleContext) bool {
2214 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2215 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2216}
2217
2218// Implements android.ApexModule
2219func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2220 return j.depIsInSameApex(ctx, dep)
2221}
2222
2223// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002224func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002225 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002226 minSdkVersion := j.MinSdkVersion(ctx)
2227 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002228 return fmt.Errorf("min_sdk_version is not specified")
2229 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002230 // If the module is compiling against core (via sdk_version), skip comparison check.
2231 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002232 return nil
2233 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002234 if minSdkVersion.GreaterThan(sdkVersion) {
2235 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002236 }
2237 return nil
2238}
2239
2240func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002241 if j.stem == "" {
2242 panic("Stem() called before stem property was set")
2243 }
2244 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002245}
2246
Jaewoong Jung26342642021-03-17 15:56:23 -07002247func (j *Module) JacocoReportClassesFile() android.Path {
2248 return j.jacocoReportClassesFile
2249}
2250
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002251func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
2252 var fromDeps []*android.DepSet[android.Path]
2253 ctx.VisitDirectDeps(func(module android.Module) {
2254 tag := ctx.OtherModuleDependencyTag(module)
2255 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002256 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2257 if depInfo.TransitiveSrcFiles != nil {
2258 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
2259 }
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002260 }
2261 }
2262 })
2263
2264 j.transitiveSrcFiles = android.NewDepSet(android.POSTORDER, mine, fromDeps)
2265}
2266
Jaewoong Jung26342642021-03-17 15:56:23 -07002267func (j *Module) IsInstallable() bool {
2268 return Bool(j.properties.Installable)
2269}
2270
2271type sdkLinkType int
2272
2273const (
2274 // TODO(jiyong) rename these for better readability. Make the allowed
2275 // and disallowed link types explicit
2276 // order is important here. See rank()
2277 javaCore sdkLinkType = iota
2278 javaSdk
2279 javaSystem
2280 javaModule
2281 javaSystemServer
2282 javaPlatform
2283)
2284
2285func (lt sdkLinkType) String() string {
2286 switch lt {
2287 case javaCore:
2288 return "core Java API"
2289 case javaSdk:
2290 return "Android API"
2291 case javaSystem:
2292 return "system API"
2293 case javaModule:
2294 return "module API"
2295 case javaSystemServer:
2296 return "system server API"
2297 case javaPlatform:
2298 return "private API"
2299 default:
2300 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2301 }
2302}
2303
2304// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2305// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2306// can't statically depend on modules that use Platform API.
2307func (lt sdkLinkType) rank() int {
2308 return int(lt)
2309}
2310
2311type moduleWithSdkDep interface {
2312 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002313 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002314}
2315
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002316func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2317 switch k {
2318 case android.SdkCore:
2319 return javaCore
2320 case android.SdkSystem:
2321 return javaSystem
2322 case android.SdkPublic:
2323 return javaSdk
2324 case android.SdkModule:
2325 return javaModule
2326 case android.SdkSystemServer:
2327 return javaSystemServer
2328 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2329 return javaPlatform
2330 default:
2331 return javaSdk
2332 }
2333}
2334
Jiyong Park92315372021-04-02 08:45:46 +09002335func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002336 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002337 case android.SdkCore.DefaultJavaLibraryName(),
2338 "legacy.core.platform.api.stubs",
2339 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002340 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002341 "core-lambda-stubs",
Jihoon Kangb5078312023-03-29 23:25:49 +00002342 "core-generated-annotation-stubs":
Jaewoong Jung26342642021-03-17 15:56:23 -07002343 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002344 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002345 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002346 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002347 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002348 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002349 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002350 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002351 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002352 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002353 return javaSystem, true
2354 }
2355
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002356 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002357 return linkType, true
2358 }
2359
Jiyong Park92315372021-04-02 08:45:46 +09002360 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002361 if !ver.Valid() {
2362 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002363 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002364
2365 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002366}
2367
2368// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2369// this module's. See the comment on rank() for details and an example.
2370func (j *Module) checkSdkLinkType(
2371 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2372 if ctx.Host() {
2373 return
2374 }
2375
Jiyong Park92315372021-04-02 08:45:46 +09002376 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002377 if stubs {
2378 return
2379 }
Jiyong Park92315372021-04-02 08:45:46 +09002380 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002381
2382 if myLinkType.rank() < depLinkType.rank() {
2383 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2384 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2385 "property of the source or target module so that target module is built "+
2386 "with the same or smaller API set when compared to the source.",
2387 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2388 }
2389}
2390
2391func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2392 var deps deps
2393
Jiyong Park92315372021-04-02 08:45:46 +09002394 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002395
Colin Cross9ffaf282024-08-12 13:50:09 -07002396 j.collectTransitiveHeaderJarsForR8(ctx)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002397
2398 var transitiveBootClasspathHeaderJars []*android.DepSet[android.Path]
2399 var transitiveClasspathHeaderJars []*android.DepSet[android.Path]
2400 var transitiveJava9ClasspathHeaderJars []*android.DepSet[android.Path]
2401 var transitiveStaticJarsHeaderLibs []*android.DepSet[android.Path]
2402 var transitiveStaticJarsImplementationLibs []*android.DepSet[android.Path]
2403 var transitiveStaticJarsResourceLibs []*android.DepSet[android.Path]
2404
Jaewoong Jung26342642021-03-17 15:56:23 -07002405 ctx.VisitDirectDeps(func(module android.Module) {
2406 otherName := ctx.OtherModuleName(module)
2407 tag := ctx.OtherModuleDependencyTag(module)
2408
2409 if IsJniDepTag(tag) {
2410 // Handled by AndroidApp.collectAppDeps
2411 return
2412 }
2413 if tag == certificateTag {
2414 // Handled by AndroidApp.collectAppDeps
2415 return
2416 }
2417
2418 if dep, ok := module.(SdkLibraryDependency); ok {
2419 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002420 case sdkLibTag, libTag:
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002421 depHeaderJars := dep.SdkHeaderJars(ctx, j.SdkVersion(ctx))
2422 deps.classpath = append(deps.classpath, depHeaderJars...)
2423 deps.dexClasspath = append(deps.dexClasspath, depHeaderJars...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002424
2425 // TODO: SDK libraries should export a provider with TransitiveClasspathHeaderJars
2426 depHeaderJarsSet := android.NewDepSet(android.PREORDER, depHeaderJars, nil)
2427 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJarsSet)
Jaewoong Jung26342642021-03-17 15:56:23 -07002428 case staticLibTag:
2429 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
2430 }
Colin Cross313aa542023-12-13 13:47:44 -08002431 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2432 if sdkLinkType != javaPlatform {
2433 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2434 // dep is a sysprop implementation library, but this module is not linking against
2435 // the platform, so it gets the sysprop public stubs library instead. Replace
2436 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2437 dep = syspropDep.JavaInfo
2438 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002439 }
2440 switch tag {
2441 case bootClasspathTag:
2442 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002443 if dep.TransitiveStaticLibsHeaderJars != nil {
2444 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2445 }
Liz Kammeref28a4c2022-09-23 16:50:56 -04002446 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002447 if _, ok := module.(*Plugin); ok {
2448 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2449 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002450 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002451 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002452 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2453 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2454 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2455 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002456 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2457 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2458 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002459
2460 if dep.TransitiveStaticLibsHeaderJars != nil {
2461 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2462 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002463 case java9LibTag:
2464 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002465 if dep.TransitiveStaticLibsHeaderJars != nil {
2466 transitiveJava9ClasspathHeaderJars = append(transitiveJava9ClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2467 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002468 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002469 if _, ok := module.(*Plugin); ok {
2470 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2471 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002472 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2473 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2474 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2475 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2476 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2477 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2478 // Turbine doesn't run annotation processors, so any module that uses an
2479 // annotation processor that generates API is incompatible with the turbine
2480 // optimization.
2481 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002482 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002483
2484 if dep.TransitiveStaticLibsHeaderJars != nil {
2485 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2486 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, dep.TransitiveStaticLibsHeaderJars)
2487 }
2488 if dep.TransitiveStaticLibsImplementationJars != nil {
2489 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, dep.TransitiveStaticLibsImplementationJars)
2490 }
2491 if dep.TransitiveStaticLibsResourceJars != nil {
2492 transitiveStaticJarsResourceLibs = append(transitiveStaticJarsResourceLibs, dep.TransitiveStaticLibsResourceJars)
2493 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002494 case pluginTag:
2495 if plugin, ok := module.(*Plugin); ok {
2496 if plugin.pluginProperties.Processor_class != nil {
2497 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2498 } else {
2499 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2500 }
2501 // Turbine doesn't run annotation processors, so any module that uses an
2502 // annotation processor that generates API is incompatible with the turbine
2503 // optimization.
2504 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2505 } else {
2506 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2507 }
2508 case errorpronePluginTag:
2509 if _, ok := module.(*Plugin); ok {
2510 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2511 } else {
2512 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2513 }
2514 case exportedPluginTag:
2515 if plugin, ok := module.(*Plugin); ok {
2516 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2517 if plugin.pluginProperties.Processor_class != nil {
2518 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2519 }
2520 // Turbine doesn't run annotation processors, so any module that uses an
2521 // annotation processor that generates API is incompatible with the turbine
2522 // optimization.
2523 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2524 } else {
2525 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2526 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002527 case kotlinPluginTag:
2528 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002529 case syspropPublicStubDepTag:
2530 // This is a sysprop implementation library, forward the JavaInfoProvider from
2531 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002532 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002533 JavaInfo: dep,
2534 })
2535 }
2536 } else if dep, ok := module.(android.SourceFileProducer); ok {
2537 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002538 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002539 checkProducesJars(ctx, dep)
2540 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002541 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002542 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars,
2543 android.NewDepSet(android.PREORDER, dep.Srcs(), nil))
Jaewoong Jung26342642021-03-17 15:56:23 -07002544 case staticLibTag:
2545 checkProducesJars(ctx, dep)
2546 deps.classpath = append(deps.classpath, dep.Srcs()...)
2547 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2548 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002549
2550 depHeaderJars := android.NewDepSet(android.PREORDER, dep.Srcs(), nil)
2551 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJars)
2552 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, depHeaderJars)
2553 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, depHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002554 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002555 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002556 switch tag {
2557 case staticLibTag:
2558 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2559 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002560 } else {
2561 switch tag {
2562 case bootClasspathTag:
2563 // If a system modules dependency has been added to the bootclasspath
2564 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002565 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002566 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars...)
2567 if sm.TransitiveStaticLibsHeaderJars != nil {
2568 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars,
2569 sm.TransitiveStaticLibsHeaderJars)
2570 }
Colin Crossb61c2262024-08-08 14:04:42 -07002571 } else {
2572 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2573 ctx.OtherModuleName(module))
2574 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002575
2576 case systemModulesTag:
2577 if deps.systemModules != nil {
2578 panic("Found two system module dependencies")
2579 }
Colin Crossb61c2262024-08-08 14:04:42 -07002580 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2581 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2582 } else {
2583 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2584 ctx.OtherModuleName(module))
2585 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002586
2587 case instrumentationForTag:
2588 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 -07002589 }
2590 }
2591
Spandan Das8aac9932024-07-18 23:14:13 +00002592 if android.InList(tag, compileDependencyTags) {
2593 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2594 j.compileDepNames = append(j.compileDepNames, otherName)
2595 }
2596
Jaewoong Jung26342642021-03-17 15:56:23 -07002597 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002598 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002599 })
2600
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002601 deps.transitiveStaticLibsHeaderJars = transitiveStaticJarsHeaderLibs
2602 deps.transitiveStaticLibsImplementationJars = transitiveStaticJarsImplementationLibs
2603 deps.transitiveStaticLibsResourceJars = transitiveStaticJarsResourceLibs
2604
2605 if ctx.Config().UseTransitiveJarsInClasspath() {
2606 depSet := android.NewDepSet(android.PREORDER, nil, transitiveClasspathHeaderJars)
2607 deps.classpath = depSet.ToList()
2608 depSet = android.NewDepSet(android.PREORDER, nil, transitiveBootClasspathHeaderJars)
2609 deps.bootClasspath = depSet.ToList()
2610 depSet = android.NewDepSet(android.PREORDER, nil, transitiveJava9ClasspathHeaderJars)
2611 deps.java9Classpath = depSet.ToList()
2612 }
2613
2614 if ctx.Device() {
2615 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
2616 if sdkDep.invalidVersion {
2617 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2618 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2619 } else if sdkDep.useFiles {
2620 // sdkDep.jar is actually equivalent to turbine header.jar.
2621 deps.classpath = append(slices.Clone(classpath(sdkDep.jars)), deps.classpath...)
2622 deps.dexClasspath = append(slices.Clone(classpath(sdkDep.jars)), deps.dexClasspath...)
2623 deps.aidlPreprocess = sdkDep.aidl
2624 // Add the sdk module dependency to `compileDepNames`.
2625 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2626 // TODO (b/358608607): Move this to decodeSdkDep
2627 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2628 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
2629 } else {
2630 deps.aidlPreprocess = sdkDep.aidl
2631 }
2632 }
2633
Jaewoong Jung26342642021-03-17 15:56:23 -07002634 return deps
2635}
2636
Joe Onorato349ae8d2024-02-05 22:46:00 +00002637// Provider for jarjar renaming rules.
2638//
2639// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2640// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2641// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2642// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2643// be renamed from that module.
2644// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002645type DependencyUse int
2646
2647const (
2648 RenameUseInvalid DependencyUse = iota
2649 RenameUseInclude
2650 RenameUseExclude
2651)
2652
2653type RenameUseElement struct {
2654 DepName string
2655 RenameUse DependencyUse
2656 Why string // token for determining where in the logic the decision was made.
2657}
2658
Joe Onorato349ae8d2024-02-05 22:46:00 +00002659type JarJarProviderData struct {
2660 // Mapping of class names: original --> renamed. If the value is "", the class will be
2661 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2662 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002663 Rename map[string]string
2664 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002665}
2666
2667func (this JarJarProviderData) GetDebugString() string {
2668 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002669 for _, k := range android.SortedKeys(this.Rename) {
2670 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002671 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2672 result += k + "--&gt;" + v + ";"
2673 }
2674 }
2675 return result
2676}
2677
2678var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2679
2680var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2681
2682func init() {
2683 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
Yu Liu26a716d2024-08-30 23:40:32 +00002684
2685 gob.Register(BaseJarJarProviderData{})
Joe Onorato349ae8d2024-02-05 22:46:00 +00002686}
2687
2688// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2689// whether they are java modules or not.
2690type BaseJarJarProviderData struct {
2691 JarJarProviderData JarJarProviderData
2692}
2693
2694func (this BaseJarJarProviderData) GetDebugString() string {
2695 return this.JarJarProviderData.GetDebugString()
2696}
2697
2698var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2699
2700// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2701// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2702// either JarJarProvider or BaseJarJarProvider.
2703func mergeJarJarPrefixes(ctx android.ModuleContext) {
2704 mod := ctx.Module()
2705 // Explicitly avoid propagating into some module types.
2706 switch reflect.TypeOf(mod).String() {
2707 case "*java.Droidstubs":
2708 return
2709 }
2710 jarJarData := collectDirectDepsProviders(ctx)
2711 if jarJarData != nil {
2712 providerData := BaseJarJarProviderData{
2713 JarJarProviderData: *jarJarData,
2714 }
2715 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2716 }
2717
2718}
2719
2720// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2721func (module *Module) addJarJarRenameRule(original string, renamed string) {
2722 if module.jarjarRenameRules == nil {
2723 module.jarjarRenameRules = make(map[string]string)
2724 }
2725 module.jarjarRenameRules[original] = renamed
2726}
2727
2728func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2729 // Gather repackage information from deps
2730 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002731
2732 module := ctx.Module()
2733 moduleName := module.Name()
2734
Joe Onorato349ae8d2024-02-05 22:46:00 +00002735 ctx.VisitDirectDepsIgnoreBlueprint(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002736 tag := ctx.OtherModuleDependencyTag(m)
2737 // This logic mirrors that in (*Module).collectDeps above. There are several places
2738 // where we explicitly return RenameUseExclude, even though it is the default, to
2739 // indicate that it has been verified to be the case.
2740 //
2741 // Note well: there are probably cases that are getting to the unconditional return
2742 // and are therefore wrong.
2743 shouldIncludeRenames := func() (DependencyUse, string) {
2744 if moduleName == m.Name() {
2745 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2746 }
2747 if sc, ok := module.(android.SdkContext); ok {
2748 if ctx.Device() {
2749 sdkDep := decodeSdkDep(ctx, sc)
2750 if !sdkDep.invalidVersion && sdkDep.useFiles {
2751 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002752 }
2753 }
LaMont Jones63683e42024-02-08 14:30:45 -08002754 }
2755 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2756 return RenameUseExclude, "tags"
2757 }
2758 if _, ok := m.(SdkLibraryDependency); ok {
2759 switch tag {
2760 case sdkLibTag, libTag:
2761 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2762 }
2763 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2764 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2765 switch ji.StubsLinkType {
2766 case Stubs:
2767 return RenameUseExclude, "info"
2768 case Implementation:
2769 return RenameUseInclude, "info"
2770 default:
LaMont Jones09721862024-06-11 10:30:50 -07002771 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002772 // Fall through to the heuristic logic.
2773 }
2774 switch reflect.TypeOf(m).String() {
2775 case "*java.GeneratedJavaLibraryModule":
2776 // Probably a java_aconfig_library module.
2777 // TODO: make this check better.
2778 return RenameUseInclude, "reflect"
2779 }
2780 switch tag {
2781 case bootClasspathTag:
2782 return RenameUseExclude, "tagswitch"
2783 case sdkLibTag, libTag, instrumentationForTag:
2784 return RenameUseInclude, "tagswitch"
2785 case java9LibTag:
2786 return RenameUseExclude, "tagswitch"
2787 case staticLibTag:
2788 return RenameUseInclude, "tagswitch"
2789 case pluginTag:
2790 return RenameUseInclude, "tagswitch"
2791 case errorpronePluginTag:
2792 return RenameUseInclude, "tagswitch"
2793 case exportedPluginTag:
2794 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002795 case kotlinPluginTag:
2796 return RenameUseInclude, "tagswitch"
2797 default:
2798 return RenameUseExclude, "tagswitch"
2799 }
2800 } else if _, ok := m.(android.SourceFileProducer); ok {
2801 switch tag {
2802 case sdkLibTag, libTag, staticLibTag:
2803 return RenameUseInclude, "srcfile"
2804 default:
2805 return RenameUseExclude, "srcfile"
2806 }
Yu Liu67a28422024-03-05 00:36:31 +00002807 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002808 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002809 } else {
2810 switch tag {
2811 case bootClasspathTag:
2812 return RenameUseExclude, "else"
2813 case systemModulesTag:
2814 return RenameUseInclude, "else"
2815 }
2816 }
2817 // If we got here, choose the safer option, which may lead to a build failure, rather
2818 // than runtime failures on the device.
2819 return RenameUseExclude, "end"
2820 }
2821
2822 if result == nil {
2823 result = &JarJarProviderData{
2824 Rename: make(map[string]string),
2825 RenameUse: make([]RenameUseElement, 0),
2826 }
2827 }
2828 how, why := shouldIncludeRenames()
2829 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2830 if how != RenameUseInclude {
2831 // Nothing to merge.
2832 return
2833 }
2834
2835 merge := func(theirs *JarJarProviderData) {
2836 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002837 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2838 result.Rename[orig] = renamed
2839 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2840 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2841 result.Rename[orig] = renamed
2842 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2843 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2844 continue
2845 }
2846 }
2847 }
2848 }
2849 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2850 merge(&theirs)
2851 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2852 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2853 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2854 // to java.Module.
2855 merge(&theirs.JarJarProviderData)
2856 }
2857 })
2858 return
2859}
2860
2861func (this Module) GetDebugString() string {
2862 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2863}
2864
2865// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2866// us, and if it's been set, apply the jarjar_prefix property to rename them.
2867func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2868 // Gather repackage information from deps
2869 result := collectDirectDepsProviders(ctx)
2870
Joe Onoratoa5d17172024-07-20 17:39:56 -07002871 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002872 if result == nil {
2873 result = &JarJarProviderData{
2874 Rename: make(map[string]string),
2875 }
2876 }
2877 if renamed != "" {
2878 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2879 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002880 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002881 }
2882 }
2883 (*result).Rename[orig] = renamed
2884 }
2885
Joe Onoratoa5d17172024-07-20 17:39:56 -07002886 // Update that with entries we've stored for ourself
2887 for orig, renamed := range module.jarjarRenameRules {
2888 add(orig, renamed)
2889 }
2890
2891 // Update that with entries given in the jarjar_rename property.
2892 for _, orig := range module.properties.Jarjar_rename {
2893 add(orig, "")
2894 }
2895
Joe Onorato349ae8d2024-02-05 22:46:00 +00002896 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2897 if result == nil {
2898 return nil
2899 }
2900
2901 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2902 // that have not yet been renamed.
2903 prefix := proptools.String(module.properties.Jarjar_prefix)
2904 if prefix != "" {
2905 if prefix[0] == '.' {
2906 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2907 return nil
2908 }
2909 if prefix[len(prefix)-1] == '.' {
2910 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2911 return nil
2912 }
2913
2914 var updated map[string]string
2915 for orig, renamed := range (*result).Rename {
2916 if renamed == "" {
2917 if updated == nil {
2918 updated = make(map[string]string)
2919 }
2920 updated[orig] = prefix + "." + orig
2921 }
2922 }
2923 for orig, renamed := range updated {
2924 (*result).Rename[orig] = renamed
2925 }
2926 }
2927
2928 return result
2929}
2930
2931// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2932// to "" won't be in this list because they shouldn't be renamed yet.
2933func getJarJarRuleText(provider *JarJarProviderData) string {
2934 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002935 for _, orig := range android.SortedKeys(provider.Rename) {
2936 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002937 if renamed != "" {
2938 result += "rule " + orig + " " + renamed + "\n"
2939 }
2940 }
2941 return result
2942}
2943
Zi Wangddb2ee52024-04-02 16:44:02 +00002944// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002945func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Zi Wangddb2ee52024-04-02 16:44:02 +00002946 if j.repackageJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002947 return infile, false
Zi Wangddb2ee52024-04-02 16:44:02 +00002948 }
Colin Crossedec77c2024-07-26 15:25:40 -07002949 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002950 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002951 return repackagedJarjarFile, true
Zi Wangddb2ee52024-04-02 16:44:02 +00002952}
2953
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002954func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Colin Crossedec77c2024-07-26 15:25:40 -07002955 if j.expandJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002956 return infile, false
Colin Crossedec77c2024-07-26 15:25:40 -07002957 }
2958 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2959 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002960 return jarjarFile, true
Colin Crossedec77c2024-07-26 15:25:40 -07002961
2962}
2963
Jaewoong Jung26342642021-03-17 15:56:23 -07002964func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2965 deps.processorPath = append(deps.processorPath, pluginJars...)
2966 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2967}
2968
2969// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2970// this interface.
2971type ProvidesUsesLib interface {
2972 ProvidesUsesLib() *string
2973}
2974
2975func (j *Module) ProvidesUsesLib() *string {
2976 return j.usesLibraryProperties.Provides_uses_lib
2977}
satayev1c564cc2021-05-25 19:50:30 +01002978
2979type ModuleWithStem interface {
2980 Stem() string
2981}
2982
2983var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002984
2985type ModuleWithUsesLibrary interface {
2986 UsesLibrary() *usesLibrary
2987}
2988
2989func (j *Module) UsesLibrary() *usesLibrary {
2990 return &j.usesLibrary
2991}
2992
2993var _ ModuleWithUsesLibrary = (*Module)(nil)