blob: 2482f325de4a0e83960ea2af92a934244a7703a8 [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 Duffinf5c0a9c2020-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 Satayev8cf899a2020-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 Satayev2db1c3f2020-04-08 19:09:30 +010097func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
Colin Crossc2d24052020-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 Satayev2db1c3f2020-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 Cross540eff82017-06-22 17:01:52 -0700256}
257
Colin Cross89536d42017-07-07 14:35:50 -0700258type CompilerDeviceProperties struct {
Colin Cross540eff82017-06-22 17:01:52 -0700259 // list of module-specific flags that will be used for dex compiles
260 Dxflags []string `android:"arch_variant"`
261
Jeongik Cha538c0d02019-07-11 15:54:27 +0900262 // if not blank, set to the version of the sdk to compile against.
263 // Defaults to compiling against the current platform.
Nan Zhangea568a42017-11-08 21:20:04 -0800264 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700265
Colin Cross83bb3162018-06-25 15:48:06 -0700266 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
267 // Defaults to sdk_version if not set.
268 Min_sdk_version *string
269
Dan Willemsen419290a2018-10-31 15:28:47 -0700270 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
271 // Defaults to sdk_version if not set.
272 Target_sdk_version *string
273
Jeongik Cha356dac42019-08-19 14:09:52 +0900274 // Whether to compile against the platform APIs instead of an SDK.
275 // If true, then sdk_version must be empty. The value of this field
276 // is ignored when module's type isn't android_app.
Colin Cross6af2e492018-05-22 11:12:33 -0700277 Platform_apis *bool
278
Colin Crossebe1a512017-11-14 13:12:14 -0800279 Aidl struct {
280 // Top level directories to pass to aidl tool
281 Include_dirs []string
Colin Cross7d5136f2015-05-11 13:39:40 -0700282
Colin Crossebe1a512017-11-14 13:12:14 -0800283 // Directories rooted at the Android.bp file to pass to aidl tool
284 Local_include_dirs []string
285
286 // directories that should be added as include directories for any aidl sources of modules
287 // that depend on this module, as well as to aidl for this module.
288 Export_include_dirs []string
Martijn Coeneneab15642018-03-09 09:29:59 +0100289
290 // whether to generate traces (for systrace) for this interface
291 Generate_traces *bool
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100292
293 // whether to generate Binder#GetTransaction name method.
294 Generate_get_transaction_name *bool
Colin Crossebe1a512017-11-14 13:12:14 -0800295 }
Colin Cross92430102017-10-09 14:59:32 -0700296
297 // If true, export a copy of the module as a -hostdex module for host testing.
298 Hostdex *bool
Colin Cross1369cdb2017-09-29 17:58:17 -0700299
Colin Cross7f87f4f2019-04-24 13:41:45 -0700300 Target struct {
301 Hostdex struct {
302 // Additional required dependencies to add to -hostdex modules.
303 Required []string
304 }
305 }
306
David Brazdil17ef5632018-06-27 10:27:45 +0100307 // If set to true, compile dex regardless of installable. Defaults to false.
308 Compile_dex *bool
309
Colin Cross66dbc0b2017-12-28 12:23:20 -0800310 Optimize struct {
Colin Crossae5caf52018-05-22 11:11:52 -0700311 // If false, disable all optimization. Defaults to true for android_app and android_test
312 // modules, false for java_library and java_test modules.
Colin Cross66dbc0b2017-12-28 12:23:20 -0800313 Enabled *bool
Sasha Smundak2057f822019-04-16 17:16:58 -0700314 // True if the module containing this has it set by default.
315 EnabledByDefault bool `blueprint:"mutated"`
Colin Cross66dbc0b2017-12-28 12:23:20 -0800316
317 // If true, optimize for size by removing unused code. Defaults to true for apps,
318 // false for libraries and tests.
319 Shrink *bool
320
321 // If true, optimize bytecode. Defaults to false.
322 Optimize *bool
323
324 // If true, obfuscate bytecode. Defaults to false.
325 Obfuscate *bool
326
327 // If true, do not use the flag files generated by aapt that automatically keep
328 // classes referenced by the app manifest. Defaults to false.
329 No_aapt_flags *bool
330
331 // Flags to pass to proguard.
332 Proguard_flags []string
333
334 // Specifies the locations of files containing proguard flags.
Colin Cross27b922f2019-03-04 22:35:41 -0800335 Proguard_flags_files []string `android:"path"`
Colin Cross66dbc0b2017-12-28 12:23:20 -0800336 }
337
Paul Duffine25c6442019-10-11 13:50:28 +0100338 // When targeting 1.9 and above, override the modules to use with --system,
339 // otherwise provides defaults libraries to add to the bootclasspath.
Colin Cross1369cdb2017-09-29 17:58:17 -0700340 System_modules *string
Colin Cross5a0dcd52018-10-05 14:20:06 -0700341
Jiyong Park4c4c0242019-10-21 14:53:15 +0900342 // set the name of the output
343 Stem *string
344
Colin Cross5a0dcd52018-10-05 14:20:06 -0700345 UncompressDex bool `blueprint:"mutated"`
Colin Cross43f08db2018-11-12 10:13:39 -0800346 IsSDKLibrary bool `blueprint:"mutated"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700347}
348
Sasha Smundak2057f822019-04-16 17:16:58 -0700349func (me *CompilerDeviceProperties) EffectiveOptimizeEnabled() bool {
350 return BoolDefault(me.Optimize.Enabled, me.Optimize.EnabledByDefault)
351}
352
Paul Duffin0d3c2e12020-05-17 08:34:50 +0100353// Functionality common to Module and Import
354type embeddableInModuleAndImport struct {
355}
356
357// Module/Import's DepIsInSameApex(...) delegates to this method.
358//
359// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
360// the one provided by ApexModuleBase.
361func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
362 // dependencies other than the static linkage are all considered crossing APEX boundary
363 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
364 return true
365 }
366 return false
367}
368
Colin Cross46c9b8b2017-06-22 16:51:17 -0700369// Module contains the properties and members used by all java module types
370type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700371 android.ModuleBase
Colin Cross89536d42017-07-07 14:35:50 -0700372 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +0900373 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900374 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -0700375
Paul Duffin0d3c2e12020-05-17 08:34:50 +0100376 // Functionality common to Module and Import.
377 embeddableInModuleAndImport
378
Colin Cross89536d42017-07-07 14:35:50 -0700379 properties CompilerProperties
Colin Cross6af17aa2017-09-20 12:59:05 -0700380 protoProperties android.ProtoProperties
Colin Cross89536d42017-07-07 14:35:50 -0700381 deviceProperties CompilerDeviceProperties
Colin Cross2fe66872015-03-30 17:20:39 -0700382
Colin Cross331a1212018-08-15 20:40:52 -0700383 // jar file containing header classes including static library dependencies, suitable for
384 // inserting into the bootclasspath/classpath of another compile
Nan Zhanged19fc32017-10-19 13:06:22 -0700385 headerJarFile android.Path
386
Colin Cross331a1212018-08-15 20:40:52 -0700387 // jar file containing implementation classes including static library dependencies but no
388 // resources
Nan Zhanged19fc32017-10-19 13:06:22 -0700389 implementationJarFile android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700390
Colin Cross331a1212018-08-15 20:40:52 -0700391 // jar file containing only resources including from static library dependencies
392 resourceJar android.Path
393
Colin Cross0c4ce212019-05-03 15:28:19 -0700394 // args and dependencies to package source files into a srcjar
395 srcJarArgs []string
396 srcJarDeps android.Paths
397
Colin Cross331a1212018-08-15 20:40:52 -0700398 // jar file containing implementation classes and resources including static library
399 // dependencies
400 implementationAndResourcesJar android.Path
401
402 // output file containing classes.dex and resources
Colin Cross6ade34f2017-09-15 13:00:47 -0700403 dexJarFile android.Path
404
Colin Cross43f08db2018-11-12 10:13:39 -0800405 // output file that contains classes.dex if it should be in the output file
406 maybeStrippedDexJarFile android.Path
407
Colin Crosscb933592017-11-22 13:49:43 -0800408 // output file containing uninstrumented classes that will be instrumented by jacoco
409 jacocoReportClassesFile android.Path
410
Colin Cross66dbc0b2017-12-28 12:23:20 -0800411 // output file containing mapping of obfuscated names
412 proguardDictionary android.Path
413
Colin Cross331a1212018-08-15 20:40:52 -0700414 // output file of the module, which may be a classes jar or a dex jar
Colin Crosse560c4a2019-03-19 16:03:11 -0700415 outputFile android.Path
416 extraOutputFiles android.Paths
Colin Crossb7a63242015-04-16 14:09:14 -0700417
Colin Cross635c3b02016-05-18 15:37:25 -0700418 exportAidlIncludeDirs android.Paths
Colin Crossc0b06f12015-04-08 13:03:43 -0700419
Colin Cross635c3b02016-05-18 15:37:25 -0700420 logtagsSrcs android.Paths
Colin Crossf05fe972015-04-10 17:45:20 -0700421
Colin Cross2fe66872015-03-30 17:20:39 -0700422 // installed file for binary dependency
Colin Cross635c3b02016-05-18 15:37:25 -0700423 installFile android.Path
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800424
425 // list of .java files and srcjars that was passed to javac
426 compiledJavaSrcs android.Paths
427 compiledSrcJars android.Paths
Colin Cross66dbc0b2017-12-28 12:23:20 -0800428
429 // list of extra progurad flag files
430 extraProguardFlagFiles android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900431
Colin Cross094054a2018-10-17 15:10:48 -0700432 // manifest file to use instead of properties.Manifest
433 overrideManifest android.OptionalPath
434
Artur Satayev9cf46692019-11-26 18:08:34 +0000435 // list of SDK lib names that this java module is exporting
Jiyong Park1be96912018-05-28 18:02:19 +0900436 exportedSdkLibs []string
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700437
Artur Satayev9cf46692019-11-26 18:08:34 +0000438 // list of plugins that this java module is exporting
439 exportedPluginJars android.Paths
440
441 // list of plugins that this java module is exporting
442 exportedPluginClasses []string
443
444 // list of source files, collected from srcFiles with unique java and all kt files,
patricktu242faad2019-09-24 15:41:30 +0800445 // will be used by android.IDEInfo struct
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700446 expandIDEInfoCompiledSrcs []string
Colin Cross43f08db2018-11-12 10:13:39 -0800447
Steven Morelandc4efd9c2019-01-18 11:51:25 -0800448 // expanded Jarjar_rules
449 expandJarjarRules android.Path
450
Vladimir Marko0975ee02019-04-02 10:29:55 +0100451 // list of additional targets for checkbuild
452 additionalCheckedModules android.Paths
453
Colin Cross988708c2019-05-06 14:04:11 -0700454 // Extra files generated by the module type to be added as java resources.
455 extraResources android.Paths
456
Colin Crossf24a22a2019-01-31 14:12:44 -0800457 hiddenAPI
Colin Cross43f08db2018-11-12 10:13:39 -0800458 dexpreopter
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800459
460 // list of the xref extraction files
461 kytheFiles android.Paths
Anton Hansson78156ef2020-03-27 19:39:48 +0000462
463 distFile android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700464}
465
Colin Cross41955e82019-05-29 14:40:35 -0700466func (j *Module) OutputFiles(tag string) (android.Paths, error) {
467 switch tag {
468 case "":
469 return append(android.Paths{j.outputFile}, j.extraOutputFiles...), nil
Colin Cross375ca3c2019-05-29 14:40:58 -0700470 case ".jar":
471 return android.Paths{j.implementationAndResourcesJar}, nil
Colin Cross2d975b12019-07-29 16:47:42 -0700472 case ".proguard_map":
473 return android.Paths{j.proguardDictionary}, nil
Colin Cross41955e82019-05-29 14:40:35 -0700474 default:
475 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
476 }
Colin Cross54250902017-12-05 09:28:08 -0800477}
478
Colin Cross41955e82019-05-29 14:40:35 -0700479var _ android.OutputFileProducer = (*Module)(nil)
Colin Cross54250902017-12-05 09:28:08 -0800480
Colin Crossf506d872017-07-19 15:53:04 -0700481type Dependency interface {
Nan Zhanged19fc32017-10-19 13:06:22 -0700482 HeaderJars() android.Paths
483 ImplementationJars() android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700484 ResourceJars() android.Paths
485 ImplementationAndResourcesJars() android.Paths
Colin Crossf24a22a2019-01-31 14:12:44 -0800486 DexJar() android.Path
Colin Cross635c3b02016-05-18 15:37:25 -0700487 AidlIncludeDirs() android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900488 ExportedSdkLibs() []string
Artur Satayev9cf46692019-11-26 18:08:34 +0000489 ExportedPlugins() (android.Paths, []string)
Colin Cross0c4ce212019-05-03 15:28:19 -0700490 SrcJarArgs() ([]string, android.Paths)
Colin Crosse323f3c2019-09-17 15:34:09 -0700491 BaseModuleName() string
Jiyong Park618922e2020-01-08 13:35:43 +0900492 JacocoReportClassesFile() android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700493}
494
Jiyong Parkc678ad32018-04-10 13:07:10 +0900495type SdkLibraryDependency interface {
Jiyong Park6a927c42020-01-21 02:03:43 +0900496 SdkHeaderJars(ctx android.BaseModuleContext, sdkVersion sdkSpec) android.Paths
497 SdkImplementationJars(ctx android.BaseModuleContext, sdkVersion sdkSpec) android.Paths
Jiyong Parkc678ad32018-04-10 13:07:10 +0900498}
499
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800500type xref interface {
501 XrefJavaFiles() android.Paths
502}
503
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800504func (j *Module) XrefJavaFiles() android.Paths {
505 return j.kytheFiles
506}
507
Colin Cross89536d42017-07-07 14:35:50 -0700508func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
509 android.InitAndroidArchModule(module, hod, android.MultilibCommon)
510 android.InitDefaultableModule(module)
511}
512
Colin Crossbe1da472017-07-07 15:59:46 -0700513type dependencyTag struct {
514 blueprint.BaseDependencyTag
515 name string
Colin Cross2fe66872015-03-30 17:20:39 -0700516}
517
Colin Crossa4f08812018-10-02 22:03:40 -0700518type jniDependencyTag struct {
519 blueprint.BaseDependencyTag
Colin Crossa4f08812018-10-02 22:03:40 -0700520}
521
Jiyong Park8be103b2019-11-08 15:53:48 +0900522func IsJniDepTag(depTag blueprint.DependencyTag) bool {
523 _, ok := depTag.(*jniDependencyTag)
524 return ok
525}
526
Colin Crossbe1da472017-07-07 15:59:46 -0700527var (
Colin Cross4b964c02018-10-15 16:18:06 -0700528 staticLibTag = dependencyTag{name: "staticlib"}
529 libTag = dependencyTag{name: "javalib"}
Colin Cross6cef4812019-10-17 14:23:50 -0700530 java9LibTag = dependencyTag{name: "java9lib"}
Colin Crossbe9cdb82019-01-21 21:37:16 -0800531 pluginTag = dependencyTag{name: "plugin"}
Artur Satayev9cf46692019-11-26 18:08:34 +0000532 exportedPluginTag = dependencyTag{name: "exported-plugin"}
Colin Cross4b964c02018-10-15 16:18:06 -0700533 bootClasspathTag = dependencyTag{name: "bootclasspath"}
534 systemModulesTag = dependencyTag{name: "system modules"}
535 frameworkResTag = dependencyTag{name: "framework-res"}
536 frameworkApkTag = dependencyTag{name: "framework-apk"}
537 kotlinStdlibTag = dependencyTag{name: "kotlin-stdlib"}
Colin Crossafbb1732019-01-17 15:42:52 -0800538 kotlinAnnotationsTag = dependencyTag{name: "kotlin-annotations"}
Colin Cross4b964c02018-10-15 16:18:06 -0700539 proguardRaiseTag = dependencyTag{name: "proguard-raise"}
540 certificateTag = dependencyTag{name: "certificate"}
541 instrumentationForTag = dependencyTag{name: "instrumentation_for"}
Colin Cross50ddcc42019-05-16 12:28:22 -0700542 usesLibTag = dependencyTag{name: "uses-library"}
Colin Crossbe1da472017-07-07 15:59:46 -0700543)
Colin Cross2fe66872015-03-30 17:20:39 -0700544
Jiyong Park83dc74b2020-01-14 18:38:44 +0900545func IsLibDepTag(depTag blueprint.DependencyTag) bool {
546 return depTag == libTag
547}
548
549func IsStaticLibDepTag(depTag blueprint.DependencyTag) bool {
550 return depTag == staticLibTag
551}
552
Colin Crossfc3674a2017-09-18 17:41:52 -0700553type sdkDep struct {
Colin Cross47ff2522017-10-02 14:22:08 -0700554 useModule, useFiles, useDefaultLibs, invalidVersion bool
555
Colin Cross6cef4812019-10-17 14:23:50 -0700556 // The modules that will be added to the bootclasspath when targeting 1.8 or lower
557 bootclasspath []string
Paul Duffine25c6442019-10-11 13:50:28 +0100558
559 // The default system modules to use. Will be an empty string if no system
560 // modules are to be used.
Colin Cross1369cdb2017-09-29 17:58:17 -0700561 systemModules string
562
Colin Cross6cef4812019-10-17 14:23:50 -0700563 // The modules that will be added ot the classpath when targeting 1.9 or higher
564 java9Classpath []string
565
Colin Crossa97c5d32018-03-28 14:58:31 -0700566 frameworkResModule string
567
Colin Cross86a60ae2018-05-29 14:44:55 -0700568 jars android.Paths
Colin Cross3047fa22019-04-18 10:56:44 -0700569 aidl android.OptionalPath
Paul Duffin250e6192019-06-07 10:44:37 +0100570
571 noStandardLibs, noFrameworksLibs bool
572}
573
574func (s sdkDep) hasStandardLibs() bool {
575 return !s.noStandardLibs
576}
577
578func (s sdkDep) hasFrameworkLibs() bool {
579 return !s.noStandardLibs && !s.noFrameworksLibs
Colin Cross1369cdb2017-09-29 17:58:17 -0700580}
581
Colin Crossa4f08812018-10-02 22:03:40 -0700582type jniLib struct {
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700583 name string
584 path android.Path
585 target android.Target
586 coverageFile android.OptionalPath
Colin Crossa4f08812018-10-02 22:03:40 -0700587}
588
Colin Cross0ea8ba82019-06-06 14:33:29 -0700589func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800590 return j.properties.Instrument && ctx.Config().IsEnvTrue("EMMA_INSTRUMENT")
591}
592
Colin Cross0ea8ba82019-06-06 14:33:29 -0700593func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800594 return j.shouldInstrument(ctx) &&
595 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
596 ctx.Config().UnbundledBuild())
597}
598
Jiyong Park6a927c42020-01-21 02:03:43 +0900599func (j *Module) sdkVersion() sdkSpec {
600 return sdkSpecFrom(String(j.deviceProperties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -0700601}
602
Paul Duffine25c6442019-10-11 13:50:28 +0100603func (j *Module) systemModules() string {
604 return proptools.String(j.deviceProperties.System_modules)
605}
606
Jiyong Park6a927c42020-01-21 02:03:43 +0900607func (j *Module) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -0700608 if j.deviceProperties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900609 return sdkSpecFrom(*j.deviceProperties.Min_sdk_version)
Colin Cross83bb3162018-06-25 15:48:06 -0700610 }
611 return j.sdkVersion()
612}
613
Jiyong Park6a927c42020-01-21 02:03:43 +0900614func (j *Module) targetSdkVersion() sdkSpec {
Dan Willemsen419290a2018-10-31 15:28:47 -0700615 if j.deviceProperties.Target_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900616 return sdkSpecFrom(*j.deviceProperties.Target_sdk_version)
Dan Willemsen419290a2018-10-31 15:28:47 -0700617 }
618 return j.sdkVersion()
619}
620
Artur Satayev480e25b2020-04-27 18:53:18 +0100621func (j *Module) MinSdkVersion() string {
622 return j.minSdkVersion().version.String()
623}
624
Jiyong Parkb02bb402019-12-03 00:43:57 +0900625func (j *Module) AvailableFor(what string) bool {
626 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
627 // Exception: for hostdex: true libraries, the platform variant is created
628 // even if it's not marked as available to platform. In that case, the platform
629 // variant is used only for the hostdex and not installed to the device.
630 return true
631 }
632 return j.ApexModuleBase.AvailableFor(what)
633}
634
Colin Crossbe1da472017-07-07 15:59:46 -0700635func (j *Module) deps(ctx android.BottomUpMutatorContext) {
Colin Cross1369cdb2017-09-29 17:58:17 -0700636 if ctx.Device() {
Paul Duffin250e6192019-06-07 10:44:37 +0100637 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross6d8d8c62019-10-28 15:10:03 -0700638 if sdkDep.useDefaultLibs {
639 ctx.AddVariationDependencies(nil, bootClasspathTag, config.DefaultBootclasspathLibraries...)
640 ctx.AddVariationDependencies(nil, systemModulesTag, config.DefaultSystemModules)
641 if sdkDep.hasFrameworkLibs() {
642 ctx.AddVariationDependencies(nil, libTag, config.DefaultLibraries...)
Colin Crossbe1da472017-07-07 15:59:46 -0700643 }
Colin Cross6d8d8c62019-10-28 15:10:03 -0700644 } else if sdkDep.useModule {
Colin Cross6cef4812019-10-17 14:23:50 -0700645 ctx.AddVariationDependencies(nil, bootClasspathTag, sdkDep.bootclasspath...)
Paul Duffine25c6442019-10-11 13:50:28 +0100646 ctx.AddVariationDependencies(nil, systemModulesTag, sdkDep.systemModules)
Colin Cross6cef4812019-10-17 14:23:50 -0700647 ctx.AddVariationDependencies(nil, java9LibTag, sdkDep.java9Classpath...)
Colin Cross6d8d8c62019-10-28 15:10:03 -0700648 if j.deviceProperties.EffectiveOptimizeEnabled() && sdkDep.hasStandardLibs() {
649 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultBootclasspathLibraries...)
650 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultLibraries...)
651 }
Colin Cross2fe66872015-03-30 17:20:39 -0700652 }
Colin Cross6d8d8c62019-10-28 15:10:03 -0700653
Nan Zhangb2b33de2018-02-23 11:18:47 -0800654 if ctx.ModuleName() == "android_stubs_current" ||
655 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -0700656 ctx.ModuleName() == "android_test_stubs_current" {
Colin Cross42d48b72018-08-29 14:10:52 -0700657 ctx.AddVariationDependencies(nil, frameworkApkTag, "framework-res")
Nan Zhangb2b33de2018-02-23 11:18:47 -0800658 }
Colin Cross2fe66872015-03-30 17:20:39 -0700659 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700660
Inseob Kimac1e9862019-12-09 18:15:47 +0900661 syspropPublicStubs := syspropPublicStubs(ctx.Config())
662
663 // rewriteSyspropLibs validates if a java module can link against platform's sysprop_library,
664 // and redirects dependency to public stub depending on the link type.
665 rewriteSyspropLibs := func(libs []string, prop string) []string {
666 // make a copy
667 ret := android.CopyOf(libs)
668
669 for idx, lib := range libs {
670 stub, ok := syspropPublicStubs[lib]
671
672 if !ok {
673 continue
674 }
675
676 linkType, _ := j.getLinkType(ctx.ModuleName())
Inseob Kimc5239512020-01-14 15:36:21 +0900677 // only platform modules can use internal props
678 if linkType != javaPlatform {
Inseob Kimac1e9862019-12-09 18:15:47 +0900679 ret[idx] = stub
Inseob Kimac1e9862019-12-09 18:15:47 +0900680 }
681 }
682
683 return ret
684 }
685
686 ctx.AddVariationDependencies(nil, libTag, rewriteSyspropLibs(j.properties.Libs, "libs")...)
687 ctx.AddVariationDependencies(nil, staticLibTag, rewriteSyspropLibs(j.properties.Static_libs, "static_libs")...)
Colin Crossa4f08812018-10-02 22:03:40 -0700688
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700689 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000690 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800691
Colin Crossfe17f6f2019-03-28 19:30:56 -0700692 android.ProtoDeps(ctx, &j.protoProperties)
Colin Cross6af17aa2017-09-20 12:59:05 -0700693 if j.hasSrcExt(".proto") {
694 protoDeps(ctx, &j.protoProperties)
695 }
Colin Cross93e85952017-08-15 13:34:18 -0700696
697 if j.hasSrcExt(".kt") {
698 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
699 // Kotlin files
Colin Cross0b03d972019-05-13 11:06:25 -0700700 ctx.AddVariationDependencies(nil, kotlinStdlibTag,
701 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8")
Colin Cross7788c122019-01-23 16:14:02 -0800702 if len(j.properties.Plugins) > 0 {
Colin Crossafbb1732019-01-17 15:42:52 -0800703 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
704 }
Colin Cross93e85952017-08-15 13:34:18 -0700705 }
Colin Cross3144dfc2018-01-03 15:06:47 -0800706
Ulya Trafimovich38dfa0f2020-01-07 16:37:02 +0000707 // Framework libraries need special handling in static coverage builds: they should not have
708 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
709 // the same jacoco classes coming from different bootclasspath jars.
710 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
711 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
712 j.properties.Instrument = true
713 }
714 } else if j.shouldInstrumentStatic(ctx) {
Colin Cross42d48b72018-08-29 14:10:52 -0700715 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
Colin Cross3144dfc2018-01-03 15:06:47 -0800716 }
Colin Cross6af17aa2017-09-20 12:59:05 -0700717}
718
719func hasSrcExt(srcs []string, ext string) bool {
720 for _, src := range srcs {
721 if filepath.Ext(src) == ext {
722 return true
723 }
724 }
725
726 return false
727}
728
729func (j *Module) hasSrcExt(ext string) bool {
730 return hasSrcExt(j.properties.Srcs, ext)
Colin Cross2fe66872015-03-30 17:20:39 -0700731}
732
Colin Cross46c9b8b2017-06-22 16:51:17 -0700733func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Colin Cross3047fa22019-04-18 10:56:44 -0700734 aidlIncludeDirs android.Paths) (string, android.Paths) {
Colin Crossc0b06f12015-04-08 13:03:43 -0700735
Colin Crossebe1a512017-11-14 13:12:14 -0800736 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
737 aidlIncludes = append(aidlIncludes,
738 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
739 aidlIncludes = append(aidlIncludes,
740 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
Colin Crossc0b06f12015-04-08 13:03:43 -0700741
Colin Cross3047fa22019-04-18 10:56:44 -0700742 var flags []string
743 var deps android.Paths
Steven Moreland667f6882018-07-26 12:55:08 -0700744
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700745 if aidlPreprocess.Valid() {
746 flags = append(flags, "-p"+aidlPreprocess.String())
Colin Cross3047fa22019-04-18 10:56:44 -0700747 deps = append(deps, aidlPreprocess.Path())
748 } else if len(aidlIncludeDirs) > 0 {
Colin Cross635c3b02016-05-18 15:37:25 -0700749 flags = append(flags, android.JoinWithPrefix(aidlIncludeDirs.Strings(), "-I"))
Colin Crossc0b06f12015-04-08 13:03:43 -0700750 }
751
Colin Cross3047fa22019-04-18 10:56:44 -0700752 if len(j.exportAidlIncludeDirs) > 0 {
753 flags = append(flags, android.JoinWithPrefix(j.exportAidlIncludeDirs.Strings(), "-I"))
754 }
755
756 if len(aidlIncludes) > 0 {
757 flags = append(flags, android.JoinWithPrefix(aidlIncludes.Strings(), "-I"))
758 }
759
Colin Cross635c3b02016-05-18 15:37:25 -0700760 flags = append(flags, "-I"+android.PathForModuleSrc(ctx).String())
Colin Cross32f38982018-02-22 11:47:25 -0800761 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Colin Crossd48633a2017-07-13 14:41:17 -0700762 flags = append(flags, "-I"+src.String())
763 }
Colin Crossc0b06f12015-04-08 13:03:43 -0700764
Martijn Coeneneab15642018-03-09 09:29:59 +0100765 if Bool(j.deviceProperties.Aidl.Generate_traces) {
766 flags = append(flags, "-t")
767 }
768
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100769 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
770 flags = append(flags, "--transaction_names")
771 }
772
Colin Cross3047fa22019-04-18 10:56:44 -0700773 return strings.Join(flags, " "), deps
Colin Crossc0b06f12015-04-08 13:03:43 -0700774}
775
Colin Cross32f676a2017-09-06 13:41:06 -0700776type deps struct {
Nan Zhang581fd212018-01-10 16:06:12 -0800777 classpath classpath
Colin Cross6cef4812019-10-17 14:23:50 -0700778 java9Classpath classpath
Nan Zhang581fd212018-01-10 16:06:12 -0800779 bootClasspath classpath
Colin Cross6a77c982018-06-19 22:43:34 -0700780 processorPath classpath
Colin Crossbe9cdb82019-01-21 21:37:16 -0800781 processorClasses []string
Colin Cross6ade34f2017-09-15 13:00:47 -0700782 staticJars android.Paths
Nan Zhanged19fc32017-10-19 13:06:22 -0700783 staticHeaderJars android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700784 staticResourceJars android.Paths
Colin Cross6ade34f2017-09-15 13:00:47 -0700785 aidlIncludeDirs android.Paths
Nan Zhangb2b33de2018-02-23 11:18:47 -0800786 srcs android.Paths
Colin Cross59149b62017-10-16 18:07:29 -0700787 srcJars android.Paths
Colin Crossb77043e2019-07-16 13:57:13 -0700788 systemModules *systemModules
Colin Cross6ade34f2017-09-15 13:00:47 -0700789 aidlPreprocess android.OptionalPath
Colin Cross93e85952017-08-15 13:34:18 -0700790 kotlinStdlib android.Paths
Colin Crossafbb1732019-01-17 15:42:52 -0800791 kotlinAnnotations android.Paths
Colin Crossbe9cdb82019-01-21 21:37:16 -0800792
793 disableTurbine bool
Colin Cross32f676a2017-09-06 13:41:06 -0700794}
Colin Cross2fe66872015-03-30 17:20:39 -0700795
Colin Cross54250902017-12-05 09:28:08 -0800796func checkProducesJars(ctx android.ModuleContext, dep android.SourceFileProducer) {
797 for _, f := range dep.Srcs() {
798 if f.Ext() != ".jar" {
799 ctx.ModuleErrorf("genrule %q must generate files ending with .jar to be used as a libs or static_libs dependency",
800 ctx.OtherModuleName(dep.(blueprint.Module)))
801 }
802 }
803}
804
Jiyong Park2d492942018-03-05 17:44:10 +0900805type linkType int
806
807const (
Jiyong Park50146e92020-01-30 18:00:15 +0900808 // TODO(jiyong) rename these for better readability. Make the allowed
809 // and disallowed link types explicit
Jiyong Park2d492942018-03-05 17:44:10 +0900810 javaCore linkType = iota
811 javaSdk
812 javaSystem
Jiyong Park50146e92020-01-30 18:00:15 +0900813 javaModule
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900814 javaSystemServer
Jiyong Park2d492942018-03-05 17:44:10 +0900815 javaPlatform
816)
817
Jeongik Cha75b83b02019-11-01 15:28:00 +0900818type linkTypeContext interface {
819 android.Module
820 getLinkType(name string) (ret linkType, stubs bool)
821}
822
823func (m *Module) getLinkType(name string) (ret linkType, stubs bool) {
Colin Cross83bb3162018-06-25 15:48:06 -0700824 ver := m.sdkVersion()
Colin Crossf19b9bb2018-03-26 14:42:44 -0700825 switch {
Jiyong Park46f78fb2018-10-20 16:33:17 +0900826 case name == "core.current.stubs" || name == "core.platform.api.stubs" ||
827 name == "stub-annotations" || name == "private-stub-annotations-jar" ||
Pete Gillincbff3262019-05-08 15:10:06 +0100828 name == "core-lambda-stubs" || name == "core-generated-annotation-stubs":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900829 return javaCore, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900830 case ver.kind == sdkCore:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900831 return javaCore, false
832 case name == "android_system_stubs_current":
833 return javaSystem, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900834 case ver.kind == sdkSystem:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900835 return javaSystem, false
836 case name == "android_test_stubs_current":
837 return javaSystem, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900838 case ver.kind == sdkTest:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900839 return javaPlatform, false
840 case name == "android_stubs_current":
841 return javaSdk, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900842 case ver.kind == sdkPublic:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900843 return javaSdk, false
Jiyong Park50146e92020-01-30 18:00:15 +0900844 case name == "android_module_lib_stubs_current":
845 return javaModule, true
846 case ver.kind == sdkModule:
847 return javaModule, false
Anton Hanssonba6ab2e2020-03-19 15:23:38 +0000848 case name == "android_system_server_stubs_current":
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900849 return javaSystemServer, true
850 case ver.kind == sdkSystemServer:
851 return javaSystemServer, false
Jiyong Park6a927c42020-01-21 02:03:43 +0900852 case ver.kind == sdkPrivate || ver.kind == sdkNone || ver.kind == sdkCorePlatform:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900853 return javaPlatform, false
Jiyong Park6a927c42020-01-21 02:03:43 +0900854 case !ver.valid():
855 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.raw))
Colin Crossf19b9bb2018-03-26 14:42:44 -0700856 default:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900857 return javaSdk, false
Jiyong Park2d492942018-03-05 17:44:10 +0900858 }
859}
860
Jeongik Cha75b83b02019-11-01 15:28:00 +0900861func checkLinkType(ctx android.ModuleContext, from *Module, to linkTypeContext, tag dependencyTag) {
Colin Crossf19b9bb2018-03-26 14:42:44 -0700862 if ctx.Host() {
863 return
864 }
865
Jeongik Cha75b83b02019-11-01 15:28:00 +0900866 myLinkType, stubs := from.getLinkType(ctx.ModuleName())
Jiyong Park46f78fb2018-10-20 16:33:17 +0900867 if stubs {
868 return
869 }
Jeongik Cha75b83b02019-11-01 15:28:00 +0900870 otherLinkType, _ := to.getLinkType(ctx.OtherModuleName(to))
Jiyong Park2d492942018-03-05 17:44:10 +0900871 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."
872
873 switch myLinkType {
874 case javaCore:
875 if otherLinkType != javaCore {
876 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 +0900877 ctx.OtherModuleName(to))
878 }
Jiyong Park2d492942018-03-05 17:44:10 +0900879 break
880 case javaSdk:
881 if otherLinkType != javaCore && otherLinkType != javaSdk {
882 ctx.ModuleErrorf("compiles against Android API, but dependency %q is compiling against non-public Android API."+commonMessage,
883 ctx.OtherModuleName(to))
884 }
885 break
886 case javaSystem:
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900887 if otherLinkType == javaPlatform || otherLinkType == javaModule || otherLinkType == javaSystemServer {
Jiyong Park2d492942018-03-05 17:44:10 +0900888 ctx.ModuleErrorf("compiles against system API, but dependency %q is compiling against private API."+commonMessage,
889 ctx.OtherModuleName(to))
890 }
891 break
Jiyong Park50146e92020-01-30 18:00:15 +0900892 case javaModule:
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900893 if otherLinkType == javaPlatform || otherLinkType == javaSystemServer {
Jiyong Park50146e92020-01-30 18:00:15 +0900894 ctx.ModuleErrorf("compiles against module API, but dependency %q is compiling against private API."+commonMessage,
895 ctx.OtherModuleName(to))
896 }
897 break
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900898 case javaSystemServer:
899 if otherLinkType == javaPlatform {
900 ctx.ModuleErrorf("compiles against system server API, but dependency %q is compiling against private API."+commonMessage,
901 ctx.OtherModuleName(to))
902 }
903 break
Jiyong Park2d492942018-03-05 17:44:10 +0900904 case javaPlatform:
905 // no restriction on link-type
906 break
Jiyong Park750e5572018-01-31 00:20:13 +0900907 }
908}
909
Colin Cross32f676a2017-09-06 13:41:06 -0700910func (j *Module) collectDeps(ctx android.ModuleContext) deps {
911 var deps deps
Colin Crossfc3674a2017-09-18 17:41:52 -0700912
Colin Cross300f0382018-03-06 13:11:51 -0800913 if ctx.Device() {
Colin Cross83bb3162018-06-25 15:48:06 -0700914 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross300f0382018-03-06 13:11:51 -0800915 if sdkDep.invalidVersion {
Colin Cross6cef4812019-10-17 14:23:50 -0700916 ctx.AddMissingDependencies(sdkDep.bootclasspath)
917 ctx.AddMissingDependencies(sdkDep.java9Classpath)
Colin Cross300f0382018-03-06 13:11:51 -0800918 } else if sdkDep.useFiles {
919 // sdkDep.jar is actually equivalent to turbine header.jar.
Colin Cross86a60ae2018-05-29 14:44:55 -0700920 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross3047fa22019-04-18 10:56:44 -0700921 deps.aidlPreprocess = sdkDep.aidl
922 } else {
923 deps.aidlPreprocess = sdkDep.aidl
Colin Cross300f0382018-03-06 13:11:51 -0800924 }
Colin Crossfc3674a2017-09-18 17:41:52 -0700925 }
926
Colin Crossd11fcda2017-10-23 17:59:01 -0700927 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross2fe66872015-03-30 17:20:39 -0700928 otherName := ctx.OtherModuleName(module)
Colin Crossec7a0422017-07-07 14:47:12 -0700929 tag := ctx.OtherModuleDependencyTag(module)
930
Colin Crossa4f08812018-10-02 22:03:40 -0700931 if _, ok := tag.(*jniDependencyTag); ok {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700932 // Handled by AndroidApp.collectAppDeps
933 return
934 }
935 if tag == certificateTag {
936 // Handled by AndroidApp.collectAppDeps
Colin Crossa4f08812018-10-02 22:03:40 -0700937 return
938 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100939
Colin Cross54250902017-12-05 09:28:08 -0800940 switch dep := module.(type) {
Colin Cross897d2ed2019-02-11 14:03:51 -0800941 case SdkLibraryDependency:
942 switch tag {
943 case libTag:
944 deps.classpath = append(deps.classpath, dep.SdkHeaderJars(ctx, j.sdkVersion())...)
945 // names of sdk libs that are directly depended are exported
946 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
Colin Cross79c7c262019-04-17 11:11:46 -0700947 case staticLibTag:
Colin Cross897d2ed2019-02-11 14:03:51 -0800948 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
949 }
Colin Cross54250902017-12-05 09:28:08 -0800950 case Dependency:
951 switch tag {
952 case bootClasspathTag:
953 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars()...)
Colin Cross4b964c02018-10-15 16:18:06 -0700954 case libTag, instrumentationForTag:
Colin Cross54250902017-12-05 09:28:08 -0800955 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900956 // sdk lib names from dependencies are re-exported
957 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700958 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000959 pluginJars, pluginClasses := dep.ExportedPlugins()
960 addPlugins(&deps, pluginJars, pluginClasses...)
Colin Cross6cef4812019-10-17 14:23:50 -0700961 case java9LibTag:
962 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars()...)
Colin Cross54250902017-12-05 09:28:08 -0800963 case staticLibTag:
964 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
965 deps.staticJars = append(deps.staticJars, dep.ImplementationJars()...)
966 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars()...)
Colin Cross331a1212018-08-15 20:40:52 -0700967 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900968 // sdk lib names from dependencies are re-exported
969 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700970 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000971 pluginJars, pluginClasses := dep.ExportedPlugins()
972 addPlugins(&deps, pluginJars, pluginClasses...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800973 case pluginTag:
974 if plugin, ok := dep.(*Plugin); ok {
Colin Crossbe9cdb82019-01-21 21:37:16 -0800975 if plugin.pluginProperties.Processor_class != nil {
Artur Satayev9cf46692019-11-26 18:08:34 +0000976 addPlugins(&deps, plugin.ImplementationAndResourcesJars(), *plugin.pluginProperties.Processor_class)
977 } else {
978 addPlugins(&deps, plugin.ImplementationAndResourcesJars())
Colin Crossbe9cdb82019-01-21 21:37:16 -0800979 }
980 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
981 } else {
982 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
983 }
Artur Satayev9cf46692019-11-26 18:08:34 +0000984 case exportedPluginTag:
985 if plugin, ok := dep.(*Plugin); ok {
986 if plugin.pluginProperties.Generates_api != nil && *plugin.pluginProperties.Generates_api {
987 ctx.PropertyErrorf("exported_plugins", "Cannot export plugins with generates_api = true, found %v", otherName)
988 }
989 j.exportedPluginJars = append(j.exportedPluginJars, plugin.ImplementationAndResourcesJars()...)
990 if plugin.pluginProperties.Processor_class != nil {
991 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
992 }
993 } else {
994 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
995 }
Nan Zhangb2b33de2018-02-23 11:18:47 -0800996 case frameworkApkTag:
997 if ctx.ModuleName() == "android_stubs_current" ||
998 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -0700999 ctx.ModuleName() == "android_test_stubs_current" {
Nan Zhangb2b33de2018-02-23 11:18:47 -08001000 // framework stubs.jar need to depend on framework-res.apk, in order to pull the
1001 // resource files out of there for aapt.
1002 //
1003 // Normally the package rule runs aapt, which includes the resource,
1004 // but we're not running that in our package rule so just copy in the
1005 // resource files here.
Colin Cross331a1212018-08-15 20:40:52 -07001006 deps.staticResourceJars = append(deps.staticResourceJars, dep.(*AndroidApp).exportPackage)
Nan Zhangb2b33de2018-02-23 11:18:47 -08001007 }
Colin Cross54250902017-12-05 09:28:08 -08001008 case kotlinStdlibTag:
Colin Cross0b03d972019-05-13 11:06:25 -07001009 deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars()...)
Colin Crossafbb1732019-01-17 15:42:52 -08001010 case kotlinAnnotationsTag:
1011 deps.kotlinAnnotations = dep.HeaderJars()
Colin Cross54250902017-12-05 09:28:08 -08001012 }
1013
Colin Cross54250902017-12-05 09:28:08 -08001014 case android.SourceFileProducer:
1015 switch tag {
1016 case libTag:
1017 checkProducesJars(ctx, dep)
1018 deps.classpath = append(deps.classpath, dep.Srcs()...)
1019 case staticLibTag:
1020 checkProducesJars(ctx, dep)
1021 deps.classpath = append(deps.classpath, dep.Srcs()...)
1022 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
1023 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Cross54250902017-12-05 09:28:08 -08001024 }
1025 default:
Colin Crossec7a0422017-07-07 14:47:12 -07001026 switch tag {
Paul Duffin68289b02019-09-20 13:50:52 +01001027 case bootClasspathTag:
1028 // If a system modules dependency has been added to the bootclasspath
1029 // then add its libs to the bootclasspath.
Paul Duffin83a2d962019-11-19 19:44:10 +00001030 sm := module.(SystemModulesProvider)
1031 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars()...)
Paul Duffin68289b02019-09-20 13:50:52 +01001032
Colin Cross1369cdb2017-09-29 17:58:17 -07001033 case systemModulesTag:
1034 if deps.systemModules != nil {
1035 panic("Found two system module dependencies")
1036 }
Paul Duffin83a2d962019-11-19 19:44:10 +00001037 sm := module.(SystemModulesProvider)
1038 outputDir, outputDeps := sm.OutputDirAndDeps()
1039 deps.systemModules = &systemModules{outputDir, outputDeps}
Colin Cross2fe66872015-03-30 17:20:39 -07001040 }
Colin Crossec7a0422017-07-07 14:47:12 -07001041 }
Colin Cross2fe66872015-03-30 17:20:39 -07001042 })
1043
Jiyong Park1be96912018-05-28 18:02:19 +09001044 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
1045
Colin Cross32f676a2017-09-06 13:41:06 -07001046 return deps
Colin Cross2fe66872015-03-30 17:20:39 -07001047}
1048
Artur Satayev9cf46692019-11-26 18:08:34 +00001049func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
1050 deps.processorPath = append(deps.processorPath, pluginJars...)
1051 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
1052}
1053
Colin Cross1e743852019-10-28 11:37:20 -07001054func getJavaVersion(ctx android.ModuleContext, javaVersion string, sdkContext sdkContext) javaVersion {
Jiyong Park6a927c42020-01-21 02:03:43 +09001055 sdk, err := sdkContext.sdkVersion().effectiveVersion(ctx)
Colin Cross83bb3162018-06-25 15:48:06 -07001056 if err != nil {
1057 ctx.PropertyErrorf("sdk_version", "%s", err)
1058 }
Nan Zhang357466b2018-04-17 17:38:36 -07001059 if javaVersion != "" {
Colin Cross1e743852019-10-28 11:37:20 -07001060 return normalizeJavaVersion(ctx, javaVersion)
Nan Zhang357466b2018-04-17 17:38:36 -07001061 } else if ctx.Device() && sdk <= 23 {
Colin Cross1e743852019-10-28 11:37:20 -07001062 return JAVA_VERSION_7
Pete Gillina1c9e9d2019-10-17 14:52:07 +01001063 } else if ctx.Device() && sdk <= 29 {
Colin Cross1e743852019-10-28 11:37:20 -07001064 return JAVA_VERSION_8
Colin Cross6cef4812019-10-17 14:23:50 -07001065 } else if ctx.Device() && ctx.Config().UnbundledBuildUsePrebuiltSdks() {
1066 // TODO(b/142896162): once we have prebuilt system modules we can use 1.9 for unbundled builds
Colin Cross1e743852019-10-28 11:37:20 -07001067 return JAVA_VERSION_8
Nan Zhang357466b2018-04-17 17:38:36 -07001068 } else {
Colin Cross1e743852019-10-28 11:37:20 -07001069 return JAVA_VERSION_9
Nan Zhang357466b2018-04-17 17:38:36 -07001070 }
Nan Zhang357466b2018-04-17 17:38:36 -07001071}
1072
Colin Cross1e743852019-10-28 11:37:20 -07001073type javaVersion int
1074
1075const (
1076 JAVA_VERSION_UNSUPPORTED = 0
1077 JAVA_VERSION_6 = 6
1078 JAVA_VERSION_7 = 7
1079 JAVA_VERSION_8 = 8
1080 JAVA_VERSION_9 = 9
1081)
1082
1083func (v javaVersion) String() string {
1084 switch v {
1085 case JAVA_VERSION_6:
1086 return "1.6"
1087 case JAVA_VERSION_7:
1088 return "1.7"
1089 case JAVA_VERSION_8:
1090 return "1.8"
1091 case JAVA_VERSION_9:
1092 return "1.9"
1093 default:
1094 return "unsupported"
1095 }
1096}
1097
1098// Returns true if javac targeting this version uses system modules instead of a bootclasspath.
1099func (v javaVersion) usesJavaModules() bool {
1100 return v >= 9
1101}
1102
1103func normalizeJavaVersion(ctx android.BaseModuleContext, javaVersion string) javaVersion {
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001104 switch javaVersion {
1105 case "1.6", "6":
Colin Cross1e743852019-10-28 11:37:20 -07001106 return JAVA_VERSION_6
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001107 case "1.7", "7":
Colin Cross1e743852019-10-28 11:37:20 -07001108 return JAVA_VERSION_7
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001109 case "1.8", "8":
Colin Cross1e743852019-10-28 11:37:20 -07001110 return JAVA_VERSION_8
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001111 case "1.9", "9":
Colin Cross1e743852019-10-28 11:37:20 -07001112 return JAVA_VERSION_9
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001113 case "10", "11":
1114 ctx.PropertyErrorf("java_version", "Java language levels above 9 are not supported")
Colin Cross1e743852019-10-28 11:37:20 -07001115 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001116 default:
1117 ctx.PropertyErrorf("java_version", "Unrecognized Java language level")
Colin Cross1e743852019-10-28 11:37:20 -07001118 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001119 }
1120}
1121
Nan Zhanged19fc32017-10-19 13:06:22 -07001122func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
Colin Crossc0b06f12015-04-08 13:03:43 -07001123
Colin Crossf03c82b2015-04-13 13:53:40 -07001124 var flags javaBuilderFlags
1125
Tobias Thierer06dd04f2018-09-11 16:21:05 +01001126 // javaVersion flag.
1127 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), sdkContext(j))
1128
Nan Zhanged19fc32017-10-19 13:06:22 -07001129 // javac flags.
Colin Crossf03c82b2015-04-13 13:53:40 -07001130 javacFlags := j.properties.Javacflags
Colin Cross1e743852019-10-28 11:37:20 -07001131 if flags.javaVersion.usesJavaModules() {
Colin Cross1369cdb2017-09-29 17:58:17 -07001132 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Nan Zhanged19fc32017-10-19 13:06:22 -07001133 }
Colin Cross6510f912017-11-29 00:27:14 -08001134 if ctx.Config().MinimizeJavaDebugInfo() {
Colin Cross126a25c2017-10-31 13:55:34 -07001135 // Override the -g flag passed globally to remove local variable debug info to reduce
1136 // disk and memory usage.
1137 javacFlags = append(javacFlags, "-g:source,lines")
1138 }
Colin Crossc228a702019-11-06 16:18:05 -08001139 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
Colin Cross64162712017-08-08 13:17:59 -07001140
Colin Cross66548102018-06-19 22:47:35 -07001141 if ctx.Config().RunErrorProne() {
1142 if config.ErrorProneClasspath == nil {
1143 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1144 }
1145
1146 errorProneFlags := []string{
1147 "-Xplugin:ErrorProne",
1148 "${config.ErrorProneChecks}",
1149 }
1150 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1151
1152 flags.errorProneExtraJavacFlags = "${config.ErrorProneFlags} " +
1153 "'" + strings.Join(errorProneFlags, " ") + "'"
1154 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
Andreas Gampef3e5b552018-01-22 21:27:21 -08001155 }
1156
Nan Zhanged19fc32017-10-19 13:06:22 -07001157 // classpath
Nan Zhang581fd212018-01-10 16:06:12 -08001158 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1159 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross6cef4812019-10-17 14:23:50 -07001160 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
Colin Cross6a77c982018-06-19 22:43:34 -07001161 flags.processorPath = append(flags.processorPath, deps.processorPath...)
Colin Cross7fdd2b72018-01-02 18:14:25 -08001162
Colin Cross5a116862020-04-22 11:44:34 -07001163 flags.processors = append(flags.processors, deps.processorClasses...)
1164 flags.processors = android.FirstUniqueStrings(flags.processors)
Colin Crossbe9cdb82019-01-21 21:37:16 -08001165
Colin Cross1e743852019-10-28 11:37:20 -07001166 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
1167 decodeSdkDep(ctx, sdkContext(j)).hasStandardLibs() {
Colin Cross7fdd2b72018-01-02 18:14:25 -08001168 // Give host-side tools a version of OpenJDK's standard libraries
1169 // close to what they're targeting. As of Dec 2017, AOSP is only
1170 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1171 //
1172 // When building with OpenJDK 8, the following should have no
1173 // effect since those jars would be available by default.
1174 //
1175 // When building with OpenJDK 9 but targeting a version < 1.8,
1176 // putting them on the bootclasspath means that:
1177 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1178 // b) references to existing APIs are not reinterpreted in an
1179 // OpenJDK 9-specific way, eg. calls to subclasses of
1180 // java.nio.Buffer as in http://b/70862583
1181 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1182 flags.bootClasspath = append(flags.bootClasspath,
1183 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1184 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
Nan Zhang5f8cb422018-02-06 10:34:32 -08001185 if Bool(j.properties.Use_tools_jar) {
1186 flags.bootClasspath = append(flags.bootClasspath,
1187 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1188 }
Colin Cross7fdd2b72018-01-02 18:14:25 -08001189 }
1190
Colin Cross1e743852019-10-28 11:37:20 -07001191 if j.properties.Patch_module != nil && flags.javaVersion.usesJavaModules() {
Jaewoong Jung38e4fb22018-12-12 09:01:34 -08001192 // Manually specify build directory in case it is not under the repo root.
1193 // (javac doesn't seem to expand into symbolc links when searching for patch-module targets, so
1194 // just adding a symlink under the root doesn't help.)
1195 patchPaths := ".:" + ctx.Config().BuildDir()
1196 classPath := flags.classpath.FormJavaClassPath("")
1197 if classPath != "" {
1198 patchPaths += ":" + classPath
1199 }
1200 javacFlags = append(javacFlags, "--patch-module="+String(j.properties.Patch_module)+"="+patchPaths)
Colin Cross81440082018-08-15 20:21:55 -07001201 }
1202
Nan Zhanged19fc32017-10-19 13:06:22 -07001203 // systemModules
Colin Crossb77043e2019-07-16 13:57:13 -07001204 flags.systemModules = deps.systemModules
Colin Cross1369cdb2017-09-29 17:58:17 -07001205
Nan Zhanged19fc32017-10-19 13:06:22 -07001206 // aidl flags.
Colin Cross3047fa22019-04-18 10:56:44 -07001207 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs)
Colin Cross2fe66872015-03-30 17:20:39 -07001208
Colin Cross81440082018-08-15 20:21:55 -07001209 if len(javacFlags) > 0 {
1210 // optimization.
1211 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1212 flags.javacFlags = "$javacFlags"
1213 }
1214
Nan Zhanged19fc32017-10-19 13:06:22 -07001215 return flags
1216}
Colin Crossc0b06f12015-04-08 13:03:43 -07001217
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001218func (j *Module) compile(ctx android.ModuleContext, aaptSrcJar android.Path) {
Colin Crossebe1a512017-11-14 13:12:14 -08001219 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
Nan Zhanged19fc32017-10-19 13:06:22 -07001220
1221 deps := j.collectDeps(ctx)
1222 flags := j.collectBuilderFlags(ctx, deps)
1223
Colin Cross1e743852019-10-28 11:37:20 -07001224 if flags.javaVersion.usesJavaModules() {
Nan Zhanged19fc32017-10-19 13:06:22 -07001225 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
1226 }
Colin Cross8a497952019-03-05 22:25:09 -08001227 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Colin Cross6af17aa2017-09-20 12:59:05 -07001228 if hasSrcExt(srcFiles.Strings(), ".proto") {
Colin Cross0f2ee152017-12-14 15:22:43 -08001229 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
Colin Cross6af17aa2017-09-20 12:59:05 -07001230 }
1231
Colin Crossaf050172017-11-15 23:01:59 -08001232 srcFiles = j.genSources(ctx, srcFiles, flags)
1233
1234 srcJars := srcFiles.FilterByExt(".srcjar")
Colin Cross59149b62017-10-16 18:07:29 -07001235 srcJars = append(srcJars, deps.srcJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001236 if aaptSrcJar != nil {
1237 srcJars = append(srcJars, aaptSrcJar)
1238 }
Colin Crossb7a63242015-04-16 14:09:14 -07001239
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001240 if j.properties.Jarjar_rules != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001241 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001242 }
1243
Colin Cross1ee23172017-10-18 14:44:18 -07001244 jarName := ctx.ModuleName() + ".jar"
1245
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001246 javaSrcFiles := srcFiles.FilterByExt(".java")
1247 var uniqueSrcFiles android.Paths
1248 set := make(map[string]bool)
1249 for _, v := range javaSrcFiles {
1250 if _, found := set[v.String()]; !found {
1251 set[v.String()] = true
1252 uniqueSrcFiles = append(uniqueSrcFiles, v)
1253 }
1254 }
1255
patricktu242faad2019-09-24 15:41:30 +08001256 // Collect .java files for AIDEGen
1257 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1258
Colin Cross55f63ea2018-08-27 12:37:09 -07001259 var kotlinJars android.Paths
1260
Colin Cross93e85952017-08-15 13:34:18 -07001261 if srcFiles.HasExt(".kt") {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001262 // user defined kotlin flags.
1263 kotlincFlags := j.properties.Kotlincflags
1264 CheckKotlincFlags(ctx, kotlincFlags)
1265
Colin Cross93e85952017-08-15 13:34:18 -07001266 // If there are kotlin files, compile them first but pass all the kotlin and java files
1267 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1268 // won't emit any classes for them.
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001269 kotlincFlags = append(kotlincFlags, "-no-stdlib")
Colin Cross93e85952017-08-15 13:34:18 -07001270 if ctx.Device() {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001271 kotlincFlags = append(kotlincFlags, "-no-jdk")
1272 }
1273 if len(kotlincFlags) > 0 {
1274 // optimization.
1275 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1276 flags.kotlincFlags += "$kotlincFlags"
Colin Cross93e85952017-08-15 13:34:18 -07001277 }
1278
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001279 var kotlinSrcFiles android.Paths
1280 kotlinSrcFiles = append(kotlinSrcFiles, uniqueSrcFiles...)
1281 kotlinSrcFiles = append(kotlinSrcFiles, srcFiles.FilterByExt(".kt")...)
1282
patricktu242faad2019-09-24 15:41:30 +08001283 // Collect .kt files for AIDEGen
1284 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, srcFiles.FilterByExt(".kt").Strings()...)
1285
Colin Crossafbb1732019-01-17 15:42:52 -08001286 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1287 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1288
1289 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1290 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1291
1292 if len(flags.processorPath) > 0 {
1293 // Use kapt for annotation processing
1294 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1295 kotlinKapt(ctx, kaptSrcJar, kotlinSrcFiles, srcJars, flags)
1296 srcJars = append(srcJars, kaptSrcJar)
1297 // Disable annotation processing in javac, it's already been handled by kapt
1298 flags.processorPath = nil
Colin Cross5a116862020-04-22 11:44:34 -07001299 flags.processors = nil
Colin Crossafbb1732019-01-17 15:42:52 -08001300 }
Colin Cross93e85952017-08-15 13:34:18 -07001301
Colin Cross1ee23172017-10-18 14:44:18 -07001302 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross21fc9bb2019-01-18 15:05:09 -08001303 kotlinCompile(ctx, kotlinJar, kotlinSrcFiles, srcJars, flags)
Colin Cross93e85952017-08-15 13:34:18 -07001304 if ctx.Failed() {
1305 return
1306 }
1307
1308 // Make javac rule depend on the kotlinc rule
1309 flags.classpath = append(flags.classpath, kotlinJar)
Przemyslaw Szczepaniak66c0c402018-03-08 13:21:55 +00001310
Colin Cross93e85952017-08-15 13:34:18 -07001311 // Jar kotlin classes into the final jar after javac
Colin Cross55f63ea2018-08-27 12:37:09 -07001312 kotlinJars = append(kotlinJars, kotlinJar)
Colin Cross9b38aef2018-08-27 15:42:25 -07001313 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
Colin Cross93e85952017-08-15 13:34:18 -07001314 }
1315
Colin Cross55f63ea2018-08-27 12:37:09 -07001316 jars := append(android.Paths(nil), kotlinJars...)
1317
Colin Cross5ab4e6d2017-11-22 16:20:45 -08001318 // Store the list of .java files that was passed to javac
1319 j.compiledJavaSrcs = uniqueSrcFiles
1320 j.compiledSrcJars = srcJars
1321
Nan Zhang61eaedb2017-11-02 13:28:15 -07001322 enable_sharding := false
Colin Crossf7d84012020-02-21 08:16:41 -08001323 var headerJarFileWithoutJarjar android.Path
Colin Crossbe9cdb82019-01-21 21:37:16 -08001324 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !deps.disableTurbine {
Nan Zhang61eaedb2017-11-02 13:28:15 -07001325 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1326 enable_sharding = true
Ashley Rosee36efcf2019-01-16 17:34:08 -05001327 // Formerly, there was a check here that prevented annotation processors
1328 // from being used when sharding was enabled, as some annotation processors
1329 // do not function correctly in sharded environments. It was removed to
1330 // allow for the use of annotation processors that do function correctly
1331 // with sharding enabled. See: b/77284273.
Nan Zhang61eaedb2017-11-02 13:28:15 -07001332 }
Colin Crossf7d84012020-02-21 08:16:41 -08001333 headerJarFileWithoutJarjar, j.headerJarFile =
1334 j.compileJavaHeader(ctx, uniqueSrcFiles, srcJars, deps, flags, jarName, kotlinJars)
Colin Crossf19b9bb2018-03-26 14:42:44 -07001335 if ctx.Failed() {
1336 return
Nan Zhanged19fc32017-10-19 13:06:22 -07001337 }
1338 }
Colin Cross8eadbf02017-10-24 17:46:00 -07001339 if len(uniqueSrcFiles) > 0 || len(srcJars) > 0 {
Colin Crossd6891432017-09-27 17:39:56 -07001340 var extraJarDeps android.Paths
Colin Cross66548102018-06-19 22:47:35 -07001341 if ctx.Config().RunErrorProne() {
Colin Crossc6bbef32017-08-14 14:16:06 -07001342 // If error-prone is enabled, add an additional rule to compile the java files into
1343 // a separate set of classes (so that they don't overwrite the normal ones and require
Colin Crossd6891432017-09-27 17:39:56 -07001344 // a rebuild when error-prone is turned off).
Colin Crossc6bbef32017-08-14 14:16:06 -07001345 // TODO(ccross): Once we always compile with javac9 we may be able to conditionally
1346 // enable error-prone without affecting the output class files.
Colin Cross1ee23172017-10-18 14:44:18 -07001347 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001348 RunErrorProne(ctx, errorprone, uniqueSrcFiles, srcJars, flags)
Colin Crossc6bbef32017-08-14 14:16:06 -07001349 extraJarDeps = append(extraJarDeps, errorprone)
1350 }
1351
Nan Zhang61eaedb2017-11-02 13:28:15 -07001352 if enable_sharding {
Colin Crossf7d84012020-02-21 08:16:41 -08001353 flags.classpath = append(flags.classpath, headerJarFileWithoutJarjar)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001354 shardSize := int(*(j.properties.Javac_shard_size))
1355 var shardSrcs []android.Paths
1356 if len(uniqueSrcFiles) > 0 {
Colin Cross0a2f7192019-09-23 14:33:09 -07001357 shardSrcs = android.ShardPaths(uniqueSrcFiles, shardSize)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001358 for idx, shardSrc := range shardSrcs {
Colin Cross3b706fd2019-09-05 16:44:18 -07001359 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1360 nil, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001361 jars = append(jars, classes)
1362 }
1363 }
1364 if len(srcJars) > 0 {
Colin Cross3b706fd2019-09-05 16:44:18 -07001365 classes := j.compileJavaClasses(ctx, jarName, len(shardSrcs),
1366 nil, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001367 jars = append(jars, classes)
1368 }
1369 } else {
Colin Cross3b706fd2019-09-05 16:44:18 -07001370 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueSrcFiles, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001371 jars = append(jars, classes)
1372 }
Colin Crossd6891432017-09-27 17:39:56 -07001373 if ctx.Failed() {
1374 return
1375 }
Colin Cross2fe66872015-03-30 17:20:39 -07001376 }
1377
Colin Cross0c4ce212019-05-03 15:28:19 -07001378 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1379
1380 var includeSrcJar android.WritablePath
1381 if Bool(j.properties.Include_srcs) {
1382 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1383 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1384 }
1385
Colin Crosscedd4762018-09-13 11:26:19 -07001386 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1387 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Colin Cross0f37af02017-09-27 17:42:05 -07001388 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
Colin Cross988708c2019-05-06 14:04:11 -07001389 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
Colin Cross0f37af02017-09-27 17:42:05 -07001390
1391 var resArgs []string
1392 var resDeps android.Paths
1393
1394 resArgs = append(resArgs, dirArgs...)
1395 resDeps = append(resDeps, dirDeps...)
1396
1397 resArgs = append(resArgs, fileArgs...)
1398 resDeps = append(resDeps, fileDeps...)
1399
Colin Cross988708c2019-05-06 14:04:11 -07001400 resArgs = append(resArgs, extraArgs...)
1401 resDeps = append(resDeps, extraDeps...)
1402
Colin Cross40a36712017-09-27 17:41:35 -07001403 if len(resArgs) > 0 {
Colin Cross1ee23172017-10-18 14:44:18 -07001404 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
Colin Crosse9a275b2017-10-16 17:09:48 -07001405 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Colin Cross331a1212018-08-15 20:40:52 -07001406 j.resourceJar = resourceJar
Colin Cross65bf4f22015-04-03 16:54:17 -07001407 if ctx.Failed() {
1408 return
1409 }
1410 }
1411
Colin Cross0c4ce212019-05-03 15:28:19 -07001412 var resourceJars android.Paths
1413 if j.resourceJar != nil {
1414 resourceJars = append(resourceJars, j.resourceJar)
1415 }
1416 if Bool(j.properties.Include_srcs) {
1417 resourceJars = append(resourceJars, includeSrcJar)
1418 }
1419 resourceJars = append(resourceJars, deps.staticResourceJars...)
Colin Cross331a1212018-08-15 20:40:52 -07001420
Colin Cross0c4ce212019-05-03 15:28:19 -07001421 if len(resourceJars) > 1 {
Colin Cross331a1212018-08-15 20:40:52 -07001422 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
Colin Cross0c4ce212019-05-03 15:28:19 -07001423 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
Colin Cross331a1212018-08-15 20:40:52 -07001424 false, nil, nil)
1425 j.resourceJar = combinedJar
Colin Cross0c4ce212019-05-03 15:28:19 -07001426 } else if len(resourceJars) == 1 {
1427 j.resourceJar = resourceJars[0]
Colin Cross331a1212018-08-15 20:40:52 -07001428 }
1429
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001430 if len(deps.staticJars) > 0 {
1431 jars = append(jars, deps.staticJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001432 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001433
Colin Cross094054a2018-10-17 15:10:48 -07001434 manifest := j.overrideManifest
1435 if !manifest.Valid() && j.properties.Manifest != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001436 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Colin Cross366938f2017-12-11 16:29:02 -08001437 }
Colin Cross635acc92017-09-12 22:50:46 -07001438
Colin Cross8a497952019-03-05 22:25:09 -08001439 services := android.PathsForModuleSrc(ctx, j.properties.Services)
Alex Light7f004a72019-02-21 13:27:37 -08001440 if len(services) > 0 {
1441 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1442 var zipargs []string
1443 for _, file := range services {
1444 serviceFile := file.String()
1445 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1446 }
1447 ctx.Build(pctx, android.BuildParams{
1448 Rule: zip,
1449 Output: servicesJar,
1450 Implicits: services,
1451 Args: map[string]string{
Colin Cross0b9f31f2019-02-28 11:00:01 -08001452 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
Alex Light7f004a72019-02-21 13:27:37 -08001453 },
1454 })
1455 jars = append(jars, servicesJar)
1456 }
1457
Colin Cross0a6e0072017-08-30 14:24:55 -07001458 // Combine the classes built from sources, any manifests, and any static libraries into
Nan Zhanged19fc32017-10-19 13:06:22 -07001459 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross3063b782018-08-15 11:19:12 -07001460 var outputFile android.ModuleOutPath
Colin Crosse9a275b2017-10-16 17:09:48 -07001461
1462 if len(jars) == 1 && !manifest.Valid() {
Colin Cross3063b782018-08-15 11:19:12 -07001463 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok {
1464 // Optimization: skip the combine step if there is nothing to do
1465 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1466 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1467 // any if len(jars) == 1.
1468 outputFile = moduleOutPath
1469 } else {
1470 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1471 ctx.Build(pctx, android.BuildParams{
1472 Rule: android.Cp,
1473 Input: jars[0],
1474 Output: combinedJar,
1475 })
1476 outputFile = combinedJar
1477 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001478 } else {
Colin Cross1ee23172017-10-18 14:44:18 -07001479 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001480 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
Colin Cross9b38aef2018-08-27 15:42:25 -07001481 false, nil, nil)
Colin Crosse9a275b2017-10-16 17:09:48 -07001482 outputFile = combinedJar
1483 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001484
Colin Cross331a1212018-08-15 20:40:52 -07001485 // jarjar implementation jar if necessary
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001486 if j.expandJarjarRules != nil {
Colin Cross8649b262017-09-27 18:03:17 -07001487 // Transform classes.jar into classes-jarjar.jar
Colin Cross1ee23172017-10-18 14:44:18 -07001488 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001489 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
Colin Crosse9a275b2017-10-16 17:09:48 -07001490 outputFile = jarjarFile
Colin Cross331a1212018-08-15 20:40:52 -07001491
1492 // jarjar resource jar if necessary
1493 if j.resourceJar != nil {
1494 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001495 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
Colin Cross331a1212018-08-15 20:40:52 -07001496 j.resourceJar = resourceJarJarFile
1497 }
1498
Colin Cross0a6e0072017-08-30 14:24:55 -07001499 if ctx.Failed() {
1500 return
1501 }
1502 }
Vladimir Marko0975ee02019-04-02 10:29:55 +01001503
1504 // Check package restrictions if necessary.
1505 if len(j.properties.Permitted_packages) > 0 {
1506 // Check packages and copy to package-checked file.
1507 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
1508 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
1509 j.additionalCheckedModules = append(j.additionalCheckedModules, pkgckFile)
1510
1511 if ctx.Failed() {
1512 return
1513 }
1514 }
1515
Nan Zhanged19fc32017-10-19 13:06:22 -07001516 j.implementationJarFile = outputFile
1517 if j.headerJarFile == nil {
1518 j.headerJarFile = j.implementationJarFile
1519 }
Colin Cross2fe66872015-03-30 17:20:39 -07001520
Jiyong Park93e57a02020-02-21 16:04:53 +09001521 // Force enable the instrumentation for java code that is built for APEXes ...
1522 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
1523 // doesn't make sense)
1524 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
1525 if android.DirectlyInAnyApex(ctx, ctx.ModuleName()) && !isJacocoAgent && !j.IsForPlatform() {
Jiyong Park00cae1c2020-02-18 12:50:44 +00001526 j.properties.Instrument = true
1527 }
1528
Colin Cross3144dfc2018-01-03 15:06:47 -08001529 if j.shouldInstrument(ctx) {
Colin Crosscb933592017-11-22 13:49:43 -08001530 outputFile = j.instrument(ctx, flags, outputFile, jarName)
1531 }
1532
Colin Cross331a1212018-08-15 20:40:52 -07001533 // merge implementation jar with resources if necessary
1534 implementationAndResourcesJar := outputFile
1535 if j.resourceJar != nil {
Colin Cross08a409d2019-04-29 10:22:44 -07001536 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Colin Cross331a1212018-08-15 20:40:52 -07001537 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Colin Cross08a409d2019-04-29 10:22:44 -07001538 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
Colin Cross331a1212018-08-15 20:40:52 -07001539 false, nil, nil)
1540 implementationAndResourcesJar = combinedJar
1541 }
1542
1543 j.implementationAndResourcesJar = implementationAndResourcesJar
1544
Jiyong Park6b21c7d2020-02-11 09:16:01 +09001545 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
1546 if android.DirectlyInAnyApex(ctx, ctx.ModuleName()) && !j.IsForPlatform() {
1547 if j.deviceProperties.Compile_dex == nil {
1548 j.deviceProperties.Compile_dex = proptools.BoolPtr(true)
1549 }
1550 if j.deviceProperties.Hostdex == nil {
1551 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1552 }
1553 }
1554
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001555 if ctx.Device() && j.hasCode(ctx) &&
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001556 (Bool(j.properties.Installable) || Bool(j.deviceProperties.Compile_dex)) {
Colin Cross8faf8fc2019-01-16 15:15:52 -08001557 // Dex compilation
Colin Cross3063b782018-08-15 11:19:12 -07001558 var dexOutputFile android.ModuleOutPath
David Brazdil17ef5632018-06-27 10:27:45 +01001559 dexOutputFile = j.compileDex(ctx, flags, outputFile, jarName)
Colin Cross2fe66872015-03-30 17:20:39 -07001560 if ctx.Failed() {
1561 return
1562 }
Colin Cross331a1212018-08-15 20:40:52 -07001563
Jiyong Park09cb6292019-07-15 15:29:23 +09001564 // Hidden API CSV generation and dex encoding
1565 dexOutputFile = j.hiddenAPI.hiddenAPI(ctx, dexOutputFile, j.implementationJarFile,
1566 j.deviceProperties.UncompressDex)
Colin Cross8faf8fc2019-01-16 15:15:52 -08001567
Colin Cross331a1212018-08-15 20:40:52 -07001568 // merge dex jar with resources if necessary
1569 if j.resourceJar != nil {
1570 jars := android.Paths{dexOutputFile, j.resourceJar}
1571 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
1572 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1573 false, nil, nil)
Nicolas Geoffrayf3438722019-01-23 15:57:21 +00001574 if j.deviceProperties.UncompressDex {
1575 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
1576 TransformZipAlign(ctx, combinedAlignedJar, combinedJar)
1577 dexOutputFile = combinedAlignedJar
1578 } else {
1579 dexOutputFile = combinedJar
1580 }
Colin Cross331a1212018-08-15 20:40:52 -07001581 }
1582
1583 j.dexJarFile = dexOutputFile
1584
Colin Cross8faf8fc2019-01-16 15:15:52 -08001585 // Dexpreopting
Colin Cross43f08db2018-11-12 10:13:39 -08001586 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
1587
1588 j.maybeStrippedDexJarFile = dexOutputFile
1589
Colin Cross3063b782018-08-15 11:19:12 -07001590 outputFile = dexOutputFile
Colin Cross43f08db2018-11-12 10:13:39 -08001591
1592 if ctx.Failed() {
1593 return
1594 }
Colin Cross331a1212018-08-15 20:40:52 -07001595 } else {
1596 outputFile = implementationAndResourcesJar
Colin Cross2fe66872015-03-30 17:20:39 -07001597 }
Colin Cross331a1212018-08-15 20:40:52 -07001598
Colin Crossb7a63242015-04-16 14:09:14 -07001599 ctx.CheckbuildFile(outputFile)
Colin Cross3063b782018-08-15 11:19:12 -07001600
1601 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1602 j.outputFile = outputFile.WithoutRel()
Colin Cross2fe66872015-03-30 17:20:39 -07001603}
1604
Colin Cross3b706fd2019-09-05 16:44:18 -07001605func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
1606 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.WritablePath {
1607
1608 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
1609 if idx >= 0 {
1610 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
1611 jarName += strconv.Itoa(idx)
1612 }
1613
1614 classes := android.PathForModuleOut(ctx, "javac", jarName)
1615 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, flags, extraJarDeps)
1616
1617 if ctx.Config().EmitXrefRules() {
1618 extractionFile := android.PathForModuleOut(ctx, kzipName)
1619 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1620 j.kytheFiles = append(j.kytheFiles, extractionFile)
1621 }
1622
1623 return classes
1624}
1625
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001626// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1627// since some of these flags may be used internally.
1628func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1629 for _, flag := range flags {
1630 flag = strings.TrimSpace(flag)
1631
1632 if !strings.HasPrefix(flag, "-") {
1633 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1634 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1635 ctx.PropertyErrorf("kotlincflags",
1636 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1637 } else if inList(flag, config.KotlincIllegalFlags) {
1638 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1639 } else if flag == "-include-runtime" {
1640 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1641 } else {
1642 args := strings.Split(flag, " ")
1643 if args[0] == "-kotlin-home" {
1644 ctx.PropertyErrorf("kotlincflags",
1645 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1646 }
1647 }
1648 }
1649}
1650
Colin Cross8eadbf02017-10-24 17:46:00 -07001651func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
Colin Crossf7d84012020-02-21 08:16:41 -08001652 deps deps, flags javaBuilderFlags, jarName string,
1653 extraJars android.Paths) (headerJar, jarjarHeaderJar android.Path) {
Nan Zhanged19fc32017-10-19 13:06:22 -07001654
1655 var jars android.Paths
Colin Cross8eadbf02017-10-24 17:46:00 -07001656 if len(srcFiles) > 0 || len(srcJars) > 0 {
Nan Zhanged19fc32017-10-19 13:06:22 -07001657 // Compile java sources into turbine.jar.
1658 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1659 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1660 if ctx.Failed() {
Colin Crossf7d84012020-02-21 08:16:41 -08001661 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001662 }
1663 jars = append(jars, turbineJar)
1664 }
1665
Colin Cross55f63ea2018-08-27 12:37:09 -07001666 jars = append(jars, extraJars...)
1667
Nan Zhanged19fc32017-10-19 13:06:22 -07001668 // Combine any static header libraries into classes-header.jar. If there is only
1669 // one input jar this step will be skipped.
Nan Zhanged19fc32017-10-19 13:06:22 -07001670 jars = append(jars, deps.staticHeaderJars...)
1671
Colin Cross5c6ecc12017-10-23 18:12:27 -07001672 // we cannot skip the combine step for now if there is only one jar
1673 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1674 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001675 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
Colin Cross6c6e6cd2019-05-08 14:30:12 -07001676 false, nil, []string{"META-INF/TRANSITIVE"})
Colin Cross5c6ecc12017-10-23 18:12:27 -07001677 headerJar = combinedJar
Colin Crossf7d84012020-02-21 08:16:41 -08001678 jarjarHeaderJar = combinedJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001679
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001680 if j.expandJarjarRules != nil {
Nan Zhanged19fc32017-10-19 13:06:22 -07001681 // Transform classes.jar into classes-jarjar.jar
1682 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001683 TransformJarJar(ctx, jarjarFile, headerJar, j.expandJarjarRules)
Colin Crossf7d84012020-02-21 08:16:41 -08001684 jarjarHeaderJar = jarjarFile
Nan Zhanged19fc32017-10-19 13:06:22 -07001685 if ctx.Failed() {
Colin Crossf7d84012020-02-21 08:16:41 -08001686 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001687 }
1688 }
1689
Colin Crossf7d84012020-02-21 08:16:41 -08001690 return headerJar, jarjarHeaderJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001691}
1692
Colin Crosscb933592017-11-22 13:49:43 -08001693func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross3063b782018-08-15 11:19:12 -07001694 classesJar android.Path, jarName string) android.ModuleOutPath {
Colin Crosscb933592017-11-22 13:49:43 -08001695
Colin Cross7a3139e2017-12-19 13:57:50 -08001696 specs := j.jacocoModuleToZipCommand(ctx)
Colin Crosscb933592017-11-22 13:49:43 -08001697
Colin Cross84c38822018-01-03 15:59:46 -08001698 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Crosscb933592017-11-22 13:49:43 -08001699 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
1700
1701 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1702
1703 j.jacocoReportClassesFile = jacocoReportClassesFile
1704
1705 return instrumentedJar
1706}
1707
albaltai36ff7dc2018-12-25 14:35:23 +08001708var _ Dependency = (*Module)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001709
Nan Zhanged19fc32017-10-19 13:06:22 -07001710func (j *Module) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001711 if j.headerJarFile == nil {
1712 return nil
1713 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001714 return android.Paths{j.headerJarFile}
1715}
1716
1717func (j *Module) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08001718 if j.implementationJarFile == nil {
1719 return nil
1720 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001721 return android.Paths{j.implementationJarFile}
Colin Cross2fe66872015-03-30 17:20:39 -07001722}
1723
Colin Crossf24a22a2019-01-31 14:12:44 -08001724func (j *Module) DexJar() android.Path {
1725 return j.dexJarFile
1726}
1727
Colin Cross331a1212018-08-15 20:40:52 -07001728func (j *Module) ResourceJars() android.Paths {
1729 if j.resourceJar == nil {
1730 return nil
1731 }
1732 return android.Paths{j.resourceJar}
1733}
1734
1735func (j *Module) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001736 if j.implementationAndResourcesJar == nil {
1737 return nil
1738 }
Colin Cross331a1212018-08-15 20:40:52 -07001739 return android.Paths{j.implementationAndResourcesJar}
1740}
1741
Colin Cross46c9b8b2017-06-22 16:51:17 -07001742func (j *Module) AidlIncludeDirs() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001743 // exportAidlIncludeDirs is type android.Paths already
Colin Crossc0b06f12015-04-08 13:03:43 -07001744 return j.exportAidlIncludeDirs
1745}
1746
Jiyong Park1be96912018-05-28 18:02:19 +09001747func (j *Module) ExportedSdkLibs() []string {
albaltai36ff7dc2018-12-25 14:35:23 +08001748 // exportedSdkLibs is type []string
Jiyong Park1be96912018-05-28 18:02:19 +09001749 return j.exportedSdkLibs
1750}
1751
Artur Satayev9cf46692019-11-26 18:08:34 +00001752func (j *Module) ExportedPlugins() (android.Paths, []string) {
1753 return j.exportedPluginJars, j.exportedPluginClasses
1754}
1755
Colin Cross0c4ce212019-05-03 15:28:19 -07001756func (j *Module) SrcJarArgs() ([]string, android.Paths) {
1757 return j.srcJarArgs, j.srcJarDeps
1758}
1759
Colin Cross46c9b8b2017-06-22 16:51:17 -07001760var _ logtagsProducer = (*Module)(nil)
Colin Crossf05fe972015-04-10 17:45:20 -07001761
Colin Cross46c9b8b2017-06-22 16:51:17 -07001762func (j *Module) logtags() android.Paths {
Colin Crossf05fe972015-04-10 17:45:20 -07001763 return j.logtagsSrcs
1764}
1765
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001766// Collect information for opening IDE project files in java/jdeps.go.
1767func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
1768 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
1769 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
patricktu18c82ff2019-05-10 15:48:50 +08001770 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001771 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001772 if j.expandJarjarRules != nil {
1773 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001774 }
1775}
1776
1777func (j *Module) CompilerDeps() []string {
1778 jdeps := []string{}
1779 jdeps = append(jdeps, j.properties.Libs...)
1780 jdeps = append(jdeps, j.properties.Static_libs...)
1781 return jdeps
1782}
1783
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001784func (j *Module) hasCode(ctx android.ModuleContext) bool {
1785 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
1786 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
1787}
1788
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001789func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffin0d3c2e12020-05-17 08:34:50 +01001790 return j.depIsInSameApex(ctx, dep)
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001791}
1792
Jiyong Park0b238752019-10-29 11:23:10 +09001793func (j *Module) Stem() string {
1794 return proptools.StringDefault(j.deviceProperties.Stem, j.Name())
1795}
1796
Jiyong Park618922e2020-01-08 13:35:43 +09001797func (j *Module) JacocoReportClassesFile() android.Path {
1798 return j.jacocoReportClassesFile
1799}
1800
Martin Stjernholm6d415272020-01-31 17:10:36 +00001801func (j *Module) IsInstallable() bool {
1802 return Bool(j.properties.Installable)
1803}
1804
Colin Cross2fe66872015-03-30 17:20:39 -07001805//
1806// Java libraries (.jar file)
1807//
1808
Anton Hansson78156ef2020-03-27 19:39:48 +00001809type LibraryProperties struct {
1810 Dist struct {
1811 // The tag of the output of this module that should be output.
1812 Tag *string `android:"arch_variant"`
1813 } `android:"arch_variant"`
1814}
1815
Colin Crossf506d872017-07-19 15:53:04 -07001816type Library struct {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001817 Module
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001818
Anton Hansson78156ef2020-03-27 19:39:48 +00001819 libraryProperties LibraryProperties
1820
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001821 InstallMixin func(ctx android.ModuleContext, installPath android.Path) (extraInstallDeps android.Paths)
Colin Cross2fe66872015-03-30 17:20:39 -07001822}
1823
Colin Cross42be7612019-02-21 18:12:14 -08001824func shouldUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter) bool {
Ulya Trafimovichf491dde2020-01-24 12:19:45 +00001825 // Store uncompressed (and aligned) any dex files from jars in APEXes.
1826 if am, ok := ctx.Module().(android.ApexModule); ok && !am.IsForPlatform() {
1827 return true
1828 }
1829
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001830 // Store uncompressed (and do not strip) dex files from boot class path jars.
1831 if inList(ctx.ModuleName(), ctx.Config().BootJars()) {
1832 return true
1833 }
1834
1835 // Store uncompressed dex files that are preopted on /system.
Colin Cross42be7612019-02-21 18:12:14 -08001836 if !dexpreopter.dexpreoptDisabled(ctx) && (ctx.Host() || !odexOnSystemOther(ctx, dexpreopter.installPath)) {
Vladimir Markoe8b00d62018-12-21 15:54:16 +00001837 return true
1838 }
Colin Cross083a2aa2019-02-06 16:37:12 -08001839 if ctx.Config().UncompressPrivAppDex() &&
1840 inList(ctx.ModuleName(), ctx.Config().ModulesLoadedByPrivilegedModules()) {
1841 return true
1842 }
1843
Colin Cross2fc72f62018-12-21 12:59:54 -08001844 return false
1845}
1846
Colin Crossf506d872017-07-19 15:53:04 -07001847func (j *Library) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayev2db1c3f2020-04-08 19:09:30 +01001848 j.checkSdkVersions(ctx)
Jiyong Park0b238752019-10-29 11:23:10 +09001849 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross43f08db2018-11-12 10:13:39 -08001850 j.dexpreopter.isSDKLibrary = j.deviceProperties.IsSDKLibrary
Colin Cross42be7612019-02-21 18:12:14 -08001851 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001852 j.deviceProperties.UncompressDex = j.dexpreopter.uncompressedDex
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001853 j.compile(ctx, nil)
Colin Crossb7a63242015-04-16 14:09:14 -07001854
Jiyong Park7f7766d2019-07-25 22:02:35 +09001855 exclusivelyForApex := android.InAnyApex(ctx.ModuleName()) && !j.IsForPlatform()
1856 if (Bool(j.properties.Installable) || ctx.Host()) && !exclusivelyForApex {
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001857 var extraInstallDeps android.Paths
1858 if j.InstallMixin != nil {
1859 extraInstallDeps = j.InstallMixin(ctx, j.outputFile)
1860 }
Colin Cross2c429dc2017-08-31 16:45:16 -07001861 j.installFile = ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001862 ctx.ModuleName()+".jar", j.outputFile, extraInstallDeps...)
Colin Cross2c429dc2017-08-31 16:45:16 -07001863 }
Anton Hansson78156ef2020-03-27 19:39:48 +00001864
1865 // Verify Dist.Tag is set to a supported output
1866 if j.libraryProperties.Dist.Tag != nil {
1867 distFiles, err := j.OutputFiles(*j.libraryProperties.Dist.Tag)
1868 if err != nil {
1869 ctx.PropertyErrorf("dist.tag", "%s", err.Error())
1870 }
1871 j.distFile = distFiles[0]
1872 }
Colin Crossb7a63242015-04-16 14:09:14 -07001873}
1874
Colin Crossf506d872017-07-19 15:53:04 -07001875func (j *Library) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001876 j.deps(ctx)
1877}
1878
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001879const (
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001880 aidlIncludeDir = "aidl"
1881 javaDir = "java"
1882 jarFileSuffix = ".jar"
1883 testConfigSuffix = "-AndroidTest.xml"
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001884)
1885
Paul Duffina0dbf432019-12-05 11:25:53 +00001886// path to the jar file of a java library. Relative to <sdk_root>/<api_dir>
Paul Duffina04c1072020-03-02 10:16:35 +00001887func sdkSnapshotFilePathForJar(osPrefix, name string) string {
1888 return sdkSnapshotFilePathForMember(osPrefix, name, jarFileSuffix)
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001889}
1890
Paul Duffina04c1072020-03-02 10:16:35 +00001891func sdkSnapshotFilePathForMember(osPrefix, name string, suffix string) string {
1892 return filepath.Join(javaDir, osPrefix, name+suffix)
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001893}
1894
Paul Duffin13879572019-11-28 14:31:38 +00001895type librarySdkMemberType struct {
Paul Duffin255f18e2019-12-13 11:22:16 +00001896 android.SdkMemberTypeBase
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00001897
1898 // Function to retrieve the appropriate output jar (implementation or header) from
1899 // the library.
1900 jarToExportGetter func(j *Library) android.Path
Paul Duffin13879572019-11-28 14:31:38 +00001901}
1902
1903func (mt *librarySdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
1904 mctx.AddVariationDependencies(nil, dependencyTag, names...)
1905}
1906
1907func (mt *librarySdkMemberType) IsInstance(module android.Module) bool {
1908 _, ok := module.(*Library)
1909 return ok
1910}
1911
Paul Duffin3a4eb502020-03-19 16:11:18 +00001912func (mt *librarySdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
1913 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_import")
Paul Duffin14eb4672020-03-02 11:33:02 +00001914}
Paul Duffina0dbf432019-12-05 11:25:53 +00001915
Paul Duffin14eb4672020-03-02 11:33:02 +00001916func (mt *librarySdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
Paul Duffina551a1c2020-03-17 21:04:24 +00001917 return &librarySdkMemberProperties{}
Paul Duffin14eb4672020-03-02 11:33:02 +00001918}
1919
1920type librarySdkMemberProperties struct {
1921 android.SdkMemberPropertiesBase
1922
Paul Duffin864e1b42020-05-06 10:23:19 +01001923 JarToExport android.Path `android:"arch_variant"`
Paul Duffina551a1c2020-03-17 21:04:24 +00001924 AidlIncludeDirs android.Paths
Paul Duffin14eb4672020-03-02 11:33:02 +00001925}
1926
Paul Duffin3a4eb502020-03-19 16:11:18 +00001927func (p *librarySdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin13879572019-11-28 14:31:38 +00001928 j := variant.(*Library)
1929
Paul Duffina551a1c2020-03-17 21:04:24 +00001930 p.JarToExport = ctx.MemberType().(*librarySdkMemberType).jarToExportGetter(j)
1931 p.AidlIncludeDirs = j.AidlIncludeDirs()
Paul Duffin14eb4672020-03-02 11:33:02 +00001932}
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001933
Paul Duffin3a4eb502020-03-19 16:11:18 +00001934func (p *librarySdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffina551a1c2020-03-17 21:04:24 +00001935 builder := ctx.SnapshotBuilder()
Paul Duffin3a4eb502020-03-19 16:11:18 +00001936
Paul Duffina551a1c2020-03-17 21:04:24 +00001937 exportedJar := p.JarToExport
1938 if exportedJar != nil {
1939 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
Paul Duffin14eb4672020-03-02 11:33:02 +00001940 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
1941
Paul Duffina551a1c2020-03-17 21:04:24 +00001942 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
1943 }
1944
1945 aidlIncludeDirs := p.AidlIncludeDirs
1946 if len(aidlIncludeDirs) != 0 {
1947 sdkModuleContext := ctx.SdkModuleContext()
1948 for _, dir := range aidlIncludeDirs {
Paul Duffin14eb4672020-03-02 11:33:02 +00001949 // TODO(jiyong): copy parcelable declarations only
1950 aidlFiles, _ := sdkModuleContext.GlobWithDeps(dir.String()+"/**/*.aidl", nil)
1951 for _, file := range aidlFiles {
1952 builder.CopyToSnapshot(android.PathForSource(sdkModuleContext, file), filepath.Join(aidlIncludeDir, file))
1953 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001954 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001955
Paul Duffina551a1c2020-03-17 21:04:24 +00001956 // TODO(b/151933053) - add aidl include dirs property
Paul Duffin14eb4672020-03-02 11:33:02 +00001957 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001958}
1959
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00001960var javaHeaderLibsSdkMemberType android.SdkMemberType = &librarySdkMemberType{
1961 android.SdkMemberTypeBase{
1962 PropertyName: "java_header_libs",
1963 SupportsSdk: true,
Paul Duffin7b81f5e2020-01-13 21:03:22 +00001964 },
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00001965 func(j *Library) android.Path {
Paul Duffina0dbf432019-12-05 11:25:53 +00001966 headerJars := j.HeaderJars()
1967 if len(headerJars) != 1 {
1968 panic(fmt.Errorf("there must be only one header jar from %q", j.Name()))
1969 }
1970
1971 return headerJars[0]
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00001972 },
Paul Duffina0dbf432019-12-05 11:25:53 +00001973}
1974
Colin Cross1b16b0e2019-02-12 14:41:32 -08001975// java_library builds and links sources into a `.jar` file for the device, and possibly for the host as well.
1976//
1977// By default, a java_library has a single variant that produces a `.jar` file containing `.class` files that were
1978// compiled against the device bootclasspath. This jar is not suitable for installing on a device, but can be used
1979// as a `static_libs` dependency of another module.
1980//
1981// Specifying `installable: true` will product a `.jar` file containing `classes.dex` files, suitable for installing on
1982// a device.
1983//
1984// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1985// compiled against the host bootclasspath.
Colin Cross9ae1b922018-06-26 17:59:05 -07001986func LibraryFactory() android.Module {
1987 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07001988
Colin Cross9ae1b922018-06-26 17:59:05 -07001989 module.AddProperties(
1990 &module.Module.properties,
1991 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001992 &module.Module.dexpreoptProperties,
Anton Hansson78156ef2020-03-27 19:39:48 +00001993 &module.Module.protoProperties,
1994 &module.libraryProperties)
Colin Cross2fe66872015-03-30 17:20:39 -07001995
Jiyong Park7f7766d2019-07-25 22:02:35 +09001996 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09001997 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09001998 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross9ae1b922018-06-26 17:59:05 -07001999 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002000}
2001
Colin Cross1b16b0e2019-02-12 14:41:32 -08002002// java_library_static is an obsolete alias for java_library.
2003func LibraryStaticFactory() android.Module {
2004 return LibraryFactory()
2005}
2006
2007// java_library_host builds and links sources into a `.jar` file for the host.
2008//
2009// A java_library_host has a single variant that produces a `.jar` file containing `.class` files that were
2010// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002011func LibraryHostFactory() android.Module {
2012 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07002013
Colin Cross6af17aa2017-09-20 12:59:05 -07002014 module.AddProperties(
2015 &module.Module.properties,
2016 &module.Module.protoProperties)
Colin Cross36242852017-06-23 15:06:31 -07002017
Colin Cross9ae1b922018-06-26 17:59:05 -07002018 module.Module.properties.Installable = proptools.BoolPtr(true)
2019
Jiyong Park7f7766d2019-07-25 22:02:35 +09002020 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002021 InitJavaModule(module, android.HostSupported)
Colin Cross36242852017-06-23 15:06:31 -07002022 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002023}
2024
2025//
Colin Crossb628ea52018-08-14 16:42:33 -07002026// Java Tests
Colin Cross05638fc2018-04-09 18:40:24 -07002027//
2028
2029type testProperties struct {
Colin Cross05638fc2018-04-09 18:40:24 -07002030 // list of compatibility suites (for example "cts", "vts") that the module should be
2031 // installed into.
2032 Test_suites []string `android:"arch_variant"`
Julien Despreze146e392018-08-02 15:00:46 -07002033
2034 // the name of the test configuration (for example "AndroidTest.xml") that should be
2035 // installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002036 Test_config *string `android:"path,arch_variant"`
Colin Crossd96ca352018-08-10 16:06:24 -07002037
Jack He33338892018-09-19 02:21:28 -07002038 // the name of the test configuration template (for example "AndroidTestTemplate.xml") that
2039 // should be installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002040 Test_config_template *string `android:"path,arch_variant"`
Jack He33338892018-09-19 02:21:28 -07002041
Colin Crossd96ca352018-08-10 16:06:24 -07002042 // list of files or filegroup modules that provide data that should be installed alongside
2043 // the test
Colin Cross27b922f2019-03-04 22:35:41 -08002044 Data []string `android:"path"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07002045
2046 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
2047 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
2048 // explicitly.
2049 Auto_gen_config *bool
Colin Cross05638fc2018-04-09 18:40:24 -07002050}
2051
Paul Duffin42df1442019-03-20 12:45:53 +00002052type testHelperLibraryProperties struct {
2053 // list of compatibility suites (for example "cts", "vts") that the module should be
2054 // installed into.
2055 Test_suites []string `android:"arch_variant"`
2056}
2057
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002058type prebuiltTestProperties struct {
2059 // list of compatibility suites (for example "cts", "vts") that the module should be
2060 // installed into.
2061 Test_suites []string `android:"arch_variant"`
2062
2063 // the name of the test configuration (for example "AndroidTest.xml") that should be
2064 // installed with the module.
2065 Test_config *string `android:"path,arch_variant"`
2066}
2067
Colin Cross05638fc2018-04-09 18:40:24 -07002068type Test struct {
2069 Library
2070
2071 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07002072
2073 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07002074 data android.Paths
Colin Cross303e21f2018-08-07 16:49:25 -07002075}
2076
Paul Duffin42df1442019-03-20 12:45:53 +00002077type TestHelperLibrary struct {
2078 Library
2079
2080 testHelperLibraryProperties testHelperLibraryProperties
2081}
2082
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002083type JavaTestImport struct {
2084 Import
2085
2086 prebuiltTestProperties prebuiltTestProperties
2087
2088 testConfig android.Path
2089}
2090
Colin Cross303e21f2018-08-07 16:49:25 -07002091func (j *Test) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Dan Shi6ffaaa82019-09-26 11:41:36 -07002092 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.testProperties.Test_config, j.testProperties.Test_config_template,
2093 j.testProperties.Test_suites, j.testProperties.Auto_gen_config)
Colin Cross8a497952019-03-05 22:25:09 -08002094 j.data = android.PathsForModuleSrc(ctx, j.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07002095
2096 j.Library.GenerateAndroidBuildActions(ctx)
Colin Cross05638fc2018-04-09 18:40:24 -07002097}
2098
Paul Duffin42df1442019-03-20 12:45:53 +00002099func (j *TestHelperLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2100 j.Library.GenerateAndroidBuildActions(ctx)
2101}
2102
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002103func (j *JavaTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2104 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.prebuiltTestProperties.Test_config, nil,
2105 j.prebuiltTestProperties.Test_suites, nil)
2106
2107 j.Import.GenerateAndroidBuildActions(ctx)
2108}
2109
2110type testSdkMemberType struct {
2111 android.SdkMemberTypeBase
2112}
2113
2114func (mt *testSdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
2115 mctx.AddVariationDependencies(nil, dependencyTag, names...)
2116}
2117
2118func (mt *testSdkMemberType) IsInstance(module android.Module) bool {
2119 _, ok := module.(*Test)
2120 return ok
2121}
2122
Paul Duffin3a4eb502020-03-19 16:11:18 +00002123func (mt *testSdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
2124 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_test_import")
Paul Duffin14eb4672020-03-02 11:33:02 +00002125}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002126
Paul Duffin14eb4672020-03-02 11:33:02 +00002127func (mt *testSdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
2128 return &testSdkMemberProperties{}
2129}
2130
2131type testSdkMemberProperties struct {
2132 android.SdkMemberPropertiesBase
2133
Paul Duffina551a1c2020-03-17 21:04:24 +00002134 JarToExport android.Path
2135 TestConfig android.Path
Paul Duffin14eb4672020-03-02 11:33:02 +00002136}
2137
Paul Duffin3a4eb502020-03-19 16:11:18 +00002138func (p *testSdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin14eb4672020-03-02 11:33:02 +00002139 test := variant.(*Test)
2140
2141 implementationJars := test.ImplementationJars()
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002142 if len(implementationJars) != 1 {
Paul Duffin14eb4672020-03-02 11:33:02 +00002143 panic(fmt.Errorf("there must be only one implementation jar from %q", test.Name()))
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002144 }
2145
Paul Duffina551a1c2020-03-17 21:04:24 +00002146 p.JarToExport = implementationJars[0]
2147 p.TestConfig = test.testConfig
Paul Duffin14eb4672020-03-02 11:33:02 +00002148}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002149
Paul Duffin3a4eb502020-03-19 16:11:18 +00002150func (p *testSdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffina551a1c2020-03-17 21:04:24 +00002151 builder := ctx.SnapshotBuilder()
Paul Duffin3a4eb502020-03-19 16:11:18 +00002152
Paul Duffina551a1c2020-03-17 21:04:24 +00002153 exportedJar := p.JarToExport
2154 if exportedJar != nil {
2155 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
2156 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
Paul Duffin14eb4672020-03-02 11:33:02 +00002157
2158 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
Paul Duffina551a1c2020-03-17 21:04:24 +00002159 }
2160
2161 testConfig := p.TestConfig
2162 if testConfig != nil {
2163 snapshotRelativeTestConfigPath := sdkSnapshotFilePathForMember(p.OsPrefix(), ctx.Name(), testConfigSuffix)
2164 builder.CopyToSnapshot(testConfig, snapshotRelativeTestConfigPath)
Paul Duffin14eb4672020-03-02 11:33:02 +00002165 propertySet.AddProperty("test_config", snapshotRelativeTestConfigPath)
2166 }
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002167}
2168
Colin Cross1b16b0e2019-02-12 14:41:32 -08002169// java_test builds a and links sources into a `.jar` file for the device, and possibly for the host as well, and
2170// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
2171//
2172// By default, a java_test has a single variant that produces a `.jar` file containing `classes.dex` files that were
2173// compiled against the device bootclasspath.
2174//
2175// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2176// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002177func TestFactory() android.Module {
2178 module := &Test{}
2179
2180 module.AddProperties(
2181 &module.Module.properties,
2182 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002183 &module.Module.dexpreoptProperties,
Colin Cross05638fc2018-04-09 18:40:24 -07002184 &module.Module.protoProperties,
2185 &module.testProperties)
2186
Colin Cross9ae1b922018-06-26 17:59:05 -07002187 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse3026872019-01-05 22:30:13 -08002188 module.Module.dexpreopter.isTest = true
Colin Cross9ae1b922018-06-26 17:59:05 -07002189
Colin Cross05638fc2018-04-09 18:40:24 -07002190 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002191 return module
2192}
2193
Paul Duffin42df1442019-03-20 12:45:53 +00002194// java_test_helper_library creates a java library and makes sure that it is added to the appropriate test suite.
2195func TestHelperLibraryFactory() android.Module {
2196 module := &TestHelperLibrary{}
2197
2198 module.AddProperties(
2199 &module.Module.properties,
2200 &module.Module.deviceProperties,
2201 &module.Module.dexpreoptProperties,
2202 &module.Module.protoProperties,
2203 &module.testHelperLibraryProperties)
2204
Colin Cross9a4abed2019-04-24 13:19:28 -07002205 module.Module.properties.Installable = proptools.BoolPtr(true)
2206 module.Module.dexpreopter.isTest = true
2207
Paul Duffin42df1442019-03-20 12:45:53 +00002208 InitJavaModule(module, android.HostAndDeviceSupported)
2209 return module
2210}
2211
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002212// java_test_import imports one or more `.jar` files into the build graph as if they were built by a java_test module
2213// and makes sure that it is added to the appropriate test suite.
2214//
2215// By default, a java_test_import has a single variant that expects a `.jar` file containing `.class` files that were
2216// compiled against an Android classpath.
2217//
2218// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2219// for host modules.
2220func JavaTestImportFactory() android.Module {
2221 module := &JavaTestImport{}
2222
2223 module.AddProperties(
2224 &module.Import.properties,
2225 &module.prebuiltTestProperties)
2226
2227 module.Import.properties.Installable = proptools.BoolPtr(true)
2228
2229 android.InitPrebuiltModule(module, &module.properties.Jars)
2230 android.InitApexModule(module)
2231 android.InitSdkAwareModule(module)
2232 InitJavaModule(module, android.HostAndDeviceSupported)
2233 return module
2234}
2235
Colin Cross1b16b0e2019-02-12 14:41:32 -08002236// java_test_host builds a and links sources into a `.jar` file for the host, and creates an `AndroidTest.xml` file to
2237// allow running the test with `atest` or a `TEST_MAPPING` file.
2238//
2239// A java_test_host has a single variant that produces a `.jar` file containing `.class` files that were
2240// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002241func TestHostFactory() android.Module {
2242 module := &Test{}
2243
2244 module.AddProperties(
2245 &module.Module.properties,
2246 &module.Module.protoProperties,
2247 &module.testProperties)
2248
Colin Cross9ae1b922018-06-26 17:59:05 -07002249 module.Module.properties.Installable = proptools.BoolPtr(true)
2250
Colin Cross05638fc2018-04-09 18:40:24 -07002251 InitJavaModule(module, android.HostSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002252 return module
2253}
2254
2255//
Colin Cross2fe66872015-03-30 17:20:39 -07002256// Java Binaries (.jar file plus wrapper script)
2257//
2258
Colin Crossf506d872017-07-19 15:53:04 -07002259type binaryProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -07002260 // installable script to execute the resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -08002261 Wrapper *string `android:"path"`
Colin Cross094054a2018-10-17 15:10:48 -07002262
2263 // Name of the class containing main to be inserted into the manifest as Main-Class.
2264 Main_class *string
Colin Cross7d5136f2015-05-11 13:39:40 -07002265}
2266
Colin Crossf506d872017-07-19 15:53:04 -07002267type Binary struct {
2268 Library
Colin Cross2fe66872015-03-30 17:20:39 -07002269
Colin Crossf506d872017-07-19 15:53:04 -07002270 binaryProperties binaryProperties
Colin Cross10a03492017-08-10 17:09:43 -07002271
Colin Cross6b4a32d2017-12-05 13:42:45 -08002272 isWrapperVariant bool
2273
Colin Crossc3315992017-12-08 19:12:36 -08002274 wrapperFile android.Path
Colin Cross70dda7e2019-10-01 22:05:35 -07002275 binaryFile android.InstallPath
Colin Cross2fe66872015-03-30 17:20:39 -07002276}
2277
Alex Light24237172017-10-26 09:46:21 -07002278func (j *Binary) HostToolPath() android.OptionalPath {
2279 return android.OptionalPathForPath(j.binaryFile)
2280}
2281
Colin Crossf506d872017-07-19 15:53:04 -07002282func (j *Binary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002283 if ctx.Arch().ArchType == android.Common {
2284 // Compile the jar
Colin Cross094054a2018-10-17 15:10:48 -07002285 if j.binaryProperties.Main_class != nil {
2286 if j.properties.Manifest != nil {
2287 ctx.PropertyErrorf("main_class", "main_class cannot be used when manifest is set")
2288 }
2289 manifestFile := android.PathForModuleOut(ctx, "manifest.txt")
2290 GenerateMainClassManifest(ctx, manifestFile, String(j.binaryProperties.Main_class))
2291 j.overrideManifest = android.OptionalPathForPath(manifestFile)
2292 }
2293
Colin Cross6b4a32d2017-12-05 13:42:45 -08002294 j.Library.GenerateAndroidBuildActions(ctx)
Nan Zhang3c807db2017-11-03 14:53:31 -07002295 } else {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002296 // Handle the binary wrapper
2297 j.isWrapperVariant = true
2298
Colin Cross366938f2017-12-11 16:29:02 -08002299 if j.binaryProperties.Wrapper != nil {
Colin Cross8a497952019-03-05 22:25:09 -08002300 j.wrapperFile = android.PathForModuleSrc(ctx, *j.binaryProperties.Wrapper)
Colin Cross6b4a32d2017-12-05 13:42:45 -08002301 } else {
2302 j.wrapperFile = android.PathForSource(ctx, "build/soong/scripts/jar-wrapper.sh")
2303 }
2304
2305 // Depend on the installed jar so that the wrapper doesn't get executed by
2306 // another build rule before the jar has been installed.
2307 jarFile := ctx.PrimaryModule().(*Binary).installFile
2308
2309 j.binaryFile = ctx.InstallExecutable(android.PathForModuleInstall(ctx, "bin"),
2310 ctx.ModuleName(), j.wrapperFile, jarFile)
Nan Zhang3c807db2017-11-03 14:53:31 -07002311 }
Colin Cross2fe66872015-03-30 17:20:39 -07002312}
2313
Colin Crossf506d872017-07-19 15:53:04 -07002314func (j *Binary) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002315 if ctx.Arch().ArchType == android.Common {
2316 j.deps(ctx)
2317 }
Colin Cross46c9b8b2017-06-22 16:51:17 -07002318}
2319
Colin Cross1b16b0e2019-02-12 14:41:32 -08002320// java_binary builds a `.jar` file and a shell script that executes it for the device, and possibly for the host
2321// as well.
2322//
2323// By default, a java_binary has a single variant that produces a `.jar` file containing `classes.dex` files that were
2324// compiled against the device bootclasspath.
2325//
2326// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2327// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002328func BinaryFactory() android.Module {
2329 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002330
Colin Cross36242852017-06-23 15:06:31 -07002331 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07002332 &module.Module.properties,
2333 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002334 &module.Module.dexpreoptProperties,
Colin Cross6af17aa2017-09-20 12:59:05 -07002335 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07002336 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002337
Colin Cross9ae1b922018-06-26 17:59:05 -07002338 module.Module.properties.Installable = proptools.BoolPtr(true)
2339
Colin Cross6b4a32d2017-12-05 13:42:45 -08002340 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibCommonFirst)
2341 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002342 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002343}
2344
Colin Cross1b16b0e2019-02-12 14:41:32 -08002345// java_binary_host builds a `.jar` file and a shell script that executes it for the host.
2346//
2347// A java_binary_host has a single variant that produces a `.jar` file containing `.class` files that were
2348// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002349func BinaryHostFactory() android.Module {
2350 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002351
Colin Cross36242852017-06-23 15:06:31 -07002352 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07002353 &module.Module.properties,
Colin Cross6af17aa2017-09-20 12:59:05 -07002354 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07002355 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002356
Colin Cross9ae1b922018-06-26 17:59:05 -07002357 module.Module.properties.Installable = proptools.BoolPtr(true)
2358
Colin Cross6b4a32d2017-12-05 13:42:45 -08002359 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommonFirst)
2360 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002361 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002362}
2363
2364//
2365// Java prebuilts
2366//
2367
Colin Cross74d73e22017-08-02 11:05:49 -07002368type ImportProperties struct {
Paul Duffina04c1072020-03-02 10:16:35 +00002369 Jars []string `android:"path,arch_variant"`
Colin Cross461bd1a2017-10-20 13:59:18 -07002370
Nan Zhangea568a42017-11-08 21:20:04 -08002371 Sdk_version *string
Colin Cross535e2cf2017-10-20 17:57:49 -07002372
2373 Installable *bool
Jiyong Park1be96912018-05-28 18:02:19 +09002374
2375 // List of shared java libs that this module has dependencies to
2376 Libs []string
Colin Cross37f6d792018-07-12 12:28:41 -07002377
2378 // List of files to remove from the jar file(s)
2379 Exclude_files []string
2380
2381 // List of directories to remove from the jar file(s)
2382 Exclude_dirs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -07002383
2384 // if set to true, run Jetifier against .jar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -07002385 Jetifier *bool
Jiyong Park4c4c0242019-10-21 14:53:15 +09002386
2387 // set the name of the output
2388 Stem *string
Jiyong Park19604de2020-03-24 16:44:11 +09002389
2390 Aidl struct {
2391 // directories that should be added as include directories for any aidl sources of modules
2392 // that depend on this module, as well as to aidl for this module.
2393 Export_include_dirs []string
2394 }
Colin Cross74d73e22017-08-02 11:05:49 -07002395}
2396
2397type Import struct {
Colin Cross635c3b02016-05-18 15:37:25 -07002398 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -07002399 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002400 android.ApexModuleBase
Colin Crossec7a0422017-07-07 14:47:12 -07002401 prebuilt android.Prebuilt
Jiyong Parkd1063c12019-07-17 20:08:41 +09002402 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -07002403
Paul Duffin0d3c2e12020-05-17 08:34:50 +01002404 // Functionality common to Module and Import.
2405 embeddableInModuleAndImport
2406
Colin Cross74d73e22017-08-02 11:05:49 -07002407 properties ImportProperties
2408
Colin Cross0a6e0072017-08-30 14:24:55 -07002409 combinedClasspathFile android.Path
Jiyong Park1be96912018-05-28 18:02:19 +09002410 exportedSdkLibs []string
Jiyong Park19604de2020-03-24 16:44:11 +09002411 exportAidlIncludeDirs android.Paths
Colin Cross2fe66872015-03-30 17:20:39 -07002412}
2413
Jiyong Park6a927c42020-01-21 02:03:43 +09002414func (j *Import) sdkVersion() sdkSpec {
2415 return sdkSpecFrom(String(j.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07002416}
2417
Jiyong Park6a927c42020-01-21 02:03:43 +09002418func (j *Import) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -07002419 return j.sdkVersion()
2420}
2421
Artur Satayev480e25b2020-04-27 18:53:18 +01002422func (j *Import) MinSdkVersion() string {
2423 return j.minSdkVersion().version.String()
2424}
2425
Colin Cross74d73e22017-08-02 11:05:49 -07002426func (j *Import) Prebuilt() *android.Prebuilt {
Colin Crossec7a0422017-07-07 14:47:12 -07002427 return &j.prebuilt
2428}
2429
Colin Cross74d73e22017-08-02 11:05:49 -07002430func (j *Import) PrebuiltSrcs() []string {
2431 return j.properties.Jars
2432}
2433
2434func (j *Import) Name() string {
Colin Cross5ea9bcc2017-07-27 15:41:32 -07002435 return j.prebuilt.Name(j.ModuleBase.Name())
2436}
2437
Jiyong Park0b238752019-10-29 11:23:10 +09002438func (j *Import) Stem() string {
2439 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2440}
2441
Jiyong Park618922e2020-01-08 13:35:43 +09002442func (a *Import) JacocoReportClassesFile() android.Path {
2443 return nil
2444}
2445
Colin Cross74d73e22017-08-02 11:05:49 -07002446func (j *Import) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross42d48b72018-08-29 14:10:52 -07002447 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Colin Cross1e676be2016-10-12 14:38:15 -07002448}
2449
Colin Cross74d73e22017-08-02 11:05:49 -07002450func (j *Import) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross8a497952019-03-05 22:25:09 -08002451 jars := android.PathsForModuleSrc(ctx, j.properties.Jars)
Colin Crosse1d62a82015-04-03 16:53:05 -07002452
Jiyong Park0b238752019-10-29 11:23:10 +09002453 jarName := j.Stem() + ".jar"
Nan Zhang4c819fb2018-08-27 18:31:46 -07002454 outputFile := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07002455 TransformJarsToJar(ctx, outputFile, "for prebuilts", jars, android.OptionalPath{},
2456 false, j.properties.Exclude_files, j.properties.Exclude_dirs)
Colin Cross1001a792019-03-21 22:21:39 -07002457 if Bool(j.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -07002458 inputFile := outputFile
2459 outputFile = android.PathForModuleOut(ctx, "jetifier", jarName)
2460 TransformJetifier(ctx, outputFile, inputFile)
2461 }
Colin Crosse9a275b2017-10-16 17:09:48 -07002462 j.combinedClasspathFile = outputFile
Jiyong Park1be96912018-05-28 18:02:19 +09002463
2464 ctx.VisitDirectDeps(func(module android.Module) {
2465 otherName := ctx.OtherModuleName(module)
2466 tag := ctx.OtherModuleDependencyTag(module)
2467
2468 switch dep := module.(type) {
2469 case Dependency:
2470 switch tag {
2471 case libTag, staticLibTag:
2472 // sdk lib names from dependencies are re-exported
2473 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
2474 }
2475 case SdkLibraryDependency:
2476 switch tag {
2477 case libTag:
2478 // names of sdk libs that are directly depended are exported
2479 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
2480 }
2481 }
2482 })
2483
2484 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002485 if Bool(j.properties.Installable) {
2486 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Park4c4c0242019-10-21 14:53:15 +09002487 jarName, outputFile)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002488 }
Jiyong Park19604de2020-03-24 16:44:11 +09002489
2490 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.properties.Aidl.Export_include_dirs)
Colin Cross2fe66872015-03-30 17:20:39 -07002491}
2492
Colin Cross74d73e22017-08-02 11:05:49 -07002493var _ Dependency = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002494
Nan Zhanged19fc32017-10-19 13:06:22 -07002495func (j *Import) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002496 if j.combinedClasspathFile == nil {
2497 return nil
2498 }
Colin Cross37f6d792018-07-12 12:28:41 -07002499 return android.Paths{j.combinedClasspathFile}
Nan Zhanged19fc32017-10-19 13:06:22 -07002500}
2501
2502func (j *Import) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08002503 if j.combinedClasspathFile == nil {
2504 return nil
2505 }
Colin Cross37f6d792018-07-12 12:28:41 -07002506 return android.Paths{j.combinedClasspathFile}
Colin Cross2fe66872015-03-30 17:20:39 -07002507}
2508
Colin Cross331a1212018-08-15 20:40:52 -07002509func (j *Import) ResourceJars() android.Paths {
2510 return nil
2511}
2512
2513func (j *Import) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002514 if j.combinedClasspathFile == nil {
2515 return nil
2516 }
Colin Cross331a1212018-08-15 20:40:52 -07002517 return android.Paths{j.combinedClasspathFile}
2518}
2519
Colin Crossf24a22a2019-01-31 14:12:44 -08002520func (j *Import) DexJar() android.Path {
2521 return nil
2522}
2523
Colin Cross74d73e22017-08-02 11:05:49 -07002524func (j *Import) AidlIncludeDirs() android.Paths {
Jiyong Park19604de2020-03-24 16:44:11 +09002525 return j.exportAidlIncludeDirs
Colin Crossc0b06f12015-04-08 13:03:43 -07002526}
2527
Jiyong Park1be96912018-05-28 18:02:19 +09002528func (j *Import) ExportedSdkLibs() []string {
2529 return j.exportedSdkLibs
2530}
2531
Artur Satayev9cf46692019-11-26 18:08:34 +00002532func (j *Import) ExportedPlugins() (android.Paths, []string) {
2533 return nil, nil
2534}
2535
Colin Cross0c4ce212019-05-03 15:28:19 -07002536func (j *Import) SrcJarArgs() ([]string, android.Paths) {
2537 return nil, nil
2538}
2539
Jiyong Park0f80c182020-01-31 02:49:53 +09002540func (j *Import) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffin0d3c2e12020-05-17 08:34:50 +01002541 return j.depIsInSameApex(ctx, dep)
Jiyong Park0f80c182020-01-31 02:49:53 +09002542}
2543
albaltai36ff7dc2018-12-25 14:35:23 +08002544// Add compile time check for interface implementation
2545var _ android.IDEInfo = (*Import)(nil)
2546var _ android.IDECustomizedModuleName = (*Import)(nil)
2547
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002548// Collect information for opening IDE project files in java/jdeps.go.
2549const (
2550 removedPrefix = "prebuilt_"
2551)
2552
2553func (j *Import) IDEInfo(dpInfo *android.IdeInfo) {
2554 dpInfo.Jars = append(dpInfo.Jars, j.PrebuiltSrcs()...)
2555}
2556
2557func (j *Import) IDECustomizedModuleName() string {
2558 // TODO(b/113562217): Extract the base module name from the Import name, often the Import name
2559 // has a prefix "prebuilt_". Remove the prefix explicitly if needed until we find a better
2560 // solution to get the Import name.
2561 name := j.Name()
2562 if strings.HasPrefix(name, removedPrefix) {
patricktubb640e02018-10-11 18:33:16 +08002563 name = strings.TrimPrefix(name, removedPrefix)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002564 }
2565 return name
2566}
2567
Colin Cross74d73e22017-08-02 11:05:49 -07002568var _ android.PrebuiltInterface = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002569
Colin Cross1b16b0e2019-02-12 14:41:32 -08002570// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library module.
2571//
2572// By default, a java_import has a single variant that expects a `.jar` file containing `.class` files that were
2573// compiled against an Android classpath.
2574//
2575// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2576// for host modules.
Colin Cross74d73e22017-08-02 11:05:49 -07002577func ImportFactory() android.Module {
2578 module := &Import{}
Colin Cross36242852017-06-23 15:06:31 -07002579
Colin Cross74d73e22017-08-02 11:05:49 -07002580 module.AddProperties(&module.properties)
2581
2582 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002583 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002584 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002585 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross36242852017-06-23 15:06:31 -07002586 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002587}
2588
Colin Cross1b16b0e2019-02-12 14:41:32 -08002589// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library_host
2590// module.
2591//
2592// A java_import_host has a single variant that expects a `.jar` file containing `.class` files that were
2593// compiled against a host bootclasspath.
Colin Cross74d73e22017-08-02 11:05:49 -07002594func ImportFactoryHost() android.Module {
2595 module := &Import{}
2596
2597 module.AddProperties(&module.properties)
2598
2599 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002600 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002601 InitJavaModule(module, android.HostSupported)
Colin Cross74d73e22017-08-02 11:05:49 -07002602 return module
2603}
2604
Colin Cross42be7612019-02-21 18:12:14 -08002605// dex_import module
2606
2607type DexImportProperties struct {
Colin Cross5cfc70d2019-07-15 13:36:55 -07002608 Jars []string `android:"path"`
Jiyong Park4c4c0242019-10-21 14:53:15 +09002609
2610 // set the name of the output
2611 Stem *string
Colin Cross42be7612019-02-21 18:12:14 -08002612}
2613
2614type DexImport struct {
2615 android.ModuleBase
2616 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002617 android.ApexModuleBase
Colin Cross42be7612019-02-21 18:12:14 -08002618 prebuilt android.Prebuilt
2619
2620 properties DexImportProperties
2621
2622 dexJarFile android.Path
2623 maybeStrippedDexJarFile android.Path
2624
2625 dexpreopter
2626}
2627
2628func (j *DexImport) Prebuilt() *android.Prebuilt {
2629 return &j.prebuilt
2630}
2631
2632func (j *DexImport) PrebuiltSrcs() []string {
2633 return j.properties.Jars
2634}
2635
2636func (j *DexImport) Name() string {
2637 return j.prebuilt.Name(j.ModuleBase.Name())
2638}
2639
Jiyong Park0b238752019-10-29 11:23:10 +09002640func (j *DexImport) Stem() string {
2641 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2642}
2643
Martin Stjernholm6d415272020-01-31 17:10:36 +00002644func (j *DexImport) IsInstallable() bool {
2645 return true
2646}
2647
Colin Cross42be7612019-02-21 18:12:14 -08002648func (j *DexImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2649 if len(j.properties.Jars) != 1 {
2650 ctx.PropertyErrorf("jars", "exactly one jar must be provided")
2651 }
2652
Jiyong Park0b238752019-10-29 11:23:10 +09002653 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross42be7612019-02-21 18:12:14 -08002654 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
2655
2656 inputJar := ctx.ExpandSource(j.properties.Jars[0], "jars")
2657 dexOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar")
2658
2659 if j.dexpreopter.uncompressedDex {
2660 rule := android.NewRuleBuilder()
2661
2662 temporary := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar.unaligned")
2663 rule.Temporary(temporary)
2664
2665 // use zip2zip to uncompress classes*.dex files
2666 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002667 BuiltTool(ctx, "zip2zip").
Colin Cross42be7612019-02-21 18:12:14 -08002668 FlagWithInput("-i ", inputJar).
2669 FlagWithOutput("-o ", temporary).
2670 FlagWithArg("-0 ", "'classes*.dex'")
2671
2672 // use zipalign to align uncompressed classes*.dex files
2673 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002674 BuiltTool(ctx, "zipalign").
Colin Cross42be7612019-02-21 18:12:14 -08002675 Flag("-f").
2676 Text("4").
2677 Input(temporary).
2678 Output(dexOutputFile)
2679
2680 rule.DeleteTemporaryFiles()
2681
2682 rule.Build(pctx, ctx, "uncompress_dex", "uncompress dex")
2683 } else {
2684 ctx.Build(pctx, android.BuildParams{
2685 Rule: android.Cp,
2686 Input: inputJar,
2687 Output: dexOutputFile,
2688 })
2689 }
2690
2691 j.dexJarFile = dexOutputFile
2692
2693 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
2694
2695 j.maybeStrippedDexJarFile = dexOutputFile
2696
2697 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
2698 ctx.ModuleName()+".jar", dexOutputFile)
2699}
2700
2701func (j *DexImport) DexJar() android.Path {
2702 return j.dexJarFile
2703}
2704
2705// dex_import imports a `.jar` file containing classes.dex files.
2706//
2707// A dex_import module cannot be used as a dependency of a java_* or android_* module, it can only be installed
2708// to the device.
2709func DexImportFactory() android.Module {
2710 module := &DexImport{}
2711
2712 module.AddProperties(&module.properties)
2713
2714 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002715 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002716 InitJavaModule(module, android.DeviceSupported)
Colin Cross42be7612019-02-21 18:12:14 -08002717 return module
2718}
2719
Colin Cross89536d42017-07-07 14:35:50 -07002720//
2721// Defaults
2722//
2723type Defaults struct {
2724 android.ModuleBase
2725 android.DefaultsModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002726 android.ApexModuleBase
Colin Cross89536d42017-07-07 14:35:50 -07002727}
2728
Colin Cross1b16b0e2019-02-12 14:41:32 -08002729// java_defaults provides a set of properties that can be inherited by other java or android modules.
2730//
2731// A module can use the properties from a java_defaults module using `defaults: ["defaults_module_name"]`. Each
2732// property in the defaults module that exists in the depending module will be prepended to the depending module's
2733// value for that property.
2734//
2735// Example:
2736//
2737// java_defaults {
2738// name: "example_defaults",
2739// srcs: ["common/**/*.java"],
2740// javacflags: ["-Xlint:all"],
2741// aaptflags: ["--auto-add-overlay"],
2742// }
2743//
2744// java_library {
2745// name: "example",
2746// defaults: ["example_defaults"],
2747// srcs: ["example/**/*.java"],
2748// }
2749//
2750// is functionally identical to:
2751//
2752// java_library {
2753// name: "example",
2754// srcs: [
2755// "common/**/*.java",
2756// "example/**/*.java",
2757// ],
2758// javacflags: ["-Xlint:all"],
2759// }
Colin Cross89536d42017-07-07 14:35:50 -07002760func defaultsFactory() android.Module {
2761 return DefaultsFactory()
2762}
2763
Paul Duffin47357662019-12-05 14:07:14 +00002764func DefaultsFactory() android.Module {
Colin Cross89536d42017-07-07 14:35:50 -07002765 module := &Defaults{}
2766
Colin Cross89536d42017-07-07 14:35:50 -07002767 module.AddProperties(
2768 &CompilerProperties{},
2769 &CompilerDeviceProperties{},
Colin Cross43f08db2018-11-12 10:13:39 -08002770 &DexpreoptProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08002771 &android.ProtoProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002772 &aaptProperties{},
2773 &androidLibraryProperties{},
2774 &appProperties{},
2775 &appTestProperties{},
Jaewoong Jung525443a2019-02-28 15:35:54 -08002776 &overridableAppProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002777 &ImportProperties{},
2778 &AARImportProperties{},
2779 &sdkLibraryProperties{},
Paul Duffin1b1e8062020-05-08 13:44:43 +01002780 &commonToSdkLibraryAndImportProperties{},
Colin Cross42be7612019-02-21 18:12:14 -08002781 &DexImportProperties{},
Jooyung Han18020ea2019-11-13 10:50:48 +09002782 &android.ApexProperties{},
Jaewoong Jungbf135462020-04-26 15:10:51 -07002783 &RuntimeResourceOverlayProperties{},
Colin Cross89536d42017-07-07 14:35:50 -07002784 )
2785
2786 android.InitDefaultsModule(module)
Colin Cross89536d42017-07-07 14:35:50 -07002787 return module
2788}
Nan Zhangea568a42017-11-08 21:20:04 -08002789
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002790func kytheExtractJavaFactory() android.Singleton {
2791 return &kytheExtractJavaSingleton{}
2792}
2793
2794type kytheExtractJavaSingleton struct {
2795}
2796
2797func (ks *kytheExtractJavaSingleton) GenerateBuildActions(ctx android.SingletonContext) {
2798 var xrefTargets android.Paths
2799 ctx.VisitAllModules(func(module android.Module) {
2800 if javaModule, ok := module.(xref); ok {
2801 xrefTargets = append(xrefTargets, javaModule.XrefJavaFiles()...)
2802 }
2803 })
2804 // TODO(asmundak): perhaps emit a rule to output a warning if there were no xrefTargets
2805 if len(xrefTargets) > 0 {
2806 ctx.Build(pctx, android.BuildParams{
2807 Rule: blueprint.Phony,
2808 Output: android.PathForPhony(ctx, "xref_java"),
2809 Inputs: xrefTargets,
2810 })
2811 }
2812}
2813
Nan Zhangea568a42017-11-08 21:20:04 -08002814var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07002815var BoolDefault = proptools.BoolDefault
Nan Zhangea568a42017-11-08 21:20:04 -08002816var String = proptools.String
Colin Cross0d0ba592018-02-20 13:33:42 -08002817var inList = android.InList