blob: 3a435a1733b5094d99388cce4e0c454f9f96f96f [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
Dave Mankoff1a7705d2025-01-08 03:06:21 +000093 // Kotlin language version to target. Currently only 1.9 and 2 are supported.
94 // See kotlinc's `-language-version` flag.
95 Kotlin_lang_version *string
96
Jaewoong Jung26342642021-03-17 15:56:23 -070097 // list of java libraries that will be in the classpath
98 Libs []string `android:"arch_variant"`
99
100 // list of java libraries that will be compiled into the resulting jar
Cole Faustb7493472024-08-28 11:55:52 -0700101 Static_libs proptools.Configurable[[]string] `android:"arch_variant"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700102
103 // manifest file to be included in resulting jar
104 Manifest *string `android:"path"`
105
106 // if not blank, run jarjar using the specified rules file
107 Jarjar_rules *string `android:"path,arch_variant"`
108
Joe Onoratoa5d17172024-07-20 17:39:56 -0700109 // java class names to rename with jarjar when a reverse dependency has a jarjar_prefix
110 // property.
111 Jarjar_rename []string
112
Joe Onorato349ae8d2024-02-05 22:46:00 +0000113 // if not blank, used as prefix to generate repackage rule
114 Jarjar_prefix *string
115
Makoto Onuki31db53a2024-12-06 16:40:47 -0800116 // Number of shards for jarjar. It needs to be an integer represented as a string.
117 // TODO(b/383559945) change it to int, once Configurable supports the type.
118 Jarjar_shards proptools.Configurable[string]
119
Jaewoong Jung26342642021-03-17 15:56:23 -0700120 // If not blank, set the java version passed to javac as -source and -target
121 Java_version *string
122
123 // If set to true, allow this module to be dexed and installed on devices. Has no
124 // effect on host modules, which are always considered installable.
125 Installable *bool
126
127 // If set to true, include sources used to compile the module in to the final jar
128 Include_srcs *bool
129
130 // If not empty, classes are restricted to the specified packages and their sub-packages.
131 // This restriction is checked after applying jarjar rules and including static libs.
132 Permitted_packages []string
133
134 // List of modules to use as annotation processors
135 Plugins []string
136
Luca Stefani50098f72024-10-12 17:55:31 +0200137 // List of modules to use as kotlin plugin
138 Kotlin_plugins []string
139
Jaewoong Jung26342642021-03-17 15:56:23 -0700140 // List of modules to export to libraries that directly depend on this library as annotation
141 // processors. Note that if the plugins set generates_api: true this will disable the turbine
142 // optimization on modules that depend on this module, which will reduce parallelism and cause
143 // more recompilation.
144 Exported_plugins []string
145
146 // The number of Java source entries each Javac instance can process
147 Javac_shard_size *int64
148
149 // Add host jdk tools.jar to bootclasspath
150 Use_tools_jar *bool
151
152 Openjdk9 struct {
153 // List of source files that should only be used when passing -source 1.9 or higher
154 Srcs []string `android:"path"`
155
156 // List of javac flags that should only be used when passing -source 1.9 or higher
157 Javacflags []string
158 }
159
160 // When compiling language level 9+ .java code in packages that are part of
161 // a system module, patch_module names the module that your sources and
162 // dependencies should be patched into. The Android runtime currently
163 // doesn't implement the JEP 261 module system so this option is only
164 // supported at compile time. It should only be needed to compile tests in
165 // packages that exist in libcore and which are inconvenient to move
166 // elsewhere.
Liz Kammer0a470a32023-10-05 17:02:00 -0400167 Patch_module *string
Jaewoong Jung26342642021-03-17 15:56:23 -0700168
169 Jacoco struct {
170 // List of classes to include for instrumentation with jacoco to collect coverage
171 // information at runtime when building with coverage enabled. If unset defaults to all
172 // classes.
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 Include_filter []string
177
178 // List of classes to exclude from instrumentation with jacoco to collect coverage
179 // information at runtime when building with coverage enabled. Overrides classes selected
180 // by the include_filter property.
181 // Supports '*' as the last character of an entry in the list as a wildcard match.
182 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
183 // it matches classes in the package that have the class name as a prefix.
184 Exclude_filter []string
185 }
186
187 Errorprone struct {
188 // List of javac flags that should only be used when running errorprone.
189 Javacflags []string
190
191 // List of java_plugin modules that provide extra errorprone checks.
192 Extra_check_modules []string
Cole Faust75fffb12021-06-13 15:23:16 -0700193
Cole Faust2b1536e2021-06-18 12:25:54 -0700194 // This property can be in 3 states. When set to true, errorprone will
195 // be run during the regular build. When set to false, errorprone will
196 // never be run. When unset, errorprone will be run when the RUN_ERROR_PRONE
197 // environment variable is true. Setting this to false will improve build
198 // performance more than adding -XepDisableAllChecks in javacflags.
Cole Faust75fffb12021-06-13 15:23:16 -0700199 Enabled *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700200 }
201
202 Proto struct {
203 // List of extra options that will be passed to the proto generator.
204 Output_params []string
205 }
206
Sam Delmericoc7593722022-08-31 15:57:52 -0400207 // If true, then jacocoagent is automatically added as a libs dependency so that
208 // r8 will not strip instrumentation classes out of dexed libraries.
Jaewoong Jung26342642021-03-17 15:56:23 -0700209 Instrument bool `blueprint:"mutated"`
Paul Duffin0038a8d2022-05-03 00:28:40 +0000210 // If true, then the module supports statically including the jacocoagent
211 // into the library.
212 Supports_static_instrumentation bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700213
214 // List of files to include in the META-INF/services folder of the resulting jar.
215 Services []string `android:"path,arch_variant"`
216
217 // If true, package the kotlin stdlib into the jar. Defaults to true.
218 Static_kotlin_stdlib *bool `android:"arch_variant"`
219
220 // A list of java_library instances that provide additional hiddenapi annotations for the library.
221 Hiddenapi_additional_annotations []string
Joe Onorato175073c2023-06-01 14:42:59 -0700222
223 // Additional srcJars tacked in by GeneratedJavaLibraryModule
224 Generated_srcjars []android.Path `android:"mutated"`
Mark Whitea15790a2023-08-22 21:28:11 +0000225
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000226 // intermediate aconfig cache file tacked in by GeneratedJavaLibraryModule
227 Aconfig_Cache_files []android.Path `android:"mutated"`
228
Mark Whitea15790a2023-08-22 21:28:11 +0000229 // If true, then only the headers are built and not the implementation jar.
Liz Kammer60772632023-10-05 17:18:44 -0400230 Headers_only *bool
Cole Faust2b64af82023-12-13 18:22:18 -0800231
232 // A list of files or dependencies to make available to the build sandbox. This is
233 // useful if source files are symlinks, the targets of the symlinks must be listed here.
234 // Note that currently not all actions implemented by android_apps are sandboxed, so you
235 // may only see this being necessary in lint builds.
236 Compile_data []string `android:"path"`
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000237
238 // Property signifying whether the module compiles stubs or not.
239 // Should be set to true when srcs of this module are stub files.
240 // This property does not need to be set to true when the module depends on
241 // the stubs via libs, but should be set to true when the module depends on
242 // the stubs via static libs.
243 Is_stubs_module *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700244
Makoto Onuki7ded3822024-03-28 14:42:20 -0700245 Ravenizer struct {
John Wu989ee842024-10-04 00:21:43 +0000246 // If true, enable the "Ravenizer" tool on the output jar.
247 // "Ravenizer" is a tool for Ravenwood tests, but it can also be enabled on other kinds
248 // of java targets.
Makoto Onuki7ded3822024-03-28 14:42:20 -0700249 Enabled *bool
John Wu989ee842024-10-04 00:21:43 +0000250
251 // If true, the "Ravenizer" tool will remove all Mockito and DexMaker
252 // classes from the output jar.
253 Strip_mockito *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700254 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +0000255
256 // Contributing api surface of the stub module. Is not visible to bp modules, and should
257 // only be set for stub submodules generated by the java_sdk_library
258 Stub_contributing_api *string `blueprint:"mutated"`
Yihan Dong8be09c22024-08-29 15:32:13 +0800259
260 // If true, enable the "ApiMapper" tool on the output jar. "ApiMapper" is a tool to inject
261 // bytecode to log API calls.
262 ApiMapper bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700263}
264
265// Properties that are specific to device modules. Host module factories should not add these when
266// constructing a new module.
267type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000268 // If not blank, set to the version of the sdk to compile against.
Spandan Das1ccf5742022-10-14 16:51:23 +0000269 // Defaults to an empty string, which compiles the module against the private platform APIs.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000270 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000271 // 1) numerical API level, "current", "none", or "core_platform"
272 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
273 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
274 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700275 Sdk_version *string
276
satayev0a420e72021-11-29 17:25:52 +0000277 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
278 // Defaults to empty string "". See sdk_version for possible values.
279 Max_sdk_version *string
280
William Loh5a082f92022-05-17 20:21:50 +0000281 // if not blank, set the maxSdkVersion properties of permission and uses-permission tags.
282 // Defaults to empty string "". See sdk_version for possible values.
283 Replace_max_sdk_version_placeholder *string
284
Jaewoong Jung26342642021-03-17 15:56:23 -0700285 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000286 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700287 Target_sdk_version *string
288
289 // Whether to compile against the platform APIs instead of an SDK.
290 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000291 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700292 Platform_apis *bool
293
294 Aidl struct {
295 // Top level directories to pass to aidl tool
296 Include_dirs []string
297
298 // Directories rooted at the Android.bp file to pass to aidl tool
299 Local_include_dirs []string
300
301 // directories that should be added as include directories for any aidl sources of modules
302 // that depend on this module, as well as to aidl for this module.
303 Export_include_dirs []string
304
305 // whether to generate traces (for systrace) for this interface
306 Generate_traces *bool
307
308 // whether to generate Binder#GetTransaction name method.
309 Generate_get_transaction_name *bool
310
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100311 // whether all interfaces should be annotated with required permissions.
312 Enforce_permissions *bool
313
314 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
315 Enforce_permissions_exceptions []string `android:"path"`
316
Jaewoong Jung26342642021-03-17 15:56:23 -0700317 // list of flags that will be passed to the AIDL compiler
318 Flags []string
319 }
320
321 // If true, export a copy of the module as a -hostdex module for host testing.
322 Hostdex *bool
323
324 Target struct {
325 Hostdex struct {
326 // Additional required dependencies to add to -hostdex modules.
327 Required []string
328 }
329 }
330
331 // When targeting 1.9 and above, override the modules to use with --system,
332 // otherwise provides defaults libraries to add to the bootclasspath.
333 System_modules *string
334
Jaewoong Jung26342642021-03-17 15:56:23 -0700335 IsSDKLibrary bool `blueprint:"mutated"`
336
337 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
338 // Defaults to false.
339 V4_signature *bool
340
341 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
342 // public stubs library.
343 SyspropPublicStub string `blueprint:"mutated"`
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000344
345 HiddenAPIPackageProperties
346 HiddenAPIFlagFileProperties
Jaewoong Jung26342642021-03-17 15:56:23 -0700347}
348
yangbill2af0b6e2024-03-15 09:29:29 +0000349// Properties that can be overridden by overriding module (e.g. override_android_app)
350type OverridableProperties struct {
Jooyung Han01d80d82022-01-08 12:16:32 +0900351 // set the name of the output. If not set, `name` is used.
352 // To override a module with this property set, overriding module might need to set this as well.
353 // Otherwise, both the overridden and the overriding modules will have the same output name, which
354 // can cause the duplicate output error.
355 Stem *string
Spandan Dasb9c58352024-05-13 18:29:45 +0000356
357 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
358 // Defaults to sdk_version if not set. See sdk_version for possible values.
359 Min_sdk_version *string
Jooyung Han01d80d82022-01-08 12:16:32 +0900360}
361
Jaewoong Jung26342642021-03-17 15:56:23 -0700362// Functionality common to Module and Import
363//
364// It is embedded in Module so its functionality can be used by methods in Module
365// but it is currently only initialized by Import and Library.
366type embeddableInModuleAndImport struct {
367
368 // Functionality related to this being used as a component of a java_sdk_library.
369 EmbeddableSdkLibraryComponent
370}
371
Paul Duffin71b33cc2021-06-23 11:39:47 +0100372func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
373 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700374}
375
Colin Crossf7bbd2f2024-12-05 13:57:10 -0800376// Module/Import's OutgoingDepIsInSameApex(...) delegates to this method.
Jaewoong Jung26342642021-03-17 15:56:23 -0700377//
Colin Crossf7bbd2f2024-12-05 13:57:10 -0800378// This cannot implement OutgoingDepIsInSameApex(...) directly as that leads to ambiguity with
Jaewoong Jung26342642021-03-17 15:56:23 -0700379// the one provided by ApexModuleBase.
Colin Crossf7bbd2f2024-12-05 13:57:10 -0800380func (e *embeddableInModuleAndImport) depIsInSameApex(tag blueprint.DependencyTag) bool {
Jaewoong Jung26342642021-03-17 15:56:23 -0700381 // dependencies other than the static linkage are all considered crossing APEX boundary
Colin Crossf7bbd2f2024-12-05 13:57:10 -0800382 if tag == staticLibTag {
Jaewoong Jung26342642021-03-17 15:56:23 -0700383 return true
384 }
385 return false
386}
387
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100388// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
389// or an invalid path describing the reason it is invalid.
390//
391// It is unset if a dex jar isn't applicable, i.e. no build rule has been
392// requested to create one.
393//
394// If a dex jar has been requested to be built then it is set, and it may be
395// either a valid android.Path, or invalid with a reason message. The latter
396// happens if the source that should produce the dex file isn't able to.
397//
398// E.g. it is invalid with a reason message if there is a prebuilt APEX that
399// could produce the dex jar through a deapexer module, but the APEX isn't
400// installable so doing so wouldn't be safe.
401type OptionalDexJarPath struct {
402 isSet bool
403 path android.OptionalPath
404}
405
406// IsSet returns true if a path has been set, either invalid or valid.
407func (o OptionalDexJarPath) IsSet() bool {
408 return o.isSet
409}
410
411// Valid returns true if there is a path that is valid.
412func (o OptionalDexJarPath) Valid() bool {
413 return o.isSet && o.path.Valid()
414}
415
416// Path returns the valid path, or panics if it's either not set or is invalid.
417func (o OptionalDexJarPath) Path() android.Path {
418 if !o.isSet {
419 panic("path isn't set")
420 }
421 return o.path.Path()
422}
423
424// PathOrNil returns the path if it's set and valid, or else nil.
425func (o OptionalDexJarPath) PathOrNil() android.Path {
426 if o.Valid() {
427 return o.Path()
428 }
429 return nil
430}
431
432// InvalidReason returns the reason for an invalid path, which is never "". It
433// returns "" for an unset or valid path.
434func (o OptionalDexJarPath) InvalidReason() string {
435 if !o.isSet {
436 return ""
437 }
438 return o.path.InvalidReason()
439}
440
441func (o OptionalDexJarPath) String() string {
442 if !o.isSet {
443 return "<unset>"
444 }
445 return o.path.String()
446}
447
448// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
449func makeUnsetDexJarPath() OptionalDexJarPath {
450 return OptionalDexJarPath{isSet: false}
451}
452
453// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
454// the given OptionalPath, which may be valid or invalid.
455func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
456 return OptionalDexJarPath{isSet: true, path: path}
457}
458
459// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
460// valid given path. It returns an unset OptionalDexJarPath if the given path is
461// nil.
462func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
463 if path == nil {
464 return makeUnsetDexJarPath()
465 }
466 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
467}
468
Jaewoong Jung26342642021-03-17 15:56:23 -0700469// Module contains the properties and members used by all java module types
470type Module struct {
471 android.ModuleBase
472 android.DefaultableModuleBase
473 android.ApexModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700474
475 // Functionality common to Module and Import.
476 embeddableInModuleAndImport
477
478 properties CommonProperties
479 protoProperties android.ProtoProperties
480 deviceProperties DeviceProperties
481
yangbill2af0b6e2024-03-15 09:29:29 +0000482 overridableProperties OverridableProperties
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700483 sourceProperties android.SourceProperties
Jooyung Han01d80d82022-01-08 12:16:32 +0900484
Jaewoong Jung26342642021-03-17 15:56:23 -0700485 // jar file containing header classes including static library dependencies, suitable for
486 // inserting into the bootclasspath/classpath of another compile
487 headerJarFile android.Path
488
489 // jar file containing implementation classes including static library dependencies but no
490 // resources
491 implementationJarFile android.Path
492
Jaewoong Jung26342642021-03-17 15:56:23 -0700493 // args and dependencies to package source files into a srcjar
494 srcJarArgs []string
495 srcJarDeps android.Paths
496
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000497 // the source files of this module and all its static dependencies
Colin Crossa14fb6a2024-10-23 16:57:06 -0700498 transitiveSrcFiles depset.DepSet[android.Path]
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000499
Jaewoong Jung26342642021-03-17 15:56:23 -0700500 // jar file containing implementation classes and resources including static library
501 // dependencies
502 implementationAndResourcesJar android.Path
503
504 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100505 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700506
507 // output file containing uninstrumented classes that will be instrumented by jacoco
508 jacocoReportClassesFile android.Path
509
510 // output file of the module, which may be a classes jar or a dex jar
511 outputFile android.Path
512 extraOutputFiles android.Paths
513
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100514 exportAidlIncludeDirs android.Paths
515 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700516
517 logtagsSrcs android.Paths
518
519 // installed file for binary dependency
520 installFile android.Path
521
Colin Cross3108ce12021-11-10 14:38:50 -0800522 // installed file for hostdex copy
523 hostdexInstallFile android.InstallPath
524
Chaohui Wangdcbe33c2022-10-11 11:13:30 +0800525 // list of unique .java and .kt source files
526 uniqueSrcFiles android.Paths
527
528 // list of srcjars that was passed to javac
529 compiledSrcJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700530
531 // manifest file to use instead of properties.Manifest
532 overrideManifest android.OptionalPath
533
Jaewoong Jung26342642021-03-17 15:56:23 -0700534 // list of plugins that this java module is exporting
535 exportedPluginJars android.Paths
536
537 // list of plugins that this java module is exporting
538 exportedPluginClasses []string
539
540 // if true, the exported plugins generate API and require disabling turbine.
541 exportedDisableTurbine bool
542
543 // list of source files, collected from srcFiles with unique java and all kt files,
544 // will be used by android.IDEInfo struct
545 expandIDEInfoCompiledSrcs []string
546
547 // expanded Jarjar_rules
548 expandJarjarRules android.Path
549
Joe Onorato349ae8d2024-02-05 22:46:00 +0000550 // jarjar rule for inherited jarjar rules
551 repackageJarjarRules android.Path
552
Jaewoong Jung26342642021-03-17 15:56:23 -0700553 // Extra files generated by the module type to be added as java resources.
554 extraResources android.Paths
555
556 hiddenAPI
557 dexer
558 dexpreopter
559 usesLibrary
560 linter
561
562 // list of the xref extraction files
Spandan Das1028d5a2024-08-19 21:45:48 +0000563 kytheFiles android.Paths
564 kytheKotlinFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700565
Jaewoong Jung26342642021-03-17 15:56:23 -0700566 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900567
568 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000569 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000570 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400571
572 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000573
574 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000575
576 // output file name based on Stem property.
577 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
578 // or the module should override Stem().
579 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700580
Joe Onorato349ae8d2024-02-05 22:46:00 +0000581 // Values that will be set in the JarJarProvider data for jarjar repackaging,
582 // and merged with our dependencies' rules.
583 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000584
585 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000586
587 // Paths to the aconfig intermediate cache files that are provided by the
588 // java_aconfig_library or java_library modules that are statically linked
589 // to this module. Does not contain cache files from all transitive dependencies.
590 aconfigCacheFiles android.Paths
Spandan Das8aac9932024-07-18 23:14:13 +0000591
592 // List of soong module dependencies required to compile the current module.
593 // This information is printed out to `Dependencies` field in module_bp_java_deps.json
594 compileDepNames []string
Makoto Onuki7ded3822024-03-28 14:42:20 -0700595
596 ravenizer struct {
597 enabled bool
598 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700599}
600
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000601var _ android.InstallableModule = (*Module)(nil)
602
603// To satisfy the InstallableModule interface
Jihoon Kang224ea082024-08-12 22:38:16 +0000604func (j *Module) StaticDependencyTags() []blueprint.DependencyTag {
605 return []blueprint.DependencyTag{staticLibTag}
606}
607
608// To satisfy the InstallableModule interface
609func (j *Module) DynamicDependencyTags() []blueprint.DependencyTag {
610 return []blueprint.DependencyTag{libTag, sdkLibTag, bootClasspathTag, systemModulesTag,
611 instrumentationForTag, java9LibTag}
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000612}
613
614// Overrides android.ModuleBase.InstallInProduct()
615func (j *Module) InstallInProduct() bool {
616 return j.ProductSpecific()
617}
618
Jihoon Kang85bc1932024-07-01 17:04:46 +0000619var _ android.StubsAvailableModule = (*Module)(nil)
620
621// To safisfy the StubsAvailableModule interface
622func (j *Module) IsStubsModule() bool {
623 return proptools.Bool(j.properties.Is_stubs_module)
624}
625
Yu Liu63bdf632024-12-03 19:54:05 +0000626func CheckStableSdkVersion(ctx android.BaseModuleContext, module android.ModuleProxy) error {
627 if info, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
628 if info.SdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700629 return nil
630 }
Yu Liu63bdf632024-12-03 19:54:05 +0000631 if info.SdkVersion.Kind == android.SdkCorePlatform {
632 if useLegacyCorePlatformApi(ctx, android.OtherModuleProviderOrDefault(ctx, module, android.CommonModuleInfoKey).BaseModuleName) {
633 return fmt.Errorf("non stable SDK %v - uses legacy core platform", info.SdkVersion)
634 } else {
635 // Treat stable core platform as stable.
636 return nil
637 }
638 } else {
639 return fmt.Errorf("non stable SDK %v", info.SdkVersion)
640 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700641 }
Yu Liu63bdf632024-12-03 19:54:05 +0000642
643 return nil
Jaewoong Jung26342642021-03-17 15:56:23 -0700644}
645
646// checkSdkVersions enforces restrictions around SDK dependencies.
647func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
648 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900649 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900650 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700651 ctx.PropertyErrorf("sdk_version",
652 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
653 }
654 }
655 }
656
657 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
658 // See rank() for details.
Yu Liuc0a36302025-01-10 22:26:01 +0000659 ctx.VisitDirectDepsProxy(func(module android.ModuleProxy) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700660 tag := ctx.OtherModuleDependencyTag(module)
Yu Liuc0a36302025-01-10 22:26:01 +0000661 _, isJavaLibrary := android.OtherModuleProvider(ctx, module, JavaLibraryInfoProvider)
662 _, isAndroidLibrary := android.OtherModuleProvider(ctx, module, AndroidLibraryInfoProvider)
663 _, isJavaAconfigLibrary := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider)
664 // Exclude java_aconfig_library modules to maintain consistency with existing behavior.
665 if (isJavaLibrary && !isJavaAconfigLibrary) || isAndroidLibrary {
666 // TODO(satayev): cover other types as well, e.g. imports
Jaewoong Jung26342642021-03-17 15:56:23 -0700667 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400668 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Yu Liuc0a36302025-01-10 22:26:01 +0000669 j.checkSdkLinkType(ctx, module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700670 }
671 }
672 })
673}
674
675func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900676 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700677 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900678 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700679 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000680 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 -0700681 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000682 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 -0700683 }
684
685 }
686}
687
Mark Whitea15790a2023-08-22 21:28:11 +0000688func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
689 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400690 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000691 installable := proptools.Bool(j.properties.Installable)
692
693 if headersOnly && installable {
694 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.")
695 }
696 }
697}
698
Jaewoong Jung26342642021-03-17 15:56:23 -0700699func (j *Module) addHostProperties() {
700 j.AddProperties(
701 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000702 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700703 &j.protoProperties,
704 &j.usesLibraryProperties,
705 )
706}
707
708func (j *Module) addHostAndDeviceProperties() {
709 j.addHostProperties()
710 j.AddProperties(
711 &j.deviceProperties,
712 &j.dexer.dexProperties,
713 &j.dexpreoptProperties,
714 &j.linter.properties,
715 )
716}
717
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000718// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
719// makes it available through the hiddenAPIPropertyInfoProvider.
720func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
721 hiddenAPIInfo := newHiddenAPIPropertyInfo()
722
723 // Populate with flag file paths from the properties.
724 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
725
726 // Populate with package rules from the properties.
727 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
728
Colin Cross40213022023-12-13 15:19:49 -0800729 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000730}
731
mrziwang9f7b9f42024-07-10 12:18:06 -0700732// helper method for java modules to set OutputFilesProvider
733func setOutputFiles(ctx android.ModuleContext, m Module) {
Cole Faust5146e782024-11-15 14:47:49 -0800734 ctx.SetOutputFiles(append(android.PathsIfNonNil(m.outputFile), m.extraOutputFiles...), "")
735 ctx.SetOutputFiles(android.PathsIfNonNil(m.outputFile), android.DefaultDistTag)
736 ctx.SetOutputFiles(android.PathsIfNonNil(m.implementationAndResourcesJar), ".jar")
737 ctx.SetOutputFiles(android.PathsIfNonNil(m.headerJarFile), ".hjar")
mrziwang9f7b9f42024-07-10 12:18:06 -0700738 if m.dexer.proguardDictionary.Valid() {
739 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
740 }
741 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
Jaewoong Jung26342642021-03-17 15:56:23 -0700742}
743
Jaewoong Jung26342642021-03-17 15:56:23 -0700744func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
745 initJavaModule(module, hod, false)
746}
747
748func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
749 initJavaModule(module, hod, true)
750}
751
752func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
753 multilib := android.MultilibCommon
754 if multiTargets {
755 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
756 } else {
757 android.InitAndroidArchModule(module, hod, multilib)
758 }
759 android.InitDefaultableModule(module)
760}
761
762func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
763 return j.properties.Instrument &&
764 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
765 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
766}
767
Yihan Dong8be09c22024-08-29 15:32:13 +0800768func (j *Module) shouldApiMapper() bool {
769 return j.properties.ApiMapper
770}
771
Jaewoong Jung26342642021-03-17 15:56:23 -0700772func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000773 return j.properties.Supports_static_instrumentation &&
774 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700775 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
776 ctx.Config().UnbundledBuild())
777}
778
779func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
780 // Force enable the instrumentation for java code that is built for APEXes ...
781 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
782 // 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 -0800783 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700784 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000785
Colin Crosse4f34882024-11-14 12:26:00 -0800786 compileDex := Bool(j.dexProperties.Compile_dex) || Bool(j.properties.Installable)
787 if compileDex && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700788 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
789 return true
790 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
791 return true
792 }
793 }
794 return false
795}
796
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400797func (j *Module) setInstrument(value bool) {
798 j.properties.Instrument = value
799}
800
Yihan Dong8be09c22024-08-29 15:32:13 +0800801func (j *Module) setApiMapper(value bool) {
802 j.properties.ApiMapper = value
803}
804
Jiyong Park92315372021-04-02 08:45:46 +0900805func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
806 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700807}
808
Jiyong Parkf1691d22021-03-29 20:11:58 +0900809func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700810 return proptools.String(j.deviceProperties.System_modules)
811}
812
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000813func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000814 if j.overridableProperties.Min_sdk_version != nil {
815 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700816 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000817 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700818}
819
Yu Liuf2b94012023-09-19 15:09:10 -0700820func (j *Module) GetDeviceProperties() *DeviceProperties {
821 return &j.deviceProperties
822}
823
Spandan Dasa26eda72023-03-02 00:56:06 +0000824func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
825 if j.deviceProperties.Max_sdk_version != nil {
826 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
827 }
828 // Default is PrivateApiLevel
829 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000830}
831
Spandan Dasa26eda72023-03-02 00:56:06 +0000832func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
833 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
834 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
835 }
836 // Default is PrivateApiLevel
837 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000838}
839
Jiyong Parkf1691d22021-03-29 20:11:58 +0900840func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000841 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900842}
843
Spandan Dasca70fc42023-03-01 23:38:49 +0000844func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900845 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000846 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900847 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000848 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700849}
850
851func (j *Module) AvailableFor(what string) bool {
Yu Liub73c3a62024-12-10 00:58:06 +0000852 return android.CheckAvailableForApex(what, j.ApexAvailableFor())
853}
854
855func (j *Module) ApexAvailableFor() []string {
856 list := j.ApexModuleBase.ApexAvailable()
857 if Bool(j.deviceProperties.Hostdex) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700858 // Exception: for hostdex: true libraries, the platform variant is created
859 // even if it's not marked as available to platform. In that case, the platform
860 // variant is used only for the hostdex and not installed to the device.
Yu Liub73c3a62024-12-10 00:58:06 +0000861 list = append(list, android.AvailableToPlatform)
Jaewoong Jung26342642021-03-17 15:56:23 -0700862 }
Yu Liub73c3a62024-12-10 00:58:06 +0000863 return android.FirstUniqueStrings(list)
Jaewoong Jung26342642021-03-17 15:56:23 -0700864}
865
Cole Faustb7493472024-08-28 11:55:52 -0700866func (j *Module) staticLibs(ctx android.BaseModuleContext) []string {
Jihoon Kang8bce3812024-09-30 18:46:51 +0000867 return j.properties.Static_libs.GetOrDefault(ctx, nil)
Cole Faustb7493472024-08-28 11:55:52 -0700868}
869
Jaewoong Jung26342642021-03-17 15:56:23 -0700870func (j *Module) deps(ctx android.BottomUpMutatorContext) {
871 if ctx.Device() {
872 j.linter.deps(ctx)
873
Jiyong Parkf1691d22021-03-29 20:11:58 +0900874 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700875
876 if j.deviceProperties.SyspropPublicStub != "" {
877 // This is a sysprop implementation library that has a corresponding sysprop public
878 // stubs library, and a dependency on it so that dependencies on the implementation can
879 // be forwarded to the public stubs library when necessary.
880 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
881 }
882 }
883
884 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000885
Cole Faustb7493472024-08-28 11:55:52 -0700886 ctx.AddVariationDependencies(nil, staticLibTag, j.staticLibs(ctx)...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700887
888 // Add dependency on libraries that provide additional hidden api annotations.
889 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
890
Jaewoong Jung26342642021-03-17 15:56:23 -0700891 // For library dependencies that are component libraries (like stubs), add the implementation
892 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
893 for _, dep := range libDeps {
894 if dep != nil {
895 if component, ok := dep.(SdkLibraryComponentDependency); ok {
896 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000897 // Add library as optional if it's one of the optional compatibility libs or it's
898 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100899 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000900 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
Cole Faust64f2d842024-10-17 13:28:34 -0700901 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs.GetOrDefault(ctx, nil)) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100902 tag = usesLibOptTag
903 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100904 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700905 }
906 }
907 }
908 }
909
910 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Luca Stefani50098f72024-10-12 17:55:31 +0200911 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag, j.properties.Kotlin_plugins...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700912 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
913 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
914
915 android.ProtoDeps(ctx, &j.protoProperties)
916 if j.hasSrcExt(".proto") {
917 protoDeps(ctx, &j.protoProperties)
918 }
919
920 if j.hasSrcExt(".kt") {
921 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
922 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700923 tag := staticLibTag
924 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
925 tag = libTag
926 }
927 ctx.AddVariationDependencies(nil, tag,
928 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700929 }
930
931 // Framework libraries need special handling in static coverage builds: they should not have
932 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
933 // the same jacoco classes coming from different bootclasspath jars.
934 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
935 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
936 j.properties.Instrument = true
937 }
938 } else if j.shouldInstrumentStatic(ctx) {
939 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
940 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700941
Cole Faustb7493472024-08-28 11:55:52 -0700942 if j.useCompose(ctx) {
Colin Crossa1ff7c62021-09-17 14:11:52 -0700943 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
Dave Mankoff0a3ef842024-10-02 18:47:24 +0000944 "kotlin-compose-compiler-plugin")
Colin Crossa1ff7c62021-09-17 14:11:52 -0700945 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700946}
947
948func hasSrcExt(srcs []string, ext string) bool {
949 for _, src := range srcs {
950 if filepath.Ext(src) == ext {
951 return true
952 }
953 }
954
955 return false
956}
957
958func (j *Module) hasSrcExt(ext string) bool {
959 return hasSrcExt(j.properties.Srcs, ext)
960}
961
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100962func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
963 var flags string
964
965 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
966 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
967 flags = "-Wmissing-permission-annotation -Werror"
968 }
969 }
970 return flags
971}
972
Jaewoong Jung26342642021-03-17 15:56:23 -0700973func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000974 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700975
976 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
977 aidlIncludes = append(aidlIncludes,
978 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
979 aidlIncludes = append(aidlIncludes,
980 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
981
982 var flags []string
983 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000984 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700985
986 flags = append(flags, j.deviceProperties.Aidl.Flags...)
987
988 if aidlPreprocess.Valid() {
989 flags = append(flags, "-p"+aidlPreprocess.String())
990 deps = append(deps, aidlPreprocess.Path())
991 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000992 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700993 }
994
995 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000996 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700997 }
998
999 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +00001000 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001001 }
1002
Sam Delmerico2351eac2022-05-24 17:10:02 +00001003 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -07001004 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +00001005 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -07001006 }
Sam Delmerico2351eac2022-05-24 17:10:02 +00001007 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
1008 // add flags for dirs containing AIDL srcs that haven't been specified yet
1009 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -07001010
Zim8774ae12022-08-17 11:46:34 +01001011 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +00001012 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +01001013 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001014 flags = append(flags, "-t")
1015 }
1016
1017 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
1018 flags = append(flags, "--transaction_names")
1019 }
1020
Thiébaud Weksteende8417c2022-02-10 15:41:46 +11001021 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
1022 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
1023 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1024 }
1025
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001026 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001027 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1028
Jaewoong Jung26342642021-03-17 15:56:23 -07001029 return strings.Join(flags, " "), deps
1030}
1031
1032func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1033
1034 var flags javaBuilderFlags
1035
1036 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001037 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001038
Cole Faust2b1536e2021-06-18 12:25:54 -07001039 epEnabled := j.properties.Errorprone.Enabled
1040 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001041 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001042 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1043 }
1044
1045 errorProneFlags := []string{
1046 "-Xplugin:ErrorProne",
1047 "${config.ErrorProneChecks}",
1048 }
1049 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1050
Colin Cross8bf6cad2022-02-28 13:07:03 -08001051 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001052 "'" + strings.Join(errorProneFlags, " ") + "'"
1053 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1054 }
1055
1056 // classpath
1057 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1058 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001059 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001060 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1061 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1062 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1063
1064 flags.processors = append(flags.processors, deps.processorClasses...)
1065 flags.processors = android.FirstUniqueStrings(flags.processors)
1066
1067 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001068 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001069 // Give host-side tools a version of OpenJDK's standard libraries
1070 // close to what they're targeting. As of Dec 2017, AOSP is only
1071 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1072 //
1073 // When building with OpenJDK 8, the following should have no
1074 // effect since those jars would be available by default.
1075 //
1076 // When building with OpenJDK 9 but targeting a version < 1.8,
1077 // putting them on the bootclasspath means that:
1078 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1079 // b) references to existing APIs are not reinterpreted in an
1080 // OpenJDK 9-specific way, eg. calls to subclasses of
1081 // java.nio.Buffer as in http://b/70862583
1082 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1083 flags.bootClasspath = append(flags.bootClasspath,
1084 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1085 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1086 if Bool(j.properties.Use_tools_jar) {
1087 flags.bootClasspath = append(flags.bootClasspath,
1088 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1089 }
1090 }
1091
1092 // systemModules
1093 flags.systemModules = deps.systemModules
1094
Jaewoong Jung26342642021-03-17 15:56:23 -07001095 return flags
1096}
1097
1098func (j *Module) collectJavacFlags(
1099 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1100 // javac flags.
1101 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001102 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001103
Mythri Alle4b9f6182023-10-25 15:17:11 +00001104 needsDebugInfo = false
1105 for _, flag := range javacFlags {
1106 if strings.HasPrefix(flag, "-g") {
1107 needsDebugInfo = true
1108 }
1109 }
1110
1111 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001112 // For non-host binaries, override the -g flag passed globally to remove
1113 // local variable debug info to reduce disk and memory usage.
1114 javacFlags = append(javacFlags, "-g:source,lines")
1115 }
1116 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1117
1118 if flags.javaVersion.usesJavaModules() {
1119 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001120 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1121 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1122 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1123 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001124
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001125 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001126 if j.properties.Patch_module != nil {
1127 // Manually specify build directory in case it is not under the repo root.
1128 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1129 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001130 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001131
Jaewoong Jung26342642021-03-17 15:56:23 -07001132 classPath := flags.classpath.FormJavaClassPath("")
1133 if classPath != "" {
1134 patchPaths = append(patchPaths, classPath)
1135 }
1136 javacFlags = append(
1137 javacFlags,
1138 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1139 }
1140 }
1141
1142 if len(javacFlags) > 0 {
1143 // optimization.
1144 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1145 flags.javacFlags = "$javacFlags"
1146 }
1147
1148 return flags
1149}
1150
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001151func (j *Module) AddJSONData(d *map[string]interface{}) {
1152 (&j.ModuleBase).AddJSONData(d)
1153 (*d)["Java"] = map[string]interface{}{
1154 "SourceExtensions": j.sourceExtensions,
1155 }
1156
1157}
1158
usta0391ca42023-09-19 15:51:59 -04001159func (j *Module) addGeneratedSrcJars(path android.Path) {
1160 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001161}
1162
Yu Liu460cf372025-01-10 00:34:06 +00001163func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars, extraDepCombinedJars android.Paths) *JavaInfo {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001164 // Auto-propagating jarjar rules
1165 jarjarProviderData := j.collectJarJarRules(ctx)
1166 if jarjarProviderData != nil {
1167 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wangddb2ee52024-04-02 16:44:02 +00001168 text := getJarJarRuleText(jarjarProviderData)
1169 if text != "" {
1170 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1171 android.WriteFileRule(ctx, ruleTextFile, text)
1172 j.repackageJarjarRules = ruleTextFile
Joe Onorato349ae8d2024-02-05 22:46:00 +00001173 }
1174 }
1175
Jaewoong Jung26342642021-03-17 15:56:23 -07001176 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1177
John Wu989ee842024-10-04 00:21:43 +00001178 // Only override the original value if explicitly set
1179 if j.properties.Ravenizer.Enabled != nil {
1180 j.ravenizer.enabled = *j.properties.Ravenizer.Enabled
Makoto Onuki7ded3822024-03-28 14:42:20 -07001181 }
1182
Jaewoong Jung26342642021-03-17 15:56:23 -07001183 deps := j.collectDeps(ctx)
1184 flags := j.collectBuilderFlags(ctx, deps)
1185
1186 if flags.javaVersion.usesJavaModules() {
1187 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001188 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1189 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1190 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001191 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001192
Jaewoong Jung26342642021-03-17 15:56:23 -07001193 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001194 j.sourceExtensions = []string{}
1195 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1196 if hasSrcExt(srcFiles.Strings(), ext) {
1197 j.sourceExtensions = append(j.sourceExtensions, ext)
1198 }
1199 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001200 if hasSrcExt(srcFiles.Strings(), ".proto") {
1201 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1202 }
1203
Dave Mankoff0a3ef842024-10-02 18:47:24 +00001204 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, j.properties.Exclude_common_srcs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001205 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1206 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1207 }
1208
Sam Delmerico2351eac2022-05-24 17:10:02 +00001209 aidlSrcs := srcFiles.FilterByExt(".aidl")
1210 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1211
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001212 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001213 srcFiles = j.genSources(ctx, srcFiles, flags)
1214
1215 // Collect javac flags only after computing the full set of srcFiles to
1216 // ensure that the --patch-module lookup paths are complete.
1217 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1218
1219 srcJars := srcFiles.FilterByExt(".srcjar")
1220 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001221 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001222 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001223 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001224
1225 if j.properties.Jarjar_rules != nil {
1226 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1227 }
1228
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001229 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001230
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001231 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001232 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001233 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001234 if _, found := set[v.String()]; !found {
1235 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001236 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001237 }
1238 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001239 var uniqueKtFiles android.Paths
1240 for _, v := range srcFiles.FilterByExt(".kt") {
1241 if _, found := set[v.String()]; !found {
1242 set[v.String()] = true
1243 uniqueKtFiles = append(uniqueKtFiles, v)
1244 }
1245 }
1246
1247 var uniqueSrcFiles android.Paths
1248 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1249 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1250 j.uniqueSrcFiles = uniqueSrcFiles
Jaewoong Jung26342642021-03-17 15:56:23 -07001251
Colin Crossb5db4012022-03-28 17:12:39 -07001252 // We don't currently run annotation processors in turbine, which means we can't use turbine
1253 // generated header jars when an annotation processor that generates API is enabled. One
1254 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1255 // is used to run all of the annotation processors.
1256 disableTurbine := deps.disableTurbine
1257
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001258 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001259 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1260
Colin Cross220a9a12022-03-28 17:08:01 -07001261 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001262
Colin Cross4eae06d2023-06-20 22:40:02 -07001263 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1264 // any dependencies so that it can override any non-final R classes from dependencies with the
1265 // final R classes from the app.
1266 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1267
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001268 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1269
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001270 var localImplementationJars android.Paths
1271
Mark Whitea15790a2023-08-22 21:28:11 +00001272 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001273 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001274 if srcFiles.HasExt(".kt") {
1275 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1276 }
1277 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1278 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1279 }
1280
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001281 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1282
1283 localHeaderJars, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
Colin Crossedec77c2024-07-26 15:25:40 -07001284 extraCombinedJars)
1285
Makoto Onuki31db53a2024-12-06 16:40:47 -08001286 combinedHeaderJarFile, jarjared := j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine", false)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001287 if jarjared {
1288 localHeaderJars = android.Paths{combinedHeaderJarFile}
1289 transitiveStaticLibsHeaderJars = nil
1290 }
1291 combinedHeaderJarFile, repackaged := j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
1292 if repackaged {
1293 localHeaderJars = android.Paths{combinedHeaderJarFile}
1294 transitiveStaticLibsHeaderJars = nil
1295 }
Mark Whitea15790a2023-08-22 21:28:11 +00001296 if ctx.Failed() {
Yu Liu460cf372025-01-10 00:34:06 +00001297 return nil
Mark Whitea15790a2023-08-22 21:28:11 +00001298 }
Colin Crossedec77c2024-07-26 15:25:40 -07001299 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001300
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001301 if ctx.Config().UseTransitiveJarsInClasspath() {
1302 if len(localHeaderJars) > 0 {
1303 ctx.CheckbuildFile(localHeaderJars...)
1304 } else {
1305 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1306 ctx.UncheckedModule()
1307 }
1308 } else {
1309 ctx.CheckbuildFile(j.headerJarFile)
1310 }
Colin Crossa6182ab2024-08-21 10:47:44 -07001311
Yu Liu460cf372025-01-10 00:34:06 +00001312 j.outputFile = j.headerJarFile
1313 return &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001314 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001315 LocalHeaderJars: localHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001316 TransitiveStaticLibsHeaderJars: depset.New(depset.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Cross9ffaf282024-08-12 13:50:09 -07001317 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1318 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001319 AidlIncludeDirs: j.exportAidlIncludeDirs,
1320 ExportedPlugins: j.exportedPluginJars,
1321 ExportedPluginClasses: j.exportedPluginClasses,
1322 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1323 StubsLinkType: j.stubsLinkType,
1324 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Yu Liu63bdf632024-12-03 19:54:05 +00001325 SdkVersion: j.SdkVersion(ctx),
Yu Liu460cf372025-01-10 00:34:06 +00001326 }
Mark Whitea15790a2023-08-22 21:28:11 +00001327 }
1328
Jaewoong Jung26342642021-03-17 15:56:23 -07001329 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001330 // When using kotlin sources turbine is used to generate annotation processor sources,
1331 // including for annotation processors that generate API, so we can use turbine for
1332 // java sources too.
1333 disableTurbine = false
1334
Jaewoong Jung26342642021-03-17 15:56:23 -07001335 // user defined kotlin flags.
1336 kotlincFlags := j.properties.Kotlincflags
1337 CheckKotlincFlags(ctx, kotlincFlags)
1338
Dave Mankoff20b0ce52025-01-10 14:52:42 +00001339 // Available kotlin versions can be found at
1340 // https://github.com/JetBrains/kotlin/blob/master/compiler/util/src/org/jetbrains/kotlin/config/LanguageVersionSettings.kt#L560
1341 // in the `LanguageVersion` class.
1342 // For now, avoid targeting language versions directly, as we'd like to kee our source
1343 // code version aligned as much as possible. Ideally, after defaulting to "2", we
1344 // can remove the "1.9" option entirely, or at least make it emit a warning.
Dave Mankoff3e112742025-01-18 03:16:23 +00001345 kotlin_default_lang_version := "1.9"
1346 if build_flag_lang_version, ok := ctx.Config().GetBuildFlag("RELEASE_KOTLIN_LANG_VERSION"); ok {
1347 kotlin_default_lang_version = build_flag_lang_version
1348 }
1349 kotlin_lang_version := proptools.StringDefault(j.properties.Kotlin_lang_version, kotlin_default_lang_version)
1350 switch kotlin_lang_version {
1351 case "1.9":
Dave Mankoff1a7705d2025-01-08 03:06:21 +00001352 kotlincFlags = append(kotlincFlags, "-language-version 1.9")
Dave Mankoff3e112742025-01-18 03:16:23 +00001353 case "2":
Dave Mankoff1a7705d2025-01-08 03:06:21 +00001354 kotlincFlags = append(kotlincFlags, "-Xsuppress-version-warnings", "-Xconsistent-data-class-copy-visibility")
Dave Mankoff3e112742025-01-18 03:16:23 +00001355 default:
Dave Mankoff1a7705d2025-01-08 03:06:21 +00001356 ctx.PropertyErrorf("kotlin_lang_version", "Must be one of `1.9` or `2`")
Dave Mankoff1a7705d2025-01-08 03:06:21 +00001357 }
1358
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001359 // Workaround for KT-46512
1360 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001361
1362 // If there are kotlin files, compile them first but pass all the kotlin and java files
1363 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1364 // won't emit any classes for them.
1365 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1366 if ctx.Device() {
1367 kotlincFlags = append(kotlincFlags, "-no-jdk")
1368 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001369
1370 for _, plugin := range deps.kotlinPlugins {
1371 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1372 }
1373 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1374
Jaewoong Jung26342642021-03-17 15:56:23 -07001375 if len(kotlincFlags) > 0 {
1376 // optimization.
1377 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1378 flags.kotlincFlags += "$kotlincFlags"
1379 }
1380
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001381 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001382 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1383
Jaewoong Jung26342642021-03-17 15:56:23 -07001384 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1385 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1386
Isaac Chioua23d9942022-04-06 06:14:38 +00001387 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001388 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001389 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1390 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001391 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001392 srcJars = append(srcJars, kaptSrcJar)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001393 localImplementationJars = append(localImplementationJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001394 // Disable annotation processing in javac, it's already been handled by kapt
1395 flags.processorPath = nil
1396 flags.processors = nil
1397 }
1398
1399 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001400 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Spandan Das1028d5a2024-08-19 21:45:48 +00001401 j.kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001402 if ctx.Failed() {
Yu Liu460cf372025-01-10 00:34:06 +00001403 return nil
Jaewoong Jung26342642021-03-17 15:56:23 -07001404 }
1405
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001406 kotlinJarPath, _ := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001407
Isaac Chioua23d9942022-04-06 06:14:38 +00001408 // Make javac rule depend on the kotlinc rule
1409 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1410
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001411 localImplementationJars = append(localImplementationJars, kotlinJarPath)
1412
Colin Cross220a9a12022-03-28 17:08:01 -07001413 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001414 }
1415
Jaewoong Jung26342642021-03-17 15:56:23 -07001416 j.compiledSrcJars = srcJars
1417
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001418 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1419
Jaewoong Jung26342642021-03-17 15:56:23 -07001420 enableSharding := false
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001421 var localHeaderJars android.Paths
1422 var shardingHeaderJars android.Paths
1423 var repackagedHeaderJarFile android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001424 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001425 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1426 enableSharding = true
1427 // Formerly, there was a check here that prevented annotation processors
1428 // from being used when sharding was enabled, as some annotation processors
1429 // do not function correctly in sharded environments. It was removed to
1430 // allow for the use of annotation processors that do function correctly
1431 // with sharding enabled. See: b/77284273.
1432 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001433 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001434 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001435 var combinedHeaderJarFile android.Path
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001436 localHeaderJars, combinedHeaderJarFile = j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
1437 shardingHeaderJars = localHeaderJars
Colin Crossedec77c2024-07-26 15:25:40 -07001438
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001439 var jarjared bool
Makoto Onuki31db53a2024-12-06 16:40:47 -08001440 j.headerJarFile, jarjared = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine", false)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001441 if jarjared {
1442 // jarjar modifies transitive static dependencies, use the combined header jar and drop the transitive
1443 // static libs header jars.
1444 localHeaderJars = android.Paths{j.headerJarFile}
1445 transitiveStaticLibsHeaderJars = nil
1446 }
1447 var repackaged bool
1448 repackagedHeaderJarFile, repackaged = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
1449 if repackaged {
1450 // repackage modifies transitive static dependencies, use the combined header jar and drop the transitive
1451 // static libs header jars.
1452 // TODO(b/356688296): this shouldn't export both the unmodified and repackaged header jars
1453 localHeaderJars = android.Paths{j.headerJarFile, repackagedHeaderJarFile}
1454 transitiveStaticLibsHeaderJars = nil
1455 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001456 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001457 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001458 hasErrorproneableFiles := false
1459 for _, ext := range j.sourceExtensions {
1460 if ext != ".proto" && ext != ".aidl" {
1461 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1462 // compile, and it's not useful to have warnings on these generated sources.
1463 hasErrorproneableFiles = true
1464 break
1465 }
1466 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001467 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001468 if Bool(j.properties.Errorprone.Enabled) {
1469 // If error-prone is enabled, enable errorprone flags on the regular
1470 // build.
1471 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001472 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faustf3240f42024-12-11 16:49:18 -08001473 if ctx.Config().RunErrorProneInline() {
1474 // On CI, we're not going to toggle back/forth between errorprone and non-errorprone
1475 // builds, so it's faster if we don't compile the module twice and instead always
1476 // compile the module with errorprone.
1477 flags = enableErrorproneFlags(flags)
1478 } else {
1479 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1480 // a new jar file just for compiling with the errorprone compiler to.
1481 // This is because we don't want to cause the java files to get completely
1482 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1483 // We also don't want to run this if errorprone is enabled by default for
1484 // this module, or else we could have duplicated errorprone messages.
1485 errorproneFlags := enableErrorproneFlags(flags)
1486 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
1487 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001488
Cole Faustf3240f42024-12-11 16:49:18 -08001489 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
1490 "errorprone", "errorprone")
Cole Faust75fffb12021-06-13 15:23:16 -07001491
Cole Faustf3240f42024-12-11 16:49:18 -08001492 extraJarDeps = append(extraJarDeps, errorprone)
1493 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001494 }
1495
1496 if enableSharding {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001497 if len(shardingHeaderJars) > 0 {
1498 flags.classpath = append(classpath(slices.Clone(shardingHeaderJars)), flags.classpath...)
Colin Cross3d56ed52021-11-18 22:23:12 -08001499 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001500 shardSize := int(*(j.properties.Javac_shard_size))
1501 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001502 if len(uniqueJavaFiles) > 0 {
1503 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001504 for idx, shardSrc := range shardSrcs {
1505 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1506 nil, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001507 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
1508 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001509 }
1510 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001511 // Assume approximately 5 sources per srcjar.
1512 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1513 // 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 -07001514 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001515 startIdx := len(shardSrcs)
1516 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1517 for idx, shardSrcJars := range shardSrcJarsList {
1518 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1519 nil, shardSrcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001520 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
1521 localImplementationJars = append(localImplementationJars, classes)
Colin Crossa052ddb2023-09-25 21:46:58 -07001522 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001523 }
1524 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001525 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001526 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
1527 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001528 }
1529 if ctx.Failed() {
Yu Liu460cf372025-01-10 00:34:06 +00001530 return nil
Jaewoong Jung26342642021-03-17 15:56:23 -07001531 }
1532 }
1533
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001534 localImplementationJars = append(localImplementationJars, extraCombinedJars...)
Colin Crossfd620b22024-02-23 10:05:21 -08001535
Jaewoong Jung26342642021-03-17 15:56:23 -07001536 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1537
1538 var includeSrcJar android.WritablePath
1539 if Bool(j.properties.Include_srcs) {
1540 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1541 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1542 }
1543
1544 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1545 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Cole Faust7fd5b2e2024-10-29 11:22:20 -07001546 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources.GetOrDefault(ctx, nil), j.properties.Exclude_java_resources)
1547 fileArgs2, fileDeps2 := ResourceFilesToJarArgs(ctx, j.properties.Device_common_java_resources.GetOrDefault(ctx, nil), nil)
1548 fileArgs3, fileDeps3 := ResourceFilesToJarArgs(ctx, j.properties.Device_first_java_resources.GetOrDefault(ctx, nil), nil)
Cole Faust65cb40a2024-10-21 15:41:42 -07001549 fileArgs = slices.Concat(fileArgs, fileArgs2, fileArgs3)
1550 fileDeps = slices.Concat(fileDeps, fileDeps2, fileDeps3)
Jaewoong Jung26342642021-03-17 15:56:23 -07001551 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1552
1553 var resArgs []string
1554 var resDeps android.Paths
1555
1556 resArgs = append(resArgs, dirArgs...)
1557 resDeps = append(resDeps, dirDeps...)
1558
1559 resArgs = append(resArgs, fileArgs...)
1560 resDeps = append(resDeps, fileDeps...)
1561
1562 resArgs = append(resArgs, extraArgs...)
1563 resDeps = append(resDeps, extraDeps...)
1564
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001565 var localResourceJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001566 if len(resArgs) > 0 {
1567 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1568 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001569 if ctx.Failed() {
Yu Liu460cf372025-01-10 00:34:06 +00001570 return nil
Jaewoong Jung26342642021-03-17 15:56:23 -07001571 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001572 localResourceJars = append(localResourceJars, resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001573 }
1574
Jaewoong Jung26342642021-03-17 15:56:23 -07001575 if Bool(j.properties.Include_srcs) {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001576 localResourceJars = append(localResourceJars, includeSrcJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001577 }
1578
1579 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1580 if len(services) > 0 {
1581 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1582 var zipargs []string
1583 for _, file := range services {
1584 serviceFile := file.String()
1585 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1586 }
1587 rule := zip
1588 args := map[string]string{
1589 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1590 }
1591 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1592 rule = zipRE
1593 args["implicits"] = strings.Join(services.Strings(), ",")
1594 }
1595 ctx.Build(pctx, android.BuildParams{
1596 Rule: rule,
1597 Output: servicesJar,
1598 Implicits: services,
1599 Args: args,
1600 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001601 localResourceJars = append(localResourceJars, servicesJar)
1602 }
1603
Colin Crossa14fb6a2024-10-23 16:57:06 -07001604 completeStaticLibsResourceJars := depset.New(depset.PREORDER, localResourceJars, deps.transitiveStaticLibsResourceJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001605
1606 var combinedResourceJar android.Path
1607 var resourceJars android.Paths
1608 if ctx.Config().UseTransitiveJarsInClasspath() {
1609 resourceJars = completeStaticLibsResourceJars.ToList()
1610 } else {
1611 resourceJars = append(slices.Clone(localResourceJars), deps.staticResourceJars...)
1612 }
1613 if len(resourceJars) == 1 {
1614 combinedResourceJar = resourceJars[0]
1615 } else if len(resourceJars) > 0 {
1616 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1617 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1618 false, nil, nil)
1619 combinedResourceJar = combinedJar
1620 }
1621
1622 manifest := j.overrideManifest
1623 if !manifest.Valid() && j.properties.Manifest != nil {
1624 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Jaewoong Jung26342642021-03-17 15:56:23 -07001625 }
1626
1627 // Combine the classes built from sources, any manifests, and any static libraries into
1628 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001629 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001630
Colin Crossa14fb6a2024-10-23 16:57:06 -07001631 completeStaticLibsImplementationJars := depset.New(depset.PREORDER, localImplementationJars, deps.transitiveStaticLibsImplementationJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001632
1633 var jars android.Paths
1634 if ctx.Config().UseTransitiveJarsInClasspath() {
1635 jars = completeStaticLibsImplementationJars.ToList()
1636 } else {
1637 jars = append(slices.Clone(localImplementationJars), deps.staticJars...)
1638 }
1639
1640 jars = append(jars, extraDepCombinedJars...)
1641
Jaewoong Jung26342642021-03-17 15:56:23 -07001642 if len(jars) == 1 && !manifest.Valid() {
1643 // Optimization: skip the combine step as there is nothing to do
1644 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1645 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001646 // any if len(extraJars) == 0.
Jaewoong Jung26342642021-03-17 15:56:23 -07001647
Jihoon Kang1147b312023-06-08 23:25:57 +00001648 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1649 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1650 // either with .from-source or .from-text suffix.
1651 // outputFile should be agnostic to the build configuration,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001652 // thus copy the single input static lib in order to prevent the static lib from being exposed
Jihoon Kang1147b312023-06-08 23:25:57 +00001653 // to the copy rules.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001654 if stub, _ := moduleStubLinkType(j); stub {
1655 copiedJar := android.PathForModuleOut(ctx, "combined", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001656 ctx.Build(pctx, android.BuildParams{
1657 Rule: android.Cp,
1658 Input: jars[0],
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001659 Output: copiedJar,
Jaewoong Jung26342642021-03-17 15:56:23 -07001660 })
Colin Crossa14fb6a2024-10-23 16:57:06 -07001661 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, android.Paths{copiedJar}, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001662 outputFile = copiedJar
Colin Cross7707b242024-07-26 12:02:36 -07001663 } else {
1664 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001665 }
1666 } else {
1667 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1668 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1669 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001670 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001671 }
1672
1673 // jarjar implementation jar if necessary
Makoto Onuki31db53a2024-12-06 16:40:47 -08001674 jarjarFile, jarjarred := j.jarjarIfNecessary(ctx, outputFile, jarName, "", true)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001675 if jarjarred {
1676 localImplementationJars = android.Paths{jarjarFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001677 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001678 }
Colin Crossedec77c2024-07-26 15:25:40 -07001679 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001680
Colin Crossedec77c2024-07-26 15:25:40 -07001681 // jarjar resource jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001682 if combinedResourceJar != nil {
Makoto Onuki31db53a2024-12-06 16:40:47 -08001683 resourceJarJarFile, jarjarred := j.jarjarIfNecessary(ctx, combinedResourceJar, jarName, "resource", false)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001684 combinedResourceJar = resourceJarJarFile
1685 if jarjarred {
1686 localResourceJars = android.Paths{resourceJarJarFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001687 completeStaticLibsResourceJars = depset.New(depset.PREORDER, localResourceJars, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001688 }
Colin Crossedec77c2024-07-26 15:25:40 -07001689 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001690
Colin Crossedec77c2024-07-26 15:25:40 -07001691 if ctx.Failed() {
Yu Liu460cf372025-01-10 00:34:06 +00001692 return nil
Jaewoong Jung26342642021-03-17 15:56:23 -07001693 }
1694
Makoto Onuki7ded3822024-03-28 14:42:20 -07001695 if j.ravenizer.enabled {
1696 ravenizerInput := outputFile
John Wub67040d2024-10-07 18:39:06 +00001697 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", "", jarName)
John Wu989ee842024-10-04 00:21:43 +00001698 ravenizerArgs := ""
1699 if proptools.Bool(j.properties.Ravenizer.Strip_mockito) {
1700 ravenizerArgs = "--strip-mockito"
1701 }
1702 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
Makoto Onuki7ded3822024-03-28 14:42:20 -07001703 outputFile = ravenizerOutput
Colin Cross7e863852024-09-06 14:42:38 -07001704 localImplementationJars = android.Paths{ravenizerOutput}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001705 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001706 if combinedResourceJar != nil {
1707 ravenizerInput = combinedResourceJar
1708 ravenizerOutput = android.PathForModuleOut(ctx, "ravenizer", "resources", jarName)
1709 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
1710 combinedResourceJar = ravenizerOutput
1711 localResourceJars = android.Paths{ravenizerOutput}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001712 completeStaticLibsResourceJars = depset.New(depset.PREORDER, localResourceJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001713 }
Makoto Onuki7ded3822024-03-28 14:42:20 -07001714 }
1715
Yihan Dong8be09c22024-08-29 15:32:13 +08001716 if j.shouldApiMapper() {
1717 inputFile := outputFile
1718 apiMapperFile := android.PathForModuleOut(ctx, "apimapper", jarName)
1719 ctx.Build(pctx, android.BuildParams{
1720 Rule: apimapper,
1721 Description: "apimapper",
1722 Input: inputFile,
1723 Output: apiMapperFile,
1724 })
1725 outputFile = apiMapperFile
Colin Cross7e863852024-09-06 14:42:38 -07001726 localImplementationJars = android.Paths{apiMapperFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001727 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Yihan Dong8be09c22024-08-29 15:32:13 +08001728 }
1729
Jaewoong Jung26342642021-03-17 15:56:23 -07001730 // Check package restrictions if necessary.
1731 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001732 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001733 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001734
1735 // Create a rule to copy the output jar to another path and add a validate dependency that
1736 // will check that the jar only contains the permitted packages. The new location will become
1737 // the output file of this module.
1738 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001739 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001740 ctx.Build(pctx, android.BuildParams{
1741 Rule: android.Cp,
1742 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001743 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001744 // Make sure that any dependency on the output file will cause ninja to run the package check
1745 // rule.
1746 Validation: pkgckFile,
1747 })
Colin Cross7707b242024-07-26 12:02:36 -07001748 outputFile = packageCheckOutputFile
Colin Cross7e863852024-09-06 14:42:38 -07001749 localImplementationJars = android.Paths{packageCheckOutputFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001750 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001751
1752 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001753 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001754
1755 if ctx.Failed() {
Yu Liu460cf372025-01-10 00:34:06 +00001756 return nil
Jaewoong Jung26342642021-03-17 15:56:23 -07001757 }
1758 }
1759
1760 j.implementationJarFile = outputFile
1761 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001762 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1763 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1764 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1765 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1766 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1767 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1768 j.headerJarFile = headerJarFile
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001769 if len(localImplementationJars) == 1 && ctx.Config().UseTransitiveJarsInClasspath() {
1770 localHeaderJarFile := android.PathForModuleOut(ctx, "local-javac-header", jarName)
1771 convertImplementationJarToHeaderJar(ctx, localImplementationJars[0], localHeaderJarFile)
1772 localHeaderJars = append(localHeaderJars, localHeaderJarFile)
1773 } else {
1774 localHeaderJars = append(localHeaderJars, headerJarFile)
1775 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001776 }
1777
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001778 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1779 specs := j.jacocoModuleToZipCommand(ctx)
1780 if ctx.Failed() {
Yu Liu460cf372025-01-10 00:34:06 +00001781 return nil
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001782 }
1783
Colin Crossb323c912024-09-24 15:21:00 -07001784 completeStaticLibsImplementationJarsToCombine := completeStaticLibsImplementationJars
1785
Colin Cross41698982024-11-13 11:31:31 -08001786 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Colin Crosse4f34882024-11-14 12:26:00 -08001787
1788 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
1789 compileDex := Bool(j.dexProperties.Compile_dex) || Bool(j.properties.Installable)
Colin Cross41698982024-11-13 11:31:31 -08001790
1791 if j.shouldInstrument(ctx) && (!ctx.Device() || compileDex) {
Colin Crossb323c912024-09-24 15:21:00 -07001792 instrumentedOutputFile := j.instrument(ctx, flags, outputFile, jarName, specs)
Colin Crossa14fb6a2024-10-23 16:57:06 -07001793 completeStaticLibsImplementationJarsToCombine = depset.New(depset.PREORDER, android.Paths{instrumentedOutputFile}, nil)
Colin Crossb323c912024-09-24 15:21:00 -07001794 outputFile = instrumentedOutputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001795 }
1796
1797 // merge implementation jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001798 var implementationAndResourcesJarsToCombine android.Paths
1799 if ctx.Config().UseTransitiveJarsInClasspath() {
1800 resourceJars := completeStaticLibsResourceJars.ToList()
1801 if len(resourceJars) > 0 {
Colin Crossb323c912024-09-24 15:21:00 -07001802 implementationAndResourcesJarsToCombine = append(resourceJars, completeStaticLibsImplementationJarsToCombine.ToList()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001803 implementationAndResourcesJarsToCombine = append(implementationAndResourcesJarsToCombine, extraDepCombinedJars...)
1804 }
1805 } else {
1806 if combinedResourceJar != nil {
1807 implementationAndResourcesJarsToCombine = android.Paths{combinedResourceJar, outputFile}
1808 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001809 }
1810
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001811 if len(implementationAndResourcesJarsToCombine) > 0 {
1812 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
1813 TransformJarsToJar(ctx, combinedJar, "for resources", implementationAndResourcesJarsToCombine, manifest,
1814 false, nil, nil)
1815 outputFile = combinedJar
1816 }
1817
1818 j.implementationAndResourcesJar = outputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001819
Colin Cross41698982024-11-13 11:31:31 -08001820 if ctx.Device() && compileDex {
Jaewoong Jung26342642021-03-17 15:56:23 -07001821 if j.hasCode(ctx) {
1822 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001823 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001824 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1825 }
1826 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001827 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001828 params := &compileDexParams{
1829 flags: flags,
1830 sdkVersion: j.SdkVersion(ctx),
1831 minSdkVersion: j.MinSdkVersion(ctx),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001832 classesJar: outputFile,
Spandan Dasc404cc72023-02-23 18:05:05 +00001833 jarName: jarName,
1834 }
Cole Fausteb032462024-09-19 11:12:54 -07001835 if j.GetProfileGuided(ctx) && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting(ctx) {
Spandan Das15a67112024-05-30 00:07:40 +00001836 ctx.PropertyErrorf("enable_profile_rewriting",
1837 "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.",
1838 )
1839 }
Cole Fausteb032462024-09-19 11:12:54 -07001840 if j.EnableProfileRewriting(ctx) {
1841 profile := j.GetProfile(ctx)
1842 if profile == "" || !j.GetProfileGuided(ctx) {
Spandan Das3dbda182024-05-20 22:23:10 +00001843 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1844 }
1845 params.artProfileInput = &profile
1846 }
1847 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001848 if ctx.Failed() {
Yu Liu460cf372025-01-10 00:34:06 +00001849 return nil
Jaewoong Jung26342642021-03-17 15:56:23 -07001850 }
1851
Spandan Das3dbda182024-05-20 22:23:10 +00001852 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1853 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001854 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001855 }
1856
Jaewoong Jung26342642021-03-17 15:56:23 -07001857 // merge dex jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001858 var dexAndResourceJarsToCombine android.Paths
1859 if ctx.Config().UseTransitiveJarsInClasspath() {
1860 resourceJars := completeStaticLibsResourceJars.ToList()
1861 if len(resourceJars) > 0 {
1862 dexAndResourceJarsToCombine = append(android.Paths{dexOutputFile}, resourceJars...)
1863 }
1864 } else {
1865 if combinedResourceJar != nil {
1866 dexAndResourceJarsToCombine = android.Paths{dexOutputFile, combinedResourceJar}
1867 }
1868 }
1869 if len(dexAndResourceJarsToCombine) > 0 {
Colin Cross7707b242024-07-26 12:02:36 -07001870 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001871 TransformJarsToJar(ctx, combinedJar, "for dex resources", dexAndResourceJarsToCombine, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001872 false, nil, nil)
1873 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001874 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001875 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001876 dexOutputFile = combinedAlignedJar
1877 } else {
1878 dexOutputFile = combinedJar
1879 }
1880 }
1881
Paul Duffin4de94502021-05-16 05:21:16 +01001882 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001883
1884 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001885
1886 // Encode hidden API flags in dex file, if needed.
1887 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1888
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001889 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001890
1891 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001892 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1893 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1894 libName = strings.TrimSuffix(libName, ".impl")
1895 }
1896 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001897
1898 outputFile = dexOutputFile
Colin Crossa6182ab2024-08-21 10:47:44 -07001899
1900 ctx.CheckbuildFile(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001901 } else {
1902 // There is no code to compile into a dex jar, make sure the resources are propagated
1903 // to the APK if this is an app.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001904 j.dexJarFile = makeDexJarPathFromPath(combinedResourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001905 }
1906
1907 if ctx.Failed() {
Yu Liu460cf372025-01-10 00:34:06 +00001908 return nil
Jaewoong Jung26342642021-03-17 15:56:23 -07001909 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001910 }
1911
1912 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001913 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001914 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001915 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001916 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001917 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001918 }
1919 }
1920
1921 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001922 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1923 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001924 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1925 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001926 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001927 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001928 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001929 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001930 j.linter.javaLanguageLevel = flags.javaVersion.String()
1931 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001932 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001933 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1934 j.linter.buildModuleReportZip = true
1935 }
1936 j.linter.lint(ctx)
1937 }
1938
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001939 j.collectTransitiveSrcFiles(ctx, srcFiles)
1940
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001941 if ctx.Config().UseTransitiveJarsInClasspath() {
1942 if len(localImplementationJars) > 0 || len(localResourceJars) > 0 || len(localHeaderJars) > 0 {
1943 ctx.CheckbuildFile(localImplementationJars...)
1944 ctx.CheckbuildFile(localResourceJars...)
1945 ctx.CheckbuildFile(localHeaderJars...)
1946 } else {
1947 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1948 ctx.UncheckedModule()
1949 }
1950 } else {
1951 ctx.CheckbuildFile(j.implementationJarFile)
1952 ctx.CheckbuildFile(j.headerJarFile)
1953 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001954
Yu Liu460cf372025-01-10 00:34:06 +00001955 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1956 j.outputFile = outputFile.WithoutRel()
1957
1958 return &JavaInfo{
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001959 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1960 RepackagedHeaderJars: android.PathsIfNonNil(repackagedHeaderJarFile),
1961
1962 LocalHeaderJars: localHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001963 TransitiveStaticLibsHeaderJars: depset.New(depset.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001964 TransitiveStaticLibsImplementationJars: completeStaticLibsImplementationJars,
1965 TransitiveStaticLibsResourceJars: completeStaticLibsResourceJars,
1966
Colin Cross9ffaf282024-08-12 13:50:09 -07001967 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1968 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001969 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1970 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001971 ResourceJars: android.PathsIfNonNil(combinedResourceJar),
Jihoon Kang705e63e2024-03-13 01:21:16 +00001972 AidlIncludeDirs: j.exportAidlIncludeDirs,
1973 SrcJarArgs: j.srcJarArgs,
1974 SrcJarDeps: j.srcJarDeps,
1975 TransitiveSrcFiles: j.transitiveSrcFiles,
1976 ExportedPlugins: j.exportedPluginJars,
1977 ExportedPluginClasses: j.exportedPluginClasses,
1978 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1979 JacocoReportClassesFile: j.jacocoReportClassesFile,
1980 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001981 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Yu Liu63bdf632024-12-03 19:54:05 +00001982 SdkVersion: j.SdkVersion(ctx),
Yu Liu7eebf8b2025-01-17 00:23:57 +00001983 OutputFile: j.outputFile,
Yu Liu460cf372025-01-10 00:34:06 +00001984 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001985}
1986
Cole Faustb7493472024-08-28 11:55:52 -07001987func (j *Module) useCompose(ctx android.BaseModuleContext) bool {
1988 return android.InList("androidx.compose.runtime_runtime", j.staticLibs(ctx))
Colin Crossa1ff7c62021-09-17 14:11:52 -07001989}
1990
Colin Crossa14fb6a2024-10-23 16:57:06 -07001991func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []depset.DepSet[android.Path]) {
Yu Liucbb50c22025-01-15 20:57:49 +00001992 ctx.VisitDirectDepsProxy(func(m android.ModuleProxy) {
Colin Cross313aa542023-12-13 13:47:44 -08001993 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001994 depTag := ctx.OtherModuleDependencyTag(m)
1995
Colin Crossa14fb6a2024-10-23 16:57:06 -07001996 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1997 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
Sam Delmerico95d70942023-08-02 18:00:35 -04001998
Colin Crossa14fb6a2024-10-23 16:57:06 -07001999 if depTag == staticLibTag {
Sam Delmerico95d70942023-08-02 18:00:35 -04002000 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
2001 }
2002 })
2003
Colin Crosscde55342024-03-27 14:11:51 -07002004 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
2005}
2006
2007func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
2008 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
2009
Sam Delmerico95d70942023-08-02 18:00:35 -04002010 directUnconditionalExportedFlags := android.Paths{}
2011 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
2012 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
2013 if exportUnconditionally {
2014 // if we explicitly export, then our unconditional exports are the same as our transitive flags
2015 transitiveUnconditionalExportedFlags = transitiveProguardFlags
2016 directUnconditionalExportedFlags = proguardFlagsForThisModule
2017 }
2018
2019 return ProguardSpecInfo{
2020 Export_proguard_flags_files: exportUnconditionally,
Colin Crossa14fb6a2024-10-23 16:57:06 -07002021 ProguardFlagsFiles: depset.New[android.Path](
2022 depset.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04002023 proguardFlagsForThisModule,
2024 transitiveProguardFlags,
2025 ),
Colin Crossa14fb6a2024-10-23 16:57:06 -07002026 UnconditionallyExportedProguardFlags: depset.New[android.Path](
2027 depset.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04002028 directUnconditionalExportedFlags,
2029 transitiveUnconditionalExportedFlags,
2030 ),
2031 }
2032
2033}
2034
Cole Faust75fffb12021-06-13 15:23:16 -07002035// Returns a copy of the supplied flags, but with all the errorprone-related
2036// fields copied to the regular build's fields.
2037func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
2038 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
2039
2040 if len(flags.errorProneExtraJavacFlags) > 0 {
2041 if len(flags.javacFlags) > 0 {
2042 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
2043 } else {
2044 flags.javacFlags = flags.errorProneExtraJavacFlags
2045 }
2046 }
2047 return flags
2048}
2049
Jaewoong Jung26342642021-03-17 15:56:23 -07002050func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07002051 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002052
2053 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00002054 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002055 if idx >= 0 {
2056 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00002057 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002058 jarName += strconv.Itoa(idx)
2059 }
2060
Colin Cross7707b242024-07-26 12:02:36 -07002061 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00002062 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07002063
Cole Faust9decf832024-06-11 11:45:53 -07002064 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002065 extractionFile := android.PathForModuleOut(ctx, kzipName)
2066 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
2067 j.kytheFiles = append(j.kytheFiles, extractionFile)
2068 }
2069
Vadim Spivak3c496f02023-06-08 06:14:59 +00002070 if len(flags.processorPath) > 0 {
2071 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
2072 }
2073
Jaewoong Jung26342642021-03-17 15:56:23 -07002074 return classes
2075}
2076
2077// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
2078// since some of these flags may be used internally.
2079func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
2080 for _, flag := range flags {
2081 flag = strings.TrimSpace(flag)
2082
2083 if !strings.HasPrefix(flag, "-") {
2084 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
2085 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
2086 ctx.PropertyErrorf("kotlincflags",
2087 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
Dave Mankoff1a7705d2025-01-08 03:06:21 +00002088 } else if slices.ContainsFunc(config.KotlincIllegalFlags, func(f string) bool {
2089 return strings.HasPrefix(flag, f)
2090 }) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002091 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
2092 } else if flag == "-include-runtime" {
2093 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
2094 } else {
2095 args := strings.Split(flag, " ")
2096 if args[0] == "-kotlin-home" {
2097 ctx.PropertyErrorf("kotlincflags",
2098 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
2099 }
2100 }
2101 }
2102}
2103
2104func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
2105 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002106 extraJars android.Paths) (localHeaderJars android.Paths, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002107
Jaewoong Jung26342642021-03-17 15:56:23 -07002108 if len(srcFiles) > 0 || len(srcJars) > 0 {
2109 // Compile java sources into turbine.jar.
2110 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
2111 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002112 localHeaderJars = append(localHeaderJars, turbineJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07002113 }
2114
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002115 localHeaderJars = append(localHeaderJars, extraJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002116
2117 // Combine any static header libraries into classes-header.jar. If there is only
2118 // one input jar this step will be skipped.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002119 var jars android.Paths
2120 if ctx.Config().UseTransitiveJarsInClasspath() {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002121 depSet := depset.New(depset.PREORDER, localHeaderJars, deps.transitiveStaticLibsHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002122 jars = depSet.ToList()
2123 } else {
2124 jars = append(slices.Clone(localHeaderJars), deps.staticHeaderJars...)
2125 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002126
2127 // we cannot skip the combine step for now if there is only one jar
2128 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07002129 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
2130 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07002131 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07002132
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002133 return localHeaderJars, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07002134}
2135
2136func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07002137 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002138
2139 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07002140 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07002141
2142 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
2143
2144 j.jacocoReportClassesFile = jacocoReportClassesFile
2145
2146 return instrumentedJar
2147}
2148
Colin Cross9ffaf282024-08-12 13:50:09 -07002149type providesTransitiveHeaderJarsForR8 struct {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002150 // set of header jars for all transitive libs deps
Colin Crossa14fb6a2024-10-23 16:57:06 -07002151 transitiveLibsHeaderJarsForR8 depset.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002152 // set of header jars for all transitive static libs deps
Colin Crossa14fb6a2024-10-23 16:57:06 -07002153 transitiveStaticLibsHeaderJarsForR8 depset.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002154}
2155
Colin Cross9ffaf282024-08-12 13:50:09 -07002156// collectTransitiveHeaderJarsForR8 visits direct dependencies and collects all transitive libs and static_libs
2157// header jars. The semantics of the collected jars are odd (it collects combined jars that contain the static
2158// libs, but also the static libs, and it collects transitive libs dependencies of static_libs), so these
2159// are only used to expand the --lib arguments to R8.
2160func (j *providesTransitiveHeaderJarsForR8) collectTransitiveHeaderJarsForR8(ctx android.ModuleContext) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002161 directLibs := android.Paths{}
2162 directStaticLibs := android.Paths{}
Colin Crossa14fb6a2024-10-23 16:57:06 -07002163 transitiveLibs := []depset.DepSet[android.Path]{}
2164 transitiveStaticLibs := []depset.DepSet[android.Path]{}
Yu Liu39f5fb32025-01-13 23:52:19 +00002165 ctx.VisitDirectDepsProxy(func(module android.ModuleProxy) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002166 // don't add deps of the prebuilt version of the same library
2167 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
2168 return
2169 }
2170
Colin Cross7727c7f2024-07-18 15:36:32 -07002171 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2172 tag := ctx.OtherModuleDependencyTag(module)
2173 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2174 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2175 directLibs = append(directLibs, dep.HeaderJars...)
2176 } else if tag == staticLibTag {
2177 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2178 } else {
2179 // Don't propagate transitive libs for other kinds of dependencies.
2180 return
2181 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002182
Colin Crossa14fb6a2024-10-23 16:57:06 -07002183 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJarsForR8)
2184 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJarsForR8)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002185 }
2186 })
Colin Crossa14fb6a2024-10-23 16:57:06 -07002187 j.transitiveLibsHeaderJarsForR8 = depset.New(depset.POSTORDER, directLibs, transitiveLibs)
2188 j.transitiveStaticLibsHeaderJarsForR8 = depset.New(depset.POSTORDER, directStaticLibs, transitiveStaticLibs)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002189}
2190
Jaewoong Jung26342642021-03-17 15:56:23 -07002191func (j *Module) HeaderJars() android.Paths {
2192 if j.headerJarFile == nil {
2193 return nil
2194 }
2195 return android.Paths{j.headerJarFile}
2196}
2197
2198func (j *Module) ImplementationJars() android.Paths {
2199 if j.implementationJarFile == nil {
2200 return nil
2201 }
2202 return android.Paths{j.implementationJarFile}
2203}
2204
Spandan Das59a4a2b2024-01-09 21:35:56 +00002205func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002206 return j.dexJarFile
2207}
2208
2209func (j *Module) DexJarInstallPath() android.Path {
2210 return j.installFile
2211}
2212
2213func (j *Module) ImplementationAndResourcesJars() android.Paths {
2214 if j.implementationAndResourcesJar == nil {
2215 return nil
2216 }
2217 return android.Paths{j.implementationAndResourcesJar}
2218}
2219
2220func (j *Module) AidlIncludeDirs() android.Paths {
2221 // exportAidlIncludeDirs is type android.Paths already
2222 return j.exportAidlIncludeDirs
2223}
2224
2225func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2226 return j.classLoaderContexts
2227}
2228
2229// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002230func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002231 if j.expandJarjarRules != nil {
2232 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Ilshat Aliyev8f99f6f2025-01-22 03:28:28 -08002233 }
2234 if j.headerJarFile != nil {
Spandan Das096b8d62024-10-08 22:41:26 +00002235 // Add the header jar so that the rdeps can be resolved to the repackaged classes.
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002236 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
Jaewoong Jung26342642021-03-17 15:56:23 -07002237 }
Spandan Das096b8d62024-10-08 22:41:26 +00002238 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2239 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2240 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002241 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2242 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Cole Faustb7493472024-08-28 11:55:52 -07002243 dpInfo.Static_libs = append(dpInfo.Static_libs, j.staticLibs(ctx)...)
Yikef6282022022-04-13 20:41:01 +08002244 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002245}
2246
2247func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002248 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002249}
2250
2251func (j *Module) hasCode(ctx android.ModuleContext) bool {
2252 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Yu Liu460cf372025-01-10 00:34:06 +00002253 return len(srcFiles) > 0 || len(ctx.GetDirectDepsProxyWithTag(staticLibTag)) > 0
Jaewoong Jung26342642021-03-17 15:56:23 -07002254}
2255
2256// Implements android.ApexModule
Colin Crossf7bbd2f2024-12-05 13:57:10 -08002257func (j *Module) OutgoingDepIsInSameApex(tag blueprint.DependencyTag) bool {
2258 return j.depIsInSameApex(tag)
Jaewoong Jung26342642021-03-17 15:56:23 -07002259}
2260
2261// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002262func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002263 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002264 minSdkVersion := j.MinSdkVersion(ctx)
2265 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002266 return fmt.Errorf("min_sdk_version is not specified")
2267 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002268 // If the module is compiling against core (via sdk_version), skip comparison check.
2269 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002270 return nil
2271 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002272 if minSdkVersion.GreaterThan(sdkVersion) {
2273 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002274 }
2275 return nil
2276}
2277
2278func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002279 if j.stem == "" {
2280 panic("Stem() called before stem property was set")
2281 }
2282 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002283}
2284
Jaewoong Jung26342642021-03-17 15:56:23 -07002285func (j *Module) JacocoReportClassesFile() android.Path {
2286 return j.jacocoReportClassesFile
2287}
2288
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002289func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002290 var fromDeps []depset.DepSet[android.Path]
Yu Liuc41eae52025-01-14 01:03:08 +00002291 ctx.VisitDirectDepsProxy(func(module android.ModuleProxy) {
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002292 tag := ctx.OtherModuleDependencyTag(module)
2293 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002294 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002295 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002296 }
2297 }
2298 })
2299
Colin Crossa14fb6a2024-10-23 16:57:06 -07002300 j.transitiveSrcFiles = depset.New(depset.POSTORDER, mine, fromDeps)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002301}
2302
Jaewoong Jung26342642021-03-17 15:56:23 -07002303func (j *Module) IsInstallable() bool {
2304 return Bool(j.properties.Installable)
2305}
2306
2307type sdkLinkType int
2308
2309const (
2310 // TODO(jiyong) rename these for better readability. Make the allowed
2311 // and disallowed link types explicit
2312 // order is important here. See rank()
2313 javaCore sdkLinkType = iota
2314 javaSdk
2315 javaSystem
2316 javaModule
2317 javaSystemServer
2318 javaPlatform
2319)
2320
2321func (lt sdkLinkType) String() string {
2322 switch lt {
2323 case javaCore:
2324 return "core Java API"
2325 case javaSdk:
2326 return "Android API"
2327 case javaSystem:
2328 return "system API"
2329 case javaModule:
2330 return "module API"
2331 case javaSystemServer:
2332 return "system server API"
2333 case javaPlatform:
2334 return "private API"
2335 default:
2336 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2337 }
2338}
2339
2340// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2341// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2342// can't statically depend on modules that use Platform API.
2343func (lt sdkLinkType) rank() int {
2344 return int(lt)
2345}
2346
2347type moduleWithSdkDep interface {
2348 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002349 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002350}
2351
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002352func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2353 switch k {
2354 case android.SdkCore:
2355 return javaCore
2356 case android.SdkSystem:
2357 return javaSystem
2358 case android.SdkPublic:
2359 return javaSdk
2360 case android.SdkModule:
2361 return javaModule
2362 case android.SdkSystemServer:
2363 return javaSystemServer
2364 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2365 return javaPlatform
2366 default:
2367 return javaSdk
2368 }
2369}
2370
Jiyong Park92315372021-04-02 08:45:46 +09002371func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002372 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002373 case android.SdkCore.DefaultJavaLibraryName(),
2374 "legacy.core.platform.api.stubs",
2375 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002376 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002377 "core-lambda-stubs",
Colin Crosse4f34882024-11-14 12:26:00 -08002378 "core-generated-annotation-stubs",
2379 // jacocoagent only uses core APIs, but has to specify a non-core sdk_version so it can use
2380 // a prebuilt SDK to avoid circular dependencies when it statically included in the bootclasspath.
2381 "jacocoagent":
Jaewoong Jung26342642021-03-17 15:56:23 -07002382 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002383 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002384 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002385 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002386 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002387 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002388 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002389 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002390 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002391 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002392 return javaSystem, true
2393 }
2394
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002395 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002396 return linkType, true
2397 }
2398
Jiyong Park92315372021-04-02 08:45:46 +09002399 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002400 if !ver.Valid() {
2401 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002402 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002403
2404 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002405}
2406
2407// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2408// this module's. See the comment on rank() for details and an example.
2409func (j *Module) checkSdkLinkType(
Yu Liuc0a36302025-01-10 22:26:01 +00002410 ctx android.ModuleContext, dep android.ModuleProxy) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002411 if ctx.Host() {
2412 return
2413 }
2414
Jiyong Park92315372021-04-02 08:45:46 +09002415 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002416 if stubs {
2417 return
2418 }
Yu Liuc0a36302025-01-10 22:26:01 +00002419 info, ok := android.OtherModuleProvider(ctx, dep, JavaInfoProvider)
2420 if !ok || info.ModuleWithSdkDepInfo == nil {
2421 panic(fmt.Errorf("dependency doesn't have ModuleWithSdkDepInfo: %v", dep))
2422 }
2423
2424 depLinkType := info.ModuleWithSdkDepInfo.SdkLinkType
Jaewoong Jung26342642021-03-17 15:56:23 -07002425
2426 if myLinkType.rank() < depLinkType.rank() {
2427 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2428 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2429 "property of the source or target module so that target module is built "+
2430 "with the same or smaller API set when compared to the source.",
2431 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2432 }
2433}
2434
2435func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2436 var deps deps
2437
Jiyong Park92315372021-04-02 08:45:46 +09002438 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002439
Colin Cross9ffaf282024-08-12 13:50:09 -07002440 j.collectTransitiveHeaderJarsForR8(ctx)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002441
Colin Crossa14fb6a2024-10-23 16:57:06 -07002442 var transitiveBootClasspathHeaderJars []depset.DepSet[android.Path]
2443 var transitiveClasspathHeaderJars []depset.DepSet[android.Path]
2444 var transitiveJava9ClasspathHeaderJars []depset.DepSet[android.Path]
2445 var transitiveStaticJarsHeaderLibs []depset.DepSet[android.Path]
2446 var transitiveStaticJarsImplementationLibs []depset.DepSet[android.Path]
2447 var transitiveStaticJarsResourceLibs []depset.DepSet[android.Path]
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002448
Yu Liu39f5fb32025-01-13 23:52:19 +00002449 ctx.VisitDirectDepsProxy(func(module android.ModuleProxy) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002450 otherName := ctx.OtherModuleName(module)
2451 tag := ctx.OtherModuleDependencyTag(module)
2452
2453 if IsJniDepTag(tag) {
2454 // Handled by AndroidApp.collectAppDeps
2455 return
2456 }
2457 if tag == certificateTag {
2458 // Handled by AndroidApp.collectAppDeps
2459 return
2460 }
2461
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002462 if sdkInfo, ok := android.OtherModuleProvider(ctx, module, SdkLibraryInfoProvider); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -07002463 switch tag {
Jihoon Kang28c96572024-09-11 23:44:44 +00002464 case sdkLibTag, libTag, staticLibTag:
Jihoon Kang28c96572024-09-11 23:44:44 +00002465 generatingLibsString := android.PrettyConcat(
2466 getGeneratingLibs(ctx, j.SdkVersion(ctx), module.Name(), sdkInfo), true, "or")
2467 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 -07002468 }
Colin Cross313aa542023-12-13 13:47:44 -08002469 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2470 if sdkLinkType != javaPlatform {
2471 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2472 // dep is a sysprop implementation library, but this module is not linking against
2473 // the platform, so it gets the sysprop public stubs library instead. Replace
2474 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2475 dep = syspropDep.JavaInfo
2476 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002477 }
2478 switch tag {
2479 case bootClasspathTag:
2480 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002481 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002482 case sdkLibTag, libTag, instrumentationForTag:
Yu Liu39f5fb32025-01-13 23:52:19 +00002483 if _, ok := android.OtherModuleProvider(ctx, module, JavaPluginInfoProvider); ok {
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002484 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2485 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002486 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002487 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002488 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2489 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2490 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2491 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002492 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2493 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2494 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002495
Colin Crossa14fb6a2024-10-23 16:57:06 -07002496 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002497 case java9LibTag:
2498 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002499 transitiveJava9ClasspathHeaderJars = append(transitiveJava9ClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002500 case staticLibTag:
Yu Liu39f5fb32025-01-13 23:52:19 +00002501 if _, ok := android.OtherModuleProvider(ctx, module, JavaPluginInfoProvider); ok {
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002502 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2503 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002504 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2505 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2506 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2507 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2508 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2509 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2510 // Turbine doesn't run annotation processors, so any module that uses an
2511 // annotation processor that generates API is incompatible with the turbine
2512 // optimization.
2513 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002514 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002515
Colin Crossa14fb6a2024-10-23 16:57:06 -07002516 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2517 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, dep.TransitiveStaticLibsHeaderJars)
2518 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, dep.TransitiveStaticLibsImplementationJars)
2519 transitiveStaticJarsResourceLibs = append(transitiveStaticJarsResourceLibs, dep.TransitiveStaticLibsResourceJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002520 case pluginTag:
Yu Liu39f5fb32025-01-13 23:52:19 +00002521 if plugin, ok := android.OtherModuleProvider(ctx, module, JavaPluginInfoProvider); ok {
2522 if plugin.ProcessorClass != nil {
2523 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.ProcessorClass)
Jaewoong Jung26342642021-03-17 15:56:23 -07002524 } else {
2525 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2526 }
2527 // Turbine doesn't run annotation processors, so any module that uses an
2528 // annotation processor that generates API is incompatible with the turbine
2529 // optimization.
Yu Liu39f5fb32025-01-13 23:52:19 +00002530 deps.disableTurbine = deps.disableTurbine || plugin.GeneratesApi
Jaewoong Jung26342642021-03-17 15:56:23 -07002531 } else {
2532 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2533 }
2534 case errorpronePluginTag:
Yu Liu39f5fb32025-01-13 23:52:19 +00002535 if _, ok := android.OtherModuleProvider(ctx, module, JavaPluginInfoProvider); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -07002536 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2537 } else {
2538 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2539 }
2540 case exportedPluginTag:
Yu Liu39f5fb32025-01-13 23:52:19 +00002541 if plugin, ok := android.OtherModuleProvider(ctx, module, JavaPluginInfoProvider); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -07002542 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
Yu Liu39f5fb32025-01-13 23:52:19 +00002543 if plugin.ProcessorClass != nil {
2544 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.ProcessorClass)
Jaewoong Jung26342642021-03-17 15:56:23 -07002545 }
2546 // Turbine doesn't run annotation processors, so any module that uses an
2547 // annotation processor that generates API is incompatible with the turbine
2548 // optimization.
Yu Liu39f5fb32025-01-13 23:52:19 +00002549 j.exportedDisableTurbine = plugin.GeneratesApi
Jaewoong Jung26342642021-03-17 15:56:23 -07002550 } else {
2551 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2552 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002553 case kotlinPluginTag:
Yu Liu39f5fb32025-01-13 23:52:19 +00002554 if _, ok := android.OtherModuleProvider(ctx, module, KotlinPluginInfoProvider); ok {
Luca Stefani50098f72024-10-12 17:55:31 +02002555 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
2556 } else {
2557 ctx.PropertyErrorf("kotlin_plugins", "%q is not a kotlin_plugin module", otherName)
2558 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002559 case syspropPublicStubDepTag:
2560 // This is a sysprop implementation library, forward the JavaInfoProvider from
2561 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002562 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002563 JavaInfo: dep,
2564 })
2565 }
Yu Liuc41eae52025-01-14 01:03:08 +00002566 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.SourceFilesInfoProvider); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -07002567 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002568 case sdkLibTag, libTag:
Yu Liu39f5fb32025-01-13 23:52:19 +00002569 checkProducesJars(ctx, dep, module)
2570 deps.classpath = append(deps.classpath, dep.Srcs...)
2571 deps.dexClasspath = append(deps.classpath, dep.Srcs...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002572 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars,
Yu Liu39f5fb32025-01-13 23:52:19 +00002573 depset.New(depset.PREORDER, dep.Srcs, nil))
Jaewoong Jung26342642021-03-17 15:56:23 -07002574 case staticLibTag:
Yu Liu39f5fb32025-01-13 23:52:19 +00002575 checkProducesJars(ctx, dep, module)
2576 deps.classpath = append(deps.classpath, dep.Srcs...)
2577 deps.staticJars = append(deps.staticJars, dep.Srcs...)
2578 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002579
Yu Liu39f5fb32025-01-13 23:52:19 +00002580 depHeaderJars := depset.New(depset.PREORDER, dep.Srcs, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002581 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJars)
2582 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, depHeaderJars)
2583 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, depHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002584 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002585 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002586 switch tag {
2587 case staticLibTag:
2588 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2589 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002590 } else {
2591 switch tag {
2592 case bootClasspathTag:
2593 // If a system modules dependency has been added to the bootclasspath
2594 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002595 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002596 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002597 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars,
2598 sm.TransitiveStaticLibsHeaderJars)
Colin Crossb61c2262024-08-08 14:04:42 -07002599 } else {
2600 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2601 ctx.OtherModuleName(module))
2602 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002603
2604 case systemModulesTag:
2605 if deps.systemModules != nil {
2606 panic("Found two system module dependencies")
2607 }
Colin Crossb61c2262024-08-08 14:04:42 -07002608 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2609 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2610 } else {
2611 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2612 ctx.OtherModuleName(module))
2613 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002614
2615 case instrumentationForTag:
2616 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 -07002617 }
2618 }
2619
Spandan Das8aac9932024-07-18 23:14:13 +00002620 if android.InList(tag, compileDependencyTags) {
2621 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2622 j.compileDepNames = append(j.compileDepNames, otherName)
2623 }
2624
Jaewoong Jung26342642021-03-17 15:56:23 -07002625 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002626 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002627 })
2628
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002629 deps.transitiveStaticLibsHeaderJars = transitiveStaticJarsHeaderLibs
2630 deps.transitiveStaticLibsImplementationJars = transitiveStaticJarsImplementationLibs
2631 deps.transitiveStaticLibsResourceJars = transitiveStaticJarsResourceLibs
2632
2633 if ctx.Config().UseTransitiveJarsInClasspath() {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002634 depSet := depset.New(depset.PREORDER, nil, transitiveClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002635 deps.classpath = depSet.ToList()
Colin Crossa14fb6a2024-10-23 16:57:06 -07002636 depSet = depset.New(depset.PREORDER, nil, transitiveBootClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002637 deps.bootClasspath = depSet.ToList()
Colin Crossa14fb6a2024-10-23 16:57:06 -07002638 depSet = depset.New(depset.PREORDER, nil, transitiveJava9ClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002639 deps.java9Classpath = depSet.ToList()
2640 }
2641
2642 if ctx.Device() {
2643 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
2644 if sdkDep.invalidVersion {
2645 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2646 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2647 } else if sdkDep.useFiles {
2648 // sdkDep.jar is actually equivalent to turbine header.jar.
2649 deps.classpath = append(slices.Clone(classpath(sdkDep.jars)), deps.classpath...)
2650 deps.dexClasspath = append(slices.Clone(classpath(sdkDep.jars)), deps.dexClasspath...)
2651 deps.aidlPreprocess = sdkDep.aidl
2652 // Add the sdk module dependency to `compileDepNames`.
2653 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2654 // TODO (b/358608607): Move this to decodeSdkDep
2655 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2656 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
2657 } else {
2658 deps.aidlPreprocess = sdkDep.aidl
2659 }
2660 }
2661
Jaewoong Jung26342642021-03-17 15:56:23 -07002662 return deps
2663}
2664
Joe Onorato349ae8d2024-02-05 22:46:00 +00002665// Provider for jarjar renaming rules.
2666//
2667// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2668// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2669// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2670// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2671// be renamed from that module.
2672// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002673type DependencyUse int
2674
2675const (
2676 RenameUseInvalid DependencyUse = iota
2677 RenameUseInclude
2678 RenameUseExclude
2679)
2680
Joe Onorato349ae8d2024-02-05 22:46:00 +00002681type JarJarProviderData struct {
2682 // Mapping of class names: original --> renamed. If the value is "", the class will be
2683 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2684 // attribute). Rdeps of that module will inherit the renaming.
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002685 Rename map[string]string
Joe Onorato349ae8d2024-02-05 22:46:00 +00002686}
2687
2688func (this JarJarProviderData) GetDebugString() string {
2689 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002690 for _, k := range android.SortedKeys(this.Rename) {
2691 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002692 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2693 result += k + "--&gt;" + v + ";"
2694 }
2695 }
2696 return result
2697}
2698
2699var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2700
2701var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2702
2703func init() {
2704 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
Yu Liu26a716d2024-08-30 23:40:32 +00002705
2706 gob.Register(BaseJarJarProviderData{})
Joe Onorato349ae8d2024-02-05 22:46:00 +00002707}
2708
2709// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2710// whether they are java modules or not.
2711type BaseJarJarProviderData struct {
2712 JarJarProviderData JarJarProviderData
2713}
2714
2715func (this BaseJarJarProviderData) GetDebugString() string {
2716 return this.JarJarProviderData.GetDebugString()
2717}
2718
2719var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2720
2721// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2722// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2723// either JarJarProvider or BaseJarJarProvider.
2724func mergeJarJarPrefixes(ctx android.ModuleContext) {
2725 mod := ctx.Module()
2726 // Explicitly avoid propagating into some module types.
2727 switch reflect.TypeOf(mod).String() {
2728 case "*java.Droidstubs":
2729 return
2730 }
2731 jarJarData := collectDirectDepsProviders(ctx)
2732 if jarJarData != nil {
2733 providerData := BaseJarJarProviderData{
2734 JarJarProviderData: *jarJarData,
2735 }
2736 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2737 }
2738
2739}
2740
2741// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2742func (module *Module) addJarJarRenameRule(original string, renamed string) {
2743 if module.jarjarRenameRules == nil {
2744 module.jarjarRenameRules = make(map[string]string)
2745 }
2746 module.jarjarRenameRules[original] = renamed
2747}
2748
2749func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2750 // Gather repackage information from deps
2751 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002752
2753 module := ctx.Module()
2754 moduleName := module.Name()
2755
Yu Liuc41eae52025-01-14 01:03:08 +00002756 ctx.VisitDirectDepsProxy(func(m android.ModuleProxy) {
LaMont Jones63683e42024-02-08 14:30:45 -08002757 tag := ctx.OtherModuleDependencyTag(m)
2758 // This logic mirrors that in (*Module).collectDeps above. There are several places
2759 // where we explicitly return RenameUseExclude, even though it is the default, to
2760 // indicate that it has been verified to be the case.
2761 //
2762 // Note well: there are probably cases that are getting to the unconditional return
2763 // and are therefore wrong.
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002764 shouldIncludeRenames := func() DependencyUse {
LaMont Jones63683e42024-02-08 14:30:45 -08002765 if moduleName == m.Name() {
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002766 return RenameUseInclude // If we have the same module name, include the renames.
LaMont Jones63683e42024-02-08 14:30:45 -08002767 }
2768 if sc, ok := module.(android.SdkContext); ok {
2769 if ctx.Device() {
2770 sdkDep := decodeSdkDep(ctx, sc)
2771 if !sdkDep.invalidVersion && sdkDep.useFiles {
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002772 return RenameUseExclude
Joe Onorato349ae8d2024-02-05 22:46:00 +00002773 }
2774 }
LaMont Jones63683e42024-02-08 14:30:45 -08002775 }
2776 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002777 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002778 }
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002779 if _, ok := android.OtherModuleProvider(ctx, m, SdkLibraryInfoProvider); ok {
LaMont Jones63683e42024-02-08 14:30:45 -08002780 switch tag {
2781 case sdkLibTag, libTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002782 return RenameUseExclude // matches collectDeps()
LaMont Jones63683e42024-02-08 14:30:45 -08002783 }
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002784 return RenameUseInvalid // dep is not used in collectDeps()
LaMont Jones63683e42024-02-08 14:30:45 -08002785 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2786 switch ji.StubsLinkType {
2787 case Stubs:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002788 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002789 case Implementation:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002790 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002791 default:
LaMont Jones09721862024-06-11 10:30:50 -07002792 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002793 // Fall through to the heuristic logic.
2794 }
Yu Liuc41eae52025-01-14 01:03:08 +00002795 if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
LaMont Jones63683e42024-02-08 14:30:45 -08002796 // Probably a java_aconfig_library module.
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002797 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002798 }
2799 switch tag {
2800 case bootClasspathTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002801 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002802 case sdkLibTag, libTag, instrumentationForTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002803 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002804 case java9LibTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002805 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002806 case staticLibTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002807 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002808 case pluginTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002809 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002810 case errorpronePluginTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002811 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002812 case exportedPluginTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002813 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002814 case kotlinPluginTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002815 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002816 default:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002817 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002818 }
Yu Liuc41eae52025-01-14 01:03:08 +00002819 } else if _, ok := android.OtherModuleProvider(ctx, m, android.SourceFilesInfoProvider); ok {
LaMont Jones63683e42024-02-08 14:30:45 -08002820 switch tag {
2821 case sdkLibTag, libTag, staticLibTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002822 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002823 default:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002824 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002825 }
Yu Liu67a28422024-03-05 00:36:31 +00002826 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002827 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002828 } else {
2829 switch tag {
2830 case bootClasspathTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002831 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002832 case systemModulesTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002833 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002834 }
2835 }
2836 // If we got here, choose the safer option, which may lead to a build failure, rather
2837 // than runtime failures on the device.
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002838 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002839 }
2840
2841 if result == nil {
2842 result = &JarJarProviderData{
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002843 Rename: make(map[string]string),
LaMont Jones63683e42024-02-08 14:30:45 -08002844 }
2845 }
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002846 how := shouldIncludeRenames()
LaMont Jones63683e42024-02-08 14:30:45 -08002847 if how != RenameUseInclude {
2848 // Nothing to merge.
2849 return
2850 }
2851
2852 merge := func(theirs *JarJarProviderData) {
2853 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002854 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2855 result.Rename[orig] = renamed
2856 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2857 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2858 result.Rename[orig] = renamed
2859 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2860 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2861 continue
2862 }
2863 }
2864 }
2865 }
2866 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2867 merge(&theirs)
2868 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2869 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2870 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2871 // to java.Module.
2872 merge(&theirs.JarJarProviderData)
2873 }
2874 })
2875 return
2876}
2877
2878func (this Module) GetDebugString() string {
2879 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2880}
2881
2882// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2883// us, and if it's been set, apply the jarjar_prefix property to rename them.
2884func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2885 // Gather repackage information from deps
2886 result := collectDirectDepsProviders(ctx)
2887
Joe Onoratoa5d17172024-07-20 17:39:56 -07002888 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002889 if result == nil {
2890 result = &JarJarProviderData{
2891 Rename: make(map[string]string),
2892 }
2893 }
2894 if renamed != "" {
2895 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2896 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002897 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002898 }
2899 }
2900 (*result).Rename[orig] = renamed
2901 }
2902
Joe Onoratoa5d17172024-07-20 17:39:56 -07002903 // Update that with entries we've stored for ourself
2904 for orig, renamed := range module.jarjarRenameRules {
2905 add(orig, renamed)
2906 }
2907
2908 // Update that with entries given in the jarjar_rename property.
2909 for _, orig := range module.properties.Jarjar_rename {
2910 add(orig, "")
2911 }
2912
Joe Onorato349ae8d2024-02-05 22:46:00 +00002913 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2914 if result == nil {
2915 return nil
2916 }
2917
2918 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2919 // that have not yet been renamed.
2920 prefix := proptools.String(module.properties.Jarjar_prefix)
2921 if prefix != "" {
2922 if prefix[0] == '.' {
2923 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2924 return nil
2925 }
2926 if prefix[len(prefix)-1] == '.' {
2927 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2928 return nil
2929 }
2930
2931 var updated map[string]string
2932 for orig, renamed := range (*result).Rename {
2933 if renamed == "" {
2934 if updated == nil {
2935 updated = make(map[string]string)
2936 }
2937 updated[orig] = prefix + "." + orig
2938 }
2939 }
2940 for orig, renamed := range updated {
2941 (*result).Rename[orig] = renamed
2942 }
2943 }
2944
2945 return result
2946}
2947
2948// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2949// to "" won't be in this list because they shouldn't be renamed yet.
2950func getJarJarRuleText(provider *JarJarProviderData) string {
Colin Crosse27e4bf2025-02-11 13:17:53 -08002951 result := strings.Builder{}
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002952 for _, orig := range android.SortedKeys(provider.Rename) {
2953 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002954 if renamed != "" {
Colin Crosse27e4bf2025-02-11 13:17:53 -08002955 result.WriteString("rule ")
2956 result.WriteString(orig)
2957 result.WriteString(" ")
2958 result.WriteString(renamed)
2959 result.WriteString("\n")
Joe Onorato349ae8d2024-02-05 22:46:00 +00002960 }
2961 }
Colin Crosse27e4bf2025-02-11 13:17:53 -08002962 return result.String()
Joe Onorato349ae8d2024-02-05 22:46:00 +00002963}
2964
Zi Wangddb2ee52024-04-02 16:44:02 +00002965// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002966func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Zi Wangddb2ee52024-04-02 16:44:02 +00002967 if j.repackageJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002968 return infile, false
Zi Wangddb2ee52024-04-02 16:44:02 +00002969 }
Colin Crossedec77c2024-07-26 15:25:40 -07002970 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002971 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002972 return repackagedJarjarFile, true
Zi Wangddb2ee52024-04-02 16:44:02 +00002973}
2974
Makoto Onuki31db53a2024-12-06 16:40:47 -08002975func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string, useShards bool) (android.Path, bool) {
Colin Crossedec77c2024-07-26 15:25:40 -07002976 if j.expandJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002977 return infile, false
Colin Crossedec77c2024-07-26 15:25:40 -07002978 }
2979 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
Makoto Onuki31db53a2024-12-06 16:40:47 -08002980
2981 totalShards := 1
2982 if useShards {
2983 totalShardsStr := j.properties.Jarjar_shards.GetOrDefault(ctx, "1")
2984 ts, err := strconv.Atoi(totalShardsStr)
2985 if err != nil {
2986 ctx.PropertyErrorf("jarjar_shards", "jarjar_shards must be an integer represented as a string")
2987 return infile, false
2988 }
2989 totalShards = ts
2990 }
2991 TransformJarJarWithShards(ctx, jarjarFile, infile, j.expandJarjarRules, totalShards)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002992 return jarjarFile, true
Colin Crossedec77c2024-07-26 15:25:40 -07002993
2994}
2995
Jaewoong Jung26342642021-03-17 15:56:23 -07002996func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2997 deps.processorPath = append(deps.processorPath, pluginJars...)
2998 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2999}
3000
3001// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
3002// this interface.
3003type ProvidesUsesLib interface {
3004 ProvidesUsesLib() *string
3005}
3006
3007func (j *Module) ProvidesUsesLib() *string {
3008 return j.usesLibraryProperties.Provides_uses_lib
3009}
satayev1c564cc2021-05-25 19:50:30 +01003010
3011type ModuleWithStem interface {
3012 Stem() string
3013}
3014
3015var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00003016
3017type ModuleWithUsesLibrary interface {
3018 UsesLibrary() *usesLibrary
3019}
3020
3021func (j *Module) UsesLibrary() *usesLibrary {
3022 return &j.usesLibrary
3023}
3024
3025var _ ModuleWithUsesLibrary = (*Module)(nil)