blob: 9e196f43d6789048c5ee237574bebb04392ff6c8 [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"
Colin Cross3e3e72d2017-06-22 17:20:19 -070032 "android/soong/java/config"
Colin Cross303e21f2018-08-07 16:49:25 -070033 "android/soong/tradefed"
Colin Cross2fe66872015-03-30 17:20:39 -070034)
35
Colin Cross463a90e2015-06-17 14:20:06 -070036func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000037 RegisterJavaBuildComponents(android.InitRegistrationContext)
Paul Duffin255f18e2019-12-13 11:22:16 +000038
39 // Register sdk member types.
Paul Duffin7b81f5e2020-01-13 21:03:22 +000040 android.RegisterSdkMemberType(javaHeaderLibsSdkMemberType)
Paul Duffin255f18e2019-12-13 11:22:16 +000041
Paul Duffin2b9e3d32020-02-28 14:39:53 +000042 android.RegisterSdkMemberType(&librarySdkMemberType{
43 android.SdkMemberTypeBase{
44 PropertyName: "java_libs",
45 },
46 func(j *Library) android.Path {
47 implementationJars := j.ImplementationJars()
48 if len(implementationJars) != 1 {
49 panic(fmt.Errorf("there must be only one implementation jar from %q", j.Name()))
50 }
51
52 return implementationJars[0]
Paul Duffin255f18e2019-12-13 11:22:16 +000053 },
54 })
Paul Duffin1b82e6a2019-12-03 18:06:47 +000055
56 android.RegisterSdkMemberType(&testSdkMemberType{
57 SdkMemberTypeBase: android.SdkMemberTypeBase{
58 PropertyName: "java_tests",
59 },
60 })
Colin Cross463a90e2015-06-17 14:20:06 -070061}
62
Paul Duffinf9b1da02019-12-18 19:51:55 +000063func RegisterJavaBuildComponents(ctx android.RegistrationContext) {
64 ctx.RegisterModuleType("java_defaults", DefaultsFactory)
65
66 ctx.RegisterModuleType("java_library", LibraryFactory)
67 ctx.RegisterModuleType("java_library_static", LibraryStaticFactory)
68 ctx.RegisterModuleType("java_library_host", LibraryHostFactory)
69 ctx.RegisterModuleType("java_binary", BinaryFactory)
70 ctx.RegisterModuleType("java_binary_host", BinaryHostFactory)
71 ctx.RegisterModuleType("java_test", TestFactory)
72 ctx.RegisterModuleType("java_test_helper_library", TestHelperLibraryFactory)
73 ctx.RegisterModuleType("java_test_host", TestHostFactory)
Paul Duffin1b82e6a2019-12-03 18:06:47 +000074 ctx.RegisterModuleType("java_test_import", JavaTestImportFactory)
Paul Duffinf9b1da02019-12-18 19:51:55 +000075 ctx.RegisterModuleType("java_import", ImportFactory)
76 ctx.RegisterModuleType("java_import_host", ImportFactoryHost)
77 ctx.RegisterModuleType("java_device_for_host", DeviceForHostFactory)
78 ctx.RegisterModuleType("java_host_for_device", HostForDeviceFactory)
79 ctx.RegisterModuleType("dex_import", DexImportFactory)
80
Martin Stjernholm6d415272020-01-31 17:10:36 +000081 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
82 ctx.BottomUp("dexpreopt_tool_deps", dexpreoptToolDepsMutator).Parallel()
83 })
Martin Stjernholmd90676f2020-01-11 00:37:30 +000084
Paul Duffinf9b1da02019-12-18 19:51:55 +000085 ctx.RegisterSingletonType("logtags", LogtagsSingleton)
86 ctx.RegisterSingletonType("kythe_java_extract", kytheExtractJavaFactory)
87}
88
Artur Satayev2eedf622020-04-15 17:29:42 +010089func (j *Module) CheckStableSdkVersion() error {
90 sdkVersion := j.sdkVersion()
91 if sdkVersion.stable() {
92 return nil
93 }
94 return fmt.Errorf("non stable SDK %v", sdkVersion)
95}
96
Artur Satayeve5ac15a2020-04-08 19:09:30 +010097func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
Colin Crosseb032962020-05-13 11:05:02 -070098 if j.RequiresStableAPIs(ctx) {
Jeongik Cha2cc570d2019-10-29 15:44:45 +090099 if sc, ok := ctx.Module().(sdkContext); ok {
Jiyong Park6a927c42020-01-21 02:03:43 +0900100 if !sc.sdkVersion().specified() {
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900101 ctx.PropertyErrorf("sdk_version",
102 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
103 }
104 }
105 }
Artur Satayeve5ac15a2020-04-08 19:09:30 +0100106
107 ctx.VisitDirectDeps(func(module android.Module) {
108 tag := ctx.OtherModuleDependencyTag(module)
109 switch module.(type) {
110 // TODO(satayev): cover other types as well, e.g. imports
111 case *Library, *AndroidLibrary:
112 switch tag {
113 case bootClasspathTag, libTag, staticLibTag, java9LibTag:
114 checkLinkType(ctx, j, module.(linkTypeContext), tag.(dependencyTag))
115 }
116 }
117 })
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900118}
119
Jeongik Cha538c0d02019-07-11 15:54:27 +0900120func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
121 if sc, ok := ctx.Module().(sdkContext); ok {
122 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park6a927c42020-01-21 02:03:43 +0900123 sdkVersionSpecified := sc.sdkVersion().specified()
124 if usePlatformAPI && sdkVersionSpecified {
125 ctx.PropertyErrorf("platform_apis", "platform_apis must be false when sdk_version is not empty.")
126 } else if !usePlatformAPI && !sdkVersionSpecified {
127 ctx.PropertyErrorf("platform_apis", "platform_apis must be true when sdk_version is empty.")
Jeongik Cha538c0d02019-07-11 15:54:27 +0900128 }
129
130 }
131}
132
Colin Cross2fe66872015-03-30 17:20:39 -0700133// TODO:
134// Autogenerated files:
Colin Cross2fe66872015-03-30 17:20:39 -0700135// Renderscript
136// Post-jar passes:
137// Proguard
Colin Cross2fe66872015-03-30 17:20:39 -0700138// Rmtypedefs
Colin Cross2fe66872015-03-30 17:20:39 -0700139// DroidDoc
140// Findbugs
141
Colin Cross89536d42017-07-07 14:35:50 -0700142type CompilerProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -0700143 // list of source files used to compile the Java module. May be .java, .logtags, .proto,
144 // or .aidl files.
Colin Cross27b922f2019-03-04 22:35:41 -0800145 Srcs []string `android:"path,arch_variant"`
Dan Willemsen2ef08f42015-06-30 18:15:24 -0700146
147 // list of source files that should not be used to build the Java module.
148 // This is most useful in the arch/multilib variants to remove non-common files
Colin Cross27b922f2019-03-04 22:35:41 -0800149 Exclude_srcs []string `android:"path,arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700150
151 // list of directories containing Java resources
Colin Cross86a63ff2017-09-27 17:33:10 -0700152 Java_resource_dirs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700153
Colin Cross86a63ff2017-09-27 17:33:10 -0700154 // list of directories that should be excluded from java_resource_dirs
155 Exclude_java_resource_dirs []string `android:"arch_variant"`
Dan Willemsen2ef08f42015-06-30 18:15:24 -0700156
Colin Cross0f37af02017-09-27 17:42:05 -0700157 // list of files to use as Java resources
Colin Cross27b922f2019-03-04 22:35:41 -0800158 Java_resources []string `android:"path,arch_variant"`
Colin Cross0f37af02017-09-27 17:42:05 -0700159
Colin Crosscedd4762018-09-13 11:26:19 -0700160 // list of files that should be excluded from java_resources and java_resource_dirs
Colin Cross27b922f2019-03-04 22:35:41 -0800161 Exclude_java_resources []string `android:"path,arch_variant"`
Colin Cross0f37af02017-09-27 17:42:05 -0700162
Colin Cross7d5136f2015-05-11 13:39:40 -0700163 // list of module-specific flags that will be used for javac compiles
164 Javacflags []string `android:"arch_variant"`
165
Zoran Jovanovic8736ce22018-08-21 17:10:29 +0200166 // list of module-specific flags that will be used for kotlinc compiles
167 Kotlincflags []string `android:"arch_variant"`
168
Colin Cross7d5136f2015-05-11 13:39:40 -0700169 // list of of java libraries that will be in the classpath
Colin Crosse8dc34a2017-07-19 11:22:16 -0700170 Libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700171
172 // list of java libraries that will be compiled into the resulting jar
Colin Crosse8dc34a2017-07-19 11:22:16 -0700173 Static_libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700174
175 // manifest file to be included in resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -0800176 Manifest *string `android:"path"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700177
Colin Cross540eff82017-06-22 17:01:52 -0700178 // if not blank, run jarjar using the specified rules file
Colin Cross27b922f2019-03-04 22:35:41 -0800179 Jarjar_rules *string `android:"path,arch_variant"`
Colin Cross64162712017-08-08 13:17:59 -0700180
181 // If not blank, set the java version passed to javac as -source and -target
182 Java_version *string
Colin Cross2c429dc2017-08-31 16:45:16 -0700183
Colin Cross9ae1b922018-06-26 17:59:05 -0700184 // If set to true, allow this module to be dexed and installed on devices. Has no
185 // effect on host modules, which are always considered installable.
Colin Cross2c429dc2017-08-31 16:45:16 -0700186 Installable *bool
Colin Cross32f676a2017-09-06 13:41:06 -0700187
Colin Cross0f37af02017-09-27 17:42:05 -0700188 // If set to true, include sources used to compile the module in to the final jar
189 Include_srcs *bool
190
Vladimir Marko0975ee02019-04-02 10:29:55 +0100191 // If not empty, classes are restricted to the specified packages and their sub-packages.
192 // This restriction is checked after applying jarjar rules and including static libs.
193 Permitted_packages []string
194
Colin Crossbe9cdb82019-01-21 21:37:16 -0800195 // List of modules to use as annotation processors
196 Plugins []string
Colin Cross1369cdb2017-09-29 17:58:17 -0700197
Artur Satayev9cf46692019-11-26 18:08:34 +0000198 // List of modules to export to libraries that directly depend on this library as annotation processors
199 Exported_plugins []string
200
Nan Zhang61eaedb2017-11-02 13:28:15 -0700201 // The number of Java source entries each Javac instance can process
202 Javac_shard_size *int64
203
Nan Zhang5f8cb422018-02-06 10:34:32 -0800204 // Add host jdk tools.jar to bootclasspath
205 Use_tools_jar *bool
206
Colin Cross1369cdb2017-09-29 17:58:17 -0700207 Openjdk9 struct {
Colin Cross6cef4812019-10-17 14:23:50 -0700208 // List of source files that should only be used when passing -source 1.9 or higher
Colin Cross27b922f2019-03-04 22:35:41 -0800209 Srcs []string `android:"path"`
Colin Cross1369cdb2017-09-29 17:58:17 -0700210
Colin Cross6cef4812019-10-17 14:23:50 -0700211 // List of javac flags that should only be used when passing -source 1.9 or higher
Colin Cross1369cdb2017-09-29 17:58:17 -0700212 Javacflags []string
213 }
Colin Crosscb933592017-11-22 13:49:43 -0800214
Colin Cross81440082018-08-15 20:21:55 -0700215 // When compiling language level 9+ .java code in packages that are part of
216 // a system module, patch_module names the module that your sources and
217 // dependencies should be patched into. The Android runtime currently
218 // doesn't implement the JEP 261 module system so this option is only
219 // supported at compile time. It should only be needed to compile tests in
220 // packages that exist in libcore and which are inconvenient to move
221 // elsewhere.
Tobias Thiererdda713d2018-09-19 16:16:19 +0100222 Patch_module *string `android:"arch_variant"`
Colin Cross81440082018-08-15 20:21:55 -0700223
Colin Crosscb933592017-11-22 13:49:43 -0800224 Jacoco struct {
225 // List of classes to include for instrumentation with jacoco to collect coverage
226 // information at runtime when building with coverage enabled. If unset defaults to all
227 // classes.
228 // Supports '*' as the last character of an entry in the list as a wildcard match.
229 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
230 // it matches classes in the package that have the class name as a prefix.
231 Include_filter []string
232
233 // List of classes to exclude from instrumentation with jacoco to collect coverage
234 // information at runtime when building with coverage enabled. Overrides classes selected
235 // by the include_filter property.
236 // Supports '*' as the last character of an entry in the list as a wildcard match.
237 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
238 // it matches classes in the package that have the class name as a prefix.
239 Exclude_filter []string
240 }
241
Andreas Gampef3e5b552018-01-22 21:27:21 -0800242 Errorprone struct {
243 // List of javac flags that should only be used when running errorprone.
244 Javacflags []string
245 }
246
Colin Cross0f2ee152017-12-14 15:22:43 -0800247 Proto struct {
248 // List of extra options that will be passed to the proto generator.
249 Output_params []string
250 }
251
Colin Crosscb933592017-11-22 13:49:43 -0800252 Instrument bool `blueprint:"mutated"`
Alex Light7f004a72019-02-21 13:27:37 -0800253
254 // List of files to include in the META-INF/services folder of the resulting jar.
Colin Cross27b922f2019-03-04 22:35:41 -0800255 Services []string `android:"path,arch_variant"`
Colin Crossaaf58062020-06-18 15:52:01 -0700256
257 // If true, package the kotlin stdlib into the jar. Defaults to true.
258 Static_kotlin_stdlib *bool `android:"arch_variant"`
Colin Cross540eff82017-06-22 17:01:52 -0700259}
260
Colin Cross89536d42017-07-07 14:35:50 -0700261type CompilerDeviceProperties struct {
Colin Cross540eff82017-06-22 17:01:52 -0700262 // list of module-specific flags that will be used for dex compiles
263 Dxflags []string `android:"arch_variant"`
264
Jeongik Cha538c0d02019-07-11 15:54:27 +0900265 // if not blank, set to the version of the sdk to compile against.
266 // Defaults to compiling against the current platform.
Nan Zhangea568a42017-11-08 21:20:04 -0800267 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700268
Colin Cross83bb3162018-06-25 15:48:06 -0700269 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
270 // Defaults to sdk_version if not set.
271 Min_sdk_version *string
272
Dan Willemsen419290a2018-10-31 15:28:47 -0700273 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
274 // Defaults to sdk_version if not set.
275 Target_sdk_version *string
276
Jeongik Cha356dac42019-08-19 14:09:52 +0900277 // Whether to compile against the platform APIs instead of an SDK.
278 // If true, then sdk_version must be empty. The value of this field
279 // is ignored when module's type isn't android_app.
Colin Cross6af2e492018-05-22 11:12:33 -0700280 Platform_apis *bool
281
Colin Crossebe1a512017-11-14 13:12:14 -0800282 Aidl struct {
283 // Top level directories to pass to aidl tool
284 Include_dirs []string
Colin Cross7d5136f2015-05-11 13:39:40 -0700285
Colin Crossebe1a512017-11-14 13:12:14 -0800286 // Directories rooted at the Android.bp file to pass to aidl tool
287 Local_include_dirs []string
288
289 // directories that should be added as include directories for any aidl sources of modules
290 // that depend on this module, as well as to aidl for this module.
291 Export_include_dirs []string
Martijn Coeneneab15642018-03-09 09:29:59 +0100292
293 // whether to generate traces (for systrace) for this interface
294 Generate_traces *bool
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100295
296 // whether to generate Binder#GetTransaction name method.
297 Generate_get_transaction_name *bool
Colin Crossebe1a512017-11-14 13:12:14 -0800298 }
Colin Cross92430102017-10-09 14:59:32 -0700299
300 // If true, export a copy of the module as a -hostdex module for host testing.
301 Hostdex *bool
Colin Cross1369cdb2017-09-29 17:58:17 -0700302
Colin Cross7f87f4f2019-04-24 13:41:45 -0700303 Target struct {
304 Hostdex struct {
305 // Additional required dependencies to add to -hostdex modules.
306 Required []string
307 }
308 }
309
David Brazdil17ef5632018-06-27 10:27:45 +0100310 // If set to true, compile dex regardless of installable. Defaults to false.
311 Compile_dex *bool
312
Colin Cross66dbc0b2017-12-28 12:23:20 -0800313 Optimize struct {
Colin Crossae5caf52018-05-22 11:11:52 -0700314 // If false, disable all optimization. Defaults to true for android_app and android_test
315 // modules, false for java_library and java_test modules.
Colin Cross66dbc0b2017-12-28 12:23:20 -0800316 Enabled *bool
Sasha Smundak2057f822019-04-16 17:16:58 -0700317 // True if the module containing this has it set by default.
318 EnabledByDefault bool `blueprint:"mutated"`
Colin Cross66dbc0b2017-12-28 12:23:20 -0800319
320 // If true, optimize for size by removing unused code. Defaults to true for apps,
321 // false for libraries and tests.
322 Shrink *bool
323
324 // If true, optimize bytecode. Defaults to false.
325 Optimize *bool
326
327 // If true, obfuscate bytecode. Defaults to false.
328 Obfuscate *bool
329
330 // If true, do not use the flag files generated by aapt that automatically keep
331 // classes referenced by the app manifest. Defaults to false.
332 No_aapt_flags *bool
333
334 // Flags to pass to proguard.
335 Proguard_flags []string
336
337 // Specifies the locations of files containing proguard flags.
Colin Cross27b922f2019-03-04 22:35:41 -0800338 Proguard_flags_files []string `android:"path"`
Colin Cross66dbc0b2017-12-28 12:23:20 -0800339 }
340
Paul Duffine25c6442019-10-11 13:50:28 +0100341 // When targeting 1.9 and above, override the modules to use with --system,
342 // otherwise provides defaults libraries to add to the bootclasspath.
Colin Cross1369cdb2017-09-29 17:58:17 -0700343 System_modules *string
Colin Cross5a0dcd52018-10-05 14:20:06 -0700344
Jiyong Park4c4c0242019-10-21 14:53:15 +0900345 // set the name of the output
346 Stem *string
347
David Srbecky98c71222020-05-20 22:20:28 +0100348 // Keep the data uncompressed. We always need uncompressed dex for execution,
349 // so this might actually save space by avoiding storing the same data twice.
350 // This defaults to reasonable value based on module and should not be set.
351 // It exists only to support ART tests.
352 Uncompress_dex *bool
353
354 IsSDKLibrary bool `blueprint:"mutated"`
Songchun Fan688de9a2020-03-24 20:32:24 -0700355
356 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
357 // Defaults to false.
358 V4_signature *bool
Colin Cross7d5136f2015-05-11 13:39:40 -0700359}
360
Sasha Smundak2057f822019-04-16 17:16:58 -0700361func (me *CompilerDeviceProperties) EffectiveOptimizeEnabled() bool {
362 return BoolDefault(me.Optimize.Enabled, me.Optimize.EnabledByDefault)
363}
364
Paul Duffinc8f2f182020-05-17 08:34:50 +0100365// Functionality common to Module and Import
Paul Duffin64e61992020-05-15 10:20:31 +0100366//
367// It is embedded in Module so its functionality can be used by methods in Module
368// but it is currently only initialized by Import and Library.
Paul Duffinc8f2f182020-05-17 08:34:50 +0100369type embeddableInModuleAndImport struct {
Paul Duffin64e61992020-05-15 10:20:31 +0100370
371 // Functionality related to this being used as a component of a java_sdk_library.
372 EmbeddableSdkLibraryComponent
373}
374
375func (e *embeddableInModuleAndImport) initModuleAndImport(moduleBase *android.ModuleBase) {
376 e.initSdkLibraryComponent(moduleBase)
Paul Duffinc8f2f182020-05-17 08:34:50 +0100377}
378
379// Module/Import's DepIsInSameApex(...) delegates to this method.
380//
381// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
382// the one provided by ApexModuleBase.
383func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
384 // dependencies other than the static linkage are all considered crossing APEX boundary
385 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
386 return true
387 }
388 return false
389}
390
Colin Cross46c9b8b2017-06-22 16:51:17 -0700391// Module contains the properties and members used by all java module types
392type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700393 android.ModuleBase
Colin Cross89536d42017-07-07 14:35:50 -0700394 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +0900395 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900396 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -0700397
Paul Duffinc8f2f182020-05-17 08:34:50 +0100398 // Functionality common to Module and Import.
399 embeddableInModuleAndImport
400
Colin Cross89536d42017-07-07 14:35:50 -0700401 properties CompilerProperties
Colin Cross6af17aa2017-09-20 12:59:05 -0700402 protoProperties android.ProtoProperties
Colin Cross89536d42017-07-07 14:35:50 -0700403 deviceProperties CompilerDeviceProperties
Colin Cross2fe66872015-03-30 17:20:39 -0700404
Colin Cross331a1212018-08-15 20:40:52 -0700405 // jar file containing header classes including static library dependencies, suitable for
406 // inserting into the bootclasspath/classpath of another compile
Nan Zhanged19fc32017-10-19 13:06:22 -0700407 headerJarFile android.Path
408
Colin Cross331a1212018-08-15 20:40:52 -0700409 // jar file containing implementation classes including static library dependencies but no
410 // resources
Nan Zhanged19fc32017-10-19 13:06:22 -0700411 implementationJarFile android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700412
Colin Cross331a1212018-08-15 20:40:52 -0700413 // jar file containing only resources including from static library dependencies
414 resourceJar android.Path
415
Colin Cross0c4ce212019-05-03 15:28:19 -0700416 // args and dependencies to package source files into a srcjar
417 srcJarArgs []string
418 srcJarDeps android.Paths
419
Colin Cross331a1212018-08-15 20:40:52 -0700420 // jar file containing implementation classes and resources including static library
421 // dependencies
422 implementationAndResourcesJar android.Path
423
424 // output file containing classes.dex and resources
Colin Cross6ade34f2017-09-15 13:00:47 -0700425 dexJarFile android.Path
426
Colin Cross43f08db2018-11-12 10:13:39 -0800427 // output file that contains classes.dex if it should be in the output file
428 maybeStrippedDexJarFile android.Path
429
Colin Crosscb933592017-11-22 13:49:43 -0800430 // output file containing uninstrumented classes that will be instrumented by jacoco
431 jacocoReportClassesFile android.Path
432
Colin Cross66dbc0b2017-12-28 12:23:20 -0800433 // output file containing mapping of obfuscated names
434 proguardDictionary android.Path
435
Colin Cross331a1212018-08-15 20:40:52 -0700436 // output file of the module, which may be a classes jar or a dex jar
Colin Crosse560c4a2019-03-19 16:03:11 -0700437 outputFile android.Path
438 extraOutputFiles android.Paths
Colin Crossb7a63242015-04-16 14:09:14 -0700439
Colin Cross635c3b02016-05-18 15:37:25 -0700440 exportAidlIncludeDirs android.Paths
Colin Crossc0b06f12015-04-08 13:03:43 -0700441
Colin Cross635c3b02016-05-18 15:37:25 -0700442 logtagsSrcs android.Paths
Colin Crossf05fe972015-04-10 17:45:20 -0700443
Colin Cross2fe66872015-03-30 17:20:39 -0700444 // installed file for binary dependency
Colin Cross635c3b02016-05-18 15:37:25 -0700445 installFile android.Path
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800446
447 // list of .java files and srcjars that was passed to javac
448 compiledJavaSrcs android.Paths
449 compiledSrcJars android.Paths
Colin Cross66dbc0b2017-12-28 12:23:20 -0800450
451 // list of extra progurad flag files
452 extraProguardFlagFiles android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900453
Colin Cross094054a2018-10-17 15:10:48 -0700454 // manifest file to use instead of properties.Manifest
455 overrideManifest android.OptionalPath
456
Artur Satayev9cf46692019-11-26 18:08:34 +0000457 // list of SDK lib names that this java module is exporting
Jiyong Park1be96912018-05-28 18:02:19 +0900458 exportedSdkLibs []string
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700459
Artur Satayev9cf46692019-11-26 18:08:34 +0000460 // list of plugins that this java module is exporting
461 exportedPluginJars android.Paths
462
463 // list of plugins that this java module is exporting
464 exportedPluginClasses []string
465
466 // list of source files, collected from srcFiles with unique java and all kt files,
patricktu242faad2019-09-24 15:41:30 +0800467 // will be used by android.IDEInfo struct
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700468 expandIDEInfoCompiledSrcs []string
Colin Cross43f08db2018-11-12 10:13:39 -0800469
Steven Morelandc4efd9c2019-01-18 11:51:25 -0800470 // expanded Jarjar_rules
471 expandJarjarRules android.Path
472
Tej Singh83839722020-06-03 18:45:54 +0000473 // list of additional targets for checkbuild
474 additionalCheckedModules android.Paths
475
Colin Cross988708c2019-05-06 14:04:11 -0700476 // Extra files generated by the module type to be added as java resources.
477 extraResources android.Paths
478
Colin Crossf24a22a2019-01-31 14:12:44 -0800479 hiddenAPI
Colin Cross43f08db2018-11-12 10:13:39 -0800480 dexpreopter
Colin Cross1e28e3c2020-06-02 20:09:13 -0700481 linter
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800482
483 // list of the xref extraction files
484 kytheFiles android.Paths
Anton Hansson1e65f942020-03-27 19:39:48 +0000485
486 distFile android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700487}
488
Colin Cross1c14b4e2020-06-15 16:09:53 -0700489func (j *Module) addHostProperties() {
490 j.AddProperties(
491 &j.properties,
492 &j.protoProperties,
493 )
494}
495
496func (j *Module) addHostAndDeviceProperties() {
497 j.addHostProperties()
498 j.AddProperties(
499 &j.deviceProperties,
500 &j.dexpreoptProperties,
Colin Cross1e28e3c2020-06-02 20:09:13 -0700501 &j.linter.properties,
Colin Cross1c14b4e2020-06-15 16:09:53 -0700502 )
503}
504
Colin Cross41955e82019-05-29 14:40:35 -0700505func (j *Module) OutputFiles(tag string) (android.Paths, error) {
506 switch tag {
507 case "":
508 return append(android.Paths{j.outputFile}, j.extraOutputFiles...), nil
Colin Cross375ca3c2019-05-29 14:40:58 -0700509 case ".jar":
510 return android.Paths{j.implementationAndResourcesJar}, nil
Colin Cross2d975b12019-07-29 16:47:42 -0700511 case ".proguard_map":
512 return android.Paths{j.proguardDictionary}, nil
Colin Cross41955e82019-05-29 14:40:35 -0700513 default:
514 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
515 }
Colin Cross54250902017-12-05 09:28:08 -0800516}
517
Colin Cross41955e82019-05-29 14:40:35 -0700518var _ android.OutputFileProducer = (*Module)(nil)
Colin Cross54250902017-12-05 09:28:08 -0800519
Colin Crossf506d872017-07-19 15:53:04 -0700520type Dependency interface {
Nan Zhanged19fc32017-10-19 13:06:22 -0700521 HeaderJars() android.Paths
522 ImplementationJars() android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700523 ResourceJars() android.Paths
524 ImplementationAndResourcesJars() android.Paths
Colin Crossf24a22a2019-01-31 14:12:44 -0800525 DexJar() android.Path
Colin Cross635c3b02016-05-18 15:37:25 -0700526 AidlIncludeDirs() android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900527 ExportedSdkLibs() []string
Artur Satayev9cf46692019-11-26 18:08:34 +0000528 ExportedPlugins() (android.Paths, []string)
Colin Cross0c4ce212019-05-03 15:28:19 -0700529 SrcJarArgs() ([]string, android.Paths)
Colin Crosse323f3c2019-09-17 15:34:09 -0700530 BaseModuleName() string
Jiyong Park618922e2020-01-08 13:35:43 +0900531 JacocoReportClassesFile() android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700532}
533
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800534type xref interface {
535 XrefJavaFiles() android.Paths
536}
537
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800538func (j *Module) XrefJavaFiles() android.Paths {
539 return j.kytheFiles
540}
541
Colin Cross89536d42017-07-07 14:35:50 -0700542func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
543 android.InitAndroidArchModule(module, hod, android.MultilibCommon)
544 android.InitDefaultableModule(module)
545}
546
Colin Crossbe1da472017-07-07 15:59:46 -0700547type dependencyTag struct {
548 blueprint.BaseDependencyTag
549 name string
Colin Cross2fe66872015-03-30 17:20:39 -0700550}
551
Colin Crossa4f08812018-10-02 22:03:40 -0700552type jniDependencyTag struct {
553 blueprint.BaseDependencyTag
Colin Crossa4f08812018-10-02 22:03:40 -0700554}
555
Jiyong Park8be103b2019-11-08 15:53:48 +0900556func IsJniDepTag(depTag blueprint.DependencyTag) bool {
557 _, ok := depTag.(*jniDependencyTag)
558 return ok
559}
560
Colin Crossbe1da472017-07-07 15:59:46 -0700561var (
Colin Cross4b964c02018-10-15 16:18:06 -0700562 staticLibTag = dependencyTag{name: "staticlib"}
563 libTag = dependencyTag{name: "javalib"}
Colin Cross6cef4812019-10-17 14:23:50 -0700564 java9LibTag = dependencyTag{name: "java9lib"}
Colin Crossbe9cdb82019-01-21 21:37:16 -0800565 pluginTag = dependencyTag{name: "plugin"}
Artur Satayev9cf46692019-11-26 18:08:34 +0000566 exportedPluginTag = dependencyTag{name: "exported-plugin"}
Colin Cross4b964c02018-10-15 16:18:06 -0700567 bootClasspathTag = dependencyTag{name: "bootclasspath"}
568 systemModulesTag = dependencyTag{name: "system modules"}
569 frameworkResTag = dependencyTag{name: "framework-res"}
570 frameworkApkTag = dependencyTag{name: "framework-apk"}
571 kotlinStdlibTag = dependencyTag{name: "kotlin-stdlib"}
Colin Crossafbb1732019-01-17 15:42:52 -0800572 kotlinAnnotationsTag = dependencyTag{name: "kotlin-annotations"}
Colin Cross4b964c02018-10-15 16:18:06 -0700573 proguardRaiseTag = dependencyTag{name: "proguard-raise"}
574 certificateTag = dependencyTag{name: "certificate"}
575 instrumentationForTag = dependencyTag{name: "instrumentation_for"}
Colin Cross50ddcc42019-05-16 12:28:22 -0700576 usesLibTag = dependencyTag{name: "uses-library"}
Colin Cross205a5042020-06-18 15:56:48 -0700577 extraLintCheckTag = dependencyTag{name: "extra-lint-check"}
Colin Crossbe1da472017-07-07 15:59:46 -0700578)
Colin Cross2fe66872015-03-30 17:20:39 -0700579
Jiyong Park83dc74b2020-01-14 18:38:44 +0900580func IsLibDepTag(depTag blueprint.DependencyTag) bool {
581 return depTag == libTag
582}
583
584func IsStaticLibDepTag(depTag blueprint.DependencyTag) bool {
585 return depTag == staticLibTag
586}
587
Colin Crossfc3674a2017-09-18 17:41:52 -0700588type sdkDep struct {
Colin Cross47ff2522017-10-02 14:22:08 -0700589 useModule, useFiles, useDefaultLibs, invalidVersion bool
590
Colin Cross6cef4812019-10-17 14:23:50 -0700591 // The modules that will be added to the bootclasspath when targeting 1.8 or lower
592 bootclasspath []string
Paul Duffine25c6442019-10-11 13:50:28 +0100593
594 // The default system modules to use. Will be an empty string if no system
595 // modules are to be used.
Colin Cross1369cdb2017-09-29 17:58:17 -0700596 systemModules string
597
Colin Cross6cef4812019-10-17 14:23:50 -0700598 // The modules that will be added ot the classpath when targeting 1.9 or higher
599 java9Classpath []string
600
Colin Crossa97c5d32018-03-28 14:58:31 -0700601 frameworkResModule string
602
Colin Cross86a60ae2018-05-29 14:44:55 -0700603 jars android.Paths
Colin Cross3047fa22019-04-18 10:56:44 -0700604 aidl android.OptionalPath
Paul Duffin250e6192019-06-07 10:44:37 +0100605
606 noStandardLibs, noFrameworksLibs bool
607}
608
609func (s sdkDep) hasStandardLibs() bool {
610 return !s.noStandardLibs
611}
612
613func (s sdkDep) hasFrameworkLibs() bool {
614 return !s.noStandardLibs && !s.noFrameworksLibs
Colin Cross1369cdb2017-09-29 17:58:17 -0700615}
616
Colin Crossa4f08812018-10-02 22:03:40 -0700617type jniLib struct {
Jaewoong Jung37ca4a12020-03-26 14:01:48 -0700618 name string
619 path android.Path
620 target android.Target
621 coverageFile android.OptionalPath
Colin Crossa4f08812018-10-02 22:03:40 -0700622}
623
Colin Cross0ea8ba82019-06-06 14:33:29 -0700624func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800625 return j.properties.Instrument && ctx.Config().IsEnvTrue("EMMA_INSTRUMENT")
626}
627
Colin Cross0ea8ba82019-06-06 14:33:29 -0700628func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800629 return j.shouldInstrument(ctx) &&
630 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
631 ctx.Config().UnbundledBuild())
632}
633
Jiyong Park6a927c42020-01-21 02:03:43 +0900634func (j *Module) sdkVersion() sdkSpec {
635 return sdkSpecFrom(String(j.deviceProperties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -0700636}
637
Paul Duffine25c6442019-10-11 13:50:28 +0100638func (j *Module) systemModules() string {
639 return proptools.String(j.deviceProperties.System_modules)
640}
641
Jiyong Park6a927c42020-01-21 02:03:43 +0900642func (j *Module) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -0700643 if j.deviceProperties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900644 return sdkSpecFrom(*j.deviceProperties.Min_sdk_version)
Colin Cross83bb3162018-06-25 15:48:06 -0700645 }
646 return j.sdkVersion()
647}
648
Jiyong Park6a927c42020-01-21 02:03:43 +0900649func (j *Module) targetSdkVersion() sdkSpec {
Dan Willemsen419290a2018-10-31 15:28:47 -0700650 if j.deviceProperties.Target_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900651 return sdkSpecFrom(*j.deviceProperties.Target_sdk_version)
Dan Willemsen419290a2018-10-31 15:28:47 -0700652 }
653 return j.sdkVersion()
654}
655
Artur Satayev388d39b2020-04-27 18:53:18 +0100656func (j *Module) MinSdkVersion() string {
657 return j.minSdkVersion().version.String()
658}
659
Jiyong Parkb02bb402019-12-03 00:43:57 +0900660func (j *Module) AvailableFor(what string) bool {
661 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
662 // Exception: for hostdex: true libraries, the platform variant is created
663 // even if it's not marked as available to platform. In that case, the platform
664 // variant is used only for the hostdex and not installed to the device.
665 return true
666 }
667 return j.ApexModuleBase.AvailableFor(what)
668}
669
Colin Crossbe1da472017-07-07 15:59:46 -0700670func (j *Module) deps(ctx android.BottomUpMutatorContext) {
Colin Cross1369cdb2017-09-29 17:58:17 -0700671 if ctx.Device() {
Colin Cross205a5042020-06-18 15:56:48 -0700672 j.linter.deps(ctx)
673
Paul Duffin250e6192019-06-07 10:44:37 +0100674 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross6d8d8c62019-10-28 15:10:03 -0700675 if sdkDep.useDefaultLibs {
676 ctx.AddVariationDependencies(nil, bootClasspathTag, config.DefaultBootclasspathLibraries...)
677 ctx.AddVariationDependencies(nil, systemModulesTag, config.DefaultSystemModules)
678 if sdkDep.hasFrameworkLibs() {
679 ctx.AddVariationDependencies(nil, libTag, config.DefaultLibraries...)
Colin Crossbe1da472017-07-07 15:59:46 -0700680 }
Colin Cross6d8d8c62019-10-28 15:10:03 -0700681 } else if sdkDep.useModule {
Colin Cross6cef4812019-10-17 14:23:50 -0700682 ctx.AddVariationDependencies(nil, bootClasspathTag, sdkDep.bootclasspath...)
Colin Cross6cef4812019-10-17 14:23:50 -0700683 ctx.AddVariationDependencies(nil, java9LibTag, sdkDep.java9Classpath...)
Colin Cross6d8d8c62019-10-28 15:10:03 -0700684 if j.deviceProperties.EffectiveOptimizeEnabled() && sdkDep.hasStandardLibs() {
685 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultBootclasspathLibraries...)
686 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultLibraries...)
687 }
Colin Cross2fe66872015-03-30 17:20:39 -0700688 }
Colin Crossdb224752020-05-14 18:05:32 -0700689 if sdkDep.systemModules != "" {
690 ctx.AddVariationDependencies(nil, systemModulesTag, sdkDep.systemModules)
691 }
Colin Cross6d8d8c62019-10-28 15:10:03 -0700692
Nan Zhangb2b33de2018-02-23 11:18:47 -0800693 if ctx.ModuleName() == "android_stubs_current" ||
694 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -0700695 ctx.ModuleName() == "android_test_stubs_current" {
Colin Cross42d48b72018-08-29 14:10:52 -0700696 ctx.AddVariationDependencies(nil, frameworkApkTag, "framework-res")
Nan Zhangb2b33de2018-02-23 11:18:47 -0800697 }
Colin Cross2fe66872015-03-30 17:20:39 -0700698 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700699
Inseob Kimac1e9862019-12-09 18:15:47 +0900700 syspropPublicStubs := syspropPublicStubs(ctx.Config())
701
702 // rewriteSyspropLibs validates if a java module can link against platform's sysprop_library,
703 // and redirects dependency to public stub depending on the link type.
704 rewriteSyspropLibs := func(libs []string, prop string) []string {
705 // make a copy
706 ret := android.CopyOf(libs)
707
708 for idx, lib := range libs {
709 stub, ok := syspropPublicStubs[lib]
710
711 if !ok {
712 continue
713 }
714
715 linkType, _ := j.getLinkType(ctx.ModuleName())
Inseob Kimc5239512020-01-14 15:36:21 +0900716 // only platform modules can use internal props
717 if linkType != javaPlatform {
Inseob Kimac1e9862019-12-09 18:15:47 +0900718 ret[idx] = stub
Inseob Kimac1e9862019-12-09 18:15:47 +0900719 }
720 }
721
722 return ret
723 }
724
725 ctx.AddVariationDependencies(nil, libTag, rewriteSyspropLibs(j.properties.Libs, "libs")...)
726 ctx.AddVariationDependencies(nil, staticLibTag, rewriteSyspropLibs(j.properties.Static_libs, "static_libs")...)
Colin Crossa4f08812018-10-02 22:03:40 -0700727
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700728 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000729 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800730
Colin Crossfe17f6f2019-03-28 19:30:56 -0700731 android.ProtoDeps(ctx, &j.protoProperties)
Colin Cross6af17aa2017-09-20 12:59:05 -0700732 if j.hasSrcExt(".proto") {
733 protoDeps(ctx, &j.protoProperties)
734 }
Colin Cross93e85952017-08-15 13:34:18 -0700735
736 if j.hasSrcExt(".kt") {
737 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
738 // Kotlin files
Colin Cross0b03d972019-05-13 11:06:25 -0700739 ctx.AddVariationDependencies(nil, kotlinStdlibTag,
740 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8")
Colin Cross7788c122019-01-23 16:14:02 -0800741 if len(j.properties.Plugins) > 0 {
Colin Crossafbb1732019-01-17 15:42:52 -0800742 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
743 }
Colin Cross93e85952017-08-15 13:34:18 -0700744 }
Colin Cross3144dfc2018-01-03 15:06:47 -0800745
Ulya Trafimovich38dfa0f2020-01-07 16:37:02 +0000746 // Framework libraries need special handling in static coverage builds: they should not have
747 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
748 // the same jacoco classes coming from different bootclasspath jars.
749 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
750 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
751 j.properties.Instrument = true
752 }
753 } else if j.shouldInstrumentStatic(ctx) {
Colin Cross42d48b72018-08-29 14:10:52 -0700754 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
Colin Cross3144dfc2018-01-03 15:06:47 -0800755 }
Colin Cross6af17aa2017-09-20 12:59:05 -0700756}
757
758func hasSrcExt(srcs []string, ext string) bool {
759 for _, src := range srcs {
760 if filepath.Ext(src) == ext {
761 return true
762 }
763 }
764
765 return false
766}
767
768func (j *Module) hasSrcExt(ext string) bool {
769 return hasSrcExt(j.properties.Srcs, ext)
Colin Cross2fe66872015-03-30 17:20:39 -0700770}
771
Colin Cross46c9b8b2017-06-22 16:51:17 -0700772func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Colin Cross3047fa22019-04-18 10:56:44 -0700773 aidlIncludeDirs android.Paths) (string, android.Paths) {
Colin Crossc0b06f12015-04-08 13:03:43 -0700774
Colin Crossebe1a512017-11-14 13:12:14 -0800775 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
776 aidlIncludes = append(aidlIncludes,
777 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
778 aidlIncludes = append(aidlIncludes,
779 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
Colin Crossc0b06f12015-04-08 13:03:43 -0700780
Colin Cross3047fa22019-04-18 10:56:44 -0700781 var flags []string
782 var deps android.Paths
Steven Moreland667f6882018-07-26 12:55:08 -0700783
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700784 if aidlPreprocess.Valid() {
785 flags = append(flags, "-p"+aidlPreprocess.String())
Colin Cross3047fa22019-04-18 10:56:44 -0700786 deps = append(deps, aidlPreprocess.Path())
787 } else if len(aidlIncludeDirs) > 0 {
Colin Cross635c3b02016-05-18 15:37:25 -0700788 flags = append(flags, android.JoinWithPrefix(aidlIncludeDirs.Strings(), "-I"))
Colin Crossc0b06f12015-04-08 13:03:43 -0700789 }
790
Colin Cross3047fa22019-04-18 10:56:44 -0700791 if len(j.exportAidlIncludeDirs) > 0 {
792 flags = append(flags, android.JoinWithPrefix(j.exportAidlIncludeDirs.Strings(), "-I"))
793 }
794
795 if len(aidlIncludes) > 0 {
796 flags = append(flags, android.JoinWithPrefix(aidlIncludes.Strings(), "-I"))
797 }
798
Colin Cross635c3b02016-05-18 15:37:25 -0700799 flags = append(flags, "-I"+android.PathForModuleSrc(ctx).String())
Colin Cross32f38982018-02-22 11:47:25 -0800800 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Colin Crossd48633a2017-07-13 14:41:17 -0700801 flags = append(flags, "-I"+src.String())
802 }
Colin Crossc0b06f12015-04-08 13:03:43 -0700803
Martijn Coeneneab15642018-03-09 09:29:59 +0100804 if Bool(j.deviceProperties.Aidl.Generate_traces) {
805 flags = append(flags, "-t")
806 }
807
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100808 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
809 flags = append(flags, "--transaction_names")
810 }
811
Colin Cross3047fa22019-04-18 10:56:44 -0700812 return strings.Join(flags, " "), deps
Colin Crossc0b06f12015-04-08 13:03:43 -0700813}
814
Colin Cross32f676a2017-09-06 13:41:06 -0700815type deps struct {
Nan Zhang581fd212018-01-10 16:06:12 -0800816 classpath classpath
Colin Cross6cef4812019-10-17 14:23:50 -0700817 java9Classpath classpath
Nan Zhang581fd212018-01-10 16:06:12 -0800818 bootClasspath classpath
Colin Cross6a77c982018-06-19 22:43:34 -0700819 processorPath classpath
Colin Crossbe9cdb82019-01-21 21:37:16 -0800820 processorClasses []string
Colin Cross6ade34f2017-09-15 13:00:47 -0700821 staticJars android.Paths
Nan Zhanged19fc32017-10-19 13:06:22 -0700822 staticHeaderJars android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700823 staticResourceJars android.Paths
Colin Cross6ade34f2017-09-15 13:00:47 -0700824 aidlIncludeDirs android.Paths
Nan Zhangb2b33de2018-02-23 11:18:47 -0800825 srcs android.Paths
Colin Cross59149b62017-10-16 18:07:29 -0700826 srcJars android.Paths
Colin Crossb77043e2019-07-16 13:57:13 -0700827 systemModules *systemModules
Colin Cross6ade34f2017-09-15 13:00:47 -0700828 aidlPreprocess android.OptionalPath
Colin Cross93e85952017-08-15 13:34:18 -0700829 kotlinStdlib android.Paths
Colin Crossafbb1732019-01-17 15:42:52 -0800830 kotlinAnnotations android.Paths
Colin Crossbe9cdb82019-01-21 21:37:16 -0800831
832 disableTurbine bool
Colin Cross32f676a2017-09-06 13:41:06 -0700833}
Colin Cross2fe66872015-03-30 17:20:39 -0700834
Colin Cross54250902017-12-05 09:28:08 -0800835func checkProducesJars(ctx android.ModuleContext, dep android.SourceFileProducer) {
836 for _, f := range dep.Srcs() {
837 if f.Ext() != ".jar" {
838 ctx.ModuleErrorf("genrule %q must generate files ending with .jar to be used as a libs or static_libs dependency",
839 ctx.OtherModuleName(dep.(blueprint.Module)))
840 }
841 }
842}
843
Jiyong Park2d492942018-03-05 17:44:10 +0900844type linkType int
845
846const (
Jiyong Park50146e92020-01-30 18:00:15 +0900847 // TODO(jiyong) rename these for better readability. Make the allowed
848 // and disallowed link types explicit
Jiyong Park2d492942018-03-05 17:44:10 +0900849 javaCore linkType = iota
850 javaSdk
851 javaSystem
Jiyong Park50146e92020-01-30 18:00:15 +0900852 javaModule
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900853 javaSystemServer
Jiyong Park2d492942018-03-05 17:44:10 +0900854 javaPlatform
855)
856
Jeongik Cha75b83b02019-11-01 15:28:00 +0900857type linkTypeContext interface {
858 android.Module
859 getLinkType(name string) (ret linkType, stubs bool)
860}
861
862func (m *Module) getLinkType(name string) (ret linkType, stubs bool) {
Anton Hanssonac103462020-05-19 12:06:48 +0100863 switch name {
864 case "core.current.stubs", "core.platform.api.stubs", "stub-annotations",
865 "private-stub-annotations-jar", "core-lambda-stubs", "core-generated-annotation-stubs":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900866 return javaCore, true
Anton Hanssonac103462020-05-19 12:06:48 +0100867 case "android_stubs_current":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900868 return javaSdk, true
Anton Hanssonac103462020-05-19 12:06:48 +0100869 case "android_system_stubs_current":
870 return javaSystem, true
871 case "android_module_lib_stubs_current":
Jiyong Park50146e92020-01-30 18:00:15 +0900872 return javaModule, true
Anton Hanssonac103462020-05-19 12:06:48 +0100873 case "android_system_server_stubs_current":
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900874 return javaSystemServer, true
Anton Hanssonac103462020-05-19 12:06:48 +0100875 case "android_test_stubs_current":
876 return javaSystem, true
Jiyong Park2d492942018-03-05 17:44:10 +0900877 }
Anton Hanssonac103462020-05-19 12:06:48 +0100878
Anton Hansson0bd88d02020-05-25 12:20:51 +0100879 if stub, linkType := moduleStubLinkType(name); stub {
880 return linkType, true
881 }
882
Anton Hanssonac103462020-05-19 12:06:48 +0100883 ver := m.sdkVersion()
884 switch ver.kind {
885 case sdkCore:
886 return javaCore, false
887 case sdkSystem:
888 return javaSystem, false
889 case sdkPublic:
890 return javaSdk, false
891 case sdkModule:
892 return javaModule, false
893 case sdkSystemServer:
894 return javaSystemServer, false
895 case sdkPrivate, sdkNone, sdkCorePlatform, sdkTest:
896 return javaPlatform, false
897 }
898
899 if !ver.valid() {
900 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.raw))
901 }
902 return javaSdk, false
Jiyong Park2d492942018-03-05 17:44:10 +0900903}
904
Jeongik Cha75b83b02019-11-01 15:28:00 +0900905func checkLinkType(ctx android.ModuleContext, from *Module, to linkTypeContext, tag dependencyTag) {
Colin Crossf19b9bb2018-03-26 14:42:44 -0700906 if ctx.Host() {
907 return
908 }
909
Jeongik Cha75b83b02019-11-01 15:28:00 +0900910 myLinkType, stubs := from.getLinkType(ctx.ModuleName())
Jiyong Park46f78fb2018-10-20 16:33:17 +0900911 if stubs {
912 return
913 }
Jeongik Cha75b83b02019-11-01 15:28:00 +0900914 otherLinkType, _ := to.getLinkType(ctx.OtherModuleName(to))
Jiyong Park2d492942018-03-05 17:44:10 +0900915 commonMessage := "Adjust sdk_version: property of the source or target module so that target module is built with the same or smaller API set than the source."
916
917 switch myLinkType {
918 case javaCore:
919 if otherLinkType != javaCore {
920 ctx.ModuleErrorf("compiles against core Java API, but dependency %q is compiling against non-core Java APIs."+commonMessage,
Jiyong Park750e5572018-01-31 00:20:13 +0900921 ctx.OtherModuleName(to))
922 }
Jiyong Park2d492942018-03-05 17:44:10 +0900923 break
924 case javaSdk:
925 if otherLinkType != javaCore && otherLinkType != javaSdk {
926 ctx.ModuleErrorf("compiles against Android API, but dependency %q is compiling against non-public Android API."+commonMessage,
927 ctx.OtherModuleName(to))
928 }
929 break
930 case javaSystem:
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900931 if otherLinkType == javaPlatform || otherLinkType == javaModule || otherLinkType == javaSystemServer {
Jiyong Park2d492942018-03-05 17:44:10 +0900932 ctx.ModuleErrorf("compiles against system API, but dependency %q is compiling against private API."+commonMessage,
933 ctx.OtherModuleName(to))
934 }
935 break
Jiyong Park50146e92020-01-30 18:00:15 +0900936 case javaModule:
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900937 if otherLinkType == javaPlatform || otherLinkType == javaSystemServer {
Jiyong Park50146e92020-01-30 18:00:15 +0900938 ctx.ModuleErrorf("compiles against module API, but dependency %q is compiling against private API."+commonMessage,
939 ctx.OtherModuleName(to))
940 }
941 break
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900942 case javaSystemServer:
943 if otherLinkType == javaPlatform {
944 ctx.ModuleErrorf("compiles against system server API, but dependency %q is compiling against private API."+commonMessage,
945 ctx.OtherModuleName(to))
946 }
947 break
Jiyong Park2d492942018-03-05 17:44:10 +0900948 case javaPlatform:
949 // no restriction on link-type
950 break
Jiyong Park750e5572018-01-31 00:20:13 +0900951 }
952}
953
Colin Cross32f676a2017-09-06 13:41:06 -0700954func (j *Module) collectDeps(ctx android.ModuleContext) deps {
955 var deps deps
Colin Crossfc3674a2017-09-18 17:41:52 -0700956
Colin Cross300f0382018-03-06 13:11:51 -0800957 if ctx.Device() {
Colin Cross83bb3162018-06-25 15:48:06 -0700958 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross300f0382018-03-06 13:11:51 -0800959 if sdkDep.invalidVersion {
Colin Cross6cef4812019-10-17 14:23:50 -0700960 ctx.AddMissingDependencies(sdkDep.bootclasspath)
961 ctx.AddMissingDependencies(sdkDep.java9Classpath)
Colin Cross300f0382018-03-06 13:11:51 -0800962 } else if sdkDep.useFiles {
963 // sdkDep.jar is actually equivalent to turbine header.jar.
Colin Cross86a60ae2018-05-29 14:44:55 -0700964 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross3047fa22019-04-18 10:56:44 -0700965 deps.aidlPreprocess = sdkDep.aidl
966 } else {
967 deps.aidlPreprocess = sdkDep.aidl
Colin Cross300f0382018-03-06 13:11:51 -0800968 }
Colin Crossfc3674a2017-09-18 17:41:52 -0700969 }
970
Paul Duffin64e61992020-05-15 10:20:31 +0100971 // If this is a component library (stubs, etc.) for a java_sdk_library then
972 // add the name of that java_sdk_library to the exported sdk libs to make sure
973 // that, if necessary, a <uses-library> element for that java_sdk_library is
974 // added to the Android manifest.
975 j.exportedSdkLibs = append(j.exportedSdkLibs, j.OptionalImplicitSdkLibrary()...)
976
Colin Crossd11fcda2017-10-23 17:59:01 -0700977 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross2fe66872015-03-30 17:20:39 -0700978 otherName := ctx.OtherModuleName(module)
Colin Crossec7a0422017-07-07 14:47:12 -0700979 tag := ctx.OtherModuleDependencyTag(module)
980
Colin Crossa4f08812018-10-02 22:03:40 -0700981 if _, ok := tag.(*jniDependencyTag); ok {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700982 // Handled by AndroidApp.collectAppDeps
983 return
984 }
985 if tag == certificateTag {
986 // Handled by AndroidApp.collectAppDeps
Colin Crossa4f08812018-10-02 22:03:40 -0700987 return
988 }
Artur Satayeve5ac15a2020-04-08 19:09:30 +0100989
Colin Cross54250902017-12-05 09:28:08 -0800990 switch dep := module.(type) {
Colin Cross897d2ed2019-02-11 14:03:51 -0800991 case SdkLibraryDependency:
992 switch tag {
993 case libTag:
994 deps.classpath = append(deps.classpath, dep.SdkHeaderJars(ctx, j.sdkVersion())...)
995 // names of sdk libs that are directly depended are exported
Paul Duffin64e61992020-05-15 10:20:31 +0100996 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.OptionalImplicitSdkLibrary()...)
Colin Cross79c7c262019-04-17 11:11:46 -0700997 case staticLibTag:
Colin Cross897d2ed2019-02-11 14:03:51 -0800998 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
999 }
Colin Cross54250902017-12-05 09:28:08 -08001000 case Dependency:
1001 switch tag {
1002 case bootClasspathTag:
1003 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars()...)
Colin Cross4b964c02018-10-15 16:18:06 -07001004 case libTag, instrumentationForTag:
Colin Cross54250902017-12-05 09:28:08 -08001005 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +09001006 // sdk lib names from dependencies are re-exported
1007 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -07001008 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Artur Satayev9cf46692019-11-26 18:08:34 +00001009 pluginJars, pluginClasses := dep.ExportedPlugins()
1010 addPlugins(&deps, pluginJars, pluginClasses...)
Colin Cross6cef4812019-10-17 14:23:50 -07001011 case java9LibTag:
1012 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars()...)
Colin Cross54250902017-12-05 09:28:08 -08001013 case staticLibTag:
1014 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
1015 deps.staticJars = append(deps.staticJars, dep.ImplementationJars()...)
1016 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars()...)
Colin Cross331a1212018-08-15 20:40:52 -07001017 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +09001018 // sdk lib names from dependencies are re-exported
1019 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -07001020 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Artur Satayev9cf46692019-11-26 18:08:34 +00001021 pluginJars, pluginClasses := dep.ExportedPlugins()
1022 addPlugins(&deps, pluginJars, pluginClasses...)
Colin Crossbe9cdb82019-01-21 21:37:16 -08001023 case pluginTag:
1024 if plugin, ok := dep.(*Plugin); ok {
Colin Crossbe9cdb82019-01-21 21:37:16 -08001025 if plugin.pluginProperties.Processor_class != nil {
Artur Satayev9cf46692019-11-26 18:08:34 +00001026 addPlugins(&deps, plugin.ImplementationAndResourcesJars(), *plugin.pluginProperties.Processor_class)
1027 } else {
1028 addPlugins(&deps, plugin.ImplementationAndResourcesJars())
Colin Crossbe9cdb82019-01-21 21:37:16 -08001029 }
1030 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
1031 } else {
1032 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
1033 }
Artur Satayev9cf46692019-11-26 18:08:34 +00001034 case exportedPluginTag:
1035 if plugin, ok := dep.(*Plugin); ok {
1036 if plugin.pluginProperties.Generates_api != nil && *plugin.pluginProperties.Generates_api {
1037 ctx.PropertyErrorf("exported_plugins", "Cannot export plugins with generates_api = true, found %v", otherName)
1038 }
1039 j.exportedPluginJars = append(j.exportedPluginJars, plugin.ImplementationAndResourcesJars()...)
1040 if plugin.pluginProperties.Processor_class != nil {
1041 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
1042 }
1043 } else {
1044 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
1045 }
Nan Zhangb2b33de2018-02-23 11:18:47 -08001046 case frameworkApkTag:
1047 if ctx.ModuleName() == "android_stubs_current" ||
1048 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -07001049 ctx.ModuleName() == "android_test_stubs_current" {
Nan Zhangb2b33de2018-02-23 11:18:47 -08001050 // framework stubs.jar need to depend on framework-res.apk, in order to pull the
1051 // resource files out of there for aapt.
1052 //
1053 // Normally the package rule runs aapt, which includes the resource,
1054 // but we're not running that in our package rule so just copy in the
1055 // resource files here.
Colin Cross331a1212018-08-15 20:40:52 -07001056 deps.staticResourceJars = append(deps.staticResourceJars, dep.(*AndroidApp).exportPackage)
Nan Zhangb2b33de2018-02-23 11:18:47 -08001057 }
Colin Cross54250902017-12-05 09:28:08 -08001058 case kotlinStdlibTag:
Colin Cross0b03d972019-05-13 11:06:25 -07001059 deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars()...)
Colin Crossafbb1732019-01-17 15:42:52 -08001060 case kotlinAnnotationsTag:
1061 deps.kotlinAnnotations = dep.HeaderJars()
Colin Cross54250902017-12-05 09:28:08 -08001062 }
1063
Colin Cross54250902017-12-05 09:28:08 -08001064 case android.SourceFileProducer:
1065 switch tag {
1066 case libTag:
1067 checkProducesJars(ctx, dep)
1068 deps.classpath = append(deps.classpath, dep.Srcs()...)
1069 case staticLibTag:
1070 checkProducesJars(ctx, dep)
1071 deps.classpath = append(deps.classpath, dep.Srcs()...)
1072 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
1073 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Cross54250902017-12-05 09:28:08 -08001074 }
1075 default:
Colin Crossec7a0422017-07-07 14:47:12 -07001076 switch tag {
Paul Duffin68289b02019-09-20 13:50:52 +01001077 case bootClasspathTag:
1078 // If a system modules dependency has been added to the bootclasspath
1079 // then add its libs to the bootclasspath.
Paul Duffin83a2d962019-11-19 19:44:10 +00001080 sm := module.(SystemModulesProvider)
1081 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars()...)
Paul Duffin68289b02019-09-20 13:50:52 +01001082
Colin Cross1369cdb2017-09-29 17:58:17 -07001083 case systemModulesTag:
1084 if deps.systemModules != nil {
1085 panic("Found two system module dependencies")
1086 }
Paul Duffin83a2d962019-11-19 19:44:10 +00001087 sm := module.(SystemModulesProvider)
1088 outputDir, outputDeps := sm.OutputDirAndDeps()
1089 deps.systemModules = &systemModules{outputDir, outputDeps}
Colin Cross2fe66872015-03-30 17:20:39 -07001090 }
Colin Crossec7a0422017-07-07 14:47:12 -07001091 }
Colin Cross2fe66872015-03-30 17:20:39 -07001092 })
1093
Jiyong Park1be96912018-05-28 18:02:19 +09001094 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
1095
Colin Cross32f676a2017-09-06 13:41:06 -07001096 return deps
Colin Cross2fe66872015-03-30 17:20:39 -07001097}
1098
Artur Satayev9cf46692019-11-26 18:08:34 +00001099func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
1100 deps.processorPath = append(deps.processorPath, pluginJars...)
1101 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
1102}
1103
Colin Cross1e743852019-10-28 11:37:20 -07001104func getJavaVersion(ctx android.ModuleContext, javaVersion string, sdkContext sdkContext) javaVersion {
Nan Zhang357466b2018-04-17 17:38:36 -07001105 if javaVersion != "" {
Colin Cross1e743852019-10-28 11:37:20 -07001106 return normalizeJavaVersion(ctx, javaVersion)
Colin Crossdb224752020-05-14 18:05:32 -07001107 } else if ctx.Device() {
1108 return sdkContext.sdkVersion().defaultJavaLanguageVersion(ctx)
Nan Zhang357466b2018-04-17 17:38:36 -07001109 } else {
Colin Cross1e743852019-10-28 11:37:20 -07001110 return JAVA_VERSION_9
Nan Zhang357466b2018-04-17 17:38:36 -07001111 }
Nan Zhang357466b2018-04-17 17:38:36 -07001112}
1113
Colin Cross1e743852019-10-28 11:37:20 -07001114type javaVersion int
1115
1116const (
1117 JAVA_VERSION_UNSUPPORTED = 0
1118 JAVA_VERSION_6 = 6
1119 JAVA_VERSION_7 = 7
1120 JAVA_VERSION_8 = 8
1121 JAVA_VERSION_9 = 9
1122)
1123
1124func (v javaVersion) String() string {
1125 switch v {
1126 case JAVA_VERSION_6:
1127 return "1.6"
1128 case JAVA_VERSION_7:
1129 return "1.7"
1130 case JAVA_VERSION_8:
1131 return "1.8"
1132 case JAVA_VERSION_9:
1133 return "1.9"
1134 default:
1135 return "unsupported"
1136 }
1137}
1138
1139// Returns true if javac targeting this version uses system modules instead of a bootclasspath.
1140func (v javaVersion) usesJavaModules() bool {
1141 return v >= 9
1142}
1143
1144func normalizeJavaVersion(ctx android.BaseModuleContext, javaVersion string) javaVersion {
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001145 switch javaVersion {
1146 case "1.6", "6":
Colin Cross1e743852019-10-28 11:37:20 -07001147 return JAVA_VERSION_6
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001148 case "1.7", "7":
Colin Cross1e743852019-10-28 11:37:20 -07001149 return JAVA_VERSION_7
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001150 case "1.8", "8":
Colin Cross1e743852019-10-28 11:37:20 -07001151 return JAVA_VERSION_8
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001152 case "1.9", "9":
Colin Cross1e743852019-10-28 11:37:20 -07001153 return JAVA_VERSION_9
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001154 case "10", "11":
1155 ctx.PropertyErrorf("java_version", "Java language levels above 9 are not supported")
Colin Cross1e743852019-10-28 11:37:20 -07001156 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001157 default:
1158 ctx.PropertyErrorf("java_version", "Unrecognized Java language level")
Colin Cross1e743852019-10-28 11:37:20 -07001159 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001160 }
1161}
1162
Nan Zhanged19fc32017-10-19 13:06:22 -07001163func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
Colin Crossc0b06f12015-04-08 13:03:43 -07001164
Colin Crossf03c82b2015-04-13 13:53:40 -07001165 var flags javaBuilderFlags
1166
Tobias Thierer06dd04f2018-09-11 16:21:05 +01001167 // javaVersion flag.
1168 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), sdkContext(j))
1169
Nan Zhanged19fc32017-10-19 13:06:22 -07001170 // javac flags.
Colin Crossf03c82b2015-04-13 13:53:40 -07001171 javacFlags := j.properties.Javacflags
Colin Cross1e743852019-10-28 11:37:20 -07001172 if flags.javaVersion.usesJavaModules() {
Colin Cross1369cdb2017-09-29 17:58:17 -07001173 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Nan Zhanged19fc32017-10-19 13:06:22 -07001174 }
Colin Cross6510f912017-11-29 00:27:14 -08001175 if ctx.Config().MinimizeJavaDebugInfo() {
Colin Cross126a25c2017-10-31 13:55:34 -07001176 // Override the -g flag passed globally to remove local variable debug info to reduce
1177 // disk and memory usage.
1178 javacFlags = append(javacFlags, "-g:source,lines")
1179 }
Colin Crossc228a702019-11-06 16:18:05 -08001180 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
Colin Cross64162712017-08-08 13:17:59 -07001181
Colin Cross66548102018-06-19 22:47:35 -07001182 if ctx.Config().RunErrorProne() {
1183 if config.ErrorProneClasspath == nil {
1184 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1185 }
1186
1187 errorProneFlags := []string{
1188 "-Xplugin:ErrorProne",
1189 "${config.ErrorProneChecks}",
1190 }
1191 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1192
1193 flags.errorProneExtraJavacFlags = "${config.ErrorProneFlags} " +
1194 "'" + strings.Join(errorProneFlags, " ") + "'"
1195 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
Andreas Gampef3e5b552018-01-22 21:27:21 -08001196 }
1197
Nan Zhanged19fc32017-10-19 13:06:22 -07001198 // classpath
Nan Zhang581fd212018-01-10 16:06:12 -08001199 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1200 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross6cef4812019-10-17 14:23:50 -07001201 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
Colin Cross6a77c982018-06-19 22:43:34 -07001202 flags.processorPath = append(flags.processorPath, deps.processorPath...)
Colin Cross7fdd2b72018-01-02 18:14:25 -08001203
Colin Crossd99540b2020-04-22 11:44:34 -07001204 flags.processors = append(flags.processors, deps.processorClasses...)
1205 flags.processors = android.FirstUniqueStrings(flags.processors)
Colin Crossbe9cdb82019-01-21 21:37:16 -08001206
Colin Cross1e743852019-10-28 11:37:20 -07001207 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
1208 decodeSdkDep(ctx, sdkContext(j)).hasStandardLibs() {
Colin Cross7fdd2b72018-01-02 18:14:25 -08001209 // Give host-side tools a version of OpenJDK's standard libraries
1210 // close to what they're targeting. As of Dec 2017, AOSP is only
1211 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1212 //
1213 // When building with OpenJDK 8, the following should have no
1214 // effect since those jars would be available by default.
1215 //
1216 // When building with OpenJDK 9 but targeting a version < 1.8,
1217 // putting them on the bootclasspath means that:
1218 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1219 // b) references to existing APIs are not reinterpreted in an
1220 // OpenJDK 9-specific way, eg. calls to subclasses of
1221 // java.nio.Buffer as in http://b/70862583
1222 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1223 flags.bootClasspath = append(flags.bootClasspath,
1224 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1225 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
Nan Zhang5f8cb422018-02-06 10:34:32 -08001226 if Bool(j.properties.Use_tools_jar) {
1227 flags.bootClasspath = append(flags.bootClasspath,
1228 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1229 }
Colin Cross7fdd2b72018-01-02 18:14:25 -08001230 }
1231
Colin Cross1e743852019-10-28 11:37:20 -07001232 if j.properties.Patch_module != nil && flags.javaVersion.usesJavaModules() {
Jaewoong Jung38e4fb22018-12-12 09:01:34 -08001233 // Manually specify build directory in case it is not under the repo root.
1234 // (javac doesn't seem to expand into symbolc links when searching for patch-module targets, so
1235 // just adding a symlink under the root doesn't help.)
1236 patchPaths := ".:" + ctx.Config().BuildDir()
1237 classPath := flags.classpath.FormJavaClassPath("")
1238 if classPath != "" {
1239 patchPaths += ":" + classPath
1240 }
1241 javacFlags = append(javacFlags, "--patch-module="+String(j.properties.Patch_module)+"="+patchPaths)
Colin Cross81440082018-08-15 20:21:55 -07001242 }
1243
Nan Zhanged19fc32017-10-19 13:06:22 -07001244 // systemModules
Colin Crossb77043e2019-07-16 13:57:13 -07001245 flags.systemModules = deps.systemModules
Colin Cross1369cdb2017-09-29 17:58:17 -07001246
Nan Zhanged19fc32017-10-19 13:06:22 -07001247 // aidl flags.
Colin Cross3047fa22019-04-18 10:56:44 -07001248 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs)
Colin Cross2fe66872015-03-30 17:20:39 -07001249
Colin Cross81440082018-08-15 20:21:55 -07001250 if len(javacFlags) > 0 {
1251 // optimization.
1252 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1253 flags.javacFlags = "$javacFlags"
1254 }
1255
Nan Zhanged19fc32017-10-19 13:06:22 -07001256 return flags
1257}
Colin Crossc0b06f12015-04-08 13:03:43 -07001258
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001259func (j *Module) compile(ctx android.ModuleContext, aaptSrcJar android.Path) {
Colin Crossebe1a512017-11-14 13:12:14 -08001260 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
Nan Zhanged19fc32017-10-19 13:06:22 -07001261
1262 deps := j.collectDeps(ctx)
1263 flags := j.collectBuilderFlags(ctx, deps)
1264
Colin Cross1e743852019-10-28 11:37:20 -07001265 if flags.javaVersion.usesJavaModules() {
Nan Zhanged19fc32017-10-19 13:06:22 -07001266 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
1267 }
Colin Cross8a497952019-03-05 22:25:09 -08001268 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Colin Cross6af17aa2017-09-20 12:59:05 -07001269 if hasSrcExt(srcFiles.Strings(), ".proto") {
Colin Cross0f2ee152017-12-14 15:22:43 -08001270 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
Colin Cross6af17aa2017-09-20 12:59:05 -07001271 }
1272
Colin Crossaf050172017-11-15 23:01:59 -08001273 srcFiles = j.genSources(ctx, srcFiles, flags)
1274
1275 srcJars := srcFiles.FilterByExt(".srcjar")
Colin Cross59149b62017-10-16 18:07:29 -07001276 srcJars = append(srcJars, deps.srcJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001277 if aaptSrcJar != nil {
1278 srcJars = append(srcJars, aaptSrcJar)
1279 }
Colin Crossb7a63242015-04-16 14:09:14 -07001280
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001281 if j.properties.Jarjar_rules != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001282 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001283 }
1284
Colin Cross1ee23172017-10-18 14:44:18 -07001285 jarName := ctx.ModuleName() + ".jar"
1286
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001287 javaSrcFiles := srcFiles.FilterByExt(".java")
1288 var uniqueSrcFiles android.Paths
1289 set := make(map[string]bool)
1290 for _, v := range javaSrcFiles {
1291 if _, found := set[v.String()]; !found {
1292 set[v.String()] = true
1293 uniqueSrcFiles = append(uniqueSrcFiles, v)
1294 }
1295 }
1296
patricktu242faad2019-09-24 15:41:30 +08001297 // Collect .java files for AIDEGen
1298 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1299
Colin Cross55f63ea2018-08-27 12:37:09 -07001300 var kotlinJars android.Paths
1301
Colin Cross93e85952017-08-15 13:34:18 -07001302 if srcFiles.HasExt(".kt") {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001303 // user defined kotlin flags.
1304 kotlincFlags := j.properties.Kotlincflags
1305 CheckKotlincFlags(ctx, kotlincFlags)
1306
Colin Cross93e85952017-08-15 13:34:18 -07001307 // If there are kotlin files, compile them first but pass all the kotlin and java files
1308 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1309 // won't emit any classes for them.
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001310 kotlincFlags = append(kotlincFlags, "-no-stdlib")
Colin Cross93e85952017-08-15 13:34:18 -07001311 if ctx.Device() {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001312 kotlincFlags = append(kotlincFlags, "-no-jdk")
1313 }
1314 if len(kotlincFlags) > 0 {
1315 // optimization.
1316 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1317 flags.kotlincFlags += "$kotlincFlags"
Colin Cross93e85952017-08-15 13:34:18 -07001318 }
1319
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001320 var kotlinSrcFiles android.Paths
1321 kotlinSrcFiles = append(kotlinSrcFiles, uniqueSrcFiles...)
1322 kotlinSrcFiles = append(kotlinSrcFiles, srcFiles.FilterByExt(".kt")...)
1323
patricktu242faad2019-09-24 15:41:30 +08001324 // Collect .kt files for AIDEGen
1325 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, srcFiles.FilterByExt(".kt").Strings()...)
1326
Colin Crossafbb1732019-01-17 15:42:52 -08001327 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1328 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1329
1330 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1331 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1332
1333 if len(flags.processorPath) > 0 {
1334 // Use kapt for annotation processing
1335 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
Colin Cross3791b452020-06-18 15:46:32 -07001336 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
1337 kotlinKapt(ctx, kaptSrcJar, kaptResJar, kotlinSrcFiles, srcJars, flags)
Colin Crossafbb1732019-01-17 15:42:52 -08001338 srcJars = append(srcJars, kaptSrcJar)
Colin Cross3791b452020-06-18 15:46:32 -07001339 kotlinJars = append(kotlinJars, kaptResJar)
Colin Crossafbb1732019-01-17 15:42:52 -08001340 // Disable annotation processing in javac, it's already been handled by kapt
1341 flags.processorPath = nil
Colin Crossd99540b2020-04-22 11:44:34 -07001342 flags.processors = nil
Colin Crossafbb1732019-01-17 15:42:52 -08001343 }
Colin Cross93e85952017-08-15 13:34:18 -07001344
Colin Cross1ee23172017-10-18 14:44:18 -07001345 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross21fc9bb2019-01-18 15:05:09 -08001346 kotlinCompile(ctx, kotlinJar, kotlinSrcFiles, srcJars, flags)
Colin Cross93e85952017-08-15 13:34:18 -07001347 if ctx.Failed() {
1348 return
1349 }
1350
1351 // Make javac rule depend on the kotlinc rule
1352 flags.classpath = append(flags.classpath, kotlinJar)
Przemyslaw Szczepaniak66c0c402018-03-08 13:21:55 +00001353
Colin Cross55f63ea2018-08-27 12:37:09 -07001354 kotlinJars = append(kotlinJars, kotlinJar)
Colin Crossaaf58062020-06-18 15:52:01 -07001355 // Jar kotlin classes into the final jar after javac
1356 if BoolDefault(j.properties.Static_kotlin_stdlib, true) {
1357 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
1358 }
Colin Cross93e85952017-08-15 13:34:18 -07001359 }
1360
Colin Cross55f63ea2018-08-27 12:37:09 -07001361 jars := append(android.Paths(nil), kotlinJars...)
1362
Colin Cross5ab4e6d2017-11-22 16:20:45 -08001363 // Store the list of .java files that was passed to javac
1364 j.compiledJavaSrcs = uniqueSrcFiles
1365 j.compiledSrcJars = srcJars
1366
Nan Zhang61eaedb2017-11-02 13:28:15 -07001367 enable_sharding := false
Colin Crossf5a66282020-02-21 08:16:41 -08001368 var headerJarFileWithoutJarjar android.Path
Colin Crossbe9cdb82019-01-21 21:37:16 -08001369 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !deps.disableTurbine {
Nan Zhang61eaedb2017-11-02 13:28:15 -07001370 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1371 enable_sharding = true
Ashley Rosee36efcf2019-01-16 17:34:08 -05001372 // Formerly, there was a check here that prevented annotation processors
1373 // from being used when sharding was enabled, as some annotation processors
1374 // do not function correctly in sharded environments. It was removed to
1375 // allow for the use of annotation processors that do function correctly
1376 // with sharding enabled. See: b/77284273.
Nan Zhang61eaedb2017-11-02 13:28:15 -07001377 }
Colin Crossf5a66282020-02-21 08:16:41 -08001378 headerJarFileWithoutJarjar, j.headerJarFile =
1379 j.compileJavaHeader(ctx, uniqueSrcFiles, srcJars, deps, flags, jarName, kotlinJars)
Colin Crossf19b9bb2018-03-26 14:42:44 -07001380 if ctx.Failed() {
1381 return
Nan Zhanged19fc32017-10-19 13:06:22 -07001382 }
1383 }
Colin Cross8eadbf02017-10-24 17:46:00 -07001384 if len(uniqueSrcFiles) > 0 || len(srcJars) > 0 {
Colin Crossd6891432017-09-27 17:39:56 -07001385 var extraJarDeps android.Paths
Colin Cross66548102018-06-19 22:47:35 -07001386 if ctx.Config().RunErrorProne() {
Colin Crossc6bbef32017-08-14 14:16:06 -07001387 // If error-prone is enabled, add an additional rule to compile the java files into
1388 // a separate set of classes (so that they don't overwrite the normal ones and require
Colin Crossd6891432017-09-27 17:39:56 -07001389 // a rebuild when error-prone is turned off).
Colin Crossc6bbef32017-08-14 14:16:06 -07001390 // TODO(ccross): Once we always compile with javac9 we may be able to conditionally
1391 // enable error-prone without affecting the output class files.
Colin Cross1ee23172017-10-18 14:44:18 -07001392 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001393 RunErrorProne(ctx, errorprone, uniqueSrcFiles, srcJars, flags)
Colin Crossc6bbef32017-08-14 14:16:06 -07001394 extraJarDeps = append(extraJarDeps, errorprone)
1395 }
1396
Nan Zhang61eaedb2017-11-02 13:28:15 -07001397 if enable_sharding {
Colin Crossf5a66282020-02-21 08:16:41 -08001398 flags.classpath = append(flags.classpath, headerJarFileWithoutJarjar)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001399 shardSize := int(*(j.properties.Javac_shard_size))
1400 var shardSrcs []android.Paths
1401 if len(uniqueSrcFiles) > 0 {
Colin Cross0a2f7192019-09-23 14:33:09 -07001402 shardSrcs = android.ShardPaths(uniqueSrcFiles, shardSize)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001403 for idx, shardSrc := range shardSrcs {
Colin Cross3b706fd2019-09-05 16:44:18 -07001404 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1405 nil, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001406 jars = append(jars, classes)
1407 }
1408 }
1409 if len(srcJars) > 0 {
Colin Cross3b706fd2019-09-05 16:44:18 -07001410 classes := j.compileJavaClasses(ctx, jarName, len(shardSrcs),
1411 nil, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001412 jars = append(jars, classes)
1413 }
1414 } else {
Colin Cross3b706fd2019-09-05 16:44:18 -07001415 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueSrcFiles, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001416 jars = append(jars, classes)
1417 }
Colin Crossd6891432017-09-27 17:39:56 -07001418 if ctx.Failed() {
1419 return
1420 }
Colin Cross2fe66872015-03-30 17:20:39 -07001421 }
1422
Colin Cross0c4ce212019-05-03 15:28:19 -07001423 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1424
1425 var includeSrcJar android.WritablePath
1426 if Bool(j.properties.Include_srcs) {
1427 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1428 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1429 }
1430
Colin Crosscedd4762018-09-13 11:26:19 -07001431 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1432 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Colin Cross0f37af02017-09-27 17:42:05 -07001433 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
Colin Cross988708c2019-05-06 14:04:11 -07001434 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
Colin Cross0f37af02017-09-27 17:42:05 -07001435
1436 var resArgs []string
1437 var resDeps android.Paths
1438
1439 resArgs = append(resArgs, dirArgs...)
1440 resDeps = append(resDeps, dirDeps...)
1441
1442 resArgs = append(resArgs, fileArgs...)
1443 resDeps = append(resDeps, fileDeps...)
1444
Colin Cross988708c2019-05-06 14:04:11 -07001445 resArgs = append(resArgs, extraArgs...)
1446 resDeps = append(resDeps, extraDeps...)
1447
Colin Cross40a36712017-09-27 17:41:35 -07001448 if len(resArgs) > 0 {
Colin Cross1ee23172017-10-18 14:44:18 -07001449 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
Colin Crosse9a275b2017-10-16 17:09:48 -07001450 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Colin Cross331a1212018-08-15 20:40:52 -07001451 j.resourceJar = resourceJar
Colin Cross65bf4f22015-04-03 16:54:17 -07001452 if ctx.Failed() {
1453 return
1454 }
1455 }
1456
Colin Cross0c4ce212019-05-03 15:28:19 -07001457 var resourceJars android.Paths
1458 if j.resourceJar != nil {
1459 resourceJars = append(resourceJars, j.resourceJar)
1460 }
1461 if Bool(j.properties.Include_srcs) {
1462 resourceJars = append(resourceJars, includeSrcJar)
1463 }
1464 resourceJars = append(resourceJars, deps.staticResourceJars...)
Colin Cross331a1212018-08-15 20:40:52 -07001465
Colin Cross0c4ce212019-05-03 15:28:19 -07001466 if len(resourceJars) > 1 {
Colin Cross331a1212018-08-15 20:40:52 -07001467 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
Colin Cross0c4ce212019-05-03 15:28:19 -07001468 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
Colin Cross331a1212018-08-15 20:40:52 -07001469 false, nil, nil)
1470 j.resourceJar = combinedJar
Colin Cross0c4ce212019-05-03 15:28:19 -07001471 } else if len(resourceJars) == 1 {
1472 j.resourceJar = resourceJars[0]
Colin Cross331a1212018-08-15 20:40:52 -07001473 }
1474
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001475 if len(deps.staticJars) > 0 {
1476 jars = append(jars, deps.staticJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001477 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001478
Colin Cross094054a2018-10-17 15:10:48 -07001479 manifest := j.overrideManifest
1480 if !manifest.Valid() && j.properties.Manifest != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001481 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Colin Cross366938f2017-12-11 16:29:02 -08001482 }
Colin Cross635acc92017-09-12 22:50:46 -07001483
Colin Cross8a497952019-03-05 22:25:09 -08001484 services := android.PathsForModuleSrc(ctx, j.properties.Services)
Alex Light7f004a72019-02-21 13:27:37 -08001485 if len(services) > 0 {
1486 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1487 var zipargs []string
1488 for _, file := range services {
1489 serviceFile := file.String()
1490 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1491 }
Kousik Kumarc05da0a2020-05-20 11:27:16 -07001492 rule := zip
1493 args := map[string]string{
1494 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1495 }
1496 if ctx.Config().IsEnvTrue("RBE_ZIP") {
1497 rule = zipRE
1498 args["implicits"] = strings.Join(services.Strings(), ",")
1499 }
Alex Light7f004a72019-02-21 13:27:37 -08001500 ctx.Build(pctx, android.BuildParams{
Kousik Kumarc05da0a2020-05-20 11:27:16 -07001501 Rule: rule,
Alex Light7f004a72019-02-21 13:27:37 -08001502 Output: servicesJar,
1503 Implicits: services,
Kousik Kumarc05da0a2020-05-20 11:27:16 -07001504 Args: args,
Alex Light7f004a72019-02-21 13:27:37 -08001505 })
1506 jars = append(jars, servicesJar)
1507 }
1508
Colin Cross0a6e0072017-08-30 14:24:55 -07001509 // Combine the classes built from sources, any manifests, and any static libraries into
Nan Zhanged19fc32017-10-19 13:06:22 -07001510 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross3063b782018-08-15 11:19:12 -07001511 var outputFile android.ModuleOutPath
Colin Crosse9a275b2017-10-16 17:09:48 -07001512
1513 if len(jars) == 1 && !manifest.Valid() {
Colin Cross3063b782018-08-15 11:19:12 -07001514 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok {
1515 // Optimization: skip the combine step if there is nothing to do
1516 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1517 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1518 // any if len(jars) == 1.
1519 outputFile = moduleOutPath
1520 } else {
1521 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1522 ctx.Build(pctx, android.BuildParams{
1523 Rule: android.Cp,
1524 Input: jars[0],
1525 Output: combinedJar,
1526 })
1527 outputFile = combinedJar
1528 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001529 } else {
Colin Cross1ee23172017-10-18 14:44:18 -07001530 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001531 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
Colin Cross9b38aef2018-08-27 15:42:25 -07001532 false, nil, nil)
Colin Crosse9a275b2017-10-16 17:09:48 -07001533 outputFile = combinedJar
1534 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001535
Colin Cross331a1212018-08-15 20:40:52 -07001536 // jarjar implementation jar if necessary
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001537 if j.expandJarjarRules != nil {
Colin Cross8649b262017-09-27 18:03:17 -07001538 // Transform classes.jar into classes-jarjar.jar
Colin Cross1ee23172017-10-18 14:44:18 -07001539 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001540 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
Colin Crosse9a275b2017-10-16 17:09:48 -07001541 outputFile = jarjarFile
Colin Cross331a1212018-08-15 20:40:52 -07001542
1543 // jarjar resource jar if necessary
1544 if j.resourceJar != nil {
1545 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001546 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
Colin Cross331a1212018-08-15 20:40:52 -07001547 j.resourceJar = resourceJarJarFile
1548 }
1549
Colin Cross0a6e0072017-08-30 14:24:55 -07001550 if ctx.Failed() {
1551 return
1552 }
1553 }
Vladimir Marko0975ee02019-04-02 10:29:55 +01001554
1555 // Check package restrictions if necessary.
1556 if len(j.properties.Permitted_packages) > 0 {
Tej Singh83839722020-06-03 18:45:54 +00001557 // Check packages and copy to package-checked file.
1558 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
1559 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
1560 j.additionalCheckedModules = append(j.additionalCheckedModules, pkgckFile)
Vladimir Marko0975ee02019-04-02 10:29:55 +01001561
1562 if ctx.Failed() {
1563 return
1564 }
1565 }
1566
Nan Zhanged19fc32017-10-19 13:06:22 -07001567 j.implementationJarFile = outputFile
1568 if j.headerJarFile == nil {
1569 j.headerJarFile = j.implementationJarFile
1570 }
Colin Cross2fe66872015-03-30 17:20:39 -07001571
Jiyong Park28826602020-02-21 16:04:53 +09001572 // Force enable the instrumentation for java code that is built for APEXes ...
1573 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
1574 // doesn't make sense)
1575 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
1576 if android.DirectlyInAnyApex(ctx, ctx.ModuleName()) && !isJacocoAgent && !j.IsForPlatform() {
Jiyong Park81aaa0c2020-02-18 12:50:44 +00001577 j.properties.Instrument = true
1578 }
1579
Colin Cross3144dfc2018-01-03 15:06:47 -08001580 if j.shouldInstrument(ctx) {
Colin Crosscb933592017-11-22 13:49:43 -08001581 outputFile = j.instrument(ctx, flags, outputFile, jarName)
1582 }
1583
Colin Cross331a1212018-08-15 20:40:52 -07001584 // merge implementation jar with resources if necessary
1585 implementationAndResourcesJar := outputFile
1586 if j.resourceJar != nil {
Colin Cross08a409d2019-04-29 10:22:44 -07001587 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Colin Cross331a1212018-08-15 20:40:52 -07001588 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Colin Cross08a409d2019-04-29 10:22:44 -07001589 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
Colin Cross331a1212018-08-15 20:40:52 -07001590 false, nil, nil)
1591 implementationAndResourcesJar = combinedJar
1592 }
1593
1594 j.implementationAndResourcesJar = implementationAndResourcesJar
1595
Jiyong Park6b21c7d2020-02-11 09:16:01 +09001596 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
1597 if android.DirectlyInAnyApex(ctx, ctx.ModuleName()) && !j.IsForPlatform() {
1598 if j.deviceProperties.Compile_dex == nil {
1599 j.deviceProperties.Compile_dex = proptools.BoolPtr(true)
1600 }
1601 if j.deviceProperties.Hostdex == nil {
1602 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1603 }
1604 }
1605
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001606 if ctx.Device() && j.hasCode(ctx) &&
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001607 (Bool(j.properties.Installable) || Bool(j.deviceProperties.Compile_dex)) {
Colin Cross8faf8fc2019-01-16 15:15:52 -08001608 // Dex compilation
Colin Cross3063b782018-08-15 11:19:12 -07001609 var dexOutputFile android.ModuleOutPath
David Brazdil17ef5632018-06-27 10:27:45 +01001610 dexOutputFile = j.compileDex(ctx, flags, outputFile, jarName)
Colin Cross2fe66872015-03-30 17:20:39 -07001611 if ctx.Failed() {
1612 return
1613 }
Colin Cross331a1212018-08-15 20:40:52 -07001614
Jiyong Park09cb6292019-07-15 15:29:23 +09001615 // Hidden API CSV generation and dex encoding
1616 dexOutputFile = j.hiddenAPI.hiddenAPI(ctx, dexOutputFile, j.implementationJarFile,
David Srbecky98c71222020-05-20 22:20:28 +01001617 proptools.Bool(j.deviceProperties.Uncompress_dex))
Colin Cross8faf8fc2019-01-16 15:15:52 -08001618
Colin Cross331a1212018-08-15 20:40:52 -07001619 // merge dex jar with resources if necessary
1620 if j.resourceJar != nil {
1621 jars := android.Paths{dexOutputFile, j.resourceJar}
1622 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
1623 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1624 false, nil, nil)
David Srbecky98c71222020-05-20 22:20:28 +01001625 if *j.deviceProperties.Uncompress_dex {
Nicolas Geoffrayf3438722019-01-23 15:57:21 +00001626 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
1627 TransformZipAlign(ctx, combinedAlignedJar, combinedJar)
1628 dexOutputFile = combinedAlignedJar
1629 } else {
1630 dexOutputFile = combinedJar
1631 }
Colin Cross331a1212018-08-15 20:40:52 -07001632 }
1633
1634 j.dexJarFile = dexOutputFile
1635
Colin Cross8faf8fc2019-01-16 15:15:52 -08001636 // Dexpreopting
Colin Cross43f08db2018-11-12 10:13:39 -08001637 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
1638
1639 j.maybeStrippedDexJarFile = dexOutputFile
1640
Colin Cross3063b782018-08-15 11:19:12 -07001641 outputFile = dexOutputFile
Colin Cross43f08db2018-11-12 10:13:39 -08001642
1643 if ctx.Failed() {
1644 return
1645 }
Colin Cross331a1212018-08-15 20:40:52 -07001646 } else {
1647 outputFile = implementationAndResourcesJar
Colin Cross2fe66872015-03-30 17:20:39 -07001648 }
Colin Cross331a1212018-08-15 20:40:52 -07001649
Colin Cross1e28e3c2020-06-02 20:09:13 -07001650 if ctx.Device() {
1651 lintSDKVersionString := func(sdkSpec sdkSpec) string {
1652 if v := sdkSpec.version; v.isNumbered() {
1653 return v.String()
1654 } else {
1655 return ctx.Config().DefaultAppTargetSdk()
1656 }
1657 }
1658
1659 j.linter.name = ctx.ModuleName()
1660 j.linter.srcs = srcFiles
1661 j.linter.srcJars = srcJars
1662 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1663 j.linter.classes = j.implementationJarFile
1664 j.linter.minSdkVersion = lintSDKVersionString(j.minSdkVersion())
1665 j.linter.targetSdkVersion = lintSDKVersionString(j.targetSdkVersion())
1666 j.linter.compileSdkVersion = lintSDKVersionString(j.sdkVersion())
1667 j.linter.javaLanguageLevel = flags.javaVersion.String()
1668 j.linter.kotlinLanguageLevel = "1.3"
1669 j.linter.lint(ctx)
1670 }
1671
Colin Crossb7a63242015-04-16 14:09:14 -07001672 ctx.CheckbuildFile(outputFile)
Colin Cross3063b782018-08-15 11:19:12 -07001673
1674 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1675 j.outputFile = outputFile.WithoutRel()
Colin Cross2fe66872015-03-30 17:20:39 -07001676}
1677
Colin Cross3b706fd2019-09-05 16:44:18 -07001678func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
1679 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.WritablePath {
1680
1681 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
1682 if idx >= 0 {
1683 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
1684 jarName += strconv.Itoa(idx)
1685 }
1686
1687 classes := android.PathForModuleOut(ctx, "javac", jarName)
1688 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, flags, extraJarDeps)
1689
1690 if ctx.Config().EmitXrefRules() {
1691 extractionFile := android.PathForModuleOut(ctx, kzipName)
1692 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1693 j.kytheFiles = append(j.kytheFiles, extractionFile)
1694 }
1695
1696 return classes
1697}
1698
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001699// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1700// since some of these flags may be used internally.
1701func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1702 for _, flag := range flags {
1703 flag = strings.TrimSpace(flag)
1704
1705 if !strings.HasPrefix(flag, "-") {
1706 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1707 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1708 ctx.PropertyErrorf("kotlincflags",
1709 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1710 } else if inList(flag, config.KotlincIllegalFlags) {
1711 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1712 } else if flag == "-include-runtime" {
1713 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1714 } else {
1715 args := strings.Split(flag, " ")
1716 if args[0] == "-kotlin-home" {
1717 ctx.PropertyErrorf("kotlincflags",
1718 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1719 }
1720 }
1721 }
1722}
1723
Colin Cross8eadbf02017-10-24 17:46:00 -07001724func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
Colin Crossf5a66282020-02-21 08:16:41 -08001725 deps deps, flags javaBuilderFlags, jarName string,
1726 extraJars android.Paths) (headerJar, jarjarHeaderJar android.Path) {
Nan Zhanged19fc32017-10-19 13:06:22 -07001727
1728 var jars android.Paths
Colin Cross8eadbf02017-10-24 17:46:00 -07001729 if len(srcFiles) > 0 || len(srcJars) > 0 {
Nan Zhanged19fc32017-10-19 13:06:22 -07001730 // Compile java sources into turbine.jar.
1731 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1732 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1733 if ctx.Failed() {
Colin Crossf5a66282020-02-21 08:16:41 -08001734 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001735 }
1736 jars = append(jars, turbineJar)
1737 }
1738
Colin Cross55f63ea2018-08-27 12:37:09 -07001739 jars = append(jars, extraJars...)
1740
Nan Zhanged19fc32017-10-19 13:06:22 -07001741 // Combine any static header libraries into classes-header.jar. If there is only
1742 // one input jar this step will be skipped.
Nan Zhanged19fc32017-10-19 13:06:22 -07001743 jars = append(jars, deps.staticHeaderJars...)
1744
Colin Cross5c6ecc12017-10-23 18:12:27 -07001745 // we cannot skip the combine step for now if there is only one jar
1746 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1747 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001748 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
Colin Cross6c6e6cd2019-05-08 14:30:12 -07001749 false, nil, []string{"META-INF/TRANSITIVE"})
Colin Cross5c6ecc12017-10-23 18:12:27 -07001750 headerJar = combinedJar
Colin Crossf5a66282020-02-21 08:16:41 -08001751 jarjarHeaderJar = combinedJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001752
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001753 if j.expandJarjarRules != nil {
Nan Zhanged19fc32017-10-19 13:06:22 -07001754 // Transform classes.jar into classes-jarjar.jar
1755 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001756 TransformJarJar(ctx, jarjarFile, headerJar, j.expandJarjarRules)
Colin Crossf5a66282020-02-21 08:16:41 -08001757 jarjarHeaderJar = jarjarFile
Nan Zhanged19fc32017-10-19 13:06:22 -07001758 if ctx.Failed() {
Colin Crossf5a66282020-02-21 08:16:41 -08001759 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001760 }
1761 }
1762
Colin Crossf5a66282020-02-21 08:16:41 -08001763 return headerJar, jarjarHeaderJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001764}
1765
Colin Crosscb933592017-11-22 13:49:43 -08001766func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross3063b782018-08-15 11:19:12 -07001767 classesJar android.Path, jarName string) android.ModuleOutPath {
Colin Crosscb933592017-11-22 13:49:43 -08001768
Colin Cross7a3139e2017-12-19 13:57:50 -08001769 specs := j.jacocoModuleToZipCommand(ctx)
Colin Crosscb933592017-11-22 13:49:43 -08001770
Colin Cross84c38822018-01-03 15:59:46 -08001771 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Crosscb933592017-11-22 13:49:43 -08001772 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
1773
1774 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1775
1776 j.jacocoReportClassesFile = jacocoReportClassesFile
1777
1778 return instrumentedJar
1779}
1780
albaltai36ff7dc2018-12-25 14:35:23 +08001781var _ Dependency = (*Module)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001782
Nan Zhanged19fc32017-10-19 13:06:22 -07001783func (j *Module) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001784 if j.headerJarFile == nil {
1785 return nil
1786 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001787 return android.Paths{j.headerJarFile}
1788}
1789
1790func (j *Module) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08001791 if j.implementationJarFile == nil {
1792 return nil
1793 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001794 return android.Paths{j.implementationJarFile}
Colin Cross2fe66872015-03-30 17:20:39 -07001795}
1796
Colin Crossf24a22a2019-01-31 14:12:44 -08001797func (j *Module) DexJar() android.Path {
1798 return j.dexJarFile
1799}
1800
Colin Cross331a1212018-08-15 20:40:52 -07001801func (j *Module) ResourceJars() android.Paths {
1802 if j.resourceJar == nil {
1803 return nil
1804 }
1805 return android.Paths{j.resourceJar}
1806}
1807
1808func (j *Module) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001809 if j.implementationAndResourcesJar == nil {
1810 return nil
1811 }
Colin Cross331a1212018-08-15 20:40:52 -07001812 return android.Paths{j.implementationAndResourcesJar}
1813}
1814
Colin Cross46c9b8b2017-06-22 16:51:17 -07001815func (j *Module) AidlIncludeDirs() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001816 // exportAidlIncludeDirs is type android.Paths already
Colin Crossc0b06f12015-04-08 13:03:43 -07001817 return j.exportAidlIncludeDirs
1818}
1819
Jiyong Park1be96912018-05-28 18:02:19 +09001820func (j *Module) ExportedSdkLibs() []string {
albaltai36ff7dc2018-12-25 14:35:23 +08001821 // exportedSdkLibs is type []string
Jiyong Park1be96912018-05-28 18:02:19 +09001822 return j.exportedSdkLibs
1823}
1824
Artur Satayev9cf46692019-11-26 18:08:34 +00001825func (j *Module) ExportedPlugins() (android.Paths, []string) {
1826 return j.exportedPluginJars, j.exportedPluginClasses
1827}
1828
Colin Cross0c4ce212019-05-03 15:28:19 -07001829func (j *Module) SrcJarArgs() ([]string, android.Paths) {
1830 return j.srcJarArgs, j.srcJarDeps
1831}
1832
Colin Cross46c9b8b2017-06-22 16:51:17 -07001833var _ logtagsProducer = (*Module)(nil)
Colin Crossf05fe972015-04-10 17:45:20 -07001834
Colin Cross46c9b8b2017-06-22 16:51:17 -07001835func (j *Module) logtags() android.Paths {
Colin Crossf05fe972015-04-10 17:45:20 -07001836 return j.logtagsSrcs
1837}
1838
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001839// Collect information for opening IDE project files in java/jdeps.go.
1840func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
1841 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
1842 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
patricktu18c82ff2019-05-10 15:48:50 +08001843 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001844 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001845 if j.expandJarjarRules != nil {
1846 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001847 }
1848}
1849
1850func (j *Module) CompilerDeps() []string {
1851 jdeps := []string{}
1852 jdeps = append(jdeps, j.properties.Libs...)
1853 jdeps = append(jdeps, j.properties.Static_libs...)
1854 return jdeps
1855}
1856
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001857func (j *Module) hasCode(ctx android.ModuleContext) bool {
1858 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
1859 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
1860}
1861
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001862func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffinc8f2f182020-05-17 08:34:50 +01001863 return j.depIsInSameApex(ctx, dep)
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001864}
1865
Jiyong Park0b238752019-10-29 11:23:10 +09001866func (j *Module) Stem() string {
1867 return proptools.StringDefault(j.deviceProperties.Stem, j.Name())
1868}
1869
Jiyong Park618922e2020-01-08 13:35:43 +09001870func (j *Module) JacocoReportClassesFile() android.Path {
1871 return j.jacocoReportClassesFile
1872}
1873
Martin Stjernholm6d415272020-01-31 17:10:36 +00001874func (j *Module) IsInstallable() bool {
1875 return Bool(j.properties.Installable)
1876}
1877
Colin Cross2fe66872015-03-30 17:20:39 -07001878//
1879// Java libraries (.jar file)
1880//
1881
Anton Hansson1e65f942020-03-27 19:39:48 +00001882type LibraryProperties struct {
1883 Dist struct {
1884 // The tag of the output of this module that should be output.
1885 Tag *string `android:"arch_variant"`
1886 } `android:"arch_variant"`
1887}
1888
Colin Crossf506d872017-07-19 15:53:04 -07001889type Library struct {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001890 Module
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001891
Anton Hansson1e65f942020-03-27 19:39:48 +00001892 libraryProperties LibraryProperties
1893
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001894 InstallMixin func(ctx android.ModuleContext, installPath android.Path) (extraInstallDeps android.Paths)
Colin Cross2fe66872015-03-30 17:20:39 -07001895}
1896
Paul Duffina105cf92020-05-29 11:24:51 +01001897// Provides access to the list of permitted packages from updatable boot jars.
1898type PermittedPackagesForUpdatableBootJars interface {
1899 PermittedPackagesForUpdatableBootJars() []string
1900}
1901
1902var _ PermittedPackagesForUpdatableBootJars = (*Library)(nil)
1903
1904func (j *Library) PermittedPackagesForUpdatableBootJars() []string {
1905 return j.properties.Permitted_packages
1906}
1907
Colin Cross42be7612019-02-21 18:12:14 -08001908func shouldUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter) bool {
Ulya Trafimovichf491dde2020-01-24 12:19:45 +00001909 // Store uncompressed (and aligned) any dex files from jars in APEXes.
1910 if am, ok := ctx.Module().(android.ApexModule); ok && !am.IsForPlatform() {
1911 return true
1912 }
1913
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001914 // Store uncompressed (and do not strip) dex files from boot class path jars.
1915 if inList(ctx.ModuleName(), ctx.Config().BootJars()) {
1916 return true
1917 }
1918
1919 // Store uncompressed dex files that are preopted on /system.
Colin Cross42be7612019-02-21 18:12:14 -08001920 if !dexpreopter.dexpreoptDisabled(ctx) && (ctx.Host() || !odexOnSystemOther(ctx, dexpreopter.installPath)) {
Vladimir Markoe8b00d62018-12-21 15:54:16 +00001921 return true
1922 }
Colin Cross083a2aa2019-02-06 16:37:12 -08001923 if ctx.Config().UncompressPrivAppDex() &&
1924 inList(ctx.ModuleName(), ctx.Config().ModulesLoadedByPrivilegedModules()) {
1925 return true
1926 }
1927
Colin Cross2fc72f62018-12-21 12:59:54 -08001928 return false
1929}
1930
Colin Crossf506d872017-07-19 15:53:04 -07001931func (j *Library) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayeve5ac15a2020-04-08 19:09:30 +01001932 j.checkSdkVersions(ctx)
Jiyong Park0b238752019-10-29 11:23:10 +09001933 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross43f08db2018-11-12 10:13:39 -08001934 j.dexpreopter.isSDKLibrary = j.deviceProperties.IsSDKLibrary
David Srbecky98c71222020-05-20 22:20:28 +01001935 if j.deviceProperties.Uncompress_dex == nil {
1936 // If the value was not force-set by the user, use reasonable default based on the module.
1937 j.deviceProperties.Uncompress_dex = proptools.BoolPtr(shouldUncompressDex(ctx, &j.dexpreopter))
1938 }
1939 j.dexpreopter.uncompressedDex = *j.deviceProperties.Uncompress_dex
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001940 j.compile(ctx, nil)
Colin Crossb7a63242015-04-16 14:09:14 -07001941
Jiyong Park7f7766d2019-07-25 22:02:35 +09001942 exclusivelyForApex := android.InAnyApex(ctx.ModuleName()) && !j.IsForPlatform()
1943 if (Bool(j.properties.Installable) || ctx.Host()) && !exclusivelyForApex {
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001944 var extraInstallDeps android.Paths
1945 if j.InstallMixin != nil {
1946 extraInstallDeps = j.InstallMixin(ctx, j.outputFile)
1947 }
Colin Cross2c429dc2017-08-31 16:45:16 -07001948 j.installFile = ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Parked50ca82020-05-28 23:46:55 +09001949 j.Stem()+".jar", j.outputFile, extraInstallDeps...)
Colin Cross2c429dc2017-08-31 16:45:16 -07001950 }
Anton Hansson1e65f942020-03-27 19:39:48 +00001951
1952 // Verify Dist.Tag is set to a supported output
1953 if j.libraryProperties.Dist.Tag != nil {
1954 distFiles, err := j.OutputFiles(*j.libraryProperties.Dist.Tag)
1955 if err != nil {
1956 ctx.PropertyErrorf("dist.tag", "%s", err.Error())
1957 }
1958 j.distFile = distFiles[0]
1959 }
Colin Crossb7a63242015-04-16 14:09:14 -07001960}
1961
Colin Crossf506d872017-07-19 15:53:04 -07001962func (j *Library) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001963 j.deps(ctx)
1964}
1965
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001966const (
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001967 aidlIncludeDir = "aidl"
1968 javaDir = "java"
1969 jarFileSuffix = ".jar"
1970 testConfigSuffix = "-AndroidTest.xml"
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001971)
1972
Paul Duffina0dbf432019-12-05 11:25:53 +00001973// path to the jar file of a java library. Relative to <sdk_root>/<api_dir>
Paul Duffin9b358d72020-03-02 10:16:35 +00001974func sdkSnapshotFilePathForJar(osPrefix, name string) string {
1975 return sdkSnapshotFilePathForMember(osPrefix, name, jarFileSuffix)
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001976}
1977
Paul Duffin9b358d72020-03-02 10:16:35 +00001978func sdkSnapshotFilePathForMember(osPrefix, name string, suffix string) string {
1979 return filepath.Join(javaDir, osPrefix, name+suffix)
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001980}
1981
Paul Duffin13879572019-11-28 14:31:38 +00001982type librarySdkMemberType struct {
Paul Duffin255f18e2019-12-13 11:22:16 +00001983 android.SdkMemberTypeBase
Paul Duffin2b9e3d32020-02-28 14:39:53 +00001984
1985 // Function to retrieve the appropriate output jar (implementation or header) from
1986 // the library.
1987 jarToExportGetter func(j *Library) android.Path
Paul Duffin13879572019-11-28 14:31:38 +00001988}
1989
1990func (mt *librarySdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
1991 mctx.AddVariationDependencies(nil, dependencyTag, names...)
1992}
1993
1994func (mt *librarySdkMemberType) IsInstance(module android.Module) bool {
1995 _, ok := module.(*Library)
1996 return ok
1997}
1998
Paul Duffin17ab8832020-03-19 16:11:18 +00001999func (mt *librarySdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
2000 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_import")
Paul Duffind76209b2020-03-02 11:33:02 +00002001}
Paul Duffina0dbf432019-12-05 11:25:53 +00002002
Paul Duffind76209b2020-03-02 11:33:02 +00002003func (mt *librarySdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
Paul Duffinc9103932020-03-17 21:04:24 +00002004 return &librarySdkMemberProperties{}
Paul Duffind76209b2020-03-02 11:33:02 +00002005}
2006
2007type librarySdkMemberProperties struct {
2008 android.SdkMemberPropertiesBase
2009
Paul Duffin08385bf2020-05-06 10:23:19 +01002010 JarToExport android.Path `android:"arch_variant"`
Paul Duffinc9103932020-03-17 21:04:24 +00002011 AidlIncludeDirs android.Paths
Paul Duffind76209b2020-03-02 11:33:02 +00002012}
2013
Paul Duffin17ab8832020-03-19 16:11:18 +00002014func (p *librarySdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin13879572019-11-28 14:31:38 +00002015 j := variant.(*Library)
2016
Paul Duffinc9103932020-03-17 21:04:24 +00002017 p.JarToExport = ctx.MemberType().(*librarySdkMemberType).jarToExportGetter(j)
2018 p.AidlIncludeDirs = j.AidlIncludeDirs()
Paul Duffind76209b2020-03-02 11:33:02 +00002019}
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00002020
Paul Duffin17ab8832020-03-19 16:11:18 +00002021func (p *librarySdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffinc9103932020-03-17 21:04:24 +00002022 builder := ctx.SnapshotBuilder()
Paul Duffin17ab8832020-03-19 16:11:18 +00002023
Paul Duffinc9103932020-03-17 21:04:24 +00002024 exportedJar := p.JarToExport
2025 if exportedJar != nil {
2026 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
Paul Duffind76209b2020-03-02 11:33:02 +00002027 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
2028
Paul Duffinc9103932020-03-17 21:04:24 +00002029 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
2030 }
2031
2032 aidlIncludeDirs := p.AidlIncludeDirs
2033 if len(aidlIncludeDirs) != 0 {
2034 sdkModuleContext := ctx.SdkModuleContext()
2035 for _, dir := range aidlIncludeDirs {
Paul Duffind76209b2020-03-02 11:33:02 +00002036 // TODO(jiyong): copy parcelable declarations only
2037 aidlFiles, _ := sdkModuleContext.GlobWithDeps(dir.String()+"/**/*.aidl", nil)
2038 for _, file := range aidlFiles {
2039 builder.CopyToSnapshot(android.PathForSource(sdkModuleContext, file), filepath.Join(aidlIncludeDir, file))
2040 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00002041 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00002042
Paul Duffinc9103932020-03-17 21:04:24 +00002043 // TODO(b/151933053) - add aidl include dirs property
Paul Duffind76209b2020-03-02 11:33:02 +00002044 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00002045}
2046
Paul Duffin2b9e3d32020-02-28 14:39:53 +00002047var javaHeaderLibsSdkMemberType android.SdkMemberType = &librarySdkMemberType{
2048 android.SdkMemberTypeBase{
2049 PropertyName: "java_header_libs",
2050 SupportsSdk: true,
Paul Duffin7b81f5e2020-01-13 21:03:22 +00002051 },
Paul Duffin2b9e3d32020-02-28 14:39:53 +00002052 func(j *Library) android.Path {
Paul Duffina0dbf432019-12-05 11:25:53 +00002053 headerJars := j.HeaderJars()
2054 if len(headerJars) != 1 {
2055 panic(fmt.Errorf("there must be only one header jar from %q", j.Name()))
2056 }
2057
2058 return headerJars[0]
Paul Duffin2b9e3d32020-02-28 14:39:53 +00002059 },
Paul Duffina0dbf432019-12-05 11:25:53 +00002060}
2061
Colin Cross1b16b0e2019-02-12 14:41:32 -08002062// java_library builds and links sources into a `.jar` file for the device, and possibly for the host as well.
2063//
2064// By default, a java_library has a single variant that produces a `.jar` file containing `.class` files that were
2065// compiled against the device bootclasspath. This jar is not suitable for installing on a device, but can be used
2066// as a `static_libs` dependency of another module.
2067//
2068// Specifying `installable: true` will product a `.jar` file containing `classes.dex` files, suitable for installing on
2069// a device.
2070//
2071// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2072// compiled against the host bootclasspath.
Colin Cross9ae1b922018-06-26 17:59:05 -07002073func LibraryFactory() android.Module {
2074 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07002075
Colin Cross1c14b4e2020-06-15 16:09:53 -07002076 module.addHostAndDeviceProperties()
2077 module.AddProperties(&module.libraryProperties)
Colin Cross2fe66872015-03-30 17:20:39 -07002078
Paul Duffin64e61992020-05-15 10:20:31 +01002079 module.initModuleAndImport(&module.ModuleBase)
2080
Jiyong Park7f7766d2019-07-25 22:02:35 +09002081 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002082 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002083 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross9ae1b922018-06-26 17:59:05 -07002084 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002085}
2086
Colin Cross1b16b0e2019-02-12 14:41:32 -08002087// java_library_static is an obsolete alias for java_library.
2088func LibraryStaticFactory() android.Module {
2089 return LibraryFactory()
2090}
2091
2092// java_library_host builds and links sources into a `.jar` file for the host.
2093//
2094// A java_library_host has a single variant that produces a `.jar` file containing `.class` files that were
2095// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002096func LibraryHostFactory() android.Module {
2097 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07002098
Colin Cross1c14b4e2020-06-15 16:09:53 -07002099 module.addHostProperties()
Colin Cross36242852017-06-23 15:06:31 -07002100
Colin Cross9ae1b922018-06-26 17:59:05 -07002101 module.Module.properties.Installable = proptools.BoolPtr(true)
2102
Jiyong Park7f7766d2019-07-25 22:02:35 +09002103 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002104 InitJavaModule(module, android.HostSupported)
Colin Cross36242852017-06-23 15:06:31 -07002105 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002106}
2107
2108//
Colin Crossb628ea52018-08-14 16:42:33 -07002109// Java Tests
Colin Cross05638fc2018-04-09 18:40:24 -07002110//
2111
2112type testProperties struct {
Colin Cross05638fc2018-04-09 18:40:24 -07002113 // list of compatibility suites (for example "cts", "vts") that the module should be
2114 // installed into.
2115 Test_suites []string `android:"arch_variant"`
Julien Despreze146e392018-08-02 15:00:46 -07002116
2117 // the name of the test configuration (for example "AndroidTest.xml") that should be
2118 // installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002119 Test_config *string `android:"path,arch_variant"`
Colin Crossd96ca352018-08-10 16:06:24 -07002120
Jack He33338892018-09-19 02:21:28 -07002121 // the name of the test configuration template (for example "AndroidTestTemplate.xml") that
2122 // should be installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002123 Test_config_template *string `android:"path,arch_variant"`
Jack He33338892018-09-19 02:21:28 -07002124
Colin Crossd96ca352018-08-10 16:06:24 -07002125 // list of files or filegroup modules that provide data that should be installed alongside
2126 // the test
Colin Cross27b922f2019-03-04 22:35:41 -08002127 Data []string `android:"path"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07002128
2129 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
2130 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
2131 // explicitly.
2132 Auto_gen_config *bool
easoncyleeba606252020-04-30 14:57:06 +08002133
2134 // Add parameterized mainline modules to auto generated test config. The options will be
2135 // handled by TradeFed to do downloading and installing the specified modules on the device.
2136 Test_mainline_modules []string
Colin Cross05638fc2018-04-09 18:40:24 -07002137}
2138
Paul Duffin42df1442019-03-20 12:45:53 +00002139type testHelperLibraryProperties struct {
2140 // list of compatibility suites (for example "cts", "vts") that the module should be
2141 // installed into.
2142 Test_suites []string `android:"arch_variant"`
2143}
2144
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002145type prebuiltTestProperties struct {
2146 // list of compatibility suites (for example "cts", "vts") that the module should be
2147 // installed into.
2148 Test_suites []string `android:"arch_variant"`
2149
2150 // the name of the test configuration (for example "AndroidTest.xml") that should be
2151 // installed with the module.
2152 Test_config *string `android:"path,arch_variant"`
2153}
2154
Colin Cross05638fc2018-04-09 18:40:24 -07002155type Test struct {
2156 Library
2157
2158 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07002159
2160 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07002161 data android.Paths
Colin Cross303e21f2018-08-07 16:49:25 -07002162}
2163
Paul Duffin42df1442019-03-20 12:45:53 +00002164type TestHelperLibrary struct {
2165 Library
2166
2167 testHelperLibraryProperties testHelperLibraryProperties
2168}
2169
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002170type JavaTestImport struct {
2171 Import
2172
2173 prebuiltTestProperties prebuiltTestProperties
2174
2175 testConfig android.Path
2176}
2177
Colin Cross303e21f2018-08-07 16:49:25 -07002178func (j *Test) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Dan Shi6ffaaa82019-09-26 11:41:36 -07002179 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.testProperties.Test_config, j.testProperties.Test_config_template,
2180 j.testProperties.Test_suites, j.testProperties.Auto_gen_config)
Colin Cross8a497952019-03-05 22:25:09 -08002181 j.data = android.PathsForModuleSrc(ctx, j.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07002182
2183 j.Library.GenerateAndroidBuildActions(ctx)
Colin Cross05638fc2018-04-09 18:40:24 -07002184}
2185
Paul Duffin42df1442019-03-20 12:45:53 +00002186func (j *TestHelperLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2187 j.Library.GenerateAndroidBuildActions(ctx)
2188}
2189
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002190func (j *JavaTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2191 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.prebuiltTestProperties.Test_config, nil,
2192 j.prebuiltTestProperties.Test_suites, nil)
2193
2194 j.Import.GenerateAndroidBuildActions(ctx)
2195}
2196
2197type testSdkMemberType struct {
2198 android.SdkMemberTypeBase
2199}
2200
2201func (mt *testSdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
2202 mctx.AddVariationDependencies(nil, dependencyTag, names...)
2203}
2204
2205func (mt *testSdkMemberType) IsInstance(module android.Module) bool {
2206 _, ok := module.(*Test)
2207 return ok
2208}
2209
Paul Duffin17ab8832020-03-19 16:11:18 +00002210func (mt *testSdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
2211 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_test_import")
Paul Duffind76209b2020-03-02 11:33:02 +00002212}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002213
Paul Duffind76209b2020-03-02 11:33:02 +00002214func (mt *testSdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
2215 return &testSdkMemberProperties{}
2216}
2217
2218type testSdkMemberProperties struct {
2219 android.SdkMemberPropertiesBase
2220
Paul Duffinc9103932020-03-17 21:04:24 +00002221 JarToExport android.Path
2222 TestConfig android.Path
Paul Duffind76209b2020-03-02 11:33:02 +00002223}
2224
Paul Duffin17ab8832020-03-19 16:11:18 +00002225func (p *testSdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffind76209b2020-03-02 11:33:02 +00002226 test := variant.(*Test)
2227
2228 implementationJars := test.ImplementationJars()
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002229 if len(implementationJars) != 1 {
Paul Duffind76209b2020-03-02 11:33:02 +00002230 panic(fmt.Errorf("there must be only one implementation jar from %q", test.Name()))
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002231 }
2232
Paul Duffinc9103932020-03-17 21:04:24 +00002233 p.JarToExport = implementationJars[0]
2234 p.TestConfig = test.testConfig
Paul Duffind76209b2020-03-02 11:33:02 +00002235}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002236
Paul Duffin17ab8832020-03-19 16:11:18 +00002237func (p *testSdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffinc9103932020-03-17 21:04:24 +00002238 builder := ctx.SnapshotBuilder()
Paul Duffin17ab8832020-03-19 16:11:18 +00002239
Paul Duffinc9103932020-03-17 21:04:24 +00002240 exportedJar := p.JarToExport
2241 if exportedJar != nil {
2242 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
2243 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
Paul Duffind76209b2020-03-02 11:33:02 +00002244
2245 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
Paul Duffinc9103932020-03-17 21:04:24 +00002246 }
2247
2248 testConfig := p.TestConfig
2249 if testConfig != nil {
2250 snapshotRelativeTestConfigPath := sdkSnapshotFilePathForMember(p.OsPrefix(), ctx.Name(), testConfigSuffix)
2251 builder.CopyToSnapshot(testConfig, snapshotRelativeTestConfigPath)
Paul Duffind76209b2020-03-02 11:33:02 +00002252 propertySet.AddProperty("test_config", snapshotRelativeTestConfigPath)
2253 }
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002254}
2255
Colin Cross1b16b0e2019-02-12 14:41:32 -08002256// java_test builds a and links sources into a `.jar` file for the device, and possibly for the host as well, and
2257// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
2258//
2259// By default, a java_test has a single variant that produces a `.jar` file containing `classes.dex` files that were
2260// compiled against the device bootclasspath.
2261//
2262// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2263// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002264func TestFactory() android.Module {
2265 module := &Test{}
2266
Colin Cross1c14b4e2020-06-15 16:09:53 -07002267 module.addHostAndDeviceProperties()
2268 module.AddProperties(&module.testProperties)
Colin Cross05638fc2018-04-09 18:40:24 -07002269
Colin Cross9ae1b922018-06-26 17:59:05 -07002270 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse3026872019-01-05 22:30:13 -08002271 module.Module.dexpreopter.isTest = true
Colin Cross1e28e3c2020-06-02 20:09:13 -07002272 module.Module.linter.test = true
Colin Cross9ae1b922018-06-26 17:59:05 -07002273
Colin Cross05638fc2018-04-09 18:40:24 -07002274 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002275 return module
2276}
2277
Paul Duffin42df1442019-03-20 12:45:53 +00002278// java_test_helper_library creates a java library and makes sure that it is added to the appropriate test suite.
2279func TestHelperLibraryFactory() android.Module {
2280 module := &TestHelperLibrary{}
2281
Colin Cross1c14b4e2020-06-15 16:09:53 -07002282 module.addHostAndDeviceProperties()
2283 module.AddProperties(&module.testHelperLibraryProperties)
Paul Duffin42df1442019-03-20 12:45:53 +00002284
Colin Cross9a4abed2019-04-24 13:19:28 -07002285 module.Module.properties.Installable = proptools.BoolPtr(true)
2286 module.Module.dexpreopter.isTest = true
Colin Cross1e28e3c2020-06-02 20:09:13 -07002287 module.Module.linter.test = true
Colin Cross9a4abed2019-04-24 13:19:28 -07002288
Paul Duffin42df1442019-03-20 12:45:53 +00002289 InitJavaModule(module, android.HostAndDeviceSupported)
2290 return module
2291}
2292
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002293// java_test_import imports one or more `.jar` files into the build graph as if they were built by a java_test module
2294// and makes sure that it is added to the appropriate test suite.
2295//
2296// By default, a java_test_import has a single variant that expects a `.jar` file containing `.class` files that were
2297// compiled against an Android classpath.
2298//
2299// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2300// for host modules.
2301func JavaTestImportFactory() android.Module {
2302 module := &JavaTestImport{}
2303
2304 module.AddProperties(
2305 &module.Import.properties,
2306 &module.prebuiltTestProperties)
2307
2308 module.Import.properties.Installable = proptools.BoolPtr(true)
2309
2310 android.InitPrebuiltModule(module, &module.properties.Jars)
2311 android.InitApexModule(module)
2312 android.InitSdkAwareModule(module)
2313 InitJavaModule(module, android.HostAndDeviceSupported)
2314 return module
2315}
2316
Colin Cross1b16b0e2019-02-12 14:41:32 -08002317// java_test_host builds a and links sources into a `.jar` file for the host, and creates an `AndroidTest.xml` file to
2318// allow running the test with `atest` or a `TEST_MAPPING` file.
2319//
2320// A java_test_host has a single variant that produces a `.jar` file containing `.class` files that were
2321// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002322func TestHostFactory() android.Module {
2323 module := &Test{}
2324
Colin Cross1c14b4e2020-06-15 16:09:53 -07002325 module.addHostProperties()
2326 module.AddProperties(&module.testProperties)
Colin Cross05638fc2018-04-09 18:40:24 -07002327
Colin Cross9ae1b922018-06-26 17:59:05 -07002328 module.Module.properties.Installable = proptools.BoolPtr(true)
2329
Colin Cross05638fc2018-04-09 18:40:24 -07002330 InitJavaModule(module, android.HostSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002331 return module
2332}
2333
2334//
Colin Cross2fe66872015-03-30 17:20:39 -07002335// Java Binaries (.jar file plus wrapper script)
2336//
2337
Colin Crossf506d872017-07-19 15:53:04 -07002338type binaryProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -07002339 // installable script to execute the resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -08002340 Wrapper *string `android:"path"`
Colin Cross094054a2018-10-17 15:10:48 -07002341
2342 // Name of the class containing main to be inserted into the manifest as Main-Class.
2343 Main_class *string
Colin Cross7d5136f2015-05-11 13:39:40 -07002344}
2345
Colin Crossf506d872017-07-19 15:53:04 -07002346type Binary struct {
2347 Library
Colin Cross2fe66872015-03-30 17:20:39 -07002348
Colin Crossf506d872017-07-19 15:53:04 -07002349 binaryProperties binaryProperties
Colin Cross10a03492017-08-10 17:09:43 -07002350
Colin Cross6b4a32d2017-12-05 13:42:45 -08002351 isWrapperVariant bool
2352
Colin Crossc3315992017-12-08 19:12:36 -08002353 wrapperFile android.Path
Colin Cross70dda7e2019-10-01 22:05:35 -07002354 binaryFile android.InstallPath
Colin Cross2fe66872015-03-30 17:20:39 -07002355}
2356
Alex Light24237172017-10-26 09:46:21 -07002357func (j *Binary) HostToolPath() android.OptionalPath {
2358 return android.OptionalPathForPath(j.binaryFile)
2359}
2360
Colin Crossf506d872017-07-19 15:53:04 -07002361func (j *Binary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002362 if ctx.Arch().ArchType == android.Common {
2363 // Compile the jar
Colin Cross094054a2018-10-17 15:10:48 -07002364 if j.binaryProperties.Main_class != nil {
2365 if j.properties.Manifest != nil {
2366 ctx.PropertyErrorf("main_class", "main_class cannot be used when manifest is set")
2367 }
2368 manifestFile := android.PathForModuleOut(ctx, "manifest.txt")
2369 GenerateMainClassManifest(ctx, manifestFile, String(j.binaryProperties.Main_class))
2370 j.overrideManifest = android.OptionalPathForPath(manifestFile)
2371 }
2372
Colin Cross6b4a32d2017-12-05 13:42:45 -08002373 j.Library.GenerateAndroidBuildActions(ctx)
Nan Zhang3c807db2017-11-03 14:53:31 -07002374 } else {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002375 // Handle the binary wrapper
2376 j.isWrapperVariant = true
2377
Colin Cross366938f2017-12-11 16:29:02 -08002378 if j.binaryProperties.Wrapper != nil {
Colin Cross8a497952019-03-05 22:25:09 -08002379 j.wrapperFile = android.PathForModuleSrc(ctx, *j.binaryProperties.Wrapper)
Colin Cross6b4a32d2017-12-05 13:42:45 -08002380 } else {
2381 j.wrapperFile = android.PathForSource(ctx, "build/soong/scripts/jar-wrapper.sh")
2382 }
2383
2384 // Depend on the installed jar so that the wrapper doesn't get executed by
2385 // another build rule before the jar has been installed.
2386 jarFile := ctx.PrimaryModule().(*Binary).installFile
2387
2388 j.binaryFile = ctx.InstallExecutable(android.PathForModuleInstall(ctx, "bin"),
2389 ctx.ModuleName(), j.wrapperFile, jarFile)
Nan Zhang3c807db2017-11-03 14:53:31 -07002390 }
Colin Cross2fe66872015-03-30 17:20:39 -07002391}
2392
Colin Crossf506d872017-07-19 15:53:04 -07002393func (j *Binary) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002394 if ctx.Arch().ArchType == android.Common {
2395 j.deps(ctx)
2396 }
Colin Cross46c9b8b2017-06-22 16:51:17 -07002397}
2398
Colin Cross1b16b0e2019-02-12 14:41:32 -08002399// java_binary builds a `.jar` file and a shell script that executes it for the device, and possibly for the host
2400// as well.
2401//
2402// By default, a java_binary has a single variant that produces a `.jar` file containing `classes.dex` files that were
2403// compiled against the device bootclasspath.
2404//
2405// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2406// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002407func BinaryFactory() android.Module {
2408 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002409
Colin Cross1c14b4e2020-06-15 16:09:53 -07002410 module.addHostAndDeviceProperties()
2411 module.AddProperties(&module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002412
Colin Cross9ae1b922018-06-26 17:59:05 -07002413 module.Module.properties.Installable = proptools.BoolPtr(true)
2414
Colin Cross6b4a32d2017-12-05 13:42:45 -08002415 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibCommonFirst)
2416 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002417 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002418}
2419
Colin Cross1b16b0e2019-02-12 14:41:32 -08002420// java_binary_host builds a `.jar` file and a shell script that executes it for the host.
2421//
2422// A java_binary_host has a single variant that produces a `.jar` file containing `.class` files that were
2423// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002424func BinaryHostFactory() android.Module {
2425 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002426
Colin Cross1c14b4e2020-06-15 16:09:53 -07002427 module.addHostProperties()
2428 module.AddProperties(&module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002429
Colin Cross9ae1b922018-06-26 17:59:05 -07002430 module.Module.properties.Installable = proptools.BoolPtr(true)
2431
Colin Cross6b4a32d2017-12-05 13:42:45 -08002432 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommonFirst)
2433 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002434 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002435}
2436
2437//
2438// Java prebuilts
2439//
2440
Colin Cross74d73e22017-08-02 11:05:49 -07002441type ImportProperties struct {
Paul Duffin9b358d72020-03-02 10:16:35 +00002442 Jars []string `android:"path,arch_variant"`
Colin Cross461bd1a2017-10-20 13:59:18 -07002443
Nan Zhangea568a42017-11-08 21:20:04 -08002444 Sdk_version *string
Colin Cross535e2cf2017-10-20 17:57:49 -07002445
2446 Installable *bool
Jiyong Park1be96912018-05-28 18:02:19 +09002447
2448 // List of shared java libs that this module has dependencies to
2449 Libs []string
Colin Cross37f6d792018-07-12 12:28:41 -07002450
2451 // List of files to remove from the jar file(s)
2452 Exclude_files []string
2453
2454 // List of directories to remove from the jar file(s)
2455 Exclude_dirs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -07002456
2457 // if set to true, run Jetifier against .jar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -07002458 Jetifier *bool
Jiyong Park4c4c0242019-10-21 14:53:15 +09002459
2460 // set the name of the output
2461 Stem *string
Colin Cross74d73e22017-08-02 11:05:49 -07002462}
2463
2464type Import struct {
Colin Cross635c3b02016-05-18 15:37:25 -07002465 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -07002466 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002467 android.ApexModuleBase
Colin Crossec7a0422017-07-07 14:47:12 -07002468 prebuilt android.Prebuilt
Jiyong Parkd1063c12019-07-17 20:08:41 +09002469 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -07002470
Paul Duffinc8f2f182020-05-17 08:34:50 +01002471 // Functionality common to Module and Import.
2472 embeddableInModuleAndImport
2473
Colin Cross74d73e22017-08-02 11:05:49 -07002474 properties ImportProperties
2475
Colin Cross0a6e0072017-08-30 14:24:55 -07002476 combinedClasspathFile android.Path
Jiyong Park1be96912018-05-28 18:02:19 +09002477 exportedSdkLibs []string
Colin Cross2fe66872015-03-30 17:20:39 -07002478}
2479
Jiyong Park6a927c42020-01-21 02:03:43 +09002480func (j *Import) sdkVersion() sdkSpec {
2481 return sdkSpecFrom(String(j.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07002482}
2483
Jiyong Park6a927c42020-01-21 02:03:43 +09002484func (j *Import) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -07002485 return j.sdkVersion()
2486}
2487
Artur Satayev388d39b2020-04-27 18:53:18 +01002488func (j *Import) MinSdkVersion() string {
2489 return j.minSdkVersion().version.String()
2490}
2491
Colin Cross74d73e22017-08-02 11:05:49 -07002492func (j *Import) Prebuilt() *android.Prebuilt {
Colin Crossec7a0422017-07-07 14:47:12 -07002493 return &j.prebuilt
2494}
2495
Colin Cross74d73e22017-08-02 11:05:49 -07002496func (j *Import) PrebuiltSrcs() []string {
2497 return j.properties.Jars
2498}
2499
2500func (j *Import) Name() string {
Colin Cross5ea9bcc2017-07-27 15:41:32 -07002501 return j.prebuilt.Name(j.ModuleBase.Name())
2502}
2503
Jiyong Park0b238752019-10-29 11:23:10 +09002504func (j *Import) Stem() string {
2505 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2506}
2507
Jiyong Park618922e2020-01-08 13:35:43 +09002508func (a *Import) JacocoReportClassesFile() android.Path {
2509 return nil
2510}
2511
Colin Cross74d73e22017-08-02 11:05:49 -07002512func (j *Import) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross42d48b72018-08-29 14:10:52 -07002513 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Colin Cross1e676be2016-10-12 14:38:15 -07002514}
2515
Colin Cross74d73e22017-08-02 11:05:49 -07002516func (j *Import) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross8a497952019-03-05 22:25:09 -08002517 jars := android.PathsForModuleSrc(ctx, j.properties.Jars)
Colin Crosse1d62a82015-04-03 16:53:05 -07002518
Jiyong Park0b238752019-10-29 11:23:10 +09002519 jarName := j.Stem() + ".jar"
Nan Zhang4c819fb2018-08-27 18:31:46 -07002520 outputFile := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07002521 TransformJarsToJar(ctx, outputFile, "for prebuilts", jars, android.OptionalPath{},
2522 false, j.properties.Exclude_files, j.properties.Exclude_dirs)
Colin Cross1001a792019-03-21 22:21:39 -07002523 if Bool(j.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -07002524 inputFile := outputFile
2525 outputFile = android.PathForModuleOut(ctx, "jetifier", jarName)
2526 TransformJetifier(ctx, outputFile, inputFile)
2527 }
Colin Crosse9a275b2017-10-16 17:09:48 -07002528 j.combinedClasspathFile = outputFile
Jiyong Park1be96912018-05-28 18:02:19 +09002529
Paul Duffin64e61992020-05-15 10:20:31 +01002530 // If this is a component library (impl, stubs, etc.) for a java_sdk_library then
2531 // add the name of that java_sdk_library to the exported sdk libs to make sure
2532 // that, if necessary, a <uses-library> element for that java_sdk_library is
2533 // added to the Android manifest.
2534 j.exportedSdkLibs = append(j.exportedSdkLibs, j.OptionalImplicitSdkLibrary()...)
2535
Jiyong Park1be96912018-05-28 18:02:19 +09002536 ctx.VisitDirectDeps(func(module android.Module) {
2537 otherName := ctx.OtherModuleName(module)
2538 tag := ctx.OtherModuleDependencyTag(module)
2539
2540 switch dep := module.(type) {
2541 case Dependency:
2542 switch tag {
2543 case libTag, staticLibTag:
2544 // sdk lib names from dependencies are re-exported
2545 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
2546 }
2547 case SdkLibraryDependency:
2548 switch tag {
2549 case libTag:
2550 // names of sdk libs that are directly depended are exported
2551 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
2552 }
2553 }
2554 })
2555
2556 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002557 if Bool(j.properties.Installable) {
2558 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Park4c4c0242019-10-21 14:53:15 +09002559 jarName, outputFile)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002560 }
Colin Cross2fe66872015-03-30 17:20:39 -07002561}
2562
Colin Cross74d73e22017-08-02 11:05:49 -07002563var _ Dependency = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002564
Nan Zhanged19fc32017-10-19 13:06:22 -07002565func (j *Import) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002566 if j.combinedClasspathFile == nil {
2567 return nil
2568 }
Colin Cross37f6d792018-07-12 12:28:41 -07002569 return android.Paths{j.combinedClasspathFile}
Nan Zhanged19fc32017-10-19 13:06:22 -07002570}
2571
2572func (j *Import) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08002573 if j.combinedClasspathFile == nil {
2574 return nil
2575 }
Colin Cross37f6d792018-07-12 12:28:41 -07002576 return android.Paths{j.combinedClasspathFile}
Colin Cross2fe66872015-03-30 17:20:39 -07002577}
2578
Colin Cross331a1212018-08-15 20:40:52 -07002579func (j *Import) ResourceJars() android.Paths {
2580 return nil
2581}
2582
2583func (j *Import) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002584 if j.combinedClasspathFile == nil {
2585 return nil
2586 }
Colin Cross331a1212018-08-15 20:40:52 -07002587 return android.Paths{j.combinedClasspathFile}
2588}
2589
Colin Crossf24a22a2019-01-31 14:12:44 -08002590func (j *Import) DexJar() android.Path {
2591 return nil
2592}
2593
Colin Cross74d73e22017-08-02 11:05:49 -07002594func (j *Import) AidlIncludeDirs() android.Paths {
Colin Crossc0b06f12015-04-08 13:03:43 -07002595 return nil
2596}
2597
Jiyong Park1be96912018-05-28 18:02:19 +09002598func (j *Import) ExportedSdkLibs() []string {
2599 return j.exportedSdkLibs
2600}
2601
Artur Satayev9cf46692019-11-26 18:08:34 +00002602func (j *Import) ExportedPlugins() (android.Paths, []string) {
2603 return nil, nil
2604}
2605
Colin Cross0c4ce212019-05-03 15:28:19 -07002606func (j *Import) SrcJarArgs() ([]string, android.Paths) {
2607 return nil, nil
2608}
2609
Jiyong Park0f80c182020-01-31 02:49:53 +09002610func (j *Import) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffinc8f2f182020-05-17 08:34:50 +01002611 return j.depIsInSameApex(ctx, dep)
Jiyong Park0f80c182020-01-31 02:49:53 +09002612}
2613
albaltai36ff7dc2018-12-25 14:35:23 +08002614// Add compile time check for interface implementation
2615var _ android.IDEInfo = (*Import)(nil)
2616var _ android.IDECustomizedModuleName = (*Import)(nil)
2617
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002618// Collect information for opening IDE project files in java/jdeps.go.
2619const (
2620 removedPrefix = "prebuilt_"
2621)
2622
2623func (j *Import) IDEInfo(dpInfo *android.IdeInfo) {
2624 dpInfo.Jars = append(dpInfo.Jars, j.PrebuiltSrcs()...)
2625}
2626
2627func (j *Import) IDECustomizedModuleName() string {
2628 // TODO(b/113562217): Extract the base module name from the Import name, often the Import name
2629 // has a prefix "prebuilt_". Remove the prefix explicitly if needed until we find a better
2630 // solution to get the Import name.
2631 name := j.Name()
2632 if strings.HasPrefix(name, removedPrefix) {
patricktubb640e02018-10-11 18:33:16 +08002633 name = strings.TrimPrefix(name, removedPrefix)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002634 }
2635 return name
2636}
2637
Colin Cross74d73e22017-08-02 11:05:49 -07002638var _ android.PrebuiltInterface = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002639
Colin Cross1b16b0e2019-02-12 14:41:32 -08002640// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library module.
2641//
2642// By default, a java_import has a single variant that expects a `.jar` file containing `.class` files that were
2643// compiled against an Android classpath.
2644//
2645// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2646// for host modules.
Colin Cross74d73e22017-08-02 11:05:49 -07002647func ImportFactory() android.Module {
2648 module := &Import{}
Colin Cross36242852017-06-23 15:06:31 -07002649
Colin Cross74d73e22017-08-02 11:05:49 -07002650 module.AddProperties(&module.properties)
2651
Paul Duffin64e61992020-05-15 10:20:31 +01002652 module.initModuleAndImport(&module.ModuleBase)
2653
Colin Cross74d73e22017-08-02 11:05:49 -07002654 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002655 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002656 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002657 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross36242852017-06-23 15:06:31 -07002658 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002659}
2660
Colin Cross1b16b0e2019-02-12 14:41:32 -08002661// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library_host
2662// module.
2663//
2664// A java_import_host has a single variant that expects a `.jar` file containing `.class` files that were
2665// compiled against a host bootclasspath.
Colin Cross74d73e22017-08-02 11:05:49 -07002666func ImportFactoryHost() android.Module {
2667 module := &Import{}
2668
2669 module.AddProperties(&module.properties)
2670
2671 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002672 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002673 InitJavaModule(module, android.HostSupported)
Colin Cross74d73e22017-08-02 11:05:49 -07002674 return module
2675}
2676
Colin Cross42be7612019-02-21 18:12:14 -08002677// dex_import module
2678
2679type DexImportProperties struct {
Colin Cross5cfc70d2019-07-15 13:36:55 -07002680 Jars []string `android:"path"`
Jiyong Park4c4c0242019-10-21 14:53:15 +09002681
2682 // set the name of the output
2683 Stem *string
Colin Cross42be7612019-02-21 18:12:14 -08002684}
2685
2686type DexImport struct {
2687 android.ModuleBase
2688 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002689 android.ApexModuleBase
Colin Cross42be7612019-02-21 18:12:14 -08002690 prebuilt android.Prebuilt
2691
2692 properties DexImportProperties
2693
2694 dexJarFile android.Path
2695 maybeStrippedDexJarFile android.Path
2696
2697 dexpreopter
2698}
2699
2700func (j *DexImport) Prebuilt() *android.Prebuilt {
2701 return &j.prebuilt
2702}
2703
2704func (j *DexImport) PrebuiltSrcs() []string {
2705 return j.properties.Jars
2706}
2707
2708func (j *DexImport) Name() string {
2709 return j.prebuilt.Name(j.ModuleBase.Name())
2710}
2711
Jiyong Park0b238752019-10-29 11:23:10 +09002712func (j *DexImport) Stem() string {
2713 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2714}
2715
Jiyong Park2cd081c2020-06-01 21:39:15 +09002716func (a *DexImport) JacocoReportClassesFile() android.Path {
2717 return nil
2718}
2719
Martin Stjernholm6d415272020-01-31 17:10:36 +00002720func (j *DexImport) IsInstallable() bool {
2721 return true
2722}
2723
Colin Cross42be7612019-02-21 18:12:14 -08002724func (j *DexImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2725 if len(j.properties.Jars) != 1 {
2726 ctx.PropertyErrorf("jars", "exactly one jar must be provided")
2727 }
2728
Jiyong Park0b238752019-10-29 11:23:10 +09002729 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross42be7612019-02-21 18:12:14 -08002730 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
2731
2732 inputJar := ctx.ExpandSource(j.properties.Jars[0], "jars")
2733 dexOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar")
2734
2735 if j.dexpreopter.uncompressedDex {
2736 rule := android.NewRuleBuilder()
2737
2738 temporary := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar.unaligned")
2739 rule.Temporary(temporary)
2740
2741 // use zip2zip to uncompress classes*.dex files
2742 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002743 BuiltTool(ctx, "zip2zip").
Colin Cross42be7612019-02-21 18:12:14 -08002744 FlagWithInput("-i ", inputJar).
2745 FlagWithOutput("-o ", temporary).
2746 FlagWithArg("-0 ", "'classes*.dex'")
2747
2748 // use zipalign to align uncompressed classes*.dex files
2749 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002750 BuiltTool(ctx, "zipalign").
Colin Cross42be7612019-02-21 18:12:14 -08002751 Flag("-f").
2752 Text("4").
2753 Input(temporary).
2754 Output(dexOutputFile)
2755
2756 rule.DeleteTemporaryFiles()
2757
2758 rule.Build(pctx, ctx, "uncompress_dex", "uncompress dex")
2759 } else {
2760 ctx.Build(pctx, android.BuildParams{
2761 Rule: android.Cp,
2762 Input: inputJar,
2763 Output: dexOutputFile,
2764 })
2765 }
2766
2767 j.dexJarFile = dexOutputFile
2768
2769 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
2770
2771 j.maybeStrippedDexJarFile = dexOutputFile
2772
Jiyong Parkafd3d112020-06-08 19:24:09 +09002773 if j.IsForPlatform() {
2774 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
2775 j.Stem()+".jar", dexOutputFile)
2776 }
Colin Cross42be7612019-02-21 18:12:14 -08002777}
2778
2779func (j *DexImport) DexJar() android.Path {
2780 return j.dexJarFile
2781}
2782
2783// dex_import imports a `.jar` file containing classes.dex files.
2784//
2785// A dex_import module cannot be used as a dependency of a java_* or android_* module, it can only be installed
2786// to the device.
2787func DexImportFactory() android.Module {
2788 module := &DexImport{}
2789
2790 module.AddProperties(&module.properties)
2791
2792 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002793 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002794 InitJavaModule(module, android.DeviceSupported)
Colin Cross42be7612019-02-21 18:12:14 -08002795 return module
2796}
2797
Colin Cross89536d42017-07-07 14:35:50 -07002798//
2799// Defaults
2800//
2801type Defaults struct {
2802 android.ModuleBase
2803 android.DefaultsModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002804 android.ApexModuleBase
Colin Cross89536d42017-07-07 14:35:50 -07002805}
2806
Colin Cross1b16b0e2019-02-12 14:41:32 -08002807// java_defaults provides a set of properties that can be inherited by other java or android modules.
2808//
2809// A module can use the properties from a java_defaults module using `defaults: ["defaults_module_name"]`. Each
2810// property in the defaults module that exists in the depending module will be prepended to the depending module's
2811// value for that property.
2812//
2813// Example:
2814//
2815// java_defaults {
2816// name: "example_defaults",
2817// srcs: ["common/**/*.java"],
2818// javacflags: ["-Xlint:all"],
2819// aaptflags: ["--auto-add-overlay"],
2820// }
2821//
2822// java_library {
2823// name: "example",
2824// defaults: ["example_defaults"],
2825// srcs: ["example/**/*.java"],
2826// }
2827//
2828// is functionally identical to:
2829//
2830// java_library {
2831// name: "example",
2832// srcs: [
2833// "common/**/*.java",
2834// "example/**/*.java",
2835// ],
2836// javacflags: ["-Xlint:all"],
2837// }
Colin Cross89536d42017-07-07 14:35:50 -07002838func defaultsFactory() android.Module {
2839 return DefaultsFactory()
2840}
2841
Paul Duffin47357662019-12-05 14:07:14 +00002842func DefaultsFactory() android.Module {
Colin Cross89536d42017-07-07 14:35:50 -07002843 module := &Defaults{}
2844
Colin Cross89536d42017-07-07 14:35:50 -07002845 module.AddProperties(
2846 &CompilerProperties{},
2847 &CompilerDeviceProperties{},
Colin Cross43f08db2018-11-12 10:13:39 -08002848 &DexpreoptProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08002849 &android.ProtoProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002850 &aaptProperties{},
2851 &androidLibraryProperties{},
2852 &appProperties{},
2853 &appTestProperties{},
Jaewoong Jung525443a2019-02-28 15:35:54 -08002854 &overridableAppProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002855 &ImportProperties{},
2856 &AARImportProperties{},
2857 &sdkLibraryProperties{},
Paul Duffin1a724e62020-05-08 13:44:43 +01002858 &commonToSdkLibraryAndImportProperties{},
Colin Cross42be7612019-02-21 18:12:14 -08002859 &DexImportProperties{},
Jooyung Han18020ea2019-11-13 10:50:48 +09002860 &android.ApexProperties{},
Jaewoong Jung062ed7e2020-04-26 15:10:51 -07002861 &RuntimeResourceOverlayProperties{},
Colin Cross1e28e3c2020-06-02 20:09:13 -07002862 &LintProperties{},
Colin Cross89536d42017-07-07 14:35:50 -07002863 )
2864
2865 android.InitDefaultsModule(module)
Colin Cross89536d42017-07-07 14:35:50 -07002866 return module
2867}
Nan Zhangea568a42017-11-08 21:20:04 -08002868
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002869func kytheExtractJavaFactory() android.Singleton {
2870 return &kytheExtractJavaSingleton{}
2871}
2872
2873type kytheExtractJavaSingleton struct {
2874}
2875
2876func (ks *kytheExtractJavaSingleton) GenerateBuildActions(ctx android.SingletonContext) {
2877 var xrefTargets android.Paths
2878 ctx.VisitAllModules(func(module android.Module) {
2879 if javaModule, ok := module.(xref); ok {
2880 xrefTargets = append(xrefTargets, javaModule.XrefJavaFiles()...)
2881 }
2882 })
2883 // TODO(asmundak): perhaps emit a rule to output a warning if there were no xrefTargets
2884 if len(xrefTargets) > 0 {
Colin Cross98552072020-06-04 13:25:17 -07002885 ctx.Phony("xref_java", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002886 }
2887}
2888
Nan Zhangea568a42017-11-08 21:20:04 -08002889var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07002890var BoolDefault = proptools.BoolDefault
Nan Zhangea568a42017-11-08 21:20:04 -08002891var String = proptools.String
Colin Cross0d0ba592018-02-20 13:33:42 -08002892var inList = android.InList