blob: 102d4eada647624696676a1b810de9cd4091f4bc [file] [log] [blame]
Jaewoong Jung26342642021-03-17 15:56:23 -07001// Copyright 2021 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package java
16
17import (
Yu Liu26a716d2024-08-30 23:40:32 +000018 "encoding/gob"
Jaewoong Jung26342642021-03-17 15:56:23 -070019 "fmt"
20 "path/filepath"
Joe Onorato349ae8d2024-02-05 22:46:00 +000021 "reflect"
22 "slices"
Jaewoong Jung26342642021-03-17 15:56:23 -070023 "strconv"
24 "strings"
25
Colin Crossd788b3e2023-11-28 13:14:56 -080026 "github.com/google/blueprint"
Jaewoong Jung26342642021-03-17 15:56:23 -070027 "github.com/google/blueprint/pathtools"
28 "github.com/google/blueprint/proptools"
29
30 "android/soong/android"
31 "android/soong/dexpreopt"
32 "android/soong/java/config"
33)
34
35// This file contains the definition and the implementation of the base module that most
36// source-based Java module structs embed.
37
38// TODO:
39// Autogenerated files:
40// Renderscript
41// Post-jar passes:
42// Proguard
43// Rmtypedefs
44// DroidDoc
45// Findbugs
46
47// Properties that are common to most Java modules, i.e. whether it's a host or device module.
48type CommonProperties struct {
49 // list of source files used to compile the Java module. May be .java, .kt, .logtags, .proto,
50 // or .aidl files.
51 Srcs []string `android:"path,arch_variant"`
52
53 // list Kotlin of source files containing Kotlin code that should be treated as common code in
54 // a codebase that supports Kotlin multiplatform. See
55 // https://kotlinlang.org/docs/reference/multiplatform.html. May be only be .kt files.
56 Common_srcs []string `android:"path,arch_variant"`
57
58 // list of source files that should not be used to build the Java module.
59 // This is most useful in the arch/multilib variants to remove non-common files
60 Exclude_srcs []string `android:"path,arch_variant"`
61
62 // list of directories containing Java resources
63 Java_resource_dirs []string `android:"arch_variant"`
64
65 // list of directories that should be excluded from java_resource_dirs
66 Exclude_java_resource_dirs []string `android:"arch_variant"`
67
68 // list of files to use as Java resources
69 Java_resources []string `android:"path,arch_variant"`
70
71 // list of files that should be excluded from java_resources and java_resource_dirs
72 Exclude_java_resources []string `android:"path,arch_variant"`
73
74 // list of module-specific flags that will be used for javac compiles
75 Javacflags []string `android:"arch_variant"`
76
77 // list of module-specific flags that will be used for kotlinc compiles
78 Kotlincflags []string `android:"arch_variant"`
79
80 // list of java libraries that will be in the classpath
81 Libs []string `android:"arch_variant"`
82
83 // list of java libraries that will be compiled into the resulting jar
Cole Faustb7493472024-08-28 11:55:52 -070084 Static_libs proptools.Configurable[[]string] `android:"arch_variant"`
Jaewoong Jung26342642021-03-17 15:56:23 -070085
Jihoon Kang381c2fa2023-06-01 22:17:32 +000086 // list of java libraries that should not be used to build this module
87 Exclude_static_libs []string `android:"arch_variant"`
88
Jaewoong Jung26342642021-03-17 15:56:23 -070089 // manifest file to be included in resulting jar
90 Manifest *string `android:"path"`
91
92 // if not blank, run jarjar using the specified rules file
93 Jarjar_rules *string `android:"path,arch_variant"`
94
Joe Onoratoa5d17172024-07-20 17:39:56 -070095 // java class names to rename with jarjar when a reverse dependency has a jarjar_prefix
96 // property.
97 Jarjar_rename []string
98
Joe Onorato349ae8d2024-02-05 22:46:00 +000099 // if not blank, used as prefix to generate repackage rule
100 Jarjar_prefix *string
101
Jaewoong Jung26342642021-03-17 15:56:23 -0700102 // If not blank, set the java version passed to javac as -source and -target
103 Java_version *string
104
105 // If set to true, allow this module to be dexed and installed on devices. Has no
106 // effect on host modules, which are always considered installable.
107 Installable *bool
108
109 // If set to true, include sources used to compile the module in to the final jar
110 Include_srcs *bool
111
112 // If not empty, classes are restricted to the specified packages and their sub-packages.
113 // This restriction is checked after applying jarjar rules and including static libs.
114 Permitted_packages []string
115
116 // List of modules to use as annotation processors
117 Plugins []string
118
Luca Stefania3efe922024-10-12 17:55:31 +0200119 // List of modules to use as kotlin plugin
120 Kotlin_plugins []string
121
Jaewoong Jung26342642021-03-17 15:56:23 -0700122 // 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
Spandan Das1028d5a2024-08-19 21:45:48 +0000541 kytheFiles android.Paths
542 kytheKotlinFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700543
Jaewoong Jung26342642021-03-17 15:56:23 -0700544 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900545
546 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000547 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000548 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400549
550 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000551
552 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000553
554 // output file name based on Stem property.
555 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
556 // or the module should override Stem().
557 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700558
Joe Onorato349ae8d2024-02-05 22:46:00 +0000559 // Values that will be set in the JarJarProvider data for jarjar repackaging,
560 // and merged with our dependencies' rules.
561 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000562
563 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000564
565 // Paths to the aconfig intermediate cache files that are provided by the
566 // java_aconfig_library or java_library modules that are statically linked
567 // to this module. Does not contain cache files from all transitive dependencies.
568 aconfigCacheFiles android.Paths
Spandan Das8aac9932024-07-18 23:14:13 +0000569
570 // List of soong module dependencies required to compile the current module.
571 // This information is printed out to `Dependencies` field in module_bp_java_deps.json
572 compileDepNames []string
Makoto Onuki7ded3822024-03-28 14:42:20 -0700573
574 ravenizer struct {
575 enabled bool
576 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700577}
578
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000579var _ android.InstallableModule = (*Module)(nil)
580
581// To satisfy the InstallableModule interface
Jihoon Kang224ea082024-08-12 22:38:16 +0000582func (j *Module) StaticDependencyTags() []blueprint.DependencyTag {
583 return []blueprint.DependencyTag{staticLibTag}
584}
585
586// To satisfy the InstallableModule interface
587func (j *Module) DynamicDependencyTags() []blueprint.DependencyTag {
588 return []blueprint.DependencyTag{libTag, sdkLibTag, bootClasspathTag, systemModulesTag,
589 instrumentationForTag, java9LibTag}
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000590}
591
592// Overrides android.ModuleBase.InstallInProduct()
593func (j *Module) InstallInProduct() bool {
594 return j.ProductSpecific()
595}
596
Jihoon Kang85bc1932024-07-01 17:04:46 +0000597var _ android.StubsAvailableModule = (*Module)(nil)
598
599// To safisfy the StubsAvailableModule interface
600func (j *Module) IsStubsModule() bool {
601 return proptools.Bool(j.properties.Is_stubs_module)
602}
603
Jiyong Park92315372021-04-02 08:45:46 +0900604func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
605 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900606 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700607 return nil
608 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900609 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000610 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700611 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
612 } else {
613 // Treat stable core platform as stable.
614 return nil
615 }
616 } else {
617 return fmt.Errorf("non stable SDK %v", sdkVersion)
618 }
619}
620
621// checkSdkVersions enforces restrictions around SDK dependencies.
622func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
623 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900624 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900625 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700626 ctx.PropertyErrorf("sdk_version",
627 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
628 }
629 }
630 }
631
632 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
633 // See rank() for details.
634 ctx.VisitDirectDeps(func(module android.Module) {
635 tag := ctx.OtherModuleDependencyTag(module)
636 switch module.(type) {
637 // TODO(satayev): cover other types as well, e.g. imports
638 case *Library, *AndroidLibrary:
639 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400640 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700641 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
642 }
643 }
644 })
645}
646
647func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900648 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700649 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900650 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700651 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000652 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 -0700653 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000654 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 -0700655 }
656
657 }
658}
659
Mark Whitea15790a2023-08-22 21:28:11 +0000660func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
661 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400662 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000663 installable := proptools.Bool(j.properties.Installable)
664
665 if headersOnly && installable {
666 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.")
667 }
668 }
669}
670
Jaewoong Jung26342642021-03-17 15:56:23 -0700671func (j *Module) addHostProperties() {
672 j.AddProperties(
673 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000674 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700675 &j.protoProperties,
676 &j.usesLibraryProperties,
677 )
678}
679
680func (j *Module) addHostAndDeviceProperties() {
681 j.addHostProperties()
682 j.AddProperties(
683 &j.deviceProperties,
684 &j.dexer.dexProperties,
685 &j.dexpreoptProperties,
686 &j.linter.properties,
687 )
688}
689
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000690// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
691// makes it available through the hiddenAPIPropertyInfoProvider.
692func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
693 hiddenAPIInfo := newHiddenAPIPropertyInfo()
694
695 // Populate with flag file paths from the properties.
696 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
697
698 // Populate with package rules from the properties.
699 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
700
Colin Cross40213022023-12-13 15:19:49 -0800701 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000702}
703
mrziwang9f7b9f42024-07-10 12:18:06 -0700704// helper method for java modules to set OutputFilesProvider
705func setOutputFiles(ctx android.ModuleContext, m Module) {
706 ctx.SetOutputFiles(append(android.Paths{m.outputFile}, m.extraOutputFiles...), "")
707 ctx.SetOutputFiles(android.Paths{m.outputFile}, android.DefaultDistTag)
708 ctx.SetOutputFiles(android.Paths{m.implementationAndResourcesJar}, ".jar")
709 ctx.SetOutputFiles(android.Paths{m.headerJarFile}, ".hjar")
710 if m.dexer.proguardDictionary.Valid() {
711 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
712 }
713 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
714 if m.linter.outputs.xml != nil {
715 ctx.SetOutputFiles(android.Paths{m.linter.outputs.xml}, ".lint")
Jaewoong Jung26342642021-03-17 15:56:23 -0700716 }
717}
718
Jaewoong Jung26342642021-03-17 15:56:23 -0700719func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
720 initJavaModule(module, hod, false)
721}
722
723func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
724 initJavaModule(module, hod, true)
725}
726
727func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
728 multilib := android.MultilibCommon
729 if multiTargets {
730 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
731 } else {
732 android.InitAndroidArchModule(module, hod, multilib)
733 }
734 android.InitDefaultableModule(module)
735}
736
737func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
738 return j.properties.Instrument &&
739 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
740 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
741}
742
Yihan Dong8be09c22024-08-29 15:32:13 +0800743func (j *Module) shouldApiMapper() bool {
744 return j.properties.ApiMapper
745}
746
Jaewoong Jung26342642021-03-17 15:56:23 -0700747func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000748 return j.properties.Supports_static_instrumentation &&
749 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700750 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
751 ctx.Config().UnbundledBuild())
752}
753
754func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
755 // Force enable the instrumentation for java code that is built for APEXes ...
756 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
757 // 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 -0800758 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700759 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000760
Jihoon Kang46d66de2024-05-22 22:42:39 +0000761 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700762 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
763 return true
764 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
765 return true
766 }
767 }
768 return false
769}
770
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400771func (j *Module) setInstrument(value bool) {
772 j.properties.Instrument = value
773}
774
Yihan Dong8be09c22024-08-29 15:32:13 +0800775func (j *Module) setApiMapper(value bool) {
776 j.properties.ApiMapper = value
777}
778
Jiyong Park92315372021-04-02 08:45:46 +0900779func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
780 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700781}
782
Jiyong Parkf1691d22021-03-29 20:11:58 +0900783func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700784 return proptools.String(j.deviceProperties.System_modules)
785}
786
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000787func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000788 if j.overridableProperties.Min_sdk_version != nil {
789 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700790 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000791 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700792}
793
Yu Liuf2b94012023-09-19 15:09:10 -0700794func (j *Module) GetDeviceProperties() *DeviceProperties {
795 return &j.deviceProperties
796}
797
Spandan Dasa26eda72023-03-02 00:56:06 +0000798func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
799 if j.deviceProperties.Max_sdk_version != nil {
800 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
801 }
802 // Default is PrivateApiLevel
803 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000804}
805
Spandan Dasa26eda72023-03-02 00:56:06 +0000806func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
807 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
808 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
809 }
810 // Default is PrivateApiLevel
811 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000812}
813
Jiyong Parkf1691d22021-03-29 20:11:58 +0900814func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000815 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900816}
817
Spandan Dasca70fc42023-03-01 23:38:49 +0000818func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900819 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000820 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900821 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000822 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700823}
824
825func (j *Module) AvailableFor(what string) bool {
826 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
827 // Exception: for hostdex: true libraries, the platform variant is created
828 // even if it's not marked as available to platform. In that case, the platform
829 // variant is used only for the hostdex and not installed to the device.
830 return true
831 }
832 return j.ApexModuleBase.AvailableFor(what)
833}
834
Cole Faustb7493472024-08-28 11:55:52 -0700835func (j *Module) staticLibs(ctx android.BaseModuleContext) []string {
836 return android.RemoveListFromList(j.properties.Static_libs.GetOrDefault(ctx, nil), j.properties.Exclude_static_libs)
837}
838
Jaewoong Jung26342642021-03-17 15:56:23 -0700839func (j *Module) deps(ctx android.BottomUpMutatorContext) {
840 if ctx.Device() {
841 j.linter.deps(ctx)
842
Jiyong Parkf1691d22021-03-29 20:11:58 +0900843 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700844
845 if j.deviceProperties.SyspropPublicStub != "" {
846 // This is a sysprop implementation library that has a corresponding sysprop public
847 // stubs library, and a dependency on it so that dependencies on the implementation can
848 // be forwarded to the public stubs library when necessary.
849 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
850 }
851 }
852
853 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000854
Cole Faustb7493472024-08-28 11:55:52 -0700855 ctx.AddVariationDependencies(nil, staticLibTag, j.staticLibs(ctx)...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700856
857 // Add dependency on libraries that provide additional hidden api annotations.
858 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
859
Kiyoung Kim9743bab2024-03-28 15:44:56 +0900860 if ctx.Config().EnforceInterPartitionJavaSdkLibrary() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700861 // Require java_sdk_library at inter-partition java dependency to ensure stable
862 // interface between partitions. If inter-partition java_library dependency is detected,
863 // raise build error because java_library doesn't have a stable interface.
864 //
865 // Inputs:
866 // PRODUCT_ENFORCE_INTER_PARTITION_JAVA_SDK_LIBRARY
867 // if true, enable enforcement
868 // PRODUCT_INTER_PARTITION_JAVA_LIBRARY_ALLOWLIST
869 // exception list of java_library names to allow inter-partition dependency
870 for idx := range j.properties.Libs {
871 if libDeps[idx] == nil {
872 continue
873 }
874
875 if javaDep, ok := libDeps[idx].(javaSdkLibraryEnforceContext); ok {
876 // java_sdk_library is always allowed at inter-partition dependency.
877 // So, skip check.
878 if _, ok := javaDep.(*SdkLibrary); ok {
879 continue
880 }
881
882 j.checkPartitionsForJavaDependency(ctx, "libs", javaDep)
883 }
884 }
885 }
886
887 // For library dependencies that are component libraries (like stubs), add the implementation
888 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
889 for _, dep := range libDeps {
890 if dep != nil {
891 if component, ok := dep.(SdkLibraryComponentDependency); ok {
892 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000893 // Add library as optional if it's one of the optional compatibility libs or it's
894 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100895 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000896 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
897 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100898 tag = usesLibOptTag
899 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100900 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700901 }
902 }
903 }
904 }
905
906 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Luca Stefania3efe922024-10-12 17:55:31 +0200907 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag, j.properties.Kotlin_plugins...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700908 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
909 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
910
911 android.ProtoDeps(ctx, &j.protoProperties)
912 if j.hasSrcExt(".proto") {
913 protoDeps(ctx, &j.protoProperties)
914 }
915
916 if j.hasSrcExt(".kt") {
917 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
918 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700919 tag := staticLibTag
920 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
921 tag = libTag
922 }
923 ctx.AddVariationDependencies(nil, tag,
924 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700925 }
926
927 // Framework libraries need special handling in static coverage builds: they should not have
928 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
929 // the same jacoco classes coming from different bootclasspath jars.
930 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
931 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
932 j.properties.Instrument = true
933 }
934 } else if j.shouldInstrumentStatic(ctx) {
935 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
936 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700937
Cole Faustb7493472024-08-28 11:55:52 -0700938 if j.useCompose(ctx) {
Colin Crossa1ff7c62021-09-17 14:11:52 -0700939 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
Luca Stefania3efe922024-10-12 17:55:31 +0200940 "androidx.compose.compiler_compiler-hosted-plugin")
Colin Crossa1ff7c62021-09-17 14:11:52 -0700941 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700942}
943
944func hasSrcExt(srcs []string, ext string) bool {
945 for _, src := range srcs {
946 if filepath.Ext(src) == ext {
947 return true
948 }
949 }
950
951 return false
952}
953
954func (j *Module) hasSrcExt(ext string) bool {
955 return hasSrcExt(j.properties.Srcs, ext)
956}
957
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100958func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
959 var flags string
960
961 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
962 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
963 flags = "-Wmissing-permission-annotation -Werror"
964 }
965 }
966 return flags
967}
968
Jaewoong Jung26342642021-03-17 15:56:23 -0700969func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000970 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700971
972 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
973 aidlIncludes = append(aidlIncludes,
974 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
975 aidlIncludes = append(aidlIncludes,
976 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
977
978 var flags []string
979 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000980 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700981
982 flags = append(flags, j.deviceProperties.Aidl.Flags...)
983
984 if aidlPreprocess.Valid() {
985 flags = append(flags, "-p"+aidlPreprocess.String())
986 deps = append(deps, aidlPreprocess.Path())
987 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000988 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700989 }
990
991 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000992 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700993 }
994
995 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000996 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700997 }
998
Sam Delmerico2351eac2022-05-24 17:10:02 +0000999 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -07001000 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +00001001 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -07001002 }
Sam Delmerico2351eac2022-05-24 17:10:02 +00001003 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
1004 // add flags for dirs containing AIDL srcs that haven't been specified yet
1005 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -07001006
Zim8774ae12022-08-17 11:46:34 +01001007 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +00001008 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +01001009 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001010 flags = append(flags, "-t")
1011 }
1012
1013 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
1014 flags = append(flags, "--transaction_names")
1015 }
1016
Thiébaud Weksteende8417c2022-02-10 15:41:46 +11001017 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
1018 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
1019 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1020 }
1021
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001022 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001023 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1024
Jaewoong Jung26342642021-03-17 15:56:23 -07001025 return strings.Join(flags, " "), deps
1026}
1027
1028func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1029
1030 var flags javaBuilderFlags
1031
1032 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001033 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001034
Cole Faust2b1536e2021-06-18 12:25:54 -07001035 epEnabled := j.properties.Errorprone.Enabled
1036 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001037 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001038 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1039 }
1040
1041 errorProneFlags := []string{
1042 "-Xplugin:ErrorProne",
1043 "${config.ErrorProneChecks}",
1044 }
1045 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1046
Colin Cross8bf6cad2022-02-28 13:07:03 -08001047 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001048 "'" + strings.Join(errorProneFlags, " ") + "'"
1049 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1050 }
1051
1052 // classpath
1053 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1054 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001055 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001056 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1057 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1058 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1059
1060 flags.processors = append(flags.processors, deps.processorClasses...)
1061 flags.processors = android.FirstUniqueStrings(flags.processors)
1062
1063 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001064 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001065 // Give host-side tools a version of OpenJDK's standard libraries
1066 // close to what they're targeting. As of Dec 2017, AOSP is only
1067 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1068 //
1069 // When building with OpenJDK 8, the following should have no
1070 // effect since those jars would be available by default.
1071 //
1072 // When building with OpenJDK 9 but targeting a version < 1.8,
1073 // putting them on the bootclasspath means that:
1074 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1075 // b) references to existing APIs are not reinterpreted in an
1076 // OpenJDK 9-specific way, eg. calls to subclasses of
1077 // java.nio.Buffer as in http://b/70862583
1078 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1079 flags.bootClasspath = append(flags.bootClasspath,
1080 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1081 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1082 if Bool(j.properties.Use_tools_jar) {
1083 flags.bootClasspath = append(flags.bootClasspath,
1084 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1085 }
1086 }
1087
1088 // systemModules
1089 flags.systemModules = deps.systemModules
1090
Jaewoong Jung26342642021-03-17 15:56:23 -07001091 return flags
1092}
1093
1094func (j *Module) collectJavacFlags(
1095 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1096 // javac flags.
1097 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001098 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001099
Mythri Alle4b9f6182023-10-25 15:17:11 +00001100 needsDebugInfo = false
1101 for _, flag := range javacFlags {
1102 if strings.HasPrefix(flag, "-g") {
1103 needsDebugInfo = true
1104 }
1105 }
1106
1107 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001108 // For non-host binaries, override the -g flag passed globally to remove
1109 // local variable debug info to reduce disk and memory usage.
1110 javacFlags = append(javacFlags, "-g:source,lines")
1111 }
1112 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1113
1114 if flags.javaVersion.usesJavaModules() {
1115 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001116 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1117 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1118 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1119 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001120
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001121 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001122 if j.properties.Patch_module != nil {
1123 // Manually specify build directory in case it is not under the repo root.
1124 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1125 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001126 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001127
Jaewoong Jung26342642021-03-17 15:56:23 -07001128 classPath := flags.classpath.FormJavaClassPath("")
1129 if classPath != "" {
1130 patchPaths = append(patchPaths, classPath)
1131 }
1132 javacFlags = append(
1133 javacFlags,
1134 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1135 }
1136 }
1137
1138 if len(javacFlags) > 0 {
1139 // optimization.
1140 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1141 flags.javacFlags = "$javacFlags"
1142 }
1143
1144 return flags
1145}
1146
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001147func (j *Module) AddJSONData(d *map[string]interface{}) {
1148 (&j.ModuleBase).AddJSONData(d)
1149 (*d)["Java"] = map[string]interface{}{
1150 "SourceExtensions": j.sourceExtensions,
1151 }
1152
1153}
1154
usta0391ca42023-09-19 15:51:59 -04001155func (j *Module) addGeneratedSrcJars(path android.Path) {
1156 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001157}
1158
Colin Crossfdaa6722024-08-23 11:58:08 -07001159func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars, extraDepCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001160 // Auto-propagating jarjar rules
1161 jarjarProviderData := j.collectJarJarRules(ctx)
1162 if jarjarProviderData != nil {
1163 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wangddb2ee52024-04-02 16:44:02 +00001164 text := getJarJarRuleText(jarjarProviderData)
1165 if text != "" {
1166 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1167 android.WriteFileRule(ctx, ruleTextFile, text)
1168 j.repackageJarjarRules = ruleTextFile
Joe Onorato349ae8d2024-02-05 22:46:00 +00001169 }
1170 }
1171
Jaewoong Jung26342642021-03-17 15:56:23 -07001172 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1173
Makoto Onuki7ded3822024-03-28 14:42:20 -07001174 if re := proptools.Bool(j.properties.Ravenizer.Enabled); re {
1175 j.ravenizer.enabled = re
1176 }
1177
Jaewoong Jung26342642021-03-17 15:56:23 -07001178 deps := j.collectDeps(ctx)
1179 flags := j.collectBuilderFlags(ctx, deps)
1180
1181 if flags.javaVersion.usesJavaModules() {
1182 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001183 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1184 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1185 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001186 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001187
Jaewoong Jung26342642021-03-17 15:56:23 -07001188 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001189 j.sourceExtensions = []string{}
1190 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1191 if hasSrcExt(srcFiles.Strings(), ext) {
1192 j.sourceExtensions = append(j.sourceExtensions, ext)
1193 }
1194 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001195 if hasSrcExt(srcFiles.Strings(), ".proto") {
1196 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1197 }
1198
1199 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1200 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1201 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1202 }
1203
Sam Delmerico2351eac2022-05-24 17:10:02 +00001204 aidlSrcs := srcFiles.FilterByExt(".aidl")
1205 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1206
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001207 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001208 srcFiles = j.genSources(ctx, srcFiles, flags)
1209
1210 // Collect javac flags only after computing the full set of srcFiles to
1211 // ensure that the --patch-module lookup paths are complete.
1212 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1213
1214 srcJars := srcFiles.FilterByExt(".srcjar")
1215 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001216 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001217 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001218 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001219
1220 if j.properties.Jarjar_rules != nil {
1221 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1222 }
1223
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001224 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001225
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001226 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001227 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001228 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001229 if _, found := set[v.String()]; !found {
1230 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001231 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001232 }
1233 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001234 var uniqueKtFiles android.Paths
1235 for _, v := range srcFiles.FilterByExt(".kt") {
1236 if _, found := set[v.String()]; !found {
1237 set[v.String()] = true
1238 uniqueKtFiles = append(uniqueKtFiles, v)
1239 }
1240 }
1241
1242 var uniqueSrcFiles android.Paths
1243 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1244 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1245 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001246 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001247
Colin Crossb5db4012022-03-28 17:12:39 -07001248 // We don't currently run annotation processors in turbine, which means we can't use turbine
1249 // generated header jars when an annotation processor that generates API is enabled. One
1250 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1251 // is used to run all of the annotation processors.
1252 disableTurbine := deps.disableTurbine
1253
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001254 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001255 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1256
Colin Cross220a9a12022-03-28 17:08:01 -07001257 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001258
Colin Cross4eae06d2023-06-20 22:40:02 -07001259 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1260 // any dependencies so that it can override any non-final R classes from dependencies with the
1261 // final R classes from the app.
1262 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1263
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001264 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1265
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001266 var localImplementationJars android.Paths
1267
Mark Whitea15790a2023-08-22 21:28:11 +00001268 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001269 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001270 if srcFiles.HasExt(".kt") {
1271 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1272 }
1273 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1274 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1275 }
1276
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001277 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1278
1279 localHeaderJars, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
Colin Crossedec77c2024-07-26 15:25:40 -07001280 extraCombinedJars)
1281
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001282 combinedHeaderJarFile, jarjared := j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1283 if jarjared {
1284 localHeaderJars = android.Paths{combinedHeaderJarFile}
1285 transitiveStaticLibsHeaderJars = nil
1286 }
1287 combinedHeaderJarFile, repackaged := j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
1288 if repackaged {
1289 localHeaderJars = android.Paths{combinedHeaderJarFile}
1290 transitiveStaticLibsHeaderJars = nil
1291 }
Mark Whitea15790a2023-08-22 21:28:11 +00001292 if ctx.Failed() {
1293 return
1294 }
Colin Crossedec77c2024-07-26 15:25:40 -07001295 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001296
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001297 if ctx.Config().UseTransitiveJarsInClasspath() {
1298 if len(localHeaderJars) > 0 {
1299 ctx.CheckbuildFile(localHeaderJars...)
1300 } else {
1301 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1302 ctx.UncheckedModule()
1303 }
1304 } else {
1305 ctx.CheckbuildFile(j.headerJarFile)
1306 }
Colin Crossa6182ab2024-08-21 10:47:44 -07001307
Colin Cross7727c7f2024-07-18 15:36:32 -07001308 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001309 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001310 LocalHeaderJars: localHeaderJars,
1311 TransitiveStaticLibsHeaderJars: android.NewDepSet(android.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Cross9ffaf282024-08-12 13:50:09 -07001312 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1313 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001314 AidlIncludeDirs: j.exportAidlIncludeDirs,
1315 ExportedPlugins: j.exportedPluginJars,
1316 ExportedPluginClasses: j.exportedPluginClasses,
1317 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1318 StubsLinkType: j.stubsLinkType,
1319 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001320 })
1321
1322 j.outputFile = j.headerJarFile
1323 return
1324 }
1325
Jaewoong Jung26342642021-03-17 15:56:23 -07001326 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001327 // When using kotlin sources turbine is used to generate annotation processor sources,
1328 // including for annotation processors that generate API, so we can use turbine for
1329 // java sources too.
1330 disableTurbine = false
1331
Jaewoong Jung26342642021-03-17 15:56:23 -07001332 // user defined kotlin flags.
1333 kotlincFlags := j.properties.Kotlincflags
1334 CheckKotlincFlags(ctx, kotlincFlags)
1335
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001336 // Workaround for KT-46512
1337 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001338
1339 // If there are kotlin files, compile them first but pass all the kotlin and java files
1340 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1341 // won't emit any classes for them.
1342 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1343 if ctx.Device() {
1344 kotlincFlags = append(kotlincFlags, "-no-jdk")
1345 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001346
1347 for _, plugin := range deps.kotlinPlugins {
1348 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1349 }
1350 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1351
Jaewoong Jung26342642021-03-17 15:56:23 -07001352 if len(kotlincFlags) > 0 {
1353 // optimization.
1354 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1355 flags.kotlincFlags += "$kotlincFlags"
1356 }
1357
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001358 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001359 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1360
Jaewoong Jung26342642021-03-17 15:56:23 -07001361 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1362 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1363
Isaac Chioua23d9942022-04-06 06:14:38 +00001364 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001365 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001366 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1367 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001368 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001369 srcJars = append(srcJars, kaptSrcJar)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001370 localImplementationJars = append(localImplementationJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001371 // Disable annotation processing in javac, it's already been handled by kapt
1372 flags.processorPath = nil
1373 flags.processors = nil
1374 }
1375
1376 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001377 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Spandan Das1028d5a2024-08-19 21:45:48 +00001378 j.kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001379 if ctx.Failed() {
1380 return
1381 }
1382
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001383 kotlinJarPath, _ := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001384
Isaac Chioua23d9942022-04-06 06:14:38 +00001385 // Make javac rule depend on the kotlinc rule
1386 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1387
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001388 localImplementationJars = append(localImplementationJars, kotlinJarPath)
1389
Colin Cross220a9a12022-03-28 17:08:01 -07001390 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001391 }
1392
Jaewoong Jung26342642021-03-17 15:56:23 -07001393 j.compiledSrcJars = srcJars
1394
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001395 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1396
Jaewoong Jung26342642021-03-17 15:56:23 -07001397 enableSharding := false
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001398 var localHeaderJars android.Paths
1399 var shardingHeaderJars android.Paths
1400 var repackagedHeaderJarFile android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001401 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001402 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1403 enableSharding = true
1404 // Formerly, there was a check here that prevented annotation processors
1405 // from being used when sharding was enabled, as some annotation processors
1406 // do not function correctly in sharded environments. It was removed to
1407 // allow for the use of annotation processors that do function correctly
1408 // with sharding enabled. See: b/77284273.
1409 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001410 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001411 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001412 var combinedHeaderJarFile android.Path
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001413 localHeaderJars, combinedHeaderJarFile = j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
1414 shardingHeaderJars = localHeaderJars
Colin Crossedec77c2024-07-26 15:25:40 -07001415
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001416 var jarjared bool
1417 j.headerJarFile, jarjared = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1418 if jarjared {
1419 // jarjar modifies transitive static dependencies, use the combined header jar and drop the transitive
1420 // static libs header jars.
1421 localHeaderJars = android.Paths{j.headerJarFile}
1422 transitiveStaticLibsHeaderJars = nil
1423 }
1424 var repackaged bool
1425 repackagedHeaderJarFile, repackaged = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
1426 if repackaged {
1427 // repackage modifies transitive static dependencies, use the combined header jar and drop the transitive
1428 // static libs header jars.
1429 // TODO(b/356688296): this shouldn't export both the unmodified and repackaged header jars
1430 localHeaderJars = android.Paths{j.headerJarFile, repackagedHeaderJarFile}
1431 transitiveStaticLibsHeaderJars = nil
1432 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001433 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001434 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001435 hasErrorproneableFiles := false
1436 for _, ext := range j.sourceExtensions {
1437 if ext != ".proto" && ext != ".aidl" {
1438 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1439 // compile, and it's not useful to have warnings on these generated sources.
1440 hasErrorproneableFiles = true
1441 break
1442 }
1443 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001444 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001445 if Bool(j.properties.Errorprone.Enabled) {
1446 // If error-prone is enabled, enable errorprone flags on the regular
1447 // build.
1448 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001449 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001450 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1451 // a new jar file just for compiling with the errorprone compiler to.
1452 // This is because we don't want to cause the java files to get completely
1453 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1454 // We also don't want to run this if errorprone is enabled by default for
1455 // this module, or else we could have duplicated errorprone messages.
1456 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001457 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001458 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001459
Vadim Spivak3c496f02023-06-08 06:14:59 +00001460 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001461 "errorprone", "errorprone")
1462
Jaewoong Jung26342642021-03-17 15:56:23 -07001463 extraJarDeps = append(extraJarDeps, errorprone)
1464 }
1465
1466 if enableSharding {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001467 if len(shardingHeaderJars) > 0 {
1468 flags.classpath = append(classpath(slices.Clone(shardingHeaderJars)), flags.classpath...)
Colin Cross3d56ed52021-11-18 22:23:12 -08001469 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001470 shardSize := int(*(j.properties.Javac_shard_size))
1471 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001472 if len(uniqueJavaFiles) > 0 {
1473 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001474 for idx, shardSrc := range shardSrcs {
1475 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1476 nil, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001477 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
1478 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001479 }
1480 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001481 // Assume approximately 5 sources per srcjar.
1482 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1483 // 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 -07001484 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001485 startIdx := len(shardSrcs)
1486 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1487 for idx, shardSrcJars := range shardSrcJarsList {
1488 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1489 nil, shardSrcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001490 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
1491 localImplementationJars = append(localImplementationJars, classes)
Colin Crossa052ddb2023-09-25 21:46:58 -07001492 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001493 }
1494 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001495 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001496 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
1497 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001498 }
1499 if ctx.Failed() {
1500 return
1501 }
1502 }
1503
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001504 localImplementationJars = append(localImplementationJars, extraCombinedJars...)
Colin Crossfd620b22024-02-23 10:05:21 -08001505
Jaewoong Jung26342642021-03-17 15:56:23 -07001506 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1507
1508 var includeSrcJar android.WritablePath
1509 if Bool(j.properties.Include_srcs) {
1510 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1511 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1512 }
1513
1514 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1515 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1516 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1517 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1518
1519 var resArgs []string
1520 var resDeps android.Paths
1521
1522 resArgs = append(resArgs, dirArgs...)
1523 resDeps = append(resDeps, dirDeps...)
1524
1525 resArgs = append(resArgs, fileArgs...)
1526 resDeps = append(resDeps, fileDeps...)
1527
1528 resArgs = append(resArgs, extraArgs...)
1529 resDeps = append(resDeps, extraDeps...)
1530
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001531 var localResourceJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001532 if len(resArgs) > 0 {
1533 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1534 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001535 if ctx.Failed() {
1536 return
1537 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001538 localResourceJars = append(localResourceJars, resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001539 }
1540
Jaewoong Jung26342642021-03-17 15:56:23 -07001541 if Bool(j.properties.Include_srcs) {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001542 localResourceJars = append(localResourceJars, includeSrcJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001543 }
1544
1545 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1546 if len(services) > 0 {
1547 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1548 var zipargs []string
1549 for _, file := range services {
1550 serviceFile := file.String()
1551 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1552 }
1553 rule := zip
1554 args := map[string]string{
1555 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1556 }
1557 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1558 rule = zipRE
1559 args["implicits"] = strings.Join(services.Strings(), ",")
1560 }
1561 ctx.Build(pctx, android.BuildParams{
1562 Rule: rule,
1563 Output: servicesJar,
1564 Implicits: services,
1565 Args: args,
1566 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001567 localResourceJars = append(localResourceJars, servicesJar)
1568 }
1569
1570 completeStaticLibsResourceJars := android.NewDepSet(android.PREORDER, localResourceJars, deps.transitiveStaticLibsResourceJars)
1571
1572 var combinedResourceJar android.Path
1573 var resourceJars android.Paths
1574 if ctx.Config().UseTransitiveJarsInClasspath() {
1575 resourceJars = completeStaticLibsResourceJars.ToList()
1576 } else {
1577 resourceJars = append(slices.Clone(localResourceJars), deps.staticResourceJars...)
1578 }
1579 if len(resourceJars) == 1 {
1580 combinedResourceJar = resourceJars[0]
1581 } else if len(resourceJars) > 0 {
1582 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1583 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1584 false, nil, nil)
1585 combinedResourceJar = combinedJar
1586 }
1587
1588 manifest := j.overrideManifest
1589 if !manifest.Valid() && j.properties.Manifest != nil {
1590 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Jaewoong Jung26342642021-03-17 15:56:23 -07001591 }
1592
1593 // Combine the classes built from sources, any manifests, and any static libraries into
1594 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001595 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001596
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001597 completeStaticLibsImplementationJars := android.NewDepSet(android.PREORDER, localImplementationJars, deps.transitiveStaticLibsImplementationJars)
1598
1599 var jars android.Paths
1600 if ctx.Config().UseTransitiveJarsInClasspath() {
1601 jars = completeStaticLibsImplementationJars.ToList()
1602 } else {
1603 jars = append(slices.Clone(localImplementationJars), deps.staticJars...)
1604 }
1605
1606 jars = append(jars, extraDepCombinedJars...)
1607
Jaewoong Jung26342642021-03-17 15:56:23 -07001608 if len(jars) == 1 && !manifest.Valid() {
1609 // Optimization: skip the combine step as there is nothing to do
1610 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1611 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001612 // any if len(extraJars) == 0.
Jaewoong Jung26342642021-03-17 15:56:23 -07001613
Jihoon Kang1147b312023-06-08 23:25:57 +00001614 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1615 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1616 // either with .from-source or .from-text suffix.
1617 // outputFile should be agnostic to the build configuration,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001618 // thus copy the single input static lib in order to prevent the static lib from being exposed
Jihoon Kang1147b312023-06-08 23:25:57 +00001619 // to the copy rules.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001620 if stub, _ := moduleStubLinkType(j); stub {
1621 copiedJar := android.PathForModuleOut(ctx, "combined", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001622 ctx.Build(pctx, android.BuildParams{
1623 Rule: android.Cp,
1624 Input: jars[0],
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001625 Output: copiedJar,
Jaewoong Jung26342642021-03-17 15:56:23 -07001626 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001627 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, android.Paths{copiedJar}, nil)
1628 outputFile = copiedJar
Colin Cross7707b242024-07-26 12:02:36 -07001629 } else {
1630 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001631 }
1632 } else {
1633 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1634 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1635 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001636 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001637 }
1638
1639 // jarjar implementation jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001640 jarjarFile, jarjarred := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1641 if jarjarred {
1642 localImplementationJars = android.Paths{jarjarFile}
1643 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
1644 }
Colin Crossedec77c2024-07-26 15:25:40 -07001645 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001646
Colin Crossedec77c2024-07-26 15:25:40 -07001647 // jarjar resource jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001648 if combinedResourceJar != nil {
1649 resourceJarJarFile, jarjarred := j.jarjarIfNecessary(ctx, combinedResourceJar, jarName, "resource")
1650 combinedResourceJar = resourceJarJarFile
1651 if jarjarred {
1652 localResourceJars = android.Paths{resourceJarJarFile}
1653 completeStaticLibsResourceJars = android.NewDepSet(android.PREORDER, localResourceJars, nil)
1654 }
Colin Crossedec77c2024-07-26 15:25:40 -07001655 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001656
Colin Crossedec77c2024-07-26 15:25:40 -07001657 if ctx.Failed() {
1658 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001659 }
1660
Makoto Onuki7ded3822024-03-28 14:42:20 -07001661 if j.ravenizer.enabled {
1662 ravenizerInput := outputFile
1663 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", jarName)
1664 ctx.Build(pctx, android.BuildParams{
1665 Rule: ravenizer,
1666 Description: "ravenizer",
1667 Input: ravenizerInput,
1668 Output: ravenizerOutput,
1669 })
1670 outputFile = ravenizerOutput
Colin Cross7e863852024-09-06 14:42:38 -07001671 localImplementationJars = android.Paths{ravenizerOutput}
1672 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Makoto Onuki7ded3822024-03-28 14:42:20 -07001673 }
1674
Yihan Dong8be09c22024-08-29 15:32:13 +08001675 if j.shouldApiMapper() {
1676 inputFile := outputFile
1677 apiMapperFile := android.PathForModuleOut(ctx, "apimapper", jarName)
1678 ctx.Build(pctx, android.BuildParams{
1679 Rule: apimapper,
1680 Description: "apimapper",
1681 Input: inputFile,
1682 Output: apiMapperFile,
1683 })
1684 outputFile = apiMapperFile
Colin Cross7e863852024-09-06 14:42:38 -07001685 localImplementationJars = android.Paths{apiMapperFile}
1686 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Yihan Dong8be09c22024-08-29 15:32:13 +08001687 }
1688
Jaewoong Jung26342642021-03-17 15:56:23 -07001689 // Check package restrictions if necessary.
1690 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001691 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001692 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001693
1694 // Create a rule to copy the output jar to another path and add a validate dependency that
1695 // will check that the jar only contains the permitted packages. The new location will become
1696 // the output file of this module.
1697 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001698 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001699 ctx.Build(pctx, android.BuildParams{
1700 Rule: android.Cp,
1701 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001702 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001703 // Make sure that any dependency on the output file will cause ninja to run the package check
1704 // rule.
1705 Validation: pkgckFile,
1706 })
Colin Cross7707b242024-07-26 12:02:36 -07001707 outputFile = packageCheckOutputFile
Colin Cross7e863852024-09-06 14:42:38 -07001708 localImplementationJars = android.Paths{packageCheckOutputFile}
1709 completeStaticLibsImplementationJars = android.NewDepSet(android.PREORDER, localImplementationJars, nil)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001710
1711 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001712 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001713
1714 if ctx.Failed() {
1715 return
1716 }
1717 }
1718
1719 j.implementationJarFile = outputFile
1720 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001721 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1722 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1723 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1724 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1725 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1726 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1727 j.headerJarFile = headerJarFile
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001728 if len(localImplementationJars) == 1 && ctx.Config().UseTransitiveJarsInClasspath() {
1729 localHeaderJarFile := android.PathForModuleOut(ctx, "local-javac-header", jarName)
1730 convertImplementationJarToHeaderJar(ctx, localImplementationJars[0], localHeaderJarFile)
1731 localHeaderJars = append(localHeaderJars, localHeaderJarFile)
1732 } else {
1733 localHeaderJars = append(localHeaderJars, headerJarFile)
1734 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001735 }
1736
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001737 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1738 specs := j.jacocoModuleToZipCommand(ctx)
1739 if ctx.Failed() {
1740 return
1741 }
1742
Jaewoong Jung26342642021-03-17 15:56:23 -07001743 if j.shouldInstrument(ctx) {
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001744 outputFile = j.instrument(ctx, flags, outputFile, jarName, specs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001745 }
1746
1747 // merge implementation jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001748 var implementationAndResourcesJarsToCombine android.Paths
1749 if ctx.Config().UseTransitiveJarsInClasspath() {
1750 resourceJars := completeStaticLibsResourceJars.ToList()
1751 if len(resourceJars) > 0 {
1752 implementationAndResourcesJarsToCombine = append(resourceJars, completeStaticLibsImplementationJars.ToList()...)
1753 implementationAndResourcesJarsToCombine = append(implementationAndResourcesJarsToCombine, extraDepCombinedJars...)
1754 }
1755 } else {
1756 if combinedResourceJar != nil {
1757 implementationAndResourcesJarsToCombine = android.Paths{combinedResourceJar, outputFile}
1758 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001759 }
1760
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001761 if len(implementationAndResourcesJarsToCombine) > 0 {
1762 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
1763 TransformJarsToJar(ctx, combinedJar, "for resources", implementationAndResourcesJarsToCombine, manifest,
1764 false, nil, nil)
1765 outputFile = combinedJar
1766 }
1767
1768 j.implementationAndResourcesJar = outputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001769
1770 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001771 compileDex := j.dexProperties.Compile_dex
Colin Crossff694a82023-12-13 15:54:49 -08001772 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -07001773 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001774 if compileDex == nil {
1775 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001776 }
1777 if j.deviceProperties.Hostdex == nil {
1778 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1779 }
1780 }
1781
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001782 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001783 if j.hasCode(ctx) {
1784 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001785 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001786 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1787 }
1788 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001789 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001790 params := &compileDexParams{
1791 flags: flags,
1792 sdkVersion: j.SdkVersion(ctx),
1793 minSdkVersion: j.MinSdkVersion(ctx),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001794 classesJar: outputFile,
Spandan Dasc404cc72023-02-23 18:05:05 +00001795 jarName: jarName,
1796 }
Cole Fausteb032462024-09-19 11:12:54 -07001797 if j.GetProfileGuided(ctx) && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting(ctx) {
Spandan Das15a67112024-05-30 00:07:40 +00001798 ctx.PropertyErrorf("enable_profile_rewriting",
1799 "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.",
1800 )
1801 }
Cole Fausteb032462024-09-19 11:12:54 -07001802 if j.EnableProfileRewriting(ctx) {
1803 profile := j.GetProfile(ctx)
1804 if profile == "" || !j.GetProfileGuided(ctx) {
Spandan Das3dbda182024-05-20 22:23:10 +00001805 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1806 }
1807 params.artProfileInput = &profile
1808 }
1809 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001810 if ctx.Failed() {
1811 return
1812 }
1813
Spandan Das3dbda182024-05-20 22:23:10 +00001814 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1815 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001816 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001817 }
1818
Jaewoong Jung26342642021-03-17 15:56:23 -07001819 // merge dex jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001820 var dexAndResourceJarsToCombine android.Paths
1821 if ctx.Config().UseTransitiveJarsInClasspath() {
1822 resourceJars := completeStaticLibsResourceJars.ToList()
1823 if len(resourceJars) > 0 {
1824 dexAndResourceJarsToCombine = append(android.Paths{dexOutputFile}, resourceJars...)
1825 }
1826 } else {
1827 if combinedResourceJar != nil {
1828 dexAndResourceJarsToCombine = android.Paths{dexOutputFile, combinedResourceJar}
1829 }
1830 }
1831 if len(dexAndResourceJarsToCombine) > 0 {
Colin Cross7707b242024-07-26 12:02:36 -07001832 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001833 TransformJarsToJar(ctx, combinedJar, "for dex resources", dexAndResourceJarsToCombine, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001834 false, nil, nil)
1835 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001836 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001837 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001838 dexOutputFile = combinedAlignedJar
1839 } else {
1840 dexOutputFile = combinedJar
1841 }
1842 }
1843
Paul Duffin4de94502021-05-16 05:21:16 +01001844 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001845
1846 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001847
1848 // Encode hidden API flags in dex file, if needed.
1849 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1850
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001851 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001852
1853 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001854 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1855 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1856 libName = strings.TrimSuffix(libName, ".impl")
1857 }
1858 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001859
1860 outputFile = dexOutputFile
Colin Crossa6182ab2024-08-21 10:47:44 -07001861
1862 ctx.CheckbuildFile(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001863 } else {
1864 // There is no code to compile into a dex jar, make sure the resources are propagated
1865 // to the APK if this is an app.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001866 j.dexJarFile = makeDexJarPathFromPath(combinedResourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001867 }
1868
1869 if ctx.Failed() {
1870 return
1871 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001872 }
1873
1874 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001875 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001876 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001877 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001878 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001879 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001880 }
1881 }
1882
1883 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001884 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1885 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001886 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1887 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001888 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001889 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001890 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001891 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001892 j.linter.javaLanguageLevel = flags.javaVersion.String()
1893 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001894 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001895 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1896 j.linter.buildModuleReportZip = true
1897 }
1898 j.linter.lint(ctx)
1899 }
1900
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001901 j.collectTransitiveSrcFiles(ctx, srcFiles)
1902
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001903 if ctx.Config().UseTransitiveJarsInClasspath() {
1904 if len(localImplementationJars) > 0 || len(localResourceJars) > 0 || len(localHeaderJars) > 0 {
1905 ctx.CheckbuildFile(localImplementationJars...)
1906 ctx.CheckbuildFile(localResourceJars...)
1907 ctx.CheckbuildFile(localHeaderJars...)
1908 } else {
1909 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1910 ctx.UncheckedModule()
1911 }
1912 } else {
1913 ctx.CheckbuildFile(j.implementationJarFile)
1914 ctx.CheckbuildFile(j.headerJarFile)
1915 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001916
Colin Cross7727c7f2024-07-18 15:36:32 -07001917 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001918 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1919 RepackagedHeaderJars: android.PathsIfNonNil(repackagedHeaderJarFile),
1920
1921 LocalHeaderJars: localHeaderJars,
1922 TransitiveStaticLibsHeaderJars: android.NewDepSet(android.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
1923 TransitiveStaticLibsImplementationJars: completeStaticLibsImplementationJars,
1924 TransitiveStaticLibsResourceJars: completeStaticLibsResourceJars,
1925
Colin Cross9ffaf282024-08-12 13:50:09 -07001926 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1927 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001928 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1929 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001930 ResourceJars: android.PathsIfNonNil(combinedResourceJar),
Jihoon Kang705e63e2024-03-13 01:21:16 +00001931 AidlIncludeDirs: j.exportAidlIncludeDirs,
1932 SrcJarArgs: j.srcJarArgs,
1933 SrcJarDeps: j.srcJarDeps,
1934 TransitiveSrcFiles: j.transitiveSrcFiles,
1935 ExportedPlugins: j.exportedPluginJars,
1936 ExportedPluginClasses: j.exportedPluginClasses,
1937 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1938 JacocoReportClassesFile: j.jacocoReportClassesFile,
1939 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001940 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001941 })
1942
1943 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1944 j.outputFile = outputFile.WithoutRel()
1945}
1946
Cole Faustb7493472024-08-28 11:55:52 -07001947func (j *Module) useCompose(ctx android.BaseModuleContext) bool {
1948 return android.InList("androidx.compose.runtime_runtime", j.staticLibs(ctx))
Colin Crossa1ff7c62021-09-17 14:11:52 -07001949}
1950
Colin Crosscde55342024-03-27 14:11:51 -07001951func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []*android.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001952 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001953 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001954 depTag := ctx.OtherModuleDependencyTag(m)
1955
1956 if depProguardInfo.UnconditionallyExportedProguardFlags != nil {
1957 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1958 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1959 }
1960
1961 if depTag == staticLibTag && depProguardInfo.ProguardFlagsFiles != nil {
1962 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1963 }
1964 })
1965
Colin Crosscde55342024-03-27 14:11:51 -07001966 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1967}
1968
1969func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1970 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1971
Sam Delmerico95d70942023-08-02 18:00:35 -04001972 directUnconditionalExportedFlags := android.Paths{}
1973 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1974 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1975 if exportUnconditionally {
1976 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1977 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1978 directUnconditionalExportedFlags = proguardFlagsForThisModule
1979 }
1980
1981 return ProguardSpecInfo{
1982 Export_proguard_flags_files: exportUnconditionally,
1983 ProguardFlagsFiles: android.NewDepSet[android.Path](
1984 android.POSTORDER,
1985 proguardFlagsForThisModule,
1986 transitiveProguardFlags,
1987 ),
1988 UnconditionallyExportedProguardFlags: android.NewDepSet[android.Path](
1989 android.POSTORDER,
1990 directUnconditionalExportedFlags,
1991 transitiveUnconditionalExportedFlags,
1992 ),
1993 }
1994
1995}
1996
Cole Faust75fffb12021-06-13 15:23:16 -07001997// Returns a copy of the supplied flags, but with all the errorprone-related
1998// fields copied to the regular build's fields.
1999func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
2000 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
2001
2002 if len(flags.errorProneExtraJavacFlags) > 0 {
2003 if len(flags.javacFlags) > 0 {
2004 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
2005 } else {
2006 flags.javacFlags = flags.errorProneExtraJavacFlags
2007 }
2008 }
2009 return flags
2010}
2011
Jaewoong Jung26342642021-03-17 15:56:23 -07002012func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07002013 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002014
2015 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00002016 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002017 if idx >= 0 {
2018 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00002019 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002020 jarName += strconv.Itoa(idx)
2021 }
2022
Colin Cross7707b242024-07-26 12:02:36 -07002023 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00002024 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07002025
Cole Faust9decf832024-06-11 11:45:53 -07002026 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002027 extractionFile := android.PathForModuleOut(ctx, kzipName)
2028 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
2029 j.kytheFiles = append(j.kytheFiles, extractionFile)
2030 }
2031
Vadim Spivak3c496f02023-06-08 06:14:59 +00002032 if len(flags.processorPath) > 0 {
2033 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
2034 }
2035
Jaewoong Jung26342642021-03-17 15:56:23 -07002036 return classes
2037}
2038
2039// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
2040// since some of these flags may be used internally.
2041func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
2042 for _, flag := range flags {
2043 flag = strings.TrimSpace(flag)
2044
2045 if !strings.HasPrefix(flag, "-") {
2046 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
2047 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
2048 ctx.PropertyErrorf("kotlincflags",
2049 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
2050 } else if inList(flag, config.KotlincIllegalFlags) {
2051 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
2052 } else if flag == "-include-runtime" {
2053 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
2054 } else {
2055 args := strings.Split(flag, " ")
2056 if args[0] == "-kotlin-home" {
2057 ctx.PropertyErrorf("kotlincflags",
2058 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
2059 }
2060 }
2061 }
2062}
2063
2064func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
2065 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002066 extraJars android.Paths) (localHeaderJars android.Paths, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002067
Jaewoong Jung26342642021-03-17 15:56:23 -07002068 if len(srcFiles) > 0 || len(srcJars) > 0 {
2069 // Compile java sources into turbine.jar.
2070 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
2071 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002072 localHeaderJars = append(localHeaderJars, turbineJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07002073 }
2074
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002075 localHeaderJars = append(localHeaderJars, extraJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002076
2077 // Combine any static header libraries into classes-header.jar. If there is only
2078 // one input jar this step will be skipped.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002079 var jars android.Paths
2080 if ctx.Config().UseTransitiveJarsInClasspath() {
2081 depSet := android.NewDepSet(android.PREORDER, localHeaderJars, deps.transitiveStaticLibsHeaderJars)
2082 jars = depSet.ToList()
2083 } else {
2084 jars = append(slices.Clone(localHeaderJars), deps.staticHeaderJars...)
2085 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002086
2087 // we cannot skip the combine step for now if there is only one jar
2088 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07002089 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
2090 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07002091 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07002092
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002093 return localHeaderJars, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07002094}
2095
2096func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07002097 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002098
2099 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07002100 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07002101
2102 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
2103
2104 j.jacocoReportClassesFile = jacocoReportClassesFile
2105
2106 return instrumentedJar
2107}
2108
Colin Cross9ffaf282024-08-12 13:50:09 -07002109type providesTransitiveHeaderJarsForR8 struct {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002110 // set of header jars for all transitive libs deps
Colin Cross9ffaf282024-08-12 13:50:09 -07002111 transitiveLibsHeaderJarsForR8 *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002112 // set of header jars for all transitive static libs deps
Colin Cross9ffaf282024-08-12 13:50:09 -07002113 transitiveStaticLibsHeaderJarsForR8 *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002114}
2115
Colin Cross9ffaf282024-08-12 13:50:09 -07002116// collectTransitiveHeaderJarsForR8 visits direct dependencies and collects all transitive libs and static_libs
2117// header jars. The semantics of the collected jars are odd (it collects combined jars that contain the static
2118// libs, but also the static libs, and it collects transitive libs dependencies of static_libs), so these
2119// are only used to expand the --lib arguments to R8.
2120func (j *providesTransitiveHeaderJarsForR8) collectTransitiveHeaderJarsForR8(ctx android.ModuleContext) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002121 directLibs := android.Paths{}
2122 directStaticLibs := android.Paths{}
Colin Crossc85750b2022-04-21 12:50:51 -07002123 transitiveLibs := []*android.DepSet[android.Path]{}
2124 transitiveStaticLibs := []*android.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002125 ctx.VisitDirectDeps(func(module android.Module) {
2126 // don't add deps of the prebuilt version of the same library
2127 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
2128 return
2129 }
2130
Colin Cross7727c7f2024-07-18 15:36:32 -07002131 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2132 tag := ctx.OtherModuleDependencyTag(module)
2133 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2134 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2135 directLibs = append(directLibs, dep.HeaderJars...)
2136 } else if tag == staticLibTag {
2137 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2138 } else {
2139 // Don't propagate transitive libs for other kinds of dependencies.
2140 return
2141 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002142
Colin Cross9ffaf282024-08-12 13:50:09 -07002143 if dep.TransitiveLibsHeaderJarsForR8 != nil {
2144 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJarsForR8)
Colin Cross7727c7f2024-07-18 15:36:32 -07002145 }
Colin Cross9ffaf282024-08-12 13:50:09 -07002146 if dep.TransitiveStaticLibsHeaderJarsForR8 != nil {
2147 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJarsForR8)
Colin Cross7727c7f2024-07-18 15:36:32 -07002148 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002149
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002150 }
2151 })
Colin Cross9ffaf282024-08-12 13:50:09 -07002152 j.transitiveLibsHeaderJarsForR8 = android.NewDepSet(android.POSTORDER, directLibs, transitiveLibs)
2153 j.transitiveStaticLibsHeaderJarsForR8 = android.NewDepSet(android.POSTORDER, directStaticLibs, transitiveStaticLibs)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002154}
2155
Jaewoong Jung26342642021-03-17 15:56:23 -07002156func (j *Module) HeaderJars() android.Paths {
2157 if j.headerJarFile == nil {
2158 return nil
2159 }
2160 return android.Paths{j.headerJarFile}
2161}
2162
2163func (j *Module) ImplementationJars() android.Paths {
2164 if j.implementationJarFile == nil {
2165 return nil
2166 }
2167 return android.Paths{j.implementationJarFile}
2168}
2169
Spandan Das59a4a2b2024-01-09 21:35:56 +00002170func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002171 return j.dexJarFile
2172}
2173
2174func (j *Module) DexJarInstallPath() android.Path {
2175 return j.installFile
2176}
2177
2178func (j *Module) ImplementationAndResourcesJars() android.Paths {
2179 if j.implementationAndResourcesJar == nil {
2180 return nil
2181 }
2182 return android.Paths{j.implementationAndResourcesJar}
2183}
2184
2185func (j *Module) AidlIncludeDirs() android.Paths {
2186 // exportAidlIncludeDirs is type android.Paths already
2187 return j.exportAidlIncludeDirs
2188}
2189
2190func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2191 return j.classLoaderContexts
2192}
2193
2194// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002195func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002196 // jarjar rules will repackage the sources. To prevent misleading results, IdeInfo should contain the
2197 // repackaged jar instead of the input sources.
Jaewoong Jung26342642021-03-17 15:56:23 -07002198 if j.expandJarjarRules != nil {
2199 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002200 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
2201 } else {
2202 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2203 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2204 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002205 }
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002206 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2207 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Cole Faustb7493472024-08-28 11:55:52 -07002208 dpInfo.Static_libs = append(dpInfo.Static_libs, j.staticLibs(ctx)...)
Yikef6282022022-04-13 20:41:01 +08002209 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002210}
2211
2212func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002213 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002214}
2215
2216func (j *Module) hasCode(ctx android.ModuleContext) bool {
2217 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2218 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2219}
2220
2221// Implements android.ApexModule
2222func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2223 return j.depIsInSameApex(ctx, dep)
2224}
2225
2226// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002227func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002228 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002229 minSdkVersion := j.MinSdkVersion(ctx)
2230 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002231 return fmt.Errorf("min_sdk_version is not specified")
2232 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002233 // If the module is compiling against core (via sdk_version), skip comparison check.
2234 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002235 return nil
2236 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002237 if minSdkVersion.GreaterThan(sdkVersion) {
2238 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002239 }
2240 return nil
2241}
2242
2243func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002244 if j.stem == "" {
2245 panic("Stem() called before stem property was set")
2246 }
2247 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002248}
2249
Jaewoong Jung26342642021-03-17 15:56:23 -07002250func (j *Module) JacocoReportClassesFile() android.Path {
2251 return j.jacocoReportClassesFile
2252}
2253
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002254func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
2255 var fromDeps []*android.DepSet[android.Path]
2256 ctx.VisitDirectDeps(func(module android.Module) {
2257 tag := ctx.OtherModuleDependencyTag(module)
2258 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002259 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2260 if depInfo.TransitiveSrcFiles != nil {
2261 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
2262 }
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002263 }
2264 }
2265 })
2266
2267 j.transitiveSrcFiles = android.NewDepSet(android.POSTORDER, mine, fromDeps)
2268}
2269
Jaewoong Jung26342642021-03-17 15:56:23 -07002270func (j *Module) IsInstallable() bool {
2271 return Bool(j.properties.Installable)
2272}
2273
2274type sdkLinkType int
2275
2276const (
2277 // TODO(jiyong) rename these for better readability. Make the allowed
2278 // and disallowed link types explicit
2279 // order is important here. See rank()
2280 javaCore sdkLinkType = iota
2281 javaSdk
2282 javaSystem
2283 javaModule
2284 javaSystemServer
2285 javaPlatform
2286)
2287
2288func (lt sdkLinkType) String() string {
2289 switch lt {
2290 case javaCore:
2291 return "core Java API"
2292 case javaSdk:
2293 return "Android API"
2294 case javaSystem:
2295 return "system API"
2296 case javaModule:
2297 return "module API"
2298 case javaSystemServer:
2299 return "system server API"
2300 case javaPlatform:
2301 return "private API"
2302 default:
2303 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2304 }
2305}
2306
2307// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2308// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2309// can't statically depend on modules that use Platform API.
2310func (lt sdkLinkType) rank() int {
2311 return int(lt)
2312}
2313
2314type moduleWithSdkDep interface {
2315 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002316 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002317}
2318
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002319func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2320 switch k {
2321 case android.SdkCore:
2322 return javaCore
2323 case android.SdkSystem:
2324 return javaSystem
2325 case android.SdkPublic:
2326 return javaSdk
2327 case android.SdkModule:
2328 return javaModule
2329 case android.SdkSystemServer:
2330 return javaSystemServer
2331 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2332 return javaPlatform
2333 default:
2334 return javaSdk
2335 }
2336}
2337
Jiyong Park92315372021-04-02 08:45:46 +09002338func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002339 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002340 case android.SdkCore.DefaultJavaLibraryName(),
2341 "legacy.core.platform.api.stubs",
2342 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002343 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002344 "core-lambda-stubs",
Jihoon Kangb5078312023-03-29 23:25:49 +00002345 "core-generated-annotation-stubs":
Jaewoong Jung26342642021-03-17 15:56:23 -07002346 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002347 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002348 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002349 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002350 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002351 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002352 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002353 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002354 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002355 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002356 return javaSystem, true
2357 }
2358
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002359 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002360 return linkType, true
2361 }
2362
Jiyong Park92315372021-04-02 08:45:46 +09002363 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002364 if !ver.Valid() {
2365 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002366 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002367
2368 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002369}
2370
2371// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2372// this module's. See the comment on rank() for details and an example.
2373func (j *Module) checkSdkLinkType(
2374 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2375 if ctx.Host() {
2376 return
2377 }
2378
Jiyong Park92315372021-04-02 08:45:46 +09002379 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002380 if stubs {
2381 return
2382 }
Jiyong Park92315372021-04-02 08:45:46 +09002383 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002384
2385 if myLinkType.rank() < depLinkType.rank() {
2386 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2387 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2388 "property of the source or target module so that target module is built "+
2389 "with the same or smaller API set when compared to the source.",
2390 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2391 }
2392}
2393
2394func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2395 var deps deps
2396
Jiyong Park92315372021-04-02 08:45:46 +09002397 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002398
Colin Cross9ffaf282024-08-12 13:50:09 -07002399 j.collectTransitiveHeaderJarsForR8(ctx)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002400
2401 var transitiveBootClasspathHeaderJars []*android.DepSet[android.Path]
2402 var transitiveClasspathHeaderJars []*android.DepSet[android.Path]
2403 var transitiveJava9ClasspathHeaderJars []*android.DepSet[android.Path]
2404 var transitiveStaticJarsHeaderLibs []*android.DepSet[android.Path]
2405 var transitiveStaticJarsImplementationLibs []*android.DepSet[android.Path]
2406 var transitiveStaticJarsResourceLibs []*android.DepSet[android.Path]
2407
Jaewoong Jung26342642021-03-17 15:56:23 -07002408 ctx.VisitDirectDeps(func(module android.Module) {
2409 otherName := ctx.OtherModuleName(module)
2410 tag := ctx.OtherModuleDependencyTag(module)
2411
2412 if IsJniDepTag(tag) {
2413 // Handled by AndroidApp.collectAppDeps
2414 return
2415 }
2416 if tag == certificateTag {
2417 // Handled by AndroidApp.collectAppDeps
2418 return
2419 }
2420
Jihoon Kang28c96572024-09-11 23:44:44 +00002421 if _, ok := module.(SdkLibraryDependency); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -07002422 switch tag {
Jihoon Kang28c96572024-09-11 23:44:44 +00002423 case sdkLibTag, libTag, staticLibTag:
2424 sdkInfo, _ := android.OtherModuleProvider(ctx, module, SdkLibraryInfoProvider)
2425 generatingLibsString := android.PrettyConcat(
2426 getGeneratingLibs(ctx, j.SdkVersion(ctx), module.Name(), sdkInfo), true, "or")
2427 ctx.ModuleErrorf("cannot depend directly on java_sdk_library %q; try depending on %s instead", module.Name(), generatingLibsString)
Jaewoong Jung26342642021-03-17 15:56:23 -07002428 }
Colin Cross313aa542023-12-13 13:47:44 -08002429 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2430 if sdkLinkType != javaPlatform {
2431 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2432 // dep is a sysprop implementation library, but this module is not linking against
2433 // the platform, so it gets the sysprop public stubs library instead. Replace
2434 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2435 dep = syspropDep.JavaInfo
2436 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002437 }
2438 switch tag {
2439 case bootClasspathTag:
2440 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002441 if dep.TransitiveStaticLibsHeaderJars != nil {
2442 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2443 }
Liz Kammeref28a4c2022-09-23 16:50:56 -04002444 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002445 if _, ok := module.(*Plugin); ok {
2446 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2447 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002448 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002449 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002450 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2451 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2452 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2453 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002454 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2455 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2456 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002457
2458 if dep.TransitiveStaticLibsHeaderJars != nil {
2459 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2460 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002461 case java9LibTag:
2462 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002463 if dep.TransitiveStaticLibsHeaderJars != nil {
2464 transitiveJava9ClasspathHeaderJars = append(transitiveJava9ClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2465 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002466 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002467 if _, ok := module.(*Plugin); ok {
2468 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2469 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002470 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2471 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2472 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2473 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2474 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2475 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2476 // Turbine doesn't run annotation processors, so any module that uses an
2477 // annotation processor that generates API is incompatible with the turbine
2478 // optimization.
2479 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002480 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002481
2482 if dep.TransitiveStaticLibsHeaderJars != nil {
2483 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2484 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, dep.TransitiveStaticLibsHeaderJars)
2485 }
2486 if dep.TransitiveStaticLibsImplementationJars != nil {
2487 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, dep.TransitiveStaticLibsImplementationJars)
2488 }
2489 if dep.TransitiveStaticLibsResourceJars != nil {
2490 transitiveStaticJarsResourceLibs = append(transitiveStaticJarsResourceLibs, dep.TransitiveStaticLibsResourceJars)
2491 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002492 case pluginTag:
2493 if plugin, ok := module.(*Plugin); ok {
2494 if plugin.pluginProperties.Processor_class != nil {
2495 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2496 } else {
2497 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2498 }
2499 // Turbine doesn't run annotation processors, so any module that uses an
2500 // annotation processor that generates API is incompatible with the turbine
2501 // optimization.
2502 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2503 } else {
2504 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2505 }
2506 case errorpronePluginTag:
2507 if _, ok := module.(*Plugin); ok {
2508 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2509 } else {
2510 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2511 }
2512 case exportedPluginTag:
2513 if plugin, ok := module.(*Plugin); ok {
2514 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2515 if plugin.pluginProperties.Processor_class != nil {
2516 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2517 }
2518 // Turbine doesn't run annotation processors, so any module that uses an
2519 // annotation processor that generates API is incompatible with the turbine
2520 // optimization.
2521 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2522 } else {
2523 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2524 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002525 case kotlinPluginTag:
Luca Stefania3efe922024-10-12 17:55:31 +02002526 if _, ok := module.(*KotlinPlugin); ok {
2527 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
2528 } else {
2529 ctx.PropertyErrorf("kotlin_plugins", "%q is not a kotlin_plugin module", otherName)
2530 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002531 case syspropPublicStubDepTag:
2532 // This is a sysprop implementation library, forward the JavaInfoProvider from
2533 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002534 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002535 JavaInfo: dep,
2536 })
2537 }
2538 } else if dep, ok := module.(android.SourceFileProducer); ok {
2539 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002540 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002541 checkProducesJars(ctx, dep)
2542 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002543 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002544 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars,
2545 android.NewDepSet(android.PREORDER, dep.Srcs(), nil))
Jaewoong Jung26342642021-03-17 15:56:23 -07002546 case staticLibTag:
2547 checkProducesJars(ctx, dep)
2548 deps.classpath = append(deps.classpath, dep.Srcs()...)
2549 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2550 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002551
2552 depHeaderJars := android.NewDepSet(android.PREORDER, dep.Srcs(), nil)
2553 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJars)
2554 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, depHeaderJars)
2555 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, depHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002556 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002557 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002558 switch tag {
2559 case staticLibTag:
2560 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2561 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002562 } else {
2563 switch tag {
2564 case bootClasspathTag:
2565 // If a system modules dependency has been added to the bootclasspath
2566 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002567 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002568 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars...)
2569 if sm.TransitiveStaticLibsHeaderJars != nil {
2570 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars,
2571 sm.TransitiveStaticLibsHeaderJars)
2572 }
Colin Crossb61c2262024-08-08 14:04:42 -07002573 } else {
2574 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2575 ctx.OtherModuleName(module))
2576 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002577
2578 case systemModulesTag:
2579 if deps.systemModules != nil {
2580 panic("Found two system module dependencies")
2581 }
Colin Crossb61c2262024-08-08 14:04:42 -07002582 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2583 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2584 } else {
2585 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2586 ctx.OtherModuleName(module))
2587 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002588
2589 case instrumentationForTag:
2590 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 -07002591 }
2592 }
2593
Spandan Das8aac9932024-07-18 23:14:13 +00002594 if android.InList(tag, compileDependencyTags) {
2595 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2596 j.compileDepNames = append(j.compileDepNames, otherName)
2597 }
2598
Jaewoong Jung26342642021-03-17 15:56:23 -07002599 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002600 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002601 })
2602
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002603 deps.transitiveStaticLibsHeaderJars = transitiveStaticJarsHeaderLibs
2604 deps.transitiveStaticLibsImplementationJars = transitiveStaticJarsImplementationLibs
2605 deps.transitiveStaticLibsResourceJars = transitiveStaticJarsResourceLibs
2606
2607 if ctx.Config().UseTransitiveJarsInClasspath() {
2608 depSet := android.NewDepSet(android.PREORDER, nil, transitiveClasspathHeaderJars)
2609 deps.classpath = depSet.ToList()
2610 depSet = android.NewDepSet(android.PREORDER, nil, transitiveBootClasspathHeaderJars)
2611 deps.bootClasspath = depSet.ToList()
2612 depSet = android.NewDepSet(android.PREORDER, nil, transitiveJava9ClasspathHeaderJars)
2613 deps.java9Classpath = depSet.ToList()
2614 }
2615
2616 if ctx.Device() {
2617 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
2618 if sdkDep.invalidVersion {
2619 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2620 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2621 } else if sdkDep.useFiles {
2622 // sdkDep.jar is actually equivalent to turbine header.jar.
2623 deps.classpath = append(slices.Clone(classpath(sdkDep.jars)), deps.classpath...)
2624 deps.dexClasspath = append(slices.Clone(classpath(sdkDep.jars)), deps.dexClasspath...)
2625 deps.aidlPreprocess = sdkDep.aidl
2626 // Add the sdk module dependency to `compileDepNames`.
2627 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2628 // TODO (b/358608607): Move this to decodeSdkDep
2629 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2630 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
2631 } else {
2632 deps.aidlPreprocess = sdkDep.aidl
2633 }
2634 }
2635
Jaewoong Jung26342642021-03-17 15:56:23 -07002636 return deps
2637}
2638
Joe Onorato349ae8d2024-02-05 22:46:00 +00002639// Provider for jarjar renaming rules.
2640//
2641// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2642// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2643// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2644// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2645// be renamed from that module.
2646// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002647type DependencyUse int
2648
2649const (
2650 RenameUseInvalid DependencyUse = iota
2651 RenameUseInclude
2652 RenameUseExclude
2653)
2654
2655type RenameUseElement struct {
2656 DepName string
2657 RenameUse DependencyUse
2658 Why string // token for determining where in the logic the decision was made.
2659}
2660
Joe Onorato349ae8d2024-02-05 22:46:00 +00002661type JarJarProviderData struct {
2662 // Mapping of class names: original --> renamed. If the value is "", the class will be
2663 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2664 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002665 Rename map[string]string
2666 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002667}
2668
2669func (this JarJarProviderData) GetDebugString() string {
2670 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002671 for _, k := range android.SortedKeys(this.Rename) {
2672 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002673 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2674 result += k + "--&gt;" + v + ";"
2675 }
2676 }
2677 return result
2678}
2679
2680var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2681
2682var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2683
2684func init() {
2685 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
Yu Liu26a716d2024-08-30 23:40:32 +00002686
2687 gob.Register(BaseJarJarProviderData{})
Joe Onorato349ae8d2024-02-05 22:46:00 +00002688}
2689
2690// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2691// whether they are java modules or not.
2692type BaseJarJarProviderData struct {
2693 JarJarProviderData JarJarProviderData
2694}
2695
2696func (this BaseJarJarProviderData) GetDebugString() string {
2697 return this.JarJarProviderData.GetDebugString()
2698}
2699
2700var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2701
2702// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2703// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2704// either JarJarProvider or BaseJarJarProvider.
2705func mergeJarJarPrefixes(ctx android.ModuleContext) {
2706 mod := ctx.Module()
2707 // Explicitly avoid propagating into some module types.
2708 switch reflect.TypeOf(mod).String() {
2709 case "*java.Droidstubs":
2710 return
2711 }
2712 jarJarData := collectDirectDepsProviders(ctx)
2713 if jarJarData != nil {
2714 providerData := BaseJarJarProviderData{
2715 JarJarProviderData: *jarJarData,
2716 }
2717 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2718 }
2719
2720}
2721
2722// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2723func (module *Module) addJarJarRenameRule(original string, renamed string) {
2724 if module.jarjarRenameRules == nil {
2725 module.jarjarRenameRules = make(map[string]string)
2726 }
2727 module.jarjarRenameRules[original] = renamed
2728}
2729
2730func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2731 // Gather repackage information from deps
2732 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002733
2734 module := ctx.Module()
2735 moduleName := module.Name()
2736
Joe Onorato349ae8d2024-02-05 22:46:00 +00002737 ctx.VisitDirectDepsIgnoreBlueprint(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002738 tag := ctx.OtherModuleDependencyTag(m)
2739 // This logic mirrors that in (*Module).collectDeps above. There are several places
2740 // where we explicitly return RenameUseExclude, even though it is the default, to
2741 // indicate that it has been verified to be the case.
2742 //
2743 // Note well: there are probably cases that are getting to the unconditional return
2744 // and are therefore wrong.
2745 shouldIncludeRenames := func() (DependencyUse, string) {
2746 if moduleName == m.Name() {
2747 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2748 }
2749 if sc, ok := module.(android.SdkContext); ok {
2750 if ctx.Device() {
2751 sdkDep := decodeSdkDep(ctx, sc)
2752 if !sdkDep.invalidVersion && sdkDep.useFiles {
2753 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002754 }
2755 }
LaMont Jones63683e42024-02-08 14:30:45 -08002756 }
2757 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2758 return RenameUseExclude, "tags"
2759 }
2760 if _, ok := m.(SdkLibraryDependency); ok {
2761 switch tag {
2762 case sdkLibTag, libTag:
2763 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2764 }
2765 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2766 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2767 switch ji.StubsLinkType {
2768 case Stubs:
2769 return RenameUseExclude, "info"
2770 case Implementation:
2771 return RenameUseInclude, "info"
2772 default:
LaMont Jones09721862024-06-11 10:30:50 -07002773 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002774 // Fall through to the heuristic logic.
2775 }
2776 switch reflect.TypeOf(m).String() {
2777 case "*java.GeneratedJavaLibraryModule":
2778 // Probably a java_aconfig_library module.
2779 // TODO: make this check better.
2780 return RenameUseInclude, "reflect"
2781 }
2782 switch tag {
2783 case bootClasspathTag:
2784 return RenameUseExclude, "tagswitch"
2785 case sdkLibTag, libTag, instrumentationForTag:
2786 return RenameUseInclude, "tagswitch"
2787 case java9LibTag:
2788 return RenameUseExclude, "tagswitch"
2789 case staticLibTag:
2790 return RenameUseInclude, "tagswitch"
2791 case pluginTag:
2792 return RenameUseInclude, "tagswitch"
2793 case errorpronePluginTag:
2794 return RenameUseInclude, "tagswitch"
2795 case exportedPluginTag:
2796 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002797 case kotlinPluginTag:
2798 return RenameUseInclude, "tagswitch"
2799 default:
2800 return RenameUseExclude, "tagswitch"
2801 }
2802 } else if _, ok := m.(android.SourceFileProducer); ok {
2803 switch tag {
2804 case sdkLibTag, libTag, staticLibTag:
2805 return RenameUseInclude, "srcfile"
2806 default:
2807 return RenameUseExclude, "srcfile"
2808 }
Yu Liu67a28422024-03-05 00:36:31 +00002809 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002810 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002811 } else {
2812 switch tag {
2813 case bootClasspathTag:
2814 return RenameUseExclude, "else"
2815 case systemModulesTag:
2816 return RenameUseInclude, "else"
2817 }
2818 }
2819 // If we got here, choose the safer option, which may lead to a build failure, rather
2820 // than runtime failures on the device.
2821 return RenameUseExclude, "end"
2822 }
2823
2824 if result == nil {
2825 result = &JarJarProviderData{
2826 Rename: make(map[string]string),
2827 RenameUse: make([]RenameUseElement, 0),
2828 }
2829 }
2830 how, why := shouldIncludeRenames()
2831 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2832 if how != RenameUseInclude {
2833 // Nothing to merge.
2834 return
2835 }
2836
2837 merge := func(theirs *JarJarProviderData) {
2838 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002839 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2840 result.Rename[orig] = renamed
2841 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2842 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2843 result.Rename[orig] = renamed
2844 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2845 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2846 continue
2847 }
2848 }
2849 }
2850 }
2851 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2852 merge(&theirs)
2853 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2854 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2855 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2856 // to java.Module.
2857 merge(&theirs.JarJarProviderData)
2858 }
2859 })
2860 return
2861}
2862
2863func (this Module) GetDebugString() string {
2864 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2865}
2866
2867// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2868// us, and if it's been set, apply the jarjar_prefix property to rename them.
2869func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2870 // Gather repackage information from deps
2871 result := collectDirectDepsProviders(ctx)
2872
Joe Onoratoa5d17172024-07-20 17:39:56 -07002873 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002874 if result == nil {
2875 result = &JarJarProviderData{
2876 Rename: make(map[string]string),
2877 }
2878 }
2879 if renamed != "" {
2880 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2881 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002882 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002883 }
2884 }
2885 (*result).Rename[orig] = renamed
2886 }
2887
Joe Onoratoa5d17172024-07-20 17:39:56 -07002888 // Update that with entries we've stored for ourself
2889 for orig, renamed := range module.jarjarRenameRules {
2890 add(orig, renamed)
2891 }
2892
2893 // Update that with entries given in the jarjar_rename property.
2894 for _, orig := range module.properties.Jarjar_rename {
2895 add(orig, "")
2896 }
2897
Joe Onorato349ae8d2024-02-05 22:46:00 +00002898 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2899 if result == nil {
2900 return nil
2901 }
2902
2903 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2904 // that have not yet been renamed.
2905 prefix := proptools.String(module.properties.Jarjar_prefix)
2906 if prefix != "" {
2907 if prefix[0] == '.' {
2908 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2909 return nil
2910 }
2911 if prefix[len(prefix)-1] == '.' {
2912 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2913 return nil
2914 }
2915
2916 var updated map[string]string
2917 for orig, renamed := range (*result).Rename {
2918 if renamed == "" {
2919 if updated == nil {
2920 updated = make(map[string]string)
2921 }
2922 updated[orig] = prefix + "." + orig
2923 }
2924 }
2925 for orig, renamed := range updated {
2926 (*result).Rename[orig] = renamed
2927 }
2928 }
2929
2930 return result
2931}
2932
2933// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2934// to "" won't be in this list because they shouldn't be renamed yet.
2935func getJarJarRuleText(provider *JarJarProviderData) string {
Colin Cross2ee388a2025-02-11 13:17:53 -08002936 result := strings.Builder{}
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002937 for _, orig := range android.SortedKeys(provider.Rename) {
2938 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002939 if renamed != "" {
Colin Cross2ee388a2025-02-11 13:17:53 -08002940 result.WriteString("rule ")
2941 result.WriteString(orig)
2942 result.WriteString(" ")
2943 result.WriteString(renamed)
2944 result.WriteString("\n")
Joe Onorato349ae8d2024-02-05 22:46:00 +00002945 }
2946 }
Colin Cross2ee388a2025-02-11 13:17:53 -08002947 return result.String()
Joe Onorato349ae8d2024-02-05 22:46:00 +00002948}
2949
Zi Wangddb2ee52024-04-02 16:44:02 +00002950// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002951func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Zi Wangddb2ee52024-04-02 16:44:02 +00002952 if j.repackageJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002953 return infile, false
Zi Wangddb2ee52024-04-02 16:44:02 +00002954 }
Colin Crossedec77c2024-07-26 15:25:40 -07002955 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002956 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002957 return repackagedJarjarFile, true
Zi Wangddb2ee52024-04-02 16:44:02 +00002958}
2959
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002960func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Colin Crossedec77c2024-07-26 15:25:40 -07002961 if j.expandJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002962 return infile, false
Colin Crossedec77c2024-07-26 15:25:40 -07002963 }
2964 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2965 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002966 return jarjarFile, true
Colin Crossedec77c2024-07-26 15:25:40 -07002967
2968}
2969
Jaewoong Jung26342642021-03-17 15:56:23 -07002970func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2971 deps.processorPath = append(deps.processorPath, pluginJars...)
2972 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2973}
2974
2975// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2976// this interface.
2977type ProvidesUsesLib interface {
2978 ProvidesUsesLib() *string
2979}
2980
2981func (j *Module) ProvidesUsesLib() *string {
2982 return j.usesLibraryProperties.Provides_uses_lib
2983}
satayev1c564cc2021-05-25 19:50:30 +01002984
2985type ModuleWithStem interface {
2986 Stem() string
2987}
2988
2989var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002990
2991type ModuleWithUsesLibrary interface {
2992 UsesLibrary() *usesLibrary
2993}
2994
2995func (j *Module) UsesLibrary() *usesLibrary {
2996 return &j.usesLibrary
2997}
2998
2999var _ ModuleWithUsesLibrary = (*Module)(nil)