blob: 652cc006b241e8c42046ed9630a169fde4d37694 [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 (
18 "fmt"
19 "path/filepath"
Joe Onorato349ae8d2024-02-05 22:46:00 +000020 "reflect"
21 "slices"
Jaewoong Jung26342642021-03-17 15:56:23 -070022 "strconv"
23 "strings"
24
Colin Crossd788b3e2023-11-28 13:14:56 -080025 "github.com/google/blueprint"
Jaewoong Jung26342642021-03-17 15:56:23 -070026 "github.com/google/blueprint/pathtools"
27 "github.com/google/blueprint/proptools"
28
29 "android/soong/android"
30 "android/soong/dexpreopt"
31 "android/soong/java/config"
32)
33
34// This file contains the definition and the implementation of the base module that most
35// source-based Java module structs embed.
36
37// TODO:
38// Autogenerated files:
39// Renderscript
40// Post-jar passes:
41// Proguard
42// Rmtypedefs
43// DroidDoc
44// Findbugs
45
46// Properties that are common to most Java modules, i.e. whether it's a host or device module.
47type CommonProperties struct {
48 // list of source files used to compile the Java module. May be .java, .kt, .logtags, .proto,
49 // or .aidl files.
50 Srcs []string `android:"path,arch_variant"`
51
52 // list Kotlin of source files containing Kotlin code that should be treated as common code in
53 // a codebase that supports Kotlin multiplatform. See
54 // https://kotlinlang.org/docs/reference/multiplatform.html. May be only be .kt files.
55 Common_srcs []string `android:"path,arch_variant"`
56
57 // list of source files that should not be used to build the Java module.
58 // This is most useful in the arch/multilib variants to remove non-common files
59 Exclude_srcs []string `android:"path,arch_variant"`
60
61 // list of directories containing Java resources
62 Java_resource_dirs []string `android:"arch_variant"`
63
64 // list of directories that should be excluded from java_resource_dirs
65 Exclude_java_resource_dirs []string `android:"arch_variant"`
66
67 // list of files to use as Java resources
68 Java_resources []string `android:"path,arch_variant"`
69
70 // list of files that should be excluded from java_resources and java_resource_dirs
71 Exclude_java_resources []string `android:"path,arch_variant"`
72
73 // list of module-specific flags that will be used for javac compiles
74 Javacflags []string `android:"arch_variant"`
75
76 // list of module-specific flags that will be used for kotlinc compiles
77 Kotlincflags []string `android:"arch_variant"`
78
79 // list of java libraries that will be in the classpath
80 Libs []string `android:"arch_variant"`
81
82 // list of java libraries that will be compiled into the resulting jar
83 Static_libs []string `android:"arch_variant"`
84
Jihoon Kang381c2fa2023-06-01 22:17:32 +000085 // list of java libraries that should not be used to build this module
86 Exclude_static_libs []string `android:"arch_variant"`
87
Jaewoong Jung26342642021-03-17 15:56:23 -070088 // manifest file to be included in resulting jar
89 Manifest *string `android:"path"`
90
91 // if not blank, run jarjar using the specified rules file
92 Jarjar_rules *string `android:"path,arch_variant"`
93
Joe Onoratoa5d17172024-07-20 17:39:56 -070094 // java class names to rename with jarjar when a reverse dependency has a jarjar_prefix
95 // property.
96 Jarjar_rename []string
97
Joe Onorato349ae8d2024-02-05 22:46:00 +000098 // if not blank, used as prefix to generate repackage rule
99 Jarjar_prefix *string
100
Zi Wang9bdd4222024-02-26 18:21:01 -0800101 // if set to true, skip the jarjar repackaging
102 Skip_jarjar_repackage *bool
103
Jaewoong Jung26342642021-03-17 15:56:23 -0700104 // If not blank, set the java version passed to javac as -source and -target
105 Java_version *string
106
107 // If set to true, allow this module to be dexed and installed on devices. Has no
108 // effect on host modules, which are always considered installable.
109 Installable *bool
110
111 // If set to true, include sources used to compile the module in to the final jar
112 Include_srcs *bool
113
114 // If not empty, classes are restricted to the specified packages and their sub-packages.
115 // This restriction is checked after applying jarjar rules and including static libs.
116 Permitted_packages []string
117
118 // List of modules to use as annotation processors
119 Plugins []string
120
121 // List of modules to export to libraries that directly depend on this library as annotation
122 // processors. Note that if the plugins set generates_api: true this will disable the turbine
123 // optimization on modules that depend on this module, which will reduce parallelism and cause
124 // more recompilation.
125 Exported_plugins []string
126
127 // The number of Java source entries each Javac instance can process
128 Javac_shard_size *int64
129
130 // Add host jdk tools.jar to bootclasspath
131 Use_tools_jar *bool
132
133 Openjdk9 struct {
134 // List of source files that should only be used when passing -source 1.9 or higher
135 Srcs []string `android:"path"`
136
137 // List of javac flags that should only be used when passing -source 1.9 or higher
138 Javacflags []string
139 }
140
141 // When compiling language level 9+ .java code in packages that are part of
142 // a system module, patch_module names the module that your sources and
143 // dependencies should be patched into. The Android runtime currently
144 // doesn't implement the JEP 261 module system so this option is only
145 // supported at compile time. It should only be needed to compile tests in
146 // packages that exist in libcore and which are inconvenient to move
147 // elsewhere.
Liz Kammer0a470a32023-10-05 17:02:00 -0400148 Patch_module *string
Jaewoong Jung26342642021-03-17 15:56:23 -0700149
150 Jacoco struct {
151 // List of classes to include for instrumentation with jacoco to collect coverage
152 // information at runtime when building with coverage enabled. If unset defaults to all
153 // classes.
154 // Supports '*' as the last character of an entry in the list as a wildcard match.
155 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
156 // it matches classes in the package that have the class name as a prefix.
157 Include_filter []string
158
159 // List of classes to exclude from instrumentation with jacoco to collect coverage
160 // information at runtime when building with coverage enabled. Overrides classes selected
161 // by the include_filter property.
162 // Supports '*' as the last character of an entry in the list as a wildcard match.
163 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
164 // it matches classes in the package that have the class name as a prefix.
165 Exclude_filter []string
166 }
167
168 Errorprone struct {
169 // List of javac flags that should only be used when running errorprone.
170 Javacflags []string
171
172 // List of java_plugin modules that provide extra errorprone checks.
173 Extra_check_modules []string
Cole Faust75fffb12021-06-13 15:23:16 -0700174
Cole Faust2b1536e2021-06-18 12:25:54 -0700175 // This property can be in 3 states. When set to true, errorprone will
176 // be run during the regular build. When set to false, errorprone will
177 // never be run. When unset, errorprone will be run when the RUN_ERROR_PRONE
178 // environment variable is true. Setting this to false will improve build
179 // performance more than adding -XepDisableAllChecks in javacflags.
Cole Faust75fffb12021-06-13 15:23:16 -0700180 Enabled *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700181 }
182
183 Proto struct {
184 // List of extra options that will be passed to the proto generator.
185 Output_params []string
186 }
187
Sam Delmericoc7593722022-08-31 15:57:52 -0400188 // If true, then jacocoagent is automatically added as a libs dependency so that
189 // r8 will not strip instrumentation classes out of dexed libraries.
Jaewoong Jung26342642021-03-17 15:56:23 -0700190 Instrument bool `blueprint:"mutated"`
Paul Duffin0038a8d2022-05-03 00:28:40 +0000191 // If true, then the module supports statically including the jacocoagent
192 // into the library.
193 Supports_static_instrumentation bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700194
195 // List of files to include in the META-INF/services folder of the resulting jar.
196 Services []string `android:"path,arch_variant"`
197
198 // If true, package the kotlin stdlib into the jar. Defaults to true.
199 Static_kotlin_stdlib *bool `android:"arch_variant"`
200
201 // A list of java_library instances that provide additional hiddenapi annotations for the library.
202 Hiddenapi_additional_annotations []string
Joe Onorato175073c2023-06-01 14:42:59 -0700203
204 // Additional srcJars tacked in by GeneratedJavaLibraryModule
205 Generated_srcjars []android.Path `android:"mutated"`
Mark Whitea15790a2023-08-22 21:28:11 +0000206
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000207 // intermediate aconfig cache file tacked in by GeneratedJavaLibraryModule
208 Aconfig_Cache_files []android.Path `android:"mutated"`
209
Mark Whitea15790a2023-08-22 21:28:11 +0000210 // If true, then only the headers are built and not the implementation jar.
Liz Kammer60772632023-10-05 17:18:44 -0400211 Headers_only *bool
Cole Faust2b64af82023-12-13 18:22:18 -0800212
213 // A list of files or dependencies to make available to the build sandbox. This is
214 // useful if source files are symlinks, the targets of the symlinks must be listed here.
215 // Note that currently not all actions implemented by android_apps are sandboxed, so you
216 // may only see this being necessary in lint builds.
217 Compile_data []string `android:"path"`
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000218
219 // Property signifying whether the module compiles stubs or not.
220 // Should be set to true when srcs of this module are stub files.
221 // This property does not need to be set to true when the module depends on
222 // the stubs via libs, but should be set to true when the module depends on
223 // the stubs via static libs.
224 Is_stubs_module *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700225
226 // If true, enable the "Ravenizer" tool on the output jar.
227 // "Ravenizer" is a tool for Ravenwood tests, but it can also be enabled on other kinds
228 // of java targets.
229 Ravenizer struct {
230 Enabled *bool
231 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +0000232
233 // Contributing api surface of the stub module. Is not visible to bp modules, and should
234 // only be set for stub submodules generated by the java_sdk_library
235 Stub_contributing_api *string `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700236}
237
238// Properties that are specific to device modules. Host module factories should not add these when
239// constructing a new module.
240type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000241 // If not blank, set to the version of the sdk to compile against.
Spandan Das1ccf5742022-10-14 16:51:23 +0000242 // Defaults to an empty string, which compiles the module against the private platform APIs.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000243 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000244 // 1) numerical API level, "current", "none", or "core_platform"
245 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
246 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
247 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700248 Sdk_version *string
249
satayev0a420e72021-11-29 17:25:52 +0000250 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
251 // Defaults to empty string "". See sdk_version for possible values.
252 Max_sdk_version *string
253
William Loh5a082f92022-05-17 20:21:50 +0000254 // if not blank, set the maxSdkVersion properties of permission and uses-permission tags.
255 // Defaults to empty string "". See sdk_version for possible values.
256 Replace_max_sdk_version_placeholder *string
257
Jaewoong Jung26342642021-03-17 15:56:23 -0700258 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000259 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700260 Target_sdk_version *string
261
262 // Whether to compile against the platform APIs instead of an SDK.
263 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000264 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700265 Platform_apis *bool
266
267 Aidl struct {
268 // Top level directories to pass to aidl tool
269 Include_dirs []string
270
271 // Directories rooted at the Android.bp file to pass to aidl tool
272 Local_include_dirs []string
273
274 // directories that should be added as include directories for any aidl sources of modules
275 // that depend on this module, as well as to aidl for this module.
276 Export_include_dirs []string
277
278 // whether to generate traces (for systrace) for this interface
279 Generate_traces *bool
280
281 // whether to generate Binder#GetTransaction name method.
282 Generate_get_transaction_name *bool
283
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100284 // whether all interfaces should be annotated with required permissions.
285 Enforce_permissions *bool
286
287 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
288 Enforce_permissions_exceptions []string `android:"path"`
289
Jaewoong Jung26342642021-03-17 15:56:23 -0700290 // list of flags that will be passed to the AIDL compiler
291 Flags []string
292 }
293
294 // If true, export a copy of the module as a -hostdex module for host testing.
295 Hostdex *bool
296
297 Target struct {
298 Hostdex struct {
299 // Additional required dependencies to add to -hostdex modules.
300 Required []string
301 }
302 }
303
304 // When targeting 1.9 and above, override the modules to use with --system,
305 // otherwise provides defaults libraries to add to the bootclasspath.
306 System_modules *string
307
Jaewoong Jung26342642021-03-17 15:56:23 -0700308 IsSDKLibrary bool `blueprint:"mutated"`
309
310 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
311 // Defaults to false.
312 V4_signature *bool
313
314 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
315 // public stubs library.
316 SyspropPublicStub string `blueprint:"mutated"`
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000317
318 HiddenAPIPackageProperties
319 HiddenAPIFlagFileProperties
Jaewoong Jung26342642021-03-17 15:56:23 -0700320}
321
yangbill2af0b6e2024-03-15 09:29:29 +0000322// Properties that can be overridden by overriding module (e.g. override_android_app)
323type OverridableProperties struct {
Jooyung Han01d80d82022-01-08 12:16:32 +0900324 // set the name of the output. If not set, `name` is used.
325 // To override a module with this property set, overriding module might need to set this as well.
326 // Otherwise, both the overridden and the overriding modules will have the same output name, which
327 // can cause the duplicate output error.
328 Stem *string
Spandan Dasb9c58352024-05-13 18:29:45 +0000329
330 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
331 // Defaults to sdk_version if not set. See sdk_version for possible values.
332 Min_sdk_version *string
Jooyung Han01d80d82022-01-08 12:16:32 +0900333}
334
Jaewoong Jung26342642021-03-17 15:56:23 -0700335// Functionality common to Module and Import
336//
337// It is embedded in Module so its functionality can be used by methods in Module
338// but it is currently only initialized by Import and Library.
339type embeddableInModuleAndImport struct {
340
341 // Functionality related to this being used as a component of a java_sdk_library.
342 EmbeddableSdkLibraryComponent
343}
344
Paul Duffin71b33cc2021-06-23 11:39:47 +0100345func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
346 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700347}
348
349// Module/Import's DepIsInSameApex(...) delegates to this method.
350//
351// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
352// the one provided by ApexModuleBase.
353func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
354 // dependencies other than the static linkage are all considered crossing APEX boundary
355 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
356 return true
357 }
358 return false
359}
360
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100361// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
362// or an invalid path describing the reason it is invalid.
363//
364// It is unset if a dex jar isn't applicable, i.e. no build rule has been
365// requested to create one.
366//
367// If a dex jar has been requested to be built then it is set, and it may be
368// either a valid android.Path, or invalid with a reason message. The latter
369// happens if the source that should produce the dex file isn't able to.
370//
371// E.g. it is invalid with a reason message if there is a prebuilt APEX that
372// could produce the dex jar through a deapexer module, but the APEX isn't
373// installable so doing so wouldn't be safe.
374type OptionalDexJarPath struct {
375 isSet bool
376 path android.OptionalPath
377}
378
379// IsSet returns true if a path has been set, either invalid or valid.
380func (o OptionalDexJarPath) IsSet() bool {
381 return o.isSet
382}
383
384// Valid returns true if there is a path that is valid.
385func (o OptionalDexJarPath) Valid() bool {
386 return o.isSet && o.path.Valid()
387}
388
389// Path returns the valid path, or panics if it's either not set or is invalid.
390func (o OptionalDexJarPath) Path() android.Path {
391 if !o.isSet {
392 panic("path isn't set")
393 }
394 return o.path.Path()
395}
396
397// PathOrNil returns the path if it's set and valid, or else nil.
398func (o OptionalDexJarPath) PathOrNil() android.Path {
399 if o.Valid() {
400 return o.Path()
401 }
402 return nil
403}
404
405// InvalidReason returns the reason for an invalid path, which is never "". It
406// returns "" for an unset or valid path.
407func (o OptionalDexJarPath) InvalidReason() string {
408 if !o.isSet {
409 return ""
410 }
411 return o.path.InvalidReason()
412}
413
414func (o OptionalDexJarPath) String() string {
415 if !o.isSet {
416 return "<unset>"
417 }
418 return o.path.String()
419}
420
421// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
422func makeUnsetDexJarPath() OptionalDexJarPath {
423 return OptionalDexJarPath{isSet: false}
424}
425
426// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
427// the given OptionalPath, which may be valid or invalid.
428func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
429 return OptionalDexJarPath{isSet: true, path: path}
430}
431
432// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
433// valid given path. It returns an unset OptionalDexJarPath if the given path is
434// nil.
435func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
436 if path == nil {
437 return makeUnsetDexJarPath()
438 }
439 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
440}
441
Jaewoong Jung26342642021-03-17 15:56:23 -0700442// Module contains the properties and members used by all java module types
443type Module struct {
444 android.ModuleBase
445 android.DefaultableModuleBase
446 android.ApexModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700447
448 // Functionality common to Module and Import.
449 embeddableInModuleAndImport
450
451 properties CommonProperties
452 protoProperties android.ProtoProperties
453 deviceProperties DeviceProperties
454
yangbill2af0b6e2024-03-15 09:29:29 +0000455 overridableProperties OverridableProperties
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700456 sourceProperties android.SourceProperties
Jooyung Han01d80d82022-01-08 12:16:32 +0900457
Jaewoong Jung26342642021-03-17 15:56:23 -0700458 // jar file containing header classes including static library dependencies, suitable for
459 // inserting into the bootclasspath/classpath of another compile
460 headerJarFile android.Path
461
Joe Onorato349ae8d2024-02-05 22:46:00 +0000462 repackagedHeaderJarFile android.Path
463
Jaewoong Jung26342642021-03-17 15:56:23 -0700464 // jar file containing implementation classes including static library dependencies but no
465 // resources
466 implementationJarFile android.Path
467
468 // jar file containing only resources including from static library dependencies
469 resourceJar android.Path
470
471 // args and dependencies to package source files into a srcjar
472 srcJarArgs []string
473 srcJarDeps android.Paths
474
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000475 // the source files of this module and all its static dependencies
476 transitiveSrcFiles *android.DepSet[android.Path]
477
Jaewoong Jung26342642021-03-17 15:56:23 -0700478 // jar file containing implementation classes and resources including static library
479 // dependencies
480 implementationAndResourcesJar android.Path
481
482 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100483 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700484
485 // output file containing uninstrumented classes that will be instrumented by jacoco
486 jacocoReportClassesFile android.Path
487
488 // output file of the module, which may be a classes jar or a dex jar
489 outputFile android.Path
490 extraOutputFiles android.Paths
491
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100492 exportAidlIncludeDirs android.Paths
493 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700494
495 logtagsSrcs android.Paths
496
497 // installed file for binary dependency
498 installFile android.Path
499
Colin Cross3108ce12021-11-10 14:38:50 -0800500 // installed file for hostdex copy
501 hostdexInstallFile android.InstallPath
502
Chaohui Wangdcbe33c2022-10-11 11:13:30 +0800503 // list of unique .java and .kt source files
504 uniqueSrcFiles android.Paths
505
506 // list of srcjars that was passed to javac
507 compiledSrcJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700508
509 // manifest file to use instead of properties.Manifest
510 overrideManifest android.OptionalPath
511
Jaewoong Jung26342642021-03-17 15:56:23 -0700512 // list of plugins that this java module is exporting
513 exportedPluginJars android.Paths
514
515 // list of plugins that this java module is exporting
516 exportedPluginClasses []string
517
518 // if true, the exported plugins generate API and require disabling turbine.
519 exportedDisableTurbine bool
520
521 // list of source files, collected from srcFiles with unique java and all kt files,
522 // will be used by android.IDEInfo struct
523 expandIDEInfoCompiledSrcs []string
524
525 // expanded Jarjar_rules
526 expandJarjarRules android.Path
527
Joe Onorato349ae8d2024-02-05 22:46:00 +0000528 // jarjar rule for inherited jarjar rules
529 repackageJarjarRules android.Path
530
Jaewoong Jung26342642021-03-17 15:56:23 -0700531 // Extra files generated by the module type to be added as java resources.
532 extraResources android.Paths
533
534 hiddenAPI
535 dexer
536 dexpreopter
537 usesLibrary
538 linter
539
540 // list of the xref extraction files
541 kytheFiles android.Paths
542
Jaewoong Jung26342642021-03-17 15:56:23 -0700543 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900544
545 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000546 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000547 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400548
549 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000550
551 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000552
553 // output file name based on Stem property.
554 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
555 // or the module should override Stem().
556 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700557
Joe Onorato349ae8d2024-02-05 22:46:00 +0000558 // Values that will be set in the JarJarProvider data for jarjar repackaging,
559 // and merged with our dependencies' rules.
560 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000561
562 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000563
564 // Paths to the aconfig intermediate cache files that are provided by the
565 // java_aconfig_library or java_library modules that are statically linked
566 // to this module. Does not contain cache files from all transitive dependencies.
567 aconfigCacheFiles android.Paths
Spandan Das8aac9932024-07-18 23:14:13 +0000568
569 // List of soong module dependencies required to compile the current module.
570 // This information is printed out to `Dependencies` field in module_bp_java_deps.json
571 compileDepNames []string
Makoto Onuki7ded3822024-03-28 14:42:20 -0700572
573 ravenizer struct {
574 enabled bool
575 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700576}
577
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000578var _ android.InstallableModule = (*Module)(nil)
579
580// To satisfy the InstallableModule interface
Jihoon Kang224ea082024-08-12 22:38:16 +0000581func (j *Module) StaticDependencyTags() []blueprint.DependencyTag {
582 return []blueprint.DependencyTag{staticLibTag}
583}
584
585// To satisfy the InstallableModule interface
586func (j *Module) DynamicDependencyTags() []blueprint.DependencyTag {
587 return []blueprint.DependencyTag{libTag, sdkLibTag, bootClasspathTag, systemModulesTag,
588 instrumentationForTag, java9LibTag}
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000589}
590
591// Overrides android.ModuleBase.InstallInProduct()
592func (j *Module) InstallInProduct() bool {
593 return j.ProductSpecific()
594}
595
Jihoon Kang85bc1932024-07-01 17:04:46 +0000596var _ android.StubsAvailableModule = (*Module)(nil)
597
598// To safisfy the StubsAvailableModule interface
599func (j *Module) IsStubsModule() bool {
600 return proptools.Bool(j.properties.Is_stubs_module)
601}
602
Jiyong Park92315372021-04-02 08:45:46 +0900603func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
604 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900605 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700606 return nil
607 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900608 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000609 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700610 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
611 } else {
612 // Treat stable core platform as stable.
613 return nil
614 }
615 } else {
616 return fmt.Errorf("non stable SDK %v", sdkVersion)
617 }
618}
619
620// checkSdkVersions enforces restrictions around SDK dependencies.
621func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
622 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900623 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900624 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700625 ctx.PropertyErrorf("sdk_version",
626 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
627 }
628 }
629 }
630
631 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
632 // See rank() for details.
633 ctx.VisitDirectDeps(func(module android.Module) {
634 tag := ctx.OtherModuleDependencyTag(module)
635 switch module.(type) {
636 // TODO(satayev): cover other types as well, e.g. imports
637 case *Library, *AndroidLibrary:
638 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400639 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700640 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
641 }
642 }
643 })
644}
645
646func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900647 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700648 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900649 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700650 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000651 ctx.PropertyErrorf("platform_apis", "This module has conflicting settings. sdk_version is not empty, which means this module cannot use platform APIs. However platform_apis is set to true.")
Jaewoong Jung26342642021-03-17 15:56:23 -0700652 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000653 ctx.PropertyErrorf("platform_apis", "This module has conflicting settings. sdk_version is empty, which means that this module is build against platform APIs. However platform_apis is not set to true")
Jaewoong Jung26342642021-03-17 15:56:23 -0700654 }
655
656 }
657}
658
Mark Whitea15790a2023-08-22 21:28:11 +0000659func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
660 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400661 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000662 installable := proptools.Bool(j.properties.Installable)
663
664 if headersOnly && installable {
665 ctx.PropertyErrorf("headers_only", "This module has conflicting settings. headers_only is true which, which means this module doesn't generate an implementation jar. However installable is set to true.")
666 }
667 }
668}
669
Jaewoong Jung26342642021-03-17 15:56:23 -0700670func (j *Module) addHostProperties() {
671 j.AddProperties(
672 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000673 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700674 &j.protoProperties,
675 &j.usesLibraryProperties,
676 )
677}
678
679func (j *Module) addHostAndDeviceProperties() {
680 j.addHostProperties()
681 j.AddProperties(
682 &j.deviceProperties,
683 &j.dexer.dexProperties,
684 &j.dexpreoptProperties,
685 &j.linter.properties,
686 )
687}
688
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000689// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
690// makes it available through the hiddenAPIPropertyInfoProvider.
691func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
692 hiddenAPIInfo := newHiddenAPIPropertyInfo()
693
694 // Populate with flag file paths from the properties.
695 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
696
697 // Populate with package rules from the properties.
698 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
699
Colin Cross40213022023-12-13 15:19:49 -0800700 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000701}
702
mrziwang9f7b9f42024-07-10 12:18:06 -0700703// helper method for java modules to set OutputFilesProvider
704func setOutputFiles(ctx android.ModuleContext, m Module) {
705 ctx.SetOutputFiles(append(android.Paths{m.outputFile}, m.extraOutputFiles...), "")
706 ctx.SetOutputFiles(android.Paths{m.outputFile}, android.DefaultDistTag)
707 ctx.SetOutputFiles(android.Paths{m.implementationAndResourcesJar}, ".jar")
708 ctx.SetOutputFiles(android.Paths{m.headerJarFile}, ".hjar")
709 if m.dexer.proguardDictionary.Valid() {
710 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
711 }
712 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
713 if m.linter.outputs.xml != nil {
714 ctx.SetOutputFiles(android.Paths{m.linter.outputs.xml}, ".lint")
Jaewoong Jung26342642021-03-17 15:56:23 -0700715 }
716}
717
Jaewoong Jung26342642021-03-17 15:56:23 -0700718func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
719 initJavaModule(module, hod, false)
720}
721
722func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
723 initJavaModule(module, hod, true)
724}
725
726func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
727 multilib := android.MultilibCommon
728 if multiTargets {
729 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
730 } else {
731 android.InitAndroidArchModule(module, hod, multilib)
732 }
733 android.InitDefaultableModule(module)
734}
735
736func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
737 return j.properties.Instrument &&
738 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
739 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
740}
741
742func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000743 return j.properties.Supports_static_instrumentation &&
744 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700745 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
746 ctx.Config().UnbundledBuild())
747}
748
749func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
750 // Force enable the instrumentation for java code that is built for APEXes ...
751 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
752 // doesn't make sense) or framework libraries (e.g. libraries found in the InstrumentFrameworkModules list) unless EMMA_INSTRUMENT_FRAMEWORK is true.
Colin Crossff694a82023-12-13 15:54:49 -0800753 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700754 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000755
Jihoon Kang46d66de2024-05-22 22:42:39 +0000756 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700757 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
758 return true
759 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
760 return true
761 }
762 }
763 return false
764}
765
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400766func (j *Module) setInstrument(value bool) {
767 j.properties.Instrument = value
768}
769
Jiyong Park92315372021-04-02 08:45:46 +0900770func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
771 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700772}
773
Jiyong Parkf1691d22021-03-29 20:11:58 +0900774func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700775 return proptools.String(j.deviceProperties.System_modules)
776}
777
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000778func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000779 if j.overridableProperties.Min_sdk_version != nil {
780 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700781 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000782 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700783}
784
Yu Liuf2b94012023-09-19 15:09:10 -0700785func (j *Module) GetDeviceProperties() *DeviceProperties {
786 return &j.deviceProperties
787}
788
Spandan Dasa26eda72023-03-02 00:56:06 +0000789func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
790 if j.deviceProperties.Max_sdk_version != nil {
791 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
792 }
793 // Default is PrivateApiLevel
794 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000795}
796
Spandan Dasa26eda72023-03-02 00:56:06 +0000797func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
798 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
799 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
800 }
801 // Default is PrivateApiLevel
802 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000803}
804
Jiyong Parkf1691d22021-03-29 20:11:58 +0900805func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000806 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900807}
808
Spandan Dasca70fc42023-03-01 23:38:49 +0000809func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900810 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000811 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900812 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000813 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700814}
815
816func (j *Module) AvailableFor(what string) bool {
817 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
818 // Exception: for hostdex: true libraries, the platform variant is created
819 // even if it's not marked as available to platform. In that case, the platform
820 // variant is used only for the hostdex and not installed to the device.
821 return true
822 }
823 return j.ApexModuleBase.AvailableFor(what)
824}
825
826func (j *Module) deps(ctx android.BottomUpMutatorContext) {
827 if ctx.Device() {
828 j.linter.deps(ctx)
829
Jiyong Parkf1691d22021-03-29 20:11:58 +0900830 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700831
832 if j.deviceProperties.SyspropPublicStub != "" {
833 // This is a sysprop implementation library that has a corresponding sysprop public
834 // stubs library, and a dependency on it so that dependencies on the implementation can
835 // be forwarded to the public stubs library when necessary.
836 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
837 }
838 }
839
840 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000841
842 j.properties.Static_libs = android.RemoveListFromList(j.properties.Static_libs, j.properties.Exclude_static_libs)
Jaewoong Jung26342642021-03-17 15:56:23 -0700843 ctx.AddVariationDependencies(nil, staticLibTag, j.properties.Static_libs...)
844
845 // Add dependency on libraries that provide additional hidden api annotations.
846 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
847
Kiyoung Kim9743bab2024-03-28 15:44:56 +0900848 if ctx.Config().EnforceInterPartitionJavaSdkLibrary() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700849 // Require java_sdk_library at inter-partition java dependency to ensure stable
850 // interface between partitions. If inter-partition java_library dependency is detected,
851 // raise build error because java_library doesn't have a stable interface.
852 //
853 // Inputs:
854 // PRODUCT_ENFORCE_INTER_PARTITION_JAVA_SDK_LIBRARY
855 // if true, enable enforcement
856 // PRODUCT_INTER_PARTITION_JAVA_LIBRARY_ALLOWLIST
857 // exception list of java_library names to allow inter-partition dependency
858 for idx := range j.properties.Libs {
859 if libDeps[idx] == nil {
860 continue
861 }
862
863 if javaDep, ok := libDeps[idx].(javaSdkLibraryEnforceContext); ok {
864 // java_sdk_library is always allowed at inter-partition dependency.
865 // So, skip check.
866 if _, ok := javaDep.(*SdkLibrary); ok {
867 continue
868 }
869
870 j.checkPartitionsForJavaDependency(ctx, "libs", javaDep)
871 }
872 }
873 }
874
875 // For library dependencies that are component libraries (like stubs), add the implementation
876 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
877 for _, dep := range libDeps {
878 if dep != nil {
879 if component, ok := dep.(SdkLibraryComponentDependency); ok {
880 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000881 // Add library as optional if it's one of the optional compatibility libs or it's
882 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100883 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000884 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
885 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100886 tag = usesLibOptTag
887 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100888 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700889 }
890 }
891 }
892 }
893
894 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
895 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
896 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
897
898 android.ProtoDeps(ctx, &j.protoProperties)
899 if j.hasSrcExt(".proto") {
900 protoDeps(ctx, &j.protoProperties)
901 }
902
903 if j.hasSrcExt(".kt") {
904 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
905 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700906 tag := staticLibTag
907 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
908 tag = libTag
909 }
910 ctx.AddVariationDependencies(nil, tag,
911 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700912 }
913
914 // Framework libraries need special handling in static coverage builds: they should not have
915 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
916 // the same jacoco classes coming from different bootclasspath jars.
917 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
918 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
919 j.properties.Instrument = true
920 }
921 } else if j.shouldInstrumentStatic(ctx) {
922 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
923 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700924
925 if j.useCompose() {
926 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
927 "androidx.compose.compiler_compiler-hosted")
928 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700929}
930
931func hasSrcExt(srcs []string, ext string) bool {
932 for _, src := range srcs {
933 if filepath.Ext(src) == ext {
934 return true
935 }
936 }
937
938 return false
939}
940
941func (j *Module) hasSrcExt(ext string) bool {
942 return hasSrcExt(j.properties.Srcs, ext)
943}
944
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100945func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
946 var flags string
947
948 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
949 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
950 flags = "-Wmissing-permission-annotation -Werror"
951 }
952 }
953 return flags
954}
955
Jaewoong Jung26342642021-03-17 15:56:23 -0700956func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000957 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700958
959 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
960 aidlIncludes = append(aidlIncludes,
961 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
962 aidlIncludes = append(aidlIncludes,
963 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
964
965 var flags []string
966 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000967 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700968
969 flags = append(flags, j.deviceProperties.Aidl.Flags...)
970
971 if aidlPreprocess.Valid() {
972 flags = append(flags, "-p"+aidlPreprocess.String())
973 deps = append(deps, aidlPreprocess.Path())
974 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000975 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700976 }
977
978 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000979 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700980 }
981
982 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000983 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700984 }
985
Sam Delmerico2351eac2022-05-24 17:10:02 +0000986 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700987 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000988 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700989 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000990 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
991 // add flags for dirs containing AIDL srcs that haven't been specified yet
992 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -0700993
Zim8774ae12022-08-17 11:46:34 +0100994 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +0000995 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +0100996 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700997 flags = append(flags, "-t")
998 }
999
1000 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
1001 flags = append(flags, "--transaction_names")
1002 }
1003
Thiébaud Weksteende8417c2022-02-10 15:41:46 +11001004 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
1005 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
1006 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1007 }
1008
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001009 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001010 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1011
Jaewoong Jung26342642021-03-17 15:56:23 -07001012 return strings.Join(flags, " "), deps
1013}
1014
1015func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1016
1017 var flags javaBuilderFlags
1018
1019 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001020 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001021
Cole Faust2b1536e2021-06-18 12:25:54 -07001022 epEnabled := j.properties.Errorprone.Enabled
1023 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001024 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001025 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1026 }
1027
1028 errorProneFlags := []string{
1029 "-Xplugin:ErrorProne",
1030 "${config.ErrorProneChecks}",
1031 }
1032 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1033
Colin Cross8bf6cad2022-02-28 13:07:03 -08001034 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001035 "'" + strings.Join(errorProneFlags, " ") + "'"
1036 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1037 }
1038
1039 // classpath
1040 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1041 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001042 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001043 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1044 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1045 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1046
1047 flags.processors = append(flags.processors, deps.processorClasses...)
1048 flags.processors = android.FirstUniqueStrings(flags.processors)
1049
1050 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001051 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001052 // Give host-side tools a version of OpenJDK's standard libraries
1053 // close to what they're targeting. As of Dec 2017, AOSP is only
1054 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1055 //
1056 // When building with OpenJDK 8, the following should have no
1057 // effect since those jars would be available by default.
1058 //
1059 // When building with OpenJDK 9 but targeting a version < 1.8,
1060 // putting them on the bootclasspath means that:
1061 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1062 // b) references to existing APIs are not reinterpreted in an
1063 // OpenJDK 9-specific way, eg. calls to subclasses of
1064 // java.nio.Buffer as in http://b/70862583
1065 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1066 flags.bootClasspath = append(flags.bootClasspath,
1067 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1068 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1069 if Bool(j.properties.Use_tools_jar) {
1070 flags.bootClasspath = append(flags.bootClasspath,
1071 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1072 }
1073 }
1074
1075 // systemModules
1076 flags.systemModules = deps.systemModules
1077
Jaewoong Jung26342642021-03-17 15:56:23 -07001078 return flags
1079}
1080
1081func (j *Module) collectJavacFlags(
1082 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1083 // javac flags.
1084 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001085 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001086
Mythri Alle4b9f6182023-10-25 15:17:11 +00001087 needsDebugInfo = false
1088 for _, flag := range javacFlags {
1089 if strings.HasPrefix(flag, "-g") {
1090 needsDebugInfo = true
1091 }
1092 }
1093
1094 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001095 // For non-host binaries, override the -g flag passed globally to remove
1096 // local variable debug info to reduce disk and memory usage.
1097 javacFlags = append(javacFlags, "-g:source,lines")
1098 }
1099 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1100
1101 if flags.javaVersion.usesJavaModules() {
1102 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001103 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1104 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1105 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1106 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001107
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001108 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001109 if j.properties.Patch_module != nil {
1110 // Manually specify build directory in case it is not under the repo root.
1111 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1112 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001113 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001114
Jaewoong Jung26342642021-03-17 15:56:23 -07001115 classPath := flags.classpath.FormJavaClassPath("")
1116 if classPath != "" {
1117 patchPaths = append(patchPaths, classPath)
1118 }
1119 javacFlags = append(
1120 javacFlags,
1121 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1122 }
1123 }
1124
1125 if len(javacFlags) > 0 {
1126 // optimization.
1127 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1128 flags.javacFlags = "$javacFlags"
1129 }
1130
1131 return flags
1132}
1133
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001134func (j *Module) AddJSONData(d *map[string]interface{}) {
1135 (&j.ModuleBase).AddJSONData(d)
1136 (*d)["Java"] = map[string]interface{}{
1137 "SourceExtensions": j.sourceExtensions,
1138 }
1139
1140}
1141
usta0391ca42023-09-19 15:51:59 -04001142func (j *Module) addGeneratedSrcJars(path android.Path) {
1143 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001144}
1145
Colin Cross4eae06d2023-06-20 22:40:02 -07001146func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001147 // Auto-propagating jarjar rules
1148 jarjarProviderData := j.collectJarJarRules(ctx)
1149 if jarjarProviderData != nil {
1150 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wang9bdd4222024-02-26 18:21:01 -08001151 if !proptools.Bool(j.properties.Skip_jarjar_repackage) {
1152 text := getJarJarRuleText(jarjarProviderData)
1153 if text != "" {
1154 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1155 android.WriteFileRule(ctx, ruleTextFile, text)
1156 j.repackageJarjarRules = ruleTextFile
1157 }
Joe Onorato349ae8d2024-02-05 22:46:00 +00001158 }
1159 }
1160
Jaewoong Jung26342642021-03-17 15:56:23 -07001161 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1162
Makoto Onuki7ded3822024-03-28 14:42:20 -07001163 if re := proptools.Bool(j.properties.Ravenizer.Enabled); re {
1164 j.ravenizer.enabled = re
1165 }
1166
Jaewoong Jung26342642021-03-17 15:56:23 -07001167 deps := j.collectDeps(ctx)
1168 flags := j.collectBuilderFlags(ctx, deps)
1169
1170 if flags.javaVersion.usesJavaModules() {
1171 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001172 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1173 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1174 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001175 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001176
Jaewoong Jung26342642021-03-17 15:56:23 -07001177 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001178 j.sourceExtensions = []string{}
1179 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1180 if hasSrcExt(srcFiles.Strings(), ext) {
1181 j.sourceExtensions = append(j.sourceExtensions, ext)
1182 }
1183 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001184 if hasSrcExt(srcFiles.Strings(), ".proto") {
1185 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1186 }
1187
1188 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1189 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1190 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1191 }
1192
Sam Delmerico2351eac2022-05-24 17:10:02 +00001193 aidlSrcs := srcFiles.FilterByExt(".aidl")
1194 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1195
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001196 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001197 srcFiles = j.genSources(ctx, srcFiles, flags)
1198
1199 // Collect javac flags only after computing the full set of srcFiles to
1200 // ensure that the --patch-module lookup paths are complete.
1201 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1202
1203 srcJars := srcFiles.FilterByExt(".srcjar")
1204 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001205 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001206 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001207 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001208
1209 if j.properties.Jarjar_rules != nil {
1210 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1211 }
1212
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001213 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001214
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001215 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001216 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001217 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001218 if _, found := set[v.String()]; !found {
1219 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001220 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001221 }
1222 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001223 var uniqueKtFiles android.Paths
1224 for _, v := range srcFiles.FilterByExt(".kt") {
1225 if _, found := set[v.String()]; !found {
1226 set[v.String()] = true
1227 uniqueKtFiles = append(uniqueKtFiles, v)
1228 }
1229 }
1230
1231 var uniqueSrcFiles android.Paths
1232 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1233 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1234 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001235 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001236
Colin Crossb5db4012022-03-28 17:12:39 -07001237 // We don't currently run annotation processors in turbine, which means we can't use turbine
1238 // generated header jars when an annotation processor that generates API is enabled. One
1239 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1240 // is used to run all of the annotation processors.
1241 disableTurbine := deps.disableTurbine
1242
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001243 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001244 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1245
1246 var kotlinJars android.Paths
Colin Cross220a9a12022-03-28 17:08:01 -07001247 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001248
Colin Cross4eae06d2023-06-20 22:40:02 -07001249 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1250 // any dependencies so that it can override any non-final R classes from dependencies with the
1251 // final R classes from the app.
1252 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1253
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001254 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1255
Mark Whitea15790a2023-08-22 21:28:11 +00001256 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001257 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001258 if srcFiles.HasExt(".kt") {
1259 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1260 }
1261 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1262 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1263 }
1264
Colin Crossedec77c2024-07-26 15:25:40 -07001265 _, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
1266 extraCombinedJars)
1267
1268 combinedHeaderJarFile = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1269 combinedHeaderJarFile = j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
Mark Whitea15790a2023-08-22 21:28:11 +00001270 if ctx.Failed() {
1271 return
1272 }
Colin Crossedec77c2024-07-26 15:25:40 -07001273 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001274
Colin Crossa6182ab2024-08-21 10:47:44 -07001275 ctx.CheckbuildFile(j.headerJarFile)
1276
Colin Cross7727c7f2024-07-18 15:36:32 -07001277 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001278 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
Colin Cross9ffaf282024-08-12 13:50:09 -07001279 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1280 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001281 AidlIncludeDirs: j.exportAidlIncludeDirs,
1282 ExportedPlugins: j.exportedPluginJars,
1283 ExportedPluginClasses: j.exportedPluginClasses,
1284 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1285 StubsLinkType: j.stubsLinkType,
1286 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001287 })
1288
1289 j.outputFile = j.headerJarFile
1290 return
1291 }
1292
Jaewoong Jung26342642021-03-17 15:56:23 -07001293 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001294 // When using kotlin sources turbine is used to generate annotation processor sources,
1295 // including for annotation processors that generate API, so we can use turbine for
1296 // java sources too.
1297 disableTurbine = false
1298
Jaewoong Jung26342642021-03-17 15:56:23 -07001299 // user defined kotlin flags.
1300 kotlincFlags := j.properties.Kotlincflags
1301 CheckKotlincFlags(ctx, kotlincFlags)
1302
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001303 // Workaround for KT-46512
1304 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001305
1306 // If there are kotlin files, compile them first but pass all the kotlin and java files
1307 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1308 // won't emit any classes for them.
1309 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1310 if ctx.Device() {
1311 kotlincFlags = append(kotlincFlags, "-no-jdk")
1312 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001313
1314 for _, plugin := range deps.kotlinPlugins {
1315 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1316 }
1317 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1318
Jaewoong Jung26342642021-03-17 15:56:23 -07001319 if len(kotlincFlags) > 0 {
1320 // optimization.
1321 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1322 flags.kotlincFlags += "$kotlincFlags"
1323 }
1324
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001325 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001326 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1327
Jaewoong Jung26342642021-03-17 15:56:23 -07001328 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1329 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1330
Isaac Chioua23d9942022-04-06 06:14:38 +00001331 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001332 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001333 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1334 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001335 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001336 srcJars = append(srcJars, kaptSrcJar)
1337 kotlinJars = append(kotlinJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001338 // Disable annotation processing in javac, it's already been handled by kapt
1339 flags.processorPath = nil
1340 flags.processors = nil
1341 }
1342
1343 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001344 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001345 kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001346 if ctx.Failed() {
1347 return
1348 }
1349
Colin Cross7707b242024-07-26 12:02:36 -07001350 kotlinJarPath := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001351
Isaac Chioua23d9942022-04-06 06:14:38 +00001352 // Make javac rule depend on the kotlinc rule
1353 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1354
Zi Wangddb2ee52024-04-02 16:44:02 +00001355 kotlinJars = append(kotlinJars, kotlinJarPath)
Colin Cross220a9a12022-03-28 17:08:01 -07001356 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001357 }
1358
Colin Crossfd620b22024-02-23 10:05:21 -08001359 jars := slices.Clone(kotlinJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001360
Jaewoong Jung26342642021-03-17 15:56:23 -07001361 j.compiledSrcJars = srcJars
1362
1363 enableSharding := false
Colin Cross3d56ed52021-11-18 22:23:12 -08001364 var headerJarFileWithoutDepsOrJarjar android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001365 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001366 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1367 enableSharding = true
1368 // Formerly, there was a check here that prevented annotation processors
1369 // from being used when sharding was enabled, as some annotation processors
1370 // do not function correctly in sharded environments. It was removed to
1371 // allow for the use of annotation processors that do function correctly
1372 // with sharding enabled. See: b/77284273.
1373 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001374 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001375 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001376 var combinedHeaderJarFile android.Path
1377 headerJarFileWithoutDepsOrJarjar, combinedHeaderJarFile =
Colin Cross4eae06d2023-06-20 22:40:02 -07001378 j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
Colin Crossedec77c2024-07-26 15:25:40 -07001379
1380 j.headerJarFile = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1381 j.repackagedHeaderJarFile = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
Jaewoong Jung26342642021-03-17 15:56:23 -07001382 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001383 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001384 hasErrorproneableFiles := false
1385 for _, ext := range j.sourceExtensions {
1386 if ext != ".proto" && ext != ".aidl" {
1387 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1388 // compile, and it's not useful to have warnings on these generated sources.
1389 hasErrorproneableFiles = true
1390 break
1391 }
1392 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001393 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001394 if Bool(j.properties.Errorprone.Enabled) {
1395 // If error-prone is enabled, enable errorprone flags on the regular
1396 // build.
1397 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001398 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001399 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1400 // a new jar file just for compiling with the errorprone compiler to.
1401 // This is because we don't want to cause the java files to get completely
1402 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1403 // We also don't want to run this if errorprone is enabled by default for
1404 // this module, or else we could have duplicated errorprone messages.
1405 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001406 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001407 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001408
Vadim Spivak3c496f02023-06-08 06:14:59 +00001409 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001410 "errorprone", "errorprone")
1411
Jaewoong Jung26342642021-03-17 15:56:23 -07001412 extraJarDeps = append(extraJarDeps, errorprone)
1413 }
1414
1415 if enableSharding {
Colin Cross3d56ed52021-11-18 22:23:12 -08001416 if headerJarFileWithoutDepsOrJarjar != nil {
1417 flags.classpath = append(classpath{headerJarFileWithoutDepsOrJarjar}, flags.classpath...)
1418 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001419 shardSize := int(*(j.properties.Javac_shard_size))
1420 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001421 if len(uniqueJavaFiles) > 0 {
1422 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001423 for idx, shardSrc := range shardSrcs {
1424 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1425 nil, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001426 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
Jaewoong Jung26342642021-03-17 15:56:23 -07001427 jars = append(jars, classes)
1428 }
1429 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001430 // Assume approximately 5 sources per srcjar.
1431 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1432 // 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 -07001433 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001434 startIdx := len(shardSrcs)
1435 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1436 for idx, shardSrcJars := range shardSrcJarsList {
1437 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1438 nil, shardSrcJars, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001439 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
Colin Crossa052ddb2023-09-25 21:46:58 -07001440 jars = append(jars, classes)
1441 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001442 }
1443 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001444 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001445 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
Jaewoong Jung26342642021-03-17 15:56:23 -07001446 jars = append(jars, classes)
1447 }
1448 if ctx.Failed() {
1449 return
1450 }
1451 }
1452
Colin Crossfd620b22024-02-23 10:05:21 -08001453 jars = append(jars, extraCombinedJars...)
1454
Jaewoong Jung26342642021-03-17 15:56:23 -07001455 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1456
1457 var includeSrcJar android.WritablePath
1458 if Bool(j.properties.Include_srcs) {
1459 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1460 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1461 }
1462
1463 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1464 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1465 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1466 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1467
1468 var resArgs []string
1469 var resDeps android.Paths
1470
1471 resArgs = append(resArgs, dirArgs...)
1472 resDeps = append(resDeps, dirDeps...)
1473
1474 resArgs = append(resArgs, fileArgs...)
1475 resDeps = append(resDeps, fileDeps...)
1476
1477 resArgs = append(resArgs, extraArgs...)
1478 resDeps = append(resDeps, extraDeps...)
1479
1480 if len(resArgs) > 0 {
1481 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1482 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
1483 j.resourceJar = resourceJar
1484 if ctx.Failed() {
1485 return
1486 }
1487 }
1488
1489 var resourceJars android.Paths
1490 if j.resourceJar != nil {
1491 resourceJars = append(resourceJars, j.resourceJar)
1492 }
1493 if Bool(j.properties.Include_srcs) {
1494 resourceJars = append(resourceJars, includeSrcJar)
1495 }
1496 resourceJars = append(resourceJars, deps.staticResourceJars...)
1497
1498 if len(resourceJars) > 1 {
1499 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1500 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1501 false, nil, nil)
1502 j.resourceJar = combinedJar
1503 } else if len(resourceJars) == 1 {
1504 j.resourceJar = resourceJars[0]
1505 }
1506
1507 if len(deps.staticJars) > 0 {
1508 jars = append(jars, deps.staticJars...)
1509 }
1510
1511 manifest := j.overrideManifest
1512 if !manifest.Valid() && j.properties.Manifest != nil {
1513 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
1514 }
1515
1516 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1517 if len(services) > 0 {
1518 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1519 var zipargs []string
1520 for _, file := range services {
1521 serviceFile := file.String()
1522 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1523 }
1524 rule := zip
1525 args := map[string]string{
1526 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1527 }
1528 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1529 rule = zipRE
1530 args["implicits"] = strings.Join(services.Strings(), ",")
1531 }
1532 ctx.Build(pctx, android.BuildParams{
1533 Rule: rule,
1534 Output: servicesJar,
1535 Implicits: services,
1536 Args: args,
1537 })
1538 jars = append(jars, servicesJar)
1539 }
1540
1541 // Combine the classes built from sources, any manifests, and any static libraries into
1542 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001543 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001544
1545 if len(jars) == 1 && !manifest.Valid() {
1546 // Optimization: skip the combine step as there is nothing to do
1547 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1548 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1549 // any if len(jars) == 1.
1550
Jihoon Kang1147b312023-06-08 23:25:57 +00001551 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1552 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1553 // either with .from-source or .from-text suffix.
1554 // outputFile should be agnostic to the build configuration,
1555 // thus "combine" the single static lib in order to prevent the static lib from being exposed
1556 // to the copy rules.
Jihoon Kangfa3f0782024-08-21 20:42:18 +00001557 stub, _ := moduleStubLinkType(j)
Jihoon Kang1147b312023-06-08 23:25:57 +00001558
Colin Cross7707b242024-07-26 12:02:36 -07001559 if stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07001560 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1561 ctx.Build(pctx, android.BuildParams{
1562 Rule: android.Cp,
1563 Input: jars[0],
1564 Output: combinedJar,
1565 })
Colin Cross7707b242024-07-26 12:02:36 -07001566 outputFile = combinedJar
1567 } else {
1568 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001569 }
1570 } else {
1571 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1572 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1573 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001574 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001575 }
1576
1577 // jarjar implementation jar if necessary
Colin Crossedec77c2024-07-26 15:25:40 -07001578 jarjarFile := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1579 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001580
Colin Crossedec77c2024-07-26 15:25:40 -07001581 // jarjar resource jar if necessary
1582 if j.resourceJar != nil {
1583 resourceJarJarFile := j.jarjarIfNecessary(ctx, j.resourceJar, jarName, "resource")
1584 j.resourceJar = resourceJarJarFile
1585 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001586
Colin Crossedec77c2024-07-26 15:25:40 -07001587 if ctx.Failed() {
1588 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001589 }
1590
Makoto Onuki7ded3822024-03-28 14:42:20 -07001591 if j.ravenizer.enabled {
1592 ravenizerInput := outputFile
1593 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", jarName)
1594 ctx.Build(pctx, android.BuildParams{
1595 Rule: ravenizer,
1596 Description: "ravenizer",
1597 Input: ravenizerInput,
1598 Output: ravenizerOutput,
1599 })
1600 outputFile = ravenizerOutput
1601 }
1602
Jaewoong Jung26342642021-03-17 15:56:23 -07001603 // Check package restrictions if necessary.
1604 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001605 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001606 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001607
1608 // Create a rule to copy the output jar to another path and add a validate dependency that
1609 // will check that the jar only contains the permitted packages. The new location will become
1610 // the output file of this module.
1611 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001612 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001613 ctx.Build(pctx, android.BuildParams{
1614 Rule: android.Cp,
1615 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001616 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001617 // Make sure that any dependency on the output file will cause ninja to run the package check
1618 // rule.
1619 Validation: pkgckFile,
1620 })
Colin Cross7707b242024-07-26 12:02:36 -07001621 outputFile = packageCheckOutputFile
Paul Duffin08a18bf2021-10-01 13:19:58 +01001622
1623 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001624 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001625
1626 if ctx.Failed() {
1627 return
1628 }
1629 }
1630
1631 j.implementationJarFile = outputFile
1632 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001633 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1634 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1635 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1636 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1637 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1638 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1639 j.headerJarFile = headerJarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001640 }
1641
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001642 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1643 specs := j.jacocoModuleToZipCommand(ctx)
1644 if ctx.Failed() {
1645 return
1646 }
1647
Jaewoong Jung26342642021-03-17 15:56:23 -07001648 if j.shouldInstrument(ctx) {
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001649 outputFile = j.instrument(ctx, flags, outputFile, jarName, specs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001650 }
1651
1652 // merge implementation jar with resources if necessary
1653 implementationAndResourcesJar := outputFile
1654 if j.resourceJar != nil {
1655 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Colin Cross7707b242024-07-26 12:02:36 -07001656 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001657 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
1658 false, nil, nil)
1659 implementationAndResourcesJar = combinedJar
1660 }
1661
1662 j.implementationAndResourcesJar = implementationAndResourcesJar
1663
1664 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001665 compileDex := j.dexProperties.Compile_dex
Colin Crossff694a82023-12-13 15:54:49 -08001666 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -07001667 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001668 if compileDex == nil {
1669 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001670 }
1671 if j.deviceProperties.Hostdex == nil {
1672 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1673 }
1674 }
1675
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001676 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001677 if j.hasCode(ctx) {
1678 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001679 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001680 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1681 }
1682 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001683 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001684 params := &compileDexParams{
1685 flags: flags,
1686 sdkVersion: j.SdkVersion(ctx),
1687 minSdkVersion: j.MinSdkVersion(ctx),
1688 classesJar: implementationAndResourcesJar,
1689 jarName: jarName,
1690 }
Spandan Das15a67112024-05-30 00:07:40 +00001691 if j.GetProfileGuided() && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting() {
1692 ctx.PropertyErrorf("enable_profile_rewriting",
1693 "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.",
1694 )
1695 }
Spandan Das3dbda182024-05-20 22:23:10 +00001696 if j.EnableProfileRewriting() {
1697 profile := j.GetProfile()
1698 if profile == "" || !j.GetProfileGuided() {
1699 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1700 }
1701 params.artProfileInput = &profile
1702 }
1703 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001704 if ctx.Failed() {
1705 return
1706 }
1707
Spandan Das3dbda182024-05-20 22:23:10 +00001708 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1709 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001710 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001711 }
1712
Jaewoong Jung26342642021-03-17 15:56:23 -07001713 // merge dex jar with resources if necessary
1714 if j.resourceJar != nil {
1715 jars := android.Paths{dexOutputFile, j.resourceJar}
Colin Cross7707b242024-07-26 12:02:36 -07001716 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001717 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1718 false, nil, nil)
1719 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001720 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001721 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001722 dexOutputFile = combinedAlignedJar
1723 } else {
1724 dexOutputFile = combinedJar
1725 }
1726 }
1727
Paul Duffin4de94502021-05-16 05:21:16 +01001728 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001729
1730 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001731
1732 // Encode hidden API flags in dex file, if needed.
1733 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1734
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001735 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001736
1737 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001738 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1739 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1740 libName = strings.TrimSuffix(libName, ".impl")
1741 }
1742 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001743
1744 outputFile = dexOutputFile
Colin Crossa6182ab2024-08-21 10:47:44 -07001745
1746 ctx.CheckbuildFile(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001747 } else {
1748 // There is no code to compile into a dex jar, make sure the resources are propagated
1749 // to the APK if this is an app.
1750 outputFile = implementationAndResourcesJar
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001751 j.dexJarFile = makeDexJarPathFromPath(j.resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001752 }
1753
1754 if ctx.Failed() {
1755 return
1756 }
1757 } else {
1758 outputFile = implementationAndResourcesJar
1759 }
1760
1761 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001762 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001763 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001764 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001765 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001766 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001767 }
1768 }
1769
1770 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001771 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1772 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001773 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1774 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001775 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001776 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001777 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001778 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001779 j.linter.javaLanguageLevel = flags.javaVersion.String()
1780 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001781 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001782 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1783 j.linter.buildModuleReportZip = true
1784 }
1785 j.linter.lint(ctx)
1786 }
1787
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001788 j.collectTransitiveSrcFiles(ctx, srcFiles)
1789
Colin Crossa6182ab2024-08-21 10:47:44 -07001790 ctx.CheckbuildFile(j.implementationJarFile)
1791 ctx.CheckbuildFile(j.headerJarFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001792
Colin Cross7727c7f2024-07-18 15:36:32 -07001793 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001794 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1795 RepackagedHeaderJars: android.PathsIfNonNil(j.repackagedHeaderJarFile),
Colin Cross9ffaf282024-08-12 13:50:09 -07001796 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1797 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001798 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1799 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
1800 ResourceJars: android.PathsIfNonNil(j.resourceJar),
1801 AidlIncludeDirs: j.exportAidlIncludeDirs,
1802 SrcJarArgs: j.srcJarArgs,
1803 SrcJarDeps: j.srcJarDeps,
1804 TransitiveSrcFiles: j.transitiveSrcFiles,
1805 ExportedPlugins: j.exportedPluginJars,
1806 ExportedPluginClasses: j.exportedPluginClasses,
1807 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1808 JacocoReportClassesFile: j.jacocoReportClassesFile,
1809 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001810 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001811 })
1812
1813 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1814 j.outputFile = outputFile.WithoutRel()
1815}
1816
Colin Crossa1ff7c62021-09-17 14:11:52 -07001817func (j *Module) useCompose() bool {
1818 return android.InList("androidx.compose.runtime_runtime", j.properties.Static_libs)
1819}
1820
Colin Crosscde55342024-03-27 14:11:51 -07001821func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []*android.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001822 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001823 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001824 depTag := ctx.OtherModuleDependencyTag(m)
1825
1826 if depProguardInfo.UnconditionallyExportedProguardFlags != nil {
1827 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1828 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1829 }
1830
1831 if depTag == staticLibTag && depProguardInfo.ProguardFlagsFiles != nil {
1832 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1833 }
1834 })
1835
Colin Crosscde55342024-03-27 14:11:51 -07001836 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1837}
1838
1839func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1840 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1841
Sam Delmerico95d70942023-08-02 18:00:35 -04001842 directUnconditionalExportedFlags := android.Paths{}
1843 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1844 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1845 if exportUnconditionally {
1846 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1847 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1848 directUnconditionalExportedFlags = proguardFlagsForThisModule
1849 }
1850
1851 return ProguardSpecInfo{
1852 Export_proguard_flags_files: exportUnconditionally,
1853 ProguardFlagsFiles: android.NewDepSet[android.Path](
1854 android.POSTORDER,
1855 proguardFlagsForThisModule,
1856 transitiveProguardFlags,
1857 ),
1858 UnconditionallyExportedProguardFlags: android.NewDepSet[android.Path](
1859 android.POSTORDER,
1860 directUnconditionalExportedFlags,
1861 transitiveUnconditionalExportedFlags,
1862 ),
1863 }
1864
1865}
1866
Cole Faust75fffb12021-06-13 15:23:16 -07001867// Returns a copy of the supplied flags, but with all the errorprone-related
1868// fields copied to the regular build's fields.
1869func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1870 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1871
1872 if len(flags.errorProneExtraJavacFlags) > 0 {
1873 if len(flags.javacFlags) > 0 {
1874 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
1875 } else {
1876 flags.javacFlags = flags.errorProneExtraJavacFlags
1877 }
1878 }
1879 return flags
1880}
1881
Jaewoong Jung26342642021-03-17 15:56:23 -07001882func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07001883 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07001884
1885 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00001886 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001887 if idx >= 0 {
1888 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00001889 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001890 jarName += strconv.Itoa(idx)
1891 }
1892
Colin Cross7707b242024-07-26 12:02:36 -07001893 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001894 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001895
Cole Faust9decf832024-06-11 11:45:53 -07001896 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001897 extractionFile := android.PathForModuleOut(ctx, kzipName)
1898 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1899 j.kytheFiles = append(j.kytheFiles, extractionFile)
1900 }
1901
Vadim Spivak3c496f02023-06-08 06:14:59 +00001902 if len(flags.processorPath) > 0 {
1903 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
1904 }
1905
Jaewoong Jung26342642021-03-17 15:56:23 -07001906 return classes
1907}
1908
1909// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1910// since some of these flags may be used internally.
1911func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1912 for _, flag := range flags {
1913 flag = strings.TrimSpace(flag)
1914
1915 if !strings.HasPrefix(flag, "-") {
1916 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1917 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1918 ctx.PropertyErrorf("kotlincflags",
1919 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1920 } else if inList(flag, config.KotlincIllegalFlags) {
1921 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1922 } else if flag == "-include-runtime" {
1923 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1924 } else {
1925 args := strings.Split(flag, " ")
1926 if args[0] == "-kotlin-home" {
1927 ctx.PropertyErrorf("kotlincflags",
1928 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1929 }
1930 }
1931 }
1932}
1933
1934func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
1935 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossedec77c2024-07-26 15:25:40 -07001936 extraJars android.Paths) (headerJar android.Path, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001937
1938 var jars android.Paths
1939 if len(srcFiles) > 0 || len(srcJars) > 0 {
1940 // Compile java sources into turbine.jar.
1941 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1942 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001943 jars = append(jars, turbineJar)
Colin Cross3d56ed52021-11-18 22:23:12 -08001944 headerJar = turbineJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001945 }
1946
1947 jars = append(jars, extraJars...)
1948
1949 // Combine any static header libraries into classes-header.jar. If there is only
1950 // one input jar this step will be skipped.
1951 jars = append(jars, deps.staticHeaderJars...)
1952
1953 // we cannot skip the combine step for now if there is only one jar
1954 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07001955 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
1956 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001957 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07001958
Colin Crossa6182ab2024-08-21 10:47:44 -07001959 ctx.CheckbuildFile(combinedHeaderJarOutputPath)
1960
Colin Crossedec77c2024-07-26 15:25:40 -07001961 return headerJar, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07001962}
1963
1964func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07001965 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07001966
1967 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07001968 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001969
1970 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1971
1972 j.jacocoReportClassesFile = jacocoReportClassesFile
1973
1974 return instrumentedJar
1975}
1976
Colin Cross9ffaf282024-08-12 13:50:09 -07001977type providesTransitiveHeaderJarsForR8 struct {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001978 // set of header jars for all transitive libs deps
Colin Cross9ffaf282024-08-12 13:50:09 -07001979 transitiveLibsHeaderJarsForR8 *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001980 // set of header jars for all transitive static libs deps
Colin Cross9ffaf282024-08-12 13:50:09 -07001981 transitiveStaticLibsHeaderJarsForR8 *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001982}
1983
Colin Cross9ffaf282024-08-12 13:50:09 -07001984// collectTransitiveHeaderJarsForR8 visits direct dependencies and collects all transitive libs and static_libs
1985// header jars. The semantics of the collected jars are odd (it collects combined jars that contain the static
1986// libs, but also the static libs, and it collects transitive libs dependencies of static_libs), so these
1987// are only used to expand the --lib arguments to R8.
1988func (j *providesTransitiveHeaderJarsForR8) collectTransitiveHeaderJarsForR8(ctx android.ModuleContext) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001989 directLibs := android.Paths{}
1990 directStaticLibs := android.Paths{}
Colin Crossc85750b2022-04-21 12:50:51 -07001991 transitiveLibs := []*android.DepSet[android.Path]{}
1992 transitiveStaticLibs := []*android.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001993 ctx.VisitDirectDeps(func(module android.Module) {
1994 // don't add deps of the prebuilt version of the same library
1995 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
1996 return
1997 }
1998
Colin Cross7727c7f2024-07-18 15:36:32 -07001999 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2000 tag := ctx.OtherModuleDependencyTag(module)
2001 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2002 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2003 directLibs = append(directLibs, dep.HeaderJars...)
2004 } else if tag == staticLibTag {
2005 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2006 } else {
2007 // Don't propagate transitive libs for other kinds of dependencies.
2008 return
2009 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002010
Colin Cross9ffaf282024-08-12 13:50:09 -07002011 if dep.TransitiveLibsHeaderJarsForR8 != nil {
2012 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJarsForR8)
Colin Cross7727c7f2024-07-18 15:36:32 -07002013 }
Colin Cross9ffaf282024-08-12 13:50:09 -07002014 if dep.TransitiveStaticLibsHeaderJarsForR8 != nil {
2015 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJarsForR8)
Colin Cross7727c7f2024-07-18 15:36:32 -07002016 }
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002017 }
2018 })
Colin Cross9ffaf282024-08-12 13:50:09 -07002019 j.transitiveLibsHeaderJarsForR8 = android.NewDepSet(android.POSTORDER, directLibs, transitiveLibs)
2020 j.transitiveStaticLibsHeaderJarsForR8 = android.NewDepSet(android.POSTORDER, directStaticLibs, transitiveStaticLibs)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002021}
2022
Jaewoong Jung26342642021-03-17 15:56:23 -07002023func (j *Module) HeaderJars() android.Paths {
2024 if j.headerJarFile == nil {
2025 return nil
2026 }
2027 return android.Paths{j.headerJarFile}
2028}
2029
2030func (j *Module) ImplementationJars() android.Paths {
2031 if j.implementationJarFile == nil {
2032 return nil
2033 }
2034 return android.Paths{j.implementationJarFile}
2035}
2036
Spandan Das59a4a2b2024-01-09 21:35:56 +00002037func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002038 return j.dexJarFile
2039}
2040
2041func (j *Module) DexJarInstallPath() android.Path {
2042 return j.installFile
2043}
2044
2045func (j *Module) ImplementationAndResourcesJars() android.Paths {
2046 if j.implementationAndResourcesJar == nil {
2047 return nil
2048 }
2049 return android.Paths{j.implementationAndResourcesJar}
2050}
2051
2052func (j *Module) AidlIncludeDirs() android.Paths {
2053 // exportAidlIncludeDirs is type android.Paths already
2054 return j.exportAidlIncludeDirs
2055}
2056
2057func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2058 return j.classLoaderContexts
2059}
2060
2061// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002062func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002063 // jarjar rules will repackage the sources. To prevent misleading results, IdeInfo should contain the
2064 // repackaged jar instead of the input sources.
Jaewoong Jung26342642021-03-17 15:56:23 -07002065 if j.expandJarjarRules != nil {
2066 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002067 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
2068 } else {
2069 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2070 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2071 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002072 }
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002073 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2074 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Yikef6282022022-04-13 20:41:01 +08002075 dpInfo.Static_libs = append(dpInfo.Static_libs, j.properties.Static_libs...)
2076 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002077}
2078
2079func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002080 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002081}
2082
2083func (j *Module) hasCode(ctx android.ModuleContext) bool {
2084 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2085 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2086}
2087
2088// Implements android.ApexModule
2089func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2090 return j.depIsInSameApex(ctx, dep)
2091}
2092
2093// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002094func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002095 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002096 minSdkVersion := j.MinSdkVersion(ctx)
2097 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002098 return fmt.Errorf("min_sdk_version is not specified")
2099 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002100 // If the module is compiling against core (via sdk_version), skip comparison check.
2101 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002102 return nil
2103 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002104 if minSdkVersion.GreaterThan(sdkVersion) {
2105 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002106 }
2107 return nil
2108}
2109
2110func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002111 if j.stem == "" {
2112 panic("Stem() called before stem property was set")
2113 }
2114 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002115}
2116
Jaewoong Jung26342642021-03-17 15:56:23 -07002117func (j *Module) JacocoReportClassesFile() android.Path {
2118 return j.jacocoReportClassesFile
2119}
2120
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002121func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
2122 var fromDeps []*android.DepSet[android.Path]
2123 ctx.VisitDirectDeps(func(module android.Module) {
2124 tag := ctx.OtherModuleDependencyTag(module)
2125 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002126 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2127 if depInfo.TransitiveSrcFiles != nil {
2128 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
2129 }
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002130 }
2131 }
2132 })
2133
2134 j.transitiveSrcFiles = android.NewDepSet(android.POSTORDER, mine, fromDeps)
2135}
2136
Jaewoong Jung26342642021-03-17 15:56:23 -07002137func (j *Module) IsInstallable() bool {
2138 return Bool(j.properties.Installable)
2139}
2140
2141type sdkLinkType int
2142
2143const (
2144 // TODO(jiyong) rename these for better readability. Make the allowed
2145 // and disallowed link types explicit
2146 // order is important here. See rank()
2147 javaCore sdkLinkType = iota
2148 javaSdk
2149 javaSystem
2150 javaModule
2151 javaSystemServer
2152 javaPlatform
2153)
2154
2155func (lt sdkLinkType) String() string {
2156 switch lt {
2157 case javaCore:
2158 return "core Java API"
2159 case javaSdk:
2160 return "Android API"
2161 case javaSystem:
2162 return "system API"
2163 case javaModule:
2164 return "module API"
2165 case javaSystemServer:
2166 return "system server API"
2167 case javaPlatform:
2168 return "private API"
2169 default:
2170 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2171 }
2172}
2173
2174// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2175// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2176// can't statically depend on modules that use Platform API.
2177func (lt sdkLinkType) rank() int {
2178 return int(lt)
2179}
2180
2181type moduleWithSdkDep interface {
2182 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002183 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002184}
2185
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002186func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2187 switch k {
2188 case android.SdkCore:
2189 return javaCore
2190 case android.SdkSystem:
2191 return javaSystem
2192 case android.SdkPublic:
2193 return javaSdk
2194 case android.SdkModule:
2195 return javaModule
2196 case android.SdkSystemServer:
2197 return javaSystemServer
2198 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2199 return javaPlatform
2200 default:
2201 return javaSdk
2202 }
2203}
2204
Jiyong Park92315372021-04-02 08:45:46 +09002205func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002206 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002207 case android.SdkCore.DefaultJavaLibraryName(),
2208 "legacy.core.platform.api.stubs",
2209 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002210 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002211 "core-lambda-stubs",
Jihoon Kangb5078312023-03-29 23:25:49 +00002212 "core-generated-annotation-stubs":
Jaewoong Jung26342642021-03-17 15:56:23 -07002213 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002214 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002215 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002216 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002217 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002218 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002219 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002220 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002221 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002222 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002223 return javaSystem, true
2224 }
2225
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002226 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002227 return linkType, true
2228 }
2229
Jiyong Park92315372021-04-02 08:45:46 +09002230 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002231 if !ver.Valid() {
2232 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002233 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002234
2235 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002236}
2237
2238// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2239// this module's. See the comment on rank() for details and an example.
2240func (j *Module) checkSdkLinkType(
2241 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2242 if ctx.Host() {
2243 return
2244 }
2245
Jiyong Park92315372021-04-02 08:45:46 +09002246 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002247 if stubs {
2248 return
2249 }
Jiyong Park92315372021-04-02 08:45:46 +09002250 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002251
2252 if myLinkType.rank() < depLinkType.rank() {
2253 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2254 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2255 "property of the source or target module so that target module is built "+
2256 "with the same or smaller API set when compared to the source.",
2257 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2258 }
2259}
2260
2261func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2262 var deps deps
2263
2264 if ctx.Device() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09002265 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07002266 if sdkDep.invalidVersion {
2267 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2268 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2269 } else if sdkDep.useFiles {
2270 // sdkDep.jar is actually equivalent to turbine header.jar.
2271 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002272 deps.dexClasspath = append(deps.dexClasspath, sdkDep.jars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002273 deps.aidlPreprocess = sdkDep.aidl
Spandan Das6e8bd1c2024-08-09 00:07:03 +00002274 // Add the sdk module dependency to `compileDepNames`.
2275 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2276 // TODO (b/358608607): Move this to decodeSdkDep
2277 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2278 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
Jaewoong Jung26342642021-03-17 15:56:23 -07002279 } else {
2280 deps.aidlPreprocess = sdkDep.aidl
2281 }
2282 }
2283
Jiyong Park92315372021-04-02 08:45:46 +09002284 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002285
Colin Cross9ffaf282024-08-12 13:50:09 -07002286 j.collectTransitiveHeaderJarsForR8(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07002287 ctx.VisitDirectDeps(func(module android.Module) {
2288 otherName := ctx.OtherModuleName(module)
2289 tag := ctx.OtherModuleDependencyTag(module)
2290
2291 if IsJniDepTag(tag) {
2292 // Handled by AndroidApp.collectAppDeps
2293 return
2294 }
2295 if tag == certificateTag {
2296 // Handled by AndroidApp.collectAppDeps
2297 return
2298 }
2299
2300 if dep, ok := module.(SdkLibraryDependency); ok {
2301 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002302 case sdkLibTag, libTag:
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002303 depHeaderJars := dep.SdkHeaderJars(ctx, j.SdkVersion(ctx))
2304 deps.classpath = append(deps.classpath, depHeaderJars...)
2305 deps.dexClasspath = append(deps.dexClasspath, depHeaderJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002306 case staticLibTag:
2307 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
2308 }
Colin Cross313aa542023-12-13 13:47:44 -08002309 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2310 if sdkLinkType != javaPlatform {
2311 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2312 // dep is a sysprop implementation library, but this module is not linking against
2313 // the platform, so it gets the sysprop public stubs library instead. Replace
2314 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2315 dep = syspropDep.JavaInfo
2316 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002317 }
2318 switch tag {
2319 case bootClasspathTag:
2320 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002321 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002322 if _, ok := module.(*Plugin); ok {
2323 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2324 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002325 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002326 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002327 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2328 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2329 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2330 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002331 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2332 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2333 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
2334 case java9LibTag:
2335 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
2336 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002337 if _, ok := module.(*Plugin); ok {
2338 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2339 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002340 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2341 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2342 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2343 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2344 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2345 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2346 // Turbine doesn't run annotation processors, so any module that uses an
2347 // annotation processor that generates API is incompatible with the turbine
2348 // optimization.
2349 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002350 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002351 case pluginTag:
2352 if plugin, ok := module.(*Plugin); ok {
2353 if plugin.pluginProperties.Processor_class != nil {
2354 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2355 } else {
2356 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2357 }
2358 // Turbine doesn't run annotation processors, so any module that uses an
2359 // annotation processor that generates API is incompatible with the turbine
2360 // optimization.
2361 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2362 } else {
2363 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2364 }
2365 case errorpronePluginTag:
2366 if _, ok := module.(*Plugin); ok {
2367 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2368 } else {
2369 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2370 }
2371 case exportedPluginTag:
2372 if plugin, ok := module.(*Plugin); ok {
2373 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2374 if plugin.pluginProperties.Processor_class != nil {
2375 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2376 }
2377 // Turbine doesn't run annotation processors, so any module that uses an
2378 // annotation processor that generates API is incompatible with the turbine
2379 // optimization.
2380 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2381 } else {
2382 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2383 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002384 case kotlinPluginTag:
2385 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002386 case syspropPublicStubDepTag:
2387 // This is a sysprop implementation library, forward the JavaInfoProvider from
2388 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002389 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002390 JavaInfo: dep,
2391 })
2392 }
2393 } else if dep, ok := module.(android.SourceFileProducer); ok {
2394 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002395 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002396 checkProducesJars(ctx, dep)
2397 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002398 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002399 case staticLibTag:
2400 checkProducesJars(ctx, dep)
2401 deps.classpath = append(deps.classpath, dep.Srcs()...)
2402 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2403 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
2404 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002405 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002406 switch tag {
2407 case staticLibTag:
2408 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2409 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002410 } else {
2411 switch tag {
2412 case bootClasspathTag:
2413 // If a system modules dependency has been added to the bootclasspath
2414 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002415 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2416 depHeaderJars := sm.HeaderJars
2417 deps.bootClasspath = append(deps.bootClasspath, depHeaderJars...)
2418 } else {
2419 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2420 ctx.OtherModuleName(module))
2421 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002422
2423 case systemModulesTag:
2424 if deps.systemModules != nil {
2425 panic("Found two system module dependencies")
2426 }
Colin Crossb61c2262024-08-08 14:04:42 -07002427 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2428 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2429 } else {
2430 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2431 ctx.OtherModuleName(module))
2432 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002433
2434 case instrumentationForTag:
2435 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 -07002436 }
2437 }
2438
Spandan Das8aac9932024-07-18 23:14:13 +00002439 if android.InList(tag, compileDependencyTags) {
2440 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2441 j.compileDepNames = append(j.compileDepNames, otherName)
2442 }
2443
Jaewoong Jung26342642021-03-17 15:56:23 -07002444 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002445 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002446 })
2447
2448 return deps
2449}
2450
Joe Onorato349ae8d2024-02-05 22:46:00 +00002451// Provider for jarjar renaming rules.
2452//
2453// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2454// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2455// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2456// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2457// be renamed from that module.
2458// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002459type DependencyUse int
2460
2461const (
2462 RenameUseInvalid DependencyUse = iota
2463 RenameUseInclude
2464 RenameUseExclude
2465)
2466
2467type RenameUseElement struct {
2468 DepName string
2469 RenameUse DependencyUse
2470 Why string // token for determining where in the logic the decision was made.
2471}
2472
Joe Onorato349ae8d2024-02-05 22:46:00 +00002473type JarJarProviderData struct {
2474 // Mapping of class names: original --> renamed. If the value is "", the class will be
2475 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2476 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002477 Rename map[string]string
2478 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002479}
2480
2481func (this JarJarProviderData) GetDebugString() string {
2482 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002483 for _, k := range android.SortedKeys(this.Rename) {
2484 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002485 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2486 result += k + "--&gt;" + v + ";"
2487 }
2488 }
2489 return result
2490}
2491
2492var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2493
2494var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2495
2496func init() {
2497 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
2498}
2499
2500// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2501// whether they are java modules or not.
2502type BaseJarJarProviderData struct {
2503 JarJarProviderData JarJarProviderData
2504}
2505
2506func (this BaseJarJarProviderData) GetDebugString() string {
2507 return this.JarJarProviderData.GetDebugString()
2508}
2509
2510var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2511
2512// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2513// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2514// either JarJarProvider or BaseJarJarProvider.
2515func mergeJarJarPrefixes(ctx android.ModuleContext) {
2516 mod := ctx.Module()
2517 // Explicitly avoid propagating into some module types.
2518 switch reflect.TypeOf(mod).String() {
2519 case "*java.Droidstubs":
2520 return
2521 }
2522 jarJarData := collectDirectDepsProviders(ctx)
2523 if jarJarData != nil {
2524 providerData := BaseJarJarProviderData{
2525 JarJarProviderData: *jarJarData,
2526 }
2527 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2528 }
2529
2530}
2531
2532// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2533func (module *Module) addJarJarRenameRule(original string, renamed string) {
2534 if module.jarjarRenameRules == nil {
2535 module.jarjarRenameRules = make(map[string]string)
2536 }
2537 module.jarjarRenameRules[original] = renamed
2538}
2539
2540func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2541 // Gather repackage information from deps
2542 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002543
2544 module := ctx.Module()
2545 moduleName := module.Name()
2546
Joe Onorato349ae8d2024-02-05 22:46:00 +00002547 ctx.VisitDirectDepsIgnoreBlueprint(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002548 tag := ctx.OtherModuleDependencyTag(m)
2549 // This logic mirrors that in (*Module).collectDeps above. There are several places
2550 // where we explicitly return RenameUseExclude, even though it is the default, to
2551 // indicate that it has been verified to be the case.
2552 //
2553 // Note well: there are probably cases that are getting to the unconditional return
2554 // and are therefore wrong.
2555 shouldIncludeRenames := func() (DependencyUse, string) {
2556 if moduleName == m.Name() {
2557 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2558 }
2559 if sc, ok := module.(android.SdkContext); ok {
2560 if ctx.Device() {
2561 sdkDep := decodeSdkDep(ctx, sc)
2562 if !sdkDep.invalidVersion && sdkDep.useFiles {
2563 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002564 }
2565 }
LaMont Jones63683e42024-02-08 14:30:45 -08002566 }
2567 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2568 return RenameUseExclude, "tags"
2569 }
2570 if _, ok := m.(SdkLibraryDependency); ok {
2571 switch tag {
2572 case sdkLibTag, libTag:
2573 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2574 }
2575 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2576 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2577 switch ji.StubsLinkType {
2578 case Stubs:
2579 return RenameUseExclude, "info"
2580 case Implementation:
2581 return RenameUseInclude, "info"
2582 default:
LaMont Jones09721862024-06-11 10:30:50 -07002583 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002584 // Fall through to the heuristic logic.
2585 }
2586 switch reflect.TypeOf(m).String() {
2587 case "*java.GeneratedJavaLibraryModule":
2588 // Probably a java_aconfig_library module.
2589 // TODO: make this check better.
2590 return RenameUseInclude, "reflect"
2591 }
2592 switch tag {
2593 case bootClasspathTag:
2594 return RenameUseExclude, "tagswitch"
2595 case sdkLibTag, libTag, instrumentationForTag:
2596 return RenameUseInclude, "tagswitch"
2597 case java9LibTag:
2598 return RenameUseExclude, "tagswitch"
2599 case staticLibTag:
2600 return RenameUseInclude, "tagswitch"
2601 case pluginTag:
2602 return RenameUseInclude, "tagswitch"
2603 case errorpronePluginTag:
2604 return RenameUseInclude, "tagswitch"
2605 case exportedPluginTag:
2606 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002607 case kotlinPluginTag:
2608 return RenameUseInclude, "tagswitch"
2609 default:
2610 return RenameUseExclude, "tagswitch"
2611 }
2612 } else if _, ok := m.(android.SourceFileProducer); ok {
2613 switch tag {
2614 case sdkLibTag, libTag, staticLibTag:
2615 return RenameUseInclude, "srcfile"
2616 default:
2617 return RenameUseExclude, "srcfile"
2618 }
Yu Liu67a28422024-03-05 00:36:31 +00002619 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002620 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002621 } else {
2622 switch tag {
2623 case bootClasspathTag:
2624 return RenameUseExclude, "else"
2625 case systemModulesTag:
2626 return RenameUseInclude, "else"
2627 }
2628 }
2629 // If we got here, choose the safer option, which may lead to a build failure, rather
2630 // than runtime failures on the device.
2631 return RenameUseExclude, "end"
2632 }
2633
2634 if result == nil {
2635 result = &JarJarProviderData{
2636 Rename: make(map[string]string),
2637 RenameUse: make([]RenameUseElement, 0),
2638 }
2639 }
2640 how, why := shouldIncludeRenames()
2641 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2642 if how != RenameUseInclude {
2643 // Nothing to merge.
2644 return
2645 }
2646
2647 merge := func(theirs *JarJarProviderData) {
2648 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002649 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2650 result.Rename[orig] = renamed
2651 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2652 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2653 result.Rename[orig] = renamed
2654 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2655 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2656 continue
2657 }
2658 }
2659 }
2660 }
2661 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2662 merge(&theirs)
2663 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2664 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2665 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2666 // to java.Module.
2667 merge(&theirs.JarJarProviderData)
2668 }
2669 })
2670 return
2671}
2672
2673func (this Module) GetDebugString() string {
2674 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2675}
2676
2677// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2678// us, and if it's been set, apply the jarjar_prefix property to rename them.
2679func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2680 // Gather repackage information from deps
2681 result := collectDirectDepsProviders(ctx)
2682
Joe Onoratoa5d17172024-07-20 17:39:56 -07002683 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002684 if result == nil {
2685 result = &JarJarProviderData{
2686 Rename: make(map[string]string),
2687 }
2688 }
2689 if renamed != "" {
2690 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2691 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002692 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002693 }
2694 }
2695 (*result).Rename[orig] = renamed
2696 }
2697
Joe Onoratoa5d17172024-07-20 17:39:56 -07002698 // Update that with entries we've stored for ourself
2699 for orig, renamed := range module.jarjarRenameRules {
2700 add(orig, renamed)
2701 }
2702
2703 // Update that with entries given in the jarjar_rename property.
2704 for _, orig := range module.properties.Jarjar_rename {
2705 add(orig, "")
2706 }
2707
Joe Onorato349ae8d2024-02-05 22:46:00 +00002708 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2709 if result == nil {
2710 return nil
2711 }
2712
2713 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2714 // that have not yet been renamed.
2715 prefix := proptools.String(module.properties.Jarjar_prefix)
2716 if prefix != "" {
2717 if prefix[0] == '.' {
2718 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2719 return nil
2720 }
2721 if prefix[len(prefix)-1] == '.' {
2722 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2723 return nil
2724 }
2725
2726 var updated map[string]string
2727 for orig, renamed := range (*result).Rename {
2728 if renamed == "" {
2729 if updated == nil {
2730 updated = make(map[string]string)
2731 }
2732 updated[orig] = prefix + "." + orig
2733 }
2734 }
2735 for orig, renamed := range updated {
2736 (*result).Rename[orig] = renamed
2737 }
2738 }
2739
2740 return result
2741}
2742
2743// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2744// to "" won't be in this list because they shouldn't be renamed yet.
2745func getJarJarRuleText(provider *JarJarProviderData) string {
2746 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002747 for _, orig := range android.SortedKeys(provider.Rename) {
2748 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002749 if renamed != "" {
2750 result += "rule " + orig + " " + renamed + "\n"
2751 }
2752 }
2753 return result
2754}
2755
Zi Wangddb2ee52024-04-02 16:44:02 +00002756// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Cross7707b242024-07-26 12:02:36 -07002757func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) android.Path {
Zi Wangddb2ee52024-04-02 16:44:02 +00002758 if j.repackageJarjarRules == nil {
2759 return infile
2760 }
Colin Crossedec77c2024-07-26 15:25:40 -07002761 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002762 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
2763 return repackagedJarjarFile
2764}
2765
Colin Crossedec77c2024-07-26 15:25:40 -07002766func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) android.Path {
2767 if j.expandJarjarRules == nil {
2768 return infile
2769 }
2770 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2771 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
2772 return jarjarFile
2773
2774}
2775
Jaewoong Jung26342642021-03-17 15:56:23 -07002776func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2777 deps.processorPath = append(deps.processorPath, pluginJars...)
2778 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2779}
2780
2781// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2782// this interface.
2783type ProvidesUsesLib interface {
2784 ProvidesUsesLib() *string
2785}
2786
2787func (j *Module) ProvidesUsesLib() *string {
2788 return j.usesLibraryProperties.Provides_uses_lib
2789}
satayev1c564cc2021-05-25 19:50:30 +01002790
2791type ModuleWithStem interface {
2792 Stem() string
2793}
2794
2795var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002796
2797type ModuleWithUsesLibrary interface {
2798 UsesLibrary() *usesLibrary
2799}
2800
2801func (j *Module) UsesLibrary() *usesLibrary {
2802 return &j.usesLibrary
2803}
2804
2805var _ ModuleWithUsesLibrary = (*Module)(nil)