blob: a2fc29de745e88e9c9d943b612f87f08c2ace8b5 [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.
659 ctx.VisitDirectDeps(func(module android.Module) {
660 tag := ctx.OtherModuleDependencyTag(module)
661 switch module.(type) {
662 // TODO(satayev): cover other types as well, e.g. imports
663 case *Library, *AndroidLibrary:
664 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400665 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700666 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
667 }
668 }
669 })
670}
671
672func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900673 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700674 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900675 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700676 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000677 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 -0700678 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000679 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 -0700680 }
681
682 }
683}
684
Mark Whitea15790a2023-08-22 21:28:11 +0000685func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
686 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400687 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000688 installable := proptools.Bool(j.properties.Installable)
689
690 if headersOnly && installable {
691 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.")
692 }
693 }
694}
695
Jaewoong Jung26342642021-03-17 15:56:23 -0700696func (j *Module) addHostProperties() {
697 j.AddProperties(
698 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000699 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700700 &j.protoProperties,
701 &j.usesLibraryProperties,
702 )
703}
704
705func (j *Module) addHostAndDeviceProperties() {
706 j.addHostProperties()
707 j.AddProperties(
708 &j.deviceProperties,
709 &j.dexer.dexProperties,
710 &j.dexpreoptProperties,
711 &j.linter.properties,
712 )
713}
714
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000715// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
716// makes it available through the hiddenAPIPropertyInfoProvider.
717func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
718 hiddenAPIInfo := newHiddenAPIPropertyInfo()
719
720 // Populate with flag file paths from the properties.
721 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
722
723 // Populate with package rules from the properties.
724 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
725
Colin Cross40213022023-12-13 15:19:49 -0800726 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000727}
728
mrziwang9f7b9f42024-07-10 12:18:06 -0700729// helper method for java modules to set OutputFilesProvider
730func setOutputFiles(ctx android.ModuleContext, m Module) {
Cole Faust5146e782024-11-15 14:47:49 -0800731 ctx.SetOutputFiles(append(android.PathsIfNonNil(m.outputFile), m.extraOutputFiles...), "")
732 ctx.SetOutputFiles(android.PathsIfNonNil(m.outputFile), android.DefaultDistTag)
733 ctx.SetOutputFiles(android.PathsIfNonNil(m.implementationAndResourcesJar), ".jar")
734 ctx.SetOutputFiles(android.PathsIfNonNil(m.headerJarFile), ".hjar")
mrziwang9f7b9f42024-07-10 12:18:06 -0700735 if m.dexer.proguardDictionary.Valid() {
736 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
737 }
738 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
Jaewoong Jung26342642021-03-17 15:56:23 -0700739}
740
Jaewoong Jung26342642021-03-17 15:56:23 -0700741func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
742 initJavaModule(module, hod, false)
743}
744
745func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
746 initJavaModule(module, hod, true)
747}
748
749func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
750 multilib := android.MultilibCommon
751 if multiTargets {
752 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
753 } else {
754 android.InitAndroidArchModule(module, hod, multilib)
755 }
756 android.InitDefaultableModule(module)
757}
758
759func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
760 return j.properties.Instrument &&
761 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
762 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
763}
764
Yihan Dong8be09c22024-08-29 15:32:13 +0800765func (j *Module) shouldApiMapper() bool {
766 return j.properties.ApiMapper
767}
768
Jaewoong Jung26342642021-03-17 15:56:23 -0700769func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000770 return j.properties.Supports_static_instrumentation &&
771 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700772 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
773 ctx.Config().UnbundledBuild())
774}
775
776func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
777 // Force enable the instrumentation for java code that is built for APEXes ...
778 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
779 // 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 -0800780 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700781 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000782
Colin Crosse4f34882024-11-14 12:26:00 -0800783 compileDex := Bool(j.dexProperties.Compile_dex) || Bool(j.properties.Installable)
784 if compileDex && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700785 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
786 return true
787 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
788 return true
789 }
790 }
791 return false
792}
793
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400794func (j *Module) setInstrument(value bool) {
795 j.properties.Instrument = value
796}
797
Yihan Dong8be09c22024-08-29 15:32:13 +0800798func (j *Module) setApiMapper(value bool) {
799 j.properties.ApiMapper = value
800}
801
Jiyong Park92315372021-04-02 08:45:46 +0900802func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
803 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700804}
805
Jiyong Parkf1691d22021-03-29 20:11:58 +0900806func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700807 return proptools.String(j.deviceProperties.System_modules)
808}
809
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000810func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000811 if j.overridableProperties.Min_sdk_version != nil {
812 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700813 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000814 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700815}
816
Yu Liuf2b94012023-09-19 15:09:10 -0700817func (j *Module) GetDeviceProperties() *DeviceProperties {
818 return &j.deviceProperties
819}
820
Spandan Dasa26eda72023-03-02 00:56:06 +0000821func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
822 if j.deviceProperties.Max_sdk_version != nil {
823 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
824 }
825 // Default is PrivateApiLevel
826 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000827}
828
Spandan Dasa26eda72023-03-02 00:56:06 +0000829func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
830 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
831 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
832 }
833 // Default is PrivateApiLevel
834 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000835}
836
Jiyong Parkf1691d22021-03-29 20:11:58 +0900837func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000838 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900839}
840
Spandan Dasca70fc42023-03-01 23:38:49 +0000841func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900842 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000843 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900844 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000845 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700846}
847
848func (j *Module) AvailableFor(what string) bool {
Yu Liub73c3a62024-12-10 00:58:06 +0000849 return android.CheckAvailableForApex(what, j.ApexAvailableFor())
850}
851
852func (j *Module) ApexAvailableFor() []string {
853 list := j.ApexModuleBase.ApexAvailable()
854 if Bool(j.deviceProperties.Hostdex) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700855 // Exception: for hostdex: true libraries, the platform variant is created
856 // even if it's not marked as available to platform. In that case, the platform
857 // variant is used only for the hostdex and not installed to the device.
Yu Liub73c3a62024-12-10 00:58:06 +0000858 list = append(list, android.AvailableToPlatform)
Jaewoong Jung26342642021-03-17 15:56:23 -0700859 }
Yu Liub73c3a62024-12-10 00:58:06 +0000860 return android.FirstUniqueStrings(list)
Jaewoong Jung26342642021-03-17 15:56:23 -0700861}
862
Cole Faustb7493472024-08-28 11:55:52 -0700863func (j *Module) staticLibs(ctx android.BaseModuleContext) []string {
Jihoon Kang8bce3812024-09-30 18:46:51 +0000864 return j.properties.Static_libs.GetOrDefault(ctx, nil)
Cole Faustb7493472024-08-28 11:55:52 -0700865}
866
Jaewoong Jung26342642021-03-17 15:56:23 -0700867func (j *Module) deps(ctx android.BottomUpMutatorContext) {
868 if ctx.Device() {
869 j.linter.deps(ctx)
870
Jiyong Parkf1691d22021-03-29 20:11:58 +0900871 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700872
873 if j.deviceProperties.SyspropPublicStub != "" {
874 // This is a sysprop implementation library that has a corresponding sysprop public
875 // stubs library, and a dependency on it so that dependencies on the implementation can
876 // be forwarded to the public stubs library when necessary.
877 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
878 }
879 }
880
881 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000882
Cole Faustb7493472024-08-28 11:55:52 -0700883 ctx.AddVariationDependencies(nil, staticLibTag, j.staticLibs(ctx)...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700884
885 // Add dependency on libraries that provide additional hidden api annotations.
886 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
887
Jaewoong Jung26342642021-03-17 15:56:23 -0700888 // For library dependencies that are component libraries (like stubs), add the implementation
889 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
890 for _, dep := range libDeps {
891 if dep != nil {
892 if component, ok := dep.(SdkLibraryComponentDependency); ok {
893 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000894 // Add library as optional if it's one of the optional compatibility libs or it's
895 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100896 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000897 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
Cole Faust64f2d842024-10-17 13:28:34 -0700898 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs.GetOrDefault(ctx, nil)) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100899 tag = usesLibOptTag
900 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100901 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700902 }
903 }
904 }
905 }
906
907 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Luca Stefani50098f72024-10-12 17:55:31 +0200908 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag, j.properties.Kotlin_plugins...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700909 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
910 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
911
912 android.ProtoDeps(ctx, &j.protoProperties)
913 if j.hasSrcExt(".proto") {
914 protoDeps(ctx, &j.protoProperties)
915 }
916
917 if j.hasSrcExt(".kt") {
918 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
919 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700920 tag := staticLibTag
921 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
922 tag = libTag
923 }
924 ctx.AddVariationDependencies(nil, tag,
925 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700926 }
927
928 // Framework libraries need special handling in static coverage builds: they should not have
929 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
930 // the same jacoco classes coming from different bootclasspath jars.
931 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
932 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
933 j.properties.Instrument = true
934 }
935 } else if j.shouldInstrumentStatic(ctx) {
936 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
937 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700938
Cole Faustb7493472024-08-28 11:55:52 -0700939 if j.useCompose(ctx) {
Colin Crossa1ff7c62021-09-17 14:11:52 -0700940 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
Dave Mankoff0a3ef842024-10-02 18:47:24 +0000941 "kotlin-compose-compiler-plugin")
Colin Crossa1ff7c62021-09-17 14:11:52 -0700942 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700943}
944
945func hasSrcExt(srcs []string, ext string) bool {
946 for _, src := range srcs {
947 if filepath.Ext(src) == ext {
948 return true
949 }
950 }
951
952 return false
953}
954
955func (j *Module) hasSrcExt(ext string) bool {
956 return hasSrcExt(j.properties.Srcs, ext)
957}
958
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100959func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
960 var flags string
961
962 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
963 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
964 flags = "-Wmissing-permission-annotation -Werror"
965 }
966 }
967 return flags
968}
969
Jaewoong Jung26342642021-03-17 15:56:23 -0700970func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000971 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700972
973 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
974 aidlIncludes = append(aidlIncludes,
975 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
976 aidlIncludes = append(aidlIncludes,
977 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
978
979 var flags []string
980 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000981 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700982
983 flags = append(flags, j.deviceProperties.Aidl.Flags...)
984
985 if aidlPreprocess.Valid() {
986 flags = append(flags, "-p"+aidlPreprocess.String())
987 deps = append(deps, aidlPreprocess.Path())
988 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000989 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700990 }
991
992 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000993 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700994 }
995
996 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000997 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700998 }
999
Sam Delmerico2351eac2022-05-24 17:10:02 +00001000 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -07001001 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +00001002 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -07001003 }
Sam Delmerico2351eac2022-05-24 17:10:02 +00001004 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
1005 // add flags for dirs containing AIDL srcs that haven't been specified yet
1006 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -07001007
Zim8774ae12022-08-17 11:46:34 +01001008 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +00001009 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +01001010 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001011 flags = append(flags, "-t")
1012 }
1013
1014 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
1015 flags = append(flags, "--transaction_names")
1016 }
1017
Thiébaud Weksteende8417c2022-02-10 15:41:46 +11001018 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
1019 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
1020 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1021 }
1022
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001023 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001024 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1025
Jaewoong Jung26342642021-03-17 15:56:23 -07001026 return strings.Join(flags, " "), deps
1027}
1028
1029func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1030
1031 var flags javaBuilderFlags
1032
1033 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001034 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001035
Cole Faust2b1536e2021-06-18 12:25:54 -07001036 epEnabled := j.properties.Errorprone.Enabled
1037 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001038 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001039 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1040 }
1041
1042 errorProneFlags := []string{
1043 "-Xplugin:ErrorProne",
1044 "${config.ErrorProneChecks}",
1045 }
1046 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1047
Colin Cross8bf6cad2022-02-28 13:07:03 -08001048 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001049 "'" + strings.Join(errorProneFlags, " ") + "'"
1050 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1051 }
1052
1053 // classpath
1054 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1055 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001056 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001057 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1058 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1059 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1060
1061 flags.processors = append(flags.processors, deps.processorClasses...)
1062 flags.processors = android.FirstUniqueStrings(flags.processors)
1063
1064 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001065 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001066 // Give host-side tools a version of OpenJDK's standard libraries
1067 // close to what they're targeting. As of Dec 2017, AOSP is only
1068 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1069 //
1070 // When building with OpenJDK 8, the following should have no
1071 // effect since those jars would be available by default.
1072 //
1073 // When building with OpenJDK 9 but targeting a version < 1.8,
1074 // putting them on the bootclasspath means that:
1075 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1076 // b) references to existing APIs are not reinterpreted in an
1077 // OpenJDK 9-specific way, eg. calls to subclasses of
1078 // java.nio.Buffer as in http://b/70862583
1079 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1080 flags.bootClasspath = append(flags.bootClasspath,
1081 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1082 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1083 if Bool(j.properties.Use_tools_jar) {
1084 flags.bootClasspath = append(flags.bootClasspath,
1085 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1086 }
1087 }
1088
1089 // systemModules
1090 flags.systemModules = deps.systemModules
1091
Jaewoong Jung26342642021-03-17 15:56:23 -07001092 return flags
1093}
1094
1095func (j *Module) collectJavacFlags(
1096 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1097 // javac flags.
1098 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001099 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001100
Mythri Alle4b9f6182023-10-25 15:17:11 +00001101 needsDebugInfo = false
1102 for _, flag := range javacFlags {
1103 if strings.HasPrefix(flag, "-g") {
1104 needsDebugInfo = true
1105 }
1106 }
1107
1108 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001109 // For non-host binaries, override the -g flag passed globally to remove
1110 // local variable debug info to reduce disk and memory usage.
1111 javacFlags = append(javacFlags, "-g:source,lines")
1112 }
1113 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1114
1115 if flags.javaVersion.usesJavaModules() {
1116 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001117 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1118 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1119 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1120 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001121
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001122 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001123 if j.properties.Patch_module != nil {
1124 // Manually specify build directory in case it is not under the repo root.
1125 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1126 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001127 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001128
Jaewoong Jung26342642021-03-17 15:56:23 -07001129 classPath := flags.classpath.FormJavaClassPath("")
1130 if classPath != "" {
1131 patchPaths = append(patchPaths, classPath)
1132 }
1133 javacFlags = append(
1134 javacFlags,
1135 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1136 }
1137 }
1138
1139 if len(javacFlags) > 0 {
1140 // optimization.
1141 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1142 flags.javacFlags = "$javacFlags"
1143 }
1144
1145 return flags
1146}
1147
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001148func (j *Module) AddJSONData(d *map[string]interface{}) {
1149 (&j.ModuleBase).AddJSONData(d)
1150 (*d)["Java"] = map[string]interface{}{
1151 "SourceExtensions": j.sourceExtensions,
1152 }
1153
1154}
1155
usta0391ca42023-09-19 15:51:59 -04001156func (j *Module) addGeneratedSrcJars(path android.Path) {
1157 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001158}
1159
Colin Crossfdaa6722024-08-23 11:58:08 -07001160func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars, extraDepCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001161 // Auto-propagating jarjar rules
1162 jarjarProviderData := j.collectJarJarRules(ctx)
1163 if jarjarProviderData != nil {
1164 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wangddb2ee52024-04-02 16:44:02 +00001165 text := getJarJarRuleText(jarjarProviderData)
1166 if text != "" {
1167 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1168 android.WriteFileRule(ctx, ruleTextFile, text)
1169 j.repackageJarjarRules = ruleTextFile
Joe Onorato349ae8d2024-02-05 22:46:00 +00001170 }
1171 }
1172
Jaewoong Jung26342642021-03-17 15:56:23 -07001173 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1174
John Wu989ee842024-10-04 00:21:43 +00001175 // Only override the original value if explicitly set
1176 if j.properties.Ravenizer.Enabled != nil {
1177 j.ravenizer.enabled = *j.properties.Ravenizer.Enabled
Makoto Onuki7ded3822024-03-28 14:42:20 -07001178 }
1179
Jaewoong Jung26342642021-03-17 15:56:23 -07001180 deps := j.collectDeps(ctx)
1181 flags := j.collectBuilderFlags(ctx, deps)
1182
1183 if flags.javaVersion.usesJavaModules() {
1184 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001185 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1186 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1187 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001188 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001189
Jaewoong Jung26342642021-03-17 15:56:23 -07001190 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001191 j.sourceExtensions = []string{}
1192 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1193 if hasSrcExt(srcFiles.Strings(), ext) {
1194 j.sourceExtensions = append(j.sourceExtensions, ext)
1195 }
1196 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001197 if hasSrcExt(srcFiles.Strings(), ".proto") {
1198 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1199 }
1200
Dave Mankoff0a3ef842024-10-02 18:47:24 +00001201 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, j.properties.Exclude_common_srcs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001202 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1203 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1204 }
1205
Sam Delmerico2351eac2022-05-24 17:10:02 +00001206 aidlSrcs := srcFiles.FilterByExt(".aidl")
1207 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1208
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001209 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001210 srcFiles = j.genSources(ctx, srcFiles, flags)
1211
1212 // Collect javac flags only after computing the full set of srcFiles to
1213 // ensure that the --patch-module lookup paths are complete.
1214 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1215
1216 srcJars := srcFiles.FilterByExt(".srcjar")
1217 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001218 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001219 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001220 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001221
1222 if j.properties.Jarjar_rules != nil {
1223 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1224 }
1225
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001226 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001227
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001228 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001229 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001230 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001231 if _, found := set[v.String()]; !found {
1232 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001233 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001234 }
1235 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001236 var uniqueKtFiles android.Paths
1237 for _, v := range srcFiles.FilterByExt(".kt") {
1238 if _, found := set[v.String()]; !found {
1239 set[v.String()] = true
1240 uniqueKtFiles = append(uniqueKtFiles, v)
1241 }
1242 }
1243
1244 var uniqueSrcFiles android.Paths
1245 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1246 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1247 j.uniqueSrcFiles = uniqueSrcFiles
Jaewoong Jung26342642021-03-17 15:56:23 -07001248
Colin Crossb5db4012022-03-28 17:12:39 -07001249 // We don't currently run annotation processors in turbine, which means we can't use turbine
1250 // generated header jars when an annotation processor that generates API is enabled. One
1251 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1252 // is used to run all of the annotation processors.
1253 disableTurbine := deps.disableTurbine
1254
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001255 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001256 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1257
Colin Cross220a9a12022-03-28 17:08:01 -07001258 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001259
Colin Cross4eae06d2023-06-20 22:40:02 -07001260 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1261 // any dependencies so that it can override any non-final R classes from dependencies with the
1262 // final R classes from the app.
1263 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1264
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001265 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1266
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001267 var localImplementationJars android.Paths
1268
Mark Whitea15790a2023-08-22 21:28:11 +00001269 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001270 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001271 if srcFiles.HasExt(".kt") {
1272 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1273 }
1274 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1275 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1276 }
1277
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001278 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1279
1280 localHeaderJars, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
Colin Crossedec77c2024-07-26 15:25:40 -07001281 extraCombinedJars)
1282
Makoto Onuki31db53a2024-12-06 16:40:47 -08001283 combinedHeaderJarFile, jarjared := j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine", false)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001284 if jarjared {
1285 localHeaderJars = android.Paths{combinedHeaderJarFile}
1286 transitiveStaticLibsHeaderJars = nil
1287 }
1288 combinedHeaderJarFile, repackaged := j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
1289 if repackaged {
1290 localHeaderJars = android.Paths{combinedHeaderJarFile}
1291 transitiveStaticLibsHeaderJars = nil
1292 }
Mark Whitea15790a2023-08-22 21:28:11 +00001293 if ctx.Failed() {
1294 return
1295 }
Colin Crossedec77c2024-07-26 15:25:40 -07001296 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001297
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001298 if ctx.Config().UseTransitiveJarsInClasspath() {
1299 if len(localHeaderJars) > 0 {
1300 ctx.CheckbuildFile(localHeaderJars...)
1301 } else {
1302 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1303 ctx.UncheckedModule()
1304 }
1305 } else {
1306 ctx.CheckbuildFile(j.headerJarFile)
1307 }
Colin Crossa6182ab2024-08-21 10:47:44 -07001308
Colin Cross7727c7f2024-07-18 15:36:32 -07001309 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001310 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001311 LocalHeaderJars: localHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001312 TransitiveStaticLibsHeaderJars: depset.New(depset.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Cross9ffaf282024-08-12 13:50:09 -07001313 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1314 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001315 AidlIncludeDirs: j.exportAidlIncludeDirs,
1316 ExportedPlugins: j.exportedPluginJars,
1317 ExportedPluginClasses: j.exportedPluginClasses,
1318 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1319 StubsLinkType: j.stubsLinkType,
1320 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Yu Liu63bdf632024-12-03 19:54:05 +00001321 SdkVersion: j.SdkVersion(ctx),
Mark Whitea15790a2023-08-22 21:28:11 +00001322 })
1323
1324 j.outputFile = j.headerJarFile
1325 return
1326 }
1327
Jaewoong Jung26342642021-03-17 15:56:23 -07001328 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001329 // When using kotlin sources turbine is used to generate annotation processor sources,
1330 // including for annotation processors that generate API, so we can use turbine for
1331 // java sources too.
1332 disableTurbine = false
1333
Jaewoong Jung26342642021-03-17 15:56:23 -07001334 // user defined kotlin flags.
1335 kotlincFlags := j.properties.Kotlincflags
1336 CheckKotlincFlags(ctx, kotlincFlags)
1337
Dave Mankoff1a7705d2025-01-08 03:06:21 +00001338 kotlin_lang_version := proptools.StringDefault(j.properties.Kotlin_lang_version, "1.9")
1339 if kotlin_lang_version == "1.9" {
1340 kotlincFlags = append(kotlincFlags, "-language-version 1.9")
1341 } else if kotlin_lang_version == "2" {
1342 kotlincFlags = append(kotlincFlags, "-Xsuppress-version-warnings", "-Xconsistent-data-class-copy-visibility")
1343 } else {
1344 ctx.PropertyErrorf("kotlin_lang_version", "Must be one of `1.9` or `2`")
1345
1346 }
1347
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001348 // Workaround for KT-46512
1349 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001350
1351 // If there are kotlin files, compile them first but pass all the kotlin and java files
1352 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1353 // won't emit any classes for them.
1354 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1355 if ctx.Device() {
1356 kotlincFlags = append(kotlincFlags, "-no-jdk")
1357 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001358
1359 for _, plugin := range deps.kotlinPlugins {
1360 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1361 }
1362 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1363
Jaewoong Jung26342642021-03-17 15:56:23 -07001364 if len(kotlincFlags) > 0 {
1365 // optimization.
1366 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1367 flags.kotlincFlags += "$kotlincFlags"
1368 }
1369
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001370 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001371 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1372
Jaewoong Jung26342642021-03-17 15:56:23 -07001373 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1374 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1375
Isaac Chioua23d9942022-04-06 06:14:38 +00001376 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001377 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001378 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1379 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001380 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001381 srcJars = append(srcJars, kaptSrcJar)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001382 localImplementationJars = append(localImplementationJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001383 // Disable annotation processing in javac, it's already been handled by kapt
1384 flags.processorPath = nil
1385 flags.processors = nil
1386 }
1387
1388 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001389 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Spandan Das1028d5a2024-08-19 21:45:48 +00001390 j.kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001391 if ctx.Failed() {
1392 return
1393 }
1394
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001395 kotlinJarPath, _ := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001396
Isaac Chioua23d9942022-04-06 06:14:38 +00001397 // Make javac rule depend on the kotlinc rule
1398 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1399
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001400 localImplementationJars = append(localImplementationJars, kotlinJarPath)
1401
Colin Cross220a9a12022-03-28 17:08:01 -07001402 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001403 }
1404
Jaewoong Jung26342642021-03-17 15:56:23 -07001405 j.compiledSrcJars = srcJars
1406
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001407 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1408
Jaewoong Jung26342642021-03-17 15:56:23 -07001409 enableSharding := false
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001410 var localHeaderJars android.Paths
1411 var shardingHeaderJars android.Paths
1412 var repackagedHeaderJarFile android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001413 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001414 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1415 enableSharding = true
1416 // Formerly, there was a check here that prevented annotation processors
1417 // from being used when sharding was enabled, as some annotation processors
1418 // do not function correctly in sharded environments. It was removed to
1419 // allow for the use of annotation processors that do function correctly
1420 // with sharding enabled. See: b/77284273.
1421 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001422 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001423 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001424 var combinedHeaderJarFile android.Path
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001425 localHeaderJars, combinedHeaderJarFile = j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
1426 shardingHeaderJars = localHeaderJars
Colin Crossedec77c2024-07-26 15:25:40 -07001427
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001428 var jarjared bool
Makoto Onuki31db53a2024-12-06 16:40:47 -08001429 j.headerJarFile, jarjared = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine", false)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001430 if jarjared {
1431 // jarjar modifies transitive static dependencies, use the combined header jar and drop the transitive
1432 // static libs header jars.
1433 localHeaderJars = android.Paths{j.headerJarFile}
1434 transitiveStaticLibsHeaderJars = nil
1435 }
1436 var repackaged bool
1437 repackagedHeaderJarFile, repackaged = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
1438 if repackaged {
1439 // repackage modifies transitive static dependencies, use the combined header jar and drop the transitive
1440 // static libs header jars.
1441 // TODO(b/356688296): this shouldn't export both the unmodified and repackaged header jars
1442 localHeaderJars = android.Paths{j.headerJarFile, repackagedHeaderJarFile}
1443 transitiveStaticLibsHeaderJars = nil
1444 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001445 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001446 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001447 hasErrorproneableFiles := false
1448 for _, ext := range j.sourceExtensions {
1449 if ext != ".proto" && ext != ".aidl" {
1450 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1451 // compile, and it's not useful to have warnings on these generated sources.
1452 hasErrorproneableFiles = true
1453 break
1454 }
1455 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001456 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001457 if Bool(j.properties.Errorprone.Enabled) {
1458 // If error-prone is enabled, enable errorprone flags on the regular
1459 // build.
1460 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001461 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faustf3240f42024-12-11 16:49:18 -08001462 if ctx.Config().RunErrorProneInline() {
1463 // On CI, we're not going to toggle back/forth between errorprone and non-errorprone
1464 // builds, so it's faster if we don't compile the module twice and instead always
1465 // compile the module with errorprone.
1466 flags = enableErrorproneFlags(flags)
1467 } else {
1468 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1469 // a new jar file just for compiling with the errorprone compiler to.
1470 // This is because we don't want to cause the java files to get completely
1471 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1472 // We also don't want to run this if errorprone is enabled by default for
1473 // this module, or else we could have duplicated errorprone messages.
1474 errorproneFlags := enableErrorproneFlags(flags)
1475 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
1476 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001477
Cole Faustf3240f42024-12-11 16:49:18 -08001478 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
1479 "errorprone", "errorprone")
Cole Faust75fffb12021-06-13 15:23:16 -07001480
Cole Faustf3240f42024-12-11 16:49:18 -08001481 extraJarDeps = append(extraJarDeps, errorprone)
1482 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001483 }
1484
1485 if enableSharding {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001486 if len(shardingHeaderJars) > 0 {
1487 flags.classpath = append(classpath(slices.Clone(shardingHeaderJars)), flags.classpath...)
Colin Cross3d56ed52021-11-18 22:23:12 -08001488 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001489 shardSize := int(*(j.properties.Javac_shard_size))
1490 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001491 if len(uniqueJavaFiles) > 0 {
1492 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001493 for idx, shardSrc := range shardSrcs {
1494 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1495 nil, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001496 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
1497 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001498 }
1499 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001500 // Assume approximately 5 sources per srcjar.
1501 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1502 // 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 -07001503 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001504 startIdx := len(shardSrcs)
1505 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1506 for idx, shardSrcJars := range shardSrcJarsList {
1507 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1508 nil, shardSrcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001509 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
1510 localImplementationJars = append(localImplementationJars, classes)
Colin Crossa052ddb2023-09-25 21:46:58 -07001511 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001512 }
1513 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001514 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001515 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
1516 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001517 }
1518 if ctx.Failed() {
1519 return
1520 }
1521 }
1522
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001523 localImplementationJars = append(localImplementationJars, extraCombinedJars...)
Colin Crossfd620b22024-02-23 10:05:21 -08001524
Jaewoong Jung26342642021-03-17 15:56:23 -07001525 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1526
1527 var includeSrcJar android.WritablePath
1528 if Bool(j.properties.Include_srcs) {
1529 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1530 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1531 }
1532
1533 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1534 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Cole Faust7fd5b2e2024-10-29 11:22:20 -07001535 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources.GetOrDefault(ctx, nil), j.properties.Exclude_java_resources)
1536 fileArgs2, fileDeps2 := ResourceFilesToJarArgs(ctx, j.properties.Device_common_java_resources.GetOrDefault(ctx, nil), nil)
1537 fileArgs3, fileDeps3 := ResourceFilesToJarArgs(ctx, j.properties.Device_first_java_resources.GetOrDefault(ctx, nil), nil)
Cole Faust65cb40a2024-10-21 15:41:42 -07001538 fileArgs = slices.Concat(fileArgs, fileArgs2, fileArgs3)
1539 fileDeps = slices.Concat(fileDeps, fileDeps2, fileDeps3)
Jaewoong Jung26342642021-03-17 15:56:23 -07001540 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1541
1542 var resArgs []string
1543 var resDeps android.Paths
1544
1545 resArgs = append(resArgs, dirArgs...)
1546 resDeps = append(resDeps, dirDeps...)
1547
1548 resArgs = append(resArgs, fileArgs...)
1549 resDeps = append(resDeps, fileDeps...)
1550
1551 resArgs = append(resArgs, extraArgs...)
1552 resDeps = append(resDeps, extraDeps...)
1553
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001554 var localResourceJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001555 if len(resArgs) > 0 {
1556 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1557 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001558 if ctx.Failed() {
1559 return
1560 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001561 localResourceJars = append(localResourceJars, resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001562 }
1563
Jaewoong Jung26342642021-03-17 15:56:23 -07001564 if Bool(j.properties.Include_srcs) {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001565 localResourceJars = append(localResourceJars, includeSrcJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001566 }
1567
1568 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1569 if len(services) > 0 {
1570 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1571 var zipargs []string
1572 for _, file := range services {
1573 serviceFile := file.String()
1574 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1575 }
1576 rule := zip
1577 args := map[string]string{
1578 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1579 }
1580 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1581 rule = zipRE
1582 args["implicits"] = strings.Join(services.Strings(), ",")
1583 }
1584 ctx.Build(pctx, android.BuildParams{
1585 Rule: rule,
1586 Output: servicesJar,
1587 Implicits: services,
1588 Args: args,
1589 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001590 localResourceJars = append(localResourceJars, servicesJar)
1591 }
1592
Colin Crossa14fb6a2024-10-23 16:57:06 -07001593 completeStaticLibsResourceJars := depset.New(depset.PREORDER, localResourceJars, deps.transitiveStaticLibsResourceJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001594
1595 var combinedResourceJar android.Path
1596 var resourceJars android.Paths
1597 if ctx.Config().UseTransitiveJarsInClasspath() {
1598 resourceJars = completeStaticLibsResourceJars.ToList()
1599 } else {
1600 resourceJars = append(slices.Clone(localResourceJars), deps.staticResourceJars...)
1601 }
1602 if len(resourceJars) == 1 {
1603 combinedResourceJar = resourceJars[0]
1604 } else if len(resourceJars) > 0 {
1605 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1606 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1607 false, nil, nil)
1608 combinedResourceJar = combinedJar
1609 }
1610
1611 manifest := j.overrideManifest
1612 if !manifest.Valid() && j.properties.Manifest != nil {
1613 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Jaewoong Jung26342642021-03-17 15:56:23 -07001614 }
1615
1616 // Combine the classes built from sources, any manifests, and any static libraries into
1617 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001618 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001619
Colin Crossa14fb6a2024-10-23 16:57:06 -07001620 completeStaticLibsImplementationJars := depset.New(depset.PREORDER, localImplementationJars, deps.transitiveStaticLibsImplementationJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001621
1622 var jars android.Paths
1623 if ctx.Config().UseTransitiveJarsInClasspath() {
1624 jars = completeStaticLibsImplementationJars.ToList()
1625 } else {
1626 jars = append(slices.Clone(localImplementationJars), deps.staticJars...)
1627 }
1628
1629 jars = append(jars, extraDepCombinedJars...)
1630
Jaewoong Jung26342642021-03-17 15:56:23 -07001631 if len(jars) == 1 && !manifest.Valid() {
1632 // Optimization: skip the combine step as there is nothing to do
1633 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1634 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001635 // any if len(extraJars) == 0.
Jaewoong Jung26342642021-03-17 15:56:23 -07001636
Jihoon Kang1147b312023-06-08 23:25:57 +00001637 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1638 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1639 // either with .from-source or .from-text suffix.
1640 // outputFile should be agnostic to the build configuration,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001641 // thus copy the single input static lib in order to prevent the static lib from being exposed
Jihoon Kang1147b312023-06-08 23:25:57 +00001642 // to the copy rules.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001643 if stub, _ := moduleStubLinkType(j); stub {
1644 copiedJar := android.PathForModuleOut(ctx, "combined", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001645 ctx.Build(pctx, android.BuildParams{
1646 Rule: android.Cp,
1647 Input: jars[0],
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001648 Output: copiedJar,
Jaewoong Jung26342642021-03-17 15:56:23 -07001649 })
Colin Crossa14fb6a2024-10-23 16:57:06 -07001650 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, android.Paths{copiedJar}, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001651 outputFile = copiedJar
Colin Cross7707b242024-07-26 12:02:36 -07001652 } else {
1653 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001654 }
1655 } else {
1656 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1657 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1658 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001659 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001660 }
1661
1662 // jarjar implementation jar if necessary
Makoto Onuki31db53a2024-12-06 16:40:47 -08001663 jarjarFile, jarjarred := j.jarjarIfNecessary(ctx, outputFile, jarName, "", true)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001664 if jarjarred {
1665 localImplementationJars = android.Paths{jarjarFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001666 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001667 }
Colin Crossedec77c2024-07-26 15:25:40 -07001668 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001669
Colin Crossedec77c2024-07-26 15:25:40 -07001670 // jarjar resource jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001671 if combinedResourceJar != nil {
Makoto Onuki31db53a2024-12-06 16:40:47 -08001672 resourceJarJarFile, jarjarred := j.jarjarIfNecessary(ctx, combinedResourceJar, jarName, "resource", false)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001673 combinedResourceJar = resourceJarJarFile
1674 if jarjarred {
1675 localResourceJars = android.Paths{resourceJarJarFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001676 completeStaticLibsResourceJars = depset.New(depset.PREORDER, localResourceJars, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001677 }
Colin Crossedec77c2024-07-26 15:25:40 -07001678 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001679
Colin Crossedec77c2024-07-26 15:25:40 -07001680 if ctx.Failed() {
1681 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001682 }
1683
Makoto Onuki7ded3822024-03-28 14:42:20 -07001684 if j.ravenizer.enabled {
1685 ravenizerInput := outputFile
John Wub67040d2024-10-07 18:39:06 +00001686 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", "", jarName)
John Wu989ee842024-10-04 00:21:43 +00001687 ravenizerArgs := ""
1688 if proptools.Bool(j.properties.Ravenizer.Strip_mockito) {
1689 ravenizerArgs = "--strip-mockito"
1690 }
1691 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
Makoto Onuki7ded3822024-03-28 14:42:20 -07001692 outputFile = ravenizerOutput
Colin Cross7e863852024-09-06 14:42:38 -07001693 localImplementationJars = android.Paths{ravenizerOutput}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001694 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001695 if combinedResourceJar != nil {
1696 ravenizerInput = combinedResourceJar
1697 ravenizerOutput = android.PathForModuleOut(ctx, "ravenizer", "resources", jarName)
1698 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
1699 combinedResourceJar = ravenizerOutput
1700 localResourceJars = android.Paths{ravenizerOutput}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001701 completeStaticLibsResourceJars = depset.New(depset.PREORDER, localResourceJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001702 }
Makoto Onuki7ded3822024-03-28 14:42:20 -07001703 }
1704
Yihan Dong8be09c22024-08-29 15:32:13 +08001705 if j.shouldApiMapper() {
1706 inputFile := outputFile
1707 apiMapperFile := android.PathForModuleOut(ctx, "apimapper", jarName)
1708 ctx.Build(pctx, android.BuildParams{
1709 Rule: apimapper,
1710 Description: "apimapper",
1711 Input: inputFile,
1712 Output: apiMapperFile,
1713 })
1714 outputFile = apiMapperFile
Colin Cross7e863852024-09-06 14:42:38 -07001715 localImplementationJars = android.Paths{apiMapperFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001716 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Yihan Dong8be09c22024-08-29 15:32:13 +08001717 }
1718
Jaewoong Jung26342642021-03-17 15:56:23 -07001719 // Check package restrictions if necessary.
1720 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001721 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001722 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001723
1724 // Create a rule to copy the output jar to another path and add a validate dependency that
1725 // will check that the jar only contains the permitted packages. The new location will become
1726 // the output file of this module.
1727 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001728 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001729 ctx.Build(pctx, android.BuildParams{
1730 Rule: android.Cp,
1731 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001732 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001733 // Make sure that any dependency on the output file will cause ninja to run the package check
1734 // rule.
1735 Validation: pkgckFile,
1736 })
Colin Cross7707b242024-07-26 12:02:36 -07001737 outputFile = packageCheckOutputFile
Colin Cross7e863852024-09-06 14:42:38 -07001738 localImplementationJars = android.Paths{packageCheckOutputFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001739 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001740
1741 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001742 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001743
1744 if ctx.Failed() {
1745 return
1746 }
1747 }
1748
1749 j.implementationJarFile = outputFile
1750 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001751 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1752 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1753 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1754 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1755 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1756 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1757 j.headerJarFile = headerJarFile
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001758 if len(localImplementationJars) == 1 && ctx.Config().UseTransitiveJarsInClasspath() {
1759 localHeaderJarFile := android.PathForModuleOut(ctx, "local-javac-header", jarName)
1760 convertImplementationJarToHeaderJar(ctx, localImplementationJars[0], localHeaderJarFile)
1761 localHeaderJars = append(localHeaderJars, localHeaderJarFile)
1762 } else {
1763 localHeaderJars = append(localHeaderJars, headerJarFile)
1764 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001765 }
1766
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001767 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1768 specs := j.jacocoModuleToZipCommand(ctx)
1769 if ctx.Failed() {
1770 return
1771 }
1772
Colin Crossb323c912024-09-24 15:21:00 -07001773 completeStaticLibsImplementationJarsToCombine := completeStaticLibsImplementationJars
1774
Colin Cross41698982024-11-13 11:31:31 -08001775 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Colin Crosse4f34882024-11-14 12:26:00 -08001776
1777 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
1778 compileDex := Bool(j.dexProperties.Compile_dex) || Bool(j.properties.Installable)
Colin Cross41698982024-11-13 11:31:31 -08001779
1780 if j.shouldInstrument(ctx) && (!ctx.Device() || compileDex) {
Colin Crossb323c912024-09-24 15:21:00 -07001781 instrumentedOutputFile := j.instrument(ctx, flags, outputFile, jarName, specs)
Colin Crossa14fb6a2024-10-23 16:57:06 -07001782 completeStaticLibsImplementationJarsToCombine = depset.New(depset.PREORDER, android.Paths{instrumentedOutputFile}, nil)
Colin Crossb323c912024-09-24 15:21:00 -07001783 outputFile = instrumentedOutputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001784 }
1785
1786 // merge implementation jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001787 var implementationAndResourcesJarsToCombine android.Paths
1788 if ctx.Config().UseTransitiveJarsInClasspath() {
1789 resourceJars := completeStaticLibsResourceJars.ToList()
1790 if len(resourceJars) > 0 {
Colin Crossb323c912024-09-24 15:21:00 -07001791 implementationAndResourcesJarsToCombine = append(resourceJars, completeStaticLibsImplementationJarsToCombine.ToList()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001792 implementationAndResourcesJarsToCombine = append(implementationAndResourcesJarsToCombine, extraDepCombinedJars...)
1793 }
1794 } else {
1795 if combinedResourceJar != nil {
1796 implementationAndResourcesJarsToCombine = android.Paths{combinedResourceJar, outputFile}
1797 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001798 }
1799
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001800 if len(implementationAndResourcesJarsToCombine) > 0 {
1801 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
1802 TransformJarsToJar(ctx, combinedJar, "for resources", implementationAndResourcesJarsToCombine, manifest,
1803 false, nil, nil)
1804 outputFile = combinedJar
1805 }
1806
1807 j.implementationAndResourcesJar = outputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001808
Colin Cross41698982024-11-13 11:31:31 -08001809 if ctx.Device() && compileDex {
Jaewoong Jung26342642021-03-17 15:56:23 -07001810 if j.hasCode(ctx) {
1811 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001812 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001813 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1814 }
1815 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001816 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001817 params := &compileDexParams{
1818 flags: flags,
1819 sdkVersion: j.SdkVersion(ctx),
1820 minSdkVersion: j.MinSdkVersion(ctx),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001821 classesJar: outputFile,
Spandan Dasc404cc72023-02-23 18:05:05 +00001822 jarName: jarName,
1823 }
Cole Fausteb032462024-09-19 11:12:54 -07001824 if j.GetProfileGuided(ctx) && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting(ctx) {
Spandan Das15a67112024-05-30 00:07:40 +00001825 ctx.PropertyErrorf("enable_profile_rewriting",
1826 "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.",
1827 )
1828 }
Cole Fausteb032462024-09-19 11:12:54 -07001829 if j.EnableProfileRewriting(ctx) {
1830 profile := j.GetProfile(ctx)
1831 if profile == "" || !j.GetProfileGuided(ctx) {
Spandan Das3dbda182024-05-20 22:23:10 +00001832 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1833 }
1834 params.artProfileInput = &profile
1835 }
1836 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001837 if ctx.Failed() {
1838 return
1839 }
1840
Spandan Das3dbda182024-05-20 22:23:10 +00001841 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1842 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001843 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001844 }
1845
Jaewoong Jung26342642021-03-17 15:56:23 -07001846 // merge dex jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001847 var dexAndResourceJarsToCombine android.Paths
1848 if ctx.Config().UseTransitiveJarsInClasspath() {
1849 resourceJars := completeStaticLibsResourceJars.ToList()
1850 if len(resourceJars) > 0 {
1851 dexAndResourceJarsToCombine = append(android.Paths{dexOutputFile}, resourceJars...)
1852 }
1853 } else {
1854 if combinedResourceJar != nil {
1855 dexAndResourceJarsToCombine = android.Paths{dexOutputFile, combinedResourceJar}
1856 }
1857 }
1858 if len(dexAndResourceJarsToCombine) > 0 {
Colin Cross7707b242024-07-26 12:02:36 -07001859 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001860 TransformJarsToJar(ctx, combinedJar, "for dex resources", dexAndResourceJarsToCombine, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001861 false, nil, nil)
1862 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001863 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001864 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001865 dexOutputFile = combinedAlignedJar
1866 } else {
1867 dexOutputFile = combinedJar
1868 }
1869 }
1870
Paul Duffin4de94502021-05-16 05:21:16 +01001871 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001872
1873 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001874
1875 // Encode hidden API flags in dex file, if needed.
1876 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1877
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001878 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001879
1880 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001881 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1882 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1883 libName = strings.TrimSuffix(libName, ".impl")
1884 }
1885 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001886
1887 outputFile = dexOutputFile
Colin Crossa6182ab2024-08-21 10:47:44 -07001888
1889 ctx.CheckbuildFile(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001890 } else {
1891 // There is no code to compile into a dex jar, make sure the resources are propagated
1892 // to the APK if this is an app.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001893 j.dexJarFile = makeDexJarPathFromPath(combinedResourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001894 }
1895
1896 if ctx.Failed() {
1897 return
1898 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001899 }
1900
1901 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001902 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001903 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001904 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001905 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001906 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001907 }
1908 }
1909
1910 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001911 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1912 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001913 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1914 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001915 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001916 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001917 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001918 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001919 j.linter.javaLanguageLevel = flags.javaVersion.String()
1920 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001921 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001922 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1923 j.linter.buildModuleReportZip = true
1924 }
1925 j.linter.lint(ctx)
1926 }
1927
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001928 j.collectTransitiveSrcFiles(ctx, srcFiles)
1929
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001930 if ctx.Config().UseTransitiveJarsInClasspath() {
1931 if len(localImplementationJars) > 0 || len(localResourceJars) > 0 || len(localHeaderJars) > 0 {
1932 ctx.CheckbuildFile(localImplementationJars...)
1933 ctx.CheckbuildFile(localResourceJars...)
1934 ctx.CheckbuildFile(localHeaderJars...)
1935 } else {
1936 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1937 ctx.UncheckedModule()
1938 }
1939 } else {
1940 ctx.CheckbuildFile(j.implementationJarFile)
1941 ctx.CheckbuildFile(j.headerJarFile)
1942 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001943
Colin Cross7727c7f2024-07-18 15:36:32 -07001944 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001945 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1946 RepackagedHeaderJars: android.PathsIfNonNil(repackagedHeaderJarFile),
1947
1948 LocalHeaderJars: localHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001949 TransitiveStaticLibsHeaderJars: depset.New(depset.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001950 TransitiveStaticLibsImplementationJars: completeStaticLibsImplementationJars,
1951 TransitiveStaticLibsResourceJars: completeStaticLibsResourceJars,
1952
Colin Cross9ffaf282024-08-12 13:50:09 -07001953 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1954 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001955 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1956 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001957 ResourceJars: android.PathsIfNonNil(combinedResourceJar),
Jihoon Kang705e63e2024-03-13 01:21:16 +00001958 AidlIncludeDirs: j.exportAidlIncludeDirs,
1959 SrcJarArgs: j.srcJarArgs,
1960 SrcJarDeps: j.srcJarDeps,
1961 TransitiveSrcFiles: j.transitiveSrcFiles,
1962 ExportedPlugins: j.exportedPluginJars,
1963 ExportedPluginClasses: j.exportedPluginClasses,
1964 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1965 JacocoReportClassesFile: j.jacocoReportClassesFile,
1966 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001967 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Yu Liu63bdf632024-12-03 19:54:05 +00001968 SdkVersion: j.SdkVersion(ctx),
Jaewoong Jung26342642021-03-17 15:56:23 -07001969 })
1970
1971 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1972 j.outputFile = outputFile.WithoutRel()
1973}
1974
Cole Faustb7493472024-08-28 11:55:52 -07001975func (j *Module) useCompose(ctx android.BaseModuleContext) bool {
1976 return android.InList("androidx.compose.runtime_runtime", j.staticLibs(ctx))
Colin Crossa1ff7c62021-09-17 14:11:52 -07001977}
1978
Colin Crossa14fb6a2024-10-23 16:57:06 -07001979func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []depset.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001980 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001981 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001982 depTag := ctx.OtherModuleDependencyTag(m)
1983
Colin Crossa14fb6a2024-10-23 16:57:06 -07001984 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1985 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
Sam Delmerico95d70942023-08-02 18:00:35 -04001986
Colin Crossa14fb6a2024-10-23 16:57:06 -07001987 if depTag == staticLibTag {
Sam Delmerico95d70942023-08-02 18:00:35 -04001988 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1989 }
1990 })
1991
Colin Crosscde55342024-03-27 14:11:51 -07001992 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1993}
1994
1995func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1996 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1997
Sam Delmerico95d70942023-08-02 18:00:35 -04001998 directUnconditionalExportedFlags := android.Paths{}
1999 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
2000 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
2001 if exportUnconditionally {
2002 // if we explicitly export, then our unconditional exports are the same as our transitive flags
2003 transitiveUnconditionalExportedFlags = transitiveProguardFlags
2004 directUnconditionalExportedFlags = proguardFlagsForThisModule
2005 }
2006
2007 return ProguardSpecInfo{
2008 Export_proguard_flags_files: exportUnconditionally,
Colin Crossa14fb6a2024-10-23 16:57:06 -07002009 ProguardFlagsFiles: depset.New[android.Path](
2010 depset.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04002011 proguardFlagsForThisModule,
2012 transitiveProguardFlags,
2013 ),
Colin Crossa14fb6a2024-10-23 16:57:06 -07002014 UnconditionallyExportedProguardFlags: depset.New[android.Path](
2015 depset.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04002016 directUnconditionalExportedFlags,
2017 transitiveUnconditionalExportedFlags,
2018 ),
2019 }
2020
2021}
2022
Cole Faust75fffb12021-06-13 15:23:16 -07002023// Returns a copy of the supplied flags, but with all the errorprone-related
2024// fields copied to the regular build's fields.
2025func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
2026 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
2027
2028 if len(flags.errorProneExtraJavacFlags) > 0 {
2029 if len(flags.javacFlags) > 0 {
2030 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
2031 } else {
2032 flags.javacFlags = flags.errorProneExtraJavacFlags
2033 }
2034 }
2035 return flags
2036}
2037
Jaewoong Jung26342642021-03-17 15:56:23 -07002038func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07002039 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002040
2041 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00002042 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002043 if idx >= 0 {
2044 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00002045 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002046 jarName += strconv.Itoa(idx)
2047 }
2048
Colin Cross7707b242024-07-26 12:02:36 -07002049 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00002050 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07002051
Cole Faust9decf832024-06-11 11:45:53 -07002052 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002053 extractionFile := android.PathForModuleOut(ctx, kzipName)
2054 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
2055 j.kytheFiles = append(j.kytheFiles, extractionFile)
2056 }
2057
Vadim Spivak3c496f02023-06-08 06:14:59 +00002058 if len(flags.processorPath) > 0 {
2059 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
2060 }
2061
Jaewoong Jung26342642021-03-17 15:56:23 -07002062 return classes
2063}
2064
2065// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
2066// since some of these flags may be used internally.
2067func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
2068 for _, flag := range flags {
2069 flag = strings.TrimSpace(flag)
2070
2071 if !strings.HasPrefix(flag, "-") {
2072 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
2073 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
2074 ctx.PropertyErrorf("kotlincflags",
2075 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
Dave Mankoff1a7705d2025-01-08 03:06:21 +00002076 } else if slices.ContainsFunc(config.KotlincIllegalFlags, func(f string) bool {
2077 return strings.HasPrefix(flag, f)
2078 }) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002079 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
2080 } else if flag == "-include-runtime" {
2081 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
2082 } else {
2083 args := strings.Split(flag, " ")
2084 if args[0] == "-kotlin-home" {
2085 ctx.PropertyErrorf("kotlincflags",
2086 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
2087 }
2088 }
2089 }
2090}
2091
2092func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
2093 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002094 extraJars android.Paths) (localHeaderJars android.Paths, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002095
Jaewoong Jung26342642021-03-17 15:56:23 -07002096 if len(srcFiles) > 0 || len(srcJars) > 0 {
2097 // Compile java sources into turbine.jar.
2098 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
2099 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002100 localHeaderJars = append(localHeaderJars, turbineJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07002101 }
2102
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002103 localHeaderJars = append(localHeaderJars, extraJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002104
2105 // Combine any static header libraries into classes-header.jar. If there is only
2106 // one input jar this step will be skipped.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002107 var jars android.Paths
2108 if ctx.Config().UseTransitiveJarsInClasspath() {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002109 depSet := depset.New(depset.PREORDER, localHeaderJars, deps.transitiveStaticLibsHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002110 jars = depSet.ToList()
2111 } else {
2112 jars = append(slices.Clone(localHeaderJars), deps.staticHeaderJars...)
2113 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002114
2115 // we cannot skip the combine step for now if there is only one jar
2116 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07002117 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
2118 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07002119 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07002120
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002121 return localHeaderJars, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07002122}
2123
2124func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07002125 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002126
2127 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07002128 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07002129
2130 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
2131
2132 j.jacocoReportClassesFile = jacocoReportClassesFile
2133
2134 return instrumentedJar
2135}
2136
Colin Cross9ffaf282024-08-12 13:50:09 -07002137type providesTransitiveHeaderJarsForR8 struct {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002138 // set of header jars for all transitive libs deps
Colin Crossa14fb6a2024-10-23 16:57:06 -07002139 transitiveLibsHeaderJarsForR8 depset.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002140 // set of header jars for all transitive static libs deps
Colin Crossa14fb6a2024-10-23 16:57:06 -07002141 transitiveStaticLibsHeaderJarsForR8 depset.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002142}
2143
Colin Cross9ffaf282024-08-12 13:50:09 -07002144// collectTransitiveHeaderJarsForR8 visits direct dependencies and collects all transitive libs and static_libs
2145// header jars. The semantics of the collected jars are odd (it collects combined jars that contain the static
2146// libs, but also the static libs, and it collects transitive libs dependencies of static_libs), so these
2147// are only used to expand the --lib arguments to R8.
2148func (j *providesTransitiveHeaderJarsForR8) collectTransitiveHeaderJarsForR8(ctx android.ModuleContext) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002149 directLibs := android.Paths{}
2150 directStaticLibs := android.Paths{}
Colin Crossa14fb6a2024-10-23 16:57:06 -07002151 transitiveLibs := []depset.DepSet[android.Path]{}
2152 transitiveStaticLibs := []depset.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002153 ctx.VisitDirectDeps(func(module android.Module) {
2154 // don't add deps of the prebuilt version of the same library
2155 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
2156 return
2157 }
2158
Colin Cross7727c7f2024-07-18 15:36:32 -07002159 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2160 tag := ctx.OtherModuleDependencyTag(module)
2161 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2162 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2163 directLibs = append(directLibs, dep.HeaderJars...)
2164 } else if tag == staticLibTag {
2165 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2166 } else {
2167 // Don't propagate transitive libs for other kinds of dependencies.
2168 return
2169 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002170
Colin Crossa14fb6a2024-10-23 16:57:06 -07002171 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJarsForR8)
2172 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJarsForR8)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002173 }
2174 })
Colin Crossa14fb6a2024-10-23 16:57:06 -07002175 j.transitiveLibsHeaderJarsForR8 = depset.New(depset.POSTORDER, directLibs, transitiveLibs)
2176 j.transitiveStaticLibsHeaderJarsForR8 = depset.New(depset.POSTORDER, directStaticLibs, transitiveStaticLibs)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002177}
2178
Jaewoong Jung26342642021-03-17 15:56:23 -07002179func (j *Module) HeaderJars() android.Paths {
2180 if j.headerJarFile == nil {
2181 return nil
2182 }
2183 return android.Paths{j.headerJarFile}
2184}
2185
2186func (j *Module) ImplementationJars() android.Paths {
2187 if j.implementationJarFile == nil {
2188 return nil
2189 }
2190 return android.Paths{j.implementationJarFile}
2191}
2192
Spandan Das59a4a2b2024-01-09 21:35:56 +00002193func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002194 return j.dexJarFile
2195}
2196
2197func (j *Module) DexJarInstallPath() android.Path {
2198 return j.installFile
2199}
2200
2201func (j *Module) ImplementationAndResourcesJars() android.Paths {
2202 if j.implementationAndResourcesJar == nil {
2203 return nil
2204 }
2205 return android.Paths{j.implementationAndResourcesJar}
2206}
2207
2208func (j *Module) AidlIncludeDirs() android.Paths {
2209 // exportAidlIncludeDirs is type android.Paths already
2210 return j.exportAidlIncludeDirs
2211}
2212
2213func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2214 return j.classLoaderContexts
2215}
2216
2217// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002218func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002219 if j.expandJarjarRules != nil {
2220 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Das096b8d62024-10-08 22:41:26 +00002221 // Add the header jar so that the rdeps can be resolved to the repackaged classes.
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002222 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
Jaewoong Jung26342642021-03-17 15:56:23 -07002223 }
Spandan Das096b8d62024-10-08 22:41:26 +00002224 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2225 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2226 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002227 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2228 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Cole Faustb7493472024-08-28 11:55:52 -07002229 dpInfo.Static_libs = append(dpInfo.Static_libs, j.staticLibs(ctx)...)
Yikef6282022022-04-13 20:41:01 +08002230 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002231}
2232
2233func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002234 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002235}
2236
2237func (j *Module) hasCode(ctx android.ModuleContext) bool {
2238 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2239 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2240}
2241
2242// Implements android.ApexModule
Colin Crossf7bbd2f2024-12-05 13:57:10 -08002243func (j *Module) OutgoingDepIsInSameApex(tag blueprint.DependencyTag) bool {
2244 return j.depIsInSameApex(tag)
Jaewoong Jung26342642021-03-17 15:56:23 -07002245}
2246
2247// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002248func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002249 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002250 minSdkVersion := j.MinSdkVersion(ctx)
2251 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002252 return fmt.Errorf("min_sdk_version is not specified")
2253 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002254 // If the module is compiling against core (via sdk_version), skip comparison check.
2255 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002256 return nil
2257 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002258 if minSdkVersion.GreaterThan(sdkVersion) {
2259 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002260 }
2261 return nil
2262}
2263
2264func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002265 if j.stem == "" {
2266 panic("Stem() called before stem property was set")
2267 }
2268 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002269}
2270
Jaewoong Jung26342642021-03-17 15:56:23 -07002271func (j *Module) JacocoReportClassesFile() android.Path {
2272 return j.jacocoReportClassesFile
2273}
2274
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002275func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002276 var fromDeps []depset.DepSet[android.Path]
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002277 ctx.VisitDirectDeps(func(module android.Module) {
2278 tag := ctx.OtherModuleDependencyTag(module)
2279 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002280 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002281 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002282 }
2283 }
2284 })
2285
Colin Crossa14fb6a2024-10-23 16:57:06 -07002286 j.transitiveSrcFiles = depset.New(depset.POSTORDER, mine, fromDeps)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002287}
2288
Jaewoong Jung26342642021-03-17 15:56:23 -07002289func (j *Module) IsInstallable() bool {
2290 return Bool(j.properties.Installable)
2291}
2292
2293type sdkLinkType int
2294
2295const (
2296 // TODO(jiyong) rename these for better readability. Make the allowed
2297 // and disallowed link types explicit
2298 // order is important here. See rank()
2299 javaCore sdkLinkType = iota
2300 javaSdk
2301 javaSystem
2302 javaModule
2303 javaSystemServer
2304 javaPlatform
2305)
2306
2307func (lt sdkLinkType) String() string {
2308 switch lt {
2309 case javaCore:
2310 return "core Java API"
2311 case javaSdk:
2312 return "Android API"
2313 case javaSystem:
2314 return "system API"
2315 case javaModule:
2316 return "module API"
2317 case javaSystemServer:
2318 return "system server API"
2319 case javaPlatform:
2320 return "private API"
2321 default:
2322 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2323 }
2324}
2325
2326// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2327// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2328// can't statically depend on modules that use Platform API.
2329func (lt sdkLinkType) rank() int {
2330 return int(lt)
2331}
2332
2333type moduleWithSdkDep interface {
2334 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002335 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002336}
2337
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002338func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2339 switch k {
2340 case android.SdkCore:
2341 return javaCore
2342 case android.SdkSystem:
2343 return javaSystem
2344 case android.SdkPublic:
2345 return javaSdk
2346 case android.SdkModule:
2347 return javaModule
2348 case android.SdkSystemServer:
2349 return javaSystemServer
2350 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2351 return javaPlatform
2352 default:
2353 return javaSdk
2354 }
2355}
2356
Jiyong Park92315372021-04-02 08:45:46 +09002357func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002358 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002359 case android.SdkCore.DefaultJavaLibraryName(),
2360 "legacy.core.platform.api.stubs",
2361 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002362 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002363 "core-lambda-stubs",
Colin Crosse4f34882024-11-14 12:26:00 -08002364 "core-generated-annotation-stubs",
2365 // jacocoagent only uses core APIs, but has to specify a non-core sdk_version so it can use
2366 // a prebuilt SDK to avoid circular dependencies when it statically included in the bootclasspath.
2367 "jacocoagent":
Jaewoong Jung26342642021-03-17 15:56:23 -07002368 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002369 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002370 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002371 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002372 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002373 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002374 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002375 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002376 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002377 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002378 return javaSystem, true
2379 }
2380
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002381 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002382 return linkType, true
2383 }
2384
Jiyong Park92315372021-04-02 08:45:46 +09002385 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002386 if !ver.Valid() {
2387 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002388 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002389
2390 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002391}
2392
2393// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2394// this module's. See the comment on rank() for details and an example.
2395func (j *Module) checkSdkLinkType(
2396 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2397 if ctx.Host() {
2398 return
2399 }
2400
Jiyong Park92315372021-04-02 08:45:46 +09002401 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002402 if stubs {
2403 return
2404 }
Jiyong Park92315372021-04-02 08:45:46 +09002405 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002406
2407 if myLinkType.rank() < depLinkType.rank() {
2408 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2409 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2410 "property of the source or target module so that target module is built "+
2411 "with the same or smaller API set when compared to the source.",
2412 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2413 }
2414}
2415
2416func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2417 var deps deps
2418
Jiyong Park92315372021-04-02 08:45:46 +09002419 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002420
Colin Cross9ffaf282024-08-12 13:50:09 -07002421 j.collectTransitiveHeaderJarsForR8(ctx)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002422
Colin Crossa14fb6a2024-10-23 16:57:06 -07002423 var transitiveBootClasspathHeaderJars []depset.DepSet[android.Path]
2424 var transitiveClasspathHeaderJars []depset.DepSet[android.Path]
2425 var transitiveJava9ClasspathHeaderJars []depset.DepSet[android.Path]
2426 var transitiveStaticJarsHeaderLibs []depset.DepSet[android.Path]
2427 var transitiveStaticJarsImplementationLibs []depset.DepSet[android.Path]
2428 var transitiveStaticJarsResourceLibs []depset.DepSet[android.Path]
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002429
Jaewoong Jung26342642021-03-17 15:56:23 -07002430 ctx.VisitDirectDeps(func(module android.Module) {
2431 otherName := ctx.OtherModuleName(module)
2432 tag := ctx.OtherModuleDependencyTag(module)
2433
2434 if IsJniDepTag(tag) {
2435 // Handled by AndroidApp.collectAppDeps
2436 return
2437 }
2438 if tag == certificateTag {
2439 // Handled by AndroidApp.collectAppDeps
2440 return
2441 }
2442
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002443 if sdkInfo, ok := android.OtherModuleProvider(ctx, module, SdkLibraryInfoProvider); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -07002444 switch tag {
Jihoon Kang28c96572024-09-11 23:44:44 +00002445 case sdkLibTag, libTag, staticLibTag:
Jihoon Kang28c96572024-09-11 23:44:44 +00002446 generatingLibsString := android.PrettyConcat(
2447 getGeneratingLibs(ctx, j.SdkVersion(ctx), module.Name(), sdkInfo), true, "or")
2448 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 -07002449 }
Colin Cross313aa542023-12-13 13:47:44 -08002450 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2451 if sdkLinkType != javaPlatform {
2452 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2453 // dep is a sysprop implementation library, but this module is not linking against
2454 // the platform, so it gets the sysprop public stubs library instead. Replace
2455 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2456 dep = syspropDep.JavaInfo
2457 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002458 }
2459 switch tag {
2460 case bootClasspathTag:
2461 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002462 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002463 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002464 if _, ok := module.(*Plugin); ok {
2465 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2466 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002467 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002468 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002469 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2470 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2471 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2472 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002473 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2474 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2475 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002476
Colin Crossa14fb6a2024-10-23 16:57:06 -07002477 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002478 case java9LibTag:
2479 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002480 transitiveJava9ClasspathHeaderJars = append(transitiveJava9ClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002481 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002482 if _, ok := module.(*Plugin); ok {
2483 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2484 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002485 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2486 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2487 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2488 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2489 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2490 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2491 // Turbine doesn't run annotation processors, so any module that uses an
2492 // annotation processor that generates API is incompatible with the turbine
2493 // optimization.
2494 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002495 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002496
Colin Crossa14fb6a2024-10-23 16:57:06 -07002497 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2498 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, dep.TransitiveStaticLibsHeaderJars)
2499 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, dep.TransitiveStaticLibsImplementationJars)
2500 transitiveStaticJarsResourceLibs = append(transitiveStaticJarsResourceLibs, dep.TransitiveStaticLibsResourceJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002501 case pluginTag:
2502 if plugin, ok := module.(*Plugin); ok {
2503 if plugin.pluginProperties.Processor_class != nil {
2504 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2505 } else {
2506 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2507 }
2508 // Turbine doesn't run annotation processors, so any module that uses an
2509 // annotation processor that generates API is incompatible with the turbine
2510 // optimization.
2511 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2512 } else {
2513 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2514 }
2515 case errorpronePluginTag:
2516 if _, ok := module.(*Plugin); ok {
2517 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2518 } else {
2519 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2520 }
2521 case exportedPluginTag:
2522 if plugin, ok := module.(*Plugin); ok {
2523 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2524 if plugin.pluginProperties.Processor_class != nil {
2525 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
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.
2530 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2531 } else {
2532 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2533 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002534 case kotlinPluginTag:
Luca Stefani50098f72024-10-12 17:55:31 +02002535 if _, ok := module.(*KotlinPlugin); ok {
2536 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
2537 } else {
2538 ctx.PropertyErrorf("kotlin_plugins", "%q is not a kotlin_plugin module", otherName)
2539 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002540 case syspropPublicStubDepTag:
2541 // This is a sysprop implementation library, forward the JavaInfoProvider from
2542 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002543 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002544 JavaInfo: dep,
2545 })
2546 }
2547 } else if dep, ok := module.(android.SourceFileProducer); ok {
2548 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002549 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002550 checkProducesJars(ctx, dep)
2551 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002552 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002553 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07002554 depset.New(depset.PREORDER, dep.Srcs(), nil))
Jaewoong Jung26342642021-03-17 15:56:23 -07002555 case staticLibTag:
2556 checkProducesJars(ctx, dep)
2557 deps.classpath = append(deps.classpath, dep.Srcs()...)
2558 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2559 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002560
Colin Crossa14fb6a2024-10-23 16:57:06 -07002561 depHeaderJars := depset.New(depset.PREORDER, dep.Srcs(), nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002562 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJars)
2563 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, depHeaderJars)
2564 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, depHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002565 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002566 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002567 switch tag {
2568 case staticLibTag:
2569 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2570 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002571 } else {
2572 switch tag {
2573 case bootClasspathTag:
2574 // If a system modules dependency has been added to the bootclasspath
2575 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002576 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002577 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002578 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars,
2579 sm.TransitiveStaticLibsHeaderJars)
Colin Crossb61c2262024-08-08 14:04:42 -07002580 } else {
2581 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2582 ctx.OtherModuleName(module))
2583 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002584
2585 case systemModulesTag:
2586 if deps.systemModules != nil {
2587 panic("Found two system module dependencies")
2588 }
Colin Crossb61c2262024-08-08 14:04:42 -07002589 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2590 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2591 } else {
2592 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2593 ctx.OtherModuleName(module))
2594 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002595
2596 case instrumentationForTag:
2597 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 -07002598 }
2599 }
2600
Spandan Das8aac9932024-07-18 23:14:13 +00002601 if android.InList(tag, compileDependencyTags) {
2602 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2603 j.compileDepNames = append(j.compileDepNames, otherName)
2604 }
2605
Jaewoong Jung26342642021-03-17 15:56:23 -07002606 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002607 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002608 })
2609
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002610 deps.transitiveStaticLibsHeaderJars = transitiveStaticJarsHeaderLibs
2611 deps.transitiveStaticLibsImplementationJars = transitiveStaticJarsImplementationLibs
2612 deps.transitiveStaticLibsResourceJars = transitiveStaticJarsResourceLibs
2613
2614 if ctx.Config().UseTransitiveJarsInClasspath() {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002615 depSet := depset.New(depset.PREORDER, nil, transitiveClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002616 deps.classpath = depSet.ToList()
Colin Crossa14fb6a2024-10-23 16:57:06 -07002617 depSet = depset.New(depset.PREORDER, nil, transitiveBootClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002618 deps.bootClasspath = depSet.ToList()
Colin Crossa14fb6a2024-10-23 16:57:06 -07002619 depSet = depset.New(depset.PREORDER, nil, transitiveJava9ClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002620 deps.java9Classpath = depSet.ToList()
2621 }
2622
2623 if ctx.Device() {
2624 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
2625 if sdkDep.invalidVersion {
2626 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2627 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2628 } else if sdkDep.useFiles {
2629 // sdkDep.jar is actually equivalent to turbine header.jar.
2630 deps.classpath = append(slices.Clone(classpath(sdkDep.jars)), deps.classpath...)
2631 deps.dexClasspath = append(slices.Clone(classpath(sdkDep.jars)), deps.dexClasspath...)
2632 deps.aidlPreprocess = sdkDep.aidl
2633 // Add the sdk module dependency to `compileDepNames`.
2634 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2635 // TODO (b/358608607): Move this to decodeSdkDep
2636 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2637 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
2638 } else {
2639 deps.aidlPreprocess = sdkDep.aidl
2640 }
2641 }
2642
Jaewoong Jung26342642021-03-17 15:56:23 -07002643 return deps
2644}
2645
Joe Onorato349ae8d2024-02-05 22:46:00 +00002646// Provider for jarjar renaming rules.
2647//
2648// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2649// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2650// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2651// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2652// be renamed from that module.
2653// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002654type DependencyUse int
2655
2656const (
2657 RenameUseInvalid DependencyUse = iota
2658 RenameUseInclude
2659 RenameUseExclude
2660)
2661
Joe Onorato349ae8d2024-02-05 22:46:00 +00002662type JarJarProviderData struct {
2663 // Mapping of class names: original --> renamed. If the value is "", the class will be
2664 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2665 // attribute). Rdeps of that module will inherit the renaming.
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002666 Rename map[string]string
Joe Onorato349ae8d2024-02-05 22:46:00 +00002667}
2668
2669func (this JarJarProviderData) GetDebugString() string {
2670 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002671 for _, k := range android.SortedKeys(this.Rename) {
2672 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002673 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2674 result += k + "--&gt;" + v + ";"
2675 }
2676 }
2677 return result
2678}
2679
2680var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2681
2682var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2683
2684func init() {
2685 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
Yu Liu26a716d2024-08-30 23:40:32 +00002686
2687 gob.Register(BaseJarJarProviderData{})
Joe Onorato349ae8d2024-02-05 22:46:00 +00002688}
2689
2690// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2691// whether they are java modules or not.
2692type BaseJarJarProviderData struct {
2693 JarJarProviderData JarJarProviderData
2694}
2695
2696func (this BaseJarJarProviderData) GetDebugString() string {
2697 return this.JarJarProviderData.GetDebugString()
2698}
2699
2700var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2701
2702// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2703// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2704// either JarJarProvider or BaseJarJarProvider.
2705func mergeJarJarPrefixes(ctx android.ModuleContext) {
2706 mod := ctx.Module()
2707 // Explicitly avoid propagating into some module types.
2708 switch reflect.TypeOf(mod).String() {
2709 case "*java.Droidstubs":
2710 return
2711 }
2712 jarJarData := collectDirectDepsProviders(ctx)
2713 if jarJarData != nil {
2714 providerData := BaseJarJarProviderData{
2715 JarJarProviderData: *jarJarData,
2716 }
2717 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2718 }
2719
2720}
2721
2722// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2723func (module *Module) addJarJarRenameRule(original string, renamed string) {
2724 if module.jarjarRenameRules == nil {
2725 module.jarjarRenameRules = make(map[string]string)
2726 }
2727 module.jarjarRenameRules[original] = renamed
2728}
2729
2730func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2731 // Gather repackage information from deps
2732 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002733
2734 module := ctx.Module()
2735 moduleName := module.Name()
2736
Colin Cross648daea2024-09-12 14:35:29 -07002737 ctx.VisitDirectDeps(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002738 tag := ctx.OtherModuleDependencyTag(m)
2739 // This logic mirrors that in (*Module).collectDeps above. There are several places
2740 // where we explicitly return RenameUseExclude, even though it is the default, to
2741 // indicate that it has been verified to be the case.
2742 //
2743 // Note well: there are probably cases that are getting to the unconditional return
2744 // and are therefore wrong.
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002745 shouldIncludeRenames := func() DependencyUse {
LaMont Jones63683e42024-02-08 14:30:45 -08002746 if moduleName == m.Name() {
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002747 return RenameUseInclude // If we have the same module name, include the renames.
LaMont Jones63683e42024-02-08 14:30:45 -08002748 }
2749 if sc, ok := module.(android.SdkContext); ok {
2750 if ctx.Device() {
2751 sdkDep := decodeSdkDep(ctx, sc)
2752 if !sdkDep.invalidVersion && sdkDep.useFiles {
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002753 return RenameUseExclude
Joe Onorato349ae8d2024-02-05 22:46:00 +00002754 }
2755 }
LaMont Jones63683e42024-02-08 14:30:45 -08002756 }
2757 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002758 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002759 }
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002760 if _, ok := android.OtherModuleProvider(ctx, m, SdkLibraryInfoProvider); ok {
LaMont Jones63683e42024-02-08 14:30:45 -08002761 switch tag {
2762 case sdkLibTag, libTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002763 return RenameUseExclude // matches collectDeps()
LaMont Jones63683e42024-02-08 14:30:45 -08002764 }
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002765 return RenameUseInvalid // dep is not used in collectDeps()
LaMont Jones63683e42024-02-08 14:30:45 -08002766 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2767 switch ji.StubsLinkType {
2768 case Stubs:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002769 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002770 case Implementation:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002771 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002772 default:
LaMont Jones09721862024-06-11 10:30:50 -07002773 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002774 // Fall through to the heuristic logic.
2775 }
2776 switch reflect.TypeOf(m).String() {
2777 case "*java.GeneratedJavaLibraryModule":
2778 // Probably a java_aconfig_library module.
2779 // TODO: make this check better.
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002780 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002781 }
2782 switch tag {
2783 case bootClasspathTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002784 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002785 case sdkLibTag, libTag, instrumentationForTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002786 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002787 case java9LibTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002788 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002789 case staticLibTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002790 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002791 case pluginTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002792 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002793 case errorpronePluginTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002794 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002795 case exportedPluginTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002796 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002797 case kotlinPluginTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002798 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002799 default:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002800 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002801 }
2802 } else if _, ok := m.(android.SourceFileProducer); ok {
2803 switch tag {
2804 case sdkLibTag, libTag, staticLibTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002805 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002806 default:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002807 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002808 }
Yu Liu67a28422024-03-05 00:36:31 +00002809 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002810 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002811 } else {
2812 switch tag {
2813 case bootClasspathTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002814 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002815 case systemModulesTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002816 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002817 }
2818 }
2819 // If we got here, choose the safer option, which may lead to a build failure, rather
2820 // than runtime failures on the device.
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002821 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002822 }
2823
2824 if result == nil {
2825 result = &JarJarProviderData{
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002826 Rename: make(map[string]string),
LaMont Jones63683e42024-02-08 14:30:45 -08002827 }
2828 }
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002829 how := shouldIncludeRenames()
LaMont Jones63683e42024-02-08 14:30:45 -08002830 if how != RenameUseInclude {
2831 // Nothing to merge.
2832 return
2833 }
2834
2835 merge := func(theirs *JarJarProviderData) {
2836 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002837 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2838 result.Rename[orig] = renamed
2839 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2840 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2841 result.Rename[orig] = renamed
2842 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2843 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2844 continue
2845 }
2846 }
2847 }
2848 }
2849 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2850 merge(&theirs)
2851 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2852 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2853 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2854 // to java.Module.
2855 merge(&theirs.JarJarProviderData)
2856 }
2857 })
2858 return
2859}
2860
2861func (this Module) GetDebugString() string {
2862 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2863}
2864
2865// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2866// us, and if it's been set, apply the jarjar_prefix property to rename them.
2867func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2868 // Gather repackage information from deps
2869 result := collectDirectDepsProviders(ctx)
2870
Joe Onoratoa5d17172024-07-20 17:39:56 -07002871 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002872 if result == nil {
2873 result = &JarJarProviderData{
2874 Rename: make(map[string]string),
2875 }
2876 }
2877 if renamed != "" {
2878 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2879 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002880 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002881 }
2882 }
2883 (*result).Rename[orig] = renamed
2884 }
2885
Joe Onoratoa5d17172024-07-20 17:39:56 -07002886 // Update that with entries we've stored for ourself
2887 for orig, renamed := range module.jarjarRenameRules {
2888 add(orig, renamed)
2889 }
2890
2891 // Update that with entries given in the jarjar_rename property.
2892 for _, orig := range module.properties.Jarjar_rename {
2893 add(orig, "")
2894 }
2895
Joe Onorato349ae8d2024-02-05 22:46:00 +00002896 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2897 if result == nil {
2898 return nil
2899 }
2900
2901 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2902 // that have not yet been renamed.
2903 prefix := proptools.String(module.properties.Jarjar_prefix)
2904 if prefix != "" {
2905 if prefix[0] == '.' {
2906 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2907 return nil
2908 }
2909 if prefix[len(prefix)-1] == '.' {
2910 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2911 return nil
2912 }
2913
2914 var updated map[string]string
2915 for orig, renamed := range (*result).Rename {
2916 if renamed == "" {
2917 if updated == nil {
2918 updated = make(map[string]string)
2919 }
2920 updated[orig] = prefix + "." + orig
2921 }
2922 }
2923 for orig, renamed := range updated {
2924 (*result).Rename[orig] = renamed
2925 }
2926 }
2927
2928 return result
2929}
2930
2931// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2932// to "" won't be in this list because they shouldn't be renamed yet.
2933func getJarJarRuleText(provider *JarJarProviderData) string {
2934 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002935 for _, orig := range android.SortedKeys(provider.Rename) {
2936 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002937 if renamed != "" {
2938 result += "rule " + orig + " " + renamed + "\n"
2939 }
2940 }
2941 return result
2942}
2943
Zi Wangddb2ee52024-04-02 16:44:02 +00002944// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002945func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Zi Wangddb2ee52024-04-02 16:44:02 +00002946 if j.repackageJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002947 return infile, false
Zi Wangddb2ee52024-04-02 16:44:02 +00002948 }
Colin Crossedec77c2024-07-26 15:25:40 -07002949 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002950 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002951 return repackagedJarjarFile, true
Zi Wangddb2ee52024-04-02 16:44:02 +00002952}
2953
Makoto Onuki31db53a2024-12-06 16:40:47 -08002954func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string, useShards bool) (android.Path, bool) {
Colin Crossedec77c2024-07-26 15:25:40 -07002955 if j.expandJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002956 return infile, false
Colin Crossedec77c2024-07-26 15:25:40 -07002957 }
2958 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
Makoto Onuki31db53a2024-12-06 16:40:47 -08002959
2960 totalShards := 1
2961 if useShards {
2962 totalShardsStr := j.properties.Jarjar_shards.GetOrDefault(ctx, "1")
2963 ts, err := strconv.Atoi(totalShardsStr)
2964 if err != nil {
2965 ctx.PropertyErrorf("jarjar_shards", "jarjar_shards must be an integer represented as a string")
2966 return infile, false
2967 }
2968 totalShards = ts
2969 }
2970 TransformJarJarWithShards(ctx, jarjarFile, infile, j.expandJarjarRules, totalShards)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002971 return jarjarFile, true
Colin Crossedec77c2024-07-26 15:25:40 -07002972
2973}
2974
Jaewoong Jung26342642021-03-17 15:56:23 -07002975func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2976 deps.processorPath = append(deps.processorPath, pluginJars...)
2977 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2978}
2979
2980// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2981// this interface.
2982type ProvidesUsesLib interface {
2983 ProvidesUsesLib() *string
2984}
2985
2986func (j *Module) ProvidesUsesLib() *string {
2987 return j.usesLibraryProperties.Provides_uses_lib
2988}
satayev1c564cc2021-05-25 19:50:30 +01002989
2990type ModuleWithStem interface {
2991 Stem() string
2992}
2993
2994var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002995
2996type ModuleWithUsesLibrary interface {
2997 UsesLibrary() *usesLibrary
2998}
2999
3000func (j *Module) UsesLibrary() *usesLibrary {
3001 return &j.usesLibrary
3002}
3003
3004var _ ModuleWithUsesLibrary = (*Module)(nil)