blob: f26404b8c95419f1aace15477ccbec4020e63edf [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
368// Module/Import's DepIsInSameApex(...) delegates to this method.
369//
370// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
371// the one provided by ApexModuleBase.
372func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
373 // dependencies other than the static linkage are all considered crossing APEX boundary
374 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
375 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 {
841 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
842 // Exception: for hostdex: true libraries, the platform variant is created
843 // even if it's not marked as available to platform. In that case, the platform
844 // variant is used only for the hostdex and not installed to the device.
845 return true
846 }
847 return j.ApexModuleBase.AvailableFor(what)
848}
849
Cole Faustb7493472024-08-28 11:55:52 -0700850func (j *Module) staticLibs(ctx android.BaseModuleContext) []string {
Jihoon Kang8bce3812024-09-30 18:46:51 +0000851 return j.properties.Static_libs.GetOrDefault(ctx, nil)
Cole Faustb7493472024-08-28 11:55:52 -0700852}
853
Jaewoong Jung26342642021-03-17 15:56:23 -0700854func (j *Module) deps(ctx android.BottomUpMutatorContext) {
855 if ctx.Device() {
856 j.linter.deps(ctx)
857
Jiyong Parkf1691d22021-03-29 20:11:58 +0900858 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700859
860 if j.deviceProperties.SyspropPublicStub != "" {
861 // This is a sysprop implementation library that has a corresponding sysprop public
862 // stubs library, and a dependency on it so that dependencies on the implementation can
863 // be forwarded to the public stubs library when necessary.
864 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
865 }
866 }
867
868 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000869
Cole Faustb7493472024-08-28 11:55:52 -0700870 ctx.AddVariationDependencies(nil, staticLibTag, j.staticLibs(ctx)...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700871
872 // Add dependency on libraries that provide additional hidden api annotations.
873 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
874
Jaewoong Jung26342642021-03-17 15:56:23 -0700875 // For library dependencies that are component libraries (like stubs), add the implementation
876 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
877 for _, dep := range libDeps {
878 if dep != nil {
879 if component, ok := dep.(SdkLibraryComponentDependency); ok {
880 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000881 // Add library as optional if it's one of the optional compatibility libs or it's
882 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100883 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000884 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
Cole Faust64f2d842024-10-17 13:28:34 -0700885 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs.GetOrDefault(ctx, nil)) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100886 tag = usesLibOptTag
887 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100888 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700889 }
890 }
891 }
892 }
893
894 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Luca Stefani50098f72024-10-12 17:55:31 +0200895 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag, j.properties.Kotlin_plugins...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700896 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
897 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
898
899 android.ProtoDeps(ctx, &j.protoProperties)
900 if j.hasSrcExt(".proto") {
901 protoDeps(ctx, &j.protoProperties)
902 }
903
904 if j.hasSrcExt(".kt") {
905 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
906 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700907 tag := staticLibTag
908 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
909 tag = libTag
910 }
911 ctx.AddVariationDependencies(nil, tag,
912 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700913 }
914
915 // Framework libraries need special handling in static coverage builds: they should not have
916 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
917 // the same jacoco classes coming from different bootclasspath jars.
918 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
919 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
920 j.properties.Instrument = true
921 }
922 } else if j.shouldInstrumentStatic(ctx) {
923 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
924 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700925
Cole Faustb7493472024-08-28 11:55:52 -0700926 if j.useCompose(ctx) {
Colin Crossa1ff7c62021-09-17 14:11:52 -0700927 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
Dave Mankoff0a3ef842024-10-02 18:47:24 +0000928 "kotlin-compose-compiler-plugin")
Colin Crossa1ff7c62021-09-17 14:11:52 -0700929 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700930}
931
932func hasSrcExt(srcs []string, ext string) bool {
933 for _, src := range srcs {
934 if filepath.Ext(src) == ext {
935 return true
936 }
937 }
938
939 return false
940}
941
942func (j *Module) hasSrcExt(ext string) bool {
943 return hasSrcExt(j.properties.Srcs, ext)
944}
945
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100946func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
947 var flags string
948
949 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
950 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
951 flags = "-Wmissing-permission-annotation -Werror"
952 }
953 }
954 return flags
955}
956
Jaewoong Jung26342642021-03-17 15:56:23 -0700957func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000958 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700959
960 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
961 aidlIncludes = append(aidlIncludes,
962 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
963 aidlIncludes = append(aidlIncludes,
964 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
965
966 var flags []string
967 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000968 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700969
970 flags = append(flags, j.deviceProperties.Aidl.Flags...)
971
972 if aidlPreprocess.Valid() {
973 flags = append(flags, "-p"+aidlPreprocess.String())
974 deps = append(deps, aidlPreprocess.Path())
975 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000976 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700977 }
978
979 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000980 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700981 }
982
983 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000984 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700985 }
986
Sam Delmerico2351eac2022-05-24 17:10:02 +0000987 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700988 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000989 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700990 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000991 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
992 // add flags for dirs containing AIDL srcs that haven't been specified yet
993 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -0700994
Zim8774ae12022-08-17 11:46:34 +0100995 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +0000996 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +0100997 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700998 flags = append(flags, "-t")
999 }
1000
1001 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
1002 flags = append(flags, "--transaction_names")
1003 }
1004
Thiébaud Weksteende8417c2022-02-10 15:41:46 +11001005 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
1006 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
1007 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1008 }
1009
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001010 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001011 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1012
Jaewoong Jung26342642021-03-17 15:56:23 -07001013 return strings.Join(flags, " "), deps
1014}
1015
1016func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1017
1018 var flags javaBuilderFlags
1019
1020 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001021 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001022
Cole Faust2b1536e2021-06-18 12:25:54 -07001023 epEnabled := j.properties.Errorprone.Enabled
1024 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001025 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001026 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1027 }
1028
1029 errorProneFlags := []string{
1030 "-Xplugin:ErrorProne",
1031 "${config.ErrorProneChecks}",
1032 }
1033 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1034
Colin Cross8bf6cad2022-02-28 13:07:03 -08001035 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001036 "'" + strings.Join(errorProneFlags, " ") + "'"
1037 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1038 }
1039
1040 // classpath
1041 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1042 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001043 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001044 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1045 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1046 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1047
1048 flags.processors = append(flags.processors, deps.processorClasses...)
1049 flags.processors = android.FirstUniqueStrings(flags.processors)
1050
1051 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001052 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001053 // Give host-side tools a version of OpenJDK's standard libraries
1054 // close to what they're targeting. As of Dec 2017, AOSP is only
1055 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1056 //
1057 // When building with OpenJDK 8, the following should have no
1058 // effect since those jars would be available by default.
1059 //
1060 // When building with OpenJDK 9 but targeting a version < 1.8,
1061 // putting them on the bootclasspath means that:
1062 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1063 // b) references to existing APIs are not reinterpreted in an
1064 // OpenJDK 9-specific way, eg. calls to subclasses of
1065 // java.nio.Buffer as in http://b/70862583
1066 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1067 flags.bootClasspath = append(flags.bootClasspath,
1068 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1069 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1070 if Bool(j.properties.Use_tools_jar) {
1071 flags.bootClasspath = append(flags.bootClasspath,
1072 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1073 }
1074 }
1075
1076 // systemModules
1077 flags.systemModules = deps.systemModules
1078
Jaewoong Jung26342642021-03-17 15:56:23 -07001079 return flags
1080}
1081
1082func (j *Module) collectJavacFlags(
1083 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1084 // javac flags.
1085 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001086 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001087
Mythri Alle4b9f6182023-10-25 15:17:11 +00001088 needsDebugInfo = false
1089 for _, flag := range javacFlags {
1090 if strings.HasPrefix(flag, "-g") {
1091 needsDebugInfo = true
1092 }
1093 }
1094
1095 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001096 // For non-host binaries, override the -g flag passed globally to remove
1097 // local variable debug info to reduce disk and memory usage.
1098 javacFlags = append(javacFlags, "-g:source,lines")
1099 }
1100 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1101
1102 if flags.javaVersion.usesJavaModules() {
1103 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001104 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1105 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1106 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1107 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001108
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001109 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001110 if j.properties.Patch_module != nil {
1111 // Manually specify build directory in case it is not under the repo root.
1112 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1113 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001114 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001115
Jaewoong Jung26342642021-03-17 15:56:23 -07001116 classPath := flags.classpath.FormJavaClassPath("")
1117 if classPath != "" {
1118 patchPaths = append(patchPaths, classPath)
1119 }
1120 javacFlags = append(
1121 javacFlags,
1122 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1123 }
1124 }
1125
1126 if len(javacFlags) > 0 {
1127 // optimization.
1128 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1129 flags.javacFlags = "$javacFlags"
1130 }
1131
1132 return flags
1133}
1134
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001135func (j *Module) AddJSONData(d *map[string]interface{}) {
1136 (&j.ModuleBase).AddJSONData(d)
1137 (*d)["Java"] = map[string]interface{}{
1138 "SourceExtensions": j.sourceExtensions,
1139 }
1140
1141}
1142
usta0391ca42023-09-19 15:51:59 -04001143func (j *Module) addGeneratedSrcJars(path android.Path) {
1144 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001145}
1146
Colin Crossfdaa6722024-08-23 11:58:08 -07001147func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars, extraDepCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001148 // Auto-propagating jarjar rules
1149 jarjarProviderData := j.collectJarJarRules(ctx)
1150 if jarjarProviderData != nil {
1151 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wangddb2ee52024-04-02 16:44:02 +00001152 text := getJarJarRuleText(jarjarProviderData)
1153 if text != "" {
1154 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1155 android.WriteFileRule(ctx, ruleTextFile, text)
1156 j.repackageJarjarRules = ruleTextFile
Joe Onorato349ae8d2024-02-05 22:46:00 +00001157 }
1158 }
1159
Jaewoong Jung26342642021-03-17 15:56:23 -07001160 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1161
John Wu989ee842024-10-04 00:21:43 +00001162 // Only override the original value if explicitly set
1163 if j.properties.Ravenizer.Enabled != nil {
1164 j.ravenizer.enabled = *j.properties.Ravenizer.Enabled
Makoto Onuki7ded3822024-03-28 14:42:20 -07001165 }
1166
Jaewoong Jung26342642021-03-17 15:56:23 -07001167 deps := j.collectDeps(ctx)
1168 flags := j.collectBuilderFlags(ctx, deps)
1169
1170 if flags.javaVersion.usesJavaModules() {
1171 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001172 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1173 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1174 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001175 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001176
Jaewoong Jung26342642021-03-17 15:56:23 -07001177 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001178 j.sourceExtensions = []string{}
1179 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1180 if hasSrcExt(srcFiles.Strings(), ext) {
1181 j.sourceExtensions = append(j.sourceExtensions, ext)
1182 }
1183 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001184 if hasSrcExt(srcFiles.Strings(), ".proto") {
1185 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1186 }
1187
Dave Mankoff0a3ef842024-10-02 18:47:24 +00001188 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, j.properties.Exclude_common_srcs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001189 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1190 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1191 }
1192
Sam Delmerico2351eac2022-05-24 17:10:02 +00001193 aidlSrcs := srcFiles.FilterByExt(".aidl")
1194 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1195
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001196 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001197 srcFiles = j.genSources(ctx, srcFiles, flags)
1198
1199 // Collect javac flags only after computing the full set of srcFiles to
1200 // ensure that the --patch-module lookup paths are complete.
1201 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1202
1203 srcJars := srcFiles.FilterByExt(".srcjar")
1204 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001205 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001206 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001207 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001208
1209 if j.properties.Jarjar_rules != nil {
1210 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1211 }
1212
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001213 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001214
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001215 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001216 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001217 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001218 if _, found := set[v.String()]; !found {
1219 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001220 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001221 }
1222 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001223 var uniqueKtFiles android.Paths
1224 for _, v := range srcFiles.FilterByExt(".kt") {
1225 if _, found := set[v.String()]; !found {
1226 set[v.String()] = true
1227 uniqueKtFiles = append(uniqueKtFiles, v)
1228 }
1229 }
1230
1231 var uniqueSrcFiles android.Paths
1232 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1233 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1234 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001235 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001236
Colin Crossb5db4012022-03-28 17:12:39 -07001237 // We don't currently run annotation processors in turbine, which means we can't use turbine
1238 // generated header jars when an annotation processor that generates API is enabled. One
1239 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1240 // is used to run all of the annotation processors.
1241 disableTurbine := deps.disableTurbine
1242
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001243 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001244 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1245
Colin Cross220a9a12022-03-28 17:08:01 -07001246 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001247
Colin Cross4eae06d2023-06-20 22:40:02 -07001248 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1249 // any dependencies so that it can override any non-final R classes from dependencies with the
1250 // final R classes from the app.
1251 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1252
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001253 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1254
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001255 var localImplementationJars android.Paths
1256
Mark Whitea15790a2023-08-22 21:28:11 +00001257 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001258 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001259 if srcFiles.HasExt(".kt") {
1260 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1261 }
1262 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1263 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1264 }
1265
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001266 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1267
1268 localHeaderJars, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
Colin Crossedec77c2024-07-26 15:25:40 -07001269 extraCombinedJars)
1270
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001271 combinedHeaderJarFile, jarjared := j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1272 if jarjared {
1273 localHeaderJars = android.Paths{combinedHeaderJarFile}
1274 transitiveStaticLibsHeaderJars = nil
1275 }
1276 combinedHeaderJarFile, repackaged := j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
1277 if repackaged {
1278 localHeaderJars = android.Paths{combinedHeaderJarFile}
1279 transitiveStaticLibsHeaderJars = nil
1280 }
Mark Whitea15790a2023-08-22 21:28:11 +00001281 if ctx.Failed() {
1282 return
1283 }
Colin Crossedec77c2024-07-26 15:25:40 -07001284 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001285
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001286 if ctx.Config().UseTransitiveJarsInClasspath() {
1287 if len(localHeaderJars) > 0 {
1288 ctx.CheckbuildFile(localHeaderJars...)
1289 } else {
1290 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1291 ctx.UncheckedModule()
1292 }
1293 } else {
1294 ctx.CheckbuildFile(j.headerJarFile)
1295 }
Colin Crossa6182ab2024-08-21 10:47:44 -07001296
Colin Cross7727c7f2024-07-18 15:36:32 -07001297 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001298 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001299 LocalHeaderJars: localHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001300 TransitiveStaticLibsHeaderJars: depset.New(depset.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Cross9ffaf282024-08-12 13:50:09 -07001301 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1302 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001303 AidlIncludeDirs: j.exportAidlIncludeDirs,
1304 ExportedPlugins: j.exportedPluginJars,
1305 ExportedPluginClasses: j.exportedPluginClasses,
1306 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1307 StubsLinkType: j.stubsLinkType,
1308 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Yu Liu63bdf632024-12-03 19:54:05 +00001309 SdkVersion: j.SdkVersion(ctx),
Mark Whitea15790a2023-08-22 21:28:11 +00001310 })
1311
1312 j.outputFile = j.headerJarFile
1313 return
1314 }
1315
Jaewoong Jung26342642021-03-17 15:56:23 -07001316 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001317 // When using kotlin sources turbine is used to generate annotation processor sources,
1318 // including for annotation processors that generate API, so we can use turbine for
1319 // java sources too.
1320 disableTurbine = false
1321
Jaewoong Jung26342642021-03-17 15:56:23 -07001322 // user defined kotlin flags.
1323 kotlincFlags := j.properties.Kotlincflags
1324 CheckKotlincFlags(ctx, kotlincFlags)
1325
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001326 // Workaround for KT-46512
1327 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001328
1329 // If there are kotlin files, compile them first but pass all the kotlin and java files
1330 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1331 // won't emit any classes for them.
1332 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1333 if ctx.Device() {
1334 kotlincFlags = append(kotlincFlags, "-no-jdk")
1335 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001336
1337 for _, plugin := range deps.kotlinPlugins {
1338 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1339 }
1340 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1341
Jaewoong Jung26342642021-03-17 15:56:23 -07001342 if len(kotlincFlags) > 0 {
1343 // optimization.
1344 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1345 flags.kotlincFlags += "$kotlincFlags"
1346 }
1347
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001348 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001349 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1350
Jaewoong Jung26342642021-03-17 15:56:23 -07001351 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1352 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1353
Isaac Chioua23d9942022-04-06 06:14:38 +00001354 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001355 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001356 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1357 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001358 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001359 srcJars = append(srcJars, kaptSrcJar)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001360 localImplementationJars = append(localImplementationJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001361 // Disable annotation processing in javac, it's already been handled by kapt
1362 flags.processorPath = nil
1363 flags.processors = nil
1364 }
1365
1366 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001367 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Spandan Das1028d5a2024-08-19 21:45:48 +00001368 j.kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001369 if ctx.Failed() {
1370 return
1371 }
1372
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001373 kotlinJarPath, _ := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001374
Isaac Chioua23d9942022-04-06 06:14:38 +00001375 // Make javac rule depend on the kotlinc rule
1376 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1377
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001378 localImplementationJars = append(localImplementationJars, kotlinJarPath)
1379
Colin Cross220a9a12022-03-28 17:08:01 -07001380 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001381 }
1382
Jaewoong Jung26342642021-03-17 15:56:23 -07001383 j.compiledSrcJars = srcJars
1384
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001385 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1386
Jaewoong Jung26342642021-03-17 15:56:23 -07001387 enableSharding := false
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001388 var localHeaderJars android.Paths
1389 var shardingHeaderJars android.Paths
1390 var repackagedHeaderJarFile android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001391 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001392 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1393 enableSharding = true
1394 // Formerly, there was a check here that prevented annotation processors
1395 // from being used when sharding was enabled, as some annotation processors
1396 // do not function correctly in sharded environments. It was removed to
1397 // allow for the use of annotation processors that do function correctly
1398 // with sharding enabled. See: b/77284273.
1399 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001400 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001401 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001402 var combinedHeaderJarFile android.Path
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001403 localHeaderJars, combinedHeaderJarFile = j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
1404 shardingHeaderJars = localHeaderJars
Colin Crossedec77c2024-07-26 15:25:40 -07001405
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001406 var jarjared bool
1407 j.headerJarFile, jarjared = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1408 if jarjared {
1409 // jarjar modifies transitive static dependencies, use the combined header jar and drop the transitive
1410 // static libs header jars.
1411 localHeaderJars = android.Paths{j.headerJarFile}
1412 transitiveStaticLibsHeaderJars = nil
1413 }
1414 var repackaged bool
1415 repackagedHeaderJarFile, repackaged = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
1416 if repackaged {
1417 // repackage modifies transitive static dependencies, use the combined header jar and drop the transitive
1418 // static libs header jars.
1419 // TODO(b/356688296): this shouldn't export both the unmodified and repackaged header jars
1420 localHeaderJars = android.Paths{j.headerJarFile, repackagedHeaderJarFile}
1421 transitiveStaticLibsHeaderJars = nil
1422 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001423 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001424 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001425 hasErrorproneableFiles := false
1426 for _, ext := range j.sourceExtensions {
1427 if ext != ".proto" && ext != ".aidl" {
1428 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1429 // compile, and it's not useful to have warnings on these generated sources.
1430 hasErrorproneableFiles = true
1431 break
1432 }
1433 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001434 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001435 if Bool(j.properties.Errorprone.Enabled) {
1436 // If error-prone is enabled, enable errorprone flags on the regular
1437 // build.
1438 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001439 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001440 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1441 // a new jar file just for compiling with the errorprone compiler to.
1442 // This is because we don't want to cause the java files to get completely
1443 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1444 // We also don't want to run this if errorprone is enabled by default for
1445 // this module, or else we could have duplicated errorprone messages.
1446 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001447 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001448 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001449
Vadim Spivak3c496f02023-06-08 06:14:59 +00001450 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001451 "errorprone", "errorprone")
1452
Jaewoong Jung26342642021-03-17 15:56:23 -07001453 extraJarDeps = append(extraJarDeps, errorprone)
1454 }
1455
1456 if enableSharding {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001457 if len(shardingHeaderJars) > 0 {
1458 flags.classpath = append(classpath(slices.Clone(shardingHeaderJars)), flags.classpath...)
Colin Cross3d56ed52021-11-18 22:23:12 -08001459 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001460 shardSize := int(*(j.properties.Javac_shard_size))
1461 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001462 if len(uniqueJavaFiles) > 0 {
1463 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001464 for idx, shardSrc := range shardSrcs {
1465 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1466 nil, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001467 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
1468 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001469 }
1470 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001471 // Assume approximately 5 sources per srcjar.
1472 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1473 // 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 -07001474 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001475 startIdx := len(shardSrcs)
1476 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1477 for idx, shardSrcJars := range shardSrcJarsList {
1478 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1479 nil, shardSrcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001480 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
1481 localImplementationJars = append(localImplementationJars, classes)
Colin Crossa052ddb2023-09-25 21:46:58 -07001482 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001483 }
1484 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001485 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001486 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
1487 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001488 }
1489 if ctx.Failed() {
1490 return
1491 }
1492 }
1493
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001494 localImplementationJars = append(localImplementationJars, extraCombinedJars...)
Colin Crossfd620b22024-02-23 10:05:21 -08001495
Jaewoong Jung26342642021-03-17 15:56:23 -07001496 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1497
1498 var includeSrcJar android.WritablePath
1499 if Bool(j.properties.Include_srcs) {
1500 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1501 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1502 }
1503
1504 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1505 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Cole Faust7fd5b2e2024-10-29 11:22:20 -07001506 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources.GetOrDefault(ctx, nil), j.properties.Exclude_java_resources)
1507 fileArgs2, fileDeps2 := ResourceFilesToJarArgs(ctx, j.properties.Device_common_java_resources.GetOrDefault(ctx, nil), nil)
1508 fileArgs3, fileDeps3 := ResourceFilesToJarArgs(ctx, j.properties.Device_first_java_resources.GetOrDefault(ctx, nil), nil)
Cole Faust65cb40a2024-10-21 15:41:42 -07001509 fileArgs = slices.Concat(fileArgs, fileArgs2, fileArgs3)
1510 fileDeps = slices.Concat(fileDeps, fileDeps2, fileDeps3)
Jaewoong Jung26342642021-03-17 15:56:23 -07001511 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1512
1513 var resArgs []string
1514 var resDeps android.Paths
1515
1516 resArgs = append(resArgs, dirArgs...)
1517 resDeps = append(resDeps, dirDeps...)
1518
1519 resArgs = append(resArgs, fileArgs...)
1520 resDeps = append(resDeps, fileDeps...)
1521
1522 resArgs = append(resArgs, extraArgs...)
1523 resDeps = append(resDeps, extraDeps...)
1524
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001525 var localResourceJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001526 if len(resArgs) > 0 {
1527 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1528 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001529 if ctx.Failed() {
1530 return
1531 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001532 localResourceJars = append(localResourceJars, resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001533 }
1534
Jaewoong Jung26342642021-03-17 15:56:23 -07001535 if Bool(j.properties.Include_srcs) {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001536 localResourceJars = append(localResourceJars, includeSrcJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001537 }
1538
1539 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1540 if len(services) > 0 {
1541 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1542 var zipargs []string
1543 for _, file := range services {
1544 serviceFile := file.String()
1545 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1546 }
1547 rule := zip
1548 args := map[string]string{
1549 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1550 }
1551 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1552 rule = zipRE
1553 args["implicits"] = strings.Join(services.Strings(), ",")
1554 }
1555 ctx.Build(pctx, android.BuildParams{
1556 Rule: rule,
1557 Output: servicesJar,
1558 Implicits: services,
1559 Args: args,
1560 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001561 localResourceJars = append(localResourceJars, servicesJar)
1562 }
1563
Colin Crossa14fb6a2024-10-23 16:57:06 -07001564 completeStaticLibsResourceJars := depset.New(depset.PREORDER, localResourceJars, deps.transitiveStaticLibsResourceJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001565
1566 var combinedResourceJar android.Path
1567 var resourceJars android.Paths
1568 if ctx.Config().UseTransitiveJarsInClasspath() {
1569 resourceJars = completeStaticLibsResourceJars.ToList()
1570 } else {
1571 resourceJars = append(slices.Clone(localResourceJars), deps.staticResourceJars...)
1572 }
1573 if len(resourceJars) == 1 {
1574 combinedResourceJar = resourceJars[0]
1575 } else if len(resourceJars) > 0 {
1576 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1577 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1578 false, nil, nil)
1579 combinedResourceJar = combinedJar
1580 }
1581
1582 manifest := j.overrideManifest
1583 if !manifest.Valid() && j.properties.Manifest != nil {
1584 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Jaewoong Jung26342642021-03-17 15:56:23 -07001585 }
1586
1587 // Combine the classes built from sources, any manifests, and any static libraries into
1588 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001589 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001590
Colin Crossa14fb6a2024-10-23 16:57:06 -07001591 completeStaticLibsImplementationJars := depset.New(depset.PREORDER, localImplementationJars, deps.transitiveStaticLibsImplementationJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001592
1593 var jars android.Paths
1594 if ctx.Config().UseTransitiveJarsInClasspath() {
1595 jars = completeStaticLibsImplementationJars.ToList()
1596 } else {
1597 jars = append(slices.Clone(localImplementationJars), deps.staticJars...)
1598 }
1599
1600 jars = append(jars, extraDepCombinedJars...)
1601
Jaewoong Jung26342642021-03-17 15:56:23 -07001602 if len(jars) == 1 && !manifest.Valid() {
1603 // Optimization: skip the combine step as there is nothing to do
1604 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1605 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001606 // any if len(extraJars) == 0.
Jaewoong Jung26342642021-03-17 15:56:23 -07001607
Jihoon Kang1147b312023-06-08 23:25:57 +00001608 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1609 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1610 // either with .from-source or .from-text suffix.
1611 // outputFile should be agnostic to the build configuration,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001612 // thus copy the single input static lib in order to prevent the static lib from being exposed
Jihoon Kang1147b312023-06-08 23:25:57 +00001613 // to the copy rules.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001614 if stub, _ := moduleStubLinkType(j); stub {
1615 copiedJar := android.PathForModuleOut(ctx, "combined", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001616 ctx.Build(pctx, android.BuildParams{
1617 Rule: android.Cp,
1618 Input: jars[0],
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001619 Output: copiedJar,
Jaewoong Jung26342642021-03-17 15:56:23 -07001620 })
Colin Crossa14fb6a2024-10-23 16:57:06 -07001621 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, android.Paths{copiedJar}, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001622 outputFile = copiedJar
Colin Cross7707b242024-07-26 12:02:36 -07001623 } else {
1624 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001625 }
1626 } else {
1627 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1628 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1629 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001630 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001631 }
1632
1633 // jarjar implementation jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001634 jarjarFile, jarjarred := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1635 if jarjarred {
1636 localImplementationJars = android.Paths{jarjarFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001637 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001638 }
Colin Crossedec77c2024-07-26 15:25:40 -07001639 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001640
Colin Crossedec77c2024-07-26 15:25:40 -07001641 // jarjar resource jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001642 if combinedResourceJar != nil {
1643 resourceJarJarFile, jarjarred := j.jarjarIfNecessary(ctx, combinedResourceJar, jarName, "resource")
1644 combinedResourceJar = resourceJarJarFile
1645 if jarjarred {
1646 localResourceJars = android.Paths{resourceJarJarFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001647 completeStaticLibsResourceJars = depset.New(depset.PREORDER, localResourceJars, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001648 }
Colin Crossedec77c2024-07-26 15:25:40 -07001649 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001650
Colin Crossedec77c2024-07-26 15:25:40 -07001651 if ctx.Failed() {
1652 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001653 }
1654
Makoto Onuki7ded3822024-03-28 14:42:20 -07001655 if j.ravenizer.enabled {
1656 ravenizerInput := outputFile
John Wub67040d2024-10-07 18:39:06 +00001657 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", "", jarName)
John Wu989ee842024-10-04 00:21:43 +00001658 ravenizerArgs := ""
1659 if proptools.Bool(j.properties.Ravenizer.Strip_mockito) {
1660 ravenizerArgs = "--strip-mockito"
1661 }
1662 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
Makoto Onuki7ded3822024-03-28 14:42:20 -07001663 outputFile = ravenizerOutput
Colin Cross7e863852024-09-06 14:42:38 -07001664 localImplementationJars = android.Paths{ravenizerOutput}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001665 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001666 if combinedResourceJar != nil {
1667 ravenizerInput = combinedResourceJar
1668 ravenizerOutput = android.PathForModuleOut(ctx, "ravenizer", "resources", jarName)
1669 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
1670 combinedResourceJar = ravenizerOutput
1671 localResourceJars = android.Paths{ravenizerOutput}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001672 completeStaticLibsResourceJars = depset.New(depset.PREORDER, localResourceJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001673 }
Makoto Onuki7ded3822024-03-28 14:42:20 -07001674 }
1675
Yihan Dong8be09c22024-08-29 15:32:13 +08001676 if j.shouldApiMapper() {
1677 inputFile := outputFile
1678 apiMapperFile := android.PathForModuleOut(ctx, "apimapper", jarName)
1679 ctx.Build(pctx, android.BuildParams{
1680 Rule: apimapper,
1681 Description: "apimapper",
1682 Input: inputFile,
1683 Output: apiMapperFile,
1684 })
1685 outputFile = apiMapperFile
Colin Cross7e863852024-09-06 14:42:38 -07001686 localImplementationJars = android.Paths{apiMapperFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001687 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Yihan Dong8be09c22024-08-29 15:32:13 +08001688 }
1689
Jaewoong Jung26342642021-03-17 15:56:23 -07001690 // Check package restrictions if necessary.
1691 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001692 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001693 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001694
1695 // Create a rule to copy the output jar to another path and add a validate dependency that
1696 // will check that the jar only contains the permitted packages. The new location will become
1697 // the output file of this module.
1698 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001699 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001700 ctx.Build(pctx, android.BuildParams{
1701 Rule: android.Cp,
1702 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001703 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001704 // Make sure that any dependency on the output file will cause ninja to run the package check
1705 // rule.
1706 Validation: pkgckFile,
1707 })
Colin Cross7707b242024-07-26 12:02:36 -07001708 outputFile = packageCheckOutputFile
Colin Cross7e863852024-09-06 14:42:38 -07001709 localImplementationJars = android.Paths{packageCheckOutputFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001710 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001711
1712 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001713 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001714
1715 if ctx.Failed() {
1716 return
1717 }
1718 }
1719
1720 j.implementationJarFile = outputFile
1721 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001722 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1723 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1724 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1725 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1726 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1727 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1728 j.headerJarFile = headerJarFile
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001729 if len(localImplementationJars) == 1 && ctx.Config().UseTransitiveJarsInClasspath() {
1730 localHeaderJarFile := android.PathForModuleOut(ctx, "local-javac-header", jarName)
1731 convertImplementationJarToHeaderJar(ctx, localImplementationJars[0], localHeaderJarFile)
1732 localHeaderJars = append(localHeaderJars, localHeaderJarFile)
1733 } else {
1734 localHeaderJars = append(localHeaderJars, headerJarFile)
1735 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001736 }
1737
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001738 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1739 specs := j.jacocoModuleToZipCommand(ctx)
1740 if ctx.Failed() {
1741 return
1742 }
1743
Colin Crossb323c912024-09-24 15:21:00 -07001744 completeStaticLibsImplementationJarsToCombine := completeStaticLibsImplementationJars
1745
Colin Cross41698982024-11-13 11:31:31 -08001746 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Colin Crosse4f34882024-11-14 12:26:00 -08001747
1748 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
1749 compileDex := Bool(j.dexProperties.Compile_dex) || Bool(j.properties.Installable)
Colin Cross41698982024-11-13 11:31:31 -08001750
1751 if j.shouldInstrument(ctx) && (!ctx.Device() || compileDex) {
Colin Crossb323c912024-09-24 15:21:00 -07001752 instrumentedOutputFile := j.instrument(ctx, flags, outputFile, jarName, specs)
Colin Crossa14fb6a2024-10-23 16:57:06 -07001753 completeStaticLibsImplementationJarsToCombine = depset.New(depset.PREORDER, android.Paths{instrumentedOutputFile}, nil)
Colin Crossb323c912024-09-24 15:21:00 -07001754 outputFile = instrumentedOutputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001755 }
1756
1757 // merge implementation jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001758 var implementationAndResourcesJarsToCombine android.Paths
1759 if ctx.Config().UseTransitiveJarsInClasspath() {
1760 resourceJars := completeStaticLibsResourceJars.ToList()
1761 if len(resourceJars) > 0 {
Colin Crossb323c912024-09-24 15:21:00 -07001762 implementationAndResourcesJarsToCombine = append(resourceJars, completeStaticLibsImplementationJarsToCombine.ToList()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001763 implementationAndResourcesJarsToCombine = append(implementationAndResourcesJarsToCombine, extraDepCombinedJars...)
1764 }
1765 } else {
1766 if combinedResourceJar != nil {
1767 implementationAndResourcesJarsToCombine = android.Paths{combinedResourceJar, outputFile}
1768 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001769 }
1770
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001771 if len(implementationAndResourcesJarsToCombine) > 0 {
1772 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
1773 TransformJarsToJar(ctx, combinedJar, "for resources", implementationAndResourcesJarsToCombine, manifest,
1774 false, nil, nil)
1775 outputFile = combinedJar
1776 }
1777
1778 j.implementationAndResourcesJar = outputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001779
Colin Cross41698982024-11-13 11:31:31 -08001780 if ctx.Device() && compileDex {
Jaewoong Jung26342642021-03-17 15:56:23 -07001781 if j.hasCode(ctx) {
1782 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001783 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001784 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1785 }
1786 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001787 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001788 params := &compileDexParams{
1789 flags: flags,
1790 sdkVersion: j.SdkVersion(ctx),
1791 minSdkVersion: j.MinSdkVersion(ctx),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001792 classesJar: outputFile,
Spandan Dasc404cc72023-02-23 18:05:05 +00001793 jarName: jarName,
1794 }
Cole Fausteb032462024-09-19 11:12:54 -07001795 if j.GetProfileGuided(ctx) && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting(ctx) {
Spandan Das15a67112024-05-30 00:07:40 +00001796 ctx.PropertyErrorf("enable_profile_rewriting",
1797 "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.",
1798 )
1799 }
Cole Fausteb032462024-09-19 11:12:54 -07001800 if j.EnableProfileRewriting(ctx) {
1801 profile := j.GetProfile(ctx)
1802 if profile == "" || !j.GetProfileGuided(ctx) {
Spandan Das3dbda182024-05-20 22:23:10 +00001803 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1804 }
1805 params.artProfileInput = &profile
1806 }
1807 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001808 if ctx.Failed() {
1809 return
1810 }
1811
Spandan Das3dbda182024-05-20 22:23:10 +00001812 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1813 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001814 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001815 }
1816
Jaewoong Jung26342642021-03-17 15:56:23 -07001817 // merge dex jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001818 var dexAndResourceJarsToCombine android.Paths
1819 if ctx.Config().UseTransitiveJarsInClasspath() {
1820 resourceJars := completeStaticLibsResourceJars.ToList()
1821 if len(resourceJars) > 0 {
1822 dexAndResourceJarsToCombine = append(android.Paths{dexOutputFile}, resourceJars...)
1823 }
1824 } else {
1825 if combinedResourceJar != nil {
1826 dexAndResourceJarsToCombine = android.Paths{dexOutputFile, combinedResourceJar}
1827 }
1828 }
1829 if len(dexAndResourceJarsToCombine) > 0 {
Colin Cross7707b242024-07-26 12:02:36 -07001830 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001831 TransformJarsToJar(ctx, combinedJar, "for dex resources", dexAndResourceJarsToCombine, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001832 false, nil, nil)
1833 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001834 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001835 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001836 dexOutputFile = combinedAlignedJar
1837 } else {
1838 dexOutputFile = combinedJar
1839 }
1840 }
1841
Paul Duffin4de94502021-05-16 05:21:16 +01001842 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001843
1844 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001845
1846 // Encode hidden API flags in dex file, if needed.
1847 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1848
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001849 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001850
1851 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001852 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1853 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1854 libName = strings.TrimSuffix(libName, ".impl")
1855 }
1856 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001857
1858 outputFile = dexOutputFile
Colin Crossa6182ab2024-08-21 10:47:44 -07001859
1860 ctx.CheckbuildFile(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001861 } else {
1862 // There is no code to compile into a dex jar, make sure the resources are propagated
1863 // to the APK if this is an app.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001864 j.dexJarFile = makeDexJarPathFromPath(combinedResourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001865 }
1866
1867 if ctx.Failed() {
1868 return
1869 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001870 }
1871
1872 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001873 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001874 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001875 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001876 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001877 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001878 }
1879 }
1880
1881 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001882 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1883 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001884 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1885 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001886 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001887 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001888 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001889 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001890 j.linter.javaLanguageLevel = flags.javaVersion.String()
1891 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001892 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001893 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1894 j.linter.buildModuleReportZip = true
1895 }
1896 j.linter.lint(ctx)
1897 }
1898
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001899 j.collectTransitiveSrcFiles(ctx, srcFiles)
1900
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001901 if ctx.Config().UseTransitiveJarsInClasspath() {
1902 if len(localImplementationJars) > 0 || len(localResourceJars) > 0 || len(localHeaderJars) > 0 {
1903 ctx.CheckbuildFile(localImplementationJars...)
1904 ctx.CheckbuildFile(localResourceJars...)
1905 ctx.CheckbuildFile(localHeaderJars...)
1906 } else {
1907 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1908 ctx.UncheckedModule()
1909 }
1910 } else {
1911 ctx.CheckbuildFile(j.implementationJarFile)
1912 ctx.CheckbuildFile(j.headerJarFile)
1913 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001914
Colin Cross7727c7f2024-07-18 15:36:32 -07001915 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001916 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1917 RepackagedHeaderJars: android.PathsIfNonNil(repackagedHeaderJarFile),
1918
1919 LocalHeaderJars: localHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001920 TransitiveStaticLibsHeaderJars: depset.New(depset.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001921 TransitiveStaticLibsImplementationJars: completeStaticLibsImplementationJars,
1922 TransitiveStaticLibsResourceJars: completeStaticLibsResourceJars,
1923
Colin Cross9ffaf282024-08-12 13:50:09 -07001924 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1925 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001926 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1927 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001928 ResourceJars: android.PathsIfNonNil(combinedResourceJar),
Jihoon Kang705e63e2024-03-13 01:21:16 +00001929 AidlIncludeDirs: j.exportAidlIncludeDirs,
1930 SrcJarArgs: j.srcJarArgs,
1931 SrcJarDeps: j.srcJarDeps,
1932 TransitiveSrcFiles: j.transitiveSrcFiles,
1933 ExportedPlugins: j.exportedPluginJars,
1934 ExportedPluginClasses: j.exportedPluginClasses,
1935 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1936 JacocoReportClassesFile: j.jacocoReportClassesFile,
1937 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001938 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Yu Liu63bdf632024-12-03 19:54:05 +00001939 SdkVersion: j.SdkVersion(ctx),
Jaewoong Jung26342642021-03-17 15:56:23 -07001940 })
1941
1942 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1943 j.outputFile = outputFile.WithoutRel()
1944}
1945
Cole Faustb7493472024-08-28 11:55:52 -07001946func (j *Module) useCompose(ctx android.BaseModuleContext) bool {
1947 return android.InList("androidx.compose.runtime_runtime", j.staticLibs(ctx))
Colin Crossa1ff7c62021-09-17 14:11:52 -07001948}
1949
Colin Crossa14fb6a2024-10-23 16:57:06 -07001950func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []depset.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001951 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001952 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001953 depTag := ctx.OtherModuleDependencyTag(m)
1954
Colin Crossa14fb6a2024-10-23 16:57:06 -07001955 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1956 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
Sam Delmerico95d70942023-08-02 18:00:35 -04001957
Colin Crossa14fb6a2024-10-23 16:57:06 -07001958 if depTag == staticLibTag {
Sam Delmerico95d70942023-08-02 18:00:35 -04001959 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1960 }
1961 })
1962
Colin Crosscde55342024-03-27 14:11:51 -07001963 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1964}
1965
1966func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1967 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1968
Sam Delmerico95d70942023-08-02 18:00:35 -04001969 directUnconditionalExportedFlags := android.Paths{}
1970 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1971 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1972 if exportUnconditionally {
1973 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1974 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1975 directUnconditionalExportedFlags = proguardFlagsForThisModule
1976 }
1977
1978 return ProguardSpecInfo{
1979 Export_proguard_flags_files: exportUnconditionally,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001980 ProguardFlagsFiles: depset.New[android.Path](
1981 depset.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04001982 proguardFlagsForThisModule,
1983 transitiveProguardFlags,
1984 ),
Colin Crossa14fb6a2024-10-23 16:57:06 -07001985 UnconditionallyExportedProguardFlags: depset.New[android.Path](
1986 depset.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04001987 directUnconditionalExportedFlags,
1988 transitiveUnconditionalExportedFlags,
1989 ),
1990 }
1991
1992}
1993
Cole Faust75fffb12021-06-13 15:23:16 -07001994// Returns a copy of the supplied flags, but with all the errorprone-related
1995// fields copied to the regular build's fields.
1996func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1997 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1998
1999 if len(flags.errorProneExtraJavacFlags) > 0 {
2000 if len(flags.javacFlags) > 0 {
2001 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
2002 } else {
2003 flags.javacFlags = flags.errorProneExtraJavacFlags
2004 }
2005 }
2006 return flags
2007}
2008
Jaewoong Jung26342642021-03-17 15:56:23 -07002009func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07002010 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002011
2012 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00002013 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002014 if idx >= 0 {
2015 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00002016 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002017 jarName += strconv.Itoa(idx)
2018 }
2019
Colin Cross7707b242024-07-26 12:02:36 -07002020 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00002021 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07002022
Cole Faust9decf832024-06-11 11:45:53 -07002023 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002024 extractionFile := android.PathForModuleOut(ctx, kzipName)
2025 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
2026 j.kytheFiles = append(j.kytheFiles, extractionFile)
2027 }
2028
Vadim Spivak3c496f02023-06-08 06:14:59 +00002029 if len(flags.processorPath) > 0 {
2030 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
2031 }
2032
Jaewoong Jung26342642021-03-17 15:56:23 -07002033 return classes
2034}
2035
2036// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
2037// since some of these flags may be used internally.
2038func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
2039 for _, flag := range flags {
2040 flag = strings.TrimSpace(flag)
2041
2042 if !strings.HasPrefix(flag, "-") {
2043 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
2044 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
2045 ctx.PropertyErrorf("kotlincflags",
2046 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
2047 } else if inList(flag, config.KotlincIllegalFlags) {
2048 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
2049 } else if flag == "-include-runtime" {
2050 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
2051 } else {
2052 args := strings.Split(flag, " ")
2053 if args[0] == "-kotlin-home" {
2054 ctx.PropertyErrorf("kotlincflags",
2055 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
2056 }
2057 }
2058 }
2059}
2060
2061func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
2062 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002063 extraJars android.Paths) (localHeaderJars android.Paths, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002064
Jaewoong Jung26342642021-03-17 15:56:23 -07002065 if len(srcFiles) > 0 || len(srcJars) > 0 {
2066 // Compile java sources into turbine.jar.
2067 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
2068 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002069 localHeaderJars = append(localHeaderJars, turbineJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07002070 }
2071
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002072 localHeaderJars = append(localHeaderJars, extraJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002073
2074 // Combine any static header libraries into classes-header.jar. If there is only
2075 // one input jar this step will be skipped.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002076 var jars android.Paths
2077 if ctx.Config().UseTransitiveJarsInClasspath() {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002078 depSet := depset.New(depset.PREORDER, localHeaderJars, deps.transitiveStaticLibsHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002079 jars = depSet.ToList()
2080 } else {
2081 jars = append(slices.Clone(localHeaderJars), deps.staticHeaderJars...)
2082 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002083
2084 // we cannot skip the combine step for now if there is only one jar
2085 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07002086 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
2087 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07002088 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07002089
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002090 return localHeaderJars, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07002091}
2092
2093func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07002094 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002095
2096 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07002097 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07002098
2099 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
2100
2101 j.jacocoReportClassesFile = jacocoReportClassesFile
2102
2103 return instrumentedJar
2104}
2105
Colin Cross9ffaf282024-08-12 13:50:09 -07002106type providesTransitiveHeaderJarsForR8 struct {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002107 // set of header jars for all transitive libs deps
Colin Crossa14fb6a2024-10-23 16:57:06 -07002108 transitiveLibsHeaderJarsForR8 depset.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002109 // set of header jars for all transitive static libs deps
Colin Crossa14fb6a2024-10-23 16:57:06 -07002110 transitiveStaticLibsHeaderJarsForR8 depset.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002111}
2112
Colin Cross9ffaf282024-08-12 13:50:09 -07002113// collectTransitiveHeaderJarsForR8 visits direct dependencies and collects all transitive libs and static_libs
2114// header jars. The semantics of the collected jars are odd (it collects combined jars that contain the static
2115// libs, but also the static libs, and it collects transitive libs dependencies of static_libs), so these
2116// are only used to expand the --lib arguments to R8.
2117func (j *providesTransitiveHeaderJarsForR8) collectTransitiveHeaderJarsForR8(ctx android.ModuleContext) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002118 directLibs := android.Paths{}
2119 directStaticLibs := android.Paths{}
Colin Crossa14fb6a2024-10-23 16:57:06 -07002120 transitiveLibs := []depset.DepSet[android.Path]{}
2121 transitiveStaticLibs := []depset.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002122 ctx.VisitDirectDeps(func(module android.Module) {
2123 // don't add deps of the prebuilt version of the same library
2124 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
2125 return
2126 }
2127
Colin Cross7727c7f2024-07-18 15:36:32 -07002128 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2129 tag := ctx.OtherModuleDependencyTag(module)
2130 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2131 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2132 directLibs = append(directLibs, dep.HeaderJars...)
2133 } else if tag == staticLibTag {
2134 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2135 } else {
2136 // Don't propagate transitive libs for other kinds of dependencies.
2137 return
2138 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002139
Colin Crossa14fb6a2024-10-23 16:57:06 -07002140 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJarsForR8)
2141 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJarsForR8)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002142 }
2143 })
Colin Crossa14fb6a2024-10-23 16:57:06 -07002144 j.transitiveLibsHeaderJarsForR8 = depset.New(depset.POSTORDER, directLibs, transitiveLibs)
2145 j.transitiveStaticLibsHeaderJarsForR8 = depset.New(depset.POSTORDER, directStaticLibs, transitiveStaticLibs)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002146}
2147
Jaewoong Jung26342642021-03-17 15:56:23 -07002148func (j *Module) HeaderJars() android.Paths {
2149 if j.headerJarFile == nil {
2150 return nil
2151 }
2152 return android.Paths{j.headerJarFile}
2153}
2154
2155func (j *Module) ImplementationJars() android.Paths {
2156 if j.implementationJarFile == nil {
2157 return nil
2158 }
2159 return android.Paths{j.implementationJarFile}
2160}
2161
Spandan Das59a4a2b2024-01-09 21:35:56 +00002162func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002163 return j.dexJarFile
2164}
2165
2166func (j *Module) DexJarInstallPath() android.Path {
2167 return j.installFile
2168}
2169
2170func (j *Module) ImplementationAndResourcesJars() android.Paths {
2171 if j.implementationAndResourcesJar == nil {
2172 return nil
2173 }
2174 return android.Paths{j.implementationAndResourcesJar}
2175}
2176
2177func (j *Module) AidlIncludeDirs() android.Paths {
2178 // exportAidlIncludeDirs is type android.Paths already
2179 return j.exportAidlIncludeDirs
2180}
2181
2182func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2183 return j.classLoaderContexts
2184}
2185
2186// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002187func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002188 if j.expandJarjarRules != nil {
2189 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Das096b8d62024-10-08 22:41:26 +00002190 // Add the header jar so that the rdeps can be resolved to the repackaged classes.
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002191 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
Jaewoong Jung26342642021-03-17 15:56:23 -07002192 }
Spandan Das096b8d62024-10-08 22:41:26 +00002193 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2194 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2195 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002196 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2197 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Cole Faustb7493472024-08-28 11:55:52 -07002198 dpInfo.Static_libs = append(dpInfo.Static_libs, j.staticLibs(ctx)...)
Yikef6282022022-04-13 20:41:01 +08002199 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002200}
2201
2202func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002203 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002204}
2205
2206func (j *Module) hasCode(ctx android.ModuleContext) bool {
2207 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2208 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2209}
2210
2211// Implements android.ApexModule
2212func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2213 return j.depIsInSameApex(ctx, dep)
2214}
2215
2216// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002217func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002218 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002219 minSdkVersion := j.MinSdkVersion(ctx)
2220 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002221 return fmt.Errorf("min_sdk_version is not specified")
2222 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002223 // If the module is compiling against core (via sdk_version), skip comparison check.
2224 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002225 return nil
2226 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002227 if minSdkVersion.GreaterThan(sdkVersion) {
2228 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002229 }
2230 return nil
2231}
2232
2233func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002234 if j.stem == "" {
2235 panic("Stem() called before stem property was set")
2236 }
2237 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002238}
2239
Jaewoong Jung26342642021-03-17 15:56:23 -07002240func (j *Module) JacocoReportClassesFile() android.Path {
2241 return j.jacocoReportClassesFile
2242}
2243
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002244func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002245 var fromDeps []depset.DepSet[android.Path]
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002246 ctx.VisitDirectDeps(func(module android.Module) {
2247 tag := ctx.OtherModuleDependencyTag(module)
2248 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002249 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002250 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002251 }
2252 }
2253 })
2254
Colin Crossa14fb6a2024-10-23 16:57:06 -07002255 j.transitiveSrcFiles = depset.New(depset.POSTORDER, mine, fromDeps)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002256}
2257
Jaewoong Jung26342642021-03-17 15:56:23 -07002258func (j *Module) IsInstallable() bool {
2259 return Bool(j.properties.Installable)
2260}
2261
2262type sdkLinkType int
2263
2264const (
2265 // TODO(jiyong) rename these for better readability. Make the allowed
2266 // and disallowed link types explicit
2267 // order is important here. See rank()
2268 javaCore sdkLinkType = iota
2269 javaSdk
2270 javaSystem
2271 javaModule
2272 javaSystemServer
2273 javaPlatform
2274)
2275
2276func (lt sdkLinkType) String() string {
2277 switch lt {
2278 case javaCore:
2279 return "core Java API"
2280 case javaSdk:
2281 return "Android API"
2282 case javaSystem:
2283 return "system API"
2284 case javaModule:
2285 return "module API"
2286 case javaSystemServer:
2287 return "system server API"
2288 case javaPlatform:
2289 return "private API"
2290 default:
2291 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2292 }
2293}
2294
2295// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2296// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2297// can't statically depend on modules that use Platform API.
2298func (lt sdkLinkType) rank() int {
2299 return int(lt)
2300}
2301
2302type moduleWithSdkDep interface {
2303 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002304 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002305}
2306
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002307func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2308 switch k {
2309 case android.SdkCore:
2310 return javaCore
2311 case android.SdkSystem:
2312 return javaSystem
2313 case android.SdkPublic:
2314 return javaSdk
2315 case android.SdkModule:
2316 return javaModule
2317 case android.SdkSystemServer:
2318 return javaSystemServer
2319 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2320 return javaPlatform
2321 default:
2322 return javaSdk
2323 }
2324}
2325
Jiyong Park92315372021-04-02 08:45:46 +09002326func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002327 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002328 case android.SdkCore.DefaultJavaLibraryName(),
2329 "legacy.core.platform.api.stubs",
2330 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002331 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002332 "core-lambda-stubs",
Colin Crosse4f34882024-11-14 12:26:00 -08002333 "core-generated-annotation-stubs",
2334 // jacocoagent only uses core APIs, but has to specify a non-core sdk_version so it can use
2335 // a prebuilt SDK to avoid circular dependencies when it statically included in the bootclasspath.
2336 "jacocoagent":
Jaewoong Jung26342642021-03-17 15:56:23 -07002337 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002338 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002339 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002340 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002341 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002342 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002343 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002344 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002345 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002346 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002347 return javaSystem, true
2348 }
2349
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002350 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002351 return linkType, true
2352 }
2353
Jiyong Park92315372021-04-02 08:45:46 +09002354 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002355 if !ver.Valid() {
2356 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002357 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002358
2359 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002360}
2361
2362// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2363// this module's. See the comment on rank() for details and an example.
2364func (j *Module) checkSdkLinkType(
2365 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2366 if ctx.Host() {
2367 return
2368 }
2369
Jiyong Park92315372021-04-02 08:45:46 +09002370 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002371 if stubs {
2372 return
2373 }
Jiyong Park92315372021-04-02 08:45:46 +09002374 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002375
2376 if myLinkType.rank() < depLinkType.rank() {
2377 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2378 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2379 "property of the source or target module so that target module is built "+
2380 "with the same or smaller API set when compared to the source.",
2381 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2382 }
2383}
2384
2385func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2386 var deps deps
2387
Jiyong Park92315372021-04-02 08:45:46 +09002388 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002389
Colin Cross9ffaf282024-08-12 13:50:09 -07002390 j.collectTransitiveHeaderJarsForR8(ctx)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002391
Colin Crossa14fb6a2024-10-23 16:57:06 -07002392 var transitiveBootClasspathHeaderJars []depset.DepSet[android.Path]
2393 var transitiveClasspathHeaderJars []depset.DepSet[android.Path]
2394 var transitiveJava9ClasspathHeaderJars []depset.DepSet[android.Path]
2395 var transitiveStaticJarsHeaderLibs []depset.DepSet[android.Path]
2396 var transitiveStaticJarsImplementationLibs []depset.DepSet[android.Path]
2397 var transitiveStaticJarsResourceLibs []depset.DepSet[android.Path]
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002398
Jaewoong Jung26342642021-03-17 15:56:23 -07002399 ctx.VisitDirectDeps(func(module android.Module) {
2400 otherName := ctx.OtherModuleName(module)
2401 tag := ctx.OtherModuleDependencyTag(module)
2402
2403 if IsJniDepTag(tag) {
2404 // Handled by AndroidApp.collectAppDeps
2405 return
2406 }
2407 if tag == certificateTag {
2408 // Handled by AndroidApp.collectAppDeps
2409 return
2410 }
2411
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002412 if sdkInfo, ok := android.OtherModuleProvider(ctx, module, SdkLibraryInfoProvider); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -07002413 switch tag {
Jihoon Kang28c96572024-09-11 23:44:44 +00002414 case sdkLibTag, libTag, staticLibTag:
Jihoon Kang28c96572024-09-11 23:44:44 +00002415 generatingLibsString := android.PrettyConcat(
2416 getGeneratingLibs(ctx, j.SdkVersion(ctx), module.Name(), sdkInfo), true, "or")
2417 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 -07002418 }
Colin Cross313aa542023-12-13 13:47:44 -08002419 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2420 if sdkLinkType != javaPlatform {
2421 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2422 // dep is a sysprop implementation library, but this module is not linking against
2423 // the platform, so it gets the sysprop public stubs library instead. Replace
2424 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2425 dep = syspropDep.JavaInfo
2426 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002427 }
2428 switch tag {
2429 case bootClasspathTag:
2430 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002431 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002432 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002433 if _, ok := module.(*Plugin); ok {
2434 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2435 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002436 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002437 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002438 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2439 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2440 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2441 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002442 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2443 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2444 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002445
Colin Crossa14fb6a2024-10-23 16:57:06 -07002446 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002447 case java9LibTag:
2448 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002449 transitiveJava9ClasspathHeaderJars = append(transitiveJava9ClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002450 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002451 if _, ok := module.(*Plugin); ok {
2452 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2453 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002454 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2455 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2456 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2457 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2458 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2459 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2460 // Turbine doesn't run annotation processors, so any module that uses an
2461 // annotation processor that generates API is incompatible with the turbine
2462 // optimization.
2463 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002464 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002465
Colin Crossa14fb6a2024-10-23 16:57:06 -07002466 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2467 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, dep.TransitiveStaticLibsHeaderJars)
2468 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, dep.TransitiveStaticLibsImplementationJars)
2469 transitiveStaticJarsResourceLibs = append(transitiveStaticJarsResourceLibs, dep.TransitiveStaticLibsResourceJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002470 case pluginTag:
2471 if plugin, ok := module.(*Plugin); ok {
2472 if plugin.pluginProperties.Processor_class != nil {
2473 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2474 } else {
2475 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2476 }
2477 // Turbine doesn't run annotation processors, so any module that uses an
2478 // annotation processor that generates API is incompatible with the turbine
2479 // optimization.
2480 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2481 } else {
2482 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2483 }
2484 case errorpronePluginTag:
2485 if _, ok := module.(*Plugin); ok {
2486 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2487 } else {
2488 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2489 }
2490 case exportedPluginTag:
2491 if plugin, ok := module.(*Plugin); ok {
2492 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2493 if plugin.pluginProperties.Processor_class != nil {
2494 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2495 }
2496 // Turbine doesn't run annotation processors, so any module that uses an
2497 // annotation processor that generates API is incompatible with the turbine
2498 // optimization.
2499 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2500 } else {
2501 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2502 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002503 case kotlinPluginTag:
Luca Stefani50098f72024-10-12 17:55:31 +02002504 if _, ok := module.(*KotlinPlugin); ok {
2505 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
2506 } else {
2507 ctx.PropertyErrorf("kotlin_plugins", "%q is not a kotlin_plugin module", otherName)
2508 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002509 case syspropPublicStubDepTag:
2510 // This is a sysprop implementation library, forward the JavaInfoProvider from
2511 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002512 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002513 JavaInfo: dep,
2514 })
2515 }
2516 } else if dep, ok := module.(android.SourceFileProducer); ok {
2517 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002518 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002519 checkProducesJars(ctx, dep)
2520 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002521 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002522 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07002523 depset.New(depset.PREORDER, dep.Srcs(), nil))
Jaewoong Jung26342642021-03-17 15:56:23 -07002524 case staticLibTag:
2525 checkProducesJars(ctx, dep)
2526 deps.classpath = append(deps.classpath, dep.Srcs()...)
2527 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2528 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002529
Colin Crossa14fb6a2024-10-23 16:57:06 -07002530 depHeaderJars := depset.New(depset.PREORDER, dep.Srcs(), nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002531 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJars)
2532 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, depHeaderJars)
2533 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, depHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002534 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002535 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002536 switch tag {
2537 case staticLibTag:
2538 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2539 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002540 } else {
2541 switch tag {
2542 case bootClasspathTag:
2543 // If a system modules dependency has been added to the bootclasspath
2544 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002545 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002546 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002547 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars,
2548 sm.TransitiveStaticLibsHeaderJars)
Colin Crossb61c2262024-08-08 14:04:42 -07002549 } else {
2550 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2551 ctx.OtherModuleName(module))
2552 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002553
2554 case systemModulesTag:
2555 if deps.systemModules != nil {
2556 panic("Found two system module dependencies")
2557 }
Colin Crossb61c2262024-08-08 14:04:42 -07002558 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2559 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2560 } else {
2561 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2562 ctx.OtherModuleName(module))
2563 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002564
2565 case instrumentationForTag:
2566 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 -07002567 }
2568 }
2569
Spandan Das8aac9932024-07-18 23:14:13 +00002570 if android.InList(tag, compileDependencyTags) {
2571 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2572 j.compileDepNames = append(j.compileDepNames, otherName)
2573 }
2574
Jaewoong Jung26342642021-03-17 15:56:23 -07002575 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002576 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002577 })
2578
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002579 deps.transitiveStaticLibsHeaderJars = transitiveStaticJarsHeaderLibs
2580 deps.transitiveStaticLibsImplementationJars = transitiveStaticJarsImplementationLibs
2581 deps.transitiveStaticLibsResourceJars = transitiveStaticJarsResourceLibs
2582
2583 if ctx.Config().UseTransitiveJarsInClasspath() {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002584 depSet := depset.New(depset.PREORDER, nil, transitiveClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002585 deps.classpath = depSet.ToList()
Colin Crossa14fb6a2024-10-23 16:57:06 -07002586 depSet = depset.New(depset.PREORDER, nil, transitiveBootClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002587 deps.bootClasspath = depSet.ToList()
Colin Crossa14fb6a2024-10-23 16:57:06 -07002588 depSet = depset.New(depset.PREORDER, nil, transitiveJava9ClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002589 deps.java9Classpath = depSet.ToList()
2590 }
2591
2592 if ctx.Device() {
2593 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
2594 if sdkDep.invalidVersion {
2595 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2596 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2597 } else if sdkDep.useFiles {
2598 // sdkDep.jar is actually equivalent to turbine header.jar.
2599 deps.classpath = append(slices.Clone(classpath(sdkDep.jars)), deps.classpath...)
2600 deps.dexClasspath = append(slices.Clone(classpath(sdkDep.jars)), deps.dexClasspath...)
2601 deps.aidlPreprocess = sdkDep.aidl
2602 // Add the sdk module dependency to `compileDepNames`.
2603 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2604 // TODO (b/358608607): Move this to decodeSdkDep
2605 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2606 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
2607 } else {
2608 deps.aidlPreprocess = sdkDep.aidl
2609 }
2610 }
2611
Jaewoong Jung26342642021-03-17 15:56:23 -07002612 return deps
2613}
2614
Joe Onorato349ae8d2024-02-05 22:46:00 +00002615// Provider for jarjar renaming rules.
2616//
2617// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2618// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2619// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2620// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2621// be renamed from that module.
2622// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002623type DependencyUse int
2624
2625const (
2626 RenameUseInvalid DependencyUse = iota
2627 RenameUseInclude
2628 RenameUseExclude
2629)
2630
2631type RenameUseElement struct {
2632 DepName string
2633 RenameUse DependencyUse
2634 Why string // token for determining where in the logic the decision was made.
2635}
2636
Joe Onorato349ae8d2024-02-05 22:46:00 +00002637type JarJarProviderData struct {
2638 // Mapping of class names: original --> renamed. If the value is "", the class will be
2639 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2640 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002641 Rename map[string]string
2642 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002643}
2644
2645func (this JarJarProviderData) GetDebugString() string {
2646 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002647 for _, k := range android.SortedKeys(this.Rename) {
2648 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002649 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2650 result += k + "--&gt;" + v + ";"
2651 }
2652 }
2653 return result
2654}
2655
2656var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2657
2658var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2659
2660func init() {
2661 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
Yu Liu26a716d2024-08-30 23:40:32 +00002662
2663 gob.Register(BaseJarJarProviderData{})
Joe Onorato349ae8d2024-02-05 22:46:00 +00002664}
2665
2666// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2667// whether they are java modules or not.
2668type BaseJarJarProviderData struct {
2669 JarJarProviderData JarJarProviderData
2670}
2671
2672func (this BaseJarJarProviderData) GetDebugString() string {
2673 return this.JarJarProviderData.GetDebugString()
2674}
2675
2676var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2677
2678// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2679// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2680// either JarJarProvider or BaseJarJarProvider.
2681func mergeJarJarPrefixes(ctx android.ModuleContext) {
2682 mod := ctx.Module()
2683 // Explicitly avoid propagating into some module types.
2684 switch reflect.TypeOf(mod).String() {
2685 case "*java.Droidstubs":
2686 return
2687 }
2688 jarJarData := collectDirectDepsProviders(ctx)
2689 if jarJarData != nil {
2690 providerData := BaseJarJarProviderData{
2691 JarJarProviderData: *jarJarData,
2692 }
2693 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2694 }
2695
2696}
2697
2698// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2699func (module *Module) addJarJarRenameRule(original string, renamed string) {
2700 if module.jarjarRenameRules == nil {
2701 module.jarjarRenameRules = make(map[string]string)
2702 }
2703 module.jarjarRenameRules[original] = renamed
2704}
2705
2706func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2707 // Gather repackage information from deps
2708 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002709
2710 module := ctx.Module()
2711 moduleName := module.Name()
2712
Colin Cross648daea2024-09-12 14:35:29 -07002713 ctx.VisitDirectDeps(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002714 tag := ctx.OtherModuleDependencyTag(m)
2715 // This logic mirrors that in (*Module).collectDeps above. There are several places
2716 // where we explicitly return RenameUseExclude, even though it is the default, to
2717 // indicate that it has been verified to be the case.
2718 //
2719 // Note well: there are probably cases that are getting to the unconditional return
2720 // and are therefore wrong.
2721 shouldIncludeRenames := func() (DependencyUse, string) {
2722 if moduleName == m.Name() {
2723 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2724 }
2725 if sc, ok := module.(android.SdkContext); ok {
2726 if ctx.Device() {
2727 sdkDep := decodeSdkDep(ctx, sc)
2728 if !sdkDep.invalidVersion && sdkDep.useFiles {
2729 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002730 }
2731 }
LaMont Jones63683e42024-02-08 14:30:45 -08002732 }
2733 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2734 return RenameUseExclude, "tags"
2735 }
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002736 if _, ok := android.OtherModuleProvider(ctx, m, SdkLibraryInfoProvider); ok {
LaMont Jones63683e42024-02-08 14:30:45 -08002737 switch tag {
2738 case sdkLibTag, libTag:
2739 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2740 }
2741 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2742 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2743 switch ji.StubsLinkType {
2744 case Stubs:
2745 return RenameUseExclude, "info"
2746 case Implementation:
2747 return RenameUseInclude, "info"
2748 default:
LaMont Jones09721862024-06-11 10:30:50 -07002749 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002750 // Fall through to the heuristic logic.
2751 }
2752 switch reflect.TypeOf(m).String() {
2753 case "*java.GeneratedJavaLibraryModule":
2754 // Probably a java_aconfig_library module.
2755 // TODO: make this check better.
2756 return RenameUseInclude, "reflect"
2757 }
2758 switch tag {
2759 case bootClasspathTag:
2760 return RenameUseExclude, "tagswitch"
2761 case sdkLibTag, libTag, instrumentationForTag:
2762 return RenameUseInclude, "tagswitch"
2763 case java9LibTag:
2764 return RenameUseExclude, "tagswitch"
2765 case staticLibTag:
2766 return RenameUseInclude, "tagswitch"
2767 case pluginTag:
2768 return RenameUseInclude, "tagswitch"
2769 case errorpronePluginTag:
2770 return RenameUseInclude, "tagswitch"
2771 case exportedPluginTag:
2772 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002773 case kotlinPluginTag:
2774 return RenameUseInclude, "tagswitch"
2775 default:
2776 return RenameUseExclude, "tagswitch"
2777 }
2778 } else if _, ok := m.(android.SourceFileProducer); ok {
2779 switch tag {
2780 case sdkLibTag, libTag, staticLibTag:
2781 return RenameUseInclude, "srcfile"
2782 default:
2783 return RenameUseExclude, "srcfile"
2784 }
Yu Liu67a28422024-03-05 00:36:31 +00002785 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002786 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002787 } else {
2788 switch tag {
2789 case bootClasspathTag:
2790 return RenameUseExclude, "else"
2791 case systemModulesTag:
2792 return RenameUseInclude, "else"
2793 }
2794 }
2795 // If we got here, choose the safer option, which may lead to a build failure, rather
2796 // than runtime failures on the device.
2797 return RenameUseExclude, "end"
2798 }
2799
2800 if result == nil {
2801 result = &JarJarProviderData{
2802 Rename: make(map[string]string),
2803 RenameUse: make([]RenameUseElement, 0),
2804 }
2805 }
2806 how, why := shouldIncludeRenames()
2807 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2808 if how != RenameUseInclude {
2809 // Nothing to merge.
2810 return
2811 }
2812
2813 merge := func(theirs *JarJarProviderData) {
2814 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002815 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2816 result.Rename[orig] = renamed
2817 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2818 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2819 result.Rename[orig] = renamed
2820 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2821 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2822 continue
2823 }
2824 }
2825 }
2826 }
2827 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2828 merge(&theirs)
2829 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2830 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2831 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2832 // to java.Module.
2833 merge(&theirs.JarJarProviderData)
2834 }
2835 })
2836 return
2837}
2838
2839func (this Module) GetDebugString() string {
2840 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2841}
2842
2843// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2844// us, and if it's been set, apply the jarjar_prefix property to rename them.
2845func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2846 // Gather repackage information from deps
2847 result := collectDirectDepsProviders(ctx)
2848
Joe Onoratoa5d17172024-07-20 17:39:56 -07002849 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002850 if result == nil {
2851 result = &JarJarProviderData{
2852 Rename: make(map[string]string),
2853 }
2854 }
2855 if renamed != "" {
2856 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2857 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002858 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002859 }
2860 }
2861 (*result).Rename[orig] = renamed
2862 }
2863
Joe Onoratoa5d17172024-07-20 17:39:56 -07002864 // Update that with entries we've stored for ourself
2865 for orig, renamed := range module.jarjarRenameRules {
2866 add(orig, renamed)
2867 }
2868
2869 // Update that with entries given in the jarjar_rename property.
2870 for _, orig := range module.properties.Jarjar_rename {
2871 add(orig, "")
2872 }
2873
Joe Onorato349ae8d2024-02-05 22:46:00 +00002874 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2875 if result == nil {
2876 return nil
2877 }
2878
2879 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2880 // that have not yet been renamed.
2881 prefix := proptools.String(module.properties.Jarjar_prefix)
2882 if prefix != "" {
2883 if prefix[0] == '.' {
2884 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2885 return nil
2886 }
2887 if prefix[len(prefix)-1] == '.' {
2888 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2889 return nil
2890 }
2891
2892 var updated map[string]string
2893 for orig, renamed := range (*result).Rename {
2894 if renamed == "" {
2895 if updated == nil {
2896 updated = make(map[string]string)
2897 }
2898 updated[orig] = prefix + "." + orig
2899 }
2900 }
2901 for orig, renamed := range updated {
2902 (*result).Rename[orig] = renamed
2903 }
2904 }
2905
2906 return result
2907}
2908
2909// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2910// to "" won't be in this list because they shouldn't be renamed yet.
2911func getJarJarRuleText(provider *JarJarProviderData) string {
2912 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002913 for _, orig := range android.SortedKeys(provider.Rename) {
2914 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002915 if renamed != "" {
2916 result += "rule " + orig + " " + renamed + "\n"
2917 }
2918 }
2919 return result
2920}
2921
Zi Wangddb2ee52024-04-02 16:44:02 +00002922// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002923func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Zi Wangddb2ee52024-04-02 16:44:02 +00002924 if j.repackageJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002925 return infile, false
Zi Wangddb2ee52024-04-02 16:44:02 +00002926 }
Colin Crossedec77c2024-07-26 15:25:40 -07002927 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002928 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002929 return repackagedJarjarFile, true
Zi Wangddb2ee52024-04-02 16:44:02 +00002930}
2931
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002932func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Colin Crossedec77c2024-07-26 15:25:40 -07002933 if j.expandJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002934 return infile, false
Colin Crossedec77c2024-07-26 15:25:40 -07002935 }
2936 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2937 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002938 return jarjarFile, true
Colin Crossedec77c2024-07-26 15:25:40 -07002939
2940}
2941
Jaewoong Jung26342642021-03-17 15:56:23 -07002942func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2943 deps.processorPath = append(deps.processorPath, pluginJars...)
2944 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2945}
2946
2947// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2948// this interface.
2949type ProvidesUsesLib interface {
2950 ProvidesUsesLib() *string
2951}
2952
2953func (j *Module) ProvidesUsesLib() *string {
2954 return j.usesLibraryProperties.Provides_uses_lib
2955}
satayev1c564cc2021-05-25 19:50:30 +01002956
2957type ModuleWithStem interface {
2958 Stem() string
2959}
2960
2961var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002962
2963type ModuleWithUsesLibrary interface {
2964 UsesLibrary() *usesLibrary
2965}
2966
2967func (j *Module) UsesLibrary() *usesLibrary {
2968 return &j.usesLibrary
2969}
2970
2971var _ ModuleWithUsesLibrary = (*Module)(nil)