blob: 3bf2e23d8b97720aba8aa4538782a8f931238e63 [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
63 // list of directories containing Java resources
64 Java_resource_dirs []string `android:"arch_variant"`
65
66 // list of directories that should be excluded from java_resource_dirs
67 Exclude_java_resource_dirs []string `android:"arch_variant"`
68
69 // list of files to use as Java resources
Cole Faust7fd5b2e2024-10-29 11:22:20 -070070 Java_resources proptools.Configurable[[]string] `android:"path,arch_variant"`
Jaewoong Jung26342642021-03-17 15:56:23 -070071
72 // list of files that should be excluded from java_resources and java_resource_dirs
73 Exclude_java_resources []string `android:"path,arch_variant"`
74
Cole Faust65cb40a2024-10-21 15:41:42 -070075 // Same as java_resources, but modules added here will use the device variant. Can be useful
76 // for making a host test that tests the contents of a device built app.
Cole Faust7fd5b2e2024-10-29 11:22:20 -070077 Device_common_java_resources proptools.Configurable[[]string] `android:"path_device_common"`
Cole Faust65cb40a2024-10-21 15:41:42 -070078
79 // Same as java_resources, but modules added here will use the device's os variant and the
80 // device's first architecture variant. Can be useful for making a host test that tests the
81 // contents of a native device built app.
Cole Faust7fd5b2e2024-10-29 11:22:20 -070082 Device_first_java_resources proptools.Configurable[[]string] `android:"path_device_first"`
Cole Faust65cb40a2024-10-21 15:41:42 -070083
Jaewoong Jung26342642021-03-17 15:56:23 -070084 // list of module-specific flags that will be used for javac compiles
85 Javacflags []string `android:"arch_variant"`
86
87 // list of module-specific flags that will be used for kotlinc compiles
88 Kotlincflags []string `android:"arch_variant"`
89
90 // list of java libraries that will be in the classpath
91 Libs []string `android:"arch_variant"`
92
93 // list of java libraries that will be compiled into the resulting jar
Cole Faustb7493472024-08-28 11:55:52 -070094 Static_libs proptools.Configurable[[]string] `android:"arch_variant"`
Jaewoong Jung26342642021-03-17 15:56:23 -070095
96 // manifest file to be included in resulting jar
97 Manifest *string `android:"path"`
98
99 // if not blank, run jarjar using the specified rules file
100 Jarjar_rules *string `android:"path,arch_variant"`
101
Joe Onoratoa5d17172024-07-20 17:39:56 -0700102 // java class names to rename with jarjar when a reverse dependency has a jarjar_prefix
103 // property.
104 Jarjar_rename []string
105
Joe Onorato349ae8d2024-02-05 22:46:00 +0000106 // if not blank, used as prefix to generate repackage rule
107 Jarjar_prefix *string
108
Jaewoong Jung26342642021-03-17 15:56:23 -0700109 // If not blank, set the java version passed to javac as -source and -target
110 Java_version *string
111
112 // If set to true, allow this module to be dexed and installed on devices. Has no
113 // effect on host modules, which are always considered installable.
114 Installable *bool
115
116 // If set to true, include sources used to compile the module in to the final jar
117 Include_srcs *bool
118
119 // If not empty, classes are restricted to the specified packages and their sub-packages.
120 // This restriction is checked after applying jarjar rules and including static libs.
121 Permitted_packages []string
122
123 // List of modules to use as annotation processors
124 Plugins []string
125
Luca Stefani50098f72024-10-12 17:55:31 +0200126 // List of modules to use as kotlin plugin
127 Kotlin_plugins []string
128
Jaewoong Jung26342642021-03-17 15:56:23 -0700129 // List of modules to export to libraries that directly depend on this library as annotation
130 // processors. Note that if the plugins set generates_api: true this will disable the turbine
131 // optimization on modules that depend on this module, which will reduce parallelism and cause
132 // more recompilation.
133 Exported_plugins []string
134
135 // The number of Java source entries each Javac instance can process
136 Javac_shard_size *int64
137
138 // Add host jdk tools.jar to bootclasspath
139 Use_tools_jar *bool
140
141 Openjdk9 struct {
142 // List of source files that should only be used when passing -source 1.9 or higher
143 Srcs []string `android:"path"`
144
145 // List of javac flags that should only be used when passing -source 1.9 or higher
146 Javacflags []string
147 }
148
149 // When compiling language level 9+ .java code in packages that are part of
150 // a system module, patch_module names the module that your sources and
151 // dependencies should be patched into. The Android runtime currently
152 // doesn't implement the JEP 261 module system so this option is only
153 // supported at compile time. It should only be needed to compile tests in
154 // packages that exist in libcore and which are inconvenient to move
155 // elsewhere.
Liz Kammer0a470a32023-10-05 17:02:00 -0400156 Patch_module *string
Jaewoong Jung26342642021-03-17 15:56:23 -0700157
158 Jacoco struct {
159 // List of classes to include for instrumentation with jacoco to collect coverage
160 // information at runtime when building with coverage enabled. If unset defaults to all
161 // classes.
162 // Supports '*' as the last character of an entry in the list as a wildcard match.
163 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
164 // it matches classes in the package that have the class name as a prefix.
165 Include_filter []string
166
167 // List of classes to exclude from instrumentation with jacoco to collect coverage
168 // information at runtime when building with coverage enabled. Overrides classes selected
169 // by the include_filter property.
170 // Supports '*' as the last character of an entry in the list as a wildcard match.
171 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
172 // it matches classes in the package that have the class name as a prefix.
173 Exclude_filter []string
174 }
175
176 Errorprone struct {
177 // List of javac flags that should only be used when running errorprone.
178 Javacflags []string
179
180 // List of java_plugin modules that provide extra errorprone checks.
181 Extra_check_modules []string
Cole Faust75fffb12021-06-13 15:23:16 -0700182
Cole Faust2b1536e2021-06-18 12:25:54 -0700183 // This property can be in 3 states. When set to true, errorprone will
184 // be run during the regular build. When set to false, errorprone will
185 // never be run. When unset, errorprone will be run when the RUN_ERROR_PRONE
186 // environment variable is true. Setting this to false will improve build
187 // performance more than adding -XepDisableAllChecks in javacflags.
Cole Faust75fffb12021-06-13 15:23:16 -0700188 Enabled *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700189 }
190
191 Proto struct {
192 // List of extra options that will be passed to the proto generator.
193 Output_params []string
194 }
195
Sam Delmericoc7593722022-08-31 15:57:52 -0400196 // If true, then jacocoagent is automatically added as a libs dependency so that
197 // r8 will not strip instrumentation classes out of dexed libraries.
Jaewoong Jung26342642021-03-17 15:56:23 -0700198 Instrument bool `blueprint:"mutated"`
Paul Duffin0038a8d2022-05-03 00:28:40 +0000199 // If true, then the module supports statically including the jacocoagent
200 // into the library.
201 Supports_static_instrumentation bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700202
203 // List of files to include in the META-INF/services folder of the resulting jar.
204 Services []string `android:"path,arch_variant"`
205
206 // If true, package the kotlin stdlib into the jar. Defaults to true.
207 Static_kotlin_stdlib *bool `android:"arch_variant"`
208
209 // A list of java_library instances that provide additional hiddenapi annotations for the library.
210 Hiddenapi_additional_annotations []string
Joe Onorato175073c2023-06-01 14:42:59 -0700211
212 // Additional srcJars tacked in by GeneratedJavaLibraryModule
213 Generated_srcjars []android.Path `android:"mutated"`
Mark Whitea15790a2023-08-22 21:28:11 +0000214
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000215 // intermediate aconfig cache file tacked in by GeneratedJavaLibraryModule
216 Aconfig_Cache_files []android.Path `android:"mutated"`
217
Mark Whitea15790a2023-08-22 21:28:11 +0000218 // If true, then only the headers are built and not the implementation jar.
Liz Kammer60772632023-10-05 17:18:44 -0400219 Headers_only *bool
Cole Faust2b64af82023-12-13 18:22:18 -0800220
221 // A list of files or dependencies to make available to the build sandbox. This is
222 // useful if source files are symlinks, the targets of the symlinks must be listed here.
223 // Note that currently not all actions implemented by android_apps are sandboxed, so you
224 // may only see this being necessary in lint builds.
225 Compile_data []string `android:"path"`
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000226
227 // Property signifying whether the module compiles stubs or not.
228 // Should be set to true when srcs of this module are stub files.
229 // This property does not need to be set to true when the module depends on
230 // the stubs via libs, but should be set to true when the module depends on
231 // the stubs via static libs.
232 Is_stubs_module *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700233
Makoto Onuki7ded3822024-03-28 14:42:20 -0700234 Ravenizer struct {
John Wu989ee842024-10-04 00:21:43 +0000235 // If true, enable the "Ravenizer" tool on the output jar.
236 // "Ravenizer" is a tool for Ravenwood tests, but it can also be enabled on other kinds
237 // of java targets.
Makoto Onuki7ded3822024-03-28 14:42:20 -0700238 Enabled *bool
John Wu989ee842024-10-04 00:21:43 +0000239
240 // If true, the "Ravenizer" tool will remove all Mockito and DexMaker
241 // classes from the output jar.
242 Strip_mockito *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700243 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +0000244
245 // Contributing api surface of the stub module. Is not visible to bp modules, and should
246 // only be set for stub submodules generated by the java_sdk_library
247 Stub_contributing_api *string `blueprint:"mutated"`
Yihan Dong8be09c22024-08-29 15:32:13 +0800248
249 // If true, enable the "ApiMapper" tool on the output jar. "ApiMapper" is a tool to inject
250 // bytecode to log API calls.
251 ApiMapper bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700252}
253
254// Properties that are specific to device modules. Host module factories should not add these when
255// constructing a new module.
256type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000257 // If not blank, set to the version of the sdk to compile against.
Spandan Das1ccf5742022-10-14 16:51:23 +0000258 // Defaults to an empty string, which compiles the module against the private platform APIs.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000259 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000260 // 1) numerical API level, "current", "none", or "core_platform"
261 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
262 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
263 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700264 Sdk_version *string
265
satayev0a420e72021-11-29 17:25:52 +0000266 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
267 // Defaults to empty string "". See sdk_version for possible values.
268 Max_sdk_version *string
269
William Loh5a082f92022-05-17 20:21:50 +0000270 // if not blank, set the maxSdkVersion properties of permission and uses-permission tags.
271 // Defaults to empty string "". See sdk_version for possible values.
272 Replace_max_sdk_version_placeholder *string
273
Jaewoong Jung26342642021-03-17 15:56:23 -0700274 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000275 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700276 Target_sdk_version *string
277
278 // Whether to compile against the platform APIs instead of an SDK.
279 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000280 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700281 Platform_apis *bool
282
283 Aidl struct {
284 // Top level directories to pass to aidl tool
285 Include_dirs []string
286
287 // Directories rooted at the Android.bp file to pass to aidl tool
288 Local_include_dirs []string
289
290 // directories that should be added as include directories for any aidl sources of modules
291 // that depend on this module, as well as to aidl for this module.
292 Export_include_dirs []string
293
294 // whether to generate traces (for systrace) for this interface
295 Generate_traces *bool
296
297 // whether to generate Binder#GetTransaction name method.
298 Generate_get_transaction_name *bool
299
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100300 // whether all interfaces should be annotated with required permissions.
301 Enforce_permissions *bool
302
303 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
304 Enforce_permissions_exceptions []string `android:"path"`
305
Jaewoong Jung26342642021-03-17 15:56:23 -0700306 // list of flags that will be passed to the AIDL compiler
307 Flags []string
308 }
309
310 // If true, export a copy of the module as a -hostdex module for host testing.
311 Hostdex *bool
312
313 Target struct {
314 Hostdex struct {
315 // Additional required dependencies to add to -hostdex modules.
316 Required []string
317 }
318 }
319
320 // When targeting 1.9 and above, override the modules to use with --system,
321 // otherwise provides defaults libraries to add to the bootclasspath.
322 System_modules *string
323
Jaewoong Jung26342642021-03-17 15:56:23 -0700324 IsSDKLibrary bool `blueprint:"mutated"`
325
326 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
327 // Defaults to false.
328 V4_signature *bool
329
330 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
331 // public stubs library.
332 SyspropPublicStub string `blueprint:"mutated"`
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000333
334 HiddenAPIPackageProperties
335 HiddenAPIFlagFileProperties
Jaewoong Jung26342642021-03-17 15:56:23 -0700336}
337
yangbill2af0b6e2024-03-15 09:29:29 +0000338// Properties that can be overridden by overriding module (e.g. override_android_app)
339type OverridableProperties struct {
Jooyung Han01d80d82022-01-08 12:16:32 +0900340 // set the name of the output. If not set, `name` is used.
341 // To override a module with this property set, overriding module might need to set this as well.
342 // Otherwise, both the overridden and the overriding modules will have the same output name, which
343 // can cause the duplicate output error.
344 Stem *string
Spandan Dasb9c58352024-05-13 18:29:45 +0000345
346 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
347 // Defaults to sdk_version if not set. See sdk_version for possible values.
348 Min_sdk_version *string
Jooyung Han01d80d82022-01-08 12:16:32 +0900349}
350
Jaewoong Jung26342642021-03-17 15:56:23 -0700351// Functionality common to Module and Import
352//
353// It is embedded in Module so its functionality can be used by methods in Module
354// but it is currently only initialized by Import and Library.
355type embeddableInModuleAndImport struct {
356
357 // Functionality related to this being used as a component of a java_sdk_library.
358 EmbeddableSdkLibraryComponent
359}
360
Paul Duffin71b33cc2021-06-23 11:39:47 +0100361func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
362 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700363}
364
365// Module/Import's DepIsInSameApex(...) delegates to this method.
366//
367// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
368// the one provided by ApexModuleBase.
369func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
370 // dependencies other than the static linkage are all considered crossing APEX boundary
371 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
372 return true
373 }
374 return false
375}
376
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100377// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
378// or an invalid path describing the reason it is invalid.
379//
380// It is unset if a dex jar isn't applicable, i.e. no build rule has been
381// requested to create one.
382//
383// If a dex jar has been requested to be built then it is set, and it may be
384// either a valid android.Path, or invalid with a reason message. The latter
385// happens if the source that should produce the dex file isn't able to.
386//
387// E.g. it is invalid with a reason message if there is a prebuilt APEX that
388// could produce the dex jar through a deapexer module, but the APEX isn't
389// installable so doing so wouldn't be safe.
390type OptionalDexJarPath struct {
391 isSet bool
392 path android.OptionalPath
393}
394
395// IsSet returns true if a path has been set, either invalid or valid.
396func (o OptionalDexJarPath) IsSet() bool {
397 return o.isSet
398}
399
400// Valid returns true if there is a path that is valid.
401func (o OptionalDexJarPath) Valid() bool {
402 return o.isSet && o.path.Valid()
403}
404
405// Path returns the valid path, or panics if it's either not set or is invalid.
406func (o OptionalDexJarPath) Path() android.Path {
407 if !o.isSet {
408 panic("path isn't set")
409 }
410 return o.path.Path()
411}
412
413// PathOrNil returns the path if it's set and valid, or else nil.
414func (o OptionalDexJarPath) PathOrNil() android.Path {
415 if o.Valid() {
416 return o.Path()
417 }
418 return nil
419}
420
421// InvalidReason returns the reason for an invalid path, which is never "". It
422// returns "" for an unset or valid path.
423func (o OptionalDexJarPath) InvalidReason() string {
424 if !o.isSet {
425 return ""
426 }
427 return o.path.InvalidReason()
428}
429
430func (o OptionalDexJarPath) String() string {
431 if !o.isSet {
432 return "<unset>"
433 }
434 return o.path.String()
435}
436
437// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
438func makeUnsetDexJarPath() OptionalDexJarPath {
439 return OptionalDexJarPath{isSet: false}
440}
441
442// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
443// the given OptionalPath, which may be valid or invalid.
444func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
445 return OptionalDexJarPath{isSet: true, path: path}
446}
447
448// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
449// valid given path. It returns an unset OptionalDexJarPath if the given path is
450// nil.
451func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
452 if path == nil {
453 return makeUnsetDexJarPath()
454 }
455 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
456}
457
Jaewoong Jung26342642021-03-17 15:56:23 -0700458// Module contains the properties and members used by all java module types
459type Module struct {
460 android.ModuleBase
461 android.DefaultableModuleBase
462 android.ApexModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700463
464 // Functionality common to Module and Import.
465 embeddableInModuleAndImport
466
467 properties CommonProperties
468 protoProperties android.ProtoProperties
469 deviceProperties DeviceProperties
470
yangbill2af0b6e2024-03-15 09:29:29 +0000471 overridableProperties OverridableProperties
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700472 sourceProperties android.SourceProperties
Jooyung Han01d80d82022-01-08 12:16:32 +0900473
Jaewoong Jung26342642021-03-17 15:56:23 -0700474 // jar file containing header classes including static library dependencies, suitable for
475 // inserting into the bootclasspath/classpath of another compile
476 headerJarFile android.Path
477
478 // jar file containing implementation classes including static library dependencies but no
479 // resources
480 implementationJarFile android.Path
481
Jaewoong Jung26342642021-03-17 15:56:23 -0700482 // args and dependencies to package source files into a srcjar
483 srcJarArgs []string
484 srcJarDeps android.Paths
485
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000486 // the source files of this module and all its static dependencies
Colin Crossa14fb6a2024-10-23 16:57:06 -0700487 transitiveSrcFiles depset.DepSet[android.Path]
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000488
Jaewoong Jung26342642021-03-17 15:56:23 -0700489 // jar file containing implementation classes and resources including static library
490 // dependencies
491 implementationAndResourcesJar android.Path
492
493 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100494 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700495
496 // output file containing uninstrumented classes that will be instrumented by jacoco
497 jacocoReportClassesFile android.Path
498
499 // output file of the module, which may be a classes jar or a dex jar
500 outputFile android.Path
501 extraOutputFiles android.Paths
502
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100503 exportAidlIncludeDirs android.Paths
504 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700505
506 logtagsSrcs android.Paths
507
508 // installed file for binary dependency
509 installFile android.Path
510
Colin Cross3108ce12021-11-10 14:38:50 -0800511 // installed file for hostdex copy
512 hostdexInstallFile android.InstallPath
513
Chaohui Wangdcbe33c2022-10-11 11:13:30 +0800514 // list of unique .java and .kt source files
515 uniqueSrcFiles android.Paths
516
517 // list of srcjars that was passed to javac
518 compiledSrcJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700519
520 // manifest file to use instead of properties.Manifest
521 overrideManifest android.OptionalPath
522
Jaewoong Jung26342642021-03-17 15:56:23 -0700523 // list of plugins that this java module is exporting
524 exportedPluginJars android.Paths
525
526 // list of plugins that this java module is exporting
527 exportedPluginClasses []string
528
529 // if true, the exported plugins generate API and require disabling turbine.
530 exportedDisableTurbine bool
531
532 // list of source files, collected from srcFiles with unique java and all kt files,
533 // will be used by android.IDEInfo struct
534 expandIDEInfoCompiledSrcs []string
535
536 // expanded Jarjar_rules
537 expandJarjarRules android.Path
538
Joe Onorato349ae8d2024-02-05 22:46:00 +0000539 // jarjar rule for inherited jarjar rules
540 repackageJarjarRules android.Path
541
Jaewoong Jung26342642021-03-17 15:56:23 -0700542 // Extra files generated by the module type to be added as java resources.
543 extraResources android.Paths
544
545 hiddenAPI
546 dexer
547 dexpreopter
548 usesLibrary
549 linter
550
551 // list of the xref extraction files
Spandan Das1028d5a2024-08-19 21:45:48 +0000552 kytheFiles android.Paths
553 kytheKotlinFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700554
Jaewoong Jung26342642021-03-17 15:56:23 -0700555 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900556
557 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000558 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000559 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400560
561 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000562
563 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000564
565 // output file name based on Stem property.
566 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
567 // or the module should override Stem().
568 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700569
Joe Onorato349ae8d2024-02-05 22:46:00 +0000570 // Values that will be set in the JarJarProvider data for jarjar repackaging,
571 // and merged with our dependencies' rules.
572 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000573
574 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000575
576 // Paths to the aconfig intermediate cache files that are provided by the
577 // java_aconfig_library or java_library modules that are statically linked
578 // to this module. Does not contain cache files from all transitive dependencies.
579 aconfigCacheFiles android.Paths
Spandan Das8aac9932024-07-18 23:14:13 +0000580
581 // List of soong module dependencies required to compile the current module.
582 // This information is printed out to `Dependencies` field in module_bp_java_deps.json
583 compileDepNames []string
Makoto Onuki7ded3822024-03-28 14:42:20 -0700584
585 ravenizer struct {
586 enabled bool
587 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700588}
589
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000590var _ android.InstallableModule = (*Module)(nil)
591
592// To satisfy the InstallableModule interface
Jihoon Kang224ea082024-08-12 22:38:16 +0000593func (j *Module) StaticDependencyTags() []blueprint.DependencyTag {
594 return []blueprint.DependencyTag{staticLibTag}
595}
596
597// To satisfy the InstallableModule interface
598func (j *Module) DynamicDependencyTags() []blueprint.DependencyTag {
599 return []blueprint.DependencyTag{libTag, sdkLibTag, bootClasspathTag, systemModulesTag,
600 instrumentationForTag, java9LibTag}
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000601}
602
603// Overrides android.ModuleBase.InstallInProduct()
604func (j *Module) InstallInProduct() bool {
605 return j.ProductSpecific()
606}
607
Jihoon Kang85bc1932024-07-01 17:04:46 +0000608var _ android.StubsAvailableModule = (*Module)(nil)
609
610// To safisfy the StubsAvailableModule interface
611func (j *Module) IsStubsModule() bool {
612 return proptools.Bool(j.properties.Is_stubs_module)
613}
614
Jiyong Park92315372021-04-02 08:45:46 +0900615func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
616 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900617 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700618 return nil
619 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900620 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000621 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700622 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
623 } else {
624 // Treat stable core platform as stable.
625 return nil
626 }
627 } else {
628 return fmt.Errorf("non stable SDK %v", sdkVersion)
629 }
630}
631
632// checkSdkVersions enforces restrictions around SDK dependencies.
633func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
634 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900635 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900636 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700637 ctx.PropertyErrorf("sdk_version",
638 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
639 }
640 }
641 }
642
643 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
644 // See rank() for details.
645 ctx.VisitDirectDeps(func(module android.Module) {
646 tag := ctx.OtherModuleDependencyTag(module)
647 switch module.(type) {
648 // TODO(satayev): cover other types as well, e.g. imports
649 case *Library, *AndroidLibrary:
650 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400651 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700652 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
653 }
654 }
655 })
656}
657
658func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900659 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700660 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900661 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700662 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000663 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 -0700664 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000665 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 -0700666 }
667
668 }
669}
670
Mark Whitea15790a2023-08-22 21:28:11 +0000671func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
672 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400673 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000674 installable := proptools.Bool(j.properties.Installable)
675
676 if headersOnly && installable {
677 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.")
678 }
679 }
680}
681
Jaewoong Jung26342642021-03-17 15:56:23 -0700682func (j *Module) addHostProperties() {
683 j.AddProperties(
684 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000685 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700686 &j.protoProperties,
687 &j.usesLibraryProperties,
688 )
689}
690
691func (j *Module) addHostAndDeviceProperties() {
692 j.addHostProperties()
693 j.AddProperties(
694 &j.deviceProperties,
695 &j.dexer.dexProperties,
696 &j.dexpreoptProperties,
697 &j.linter.properties,
698 )
699}
700
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000701// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
702// makes it available through the hiddenAPIPropertyInfoProvider.
703func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
704 hiddenAPIInfo := newHiddenAPIPropertyInfo()
705
706 // Populate with flag file paths from the properties.
707 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
708
709 // Populate with package rules from the properties.
710 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
711
Colin Cross40213022023-12-13 15:19:49 -0800712 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000713}
714
mrziwang9f7b9f42024-07-10 12:18:06 -0700715// helper method for java modules to set OutputFilesProvider
716func setOutputFiles(ctx android.ModuleContext, m Module) {
Cole Faust5146e782024-11-15 14:47:49 -0800717 ctx.SetOutputFiles(append(android.PathsIfNonNil(m.outputFile), m.extraOutputFiles...), "")
718 ctx.SetOutputFiles(android.PathsIfNonNil(m.outputFile), android.DefaultDistTag)
719 ctx.SetOutputFiles(android.PathsIfNonNil(m.implementationAndResourcesJar), ".jar")
720 ctx.SetOutputFiles(android.PathsIfNonNil(m.headerJarFile), ".hjar")
mrziwang9f7b9f42024-07-10 12:18:06 -0700721 if m.dexer.proguardDictionary.Valid() {
722 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
723 }
724 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
Jaewoong Jung26342642021-03-17 15:56:23 -0700725}
726
Jaewoong Jung26342642021-03-17 15:56:23 -0700727func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
728 initJavaModule(module, hod, false)
729}
730
731func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
732 initJavaModule(module, hod, true)
733}
734
735func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
736 multilib := android.MultilibCommon
737 if multiTargets {
738 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
739 } else {
740 android.InitAndroidArchModule(module, hod, multilib)
741 }
742 android.InitDefaultableModule(module)
743}
744
745func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
746 return j.properties.Instrument &&
747 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
748 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
749}
750
Yihan Dong8be09c22024-08-29 15:32:13 +0800751func (j *Module) shouldApiMapper() bool {
752 return j.properties.ApiMapper
753}
754
Jaewoong Jung26342642021-03-17 15:56:23 -0700755func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000756 return j.properties.Supports_static_instrumentation &&
757 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700758 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
759 ctx.Config().UnbundledBuild())
760}
761
762func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
763 // Force enable the instrumentation for java code that is built for APEXes ...
764 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
765 // 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 -0800766 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700767 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000768
Colin Crosse4f34882024-11-14 12:26:00 -0800769 compileDex := Bool(j.dexProperties.Compile_dex) || Bool(j.properties.Installable)
770 if compileDex && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700771 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
772 return true
773 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
774 return true
775 }
776 }
777 return false
778}
779
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400780func (j *Module) setInstrument(value bool) {
781 j.properties.Instrument = value
782}
783
Yihan Dong8be09c22024-08-29 15:32:13 +0800784func (j *Module) setApiMapper(value bool) {
785 j.properties.ApiMapper = value
786}
787
Jiyong Park92315372021-04-02 08:45:46 +0900788func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
789 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700790}
791
Jiyong Parkf1691d22021-03-29 20:11:58 +0900792func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700793 return proptools.String(j.deviceProperties.System_modules)
794}
795
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000796func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000797 if j.overridableProperties.Min_sdk_version != nil {
798 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700799 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000800 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700801}
802
Yu Liuf2b94012023-09-19 15:09:10 -0700803func (j *Module) GetDeviceProperties() *DeviceProperties {
804 return &j.deviceProperties
805}
806
Spandan Dasa26eda72023-03-02 00:56:06 +0000807func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
808 if j.deviceProperties.Max_sdk_version != nil {
809 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
810 }
811 // Default is PrivateApiLevel
812 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000813}
814
Spandan Dasa26eda72023-03-02 00:56:06 +0000815func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
816 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
817 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
818 }
819 // Default is PrivateApiLevel
820 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000821}
822
Jiyong Parkf1691d22021-03-29 20:11:58 +0900823func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000824 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900825}
826
Spandan Dasca70fc42023-03-01 23:38:49 +0000827func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900828 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000829 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900830 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000831 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700832}
833
834func (j *Module) AvailableFor(what string) bool {
835 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
836 // Exception: for hostdex: true libraries, the platform variant is created
837 // even if it's not marked as available to platform. In that case, the platform
838 // variant is used only for the hostdex and not installed to the device.
839 return true
840 }
841 return j.ApexModuleBase.AvailableFor(what)
842}
843
Cole Faustb7493472024-08-28 11:55:52 -0700844func (j *Module) staticLibs(ctx android.BaseModuleContext) []string {
Jihoon Kang8bce3812024-09-30 18:46:51 +0000845 return j.properties.Static_libs.GetOrDefault(ctx, nil)
Cole Faustb7493472024-08-28 11:55:52 -0700846}
847
Jaewoong Jung26342642021-03-17 15:56:23 -0700848func (j *Module) deps(ctx android.BottomUpMutatorContext) {
849 if ctx.Device() {
850 j.linter.deps(ctx)
851
Jiyong Parkf1691d22021-03-29 20:11:58 +0900852 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700853
854 if j.deviceProperties.SyspropPublicStub != "" {
855 // This is a sysprop implementation library that has a corresponding sysprop public
856 // stubs library, and a dependency on it so that dependencies on the implementation can
857 // be forwarded to the public stubs library when necessary.
858 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
859 }
860 }
861
862 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000863
Cole Faustb7493472024-08-28 11:55:52 -0700864 ctx.AddVariationDependencies(nil, staticLibTag, j.staticLibs(ctx)...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700865
866 // Add dependency on libraries that provide additional hidden api annotations.
867 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
868
Jaewoong Jung26342642021-03-17 15:56:23 -0700869 // For library dependencies that are component libraries (like stubs), add the implementation
870 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
871 for _, dep := range libDeps {
872 if dep != nil {
873 if component, ok := dep.(SdkLibraryComponentDependency); ok {
874 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000875 // Add library as optional if it's one of the optional compatibility libs or it's
876 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100877 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000878 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
Cole Faust64f2d842024-10-17 13:28:34 -0700879 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs.GetOrDefault(ctx, nil)) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100880 tag = usesLibOptTag
881 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100882 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700883 }
884 }
885 }
886 }
887
888 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Luca Stefani50098f72024-10-12 17:55:31 +0200889 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag, j.properties.Kotlin_plugins...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700890 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
891 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
892
893 android.ProtoDeps(ctx, &j.protoProperties)
894 if j.hasSrcExt(".proto") {
895 protoDeps(ctx, &j.protoProperties)
896 }
897
898 if j.hasSrcExt(".kt") {
899 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
900 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700901 tag := staticLibTag
902 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
903 tag = libTag
904 }
905 ctx.AddVariationDependencies(nil, tag,
906 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700907 }
908
909 // Framework libraries need special handling in static coverage builds: they should not have
910 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
911 // the same jacoco classes coming from different bootclasspath jars.
912 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
913 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
914 j.properties.Instrument = true
915 }
916 } else if j.shouldInstrumentStatic(ctx) {
917 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
918 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700919
Cole Faustb7493472024-08-28 11:55:52 -0700920 if j.useCompose(ctx) {
Colin Crossa1ff7c62021-09-17 14:11:52 -0700921 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
Luca Stefani50098f72024-10-12 17:55:31 +0200922 "androidx.compose.compiler_compiler-hosted-plugin")
Colin Crossa1ff7c62021-09-17 14:11:52 -0700923 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700924}
925
926func hasSrcExt(srcs []string, ext string) bool {
927 for _, src := range srcs {
928 if filepath.Ext(src) == ext {
929 return true
930 }
931 }
932
933 return false
934}
935
936func (j *Module) hasSrcExt(ext string) bool {
937 return hasSrcExt(j.properties.Srcs, ext)
938}
939
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100940func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
941 var flags string
942
943 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
944 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
945 flags = "-Wmissing-permission-annotation -Werror"
946 }
947 }
948 return flags
949}
950
Jaewoong Jung26342642021-03-17 15:56:23 -0700951func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000952 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700953
954 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
955 aidlIncludes = append(aidlIncludes,
956 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
957 aidlIncludes = append(aidlIncludes,
958 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
959
960 var flags []string
961 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000962 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700963
964 flags = append(flags, j.deviceProperties.Aidl.Flags...)
965
966 if aidlPreprocess.Valid() {
967 flags = append(flags, "-p"+aidlPreprocess.String())
968 deps = append(deps, aidlPreprocess.Path())
969 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000970 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700971 }
972
973 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000974 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700975 }
976
977 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000978 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700979 }
980
Sam Delmerico2351eac2022-05-24 17:10:02 +0000981 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700982 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000983 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700984 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000985 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
986 // add flags for dirs containing AIDL srcs that haven't been specified yet
987 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -0700988
Zim8774ae12022-08-17 11:46:34 +0100989 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +0000990 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +0100991 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700992 flags = append(flags, "-t")
993 }
994
995 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
996 flags = append(flags, "--transaction_names")
997 }
998
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100999 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
1000 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
1001 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1002 }
1003
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001004 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001005 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1006
Jaewoong Jung26342642021-03-17 15:56:23 -07001007 return strings.Join(flags, " "), deps
1008}
1009
1010func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1011
1012 var flags javaBuilderFlags
1013
1014 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001015 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001016
Cole Faust2b1536e2021-06-18 12:25:54 -07001017 epEnabled := j.properties.Errorprone.Enabled
1018 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001019 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001020 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1021 }
1022
1023 errorProneFlags := []string{
1024 "-Xplugin:ErrorProne",
1025 "${config.ErrorProneChecks}",
1026 }
1027 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1028
Colin Cross8bf6cad2022-02-28 13:07:03 -08001029 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001030 "'" + strings.Join(errorProneFlags, " ") + "'"
1031 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1032 }
1033
1034 // classpath
1035 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1036 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001037 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001038 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1039 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1040 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1041
1042 flags.processors = append(flags.processors, deps.processorClasses...)
1043 flags.processors = android.FirstUniqueStrings(flags.processors)
1044
1045 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001046 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001047 // Give host-side tools a version of OpenJDK's standard libraries
1048 // close to what they're targeting. As of Dec 2017, AOSP is only
1049 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1050 //
1051 // When building with OpenJDK 8, the following should have no
1052 // effect since those jars would be available by default.
1053 //
1054 // When building with OpenJDK 9 but targeting a version < 1.8,
1055 // putting them on the bootclasspath means that:
1056 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1057 // b) references to existing APIs are not reinterpreted in an
1058 // OpenJDK 9-specific way, eg. calls to subclasses of
1059 // java.nio.Buffer as in http://b/70862583
1060 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1061 flags.bootClasspath = append(flags.bootClasspath,
1062 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1063 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1064 if Bool(j.properties.Use_tools_jar) {
1065 flags.bootClasspath = append(flags.bootClasspath,
1066 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1067 }
1068 }
1069
1070 // systemModules
1071 flags.systemModules = deps.systemModules
1072
Jaewoong Jung26342642021-03-17 15:56:23 -07001073 return flags
1074}
1075
1076func (j *Module) collectJavacFlags(
1077 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1078 // javac flags.
1079 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001080 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001081
Mythri Alle4b9f6182023-10-25 15:17:11 +00001082 needsDebugInfo = false
1083 for _, flag := range javacFlags {
1084 if strings.HasPrefix(flag, "-g") {
1085 needsDebugInfo = true
1086 }
1087 }
1088
1089 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001090 // For non-host binaries, override the -g flag passed globally to remove
1091 // local variable debug info to reduce disk and memory usage.
1092 javacFlags = append(javacFlags, "-g:source,lines")
1093 }
1094 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1095
1096 if flags.javaVersion.usesJavaModules() {
1097 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001098 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1099 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1100 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1101 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001102
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001103 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001104 if j.properties.Patch_module != nil {
1105 // Manually specify build directory in case it is not under the repo root.
1106 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1107 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001108 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001109
Jaewoong Jung26342642021-03-17 15:56:23 -07001110 classPath := flags.classpath.FormJavaClassPath("")
1111 if classPath != "" {
1112 patchPaths = append(patchPaths, classPath)
1113 }
1114 javacFlags = append(
1115 javacFlags,
1116 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1117 }
1118 }
1119
1120 if len(javacFlags) > 0 {
1121 // optimization.
1122 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1123 flags.javacFlags = "$javacFlags"
1124 }
1125
1126 return flags
1127}
1128
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001129func (j *Module) AddJSONData(d *map[string]interface{}) {
1130 (&j.ModuleBase).AddJSONData(d)
1131 (*d)["Java"] = map[string]interface{}{
1132 "SourceExtensions": j.sourceExtensions,
1133 }
1134
1135}
1136
usta0391ca42023-09-19 15:51:59 -04001137func (j *Module) addGeneratedSrcJars(path android.Path) {
1138 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001139}
1140
Colin Crossfdaa6722024-08-23 11:58:08 -07001141func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars, extraDepCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001142 // Auto-propagating jarjar rules
1143 jarjarProviderData := j.collectJarJarRules(ctx)
1144 if jarjarProviderData != nil {
1145 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wangddb2ee52024-04-02 16:44:02 +00001146 text := getJarJarRuleText(jarjarProviderData)
1147 if text != "" {
1148 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1149 android.WriteFileRule(ctx, ruleTextFile, text)
1150 j.repackageJarjarRules = ruleTextFile
Joe Onorato349ae8d2024-02-05 22:46:00 +00001151 }
1152 }
1153
Jaewoong Jung26342642021-03-17 15:56:23 -07001154 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1155
John Wu989ee842024-10-04 00:21:43 +00001156 // Only override the original value if explicitly set
1157 if j.properties.Ravenizer.Enabled != nil {
1158 j.ravenizer.enabled = *j.properties.Ravenizer.Enabled
Makoto Onuki7ded3822024-03-28 14:42:20 -07001159 }
1160
Jaewoong Jung26342642021-03-17 15:56:23 -07001161 deps := j.collectDeps(ctx)
1162 flags := j.collectBuilderFlags(ctx, deps)
1163
1164 if flags.javaVersion.usesJavaModules() {
1165 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001166 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1167 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1168 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001169 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001170
Jaewoong Jung26342642021-03-17 15:56:23 -07001171 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001172 j.sourceExtensions = []string{}
1173 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1174 if hasSrcExt(srcFiles.Strings(), ext) {
1175 j.sourceExtensions = append(j.sourceExtensions, ext)
1176 }
1177 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001178 if hasSrcExt(srcFiles.Strings(), ".proto") {
1179 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1180 }
1181
1182 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1183 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1184 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1185 }
1186
Sam Delmerico2351eac2022-05-24 17:10:02 +00001187 aidlSrcs := srcFiles.FilterByExt(".aidl")
1188 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1189
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001190 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001191 srcFiles = j.genSources(ctx, srcFiles, flags)
1192
1193 // Collect javac flags only after computing the full set of srcFiles to
1194 // ensure that the --patch-module lookup paths are complete.
1195 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1196
1197 srcJars := srcFiles.FilterByExt(".srcjar")
1198 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001199 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001200 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001201 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001202
1203 if j.properties.Jarjar_rules != nil {
1204 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1205 }
1206
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001207 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001208
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001209 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001210 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001211 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001212 if _, found := set[v.String()]; !found {
1213 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001214 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001215 }
1216 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001217 var uniqueKtFiles android.Paths
1218 for _, v := range srcFiles.FilterByExt(".kt") {
1219 if _, found := set[v.String()]; !found {
1220 set[v.String()] = true
1221 uniqueKtFiles = append(uniqueKtFiles, v)
1222 }
1223 }
1224
1225 var uniqueSrcFiles android.Paths
1226 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1227 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1228 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001229 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001230
Colin Crossb5db4012022-03-28 17:12:39 -07001231 // We don't currently run annotation processors in turbine, which means we can't use turbine
1232 // generated header jars when an annotation processor that generates API is enabled. One
1233 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1234 // is used to run all of the annotation processors.
1235 disableTurbine := deps.disableTurbine
1236
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001237 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001238 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1239
Colin Cross220a9a12022-03-28 17:08:01 -07001240 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001241
Colin Cross4eae06d2023-06-20 22:40:02 -07001242 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1243 // any dependencies so that it can override any non-final R classes from dependencies with the
1244 // final R classes from the app.
1245 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1246
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001247 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1248
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001249 var localImplementationJars android.Paths
1250
Mark Whitea15790a2023-08-22 21:28:11 +00001251 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001252 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001253 if srcFiles.HasExt(".kt") {
1254 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1255 }
1256 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1257 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1258 }
1259
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001260 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1261
1262 localHeaderJars, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
Colin Crossedec77c2024-07-26 15:25:40 -07001263 extraCombinedJars)
1264
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001265 combinedHeaderJarFile, jarjared := j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1266 if jarjared {
1267 localHeaderJars = android.Paths{combinedHeaderJarFile}
1268 transitiveStaticLibsHeaderJars = nil
1269 }
1270 combinedHeaderJarFile, repackaged := j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
1271 if repackaged {
1272 localHeaderJars = android.Paths{combinedHeaderJarFile}
1273 transitiveStaticLibsHeaderJars = nil
1274 }
Mark Whitea15790a2023-08-22 21:28:11 +00001275 if ctx.Failed() {
1276 return
1277 }
Colin Crossedec77c2024-07-26 15:25:40 -07001278 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001279
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001280 if ctx.Config().UseTransitiveJarsInClasspath() {
1281 if len(localHeaderJars) > 0 {
1282 ctx.CheckbuildFile(localHeaderJars...)
1283 } else {
1284 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1285 ctx.UncheckedModule()
1286 }
1287 } else {
1288 ctx.CheckbuildFile(j.headerJarFile)
1289 }
Colin Crossa6182ab2024-08-21 10:47:44 -07001290
Colin Cross7727c7f2024-07-18 15:36:32 -07001291 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001292 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001293 LocalHeaderJars: localHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001294 TransitiveStaticLibsHeaderJars: depset.New(depset.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Cross9ffaf282024-08-12 13:50:09 -07001295 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1296 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001297 AidlIncludeDirs: j.exportAidlIncludeDirs,
1298 ExportedPlugins: j.exportedPluginJars,
1299 ExportedPluginClasses: j.exportedPluginClasses,
1300 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1301 StubsLinkType: j.stubsLinkType,
1302 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001303 })
1304
1305 j.outputFile = j.headerJarFile
1306 return
1307 }
1308
Jaewoong Jung26342642021-03-17 15:56:23 -07001309 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001310 // When using kotlin sources turbine is used to generate annotation processor sources,
1311 // including for annotation processors that generate API, so we can use turbine for
1312 // java sources too.
1313 disableTurbine = false
1314
Jaewoong Jung26342642021-03-17 15:56:23 -07001315 // user defined kotlin flags.
1316 kotlincFlags := j.properties.Kotlincflags
1317 CheckKotlincFlags(ctx, kotlincFlags)
1318
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001319 // Workaround for KT-46512
1320 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001321
1322 // If there are kotlin files, compile them first but pass all the kotlin and java files
1323 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1324 // won't emit any classes for them.
1325 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1326 if ctx.Device() {
1327 kotlincFlags = append(kotlincFlags, "-no-jdk")
1328 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001329
1330 for _, plugin := range deps.kotlinPlugins {
1331 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1332 }
1333 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1334
Jaewoong Jung26342642021-03-17 15:56:23 -07001335 if len(kotlincFlags) > 0 {
1336 // optimization.
1337 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1338 flags.kotlincFlags += "$kotlincFlags"
1339 }
1340
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001341 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001342 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1343
Jaewoong Jung26342642021-03-17 15:56:23 -07001344 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1345 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1346
Isaac Chioua23d9942022-04-06 06:14:38 +00001347 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001348 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001349 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1350 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001351 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001352 srcJars = append(srcJars, kaptSrcJar)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001353 localImplementationJars = append(localImplementationJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001354 // Disable annotation processing in javac, it's already been handled by kapt
1355 flags.processorPath = nil
1356 flags.processors = nil
1357 }
1358
1359 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001360 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Spandan Das1028d5a2024-08-19 21:45:48 +00001361 j.kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001362 if ctx.Failed() {
1363 return
1364 }
1365
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001366 kotlinJarPath, _ := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001367
Isaac Chioua23d9942022-04-06 06:14:38 +00001368 // Make javac rule depend on the kotlinc rule
1369 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1370
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001371 localImplementationJars = append(localImplementationJars, kotlinJarPath)
1372
Colin Cross220a9a12022-03-28 17:08:01 -07001373 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001374 }
1375
Jaewoong Jung26342642021-03-17 15:56:23 -07001376 j.compiledSrcJars = srcJars
1377
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001378 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1379
Jaewoong Jung26342642021-03-17 15:56:23 -07001380 enableSharding := false
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001381 var localHeaderJars android.Paths
1382 var shardingHeaderJars android.Paths
1383 var repackagedHeaderJarFile android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001384 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001385 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1386 enableSharding = true
1387 // Formerly, there was a check here that prevented annotation processors
1388 // from being used when sharding was enabled, as some annotation processors
1389 // do not function correctly in sharded environments. It was removed to
1390 // allow for the use of annotation processors that do function correctly
1391 // with sharding enabled. See: b/77284273.
1392 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001393 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001394 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001395 var combinedHeaderJarFile android.Path
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001396 localHeaderJars, combinedHeaderJarFile = j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
1397 shardingHeaderJars = localHeaderJars
Colin Crossedec77c2024-07-26 15:25:40 -07001398
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001399 var jarjared bool
1400 j.headerJarFile, jarjared = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1401 if jarjared {
1402 // jarjar modifies transitive static dependencies, use the combined header jar and drop the transitive
1403 // static libs header jars.
1404 localHeaderJars = android.Paths{j.headerJarFile}
1405 transitiveStaticLibsHeaderJars = nil
1406 }
1407 var repackaged bool
1408 repackagedHeaderJarFile, repackaged = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
1409 if repackaged {
1410 // repackage modifies transitive static dependencies, use the combined header jar and drop the transitive
1411 // static libs header jars.
1412 // TODO(b/356688296): this shouldn't export both the unmodified and repackaged header jars
1413 localHeaderJars = android.Paths{j.headerJarFile, repackagedHeaderJarFile}
1414 transitiveStaticLibsHeaderJars = nil
1415 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001416 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001417 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001418 hasErrorproneableFiles := false
1419 for _, ext := range j.sourceExtensions {
1420 if ext != ".proto" && ext != ".aidl" {
1421 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1422 // compile, and it's not useful to have warnings on these generated sources.
1423 hasErrorproneableFiles = true
1424 break
1425 }
1426 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001427 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001428 if Bool(j.properties.Errorprone.Enabled) {
1429 // If error-prone is enabled, enable errorprone flags on the regular
1430 // build.
1431 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001432 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001433 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1434 // a new jar file just for compiling with the errorprone compiler to.
1435 // This is because we don't want to cause the java files to get completely
1436 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1437 // We also don't want to run this if errorprone is enabled by default for
1438 // this module, or else we could have duplicated errorprone messages.
1439 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001440 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001441 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001442
Vadim Spivak3c496f02023-06-08 06:14:59 +00001443 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001444 "errorprone", "errorprone")
1445
Jaewoong Jung26342642021-03-17 15:56:23 -07001446 extraJarDeps = append(extraJarDeps, errorprone)
1447 }
1448
1449 if enableSharding {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001450 if len(shardingHeaderJars) > 0 {
1451 flags.classpath = append(classpath(slices.Clone(shardingHeaderJars)), flags.classpath...)
Colin Cross3d56ed52021-11-18 22:23:12 -08001452 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001453 shardSize := int(*(j.properties.Javac_shard_size))
1454 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001455 if len(uniqueJavaFiles) > 0 {
1456 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001457 for idx, shardSrc := range shardSrcs {
1458 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1459 nil, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001460 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
1461 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001462 }
1463 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001464 // Assume approximately 5 sources per srcjar.
1465 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1466 // 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 -07001467 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001468 startIdx := len(shardSrcs)
1469 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1470 for idx, shardSrcJars := range shardSrcJarsList {
1471 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1472 nil, shardSrcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001473 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
1474 localImplementationJars = append(localImplementationJars, classes)
Colin Crossa052ddb2023-09-25 21:46:58 -07001475 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001476 }
1477 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001478 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001479 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
1480 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001481 }
1482 if ctx.Failed() {
1483 return
1484 }
1485 }
1486
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001487 localImplementationJars = append(localImplementationJars, extraCombinedJars...)
Colin Crossfd620b22024-02-23 10:05:21 -08001488
Jaewoong Jung26342642021-03-17 15:56:23 -07001489 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1490
1491 var includeSrcJar android.WritablePath
1492 if Bool(j.properties.Include_srcs) {
1493 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1494 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1495 }
1496
1497 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1498 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Cole Faust7fd5b2e2024-10-29 11:22:20 -07001499 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources.GetOrDefault(ctx, nil), j.properties.Exclude_java_resources)
1500 fileArgs2, fileDeps2 := ResourceFilesToJarArgs(ctx, j.properties.Device_common_java_resources.GetOrDefault(ctx, nil), nil)
1501 fileArgs3, fileDeps3 := ResourceFilesToJarArgs(ctx, j.properties.Device_first_java_resources.GetOrDefault(ctx, nil), nil)
Cole Faust65cb40a2024-10-21 15:41:42 -07001502 fileArgs = slices.Concat(fileArgs, fileArgs2, fileArgs3)
1503 fileDeps = slices.Concat(fileDeps, fileDeps2, fileDeps3)
Jaewoong Jung26342642021-03-17 15:56:23 -07001504 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1505
1506 var resArgs []string
1507 var resDeps android.Paths
1508
1509 resArgs = append(resArgs, dirArgs...)
1510 resDeps = append(resDeps, dirDeps...)
1511
1512 resArgs = append(resArgs, fileArgs...)
1513 resDeps = append(resDeps, fileDeps...)
1514
1515 resArgs = append(resArgs, extraArgs...)
1516 resDeps = append(resDeps, extraDeps...)
1517
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001518 var localResourceJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001519 if len(resArgs) > 0 {
1520 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1521 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001522 if ctx.Failed() {
1523 return
1524 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001525 localResourceJars = append(localResourceJars, resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001526 }
1527
Jaewoong Jung26342642021-03-17 15:56:23 -07001528 if Bool(j.properties.Include_srcs) {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001529 localResourceJars = append(localResourceJars, includeSrcJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001530 }
1531
1532 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1533 if len(services) > 0 {
1534 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1535 var zipargs []string
1536 for _, file := range services {
1537 serviceFile := file.String()
1538 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1539 }
1540 rule := zip
1541 args := map[string]string{
1542 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1543 }
1544 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1545 rule = zipRE
1546 args["implicits"] = strings.Join(services.Strings(), ",")
1547 }
1548 ctx.Build(pctx, android.BuildParams{
1549 Rule: rule,
1550 Output: servicesJar,
1551 Implicits: services,
1552 Args: args,
1553 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001554 localResourceJars = append(localResourceJars, servicesJar)
1555 }
1556
Colin Crossa14fb6a2024-10-23 16:57:06 -07001557 completeStaticLibsResourceJars := depset.New(depset.PREORDER, localResourceJars, deps.transitiveStaticLibsResourceJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001558
1559 var combinedResourceJar android.Path
1560 var resourceJars android.Paths
1561 if ctx.Config().UseTransitiveJarsInClasspath() {
1562 resourceJars = completeStaticLibsResourceJars.ToList()
1563 } else {
1564 resourceJars = append(slices.Clone(localResourceJars), deps.staticResourceJars...)
1565 }
1566 if len(resourceJars) == 1 {
1567 combinedResourceJar = resourceJars[0]
1568 } else if len(resourceJars) > 0 {
1569 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1570 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1571 false, nil, nil)
1572 combinedResourceJar = combinedJar
1573 }
1574
1575 manifest := j.overrideManifest
1576 if !manifest.Valid() && j.properties.Manifest != nil {
1577 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Jaewoong Jung26342642021-03-17 15:56:23 -07001578 }
1579
1580 // Combine the classes built from sources, any manifests, and any static libraries into
1581 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001582 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001583
Colin Crossa14fb6a2024-10-23 16:57:06 -07001584 completeStaticLibsImplementationJars := depset.New(depset.PREORDER, localImplementationJars, deps.transitiveStaticLibsImplementationJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001585
1586 var jars android.Paths
1587 if ctx.Config().UseTransitiveJarsInClasspath() {
1588 jars = completeStaticLibsImplementationJars.ToList()
1589 } else {
1590 jars = append(slices.Clone(localImplementationJars), deps.staticJars...)
1591 }
1592
1593 jars = append(jars, extraDepCombinedJars...)
1594
Jaewoong Jung26342642021-03-17 15:56:23 -07001595 if len(jars) == 1 && !manifest.Valid() {
1596 // Optimization: skip the combine step as there is nothing to do
1597 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1598 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001599 // any if len(extraJars) == 0.
Jaewoong Jung26342642021-03-17 15:56:23 -07001600
Jihoon Kang1147b312023-06-08 23:25:57 +00001601 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1602 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1603 // either with .from-source or .from-text suffix.
1604 // outputFile should be agnostic to the build configuration,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001605 // thus copy the single input static lib in order to prevent the static lib from being exposed
Jihoon Kang1147b312023-06-08 23:25:57 +00001606 // to the copy rules.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001607 if stub, _ := moduleStubLinkType(j); stub {
1608 copiedJar := android.PathForModuleOut(ctx, "combined", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001609 ctx.Build(pctx, android.BuildParams{
1610 Rule: android.Cp,
1611 Input: jars[0],
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001612 Output: copiedJar,
Jaewoong Jung26342642021-03-17 15:56:23 -07001613 })
Colin Crossa14fb6a2024-10-23 16:57:06 -07001614 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, android.Paths{copiedJar}, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001615 outputFile = copiedJar
Colin Cross7707b242024-07-26 12:02:36 -07001616 } else {
1617 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001618 }
1619 } else {
1620 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1621 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1622 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001623 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001624 }
1625
1626 // jarjar implementation jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001627 jarjarFile, jarjarred := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1628 if jarjarred {
1629 localImplementationJars = android.Paths{jarjarFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001630 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001631 }
Colin Crossedec77c2024-07-26 15:25:40 -07001632 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001633
Colin Crossedec77c2024-07-26 15:25:40 -07001634 // jarjar resource jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001635 if combinedResourceJar != nil {
1636 resourceJarJarFile, jarjarred := j.jarjarIfNecessary(ctx, combinedResourceJar, jarName, "resource")
1637 combinedResourceJar = resourceJarJarFile
1638 if jarjarred {
1639 localResourceJars = android.Paths{resourceJarJarFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001640 completeStaticLibsResourceJars = depset.New(depset.PREORDER, localResourceJars, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001641 }
Colin Crossedec77c2024-07-26 15:25:40 -07001642 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001643
Colin Crossedec77c2024-07-26 15:25:40 -07001644 if ctx.Failed() {
1645 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001646 }
1647
Makoto Onuki7ded3822024-03-28 14:42:20 -07001648 if j.ravenizer.enabled {
1649 ravenizerInput := outputFile
John Wub67040d2024-10-07 18:39:06 +00001650 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", "", jarName)
John Wu989ee842024-10-04 00:21:43 +00001651 ravenizerArgs := ""
1652 if proptools.Bool(j.properties.Ravenizer.Strip_mockito) {
1653 ravenizerArgs = "--strip-mockito"
1654 }
1655 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
Makoto Onuki7ded3822024-03-28 14:42:20 -07001656 outputFile = ravenizerOutput
Colin Cross7e863852024-09-06 14:42:38 -07001657 localImplementationJars = android.Paths{ravenizerOutput}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001658 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001659 if combinedResourceJar != nil {
1660 ravenizerInput = combinedResourceJar
1661 ravenizerOutput = android.PathForModuleOut(ctx, "ravenizer", "resources", jarName)
1662 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
1663 combinedResourceJar = ravenizerOutput
1664 localResourceJars = android.Paths{ravenizerOutput}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001665 completeStaticLibsResourceJars = depset.New(depset.PREORDER, localResourceJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001666 }
Makoto Onuki7ded3822024-03-28 14:42:20 -07001667 }
1668
Yihan Dong8be09c22024-08-29 15:32:13 +08001669 if j.shouldApiMapper() {
1670 inputFile := outputFile
1671 apiMapperFile := android.PathForModuleOut(ctx, "apimapper", jarName)
1672 ctx.Build(pctx, android.BuildParams{
1673 Rule: apimapper,
1674 Description: "apimapper",
1675 Input: inputFile,
1676 Output: apiMapperFile,
1677 })
1678 outputFile = apiMapperFile
Colin Cross7e863852024-09-06 14:42:38 -07001679 localImplementationJars = android.Paths{apiMapperFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001680 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Yihan Dong8be09c22024-08-29 15:32:13 +08001681 }
1682
Jaewoong Jung26342642021-03-17 15:56:23 -07001683 // Check package restrictions if necessary.
1684 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001685 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001686 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001687
1688 // Create a rule to copy the output jar to another path and add a validate dependency that
1689 // will check that the jar only contains the permitted packages. The new location will become
1690 // the output file of this module.
1691 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001692 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001693 ctx.Build(pctx, android.BuildParams{
1694 Rule: android.Cp,
1695 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001696 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001697 // Make sure that any dependency on the output file will cause ninja to run the package check
1698 // rule.
1699 Validation: pkgckFile,
1700 })
Colin Cross7707b242024-07-26 12:02:36 -07001701 outputFile = packageCheckOutputFile
Colin Cross7e863852024-09-06 14:42:38 -07001702 localImplementationJars = android.Paths{packageCheckOutputFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001703 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001704
1705 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001706 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001707
1708 if ctx.Failed() {
1709 return
1710 }
1711 }
1712
1713 j.implementationJarFile = outputFile
1714 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001715 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1716 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1717 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1718 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1719 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1720 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1721 j.headerJarFile = headerJarFile
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001722 if len(localImplementationJars) == 1 && ctx.Config().UseTransitiveJarsInClasspath() {
1723 localHeaderJarFile := android.PathForModuleOut(ctx, "local-javac-header", jarName)
1724 convertImplementationJarToHeaderJar(ctx, localImplementationJars[0], localHeaderJarFile)
1725 localHeaderJars = append(localHeaderJars, localHeaderJarFile)
1726 } else {
1727 localHeaderJars = append(localHeaderJars, headerJarFile)
1728 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001729 }
1730
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001731 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1732 specs := j.jacocoModuleToZipCommand(ctx)
1733 if ctx.Failed() {
1734 return
1735 }
1736
Colin Crossb323c912024-09-24 15:21:00 -07001737 completeStaticLibsImplementationJarsToCombine := completeStaticLibsImplementationJars
1738
Colin Cross41698982024-11-13 11:31:31 -08001739 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Colin Crosse4f34882024-11-14 12:26:00 -08001740
1741 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
1742 compileDex := Bool(j.dexProperties.Compile_dex) || Bool(j.properties.Installable)
Colin Cross41698982024-11-13 11:31:31 -08001743
1744 if j.shouldInstrument(ctx) && (!ctx.Device() || compileDex) {
Colin Crossb323c912024-09-24 15:21:00 -07001745 instrumentedOutputFile := j.instrument(ctx, flags, outputFile, jarName, specs)
Colin Crossa14fb6a2024-10-23 16:57:06 -07001746 completeStaticLibsImplementationJarsToCombine = depset.New(depset.PREORDER, android.Paths{instrumentedOutputFile}, nil)
Colin Crossb323c912024-09-24 15:21:00 -07001747 outputFile = instrumentedOutputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001748 }
1749
1750 // merge implementation jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001751 var implementationAndResourcesJarsToCombine android.Paths
1752 if ctx.Config().UseTransitiveJarsInClasspath() {
1753 resourceJars := completeStaticLibsResourceJars.ToList()
1754 if len(resourceJars) > 0 {
Colin Crossb323c912024-09-24 15:21:00 -07001755 implementationAndResourcesJarsToCombine = append(resourceJars, completeStaticLibsImplementationJarsToCombine.ToList()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001756 implementationAndResourcesJarsToCombine = append(implementationAndResourcesJarsToCombine, extraDepCombinedJars...)
1757 }
1758 } else {
1759 if combinedResourceJar != nil {
1760 implementationAndResourcesJarsToCombine = android.Paths{combinedResourceJar, outputFile}
1761 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001762 }
1763
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001764 if len(implementationAndResourcesJarsToCombine) > 0 {
1765 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
1766 TransformJarsToJar(ctx, combinedJar, "for resources", implementationAndResourcesJarsToCombine, manifest,
1767 false, nil, nil)
1768 outputFile = combinedJar
1769 }
1770
1771 j.implementationAndResourcesJar = outputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001772
Colin Cross41698982024-11-13 11:31:31 -08001773 if ctx.Device() && compileDex {
Jaewoong Jung26342642021-03-17 15:56:23 -07001774 if j.hasCode(ctx) {
1775 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001776 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001777 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1778 }
1779 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001780 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001781 params := &compileDexParams{
1782 flags: flags,
1783 sdkVersion: j.SdkVersion(ctx),
1784 minSdkVersion: j.MinSdkVersion(ctx),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001785 classesJar: outputFile,
Spandan Dasc404cc72023-02-23 18:05:05 +00001786 jarName: jarName,
1787 }
Cole Fausteb032462024-09-19 11:12:54 -07001788 if j.GetProfileGuided(ctx) && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting(ctx) {
Spandan Das15a67112024-05-30 00:07:40 +00001789 ctx.PropertyErrorf("enable_profile_rewriting",
1790 "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.",
1791 )
1792 }
Cole Fausteb032462024-09-19 11:12:54 -07001793 if j.EnableProfileRewriting(ctx) {
1794 profile := j.GetProfile(ctx)
1795 if profile == "" || !j.GetProfileGuided(ctx) {
Spandan Das3dbda182024-05-20 22:23:10 +00001796 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1797 }
1798 params.artProfileInput = &profile
1799 }
1800 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001801 if ctx.Failed() {
1802 return
1803 }
1804
Spandan Das3dbda182024-05-20 22:23:10 +00001805 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1806 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001807 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001808 }
1809
Jaewoong Jung26342642021-03-17 15:56:23 -07001810 // merge dex jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001811 var dexAndResourceJarsToCombine android.Paths
1812 if ctx.Config().UseTransitiveJarsInClasspath() {
1813 resourceJars := completeStaticLibsResourceJars.ToList()
1814 if len(resourceJars) > 0 {
1815 dexAndResourceJarsToCombine = append(android.Paths{dexOutputFile}, resourceJars...)
1816 }
1817 } else {
1818 if combinedResourceJar != nil {
1819 dexAndResourceJarsToCombine = android.Paths{dexOutputFile, combinedResourceJar}
1820 }
1821 }
1822 if len(dexAndResourceJarsToCombine) > 0 {
Colin Cross7707b242024-07-26 12:02:36 -07001823 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001824 TransformJarsToJar(ctx, combinedJar, "for dex resources", dexAndResourceJarsToCombine, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001825 false, nil, nil)
1826 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001827 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001828 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001829 dexOutputFile = combinedAlignedJar
1830 } else {
1831 dexOutputFile = combinedJar
1832 }
1833 }
1834
Paul Duffin4de94502021-05-16 05:21:16 +01001835 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001836
1837 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001838
1839 // Encode hidden API flags in dex file, if needed.
1840 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1841
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001842 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001843
1844 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001845 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1846 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1847 libName = strings.TrimSuffix(libName, ".impl")
1848 }
1849 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001850
1851 outputFile = dexOutputFile
Colin Crossa6182ab2024-08-21 10:47:44 -07001852
1853 ctx.CheckbuildFile(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001854 } else {
1855 // There is no code to compile into a dex jar, make sure the resources are propagated
1856 // to the APK if this is an app.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001857 j.dexJarFile = makeDexJarPathFromPath(combinedResourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001858 }
1859
1860 if ctx.Failed() {
1861 return
1862 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001863 }
1864
1865 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001866 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001867 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001868 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001869 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001870 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001871 }
1872 }
1873
1874 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001875 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1876 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001877 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1878 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001879 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001880 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001881 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001882 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001883 j.linter.javaLanguageLevel = flags.javaVersion.String()
1884 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001885 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001886 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1887 j.linter.buildModuleReportZip = true
1888 }
1889 j.linter.lint(ctx)
1890 }
1891
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001892 j.collectTransitiveSrcFiles(ctx, srcFiles)
1893
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001894 if ctx.Config().UseTransitiveJarsInClasspath() {
1895 if len(localImplementationJars) > 0 || len(localResourceJars) > 0 || len(localHeaderJars) > 0 {
1896 ctx.CheckbuildFile(localImplementationJars...)
1897 ctx.CheckbuildFile(localResourceJars...)
1898 ctx.CheckbuildFile(localHeaderJars...)
1899 } else {
1900 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1901 ctx.UncheckedModule()
1902 }
1903 } else {
1904 ctx.CheckbuildFile(j.implementationJarFile)
1905 ctx.CheckbuildFile(j.headerJarFile)
1906 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001907
Colin Cross7727c7f2024-07-18 15:36:32 -07001908 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001909 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1910 RepackagedHeaderJars: android.PathsIfNonNil(repackagedHeaderJarFile),
1911
1912 LocalHeaderJars: localHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001913 TransitiveStaticLibsHeaderJars: depset.New(depset.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001914 TransitiveStaticLibsImplementationJars: completeStaticLibsImplementationJars,
1915 TransitiveStaticLibsResourceJars: completeStaticLibsResourceJars,
1916
Colin Cross9ffaf282024-08-12 13:50:09 -07001917 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1918 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001919 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1920 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001921 ResourceJars: android.PathsIfNonNil(combinedResourceJar),
Jihoon Kang705e63e2024-03-13 01:21:16 +00001922 AidlIncludeDirs: j.exportAidlIncludeDirs,
1923 SrcJarArgs: j.srcJarArgs,
1924 SrcJarDeps: j.srcJarDeps,
1925 TransitiveSrcFiles: j.transitiveSrcFiles,
1926 ExportedPlugins: j.exportedPluginJars,
1927 ExportedPluginClasses: j.exportedPluginClasses,
1928 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1929 JacocoReportClassesFile: j.jacocoReportClassesFile,
1930 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001931 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001932 })
1933
1934 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1935 j.outputFile = outputFile.WithoutRel()
1936}
1937
Cole Faustb7493472024-08-28 11:55:52 -07001938func (j *Module) useCompose(ctx android.BaseModuleContext) bool {
1939 return android.InList("androidx.compose.runtime_runtime", j.staticLibs(ctx))
Colin Crossa1ff7c62021-09-17 14:11:52 -07001940}
1941
Colin Crossa14fb6a2024-10-23 16:57:06 -07001942func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []depset.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001943 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001944 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001945 depTag := ctx.OtherModuleDependencyTag(m)
1946
Colin Crossa14fb6a2024-10-23 16:57:06 -07001947 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1948 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
Sam Delmerico95d70942023-08-02 18:00:35 -04001949
Colin Crossa14fb6a2024-10-23 16:57:06 -07001950 if depTag == staticLibTag {
Sam Delmerico95d70942023-08-02 18:00:35 -04001951 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1952 }
1953 })
1954
Colin Crosscde55342024-03-27 14:11:51 -07001955 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1956}
1957
1958func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1959 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1960
Sam Delmerico95d70942023-08-02 18:00:35 -04001961 directUnconditionalExportedFlags := android.Paths{}
1962 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1963 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1964 if exportUnconditionally {
1965 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1966 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1967 directUnconditionalExportedFlags = proguardFlagsForThisModule
1968 }
1969
1970 return ProguardSpecInfo{
1971 Export_proguard_flags_files: exportUnconditionally,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001972 ProguardFlagsFiles: depset.New[android.Path](
1973 depset.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04001974 proguardFlagsForThisModule,
1975 transitiveProguardFlags,
1976 ),
Colin Crossa14fb6a2024-10-23 16:57:06 -07001977 UnconditionallyExportedProguardFlags: depset.New[android.Path](
1978 depset.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04001979 directUnconditionalExportedFlags,
1980 transitiveUnconditionalExportedFlags,
1981 ),
1982 }
1983
1984}
1985
Cole Faust75fffb12021-06-13 15:23:16 -07001986// Returns a copy of the supplied flags, but with all the errorprone-related
1987// fields copied to the regular build's fields.
1988func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1989 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1990
1991 if len(flags.errorProneExtraJavacFlags) > 0 {
1992 if len(flags.javacFlags) > 0 {
1993 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
1994 } else {
1995 flags.javacFlags = flags.errorProneExtraJavacFlags
1996 }
1997 }
1998 return flags
1999}
2000
Jaewoong Jung26342642021-03-17 15:56:23 -07002001func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07002002 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002003
2004 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00002005 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002006 if idx >= 0 {
2007 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00002008 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002009 jarName += strconv.Itoa(idx)
2010 }
2011
Colin Cross7707b242024-07-26 12:02:36 -07002012 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00002013 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07002014
Cole Faust9decf832024-06-11 11:45:53 -07002015 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002016 extractionFile := android.PathForModuleOut(ctx, kzipName)
2017 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
2018 j.kytheFiles = append(j.kytheFiles, extractionFile)
2019 }
2020
Vadim Spivak3c496f02023-06-08 06:14:59 +00002021 if len(flags.processorPath) > 0 {
2022 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
2023 }
2024
Jaewoong Jung26342642021-03-17 15:56:23 -07002025 return classes
2026}
2027
2028// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
2029// since some of these flags may be used internally.
2030func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
2031 for _, flag := range flags {
2032 flag = strings.TrimSpace(flag)
2033
2034 if !strings.HasPrefix(flag, "-") {
2035 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
2036 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
2037 ctx.PropertyErrorf("kotlincflags",
2038 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
2039 } else if inList(flag, config.KotlincIllegalFlags) {
2040 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
2041 } else if flag == "-include-runtime" {
2042 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
2043 } else {
2044 args := strings.Split(flag, " ")
2045 if args[0] == "-kotlin-home" {
2046 ctx.PropertyErrorf("kotlincflags",
2047 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
2048 }
2049 }
2050 }
2051}
2052
2053func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
2054 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002055 extraJars android.Paths) (localHeaderJars android.Paths, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002056
Jaewoong Jung26342642021-03-17 15:56:23 -07002057 if len(srcFiles) > 0 || len(srcJars) > 0 {
2058 // Compile java sources into turbine.jar.
2059 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
2060 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002061 localHeaderJars = append(localHeaderJars, turbineJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07002062 }
2063
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002064 localHeaderJars = append(localHeaderJars, extraJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002065
2066 // Combine any static header libraries into classes-header.jar. If there is only
2067 // one input jar this step will be skipped.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002068 var jars android.Paths
2069 if ctx.Config().UseTransitiveJarsInClasspath() {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002070 depSet := depset.New(depset.PREORDER, localHeaderJars, deps.transitiveStaticLibsHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002071 jars = depSet.ToList()
2072 } else {
2073 jars = append(slices.Clone(localHeaderJars), deps.staticHeaderJars...)
2074 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002075
2076 // we cannot skip the combine step for now if there is only one jar
2077 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07002078 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
2079 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07002080 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07002081
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002082 return localHeaderJars, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07002083}
2084
2085func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07002086 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002087
2088 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07002089 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07002090
2091 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
2092
2093 j.jacocoReportClassesFile = jacocoReportClassesFile
2094
2095 return instrumentedJar
2096}
2097
Colin Cross9ffaf282024-08-12 13:50:09 -07002098type providesTransitiveHeaderJarsForR8 struct {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002099 // set of header jars for all transitive libs deps
Colin Crossa14fb6a2024-10-23 16:57:06 -07002100 transitiveLibsHeaderJarsForR8 depset.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002101 // set of header jars for all transitive static libs deps
Colin Crossa14fb6a2024-10-23 16:57:06 -07002102 transitiveStaticLibsHeaderJarsForR8 depset.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002103}
2104
Colin Cross9ffaf282024-08-12 13:50:09 -07002105// collectTransitiveHeaderJarsForR8 visits direct dependencies and collects all transitive libs and static_libs
2106// header jars. The semantics of the collected jars are odd (it collects combined jars that contain the static
2107// libs, but also the static libs, and it collects transitive libs dependencies of static_libs), so these
2108// are only used to expand the --lib arguments to R8.
2109func (j *providesTransitiveHeaderJarsForR8) collectTransitiveHeaderJarsForR8(ctx android.ModuleContext) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002110 directLibs := android.Paths{}
2111 directStaticLibs := android.Paths{}
Colin Crossa14fb6a2024-10-23 16:57:06 -07002112 transitiveLibs := []depset.DepSet[android.Path]{}
2113 transitiveStaticLibs := []depset.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002114 ctx.VisitDirectDeps(func(module android.Module) {
2115 // don't add deps of the prebuilt version of the same library
2116 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
2117 return
2118 }
2119
Colin Cross7727c7f2024-07-18 15:36:32 -07002120 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2121 tag := ctx.OtherModuleDependencyTag(module)
2122 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2123 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2124 directLibs = append(directLibs, dep.HeaderJars...)
2125 } else if tag == staticLibTag {
2126 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2127 } else {
2128 // Don't propagate transitive libs for other kinds of dependencies.
2129 return
2130 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002131
Colin Crossa14fb6a2024-10-23 16:57:06 -07002132 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJarsForR8)
2133 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJarsForR8)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002134 }
2135 })
Colin Crossa14fb6a2024-10-23 16:57:06 -07002136 j.transitiveLibsHeaderJarsForR8 = depset.New(depset.POSTORDER, directLibs, transitiveLibs)
2137 j.transitiveStaticLibsHeaderJarsForR8 = depset.New(depset.POSTORDER, directStaticLibs, transitiveStaticLibs)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002138}
2139
Jaewoong Jung26342642021-03-17 15:56:23 -07002140func (j *Module) HeaderJars() android.Paths {
2141 if j.headerJarFile == nil {
2142 return nil
2143 }
2144 return android.Paths{j.headerJarFile}
2145}
2146
2147func (j *Module) ImplementationJars() android.Paths {
2148 if j.implementationJarFile == nil {
2149 return nil
2150 }
2151 return android.Paths{j.implementationJarFile}
2152}
2153
Spandan Das59a4a2b2024-01-09 21:35:56 +00002154func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002155 return j.dexJarFile
2156}
2157
2158func (j *Module) DexJarInstallPath() android.Path {
2159 return j.installFile
2160}
2161
2162func (j *Module) ImplementationAndResourcesJars() android.Paths {
2163 if j.implementationAndResourcesJar == nil {
2164 return nil
2165 }
2166 return android.Paths{j.implementationAndResourcesJar}
2167}
2168
2169func (j *Module) AidlIncludeDirs() android.Paths {
2170 // exportAidlIncludeDirs is type android.Paths already
2171 return j.exportAidlIncludeDirs
2172}
2173
2174func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2175 return j.classLoaderContexts
2176}
2177
2178// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002179func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002180 if j.expandJarjarRules != nil {
2181 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Das096b8d62024-10-08 22:41:26 +00002182 // Add the header jar so that the rdeps can be resolved to the repackaged classes.
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002183 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
Jaewoong Jung26342642021-03-17 15:56:23 -07002184 }
Spandan Das096b8d62024-10-08 22:41:26 +00002185 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2186 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2187 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002188 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2189 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Cole Faustb7493472024-08-28 11:55:52 -07002190 dpInfo.Static_libs = append(dpInfo.Static_libs, j.staticLibs(ctx)...)
Yikef6282022022-04-13 20:41:01 +08002191 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002192}
2193
2194func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002195 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002196}
2197
2198func (j *Module) hasCode(ctx android.ModuleContext) bool {
2199 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2200 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2201}
2202
2203// Implements android.ApexModule
2204func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2205 return j.depIsInSameApex(ctx, dep)
2206}
2207
2208// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002209func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002210 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002211 minSdkVersion := j.MinSdkVersion(ctx)
2212 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002213 return fmt.Errorf("min_sdk_version is not specified")
2214 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002215 // If the module is compiling against core (via sdk_version), skip comparison check.
2216 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002217 return nil
2218 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002219 if minSdkVersion.GreaterThan(sdkVersion) {
2220 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002221 }
2222 return nil
2223}
2224
2225func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002226 if j.stem == "" {
2227 panic("Stem() called before stem property was set")
2228 }
2229 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002230}
2231
Jaewoong Jung26342642021-03-17 15:56:23 -07002232func (j *Module) JacocoReportClassesFile() android.Path {
2233 return j.jacocoReportClassesFile
2234}
2235
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002236func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002237 var fromDeps []depset.DepSet[android.Path]
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002238 ctx.VisitDirectDeps(func(module android.Module) {
2239 tag := ctx.OtherModuleDependencyTag(module)
2240 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002241 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002242 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002243 }
2244 }
2245 })
2246
Colin Crossa14fb6a2024-10-23 16:57:06 -07002247 j.transitiveSrcFiles = depset.New(depset.POSTORDER, mine, fromDeps)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002248}
2249
Jaewoong Jung26342642021-03-17 15:56:23 -07002250func (j *Module) IsInstallable() bool {
2251 return Bool(j.properties.Installable)
2252}
2253
2254type sdkLinkType int
2255
2256const (
2257 // TODO(jiyong) rename these for better readability. Make the allowed
2258 // and disallowed link types explicit
2259 // order is important here. See rank()
2260 javaCore sdkLinkType = iota
2261 javaSdk
2262 javaSystem
2263 javaModule
2264 javaSystemServer
2265 javaPlatform
2266)
2267
2268func (lt sdkLinkType) String() string {
2269 switch lt {
2270 case javaCore:
2271 return "core Java API"
2272 case javaSdk:
2273 return "Android API"
2274 case javaSystem:
2275 return "system API"
2276 case javaModule:
2277 return "module API"
2278 case javaSystemServer:
2279 return "system server API"
2280 case javaPlatform:
2281 return "private API"
2282 default:
2283 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2284 }
2285}
2286
2287// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2288// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2289// can't statically depend on modules that use Platform API.
2290func (lt sdkLinkType) rank() int {
2291 return int(lt)
2292}
2293
2294type moduleWithSdkDep interface {
2295 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002296 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002297}
2298
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002299func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2300 switch k {
2301 case android.SdkCore:
2302 return javaCore
2303 case android.SdkSystem:
2304 return javaSystem
2305 case android.SdkPublic:
2306 return javaSdk
2307 case android.SdkModule:
2308 return javaModule
2309 case android.SdkSystemServer:
2310 return javaSystemServer
2311 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2312 return javaPlatform
2313 default:
2314 return javaSdk
2315 }
2316}
2317
Jiyong Park92315372021-04-02 08:45:46 +09002318func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002319 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002320 case android.SdkCore.DefaultJavaLibraryName(),
2321 "legacy.core.platform.api.stubs",
2322 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002323 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002324 "core-lambda-stubs",
Colin Crosse4f34882024-11-14 12:26:00 -08002325 "core-generated-annotation-stubs",
2326 // jacocoagent only uses core APIs, but has to specify a non-core sdk_version so it can use
2327 // a prebuilt SDK to avoid circular dependencies when it statically included in the bootclasspath.
2328 "jacocoagent":
Jaewoong Jung26342642021-03-17 15:56:23 -07002329 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002330 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002331 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002332 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002333 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002334 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002335 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002336 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002337 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002338 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002339 return javaSystem, true
2340 }
2341
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002342 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002343 return linkType, true
2344 }
2345
Jiyong Park92315372021-04-02 08:45:46 +09002346 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002347 if !ver.Valid() {
2348 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002349 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002350
2351 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002352}
2353
2354// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2355// this module's. See the comment on rank() for details and an example.
2356func (j *Module) checkSdkLinkType(
2357 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2358 if ctx.Host() {
2359 return
2360 }
2361
Jiyong Park92315372021-04-02 08:45:46 +09002362 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002363 if stubs {
2364 return
2365 }
Jiyong Park92315372021-04-02 08:45:46 +09002366 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002367
2368 if myLinkType.rank() < depLinkType.rank() {
2369 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2370 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2371 "property of the source or target module so that target module is built "+
2372 "with the same or smaller API set when compared to the source.",
2373 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2374 }
2375}
2376
2377func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2378 var deps deps
2379
Jiyong Park92315372021-04-02 08:45:46 +09002380 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002381
Colin Cross9ffaf282024-08-12 13:50:09 -07002382 j.collectTransitiveHeaderJarsForR8(ctx)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002383
Colin Crossa14fb6a2024-10-23 16:57:06 -07002384 var transitiveBootClasspathHeaderJars []depset.DepSet[android.Path]
2385 var transitiveClasspathHeaderJars []depset.DepSet[android.Path]
2386 var transitiveJava9ClasspathHeaderJars []depset.DepSet[android.Path]
2387 var transitiveStaticJarsHeaderLibs []depset.DepSet[android.Path]
2388 var transitiveStaticJarsImplementationLibs []depset.DepSet[android.Path]
2389 var transitiveStaticJarsResourceLibs []depset.DepSet[android.Path]
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002390
Jaewoong Jung26342642021-03-17 15:56:23 -07002391 ctx.VisitDirectDeps(func(module android.Module) {
2392 otherName := ctx.OtherModuleName(module)
2393 tag := ctx.OtherModuleDependencyTag(module)
2394
2395 if IsJniDepTag(tag) {
2396 // Handled by AndroidApp.collectAppDeps
2397 return
2398 }
2399 if tag == certificateTag {
2400 // Handled by AndroidApp.collectAppDeps
2401 return
2402 }
2403
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002404 if sdkInfo, ok := android.OtherModuleProvider(ctx, module, SdkLibraryInfoProvider); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -07002405 switch tag {
Jihoon Kang28c96572024-09-11 23:44:44 +00002406 case sdkLibTag, libTag, staticLibTag:
Jihoon Kang28c96572024-09-11 23:44:44 +00002407 generatingLibsString := android.PrettyConcat(
2408 getGeneratingLibs(ctx, j.SdkVersion(ctx), module.Name(), sdkInfo), true, "or")
2409 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 -07002410 }
Colin Cross313aa542023-12-13 13:47:44 -08002411 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2412 if sdkLinkType != javaPlatform {
2413 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2414 // dep is a sysprop implementation library, but this module is not linking against
2415 // the platform, so it gets the sysprop public stubs library instead. Replace
2416 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2417 dep = syspropDep.JavaInfo
2418 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002419 }
2420 switch tag {
2421 case bootClasspathTag:
2422 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002423 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002424 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002425 if _, ok := module.(*Plugin); ok {
2426 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2427 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002428 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002429 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002430 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2431 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2432 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2433 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002434 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2435 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2436 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002437
Colin Crossa14fb6a2024-10-23 16:57:06 -07002438 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002439 case java9LibTag:
2440 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002441 transitiveJava9ClasspathHeaderJars = append(transitiveJava9ClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002442 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002443 if _, ok := module.(*Plugin); ok {
2444 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2445 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002446 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2447 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2448 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2449 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2450 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2451 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2452 // Turbine doesn't run annotation processors, so any module that uses an
2453 // annotation processor that generates API is incompatible with the turbine
2454 // optimization.
2455 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002456 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002457
Colin Crossa14fb6a2024-10-23 16:57:06 -07002458 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2459 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, dep.TransitiveStaticLibsHeaderJars)
2460 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, dep.TransitiveStaticLibsImplementationJars)
2461 transitiveStaticJarsResourceLibs = append(transitiveStaticJarsResourceLibs, dep.TransitiveStaticLibsResourceJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002462 case pluginTag:
2463 if plugin, ok := module.(*Plugin); ok {
2464 if plugin.pluginProperties.Processor_class != nil {
2465 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2466 } else {
2467 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2468 }
2469 // Turbine doesn't run annotation processors, so any module that uses an
2470 // annotation processor that generates API is incompatible with the turbine
2471 // optimization.
2472 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2473 } else {
2474 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2475 }
2476 case errorpronePluginTag:
2477 if _, ok := module.(*Plugin); ok {
2478 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2479 } else {
2480 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2481 }
2482 case exportedPluginTag:
2483 if plugin, ok := module.(*Plugin); ok {
2484 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2485 if plugin.pluginProperties.Processor_class != nil {
2486 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2487 }
2488 // Turbine doesn't run annotation processors, so any module that uses an
2489 // annotation processor that generates API is incompatible with the turbine
2490 // optimization.
2491 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2492 } else {
2493 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2494 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002495 case kotlinPluginTag:
Luca Stefani50098f72024-10-12 17:55:31 +02002496 if _, ok := module.(*KotlinPlugin); ok {
2497 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
2498 } else {
2499 ctx.PropertyErrorf("kotlin_plugins", "%q is not a kotlin_plugin module", otherName)
2500 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002501 case syspropPublicStubDepTag:
2502 // This is a sysprop implementation library, forward the JavaInfoProvider from
2503 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002504 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002505 JavaInfo: dep,
2506 })
2507 }
2508 } else if dep, ok := module.(android.SourceFileProducer); ok {
2509 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002510 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002511 checkProducesJars(ctx, dep)
2512 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002513 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002514 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07002515 depset.New(depset.PREORDER, dep.Srcs(), nil))
Jaewoong Jung26342642021-03-17 15:56:23 -07002516 case staticLibTag:
2517 checkProducesJars(ctx, dep)
2518 deps.classpath = append(deps.classpath, dep.Srcs()...)
2519 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2520 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002521
Colin Crossa14fb6a2024-10-23 16:57:06 -07002522 depHeaderJars := depset.New(depset.PREORDER, dep.Srcs(), nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002523 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJars)
2524 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, depHeaderJars)
2525 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, depHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002526 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002527 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002528 switch tag {
2529 case staticLibTag:
2530 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2531 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002532 } else {
2533 switch tag {
2534 case bootClasspathTag:
2535 // If a system modules dependency has been added to the bootclasspath
2536 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002537 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002538 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002539 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars,
2540 sm.TransitiveStaticLibsHeaderJars)
Colin Crossb61c2262024-08-08 14:04:42 -07002541 } else {
2542 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2543 ctx.OtherModuleName(module))
2544 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002545
2546 case systemModulesTag:
2547 if deps.systemModules != nil {
2548 panic("Found two system module dependencies")
2549 }
Colin Crossb61c2262024-08-08 14:04:42 -07002550 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2551 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2552 } else {
2553 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2554 ctx.OtherModuleName(module))
2555 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002556
2557 case instrumentationForTag:
2558 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 -07002559 }
2560 }
2561
Spandan Das8aac9932024-07-18 23:14:13 +00002562 if android.InList(tag, compileDependencyTags) {
2563 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2564 j.compileDepNames = append(j.compileDepNames, otherName)
2565 }
2566
Jaewoong Jung26342642021-03-17 15:56:23 -07002567 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002568 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002569 })
2570
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002571 deps.transitiveStaticLibsHeaderJars = transitiveStaticJarsHeaderLibs
2572 deps.transitiveStaticLibsImplementationJars = transitiveStaticJarsImplementationLibs
2573 deps.transitiveStaticLibsResourceJars = transitiveStaticJarsResourceLibs
2574
2575 if ctx.Config().UseTransitiveJarsInClasspath() {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002576 depSet := depset.New(depset.PREORDER, nil, transitiveClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002577 deps.classpath = depSet.ToList()
Colin Crossa14fb6a2024-10-23 16:57:06 -07002578 depSet = depset.New(depset.PREORDER, nil, transitiveBootClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002579 deps.bootClasspath = depSet.ToList()
Colin Crossa14fb6a2024-10-23 16:57:06 -07002580 depSet = depset.New(depset.PREORDER, nil, transitiveJava9ClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002581 deps.java9Classpath = depSet.ToList()
2582 }
2583
2584 if ctx.Device() {
2585 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
2586 if sdkDep.invalidVersion {
2587 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2588 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2589 } else if sdkDep.useFiles {
2590 // sdkDep.jar is actually equivalent to turbine header.jar.
2591 deps.classpath = append(slices.Clone(classpath(sdkDep.jars)), deps.classpath...)
2592 deps.dexClasspath = append(slices.Clone(classpath(sdkDep.jars)), deps.dexClasspath...)
2593 deps.aidlPreprocess = sdkDep.aidl
2594 // Add the sdk module dependency to `compileDepNames`.
2595 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2596 // TODO (b/358608607): Move this to decodeSdkDep
2597 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2598 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
2599 } else {
2600 deps.aidlPreprocess = sdkDep.aidl
2601 }
2602 }
2603
Jaewoong Jung26342642021-03-17 15:56:23 -07002604 return deps
2605}
2606
Joe Onorato349ae8d2024-02-05 22:46:00 +00002607// Provider for jarjar renaming rules.
2608//
2609// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2610// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2611// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2612// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2613// be renamed from that module.
2614// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002615type DependencyUse int
2616
2617const (
2618 RenameUseInvalid DependencyUse = iota
2619 RenameUseInclude
2620 RenameUseExclude
2621)
2622
2623type RenameUseElement struct {
2624 DepName string
2625 RenameUse DependencyUse
2626 Why string // token for determining where in the logic the decision was made.
2627}
2628
Joe Onorato349ae8d2024-02-05 22:46:00 +00002629type JarJarProviderData struct {
2630 // Mapping of class names: original --> renamed. If the value is "", the class will be
2631 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2632 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002633 Rename map[string]string
2634 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002635}
2636
2637func (this JarJarProviderData) GetDebugString() string {
2638 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002639 for _, k := range android.SortedKeys(this.Rename) {
2640 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002641 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2642 result += k + "--&gt;" + v + ";"
2643 }
2644 }
2645 return result
2646}
2647
2648var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2649
2650var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2651
2652func init() {
2653 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
Yu Liu26a716d2024-08-30 23:40:32 +00002654
2655 gob.Register(BaseJarJarProviderData{})
Joe Onorato349ae8d2024-02-05 22:46:00 +00002656}
2657
2658// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2659// whether they are java modules or not.
2660type BaseJarJarProviderData struct {
2661 JarJarProviderData JarJarProviderData
2662}
2663
2664func (this BaseJarJarProviderData) GetDebugString() string {
2665 return this.JarJarProviderData.GetDebugString()
2666}
2667
2668var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2669
2670// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2671// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2672// either JarJarProvider or BaseJarJarProvider.
2673func mergeJarJarPrefixes(ctx android.ModuleContext) {
2674 mod := ctx.Module()
2675 // Explicitly avoid propagating into some module types.
2676 switch reflect.TypeOf(mod).String() {
2677 case "*java.Droidstubs":
2678 return
2679 }
2680 jarJarData := collectDirectDepsProviders(ctx)
2681 if jarJarData != nil {
2682 providerData := BaseJarJarProviderData{
2683 JarJarProviderData: *jarJarData,
2684 }
2685 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2686 }
2687
2688}
2689
2690// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2691func (module *Module) addJarJarRenameRule(original string, renamed string) {
2692 if module.jarjarRenameRules == nil {
2693 module.jarjarRenameRules = make(map[string]string)
2694 }
2695 module.jarjarRenameRules[original] = renamed
2696}
2697
2698func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2699 // Gather repackage information from deps
2700 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002701
2702 module := ctx.Module()
2703 moduleName := module.Name()
2704
Colin Cross648daea2024-09-12 14:35:29 -07002705 ctx.VisitDirectDeps(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002706 tag := ctx.OtherModuleDependencyTag(m)
2707 // This logic mirrors that in (*Module).collectDeps above. There are several places
2708 // where we explicitly return RenameUseExclude, even though it is the default, to
2709 // indicate that it has been verified to be the case.
2710 //
2711 // Note well: there are probably cases that are getting to the unconditional return
2712 // and are therefore wrong.
2713 shouldIncludeRenames := func() (DependencyUse, string) {
2714 if moduleName == m.Name() {
2715 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2716 }
2717 if sc, ok := module.(android.SdkContext); ok {
2718 if ctx.Device() {
2719 sdkDep := decodeSdkDep(ctx, sc)
2720 if !sdkDep.invalidVersion && sdkDep.useFiles {
2721 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002722 }
2723 }
LaMont Jones63683e42024-02-08 14:30:45 -08002724 }
2725 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2726 return RenameUseExclude, "tags"
2727 }
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002728 if _, ok := android.OtherModuleProvider(ctx, m, SdkLibraryInfoProvider); ok {
LaMont Jones63683e42024-02-08 14:30:45 -08002729 switch tag {
2730 case sdkLibTag, libTag:
2731 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2732 }
2733 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2734 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2735 switch ji.StubsLinkType {
2736 case Stubs:
2737 return RenameUseExclude, "info"
2738 case Implementation:
2739 return RenameUseInclude, "info"
2740 default:
LaMont Jones09721862024-06-11 10:30:50 -07002741 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002742 // Fall through to the heuristic logic.
2743 }
2744 switch reflect.TypeOf(m).String() {
2745 case "*java.GeneratedJavaLibraryModule":
2746 // Probably a java_aconfig_library module.
2747 // TODO: make this check better.
2748 return RenameUseInclude, "reflect"
2749 }
2750 switch tag {
2751 case bootClasspathTag:
2752 return RenameUseExclude, "tagswitch"
2753 case sdkLibTag, libTag, instrumentationForTag:
2754 return RenameUseInclude, "tagswitch"
2755 case java9LibTag:
2756 return RenameUseExclude, "tagswitch"
2757 case staticLibTag:
2758 return RenameUseInclude, "tagswitch"
2759 case pluginTag:
2760 return RenameUseInclude, "tagswitch"
2761 case errorpronePluginTag:
2762 return RenameUseInclude, "tagswitch"
2763 case exportedPluginTag:
2764 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002765 case kotlinPluginTag:
2766 return RenameUseInclude, "tagswitch"
2767 default:
2768 return RenameUseExclude, "tagswitch"
2769 }
2770 } else if _, ok := m.(android.SourceFileProducer); ok {
2771 switch tag {
2772 case sdkLibTag, libTag, staticLibTag:
2773 return RenameUseInclude, "srcfile"
2774 default:
2775 return RenameUseExclude, "srcfile"
2776 }
Yu Liu67a28422024-03-05 00:36:31 +00002777 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002778 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002779 } else {
2780 switch tag {
2781 case bootClasspathTag:
2782 return RenameUseExclude, "else"
2783 case systemModulesTag:
2784 return RenameUseInclude, "else"
2785 }
2786 }
2787 // If we got here, choose the safer option, which may lead to a build failure, rather
2788 // than runtime failures on the device.
2789 return RenameUseExclude, "end"
2790 }
2791
2792 if result == nil {
2793 result = &JarJarProviderData{
2794 Rename: make(map[string]string),
2795 RenameUse: make([]RenameUseElement, 0),
2796 }
2797 }
2798 how, why := shouldIncludeRenames()
2799 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2800 if how != RenameUseInclude {
2801 // Nothing to merge.
2802 return
2803 }
2804
2805 merge := func(theirs *JarJarProviderData) {
2806 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002807 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2808 result.Rename[orig] = renamed
2809 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2810 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2811 result.Rename[orig] = renamed
2812 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2813 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2814 continue
2815 }
2816 }
2817 }
2818 }
2819 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2820 merge(&theirs)
2821 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2822 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2823 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2824 // to java.Module.
2825 merge(&theirs.JarJarProviderData)
2826 }
2827 })
2828 return
2829}
2830
2831func (this Module) GetDebugString() string {
2832 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2833}
2834
2835// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2836// us, and if it's been set, apply the jarjar_prefix property to rename them.
2837func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2838 // Gather repackage information from deps
2839 result := collectDirectDepsProviders(ctx)
2840
Joe Onoratoa5d17172024-07-20 17:39:56 -07002841 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002842 if result == nil {
2843 result = &JarJarProviderData{
2844 Rename: make(map[string]string),
2845 }
2846 }
2847 if renamed != "" {
2848 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2849 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002850 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002851 }
2852 }
2853 (*result).Rename[orig] = renamed
2854 }
2855
Joe Onoratoa5d17172024-07-20 17:39:56 -07002856 // Update that with entries we've stored for ourself
2857 for orig, renamed := range module.jarjarRenameRules {
2858 add(orig, renamed)
2859 }
2860
2861 // Update that with entries given in the jarjar_rename property.
2862 for _, orig := range module.properties.Jarjar_rename {
2863 add(orig, "")
2864 }
2865
Joe Onorato349ae8d2024-02-05 22:46:00 +00002866 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2867 if result == nil {
2868 return nil
2869 }
2870
2871 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2872 // that have not yet been renamed.
2873 prefix := proptools.String(module.properties.Jarjar_prefix)
2874 if prefix != "" {
2875 if prefix[0] == '.' {
2876 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2877 return nil
2878 }
2879 if prefix[len(prefix)-1] == '.' {
2880 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2881 return nil
2882 }
2883
2884 var updated map[string]string
2885 for orig, renamed := range (*result).Rename {
2886 if renamed == "" {
2887 if updated == nil {
2888 updated = make(map[string]string)
2889 }
2890 updated[orig] = prefix + "." + orig
2891 }
2892 }
2893 for orig, renamed := range updated {
2894 (*result).Rename[orig] = renamed
2895 }
2896 }
2897
2898 return result
2899}
2900
2901// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2902// to "" won't be in this list because they shouldn't be renamed yet.
2903func getJarJarRuleText(provider *JarJarProviderData) string {
2904 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002905 for _, orig := range android.SortedKeys(provider.Rename) {
2906 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002907 if renamed != "" {
2908 result += "rule " + orig + " " + renamed + "\n"
2909 }
2910 }
2911 return result
2912}
2913
Zi Wangddb2ee52024-04-02 16:44:02 +00002914// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002915func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Zi Wangddb2ee52024-04-02 16:44:02 +00002916 if j.repackageJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002917 return infile, false
Zi Wangddb2ee52024-04-02 16:44:02 +00002918 }
Colin Crossedec77c2024-07-26 15:25:40 -07002919 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002920 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002921 return repackagedJarjarFile, true
Zi Wangddb2ee52024-04-02 16:44:02 +00002922}
2923
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002924func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Colin Crossedec77c2024-07-26 15:25:40 -07002925 if j.expandJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002926 return infile, false
Colin Crossedec77c2024-07-26 15:25:40 -07002927 }
2928 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2929 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002930 return jarjarFile, true
Colin Crossedec77c2024-07-26 15:25:40 -07002931
2932}
2933
Jaewoong Jung26342642021-03-17 15:56:23 -07002934func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2935 deps.processorPath = append(deps.processorPath, pluginJars...)
2936 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2937}
2938
2939// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2940// this interface.
2941type ProvidesUsesLib interface {
2942 ProvidesUsesLib() *string
2943}
2944
2945func (j *Module) ProvidesUsesLib() *string {
2946 return j.usesLibraryProperties.Provides_uses_lib
2947}
satayev1c564cc2021-05-25 19:50:30 +01002948
2949type ModuleWithStem interface {
2950 Stem() string
2951}
2952
2953var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002954
2955type ModuleWithUsesLibrary interface {
2956 UsesLibrary() *usesLibrary
2957}
2958
2959func (j *Module) UsesLibrary() *usesLibrary {
2960 return &j.usesLibrary
2961}
2962
2963var _ ModuleWithUsesLibrary = (*Module)(nil)