blob: c80eef97f82722c4ebde281f6526ce7bbd71ae9d [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
Tej Singh83839722020-06-03 18:45:54 +0000470 // 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 Cross1c14b4e2020-06-15 16:09:53 -0700485func (j *Module) addHostProperties() {
486 j.AddProperties(
487 &j.properties,
488 &j.protoProperties,
489 )
490}
491
492func (j *Module) addHostAndDeviceProperties() {
493 j.addHostProperties()
494 j.AddProperties(
495 &j.deviceProperties,
496 &j.dexpreoptProperties,
497 )
498}
499
Colin Cross41955e82019-05-29 14:40:35 -0700500func (j *Module) OutputFiles(tag string) (android.Paths, error) {
501 switch tag {
502 case "":
503 return append(android.Paths{j.outputFile}, j.extraOutputFiles...), nil
Colin Cross375ca3c2019-05-29 14:40:58 -0700504 case ".jar":
505 return android.Paths{j.implementationAndResourcesJar}, nil
Colin Cross2d975b12019-07-29 16:47:42 -0700506 case ".proguard_map":
507 return android.Paths{j.proguardDictionary}, nil
Colin Cross41955e82019-05-29 14:40:35 -0700508 default:
509 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
510 }
Colin Cross54250902017-12-05 09:28:08 -0800511}
512
Colin Cross41955e82019-05-29 14:40:35 -0700513var _ android.OutputFileProducer = (*Module)(nil)
Colin Cross54250902017-12-05 09:28:08 -0800514
Colin Crossf506d872017-07-19 15:53:04 -0700515type Dependency interface {
Nan Zhanged19fc32017-10-19 13:06:22 -0700516 HeaderJars() android.Paths
517 ImplementationJars() android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700518 ResourceJars() android.Paths
519 ImplementationAndResourcesJars() android.Paths
Colin Crossf24a22a2019-01-31 14:12:44 -0800520 DexJar() android.Path
Colin Cross635c3b02016-05-18 15:37:25 -0700521 AidlIncludeDirs() android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900522 ExportedSdkLibs() []string
Artur Satayev9cf46692019-11-26 18:08:34 +0000523 ExportedPlugins() (android.Paths, []string)
Colin Cross0c4ce212019-05-03 15:28:19 -0700524 SrcJarArgs() ([]string, android.Paths)
Colin Crosse323f3c2019-09-17 15:34:09 -0700525 BaseModuleName() string
Jiyong Park618922e2020-01-08 13:35:43 +0900526 JacocoReportClassesFile() android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700527}
528
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800529type xref interface {
530 XrefJavaFiles() android.Paths
531}
532
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800533func (j *Module) XrefJavaFiles() android.Paths {
534 return j.kytheFiles
535}
536
Colin Cross89536d42017-07-07 14:35:50 -0700537func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
538 android.InitAndroidArchModule(module, hod, android.MultilibCommon)
539 android.InitDefaultableModule(module)
540}
541
Colin Crossbe1da472017-07-07 15:59:46 -0700542type dependencyTag struct {
543 blueprint.BaseDependencyTag
544 name string
Colin Cross2fe66872015-03-30 17:20:39 -0700545}
546
Colin Crossa4f08812018-10-02 22:03:40 -0700547type jniDependencyTag struct {
548 blueprint.BaseDependencyTag
Colin Crossa4f08812018-10-02 22:03:40 -0700549}
550
Jiyong Park8be103b2019-11-08 15:53:48 +0900551func IsJniDepTag(depTag blueprint.DependencyTag) bool {
552 _, ok := depTag.(*jniDependencyTag)
553 return ok
554}
555
Colin Crossbe1da472017-07-07 15:59:46 -0700556var (
Colin Cross4b964c02018-10-15 16:18:06 -0700557 staticLibTag = dependencyTag{name: "staticlib"}
558 libTag = dependencyTag{name: "javalib"}
Colin Cross6cef4812019-10-17 14:23:50 -0700559 java9LibTag = dependencyTag{name: "java9lib"}
Colin Crossbe9cdb82019-01-21 21:37:16 -0800560 pluginTag = dependencyTag{name: "plugin"}
Artur Satayev9cf46692019-11-26 18:08:34 +0000561 exportedPluginTag = dependencyTag{name: "exported-plugin"}
Colin Cross4b964c02018-10-15 16:18:06 -0700562 bootClasspathTag = dependencyTag{name: "bootclasspath"}
563 systemModulesTag = dependencyTag{name: "system modules"}
564 frameworkResTag = dependencyTag{name: "framework-res"}
565 frameworkApkTag = dependencyTag{name: "framework-apk"}
566 kotlinStdlibTag = dependencyTag{name: "kotlin-stdlib"}
Colin Crossafbb1732019-01-17 15:42:52 -0800567 kotlinAnnotationsTag = dependencyTag{name: "kotlin-annotations"}
Colin Cross4b964c02018-10-15 16:18:06 -0700568 proguardRaiseTag = dependencyTag{name: "proguard-raise"}
569 certificateTag = dependencyTag{name: "certificate"}
570 instrumentationForTag = dependencyTag{name: "instrumentation_for"}
Colin Cross50ddcc42019-05-16 12:28:22 -0700571 usesLibTag = dependencyTag{name: "uses-library"}
Colin Crossbe1da472017-07-07 15:59:46 -0700572)
Colin Cross2fe66872015-03-30 17:20:39 -0700573
Jiyong Park83dc74b2020-01-14 18:38:44 +0900574func IsLibDepTag(depTag blueprint.DependencyTag) bool {
575 return depTag == libTag
576}
577
578func IsStaticLibDepTag(depTag blueprint.DependencyTag) bool {
579 return depTag == staticLibTag
580}
581
Colin Crossfc3674a2017-09-18 17:41:52 -0700582type sdkDep struct {
Colin Cross47ff2522017-10-02 14:22:08 -0700583 useModule, useFiles, useDefaultLibs, invalidVersion bool
584
Colin Cross6cef4812019-10-17 14:23:50 -0700585 // The modules that will be added to the bootclasspath when targeting 1.8 or lower
586 bootclasspath []string
Paul Duffine25c6442019-10-11 13:50:28 +0100587
588 // The default system modules to use. Will be an empty string if no system
589 // modules are to be used.
Colin Cross1369cdb2017-09-29 17:58:17 -0700590 systemModules string
591
Colin Cross6cef4812019-10-17 14:23:50 -0700592 // The modules that will be added ot the classpath when targeting 1.9 or higher
593 java9Classpath []string
594
Colin Crossa97c5d32018-03-28 14:58:31 -0700595 frameworkResModule string
596
Colin Cross86a60ae2018-05-29 14:44:55 -0700597 jars android.Paths
Colin Cross3047fa22019-04-18 10:56:44 -0700598 aidl android.OptionalPath
Paul Duffin250e6192019-06-07 10:44:37 +0100599
600 noStandardLibs, noFrameworksLibs bool
601}
602
603func (s sdkDep) hasStandardLibs() bool {
604 return !s.noStandardLibs
605}
606
607func (s sdkDep) hasFrameworkLibs() bool {
608 return !s.noStandardLibs && !s.noFrameworksLibs
Colin Cross1369cdb2017-09-29 17:58:17 -0700609}
610
Colin Crossa4f08812018-10-02 22:03:40 -0700611type jniLib struct {
Jaewoong Jung37ca4a12020-03-26 14:01:48 -0700612 name string
613 path android.Path
614 target android.Target
615 coverageFile android.OptionalPath
Colin Crossa4f08812018-10-02 22:03:40 -0700616}
617
Colin Cross0ea8ba82019-06-06 14:33:29 -0700618func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800619 return j.properties.Instrument && ctx.Config().IsEnvTrue("EMMA_INSTRUMENT")
620}
621
Colin Cross0ea8ba82019-06-06 14:33:29 -0700622func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800623 return j.shouldInstrument(ctx) &&
624 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
625 ctx.Config().UnbundledBuild())
626}
627
Jiyong Park6a927c42020-01-21 02:03:43 +0900628func (j *Module) sdkVersion() sdkSpec {
629 return sdkSpecFrom(String(j.deviceProperties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -0700630}
631
Paul Duffine25c6442019-10-11 13:50:28 +0100632func (j *Module) systemModules() string {
633 return proptools.String(j.deviceProperties.System_modules)
634}
635
Jiyong Park6a927c42020-01-21 02:03:43 +0900636func (j *Module) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -0700637 if j.deviceProperties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900638 return sdkSpecFrom(*j.deviceProperties.Min_sdk_version)
Colin Cross83bb3162018-06-25 15:48:06 -0700639 }
640 return j.sdkVersion()
641}
642
Jiyong Park6a927c42020-01-21 02:03:43 +0900643func (j *Module) targetSdkVersion() sdkSpec {
Dan Willemsen419290a2018-10-31 15:28:47 -0700644 if j.deviceProperties.Target_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900645 return sdkSpecFrom(*j.deviceProperties.Target_sdk_version)
Dan Willemsen419290a2018-10-31 15:28:47 -0700646 }
647 return j.sdkVersion()
648}
649
Artur Satayev388d39b2020-04-27 18:53:18 +0100650func (j *Module) MinSdkVersion() string {
651 return j.minSdkVersion().version.String()
652}
653
Jiyong Parkb02bb402019-12-03 00:43:57 +0900654func (j *Module) AvailableFor(what string) bool {
655 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
656 // Exception: for hostdex: true libraries, the platform variant is created
657 // even if it's not marked as available to platform. In that case, the platform
658 // variant is used only for the hostdex and not installed to the device.
659 return true
660 }
661 return j.ApexModuleBase.AvailableFor(what)
662}
663
Colin Crossbe1da472017-07-07 15:59:46 -0700664func (j *Module) deps(ctx android.BottomUpMutatorContext) {
Colin Cross1369cdb2017-09-29 17:58:17 -0700665 if ctx.Device() {
Paul Duffin250e6192019-06-07 10:44:37 +0100666 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross6d8d8c62019-10-28 15:10:03 -0700667 if sdkDep.useDefaultLibs {
668 ctx.AddVariationDependencies(nil, bootClasspathTag, config.DefaultBootclasspathLibraries...)
669 ctx.AddVariationDependencies(nil, systemModulesTag, config.DefaultSystemModules)
670 if sdkDep.hasFrameworkLibs() {
671 ctx.AddVariationDependencies(nil, libTag, config.DefaultLibraries...)
Colin Crossbe1da472017-07-07 15:59:46 -0700672 }
Colin Cross6d8d8c62019-10-28 15:10:03 -0700673 } else if sdkDep.useModule {
Colin Cross6cef4812019-10-17 14:23:50 -0700674 ctx.AddVariationDependencies(nil, bootClasspathTag, sdkDep.bootclasspath...)
Colin Cross6cef4812019-10-17 14:23:50 -0700675 ctx.AddVariationDependencies(nil, java9LibTag, sdkDep.java9Classpath...)
Colin Cross6d8d8c62019-10-28 15:10:03 -0700676 if j.deviceProperties.EffectiveOptimizeEnabled() && sdkDep.hasStandardLibs() {
677 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultBootclasspathLibraries...)
678 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultLibraries...)
679 }
Colin Cross2fe66872015-03-30 17:20:39 -0700680 }
Colin Crossdb224752020-05-14 18:05:32 -0700681 if sdkDep.systemModules != "" {
682 ctx.AddVariationDependencies(nil, systemModulesTag, sdkDep.systemModules)
683 }
Colin Cross6d8d8c62019-10-28 15:10:03 -0700684
Nan Zhangb2b33de2018-02-23 11:18:47 -0800685 if ctx.ModuleName() == "android_stubs_current" ||
686 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -0700687 ctx.ModuleName() == "android_test_stubs_current" {
Colin Cross42d48b72018-08-29 14:10:52 -0700688 ctx.AddVariationDependencies(nil, frameworkApkTag, "framework-res")
Nan Zhangb2b33de2018-02-23 11:18:47 -0800689 }
Colin Cross2fe66872015-03-30 17:20:39 -0700690 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700691
Inseob Kimac1e9862019-12-09 18:15:47 +0900692 syspropPublicStubs := syspropPublicStubs(ctx.Config())
693
694 // rewriteSyspropLibs validates if a java module can link against platform's sysprop_library,
695 // and redirects dependency to public stub depending on the link type.
696 rewriteSyspropLibs := func(libs []string, prop string) []string {
697 // make a copy
698 ret := android.CopyOf(libs)
699
700 for idx, lib := range libs {
701 stub, ok := syspropPublicStubs[lib]
702
703 if !ok {
704 continue
705 }
706
707 linkType, _ := j.getLinkType(ctx.ModuleName())
Inseob Kimc5239512020-01-14 15:36:21 +0900708 // only platform modules can use internal props
709 if linkType != javaPlatform {
Inseob Kimac1e9862019-12-09 18:15:47 +0900710 ret[idx] = stub
Inseob Kimac1e9862019-12-09 18:15:47 +0900711 }
712 }
713
714 return ret
715 }
716
717 ctx.AddVariationDependencies(nil, libTag, rewriteSyspropLibs(j.properties.Libs, "libs")...)
718 ctx.AddVariationDependencies(nil, staticLibTag, rewriteSyspropLibs(j.properties.Static_libs, "static_libs")...)
Colin Crossa4f08812018-10-02 22:03:40 -0700719
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700720 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000721 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800722
Colin Crossfe17f6f2019-03-28 19:30:56 -0700723 android.ProtoDeps(ctx, &j.protoProperties)
Colin Cross6af17aa2017-09-20 12:59:05 -0700724 if j.hasSrcExt(".proto") {
725 protoDeps(ctx, &j.protoProperties)
726 }
Colin Cross93e85952017-08-15 13:34:18 -0700727
728 if j.hasSrcExt(".kt") {
729 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
730 // Kotlin files
Colin Cross0b03d972019-05-13 11:06:25 -0700731 ctx.AddVariationDependencies(nil, kotlinStdlibTag,
732 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8")
Colin Cross7788c122019-01-23 16:14:02 -0800733 if len(j.properties.Plugins) > 0 {
Colin Crossafbb1732019-01-17 15:42:52 -0800734 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
735 }
Colin Cross93e85952017-08-15 13:34:18 -0700736 }
Colin Cross3144dfc2018-01-03 15:06:47 -0800737
Ulya Trafimovich38dfa0f2020-01-07 16:37:02 +0000738 // Framework libraries need special handling in static coverage builds: they should not have
739 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
740 // the same jacoco classes coming from different bootclasspath jars.
741 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
742 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
743 j.properties.Instrument = true
744 }
745 } else if j.shouldInstrumentStatic(ctx) {
Colin Cross42d48b72018-08-29 14:10:52 -0700746 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
Colin Cross3144dfc2018-01-03 15:06:47 -0800747 }
Colin Cross6af17aa2017-09-20 12:59:05 -0700748}
749
750func hasSrcExt(srcs []string, ext string) bool {
751 for _, src := range srcs {
752 if filepath.Ext(src) == ext {
753 return true
754 }
755 }
756
757 return false
758}
759
760func (j *Module) hasSrcExt(ext string) bool {
761 return hasSrcExt(j.properties.Srcs, ext)
Colin Cross2fe66872015-03-30 17:20:39 -0700762}
763
Colin Cross46c9b8b2017-06-22 16:51:17 -0700764func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Colin Cross3047fa22019-04-18 10:56:44 -0700765 aidlIncludeDirs android.Paths) (string, android.Paths) {
Colin Crossc0b06f12015-04-08 13:03:43 -0700766
Colin Crossebe1a512017-11-14 13:12:14 -0800767 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
768 aidlIncludes = append(aidlIncludes,
769 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
770 aidlIncludes = append(aidlIncludes,
771 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
Colin Crossc0b06f12015-04-08 13:03:43 -0700772
Colin Cross3047fa22019-04-18 10:56:44 -0700773 var flags []string
774 var deps android.Paths
Steven Moreland667f6882018-07-26 12:55:08 -0700775
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700776 if aidlPreprocess.Valid() {
777 flags = append(flags, "-p"+aidlPreprocess.String())
Colin Cross3047fa22019-04-18 10:56:44 -0700778 deps = append(deps, aidlPreprocess.Path())
779 } else if len(aidlIncludeDirs) > 0 {
Colin Cross635c3b02016-05-18 15:37:25 -0700780 flags = append(flags, android.JoinWithPrefix(aidlIncludeDirs.Strings(), "-I"))
Colin Crossc0b06f12015-04-08 13:03:43 -0700781 }
782
Colin Cross3047fa22019-04-18 10:56:44 -0700783 if len(j.exportAidlIncludeDirs) > 0 {
784 flags = append(flags, android.JoinWithPrefix(j.exportAidlIncludeDirs.Strings(), "-I"))
785 }
786
787 if len(aidlIncludes) > 0 {
788 flags = append(flags, android.JoinWithPrefix(aidlIncludes.Strings(), "-I"))
789 }
790
Colin Cross635c3b02016-05-18 15:37:25 -0700791 flags = append(flags, "-I"+android.PathForModuleSrc(ctx).String())
Colin Cross32f38982018-02-22 11:47:25 -0800792 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Colin Crossd48633a2017-07-13 14:41:17 -0700793 flags = append(flags, "-I"+src.String())
794 }
Colin Crossc0b06f12015-04-08 13:03:43 -0700795
Martijn Coeneneab15642018-03-09 09:29:59 +0100796 if Bool(j.deviceProperties.Aidl.Generate_traces) {
797 flags = append(flags, "-t")
798 }
799
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100800 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
801 flags = append(flags, "--transaction_names")
802 }
803
Colin Cross3047fa22019-04-18 10:56:44 -0700804 return strings.Join(flags, " "), deps
Colin Crossc0b06f12015-04-08 13:03:43 -0700805}
806
Colin Cross32f676a2017-09-06 13:41:06 -0700807type deps struct {
Nan Zhang581fd212018-01-10 16:06:12 -0800808 classpath classpath
Colin Cross6cef4812019-10-17 14:23:50 -0700809 java9Classpath classpath
Nan Zhang581fd212018-01-10 16:06:12 -0800810 bootClasspath classpath
Colin Cross6a77c982018-06-19 22:43:34 -0700811 processorPath classpath
Colin Crossbe9cdb82019-01-21 21:37:16 -0800812 processorClasses []string
Colin Cross6ade34f2017-09-15 13:00:47 -0700813 staticJars android.Paths
Nan Zhanged19fc32017-10-19 13:06:22 -0700814 staticHeaderJars android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700815 staticResourceJars android.Paths
Colin Cross6ade34f2017-09-15 13:00:47 -0700816 aidlIncludeDirs android.Paths
Nan Zhangb2b33de2018-02-23 11:18:47 -0800817 srcs android.Paths
Colin Cross59149b62017-10-16 18:07:29 -0700818 srcJars android.Paths
Colin Crossb77043e2019-07-16 13:57:13 -0700819 systemModules *systemModules
Colin Cross6ade34f2017-09-15 13:00:47 -0700820 aidlPreprocess android.OptionalPath
Colin Cross93e85952017-08-15 13:34:18 -0700821 kotlinStdlib android.Paths
Colin Crossafbb1732019-01-17 15:42:52 -0800822 kotlinAnnotations android.Paths
Colin Crossbe9cdb82019-01-21 21:37:16 -0800823
824 disableTurbine bool
Colin Cross32f676a2017-09-06 13:41:06 -0700825}
Colin Cross2fe66872015-03-30 17:20:39 -0700826
Colin Cross54250902017-12-05 09:28:08 -0800827func checkProducesJars(ctx android.ModuleContext, dep android.SourceFileProducer) {
828 for _, f := range dep.Srcs() {
829 if f.Ext() != ".jar" {
830 ctx.ModuleErrorf("genrule %q must generate files ending with .jar to be used as a libs or static_libs dependency",
831 ctx.OtherModuleName(dep.(blueprint.Module)))
832 }
833 }
834}
835
Jiyong Park2d492942018-03-05 17:44:10 +0900836type linkType int
837
838const (
Jiyong Park50146e92020-01-30 18:00:15 +0900839 // TODO(jiyong) rename these for better readability. Make the allowed
840 // and disallowed link types explicit
Jiyong Park2d492942018-03-05 17:44:10 +0900841 javaCore linkType = iota
842 javaSdk
843 javaSystem
Jiyong Park50146e92020-01-30 18:00:15 +0900844 javaModule
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900845 javaSystemServer
Jiyong Park2d492942018-03-05 17:44:10 +0900846 javaPlatform
847)
848
Jeongik Cha75b83b02019-11-01 15:28:00 +0900849type linkTypeContext interface {
850 android.Module
851 getLinkType(name string) (ret linkType, stubs bool)
852}
853
854func (m *Module) getLinkType(name string) (ret linkType, stubs bool) {
Anton Hanssonac103462020-05-19 12:06:48 +0100855 switch name {
856 case "core.current.stubs", "core.platform.api.stubs", "stub-annotations",
857 "private-stub-annotations-jar", "core-lambda-stubs", "core-generated-annotation-stubs":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900858 return javaCore, true
Anton Hanssonac103462020-05-19 12:06:48 +0100859 case "android_stubs_current":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900860 return javaSdk, true
Anton Hanssonac103462020-05-19 12:06:48 +0100861 case "android_system_stubs_current":
862 return javaSystem, true
863 case "android_module_lib_stubs_current":
Jiyong Park50146e92020-01-30 18:00:15 +0900864 return javaModule, true
Anton Hanssonac103462020-05-19 12:06:48 +0100865 case "android_system_server_stubs_current":
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900866 return javaSystemServer, true
Anton Hanssonac103462020-05-19 12:06:48 +0100867 case "android_test_stubs_current":
868 return javaSystem, true
Jiyong Park2d492942018-03-05 17:44:10 +0900869 }
Anton Hanssonac103462020-05-19 12:06:48 +0100870
Anton Hansson0bd88d02020-05-25 12:20:51 +0100871 if stub, linkType := moduleStubLinkType(name); stub {
872 return linkType, true
873 }
874
Anton Hanssonac103462020-05-19 12:06:48 +0100875 ver := m.sdkVersion()
876 switch ver.kind {
877 case sdkCore:
878 return javaCore, false
879 case sdkSystem:
880 return javaSystem, false
881 case sdkPublic:
882 return javaSdk, false
883 case sdkModule:
884 return javaModule, false
885 case sdkSystemServer:
886 return javaSystemServer, false
887 case sdkPrivate, sdkNone, sdkCorePlatform, sdkTest:
888 return javaPlatform, false
889 }
890
891 if !ver.valid() {
892 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.raw))
893 }
894 return javaSdk, false
Jiyong Park2d492942018-03-05 17:44:10 +0900895}
896
Jeongik Cha75b83b02019-11-01 15:28:00 +0900897func checkLinkType(ctx android.ModuleContext, from *Module, to linkTypeContext, tag dependencyTag) {
Colin Crossf19b9bb2018-03-26 14:42:44 -0700898 if ctx.Host() {
899 return
900 }
901
Jeongik Cha75b83b02019-11-01 15:28:00 +0900902 myLinkType, stubs := from.getLinkType(ctx.ModuleName())
Jiyong Park46f78fb2018-10-20 16:33:17 +0900903 if stubs {
904 return
905 }
Jeongik Cha75b83b02019-11-01 15:28:00 +0900906 otherLinkType, _ := to.getLinkType(ctx.OtherModuleName(to))
Jiyong Park2d492942018-03-05 17:44:10 +0900907 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."
908
909 switch myLinkType {
910 case javaCore:
911 if otherLinkType != javaCore {
912 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 +0900913 ctx.OtherModuleName(to))
914 }
Jiyong Park2d492942018-03-05 17:44:10 +0900915 break
916 case javaSdk:
917 if otherLinkType != javaCore && otherLinkType != javaSdk {
918 ctx.ModuleErrorf("compiles against Android API, but dependency %q is compiling against non-public Android API."+commonMessage,
919 ctx.OtherModuleName(to))
920 }
921 break
922 case javaSystem:
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900923 if otherLinkType == javaPlatform || otherLinkType == javaModule || otherLinkType == javaSystemServer {
Jiyong Park2d492942018-03-05 17:44:10 +0900924 ctx.ModuleErrorf("compiles against system API, but dependency %q is compiling against private API."+commonMessage,
925 ctx.OtherModuleName(to))
926 }
927 break
Jiyong Park50146e92020-01-30 18:00:15 +0900928 case javaModule:
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900929 if otherLinkType == javaPlatform || otherLinkType == javaSystemServer {
Jiyong Park50146e92020-01-30 18:00:15 +0900930 ctx.ModuleErrorf("compiles against module API, but dependency %q is compiling against private API."+commonMessage,
931 ctx.OtherModuleName(to))
932 }
933 break
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900934 case javaSystemServer:
935 if otherLinkType == javaPlatform {
936 ctx.ModuleErrorf("compiles against system server API, but dependency %q is compiling against private API."+commonMessage,
937 ctx.OtherModuleName(to))
938 }
939 break
Jiyong Park2d492942018-03-05 17:44:10 +0900940 case javaPlatform:
941 // no restriction on link-type
942 break
Jiyong Park750e5572018-01-31 00:20:13 +0900943 }
944}
945
Colin Cross32f676a2017-09-06 13:41:06 -0700946func (j *Module) collectDeps(ctx android.ModuleContext) deps {
947 var deps deps
Colin Crossfc3674a2017-09-18 17:41:52 -0700948
Colin Cross300f0382018-03-06 13:11:51 -0800949 if ctx.Device() {
Colin Cross83bb3162018-06-25 15:48:06 -0700950 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross300f0382018-03-06 13:11:51 -0800951 if sdkDep.invalidVersion {
Colin Cross6cef4812019-10-17 14:23:50 -0700952 ctx.AddMissingDependencies(sdkDep.bootclasspath)
953 ctx.AddMissingDependencies(sdkDep.java9Classpath)
Colin Cross300f0382018-03-06 13:11:51 -0800954 } else if sdkDep.useFiles {
955 // sdkDep.jar is actually equivalent to turbine header.jar.
Colin Cross86a60ae2018-05-29 14:44:55 -0700956 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross3047fa22019-04-18 10:56:44 -0700957 deps.aidlPreprocess = sdkDep.aidl
958 } else {
959 deps.aidlPreprocess = sdkDep.aidl
Colin Cross300f0382018-03-06 13:11:51 -0800960 }
Colin Crossfc3674a2017-09-18 17:41:52 -0700961 }
962
Paul Duffin64e61992020-05-15 10:20:31 +0100963 // If this is a component library (stubs, etc.) for a java_sdk_library then
964 // add the name of that java_sdk_library to the exported sdk libs to make sure
965 // that, if necessary, a <uses-library> element for that java_sdk_library is
966 // added to the Android manifest.
967 j.exportedSdkLibs = append(j.exportedSdkLibs, j.OptionalImplicitSdkLibrary()...)
968
Colin Crossd11fcda2017-10-23 17:59:01 -0700969 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross2fe66872015-03-30 17:20:39 -0700970 otherName := ctx.OtherModuleName(module)
Colin Crossec7a0422017-07-07 14:47:12 -0700971 tag := ctx.OtherModuleDependencyTag(module)
972
Colin Crossa4f08812018-10-02 22:03:40 -0700973 if _, ok := tag.(*jniDependencyTag); ok {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700974 // Handled by AndroidApp.collectAppDeps
975 return
976 }
977 if tag == certificateTag {
978 // Handled by AndroidApp.collectAppDeps
Colin Crossa4f08812018-10-02 22:03:40 -0700979 return
980 }
Artur Satayeve5ac15a2020-04-08 19:09:30 +0100981
Colin Cross54250902017-12-05 09:28:08 -0800982 switch dep := module.(type) {
Colin Cross897d2ed2019-02-11 14:03:51 -0800983 case SdkLibraryDependency:
984 switch tag {
985 case libTag:
986 deps.classpath = append(deps.classpath, dep.SdkHeaderJars(ctx, j.sdkVersion())...)
987 // names of sdk libs that are directly depended are exported
Paul Duffin64e61992020-05-15 10:20:31 +0100988 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.OptionalImplicitSdkLibrary()...)
Colin Cross79c7c262019-04-17 11:11:46 -0700989 case staticLibTag:
Colin Cross897d2ed2019-02-11 14:03:51 -0800990 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
991 }
Colin Cross54250902017-12-05 09:28:08 -0800992 case Dependency:
993 switch tag {
994 case bootClasspathTag:
995 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars()...)
Colin Cross4b964c02018-10-15 16:18:06 -0700996 case libTag, instrumentationForTag:
Colin Cross54250902017-12-05 09:28:08 -0800997 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900998 // sdk lib names from dependencies are re-exported
999 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -07001000 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Artur Satayev9cf46692019-11-26 18:08:34 +00001001 pluginJars, pluginClasses := dep.ExportedPlugins()
1002 addPlugins(&deps, pluginJars, pluginClasses...)
Colin Cross6cef4812019-10-17 14:23:50 -07001003 case java9LibTag:
1004 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars()...)
Colin Cross54250902017-12-05 09:28:08 -08001005 case staticLibTag:
1006 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
1007 deps.staticJars = append(deps.staticJars, dep.ImplementationJars()...)
1008 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars()...)
Colin Cross331a1212018-08-15 20:40:52 -07001009 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +09001010 // sdk lib names from dependencies are re-exported
1011 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -07001012 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Artur Satayev9cf46692019-11-26 18:08:34 +00001013 pluginJars, pluginClasses := dep.ExportedPlugins()
1014 addPlugins(&deps, pluginJars, pluginClasses...)
Colin Crossbe9cdb82019-01-21 21:37:16 -08001015 case pluginTag:
1016 if plugin, ok := dep.(*Plugin); ok {
Colin Crossbe9cdb82019-01-21 21:37:16 -08001017 if plugin.pluginProperties.Processor_class != nil {
Artur Satayev9cf46692019-11-26 18:08:34 +00001018 addPlugins(&deps, plugin.ImplementationAndResourcesJars(), *plugin.pluginProperties.Processor_class)
1019 } else {
1020 addPlugins(&deps, plugin.ImplementationAndResourcesJars())
Colin Crossbe9cdb82019-01-21 21:37:16 -08001021 }
1022 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
1023 } else {
1024 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
1025 }
Artur Satayev9cf46692019-11-26 18:08:34 +00001026 case exportedPluginTag:
1027 if plugin, ok := dep.(*Plugin); ok {
1028 if plugin.pluginProperties.Generates_api != nil && *plugin.pluginProperties.Generates_api {
1029 ctx.PropertyErrorf("exported_plugins", "Cannot export plugins with generates_api = true, found %v", otherName)
1030 }
1031 j.exportedPluginJars = append(j.exportedPluginJars, plugin.ImplementationAndResourcesJars()...)
1032 if plugin.pluginProperties.Processor_class != nil {
1033 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
1034 }
1035 } else {
1036 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
1037 }
Nan Zhangb2b33de2018-02-23 11:18:47 -08001038 case frameworkApkTag:
1039 if ctx.ModuleName() == "android_stubs_current" ||
1040 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -07001041 ctx.ModuleName() == "android_test_stubs_current" {
Nan Zhangb2b33de2018-02-23 11:18:47 -08001042 // framework stubs.jar need to depend on framework-res.apk, in order to pull the
1043 // resource files out of there for aapt.
1044 //
1045 // Normally the package rule runs aapt, which includes the resource,
1046 // but we're not running that in our package rule so just copy in the
1047 // resource files here.
Colin Cross331a1212018-08-15 20:40:52 -07001048 deps.staticResourceJars = append(deps.staticResourceJars, dep.(*AndroidApp).exportPackage)
Nan Zhangb2b33de2018-02-23 11:18:47 -08001049 }
Colin Cross54250902017-12-05 09:28:08 -08001050 case kotlinStdlibTag:
Colin Cross0b03d972019-05-13 11:06:25 -07001051 deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars()...)
Colin Crossafbb1732019-01-17 15:42:52 -08001052 case kotlinAnnotationsTag:
1053 deps.kotlinAnnotations = dep.HeaderJars()
Colin Cross54250902017-12-05 09:28:08 -08001054 }
1055
Colin Cross54250902017-12-05 09:28:08 -08001056 case android.SourceFileProducer:
1057 switch tag {
1058 case libTag:
1059 checkProducesJars(ctx, dep)
1060 deps.classpath = append(deps.classpath, dep.Srcs()...)
1061 case staticLibTag:
1062 checkProducesJars(ctx, dep)
1063 deps.classpath = append(deps.classpath, dep.Srcs()...)
1064 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
1065 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Cross54250902017-12-05 09:28:08 -08001066 }
1067 default:
Colin Crossec7a0422017-07-07 14:47:12 -07001068 switch tag {
Paul Duffin68289b02019-09-20 13:50:52 +01001069 case bootClasspathTag:
1070 // If a system modules dependency has been added to the bootclasspath
1071 // then add its libs to the bootclasspath.
Paul Duffin83a2d962019-11-19 19:44:10 +00001072 sm := module.(SystemModulesProvider)
1073 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars()...)
Paul Duffin68289b02019-09-20 13:50:52 +01001074
Colin Cross1369cdb2017-09-29 17:58:17 -07001075 case systemModulesTag:
1076 if deps.systemModules != nil {
1077 panic("Found two system module dependencies")
1078 }
Paul Duffin83a2d962019-11-19 19:44:10 +00001079 sm := module.(SystemModulesProvider)
1080 outputDir, outputDeps := sm.OutputDirAndDeps()
1081 deps.systemModules = &systemModules{outputDir, outputDeps}
Colin Cross2fe66872015-03-30 17:20:39 -07001082 }
Colin Crossec7a0422017-07-07 14:47:12 -07001083 }
Colin Cross2fe66872015-03-30 17:20:39 -07001084 })
1085
Jiyong Park1be96912018-05-28 18:02:19 +09001086 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
1087
Colin Cross32f676a2017-09-06 13:41:06 -07001088 return deps
Colin Cross2fe66872015-03-30 17:20:39 -07001089}
1090
Artur Satayev9cf46692019-11-26 18:08:34 +00001091func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
1092 deps.processorPath = append(deps.processorPath, pluginJars...)
1093 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
1094}
1095
Colin Cross1e743852019-10-28 11:37:20 -07001096func getJavaVersion(ctx android.ModuleContext, javaVersion string, sdkContext sdkContext) javaVersion {
Nan Zhang357466b2018-04-17 17:38:36 -07001097 if javaVersion != "" {
Colin Cross1e743852019-10-28 11:37:20 -07001098 return normalizeJavaVersion(ctx, javaVersion)
Colin Crossdb224752020-05-14 18:05:32 -07001099 } else if ctx.Device() {
1100 return sdkContext.sdkVersion().defaultJavaLanguageVersion(ctx)
Nan Zhang357466b2018-04-17 17:38:36 -07001101 } else {
Colin Cross1e743852019-10-28 11:37:20 -07001102 return JAVA_VERSION_9
Nan Zhang357466b2018-04-17 17:38:36 -07001103 }
Nan Zhang357466b2018-04-17 17:38:36 -07001104}
1105
Colin Cross1e743852019-10-28 11:37:20 -07001106type javaVersion int
1107
1108const (
1109 JAVA_VERSION_UNSUPPORTED = 0
1110 JAVA_VERSION_6 = 6
1111 JAVA_VERSION_7 = 7
1112 JAVA_VERSION_8 = 8
1113 JAVA_VERSION_9 = 9
1114)
1115
1116func (v javaVersion) String() string {
1117 switch v {
1118 case JAVA_VERSION_6:
1119 return "1.6"
1120 case JAVA_VERSION_7:
1121 return "1.7"
1122 case JAVA_VERSION_8:
1123 return "1.8"
1124 case JAVA_VERSION_9:
1125 return "1.9"
1126 default:
1127 return "unsupported"
1128 }
1129}
1130
1131// Returns true if javac targeting this version uses system modules instead of a bootclasspath.
1132func (v javaVersion) usesJavaModules() bool {
1133 return v >= 9
1134}
1135
1136func normalizeJavaVersion(ctx android.BaseModuleContext, javaVersion string) javaVersion {
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001137 switch javaVersion {
1138 case "1.6", "6":
Colin Cross1e743852019-10-28 11:37:20 -07001139 return JAVA_VERSION_6
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001140 case "1.7", "7":
Colin Cross1e743852019-10-28 11:37:20 -07001141 return JAVA_VERSION_7
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001142 case "1.8", "8":
Colin Cross1e743852019-10-28 11:37:20 -07001143 return JAVA_VERSION_8
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001144 case "1.9", "9":
Colin Cross1e743852019-10-28 11:37:20 -07001145 return JAVA_VERSION_9
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001146 case "10", "11":
1147 ctx.PropertyErrorf("java_version", "Java language levels above 9 are not supported")
Colin Cross1e743852019-10-28 11:37:20 -07001148 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001149 default:
1150 ctx.PropertyErrorf("java_version", "Unrecognized Java language level")
Colin Cross1e743852019-10-28 11:37:20 -07001151 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001152 }
1153}
1154
Nan Zhanged19fc32017-10-19 13:06:22 -07001155func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
Colin Crossc0b06f12015-04-08 13:03:43 -07001156
Colin Crossf03c82b2015-04-13 13:53:40 -07001157 var flags javaBuilderFlags
1158
Tobias Thierer06dd04f2018-09-11 16:21:05 +01001159 // javaVersion flag.
1160 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), sdkContext(j))
1161
Nan Zhanged19fc32017-10-19 13:06:22 -07001162 // javac flags.
Colin Crossf03c82b2015-04-13 13:53:40 -07001163 javacFlags := j.properties.Javacflags
Colin Cross1e743852019-10-28 11:37:20 -07001164 if flags.javaVersion.usesJavaModules() {
Colin Cross1369cdb2017-09-29 17:58:17 -07001165 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Nan Zhanged19fc32017-10-19 13:06:22 -07001166 }
Colin Cross6510f912017-11-29 00:27:14 -08001167 if ctx.Config().MinimizeJavaDebugInfo() {
Colin Cross126a25c2017-10-31 13:55:34 -07001168 // Override the -g flag passed globally to remove local variable debug info to reduce
1169 // disk and memory usage.
1170 javacFlags = append(javacFlags, "-g:source,lines")
1171 }
Colin Crossc228a702019-11-06 16:18:05 -08001172 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
Colin Cross64162712017-08-08 13:17:59 -07001173
Colin Cross66548102018-06-19 22:47:35 -07001174 if ctx.Config().RunErrorProne() {
1175 if config.ErrorProneClasspath == nil {
1176 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1177 }
1178
1179 errorProneFlags := []string{
1180 "-Xplugin:ErrorProne",
1181 "${config.ErrorProneChecks}",
1182 }
1183 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1184
1185 flags.errorProneExtraJavacFlags = "${config.ErrorProneFlags} " +
1186 "'" + strings.Join(errorProneFlags, " ") + "'"
1187 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
Andreas Gampef3e5b552018-01-22 21:27:21 -08001188 }
1189
Nan Zhanged19fc32017-10-19 13:06:22 -07001190 // classpath
Nan Zhang581fd212018-01-10 16:06:12 -08001191 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1192 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross6cef4812019-10-17 14:23:50 -07001193 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
Colin Cross6a77c982018-06-19 22:43:34 -07001194 flags.processorPath = append(flags.processorPath, deps.processorPath...)
Colin Cross7fdd2b72018-01-02 18:14:25 -08001195
Colin Crossd99540b2020-04-22 11:44:34 -07001196 flags.processors = append(flags.processors, deps.processorClasses...)
1197 flags.processors = android.FirstUniqueStrings(flags.processors)
Colin Crossbe9cdb82019-01-21 21:37:16 -08001198
Colin Cross1e743852019-10-28 11:37:20 -07001199 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
1200 decodeSdkDep(ctx, sdkContext(j)).hasStandardLibs() {
Colin Cross7fdd2b72018-01-02 18:14:25 -08001201 // Give host-side tools a version of OpenJDK's standard libraries
1202 // close to what they're targeting. As of Dec 2017, AOSP is only
1203 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1204 //
1205 // When building with OpenJDK 8, the following should have no
1206 // effect since those jars would be available by default.
1207 //
1208 // When building with OpenJDK 9 but targeting a version < 1.8,
1209 // putting them on the bootclasspath means that:
1210 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1211 // b) references to existing APIs are not reinterpreted in an
1212 // OpenJDK 9-specific way, eg. calls to subclasses of
1213 // java.nio.Buffer as in http://b/70862583
1214 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1215 flags.bootClasspath = append(flags.bootClasspath,
1216 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1217 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
Nan Zhang5f8cb422018-02-06 10:34:32 -08001218 if Bool(j.properties.Use_tools_jar) {
1219 flags.bootClasspath = append(flags.bootClasspath,
1220 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1221 }
Colin Cross7fdd2b72018-01-02 18:14:25 -08001222 }
1223
Colin Cross1e743852019-10-28 11:37:20 -07001224 if j.properties.Patch_module != nil && flags.javaVersion.usesJavaModules() {
Jaewoong Jung38e4fb22018-12-12 09:01:34 -08001225 // Manually specify build directory in case it is not under the repo root.
1226 // (javac doesn't seem to expand into symbolc links when searching for patch-module targets, so
1227 // just adding a symlink under the root doesn't help.)
1228 patchPaths := ".:" + ctx.Config().BuildDir()
1229 classPath := flags.classpath.FormJavaClassPath("")
1230 if classPath != "" {
1231 patchPaths += ":" + classPath
1232 }
1233 javacFlags = append(javacFlags, "--patch-module="+String(j.properties.Patch_module)+"="+patchPaths)
Colin Cross81440082018-08-15 20:21:55 -07001234 }
1235
Nan Zhanged19fc32017-10-19 13:06:22 -07001236 // systemModules
Colin Crossb77043e2019-07-16 13:57:13 -07001237 flags.systemModules = deps.systemModules
Colin Cross1369cdb2017-09-29 17:58:17 -07001238
Nan Zhanged19fc32017-10-19 13:06:22 -07001239 // aidl flags.
Colin Cross3047fa22019-04-18 10:56:44 -07001240 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs)
Colin Cross2fe66872015-03-30 17:20:39 -07001241
Colin Cross81440082018-08-15 20:21:55 -07001242 if len(javacFlags) > 0 {
1243 // optimization.
1244 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1245 flags.javacFlags = "$javacFlags"
1246 }
1247
Nan Zhanged19fc32017-10-19 13:06:22 -07001248 return flags
1249}
Colin Crossc0b06f12015-04-08 13:03:43 -07001250
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001251func (j *Module) compile(ctx android.ModuleContext, aaptSrcJar android.Path) {
Colin Crossebe1a512017-11-14 13:12:14 -08001252 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
Nan Zhanged19fc32017-10-19 13:06:22 -07001253
1254 deps := j.collectDeps(ctx)
1255 flags := j.collectBuilderFlags(ctx, deps)
1256
Colin Cross1e743852019-10-28 11:37:20 -07001257 if flags.javaVersion.usesJavaModules() {
Nan Zhanged19fc32017-10-19 13:06:22 -07001258 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
1259 }
Colin Cross8a497952019-03-05 22:25:09 -08001260 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Colin Cross6af17aa2017-09-20 12:59:05 -07001261 if hasSrcExt(srcFiles.Strings(), ".proto") {
Colin Cross0f2ee152017-12-14 15:22:43 -08001262 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
Colin Cross6af17aa2017-09-20 12:59:05 -07001263 }
1264
Colin Crossaf050172017-11-15 23:01:59 -08001265 srcFiles = j.genSources(ctx, srcFiles, flags)
1266
1267 srcJars := srcFiles.FilterByExt(".srcjar")
Colin Cross59149b62017-10-16 18:07:29 -07001268 srcJars = append(srcJars, deps.srcJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001269 if aaptSrcJar != nil {
1270 srcJars = append(srcJars, aaptSrcJar)
1271 }
Colin Crossb7a63242015-04-16 14:09:14 -07001272
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001273 if j.properties.Jarjar_rules != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001274 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001275 }
1276
Colin Cross1ee23172017-10-18 14:44:18 -07001277 jarName := ctx.ModuleName() + ".jar"
1278
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001279 javaSrcFiles := srcFiles.FilterByExt(".java")
1280 var uniqueSrcFiles android.Paths
1281 set := make(map[string]bool)
1282 for _, v := range javaSrcFiles {
1283 if _, found := set[v.String()]; !found {
1284 set[v.String()] = true
1285 uniqueSrcFiles = append(uniqueSrcFiles, v)
1286 }
1287 }
1288
patricktu242faad2019-09-24 15:41:30 +08001289 // Collect .java files for AIDEGen
1290 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1291
Colin Cross55f63ea2018-08-27 12:37:09 -07001292 var kotlinJars android.Paths
1293
Colin Cross93e85952017-08-15 13:34:18 -07001294 if srcFiles.HasExt(".kt") {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001295 // user defined kotlin flags.
1296 kotlincFlags := j.properties.Kotlincflags
1297 CheckKotlincFlags(ctx, kotlincFlags)
1298
Colin Cross93e85952017-08-15 13:34:18 -07001299 // If there are kotlin files, compile them first but pass all the kotlin and java files
1300 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1301 // won't emit any classes for them.
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001302 kotlincFlags = append(kotlincFlags, "-no-stdlib")
Colin Cross93e85952017-08-15 13:34:18 -07001303 if ctx.Device() {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001304 kotlincFlags = append(kotlincFlags, "-no-jdk")
1305 }
1306 if len(kotlincFlags) > 0 {
1307 // optimization.
1308 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1309 flags.kotlincFlags += "$kotlincFlags"
Colin Cross93e85952017-08-15 13:34:18 -07001310 }
1311
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001312 var kotlinSrcFiles android.Paths
1313 kotlinSrcFiles = append(kotlinSrcFiles, uniqueSrcFiles...)
1314 kotlinSrcFiles = append(kotlinSrcFiles, srcFiles.FilterByExt(".kt")...)
1315
patricktu242faad2019-09-24 15:41:30 +08001316 // Collect .kt files for AIDEGen
1317 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, srcFiles.FilterByExt(".kt").Strings()...)
1318
Colin Crossafbb1732019-01-17 15:42:52 -08001319 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1320 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1321
1322 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1323 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1324
1325 if len(flags.processorPath) > 0 {
1326 // Use kapt for annotation processing
1327 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1328 kotlinKapt(ctx, kaptSrcJar, kotlinSrcFiles, srcJars, flags)
1329 srcJars = append(srcJars, kaptSrcJar)
1330 // Disable annotation processing in javac, it's already been handled by kapt
1331 flags.processorPath = nil
Colin Crossd99540b2020-04-22 11:44:34 -07001332 flags.processors = nil
Colin Crossafbb1732019-01-17 15:42:52 -08001333 }
Colin Cross93e85952017-08-15 13:34:18 -07001334
Colin Cross1ee23172017-10-18 14:44:18 -07001335 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross21fc9bb2019-01-18 15:05:09 -08001336 kotlinCompile(ctx, kotlinJar, kotlinSrcFiles, srcJars, flags)
Colin Cross93e85952017-08-15 13:34:18 -07001337 if ctx.Failed() {
1338 return
1339 }
1340
1341 // Make javac rule depend on the kotlinc rule
1342 flags.classpath = append(flags.classpath, kotlinJar)
Przemyslaw Szczepaniak66c0c402018-03-08 13:21:55 +00001343
Colin Cross93e85952017-08-15 13:34:18 -07001344 // Jar kotlin classes into the final jar after javac
Colin Cross55f63ea2018-08-27 12:37:09 -07001345 kotlinJars = append(kotlinJars, kotlinJar)
Colin Cross9b38aef2018-08-27 15:42:25 -07001346 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
Colin Cross93e85952017-08-15 13:34:18 -07001347 }
1348
Colin Cross55f63ea2018-08-27 12:37:09 -07001349 jars := append(android.Paths(nil), kotlinJars...)
1350
Colin Cross5ab4e6d2017-11-22 16:20:45 -08001351 // Store the list of .java files that was passed to javac
1352 j.compiledJavaSrcs = uniqueSrcFiles
1353 j.compiledSrcJars = srcJars
1354
Nan Zhang61eaedb2017-11-02 13:28:15 -07001355 enable_sharding := false
Colin Crossf5a66282020-02-21 08:16:41 -08001356 var headerJarFileWithoutJarjar android.Path
Colin Crossbe9cdb82019-01-21 21:37:16 -08001357 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !deps.disableTurbine {
Nan Zhang61eaedb2017-11-02 13:28:15 -07001358 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1359 enable_sharding = true
Ashley Rosee36efcf2019-01-16 17:34:08 -05001360 // Formerly, there was a check here that prevented annotation processors
1361 // from being used when sharding was enabled, as some annotation processors
1362 // do not function correctly in sharded environments. It was removed to
1363 // allow for the use of annotation processors that do function correctly
1364 // with sharding enabled. See: b/77284273.
Nan Zhang61eaedb2017-11-02 13:28:15 -07001365 }
Colin Crossf5a66282020-02-21 08:16:41 -08001366 headerJarFileWithoutJarjar, j.headerJarFile =
1367 j.compileJavaHeader(ctx, uniqueSrcFiles, srcJars, deps, flags, jarName, kotlinJars)
Colin Crossf19b9bb2018-03-26 14:42:44 -07001368 if ctx.Failed() {
1369 return
Nan Zhanged19fc32017-10-19 13:06:22 -07001370 }
1371 }
Colin Cross8eadbf02017-10-24 17:46:00 -07001372 if len(uniqueSrcFiles) > 0 || len(srcJars) > 0 {
Colin Crossd6891432017-09-27 17:39:56 -07001373 var extraJarDeps android.Paths
Colin Cross66548102018-06-19 22:47:35 -07001374 if ctx.Config().RunErrorProne() {
Colin Crossc6bbef32017-08-14 14:16:06 -07001375 // If error-prone is enabled, add an additional rule to compile the java files into
1376 // a separate set of classes (so that they don't overwrite the normal ones and require
Colin Crossd6891432017-09-27 17:39:56 -07001377 // a rebuild when error-prone is turned off).
Colin Crossc6bbef32017-08-14 14:16:06 -07001378 // TODO(ccross): Once we always compile with javac9 we may be able to conditionally
1379 // enable error-prone without affecting the output class files.
Colin Cross1ee23172017-10-18 14:44:18 -07001380 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001381 RunErrorProne(ctx, errorprone, uniqueSrcFiles, srcJars, flags)
Colin Crossc6bbef32017-08-14 14:16:06 -07001382 extraJarDeps = append(extraJarDeps, errorprone)
1383 }
1384
Nan Zhang61eaedb2017-11-02 13:28:15 -07001385 if enable_sharding {
Colin Crossf5a66282020-02-21 08:16:41 -08001386 flags.classpath = append(flags.classpath, headerJarFileWithoutJarjar)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001387 shardSize := int(*(j.properties.Javac_shard_size))
1388 var shardSrcs []android.Paths
1389 if len(uniqueSrcFiles) > 0 {
Colin Cross0a2f7192019-09-23 14:33:09 -07001390 shardSrcs = android.ShardPaths(uniqueSrcFiles, shardSize)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001391 for idx, shardSrc := range shardSrcs {
Colin Cross3b706fd2019-09-05 16:44:18 -07001392 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1393 nil, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001394 jars = append(jars, classes)
1395 }
1396 }
1397 if len(srcJars) > 0 {
Colin Cross3b706fd2019-09-05 16:44:18 -07001398 classes := j.compileJavaClasses(ctx, jarName, len(shardSrcs),
1399 nil, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001400 jars = append(jars, classes)
1401 }
1402 } else {
Colin Cross3b706fd2019-09-05 16:44:18 -07001403 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueSrcFiles, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001404 jars = append(jars, classes)
1405 }
Colin Crossd6891432017-09-27 17:39:56 -07001406 if ctx.Failed() {
1407 return
1408 }
Colin Cross2fe66872015-03-30 17:20:39 -07001409 }
1410
Colin Cross0c4ce212019-05-03 15:28:19 -07001411 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1412
1413 var includeSrcJar android.WritablePath
1414 if Bool(j.properties.Include_srcs) {
1415 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1416 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1417 }
1418
Colin Crosscedd4762018-09-13 11:26:19 -07001419 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1420 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Colin Cross0f37af02017-09-27 17:42:05 -07001421 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
Colin Cross988708c2019-05-06 14:04:11 -07001422 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
Colin Cross0f37af02017-09-27 17:42:05 -07001423
1424 var resArgs []string
1425 var resDeps android.Paths
1426
1427 resArgs = append(resArgs, dirArgs...)
1428 resDeps = append(resDeps, dirDeps...)
1429
1430 resArgs = append(resArgs, fileArgs...)
1431 resDeps = append(resDeps, fileDeps...)
1432
Colin Cross988708c2019-05-06 14:04:11 -07001433 resArgs = append(resArgs, extraArgs...)
1434 resDeps = append(resDeps, extraDeps...)
1435
Colin Cross40a36712017-09-27 17:41:35 -07001436 if len(resArgs) > 0 {
Colin Cross1ee23172017-10-18 14:44:18 -07001437 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
Colin Crosse9a275b2017-10-16 17:09:48 -07001438 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Colin Cross331a1212018-08-15 20:40:52 -07001439 j.resourceJar = resourceJar
Colin Cross65bf4f22015-04-03 16:54:17 -07001440 if ctx.Failed() {
1441 return
1442 }
1443 }
1444
Colin Cross0c4ce212019-05-03 15:28:19 -07001445 var resourceJars android.Paths
1446 if j.resourceJar != nil {
1447 resourceJars = append(resourceJars, j.resourceJar)
1448 }
1449 if Bool(j.properties.Include_srcs) {
1450 resourceJars = append(resourceJars, includeSrcJar)
1451 }
1452 resourceJars = append(resourceJars, deps.staticResourceJars...)
Colin Cross331a1212018-08-15 20:40:52 -07001453
Colin Cross0c4ce212019-05-03 15:28:19 -07001454 if len(resourceJars) > 1 {
Colin Cross331a1212018-08-15 20:40:52 -07001455 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
Colin Cross0c4ce212019-05-03 15:28:19 -07001456 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
Colin Cross331a1212018-08-15 20:40:52 -07001457 false, nil, nil)
1458 j.resourceJar = combinedJar
Colin Cross0c4ce212019-05-03 15:28:19 -07001459 } else if len(resourceJars) == 1 {
1460 j.resourceJar = resourceJars[0]
Colin Cross331a1212018-08-15 20:40:52 -07001461 }
1462
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001463 if len(deps.staticJars) > 0 {
1464 jars = append(jars, deps.staticJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001465 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001466
Colin Cross094054a2018-10-17 15:10:48 -07001467 manifest := j.overrideManifest
1468 if !manifest.Valid() && j.properties.Manifest != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001469 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Colin Cross366938f2017-12-11 16:29:02 -08001470 }
Colin Cross635acc92017-09-12 22:50:46 -07001471
Colin Cross8a497952019-03-05 22:25:09 -08001472 services := android.PathsForModuleSrc(ctx, j.properties.Services)
Alex Light7f004a72019-02-21 13:27:37 -08001473 if len(services) > 0 {
1474 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1475 var zipargs []string
1476 for _, file := range services {
1477 serviceFile := file.String()
1478 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1479 }
Kousik Kumarc05da0a2020-05-20 11:27:16 -07001480 rule := zip
1481 args := map[string]string{
1482 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1483 }
1484 if ctx.Config().IsEnvTrue("RBE_ZIP") {
1485 rule = zipRE
1486 args["implicits"] = strings.Join(services.Strings(), ",")
1487 }
Alex Light7f004a72019-02-21 13:27:37 -08001488 ctx.Build(pctx, android.BuildParams{
Kousik Kumarc05da0a2020-05-20 11:27:16 -07001489 Rule: rule,
Alex Light7f004a72019-02-21 13:27:37 -08001490 Output: servicesJar,
1491 Implicits: services,
Kousik Kumarc05da0a2020-05-20 11:27:16 -07001492 Args: args,
Alex Light7f004a72019-02-21 13:27:37 -08001493 })
1494 jars = append(jars, servicesJar)
1495 }
1496
Colin Cross0a6e0072017-08-30 14:24:55 -07001497 // Combine the classes built from sources, any manifests, and any static libraries into
Nan Zhanged19fc32017-10-19 13:06:22 -07001498 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross3063b782018-08-15 11:19:12 -07001499 var outputFile android.ModuleOutPath
Colin Crosse9a275b2017-10-16 17:09:48 -07001500
1501 if len(jars) == 1 && !manifest.Valid() {
Colin Cross3063b782018-08-15 11:19:12 -07001502 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok {
1503 // Optimization: skip the combine step if there is nothing to do
1504 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1505 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1506 // any if len(jars) == 1.
1507 outputFile = moduleOutPath
1508 } else {
1509 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1510 ctx.Build(pctx, android.BuildParams{
1511 Rule: android.Cp,
1512 Input: jars[0],
1513 Output: combinedJar,
1514 })
1515 outputFile = combinedJar
1516 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001517 } else {
Colin Cross1ee23172017-10-18 14:44:18 -07001518 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001519 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
Colin Cross9b38aef2018-08-27 15:42:25 -07001520 false, nil, nil)
Colin Crosse9a275b2017-10-16 17:09:48 -07001521 outputFile = combinedJar
1522 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001523
Colin Cross331a1212018-08-15 20:40:52 -07001524 // jarjar implementation jar if necessary
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001525 if j.expandJarjarRules != nil {
Colin Cross8649b262017-09-27 18:03:17 -07001526 // Transform classes.jar into classes-jarjar.jar
Colin Cross1ee23172017-10-18 14:44:18 -07001527 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001528 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
Colin Crosse9a275b2017-10-16 17:09:48 -07001529 outputFile = jarjarFile
Colin Cross331a1212018-08-15 20:40:52 -07001530
1531 // jarjar resource jar if necessary
1532 if j.resourceJar != nil {
1533 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001534 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
Colin Cross331a1212018-08-15 20:40:52 -07001535 j.resourceJar = resourceJarJarFile
1536 }
1537
Colin Cross0a6e0072017-08-30 14:24:55 -07001538 if ctx.Failed() {
1539 return
1540 }
1541 }
Vladimir Marko0975ee02019-04-02 10:29:55 +01001542
1543 // Check package restrictions if necessary.
1544 if len(j.properties.Permitted_packages) > 0 {
Tej Singh83839722020-06-03 18:45:54 +00001545 // Check packages and copy to package-checked file.
1546 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
1547 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
1548 j.additionalCheckedModules = append(j.additionalCheckedModules, pkgckFile)
Vladimir Marko0975ee02019-04-02 10:29:55 +01001549
1550 if ctx.Failed() {
1551 return
1552 }
1553 }
1554
Nan Zhanged19fc32017-10-19 13:06:22 -07001555 j.implementationJarFile = outputFile
1556 if j.headerJarFile == nil {
1557 j.headerJarFile = j.implementationJarFile
1558 }
Colin Cross2fe66872015-03-30 17:20:39 -07001559
Jiyong Park28826602020-02-21 16:04:53 +09001560 // Force enable the instrumentation for java code that is built for APEXes ...
1561 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
1562 // doesn't make sense)
1563 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
1564 if android.DirectlyInAnyApex(ctx, ctx.ModuleName()) && !isJacocoAgent && !j.IsForPlatform() {
Jiyong Park81aaa0c2020-02-18 12:50:44 +00001565 j.properties.Instrument = true
1566 }
1567
Colin Cross3144dfc2018-01-03 15:06:47 -08001568 if j.shouldInstrument(ctx) {
Colin Crosscb933592017-11-22 13:49:43 -08001569 outputFile = j.instrument(ctx, flags, outputFile, jarName)
1570 }
1571
Colin Cross331a1212018-08-15 20:40:52 -07001572 // merge implementation jar with resources if necessary
1573 implementationAndResourcesJar := outputFile
1574 if j.resourceJar != nil {
Colin Cross08a409d2019-04-29 10:22:44 -07001575 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Colin Cross331a1212018-08-15 20:40:52 -07001576 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Colin Cross08a409d2019-04-29 10:22:44 -07001577 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
Colin Cross331a1212018-08-15 20:40:52 -07001578 false, nil, nil)
1579 implementationAndResourcesJar = combinedJar
1580 }
1581
1582 j.implementationAndResourcesJar = implementationAndResourcesJar
1583
Jiyong Park6b21c7d2020-02-11 09:16:01 +09001584 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
1585 if android.DirectlyInAnyApex(ctx, ctx.ModuleName()) && !j.IsForPlatform() {
1586 if j.deviceProperties.Compile_dex == nil {
1587 j.deviceProperties.Compile_dex = proptools.BoolPtr(true)
1588 }
1589 if j.deviceProperties.Hostdex == nil {
1590 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1591 }
1592 }
1593
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001594 if ctx.Device() && j.hasCode(ctx) &&
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001595 (Bool(j.properties.Installable) || Bool(j.deviceProperties.Compile_dex)) {
Colin Cross8faf8fc2019-01-16 15:15:52 -08001596 // Dex compilation
Colin Cross3063b782018-08-15 11:19:12 -07001597 var dexOutputFile android.ModuleOutPath
David Brazdil17ef5632018-06-27 10:27:45 +01001598 dexOutputFile = j.compileDex(ctx, flags, outputFile, jarName)
Colin Cross2fe66872015-03-30 17:20:39 -07001599 if ctx.Failed() {
1600 return
1601 }
Colin Cross331a1212018-08-15 20:40:52 -07001602
Jiyong Park09cb6292019-07-15 15:29:23 +09001603 // Hidden API CSV generation and dex encoding
1604 dexOutputFile = j.hiddenAPI.hiddenAPI(ctx, dexOutputFile, j.implementationJarFile,
David Srbecky98c71222020-05-20 22:20:28 +01001605 proptools.Bool(j.deviceProperties.Uncompress_dex))
Colin Cross8faf8fc2019-01-16 15:15:52 -08001606
Colin Cross331a1212018-08-15 20:40:52 -07001607 // merge dex jar with resources if necessary
1608 if j.resourceJar != nil {
1609 jars := android.Paths{dexOutputFile, j.resourceJar}
1610 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
1611 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1612 false, nil, nil)
David Srbecky98c71222020-05-20 22:20:28 +01001613 if *j.deviceProperties.Uncompress_dex {
Nicolas Geoffrayf3438722019-01-23 15:57:21 +00001614 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
1615 TransformZipAlign(ctx, combinedAlignedJar, combinedJar)
1616 dexOutputFile = combinedAlignedJar
1617 } else {
1618 dexOutputFile = combinedJar
1619 }
Colin Cross331a1212018-08-15 20:40:52 -07001620 }
1621
1622 j.dexJarFile = dexOutputFile
1623
Colin Cross8faf8fc2019-01-16 15:15:52 -08001624 // Dexpreopting
Colin Cross43f08db2018-11-12 10:13:39 -08001625 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
1626
1627 j.maybeStrippedDexJarFile = dexOutputFile
1628
Colin Cross3063b782018-08-15 11:19:12 -07001629 outputFile = dexOutputFile
Colin Cross43f08db2018-11-12 10:13:39 -08001630
1631 if ctx.Failed() {
1632 return
1633 }
Colin Cross331a1212018-08-15 20:40:52 -07001634 } else {
1635 outputFile = implementationAndResourcesJar
Colin Cross2fe66872015-03-30 17:20:39 -07001636 }
Colin Cross331a1212018-08-15 20:40:52 -07001637
Colin Crossb7a63242015-04-16 14:09:14 -07001638 ctx.CheckbuildFile(outputFile)
Colin Cross3063b782018-08-15 11:19:12 -07001639
1640 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1641 j.outputFile = outputFile.WithoutRel()
Colin Cross2fe66872015-03-30 17:20:39 -07001642}
1643
Colin Cross3b706fd2019-09-05 16:44:18 -07001644func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
1645 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.WritablePath {
1646
1647 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
1648 if idx >= 0 {
1649 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
1650 jarName += strconv.Itoa(idx)
1651 }
1652
1653 classes := android.PathForModuleOut(ctx, "javac", jarName)
1654 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, flags, extraJarDeps)
1655
1656 if ctx.Config().EmitXrefRules() {
1657 extractionFile := android.PathForModuleOut(ctx, kzipName)
1658 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1659 j.kytheFiles = append(j.kytheFiles, extractionFile)
1660 }
1661
1662 return classes
1663}
1664
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001665// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1666// since some of these flags may be used internally.
1667func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1668 for _, flag := range flags {
1669 flag = strings.TrimSpace(flag)
1670
1671 if !strings.HasPrefix(flag, "-") {
1672 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1673 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1674 ctx.PropertyErrorf("kotlincflags",
1675 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1676 } else if inList(flag, config.KotlincIllegalFlags) {
1677 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1678 } else if flag == "-include-runtime" {
1679 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1680 } else {
1681 args := strings.Split(flag, " ")
1682 if args[0] == "-kotlin-home" {
1683 ctx.PropertyErrorf("kotlincflags",
1684 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1685 }
1686 }
1687 }
1688}
1689
Colin Cross8eadbf02017-10-24 17:46:00 -07001690func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
Colin Crossf5a66282020-02-21 08:16:41 -08001691 deps deps, flags javaBuilderFlags, jarName string,
1692 extraJars android.Paths) (headerJar, jarjarHeaderJar android.Path) {
Nan Zhanged19fc32017-10-19 13:06:22 -07001693
1694 var jars android.Paths
Colin Cross8eadbf02017-10-24 17:46:00 -07001695 if len(srcFiles) > 0 || len(srcJars) > 0 {
Nan Zhanged19fc32017-10-19 13:06:22 -07001696 // Compile java sources into turbine.jar.
1697 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1698 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1699 if ctx.Failed() {
Colin Crossf5a66282020-02-21 08:16:41 -08001700 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001701 }
1702 jars = append(jars, turbineJar)
1703 }
1704
Colin Cross55f63ea2018-08-27 12:37:09 -07001705 jars = append(jars, extraJars...)
1706
Nan Zhanged19fc32017-10-19 13:06:22 -07001707 // Combine any static header libraries into classes-header.jar. If there is only
1708 // one input jar this step will be skipped.
Nan Zhanged19fc32017-10-19 13:06:22 -07001709 jars = append(jars, deps.staticHeaderJars...)
1710
Colin Cross5c6ecc12017-10-23 18:12:27 -07001711 // we cannot skip the combine step for now if there is only one jar
1712 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1713 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001714 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
Colin Cross6c6e6cd2019-05-08 14:30:12 -07001715 false, nil, []string{"META-INF/TRANSITIVE"})
Colin Cross5c6ecc12017-10-23 18:12:27 -07001716 headerJar = combinedJar
Colin Crossf5a66282020-02-21 08:16:41 -08001717 jarjarHeaderJar = combinedJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001718
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001719 if j.expandJarjarRules != nil {
Nan Zhanged19fc32017-10-19 13:06:22 -07001720 // Transform classes.jar into classes-jarjar.jar
1721 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001722 TransformJarJar(ctx, jarjarFile, headerJar, j.expandJarjarRules)
Colin Crossf5a66282020-02-21 08:16:41 -08001723 jarjarHeaderJar = jarjarFile
Nan Zhanged19fc32017-10-19 13:06:22 -07001724 if ctx.Failed() {
Colin Crossf5a66282020-02-21 08:16:41 -08001725 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001726 }
1727 }
1728
Colin Crossf5a66282020-02-21 08:16:41 -08001729 return headerJar, jarjarHeaderJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001730}
1731
Colin Crosscb933592017-11-22 13:49:43 -08001732func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross3063b782018-08-15 11:19:12 -07001733 classesJar android.Path, jarName string) android.ModuleOutPath {
Colin Crosscb933592017-11-22 13:49:43 -08001734
Colin Cross7a3139e2017-12-19 13:57:50 -08001735 specs := j.jacocoModuleToZipCommand(ctx)
Colin Crosscb933592017-11-22 13:49:43 -08001736
Colin Cross84c38822018-01-03 15:59:46 -08001737 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Crosscb933592017-11-22 13:49:43 -08001738 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
1739
1740 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1741
1742 j.jacocoReportClassesFile = jacocoReportClassesFile
1743
1744 return instrumentedJar
1745}
1746
albaltai36ff7dc2018-12-25 14:35:23 +08001747var _ Dependency = (*Module)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001748
Nan Zhanged19fc32017-10-19 13:06:22 -07001749func (j *Module) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001750 if j.headerJarFile == nil {
1751 return nil
1752 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001753 return android.Paths{j.headerJarFile}
1754}
1755
1756func (j *Module) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08001757 if j.implementationJarFile == nil {
1758 return nil
1759 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001760 return android.Paths{j.implementationJarFile}
Colin Cross2fe66872015-03-30 17:20:39 -07001761}
1762
Colin Crossf24a22a2019-01-31 14:12:44 -08001763func (j *Module) DexJar() android.Path {
1764 return j.dexJarFile
1765}
1766
Colin Cross331a1212018-08-15 20:40:52 -07001767func (j *Module) ResourceJars() android.Paths {
1768 if j.resourceJar == nil {
1769 return nil
1770 }
1771 return android.Paths{j.resourceJar}
1772}
1773
1774func (j *Module) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001775 if j.implementationAndResourcesJar == nil {
1776 return nil
1777 }
Colin Cross331a1212018-08-15 20:40:52 -07001778 return android.Paths{j.implementationAndResourcesJar}
1779}
1780
Colin Cross46c9b8b2017-06-22 16:51:17 -07001781func (j *Module) AidlIncludeDirs() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001782 // exportAidlIncludeDirs is type android.Paths already
Colin Crossc0b06f12015-04-08 13:03:43 -07001783 return j.exportAidlIncludeDirs
1784}
1785
Jiyong Park1be96912018-05-28 18:02:19 +09001786func (j *Module) ExportedSdkLibs() []string {
albaltai36ff7dc2018-12-25 14:35:23 +08001787 // exportedSdkLibs is type []string
Jiyong Park1be96912018-05-28 18:02:19 +09001788 return j.exportedSdkLibs
1789}
1790
Artur Satayev9cf46692019-11-26 18:08:34 +00001791func (j *Module) ExportedPlugins() (android.Paths, []string) {
1792 return j.exportedPluginJars, j.exportedPluginClasses
1793}
1794
Colin Cross0c4ce212019-05-03 15:28:19 -07001795func (j *Module) SrcJarArgs() ([]string, android.Paths) {
1796 return j.srcJarArgs, j.srcJarDeps
1797}
1798
Colin Cross46c9b8b2017-06-22 16:51:17 -07001799var _ logtagsProducer = (*Module)(nil)
Colin Crossf05fe972015-04-10 17:45:20 -07001800
Colin Cross46c9b8b2017-06-22 16:51:17 -07001801func (j *Module) logtags() android.Paths {
Colin Crossf05fe972015-04-10 17:45:20 -07001802 return j.logtagsSrcs
1803}
1804
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001805// Collect information for opening IDE project files in java/jdeps.go.
1806func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
1807 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
1808 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
patricktu18c82ff2019-05-10 15:48:50 +08001809 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001810 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001811 if j.expandJarjarRules != nil {
1812 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001813 }
1814}
1815
1816func (j *Module) CompilerDeps() []string {
1817 jdeps := []string{}
1818 jdeps = append(jdeps, j.properties.Libs...)
1819 jdeps = append(jdeps, j.properties.Static_libs...)
1820 return jdeps
1821}
1822
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001823func (j *Module) hasCode(ctx android.ModuleContext) bool {
1824 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
1825 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
1826}
1827
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001828func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffinc8f2f182020-05-17 08:34:50 +01001829 return j.depIsInSameApex(ctx, dep)
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001830}
1831
Jiyong Park0b238752019-10-29 11:23:10 +09001832func (j *Module) Stem() string {
1833 return proptools.StringDefault(j.deviceProperties.Stem, j.Name())
1834}
1835
Jiyong Park618922e2020-01-08 13:35:43 +09001836func (j *Module) JacocoReportClassesFile() android.Path {
1837 return j.jacocoReportClassesFile
1838}
1839
Martin Stjernholm6d415272020-01-31 17:10:36 +00001840func (j *Module) IsInstallable() bool {
1841 return Bool(j.properties.Installable)
1842}
1843
Colin Cross2fe66872015-03-30 17:20:39 -07001844//
1845// Java libraries (.jar file)
1846//
1847
Anton Hansson1e65f942020-03-27 19:39:48 +00001848type LibraryProperties struct {
1849 Dist struct {
1850 // The tag of the output of this module that should be output.
1851 Tag *string `android:"arch_variant"`
1852 } `android:"arch_variant"`
1853}
1854
Colin Crossf506d872017-07-19 15:53:04 -07001855type Library struct {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001856 Module
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001857
Anton Hansson1e65f942020-03-27 19:39:48 +00001858 libraryProperties LibraryProperties
1859
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001860 InstallMixin func(ctx android.ModuleContext, installPath android.Path) (extraInstallDeps android.Paths)
Colin Cross2fe66872015-03-30 17:20:39 -07001861}
1862
Paul Duffina105cf92020-05-29 11:24:51 +01001863// Provides access to the list of permitted packages from updatable boot jars.
1864type PermittedPackagesForUpdatableBootJars interface {
1865 PermittedPackagesForUpdatableBootJars() []string
1866}
1867
1868var _ PermittedPackagesForUpdatableBootJars = (*Library)(nil)
1869
1870func (j *Library) PermittedPackagesForUpdatableBootJars() []string {
1871 return j.properties.Permitted_packages
1872}
1873
Colin Cross42be7612019-02-21 18:12:14 -08001874func shouldUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter) bool {
Ulya Trafimovichf491dde2020-01-24 12:19:45 +00001875 // Store uncompressed (and aligned) any dex files from jars in APEXes.
1876 if am, ok := ctx.Module().(android.ApexModule); ok && !am.IsForPlatform() {
1877 return true
1878 }
1879
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001880 // Store uncompressed (and do not strip) dex files from boot class path jars.
1881 if inList(ctx.ModuleName(), ctx.Config().BootJars()) {
1882 return true
1883 }
1884
1885 // Store uncompressed dex files that are preopted on /system.
Colin Cross42be7612019-02-21 18:12:14 -08001886 if !dexpreopter.dexpreoptDisabled(ctx) && (ctx.Host() || !odexOnSystemOther(ctx, dexpreopter.installPath)) {
Vladimir Markoe8b00d62018-12-21 15:54:16 +00001887 return true
1888 }
Colin Cross083a2aa2019-02-06 16:37:12 -08001889 if ctx.Config().UncompressPrivAppDex() &&
1890 inList(ctx.ModuleName(), ctx.Config().ModulesLoadedByPrivilegedModules()) {
1891 return true
1892 }
1893
Colin Cross2fc72f62018-12-21 12:59:54 -08001894 return false
1895}
1896
Colin Crossf506d872017-07-19 15:53:04 -07001897func (j *Library) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayeve5ac15a2020-04-08 19:09:30 +01001898 j.checkSdkVersions(ctx)
Jiyong Park0b238752019-10-29 11:23:10 +09001899 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross43f08db2018-11-12 10:13:39 -08001900 j.dexpreopter.isSDKLibrary = j.deviceProperties.IsSDKLibrary
David Srbecky98c71222020-05-20 22:20:28 +01001901 if j.deviceProperties.Uncompress_dex == nil {
1902 // If the value was not force-set by the user, use reasonable default based on the module.
1903 j.deviceProperties.Uncompress_dex = proptools.BoolPtr(shouldUncompressDex(ctx, &j.dexpreopter))
1904 }
1905 j.dexpreopter.uncompressedDex = *j.deviceProperties.Uncompress_dex
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001906 j.compile(ctx, nil)
Colin Crossb7a63242015-04-16 14:09:14 -07001907
Jiyong Park7f7766d2019-07-25 22:02:35 +09001908 exclusivelyForApex := android.InAnyApex(ctx.ModuleName()) && !j.IsForPlatform()
1909 if (Bool(j.properties.Installable) || ctx.Host()) && !exclusivelyForApex {
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001910 var extraInstallDeps android.Paths
1911 if j.InstallMixin != nil {
1912 extraInstallDeps = j.InstallMixin(ctx, j.outputFile)
1913 }
Colin Cross2c429dc2017-08-31 16:45:16 -07001914 j.installFile = ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Parked50ca82020-05-28 23:46:55 +09001915 j.Stem()+".jar", j.outputFile, extraInstallDeps...)
Colin Cross2c429dc2017-08-31 16:45:16 -07001916 }
Anton Hansson1e65f942020-03-27 19:39:48 +00001917
1918 // Verify Dist.Tag is set to a supported output
1919 if j.libraryProperties.Dist.Tag != nil {
1920 distFiles, err := j.OutputFiles(*j.libraryProperties.Dist.Tag)
1921 if err != nil {
1922 ctx.PropertyErrorf("dist.tag", "%s", err.Error())
1923 }
1924 j.distFile = distFiles[0]
1925 }
Colin Crossb7a63242015-04-16 14:09:14 -07001926}
1927
Colin Crossf506d872017-07-19 15:53:04 -07001928func (j *Library) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001929 j.deps(ctx)
1930}
1931
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001932const (
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001933 aidlIncludeDir = "aidl"
1934 javaDir = "java"
1935 jarFileSuffix = ".jar"
1936 testConfigSuffix = "-AndroidTest.xml"
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001937)
1938
Paul Duffina0dbf432019-12-05 11:25:53 +00001939// path to the jar file of a java library. Relative to <sdk_root>/<api_dir>
Paul Duffin9b358d72020-03-02 10:16:35 +00001940func sdkSnapshotFilePathForJar(osPrefix, name string) string {
1941 return sdkSnapshotFilePathForMember(osPrefix, name, jarFileSuffix)
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001942}
1943
Paul Duffin9b358d72020-03-02 10:16:35 +00001944func sdkSnapshotFilePathForMember(osPrefix, name string, suffix string) string {
1945 return filepath.Join(javaDir, osPrefix, name+suffix)
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001946}
1947
Paul Duffin13879572019-11-28 14:31:38 +00001948type librarySdkMemberType struct {
Paul Duffin255f18e2019-12-13 11:22:16 +00001949 android.SdkMemberTypeBase
Paul Duffin2b9e3d32020-02-28 14:39:53 +00001950
1951 // Function to retrieve the appropriate output jar (implementation or header) from
1952 // the library.
1953 jarToExportGetter func(j *Library) android.Path
Paul Duffin13879572019-11-28 14:31:38 +00001954}
1955
1956func (mt *librarySdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
1957 mctx.AddVariationDependencies(nil, dependencyTag, names...)
1958}
1959
1960func (mt *librarySdkMemberType) IsInstance(module android.Module) bool {
1961 _, ok := module.(*Library)
1962 return ok
1963}
1964
Paul Duffin17ab8832020-03-19 16:11:18 +00001965func (mt *librarySdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
1966 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_import")
Paul Duffind76209b2020-03-02 11:33:02 +00001967}
Paul Duffina0dbf432019-12-05 11:25:53 +00001968
Paul Duffind76209b2020-03-02 11:33:02 +00001969func (mt *librarySdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
Paul Duffinc9103932020-03-17 21:04:24 +00001970 return &librarySdkMemberProperties{}
Paul Duffind76209b2020-03-02 11:33:02 +00001971}
1972
1973type librarySdkMemberProperties struct {
1974 android.SdkMemberPropertiesBase
1975
Paul Duffin08385bf2020-05-06 10:23:19 +01001976 JarToExport android.Path `android:"arch_variant"`
Paul Duffinc9103932020-03-17 21:04:24 +00001977 AidlIncludeDirs android.Paths
Paul Duffind76209b2020-03-02 11:33:02 +00001978}
1979
Paul Duffin17ab8832020-03-19 16:11:18 +00001980func (p *librarySdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin13879572019-11-28 14:31:38 +00001981 j := variant.(*Library)
1982
Paul Duffinc9103932020-03-17 21:04:24 +00001983 p.JarToExport = ctx.MemberType().(*librarySdkMemberType).jarToExportGetter(j)
1984 p.AidlIncludeDirs = j.AidlIncludeDirs()
Paul Duffind76209b2020-03-02 11:33:02 +00001985}
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001986
Paul Duffin17ab8832020-03-19 16:11:18 +00001987func (p *librarySdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffinc9103932020-03-17 21:04:24 +00001988 builder := ctx.SnapshotBuilder()
Paul Duffin17ab8832020-03-19 16:11:18 +00001989
Paul Duffinc9103932020-03-17 21:04:24 +00001990 exportedJar := p.JarToExport
1991 if exportedJar != nil {
1992 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
Paul Duffind76209b2020-03-02 11:33:02 +00001993 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
1994
Paul Duffinc9103932020-03-17 21:04:24 +00001995 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
1996 }
1997
1998 aidlIncludeDirs := p.AidlIncludeDirs
1999 if len(aidlIncludeDirs) != 0 {
2000 sdkModuleContext := ctx.SdkModuleContext()
2001 for _, dir := range aidlIncludeDirs {
Paul Duffind76209b2020-03-02 11:33:02 +00002002 // TODO(jiyong): copy parcelable declarations only
2003 aidlFiles, _ := sdkModuleContext.GlobWithDeps(dir.String()+"/**/*.aidl", nil)
2004 for _, file := range aidlFiles {
2005 builder.CopyToSnapshot(android.PathForSource(sdkModuleContext, file), filepath.Join(aidlIncludeDir, file))
2006 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00002007 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00002008
Paul Duffinc9103932020-03-17 21:04:24 +00002009 // TODO(b/151933053) - add aidl include dirs property
Paul Duffind76209b2020-03-02 11:33:02 +00002010 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00002011}
2012
Paul Duffin2b9e3d32020-02-28 14:39:53 +00002013var javaHeaderLibsSdkMemberType android.SdkMemberType = &librarySdkMemberType{
2014 android.SdkMemberTypeBase{
2015 PropertyName: "java_header_libs",
2016 SupportsSdk: true,
Paul Duffin7b81f5e2020-01-13 21:03:22 +00002017 },
Paul Duffin2b9e3d32020-02-28 14:39:53 +00002018 func(j *Library) android.Path {
Paul Duffina0dbf432019-12-05 11:25:53 +00002019 headerJars := j.HeaderJars()
2020 if len(headerJars) != 1 {
2021 panic(fmt.Errorf("there must be only one header jar from %q", j.Name()))
2022 }
2023
2024 return headerJars[0]
Paul Duffin2b9e3d32020-02-28 14:39:53 +00002025 },
Paul Duffina0dbf432019-12-05 11:25:53 +00002026}
2027
Colin Cross1b16b0e2019-02-12 14:41:32 -08002028// java_library builds and links sources into a `.jar` file for the device, and possibly for the host as well.
2029//
2030// By default, a java_library has a single variant that produces a `.jar` file containing `.class` files that were
2031// compiled against the device bootclasspath. This jar is not suitable for installing on a device, but can be used
2032// as a `static_libs` dependency of another module.
2033//
2034// Specifying `installable: true` will product a `.jar` file containing `classes.dex` files, suitable for installing on
2035// a device.
2036//
2037// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2038// compiled against the host bootclasspath.
Colin Cross9ae1b922018-06-26 17:59:05 -07002039func LibraryFactory() android.Module {
2040 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07002041
Colin Cross1c14b4e2020-06-15 16:09:53 -07002042 module.addHostAndDeviceProperties()
2043 module.AddProperties(&module.libraryProperties)
Colin Cross2fe66872015-03-30 17:20:39 -07002044
Paul Duffin64e61992020-05-15 10:20:31 +01002045 module.initModuleAndImport(&module.ModuleBase)
2046
Jiyong Park7f7766d2019-07-25 22:02:35 +09002047 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002048 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002049 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross9ae1b922018-06-26 17:59:05 -07002050 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002051}
2052
Colin Cross1b16b0e2019-02-12 14:41:32 -08002053// java_library_static is an obsolete alias for java_library.
2054func LibraryStaticFactory() android.Module {
2055 return LibraryFactory()
2056}
2057
2058// java_library_host builds and links sources into a `.jar` file for the host.
2059//
2060// A java_library_host has a single variant that produces a `.jar` file containing `.class` files that were
2061// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002062func LibraryHostFactory() android.Module {
2063 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07002064
Colin Cross1c14b4e2020-06-15 16:09:53 -07002065 module.addHostProperties()
Colin Cross36242852017-06-23 15:06:31 -07002066
Colin Cross9ae1b922018-06-26 17:59:05 -07002067 module.Module.properties.Installable = proptools.BoolPtr(true)
2068
Jiyong Park7f7766d2019-07-25 22:02:35 +09002069 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002070 InitJavaModule(module, android.HostSupported)
Colin Cross36242852017-06-23 15:06:31 -07002071 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002072}
2073
2074//
Colin Crossb628ea52018-08-14 16:42:33 -07002075// Java Tests
Colin Cross05638fc2018-04-09 18:40:24 -07002076//
2077
2078type testProperties struct {
Colin Cross05638fc2018-04-09 18:40:24 -07002079 // list of compatibility suites (for example "cts", "vts") that the module should be
2080 // installed into.
2081 Test_suites []string `android:"arch_variant"`
Julien Despreze146e392018-08-02 15:00:46 -07002082
2083 // the name of the test configuration (for example "AndroidTest.xml") that should be
2084 // installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002085 Test_config *string `android:"path,arch_variant"`
Colin Crossd96ca352018-08-10 16:06:24 -07002086
Jack He33338892018-09-19 02:21:28 -07002087 // the name of the test configuration template (for example "AndroidTestTemplate.xml") that
2088 // should be installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002089 Test_config_template *string `android:"path,arch_variant"`
Jack He33338892018-09-19 02:21:28 -07002090
Colin Crossd96ca352018-08-10 16:06:24 -07002091 // list of files or filegroup modules that provide data that should be installed alongside
2092 // the test
Colin Cross27b922f2019-03-04 22:35:41 -08002093 Data []string `android:"path"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07002094
2095 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
2096 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
2097 // explicitly.
2098 Auto_gen_config *bool
easoncyleeba606252020-04-30 14:57:06 +08002099
2100 // Add parameterized mainline modules to auto generated test config. The options will be
2101 // handled by TradeFed to do downloading and installing the specified modules on the device.
2102 Test_mainline_modules []string
Colin Cross05638fc2018-04-09 18:40:24 -07002103}
2104
Paul Duffin42df1442019-03-20 12:45:53 +00002105type testHelperLibraryProperties struct {
2106 // list of compatibility suites (for example "cts", "vts") that the module should be
2107 // installed into.
2108 Test_suites []string `android:"arch_variant"`
2109}
2110
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002111type prebuiltTestProperties struct {
2112 // list of compatibility suites (for example "cts", "vts") that the module should be
2113 // installed into.
2114 Test_suites []string `android:"arch_variant"`
2115
2116 // the name of the test configuration (for example "AndroidTest.xml") that should be
2117 // installed with the module.
2118 Test_config *string `android:"path,arch_variant"`
2119}
2120
Colin Cross05638fc2018-04-09 18:40:24 -07002121type Test struct {
2122 Library
2123
2124 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07002125
2126 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07002127 data android.Paths
Colin Cross303e21f2018-08-07 16:49:25 -07002128}
2129
Paul Duffin42df1442019-03-20 12:45:53 +00002130type TestHelperLibrary struct {
2131 Library
2132
2133 testHelperLibraryProperties testHelperLibraryProperties
2134}
2135
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002136type JavaTestImport struct {
2137 Import
2138
2139 prebuiltTestProperties prebuiltTestProperties
2140
2141 testConfig android.Path
2142}
2143
Colin Cross303e21f2018-08-07 16:49:25 -07002144func (j *Test) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Dan Shi6ffaaa82019-09-26 11:41:36 -07002145 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.testProperties.Test_config, j.testProperties.Test_config_template,
2146 j.testProperties.Test_suites, j.testProperties.Auto_gen_config)
Colin Cross8a497952019-03-05 22:25:09 -08002147 j.data = android.PathsForModuleSrc(ctx, j.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07002148
2149 j.Library.GenerateAndroidBuildActions(ctx)
Colin Cross05638fc2018-04-09 18:40:24 -07002150}
2151
Paul Duffin42df1442019-03-20 12:45:53 +00002152func (j *TestHelperLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2153 j.Library.GenerateAndroidBuildActions(ctx)
2154}
2155
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002156func (j *JavaTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2157 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.prebuiltTestProperties.Test_config, nil,
2158 j.prebuiltTestProperties.Test_suites, nil)
2159
2160 j.Import.GenerateAndroidBuildActions(ctx)
2161}
2162
2163type testSdkMemberType struct {
2164 android.SdkMemberTypeBase
2165}
2166
2167func (mt *testSdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
2168 mctx.AddVariationDependencies(nil, dependencyTag, names...)
2169}
2170
2171func (mt *testSdkMemberType) IsInstance(module android.Module) bool {
2172 _, ok := module.(*Test)
2173 return ok
2174}
2175
Paul Duffin17ab8832020-03-19 16:11:18 +00002176func (mt *testSdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
2177 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_test_import")
Paul Duffind76209b2020-03-02 11:33:02 +00002178}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002179
Paul Duffind76209b2020-03-02 11:33:02 +00002180func (mt *testSdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
2181 return &testSdkMemberProperties{}
2182}
2183
2184type testSdkMemberProperties struct {
2185 android.SdkMemberPropertiesBase
2186
Paul Duffinc9103932020-03-17 21:04:24 +00002187 JarToExport android.Path
2188 TestConfig android.Path
Paul Duffind76209b2020-03-02 11:33:02 +00002189}
2190
Paul Duffin17ab8832020-03-19 16:11:18 +00002191func (p *testSdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffind76209b2020-03-02 11:33:02 +00002192 test := variant.(*Test)
2193
2194 implementationJars := test.ImplementationJars()
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002195 if len(implementationJars) != 1 {
Paul Duffind76209b2020-03-02 11:33:02 +00002196 panic(fmt.Errorf("there must be only one implementation jar from %q", test.Name()))
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002197 }
2198
Paul Duffinc9103932020-03-17 21:04:24 +00002199 p.JarToExport = implementationJars[0]
2200 p.TestConfig = test.testConfig
Paul Duffind76209b2020-03-02 11:33:02 +00002201}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002202
Paul Duffin17ab8832020-03-19 16:11:18 +00002203func (p *testSdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffinc9103932020-03-17 21:04:24 +00002204 builder := ctx.SnapshotBuilder()
Paul Duffin17ab8832020-03-19 16:11:18 +00002205
Paul Duffinc9103932020-03-17 21:04:24 +00002206 exportedJar := p.JarToExport
2207 if exportedJar != nil {
2208 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
2209 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
Paul Duffind76209b2020-03-02 11:33:02 +00002210
2211 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
Paul Duffinc9103932020-03-17 21:04:24 +00002212 }
2213
2214 testConfig := p.TestConfig
2215 if testConfig != nil {
2216 snapshotRelativeTestConfigPath := sdkSnapshotFilePathForMember(p.OsPrefix(), ctx.Name(), testConfigSuffix)
2217 builder.CopyToSnapshot(testConfig, snapshotRelativeTestConfigPath)
Paul Duffind76209b2020-03-02 11:33:02 +00002218 propertySet.AddProperty("test_config", snapshotRelativeTestConfigPath)
2219 }
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002220}
2221
Colin Cross1b16b0e2019-02-12 14:41:32 -08002222// java_test builds a and links sources into a `.jar` file for the device, and possibly for the host as well, and
2223// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
2224//
2225// By default, a java_test has a single variant that produces a `.jar` file containing `classes.dex` files that were
2226// compiled against the device bootclasspath.
2227//
2228// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2229// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002230func TestFactory() android.Module {
2231 module := &Test{}
2232
Colin Cross1c14b4e2020-06-15 16:09:53 -07002233 module.addHostAndDeviceProperties()
2234 module.AddProperties(&module.testProperties)
Colin Cross05638fc2018-04-09 18:40:24 -07002235
Colin Cross9ae1b922018-06-26 17:59:05 -07002236 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse3026872019-01-05 22:30:13 -08002237 module.Module.dexpreopter.isTest = true
Colin Cross9ae1b922018-06-26 17:59:05 -07002238
Colin Cross05638fc2018-04-09 18:40:24 -07002239 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002240 return module
2241}
2242
Paul Duffin42df1442019-03-20 12:45:53 +00002243// java_test_helper_library creates a java library and makes sure that it is added to the appropriate test suite.
2244func TestHelperLibraryFactory() android.Module {
2245 module := &TestHelperLibrary{}
2246
Colin Cross1c14b4e2020-06-15 16:09:53 -07002247 module.addHostAndDeviceProperties()
2248 module.AddProperties(&module.testHelperLibraryProperties)
Paul Duffin42df1442019-03-20 12:45:53 +00002249
Colin Cross9a4abed2019-04-24 13:19:28 -07002250 module.Module.properties.Installable = proptools.BoolPtr(true)
2251 module.Module.dexpreopter.isTest = true
2252
Paul Duffin42df1442019-03-20 12:45:53 +00002253 InitJavaModule(module, android.HostAndDeviceSupported)
2254 return module
2255}
2256
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002257// java_test_import imports one or more `.jar` files into the build graph as if they were built by a java_test module
2258// and makes sure that it is added to the appropriate test suite.
2259//
2260// By default, a java_test_import has a single variant that expects a `.jar` file containing `.class` files that were
2261// compiled against an Android classpath.
2262//
2263// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2264// for host modules.
2265func JavaTestImportFactory() android.Module {
2266 module := &JavaTestImport{}
2267
2268 module.AddProperties(
2269 &module.Import.properties,
2270 &module.prebuiltTestProperties)
2271
2272 module.Import.properties.Installable = proptools.BoolPtr(true)
2273
2274 android.InitPrebuiltModule(module, &module.properties.Jars)
2275 android.InitApexModule(module)
2276 android.InitSdkAwareModule(module)
2277 InitJavaModule(module, android.HostAndDeviceSupported)
2278 return module
2279}
2280
Colin Cross1b16b0e2019-02-12 14:41:32 -08002281// java_test_host builds a and links sources into a `.jar` file for the host, and creates an `AndroidTest.xml` file to
2282// allow running the test with `atest` or a `TEST_MAPPING` file.
2283//
2284// A java_test_host has a single variant that produces a `.jar` file containing `.class` files that were
2285// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002286func TestHostFactory() android.Module {
2287 module := &Test{}
2288
Colin Cross1c14b4e2020-06-15 16:09:53 -07002289 module.addHostProperties()
2290 module.AddProperties(&module.testProperties)
Colin Cross05638fc2018-04-09 18:40:24 -07002291
Colin Cross9ae1b922018-06-26 17:59:05 -07002292 module.Module.properties.Installable = proptools.BoolPtr(true)
2293
Colin Cross05638fc2018-04-09 18:40:24 -07002294 InitJavaModule(module, android.HostSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002295 return module
2296}
2297
2298//
Colin Cross2fe66872015-03-30 17:20:39 -07002299// Java Binaries (.jar file plus wrapper script)
2300//
2301
Colin Crossf506d872017-07-19 15:53:04 -07002302type binaryProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -07002303 // installable script to execute the resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -08002304 Wrapper *string `android:"path"`
Colin Cross094054a2018-10-17 15:10:48 -07002305
2306 // Name of the class containing main to be inserted into the manifest as Main-Class.
2307 Main_class *string
Colin Cross7d5136f2015-05-11 13:39:40 -07002308}
2309
Colin Crossf506d872017-07-19 15:53:04 -07002310type Binary struct {
2311 Library
Colin Cross2fe66872015-03-30 17:20:39 -07002312
Colin Crossf506d872017-07-19 15:53:04 -07002313 binaryProperties binaryProperties
Colin Cross10a03492017-08-10 17:09:43 -07002314
Colin Cross6b4a32d2017-12-05 13:42:45 -08002315 isWrapperVariant bool
2316
Colin Crossc3315992017-12-08 19:12:36 -08002317 wrapperFile android.Path
Colin Cross70dda7e2019-10-01 22:05:35 -07002318 binaryFile android.InstallPath
Colin Cross2fe66872015-03-30 17:20:39 -07002319}
2320
Alex Light24237172017-10-26 09:46:21 -07002321func (j *Binary) HostToolPath() android.OptionalPath {
2322 return android.OptionalPathForPath(j.binaryFile)
2323}
2324
Colin Crossf506d872017-07-19 15:53:04 -07002325func (j *Binary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002326 if ctx.Arch().ArchType == android.Common {
2327 // Compile the jar
Colin Cross094054a2018-10-17 15:10:48 -07002328 if j.binaryProperties.Main_class != nil {
2329 if j.properties.Manifest != nil {
2330 ctx.PropertyErrorf("main_class", "main_class cannot be used when manifest is set")
2331 }
2332 manifestFile := android.PathForModuleOut(ctx, "manifest.txt")
2333 GenerateMainClassManifest(ctx, manifestFile, String(j.binaryProperties.Main_class))
2334 j.overrideManifest = android.OptionalPathForPath(manifestFile)
2335 }
2336
Colin Cross6b4a32d2017-12-05 13:42:45 -08002337 j.Library.GenerateAndroidBuildActions(ctx)
Nan Zhang3c807db2017-11-03 14:53:31 -07002338 } else {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002339 // Handle the binary wrapper
2340 j.isWrapperVariant = true
2341
Colin Cross366938f2017-12-11 16:29:02 -08002342 if j.binaryProperties.Wrapper != nil {
Colin Cross8a497952019-03-05 22:25:09 -08002343 j.wrapperFile = android.PathForModuleSrc(ctx, *j.binaryProperties.Wrapper)
Colin Cross6b4a32d2017-12-05 13:42:45 -08002344 } else {
2345 j.wrapperFile = android.PathForSource(ctx, "build/soong/scripts/jar-wrapper.sh")
2346 }
2347
2348 // Depend on the installed jar so that the wrapper doesn't get executed by
2349 // another build rule before the jar has been installed.
2350 jarFile := ctx.PrimaryModule().(*Binary).installFile
2351
2352 j.binaryFile = ctx.InstallExecutable(android.PathForModuleInstall(ctx, "bin"),
2353 ctx.ModuleName(), j.wrapperFile, jarFile)
Nan Zhang3c807db2017-11-03 14:53:31 -07002354 }
Colin Cross2fe66872015-03-30 17:20:39 -07002355}
2356
Colin Crossf506d872017-07-19 15:53:04 -07002357func (j *Binary) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002358 if ctx.Arch().ArchType == android.Common {
2359 j.deps(ctx)
2360 }
Colin Cross46c9b8b2017-06-22 16:51:17 -07002361}
2362
Colin Cross1b16b0e2019-02-12 14:41:32 -08002363// java_binary builds a `.jar` file and a shell script that executes it for the device, and possibly for the host
2364// as well.
2365//
2366// By default, a java_binary has a single variant that produces a `.jar` file containing `classes.dex` files that were
2367// compiled against the device bootclasspath.
2368//
2369// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2370// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002371func BinaryFactory() android.Module {
2372 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002373
Colin Cross1c14b4e2020-06-15 16:09:53 -07002374 module.addHostAndDeviceProperties()
2375 module.AddProperties(&module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002376
Colin Cross9ae1b922018-06-26 17:59:05 -07002377 module.Module.properties.Installable = proptools.BoolPtr(true)
2378
Colin Cross6b4a32d2017-12-05 13:42:45 -08002379 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibCommonFirst)
2380 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002381 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002382}
2383
Colin Cross1b16b0e2019-02-12 14:41:32 -08002384// java_binary_host builds a `.jar` file and a shell script that executes it for the host.
2385//
2386// A java_binary_host has a single variant that produces a `.jar` file containing `.class` files that were
2387// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002388func BinaryHostFactory() android.Module {
2389 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002390
Colin Cross1c14b4e2020-06-15 16:09:53 -07002391 module.addHostProperties()
2392 module.AddProperties(&module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002393
Colin Cross9ae1b922018-06-26 17:59:05 -07002394 module.Module.properties.Installable = proptools.BoolPtr(true)
2395
Colin Cross6b4a32d2017-12-05 13:42:45 -08002396 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommonFirst)
2397 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002398 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002399}
2400
2401//
2402// Java prebuilts
2403//
2404
Colin Cross74d73e22017-08-02 11:05:49 -07002405type ImportProperties struct {
Paul Duffin9b358d72020-03-02 10:16:35 +00002406 Jars []string `android:"path,arch_variant"`
Colin Cross461bd1a2017-10-20 13:59:18 -07002407
Nan Zhangea568a42017-11-08 21:20:04 -08002408 Sdk_version *string
Colin Cross535e2cf2017-10-20 17:57:49 -07002409
2410 Installable *bool
Jiyong Park1be96912018-05-28 18:02:19 +09002411
2412 // List of shared java libs that this module has dependencies to
2413 Libs []string
Colin Cross37f6d792018-07-12 12:28:41 -07002414
2415 // List of files to remove from the jar file(s)
2416 Exclude_files []string
2417
2418 // List of directories to remove from the jar file(s)
2419 Exclude_dirs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -07002420
2421 // if set to true, run Jetifier against .jar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -07002422 Jetifier *bool
Jiyong Park4c4c0242019-10-21 14:53:15 +09002423
2424 // set the name of the output
2425 Stem *string
Colin Cross74d73e22017-08-02 11:05:49 -07002426}
2427
2428type Import struct {
Colin Cross635c3b02016-05-18 15:37:25 -07002429 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -07002430 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002431 android.ApexModuleBase
Colin Crossec7a0422017-07-07 14:47:12 -07002432 prebuilt android.Prebuilt
Jiyong Parkd1063c12019-07-17 20:08:41 +09002433 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -07002434
Paul Duffinc8f2f182020-05-17 08:34:50 +01002435 // Functionality common to Module and Import.
2436 embeddableInModuleAndImport
2437
Colin Cross74d73e22017-08-02 11:05:49 -07002438 properties ImportProperties
2439
Colin Cross0a6e0072017-08-30 14:24:55 -07002440 combinedClasspathFile android.Path
Jiyong Park1be96912018-05-28 18:02:19 +09002441 exportedSdkLibs []string
Colin Cross2fe66872015-03-30 17:20:39 -07002442}
2443
Jiyong Park6a927c42020-01-21 02:03:43 +09002444func (j *Import) sdkVersion() sdkSpec {
2445 return sdkSpecFrom(String(j.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07002446}
2447
Jiyong Park6a927c42020-01-21 02:03:43 +09002448func (j *Import) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -07002449 return j.sdkVersion()
2450}
2451
Artur Satayev388d39b2020-04-27 18:53:18 +01002452func (j *Import) MinSdkVersion() string {
2453 return j.minSdkVersion().version.String()
2454}
2455
Colin Cross74d73e22017-08-02 11:05:49 -07002456func (j *Import) Prebuilt() *android.Prebuilt {
Colin Crossec7a0422017-07-07 14:47:12 -07002457 return &j.prebuilt
2458}
2459
Colin Cross74d73e22017-08-02 11:05:49 -07002460func (j *Import) PrebuiltSrcs() []string {
2461 return j.properties.Jars
2462}
2463
2464func (j *Import) Name() string {
Colin Cross5ea9bcc2017-07-27 15:41:32 -07002465 return j.prebuilt.Name(j.ModuleBase.Name())
2466}
2467
Jiyong Park0b238752019-10-29 11:23:10 +09002468func (j *Import) Stem() string {
2469 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2470}
2471
Jiyong Park618922e2020-01-08 13:35:43 +09002472func (a *Import) JacocoReportClassesFile() android.Path {
2473 return nil
2474}
2475
Colin Cross74d73e22017-08-02 11:05:49 -07002476func (j *Import) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross42d48b72018-08-29 14:10:52 -07002477 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Colin Cross1e676be2016-10-12 14:38:15 -07002478}
2479
Colin Cross74d73e22017-08-02 11:05:49 -07002480func (j *Import) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross8a497952019-03-05 22:25:09 -08002481 jars := android.PathsForModuleSrc(ctx, j.properties.Jars)
Colin Crosse1d62a82015-04-03 16:53:05 -07002482
Jiyong Park0b238752019-10-29 11:23:10 +09002483 jarName := j.Stem() + ".jar"
Nan Zhang4c819fb2018-08-27 18:31:46 -07002484 outputFile := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07002485 TransformJarsToJar(ctx, outputFile, "for prebuilts", jars, android.OptionalPath{},
2486 false, j.properties.Exclude_files, j.properties.Exclude_dirs)
Colin Cross1001a792019-03-21 22:21:39 -07002487 if Bool(j.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -07002488 inputFile := outputFile
2489 outputFile = android.PathForModuleOut(ctx, "jetifier", jarName)
2490 TransformJetifier(ctx, outputFile, inputFile)
2491 }
Colin Crosse9a275b2017-10-16 17:09:48 -07002492 j.combinedClasspathFile = outputFile
Jiyong Park1be96912018-05-28 18:02:19 +09002493
Paul Duffin64e61992020-05-15 10:20:31 +01002494 // If this is a component library (impl, stubs, etc.) for a java_sdk_library then
2495 // add the name of that java_sdk_library to the exported sdk libs to make sure
2496 // that, if necessary, a <uses-library> element for that java_sdk_library is
2497 // added to the Android manifest.
2498 j.exportedSdkLibs = append(j.exportedSdkLibs, j.OptionalImplicitSdkLibrary()...)
2499
Jiyong Park1be96912018-05-28 18:02:19 +09002500 ctx.VisitDirectDeps(func(module android.Module) {
2501 otherName := ctx.OtherModuleName(module)
2502 tag := ctx.OtherModuleDependencyTag(module)
2503
2504 switch dep := module.(type) {
2505 case Dependency:
2506 switch tag {
2507 case libTag, staticLibTag:
2508 // sdk lib names from dependencies are re-exported
2509 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
2510 }
2511 case SdkLibraryDependency:
2512 switch tag {
2513 case libTag:
2514 // names of sdk libs that are directly depended are exported
2515 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
2516 }
2517 }
2518 })
2519
2520 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002521 if Bool(j.properties.Installable) {
2522 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Park4c4c0242019-10-21 14:53:15 +09002523 jarName, outputFile)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002524 }
Colin Cross2fe66872015-03-30 17:20:39 -07002525}
2526
Colin Cross74d73e22017-08-02 11:05:49 -07002527var _ Dependency = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002528
Nan Zhanged19fc32017-10-19 13:06:22 -07002529func (j *Import) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002530 if j.combinedClasspathFile == nil {
2531 return nil
2532 }
Colin Cross37f6d792018-07-12 12:28:41 -07002533 return android.Paths{j.combinedClasspathFile}
Nan Zhanged19fc32017-10-19 13:06:22 -07002534}
2535
2536func (j *Import) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08002537 if j.combinedClasspathFile == nil {
2538 return nil
2539 }
Colin Cross37f6d792018-07-12 12:28:41 -07002540 return android.Paths{j.combinedClasspathFile}
Colin Cross2fe66872015-03-30 17:20:39 -07002541}
2542
Colin Cross331a1212018-08-15 20:40:52 -07002543func (j *Import) ResourceJars() android.Paths {
2544 return nil
2545}
2546
2547func (j *Import) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002548 if j.combinedClasspathFile == nil {
2549 return nil
2550 }
Colin Cross331a1212018-08-15 20:40:52 -07002551 return android.Paths{j.combinedClasspathFile}
2552}
2553
Colin Crossf24a22a2019-01-31 14:12:44 -08002554func (j *Import) DexJar() android.Path {
2555 return nil
2556}
2557
Colin Cross74d73e22017-08-02 11:05:49 -07002558func (j *Import) AidlIncludeDirs() android.Paths {
Colin Crossc0b06f12015-04-08 13:03:43 -07002559 return nil
2560}
2561
Jiyong Park1be96912018-05-28 18:02:19 +09002562func (j *Import) ExportedSdkLibs() []string {
2563 return j.exportedSdkLibs
2564}
2565
Artur Satayev9cf46692019-11-26 18:08:34 +00002566func (j *Import) ExportedPlugins() (android.Paths, []string) {
2567 return nil, nil
2568}
2569
Colin Cross0c4ce212019-05-03 15:28:19 -07002570func (j *Import) SrcJarArgs() ([]string, android.Paths) {
2571 return nil, nil
2572}
2573
Jiyong Park0f80c182020-01-31 02:49:53 +09002574func (j *Import) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffinc8f2f182020-05-17 08:34:50 +01002575 return j.depIsInSameApex(ctx, dep)
Jiyong Park0f80c182020-01-31 02:49:53 +09002576}
2577
albaltai36ff7dc2018-12-25 14:35:23 +08002578// Add compile time check for interface implementation
2579var _ android.IDEInfo = (*Import)(nil)
2580var _ android.IDECustomizedModuleName = (*Import)(nil)
2581
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002582// Collect information for opening IDE project files in java/jdeps.go.
2583const (
2584 removedPrefix = "prebuilt_"
2585)
2586
2587func (j *Import) IDEInfo(dpInfo *android.IdeInfo) {
2588 dpInfo.Jars = append(dpInfo.Jars, j.PrebuiltSrcs()...)
2589}
2590
2591func (j *Import) IDECustomizedModuleName() string {
2592 // TODO(b/113562217): Extract the base module name from the Import name, often the Import name
2593 // has a prefix "prebuilt_". Remove the prefix explicitly if needed until we find a better
2594 // solution to get the Import name.
2595 name := j.Name()
2596 if strings.HasPrefix(name, removedPrefix) {
patricktubb640e02018-10-11 18:33:16 +08002597 name = strings.TrimPrefix(name, removedPrefix)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002598 }
2599 return name
2600}
2601
Colin Cross74d73e22017-08-02 11:05:49 -07002602var _ android.PrebuiltInterface = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002603
Colin Cross1b16b0e2019-02-12 14:41:32 -08002604// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library module.
2605//
2606// By default, a java_import has a single variant that expects a `.jar` file containing `.class` files that were
2607// compiled against an Android classpath.
2608//
2609// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2610// for host modules.
Colin Cross74d73e22017-08-02 11:05:49 -07002611func ImportFactory() android.Module {
2612 module := &Import{}
Colin Cross36242852017-06-23 15:06:31 -07002613
Colin Cross74d73e22017-08-02 11:05:49 -07002614 module.AddProperties(&module.properties)
2615
Paul Duffin64e61992020-05-15 10:20:31 +01002616 module.initModuleAndImport(&module.ModuleBase)
2617
Colin Cross74d73e22017-08-02 11:05:49 -07002618 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002619 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002620 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002621 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross36242852017-06-23 15:06:31 -07002622 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002623}
2624
Colin Cross1b16b0e2019-02-12 14:41:32 -08002625// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library_host
2626// module.
2627//
2628// A java_import_host has a single variant that expects a `.jar` file containing `.class` files that were
2629// compiled against a host bootclasspath.
Colin Cross74d73e22017-08-02 11:05:49 -07002630func ImportFactoryHost() android.Module {
2631 module := &Import{}
2632
2633 module.AddProperties(&module.properties)
2634
2635 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002636 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002637 InitJavaModule(module, android.HostSupported)
Colin Cross74d73e22017-08-02 11:05:49 -07002638 return module
2639}
2640
Colin Cross42be7612019-02-21 18:12:14 -08002641// dex_import module
2642
2643type DexImportProperties struct {
Colin Cross5cfc70d2019-07-15 13:36:55 -07002644 Jars []string `android:"path"`
Jiyong Park4c4c0242019-10-21 14:53:15 +09002645
2646 // set the name of the output
2647 Stem *string
Colin Cross42be7612019-02-21 18:12:14 -08002648}
2649
2650type DexImport struct {
2651 android.ModuleBase
2652 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002653 android.ApexModuleBase
Colin Cross42be7612019-02-21 18:12:14 -08002654 prebuilt android.Prebuilt
2655
2656 properties DexImportProperties
2657
2658 dexJarFile android.Path
2659 maybeStrippedDexJarFile android.Path
2660
2661 dexpreopter
2662}
2663
2664func (j *DexImport) Prebuilt() *android.Prebuilt {
2665 return &j.prebuilt
2666}
2667
2668func (j *DexImport) PrebuiltSrcs() []string {
2669 return j.properties.Jars
2670}
2671
2672func (j *DexImport) Name() string {
2673 return j.prebuilt.Name(j.ModuleBase.Name())
2674}
2675
Jiyong Park0b238752019-10-29 11:23:10 +09002676func (j *DexImport) Stem() string {
2677 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2678}
2679
Jiyong Park2cd081c2020-06-01 21:39:15 +09002680func (a *DexImport) JacocoReportClassesFile() android.Path {
2681 return nil
2682}
2683
Martin Stjernholm6d415272020-01-31 17:10:36 +00002684func (j *DexImport) IsInstallable() bool {
2685 return true
2686}
2687
Colin Cross42be7612019-02-21 18:12:14 -08002688func (j *DexImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2689 if len(j.properties.Jars) != 1 {
2690 ctx.PropertyErrorf("jars", "exactly one jar must be provided")
2691 }
2692
Jiyong Park0b238752019-10-29 11:23:10 +09002693 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross42be7612019-02-21 18:12:14 -08002694 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
2695
2696 inputJar := ctx.ExpandSource(j.properties.Jars[0], "jars")
2697 dexOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar")
2698
2699 if j.dexpreopter.uncompressedDex {
2700 rule := android.NewRuleBuilder()
2701
2702 temporary := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar.unaligned")
2703 rule.Temporary(temporary)
2704
2705 // use zip2zip to uncompress classes*.dex files
2706 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002707 BuiltTool(ctx, "zip2zip").
Colin Cross42be7612019-02-21 18:12:14 -08002708 FlagWithInput("-i ", inputJar).
2709 FlagWithOutput("-o ", temporary).
2710 FlagWithArg("-0 ", "'classes*.dex'")
2711
2712 // use zipalign to align uncompressed classes*.dex files
2713 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002714 BuiltTool(ctx, "zipalign").
Colin Cross42be7612019-02-21 18:12:14 -08002715 Flag("-f").
2716 Text("4").
2717 Input(temporary).
2718 Output(dexOutputFile)
2719
2720 rule.DeleteTemporaryFiles()
2721
2722 rule.Build(pctx, ctx, "uncompress_dex", "uncompress dex")
2723 } else {
2724 ctx.Build(pctx, android.BuildParams{
2725 Rule: android.Cp,
2726 Input: inputJar,
2727 Output: dexOutputFile,
2728 })
2729 }
2730
2731 j.dexJarFile = dexOutputFile
2732
2733 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
2734
2735 j.maybeStrippedDexJarFile = dexOutputFile
2736
Jiyong Parkafd3d112020-06-08 19:24:09 +09002737 if j.IsForPlatform() {
2738 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
2739 j.Stem()+".jar", dexOutputFile)
2740 }
Colin Cross42be7612019-02-21 18:12:14 -08002741}
2742
2743func (j *DexImport) DexJar() android.Path {
2744 return j.dexJarFile
2745}
2746
2747// dex_import imports a `.jar` file containing classes.dex files.
2748//
2749// A dex_import module cannot be used as a dependency of a java_* or android_* module, it can only be installed
2750// to the device.
2751func DexImportFactory() android.Module {
2752 module := &DexImport{}
2753
2754 module.AddProperties(&module.properties)
2755
2756 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002757 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002758 InitJavaModule(module, android.DeviceSupported)
Colin Cross42be7612019-02-21 18:12:14 -08002759 return module
2760}
2761
Colin Cross89536d42017-07-07 14:35:50 -07002762//
2763// Defaults
2764//
2765type Defaults struct {
2766 android.ModuleBase
2767 android.DefaultsModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002768 android.ApexModuleBase
Colin Cross89536d42017-07-07 14:35:50 -07002769}
2770
Colin Cross1b16b0e2019-02-12 14:41:32 -08002771// java_defaults provides a set of properties that can be inherited by other java or android modules.
2772//
2773// A module can use the properties from a java_defaults module using `defaults: ["defaults_module_name"]`. Each
2774// property in the defaults module that exists in the depending module will be prepended to the depending module's
2775// value for that property.
2776//
2777// Example:
2778//
2779// java_defaults {
2780// name: "example_defaults",
2781// srcs: ["common/**/*.java"],
2782// javacflags: ["-Xlint:all"],
2783// aaptflags: ["--auto-add-overlay"],
2784// }
2785//
2786// java_library {
2787// name: "example",
2788// defaults: ["example_defaults"],
2789// srcs: ["example/**/*.java"],
2790// }
2791//
2792// is functionally identical to:
2793//
2794// java_library {
2795// name: "example",
2796// srcs: [
2797// "common/**/*.java",
2798// "example/**/*.java",
2799// ],
2800// javacflags: ["-Xlint:all"],
2801// }
Colin Cross89536d42017-07-07 14:35:50 -07002802func defaultsFactory() android.Module {
2803 return DefaultsFactory()
2804}
2805
Paul Duffin47357662019-12-05 14:07:14 +00002806func DefaultsFactory() android.Module {
Colin Cross89536d42017-07-07 14:35:50 -07002807 module := &Defaults{}
2808
Colin Cross89536d42017-07-07 14:35:50 -07002809 module.AddProperties(
2810 &CompilerProperties{},
2811 &CompilerDeviceProperties{},
Colin Cross43f08db2018-11-12 10:13:39 -08002812 &DexpreoptProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08002813 &android.ProtoProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002814 &aaptProperties{},
2815 &androidLibraryProperties{},
2816 &appProperties{},
2817 &appTestProperties{},
Jaewoong Jung525443a2019-02-28 15:35:54 -08002818 &overridableAppProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002819 &ImportProperties{},
2820 &AARImportProperties{},
2821 &sdkLibraryProperties{},
Paul Duffin1a724e62020-05-08 13:44:43 +01002822 &commonToSdkLibraryAndImportProperties{},
Colin Cross42be7612019-02-21 18:12:14 -08002823 &DexImportProperties{},
Jooyung Han18020ea2019-11-13 10:50:48 +09002824 &android.ApexProperties{},
Jaewoong Jung062ed7e2020-04-26 15:10:51 -07002825 &RuntimeResourceOverlayProperties{},
Colin Cross89536d42017-07-07 14:35:50 -07002826 )
2827
2828 android.InitDefaultsModule(module)
Colin Cross89536d42017-07-07 14:35:50 -07002829 return module
2830}
Nan Zhangea568a42017-11-08 21:20:04 -08002831
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002832func kytheExtractJavaFactory() android.Singleton {
2833 return &kytheExtractJavaSingleton{}
2834}
2835
2836type kytheExtractJavaSingleton struct {
2837}
2838
2839func (ks *kytheExtractJavaSingleton) GenerateBuildActions(ctx android.SingletonContext) {
2840 var xrefTargets android.Paths
2841 ctx.VisitAllModules(func(module android.Module) {
2842 if javaModule, ok := module.(xref); ok {
2843 xrefTargets = append(xrefTargets, javaModule.XrefJavaFiles()...)
2844 }
2845 })
2846 // TODO(asmundak): perhaps emit a rule to output a warning if there were no xrefTargets
2847 if len(xrefTargets) > 0 {
Colin Cross98552072020-06-04 13:25:17 -07002848 ctx.Phony("xref_java", xrefTargets...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002849 }
2850}
2851
Nan Zhangea568a42017-11-08 21:20:04 -08002852var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07002853var BoolDefault = proptools.BoolDefault
Nan Zhangea568a42017-11-08 21:20:04 -08002854var String = proptools.String
Colin Cross0d0ba592018-02-20 13:33:42 -08002855var inList = android.InList