blob: dbfad029b1c32c2cbe251ee6c32874a46f93013d [file] [log] [blame]
Colin Cross2fe66872015-03-30 17:20:39 -07001// Copyright 2015 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
17// This file contains the module types for compiling Java for Android, and converts the properties
Colin Cross46c9b8b2017-06-22 16:51:17 -070018// into the flags and filenames necessary to pass to the Module. The final creation of the rules
Colin Cross2fe66872015-03-30 17:20:39 -070019// is handled in builder.go
20
21import (
Colin Crossf19b9bb2018-03-26 14:42:44 -070022 "fmt"
Colin Crossfc3674a2017-09-18 17:41:52 -070023 "path/filepath"
Colin Cross74d73e22017-08-02 11:05:49 -070024 "strconv"
Colin Cross2fe66872015-03-30 17:20:39 -070025 "strings"
26
27 "github.com/google/blueprint"
Colin Cross3b706fd2019-09-05 16:44:18 -070028 "github.com/google/blueprint/pathtools"
Colin Cross76b5f0c2017-08-29 16:02:06 -070029 "github.com/google/blueprint/proptools"
Colin Cross2fe66872015-03-30 17:20:39 -070030
Colin Cross635c3b02016-05-18 15:37:25 -070031 "android/soong/android"
Ulya Trafimovich31e444e2020-08-14 17:32:16 +010032 "android/soong/dexpreopt"
Colin Cross3e3e72d2017-06-22 17:20:19 -070033 "android/soong/java/config"
Colin Cross303e21f2018-08-07 16:49:25 -070034 "android/soong/tradefed"
Colin Cross2fe66872015-03-30 17:20:39 -070035)
36
Colin Cross463a90e2015-06-17 14:20:06 -070037func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000038 RegisterJavaBuildComponents(android.InitRegistrationContext)
Paul Duffin255f18e2019-12-13 11:22:16 +000039
40 // Register sdk member types.
Paul Duffin7b81f5e2020-01-13 21:03:22 +000041 android.RegisterSdkMemberType(javaHeaderLibsSdkMemberType)
Paul Duffin255f18e2019-12-13 11:22:16 +000042
Paul Duffin22ff0aa2021-02-04 11:15:34 +000043 // Export implementation classes jar as part of the sdk.
44 exportImplementationClassesJar := func(_ android.SdkMemberContext, j *Library) android.Path {
45 implementationJars := j.ImplementationAndResourcesJars()
46 if len(implementationJars) != 1 {
47 panic(fmt.Errorf("there must be only one implementation jar from %q", j.Name()))
48 }
49 return implementationJars[0]
50 }
51
Paul Duffindb170e42020-12-08 17:48:25 +000052 // Register java implementation libraries for use only in module_exports (not sdk).
Paul Duffinf5c0a9c2020-02-28 14:39:53 +000053 android.RegisterSdkMemberType(&librarySdkMemberType{
54 android.SdkMemberTypeBase{
55 PropertyName: "java_libs",
56 },
Paul Duffin22ff0aa2021-02-04 11:15:34 +000057 exportImplementationClassesJar,
Paul Duffindb170e42020-12-08 17:48:25 +000058 sdkSnapshotFilePathForJar,
59 copyEverythingToSnapshot,
Paul Duffin255f18e2019-12-13 11:22:16 +000060 })
Paul Duffin1b82e6a2019-12-03 18:06:47 +000061
Paul Duffindb170e42020-12-08 17:48:25 +000062 // Register java boot libraries for use in sdk.
63 //
64 // The build has some implicit dependencies (via the boot jars configuration) on a number of
65 // modules, e.g. core-oj, apache-xml, that are part of the java boot class path and which are
66 // provided by mainline modules (e.g. art, conscrypt, runtime-i18n) but which are not otherwise
67 // used outside those mainline modules.
68 //
69 // As they are not needed outside the mainline modules adding them to the sdk/module-exports as
70 // either java_libs, or java_header_libs would end up exporting more information than was strictly
71 // necessary. The java_boot_libs property to allow those modules to be exported as part of the
72 // sdk/module_exports without exposing any unnecessary information.
73 android.RegisterSdkMemberType(&librarySdkMemberType{
74 android.SdkMemberTypeBase{
75 PropertyName: "java_boot_libs",
76 SupportsSdk: true,
77 },
Paul Duffin22ff0aa2021-02-04 11:15:34 +000078 // Temporarily export implementation classes jar for java_boot_libs as it is required for the
79 // hiddenapi processing.
80 // TODO(b/179354495): Revert once hiddenapi processing has been modularized.
81 exportImplementationClassesJar,
82 sdkSnapshotFilePathForJar,
Paul Duffindb170e42020-12-08 17:48:25 +000083 onlyCopyJarToSnapshot,
84 })
85
86 // Register java test libraries for use only in module_exports (not sdk).
Paul Duffin1b82e6a2019-12-03 18:06:47 +000087 android.RegisterSdkMemberType(&testSdkMemberType{
88 SdkMemberTypeBase: android.SdkMemberTypeBase{
89 PropertyName: "java_tests",
90 },
91 })
Colin Cross463a90e2015-06-17 14:20:06 -070092}
93
Paul Duffinf9b1da02019-12-18 19:51:55 +000094func RegisterJavaBuildComponents(ctx android.RegistrationContext) {
95 ctx.RegisterModuleType("java_defaults", DefaultsFactory)
96
97 ctx.RegisterModuleType("java_library", LibraryFactory)
98 ctx.RegisterModuleType("java_library_static", LibraryStaticFactory)
99 ctx.RegisterModuleType("java_library_host", LibraryHostFactory)
100 ctx.RegisterModuleType("java_binary", BinaryFactory)
101 ctx.RegisterModuleType("java_binary_host", BinaryHostFactory)
102 ctx.RegisterModuleType("java_test", TestFactory)
103 ctx.RegisterModuleType("java_test_helper_library", TestHelperLibraryFactory)
104 ctx.RegisterModuleType("java_test_host", TestHostFactory)
Paul Duffin1b82e6a2019-12-03 18:06:47 +0000105 ctx.RegisterModuleType("java_test_import", JavaTestImportFactory)
Paul Duffinf9b1da02019-12-18 19:51:55 +0000106 ctx.RegisterModuleType("java_import", ImportFactory)
107 ctx.RegisterModuleType("java_import_host", ImportFactoryHost)
108 ctx.RegisterModuleType("java_device_for_host", DeviceForHostFactory)
109 ctx.RegisterModuleType("java_host_for_device", HostForDeviceFactory)
110 ctx.RegisterModuleType("dex_import", DexImportFactory)
111
Martin Stjernholm6d415272020-01-31 17:10:36 +0000112 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
113 ctx.BottomUp("dexpreopt_tool_deps", dexpreoptToolDepsMutator).Parallel()
114 })
Martin Stjernholmd90676f2020-01-11 00:37:30 +0000115
Paul Duffinf9b1da02019-12-18 19:51:55 +0000116 ctx.RegisterSingletonType("logtags", LogtagsSingleton)
117 ctx.RegisterSingletonType("kythe_java_extract", kytheExtractJavaFactory)
118}
119
Artur Satayev8cf899a2020-04-15 17:29:42 +0100120func (j *Module) CheckStableSdkVersion() error {
121 sdkVersion := j.sdkVersion()
122 if sdkVersion.stable() {
123 return nil
124 }
125 return fmt.Errorf("non stable SDK %v", sdkVersion)
126}
127
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100128func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
Colin Crossc2d24052020-05-13 11:05:02 -0700129 if j.RequiresStableAPIs(ctx) {
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900130 if sc, ok := ctx.Module().(sdkContext); ok {
Jiyong Park6a927c42020-01-21 02:03:43 +0900131 if !sc.sdkVersion().specified() {
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900132 ctx.PropertyErrorf("sdk_version",
133 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
134 }
135 }
136 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100137
138 ctx.VisitDirectDeps(func(module android.Module) {
139 tag := ctx.OtherModuleDependencyTag(module)
140 switch module.(type) {
141 // TODO(satayev): cover other types as well, e.g. imports
142 case *Library, *AndroidLibrary:
143 switch tag {
144 case bootClasspathTag, libTag, staticLibTag, java9LibTag:
145 checkLinkType(ctx, j, module.(linkTypeContext), tag.(dependencyTag))
146 }
147 }
148 })
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900149}
150
Jeongik Cha538c0d02019-07-11 15:54:27 +0900151func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
152 if sc, ok := ctx.Module().(sdkContext); ok {
153 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park6a927c42020-01-21 02:03:43 +0900154 sdkVersionSpecified := sc.sdkVersion().specified()
155 if usePlatformAPI && sdkVersionSpecified {
156 ctx.PropertyErrorf("platform_apis", "platform_apis must be false when sdk_version is not empty.")
157 } else if !usePlatformAPI && !sdkVersionSpecified {
158 ctx.PropertyErrorf("platform_apis", "platform_apis must be true when sdk_version is empty.")
Jeongik Cha538c0d02019-07-11 15:54:27 +0900159 }
160
161 }
162}
163
Colin Cross2fe66872015-03-30 17:20:39 -0700164// TODO:
165// Autogenerated files:
Colin Cross2fe66872015-03-30 17:20:39 -0700166// Renderscript
167// Post-jar passes:
168// Proguard
Colin Cross2fe66872015-03-30 17:20:39 -0700169// Rmtypedefs
Colin Cross2fe66872015-03-30 17:20:39 -0700170// DroidDoc
171// Findbugs
172
Colin Cross89536d42017-07-07 14:35:50 -0700173type CompilerProperties struct {
Colin Crossa4c8cc62020-06-25 17:13:36 -0700174 // list of source files used to compile the Java module. May be .java, .kt, .logtags, .proto,
Colin Cross7d5136f2015-05-11 13:39:40 -0700175 // or .aidl files.
Colin Cross27b922f2019-03-04 22:35:41 -0800176 Srcs []string `android:"path,arch_variant"`
Dan Willemsen2ef08f42015-06-30 18:15:24 -0700177
Colin Crossa4c8cc62020-06-25 17:13:36 -0700178 // list Kotlin of source files containing Kotlin code that should be treated as common code in
179 // a codebase that supports Kotlin multiplatform. See
180 // https://kotlinlang.org/docs/reference/multiplatform.html. May be only be .kt files.
181 Common_srcs []string `android:"path,arch_variant"`
182
Dan Willemsen2ef08f42015-06-30 18:15:24 -0700183 // list of source files that should not be used to build the Java module.
184 // This is most useful in the arch/multilib variants to remove non-common files
Colin Cross27b922f2019-03-04 22:35:41 -0800185 Exclude_srcs []string `android:"path,arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700186
187 // list of directories containing Java resources
Colin Cross86a63ff2017-09-27 17:33:10 -0700188 Java_resource_dirs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700189
Colin Cross86a63ff2017-09-27 17:33:10 -0700190 // list of directories that should be excluded from java_resource_dirs
191 Exclude_java_resource_dirs []string `android:"arch_variant"`
Dan Willemsen2ef08f42015-06-30 18:15:24 -0700192
Colin Cross0f37af02017-09-27 17:42:05 -0700193 // list of files to use as Java resources
Colin Cross27b922f2019-03-04 22:35:41 -0800194 Java_resources []string `android:"path,arch_variant"`
Colin Cross0f37af02017-09-27 17:42:05 -0700195
Colin Crosscedd4762018-09-13 11:26:19 -0700196 // list of files that should be excluded from java_resources and java_resource_dirs
Colin Cross27b922f2019-03-04 22:35:41 -0800197 Exclude_java_resources []string `android:"path,arch_variant"`
Colin Cross0f37af02017-09-27 17:42:05 -0700198
Colin Cross7d5136f2015-05-11 13:39:40 -0700199 // list of module-specific flags that will be used for javac compiles
200 Javacflags []string `android:"arch_variant"`
201
Zoran Jovanovic8736ce22018-08-21 17:10:29 +0200202 // list of module-specific flags that will be used for kotlinc compiles
203 Kotlincflags []string `android:"arch_variant"`
204
Colin Cross7d5136f2015-05-11 13:39:40 -0700205 // list of of java libraries that will be in the classpath
Colin Crosse8dc34a2017-07-19 11:22:16 -0700206 Libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700207
208 // list of java libraries that will be compiled into the resulting jar
Colin Crosse8dc34a2017-07-19 11:22:16 -0700209 Static_libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700210
211 // manifest file to be included in resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -0800212 Manifest *string `android:"path"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700213
Colin Cross540eff82017-06-22 17:01:52 -0700214 // if not blank, run jarjar using the specified rules file
Colin Cross27b922f2019-03-04 22:35:41 -0800215 Jarjar_rules *string `android:"path,arch_variant"`
Colin Cross64162712017-08-08 13:17:59 -0700216
217 // If not blank, set the java version passed to javac as -source and -target
218 Java_version *string
Colin Cross2c429dc2017-08-31 16:45:16 -0700219
Colin Cross9ae1b922018-06-26 17:59:05 -0700220 // If set to true, allow this module to be dexed and installed on devices. Has no
221 // effect on host modules, which are always considered installable.
Colin Cross2c429dc2017-08-31 16:45:16 -0700222 Installable *bool
Colin Cross32f676a2017-09-06 13:41:06 -0700223
Colin Cross0f37af02017-09-27 17:42:05 -0700224 // If set to true, include sources used to compile the module in to the final jar
225 Include_srcs *bool
226
Vladimir Marko0975ee02019-04-02 10:29:55 +0100227 // If not empty, classes are restricted to the specified packages and their sub-packages.
228 // This restriction is checked after applying jarjar rules and including static libs.
229 Permitted_packages []string
230
Colin Crossbe9cdb82019-01-21 21:37:16 -0800231 // List of modules to use as annotation processors
232 Plugins []string
Colin Cross1369cdb2017-09-29 17:58:17 -0700233
Colin Crossc9fe10f2020-11-19 18:06:03 -0800234 // List of modules to export to libraries that directly depend on this library as annotation
235 // processors. Note that if the plugins set generates_api: true this will disable the turbine
236 // optimization on modules that depend on this module, which will reduce parallelism and cause
237 // more recompilation.
Artur Satayev9cf46692019-11-26 18:08:34 +0000238 Exported_plugins []string
239
Nan Zhang61eaedb2017-11-02 13:28:15 -0700240 // The number of Java source entries each Javac instance can process
241 Javac_shard_size *int64
242
Nan Zhang5f8cb422018-02-06 10:34:32 -0800243 // Add host jdk tools.jar to bootclasspath
244 Use_tools_jar *bool
245
Colin Cross1369cdb2017-09-29 17:58:17 -0700246 Openjdk9 struct {
Colin Cross6cef4812019-10-17 14:23:50 -0700247 // List of source files that should only be used when passing -source 1.9 or higher
Colin Cross27b922f2019-03-04 22:35:41 -0800248 Srcs []string `android:"path"`
Colin Cross1369cdb2017-09-29 17:58:17 -0700249
Colin Cross6cef4812019-10-17 14:23:50 -0700250 // List of javac flags that should only be used when passing -source 1.9 or higher
Colin Cross1369cdb2017-09-29 17:58:17 -0700251 Javacflags []string
252 }
Colin Crosscb933592017-11-22 13:49:43 -0800253
Colin Cross81440082018-08-15 20:21:55 -0700254 // When compiling language level 9+ .java code in packages that are part of
255 // a system module, patch_module names the module that your sources and
256 // dependencies should be patched into. The Android runtime currently
257 // doesn't implement the JEP 261 module system so this option is only
258 // supported at compile time. It should only be needed to compile tests in
259 // packages that exist in libcore and which are inconvenient to move
260 // elsewhere.
Tobias Thiererdda713d2018-09-19 16:16:19 +0100261 Patch_module *string `android:"arch_variant"`
Colin Cross81440082018-08-15 20:21:55 -0700262
Colin Crosscb933592017-11-22 13:49:43 -0800263 Jacoco struct {
264 // List of classes to include for instrumentation with jacoco to collect coverage
265 // information at runtime when building with coverage enabled. If unset defaults to all
266 // classes.
267 // Supports '*' as the last character of an entry in the list as a wildcard match.
268 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
269 // it matches classes in the package that have the class name as a prefix.
270 Include_filter []string
271
272 // List of classes to exclude from instrumentation with jacoco to collect coverage
273 // information at runtime when building with coverage enabled. Overrides classes selected
274 // by the include_filter property.
275 // Supports '*' as the last character of an entry in the list as a wildcard match.
276 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
277 // it matches classes in the package that have the class name as a prefix.
278 Exclude_filter []string
279 }
280
Andreas Gampef3e5b552018-01-22 21:27:21 -0800281 Errorprone struct {
282 // List of javac flags that should only be used when running errorprone.
283 Javacflags []string
Colin Cross748b2d82020-11-19 13:52:06 -0800284
285 // List of java_plugin modules that provide extra errorprone checks.
286 Extra_check_modules []string
Andreas Gampef3e5b552018-01-22 21:27:21 -0800287 }
288
Colin Cross0f2ee152017-12-14 15:22:43 -0800289 Proto struct {
290 // List of extra options that will be passed to the proto generator.
291 Output_params []string
292 }
293
Colin Crosscb933592017-11-22 13:49:43 -0800294 Instrument bool `blueprint:"mutated"`
Alex Light7f004a72019-02-21 13:27:37 -0800295
296 // List of files to include in the META-INF/services folder of the resulting jar.
Colin Cross27b922f2019-03-04 22:35:41 -0800297 Services []string `android:"path,arch_variant"`
Colin Cross0b67a8b2020-06-18 15:52:01 -0700298
299 // If true, package the kotlin stdlib into the jar. Defaults to true.
300 Static_kotlin_stdlib *bool `android:"arch_variant"`
Paul Duffin031d8692021-02-12 11:46:42 +0000301
302 // A list of java_library instances that provide additional hiddenapi annotations for the library.
303 Hiddenapi_additional_annotations []string
Colin Cross540eff82017-06-22 17:01:52 -0700304}
305
Colin Cross89536d42017-07-07 14:35:50 -0700306type CompilerDeviceProperties struct {
Jeongik Cha538c0d02019-07-11 15:54:27 +0900307 // if not blank, set to the version of the sdk to compile against.
308 // Defaults to compiling against the current platform.
Nan Zhangea568a42017-11-08 21:20:04 -0800309 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700310
Colin Cross83bb3162018-06-25 15:48:06 -0700311 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
312 // Defaults to sdk_version if not set.
313 Min_sdk_version *string
314
Dan Willemsen419290a2018-10-31 15:28:47 -0700315 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
316 // Defaults to sdk_version if not set.
317 Target_sdk_version *string
318
Jeongik Cha356dac42019-08-19 14:09:52 +0900319 // Whether to compile against the platform APIs instead of an SDK.
320 // If true, then sdk_version must be empty. The value of this field
321 // is ignored when module's type isn't android_app.
Colin Cross6af2e492018-05-22 11:12:33 -0700322 Platform_apis *bool
323
Colin Crossebe1a512017-11-14 13:12:14 -0800324 Aidl struct {
325 // Top level directories to pass to aidl tool
326 Include_dirs []string
Colin Cross7d5136f2015-05-11 13:39:40 -0700327
Colin Crossebe1a512017-11-14 13:12:14 -0800328 // Directories rooted at the Android.bp file to pass to aidl tool
329 Local_include_dirs []string
330
331 // directories that should be added as include directories for any aidl sources of modules
332 // that depend on this module, as well as to aidl for this module.
333 Export_include_dirs []string
Martijn Coeneneab15642018-03-09 09:29:59 +0100334
335 // whether to generate traces (for systrace) for this interface
336 Generate_traces *bool
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100337
338 // whether to generate Binder#GetTransaction name method.
339 Generate_get_transaction_name *bool
Jooyung Hane197d8b2021-01-05 10:33:16 +0900340
341 // list of flags that will be passed to the AIDL compiler
342 Flags []string
Colin Crossebe1a512017-11-14 13:12:14 -0800343 }
Colin Cross92430102017-10-09 14:59:32 -0700344
345 // If true, export a copy of the module as a -hostdex module for host testing.
346 Hostdex *bool
Colin Cross1369cdb2017-09-29 17:58:17 -0700347
Colin Cross7f87f4f2019-04-24 13:41:45 -0700348 Target struct {
349 Hostdex struct {
350 // Additional required dependencies to add to -hostdex modules.
351 Required []string
352 }
353 }
354
Paul Duffine25c6442019-10-11 13:50:28 +0100355 // When targeting 1.9 and above, override the modules to use with --system,
356 // otherwise provides defaults libraries to add to the bootclasspath.
Colin Cross1369cdb2017-09-29 17:58:17 -0700357 System_modules *string
Colin Cross5a0dcd52018-10-05 14:20:06 -0700358
Paul Duffina2058f82020-06-24 16:22:38 +0100359 // The name of the module as used in build configuration.
360 //
361 // Allows a library to separate its actual name from the name used in
362 // build configuration, e.g.ctx.Config().BootJars().
363 ConfigurationName *string `blueprint:"mutated"`
364
Jiyong Park4c4c0242019-10-21 14:53:15 +0900365 // set the name of the output
366 Stem *string
367
David Srbeckye033cba2020-05-20 22:20:28 +0100368 IsSDKLibrary bool `blueprint:"mutated"`
Songchun Fan17d69e32020-03-24 20:32:24 -0700369
370 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
371 // Defaults to false.
372 V4_signature *bool
Colin Cross7d5136f2015-05-11 13:39:40 -0700373}
374
Paul Duffin0d3c2e12020-05-17 08:34:50 +0100375// Functionality common to Module and Import
Paul Duffin859fe962020-05-15 10:20:31 +0100376//
377// It is embedded in Module so its functionality can be used by methods in Module
378// but it is currently only initialized by Import and Library.
Paul Duffin0d3c2e12020-05-17 08:34:50 +0100379type embeddableInModuleAndImport struct {
Paul Duffin859fe962020-05-15 10:20:31 +0100380
381 // Functionality related to this being used as a component of a java_sdk_library.
382 EmbeddableSdkLibraryComponent
383}
384
385func (e *embeddableInModuleAndImport) initModuleAndImport(moduleBase *android.ModuleBase) {
386 e.initSdkLibraryComponent(moduleBase)
Paul Duffin0d3c2e12020-05-17 08:34:50 +0100387}
388
389// Module/Import's DepIsInSameApex(...) delegates to this method.
390//
391// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
392// the one provided by ApexModuleBase.
393func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
394 // dependencies other than the static linkage are all considered crossing APEX boundary
395 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
396 return true
397 }
398 return false
399}
400
Colin Cross46c9b8b2017-06-22 16:51:17 -0700401// Module contains the properties and members used by all java module types
402type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700403 android.ModuleBase
Colin Cross89536d42017-07-07 14:35:50 -0700404 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +0900405 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900406 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -0700407
Paul Duffin0d3c2e12020-05-17 08:34:50 +0100408 // Functionality common to Module and Import.
409 embeddableInModuleAndImport
410
Colin Cross89536d42017-07-07 14:35:50 -0700411 properties CompilerProperties
Colin Cross6af17aa2017-09-20 12:59:05 -0700412 protoProperties android.ProtoProperties
Colin Cross89536d42017-07-07 14:35:50 -0700413 deviceProperties CompilerDeviceProperties
Colin Cross2fe66872015-03-30 17:20:39 -0700414
Colin Cross331a1212018-08-15 20:40:52 -0700415 // jar file containing header classes including static library dependencies, suitable for
416 // inserting into the bootclasspath/classpath of another compile
Nan Zhanged19fc32017-10-19 13:06:22 -0700417 headerJarFile android.Path
418
Colin Cross331a1212018-08-15 20:40:52 -0700419 // jar file containing implementation classes including static library dependencies but no
420 // resources
Nan Zhanged19fc32017-10-19 13:06:22 -0700421 implementationJarFile android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700422
Colin Cross331a1212018-08-15 20:40:52 -0700423 // jar file containing only resources including from static library dependencies
424 resourceJar android.Path
425
Colin Cross0c4ce212019-05-03 15:28:19 -0700426 // args and dependencies to package source files into a srcjar
427 srcJarArgs []string
428 srcJarDeps android.Paths
429
Colin Cross331a1212018-08-15 20:40:52 -0700430 // jar file containing implementation classes and resources including static library
431 // dependencies
432 implementationAndResourcesJar android.Path
433
434 // output file containing classes.dex and resources
Colin Cross6ade34f2017-09-15 13:00:47 -0700435 dexJarFile android.Path
436
Colin Cross43f08db2018-11-12 10:13:39 -0800437 // output file that contains classes.dex if it should be in the output file
438 maybeStrippedDexJarFile android.Path
439
Colin Crosscb933592017-11-22 13:49:43 -0800440 // output file containing uninstrumented classes that will be instrumented by jacoco
441 jacocoReportClassesFile android.Path
442
Colin Cross331a1212018-08-15 20:40:52 -0700443 // output file of the module, which may be a classes jar or a dex jar
Colin Crosse560c4a2019-03-19 16:03:11 -0700444 outputFile android.Path
445 extraOutputFiles android.Paths
Colin Crossb7a63242015-04-16 14:09:14 -0700446
Colin Cross635c3b02016-05-18 15:37:25 -0700447 exportAidlIncludeDirs android.Paths
Colin Crossc0b06f12015-04-08 13:03:43 -0700448
Colin Cross635c3b02016-05-18 15:37:25 -0700449 logtagsSrcs android.Paths
Colin Crossf05fe972015-04-10 17:45:20 -0700450
Colin Cross2fe66872015-03-30 17:20:39 -0700451 // installed file for binary dependency
Colin Cross635c3b02016-05-18 15:37:25 -0700452 installFile android.Path
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800453
454 // list of .java files and srcjars that was passed to javac
455 compiledJavaSrcs android.Paths
456 compiledSrcJars android.Paths
Colin Cross66dbc0b2017-12-28 12:23:20 -0800457
Colin Cross094054a2018-10-17 15:10:48 -0700458 // manifest file to use instead of properties.Manifest
459 overrideManifest android.OptionalPath
460
Ulya Trafimovich8cbc5d22020-11-03 15:15:46 +0000461 // map of SDK version to class loader context
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +0100462 classLoaderContexts dexpreopt.ClassLoaderContextMap
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700463
Artur Satayev9cf46692019-11-26 18:08:34 +0000464 // list of plugins that this java module is exporting
465 exportedPluginJars android.Paths
466
467 // list of plugins that this java module is exporting
468 exportedPluginClasses []string
469
Colin Crossc9fe10f2020-11-19 18:06:03 -0800470 // if true, the exported plugins generate API and require disabling turbine.
471 exportedDisableTurbine bool
472
Artur Satayev9cf46692019-11-26 18:08:34 +0000473 // list of source files, collected from srcFiles with unique java and all kt files,
patricktu242faad2019-09-24 15:41:30 +0800474 // will be used by android.IDEInfo struct
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700475 expandIDEInfoCompiledSrcs []string
Colin Cross43f08db2018-11-12 10:13:39 -0800476
Steven Morelandc4efd9c2019-01-18 11:51:25 -0800477 // expanded Jarjar_rules
478 expandJarjarRules android.Path
479
Vladimir Marko0975ee02019-04-02 10:29:55 +0100480 // list of additional targets for checkbuild
481 additionalCheckedModules android.Paths
482
Colin Cross988708c2019-05-06 14:04:11 -0700483 // Extra files generated by the module type to be added as java resources.
484 extraResources android.Paths
485
Colin Crossf24a22a2019-01-31 14:12:44 -0800486 hiddenAPI
Liz Kammera7a64f32020-07-09 15:16:41 -0700487 dexer
Colin Cross43f08db2018-11-12 10:13:39 -0800488 dexpreopter
Ulya Trafimovich21a73752020-09-01 17:33:48 +0100489 usesLibrary
Colin Cross014489c2020-06-02 20:09:13 -0700490 linter
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800491
492 // list of the xref extraction files
493 kytheFiles android.Paths
Anton Hansson78156ef2020-03-27 19:39:48 +0000494
bralee1fbf4402020-05-21 10:11:59 +0800495 // Collect the module directory for IDE info in java/jdeps.go.
496 modulePaths []string
Colin Cross56a83212020-09-15 18:30:11 -0700497
498 hideApexVariantFromMake bool
Colin Cross2fe66872015-03-30 17:20:39 -0700499}
500
Colin Crossce6734e2020-06-15 16:09:53 -0700501func (j *Module) addHostProperties() {
502 j.AddProperties(
503 &j.properties,
504 &j.protoProperties,
Ulya Trafimovich21a73752020-09-01 17:33:48 +0100505 &j.usesLibraryProperties,
Colin Crossce6734e2020-06-15 16:09:53 -0700506 )
507}
508
509func (j *Module) addHostAndDeviceProperties() {
510 j.addHostProperties()
511 j.AddProperties(
512 &j.deviceProperties,
Liz Kammera7a64f32020-07-09 15:16:41 -0700513 &j.dexer.dexProperties,
Colin Crossce6734e2020-06-15 16:09:53 -0700514 &j.dexpreoptProperties,
Colin Cross014489c2020-06-02 20:09:13 -0700515 &j.linter.properties,
Colin Crossce6734e2020-06-15 16:09:53 -0700516 )
517}
518
Colin Cross41955e82019-05-29 14:40:35 -0700519func (j *Module) OutputFiles(tag string) (android.Paths, error) {
520 switch tag {
521 case "":
522 return append(android.Paths{j.outputFile}, j.extraOutputFiles...), nil
Paul Duffin74f05592020-11-25 16:37:46 +0000523 case android.DefaultDistTag:
524 return android.Paths{j.outputFile}, nil
Colin Cross375ca3c2019-05-29 14:40:58 -0700525 case ".jar":
526 return android.Paths{j.implementationAndResourcesJar}, nil
Colin Cross2d975b12019-07-29 16:47:42 -0700527 case ".proguard_map":
Liz Kammera7a64f32020-07-09 15:16:41 -0700528 if j.dexer.proguardDictionary.Valid() {
529 return android.Paths{j.dexer.proguardDictionary.Path()}, nil
530 }
531 return nil, fmt.Errorf("%q was requested, but no output file was found.", tag)
Colin Cross41955e82019-05-29 14:40:35 -0700532 default:
533 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
534 }
Colin Cross54250902017-12-05 09:28:08 -0800535}
536
Colin Cross41955e82019-05-29 14:40:35 -0700537var _ android.OutputFileProducer = (*Module)(nil)
Colin Cross54250902017-12-05 09:28:08 -0800538
Colin Crossdcf71b22021-02-01 13:59:03 -0800539// JavaInfo contains information about a java module for use by modules that depend on it.
540type JavaInfo struct {
541 // HeaderJars is a list of jars that can be passed as the javac classpath in order to link
542 // against this module. If empty, ImplementationJars should be used instead.
543 HeaderJars android.Paths
544
545 // ImplementationAndResourceJars is a list of jars that contain the implementations of classes
546 // in the module as well as any resources included in the module.
547 ImplementationAndResourcesJars android.Paths
548
549 // ImplementationJars is a list of jars that contain the implementations of classes in the
550 //module.
551 ImplementationJars android.Paths
552
553 // ResourceJars is a list of jars that contain the resources included in the module.
554 ResourceJars android.Paths
555
556 // AidlIncludeDirs is a list of directories that should be passed to the aidl tool when
557 // depending on this module.
558 AidlIncludeDirs android.Paths
559
560 // SrcJarArgs is a list of arguments to pass to soong_zip to package the sources of this
561 // module.
562 SrcJarArgs []string
563
564 // SrcJarDeps is a list of paths to depend on when packaging the sources of this module.
565 SrcJarDeps android.Paths
566
567 // ExportedPlugins is a list of paths that should be used as annotation processors for any
568 // module that depends on this module.
569 ExportedPlugins android.Paths
570
571 // ExportedPluginClasses is a list of classes that should be run as annotation processors for
572 // any module that depends on this module.
573 ExportedPluginClasses []string
574
575 // ExportedPluginDisableTurbine is true if this module's annotation processors generate APIs,
576 // requiring disbling turbine for any modules that depend on it.
577 ExportedPluginDisableTurbine bool
578
579 // JacocoReportClassesFile is the path to a jar containing uninstrumented classes that will be
580 // instrumented by jacoco.
581 JacocoReportClassesFile android.Path
582}
583
584var JavaInfoProvider = blueprint.NewProvider(JavaInfo{})
585
Paul Duffin44b481b2020-06-17 16:59:43 +0100586// Methods that need to be implemented for a module that is added to apex java_libs property.
587type ApexDependency interface {
Nan Zhanged19fc32017-10-19 13:06:22 -0700588 HeaderJars() android.Paths
Paul Duffin44b481b2020-06-17 16:59:43 +0100589 ImplementationAndResourcesJars() android.Paths
590}
591
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100592// Provides build path and install path to DEX jars.
593type UsesLibraryDependency interface {
Ulyana Trafimovich5539e7b2020-06-04 14:08:17 +0000594 DexJarBuildPath() android.Path
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +0100595 DexJarInstallPath() android.Path
Ulya Trafimovichdbf31662020-12-17 12:07:54 +0000596 ClassLoaderContexts() dexpreopt.ClassLoaderContextMap
Ulya Trafimovich31e444e2020-08-14 17:32:16 +0100597}
598
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800599type xref interface {
600 XrefJavaFiles() android.Paths
601}
602
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800603func (j *Module) XrefJavaFiles() android.Paths {
604 return j.kytheFiles
605}
606
Colin Cross89536d42017-07-07 14:35:50 -0700607func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
Liz Kammerdd849a82020-06-12 16:38:45 -0700608 initJavaModule(module, hod, false)
609}
610
611func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
612 initJavaModule(module, hod, true)
613}
614
615func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
616 multilib := android.MultilibCommon
617 if multiTargets {
618 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
619 } else {
620 android.InitAndroidArchModule(module, hod, multilib)
621 }
Colin Cross89536d42017-07-07 14:35:50 -0700622 android.InitDefaultableModule(module)
623}
624
Colin Crossbe1da472017-07-07 15:59:46 -0700625type dependencyTag struct {
626 blueprint.BaseDependencyTag
627 name string
Colin Cross2fe66872015-03-30 17:20:39 -0700628}
629
Colin Crosse9fe2942020-11-10 18:12:15 -0800630// installDependencyTag is a dependency tag that is annotated to cause the installed files of the
631// dependency to be installed when the parent module is installed.
632type installDependencyTag struct {
633 blueprint.BaseDependencyTag
634 android.InstallAlwaysNeededDependencyTag
635 name string
636}
637
Ulya Trafimovichb5218112020-10-07 15:11:32 +0100638type usesLibraryDependencyTag struct {
639 dependencyTag
640 sdkVersion int // SDK version in which the library appared as a standalone library.
641}
642
643func makeUsesLibraryDependencyTag(sdkVersion int) usesLibraryDependencyTag {
644 return usesLibraryDependencyTag{
645 dependencyTag: dependencyTag{name: fmt.Sprintf("uses-library-%d", sdkVersion)},
646 sdkVersion: sdkVersion,
647 }
648}
649
Jiyong Park8be103b2019-11-08 15:53:48 +0900650func IsJniDepTag(depTag blueprint.DependencyTag) bool {
Colin Crossde78d132020-10-09 18:59:49 -0700651 return depTag == jniLibTag
Jiyong Park8be103b2019-11-08 15:53:48 +0900652}
653
Colin Crossbe1da472017-07-07 15:59:46 -0700654var (
Liz Kammerdd849a82020-06-12 16:38:45 -0700655 dataNativeBinsTag = dependencyTag{name: "dataNativeBins"}
Colin Cross4b964c02018-10-15 16:18:06 -0700656 staticLibTag = dependencyTag{name: "staticlib"}
657 libTag = dependencyTag{name: "javalib"}
Colin Cross6cef4812019-10-17 14:23:50 -0700658 java9LibTag = dependencyTag{name: "java9lib"}
Colin Crossbe9cdb82019-01-21 21:37:16 -0800659 pluginTag = dependencyTag{name: "plugin"}
Colin Cross748b2d82020-11-19 13:52:06 -0800660 errorpronePluginTag = dependencyTag{name: "errorprone-plugin"}
Artur Satayev9cf46692019-11-26 18:08:34 +0000661 exportedPluginTag = dependencyTag{name: "exported-plugin"}
Colin Cross4b964c02018-10-15 16:18:06 -0700662 bootClasspathTag = dependencyTag{name: "bootclasspath"}
663 systemModulesTag = dependencyTag{name: "system modules"}
664 frameworkResTag = dependencyTag{name: "framework-res"}
Colin Cross4b964c02018-10-15 16:18:06 -0700665 kotlinStdlibTag = dependencyTag{name: "kotlin-stdlib"}
Colin Crossafbb1732019-01-17 15:42:52 -0800666 kotlinAnnotationsTag = dependencyTag{name: "kotlin-annotations"}
Colin Cross4b964c02018-10-15 16:18:06 -0700667 proguardRaiseTag = dependencyTag{name: "proguard-raise"}
668 certificateTag = dependencyTag{name: "certificate"}
669 instrumentationForTag = dependencyTag{name: "instrumentation_for"}
Colin Cross92e4b462020-06-18 15:56:48 -0700670 extraLintCheckTag = dependencyTag{name: "extra-lint-check"}
Colin Crossde78d132020-10-09 18:59:49 -0700671 jniLibTag = dependencyTag{name: "jnilib"}
Colin Crosse9fe2942020-11-10 18:12:15 -0800672 jniInstallTag = installDependencyTag{name: "jni install"}
673 binaryInstallTag = installDependencyTag{name: "binary install"}
Ulya Trafimovichb5218112020-10-07 15:11:32 +0100674 usesLibTag = makeUsesLibraryDependencyTag(dexpreopt.AnySdkVersion)
675 usesLibCompat28Tag = makeUsesLibraryDependencyTag(28)
676 usesLibCompat29Tag = makeUsesLibraryDependencyTag(29)
677 usesLibCompat30Tag = makeUsesLibraryDependencyTag(30)
Colin Crossbe1da472017-07-07 15:59:46 -0700678)
Colin Cross2fe66872015-03-30 17:20:39 -0700679
Jiyong Park83dc74b2020-01-14 18:38:44 +0900680func IsLibDepTag(depTag blueprint.DependencyTag) bool {
681 return depTag == libTag
682}
683
684func IsStaticLibDepTag(depTag blueprint.DependencyTag) bool {
685 return depTag == staticLibTag
686}
687
Colin Crossfc3674a2017-09-18 17:41:52 -0700688type sdkDep struct {
Pete Gilline3d44b22020-06-29 11:28:51 +0100689 useModule, useFiles, invalidVersion bool
Colin Cross47ff2522017-10-02 14:22:08 -0700690
Colin Cross6cef4812019-10-17 14:23:50 -0700691 // The modules that will be added to the bootclasspath when targeting 1.8 or lower
692 bootclasspath []string
Paul Duffine25c6442019-10-11 13:50:28 +0100693
694 // The default system modules to use. Will be an empty string if no system
695 // modules are to be used.
Colin Cross1369cdb2017-09-29 17:58:17 -0700696 systemModules string
697
Pete Gilline3d44b22020-06-29 11:28:51 +0100698 // The modules that will be added to the classpath regardless of the Java language level targeted
699 classpath []string
700
Colin Cross6cef4812019-10-17 14:23:50 -0700701 // The modules that will be added ot the classpath when targeting 1.9 or higher
Pete Gilline3d44b22020-06-29 11:28:51 +0100702 // (normally these will be on the bootclasspath when targeting 1.8 or lower)
Colin Cross6cef4812019-10-17 14:23:50 -0700703 java9Classpath []string
704
Colin Crossa97c5d32018-03-28 14:58:31 -0700705 frameworkResModule string
706
Colin Cross86a60ae2018-05-29 14:44:55 -0700707 jars android.Paths
Colin Cross3047fa22019-04-18 10:56:44 -0700708 aidl android.OptionalPath
Paul Duffin250e6192019-06-07 10:44:37 +0100709
710 noStandardLibs, noFrameworksLibs bool
711}
712
713func (s sdkDep) hasStandardLibs() bool {
714 return !s.noStandardLibs
715}
716
717func (s sdkDep) hasFrameworkLibs() bool {
718 return !s.noStandardLibs && !s.noFrameworksLibs
Colin Cross1369cdb2017-09-29 17:58:17 -0700719}
720
Colin Crossa4f08812018-10-02 22:03:40 -0700721type jniLib struct {
Colin Cross403cc152020-07-06 14:15:24 -0700722 name string
723 path android.Path
724 target android.Target
725 coverageFile android.OptionalPath
726 unstrippedFile android.Path
Colin Crossa4f08812018-10-02 22:03:40 -0700727}
728
Colin Cross0ea8ba82019-06-06 14:33:29 -0700729func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
Roland Levillainada12702020-06-09 13:07:36 +0100730 return j.properties.Instrument &&
731 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
732 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
Colin Cross3144dfc2018-01-03 15:06:47 -0800733}
734
Colin Cross0ea8ba82019-06-06 14:33:29 -0700735func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800736 return j.shouldInstrument(ctx) &&
737 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
738 ctx.Config().UnbundledBuild())
739}
740
Chris Gross190fdc02020-05-29 16:01:19 +0000741func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
742 // Force enable the instrumentation for java code that is built for APEXes ...
743 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
744 // doesn't make sense) or framework libraries (e.g. libraries found in the InstrumentFrameworkModules list) unless EMMA_INSTRUMENT_FRAMEWORK is true.
Colin Cross56a83212020-09-15 18:30:11 -0700745 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
Chris Gross190fdc02020-05-29 16:01:19 +0000746 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Colin Cross56a83212020-09-15 18:30:11 -0700747 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Chris Gross190fdc02020-05-29 16:01:19 +0000748 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
749 return true
750 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
751 return true
752 }
753 }
754 return false
755}
756
Jiyong Park6a927c42020-01-21 02:03:43 +0900757func (j *Module) sdkVersion() sdkSpec {
758 return sdkSpecFrom(String(j.deviceProperties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -0700759}
760
Paul Duffine25c6442019-10-11 13:50:28 +0100761func (j *Module) systemModules() string {
762 return proptools.String(j.deviceProperties.System_modules)
763}
764
Jiyong Park6a927c42020-01-21 02:03:43 +0900765func (j *Module) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -0700766 if j.deviceProperties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900767 return sdkSpecFrom(*j.deviceProperties.Min_sdk_version)
Colin Cross83bb3162018-06-25 15:48:06 -0700768 }
769 return j.sdkVersion()
770}
771
Jiyong Park6a927c42020-01-21 02:03:43 +0900772func (j *Module) targetSdkVersion() sdkSpec {
Dan Willemsen419290a2018-10-31 15:28:47 -0700773 if j.deviceProperties.Target_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900774 return sdkSpecFrom(*j.deviceProperties.Target_sdk_version)
Dan Willemsen419290a2018-10-31 15:28:47 -0700775 }
776 return j.sdkVersion()
777}
778
Artur Satayev480e25b2020-04-27 18:53:18 +0100779func (j *Module) MinSdkVersion() string {
780 return j.minSdkVersion().version.String()
781}
782
Jiyong Parkb02bb402019-12-03 00:43:57 +0900783func (j *Module) AvailableFor(what string) bool {
784 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
785 // Exception: for hostdex: true libraries, the platform variant is created
786 // even if it's not marked as available to platform. In that case, the platform
787 // variant is used only for the hostdex and not installed to the device.
788 return true
789 }
790 return j.ApexModuleBase.AvailableFor(what)
791}
792
Liz Kammerd6c31d22020-08-05 15:40:41 -0700793func sdkDeps(ctx android.BottomUpMutatorContext, sdkContext sdkContext, d dexer) {
794 sdkDep := decodeSdkDep(ctx, sdkContext)
795 if sdkDep.useModule {
796 ctx.AddVariationDependencies(nil, bootClasspathTag, sdkDep.bootclasspath...)
797 ctx.AddVariationDependencies(nil, java9LibTag, sdkDep.java9Classpath...)
798 ctx.AddVariationDependencies(nil, libTag, sdkDep.classpath...)
799 if d.effectiveOptimizeEnabled() && sdkDep.hasStandardLibs() {
800 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.LegacyCorePlatformBootclasspathLibraries...)
801 }
802 if d.effectiveOptimizeEnabled() && sdkDep.hasFrameworkLibs() {
803 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.FrameworkLibraries...)
804 }
805 }
806 if sdkDep.systemModules != "" {
807 ctx.AddVariationDependencies(nil, systemModulesTag, sdkDep.systemModules)
808 }
809}
810
Colin Crossbe1da472017-07-07 15:59:46 -0700811func (j *Module) deps(ctx android.BottomUpMutatorContext) {
Colin Cross1369cdb2017-09-29 17:58:17 -0700812 if ctx.Device() {
Colin Cross92e4b462020-06-18 15:56:48 -0700813 j.linter.deps(ctx)
814
Liz Kammerd6c31d22020-08-05 15:40:41 -0700815 sdkDeps(ctx, sdkContext(j), j.dexer)
Colin Cross2fe66872015-03-30 17:20:39 -0700816 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700817
Inseob Kimac1e9862019-12-09 18:15:47 +0900818 syspropPublicStubs := syspropPublicStubs(ctx.Config())
819
820 // rewriteSyspropLibs validates if a java module can link against platform's sysprop_library,
821 // and redirects dependency to public stub depending on the link type.
822 rewriteSyspropLibs := func(libs []string, prop string) []string {
823 // make a copy
824 ret := android.CopyOf(libs)
825
826 for idx, lib := range libs {
827 stub, ok := syspropPublicStubs[lib]
828
829 if !ok {
830 continue
831 }
832
833 linkType, _ := j.getLinkType(ctx.ModuleName())
Inseob Kimc5239512020-01-14 15:36:21 +0900834 // only platform modules can use internal props
835 if linkType != javaPlatform {
Inseob Kimac1e9862019-12-09 18:15:47 +0900836 ret[idx] = stub
Inseob Kimac1e9862019-12-09 18:15:47 +0900837 }
838 }
839
840 return ret
841 }
842
Ulya Trafimovich39b437b2020-09-23 16:42:35 +0100843 libDeps := ctx.AddVariationDependencies(nil, libTag, rewriteSyspropLibs(j.properties.Libs, "libs")...)
Inseob Kimac1e9862019-12-09 18:15:47 +0900844 ctx.AddVariationDependencies(nil, staticLibTag, rewriteSyspropLibs(j.properties.Static_libs, "static_libs")...)
Colin Crossa4f08812018-10-02 22:03:40 -0700845
Paul Duffin031d8692021-02-12 11:46:42 +0000846 // Add dependency on libraries that provide additional hidden api annotations.
847 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
848
JaeMan Parkff715562020-10-19 17:25:58 +0900849 if ctx.DeviceConfig().VndkVersion() != "" && ctx.Config().EnforceInterPartitionJavaSdkLibrary() {
850 // Require java_sdk_library at inter-partition java dependency to ensure stable
851 // interface between partitions. If inter-partition java_library dependency is detected,
852 // raise build error because java_library doesn't have a stable interface.
853 //
854 // Inputs:
855 // PRODUCT_ENFORCE_INTER_PARTITION_JAVA_SDK_LIBRARY
856 // if true, enable enforcement
857 // PRODUCT_INTER_PARTITION_JAVA_LIBRARY_ALLOWLIST
858 // exception list of java_library names to allow inter-partition dependency
859 for idx, lib := range j.properties.Libs {
860 if libDeps[idx] == nil {
861 continue
862 }
863
864 if _, ok := syspropPublicStubs[lib]; ok {
865 continue
866 }
867
868 if javaDep, ok := libDeps[idx].(javaSdkLibraryEnforceContext); ok {
869 // java_sdk_library is always allowed at inter-partition dependency.
870 // So, skip check.
871 if _, ok := javaDep.(*SdkLibrary); ok {
872 continue
873 }
874
875 j.checkPartitionsForJavaDependency(ctx, "libs", javaDep)
876 }
877 }
878 }
879
Ulya Trafimovich39b437b2020-09-23 16:42:35 +0100880 // For library dependencies that are component libraries (like stubs), add the implementation
881 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
882 for _, dep := range libDeps {
883 if dep != nil {
884 if component, ok := dep.(SdkLibraryComponentDependency); ok {
885 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
886 ctx.AddVariationDependencies(nil, usesLibTag, *lib)
887 }
888 }
889 }
890 }
891
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700892 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Colin Cross748b2d82020-11-19 13:52:06 -0800893 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000894 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800895
Colin Crossfe17f6f2019-03-28 19:30:56 -0700896 android.ProtoDeps(ctx, &j.protoProperties)
Colin Cross6af17aa2017-09-20 12:59:05 -0700897 if j.hasSrcExt(".proto") {
898 protoDeps(ctx, &j.protoProperties)
899 }
Colin Cross93e85952017-08-15 13:34:18 -0700900
901 if j.hasSrcExt(".kt") {
902 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
903 // Kotlin files
Colin Cross0b03d972019-05-13 11:06:25 -0700904 ctx.AddVariationDependencies(nil, kotlinStdlibTag,
905 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8")
Colin Cross7788c122019-01-23 16:14:02 -0800906 if len(j.properties.Plugins) > 0 {
Colin Crossafbb1732019-01-17 15:42:52 -0800907 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
908 }
Colin Cross93e85952017-08-15 13:34:18 -0700909 }
Colin Cross3144dfc2018-01-03 15:06:47 -0800910
Ulya Trafimovich38dfa0f2020-01-07 16:37:02 +0000911 // Framework libraries need special handling in static coverage builds: they should not have
912 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
913 // the same jacoco classes coming from different bootclasspath jars.
914 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
915 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
916 j.properties.Instrument = true
917 }
918 } else if j.shouldInstrumentStatic(ctx) {
Colin Cross42d48b72018-08-29 14:10:52 -0700919 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
Colin Cross3144dfc2018-01-03 15:06:47 -0800920 }
Colin Cross6af17aa2017-09-20 12:59:05 -0700921}
922
923func hasSrcExt(srcs []string, ext string) bool {
924 for _, src := range srcs {
925 if filepath.Ext(src) == ext {
926 return true
927 }
928 }
929
930 return false
931}
932
933func (j *Module) hasSrcExt(ext string) bool {
934 return hasSrcExt(j.properties.Srcs, ext)
Colin Cross2fe66872015-03-30 17:20:39 -0700935}
936
Colin Cross46c9b8b2017-06-22 16:51:17 -0700937func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Colin Cross3047fa22019-04-18 10:56:44 -0700938 aidlIncludeDirs android.Paths) (string, android.Paths) {
Colin Crossc0b06f12015-04-08 13:03:43 -0700939
Colin Crossebe1a512017-11-14 13:12:14 -0800940 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
941 aidlIncludes = append(aidlIncludes,
942 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
943 aidlIncludes = append(aidlIncludes,
944 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
Colin Crossc0b06f12015-04-08 13:03:43 -0700945
Colin Cross3047fa22019-04-18 10:56:44 -0700946 var flags []string
947 var deps android.Paths
Steven Moreland667f6882018-07-26 12:55:08 -0700948
Jooyung Hane197d8b2021-01-05 10:33:16 +0900949 flags = append(flags, j.deviceProperties.Aidl.Flags...)
950
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700951 if aidlPreprocess.Valid() {
952 flags = append(flags, "-p"+aidlPreprocess.String())
Colin Cross3047fa22019-04-18 10:56:44 -0700953 deps = append(deps, aidlPreprocess.Path())
954 } else if len(aidlIncludeDirs) > 0 {
Colin Cross635c3b02016-05-18 15:37:25 -0700955 flags = append(flags, android.JoinWithPrefix(aidlIncludeDirs.Strings(), "-I"))
Colin Crossc0b06f12015-04-08 13:03:43 -0700956 }
957
Colin Cross3047fa22019-04-18 10:56:44 -0700958 if len(j.exportAidlIncludeDirs) > 0 {
959 flags = append(flags, android.JoinWithPrefix(j.exportAidlIncludeDirs.Strings(), "-I"))
960 }
961
962 if len(aidlIncludes) > 0 {
963 flags = append(flags, android.JoinWithPrefix(aidlIncludes.Strings(), "-I"))
964 }
965
Colin Cross635c3b02016-05-18 15:37:25 -0700966 flags = append(flags, "-I"+android.PathForModuleSrc(ctx).String())
Colin Cross32f38982018-02-22 11:47:25 -0800967 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Colin Crossd48633a2017-07-13 14:41:17 -0700968 flags = append(flags, "-I"+src.String())
969 }
Colin Crossc0b06f12015-04-08 13:03:43 -0700970
Martijn Coeneneab15642018-03-09 09:29:59 +0100971 if Bool(j.deviceProperties.Aidl.Generate_traces) {
972 flags = append(flags, "-t")
973 }
974
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100975 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
976 flags = append(flags, "--transaction_names")
977 }
978
Colin Cross3047fa22019-04-18 10:56:44 -0700979 return strings.Join(flags, " "), deps
Colin Crossc0b06f12015-04-08 13:03:43 -0700980}
981
Colin Cross32f676a2017-09-06 13:41:06 -0700982type deps struct {
Colin Cross748b2d82020-11-19 13:52:06 -0800983 classpath classpath
984 java9Classpath classpath
985 bootClasspath classpath
986 processorPath classpath
987 errorProneProcessorPath classpath
988 processorClasses []string
989 staticJars android.Paths
990 staticHeaderJars android.Paths
991 staticResourceJars android.Paths
992 aidlIncludeDirs android.Paths
993 srcs android.Paths
994 srcJars android.Paths
995 systemModules *systemModules
996 aidlPreprocess android.OptionalPath
997 kotlinStdlib android.Paths
998 kotlinAnnotations android.Paths
Colin Crossbe9cdb82019-01-21 21:37:16 -0800999
1000 disableTurbine bool
Colin Cross32f676a2017-09-06 13:41:06 -07001001}
Colin Cross2fe66872015-03-30 17:20:39 -07001002
Colin Cross54250902017-12-05 09:28:08 -08001003func checkProducesJars(ctx android.ModuleContext, dep android.SourceFileProducer) {
1004 for _, f := range dep.Srcs() {
1005 if f.Ext() != ".jar" {
1006 ctx.ModuleErrorf("genrule %q must generate files ending with .jar to be used as a libs or static_libs dependency",
1007 ctx.OtherModuleName(dep.(blueprint.Module)))
1008 }
1009 }
1010}
1011
Jiyong Park2d492942018-03-05 17:44:10 +09001012type linkType int
1013
1014const (
Jiyong Park50146e92020-01-30 18:00:15 +09001015 // TODO(jiyong) rename these for better readability. Make the allowed
1016 // and disallowed link types explicit
Jiyong Park7f87e1a2021-02-18 20:29:05 +09001017 // order is important here. See rank()
Jiyong Park2d492942018-03-05 17:44:10 +09001018 javaCore linkType = iota
1019 javaSdk
1020 javaSystem
Jiyong Park50146e92020-01-30 18:00:15 +09001021 javaModule
Jiyong Parkaae9bd12020-02-12 04:36:43 +09001022 javaSystemServer
Jiyong Park2d492942018-03-05 17:44:10 +09001023 javaPlatform
1024)
1025
Jiyong Park670e0f62021-02-18 13:10:18 +09001026func (lt linkType) String() string {
1027 switch lt {
1028 case javaCore:
1029 return "core Java API"
1030 case javaSdk:
1031 return "Android API"
1032 case javaSystem:
1033 return "system API"
1034 case javaModule:
1035 return "module API"
1036 case javaSystemServer:
1037 return "system server API"
1038 case javaPlatform:
1039 return "private API"
1040 default:
1041 panic(fmt.Errorf("unrecognized linktype: %v", lt))
1042 }
1043}
1044
Jiyong Park7f87e1a2021-02-18 20:29:05 +09001045// rank determins the total order among linkTypes. A link type of rank A can link to another link
1046// type of rank B only when B <= A
1047func (lt linkType) rank() int {
1048 return int(lt)
1049}
1050
Jeongik Cha75b83b02019-11-01 15:28:00 +09001051type linkTypeContext interface {
1052 android.Module
1053 getLinkType(name string) (ret linkType, stubs bool)
1054}
1055
1056func (m *Module) getLinkType(name string) (ret linkType, stubs bool) {
Anton Hanssoncc51a682020-05-19 12:06:48 +01001057 switch name {
Pete Gillin1f41dbf2020-06-02 15:59:45 +01001058 case "core.current.stubs", "legacy.core.platform.api.stubs", "stable.core.platform.api.stubs",
1059 "stub-annotations", "private-stub-annotations-jar",
1060 "core-lambda-stubs", "core-generated-annotation-stubs":
Jiyong Park46f78fb2018-10-20 16:33:17 +09001061 return javaCore, true
Anton Hanssoncc51a682020-05-19 12:06:48 +01001062 case "android_stubs_current":
Jiyong Park46f78fb2018-10-20 16:33:17 +09001063 return javaSdk, true
Anton Hanssoncc51a682020-05-19 12:06:48 +01001064 case "android_system_stubs_current":
1065 return javaSystem, true
1066 case "android_module_lib_stubs_current":
Jiyong Park50146e92020-01-30 18:00:15 +09001067 return javaModule, true
Anton Hanssoncc51a682020-05-19 12:06:48 +01001068 case "android_system_server_stubs_current":
Jiyong Parkaae9bd12020-02-12 04:36:43 +09001069 return javaSystemServer, true
Anton Hanssoncc51a682020-05-19 12:06:48 +01001070 case "android_test_stubs_current":
1071 return javaSystem, true
Jiyong Park2d492942018-03-05 17:44:10 +09001072 }
Anton Hanssoncc51a682020-05-19 12:06:48 +01001073
Anton Hansson2d0c1942020-05-25 12:20:51 +01001074 if stub, linkType := moduleStubLinkType(name); stub {
1075 return linkType, true
1076 }
1077
Anton Hanssoncc51a682020-05-19 12:06:48 +01001078 ver := m.sdkVersion()
1079 switch ver.kind {
1080 case sdkCore:
1081 return javaCore, false
1082 case sdkSystem:
1083 return javaSystem, false
1084 case sdkPublic:
1085 return javaSdk, false
1086 case sdkModule:
1087 return javaModule, false
1088 case sdkSystemServer:
1089 return javaSystemServer, false
1090 case sdkPrivate, sdkNone, sdkCorePlatform, sdkTest:
1091 return javaPlatform, false
1092 }
1093
1094 if !ver.valid() {
1095 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.raw))
1096 }
1097 return javaSdk, false
Jiyong Park2d492942018-03-05 17:44:10 +09001098}
1099
Jeongik Cha75b83b02019-11-01 15:28:00 +09001100func checkLinkType(ctx android.ModuleContext, from *Module, to linkTypeContext, tag dependencyTag) {
Colin Crossf19b9bb2018-03-26 14:42:44 -07001101 if ctx.Host() {
1102 return
1103 }
1104
Jeongik Cha75b83b02019-11-01 15:28:00 +09001105 myLinkType, stubs := from.getLinkType(ctx.ModuleName())
Jiyong Park46f78fb2018-10-20 16:33:17 +09001106 if stubs {
1107 return
1108 }
Jeongik Cha75b83b02019-11-01 15:28:00 +09001109 otherLinkType, _ := to.getLinkType(ctx.OtherModuleName(to))
Jiyong Park2d492942018-03-05 17:44:10 +09001110
Jiyong Park7f87e1a2021-02-18 20:29:05 +09001111 if myLinkType.rank() < otherLinkType.rank() {
Jiyong Park670e0f62021-02-18 13:10:18 +09001112 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
1113 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
1114 "property of the source or target module so that target module is built "+
1115 "with the same or smaller API set when compared to the source.",
1116 myLinkType, ctx.OtherModuleName(to), otherLinkType)
1117 }
Jiyong Park750e5572018-01-31 00:20:13 +09001118}
1119
Colin Cross32f676a2017-09-06 13:41:06 -07001120func (j *Module) collectDeps(ctx android.ModuleContext) deps {
1121 var deps deps
Colin Crossfc3674a2017-09-18 17:41:52 -07001122
Colin Cross300f0382018-03-06 13:11:51 -08001123 if ctx.Device() {
Colin Cross83bb3162018-06-25 15:48:06 -07001124 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross300f0382018-03-06 13:11:51 -08001125 if sdkDep.invalidVersion {
Colin Cross6cef4812019-10-17 14:23:50 -07001126 ctx.AddMissingDependencies(sdkDep.bootclasspath)
1127 ctx.AddMissingDependencies(sdkDep.java9Classpath)
Colin Cross300f0382018-03-06 13:11:51 -08001128 } else if sdkDep.useFiles {
1129 // sdkDep.jar is actually equivalent to turbine header.jar.
Colin Cross86a60ae2018-05-29 14:44:55 -07001130 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross3047fa22019-04-18 10:56:44 -07001131 deps.aidlPreprocess = sdkDep.aidl
1132 } else {
1133 deps.aidlPreprocess = sdkDep.aidl
Colin Cross300f0382018-03-06 13:11:51 -08001134 }
Colin Crossfc3674a2017-09-18 17:41:52 -07001135 }
1136
Colin Crossd11fcda2017-10-23 17:59:01 -07001137 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross2fe66872015-03-30 17:20:39 -07001138 otherName := ctx.OtherModuleName(module)
Colin Crossec7a0422017-07-07 14:47:12 -07001139 tag := ctx.OtherModuleDependencyTag(module)
1140
Colin Crossde78d132020-10-09 18:59:49 -07001141 if IsJniDepTag(tag) {
Colin Crossbd01e2a2018-10-04 15:21:03 -07001142 // Handled by AndroidApp.collectAppDeps
1143 return
1144 }
1145 if tag == certificateTag {
1146 // Handled by AndroidApp.collectAppDeps
Colin Crossa4f08812018-10-02 22:03:40 -07001147 return
1148 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +01001149
Colin Crossdcf71b22021-02-01 13:59:03 -08001150 if dep, ok := module.(SdkLibraryDependency); ok {
Colin Cross897d2ed2019-02-11 14:03:51 -08001151 switch tag {
1152 case libTag:
1153 deps.classpath = append(deps.classpath, dep.SdkHeaderJars(ctx, j.sdkVersion())...)
Colin Cross79c7c262019-04-17 11:11:46 -07001154 case staticLibTag:
Colin Cross897d2ed2019-02-11 14:03:51 -08001155 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
1156 }
Colin Crossdcf71b22021-02-01 13:59:03 -08001157 } else if ctx.OtherModuleHasProvider(module, JavaInfoProvider) {
1158 dep := ctx.OtherModuleProvider(module, JavaInfoProvider).(JavaInfo)
Colin Cross54250902017-12-05 09:28:08 -08001159 switch tag {
1160 case bootClasspathTag:
Colin Crossdcf71b22021-02-01 13:59:03 -08001161 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Colin Cross4b964c02018-10-15 16:18:06 -07001162 case libTag, instrumentationForTag:
Colin Crossdcf71b22021-02-01 13:59:03 -08001163 deps.classpath = append(deps.classpath, dep.HeaderJars...)
1164 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
1165 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
1166 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Colin Cross6cef4812019-10-17 14:23:50 -07001167 case java9LibTag:
Colin Crossdcf71b22021-02-01 13:59:03 -08001168 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
Colin Cross54250902017-12-05 09:28:08 -08001169 case staticLibTag:
Colin Crossdcf71b22021-02-01 13:59:03 -08001170 deps.classpath = append(deps.classpath, dep.HeaderJars...)
1171 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
1172 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
1173 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
1174 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
1175 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
Colin Crossc9fe10f2020-11-19 18:06:03 -08001176 // Turbine doesn't run annotation processors, so any module that uses an
1177 // annotation processor that generates API is incompatible with the turbine
1178 // optimization.
Colin Crossdcf71b22021-02-01 13:59:03 -08001179 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Colin Crossbe9cdb82019-01-21 21:37:16 -08001180 case pluginTag:
Colin Crossdcf71b22021-02-01 13:59:03 -08001181 if plugin, ok := module.(*Plugin); ok {
Colin Crossbe9cdb82019-01-21 21:37:16 -08001182 if plugin.pluginProperties.Processor_class != nil {
Colin Crossdcf71b22021-02-01 13:59:03 -08001183 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
Artur Satayev9cf46692019-11-26 18:08:34 +00001184 } else {
Colin Crossdcf71b22021-02-01 13:59:03 -08001185 addPlugins(&deps, dep.ImplementationAndResourcesJars)
Colin Crossbe9cdb82019-01-21 21:37:16 -08001186 }
Colin Crossc9fe10f2020-11-19 18:06:03 -08001187 // Turbine doesn't run annotation processors, so any module that uses an
1188 // annotation processor that generates API is incompatible with the turbine
1189 // optimization.
Colin Crossbe9cdb82019-01-21 21:37:16 -08001190 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
1191 } else {
1192 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
1193 }
Colin Cross748b2d82020-11-19 13:52:06 -08001194 case errorpronePluginTag:
Colin Crossdcf71b22021-02-01 13:59:03 -08001195 if _, ok := module.(*Plugin); ok {
1196 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
Colin Cross748b2d82020-11-19 13:52:06 -08001197 } else {
1198 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
1199 }
Artur Satayev9cf46692019-11-26 18:08:34 +00001200 case exportedPluginTag:
Colin Crossdcf71b22021-02-01 13:59:03 -08001201 if plugin, ok := module.(*Plugin); ok {
1202 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
Artur Satayev9cf46692019-11-26 18:08:34 +00001203 if plugin.pluginProperties.Processor_class != nil {
1204 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
1205 }
Colin Crossc9fe10f2020-11-19 18:06:03 -08001206 // Turbine doesn't run annotation processors, so any module that uses an
1207 // annotation processor that generates API is incompatible with the turbine
1208 // optimization.
1209 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
Artur Satayev9cf46692019-11-26 18:08:34 +00001210 } else {
1211 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
1212 }
Colin Cross54250902017-12-05 09:28:08 -08001213 case kotlinStdlibTag:
Colin Crossdcf71b22021-02-01 13:59:03 -08001214 deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars...)
Colin Crossafbb1732019-01-17 15:42:52 -08001215 case kotlinAnnotationsTag:
Colin Crossdcf71b22021-02-01 13:59:03 -08001216 deps.kotlinAnnotations = dep.HeaderJars
Colin Cross54250902017-12-05 09:28:08 -08001217 }
Colin Crossdcf71b22021-02-01 13:59:03 -08001218 } else if dep, ok := module.(android.SourceFileProducer); ok {
Colin Cross54250902017-12-05 09:28:08 -08001219 switch tag {
1220 case libTag:
1221 checkProducesJars(ctx, dep)
1222 deps.classpath = append(deps.classpath, dep.Srcs()...)
1223 case staticLibTag:
1224 checkProducesJars(ctx, dep)
1225 deps.classpath = append(deps.classpath, dep.Srcs()...)
1226 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
1227 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Cross54250902017-12-05 09:28:08 -08001228 }
Colin Crossdcf71b22021-02-01 13:59:03 -08001229 } else {
Colin Crossec7a0422017-07-07 14:47:12 -07001230 switch tag {
Paul Duffin68289b02019-09-20 13:50:52 +01001231 case bootClasspathTag:
1232 // If a system modules dependency has been added to the bootclasspath
1233 // then add its libs to the bootclasspath.
Paul Duffin83a2d962019-11-19 19:44:10 +00001234 sm := module.(SystemModulesProvider)
1235 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars()...)
Paul Duffin68289b02019-09-20 13:50:52 +01001236
Colin Cross1369cdb2017-09-29 17:58:17 -07001237 case systemModulesTag:
1238 if deps.systemModules != nil {
1239 panic("Found two system module dependencies")
1240 }
Paul Duffin83a2d962019-11-19 19:44:10 +00001241 sm := module.(SystemModulesProvider)
1242 outputDir, outputDeps := sm.OutputDirAndDeps()
1243 deps.systemModules = &systemModules{outputDir, outputDeps}
Colin Cross2fe66872015-03-30 17:20:39 -07001244 }
Colin Crossec7a0422017-07-07 14:47:12 -07001245 }
Ulya Trafimovich65b03192020-12-03 16:50:22 +00001246
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00001247 addCLCFromDep(ctx, module, j.classLoaderContexts)
Colin Cross2fe66872015-03-30 17:20:39 -07001248 })
1249
Colin Cross32f676a2017-09-06 13:41:06 -07001250 return deps
Colin Cross2fe66872015-03-30 17:20:39 -07001251}
1252
Artur Satayev9cf46692019-11-26 18:08:34 +00001253func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
1254 deps.processorPath = append(deps.processorPath, pluginJars...)
1255 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
1256}
1257
Colin Cross1e743852019-10-28 11:37:20 -07001258func getJavaVersion(ctx android.ModuleContext, javaVersion string, sdkContext sdkContext) javaVersion {
Nan Zhang357466b2018-04-17 17:38:36 -07001259 if javaVersion != "" {
Colin Cross1e743852019-10-28 11:37:20 -07001260 return normalizeJavaVersion(ctx, javaVersion)
Colin Cross17dec172020-05-14 18:05:32 -07001261 } else if ctx.Device() {
1262 return sdkContext.sdkVersion().defaultJavaLanguageVersion(ctx)
Nan Zhang357466b2018-04-17 17:38:36 -07001263 } else {
Colin Cross1e743852019-10-28 11:37:20 -07001264 return JAVA_VERSION_9
Nan Zhang357466b2018-04-17 17:38:36 -07001265 }
Nan Zhang357466b2018-04-17 17:38:36 -07001266}
1267
Colin Cross1e743852019-10-28 11:37:20 -07001268type javaVersion int
1269
1270const (
1271 JAVA_VERSION_UNSUPPORTED = 0
1272 JAVA_VERSION_6 = 6
1273 JAVA_VERSION_7 = 7
1274 JAVA_VERSION_8 = 8
1275 JAVA_VERSION_9 = 9
1276)
1277
1278func (v javaVersion) String() string {
1279 switch v {
1280 case JAVA_VERSION_6:
1281 return "1.6"
1282 case JAVA_VERSION_7:
1283 return "1.7"
1284 case JAVA_VERSION_8:
1285 return "1.8"
1286 case JAVA_VERSION_9:
1287 return "1.9"
1288 default:
1289 return "unsupported"
1290 }
1291}
1292
1293// Returns true if javac targeting this version uses system modules instead of a bootclasspath.
1294func (v javaVersion) usesJavaModules() bool {
1295 return v >= 9
1296}
1297
1298func normalizeJavaVersion(ctx android.BaseModuleContext, javaVersion string) javaVersion {
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001299 switch javaVersion {
1300 case "1.6", "6":
Colin Cross1e743852019-10-28 11:37:20 -07001301 return JAVA_VERSION_6
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001302 case "1.7", "7":
Colin Cross1e743852019-10-28 11:37:20 -07001303 return JAVA_VERSION_7
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001304 case "1.8", "8":
Colin Cross1e743852019-10-28 11:37:20 -07001305 return JAVA_VERSION_8
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001306 case "1.9", "9":
Colin Cross1e743852019-10-28 11:37:20 -07001307 return JAVA_VERSION_9
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001308 case "10", "11":
1309 ctx.PropertyErrorf("java_version", "Java language levels above 9 are not supported")
Colin Cross1e743852019-10-28 11:37:20 -07001310 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001311 default:
1312 ctx.PropertyErrorf("java_version", "Unrecognized Java language level")
Colin Cross1e743852019-10-28 11:37:20 -07001313 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001314 }
1315}
1316
Nan Zhanged19fc32017-10-19 13:06:22 -07001317func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
Colin Crossc0b06f12015-04-08 13:03:43 -07001318
Colin Crossf03c82b2015-04-13 13:53:40 -07001319 var flags javaBuilderFlags
1320
Tobias Thierer06dd04f2018-09-11 16:21:05 +01001321 // javaVersion flag.
1322 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), sdkContext(j))
1323
Colin Cross66548102018-06-19 22:47:35 -07001324 if ctx.Config().RunErrorProne() {
Colin Cross748b2d82020-11-19 13:52:06 -08001325 if config.ErrorProneClasspath == nil && ctx.Config().TestProductVariables == nil {
Colin Cross66548102018-06-19 22:47:35 -07001326 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1327 }
1328
1329 errorProneFlags := []string{
1330 "-Xplugin:ErrorProne",
1331 "${config.ErrorProneChecks}",
1332 }
1333 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1334
1335 flags.errorProneExtraJavacFlags = "${config.ErrorProneFlags} " +
1336 "'" + strings.Join(errorProneFlags, " ") + "'"
1337 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
Andreas Gampef3e5b552018-01-22 21:27:21 -08001338 }
1339
Nan Zhanged19fc32017-10-19 13:06:22 -07001340 // classpath
Nan Zhang581fd212018-01-10 16:06:12 -08001341 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1342 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross6cef4812019-10-17 14:23:50 -07001343 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
Colin Cross6a77c982018-06-19 22:43:34 -07001344 flags.processorPath = append(flags.processorPath, deps.processorPath...)
Colin Cross748b2d82020-11-19 13:52:06 -08001345 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
Colin Cross7fdd2b72018-01-02 18:14:25 -08001346
Colin Cross5a116862020-04-22 11:44:34 -07001347 flags.processors = append(flags.processors, deps.processorClasses...)
1348 flags.processors = android.FirstUniqueStrings(flags.processors)
Colin Crossbe9cdb82019-01-21 21:37:16 -08001349
Colin Cross1e743852019-10-28 11:37:20 -07001350 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
1351 decodeSdkDep(ctx, sdkContext(j)).hasStandardLibs() {
Colin Cross7fdd2b72018-01-02 18:14:25 -08001352 // Give host-side tools a version of OpenJDK's standard libraries
1353 // close to what they're targeting. As of Dec 2017, AOSP is only
1354 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1355 //
1356 // When building with OpenJDK 8, the following should have no
1357 // effect since those jars would be available by default.
1358 //
1359 // When building with OpenJDK 9 but targeting a version < 1.8,
1360 // putting them on the bootclasspath means that:
1361 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1362 // b) references to existing APIs are not reinterpreted in an
1363 // OpenJDK 9-specific way, eg. calls to subclasses of
1364 // java.nio.Buffer as in http://b/70862583
1365 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1366 flags.bootClasspath = append(flags.bootClasspath,
1367 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1368 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
Nan Zhang5f8cb422018-02-06 10:34:32 -08001369 if Bool(j.properties.Use_tools_jar) {
1370 flags.bootClasspath = append(flags.bootClasspath,
1371 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1372 }
Colin Cross7fdd2b72018-01-02 18:14:25 -08001373 }
1374
Nan Zhanged19fc32017-10-19 13:06:22 -07001375 // systemModules
Colin Crossb77043e2019-07-16 13:57:13 -07001376 flags.systemModules = deps.systemModules
Colin Cross1369cdb2017-09-29 17:58:17 -07001377
Nan Zhanged19fc32017-10-19 13:06:22 -07001378 // aidl flags.
Colin Cross3047fa22019-04-18 10:56:44 -07001379 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs)
Colin Cross2fe66872015-03-30 17:20:39 -07001380
Jingwen Chen9cb8d1b2020-10-21 10:06:35 -04001381 return flags
1382}
1383
Jingwen Chen5136a6e2020-10-30 01:01:35 -04001384func (j *Module) collectJavacFlags(
1385 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
Jingwen Chen9cb8d1b2020-10-21 10:06:35 -04001386 // javac flags.
1387 javacFlags := j.properties.Javacflags
1388
1389 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() {
1390 // For non-host binaries, override the -g flag passed globally to remove
1391 // local variable debug info to reduce disk and memory usage.
1392 javacFlags = append(javacFlags, "-g:source,lines")
1393 }
1394 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1395
1396 if flags.javaVersion.usesJavaModules() {
1397 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
1398
1399 if j.properties.Patch_module != nil {
1400 // Manually specify build directory in case it is not under the repo root.
Jingwen Chen5136a6e2020-10-30 01:01:35 -04001401 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
Jingwen Chen9cb8d1b2020-10-21 10:06:35 -04001402 // just adding a symlink under the root doesn't help.)
Jingwen Chen5136a6e2020-10-30 01:01:35 -04001403 patchPaths := []string{".", ctx.Config().BuildDir()}
1404
1405 // b/150878007
1406 //
1407 // Workaround to support *Bazel-executed* JDK9 javac in Bazel's
1408 // execution root for --patch-module. If this javac command line is
1409 // invoked within Bazel's execution root working directory, the top
1410 // level directories (e.g. libcore/, tools/, frameworks/) are all
1411 // symlinks. JDK9 javac does not traverse into symlinks, which causes
1412 // --patch-module to fail source file lookups when invoked in the
1413 // execution root.
1414 //
1415 // Short of patching javac or enumerating *all* directories as possible
1416 // input dirs, manually add the top level dir of the source files to be
1417 // compiled.
1418 topLevelDirs := map[string]bool{}
1419 for _, srcFilePath := range srcFiles {
1420 srcFileParts := strings.Split(srcFilePath.String(), "/")
1421 // Ignore source files that are already in the top level directory
1422 // as well as generated files in the out directory. The out
1423 // directory may be an absolute path, which means srcFileParts[0] is the
1424 // empty string, so check that as well. Note that "out" in Bazel's execution
1425 // root is *not* a symlink, which doesn't cause problems for --patch-modules
1426 // anyway, so it's fine to not apply this workaround for generated
1427 // source files.
1428 if len(srcFileParts) > 1 &&
1429 srcFileParts[0] != "" &&
1430 srcFileParts[0] != "out" {
1431 topLevelDirs[srcFileParts[0]] = true
1432 }
1433 }
1434 patchPaths = append(patchPaths, android.SortedStringKeys(topLevelDirs)...)
1435
Jingwen Chen9cb8d1b2020-10-21 10:06:35 -04001436 classPath := flags.classpath.FormJavaClassPath("")
1437 if classPath != "" {
Jingwen Chen5136a6e2020-10-30 01:01:35 -04001438 patchPaths = append(patchPaths, classPath)
Jingwen Chen9cb8d1b2020-10-21 10:06:35 -04001439 }
Jingwen Chen5136a6e2020-10-30 01:01:35 -04001440 javacFlags = append(
1441 javacFlags,
1442 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
Jingwen Chen9cb8d1b2020-10-21 10:06:35 -04001443 }
1444 }
1445
Colin Cross81440082018-08-15 20:21:55 -07001446 if len(javacFlags) > 0 {
1447 // optimization.
1448 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1449 flags.javacFlags = "$javacFlags"
1450 }
1451
Nan Zhanged19fc32017-10-19 13:06:22 -07001452 return flags
1453}
Colin Crossc0b06f12015-04-08 13:03:43 -07001454
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001455func (j *Module) compile(ctx android.ModuleContext, aaptSrcJar android.Path) {
Colin Crossebe1a512017-11-14 13:12:14 -08001456 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
Nan Zhanged19fc32017-10-19 13:06:22 -07001457
1458 deps := j.collectDeps(ctx)
1459 flags := j.collectBuilderFlags(ctx, deps)
1460
Colin Cross1e743852019-10-28 11:37:20 -07001461 if flags.javaVersion.usesJavaModules() {
Nan Zhanged19fc32017-10-19 13:06:22 -07001462 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
1463 }
Colin Cross8a497952019-03-05 22:25:09 -08001464 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Colin Cross6af17aa2017-09-20 12:59:05 -07001465 if hasSrcExt(srcFiles.Strings(), ".proto") {
Colin Cross0f2ee152017-12-14 15:22:43 -08001466 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
Colin Cross6af17aa2017-09-20 12:59:05 -07001467 }
1468
Colin Crossa4c8cc62020-06-25 17:13:36 -07001469 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1470 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1471 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1472 }
1473
Colin Crossaf050172017-11-15 23:01:59 -08001474 srcFiles = j.genSources(ctx, srcFiles, flags)
1475
Jingwen Chen5136a6e2020-10-30 01:01:35 -04001476 // Collect javac flags only after computing the full set of srcFiles to
1477 // ensure that the --patch-module lookup paths are complete.
1478 flags = j.collectJavacFlags(ctx, flags, srcFiles)
Jingwen Chen9cb8d1b2020-10-21 10:06:35 -04001479
Colin Crossaf050172017-11-15 23:01:59 -08001480 srcJars := srcFiles.FilterByExt(".srcjar")
Colin Cross59149b62017-10-16 18:07:29 -07001481 srcJars = append(srcJars, deps.srcJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001482 if aaptSrcJar != nil {
1483 srcJars = append(srcJars, aaptSrcJar)
1484 }
Colin Crossb7a63242015-04-16 14:09:14 -07001485
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001486 if j.properties.Jarjar_rules != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001487 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001488 }
1489
Colin Cross1ee23172017-10-18 14:44:18 -07001490 jarName := ctx.ModuleName() + ".jar"
1491
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001492 javaSrcFiles := srcFiles.FilterByExt(".java")
1493 var uniqueSrcFiles android.Paths
1494 set := make(map[string]bool)
1495 for _, v := range javaSrcFiles {
1496 if _, found := set[v.String()]; !found {
1497 set[v.String()] = true
1498 uniqueSrcFiles = append(uniqueSrcFiles, v)
1499 }
1500 }
1501
patricktu242faad2019-09-24 15:41:30 +08001502 // Collect .java files for AIDEGen
1503 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1504
Colin Cross55f63ea2018-08-27 12:37:09 -07001505 var kotlinJars android.Paths
1506
Colin Cross93e85952017-08-15 13:34:18 -07001507 if srcFiles.HasExt(".kt") {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001508 // user defined kotlin flags.
1509 kotlincFlags := j.properties.Kotlincflags
1510 CheckKotlincFlags(ctx, kotlincFlags)
1511
Mads Agerad2bfda2020-12-03 12:21:14 +01001512 // Dogfood the JVM_IR backend.
1513 kotlincFlags = append(kotlincFlags, "-Xuse-ir")
1514
Colin Cross93e85952017-08-15 13:34:18 -07001515 // If there are kotlin files, compile them first but pass all the kotlin and java files
1516 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1517 // won't emit any classes for them.
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001518 kotlincFlags = append(kotlincFlags, "-no-stdlib")
Colin Cross93e85952017-08-15 13:34:18 -07001519 if ctx.Device() {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001520 kotlincFlags = append(kotlincFlags, "-no-jdk")
1521 }
1522 if len(kotlincFlags) > 0 {
1523 // optimization.
1524 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1525 flags.kotlincFlags += "$kotlincFlags"
Colin Cross93e85952017-08-15 13:34:18 -07001526 }
1527
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001528 var kotlinSrcFiles android.Paths
1529 kotlinSrcFiles = append(kotlinSrcFiles, uniqueSrcFiles...)
1530 kotlinSrcFiles = append(kotlinSrcFiles, srcFiles.FilterByExt(".kt")...)
1531
patricktu242faad2019-09-24 15:41:30 +08001532 // Collect .kt files for AIDEGen
1533 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, srcFiles.FilterByExt(".kt").Strings()...)
Colin Crossa4c8cc62020-06-25 17:13:36 -07001534 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
patricktu242faad2019-09-24 15:41:30 +08001535
Colin Crossafbb1732019-01-17 15:42:52 -08001536 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1537 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1538
1539 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1540 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1541
1542 if len(flags.processorPath) > 0 {
1543 // Use kapt for annotation processing
1544 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
Colin Cross9ca38d22020-06-18 15:46:32 -07001545 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Colin Crossa4c8cc62020-06-25 17:13:36 -07001546 kotlinKapt(ctx, kaptSrcJar, kaptResJar, kotlinSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Colin Crossafbb1732019-01-17 15:42:52 -08001547 srcJars = append(srcJars, kaptSrcJar)
Colin Cross9ca38d22020-06-18 15:46:32 -07001548 kotlinJars = append(kotlinJars, kaptResJar)
Colin Crossafbb1732019-01-17 15:42:52 -08001549 // Disable annotation processing in javac, it's already been handled by kapt
1550 flags.processorPath = nil
Colin Cross5a116862020-04-22 11:44:34 -07001551 flags.processors = nil
Colin Crossafbb1732019-01-17 15:42:52 -08001552 }
Colin Cross93e85952017-08-15 13:34:18 -07001553
Colin Cross1ee23172017-10-18 14:44:18 -07001554 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Crossa4c8cc62020-06-25 17:13:36 -07001555 kotlinCompile(ctx, kotlinJar, kotlinSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Colin Cross93e85952017-08-15 13:34:18 -07001556 if ctx.Failed() {
1557 return
1558 }
1559
1560 // Make javac rule depend on the kotlinc rule
1561 flags.classpath = append(flags.classpath, kotlinJar)
Przemyslaw Szczepaniak66c0c402018-03-08 13:21:55 +00001562
Colin Cross55f63ea2018-08-27 12:37:09 -07001563 kotlinJars = append(kotlinJars, kotlinJar)
Colin Cross0b67a8b2020-06-18 15:52:01 -07001564 // Jar kotlin classes into the final jar after javac
1565 if BoolDefault(j.properties.Static_kotlin_stdlib, true) {
1566 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
1567 }
Colin Cross93e85952017-08-15 13:34:18 -07001568 }
1569
Colin Cross55f63ea2018-08-27 12:37:09 -07001570 jars := append(android.Paths(nil), kotlinJars...)
1571
Colin Cross5ab4e6d2017-11-22 16:20:45 -08001572 // Store the list of .java files that was passed to javac
1573 j.compiledJavaSrcs = uniqueSrcFiles
1574 j.compiledSrcJars = srcJars
1575
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001576 enableSharding := false
Colin Crossf7d84012020-02-21 08:16:41 -08001577 var headerJarFileWithoutJarjar android.Path
Colin Crossbe9cdb82019-01-21 21:37:16 -08001578 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !deps.disableTurbine {
Nan Zhang61eaedb2017-11-02 13:28:15 -07001579 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001580 enableSharding = true
Ashley Rosee36efcf2019-01-16 17:34:08 -05001581 // Formerly, there was a check here that prevented annotation processors
1582 // from being used when sharding was enabled, as some annotation processors
1583 // do not function correctly in sharded environments. It was removed to
1584 // allow for the use of annotation processors that do function correctly
1585 // with sharding enabled. See: b/77284273.
Nan Zhang61eaedb2017-11-02 13:28:15 -07001586 }
Colin Crossf7d84012020-02-21 08:16:41 -08001587 headerJarFileWithoutJarjar, j.headerJarFile =
1588 j.compileJavaHeader(ctx, uniqueSrcFiles, srcJars, deps, flags, jarName, kotlinJars)
Colin Crossf19b9bb2018-03-26 14:42:44 -07001589 if ctx.Failed() {
1590 return
Nan Zhanged19fc32017-10-19 13:06:22 -07001591 }
1592 }
Colin Cross8eadbf02017-10-24 17:46:00 -07001593 if len(uniqueSrcFiles) > 0 || len(srcJars) > 0 {
Colin Crossd6891432017-09-27 17:39:56 -07001594 var extraJarDeps android.Paths
Colin Cross66548102018-06-19 22:47:35 -07001595 if ctx.Config().RunErrorProne() {
Colin Crossc6bbef32017-08-14 14:16:06 -07001596 // If error-prone is enabled, add an additional rule to compile the java files into
1597 // a separate set of classes (so that they don't overwrite the normal ones and require
Colin Crossd6891432017-09-27 17:39:56 -07001598 // a rebuild when error-prone is turned off).
Colin Crossc6bbef32017-08-14 14:16:06 -07001599 // TODO(ccross): Once we always compile with javac9 we may be able to conditionally
1600 // enable error-prone without affecting the output class files.
Colin Cross1ee23172017-10-18 14:44:18 -07001601 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001602 RunErrorProne(ctx, errorprone, uniqueSrcFiles, srcJars, flags)
Colin Crossc6bbef32017-08-14 14:16:06 -07001603 extraJarDeps = append(extraJarDeps, errorprone)
1604 }
1605
Jaewoong Jung18aefc12020-12-21 09:11:10 -08001606 if enableSharding {
Colin Crossf7d84012020-02-21 08:16:41 -08001607 flags.classpath = append(flags.classpath, headerJarFileWithoutJarjar)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001608 shardSize := int(*(j.properties.Javac_shard_size))
1609 var shardSrcs []android.Paths
1610 if len(uniqueSrcFiles) > 0 {
Colin Cross0a2f7192019-09-23 14:33:09 -07001611 shardSrcs = android.ShardPaths(uniqueSrcFiles, shardSize)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001612 for idx, shardSrc := range shardSrcs {
Colin Cross3b706fd2019-09-05 16:44:18 -07001613 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1614 nil, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001615 jars = append(jars, classes)
1616 }
1617 }
1618 if len(srcJars) > 0 {
Colin Cross3b706fd2019-09-05 16:44:18 -07001619 classes := j.compileJavaClasses(ctx, jarName, len(shardSrcs),
1620 nil, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001621 jars = append(jars, classes)
1622 }
1623 } else {
Colin Cross3b706fd2019-09-05 16:44:18 -07001624 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueSrcFiles, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001625 jars = append(jars, classes)
1626 }
Colin Crossd6891432017-09-27 17:39:56 -07001627 if ctx.Failed() {
1628 return
1629 }
Colin Cross2fe66872015-03-30 17:20:39 -07001630 }
1631
Colin Cross0c4ce212019-05-03 15:28:19 -07001632 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1633
1634 var includeSrcJar android.WritablePath
1635 if Bool(j.properties.Include_srcs) {
1636 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1637 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1638 }
1639
Colin Crosscedd4762018-09-13 11:26:19 -07001640 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1641 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Colin Cross0f37af02017-09-27 17:42:05 -07001642 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
Colin Cross988708c2019-05-06 14:04:11 -07001643 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
Colin Cross0f37af02017-09-27 17:42:05 -07001644
1645 var resArgs []string
1646 var resDeps android.Paths
1647
1648 resArgs = append(resArgs, dirArgs...)
1649 resDeps = append(resDeps, dirDeps...)
1650
1651 resArgs = append(resArgs, fileArgs...)
1652 resDeps = append(resDeps, fileDeps...)
1653
Colin Cross988708c2019-05-06 14:04:11 -07001654 resArgs = append(resArgs, extraArgs...)
1655 resDeps = append(resDeps, extraDeps...)
1656
Colin Cross40a36712017-09-27 17:41:35 -07001657 if len(resArgs) > 0 {
Colin Cross1ee23172017-10-18 14:44:18 -07001658 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
Colin Crosse9a275b2017-10-16 17:09:48 -07001659 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Colin Cross331a1212018-08-15 20:40:52 -07001660 j.resourceJar = resourceJar
Colin Cross65bf4f22015-04-03 16:54:17 -07001661 if ctx.Failed() {
1662 return
1663 }
1664 }
1665
Colin Cross0c4ce212019-05-03 15:28:19 -07001666 var resourceJars android.Paths
1667 if j.resourceJar != nil {
1668 resourceJars = append(resourceJars, j.resourceJar)
1669 }
1670 if Bool(j.properties.Include_srcs) {
1671 resourceJars = append(resourceJars, includeSrcJar)
1672 }
1673 resourceJars = append(resourceJars, deps.staticResourceJars...)
Colin Cross331a1212018-08-15 20:40:52 -07001674
Colin Cross0c4ce212019-05-03 15:28:19 -07001675 if len(resourceJars) > 1 {
Colin Cross331a1212018-08-15 20:40:52 -07001676 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
Colin Cross0c4ce212019-05-03 15:28:19 -07001677 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
Colin Cross331a1212018-08-15 20:40:52 -07001678 false, nil, nil)
1679 j.resourceJar = combinedJar
Colin Cross0c4ce212019-05-03 15:28:19 -07001680 } else if len(resourceJars) == 1 {
1681 j.resourceJar = resourceJars[0]
Colin Cross331a1212018-08-15 20:40:52 -07001682 }
1683
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001684 if len(deps.staticJars) > 0 {
1685 jars = append(jars, deps.staticJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001686 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001687
Colin Cross094054a2018-10-17 15:10:48 -07001688 manifest := j.overrideManifest
1689 if !manifest.Valid() && j.properties.Manifest != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001690 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Colin Cross366938f2017-12-11 16:29:02 -08001691 }
Colin Cross635acc92017-09-12 22:50:46 -07001692
Colin Cross8a497952019-03-05 22:25:09 -08001693 services := android.PathsForModuleSrc(ctx, j.properties.Services)
Alex Light7f004a72019-02-21 13:27:37 -08001694 if len(services) > 0 {
1695 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1696 var zipargs []string
1697 for _, file := range services {
1698 serviceFile := file.String()
1699 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1700 }
Kousik Kumar366afc52020-05-20 11:27:16 -07001701 rule := zip
1702 args := map[string]string{
1703 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1704 }
Ramy Medhat16f23a42020-09-03 01:29:49 -04001705 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
Kousik Kumar366afc52020-05-20 11:27:16 -07001706 rule = zipRE
1707 args["implicits"] = strings.Join(services.Strings(), ",")
1708 }
Alex Light7f004a72019-02-21 13:27:37 -08001709 ctx.Build(pctx, android.BuildParams{
Kousik Kumar366afc52020-05-20 11:27:16 -07001710 Rule: rule,
Alex Light7f004a72019-02-21 13:27:37 -08001711 Output: servicesJar,
1712 Implicits: services,
Kousik Kumar366afc52020-05-20 11:27:16 -07001713 Args: args,
Alex Light7f004a72019-02-21 13:27:37 -08001714 })
1715 jars = append(jars, servicesJar)
1716 }
1717
Colin Cross0a6e0072017-08-30 14:24:55 -07001718 // Combine the classes built from sources, any manifests, and any static libraries into
Nan Zhanged19fc32017-10-19 13:06:22 -07001719 // classes.jar. If there is only one input jar this step will be skipped.
Paul Duffin612e6102021-02-02 13:38:13 +00001720 var outputFile android.OutputPath
Colin Crosse9a275b2017-10-16 17:09:48 -07001721
1722 if len(jars) == 1 && !manifest.Valid() {
Paul Duffin612e6102021-02-02 13:38:13 +00001723 // Optimization: skip the combine step as there is nothing to do
1724 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1725 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1726 // any if len(jars) == 1.
1727
1728 // Transform the single path to the jar into an OutputPath as that is required by the following
1729 // code.
Colin Cross3063b782018-08-15 11:19:12 -07001730 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok {
Paul Duffin612e6102021-02-02 13:38:13 +00001731 // The path contains an embedded OutputPath so reuse that.
1732 outputFile = moduleOutPath.OutputPath
1733 } else if outputPath, ok := jars[0].(android.OutputPath); ok {
1734 // The path is an OutputPath so reuse it directly.
1735 outputFile = outputPath
Colin Cross3063b782018-08-15 11:19:12 -07001736 } else {
Paul Duffin612e6102021-02-02 13:38:13 +00001737 // The file is not in the out directory so create an OutputPath into which it can be copied
1738 // and which the following code can use to refer to it.
Colin Cross3063b782018-08-15 11:19:12 -07001739 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1740 ctx.Build(pctx, android.BuildParams{
1741 Rule: android.Cp,
1742 Input: jars[0],
1743 Output: combinedJar,
1744 })
Paul Duffin612e6102021-02-02 13:38:13 +00001745 outputFile = combinedJar.OutputPath
Colin Cross3063b782018-08-15 11:19:12 -07001746 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001747 } else {
Colin Cross1ee23172017-10-18 14:44:18 -07001748 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001749 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
Colin Cross9b38aef2018-08-27 15:42:25 -07001750 false, nil, nil)
Paul Duffin612e6102021-02-02 13:38:13 +00001751 outputFile = combinedJar.OutputPath
Colin Crosse9a275b2017-10-16 17:09:48 -07001752 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001753
Colin Cross331a1212018-08-15 20:40:52 -07001754 // jarjar implementation jar if necessary
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001755 if j.expandJarjarRules != nil {
Colin Cross8649b262017-09-27 18:03:17 -07001756 // Transform classes.jar into classes-jarjar.jar
Paul Duffin612e6102021-02-02 13:38:13 +00001757 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName).OutputPath
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001758 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
Colin Crosse9a275b2017-10-16 17:09:48 -07001759 outputFile = jarjarFile
Colin Cross331a1212018-08-15 20:40:52 -07001760
1761 // jarjar resource jar if necessary
1762 if j.resourceJar != nil {
1763 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001764 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
Colin Cross331a1212018-08-15 20:40:52 -07001765 j.resourceJar = resourceJarJarFile
1766 }
1767
Colin Cross0a6e0072017-08-30 14:24:55 -07001768 if ctx.Failed() {
1769 return
1770 }
1771 }
Vladimir Marko0975ee02019-04-02 10:29:55 +01001772
1773 // Check package restrictions if necessary.
1774 if len(j.properties.Permitted_packages) > 0 {
1775 // Check packages and copy to package-checked file.
1776 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
1777 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
1778 j.additionalCheckedModules = append(j.additionalCheckedModules, pkgckFile)
1779
1780 if ctx.Failed() {
1781 return
1782 }
1783 }
1784
Nan Zhanged19fc32017-10-19 13:06:22 -07001785 j.implementationJarFile = outputFile
1786 if j.headerJarFile == nil {
1787 j.headerJarFile = j.implementationJarFile
1788 }
Colin Cross2fe66872015-03-30 17:20:39 -07001789
Chris Gross190fdc02020-05-29 16:01:19 +00001790 if j.shouldInstrumentInApex(ctx) {
Jiyong Park00cae1c2020-02-18 12:50:44 +00001791 j.properties.Instrument = true
1792 }
1793
Colin Cross3144dfc2018-01-03 15:06:47 -08001794 if j.shouldInstrument(ctx) {
Colin Crosscb933592017-11-22 13:49:43 -08001795 outputFile = j.instrument(ctx, flags, outputFile, jarName)
1796 }
1797
Colin Cross331a1212018-08-15 20:40:52 -07001798 // merge implementation jar with resources if necessary
1799 implementationAndResourcesJar := outputFile
1800 if j.resourceJar != nil {
Colin Cross08a409d2019-04-29 10:22:44 -07001801 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Paul Duffin612e6102021-02-02 13:38:13 +00001802 combinedJar := android.PathForModuleOut(ctx, "withres", jarName).OutputPath
Colin Cross08a409d2019-04-29 10:22:44 -07001803 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
Colin Cross331a1212018-08-15 20:40:52 -07001804 false, nil, nil)
1805 implementationAndResourcesJar = combinedJar
1806 }
1807
1808 j.implementationAndResourcesJar = implementationAndResourcesJar
1809
Jiyong Park6b21c7d2020-02-11 09:16:01 +09001810 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Colin Cross56a83212020-09-15 18:30:11 -07001811 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1812 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Liz Kammera7a64f32020-07-09 15:16:41 -07001813 if j.dexProperties.Compile_dex == nil {
1814 j.dexProperties.Compile_dex = proptools.BoolPtr(true)
Jiyong Park6b21c7d2020-02-11 09:16:01 +09001815 }
1816 if j.deviceProperties.Hostdex == nil {
1817 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1818 }
1819 }
1820
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001821 if ctx.Device() && j.hasCode(ctx) &&
Liz Kammera7a64f32020-07-09 15:16:41 -07001822 (Bool(j.properties.Installable) || Bool(j.dexProperties.Compile_dex)) {
1823 if j.shouldInstrumentStatic(ctx) {
1824 j.dexer.extraProguardFlagFiles = append(j.dexer.extraProguardFlagFiles,
1825 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1826 }
Colin Cross8faf8fc2019-01-16 15:15:52 -08001827 // Dex compilation
Paul Duffin612e6102021-02-02 13:38:13 +00001828 var dexOutputFile android.OutputPath
Liz Kammera7a64f32020-07-09 15:16:41 -07001829 dexOutputFile = j.dexer.compileDex(ctx, flags, j.minSdkVersion(), outputFile, jarName)
Colin Cross2fe66872015-03-30 17:20:39 -07001830 if ctx.Failed() {
1831 return
1832 }
Colin Cross331a1212018-08-15 20:40:52 -07001833
Jiyong Park09cb6292019-07-15 15:29:23 +09001834 // Hidden API CSV generation and dex encoding
Paul Duffinf75e5272021-02-09 14:34:25 +00001835 dexOutputFile = j.hiddenAPIExtractAndEncode(ctx, dexOutputFile, j.implementationJarFile,
Liz Kammera7a64f32020-07-09 15:16:41 -07001836 proptools.Bool(j.dexProperties.Uncompress_dex))
Colin Cross8faf8fc2019-01-16 15:15:52 -08001837
Colin Cross331a1212018-08-15 20:40:52 -07001838 // merge dex jar with resources if necessary
1839 if j.resourceJar != nil {
1840 jars := android.Paths{dexOutputFile, j.resourceJar}
Paul Duffin612e6102021-02-02 13:38:13 +00001841 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName).OutputPath
Colin Cross331a1212018-08-15 20:40:52 -07001842 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1843 false, nil, nil)
Liz Kammera7a64f32020-07-09 15:16:41 -07001844 if *j.dexProperties.Uncompress_dex {
Paul Duffin612e6102021-02-02 13:38:13 +00001845 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName).OutputPath
Nicolas Geoffrayf3438722019-01-23 15:57:21 +00001846 TransformZipAlign(ctx, combinedAlignedJar, combinedJar)
1847 dexOutputFile = combinedAlignedJar
1848 } else {
1849 dexOutputFile = combinedJar
1850 }
Colin Cross331a1212018-08-15 20:40:52 -07001851 }
1852
1853 j.dexJarFile = dexOutputFile
1854
Colin Cross8faf8fc2019-01-16 15:15:52 -08001855 // Dexpreopting
Jaewoong Jung4b97a562020-12-17 09:43:28 -08001856 j.dexpreopt(ctx, dexOutputFile)
Colin Cross43f08db2018-11-12 10:13:39 -08001857
1858 j.maybeStrippedDexJarFile = dexOutputFile
1859
Colin Cross3063b782018-08-15 11:19:12 -07001860 outputFile = dexOutputFile
Colin Cross43f08db2018-11-12 10:13:39 -08001861
1862 if ctx.Failed() {
1863 return
1864 }
Colin Cross331a1212018-08-15 20:40:52 -07001865 } else {
1866 outputFile = implementationAndResourcesJar
Colin Cross2fe66872015-03-30 17:20:39 -07001867 }
Colin Cross331a1212018-08-15 20:40:52 -07001868
Colin Cross014489c2020-06-02 20:09:13 -07001869 if ctx.Device() {
1870 lintSDKVersionString := func(sdkSpec sdkSpec) string {
1871 if v := sdkSpec.version; v.isNumbered() {
1872 return v.String()
1873 } else {
Dan Albert4f378d72020-07-23 17:32:15 -07001874 return ctx.Config().DefaultAppTargetSdk(ctx).String()
Colin Cross014489c2020-06-02 20:09:13 -07001875 }
1876 }
1877
1878 j.linter.name = ctx.ModuleName()
1879 j.linter.srcs = srcFiles
1880 j.linter.srcJars = srcJars
1881 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1882 j.linter.classes = j.implementationJarFile
1883 j.linter.minSdkVersion = lintSDKVersionString(j.minSdkVersion())
1884 j.linter.targetSdkVersion = lintSDKVersionString(j.targetSdkVersion())
1885 j.linter.compileSdkVersion = lintSDKVersionString(j.sdkVersion())
1886 j.linter.javaLanguageLevel = flags.javaVersion.String()
1887 j.linter.kotlinLanguageLevel = "1.3"
Colin Cross56a83212020-09-15 18:30:11 -07001888 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
Colin Cross08dca382020-07-21 20:31:17 -07001889 j.linter.buildModuleReportZip = true
1890 }
Colin Cross014489c2020-06-02 20:09:13 -07001891 j.linter.lint(ctx)
1892 }
1893
Colin Crossb7a63242015-04-16 14:09:14 -07001894 ctx.CheckbuildFile(outputFile)
Colin Cross3063b782018-08-15 11:19:12 -07001895
Colin Crossdcf71b22021-02-01 13:59:03 -08001896 ctx.SetProvider(JavaInfoProvider, JavaInfo{
1897 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1898 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1899 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
1900 ResourceJars: android.PathsIfNonNil(j.resourceJar),
1901 AidlIncludeDirs: j.exportAidlIncludeDirs,
1902 SrcJarArgs: j.srcJarArgs,
1903 SrcJarDeps: j.srcJarDeps,
1904 ExportedPlugins: j.exportedPluginJars,
1905 ExportedPluginClasses: j.exportedPluginClasses,
1906 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1907 JacocoReportClassesFile: j.jacocoReportClassesFile,
1908 })
1909
Colin Cross3063b782018-08-15 11:19:12 -07001910 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1911 j.outputFile = outputFile.WithoutRel()
Colin Cross2fe66872015-03-30 17:20:39 -07001912}
1913
Colin Cross3b706fd2019-09-05 16:44:18 -07001914func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
1915 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.WritablePath {
1916
1917 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
1918 if idx >= 0 {
1919 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
1920 jarName += strconv.Itoa(idx)
1921 }
1922
Paul Duffin612e6102021-02-02 13:38:13 +00001923 classes := android.PathForModuleOut(ctx, "javac", jarName).OutputPath
Colin Cross3b706fd2019-09-05 16:44:18 -07001924 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, flags, extraJarDeps)
1925
1926 if ctx.Config().EmitXrefRules() {
1927 extractionFile := android.PathForModuleOut(ctx, kzipName)
1928 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1929 j.kytheFiles = append(j.kytheFiles, extractionFile)
1930 }
1931
1932 return classes
1933}
1934
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001935// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1936// since some of these flags may be used internally.
1937func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1938 for _, flag := range flags {
1939 flag = strings.TrimSpace(flag)
1940
1941 if !strings.HasPrefix(flag, "-") {
1942 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1943 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1944 ctx.PropertyErrorf("kotlincflags",
1945 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1946 } else if inList(flag, config.KotlincIllegalFlags) {
1947 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1948 } else if flag == "-include-runtime" {
1949 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1950 } else {
1951 args := strings.Split(flag, " ")
1952 if args[0] == "-kotlin-home" {
1953 ctx.PropertyErrorf("kotlincflags",
1954 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1955 }
1956 }
1957 }
1958}
1959
Colin Cross8eadbf02017-10-24 17:46:00 -07001960func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
Colin Crossf7d84012020-02-21 08:16:41 -08001961 deps deps, flags javaBuilderFlags, jarName string,
1962 extraJars android.Paths) (headerJar, jarjarHeaderJar android.Path) {
Nan Zhanged19fc32017-10-19 13:06:22 -07001963
1964 var jars android.Paths
Colin Cross8eadbf02017-10-24 17:46:00 -07001965 if len(srcFiles) > 0 || len(srcJars) > 0 {
Nan Zhanged19fc32017-10-19 13:06:22 -07001966 // Compile java sources into turbine.jar.
1967 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1968 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1969 if ctx.Failed() {
Colin Crossf7d84012020-02-21 08:16:41 -08001970 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001971 }
1972 jars = append(jars, turbineJar)
1973 }
1974
Colin Cross55f63ea2018-08-27 12:37:09 -07001975 jars = append(jars, extraJars...)
1976
Nan Zhanged19fc32017-10-19 13:06:22 -07001977 // Combine any static header libraries into classes-header.jar. If there is only
1978 // one input jar this step will be skipped.
Nan Zhanged19fc32017-10-19 13:06:22 -07001979 jars = append(jars, deps.staticHeaderJars...)
1980
Colin Cross5c6ecc12017-10-23 18:12:27 -07001981 // we cannot skip the combine step for now if there is only one jar
1982 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1983 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001984 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
Colin Cross6c6e6cd2019-05-08 14:30:12 -07001985 false, nil, []string{"META-INF/TRANSITIVE"})
Colin Cross5c6ecc12017-10-23 18:12:27 -07001986 headerJar = combinedJar
Colin Crossf7d84012020-02-21 08:16:41 -08001987 jarjarHeaderJar = combinedJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001988
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001989 if j.expandJarjarRules != nil {
Nan Zhanged19fc32017-10-19 13:06:22 -07001990 // Transform classes.jar into classes-jarjar.jar
1991 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001992 TransformJarJar(ctx, jarjarFile, headerJar, j.expandJarjarRules)
Colin Crossf7d84012020-02-21 08:16:41 -08001993 jarjarHeaderJar = jarjarFile
Nan Zhanged19fc32017-10-19 13:06:22 -07001994 if ctx.Failed() {
Colin Crossf7d84012020-02-21 08:16:41 -08001995 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001996 }
1997 }
1998
Colin Crossf7d84012020-02-21 08:16:41 -08001999 return headerJar, jarjarHeaderJar
Nan Zhanged19fc32017-10-19 13:06:22 -07002000}
2001
Colin Crosscb933592017-11-22 13:49:43 -08002002func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Paul Duffin612e6102021-02-02 13:38:13 +00002003 classesJar android.Path, jarName string) android.OutputPath {
Colin Crosscb933592017-11-22 13:49:43 -08002004
Colin Cross7a3139e2017-12-19 13:57:50 -08002005 specs := j.jacocoModuleToZipCommand(ctx)
Colin Crosscb933592017-11-22 13:49:43 -08002006
Colin Cross84c38822018-01-03 15:59:46 -08002007 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Paul Duffin612e6102021-02-02 13:38:13 +00002008 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName).OutputPath
Colin Crosscb933592017-11-22 13:49:43 -08002009
2010 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
2011
2012 j.jacocoReportClassesFile = jacocoReportClassesFile
2013
2014 return instrumentedJar
2015}
2016
Nan Zhanged19fc32017-10-19 13:06:22 -07002017func (j *Module) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002018 if j.headerJarFile == nil {
2019 return nil
2020 }
Nan Zhanged19fc32017-10-19 13:06:22 -07002021 return android.Paths{j.headerJarFile}
2022}
2023
2024func (j *Module) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08002025 if j.implementationJarFile == nil {
2026 return nil
2027 }
Nan Zhanged19fc32017-10-19 13:06:22 -07002028 return android.Paths{j.implementationJarFile}
Colin Cross2fe66872015-03-30 17:20:39 -07002029}
2030
Ulyana Trafimovich5539e7b2020-06-04 14:08:17 +00002031func (j *Module) DexJarBuildPath() android.Path {
Colin Crossf24a22a2019-01-31 14:12:44 -08002032 return j.dexJarFile
2033}
2034
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01002035func (j *Module) DexJarInstallPath() android.Path {
2036 return j.installFile
2037}
2038
Colin Cross331a1212018-08-15 20:40:52 -07002039func (j *Module) ResourceJars() android.Paths {
2040 if j.resourceJar == nil {
2041 return nil
2042 }
2043 return android.Paths{j.resourceJar}
2044}
2045
2046func (j *Module) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002047 if j.implementationAndResourcesJar == nil {
2048 return nil
2049 }
Colin Cross331a1212018-08-15 20:40:52 -07002050 return android.Paths{j.implementationAndResourcesJar}
2051}
2052
Colin Cross46c9b8b2017-06-22 16:51:17 -07002053func (j *Module) AidlIncludeDirs() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002054 // exportAidlIncludeDirs is type android.Paths already
Colin Crossc0b06f12015-04-08 13:03:43 -07002055 return j.exportAidlIncludeDirs
2056}
2057
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01002058func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2059 return j.classLoaderContexts
Jiyong Park1be96912018-05-28 18:02:19 +09002060}
2061
Colin Crossc9fe10f2020-11-19 18:06:03 -08002062// ExportedPlugins returns the list of jars needed to run the exported plugins, the list of
2063// classes for the plugins, and a boolean for whether turbine needs to be disabled due to plugins
2064// that generate APIs.
2065func (j *Module) ExportedPlugins() (android.Paths, []string, bool) {
2066 return j.exportedPluginJars, j.exportedPluginClasses, j.exportedDisableTurbine
Artur Satayev9cf46692019-11-26 18:08:34 +00002067}
2068
Colin Cross0c4ce212019-05-03 15:28:19 -07002069func (j *Module) SrcJarArgs() ([]string, android.Paths) {
2070 return j.srcJarArgs, j.srcJarDeps
2071}
2072
Colin Cross46c9b8b2017-06-22 16:51:17 -07002073var _ logtagsProducer = (*Module)(nil)
Colin Crossf05fe972015-04-10 17:45:20 -07002074
Colin Cross46c9b8b2017-06-22 16:51:17 -07002075func (j *Module) logtags() android.Paths {
Colin Crossf05fe972015-04-10 17:45:20 -07002076 return j.logtagsSrcs
2077}
2078
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002079// Collect information for opening IDE project files in java/jdeps.go.
2080func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
2081 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2082 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
patricktu18c82ff2019-05-10 15:48:50 +08002083 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002084 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08002085 if j.expandJarjarRules != nil {
2086 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002087 }
bralee1fbf4402020-05-21 10:11:59 +08002088 dpInfo.Paths = append(dpInfo.Paths, j.modulePaths...)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002089}
2090
2091func (j *Module) CompilerDeps() []string {
2092 jdeps := []string{}
2093 jdeps = append(jdeps, j.properties.Libs...)
2094 jdeps = append(jdeps, j.properties.Static_libs...)
2095 return jdeps
2096}
2097
Jaewoong Jungc27ab662019-05-30 15:51:14 -07002098func (j *Module) hasCode(ctx android.ModuleContext) bool {
2099 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2100 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2101}
2102
Jiyong Park45bf82e2020-12-15 22:29:02 +09002103// Implements android.ApexModule
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09002104func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffin0d3c2e12020-05-17 08:34:50 +01002105 return j.depIsInSameApex(ctx, dep)
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09002106}
2107
Jiyong Park45bf82e2020-12-15 22:29:02 +09002108// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07002109func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
2110 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09002111 sdkSpec := j.minSdkVersion()
2112 if !sdkSpec.specified() {
2113 return fmt.Errorf("min_sdk_version is not specified")
2114 }
2115 if sdkSpec.kind == sdkCore {
2116 return nil
2117 }
2118 ver, err := sdkSpec.effectiveVersion(ctx)
2119 if err != nil {
2120 return err
2121 }
Dan Albertc8060532020-07-22 22:32:17 -07002122 if ver.ApiLevel(ctx).GreaterThan(sdkVersion) {
Jooyung Han749dc692020-04-15 11:03:39 +09002123 return fmt.Errorf("newer SDK(%v)", ver)
2124 }
2125 return nil
2126}
2127
Jiyong Park0b238752019-10-29 11:23:10 +09002128func (j *Module) Stem() string {
2129 return proptools.StringDefault(j.deviceProperties.Stem, j.Name())
2130}
2131
Paul Duffin4103e922021-02-01 19:01:34 +00002132// ConfigurationName returns the name of the module as used in build configuration.
2133//
2134// This is usually the same as BaseModuleName() except for the <x>.impl libraries created by
2135// java_sdk_library in which case this is the BaseModuleName() without the ".impl" suffix,
2136// i.e. just <x>.
Paul Duffina2058f82020-06-24 16:22:38 +01002137func (j *Module) ConfigurationName() string {
2138 return proptools.StringDefault(j.deviceProperties.ConfigurationName, j.BaseModuleName())
2139}
2140
Jiyong Park618922e2020-01-08 13:35:43 +09002141func (j *Module) JacocoReportClassesFile() android.Path {
2142 return j.jacocoReportClassesFile
2143}
2144
Martin Stjernholm6d415272020-01-31 17:10:36 +00002145func (j *Module) IsInstallable() bool {
2146 return Bool(j.properties.Installable)
2147}
2148
Colin Cross2fe66872015-03-30 17:20:39 -07002149//
2150// Java libraries (.jar file)
2151//
2152
Colin Crossf506d872017-07-19 15:53:04 -07002153type Library struct {
Colin Cross46c9b8b2017-06-22 16:51:17 -07002154 Module
Colin Crossf0f2e2c2019-10-15 16:36:40 -07002155
2156 InstallMixin func(ctx android.ModuleContext, installPath android.Path) (extraInstallDeps android.Paths)
Colin Cross2fe66872015-03-30 17:20:39 -07002157}
2158
Jiyong Park45bf82e2020-12-15 22:29:02 +09002159var _ android.ApexModule = (*Library)(nil)
2160
Paul Duffine739f1e2020-05-29 11:24:51 +01002161// Provides access to the list of permitted packages from updatable boot jars.
2162type PermittedPackagesForUpdatableBootJars interface {
2163 PermittedPackagesForUpdatableBootJars() []string
2164}
2165
2166var _ PermittedPackagesForUpdatableBootJars = (*Library)(nil)
2167
2168func (j *Library) PermittedPackagesForUpdatableBootJars() []string {
2169 return j.properties.Permitted_packages
2170}
2171
Colin Cross42be7612019-02-21 18:12:14 -08002172func shouldUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter) bool {
Ulya Trafimovichf491dde2020-01-24 12:19:45 +00002173 // Store uncompressed (and aligned) any dex files from jars in APEXes.
Colin Cross56a83212020-09-15 18:30:11 -07002174 if apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo); !apexInfo.IsForPlatform() {
Ulya Trafimovichf491dde2020-01-24 12:19:45 +00002175 return true
2176 }
2177
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00002178 // Store uncompressed (and do not strip) dex files from boot class path jars.
2179 if inList(ctx.ModuleName(), ctx.Config().BootJars()) {
2180 return true
2181 }
2182
2183 // Store uncompressed dex files that are preopted on /system.
Colin Cross42be7612019-02-21 18:12:14 -08002184 if !dexpreopter.dexpreoptDisabled(ctx) && (ctx.Host() || !odexOnSystemOther(ctx, dexpreopter.installPath)) {
Vladimir Markoe8b00d62018-12-21 15:54:16 +00002185 return true
2186 }
Colin Cross083a2aa2019-02-06 16:37:12 -08002187 if ctx.Config().UncompressPrivAppDex() &&
2188 inList(ctx.ModuleName(), ctx.Config().ModulesLoadedByPrivilegedModules()) {
2189 return true
2190 }
2191
Colin Cross2fc72f62018-12-21 12:59:54 -08002192 return false
2193}
2194
Colin Crossf506d872017-07-19 15:53:04 -07002195func (j *Library) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Paul Duffin4103e922021-02-01 19:01:34 +00002196 // Initialize the hiddenapi structure. Pass in the configuration name rather than the module name
2197 // so the hidden api will encode the <x>.impl java_ library created by java_sdk_library just as it
2198 // would the <x> library if <x> was configured as a boot jar.
2199 j.initHiddenAPI(ctx, j.ConfigurationName())
2200
Colin Cross56a83212020-09-15 18:30:11 -07002201 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2202 if !apexInfo.IsForPlatform() {
2203 j.hideApexVariantFromMake = true
2204 }
2205
Artur Satayev2db1c3f2020-04-08 19:09:30 +01002206 j.checkSdkVersions(ctx)
Jiyong Park0b238752019-10-29 11:23:10 +09002207 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross43f08db2018-11-12 10:13:39 -08002208 j.dexpreopter.isSDKLibrary = j.deviceProperties.IsSDKLibrary
Liz Kammera7a64f32020-07-09 15:16:41 -07002209 if j.dexProperties.Uncompress_dex == nil {
David Srbeckye033cba2020-05-20 22:20:28 +01002210 // If the value was not force-set by the user, use reasonable default based on the module.
Liz Kammera7a64f32020-07-09 15:16:41 -07002211 j.dexProperties.Uncompress_dex = proptools.BoolPtr(shouldUncompressDex(ctx, &j.dexpreopter))
David Srbeckye033cba2020-05-20 22:20:28 +01002212 }
Liz Kammera7a64f32020-07-09 15:16:41 -07002213 j.dexpreopter.uncompressedDex = *j.dexProperties.Uncompress_dex
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01002214 j.classLoaderContexts = make(dexpreopt.ClassLoaderContextMap)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07002215 j.compile(ctx, nil)
Colin Crossb7a63242015-04-16 14:09:14 -07002216
bralee1fbf4402020-05-21 10:11:59 +08002217 // Collect the module directory for IDE info in java/jdeps.go.
2218 j.modulePaths = append(j.modulePaths, ctx.ModuleDir())
2219
Colin Cross56a83212020-09-15 18:30:11 -07002220 exclusivelyForApex := !apexInfo.IsForPlatform()
Jiyong Park7f7766d2019-07-25 22:02:35 +09002221 if (Bool(j.properties.Installable) || ctx.Host()) && !exclusivelyForApex {
Colin Crossf0f2e2c2019-10-15 16:36:40 -07002222 var extraInstallDeps android.Paths
2223 if j.InstallMixin != nil {
2224 extraInstallDeps = j.InstallMixin(ctx, j.outputFile)
2225 }
Colin Cross2c429dc2017-08-31 16:45:16 -07002226 j.installFile = ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Parka62aa232020-05-28 23:46:55 +09002227 j.Stem()+".jar", j.outputFile, extraInstallDeps...)
Colin Cross2c429dc2017-08-31 16:45:16 -07002228 }
Colin Crossb7a63242015-04-16 14:09:14 -07002229}
2230
Colin Crossf506d872017-07-19 15:53:04 -07002231func (j *Library) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross46c9b8b2017-06-22 16:51:17 -07002232 j.deps(ctx)
2233}
2234
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00002235const (
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002236 aidlIncludeDir = "aidl"
2237 javaDir = "java"
2238 jarFileSuffix = ".jar"
2239 testConfigSuffix = "-AndroidTest.xml"
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00002240)
2241
Paul Duffina0dbf432019-12-05 11:25:53 +00002242// path to the jar file of a java library. Relative to <sdk_root>/<api_dir>
Paul Duffina04c1072020-03-02 10:16:35 +00002243func sdkSnapshotFilePathForJar(osPrefix, name string) string {
2244 return sdkSnapshotFilePathForMember(osPrefix, name, jarFileSuffix)
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002245}
2246
Paul Duffina04c1072020-03-02 10:16:35 +00002247func sdkSnapshotFilePathForMember(osPrefix, name string, suffix string) string {
2248 return filepath.Join(javaDir, osPrefix, name+suffix)
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00002249}
2250
Paul Duffin13879572019-11-28 14:31:38 +00002251type librarySdkMemberType struct {
Paul Duffin255f18e2019-12-13 11:22:16 +00002252 android.SdkMemberTypeBase
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00002253
2254 // Function to retrieve the appropriate output jar (implementation or header) from
2255 // the library.
Paul Duffindb170e42020-12-08 17:48:25 +00002256 jarToExportGetter func(ctx android.SdkMemberContext, j *Library) android.Path
2257
2258 // Function to compute the snapshot relative path to which the named library's
2259 // jar should be copied.
2260 snapshotPathGetter func(osPrefix, name string) string
2261
2262 // True if only the jar should be copied to the snapshot, false if the jar plus any additional
2263 // files like aidl files should also be copied.
2264 onlyCopyJarToSnapshot bool
Paul Duffin13879572019-11-28 14:31:38 +00002265}
2266
Paul Duffindb170e42020-12-08 17:48:25 +00002267const (
2268 onlyCopyJarToSnapshot = true
2269 copyEverythingToSnapshot = false
2270)
2271
Paul Duffin13879572019-11-28 14:31:38 +00002272func (mt *librarySdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
2273 mctx.AddVariationDependencies(nil, dependencyTag, names...)
2274}
2275
2276func (mt *librarySdkMemberType) IsInstance(module android.Module) bool {
2277 _, ok := module.(*Library)
2278 return ok
2279}
2280
Paul Duffin3a4eb502020-03-19 16:11:18 +00002281func (mt *librarySdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
2282 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_import")
Paul Duffin14eb4672020-03-02 11:33:02 +00002283}
Paul Duffina0dbf432019-12-05 11:25:53 +00002284
Paul Duffin14eb4672020-03-02 11:33:02 +00002285func (mt *librarySdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
Paul Duffina551a1c2020-03-17 21:04:24 +00002286 return &librarySdkMemberProperties{}
Paul Duffin14eb4672020-03-02 11:33:02 +00002287}
2288
2289type librarySdkMemberProperties struct {
2290 android.SdkMemberPropertiesBase
2291
Paul Duffin864e1b42020-05-06 10:23:19 +01002292 JarToExport android.Path `android:"arch_variant"`
Paul Duffina551a1c2020-03-17 21:04:24 +00002293 AidlIncludeDirs android.Paths
Paul Duffin14eb4672020-03-02 11:33:02 +00002294}
2295
Paul Duffin3a4eb502020-03-19 16:11:18 +00002296func (p *librarySdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin13879572019-11-28 14:31:38 +00002297 j := variant.(*Library)
2298
Paul Duffindb170e42020-12-08 17:48:25 +00002299 p.JarToExport = ctx.MemberType().(*librarySdkMemberType).jarToExportGetter(ctx, j)
2300
Paul Duffina551a1c2020-03-17 21:04:24 +00002301 p.AidlIncludeDirs = j.AidlIncludeDirs()
Paul Duffin14eb4672020-03-02 11:33:02 +00002302}
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00002303
Paul Duffin3a4eb502020-03-19 16:11:18 +00002304func (p *librarySdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffina551a1c2020-03-17 21:04:24 +00002305 builder := ctx.SnapshotBuilder()
Paul Duffin3a4eb502020-03-19 16:11:18 +00002306
Paul Duffindb170e42020-12-08 17:48:25 +00002307 memberType := ctx.MemberType().(*librarySdkMemberType)
2308
Paul Duffina551a1c2020-03-17 21:04:24 +00002309 exportedJar := p.JarToExport
2310 if exportedJar != nil {
Paul Duffindb170e42020-12-08 17:48:25 +00002311 // Delegate the creation of the snapshot relative path to the member type.
2312 snapshotRelativeJavaLibPath := memberType.snapshotPathGetter(p.OsPrefix(), ctx.Name())
2313
2314 // Copy the exported jar to the snapshot.
Paul Duffin14eb4672020-03-02 11:33:02 +00002315 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
2316
Paul Duffina551a1c2020-03-17 21:04:24 +00002317 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
2318 }
2319
Paul Duffindb170e42020-12-08 17:48:25 +00002320 // Do not copy anything else to the snapshot.
2321 if memberType.onlyCopyJarToSnapshot {
2322 return
2323 }
2324
Paul Duffina551a1c2020-03-17 21:04:24 +00002325 aidlIncludeDirs := p.AidlIncludeDirs
2326 if len(aidlIncludeDirs) != 0 {
2327 sdkModuleContext := ctx.SdkModuleContext()
2328 for _, dir := range aidlIncludeDirs {
Paul Duffin14eb4672020-03-02 11:33:02 +00002329 // TODO(jiyong): copy parcelable declarations only
2330 aidlFiles, _ := sdkModuleContext.GlobWithDeps(dir.String()+"/**/*.aidl", nil)
2331 for _, file := range aidlFiles {
2332 builder.CopyToSnapshot(android.PathForSource(sdkModuleContext, file), filepath.Join(aidlIncludeDir, file))
2333 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00002334 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00002335
Paul Duffina551a1c2020-03-17 21:04:24 +00002336 // TODO(b/151933053) - add aidl include dirs property
Paul Duffin14eb4672020-03-02 11:33:02 +00002337 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00002338}
2339
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00002340var javaHeaderLibsSdkMemberType android.SdkMemberType = &librarySdkMemberType{
2341 android.SdkMemberTypeBase{
2342 PropertyName: "java_header_libs",
2343 SupportsSdk: true,
Paul Duffin7b81f5e2020-01-13 21:03:22 +00002344 },
Paul Duffindb170e42020-12-08 17:48:25 +00002345 func(_ android.SdkMemberContext, j *Library) android.Path {
Paul Duffina0dbf432019-12-05 11:25:53 +00002346 headerJars := j.HeaderJars()
2347 if len(headerJars) != 1 {
2348 panic(fmt.Errorf("there must be only one header jar from %q", j.Name()))
2349 }
2350
2351 return headerJars[0]
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00002352 },
Paul Duffindb170e42020-12-08 17:48:25 +00002353 sdkSnapshotFilePathForJar,
2354 copyEverythingToSnapshot,
Paul Duffina0dbf432019-12-05 11:25:53 +00002355}
2356
Colin Cross1b16b0e2019-02-12 14:41:32 -08002357// java_library builds and links sources into a `.jar` file for the device, and possibly for the host as well.
2358//
2359// By default, a java_library has a single variant that produces a `.jar` file containing `.class` files that were
2360// compiled against the device bootclasspath. This jar is not suitable for installing on a device, but can be used
2361// as a `static_libs` dependency of another module.
2362//
2363// Specifying `installable: true` will product a `.jar` file containing `classes.dex` files, suitable for installing on
2364// a device.
2365//
2366// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2367// compiled against the host bootclasspath.
Colin Cross9ae1b922018-06-26 17:59:05 -07002368func LibraryFactory() android.Module {
2369 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07002370
Colin Crossce6734e2020-06-15 16:09:53 -07002371 module.addHostAndDeviceProperties()
Colin Cross2fe66872015-03-30 17:20:39 -07002372
Paul Duffin859fe962020-05-15 10:20:31 +01002373 module.initModuleAndImport(&module.ModuleBase)
2374
Jiyong Park7f7766d2019-07-25 22:02:35 +09002375 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002376 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002377 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross9ae1b922018-06-26 17:59:05 -07002378 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002379}
2380
Colin Cross1b16b0e2019-02-12 14:41:32 -08002381// java_library_static is an obsolete alias for java_library.
2382func LibraryStaticFactory() android.Module {
2383 return LibraryFactory()
2384}
2385
2386// java_library_host builds and links sources into a `.jar` file for the host.
2387//
2388// A java_library_host has a single variant that produces a `.jar` file containing `.class` files that were
2389// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002390func LibraryHostFactory() android.Module {
2391 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07002392
Colin Crossce6734e2020-06-15 16:09:53 -07002393 module.addHostProperties()
Colin Cross36242852017-06-23 15:06:31 -07002394
Colin Cross9ae1b922018-06-26 17:59:05 -07002395 module.Module.properties.Installable = proptools.BoolPtr(true)
2396
Jiyong Park7f7766d2019-07-25 22:02:35 +09002397 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002398 InitJavaModule(module, android.HostSupported)
Colin Cross36242852017-06-23 15:06:31 -07002399 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002400}
2401
2402//
Colin Crossb628ea52018-08-14 16:42:33 -07002403// Java Tests
Colin Cross05638fc2018-04-09 18:40:24 -07002404//
2405
Dan Shi95d19422020-08-15 12:24:26 -07002406// Test option struct.
2407type TestOptions struct {
2408 // a list of extra test configuration files that should be installed with the module.
2409 Extra_test_configs []string `android:"path,arch_variant"`
Dan Shid79572f2020-11-13 14:33:46 -08002410
2411 // If the test is a hostside(no device required) unittest that shall be run during presubmit check.
2412 Unit_test *bool
Dan Shi95d19422020-08-15 12:24:26 -07002413}
2414
Colin Cross05638fc2018-04-09 18:40:24 -07002415type testProperties struct {
Colin Cross05638fc2018-04-09 18:40:24 -07002416 // list of compatibility suites (for example "cts", "vts") that the module should be
2417 // installed into.
2418 Test_suites []string `android:"arch_variant"`
Julien Despreze146e392018-08-02 15:00:46 -07002419
2420 // the name of the test configuration (for example "AndroidTest.xml") that should be
2421 // installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002422 Test_config *string `android:"path,arch_variant"`
Colin Crossd96ca352018-08-10 16:06:24 -07002423
Jack He33338892018-09-19 02:21:28 -07002424 // the name of the test configuration template (for example "AndroidTestTemplate.xml") that
2425 // should be installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002426 Test_config_template *string `android:"path,arch_variant"`
Jack He33338892018-09-19 02:21:28 -07002427
Colin Crossd96ca352018-08-10 16:06:24 -07002428 // list of files or filegroup modules that provide data that should be installed alongside
2429 // the test
Jiyong Park2b0e4902021-02-16 06:52:39 +09002430 Data []string `android:"path"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07002431
2432 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
2433 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
2434 // explicitly.
2435 Auto_gen_config *bool
easoncylee5bcff5d2020-04-30 14:57:06 +08002436
2437 // Add parameterized mainline modules to auto generated test config. The options will be
2438 // handled by TradeFed to do downloading and installing the specified modules on the device.
2439 Test_mainline_modules []string
Dan Shi95d19422020-08-15 12:24:26 -07002440
2441 // Test options.
2442 Test_options TestOptions
Colin Cross05638fc2018-04-09 18:40:24 -07002443}
2444
Liz Kammerdd849a82020-06-12 16:38:45 -07002445type hostTestProperties struct {
2446 // list of native binary modules that should be installed alongside the test
2447 Data_native_bins []string `android:"arch_variant"`
2448}
2449
Paul Duffin42df1442019-03-20 12:45:53 +00002450type testHelperLibraryProperties struct {
2451 // list of compatibility suites (for example "cts", "vts") that the module should be
2452 // installed into.
2453 Test_suites []string `android:"arch_variant"`
2454}
2455
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002456type prebuiltTestProperties struct {
2457 // list of compatibility suites (for example "cts", "vts") that the module should be
2458 // installed into.
2459 Test_suites []string `android:"arch_variant"`
2460
2461 // the name of the test configuration (for example "AndroidTest.xml") that should be
2462 // installed with the module.
2463 Test_config *string `android:"path,arch_variant"`
2464}
2465
Colin Cross05638fc2018-04-09 18:40:24 -07002466type Test struct {
2467 Library
2468
2469 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07002470
Dan Shi95d19422020-08-15 12:24:26 -07002471 testConfig android.Path
2472 extraTestConfigs android.Paths
2473 data android.Paths
Colin Cross303e21f2018-08-07 16:49:25 -07002474}
2475
Liz Kammerdd849a82020-06-12 16:38:45 -07002476type TestHost struct {
2477 Test
2478
2479 testHostProperties hostTestProperties
2480}
2481
Paul Duffin42df1442019-03-20 12:45:53 +00002482type TestHelperLibrary struct {
2483 Library
2484
2485 testHelperLibraryProperties testHelperLibraryProperties
2486}
2487
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002488type JavaTestImport struct {
2489 Import
2490
2491 prebuiltTestProperties prebuiltTestProperties
2492
2493 testConfig android.Path
Liz Kammerd6c31d22020-08-05 15:40:41 -07002494 dexJarFile android.Path
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002495}
2496
Liz Kammerdd849a82020-06-12 16:38:45 -07002497func (j *TestHost) DepsMutator(ctx android.BottomUpMutatorContext) {
2498 if len(j.testHostProperties.Data_native_bins) > 0 {
2499 for _, target := range ctx.MultiTargets() {
2500 ctx.AddVariationDependencies(target.Variations(), dataNativeBinsTag, j.testHostProperties.Data_native_bins...)
2501 }
2502 }
2503
2504 j.deps(ctx)
2505}
2506
Colin Cross303e21f2018-08-07 16:49:25 -07002507func (j *Test) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Dan Shi6ffaaa82019-09-26 11:41:36 -07002508 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.testProperties.Test_config, j.testProperties.Test_config_template,
Julien Desprez70898c42020-11-19 09:43:45 -08002509 j.testProperties.Test_suites, j.testProperties.Auto_gen_config, j.testProperties.Test_options.Unit_test)
Liz Kammerdd849a82020-06-12 16:38:45 -07002510
Colin Cross8a497952019-03-05 22:25:09 -08002511 j.data = android.PathsForModuleSrc(ctx, j.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07002512
Dan Shi95d19422020-08-15 12:24:26 -07002513 j.extraTestConfigs = android.PathsForModuleSrc(ctx, j.testProperties.Test_options.Extra_test_configs)
2514
Liz Kammerdd849a82020-06-12 16:38:45 -07002515 ctx.VisitDirectDepsWithTag(dataNativeBinsTag, func(dep android.Module) {
2516 j.data = append(j.data, android.OutputFileForModule(ctx, dep, ""))
2517 })
2518
Colin Cross303e21f2018-08-07 16:49:25 -07002519 j.Library.GenerateAndroidBuildActions(ctx)
Colin Cross05638fc2018-04-09 18:40:24 -07002520}
2521
Paul Duffin42df1442019-03-20 12:45:53 +00002522func (j *TestHelperLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2523 j.Library.GenerateAndroidBuildActions(ctx)
2524}
2525
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002526func (j *JavaTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2527 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.prebuiltTestProperties.Test_config, nil,
Julien Desprez70898c42020-11-19 09:43:45 -08002528 j.prebuiltTestProperties.Test_suites, nil, nil)
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002529
2530 j.Import.GenerateAndroidBuildActions(ctx)
2531}
2532
2533type testSdkMemberType struct {
2534 android.SdkMemberTypeBase
2535}
2536
2537func (mt *testSdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
2538 mctx.AddVariationDependencies(nil, dependencyTag, names...)
2539}
2540
2541func (mt *testSdkMemberType) IsInstance(module android.Module) bool {
2542 _, ok := module.(*Test)
2543 return ok
2544}
2545
Paul Duffin3a4eb502020-03-19 16:11:18 +00002546func (mt *testSdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
2547 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_test_import")
Paul Duffin14eb4672020-03-02 11:33:02 +00002548}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002549
Paul Duffin14eb4672020-03-02 11:33:02 +00002550func (mt *testSdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
2551 return &testSdkMemberProperties{}
2552}
2553
2554type testSdkMemberProperties struct {
2555 android.SdkMemberPropertiesBase
2556
Paul Duffina551a1c2020-03-17 21:04:24 +00002557 JarToExport android.Path
2558 TestConfig android.Path
Paul Duffin14eb4672020-03-02 11:33:02 +00002559}
2560
Paul Duffin3a4eb502020-03-19 16:11:18 +00002561func (p *testSdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin14eb4672020-03-02 11:33:02 +00002562 test := variant.(*Test)
2563
2564 implementationJars := test.ImplementationJars()
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002565 if len(implementationJars) != 1 {
Paul Duffin14eb4672020-03-02 11:33:02 +00002566 panic(fmt.Errorf("there must be only one implementation jar from %q", test.Name()))
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002567 }
2568
Paul Duffina551a1c2020-03-17 21:04:24 +00002569 p.JarToExport = implementationJars[0]
2570 p.TestConfig = test.testConfig
Paul Duffin14eb4672020-03-02 11:33:02 +00002571}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002572
Paul Duffin3a4eb502020-03-19 16:11:18 +00002573func (p *testSdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffina551a1c2020-03-17 21:04:24 +00002574 builder := ctx.SnapshotBuilder()
Paul Duffin3a4eb502020-03-19 16:11:18 +00002575
Paul Duffina551a1c2020-03-17 21:04:24 +00002576 exportedJar := p.JarToExport
2577 if exportedJar != nil {
2578 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
2579 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
Paul Duffin14eb4672020-03-02 11:33:02 +00002580
2581 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
Paul Duffina551a1c2020-03-17 21:04:24 +00002582 }
2583
2584 testConfig := p.TestConfig
2585 if testConfig != nil {
2586 snapshotRelativeTestConfigPath := sdkSnapshotFilePathForMember(p.OsPrefix(), ctx.Name(), testConfigSuffix)
2587 builder.CopyToSnapshot(testConfig, snapshotRelativeTestConfigPath)
Paul Duffin14eb4672020-03-02 11:33:02 +00002588 propertySet.AddProperty("test_config", snapshotRelativeTestConfigPath)
2589 }
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002590}
2591
Colin Cross1b16b0e2019-02-12 14:41:32 -08002592// java_test builds a and links sources into a `.jar` file for the device, and possibly for the host as well, and
2593// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
2594//
2595// By default, a java_test has a single variant that produces a `.jar` file containing `classes.dex` files that were
2596// compiled against the device bootclasspath.
2597//
2598// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2599// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002600func TestFactory() android.Module {
2601 module := &Test{}
2602
Colin Crossce6734e2020-06-15 16:09:53 -07002603 module.addHostAndDeviceProperties()
2604 module.AddProperties(&module.testProperties)
Colin Cross05638fc2018-04-09 18:40:24 -07002605
Colin Cross9ae1b922018-06-26 17:59:05 -07002606 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse3026872019-01-05 22:30:13 -08002607 module.Module.dexpreopter.isTest = true
Colin Cross014489c2020-06-02 20:09:13 -07002608 module.Module.linter.test = true
Colin Cross9ae1b922018-06-26 17:59:05 -07002609
Colin Cross05638fc2018-04-09 18:40:24 -07002610 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002611 return module
2612}
2613
Paul Duffin42df1442019-03-20 12:45:53 +00002614// java_test_helper_library creates a java library and makes sure that it is added to the appropriate test suite.
2615func TestHelperLibraryFactory() android.Module {
2616 module := &TestHelperLibrary{}
2617
Colin Crossce6734e2020-06-15 16:09:53 -07002618 module.addHostAndDeviceProperties()
2619 module.AddProperties(&module.testHelperLibraryProperties)
Paul Duffin42df1442019-03-20 12:45:53 +00002620
Colin Cross9a4abed2019-04-24 13:19:28 -07002621 module.Module.properties.Installable = proptools.BoolPtr(true)
2622 module.Module.dexpreopter.isTest = true
Colin Cross014489c2020-06-02 20:09:13 -07002623 module.Module.linter.test = true
Colin Cross9a4abed2019-04-24 13:19:28 -07002624
Paul Duffin42df1442019-03-20 12:45:53 +00002625 InitJavaModule(module, android.HostAndDeviceSupported)
2626 return module
2627}
2628
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002629// java_test_import imports one or more `.jar` files into the build graph as if they were built by a java_test module
2630// and makes sure that it is added to the appropriate test suite.
2631//
2632// By default, a java_test_import has a single variant that expects a `.jar` file containing `.class` files that were
2633// compiled against an Android classpath.
2634//
2635// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2636// for host modules.
2637func JavaTestImportFactory() android.Module {
2638 module := &JavaTestImport{}
2639
2640 module.AddProperties(
2641 &module.Import.properties,
2642 &module.prebuiltTestProperties)
2643
2644 module.Import.properties.Installable = proptools.BoolPtr(true)
2645
2646 android.InitPrebuiltModule(module, &module.properties.Jars)
2647 android.InitApexModule(module)
2648 android.InitSdkAwareModule(module)
2649 InitJavaModule(module, android.HostAndDeviceSupported)
2650 return module
2651}
2652
Colin Cross1b16b0e2019-02-12 14:41:32 -08002653// java_test_host builds a and links sources into a `.jar` file for the host, and creates an `AndroidTest.xml` file to
2654// allow running the test with `atest` or a `TEST_MAPPING` file.
2655//
2656// A java_test_host has a single variant that produces a `.jar` file containing `.class` files that were
2657// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002658func TestHostFactory() android.Module {
Liz Kammerdd849a82020-06-12 16:38:45 -07002659 module := &TestHost{}
Colin Cross05638fc2018-04-09 18:40:24 -07002660
Colin Crossce6734e2020-06-15 16:09:53 -07002661 module.addHostProperties()
2662 module.AddProperties(&module.testProperties)
Liz Kammerdd849a82020-06-12 16:38:45 -07002663 module.AddProperties(&module.testHostProperties)
Colin Cross05638fc2018-04-09 18:40:24 -07002664
Colin Cross9ae1b922018-06-26 17:59:05 -07002665 module.Module.properties.Installable = proptools.BoolPtr(true)
2666
Liz Kammerdd849a82020-06-12 16:38:45 -07002667 InitJavaModuleMultiTargets(module, android.HostSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002668 return module
2669}
2670
2671//
Colin Cross2fe66872015-03-30 17:20:39 -07002672// Java Binaries (.jar file plus wrapper script)
2673//
2674
Colin Crossf506d872017-07-19 15:53:04 -07002675type binaryProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -07002676 // installable script to execute the resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -08002677 Wrapper *string `android:"path"`
Colin Cross094054a2018-10-17 15:10:48 -07002678
2679 // Name of the class containing main to be inserted into the manifest as Main-Class.
2680 Main_class *string
Colin Cross89226d92020-10-09 19:00:54 -07002681
2682 // Names of modules containing JNI libraries that should be installed alongside the host
2683 // variant of the binary.
2684 Jni_libs []string
Colin Cross7d5136f2015-05-11 13:39:40 -07002685}
2686
Colin Crossf506d872017-07-19 15:53:04 -07002687type Binary struct {
2688 Library
Colin Cross2fe66872015-03-30 17:20:39 -07002689
Colin Crossf506d872017-07-19 15:53:04 -07002690 binaryProperties binaryProperties
Colin Cross10a03492017-08-10 17:09:43 -07002691
Colin Cross6b4a32d2017-12-05 13:42:45 -08002692 isWrapperVariant bool
2693
Colin Crossc3315992017-12-08 19:12:36 -08002694 wrapperFile android.Path
Colin Cross70dda7e2019-10-01 22:05:35 -07002695 binaryFile android.InstallPath
Colin Cross2fe66872015-03-30 17:20:39 -07002696}
2697
Alex Light24237172017-10-26 09:46:21 -07002698func (j *Binary) HostToolPath() android.OptionalPath {
2699 return android.OptionalPathForPath(j.binaryFile)
2700}
2701
Colin Crossf506d872017-07-19 15:53:04 -07002702func (j *Binary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002703 if ctx.Arch().ArchType == android.Common {
2704 // Compile the jar
Colin Cross094054a2018-10-17 15:10:48 -07002705 if j.binaryProperties.Main_class != nil {
2706 if j.properties.Manifest != nil {
2707 ctx.PropertyErrorf("main_class", "main_class cannot be used when manifest is set")
2708 }
2709 manifestFile := android.PathForModuleOut(ctx, "manifest.txt")
2710 GenerateMainClassManifest(ctx, manifestFile, String(j.binaryProperties.Main_class))
2711 j.overrideManifest = android.OptionalPathForPath(manifestFile)
2712 }
2713
Colin Cross6b4a32d2017-12-05 13:42:45 -08002714 j.Library.GenerateAndroidBuildActions(ctx)
Nan Zhang3c807db2017-11-03 14:53:31 -07002715 } else {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002716 // Handle the binary wrapper
2717 j.isWrapperVariant = true
2718
Colin Cross366938f2017-12-11 16:29:02 -08002719 if j.binaryProperties.Wrapper != nil {
Colin Cross8a497952019-03-05 22:25:09 -08002720 j.wrapperFile = android.PathForModuleSrc(ctx, *j.binaryProperties.Wrapper)
Colin Cross6b4a32d2017-12-05 13:42:45 -08002721 } else {
2722 j.wrapperFile = android.PathForSource(ctx, "build/soong/scripts/jar-wrapper.sh")
2723 }
2724
Colin Crossc179ea62020-10-09 10:54:15 -07002725 // The host installation rules make the installed wrapper depend on all the dependencies
Colin Cross89226d92020-10-09 19:00:54 -07002726 // of the wrapper variant, which will include the common variant's jar file and any JNI
2727 // libraries. This is verified by TestBinary.
Colin Cross6b4a32d2017-12-05 13:42:45 -08002728 j.binaryFile = ctx.InstallExecutable(android.PathForModuleInstall(ctx, "bin"),
Colin Crossc179ea62020-10-09 10:54:15 -07002729 ctx.ModuleName(), j.wrapperFile)
Nan Zhang3c807db2017-11-03 14:53:31 -07002730 }
Colin Cross2fe66872015-03-30 17:20:39 -07002731}
2732
Colin Crossf506d872017-07-19 15:53:04 -07002733func (j *Binary) DepsMutator(ctx android.BottomUpMutatorContext) {
Liz Kammer356f7d42021-01-26 09:18:53 -05002734 if ctx.Arch().ArchType == android.Common || ctx.BazelConversionMode() {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002735 j.deps(ctx)
Liz Kammer356f7d42021-01-26 09:18:53 -05002736 }
2737 if ctx.Arch().ArchType != android.Common || ctx.BazelConversionMode() {
Colin Crosse9fe2942020-11-10 18:12:15 -08002738 // These dependencies ensure the host installation rules will install the jar file and
2739 // the jni libraries when the wrapper is installed.
2740 ctx.AddVariationDependencies(nil, jniInstallTag, j.binaryProperties.Jni_libs...)
2741 ctx.AddVariationDependencies(
2742 []blueprint.Variation{{Mutator: "arch", Variation: android.CommonArch.String()}},
2743 binaryInstallTag, ctx.ModuleName())
Colin Cross6b4a32d2017-12-05 13:42:45 -08002744 }
Colin Cross46c9b8b2017-06-22 16:51:17 -07002745}
2746
Colin Cross1b16b0e2019-02-12 14:41:32 -08002747// java_binary builds a `.jar` file and a shell script that executes it for the device, and possibly for the host
2748// as well.
2749//
2750// By default, a java_binary has a single variant that produces a `.jar` file containing `classes.dex` files that were
2751// compiled against the device bootclasspath.
2752//
2753// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2754// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002755func BinaryFactory() android.Module {
2756 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002757
Colin Crossce6734e2020-06-15 16:09:53 -07002758 module.addHostAndDeviceProperties()
2759 module.AddProperties(&module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002760
Colin Cross9ae1b922018-06-26 17:59:05 -07002761 module.Module.properties.Installable = proptools.BoolPtr(true)
2762
Colin Cross6b4a32d2017-12-05 13:42:45 -08002763 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibCommonFirst)
2764 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002765 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002766}
2767
Colin Cross1b16b0e2019-02-12 14:41:32 -08002768// java_binary_host builds a `.jar` file and a shell script that executes it for the host.
2769//
2770// A java_binary_host has a single variant that produces a `.jar` file containing `.class` files that were
2771// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002772func BinaryHostFactory() android.Module {
2773 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002774
Colin Crossce6734e2020-06-15 16:09:53 -07002775 module.addHostProperties()
2776 module.AddProperties(&module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002777
Colin Cross9ae1b922018-06-26 17:59:05 -07002778 module.Module.properties.Installable = proptools.BoolPtr(true)
2779
Colin Cross6b4a32d2017-12-05 13:42:45 -08002780 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommonFirst)
2781 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002782 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002783}
2784
2785//
2786// Java prebuilts
2787//
2788
Colin Cross74d73e22017-08-02 11:05:49 -07002789type ImportProperties struct {
Paul Duffina04c1072020-03-02 10:16:35 +00002790 Jars []string `android:"path,arch_variant"`
Colin Cross461bd1a2017-10-20 13:59:18 -07002791
Nan Zhangea568a42017-11-08 21:20:04 -08002792 Sdk_version *string
Colin Cross535e2cf2017-10-20 17:57:49 -07002793
2794 Installable *bool
Jiyong Park1be96912018-05-28 18:02:19 +09002795
2796 // List of shared java libs that this module has dependencies to
2797 Libs []string
Colin Cross37f6d792018-07-12 12:28:41 -07002798
2799 // List of files to remove from the jar file(s)
2800 Exclude_files []string
2801
2802 // List of directories to remove from the jar file(s)
2803 Exclude_dirs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -07002804
2805 // if set to true, run Jetifier against .jar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -07002806 Jetifier *bool
Jiyong Park4c4c0242019-10-21 14:53:15 +09002807
2808 // set the name of the output
2809 Stem *string
Jiyong Park19604de2020-03-24 16:44:11 +09002810
2811 Aidl struct {
2812 // directories that should be added as include directories for any aidl sources of modules
2813 // that depend on this module, as well as to aidl for this module.
2814 Export_include_dirs []string
2815 }
Colin Cross74d73e22017-08-02 11:05:49 -07002816}
2817
2818type Import struct {
Colin Cross635c3b02016-05-18 15:37:25 -07002819 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -07002820 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002821 android.ApexModuleBase
Colin Crossec7a0422017-07-07 14:47:12 -07002822 prebuilt android.Prebuilt
Jiyong Parkd1063c12019-07-17 20:08:41 +09002823 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -07002824
Paul Duffin0d3c2e12020-05-17 08:34:50 +01002825 // Functionality common to Module and Import.
2826 embeddableInModuleAndImport
2827
Liz Kammerd6c31d22020-08-05 15:40:41 -07002828 hiddenAPI
2829 dexer
Bill Peckhamff89ffa2020-12-23 16:13:04 -08002830 dexpreopter
Liz Kammerd6c31d22020-08-05 15:40:41 -07002831
Colin Cross74d73e22017-08-02 11:05:49 -07002832 properties ImportProperties
2833
Liz Kammerd6c31d22020-08-05 15:40:41 -07002834 // output file containing classes.dex and resources
2835 dexJarFile android.Path
2836
Colin Cross0a6e0072017-08-30 14:24:55 -07002837 combinedClasspathFile android.Path
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01002838 classLoaderContexts dexpreopt.ClassLoaderContextMap
Jiyong Park19604de2020-03-24 16:44:11 +09002839 exportAidlIncludeDirs android.Paths
Colin Cross56a83212020-09-15 18:30:11 -07002840
2841 hideApexVariantFromMake bool
Colin Cross2fe66872015-03-30 17:20:39 -07002842}
2843
Jiyong Park6a927c42020-01-21 02:03:43 +09002844func (j *Import) sdkVersion() sdkSpec {
2845 return sdkSpecFrom(String(j.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07002846}
2847
Liz Kammer2d2fd852020-08-12 14:42:30 -07002848func (j *Import) makeSdkVersion() string {
2849 return j.sdkVersion().raw
2850}
2851
Liz Kammerd6c31d22020-08-05 15:40:41 -07002852func (j *Import) systemModules() string {
2853 return "none"
2854}
2855
Jiyong Park6a927c42020-01-21 02:03:43 +09002856func (j *Import) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -07002857 return j.sdkVersion()
2858}
2859
Liz Kammerd6c31d22020-08-05 15:40:41 -07002860func (j *Import) targetSdkVersion() sdkSpec {
2861 return j.sdkVersion()
2862}
2863
Artur Satayev480e25b2020-04-27 18:53:18 +01002864func (j *Import) MinSdkVersion() string {
2865 return j.minSdkVersion().version.String()
2866}
2867
Colin Cross74d73e22017-08-02 11:05:49 -07002868func (j *Import) Prebuilt() *android.Prebuilt {
Colin Crossec7a0422017-07-07 14:47:12 -07002869 return &j.prebuilt
2870}
2871
Colin Cross74d73e22017-08-02 11:05:49 -07002872func (j *Import) PrebuiltSrcs() []string {
2873 return j.properties.Jars
2874}
2875
2876func (j *Import) Name() string {
Colin Cross5ea9bcc2017-07-27 15:41:32 -07002877 return j.prebuilt.Name(j.ModuleBase.Name())
2878}
2879
Jiyong Park0b238752019-10-29 11:23:10 +09002880func (j *Import) Stem() string {
2881 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2882}
2883
Jiyong Park618922e2020-01-08 13:35:43 +09002884func (a *Import) JacocoReportClassesFile() android.Path {
2885 return nil
2886}
2887
Bill Peckhama41a6962021-01-11 10:58:54 -08002888func (j *Import) LintDepSets() LintDepSets {
2889 return LintDepSets{}
2890}
2891
Colin Cross74d73e22017-08-02 11:05:49 -07002892func (j *Import) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross42d48b72018-08-29 14:10:52 -07002893 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Liz Kammerd6c31d22020-08-05 15:40:41 -07002894
2895 if ctx.Device() && Bool(j.dexProperties.Compile_dex) {
2896 sdkDeps(ctx, sdkContext(j), j.dexer)
2897 }
Colin Cross1e676be2016-10-12 14:38:15 -07002898}
2899
Colin Cross74d73e22017-08-02 11:05:49 -07002900func (j *Import) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Paul Duffin4103e922021-02-01 19:01:34 +00002901 // Initialize the hiddenapi structure.
2902 j.initHiddenAPI(ctx, j.BaseModuleName())
2903
Colin Cross56a83212020-09-15 18:30:11 -07002904 if !ctx.Provider(android.ApexInfoProvider).(android.ApexInfo).IsForPlatform() {
2905 j.hideApexVariantFromMake = true
2906 }
2907
Colin Cross8a497952019-03-05 22:25:09 -08002908 jars := android.PathsForModuleSrc(ctx, j.properties.Jars)
Colin Crosse1d62a82015-04-03 16:53:05 -07002909
Jiyong Park0b238752019-10-29 11:23:10 +09002910 jarName := j.Stem() + ".jar"
Nan Zhang4c819fb2018-08-27 18:31:46 -07002911 outputFile := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07002912 TransformJarsToJar(ctx, outputFile, "for prebuilts", jars, android.OptionalPath{},
2913 false, j.properties.Exclude_files, j.properties.Exclude_dirs)
Colin Cross1001a792019-03-21 22:21:39 -07002914 if Bool(j.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -07002915 inputFile := outputFile
2916 outputFile = android.PathForModuleOut(ctx, "jetifier", jarName)
2917 TransformJetifier(ctx, outputFile, inputFile)
2918 }
Colin Crosse9a275b2017-10-16 17:09:48 -07002919 j.combinedClasspathFile = outputFile
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01002920 j.classLoaderContexts = make(dexpreopt.ClassLoaderContextMap)
Paul Duffin859fe962020-05-15 10:20:31 +01002921
Liz Kammerd6c31d22020-08-05 15:40:41 -07002922 var flags javaBuilderFlags
Paul Duffin064b70c2020-11-02 17:32:38 +00002923 var deapexerModule android.Module
Liz Kammerd6c31d22020-08-05 15:40:41 -07002924
Jiyong Park1be96912018-05-28 18:02:19 +09002925 ctx.VisitDirectDeps(func(module android.Module) {
Jiyong Park1be96912018-05-28 18:02:19 +09002926 tag := ctx.OtherModuleDependencyTag(module)
2927
Colin Crossdcf71b22021-02-01 13:59:03 -08002928 if ctx.OtherModuleHasProvider(module, JavaInfoProvider) {
2929 dep := ctx.OtherModuleProvider(module, JavaInfoProvider).(JavaInfo)
Jiyong Park1be96912018-05-28 18:02:19 +09002930 switch tag {
2931 case libTag, staticLibTag:
Colin Crossdcf71b22021-02-01 13:59:03 -08002932 flags.classpath = append(flags.classpath, dep.HeaderJars...)
Liz Kammerd6c31d22020-08-05 15:40:41 -07002933 case bootClasspathTag:
Colin Crossdcf71b22021-02-01 13:59:03 -08002934 flags.bootClasspath = append(flags.bootClasspath, dep.HeaderJars...)
Jiyong Park1be96912018-05-28 18:02:19 +09002935 }
Colin Crossdcf71b22021-02-01 13:59:03 -08002936 } else if dep, ok := module.(SdkLibraryDependency); ok {
Jiyong Park1be96912018-05-28 18:02:19 +09002937 switch tag {
2938 case libTag:
Liz Kammerd6c31d22020-08-05 15:40:41 -07002939 flags.classpath = append(flags.classpath, dep.SdkHeaderJars(ctx, j.sdkVersion())...)
Jiyong Park1be96912018-05-28 18:02:19 +09002940 }
2941 }
Ulya Trafimovich65b03192020-12-03 16:50:22 +00002942
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002943 addCLCFromDep(ctx, module, j.classLoaderContexts)
Paul Duffin064b70c2020-11-02 17:32:38 +00002944
2945 // Save away the `deapexer` module on which this depends, if any.
2946 if tag == android.DeapexerTag {
2947 deapexerModule = module
2948 }
Jiyong Park1be96912018-05-28 18:02:19 +09002949 })
2950
Nan Zhang4973ecf2018-08-10 13:42:12 -07002951 if Bool(j.properties.Installable) {
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00002952 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Park4c4c0242019-10-21 14:53:15 +09002953 jarName, outputFile)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002954 }
Jiyong Park19604de2020-03-24 16:44:11 +09002955
2956 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.properties.Aidl.Export_include_dirs)
Liz Kammerd6c31d22020-08-05 15:40:41 -07002957
Paul Duffin064b70c2020-11-02 17:32:38 +00002958 if ctx.Device() {
2959 // If this is a variant created for a prebuilt_apex then use the dex implementation jar
2960 // obtained from the associated deapexer module.
2961 ai := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
2962 if ai.ForPrebuiltApex {
2963 if deapexerModule == nil {
2964 // This should never happen as a variant for a prebuilt_apex is only created if the
2965 // deapxer module has been configured to export the dex implementation jar for this module.
2966 ctx.ModuleErrorf("internal error: module %q does not depend on a `deapexer` module for prebuilt_apex %q",
2967 j.Name(), ai.ApexVariationName)
2968 }
2969
2970 // Get the path of the dex implementation jar from the `deapexer` module.
2971 di := ctx.OtherModuleProvider(deapexerModule, android.DeapexerProvider).(android.DeapexerInfo)
Paul Duffin9d67ca62021-02-03 20:06:33 +00002972 if dexOutputPath := di.PrebuiltExportPath(j.BaseModuleName(), ".dexjar"); dexOutputPath != nil {
2973 j.dexJarFile = dexOutputPath
Paul Duffinf75e5272021-02-09 14:34:25 +00002974 j.hiddenAPIExtractInformation(ctx, dexOutputPath, outputFile)
Paul Duffin9d67ca62021-02-03 20:06:33 +00002975 } else {
Paul Duffin064b70c2020-11-02 17:32:38 +00002976 // This should never happen as a variant for a prebuilt_apex is only created if the
2977 // prebuilt_apex has been configured to export the java library dex file.
2978 ctx.ModuleErrorf("internal error: no dex implementation jar available from prebuilt_apex %q", deapexerModule.Name())
2979 }
2980 } else if Bool(j.dexProperties.Compile_dex) {
2981 sdkDep := decodeSdkDep(ctx, sdkContext(j))
2982 if sdkDep.invalidVersion {
2983 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2984 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2985 } else if sdkDep.useFiles {
2986 // sdkDep.jar is actually equivalent to turbine header.jar.
2987 flags.classpath = append(flags.classpath, sdkDep.jars...)
2988 }
2989
2990 // Dex compilation
2991
2992 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", jarName)
2993 if j.dexProperties.Uncompress_dex == nil {
2994 // If the value was not force-set by the user, use reasonable default based on the module.
2995 j.dexProperties.Uncompress_dex = proptools.BoolPtr(shouldUncompressDex(ctx, &j.dexpreopter))
2996 }
2997 j.dexpreopter.uncompressedDex = *j.dexProperties.Uncompress_dex
2998
Paul Duffin612e6102021-02-02 13:38:13 +00002999 var dexOutputFile android.OutputPath
Paul Duffin064b70c2020-11-02 17:32:38 +00003000 dexOutputFile = j.dexer.compileDex(ctx, flags, j.minSdkVersion(), outputFile, jarName)
3001 if ctx.Failed() {
3002 return
3003 }
3004
Paul Duffin064b70c2020-11-02 17:32:38 +00003005 // Hidden API CSV generation and dex encoding
Paul Duffinf75e5272021-02-09 14:34:25 +00003006 dexOutputFile = j.hiddenAPIExtractAndEncode(ctx, dexOutputFile, outputFile,
Paul Duffin064b70c2020-11-02 17:32:38 +00003007 proptools.Bool(j.dexProperties.Uncompress_dex))
3008
3009 j.dexJarFile = dexOutputFile
Liz Kammerd6c31d22020-08-05 15:40:41 -07003010 }
Liz Kammerd6c31d22020-08-05 15:40:41 -07003011 }
Colin Crossdcf71b22021-02-01 13:59:03 -08003012
3013 ctx.SetProvider(JavaInfoProvider, JavaInfo{
3014 HeaderJars: android.PathsIfNonNil(j.combinedClasspathFile),
3015 ImplementationAndResourcesJars: android.PathsIfNonNil(j.combinedClasspathFile),
3016 ImplementationJars: android.PathsIfNonNil(j.combinedClasspathFile),
3017 AidlIncludeDirs: j.exportAidlIncludeDirs,
3018 })
Colin Cross2fe66872015-03-30 17:20:39 -07003019}
3020
Paul Duffinaa55f742020-10-06 17:20:13 +01003021func (j *Import) OutputFiles(tag string) (android.Paths, error) {
3022 switch tag {
Saeid Farivar Asanjan128fe5c2020-10-15 17:54:40 +00003023 case "", ".jar":
Paul Duffinaa55f742020-10-06 17:20:13 +01003024 return android.Paths{j.combinedClasspathFile}, nil
3025 default:
3026 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
3027 }
3028}
3029
3030var _ android.OutputFileProducer = (*Import)(nil)
3031
Nan Zhanged19fc32017-10-19 13:06:22 -07003032func (j *Import) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08003033 if j.combinedClasspathFile == nil {
3034 return nil
3035 }
Colin Cross37f6d792018-07-12 12:28:41 -07003036 return android.Paths{j.combinedClasspathFile}
Nan Zhanged19fc32017-10-19 13:06:22 -07003037}
3038
3039func (j *Import) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08003040 if j.combinedClasspathFile == nil {
3041 return nil
3042 }
Colin Cross37f6d792018-07-12 12:28:41 -07003043 return android.Paths{j.combinedClasspathFile}
Colin Cross2fe66872015-03-30 17:20:39 -07003044}
3045
Colin Cross331a1212018-08-15 20:40:52 -07003046func (j *Import) ResourceJars() android.Paths {
3047 return nil
3048}
3049
3050func (j *Import) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08003051 if j.combinedClasspathFile == nil {
3052 return nil
3053 }
Colin Cross331a1212018-08-15 20:40:52 -07003054 return android.Paths{j.combinedClasspathFile}
3055}
3056
Ulyana Trafimovich5539e7b2020-06-04 14:08:17 +00003057func (j *Import) DexJarBuildPath() android.Path {
Liz Kammerd6c31d22020-08-05 15:40:41 -07003058 return j.dexJarFile
Colin Crossf24a22a2019-01-31 14:12:44 -08003059}
3060
Ulya Trafimovich9f3052c2020-06-09 14:31:19 +01003061func (j *Import) DexJarInstallPath() android.Path {
3062 return nil
3063}
3064
Colin Cross74d73e22017-08-02 11:05:49 -07003065func (j *Import) AidlIncludeDirs() android.Paths {
Jiyong Park19604de2020-03-24 16:44:11 +09003066 return j.exportAidlIncludeDirs
Colin Crossc0b06f12015-04-08 13:03:43 -07003067}
3068
Ulya Trafimovichb23d28c2020-10-08 12:53:58 +01003069func (j *Import) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
3070 return j.classLoaderContexts
Jiyong Park1be96912018-05-28 18:02:19 +09003071}
3072
Colin Crossc9fe10f2020-11-19 18:06:03 -08003073func (j *Import) ExportedPlugins() (android.Paths, []string, bool) {
3074 return nil, nil, false
Artur Satayev9cf46692019-11-26 18:08:34 +00003075}
3076
Colin Cross0c4ce212019-05-03 15:28:19 -07003077func (j *Import) SrcJarArgs() ([]string, android.Paths) {
3078 return nil, nil
3079}
3080
Jiyong Park45bf82e2020-12-15 22:29:02 +09003081var _ android.ApexModule = (*Import)(nil)
3082
3083// Implements android.ApexModule
Jiyong Park0f80c182020-01-31 02:49:53 +09003084func (j *Import) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffin0d3c2e12020-05-17 08:34:50 +01003085 return j.depIsInSameApex(ctx, dep)
Jiyong Park0f80c182020-01-31 02:49:53 +09003086}
3087
Jiyong Park45bf82e2020-12-15 22:29:02 +09003088// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003089func (j *Import) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3090 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003091 // Do not check for prebuilts against the min_sdk_version of enclosing APEX
3092 return nil
3093}
3094
albaltai36ff7dc2018-12-25 14:35:23 +08003095// Add compile time check for interface implementation
3096var _ android.IDEInfo = (*Import)(nil)
3097var _ android.IDECustomizedModuleName = (*Import)(nil)
3098
Brandon Lee5d45c6f2018-08-15 15:35:38 -07003099// Collect information for opening IDE project files in java/jdeps.go.
3100const (
3101 removedPrefix = "prebuilt_"
3102)
3103
3104func (j *Import) IDEInfo(dpInfo *android.IdeInfo) {
3105 dpInfo.Jars = append(dpInfo.Jars, j.PrebuiltSrcs()...)
3106}
3107
3108func (j *Import) IDECustomizedModuleName() string {
3109 // TODO(b/113562217): Extract the base module name from the Import name, often the Import name
3110 // has a prefix "prebuilt_". Remove the prefix explicitly if needed until we find a better
3111 // solution to get the Import name.
3112 name := j.Name()
3113 if strings.HasPrefix(name, removedPrefix) {
patricktubb640e02018-10-11 18:33:16 +08003114 name = strings.TrimPrefix(name, removedPrefix)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07003115 }
3116 return name
3117}
3118
Colin Cross74d73e22017-08-02 11:05:49 -07003119var _ android.PrebuiltInterface = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07003120
Bill Peckhamff89ffa2020-12-23 16:13:04 -08003121func (j *Import) IsInstallable() bool {
3122 return Bool(j.properties.Installable)
3123}
3124
3125var _ dexpreopterInterface = (*Import)(nil)
3126
Colin Cross1b16b0e2019-02-12 14:41:32 -08003127// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library module.
3128//
3129// By default, a java_import has a single variant that expects a `.jar` file containing `.class` files that were
3130// compiled against an Android classpath.
3131//
3132// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
3133// for host modules.
Colin Cross74d73e22017-08-02 11:05:49 -07003134func ImportFactory() android.Module {
3135 module := &Import{}
Colin Cross36242852017-06-23 15:06:31 -07003136
Liz Kammerd6c31d22020-08-05 15:40:41 -07003137 module.AddProperties(
3138 &module.properties,
3139 &module.dexer.dexProperties,
3140 )
Colin Cross74d73e22017-08-02 11:05:49 -07003141
Paul Duffin859fe962020-05-15 10:20:31 +01003142 module.initModuleAndImport(&module.ModuleBase)
3143
Liz Kammerd6c31d22020-08-05 15:40:41 -07003144 module.dexProperties.Optimize.EnabledByDefault = false
3145
Colin Cross74d73e22017-08-02 11:05:49 -07003146 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09003147 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09003148 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09003149 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross36242852017-06-23 15:06:31 -07003150 return module
Colin Cross2fe66872015-03-30 17:20:39 -07003151}
3152
Colin Cross1b16b0e2019-02-12 14:41:32 -08003153// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library_host
3154// module.
3155//
3156// A java_import_host has a single variant that expects a `.jar` file containing `.class` files that were
3157// compiled against a host bootclasspath.
Colin Cross74d73e22017-08-02 11:05:49 -07003158func ImportFactoryHost() android.Module {
3159 module := &Import{}
3160
3161 module.AddProperties(&module.properties)
3162
3163 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09003164 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09003165 InitJavaModule(module, android.HostSupported)
Colin Cross74d73e22017-08-02 11:05:49 -07003166 return module
3167}
3168
Colin Cross42be7612019-02-21 18:12:14 -08003169// dex_import module
3170
3171type DexImportProperties struct {
Colin Cross5cfc70d2019-07-15 13:36:55 -07003172 Jars []string `android:"path"`
Jiyong Park4c4c0242019-10-21 14:53:15 +09003173
3174 // set the name of the output
3175 Stem *string
Colin Cross42be7612019-02-21 18:12:14 -08003176}
3177
3178type DexImport struct {
3179 android.ModuleBase
3180 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09003181 android.ApexModuleBase
Colin Cross42be7612019-02-21 18:12:14 -08003182 prebuilt android.Prebuilt
3183
3184 properties DexImportProperties
3185
3186 dexJarFile android.Path
3187 maybeStrippedDexJarFile android.Path
3188
3189 dexpreopter
Colin Cross56a83212020-09-15 18:30:11 -07003190
3191 hideApexVariantFromMake bool
Colin Cross42be7612019-02-21 18:12:14 -08003192}
3193
3194func (j *DexImport) Prebuilt() *android.Prebuilt {
3195 return &j.prebuilt
3196}
3197
3198func (j *DexImport) PrebuiltSrcs() []string {
3199 return j.properties.Jars
3200}
3201
3202func (j *DexImport) Name() string {
3203 return j.prebuilt.Name(j.ModuleBase.Name())
3204}
3205
Jiyong Park0b238752019-10-29 11:23:10 +09003206func (j *DexImport) Stem() string {
3207 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
3208}
3209
Jiyong Park77acec62020-06-01 21:39:15 +09003210func (a *DexImport) JacocoReportClassesFile() android.Path {
3211 return nil
3212}
3213
Colin Cross08dca382020-07-21 20:31:17 -07003214func (a *DexImport) LintDepSets() LintDepSets {
3215 return LintDepSets{}
3216}
3217
Martin Stjernholm6d415272020-01-31 17:10:36 +00003218func (j *DexImport) IsInstallable() bool {
3219 return true
3220}
3221
Colin Cross42be7612019-02-21 18:12:14 -08003222func (j *DexImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
3223 if len(j.properties.Jars) != 1 {
3224 ctx.PropertyErrorf("jars", "exactly one jar must be provided")
3225 }
3226
Colin Cross56a83212020-09-15 18:30:11 -07003227 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
3228 if !apexInfo.IsForPlatform() {
3229 j.hideApexVariantFromMake = true
3230 }
3231
Jiyong Park0b238752019-10-29 11:23:10 +09003232 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross42be7612019-02-21 18:12:14 -08003233 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
3234
3235 inputJar := ctx.ExpandSource(j.properties.Jars[0], "jars")
3236 dexOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar")
3237
3238 if j.dexpreopter.uncompressedDex {
Colin Crossf1a035e2020-11-16 17:32:30 -08003239 rule := android.NewRuleBuilder(pctx, ctx)
Colin Cross42be7612019-02-21 18:12:14 -08003240
3241 temporary := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar.unaligned")
3242 rule.Temporary(temporary)
3243
3244 // use zip2zip to uncompress classes*.dex files
3245 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08003246 BuiltTool("zip2zip").
Colin Cross42be7612019-02-21 18:12:14 -08003247 FlagWithInput("-i ", inputJar).
3248 FlagWithOutput("-o ", temporary).
3249 FlagWithArg("-0 ", "'classes*.dex'")
3250
3251 // use zipalign to align uncompressed classes*.dex files
3252 rule.Command().
Colin Crossf1a035e2020-11-16 17:32:30 -08003253 BuiltTool("zipalign").
Colin Cross42be7612019-02-21 18:12:14 -08003254 Flag("-f").
3255 Text("4").
3256 Input(temporary).
3257 Output(dexOutputFile)
3258
3259 rule.DeleteTemporaryFiles()
3260
Colin Crossf1a035e2020-11-16 17:32:30 -08003261 rule.Build("uncompress_dex", "uncompress dex")
Colin Cross42be7612019-02-21 18:12:14 -08003262 } else {
3263 ctx.Build(pctx, android.BuildParams{
3264 Rule: android.Cp,
3265 Input: inputJar,
3266 Output: dexOutputFile,
3267 })
3268 }
3269
3270 j.dexJarFile = dexOutputFile
3271
Jaewoong Jung4b97a562020-12-17 09:43:28 -08003272 j.dexpreopt(ctx, dexOutputFile)
Colin Cross42be7612019-02-21 18:12:14 -08003273
3274 j.maybeStrippedDexJarFile = dexOutputFile
3275
Colin Cross56a83212020-09-15 18:30:11 -07003276 if apexInfo.IsForPlatform() {
Jiyong Park01bca752020-06-08 19:24:09 +09003277 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
3278 j.Stem()+".jar", dexOutputFile)
3279 }
Colin Cross42be7612019-02-21 18:12:14 -08003280}
3281
Ulyana Trafimovich5539e7b2020-06-04 14:08:17 +00003282func (j *DexImport) DexJarBuildPath() android.Path {
Colin Cross42be7612019-02-21 18:12:14 -08003283 return j.dexJarFile
3284}
3285
Jiyong Park45bf82e2020-12-15 22:29:02 +09003286var _ android.ApexModule = (*DexImport)(nil)
3287
3288// Implements android.ApexModule
Dan Albertc8060532020-07-22 22:32:17 -07003289func (j *DexImport) ShouldSupportSdkVersion(ctx android.BaseModuleContext,
3290 sdkVersion android.ApiLevel) error {
Jooyung Han749dc692020-04-15 11:03:39 +09003291 // we don't check prebuilt modules for sdk_version
3292 return nil
3293}
3294
Colin Cross42be7612019-02-21 18:12:14 -08003295// dex_import imports a `.jar` file containing classes.dex files.
3296//
3297// A dex_import module cannot be used as a dependency of a java_* or android_* module, it can only be installed
3298// to the device.
3299func DexImportFactory() android.Module {
3300 module := &DexImport{}
3301
3302 module.AddProperties(&module.properties)
3303
3304 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09003305 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09003306 InitJavaModule(module, android.DeviceSupported)
Colin Cross42be7612019-02-21 18:12:14 -08003307 return module
3308}
3309
Colin Cross89536d42017-07-07 14:35:50 -07003310//
3311// Defaults
3312//
3313type Defaults struct {
3314 android.ModuleBase
3315 android.DefaultsModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09003316 android.ApexModuleBase
Colin Cross89536d42017-07-07 14:35:50 -07003317}
3318
Colin Cross1b16b0e2019-02-12 14:41:32 -08003319// java_defaults provides a set of properties that can be inherited by other java or android modules.
3320//
3321// A module can use the properties from a java_defaults module using `defaults: ["defaults_module_name"]`. Each
3322// property in the defaults module that exists in the depending module will be prepended to the depending module's
3323// value for that property.
3324//
3325// Example:
3326//
3327// java_defaults {
3328// name: "example_defaults",
3329// srcs: ["common/**/*.java"],
3330// javacflags: ["-Xlint:all"],
3331// aaptflags: ["--auto-add-overlay"],
3332// }
3333//
3334// java_library {
3335// name: "example",
3336// defaults: ["example_defaults"],
3337// srcs: ["example/**/*.java"],
3338// }
3339//
3340// is functionally identical to:
3341//
3342// java_library {
3343// name: "example",
3344// srcs: [
3345// "common/**/*.java",
3346// "example/**/*.java",
3347// ],
3348// javacflags: ["-Xlint:all"],
3349// }
Colin Cross89536d42017-07-07 14:35:50 -07003350func defaultsFactory() android.Module {
3351 return DefaultsFactory()
3352}
3353
Paul Duffin47357662019-12-05 14:07:14 +00003354func DefaultsFactory() android.Module {
Colin Cross89536d42017-07-07 14:35:50 -07003355 module := &Defaults{}
3356
Colin Cross89536d42017-07-07 14:35:50 -07003357 module.AddProperties(
3358 &CompilerProperties{},
3359 &CompilerDeviceProperties{},
Liz Kammera7a64f32020-07-09 15:16:41 -07003360 &DexProperties{},
Colin Cross43f08db2018-11-12 10:13:39 -08003361 &DexpreoptProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08003362 &android.ProtoProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07003363 &aaptProperties{},
3364 &androidLibraryProperties{},
3365 &appProperties{},
3366 &appTestProperties{},
Jaewoong Jung525443a2019-02-28 15:35:54 -08003367 &overridableAppProperties{},
Roland Levillainb5b0ff32020-02-04 15:45:49 +00003368 &testProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07003369 &ImportProperties{},
3370 &AARImportProperties{},
3371 &sdkLibraryProperties{},
Paul Duffin1b1e8062020-05-08 13:44:43 +01003372 &commonToSdkLibraryAndImportProperties{},
Colin Cross42be7612019-02-21 18:12:14 -08003373 &DexImportProperties{},
Jooyung Han18020ea2019-11-13 10:50:48 +09003374 &android.ApexProperties{},
Jaewoong Jungbf135462020-04-26 15:10:51 -07003375 &RuntimeResourceOverlayProperties{},
Colin Cross014489c2020-06-02 20:09:13 -07003376 &LintProperties{},
Colin Crosscbce0b02021-02-09 10:38:30 -08003377 &appTestHelperAppProperties{},
Colin Cross89536d42017-07-07 14:35:50 -07003378 )
3379
3380 android.InitDefaultsModule(module)
Colin Cross89536d42017-07-07 14:35:50 -07003381 return module
3382}
Nan Zhangea568a42017-11-08 21:20:04 -08003383
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003384func kytheExtractJavaFactory() android.Singleton {
3385 return &kytheExtractJavaSingleton{}
3386}
3387
3388type kytheExtractJavaSingleton struct {
3389}
3390
3391func (ks *kytheExtractJavaSingleton) GenerateBuildActions(ctx android.SingletonContext) {
3392 var xrefTargets android.Paths
3393 ctx.VisitAllModules(func(module android.Module) {
3394 if javaModule, ok := module.(xref); ok {
3395 xrefTargets = append(xrefTargets, javaModule.XrefJavaFiles()...)
3396 }
3397 })
3398 // TODO(asmundak): perhaps emit a rule to output a warning if there were no xrefTargets
3399 if len(xrefTargets) > 0 {
Colin Crossc3d87d32020-06-04 13:25:17 -07003400 ctx.Phony("xref_java", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08003401 }
3402}
3403
Nan Zhangea568a42017-11-08 21:20:04 -08003404var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07003405var BoolDefault = proptools.BoolDefault
Nan Zhangea568a42017-11-08 21:20:04 -08003406var String = proptools.String
Colin Cross0d0ba592018-02-20 13:33:42 -08003407var inList = android.InList
Ulya Trafimovich65b03192020-12-03 16:50:22 +00003408
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00003409// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
3410// this interface.
3411type ProvidesUsesLib interface {
3412 ProvidesUsesLib() *string
3413}
Ulya Trafimovich65b03192020-12-03 16:50:22 +00003414
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00003415func (j *Module) ProvidesUsesLib() *string {
3416 return j.usesLibraryProperties.Provides_uses_lib
3417}
Ulya Trafimovich65b03192020-12-03 16:50:22 +00003418
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00003419// Add class loader context (CLC) of a given dependency to the current CLC.
3420func addCLCFromDep(ctx android.ModuleContext, depModule android.Module,
3421 clcMap dexpreopt.ClassLoaderContextMap) {
3422
3423 dep, ok := depModule.(UsesLibraryDependency)
3424 if !ok {
3425 return
3426 }
3427
3428 // Find out if the dependency is either an SDK library or an ordinary library that is disguised
3429 // as an SDK library by the means of `provides_uses_lib` property. If yes, the library is itself
3430 // a <uses-library> and should be added as a node in the CLC tree, and its CLC should be added
3431 // as subtree of that node. Otherwise the library is not a <uses_library> and should not be
3432 // added to CLC, but the transitive <uses-library> dependencies from its CLC should be added to
3433 // the current CLC.
3434 var implicitSdkLib *string
3435 comp, isComp := depModule.(SdkLibraryComponentDependency)
3436 if isComp {
3437 implicitSdkLib = comp.OptionalImplicitSdkLibrary()
3438 // OptionalImplicitSdkLibrary() may be nil so need to fall through to ProvidesUsesLib().
3439 }
3440 if implicitSdkLib == nil {
3441 if ulib, ok := depModule.(ProvidesUsesLib); ok {
3442 implicitSdkLib = ulib.ProvidesUsesLib()
Ulya Trafimovich65b03192020-12-03 16:50:22 +00003443 }
3444 }
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00003445
3446 depTag := ctx.OtherModuleDependencyTag(depModule)
3447 if depTag == libTag || depTag == usesLibTag {
3448 // Ok, propagate <uses-library> through non-static library dependencies.
3449 } else if depTag == staticLibTag {
3450 // Propagate <uses-library> through static library dependencies, unless it is a component
3451 // library (such as stubs). Component libraries have a dependency on their SDK library,
3452 // which should not be pulled just because of a static component library.
3453 if implicitSdkLib != nil {
3454 return
3455 }
3456 } else {
3457 // Don't propagate <uses-library> for other dependency tags.
3458 return
3459 }
3460
3461 if implicitSdkLib != nil {
Ulya Trafimovich7bc1cf52021-01-05 15:41:55 +00003462 clcMap.AddContext(ctx, dexpreopt.AnySdkVersion, *implicitSdkLib,
Ulya Trafimovich88bb6f62020-12-16 16:16:11 +00003463 dep.DexJarBuildPath(), dep.DexJarInstallPath(), dep.ClassLoaderContexts())
3464 } else {
3465 depName := ctx.OtherModuleName(depModule)
3466 clcMap.AddContextMap(dep.ClassLoaderContexts(), depName)
3467 }
Ulya Trafimovich65b03192020-12-03 16:50:22 +00003468}