blob: 1ba940adaa03dc8ee17f500852e2b8c009b4be30 [file] [log] [blame]
Colin Cross2fe66872015-03-30 17:20:39 -07001// Copyright 2015 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package java
16
17// This file contains the module types for compiling Java for Android, and converts the properties
Colin Cross46c9b8b2017-06-22 16:51:17 -070018// into the flags and filenames necessary to pass to the Module. The final creation of the rules
Colin Cross2fe66872015-03-30 17:20:39 -070019// is handled in builder.go
20
21import (
Colin Crossf19b9bb2018-03-26 14:42:44 -070022 "fmt"
Colin Crossfc3674a2017-09-18 17:41:52 -070023 "path/filepath"
Colin Cross74d73e22017-08-02 11:05:49 -070024 "strconv"
Colin Cross2fe66872015-03-30 17:20:39 -070025 "strings"
26
27 "github.com/google/blueprint"
Colin Cross3b706fd2019-09-05 16:44:18 -070028 "github.com/google/blueprint/pathtools"
Colin Cross76b5f0c2017-08-29 16:02:06 -070029 "github.com/google/blueprint/proptools"
Colin Cross2fe66872015-03-30 17:20:39 -070030
Colin Cross635c3b02016-05-18 15:37:25 -070031 "android/soong/android"
Colin Cross3e3e72d2017-06-22 17:20:19 -070032 "android/soong/java/config"
Colin Cross303e21f2018-08-07 16:49:25 -070033 "android/soong/tradefed"
Colin Cross2fe66872015-03-30 17:20:39 -070034)
35
Colin Cross463a90e2015-06-17 14:20:06 -070036func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000037 RegisterJavaBuildComponents(android.InitRegistrationContext)
Paul Duffin255f18e2019-12-13 11:22:16 +000038
39 // Register sdk member types.
Paul Duffin7b81f5e2020-01-13 21:03:22 +000040 android.RegisterSdkMemberType(javaHeaderLibsSdkMemberType)
Paul Duffin255f18e2019-12-13 11:22:16 +000041
Paul Duffin2b9e3d32020-02-28 14:39:53 +000042 android.RegisterSdkMemberType(&librarySdkMemberType{
43 android.SdkMemberTypeBase{
44 PropertyName: "java_libs",
45 },
46 func(j *Library) android.Path {
47 implementationJars := j.ImplementationJars()
48 if len(implementationJars) != 1 {
49 panic(fmt.Errorf("there must be only one implementation jar from %q", j.Name()))
50 }
51
52 return implementationJars[0]
Paul Duffin255f18e2019-12-13 11:22:16 +000053 },
54 })
Paul Duffin1b82e6a2019-12-03 18:06:47 +000055
56 android.RegisterSdkMemberType(&testSdkMemberType{
57 SdkMemberTypeBase: android.SdkMemberTypeBase{
58 PropertyName: "java_tests",
59 },
60 })
Colin Cross463a90e2015-06-17 14:20:06 -070061}
62
Paul Duffinf9b1da02019-12-18 19:51:55 +000063func RegisterJavaBuildComponents(ctx android.RegistrationContext) {
64 ctx.RegisterModuleType("java_defaults", DefaultsFactory)
65
66 ctx.RegisterModuleType("java_library", LibraryFactory)
67 ctx.RegisterModuleType("java_library_static", LibraryStaticFactory)
68 ctx.RegisterModuleType("java_library_host", LibraryHostFactory)
69 ctx.RegisterModuleType("java_binary", BinaryFactory)
70 ctx.RegisterModuleType("java_binary_host", BinaryHostFactory)
71 ctx.RegisterModuleType("java_test", TestFactory)
72 ctx.RegisterModuleType("java_test_helper_library", TestHelperLibraryFactory)
73 ctx.RegisterModuleType("java_test_host", TestHostFactory)
Paul Duffin1b82e6a2019-12-03 18:06:47 +000074 ctx.RegisterModuleType("java_test_import", JavaTestImportFactory)
Paul Duffinf9b1da02019-12-18 19:51:55 +000075 ctx.RegisterModuleType("java_import", ImportFactory)
76 ctx.RegisterModuleType("java_import_host", ImportFactoryHost)
77 ctx.RegisterModuleType("java_device_for_host", DeviceForHostFactory)
78 ctx.RegisterModuleType("java_host_for_device", HostForDeviceFactory)
79 ctx.RegisterModuleType("dex_import", DexImportFactory)
80
Martin Stjernholm6d415272020-01-31 17:10:36 +000081 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
82 ctx.BottomUp("dexpreopt_tool_deps", dexpreoptToolDepsMutator).Parallel()
83 })
Martin Stjernholmd90676f2020-01-11 00:37:30 +000084
Paul Duffinf9b1da02019-12-18 19:51:55 +000085 ctx.RegisterSingletonType("logtags", LogtagsSingleton)
86 ctx.RegisterSingletonType("kythe_java_extract", kytheExtractJavaFactory)
87}
88
Artur Satayev2eedf622020-04-15 17:29:42 +010089func (j *Module) CheckStableSdkVersion() error {
90 sdkVersion := j.sdkVersion()
91 if sdkVersion.stable() {
92 return nil
93 }
94 return fmt.Errorf("non stable SDK %v", sdkVersion)
95}
96
Artur Satayeve5ac15a2020-04-08 19:09:30 +010097func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
Colin Crosseb032962020-05-13 11:05:02 -070098 if j.RequiresStableAPIs(ctx) {
Jeongik Cha2cc570d2019-10-29 15:44:45 +090099 if sc, ok := ctx.Module().(sdkContext); ok {
Jiyong Park6a927c42020-01-21 02:03:43 +0900100 if !sc.sdkVersion().specified() {
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900101 ctx.PropertyErrorf("sdk_version",
102 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
103 }
104 }
105 }
Artur Satayeve5ac15a2020-04-08 19:09:30 +0100106
107 ctx.VisitDirectDeps(func(module android.Module) {
108 tag := ctx.OtherModuleDependencyTag(module)
109 switch module.(type) {
110 // TODO(satayev): cover other types as well, e.g. imports
111 case *Library, *AndroidLibrary:
112 switch tag {
113 case bootClasspathTag, libTag, staticLibTag, java9LibTag:
114 checkLinkType(ctx, j, module.(linkTypeContext), tag.(dependencyTag))
115 }
116 }
117 })
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900118}
119
Jeongik Cha538c0d02019-07-11 15:54:27 +0900120func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
121 if sc, ok := ctx.Module().(sdkContext); ok {
122 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park6a927c42020-01-21 02:03:43 +0900123 sdkVersionSpecified := sc.sdkVersion().specified()
124 if usePlatformAPI && sdkVersionSpecified {
125 ctx.PropertyErrorf("platform_apis", "platform_apis must be false when sdk_version is not empty.")
126 } else if !usePlatformAPI && !sdkVersionSpecified {
127 ctx.PropertyErrorf("platform_apis", "platform_apis must be true when sdk_version is empty.")
Jeongik Cha538c0d02019-07-11 15:54:27 +0900128 }
129
130 }
131}
132
Colin Cross2fe66872015-03-30 17:20:39 -0700133// TODO:
134// Autogenerated files:
Colin Cross2fe66872015-03-30 17:20:39 -0700135// Renderscript
136// Post-jar passes:
137// Proguard
Colin Cross2fe66872015-03-30 17:20:39 -0700138// Rmtypedefs
Colin Cross2fe66872015-03-30 17:20:39 -0700139// DroidDoc
140// Findbugs
141
Colin Cross89536d42017-07-07 14:35:50 -0700142type CompilerProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -0700143 // list of source files used to compile the Java module. May be .java, .logtags, .proto,
144 // or .aidl files.
Colin Cross27b922f2019-03-04 22:35:41 -0800145 Srcs []string `android:"path,arch_variant"`
Dan Willemsen2ef08f42015-06-30 18:15:24 -0700146
147 // list of source files that should not be used to build the Java module.
148 // This is most useful in the arch/multilib variants to remove non-common files
Colin Cross27b922f2019-03-04 22:35:41 -0800149 Exclude_srcs []string `android:"path,arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700150
151 // list of directories containing Java resources
Colin Cross86a63ff2017-09-27 17:33:10 -0700152 Java_resource_dirs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700153
Colin Cross86a63ff2017-09-27 17:33:10 -0700154 // list of directories that should be excluded from java_resource_dirs
155 Exclude_java_resource_dirs []string `android:"arch_variant"`
Dan Willemsen2ef08f42015-06-30 18:15:24 -0700156
Colin Cross0f37af02017-09-27 17:42:05 -0700157 // list of files to use as Java resources
Colin Cross27b922f2019-03-04 22:35:41 -0800158 Java_resources []string `android:"path,arch_variant"`
Colin Cross0f37af02017-09-27 17:42:05 -0700159
Colin Crosscedd4762018-09-13 11:26:19 -0700160 // list of files that should be excluded from java_resources and java_resource_dirs
Colin Cross27b922f2019-03-04 22:35:41 -0800161 Exclude_java_resources []string `android:"path,arch_variant"`
Colin Cross0f37af02017-09-27 17:42:05 -0700162
Colin Cross7d5136f2015-05-11 13:39:40 -0700163 // list of module-specific flags that will be used for javac compiles
164 Javacflags []string `android:"arch_variant"`
165
Zoran Jovanovic8736ce22018-08-21 17:10:29 +0200166 // list of module-specific flags that will be used for kotlinc compiles
167 Kotlincflags []string `android:"arch_variant"`
168
Colin Cross7d5136f2015-05-11 13:39:40 -0700169 // list of of java libraries that will be in the classpath
Colin Crosse8dc34a2017-07-19 11:22:16 -0700170 Libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700171
172 // list of java libraries that will be compiled into the resulting jar
Colin Crosse8dc34a2017-07-19 11:22:16 -0700173 Static_libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700174
175 // manifest file to be included in resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -0800176 Manifest *string `android:"path"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700177
Colin Cross540eff82017-06-22 17:01:52 -0700178 // if not blank, run jarjar using the specified rules file
Colin Cross27b922f2019-03-04 22:35:41 -0800179 Jarjar_rules *string `android:"path,arch_variant"`
Colin Cross64162712017-08-08 13:17:59 -0700180
181 // If not blank, set the java version passed to javac as -source and -target
182 Java_version *string
Colin Cross2c429dc2017-08-31 16:45:16 -0700183
Colin Cross9ae1b922018-06-26 17:59:05 -0700184 // If set to true, allow this module to be dexed and installed on devices. Has no
185 // effect on host modules, which are always considered installable.
Colin Cross2c429dc2017-08-31 16:45:16 -0700186 Installable *bool
Colin Cross32f676a2017-09-06 13:41:06 -0700187
Colin Cross0f37af02017-09-27 17:42:05 -0700188 // If set to true, include sources used to compile the module in to the final jar
189 Include_srcs *bool
190
Vladimir Marko0975ee02019-04-02 10:29:55 +0100191 // If not empty, classes are restricted to the specified packages and their sub-packages.
192 // This restriction is checked after applying jarjar rules and including static libs.
193 Permitted_packages []string
194
Colin Crossbe9cdb82019-01-21 21:37:16 -0800195 // List of modules to use as annotation processors
196 Plugins []string
Colin Cross1369cdb2017-09-29 17:58:17 -0700197
Artur Satayev9cf46692019-11-26 18:08:34 +0000198 // List of modules to export to libraries that directly depend on this library as annotation processors
199 Exported_plugins []string
200
Nan Zhang61eaedb2017-11-02 13:28:15 -0700201 // The number of Java source entries each Javac instance can process
202 Javac_shard_size *int64
203
Nan Zhang5f8cb422018-02-06 10:34:32 -0800204 // Add host jdk tools.jar to bootclasspath
205 Use_tools_jar *bool
206
Colin Cross1369cdb2017-09-29 17:58:17 -0700207 Openjdk9 struct {
Colin Cross6cef4812019-10-17 14:23:50 -0700208 // List of source files that should only be used when passing -source 1.9 or higher
Colin Cross27b922f2019-03-04 22:35:41 -0800209 Srcs []string `android:"path"`
Colin Cross1369cdb2017-09-29 17:58:17 -0700210
Colin Cross6cef4812019-10-17 14:23:50 -0700211 // List of javac flags that should only be used when passing -source 1.9 or higher
Colin Cross1369cdb2017-09-29 17:58:17 -0700212 Javacflags []string
213 }
Colin Crosscb933592017-11-22 13:49:43 -0800214
Colin Cross81440082018-08-15 20:21:55 -0700215 // When compiling language level 9+ .java code in packages that are part of
216 // a system module, patch_module names the module that your sources and
217 // dependencies should be patched into. The Android runtime currently
218 // doesn't implement the JEP 261 module system so this option is only
219 // supported at compile time. It should only be needed to compile tests in
220 // packages that exist in libcore and which are inconvenient to move
221 // elsewhere.
Tobias Thiererdda713d2018-09-19 16:16:19 +0100222 Patch_module *string `android:"arch_variant"`
Colin Cross81440082018-08-15 20:21:55 -0700223
Colin Crosscb933592017-11-22 13:49:43 -0800224 Jacoco struct {
225 // List of classes to include for instrumentation with jacoco to collect coverage
226 // information at runtime when building with coverage enabled. If unset defaults to all
227 // classes.
228 // Supports '*' as the last character of an entry in the list as a wildcard match.
229 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
230 // it matches classes in the package that have the class name as a prefix.
231 Include_filter []string
232
233 // List of classes to exclude from instrumentation with jacoco to collect coverage
234 // information at runtime when building with coverage enabled. Overrides classes selected
235 // by the include_filter property.
236 // Supports '*' as the last character of an entry in the list as a wildcard match.
237 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
238 // it matches classes in the package that have the class name as a prefix.
239 Exclude_filter []string
240 }
241
Andreas Gampef3e5b552018-01-22 21:27:21 -0800242 Errorprone struct {
243 // List of javac flags that should only be used when running errorprone.
244 Javacflags []string
245 }
246
Colin Cross0f2ee152017-12-14 15:22:43 -0800247 Proto struct {
248 // List of extra options that will be passed to the proto generator.
249 Output_params []string
250 }
251
Colin Crosscb933592017-11-22 13:49:43 -0800252 Instrument bool `blueprint:"mutated"`
Alex Light7f004a72019-02-21 13:27:37 -0800253
254 // List of files to include in the META-INF/services folder of the resulting jar.
Colin Cross27b922f2019-03-04 22:35:41 -0800255 Services []string `android:"path,arch_variant"`
Colin 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
David Srbecky98c71222020-05-20 22:20:28 +0100345 // Keep the data uncompressed. We always need uncompressed dex for execution,
346 // so this might actually save space by avoiding storing the same data twice.
347 // This defaults to reasonable value based on module and should not be set.
348 // It exists only to support ART tests.
349 Uncompress_dex *bool
350
351 IsSDKLibrary bool `blueprint:"mutated"`
Songchun Fan688de9a2020-03-24 20:32:24 -0700352
353 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
354 // Defaults to false.
355 V4_signature *bool
Colin Cross7d5136f2015-05-11 13:39:40 -0700356}
357
Sasha Smundak2057f822019-04-16 17:16:58 -0700358func (me *CompilerDeviceProperties) EffectiveOptimizeEnabled() bool {
359 return BoolDefault(me.Optimize.Enabled, me.Optimize.EnabledByDefault)
360}
361
Paul Duffinc8f2f182020-05-17 08:34:50 +0100362// Functionality common to Module and Import
Paul Duffin64e61992020-05-15 10:20:31 +0100363//
364// It is embedded in Module so its functionality can be used by methods in Module
365// but it is currently only initialized by Import and Library.
Paul Duffinc8f2f182020-05-17 08:34:50 +0100366type embeddableInModuleAndImport struct {
Paul Duffin64e61992020-05-15 10:20:31 +0100367
368 // Functionality related to this being used as a component of a java_sdk_library.
369 EmbeddableSdkLibraryComponent
370}
371
372func (e *embeddableInModuleAndImport) initModuleAndImport(moduleBase *android.ModuleBase) {
373 e.initSdkLibraryComponent(moduleBase)
Paul Duffinc8f2f182020-05-17 08:34:50 +0100374}
375
376// Module/Import's DepIsInSameApex(...) delegates to this method.
377//
378// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
379// the one provided by ApexModuleBase.
380func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
381 // dependencies other than the static linkage are all considered crossing APEX boundary
382 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
383 return true
384 }
385 return false
386}
387
Colin Cross46c9b8b2017-06-22 16:51:17 -0700388// Module contains the properties and members used by all java module types
389type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700390 android.ModuleBase
Colin Cross89536d42017-07-07 14:35:50 -0700391 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +0900392 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900393 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -0700394
Paul Duffinc8f2f182020-05-17 08:34:50 +0100395 // Functionality common to Module and Import.
396 embeddableInModuleAndImport
397
Colin Cross89536d42017-07-07 14:35:50 -0700398 properties CompilerProperties
Colin Cross6af17aa2017-09-20 12:59:05 -0700399 protoProperties android.ProtoProperties
Colin Cross89536d42017-07-07 14:35:50 -0700400 deviceProperties CompilerDeviceProperties
Colin Cross2fe66872015-03-30 17:20:39 -0700401
Colin Cross331a1212018-08-15 20:40:52 -0700402 // jar file containing header classes including static library dependencies, suitable for
403 // inserting into the bootclasspath/classpath of another compile
Nan Zhanged19fc32017-10-19 13:06:22 -0700404 headerJarFile android.Path
405
Colin Cross331a1212018-08-15 20:40:52 -0700406 // jar file containing implementation classes including static library dependencies but no
407 // resources
Nan Zhanged19fc32017-10-19 13:06:22 -0700408 implementationJarFile android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700409
Colin Cross331a1212018-08-15 20:40:52 -0700410 // jar file containing only resources including from static library dependencies
411 resourceJar android.Path
412
Colin Cross0c4ce212019-05-03 15:28:19 -0700413 // args and dependencies to package source files into a srcjar
414 srcJarArgs []string
415 srcJarDeps android.Paths
416
Colin Cross331a1212018-08-15 20:40:52 -0700417 // jar file containing implementation classes and resources including static library
418 // dependencies
419 implementationAndResourcesJar android.Path
420
421 // output file containing classes.dex and resources
Colin Cross6ade34f2017-09-15 13:00:47 -0700422 dexJarFile android.Path
423
Colin Cross43f08db2018-11-12 10:13:39 -0800424 // output file that contains classes.dex if it should be in the output file
425 maybeStrippedDexJarFile android.Path
426
Colin Crosscb933592017-11-22 13:49:43 -0800427 // output file containing uninstrumented classes that will be instrumented by jacoco
428 jacocoReportClassesFile android.Path
429
Colin Cross66dbc0b2017-12-28 12:23:20 -0800430 // output file containing mapping of obfuscated names
431 proguardDictionary android.Path
432
Colin Cross331a1212018-08-15 20:40:52 -0700433 // output file of the module, which may be a classes jar or a dex jar
Colin Crosse560c4a2019-03-19 16:03:11 -0700434 outputFile android.Path
435 extraOutputFiles android.Paths
Colin Crossb7a63242015-04-16 14:09:14 -0700436
Colin Cross635c3b02016-05-18 15:37:25 -0700437 exportAidlIncludeDirs android.Paths
Colin Crossc0b06f12015-04-08 13:03:43 -0700438
Colin Cross635c3b02016-05-18 15:37:25 -0700439 logtagsSrcs android.Paths
Colin Crossf05fe972015-04-10 17:45:20 -0700440
Colin Cross2fe66872015-03-30 17:20:39 -0700441 // installed file for binary dependency
Colin Cross635c3b02016-05-18 15:37:25 -0700442 installFile android.Path
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800443
444 // list of .java files and srcjars that was passed to javac
445 compiledJavaSrcs android.Paths
446 compiledSrcJars android.Paths
Colin Cross66dbc0b2017-12-28 12:23:20 -0800447
448 // list of extra progurad flag files
449 extraProguardFlagFiles android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900450
Colin Cross094054a2018-10-17 15:10:48 -0700451 // manifest file to use instead of properties.Manifest
452 overrideManifest android.OptionalPath
453
Artur Satayev9cf46692019-11-26 18:08:34 +0000454 // list of SDK lib names that this java module is exporting
Jiyong Park1be96912018-05-28 18:02:19 +0900455 exportedSdkLibs []string
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700456
Artur Satayev9cf46692019-11-26 18:08:34 +0000457 // list of plugins that this java module is exporting
458 exportedPluginJars android.Paths
459
460 // list of plugins that this java module is exporting
461 exportedPluginClasses []string
462
463 // list of source files, collected from srcFiles with unique java and all kt files,
patricktu242faad2019-09-24 15:41:30 +0800464 // will be used by android.IDEInfo struct
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700465 expandIDEInfoCompiledSrcs []string
Colin Cross43f08db2018-11-12 10:13:39 -0800466
Steven Morelandc4efd9c2019-01-18 11:51:25 -0800467 // expanded Jarjar_rules
468 expandJarjarRules android.Path
469
Vladimir Marko0975ee02019-04-02 10:29:55 +0100470 // list of additional targets for checkbuild
471 additionalCheckedModules android.Paths
472
Colin Cross988708c2019-05-06 14:04:11 -0700473 // Extra files generated by the module type to be added as java resources.
474 extraResources android.Paths
475
Colin Crossf24a22a2019-01-31 14:12:44 -0800476 hiddenAPI
Colin Cross43f08db2018-11-12 10:13:39 -0800477 dexpreopter
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800478
479 // list of the xref extraction files
480 kytheFiles android.Paths
Anton Hansson1e65f942020-03-27 19:39:48 +0000481
482 distFile android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700483}
484
Colin Cross41955e82019-05-29 14:40:35 -0700485func (j *Module) OutputFiles(tag string) (android.Paths, error) {
486 switch tag {
487 case "":
488 return append(android.Paths{j.outputFile}, j.extraOutputFiles...), nil
Colin Cross375ca3c2019-05-29 14:40:58 -0700489 case ".jar":
490 return android.Paths{j.implementationAndResourcesJar}, nil
Colin Cross2d975b12019-07-29 16:47:42 -0700491 case ".proguard_map":
492 return android.Paths{j.proguardDictionary}, nil
Colin Cross41955e82019-05-29 14:40:35 -0700493 default:
494 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
495 }
Colin Cross54250902017-12-05 09:28:08 -0800496}
497
Colin Cross41955e82019-05-29 14:40:35 -0700498var _ android.OutputFileProducer = (*Module)(nil)
Colin Cross54250902017-12-05 09:28:08 -0800499
Colin Crossf506d872017-07-19 15:53:04 -0700500type Dependency interface {
Nan Zhanged19fc32017-10-19 13:06:22 -0700501 HeaderJars() android.Paths
502 ImplementationJars() android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700503 ResourceJars() android.Paths
504 ImplementationAndResourcesJars() android.Paths
Colin Crossf24a22a2019-01-31 14:12:44 -0800505 DexJar() android.Path
Colin Cross635c3b02016-05-18 15:37:25 -0700506 AidlIncludeDirs() android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900507 ExportedSdkLibs() []string
Artur Satayev9cf46692019-11-26 18:08:34 +0000508 ExportedPlugins() (android.Paths, []string)
Colin Cross0c4ce212019-05-03 15:28:19 -0700509 SrcJarArgs() ([]string, android.Paths)
Colin Crosse323f3c2019-09-17 15:34:09 -0700510 BaseModuleName() string
Jiyong Park618922e2020-01-08 13:35:43 +0900511 JacocoReportClassesFile() android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700512}
513
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800514type xref interface {
515 XrefJavaFiles() android.Paths
516}
517
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800518func (j *Module) XrefJavaFiles() android.Paths {
519 return j.kytheFiles
520}
521
Colin Cross89536d42017-07-07 14:35:50 -0700522func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
523 android.InitAndroidArchModule(module, hod, android.MultilibCommon)
524 android.InitDefaultableModule(module)
525}
526
Colin Crossbe1da472017-07-07 15:59:46 -0700527type dependencyTag struct {
528 blueprint.BaseDependencyTag
529 name string
Colin Cross2fe66872015-03-30 17:20:39 -0700530}
531
Colin Crossa4f08812018-10-02 22:03:40 -0700532type jniDependencyTag struct {
533 blueprint.BaseDependencyTag
Colin Crossa4f08812018-10-02 22:03:40 -0700534}
535
Jiyong Park8be103b2019-11-08 15:53:48 +0900536func IsJniDepTag(depTag blueprint.DependencyTag) bool {
537 _, ok := depTag.(*jniDependencyTag)
538 return ok
539}
540
Colin Crossbe1da472017-07-07 15:59:46 -0700541var (
Colin Cross4b964c02018-10-15 16:18:06 -0700542 staticLibTag = dependencyTag{name: "staticlib"}
543 libTag = dependencyTag{name: "javalib"}
Colin Cross6cef4812019-10-17 14:23:50 -0700544 java9LibTag = dependencyTag{name: "java9lib"}
Colin Crossbe9cdb82019-01-21 21:37:16 -0800545 pluginTag = dependencyTag{name: "plugin"}
Artur Satayev9cf46692019-11-26 18:08:34 +0000546 exportedPluginTag = dependencyTag{name: "exported-plugin"}
Colin Cross4b964c02018-10-15 16:18:06 -0700547 bootClasspathTag = dependencyTag{name: "bootclasspath"}
548 systemModulesTag = dependencyTag{name: "system modules"}
549 frameworkResTag = dependencyTag{name: "framework-res"}
550 frameworkApkTag = dependencyTag{name: "framework-apk"}
551 kotlinStdlibTag = dependencyTag{name: "kotlin-stdlib"}
Colin Crossafbb1732019-01-17 15:42:52 -0800552 kotlinAnnotationsTag = dependencyTag{name: "kotlin-annotations"}
Colin Cross4b964c02018-10-15 16:18:06 -0700553 proguardRaiseTag = dependencyTag{name: "proguard-raise"}
554 certificateTag = dependencyTag{name: "certificate"}
555 instrumentationForTag = dependencyTag{name: "instrumentation_for"}
Colin Cross50ddcc42019-05-16 12:28:22 -0700556 usesLibTag = dependencyTag{name: "uses-library"}
Colin Crossbe1da472017-07-07 15:59:46 -0700557)
Colin Cross2fe66872015-03-30 17:20:39 -0700558
Jiyong Park83dc74b2020-01-14 18:38:44 +0900559func IsLibDepTag(depTag blueprint.DependencyTag) bool {
560 return depTag == libTag
561}
562
563func IsStaticLibDepTag(depTag blueprint.DependencyTag) bool {
564 return depTag == staticLibTag
565}
566
Colin Crossfc3674a2017-09-18 17:41:52 -0700567type sdkDep struct {
Colin Cross47ff2522017-10-02 14:22:08 -0700568 useModule, useFiles, useDefaultLibs, invalidVersion bool
569
Colin Cross6cef4812019-10-17 14:23:50 -0700570 // The modules that will be added to the bootclasspath when targeting 1.8 or lower
571 bootclasspath []string
Paul Duffine25c6442019-10-11 13:50:28 +0100572
573 // The default system modules to use. Will be an empty string if no system
574 // modules are to be used.
Colin Cross1369cdb2017-09-29 17:58:17 -0700575 systemModules string
576
Colin Cross6cef4812019-10-17 14:23:50 -0700577 // The modules that will be added ot the classpath when targeting 1.9 or higher
578 java9Classpath []string
579
Colin Crossa97c5d32018-03-28 14:58:31 -0700580 frameworkResModule string
581
Colin Cross86a60ae2018-05-29 14:44:55 -0700582 jars android.Paths
Colin Cross3047fa22019-04-18 10:56:44 -0700583 aidl android.OptionalPath
Paul Duffin250e6192019-06-07 10:44:37 +0100584
585 noStandardLibs, noFrameworksLibs bool
586}
587
588func (s sdkDep) hasStandardLibs() bool {
589 return !s.noStandardLibs
590}
591
592func (s sdkDep) hasFrameworkLibs() bool {
593 return !s.noStandardLibs && !s.noFrameworksLibs
Colin Cross1369cdb2017-09-29 17:58:17 -0700594}
595
Colin Crossa4f08812018-10-02 22:03:40 -0700596type jniLib struct {
Jaewoong Jung37ca4a12020-03-26 14:01:48 -0700597 name string
598 path android.Path
599 target android.Target
600 coverageFile android.OptionalPath
Colin Crossa4f08812018-10-02 22:03:40 -0700601}
602
Colin Cross0ea8ba82019-06-06 14:33:29 -0700603func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800604 return j.properties.Instrument && ctx.Config().IsEnvTrue("EMMA_INSTRUMENT")
605}
606
Colin Cross0ea8ba82019-06-06 14:33:29 -0700607func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800608 return j.shouldInstrument(ctx) &&
609 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
610 ctx.Config().UnbundledBuild())
611}
612
Jiyong Park6a927c42020-01-21 02:03:43 +0900613func (j *Module) sdkVersion() sdkSpec {
614 return sdkSpecFrom(String(j.deviceProperties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -0700615}
616
Paul Duffine25c6442019-10-11 13:50:28 +0100617func (j *Module) systemModules() string {
618 return proptools.String(j.deviceProperties.System_modules)
619}
620
Jiyong Park6a927c42020-01-21 02:03:43 +0900621func (j *Module) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -0700622 if j.deviceProperties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900623 return sdkSpecFrom(*j.deviceProperties.Min_sdk_version)
Colin Cross83bb3162018-06-25 15:48:06 -0700624 }
625 return j.sdkVersion()
626}
627
Jiyong Park6a927c42020-01-21 02:03:43 +0900628func (j *Module) targetSdkVersion() sdkSpec {
Dan Willemsen419290a2018-10-31 15:28:47 -0700629 if j.deviceProperties.Target_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900630 return sdkSpecFrom(*j.deviceProperties.Target_sdk_version)
Dan Willemsen419290a2018-10-31 15:28:47 -0700631 }
632 return j.sdkVersion()
633}
634
Artur Satayev388d39b2020-04-27 18:53:18 +0100635func (j *Module) MinSdkVersion() string {
636 return j.minSdkVersion().version.String()
637}
638
Jiyong Parkb02bb402019-12-03 00:43:57 +0900639func (j *Module) AvailableFor(what string) bool {
640 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
641 // Exception: for hostdex: true libraries, the platform variant is created
642 // even if it's not marked as available to platform. In that case, the platform
643 // variant is used only for the hostdex and not installed to the device.
644 return true
645 }
646 return j.ApexModuleBase.AvailableFor(what)
647}
648
Colin Crossbe1da472017-07-07 15:59:46 -0700649func (j *Module) deps(ctx android.BottomUpMutatorContext) {
Colin Cross1369cdb2017-09-29 17:58:17 -0700650 if ctx.Device() {
Paul Duffin250e6192019-06-07 10:44:37 +0100651 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross6d8d8c62019-10-28 15:10:03 -0700652 if sdkDep.useDefaultLibs {
653 ctx.AddVariationDependencies(nil, bootClasspathTag, config.DefaultBootclasspathLibraries...)
654 ctx.AddVariationDependencies(nil, systemModulesTag, config.DefaultSystemModules)
655 if sdkDep.hasFrameworkLibs() {
656 ctx.AddVariationDependencies(nil, libTag, config.DefaultLibraries...)
Colin Crossbe1da472017-07-07 15:59:46 -0700657 }
Colin Cross6d8d8c62019-10-28 15:10:03 -0700658 } else if sdkDep.useModule {
Colin Cross6cef4812019-10-17 14:23:50 -0700659 ctx.AddVariationDependencies(nil, bootClasspathTag, sdkDep.bootclasspath...)
Colin Cross6cef4812019-10-17 14:23:50 -0700660 ctx.AddVariationDependencies(nil, java9LibTag, sdkDep.java9Classpath...)
Colin Cross6d8d8c62019-10-28 15:10:03 -0700661 if j.deviceProperties.EffectiveOptimizeEnabled() && sdkDep.hasStandardLibs() {
662 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultBootclasspathLibraries...)
663 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultLibraries...)
664 }
Colin Cross2fe66872015-03-30 17:20:39 -0700665 }
Colin Crossdb224752020-05-14 18:05:32 -0700666 if sdkDep.systemModules != "" {
667 ctx.AddVariationDependencies(nil, systemModulesTag, sdkDep.systemModules)
668 }
Colin Cross6d8d8c62019-10-28 15:10:03 -0700669
Nan Zhangb2b33de2018-02-23 11:18:47 -0800670 if ctx.ModuleName() == "android_stubs_current" ||
671 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -0700672 ctx.ModuleName() == "android_test_stubs_current" {
Colin Cross42d48b72018-08-29 14:10:52 -0700673 ctx.AddVariationDependencies(nil, frameworkApkTag, "framework-res")
Nan Zhangb2b33de2018-02-23 11:18:47 -0800674 }
Colin Cross2fe66872015-03-30 17:20:39 -0700675 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700676
Inseob Kimac1e9862019-12-09 18:15:47 +0900677 syspropPublicStubs := syspropPublicStubs(ctx.Config())
678
679 // rewriteSyspropLibs validates if a java module can link against platform's sysprop_library,
680 // and redirects dependency to public stub depending on the link type.
681 rewriteSyspropLibs := func(libs []string, prop string) []string {
682 // make a copy
683 ret := android.CopyOf(libs)
684
685 for idx, lib := range libs {
686 stub, ok := syspropPublicStubs[lib]
687
688 if !ok {
689 continue
690 }
691
692 linkType, _ := j.getLinkType(ctx.ModuleName())
Inseob Kimc5239512020-01-14 15:36:21 +0900693 // only platform modules can use internal props
694 if linkType != javaPlatform {
Inseob Kimac1e9862019-12-09 18:15:47 +0900695 ret[idx] = stub
Inseob Kimac1e9862019-12-09 18:15:47 +0900696 }
697 }
698
699 return ret
700 }
701
702 ctx.AddVariationDependencies(nil, libTag, rewriteSyspropLibs(j.properties.Libs, "libs")...)
703 ctx.AddVariationDependencies(nil, staticLibTag, rewriteSyspropLibs(j.properties.Static_libs, "static_libs")...)
Colin Crossa4f08812018-10-02 22:03:40 -0700704
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700705 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000706 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800707
Colin Crossfe17f6f2019-03-28 19:30:56 -0700708 android.ProtoDeps(ctx, &j.protoProperties)
Colin Cross6af17aa2017-09-20 12:59:05 -0700709 if j.hasSrcExt(".proto") {
710 protoDeps(ctx, &j.protoProperties)
711 }
Colin Cross93e85952017-08-15 13:34:18 -0700712
713 if j.hasSrcExt(".kt") {
714 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
715 // Kotlin files
Colin Cross0b03d972019-05-13 11:06:25 -0700716 ctx.AddVariationDependencies(nil, kotlinStdlibTag,
717 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8")
Colin Cross7788c122019-01-23 16:14:02 -0800718 if len(j.properties.Plugins) > 0 {
Colin Crossafbb1732019-01-17 15:42:52 -0800719 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
720 }
Colin Cross93e85952017-08-15 13:34:18 -0700721 }
Colin Cross3144dfc2018-01-03 15:06:47 -0800722
Ulya Trafimovich38dfa0f2020-01-07 16:37:02 +0000723 // Framework libraries need special handling in static coverage builds: they should not have
724 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
725 // the same jacoco classes coming from different bootclasspath jars.
726 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
727 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
728 j.properties.Instrument = true
729 }
730 } else if j.shouldInstrumentStatic(ctx) {
Colin Cross42d48b72018-08-29 14:10:52 -0700731 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
Colin Cross3144dfc2018-01-03 15:06:47 -0800732 }
Colin Cross6af17aa2017-09-20 12:59:05 -0700733}
734
735func hasSrcExt(srcs []string, ext string) bool {
736 for _, src := range srcs {
737 if filepath.Ext(src) == ext {
738 return true
739 }
740 }
741
742 return false
743}
744
745func (j *Module) hasSrcExt(ext string) bool {
746 return hasSrcExt(j.properties.Srcs, ext)
Colin Cross2fe66872015-03-30 17:20:39 -0700747}
748
Colin Cross46c9b8b2017-06-22 16:51:17 -0700749func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Colin Cross3047fa22019-04-18 10:56:44 -0700750 aidlIncludeDirs android.Paths) (string, android.Paths) {
Colin Crossc0b06f12015-04-08 13:03:43 -0700751
Colin Crossebe1a512017-11-14 13:12:14 -0800752 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
753 aidlIncludes = append(aidlIncludes,
754 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
755 aidlIncludes = append(aidlIncludes,
756 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
Colin Crossc0b06f12015-04-08 13:03:43 -0700757
Colin Cross3047fa22019-04-18 10:56:44 -0700758 var flags []string
759 var deps android.Paths
Steven Moreland667f6882018-07-26 12:55:08 -0700760
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700761 if aidlPreprocess.Valid() {
762 flags = append(flags, "-p"+aidlPreprocess.String())
Colin Cross3047fa22019-04-18 10:56:44 -0700763 deps = append(deps, aidlPreprocess.Path())
764 } else if len(aidlIncludeDirs) > 0 {
Colin Cross635c3b02016-05-18 15:37:25 -0700765 flags = append(flags, android.JoinWithPrefix(aidlIncludeDirs.Strings(), "-I"))
Colin Crossc0b06f12015-04-08 13:03:43 -0700766 }
767
Colin Cross3047fa22019-04-18 10:56:44 -0700768 if len(j.exportAidlIncludeDirs) > 0 {
769 flags = append(flags, android.JoinWithPrefix(j.exportAidlIncludeDirs.Strings(), "-I"))
770 }
771
772 if len(aidlIncludes) > 0 {
773 flags = append(flags, android.JoinWithPrefix(aidlIncludes.Strings(), "-I"))
774 }
775
Colin Cross635c3b02016-05-18 15:37:25 -0700776 flags = append(flags, "-I"+android.PathForModuleSrc(ctx).String())
Colin Cross32f38982018-02-22 11:47:25 -0800777 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Colin Crossd48633a2017-07-13 14:41:17 -0700778 flags = append(flags, "-I"+src.String())
779 }
Colin Crossc0b06f12015-04-08 13:03:43 -0700780
Martijn Coeneneab15642018-03-09 09:29:59 +0100781 if Bool(j.deviceProperties.Aidl.Generate_traces) {
782 flags = append(flags, "-t")
783 }
784
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100785 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
786 flags = append(flags, "--transaction_names")
787 }
788
Colin Cross3047fa22019-04-18 10:56:44 -0700789 return strings.Join(flags, " "), deps
Colin Crossc0b06f12015-04-08 13:03:43 -0700790}
791
Colin Cross32f676a2017-09-06 13:41:06 -0700792type deps struct {
Nan Zhang581fd212018-01-10 16:06:12 -0800793 classpath classpath
Colin Cross6cef4812019-10-17 14:23:50 -0700794 java9Classpath classpath
Nan Zhang581fd212018-01-10 16:06:12 -0800795 bootClasspath classpath
Colin Cross6a77c982018-06-19 22:43:34 -0700796 processorPath classpath
Colin Crossbe9cdb82019-01-21 21:37:16 -0800797 processorClasses []string
Colin Cross6ade34f2017-09-15 13:00:47 -0700798 staticJars android.Paths
Nan Zhanged19fc32017-10-19 13:06:22 -0700799 staticHeaderJars android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700800 staticResourceJars android.Paths
Colin Cross6ade34f2017-09-15 13:00:47 -0700801 aidlIncludeDirs android.Paths
Nan Zhangb2b33de2018-02-23 11:18:47 -0800802 srcs android.Paths
Colin Cross59149b62017-10-16 18:07:29 -0700803 srcJars android.Paths
Colin Crossb77043e2019-07-16 13:57:13 -0700804 systemModules *systemModules
Colin Cross6ade34f2017-09-15 13:00:47 -0700805 aidlPreprocess android.OptionalPath
Colin Cross93e85952017-08-15 13:34:18 -0700806 kotlinStdlib android.Paths
Colin Crossafbb1732019-01-17 15:42:52 -0800807 kotlinAnnotations android.Paths
Colin Crossbe9cdb82019-01-21 21:37:16 -0800808
809 disableTurbine bool
Colin Cross32f676a2017-09-06 13:41:06 -0700810}
Colin Cross2fe66872015-03-30 17:20:39 -0700811
Colin Cross54250902017-12-05 09:28:08 -0800812func checkProducesJars(ctx android.ModuleContext, dep android.SourceFileProducer) {
813 for _, f := range dep.Srcs() {
814 if f.Ext() != ".jar" {
815 ctx.ModuleErrorf("genrule %q must generate files ending with .jar to be used as a libs or static_libs dependency",
816 ctx.OtherModuleName(dep.(blueprint.Module)))
817 }
818 }
819}
820
Jiyong Park2d492942018-03-05 17:44:10 +0900821type linkType int
822
823const (
Jiyong Park50146e92020-01-30 18:00:15 +0900824 // TODO(jiyong) rename these for better readability. Make the allowed
825 // and disallowed link types explicit
Jiyong Park2d492942018-03-05 17:44:10 +0900826 javaCore linkType = iota
827 javaSdk
828 javaSystem
Jiyong Park50146e92020-01-30 18:00:15 +0900829 javaModule
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900830 javaSystemServer
Jiyong Park2d492942018-03-05 17:44:10 +0900831 javaPlatform
832)
833
Jeongik Cha75b83b02019-11-01 15:28:00 +0900834type linkTypeContext interface {
835 android.Module
836 getLinkType(name string) (ret linkType, stubs bool)
837}
838
839func (m *Module) getLinkType(name string) (ret linkType, stubs bool) {
Colin Cross83bb3162018-06-25 15:48:06 -0700840 ver := m.sdkVersion()
Colin Crossf19b9bb2018-03-26 14:42:44 -0700841 switch {
Jiyong Park46f78fb2018-10-20 16:33:17 +0900842 case name == "core.current.stubs" || name == "core.platform.api.stubs" ||
843 name == "stub-annotations" || name == "private-stub-annotations-jar" ||
Pete Gillincbff3262019-05-08 15:10:06 +0100844 name == "core-lambda-stubs" || name == "core-generated-annotation-stubs":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900845 return javaCore, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900846 case ver.kind == sdkCore:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900847 return javaCore, false
848 case name == "android_system_stubs_current":
849 return javaSystem, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900850 case ver.kind == sdkSystem:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900851 return javaSystem, false
852 case name == "android_test_stubs_current":
853 return javaSystem, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900854 case ver.kind == sdkTest:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900855 return javaPlatform, false
856 case name == "android_stubs_current":
857 return javaSdk, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900858 case ver.kind == sdkPublic:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900859 return javaSdk, false
Jiyong Park50146e92020-01-30 18:00:15 +0900860 case name == "android_module_lib_stubs_current":
861 return javaModule, true
862 case ver.kind == sdkModule:
863 return javaModule, false
Anton Hanssonbbd78552020-03-19 15:23:38 +0000864 case name == "android_system_server_stubs_current":
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900865 return javaSystemServer, true
866 case ver.kind == sdkSystemServer:
867 return javaSystemServer, false
Jiyong Park6a927c42020-01-21 02:03:43 +0900868 case ver.kind == sdkPrivate || ver.kind == sdkNone || ver.kind == sdkCorePlatform:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900869 return javaPlatform, false
Jiyong Park6a927c42020-01-21 02:03:43 +0900870 case !ver.valid():
871 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.raw))
Colin Crossf19b9bb2018-03-26 14:42:44 -0700872 default:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900873 return javaSdk, false
Jiyong Park2d492942018-03-05 17:44:10 +0900874 }
875}
876
Jeongik Cha75b83b02019-11-01 15:28:00 +0900877func checkLinkType(ctx android.ModuleContext, from *Module, to linkTypeContext, tag dependencyTag) {
Colin Crossf19b9bb2018-03-26 14:42:44 -0700878 if ctx.Host() {
879 return
880 }
881
Jeongik Cha75b83b02019-11-01 15:28:00 +0900882 myLinkType, stubs := from.getLinkType(ctx.ModuleName())
Jiyong Park46f78fb2018-10-20 16:33:17 +0900883 if stubs {
884 return
885 }
Jeongik Cha75b83b02019-11-01 15:28:00 +0900886 otherLinkType, _ := to.getLinkType(ctx.OtherModuleName(to))
Jiyong Park2d492942018-03-05 17:44:10 +0900887 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."
888
889 switch myLinkType {
890 case javaCore:
891 if otherLinkType != javaCore {
892 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 +0900893 ctx.OtherModuleName(to))
894 }
Jiyong Park2d492942018-03-05 17:44:10 +0900895 break
896 case javaSdk:
897 if otherLinkType != javaCore && otherLinkType != javaSdk {
898 ctx.ModuleErrorf("compiles against Android API, but dependency %q is compiling against non-public Android API."+commonMessage,
899 ctx.OtherModuleName(to))
900 }
901 break
902 case javaSystem:
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900903 if otherLinkType == javaPlatform || otherLinkType == javaModule || otherLinkType == javaSystemServer {
Jiyong Park2d492942018-03-05 17:44:10 +0900904 ctx.ModuleErrorf("compiles against system API, but dependency %q is compiling against private API."+commonMessage,
905 ctx.OtherModuleName(to))
906 }
907 break
Jiyong Park50146e92020-01-30 18:00:15 +0900908 case javaModule:
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900909 if otherLinkType == javaPlatform || otherLinkType == javaSystemServer {
Jiyong Park50146e92020-01-30 18:00:15 +0900910 ctx.ModuleErrorf("compiles against module API, but dependency %q is compiling against private API."+commonMessage,
911 ctx.OtherModuleName(to))
912 }
913 break
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900914 case javaSystemServer:
915 if otherLinkType == javaPlatform {
916 ctx.ModuleErrorf("compiles against system server API, but dependency %q is compiling against private API."+commonMessage,
917 ctx.OtherModuleName(to))
918 }
919 break
Jiyong Park2d492942018-03-05 17:44:10 +0900920 case javaPlatform:
921 // no restriction on link-type
922 break
Jiyong Park750e5572018-01-31 00:20:13 +0900923 }
924}
925
Colin Cross32f676a2017-09-06 13:41:06 -0700926func (j *Module) collectDeps(ctx android.ModuleContext) deps {
927 var deps deps
Colin Crossfc3674a2017-09-18 17:41:52 -0700928
Colin Cross300f0382018-03-06 13:11:51 -0800929 if ctx.Device() {
Colin Cross83bb3162018-06-25 15:48:06 -0700930 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross300f0382018-03-06 13:11:51 -0800931 if sdkDep.invalidVersion {
Colin Cross6cef4812019-10-17 14:23:50 -0700932 ctx.AddMissingDependencies(sdkDep.bootclasspath)
933 ctx.AddMissingDependencies(sdkDep.java9Classpath)
Colin Cross300f0382018-03-06 13:11:51 -0800934 } else if sdkDep.useFiles {
935 // sdkDep.jar is actually equivalent to turbine header.jar.
Colin Cross86a60ae2018-05-29 14:44:55 -0700936 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross3047fa22019-04-18 10:56:44 -0700937 deps.aidlPreprocess = sdkDep.aidl
938 } else {
939 deps.aidlPreprocess = sdkDep.aidl
Colin Cross300f0382018-03-06 13:11:51 -0800940 }
Colin Crossfc3674a2017-09-18 17:41:52 -0700941 }
942
Paul Duffin64e61992020-05-15 10:20:31 +0100943 // If this is a component library (stubs, etc.) for a java_sdk_library then
944 // add the name of that java_sdk_library to the exported sdk libs to make sure
945 // that, if necessary, a <uses-library> element for that java_sdk_library is
946 // added to the Android manifest.
947 j.exportedSdkLibs = append(j.exportedSdkLibs, j.OptionalImplicitSdkLibrary()...)
948
Colin Crossd11fcda2017-10-23 17:59:01 -0700949 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross2fe66872015-03-30 17:20:39 -0700950 otherName := ctx.OtherModuleName(module)
Colin Crossec7a0422017-07-07 14:47:12 -0700951 tag := ctx.OtherModuleDependencyTag(module)
952
Colin Crossa4f08812018-10-02 22:03:40 -0700953 if _, ok := tag.(*jniDependencyTag); ok {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700954 // Handled by AndroidApp.collectAppDeps
955 return
956 }
957 if tag == certificateTag {
958 // Handled by AndroidApp.collectAppDeps
Colin Crossa4f08812018-10-02 22:03:40 -0700959 return
960 }
Artur Satayeve5ac15a2020-04-08 19:09:30 +0100961
Colin Cross54250902017-12-05 09:28:08 -0800962 switch dep := module.(type) {
Colin Cross897d2ed2019-02-11 14:03:51 -0800963 case SdkLibraryDependency:
964 switch tag {
965 case libTag:
966 deps.classpath = append(deps.classpath, dep.SdkHeaderJars(ctx, j.sdkVersion())...)
967 // names of sdk libs that are directly depended are exported
Paul Duffin64e61992020-05-15 10:20:31 +0100968 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.OptionalImplicitSdkLibrary()...)
Colin Cross79c7c262019-04-17 11:11:46 -0700969 case staticLibTag:
Colin Cross897d2ed2019-02-11 14:03:51 -0800970 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
971 }
Colin Cross54250902017-12-05 09:28:08 -0800972 case Dependency:
973 switch tag {
974 case bootClasspathTag:
975 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars()...)
Colin Cross4b964c02018-10-15 16:18:06 -0700976 case libTag, instrumentationForTag:
Colin Cross54250902017-12-05 09:28:08 -0800977 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900978 // sdk lib names from dependencies are re-exported
979 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700980 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000981 pluginJars, pluginClasses := dep.ExportedPlugins()
982 addPlugins(&deps, pluginJars, pluginClasses...)
Colin Cross6cef4812019-10-17 14:23:50 -0700983 case java9LibTag:
984 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars()...)
Colin Cross54250902017-12-05 09:28:08 -0800985 case staticLibTag:
986 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
987 deps.staticJars = append(deps.staticJars, dep.ImplementationJars()...)
988 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars()...)
Colin Cross331a1212018-08-15 20:40:52 -0700989 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900990 // sdk lib names from dependencies are re-exported
991 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700992 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000993 pluginJars, pluginClasses := dep.ExportedPlugins()
994 addPlugins(&deps, pluginJars, pluginClasses...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800995 case pluginTag:
996 if plugin, ok := dep.(*Plugin); ok {
Colin Crossbe9cdb82019-01-21 21:37:16 -0800997 if plugin.pluginProperties.Processor_class != nil {
Artur Satayev9cf46692019-11-26 18:08:34 +0000998 addPlugins(&deps, plugin.ImplementationAndResourcesJars(), *plugin.pluginProperties.Processor_class)
999 } else {
1000 addPlugins(&deps, plugin.ImplementationAndResourcesJars())
Colin Crossbe9cdb82019-01-21 21:37:16 -08001001 }
1002 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
1003 } else {
1004 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
1005 }
Artur Satayev9cf46692019-11-26 18:08:34 +00001006 case exportedPluginTag:
1007 if plugin, ok := dep.(*Plugin); ok {
1008 if plugin.pluginProperties.Generates_api != nil && *plugin.pluginProperties.Generates_api {
1009 ctx.PropertyErrorf("exported_plugins", "Cannot export plugins with generates_api = true, found %v", otherName)
1010 }
1011 j.exportedPluginJars = append(j.exportedPluginJars, plugin.ImplementationAndResourcesJars()...)
1012 if plugin.pluginProperties.Processor_class != nil {
1013 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
1014 }
1015 } else {
1016 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
1017 }
Nan Zhangb2b33de2018-02-23 11:18:47 -08001018 case frameworkApkTag:
1019 if ctx.ModuleName() == "android_stubs_current" ||
1020 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -07001021 ctx.ModuleName() == "android_test_stubs_current" {
Nan Zhangb2b33de2018-02-23 11:18:47 -08001022 // framework stubs.jar need to depend on framework-res.apk, in order to pull the
1023 // resource files out of there for aapt.
1024 //
1025 // Normally the package rule runs aapt, which includes the resource,
1026 // but we're not running that in our package rule so just copy in the
1027 // resource files here.
Colin Cross331a1212018-08-15 20:40:52 -07001028 deps.staticResourceJars = append(deps.staticResourceJars, dep.(*AndroidApp).exportPackage)
Nan Zhangb2b33de2018-02-23 11:18:47 -08001029 }
Colin Cross54250902017-12-05 09:28:08 -08001030 case kotlinStdlibTag:
Colin Cross0b03d972019-05-13 11:06:25 -07001031 deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars()...)
Colin Crossafbb1732019-01-17 15:42:52 -08001032 case kotlinAnnotationsTag:
1033 deps.kotlinAnnotations = dep.HeaderJars()
Colin Cross54250902017-12-05 09:28:08 -08001034 }
1035
Colin Cross54250902017-12-05 09:28:08 -08001036 case android.SourceFileProducer:
1037 switch tag {
1038 case libTag:
1039 checkProducesJars(ctx, dep)
1040 deps.classpath = append(deps.classpath, dep.Srcs()...)
1041 case staticLibTag:
1042 checkProducesJars(ctx, dep)
1043 deps.classpath = append(deps.classpath, dep.Srcs()...)
1044 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
1045 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Cross54250902017-12-05 09:28:08 -08001046 }
1047 default:
Colin Crossec7a0422017-07-07 14:47:12 -07001048 switch tag {
Paul Duffin68289b02019-09-20 13:50:52 +01001049 case bootClasspathTag:
1050 // If a system modules dependency has been added to the bootclasspath
1051 // then add its libs to the bootclasspath.
Paul Duffin83a2d962019-11-19 19:44:10 +00001052 sm := module.(SystemModulesProvider)
1053 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars()...)
Paul Duffin68289b02019-09-20 13:50:52 +01001054
Colin Cross1369cdb2017-09-29 17:58:17 -07001055 case systemModulesTag:
1056 if deps.systemModules != nil {
1057 panic("Found two system module dependencies")
1058 }
Paul Duffin83a2d962019-11-19 19:44:10 +00001059 sm := module.(SystemModulesProvider)
1060 outputDir, outputDeps := sm.OutputDirAndDeps()
1061 deps.systemModules = &systemModules{outputDir, outputDeps}
Colin Cross2fe66872015-03-30 17:20:39 -07001062 }
Colin Crossec7a0422017-07-07 14:47:12 -07001063 }
Colin Cross2fe66872015-03-30 17:20:39 -07001064 })
1065
Jiyong Park1be96912018-05-28 18:02:19 +09001066 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
1067
Colin Cross32f676a2017-09-06 13:41:06 -07001068 return deps
Colin Cross2fe66872015-03-30 17:20:39 -07001069}
1070
Artur Satayev9cf46692019-11-26 18:08:34 +00001071func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
1072 deps.processorPath = append(deps.processorPath, pluginJars...)
1073 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
1074}
1075
Colin Cross1e743852019-10-28 11:37:20 -07001076func getJavaVersion(ctx android.ModuleContext, javaVersion string, sdkContext sdkContext) javaVersion {
Nan Zhang357466b2018-04-17 17:38:36 -07001077 if javaVersion != "" {
Colin Cross1e743852019-10-28 11:37:20 -07001078 return normalizeJavaVersion(ctx, javaVersion)
Colin Crossdb224752020-05-14 18:05:32 -07001079 } else if ctx.Device() {
1080 return sdkContext.sdkVersion().defaultJavaLanguageVersion(ctx)
Nan Zhang357466b2018-04-17 17:38:36 -07001081 } else {
Colin Cross1e743852019-10-28 11:37:20 -07001082 return JAVA_VERSION_9
Nan Zhang357466b2018-04-17 17:38:36 -07001083 }
Nan Zhang357466b2018-04-17 17:38:36 -07001084}
1085
Colin Cross1e743852019-10-28 11:37:20 -07001086type javaVersion int
1087
1088const (
1089 JAVA_VERSION_UNSUPPORTED = 0
1090 JAVA_VERSION_6 = 6
1091 JAVA_VERSION_7 = 7
1092 JAVA_VERSION_8 = 8
1093 JAVA_VERSION_9 = 9
1094)
1095
1096func (v javaVersion) String() string {
1097 switch v {
1098 case JAVA_VERSION_6:
1099 return "1.6"
1100 case JAVA_VERSION_7:
1101 return "1.7"
1102 case JAVA_VERSION_8:
1103 return "1.8"
1104 case JAVA_VERSION_9:
1105 return "1.9"
1106 default:
1107 return "unsupported"
1108 }
1109}
1110
1111// Returns true if javac targeting this version uses system modules instead of a bootclasspath.
1112func (v javaVersion) usesJavaModules() bool {
1113 return v >= 9
1114}
1115
1116func normalizeJavaVersion(ctx android.BaseModuleContext, javaVersion string) javaVersion {
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001117 switch javaVersion {
1118 case "1.6", "6":
Colin Cross1e743852019-10-28 11:37:20 -07001119 return JAVA_VERSION_6
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001120 case "1.7", "7":
Colin Cross1e743852019-10-28 11:37:20 -07001121 return JAVA_VERSION_7
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001122 case "1.8", "8":
Colin Cross1e743852019-10-28 11:37:20 -07001123 return JAVA_VERSION_8
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001124 case "1.9", "9":
Colin Cross1e743852019-10-28 11:37:20 -07001125 return JAVA_VERSION_9
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001126 case "10", "11":
1127 ctx.PropertyErrorf("java_version", "Java language levels above 9 are not supported")
Colin Cross1e743852019-10-28 11:37:20 -07001128 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001129 default:
1130 ctx.PropertyErrorf("java_version", "Unrecognized Java language level")
Colin Cross1e743852019-10-28 11:37:20 -07001131 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001132 }
1133}
1134
Nan Zhanged19fc32017-10-19 13:06:22 -07001135func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
Colin Crossc0b06f12015-04-08 13:03:43 -07001136
Colin Crossf03c82b2015-04-13 13:53:40 -07001137 var flags javaBuilderFlags
1138
Tobias Thierer06dd04f2018-09-11 16:21:05 +01001139 // javaVersion flag.
1140 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), sdkContext(j))
1141
Nan Zhanged19fc32017-10-19 13:06:22 -07001142 // javac flags.
Colin Crossf03c82b2015-04-13 13:53:40 -07001143 javacFlags := j.properties.Javacflags
Colin Cross1e743852019-10-28 11:37:20 -07001144 if flags.javaVersion.usesJavaModules() {
Colin Cross1369cdb2017-09-29 17:58:17 -07001145 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Nan Zhanged19fc32017-10-19 13:06:22 -07001146 }
Colin Cross6510f912017-11-29 00:27:14 -08001147 if ctx.Config().MinimizeJavaDebugInfo() {
Colin Cross126a25c2017-10-31 13:55:34 -07001148 // Override the -g flag passed globally to remove local variable debug info to reduce
1149 // disk and memory usage.
1150 javacFlags = append(javacFlags, "-g:source,lines")
1151 }
Colin Crossc228a702019-11-06 16:18:05 -08001152 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
Colin Cross64162712017-08-08 13:17:59 -07001153
Colin Cross66548102018-06-19 22:47:35 -07001154 if ctx.Config().RunErrorProne() {
1155 if config.ErrorProneClasspath == nil {
1156 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1157 }
1158
1159 errorProneFlags := []string{
1160 "-Xplugin:ErrorProne",
1161 "${config.ErrorProneChecks}",
1162 }
1163 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1164
1165 flags.errorProneExtraJavacFlags = "${config.ErrorProneFlags} " +
1166 "'" + strings.Join(errorProneFlags, " ") + "'"
1167 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
Andreas Gampef3e5b552018-01-22 21:27:21 -08001168 }
1169
Nan Zhanged19fc32017-10-19 13:06:22 -07001170 // classpath
Nan Zhang581fd212018-01-10 16:06:12 -08001171 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1172 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross6cef4812019-10-17 14:23:50 -07001173 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
Colin Cross6a77c982018-06-19 22:43:34 -07001174 flags.processorPath = append(flags.processorPath, deps.processorPath...)
Colin Cross7fdd2b72018-01-02 18:14:25 -08001175
Colin Crossd99540b2020-04-22 11:44:34 -07001176 flags.processors = append(flags.processors, deps.processorClasses...)
1177 flags.processors = android.FirstUniqueStrings(flags.processors)
Colin Crossbe9cdb82019-01-21 21:37:16 -08001178
Colin Cross1e743852019-10-28 11:37:20 -07001179 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
1180 decodeSdkDep(ctx, sdkContext(j)).hasStandardLibs() {
Colin Cross7fdd2b72018-01-02 18:14:25 -08001181 // Give host-side tools a version of OpenJDK's standard libraries
1182 // close to what they're targeting. As of Dec 2017, AOSP is only
1183 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1184 //
1185 // When building with OpenJDK 8, the following should have no
1186 // effect since those jars would be available by default.
1187 //
1188 // When building with OpenJDK 9 but targeting a version < 1.8,
1189 // putting them on the bootclasspath means that:
1190 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1191 // b) references to existing APIs are not reinterpreted in an
1192 // OpenJDK 9-specific way, eg. calls to subclasses of
1193 // java.nio.Buffer as in http://b/70862583
1194 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1195 flags.bootClasspath = append(flags.bootClasspath,
1196 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1197 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
Nan Zhang5f8cb422018-02-06 10:34:32 -08001198 if Bool(j.properties.Use_tools_jar) {
1199 flags.bootClasspath = append(flags.bootClasspath,
1200 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1201 }
Colin Cross7fdd2b72018-01-02 18:14:25 -08001202 }
1203
Colin Cross1e743852019-10-28 11:37:20 -07001204 if j.properties.Patch_module != nil && flags.javaVersion.usesJavaModules() {
Jaewoong Jung38e4fb22018-12-12 09:01:34 -08001205 // Manually specify build directory in case it is not under the repo root.
1206 // (javac doesn't seem to expand into symbolc links when searching for patch-module targets, so
1207 // just adding a symlink under the root doesn't help.)
1208 patchPaths := ".:" + ctx.Config().BuildDir()
1209 classPath := flags.classpath.FormJavaClassPath("")
1210 if classPath != "" {
1211 patchPaths += ":" + classPath
1212 }
1213 javacFlags = append(javacFlags, "--patch-module="+String(j.properties.Patch_module)+"="+patchPaths)
Colin Cross81440082018-08-15 20:21:55 -07001214 }
1215
Nan Zhanged19fc32017-10-19 13:06:22 -07001216 // systemModules
Colin Crossb77043e2019-07-16 13:57:13 -07001217 flags.systemModules = deps.systemModules
Colin Cross1369cdb2017-09-29 17:58:17 -07001218
Nan Zhanged19fc32017-10-19 13:06:22 -07001219 // aidl flags.
Colin Cross3047fa22019-04-18 10:56:44 -07001220 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs)
Colin Cross2fe66872015-03-30 17:20:39 -07001221
Colin Cross81440082018-08-15 20:21:55 -07001222 if len(javacFlags) > 0 {
1223 // optimization.
1224 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1225 flags.javacFlags = "$javacFlags"
1226 }
1227
Nan Zhanged19fc32017-10-19 13:06:22 -07001228 return flags
1229}
Colin Crossc0b06f12015-04-08 13:03:43 -07001230
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001231func (j *Module) compile(ctx android.ModuleContext, aaptSrcJar android.Path) {
Colin Crossebe1a512017-11-14 13:12:14 -08001232 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
Nan Zhanged19fc32017-10-19 13:06:22 -07001233
1234 deps := j.collectDeps(ctx)
1235 flags := j.collectBuilderFlags(ctx, deps)
1236
Colin Cross1e743852019-10-28 11:37:20 -07001237 if flags.javaVersion.usesJavaModules() {
Nan Zhanged19fc32017-10-19 13:06:22 -07001238 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
1239 }
Colin Cross8a497952019-03-05 22:25:09 -08001240 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Colin Cross6af17aa2017-09-20 12:59:05 -07001241 if hasSrcExt(srcFiles.Strings(), ".proto") {
Colin Cross0f2ee152017-12-14 15:22:43 -08001242 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
Colin Cross6af17aa2017-09-20 12:59:05 -07001243 }
1244
Colin Crossaf050172017-11-15 23:01:59 -08001245 srcFiles = j.genSources(ctx, srcFiles, flags)
1246
1247 srcJars := srcFiles.FilterByExt(".srcjar")
Colin Cross59149b62017-10-16 18:07:29 -07001248 srcJars = append(srcJars, deps.srcJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001249 if aaptSrcJar != nil {
1250 srcJars = append(srcJars, aaptSrcJar)
1251 }
Colin Crossb7a63242015-04-16 14:09:14 -07001252
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001253 if j.properties.Jarjar_rules != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001254 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001255 }
1256
Colin Cross1ee23172017-10-18 14:44:18 -07001257 jarName := ctx.ModuleName() + ".jar"
1258
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001259 javaSrcFiles := srcFiles.FilterByExt(".java")
1260 var uniqueSrcFiles android.Paths
1261 set := make(map[string]bool)
1262 for _, v := range javaSrcFiles {
1263 if _, found := set[v.String()]; !found {
1264 set[v.String()] = true
1265 uniqueSrcFiles = append(uniqueSrcFiles, v)
1266 }
1267 }
1268
patricktu242faad2019-09-24 15:41:30 +08001269 // Collect .java files for AIDEGen
1270 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1271
Colin Cross55f63ea2018-08-27 12:37:09 -07001272 var kotlinJars android.Paths
1273
Colin Cross93e85952017-08-15 13:34:18 -07001274 if srcFiles.HasExt(".kt") {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001275 // user defined kotlin flags.
1276 kotlincFlags := j.properties.Kotlincflags
1277 CheckKotlincFlags(ctx, kotlincFlags)
1278
Colin Cross93e85952017-08-15 13:34:18 -07001279 // If there are kotlin files, compile them first but pass all the kotlin and java files
1280 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1281 // won't emit any classes for them.
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001282 kotlincFlags = append(kotlincFlags, "-no-stdlib")
Colin Cross93e85952017-08-15 13:34:18 -07001283 if ctx.Device() {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001284 kotlincFlags = append(kotlincFlags, "-no-jdk")
1285 }
1286 if len(kotlincFlags) > 0 {
1287 // optimization.
1288 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1289 flags.kotlincFlags += "$kotlincFlags"
Colin Cross93e85952017-08-15 13:34:18 -07001290 }
1291
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001292 var kotlinSrcFiles android.Paths
1293 kotlinSrcFiles = append(kotlinSrcFiles, uniqueSrcFiles...)
1294 kotlinSrcFiles = append(kotlinSrcFiles, srcFiles.FilterByExt(".kt")...)
1295
patricktu242faad2019-09-24 15:41:30 +08001296 // Collect .kt files for AIDEGen
1297 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, srcFiles.FilterByExt(".kt").Strings()...)
1298
Colin Crossafbb1732019-01-17 15:42:52 -08001299 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1300 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1301
1302 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1303 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1304
1305 if len(flags.processorPath) > 0 {
1306 // Use kapt for annotation processing
1307 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1308 kotlinKapt(ctx, kaptSrcJar, kotlinSrcFiles, srcJars, flags)
1309 srcJars = append(srcJars, kaptSrcJar)
1310 // Disable annotation processing in javac, it's already been handled by kapt
1311 flags.processorPath = nil
Colin Crossd99540b2020-04-22 11:44:34 -07001312 flags.processors = nil
Colin Crossafbb1732019-01-17 15:42:52 -08001313 }
Colin Cross93e85952017-08-15 13:34:18 -07001314
Colin Cross1ee23172017-10-18 14:44:18 -07001315 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross21fc9bb2019-01-18 15:05:09 -08001316 kotlinCompile(ctx, kotlinJar, kotlinSrcFiles, srcJars, flags)
Colin Cross93e85952017-08-15 13:34:18 -07001317 if ctx.Failed() {
1318 return
1319 }
1320
1321 // Make javac rule depend on the kotlinc rule
1322 flags.classpath = append(flags.classpath, kotlinJar)
Przemyslaw Szczepaniak66c0c402018-03-08 13:21:55 +00001323
Colin Cross93e85952017-08-15 13:34:18 -07001324 // Jar kotlin classes into the final jar after javac
Colin Cross55f63ea2018-08-27 12:37:09 -07001325 kotlinJars = append(kotlinJars, kotlinJar)
Colin Cross9b38aef2018-08-27 15:42:25 -07001326 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
Colin Cross93e85952017-08-15 13:34:18 -07001327 }
1328
Colin Cross55f63ea2018-08-27 12:37:09 -07001329 jars := append(android.Paths(nil), kotlinJars...)
1330
Colin Cross5ab4e6d2017-11-22 16:20:45 -08001331 // Store the list of .java files that was passed to javac
1332 j.compiledJavaSrcs = uniqueSrcFiles
1333 j.compiledSrcJars = srcJars
1334
Nan Zhang61eaedb2017-11-02 13:28:15 -07001335 enable_sharding := false
Colin Crossf5a66282020-02-21 08:16:41 -08001336 var headerJarFileWithoutJarjar android.Path
Colin Crossbe9cdb82019-01-21 21:37:16 -08001337 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !deps.disableTurbine {
Nan Zhang61eaedb2017-11-02 13:28:15 -07001338 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1339 enable_sharding = true
Ashley Rosee36efcf2019-01-16 17:34:08 -05001340 // Formerly, there was a check here that prevented annotation processors
1341 // from being used when sharding was enabled, as some annotation processors
1342 // do not function correctly in sharded environments. It was removed to
1343 // allow for the use of annotation processors that do function correctly
1344 // with sharding enabled. See: b/77284273.
Nan Zhang61eaedb2017-11-02 13:28:15 -07001345 }
Colin Crossf5a66282020-02-21 08:16:41 -08001346 headerJarFileWithoutJarjar, j.headerJarFile =
1347 j.compileJavaHeader(ctx, uniqueSrcFiles, srcJars, deps, flags, jarName, kotlinJars)
Colin Crossf19b9bb2018-03-26 14:42:44 -07001348 if ctx.Failed() {
1349 return
Nan Zhanged19fc32017-10-19 13:06:22 -07001350 }
1351 }
Colin Cross8eadbf02017-10-24 17:46:00 -07001352 if len(uniqueSrcFiles) > 0 || len(srcJars) > 0 {
Colin Crossd6891432017-09-27 17:39:56 -07001353 var extraJarDeps android.Paths
Colin Cross66548102018-06-19 22:47:35 -07001354 if ctx.Config().RunErrorProne() {
Colin Crossc6bbef32017-08-14 14:16:06 -07001355 // If error-prone is enabled, add an additional rule to compile the java files into
1356 // a separate set of classes (so that they don't overwrite the normal ones and require
Colin Crossd6891432017-09-27 17:39:56 -07001357 // a rebuild when error-prone is turned off).
Colin Crossc6bbef32017-08-14 14:16:06 -07001358 // TODO(ccross): Once we always compile with javac9 we may be able to conditionally
1359 // enable error-prone without affecting the output class files.
Colin Cross1ee23172017-10-18 14:44:18 -07001360 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001361 RunErrorProne(ctx, errorprone, uniqueSrcFiles, srcJars, flags)
Colin Crossc6bbef32017-08-14 14:16:06 -07001362 extraJarDeps = append(extraJarDeps, errorprone)
1363 }
1364
Nan Zhang61eaedb2017-11-02 13:28:15 -07001365 if enable_sharding {
Colin Crossf5a66282020-02-21 08:16:41 -08001366 flags.classpath = append(flags.classpath, headerJarFileWithoutJarjar)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001367 shardSize := int(*(j.properties.Javac_shard_size))
1368 var shardSrcs []android.Paths
1369 if len(uniqueSrcFiles) > 0 {
Colin Cross0a2f7192019-09-23 14:33:09 -07001370 shardSrcs = android.ShardPaths(uniqueSrcFiles, shardSize)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001371 for idx, shardSrc := range shardSrcs {
Colin Cross3b706fd2019-09-05 16:44:18 -07001372 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1373 nil, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001374 jars = append(jars, classes)
1375 }
1376 }
1377 if len(srcJars) > 0 {
Colin Cross3b706fd2019-09-05 16:44:18 -07001378 classes := j.compileJavaClasses(ctx, jarName, len(shardSrcs),
1379 nil, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001380 jars = append(jars, classes)
1381 }
1382 } else {
Colin Cross3b706fd2019-09-05 16:44:18 -07001383 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueSrcFiles, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001384 jars = append(jars, classes)
1385 }
Colin Crossd6891432017-09-27 17:39:56 -07001386 if ctx.Failed() {
1387 return
1388 }
Colin Cross2fe66872015-03-30 17:20:39 -07001389 }
1390
Colin Cross0c4ce212019-05-03 15:28:19 -07001391 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1392
1393 var includeSrcJar android.WritablePath
1394 if Bool(j.properties.Include_srcs) {
1395 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1396 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1397 }
1398
Colin Crosscedd4762018-09-13 11:26:19 -07001399 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1400 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Colin Cross0f37af02017-09-27 17:42:05 -07001401 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
Colin Cross988708c2019-05-06 14:04:11 -07001402 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
Colin Cross0f37af02017-09-27 17:42:05 -07001403
1404 var resArgs []string
1405 var resDeps android.Paths
1406
1407 resArgs = append(resArgs, dirArgs...)
1408 resDeps = append(resDeps, dirDeps...)
1409
1410 resArgs = append(resArgs, fileArgs...)
1411 resDeps = append(resDeps, fileDeps...)
1412
Colin Cross988708c2019-05-06 14:04:11 -07001413 resArgs = append(resArgs, extraArgs...)
1414 resDeps = append(resDeps, extraDeps...)
1415
Colin Cross40a36712017-09-27 17:41:35 -07001416 if len(resArgs) > 0 {
Colin Cross1ee23172017-10-18 14:44:18 -07001417 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
Colin Crosse9a275b2017-10-16 17:09:48 -07001418 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Colin Cross331a1212018-08-15 20:40:52 -07001419 j.resourceJar = resourceJar
Colin Cross65bf4f22015-04-03 16:54:17 -07001420 if ctx.Failed() {
1421 return
1422 }
1423 }
1424
Colin Cross0c4ce212019-05-03 15:28:19 -07001425 var resourceJars android.Paths
1426 if j.resourceJar != nil {
1427 resourceJars = append(resourceJars, j.resourceJar)
1428 }
1429 if Bool(j.properties.Include_srcs) {
1430 resourceJars = append(resourceJars, includeSrcJar)
1431 }
1432 resourceJars = append(resourceJars, deps.staticResourceJars...)
Colin Cross331a1212018-08-15 20:40:52 -07001433
Colin Cross0c4ce212019-05-03 15:28:19 -07001434 if len(resourceJars) > 1 {
Colin Cross331a1212018-08-15 20:40:52 -07001435 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
Colin Cross0c4ce212019-05-03 15:28:19 -07001436 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
Colin Cross331a1212018-08-15 20:40:52 -07001437 false, nil, nil)
1438 j.resourceJar = combinedJar
Colin Cross0c4ce212019-05-03 15:28:19 -07001439 } else if len(resourceJars) == 1 {
1440 j.resourceJar = resourceJars[0]
Colin Cross331a1212018-08-15 20:40:52 -07001441 }
1442
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001443 if len(deps.staticJars) > 0 {
1444 jars = append(jars, deps.staticJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001445 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001446
Colin Cross094054a2018-10-17 15:10:48 -07001447 manifest := j.overrideManifest
1448 if !manifest.Valid() && j.properties.Manifest != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001449 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Colin Cross366938f2017-12-11 16:29:02 -08001450 }
Colin Cross635acc92017-09-12 22:50:46 -07001451
Colin Cross8a497952019-03-05 22:25:09 -08001452 services := android.PathsForModuleSrc(ctx, j.properties.Services)
Alex Light7f004a72019-02-21 13:27:37 -08001453 if len(services) > 0 {
1454 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1455 var zipargs []string
1456 for _, file := range services {
1457 serviceFile := file.String()
1458 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1459 }
1460 ctx.Build(pctx, android.BuildParams{
1461 Rule: zip,
1462 Output: servicesJar,
1463 Implicits: services,
1464 Args: map[string]string{
Colin Cross0b9f31f2019-02-28 11:00:01 -08001465 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
Alex Light7f004a72019-02-21 13:27:37 -08001466 },
1467 })
1468 jars = append(jars, servicesJar)
1469 }
1470
Colin Cross0a6e0072017-08-30 14:24:55 -07001471 // Combine the classes built from sources, any manifests, and any static libraries into
Nan Zhanged19fc32017-10-19 13:06:22 -07001472 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross3063b782018-08-15 11:19:12 -07001473 var outputFile android.ModuleOutPath
Colin Crosse9a275b2017-10-16 17:09:48 -07001474
1475 if len(jars) == 1 && !manifest.Valid() {
Colin Cross3063b782018-08-15 11:19:12 -07001476 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok {
1477 // Optimization: skip the combine step if there is nothing to do
1478 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1479 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1480 // any if len(jars) == 1.
1481 outputFile = moduleOutPath
1482 } else {
1483 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1484 ctx.Build(pctx, android.BuildParams{
1485 Rule: android.Cp,
1486 Input: jars[0],
1487 Output: combinedJar,
1488 })
1489 outputFile = combinedJar
1490 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001491 } else {
Colin Cross1ee23172017-10-18 14:44:18 -07001492 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001493 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
Colin Cross9b38aef2018-08-27 15:42:25 -07001494 false, nil, nil)
Colin Crosse9a275b2017-10-16 17:09:48 -07001495 outputFile = combinedJar
1496 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001497
Colin Cross331a1212018-08-15 20:40:52 -07001498 // jarjar implementation jar if necessary
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001499 if j.expandJarjarRules != nil {
Colin Cross8649b262017-09-27 18:03:17 -07001500 // Transform classes.jar into classes-jarjar.jar
Colin Cross1ee23172017-10-18 14:44:18 -07001501 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001502 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
Colin Crosse9a275b2017-10-16 17:09:48 -07001503 outputFile = jarjarFile
Colin Cross331a1212018-08-15 20:40:52 -07001504
1505 // jarjar resource jar if necessary
1506 if j.resourceJar != nil {
1507 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001508 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
Colin Cross331a1212018-08-15 20:40:52 -07001509 j.resourceJar = resourceJarJarFile
1510 }
1511
Colin Cross0a6e0072017-08-30 14:24:55 -07001512 if ctx.Failed() {
1513 return
1514 }
1515 }
Vladimir Marko0975ee02019-04-02 10:29:55 +01001516
1517 // Check package restrictions if necessary.
1518 if len(j.properties.Permitted_packages) > 0 {
1519 // Check packages and copy to package-checked file.
1520 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
1521 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
1522 j.additionalCheckedModules = append(j.additionalCheckedModules, pkgckFile)
1523
1524 if ctx.Failed() {
1525 return
1526 }
1527 }
1528
Nan Zhanged19fc32017-10-19 13:06:22 -07001529 j.implementationJarFile = outputFile
1530 if j.headerJarFile == nil {
1531 j.headerJarFile = j.implementationJarFile
1532 }
Colin Cross2fe66872015-03-30 17:20:39 -07001533
Jiyong Park28826602020-02-21 16:04:53 +09001534 // Force enable the instrumentation for java code that is built for APEXes ...
1535 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
1536 // doesn't make sense)
1537 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
1538 if android.DirectlyInAnyApex(ctx, ctx.ModuleName()) && !isJacocoAgent && !j.IsForPlatform() {
Jiyong Park81aaa0c2020-02-18 12:50:44 +00001539 j.properties.Instrument = true
1540 }
1541
Colin Cross3144dfc2018-01-03 15:06:47 -08001542 if j.shouldInstrument(ctx) {
Colin Crosscb933592017-11-22 13:49:43 -08001543 outputFile = j.instrument(ctx, flags, outputFile, jarName)
1544 }
1545
Colin Cross331a1212018-08-15 20:40:52 -07001546 // merge implementation jar with resources if necessary
1547 implementationAndResourcesJar := outputFile
1548 if j.resourceJar != nil {
Colin Cross08a409d2019-04-29 10:22:44 -07001549 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Colin Cross331a1212018-08-15 20:40:52 -07001550 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Colin Cross08a409d2019-04-29 10:22:44 -07001551 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
Colin Cross331a1212018-08-15 20:40:52 -07001552 false, nil, nil)
1553 implementationAndResourcesJar = combinedJar
1554 }
1555
1556 j.implementationAndResourcesJar = implementationAndResourcesJar
1557
Jiyong Park6b21c7d2020-02-11 09:16:01 +09001558 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
1559 if android.DirectlyInAnyApex(ctx, ctx.ModuleName()) && !j.IsForPlatform() {
1560 if j.deviceProperties.Compile_dex == nil {
1561 j.deviceProperties.Compile_dex = proptools.BoolPtr(true)
1562 }
1563 if j.deviceProperties.Hostdex == nil {
1564 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1565 }
1566 }
1567
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001568 if ctx.Device() && j.hasCode(ctx) &&
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001569 (Bool(j.properties.Installable) || Bool(j.deviceProperties.Compile_dex)) {
Colin Cross8faf8fc2019-01-16 15:15:52 -08001570 // Dex compilation
Colin Cross3063b782018-08-15 11:19:12 -07001571 var dexOutputFile android.ModuleOutPath
David Brazdil17ef5632018-06-27 10:27:45 +01001572 dexOutputFile = j.compileDex(ctx, flags, outputFile, jarName)
Colin Cross2fe66872015-03-30 17:20:39 -07001573 if ctx.Failed() {
1574 return
1575 }
Colin Cross331a1212018-08-15 20:40:52 -07001576
Jiyong Park09cb6292019-07-15 15:29:23 +09001577 // Hidden API CSV generation and dex encoding
1578 dexOutputFile = j.hiddenAPI.hiddenAPI(ctx, dexOutputFile, j.implementationJarFile,
David Srbecky98c71222020-05-20 22:20:28 +01001579 proptools.Bool(j.deviceProperties.Uncompress_dex))
Colin Cross8faf8fc2019-01-16 15:15:52 -08001580
Colin Cross331a1212018-08-15 20:40:52 -07001581 // merge dex jar with resources if necessary
1582 if j.resourceJar != nil {
1583 jars := android.Paths{dexOutputFile, j.resourceJar}
1584 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
1585 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1586 false, nil, nil)
David Srbecky98c71222020-05-20 22:20:28 +01001587 if *j.deviceProperties.Uncompress_dex {
Nicolas Geoffrayf3438722019-01-23 15:57:21 +00001588 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
1589 TransformZipAlign(ctx, combinedAlignedJar, combinedJar)
1590 dexOutputFile = combinedAlignedJar
1591 } else {
1592 dexOutputFile = combinedJar
1593 }
Colin Cross331a1212018-08-15 20:40:52 -07001594 }
1595
1596 j.dexJarFile = dexOutputFile
1597
Colin Cross8faf8fc2019-01-16 15:15:52 -08001598 // Dexpreopting
Colin Cross43f08db2018-11-12 10:13:39 -08001599 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
1600
1601 j.maybeStrippedDexJarFile = dexOutputFile
1602
Colin Cross3063b782018-08-15 11:19:12 -07001603 outputFile = dexOutputFile
Colin Cross43f08db2018-11-12 10:13:39 -08001604
1605 if ctx.Failed() {
1606 return
1607 }
Colin Cross331a1212018-08-15 20:40:52 -07001608 } else {
1609 outputFile = implementationAndResourcesJar
Colin Cross2fe66872015-03-30 17:20:39 -07001610 }
Colin Cross331a1212018-08-15 20:40:52 -07001611
Colin Crossb7a63242015-04-16 14:09:14 -07001612 ctx.CheckbuildFile(outputFile)
Colin Cross3063b782018-08-15 11:19:12 -07001613
1614 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1615 j.outputFile = outputFile.WithoutRel()
Colin Cross2fe66872015-03-30 17:20:39 -07001616}
1617
Colin Cross3b706fd2019-09-05 16:44:18 -07001618func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
1619 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.WritablePath {
1620
1621 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
1622 if idx >= 0 {
1623 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
1624 jarName += strconv.Itoa(idx)
1625 }
1626
1627 classes := android.PathForModuleOut(ctx, "javac", jarName)
1628 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, flags, extraJarDeps)
1629
1630 if ctx.Config().EmitXrefRules() {
1631 extractionFile := android.PathForModuleOut(ctx, kzipName)
1632 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1633 j.kytheFiles = append(j.kytheFiles, extractionFile)
1634 }
1635
1636 return classes
1637}
1638
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001639// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1640// since some of these flags may be used internally.
1641func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1642 for _, flag := range flags {
1643 flag = strings.TrimSpace(flag)
1644
1645 if !strings.HasPrefix(flag, "-") {
1646 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1647 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1648 ctx.PropertyErrorf("kotlincflags",
1649 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1650 } else if inList(flag, config.KotlincIllegalFlags) {
1651 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1652 } else if flag == "-include-runtime" {
1653 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1654 } else {
1655 args := strings.Split(flag, " ")
1656 if args[0] == "-kotlin-home" {
1657 ctx.PropertyErrorf("kotlincflags",
1658 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1659 }
1660 }
1661 }
1662}
1663
Colin Cross8eadbf02017-10-24 17:46:00 -07001664func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
Colin Crossf5a66282020-02-21 08:16:41 -08001665 deps deps, flags javaBuilderFlags, jarName string,
1666 extraJars android.Paths) (headerJar, jarjarHeaderJar android.Path) {
Nan Zhanged19fc32017-10-19 13:06:22 -07001667
1668 var jars android.Paths
Colin Cross8eadbf02017-10-24 17:46:00 -07001669 if len(srcFiles) > 0 || len(srcJars) > 0 {
Nan Zhanged19fc32017-10-19 13:06:22 -07001670 // Compile java sources into turbine.jar.
1671 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1672 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1673 if ctx.Failed() {
Colin Crossf5a66282020-02-21 08:16:41 -08001674 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001675 }
1676 jars = append(jars, turbineJar)
1677 }
1678
Colin Cross55f63ea2018-08-27 12:37:09 -07001679 jars = append(jars, extraJars...)
1680
Nan Zhanged19fc32017-10-19 13:06:22 -07001681 // Combine any static header libraries into classes-header.jar. If there is only
1682 // one input jar this step will be skipped.
Nan Zhanged19fc32017-10-19 13:06:22 -07001683 jars = append(jars, deps.staticHeaderJars...)
1684
Colin Cross5c6ecc12017-10-23 18:12:27 -07001685 // we cannot skip the combine step for now if there is only one jar
1686 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1687 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001688 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
Colin Cross6c6e6cd2019-05-08 14:30:12 -07001689 false, nil, []string{"META-INF/TRANSITIVE"})
Colin Cross5c6ecc12017-10-23 18:12:27 -07001690 headerJar = combinedJar
Colin Crossf5a66282020-02-21 08:16:41 -08001691 jarjarHeaderJar = combinedJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001692
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001693 if j.expandJarjarRules != nil {
Nan Zhanged19fc32017-10-19 13:06:22 -07001694 // Transform classes.jar into classes-jarjar.jar
1695 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001696 TransformJarJar(ctx, jarjarFile, headerJar, j.expandJarjarRules)
Colin Crossf5a66282020-02-21 08:16:41 -08001697 jarjarHeaderJar = jarjarFile
Nan Zhanged19fc32017-10-19 13:06:22 -07001698 if ctx.Failed() {
Colin Crossf5a66282020-02-21 08:16:41 -08001699 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001700 }
1701 }
1702
Colin Crossf5a66282020-02-21 08:16:41 -08001703 return headerJar, jarjarHeaderJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001704}
1705
Colin Crosscb933592017-11-22 13:49:43 -08001706func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross3063b782018-08-15 11:19:12 -07001707 classesJar android.Path, jarName string) android.ModuleOutPath {
Colin Crosscb933592017-11-22 13:49:43 -08001708
Colin Cross7a3139e2017-12-19 13:57:50 -08001709 specs := j.jacocoModuleToZipCommand(ctx)
Colin Crosscb933592017-11-22 13:49:43 -08001710
Colin Cross84c38822018-01-03 15:59:46 -08001711 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Crosscb933592017-11-22 13:49:43 -08001712 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
1713
1714 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1715
1716 j.jacocoReportClassesFile = jacocoReportClassesFile
1717
1718 return instrumentedJar
1719}
1720
albaltai36ff7dc2018-12-25 14:35:23 +08001721var _ Dependency = (*Module)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001722
Nan Zhanged19fc32017-10-19 13:06:22 -07001723func (j *Module) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001724 if j.headerJarFile == nil {
1725 return nil
1726 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001727 return android.Paths{j.headerJarFile}
1728}
1729
1730func (j *Module) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08001731 if j.implementationJarFile == nil {
1732 return nil
1733 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001734 return android.Paths{j.implementationJarFile}
Colin Cross2fe66872015-03-30 17:20:39 -07001735}
1736
Colin Crossf24a22a2019-01-31 14:12:44 -08001737func (j *Module) DexJar() android.Path {
1738 return j.dexJarFile
1739}
1740
Colin Cross331a1212018-08-15 20:40:52 -07001741func (j *Module) ResourceJars() android.Paths {
1742 if j.resourceJar == nil {
1743 return nil
1744 }
1745 return android.Paths{j.resourceJar}
1746}
1747
1748func (j *Module) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001749 if j.implementationAndResourcesJar == nil {
1750 return nil
1751 }
Colin Cross331a1212018-08-15 20:40:52 -07001752 return android.Paths{j.implementationAndResourcesJar}
1753}
1754
Colin Cross46c9b8b2017-06-22 16:51:17 -07001755func (j *Module) AidlIncludeDirs() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001756 // exportAidlIncludeDirs is type android.Paths already
Colin Crossc0b06f12015-04-08 13:03:43 -07001757 return j.exportAidlIncludeDirs
1758}
1759
Jiyong Park1be96912018-05-28 18:02:19 +09001760func (j *Module) ExportedSdkLibs() []string {
albaltai36ff7dc2018-12-25 14:35:23 +08001761 // exportedSdkLibs is type []string
Jiyong Park1be96912018-05-28 18:02:19 +09001762 return j.exportedSdkLibs
1763}
1764
Artur Satayev9cf46692019-11-26 18:08:34 +00001765func (j *Module) ExportedPlugins() (android.Paths, []string) {
1766 return j.exportedPluginJars, j.exportedPluginClasses
1767}
1768
Colin Cross0c4ce212019-05-03 15:28:19 -07001769func (j *Module) SrcJarArgs() ([]string, android.Paths) {
1770 return j.srcJarArgs, j.srcJarDeps
1771}
1772
Colin Cross46c9b8b2017-06-22 16:51:17 -07001773var _ logtagsProducer = (*Module)(nil)
Colin Crossf05fe972015-04-10 17:45:20 -07001774
Colin Cross46c9b8b2017-06-22 16:51:17 -07001775func (j *Module) logtags() android.Paths {
Colin Crossf05fe972015-04-10 17:45:20 -07001776 return j.logtagsSrcs
1777}
1778
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001779// Collect information for opening IDE project files in java/jdeps.go.
1780func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
1781 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
1782 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
patricktu18c82ff2019-05-10 15:48:50 +08001783 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001784 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001785 if j.expandJarjarRules != nil {
1786 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001787 }
1788}
1789
1790func (j *Module) CompilerDeps() []string {
1791 jdeps := []string{}
1792 jdeps = append(jdeps, j.properties.Libs...)
1793 jdeps = append(jdeps, j.properties.Static_libs...)
1794 return jdeps
1795}
1796
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001797func (j *Module) hasCode(ctx android.ModuleContext) bool {
1798 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
1799 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
1800}
1801
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001802func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffinc8f2f182020-05-17 08:34:50 +01001803 return j.depIsInSameApex(ctx, dep)
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001804}
1805
Jiyong Park0b238752019-10-29 11:23:10 +09001806func (j *Module) Stem() string {
1807 return proptools.StringDefault(j.deviceProperties.Stem, j.Name())
1808}
1809
Jiyong Park618922e2020-01-08 13:35:43 +09001810func (j *Module) JacocoReportClassesFile() android.Path {
1811 return j.jacocoReportClassesFile
1812}
1813
Martin Stjernholm6d415272020-01-31 17:10:36 +00001814func (j *Module) IsInstallable() bool {
1815 return Bool(j.properties.Installable)
1816}
1817
Colin Cross2fe66872015-03-30 17:20:39 -07001818//
1819// Java libraries (.jar file)
1820//
1821
Anton Hansson1e65f942020-03-27 19:39:48 +00001822type LibraryProperties struct {
1823 Dist struct {
1824 // The tag of the output of this module that should be output.
1825 Tag *string `android:"arch_variant"`
1826 } `android:"arch_variant"`
1827}
1828
Colin Crossf506d872017-07-19 15:53:04 -07001829type Library struct {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001830 Module
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001831
Anton Hansson1e65f942020-03-27 19:39:48 +00001832 libraryProperties LibraryProperties
1833
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001834 InstallMixin func(ctx android.ModuleContext, installPath android.Path) (extraInstallDeps android.Paths)
Colin Cross2fe66872015-03-30 17:20:39 -07001835}
1836
Colin Cross42be7612019-02-21 18:12:14 -08001837func shouldUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter) bool {
Ulya Trafimovichf491dde2020-01-24 12:19:45 +00001838 // Store uncompressed (and aligned) any dex files from jars in APEXes.
1839 if am, ok := ctx.Module().(android.ApexModule); ok && !am.IsForPlatform() {
1840 return true
1841 }
1842
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001843 // Store uncompressed (and do not strip) dex files from boot class path jars.
1844 if inList(ctx.ModuleName(), ctx.Config().BootJars()) {
1845 return true
1846 }
1847
1848 // Store uncompressed dex files that are preopted on /system.
Colin Cross42be7612019-02-21 18:12:14 -08001849 if !dexpreopter.dexpreoptDisabled(ctx) && (ctx.Host() || !odexOnSystemOther(ctx, dexpreopter.installPath)) {
Vladimir Markoe8b00d62018-12-21 15:54:16 +00001850 return true
1851 }
Colin Cross083a2aa2019-02-06 16:37:12 -08001852 if ctx.Config().UncompressPrivAppDex() &&
1853 inList(ctx.ModuleName(), ctx.Config().ModulesLoadedByPrivilegedModules()) {
1854 return true
1855 }
1856
Colin Cross2fc72f62018-12-21 12:59:54 -08001857 return false
1858}
1859
Colin Crossf506d872017-07-19 15:53:04 -07001860func (j *Library) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayeve5ac15a2020-04-08 19:09:30 +01001861 j.checkSdkVersions(ctx)
Jiyong Park0b238752019-10-29 11:23:10 +09001862 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross43f08db2018-11-12 10:13:39 -08001863 j.dexpreopter.isSDKLibrary = j.deviceProperties.IsSDKLibrary
David Srbecky98c71222020-05-20 22:20:28 +01001864 if j.deviceProperties.Uncompress_dex == nil {
1865 // If the value was not force-set by the user, use reasonable default based on the module.
1866 j.deviceProperties.Uncompress_dex = proptools.BoolPtr(shouldUncompressDex(ctx, &j.dexpreopter))
1867 }
1868 j.dexpreopter.uncompressedDex = *j.deviceProperties.Uncompress_dex
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001869 j.compile(ctx, nil)
Colin Crossb7a63242015-04-16 14:09:14 -07001870
Jiyong Park7f7766d2019-07-25 22:02:35 +09001871 exclusivelyForApex := android.InAnyApex(ctx.ModuleName()) && !j.IsForPlatform()
1872 if (Bool(j.properties.Installable) || ctx.Host()) && !exclusivelyForApex {
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001873 var extraInstallDeps android.Paths
1874 if j.InstallMixin != nil {
1875 extraInstallDeps = j.InstallMixin(ctx, j.outputFile)
1876 }
Colin Cross2c429dc2017-08-31 16:45:16 -07001877 j.installFile = ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001878 ctx.ModuleName()+".jar", j.outputFile, extraInstallDeps...)
Colin Cross2c429dc2017-08-31 16:45:16 -07001879 }
Anton Hansson1e65f942020-03-27 19:39:48 +00001880
1881 // Verify Dist.Tag is set to a supported output
1882 if j.libraryProperties.Dist.Tag != nil {
1883 distFiles, err := j.OutputFiles(*j.libraryProperties.Dist.Tag)
1884 if err != nil {
1885 ctx.PropertyErrorf("dist.tag", "%s", err.Error())
1886 }
1887 j.distFile = distFiles[0]
1888 }
Colin Crossb7a63242015-04-16 14:09:14 -07001889}
1890
Colin Crossf506d872017-07-19 15:53:04 -07001891func (j *Library) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001892 j.deps(ctx)
1893}
1894
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001895const (
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001896 aidlIncludeDir = "aidl"
1897 javaDir = "java"
1898 jarFileSuffix = ".jar"
1899 testConfigSuffix = "-AndroidTest.xml"
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001900)
1901
Paul Duffina0dbf432019-12-05 11:25:53 +00001902// path to the jar file of a java library. Relative to <sdk_root>/<api_dir>
Paul Duffin9b358d72020-03-02 10:16:35 +00001903func sdkSnapshotFilePathForJar(osPrefix, name string) string {
1904 return sdkSnapshotFilePathForMember(osPrefix, name, jarFileSuffix)
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001905}
1906
Paul Duffin9b358d72020-03-02 10:16:35 +00001907func sdkSnapshotFilePathForMember(osPrefix, name string, suffix string) string {
1908 return filepath.Join(javaDir, osPrefix, name+suffix)
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001909}
1910
Paul Duffin13879572019-11-28 14:31:38 +00001911type librarySdkMemberType struct {
Paul Duffin255f18e2019-12-13 11:22:16 +00001912 android.SdkMemberTypeBase
Paul Duffin2b9e3d32020-02-28 14:39:53 +00001913
1914 // Function to retrieve the appropriate output jar (implementation or header) from
1915 // the library.
1916 jarToExportGetter func(j *Library) android.Path
Paul Duffin13879572019-11-28 14:31:38 +00001917}
1918
1919func (mt *librarySdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
1920 mctx.AddVariationDependencies(nil, dependencyTag, names...)
1921}
1922
1923func (mt *librarySdkMemberType) IsInstance(module android.Module) bool {
1924 _, ok := module.(*Library)
1925 return ok
1926}
1927
Paul Duffin17ab8832020-03-19 16:11:18 +00001928func (mt *librarySdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
1929 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_import")
Paul Duffind76209b2020-03-02 11:33:02 +00001930}
Paul Duffina0dbf432019-12-05 11:25:53 +00001931
Paul Duffind76209b2020-03-02 11:33:02 +00001932func (mt *librarySdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
Paul Duffinc9103932020-03-17 21:04:24 +00001933 return &librarySdkMemberProperties{}
Paul Duffind76209b2020-03-02 11:33:02 +00001934}
1935
1936type librarySdkMemberProperties struct {
1937 android.SdkMemberPropertiesBase
1938
Paul Duffin08385bf2020-05-06 10:23:19 +01001939 JarToExport android.Path `android:"arch_variant"`
Paul Duffinc9103932020-03-17 21:04:24 +00001940 AidlIncludeDirs android.Paths
Paul Duffind76209b2020-03-02 11:33:02 +00001941}
1942
Paul Duffin17ab8832020-03-19 16:11:18 +00001943func (p *librarySdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin13879572019-11-28 14:31:38 +00001944 j := variant.(*Library)
1945
Paul Duffinc9103932020-03-17 21:04:24 +00001946 p.JarToExport = ctx.MemberType().(*librarySdkMemberType).jarToExportGetter(j)
1947 p.AidlIncludeDirs = j.AidlIncludeDirs()
Paul Duffind76209b2020-03-02 11:33:02 +00001948}
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001949
Paul Duffin17ab8832020-03-19 16:11:18 +00001950func (p *librarySdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffinc9103932020-03-17 21:04:24 +00001951 builder := ctx.SnapshotBuilder()
Paul Duffin17ab8832020-03-19 16:11:18 +00001952
Paul Duffinc9103932020-03-17 21:04:24 +00001953 exportedJar := p.JarToExport
1954 if exportedJar != nil {
1955 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
Paul Duffind76209b2020-03-02 11:33:02 +00001956 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
1957
Paul Duffinc9103932020-03-17 21:04:24 +00001958 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
1959 }
1960
1961 aidlIncludeDirs := p.AidlIncludeDirs
1962 if len(aidlIncludeDirs) != 0 {
1963 sdkModuleContext := ctx.SdkModuleContext()
1964 for _, dir := range aidlIncludeDirs {
Paul Duffind76209b2020-03-02 11:33:02 +00001965 // TODO(jiyong): copy parcelable declarations only
1966 aidlFiles, _ := sdkModuleContext.GlobWithDeps(dir.String()+"/**/*.aidl", nil)
1967 for _, file := range aidlFiles {
1968 builder.CopyToSnapshot(android.PathForSource(sdkModuleContext, file), filepath.Join(aidlIncludeDir, file))
1969 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001970 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001971
Paul Duffinc9103932020-03-17 21:04:24 +00001972 // TODO(b/151933053) - add aidl include dirs property
Paul Duffind76209b2020-03-02 11:33:02 +00001973 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001974}
1975
Paul Duffin2b9e3d32020-02-28 14:39:53 +00001976var javaHeaderLibsSdkMemberType android.SdkMemberType = &librarySdkMemberType{
1977 android.SdkMemberTypeBase{
1978 PropertyName: "java_header_libs",
1979 SupportsSdk: true,
Paul Duffin7b81f5e2020-01-13 21:03:22 +00001980 },
Paul Duffin2b9e3d32020-02-28 14:39:53 +00001981 func(j *Library) android.Path {
Paul Duffina0dbf432019-12-05 11:25:53 +00001982 headerJars := j.HeaderJars()
1983 if len(headerJars) != 1 {
1984 panic(fmt.Errorf("there must be only one header jar from %q", j.Name()))
1985 }
1986
1987 return headerJars[0]
Paul Duffin2b9e3d32020-02-28 14:39:53 +00001988 },
Paul Duffina0dbf432019-12-05 11:25:53 +00001989}
1990
Colin Cross1b16b0e2019-02-12 14:41:32 -08001991// java_library builds and links sources into a `.jar` file for the device, and possibly for the host as well.
1992//
1993// By default, a java_library has a single variant that produces a `.jar` file containing `.class` files that were
1994// compiled against the device bootclasspath. This jar is not suitable for installing on a device, but can be used
1995// as a `static_libs` dependency of another module.
1996//
1997// Specifying `installable: true` will product a `.jar` file containing `classes.dex` files, suitable for installing on
1998// a device.
1999//
2000// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2001// compiled against the host bootclasspath.
Colin Cross9ae1b922018-06-26 17:59:05 -07002002func LibraryFactory() android.Module {
2003 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07002004
Colin Cross9ae1b922018-06-26 17:59:05 -07002005 module.AddProperties(
2006 &module.Module.properties,
2007 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002008 &module.Module.dexpreoptProperties,
Anton Hansson1e65f942020-03-27 19:39:48 +00002009 &module.Module.protoProperties,
2010 &module.libraryProperties)
Colin Cross2fe66872015-03-30 17:20:39 -07002011
Paul Duffin64e61992020-05-15 10:20:31 +01002012 module.initModuleAndImport(&module.ModuleBase)
2013
Jiyong Park7f7766d2019-07-25 22:02:35 +09002014 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002015 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002016 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross9ae1b922018-06-26 17:59:05 -07002017 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002018}
2019
Colin Cross1b16b0e2019-02-12 14:41:32 -08002020// java_library_static is an obsolete alias for java_library.
2021func LibraryStaticFactory() android.Module {
2022 return LibraryFactory()
2023}
2024
2025// java_library_host builds and links sources into a `.jar` file for the host.
2026//
2027// A java_library_host has a single variant that produces a `.jar` file containing `.class` files that were
2028// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002029func LibraryHostFactory() android.Module {
2030 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07002031
Colin Cross6af17aa2017-09-20 12:59:05 -07002032 module.AddProperties(
2033 &module.Module.properties,
2034 &module.Module.protoProperties)
Colin Cross36242852017-06-23 15:06:31 -07002035
Colin Cross9ae1b922018-06-26 17:59:05 -07002036 module.Module.properties.Installable = proptools.BoolPtr(true)
2037
Jiyong Park7f7766d2019-07-25 22:02:35 +09002038 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002039 InitJavaModule(module, android.HostSupported)
Colin Cross36242852017-06-23 15:06:31 -07002040 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002041}
2042
2043//
Colin Crossb628ea52018-08-14 16:42:33 -07002044// Java Tests
Colin Cross05638fc2018-04-09 18:40:24 -07002045//
2046
2047type testProperties struct {
Colin Cross05638fc2018-04-09 18:40:24 -07002048 // list of compatibility suites (for example "cts", "vts") that the module should be
2049 // installed into.
2050 Test_suites []string `android:"arch_variant"`
Julien Despreze146e392018-08-02 15:00:46 -07002051
2052 // the name of the test configuration (for example "AndroidTest.xml") that should be
2053 // installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002054 Test_config *string `android:"path,arch_variant"`
Colin Crossd96ca352018-08-10 16:06:24 -07002055
Jack He33338892018-09-19 02:21:28 -07002056 // the name of the test configuration template (for example "AndroidTestTemplate.xml") that
2057 // should be installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002058 Test_config_template *string `android:"path,arch_variant"`
Jack He33338892018-09-19 02:21:28 -07002059
Colin Crossd96ca352018-08-10 16:06:24 -07002060 // list of files or filegroup modules that provide data that should be installed alongside
2061 // the test
Colin Cross27b922f2019-03-04 22:35:41 -08002062 Data []string `android:"path"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07002063
2064 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
2065 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
2066 // explicitly.
2067 Auto_gen_config *bool
Colin Cross05638fc2018-04-09 18:40:24 -07002068}
2069
Paul Duffin42df1442019-03-20 12:45:53 +00002070type testHelperLibraryProperties struct {
2071 // list of compatibility suites (for example "cts", "vts") that the module should be
2072 // installed into.
2073 Test_suites []string `android:"arch_variant"`
2074}
2075
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002076type prebuiltTestProperties struct {
2077 // list of compatibility suites (for example "cts", "vts") that the module should be
2078 // installed into.
2079 Test_suites []string `android:"arch_variant"`
2080
2081 // the name of the test configuration (for example "AndroidTest.xml") that should be
2082 // installed with the module.
2083 Test_config *string `android:"path,arch_variant"`
2084}
2085
Colin Cross05638fc2018-04-09 18:40:24 -07002086type Test struct {
2087 Library
2088
2089 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07002090
2091 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07002092 data android.Paths
Colin Cross303e21f2018-08-07 16:49:25 -07002093}
2094
Paul Duffin42df1442019-03-20 12:45:53 +00002095type TestHelperLibrary struct {
2096 Library
2097
2098 testHelperLibraryProperties testHelperLibraryProperties
2099}
2100
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002101type JavaTestImport struct {
2102 Import
2103
2104 prebuiltTestProperties prebuiltTestProperties
2105
2106 testConfig android.Path
2107}
2108
Colin Cross303e21f2018-08-07 16:49:25 -07002109func (j *Test) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Dan Shi6ffaaa82019-09-26 11:41:36 -07002110 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.testProperties.Test_config, j.testProperties.Test_config_template,
2111 j.testProperties.Test_suites, j.testProperties.Auto_gen_config)
Colin Cross8a497952019-03-05 22:25:09 -08002112 j.data = android.PathsForModuleSrc(ctx, j.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07002113
2114 j.Library.GenerateAndroidBuildActions(ctx)
Colin Cross05638fc2018-04-09 18:40:24 -07002115}
2116
Paul Duffin42df1442019-03-20 12:45:53 +00002117func (j *TestHelperLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2118 j.Library.GenerateAndroidBuildActions(ctx)
2119}
2120
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002121func (j *JavaTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2122 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.prebuiltTestProperties.Test_config, nil,
2123 j.prebuiltTestProperties.Test_suites, nil)
2124
2125 j.Import.GenerateAndroidBuildActions(ctx)
2126}
2127
2128type testSdkMemberType struct {
2129 android.SdkMemberTypeBase
2130}
2131
2132func (mt *testSdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
2133 mctx.AddVariationDependencies(nil, dependencyTag, names...)
2134}
2135
2136func (mt *testSdkMemberType) IsInstance(module android.Module) bool {
2137 _, ok := module.(*Test)
2138 return ok
2139}
2140
Paul Duffin17ab8832020-03-19 16:11:18 +00002141func (mt *testSdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
2142 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_test_import")
Paul Duffind76209b2020-03-02 11:33:02 +00002143}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002144
Paul Duffind76209b2020-03-02 11:33:02 +00002145func (mt *testSdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
2146 return &testSdkMemberProperties{}
2147}
2148
2149type testSdkMemberProperties struct {
2150 android.SdkMemberPropertiesBase
2151
Paul Duffinc9103932020-03-17 21:04:24 +00002152 JarToExport android.Path
2153 TestConfig android.Path
Paul Duffind76209b2020-03-02 11:33:02 +00002154}
2155
Paul Duffin17ab8832020-03-19 16:11:18 +00002156func (p *testSdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffind76209b2020-03-02 11:33:02 +00002157 test := variant.(*Test)
2158
2159 implementationJars := test.ImplementationJars()
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002160 if len(implementationJars) != 1 {
Paul Duffind76209b2020-03-02 11:33:02 +00002161 panic(fmt.Errorf("there must be only one implementation jar from %q", test.Name()))
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002162 }
2163
Paul Duffinc9103932020-03-17 21:04:24 +00002164 p.JarToExport = implementationJars[0]
2165 p.TestConfig = test.testConfig
Paul Duffind76209b2020-03-02 11:33:02 +00002166}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002167
Paul Duffin17ab8832020-03-19 16:11:18 +00002168func (p *testSdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffinc9103932020-03-17 21:04:24 +00002169 builder := ctx.SnapshotBuilder()
Paul Duffin17ab8832020-03-19 16:11:18 +00002170
Paul Duffinc9103932020-03-17 21:04:24 +00002171 exportedJar := p.JarToExport
2172 if exportedJar != nil {
2173 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
2174 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
Paul Duffind76209b2020-03-02 11:33:02 +00002175
2176 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
Paul Duffinc9103932020-03-17 21:04:24 +00002177 }
2178
2179 testConfig := p.TestConfig
2180 if testConfig != nil {
2181 snapshotRelativeTestConfigPath := sdkSnapshotFilePathForMember(p.OsPrefix(), ctx.Name(), testConfigSuffix)
2182 builder.CopyToSnapshot(testConfig, snapshotRelativeTestConfigPath)
Paul Duffind76209b2020-03-02 11:33:02 +00002183 propertySet.AddProperty("test_config", snapshotRelativeTestConfigPath)
2184 }
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002185}
2186
Colin Cross1b16b0e2019-02-12 14:41:32 -08002187// java_test builds a and links sources into a `.jar` file for the device, and possibly for the host as well, and
2188// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
2189//
2190// By default, a java_test has a single variant that produces a `.jar` file containing `classes.dex` files that were
2191// compiled against the device bootclasspath.
2192//
2193// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2194// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002195func TestFactory() android.Module {
2196 module := &Test{}
2197
2198 module.AddProperties(
2199 &module.Module.properties,
2200 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002201 &module.Module.dexpreoptProperties,
Colin Cross05638fc2018-04-09 18:40:24 -07002202 &module.Module.protoProperties,
2203 &module.testProperties)
2204
Colin Cross9ae1b922018-06-26 17:59:05 -07002205 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse3026872019-01-05 22:30:13 -08002206 module.Module.dexpreopter.isTest = true
Colin Cross9ae1b922018-06-26 17:59:05 -07002207
Colin Cross05638fc2018-04-09 18:40:24 -07002208 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002209 return module
2210}
2211
Paul Duffin42df1442019-03-20 12:45:53 +00002212// java_test_helper_library creates a java library and makes sure that it is added to the appropriate test suite.
2213func TestHelperLibraryFactory() android.Module {
2214 module := &TestHelperLibrary{}
2215
2216 module.AddProperties(
2217 &module.Module.properties,
2218 &module.Module.deviceProperties,
2219 &module.Module.dexpreoptProperties,
2220 &module.Module.protoProperties,
2221 &module.testHelperLibraryProperties)
2222
Colin Cross9a4abed2019-04-24 13:19:28 -07002223 module.Module.properties.Installable = proptools.BoolPtr(true)
2224 module.Module.dexpreopter.isTest = true
2225
Paul Duffin42df1442019-03-20 12:45:53 +00002226 InitJavaModule(module, android.HostAndDeviceSupported)
2227 return module
2228}
2229
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002230// java_test_import imports one or more `.jar` files into the build graph as if they were built by a java_test module
2231// and makes sure that it is added to the appropriate test suite.
2232//
2233// By default, a java_test_import has a single variant that expects a `.jar` file containing `.class` files that were
2234// compiled against an Android classpath.
2235//
2236// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2237// for host modules.
2238func JavaTestImportFactory() android.Module {
2239 module := &JavaTestImport{}
2240
2241 module.AddProperties(
2242 &module.Import.properties,
2243 &module.prebuiltTestProperties)
2244
2245 module.Import.properties.Installable = proptools.BoolPtr(true)
2246
2247 android.InitPrebuiltModule(module, &module.properties.Jars)
2248 android.InitApexModule(module)
2249 android.InitSdkAwareModule(module)
2250 InitJavaModule(module, android.HostAndDeviceSupported)
2251 return module
2252}
2253
Colin Cross1b16b0e2019-02-12 14:41:32 -08002254// java_test_host builds a and links sources into a `.jar` file for the host, and creates an `AndroidTest.xml` file to
2255// allow running the test with `atest` or a `TEST_MAPPING` file.
2256//
2257// A java_test_host has a single variant that produces a `.jar` file containing `.class` files that were
2258// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002259func TestHostFactory() android.Module {
2260 module := &Test{}
2261
2262 module.AddProperties(
2263 &module.Module.properties,
2264 &module.Module.protoProperties,
2265 &module.testProperties)
2266
Colin Cross9ae1b922018-06-26 17:59:05 -07002267 module.Module.properties.Installable = proptools.BoolPtr(true)
2268
Colin Cross05638fc2018-04-09 18:40:24 -07002269 InitJavaModule(module, android.HostSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002270 return module
2271}
2272
2273//
Colin Cross2fe66872015-03-30 17:20:39 -07002274// Java Binaries (.jar file plus wrapper script)
2275//
2276
Colin Crossf506d872017-07-19 15:53:04 -07002277type binaryProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -07002278 // installable script to execute the resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -08002279 Wrapper *string `android:"path"`
Colin Cross094054a2018-10-17 15:10:48 -07002280
2281 // Name of the class containing main to be inserted into the manifest as Main-Class.
2282 Main_class *string
Colin Cross7d5136f2015-05-11 13:39:40 -07002283}
2284
Colin Crossf506d872017-07-19 15:53:04 -07002285type Binary struct {
2286 Library
Colin Cross2fe66872015-03-30 17:20:39 -07002287
Colin Crossf506d872017-07-19 15:53:04 -07002288 binaryProperties binaryProperties
Colin Cross10a03492017-08-10 17:09:43 -07002289
Colin Cross6b4a32d2017-12-05 13:42:45 -08002290 isWrapperVariant bool
2291
Colin Crossc3315992017-12-08 19:12:36 -08002292 wrapperFile android.Path
Colin Cross70dda7e2019-10-01 22:05:35 -07002293 binaryFile android.InstallPath
Colin Cross2fe66872015-03-30 17:20:39 -07002294}
2295
Alex Light24237172017-10-26 09:46:21 -07002296func (j *Binary) HostToolPath() android.OptionalPath {
2297 return android.OptionalPathForPath(j.binaryFile)
2298}
2299
Colin Crossf506d872017-07-19 15:53:04 -07002300func (j *Binary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002301 if ctx.Arch().ArchType == android.Common {
2302 // Compile the jar
Colin Cross094054a2018-10-17 15:10:48 -07002303 if j.binaryProperties.Main_class != nil {
2304 if j.properties.Manifest != nil {
2305 ctx.PropertyErrorf("main_class", "main_class cannot be used when manifest is set")
2306 }
2307 manifestFile := android.PathForModuleOut(ctx, "manifest.txt")
2308 GenerateMainClassManifest(ctx, manifestFile, String(j.binaryProperties.Main_class))
2309 j.overrideManifest = android.OptionalPathForPath(manifestFile)
2310 }
2311
Colin Cross6b4a32d2017-12-05 13:42:45 -08002312 j.Library.GenerateAndroidBuildActions(ctx)
Nan Zhang3c807db2017-11-03 14:53:31 -07002313 } else {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002314 // Handle the binary wrapper
2315 j.isWrapperVariant = true
2316
Colin Cross366938f2017-12-11 16:29:02 -08002317 if j.binaryProperties.Wrapper != nil {
Colin Cross8a497952019-03-05 22:25:09 -08002318 j.wrapperFile = android.PathForModuleSrc(ctx, *j.binaryProperties.Wrapper)
Colin Cross6b4a32d2017-12-05 13:42:45 -08002319 } else {
2320 j.wrapperFile = android.PathForSource(ctx, "build/soong/scripts/jar-wrapper.sh")
2321 }
2322
2323 // Depend on the installed jar so that the wrapper doesn't get executed by
2324 // another build rule before the jar has been installed.
2325 jarFile := ctx.PrimaryModule().(*Binary).installFile
2326
2327 j.binaryFile = ctx.InstallExecutable(android.PathForModuleInstall(ctx, "bin"),
2328 ctx.ModuleName(), j.wrapperFile, jarFile)
Nan Zhang3c807db2017-11-03 14:53:31 -07002329 }
Colin Cross2fe66872015-03-30 17:20:39 -07002330}
2331
Colin Crossf506d872017-07-19 15:53:04 -07002332func (j *Binary) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002333 if ctx.Arch().ArchType == android.Common {
2334 j.deps(ctx)
2335 }
Colin Cross46c9b8b2017-06-22 16:51:17 -07002336}
2337
Colin Cross1b16b0e2019-02-12 14:41:32 -08002338// java_binary builds a `.jar` file and a shell script that executes it for the device, and possibly for the host
2339// as well.
2340//
2341// By default, a java_binary has a single variant that produces a `.jar` file containing `classes.dex` files that were
2342// compiled against the device bootclasspath.
2343//
2344// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2345// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002346func BinaryFactory() android.Module {
2347 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002348
Colin Cross36242852017-06-23 15:06:31 -07002349 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07002350 &module.Module.properties,
2351 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002352 &module.Module.dexpreoptProperties,
Colin Cross6af17aa2017-09-20 12:59:05 -07002353 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07002354 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002355
Colin Cross9ae1b922018-06-26 17:59:05 -07002356 module.Module.properties.Installable = proptools.BoolPtr(true)
2357
Colin Cross6b4a32d2017-12-05 13:42:45 -08002358 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibCommonFirst)
2359 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002360 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002361}
2362
Colin Cross1b16b0e2019-02-12 14:41:32 -08002363// java_binary_host builds a `.jar` file and a shell script that executes it for the host.
2364//
2365// A java_binary_host has a single variant that produces a `.jar` file containing `.class` files that were
2366// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002367func BinaryHostFactory() android.Module {
2368 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002369
Colin Cross36242852017-06-23 15:06:31 -07002370 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07002371 &module.Module.properties,
Colin Cross6af17aa2017-09-20 12:59:05 -07002372 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07002373 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002374
Colin Cross9ae1b922018-06-26 17:59:05 -07002375 module.Module.properties.Installable = proptools.BoolPtr(true)
2376
Colin Cross6b4a32d2017-12-05 13:42:45 -08002377 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommonFirst)
2378 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002379 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002380}
2381
2382//
2383// Java prebuilts
2384//
2385
Colin Cross74d73e22017-08-02 11:05:49 -07002386type ImportProperties struct {
Paul Duffin9b358d72020-03-02 10:16:35 +00002387 Jars []string `android:"path,arch_variant"`
Colin Cross461bd1a2017-10-20 13:59:18 -07002388
Nan Zhangea568a42017-11-08 21:20:04 -08002389 Sdk_version *string
Colin Cross535e2cf2017-10-20 17:57:49 -07002390
2391 Installable *bool
Jiyong Park1be96912018-05-28 18:02:19 +09002392
2393 // List of shared java libs that this module has dependencies to
2394 Libs []string
Colin Cross37f6d792018-07-12 12:28:41 -07002395
2396 // List of files to remove from the jar file(s)
2397 Exclude_files []string
2398
2399 // List of directories to remove from the jar file(s)
2400 Exclude_dirs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -07002401
2402 // if set to true, run Jetifier against .jar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -07002403 Jetifier *bool
Jiyong Park4c4c0242019-10-21 14:53:15 +09002404
2405 // set the name of the output
2406 Stem *string
Colin Cross74d73e22017-08-02 11:05:49 -07002407}
2408
2409type Import struct {
Colin Cross635c3b02016-05-18 15:37:25 -07002410 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -07002411 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002412 android.ApexModuleBase
Colin Crossec7a0422017-07-07 14:47:12 -07002413 prebuilt android.Prebuilt
Jiyong Parkd1063c12019-07-17 20:08:41 +09002414 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -07002415
Paul Duffinc8f2f182020-05-17 08:34:50 +01002416 // Functionality common to Module and Import.
2417 embeddableInModuleAndImport
2418
Colin Cross74d73e22017-08-02 11:05:49 -07002419 properties ImportProperties
2420
Colin Cross0a6e0072017-08-30 14:24:55 -07002421 combinedClasspathFile android.Path
Jiyong Park1be96912018-05-28 18:02:19 +09002422 exportedSdkLibs []string
Colin Cross2fe66872015-03-30 17:20:39 -07002423}
2424
Jiyong Park6a927c42020-01-21 02:03:43 +09002425func (j *Import) sdkVersion() sdkSpec {
2426 return sdkSpecFrom(String(j.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07002427}
2428
Jiyong Park6a927c42020-01-21 02:03:43 +09002429func (j *Import) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -07002430 return j.sdkVersion()
2431}
2432
Artur Satayev388d39b2020-04-27 18:53:18 +01002433func (j *Import) MinSdkVersion() string {
2434 return j.minSdkVersion().version.String()
2435}
2436
Colin Cross74d73e22017-08-02 11:05:49 -07002437func (j *Import) Prebuilt() *android.Prebuilt {
Colin Crossec7a0422017-07-07 14:47:12 -07002438 return &j.prebuilt
2439}
2440
Colin Cross74d73e22017-08-02 11:05:49 -07002441func (j *Import) PrebuiltSrcs() []string {
2442 return j.properties.Jars
2443}
2444
2445func (j *Import) Name() string {
Colin Cross5ea9bcc2017-07-27 15:41:32 -07002446 return j.prebuilt.Name(j.ModuleBase.Name())
2447}
2448
Jiyong Park0b238752019-10-29 11:23:10 +09002449func (j *Import) Stem() string {
2450 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2451}
2452
Jiyong Park618922e2020-01-08 13:35:43 +09002453func (a *Import) JacocoReportClassesFile() android.Path {
2454 return nil
2455}
2456
Colin Cross74d73e22017-08-02 11:05:49 -07002457func (j *Import) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross42d48b72018-08-29 14:10:52 -07002458 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Colin Cross1e676be2016-10-12 14:38:15 -07002459}
2460
Colin Cross74d73e22017-08-02 11:05:49 -07002461func (j *Import) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross8a497952019-03-05 22:25:09 -08002462 jars := android.PathsForModuleSrc(ctx, j.properties.Jars)
Colin Crosse1d62a82015-04-03 16:53:05 -07002463
Jiyong Park0b238752019-10-29 11:23:10 +09002464 jarName := j.Stem() + ".jar"
Nan Zhang4c819fb2018-08-27 18:31:46 -07002465 outputFile := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07002466 TransformJarsToJar(ctx, outputFile, "for prebuilts", jars, android.OptionalPath{},
2467 false, j.properties.Exclude_files, j.properties.Exclude_dirs)
Colin Cross1001a792019-03-21 22:21:39 -07002468 if Bool(j.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -07002469 inputFile := outputFile
2470 outputFile = android.PathForModuleOut(ctx, "jetifier", jarName)
2471 TransformJetifier(ctx, outputFile, inputFile)
2472 }
Colin Crosse9a275b2017-10-16 17:09:48 -07002473 j.combinedClasspathFile = outputFile
Jiyong Park1be96912018-05-28 18:02:19 +09002474
Paul Duffin64e61992020-05-15 10:20:31 +01002475 // If this is a component library (impl, stubs, etc.) for a java_sdk_library then
2476 // add the name of that java_sdk_library to the exported sdk libs to make sure
2477 // that, if necessary, a <uses-library> element for that java_sdk_library is
2478 // added to the Android manifest.
2479 j.exportedSdkLibs = append(j.exportedSdkLibs, j.OptionalImplicitSdkLibrary()...)
2480
Jiyong Park1be96912018-05-28 18:02:19 +09002481 ctx.VisitDirectDeps(func(module android.Module) {
2482 otherName := ctx.OtherModuleName(module)
2483 tag := ctx.OtherModuleDependencyTag(module)
2484
2485 switch dep := module.(type) {
2486 case Dependency:
2487 switch tag {
2488 case libTag, staticLibTag:
2489 // sdk lib names from dependencies are re-exported
2490 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
2491 }
2492 case SdkLibraryDependency:
2493 switch tag {
2494 case libTag:
2495 // names of sdk libs that are directly depended are exported
2496 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
2497 }
2498 }
2499 })
2500
2501 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002502 if Bool(j.properties.Installable) {
2503 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Park4c4c0242019-10-21 14:53:15 +09002504 jarName, outputFile)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002505 }
Colin Cross2fe66872015-03-30 17:20:39 -07002506}
2507
Colin Cross74d73e22017-08-02 11:05:49 -07002508var _ Dependency = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002509
Nan Zhanged19fc32017-10-19 13:06:22 -07002510func (j *Import) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002511 if j.combinedClasspathFile == nil {
2512 return nil
2513 }
Colin Cross37f6d792018-07-12 12:28:41 -07002514 return android.Paths{j.combinedClasspathFile}
Nan Zhanged19fc32017-10-19 13:06:22 -07002515}
2516
2517func (j *Import) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08002518 if j.combinedClasspathFile == nil {
2519 return nil
2520 }
Colin Cross37f6d792018-07-12 12:28:41 -07002521 return android.Paths{j.combinedClasspathFile}
Colin Cross2fe66872015-03-30 17:20:39 -07002522}
2523
Colin Cross331a1212018-08-15 20:40:52 -07002524func (j *Import) ResourceJars() android.Paths {
2525 return nil
2526}
2527
2528func (j *Import) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002529 if j.combinedClasspathFile == nil {
2530 return nil
2531 }
Colin Cross331a1212018-08-15 20:40:52 -07002532 return android.Paths{j.combinedClasspathFile}
2533}
2534
Colin Crossf24a22a2019-01-31 14:12:44 -08002535func (j *Import) DexJar() android.Path {
2536 return nil
2537}
2538
Colin Cross74d73e22017-08-02 11:05:49 -07002539func (j *Import) AidlIncludeDirs() android.Paths {
Colin Crossc0b06f12015-04-08 13:03:43 -07002540 return nil
2541}
2542
Jiyong Park1be96912018-05-28 18:02:19 +09002543func (j *Import) ExportedSdkLibs() []string {
2544 return j.exportedSdkLibs
2545}
2546
Artur Satayev9cf46692019-11-26 18:08:34 +00002547func (j *Import) ExportedPlugins() (android.Paths, []string) {
2548 return nil, nil
2549}
2550
Colin Cross0c4ce212019-05-03 15:28:19 -07002551func (j *Import) SrcJarArgs() ([]string, android.Paths) {
2552 return nil, nil
2553}
2554
Jiyong Park0f80c182020-01-31 02:49:53 +09002555func (j *Import) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffinc8f2f182020-05-17 08:34:50 +01002556 return j.depIsInSameApex(ctx, dep)
Jiyong Park0f80c182020-01-31 02:49:53 +09002557}
2558
albaltai36ff7dc2018-12-25 14:35:23 +08002559// Add compile time check for interface implementation
2560var _ android.IDEInfo = (*Import)(nil)
2561var _ android.IDECustomizedModuleName = (*Import)(nil)
2562
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002563// Collect information for opening IDE project files in java/jdeps.go.
2564const (
2565 removedPrefix = "prebuilt_"
2566)
2567
2568func (j *Import) IDEInfo(dpInfo *android.IdeInfo) {
2569 dpInfo.Jars = append(dpInfo.Jars, j.PrebuiltSrcs()...)
2570}
2571
2572func (j *Import) IDECustomizedModuleName() string {
2573 // TODO(b/113562217): Extract the base module name from the Import name, often the Import name
2574 // has a prefix "prebuilt_". Remove the prefix explicitly if needed until we find a better
2575 // solution to get the Import name.
2576 name := j.Name()
2577 if strings.HasPrefix(name, removedPrefix) {
patricktubb640e02018-10-11 18:33:16 +08002578 name = strings.TrimPrefix(name, removedPrefix)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002579 }
2580 return name
2581}
2582
Colin Cross74d73e22017-08-02 11:05:49 -07002583var _ android.PrebuiltInterface = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002584
Colin Cross1b16b0e2019-02-12 14:41:32 -08002585// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library module.
2586//
2587// By default, a java_import has a single variant that expects a `.jar` file containing `.class` files that were
2588// compiled against an Android classpath.
2589//
2590// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2591// for host modules.
Colin Cross74d73e22017-08-02 11:05:49 -07002592func ImportFactory() android.Module {
2593 module := &Import{}
Colin Cross36242852017-06-23 15:06:31 -07002594
Colin Cross74d73e22017-08-02 11:05:49 -07002595 module.AddProperties(&module.properties)
2596
Paul Duffin64e61992020-05-15 10:20:31 +01002597 module.initModuleAndImport(&module.ModuleBase)
2598
Colin Cross74d73e22017-08-02 11:05:49 -07002599 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002600 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002601 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002602 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross36242852017-06-23 15:06:31 -07002603 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002604}
2605
Colin Cross1b16b0e2019-02-12 14:41:32 -08002606// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library_host
2607// module.
2608//
2609// A java_import_host has a single variant that expects a `.jar` file containing `.class` files that were
2610// compiled against a host bootclasspath.
Colin Cross74d73e22017-08-02 11:05:49 -07002611func ImportFactoryHost() android.Module {
2612 module := &Import{}
2613
2614 module.AddProperties(&module.properties)
2615
2616 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002617 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002618 InitJavaModule(module, android.HostSupported)
Colin Cross74d73e22017-08-02 11:05:49 -07002619 return module
2620}
2621
Colin Cross42be7612019-02-21 18:12:14 -08002622// dex_import module
2623
2624type DexImportProperties struct {
Colin Cross5cfc70d2019-07-15 13:36:55 -07002625 Jars []string `android:"path"`
Jiyong Park4c4c0242019-10-21 14:53:15 +09002626
2627 // set the name of the output
2628 Stem *string
Colin Cross42be7612019-02-21 18:12:14 -08002629}
2630
2631type DexImport struct {
2632 android.ModuleBase
2633 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002634 android.ApexModuleBase
Colin Cross42be7612019-02-21 18:12:14 -08002635 prebuilt android.Prebuilt
2636
2637 properties DexImportProperties
2638
2639 dexJarFile android.Path
2640 maybeStrippedDexJarFile android.Path
2641
2642 dexpreopter
2643}
2644
2645func (j *DexImport) Prebuilt() *android.Prebuilt {
2646 return &j.prebuilt
2647}
2648
2649func (j *DexImport) PrebuiltSrcs() []string {
2650 return j.properties.Jars
2651}
2652
2653func (j *DexImport) Name() string {
2654 return j.prebuilt.Name(j.ModuleBase.Name())
2655}
2656
Jiyong Park0b238752019-10-29 11:23:10 +09002657func (j *DexImport) Stem() string {
2658 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2659}
2660
Martin Stjernholm6d415272020-01-31 17:10:36 +00002661func (j *DexImport) IsInstallable() bool {
2662 return true
2663}
2664
Colin Cross42be7612019-02-21 18:12:14 -08002665func (j *DexImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2666 if len(j.properties.Jars) != 1 {
2667 ctx.PropertyErrorf("jars", "exactly one jar must be provided")
2668 }
2669
Jiyong Park0b238752019-10-29 11:23:10 +09002670 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross42be7612019-02-21 18:12:14 -08002671 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
2672
2673 inputJar := ctx.ExpandSource(j.properties.Jars[0], "jars")
2674 dexOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar")
2675
2676 if j.dexpreopter.uncompressedDex {
2677 rule := android.NewRuleBuilder()
2678
2679 temporary := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar.unaligned")
2680 rule.Temporary(temporary)
2681
2682 // use zip2zip to uncompress classes*.dex files
2683 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002684 BuiltTool(ctx, "zip2zip").
Colin Cross42be7612019-02-21 18:12:14 -08002685 FlagWithInput("-i ", inputJar).
2686 FlagWithOutput("-o ", temporary).
2687 FlagWithArg("-0 ", "'classes*.dex'")
2688
2689 // use zipalign to align uncompressed classes*.dex files
2690 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002691 BuiltTool(ctx, "zipalign").
Colin Cross42be7612019-02-21 18:12:14 -08002692 Flag("-f").
2693 Text("4").
2694 Input(temporary).
2695 Output(dexOutputFile)
2696
2697 rule.DeleteTemporaryFiles()
2698
2699 rule.Build(pctx, ctx, "uncompress_dex", "uncompress dex")
2700 } else {
2701 ctx.Build(pctx, android.BuildParams{
2702 Rule: android.Cp,
2703 Input: inputJar,
2704 Output: dexOutputFile,
2705 })
2706 }
2707
2708 j.dexJarFile = dexOutputFile
2709
2710 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
2711
2712 j.maybeStrippedDexJarFile = dexOutputFile
2713
2714 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
2715 ctx.ModuleName()+".jar", dexOutputFile)
2716}
2717
2718func (j *DexImport) DexJar() android.Path {
2719 return j.dexJarFile
2720}
2721
2722// dex_import imports a `.jar` file containing classes.dex files.
2723//
2724// A dex_import module cannot be used as a dependency of a java_* or android_* module, it can only be installed
2725// to the device.
2726func DexImportFactory() android.Module {
2727 module := &DexImport{}
2728
2729 module.AddProperties(&module.properties)
2730
2731 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002732 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002733 InitJavaModule(module, android.DeviceSupported)
Colin Cross42be7612019-02-21 18:12:14 -08002734 return module
2735}
2736
Colin Cross89536d42017-07-07 14:35:50 -07002737//
2738// Defaults
2739//
2740type Defaults struct {
2741 android.ModuleBase
2742 android.DefaultsModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002743 android.ApexModuleBase
Colin Cross89536d42017-07-07 14:35:50 -07002744}
2745
Colin Cross1b16b0e2019-02-12 14:41:32 -08002746// java_defaults provides a set of properties that can be inherited by other java or android modules.
2747//
2748// A module can use the properties from a java_defaults module using `defaults: ["defaults_module_name"]`. Each
2749// property in the defaults module that exists in the depending module will be prepended to the depending module's
2750// value for that property.
2751//
2752// Example:
2753//
2754// java_defaults {
2755// name: "example_defaults",
2756// srcs: ["common/**/*.java"],
2757// javacflags: ["-Xlint:all"],
2758// aaptflags: ["--auto-add-overlay"],
2759// }
2760//
2761// java_library {
2762// name: "example",
2763// defaults: ["example_defaults"],
2764// srcs: ["example/**/*.java"],
2765// }
2766//
2767// is functionally identical to:
2768//
2769// java_library {
2770// name: "example",
2771// srcs: [
2772// "common/**/*.java",
2773// "example/**/*.java",
2774// ],
2775// javacflags: ["-Xlint:all"],
2776// }
Colin Cross89536d42017-07-07 14:35:50 -07002777func defaultsFactory() android.Module {
2778 return DefaultsFactory()
2779}
2780
Paul Duffin47357662019-12-05 14:07:14 +00002781func DefaultsFactory() android.Module {
Colin Cross89536d42017-07-07 14:35:50 -07002782 module := &Defaults{}
2783
Colin Cross89536d42017-07-07 14:35:50 -07002784 module.AddProperties(
2785 &CompilerProperties{},
2786 &CompilerDeviceProperties{},
Colin Cross43f08db2018-11-12 10:13:39 -08002787 &DexpreoptProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08002788 &android.ProtoProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002789 &aaptProperties{},
2790 &androidLibraryProperties{},
2791 &appProperties{},
2792 &appTestProperties{},
Jaewoong Jung525443a2019-02-28 15:35:54 -08002793 &overridableAppProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002794 &ImportProperties{},
2795 &AARImportProperties{},
2796 &sdkLibraryProperties{},
Paul Duffin1a724e62020-05-08 13:44:43 +01002797 &commonToSdkLibraryAndImportProperties{},
Colin Cross42be7612019-02-21 18:12:14 -08002798 &DexImportProperties{},
Jooyung Han18020ea2019-11-13 10:50:48 +09002799 &android.ApexProperties{},
Jaewoong Jung062ed7e2020-04-26 15:10:51 -07002800 &RuntimeResourceOverlayProperties{},
Colin Cross89536d42017-07-07 14:35:50 -07002801 )
2802
2803 android.InitDefaultsModule(module)
Colin Cross89536d42017-07-07 14:35:50 -07002804 return module
2805}
Nan Zhangea568a42017-11-08 21:20:04 -08002806
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002807func kytheExtractJavaFactory() android.Singleton {
2808 return &kytheExtractJavaSingleton{}
2809}
2810
2811type kytheExtractJavaSingleton struct {
2812}
2813
2814func (ks *kytheExtractJavaSingleton) GenerateBuildActions(ctx android.SingletonContext) {
2815 var xrefTargets android.Paths
2816 ctx.VisitAllModules(func(module android.Module) {
2817 if javaModule, ok := module.(xref); ok {
2818 xrefTargets = append(xrefTargets, javaModule.XrefJavaFiles()...)
2819 }
2820 })
2821 // TODO(asmundak): perhaps emit a rule to output a warning if there were no xrefTargets
2822 if len(xrefTargets) > 0 {
2823 ctx.Build(pctx, android.BuildParams{
2824 Rule: blueprint.Phony,
2825 Output: android.PathForPhony(ctx, "xref_java"),
2826 Inputs: xrefTargets,
2827 })
2828 }
2829}
2830
Nan Zhangea568a42017-11-08 21:20:04 -08002831var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07002832var BoolDefault = proptools.BoolDefault
Nan Zhangea568a42017-11-08 21:20:04 -08002833var String = proptools.String
Colin Cross0d0ba592018-02-20 13:33:42 -08002834var inList = android.InList