blob: c0ac4ab995400bd2d06ca6223e79aa5cdf7d295e [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
Yu Liu63bdf632024-12-03 19:54:05 +0000615func CheckStableSdkVersion(ctx android.BaseModuleContext, module android.ModuleProxy) error {
616 if info, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
617 if info.SdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700618 return nil
619 }
Yu Liu63bdf632024-12-03 19:54:05 +0000620 if info.SdkVersion.Kind == android.SdkCorePlatform {
621 if useLegacyCorePlatformApi(ctx, android.OtherModuleProviderOrDefault(ctx, module, android.CommonModuleInfoKey).BaseModuleName) {
622 return fmt.Errorf("non stable SDK %v - uses legacy core platform", info.SdkVersion)
623 } else {
624 // Treat stable core platform as stable.
625 return nil
626 }
627 } else {
628 return fmt.Errorf("non stable SDK %v", info.SdkVersion)
629 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700630 }
Yu Liu63bdf632024-12-03 19:54:05 +0000631
632 return nil
Jaewoong Jung26342642021-03-17 15:56:23 -0700633}
634
635// checkSdkVersions enforces restrictions around SDK dependencies.
636func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
637 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900638 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900639 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700640 ctx.PropertyErrorf("sdk_version",
641 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
642 }
643 }
644 }
645
646 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
647 // See rank() for details.
648 ctx.VisitDirectDeps(func(module android.Module) {
649 tag := ctx.OtherModuleDependencyTag(module)
650 switch module.(type) {
651 // TODO(satayev): cover other types as well, e.g. imports
652 case *Library, *AndroidLibrary:
653 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400654 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700655 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
656 }
657 }
658 })
659}
660
661func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900662 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700663 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900664 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700665 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000666 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 -0700667 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000668 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 -0700669 }
670
671 }
672}
673
Mark Whitea15790a2023-08-22 21:28:11 +0000674func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
675 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400676 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000677 installable := proptools.Bool(j.properties.Installable)
678
679 if headersOnly && installable {
680 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.")
681 }
682 }
683}
684
Jaewoong Jung26342642021-03-17 15:56:23 -0700685func (j *Module) addHostProperties() {
686 j.AddProperties(
687 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000688 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700689 &j.protoProperties,
690 &j.usesLibraryProperties,
691 )
692}
693
694func (j *Module) addHostAndDeviceProperties() {
695 j.addHostProperties()
696 j.AddProperties(
697 &j.deviceProperties,
698 &j.dexer.dexProperties,
699 &j.dexpreoptProperties,
700 &j.linter.properties,
701 )
702}
703
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000704// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
705// makes it available through the hiddenAPIPropertyInfoProvider.
706func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
707 hiddenAPIInfo := newHiddenAPIPropertyInfo()
708
709 // Populate with flag file paths from the properties.
710 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
711
712 // Populate with package rules from the properties.
713 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
714
Colin Cross40213022023-12-13 15:19:49 -0800715 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000716}
717
mrziwang9f7b9f42024-07-10 12:18:06 -0700718// helper method for java modules to set OutputFilesProvider
719func setOutputFiles(ctx android.ModuleContext, m Module) {
Cole Faust5146e782024-11-15 14:47:49 -0800720 ctx.SetOutputFiles(append(android.PathsIfNonNil(m.outputFile), m.extraOutputFiles...), "")
721 ctx.SetOutputFiles(android.PathsIfNonNil(m.outputFile), android.DefaultDistTag)
722 ctx.SetOutputFiles(android.PathsIfNonNil(m.implementationAndResourcesJar), ".jar")
723 ctx.SetOutputFiles(android.PathsIfNonNil(m.headerJarFile), ".hjar")
mrziwang9f7b9f42024-07-10 12:18:06 -0700724 if m.dexer.proguardDictionary.Valid() {
725 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
726 }
727 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
Jaewoong Jung26342642021-03-17 15:56:23 -0700728}
729
Jaewoong Jung26342642021-03-17 15:56:23 -0700730func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
731 initJavaModule(module, hod, false)
732}
733
734func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
735 initJavaModule(module, hod, true)
736}
737
738func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
739 multilib := android.MultilibCommon
740 if multiTargets {
741 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
742 } else {
743 android.InitAndroidArchModule(module, hod, multilib)
744 }
745 android.InitDefaultableModule(module)
746}
747
748func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
749 return j.properties.Instrument &&
750 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
751 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
752}
753
Yihan Dong8be09c22024-08-29 15:32:13 +0800754func (j *Module) shouldApiMapper() bool {
755 return j.properties.ApiMapper
756}
757
Jaewoong Jung26342642021-03-17 15:56:23 -0700758func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000759 return j.properties.Supports_static_instrumentation &&
760 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700761 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
762 ctx.Config().UnbundledBuild())
763}
764
765func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
766 // Force enable the instrumentation for java code that is built for APEXes ...
767 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
768 // 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 -0800769 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700770 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000771
Colin Crosse4f34882024-11-14 12:26:00 -0800772 compileDex := Bool(j.dexProperties.Compile_dex) || Bool(j.properties.Installable)
773 if compileDex && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700774 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
775 return true
776 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
777 return true
778 }
779 }
780 return false
781}
782
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400783func (j *Module) setInstrument(value bool) {
784 j.properties.Instrument = value
785}
786
Yihan Dong8be09c22024-08-29 15:32:13 +0800787func (j *Module) setApiMapper(value bool) {
788 j.properties.ApiMapper = value
789}
790
Jiyong Park92315372021-04-02 08:45:46 +0900791func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
792 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700793}
794
Jiyong Parkf1691d22021-03-29 20:11:58 +0900795func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700796 return proptools.String(j.deviceProperties.System_modules)
797}
798
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000799func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000800 if j.overridableProperties.Min_sdk_version != nil {
801 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700802 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000803 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700804}
805
Yu Liuf2b94012023-09-19 15:09:10 -0700806func (j *Module) GetDeviceProperties() *DeviceProperties {
807 return &j.deviceProperties
808}
809
Spandan Dasa26eda72023-03-02 00:56:06 +0000810func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
811 if j.deviceProperties.Max_sdk_version != nil {
812 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
813 }
814 // Default is PrivateApiLevel
815 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000816}
817
Spandan Dasa26eda72023-03-02 00:56:06 +0000818func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
819 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
820 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
821 }
822 // Default is PrivateApiLevel
823 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000824}
825
Jiyong Parkf1691d22021-03-29 20:11:58 +0900826func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000827 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900828}
829
Spandan Dasca70fc42023-03-01 23:38:49 +0000830func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900831 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000832 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900833 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000834 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700835}
836
837func (j *Module) AvailableFor(what string) bool {
838 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
839 // Exception: for hostdex: true libraries, the platform variant is created
840 // even if it's not marked as available to platform. In that case, the platform
841 // variant is used only for the hostdex and not installed to the device.
842 return true
843 }
844 return j.ApexModuleBase.AvailableFor(what)
845}
846
Cole Faustb7493472024-08-28 11:55:52 -0700847func (j *Module) staticLibs(ctx android.BaseModuleContext) []string {
Jihoon Kang8bce3812024-09-30 18:46:51 +0000848 return j.properties.Static_libs.GetOrDefault(ctx, nil)
Cole Faustb7493472024-08-28 11:55:52 -0700849}
850
Jaewoong Jung26342642021-03-17 15:56:23 -0700851func (j *Module) deps(ctx android.BottomUpMutatorContext) {
852 if ctx.Device() {
853 j.linter.deps(ctx)
854
Jiyong Parkf1691d22021-03-29 20:11:58 +0900855 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700856
857 if j.deviceProperties.SyspropPublicStub != "" {
858 // This is a sysprop implementation library that has a corresponding sysprop public
859 // stubs library, and a dependency on it so that dependencies on the implementation can
860 // be forwarded to the public stubs library when necessary.
861 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
862 }
863 }
864
865 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000866
Cole Faustb7493472024-08-28 11:55:52 -0700867 ctx.AddVariationDependencies(nil, staticLibTag, j.staticLibs(ctx)...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700868
869 // Add dependency on libraries that provide additional hidden api annotations.
870 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
871
Jaewoong Jung26342642021-03-17 15:56:23 -0700872 // For library dependencies that are component libraries (like stubs), add the implementation
873 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
874 for _, dep := range libDeps {
875 if dep != nil {
876 if component, ok := dep.(SdkLibraryComponentDependency); ok {
877 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000878 // Add library as optional if it's one of the optional compatibility libs or it's
879 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100880 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000881 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
Cole Faust64f2d842024-10-17 13:28:34 -0700882 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs.GetOrDefault(ctx, nil)) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100883 tag = usesLibOptTag
884 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100885 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700886 }
887 }
888 }
889 }
890
891 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Luca Stefani50098f72024-10-12 17:55:31 +0200892 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag, j.properties.Kotlin_plugins...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700893 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
894 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
895
896 android.ProtoDeps(ctx, &j.protoProperties)
897 if j.hasSrcExt(".proto") {
898 protoDeps(ctx, &j.protoProperties)
899 }
900
901 if j.hasSrcExt(".kt") {
902 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
903 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700904 tag := staticLibTag
905 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
906 tag = libTag
907 }
908 ctx.AddVariationDependencies(nil, tag,
909 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700910 }
911
912 // Framework libraries need special handling in static coverage builds: they should not have
913 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
914 // the same jacoco classes coming from different bootclasspath jars.
915 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
916 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
917 j.properties.Instrument = true
918 }
919 } else if j.shouldInstrumentStatic(ctx) {
920 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
921 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700922
Cole Faustb7493472024-08-28 11:55:52 -0700923 if j.useCompose(ctx) {
Colin Crossa1ff7c62021-09-17 14:11:52 -0700924 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
Luca Stefani50098f72024-10-12 17:55:31 +0200925 "androidx.compose.compiler_compiler-hosted-plugin")
Colin Crossa1ff7c62021-09-17 14:11:52 -0700926 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700927}
928
929func hasSrcExt(srcs []string, ext string) bool {
930 for _, src := range srcs {
931 if filepath.Ext(src) == ext {
932 return true
933 }
934 }
935
936 return false
937}
938
939func (j *Module) hasSrcExt(ext string) bool {
940 return hasSrcExt(j.properties.Srcs, ext)
941}
942
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100943func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
944 var flags string
945
946 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
947 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
948 flags = "-Wmissing-permission-annotation -Werror"
949 }
950 }
951 return flags
952}
953
Jaewoong Jung26342642021-03-17 15:56:23 -0700954func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000955 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700956
957 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
958 aidlIncludes = append(aidlIncludes,
959 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
960 aidlIncludes = append(aidlIncludes,
961 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
962
963 var flags []string
964 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000965 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700966
967 flags = append(flags, j.deviceProperties.Aidl.Flags...)
968
969 if aidlPreprocess.Valid() {
970 flags = append(flags, "-p"+aidlPreprocess.String())
971 deps = append(deps, aidlPreprocess.Path())
972 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000973 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700974 }
975
976 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000977 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700978 }
979
980 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000981 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700982 }
983
Sam Delmerico2351eac2022-05-24 17:10:02 +0000984 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700985 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000986 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700987 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000988 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
989 // add flags for dirs containing AIDL srcs that haven't been specified yet
990 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -0700991
Zim8774ae12022-08-17 11:46:34 +0100992 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +0000993 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +0100994 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700995 flags = append(flags, "-t")
996 }
997
998 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
999 flags = append(flags, "--transaction_names")
1000 }
1001
Thiébaud Weksteende8417c2022-02-10 15:41:46 +11001002 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
1003 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
1004 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1005 }
1006
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001007 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001008 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1009
Jaewoong Jung26342642021-03-17 15:56:23 -07001010 return strings.Join(flags, " "), deps
1011}
1012
1013func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1014
1015 var flags javaBuilderFlags
1016
1017 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001018 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001019
Cole Faust2b1536e2021-06-18 12:25:54 -07001020 epEnabled := j.properties.Errorprone.Enabled
1021 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001022 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001023 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1024 }
1025
1026 errorProneFlags := []string{
1027 "-Xplugin:ErrorProne",
1028 "${config.ErrorProneChecks}",
1029 }
1030 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1031
Colin Cross8bf6cad2022-02-28 13:07:03 -08001032 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001033 "'" + strings.Join(errorProneFlags, " ") + "'"
1034 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1035 }
1036
1037 // classpath
1038 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1039 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001040 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001041 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1042 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1043 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1044
1045 flags.processors = append(flags.processors, deps.processorClasses...)
1046 flags.processors = android.FirstUniqueStrings(flags.processors)
1047
1048 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001049 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001050 // Give host-side tools a version of OpenJDK's standard libraries
1051 // close to what they're targeting. As of Dec 2017, AOSP is only
1052 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1053 //
1054 // When building with OpenJDK 8, the following should have no
1055 // effect since those jars would be available by default.
1056 //
1057 // When building with OpenJDK 9 but targeting a version < 1.8,
1058 // putting them on the bootclasspath means that:
1059 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1060 // b) references to existing APIs are not reinterpreted in an
1061 // OpenJDK 9-specific way, eg. calls to subclasses of
1062 // java.nio.Buffer as in http://b/70862583
1063 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1064 flags.bootClasspath = append(flags.bootClasspath,
1065 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1066 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1067 if Bool(j.properties.Use_tools_jar) {
1068 flags.bootClasspath = append(flags.bootClasspath,
1069 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1070 }
1071 }
1072
1073 // systemModules
1074 flags.systemModules = deps.systemModules
1075
Jaewoong Jung26342642021-03-17 15:56:23 -07001076 return flags
1077}
1078
1079func (j *Module) collectJavacFlags(
1080 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1081 // javac flags.
1082 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001083 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001084
Mythri Alle4b9f6182023-10-25 15:17:11 +00001085 needsDebugInfo = false
1086 for _, flag := range javacFlags {
1087 if strings.HasPrefix(flag, "-g") {
1088 needsDebugInfo = true
1089 }
1090 }
1091
1092 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001093 // For non-host binaries, override the -g flag passed globally to remove
1094 // local variable debug info to reduce disk and memory usage.
1095 javacFlags = append(javacFlags, "-g:source,lines")
1096 }
1097 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1098
1099 if flags.javaVersion.usesJavaModules() {
1100 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001101 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1102 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1103 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1104 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001105
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001106 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001107 if j.properties.Patch_module != nil {
1108 // Manually specify build directory in case it is not under the repo root.
1109 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1110 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001111 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001112
Jaewoong Jung26342642021-03-17 15:56:23 -07001113 classPath := flags.classpath.FormJavaClassPath("")
1114 if classPath != "" {
1115 patchPaths = append(patchPaths, classPath)
1116 }
1117 javacFlags = append(
1118 javacFlags,
1119 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1120 }
1121 }
1122
1123 if len(javacFlags) > 0 {
1124 // optimization.
1125 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1126 flags.javacFlags = "$javacFlags"
1127 }
1128
1129 return flags
1130}
1131
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001132func (j *Module) AddJSONData(d *map[string]interface{}) {
1133 (&j.ModuleBase).AddJSONData(d)
1134 (*d)["Java"] = map[string]interface{}{
1135 "SourceExtensions": j.sourceExtensions,
1136 }
1137
1138}
1139
usta0391ca42023-09-19 15:51:59 -04001140func (j *Module) addGeneratedSrcJars(path android.Path) {
1141 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001142}
1143
Colin Crossfdaa6722024-08-23 11:58:08 -07001144func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars, extraDepCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001145 // Auto-propagating jarjar rules
1146 jarjarProviderData := j.collectJarJarRules(ctx)
1147 if jarjarProviderData != nil {
1148 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wangddb2ee52024-04-02 16:44:02 +00001149 text := getJarJarRuleText(jarjarProviderData)
1150 if text != "" {
1151 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1152 android.WriteFileRule(ctx, ruleTextFile, text)
1153 j.repackageJarjarRules = ruleTextFile
Joe Onorato349ae8d2024-02-05 22:46:00 +00001154 }
1155 }
1156
Jaewoong Jung26342642021-03-17 15:56:23 -07001157 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1158
John Wu989ee842024-10-04 00:21:43 +00001159 // Only override the original value if explicitly set
1160 if j.properties.Ravenizer.Enabled != nil {
1161 j.ravenizer.enabled = *j.properties.Ravenizer.Enabled
Makoto Onuki7ded3822024-03-28 14:42:20 -07001162 }
1163
Jaewoong Jung26342642021-03-17 15:56:23 -07001164 deps := j.collectDeps(ctx)
1165 flags := j.collectBuilderFlags(ctx, deps)
1166
1167 if flags.javaVersion.usesJavaModules() {
1168 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001169 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1170 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1171 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001172 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001173
Jaewoong Jung26342642021-03-17 15:56:23 -07001174 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001175 j.sourceExtensions = []string{}
1176 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1177 if hasSrcExt(srcFiles.Strings(), ext) {
1178 j.sourceExtensions = append(j.sourceExtensions, ext)
1179 }
1180 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001181 if hasSrcExt(srcFiles.Strings(), ".proto") {
1182 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1183 }
1184
1185 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1186 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1187 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1188 }
1189
Sam Delmerico2351eac2022-05-24 17:10:02 +00001190 aidlSrcs := srcFiles.FilterByExt(".aidl")
1191 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1192
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001193 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001194 srcFiles = j.genSources(ctx, srcFiles, flags)
1195
1196 // Collect javac flags only after computing the full set of srcFiles to
1197 // ensure that the --patch-module lookup paths are complete.
1198 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1199
1200 srcJars := srcFiles.FilterByExt(".srcjar")
1201 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001202 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001203 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001204 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001205
1206 if j.properties.Jarjar_rules != nil {
1207 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1208 }
1209
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001210 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001211
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001212 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001213 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001214 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001215 if _, found := set[v.String()]; !found {
1216 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001217 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001218 }
1219 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001220 var uniqueKtFiles android.Paths
1221 for _, v := range srcFiles.FilterByExt(".kt") {
1222 if _, found := set[v.String()]; !found {
1223 set[v.String()] = true
1224 uniqueKtFiles = append(uniqueKtFiles, v)
1225 }
1226 }
1227
1228 var uniqueSrcFiles android.Paths
1229 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1230 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1231 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001232 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001233
Colin Crossb5db4012022-03-28 17:12:39 -07001234 // We don't currently run annotation processors in turbine, which means we can't use turbine
1235 // generated header jars when an annotation processor that generates API is enabled. One
1236 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1237 // is used to run all of the annotation processors.
1238 disableTurbine := deps.disableTurbine
1239
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001240 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001241 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1242
Colin Cross220a9a12022-03-28 17:08:01 -07001243 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001244
Colin Cross4eae06d2023-06-20 22:40:02 -07001245 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1246 // any dependencies so that it can override any non-final R classes from dependencies with the
1247 // final R classes from the app.
1248 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1249
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001250 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1251
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001252 var localImplementationJars android.Paths
1253
Mark Whitea15790a2023-08-22 21:28:11 +00001254 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001255 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001256 if srcFiles.HasExt(".kt") {
1257 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1258 }
1259 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1260 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1261 }
1262
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001263 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1264
1265 localHeaderJars, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
Colin Crossedec77c2024-07-26 15:25:40 -07001266 extraCombinedJars)
1267
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001268 combinedHeaderJarFile, jarjared := j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1269 if jarjared {
1270 localHeaderJars = android.Paths{combinedHeaderJarFile}
1271 transitiveStaticLibsHeaderJars = nil
1272 }
1273 combinedHeaderJarFile, repackaged := j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
1274 if repackaged {
1275 localHeaderJars = android.Paths{combinedHeaderJarFile}
1276 transitiveStaticLibsHeaderJars = nil
1277 }
Mark Whitea15790a2023-08-22 21:28:11 +00001278 if ctx.Failed() {
1279 return
1280 }
Colin Crossedec77c2024-07-26 15:25:40 -07001281 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001282
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001283 if ctx.Config().UseTransitiveJarsInClasspath() {
1284 if len(localHeaderJars) > 0 {
1285 ctx.CheckbuildFile(localHeaderJars...)
1286 } else {
1287 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1288 ctx.UncheckedModule()
1289 }
1290 } else {
1291 ctx.CheckbuildFile(j.headerJarFile)
1292 }
Colin Crossa6182ab2024-08-21 10:47:44 -07001293
Colin Cross7727c7f2024-07-18 15:36:32 -07001294 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001295 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001296 LocalHeaderJars: localHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001297 TransitiveStaticLibsHeaderJars: depset.New(depset.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Cross9ffaf282024-08-12 13:50:09 -07001298 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1299 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001300 AidlIncludeDirs: j.exportAidlIncludeDirs,
1301 ExportedPlugins: j.exportedPluginJars,
1302 ExportedPluginClasses: j.exportedPluginClasses,
1303 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1304 StubsLinkType: j.stubsLinkType,
1305 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Yu Liu63bdf632024-12-03 19:54:05 +00001306 SdkVersion: j.SdkVersion(ctx),
Mark Whitea15790a2023-08-22 21:28:11 +00001307 })
1308
1309 j.outputFile = j.headerJarFile
1310 return
1311 }
1312
Jaewoong Jung26342642021-03-17 15:56:23 -07001313 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001314 // When using kotlin sources turbine is used to generate annotation processor sources,
1315 // including for annotation processors that generate API, so we can use turbine for
1316 // java sources too.
1317 disableTurbine = false
1318
Jaewoong Jung26342642021-03-17 15:56:23 -07001319 // user defined kotlin flags.
1320 kotlincFlags := j.properties.Kotlincflags
1321 CheckKotlincFlags(ctx, kotlincFlags)
1322
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001323 // Workaround for KT-46512
1324 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001325
1326 // If there are kotlin files, compile them first but pass all the kotlin and java files
1327 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1328 // won't emit any classes for them.
1329 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1330 if ctx.Device() {
1331 kotlincFlags = append(kotlincFlags, "-no-jdk")
1332 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001333
1334 for _, plugin := range deps.kotlinPlugins {
1335 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1336 }
1337 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1338
Jaewoong Jung26342642021-03-17 15:56:23 -07001339 if len(kotlincFlags) > 0 {
1340 // optimization.
1341 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1342 flags.kotlincFlags += "$kotlincFlags"
1343 }
1344
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001345 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001346 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1347
Jaewoong Jung26342642021-03-17 15:56:23 -07001348 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1349 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1350
Isaac Chioua23d9942022-04-06 06:14:38 +00001351 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001352 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001353 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1354 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001355 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001356 srcJars = append(srcJars, kaptSrcJar)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001357 localImplementationJars = append(localImplementationJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001358 // Disable annotation processing in javac, it's already been handled by kapt
1359 flags.processorPath = nil
1360 flags.processors = nil
1361 }
1362
1363 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001364 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Spandan Das1028d5a2024-08-19 21:45:48 +00001365 j.kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001366 if ctx.Failed() {
1367 return
1368 }
1369
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001370 kotlinJarPath, _ := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001371
Isaac Chioua23d9942022-04-06 06:14:38 +00001372 // Make javac rule depend on the kotlinc rule
1373 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1374
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001375 localImplementationJars = append(localImplementationJars, kotlinJarPath)
1376
Colin Cross220a9a12022-03-28 17:08:01 -07001377 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001378 }
1379
Jaewoong Jung26342642021-03-17 15:56:23 -07001380 j.compiledSrcJars = srcJars
1381
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001382 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1383
Jaewoong Jung26342642021-03-17 15:56:23 -07001384 enableSharding := false
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001385 var localHeaderJars android.Paths
1386 var shardingHeaderJars android.Paths
1387 var repackagedHeaderJarFile android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001388 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001389 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1390 enableSharding = true
1391 // Formerly, there was a check here that prevented annotation processors
1392 // from being used when sharding was enabled, as some annotation processors
1393 // do not function correctly in sharded environments. It was removed to
1394 // allow for the use of annotation processors that do function correctly
1395 // with sharding enabled. See: b/77284273.
1396 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001397 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001398 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001399 var combinedHeaderJarFile android.Path
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001400 localHeaderJars, combinedHeaderJarFile = j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
1401 shardingHeaderJars = localHeaderJars
Colin Crossedec77c2024-07-26 15:25:40 -07001402
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001403 var jarjared bool
1404 j.headerJarFile, jarjared = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1405 if jarjared {
1406 // jarjar modifies transitive static dependencies, use the combined header jar and drop the transitive
1407 // static libs header jars.
1408 localHeaderJars = android.Paths{j.headerJarFile}
1409 transitiveStaticLibsHeaderJars = nil
1410 }
1411 var repackaged bool
1412 repackagedHeaderJarFile, repackaged = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
1413 if repackaged {
1414 // repackage modifies transitive static dependencies, use the combined header jar and drop the transitive
1415 // static libs header jars.
1416 // TODO(b/356688296): this shouldn't export both the unmodified and repackaged header jars
1417 localHeaderJars = android.Paths{j.headerJarFile, repackagedHeaderJarFile}
1418 transitiveStaticLibsHeaderJars = nil
1419 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001420 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001421 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001422 hasErrorproneableFiles := false
1423 for _, ext := range j.sourceExtensions {
1424 if ext != ".proto" && ext != ".aidl" {
1425 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1426 // compile, and it's not useful to have warnings on these generated sources.
1427 hasErrorproneableFiles = true
1428 break
1429 }
1430 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001431 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001432 if Bool(j.properties.Errorprone.Enabled) {
1433 // If error-prone is enabled, enable errorprone flags on the regular
1434 // build.
1435 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001436 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001437 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1438 // a new jar file just for compiling with the errorprone compiler to.
1439 // This is because we don't want to cause the java files to get completely
1440 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1441 // We also don't want to run this if errorprone is enabled by default for
1442 // this module, or else we could have duplicated errorprone messages.
1443 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001444 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001445 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001446
Vadim Spivak3c496f02023-06-08 06:14:59 +00001447 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001448 "errorprone", "errorprone")
1449
Jaewoong Jung26342642021-03-17 15:56:23 -07001450 extraJarDeps = append(extraJarDeps, errorprone)
1451 }
1452
1453 if enableSharding {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001454 if len(shardingHeaderJars) > 0 {
1455 flags.classpath = append(classpath(slices.Clone(shardingHeaderJars)), flags.classpath...)
Colin Cross3d56ed52021-11-18 22:23:12 -08001456 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001457 shardSize := int(*(j.properties.Javac_shard_size))
1458 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001459 if len(uniqueJavaFiles) > 0 {
1460 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001461 for idx, shardSrc := range shardSrcs {
1462 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1463 nil, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001464 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
1465 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001466 }
1467 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001468 // Assume approximately 5 sources per srcjar.
1469 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1470 // 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 -07001471 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001472 startIdx := len(shardSrcs)
1473 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1474 for idx, shardSrcJars := range shardSrcJarsList {
1475 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1476 nil, shardSrcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001477 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
1478 localImplementationJars = append(localImplementationJars, classes)
Colin Crossa052ddb2023-09-25 21:46:58 -07001479 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001480 }
1481 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001482 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001483 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
1484 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001485 }
1486 if ctx.Failed() {
1487 return
1488 }
1489 }
1490
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001491 localImplementationJars = append(localImplementationJars, extraCombinedJars...)
Colin Crossfd620b22024-02-23 10:05:21 -08001492
Jaewoong Jung26342642021-03-17 15:56:23 -07001493 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1494
1495 var includeSrcJar android.WritablePath
1496 if Bool(j.properties.Include_srcs) {
1497 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1498 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1499 }
1500
1501 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1502 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Cole Faust7fd5b2e2024-10-29 11:22:20 -07001503 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources.GetOrDefault(ctx, nil), j.properties.Exclude_java_resources)
1504 fileArgs2, fileDeps2 := ResourceFilesToJarArgs(ctx, j.properties.Device_common_java_resources.GetOrDefault(ctx, nil), nil)
1505 fileArgs3, fileDeps3 := ResourceFilesToJarArgs(ctx, j.properties.Device_first_java_resources.GetOrDefault(ctx, nil), nil)
Cole Faust65cb40a2024-10-21 15:41:42 -07001506 fileArgs = slices.Concat(fileArgs, fileArgs2, fileArgs3)
1507 fileDeps = slices.Concat(fileDeps, fileDeps2, fileDeps3)
Jaewoong Jung26342642021-03-17 15:56:23 -07001508 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1509
1510 var resArgs []string
1511 var resDeps android.Paths
1512
1513 resArgs = append(resArgs, dirArgs...)
1514 resDeps = append(resDeps, dirDeps...)
1515
1516 resArgs = append(resArgs, fileArgs...)
1517 resDeps = append(resDeps, fileDeps...)
1518
1519 resArgs = append(resArgs, extraArgs...)
1520 resDeps = append(resDeps, extraDeps...)
1521
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001522 var localResourceJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001523 if len(resArgs) > 0 {
1524 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1525 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001526 if ctx.Failed() {
1527 return
1528 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001529 localResourceJars = append(localResourceJars, resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001530 }
1531
Jaewoong Jung26342642021-03-17 15:56:23 -07001532 if Bool(j.properties.Include_srcs) {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001533 localResourceJars = append(localResourceJars, includeSrcJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001534 }
1535
1536 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1537 if len(services) > 0 {
1538 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1539 var zipargs []string
1540 for _, file := range services {
1541 serviceFile := file.String()
1542 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1543 }
1544 rule := zip
1545 args := map[string]string{
1546 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1547 }
1548 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1549 rule = zipRE
1550 args["implicits"] = strings.Join(services.Strings(), ",")
1551 }
1552 ctx.Build(pctx, android.BuildParams{
1553 Rule: rule,
1554 Output: servicesJar,
1555 Implicits: services,
1556 Args: args,
1557 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001558 localResourceJars = append(localResourceJars, servicesJar)
1559 }
1560
Colin Crossa14fb6a2024-10-23 16:57:06 -07001561 completeStaticLibsResourceJars := depset.New(depset.PREORDER, localResourceJars, deps.transitiveStaticLibsResourceJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001562
1563 var combinedResourceJar android.Path
1564 var resourceJars android.Paths
1565 if ctx.Config().UseTransitiveJarsInClasspath() {
1566 resourceJars = completeStaticLibsResourceJars.ToList()
1567 } else {
1568 resourceJars = append(slices.Clone(localResourceJars), deps.staticResourceJars...)
1569 }
1570 if len(resourceJars) == 1 {
1571 combinedResourceJar = resourceJars[0]
1572 } else if len(resourceJars) > 0 {
1573 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1574 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1575 false, nil, nil)
1576 combinedResourceJar = combinedJar
1577 }
1578
1579 manifest := j.overrideManifest
1580 if !manifest.Valid() && j.properties.Manifest != nil {
1581 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Jaewoong Jung26342642021-03-17 15:56:23 -07001582 }
1583
1584 // Combine the classes built from sources, any manifests, and any static libraries into
1585 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001586 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001587
Colin Crossa14fb6a2024-10-23 16:57:06 -07001588 completeStaticLibsImplementationJars := depset.New(depset.PREORDER, localImplementationJars, deps.transitiveStaticLibsImplementationJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001589
1590 var jars android.Paths
1591 if ctx.Config().UseTransitiveJarsInClasspath() {
1592 jars = completeStaticLibsImplementationJars.ToList()
1593 } else {
1594 jars = append(slices.Clone(localImplementationJars), deps.staticJars...)
1595 }
1596
1597 jars = append(jars, extraDepCombinedJars...)
1598
Jaewoong Jung26342642021-03-17 15:56:23 -07001599 if len(jars) == 1 && !manifest.Valid() {
1600 // Optimization: skip the combine step as there is nothing to do
1601 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1602 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001603 // any if len(extraJars) == 0.
Jaewoong Jung26342642021-03-17 15:56:23 -07001604
Jihoon Kang1147b312023-06-08 23:25:57 +00001605 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1606 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1607 // either with .from-source or .from-text suffix.
1608 // outputFile should be agnostic to the build configuration,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001609 // thus copy the single input static lib in order to prevent the static lib from being exposed
Jihoon Kang1147b312023-06-08 23:25:57 +00001610 // to the copy rules.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001611 if stub, _ := moduleStubLinkType(j); stub {
1612 copiedJar := android.PathForModuleOut(ctx, "combined", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001613 ctx.Build(pctx, android.BuildParams{
1614 Rule: android.Cp,
1615 Input: jars[0],
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001616 Output: copiedJar,
Jaewoong Jung26342642021-03-17 15:56:23 -07001617 })
Colin Crossa14fb6a2024-10-23 16:57:06 -07001618 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, android.Paths{copiedJar}, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001619 outputFile = copiedJar
Colin Cross7707b242024-07-26 12:02:36 -07001620 } else {
1621 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001622 }
1623 } else {
1624 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1625 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1626 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001627 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001628 }
1629
1630 // jarjar implementation jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001631 jarjarFile, jarjarred := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1632 if jarjarred {
1633 localImplementationJars = android.Paths{jarjarFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001634 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001635 }
Colin Crossedec77c2024-07-26 15:25:40 -07001636 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001637
Colin Crossedec77c2024-07-26 15:25:40 -07001638 // jarjar resource jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001639 if combinedResourceJar != nil {
1640 resourceJarJarFile, jarjarred := j.jarjarIfNecessary(ctx, combinedResourceJar, jarName, "resource")
1641 combinedResourceJar = resourceJarJarFile
1642 if jarjarred {
1643 localResourceJars = android.Paths{resourceJarJarFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001644 completeStaticLibsResourceJars = depset.New(depset.PREORDER, localResourceJars, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001645 }
Colin Crossedec77c2024-07-26 15:25:40 -07001646 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001647
Colin Crossedec77c2024-07-26 15:25:40 -07001648 if ctx.Failed() {
1649 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001650 }
1651
Makoto Onuki7ded3822024-03-28 14:42:20 -07001652 if j.ravenizer.enabled {
1653 ravenizerInput := outputFile
John Wub67040d2024-10-07 18:39:06 +00001654 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", "", jarName)
John Wu989ee842024-10-04 00:21:43 +00001655 ravenizerArgs := ""
1656 if proptools.Bool(j.properties.Ravenizer.Strip_mockito) {
1657 ravenizerArgs = "--strip-mockito"
1658 }
1659 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
Makoto Onuki7ded3822024-03-28 14:42:20 -07001660 outputFile = ravenizerOutput
Colin Cross7e863852024-09-06 14:42:38 -07001661 localImplementationJars = android.Paths{ravenizerOutput}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001662 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001663 if combinedResourceJar != nil {
1664 ravenizerInput = combinedResourceJar
1665 ravenizerOutput = android.PathForModuleOut(ctx, "ravenizer", "resources", jarName)
1666 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
1667 combinedResourceJar = ravenizerOutput
1668 localResourceJars = android.Paths{ravenizerOutput}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001669 completeStaticLibsResourceJars = depset.New(depset.PREORDER, localResourceJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001670 }
Makoto Onuki7ded3822024-03-28 14:42:20 -07001671 }
1672
Yihan Dong8be09c22024-08-29 15:32:13 +08001673 if j.shouldApiMapper() {
1674 inputFile := outputFile
1675 apiMapperFile := android.PathForModuleOut(ctx, "apimapper", jarName)
1676 ctx.Build(pctx, android.BuildParams{
1677 Rule: apimapper,
1678 Description: "apimapper",
1679 Input: inputFile,
1680 Output: apiMapperFile,
1681 })
1682 outputFile = apiMapperFile
Colin Cross7e863852024-09-06 14:42:38 -07001683 localImplementationJars = android.Paths{apiMapperFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001684 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Yihan Dong8be09c22024-08-29 15:32:13 +08001685 }
1686
Jaewoong Jung26342642021-03-17 15:56:23 -07001687 // Check package restrictions if necessary.
1688 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001689 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001690 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001691
1692 // Create a rule to copy the output jar to another path and add a validate dependency that
1693 // will check that the jar only contains the permitted packages. The new location will become
1694 // the output file of this module.
1695 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001696 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001697 ctx.Build(pctx, android.BuildParams{
1698 Rule: android.Cp,
1699 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001700 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001701 // Make sure that any dependency on the output file will cause ninja to run the package check
1702 // rule.
1703 Validation: pkgckFile,
1704 })
Colin Cross7707b242024-07-26 12:02:36 -07001705 outputFile = packageCheckOutputFile
Colin Cross7e863852024-09-06 14:42:38 -07001706 localImplementationJars = android.Paths{packageCheckOutputFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001707 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001708
1709 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001710 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001711
1712 if ctx.Failed() {
1713 return
1714 }
1715 }
1716
1717 j.implementationJarFile = outputFile
1718 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001719 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1720 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1721 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1722 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1723 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1724 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1725 j.headerJarFile = headerJarFile
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001726 if len(localImplementationJars) == 1 && ctx.Config().UseTransitiveJarsInClasspath() {
1727 localHeaderJarFile := android.PathForModuleOut(ctx, "local-javac-header", jarName)
1728 convertImplementationJarToHeaderJar(ctx, localImplementationJars[0], localHeaderJarFile)
1729 localHeaderJars = append(localHeaderJars, localHeaderJarFile)
1730 } else {
1731 localHeaderJars = append(localHeaderJars, headerJarFile)
1732 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001733 }
1734
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001735 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1736 specs := j.jacocoModuleToZipCommand(ctx)
1737 if ctx.Failed() {
1738 return
1739 }
1740
Colin Crossb323c912024-09-24 15:21:00 -07001741 completeStaticLibsImplementationJarsToCombine := completeStaticLibsImplementationJars
1742
Colin Cross41698982024-11-13 11:31:31 -08001743 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Colin Crosse4f34882024-11-14 12:26:00 -08001744
1745 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
1746 compileDex := Bool(j.dexProperties.Compile_dex) || Bool(j.properties.Installable)
Colin Cross41698982024-11-13 11:31:31 -08001747
1748 if j.shouldInstrument(ctx) && (!ctx.Device() || compileDex) {
Colin Crossb323c912024-09-24 15:21:00 -07001749 instrumentedOutputFile := j.instrument(ctx, flags, outputFile, jarName, specs)
Colin Crossa14fb6a2024-10-23 16:57:06 -07001750 completeStaticLibsImplementationJarsToCombine = depset.New(depset.PREORDER, android.Paths{instrumentedOutputFile}, nil)
Colin Crossb323c912024-09-24 15:21:00 -07001751 outputFile = instrumentedOutputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001752 }
1753
1754 // merge implementation jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001755 var implementationAndResourcesJarsToCombine android.Paths
1756 if ctx.Config().UseTransitiveJarsInClasspath() {
1757 resourceJars := completeStaticLibsResourceJars.ToList()
1758 if len(resourceJars) > 0 {
Colin Crossb323c912024-09-24 15:21:00 -07001759 implementationAndResourcesJarsToCombine = append(resourceJars, completeStaticLibsImplementationJarsToCombine.ToList()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001760 implementationAndResourcesJarsToCombine = append(implementationAndResourcesJarsToCombine, extraDepCombinedJars...)
1761 }
1762 } else {
1763 if combinedResourceJar != nil {
1764 implementationAndResourcesJarsToCombine = android.Paths{combinedResourceJar, outputFile}
1765 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001766 }
1767
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001768 if len(implementationAndResourcesJarsToCombine) > 0 {
1769 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
1770 TransformJarsToJar(ctx, combinedJar, "for resources", implementationAndResourcesJarsToCombine, manifest,
1771 false, nil, nil)
1772 outputFile = combinedJar
1773 }
1774
1775 j.implementationAndResourcesJar = outputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001776
Colin Cross41698982024-11-13 11:31:31 -08001777 if ctx.Device() && compileDex {
Jaewoong Jung26342642021-03-17 15:56:23 -07001778 if j.hasCode(ctx) {
1779 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001780 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001781 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1782 }
1783 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001784 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001785 params := &compileDexParams{
1786 flags: flags,
1787 sdkVersion: j.SdkVersion(ctx),
1788 minSdkVersion: j.MinSdkVersion(ctx),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001789 classesJar: outputFile,
Spandan Dasc404cc72023-02-23 18:05:05 +00001790 jarName: jarName,
1791 }
Cole Fausteb032462024-09-19 11:12:54 -07001792 if j.GetProfileGuided(ctx) && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting(ctx) {
Spandan Das15a67112024-05-30 00:07:40 +00001793 ctx.PropertyErrorf("enable_profile_rewriting",
1794 "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.",
1795 )
1796 }
Cole Fausteb032462024-09-19 11:12:54 -07001797 if j.EnableProfileRewriting(ctx) {
1798 profile := j.GetProfile(ctx)
1799 if profile == "" || !j.GetProfileGuided(ctx) {
Spandan Das3dbda182024-05-20 22:23:10 +00001800 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1801 }
1802 params.artProfileInput = &profile
1803 }
1804 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001805 if ctx.Failed() {
1806 return
1807 }
1808
Spandan Das3dbda182024-05-20 22:23:10 +00001809 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1810 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001811 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001812 }
1813
Jaewoong Jung26342642021-03-17 15:56:23 -07001814 // merge dex jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001815 var dexAndResourceJarsToCombine android.Paths
1816 if ctx.Config().UseTransitiveJarsInClasspath() {
1817 resourceJars := completeStaticLibsResourceJars.ToList()
1818 if len(resourceJars) > 0 {
1819 dexAndResourceJarsToCombine = append(android.Paths{dexOutputFile}, resourceJars...)
1820 }
1821 } else {
1822 if combinedResourceJar != nil {
1823 dexAndResourceJarsToCombine = android.Paths{dexOutputFile, combinedResourceJar}
1824 }
1825 }
1826 if len(dexAndResourceJarsToCombine) > 0 {
Colin Cross7707b242024-07-26 12:02:36 -07001827 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001828 TransformJarsToJar(ctx, combinedJar, "for dex resources", dexAndResourceJarsToCombine, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001829 false, nil, nil)
1830 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001831 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001832 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001833 dexOutputFile = combinedAlignedJar
1834 } else {
1835 dexOutputFile = combinedJar
1836 }
1837 }
1838
Paul Duffin4de94502021-05-16 05:21:16 +01001839 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001840
1841 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001842
1843 // Encode hidden API flags in dex file, if needed.
1844 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1845
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001846 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001847
1848 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001849 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1850 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1851 libName = strings.TrimSuffix(libName, ".impl")
1852 }
1853 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001854
1855 outputFile = dexOutputFile
Colin Crossa6182ab2024-08-21 10:47:44 -07001856
1857 ctx.CheckbuildFile(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001858 } else {
1859 // There is no code to compile into a dex jar, make sure the resources are propagated
1860 // to the APK if this is an app.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001861 j.dexJarFile = makeDexJarPathFromPath(combinedResourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001862 }
1863
1864 if ctx.Failed() {
1865 return
1866 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001867 }
1868
1869 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001870 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001871 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001872 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001873 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001874 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001875 }
1876 }
1877
1878 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001879 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1880 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001881 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1882 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001883 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001884 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001885 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001886 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001887 j.linter.javaLanguageLevel = flags.javaVersion.String()
1888 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001889 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001890 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1891 j.linter.buildModuleReportZip = true
1892 }
1893 j.linter.lint(ctx)
1894 }
1895
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001896 j.collectTransitiveSrcFiles(ctx, srcFiles)
1897
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001898 if ctx.Config().UseTransitiveJarsInClasspath() {
1899 if len(localImplementationJars) > 0 || len(localResourceJars) > 0 || len(localHeaderJars) > 0 {
1900 ctx.CheckbuildFile(localImplementationJars...)
1901 ctx.CheckbuildFile(localResourceJars...)
1902 ctx.CheckbuildFile(localHeaderJars...)
1903 } else {
1904 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1905 ctx.UncheckedModule()
1906 }
1907 } else {
1908 ctx.CheckbuildFile(j.implementationJarFile)
1909 ctx.CheckbuildFile(j.headerJarFile)
1910 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001911
Colin Cross7727c7f2024-07-18 15:36:32 -07001912 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001913 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1914 RepackagedHeaderJars: android.PathsIfNonNil(repackagedHeaderJarFile),
1915
1916 LocalHeaderJars: localHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001917 TransitiveStaticLibsHeaderJars: depset.New(depset.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001918 TransitiveStaticLibsImplementationJars: completeStaticLibsImplementationJars,
1919 TransitiveStaticLibsResourceJars: completeStaticLibsResourceJars,
1920
Colin Cross9ffaf282024-08-12 13:50:09 -07001921 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1922 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001923 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1924 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001925 ResourceJars: android.PathsIfNonNil(combinedResourceJar),
Jihoon Kang705e63e2024-03-13 01:21:16 +00001926 AidlIncludeDirs: j.exportAidlIncludeDirs,
1927 SrcJarArgs: j.srcJarArgs,
1928 SrcJarDeps: j.srcJarDeps,
1929 TransitiveSrcFiles: j.transitiveSrcFiles,
1930 ExportedPlugins: j.exportedPluginJars,
1931 ExportedPluginClasses: j.exportedPluginClasses,
1932 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1933 JacocoReportClassesFile: j.jacocoReportClassesFile,
1934 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001935 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Yu Liu63bdf632024-12-03 19:54:05 +00001936 SdkVersion: j.SdkVersion(ctx),
Jaewoong Jung26342642021-03-17 15:56:23 -07001937 })
1938
1939 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1940 j.outputFile = outputFile.WithoutRel()
1941}
1942
Cole Faustb7493472024-08-28 11:55:52 -07001943func (j *Module) useCompose(ctx android.BaseModuleContext) bool {
1944 return android.InList("androidx.compose.runtime_runtime", j.staticLibs(ctx))
Colin Crossa1ff7c62021-09-17 14:11:52 -07001945}
1946
Colin Crossa14fb6a2024-10-23 16:57:06 -07001947func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []depset.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001948 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001949 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001950 depTag := ctx.OtherModuleDependencyTag(m)
1951
Colin Crossa14fb6a2024-10-23 16:57:06 -07001952 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1953 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
Sam Delmerico95d70942023-08-02 18:00:35 -04001954
Colin Crossa14fb6a2024-10-23 16:57:06 -07001955 if depTag == staticLibTag {
Sam Delmerico95d70942023-08-02 18:00:35 -04001956 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1957 }
1958 })
1959
Colin Crosscde55342024-03-27 14:11:51 -07001960 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1961}
1962
1963func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1964 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1965
Sam Delmerico95d70942023-08-02 18:00:35 -04001966 directUnconditionalExportedFlags := android.Paths{}
1967 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1968 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1969 if exportUnconditionally {
1970 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1971 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1972 directUnconditionalExportedFlags = proguardFlagsForThisModule
1973 }
1974
1975 return ProguardSpecInfo{
1976 Export_proguard_flags_files: exportUnconditionally,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001977 ProguardFlagsFiles: depset.New[android.Path](
1978 depset.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04001979 proguardFlagsForThisModule,
1980 transitiveProguardFlags,
1981 ),
Colin Crossa14fb6a2024-10-23 16:57:06 -07001982 UnconditionallyExportedProguardFlags: depset.New[android.Path](
1983 depset.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04001984 directUnconditionalExportedFlags,
1985 transitiveUnconditionalExportedFlags,
1986 ),
1987 }
1988
1989}
1990
Cole Faust75fffb12021-06-13 15:23:16 -07001991// Returns a copy of the supplied flags, but with all the errorprone-related
1992// fields copied to the regular build's fields.
1993func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1994 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1995
1996 if len(flags.errorProneExtraJavacFlags) > 0 {
1997 if len(flags.javacFlags) > 0 {
1998 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
1999 } else {
2000 flags.javacFlags = flags.errorProneExtraJavacFlags
2001 }
2002 }
2003 return flags
2004}
2005
Jaewoong Jung26342642021-03-17 15:56:23 -07002006func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07002007 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002008
2009 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00002010 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002011 if idx >= 0 {
2012 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00002013 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002014 jarName += strconv.Itoa(idx)
2015 }
2016
Colin Cross7707b242024-07-26 12:02:36 -07002017 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00002018 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07002019
Cole Faust9decf832024-06-11 11:45:53 -07002020 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002021 extractionFile := android.PathForModuleOut(ctx, kzipName)
2022 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
2023 j.kytheFiles = append(j.kytheFiles, extractionFile)
2024 }
2025
Vadim Spivak3c496f02023-06-08 06:14:59 +00002026 if len(flags.processorPath) > 0 {
2027 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
2028 }
2029
Jaewoong Jung26342642021-03-17 15:56:23 -07002030 return classes
2031}
2032
2033// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
2034// since some of these flags may be used internally.
2035func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
2036 for _, flag := range flags {
2037 flag = strings.TrimSpace(flag)
2038
2039 if !strings.HasPrefix(flag, "-") {
2040 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
2041 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
2042 ctx.PropertyErrorf("kotlincflags",
2043 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
2044 } else if inList(flag, config.KotlincIllegalFlags) {
2045 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
2046 } else if flag == "-include-runtime" {
2047 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
2048 } else {
2049 args := strings.Split(flag, " ")
2050 if args[0] == "-kotlin-home" {
2051 ctx.PropertyErrorf("kotlincflags",
2052 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
2053 }
2054 }
2055 }
2056}
2057
2058func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
2059 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002060 extraJars android.Paths) (localHeaderJars android.Paths, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002061
Jaewoong Jung26342642021-03-17 15:56:23 -07002062 if len(srcFiles) > 0 || len(srcJars) > 0 {
2063 // Compile java sources into turbine.jar.
2064 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
2065 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002066 localHeaderJars = append(localHeaderJars, turbineJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07002067 }
2068
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002069 localHeaderJars = append(localHeaderJars, extraJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002070
2071 // Combine any static header libraries into classes-header.jar. If there is only
2072 // one input jar this step will be skipped.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002073 var jars android.Paths
2074 if ctx.Config().UseTransitiveJarsInClasspath() {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002075 depSet := depset.New(depset.PREORDER, localHeaderJars, deps.transitiveStaticLibsHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002076 jars = depSet.ToList()
2077 } else {
2078 jars = append(slices.Clone(localHeaderJars), deps.staticHeaderJars...)
2079 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002080
2081 // we cannot skip the combine step for now if there is only one jar
2082 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07002083 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
2084 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07002085 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07002086
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002087 return localHeaderJars, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07002088}
2089
2090func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07002091 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002092
2093 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07002094 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07002095
2096 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
2097
2098 j.jacocoReportClassesFile = jacocoReportClassesFile
2099
2100 return instrumentedJar
2101}
2102
Colin Cross9ffaf282024-08-12 13:50:09 -07002103type providesTransitiveHeaderJarsForR8 struct {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002104 // set of header jars for all transitive libs deps
Colin Crossa14fb6a2024-10-23 16:57:06 -07002105 transitiveLibsHeaderJarsForR8 depset.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002106 // set of header jars for all transitive static libs deps
Colin Crossa14fb6a2024-10-23 16:57:06 -07002107 transitiveStaticLibsHeaderJarsForR8 depset.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002108}
2109
Colin Cross9ffaf282024-08-12 13:50:09 -07002110// collectTransitiveHeaderJarsForR8 visits direct dependencies and collects all transitive libs and static_libs
2111// header jars. The semantics of the collected jars are odd (it collects combined jars that contain the static
2112// libs, but also the static libs, and it collects transitive libs dependencies of static_libs), so these
2113// are only used to expand the --lib arguments to R8.
2114func (j *providesTransitiveHeaderJarsForR8) collectTransitiveHeaderJarsForR8(ctx android.ModuleContext) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002115 directLibs := android.Paths{}
2116 directStaticLibs := android.Paths{}
Colin Crossa14fb6a2024-10-23 16:57:06 -07002117 transitiveLibs := []depset.DepSet[android.Path]{}
2118 transitiveStaticLibs := []depset.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002119 ctx.VisitDirectDeps(func(module android.Module) {
2120 // don't add deps of the prebuilt version of the same library
2121 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
2122 return
2123 }
2124
Colin Cross7727c7f2024-07-18 15:36:32 -07002125 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2126 tag := ctx.OtherModuleDependencyTag(module)
2127 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2128 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2129 directLibs = append(directLibs, dep.HeaderJars...)
2130 } else if tag == staticLibTag {
2131 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2132 } else {
2133 // Don't propagate transitive libs for other kinds of dependencies.
2134 return
2135 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002136
Colin Crossa14fb6a2024-10-23 16:57:06 -07002137 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJarsForR8)
2138 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJarsForR8)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002139 }
2140 })
Colin Crossa14fb6a2024-10-23 16:57:06 -07002141 j.transitiveLibsHeaderJarsForR8 = depset.New(depset.POSTORDER, directLibs, transitiveLibs)
2142 j.transitiveStaticLibsHeaderJarsForR8 = depset.New(depset.POSTORDER, directStaticLibs, transitiveStaticLibs)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002143}
2144
Jaewoong Jung26342642021-03-17 15:56:23 -07002145func (j *Module) HeaderJars() android.Paths {
2146 if j.headerJarFile == nil {
2147 return nil
2148 }
2149 return android.Paths{j.headerJarFile}
2150}
2151
2152func (j *Module) ImplementationJars() android.Paths {
2153 if j.implementationJarFile == nil {
2154 return nil
2155 }
2156 return android.Paths{j.implementationJarFile}
2157}
2158
Spandan Das59a4a2b2024-01-09 21:35:56 +00002159func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002160 return j.dexJarFile
2161}
2162
2163func (j *Module) DexJarInstallPath() android.Path {
2164 return j.installFile
2165}
2166
2167func (j *Module) ImplementationAndResourcesJars() android.Paths {
2168 if j.implementationAndResourcesJar == nil {
2169 return nil
2170 }
2171 return android.Paths{j.implementationAndResourcesJar}
2172}
2173
2174func (j *Module) AidlIncludeDirs() android.Paths {
2175 // exportAidlIncludeDirs is type android.Paths already
2176 return j.exportAidlIncludeDirs
2177}
2178
2179func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2180 return j.classLoaderContexts
2181}
2182
2183// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002184func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002185 if j.expandJarjarRules != nil {
2186 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Das096b8d62024-10-08 22:41:26 +00002187 // Add the header jar so that the rdeps can be resolved to the repackaged classes.
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002188 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
Jaewoong Jung26342642021-03-17 15:56:23 -07002189 }
Spandan Das096b8d62024-10-08 22:41:26 +00002190 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2191 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2192 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002193 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2194 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Cole Faustb7493472024-08-28 11:55:52 -07002195 dpInfo.Static_libs = append(dpInfo.Static_libs, j.staticLibs(ctx)...)
Yikef6282022022-04-13 20:41:01 +08002196 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002197}
2198
2199func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002200 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002201}
2202
2203func (j *Module) hasCode(ctx android.ModuleContext) bool {
2204 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2205 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2206}
2207
2208// Implements android.ApexModule
2209func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2210 return j.depIsInSameApex(ctx, dep)
2211}
2212
2213// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002214func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002215 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002216 minSdkVersion := j.MinSdkVersion(ctx)
2217 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002218 return fmt.Errorf("min_sdk_version is not specified")
2219 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002220 // If the module is compiling against core (via sdk_version), skip comparison check.
2221 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002222 return nil
2223 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002224 if minSdkVersion.GreaterThan(sdkVersion) {
2225 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002226 }
2227 return nil
2228}
2229
2230func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002231 if j.stem == "" {
2232 panic("Stem() called before stem property was set")
2233 }
2234 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002235}
2236
Jaewoong Jung26342642021-03-17 15:56:23 -07002237func (j *Module) JacocoReportClassesFile() android.Path {
2238 return j.jacocoReportClassesFile
2239}
2240
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002241func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002242 var fromDeps []depset.DepSet[android.Path]
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002243 ctx.VisitDirectDeps(func(module android.Module) {
2244 tag := ctx.OtherModuleDependencyTag(module)
2245 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002246 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002247 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002248 }
2249 }
2250 })
2251
Colin Crossa14fb6a2024-10-23 16:57:06 -07002252 j.transitiveSrcFiles = depset.New(depset.POSTORDER, mine, fromDeps)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002253}
2254
Jaewoong Jung26342642021-03-17 15:56:23 -07002255func (j *Module) IsInstallable() bool {
2256 return Bool(j.properties.Installable)
2257}
2258
2259type sdkLinkType int
2260
2261const (
2262 // TODO(jiyong) rename these for better readability. Make the allowed
2263 // and disallowed link types explicit
2264 // order is important here. See rank()
2265 javaCore sdkLinkType = iota
2266 javaSdk
2267 javaSystem
2268 javaModule
2269 javaSystemServer
2270 javaPlatform
2271)
2272
2273func (lt sdkLinkType) String() string {
2274 switch lt {
2275 case javaCore:
2276 return "core Java API"
2277 case javaSdk:
2278 return "Android API"
2279 case javaSystem:
2280 return "system API"
2281 case javaModule:
2282 return "module API"
2283 case javaSystemServer:
2284 return "system server API"
2285 case javaPlatform:
2286 return "private API"
2287 default:
2288 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2289 }
2290}
2291
2292// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2293// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2294// can't statically depend on modules that use Platform API.
2295func (lt sdkLinkType) rank() int {
2296 return int(lt)
2297}
2298
2299type moduleWithSdkDep interface {
2300 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002301 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002302}
2303
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002304func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2305 switch k {
2306 case android.SdkCore:
2307 return javaCore
2308 case android.SdkSystem:
2309 return javaSystem
2310 case android.SdkPublic:
2311 return javaSdk
2312 case android.SdkModule:
2313 return javaModule
2314 case android.SdkSystemServer:
2315 return javaSystemServer
2316 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2317 return javaPlatform
2318 default:
2319 return javaSdk
2320 }
2321}
2322
Jiyong Park92315372021-04-02 08:45:46 +09002323func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002324 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002325 case android.SdkCore.DefaultJavaLibraryName(),
2326 "legacy.core.platform.api.stubs",
2327 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002328 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002329 "core-lambda-stubs",
Colin Crosse4f34882024-11-14 12:26:00 -08002330 "core-generated-annotation-stubs",
2331 // jacocoagent only uses core APIs, but has to specify a non-core sdk_version so it can use
2332 // a prebuilt SDK to avoid circular dependencies when it statically included in the bootclasspath.
2333 "jacocoagent":
Jaewoong Jung26342642021-03-17 15:56:23 -07002334 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002335 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002336 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002337 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002338 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002339 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002340 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002341 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002342 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002343 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002344 return javaSystem, true
2345 }
2346
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002347 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002348 return linkType, true
2349 }
2350
Jiyong Park92315372021-04-02 08:45:46 +09002351 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002352 if !ver.Valid() {
2353 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002354 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002355
2356 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002357}
2358
2359// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2360// this module's. See the comment on rank() for details and an example.
2361func (j *Module) checkSdkLinkType(
2362 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2363 if ctx.Host() {
2364 return
2365 }
2366
Jiyong Park92315372021-04-02 08:45:46 +09002367 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002368 if stubs {
2369 return
2370 }
Jiyong Park92315372021-04-02 08:45:46 +09002371 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002372
2373 if myLinkType.rank() < depLinkType.rank() {
2374 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2375 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2376 "property of the source or target module so that target module is built "+
2377 "with the same or smaller API set when compared to the source.",
2378 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2379 }
2380}
2381
2382func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2383 var deps deps
2384
Jiyong Park92315372021-04-02 08:45:46 +09002385 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002386
Colin Cross9ffaf282024-08-12 13:50:09 -07002387 j.collectTransitiveHeaderJarsForR8(ctx)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002388
Colin Crossa14fb6a2024-10-23 16:57:06 -07002389 var transitiveBootClasspathHeaderJars []depset.DepSet[android.Path]
2390 var transitiveClasspathHeaderJars []depset.DepSet[android.Path]
2391 var transitiveJava9ClasspathHeaderJars []depset.DepSet[android.Path]
2392 var transitiveStaticJarsHeaderLibs []depset.DepSet[android.Path]
2393 var transitiveStaticJarsImplementationLibs []depset.DepSet[android.Path]
2394 var transitiveStaticJarsResourceLibs []depset.DepSet[android.Path]
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002395
Jaewoong Jung26342642021-03-17 15:56:23 -07002396 ctx.VisitDirectDeps(func(module android.Module) {
2397 otherName := ctx.OtherModuleName(module)
2398 tag := ctx.OtherModuleDependencyTag(module)
2399
2400 if IsJniDepTag(tag) {
2401 // Handled by AndroidApp.collectAppDeps
2402 return
2403 }
2404 if tag == certificateTag {
2405 // Handled by AndroidApp.collectAppDeps
2406 return
2407 }
2408
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002409 if sdkInfo, ok := android.OtherModuleProvider(ctx, module, SdkLibraryInfoProvider); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -07002410 switch tag {
Jihoon Kang28c96572024-09-11 23:44:44 +00002411 case sdkLibTag, libTag, staticLibTag:
Jihoon Kang28c96572024-09-11 23:44:44 +00002412 generatingLibsString := android.PrettyConcat(
2413 getGeneratingLibs(ctx, j.SdkVersion(ctx), module.Name(), sdkInfo), true, "or")
2414 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 -07002415 }
Colin Cross313aa542023-12-13 13:47:44 -08002416 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2417 if sdkLinkType != javaPlatform {
2418 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2419 // dep is a sysprop implementation library, but this module is not linking against
2420 // the platform, so it gets the sysprop public stubs library instead. Replace
2421 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2422 dep = syspropDep.JavaInfo
2423 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002424 }
2425 switch tag {
2426 case bootClasspathTag:
2427 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002428 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002429 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002430 if _, ok := module.(*Plugin); ok {
2431 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2432 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002433 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002434 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002435 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2436 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2437 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2438 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002439 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2440 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2441 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002442
Colin Crossa14fb6a2024-10-23 16:57:06 -07002443 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002444 case java9LibTag:
2445 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002446 transitiveJava9ClasspathHeaderJars = append(transitiveJava9ClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002447 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002448 if _, ok := module.(*Plugin); ok {
2449 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2450 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002451 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2452 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2453 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2454 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2455 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2456 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2457 // Turbine doesn't run annotation processors, so any module that uses an
2458 // annotation processor that generates API is incompatible with the turbine
2459 // optimization.
2460 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002461 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002462
Colin Crossa14fb6a2024-10-23 16:57:06 -07002463 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2464 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, dep.TransitiveStaticLibsHeaderJars)
2465 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, dep.TransitiveStaticLibsImplementationJars)
2466 transitiveStaticJarsResourceLibs = append(transitiveStaticJarsResourceLibs, dep.TransitiveStaticLibsResourceJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002467 case pluginTag:
2468 if plugin, ok := module.(*Plugin); ok {
2469 if plugin.pluginProperties.Processor_class != nil {
2470 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2471 } else {
2472 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2473 }
2474 // Turbine doesn't run annotation processors, so any module that uses an
2475 // annotation processor that generates API is incompatible with the turbine
2476 // optimization.
2477 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2478 } else {
2479 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2480 }
2481 case errorpronePluginTag:
2482 if _, ok := module.(*Plugin); ok {
2483 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2484 } else {
2485 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2486 }
2487 case exportedPluginTag:
2488 if plugin, ok := module.(*Plugin); ok {
2489 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2490 if plugin.pluginProperties.Processor_class != nil {
2491 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2492 }
2493 // Turbine doesn't run annotation processors, so any module that uses an
2494 // annotation processor that generates API is incompatible with the turbine
2495 // optimization.
2496 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2497 } else {
2498 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2499 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002500 case kotlinPluginTag:
Luca Stefani50098f72024-10-12 17:55:31 +02002501 if _, ok := module.(*KotlinPlugin); ok {
2502 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
2503 } else {
2504 ctx.PropertyErrorf("kotlin_plugins", "%q is not a kotlin_plugin module", otherName)
2505 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002506 case syspropPublicStubDepTag:
2507 // This is a sysprop implementation library, forward the JavaInfoProvider from
2508 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002509 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002510 JavaInfo: dep,
2511 })
2512 }
2513 } else if dep, ok := module.(android.SourceFileProducer); ok {
2514 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002515 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002516 checkProducesJars(ctx, dep)
2517 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002518 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002519 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07002520 depset.New(depset.PREORDER, dep.Srcs(), nil))
Jaewoong Jung26342642021-03-17 15:56:23 -07002521 case staticLibTag:
2522 checkProducesJars(ctx, dep)
2523 deps.classpath = append(deps.classpath, dep.Srcs()...)
2524 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2525 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002526
Colin Crossa14fb6a2024-10-23 16:57:06 -07002527 depHeaderJars := depset.New(depset.PREORDER, dep.Srcs(), nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002528 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJars)
2529 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, depHeaderJars)
2530 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, depHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002531 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002532 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002533 switch tag {
2534 case staticLibTag:
2535 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2536 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002537 } else {
2538 switch tag {
2539 case bootClasspathTag:
2540 // If a system modules dependency has been added to the bootclasspath
2541 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002542 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002543 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002544 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars,
2545 sm.TransitiveStaticLibsHeaderJars)
Colin Crossb61c2262024-08-08 14:04:42 -07002546 } else {
2547 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2548 ctx.OtherModuleName(module))
2549 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002550
2551 case systemModulesTag:
2552 if deps.systemModules != nil {
2553 panic("Found two system module dependencies")
2554 }
Colin Crossb61c2262024-08-08 14:04:42 -07002555 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2556 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2557 } else {
2558 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2559 ctx.OtherModuleName(module))
2560 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002561
2562 case instrumentationForTag:
2563 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 -07002564 }
2565 }
2566
Spandan Das8aac9932024-07-18 23:14:13 +00002567 if android.InList(tag, compileDependencyTags) {
2568 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2569 j.compileDepNames = append(j.compileDepNames, otherName)
2570 }
2571
Jaewoong Jung26342642021-03-17 15:56:23 -07002572 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002573 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002574 })
2575
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002576 deps.transitiveStaticLibsHeaderJars = transitiveStaticJarsHeaderLibs
2577 deps.transitiveStaticLibsImplementationJars = transitiveStaticJarsImplementationLibs
2578 deps.transitiveStaticLibsResourceJars = transitiveStaticJarsResourceLibs
2579
2580 if ctx.Config().UseTransitiveJarsInClasspath() {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002581 depSet := depset.New(depset.PREORDER, nil, transitiveClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002582 deps.classpath = depSet.ToList()
Colin Crossa14fb6a2024-10-23 16:57:06 -07002583 depSet = depset.New(depset.PREORDER, nil, transitiveBootClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002584 deps.bootClasspath = depSet.ToList()
Colin Crossa14fb6a2024-10-23 16:57:06 -07002585 depSet = depset.New(depset.PREORDER, nil, transitiveJava9ClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002586 deps.java9Classpath = depSet.ToList()
2587 }
2588
2589 if ctx.Device() {
2590 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
2591 if sdkDep.invalidVersion {
2592 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2593 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2594 } else if sdkDep.useFiles {
2595 // sdkDep.jar is actually equivalent to turbine header.jar.
2596 deps.classpath = append(slices.Clone(classpath(sdkDep.jars)), deps.classpath...)
2597 deps.dexClasspath = append(slices.Clone(classpath(sdkDep.jars)), deps.dexClasspath...)
2598 deps.aidlPreprocess = sdkDep.aidl
2599 // Add the sdk module dependency to `compileDepNames`.
2600 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2601 // TODO (b/358608607): Move this to decodeSdkDep
2602 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2603 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
2604 } else {
2605 deps.aidlPreprocess = sdkDep.aidl
2606 }
2607 }
2608
Jaewoong Jung26342642021-03-17 15:56:23 -07002609 return deps
2610}
2611
Joe Onorato349ae8d2024-02-05 22:46:00 +00002612// Provider for jarjar renaming rules.
2613//
2614// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2615// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2616// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2617// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2618// be renamed from that module.
2619// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002620type DependencyUse int
2621
2622const (
2623 RenameUseInvalid DependencyUse = iota
2624 RenameUseInclude
2625 RenameUseExclude
2626)
2627
2628type RenameUseElement struct {
2629 DepName string
2630 RenameUse DependencyUse
2631 Why string // token for determining where in the logic the decision was made.
2632}
2633
Joe Onorato349ae8d2024-02-05 22:46:00 +00002634type JarJarProviderData struct {
2635 // Mapping of class names: original --> renamed. If the value is "", the class will be
2636 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2637 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002638 Rename map[string]string
2639 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002640}
2641
2642func (this JarJarProviderData) GetDebugString() string {
2643 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002644 for _, k := range android.SortedKeys(this.Rename) {
2645 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002646 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2647 result += k + "--&gt;" + v + ";"
2648 }
2649 }
2650 return result
2651}
2652
2653var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2654
2655var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2656
2657func init() {
2658 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
Yu Liu26a716d2024-08-30 23:40:32 +00002659
2660 gob.Register(BaseJarJarProviderData{})
Joe Onorato349ae8d2024-02-05 22:46:00 +00002661}
2662
2663// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2664// whether they are java modules or not.
2665type BaseJarJarProviderData struct {
2666 JarJarProviderData JarJarProviderData
2667}
2668
2669func (this BaseJarJarProviderData) GetDebugString() string {
2670 return this.JarJarProviderData.GetDebugString()
2671}
2672
2673var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2674
2675// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2676// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2677// either JarJarProvider or BaseJarJarProvider.
2678func mergeJarJarPrefixes(ctx android.ModuleContext) {
2679 mod := ctx.Module()
2680 // Explicitly avoid propagating into some module types.
2681 switch reflect.TypeOf(mod).String() {
2682 case "*java.Droidstubs":
2683 return
2684 }
2685 jarJarData := collectDirectDepsProviders(ctx)
2686 if jarJarData != nil {
2687 providerData := BaseJarJarProviderData{
2688 JarJarProviderData: *jarJarData,
2689 }
2690 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2691 }
2692
2693}
2694
2695// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2696func (module *Module) addJarJarRenameRule(original string, renamed string) {
2697 if module.jarjarRenameRules == nil {
2698 module.jarjarRenameRules = make(map[string]string)
2699 }
2700 module.jarjarRenameRules[original] = renamed
2701}
2702
2703func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2704 // Gather repackage information from deps
2705 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002706
2707 module := ctx.Module()
2708 moduleName := module.Name()
2709
Colin Cross648daea2024-09-12 14:35:29 -07002710 ctx.VisitDirectDeps(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002711 tag := ctx.OtherModuleDependencyTag(m)
2712 // This logic mirrors that in (*Module).collectDeps above. There are several places
2713 // where we explicitly return RenameUseExclude, even though it is the default, to
2714 // indicate that it has been verified to be the case.
2715 //
2716 // Note well: there are probably cases that are getting to the unconditional return
2717 // and are therefore wrong.
2718 shouldIncludeRenames := func() (DependencyUse, string) {
2719 if moduleName == m.Name() {
2720 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2721 }
2722 if sc, ok := module.(android.SdkContext); ok {
2723 if ctx.Device() {
2724 sdkDep := decodeSdkDep(ctx, sc)
2725 if !sdkDep.invalidVersion && sdkDep.useFiles {
2726 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002727 }
2728 }
LaMont Jones63683e42024-02-08 14:30:45 -08002729 }
2730 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2731 return RenameUseExclude, "tags"
2732 }
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002733 if _, ok := android.OtherModuleProvider(ctx, m, SdkLibraryInfoProvider); ok {
LaMont Jones63683e42024-02-08 14:30:45 -08002734 switch tag {
2735 case sdkLibTag, libTag:
2736 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2737 }
2738 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2739 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2740 switch ji.StubsLinkType {
2741 case Stubs:
2742 return RenameUseExclude, "info"
2743 case Implementation:
2744 return RenameUseInclude, "info"
2745 default:
LaMont Jones09721862024-06-11 10:30:50 -07002746 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002747 // Fall through to the heuristic logic.
2748 }
2749 switch reflect.TypeOf(m).String() {
2750 case "*java.GeneratedJavaLibraryModule":
2751 // Probably a java_aconfig_library module.
2752 // TODO: make this check better.
2753 return RenameUseInclude, "reflect"
2754 }
2755 switch tag {
2756 case bootClasspathTag:
2757 return RenameUseExclude, "tagswitch"
2758 case sdkLibTag, libTag, instrumentationForTag:
2759 return RenameUseInclude, "tagswitch"
2760 case java9LibTag:
2761 return RenameUseExclude, "tagswitch"
2762 case staticLibTag:
2763 return RenameUseInclude, "tagswitch"
2764 case pluginTag:
2765 return RenameUseInclude, "tagswitch"
2766 case errorpronePluginTag:
2767 return RenameUseInclude, "tagswitch"
2768 case exportedPluginTag:
2769 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002770 case kotlinPluginTag:
2771 return RenameUseInclude, "tagswitch"
2772 default:
2773 return RenameUseExclude, "tagswitch"
2774 }
2775 } else if _, ok := m.(android.SourceFileProducer); ok {
2776 switch tag {
2777 case sdkLibTag, libTag, staticLibTag:
2778 return RenameUseInclude, "srcfile"
2779 default:
2780 return RenameUseExclude, "srcfile"
2781 }
Yu Liu67a28422024-03-05 00:36:31 +00002782 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002783 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002784 } else {
2785 switch tag {
2786 case bootClasspathTag:
2787 return RenameUseExclude, "else"
2788 case systemModulesTag:
2789 return RenameUseInclude, "else"
2790 }
2791 }
2792 // If we got here, choose the safer option, which may lead to a build failure, rather
2793 // than runtime failures on the device.
2794 return RenameUseExclude, "end"
2795 }
2796
2797 if result == nil {
2798 result = &JarJarProviderData{
2799 Rename: make(map[string]string),
2800 RenameUse: make([]RenameUseElement, 0),
2801 }
2802 }
2803 how, why := shouldIncludeRenames()
2804 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2805 if how != RenameUseInclude {
2806 // Nothing to merge.
2807 return
2808 }
2809
2810 merge := func(theirs *JarJarProviderData) {
2811 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002812 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2813 result.Rename[orig] = renamed
2814 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2815 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2816 result.Rename[orig] = renamed
2817 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2818 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2819 continue
2820 }
2821 }
2822 }
2823 }
2824 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2825 merge(&theirs)
2826 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2827 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2828 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2829 // to java.Module.
2830 merge(&theirs.JarJarProviderData)
2831 }
2832 })
2833 return
2834}
2835
2836func (this Module) GetDebugString() string {
2837 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2838}
2839
2840// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2841// us, and if it's been set, apply the jarjar_prefix property to rename them.
2842func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2843 // Gather repackage information from deps
2844 result := collectDirectDepsProviders(ctx)
2845
Joe Onoratoa5d17172024-07-20 17:39:56 -07002846 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002847 if result == nil {
2848 result = &JarJarProviderData{
2849 Rename: make(map[string]string),
2850 }
2851 }
2852 if renamed != "" {
2853 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2854 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002855 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002856 }
2857 }
2858 (*result).Rename[orig] = renamed
2859 }
2860
Joe Onoratoa5d17172024-07-20 17:39:56 -07002861 // Update that with entries we've stored for ourself
2862 for orig, renamed := range module.jarjarRenameRules {
2863 add(orig, renamed)
2864 }
2865
2866 // Update that with entries given in the jarjar_rename property.
2867 for _, orig := range module.properties.Jarjar_rename {
2868 add(orig, "")
2869 }
2870
Joe Onorato349ae8d2024-02-05 22:46:00 +00002871 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2872 if result == nil {
2873 return nil
2874 }
2875
2876 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2877 // that have not yet been renamed.
2878 prefix := proptools.String(module.properties.Jarjar_prefix)
2879 if prefix != "" {
2880 if prefix[0] == '.' {
2881 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2882 return nil
2883 }
2884 if prefix[len(prefix)-1] == '.' {
2885 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2886 return nil
2887 }
2888
2889 var updated map[string]string
2890 for orig, renamed := range (*result).Rename {
2891 if renamed == "" {
2892 if updated == nil {
2893 updated = make(map[string]string)
2894 }
2895 updated[orig] = prefix + "." + orig
2896 }
2897 }
2898 for orig, renamed := range updated {
2899 (*result).Rename[orig] = renamed
2900 }
2901 }
2902
2903 return result
2904}
2905
2906// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2907// to "" won't be in this list because they shouldn't be renamed yet.
2908func getJarJarRuleText(provider *JarJarProviderData) string {
2909 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002910 for _, orig := range android.SortedKeys(provider.Rename) {
2911 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002912 if renamed != "" {
2913 result += "rule " + orig + " " + renamed + "\n"
2914 }
2915 }
2916 return result
2917}
2918
Zi Wangddb2ee52024-04-02 16:44:02 +00002919// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002920func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Zi Wangddb2ee52024-04-02 16:44:02 +00002921 if j.repackageJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002922 return infile, false
Zi Wangddb2ee52024-04-02 16:44:02 +00002923 }
Colin Crossedec77c2024-07-26 15:25:40 -07002924 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002925 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002926 return repackagedJarjarFile, true
Zi Wangddb2ee52024-04-02 16:44:02 +00002927}
2928
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002929func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Colin Crossedec77c2024-07-26 15:25:40 -07002930 if j.expandJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002931 return infile, false
Colin Crossedec77c2024-07-26 15:25:40 -07002932 }
2933 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2934 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002935 return jarjarFile, true
Colin Crossedec77c2024-07-26 15:25:40 -07002936
2937}
2938
Jaewoong Jung26342642021-03-17 15:56:23 -07002939func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2940 deps.processorPath = append(deps.processorPath, pluginJars...)
2941 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2942}
2943
2944// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2945// this interface.
2946type ProvidesUsesLib interface {
2947 ProvidesUsesLib() *string
2948}
2949
2950func (j *Module) ProvidesUsesLib() *string {
2951 return j.usesLibraryProperties.Provides_uses_lib
2952}
satayev1c564cc2021-05-25 19:50:30 +01002953
2954type ModuleWithStem interface {
2955 Stem() string
2956}
2957
2958var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002959
2960type ModuleWithUsesLibrary interface {
2961 UsesLibrary() *usesLibrary
2962}
2963
2964func (j *Module) UsesLibrary() *usesLibrary {
2965 return &j.usesLibrary
2966}
2967
2968var _ ModuleWithUsesLibrary = (*Module)(nil)