blob: 5ac965cad2c28626cbd20dfe7613feff137c5a5e [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"`
Yihan Dong8be09c22024-08-29 15:32:13 +0800236
237 // If true, enable the "ApiMapper" tool on the output jar. "ApiMapper" is a tool to inject
238 // bytecode to log API calls.
239 ApiMapper bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700240}
241
242// Properties that are specific to device modules. Host module factories should not add these when
243// constructing a new module.
244type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000245 // If not blank, set to the version of the sdk to compile against.
Spandan Das1ccf5742022-10-14 16:51:23 +0000246 // Defaults to an empty string, which compiles the module against the private platform APIs.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000247 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000248 // 1) numerical API level, "current", "none", or "core_platform"
249 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
250 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
251 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700252 Sdk_version *string
253
satayev0a420e72021-11-29 17:25:52 +0000254 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
255 // Defaults to empty string "". See sdk_version for possible values.
256 Max_sdk_version *string
257
William Loh5a082f92022-05-17 20:21:50 +0000258 // if not blank, set the maxSdkVersion properties of permission and uses-permission tags.
259 // Defaults to empty string "". See sdk_version for possible values.
260 Replace_max_sdk_version_placeholder *string
261
Jaewoong Jung26342642021-03-17 15:56:23 -0700262 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000263 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700264 Target_sdk_version *string
265
266 // Whether to compile against the platform APIs instead of an SDK.
267 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000268 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700269 Platform_apis *bool
270
271 Aidl struct {
272 // Top level directories to pass to aidl tool
273 Include_dirs []string
274
275 // Directories rooted at the Android.bp file to pass to aidl tool
276 Local_include_dirs []string
277
278 // directories that should be added as include directories for any aidl sources of modules
279 // that depend on this module, as well as to aidl for this module.
280 Export_include_dirs []string
281
282 // whether to generate traces (for systrace) for this interface
283 Generate_traces *bool
284
285 // whether to generate Binder#GetTransaction name method.
286 Generate_get_transaction_name *bool
287
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100288 // whether all interfaces should be annotated with required permissions.
289 Enforce_permissions *bool
290
291 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
292 Enforce_permissions_exceptions []string `android:"path"`
293
Jaewoong Jung26342642021-03-17 15:56:23 -0700294 // list of flags that will be passed to the AIDL compiler
295 Flags []string
296 }
297
298 // If true, export a copy of the module as a -hostdex module for host testing.
299 Hostdex *bool
300
301 Target struct {
302 Hostdex struct {
303 // Additional required dependencies to add to -hostdex modules.
304 Required []string
305 }
306 }
307
308 // When targeting 1.9 and above, override the modules to use with --system,
309 // otherwise provides defaults libraries to add to the bootclasspath.
310 System_modules *string
311
Jaewoong Jung26342642021-03-17 15:56:23 -0700312 IsSDKLibrary bool `blueprint:"mutated"`
313
314 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
315 // Defaults to false.
316 V4_signature *bool
317
318 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
319 // public stubs library.
320 SyspropPublicStub string `blueprint:"mutated"`
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000321
322 HiddenAPIPackageProperties
323 HiddenAPIFlagFileProperties
Jaewoong Jung26342642021-03-17 15:56:23 -0700324}
325
yangbill2af0b6e2024-03-15 09:29:29 +0000326// Properties that can be overridden by overriding module (e.g. override_android_app)
327type OverridableProperties struct {
Jooyung Han01d80d82022-01-08 12:16:32 +0900328 // set the name of the output. If not set, `name` is used.
329 // To override a module with this property set, overriding module might need to set this as well.
330 // Otherwise, both the overridden and the overriding modules will have the same output name, which
331 // can cause the duplicate output error.
332 Stem *string
Spandan Dasb9c58352024-05-13 18:29:45 +0000333
334 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
335 // Defaults to sdk_version if not set. See sdk_version for possible values.
336 Min_sdk_version *string
Jooyung Han01d80d82022-01-08 12:16:32 +0900337}
338
Jaewoong Jung26342642021-03-17 15:56:23 -0700339// Functionality common to Module and Import
340//
341// It is embedded in Module so its functionality can be used by methods in Module
342// but it is currently only initialized by Import and Library.
343type embeddableInModuleAndImport struct {
344
345 // Functionality related to this being used as a component of a java_sdk_library.
346 EmbeddableSdkLibraryComponent
347}
348
Paul Duffin71b33cc2021-06-23 11:39:47 +0100349func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
350 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700351}
352
353// Module/Import's DepIsInSameApex(...) delegates to this method.
354//
355// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
356// the one provided by ApexModuleBase.
357func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
358 // dependencies other than the static linkage are all considered crossing APEX boundary
359 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
360 return true
361 }
362 return false
363}
364
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100365// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
366// or an invalid path describing the reason it is invalid.
367//
368// It is unset if a dex jar isn't applicable, i.e. no build rule has been
369// requested to create one.
370//
371// If a dex jar has been requested to be built then it is set, and it may be
372// either a valid android.Path, or invalid with a reason message. The latter
373// happens if the source that should produce the dex file isn't able to.
374//
375// E.g. it is invalid with a reason message if there is a prebuilt APEX that
376// could produce the dex jar through a deapexer module, but the APEX isn't
377// installable so doing so wouldn't be safe.
378type OptionalDexJarPath struct {
379 isSet bool
380 path android.OptionalPath
381}
382
383// IsSet returns true if a path has been set, either invalid or valid.
384func (o OptionalDexJarPath) IsSet() bool {
385 return o.isSet
386}
387
388// Valid returns true if there is a path that is valid.
389func (o OptionalDexJarPath) Valid() bool {
390 return o.isSet && o.path.Valid()
391}
392
393// Path returns the valid path, or panics if it's either not set or is invalid.
394func (o OptionalDexJarPath) Path() android.Path {
395 if !o.isSet {
396 panic("path isn't set")
397 }
398 return o.path.Path()
399}
400
401// PathOrNil returns the path if it's set and valid, or else nil.
402func (o OptionalDexJarPath) PathOrNil() android.Path {
403 if o.Valid() {
404 return o.Path()
405 }
406 return nil
407}
408
409// InvalidReason returns the reason for an invalid path, which is never "". It
410// returns "" for an unset or valid path.
411func (o OptionalDexJarPath) InvalidReason() string {
412 if !o.isSet {
413 return ""
414 }
415 return o.path.InvalidReason()
416}
417
418func (o OptionalDexJarPath) String() string {
419 if !o.isSet {
420 return "<unset>"
421 }
422 return o.path.String()
423}
424
425// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
426func makeUnsetDexJarPath() OptionalDexJarPath {
427 return OptionalDexJarPath{isSet: false}
428}
429
430// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
431// the given OptionalPath, which may be valid or invalid.
432func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
433 return OptionalDexJarPath{isSet: true, path: path}
434}
435
436// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
437// valid given path. It returns an unset OptionalDexJarPath if the given path is
438// nil.
439func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
440 if path == nil {
441 return makeUnsetDexJarPath()
442 }
443 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
444}
445
Jaewoong Jung26342642021-03-17 15:56:23 -0700446// Module contains the properties and members used by all java module types
447type Module struct {
448 android.ModuleBase
449 android.DefaultableModuleBase
450 android.ApexModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700451
452 // Functionality common to Module and Import.
453 embeddableInModuleAndImport
454
455 properties CommonProperties
456 protoProperties android.ProtoProperties
457 deviceProperties DeviceProperties
458
yangbill2af0b6e2024-03-15 09:29:29 +0000459 overridableProperties OverridableProperties
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700460 sourceProperties android.SourceProperties
Jooyung Han01d80d82022-01-08 12:16:32 +0900461
Jaewoong Jung26342642021-03-17 15:56:23 -0700462 // jar file containing header classes including static library dependencies, suitable for
463 // inserting into the bootclasspath/classpath of another compile
464 headerJarFile android.Path
465
Joe Onorato349ae8d2024-02-05 22:46:00 +0000466 repackagedHeaderJarFile android.Path
467
Jaewoong Jung26342642021-03-17 15:56:23 -0700468 // jar file containing implementation classes including static library dependencies but no
469 // resources
470 implementationJarFile android.Path
471
472 // jar file containing only resources including from static library dependencies
473 resourceJar android.Path
474
475 // args and dependencies to package source files into a srcjar
476 srcJarArgs []string
477 srcJarDeps android.Paths
478
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000479 // the source files of this module and all its static dependencies
480 transitiveSrcFiles *android.DepSet[android.Path]
481
Jaewoong Jung26342642021-03-17 15:56:23 -0700482 // jar file containing implementation classes and resources including static library
483 // dependencies
484 implementationAndResourcesJar android.Path
485
486 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100487 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700488
489 // output file containing uninstrumented classes that will be instrumented by jacoco
490 jacocoReportClassesFile android.Path
491
492 // output file of the module, which may be a classes jar or a dex jar
493 outputFile android.Path
494 extraOutputFiles android.Paths
495
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100496 exportAidlIncludeDirs android.Paths
497 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700498
499 logtagsSrcs android.Paths
500
501 // installed file for binary dependency
502 installFile android.Path
503
Colin Cross3108ce12021-11-10 14:38:50 -0800504 // installed file for hostdex copy
505 hostdexInstallFile android.InstallPath
506
Chaohui Wangdcbe33c2022-10-11 11:13:30 +0800507 // list of unique .java and .kt source files
508 uniqueSrcFiles android.Paths
509
510 // list of srcjars that was passed to javac
511 compiledSrcJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700512
513 // manifest file to use instead of properties.Manifest
514 overrideManifest android.OptionalPath
515
Jaewoong Jung26342642021-03-17 15:56:23 -0700516 // list of plugins that this java module is exporting
517 exportedPluginJars android.Paths
518
519 // list of plugins that this java module is exporting
520 exportedPluginClasses []string
521
522 // if true, the exported plugins generate API and require disabling turbine.
523 exportedDisableTurbine bool
524
525 // list of source files, collected from srcFiles with unique java and all kt files,
526 // will be used by android.IDEInfo struct
527 expandIDEInfoCompiledSrcs []string
528
529 // expanded Jarjar_rules
530 expandJarjarRules android.Path
531
Joe Onorato349ae8d2024-02-05 22:46:00 +0000532 // jarjar rule for inherited jarjar rules
533 repackageJarjarRules android.Path
534
Jaewoong Jung26342642021-03-17 15:56:23 -0700535 // Extra files generated by the module type to be added as java resources.
536 extraResources android.Paths
537
538 hiddenAPI
539 dexer
540 dexpreopter
541 usesLibrary
542 linter
543
544 // list of the xref extraction files
545 kytheFiles android.Paths
546
Jaewoong Jung26342642021-03-17 15:56:23 -0700547 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900548
549 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000550 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000551 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400552
553 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000554
555 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000556
557 // output file name based on Stem property.
558 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
559 // or the module should override Stem().
560 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700561
Joe Onorato349ae8d2024-02-05 22:46:00 +0000562 // Values that will be set in the JarJarProvider data for jarjar repackaging,
563 // and merged with our dependencies' rules.
564 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000565
566 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000567
568 // Paths to the aconfig intermediate cache files that are provided by the
569 // java_aconfig_library or java_library modules that are statically linked
570 // to this module. Does not contain cache files from all transitive dependencies.
571 aconfigCacheFiles android.Paths
Spandan Das8aac9932024-07-18 23:14:13 +0000572
573 // List of soong module dependencies required to compile the current module.
574 // This information is printed out to `Dependencies` field in module_bp_java_deps.json
575 compileDepNames []string
Makoto Onuki7ded3822024-03-28 14:42:20 -0700576
577 ravenizer struct {
578 enabled bool
579 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700580}
581
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000582var _ android.InstallableModule = (*Module)(nil)
583
584// To satisfy the InstallableModule interface
Jihoon Kang224ea082024-08-12 22:38:16 +0000585func (j *Module) StaticDependencyTags() []blueprint.DependencyTag {
586 return []blueprint.DependencyTag{staticLibTag}
587}
588
589// To satisfy the InstallableModule interface
590func (j *Module) DynamicDependencyTags() []blueprint.DependencyTag {
591 return []blueprint.DependencyTag{libTag, sdkLibTag, bootClasspathTag, systemModulesTag,
592 instrumentationForTag, java9LibTag}
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000593}
594
595// Overrides android.ModuleBase.InstallInProduct()
596func (j *Module) InstallInProduct() bool {
597 return j.ProductSpecific()
598}
599
Jiyong Park92315372021-04-02 08:45:46 +0900600func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
601 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900602 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700603 return nil
604 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900605 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000606 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700607 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
608 } else {
609 // Treat stable core platform as stable.
610 return nil
611 }
612 } else {
613 return fmt.Errorf("non stable SDK %v", sdkVersion)
614 }
615}
616
617// checkSdkVersions enforces restrictions around SDK dependencies.
618func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
619 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900620 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900621 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700622 ctx.PropertyErrorf("sdk_version",
623 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
624 }
625 }
626 }
627
628 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
629 // See rank() for details.
630 ctx.VisitDirectDeps(func(module android.Module) {
631 tag := ctx.OtherModuleDependencyTag(module)
632 switch module.(type) {
633 // TODO(satayev): cover other types as well, e.g. imports
634 case *Library, *AndroidLibrary:
635 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400636 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700637 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
638 }
639 }
640 })
641}
642
643func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900644 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700645 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900646 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700647 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000648 ctx.PropertyErrorf("platform_apis", "This module has conflicting settings. sdk_version is not empty, which means this module cannot use platform APIs. However platform_apis is set to true.")
Jaewoong Jung26342642021-03-17 15:56:23 -0700649 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000650 ctx.PropertyErrorf("platform_apis", "This module has conflicting settings. sdk_version is empty, which means that this module is build against platform APIs. However platform_apis is not set to true")
Jaewoong Jung26342642021-03-17 15:56:23 -0700651 }
652
653 }
654}
655
Mark Whitea15790a2023-08-22 21:28:11 +0000656func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
657 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400658 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000659 installable := proptools.Bool(j.properties.Installable)
660
661 if headersOnly && installable {
662 ctx.PropertyErrorf("headers_only", "This module has conflicting settings. headers_only is true which, which means this module doesn't generate an implementation jar. However installable is set to true.")
663 }
664 }
665}
666
Jaewoong Jung26342642021-03-17 15:56:23 -0700667func (j *Module) addHostProperties() {
668 j.AddProperties(
669 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000670 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700671 &j.protoProperties,
672 &j.usesLibraryProperties,
673 )
674}
675
676func (j *Module) addHostAndDeviceProperties() {
677 j.addHostProperties()
678 j.AddProperties(
679 &j.deviceProperties,
680 &j.dexer.dexProperties,
681 &j.dexpreoptProperties,
682 &j.linter.properties,
683 )
684}
685
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000686// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
687// makes it available through the hiddenAPIPropertyInfoProvider.
688func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
689 hiddenAPIInfo := newHiddenAPIPropertyInfo()
690
691 // Populate with flag file paths from the properties.
692 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
693
694 // Populate with package rules from the properties.
695 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
696
Colin Cross40213022023-12-13 15:19:49 -0800697 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000698}
699
mrziwang9f7b9f42024-07-10 12:18:06 -0700700// helper method for java modules to set OutputFilesProvider
701func setOutputFiles(ctx android.ModuleContext, m Module) {
702 ctx.SetOutputFiles(append(android.Paths{m.outputFile}, m.extraOutputFiles...), "")
703 ctx.SetOutputFiles(android.Paths{m.outputFile}, android.DefaultDistTag)
704 ctx.SetOutputFiles(android.Paths{m.implementationAndResourcesJar}, ".jar")
705 ctx.SetOutputFiles(android.Paths{m.headerJarFile}, ".hjar")
706 if m.dexer.proguardDictionary.Valid() {
707 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
708 }
709 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
710 if m.linter.outputs.xml != nil {
711 ctx.SetOutputFiles(android.Paths{m.linter.outputs.xml}, ".lint")
Jaewoong Jung26342642021-03-17 15:56:23 -0700712 }
713}
714
Jaewoong Jung26342642021-03-17 15:56:23 -0700715func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
716 initJavaModule(module, hod, false)
717}
718
719func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
720 initJavaModule(module, hod, true)
721}
722
723func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
724 multilib := android.MultilibCommon
725 if multiTargets {
726 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
727 } else {
728 android.InitAndroidArchModule(module, hod, multilib)
729 }
730 android.InitDefaultableModule(module)
731}
732
733func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
734 return j.properties.Instrument &&
735 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
736 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
737}
738
Yihan Dong8be09c22024-08-29 15:32:13 +0800739func (j *Module) shouldApiMapper() bool {
740 return j.properties.ApiMapper
741}
742
Jaewoong Jung26342642021-03-17 15:56:23 -0700743func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000744 return j.properties.Supports_static_instrumentation &&
745 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700746 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
747 ctx.Config().UnbundledBuild())
748}
749
750func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
751 // Force enable the instrumentation for java code that is built for APEXes ...
752 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
753 // 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 -0800754 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700755 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000756
Jihoon Kang46d66de2024-05-22 22:42:39 +0000757 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700758 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
759 return true
760 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
761 return true
762 }
763 }
764 return false
765}
766
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400767func (j *Module) setInstrument(value bool) {
768 j.properties.Instrument = value
769}
770
Yihan Dong8be09c22024-08-29 15:32:13 +0800771func (j *Module) setApiMapper(value bool) {
772 j.properties.ApiMapper = value
773}
774
Jiyong Park92315372021-04-02 08:45:46 +0900775func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
776 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700777}
778
Jiyong Parkf1691d22021-03-29 20:11:58 +0900779func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700780 return proptools.String(j.deviceProperties.System_modules)
781}
782
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000783func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000784 if j.overridableProperties.Min_sdk_version != nil {
785 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700786 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000787 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700788}
789
Yu Liuf2b94012023-09-19 15:09:10 -0700790func (j *Module) GetDeviceProperties() *DeviceProperties {
791 return &j.deviceProperties
792}
793
Spandan Dasa26eda72023-03-02 00:56:06 +0000794func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
795 if j.deviceProperties.Max_sdk_version != nil {
796 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
797 }
798 // Default is PrivateApiLevel
799 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000800}
801
Spandan Dasa26eda72023-03-02 00:56:06 +0000802func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
803 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
804 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
805 }
806 // Default is PrivateApiLevel
807 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000808}
809
Jiyong Parkf1691d22021-03-29 20:11:58 +0900810func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000811 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900812}
813
Spandan Dasca70fc42023-03-01 23:38:49 +0000814func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900815 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000816 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900817 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000818 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700819}
820
821func (j *Module) AvailableFor(what string) bool {
822 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
823 // Exception: for hostdex: true libraries, the platform variant is created
824 // even if it's not marked as available to platform. In that case, the platform
825 // variant is used only for the hostdex and not installed to the device.
826 return true
827 }
828 return j.ApexModuleBase.AvailableFor(what)
829}
830
831func (j *Module) deps(ctx android.BottomUpMutatorContext) {
832 if ctx.Device() {
833 j.linter.deps(ctx)
834
Jiyong Parkf1691d22021-03-29 20:11:58 +0900835 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700836
837 if j.deviceProperties.SyspropPublicStub != "" {
838 // This is a sysprop implementation library that has a corresponding sysprop public
839 // stubs library, and a dependency on it so that dependencies on the implementation can
840 // be forwarded to the public stubs library when necessary.
841 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
842 }
843 }
844
845 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000846
847 j.properties.Static_libs = android.RemoveListFromList(j.properties.Static_libs, j.properties.Exclude_static_libs)
Jaewoong Jung26342642021-03-17 15:56:23 -0700848 ctx.AddVariationDependencies(nil, staticLibTag, j.properties.Static_libs...)
849
850 // Add dependency on libraries that provide additional hidden api annotations.
851 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
852
Kiyoung Kim9743bab2024-03-28 15:44:56 +0900853 if ctx.Config().EnforceInterPartitionJavaSdkLibrary() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700854 // Require java_sdk_library at inter-partition java dependency to ensure stable
855 // interface between partitions. If inter-partition java_library dependency is detected,
856 // raise build error because java_library doesn't have a stable interface.
857 //
858 // Inputs:
859 // PRODUCT_ENFORCE_INTER_PARTITION_JAVA_SDK_LIBRARY
860 // if true, enable enforcement
861 // PRODUCT_INTER_PARTITION_JAVA_LIBRARY_ALLOWLIST
862 // exception list of java_library names to allow inter-partition dependency
863 for idx := range j.properties.Libs {
864 if libDeps[idx] == nil {
865 continue
866 }
867
868 if javaDep, ok := libDeps[idx].(javaSdkLibraryEnforceContext); ok {
869 // java_sdk_library is always allowed at inter-partition dependency.
870 // So, skip check.
871 if _, ok := javaDep.(*SdkLibrary); ok {
872 continue
873 }
874
875 j.checkPartitionsForJavaDependency(ctx, "libs", javaDep)
876 }
877 }
878 }
879
880 // For library dependencies that are component libraries (like stubs), add the implementation
881 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
882 for _, dep := range libDeps {
883 if dep != nil {
884 if component, ok := dep.(SdkLibraryComponentDependency); ok {
885 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000886 // Add library as optional if it's one of the optional compatibility libs or it's
887 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100888 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000889 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
890 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100891 tag = usesLibOptTag
892 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100893 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700894 }
895 }
896 }
897 }
898
899 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
900 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
901 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
902
903 android.ProtoDeps(ctx, &j.protoProperties)
904 if j.hasSrcExt(".proto") {
905 protoDeps(ctx, &j.protoProperties)
906 }
907
908 if j.hasSrcExt(".kt") {
909 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
910 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700911 tag := staticLibTag
912 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
913 tag = libTag
914 }
915 ctx.AddVariationDependencies(nil, tag,
916 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700917 }
918
919 // Framework libraries need special handling in static coverage builds: they should not have
920 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
921 // the same jacoco classes coming from different bootclasspath jars.
922 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
923 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
924 j.properties.Instrument = true
925 }
926 } else if j.shouldInstrumentStatic(ctx) {
927 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
928 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700929
930 if j.useCompose() {
931 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
932 "androidx.compose.compiler_compiler-hosted")
933 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700934}
935
936func hasSrcExt(srcs []string, ext string) bool {
937 for _, src := range srcs {
938 if filepath.Ext(src) == ext {
939 return true
940 }
941 }
942
943 return false
944}
945
946func (j *Module) hasSrcExt(ext string) bool {
947 return hasSrcExt(j.properties.Srcs, ext)
948}
949
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100950func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
951 var flags string
952
953 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
954 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
955 flags = "-Wmissing-permission-annotation -Werror"
956 }
957 }
958 return flags
959}
960
Jaewoong Jung26342642021-03-17 15:56:23 -0700961func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000962 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700963
964 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
965 aidlIncludes = append(aidlIncludes,
966 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
967 aidlIncludes = append(aidlIncludes,
968 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
969
970 var flags []string
971 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000972 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700973
974 flags = append(flags, j.deviceProperties.Aidl.Flags...)
975
976 if aidlPreprocess.Valid() {
977 flags = append(flags, "-p"+aidlPreprocess.String())
978 deps = append(deps, aidlPreprocess.Path())
979 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000980 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700981 }
982
983 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000984 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700985 }
986
987 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000988 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700989 }
990
Sam Delmerico2351eac2022-05-24 17:10:02 +0000991 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700992 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000993 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700994 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000995 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
996 // add flags for dirs containing AIDL srcs that haven't been specified yet
997 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -0700998
Zim8774ae12022-08-17 11:46:34 +0100999 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +00001000 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +01001001 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001002 flags = append(flags, "-t")
1003 }
1004
1005 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
1006 flags = append(flags, "--transaction_names")
1007 }
1008
Thiébaud Weksteende8417c2022-02-10 15:41:46 +11001009 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
1010 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
1011 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1012 }
1013
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001014 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001015 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1016
Jaewoong Jung26342642021-03-17 15:56:23 -07001017 return strings.Join(flags, " "), deps
1018}
1019
1020func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1021
1022 var flags javaBuilderFlags
1023
1024 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001025 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001026
Cole Faust2b1536e2021-06-18 12:25:54 -07001027 epEnabled := j.properties.Errorprone.Enabled
1028 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001029 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001030 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1031 }
1032
1033 errorProneFlags := []string{
1034 "-Xplugin:ErrorProne",
1035 "${config.ErrorProneChecks}",
1036 }
1037 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1038
Colin Cross8bf6cad2022-02-28 13:07:03 -08001039 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001040 "'" + strings.Join(errorProneFlags, " ") + "'"
1041 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1042 }
1043
1044 // classpath
1045 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1046 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001047 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001048 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1049 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1050 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1051
1052 flags.processors = append(flags.processors, deps.processorClasses...)
1053 flags.processors = android.FirstUniqueStrings(flags.processors)
1054
1055 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001056 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001057 // Give host-side tools a version of OpenJDK's standard libraries
1058 // close to what they're targeting. As of Dec 2017, AOSP is only
1059 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1060 //
1061 // When building with OpenJDK 8, the following should have no
1062 // effect since those jars would be available by default.
1063 //
1064 // When building with OpenJDK 9 but targeting a version < 1.8,
1065 // putting them on the bootclasspath means that:
1066 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1067 // b) references to existing APIs are not reinterpreted in an
1068 // OpenJDK 9-specific way, eg. calls to subclasses of
1069 // java.nio.Buffer as in http://b/70862583
1070 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1071 flags.bootClasspath = append(flags.bootClasspath,
1072 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1073 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1074 if Bool(j.properties.Use_tools_jar) {
1075 flags.bootClasspath = append(flags.bootClasspath,
1076 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1077 }
1078 }
1079
1080 // systemModules
1081 flags.systemModules = deps.systemModules
1082
Jaewoong Jung26342642021-03-17 15:56:23 -07001083 return flags
1084}
1085
1086func (j *Module) collectJavacFlags(
1087 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1088 // javac flags.
1089 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001090 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001091
Mythri Alle4b9f6182023-10-25 15:17:11 +00001092 needsDebugInfo = false
1093 for _, flag := range javacFlags {
1094 if strings.HasPrefix(flag, "-g") {
1095 needsDebugInfo = true
1096 }
1097 }
1098
1099 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001100 // For non-host binaries, override the -g flag passed globally to remove
1101 // local variable debug info to reduce disk and memory usage.
1102 javacFlags = append(javacFlags, "-g:source,lines")
1103 }
1104 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1105
1106 if flags.javaVersion.usesJavaModules() {
1107 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001108 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1109 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1110 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1111 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001112
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001113 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001114 if j.properties.Patch_module != nil {
1115 // Manually specify build directory in case it is not under the repo root.
1116 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1117 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001118 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001119
Jaewoong Jung26342642021-03-17 15:56:23 -07001120 classPath := flags.classpath.FormJavaClassPath("")
1121 if classPath != "" {
1122 patchPaths = append(patchPaths, classPath)
1123 }
1124 javacFlags = append(
1125 javacFlags,
1126 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1127 }
1128 }
1129
1130 if len(javacFlags) > 0 {
1131 // optimization.
1132 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1133 flags.javacFlags = "$javacFlags"
1134 }
1135
1136 return flags
1137}
1138
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001139func (j *Module) AddJSONData(d *map[string]interface{}) {
1140 (&j.ModuleBase).AddJSONData(d)
1141 (*d)["Java"] = map[string]interface{}{
1142 "SourceExtensions": j.sourceExtensions,
1143 }
1144
1145}
1146
usta0391ca42023-09-19 15:51:59 -04001147func (j *Module) addGeneratedSrcJars(path android.Path) {
1148 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001149}
1150
Colin Cross4eae06d2023-06-20 22:40:02 -07001151func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001152 // Auto-propagating jarjar rules
1153 jarjarProviderData := j.collectJarJarRules(ctx)
1154 if jarjarProviderData != nil {
1155 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wang9bdd4222024-02-26 18:21:01 -08001156 if !proptools.Bool(j.properties.Skip_jarjar_repackage) {
1157 text := getJarJarRuleText(jarjarProviderData)
1158 if text != "" {
1159 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1160 android.WriteFileRule(ctx, ruleTextFile, text)
1161 j.repackageJarjarRules = ruleTextFile
1162 }
Joe Onorato349ae8d2024-02-05 22:46:00 +00001163 }
1164 }
1165
Jaewoong Jung26342642021-03-17 15:56:23 -07001166 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1167
Makoto Onuki7ded3822024-03-28 14:42:20 -07001168 if re := proptools.Bool(j.properties.Ravenizer.Enabled); re {
1169 j.ravenizer.enabled = re
1170 }
1171
Jaewoong Jung26342642021-03-17 15:56:23 -07001172 deps := j.collectDeps(ctx)
1173 flags := j.collectBuilderFlags(ctx, deps)
1174
1175 if flags.javaVersion.usesJavaModules() {
1176 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001177 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1178 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1179 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001180 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001181
Jaewoong Jung26342642021-03-17 15:56:23 -07001182 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001183 j.sourceExtensions = []string{}
1184 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1185 if hasSrcExt(srcFiles.Strings(), ext) {
1186 j.sourceExtensions = append(j.sourceExtensions, ext)
1187 }
1188 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001189 if hasSrcExt(srcFiles.Strings(), ".proto") {
1190 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1191 }
1192
1193 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1194 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1195 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1196 }
1197
Sam Delmerico2351eac2022-05-24 17:10:02 +00001198 aidlSrcs := srcFiles.FilterByExt(".aidl")
1199 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1200
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001201 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001202 srcFiles = j.genSources(ctx, srcFiles, flags)
1203
1204 // Collect javac flags only after computing the full set of srcFiles to
1205 // ensure that the --patch-module lookup paths are complete.
1206 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1207
1208 srcJars := srcFiles.FilterByExt(".srcjar")
1209 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001210 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001211 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001212 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001213
1214 if j.properties.Jarjar_rules != nil {
1215 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1216 }
1217
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001218 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001219
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001220 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001221 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001222 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001223 if _, found := set[v.String()]; !found {
1224 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001225 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001226 }
1227 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001228 var uniqueKtFiles android.Paths
1229 for _, v := range srcFiles.FilterByExt(".kt") {
1230 if _, found := set[v.String()]; !found {
1231 set[v.String()] = true
1232 uniqueKtFiles = append(uniqueKtFiles, v)
1233 }
1234 }
1235
1236 var uniqueSrcFiles android.Paths
1237 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1238 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1239 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001240 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001241
Colin Crossb5db4012022-03-28 17:12:39 -07001242 // We don't currently run annotation processors in turbine, which means we can't use turbine
1243 // generated header jars when an annotation processor that generates API is enabled. One
1244 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1245 // is used to run all of the annotation processors.
1246 disableTurbine := deps.disableTurbine
1247
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001248 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001249 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1250
1251 var kotlinJars android.Paths
Colin Cross220a9a12022-03-28 17:08:01 -07001252 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001253
Colin Cross4eae06d2023-06-20 22:40:02 -07001254 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1255 // any dependencies so that it can override any non-final R classes from dependencies with the
1256 // final R classes from the app.
1257 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1258
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001259 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1260
Mark Whitea15790a2023-08-22 21:28:11 +00001261 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001262 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001263 if srcFiles.HasExt(".kt") {
1264 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1265 }
1266 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1267 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1268 }
1269
Colin Crossedec77c2024-07-26 15:25:40 -07001270 _, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
1271 extraCombinedJars)
1272
1273 combinedHeaderJarFile = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1274 combinedHeaderJarFile = j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
Mark Whitea15790a2023-08-22 21:28:11 +00001275 if ctx.Failed() {
1276 return
1277 }
Colin Crossedec77c2024-07-26 15:25:40 -07001278 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001279
Colin Cross7727c7f2024-07-18 15:36:32 -07001280 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001281 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1282 TransitiveLibsHeaderJars: j.transitiveLibsHeaderJars,
1283 TransitiveStaticLibsHeaderJars: j.transitiveStaticLibsHeaderJars,
1284 AidlIncludeDirs: j.exportAidlIncludeDirs,
1285 ExportedPlugins: j.exportedPluginJars,
1286 ExportedPluginClasses: j.exportedPluginClasses,
1287 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1288 StubsLinkType: j.stubsLinkType,
1289 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001290 })
1291
1292 j.outputFile = j.headerJarFile
1293 return
1294 }
1295
Jaewoong Jung26342642021-03-17 15:56:23 -07001296 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001297 // When using kotlin sources turbine is used to generate annotation processor sources,
1298 // including for annotation processors that generate API, so we can use turbine for
1299 // java sources too.
1300 disableTurbine = false
1301
Jaewoong Jung26342642021-03-17 15:56:23 -07001302 // user defined kotlin flags.
1303 kotlincFlags := j.properties.Kotlincflags
1304 CheckKotlincFlags(ctx, kotlincFlags)
1305
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001306 // Workaround for KT-46512
1307 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001308
1309 // If there are kotlin files, compile them first but pass all the kotlin and java files
1310 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1311 // won't emit any classes for them.
1312 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1313 if ctx.Device() {
1314 kotlincFlags = append(kotlincFlags, "-no-jdk")
1315 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001316
1317 for _, plugin := range deps.kotlinPlugins {
1318 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1319 }
1320 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1321
Jaewoong Jung26342642021-03-17 15:56:23 -07001322 if len(kotlincFlags) > 0 {
1323 // optimization.
1324 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1325 flags.kotlincFlags += "$kotlincFlags"
1326 }
1327
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001328 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001329 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1330
Jaewoong Jung26342642021-03-17 15:56:23 -07001331 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1332 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1333
Isaac Chioua23d9942022-04-06 06:14:38 +00001334 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001335 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001336 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1337 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001338 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001339 srcJars = append(srcJars, kaptSrcJar)
1340 kotlinJars = append(kotlinJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001341 // Disable annotation processing in javac, it's already been handled by kapt
1342 flags.processorPath = nil
1343 flags.processors = nil
1344 }
1345
1346 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001347 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001348 kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001349 if ctx.Failed() {
1350 return
1351 }
1352
Colin Cross7707b242024-07-26 12:02:36 -07001353 kotlinJarPath := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001354
Isaac Chioua23d9942022-04-06 06:14:38 +00001355 // Make javac rule depend on the kotlinc rule
1356 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1357
Zi Wangddb2ee52024-04-02 16:44:02 +00001358 kotlinJars = append(kotlinJars, kotlinJarPath)
Colin Cross220a9a12022-03-28 17:08:01 -07001359 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001360 }
1361
Colin Crossfd620b22024-02-23 10:05:21 -08001362 jars := slices.Clone(kotlinJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001363
Jaewoong Jung26342642021-03-17 15:56:23 -07001364 j.compiledSrcJars = srcJars
1365
1366 enableSharding := false
Colin Cross3d56ed52021-11-18 22:23:12 -08001367 var headerJarFileWithoutDepsOrJarjar android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001368 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001369 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1370 enableSharding = true
1371 // Formerly, there was a check here that prevented annotation processors
1372 // from being used when sharding was enabled, as some annotation processors
1373 // do not function correctly in sharded environments. It was removed to
1374 // allow for the use of annotation processors that do function correctly
1375 // with sharding enabled. See: b/77284273.
1376 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001377 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001378 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001379 var combinedHeaderJarFile android.Path
1380 headerJarFileWithoutDepsOrJarjar, combinedHeaderJarFile =
Colin Cross4eae06d2023-06-20 22:40:02 -07001381 j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
Colin Crossedec77c2024-07-26 15:25:40 -07001382
1383 j.headerJarFile = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1384 j.repackagedHeaderJarFile = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
Jaewoong Jung26342642021-03-17 15:56:23 -07001385 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001386 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001387 hasErrorproneableFiles := false
1388 for _, ext := range j.sourceExtensions {
1389 if ext != ".proto" && ext != ".aidl" {
1390 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1391 // compile, and it's not useful to have warnings on these generated sources.
1392 hasErrorproneableFiles = true
1393 break
1394 }
1395 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001396 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001397 if Bool(j.properties.Errorprone.Enabled) {
1398 // If error-prone is enabled, enable errorprone flags on the regular
1399 // build.
1400 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001401 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001402 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1403 // a new jar file just for compiling with the errorprone compiler to.
1404 // This is because we don't want to cause the java files to get completely
1405 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1406 // We also don't want to run this if errorprone is enabled by default for
1407 // this module, or else we could have duplicated errorprone messages.
1408 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001409 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001410 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001411
Vadim Spivak3c496f02023-06-08 06:14:59 +00001412 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001413 "errorprone", "errorprone")
1414
Jaewoong Jung26342642021-03-17 15:56:23 -07001415 extraJarDeps = append(extraJarDeps, errorprone)
1416 }
1417
1418 if enableSharding {
Colin Cross3d56ed52021-11-18 22:23:12 -08001419 if headerJarFileWithoutDepsOrJarjar != nil {
1420 flags.classpath = append(classpath{headerJarFileWithoutDepsOrJarjar}, flags.classpath...)
1421 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001422 shardSize := int(*(j.properties.Javac_shard_size))
1423 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001424 if len(uniqueJavaFiles) > 0 {
1425 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001426 for idx, shardSrc := range shardSrcs {
1427 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1428 nil, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001429 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
Jaewoong Jung26342642021-03-17 15:56:23 -07001430 jars = append(jars, classes)
1431 }
1432 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001433 // Assume approximately 5 sources per srcjar.
1434 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1435 // 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 -07001436 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001437 startIdx := len(shardSrcs)
1438 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1439 for idx, shardSrcJars := range shardSrcJarsList {
1440 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1441 nil, shardSrcJars, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001442 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
Colin Crossa052ddb2023-09-25 21:46:58 -07001443 jars = append(jars, classes)
1444 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001445 }
1446 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001447 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001448 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
Jaewoong Jung26342642021-03-17 15:56:23 -07001449 jars = append(jars, classes)
1450 }
1451 if ctx.Failed() {
1452 return
1453 }
1454 }
1455
Colin Crossfd620b22024-02-23 10:05:21 -08001456 jars = append(jars, extraCombinedJars...)
1457
Jaewoong Jung26342642021-03-17 15:56:23 -07001458 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1459
1460 var includeSrcJar android.WritablePath
1461 if Bool(j.properties.Include_srcs) {
1462 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1463 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1464 }
1465
1466 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1467 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1468 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1469 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1470
1471 var resArgs []string
1472 var resDeps android.Paths
1473
1474 resArgs = append(resArgs, dirArgs...)
1475 resDeps = append(resDeps, dirDeps...)
1476
1477 resArgs = append(resArgs, fileArgs...)
1478 resDeps = append(resDeps, fileDeps...)
1479
1480 resArgs = append(resArgs, extraArgs...)
1481 resDeps = append(resDeps, extraDeps...)
1482
1483 if len(resArgs) > 0 {
1484 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1485 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
1486 j.resourceJar = resourceJar
1487 if ctx.Failed() {
1488 return
1489 }
1490 }
1491
1492 var resourceJars android.Paths
1493 if j.resourceJar != nil {
1494 resourceJars = append(resourceJars, j.resourceJar)
1495 }
1496 if Bool(j.properties.Include_srcs) {
1497 resourceJars = append(resourceJars, includeSrcJar)
1498 }
1499 resourceJars = append(resourceJars, deps.staticResourceJars...)
1500
1501 if len(resourceJars) > 1 {
1502 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1503 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1504 false, nil, nil)
1505 j.resourceJar = combinedJar
1506 } else if len(resourceJars) == 1 {
1507 j.resourceJar = resourceJars[0]
1508 }
1509
1510 if len(deps.staticJars) > 0 {
1511 jars = append(jars, deps.staticJars...)
1512 }
1513
1514 manifest := j.overrideManifest
1515 if !manifest.Valid() && j.properties.Manifest != nil {
1516 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
1517 }
1518
1519 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1520 if len(services) > 0 {
1521 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1522 var zipargs []string
1523 for _, file := range services {
1524 serviceFile := file.String()
1525 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1526 }
1527 rule := zip
1528 args := map[string]string{
1529 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1530 }
1531 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1532 rule = zipRE
1533 args["implicits"] = strings.Join(services.Strings(), ",")
1534 }
1535 ctx.Build(pctx, android.BuildParams{
1536 Rule: rule,
1537 Output: servicesJar,
1538 Implicits: services,
1539 Args: args,
1540 })
1541 jars = append(jars, servicesJar)
1542 }
1543
1544 // Combine the classes built from sources, any manifests, and any static libraries into
1545 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001546 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001547
1548 if len(jars) == 1 && !manifest.Valid() {
1549 // Optimization: skip the combine step as there is nothing to do
1550 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1551 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1552 // any if len(jars) == 1.
1553
Jihoon Kang1147b312023-06-08 23:25:57 +00001554 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1555 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1556 // either with .from-source or .from-text suffix.
1557 // outputFile should be agnostic to the build configuration,
1558 // thus "combine" the single static lib in order to prevent the static lib from being exposed
1559 // to the copy rules.
Jihoon Kangfa3f0782024-08-21 20:42:18 +00001560 stub, _ := moduleStubLinkType(j)
Jihoon Kang1147b312023-06-08 23:25:57 +00001561
Colin Cross7707b242024-07-26 12:02:36 -07001562 if stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07001563 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1564 ctx.Build(pctx, android.BuildParams{
1565 Rule: android.Cp,
1566 Input: jars[0],
1567 Output: combinedJar,
1568 })
Colin Cross7707b242024-07-26 12:02:36 -07001569 outputFile = combinedJar
1570 } else {
1571 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001572 }
1573 } else {
1574 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1575 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1576 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001577 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001578 }
1579
1580 // jarjar implementation jar if necessary
Colin Crossedec77c2024-07-26 15:25:40 -07001581 jarjarFile := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1582 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001583
Colin Crossedec77c2024-07-26 15:25:40 -07001584 // jarjar resource jar if necessary
1585 if j.resourceJar != nil {
1586 resourceJarJarFile := j.jarjarIfNecessary(ctx, j.resourceJar, jarName, "resource")
1587 j.resourceJar = resourceJarJarFile
1588 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001589
Colin Crossedec77c2024-07-26 15:25:40 -07001590 if ctx.Failed() {
1591 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001592 }
1593
Makoto Onuki7ded3822024-03-28 14:42:20 -07001594 if j.ravenizer.enabled {
1595 ravenizerInput := outputFile
1596 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", jarName)
1597 ctx.Build(pctx, android.BuildParams{
1598 Rule: ravenizer,
1599 Description: "ravenizer",
1600 Input: ravenizerInput,
1601 Output: ravenizerOutput,
1602 })
1603 outputFile = ravenizerOutput
1604 }
1605
Yihan Dong8be09c22024-08-29 15:32:13 +08001606 if j.shouldApiMapper() {
1607 inputFile := outputFile
1608 apiMapperFile := android.PathForModuleOut(ctx, "apimapper", jarName)
1609 ctx.Build(pctx, android.BuildParams{
1610 Rule: apimapper,
1611 Description: "apimapper",
1612 Input: inputFile,
1613 Output: apiMapperFile,
1614 })
1615 outputFile = apiMapperFile
1616 }
1617
Jaewoong Jung26342642021-03-17 15:56:23 -07001618 // Check package restrictions if necessary.
1619 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001620 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001621 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001622
1623 // Create a rule to copy the output jar to another path and add a validate dependency that
1624 // will check that the jar only contains the permitted packages. The new location will become
1625 // the output file of this module.
1626 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001627 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001628 ctx.Build(pctx, android.BuildParams{
1629 Rule: android.Cp,
1630 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001631 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001632 // Make sure that any dependency on the output file will cause ninja to run the package check
1633 // rule.
1634 Validation: pkgckFile,
1635 })
Colin Cross7707b242024-07-26 12:02:36 -07001636 outputFile = packageCheckOutputFile
Paul Duffin08a18bf2021-10-01 13:19:58 +01001637
1638 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001639 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001640
1641 if ctx.Failed() {
1642 return
1643 }
1644 }
1645
1646 j.implementationJarFile = outputFile
1647 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001648 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1649 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1650 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1651 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1652 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1653 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1654 j.headerJarFile = headerJarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001655 }
1656
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001657 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1658 specs := j.jacocoModuleToZipCommand(ctx)
1659 if ctx.Failed() {
1660 return
1661 }
1662
Jaewoong Jung26342642021-03-17 15:56:23 -07001663 if j.shouldInstrument(ctx) {
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001664 outputFile = j.instrument(ctx, flags, outputFile, jarName, specs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001665 }
1666
1667 // merge implementation jar with resources if necessary
1668 implementationAndResourcesJar := outputFile
1669 if j.resourceJar != nil {
1670 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Colin Cross7707b242024-07-26 12:02:36 -07001671 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001672 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
1673 false, nil, nil)
1674 implementationAndResourcesJar = combinedJar
1675 }
1676
1677 j.implementationAndResourcesJar = implementationAndResourcesJar
1678
1679 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001680 compileDex := j.dexProperties.Compile_dex
Colin Crossff694a82023-12-13 15:54:49 -08001681 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -07001682 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001683 if compileDex == nil {
1684 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001685 }
1686 if j.deviceProperties.Hostdex == nil {
1687 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1688 }
1689 }
1690
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001691 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001692 if j.hasCode(ctx) {
1693 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001694 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001695 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1696 }
1697 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001698 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001699 params := &compileDexParams{
1700 flags: flags,
1701 sdkVersion: j.SdkVersion(ctx),
1702 minSdkVersion: j.MinSdkVersion(ctx),
1703 classesJar: implementationAndResourcesJar,
1704 jarName: jarName,
1705 }
Spandan Das15a67112024-05-30 00:07:40 +00001706 if j.GetProfileGuided() && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting() {
1707 ctx.PropertyErrorf("enable_profile_rewriting",
1708 "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.",
1709 )
1710 }
Spandan Das3dbda182024-05-20 22:23:10 +00001711 if j.EnableProfileRewriting() {
1712 profile := j.GetProfile()
1713 if profile == "" || !j.GetProfileGuided() {
1714 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1715 }
1716 params.artProfileInput = &profile
1717 }
1718 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001719 if ctx.Failed() {
1720 return
1721 }
1722
Spandan Das3dbda182024-05-20 22:23:10 +00001723 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1724 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001725 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001726 }
1727
Jaewoong Jung26342642021-03-17 15:56:23 -07001728 // merge dex jar with resources if necessary
1729 if j.resourceJar != nil {
1730 jars := android.Paths{dexOutputFile, j.resourceJar}
Colin Cross7707b242024-07-26 12:02:36 -07001731 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001732 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1733 false, nil, nil)
1734 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001735 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001736 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001737 dexOutputFile = combinedAlignedJar
1738 } else {
1739 dexOutputFile = combinedJar
1740 }
1741 }
1742
Paul Duffin4de94502021-05-16 05:21:16 +01001743 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001744
1745 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001746
1747 // Encode hidden API flags in dex file, if needed.
1748 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1749
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001750 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001751
1752 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001753 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1754 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1755 libName = strings.TrimSuffix(libName, ".impl")
1756 }
1757 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001758
1759 outputFile = dexOutputFile
1760 } else {
1761 // There is no code to compile into a dex jar, make sure the resources are propagated
1762 // to the APK if this is an app.
1763 outputFile = implementationAndResourcesJar
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001764 j.dexJarFile = makeDexJarPathFromPath(j.resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001765 }
1766
1767 if ctx.Failed() {
1768 return
1769 }
1770 } else {
1771 outputFile = implementationAndResourcesJar
1772 }
1773
1774 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001775 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001776 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001777 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001778 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001779 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001780 }
1781 }
1782
1783 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001784 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1785 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001786 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1787 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001788 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001789 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001790 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001791 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001792 j.linter.javaLanguageLevel = flags.javaVersion.String()
1793 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001794 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001795 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1796 j.linter.buildModuleReportZip = true
1797 }
1798 j.linter.lint(ctx)
1799 }
1800
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001801 j.collectTransitiveSrcFiles(ctx, srcFiles)
1802
Jaewoong Jung26342642021-03-17 15:56:23 -07001803 ctx.CheckbuildFile(outputFile)
1804
Colin Cross7727c7f2024-07-18 15:36:32 -07001805 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001806 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1807 RepackagedHeaderJars: android.PathsIfNonNil(j.repackagedHeaderJarFile),
1808 TransitiveLibsHeaderJars: j.transitiveLibsHeaderJars,
1809 TransitiveStaticLibsHeaderJars: j.transitiveStaticLibsHeaderJars,
1810 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1811 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
1812 ResourceJars: android.PathsIfNonNil(j.resourceJar),
1813 AidlIncludeDirs: j.exportAidlIncludeDirs,
1814 SrcJarArgs: j.srcJarArgs,
1815 SrcJarDeps: j.srcJarDeps,
1816 TransitiveSrcFiles: j.transitiveSrcFiles,
1817 ExportedPlugins: j.exportedPluginJars,
1818 ExportedPluginClasses: j.exportedPluginClasses,
1819 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1820 JacocoReportClassesFile: j.jacocoReportClassesFile,
1821 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001822 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001823 })
1824
1825 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1826 j.outputFile = outputFile.WithoutRel()
1827}
1828
Colin Crossa1ff7c62021-09-17 14:11:52 -07001829func (j *Module) useCompose() bool {
1830 return android.InList("androidx.compose.runtime_runtime", j.properties.Static_libs)
1831}
1832
Colin Crosscde55342024-03-27 14:11:51 -07001833func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []*android.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001834 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001835 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001836 depTag := ctx.OtherModuleDependencyTag(m)
1837
1838 if depProguardInfo.UnconditionallyExportedProguardFlags != nil {
1839 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1840 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1841 }
1842
1843 if depTag == staticLibTag && depProguardInfo.ProguardFlagsFiles != nil {
1844 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1845 }
1846 })
1847
Colin Crosscde55342024-03-27 14:11:51 -07001848 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1849}
1850
1851func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1852 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1853
Sam Delmerico95d70942023-08-02 18:00:35 -04001854 directUnconditionalExportedFlags := android.Paths{}
1855 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1856 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1857 if exportUnconditionally {
1858 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1859 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1860 directUnconditionalExportedFlags = proguardFlagsForThisModule
1861 }
1862
1863 return ProguardSpecInfo{
1864 Export_proguard_flags_files: exportUnconditionally,
1865 ProguardFlagsFiles: android.NewDepSet[android.Path](
1866 android.POSTORDER,
1867 proguardFlagsForThisModule,
1868 transitiveProguardFlags,
1869 ),
1870 UnconditionallyExportedProguardFlags: android.NewDepSet[android.Path](
1871 android.POSTORDER,
1872 directUnconditionalExportedFlags,
1873 transitiveUnconditionalExportedFlags,
1874 ),
1875 }
1876
1877}
1878
Cole Faust75fffb12021-06-13 15:23:16 -07001879// Returns a copy of the supplied flags, but with all the errorprone-related
1880// fields copied to the regular build's fields.
1881func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1882 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1883
1884 if len(flags.errorProneExtraJavacFlags) > 0 {
1885 if len(flags.javacFlags) > 0 {
1886 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
1887 } else {
1888 flags.javacFlags = flags.errorProneExtraJavacFlags
1889 }
1890 }
1891 return flags
1892}
1893
Jaewoong Jung26342642021-03-17 15:56:23 -07001894func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07001895 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07001896
1897 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00001898 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001899 if idx >= 0 {
1900 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00001901 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001902 jarName += strconv.Itoa(idx)
1903 }
1904
Colin Cross7707b242024-07-26 12:02:36 -07001905 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001906 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001907
Cole Faust9decf832024-06-11 11:45:53 -07001908 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001909 extractionFile := android.PathForModuleOut(ctx, kzipName)
1910 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1911 j.kytheFiles = append(j.kytheFiles, extractionFile)
1912 }
1913
Vadim Spivak3c496f02023-06-08 06:14:59 +00001914 if len(flags.processorPath) > 0 {
1915 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
1916 }
1917
Jaewoong Jung26342642021-03-17 15:56:23 -07001918 return classes
1919}
1920
1921// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1922// since some of these flags may be used internally.
1923func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1924 for _, flag := range flags {
1925 flag = strings.TrimSpace(flag)
1926
1927 if !strings.HasPrefix(flag, "-") {
1928 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1929 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1930 ctx.PropertyErrorf("kotlincflags",
1931 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1932 } else if inList(flag, config.KotlincIllegalFlags) {
1933 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1934 } else if flag == "-include-runtime" {
1935 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1936 } else {
1937 args := strings.Split(flag, " ")
1938 if args[0] == "-kotlin-home" {
1939 ctx.PropertyErrorf("kotlincflags",
1940 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1941 }
1942 }
1943 }
1944}
1945
1946func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
1947 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossedec77c2024-07-26 15:25:40 -07001948 extraJars android.Paths) (headerJar android.Path, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001949
1950 var jars android.Paths
1951 if len(srcFiles) > 0 || len(srcJars) > 0 {
1952 // Compile java sources into turbine.jar.
1953 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1954 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001955 jars = append(jars, turbineJar)
Colin Cross3d56ed52021-11-18 22:23:12 -08001956 headerJar = turbineJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001957 }
1958
1959 jars = append(jars, extraJars...)
1960
1961 // Combine any static header libraries into classes-header.jar. If there is only
1962 // one input jar this step will be skipped.
1963 jars = append(jars, deps.staticHeaderJars...)
1964
1965 // we cannot skip the combine step for now if there is only one jar
1966 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07001967 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
1968 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001969 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07001970
Colin Crossedec77c2024-07-26 15:25:40 -07001971 return headerJar, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07001972}
1973
1974func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07001975 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07001976
1977 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07001978 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001979
1980 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1981
1982 j.jacocoReportClassesFile = jacocoReportClassesFile
1983
1984 return instrumentedJar
1985}
1986
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001987type providesTransitiveHeaderJars struct {
1988 // set of header jars for all transitive libs deps
Colin Crossc85750b2022-04-21 12:50:51 -07001989 transitiveLibsHeaderJars *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001990 // set of header jars for all transitive static libs deps
Colin Crossc85750b2022-04-21 12:50:51 -07001991 transitiveStaticLibsHeaderJars *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001992}
1993
Colin Crossc85750b2022-04-21 12:50:51 -07001994func (j *providesTransitiveHeaderJars) TransitiveLibsHeaderJars() *android.DepSet[android.Path] {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001995 return j.transitiveLibsHeaderJars
1996}
1997
Colin Crossc85750b2022-04-21 12:50:51 -07001998func (j *providesTransitiveHeaderJars) TransitiveStaticLibsHeaderJars() *android.DepSet[android.Path] {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001999 return j.transitiveStaticLibsHeaderJars
2000}
2001
2002func (j *providesTransitiveHeaderJars) collectTransitiveHeaderJars(ctx android.ModuleContext) {
2003 directLibs := android.Paths{}
2004 directStaticLibs := android.Paths{}
Colin Crossc85750b2022-04-21 12:50:51 -07002005 transitiveLibs := []*android.DepSet[android.Path]{}
2006 transitiveStaticLibs := []*android.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002007 ctx.VisitDirectDeps(func(module android.Module) {
2008 // don't add deps of the prebuilt version of the same library
2009 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
2010 return
2011 }
2012
Colin Cross7727c7f2024-07-18 15:36:32 -07002013 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2014 tag := ctx.OtherModuleDependencyTag(module)
2015 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2016 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2017 directLibs = append(directLibs, dep.HeaderJars...)
2018 } else if tag == staticLibTag {
2019 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2020 } else {
2021 // Don't propagate transitive libs for other kinds of dependencies.
2022 return
2023 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002024
Colin Cross7727c7f2024-07-18 15:36:32 -07002025 if dep.TransitiveLibsHeaderJars != nil {
2026 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJars)
2027 }
2028 if dep.TransitiveStaticLibsHeaderJars != nil {
2029 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJars)
2030 }
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002031 }
2032 })
2033 j.transitiveLibsHeaderJars = android.NewDepSet(android.POSTORDER, directLibs, transitiveLibs)
2034 j.transitiveStaticLibsHeaderJars = android.NewDepSet(android.POSTORDER, directStaticLibs, transitiveStaticLibs)
2035}
2036
Jaewoong Jung26342642021-03-17 15:56:23 -07002037func (j *Module) HeaderJars() android.Paths {
2038 if j.headerJarFile == nil {
2039 return nil
2040 }
2041 return android.Paths{j.headerJarFile}
2042}
2043
2044func (j *Module) ImplementationJars() android.Paths {
2045 if j.implementationJarFile == nil {
2046 return nil
2047 }
2048 return android.Paths{j.implementationJarFile}
2049}
2050
Spandan Das59a4a2b2024-01-09 21:35:56 +00002051func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002052 return j.dexJarFile
2053}
2054
2055func (j *Module) DexJarInstallPath() android.Path {
2056 return j.installFile
2057}
2058
2059func (j *Module) ImplementationAndResourcesJars() android.Paths {
2060 if j.implementationAndResourcesJar == nil {
2061 return nil
2062 }
2063 return android.Paths{j.implementationAndResourcesJar}
2064}
2065
2066func (j *Module) AidlIncludeDirs() android.Paths {
2067 // exportAidlIncludeDirs is type android.Paths already
2068 return j.exportAidlIncludeDirs
2069}
2070
2071func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2072 return j.classLoaderContexts
2073}
2074
2075// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002076func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002077 // jarjar rules will repackage the sources. To prevent misleading results, IdeInfo should contain the
2078 // repackaged jar instead of the input sources.
Jaewoong Jung26342642021-03-17 15:56:23 -07002079 if j.expandJarjarRules != nil {
2080 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002081 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
2082 } else {
2083 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2084 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2085 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002086 }
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002087 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2088 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Yikef6282022022-04-13 20:41:01 +08002089 dpInfo.Static_libs = append(dpInfo.Static_libs, j.properties.Static_libs...)
2090 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002091}
2092
2093func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002094 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002095}
2096
2097func (j *Module) hasCode(ctx android.ModuleContext) bool {
2098 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2099 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2100}
2101
2102// Implements android.ApexModule
2103func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2104 return j.depIsInSameApex(ctx, dep)
2105}
2106
2107// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002108func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002109 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002110 minSdkVersion := j.MinSdkVersion(ctx)
2111 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002112 return fmt.Errorf("min_sdk_version is not specified")
2113 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002114 // If the module is compiling against core (via sdk_version), skip comparison check.
2115 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002116 return nil
2117 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002118 if minSdkVersion.GreaterThan(sdkVersion) {
2119 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002120 }
2121 return nil
2122}
2123
2124func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002125 if j.stem == "" {
2126 panic("Stem() called before stem property was set")
2127 }
2128 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002129}
2130
Jaewoong Jung26342642021-03-17 15:56:23 -07002131func (j *Module) JacocoReportClassesFile() android.Path {
2132 return j.jacocoReportClassesFile
2133}
2134
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002135func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
2136 var fromDeps []*android.DepSet[android.Path]
2137 ctx.VisitDirectDeps(func(module android.Module) {
2138 tag := ctx.OtherModuleDependencyTag(module)
2139 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002140 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2141 if depInfo.TransitiveSrcFiles != nil {
2142 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
2143 }
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002144 }
2145 }
2146 })
2147
2148 j.transitiveSrcFiles = android.NewDepSet(android.POSTORDER, mine, fromDeps)
2149}
2150
Jaewoong Jung26342642021-03-17 15:56:23 -07002151func (j *Module) IsInstallable() bool {
2152 return Bool(j.properties.Installable)
2153}
2154
2155type sdkLinkType int
2156
2157const (
2158 // TODO(jiyong) rename these for better readability. Make the allowed
2159 // and disallowed link types explicit
2160 // order is important here. See rank()
2161 javaCore sdkLinkType = iota
2162 javaSdk
2163 javaSystem
2164 javaModule
2165 javaSystemServer
2166 javaPlatform
2167)
2168
2169func (lt sdkLinkType) String() string {
2170 switch lt {
2171 case javaCore:
2172 return "core Java API"
2173 case javaSdk:
2174 return "Android API"
2175 case javaSystem:
2176 return "system API"
2177 case javaModule:
2178 return "module API"
2179 case javaSystemServer:
2180 return "system server API"
2181 case javaPlatform:
2182 return "private API"
2183 default:
2184 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2185 }
2186}
2187
2188// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2189// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2190// can't statically depend on modules that use Platform API.
2191func (lt sdkLinkType) rank() int {
2192 return int(lt)
2193}
2194
2195type moduleWithSdkDep interface {
2196 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002197 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002198}
2199
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002200func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2201 switch k {
2202 case android.SdkCore:
2203 return javaCore
2204 case android.SdkSystem:
2205 return javaSystem
2206 case android.SdkPublic:
2207 return javaSdk
2208 case android.SdkModule:
2209 return javaModule
2210 case android.SdkSystemServer:
2211 return javaSystemServer
2212 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2213 return javaPlatform
2214 default:
2215 return javaSdk
2216 }
2217}
2218
Jiyong Park92315372021-04-02 08:45:46 +09002219func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002220 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002221 case android.SdkCore.DefaultJavaLibraryName(),
2222 "legacy.core.platform.api.stubs",
2223 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002224 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002225 "core-lambda-stubs",
Jihoon Kangb5078312023-03-29 23:25:49 +00002226 "core-generated-annotation-stubs":
Jaewoong Jung26342642021-03-17 15:56:23 -07002227 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002228 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002229 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002230 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002231 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002232 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002233 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002234 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002235 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002236 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002237 return javaSystem, true
2238 }
2239
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002240 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002241 return linkType, true
2242 }
2243
Jiyong Park92315372021-04-02 08:45:46 +09002244 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002245 if !ver.Valid() {
2246 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002247 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002248
2249 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002250}
2251
2252// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2253// this module's. See the comment on rank() for details and an example.
2254func (j *Module) checkSdkLinkType(
2255 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2256 if ctx.Host() {
2257 return
2258 }
2259
Jiyong Park92315372021-04-02 08:45:46 +09002260 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002261 if stubs {
2262 return
2263 }
Jiyong Park92315372021-04-02 08:45:46 +09002264 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002265
2266 if myLinkType.rank() < depLinkType.rank() {
2267 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2268 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2269 "property of the source or target module so that target module is built "+
2270 "with the same or smaller API set when compared to the source.",
2271 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2272 }
2273}
2274
2275func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2276 var deps deps
2277
2278 if ctx.Device() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09002279 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07002280 if sdkDep.invalidVersion {
2281 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2282 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2283 } else if sdkDep.useFiles {
2284 // sdkDep.jar is actually equivalent to turbine header.jar.
2285 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002286 deps.dexClasspath = append(deps.dexClasspath, sdkDep.jars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002287 deps.aidlPreprocess = sdkDep.aidl
Spandan Das6e8bd1c2024-08-09 00:07:03 +00002288 // Add the sdk module dependency to `compileDepNames`.
2289 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2290 // TODO (b/358608607): Move this to decodeSdkDep
2291 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2292 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
Jaewoong Jung26342642021-03-17 15:56:23 -07002293 } else {
2294 deps.aidlPreprocess = sdkDep.aidl
2295 }
2296 }
2297
Jiyong Park92315372021-04-02 08:45:46 +09002298 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002299
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002300 j.collectTransitiveHeaderJars(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07002301 ctx.VisitDirectDeps(func(module android.Module) {
2302 otherName := ctx.OtherModuleName(module)
2303 tag := ctx.OtherModuleDependencyTag(module)
2304
2305 if IsJniDepTag(tag) {
2306 // Handled by AndroidApp.collectAppDeps
2307 return
2308 }
2309 if tag == certificateTag {
2310 // Handled by AndroidApp.collectAppDeps
2311 return
2312 }
2313
2314 if dep, ok := module.(SdkLibraryDependency); ok {
2315 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002316 case sdkLibTag, libTag:
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002317 depHeaderJars := dep.SdkHeaderJars(ctx, j.SdkVersion(ctx))
2318 deps.classpath = append(deps.classpath, depHeaderJars...)
2319 deps.dexClasspath = append(deps.dexClasspath, depHeaderJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002320 case staticLibTag:
2321 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
2322 }
Colin Cross313aa542023-12-13 13:47:44 -08002323 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2324 if sdkLinkType != javaPlatform {
2325 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2326 // dep is a sysprop implementation library, but this module is not linking against
2327 // the platform, so it gets the sysprop public stubs library instead. Replace
2328 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2329 dep = syspropDep.JavaInfo
2330 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002331 }
2332 switch tag {
2333 case bootClasspathTag:
2334 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002335 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002336 if _, ok := module.(*Plugin); ok {
2337 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2338 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002339 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002340 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002341 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2342 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2343 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2344 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002345 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2346 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2347 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
2348 case java9LibTag:
2349 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
2350 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002351 if _, ok := module.(*Plugin); ok {
2352 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2353 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002354 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2355 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2356 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2357 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2358 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2359 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2360 // Turbine doesn't run annotation processors, so any module that uses an
2361 // annotation processor that generates API is incompatible with the turbine
2362 // optimization.
2363 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002364 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002365 case pluginTag:
2366 if plugin, ok := module.(*Plugin); ok {
2367 if plugin.pluginProperties.Processor_class != nil {
2368 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2369 } else {
2370 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2371 }
2372 // Turbine doesn't run annotation processors, so any module that uses an
2373 // annotation processor that generates API is incompatible with the turbine
2374 // optimization.
2375 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2376 } else {
2377 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2378 }
2379 case errorpronePluginTag:
2380 if _, ok := module.(*Plugin); ok {
2381 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2382 } else {
2383 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2384 }
2385 case exportedPluginTag:
2386 if plugin, ok := module.(*Plugin); ok {
2387 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2388 if plugin.pluginProperties.Processor_class != nil {
2389 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2390 }
2391 // Turbine doesn't run annotation processors, so any module that uses an
2392 // annotation processor that generates API is incompatible with the turbine
2393 // optimization.
2394 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2395 } else {
2396 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2397 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002398 case kotlinPluginTag:
2399 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002400 case syspropPublicStubDepTag:
2401 // This is a sysprop implementation library, forward the JavaInfoProvider from
2402 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002403 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002404 JavaInfo: dep,
2405 })
2406 }
2407 } else if dep, ok := module.(android.SourceFileProducer); ok {
2408 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002409 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002410 checkProducesJars(ctx, dep)
2411 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002412 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002413 case staticLibTag:
2414 checkProducesJars(ctx, dep)
2415 deps.classpath = append(deps.classpath, dep.Srcs()...)
2416 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2417 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
2418 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002419 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002420 switch tag {
2421 case staticLibTag:
2422 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2423 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002424 } else {
2425 switch tag {
2426 case bootClasspathTag:
2427 // If a system modules dependency has been added to the bootclasspath
2428 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002429 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2430 depHeaderJars := sm.HeaderJars
2431 deps.bootClasspath = append(deps.bootClasspath, depHeaderJars...)
2432 } else {
2433 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2434 ctx.OtherModuleName(module))
2435 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002436
2437 case systemModulesTag:
2438 if deps.systemModules != nil {
2439 panic("Found two system module dependencies")
2440 }
Colin Crossb61c2262024-08-08 14:04:42 -07002441 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2442 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2443 } else {
2444 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2445 ctx.OtherModuleName(module))
2446 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002447
2448 case instrumentationForTag:
2449 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 -07002450 }
2451 }
2452
Spandan Das8aac9932024-07-18 23:14:13 +00002453 if android.InList(tag, compileDependencyTags) {
2454 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2455 j.compileDepNames = append(j.compileDepNames, otherName)
2456 }
2457
Jaewoong Jung26342642021-03-17 15:56:23 -07002458 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002459 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002460 })
2461
2462 return deps
2463}
2464
Joe Onorato349ae8d2024-02-05 22:46:00 +00002465// Provider for jarjar renaming rules.
2466//
2467// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2468// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2469// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2470// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2471// be renamed from that module.
2472// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002473type DependencyUse int
2474
2475const (
2476 RenameUseInvalid DependencyUse = iota
2477 RenameUseInclude
2478 RenameUseExclude
2479)
2480
2481type RenameUseElement struct {
2482 DepName string
2483 RenameUse DependencyUse
2484 Why string // token for determining where in the logic the decision was made.
2485}
2486
Joe Onorato349ae8d2024-02-05 22:46:00 +00002487type JarJarProviderData struct {
2488 // Mapping of class names: original --> renamed. If the value is "", the class will be
2489 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2490 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002491 Rename map[string]string
2492 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002493}
2494
2495func (this JarJarProviderData) GetDebugString() string {
2496 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002497 for _, k := range android.SortedKeys(this.Rename) {
2498 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002499 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2500 result += k + "--&gt;" + v + ";"
2501 }
2502 }
2503 return result
2504}
2505
2506var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2507
2508var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2509
2510func init() {
2511 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
2512}
2513
2514// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2515// whether they are java modules or not.
2516type BaseJarJarProviderData struct {
2517 JarJarProviderData JarJarProviderData
2518}
2519
2520func (this BaseJarJarProviderData) GetDebugString() string {
2521 return this.JarJarProviderData.GetDebugString()
2522}
2523
2524var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2525
2526// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2527// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2528// either JarJarProvider or BaseJarJarProvider.
2529func mergeJarJarPrefixes(ctx android.ModuleContext) {
2530 mod := ctx.Module()
2531 // Explicitly avoid propagating into some module types.
2532 switch reflect.TypeOf(mod).String() {
2533 case "*java.Droidstubs":
2534 return
2535 }
2536 jarJarData := collectDirectDepsProviders(ctx)
2537 if jarJarData != nil {
2538 providerData := BaseJarJarProviderData{
2539 JarJarProviderData: *jarJarData,
2540 }
2541 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2542 }
2543
2544}
2545
2546// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2547func (module *Module) addJarJarRenameRule(original string, renamed string) {
2548 if module.jarjarRenameRules == nil {
2549 module.jarjarRenameRules = make(map[string]string)
2550 }
2551 module.jarjarRenameRules[original] = renamed
2552}
2553
2554func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2555 // Gather repackage information from deps
2556 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002557
2558 module := ctx.Module()
2559 moduleName := module.Name()
2560
Joe Onorato349ae8d2024-02-05 22:46:00 +00002561 ctx.VisitDirectDepsIgnoreBlueprint(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002562 tag := ctx.OtherModuleDependencyTag(m)
2563 // This logic mirrors that in (*Module).collectDeps above. There are several places
2564 // where we explicitly return RenameUseExclude, even though it is the default, to
2565 // indicate that it has been verified to be the case.
2566 //
2567 // Note well: there are probably cases that are getting to the unconditional return
2568 // and are therefore wrong.
2569 shouldIncludeRenames := func() (DependencyUse, string) {
2570 if moduleName == m.Name() {
2571 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2572 }
2573 if sc, ok := module.(android.SdkContext); ok {
2574 if ctx.Device() {
2575 sdkDep := decodeSdkDep(ctx, sc)
2576 if !sdkDep.invalidVersion && sdkDep.useFiles {
2577 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002578 }
2579 }
LaMont Jones63683e42024-02-08 14:30:45 -08002580 }
2581 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2582 return RenameUseExclude, "tags"
2583 }
2584 if _, ok := m.(SdkLibraryDependency); ok {
2585 switch tag {
2586 case sdkLibTag, libTag:
2587 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2588 }
2589 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2590 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2591 switch ji.StubsLinkType {
2592 case Stubs:
2593 return RenameUseExclude, "info"
2594 case Implementation:
2595 return RenameUseInclude, "info"
2596 default:
LaMont Jones09721862024-06-11 10:30:50 -07002597 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002598 // Fall through to the heuristic logic.
2599 }
2600 switch reflect.TypeOf(m).String() {
2601 case "*java.GeneratedJavaLibraryModule":
2602 // Probably a java_aconfig_library module.
2603 // TODO: make this check better.
2604 return RenameUseInclude, "reflect"
2605 }
2606 switch tag {
2607 case bootClasspathTag:
2608 return RenameUseExclude, "tagswitch"
2609 case sdkLibTag, libTag, instrumentationForTag:
2610 return RenameUseInclude, "tagswitch"
2611 case java9LibTag:
2612 return RenameUseExclude, "tagswitch"
2613 case staticLibTag:
2614 return RenameUseInclude, "tagswitch"
2615 case pluginTag:
2616 return RenameUseInclude, "tagswitch"
2617 case errorpronePluginTag:
2618 return RenameUseInclude, "tagswitch"
2619 case exportedPluginTag:
2620 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002621 case kotlinPluginTag:
2622 return RenameUseInclude, "tagswitch"
2623 default:
2624 return RenameUseExclude, "tagswitch"
2625 }
2626 } else if _, ok := m.(android.SourceFileProducer); ok {
2627 switch tag {
2628 case sdkLibTag, libTag, staticLibTag:
2629 return RenameUseInclude, "srcfile"
2630 default:
2631 return RenameUseExclude, "srcfile"
2632 }
Yu Liu67a28422024-03-05 00:36:31 +00002633 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002634 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002635 } else {
2636 switch tag {
2637 case bootClasspathTag:
2638 return RenameUseExclude, "else"
2639 case systemModulesTag:
2640 return RenameUseInclude, "else"
2641 }
2642 }
2643 // If we got here, choose the safer option, which may lead to a build failure, rather
2644 // than runtime failures on the device.
2645 return RenameUseExclude, "end"
2646 }
2647
2648 if result == nil {
2649 result = &JarJarProviderData{
2650 Rename: make(map[string]string),
2651 RenameUse: make([]RenameUseElement, 0),
2652 }
2653 }
2654 how, why := shouldIncludeRenames()
2655 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2656 if how != RenameUseInclude {
2657 // Nothing to merge.
2658 return
2659 }
2660
2661 merge := func(theirs *JarJarProviderData) {
2662 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002663 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2664 result.Rename[orig] = renamed
2665 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2666 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2667 result.Rename[orig] = renamed
2668 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2669 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2670 continue
2671 }
2672 }
2673 }
2674 }
2675 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2676 merge(&theirs)
2677 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2678 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2679 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2680 // to java.Module.
2681 merge(&theirs.JarJarProviderData)
2682 }
2683 })
2684 return
2685}
2686
2687func (this Module) GetDebugString() string {
2688 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2689}
2690
2691// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2692// us, and if it's been set, apply the jarjar_prefix property to rename them.
2693func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2694 // Gather repackage information from deps
2695 result := collectDirectDepsProviders(ctx)
2696
Joe Onoratoa5d17172024-07-20 17:39:56 -07002697 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002698 if result == nil {
2699 result = &JarJarProviderData{
2700 Rename: make(map[string]string),
2701 }
2702 }
2703 if renamed != "" {
2704 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2705 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002706 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002707 }
2708 }
2709 (*result).Rename[orig] = renamed
2710 }
2711
Joe Onoratoa5d17172024-07-20 17:39:56 -07002712 // Update that with entries we've stored for ourself
2713 for orig, renamed := range module.jarjarRenameRules {
2714 add(orig, renamed)
2715 }
2716
2717 // Update that with entries given in the jarjar_rename property.
2718 for _, orig := range module.properties.Jarjar_rename {
2719 add(orig, "")
2720 }
2721
Joe Onorato349ae8d2024-02-05 22:46:00 +00002722 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2723 if result == nil {
2724 return nil
2725 }
2726
2727 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2728 // that have not yet been renamed.
2729 prefix := proptools.String(module.properties.Jarjar_prefix)
2730 if prefix != "" {
2731 if prefix[0] == '.' {
2732 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2733 return nil
2734 }
2735 if prefix[len(prefix)-1] == '.' {
2736 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2737 return nil
2738 }
2739
2740 var updated map[string]string
2741 for orig, renamed := range (*result).Rename {
2742 if renamed == "" {
2743 if updated == nil {
2744 updated = make(map[string]string)
2745 }
2746 updated[orig] = prefix + "." + orig
2747 }
2748 }
2749 for orig, renamed := range updated {
2750 (*result).Rename[orig] = renamed
2751 }
2752 }
2753
2754 return result
2755}
2756
2757// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2758// to "" won't be in this list because they shouldn't be renamed yet.
2759func getJarJarRuleText(provider *JarJarProviderData) string {
2760 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002761 for _, orig := range android.SortedKeys(provider.Rename) {
2762 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002763 if renamed != "" {
2764 result += "rule " + orig + " " + renamed + "\n"
2765 }
2766 }
2767 return result
2768}
2769
Zi Wangddb2ee52024-04-02 16:44:02 +00002770// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Cross7707b242024-07-26 12:02:36 -07002771func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) android.Path {
Zi Wangddb2ee52024-04-02 16:44:02 +00002772 if j.repackageJarjarRules == nil {
2773 return infile
2774 }
Colin Crossedec77c2024-07-26 15:25:40 -07002775 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002776 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
2777 return repackagedJarjarFile
2778}
2779
Colin Crossedec77c2024-07-26 15:25:40 -07002780func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) android.Path {
2781 if j.expandJarjarRules == nil {
2782 return infile
2783 }
2784 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2785 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
2786 return jarjarFile
2787
2788}
2789
Jaewoong Jung26342642021-03-17 15:56:23 -07002790func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2791 deps.processorPath = append(deps.processorPath, pluginJars...)
2792 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2793}
2794
2795// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2796// this interface.
2797type ProvidesUsesLib interface {
2798 ProvidesUsesLib() *string
2799}
2800
2801func (j *Module) ProvidesUsesLib() *string {
2802 return j.usesLibraryProperties.Provides_uses_lib
2803}
satayev1c564cc2021-05-25 19:50:30 +01002804
2805type ModuleWithStem interface {
2806 Stem() string
2807}
2808
2809var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002810
2811type ModuleWithUsesLibrary interface {
2812 UsesLibrary() *usesLibrary
2813}
2814
2815func (j *Module) UsesLibrary() *usesLibrary {
2816 return &j.usesLibrary
2817}
2818
2819var _ ModuleWithUsesLibrary = (*Module)(nil)