blob: 7e8d027694d940a6a68fc2bb824bd9e3f55496cd [file] [log] [blame]
Jaewoong Jung26342642021-03-17 15:56:23 -07001// Copyright 2021 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package java
16
17import (
Yu Liu26a716d2024-08-30 23:40:32 +000018 "encoding/gob"
Jaewoong Jung26342642021-03-17 15:56:23 -070019 "fmt"
20 "path/filepath"
Joe Onorato349ae8d2024-02-05 22:46:00 +000021 "reflect"
22 "slices"
Jaewoong Jung26342642021-03-17 15:56:23 -070023 "strconv"
24 "strings"
25
Colin Crossd788b3e2023-11-28 13:14:56 -080026 "github.com/google/blueprint"
Colin Crossa14fb6a2024-10-23 16:57:06 -070027 "github.com/google/blueprint/depset"
Jaewoong Jung26342642021-03-17 15:56:23 -070028 "github.com/google/blueprint/pathtools"
29 "github.com/google/blueprint/proptools"
30
31 "android/soong/android"
32 "android/soong/dexpreopt"
33 "android/soong/java/config"
34)
35
36// This file contains the definition and the implementation of the base module that most
37// source-based Java module structs embed.
38
39// TODO:
40// Autogenerated files:
41// Renderscript
42// Post-jar passes:
43// Proguard
44// Rmtypedefs
45// DroidDoc
46// Findbugs
47
48// Properties that are common to most Java modules, i.e. whether it's a host or device module.
49type CommonProperties struct {
50 // list of source files used to compile the Java module. May be .java, .kt, .logtags, .proto,
51 // or .aidl files.
52 Srcs []string `android:"path,arch_variant"`
53
54 // list Kotlin of source files containing Kotlin code that should be treated as common code in
55 // a codebase that supports Kotlin multiplatform. See
56 // https://kotlinlang.org/docs/reference/multiplatform.html. May be only be .kt files.
57 Common_srcs []string `android:"path,arch_variant"`
58
59 // list of source files that should not be used to build the Java module.
60 // This is most useful in the arch/multilib variants to remove non-common files
61 Exclude_srcs []string `android:"path,arch_variant"`
62
63 // list of directories containing Java resources
64 Java_resource_dirs []string `android:"arch_variant"`
65
66 // list of directories that should be excluded from java_resource_dirs
67 Exclude_java_resource_dirs []string `android:"arch_variant"`
68
69 // list of files to use as Java resources
Cole Faust7fd5b2e2024-10-29 11:22:20 -070070 Java_resources proptools.Configurable[[]string] `android:"path,arch_variant"`
Jaewoong Jung26342642021-03-17 15:56:23 -070071
72 // list of files that should be excluded from java_resources and java_resource_dirs
73 Exclude_java_resources []string `android:"path,arch_variant"`
74
Cole Faust65cb40a2024-10-21 15:41:42 -070075 // Same as java_resources, but modules added here will use the device variant. Can be useful
76 // for making a host test that tests the contents of a device built app.
Cole Faust7fd5b2e2024-10-29 11:22:20 -070077 Device_common_java_resources proptools.Configurable[[]string] `android:"path_device_common"`
Cole Faust65cb40a2024-10-21 15:41:42 -070078
79 // Same as java_resources, but modules added here will use the device's os variant and the
80 // device's first architecture variant. Can be useful for making a host test that tests the
81 // contents of a native device built app.
Cole Faust7fd5b2e2024-10-29 11:22:20 -070082 Device_first_java_resources proptools.Configurable[[]string] `android:"path_device_first"`
Cole Faust65cb40a2024-10-21 15:41:42 -070083
Jaewoong Jung26342642021-03-17 15:56:23 -070084 // list of module-specific flags that will be used for javac compiles
85 Javacflags []string `android:"arch_variant"`
86
87 // list of module-specific flags that will be used for kotlinc compiles
88 Kotlincflags []string `android:"arch_variant"`
89
90 // list of java libraries that will be in the classpath
91 Libs []string `android:"arch_variant"`
92
93 // list of java libraries that will be compiled into the resulting jar
Cole Faustb7493472024-08-28 11:55:52 -070094 Static_libs proptools.Configurable[[]string] `android:"arch_variant"`
Jaewoong Jung26342642021-03-17 15:56:23 -070095
96 // manifest file to be included in resulting jar
97 Manifest *string `android:"path"`
98
99 // if not blank, run jarjar using the specified rules file
100 Jarjar_rules *string `android:"path,arch_variant"`
101
Joe Onoratoa5d17172024-07-20 17:39:56 -0700102 // java class names to rename with jarjar when a reverse dependency has a jarjar_prefix
103 // property.
104 Jarjar_rename []string
105
Joe Onorato349ae8d2024-02-05 22:46:00 +0000106 // if not blank, used as prefix to generate repackage rule
107 Jarjar_prefix *string
108
Jaewoong Jung26342642021-03-17 15:56:23 -0700109 // If not blank, set the java version passed to javac as -source and -target
110 Java_version *string
111
112 // If set to true, allow this module to be dexed and installed on devices. Has no
113 // effect on host modules, which are always considered installable.
114 Installable *bool
115
116 // If set to true, include sources used to compile the module in to the final jar
117 Include_srcs *bool
118
119 // If not empty, classes are restricted to the specified packages and their sub-packages.
120 // This restriction is checked after applying jarjar rules and including static libs.
121 Permitted_packages []string
122
123 // List of modules to use as annotation processors
124 Plugins []string
125
Luca Stefani50098f72024-10-12 17:55:31 +0200126 // List of modules to use as kotlin plugin
127 Kotlin_plugins []string
128
Jaewoong Jung26342642021-03-17 15:56:23 -0700129 // List of modules to export to libraries that directly depend on this library as annotation
130 // processors. Note that if the plugins set generates_api: true this will disable the turbine
131 // optimization on modules that depend on this module, which will reduce parallelism and cause
132 // more recompilation.
133 Exported_plugins []string
134
135 // The number of Java source entries each Javac instance can process
136 Javac_shard_size *int64
137
138 // Add host jdk tools.jar to bootclasspath
139 Use_tools_jar *bool
140
141 Openjdk9 struct {
142 // List of source files that should only be used when passing -source 1.9 or higher
143 Srcs []string `android:"path"`
144
145 // List of javac flags that should only be used when passing -source 1.9 or higher
146 Javacflags []string
147 }
148
149 // When compiling language level 9+ .java code in packages that are part of
150 // a system module, patch_module names the module that your sources and
151 // dependencies should be patched into. The Android runtime currently
152 // doesn't implement the JEP 261 module system so this option is only
153 // supported at compile time. It should only be needed to compile tests in
154 // packages that exist in libcore and which are inconvenient to move
155 // elsewhere.
Liz Kammer0a470a32023-10-05 17:02:00 -0400156 Patch_module *string
Jaewoong Jung26342642021-03-17 15:56:23 -0700157
158 Jacoco struct {
159 // List of classes to include for instrumentation with jacoco to collect coverage
160 // information at runtime when building with coverage enabled. If unset defaults to all
161 // classes.
162 // Supports '*' as the last character of an entry in the list as a wildcard match.
163 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
164 // it matches classes in the package that have the class name as a prefix.
165 Include_filter []string
166
167 // List of classes to exclude from instrumentation with jacoco to collect coverage
168 // information at runtime when building with coverage enabled. Overrides classes selected
169 // by the include_filter property.
170 // Supports '*' as the last character of an entry in the list as a wildcard match.
171 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
172 // it matches classes in the package that have the class name as a prefix.
173 Exclude_filter []string
174 }
175
176 Errorprone struct {
177 // List of javac flags that should only be used when running errorprone.
178 Javacflags []string
179
180 // List of java_plugin modules that provide extra errorprone checks.
181 Extra_check_modules []string
Cole Faust75fffb12021-06-13 15:23:16 -0700182
Cole Faust2b1536e2021-06-18 12:25:54 -0700183 // This property can be in 3 states. When set to true, errorprone will
184 // be run during the regular build. When set to false, errorprone will
185 // never be run. When unset, errorprone will be run when the RUN_ERROR_PRONE
186 // environment variable is true. Setting this to false will improve build
187 // performance more than adding -XepDisableAllChecks in javacflags.
Cole Faust75fffb12021-06-13 15:23:16 -0700188 Enabled *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700189 }
190
191 Proto struct {
192 // List of extra options that will be passed to the proto generator.
193 Output_params []string
194 }
195
Sam Delmericoc7593722022-08-31 15:57:52 -0400196 // If true, then jacocoagent is automatically added as a libs dependency so that
197 // r8 will not strip instrumentation classes out of dexed libraries.
Jaewoong Jung26342642021-03-17 15:56:23 -0700198 Instrument bool `blueprint:"mutated"`
Paul Duffin0038a8d2022-05-03 00:28:40 +0000199 // If true, then the module supports statically including the jacocoagent
200 // into the library.
201 Supports_static_instrumentation bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700202
203 // List of files to include in the META-INF/services folder of the resulting jar.
204 Services []string `android:"path,arch_variant"`
205
206 // If true, package the kotlin stdlib into the jar. Defaults to true.
207 Static_kotlin_stdlib *bool `android:"arch_variant"`
208
209 // A list of java_library instances that provide additional hiddenapi annotations for the library.
210 Hiddenapi_additional_annotations []string
Joe Onorato175073c2023-06-01 14:42:59 -0700211
212 // Additional srcJars tacked in by GeneratedJavaLibraryModule
213 Generated_srcjars []android.Path `android:"mutated"`
Mark Whitea15790a2023-08-22 21:28:11 +0000214
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000215 // intermediate aconfig cache file tacked in by GeneratedJavaLibraryModule
216 Aconfig_Cache_files []android.Path `android:"mutated"`
217
Mark Whitea15790a2023-08-22 21:28:11 +0000218 // If true, then only the headers are built and not the implementation jar.
Liz Kammer60772632023-10-05 17:18:44 -0400219 Headers_only *bool
Cole Faust2b64af82023-12-13 18:22:18 -0800220
221 // A list of files or dependencies to make available to the build sandbox. This is
222 // useful if source files are symlinks, the targets of the symlinks must be listed here.
223 // Note that currently not all actions implemented by android_apps are sandboxed, so you
224 // may only see this being necessary in lint builds.
225 Compile_data []string `android:"path"`
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000226
227 // Property signifying whether the module compiles stubs or not.
228 // Should be set to true when srcs of this module are stub files.
229 // This property does not need to be set to true when the module depends on
230 // the stubs via libs, but should be set to true when the module depends on
231 // the stubs via static libs.
232 Is_stubs_module *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700233
Makoto Onuki7ded3822024-03-28 14:42:20 -0700234 Ravenizer struct {
John Wu989ee842024-10-04 00:21:43 +0000235 // If true, enable the "Ravenizer" tool on the output jar.
236 // "Ravenizer" is a tool for Ravenwood tests, but it can also be enabled on other kinds
237 // of java targets.
Makoto Onuki7ded3822024-03-28 14:42:20 -0700238 Enabled *bool
John Wu989ee842024-10-04 00:21:43 +0000239
240 // If true, the "Ravenizer" tool will remove all Mockito and DexMaker
241 // classes from the output jar.
242 Strip_mockito *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700243 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +0000244
245 // Contributing api surface of the stub module. Is not visible to bp modules, and should
246 // only be set for stub submodules generated by the java_sdk_library
247 Stub_contributing_api *string `blueprint:"mutated"`
Yihan Dong8be09c22024-08-29 15:32:13 +0800248
249 // If true, enable the "ApiMapper" tool on the output jar. "ApiMapper" is a tool to inject
250 // bytecode to log API calls.
251 ApiMapper bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700252}
253
254// Properties that are specific to device modules. Host module factories should not add these when
255// constructing a new module.
256type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000257 // If not blank, set to the version of the sdk to compile against.
Spandan Das1ccf5742022-10-14 16:51:23 +0000258 // Defaults to an empty string, which compiles the module against the private platform APIs.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000259 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000260 // 1) numerical API level, "current", "none", or "core_platform"
261 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
262 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
263 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700264 Sdk_version *string
265
satayev0a420e72021-11-29 17:25:52 +0000266 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
267 // Defaults to empty string "". See sdk_version for possible values.
268 Max_sdk_version *string
269
William Loh5a082f92022-05-17 20:21:50 +0000270 // if not blank, set the maxSdkVersion properties of permission and uses-permission tags.
271 // Defaults to empty string "". See sdk_version for possible values.
272 Replace_max_sdk_version_placeholder *string
273
Jaewoong Jung26342642021-03-17 15:56:23 -0700274 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000275 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700276 Target_sdk_version *string
277
278 // Whether to compile against the platform APIs instead of an SDK.
279 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000280 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700281 Platform_apis *bool
282
283 Aidl struct {
284 // Top level directories to pass to aidl tool
285 Include_dirs []string
286
287 // Directories rooted at the Android.bp file to pass to aidl tool
288 Local_include_dirs []string
289
290 // directories that should be added as include directories for any aidl sources of modules
291 // that depend on this module, as well as to aidl for this module.
292 Export_include_dirs []string
293
294 // whether to generate traces (for systrace) for this interface
295 Generate_traces *bool
296
297 // whether to generate Binder#GetTransaction name method.
298 Generate_get_transaction_name *bool
299
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100300 // whether all interfaces should be annotated with required permissions.
301 Enforce_permissions *bool
302
303 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
304 Enforce_permissions_exceptions []string `android:"path"`
305
Jaewoong Jung26342642021-03-17 15:56:23 -0700306 // list of flags that will be passed to the AIDL compiler
307 Flags []string
308 }
309
310 // If true, export a copy of the module as a -hostdex module for host testing.
311 Hostdex *bool
312
313 Target struct {
314 Hostdex struct {
315 // Additional required dependencies to add to -hostdex modules.
316 Required []string
317 }
318 }
319
320 // When targeting 1.9 and above, override the modules to use with --system,
321 // otherwise provides defaults libraries to add to the bootclasspath.
322 System_modules *string
323
Jaewoong Jung26342642021-03-17 15:56:23 -0700324 IsSDKLibrary bool `blueprint:"mutated"`
325
326 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
327 // Defaults to false.
328 V4_signature *bool
329
330 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
331 // public stubs library.
332 SyspropPublicStub string `blueprint:"mutated"`
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000333
334 HiddenAPIPackageProperties
335 HiddenAPIFlagFileProperties
Jaewoong Jung26342642021-03-17 15:56:23 -0700336}
337
yangbill2af0b6e2024-03-15 09:29:29 +0000338// Properties that can be overridden by overriding module (e.g. override_android_app)
339type OverridableProperties struct {
Jooyung Han01d80d82022-01-08 12:16:32 +0900340 // set the name of the output. If not set, `name` is used.
341 // To override a module with this property set, overriding module might need to set this as well.
342 // Otherwise, both the overridden and the overriding modules will have the same output name, which
343 // can cause the duplicate output error.
344 Stem *string
Spandan Dasb9c58352024-05-13 18:29:45 +0000345
346 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
347 // Defaults to sdk_version if not set. See sdk_version for possible values.
348 Min_sdk_version *string
Jooyung Han01d80d82022-01-08 12:16:32 +0900349}
350
Jaewoong Jung26342642021-03-17 15:56:23 -0700351// Functionality common to Module and Import
352//
353// It is embedded in Module so its functionality can be used by methods in Module
354// but it is currently only initialized by Import and Library.
355type embeddableInModuleAndImport struct {
356
357 // Functionality related to this being used as a component of a java_sdk_library.
358 EmbeddableSdkLibraryComponent
359}
360
Paul Duffin71b33cc2021-06-23 11:39:47 +0100361func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
362 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700363}
364
365// Module/Import's DepIsInSameApex(...) delegates to this method.
366//
367// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
368// the one provided by ApexModuleBase.
369func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
370 // dependencies other than the static linkage are all considered crossing APEX boundary
371 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
372 return true
373 }
374 return false
375}
376
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100377// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
378// or an invalid path describing the reason it is invalid.
379//
380// It is unset if a dex jar isn't applicable, i.e. no build rule has been
381// requested to create one.
382//
383// If a dex jar has been requested to be built then it is set, and it may be
384// either a valid android.Path, or invalid with a reason message. The latter
385// happens if the source that should produce the dex file isn't able to.
386//
387// E.g. it is invalid with a reason message if there is a prebuilt APEX that
388// could produce the dex jar through a deapexer module, but the APEX isn't
389// installable so doing so wouldn't be safe.
390type OptionalDexJarPath struct {
391 isSet bool
392 path android.OptionalPath
393}
394
395// IsSet returns true if a path has been set, either invalid or valid.
396func (o OptionalDexJarPath) IsSet() bool {
397 return o.isSet
398}
399
400// Valid returns true if there is a path that is valid.
401func (o OptionalDexJarPath) Valid() bool {
402 return o.isSet && o.path.Valid()
403}
404
405// Path returns the valid path, or panics if it's either not set or is invalid.
406func (o OptionalDexJarPath) Path() android.Path {
407 if !o.isSet {
408 panic("path isn't set")
409 }
410 return o.path.Path()
411}
412
413// PathOrNil returns the path if it's set and valid, or else nil.
414func (o OptionalDexJarPath) PathOrNil() android.Path {
415 if o.Valid() {
416 return o.Path()
417 }
418 return nil
419}
420
421// InvalidReason returns the reason for an invalid path, which is never "". It
422// returns "" for an unset or valid path.
423func (o OptionalDexJarPath) InvalidReason() string {
424 if !o.isSet {
425 return ""
426 }
427 return o.path.InvalidReason()
428}
429
430func (o OptionalDexJarPath) String() string {
431 if !o.isSet {
432 return "<unset>"
433 }
434 return o.path.String()
435}
436
437// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
438func makeUnsetDexJarPath() OptionalDexJarPath {
439 return OptionalDexJarPath{isSet: false}
440}
441
442// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
443// the given OptionalPath, which may be valid or invalid.
444func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
445 return OptionalDexJarPath{isSet: true, path: path}
446}
447
448// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
449// valid given path. It returns an unset OptionalDexJarPath if the given path is
450// nil.
451func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
452 if path == nil {
453 return makeUnsetDexJarPath()
454 }
455 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
456}
457
Jaewoong Jung26342642021-03-17 15:56:23 -0700458// Module contains the properties and members used by all java module types
459type Module struct {
460 android.ModuleBase
461 android.DefaultableModuleBase
462 android.ApexModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700463
464 // Functionality common to Module and Import.
465 embeddableInModuleAndImport
466
467 properties CommonProperties
468 protoProperties android.ProtoProperties
469 deviceProperties DeviceProperties
470
yangbill2af0b6e2024-03-15 09:29:29 +0000471 overridableProperties OverridableProperties
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700472 sourceProperties android.SourceProperties
Jooyung Han01d80d82022-01-08 12:16:32 +0900473
Jaewoong Jung26342642021-03-17 15:56:23 -0700474 // jar file containing header classes including static library dependencies, suitable for
475 // inserting into the bootclasspath/classpath of another compile
476 headerJarFile android.Path
477
478 // jar file containing implementation classes including static library dependencies but no
479 // resources
480 implementationJarFile android.Path
481
Jaewoong Jung26342642021-03-17 15:56:23 -0700482 // args and dependencies to package source files into a srcjar
483 srcJarArgs []string
484 srcJarDeps android.Paths
485
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000486 // the source files of this module and all its static dependencies
Colin Crossa14fb6a2024-10-23 16:57:06 -0700487 transitiveSrcFiles depset.DepSet[android.Path]
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000488
Jaewoong Jung26342642021-03-17 15:56:23 -0700489 // jar file containing implementation classes and resources including static library
490 // dependencies
491 implementationAndResourcesJar android.Path
492
493 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100494 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700495
496 // output file containing uninstrumented classes that will be instrumented by jacoco
497 jacocoReportClassesFile android.Path
498
499 // output file of the module, which may be a classes jar or a dex jar
500 outputFile android.Path
501 extraOutputFiles android.Paths
502
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100503 exportAidlIncludeDirs android.Paths
504 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700505
506 logtagsSrcs android.Paths
507
508 // installed file for binary dependency
509 installFile android.Path
510
Colin Cross3108ce12021-11-10 14:38:50 -0800511 // installed file for hostdex copy
512 hostdexInstallFile android.InstallPath
513
Chaohui Wangdcbe33c2022-10-11 11:13:30 +0800514 // list of unique .java and .kt source files
515 uniqueSrcFiles android.Paths
516
517 // list of srcjars that was passed to javac
518 compiledSrcJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700519
520 // manifest file to use instead of properties.Manifest
521 overrideManifest android.OptionalPath
522
Jaewoong Jung26342642021-03-17 15:56:23 -0700523 // list of plugins that this java module is exporting
524 exportedPluginJars android.Paths
525
526 // list of plugins that this java module is exporting
527 exportedPluginClasses []string
528
529 // if true, the exported plugins generate API and require disabling turbine.
530 exportedDisableTurbine bool
531
532 // list of source files, collected from srcFiles with unique java and all kt files,
533 // will be used by android.IDEInfo struct
534 expandIDEInfoCompiledSrcs []string
535
536 // expanded Jarjar_rules
537 expandJarjarRules android.Path
538
Joe Onorato349ae8d2024-02-05 22:46:00 +0000539 // jarjar rule for inherited jarjar rules
540 repackageJarjarRules android.Path
541
Jaewoong Jung26342642021-03-17 15:56:23 -0700542 // Extra files generated by the module type to be added as java resources.
543 extraResources android.Paths
544
545 hiddenAPI
546 dexer
547 dexpreopter
548 usesLibrary
549 linter
550
551 // list of the xref extraction files
Spandan Das1028d5a2024-08-19 21:45:48 +0000552 kytheFiles android.Paths
553 kytheKotlinFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700554
Jaewoong Jung26342642021-03-17 15:56:23 -0700555 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900556
557 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000558 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000559 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400560
561 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000562
563 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000564
565 // output file name based on Stem property.
566 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
567 // or the module should override Stem().
568 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700569
Joe Onorato349ae8d2024-02-05 22:46:00 +0000570 // Values that will be set in the JarJarProvider data for jarjar repackaging,
571 // and merged with our dependencies' rules.
572 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000573
574 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000575
576 // Paths to the aconfig intermediate cache files that are provided by the
577 // java_aconfig_library or java_library modules that are statically linked
578 // to this module. Does not contain cache files from all transitive dependencies.
579 aconfigCacheFiles android.Paths
Spandan Das8aac9932024-07-18 23:14:13 +0000580
581 // List of soong module dependencies required to compile the current module.
582 // This information is printed out to `Dependencies` field in module_bp_java_deps.json
583 compileDepNames []string
Makoto Onuki7ded3822024-03-28 14:42:20 -0700584
585 ravenizer struct {
586 enabled bool
587 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700588}
589
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000590var _ android.InstallableModule = (*Module)(nil)
591
592// To satisfy the InstallableModule interface
Jihoon Kang224ea082024-08-12 22:38:16 +0000593func (j *Module) StaticDependencyTags() []blueprint.DependencyTag {
594 return []blueprint.DependencyTag{staticLibTag}
595}
596
597// To satisfy the InstallableModule interface
598func (j *Module) DynamicDependencyTags() []blueprint.DependencyTag {
599 return []blueprint.DependencyTag{libTag, sdkLibTag, bootClasspathTag, systemModulesTag,
600 instrumentationForTag, java9LibTag}
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000601}
602
603// Overrides android.ModuleBase.InstallInProduct()
604func (j *Module) InstallInProduct() bool {
605 return j.ProductSpecific()
606}
607
Jihoon Kang85bc1932024-07-01 17:04:46 +0000608var _ android.StubsAvailableModule = (*Module)(nil)
609
610// To safisfy the StubsAvailableModule interface
611func (j *Module) IsStubsModule() bool {
612 return proptools.Bool(j.properties.Is_stubs_module)
613}
614
Jiyong Park92315372021-04-02 08:45:46 +0900615func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
616 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900617 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700618 return nil
619 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900620 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000621 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700622 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
623 } else {
624 // Treat stable core platform as stable.
625 return nil
626 }
627 } else {
628 return fmt.Errorf("non stable SDK %v", sdkVersion)
629 }
630}
631
632// checkSdkVersions enforces restrictions around SDK dependencies.
633func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
634 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900635 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900636 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700637 ctx.PropertyErrorf("sdk_version",
638 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
639 }
640 }
641 }
642
643 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
644 // See rank() for details.
645 ctx.VisitDirectDeps(func(module android.Module) {
646 tag := ctx.OtherModuleDependencyTag(module)
647 switch module.(type) {
648 // TODO(satayev): cover other types as well, e.g. imports
649 case *Library, *AndroidLibrary:
650 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400651 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700652 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
653 }
654 }
655 })
656}
657
658func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900659 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700660 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900661 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700662 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000663 ctx.PropertyErrorf("platform_apis", "This module has conflicting settings. sdk_version is not empty, which means this module cannot use platform APIs. However platform_apis is set to true.")
Jaewoong Jung26342642021-03-17 15:56:23 -0700664 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000665 ctx.PropertyErrorf("platform_apis", "This module has conflicting settings. sdk_version is empty, which means that this module is build against platform APIs. However platform_apis is not set to true")
Jaewoong Jung26342642021-03-17 15:56:23 -0700666 }
667
668 }
669}
670
Mark Whitea15790a2023-08-22 21:28:11 +0000671func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
672 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400673 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000674 installable := proptools.Bool(j.properties.Installable)
675
676 if headersOnly && installable {
677 ctx.PropertyErrorf("headers_only", "This module has conflicting settings. headers_only is true which, which means this module doesn't generate an implementation jar. However installable is set to true.")
678 }
679 }
680}
681
Jaewoong Jung26342642021-03-17 15:56:23 -0700682func (j *Module) addHostProperties() {
683 j.AddProperties(
684 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000685 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700686 &j.protoProperties,
687 &j.usesLibraryProperties,
688 )
689}
690
691func (j *Module) addHostAndDeviceProperties() {
692 j.addHostProperties()
693 j.AddProperties(
694 &j.deviceProperties,
695 &j.dexer.dexProperties,
696 &j.dexpreoptProperties,
697 &j.linter.properties,
698 )
699}
700
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000701// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
702// makes it available through the hiddenAPIPropertyInfoProvider.
703func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
704 hiddenAPIInfo := newHiddenAPIPropertyInfo()
705
706 // Populate with flag file paths from the properties.
707 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
708
709 // Populate with package rules from the properties.
710 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
711
Colin Cross40213022023-12-13 15:19:49 -0800712 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000713}
714
mrziwang9f7b9f42024-07-10 12:18:06 -0700715// helper method for java modules to set OutputFilesProvider
716func setOutputFiles(ctx android.ModuleContext, m Module) {
Cole Faust5146e782024-11-15 14:47:49 -0800717 ctx.SetOutputFiles(append(android.PathsIfNonNil(m.outputFile), m.extraOutputFiles...), "")
718 ctx.SetOutputFiles(android.PathsIfNonNil(m.outputFile), android.DefaultDistTag)
719 ctx.SetOutputFiles(android.PathsIfNonNil(m.implementationAndResourcesJar), ".jar")
720 ctx.SetOutputFiles(android.PathsIfNonNil(m.headerJarFile), ".hjar")
mrziwang9f7b9f42024-07-10 12:18:06 -0700721 if m.dexer.proguardDictionary.Valid() {
722 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
723 }
724 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
Jaewoong Jung26342642021-03-17 15:56:23 -0700725}
726
Jaewoong Jung26342642021-03-17 15:56:23 -0700727func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
728 initJavaModule(module, hod, false)
729}
730
731func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
732 initJavaModule(module, hod, true)
733}
734
735func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
736 multilib := android.MultilibCommon
737 if multiTargets {
738 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
739 } else {
740 android.InitAndroidArchModule(module, hod, multilib)
741 }
742 android.InitDefaultableModule(module)
743}
744
745func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
746 return j.properties.Instrument &&
747 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
748 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
749}
750
Yihan Dong8be09c22024-08-29 15:32:13 +0800751func (j *Module) shouldApiMapper() bool {
752 return j.properties.ApiMapper
753}
754
Jaewoong Jung26342642021-03-17 15:56:23 -0700755func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000756 return j.properties.Supports_static_instrumentation &&
757 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700758 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
759 ctx.Config().UnbundledBuild())
760}
761
762func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
763 // Force enable the instrumentation for java code that is built for APEXes ...
764 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
765 // doesn't make sense) or framework libraries (e.g. libraries found in the InstrumentFrameworkModules list) unless EMMA_INSTRUMENT_FRAMEWORK is true.
Colin Crossff694a82023-12-13 15:54:49 -0800766 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700767 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000768
Jihoon Kang46d66de2024-05-22 22:42:39 +0000769 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700770 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
771 return true
772 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
773 return true
774 }
775 }
776 return false
777}
778
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400779func (j *Module) setInstrument(value bool) {
780 j.properties.Instrument = value
781}
782
Yihan Dong8be09c22024-08-29 15:32:13 +0800783func (j *Module) setApiMapper(value bool) {
784 j.properties.ApiMapper = value
785}
786
Jiyong Park92315372021-04-02 08:45:46 +0900787func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
788 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700789}
790
Jiyong Parkf1691d22021-03-29 20:11:58 +0900791func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700792 return proptools.String(j.deviceProperties.System_modules)
793}
794
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000795func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000796 if j.overridableProperties.Min_sdk_version != nil {
797 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700798 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000799 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700800}
801
Yu Liuf2b94012023-09-19 15:09:10 -0700802func (j *Module) GetDeviceProperties() *DeviceProperties {
803 return &j.deviceProperties
804}
805
Spandan Dasa26eda72023-03-02 00:56:06 +0000806func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
807 if j.deviceProperties.Max_sdk_version != nil {
808 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
809 }
810 // Default is PrivateApiLevel
811 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000812}
813
Spandan Dasa26eda72023-03-02 00:56:06 +0000814func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
815 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
816 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
817 }
818 // Default is PrivateApiLevel
819 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000820}
821
Jiyong Parkf1691d22021-03-29 20:11:58 +0900822func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000823 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900824}
825
Spandan Dasca70fc42023-03-01 23:38:49 +0000826func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900827 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000828 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900829 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000830 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700831}
832
833func (j *Module) AvailableFor(what string) bool {
834 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
835 // Exception: for hostdex: true libraries, the platform variant is created
836 // even if it's not marked as available to platform. In that case, the platform
837 // variant is used only for the hostdex and not installed to the device.
838 return true
839 }
840 return j.ApexModuleBase.AvailableFor(what)
841}
842
Cole Faustb7493472024-08-28 11:55:52 -0700843func (j *Module) staticLibs(ctx android.BaseModuleContext) []string {
Jihoon Kang8bce3812024-09-30 18:46:51 +0000844 return j.properties.Static_libs.GetOrDefault(ctx, nil)
Cole Faustb7493472024-08-28 11:55:52 -0700845}
846
Jaewoong Jung26342642021-03-17 15:56:23 -0700847func (j *Module) deps(ctx android.BottomUpMutatorContext) {
848 if ctx.Device() {
849 j.linter.deps(ctx)
850
Jiyong Parkf1691d22021-03-29 20:11:58 +0900851 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700852
853 if j.deviceProperties.SyspropPublicStub != "" {
854 // This is a sysprop implementation library that has a corresponding sysprop public
855 // stubs library, and a dependency on it so that dependencies on the implementation can
856 // be forwarded to the public stubs library when necessary.
857 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
858 }
859 }
860
861 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000862
Cole Faustb7493472024-08-28 11:55:52 -0700863 ctx.AddVariationDependencies(nil, staticLibTag, j.staticLibs(ctx)...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700864
865 // Add dependency on libraries that provide additional hidden api annotations.
866 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
867
Jaewoong Jung26342642021-03-17 15:56:23 -0700868 // For library dependencies that are component libraries (like stubs), add the implementation
869 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
870 for _, dep := range libDeps {
871 if dep != nil {
872 if component, ok := dep.(SdkLibraryComponentDependency); ok {
873 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000874 // Add library as optional if it's one of the optional compatibility libs or it's
875 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100876 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000877 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
Cole Faust64f2d842024-10-17 13:28:34 -0700878 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs.GetOrDefault(ctx, nil)) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100879 tag = usesLibOptTag
880 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100881 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700882 }
883 }
884 }
885 }
886
887 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Luca Stefani50098f72024-10-12 17:55:31 +0200888 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag, j.properties.Kotlin_plugins...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700889 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
890 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
891
892 android.ProtoDeps(ctx, &j.protoProperties)
893 if j.hasSrcExt(".proto") {
894 protoDeps(ctx, &j.protoProperties)
895 }
896
897 if j.hasSrcExt(".kt") {
898 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
899 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700900 tag := staticLibTag
901 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
902 tag = libTag
903 }
904 ctx.AddVariationDependencies(nil, tag,
905 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700906 }
907
908 // Framework libraries need special handling in static coverage builds: they should not have
909 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
910 // the same jacoco classes coming from different bootclasspath jars.
911 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
912 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
913 j.properties.Instrument = true
914 }
915 } else if j.shouldInstrumentStatic(ctx) {
916 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
917 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700918
Cole Faustb7493472024-08-28 11:55:52 -0700919 if j.useCompose(ctx) {
Colin Crossa1ff7c62021-09-17 14:11:52 -0700920 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
Luca Stefani50098f72024-10-12 17:55:31 +0200921 "androidx.compose.compiler_compiler-hosted-plugin")
Colin Crossa1ff7c62021-09-17 14:11:52 -0700922 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700923}
924
925func hasSrcExt(srcs []string, ext string) bool {
926 for _, src := range srcs {
927 if filepath.Ext(src) == ext {
928 return true
929 }
930 }
931
932 return false
933}
934
935func (j *Module) hasSrcExt(ext string) bool {
936 return hasSrcExt(j.properties.Srcs, ext)
937}
938
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100939func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
940 var flags string
941
942 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
943 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
944 flags = "-Wmissing-permission-annotation -Werror"
945 }
946 }
947 return flags
948}
949
Jaewoong Jung26342642021-03-17 15:56:23 -0700950func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000951 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700952
953 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
954 aidlIncludes = append(aidlIncludes,
955 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
956 aidlIncludes = append(aidlIncludes,
957 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
958
959 var flags []string
960 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000961 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700962
963 flags = append(flags, j.deviceProperties.Aidl.Flags...)
964
965 if aidlPreprocess.Valid() {
966 flags = append(flags, "-p"+aidlPreprocess.String())
967 deps = append(deps, aidlPreprocess.Path())
968 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000969 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700970 }
971
972 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000973 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700974 }
975
976 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000977 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700978 }
979
Sam Delmerico2351eac2022-05-24 17:10:02 +0000980 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700981 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000982 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700983 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000984 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
985 // add flags for dirs containing AIDL srcs that haven't been specified yet
986 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -0700987
Zim8774ae12022-08-17 11:46:34 +0100988 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +0000989 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +0100990 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700991 flags = append(flags, "-t")
992 }
993
994 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
995 flags = append(flags, "--transaction_names")
996 }
997
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100998 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
999 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
1000 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1001 }
1002
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001003 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001004 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1005
Jaewoong Jung26342642021-03-17 15:56:23 -07001006 return strings.Join(flags, " "), deps
1007}
1008
1009func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1010
1011 var flags javaBuilderFlags
1012
1013 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001014 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001015
Cole Faust2b1536e2021-06-18 12:25:54 -07001016 epEnabled := j.properties.Errorprone.Enabled
1017 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001018 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001019 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1020 }
1021
1022 errorProneFlags := []string{
1023 "-Xplugin:ErrorProne",
1024 "${config.ErrorProneChecks}",
1025 }
1026 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1027
Colin Cross8bf6cad2022-02-28 13:07:03 -08001028 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001029 "'" + strings.Join(errorProneFlags, " ") + "'"
1030 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1031 }
1032
1033 // classpath
1034 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1035 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001036 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001037 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1038 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1039 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1040
1041 flags.processors = append(flags.processors, deps.processorClasses...)
1042 flags.processors = android.FirstUniqueStrings(flags.processors)
1043
1044 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001045 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001046 // Give host-side tools a version of OpenJDK's standard libraries
1047 // close to what they're targeting. As of Dec 2017, AOSP is only
1048 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1049 //
1050 // When building with OpenJDK 8, the following should have no
1051 // effect since those jars would be available by default.
1052 //
1053 // When building with OpenJDK 9 but targeting a version < 1.8,
1054 // putting them on the bootclasspath means that:
1055 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1056 // b) references to existing APIs are not reinterpreted in an
1057 // OpenJDK 9-specific way, eg. calls to subclasses of
1058 // java.nio.Buffer as in http://b/70862583
1059 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1060 flags.bootClasspath = append(flags.bootClasspath,
1061 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1062 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1063 if Bool(j.properties.Use_tools_jar) {
1064 flags.bootClasspath = append(flags.bootClasspath,
1065 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1066 }
1067 }
1068
1069 // systemModules
1070 flags.systemModules = deps.systemModules
1071
Jaewoong Jung26342642021-03-17 15:56:23 -07001072 return flags
1073}
1074
1075func (j *Module) collectJavacFlags(
1076 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1077 // javac flags.
1078 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001079 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001080
Mythri Alle4b9f6182023-10-25 15:17:11 +00001081 needsDebugInfo = false
1082 for _, flag := range javacFlags {
1083 if strings.HasPrefix(flag, "-g") {
1084 needsDebugInfo = true
1085 }
1086 }
1087
1088 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001089 // For non-host binaries, override the -g flag passed globally to remove
1090 // local variable debug info to reduce disk and memory usage.
1091 javacFlags = append(javacFlags, "-g:source,lines")
1092 }
1093 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1094
1095 if flags.javaVersion.usesJavaModules() {
1096 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001097 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1098 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1099 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1100 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001101
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001102 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001103 if j.properties.Patch_module != nil {
1104 // Manually specify build directory in case it is not under the repo root.
1105 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1106 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001107 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001108
Jaewoong Jung26342642021-03-17 15:56:23 -07001109 classPath := flags.classpath.FormJavaClassPath("")
1110 if classPath != "" {
1111 patchPaths = append(patchPaths, classPath)
1112 }
1113 javacFlags = append(
1114 javacFlags,
1115 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1116 }
1117 }
1118
1119 if len(javacFlags) > 0 {
1120 // optimization.
1121 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1122 flags.javacFlags = "$javacFlags"
1123 }
1124
1125 return flags
1126}
1127
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001128func (j *Module) AddJSONData(d *map[string]interface{}) {
1129 (&j.ModuleBase).AddJSONData(d)
1130 (*d)["Java"] = map[string]interface{}{
1131 "SourceExtensions": j.sourceExtensions,
1132 }
1133
1134}
1135
usta0391ca42023-09-19 15:51:59 -04001136func (j *Module) addGeneratedSrcJars(path android.Path) {
1137 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001138}
1139
Colin Crossfdaa6722024-08-23 11:58:08 -07001140func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars, extraDepCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001141 // Auto-propagating jarjar rules
1142 jarjarProviderData := j.collectJarJarRules(ctx)
1143 if jarjarProviderData != nil {
1144 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wangddb2ee52024-04-02 16:44:02 +00001145 text := getJarJarRuleText(jarjarProviderData)
1146 if text != "" {
1147 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1148 android.WriteFileRule(ctx, ruleTextFile, text)
1149 j.repackageJarjarRules = ruleTextFile
Joe Onorato349ae8d2024-02-05 22:46:00 +00001150 }
1151 }
1152
Jaewoong Jung26342642021-03-17 15:56:23 -07001153 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1154
John Wu989ee842024-10-04 00:21:43 +00001155 // Only override the original value if explicitly set
1156 if j.properties.Ravenizer.Enabled != nil {
1157 j.ravenizer.enabled = *j.properties.Ravenizer.Enabled
Makoto Onuki7ded3822024-03-28 14:42:20 -07001158 }
1159
Jaewoong Jung26342642021-03-17 15:56:23 -07001160 deps := j.collectDeps(ctx)
1161 flags := j.collectBuilderFlags(ctx, deps)
1162
1163 if flags.javaVersion.usesJavaModules() {
1164 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001165 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1166 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1167 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001168 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001169
Jaewoong Jung26342642021-03-17 15:56:23 -07001170 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001171 j.sourceExtensions = []string{}
1172 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1173 if hasSrcExt(srcFiles.Strings(), ext) {
1174 j.sourceExtensions = append(j.sourceExtensions, ext)
1175 }
1176 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001177 if hasSrcExt(srcFiles.Strings(), ".proto") {
1178 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1179 }
1180
1181 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1182 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1183 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1184 }
1185
Sam Delmerico2351eac2022-05-24 17:10:02 +00001186 aidlSrcs := srcFiles.FilterByExt(".aidl")
1187 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1188
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001189 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001190 srcFiles = j.genSources(ctx, srcFiles, flags)
1191
1192 // Collect javac flags only after computing the full set of srcFiles to
1193 // ensure that the --patch-module lookup paths are complete.
1194 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1195
1196 srcJars := srcFiles.FilterByExt(".srcjar")
1197 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001198 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001199 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001200 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001201
1202 if j.properties.Jarjar_rules != nil {
1203 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1204 }
1205
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001206 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001207
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001208 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001209 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001210 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001211 if _, found := set[v.String()]; !found {
1212 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001213 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001214 }
1215 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001216 var uniqueKtFiles android.Paths
1217 for _, v := range srcFiles.FilterByExt(".kt") {
1218 if _, found := set[v.String()]; !found {
1219 set[v.String()] = true
1220 uniqueKtFiles = append(uniqueKtFiles, v)
1221 }
1222 }
1223
1224 var uniqueSrcFiles android.Paths
1225 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1226 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1227 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001228 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001229
Colin Crossb5db4012022-03-28 17:12:39 -07001230 // We don't currently run annotation processors in turbine, which means we can't use turbine
1231 // generated header jars when an annotation processor that generates API is enabled. One
1232 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1233 // is used to run all of the annotation processors.
1234 disableTurbine := deps.disableTurbine
1235
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001236 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001237 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1238
Colin Cross220a9a12022-03-28 17:08:01 -07001239 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001240
Colin Cross4eae06d2023-06-20 22:40:02 -07001241 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1242 // any dependencies so that it can override any non-final R classes from dependencies with the
1243 // final R classes from the app.
1244 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1245
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001246 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1247
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001248 var localImplementationJars android.Paths
1249
Mark Whitea15790a2023-08-22 21:28:11 +00001250 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001251 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001252 if srcFiles.HasExt(".kt") {
1253 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1254 }
1255 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1256 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1257 }
1258
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001259 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1260
1261 localHeaderJars, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
Colin Crossedec77c2024-07-26 15:25:40 -07001262 extraCombinedJars)
1263
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001264 combinedHeaderJarFile, jarjared := j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1265 if jarjared {
1266 localHeaderJars = android.Paths{combinedHeaderJarFile}
1267 transitiveStaticLibsHeaderJars = nil
1268 }
1269 combinedHeaderJarFile, repackaged := j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
1270 if repackaged {
1271 localHeaderJars = android.Paths{combinedHeaderJarFile}
1272 transitiveStaticLibsHeaderJars = nil
1273 }
Mark Whitea15790a2023-08-22 21:28:11 +00001274 if ctx.Failed() {
1275 return
1276 }
Colin Crossedec77c2024-07-26 15:25:40 -07001277 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001278
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001279 if ctx.Config().UseTransitiveJarsInClasspath() {
1280 if len(localHeaderJars) > 0 {
1281 ctx.CheckbuildFile(localHeaderJars...)
1282 } else {
1283 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1284 ctx.UncheckedModule()
1285 }
1286 } else {
1287 ctx.CheckbuildFile(j.headerJarFile)
1288 }
Colin Crossa6182ab2024-08-21 10:47:44 -07001289
Colin Cross7727c7f2024-07-18 15:36:32 -07001290 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001291 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001292 LocalHeaderJars: localHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001293 TransitiveStaticLibsHeaderJars: depset.New(depset.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Cross9ffaf282024-08-12 13:50:09 -07001294 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1295 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001296 AidlIncludeDirs: j.exportAidlIncludeDirs,
1297 ExportedPlugins: j.exportedPluginJars,
1298 ExportedPluginClasses: j.exportedPluginClasses,
1299 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1300 StubsLinkType: j.stubsLinkType,
1301 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001302 })
1303
1304 j.outputFile = j.headerJarFile
1305 return
1306 }
1307
Jaewoong Jung26342642021-03-17 15:56:23 -07001308 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001309 // When using kotlin sources turbine is used to generate annotation processor sources,
1310 // including for annotation processors that generate API, so we can use turbine for
1311 // java sources too.
1312 disableTurbine = false
1313
Jaewoong Jung26342642021-03-17 15:56:23 -07001314 // user defined kotlin flags.
1315 kotlincFlags := j.properties.Kotlincflags
1316 CheckKotlincFlags(ctx, kotlincFlags)
1317
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001318 // Workaround for KT-46512
1319 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001320
1321 // If there are kotlin files, compile them first but pass all the kotlin and java files
1322 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1323 // won't emit any classes for them.
1324 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1325 if ctx.Device() {
1326 kotlincFlags = append(kotlincFlags, "-no-jdk")
1327 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001328
1329 for _, plugin := range deps.kotlinPlugins {
1330 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1331 }
1332 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1333
Jaewoong Jung26342642021-03-17 15:56:23 -07001334 if len(kotlincFlags) > 0 {
1335 // optimization.
1336 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1337 flags.kotlincFlags += "$kotlincFlags"
1338 }
1339
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001340 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001341 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1342
Jaewoong Jung26342642021-03-17 15:56:23 -07001343 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1344 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1345
Isaac Chioua23d9942022-04-06 06:14:38 +00001346 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001347 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001348 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1349 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001350 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001351 srcJars = append(srcJars, kaptSrcJar)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001352 localImplementationJars = append(localImplementationJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001353 // Disable annotation processing in javac, it's already been handled by kapt
1354 flags.processorPath = nil
1355 flags.processors = nil
1356 }
1357
1358 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001359 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Spandan Das1028d5a2024-08-19 21:45:48 +00001360 j.kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001361 if ctx.Failed() {
1362 return
1363 }
1364
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001365 kotlinJarPath, _ := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001366
Isaac Chioua23d9942022-04-06 06:14:38 +00001367 // Make javac rule depend on the kotlinc rule
1368 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1369
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001370 localImplementationJars = append(localImplementationJars, kotlinJarPath)
1371
Colin Cross220a9a12022-03-28 17:08:01 -07001372 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001373 }
1374
Jaewoong Jung26342642021-03-17 15:56:23 -07001375 j.compiledSrcJars = srcJars
1376
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001377 transitiveStaticLibsHeaderJars := deps.transitiveStaticLibsHeaderJars
1378
Jaewoong Jung26342642021-03-17 15:56:23 -07001379 enableSharding := false
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001380 var localHeaderJars android.Paths
1381 var shardingHeaderJars android.Paths
1382 var repackagedHeaderJarFile android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001383 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001384 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1385 enableSharding = true
1386 // Formerly, there was a check here that prevented annotation processors
1387 // from being used when sharding was enabled, as some annotation processors
1388 // do not function correctly in sharded environments. It was removed to
1389 // allow for the use of annotation processors that do function correctly
1390 // with sharding enabled. See: b/77284273.
1391 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001392 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001393 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001394 var combinedHeaderJarFile android.Path
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001395 localHeaderJars, combinedHeaderJarFile = j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
1396 shardingHeaderJars = localHeaderJars
Colin Crossedec77c2024-07-26 15:25:40 -07001397
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001398 var jarjared bool
1399 j.headerJarFile, jarjared = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1400 if jarjared {
1401 // jarjar modifies transitive static dependencies, use the combined header jar and drop the transitive
1402 // static libs header jars.
1403 localHeaderJars = android.Paths{j.headerJarFile}
1404 transitiveStaticLibsHeaderJars = nil
1405 }
1406 var repackaged bool
1407 repackagedHeaderJarFile, repackaged = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
1408 if repackaged {
1409 // repackage modifies transitive static dependencies, use the combined header jar and drop the transitive
1410 // static libs header jars.
1411 // TODO(b/356688296): this shouldn't export both the unmodified and repackaged header jars
1412 localHeaderJars = android.Paths{j.headerJarFile, repackagedHeaderJarFile}
1413 transitiveStaticLibsHeaderJars = nil
1414 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001415 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001416 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001417 hasErrorproneableFiles := false
1418 for _, ext := range j.sourceExtensions {
1419 if ext != ".proto" && ext != ".aidl" {
1420 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1421 // compile, and it's not useful to have warnings on these generated sources.
1422 hasErrorproneableFiles = true
1423 break
1424 }
1425 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001426 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001427 if Bool(j.properties.Errorprone.Enabled) {
1428 // If error-prone is enabled, enable errorprone flags on the regular
1429 // build.
1430 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001431 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001432 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1433 // a new jar file just for compiling with the errorprone compiler to.
1434 // This is because we don't want to cause the java files to get completely
1435 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1436 // We also don't want to run this if errorprone is enabled by default for
1437 // this module, or else we could have duplicated errorprone messages.
1438 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001439 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001440 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001441
Vadim Spivak3c496f02023-06-08 06:14:59 +00001442 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001443 "errorprone", "errorprone")
1444
Jaewoong Jung26342642021-03-17 15:56:23 -07001445 extraJarDeps = append(extraJarDeps, errorprone)
1446 }
1447
1448 if enableSharding {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001449 if len(shardingHeaderJars) > 0 {
1450 flags.classpath = append(classpath(slices.Clone(shardingHeaderJars)), flags.classpath...)
Colin Cross3d56ed52021-11-18 22:23:12 -08001451 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001452 shardSize := int(*(j.properties.Javac_shard_size))
1453 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001454 if len(uniqueJavaFiles) > 0 {
1455 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001456 for idx, shardSrc := range shardSrcs {
1457 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1458 nil, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001459 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
1460 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001461 }
1462 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001463 // Assume approximately 5 sources per srcjar.
1464 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1465 // 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 -07001466 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001467 startIdx := len(shardSrcs)
1468 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1469 for idx, shardSrcJars := range shardSrcJarsList {
1470 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1471 nil, shardSrcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001472 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
1473 localImplementationJars = append(localImplementationJars, classes)
Colin Crossa052ddb2023-09-25 21:46:58 -07001474 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001475 }
1476 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001477 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001478 classes, _ = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
1479 localImplementationJars = append(localImplementationJars, classes)
Jaewoong Jung26342642021-03-17 15:56:23 -07001480 }
1481 if ctx.Failed() {
1482 return
1483 }
1484 }
1485
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001486 localImplementationJars = append(localImplementationJars, extraCombinedJars...)
Colin Crossfd620b22024-02-23 10:05:21 -08001487
Jaewoong Jung26342642021-03-17 15:56:23 -07001488 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1489
1490 var includeSrcJar android.WritablePath
1491 if Bool(j.properties.Include_srcs) {
1492 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1493 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1494 }
1495
1496 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1497 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Cole Faust7fd5b2e2024-10-29 11:22:20 -07001498 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources.GetOrDefault(ctx, nil), j.properties.Exclude_java_resources)
1499 fileArgs2, fileDeps2 := ResourceFilesToJarArgs(ctx, j.properties.Device_common_java_resources.GetOrDefault(ctx, nil), nil)
1500 fileArgs3, fileDeps3 := ResourceFilesToJarArgs(ctx, j.properties.Device_first_java_resources.GetOrDefault(ctx, nil), nil)
Cole Faust65cb40a2024-10-21 15:41:42 -07001501 fileArgs = slices.Concat(fileArgs, fileArgs2, fileArgs3)
1502 fileDeps = slices.Concat(fileDeps, fileDeps2, fileDeps3)
Jaewoong Jung26342642021-03-17 15:56:23 -07001503 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1504
1505 var resArgs []string
1506 var resDeps android.Paths
1507
1508 resArgs = append(resArgs, dirArgs...)
1509 resDeps = append(resDeps, dirDeps...)
1510
1511 resArgs = append(resArgs, fileArgs...)
1512 resDeps = append(resDeps, fileDeps...)
1513
1514 resArgs = append(resArgs, extraArgs...)
1515 resDeps = append(resDeps, extraDeps...)
1516
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001517 var localResourceJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001518 if len(resArgs) > 0 {
1519 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1520 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001521 if ctx.Failed() {
1522 return
1523 }
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001524 localResourceJars = append(localResourceJars, resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001525 }
1526
Jaewoong Jung26342642021-03-17 15:56:23 -07001527 if Bool(j.properties.Include_srcs) {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001528 localResourceJars = append(localResourceJars, includeSrcJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001529 }
1530
1531 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1532 if len(services) > 0 {
1533 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1534 var zipargs []string
1535 for _, file := range services {
1536 serviceFile := file.String()
1537 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1538 }
1539 rule := zip
1540 args := map[string]string{
1541 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1542 }
1543 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1544 rule = zipRE
1545 args["implicits"] = strings.Join(services.Strings(), ",")
1546 }
1547 ctx.Build(pctx, android.BuildParams{
1548 Rule: rule,
1549 Output: servicesJar,
1550 Implicits: services,
1551 Args: args,
1552 })
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001553 localResourceJars = append(localResourceJars, servicesJar)
1554 }
1555
Colin Crossa14fb6a2024-10-23 16:57:06 -07001556 completeStaticLibsResourceJars := depset.New(depset.PREORDER, localResourceJars, deps.transitiveStaticLibsResourceJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001557
1558 var combinedResourceJar android.Path
1559 var resourceJars android.Paths
1560 if ctx.Config().UseTransitiveJarsInClasspath() {
1561 resourceJars = completeStaticLibsResourceJars.ToList()
1562 } else {
1563 resourceJars = append(slices.Clone(localResourceJars), deps.staticResourceJars...)
1564 }
1565 if len(resourceJars) == 1 {
1566 combinedResourceJar = resourceJars[0]
1567 } else if len(resourceJars) > 0 {
1568 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1569 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1570 false, nil, nil)
1571 combinedResourceJar = combinedJar
1572 }
1573
1574 manifest := j.overrideManifest
1575 if !manifest.Valid() && j.properties.Manifest != nil {
1576 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Jaewoong Jung26342642021-03-17 15:56:23 -07001577 }
1578
1579 // Combine the classes built from sources, any manifests, and any static libraries into
1580 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001581 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001582
Colin Crossa14fb6a2024-10-23 16:57:06 -07001583 completeStaticLibsImplementationJars := depset.New(depset.PREORDER, localImplementationJars, deps.transitiveStaticLibsImplementationJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001584
1585 var jars android.Paths
1586 if ctx.Config().UseTransitiveJarsInClasspath() {
1587 jars = completeStaticLibsImplementationJars.ToList()
1588 } else {
1589 jars = append(slices.Clone(localImplementationJars), deps.staticJars...)
1590 }
1591
1592 jars = append(jars, extraDepCombinedJars...)
1593
Jaewoong Jung26342642021-03-17 15:56:23 -07001594 if len(jars) == 1 && !manifest.Valid() {
1595 // Optimization: skip the combine step as there is nothing to do
1596 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1597 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001598 // any if len(extraJars) == 0.
Jaewoong Jung26342642021-03-17 15:56:23 -07001599
Jihoon Kang1147b312023-06-08 23:25:57 +00001600 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1601 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1602 // either with .from-source or .from-text suffix.
1603 // outputFile should be agnostic to the build configuration,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001604 // thus copy the single input static lib in order to prevent the static lib from being exposed
Jihoon Kang1147b312023-06-08 23:25:57 +00001605 // to the copy rules.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001606 if stub, _ := moduleStubLinkType(j); stub {
1607 copiedJar := android.PathForModuleOut(ctx, "combined", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001608 ctx.Build(pctx, android.BuildParams{
1609 Rule: android.Cp,
1610 Input: jars[0],
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001611 Output: copiedJar,
Jaewoong Jung26342642021-03-17 15:56:23 -07001612 })
Colin Crossa14fb6a2024-10-23 16:57:06 -07001613 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, android.Paths{copiedJar}, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001614 outputFile = copiedJar
Colin Cross7707b242024-07-26 12:02:36 -07001615 } else {
1616 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001617 }
1618 } else {
1619 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1620 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1621 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001622 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001623 }
1624
1625 // jarjar implementation jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001626 jarjarFile, jarjarred := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1627 if jarjarred {
1628 localImplementationJars = android.Paths{jarjarFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001629 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001630 }
Colin Crossedec77c2024-07-26 15:25:40 -07001631 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001632
Colin Crossedec77c2024-07-26 15:25:40 -07001633 // jarjar resource jar if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001634 if combinedResourceJar != nil {
1635 resourceJarJarFile, jarjarred := j.jarjarIfNecessary(ctx, combinedResourceJar, jarName, "resource")
1636 combinedResourceJar = resourceJarJarFile
1637 if jarjarred {
1638 localResourceJars = android.Paths{resourceJarJarFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001639 completeStaticLibsResourceJars = depset.New(depset.PREORDER, localResourceJars, nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001640 }
Colin Crossedec77c2024-07-26 15:25:40 -07001641 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001642
Colin Crossedec77c2024-07-26 15:25:40 -07001643 if ctx.Failed() {
1644 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001645 }
1646
Makoto Onuki7ded3822024-03-28 14:42:20 -07001647 if j.ravenizer.enabled {
1648 ravenizerInput := outputFile
John Wub67040d2024-10-07 18:39:06 +00001649 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", "", jarName)
John Wu989ee842024-10-04 00:21:43 +00001650 ravenizerArgs := ""
1651 if proptools.Bool(j.properties.Ravenizer.Strip_mockito) {
1652 ravenizerArgs = "--strip-mockito"
1653 }
1654 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
Makoto Onuki7ded3822024-03-28 14:42:20 -07001655 outputFile = ravenizerOutput
Colin Cross7e863852024-09-06 14:42:38 -07001656 localImplementationJars = android.Paths{ravenizerOutput}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001657 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001658 if combinedResourceJar != nil {
1659 ravenizerInput = combinedResourceJar
1660 ravenizerOutput = android.PathForModuleOut(ctx, "ravenizer", "resources", jarName)
1661 TransformRavenizer(ctx, ravenizerOutput, ravenizerInput, ravenizerArgs)
1662 combinedResourceJar = ravenizerOutput
1663 localResourceJars = android.Paths{ravenizerOutput}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001664 completeStaticLibsResourceJars = depset.New(depset.PREORDER, localResourceJars, nil)
John Wub67040d2024-10-07 18:39:06 +00001665 }
Makoto Onuki7ded3822024-03-28 14:42:20 -07001666 }
1667
Yihan Dong8be09c22024-08-29 15:32:13 +08001668 if j.shouldApiMapper() {
1669 inputFile := outputFile
1670 apiMapperFile := android.PathForModuleOut(ctx, "apimapper", jarName)
1671 ctx.Build(pctx, android.BuildParams{
1672 Rule: apimapper,
1673 Description: "apimapper",
1674 Input: inputFile,
1675 Output: apiMapperFile,
1676 })
1677 outputFile = apiMapperFile
Colin Cross7e863852024-09-06 14:42:38 -07001678 localImplementationJars = android.Paths{apiMapperFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001679 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Yihan Dong8be09c22024-08-29 15:32:13 +08001680 }
1681
Jaewoong Jung26342642021-03-17 15:56:23 -07001682 // Check package restrictions if necessary.
1683 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001684 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001685 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001686
1687 // Create a rule to copy the output jar to another path and add a validate dependency that
1688 // will check that the jar only contains the permitted packages. The new location will become
1689 // the output file of this module.
1690 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001691 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001692 ctx.Build(pctx, android.BuildParams{
1693 Rule: android.Cp,
1694 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001695 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001696 // Make sure that any dependency on the output file will cause ninja to run the package check
1697 // rule.
1698 Validation: pkgckFile,
1699 })
Colin Cross7707b242024-07-26 12:02:36 -07001700 outputFile = packageCheckOutputFile
Colin Cross7e863852024-09-06 14:42:38 -07001701 localImplementationJars = android.Paths{packageCheckOutputFile}
Colin Crossa14fb6a2024-10-23 16:57:06 -07001702 completeStaticLibsImplementationJars = depset.New(depset.PREORDER, localImplementationJars, nil)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001703
1704 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001705 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001706
1707 if ctx.Failed() {
1708 return
1709 }
1710 }
1711
1712 j.implementationJarFile = outputFile
1713 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001714 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1715 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1716 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1717 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1718 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1719 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1720 j.headerJarFile = headerJarFile
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001721 if len(localImplementationJars) == 1 && ctx.Config().UseTransitiveJarsInClasspath() {
1722 localHeaderJarFile := android.PathForModuleOut(ctx, "local-javac-header", jarName)
1723 convertImplementationJarToHeaderJar(ctx, localImplementationJars[0], localHeaderJarFile)
1724 localHeaderJars = append(localHeaderJars, localHeaderJarFile)
1725 } else {
1726 localHeaderJars = append(localHeaderJars, headerJarFile)
1727 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001728 }
1729
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001730 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1731 specs := j.jacocoModuleToZipCommand(ctx)
1732 if ctx.Failed() {
1733 return
1734 }
1735
Colin Crossb323c912024-09-24 15:21:00 -07001736 completeStaticLibsImplementationJarsToCombine := completeStaticLibsImplementationJars
1737
Jaewoong Jung26342642021-03-17 15:56:23 -07001738 if j.shouldInstrument(ctx) {
Colin Crossb323c912024-09-24 15:21:00 -07001739 instrumentedOutputFile := j.instrument(ctx, flags, outputFile, jarName, specs)
Colin Crossa14fb6a2024-10-23 16:57:06 -07001740 completeStaticLibsImplementationJarsToCombine = depset.New(depset.PREORDER, android.Paths{instrumentedOutputFile}, nil)
Colin Crossb323c912024-09-24 15:21:00 -07001741 outputFile = instrumentedOutputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001742 }
1743
1744 // merge implementation jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001745 var implementationAndResourcesJarsToCombine android.Paths
1746 if ctx.Config().UseTransitiveJarsInClasspath() {
1747 resourceJars := completeStaticLibsResourceJars.ToList()
1748 if len(resourceJars) > 0 {
Colin Crossb323c912024-09-24 15:21:00 -07001749 implementationAndResourcesJarsToCombine = append(resourceJars, completeStaticLibsImplementationJarsToCombine.ToList()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001750 implementationAndResourcesJarsToCombine = append(implementationAndResourcesJarsToCombine, extraDepCombinedJars...)
1751 }
1752 } else {
1753 if combinedResourceJar != nil {
1754 implementationAndResourcesJarsToCombine = android.Paths{combinedResourceJar, outputFile}
1755 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001756 }
1757
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001758 if len(implementationAndResourcesJarsToCombine) > 0 {
1759 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
1760 TransformJarsToJar(ctx, combinedJar, "for resources", implementationAndResourcesJarsToCombine, manifest,
1761 false, nil, nil)
1762 outputFile = combinedJar
1763 }
1764
1765 j.implementationAndResourcesJar = outputFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001766
1767 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001768 compileDex := j.dexProperties.Compile_dex
Colin Crossff694a82023-12-13 15:54:49 -08001769 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -07001770 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001771 if compileDex == nil {
1772 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001773 }
1774 if j.deviceProperties.Hostdex == nil {
1775 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1776 }
1777 }
1778
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001779 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001780 if j.hasCode(ctx) {
1781 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001782 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001783 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1784 }
1785 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001786 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001787 params := &compileDexParams{
1788 flags: flags,
1789 sdkVersion: j.SdkVersion(ctx),
1790 minSdkVersion: j.MinSdkVersion(ctx),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001791 classesJar: outputFile,
Spandan Dasc404cc72023-02-23 18:05:05 +00001792 jarName: jarName,
1793 }
Cole Fausteb032462024-09-19 11:12:54 -07001794 if j.GetProfileGuided(ctx) && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting(ctx) {
Spandan Das15a67112024-05-30 00:07:40 +00001795 ctx.PropertyErrorf("enable_profile_rewriting",
1796 "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.",
1797 )
1798 }
Cole Fausteb032462024-09-19 11:12:54 -07001799 if j.EnableProfileRewriting(ctx) {
1800 profile := j.GetProfile(ctx)
1801 if profile == "" || !j.GetProfileGuided(ctx) {
Spandan Das3dbda182024-05-20 22:23:10 +00001802 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1803 }
1804 params.artProfileInput = &profile
1805 }
1806 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001807 if ctx.Failed() {
1808 return
1809 }
1810
Spandan Das3dbda182024-05-20 22:23:10 +00001811 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1812 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001813 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001814 }
1815
Jaewoong Jung26342642021-03-17 15:56:23 -07001816 // merge dex jar with resources if necessary
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001817 var dexAndResourceJarsToCombine android.Paths
1818 if ctx.Config().UseTransitiveJarsInClasspath() {
1819 resourceJars := completeStaticLibsResourceJars.ToList()
1820 if len(resourceJars) > 0 {
1821 dexAndResourceJarsToCombine = append(android.Paths{dexOutputFile}, resourceJars...)
1822 }
1823 } else {
1824 if combinedResourceJar != nil {
1825 dexAndResourceJarsToCombine = android.Paths{dexOutputFile, combinedResourceJar}
1826 }
1827 }
1828 if len(dexAndResourceJarsToCombine) > 0 {
Colin Cross7707b242024-07-26 12:02:36 -07001829 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001830 TransformJarsToJar(ctx, combinedJar, "for dex resources", dexAndResourceJarsToCombine, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001831 false, nil, nil)
1832 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001833 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001834 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001835 dexOutputFile = combinedAlignedJar
1836 } else {
1837 dexOutputFile = combinedJar
1838 }
1839 }
1840
Paul Duffin4de94502021-05-16 05:21:16 +01001841 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001842
1843 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001844
1845 // Encode hidden API flags in dex file, if needed.
1846 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1847
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001848 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001849
1850 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001851 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1852 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1853 libName = strings.TrimSuffix(libName, ".impl")
1854 }
1855 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001856
1857 outputFile = dexOutputFile
Colin Crossa6182ab2024-08-21 10:47:44 -07001858
1859 ctx.CheckbuildFile(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001860 } else {
1861 // There is no code to compile into a dex jar, make sure the resources are propagated
1862 // to the APK if this is an app.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001863 j.dexJarFile = makeDexJarPathFromPath(combinedResourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001864 }
1865
1866 if ctx.Failed() {
1867 return
1868 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001869 }
1870
1871 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001872 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001873 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001874 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001875 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001876 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001877 }
1878 }
1879
1880 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001881 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1882 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001883 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1884 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001885 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001886 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001887 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001888 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001889 j.linter.javaLanguageLevel = flags.javaVersion.String()
1890 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001891 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001892 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1893 j.linter.buildModuleReportZip = true
1894 }
1895 j.linter.lint(ctx)
1896 }
1897
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001898 j.collectTransitiveSrcFiles(ctx, srcFiles)
1899
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001900 if ctx.Config().UseTransitiveJarsInClasspath() {
1901 if len(localImplementationJars) > 0 || len(localResourceJars) > 0 || len(localHeaderJars) > 0 {
1902 ctx.CheckbuildFile(localImplementationJars...)
1903 ctx.CheckbuildFile(localResourceJars...)
1904 ctx.CheckbuildFile(localHeaderJars...)
1905 } else {
1906 // There are no local sources or resources in this module, so there is nothing to checkbuild.
1907 ctx.UncheckedModule()
1908 }
1909 } else {
1910 ctx.CheckbuildFile(j.implementationJarFile)
1911 ctx.CheckbuildFile(j.headerJarFile)
1912 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001913
Colin Cross7727c7f2024-07-18 15:36:32 -07001914 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001915 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1916 RepackagedHeaderJars: android.PathsIfNonNil(repackagedHeaderJarFile),
1917
1918 LocalHeaderJars: localHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001919 TransitiveStaticLibsHeaderJars: depset.New(depset.PREORDER, localHeaderJars, transitiveStaticLibsHeaderJars),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001920 TransitiveStaticLibsImplementationJars: completeStaticLibsImplementationJars,
1921 TransitiveStaticLibsResourceJars: completeStaticLibsResourceJars,
1922
Colin Cross9ffaf282024-08-12 13:50:09 -07001923 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1924 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001925 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1926 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
Colin Crossc9b4f6b2024-07-26 15:25:46 -07001927 ResourceJars: android.PathsIfNonNil(combinedResourceJar),
Jihoon Kang705e63e2024-03-13 01:21:16 +00001928 AidlIncludeDirs: j.exportAidlIncludeDirs,
1929 SrcJarArgs: j.srcJarArgs,
1930 SrcJarDeps: j.srcJarDeps,
1931 TransitiveSrcFiles: j.transitiveSrcFiles,
1932 ExportedPlugins: j.exportedPluginJars,
1933 ExportedPluginClasses: j.exportedPluginClasses,
1934 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1935 JacocoReportClassesFile: j.jacocoReportClassesFile,
1936 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001937 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001938 })
1939
1940 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1941 j.outputFile = outputFile.WithoutRel()
1942}
1943
Cole Faustb7493472024-08-28 11:55:52 -07001944func (j *Module) useCompose(ctx android.BaseModuleContext) bool {
1945 return android.InList("androidx.compose.runtime_runtime", j.staticLibs(ctx))
Colin Crossa1ff7c62021-09-17 14:11:52 -07001946}
1947
Colin Crossa14fb6a2024-10-23 16:57:06 -07001948func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []depset.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001949 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001950 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001951 depTag := ctx.OtherModuleDependencyTag(m)
1952
Colin Crossa14fb6a2024-10-23 16:57:06 -07001953 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1954 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
Sam Delmerico95d70942023-08-02 18:00:35 -04001955
Colin Crossa14fb6a2024-10-23 16:57:06 -07001956 if depTag == staticLibTag {
Sam Delmerico95d70942023-08-02 18:00:35 -04001957 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1958 }
1959 })
1960
Colin Crosscde55342024-03-27 14:11:51 -07001961 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1962}
1963
1964func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1965 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1966
Sam Delmerico95d70942023-08-02 18:00:35 -04001967 directUnconditionalExportedFlags := android.Paths{}
1968 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1969 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1970 if exportUnconditionally {
1971 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1972 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1973 directUnconditionalExportedFlags = proguardFlagsForThisModule
1974 }
1975
1976 return ProguardSpecInfo{
1977 Export_proguard_flags_files: exportUnconditionally,
Colin Crossa14fb6a2024-10-23 16:57:06 -07001978 ProguardFlagsFiles: depset.New[android.Path](
1979 depset.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04001980 proguardFlagsForThisModule,
1981 transitiveProguardFlags,
1982 ),
Colin Crossa14fb6a2024-10-23 16:57:06 -07001983 UnconditionallyExportedProguardFlags: depset.New[android.Path](
1984 depset.POSTORDER,
Sam Delmerico95d70942023-08-02 18:00:35 -04001985 directUnconditionalExportedFlags,
1986 transitiveUnconditionalExportedFlags,
1987 ),
1988 }
1989
1990}
1991
Cole Faust75fffb12021-06-13 15:23:16 -07001992// Returns a copy of the supplied flags, but with all the errorprone-related
1993// fields copied to the regular build's fields.
1994func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1995 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1996
1997 if len(flags.errorProneExtraJavacFlags) > 0 {
1998 if len(flags.javacFlags) > 0 {
1999 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
2000 } else {
2001 flags.javacFlags = flags.errorProneExtraJavacFlags
2002 }
2003 }
2004 return flags
2005}
2006
Jaewoong Jung26342642021-03-17 15:56:23 -07002007func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07002008 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002009
2010 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00002011 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002012 if idx >= 0 {
2013 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00002014 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07002015 jarName += strconv.Itoa(idx)
2016 }
2017
Colin Cross7707b242024-07-26 12:02:36 -07002018 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00002019 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07002020
Cole Faust9decf832024-06-11 11:45:53 -07002021 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002022 extractionFile := android.PathForModuleOut(ctx, kzipName)
2023 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
2024 j.kytheFiles = append(j.kytheFiles, extractionFile)
2025 }
2026
Vadim Spivak3c496f02023-06-08 06:14:59 +00002027 if len(flags.processorPath) > 0 {
2028 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
2029 }
2030
Jaewoong Jung26342642021-03-17 15:56:23 -07002031 return classes
2032}
2033
2034// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
2035// since some of these flags may be used internally.
2036func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
2037 for _, flag := range flags {
2038 flag = strings.TrimSpace(flag)
2039
2040 if !strings.HasPrefix(flag, "-") {
2041 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
2042 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
2043 ctx.PropertyErrorf("kotlincflags",
2044 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
2045 } else if inList(flag, config.KotlincIllegalFlags) {
2046 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
2047 } else if flag == "-include-runtime" {
2048 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
2049 } else {
2050 args := strings.Split(flag, " ")
2051 if args[0] == "-kotlin-home" {
2052 ctx.PropertyErrorf("kotlincflags",
2053 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
2054 }
2055 }
2056 }
2057}
2058
2059func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
2060 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002061 extraJars android.Paths) (localHeaderJars android.Paths, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002062
Jaewoong Jung26342642021-03-17 15:56:23 -07002063 if len(srcFiles) > 0 || len(srcJars) > 0 {
2064 // Compile java sources into turbine.jar.
2065 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
2066 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002067 localHeaderJars = append(localHeaderJars, turbineJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07002068 }
2069
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002070 localHeaderJars = append(localHeaderJars, extraJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002071
2072 // Combine any static header libraries into classes-header.jar. If there is only
2073 // one input jar this step will be skipped.
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002074 var jars android.Paths
2075 if ctx.Config().UseTransitiveJarsInClasspath() {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002076 depSet := depset.New(depset.PREORDER, localHeaderJars, deps.transitiveStaticLibsHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002077 jars = depSet.ToList()
2078 } else {
2079 jars = append(slices.Clone(localHeaderJars), deps.staticHeaderJars...)
2080 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002081
2082 // we cannot skip the combine step for now if there is only one jar
2083 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07002084 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
2085 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07002086 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07002087
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002088 return localHeaderJars, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07002089}
2090
2091func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07002092 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07002093
2094 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07002095 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07002096
2097 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
2098
2099 j.jacocoReportClassesFile = jacocoReportClassesFile
2100
2101 return instrumentedJar
2102}
2103
Colin Cross9ffaf282024-08-12 13:50:09 -07002104type providesTransitiveHeaderJarsForR8 struct {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002105 // set of header jars for all transitive libs deps
Colin Crossa14fb6a2024-10-23 16:57:06 -07002106 transitiveLibsHeaderJarsForR8 depset.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002107 // set of header jars for all transitive static libs deps
Colin Crossa14fb6a2024-10-23 16:57:06 -07002108 transitiveStaticLibsHeaderJarsForR8 depset.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002109}
2110
Colin Cross9ffaf282024-08-12 13:50:09 -07002111// collectTransitiveHeaderJarsForR8 visits direct dependencies and collects all transitive libs and static_libs
2112// header jars. The semantics of the collected jars are odd (it collects combined jars that contain the static
2113// libs, but also the static libs, and it collects transitive libs dependencies of static_libs), so these
2114// are only used to expand the --lib arguments to R8.
2115func (j *providesTransitiveHeaderJarsForR8) collectTransitiveHeaderJarsForR8(ctx android.ModuleContext) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002116 directLibs := android.Paths{}
2117 directStaticLibs := android.Paths{}
Colin Crossa14fb6a2024-10-23 16:57:06 -07002118 transitiveLibs := []depset.DepSet[android.Path]{}
2119 transitiveStaticLibs := []depset.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002120 ctx.VisitDirectDeps(func(module android.Module) {
2121 // don't add deps of the prebuilt version of the same library
2122 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
2123 return
2124 }
2125
Colin Cross7727c7f2024-07-18 15:36:32 -07002126 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2127 tag := ctx.OtherModuleDependencyTag(module)
2128 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2129 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2130 directLibs = append(directLibs, dep.HeaderJars...)
2131 } else if tag == staticLibTag {
2132 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2133 } else {
2134 // Don't propagate transitive libs for other kinds of dependencies.
2135 return
2136 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002137
Colin Crossa14fb6a2024-10-23 16:57:06 -07002138 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJarsForR8)
2139 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJarsForR8)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002140 }
2141 })
Colin Crossa14fb6a2024-10-23 16:57:06 -07002142 j.transitiveLibsHeaderJarsForR8 = depset.New(depset.POSTORDER, directLibs, transitiveLibs)
2143 j.transitiveStaticLibsHeaderJarsForR8 = depset.New(depset.POSTORDER, directStaticLibs, transitiveStaticLibs)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002144}
2145
Jaewoong Jung26342642021-03-17 15:56:23 -07002146func (j *Module) HeaderJars() android.Paths {
2147 if j.headerJarFile == nil {
2148 return nil
2149 }
2150 return android.Paths{j.headerJarFile}
2151}
2152
2153func (j *Module) ImplementationJars() android.Paths {
2154 if j.implementationJarFile == nil {
2155 return nil
2156 }
2157 return android.Paths{j.implementationJarFile}
2158}
2159
Spandan Das59a4a2b2024-01-09 21:35:56 +00002160func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002161 return j.dexJarFile
2162}
2163
2164func (j *Module) DexJarInstallPath() android.Path {
2165 return j.installFile
2166}
2167
2168func (j *Module) ImplementationAndResourcesJars() android.Paths {
2169 if j.implementationAndResourcesJar == nil {
2170 return nil
2171 }
2172 return android.Paths{j.implementationAndResourcesJar}
2173}
2174
2175func (j *Module) AidlIncludeDirs() android.Paths {
2176 // exportAidlIncludeDirs is type android.Paths already
2177 return j.exportAidlIncludeDirs
2178}
2179
2180func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2181 return j.classLoaderContexts
2182}
2183
2184// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002185func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002186 if j.expandJarjarRules != nil {
2187 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Das096b8d62024-10-08 22:41:26 +00002188 // Add the header jar so that the rdeps can be resolved to the repackaged classes.
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002189 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
Jaewoong Jung26342642021-03-17 15:56:23 -07002190 }
Spandan Das096b8d62024-10-08 22:41:26 +00002191 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2192 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2193 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002194 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2195 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Cole Faustb7493472024-08-28 11:55:52 -07002196 dpInfo.Static_libs = append(dpInfo.Static_libs, j.staticLibs(ctx)...)
Yikef6282022022-04-13 20:41:01 +08002197 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002198}
2199
2200func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002201 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002202}
2203
2204func (j *Module) hasCode(ctx android.ModuleContext) bool {
2205 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2206 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2207}
2208
2209// Implements android.ApexModule
2210func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2211 return j.depIsInSameApex(ctx, dep)
2212}
2213
2214// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002215func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002216 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002217 minSdkVersion := j.MinSdkVersion(ctx)
2218 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002219 return fmt.Errorf("min_sdk_version is not specified")
2220 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002221 // If the module is compiling against core (via sdk_version), skip comparison check.
2222 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002223 return nil
2224 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002225 if minSdkVersion.GreaterThan(sdkVersion) {
2226 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002227 }
2228 return nil
2229}
2230
2231func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002232 if j.stem == "" {
2233 panic("Stem() called before stem property was set")
2234 }
2235 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002236}
2237
Jaewoong Jung26342642021-03-17 15:56:23 -07002238func (j *Module) JacocoReportClassesFile() android.Path {
2239 return j.jacocoReportClassesFile
2240}
2241
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002242func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002243 var fromDeps []depset.DepSet[android.Path]
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002244 ctx.VisitDirectDeps(func(module android.Module) {
2245 tag := ctx.OtherModuleDependencyTag(module)
2246 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002247 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002248 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002249 }
2250 }
2251 })
2252
Colin Crossa14fb6a2024-10-23 16:57:06 -07002253 j.transitiveSrcFiles = depset.New(depset.POSTORDER, mine, fromDeps)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002254}
2255
Jaewoong Jung26342642021-03-17 15:56:23 -07002256func (j *Module) IsInstallable() bool {
2257 return Bool(j.properties.Installable)
2258}
2259
2260type sdkLinkType int
2261
2262const (
2263 // TODO(jiyong) rename these for better readability. Make the allowed
2264 // and disallowed link types explicit
2265 // order is important here. See rank()
2266 javaCore sdkLinkType = iota
2267 javaSdk
2268 javaSystem
2269 javaModule
2270 javaSystemServer
2271 javaPlatform
2272)
2273
2274func (lt sdkLinkType) String() string {
2275 switch lt {
2276 case javaCore:
2277 return "core Java API"
2278 case javaSdk:
2279 return "Android API"
2280 case javaSystem:
2281 return "system API"
2282 case javaModule:
2283 return "module API"
2284 case javaSystemServer:
2285 return "system server API"
2286 case javaPlatform:
2287 return "private API"
2288 default:
2289 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2290 }
2291}
2292
2293// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2294// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2295// can't statically depend on modules that use Platform API.
2296func (lt sdkLinkType) rank() int {
2297 return int(lt)
2298}
2299
2300type moduleWithSdkDep interface {
2301 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002302 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002303}
2304
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002305func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2306 switch k {
2307 case android.SdkCore:
2308 return javaCore
2309 case android.SdkSystem:
2310 return javaSystem
2311 case android.SdkPublic:
2312 return javaSdk
2313 case android.SdkModule:
2314 return javaModule
2315 case android.SdkSystemServer:
2316 return javaSystemServer
2317 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2318 return javaPlatform
2319 default:
2320 return javaSdk
2321 }
2322}
2323
Jiyong Park92315372021-04-02 08:45:46 +09002324func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002325 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002326 case android.SdkCore.DefaultJavaLibraryName(),
2327 "legacy.core.platform.api.stubs",
2328 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002329 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002330 "core-lambda-stubs",
Jihoon Kangb5078312023-03-29 23:25:49 +00002331 "core-generated-annotation-stubs":
Jaewoong Jung26342642021-03-17 15:56:23 -07002332 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002333 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002334 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002335 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002336 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002337 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002338 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002339 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002340 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002341 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002342 return javaSystem, true
2343 }
2344
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002345 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002346 return linkType, true
2347 }
2348
Jiyong Park92315372021-04-02 08:45:46 +09002349 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002350 if !ver.Valid() {
2351 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002352 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002353
2354 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002355}
2356
2357// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2358// this module's. See the comment on rank() for details and an example.
2359func (j *Module) checkSdkLinkType(
2360 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2361 if ctx.Host() {
2362 return
2363 }
2364
Jiyong Park92315372021-04-02 08:45:46 +09002365 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002366 if stubs {
2367 return
2368 }
Jiyong Park92315372021-04-02 08:45:46 +09002369 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002370
2371 if myLinkType.rank() < depLinkType.rank() {
2372 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2373 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2374 "property of the source or target module so that target module is built "+
2375 "with the same or smaller API set when compared to the source.",
2376 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2377 }
2378}
2379
2380func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2381 var deps deps
2382
Jiyong Park92315372021-04-02 08:45:46 +09002383 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002384
Colin Cross9ffaf282024-08-12 13:50:09 -07002385 j.collectTransitiveHeaderJarsForR8(ctx)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002386
Colin Crossa14fb6a2024-10-23 16:57:06 -07002387 var transitiveBootClasspathHeaderJars []depset.DepSet[android.Path]
2388 var transitiveClasspathHeaderJars []depset.DepSet[android.Path]
2389 var transitiveJava9ClasspathHeaderJars []depset.DepSet[android.Path]
2390 var transitiveStaticJarsHeaderLibs []depset.DepSet[android.Path]
2391 var transitiveStaticJarsImplementationLibs []depset.DepSet[android.Path]
2392 var transitiveStaticJarsResourceLibs []depset.DepSet[android.Path]
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002393
Jaewoong Jung26342642021-03-17 15:56:23 -07002394 ctx.VisitDirectDeps(func(module android.Module) {
2395 otherName := ctx.OtherModuleName(module)
2396 tag := ctx.OtherModuleDependencyTag(module)
2397
2398 if IsJniDepTag(tag) {
2399 // Handled by AndroidApp.collectAppDeps
2400 return
2401 }
2402 if tag == certificateTag {
2403 // Handled by AndroidApp.collectAppDeps
2404 return
2405 }
2406
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002407 if sdkInfo, ok := android.OtherModuleProvider(ctx, module, SdkLibraryInfoProvider); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -07002408 switch tag {
Jihoon Kang28c96572024-09-11 23:44:44 +00002409 case sdkLibTag, libTag, staticLibTag:
Jihoon Kang28c96572024-09-11 23:44:44 +00002410 generatingLibsString := android.PrettyConcat(
2411 getGeneratingLibs(ctx, j.SdkVersion(ctx), module.Name(), sdkInfo), true, "or")
2412 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 -07002413 }
Colin Cross313aa542023-12-13 13:47:44 -08002414 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2415 if sdkLinkType != javaPlatform {
2416 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2417 // dep is a sysprop implementation library, but this module is not linking against
2418 // the platform, so it gets the sysprop public stubs library instead. Replace
2419 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2420 dep = syspropDep.JavaInfo
2421 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002422 }
2423 switch tag {
2424 case bootClasspathTag:
2425 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002426 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002427 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002428 if _, ok := module.(*Plugin); ok {
2429 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2430 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002431 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002432 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002433 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2434 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2435 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2436 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002437 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2438 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2439 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002440
Colin Crossa14fb6a2024-10-23 16:57:06 -07002441 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002442 case java9LibTag:
2443 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002444 transitiveJava9ClasspathHeaderJars = append(transitiveJava9ClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002445 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002446 if _, ok := module.(*Plugin); ok {
2447 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2448 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002449 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2450 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2451 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2452 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2453 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2454 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2455 // Turbine doesn't run annotation processors, so any module that uses an
2456 // annotation processor that generates API is incompatible with the turbine
2457 // optimization.
2458 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002459 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002460
Colin Crossa14fb6a2024-10-23 16:57:06 -07002461 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, dep.TransitiveStaticLibsHeaderJars)
2462 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, dep.TransitiveStaticLibsHeaderJars)
2463 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, dep.TransitiveStaticLibsImplementationJars)
2464 transitiveStaticJarsResourceLibs = append(transitiveStaticJarsResourceLibs, dep.TransitiveStaticLibsResourceJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002465 case pluginTag:
2466 if plugin, ok := module.(*Plugin); ok {
2467 if plugin.pluginProperties.Processor_class != nil {
2468 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2469 } else {
2470 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2471 }
2472 // Turbine doesn't run annotation processors, so any module that uses an
2473 // annotation processor that generates API is incompatible with the turbine
2474 // optimization.
2475 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2476 } else {
2477 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2478 }
2479 case errorpronePluginTag:
2480 if _, ok := module.(*Plugin); ok {
2481 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2482 } else {
2483 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2484 }
2485 case exportedPluginTag:
2486 if plugin, ok := module.(*Plugin); ok {
2487 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2488 if plugin.pluginProperties.Processor_class != nil {
2489 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2490 }
2491 // Turbine doesn't run annotation processors, so any module that uses an
2492 // annotation processor that generates API is incompatible with the turbine
2493 // optimization.
2494 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2495 } else {
2496 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2497 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002498 case kotlinPluginTag:
Luca Stefani50098f72024-10-12 17:55:31 +02002499 if _, ok := module.(*KotlinPlugin); ok {
2500 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
2501 } else {
2502 ctx.PropertyErrorf("kotlin_plugins", "%q is not a kotlin_plugin module", otherName)
2503 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002504 case syspropPublicStubDepTag:
2505 // This is a sysprop implementation library, forward the JavaInfoProvider from
2506 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002507 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002508 JavaInfo: dep,
2509 })
2510 }
2511 } else if dep, ok := module.(android.SourceFileProducer); ok {
2512 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002513 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002514 checkProducesJars(ctx, dep)
2515 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002516 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002517 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars,
Colin Crossa14fb6a2024-10-23 16:57:06 -07002518 depset.New(depset.PREORDER, dep.Srcs(), nil))
Jaewoong Jung26342642021-03-17 15:56:23 -07002519 case staticLibTag:
2520 checkProducesJars(ctx, dep)
2521 deps.classpath = append(deps.classpath, dep.Srcs()...)
2522 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2523 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002524
Colin Crossa14fb6a2024-10-23 16:57:06 -07002525 depHeaderJars := depset.New(depset.PREORDER, dep.Srcs(), nil)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002526 transitiveClasspathHeaderJars = append(transitiveClasspathHeaderJars, depHeaderJars)
2527 transitiveStaticJarsHeaderLibs = append(transitiveStaticJarsHeaderLibs, depHeaderJars)
2528 transitiveStaticJarsImplementationLibs = append(transitiveStaticJarsImplementationLibs, depHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07002529 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002530 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002531 switch tag {
2532 case staticLibTag:
2533 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2534 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002535 } else {
2536 switch tag {
2537 case bootClasspathTag:
2538 // If a system modules dependency has been added to the bootclasspath
2539 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002540 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002541 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars...)
Colin Crossa14fb6a2024-10-23 16:57:06 -07002542 transitiveBootClasspathHeaderJars = append(transitiveBootClasspathHeaderJars,
2543 sm.TransitiveStaticLibsHeaderJars)
Colin Crossb61c2262024-08-08 14:04:42 -07002544 } else {
2545 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2546 ctx.OtherModuleName(module))
2547 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002548
2549 case systemModulesTag:
2550 if deps.systemModules != nil {
2551 panic("Found two system module dependencies")
2552 }
Colin Crossb61c2262024-08-08 14:04:42 -07002553 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2554 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2555 } else {
2556 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2557 ctx.OtherModuleName(module))
2558 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002559
2560 case instrumentationForTag:
2561 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 -07002562 }
2563 }
2564
Spandan Das8aac9932024-07-18 23:14:13 +00002565 if android.InList(tag, compileDependencyTags) {
2566 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2567 j.compileDepNames = append(j.compileDepNames, otherName)
2568 }
2569
Jaewoong Jung26342642021-03-17 15:56:23 -07002570 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002571 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002572 })
2573
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002574 deps.transitiveStaticLibsHeaderJars = transitiveStaticJarsHeaderLibs
2575 deps.transitiveStaticLibsImplementationJars = transitiveStaticJarsImplementationLibs
2576 deps.transitiveStaticLibsResourceJars = transitiveStaticJarsResourceLibs
2577
2578 if ctx.Config().UseTransitiveJarsInClasspath() {
Colin Crossa14fb6a2024-10-23 16:57:06 -07002579 depSet := depset.New(depset.PREORDER, nil, transitiveClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002580 deps.classpath = depSet.ToList()
Colin Crossa14fb6a2024-10-23 16:57:06 -07002581 depSet = depset.New(depset.PREORDER, nil, transitiveBootClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002582 deps.bootClasspath = depSet.ToList()
Colin Crossa14fb6a2024-10-23 16:57:06 -07002583 depSet = depset.New(depset.PREORDER, nil, transitiveJava9ClasspathHeaderJars)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002584 deps.java9Classpath = depSet.ToList()
2585 }
2586
2587 if ctx.Device() {
2588 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
2589 if sdkDep.invalidVersion {
2590 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2591 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2592 } else if sdkDep.useFiles {
2593 // sdkDep.jar is actually equivalent to turbine header.jar.
2594 deps.classpath = append(slices.Clone(classpath(sdkDep.jars)), deps.classpath...)
2595 deps.dexClasspath = append(slices.Clone(classpath(sdkDep.jars)), deps.dexClasspath...)
2596 deps.aidlPreprocess = sdkDep.aidl
2597 // Add the sdk module dependency to `compileDepNames`.
2598 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2599 // TODO (b/358608607): Move this to decodeSdkDep
2600 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2601 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
2602 } else {
2603 deps.aidlPreprocess = sdkDep.aidl
2604 }
2605 }
2606
Jaewoong Jung26342642021-03-17 15:56:23 -07002607 return deps
2608}
2609
Joe Onorato349ae8d2024-02-05 22:46:00 +00002610// Provider for jarjar renaming rules.
2611//
2612// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2613// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2614// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2615// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2616// be renamed from that module.
2617// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002618type DependencyUse int
2619
2620const (
2621 RenameUseInvalid DependencyUse = iota
2622 RenameUseInclude
2623 RenameUseExclude
2624)
2625
2626type RenameUseElement struct {
2627 DepName string
2628 RenameUse DependencyUse
2629 Why string // token for determining where in the logic the decision was made.
2630}
2631
Joe Onorato349ae8d2024-02-05 22:46:00 +00002632type JarJarProviderData struct {
2633 // Mapping of class names: original --> renamed. If the value is "", the class will be
2634 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2635 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002636 Rename map[string]string
2637 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002638}
2639
2640func (this JarJarProviderData) GetDebugString() string {
2641 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002642 for _, k := range android.SortedKeys(this.Rename) {
2643 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002644 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2645 result += k + "--&gt;" + v + ";"
2646 }
2647 }
2648 return result
2649}
2650
2651var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2652
2653var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2654
2655func init() {
2656 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
Yu Liu26a716d2024-08-30 23:40:32 +00002657
2658 gob.Register(BaseJarJarProviderData{})
Joe Onorato349ae8d2024-02-05 22:46:00 +00002659}
2660
2661// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2662// whether they are java modules or not.
2663type BaseJarJarProviderData struct {
2664 JarJarProviderData JarJarProviderData
2665}
2666
2667func (this BaseJarJarProviderData) GetDebugString() string {
2668 return this.JarJarProviderData.GetDebugString()
2669}
2670
2671var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2672
2673// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2674// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2675// either JarJarProvider or BaseJarJarProvider.
2676func mergeJarJarPrefixes(ctx android.ModuleContext) {
2677 mod := ctx.Module()
2678 // Explicitly avoid propagating into some module types.
2679 switch reflect.TypeOf(mod).String() {
2680 case "*java.Droidstubs":
2681 return
2682 }
2683 jarJarData := collectDirectDepsProviders(ctx)
2684 if jarJarData != nil {
2685 providerData := BaseJarJarProviderData{
2686 JarJarProviderData: *jarJarData,
2687 }
2688 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2689 }
2690
2691}
2692
2693// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2694func (module *Module) addJarJarRenameRule(original string, renamed string) {
2695 if module.jarjarRenameRules == nil {
2696 module.jarjarRenameRules = make(map[string]string)
2697 }
2698 module.jarjarRenameRules[original] = renamed
2699}
2700
2701func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2702 // Gather repackage information from deps
2703 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002704
2705 module := ctx.Module()
2706 moduleName := module.Name()
2707
Colin Cross648daea2024-09-12 14:35:29 -07002708 ctx.VisitDirectDeps(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002709 tag := ctx.OtherModuleDependencyTag(m)
2710 // This logic mirrors that in (*Module).collectDeps above. There are several places
2711 // where we explicitly return RenameUseExclude, even though it is the default, to
2712 // indicate that it has been verified to be the case.
2713 //
2714 // Note well: there are probably cases that are getting to the unconditional return
2715 // and are therefore wrong.
2716 shouldIncludeRenames := func() (DependencyUse, string) {
2717 if moduleName == m.Name() {
2718 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2719 }
2720 if sc, ok := module.(android.SdkContext); ok {
2721 if ctx.Device() {
2722 sdkDep := decodeSdkDep(ctx, sc)
2723 if !sdkDep.invalidVersion && sdkDep.useFiles {
2724 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002725 }
2726 }
LaMont Jones63683e42024-02-08 14:30:45 -08002727 }
2728 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2729 return RenameUseExclude, "tags"
2730 }
Jihoon Kang98e9ac62024-09-25 23:42:30 +00002731 if _, ok := android.OtherModuleProvider(ctx, m, SdkLibraryInfoProvider); ok {
LaMont Jones63683e42024-02-08 14:30:45 -08002732 switch tag {
2733 case sdkLibTag, libTag:
2734 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2735 }
2736 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2737 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2738 switch ji.StubsLinkType {
2739 case Stubs:
2740 return RenameUseExclude, "info"
2741 case Implementation:
2742 return RenameUseInclude, "info"
2743 default:
LaMont Jones09721862024-06-11 10:30:50 -07002744 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002745 // Fall through to the heuristic logic.
2746 }
2747 switch reflect.TypeOf(m).String() {
2748 case "*java.GeneratedJavaLibraryModule":
2749 // Probably a java_aconfig_library module.
2750 // TODO: make this check better.
2751 return RenameUseInclude, "reflect"
2752 }
2753 switch tag {
2754 case bootClasspathTag:
2755 return RenameUseExclude, "tagswitch"
2756 case sdkLibTag, libTag, instrumentationForTag:
2757 return RenameUseInclude, "tagswitch"
2758 case java9LibTag:
2759 return RenameUseExclude, "tagswitch"
2760 case staticLibTag:
2761 return RenameUseInclude, "tagswitch"
2762 case pluginTag:
2763 return RenameUseInclude, "tagswitch"
2764 case errorpronePluginTag:
2765 return RenameUseInclude, "tagswitch"
2766 case exportedPluginTag:
2767 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002768 case kotlinPluginTag:
2769 return RenameUseInclude, "tagswitch"
2770 default:
2771 return RenameUseExclude, "tagswitch"
2772 }
2773 } else if _, ok := m.(android.SourceFileProducer); ok {
2774 switch tag {
2775 case sdkLibTag, libTag, staticLibTag:
2776 return RenameUseInclude, "srcfile"
2777 default:
2778 return RenameUseExclude, "srcfile"
2779 }
Yu Liu67a28422024-03-05 00:36:31 +00002780 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002781 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002782 } else {
2783 switch tag {
2784 case bootClasspathTag:
2785 return RenameUseExclude, "else"
2786 case systemModulesTag:
2787 return RenameUseInclude, "else"
2788 }
2789 }
2790 // If we got here, choose the safer option, which may lead to a build failure, rather
2791 // than runtime failures on the device.
2792 return RenameUseExclude, "end"
2793 }
2794
2795 if result == nil {
2796 result = &JarJarProviderData{
2797 Rename: make(map[string]string),
2798 RenameUse: make([]RenameUseElement, 0),
2799 }
2800 }
2801 how, why := shouldIncludeRenames()
2802 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2803 if how != RenameUseInclude {
2804 // Nothing to merge.
2805 return
2806 }
2807
2808 merge := func(theirs *JarJarProviderData) {
2809 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002810 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2811 result.Rename[orig] = renamed
2812 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2813 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2814 result.Rename[orig] = renamed
2815 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2816 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2817 continue
2818 }
2819 }
2820 }
2821 }
2822 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2823 merge(&theirs)
2824 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2825 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2826 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2827 // to java.Module.
2828 merge(&theirs.JarJarProviderData)
2829 }
2830 })
2831 return
2832}
2833
2834func (this Module) GetDebugString() string {
2835 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2836}
2837
2838// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2839// us, and if it's been set, apply the jarjar_prefix property to rename them.
2840func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2841 // Gather repackage information from deps
2842 result := collectDirectDepsProviders(ctx)
2843
Joe Onoratoa5d17172024-07-20 17:39:56 -07002844 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002845 if result == nil {
2846 result = &JarJarProviderData{
2847 Rename: make(map[string]string),
2848 }
2849 }
2850 if renamed != "" {
2851 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2852 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002853 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002854 }
2855 }
2856 (*result).Rename[orig] = renamed
2857 }
2858
Joe Onoratoa5d17172024-07-20 17:39:56 -07002859 // Update that with entries we've stored for ourself
2860 for orig, renamed := range module.jarjarRenameRules {
2861 add(orig, renamed)
2862 }
2863
2864 // Update that with entries given in the jarjar_rename property.
2865 for _, orig := range module.properties.Jarjar_rename {
2866 add(orig, "")
2867 }
2868
Joe Onorato349ae8d2024-02-05 22:46:00 +00002869 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2870 if result == nil {
2871 return nil
2872 }
2873
2874 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2875 // that have not yet been renamed.
2876 prefix := proptools.String(module.properties.Jarjar_prefix)
2877 if prefix != "" {
2878 if prefix[0] == '.' {
2879 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2880 return nil
2881 }
2882 if prefix[len(prefix)-1] == '.' {
2883 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2884 return nil
2885 }
2886
2887 var updated map[string]string
2888 for orig, renamed := range (*result).Rename {
2889 if renamed == "" {
2890 if updated == nil {
2891 updated = make(map[string]string)
2892 }
2893 updated[orig] = prefix + "." + orig
2894 }
2895 }
2896 for orig, renamed := range updated {
2897 (*result).Rename[orig] = renamed
2898 }
2899 }
2900
2901 return result
2902}
2903
2904// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2905// to "" won't be in this list because they shouldn't be renamed yet.
2906func getJarJarRuleText(provider *JarJarProviderData) string {
2907 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002908 for _, orig := range android.SortedKeys(provider.Rename) {
2909 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002910 if renamed != "" {
2911 result += "rule " + orig + " " + renamed + "\n"
2912 }
2913 }
2914 return result
2915}
2916
Zi Wangddb2ee52024-04-02 16:44:02 +00002917// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002918func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Zi Wangddb2ee52024-04-02 16:44:02 +00002919 if j.repackageJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002920 return infile, false
Zi Wangddb2ee52024-04-02 16:44:02 +00002921 }
Colin Crossedec77c2024-07-26 15:25:40 -07002922 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002923 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002924 return repackagedJarjarFile, true
Zi Wangddb2ee52024-04-02 16:44:02 +00002925}
2926
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002927func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) (android.Path, bool) {
Colin Crossedec77c2024-07-26 15:25:40 -07002928 if j.expandJarjarRules == nil {
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002929 return infile, false
Colin Crossedec77c2024-07-26 15:25:40 -07002930 }
2931 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2932 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
Colin Crossc9b4f6b2024-07-26 15:25:46 -07002933 return jarjarFile, true
Colin Crossedec77c2024-07-26 15:25:40 -07002934
2935}
2936
Jaewoong Jung26342642021-03-17 15:56:23 -07002937func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2938 deps.processorPath = append(deps.processorPath, pluginJars...)
2939 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2940}
2941
2942// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2943// this interface.
2944type ProvidesUsesLib interface {
2945 ProvidesUsesLib() *string
2946}
2947
2948func (j *Module) ProvidesUsesLib() *string {
2949 return j.usesLibraryProperties.Provides_uses_lib
2950}
satayev1c564cc2021-05-25 19:50:30 +01002951
2952type ModuleWithStem interface {
2953 Stem() string
2954}
2955
2956var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002957
2958type ModuleWithUsesLibrary interface {
2959 UsesLibrary() *usesLibrary
2960}
2961
2962func (j *Module) UsesLibrary() *usesLibrary {
2963 return &j.usesLibrary
2964}
2965
2966var _ ModuleWithUsesLibrary = (*Module)(nil)