blob: 1aef37ca40d3f5d8940cc52c6bc0d986d6877bb7 [file] [log] [blame]
Jaewoong Jung26342642021-03-17 15:56:23 -07001// Copyright 2021 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package java
16
17import (
Yu Liu26a716d2024-08-30 23:40:32 +000018 "encoding/gob"
Jaewoong Jung26342642021-03-17 15:56:23 -070019 "fmt"
20 "path/filepath"
Joe Onorato349ae8d2024-02-05 22:46:00 +000021 "reflect"
22 "slices"
Jaewoong Jung26342642021-03-17 15:56:23 -070023 "strconv"
24 "strings"
25
Colin Crossd788b3e2023-11-28 13:14:56 -080026 "github.com/google/blueprint"
Colin Crossa14fb6a2024-10-23 16:57:06 -070027 "github.com/google/blueprint/depset"
Jaewoong Jung26342642021-03-17 15:56:23 -070028 "github.com/google/blueprint/pathtools"
29 "github.com/google/blueprint/proptools"
30
31 "android/soong/android"
32 "android/soong/dexpreopt"
33 "android/soong/java/config"
34)
35
36// This file contains the definition and the implementation of the base module that most
37// source-based Java module structs embed.
38
39// TODO:
40// Autogenerated files:
41// Renderscript
42// Post-jar passes:
43// Proguard
44// Rmtypedefs
45// DroidDoc
46// Findbugs
47
48// Properties that are common to most Java modules, i.e. whether it's a host or device module.
49type CommonProperties struct {
50 // list of source files used to compile the Java module. May be .java, .kt, .logtags, .proto,
51 // or .aidl files.
52 Srcs []string `android:"path,arch_variant"`
53
54 // list Kotlin of source files containing Kotlin code that should be treated as common code in
55 // a codebase that supports Kotlin multiplatform. See
56 // https://kotlinlang.org/docs/reference/multiplatform.html. May be only be .kt files.
57 Common_srcs []string `android:"path,arch_variant"`
58
59 // list of source files that should not be used to build the Java module.
60 // This is most useful in the arch/multilib variants to remove non-common files
61 Exclude_srcs []string `android:"path,arch_variant"`
62
Dave Mankoff0a3ef842024-10-02 18:47:24 +000063 // list of Kotlin source files that should excluded from the list of common_srcs.
64 Exclude_common_srcs []string `android:"path,arch_variant"`
65
Jaewoong Jung26342642021-03-17 15:56:23 -070066 // list of directories containing Java resources
67 Java_resource_dirs []string `android:"arch_variant"`
68
69 // list of directories that should be excluded from java_resource_dirs
70 Exclude_java_resource_dirs []string `android:"arch_variant"`
71
72 // list of files to use as Java resources
Cole Faust7fd5b2e2024-10-29 11:22:20 -070073 Java_resources proptools.Configurable[[]string] `android:"path,arch_variant"`
Jaewoong Jung26342642021-03-17 15:56:23 -070074
75 // list of files that should be excluded from java_resources and java_resource_dirs
76 Exclude_java_resources []string `android:"path,arch_variant"`
77
Cole Faust65cb40a2024-10-21 15:41:42 -070078 // Same as java_resources, but modules added here will use the device variant. Can be useful
79 // for making a host test that tests the contents of a device built app.
Cole Faust7fd5b2e2024-10-29 11:22:20 -070080 Device_common_java_resources proptools.Configurable[[]string] `android:"path_device_common"`
Cole Faust65cb40a2024-10-21 15:41:42 -070081
82 // Same as java_resources, but modules added here will use the device's os variant and the
83 // device's first architecture variant. Can be useful for making a host test that tests the
84 // contents of a native device built app.
Cole Faust7fd5b2e2024-10-29 11:22:20 -070085 Device_first_java_resources proptools.Configurable[[]string] `android:"path_device_first"`
Cole Faust65cb40a2024-10-21 15:41:42 -070086
Jaewoong Jung26342642021-03-17 15:56:23 -070087 // list of module-specific flags that will be used for javac compiles
88 Javacflags []string `android:"arch_variant"`
89
90 // list of module-specific flags that will be used for kotlinc compiles
91 Kotlincflags []string `android:"arch_variant"`
92
93 // list of java libraries that will be in the classpath
94 Libs []string `android:"arch_variant"`
95
96 // list of java libraries that will be compiled into the resulting jar
Cole Faustb7493472024-08-28 11:55:52 -070097 Static_libs proptools.Configurable[[]string] `android:"arch_variant"`
Jaewoong Jung26342642021-03-17 15:56:23 -070098
99 // manifest file to be included in resulting jar
100 Manifest *string `android:"path"`
101
102 // if not blank, run jarjar using the specified rules file
103 Jarjar_rules *string `android:"path,arch_variant"`
104
Joe Onoratoa5d17172024-07-20 17:39:56 -0700105 // java class names to rename with jarjar when a reverse dependency has a jarjar_prefix
106 // property.
107 Jarjar_rename []string
108
Joe Onorato349ae8d2024-02-05 22:46:00 +0000109 // if not blank, used as prefix to generate repackage rule
110 Jarjar_prefix *string
111
Makoto Onuki31db53a2024-12-06 16:40:47 -0800112 // Number of shards for jarjar. It needs to be an integer represented as a string.
113 // TODO(b/383559945) change it to int, once Configurable supports the type.
114 Jarjar_shards proptools.Configurable[string]
115
Jaewoong Jung26342642021-03-17 15:56:23 -0700116 // If not blank, set the java version passed to javac as -source and -target
117 Java_version *string
118
119 // If set to true, allow this module to be dexed and installed on devices. Has no
120 // effect on host modules, which are always considered installable.
121 Installable *bool
122
123 // If set to true, include sources used to compile the module in to the final jar
124 Include_srcs *bool
125
126 // If not empty, classes are restricted to the specified packages and their sub-packages.
127 // This restriction is checked after applying jarjar rules and including static libs.
128 Permitted_packages []string
129
130 // List of modules to use as annotation processors
131 Plugins []string
132
Luca Stefani50098f72024-10-12 17:55:31 +0200133 // List of modules to use as kotlin plugin
134 Kotlin_plugins []string
135
Jaewoong Jung26342642021-03-17 15:56:23 -0700136 // List of modules to export to libraries that directly depend on this library as annotation
137 // processors. Note that if the plugins set generates_api: true this will disable the turbine
138 // optimization on modules that depend on this module, which will reduce parallelism and cause
139 // more recompilation.
140 Exported_plugins []string
141
142 // The number of Java source entries each Javac instance can process
143 Javac_shard_size *int64
144
145 // Add host jdk tools.jar to bootclasspath
146 Use_tools_jar *bool
147
148 Openjdk9 struct {
149 // List of source files that should only be used when passing -source 1.9 or higher
150 Srcs []string `android:"path"`
151
152 // List of javac flags that should only be used when passing -source 1.9 or higher
153 Javacflags []string
154 }
155
156 // When compiling language level 9+ .java code in packages that are part of
157 // a system module, patch_module names the module that your sources and
158 // dependencies should be patched into. The Android runtime currently
159 // doesn't implement the JEP 261 module system so this option is only
160 // supported at compile time. It should only be needed to compile tests in
161 // packages that exist in libcore and which are inconvenient to move
162 // elsewhere.
Liz Kammer0a470a32023-10-05 17:02:00 -0400163 Patch_module *string
Jaewoong Jung26342642021-03-17 15:56:23 -0700164
165 Jacoco struct {
166 // List of classes to include for instrumentation with jacoco to collect coverage
167 // information at runtime when building with coverage enabled. If unset defaults to all
168 // classes.
169 // Supports '*' as the last character of an entry in the list as a wildcard match.
170 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
171 // it matches classes in the package that have the class name as a prefix.
172 Include_filter []string
173
174 // List of classes to exclude from instrumentation with jacoco to collect coverage
175 // information at runtime when building with coverage enabled. Overrides classes selected
176 // by the include_filter property.
177 // Supports '*' as the last character of an entry in the list as a wildcard match.
178 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
179 // it matches classes in the package that have the class name as a prefix.
180 Exclude_filter []string
181 }
182
183 Errorprone struct {
184 // List of javac flags that should only be used when running errorprone.
185 Javacflags []string
186
187 // List of java_plugin modules that provide extra errorprone checks.
188 Extra_check_modules []string
Cole Faust75fffb12021-06-13 15:23:16 -0700189
Cole Faust2b1536e2021-06-18 12:25:54 -0700190 // This property can be in 3 states. When set to true, errorprone will
191 // be run during the regular build. When set to false, errorprone will
192 // never be run. When unset, errorprone will be run when the RUN_ERROR_PRONE
193 // environment variable is true. Setting this to false will improve build
194 // performance more than adding -XepDisableAllChecks in javacflags.
Cole Faust75fffb12021-06-13 15:23:16 -0700195 Enabled *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700196 }
197
198 Proto struct {
199 // List of extra options that will be passed to the proto generator.
200 Output_params []string
201 }
202
Sam Delmericoc7593722022-08-31 15:57:52 -0400203 // If true, then jacocoagent is automatically added as a libs dependency so that
204 // r8 will not strip instrumentation classes out of dexed libraries.
Jaewoong Jung26342642021-03-17 15:56:23 -0700205 Instrument bool `blueprint:"mutated"`
Paul Duffin0038a8d2022-05-03 00:28:40 +0000206 // If true, then the module supports statically including the jacocoagent
207 // into the library.
208 Supports_static_instrumentation bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700209
210 // List of files to include in the META-INF/services folder of the resulting jar.
211 Services []string `android:"path,arch_variant"`
212
213 // If true, package the kotlin stdlib into the jar. Defaults to true.
214 Static_kotlin_stdlib *bool `android:"arch_variant"`
215
216 // A list of java_library instances that provide additional hiddenapi annotations for the library.
217 Hiddenapi_additional_annotations []string
Joe Onorato175073c2023-06-01 14:42:59 -0700218
219 // Additional srcJars tacked in by GeneratedJavaLibraryModule
220 Generated_srcjars []android.Path `android:"mutated"`
Mark Whitea15790a2023-08-22 21:28:11 +0000221
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000222 // intermediate aconfig cache file tacked in by GeneratedJavaLibraryModule
223 Aconfig_Cache_files []android.Path `android:"mutated"`
224
Mark Whitea15790a2023-08-22 21:28:11 +0000225 // If true, then only the headers are built and not the implementation jar.
Liz Kammer60772632023-10-05 17:18:44 -0400226 Headers_only *bool
Cole Faust2b64af82023-12-13 18:22:18 -0800227
228 // A list of files or dependencies to make available to the build sandbox. This is
229 // useful if source files are symlinks, the targets of the symlinks must be listed here.
230 // Note that currently not all actions implemented by android_apps are sandboxed, so you
231 // may only see this being necessary in lint builds.
232 Compile_data []string `android:"path"`
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000233
234 // Property signifying whether the module compiles stubs or not.
235 // Should be set to true when srcs of this module are stub files.
236 // This property does not need to be set to true when the module depends on
237 // the stubs via libs, but should be set to true when the module depends on
238 // the stubs via static libs.
239 Is_stubs_module *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700240
Makoto Onuki7ded3822024-03-28 14:42:20 -0700241 Ravenizer struct {
John Wu989ee842024-10-04 00:21:43 +0000242 // If true, enable the "Ravenizer" tool on the output jar.
243 // "Ravenizer" is a tool for Ravenwood tests, but it can also be enabled on other kinds
244 // of java targets.
Makoto Onuki7ded3822024-03-28 14:42:20 -0700245 Enabled *bool
John Wu989ee842024-10-04 00:21:43 +0000246
247 // If true, the "Ravenizer" tool will remove all Mockito and DexMaker
248 // classes from the output jar.
249 Strip_mockito *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700250 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +0000251
252 // Contributing api surface of the stub module. Is not visible to bp modules, and should
253 // only be set for stub submodules generated by the java_sdk_library
254 Stub_contributing_api *string `blueprint:"mutated"`
Yihan Dong8be09c22024-08-29 15:32:13 +0800255
256 // If true, enable the "ApiMapper" tool on the output jar. "ApiMapper" is a tool to inject
257 // bytecode to log API calls.
258 ApiMapper bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700259}
260
261// Properties that are specific to device modules. Host module factories should not add these when
262// constructing a new module.
263type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000264 // If not blank, set to the version of the sdk to compile against.
Spandan Das1ccf5742022-10-14 16:51:23 +0000265 // Defaults to an empty string, which compiles the module against the private platform APIs.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000266 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000267 // 1) numerical API level, "current", "none", or "core_platform"
268 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
269 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
270 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700271 Sdk_version *string
272
satayev0a420e72021-11-29 17:25:52 +0000273 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
274 // Defaults to empty string "". See sdk_version for possible values.
275 Max_sdk_version *string
276
William Loh5a082f92022-05-17 20:21:50 +0000277 // if not blank, set the maxSdkVersion properties of permission and uses-permission tags.
278 // Defaults to empty string "". See sdk_version for possible values.
279 Replace_max_sdk_version_placeholder *string
280
Jaewoong Jung26342642021-03-17 15:56:23 -0700281 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000282 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700283 Target_sdk_version *string
284
285 // Whether to compile against the platform APIs instead of an SDK.
286 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000287 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700288 Platform_apis *bool
289
290 Aidl struct {
291 // Top level directories to pass to aidl tool
292 Include_dirs []string
293
294 // Directories rooted at the Android.bp file to pass to aidl tool
295 Local_include_dirs []string
296
297 // directories that should be added as include directories for any aidl sources of modules
298 // that depend on this module, as well as to aidl for this module.
299 Export_include_dirs []string
300
301 // whether to generate traces (for systrace) for this interface
302 Generate_traces *bool
303
304 // whether to generate Binder#GetTransaction name method.
305 Generate_get_transaction_name *bool
306
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100307 // whether all interfaces should be annotated with required permissions.
308 Enforce_permissions *bool
309
310 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
311 Enforce_permissions_exceptions []string `android:"path"`
312
Jaewoong Jung26342642021-03-17 15:56:23 -0700313 // list of flags that will be passed to the AIDL compiler
314 Flags []string
315 }
316
317 // If true, export a copy of the module as a -hostdex module for host testing.
318 Hostdex *bool
319
320 Target struct {
321 Hostdex struct {
322 // Additional required dependencies to add to -hostdex modules.
323 Required []string
324 }
325 }
326
327 // When targeting 1.9 and above, override the modules to use with --system,
328 // otherwise provides defaults libraries to add to the bootclasspath.
329 System_modules *string
330
Jaewoong Jung26342642021-03-17 15:56:23 -0700331 IsSDKLibrary bool `blueprint:"mutated"`
332
333 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
334 // Defaults to false.
335 V4_signature *bool
336
337 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
338 // public stubs library.
339 SyspropPublicStub string `blueprint:"mutated"`
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000340
341 HiddenAPIPackageProperties
342 HiddenAPIFlagFileProperties
Jaewoong Jung26342642021-03-17 15:56:23 -0700343}
344
yangbill2af0b6e2024-03-15 09:29:29 +0000345// Properties that can be overridden by overriding module (e.g. override_android_app)
346type OverridableProperties struct {
Jooyung Han01d80d82022-01-08 12:16:32 +0900347 // set the name of the output. If not set, `name` is used.
348 // To override a module with this property set, overriding module might need to set this as well.
349 // Otherwise, both the overridden and the overriding modules will have the same output name, which
350 // can cause the duplicate output error.
351 Stem *string
Spandan Dasb9c58352024-05-13 18:29:45 +0000352
353 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
354 // Defaults to sdk_version if not set. See sdk_version for possible values.
355 Min_sdk_version *string
Jooyung Han01d80d82022-01-08 12:16:32 +0900356}
357
Jaewoong Jung26342642021-03-17 15:56:23 -0700358// Functionality common to Module and Import
359//
360// It is embedded in Module so its functionality can be used by methods in Module
361// but it is currently only initialized by Import and Library.
362type embeddableInModuleAndImport struct {
363
364 // Functionality related to this being used as a component of a java_sdk_library.
365 EmbeddableSdkLibraryComponent
366}
367
Paul Duffin71b33cc2021-06-23 11:39:47 +0100368func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
369 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700370}
371
Colin Crossf7bbd2f2024-12-05 13:57:10 -0800372// Module/Import's OutgoingDepIsInSameApex(...) delegates to this method.
Jaewoong Jung26342642021-03-17 15:56:23 -0700373//
Colin Crossf7bbd2f2024-12-05 13:57:10 -0800374// This cannot implement OutgoingDepIsInSameApex(...) directly as that leads to ambiguity with
Jaewoong Jung26342642021-03-17 15:56:23 -0700375// the one provided by ApexModuleBase.
Colin Crossf7bbd2f2024-12-05 13:57:10 -0800376func (e *embeddableInModuleAndImport) depIsInSameApex(tag blueprint.DependencyTag) bool {
Jaewoong Jung26342642021-03-17 15:56:23 -0700377 // dependencies other than the static linkage are all considered crossing APEX boundary
Colin Crossf7bbd2f2024-12-05 13:57:10 -0800378 if tag == staticLibTag {
Jaewoong Jung26342642021-03-17 15:56:23 -0700379 return true
380 }
381 return false
382}
383
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100384// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
385// or an invalid path describing the reason it is invalid.
386//
387// It is unset if a dex jar isn't applicable, i.e. no build rule has been
388// requested to create one.
389//
390// If a dex jar has been requested to be built then it is set, and it may be
391// either a valid android.Path, or invalid with a reason message. The latter
392// happens if the source that should produce the dex file isn't able to.
393//
394// E.g. it is invalid with a reason message if there is a prebuilt APEX that
395// could produce the dex jar through a deapexer module, but the APEX isn't
396// installable so doing so wouldn't be safe.
397type OptionalDexJarPath struct {
398 isSet bool
399 path android.OptionalPath
400}
401
402// IsSet returns true if a path has been set, either invalid or valid.
403func (o OptionalDexJarPath) IsSet() bool {
404 return o.isSet
405}
406
407// Valid returns true if there is a path that is valid.
408func (o OptionalDexJarPath) Valid() bool {
409 return o.isSet && o.path.Valid()
410}
411
412// Path returns the valid path, or panics if it's either not set or is invalid.
413func (o OptionalDexJarPath) Path() android.Path {
414 if !o.isSet {
415 panic("path isn't set")
416 }
417 return o.path.Path()
418}
419
420// PathOrNil returns the path if it's set and valid, or else nil.
421func (o OptionalDexJarPath) PathOrNil() android.Path {
422 if o.Valid() {
423 return o.Path()
424 }
425 return nil
426}
427
428// InvalidReason returns the reason for an invalid path, which is never "". It
429// returns "" for an unset or valid path.
430func (o OptionalDexJarPath) InvalidReason() string {
431 if !o.isSet {
432 return ""
433 }
434 return o.path.InvalidReason()
435}
436
437func (o OptionalDexJarPath) String() string {
438 if !o.isSet {
439 return "<unset>"
440 }
441 return o.path.String()
442}
443
444// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
445func makeUnsetDexJarPath() OptionalDexJarPath {
446 return OptionalDexJarPath{isSet: false}
447}
448
449// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
450// the given OptionalPath, which may be valid or invalid.
451func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
452 return OptionalDexJarPath{isSet: true, path: path}
453}
454
455// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
456// valid given path. It returns an unset OptionalDexJarPath if the given path is
457// nil.
458func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
459 if path == nil {
460 return makeUnsetDexJarPath()
461 }
462 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
463}
464
Jaewoong Jung26342642021-03-17 15:56:23 -0700465// Module contains the properties and members used by all java module types
466type Module struct {
467 android.ModuleBase
468 android.DefaultableModuleBase
469 android.ApexModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700470
471 // Functionality common to Module and Import.
472 embeddableInModuleAndImport
473
474 properties CommonProperties
475 protoProperties android.ProtoProperties
476 deviceProperties DeviceProperties
477
yangbill2af0b6e2024-03-15 09:29:29 +0000478 overridableProperties OverridableProperties
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700479 sourceProperties android.SourceProperties
Jooyung Han01d80d82022-01-08 12:16:32 +0900480
Jaewoong Jung26342642021-03-17 15:56:23 -0700481 // jar file containing header classes including static library dependencies, suitable for
482 // inserting into the bootclasspath/classpath of another compile
483 headerJarFile android.Path
484
485 // jar file containing implementation classes including static library dependencies but no
486 // resources
487 implementationJarFile android.Path
488
Jaewoong Jung26342642021-03-17 15:56:23 -0700489 // args and dependencies to package source files into a srcjar
490 srcJarArgs []string
491 srcJarDeps android.Paths
492
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000493 // the source files of this module and all its static dependencies
Colin Crossa14fb6a2024-10-23 16:57:06 -0700494 transitiveSrcFiles depset.DepSet[android.Path]
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000495
Jaewoong Jung26342642021-03-17 15:56:23 -0700496 // jar file containing implementation classes and resources including static library
497 // dependencies
498 implementationAndResourcesJar android.Path
499
500 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100501 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700502
503 // output file containing uninstrumented classes that will be instrumented by jacoco
504 jacocoReportClassesFile android.Path
505
506 // output file of the module, which may be a classes jar or a dex jar
507 outputFile android.Path
508 extraOutputFiles android.Paths
509
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100510 exportAidlIncludeDirs android.Paths
511 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700512
513 logtagsSrcs android.Paths
514
515 // installed file for binary dependency
516 installFile android.Path
517
Colin Cross3108ce12021-11-10 14:38:50 -0800518 // installed file for hostdex copy
519 hostdexInstallFile android.InstallPath
520
Chaohui Wangdcbe33c2022-10-11 11:13:30 +0800521 // list of unique .java and .kt source files
522 uniqueSrcFiles android.Paths
523
524 // list of srcjars that was passed to javac
525 compiledSrcJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700526
527 // manifest file to use instead of properties.Manifest
528 overrideManifest android.OptionalPath
529
Jaewoong Jung26342642021-03-17 15:56:23 -0700530 // list of plugins that this java module is exporting
531 exportedPluginJars android.Paths
532
533 // list of plugins that this java module is exporting
534 exportedPluginClasses []string
535
536 // if true, the exported plugins generate API and require disabling turbine.
537 exportedDisableTurbine bool
538
539 // list of source files, collected from srcFiles with unique java and all kt files,
540 // will be used by android.IDEInfo struct
541 expandIDEInfoCompiledSrcs []string
542
543 // expanded Jarjar_rules
544 expandJarjarRules android.Path
545
Joe Onorato349ae8d2024-02-05 22:46:00 +0000546 // jarjar rule for inherited jarjar rules
547 repackageJarjarRules android.Path
548
Jaewoong Jung26342642021-03-17 15:56:23 -0700549 // Extra files generated by the module type to be added as java resources.
550 extraResources android.Paths
551
552 hiddenAPI
553 dexer
554 dexpreopter
555 usesLibrary
556 linter
557
558 // list of the xref extraction files
Spandan Das1028d5a2024-08-19 21:45:48 +0000559 kytheFiles android.Paths
560 kytheKotlinFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700561
Jaewoong Jung26342642021-03-17 15:56:23 -0700562 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900563
564 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000565 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000566 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400567
568 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000569
570 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000571
572 // output file name based on Stem property.
573 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
574 // or the module should override Stem().
575 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700576
Joe Onorato349ae8d2024-02-05 22:46:00 +0000577 // Values that will be set in the JarJarProvider data for jarjar repackaging,
578 // and merged with our dependencies' rules.
579 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000580
581 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000582
583 // Paths to the aconfig intermediate cache files that are provided by the
584 // java_aconfig_library or java_library modules that are statically linked
585 // to this module. Does not contain cache files from all transitive dependencies.
586 aconfigCacheFiles android.Paths
Spandan Das8aac9932024-07-18 23:14:13 +0000587
588 // List of soong module dependencies required to compile the current module.
589 // This information is printed out to `Dependencies` field in module_bp_java_deps.json
590 compileDepNames []string
Makoto Onuki7ded3822024-03-28 14:42:20 -0700591
592 ravenizer struct {
593 enabled bool
594 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700595}
596
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000597var _ android.InstallableModule = (*Module)(nil)
598
599// To satisfy the InstallableModule interface
Jihoon Kang224ea082024-08-12 22:38:16 +0000600func (j *Module) StaticDependencyTags() []blueprint.DependencyTag {
601 return []blueprint.DependencyTag{staticLibTag}
602}
603
604// To satisfy the InstallableModule interface
605func (j *Module) DynamicDependencyTags() []blueprint.DependencyTag {
606 return []blueprint.DependencyTag{libTag, sdkLibTag, bootClasspathTag, systemModulesTag,
607 instrumentationForTag, java9LibTag}
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000608}
609
610// Overrides android.ModuleBase.InstallInProduct()
611func (j *Module) InstallInProduct() bool {
612 return j.ProductSpecific()
613}
614
Jihoon Kang85bc1932024-07-01 17:04:46 +0000615var _ android.StubsAvailableModule = (*Module)(nil)
616
617// To safisfy the StubsAvailableModule interface
618func (j *Module) IsStubsModule() bool {
619 return proptools.Bool(j.properties.Is_stubs_module)
620}
621
Yu Liu63bdf632024-12-03 19:54:05 +0000622func CheckStableSdkVersion(ctx android.BaseModuleContext, module android.ModuleProxy) error {
623 if info, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
624 if info.SdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700625 return nil
626 }
Yu Liu63bdf632024-12-03 19:54:05 +0000627 if info.SdkVersion.Kind == android.SdkCorePlatform {
628 if useLegacyCorePlatformApi(ctx, android.OtherModuleProviderOrDefault(ctx, module, android.CommonModuleInfoKey).BaseModuleName) {
629 return fmt.Errorf("non stable SDK %v - uses legacy core platform", info.SdkVersion)
630 } else {
631 // Treat stable core platform as stable.
632 return nil
633 }
634 } else {
635 return fmt.Errorf("non stable SDK %v", info.SdkVersion)
636 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700637 }
Yu Liu63bdf632024-12-03 19:54:05 +0000638
639 return nil
Jaewoong Jung26342642021-03-17 15:56:23 -0700640}
641
642// checkSdkVersions enforces restrictions around SDK dependencies.
643func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
644 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900645 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900646 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700647 ctx.PropertyErrorf("sdk_version",
648 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
649 }
650 }
651 }
652
653 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
654 // See rank() for details.
655 ctx.VisitDirectDeps(func(module android.Module) {
656 tag := ctx.OtherModuleDependencyTag(module)
657 switch module.(type) {
658 // TODO(satayev): cover other types as well, e.g. imports
659 case *Library, *AndroidLibrary:
660 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400661 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700662 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
663 }
664 }
665 })
666}
667
668func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900669 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700670 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900671 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700672 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000673 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 -0700674 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000675 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 -0700676 }
677
678 }
679}
680
Mark Whitea15790a2023-08-22 21:28:11 +0000681func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
682 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400683 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000684 installable := proptools.Bool(j.properties.Installable)
685
686 if headersOnly && installable {
687 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.")
688 }
689 }
690}
691
Jaewoong Jung26342642021-03-17 15:56:23 -0700692func (j *Module) addHostProperties() {
693 j.AddProperties(
694 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000695 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700696 &j.protoProperties,
697 &j.usesLibraryProperties,
698 )
699}
700
701func (j *Module) addHostAndDeviceProperties() {
702 j.addHostProperties()
703 j.AddProperties(
704 &j.deviceProperties,
705 &j.dexer.dexProperties,
706 &j.dexpreoptProperties,
707 &j.linter.properties,
708 )
709}
710
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000711// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
712// makes it available through the hiddenAPIPropertyInfoProvider.
713func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
714 hiddenAPIInfo := newHiddenAPIPropertyInfo()
715
716 // Populate with flag file paths from the properties.
717 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
718
719 // Populate with package rules from the properties.
720 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
721
Colin Cross40213022023-12-13 15:19:49 -0800722 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000723}
724
mrziwang9f7b9f42024-07-10 12:18:06 -0700725// helper method for java modules to set OutputFilesProvider
726func setOutputFiles(ctx android.ModuleContext, m Module) {
Cole Faust5146e782024-11-15 14:47:49 -0800727 ctx.SetOutputFiles(append(android.PathsIfNonNil(m.outputFile), m.extraOutputFiles...), "")
728 ctx.SetOutputFiles(android.PathsIfNonNil(m.outputFile), android.DefaultDistTag)
729 ctx.SetOutputFiles(android.PathsIfNonNil(m.implementationAndResourcesJar), ".jar")
730 ctx.SetOutputFiles(android.PathsIfNonNil(m.headerJarFile), ".hjar")
mrziwang9f7b9f42024-07-10 12:18:06 -0700731 if m.dexer.proguardDictionary.Valid() {
732 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
733 }
734 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
Jaewoong Jung26342642021-03-17 15:56:23 -0700735}
736
Jaewoong Jung26342642021-03-17 15:56:23 -0700737func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
738 initJavaModule(module, hod, false)
739}
740
741func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
742 initJavaModule(module, hod, true)
743}
744
745func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
746 multilib := android.MultilibCommon
747 if multiTargets {
748 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
749 } else {
750 android.InitAndroidArchModule(module, hod, multilib)
751 }
752 android.InitDefaultableModule(module)
753}
754
755func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
756 return j.properties.Instrument &&
757 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
758 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
759}
760
Yihan Dong8be09c22024-08-29 15:32:13 +0800761func (j *Module) shouldApiMapper() bool {
762 return j.properties.ApiMapper
763}
764
Jaewoong Jung26342642021-03-17 15:56:23 -0700765func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000766 return j.properties.Supports_static_instrumentation &&
767 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700768 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
769 ctx.Config().UnbundledBuild())
770}
771
772func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
773 // Force enable the instrumentation for java code that is built for APEXes ...
774 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
775 // 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 -0800776 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700777 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000778
Colin Crosse4f34882024-11-14 12:26:00 -0800779 compileDex := Bool(j.dexProperties.Compile_dex) || Bool(j.properties.Installable)
780 if compileDex && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700781 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
782 return true
783 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
784 return true
785 }
786 }
787 return false
788}
789
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400790func (j *Module) setInstrument(value bool) {
791 j.properties.Instrument = value
792}
793
Yihan Dong8be09c22024-08-29 15:32:13 +0800794func (j *Module) setApiMapper(value bool) {
795 j.properties.ApiMapper = value
796}
797
Jiyong Park92315372021-04-02 08:45:46 +0900798func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
799 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700800}
801
Jiyong Parkf1691d22021-03-29 20:11:58 +0900802func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700803 return proptools.String(j.deviceProperties.System_modules)
804}
805
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000806func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000807 if j.overridableProperties.Min_sdk_version != nil {
808 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700809 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000810 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700811}
812
Yu Liuf2b94012023-09-19 15:09:10 -0700813func (j *Module) GetDeviceProperties() *DeviceProperties {
814 return &j.deviceProperties
815}
816
Spandan Dasa26eda72023-03-02 00:56:06 +0000817func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
818 if j.deviceProperties.Max_sdk_version != nil {
819 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
820 }
821 // Default is PrivateApiLevel
822 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000823}
824
Spandan Dasa26eda72023-03-02 00:56:06 +0000825func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
826 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
827 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
828 }
829 // Default is PrivateApiLevel
830 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000831}
832
Jiyong Parkf1691d22021-03-29 20:11:58 +0900833func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000834 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900835}
836
Spandan Dasca70fc42023-03-01 23:38:49 +0000837func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900838 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000839 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900840 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000841 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700842}
843
844func (j *Module) AvailableFor(what string) bool {
Yu Liub73c3a62024-12-10 00:58:06 +0000845 return android.CheckAvailableForApex(what, j.ApexAvailableFor())
846}
847
848func (j *Module) ApexAvailableFor() []string {
849 list := j.ApexModuleBase.ApexAvailable()
850 if Bool(j.deviceProperties.Hostdex) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700851 // Exception: for hostdex: true libraries, the platform variant is created
852 // even if it's not marked as available to platform. In that case, the platform
853 // variant is used only for the hostdex and not installed to the device.
Yu Liub73c3a62024-12-10 00:58:06 +0000854 list = append(list, android.AvailableToPlatform)
Jaewoong Jung26342642021-03-17 15:56:23 -0700855 }
Yu Liub73c3a62024-12-10 00:58:06 +0000856 return android.FirstUniqueStrings(list)
Jaewoong Jung26342642021-03-17 15:56:23 -0700857}
858
Cole Faustb7493472024-08-28 11:55:52 -0700859func (j *Module) staticLibs(ctx android.BaseModuleContext) []string {
Jihoon Kang8bce3812024-09-30 18:46:51 +0000860 return j.properties.Static_libs.GetOrDefault(ctx, nil)
Cole Faustb7493472024-08-28 11:55:52 -0700861}
862
Jaewoong Jung26342642021-03-17 15:56:23 -0700863func (j *Module) deps(ctx android.BottomUpMutatorContext) {
864 if ctx.Device() {
865 j.linter.deps(ctx)
866
Jiyong Parkf1691d22021-03-29 20:11:58 +0900867 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700868
869 if j.deviceProperties.SyspropPublicStub != "" {
870 // This is a sysprop implementation library that has a corresponding sysprop public
871 // stubs library, and a dependency on it so that dependencies on the implementation can
872 // be forwarded to the public stubs library when necessary.
873 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
874 }
875 }
876
877 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000878
Cole Faustb7493472024-08-28 11:55:52 -0700879 ctx.AddVariationDependencies(nil, staticLibTag, j.staticLibs(ctx)...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700880
881 // Add dependency on libraries that provide additional hidden api annotations.
882 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
883
Jaewoong Jung26342642021-03-17 15:56:23 -0700884 // For library dependencies that are component libraries (like stubs), add the implementation
885 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
886 for _, dep := range libDeps {
887 if dep != nil {
888 if component, ok := dep.(SdkLibraryComponentDependency); ok {
889 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000890 // Add library as optional if it's one of the optional compatibility libs or it's
891 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100892 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000893 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
Cole Faust64f2d842024-10-17 13:28:34 -0700894 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs.GetOrDefault(ctx, nil)) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100895 tag = usesLibOptTag
896 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100897 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700898 }
899 }
900 }
901 }
902
903 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Luca Stefani50098f72024-10-12 17:55:31 +0200904 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag, j.properties.Kotlin_plugins...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700905 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
906 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
907
908 android.ProtoDeps(ctx, &j.protoProperties)
909 if j.hasSrcExt(".proto") {
910 protoDeps(ctx, &j.protoProperties)
911 }
912
913 if j.hasSrcExt(".kt") {
914 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
915 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700916 tag := staticLibTag
917 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
918 tag = libTag
919 }
920 ctx.AddVariationDependencies(nil, tag,
921 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700922 }
923
924 // Framework libraries need special handling in static coverage builds: they should not have
925 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
926 // the same jacoco classes coming from different bootclasspath jars.
927 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
928 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
929 j.properties.Instrument = true
930 }
931 } else if j.shouldInstrumentStatic(ctx) {
932 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
933 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700934
Cole Faustb7493472024-08-28 11:55:52 -0700935 if j.useCompose(ctx) {
Colin Crossa1ff7c62021-09-17 14:11:52 -0700936 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
Dave Mankoff0a3ef842024-10-02 18:47:24 +0000937 "kotlin-compose-compiler-plugin")
Colin Crossa1ff7c62021-09-17 14:11:52 -0700938 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700939}
940
941func hasSrcExt(srcs []string, ext string) bool {
942 for _, src := range srcs {
943 if filepath.Ext(src) == ext {
944 return true
945 }
946 }
947
948 return false
949}
950
951func (j *Module) hasSrcExt(ext string) bool {
952 return hasSrcExt(j.properties.Srcs, ext)
953}
954
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100955func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
956 var flags string
957
958 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
959 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
960 flags = "-Wmissing-permission-annotation -Werror"
961 }
962 }
963 return flags
964}
965
Jaewoong Jung26342642021-03-17 15:56:23 -0700966func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000967 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700968
969 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
970 aidlIncludes = append(aidlIncludes,
971 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
972 aidlIncludes = append(aidlIncludes,
973 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
974
975 var flags []string
976 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000977 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700978
979 flags = append(flags, j.deviceProperties.Aidl.Flags...)
980
981 if aidlPreprocess.Valid() {
982 flags = append(flags, "-p"+aidlPreprocess.String())
983 deps = append(deps, aidlPreprocess.Path())
984 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000985 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700986 }
987
988 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000989 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700990 }
991
992 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000993 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700994 }
995
Sam Delmerico2351eac2022-05-24 17:10:02 +0000996 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700997 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000998 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700999 }
Sam Delmerico2351eac2022-05-24 17:10:02 +00001000 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
1001 // add flags for dirs containing AIDL srcs that haven't been specified yet
1002 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -07001003
Zim8774ae12022-08-17 11:46:34 +01001004 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +00001005 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +01001006 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001007 flags = append(flags, "-t")
1008 }
1009
1010 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
1011 flags = append(flags, "--transaction_names")
1012 }
1013
Thiébaud Weksteende8417c2022-02-10 15:41:46 +11001014 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
1015 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
1016 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1017 }
1018
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001019 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001020 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1021
Jaewoong Jung26342642021-03-17 15:56:23 -07001022 return strings.Join(flags, " "), deps
1023}
1024
1025func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1026
1027 var flags javaBuilderFlags
1028
1029 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001030 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001031
Cole Faust2b1536e2021-06-18 12:25:54 -07001032 epEnabled := j.properties.Errorprone.Enabled
1033 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001034 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001035 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1036 }
1037
1038 errorProneFlags := []string{
1039 "-Xplugin:ErrorProne",
1040 "${config.ErrorProneChecks}",
1041 }
1042 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1043
Colin Cross8bf6cad2022-02-28 13:07:03 -08001044 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001045 "'" + strings.Join(errorProneFlags, " ") + "'"
1046 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1047 }
1048
1049 // classpath
1050 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1051 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001052 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001053 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1054 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1055 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1056
1057 flags.processors = append(flags.processors, deps.processorClasses...)
1058 flags.processors = android.FirstUniqueStrings(flags.processors)
1059
1060 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001061 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001062 // Give host-side tools a version of OpenJDK's standard libraries
1063 // close to what they're targeting. As of Dec 2017, AOSP is only
1064 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1065 //
1066 // When building with OpenJDK 8, the following should have no
1067 // effect since those jars would be available by default.
1068 //
1069 // When building with OpenJDK 9 but targeting a version < 1.8,
1070 // putting them on the bootclasspath means that:
1071 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1072 // b) references to existing APIs are not reinterpreted in an
1073 // OpenJDK 9-specific way, eg. calls to subclasses of
1074 // java.nio.Buffer as in http://b/70862583
1075 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1076 flags.bootClasspath = append(flags.bootClasspath,
1077 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1078 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1079 if Bool(j.properties.Use_tools_jar) {
1080 flags.bootClasspath = append(flags.bootClasspath,
1081 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1082 }
1083 }
1084
1085 // systemModules
1086 flags.systemModules = deps.systemModules
1087
Jaewoong Jung26342642021-03-17 15:56:23 -07001088 return flags
1089}
1090
1091func (j *Module) collectJavacFlags(
1092 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1093 // javac flags.
1094 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001095 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001096
Mythri Alle4b9f6182023-10-25 15:17:11 +00001097 needsDebugInfo = false
1098 for _, flag := range javacFlags {
1099 if strings.HasPrefix(flag, "-g") {
1100 needsDebugInfo = true
1101 }
1102 }
1103
1104 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001105 // For non-host binaries, override the -g flag passed globally to remove
1106 // local variable debug info to reduce disk and memory usage.
1107 javacFlags = append(javacFlags, "-g:source,lines")
1108 }
1109 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1110
1111 if flags.javaVersion.usesJavaModules() {
1112 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001113 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1114 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1115 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1116 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001117
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001118 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001119 if j.properties.Patch_module != nil {
1120 // Manually specify build directory in case it is not under the repo root.
1121 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1122 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001123 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001124
Jaewoong Jung26342642021-03-17 15:56:23 -07001125 classPath := flags.classpath.FormJavaClassPath("")
1126 if classPath != "" {
1127 patchPaths = append(patchPaths, classPath)
1128 }
1129 javacFlags = append(
1130 javacFlags,
1131 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1132 }
1133 }
1134
1135 if len(javacFlags) > 0 {
1136 // optimization.
1137 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1138 flags.javacFlags = "$javacFlags"
1139 }
1140
1141 return flags
1142}
1143
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001144func (j *Module) AddJSONData(d *map[string]interface{}) {
1145 (&j.ModuleBase).AddJSONData(d)
1146 (*d)["Java"] = map[string]interface{}{
1147 "SourceExtensions": j.sourceExtensions,
1148 }
1149
1150}
1151
usta0391ca42023-09-19 15:51:59 -04001152func (j *Module) addGeneratedSrcJars(path android.Path) {
1153 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001154}
1155
Colin Crossfdaa6722024-08-23 11:58:08 -07001156func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars, extraDepCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001157 // Auto-propagating jarjar rules
1158 jarjarProviderData := j.collectJarJarRules(ctx)
1159 if jarjarProviderData != nil {
1160 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wangddb2ee52024-04-02 16:44:02 +00001161 text := getJarJarRuleText(jarjarProviderData)
1162 if text != "" {
1163 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1164 android.WriteFileRule(ctx, ruleTextFile, text)
1165 j.repackageJarjarRules = ruleTextFile
Joe Onorato349ae8d2024-02-05 22:46:00 +00001166 }
1167 }
1168
Jaewoong Jung26342642021-03-17 15:56:23 -07001169 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1170
John Wu989ee842024-10-04 00:21:43 +00001171 // Only override the original value if explicitly set
1172 if j.properties.Ravenizer.Enabled != nil {
1173 j.ravenizer.enabled = *j.properties.Ravenizer.Enabled
Makoto Onuki7ded3822024-03-28 14:42:20 -07001174 }
1175
Jaewoong Jung26342642021-03-17 15:56:23 -07001176 deps := j.collectDeps(ctx)
1177 flags := j.collectBuilderFlags(ctx, deps)
1178
1179 if flags.javaVersion.usesJavaModules() {
1180 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001181 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1182 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1183 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001184 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001185
Jaewoong Jung26342642021-03-17 15:56:23 -07001186 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001187 j.sourceExtensions = []string{}
1188 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1189 if hasSrcExt(srcFiles.Strings(), ext) {
1190 j.sourceExtensions = append(j.sourceExtensions, ext)
1191 }
1192 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001193 if hasSrcExt(srcFiles.Strings(), ".proto") {
1194 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1195 }
1196
Dave Mankoff0a3ef842024-10-02 18:47:24 +00001197 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, j.properties.Exclude_common_srcs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001198 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1199 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1200 }
1201
Sam Delmerico2351eac2022-05-24 17:10:02 +00001202 aidlSrcs := srcFiles.FilterByExt(".aidl")
1203 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1204
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001205 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001206 srcFiles = j.genSources(ctx, srcFiles, flags)
1207
1208 // Collect javac flags only after computing the full set of srcFiles to
1209 // ensure that the --patch-module lookup paths are complete.
1210 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1211
1212 srcJars := srcFiles.FilterByExt(".srcjar")
1213 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001214 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001215 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001216 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001217
1218 if j.properties.Jarjar_rules != nil {
1219 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1220 }
1221
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001222 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001223
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001224 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001225 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001226 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001227 if _, found := set[v.String()]; !found {
1228 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001229 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001230 }
1231 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001232 var uniqueKtFiles android.Paths
1233 for _, v := range srcFiles.FilterByExt(".kt") {
1234 if _, found := set[v.String()]; !found {
1235 set[v.String()] = true
1236 uniqueKtFiles = append(uniqueKtFiles, v)
1237 }
1238 }
1239
1240 var uniqueSrcFiles android.Paths
1241 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1242 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1243 j.uniqueSrcFiles = uniqueSrcFiles
Jaewoong Jung26342642021-03-17 15:56:23 -07001244
Colin Crossb5db4012022-03-28 17:12:39 -07001245 // We don't currently run annotation processors in turbine, which means we can't use turbine
1246 // generated header jars when an annotation processor that generates API is enabled. One
1247 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1248 // is used to run all of the annotation processors.
1249 disableTurbine := deps.disableTurbine
1250
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001251 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001252 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1253
Colin Cross220a9a12022-03-28 17:08:01 -07001254 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001255
Colin Cross4eae06d2023-06-20 22:40:02 -07001256 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1257 // any dependencies so that it can override any non-final R classes from dependencies with the
1258 // final R classes from the app.
1259 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1260
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001261 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1262
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001263 var localImplementationJars android.Paths
1264
Mark Whitea15790a2023-08-22 21:28:11 +00001265 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001266 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001267 if srcFiles.HasExt(".kt") {
1268 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1269 }
1270 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1271 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1272 }
1273
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001274 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1275
1276 localHeaderJars, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
Colin Crossedec77c2024-07-26 15:25:40 -07001277 extraCombinedJars)
1278
Makoto Onuki31db53a2024-12-06 16:40:47 -08001279 combinedHeaderJarFile, jarjared := j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine", false)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001280 if jarjared {
1281 localHeaderJars = android.Paths{combinedHeaderJarFile}
1282 transitiveStaticLibsHeaderJars = nil
1283 }
1284 combinedHeaderJarFile, repackaged := j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
1285 if repackaged {
1286 localHeaderJars = android.Paths{combinedHeaderJarFile}
1287 transitiveStaticLibsHeaderJars = nil
1288 }
Mark Whitea15790a2023-08-22 21:28:11 +00001289 if ctx.Failed() {
1290 return
1291 }
Colin Crossedec77c2024-07-26 15:25:40 -07001292 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001293
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001294 if ctx.Config().UseTransitiveJarsInClasspath() {
1295 if len(localHeaderJars) > 0 {
1296 ctx.CheckbuildFile(localHeaderJars...)
1297 } else {
1298 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1299 ctx.UncheckedModule()
1300 }
1301 } else {
1302 ctx.CheckbuildFile(j.headerJarFile)
1303 }
Colin Crossa6182ab2024-08-21 10:47:44 -07001304
Colin Cross7727c7f2024-07-18 15:36:32 -07001305 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001306 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001307 LocalHeaderJars: localHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001308 TransitiveStaticLibsHeaderJars: depset.New(depset.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Cross9ffaf282024-08-12 13:50:09 -07001309 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1310 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001311 AidlIncludeDirs: j.exportAidlIncludeDirs,
1312 ExportedPlugins: j.exportedPluginJars,
1313 ExportedPluginClasses: j.exportedPluginClasses,
1314 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1315 StubsLinkType: j.stubsLinkType,
1316 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Yu Liu63bdf632024-12-03 19:54:05 +00001317 SdkVersion: j.SdkVersion(ctx),
Mark Whitea15790a2023-08-22 21:28:11 +00001318 })
1319
1320 j.outputFile = j.headerJarFile
1321 return
1322 }
1323
Jaewoong Jung26342642021-03-17 15:56:23 -07001324 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001325 // When using kotlin sources turbine is used to generate annotation processor sources,
1326 // including for annotation processors that generate API, so we can use turbine for
1327 // java sources too.
1328 disableTurbine = false
1329
Jaewoong Jung26342642021-03-17 15:56:23 -07001330 // user defined kotlin flags.
1331 kotlincFlags := j.properties.Kotlincflags
1332 CheckKotlincFlags(ctx, kotlincFlags)
1333
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001334 // Workaround for KT-46512
1335 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001336
1337 // If there are kotlin files, compile them first but pass all the kotlin and java files
1338 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1339 // won't emit any classes for them.
1340 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1341 if ctx.Device() {
1342 kotlincFlags = append(kotlincFlags, "-no-jdk")
1343 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001344
1345 for _, plugin := range deps.kotlinPlugins {
1346 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1347 }
1348 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1349
Jaewoong Jung26342642021-03-17 15:56:23 -07001350 if len(kotlincFlags) > 0 {
1351 // optimization.
1352 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1353 flags.kotlincFlags += "$kotlincFlags"
1354 }
1355
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001356 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001357 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1358
Jaewoong Jung26342642021-03-17 15:56:23 -07001359 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1360 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1361
Isaac Chioua23d9942022-04-06 06:14:38 +00001362 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001363 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001364 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1365 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001366 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001367 srcJars = append(srcJars, kaptSrcJar)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001368 localImplementationJars = append(localImplementationJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001369 // Disable annotation processing in javac, it's already been handled by kapt
1370 flags.processorPath = nil
1371 flags.processors = nil
1372 }
1373
1374 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001375 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Spandan Das1028d5a2024-08-19 21:45:48 +00001376 j.kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001377 if ctx.Failed() {
1378 return
1379 }
1380
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001381 kotlinJarPath, _ := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001382
Isaac Chioua23d9942022-04-06 06:14:38 +00001383 // Make javac rule depend on the kotlinc rule
1384 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1385
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001386 localImplementationJars = append(localImplementationJars, kotlinJarPath)
1387
Colin Cross220a9a12022-03-28 17:08:01 -07001388 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001389 }
1390
Jaewoong Jung26342642021-03-17 15:56:23 -07001391 j.compiledSrcJars = srcJars
1392
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001393 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1394
Jaewoong Jung26342642021-03-17 15:56:23 -07001395 enableSharding := false
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001396 var localHeaderJars android.Paths
1397 var shardingHeaderJars android.Paths
1398 var repackagedHeaderJarFile android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001399 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001400 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1401 enableSharding = true
1402 // Formerly, there was a check here that prevented annotation processors
1403 // from being used when sharding was enabled, as some annotation processors
1404 // do not function correctly in sharded environments. It was removed to
1405 // allow for the use of annotation processors that do function correctly
1406 // with sharding enabled. See: b/77284273.
1407 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001408 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001409 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001410 var combinedHeaderJarFile android.Path
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001411 localHeaderJars, combinedHeaderJarFile = j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
1412 shardingHeaderJars = localHeaderJars
Colin Crossedec77c2024-07-26 15:25:40 -07001413
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001414 var jarjared bool
Makoto Onuki31db53a2024-12-06 16:40:47 -08001415 j.headerJarFile, jarjared = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine", false)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001416 if jarjared {
1417 // jarjar modifies transitive static dependencies, use the combined header jar and drop the transitive
1418 // static libs header jars.
1419 localHeaderJars = android.Paths{j.headerJarFile}
1420 transitiveStaticLibsHeaderJars = nil
1421 }
1422 var repackaged bool
1423 repackagedHeaderJarFile, repackaged = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
1424 if repackaged {
1425 // repackage modifies transitive static dependencies, use the combined header jar and drop the transitive
1426 // static libs header jars.
1427 // TODO(b/356688296): this shouldn't export both the unmodified and repackaged header jars
1428 localHeaderJars = android.Paths{j.headerJarFile, repackagedHeaderJarFile}
1429 transitiveStaticLibsHeaderJars = nil
1430 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001431 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001432 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001433 hasErrorproneableFiles := false
1434 for _, ext := range j.sourceExtensions {
1435 if ext != ".proto" && ext != ".aidl" {
1436 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1437 // compile, and it's not useful to have warnings on these generated sources.
1438 hasErrorproneableFiles = true
1439 break
1440 }
1441 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001442 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001443 if Bool(j.properties.Errorprone.Enabled) {
1444 // If error-prone is enabled, enable errorprone flags on the regular
1445 // build.
1446 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001447 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faustf3240f42024-12-11 16:49:18 -08001448 if ctx.Config().RunErrorProneInline() {
1449 // On CI, we're not going to toggle back/forth between errorprone and non-errorprone
1450 // builds, so it's faster if we don't compile the module twice and instead always
1451 // compile the module with errorprone.
1452 flags = enableErrorproneFlags(flags)
1453 } else {
1454 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1455 // a new jar file just for compiling with the errorprone compiler to.
1456 // This is because we don't want to cause the java files to get completely
1457 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1458 // We also don't want to run this if errorprone is enabled by default for
1459 // this module, or else we could have duplicated errorprone messages.
1460 errorproneFlags := enableErrorproneFlags(flags)
1461 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
1462 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001463
Cole Faustf3240f42024-12-11 16:49:18 -08001464 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
1465 "errorprone", "errorprone")
Cole Faust75fffb12021-06-13 15:23:16 -07001466
Cole Faustf3240f42024-12-11 16:49:18 -08001467 extraJarDeps = append(extraJarDeps, errorprone)
1468 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001469 }
1470
1471 if enableSharding {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001472 if len(shardingHeaderJars) > 0 {
1473 flags.classpath = append(classpath(slices.Clone(shardingHeaderJars)), flags.classpath...)
Colin Cross3d56ed52021-11-18 22:23:12 -08001474 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001475 shardSize := int(*(j.properties.Javac_shard_size))
1476 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001477 if len(uniqueJavaFiles) > 0 {
1478 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001479 for idx, shardSrc := range shardSrcs {
1480 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1481 nil, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001482 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
1483 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001484 }
1485 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001486 // Assume approximately 5 sources per srcjar.
1487 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1488 // 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 -07001489 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001490 startIdx := len(shardSrcs)
1491 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1492 for idx, shardSrcJars := range shardSrcJarsList {
1493 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1494 nil, shardSrcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001495 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
1496 localImplementationJars = append(localImplementationJars, classes)
Colin Crossa052ddb2023-09-25 21:46:58 -07001497 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001498 }
1499 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001500 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001501 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
1502 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001503 }
1504 if ctx.Failed() {
1505 return
1506 }
1507 }
1508
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001509 localImplementationJars = append(localImplementationJars, extraCombinedJars...)
Colin Crossfd620b22024-02-23 10:05:21 -08001510
Jaewoong Jung26342642021-03-17 15:56:23 -07001511 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1512
1513 var includeSrcJar android.WritablePath
1514 if Bool(j.properties.Include_srcs) {
1515 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1516 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1517 }
1518
1519 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1520 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Cole Faust7fd5b2e2024-10-29 11:22:20 -07001521 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources.GetOrDefault(ctx, nil), j.properties.Exclude_java_resources)
1522 fileArgs2, fileDeps2 := ResourceFilesToJarArgs(ctx, j.properties.Device_common_java_resources.GetOrDefault(ctx, nil), nil)
1523 fileArgs3, fileDeps3 := ResourceFilesToJarArgs(ctx, j.properties.Device_first_java_resources.GetOrDefault(ctx, nil), nil)
Cole Faust65cb40a2024-10-21 15:41:42 -07001524 fileArgs = slices.Concat(fileArgs, fileArgs2, fileArgs3)
1525 fileDeps = slices.Concat(fileDeps, fileDeps2, fileDeps3)
Jaewoong Jung26342642021-03-17 15:56:23 -07001526 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1527
1528 var resArgs []string
1529 var resDeps android.Paths
1530
1531 resArgs = append(resArgs, dirArgs...)
1532 resDeps = append(resDeps, dirDeps...)
1533
1534 resArgs = append(resArgs, fileArgs...)
1535 resDeps = append(resDeps, fileDeps...)
1536
1537 resArgs = append(resArgs, extraArgs...)
1538 resDeps = append(resDeps, extraDeps...)
1539
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001540 var localResourceJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001541 if len(resArgs) > 0 {
1542 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1543 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001544 if ctx.Failed() {
1545 return
1546 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001547 localResourceJars = append(localResourceJars, resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001548 }
1549
Jaewoong Jung26342642021-03-17 15:56:23 -07001550 if Bool(j.properties.Include_srcs) {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001551 localResourceJars = append(localResourceJars, includeSrcJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001552 }
1553
1554 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1555 if len(services) > 0 {
1556 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1557 var zipargs []string
1558 for _, file := range services {
1559 serviceFile := file.String()
1560 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1561 }
1562 rule := zip
1563 args := map[string]string{
1564 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1565 }
1566 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1567 rule = zipRE
1568 args["implicits"] = strings.Join(services.Strings(), ",")
1569 }
1570 ctx.Build(pctx, android.BuildParams{
1571 Rule: rule,
1572 Output: servicesJar,
1573 Implicits: services,
1574 Args: args,
1575 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001576 localResourceJars = append(localResourceJars, servicesJar)
1577 }
1578
Colin Crossa14fb6a2024-10-23 16:57:06 -07001579 completeStaticLibsResourceJars := depset.New(depset.PREORDER, localResourceJars, deps.transitiveStaticLibsResourceJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001580
1581 var combinedResourceJar android.Path
1582 var resourceJars android.Paths
1583 if ctx.Config().UseTransitiveJarsInClasspath() {
1584 resourceJars = completeStaticLibsResourceJars.ToList()
1585 } else {
1586 resourceJars = append(slices.Clone(localResourceJars), deps.staticResourceJars...)
1587 }
1588 if len(resourceJars) == 1 {
1589 combinedResourceJar = resourceJars[0]
1590 } else if len(resourceJars) > 0 {
1591 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1592 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1593 false, nil, nil)
1594 combinedResourceJar = combinedJar
1595 }
1596
1597 manifest := j.overrideManifest
1598 if !manifest.Valid() && j.properties.Manifest != nil {
1599 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Jaewoong Jung26342642021-03-17 15:56:23 -07001600 }
1601
1602 // Combine the classes built from sources, any manifests, and any static libraries into
1603 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001604 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001605
Colin Crossa14fb6a2024-10-23 16:57:06 -07001606 completeStaticLibsImplementationJars := depset.New(depset.PREORDER, localImplementationJars, deps.transitiveStaticLibsImplementationJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001607
1608 var jars android.Paths
1609 if ctx.Config().UseTransitiveJarsInClasspath() {
1610 jars = completeStaticLibsImplementationJars.ToList()
1611 } else {
1612 jars = append(slices.Clone(localImplementationJars), deps.staticJars...)
1613 }
1614
1615 jars = append(jars, extraDepCombinedJars...)
1616
Jaewoong Jung26342642021-03-17 15:56:23 -07001617 if len(jars) == 1 && !manifest.Valid() {
1618 // Optimization: skip the combine step as there is nothing to do
1619 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1620 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001621 // any if len(extraJars) == 0.
Jaewoong Jung26342642021-03-17 15:56:23 -07001622
Jihoon Kang1147b312023-06-08 23:25:57 +00001623 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1624 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1625 // either with .from-source or .from-text suffix.
1626 // outputFile should be agnostic to the build configuration,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001627 // thus copy the single input static lib in order to prevent the static lib from being exposed
Jihoon Kang1147b312023-06-08 23:25:57 +00001628 // to the copy rules.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001629 if stub, _ := moduleStubLinkType(j); stub {
1630 copiedJar := android.PathForModuleOut(ctx, "combined", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001631 ctx.Build(pctx, android.BuildParams{
1632 Rule: android.Cp,
1633 Input: jars[0],
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001634 Output: copiedJar,
Jaewoong Jung26342642021-03-17 15:56:23 -07001635 })
Colin Crossa14fb6a2024-10-23 16:57:06 -07001636 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, android.Paths{copiedJar}, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001637 outputFile = copiedJar
Colin Cross7707b242024-07-26 12:02:36 -07001638 } else {
1639 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001640 }
1641 } else {
1642 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1643 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1644 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001645 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001646 }
1647
1648 // jarjar implementation jar if necessary
Makoto Onuki31db53a2024-12-06 16:40:47 -08001649 jarjarFile, jarjarred := j.jarjarIfNecessary(ctx, outputFile, jarName, "", true)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001650 if jarjarred {
1651 localImplementationJars = android.Paths{jarjarFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001652 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001653 }
Colin Crossedec77c2024-07-26 15:25:40 -07001654 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001655
Colin Crossedec77c2024-07-26 15:25:40 -07001656 // jarjar resource jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001657 if combinedResourceJar != nil {
Makoto Onuki31db53a2024-12-06 16:40:47 -08001658 resourceJarJarFile, jarjarred := j.jarjarIfNecessary(ctx, combinedResourceJar, jarName, "resource", false)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001659 combinedResourceJar = resourceJarJarFile
1660 if jarjarred {
1661 localResourceJars = android.Paths{resourceJarJarFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001662 completeStaticLibsResourceJars = depset.New(depset.PREORDER, localResourceJars, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001663 }
Colin Crossedec77c2024-07-26 15:25:40 -07001664 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001665
Colin Crossedec77c2024-07-26 15:25:40 -07001666 if ctx.Failed() {
1667 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001668 }
1669
Makoto Onuki7ded3822024-03-28 14:42:20 -07001670 if j.ravenizer.enabled {
1671 ravenizerInput := outputFile
John Wub67040d2024-10-07 18:39:06 +00001672 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", "", jarName)
John Wu989ee842024-10-04 00:21:43 +00001673 ravenizerArgs := ""
1674 if proptools.Bool(j.properties.Ravenizer.Strip_mockito) {
1675 ravenizerArgs = "--strip-mockito"
1676 }
1677 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
Makoto Onuki7ded3822024-03-28 14:42:20 -07001678 outputFile = ravenizerOutput
Colin Cross7e863852024-09-06 14:42:38 -07001679 localImplementationJars = android.Paths{ravenizerOutput}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001680 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001681 if combinedResourceJar != nil {
1682 ravenizerInput = combinedResourceJar
1683 ravenizerOutput = android.PathForModuleOut(ctx, "ravenizer", "resources", jarName)
1684 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
1685 combinedResourceJar = ravenizerOutput
1686 localResourceJars = android.Paths{ravenizerOutput}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001687 completeStaticLibsResourceJars = depset.New(depset.PREORDER, localResourceJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001688 }
Makoto Onuki7ded3822024-03-28 14:42:20 -07001689 }
1690
Yihan Dong8be09c22024-08-29 15:32:13 +08001691 if j.shouldApiMapper() {
1692 inputFile := outputFile
1693 apiMapperFile := android.PathForModuleOut(ctx, "apimapper", jarName)
1694 ctx.Build(pctx, android.BuildParams{
1695 Rule: apimapper,
1696 Description: "apimapper",
1697 Input: inputFile,
1698 Output: apiMapperFile,
1699 })
1700 outputFile = apiMapperFile
Colin Cross7e863852024-09-06 14:42:38 -07001701 localImplementationJars = android.Paths{apiMapperFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001702 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Yihan Dong8be09c22024-08-29 15:32:13 +08001703 }
1704
Jaewoong Jung26342642021-03-17 15:56:23 -07001705 // Check package restrictions if necessary.
1706 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001707 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001708 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001709
1710 // Create a rule to copy the output jar to another path and add a validate dependency that
1711 // will check that the jar only contains the permitted packages. The new location will become
1712 // the output file of this module.
1713 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001714 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001715 ctx.Build(pctx, android.BuildParams{
1716 Rule: android.Cp,
1717 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001718 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001719 // Make sure that any dependency on the output file will cause ninja to run the package check
1720 // rule.
1721 Validation: pkgckFile,
1722 })
Colin Cross7707b242024-07-26 12:02:36 -07001723 outputFile = packageCheckOutputFile
Colin Cross7e863852024-09-06 14:42:38 -07001724 localImplementationJars = android.Paths{packageCheckOutputFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001725 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001726
1727 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001728 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001729
1730 if ctx.Failed() {
1731 return
1732 }
1733 }
1734
1735 j.implementationJarFile = outputFile
1736 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001737 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1738 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1739 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1740 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1741 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1742 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1743 j.headerJarFile = headerJarFile
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001744 if len(localImplementationJars) == 1 && ctx.Config().UseTransitiveJarsInClasspath() {
1745 localHeaderJarFile := android.PathForModuleOut(ctx, "local-javac-header", jarName)
1746 convertImplementationJarToHeaderJar(ctx, localImplementationJars[0], localHeaderJarFile)
1747 localHeaderJars = append(localHeaderJars, localHeaderJarFile)
1748 } else {
1749 localHeaderJars = append(localHeaderJars, headerJarFile)
1750 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001751 }
1752
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001753 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1754 specs := j.jacocoModuleToZipCommand(ctx)
1755 if ctx.Failed() {
1756 return
1757 }
1758
Colin Crossb323c912024-09-24 15:21:00 -07001759 completeStaticLibsImplementationJarsToCombine := completeStaticLibsImplementationJars
1760
Colin Cross41698982024-11-13 11:31:31 -08001761 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Colin Crosse4f34882024-11-14 12:26:00 -08001762
1763 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
1764 compileDex := Bool(j.dexProperties.Compile_dex) || Bool(j.properties.Installable)
Colin Cross41698982024-11-13 11:31:31 -08001765
1766 if j.shouldInstrument(ctx) && (!ctx.Device() || compileDex) {
Colin Crossb323c912024-09-24 15:21:00 -07001767 instrumentedOutputFile := j.instrument(ctx, flags, outputFile, jarName, specs)
Colin Crossa14fb6a2024-10-23 16:57:06 -07001768 completeStaticLibsImplementationJarsToCombine = depset.New(depset.PREORDER, android.Paths{instrumentedOutputFile}, nil)
Colin Crossb323c912024-09-24 15:21:00 -07001769 outputFile = instrumentedOutputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001770 }
1771
1772 // merge implementation jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001773 var implementationAndResourcesJarsToCombine android.Paths
1774 if ctx.Config().UseTransitiveJarsInClasspath() {
1775 resourceJars := completeStaticLibsResourceJars.ToList()
1776 if len(resourceJars) > 0 {
Colin Crossb323c912024-09-24 15:21:00 -07001777 implementationAndResourcesJarsToCombine = append(resourceJars, completeStaticLibsImplementationJarsToCombine.ToList()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001778 implementationAndResourcesJarsToCombine = append(implementationAndResourcesJarsToCombine, extraDepCombinedJars...)
1779 }
1780 } else {
1781 if combinedResourceJar != nil {
1782 implementationAndResourcesJarsToCombine = android.Paths{combinedResourceJar, outputFile}
1783 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001784 }
1785
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001786 if len(implementationAndResourcesJarsToCombine) > 0 {
1787 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
1788 TransformJarsToJar(ctx, combinedJar, "for resources", implementationAndResourcesJarsToCombine, manifest,
1789 false, nil, nil)
1790 outputFile = combinedJar
1791 }
1792
1793 j.implementationAndResourcesJar = outputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001794
Colin Cross41698982024-11-13 11:31:31 -08001795 if ctx.Device() && compileDex {
Jaewoong Jung26342642021-03-17 15:56:23 -07001796 if j.hasCode(ctx) {
1797 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001798 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001799 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1800 }
1801 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001802 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001803 params := &compileDexParams{
1804 flags: flags,
1805 sdkVersion: j.SdkVersion(ctx),
1806 minSdkVersion: j.MinSdkVersion(ctx),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001807 classesJar: outputFile,
Spandan Dasc404cc72023-02-23 18:05:05 +00001808 jarName: jarName,
1809 }
Cole Fausteb032462024-09-19 11:12:54 -07001810 if j.GetProfileGuided(ctx) && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting(ctx) {
Spandan Das15a67112024-05-30 00:07:40 +00001811 ctx.PropertyErrorf("enable_profile_rewriting",
1812 "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.",
1813 )
1814 }
Cole Fausteb032462024-09-19 11:12:54 -07001815 if j.EnableProfileRewriting(ctx) {
1816 profile := j.GetProfile(ctx)
1817 if profile == "" || !j.GetProfileGuided(ctx) {
Spandan Das3dbda182024-05-20 22:23:10 +00001818 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1819 }
1820 params.artProfileInput = &profile
1821 }
1822 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001823 if ctx.Failed() {
1824 return
1825 }
1826
Spandan Das3dbda182024-05-20 22:23:10 +00001827 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1828 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001829 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001830 }
1831
Jaewoong Jung26342642021-03-17 15:56:23 -07001832 // merge dex jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001833 var dexAndResourceJarsToCombine android.Paths
1834 if ctx.Config().UseTransitiveJarsInClasspath() {
1835 resourceJars := completeStaticLibsResourceJars.ToList()
1836 if len(resourceJars) > 0 {
1837 dexAndResourceJarsToCombine = append(android.Paths{dexOutputFile}, resourceJars...)
1838 }
1839 } else {
1840 if combinedResourceJar != nil {
1841 dexAndResourceJarsToCombine = android.Paths{dexOutputFile, combinedResourceJar}
1842 }
1843 }
1844 if len(dexAndResourceJarsToCombine) > 0 {
Colin Cross7707b242024-07-26 12:02:36 -07001845 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001846 TransformJarsToJar(ctx, combinedJar, "for dex resources", dexAndResourceJarsToCombine, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001847 false, nil, nil)
1848 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001849 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001850 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001851 dexOutputFile = combinedAlignedJar
1852 } else {
1853 dexOutputFile = combinedJar
1854 }
1855 }
1856
Paul Duffin4de94502021-05-16 05:21:16 +01001857 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001858
1859 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001860
1861 // Encode hidden API flags in dex file, if needed.
1862 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1863
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001864 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001865
1866 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001867 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1868 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1869 libName = strings.TrimSuffix(libName, ".impl")
1870 }
1871 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001872
1873 outputFile = dexOutputFile
Colin Crossa6182ab2024-08-21 10:47:44 -07001874
1875 ctx.CheckbuildFile(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001876 } else {
1877 // There is no code to compile into a dex jar, make sure the resources are propagated
1878 // to the APK if this is an app.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001879 j.dexJarFile = makeDexJarPathFromPath(combinedResourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001880 }
1881
1882 if ctx.Failed() {
1883 return
1884 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001885 }
1886
1887 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001888 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001889 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001890 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001891 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001892 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001893 }
1894 }
1895
1896 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001897 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1898 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001899 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1900 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001901 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001902 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001903 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001904 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001905 j.linter.javaLanguageLevel = flags.javaVersion.String()
1906 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001907 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001908 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1909 j.linter.buildModuleReportZip = true
1910 }
1911 j.linter.lint(ctx)
1912 }
1913
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001914 j.collectTransitiveSrcFiles(ctx, srcFiles)
1915
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001916 if ctx.Config().UseTransitiveJarsInClasspath() {
1917 if len(localImplementationJars) > 0 || len(localResourceJars) > 0 || len(localHeaderJars) > 0 {
1918 ctx.CheckbuildFile(localImplementationJars...)
1919 ctx.CheckbuildFile(localResourceJars...)
1920 ctx.CheckbuildFile(localHeaderJars...)
1921 } else {
1922 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1923 ctx.UncheckedModule()
1924 }
1925 } else {
1926 ctx.CheckbuildFile(j.implementationJarFile)
1927 ctx.CheckbuildFile(j.headerJarFile)
1928 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001929
Colin Cross7727c7f2024-07-18 15:36:32 -07001930 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001931 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1932 RepackagedHeaderJars: android.PathsIfNonNil(repackagedHeaderJarFile),
1933
1934 LocalHeaderJars: localHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001935 TransitiveStaticLibsHeaderJars: depset.New(depset.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001936 TransitiveStaticLibsImplementationJars: completeStaticLibsImplementationJars,
1937 TransitiveStaticLibsResourceJars: completeStaticLibsResourceJars,
1938
Colin Cross9ffaf282024-08-12 13:50:09 -07001939 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1940 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001941 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1942 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001943 ResourceJars: android.PathsIfNonNil(combinedResourceJar),
Jihoon Kang705e63e2024-03-13 01:21:16 +00001944 AidlIncludeDirs: j.exportAidlIncludeDirs,
1945 SrcJarArgs: j.srcJarArgs,
1946 SrcJarDeps: j.srcJarDeps,
1947 TransitiveSrcFiles: j.transitiveSrcFiles,
1948 ExportedPlugins: j.exportedPluginJars,
1949 ExportedPluginClasses: j.exportedPluginClasses,
1950 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1951 JacocoReportClassesFile: j.jacocoReportClassesFile,
1952 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001953 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Yu Liu63bdf632024-12-03 19:54:05 +00001954 SdkVersion: j.SdkVersion(ctx),
Jaewoong Jung26342642021-03-17 15:56:23 -07001955 })
1956
1957 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1958 j.outputFile = outputFile.WithoutRel()
1959}
1960
Cole Faustb7493472024-08-28 11:55:52 -07001961func (j *Module) useCompose(ctx android.BaseModuleContext) bool {
1962 return android.InList("androidx.compose.runtime_runtime", j.staticLibs(ctx))
Colin Crossa1ff7c62021-09-17 14:11:52 -07001963}
1964
Colin Crossa14fb6a2024-10-23 16:57:06 -07001965func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []depset.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001966 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001967 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001968 depTag := ctx.OtherModuleDependencyTag(m)
1969
Colin Crossa14fb6a2024-10-23 16:57:06 -07001970 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1971 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
Sam Delmerico95d70942023-08-02 18:00:35 -04001972
Colin Crossa14fb6a2024-10-23 16:57:06 -07001973 if depTag == staticLibTag {
Sam Delmerico95d70942023-08-02 18:00:35 -04001974 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1975 }
1976 })
1977
Colin Crosscde55342024-03-27 14:11:51 -07001978 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1979}
1980
1981func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1982 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1983
Sam Delmerico95d70942023-08-02 18:00:35 -04001984 directUnconditionalExportedFlags := android.Paths{}
1985 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1986 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1987 if exportUnconditionally {
1988 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1989 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1990 directUnconditionalExportedFlags = proguardFlagsForThisModule
1991 }
1992
1993 return ProguardSpecInfo{
1994 Export_proguard_flags_files: exportUnconditionally,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001995 ProguardFlagsFiles: depset.New[android.Path](
1996 depset.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04001997 proguardFlagsForThisModule,
1998 transitiveProguardFlags,
1999 ),
Colin Crossa14fb6a2024-10-23 16:57:06 -07002000 UnconditionallyExportedProguardFlags: depset.New[android.Path](
2001 depset.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04002002 directUnconditionalExportedFlags,
2003 transitiveUnconditionalExportedFlags,
2004 ),
2005 }
2006
2007}
2008
Cole Faust75fffb12021-06-13 15:23:16 -07002009// Returns a copy of the supplied flags, but with all the errorprone-related
2010// fields copied to the regular build's fields.
2011func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
2012 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
2013
2014 if len(flags.errorProneExtraJavacFlags) > 0 {
2015 if len(flags.javacFlags) > 0 {
2016 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
2017 } else {
2018 flags.javacFlags = flags.errorProneExtraJavacFlags
2019 }
2020 }
2021 return flags
2022}
2023
Jaewoong Jung26342642021-03-17 15:56:23 -07002024func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07002025 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002026
2027 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00002028 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002029 if idx >= 0 {
2030 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00002031 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002032 jarName += strconv.Itoa(idx)
2033 }
2034
Colin Cross7707b242024-07-26 12:02:36 -07002035 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00002036 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07002037
Cole Faust9decf832024-06-11 11:45:53 -07002038 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002039 extractionFile := android.PathForModuleOut(ctx, kzipName)
2040 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
2041 j.kytheFiles = append(j.kytheFiles, extractionFile)
2042 }
2043
Vadim Spivak3c496f02023-06-08 06:14:59 +00002044 if len(flags.processorPath) > 0 {
2045 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
2046 }
2047
Jaewoong Jung26342642021-03-17 15:56:23 -07002048 return classes
2049}
2050
2051// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
2052// since some of these flags may be used internally.
2053func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
2054 for _, flag := range flags {
2055 flag = strings.TrimSpace(flag)
2056
2057 if !strings.HasPrefix(flag, "-") {
2058 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
2059 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
2060 ctx.PropertyErrorf("kotlincflags",
2061 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
2062 } else if inList(flag, config.KotlincIllegalFlags) {
2063 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
2064 } else if flag == "-include-runtime" {
2065 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
2066 } else {
2067 args := strings.Split(flag, " ")
2068 if args[0] == "-kotlin-home" {
2069 ctx.PropertyErrorf("kotlincflags",
2070 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
2071 }
2072 }
2073 }
2074}
2075
2076func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
2077 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002078 extraJars android.Paths) (localHeaderJars android.Paths, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002079
Jaewoong Jung26342642021-03-17 15:56:23 -07002080 if len(srcFiles) > 0 || len(srcJars) > 0 {
2081 // Compile java sources into turbine.jar.
2082 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
2083 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002084 localHeaderJars = append(localHeaderJars, turbineJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07002085 }
2086
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002087 localHeaderJars = append(localHeaderJars, extraJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002088
2089 // Combine any static header libraries into classes-header.jar. If there is only
2090 // one input jar this step will be skipped.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002091 var jars android.Paths
2092 if ctx.Config().UseTransitiveJarsInClasspath() {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002093 depSet := depset.New(depset.PREORDER, localHeaderJars, deps.transitiveStaticLibsHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002094 jars = depSet.ToList()
2095 } else {
2096 jars = append(slices.Clone(localHeaderJars), deps.staticHeaderJars...)
2097 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002098
2099 // we cannot skip the combine step for now if there is only one jar
2100 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07002101 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
2102 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07002103 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07002104
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002105 return localHeaderJars, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07002106}
2107
2108func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07002109 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002110
2111 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07002112 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07002113
2114 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
2115
2116 j.jacocoReportClassesFile = jacocoReportClassesFile
2117
2118 return instrumentedJar
2119}
2120
Colin Cross9ffaf282024-08-12 13:50:09 -07002121type providesTransitiveHeaderJarsForR8 struct {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002122 // set of header jars for all transitive libs deps
Colin Crossa14fb6a2024-10-23 16:57:06 -07002123 transitiveLibsHeaderJarsForR8 depset.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002124 // set of header jars for all transitive static libs deps
Colin Crossa14fb6a2024-10-23 16:57:06 -07002125 transitiveStaticLibsHeaderJarsForR8 depset.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002126}
2127
Colin Cross9ffaf282024-08-12 13:50:09 -07002128// collectTransitiveHeaderJarsForR8 visits direct dependencies and collects all transitive libs and static_libs
2129// header jars. The semantics of the collected jars are odd (it collects combined jars that contain the static
2130// libs, but also the static libs, and it collects transitive libs dependencies of static_libs), so these
2131// are only used to expand the --lib arguments to R8.
2132func (j *providesTransitiveHeaderJarsForR8) collectTransitiveHeaderJarsForR8(ctx android.ModuleContext) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002133 directLibs := android.Paths{}
2134 directStaticLibs := android.Paths{}
Colin Crossa14fb6a2024-10-23 16:57:06 -07002135 transitiveLibs := []depset.DepSet[android.Path]{}
2136 transitiveStaticLibs := []depset.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002137 ctx.VisitDirectDeps(func(module android.Module) {
2138 // don't add deps of the prebuilt version of the same library
2139 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
2140 return
2141 }
2142
Colin Cross7727c7f2024-07-18 15:36:32 -07002143 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2144 tag := ctx.OtherModuleDependencyTag(module)
2145 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2146 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2147 directLibs = append(directLibs, dep.HeaderJars...)
2148 } else if tag == staticLibTag {
2149 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2150 } else {
2151 // Don't propagate transitive libs for other kinds of dependencies.
2152 return
2153 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002154
Colin Crossa14fb6a2024-10-23 16:57:06 -07002155 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJarsForR8)
2156 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJarsForR8)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002157 }
2158 })
Colin Crossa14fb6a2024-10-23 16:57:06 -07002159 j.transitiveLibsHeaderJarsForR8 = depset.New(depset.POSTORDER, directLibs, transitiveLibs)
2160 j.transitiveStaticLibsHeaderJarsForR8 = depset.New(depset.POSTORDER, directStaticLibs, transitiveStaticLibs)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002161}
2162
Jaewoong Jung26342642021-03-17 15:56:23 -07002163func (j *Module) HeaderJars() android.Paths {
2164 if j.headerJarFile == nil {
2165 return nil
2166 }
2167 return android.Paths{j.headerJarFile}
2168}
2169
2170func (j *Module) ImplementationJars() android.Paths {
2171 if j.implementationJarFile == nil {
2172 return nil
2173 }
2174 return android.Paths{j.implementationJarFile}
2175}
2176
Spandan Das59a4a2b2024-01-09 21:35:56 +00002177func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002178 return j.dexJarFile
2179}
2180
2181func (j *Module) DexJarInstallPath() android.Path {
2182 return j.installFile
2183}
2184
2185func (j *Module) ImplementationAndResourcesJars() android.Paths {
2186 if j.implementationAndResourcesJar == nil {
2187 return nil
2188 }
2189 return android.Paths{j.implementationAndResourcesJar}
2190}
2191
2192func (j *Module) AidlIncludeDirs() android.Paths {
2193 // exportAidlIncludeDirs is type android.Paths already
2194 return j.exportAidlIncludeDirs
2195}
2196
2197func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2198 return j.classLoaderContexts
2199}
2200
2201// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002202func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002203 if j.expandJarjarRules != nil {
2204 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Das096b8d62024-10-08 22:41:26 +00002205 // Add the header jar so that the rdeps can be resolved to the repackaged classes.
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002206 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
Jaewoong Jung26342642021-03-17 15:56:23 -07002207 }
Spandan Das096b8d62024-10-08 22:41:26 +00002208 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2209 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2210 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002211 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2212 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Cole Faustb7493472024-08-28 11:55:52 -07002213 dpInfo.Static_libs = append(dpInfo.Static_libs, j.staticLibs(ctx)...)
Yikef6282022022-04-13 20:41:01 +08002214 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002215}
2216
2217func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002218 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002219}
2220
2221func (j *Module) hasCode(ctx android.ModuleContext) bool {
2222 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2223 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2224}
2225
2226// Implements android.ApexModule
Colin Crossf7bbd2f2024-12-05 13:57:10 -08002227func (j *Module) OutgoingDepIsInSameApex(tag blueprint.DependencyTag) bool {
2228 return j.depIsInSameApex(tag)
Jaewoong Jung26342642021-03-17 15:56:23 -07002229}
2230
2231// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002232func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002233 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002234 minSdkVersion := j.MinSdkVersion(ctx)
2235 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002236 return fmt.Errorf("min_sdk_version is not specified")
2237 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002238 // If the module is compiling against core (via sdk_version), skip comparison check.
2239 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002240 return nil
2241 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002242 if minSdkVersion.GreaterThan(sdkVersion) {
2243 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002244 }
2245 return nil
2246}
2247
2248func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002249 if j.stem == "" {
2250 panic("Stem() called before stem property was set")
2251 }
2252 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002253}
2254
Jaewoong Jung26342642021-03-17 15:56:23 -07002255func (j *Module) JacocoReportClassesFile() android.Path {
2256 return j.jacocoReportClassesFile
2257}
2258
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002259func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002260 var fromDeps []depset.DepSet[android.Path]
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002261 ctx.VisitDirectDeps(func(module android.Module) {
2262 tag := ctx.OtherModuleDependencyTag(module)
2263 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002264 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002265 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002266 }
2267 }
2268 })
2269
Colin Crossa14fb6a2024-10-23 16:57:06 -07002270 j.transitiveSrcFiles = depset.New(depset.POSTORDER, mine, fromDeps)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002271}
2272
Jaewoong Jung26342642021-03-17 15:56:23 -07002273func (j *Module) IsInstallable() bool {
2274 return Bool(j.properties.Installable)
2275}
2276
2277type sdkLinkType int
2278
2279const (
2280 // TODO(jiyong) rename these for better readability. Make the allowed
2281 // and disallowed link types explicit
2282 // order is important here. See rank()
2283 javaCore sdkLinkType = iota
2284 javaSdk
2285 javaSystem
2286 javaModule
2287 javaSystemServer
2288 javaPlatform
2289)
2290
2291func (lt sdkLinkType) String() string {
2292 switch lt {
2293 case javaCore:
2294 return "core Java API"
2295 case javaSdk:
2296 return "Android API"
2297 case javaSystem:
2298 return "system API"
2299 case javaModule:
2300 return "module API"
2301 case javaSystemServer:
2302 return "system server API"
2303 case javaPlatform:
2304 return "private API"
2305 default:
2306 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2307 }
2308}
2309
2310// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2311// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2312// can't statically depend on modules that use Platform API.
2313func (lt sdkLinkType) rank() int {
2314 return int(lt)
2315}
2316
2317type moduleWithSdkDep interface {
2318 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002319 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002320}
2321
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002322func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2323 switch k {
2324 case android.SdkCore:
2325 return javaCore
2326 case android.SdkSystem:
2327 return javaSystem
2328 case android.SdkPublic:
2329 return javaSdk
2330 case android.SdkModule:
2331 return javaModule
2332 case android.SdkSystemServer:
2333 return javaSystemServer
2334 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2335 return javaPlatform
2336 default:
2337 return javaSdk
2338 }
2339}
2340
Jiyong Park92315372021-04-02 08:45:46 +09002341func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002342 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002343 case android.SdkCore.DefaultJavaLibraryName(),
2344 "legacy.core.platform.api.stubs",
2345 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002346 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002347 "core-lambda-stubs",
Colin Crosse4f34882024-11-14 12:26:00 -08002348 "core-generated-annotation-stubs",
2349 // jacocoagent only uses core APIs, but has to specify a non-core sdk_version so it can use
2350 // a prebuilt SDK to avoid circular dependencies when it statically included in the bootclasspath.
2351 "jacocoagent":
Jaewoong Jung26342642021-03-17 15:56:23 -07002352 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002353 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002354 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002355 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002356 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002357 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002358 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002359 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002360 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002361 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002362 return javaSystem, true
2363 }
2364
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002365 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002366 return linkType, true
2367 }
2368
Jiyong Park92315372021-04-02 08:45:46 +09002369 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002370 if !ver.Valid() {
2371 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002372 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002373
2374 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002375}
2376
2377// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2378// this module's. See the comment on rank() for details and an example.
2379func (j *Module) checkSdkLinkType(
2380 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2381 if ctx.Host() {
2382 return
2383 }
2384
Jiyong Park92315372021-04-02 08:45:46 +09002385 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002386 if stubs {
2387 return
2388 }
Jiyong Park92315372021-04-02 08:45:46 +09002389 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002390
2391 if myLinkType.rank() < depLinkType.rank() {
2392 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2393 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2394 "property of the source or target module so that target module is built "+
2395 "with the same or smaller API set when compared to the source.",
2396 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2397 }
2398}
2399
2400func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2401 var deps deps
2402
Jiyong Park92315372021-04-02 08:45:46 +09002403 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002404
Colin Cross9ffaf282024-08-12 13:50:09 -07002405 j.collectTransitiveHeaderJarsForR8(ctx)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002406
Colin Crossa14fb6a2024-10-23 16:57:06 -07002407 var transitiveBootClasspathHeaderJars []depset.DepSet[android.Path]
2408 var transitiveClasspathHeaderJars []depset.DepSet[android.Path]
2409 var transitiveJava9ClasspathHeaderJars []depset.DepSet[android.Path]
2410 var transitiveStaticJarsHeaderLibs []depset.DepSet[android.Path]
2411 var transitiveStaticJarsImplementationLibs []depset.DepSet[android.Path]
2412 var transitiveStaticJarsResourceLibs []depset.DepSet[android.Path]
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002413
Jaewoong Jung26342642021-03-17 15:56:23 -07002414 ctx.VisitDirectDeps(func(module android.Module) {
2415 otherName := ctx.OtherModuleName(module)
2416 tag := ctx.OtherModuleDependencyTag(module)
2417
2418 if IsJniDepTag(tag) {
2419 // Handled by AndroidApp.collectAppDeps
2420 return
2421 }
2422 if tag == certificateTag {
2423 // Handled by AndroidApp.collectAppDeps
2424 return
2425 }
2426
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002427 if sdkInfo, ok := android.OtherModuleProvider(ctx, module, SdkLibraryInfoProvider); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -07002428 switch tag {
Jihoon Kang28c96572024-09-11 23:44:44 +00002429 case sdkLibTag, libTag, staticLibTag:
Jihoon Kang28c96572024-09-11 23:44:44 +00002430 generatingLibsString := android.PrettyConcat(
2431 getGeneratingLibs(ctx, j.SdkVersion(ctx), module.Name(), sdkInfo), true, "or")
2432 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 -07002433 }
Colin Cross313aa542023-12-13 13:47:44 -08002434 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2435 if sdkLinkType != javaPlatform {
2436 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2437 // dep is a sysprop implementation library, but this module is not linking against
2438 // the platform, so it gets the sysprop public stubs library instead. Replace
2439 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2440 dep = syspropDep.JavaInfo
2441 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002442 }
2443 switch tag {
2444 case bootClasspathTag:
2445 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002446 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002447 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002448 if _, ok := module.(*Plugin); ok {
2449 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2450 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002451 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002452 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002453 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2454 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2455 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2456 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002457 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2458 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2459 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002460
Colin Crossa14fb6a2024-10-23 16:57:06 -07002461 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002462 case java9LibTag:
2463 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002464 transitiveJava9ClasspathHeaderJars = append(transitiveJava9ClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002465 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002466 if _, ok := module.(*Plugin); ok {
2467 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2468 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002469 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2470 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2471 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2472 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2473 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2474 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2475 // Turbine doesn't run annotation processors, so any module that uses an
2476 // annotation processor that generates API is incompatible with the turbine
2477 // optimization.
2478 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002479 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002480
Colin Crossa14fb6a2024-10-23 16:57:06 -07002481 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2482 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, dep.TransitiveStaticLibsHeaderJars)
2483 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, dep.TransitiveStaticLibsImplementationJars)
2484 transitiveStaticJarsResourceLibs = append(transitiveStaticJarsResourceLibs, dep.TransitiveStaticLibsResourceJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002485 case pluginTag:
2486 if plugin, ok := module.(*Plugin); ok {
2487 if plugin.pluginProperties.Processor_class != nil {
2488 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2489 } else {
2490 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2491 }
2492 // Turbine doesn't run annotation processors, so any module that uses an
2493 // annotation processor that generates API is incompatible with the turbine
2494 // optimization.
2495 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2496 } else {
2497 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2498 }
2499 case errorpronePluginTag:
2500 if _, ok := module.(*Plugin); ok {
2501 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2502 } else {
2503 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2504 }
2505 case exportedPluginTag:
2506 if plugin, ok := module.(*Plugin); ok {
2507 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2508 if plugin.pluginProperties.Processor_class != nil {
2509 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2510 }
2511 // Turbine doesn't run annotation processors, so any module that uses an
2512 // annotation processor that generates API is incompatible with the turbine
2513 // optimization.
2514 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2515 } else {
2516 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2517 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002518 case kotlinPluginTag:
Luca Stefani50098f72024-10-12 17:55:31 +02002519 if _, ok := module.(*KotlinPlugin); ok {
2520 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
2521 } else {
2522 ctx.PropertyErrorf("kotlin_plugins", "%q is not a kotlin_plugin module", otherName)
2523 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002524 case syspropPublicStubDepTag:
2525 // This is a sysprop implementation library, forward the JavaInfoProvider from
2526 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002527 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002528 JavaInfo: dep,
2529 })
2530 }
2531 } else if dep, ok := module.(android.SourceFileProducer); ok {
2532 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002533 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002534 checkProducesJars(ctx, dep)
2535 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002536 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002537 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07002538 depset.New(depset.PREORDER, dep.Srcs(), nil))
Jaewoong Jung26342642021-03-17 15:56:23 -07002539 case staticLibTag:
2540 checkProducesJars(ctx, dep)
2541 deps.classpath = append(deps.classpath, dep.Srcs()...)
2542 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2543 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002544
Colin Crossa14fb6a2024-10-23 16:57:06 -07002545 depHeaderJars := depset.New(depset.PREORDER, dep.Srcs(), nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002546 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJars)
2547 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, depHeaderJars)
2548 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, depHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002549 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002550 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002551 switch tag {
2552 case staticLibTag:
2553 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2554 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002555 } else {
2556 switch tag {
2557 case bootClasspathTag:
2558 // If a system modules dependency has been added to the bootclasspath
2559 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002560 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002561 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002562 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars,
2563 sm.TransitiveStaticLibsHeaderJars)
Colin Crossb61c2262024-08-08 14:04:42 -07002564 } else {
2565 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2566 ctx.OtherModuleName(module))
2567 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002568
2569 case systemModulesTag:
2570 if deps.systemModules != nil {
2571 panic("Found two system module dependencies")
2572 }
Colin Crossb61c2262024-08-08 14:04:42 -07002573 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2574 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2575 } else {
2576 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2577 ctx.OtherModuleName(module))
2578 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002579
2580 case instrumentationForTag:
2581 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 -07002582 }
2583 }
2584
Spandan Das8aac9932024-07-18 23:14:13 +00002585 if android.InList(tag, compileDependencyTags) {
2586 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2587 j.compileDepNames = append(j.compileDepNames, otherName)
2588 }
2589
Jaewoong Jung26342642021-03-17 15:56:23 -07002590 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002591 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002592 })
2593
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002594 deps.transitiveStaticLibsHeaderJars = transitiveStaticJarsHeaderLibs
2595 deps.transitiveStaticLibsImplementationJars = transitiveStaticJarsImplementationLibs
2596 deps.transitiveStaticLibsResourceJars = transitiveStaticJarsResourceLibs
2597
2598 if ctx.Config().UseTransitiveJarsInClasspath() {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002599 depSet := depset.New(depset.PREORDER, nil, transitiveClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002600 deps.classpath = depSet.ToList()
Colin Crossa14fb6a2024-10-23 16:57:06 -07002601 depSet = depset.New(depset.PREORDER, nil, transitiveBootClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002602 deps.bootClasspath = depSet.ToList()
Colin Crossa14fb6a2024-10-23 16:57:06 -07002603 depSet = depset.New(depset.PREORDER, nil, transitiveJava9ClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002604 deps.java9Classpath = depSet.ToList()
2605 }
2606
2607 if ctx.Device() {
2608 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
2609 if sdkDep.invalidVersion {
2610 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2611 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2612 } else if sdkDep.useFiles {
2613 // sdkDep.jar is actually equivalent to turbine header.jar.
2614 deps.classpath = append(slices.Clone(classpath(sdkDep.jars)), deps.classpath...)
2615 deps.dexClasspath = append(slices.Clone(classpath(sdkDep.jars)), deps.dexClasspath...)
2616 deps.aidlPreprocess = sdkDep.aidl
2617 // Add the sdk module dependency to `compileDepNames`.
2618 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2619 // TODO (b/358608607): Move this to decodeSdkDep
2620 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2621 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
2622 } else {
2623 deps.aidlPreprocess = sdkDep.aidl
2624 }
2625 }
2626
Jaewoong Jung26342642021-03-17 15:56:23 -07002627 return deps
2628}
2629
Joe Onorato349ae8d2024-02-05 22:46:00 +00002630// Provider for jarjar renaming rules.
2631//
2632// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2633// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2634// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2635// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2636// be renamed from that module.
2637// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002638type DependencyUse int
2639
2640const (
2641 RenameUseInvalid DependencyUse = iota
2642 RenameUseInclude
2643 RenameUseExclude
2644)
2645
Joe Onorato349ae8d2024-02-05 22:46:00 +00002646type JarJarProviderData struct {
2647 // Mapping of class names: original --> renamed. If the value is "", the class will be
2648 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2649 // attribute). Rdeps of that module will inherit the renaming.
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002650 Rename map[string]string
Joe Onorato349ae8d2024-02-05 22:46:00 +00002651}
2652
2653func (this JarJarProviderData) GetDebugString() string {
2654 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002655 for _, k := range android.SortedKeys(this.Rename) {
2656 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002657 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2658 result += k + "--&gt;" + v + ";"
2659 }
2660 }
2661 return result
2662}
2663
2664var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2665
2666var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2667
2668func init() {
2669 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
Yu Liu26a716d2024-08-30 23:40:32 +00002670
2671 gob.Register(BaseJarJarProviderData{})
Joe Onorato349ae8d2024-02-05 22:46:00 +00002672}
2673
2674// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2675// whether they are java modules or not.
2676type BaseJarJarProviderData struct {
2677 JarJarProviderData JarJarProviderData
2678}
2679
2680func (this BaseJarJarProviderData) GetDebugString() string {
2681 return this.JarJarProviderData.GetDebugString()
2682}
2683
2684var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2685
2686// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2687// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2688// either JarJarProvider or BaseJarJarProvider.
2689func mergeJarJarPrefixes(ctx android.ModuleContext) {
2690 mod := ctx.Module()
2691 // Explicitly avoid propagating into some module types.
2692 switch reflect.TypeOf(mod).String() {
2693 case "*java.Droidstubs":
2694 return
2695 }
2696 jarJarData := collectDirectDepsProviders(ctx)
2697 if jarJarData != nil {
2698 providerData := BaseJarJarProviderData{
2699 JarJarProviderData: *jarJarData,
2700 }
2701 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2702 }
2703
2704}
2705
2706// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2707func (module *Module) addJarJarRenameRule(original string, renamed string) {
2708 if module.jarjarRenameRules == nil {
2709 module.jarjarRenameRules = make(map[string]string)
2710 }
2711 module.jarjarRenameRules[original] = renamed
2712}
2713
2714func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2715 // Gather repackage information from deps
2716 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002717
2718 module := ctx.Module()
2719 moduleName := module.Name()
2720
Colin Cross648daea2024-09-12 14:35:29 -07002721 ctx.VisitDirectDeps(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002722 tag := ctx.OtherModuleDependencyTag(m)
2723 // This logic mirrors that in (*Module).collectDeps above. There are several places
2724 // where we explicitly return RenameUseExclude, even though it is the default, to
2725 // indicate that it has been verified to be the case.
2726 //
2727 // Note well: there are probably cases that are getting to the unconditional return
2728 // and are therefore wrong.
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002729 shouldIncludeRenames := func() DependencyUse {
LaMont Jones63683e42024-02-08 14:30:45 -08002730 if moduleName == m.Name() {
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002731 return RenameUseInclude // If we have the same module name, include the renames.
LaMont Jones63683e42024-02-08 14:30:45 -08002732 }
2733 if sc, ok := module.(android.SdkContext); ok {
2734 if ctx.Device() {
2735 sdkDep := decodeSdkDep(ctx, sc)
2736 if !sdkDep.invalidVersion && sdkDep.useFiles {
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002737 return RenameUseExclude
Joe Onorato349ae8d2024-02-05 22:46:00 +00002738 }
2739 }
LaMont Jones63683e42024-02-08 14:30:45 -08002740 }
2741 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002742 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002743 }
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002744 if _, ok := android.OtherModuleProvider(ctx, m, SdkLibraryInfoProvider); ok {
LaMont Jones63683e42024-02-08 14:30:45 -08002745 switch tag {
2746 case sdkLibTag, libTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002747 return RenameUseExclude // matches collectDeps()
LaMont Jones63683e42024-02-08 14:30:45 -08002748 }
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002749 return RenameUseInvalid // dep is not used in collectDeps()
LaMont Jones63683e42024-02-08 14:30:45 -08002750 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2751 switch ji.StubsLinkType {
2752 case Stubs:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002753 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002754 case Implementation:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002755 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002756 default:
LaMont Jones09721862024-06-11 10:30:50 -07002757 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002758 // Fall through to the heuristic logic.
2759 }
2760 switch reflect.TypeOf(m).String() {
2761 case "*java.GeneratedJavaLibraryModule":
2762 // Probably a java_aconfig_library module.
2763 // TODO: make this check better.
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002764 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002765 }
2766 switch tag {
2767 case bootClasspathTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002768 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002769 case sdkLibTag, libTag, instrumentationForTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002770 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002771 case java9LibTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002772 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002773 case staticLibTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002774 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002775 case pluginTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002776 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002777 case errorpronePluginTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002778 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002779 case exportedPluginTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002780 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002781 case kotlinPluginTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002782 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002783 default:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002784 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002785 }
2786 } else if _, ok := m.(android.SourceFileProducer); ok {
2787 switch tag {
2788 case sdkLibTag, libTag, staticLibTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002789 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002790 default:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002791 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002792 }
Yu Liu67a28422024-03-05 00:36:31 +00002793 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002794 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002795 } else {
2796 switch tag {
2797 case bootClasspathTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002798 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002799 case systemModulesTag:
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002800 return RenameUseInclude
LaMont Jones63683e42024-02-08 14:30:45 -08002801 }
2802 }
2803 // If we got here, choose the safer option, which may lead to a build failure, rather
2804 // than runtime failures on the device.
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002805 return RenameUseExclude
LaMont Jones63683e42024-02-08 14:30:45 -08002806 }
2807
2808 if result == nil {
2809 result = &JarJarProviderData{
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002810 Rename: make(map[string]string),
LaMont Jones63683e42024-02-08 14:30:45 -08002811 }
2812 }
Jihoon Kangbbcfd512025-01-03 00:13:50 +00002813 how := shouldIncludeRenames()
LaMont Jones63683e42024-02-08 14:30:45 -08002814 if how != RenameUseInclude {
2815 // Nothing to merge.
2816 return
2817 }
2818
2819 merge := func(theirs *JarJarProviderData) {
2820 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002821 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2822 result.Rename[orig] = renamed
2823 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2824 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2825 result.Rename[orig] = renamed
2826 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2827 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2828 continue
2829 }
2830 }
2831 }
2832 }
2833 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2834 merge(&theirs)
2835 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2836 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2837 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2838 // to java.Module.
2839 merge(&theirs.JarJarProviderData)
2840 }
2841 })
2842 return
2843}
2844
2845func (this Module) GetDebugString() string {
2846 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2847}
2848
2849// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2850// us, and if it's been set, apply the jarjar_prefix property to rename them.
2851func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2852 // Gather repackage information from deps
2853 result := collectDirectDepsProviders(ctx)
2854
Joe Onoratoa5d17172024-07-20 17:39:56 -07002855 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002856 if result == nil {
2857 result = &JarJarProviderData{
2858 Rename: make(map[string]string),
2859 }
2860 }
2861 if renamed != "" {
2862 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2863 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002864 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002865 }
2866 }
2867 (*result).Rename[orig] = renamed
2868 }
2869
Joe Onoratoa5d17172024-07-20 17:39:56 -07002870 // Update that with entries we've stored for ourself
2871 for orig, renamed := range module.jarjarRenameRules {
2872 add(orig, renamed)
2873 }
2874
2875 // Update that with entries given in the jarjar_rename property.
2876 for _, orig := range module.properties.Jarjar_rename {
2877 add(orig, "")
2878 }
2879
Joe Onorato349ae8d2024-02-05 22:46:00 +00002880 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2881 if result == nil {
2882 return nil
2883 }
2884
2885 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2886 // that have not yet been renamed.
2887 prefix := proptools.String(module.properties.Jarjar_prefix)
2888 if prefix != "" {
2889 if prefix[0] == '.' {
2890 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2891 return nil
2892 }
2893 if prefix[len(prefix)-1] == '.' {
2894 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2895 return nil
2896 }
2897
2898 var updated map[string]string
2899 for orig, renamed := range (*result).Rename {
2900 if renamed == "" {
2901 if updated == nil {
2902 updated = make(map[string]string)
2903 }
2904 updated[orig] = prefix + "." + orig
2905 }
2906 }
2907 for orig, renamed := range updated {
2908 (*result).Rename[orig] = renamed
2909 }
2910 }
2911
2912 return result
2913}
2914
2915// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2916// to "" won't be in this list because they shouldn't be renamed yet.
2917func getJarJarRuleText(provider *JarJarProviderData) string {
2918 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002919 for _, orig := range android.SortedKeys(provider.Rename) {
2920 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002921 if renamed != "" {
2922 result += "rule " + orig + " " + renamed + "\n"
2923 }
2924 }
2925 return result
2926}
2927
Zi Wangddb2ee52024-04-02 16:44:02 +00002928// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002929func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Zi Wangddb2ee52024-04-02 16:44:02 +00002930 if j.repackageJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002931 return infile, false
Zi Wangddb2ee52024-04-02 16:44:02 +00002932 }
Colin Crossedec77c2024-07-26 15:25:40 -07002933 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002934 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002935 return repackagedJarjarFile, true
Zi Wangddb2ee52024-04-02 16:44:02 +00002936}
2937
Makoto Onuki31db53a2024-12-06 16:40:47 -08002938func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string, useShards bool) (android.Path, bool) {
Colin Crossedec77c2024-07-26 15:25:40 -07002939 if j.expandJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002940 return infile, false
Colin Crossedec77c2024-07-26 15:25:40 -07002941 }
2942 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
Makoto Onuki31db53a2024-12-06 16:40:47 -08002943
2944 totalShards := 1
2945 if useShards {
2946 totalShardsStr := j.properties.Jarjar_shards.GetOrDefault(ctx, "1")
2947 ts, err := strconv.Atoi(totalShardsStr)
2948 if err != nil {
2949 ctx.PropertyErrorf("jarjar_shards", "jarjar_shards must be an integer represented as a string")
2950 return infile, false
2951 }
2952 totalShards = ts
2953 }
2954 TransformJarJarWithShards(ctx, jarjarFile, infile, j.expandJarjarRules, totalShards)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002955 return jarjarFile, true
Colin Crossedec77c2024-07-26 15:25:40 -07002956
2957}
2958
Jaewoong Jung26342642021-03-17 15:56:23 -07002959func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2960 deps.processorPath = append(deps.processorPath, pluginJars...)
2961 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2962}
2963
2964// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2965// this interface.
2966type ProvidesUsesLib interface {
2967 ProvidesUsesLib() *string
2968}
2969
2970func (j *Module) ProvidesUsesLib() *string {
2971 return j.usesLibraryProperties.Provides_uses_lib
2972}
satayev1c564cc2021-05-25 19:50:30 +01002973
2974type ModuleWithStem interface {
2975 Stem() string
2976}
2977
2978var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002979
2980type ModuleWithUsesLibrary interface {
2981 UsesLibrary() *usesLibrary
2982}
2983
2984func (j *Module) UsesLibrary() *usesLibrary {
2985 return &j.usesLibrary
2986}
2987
2988var _ ModuleWithUsesLibrary = (*Module)(nil)