blob: 4cd60215c4b5a3cf44caac0297d9ceb44155bf3b [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
Jiyong Park92315372021-04-02 08:45:46 +0900596func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
597 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900598 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700599 return nil
600 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900601 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000602 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700603 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
604 } else {
605 // Treat stable core platform as stable.
606 return nil
607 }
608 } else {
609 return fmt.Errorf("non stable SDK %v", sdkVersion)
610 }
611}
612
613// checkSdkVersions enforces restrictions around SDK dependencies.
614func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
615 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900616 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900617 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700618 ctx.PropertyErrorf("sdk_version",
619 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
620 }
621 }
622 }
623
624 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
625 // See rank() for details.
626 ctx.VisitDirectDeps(func(module android.Module) {
627 tag := ctx.OtherModuleDependencyTag(module)
628 switch module.(type) {
629 // TODO(satayev): cover other types as well, e.g. imports
630 case *Library, *AndroidLibrary:
631 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400632 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700633 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
634 }
635 }
636 })
637}
638
639func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900640 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700641 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900642 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700643 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000644 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 -0700645 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000646 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 -0700647 }
648
649 }
650}
651
Mark Whitea15790a2023-08-22 21:28:11 +0000652func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
653 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400654 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000655 installable := proptools.Bool(j.properties.Installable)
656
657 if headersOnly && installable {
658 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.")
659 }
660 }
661}
662
Jaewoong Jung26342642021-03-17 15:56:23 -0700663func (j *Module) addHostProperties() {
664 j.AddProperties(
665 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000666 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700667 &j.protoProperties,
668 &j.usesLibraryProperties,
669 )
670}
671
672func (j *Module) addHostAndDeviceProperties() {
673 j.addHostProperties()
674 j.AddProperties(
675 &j.deviceProperties,
676 &j.dexer.dexProperties,
677 &j.dexpreoptProperties,
678 &j.linter.properties,
679 )
680}
681
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000682// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
683// makes it available through the hiddenAPIPropertyInfoProvider.
684func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
685 hiddenAPIInfo := newHiddenAPIPropertyInfo()
686
687 // Populate with flag file paths from the properties.
688 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
689
690 // Populate with package rules from the properties.
691 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
692
Colin Cross40213022023-12-13 15:19:49 -0800693 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000694}
695
mrziwang9f7b9f42024-07-10 12:18:06 -0700696// helper method for java modules to set OutputFilesProvider
697func setOutputFiles(ctx android.ModuleContext, m Module) {
698 ctx.SetOutputFiles(append(android.Paths{m.outputFile}, m.extraOutputFiles...), "")
699 ctx.SetOutputFiles(android.Paths{m.outputFile}, android.DefaultDistTag)
700 ctx.SetOutputFiles(android.Paths{m.implementationAndResourcesJar}, ".jar")
701 ctx.SetOutputFiles(android.Paths{m.headerJarFile}, ".hjar")
702 if m.dexer.proguardDictionary.Valid() {
703 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
704 }
705 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
706 if m.linter.outputs.xml != nil {
707 ctx.SetOutputFiles(android.Paths{m.linter.outputs.xml}, ".lint")
Jaewoong Jung26342642021-03-17 15:56:23 -0700708 }
709}
710
Jaewoong Jung26342642021-03-17 15:56:23 -0700711func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
712 initJavaModule(module, hod, false)
713}
714
715func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
716 initJavaModule(module, hod, true)
717}
718
719func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
720 multilib := android.MultilibCommon
721 if multiTargets {
722 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
723 } else {
724 android.InitAndroidArchModule(module, hod, multilib)
725 }
726 android.InitDefaultableModule(module)
727}
728
729func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
730 return j.properties.Instrument &&
731 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
732 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
733}
734
735func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000736 return j.properties.Supports_static_instrumentation &&
737 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700738 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
739 ctx.Config().UnbundledBuild())
740}
741
742func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
743 // Force enable the instrumentation for java code that is built for APEXes ...
744 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
745 // 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 -0800746 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700747 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000748
Jihoon Kang46d66de2024-05-22 22:42:39 +0000749 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700750 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
751 return true
752 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
753 return true
754 }
755 }
756 return false
757}
758
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400759func (j *Module) setInstrument(value bool) {
760 j.properties.Instrument = value
761}
762
Jiyong Park92315372021-04-02 08:45:46 +0900763func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
764 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700765}
766
Jiyong Parkf1691d22021-03-29 20:11:58 +0900767func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700768 return proptools.String(j.deviceProperties.System_modules)
769}
770
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000771func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000772 if j.overridableProperties.Min_sdk_version != nil {
773 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700774 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000775 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700776}
777
Yu Liuf2b94012023-09-19 15:09:10 -0700778func (j *Module) GetDeviceProperties() *DeviceProperties {
779 return &j.deviceProperties
780}
781
Spandan Dasa26eda72023-03-02 00:56:06 +0000782func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
783 if j.deviceProperties.Max_sdk_version != nil {
784 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
785 }
786 // Default is PrivateApiLevel
787 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000788}
789
Spandan Dasa26eda72023-03-02 00:56:06 +0000790func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
791 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
792 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
793 }
794 // Default is PrivateApiLevel
795 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000796}
797
Jiyong Parkf1691d22021-03-29 20:11:58 +0900798func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000799 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900800}
801
Spandan Dasca70fc42023-03-01 23:38:49 +0000802func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900803 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000804 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900805 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000806 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700807}
808
809func (j *Module) AvailableFor(what string) bool {
810 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
811 // Exception: for hostdex: true libraries, the platform variant is created
812 // even if it's not marked as available to platform. In that case, the platform
813 // variant is used only for the hostdex and not installed to the device.
814 return true
815 }
816 return j.ApexModuleBase.AvailableFor(what)
817}
818
819func (j *Module) deps(ctx android.BottomUpMutatorContext) {
820 if ctx.Device() {
821 j.linter.deps(ctx)
822
Jiyong Parkf1691d22021-03-29 20:11:58 +0900823 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700824
825 if j.deviceProperties.SyspropPublicStub != "" {
826 // This is a sysprop implementation library that has a corresponding sysprop public
827 // stubs library, and a dependency on it so that dependencies on the implementation can
828 // be forwarded to the public stubs library when necessary.
829 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
830 }
831 }
832
833 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000834
835 j.properties.Static_libs = android.RemoveListFromList(j.properties.Static_libs, j.properties.Exclude_static_libs)
Jaewoong Jung26342642021-03-17 15:56:23 -0700836 ctx.AddVariationDependencies(nil, staticLibTag, j.properties.Static_libs...)
837
838 // Add dependency on libraries that provide additional hidden api annotations.
839 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
840
Kiyoung Kim9743bab2024-03-28 15:44:56 +0900841 if ctx.Config().EnforceInterPartitionJavaSdkLibrary() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700842 // Require java_sdk_library at inter-partition java dependency to ensure stable
843 // interface between partitions. If inter-partition java_library dependency is detected,
844 // raise build error because java_library doesn't have a stable interface.
845 //
846 // Inputs:
847 // PRODUCT_ENFORCE_INTER_PARTITION_JAVA_SDK_LIBRARY
848 // if true, enable enforcement
849 // PRODUCT_INTER_PARTITION_JAVA_LIBRARY_ALLOWLIST
850 // exception list of java_library names to allow inter-partition dependency
851 for idx := range j.properties.Libs {
852 if libDeps[idx] == nil {
853 continue
854 }
855
856 if javaDep, ok := libDeps[idx].(javaSdkLibraryEnforceContext); ok {
857 // java_sdk_library is always allowed at inter-partition dependency.
858 // So, skip check.
859 if _, ok := javaDep.(*SdkLibrary); ok {
860 continue
861 }
862
863 j.checkPartitionsForJavaDependency(ctx, "libs", javaDep)
864 }
865 }
866 }
867
868 // For library dependencies that are component libraries (like stubs), add the implementation
869 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
870 for _, dep := range libDeps {
871 if dep != nil {
872 if component, ok := dep.(SdkLibraryComponentDependency); ok {
873 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000874 // Add library as optional if it's one of the optional compatibility libs or it's
875 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100876 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000877 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
878 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100879 tag = usesLibOptTag
880 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100881 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700882 }
883 }
884 }
885 }
886
887 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
888 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
889 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
890
891 android.ProtoDeps(ctx, &j.protoProperties)
892 if j.hasSrcExt(".proto") {
893 protoDeps(ctx, &j.protoProperties)
894 }
895
896 if j.hasSrcExt(".kt") {
897 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
898 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700899 tag := staticLibTag
900 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
901 tag = libTag
902 }
903 ctx.AddVariationDependencies(nil, tag,
904 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700905 }
906
907 // Framework libraries need special handling in static coverage builds: they should not have
908 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
909 // the same jacoco classes coming from different bootclasspath jars.
910 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
911 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
912 j.properties.Instrument = true
913 }
914 } else if j.shouldInstrumentStatic(ctx) {
915 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
916 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700917
918 if j.useCompose() {
919 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
920 "androidx.compose.compiler_compiler-hosted")
921 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700922}
923
924func hasSrcExt(srcs []string, ext string) bool {
925 for _, src := range srcs {
926 if filepath.Ext(src) == ext {
927 return true
928 }
929 }
930
931 return false
932}
933
934func (j *Module) hasSrcExt(ext string) bool {
935 return hasSrcExt(j.properties.Srcs, ext)
936}
937
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100938func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
939 var flags string
940
941 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
942 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
943 flags = "-Wmissing-permission-annotation -Werror"
944 }
945 }
946 return flags
947}
948
Jaewoong Jung26342642021-03-17 15:56:23 -0700949func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000950 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700951
952 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
953 aidlIncludes = append(aidlIncludes,
954 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
955 aidlIncludes = append(aidlIncludes,
956 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
957
958 var flags []string
959 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000960 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700961
962 flags = append(flags, j.deviceProperties.Aidl.Flags...)
963
964 if aidlPreprocess.Valid() {
965 flags = append(flags, "-p"+aidlPreprocess.String())
966 deps = append(deps, aidlPreprocess.Path())
967 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000968 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700969 }
970
971 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000972 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700973 }
974
975 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000976 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700977 }
978
Sam Delmerico2351eac2022-05-24 17:10:02 +0000979 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700980 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000981 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700982 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000983 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
984 // add flags for dirs containing AIDL srcs that haven't been specified yet
985 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -0700986
Zim8774ae12022-08-17 11:46:34 +0100987 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +0000988 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +0100989 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700990 flags = append(flags, "-t")
991 }
992
993 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
994 flags = append(flags, "--transaction_names")
995 }
996
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100997 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
998 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
999 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1000 }
1001
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001002 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001003 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1004
Jaewoong Jung26342642021-03-17 15:56:23 -07001005 return strings.Join(flags, " "), deps
1006}
1007
1008func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1009
1010 var flags javaBuilderFlags
1011
1012 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001013 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001014
Cole Faust2b1536e2021-06-18 12:25:54 -07001015 epEnabled := j.properties.Errorprone.Enabled
1016 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001017 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001018 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1019 }
1020
1021 errorProneFlags := []string{
1022 "-Xplugin:ErrorProne",
1023 "${config.ErrorProneChecks}",
1024 }
1025 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1026
Colin Cross8bf6cad2022-02-28 13:07:03 -08001027 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001028 "'" + strings.Join(errorProneFlags, " ") + "'"
1029 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1030 }
1031
1032 // classpath
1033 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1034 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001035 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001036 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1037 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1038 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1039
1040 flags.processors = append(flags.processors, deps.processorClasses...)
1041 flags.processors = android.FirstUniqueStrings(flags.processors)
1042
1043 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001044 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001045 // Give host-side tools a version of OpenJDK's standard libraries
1046 // close to what they're targeting. As of Dec 2017, AOSP is only
1047 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1048 //
1049 // When building with OpenJDK 8, the following should have no
1050 // effect since those jars would be available by default.
1051 //
1052 // When building with OpenJDK 9 but targeting a version < 1.8,
1053 // putting them on the bootclasspath means that:
1054 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1055 // b) references to existing APIs are not reinterpreted in an
1056 // OpenJDK 9-specific way, eg. calls to subclasses of
1057 // java.nio.Buffer as in http://b/70862583
1058 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1059 flags.bootClasspath = append(flags.bootClasspath,
1060 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1061 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1062 if Bool(j.properties.Use_tools_jar) {
1063 flags.bootClasspath = append(flags.bootClasspath,
1064 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1065 }
1066 }
1067
1068 // systemModules
1069 flags.systemModules = deps.systemModules
1070
Jaewoong Jung26342642021-03-17 15:56:23 -07001071 return flags
1072}
1073
1074func (j *Module) collectJavacFlags(
1075 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1076 // javac flags.
1077 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001078 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001079
Mythri Alle4b9f6182023-10-25 15:17:11 +00001080 needsDebugInfo = false
1081 for _, flag := range javacFlags {
1082 if strings.HasPrefix(flag, "-g") {
1083 needsDebugInfo = true
1084 }
1085 }
1086
1087 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001088 // For non-host binaries, override the -g flag passed globally to remove
1089 // local variable debug info to reduce disk and memory usage.
1090 javacFlags = append(javacFlags, "-g:source,lines")
1091 }
1092 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1093
1094 if flags.javaVersion.usesJavaModules() {
1095 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001096 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1097 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1098 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1099 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001100
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001101 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001102 if j.properties.Patch_module != nil {
1103 // Manually specify build directory in case it is not under the repo root.
1104 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1105 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001106 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001107
Jaewoong Jung26342642021-03-17 15:56:23 -07001108 classPath := flags.classpath.FormJavaClassPath("")
1109 if classPath != "" {
1110 patchPaths = append(patchPaths, classPath)
1111 }
1112 javacFlags = append(
1113 javacFlags,
1114 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1115 }
1116 }
1117
1118 if len(javacFlags) > 0 {
1119 // optimization.
1120 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1121 flags.javacFlags = "$javacFlags"
1122 }
1123
1124 return flags
1125}
1126
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001127func (j *Module) AddJSONData(d *map[string]interface{}) {
1128 (&j.ModuleBase).AddJSONData(d)
1129 (*d)["Java"] = map[string]interface{}{
1130 "SourceExtensions": j.sourceExtensions,
1131 }
1132
1133}
1134
usta0391ca42023-09-19 15:51:59 -04001135func (j *Module) addGeneratedSrcJars(path android.Path) {
1136 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001137}
1138
Colin Cross4eae06d2023-06-20 22:40:02 -07001139func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001140 // Auto-propagating jarjar rules
1141 jarjarProviderData := j.collectJarJarRules(ctx)
1142 if jarjarProviderData != nil {
1143 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wang9bdd4222024-02-26 18:21:01 -08001144 if !proptools.Bool(j.properties.Skip_jarjar_repackage) {
1145 text := getJarJarRuleText(jarjarProviderData)
1146 if text != "" {
1147 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1148 android.WriteFileRule(ctx, ruleTextFile, text)
1149 j.repackageJarjarRules = ruleTextFile
1150 }
Joe Onorato349ae8d2024-02-05 22:46:00 +00001151 }
1152 }
1153
Jaewoong Jung26342642021-03-17 15:56:23 -07001154 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1155
Makoto Onuki7ded3822024-03-28 14:42:20 -07001156 if re := proptools.Bool(j.properties.Ravenizer.Enabled); re {
1157 j.ravenizer.enabled = re
1158 }
1159
Jaewoong Jung26342642021-03-17 15:56:23 -07001160 deps := j.collectDeps(ctx)
1161 flags := j.collectBuilderFlags(ctx, deps)
1162
1163 if flags.javaVersion.usesJavaModules() {
1164 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001165 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1166 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1167 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001168 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001169
Jaewoong Jung26342642021-03-17 15:56:23 -07001170 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001171 j.sourceExtensions = []string{}
1172 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1173 if hasSrcExt(srcFiles.Strings(), ext) {
1174 j.sourceExtensions = append(j.sourceExtensions, ext)
1175 }
1176 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001177 if hasSrcExt(srcFiles.Strings(), ".proto") {
1178 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1179 }
1180
1181 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1182 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1183 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1184 }
1185
Sam Delmerico2351eac2022-05-24 17:10:02 +00001186 aidlSrcs := srcFiles.FilterByExt(".aidl")
1187 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1188
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001189 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001190 srcFiles = j.genSources(ctx, srcFiles, flags)
1191
1192 // Collect javac flags only after computing the full set of srcFiles to
1193 // ensure that the --patch-module lookup paths are complete.
1194 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1195
1196 srcJars := srcFiles.FilterByExt(".srcjar")
1197 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001198 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001199 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001200 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001201
1202 if j.properties.Jarjar_rules != nil {
1203 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1204 }
1205
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001206 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001207
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001208 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001209 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001210 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001211 if _, found := set[v.String()]; !found {
1212 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001213 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001214 }
1215 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001216 var uniqueKtFiles android.Paths
1217 for _, v := range srcFiles.FilterByExt(".kt") {
1218 if _, found := set[v.String()]; !found {
1219 set[v.String()] = true
1220 uniqueKtFiles = append(uniqueKtFiles, v)
1221 }
1222 }
1223
1224 var uniqueSrcFiles android.Paths
1225 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1226 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1227 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001228 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001229
Colin Crossb5db4012022-03-28 17:12:39 -07001230 // We don't currently run annotation processors in turbine, which means we can't use turbine
1231 // generated header jars when an annotation processor that generates API is enabled. One
1232 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1233 // is used to run all of the annotation processors.
1234 disableTurbine := deps.disableTurbine
1235
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001236 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001237 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1238
1239 var kotlinJars android.Paths
Colin Cross220a9a12022-03-28 17:08:01 -07001240 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001241
Colin Cross4eae06d2023-06-20 22:40:02 -07001242 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1243 // any dependencies so that it can override any non-final R classes from dependencies with the
1244 // final R classes from the app.
1245 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1246
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001247 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1248
Mark Whitea15790a2023-08-22 21:28:11 +00001249 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001250 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001251 if srcFiles.HasExt(".kt") {
1252 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1253 }
1254 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1255 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1256 }
1257
Colin Crossedec77c2024-07-26 15:25:40 -07001258 _, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
1259 extraCombinedJars)
1260
1261 combinedHeaderJarFile = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1262 combinedHeaderJarFile = j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
Mark Whitea15790a2023-08-22 21:28:11 +00001263 if ctx.Failed() {
1264 return
1265 }
Colin Crossedec77c2024-07-26 15:25:40 -07001266 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001267
Colin Cross7727c7f2024-07-18 15:36:32 -07001268 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001269 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1270 TransitiveLibsHeaderJars: j.transitiveLibsHeaderJars,
1271 TransitiveStaticLibsHeaderJars: j.transitiveStaticLibsHeaderJars,
1272 AidlIncludeDirs: j.exportAidlIncludeDirs,
1273 ExportedPlugins: j.exportedPluginJars,
1274 ExportedPluginClasses: j.exportedPluginClasses,
1275 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1276 StubsLinkType: j.stubsLinkType,
1277 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001278 })
1279
1280 j.outputFile = j.headerJarFile
1281 return
1282 }
1283
Jaewoong Jung26342642021-03-17 15:56:23 -07001284 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001285 // When using kotlin sources turbine is used to generate annotation processor sources,
1286 // including for annotation processors that generate API, so we can use turbine for
1287 // java sources too.
1288 disableTurbine = false
1289
Jaewoong Jung26342642021-03-17 15:56:23 -07001290 // user defined kotlin flags.
1291 kotlincFlags := j.properties.Kotlincflags
1292 CheckKotlincFlags(ctx, kotlincFlags)
1293
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001294 // Workaround for KT-46512
1295 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001296
1297 // If there are kotlin files, compile them first but pass all the kotlin and java files
1298 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1299 // won't emit any classes for them.
1300 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1301 if ctx.Device() {
1302 kotlincFlags = append(kotlincFlags, "-no-jdk")
1303 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001304
1305 for _, plugin := range deps.kotlinPlugins {
1306 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1307 }
1308 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1309
Jaewoong Jung26342642021-03-17 15:56:23 -07001310 if len(kotlincFlags) > 0 {
1311 // optimization.
1312 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1313 flags.kotlincFlags += "$kotlincFlags"
1314 }
1315
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001316 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001317 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1318
Jaewoong Jung26342642021-03-17 15:56:23 -07001319 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1320 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1321
Isaac Chioua23d9942022-04-06 06:14:38 +00001322 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001323 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001324 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1325 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001326 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001327 srcJars = append(srcJars, kaptSrcJar)
1328 kotlinJars = append(kotlinJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001329 // Disable annotation processing in javac, it's already been handled by kapt
1330 flags.processorPath = nil
1331 flags.processors = nil
1332 }
1333
1334 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001335 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001336 kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001337 if ctx.Failed() {
1338 return
1339 }
1340
Colin Cross7707b242024-07-26 12:02:36 -07001341 kotlinJarPath := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001342
Isaac Chioua23d9942022-04-06 06:14:38 +00001343 // Make javac rule depend on the kotlinc rule
1344 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1345
Zi Wangddb2ee52024-04-02 16:44:02 +00001346 kotlinJars = append(kotlinJars, kotlinJarPath)
Colin Cross220a9a12022-03-28 17:08:01 -07001347 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001348 }
1349
Colin Crossfd620b22024-02-23 10:05:21 -08001350 jars := slices.Clone(kotlinJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001351
Jaewoong Jung26342642021-03-17 15:56:23 -07001352 j.compiledSrcJars = srcJars
1353
1354 enableSharding := false
Colin Cross3d56ed52021-11-18 22:23:12 -08001355 var headerJarFileWithoutDepsOrJarjar android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001356 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001357 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1358 enableSharding = true
1359 // Formerly, there was a check here that prevented annotation processors
1360 // from being used when sharding was enabled, as some annotation processors
1361 // do not function correctly in sharded environments. It was removed to
1362 // allow for the use of annotation processors that do function correctly
1363 // with sharding enabled. See: b/77284273.
1364 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001365 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001366 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001367 var combinedHeaderJarFile android.Path
1368 headerJarFileWithoutDepsOrJarjar, combinedHeaderJarFile =
Colin Cross4eae06d2023-06-20 22:40:02 -07001369 j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
Colin Crossedec77c2024-07-26 15:25:40 -07001370
1371 j.headerJarFile = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1372 j.repackagedHeaderJarFile = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
Jaewoong Jung26342642021-03-17 15:56:23 -07001373 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001374 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001375 hasErrorproneableFiles := false
1376 for _, ext := range j.sourceExtensions {
1377 if ext != ".proto" && ext != ".aidl" {
1378 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1379 // compile, and it's not useful to have warnings on these generated sources.
1380 hasErrorproneableFiles = true
1381 break
1382 }
1383 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001384 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001385 if Bool(j.properties.Errorprone.Enabled) {
1386 // If error-prone is enabled, enable errorprone flags on the regular
1387 // build.
1388 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001389 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001390 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1391 // a new jar file just for compiling with the errorprone compiler to.
1392 // This is because we don't want to cause the java files to get completely
1393 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1394 // We also don't want to run this if errorprone is enabled by default for
1395 // this module, or else we could have duplicated errorprone messages.
1396 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001397 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001398 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001399
Vadim Spivak3c496f02023-06-08 06:14:59 +00001400 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001401 "errorprone", "errorprone")
1402
Jaewoong Jung26342642021-03-17 15:56:23 -07001403 extraJarDeps = append(extraJarDeps, errorprone)
1404 }
1405
1406 if enableSharding {
Colin Cross3d56ed52021-11-18 22:23:12 -08001407 if headerJarFileWithoutDepsOrJarjar != nil {
1408 flags.classpath = append(classpath{headerJarFileWithoutDepsOrJarjar}, flags.classpath...)
1409 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001410 shardSize := int(*(j.properties.Javac_shard_size))
1411 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001412 if len(uniqueJavaFiles) > 0 {
1413 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001414 for idx, shardSrc := range shardSrcs {
1415 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1416 nil, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001417 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
Jaewoong Jung26342642021-03-17 15:56:23 -07001418 jars = append(jars, classes)
1419 }
1420 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001421 // Assume approximately 5 sources per srcjar.
1422 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1423 // 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 -07001424 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001425 startIdx := len(shardSrcs)
1426 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1427 for idx, shardSrcJars := range shardSrcJarsList {
1428 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1429 nil, shardSrcJars, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001430 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
Colin Crossa052ddb2023-09-25 21:46:58 -07001431 jars = append(jars, classes)
1432 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001433 }
1434 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001435 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001436 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
Jaewoong Jung26342642021-03-17 15:56:23 -07001437 jars = append(jars, classes)
1438 }
1439 if ctx.Failed() {
1440 return
1441 }
1442 }
1443
Colin Crossfd620b22024-02-23 10:05:21 -08001444 jars = append(jars, extraCombinedJars...)
1445
Jaewoong Jung26342642021-03-17 15:56:23 -07001446 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1447
1448 var includeSrcJar android.WritablePath
1449 if Bool(j.properties.Include_srcs) {
1450 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1451 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1452 }
1453
1454 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1455 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1456 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1457 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1458
1459 var resArgs []string
1460 var resDeps android.Paths
1461
1462 resArgs = append(resArgs, dirArgs...)
1463 resDeps = append(resDeps, dirDeps...)
1464
1465 resArgs = append(resArgs, fileArgs...)
1466 resDeps = append(resDeps, fileDeps...)
1467
1468 resArgs = append(resArgs, extraArgs...)
1469 resDeps = append(resDeps, extraDeps...)
1470
1471 if len(resArgs) > 0 {
1472 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1473 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
1474 j.resourceJar = resourceJar
1475 if ctx.Failed() {
1476 return
1477 }
1478 }
1479
1480 var resourceJars android.Paths
1481 if j.resourceJar != nil {
1482 resourceJars = append(resourceJars, j.resourceJar)
1483 }
1484 if Bool(j.properties.Include_srcs) {
1485 resourceJars = append(resourceJars, includeSrcJar)
1486 }
1487 resourceJars = append(resourceJars, deps.staticResourceJars...)
1488
1489 if len(resourceJars) > 1 {
1490 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1491 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1492 false, nil, nil)
1493 j.resourceJar = combinedJar
1494 } else if len(resourceJars) == 1 {
1495 j.resourceJar = resourceJars[0]
1496 }
1497
1498 if len(deps.staticJars) > 0 {
1499 jars = append(jars, deps.staticJars...)
1500 }
1501
1502 manifest := j.overrideManifest
1503 if !manifest.Valid() && j.properties.Manifest != nil {
1504 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
1505 }
1506
1507 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1508 if len(services) > 0 {
1509 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1510 var zipargs []string
1511 for _, file := range services {
1512 serviceFile := file.String()
1513 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1514 }
1515 rule := zip
1516 args := map[string]string{
1517 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1518 }
1519 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1520 rule = zipRE
1521 args["implicits"] = strings.Join(services.Strings(), ",")
1522 }
1523 ctx.Build(pctx, android.BuildParams{
1524 Rule: rule,
1525 Output: servicesJar,
1526 Implicits: services,
1527 Args: args,
1528 })
1529 jars = append(jars, servicesJar)
1530 }
1531
1532 // Combine the classes built from sources, any manifests, and any static libraries into
1533 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001534 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001535
1536 if len(jars) == 1 && !manifest.Valid() {
1537 // Optimization: skip the combine step as there is nothing to do
1538 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1539 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1540 // any if len(jars) == 1.
1541
Jihoon Kang1147b312023-06-08 23:25:57 +00001542 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1543 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1544 // either with .from-source or .from-text suffix.
1545 // outputFile should be agnostic to the build configuration,
1546 // thus "combine" the single static lib in order to prevent the static lib from being exposed
1547 // to the copy rules.
Jihoon Kangfa3f0782024-08-21 20:42:18 +00001548 stub, _ := moduleStubLinkType(j)
Jihoon Kang1147b312023-06-08 23:25:57 +00001549
Colin Cross7707b242024-07-26 12:02:36 -07001550 if stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07001551 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1552 ctx.Build(pctx, android.BuildParams{
1553 Rule: android.Cp,
1554 Input: jars[0],
1555 Output: combinedJar,
1556 })
Colin Cross7707b242024-07-26 12:02:36 -07001557 outputFile = combinedJar
1558 } else {
1559 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001560 }
1561 } else {
1562 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1563 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1564 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001565 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001566 }
1567
1568 // jarjar implementation jar if necessary
Colin Crossedec77c2024-07-26 15:25:40 -07001569 jarjarFile := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1570 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001571
Colin Crossedec77c2024-07-26 15:25:40 -07001572 // jarjar resource jar if necessary
1573 if j.resourceJar != nil {
1574 resourceJarJarFile := j.jarjarIfNecessary(ctx, j.resourceJar, jarName, "resource")
1575 j.resourceJar = resourceJarJarFile
1576 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001577
Colin Crossedec77c2024-07-26 15:25:40 -07001578 if ctx.Failed() {
1579 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001580 }
1581
Makoto Onuki7ded3822024-03-28 14:42:20 -07001582 if j.ravenizer.enabled {
1583 ravenizerInput := outputFile
1584 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", jarName)
1585 ctx.Build(pctx, android.BuildParams{
1586 Rule: ravenizer,
1587 Description: "ravenizer",
1588 Input: ravenizerInput,
1589 Output: ravenizerOutput,
1590 })
1591 outputFile = ravenizerOutput
1592 }
1593
Jaewoong Jung26342642021-03-17 15:56:23 -07001594 // Check package restrictions if necessary.
1595 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001596 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001597 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001598
1599 // Create a rule to copy the output jar to another path and add a validate dependency that
1600 // will check that the jar only contains the permitted packages. The new location will become
1601 // the output file of this module.
1602 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001603 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001604 ctx.Build(pctx, android.BuildParams{
1605 Rule: android.Cp,
1606 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001607 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001608 // Make sure that any dependency on the output file will cause ninja to run the package check
1609 // rule.
1610 Validation: pkgckFile,
1611 })
Colin Cross7707b242024-07-26 12:02:36 -07001612 outputFile = packageCheckOutputFile
Paul Duffin08a18bf2021-10-01 13:19:58 +01001613
1614 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001615 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001616
1617 if ctx.Failed() {
1618 return
1619 }
1620 }
1621
1622 j.implementationJarFile = outputFile
1623 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001624 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1625 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1626 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1627 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1628 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1629 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1630 j.headerJarFile = headerJarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001631 }
1632
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001633 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1634 specs := j.jacocoModuleToZipCommand(ctx)
1635 if ctx.Failed() {
1636 return
1637 }
1638
Jaewoong Jung26342642021-03-17 15:56:23 -07001639 if j.shouldInstrument(ctx) {
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001640 outputFile = j.instrument(ctx, flags, outputFile, jarName, specs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001641 }
1642
1643 // merge implementation jar with resources if necessary
1644 implementationAndResourcesJar := outputFile
1645 if j.resourceJar != nil {
1646 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Colin Cross7707b242024-07-26 12:02:36 -07001647 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001648 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
1649 false, nil, nil)
1650 implementationAndResourcesJar = combinedJar
1651 }
1652
1653 j.implementationAndResourcesJar = implementationAndResourcesJar
1654
1655 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001656 compileDex := j.dexProperties.Compile_dex
Colin Crossff694a82023-12-13 15:54:49 -08001657 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -07001658 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001659 if compileDex == nil {
1660 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001661 }
1662 if j.deviceProperties.Hostdex == nil {
1663 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1664 }
1665 }
1666
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001667 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001668 if j.hasCode(ctx) {
1669 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001670 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001671 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1672 }
1673 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001674 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001675 params := &compileDexParams{
1676 flags: flags,
1677 sdkVersion: j.SdkVersion(ctx),
1678 minSdkVersion: j.MinSdkVersion(ctx),
1679 classesJar: implementationAndResourcesJar,
1680 jarName: jarName,
1681 }
Spandan Das15a67112024-05-30 00:07:40 +00001682 if j.GetProfileGuided() && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting() {
1683 ctx.PropertyErrorf("enable_profile_rewriting",
1684 "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.",
1685 )
1686 }
Spandan Das3dbda182024-05-20 22:23:10 +00001687 if j.EnableProfileRewriting() {
1688 profile := j.GetProfile()
1689 if profile == "" || !j.GetProfileGuided() {
1690 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1691 }
1692 params.artProfileInput = &profile
1693 }
1694 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001695 if ctx.Failed() {
1696 return
1697 }
1698
Spandan Das3dbda182024-05-20 22:23:10 +00001699 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1700 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001701 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001702 }
1703
Jaewoong Jung26342642021-03-17 15:56:23 -07001704 // merge dex jar with resources if necessary
1705 if j.resourceJar != nil {
1706 jars := android.Paths{dexOutputFile, j.resourceJar}
Colin Cross7707b242024-07-26 12:02:36 -07001707 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001708 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1709 false, nil, nil)
1710 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001711 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001712 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001713 dexOutputFile = combinedAlignedJar
1714 } else {
1715 dexOutputFile = combinedJar
1716 }
1717 }
1718
Paul Duffin4de94502021-05-16 05:21:16 +01001719 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001720
1721 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001722
1723 // Encode hidden API flags in dex file, if needed.
1724 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1725
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001726 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001727
1728 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001729 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1730 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1731 libName = strings.TrimSuffix(libName, ".impl")
1732 }
1733 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001734
1735 outputFile = dexOutputFile
1736 } else {
1737 // There is no code to compile into a dex jar, make sure the resources are propagated
1738 // to the APK if this is an app.
1739 outputFile = implementationAndResourcesJar
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001740 j.dexJarFile = makeDexJarPathFromPath(j.resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001741 }
1742
1743 if ctx.Failed() {
1744 return
1745 }
1746 } else {
1747 outputFile = implementationAndResourcesJar
1748 }
1749
1750 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001751 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001752 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001753 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001754 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001755 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001756 }
1757 }
1758
1759 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001760 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1761 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001762 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1763 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001764 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001765 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001766 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001767 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001768 j.linter.javaLanguageLevel = flags.javaVersion.String()
1769 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001770 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001771 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1772 j.linter.buildModuleReportZip = true
1773 }
1774 j.linter.lint(ctx)
1775 }
1776
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001777 j.collectTransitiveSrcFiles(ctx, srcFiles)
1778
Jaewoong Jung26342642021-03-17 15:56:23 -07001779 ctx.CheckbuildFile(outputFile)
1780
Colin Cross7727c7f2024-07-18 15:36:32 -07001781 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001782 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1783 RepackagedHeaderJars: android.PathsIfNonNil(j.repackagedHeaderJarFile),
1784 TransitiveLibsHeaderJars: j.transitiveLibsHeaderJars,
1785 TransitiveStaticLibsHeaderJars: j.transitiveStaticLibsHeaderJars,
1786 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1787 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
1788 ResourceJars: android.PathsIfNonNil(j.resourceJar),
1789 AidlIncludeDirs: j.exportAidlIncludeDirs,
1790 SrcJarArgs: j.srcJarArgs,
1791 SrcJarDeps: j.srcJarDeps,
1792 TransitiveSrcFiles: j.transitiveSrcFiles,
1793 ExportedPlugins: j.exportedPluginJars,
1794 ExportedPluginClasses: j.exportedPluginClasses,
1795 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1796 JacocoReportClassesFile: j.jacocoReportClassesFile,
1797 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001798 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001799 })
1800
1801 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1802 j.outputFile = outputFile.WithoutRel()
1803}
1804
Colin Crossa1ff7c62021-09-17 14:11:52 -07001805func (j *Module) useCompose() bool {
1806 return android.InList("androidx.compose.runtime_runtime", j.properties.Static_libs)
1807}
1808
Colin Crosscde55342024-03-27 14:11:51 -07001809func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []*android.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001810 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001811 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001812 depTag := ctx.OtherModuleDependencyTag(m)
1813
1814 if depProguardInfo.UnconditionallyExportedProguardFlags != nil {
1815 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1816 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1817 }
1818
1819 if depTag == staticLibTag && depProguardInfo.ProguardFlagsFiles != nil {
1820 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1821 }
1822 })
1823
Colin Crosscde55342024-03-27 14:11:51 -07001824 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1825}
1826
1827func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1828 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1829
Sam Delmerico95d70942023-08-02 18:00:35 -04001830 directUnconditionalExportedFlags := android.Paths{}
1831 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1832 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1833 if exportUnconditionally {
1834 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1835 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1836 directUnconditionalExportedFlags = proguardFlagsForThisModule
1837 }
1838
1839 return ProguardSpecInfo{
1840 Export_proguard_flags_files: exportUnconditionally,
1841 ProguardFlagsFiles: android.NewDepSet[android.Path](
1842 android.POSTORDER,
1843 proguardFlagsForThisModule,
1844 transitiveProguardFlags,
1845 ),
1846 UnconditionallyExportedProguardFlags: android.NewDepSet[android.Path](
1847 android.POSTORDER,
1848 directUnconditionalExportedFlags,
1849 transitiveUnconditionalExportedFlags,
1850 ),
1851 }
1852
1853}
1854
Cole Faust75fffb12021-06-13 15:23:16 -07001855// Returns a copy of the supplied flags, but with all the errorprone-related
1856// fields copied to the regular build's fields.
1857func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1858 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1859
1860 if len(flags.errorProneExtraJavacFlags) > 0 {
1861 if len(flags.javacFlags) > 0 {
1862 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
1863 } else {
1864 flags.javacFlags = flags.errorProneExtraJavacFlags
1865 }
1866 }
1867 return flags
1868}
1869
Jaewoong Jung26342642021-03-17 15:56:23 -07001870func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07001871 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07001872
1873 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00001874 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001875 if idx >= 0 {
1876 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00001877 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001878 jarName += strconv.Itoa(idx)
1879 }
1880
Colin Cross7707b242024-07-26 12:02:36 -07001881 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001882 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001883
Cole Faust9decf832024-06-11 11:45:53 -07001884 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001885 extractionFile := android.PathForModuleOut(ctx, kzipName)
1886 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1887 j.kytheFiles = append(j.kytheFiles, extractionFile)
1888 }
1889
Vadim Spivak3c496f02023-06-08 06:14:59 +00001890 if len(flags.processorPath) > 0 {
1891 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
1892 }
1893
Jaewoong Jung26342642021-03-17 15:56:23 -07001894 return classes
1895}
1896
1897// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1898// since some of these flags may be used internally.
1899func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1900 for _, flag := range flags {
1901 flag = strings.TrimSpace(flag)
1902
1903 if !strings.HasPrefix(flag, "-") {
1904 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1905 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1906 ctx.PropertyErrorf("kotlincflags",
1907 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1908 } else if inList(flag, config.KotlincIllegalFlags) {
1909 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1910 } else if flag == "-include-runtime" {
1911 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1912 } else {
1913 args := strings.Split(flag, " ")
1914 if args[0] == "-kotlin-home" {
1915 ctx.PropertyErrorf("kotlincflags",
1916 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1917 }
1918 }
1919 }
1920}
1921
1922func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
1923 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossedec77c2024-07-26 15:25:40 -07001924 extraJars android.Paths) (headerJar android.Path, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001925
1926 var jars android.Paths
1927 if len(srcFiles) > 0 || len(srcJars) > 0 {
1928 // Compile java sources into turbine.jar.
1929 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1930 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001931 jars = append(jars, turbineJar)
Colin Cross3d56ed52021-11-18 22:23:12 -08001932 headerJar = turbineJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001933 }
1934
1935 jars = append(jars, extraJars...)
1936
1937 // Combine any static header libraries into classes-header.jar. If there is only
1938 // one input jar this step will be skipped.
1939 jars = append(jars, deps.staticHeaderJars...)
1940
1941 // we cannot skip the combine step for now if there is only one jar
1942 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07001943 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
1944 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001945 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07001946
Colin Crossedec77c2024-07-26 15:25:40 -07001947 return headerJar, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07001948}
1949
1950func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07001951 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07001952
1953 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07001954 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001955
1956 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1957
1958 j.jacocoReportClassesFile = jacocoReportClassesFile
1959
1960 return instrumentedJar
1961}
1962
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001963type providesTransitiveHeaderJars struct {
1964 // set of header jars for all transitive libs deps
Colin Crossc85750b2022-04-21 12:50:51 -07001965 transitiveLibsHeaderJars *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001966 // set of header jars for all transitive static libs deps
Colin Crossc85750b2022-04-21 12:50:51 -07001967 transitiveStaticLibsHeaderJars *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001968}
1969
Colin Crossc85750b2022-04-21 12:50:51 -07001970func (j *providesTransitiveHeaderJars) TransitiveLibsHeaderJars() *android.DepSet[android.Path] {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001971 return j.transitiveLibsHeaderJars
1972}
1973
Colin Crossc85750b2022-04-21 12:50:51 -07001974func (j *providesTransitiveHeaderJars) TransitiveStaticLibsHeaderJars() *android.DepSet[android.Path] {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001975 return j.transitiveStaticLibsHeaderJars
1976}
1977
1978func (j *providesTransitiveHeaderJars) collectTransitiveHeaderJars(ctx android.ModuleContext) {
1979 directLibs := android.Paths{}
1980 directStaticLibs := android.Paths{}
Colin Crossc85750b2022-04-21 12:50:51 -07001981 transitiveLibs := []*android.DepSet[android.Path]{}
1982 transitiveStaticLibs := []*android.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001983 ctx.VisitDirectDeps(func(module android.Module) {
1984 // don't add deps of the prebuilt version of the same library
1985 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
1986 return
1987 }
1988
Colin Cross7727c7f2024-07-18 15:36:32 -07001989 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
1990 tag := ctx.OtherModuleDependencyTag(module)
1991 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
1992 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
1993 directLibs = append(directLibs, dep.HeaderJars...)
1994 } else if tag == staticLibTag {
1995 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
1996 } else {
1997 // Don't propagate transitive libs for other kinds of dependencies.
1998 return
1999 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002000
Colin Cross7727c7f2024-07-18 15:36:32 -07002001 if dep.TransitiveLibsHeaderJars != nil {
2002 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJars)
2003 }
2004 if dep.TransitiveStaticLibsHeaderJars != nil {
2005 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJars)
2006 }
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002007 }
2008 })
2009 j.transitiveLibsHeaderJars = android.NewDepSet(android.POSTORDER, directLibs, transitiveLibs)
2010 j.transitiveStaticLibsHeaderJars = android.NewDepSet(android.POSTORDER, directStaticLibs, transitiveStaticLibs)
2011}
2012
Jaewoong Jung26342642021-03-17 15:56:23 -07002013func (j *Module) HeaderJars() android.Paths {
2014 if j.headerJarFile == nil {
2015 return nil
2016 }
2017 return android.Paths{j.headerJarFile}
2018}
2019
2020func (j *Module) ImplementationJars() android.Paths {
2021 if j.implementationJarFile == nil {
2022 return nil
2023 }
2024 return android.Paths{j.implementationJarFile}
2025}
2026
Spandan Das59a4a2b2024-01-09 21:35:56 +00002027func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002028 return j.dexJarFile
2029}
2030
2031func (j *Module) DexJarInstallPath() android.Path {
2032 return j.installFile
2033}
2034
2035func (j *Module) ImplementationAndResourcesJars() android.Paths {
2036 if j.implementationAndResourcesJar == nil {
2037 return nil
2038 }
2039 return android.Paths{j.implementationAndResourcesJar}
2040}
2041
2042func (j *Module) AidlIncludeDirs() android.Paths {
2043 // exportAidlIncludeDirs is type android.Paths already
2044 return j.exportAidlIncludeDirs
2045}
2046
2047func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2048 return j.classLoaderContexts
2049}
2050
2051// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002052func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002053 // jarjar rules will repackage the sources. To prevent misleading results, IdeInfo should contain the
2054 // repackaged jar instead of the input sources.
Jaewoong Jung26342642021-03-17 15:56:23 -07002055 if j.expandJarjarRules != nil {
2056 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002057 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
2058 } else {
2059 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2060 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2061 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002062 }
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002063 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2064 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Yikef6282022022-04-13 20:41:01 +08002065 dpInfo.Static_libs = append(dpInfo.Static_libs, j.properties.Static_libs...)
2066 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002067}
2068
2069func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002070 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002071}
2072
2073func (j *Module) hasCode(ctx android.ModuleContext) bool {
2074 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2075 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2076}
2077
2078// Implements android.ApexModule
2079func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2080 return j.depIsInSameApex(ctx, dep)
2081}
2082
2083// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002084func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002085 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002086 minSdkVersion := j.MinSdkVersion(ctx)
2087 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002088 return fmt.Errorf("min_sdk_version is not specified")
2089 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002090 // If the module is compiling against core (via sdk_version), skip comparison check.
2091 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002092 return nil
2093 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002094 if minSdkVersion.GreaterThan(sdkVersion) {
2095 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002096 }
2097 return nil
2098}
2099
2100func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002101 if j.stem == "" {
2102 panic("Stem() called before stem property was set")
2103 }
2104 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002105}
2106
Jaewoong Jung26342642021-03-17 15:56:23 -07002107func (j *Module) JacocoReportClassesFile() android.Path {
2108 return j.jacocoReportClassesFile
2109}
2110
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002111func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
2112 var fromDeps []*android.DepSet[android.Path]
2113 ctx.VisitDirectDeps(func(module android.Module) {
2114 tag := ctx.OtherModuleDependencyTag(module)
2115 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002116 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2117 if depInfo.TransitiveSrcFiles != nil {
2118 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
2119 }
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002120 }
2121 }
2122 })
2123
2124 j.transitiveSrcFiles = android.NewDepSet(android.POSTORDER, mine, fromDeps)
2125}
2126
Jaewoong Jung26342642021-03-17 15:56:23 -07002127func (j *Module) IsInstallable() bool {
2128 return Bool(j.properties.Installable)
2129}
2130
2131type sdkLinkType int
2132
2133const (
2134 // TODO(jiyong) rename these for better readability. Make the allowed
2135 // and disallowed link types explicit
2136 // order is important here. See rank()
2137 javaCore sdkLinkType = iota
2138 javaSdk
2139 javaSystem
2140 javaModule
2141 javaSystemServer
2142 javaPlatform
2143)
2144
2145func (lt sdkLinkType) String() string {
2146 switch lt {
2147 case javaCore:
2148 return "core Java API"
2149 case javaSdk:
2150 return "Android API"
2151 case javaSystem:
2152 return "system API"
2153 case javaModule:
2154 return "module API"
2155 case javaSystemServer:
2156 return "system server API"
2157 case javaPlatform:
2158 return "private API"
2159 default:
2160 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2161 }
2162}
2163
2164// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2165// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2166// can't statically depend on modules that use Platform API.
2167func (lt sdkLinkType) rank() int {
2168 return int(lt)
2169}
2170
2171type moduleWithSdkDep interface {
2172 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002173 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002174}
2175
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002176func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2177 switch k {
2178 case android.SdkCore:
2179 return javaCore
2180 case android.SdkSystem:
2181 return javaSystem
2182 case android.SdkPublic:
2183 return javaSdk
2184 case android.SdkModule:
2185 return javaModule
2186 case android.SdkSystemServer:
2187 return javaSystemServer
2188 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2189 return javaPlatform
2190 default:
2191 return javaSdk
2192 }
2193}
2194
Jiyong Park92315372021-04-02 08:45:46 +09002195func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002196 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002197 case android.SdkCore.DefaultJavaLibraryName(),
2198 "legacy.core.platform.api.stubs",
2199 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002200 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002201 "core-lambda-stubs",
Jihoon Kangb5078312023-03-29 23:25:49 +00002202 "core-generated-annotation-stubs":
Jaewoong Jung26342642021-03-17 15:56:23 -07002203 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002204 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002205 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002206 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002207 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002208 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002209 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002210 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002211 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002212 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002213 return javaSystem, true
2214 }
2215
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002216 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002217 return linkType, true
2218 }
2219
Jiyong Park92315372021-04-02 08:45:46 +09002220 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002221 if !ver.Valid() {
2222 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002223 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002224
2225 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002226}
2227
2228// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2229// this module's. See the comment on rank() for details and an example.
2230func (j *Module) checkSdkLinkType(
2231 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2232 if ctx.Host() {
2233 return
2234 }
2235
Jiyong Park92315372021-04-02 08:45:46 +09002236 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002237 if stubs {
2238 return
2239 }
Jiyong Park92315372021-04-02 08:45:46 +09002240 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002241
2242 if myLinkType.rank() < depLinkType.rank() {
2243 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2244 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2245 "property of the source or target module so that target module is built "+
2246 "with the same or smaller API set when compared to the source.",
2247 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2248 }
2249}
2250
2251func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2252 var deps deps
2253
2254 if ctx.Device() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09002255 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07002256 if sdkDep.invalidVersion {
2257 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2258 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2259 } else if sdkDep.useFiles {
2260 // sdkDep.jar is actually equivalent to turbine header.jar.
2261 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002262 deps.dexClasspath = append(deps.dexClasspath, sdkDep.jars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002263 deps.aidlPreprocess = sdkDep.aidl
Spandan Das6e8bd1c2024-08-09 00:07:03 +00002264 // Add the sdk module dependency to `compileDepNames`.
2265 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2266 // TODO (b/358608607): Move this to decodeSdkDep
2267 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2268 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
Jaewoong Jung26342642021-03-17 15:56:23 -07002269 } else {
2270 deps.aidlPreprocess = sdkDep.aidl
2271 }
2272 }
2273
Jiyong Park92315372021-04-02 08:45:46 +09002274 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002275
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002276 j.collectTransitiveHeaderJars(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07002277 ctx.VisitDirectDeps(func(module android.Module) {
2278 otherName := ctx.OtherModuleName(module)
2279 tag := ctx.OtherModuleDependencyTag(module)
2280
2281 if IsJniDepTag(tag) {
2282 // Handled by AndroidApp.collectAppDeps
2283 return
2284 }
2285 if tag == certificateTag {
2286 // Handled by AndroidApp.collectAppDeps
2287 return
2288 }
2289
2290 if dep, ok := module.(SdkLibraryDependency); ok {
2291 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002292 case sdkLibTag, libTag:
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002293 depHeaderJars := dep.SdkHeaderJars(ctx, j.SdkVersion(ctx))
2294 deps.classpath = append(deps.classpath, depHeaderJars...)
2295 deps.dexClasspath = append(deps.dexClasspath, depHeaderJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002296 case staticLibTag:
2297 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
2298 }
Colin Cross313aa542023-12-13 13:47:44 -08002299 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2300 if sdkLinkType != javaPlatform {
2301 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2302 // dep is a sysprop implementation library, but this module is not linking against
2303 // the platform, so it gets the sysprop public stubs library instead. Replace
2304 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2305 dep = syspropDep.JavaInfo
2306 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002307 }
2308 switch tag {
2309 case bootClasspathTag:
2310 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002311 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002312 if _, ok := module.(*Plugin); ok {
2313 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2314 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002315 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002316 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002317 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2318 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2319 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2320 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002321 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2322 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2323 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
2324 case java9LibTag:
2325 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
2326 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002327 if _, ok := module.(*Plugin); ok {
2328 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2329 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002330 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2331 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2332 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2333 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2334 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2335 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2336 // Turbine doesn't run annotation processors, so any module that uses an
2337 // annotation processor that generates API is incompatible with the turbine
2338 // optimization.
2339 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002340 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002341 case pluginTag:
2342 if plugin, ok := module.(*Plugin); ok {
2343 if plugin.pluginProperties.Processor_class != nil {
2344 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2345 } else {
2346 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2347 }
2348 // Turbine doesn't run annotation processors, so any module that uses an
2349 // annotation processor that generates API is incompatible with the turbine
2350 // optimization.
2351 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2352 } else {
2353 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2354 }
2355 case errorpronePluginTag:
2356 if _, ok := module.(*Plugin); ok {
2357 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2358 } else {
2359 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2360 }
2361 case exportedPluginTag:
2362 if plugin, ok := module.(*Plugin); ok {
2363 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2364 if plugin.pluginProperties.Processor_class != nil {
2365 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2366 }
2367 // Turbine doesn't run annotation processors, so any module that uses an
2368 // annotation processor that generates API is incompatible with the turbine
2369 // optimization.
2370 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2371 } else {
2372 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2373 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002374 case kotlinPluginTag:
2375 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002376 case syspropPublicStubDepTag:
2377 // This is a sysprop implementation library, forward the JavaInfoProvider from
2378 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002379 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002380 JavaInfo: dep,
2381 })
2382 }
2383 } else if dep, ok := module.(android.SourceFileProducer); ok {
2384 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002385 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002386 checkProducesJars(ctx, dep)
2387 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002388 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002389 case staticLibTag:
2390 checkProducesJars(ctx, dep)
2391 deps.classpath = append(deps.classpath, dep.Srcs()...)
2392 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2393 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
2394 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002395 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002396 switch tag {
2397 case staticLibTag:
2398 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2399 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002400 } else {
2401 switch tag {
2402 case bootClasspathTag:
2403 // If a system modules dependency has been added to the bootclasspath
2404 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002405 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2406 depHeaderJars := sm.HeaderJars
2407 deps.bootClasspath = append(deps.bootClasspath, depHeaderJars...)
2408 } else {
2409 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2410 ctx.OtherModuleName(module))
2411 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002412
2413 case systemModulesTag:
2414 if deps.systemModules != nil {
2415 panic("Found two system module dependencies")
2416 }
Colin Crossb61c2262024-08-08 14:04:42 -07002417 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2418 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2419 } else {
2420 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2421 ctx.OtherModuleName(module))
2422 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002423
2424 case instrumentationForTag:
2425 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 -07002426 }
2427 }
2428
Spandan Das8aac9932024-07-18 23:14:13 +00002429 if android.InList(tag, compileDependencyTags) {
2430 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2431 j.compileDepNames = append(j.compileDepNames, otherName)
2432 }
2433
Jaewoong Jung26342642021-03-17 15:56:23 -07002434 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002435 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002436 })
2437
2438 return deps
2439}
2440
Joe Onorato349ae8d2024-02-05 22:46:00 +00002441// Provider for jarjar renaming rules.
2442//
2443// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2444// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2445// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2446// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2447// be renamed from that module.
2448// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002449type DependencyUse int
2450
2451const (
2452 RenameUseInvalid DependencyUse = iota
2453 RenameUseInclude
2454 RenameUseExclude
2455)
2456
2457type RenameUseElement struct {
2458 DepName string
2459 RenameUse DependencyUse
2460 Why string // token for determining where in the logic the decision was made.
2461}
2462
Joe Onorato349ae8d2024-02-05 22:46:00 +00002463type JarJarProviderData struct {
2464 // Mapping of class names: original --> renamed. If the value is "", the class will be
2465 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2466 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002467 Rename map[string]string
2468 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002469}
2470
2471func (this JarJarProviderData) GetDebugString() string {
2472 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002473 for _, k := range android.SortedKeys(this.Rename) {
2474 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002475 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2476 result += k + "--&gt;" + v + ";"
2477 }
2478 }
2479 return result
2480}
2481
2482var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2483
2484var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2485
2486func init() {
2487 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
2488}
2489
2490// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2491// whether they are java modules or not.
2492type BaseJarJarProviderData struct {
2493 JarJarProviderData JarJarProviderData
2494}
2495
2496func (this BaseJarJarProviderData) GetDebugString() string {
2497 return this.JarJarProviderData.GetDebugString()
2498}
2499
2500var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2501
2502// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2503// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2504// either JarJarProvider or BaseJarJarProvider.
2505func mergeJarJarPrefixes(ctx android.ModuleContext) {
2506 mod := ctx.Module()
2507 // Explicitly avoid propagating into some module types.
2508 switch reflect.TypeOf(mod).String() {
2509 case "*java.Droidstubs":
2510 return
2511 }
2512 jarJarData := collectDirectDepsProviders(ctx)
2513 if jarJarData != nil {
2514 providerData := BaseJarJarProviderData{
2515 JarJarProviderData: *jarJarData,
2516 }
2517 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2518 }
2519
2520}
2521
2522// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2523func (module *Module) addJarJarRenameRule(original string, renamed string) {
2524 if module.jarjarRenameRules == nil {
2525 module.jarjarRenameRules = make(map[string]string)
2526 }
2527 module.jarjarRenameRules[original] = renamed
2528}
2529
2530func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2531 // Gather repackage information from deps
2532 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002533
2534 module := ctx.Module()
2535 moduleName := module.Name()
2536
Joe Onorato349ae8d2024-02-05 22:46:00 +00002537 ctx.VisitDirectDepsIgnoreBlueprint(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002538 tag := ctx.OtherModuleDependencyTag(m)
2539 // This logic mirrors that in (*Module).collectDeps above. There are several places
2540 // where we explicitly return RenameUseExclude, even though it is the default, to
2541 // indicate that it has been verified to be the case.
2542 //
2543 // Note well: there are probably cases that are getting to the unconditional return
2544 // and are therefore wrong.
2545 shouldIncludeRenames := func() (DependencyUse, string) {
2546 if moduleName == m.Name() {
2547 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2548 }
2549 if sc, ok := module.(android.SdkContext); ok {
2550 if ctx.Device() {
2551 sdkDep := decodeSdkDep(ctx, sc)
2552 if !sdkDep.invalidVersion && sdkDep.useFiles {
2553 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002554 }
2555 }
LaMont Jones63683e42024-02-08 14:30:45 -08002556 }
2557 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2558 return RenameUseExclude, "tags"
2559 }
2560 if _, ok := m.(SdkLibraryDependency); ok {
2561 switch tag {
2562 case sdkLibTag, libTag:
2563 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2564 }
2565 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2566 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2567 switch ji.StubsLinkType {
2568 case Stubs:
2569 return RenameUseExclude, "info"
2570 case Implementation:
2571 return RenameUseInclude, "info"
2572 default:
LaMont Jones09721862024-06-11 10:30:50 -07002573 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002574 // Fall through to the heuristic logic.
2575 }
2576 switch reflect.TypeOf(m).String() {
2577 case "*java.GeneratedJavaLibraryModule":
2578 // Probably a java_aconfig_library module.
2579 // TODO: make this check better.
2580 return RenameUseInclude, "reflect"
2581 }
2582 switch tag {
2583 case bootClasspathTag:
2584 return RenameUseExclude, "tagswitch"
2585 case sdkLibTag, libTag, instrumentationForTag:
2586 return RenameUseInclude, "tagswitch"
2587 case java9LibTag:
2588 return RenameUseExclude, "tagswitch"
2589 case staticLibTag:
2590 return RenameUseInclude, "tagswitch"
2591 case pluginTag:
2592 return RenameUseInclude, "tagswitch"
2593 case errorpronePluginTag:
2594 return RenameUseInclude, "tagswitch"
2595 case exportedPluginTag:
2596 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002597 case kotlinPluginTag:
2598 return RenameUseInclude, "tagswitch"
2599 default:
2600 return RenameUseExclude, "tagswitch"
2601 }
2602 } else if _, ok := m.(android.SourceFileProducer); ok {
2603 switch tag {
2604 case sdkLibTag, libTag, staticLibTag:
2605 return RenameUseInclude, "srcfile"
2606 default:
2607 return RenameUseExclude, "srcfile"
2608 }
Yu Liu67a28422024-03-05 00:36:31 +00002609 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002610 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002611 } else {
2612 switch tag {
2613 case bootClasspathTag:
2614 return RenameUseExclude, "else"
2615 case systemModulesTag:
2616 return RenameUseInclude, "else"
2617 }
2618 }
2619 // If we got here, choose the safer option, which may lead to a build failure, rather
2620 // than runtime failures on the device.
2621 return RenameUseExclude, "end"
2622 }
2623
2624 if result == nil {
2625 result = &JarJarProviderData{
2626 Rename: make(map[string]string),
2627 RenameUse: make([]RenameUseElement, 0),
2628 }
2629 }
2630 how, why := shouldIncludeRenames()
2631 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2632 if how != RenameUseInclude {
2633 // Nothing to merge.
2634 return
2635 }
2636
2637 merge := func(theirs *JarJarProviderData) {
2638 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002639 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2640 result.Rename[orig] = renamed
2641 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2642 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2643 result.Rename[orig] = renamed
2644 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2645 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2646 continue
2647 }
2648 }
2649 }
2650 }
2651 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2652 merge(&theirs)
2653 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2654 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2655 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2656 // to java.Module.
2657 merge(&theirs.JarJarProviderData)
2658 }
2659 })
2660 return
2661}
2662
2663func (this Module) GetDebugString() string {
2664 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2665}
2666
2667// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2668// us, and if it's been set, apply the jarjar_prefix property to rename them.
2669func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2670 // Gather repackage information from deps
2671 result := collectDirectDepsProviders(ctx)
2672
Joe Onoratoa5d17172024-07-20 17:39:56 -07002673 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002674 if result == nil {
2675 result = &JarJarProviderData{
2676 Rename: make(map[string]string),
2677 }
2678 }
2679 if renamed != "" {
2680 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2681 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002682 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002683 }
2684 }
2685 (*result).Rename[orig] = renamed
2686 }
2687
Joe Onoratoa5d17172024-07-20 17:39:56 -07002688 // Update that with entries we've stored for ourself
2689 for orig, renamed := range module.jarjarRenameRules {
2690 add(orig, renamed)
2691 }
2692
2693 // Update that with entries given in the jarjar_rename property.
2694 for _, orig := range module.properties.Jarjar_rename {
2695 add(orig, "")
2696 }
2697
Joe Onorato349ae8d2024-02-05 22:46:00 +00002698 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2699 if result == nil {
2700 return nil
2701 }
2702
2703 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2704 // that have not yet been renamed.
2705 prefix := proptools.String(module.properties.Jarjar_prefix)
2706 if prefix != "" {
2707 if prefix[0] == '.' {
2708 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2709 return nil
2710 }
2711 if prefix[len(prefix)-1] == '.' {
2712 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2713 return nil
2714 }
2715
2716 var updated map[string]string
2717 for orig, renamed := range (*result).Rename {
2718 if renamed == "" {
2719 if updated == nil {
2720 updated = make(map[string]string)
2721 }
2722 updated[orig] = prefix + "." + orig
2723 }
2724 }
2725 for orig, renamed := range updated {
2726 (*result).Rename[orig] = renamed
2727 }
2728 }
2729
2730 return result
2731}
2732
2733// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2734// to "" won't be in this list because they shouldn't be renamed yet.
2735func getJarJarRuleText(provider *JarJarProviderData) string {
2736 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002737 for _, orig := range android.SortedKeys(provider.Rename) {
2738 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002739 if renamed != "" {
2740 result += "rule " + orig + " " + renamed + "\n"
2741 }
2742 }
2743 return result
2744}
2745
Zi Wangddb2ee52024-04-02 16:44:02 +00002746// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Cross7707b242024-07-26 12:02:36 -07002747func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) android.Path {
Zi Wangddb2ee52024-04-02 16:44:02 +00002748 if j.repackageJarjarRules == nil {
2749 return infile
2750 }
Colin Crossedec77c2024-07-26 15:25:40 -07002751 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002752 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
2753 return repackagedJarjarFile
2754}
2755
Colin Crossedec77c2024-07-26 15:25:40 -07002756func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) android.Path {
2757 if j.expandJarjarRules == nil {
2758 return infile
2759 }
2760 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2761 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
2762 return jarjarFile
2763
2764}
2765
Jaewoong Jung26342642021-03-17 15:56:23 -07002766func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2767 deps.processorPath = append(deps.processorPath, pluginJars...)
2768 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2769}
2770
2771// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2772// this interface.
2773type ProvidesUsesLib interface {
2774 ProvidesUsesLib() *string
2775}
2776
2777func (j *Module) ProvidesUsesLib() *string {
2778 return j.usesLibraryProperties.Provides_uses_lib
2779}
satayev1c564cc2021-05-25 19:50:30 +01002780
2781type ModuleWithStem interface {
2782 Stem() string
2783}
2784
2785var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002786
2787type ModuleWithUsesLibrary interface {
2788 UsesLibrary() *usesLibrary
2789}
2790
2791func (j *Module) UsesLibrary() *usesLibrary {
2792 return &j.usesLibrary
2793}
2794
2795var _ ModuleWithUsesLibrary = (*Module)(nil)