blob: cd5550a7c9ac5cdc7d5ca72d9fc3842a132a0982 [file] [log] [blame]
Jaewoong Jung26342642021-03-17 15:56:23 -07001// Copyright 2021 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package java
16
17import (
Yu Liu26a716d2024-08-30 23:40:32 +000018 "encoding/gob"
Jaewoong Jung26342642021-03-17 15:56:23 -070019 "fmt"
20 "path/filepath"
Joe Onorato349ae8d2024-02-05 22:46:00 +000021 "reflect"
22 "slices"
Jaewoong Jung26342642021-03-17 15:56:23 -070023 "strconv"
24 "strings"
25
Colin Crossd788b3e2023-11-28 13:14:56 -080026 "github.com/google/blueprint"
Colin Crossa14fb6a2024-10-23 16:57:06 -070027 "github.com/google/blueprint/depset"
Jaewoong Jung26342642021-03-17 15:56:23 -070028 "github.com/google/blueprint/pathtools"
29 "github.com/google/blueprint/proptools"
30
31 "android/soong/android"
32 "android/soong/dexpreopt"
33 "android/soong/java/config"
34)
35
36// This file contains the definition and the implementation of the base module that most
37// source-based Java module structs embed.
38
39// TODO:
40// Autogenerated files:
41// Renderscript
42// Post-jar passes:
43// Proguard
44// Rmtypedefs
45// DroidDoc
46// Findbugs
47
48// Properties that are common to most Java modules, i.e. whether it's a host or device module.
49type CommonProperties struct {
50 // list of source files used to compile the Java module. May be .java, .kt, .logtags, .proto,
51 // or .aidl files.
52 Srcs []string `android:"path,arch_variant"`
53
54 // list Kotlin of source files containing Kotlin code that should be treated as common code in
55 // a codebase that supports Kotlin multiplatform. See
56 // https://kotlinlang.org/docs/reference/multiplatform.html. May be only be .kt files.
57 Common_srcs []string `android:"path,arch_variant"`
58
59 // list of source files that should not be used to build the Java module.
60 // This is most useful in the arch/multilib variants to remove non-common files
61 Exclude_srcs []string `android:"path,arch_variant"`
62
Dave Mankoff0a3ef842024-10-02 18:47:24 +000063 // list of Kotlin source files that should excluded from the list of common_srcs.
64 Exclude_common_srcs []string `android:"path,arch_variant"`
65
Jaewoong Jung26342642021-03-17 15:56:23 -070066 // list of directories containing Java resources
67 Java_resource_dirs []string `android:"arch_variant"`
68
69 // list of directories that should be excluded from java_resource_dirs
70 Exclude_java_resource_dirs []string `android:"arch_variant"`
71
72 // list of files to use as Java resources
Cole Faust7fd5b2e2024-10-29 11:22:20 -070073 Java_resources proptools.Configurable[[]string] `android:"path,arch_variant"`
Jaewoong Jung26342642021-03-17 15:56:23 -070074
75 // list of files that should be excluded from java_resources and java_resource_dirs
76 Exclude_java_resources []string `android:"path,arch_variant"`
77
Cole Faust65cb40a2024-10-21 15:41:42 -070078 // Same as java_resources, but modules added here will use the device variant. Can be useful
79 // for making a host test that tests the contents of a device built app.
Cole Faust7fd5b2e2024-10-29 11:22:20 -070080 Device_common_java_resources proptools.Configurable[[]string] `android:"path_device_common"`
Cole Faust65cb40a2024-10-21 15:41:42 -070081
82 // Same as java_resources, but modules added here will use the device's os variant and the
83 // device's first architecture variant. Can be useful for making a host test that tests the
84 // contents of a native device built app.
Cole Faust7fd5b2e2024-10-29 11:22:20 -070085 Device_first_java_resources proptools.Configurable[[]string] `android:"path_device_first"`
Cole Faust65cb40a2024-10-21 15:41:42 -070086
Jaewoong Jung26342642021-03-17 15:56:23 -070087 // list of module-specific flags that will be used for javac compiles
88 Javacflags []string `android:"arch_variant"`
89
90 // list of module-specific flags that will be used for kotlinc compiles
91 Kotlincflags []string `android:"arch_variant"`
92
93 // list of java libraries that will be in the classpath
94 Libs []string `android:"arch_variant"`
95
96 // list of java libraries that will be compiled into the resulting jar
Cole Faustb7493472024-08-28 11:55:52 -070097 Static_libs proptools.Configurable[[]string] `android:"arch_variant"`
Jaewoong Jung26342642021-03-17 15:56:23 -070098
99 // manifest file to be included in resulting jar
100 Manifest *string `android:"path"`
101
102 // if not blank, run jarjar using the specified rules file
103 Jarjar_rules *string `android:"path,arch_variant"`
104
Joe Onoratoa5d17172024-07-20 17:39:56 -0700105 // java class names to rename with jarjar when a reverse dependency has a jarjar_prefix
106 // property.
107 Jarjar_rename []string
108
Joe Onorato349ae8d2024-02-05 22:46:00 +0000109 // if not blank, used as prefix to generate repackage rule
110 Jarjar_prefix *string
111
Jaewoong Jung26342642021-03-17 15:56:23 -0700112 // If not blank, set the java version passed to javac as -source and -target
113 Java_version *string
114
115 // If set to true, allow this module to be dexed and installed on devices. Has no
116 // effect on host modules, which are always considered installable.
117 Installable *bool
118
119 // If set to true, include sources used to compile the module in to the final jar
120 Include_srcs *bool
121
122 // If not empty, classes are restricted to the specified packages and their sub-packages.
123 // This restriction is checked after applying jarjar rules and including static libs.
124 Permitted_packages []string
125
126 // List of modules to use as annotation processors
127 Plugins []string
128
Luca Stefani50098f72024-10-12 17:55:31 +0200129 // List of modules to use as kotlin plugin
130 Kotlin_plugins []string
131
Jaewoong Jung26342642021-03-17 15:56:23 -0700132 // List of modules to export to libraries that directly depend on this library as annotation
133 // processors. Note that if the plugins set generates_api: true this will disable the turbine
134 // optimization on modules that depend on this module, which will reduce parallelism and cause
135 // more recompilation.
136 Exported_plugins []string
137
138 // The number of Java source entries each Javac instance can process
139 Javac_shard_size *int64
140
141 // Add host jdk tools.jar to bootclasspath
142 Use_tools_jar *bool
143
144 Openjdk9 struct {
145 // List of source files that should only be used when passing -source 1.9 or higher
146 Srcs []string `android:"path"`
147
148 // List of javac flags that should only be used when passing -source 1.9 or higher
149 Javacflags []string
150 }
151
152 // When compiling language level 9+ .java code in packages that are part of
153 // a system module, patch_module names the module that your sources and
154 // dependencies should be patched into. The Android runtime currently
155 // doesn't implement the JEP 261 module system so this option is only
156 // supported at compile time. It should only be needed to compile tests in
157 // packages that exist in libcore and which are inconvenient to move
158 // elsewhere.
Liz Kammer0a470a32023-10-05 17:02:00 -0400159 Patch_module *string
Jaewoong Jung26342642021-03-17 15:56:23 -0700160
161 Jacoco struct {
162 // List of classes to include for instrumentation with jacoco to collect coverage
163 // information at runtime when building with coverage enabled. If unset defaults to all
164 // classes.
165 // Supports '*' as the last character of an entry in the list as a wildcard match.
166 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
167 // it matches classes in the package that have the class name as a prefix.
168 Include_filter []string
169
170 // List of classes to exclude from instrumentation with jacoco to collect coverage
171 // information at runtime when building with coverage enabled. Overrides classes selected
172 // by the include_filter property.
173 // Supports '*' as the last character of an entry in the list as a wildcard match.
174 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
175 // it matches classes in the package that have the class name as a prefix.
176 Exclude_filter []string
177 }
178
179 Errorprone struct {
180 // List of javac flags that should only be used when running errorprone.
181 Javacflags []string
182
183 // List of java_plugin modules that provide extra errorprone checks.
184 Extra_check_modules []string
Cole Faust75fffb12021-06-13 15:23:16 -0700185
Cole Faust2b1536e2021-06-18 12:25:54 -0700186 // This property can be in 3 states. When set to true, errorprone will
187 // be run during the regular build. When set to false, errorprone will
188 // never be run. When unset, errorprone will be run when the RUN_ERROR_PRONE
189 // environment variable is true. Setting this to false will improve build
190 // performance more than adding -XepDisableAllChecks in javacflags.
Cole Faust75fffb12021-06-13 15:23:16 -0700191 Enabled *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700192 }
193
194 Proto struct {
195 // List of extra options that will be passed to the proto generator.
196 Output_params []string
197 }
198
Sam Delmericoc7593722022-08-31 15:57:52 -0400199 // If true, then jacocoagent is automatically added as a libs dependency so that
200 // r8 will not strip instrumentation classes out of dexed libraries.
Jaewoong Jung26342642021-03-17 15:56:23 -0700201 Instrument bool `blueprint:"mutated"`
Paul Duffin0038a8d2022-05-03 00:28:40 +0000202 // If true, then the module supports statically including the jacocoagent
203 // into the library.
204 Supports_static_instrumentation bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700205
206 // List of files to include in the META-INF/services folder of the resulting jar.
207 Services []string `android:"path,arch_variant"`
208
209 // If true, package the kotlin stdlib into the jar. Defaults to true.
210 Static_kotlin_stdlib *bool `android:"arch_variant"`
211
212 // A list of java_library instances that provide additional hiddenapi annotations for the library.
213 Hiddenapi_additional_annotations []string
Joe Onorato175073c2023-06-01 14:42:59 -0700214
215 // Additional srcJars tacked in by GeneratedJavaLibraryModule
216 Generated_srcjars []android.Path `android:"mutated"`
Mark Whitea15790a2023-08-22 21:28:11 +0000217
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000218 // intermediate aconfig cache file tacked in by GeneratedJavaLibraryModule
219 Aconfig_Cache_files []android.Path `android:"mutated"`
220
Mark Whitea15790a2023-08-22 21:28:11 +0000221 // If true, then only the headers are built and not the implementation jar.
Liz Kammer60772632023-10-05 17:18:44 -0400222 Headers_only *bool
Cole Faust2b64af82023-12-13 18:22:18 -0800223
224 // A list of files or dependencies to make available to the build sandbox. This is
225 // useful if source files are symlinks, the targets of the symlinks must be listed here.
226 // Note that currently not all actions implemented by android_apps are sandboxed, so you
227 // may only see this being necessary in lint builds.
228 Compile_data []string `android:"path"`
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000229
230 // Property signifying whether the module compiles stubs or not.
231 // Should be set to true when srcs of this module are stub files.
232 // This property does not need to be set to true when the module depends on
233 // the stubs via libs, but should be set to true when the module depends on
234 // the stubs via static libs.
235 Is_stubs_module *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700236
Makoto Onuki7ded3822024-03-28 14:42:20 -0700237 Ravenizer struct {
John Wu989ee842024-10-04 00:21:43 +0000238 // If true, enable the "Ravenizer" tool on the output jar.
239 // "Ravenizer" is a tool for Ravenwood tests, but it can also be enabled on other kinds
240 // of java targets.
Makoto Onuki7ded3822024-03-28 14:42:20 -0700241 Enabled *bool
John Wu989ee842024-10-04 00:21:43 +0000242
243 // If true, the "Ravenizer" tool will remove all Mockito and DexMaker
244 // classes from the output jar.
245 Strip_mockito *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700246 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +0000247
248 // Contributing api surface of the stub module. Is not visible to bp modules, and should
249 // only be set for stub submodules generated by the java_sdk_library
250 Stub_contributing_api *string `blueprint:"mutated"`
Yihan Dong8be09c22024-08-29 15:32:13 +0800251
252 // If true, enable the "ApiMapper" tool on the output jar. "ApiMapper" is a tool to inject
253 // bytecode to log API calls.
254 ApiMapper bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700255}
256
257// Properties that are specific to device modules. Host module factories should not add these when
258// constructing a new module.
259type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000260 // If not blank, set to the version of the sdk to compile against.
Spandan Das1ccf5742022-10-14 16:51:23 +0000261 // Defaults to an empty string, which compiles the module against the private platform APIs.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000262 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000263 // 1) numerical API level, "current", "none", or "core_platform"
264 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
265 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
266 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700267 Sdk_version *string
268
satayev0a420e72021-11-29 17:25:52 +0000269 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
270 // Defaults to empty string "". See sdk_version for possible values.
271 Max_sdk_version *string
272
William Loh5a082f92022-05-17 20:21:50 +0000273 // if not blank, set the maxSdkVersion properties of permission and uses-permission tags.
274 // Defaults to empty string "". See sdk_version for possible values.
275 Replace_max_sdk_version_placeholder *string
276
Jaewoong Jung26342642021-03-17 15:56:23 -0700277 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000278 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700279 Target_sdk_version *string
280
281 // Whether to compile against the platform APIs instead of an SDK.
282 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000283 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700284 Platform_apis *bool
285
286 Aidl struct {
287 // Top level directories to pass to aidl tool
288 Include_dirs []string
289
290 // Directories rooted at the Android.bp file to pass to aidl tool
291 Local_include_dirs []string
292
293 // directories that should be added as include directories for any aidl sources of modules
294 // that depend on this module, as well as to aidl for this module.
295 Export_include_dirs []string
296
297 // whether to generate traces (for systrace) for this interface
298 Generate_traces *bool
299
300 // whether to generate Binder#GetTransaction name method.
301 Generate_get_transaction_name *bool
302
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100303 // whether all interfaces should be annotated with required permissions.
304 Enforce_permissions *bool
305
306 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
307 Enforce_permissions_exceptions []string `android:"path"`
308
Jaewoong Jung26342642021-03-17 15:56:23 -0700309 // list of flags that will be passed to the AIDL compiler
310 Flags []string
311 }
312
313 // If true, export a copy of the module as a -hostdex module for host testing.
314 Hostdex *bool
315
316 Target struct {
317 Hostdex struct {
318 // Additional required dependencies to add to -hostdex modules.
319 Required []string
320 }
321 }
322
323 // When targeting 1.9 and above, override the modules to use with --system,
324 // otherwise provides defaults libraries to add to the bootclasspath.
325 System_modules *string
326
Jaewoong Jung26342642021-03-17 15:56:23 -0700327 IsSDKLibrary bool `blueprint:"mutated"`
328
329 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
330 // Defaults to false.
331 V4_signature *bool
332
333 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
334 // public stubs library.
335 SyspropPublicStub string `blueprint:"mutated"`
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000336
337 HiddenAPIPackageProperties
338 HiddenAPIFlagFileProperties
Jaewoong Jung26342642021-03-17 15:56:23 -0700339}
340
yangbill2af0b6e2024-03-15 09:29:29 +0000341// Properties that can be overridden by overriding module (e.g. override_android_app)
342type OverridableProperties struct {
Jooyung Han01d80d82022-01-08 12:16:32 +0900343 // set the name of the output. If not set, `name` is used.
344 // To override a module with this property set, overriding module might need to set this as well.
345 // Otherwise, both the overridden and the overriding modules will have the same output name, which
346 // can cause the duplicate output error.
347 Stem *string
Spandan Dasb9c58352024-05-13 18:29:45 +0000348
349 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
350 // Defaults to sdk_version if not set. See sdk_version for possible values.
351 Min_sdk_version *string
Jooyung Han01d80d82022-01-08 12:16:32 +0900352}
353
Jaewoong Jung26342642021-03-17 15:56:23 -0700354// Functionality common to Module and Import
355//
356// It is embedded in Module so its functionality can be used by methods in Module
357// but it is currently only initialized by Import and Library.
358type embeddableInModuleAndImport struct {
359
360 // Functionality related to this being used as a component of a java_sdk_library.
361 EmbeddableSdkLibraryComponent
362}
363
Paul Duffin71b33cc2021-06-23 11:39:47 +0100364func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
365 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700366}
367
Colin Crossf7bbd2f2024-12-05 13:57:10 -0800368// Module/Import's OutgoingDepIsInSameApex(...) delegates to this method.
Jaewoong Jung26342642021-03-17 15:56:23 -0700369//
Colin Crossf7bbd2f2024-12-05 13:57:10 -0800370// This cannot implement OutgoingDepIsInSameApex(...) directly as that leads to ambiguity with
Jaewoong Jung26342642021-03-17 15:56:23 -0700371// the one provided by ApexModuleBase.
Colin Crossf7bbd2f2024-12-05 13:57:10 -0800372func (e *embeddableInModuleAndImport) depIsInSameApex(tag blueprint.DependencyTag) bool {
Jaewoong Jung26342642021-03-17 15:56:23 -0700373 // dependencies other than the static linkage are all considered crossing APEX boundary
Colin Crossf7bbd2f2024-12-05 13:57:10 -0800374 if tag == staticLibTag {
Jaewoong Jung26342642021-03-17 15:56:23 -0700375 return true
376 }
377 return false
378}
379
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100380// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
381// or an invalid path describing the reason it is invalid.
382//
383// It is unset if a dex jar isn't applicable, i.e. no build rule has been
384// requested to create one.
385//
386// If a dex jar has been requested to be built then it is set, and it may be
387// either a valid android.Path, or invalid with a reason message. The latter
388// happens if the source that should produce the dex file isn't able to.
389//
390// E.g. it is invalid with a reason message if there is a prebuilt APEX that
391// could produce the dex jar through a deapexer module, but the APEX isn't
392// installable so doing so wouldn't be safe.
393type OptionalDexJarPath struct {
394 isSet bool
395 path android.OptionalPath
396}
397
398// IsSet returns true if a path has been set, either invalid or valid.
399func (o OptionalDexJarPath) IsSet() bool {
400 return o.isSet
401}
402
403// Valid returns true if there is a path that is valid.
404func (o OptionalDexJarPath) Valid() bool {
405 return o.isSet && o.path.Valid()
406}
407
408// Path returns the valid path, or panics if it's either not set or is invalid.
409func (o OptionalDexJarPath) Path() android.Path {
410 if !o.isSet {
411 panic("path isn't set")
412 }
413 return o.path.Path()
414}
415
416// PathOrNil returns the path if it's set and valid, or else nil.
417func (o OptionalDexJarPath) PathOrNil() android.Path {
418 if o.Valid() {
419 return o.Path()
420 }
421 return nil
422}
423
424// InvalidReason returns the reason for an invalid path, which is never "". It
425// returns "" for an unset or valid path.
426func (o OptionalDexJarPath) InvalidReason() string {
427 if !o.isSet {
428 return ""
429 }
430 return o.path.InvalidReason()
431}
432
433func (o OptionalDexJarPath) String() string {
434 if !o.isSet {
435 return "<unset>"
436 }
437 return o.path.String()
438}
439
440// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
441func makeUnsetDexJarPath() OptionalDexJarPath {
442 return OptionalDexJarPath{isSet: false}
443}
444
445// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
446// the given OptionalPath, which may be valid or invalid.
447func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
448 return OptionalDexJarPath{isSet: true, path: path}
449}
450
451// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
452// valid given path. It returns an unset OptionalDexJarPath if the given path is
453// nil.
454func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
455 if path == nil {
456 return makeUnsetDexJarPath()
457 }
458 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
459}
460
Jaewoong Jung26342642021-03-17 15:56:23 -0700461// Module contains the properties and members used by all java module types
462type Module struct {
463 android.ModuleBase
464 android.DefaultableModuleBase
465 android.ApexModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700466
467 // Functionality common to Module and Import.
468 embeddableInModuleAndImport
469
470 properties CommonProperties
471 protoProperties android.ProtoProperties
472 deviceProperties DeviceProperties
473
yangbill2af0b6e2024-03-15 09:29:29 +0000474 overridableProperties OverridableProperties
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700475 sourceProperties android.SourceProperties
Jooyung Han01d80d82022-01-08 12:16:32 +0900476
Jaewoong Jung26342642021-03-17 15:56:23 -0700477 // jar file containing header classes including static library dependencies, suitable for
478 // inserting into the bootclasspath/classpath of another compile
479 headerJarFile android.Path
480
481 // jar file containing implementation classes including static library dependencies but no
482 // resources
483 implementationJarFile android.Path
484
Jaewoong Jung26342642021-03-17 15:56:23 -0700485 // args and dependencies to package source files into a srcjar
486 srcJarArgs []string
487 srcJarDeps android.Paths
488
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000489 // the source files of this module and all its static dependencies
Colin Crossa14fb6a2024-10-23 16:57:06 -0700490 transitiveSrcFiles depset.DepSet[android.Path]
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000491
Jaewoong Jung26342642021-03-17 15:56:23 -0700492 // jar file containing implementation classes and resources including static library
493 // dependencies
494 implementationAndResourcesJar android.Path
495
496 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100497 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700498
499 // output file containing uninstrumented classes that will be instrumented by jacoco
500 jacocoReportClassesFile android.Path
501
502 // output file of the module, which may be a classes jar or a dex jar
503 outputFile android.Path
504 extraOutputFiles android.Paths
505
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100506 exportAidlIncludeDirs android.Paths
507 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700508
509 logtagsSrcs android.Paths
510
511 // installed file for binary dependency
512 installFile android.Path
513
Colin Cross3108ce12021-11-10 14:38:50 -0800514 // installed file for hostdex copy
515 hostdexInstallFile android.InstallPath
516
Chaohui Wangdcbe33c2022-10-11 11:13:30 +0800517 // list of unique .java and .kt source files
518 uniqueSrcFiles android.Paths
519
520 // list of srcjars that was passed to javac
521 compiledSrcJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700522
523 // manifest file to use instead of properties.Manifest
524 overrideManifest android.OptionalPath
525
Jaewoong Jung26342642021-03-17 15:56:23 -0700526 // list of plugins that this java module is exporting
527 exportedPluginJars android.Paths
528
529 // list of plugins that this java module is exporting
530 exportedPluginClasses []string
531
532 // if true, the exported plugins generate API and require disabling turbine.
533 exportedDisableTurbine bool
534
535 // list of source files, collected from srcFiles with unique java and all kt files,
536 // will be used by android.IDEInfo struct
537 expandIDEInfoCompiledSrcs []string
538
539 // expanded Jarjar_rules
540 expandJarjarRules android.Path
541
Joe Onorato349ae8d2024-02-05 22:46:00 +0000542 // jarjar rule for inherited jarjar rules
543 repackageJarjarRules android.Path
544
Jaewoong Jung26342642021-03-17 15:56:23 -0700545 // Extra files generated by the module type to be added as java resources.
546 extraResources android.Paths
547
548 hiddenAPI
549 dexer
550 dexpreopter
551 usesLibrary
552 linter
553
554 // list of the xref extraction files
Spandan Das1028d5a2024-08-19 21:45:48 +0000555 kytheFiles android.Paths
556 kytheKotlinFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700557
Jaewoong Jung26342642021-03-17 15:56:23 -0700558 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900559
560 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000561 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000562 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400563
564 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000565
566 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000567
568 // output file name based on Stem property.
569 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
570 // or the module should override Stem().
571 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700572
Joe Onorato349ae8d2024-02-05 22:46:00 +0000573 // Values that will be set in the JarJarProvider data for jarjar repackaging,
574 // and merged with our dependencies' rules.
575 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000576
577 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000578
579 // Paths to the aconfig intermediate cache files that are provided by the
580 // java_aconfig_library or java_library modules that are statically linked
581 // to this module. Does not contain cache files from all transitive dependencies.
582 aconfigCacheFiles android.Paths
Spandan Das8aac9932024-07-18 23:14:13 +0000583
584 // List of soong module dependencies required to compile the current module.
585 // This information is printed out to `Dependencies` field in module_bp_java_deps.json
586 compileDepNames []string
Makoto Onuki7ded3822024-03-28 14:42:20 -0700587
588 ravenizer struct {
589 enabled bool
590 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700591}
592
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000593var _ android.InstallableModule = (*Module)(nil)
594
595// To satisfy the InstallableModule interface
Jihoon Kang224ea082024-08-12 22:38:16 +0000596func (j *Module) StaticDependencyTags() []blueprint.DependencyTag {
597 return []blueprint.DependencyTag{staticLibTag}
598}
599
600// To satisfy the InstallableModule interface
601func (j *Module) DynamicDependencyTags() []blueprint.DependencyTag {
602 return []blueprint.DependencyTag{libTag, sdkLibTag, bootClasspathTag, systemModulesTag,
603 instrumentationForTag, java9LibTag}
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000604}
605
606// Overrides android.ModuleBase.InstallInProduct()
607func (j *Module) InstallInProduct() bool {
608 return j.ProductSpecific()
609}
610
Jihoon Kang85bc1932024-07-01 17:04:46 +0000611var _ android.StubsAvailableModule = (*Module)(nil)
612
613// To safisfy the StubsAvailableModule interface
614func (j *Module) IsStubsModule() bool {
615 return proptools.Bool(j.properties.Is_stubs_module)
616}
617
Yu Liu63bdf632024-12-03 19:54:05 +0000618func CheckStableSdkVersion(ctx android.BaseModuleContext, module android.ModuleProxy) error {
619 if info, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
620 if info.SdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700621 return nil
622 }
Yu Liu63bdf632024-12-03 19:54:05 +0000623 if info.SdkVersion.Kind == android.SdkCorePlatform {
624 if useLegacyCorePlatformApi(ctx, android.OtherModuleProviderOrDefault(ctx, module, android.CommonModuleInfoKey).BaseModuleName) {
625 return fmt.Errorf("non stable SDK %v - uses legacy core platform", info.SdkVersion)
626 } else {
627 // Treat stable core platform as stable.
628 return nil
629 }
630 } else {
631 return fmt.Errorf("non stable SDK %v", info.SdkVersion)
632 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700633 }
Yu Liu63bdf632024-12-03 19:54:05 +0000634
635 return nil
Jaewoong Jung26342642021-03-17 15:56:23 -0700636}
637
638// checkSdkVersions enforces restrictions around SDK dependencies.
639func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
640 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900641 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900642 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700643 ctx.PropertyErrorf("sdk_version",
644 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
645 }
646 }
647 }
648
649 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
650 // See rank() for details.
651 ctx.VisitDirectDeps(func(module android.Module) {
652 tag := ctx.OtherModuleDependencyTag(module)
653 switch module.(type) {
654 // TODO(satayev): cover other types as well, e.g. imports
655 case *Library, *AndroidLibrary:
656 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400657 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700658 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
659 }
660 }
661 })
662}
663
664func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900665 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700666 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900667 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700668 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000669 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 -0700670 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000671 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 -0700672 }
673
674 }
675}
676
Mark Whitea15790a2023-08-22 21:28:11 +0000677func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
678 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400679 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000680 installable := proptools.Bool(j.properties.Installable)
681
682 if headersOnly && installable {
683 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.")
684 }
685 }
686}
687
Jaewoong Jung26342642021-03-17 15:56:23 -0700688func (j *Module) addHostProperties() {
689 j.AddProperties(
690 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000691 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700692 &j.protoProperties,
693 &j.usesLibraryProperties,
694 )
695}
696
697func (j *Module) addHostAndDeviceProperties() {
698 j.addHostProperties()
699 j.AddProperties(
700 &j.deviceProperties,
701 &j.dexer.dexProperties,
702 &j.dexpreoptProperties,
703 &j.linter.properties,
704 )
705}
706
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000707// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
708// makes it available through the hiddenAPIPropertyInfoProvider.
709func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
710 hiddenAPIInfo := newHiddenAPIPropertyInfo()
711
712 // Populate with flag file paths from the properties.
713 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
714
715 // Populate with package rules from the properties.
716 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
717
Colin Cross40213022023-12-13 15:19:49 -0800718 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000719}
720
mrziwang9f7b9f42024-07-10 12:18:06 -0700721// helper method for java modules to set OutputFilesProvider
722func setOutputFiles(ctx android.ModuleContext, m Module) {
Cole Faust5146e782024-11-15 14:47:49 -0800723 ctx.SetOutputFiles(append(android.PathsIfNonNil(m.outputFile), m.extraOutputFiles...), "")
724 ctx.SetOutputFiles(android.PathsIfNonNil(m.outputFile), android.DefaultDistTag)
725 ctx.SetOutputFiles(android.PathsIfNonNil(m.implementationAndResourcesJar), ".jar")
726 ctx.SetOutputFiles(android.PathsIfNonNil(m.headerJarFile), ".hjar")
mrziwang9f7b9f42024-07-10 12:18:06 -0700727 if m.dexer.proguardDictionary.Valid() {
728 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
729 }
730 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
Jaewoong Jung26342642021-03-17 15:56:23 -0700731}
732
Jaewoong Jung26342642021-03-17 15:56:23 -0700733func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
734 initJavaModule(module, hod, false)
735}
736
737func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
738 initJavaModule(module, hod, true)
739}
740
741func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
742 multilib := android.MultilibCommon
743 if multiTargets {
744 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
745 } else {
746 android.InitAndroidArchModule(module, hod, multilib)
747 }
748 android.InitDefaultableModule(module)
749}
750
751func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
752 return j.properties.Instrument &&
753 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
754 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
755}
756
Yihan Dong8be09c22024-08-29 15:32:13 +0800757func (j *Module) shouldApiMapper() bool {
758 return j.properties.ApiMapper
759}
760
Jaewoong Jung26342642021-03-17 15:56:23 -0700761func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000762 return j.properties.Supports_static_instrumentation &&
763 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700764 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
765 ctx.Config().UnbundledBuild())
766}
767
768func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
769 // Force enable the instrumentation for java code that is built for APEXes ...
770 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
771 // 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 -0800772 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700773 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000774
Colin Crosse4f34882024-11-14 12:26:00 -0800775 compileDex := Bool(j.dexProperties.Compile_dex) || Bool(j.properties.Installable)
776 if compileDex && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700777 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
778 return true
779 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
780 return true
781 }
782 }
783 return false
784}
785
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400786func (j *Module) setInstrument(value bool) {
787 j.properties.Instrument = value
788}
789
Yihan Dong8be09c22024-08-29 15:32:13 +0800790func (j *Module) setApiMapper(value bool) {
791 j.properties.ApiMapper = value
792}
793
Jiyong Park92315372021-04-02 08:45:46 +0900794func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
795 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700796}
797
Jiyong Parkf1691d22021-03-29 20:11:58 +0900798func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700799 return proptools.String(j.deviceProperties.System_modules)
800}
801
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000802func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000803 if j.overridableProperties.Min_sdk_version != nil {
804 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700805 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000806 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700807}
808
Yu Liuf2b94012023-09-19 15:09:10 -0700809func (j *Module) GetDeviceProperties() *DeviceProperties {
810 return &j.deviceProperties
811}
812
Spandan Dasa26eda72023-03-02 00:56:06 +0000813func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
814 if j.deviceProperties.Max_sdk_version != nil {
815 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
816 }
817 // Default is PrivateApiLevel
818 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000819}
820
Spandan Dasa26eda72023-03-02 00:56:06 +0000821func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
822 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
823 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
824 }
825 // Default is PrivateApiLevel
826 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000827}
828
Jiyong Parkf1691d22021-03-29 20:11:58 +0900829func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000830 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900831}
832
Spandan Dasca70fc42023-03-01 23:38:49 +0000833func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900834 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000835 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900836 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000837 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700838}
839
840func (j *Module) AvailableFor(what string) bool {
Yu Liub73c3a62024-12-10 00:58:06 +0000841 return android.CheckAvailableForApex(what, j.ApexAvailableFor())
842}
843
844func (j *Module) ApexAvailableFor() []string {
845 list := j.ApexModuleBase.ApexAvailable()
846 if Bool(j.deviceProperties.Hostdex) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700847 // Exception: for hostdex: true libraries, the platform variant is created
848 // even if it's not marked as available to platform. In that case, the platform
849 // variant is used only for the hostdex and not installed to the device.
Yu Liub73c3a62024-12-10 00:58:06 +0000850 list = append(list, android.AvailableToPlatform)
Jaewoong Jung26342642021-03-17 15:56:23 -0700851 }
Yu Liub73c3a62024-12-10 00:58:06 +0000852 return android.FirstUniqueStrings(list)
Jaewoong Jung26342642021-03-17 15:56:23 -0700853}
854
Cole Faustb7493472024-08-28 11:55:52 -0700855func (j *Module) staticLibs(ctx android.BaseModuleContext) []string {
Jihoon Kang8bce3812024-09-30 18:46:51 +0000856 return j.properties.Static_libs.GetOrDefault(ctx, nil)
Cole Faustb7493472024-08-28 11:55:52 -0700857}
858
Jaewoong Jung26342642021-03-17 15:56:23 -0700859func (j *Module) deps(ctx android.BottomUpMutatorContext) {
860 if ctx.Device() {
861 j.linter.deps(ctx)
862
Jiyong Parkf1691d22021-03-29 20:11:58 +0900863 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700864
865 if j.deviceProperties.SyspropPublicStub != "" {
866 // This is a sysprop implementation library that has a corresponding sysprop public
867 // stubs library, and a dependency on it so that dependencies on the implementation can
868 // be forwarded to the public stubs library when necessary.
869 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
870 }
871 }
872
873 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000874
Cole Faustb7493472024-08-28 11:55:52 -0700875 ctx.AddVariationDependencies(nil, staticLibTag, j.staticLibs(ctx)...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700876
877 // Add dependency on libraries that provide additional hidden api annotations.
878 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
879
Jaewoong Jung26342642021-03-17 15:56:23 -0700880 // 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) ||
Cole Faust64f2d842024-10-17 13:28:34 -0700890 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs.GetOrDefault(ctx, nil)) {
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...)
Luca Stefani50098f72024-10-12 17:55:31 +0200900 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag, j.properties.Kotlin_plugins...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700901 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
902 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
903
904 android.ProtoDeps(ctx, &j.protoProperties)
905 if j.hasSrcExt(".proto") {
906 protoDeps(ctx, &j.protoProperties)
907 }
908
909 if j.hasSrcExt(".kt") {
910 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
911 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700912 tag := staticLibTag
913 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
914 tag = libTag
915 }
916 ctx.AddVariationDependencies(nil, tag,
917 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700918 }
919
920 // Framework libraries need special handling in static coverage builds: they should not have
921 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
922 // the same jacoco classes coming from different bootclasspath jars.
923 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
924 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
925 j.properties.Instrument = true
926 }
927 } else if j.shouldInstrumentStatic(ctx) {
928 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
929 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700930
Cole Faustb7493472024-08-28 11:55:52 -0700931 if j.useCompose(ctx) {
Colin Crossa1ff7c62021-09-17 14:11:52 -0700932 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
Dave Mankoff0a3ef842024-10-02 18:47:24 +0000933 "kotlin-compose-compiler-plugin")
Colin Crossa1ff7c62021-09-17 14:11:52 -0700934 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700935}
936
937func hasSrcExt(srcs []string, ext string) bool {
938 for _, src := range srcs {
939 if filepath.Ext(src) == ext {
940 return true
941 }
942 }
943
944 return false
945}
946
947func (j *Module) hasSrcExt(ext string) bool {
948 return hasSrcExt(j.properties.Srcs, ext)
949}
950
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100951func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
952 var flags string
953
954 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
955 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
956 flags = "-Wmissing-permission-annotation -Werror"
957 }
958 }
959 return flags
960}
961
Jaewoong Jung26342642021-03-17 15:56:23 -0700962func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000963 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700964
965 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
966 aidlIncludes = append(aidlIncludes,
967 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
968 aidlIncludes = append(aidlIncludes,
969 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
970
971 var flags []string
972 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000973 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700974
975 flags = append(flags, j.deviceProperties.Aidl.Flags...)
976
977 if aidlPreprocess.Valid() {
978 flags = append(flags, "-p"+aidlPreprocess.String())
979 deps = append(deps, aidlPreprocess.Path())
980 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000981 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700982 }
983
984 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000985 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700986 }
987
988 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000989 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700990 }
991
Sam Delmerico2351eac2022-05-24 17:10:02 +0000992 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700993 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000994 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700995 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000996 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
997 // add flags for dirs containing AIDL srcs that haven't been specified yet
998 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -0700999
Zim8774ae12022-08-17 11:46:34 +01001000 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +00001001 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +01001002 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001003 flags = append(flags, "-t")
1004 }
1005
1006 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
1007 flags = append(flags, "--transaction_names")
1008 }
1009
Thiébaud Weksteende8417c2022-02-10 15:41:46 +11001010 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
1011 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
1012 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1013 }
1014
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001015 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001016 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1017
Jaewoong Jung26342642021-03-17 15:56:23 -07001018 return strings.Join(flags, " "), deps
1019}
1020
1021func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1022
1023 var flags javaBuilderFlags
1024
1025 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001026 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001027
Cole Faust2b1536e2021-06-18 12:25:54 -07001028 epEnabled := j.properties.Errorprone.Enabled
1029 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001030 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001031 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1032 }
1033
1034 errorProneFlags := []string{
1035 "-Xplugin:ErrorProne",
1036 "${config.ErrorProneChecks}",
1037 }
1038 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1039
Colin Cross8bf6cad2022-02-28 13:07:03 -08001040 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001041 "'" + strings.Join(errorProneFlags, " ") + "'"
1042 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1043 }
1044
1045 // classpath
1046 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1047 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001048 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001049 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1050 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1051 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1052
1053 flags.processors = append(flags.processors, deps.processorClasses...)
1054 flags.processors = android.FirstUniqueStrings(flags.processors)
1055
1056 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001057 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001058 // Give host-side tools a version of OpenJDK's standard libraries
1059 // close to what they're targeting. As of Dec 2017, AOSP is only
1060 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1061 //
1062 // When building with OpenJDK 8, the following should have no
1063 // effect since those jars would be available by default.
1064 //
1065 // When building with OpenJDK 9 but targeting a version < 1.8,
1066 // putting them on the bootclasspath means that:
1067 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1068 // b) references to existing APIs are not reinterpreted in an
1069 // OpenJDK 9-specific way, eg. calls to subclasses of
1070 // java.nio.Buffer as in http://b/70862583
1071 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1072 flags.bootClasspath = append(flags.bootClasspath,
1073 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1074 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1075 if Bool(j.properties.Use_tools_jar) {
1076 flags.bootClasspath = append(flags.bootClasspath,
1077 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1078 }
1079 }
1080
1081 // systemModules
1082 flags.systemModules = deps.systemModules
1083
Jaewoong Jung26342642021-03-17 15:56:23 -07001084 return flags
1085}
1086
1087func (j *Module) collectJavacFlags(
1088 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1089 // javac flags.
1090 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001091 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001092
Mythri Alle4b9f6182023-10-25 15:17:11 +00001093 needsDebugInfo = false
1094 for _, flag := range javacFlags {
1095 if strings.HasPrefix(flag, "-g") {
1096 needsDebugInfo = true
1097 }
1098 }
1099
1100 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001101 // For non-host binaries, override the -g flag passed globally to remove
1102 // local variable debug info to reduce disk and memory usage.
1103 javacFlags = append(javacFlags, "-g:source,lines")
1104 }
1105 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1106
1107 if flags.javaVersion.usesJavaModules() {
1108 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001109 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1110 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1111 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1112 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001113
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001114 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001115 if j.properties.Patch_module != nil {
1116 // Manually specify build directory in case it is not under the repo root.
1117 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1118 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001119 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001120
Jaewoong Jung26342642021-03-17 15:56:23 -07001121 classPath := flags.classpath.FormJavaClassPath("")
1122 if classPath != "" {
1123 patchPaths = append(patchPaths, classPath)
1124 }
1125 javacFlags = append(
1126 javacFlags,
1127 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1128 }
1129 }
1130
1131 if len(javacFlags) > 0 {
1132 // optimization.
1133 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1134 flags.javacFlags = "$javacFlags"
1135 }
1136
1137 return flags
1138}
1139
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001140func (j *Module) AddJSONData(d *map[string]interface{}) {
1141 (&j.ModuleBase).AddJSONData(d)
1142 (*d)["Java"] = map[string]interface{}{
1143 "SourceExtensions": j.sourceExtensions,
1144 }
1145
1146}
1147
usta0391ca42023-09-19 15:51:59 -04001148func (j *Module) addGeneratedSrcJars(path android.Path) {
1149 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001150}
1151
Colin Crossfdaa6722024-08-23 11:58:08 -07001152func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars, extraDepCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001153 // Auto-propagating jarjar rules
1154 jarjarProviderData := j.collectJarJarRules(ctx)
1155 if jarjarProviderData != nil {
1156 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wangddb2ee52024-04-02 16:44:02 +00001157 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
Joe Onorato349ae8d2024-02-05 22:46:00 +00001162 }
1163 }
1164
Jaewoong Jung26342642021-03-17 15:56:23 -07001165 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1166
John Wu989ee842024-10-04 00:21:43 +00001167 // Only override the original value if explicitly set
1168 if j.properties.Ravenizer.Enabled != nil {
1169 j.ravenizer.enabled = *j.properties.Ravenizer.Enabled
Makoto Onuki7ded3822024-03-28 14:42:20 -07001170 }
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
Dave Mankoff0a3ef842024-10-02 18:47:24 +00001193 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, j.properties.Exclude_common_srcs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001194 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
Colin Cross220a9a12022-03-28 17:08:01 -07001251 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001252
Colin Cross4eae06d2023-06-20 22:40:02 -07001253 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1254 // any dependencies so that it can override any non-final R classes from dependencies with the
1255 // final R classes from the app.
1256 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1257
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001258 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1259
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001260 var localImplementationJars android.Paths
1261
Mark Whitea15790a2023-08-22 21:28:11 +00001262 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001263 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001264 if srcFiles.HasExt(".kt") {
1265 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1266 }
1267 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1268 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1269 }
1270
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001271 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1272
1273 localHeaderJars, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
Colin Crossedec77c2024-07-26 15:25:40 -07001274 extraCombinedJars)
1275
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001276 combinedHeaderJarFile, jarjared := j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1277 if jarjared {
1278 localHeaderJars = android.Paths{combinedHeaderJarFile}
1279 transitiveStaticLibsHeaderJars = nil
1280 }
1281 combinedHeaderJarFile, repackaged := j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
1282 if repackaged {
1283 localHeaderJars = android.Paths{combinedHeaderJarFile}
1284 transitiveStaticLibsHeaderJars = nil
1285 }
Mark Whitea15790a2023-08-22 21:28:11 +00001286 if ctx.Failed() {
1287 return
1288 }
Colin Crossedec77c2024-07-26 15:25:40 -07001289 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001290
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001291 if ctx.Config().UseTransitiveJarsInClasspath() {
1292 if len(localHeaderJars) > 0 {
1293 ctx.CheckbuildFile(localHeaderJars...)
1294 } else {
1295 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1296 ctx.UncheckedModule()
1297 }
1298 } else {
1299 ctx.CheckbuildFile(j.headerJarFile)
1300 }
Colin Crossa6182ab2024-08-21 10:47:44 -07001301
Colin Cross7727c7f2024-07-18 15:36:32 -07001302 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001303 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001304 LocalHeaderJars: localHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001305 TransitiveStaticLibsHeaderJars: depset.New(depset.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Cross9ffaf282024-08-12 13:50:09 -07001306 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1307 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001308 AidlIncludeDirs: j.exportAidlIncludeDirs,
1309 ExportedPlugins: j.exportedPluginJars,
1310 ExportedPluginClasses: j.exportedPluginClasses,
1311 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1312 StubsLinkType: j.stubsLinkType,
1313 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Yu Liu63bdf632024-12-03 19:54:05 +00001314 SdkVersion: j.SdkVersion(ctx),
Mark Whitea15790a2023-08-22 21:28:11 +00001315 })
1316
1317 j.outputFile = j.headerJarFile
1318 return
1319 }
1320
Jaewoong Jung26342642021-03-17 15:56:23 -07001321 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001322 // When using kotlin sources turbine is used to generate annotation processor sources,
1323 // including for annotation processors that generate API, so we can use turbine for
1324 // java sources too.
1325 disableTurbine = false
1326
Jaewoong Jung26342642021-03-17 15:56:23 -07001327 // user defined kotlin flags.
1328 kotlincFlags := j.properties.Kotlincflags
1329 CheckKotlincFlags(ctx, kotlincFlags)
1330
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001331 // Workaround for KT-46512
1332 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001333
1334 // If there are kotlin files, compile them first but pass all the kotlin and java files
1335 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1336 // won't emit any classes for them.
1337 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1338 if ctx.Device() {
1339 kotlincFlags = append(kotlincFlags, "-no-jdk")
1340 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001341
1342 for _, plugin := range deps.kotlinPlugins {
1343 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1344 }
1345 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1346
Jaewoong Jung26342642021-03-17 15:56:23 -07001347 if len(kotlincFlags) > 0 {
1348 // optimization.
1349 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1350 flags.kotlincFlags += "$kotlincFlags"
1351 }
1352
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001353 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001354 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1355
Jaewoong Jung26342642021-03-17 15:56:23 -07001356 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1357 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1358
Isaac Chioua23d9942022-04-06 06:14:38 +00001359 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001360 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001361 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1362 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001363 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001364 srcJars = append(srcJars, kaptSrcJar)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001365 localImplementationJars = append(localImplementationJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001366 // Disable annotation processing in javac, it's already been handled by kapt
1367 flags.processorPath = nil
1368 flags.processors = nil
1369 }
1370
1371 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001372 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Spandan Das1028d5a2024-08-19 21:45:48 +00001373 j.kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001374 if ctx.Failed() {
1375 return
1376 }
1377
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001378 kotlinJarPath, _ := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001379
Isaac Chioua23d9942022-04-06 06:14:38 +00001380 // Make javac rule depend on the kotlinc rule
1381 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1382
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001383 localImplementationJars = append(localImplementationJars, kotlinJarPath)
1384
Colin Cross220a9a12022-03-28 17:08:01 -07001385 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001386 }
1387
Jaewoong Jung26342642021-03-17 15:56:23 -07001388 j.compiledSrcJars = srcJars
1389
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001390 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1391
Jaewoong Jung26342642021-03-17 15:56:23 -07001392 enableSharding := false
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001393 var localHeaderJars android.Paths
1394 var shardingHeaderJars android.Paths
1395 var repackagedHeaderJarFile android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001396 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001397 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1398 enableSharding = true
1399 // Formerly, there was a check here that prevented annotation processors
1400 // from being used when sharding was enabled, as some annotation processors
1401 // do not function correctly in sharded environments. It was removed to
1402 // allow for the use of annotation processors that do function correctly
1403 // with sharding enabled. See: b/77284273.
1404 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001405 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001406 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001407 var combinedHeaderJarFile android.Path
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001408 localHeaderJars, combinedHeaderJarFile = j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
1409 shardingHeaderJars = localHeaderJars
Colin Crossedec77c2024-07-26 15:25:40 -07001410
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001411 var jarjared bool
1412 j.headerJarFile, jarjared = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1413 if jarjared {
1414 // jarjar modifies transitive static dependencies, use the combined header jar and drop the transitive
1415 // static libs header jars.
1416 localHeaderJars = android.Paths{j.headerJarFile}
1417 transitiveStaticLibsHeaderJars = nil
1418 }
1419 var repackaged bool
1420 repackagedHeaderJarFile, repackaged = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
1421 if repackaged {
1422 // repackage modifies transitive static dependencies, use the combined header jar and drop the transitive
1423 // static libs header jars.
1424 // TODO(b/356688296): this shouldn't export both the unmodified and repackaged header jars
1425 localHeaderJars = android.Paths{j.headerJarFile, repackagedHeaderJarFile}
1426 transitiveStaticLibsHeaderJars = nil
1427 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001428 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001429 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001430 hasErrorproneableFiles := false
1431 for _, ext := range j.sourceExtensions {
1432 if ext != ".proto" && ext != ".aidl" {
1433 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1434 // compile, and it's not useful to have warnings on these generated sources.
1435 hasErrorproneableFiles = true
1436 break
1437 }
1438 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001439 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001440 if Bool(j.properties.Errorprone.Enabled) {
1441 // If error-prone is enabled, enable errorprone flags on the regular
1442 // build.
1443 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001444 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faustf3240f42024-12-11 16:49:18 -08001445 if ctx.Config().RunErrorProneInline() {
1446 // On CI, we're not going to toggle back/forth between errorprone and non-errorprone
1447 // builds, so it's faster if we don't compile the module twice and instead always
1448 // compile the module with errorprone.
1449 flags = enableErrorproneFlags(flags)
1450 } else {
1451 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1452 // a new jar file just for compiling with the errorprone compiler to.
1453 // This is because we don't want to cause the java files to get completely
1454 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1455 // We also don't want to run this if errorprone is enabled by default for
1456 // this module, or else we could have duplicated errorprone messages.
1457 errorproneFlags := enableErrorproneFlags(flags)
1458 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
1459 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001460
Cole Faustf3240f42024-12-11 16:49:18 -08001461 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
1462 "errorprone", "errorprone")
Cole Faust75fffb12021-06-13 15:23:16 -07001463
Cole Faustf3240f42024-12-11 16:49:18 -08001464 extraJarDeps = append(extraJarDeps, errorprone)
1465 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001466 }
1467
1468 if enableSharding {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001469 if len(shardingHeaderJars) > 0 {
1470 flags.classpath = append(classpath(slices.Clone(shardingHeaderJars)), flags.classpath...)
Colin Cross3d56ed52021-11-18 22:23:12 -08001471 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001472 shardSize := int(*(j.properties.Javac_shard_size))
1473 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001474 if len(uniqueJavaFiles) > 0 {
1475 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001476 for idx, shardSrc := range shardSrcs {
1477 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1478 nil, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001479 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
1480 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001481 }
1482 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001483 // Assume approximately 5 sources per srcjar.
1484 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1485 // 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 -07001486 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001487 startIdx := len(shardSrcs)
1488 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1489 for idx, shardSrcJars := range shardSrcJarsList {
1490 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1491 nil, shardSrcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001492 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
1493 localImplementationJars = append(localImplementationJars, classes)
Colin Crossa052ddb2023-09-25 21:46:58 -07001494 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001495 }
1496 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001497 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001498 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
1499 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001500 }
1501 if ctx.Failed() {
1502 return
1503 }
1504 }
1505
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001506 localImplementationJars = append(localImplementationJars, extraCombinedJars...)
Colin Crossfd620b22024-02-23 10:05:21 -08001507
Jaewoong Jung26342642021-03-17 15:56:23 -07001508 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1509
1510 var includeSrcJar android.WritablePath
1511 if Bool(j.properties.Include_srcs) {
1512 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1513 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1514 }
1515
1516 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1517 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Cole Faust7fd5b2e2024-10-29 11:22:20 -07001518 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources.GetOrDefault(ctx, nil), j.properties.Exclude_java_resources)
1519 fileArgs2, fileDeps2 := ResourceFilesToJarArgs(ctx, j.properties.Device_common_java_resources.GetOrDefault(ctx, nil), nil)
1520 fileArgs3, fileDeps3 := ResourceFilesToJarArgs(ctx, j.properties.Device_first_java_resources.GetOrDefault(ctx, nil), nil)
Cole Faust65cb40a2024-10-21 15:41:42 -07001521 fileArgs = slices.Concat(fileArgs, fileArgs2, fileArgs3)
1522 fileDeps = slices.Concat(fileDeps, fileDeps2, fileDeps3)
Jaewoong Jung26342642021-03-17 15:56:23 -07001523 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1524
1525 var resArgs []string
1526 var resDeps android.Paths
1527
1528 resArgs = append(resArgs, dirArgs...)
1529 resDeps = append(resDeps, dirDeps...)
1530
1531 resArgs = append(resArgs, fileArgs...)
1532 resDeps = append(resDeps, fileDeps...)
1533
1534 resArgs = append(resArgs, extraArgs...)
1535 resDeps = append(resDeps, extraDeps...)
1536
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001537 var localResourceJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001538 if len(resArgs) > 0 {
1539 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1540 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001541 if ctx.Failed() {
1542 return
1543 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001544 localResourceJars = append(localResourceJars, resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001545 }
1546
Jaewoong Jung26342642021-03-17 15:56:23 -07001547 if Bool(j.properties.Include_srcs) {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001548 localResourceJars = append(localResourceJars, includeSrcJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001549 }
1550
1551 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1552 if len(services) > 0 {
1553 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1554 var zipargs []string
1555 for _, file := range services {
1556 serviceFile := file.String()
1557 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1558 }
1559 rule := zip
1560 args := map[string]string{
1561 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1562 }
1563 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1564 rule = zipRE
1565 args["implicits"] = strings.Join(services.Strings(), ",")
1566 }
1567 ctx.Build(pctx, android.BuildParams{
1568 Rule: rule,
1569 Output: servicesJar,
1570 Implicits: services,
1571 Args: args,
1572 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001573 localResourceJars = append(localResourceJars, servicesJar)
1574 }
1575
Colin Crossa14fb6a2024-10-23 16:57:06 -07001576 completeStaticLibsResourceJars := depset.New(depset.PREORDER, localResourceJars, deps.transitiveStaticLibsResourceJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001577
1578 var combinedResourceJar android.Path
1579 var resourceJars android.Paths
1580 if ctx.Config().UseTransitiveJarsInClasspath() {
1581 resourceJars = completeStaticLibsResourceJars.ToList()
1582 } else {
1583 resourceJars = append(slices.Clone(localResourceJars), deps.staticResourceJars...)
1584 }
1585 if len(resourceJars) == 1 {
1586 combinedResourceJar = resourceJars[0]
1587 } else if len(resourceJars) > 0 {
1588 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1589 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1590 false, nil, nil)
1591 combinedResourceJar = combinedJar
1592 }
1593
1594 manifest := j.overrideManifest
1595 if !manifest.Valid() && j.properties.Manifest != nil {
1596 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Jaewoong Jung26342642021-03-17 15:56:23 -07001597 }
1598
1599 // Combine the classes built from sources, any manifests, and any static libraries into
1600 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001601 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001602
Colin Crossa14fb6a2024-10-23 16:57:06 -07001603 completeStaticLibsImplementationJars := depset.New(depset.PREORDER, localImplementationJars, deps.transitiveStaticLibsImplementationJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001604
1605 var jars android.Paths
1606 if ctx.Config().UseTransitiveJarsInClasspath() {
1607 jars = completeStaticLibsImplementationJars.ToList()
1608 } else {
1609 jars = append(slices.Clone(localImplementationJars), deps.staticJars...)
1610 }
1611
1612 jars = append(jars, extraDepCombinedJars...)
1613
Jaewoong Jung26342642021-03-17 15:56:23 -07001614 if len(jars) == 1 && !manifest.Valid() {
1615 // Optimization: skip the combine step as there is nothing to do
1616 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1617 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001618 // any if len(extraJars) == 0.
Jaewoong Jung26342642021-03-17 15:56:23 -07001619
Jihoon Kang1147b312023-06-08 23:25:57 +00001620 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1621 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1622 // either with .from-source or .from-text suffix.
1623 // outputFile should be agnostic to the build configuration,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001624 // thus copy the single input static lib in order to prevent the static lib from being exposed
Jihoon Kang1147b312023-06-08 23:25:57 +00001625 // to the copy rules.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001626 if stub, _ := moduleStubLinkType(j); stub {
1627 copiedJar := android.PathForModuleOut(ctx, "combined", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001628 ctx.Build(pctx, android.BuildParams{
1629 Rule: android.Cp,
1630 Input: jars[0],
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001631 Output: copiedJar,
Jaewoong Jung26342642021-03-17 15:56:23 -07001632 })
Colin Crossa14fb6a2024-10-23 16:57:06 -07001633 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, android.Paths{copiedJar}, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001634 outputFile = copiedJar
Colin Cross7707b242024-07-26 12:02:36 -07001635 } else {
1636 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001637 }
1638 } else {
1639 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1640 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1641 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001642 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001643 }
1644
1645 // jarjar implementation jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001646 jarjarFile, jarjarred := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1647 if jarjarred {
1648 localImplementationJars = android.Paths{jarjarFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001649 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001650 }
Colin Crossedec77c2024-07-26 15:25:40 -07001651 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001652
Colin Crossedec77c2024-07-26 15:25:40 -07001653 // jarjar resource jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001654 if combinedResourceJar != nil {
1655 resourceJarJarFile, jarjarred := j.jarjarIfNecessary(ctx, combinedResourceJar, jarName, "resource")
1656 combinedResourceJar = resourceJarJarFile
1657 if jarjarred {
1658 localResourceJars = android.Paths{resourceJarJarFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001659 completeStaticLibsResourceJars = depset.New(depset.PREORDER, localResourceJars, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001660 }
Colin Crossedec77c2024-07-26 15:25:40 -07001661 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001662
Colin Crossedec77c2024-07-26 15:25:40 -07001663 if ctx.Failed() {
1664 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001665 }
1666
Makoto Onuki7ded3822024-03-28 14:42:20 -07001667 if j.ravenizer.enabled {
1668 ravenizerInput := outputFile
John Wub67040d2024-10-07 18:39:06 +00001669 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", "", jarName)
John Wu989ee842024-10-04 00:21:43 +00001670 ravenizerArgs := ""
1671 if proptools.Bool(j.properties.Ravenizer.Strip_mockito) {
1672 ravenizerArgs = "--strip-mockito"
1673 }
1674 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
Makoto Onuki7ded3822024-03-28 14:42:20 -07001675 outputFile = ravenizerOutput
Colin Cross7e863852024-09-06 14:42:38 -07001676 localImplementationJars = android.Paths{ravenizerOutput}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001677 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001678 if combinedResourceJar != nil {
1679 ravenizerInput = combinedResourceJar
1680 ravenizerOutput = android.PathForModuleOut(ctx, "ravenizer", "resources", jarName)
1681 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
1682 combinedResourceJar = ravenizerOutput
1683 localResourceJars = android.Paths{ravenizerOutput}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001684 completeStaticLibsResourceJars = depset.New(depset.PREORDER, localResourceJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001685 }
Makoto Onuki7ded3822024-03-28 14:42:20 -07001686 }
1687
Yihan Dong8be09c22024-08-29 15:32:13 +08001688 if j.shouldApiMapper() {
1689 inputFile := outputFile
1690 apiMapperFile := android.PathForModuleOut(ctx, "apimapper", jarName)
1691 ctx.Build(pctx, android.BuildParams{
1692 Rule: apimapper,
1693 Description: "apimapper",
1694 Input: inputFile,
1695 Output: apiMapperFile,
1696 })
1697 outputFile = apiMapperFile
Colin Cross7e863852024-09-06 14:42:38 -07001698 localImplementationJars = android.Paths{apiMapperFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001699 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Yihan Dong8be09c22024-08-29 15:32:13 +08001700 }
1701
Jaewoong Jung26342642021-03-17 15:56:23 -07001702 // Check package restrictions if necessary.
1703 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001704 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001705 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001706
1707 // Create a rule to copy the output jar to another path and add a validate dependency that
1708 // will check that the jar only contains the permitted packages. The new location will become
1709 // the output file of this module.
1710 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001711 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001712 ctx.Build(pctx, android.BuildParams{
1713 Rule: android.Cp,
1714 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001715 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001716 // Make sure that any dependency on the output file will cause ninja to run the package check
1717 // rule.
1718 Validation: pkgckFile,
1719 })
Colin Cross7707b242024-07-26 12:02:36 -07001720 outputFile = packageCheckOutputFile
Colin Cross7e863852024-09-06 14:42:38 -07001721 localImplementationJars = android.Paths{packageCheckOutputFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001722 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001723
1724 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001725 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001726
1727 if ctx.Failed() {
1728 return
1729 }
1730 }
1731
1732 j.implementationJarFile = outputFile
1733 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001734 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1735 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1736 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1737 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1738 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1739 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1740 j.headerJarFile = headerJarFile
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001741 if len(localImplementationJars) == 1 && ctx.Config().UseTransitiveJarsInClasspath() {
1742 localHeaderJarFile := android.PathForModuleOut(ctx, "local-javac-header", jarName)
1743 convertImplementationJarToHeaderJar(ctx, localImplementationJars[0], localHeaderJarFile)
1744 localHeaderJars = append(localHeaderJars, localHeaderJarFile)
1745 } else {
1746 localHeaderJars = append(localHeaderJars, headerJarFile)
1747 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001748 }
1749
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001750 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1751 specs := j.jacocoModuleToZipCommand(ctx)
1752 if ctx.Failed() {
1753 return
1754 }
1755
Colin Crossb323c912024-09-24 15:21:00 -07001756 completeStaticLibsImplementationJarsToCombine := completeStaticLibsImplementationJars
1757
Colin Cross41698982024-11-13 11:31:31 -08001758 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Colin Crosse4f34882024-11-14 12:26:00 -08001759
1760 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
1761 compileDex := Bool(j.dexProperties.Compile_dex) || Bool(j.properties.Installable)
Colin Cross41698982024-11-13 11:31:31 -08001762
1763 if j.shouldInstrument(ctx) && (!ctx.Device() || compileDex) {
Colin Crossb323c912024-09-24 15:21:00 -07001764 instrumentedOutputFile := j.instrument(ctx, flags, outputFile, jarName, specs)
Colin Crossa14fb6a2024-10-23 16:57:06 -07001765 completeStaticLibsImplementationJarsToCombine = depset.New(depset.PREORDER, android.Paths{instrumentedOutputFile}, nil)
Colin Crossb323c912024-09-24 15:21:00 -07001766 outputFile = instrumentedOutputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001767 }
1768
1769 // merge implementation jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001770 var implementationAndResourcesJarsToCombine android.Paths
1771 if ctx.Config().UseTransitiveJarsInClasspath() {
1772 resourceJars := completeStaticLibsResourceJars.ToList()
1773 if len(resourceJars) > 0 {
Colin Crossb323c912024-09-24 15:21:00 -07001774 implementationAndResourcesJarsToCombine = append(resourceJars, completeStaticLibsImplementationJarsToCombine.ToList()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001775 implementationAndResourcesJarsToCombine = append(implementationAndResourcesJarsToCombine, extraDepCombinedJars...)
1776 }
1777 } else {
1778 if combinedResourceJar != nil {
1779 implementationAndResourcesJarsToCombine = android.Paths{combinedResourceJar, outputFile}
1780 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001781 }
1782
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001783 if len(implementationAndResourcesJarsToCombine) > 0 {
1784 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
1785 TransformJarsToJar(ctx, combinedJar, "for resources", implementationAndResourcesJarsToCombine, manifest,
1786 false, nil, nil)
1787 outputFile = combinedJar
1788 }
1789
1790 j.implementationAndResourcesJar = outputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001791
Colin Cross41698982024-11-13 11:31:31 -08001792 if ctx.Device() && compileDex {
Jaewoong Jung26342642021-03-17 15:56:23 -07001793 if j.hasCode(ctx) {
1794 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001795 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001796 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1797 }
1798 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001799 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001800 params := &compileDexParams{
1801 flags: flags,
1802 sdkVersion: j.SdkVersion(ctx),
1803 minSdkVersion: j.MinSdkVersion(ctx),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001804 classesJar: outputFile,
Spandan Dasc404cc72023-02-23 18:05:05 +00001805 jarName: jarName,
1806 }
Cole Fausteb032462024-09-19 11:12:54 -07001807 if j.GetProfileGuided(ctx) && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting(ctx) {
Spandan Das15a67112024-05-30 00:07:40 +00001808 ctx.PropertyErrorf("enable_profile_rewriting",
1809 "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.",
1810 )
1811 }
Cole Fausteb032462024-09-19 11:12:54 -07001812 if j.EnableProfileRewriting(ctx) {
1813 profile := j.GetProfile(ctx)
1814 if profile == "" || !j.GetProfileGuided(ctx) {
Spandan Das3dbda182024-05-20 22:23:10 +00001815 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1816 }
1817 params.artProfileInput = &profile
1818 }
1819 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001820 if ctx.Failed() {
1821 return
1822 }
1823
Spandan Das3dbda182024-05-20 22:23:10 +00001824 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1825 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001826 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001827 }
1828
Jaewoong Jung26342642021-03-17 15:56:23 -07001829 // merge dex jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001830 var dexAndResourceJarsToCombine android.Paths
1831 if ctx.Config().UseTransitiveJarsInClasspath() {
1832 resourceJars := completeStaticLibsResourceJars.ToList()
1833 if len(resourceJars) > 0 {
1834 dexAndResourceJarsToCombine = append(android.Paths{dexOutputFile}, resourceJars...)
1835 }
1836 } else {
1837 if combinedResourceJar != nil {
1838 dexAndResourceJarsToCombine = android.Paths{dexOutputFile, combinedResourceJar}
1839 }
1840 }
1841 if len(dexAndResourceJarsToCombine) > 0 {
Colin Cross7707b242024-07-26 12:02:36 -07001842 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001843 TransformJarsToJar(ctx, combinedJar, "for dex resources", dexAndResourceJarsToCombine, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001844 false, nil, nil)
1845 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001846 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001847 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001848 dexOutputFile = combinedAlignedJar
1849 } else {
1850 dexOutputFile = combinedJar
1851 }
1852 }
1853
Paul Duffin4de94502021-05-16 05:21:16 +01001854 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001855
1856 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001857
1858 // Encode hidden API flags in dex file, if needed.
1859 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1860
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001861 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001862
1863 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001864 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1865 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1866 libName = strings.TrimSuffix(libName, ".impl")
1867 }
1868 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001869
1870 outputFile = dexOutputFile
Colin Crossa6182ab2024-08-21 10:47:44 -07001871
1872 ctx.CheckbuildFile(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001873 } else {
1874 // There is no code to compile into a dex jar, make sure the resources are propagated
1875 // to the APK if this is an app.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001876 j.dexJarFile = makeDexJarPathFromPath(combinedResourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001877 }
1878
1879 if ctx.Failed() {
1880 return
1881 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001882 }
1883
1884 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001885 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001886 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001887 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001888 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001889 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001890 }
1891 }
1892
1893 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001894 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1895 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001896 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1897 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001898 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001899 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001900 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001901 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001902 j.linter.javaLanguageLevel = flags.javaVersion.String()
1903 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001904 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001905 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1906 j.linter.buildModuleReportZip = true
1907 }
1908 j.linter.lint(ctx)
1909 }
1910
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001911 j.collectTransitiveSrcFiles(ctx, srcFiles)
1912
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001913 if ctx.Config().UseTransitiveJarsInClasspath() {
1914 if len(localImplementationJars) > 0 || len(localResourceJars) > 0 || len(localHeaderJars) > 0 {
1915 ctx.CheckbuildFile(localImplementationJars...)
1916 ctx.CheckbuildFile(localResourceJars...)
1917 ctx.CheckbuildFile(localHeaderJars...)
1918 } else {
1919 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1920 ctx.UncheckedModule()
1921 }
1922 } else {
1923 ctx.CheckbuildFile(j.implementationJarFile)
1924 ctx.CheckbuildFile(j.headerJarFile)
1925 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001926
Colin Cross7727c7f2024-07-18 15:36:32 -07001927 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001928 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1929 RepackagedHeaderJars: android.PathsIfNonNil(repackagedHeaderJarFile),
1930
1931 LocalHeaderJars: localHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001932 TransitiveStaticLibsHeaderJars: depset.New(depset.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001933 TransitiveStaticLibsImplementationJars: completeStaticLibsImplementationJars,
1934 TransitiveStaticLibsResourceJars: completeStaticLibsResourceJars,
1935
Colin Cross9ffaf282024-08-12 13:50:09 -07001936 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1937 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001938 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1939 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001940 ResourceJars: android.PathsIfNonNil(combinedResourceJar),
Jihoon Kang705e63e2024-03-13 01:21:16 +00001941 AidlIncludeDirs: j.exportAidlIncludeDirs,
1942 SrcJarArgs: j.srcJarArgs,
1943 SrcJarDeps: j.srcJarDeps,
1944 TransitiveSrcFiles: j.transitiveSrcFiles,
1945 ExportedPlugins: j.exportedPluginJars,
1946 ExportedPluginClasses: j.exportedPluginClasses,
1947 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1948 JacocoReportClassesFile: j.jacocoReportClassesFile,
1949 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001950 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Yu Liu63bdf632024-12-03 19:54:05 +00001951 SdkVersion: j.SdkVersion(ctx),
Jaewoong Jung26342642021-03-17 15:56:23 -07001952 })
1953
1954 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1955 j.outputFile = outputFile.WithoutRel()
1956}
1957
Cole Faustb7493472024-08-28 11:55:52 -07001958func (j *Module) useCompose(ctx android.BaseModuleContext) bool {
1959 return android.InList("androidx.compose.runtime_runtime", j.staticLibs(ctx))
Colin Crossa1ff7c62021-09-17 14:11:52 -07001960}
1961
Colin Crossa14fb6a2024-10-23 16:57:06 -07001962func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []depset.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001963 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001964 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001965 depTag := ctx.OtherModuleDependencyTag(m)
1966
Colin Crossa14fb6a2024-10-23 16:57:06 -07001967 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1968 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
Sam Delmerico95d70942023-08-02 18:00:35 -04001969
Colin Crossa14fb6a2024-10-23 16:57:06 -07001970 if depTag == staticLibTag {
Sam Delmerico95d70942023-08-02 18:00:35 -04001971 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1972 }
1973 })
1974
Colin Crosscde55342024-03-27 14:11:51 -07001975 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1976}
1977
1978func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1979 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1980
Sam Delmerico95d70942023-08-02 18:00:35 -04001981 directUnconditionalExportedFlags := android.Paths{}
1982 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1983 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1984 if exportUnconditionally {
1985 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1986 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1987 directUnconditionalExportedFlags = proguardFlagsForThisModule
1988 }
1989
1990 return ProguardSpecInfo{
1991 Export_proguard_flags_files: exportUnconditionally,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001992 ProguardFlagsFiles: depset.New[android.Path](
1993 depset.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04001994 proguardFlagsForThisModule,
1995 transitiveProguardFlags,
1996 ),
Colin Crossa14fb6a2024-10-23 16:57:06 -07001997 UnconditionallyExportedProguardFlags: depset.New[android.Path](
1998 depset.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04001999 directUnconditionalExportedFlags,
2000 transitiveUnconditionalExportedFlags,
2001 ),
2002 }
2003
2004}
2005
Cole Faust75fffb12021-06-13 15:23:16 -07002006// Returns a copy of the supplied flags, but with all the errorprone-related
2007// fields copied to the regular build's fields.
2008func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
2009 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
2010
2011 if len(flags.errorProneExtraJavacFlags) > 0 {
2012 if len(flags.javacFlags) > 0 {
2013 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
2014 } else {
2015 flags.javacFlags = flags.errorProneExtraJavacFlags
2016 }
2017 }
2018 return flags
2019}
2020
Jaewoong Jung26342642021-03-17 15:56:23 -07002021func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07002022 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002023
2024 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00002025 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002026 if idx >= 0 {
2027 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00002028 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002029 jarName += strconv.Itoa(idx)
2030 }
2031
Colin Cross7707b242024-07-26 12:02:36 -07002032 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00002033 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07002034
Cole Faust9decf832024-06-11 11:45:53 -07002035 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002036 extractionFile := android.PathForModuleOut(ctx, kzipName)
2037 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
2038 j.kytheFiles = append(j.kytheFiles, extractionFile)
2039 }
2040
Vadim Spivak3c496f02023-06-08 06:14:59 +00002041 if len(flags.processorPath) > 0 {
2042 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
2043 }
2044
Jaewoong Jung26342642021-03-17 15:56:23 -07002045 return classes
2046}
2047
2048// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
2049// since some of these flags may be used internally.
2050func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
2051 for _, flag := range flags {
2052 flag = strings.TrimSpace(flag)
2053
2054 if !strings.HasPrefix(flag, "-") {
2055 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
2056 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
2057 ctx.PropertyErrorf("kotlincflags",
2058 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
2059 } else if inList(flag, config.KotlincIllegalFlags) {
2060 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
2061 } else if flag == "-include-runtime" {
2062 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
2063 } else {
2064 args := strings.Split(flag, " ")
2065 if args[0] == "-kotlin-home" {
2066 ctx.PropertyErrorf("kotlincflags",
2067 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
2068 }
2069 }
2070 }
2071}
2072
2073func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
2074 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002075 extraJars android.Paths) (localHeaderJars android.Paths, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002076
Jaewoong Jung26342642021-03-17 15:56:23 -07002077 if len(srcFiles) > 0 || len(srcJars) > 0 {
2078 // Compile java sources into turbine.jar.
2079 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
2080 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002081 localHeaderJars = append(localHeaderJars, turbineJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07002082 }
2083
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002084 localHeaderJars = append(localHeaderJars, extraJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002085
2086 // Combine any static header libraries into classes-header.jar. If there is only
2087 // one input jar this step will be skipped.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002088 var jars android.Paths
2089 if ctx.Config().UseTransitiveJarsInClasspath() {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002090 depSet := depset.New(depset.PREORDER, localHeaderJars, deps.transitiveStaticLibsHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002091 jars = depSet.ToList()
2092 } else {
2093 jars = append(slices.Clone(localHeaderJars), deps.staticHeaderJars...)
2094 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002095
2096 // we cannot skip the combine step for now if there is only one jar
2097 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07002098 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
2099 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07002100 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07002101
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002102 return localHeaderJars, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07002103}
2104
2105func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07002106 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002107
2108 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07002109 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07002110
2111 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
2112
2113 j.jacocoReportClassesFile = jacocoReportClassesFile
2114
2115 return instrumentedJar
2116}
2117
Colin Cross9ffaf282024-08-12 13:50:09 -07002118type providesTransitiveHeaderJarsForR8 struct {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002119 // set of header jars for all transitive libs deps
Colin Crossa14fb6a2024-10-23 16:57:06 -07002120 transitiveLibsHeaderJarsForR8 depset.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002121 // set of header jars for all transitive static libs deps
Colin Crossa14fb6a2024-10-23 16:57:06 -07002122 transitiveStaticLibsHeaderJarsForR8 depset.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002123}
2124
Colin Cross9ffaf282024-08-12 13:50:09 -07002125// collectTransitiveHeaderJarsForR8 visits direct dependencies and collects all transitive libs and static_libs
2126// header jars. The semantics of the collected jars are odd (it collects combined jars that contain the static
2127// libs, but also the static libs, and it collects transitive libs dependencies of static_libs), so these
2128// are only used to expand the --lib arguments to R8.
2129func (j *providesTransitiveHeaderJarsForR8) collectTransitiveHeaderJarsForR8(ctx android.ModuleContext) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002130 directLibs := android.Paths{}
2131 directStaticLibs := android.Paths{}
Colin Crossa14fb6a2024-10-23 16:57:06 -07002132 transitiveLibs := []depset.DepSet[android.Path]{}
2133 transitiveStaticLibs := []depset.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002134 ctx.VisitDirectDeps(func(module android.Module) {
2135 // don't add deps of the prebuilt version of the same library
2136 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
2137 return
2138 }
2139
Colin Cross7727c7f2024-07-18 15:36:32 -07002140 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2141 tag := ctx.OtherModuleDependencyTag(module)
2142 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2143 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2144 directLibs = append(directLibs, dep.HeaderJars...)
2145 } else if tag == staticLibTag {
2146 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2147 } else {
2148 // Don't propagate transitive libs for other kinds of dependencies.
2149 return
2150 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002151
Colin Crossa14fb6a2024-10-23 16:57:06 -07002152 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJarsForR8)
2153 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJarsForR8)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002154 }
2155 })
Colin Crossa14fb6a2024-10-23 16:57:06 -07002156 j.transitiveLibsHeaderJarsForR8 = depset.New(depset.POSTORDER, directLibs, transitiveLibs)
2157 j.transitiveStaticLibsHeaderJarsForR8 = depset.New(depset.POSTORDER, directStaticLibs, transitiveStaticLibs)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002158}
2159
Jaewoong Jung26342642021-03-17 15:56:23 -07002160func (j *Module) HeaderJars() android.Paths {
2161 if j.headerJarFile == nil {
2162 return nil
2163 }
2164 return android.Paths{j.headerJarFile}
2165}
2166
2167func (j *Module) ImplementationJars() android.Paths {
2168 if j.implementationJarFile == nil {
2169 return nil
2170 }
2171 return android.Paths{j.implementationJarFile}
2172}
2173
Spandan Das59a4a2b2024-01-09 21:35:56 +00002174func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002175 return j.dexJarFile
2176}
2177
2178func (j *Module) DexJarInstallPath() android.Path {
2179 return j.installFile
2180}
2181
2182func (j *Module) ImplementationAndResourcesJars() android.Paths {
2183 if j.implementationAndResourcesJar == nil {
2184 return nil
2185 }
2186 return android.Paths{j.implementationAndResourcesJar}
2187}
2188
2189func (j *Module) AidlIncludeDirs() android.Paths {
2190 // exportAidlIncludeDirs is type android.Paths already
2191 return j.exportAidlIncludeDirs
2192}
2193
2194func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2195 return j.classLoaderContexts
2196}
2197
2198// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002199func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002200 if j.expandJarjarRules != nil {
2201 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Das096b8d62024-10-08 22:41:26 +00002202 // Add the header jar so that the rdeps can be resolved to the repackaged classes.
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002203 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
Jaewoong Jung26342642021-03-17 15:56:23 -07002204 }
Spandan Das096b8d62024-10-08 22:41:26 +00002205 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2206 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2207 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002208 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2209 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Cole Faustb7493472024-08-28 11:55:52 -07002210 dpInfo.Static_libs = append(dpInfo.Static_libs, j.staticLibs(ctx)...)
Yikef6282022022-04-13 20:41:01 +08002211 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002212}
2213
2214func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002215 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002216}
2217
2218func (j *Module) hasCode(ctx android.ModuleContext) bool {
2219 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2220 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2221}
2222
2223// Implements android.ApexModule
Colin Crossf7bbd2f2024-12-05 13:57:10 -08002224func (j *Module) OutgoingDepIsInSameApex(tag blueprint.DependencyTag) bool {
2225 return j.depIsInSameApex(tag)
Jaewoong Jung26342642021-03-17 15:56:23 -07002226}
2227
2228// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002229func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002230 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002231 minSdkVersion := j.MinSdkVersion(ctx)
2232 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002233 return fmt.Errorf("min_sdk_version is not specified")
2234 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002235 // If the module is compiling against core (via sdk_version), skip comparison check.
2236 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002237 return nil
2238 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002239 if minSdkVersion.GreaterThan(sdkVersion) {
2240 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002241 }
2242 return nil
2243}
2244
2245func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002246 if j.stem == "" {
2247 panic("Stem() called before stem property was set")
2248 }
2249 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002250}
2251
Jaewoong Jung26342642021-03-17 15:56:23 -07002252func (j *Module) JacocoReportClassesFile() android.Path {
2253 return j.jacocoReportClassesFile
2254}
2255
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002256func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002257 var fromDeps []depset.DepSet[android.Path]
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002258 ctx.VisitDirectDeps(func(module android.Module) {
2259 tag := ctx.OtherModuleDependencyTag(module)
2260 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002261 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002262 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002263 }
2264 }
2265 })
2266
Colin Crossa14fb6a2024-10-23 16:57:06 -07002267 j.transitiveSrcFiles = depset.New(depset.POSTORDER, mine, fromDeps)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002268}
2269
Jaewoong Jung26342642021-03-17 15:56:23 -07002270func (j *Module) IsInstallable() bool {
2271 return Bool(j.properties.Installable)
2272}
2273
2274type sdkLinkType int
2275
2276const (
2277 // TODO(jiyong) rename these for better readability. Make the allowed
2278 // and disallowed link types explicit
2279 // order is important here. See rank()
2280 javaCore sdkLinkType = iota
2281 javaSdk
2282 javaSystem
2283 javaModule
2284 javaSystemServer
2285 javaPlatform
2286)
2287
2288func (lt sdkLinkType) String() string {
2289 switch lt {
2290 case javaCore:
2291 return "core Java API"
2292 case javaSdk:
2293 return "Android API"
2294 case javaSystem:
2295 return "system API"
2296 case javaModule:
2297 return "module API"
2298 case javaSystemServer:
2299 return "system server API"
2300 case javaPlatform:
2301 return "private API"
2302 default:
2303 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2304 }
2305}
2306
2307// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2308// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2309// can't statically depend on modules that use Platform API.
2310func (lt sdkLinkType) rank() int {
2311 return int(lt)
2312}
2313
2314type moduleWithSdkDep interface {
2315 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002316 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002317}
2318
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002319func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2320 switch k {
2321 case android.SdkCore:
2322 return javaCore
2323 case android.SdkSystem:
2324 return javaSystem
2325 case android.SdkPublic:
2326 return javaSdk
2327 case android.SdkModule:
2328 return javaModule
2329 case android.SdkSystemServer:
2330 return javaSystemServer
2331 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2332 return javaPlatform
2333 default:
2334 return javaSdk
2335 }
2336}
2337
Jiyong Park92315372021-04-02 08:45:46 +09002338func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002339 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002340 case android.SdkCore.DefaultJavaLibraryName(),
2341 "legacy.core.platform.api.stubs",
2342 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002343 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002344 "core-lambda-stubs",
Colin Crosse4f34882024-11-14 12:26:00 -08002345 "core-generated-annotation-stubs",
2346 // jacocoagent only uses core APIs, but has to specify a non-core sdk_version so it can use
2347 // a prebuilt SDK to avoid circular dependencies when it statically included in the bootclasspath.
2348 "jacocoagent":
Jaewoong Jung26342642021-03-17 15:56:23 -07002349 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002350 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002351 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002352 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002353 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002354 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002355 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002356 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002357 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002358 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002359 return javaSystem, true
2360 }
2361
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002362 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002363 return linkType, true
2364 }
2365
Jiyong Park92315372021-04-02 08:45:46 +09002366 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002367 if !ver.Valid() {
2368 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002369 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002370
2371 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002372}
2373
2374// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2375// this module's. See the comment on rank() for details and an example.
2376func (j *Module) checkSdkLinkType(
2377 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2378 if ctx.Host() {
2379 return
2380 }
2381
Jiyong Park92315372021-04-02 08:45:46 +09002382 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002383 if stubs {
2384 return
2385 }
Jiyong Park92315372021-04-02 08:45:46 +09002386 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002387
2388 if myLinkType.rank() < depLinkType.rank() {
2389 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2390 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2391 "property of the source or target module so that target module is built "+
2392 "with the same or smaller API set when compared to the source.",
2393 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2394 }
2395}
2396
2397func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2398 var deps deps
2399
Jiyong Park92315372021-04-02 08:45:46 +09002400 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002401
Colin Cross9ffaf282024-08-12 13:50:09 -07002402 j.collectTransitiveHeaderJarsForR8(ctx)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002403
Colin Crossa14fb6a2024-10-23 16:57:06 -07002404 var transitiveBootClasspathHeaderJars []depset.DepSet[android.Path]
2405 var transitiveClasspathHeaderJars []depset.DepSet[android.Path]
2406 var transitiveJava9ClasspathHeaderJars []depset.DepSet[android.Path]
2407 var transitiveStaticJarsHeaderLibs []depset.DepSet[android.Path]
2408 var transitiveStaticJarsImplementationLibs []depset.DepSet[android.Path]
2409 var transitiveStaticJarsResourceLibs []depset.DepSet[android.Path]
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002410
Jaewoong Jung26342642021-03-17 15:56:23 -07002411 ctx.VisitDirectDeps(func(module android.Module) {
2412 otherName := ctx.OtherModuleName(module)
2413 tag := ctx.OtherModuleDependencyTag(module)
2414
2415 if IsJniDepTag(tag) {
2416 // Handled by AndroidApp.collectAppDeps
2417 return
2418 }
2419 if tag == certificateTag {
2420 // Handled by AndroidApp.collectAppDeps
2421 return
2422 }
2423
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002424 if sdkInfo, ok := android.OtherModuleProvider(ctx, module, SdkLibraryInfoProvider); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -07002425 switch tag {
Jihoon Kang28c96572024-09-11 23:44:44 +00002426 case sdkLibTag, libTag, staticLibTag:
Jihoon Kang28c96572024-09-11 23:44:44 +00002427 generatingLibsString := android.PrettyConcat(
2428 getGeneratingLibs(ctx, j.SdkVersion(ctx), module.Name(), sdkInfo), true, "or")
2429 ctx.ModuleErrorf("cannot depend directly on java_sdk_library %q; try depending on %s instead", module.Name(), generatingLibsString)
Jaewoong Jung26342642021-03-17 15:56:23 -07002430 }
Colin Cross313aa542023-12-13 13:47:44 -08002431 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2432 if sdkLinkType != javaPlatform {
2433 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2434 // dep is a sysprop implementation library, but this module is not linking against
2435 // the platform, so it gets the sysprop public stubs library instead. Replace
2436 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2437 dep = syspropDep.JavaInfo
2438 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002439 }
2440 switch tag {
2441 case bootClasspathTag:
2442 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002443 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002444 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002445 if _, ok := module.(*Plugin); ok {
2446 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2447 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002448 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002449 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002450 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2451 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2452 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2453 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002454 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2455 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2456 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002457
Colin Crossa14fb6a2024-10-23 16:57:06 -07002458 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002459 case java9LibTag:
2460 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002461 transitiveJava9ClasspathHeaderJars = append(transitiveJava9ClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002462 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002463 if _, ok := module.(*Plugin); ok {
2464 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2465 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002466 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2467 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2468 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2469 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2470 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2471 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2472 // Turbine doesn't run annotation processors, so any module that uses an
2473 // annotation processor that generates API is incompatible with the turbine
2474 // optimization.
2475 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002476 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002477
Colin Crossa14fb6a2024-10-23 16:57:06 -07002478 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2479 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, dep.TransitiveStaticLibsHeaderJars)
2480 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, dep.TransitiveStaticLibsImplementationJars)
2481 transitiveStaticJarsResourceLibs = append(transitiveStaticJarsResourceLibs, dep.TransitiveStaticLibsResourceJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002482 case pluginTag:
2483 if plugin, ok := module.(*Plugin); ok {
2484 if plugin.pluginProperties.Processor_class != nil {
2485 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2486 } else {
2487 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2488 }
2489 // Turbine doesn't run annotation processors, so any module that uses an
2490 // annotation processor that generates API is incompatible with the turbine
2491 // optimization.
2492 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2493 } else {
2494 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2495 }
2496 case errorpronePluginTag:
2497 if _, ok := module.(*Plugin); ok {
2498 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2499 } else {
2500 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2501 }
2502 case exportedPluginTag:
2503 if plugin, ok := module.(*Plugin); ok {
2504 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2505 if plugin.pluginProperties.Processor_class != nil {
2506 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2507 }
2508 // Turbine doesn't run annotation processors, so any module that uses an
2509 // annotation processor that generates API is incompatible with the turbine
2510 // optimization.
2511 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2512 } else {
2513 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2514 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002515 case kotlinPluginTag:
Luca Stefani50098f72024-10-12 17:55:31 +02002516 if _, ok := module.(*KotlinPlugin); ok {
2517 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
2518 } else {
2519 ctx.PropertyErrorf("kotlin_plugins", "%q is not a kotlin_plugin module", otherName)
2520 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002521 case syspropPublicStubDepTag:
2522 // This is a sysprop implementation library, forward the JavaInfoProvider from
2523 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002524 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002525 JavaInfo: dep,
2526 })
2527 }
2528 } else if dep, ok := module.(android.SourceFileProducer); ok {
2529 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002530 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002531 checkProducesJars(ctx, dep)
2532 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002533 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002534 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07002535 depset.New(depset.PREORDER, dep.Srcs(), nil))
Jaewoong Jung26342642021-03-17 15:56:23 -07002536 case staticLibTag:
2537 checkProducesJars(ctx, dep)
2538 deps.classpath = append(deps.classpath, dep.Srcs()...)
2539 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2540 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002541
Colin Crossa14fb6a2024-10-23 16:57:06 -07002542 depHeaderJars := depset.New(depset.PREORDER, dep.Srcs(), nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002543 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJars)
2544 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, depHeaderJars)
2545 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, depHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002546 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002547 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002548 switch tag {
2549 case staticLibTag:
2550 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2551 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002552 } else {
2553 switch tag {
2554 case bootClasspathTag:
2555 // If a system modules dependency has been added to the bootclasspath
2556 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002557 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002558 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002559 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars,
2560 sm.TransitiveStaticLibsHeaderJars)
Colin Crossb61c2262024-08-08 14:04:42 -07002561 } else {
2562 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2563 ctx.OtherModuleName(module))
2564 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002565
2566 case systemModulesTag:
2567 if deps.systemModules != nil {
2568 panic("Found two system module dependencies")
2569 }
Colin Crossb61c2262024-08-08 14:04:42 -07002570 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2571 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2572 } else {
2573 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2574 ctx.OtherModuleName(module))
2575 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002576
2577 case instrumentationForTag:
2578 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 -07002579 }
2580 }
2581
Spandan Das8aac9932024-07-18 23:14:13 +00002582 if android.InList(tag, compileDependencyTags) {
2583 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2584 j.compileDepNames = append(j.compileDepNames, otherName)
2585 }
2586
Jaewoong Jung26342642021-03-17 15:56:23 -07002587 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002588 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002589 })
2590
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002591 deps.transitiveStaticLibsHeaderJars = transitiveStaticJarsHeaderLibs
2592 deps.transitiveStaticLibsImplementationJars = transitiveStaticJarsImplementationLibs
2593 deps.transitiveStaticLibsResourceJars = transitiveStaticJarsResourceLibs
2594
2595 if ctx.Config().UseTransitiveJarsInClasspath() {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002596 depSet := depset.New(depset.PREORDER, nil, transitiveClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002597 deps.classpath = depSet.ToList()
Colin Crossa14fb6a2024-10-23 16:57:06 -07002598 depSet = depset.New(depset.PREORDER, nil, transitiveBootClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002599 deps.bootClasspath = depSet.ToList()
Colin Crossa14fb6a2024-10-23 16:57:06 -07002600 depSet = depset.New(depset.PREORDER, nil, transitiveJava9ClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002601 deps.java9Classpath = depSet.ToList()
2602 }
2603
2604 if ctx.Device() {
2605 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
2606 if sdkDep.invalidVersion {
2607 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2608 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2609 } else if sdkDep.useFiles {
2610 // sdkDep.jar is actually equivalent to turbine header.jar.
2611 deps.classpath = append(slices.Clone(classpath(sdkDep.jars)), deps.classpath...)
2612 deps.dexClasspath = append(slices.Clone(classpath(sdkDep.jars)), deps.dexClasspath...)
2613 deps.aidlPreprocess = sdkDep.aidl
2614 // Add the sdk module dependency to `compileDepNames`.
2615 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2616 // TODO (b/358608607): Move this to decodeSdkDep
2617 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2618 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
2619 } else {
2620 deps.aidlPreprocess = sdkDep.aidl
2621 }
2622 }
2623
Jaewoong Jung26342642021-03-17 15:56:23 -07002624 return deps
2625}
2626
Joe Onorato349ae8d2024-02-05 22:46:00 +00002627// Provider for jarjar renaming rules.
2628//
2629// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2630// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2631// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2632// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2633// be renamed from that module.
2634// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002635type DependencyUse int
2636
2637const (
2638 RenameUseInvalid DependencyUse = iota
2639 RenameUseInclude
2640 RenameUseExclude
2641)
2642
2643type RenameUseElement struct {
2644 DepName string
2645 RenameUse DependencyUse
2646 Why string // token for determining where in the logic the decision was made.
2647}
2648
Joe Onorato349ae8d2024-02-05 22:46:00 +00002649type JarJarProviderData struct {
2650 // Mapping of class names: original --> renamed. If the value is "", the class will be
2651 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2652 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002653 Rename map[string]string
2654 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002655}
2656
2657func (this JarJarProviderData) GetDebugString() string {
2658 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002659 for _, k := range android.SortedKeys(this.Rename) {
2660 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002661 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2662 result += k + "--&gt;" + v + ";"
2663 }
2664 }
2665 return result
2666}
2667
2668var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2669
2670var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2671
2672func init() {
2673 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
Yu Liu26a716d2024-08-30 23:40:32 +00002674
2675 gob.Register(BaseJarJarProviderData{})
Joe Onorato349ae8d2024-02-05 22:46:00 +00002676}
2677
2678// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2679// whether they are java modules or not.
2680type BaseJarJarProviderData struct {
2681 JarJarProviderData JarJarProviderData
2682}
2683
2684func (this BaseJarJarProviderData) GetDebugString() string {
2685 return this.JarJarProviderData.GetDebugString()
2686}
2687
2688var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2689
2690// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2691// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2692// either JarJarProvider or BaseJarJarProvider.
2693func mergeJarJarPrefixes(ctx android.ModuleContext) {
2694 mod := ctx.Module()
2695 // Explicitly avoid propagating into some module types.
2696 switch reflect.TypeOf(mod).String() {
2697 case "*java.Droidstubs":
2698 return
2699 }
2700 jarJarData := collectDirectDepsProviders(ctx)
2701 if jarJarData != nil {
2702 providerData := BaseJarJarProviderData{
2703 JarJarProviderData: *jarJarData,
2704 }
2705 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2706 }
2707
2708}
2709
2710// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2711func (module *Module) addJarJarRenameRule(original string, renamed string) {
2712 if module.jarjarRenameRules == nil {
2713 module.jarjarRenameRules = make(map[string]string)
2714 }
2715 module.jarjarRenameRules[original] = renamed
2716}
2717
2718func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2719 // Gather repackage information from deps
2720 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002721
2722 module := ctx.Module()
2723 moduleName := module.Name()
2724
Colin Cross648daea2024-09-12 14:35:29 -07002725 ctx.VisitDirectDeps(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002726 tag := ctx.OtherModuleDependencyTag(m)
2727 // This logic mirrors that in (*Module).collectDeps above. There are several places
2728 // where we explicitly return RenameUseExclude, even though it is the default, to
2729 // indicate that it has been verified to be the case.
2730 //
2731 // Note well: there are probably cases that are getting to the unconditional return
2732 // and are therefore wrong.
2733 shouldIncludeRenames := func() (DependencyUse, string) {
2734 if moduleName == m.Name() {
2735 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2736 }
2737 if sc, ok := module.(android.SdkContext); ok {
2738 if ctx.Device() {
2739 sdkDep := decodeSdkDep(ctx, sc)
2740 if !sdkDep.invalidVersion && sdkDep.useFiles {
2741 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002742 }
2743 }
LaMont Jones63683e42024-02-08 14:30:45 -08002744 }
2745 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2746 return RenameUseExclude, "tags"
2747 }
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002748 if _, ok := android.OtherModuleProvider(ctx, m, SdkLibraryInfoProvider); ok {
LaMont Jones63683e42024-02-08 14:30:45 -08002749 switch tag {
2750 case sdkLibTag, libTag:
2751 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2752 }
2753 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2754 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2755 switch ji.StubsLinkType {
2756 case Stubs:
2757 return RenameUseExclude, "info"
2758 case Implementation:
2759 return RenameUseInclude, "info"
2760 default:
LaMont Jones09721862024-06-11 10:30:50 -07002761 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002762 // Fall through to the heuristic logic.
2763 }
2764 switch reflect.TypeOf(m).String() {
2765 case "*java.GeneratedJavaLibraryModule":
2766 // Probably a java_aconfig_library module.
2767 // TODO: make this check better.
2768 return RenameUseInclude, "reflect"
2769 }
2770 switch tag {
2771 case bootClasspathTag:
2772 return RenameUseExclude, "tagswitch"
2773 case sdkLibTag, libTag, instrumentationForTag:
2774 return RenameUseInclude, "tagswitch"
2775 case java9LibTag:
2776 return RenameUseExclude, "tagswitch"
2777 case staticLibTag:
2778 return RenameUseInclude, "tagswitch"
2779 case pluginTag:
2780 return RenameUseInclude, "tagswitch"
2781 case errorpronePluginTag:
2782 return RenameUseInclude, "tagswitch"
2783 case exportedPluginTag:
2784 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002785 case kotlinPluginTag:
2786 return RenameUseInclude, "tagswitch"
2787 default:
2788 return RenameUseExclude, "tagswitch"
2789 }
2790 } else if _, ok := m.(android.SourceFileProducer); ok {
2791 switch tag {
2792 case sdkLibTag, libTag, staticLibTag:
2793 return RenameUseInclude, "srcfile"
2794 default:
2795 return RenameUseExclude, "srcfile"
2796 }
Yu Liu67a28422024-03-05 00:36:31 +00002797 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002798 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002799 } else {
2800 switch tag {
2801 case bootClasspathTag:
2802 return RenameUseExclude, "else"
2803 case systemModulesTag:
2804 return RenameUseInclude, "else"
2805 }
2806 }
2807 // If we got here, choose the safer option, which may lead to a build failure, rather
2808 // than runtime failures on the device.
2809 return RenameUseExclude, "end"
2810 }
2811
2812 if result == nil {
2813 result = &JarJarProviderData{
2814 Rename: make(map[string]string),
2815 RenameUse: make([]RenameUseElement, 0),
2816 }
2817 }
2818 how, why := shouldIncludeRenames()
2819 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2820 if how != RenameUseInclude {
2821 // Nothing to merge.
2822 return
2823 }
2824
2825 merge := func(theirs *JarJarProviderData) {
2826 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002827 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2828 result.Rename[orig] = renamed
2829 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2830 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2831 result.Rename[orig] = renamed
2832 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2833 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2834 continue
2835 }
2836 }
2837 }
2838 }
2839 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2840 merge(&theirs)
2841 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2842 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2843 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2844 // to java.Module.
2845 merge(&theirs.JarJarProviderData)
2846 }
2847 })
2848 return
2849}
2850
2851func (this Module) GetDebugString() string {
2852 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2853}
2854
2855// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2856// us, and if it's been set, apply the jarjar_prefix property to rename them.
2857func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2858 // Gather repackage information from deps
2859 result := collectDirectDepsProviders(ctx)
2860
Joe Onoratoa5d17172024-07-20 17:39:56 -07002861 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002862 if result == nil {
2863 result = &JarJarProviderData{
2864 Rename: make(map[string]string),
2865 }
2866 }
2867 if renamed != "" {
2868 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2869 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002870 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002871 }
2872 }
2873 (*result).Rename[orig] = renamed
2874 }
2875
Joe Onoratoa5d17172024-07-20 17:39:56 -07002876 // Update that with entries we've stored for ourself
2877 for orig, renamed := range module.jarjarRenameRules {
2878 add(orig, renamed)
2879 }
2880
2881 // Update that with entries given in the jarjar_rename property.
2882 for _, orig := range module.properties.Jarjar_rename {
2883 add(orig, "")
2884 }
2885
Joe Onorato349ae8d2024-02-05 22:46:00 +00002886 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2887 if result == nil {
2888 return nil
2889 }
2890
2891 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2892 // that have not yet been renamed.
2893 prefix := proptools.String(module.properties.Jarjar_prefix)
2894 if prefix != "" {
2895 if prefix[0] == '.' {
2896 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2897 return nil
2898 }
2899 if prefix[len(prefix)-1] == '.' {
2900 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2901 return nil
2902 }
2903
2904 var updated map[string]string
2905 for orig, renamed := range (*result).Rename {
2906 if renamed == "" {
2907 if updated == nil {
2908 updated = make(map[string]string)
2909 }
2910 updated[orig] = prefix + "." + orig
2911 }
2912 }
2913 for orig, renamed := range updated {
2914 (*result).Rename[orig] = renamed
2915 }
2916 }
2917
2918 return result
2919}
2920
2921// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2922// to "" won't be in this list because they shouldn't be renamed yet.
2923func getJarJarRuleText(provider *JarJarProviderData) string {
2924 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002925 for _, orig := range android.SortedKeys(provider.Rename) {
2926 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002927 if renamed != "" {
2928 result += "rule " + orig + " " + renamed + "\n"
2929 }
2930 }
2931 return result
2932}
2933
Zi Wangddb2ee52024-04-02 16:44:02 +00002934// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002935func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Zi Wangddb2ee52024-04-02 16:44:02 +00002936 if j.repackageJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002937 return infile, false
Zi Wangddb2ee52024-04-02 16:44:02 +00002938 }
Colin Crossedec77c2024-07-26 15:25:40 -07002939 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002940 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002941 return repackagedJarjarFile, true
Zi Wangddb2ee52024-04-02 16:44:02 +00002942}
2943
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002944func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Colin Crossedec77c2024-07-26 15:25:40 -07002945 if j.expandJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002946 return infile, false
Colin Crossedec77c2024-07-26 15:25:40 -07002947 }
2948 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2949 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002950 return jarjarFile, true
Colin Crossedec77c2024-07-26 15:25:40 -07002951
2952}
2953
Jaewoong Jung26342642021-03-17 15:56:23 -07002954func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2955 deps.processorPath = append(deps.processorPath, pluginJars...)
2956 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2957}
2958
2959// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2960// this interface.
2961type ProvidesUsesLib interface {
2962 ProvidesUsesLib() *string
2963}
2964
2965func (j *Module) ProvidesUsesLib() *string {
2966 return j.usesLibraryProperties.Provides_uses_lib
2967}
satayev1c564cc2021-05-25 19:50:30 +01002968
2969type ModuleWithStem interface {
2970 Stem() string
2971}
2972
2973var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002974
2975type ModuleWithUsesLibrary interface {
2976 UsesLibrary() *usesLibrary
2977}
2978
2979func (j *Module) UsesLibrary() *usesLibrary {
2980 return &j.usesLibrary
2981}
2982
2983var _ ModuleWithUsesLibrary = (*Module)(nil)