blob: 466132e1e70dd30d4bbd93e9b21cd3f1cde364cd [file] [log] [blame]
Colin Cross2fe66872015-03-30 17:20:39 -07001// Copyright 2015 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package java
16
17// This file contains the module types for compiling Java for Android, and converts the properties
Colin Cross46c9b8b2017-06-22 16:51:17 -070018// into the flags and filenames necessary to pass to the Module. The final creation of the rules
Colin Cross2fe66872015-03-30 17:20:39 -070019// is handled in builder.go
20
21import (
Colin Crossf19b9bb2018-03-26 14:42:44 -070022 "fmt"
Colin Crossfc3674a2017-09-18 17:41:52 -070023 "path/filepath"
Colin Cross74d73e22017-08-02 11:05:49 -070024 "strconv"
Colin Cross2fe66872015-03-30 17:20:39 -070025 "strings"
26
27 "github.com/google/blueprint"
Colin Cross3b706fd2019-09-05 16:44:18 -070028 "github.com/google/blueprint/pathtools"
Colin Cross76b5f0c2017-08-29 16:02:06 -070029 "github.com/google/blueprint/proptools"
Colin Cross2fe66872015-03-30 17:20:39 -070030
Colin Cross635c3b02016-05-18 15:37:25 -070031 "android/soong/android"
Colin Cross3e3e72d2017-06-22 17:20:19 -070032 "android/soong/java/config"
Colin Cross303e21f2018-08-07 16:49:25 -070033 "android/soong/tradefed"
Colin Cross2fe66872015-03-30 17:20:39 -070034)
35
Colin Cross463a90e2015-06-17 14:20:06 -070036func init() {
Paul Duffinf9b1da02019-12-18 19:51:55 +000037 RegisterJavaBuildComponents(android.InitRegistrationContext)
Paul Duffin255f18e2019-12-13 11:22:16 +000038
39 // Register sdk member types.
Paul Duffin7b81f5e2020-01-13 21:03:22 +000040 android.RegisterSdkMemberType(javaHeaderLibsSdkMemberType)
Paul Duffin255f18e2019-12-13 11:22:16 +000041
Paul Duffinf5c0a9c2020-02-28 14:39:53 +000042 android.RegisterSdkMemberType(&librarySdkMemberType{
43 android.SdkMemberTypeBase{
44 PropertyName: "java_libs",
45 },
46 func(j *Library) android.Path {
47 implementationJars := j.ImplementationJars()
48 if len(implementationJars) != 1 {
49 panic(fmt.Errorf("there must be only one implementation jar from %q", j.Name()))
50 }
51
52 return implementationJars[0]
Paul Duffin255f18e2019-12-13 11:22:16 +000053 },
54 })
Paul Duffin1b82e6a2019-12-03 18:06:47 +000055
56 android.RegisterSdkMemberType(&testSdkMemberType{
57 SdkMemberTypeBase: android.SdkMemberTypeBase{
58 PropertyName: "java_tests",
59 },
60 })
Colin Cross463a90e2015-06-17 14:20:06 -070061}
62
Paul Duffinf9b1da02019-12-18 19:51:55 +000063func RegisterJavaBuildComponents(ctx android.RegistrationContext) {
64 ctx.RegisterModuleType("java_defaults", DefaultsFactory)
65
66 ctx.RegisterModuleType("java_library", LibraryFactory)
67 ctx.RegisterModuleType("java_library_static", LibraryStaticFactory)
68 ctx.RegisterModuleType("java_library_host", LibraryHostFactory)
69 ctx.RegisterModuleType("java_binary", BinaryFactory)
70 ctx.RegisterModuleType("java_binary_host", BinaryHostFactory)
71 ctx.RegisterModuleType("java_test", TestFactory)
72 ctx.RegisterModuleType("java_test_helper_library", TestHelperLibraryFactory)
73 ctx.RegisterModuleType("java_test_host", TestHostFactory)
Paul Duffin1b82e6a2019-12-03 18:06:47 +000074 ctx.RegisterModuleType("java_test_import", JavaTestImportFactory)
Paul Duffinf9b1da02019-12-18 19:51:55 +000075 ctx.RegisterModuleType("java_import", ImportFactory)
76 ctx.RegisterModuleType("java_import_host", ImportFactoryHost)
77 ctx.RegisterModuleType("java_device_for_host", DeviceForHostFactory)
78 ctx.RegisterModuleType("java_host_for_device", HostForDeviceFactory)
79 ctx.RegisterModuleType("dex_import", DexImportFactory)
80
Martin Stjernholm6d415272020-01-31 17:10:36 +000081 ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) {
82 ctx.BottomUp("dexpreopt_tool_deps", dexpreoptToolDepsMutator).Parallel()
83 })
Martin Stjernholmd90676f2020-01-11 00:37:30 +000084
Paul Duffinf9b1da02019-12-18 19:51:55 +000085 ctx.RegisterSingletonType("logtags", LogtagsSingleton)
86 ctx.RegisterSingletonType("kythe_java_extract", kytheExtractJavaFactory)
87}
88
Artur Satayev8cf899a2020-04-15 17:29:42 +010089func (j *Module) CheckStableSdkVersion() error {
90 sdkVersion := j.sdkVersion()
91 if sdkVersion.stable() {
92 return nil
93 }
94 return fmt.Errorf("non stable SDK %v", sdkVersion)
95}
96
Artur Satayev2db1c3f2020-04-08 19:09:30 +010097func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
Colin Crossc2d24052020-05-13 11:05:02 -070098 if j.RequiresStableAPIs(ctx) {
Jeongik Cha2cc570d2019-10-29 15:44:45 +090099 if sc, ok := ctx.Module().(sdkContext); ok {
Jiyong Park6a927c42020-01-21 02:03:43 +0900100 if !sc.sdkVersion().specified() {
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900101 ctx.PropertyErrorf("sdk_version",
102 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
103 }
104 }
105 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100106
107 ctx.VisitDirectDeps(func(module android.Module) {
108 tag := ctx.OtherModuleDependencyTag(module)
109 switch module.(type) {
110 // TODO(satayev): cover other types as well, e.g. imports
111 case *Library, *AndroidLibrary:
112 switch tag {
113 case bootClasspathTag, libTag, staticLibTag, java9LibTag:
114 checkLinkType(ctx, j, module.(linkTypeContext), tag.(dependencyTag))
115 }
116 }
117 })
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900118}
119
Jeongik Cha538c0d02019-07-11 15:54:27 +0900120func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
121 if sc, ok := ctx.Module().(sdkContext); ok {
122 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park6a927c42020-01-21 02:03:43 +0900123 sdkVersionSpecified := sc.sdkVersion().specified()
124 if usePlatformAPI && sdkVersionSpecified {
125 ctx.PropertyErrorf("platform_apis", "platform_apis must be false when sdk_version is not empty.")
126 } else if !usePlatformAPI && !sdkVersionSpecified {
127 ctx.PropertyErrorf("platform_apis", "platform_apis must be true when sdk_version is empty.")
Jeongik Cha538c0d02019-07-11 15:54:27 +0900128 }
129
130 }
131}
132
Colin Cross2fe66872015-03-30 17:20:39 -0700133// TODO:
134// Autogenerated files:
Colin Cross2fe66872015-03-30 17:20:39 -0700135// Renderscript
136// Post-jar passes:
137// Proguard
Colin Cross2fe66872015-03-30 17:20:39 -0700138// Rmtypedefs
Colin Cross2fe66872015-03-30 17:20:39 -0700139// DroidDoc
140// Findbugs
141
Colin Cross89536d42017-07-07 14:35:50 -0700142type CompilerProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -0700143 // list of source files used to compile the Java module. May be .java, .logtags, .proto,
144 // or .aidl files.
Colin Cross27b922f2019-03-04 22:35:41 -0800145 Srcs []string `android:"path,arch_variant"`
Dan Willemsen2ef08f42015-06-30 18:15:24 -0700146
147 // list of source files that should not be used to build the Java module.
148 // This is most useful in the arch/multilib variants to remove non-common files
Colin Cross27b922f2019-03-04 22:35:41 -0800149 Exclude_srcs []string `android:"path,arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700150
151 // list of directories containing Java resources
Colin Cross86a63ff2017-09-27 17:33:10 -0700152 Java_resource_dirs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700153
Colin Cross86a63ff2017-09-27 17:33:10 -0700154 // list of directories that should be excluded from java_resource_dirs
155 Exclude_java_resource_dirs []string `android:"arch_variant"`
Dan Willemsen2ef08f42015-06-30 18:15:24 -0700156
Colin Cross0f37af02017-09-27 17:42:05 -0700157 // list of files to use as Java resources
Colin Cross27b922f2019-03-04 22:35:41 -0800158 Java_resources []string `android:"path,arch_variant"`
Colin Cross0f37af02017-09-27 17:42:05 -0700159
Colin Crosscedd4762018-09-13 11:26:19 -0700160 // list of files that should be excluded from java_resources and java_resource_dirs
Colin Cross27b922f2019-03-04 22:35:41 -0800161 Exclude_java_resources []string `android:"path,arch_variant"`
Colin Cross0f37af02017-09-27 17:42:05 -0700162
Colin Cross7d5136f2015-05-11 13:39:40 -0700163 // list of module-specific flags that will be used for javac compiles
164 Javacflags []string `android:"arch_variant"`
165
Zoran Jovanovic8736ce22018-08-21 17:10:29 +0200166 // list of module-specific flags that will be used for kotlinc compiles
167 Kotlincflags []string `android:"arch_variant"`
168
Colin Cross7d5136f2015-05-11 13:39:40 -0700169 // list of of java libraries that will be in the classpath
Colin Crosse8dc34a2017-07-19 11:22:16 -0700170 Libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700171
172 // list of java libraries that will be compiled into the resulting jar
Colin Crosse8dc34a2017-07-19 11:22:16 -0700173 Static_libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700174
175 // manifest file to be included in resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -0800176 Manifest *string `android:"path"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700177
Colin Cross540eff82017-06-22 17:01:52 -0700178 // if not blank, run jarjar using the specified rules file
Colin Cross27b922f2019-03-04 22:35:41 -0800179 Jarjar_rules *string `android:"path,arch_variant"`
Colin Cross64162712017-08-08 13:17:59 -0700180
181 // If not blank, set the java version passed to javac as -source and -target
182 Java_version *string
Colin Cross2c429dc2017-08-31 16:45:16 -0700183
Colin Cross9ae1b922018-06-26 17:59:05 -0700184 // If set to true, allow this module to be dexed and installed on devices. Has no
185 // effect on host modules, which are always considered installable.
Colin Cross2c429dc2017-08-31 16:45:16 -0700186 Installable *bool
Colin Cross32f676a2017-09-06 13:41:06 -0700187
Colin Cross0f37af02017-09-27 17:42:05 -0700188 // If set to true, include sources used to compile the module in to the final jar
189 Include_srcs *bool
190
Vladimir Marko0975ee02019-04-02 10:29:55 +0100191 // If not empty, classes are restricted to the specified packages and their sub-packages.
192 // This restriction is checked after applying jarjar rules and including static libs.
193 Permitted_packages []string
194
Colin Crossbe9cdb82019-01-21 21:37:16 -0800195 // List of modules to use as annotation processors
196 Plugins []string
Colin Cross1369cdb2017-09-29 17:58:17 -0700197
Artur Satayev9cf46692019-11-26 18:08:34 +0000198 // List of modules to export to libraries that directly depend on this library as annotation processors
199 Exported_plugins []string
200
Nan Zhang61eaedb2017-11-02 13:28:15 -0700201 // The number of Java source entries each Javac instance can process
202 Javac_shard_size *int64
203
Nan Zhang5f8cb422018-02-06 10:34:32 -0800204 // Add host jdk tools.jar to bootclasspath
205 Use_tools_jar *bool
206
Colin Cross1369cdb2017-09-29 17:58:17 -0700207 Openjdk9 struct {
Colin Cross6cef4812019-10-17 14:23:50 -0700208 // List of source files that should only be used when passing -source 1.9 or higher
Colin Cross27b922f2019-03-04 22:35:41 -0800209 Srcs []string `android:"path"`
Colin Cross1369cdb2017-09-29 17:58:17 -0700210
Colin Cross6cef4812019-10-17 14:23:50 -0700211 // List of javac flags that should only be used when passing -source 1.9 or higher
Colin Cross1369cdb2017-09-29 17:58:17 -0700212 Javacflags []string
213 }
Colin Crosscb933592017-11-22 13:49:43 -0800214
Colin Cross81440082018-08-15 20:21:55 -0700215 // When compiling language level 9+ .java code in packages that are part of
216 // a system module, patch_module names the module that your sources and
217 // dependencies should be patched into. The Android runtime currently
218 // doesn't implement the JEP 261 module system so this option is only
219 // supported at compile time. It should only be needed to compile tests in
220 // packages that exist in libcore and which are inconvenient to move
221 // elsewhere.
Tobias Thiererdda713d2018-09-19 16:16:19 +0100222 Patch_module *string `android:"arch_variant"`
Colin Cross81440082018-08-15 20:21:55 -0700223
Colin Crosscb933592017-11-22 13:49:43 -0800224 Jacoco struct {
225 // List of classes to include for instrumentation with jacoco to collect coverage
226 // information at runtime when building with coverage enabled. If unset defaults to all
227 // classes.
228 // Supports '*' as the last character of an entry in the list as a wildcard match.
229 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
230 // it matches classes in the package that have the class name as a prefix.
231 Include_filter []string
232
233 // List of classes to exclude from instrumentation with jacoco to collect coverage
234 // information at runtime when building with coverage enabled. Overrides classes selected
235 // by the include_filter property.
236 // Supports '*' as the last character of an entry in the list as a wildcard match.
237 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
238 // it matches classes in the package that have the class name as a prefix.
239 Exclude_filter []string
240 }
241
Andreas Gampef3e5b552018-01-22 21:27:21 -0800242 Errorprone struct {
243 // List of javac flags that should only be used when running errorprone.
244 Javacflags []string
245 }
246
Colin Cross0f2ee152017-12-14 15:22:43 -0800247 Proto struct {
248 // List of extra options that will be passed to the proto generator.
249 Output_params []string
250 }
251
Colin Crosscb933592017-11-22 13:49:43 -0800252 Instrument bool `blueprint:"mutated"`
Alex Light7f004a72019-02-21 13:27:37 -0800253
254 // List of files to include in the META-INF/services folder of the resulting jar.
Colin Cross27b922f2019-03-04 22:35:41 -0800255 Services []string `android:"path,arch_variant"`
Colin Cross540eff82017-06-22 17:01:52 -0700256}
257
Colin Cross89536d42017-07-07 14:35:50 -0700258type CompilerDeviceProperties struct {
Colin Cross540eff82017-06-22 17:01:52 -0700259 // list of module-specific flags that will be used for dex compiles
260 Dxflags []string `android:"arch_variant"`
261
Jeongik Cha538c0d02019-07-11 15:54:27 +0900262 // if not blank, set to the version of the sdk to compile against.
263 // Defaults to compiling against the current platform.
Nan Zhangea568a42017-11-08 21:20:04 -0800264 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700265
Colin Cross83bb3162018-06-25 15:48:06 -0700266 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
267 // Defaults to sdk_version if not set.
268 Min_sdk_version *string
269
Dan Willemsen419290a2018-10-31 15:28:47 -0700270 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
271 // Defaults to sdk_version if not set.
272 Target_sdk_version *string
273
Jeongik Cha356dac42019-08-19 14:09:52 +0900274 // Whether to compile against the platform APIs instead of an SDK.
275 // If true, then sdk_version must be empty. The value of this field
276 // is ignored when module's type isn't android_app.
Colin Cross6af2e492018-05-22 11:12:33 -0700277 Platform_apis *bool
278
Colin Crossebe1a512017-11-14 13:12:14 -0800279 Aidl struct {
280 // Top level directories to pass to aidl tool
281 Include_dirs []string
Colin Cross7d5136f2015-05-11 13:39:40 -0700282
Colin Crossebe1a512017-11-14 13:12:14 -0800283 // Directories rooted at the Android.bp file to pass to aidl tool
284 Local_include_dirs []string
285
286 // directories that should be added as include directories for any aidl sources of modules
287 // that depend on this module, as well as to aidl for this module.
288 Export_include_dirs []string
Martijn Coeneneab15642018-03-09 09:29:59 +0100289
290 // whether to generate traces (for systrace) for this interface
291 Generate_traces *bool
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100292
293 // whether to generate Binder#GetTransaction name method.
294 Generate_get_transaction_name *bool
Colin Crossebe1a512017-11-14 13:12:14 -0800295 }
Colin Cross92430102017-10-09 14:59:32 -0700296
297 // If true, export a copy of the module as a -hostdex module for host testing.
298 Hostdex *bool
Colin Cross1369cdb2017-09-29 17:58:17 -0700299
Colin Cross7f87f4f2019-04-24 13:41:45 -0700300 Target struct {
301 Hostdex struct {
302 // Additional required dependencies to add to -hostdex modules.
303 Required []string
304 }
305 }
306
David Brazdil17ef5632018-06-27 10:27:45 +0100307 // If set to true, compile dex regardless of installable. Defaults to false.
308 Compile_dex *bool
309
Colin Cross66dbc0b2017-12-28 12:23:20 -0800310 Optimize struct {
Colin Crossae5caf52018-05-22 11:11:52 -0700311 // If false, disable all optimization. Defaults to true for android_app and android_test
312 // modules, false for java_library and java_test modules.
Colin Cross66dbc0b2017-12-28 12:23:20 -0800313 Enabled *bool
Sasha Smundak2057f822019-04-16 17:16:58 -0700314 // True if the module containing this has it set by default.
315 EnabledByDefault bool `blueprint:"mutated"`
Colin Cross66dbc0b2017-12-28 12:23:20 -0800316
317 // If true, optimize for size by removing unused code. Defaults to true for apps,
318 // false for libraries and tests.
319 Shrink *bool
320
321 // If true, optimize bytecode. Defaults to false.
322 Optimize *bool
323
324 // If true, obfuscate bytecode. Defaults to false.
325 Obfuscate *bool
326
327 // If true, do not use the flag files generated by aapt that automatically keep
328 // classes referenced by the app manifest. Defaults to false.
329 No_aapt_flags *bool
330
331 // Flags to pass to proguard.
332 Proguard_flags []string
333
334 // Specifies the locations of files containing proguard flags.
Colin Cross27b922f2019-03-04 22:35:41 -0800335 Proguard_flags_files []string `android:"path"`
Colin Cross66dbc0b2017-12-28 12:23:20 -0800336 }
337
Paul Duffine25c6442019-10-11 13:50:28 +0100338 // When targeting 1.9 and above, override the modules to use with --system,
339 // otherwise provides defaults libraries to add to the bootclasspath.
Colin Cross1369cdb2017-09-29 17:58:17 -0700340 System_modules *string
Colin Cross5a0dcd52018-10-05 14:20:06 -0700341
Jiyong Park4c4c0242019-10-21 14:53:15 +0900342 // set the name of the output
343 Stem *string
344
David Srbeckye033cba2020-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"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700352}
353
Sasha Smundak2057f822019-04-16 17:16:58 -0700354func (me *CompilerDeviceProperties) EffectiveOptimizeEnabled() bool {
355 return BoolDefault(me.Optimize.Enabled, me.Optimize.EnabledByDefault)
356}
357
Paul Duffin0d3c2e12020-05-17 08:34:50 +0100358// Functionality common to Module and Import
Paul Duffin859fe962020-05-15 10:20:31 +0100359//
360// It is embedded in Module so its functionality can be used by methods in Module
361// but it is currently only initialized by Import and Library.
Paul Duffin0d3c2e12020-05-17 08:34:50 +0100362type embeddableInModuleAndImport struct {
Paul Duffin859fe962020-05-15 10:20:31 +0100363
364 // Functionality related to this being used as a component of a java_sdk_library.
365 EmbeddableSdkLibraryComponent
366}
367
368func (e *embeddableInModuleAndImport) initModuleAndImport(moduleBase *android.ModuleBase) {
369 e.initSdkLibraryComponent(moduleBase)
Paul Duffin0d3c2e12020-05-17 08:34:50 +0100370}
371
372// Module/Import's DepIsInSameApex(...) delegates to this method.
373//
374// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
375// the one provided by ApexModuleBase.
376func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
377 // dependencies other than the static linkage are all considered crossing APEX boundary
378 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
379 return true
380 }
381 return false
382}
383
Colin Cross46c9b8b2017-06-22 16:51:17 -0700384// Module contains the properties and members used by all java module types
385type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700386 android.ModuleBase
Colin Cross89536d42017-07-07 14:35:50 -0700387 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +0900388 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900389 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -0700390
Paul Duffin0d3c2e12020-05-17 08:34:50 +0100391 // Functionality common to Module and Import.
392 embeddableInModuleAndImport
393
Colin Cross89536d42017-07-07 14:35:50 -0700394 properties CompilerProperties
Colin Cross6af17aa2017-09-20 12:59:05 -0700395 protoProperties android.ProtoProperties
Colin Cross89536d42017-07-07 14:35:50 -0700396 deviceProperties CompilerDeviceProperties
Colin Cross2fe66872015-03-30 17:20:39 -0700397
Colin Cross331a1212018-08-15 20:40:52 -0700398 // jar file containing header classes including static library dependencies, suitable for
399 // inserting into the bootclasspath/classpath of another compile
Nan Zhanged19fc32017-10-19 13:06:22 -0700400 headerJarFile android.Path
401
Colin Cross331a1212018-08-15 20:40:52 -0700402 // jar file containing implementation classes including static library dependencies but no
403 // resources
Nan Zhanged19fc32017-10-19 13:06:22 -0700404 implementationJarFile android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700405
Colin Cross331a1212018-08-15 20:40:52 -0700406 // jar file containing only resources including from static library dependencies
407 resourceJar android.Path
408
Colin Cross0c4ce212019-05-03 15:28:19 -0700409 // args and dependencies to package source files into a srcjar
410 srcJarArgs []string
411 srcJarDeps android.Paths
412
Colin Cross331a1212018-08-15 20:40:52 -0700413 // jar file containing implementation classes and resources including static library
414 // dependencies
415 implementationAndResourcesJar android.Path
416
417 // output file containing classes.dex and resources
Colin Cross6ade34f2017-09-15 13:00:47 -0700418 dexJarFile android.Path
419
Colin Cross43f08db2018-11-12 10:13:39 -0800420 // output file that contains classes.dex if it should be in the output file
421 maybeStrippedDexJarFile android.Path
422
Colin Crosscb933592017-11-22 13:49:43 -0800423 // output file containing uninstrumented classes that will be instrumented by jacoco
424 jacocoReportClassesFile android.Path
425
Colin Cross66dbc0b2017-12-28 12:23:20 -0800426 // output file containing mapping of obfuscated names
427 proguardDictionary android.Path
428
Colin Cross331a1212018-08-15 20:40:52 -0700429 // output file of the module, which may be a classes jar or a dex jar
Colin Crosse560c4a2019-03-19 16:03:11 -0700430 outputFile android.Path
431 extraOutputFiles android.Paths
Colin Crossb7a63242015-04-16 14:09:14 -0700432
Colin Cross635c3b02016-05-18 15:37:25 -0700433 exportAidlIncludeDirs android.Paths
Colin Crossc0b06f12015-04-08 13:03:43 -0700434
Colin Cross635c3b02016-05-18 15:37:25 -0700435 logtagsSrcs android.Paths
Colin Crossf05fe972015-04-10 17:45:20 -0700436
Colin Cross2fe66872015-03-30 17:20:39 -0700437 // installed file for binary dependency
Colin Cross635c3b02016-05-18 15:37:25 -0700438 installFile android.Path
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800439
440 // list of .java files and srcjars that was passed to javac
441 compiledJavaSrcs android.Paths
442 compiledSrcJars android.Paths
Colin Cross66dbc0b2017-12-28 12:23:20 -0800443
444 // list of extra progurad flag files
445 extraProguardFlagFiles android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900446
Colin Cross094054a2018-10-17 15:10:48 -0700447 // manifest file to use instead of properties.Manifest
448 overrideManifest android.OptionalPath
449
Artur Satayev9cf46692019-11-26 18:08:34 +0000450 // list of SDK lib names that this java module is exporting
Jiyong Park1be96912018-05-28 18:02:19 +0900451 exportedSdkLibs []string
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700452
Artur Satayev9cf46692019-11-26 18:08:34 +0000453 // list of plugins that this java module is exporting
454 exportedPluginJars android.Paths
455
456 // list of plugins that this java module is exporting
457 exportedPluginClasses []string
458
459 // list of source files, collected from srcFiles with unique java and all kt files,
patricktu242faad2019-09-24 15:41:30 +0800460 // will be used by android.IDEInfo struct
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700461 expandIDEInfoCompiledSrcs []string
Colin Cross43f08db2018-11-12 10:13:39 -0800462
Steven Morelandc4efd9c2019-01-18 11:51:25 -0800463 // expanded Jarjar_rules
464 expandJarjarRules android.Path
465
Vladimir Marko0975ee02019-04-02 10:29:55 +0100466 // list of additional targets for checkbuild
467 additionalCheckedModules android.Paths
468
Colin Cross988708c2019-05-06 14:04:11 -0700469 // Extra files generated by the module type to be added as java resources.
470 extraResources android.Paths
471
Colin Crossf24a22a2019-01-31 14:12:44 -0800472 hiddenAPI
Colin Cross43f08db2018-11-12 10:13:39 -0800473 dexpreopter
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800474
475 // list of the xref extraction files
476 kytheFiles android.Paths
Anton Hansson78156ef2020-03-27 19:39:48 +0000477
478 distFile android.Path
bralee1fbf4402020-05-21 10:11:59 +0800479
480 // Collect the module directory for IDE info in java/jdeps.go.
481 modulePaths []string
Colin Cross2fe66872015-03-30 17:20:39 -0700482}
483
Colin Cross41955e82019-05-29 14:40:35 -0700484func (j *Module) OutputFiles(tag string) (android.Paths, error) {
485 switch tag {
486 case "":
487 return append(android.Paths{j.outputFile}, j.extraOutputFiles...), nil
Colin Cross375ca3c2019-05-29 14:40:58 -0700488 case ".jar":
489 return android.Paths{j.implementationAndResourcesJar}, nil
Colin Cross2d975b12019-07-29 16:47:42 -0700490 case ".proguard_map":
491 return android.Paths{j.proguardDictionary}, nil
Colin Cross41955e82019-05-29 14:40:35 -0700492 default:
493 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
494 }
Colin Cross54250902017-12-05 09:28:08 -0800495}
496
Colin Cross41955e82019-05-29 14:40:35 -0700497var _ android.OutputFileProducer = (*Module)(nil)
Colin Cross54250902017-12-05 09:28:08 -0800498
Colin Crossf506d872017-07-19 15:53:04 -0700499type Dependency interface {
Nan Zhanged19fc32017-10-19 13:06:22 -0700500 HeaderJars() android.Paths
501 ImplementationJars() android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700502 ResourceJars() android.Paths
503 ImplementationAndResourcesJars() android.Paths
Colin Crossf24a22a2019-01-31 14:12:44 -0800504 DexJar() android.Path
Colin Cross635c3b02016-05-18 15:37:25 -0700505 AidlIncludeDirs() android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900506 ExportedSdkLibs() []string
Artur Satayev9cf46692019-11-26 18:08:34 +0000507 ExportedPlugins() (android.Paths, []string)
Colin Cross0c4ce212019-05-03 15:28:19 -0700508 SrcJarArgs() ([]string, android.Paths)
Colin Crosse323f3c2019-09-17 15:34:09 -0700509 BaseModuleName() string
Jiyong Park618922e2020-01-08 13:35:43 +0900510 JacocoReportClassesFile() android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700511}
512
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800513type xref interface {
514 XrefJavaFiles() android.Paths
515}
516
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800517func (j *Module) XrefJavaFiles() android.Paths {
518 return j.kytheFiles
519}
520
Colin Cross89536d42017-07-07 14:35:50 -0700521func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
522 android.InitAndroidArchModule(module, hod, android.MultilibCommon)
523 android.InitDefaultableModule(module)
524}
525
Colin Crossbe1da472017-07-07 15:59:46 -0700526type dependencyTag struct {
527 blueprint.BaseDependencyTag
528 name string
Colin Cross2fe66872015-03-30 17:20:39 -0700529}
530
Colin Crossa4f08812018-10-02 22:03:40 -0700531type jniDependencyTag struct {
532 blueprint.BaseDependencyTag
Colin Crossa4f08812018-10-02 22:03:40 -0700533}
534
Jiyong Park8be103b2019-11-08 15:53:48 +0900535func IsJniDepTag(depTag blueprint.DependencyTag) bool {
536 _, ok := depTag.(*jniDependencyTag)
537 return ok
538}
539
Colin Crossbe1da472017-07-07 15:59:46 -0700540var (
Colin Cross4b964c02018-10-15 16:18:06 -0700541 staticLibTag = dependencyTag{name: "staticlib"}
542 libTag = dependencyTag{name: "javalib"}
Colin Cross6cef4812019-10-17 14:23:50 -0700543 java9LibTag = dependencyTag{name: "java9lib"}
Colin Crossbe9cdb82019-01-21 21:37:16 -0800544 pluginTag = dependencyTag{name: "plugin"}
Artur Satayev9cf46692019-11-26 18:08:34 +0000545 exportedPluginTag = dependencyTag{name: "exported-plugin"}
Colin Cross4b964c02018-10-15 16:18:06 -0700546 bootClasspathTag = dependencyTag{name: "bootclasspath"}
547 systemModulesTag = dependencyTag{name: "system modules"}
548 frameworkResTag = dependencyTag{name: "framework-res"}
549 frameworkApkTag = dependencyTag{name: "framework-apk"}
550 kotlinStdlibTag = dependencyTag{name: "kotlin-stdlib"}
Colin Crossafbb1732019-01-17 15:42:52 -0800551 kotlinAnnotationsTag = dependencyTag{name: "kotlin-annotations"}
Colin Cross4b964c02018-10-15 16:18:06 -0700552 proguardRaiseTag = dependencyTag{name: "proguard-raise"}
553 certificateTag = dependencyTag{name: "certificate"}
554 instrumentationForTag = dependencyTag{name: "instrumentation_for"}
Colin Cross50ddcc42019-05-16 12:28:22 -0700555 usesLibTag = dependencyTag{name: "uses-library"}
Colin Crossbe1da472017-07-07 15:59:46 -0700556)
Colin Cross2fe66872015-03-30 17:20:39 -0700557
Jiyong Park83dc74b2020-01-14 18:38:44 +0900558func IsLibDepTag(depTag blueprint.DependencyTag) bool {
559 return depTag == libTag
560}
561
562func IsStaticLibDepTag(depTag blueprint.DependencyTag) bool {
563 return depTag == staticLibTag
564}
565
Colin Crossfc3674a2017-09-18 17:41:52 -0700566type sdkDep struct {
Colin Cross47ff2522017-10-02 14:22:08 -0700567 useModule, useFiles, useDefaultLibs, invalidVersion bool
568
Colin Cross6cef4812019-10-17 14:23:50 -0700569 // The modules that will be added to the bootclasspath when targeting 1.8 or lower
570 bootclasspath []string
Paul Duffine25c6442019-10-11 13:50:28 +0100571
572 // The default system modules to use. Will be an empty string if no system
573 // modules are to be used.
Colin Cross1369cdb2017-09-29 17:58:17 -0700574 systemModules string
575
Colin Cross6cef4812019-10-17 14:23:50 -0700576 // The modules that will be added ot the classpath when targeting 1.9 or higher
577 java9Classpath []string
578
Colin Crossa97c5d32018-03-28 14:58:31 -0700579 frameworkResModule string
580
Colin Cross86a60ae2018-05-29 14:44:55 -0700581 jars android.Paths
Colin Cross3047fa22019-04-18 10:56:44 -0700582 aidl android.OptionalPath
Paul Duffin250e6192019-06-07 10:44:37 +0100583
584 noStandardLibs, noFrameworksLibs bool
585}
586
587func (s sdkDep) hasStandardLibs() bool {
588 return !s.noStandardLibs
589}
590
591func (s sdkDep) hasFrameworkLibs() bool {
592 return !s.noStandardLibs && !s.noFrameworksLibs
Colin Cross1369cdb2017-09-29 17:58:17 -0700593}
594
Colin Crossa4f08812018-10-02 22:03:40 -0700595type jniLib struct {
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700596 name string
597 path android.Path
598 target android.Target
599 coverageFile android.OptionalPath
Colin Crossa4f08812018-10-02 22:03:40 -0700600}
601
Colin Cross0ea8ba82019-06-06 14:33:29 -0700602func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800603 return j.properties.Instrument && ctx.Config().IsEnvTrue("EMMA_INSTRUMENT")
604}
605
Colin Cross0ea8ba82019-06-06 14:33:29 -0700606func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800607 return j.shouldInstrument(ctx) &&
608 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
609 ctx.Config().UnbundledBuild())
610}
611
Jiyong Park6a927c42020-01-21 02:03:43 +0900612func (j *Module) sdkVersion() sdkSpec {
613 return sdkSpecFrom(String(j.deviceProperties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -0700614}
615
Paul Duffine25c6442019-10-11 13:50:28 +0100616func (j *Module) systemModules() string {
617 return proptools.String(j.deviceProperties.System_modules)
618}
619
Jiyong Park6a927c42020-01-21 02:03:43 +0900620func (j *Module) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -0700621 if j.deviceProperties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900622 return sdkSpecFrom(*j.deviceProperties.Min_sdk_version)
Colin Cross83bb3162018-06-25 15:48:06 -0700623 }
624 return j.sdkVersion()
625}
626
Jiyong Park6a927c42020-01-21 02:03:43 +0900627func (j *Module) targetSdkVersion() sdkSpec {
Dan Willemsen419290a2018-10-31 15:28:47 -0700628 if j.deviceProperties.Target_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900629 return sdkSpecFrom(*j.deviceProperties.Target_sdk_version)
Dan Willemsen419290a2018-10-31 15:28:47 -0700630 }
631 return j.sdkVersion()
632}
633
Artur Satayev480e25b2020-04-27 18:53:18 +0100634func (j *Module) MinSdkVersion() string {
635 return j.minSdkVersion().version.String()
636}
637
Jiyong Parkb02bb402019-12-03 00:43:57 +0900638func (j *Module) AvailableFor(what string) bool {
639 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
640 // Exception: for hostdex: true libraries, the platform variant is created
641 // even if it's not marked as available to platform. In that case, the platform
642 // variant is used only for the hostdex and not installed to the device.
643 return true
644 }
645 return j.ApexModuleBase.AvailableFor(what)
646}
647
Colin Crossbe1da472017-07-07 15:59:46 -0700648func (j *Module) deps(ctx android.BottomUpMutatorContext) {
Colin Cross1369cdb2017-09-29 17:58:17 -0700649 if ctx.Device() {
Paul Duffin250e6192019-06-07 10:44:37 +0100650 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross6d8d8c62019-10-28 15:10:03 -0700651 if sdkDep.useDefaultLibs {
652 ctx.AddVariationDependencies(nil, bootClasspathTag, config.DefaultBootclasspathLibraries...)
653 ctx.AddVariationDependencies(nil, systemModulesTag, config.DefaultSystemModules)
654 if sdkDep.hasFrameworkLibs() {
655 ctx.AddVariationDependencies(nil, libTag, config.DefaultLibraries...)
Colin Crossbe1da472017-07-07 15:59:46 -0700656 }
Colin Cross6d8d8c62019-10-28 15:10:03 -0700657 } else if sdkDep.useModule {
Colin Cross6cef4812019-10-17 14:23:50 -0700658 ctx.AddVariationDependencies(nil, bootClasspathTag, sdkDep.bootclasspath...)
Colin Cross6cef4812019-10-17 14:23:50 -0700659 ctx.AddVariationDependencies(nil, java9LibTag, sdkDep.java9Classpath...)
Colin Cross6d8d8c62019-10-28 15:10:03 -0700660 if j.deviceProperties.EffectiveOptimizeEnabled() && sdkDep.hasStandardLibs() {
661 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultBootclasspathLibraries...)
662 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultLibraries...)
663 }
Colin Cross2fe66872015-03-30 17:20:39 -0700664 }
Colin Cross17dec172020-05-14 18:05:32 -0700665 if sdkDep.systemModules != "" {
666 ctx.AddVariationDependencies(nil, systemModulesTag, sdkDep.systemModules)
667 }
Colin Cross6d8d8c62019-10-28 15:10:03 -0700668
Nan Zhangb2b33de2018-02-23 11:18:47 -0800669 if ctx.ModuleName() == "android_stubs_current" ||
670 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -0700671 ctx.ModuleName() == "android_test_stubs_current" {
Colin Cross42d48b72018-08-29 14:10:52 -0700672 ctx.AddVariationDependencies(nil, frameworkApkTag, "framework-res")
Nan Zhangb2b33de2018-02-23 11:18:47 -0800673 }
Colin Cross2fe66872015-03-30 17:20:39 -0700674 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700675
Inseob Kimac1e9862019-12-09 18:15:47 +0900676 syspropPublicStubs := syspropPublicStubs(ctx.Config())
677
678 // rewriteSyspropLibs validates if a java module can link against platform's sysprop_library,
679 // and redirects dependency to public stub depending on the link type.
680 rewriteSyspropLibs := func(libs []string, prop string) []string {
681 // make a copy
682 ret := android.CopyOf(libs)
683
684 for idx, lib := range libs {
685 stub, ok := syspropPublicStubs[lib]
686
687 if !ok {
688 continue
689 }
690
691 linkType, _ := j.getLinkType(ctx.ModuleName())
Inseob Kimc5239512020-01-14 15:36:21 +0900692 // only platform modules can use internal props
693 if linkType != javaPlatform {
Inseob Kimac1e9862019-12-09 18:15:47 +0900694 ret[idx] = stub
Inseob Kimac1e9862019-12-09 18:15:47 +0900695 }
696 }
697
698 return ret
699 }
700
701 ctx.AddVariationDependencies(nil, libTag, rewriteSyspropLibs(j.properties.Libs, "libs")...)
702 ctx.AddVariationDependencies(nil, staticLibTag, rewriteSyspropLibs(j.properties.Static_libs, "static_libs")...)
Colin Crossa4f08812018-10-02 22:03:40 -0700703
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700704 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000705 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800706
Colin Crossfe17f6f2019-03-28 19:30:56 -0700707 android.ProtoDeps(ctx, &j.protoProperties)
Colin Cross6af17aa2017-09-20 12:59:05 -0700708 if j.hasSrcExt(".proto") {
709 protoDeps(ctx, &j.protoProperties)
710 }
Colin Cross93e85952017-08-15 13:34:18 -0700711
712 if j.hasSrcExt(".kt") {
713 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
714 // Kotlin files
Colin Cross0b03d972019-05-13 11:06:25 -0700715 ctx.AddVariationDependencies(nil, kotlinStdlibTag,
716 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8")
Colin Cross7788c122019-01-23 16:14:02 -0800717 if len(j.properties.Plugins) > 0 {
Colin Crossafbb1732019-01-17 15:42:52 -0800718 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
719 }
Colin Cross93e85952017-08-15 13:34:18 -0700720 }
Colin Cross3144dfc2018-01-03 15:06:47 -0800721
Ulya Trafimovich38dfa0f2020-01-07 16:37:02 +0000722 // Framework libraries need special handling in static coverage builds: they should not have
723 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
724 // the same jacoco classes coming from different bootclasspath jars.
725 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
726 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
727 j.properties.Instrument = true
728 }
729 } else if j.shouldInstrumentStatic(ctx) {
Colin Cross42d48b72018-08-29 14:10:52 -0700730 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
Colin Cross3144dfc2018-01-03 15:06:47 -0800731 }
Colin Cross6af17aa2017-09-20 12:59:05 -0700732}
733
734func hasSrcExt(srcs []string, ext string) bool {
735 for _, src := range srcs {
736 if filepath.Ext(src) == ext {
737 return true
738 }
739 }
740
741 return false
742}
743
744func (j *Module) hasSrcExt(ext string) bool {
745 return hasSrcExt(j.properties.Srcs, ext)
Colin Cross2fe66872015-03-30 17:20:39 -0700746}
747
Colin Cross46c9b8b2017-06-22 16:51:17 -0700748func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Colin Cross3047fa22019-04-18 10:56:44 -0700749 aidlIncludeDirs android.Paths) (string, android.Paths) {
Colin Crossc0b06f12015-04-08 13:03:43 -0700750
Colin Crossebe1a512017-11-14 13:12:14 -0800751 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
752 aidlIncludes = append(aidlIncludes,
753 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
754 aidlIncludes = append(aidlIncludes,
755 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
Colin Crossc0b06f12015-04-08 13:03:43 -0700756
Colin Cross3047fa22019-04-18 10:56:44 -0700757 var flags []string
758 var deps android.Paths
Steven Moreland667f6882018-07-26 12:55:08 -0700759
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700760 if aidlPreprocess.Valid() {
761 flags = append(flags, "-p"+aidlPreprocess.String())
Colin Cross3047fa22019-04-18 10:56:44 -0700762 deps = append(deps, aidlPreprocess.Path())
763 } else if len(aidlIncludeDirs) > 0 {
Colin Cross635c3b02016-05-18 15:37:25 -0700764 flags = append(flags, android.JoinWithPrefix(aidlIncludeDirs.Strings(), "-I"))
Colin Crossc0b06f12015-04-08 13:03:43 -0700765 }
766
Colin Cross3047fa22019-04-18 10:56:44 -0700767 if len(j.exportAidlIncludeDirs) > 0 {
768 flags = append(flags, android.JoinWithPrefix(j.exportAidlIncludeDirs.Strings(), "-I"))
769 }
770
771 if len(aidlIncludes) > 0 {
772 flags = append(flags, android.JoinWithPrefix(aidlIncludes.Strings(), "-I"))
773 }
774
Colin Cross635c3b02016-05-18 15:37:25 -0700775 flags = append(flags, "-I"+android.PathForModuleSrc(ctx).String())
Colin Cross32f38982018-02-22 11:47:25 -0800776 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Colin Crossd48633a2017-07-13 14:41:17 -0700777 flags = append(flags, "-I"+src.String())
778 }
Colin Crossc0b06f12015-04-08 13:03:43 -0700779
Martijn Coeneneab15642018-03-09 09:29:59 +0100780 if Bool(j.deviceProperties.Aidl.Generate_traces) {
781 flags = append(flags, "-t")
782 }
783
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100784 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
785 flags = append(flags, "--transaction_names")
786 }
787
Colin Cross3047fa22019-04-18 10:56:44 -0700788 return strings.Join(flags, " "), deps
Colin Crossc0b06f12015-04-08 13:03:43 -0700789}
790
Colin Cross32f676a2017-09-06 13:41:06 -0700791type deps struct {
Nan Zhang581fd212018-01-10 16:06:12 -0800792 classpath classpath
Colin Cross6cef4812019-10-17 14:23:50 -0700793 java9Classpath classpath
Nan Zhang581fd212018-01-10 16:06:12 -0800794 bootClasspath classpath
Colin Cross6a77c982018-06-19 22:43:34 -0700795 processorPath classpath
Colin Crossbe9cdb82019-01-21 21:37:16 -0800796 processorClasses []string
Colin Cross6ade34f2017-09-15 13:00:47 -0700797 staticJars android.Paths
Nan Zhanged19fc32017-10-19 13:06:22 -0700798 staticHeaderJars android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700799 staticResourceJars android.Paths
Colin Cross6ade34f2017-09-15 13:00:47 -0700800 aidlIncludeDirs android.Paths
Nan Zhangb2b33de2018-02-23 11:18:47 -0800801 srcs android.Paths
Colin Cross59149b62017-10-16 18:07:29 -0700802 srcJars android.Paths
Colin Crossb77043e2019-07-16 13:57:13 -0700803 systemModules *systemModules
Colin Cross6ade34f2017-09-15 13:00:47 -0700804 aidlPreprocess android.OptionalPath
Colin Cross93e85952017-08-15 13:34:18 -0700805 kotlinStdlib android.Paths
Colin Crossafbb1732019-01-17 15:42:52 -0800806 kotlinAnnotations android.Paths
Colin Crossbe9cdb82019-01-21 21:37:16 -0800807
808 disableTurbine bool
Colin Cross32f676a2017-09-06 13:41:06 -0700809}
Colin Cross2fe66872015-03-30 17:20:39 -0700810
Colin Cross54250902017-12-05 09:28:08 -0800811func checkProducesJars(ctx android.ModuleContext, dep android.SourceFileProducer) {
812 for _, f := range dep.Srcs() {
813 if f.Ext() != ".jar" {
814 ctx.ModuleErrorf("genrule %q must generate files ending with .jar to be used as a libs or static_libs dependency",
815 ctx.OtherModuleName(dep.(blueprint.Module)))
816 }
817 }
818}
819
Jiyong Park2d492942018-03-05 17:44:10 +0900820type linkType int
821
822const (
Jiyong Park50146e92020-01-30 18:00:15 +0900823 // TODO(jiyong) rename these for better readability. Make the allowed
824 // and disallowed link types explicit
Jiyong Park2d492942018-03-05 17:44:10 +0900825 javaCore linkType = iota
826 javaSdk
827 javaSystem
Jiyong Park50146e92020-01-30 18:00:15 +0900828 javaModule
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900829 javaSystemServer
Jiyong Park2d492942018-03-05 17:44:10 +0900830 javaPlatform
831)
832
Jeongik Cha75b83b02019-11-01 15:28:00 +0900833type linkTypeContext interface {
834 android.Module
835 getLinkType(name string) (ret linkType, stubs bool)
836}
837
838func (m *Module) getLinkType(name string) (ret linkType, stubs bool) {
Colin Cross83bb3162018-06-25 15:48:06 -0700839 ver := m.sdkVersion()
Colin Crossf19b9bb2018-03-26 14:42:44 -0700840 switch {
Jiyong Park46f78fb2018-10-20 16:33:17 +0900841 case name == "core.current.stubs" || name == "core.platform.api.stubs" ||
842 name == "stub-annotations" || name == "private-stub-annotations-jar" ||
Pete Gillincbff3262019-05-08 15:10:06 +0100843 name == "core-lambda-stubs" || name == "core-generated-annotation-stubs":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900844 return javaCore, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900845 case ver.kind == sdkCore:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900846 return javaCore, false
847 case name == "android_system_stubs_current":
848 return javaSystem, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900849 case ver.kind == sdkSystem:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900850 return javaSystem, false
851 case name == "android_test_stubs_current":
852 return javaSystem, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900853 case ver.kind == sdkTest:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900854 return javaPlatform, false
855 case name == "android_stubs_current":
856 return javaSdk, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900857 case ver.kind == sdkPublic:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900858 return javaSdk, false
Jiyong Park50146e92020-01-30 18:00:15 +0900859 case name == "android_module_lib_stubs_current":
860 return javaModule, true
861 case ver.kind == sdkModule:
862 return javaModule, false
Anton Hanssonba6ab2e2020-03-19 15:23:38 +0000863 case name == "android_system_server_stubs_current":
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900864 return javaSystemServer, true
865 case ver.kind == sdkSystemServer:
866 return javaSystemServer, false
Jiyong Park6a927c42020-01-21 02:03:43 +0900867 case ver.kind == sdkPrivate || ver.kind == sdkNone || ver.kind == sdkCorePlatform:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900868 return javaPlatform, false
Jiyong Park6a927c42020-01-21 02:03:43 +0900869 case !ver.valid():
870 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.raw))
Colin Crossf19b9bb2018-03-26 14:42:44 -0700871 default:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900872 return javaSdk, false
Jiyong Park2d492942018-03-05 17:44:10 +0900873 }
874}
875
Jeongik Cha75b83b02019-11-01 15:28:00 +0900876func checkLinkType(ctx android.ModuleContext, from *Module, to linkTypeContext, tag dependencyTag) {
Colin Crossf19b9bb2018-03-26 14:42:44 -0700877 if ctx.Host() {
878 return
879 }
880
Jeongik Cha75b83b02019-11-01 15:28:00 +0900881 myLinkType, stubs := from.getLinkType(ctx.ModuleName())
Jiyong Park46f78fb2018-10-20 16:33:17 +0900882 if stubs {
883 return
884 }
Jeongik Cha75b83b02019-11-01 15:28:00 +0900885 otherLinkType, _ := to.getLinkType(ctx.OtherModuleName(to))
Jiyong Park2d492942018-03-05 17:44:10 +0900886 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."
887
888 switch myLinkType {
889 case javaCore:
890 if otherLinkType != javaCore {
891 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 +0900892 ctx.OtherModuleName(to))
893 }
Jiyong Park2d492942018-03-05 17:44:10 +0900894 break
895 case javaSdk:
896 if otherLinkType != javaCore && otherLinkType != javaSdk {
897 ctx.ModuleErrorf("compiles against Android API, but dependency %q is compiling against non-public Android API."+commonMessage,
898 ctx.OtherModuleName(to))
899 }
900 break
901 case javaSystem:
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900902 if otherLinkType == javaPlatform || otherLinkType == javaModule || otherLinkType == javaSystemServer {
Jiyong Park2d492942018-03-05 17:44:10 +0900903 ctx.ModuleErrorf("compiles against system API, but dependency %q is compiling against private API."+commonMessage,
904 ctx.OtherModuleName(to))
905 }
906 break
Jiyong Park50146e92020-01-30 18:00:15 +0900907 case javaModule:
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900908 if otherLinkType == javaPlatform || otherLinkType == javaSystemServer {
Jiyong Park50146e92020-01-30 18:00:15 +0900909 ctx.ModuleErrorf("compiles against module API, but dependency %q is compiling against private API."+commonMessage,
910 ctx.OtherModuleName(to))
911 }
912 break
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900913 case javaSystemServer:
914 if otherLinkType == javaPlatform {
915 ctx.ModuleErrorf("compiles against system server API, but dependency %q is compiling against private API."+commonMessage,
916 ctx.OtherModuleName(to))
917 }
918 break
Jiyong Park2d492942018-03-05 17:44:10 +0900919 case javaPlatform:
920 // no restriction on link-type
921 break
Jiyong Park750e5572018-01-31 00:20:13 +0900922 }
923}
924
Colin Cross32f676a2017-09-06 13:41:06 -0700925func (j *Module) collectDeps(ctx android.ModuleContext) deps {
926 var deps deps
Colin Crossfc3674a2017-09-18 17:41:52 -0700927
Colin Cross300f0382018-03-06 13:11:51 -0800928 if ctx.Device() {
Colin Cross83bb3162018-06-25 15:48:06 -0700929 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross300f0382018-03-06 13:11:51 -0800930 if sdkDep.invalidVersion {
Colin Cross6cef4812019-10-17 14:23:50 -0700931 ctx.AddMissingDependencies(sdkDep.bootclasspath)
932 ctx.AddMissingDependencies(sdkDep.java9Classpath)
Colin Cross300f0382018-03-06 13:11:51 -0800933 } else if sdkDep.useFiles {
934 // sdkDep.jar is actually equivalent to turbine header.jar.
Colin Cross86a60ae2018-05-29 14:44:55 -0700935 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross3047fa22019-04-18 10:56:44 -0700936 deps.aidlPreprocess = sdkDep.aidl
937 } else {
938 deps.aidlPreprocess = sdkDep.aidl
Colin Cross300f0382018-03-06 13:11:51 -0800939 }
Colin Crossfc3674a2017-09-18 17:41:52 -0700940 }
941
Paul Duffin859fe962020-05-15 10:20:31 +0100942 // If this is a component library (stubs, etc.) for a java_sdk_library then
943 // add the name of that java_sdk_library to the exported sdk libs to make sure
944 // that, if necessary, a <uses-library> element for that java_sdk_library is
945 // added to the Android manifest.
946 j.exportedSdkLibs = append(j.exportedSdkLibs, j.OptionalImplicitSdkLibrary()...)
947
Colin Crossd11fcda2017-10-23 17:59:01 -0700948 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross2fe66872015-03-30 17:20:39 -0700949 otherName := ctx.OtherModuleName(module)
Colin Crossec7a0422017-07-07 14:47:12 -0700950 tag := ctx.OtherModuleDependencyTag(module)
951
Colin Crossa4f08812018-10-02 22:03:40 -0700952 if _, ok := tag.(*jniDependencyTag); ok {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700953 // Handled by AndroidApp.collectAppDeps
954 return
955 }
956 if tag == certificateTag {
957 // Handled by AndroidApp.collectAppDeps
Colin Crossa4f08812018-10-02 22:03:40 -0700958 return
959 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100960
Colin Cross54250902017-12-05 09:28:08 -0800961 switch dep := module.(type) {
Colin Cross897d2ed2019-02-11 14:03:51 -0800962 case SdkLibraryDependency:
963 switch tag {
964 case libTag:
965 deps.classpath = append(deps.classpath, dep.SdkHeaderJars(ctx, j.sdkVersion())...)
966 // names of sdk libs that are directly depended are exported
Paul Duffin859fe962020-05-15 10:20:31 +0100967 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.OptionalImplicitSdkLibrary()...)
Colin Cross79c7c262019-04-17 11:11:46 -0700968 case staticLibTag:
Colin Cross897d2ed2019-02-11 14:03:51 -0800969 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
970 }
Colin Cross54250902017-12-05 09:28:08 -0800971 case Dependency:
972 switch tag {
973 case bootClasspathTag:
974 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars()...)
Colin Cross4b964c02018-10-15 16:18:06 -0700975 case libTag, instrumentationForTag:
Colin Cross54250902017-12-05 09:28:08 -0800976 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900977 // sdk lib names from dependencies are re-exported
978 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700979 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000980 pluginJars, pluginClasses := dep.ExportedPlugins()
981 addPlugins(&deps, pluginJars, pluginClasses...)
Colin Cross6cef4812019-10-17 14:23:50 -0700982 case java9LibTag:
983 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars()...)
Colin Cross54250902017-12-05 09:28:08 -0800984 case staticLibTag:
985 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
986 deps.staticJars = append(deps.staticJars, dep.ImplementationJars()...)
987 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars()...)
Colin Cross331a1212018-08-15 20:40:52 -0700988 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900989 // sdk lib names from dependencies are re-exported
990 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700991 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000992 pluginJars, pluginClasses := dep.ExportedPlugins()
993 addPlugins(&deps, pluginJars, pluginClasses...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800994 case pluginTag:
995 if plugin, ok := dep.(*Plugin); ok {
Colin Crossbe9cdb82019-01-21 21:37:16 -0800996 if plugin.pluginProperties.Processor_class != nil {
Artur Satayev9cf46692019-11-26 18:08:34 +0000997 addPlugins(&deps, plugin.ImplementationAndResourcesJars(), *plugin.pluginProperties.Processor_class)
998 } else {
999 addPlugins(&deps, plugin.ImplementationAndResourcesJars())
Colin Crossbe9cdb82019-01-21 21:37:16 -08001000 }
1001 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
1002 } else {
1003 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
1004 }
Artur Satayev9cf46692019-11-26 18:08:34 +00001005 case exportedPluginTag:
1006 if plugin, ok := dep.(*Plugin); ok {
1007 if plugin.pluginProperties.Generates_api != nil && *plugin.pluginProperties.Generates_api {
1008 ctx.PropertyErrorf("exported_plugins", "Cannot export plugins with generates_api = true, found %v", otherName)
1009 }
1010 j.exportedPluginJars = append(j.exportedPluginJars, plugin.ImplementationAndResourcesJars()...)
1011 if plugin.pluginProperties.Processor_class != nil {
1012 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
1013 }
1014 } else {
1015 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
1016 }
Nan Zhangb2b33de2018-02-23 11:18:47 -08001017 case frameworkApkTag:
1018 if ctx.ModuleName() == "android_stubs_current" ||
1019 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -07001020 ctx.ModuleName() == "android_test_stubs_current" {
Nan Zhangb2b33de2018-02-23 11:18:47 -08001021 // framework stubs.jar need to depend on framework-res.apk, in order to pull the
1022 // resource files out of there for aapt.
1023 //
1024 // Normally the package rule runs aapt, which includes the resource,
1025 // but we're not running that in our package rule so just copy in the
1026 // resource files here.
Colin Cross331a1212018-08-15 20:40:52 -07001027 deps.staticResourceJars = append(deps.staticResourceJars, dep.(*AndroidApp).exportPackage)
Nan Zhangb2b33de2018-02-23 11:18:47 -08001028 }
Colin Cross54250902017-12-05 09:28:08 -08001029 case kotlinStdlibTag:
Colin Cross0b03d972019-05-13 11:06:25 -07001030 deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars()...)
Colin Crossafbb1732019-01-17 15:42:52 -08001031 case kotlinAnnotationsTag:
1032 deps.kotlinAnnotations = dep.HeaderJars()
Colin Cross54250902017-12-05 09:28:08 -08001033 }
1034
Colin Cross54250902017-12-05 09:28:08 -08001035 case android.SourceFileProducer:
1036 switch tag {
1037 case libTag:
1038 checkProducesJars(ctx, dep)
1039 deps.classpath = append(deps.classpath, dep.Srcs()...)
1040 case staticLibTag:
1041 checkProducesJars(ctx, dep)
1042 deps.classpath = append(deps.classpath, dep.Srcs()...)
1043 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
1044 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Cross54250902017-12-05 09:28:08 -08001045 }
1046 default:
Colin Crossec7a0422017-07-07 14:47:12 -07001047 switch tag {
Paul Duffin68289b02019-09-20 13:50:52 +01001048 case bootClasspathTag:
1049 // If a system modules dependency has been added to the bootclasspath
1050 // then add its libs to the bootclasspath.
Paul Duffin83a2d962019-11-19 19:44:10 +00001051 sm := module.(SystemModulesProvider)
1052 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars()...)
Paul Duffin68289b02019-09-20 13:50:52 +01001053
Colin Cross1369cdb2017-09-29 17:58:17 -07001054 case systemModulesTag:
1055 if deps.systemModules != nil {
1056 panic("Found two system module dependencies")
1057 }
Paul Duffin83a2d962019-11-19 19:44:10 +00001058 sm := module.(SystemModulesProvider)
1059 outputDir, outputDeps := sm.OutputDirAndDeps()
1060 deps.systemModules = &systemModules{outputDir, outputDeps}
Colin Cross2fe66872015-03-30 17:20:39 -07001061 }
Colin Crossec7a0422017-07-07 14:47:12 -07001062 }
Colin Cross2fe66872015-03-30 17:20:39 -07001063 })
1064
Jiyong Park1be96912018-05-28 18:02:19 +09001065 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
1066
Colin Cross32f676a2017-09-06 13:41:06 -07001067 return deps
Colin Cross2fe66872015-03-30 17:20:39 -07001068}
1069
Artur Satayev9cf46692019-11-26 18:08:34 +00001070func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
1071 deps.processorPath = append(deps.processorPath, pluginJars...)
1072 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
1073}
1074
Colin Cross1e743852019-10-28 11:37:20 -07001075func getJavaVersion(ctx android.ModuleContext, javaVersion string, sdkContext sdkContext) javaVersion {
Nan Zhang357466b2018-04-17 17:38:36 -07001076 if javaVersion != "" {
Colin Cross1e743852019-10-28 11:37:20 -07001077 return normalizeJavaVersion(ctx, javaVersion)
Colin Cross17dec172020-05-14 18:05:32 -07001078 } else if ctx.Device() {
1079 return sdkContext.sdkVersion().defaultJavaLanguageVersion(ctx)
Nan Zhang357466b2018-04-17 17:38:36 -07001080 } else {
Colin Cross1e743852019-10-28 11:37:20 -07001081 return JAVA_VERSION_9
Nan Zhang357466b2018-04-17 17:38:36 -07001082 }
Nan Zhang357466b2018-04-17 17:38:36 -07001083}
1084
Colin Cross1e743852019-10-28 11:37:20 -07001085type javaVersion int
1086
1087const (
1088 JAVA_VERSION_UNSUPPORTED = 0
1089 JAVA_VERSION_6 = 6
1090 JAVA_VERSION_7 = 7
1091 JAVA_VERSION_8 = 8
1092 JAVA_VERSION_9 = 9
1093)
1094
1095func (v javaVersion) String() string {
1096 switch v {
1097 case JAVA_VERSION_6:
1098 return "1.6"
1099 case JAVA_VERSION_7:
1100 return "1.7"
1101 case JAVA_VERSION_8:
1102 return "1.8"
1103 case JAVA_VERSION_9:
1104 return "1.9"
1105 default:
1106 return "unsupported"
1107 }
1108}
1109
1110// Returns true if javac targeting this version uses system modules instead of a bootclasspath.
1111func (v javaVersion) usesJavaModules() bool {
1112 return v >= 9
1113}
1114
1115func normalizeJavaVersion(ctx android.BaseModuleContext, javaVersion string) javaVersion {
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001116 switch javaVersion {
1117 case "1.6", "6":
Colin Cross1e743852019-10-28 11:37:20 -07001118 return JAVA_VERSION_6
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001119 case "1.7", "7":
Colin Cross1e743852019-10-28 11:37:20 -07001120 return JAVA_VERSION_7
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001121 case "1.8", "8":
Colin Cross1e743852019-10-28 11:37:20 -07001122 return JAVA_VERSION_8
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001123 case "1.9", "9":
Colin Cross1e743852019-10-28 11:37:20 -07001124 return JAVA_VERSION_9
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001125 case "10", "11":
1126 ctx.PropertyErrorf("java_version", "Java language levels above 9 are not supported")
Colin Cross1e743852019-10-28 11:37:20 -07001127 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001128 default:
1129 ctx.PropertyErrorf("java_version", "Unrecognized Java language level")
Colin Cross1e743852019-10-28 11:37:20 -07001130 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001131 }
1132}
1133
Nan Zhanged19fc32017-10-19 13:06:22 -07001134func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
Colin Crossc0b06f12015-04-08 13:03:43 -07001135
Colin Crossf03c82b2015-04-13 13:53:40 -07001136 var flags javaBuilderFlags
1137
Tobias Thierer06dd04f2018-09-11 16:21:05 +01001138 // javaVersion flag.
1139 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), sdkContext(j))
1140
Nan Zhanged19fc32017-10-19 13:06:22 -07001141 // javac flags.
Colin Crossf03c82b2015-04-13 13:53:40 -07001142 javacFlags := j.properties.Javacflags
Colin Cross1e743852019-10-28 11:37:20 -07001143 if flags.javaVersion.usesJavaModules() {
Colin Cross1369cdb2017-09-29 17:58:17 -07001144 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Nan Zhanged19fc32017-10-19 13:06:22 -07001145 }
Colin Cross6510f912017-11-29 00:27:14 -08001146 if ctx.Config().MinimizeJavaDebugInfo() {
Colin Cross126a25c2017-10-31 13:55:34 -07001147 // Override the -g flag passed globally to remove local variable debug info to reduce
1148 // disk and memory usage.
1149 javacFlags = append(javacFlags, "-g:source,lines")
1150 }
Colin Crossc228a702019-11-06 16:18:05 -08001151 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
Colin Cross64162712017-08-08 13:17:59 -07001152
Colin Cross66548102018-06-19 22:47:35 -07001153 if ctx.Config().RunErrorProne() {
1154 if config.ErrorProneClasspath == nil {
1155 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1156 }
1157
1158 errorProneFlags := []string{
1159 "-Xplugin:ErrorProne",
1160 "${config.ErrorProneChecks}",
1161 }
1162 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1163
1164 flags.errorProneExtraJavacFlags = "${config.ErrorProneFlags} " +
1165 "'" + strings.Join(errorProneFlags, " ") + "'"
1166 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
Andreas Gampef3e5b552018-01-22 21:27:21 -08001167 }
1168
Nan Zhanged19fc32017-10-19 13:06:22 -07001169 // classpath
Nan Zhang581fd212018-01-10 16:06:12 -08001170 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1171 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross6cef4812019-10-17 14:23:50 -07001172 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
Colin Cross6a77c982018-06-19 22:43:34 -07001173 flags.processorPath = append(flags.processorPath, deps.processorPath...)
Colin Cross7fdd2b72018-01-02 18:14:25 -08001174
Colin Cross5a116862020-04-22 11:44:34 -07001175 flags.processors = append(flags.processors, deps.processorClasses...)
1176 flags.processors = android.FirstUniqueStrings(flags.processors)
Colin Crossbe9cdb82019-01-21 21:37:16 -08001177
Colin Cross1e743852019-10-28 11:37:20 -07001178 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
1179 decodeSdkDep(ctx, sdkContext(j)).hasStandardLibs() {
Colin Cross7fdd2b72018-01-02 18:14:25 -08001180 // Give host-side tools a version of OpenJDK's standard libraries
1181 // close to what they're targeting. As of Dec 2017, AOSP is only
1182 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1183 //
1184 // When building with OpenJDK 8, the following should have no
1185 // effect since those jars would be available by default.
1186 //
1187 // When building with OpenJDK 9 but targeting a version < 1.8,
1188 // putting them on the bootclasspath means that:
1189 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1190 // b) references to existing APIs are not reinterpreted in an
1191 // OpenJDK 9-specific way, eg. calls to subclasses of
1192 // java.nio.Buffer as in http://b/70862583
1193 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1194 flags.bootClasspath = append(flags.bootClasspath,
1195 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1196 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
Nan Zhang5f8cb422018-02-06 10:34:32 -08001197 if Bool(j.properties.Use_tools_jar) {
1198 flags.bootClasspath = append(flags.bootClasspath,
1199 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1200 }
Colin Cross7fdd2b72018-01-02 18:14:25 -08001201 }
1202
Colin Cross1e743852019-10-28 11:37:20 -07001203 if j.properties.Patch_module != nil && flags.javaVersion.usesJavaModules() {
Jaewoong Jung38e4fb22018-12-12 09:01:34 -08001204 // Manually specify build directory in case it is not under the repo root.
1205 // (javac doesn't seem to expand into symbolc links when searching for patch-module targets, so
1206 // just adding a symlink under the root doesn't help.)
1207 patchPaths := ".:" + ctx.Config().BuildDir()
1208 classPath := flags.classpath.FormJavaClassPath("")
1209 if classPath != "" {
1210 patchPaths += ":" + classPath
1211 }
1212 javacFlags = append(javacFlags, "--patch-module="+String(j.properties.Patch_module)+"="+patchPaths)
Colin Cross81440082018-08-15 20:21:55 -07001213 }
1214
Nan Zhanged19fc32017-10-19 13:06:22 -07001215 // systemModules
Colin Crossb77043e2019-07-16 13:57:13 -07001216 flags.systemModules = deps.systemModules
Colin Cross1369cdb2017-09-29 17:58:17 -07001217
Nan Zhanged19fc32017-10-19 13:06:22 -07001218 // aidl flags.
Colin Cross3047fa22019-04-18 10:56:44 -07001219 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs)
Colin Cross2fe66872015-03-30 17:20:39 -07001220
Colin Cross81440082018-08-15 20:21:55 -07001221 if len(javacFlags) > 0 {
1222 // optimization.
1223 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1224 flags.javacFlags = "$javacFlags"
1225 }
1226
Nan Zhanged19fc32017-10-19 13:06:22 -07001227 return flags
1228}
Colin Crossc0b06f12015-04-08 13:03:43 -07001229
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001230func (j *Module) compile(ctx android.ModuleContext, aaptSrcJar android.Path) {
Colin Crossebe1a512017-11-14 13:12:14 -08001231 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
Nan Zhanged19fc32017-10-19 13:06:22 -07001232
1233 deps := j.collectDeps(ctx)
1234 flags := j.collectBuilderFlags(ctx, deps)
1235
Colin Cross1e743852019-10-28 11:37:20 -07001236 if flags.javaVersion.usesJavaModules() {
Nan Zhanged19fc32017-10-19 13:06:22 -07001237 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
1238 }
Colin Cross8a497952019-03-05 22:25:09 -08001239 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Colin Cross6af17aa2017-09-20 12:59:05 -07001240 if hasSrcExt(srcFiles.Strings(), ".proto") {
Colin Cross0f2ee152017-12-14 15:22:43 -08001241 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
Colin Cross6af17aa2017-09-20 12:59:05 -07001242 }
1243
Colin Crossaf050172017-11-15 23:01:59 -08001244 srcFiles = j.genSources(ctx, srcFiles, flags)
1245
1246 srcJars := srcFiles.FilterByExt(".srcjar")
Colin Cross59149b62017-10-16 18:07:29 -07001247 srcJars = append(srcJars, deps.srcJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001248 if aaptSrcJar != nil {
1249 srcJars = append(srcJars, aaptSrcJar)
1250 }
Colin Crossb7a63242015-04-16 14:09:14 -07001251
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001252 if j.properties.Jarjar_rules != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001253 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001254 }
1255
Colin Cross1ee23172017-10-18 14:44:18 -07001256 jarName := ctx.ModuleName() + ".jar"
1257
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001258 javaSrcFiles := srcFiles.FilterByExt(".java")
1259 var uniqueSrcFiles android.Paths
1260 set := make(map[string]bool)
1261 for _, v := range javaSrcFiles {
1262 if _, found := set[v.String()]; !found {
1263 set[v.String()] = true
1264 uniqueSrcFiles = append(uniqueSrcFiles, v)
1265 }
1266 }
1267
patricktu242faad2019-09-24 15:41:30 +08001268 // Collect .java files for AIDEGen
1269 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1270
Colin Cross55f63ea2018-08-27 12:37:09 -07001271 var kotlinJars android.Paths
1272
Colin Cross93e85952017-08-15 13:34:18 -07001273 if srcFiles.HasExt(".kt") {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001274 // user defined kotlin flags.
1275 kotlincFlags := j.properties.Kotlincflags
1276 CheckKotlincFlags(ctx, kotlincFlags)
1277
Colin Cross93e85952017-08-15 13:34:18 -07001278 // If there are kotlin files, compile them first but pass all the kotlin and java files
1279 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1280 // won't emit any classes for them.
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001281 kotlincFlags = append(kotlincFlags, "-no-stdlib")
Colin Cross93e85952017-08-15 13:34:18 -07001282 if ctx.Device() {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001283 kotlincFlags = append(kotlincFlags, "-no-jdk")
1284 }
1285 if len(kotlincFlags) > 0 {
1286 // optimization.
1287 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1288 flags.kotlincFlags += "$kotlincFlags"
Colin Cross93e85952017-08-15 13:34:18 -07001289 }
1290
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001291 var kotlinSrcFiles android.Paths
1292 kotlinSrcFiles = append(kotlinSrcFiles, uniqueSrcFiles...)
1293 kotlinSrcFiles = append(kotlinSrcFiles, srcFiles.FilterByExt(".kt")...)
1294
patricktu242faad2019-09-24 15:41:30 +08001295 // Collect .kt files for AIDEGen
1296 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, srcFiles.FilterByExt(".kt").Strings()...)
1297
Colin Crossafbb1732019-01-17 15:42:52 -08001298 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1299 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1300
1301 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1302 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1303
1304 if len(flags.processorPath) > 0 {
1305 // Use kapt for annotation processing
1306 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1307 kotlinKapt(ctx, kaptSrcJar, kotlinSrcFiles, srcJars, flags)
1308 srcJars = append(srcJars, kaptSrcJar)
1309 // Disable annotation processing in javac, it's already been handled by kapt
1310 flags.processorPath = nil
Colin Cross5a116862020-04-22 11:44:34 -07001311 flags.processors = nil
Colin Crossafbb1732019-01-17 15:42:52 -08001312 }
Colin Cross93e85952017-08-15 13:34:18 -07001313
Colin Cross1ee23172017-10-18 14:44:18 -07001314 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross21fc9bb2019-01-18 15:05:09 -08001315 kotlinCompile(ctx, kotlinJar, kotlinSrcFiles, srcJars, flags)
Colin Cross93e85952017-08-15 13:34:18 -07001316 if ctx.Failed() {
1317 return
1318 }
1319
1320 // Make javac rule depend on the kotlinc rule
1321 flags.classpath = append(flags.classpath, kotlinJar)
Przemyslaw Szczepaniak66c0c402018-03-08 13:21:55 +00001322
Colin Cross93e85952017-08-15 13:34:18 -07001323 // Jar kotlin classes into the final jar after javac
Colin Cross55f63ea2018-08-27 12:37:09 -07001324 kotlinJars = append(kotlinJars, kotlinJar)
Colin Cross9b38aef2018-08-27 15:42:25 -07001325 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
Colin Cross93e85952017-08-15 13:34:18 -07001326 }
1327
Colin Cross55f63ea2018-08-27 12:37:09 -07001328 jars := append(android.Paths(nil), kotlinJars...)
1329
Colin Cross5ab4e6d2017-11-22 16:20:45 -08001330 // Store the list of .java files that was passed to javac
1331 j.compiledJavaSrcs = uniqueSrcFiles
1332 j.compiledSrcJars = srcJars
1333
Nan Zhang61eaedb2017-11-02 13:28:15 -07001334 enable_sharding := false
Colin Crossf7d84012020-02-21 08:16:41 -08001335 var headerJarFileWithoutJarjar android.Path
Colin Crossbe9cdb82019-01-21 21:37:16 -08001336 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !deps.disableTurbine {
Nan Zhang61eaedb2017-11-02 13:28:15 -07001337 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1338 enable_sharding = true
Ashley Rosee36efcf2019-01-16 17:34:08 -05001339 // Formerly, there was a check here that prevented annotation processors
1340 // from being used when sharding was enabled, as some annotation processors
1341 // do not function correctly in sharded environments. It was removed to
1342 // allow for the use of annotation processors that do function correctly
1343 // with sharding enabled. See: b/77284273.
Nan Zhang61eaedb2017-11-02 13:28:15 -07001344 }
Colin Crossf7d84012020-02-21 08:16:41 -08001345 headerJarFileWithoutJarjar, j.headerJarFile =
1346 j.compileJavaHeader(ctx, uniqueSrcFiles, srcJars, deps, flags, jarName, kotlinJars)
Colin Crossf19b9bb2018-03-26 14:42:44 -07001347 if ctx.Failed() {
1348 return
Nan Zhanged19fc32017-10-19 13:06:22 -07001349 }
1350 }
Colin Cross8eadbf02017-10-24 17:46:00 -07001351 if len(uniqueSrcFiles) > 0 || len(srcJars) > 0 {
Colin Crossd6891432017-09-27 17:39:56 -07001352 var extraJarDeps android.Paths
Colin Cross66548102018-06-19 22:47:35 -07001353 if ctx.Config().RunErrorProne() {
Colin Crossc6bbef32017-08-14 14:16:06 -07001354 // If error-prone is enabled, add an additional rule to compile the java files into
1355 // a separate set of classes (so that they don't overwrite the normal ones and require
Colin Crossd6891432017-09-27 17:39:56 -07001356 // a rebuild when error-prone is turned off).
Colin Crossc6bbef32017-08-14 14:16:06 -07001357 // TODO(ccross): Once we always compile with javac9 we may be able to conditionally
1358 // enable error-prone without affecting the output class files.
Colin Cross1ee23172017-10-18 14:44:18 -07001359 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001360 RunErrorProne(ctx, errorprone, uniqueSrcFiles, srcJars, flags)
Colin Crossc6bbef32017-08-14 14:16:06 -07001361 extraJarDeps = append(extraJarDeps, errorprone)
1362 }
1363
Nan Zhang61eaedb2017-11-02 13:28:15 -07001364 if enable_sharding {
Colin Crossf7d84012020-02-21 08:16:41 -08001365 flags.classpath = append(flags.classpath, headerJarFileWithoutJarjar)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001366 shardSize := int(*(j.properties.Javac_shard_size))
1367 var shardSrcs []android.Paths
1368 if len(uniqueSrcFiles) > 0 {
Colin Cross0a2f7192019-09-23 14:33:09 -07001369 shardSrcs = android.ShardPaths(uniqueSrcFiles, shardSize)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001370 for idx, shardSrc := range shardSrcs {
Colin Cross3b706fd2019-09-05 16:44:18 -07001371 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1372 nil, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001373 jars = append(jars, classes)
1374 }
1375 }
1376 if len(srcJars) > 0 {
Colin Cross3b706fd2019-09-05 16:44:18 -07001377 classes := j.compileJavaClasses(ctx, jarName, len(shardSrcs),
1378 nil, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001379 jars = append(jars, classes)
1380 }
1381 } else {
Colin Cross3b706fd2019-09-05 16:44:18 -07001382 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueSrcFiles, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001383 jars = append(jars, classes)
1384 }
Colin Crossd6891432017-09-27 17:39:56 -07001385 if ctx.Failed() {
1386 return
1387 }
Colin Cross2fe66872015-03-30 17:20:39 -07001388 }
1389
Colin Cross0c4ce212019-05-03 15:28:19 -07001390 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1391
1392 var includeSrcJar android.WritablePath
1393 if Bool(j.properties.Include_srcs) {
1394 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1395 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1396 }
1397
Colin Crosscedd4762018-09-13 11:26:19 -07001398 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1399 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Colin Cross0f37af02017-09-27 17:42:05 -07001400 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
Colin Cross988708c2019-05-06 14:04:11 -07001401 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
Colin Cross0f37af02017-09-27 17:42:05 -07001402
1403 var resArgs []string
1404 var resDeps android.Paths
1405
1406 resArgs = append(resArgs, dirArgs...)
1407 resDeps = append(resDeps, dirDeps...)
1408
1409 resArgs = append(resArgs, fileArgs...)
1410 resDeps = append(resDeps, fileDeps...)
1411
Colin Cross988708c2019-05-06 14:04:11 -07001412 resArgs = append(resArgs, extraArgs...)
1413 resDeps = append(resDeps, extraDeps...)
1414
Colin Cross40a36712017-09-27 17:41:35 -07001415 if len(resArgs) > 0 {
Colin Cross1ee23172017-10-18 14:44:18 -07001416 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
Colin Crosse9a275b2017-10-16 17:09:48 -07001417 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Colin Cross331a1212018-08-15 20:40:52 -07001418 j.resourceJar = resourceJar
Colin Cross65bf4f22015-04-03 16:54:17 -07001419 if ctx.Failed() {
1420 return
1421 }
1422 }
1423
Colin Cross0c4ce212019-05-03 15:28:19 -07001424 var resourceJars android.Paths
1425 if j.resourceJar != nil {
1426 resourceJars = append(resourceJars, j.resourceJar)
1427 }
1428 if Bool(j.properties.Include_srcs) {
1429 resourceJars = append(resourceJars, includeSrcJar)
1430 }
1431 resourceJars = append(resourceJars, deps.staticResourceJars...)
Colin Cross331a1212018-08-15 20:40:52 -07001432
Colin Cross0c4ce212019-05-03 15:28:19 -07001433 if len(resourceJars) > 1 {
Colin Cross331a1212018-08-15 20:40:52 -07001434 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
Colin Cross0c4ce212019-05-03 15:28:19 -07001435 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
Colin Cross331a1212018-08-15 20:40:52 -07001436 false, nil, nil)
1437 j.resourceJar = combinedJar
Colin Cross0c4ce212019-05-03 15:28:19 -07001438 } else if len(resourceJars) == 1 {
1439 j.resourceJar = resourceJars[0]
Colin Cross331a1212018-08-15 20:40:52 -07001440 }
1441
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001442 if len(deps.staticJars) > 0 {
1443 jars = append(jars, deps.staticJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001444 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001445
Colin Cross094054a2018-10-17 15:10:48 -07001446 manifest := j.overrideManifest
1447 if !manifest.Valid() && j.properties.Manifest != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001448 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Colin Cross366938f2017-12-11 16:29:02 -08001449 }
Colin Cross635acc92017-09-12 22:50:46 -07001450
Colin Cross8a497952019-03-05 22:25:09 -08001451 services := android.PathsForModuleSrc(ctx, j.properties.Services)
Alex Light7f004a72019-02-21 13:27:37 -08001452 if len(services) > 0 {
1453 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1454 var zipargs []string
1455 for _, file := range services {
1456 serviceFile := file.String()
1457 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1458 }
1459 ctx.Build(pctx, android.BuildParams{
1460 Rule: zip,
1461 Output: servicesJar,
1462 Implicits: services,
1463 Args: map[string]string{
Colin Cross0b9f31f2019-02-28 11:00:01 -08001464 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
Alex Light7f004a72019-02-21 13:27:37 -08001465 },
1466 })
1467 jars = append(jars, servicesJar)
1468 }
1469
Colin Cross0a6e0072017-08-30 14:24:55 -07001470 // Combine the classes built from sources, any manifests, and any static libraries into
Nan Zhanged19fc32017-10-19 13:06:22 -07001471 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross3063b782018-08-15 11:19:12 -07001472 var outputFile android.ModuleOutPath
Colin Crosse9a275b2017-10-16 17:09:48 -07001473
1474 if len(jars) == 1 && !manifest.Valid() {
Colin Cross3063b782018-08-15 11:19:12 -07001475 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok {
1476 // Optimization: skip the combine step if there is nothing to do
1477 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1478 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1479 // any if len(jars) == 1.
1480 outputFile = moduleOutPath
1481 } else {
1482 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1483 ctx.Build(pctx, android.BuildParams{
1484 Rule: android.Cp,
1485 Input: jars[0],
1486 Output: combinedJar,
1487 })
1488 outputFile = combinedJar
1489 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001490 } else {
Colin Cross1ee23172017-10-18 14:44:18 -07001491 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001492 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
Colin Cross9b38aef2018-08-27 15:42:25 -07001493 false, nil, nil)
Colin Crosse9a275b2017-10-16 17:09:48 -07001494 outputFile = combinedJar
1495 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001496
Colin Cross331a1212018-08-15 20:40:52 -07001497 // jarjar implementation jar if necessary
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001498 if j.expandJarjarRules != nil {
Colin Cross8649b262017-09-27 18:03:17 -07001499 // Transform classes.jar into classes-jarjar.jar
Colin Cross1ee23172017-10-18 14:44:18 -07001500 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001501 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
Colin Crosse9a275b2017-10-16 17:09:48 -07001502 outputFile = jarjarFile
Colin Cross331a1212018-08-15 20:40:52 -07001503
1504 // jarjar resource jar if necessary
1505 if j.resourceJar != nil {
1506 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001507 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
Colin Cross331a1212018-08-15 20:40:52 -07001508 j.resourceJar = resourceJarJarFile
1509 }
1510
Colin Cross0a6e0072017-08-30 14:24:55 -07001511 if ctx.Failed() {
1512 return
1513 }
1514 }
Vladimir Marko0975ee02019-04-02 10:29:55 +01001515
1516 // Check package restrictions if necessary.
1517 if len(j.properties.Permitted_packages) > 0 {
1518 // Check packages and copy to package-checked file.
1519 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
1520 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
1521 j.additionalCheckedModules = append(j.additionalCheckedModules, pkgckFile)
1522
1523 if ctx.Failed() {
1524 return
1525 }
1526 }
1527
Nan Zhanged19fc32017-10-19 13:06:22 -07001528 j.implementationJarFile = outputFile
1529 if j.headerJarFile == nil {
1530 j.headerJarFile = j.implementationJarFile
1531 }
Colin Cross2fe66872015-03-30 17:20:39 -07001532
Jiyong Park93e57a02020-02-21 16:04:53 +09001533 // Force enable the instrumentation for java code that is built for APEXes ...
1534 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
1535 // doesn't make sense)
1536 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
1537 if android.DirectlyInAnyApex(ctx, ctx.ModuleName()) && !isJacocoAgent && !j.IsForPlatform() {
Jiyong Park00cae1c2020-02-18 12:50:44 +00001538 j.properties.Instrument = true
1539 }
1540
Colin Cross3144dfc2018-01-03 15:06:47 -08001541 if j.shouldInstrument(ctx) {
Colin Crosscb933592017-11-22 13:49:43 -08001542 outputFile = j.instrument(ctx, flags, outputFile, jarName)
1543 }
1544
Colin Cross331a1212018-08-15 20:40:52 -07001545 // merge implementation jar with resources if necessary
1546 implementationAndResourcesJar := outputFile
1547 if j.resourceJar != nil {
Colin Cross08a409d2019-04-29 10:22:44 -07001548 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Colin Cross331a1212018-08-15 20:40:52 -07001549 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Colin Cross08a409d2019-04-29 10:22:44 -07001550 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
Colin Cross331a1212018-08-15 20:40:52 -07001551 false, nil, nil)
1552 implementationAndResourcesJar = combinedJar
1553 }
1554
1555 j.implementationAndResourcesJar = implementationAndResourcesJar
1556
Jiyong Park6b21c7d2020-02-11 09:16:01 +09001557 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
1558 if android.DirectlyInAnyApex(ctx, ctx.ModuleName()) && !j.IsForPlatform() {
1559 if j.deviceProperties.Compile_dex == nil {
1560 j.deviceProperties.Compile_dex = proptools.BoolPtr(true)
1561 }
1562 if j.deviceProperties.Hostdex == nil {
1563 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1564 }
1565 }
1566
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001567 if ctx.Device() && j.hasCode(ctx) &&
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001568 (Bool(j.properties.Installable) || Bool(j.deviceProperties.Compile_dex)) {
Colin Cross8faf8fc2019-01-16 15:15:52 -08001569 // Dex compilation
Colin Cross3063b782018-08-15 11:19:12 -07001570 var dexOutputFile android.ModuleOutPath
David Brazdil17ef5632018-06-27 10:27:45 +01001571 dexOutputFile = j.compileDex(ctx, flags, outputFile, jarName)
Colin Cross2fe66872015-03-30 17:20:39 -07001572 if ctx.Failed() {
1573 return
1574 }
Colin Cross331a1212018-08-15 20:40:52 -07001575
Jiyong Park09cb6292019-07-15 15:29:23 +09001576 // Hidden API CSV generation and dex encoding
1577 dexOutputFile = j.hiddenAPI.hiddenAPI(ctx, dexOutputFile, j.implementationJarFile,
David Srbeckye033cba2020-05-20 22:20:28 +01001578 proptools.Bool(j.deviceProperties.Uncompress_dex))
Colin Cross8faf8fc2019-01-16 15:15:52 -08001579
Colin Cross331a1212018-08-15 20:40:52 -07001580 // merge dex jar with resources if necessary
1581 if j.resourceJar != nil {
1582 jars := android.Paths{dexOutputFile, j.resourceJar}
1583 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
1584 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1585 false, nil, nil)
David Srbeckye033cba2020-05-20 22:20:28 +01001586 if *j.deviceProperties.Uncompress_dex {
Nicolas Geoffrayf3438722019-01-23 15:57:21 +00001587 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
1588 TransformZipAlign(ctx, combinedAlignedJar, combinedJar)
1589 dexOutputFile = combinedAlignedJar
1590 } else {
1591 dexOutputFile = combinedJar
1592 }
Colin Cross331a1212018-08-15 20:40:52 -07001593 }
1594
1595 j.dexJarFile = dexOutputFile
1596
Colin Cross8faf8fc2019-01-16 15:15:52 -08001597 // Dexpreopting
Colin Cross43f08db2018-11-12 10:13:39 -08001598 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
1599
1600 j.maybeStrippedDexJarFile = dexOutputFile
1601
Colin Cross3063b782018-08-15 11:19:12 -07001602 outputFile = dexOutputFile
Colin Cross43f08db2018-11-12 10:13:39 -08001603
1604 if ctx.Failed() {
1605 return
1606 }
Colin Cross331a1212018-08-15 20:40:52 -07001607 } else {
1608 outputFile = implementationAndResourcesJar
Colin Cross2fe66872015-03-30 17:20:39 -07001609 }
Colin Cross331a1212018-08-15 20:40:52 -07001610
Colin Crossb7a63242015-04-16 14:09:14 -07001611 ctx.CheckbuildFile(outputFile)
Colin Cross3063b782018-08-15 11:19:12 -07001612
1613 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1614 j.outputFile = outputFile.WithoutRel()
Colin Cross2fe66872015-03-30 17:20:39 -07001615}
1616
Colin Cross3b706fd2019-09-05 16:44:18 -07001617func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
1618 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.WritablePath {
1619
1620 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
1621 if idx >= 0 {
1622 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
1623 jarName += strconv.Itoa(idx)
1624 }
1625
1626 classes := android.PathForModuleOut(ctx, "javac", jarName)
1627 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, flags, extraJarDeps)
1628
1629 if ctx.Config().EmitXrefRules() {
1630 extractionFile := android.PathForModuleOut(ctx, kzipName)
1631 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1632 j.kytheFiles = append(j.kytheFiles, extractionFile)
1633 }
1634
1635 return classes
1636}
1637
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001638// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1639// since some of these flags may be used internally.
1640func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1641 for _, flag := range flags {
1642 flag = strings.TrimSpace(flag)
1643
1644 if !strings.HasPrefix(flag, "-") {
1645 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1646 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1647 ctx.PropertyErrorf("kotlincflags",
1648 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1649 } else if inList(flag, config.KotlincIllegalFlags) {
1650 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1651 } else if flag == "-include-runtime" {
1652 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1653 } else {
1654 args := strings.Split(flag, " ")
1655 if args[0] == "-kotlin-home" {
1656 ctx.PropertyErrorf("kotlincflags",
1657 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1658 }
1659 }
1660 }
1661}
1662
Colin Cross8eadbf02017-10-24 17:46:00 -07001663func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
Colin Crossf7d84012020-02-21 08:16:41 -08001664 deps deps, flags javaBuilderFlags, jarName string,
1665 extraJars android.Paths) (headerJar, jarjarHeaderJar android.Path) {
Nan Zhanged19fc32017-10-19 13:06:22 -07001666
1667 var jars android.Paths
Colin Cross8eadbf02017-10-24 17:46:00 -07001668 if len(srcFiles) > 0 || len(srcJars) > 0 {
Nan Zhanged19fc32017-10-19 13:06:22 -07001669 // Compile java sources into turbine.jar.
1670 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1671 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1672 if ctx.Failed() {
Colin Crossf7d84012020-02-21 08:16:41 -08001673 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001674 }
1675 jars = append(jars, turbineJar)
1676 }
1677
Colin Cross55f63ea2018-08-27 12:37:09 -07001678 jars = append(jars, extraJars...)
1679
Nan Zhanged19fc32017-10-19 13:06:22 -07001680 // Combine any static header libraries into classes-header.jar. If there is only
1681 // one input jar this step will be skipped.
Nan Zhanged19fc32017-10-19 13:06:22 -07001682 jars = append(jars, deps.staticHeaderJars...)
1683
Colin Cross5c6ecc12017-10-23 18:12:27 -07001684 // we cannot skip the combine step for now if there is only one jar
1685 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1686 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001687 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
Colin Cross6c6e6cd2019-05-08 14:30:12 -07001688 false, nil, []string{"META-INF/TRANSITIVE"})
Colin Cross5c6ecc12017-10-23 18:12:27 -07001689 headerJar = combinedJar
Colin Crossf7d84012020-02-21 08:16:41 -08001690 jarjarHeaderJar = combinedJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001691
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001692 if j.expandJarjarRules != nil {
Nan Zhanged19fc32017-10-19 13:06:22 -07001693 // Transform classes.jar into classes-jarjar.jar
1694 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001695 TransformJarJar(ctx, jarjarFile, headerJar, j.expandJarjarRules)
Colin Crossf7d84012020-02-21 08:16:41 -08001696 jarjarHeaderJar = jarjarFile
Nan Zhanged19fc32017-10-19 13:06:22 -07001697 if ctx.Failed() {
Colin Crossf7d84012020-02-21 08:16:41 -08001698 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001699 }
1700 }
1701
Colin Crossf7d84012020-02-21 08:16:41 -08001702 return headerJar, jarjarHeaderJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001703}
1704
Colin Crosscb933592017-11-22 13:49:43 -08001705func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross3063b782018-08-15 11:19:12 -07001706 classesJar android.Path, jarName string) android.ModuleOutPath {
Colin Crosscb933592017-11-22 13:49:43 -08001707
Colin Cross7a3139e2017-12-19 13:57:50 -08001708 specs := j.jacocoModuleToZipCommand(ctx)
Colin Crosscb933592017-11-22 13:49:43 -08001709
Colin Cross84c38822018-01-03 15:59:46 -08001710 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Crosscb933592017-11-22 13:49:43 -08001711 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
1712
1713 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1714
1715 j.jacocoReportClassesFile = jacocoReportClassesFile
1716
1717 return instrumentedJar
1718}
1719
albaltai36ff7dc2018-12-25 14:35:23 +08001720var _ Dependency = (*Module)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001721
Nan Zhanged19fc32017-10-19 13:06:22 -07001722func (j *Module) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001723 if j.headerJarFile == nil {
1724 return nil
1725 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001726 return android.Paths{j.headerJarFile}
1727}
1728
1729func (j *Module) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08001730 if j.implementationJarFile == nil {
1731 return nil
1732 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001733 return android.Paths{j.implementationJarFile}
Colin Cross2fe66872015-03-30 17:20:39 -07001734}
1735
Colin Crossf24a22a2019-01-31 14:12:44 -08001736func (j *Module) DexJar() android.Path {
1737 return j.dexJarFile
1738}
1739
Colin Cross331a1212018-08-15 20:40:52 -07001740func (j *Module) ResourceJars() android.Paths {
1741 if j.resourceJar == nil {
1742 return nil
1743 }
1744 return android.Paths{j.resourceJar}
1745}
1746
1747func (j *Module) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001748 if j.implementationAndResourcesJar == nil {
1749 return nil
1750 }
Colin Cross331a1212018-08-15 20:40:52 -07001751 return android.Paths{j.implementationAndResourcesJar}
1752}
1753
Colin Cross46c9b8b2017-06-22 16:51:17 -07001754func (j *Module) AidlIncludeDirs() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001755 // exportAidlIncludeDirs is type android.Paths already
Colin Crossc0b06f12015-04-08 13:03:43 -07001756 return j.exportAidlIncludeDirs
1757}
1758
Jiyong Park1be96912018-05-28 18:02:19 +09001759func (j *Module) ExportedSdkLibs() []string {
albaltai36ff7dc2018-12-25 14:35:23 +08001760 // exportedSdkLibs is type []string
Jiyong Park1be96912018-05-28 18:02:19 +09001761 return j.exportedSdkLibs
1762}
1763
Artur Satayev9cf46692019-11-26 18:08:34 +00001764func (j *Module) ExportedPlugins() (android.Paths, []string) {
1765 return j.exportedPluginJars, j.exportedPluginClasses
1766}
1767
Colin Cross0c4ce212019-05-03 15:28:19 -07001768func (j *Module) SrcJarArgs() ([]string, android.Paths) {
1769 return j.srcJarArgs, j.srcJarDeps
1770}
1771
Colin Cross46c9b8b2017-06-22 16:51:17 -07001772var _ logtagsProducer = (*Module)(nil)
Colin Crossf05fe972015-04-10 17:45:20 -07001773
Colin Cross46c9b8b2017-06-22 16:51:17 -07001774func (j *Module) logtags() android.Paths {
Colin Crossf05fe972015-04-10 17:45:20 -07001775 return j.logtagsSrcs
1776}
1777
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001778// Collect information for opening IDE project files in java/jdeps.go.
1779func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
1780 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
1781 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
patricktu18c82ff2019-05-10 15:48:50 +08001782 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001783 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001784 if j.expandJarjarRules != nil {
1785 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001786 }
bralee1fbf4402020-05-21 10:11:59 +08001787 dpInfo.Paths = append(dpInfo.Paths, j.modulePaths...)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001788}
1789
1790func (j *Module) CompilerDeps() []string {
1791 jdeps := []string{}
1792 jdeps = append(jdeps, j.properties.Libs...)
1793 jdeps = append(jdeps, j.properties.Static_libs...)
1794 return jdeps
1795}
1796
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001797func (j *Module) hasCode(ctx android.ModuleContext) bool {
1798 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
1799 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
1800}
1801
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001802func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffin0d3c2e12020-05-17 08:34:50 +01001803 return j.depIsInSameApex(ctx, dep)
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001804}
1805
Jiyong Park0b238752019-10-29 11:23:10 +09001806func (j *Module) Stem() string {
1807 return proptools.StringDefault(j.deviceProperties.Stem, j.Name())
1808}
1809
Jiyong Park618922e2020-01-08 13:35:43 +09001810func (j *Module) JacocoReportClassesFile() android.Path {
1811 return j.jacocoReportClassesFile
1812}
1813
Martin Stjernholm6d415272020-01-31 17:10:36 +00001814func (j *Module) IsInstallable() bool {
1815 return Bool(j.properties.Installable)
1816}
1817
Colin Cross2fe66872015-03-30 17:20:39 -07001818//
1819// Java libraries (.jar file)
1820//
1821
Anton Hansson78156ef2020-03-27 19:39:48 +00001822type LibraryProperties struct {
1823 Dist struct {
1824 // The tag of the output of this module that should be output.
1825 Tag *string `android:"arch_variant"`
1826 } `android:"arch_variant"`
1827}
1828
Colin Crossf506d872017-07-19 15:53:04 -07001829type Library struct {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001830 Module
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001831
Anton Hansson78156ef2020-03-27 19:39:48 +00001832 libraryProperties LibraryProperties
1833
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001834 InstallMixin func(ctx android.ModuleContext, installPath android.Path) (extraInstallDeps android.Paths)
Colin Cross2fe66872015-03-30 17:20:39 -07001835}
1836
Colin Cross42be7612019-02-21 18:12:14 -08001837func shouldUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter) bool {
Ulya Trafimovichf491dde2020-01-24 12:19:45 +00001838 // Store uncompressed (and aligned) any dex files from jars in APEXes.
1839 if am, ok := ctx.Module().(android.ApexModule); ok && !am.IsForPlatform() {
1840 return true
1841 }
1842
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001843 // Store uncompressed (and do not strip) dex files from boot class path jars.
1844 if inList(ctx.ModuleName(), ctx.Config().BootJars()) {
1845 return true
1846 }
1847
1848 // Store uncompressed dex files that are preopted on /system.
Colin Cross42be7612019-02-21 18:12:14 -08001849 if !dexpreopter.dexpreoptDisabled(ctx) && (ctx.Host() || !odexOnSystemOther(ctx, dexpreopter.installPath)) {
Vladimir Markoe8b00d62018-12-21 15:54:16 +00001850 return true
1851 }
Colin Cross083a2aa2019-02-06 16:37:12 -08001852 if ctx.Config().UncompressPrivAppDex() &&
1853 inList(ctx.ModuleName(), ctx.Config().ModulesLoadedByPrivilegedModules()) {
1854 return true
1855 }
1856
Colin Cross2fc72f62018-12-21 12:59:54 -08001857 return false
1858}
1859
Colin Crossf506d872017-07-19 15:53:04 -07001860func (j *Library) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayev2db1c3f2020-04-08 19:09:30 +01001861 j.checkSdkVersions(ctx)
Jiyong Park0b238752019-10-29 11:23:10 +09001862 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross43f08db2018-11-12 10:13:39 -08001863 j.dexpreopter.isSDKLibrary = j.deviceProperties.IsSDKLibrary
David Srbeckye033cba2020-05-20 22:20:28 +01001864 if j.deviceProperties.Uncompress_dex == nil {
1865 // If the value was not force-set by the user, use reasonable default based on the module.
1866 j.deviceProperties.Uncompress_dex = proptools.BoolPtr(shouldUncompressDex(ctx, &j.dexpreopter))
1867 }
1868 j.dexpreopter.uncompressedDex = *j.deviceProperties.Uncompress_dex
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001869 j.compile(ctx, nil)
Colin Crossb7a63242015-04-16 14:09:14 -07001870
bralee1fbf4402020-05-21 10:11:59 +08001871 // Collect the module directory for IDE info in java/jdeps.go.
1872 j.modulePaths = append(j.modulePaths, ctx.ModuleDir())
1873
Jiyong Park7f7766d2019-07-25 22:02:35 +09001874 exclusivelyForApex := android.InAnyApex(ctx.ModuleName()) && !j.IsForPlatform()
1875 if (Bool(j.properties.Installable) || ctx.Host()) && !exclusivelyForApex {
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001876 var extraInstallDeps android.Paths
1877 if j.InstallMixin != nil {
1878 extraInstallDeps = j.InstallMixin(ctx, j.outputFile)
1879 }
Colin Cross2c429dc2017-08-31 16:45:16 -07001880 j.installFile = ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001881 ctx.ModuleName()+".jar", j.outputFile, extraInstallDeps...)
Colin Cross2c429dc2017-08-31 16:45:16 -07001882 }
Anton Hansson78156ef2020-03-27 19:39:48 +00001883
1884 // Verify Dist.Tag is set to a supported output
1885 if j.libraryProperties.Dist.Tag != nil {
1886 distFiles, err := j.OutputFiles(*j.libraryProperties.Dist.Tag)
1887 if err != nil {
1888 ctx.PropertyErrorf("dist.tag", "%s", err.Error())
1889 }
1890 j.distFile = distFiles[0]
1891 }
Colin Crossb7a63242015-04-16 14:09:14 -07001892}
1893
Colin Crossf506d872017-07-19 15:53:04 -07001894func (j *Library) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001895 j.deps(ctx)
1896}
1897
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001898const (
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001899 aidlIncludeDir = "aidl"
1900 javaDir = "java"
1901 jarFileSuffix = ".jar"
1902 testConfigSuffix = "-AndroidTest.xml"
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001903)
1904
Paul Duffina0dbf432019-12-05 11:25:53 +00001905// path to the jar file of a java library. Relative to <sdk_root>/<api_dir>
Paul Duffina04c1072020-03-02 10:16:35 +00001906func sdkSnapshotFilePathForJar(osPrefix, name string) string {
1907 return sdkSnapshotFilePathForMember(osPrefix, name, jarFileSuffix)
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001908}
1909
Paul Duffina04c1072020-03-02 10:16:35 +00001910func sdkSnapshotFilePathForMember(osPrefix, name string, suffix string) string {
1911 return filepath.Join(javaDir, osPrefix, name+suffix)
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001912}
1913
Paul Duffin13879572019-11-28 14:31:38 +00001914type librarySdkMemberType struct {
Paul Duffin255f18e2019-12-13 11:22:16 +00001915 android.SdkMemberTypeBase
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00001916
1917 // Function to retrieve the appropriate output jar (implementation or header) from
1918 // the library.
1919 jarToExportGetter func(j *Library) android.Path
Paul Duffin13879572019-11-28 14:31:38 +00001920}
1921
1922func (mt *librarySdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
1923 mctx.AddVariationDependencies(nil, dependencyTag, names...)
1924}
1925
1926func (mt *librarySdkMemberType) IsInstance(module android.Module) bool {
1927 _, ok := module.(*Library)
1928 return ok
1929}
1930
Paul Duffin3a4eb502020-03-19 16:11:18 +00001931func (mt *librarySdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
1932 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_import")
Paul Duffin14eb4672020-03-02 11:33:02 +00001933}
Paul Duffina0dbf432019-12-05 11:25:53 +00001934
Paul Duffin14eb4672020-03-02 11:33:02 +00001935func (mt *librarySdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
Paul Duffina551a1c2020-03-17 21:04:24 +00001936 return &librarySdkMemberProperties{}
Paul Duffin14eb4672020-03-02 11:33:02 +00001937}
1938
1939type librarySdkMemberProperties struct {
1940 android.SdkMemberPropertiesBase
1941
Paul Duffin864e1b42020-05-06 10:23:19 +01001942 JarToExport android.Path `android:"arch_variant"`
Paul Duffina551a1c2020-03-17 21:04:24 +00001943 AidlIncludeDirs android.Paths
Paul Duffin14eb4672020-03-02 11:33:02 +00001944}
1945
Paul Duffin3a4eb502020-03-19 16:11:18 +00001946func (p *librarySdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin13879572019-11-28 14:31:38 +00001947 j := variant.(*Library)
1948
Paul Duffina551a1c2020-03-17 21:04:24 +00001949 p.JarToExport = ctx.MemberType().(*librarySdkMemberType).jarToExportGetter(j)
1950 p.AidlIncludeDirs = j.AidlIncludeDirs()
Paul Duffin14eb4672020-03-02 11:33:02 +00001951}
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001952
Paul Duffin3a4eb502020-03-19 16:11:18 +00001953func (p *librarySdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffina551a1c2020-03-17 21:04:24 +00001954 builder := ctx.SnapshotBuilder()
Paul Duffin3a4eb502020-03-19 16:11:18 +00001955
Paul Duffina551a1c2020-03-17 21:04:24 +00001956 exportedJar := p.JarToExport
1957 if exportedJar != nil {
1958 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
Paul Duffin14eb4672020-03-02 11:33:02 +00001959 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
1960
Paul Duffina551a1c2020-03-17 21:04:24 +00001961 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
1962 }
1963
1964 aidlIncludeDirs := p.AidlIncludeDirs
1965 if len(aidlIncludeDirs) != 0 {
1966 sdkModuleContext := ctx.SdkModuleContext()
1967 for _, dir := range aidlIncludeDirs {
Paul Duffin14eb4672020-03-02 11:33:02 +00001968 // TODO(jiyong): copy parcelable declarations only
1969 aidlFiles, _ := sdkModuleContext.GlobWithDeps(dir.String()+"/**/*.aidl", nil)
1970 for _, file := range aidlFiles {
1971 builder.CopyToSnapshot(android.PathForSource(sdkModuleContext, file), filepath.Join(aidlIncludeDir, file))
1972 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001973 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001974
Paul Duffina551a1c2020-03-17 21:04:24 +00001975 // TODO(b/151933053) - add aidl include dirs property
Paul Duffin14eb4672020-03-02 11:33:02 +00001976 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001977}
1978
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00001979var javaHeaderLibsSdkMemberType android.SdkMemberType = &librarySdkMemberType{
1980 android.SdkMemberTypeBase{
1981 PropertyName: "java_header_libs",
1982 SupportsSdk: true,
Paul Duffin7b81f5e2020-01-13 21:03:22 +00001983 },
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00001984 func(j *Library) android.Path {
Paul Duffina0dbf432019-12-05 11:25:53 +00001985 headerJars := j.HeaderJars()
1986 if len(headerJars) != 1 {
1987 panic(fmt.Errorf("there must be only one header jar from %q", j.Name()))
1988 }
1989
1990 return headerJars[0]
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00001991 },
Paul Duffina0dbf432019-12-05 11:25:53 +00001992}
1993
Colin Cross1b16b0e2019-02-12 14:41:32 -08001994// java_library builds and links sources into a `.jar` file for the device, and possibly for the host as well.
1995//
1996// By default, a java_library has a single variant that produces a `.jar` file containing `.class` files that were
1997// compiled against the device bootclasspath. This jar is not suitable for installing on a device, but can be used
1998// as a `static_libs` dependency of another module.
1999//
2000// Specifying `installable: true` will product a `.jar` file containing `classes.dex` files, suitable for installing on
2001// a device.
2002//
2003// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2004// compiled against the host bootclasspath.
Colin Cross9ae1b922018-06-26 17:59:05 -07002005func LibraryFactory() android.Module {
2006 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07002007
Colin Cross9ae1b922018-06-26 17:59:05 -07002008 module.AddProperties(
2009 &module.Module.properties,
2010 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002011 &module.Module.dexpreoptProperties,
Anton Hansson78156ef2020-03-27 19:39:48 +00002012 &module.Module.protoProperties,
2013 &module.libraryProperties)
Colin Cross2fe66872015-03-30 17:20:39 -07002014
Paul Duffin859fe962020-05-15 10:20:31 +01002015 module.initModuleAndImport(&module.ModuleBase)
2016
Jiyong Park7f7766d2019-07-25 22:02:35 +09002017 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002018 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002019 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross9ae1b922018-06-26 17:59:05 -07002020 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002021}
2022
Colin Cross1b16b0e2019-02-12 14:41:32 -08002023// java_library_static is an obsolete alias for java_library.
2024func LibraryStaticFactory() android.Module {
2025 return LibraryFactory()
2026}
2027
2028// java_library_host builds and links sources into a `.jar` file for the host.
2029//
2030// A java_library_host has a single variant that produces a `.jar` file containing `.class` files that were
2031// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002032func LibraryHostFactory() android.Module {
2033 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07002034
Colin Cross6af17aa2017-09-20 12:59:05 -07002035 module.AddProperties(
2036 &module.Module.properties,
2037 &module.Module.protoProperties)
Colin Cross36242852017-06-23 15:06:31 -07002038
Colin Cross9ae1b922018-06-26 17:59:05 -07002039 module.Module.properties.Installable = proptools.BoolPtr(true)
2040
Jiyong Park7f7766d2019-07-25 22:02:35 +09002041 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002042 InitJavaModule(module, android.HostSupported)
Colin Cross36242852017-06-23 15:06:31 -07002043 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002044}
2045
2046//
Colin Crossb628ea52018-08-14 16:42:33 -07002047// Java Tests
Colin Cross05638fc2018-04-09 18:40:24 -07002048//
2049
2050type testProperties struct {
Colin Cross05638fc2018-04-09 18:40:24 -07002051 // list of compatibility suites (for example "cts", "vts") that the module should be
2052 // installed into.
2053 Test_suites []string `android:"arch_variant"`
Julien Despreze146e392018-08-02 15:00:46 -07002054
2055 // the name of the test configuration (for example "AndroidTest.xml") that should be
2056 // installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002057 Test_config *string `android:"path,arch_variant"`
Colin Crossd96ca352018-08-10 16:06:24 -07002058
Jack He33338892018-09-19 02:21:28 -07002059 // the name of the test configuration template (for example "AndroidTestTemplate.xml") that
2060 // should be installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002061 Test_config_template *string `android:"path,arch_variant"`
Jack He33338892018-09-19 02:21:28 -07002062
Colin Crossd96ca352018-08-10 16:06:24 -07002063 // list of files or filegroup modules that provide data that should be installed alongside
2064 // the test
Colin Cross27b922f2019-03-04 22:35:41 -08002065 Data []string `android:"path"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07002066
2067 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
2068 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
2069 // explicitly.
2070 Auto_gen_config *bool
easoncylee5bcff5d2020-04-30 14:57:06 +08002071
2072 // Add parameterized mainline modules to auto generated test config. The options will be
2073 // handled by TradeFed to do downloading and installing the specified modules on the device.
2074 Test_mainline_modules []string
Colin Cross05638fc2018-04-09 18:40:24 -07002075}
2076
Paul Duffin42df1442019-03-20 12:45:53 +00002077type testHelperLibraryProperties struct {
2078 // list of compatibility suites (for example "cts", "vts") that the module should be
2079 // installed into.
2080 Test_suites []string `android:"arch_variant"`
2081}
2082
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002083type prebuiltTestProperties struct {
2084 // list of compatibility suites (for example "cts", "vts") that the module should be
2085 // installed into.
2086 Test_suites []string `android:"arch_variant"`
2087
2088 // the name of the test configuration (for example "AndroidTest.xml") that should be
2089 // installed with the module.
2090 Test_config *string `android:"path,arch_variant"`
2091}
2092
Colin Cross05638fc2018-04-09 18:40:24 -07002093type Test struct {
2094 Library
2095
2096 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07002097
2098 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07002099 data android.Paths
Colin Cross303e21f2018-08-07 16:49:25 -07002100}
2101
Paul Duffin42df1442019-03-20 12:45:53 +00002102type TestHelperLibrary struct {
2103 Library
2104
2105 testHelperLibraryProperties testHelperLibraryProperties
2106}
2107
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002108type JavaTestImport struct {
2109 Import
2110
2111 prebuiltTestProperties prebuiltTestProperties
2112
2113 testConfig android.Path
2114}
2115
Colin Cross303e21f2018-08-07 16:49:25 -07002116func (j *Test) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Dan Shi6ffaaa82019-09-26 11:41:36 -07002117 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.testProperties.Test_config, j.testProperties.Test_config_template,
2118 j.testProperties.Test_suites, j.testProperties.Auto_gen_config)
Colin Cross8a497952019-03-05 22:25:09 -08002119 j.data = android.PathsForModuleSrc(ctx, j.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07002120
2121 j.Library.GenerateAndroidBuildActions(ctx)
Colin Cross05638fc2018-04-09 18:40:24 -07002122}
2123
Paul Duffin42df1442019-03-20 12:45:53 +00002124func (j *TestHelperLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2125 j.Library.GenerateAndroidBuildActions(ctx)
2126}
2127
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002128func (j *JavaTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2129 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.prebuiltTestProperties.Test_config, nil,
2130 j.prebuiltTestProperties.Test_suites, nil)
2131
2132 j.Import.GenerateAndroidBuildActions(ctx)
2133}
2134
2135type testSdkMemberType struct {
2136 android.SdkMemberTypeBase
2137}
2138
2139func (mt *testSdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
2140 mctx.AddVariationDependencies(nil, dependencyTag, names...)
2141}
2142
2143func (mt *testSdkMemberType) IsInstance(module android.Module) bool {
2144 _, ok := module.(*Test)
2145 return ok
2146}
2147
Paul Duffin3a4eb502020-03-19 16:11:18 +00002148func (mt *testSdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
2149 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_test_import")
Paul Duffin14eb4672020-03-02 11:33:02 +00002150}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002151
Paul Duffin14eb4672020-03-02 11:33:02 +00002152func (mt *testSdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
2153 return &testSdkMemberProperties{}
2154}
2155
2156type testSdkMemberProperties struct {
2157 android.SdkMemberPropertiesBase
2158
Paul Duffina551a1c2020-03-17 21:04:24 +00002159 JarToExport android.Path
2160 TestConfig android.Path
Paul Duffin14eb4672020-03-02 11:33:02 +00002161}
2162
Paul Duffin3a4eb502020-03-19 16:11:18 +00002163func (p *testSdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin14eb4672020-03-02 11:33:02 +00002164 test := variant.(*Test)
2165
2166 implementationJars := test.ImplementationJars()
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002167 if len(implementationJars) != 1 {
Paul Duffin14eb4672020-03-02 11:33:02 +00002168 panic(fmt.Errorf("there must be only one implementation jar from %q", test.Name()))
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002169 }
2170
Paul Duffina551a1c2020-03-17 21:04:24 +00002171 p.JarToExport = implementationJars[0]
2172 p.TestConfig = test.testConfig
Paul Duffin14eb4672020-03-02 11:33:02 +00002173}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002174
Paul Duffin3a4eb502020-03-19 16:11:18 +00002175func (p *testSdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffina551a1c2020-03-17 21:04:24 +00002176 builder := ctx.SnapshotBuilder()
Paul Duffin3a4eb502020-03-19 16:11:18 +00002177
Paul Duffina551a1c2020-03-17 21:04:24 +00002178 exportedJar := p.JarToExport
2179 if exportedJar != nil {
2180 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
2181 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
Paul Duffin14eb4672020-03-02 11:33:02 +00002182
2183 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
Paul Duffina551a1c2020-03-17 21:04:24 +00002184 }
2185
2186 testConfig := p.TestConfig
2187 if testConfig != nil {
2188 snapshotRelativeTestConfigPath := sdkSnapshotFilePathForMember(p.OsPrefix(), ctx.Name(), testConfigSuffix)
2189 builder.CopyToSnapshot(testConfig, snapshotRelativeTestConfigPath)
Paul Duffin14eb4672020-03-02 11:33:02 +00002190 propertySet.AddProperty("test_config", snapshotRelativeTestConfigPath)
2191 }
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002192}
2193
Colin Cross1b16b0e2019-02-12 14:41:32 -08002194// java_test builds a and links sources into a `.jar` file for the device, and possibly for the host as well, and
2195// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
2196//
2197// By default, a java_test has a single variant that produces a `.jar` file containing `classes.dex` files that were
2198// compiled against the device bootclasspath.
2199//
2200// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2201// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002202func TestFactory() android.Module {
2203 module := &Test{}
2204
2205 module.AddProperties(
2206 &module.Module.properties,
2207 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002208 &module.Module.dexpreoptProperties,
Colin Cross05638fc2018-04-09 18:40:24 -07002209 &module.Module.protoProperties,
2210 &module.testProperties)
2211
Colin Cross9ae1b922018-06-26 17:59:05 -07002212 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse3026872019-01-05 22:30:13 -08002213 module.Module.dexpreopter.isTest = true
Colin Cross9ae1b922018-06-26 17:59:05 -07002214
Colin Cross05638fc2018-04-09 18:40:24 -07002215 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002216 return module
2217}
2218
Paul Duffin42df1442019-03-20 12:45:53 +00002219// java_test_helper_library creates a java library and makes sure that it is added to the appropriate test suite.
2220func TestHelperLibraryFactory() android.Module {
2221 module := &TestHelperLibrary{}
2222
2223 module.AddProperties(
2224 &module.Module.properties,
2225 &module.Module.deviceProperties,
2226 &module.Module.dexpreoptProperties,
2227 &module.Module.protoProperties,
2228 &module.testHelperLibraryProperties)
2229
Colin Cross9a4abed2019-04-24 13:19:28 -07002230 module.Module.properties.Installable = proptools.BoolPtr(true)
2231 module.Module.dexpreopter.isTest = true
2232
Paul Duffin42df1442019-03-20 12:45:53 +00002233 InitJavaModule(module, android.HostAndDeviceSupported)
2234 return module
2235}
2236
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002237// java_test_import imports one or more `.jar` files into the build graph as if they were built by a java_test module
2238// and makes sure that it is added to the appropriate test suite.
2239//
2240// By default, a java_test_import has a single variant that expects a `.jar` file containing `.class` files that were
2241// compiled against an Android classpath.
2242//
2243// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2244// for host modules.
2245func JavaTestImportFactory() android.Module {
2246 module := &JavaTestImport{}
2247
2248 module.AddProperties(
2249 &module.Import.properties,
2250 &module.prebuiltTestProperties)
2251
2252 module.Import.properties.Installable = proptools.BoolPtr(true)
2253
2254 android.InitPrebuiltModule(module, &module.properties.Jars)
2255 android.InitApexModule(module)
2256 android.InitSdkAwareModule(module)
2257 InitJavaModule(module, android.HostAndDeviceSupported)
2258 return module
2259}
2260
Colin Cross1b16b0e2019-02-12 14:41:32 -08002261// java_test_host builds a and links sources into a `.jar` file for the host, and creates an `AndroidTest.xml` file to
2262// allow running the test with `atest` or a `TEST_MAPPING` file.
2263//
2264// A java_test_host has a single variant that produces a `.jar` file containing `.class` files that were
2265// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002266func TestHostFactory() android.Module {
2267 module := &Test{}
2268
2269 module.AddProperties(
2270 &module.Module.properties,
2271 &module.Module.protoProperties,
2272 &module.testProperties)
2273
Colin Cross9ae1b922018-06-26 17:59:05 -07002274 module.Module.properties.Installable = proptools.BoolPtr(true)
2275
Colin Cross05638fc2018-04-09 18:40:24 -07002276 InitJavaModule(module, android.HostSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002277 return module
2278}
2279
2280//
Colin Cross2fe66872015-03-30 17:20:39 -07002281// Java Binaries (.jar file plus wrapper script)
2282//
2283
Colin Crossf506d872017-07-19 15:53:04 -07002284type binaryProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -07002285 // installable script to execute the resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -08002286 Wrapper *string `android:"path"`
Colin Cross094054a2018-10-17 15:10:48 -07002287
2288 // Name of the class containing main to be inserted into the manifest as Main-Class.
2289 Main_class *string
Colin Cross7d5136f2015-05-11 13:39:40 -07002290}
2291
Colin Crossf506d872017-07-19 15:53:04 -07002292type Binary struct {
2293 Library
Colin Cross2fe66872015-03-30 17:20:39 -07002294
Colin Crossf506d872017-07-19 15:53:04 -07002295 binaryProperties binaryProperties
Colin Cross10a03492017-08-10 17:09:43 -07002296
Colin Cross6b4a32d2017-12-05 13:42:45 -08002297 isWrapperVariant bool
2298
Colin Crossc3315992017-12-08 19:12:36 -08002299 wrapperFile android.Path
Colin Cross70dda7e2019-10-01 22:05:35 -07002300 binaryFile android.InstallPath
Colin Cross2fe66872015-03-30 17:20:39 -07002301}
2302
Alex Light24237172017-10-26 09:46:21 -07002303func (j *Binary) HostToolPath() android.OptionalPath {
2304 return android.OptionalPathForPath(j.binaryFile)
2305}
2306
Colin Crossf506d872017-07-19 15:53:04 -07002307func (j *Binary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002308 if ctx.Arch().ArchType == android.Common {
2309 // Compile the jar
Colin Cross094054a2018-10-17 15:10:48 -07002310 if j.binaryProperties.Main_class != nil {
2311 if j.properties.Manifest != nil {
2312 ctx.PropertyErrorf("main_class", "main_class cannot be used when manifest is set")
2313 }
2314 manifestFile := android.PathForModuleOut(ctx, "manifest.txt")
2315 GenerateMainClassManifest(ctx, manifestFile, String(j.binaryProperties.Main_class))
2316 j.overrideManifest = android.OptionalPathForPath(manifestFile)
2317 }
2318
Colin Cross6b4a32d2017-12-05 13:42:45 -08002319 j.Library.GenerateAndroidBuildActions(ctx)
Nan Zhang3c807db2017-11-03 14:53:31 -07002320 } else {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002321 // Handle the binary wrapper
2322 j.isWrapperVariant = true
2323
Colin Cross366938f2017-12-11 16:29:02 -08002324 if j.binaryProperties.Wrapper != nil {
Colin Cross8a497952019-03-05 22:25:09 -08002325 j.wrapperFile = android.PathForModuleSrc(ctx, *j.binaryProperties.Wrapper)
Colin Cross6b4a32d2017-12-05 13:42:45 -08002326 } else {
2327 j.wrapperFile = android.PathForSource(ctx, "build/soong/scripts/jar-wrapper.sh")
2328 }
2329
2330 // Depend on the installed jar so that the wrapper doesn't get executed by
2331 // another build rule before the jar has been installed.
2332 jarFile := ctx.PrimaryModule().(*Binary).installFile
2333
2334 j.binaryFile = ctx.InstallExecutable(android.PathForModuleInstall(ctx, "bin"),
2335 ctx.ModuleName(), j.wrapperFile, jarFile)
Nan Zhang3c807db2017-11-03 14:53:31 -07002336 }
Colin Cross2fe66872015-03-30 17:20:39 -07002337}
2338
Colin Crossf506d872017-07-19 15:53:04 -07002339func (j *Binary) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002340 if ctx.Arch().ArchType == android.Common {
2341 j.deps(ctx)
2342 }
Colin Cross46c9b8b2017-06-22 16:51:17 -07002343}
2344
Colin Cross1b16b0e2019-02-12 14:41:32 -08002345// java_binary builds a `.jar` file and a shell script that executes it for the device, and possibly for the host
2346// as well.
2347//
2348// By default, a java_binary has a single variant that produces a `.jar` file containing `classes.dex` files that were
2349// compiled against the device bootclasspath.
2350//
2351// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2352// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002353func BinaryFactory() android.Module {
2354 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002355
Colin Cross36242852017-06-23 15:06:31 -07002356 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07002357 &module.Module.properties,
2358 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002359 &module.Module.dexpreoptProperties,
Colin Cross6af17aa2017-09-20 12:59:05 -07002360 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07002361 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002362
Colin Cross9ae1b922018-06-26 17:59:05 -07002363 module.Module.properties.Installable = proptools.BoolPtr(true)
2364
Colin Cross6b4a32d2017-12-05 13:42:45 -08002365 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibCommonFirst)
2366 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002367 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002368}
2369
Colin Cross1b16b0e2019-02-12 14:41:32 -08002370// java_binary_host builds a `.jar` file and a shell script that executes it for the host.
2371//
2372// A java_binary_host has a single variant that produces a `.jar` file containing `.class` files that were
2373// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002374func BinaryHostFactory() android.Module {
2375 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002376
Colin Cross36242852017-06-23 15:06:31 -07002377 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07002378 &module.Module.properties,
Colin Cross6af17aa2017-09-20 12:59:05 -07002379 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07002380 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002381
Colin Cross9ae1b922018-06-26 17:59:05 -07002382 module.Module.properties.Installable = proptools.BoolPtr(true)
2383
Colin Cross6b4a32d2017-12-05 13:42:45 -08002384 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommonFirst)
2385 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002386 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002387}
2388
2389//
2390// Java prebuilts
2391//
2392
Colin Cross74d73e22017-08-02 11:05:49 -07002393type ImportProperties struct {
Paul Duffina04c1072020-03-02 10:16:35 +00002394 Jars []string `android:"path,arch_variant"`
Colin Cross461bd1a2017-10-20 13:59:18 -07002395
Nan Zhangea568a42017-11-08 21:20:04 -08002396 Sdk_version *string
Colin Cross535e2cf2017-10-20 17:57:49 -07002397
2398 Installable *bool
Jiyong Park1be96912018-05-28 18:02:19 +09002399
2400 // List of shared java libs that this module has dependencies to
2401 Libs []string
Colin Cross37f6d792018-07-12 12:28:41 -07002402
2403 // List of files to remove from the jar file(s)
2404 Exclude_files []string
2405
2406 // List of directories to remove from the jar file(s)
2407 Exclude_dirs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -07002408
2409 // if set to true, run Jetifier against .jar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -07002410 Jetifier *bool
Jiyong Park4c4c0242019-10-21 14:53:15 +09002411
2412 // set the name of the output
2413 Stem *string
Jiyong Park19604de2020-03-24 16:44:11 +09002414
2415 Aidl struct {
2416 // directories that should be added as include directories for any aidl sources of modules
2417 // that depend on this module, as well as to aidl for this module.
2418 Export_include_dirs []string
2419 }
Colin Cross74d73e22017-08-02 11:05:49 -07002420}
2421
2422type Import struct {
Colin Cross635c3b02016-05-18 15:37:25 -07002423 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -07002424 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002425 android.ApexModuleBase
Colin Crossec7a0422017-07-07 14:47:12 -07002426 prebuilt android.Prebuilt
Jiyong Parkd1063c12019-07-17 20:08:41 +09002427 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -07002428
Paul Duffin0d3c2e12020-05-17 08:34:50 +01002429 // Functionality common to Module and Import.
2430 embeddableInModuleAndImport
2431
Colin Cross74d73e22017-08-02 11:05:49 -07002432 properties ImportProperties
2433
Colin Cross0a6e0072017-08-30 14:24:55 -07002434 combinedClasspathFile android.Path
Jiyong Park1be96912018-05-28 18:02:19 +09002435 exportedSdkLibs []string
Jiyong Park19604de2020-03-24 16:44:11 +09002436 exportAidlIncludeDirs android.Paths
Colin Cross2fe66872015-03-30 17:20:39 -07002437}
2438
Jiyong Park6a927c42020-01-21 02:03:43 +09002439func (j *Import) sdkVersion() sdkSpec {
2440 return sdkSpecFrom(String(j.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07002441}
2442
Jiyong Park6a927c42020-01-21 02:03:43 +09002443func (j *Import) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -07002444 return j.sdkVersion()
2445}
2446
Artur Satayev480e25b2020-04-27 18:53:18 +01002447func (j *Import) MinSdkVersion() string {
2448 return j.minSdkVersion().version.String()
2449}
2450
Colin Cross74d73e22017-08-02 11:05:49 -07002451func (j *Import) Prebuilt() *android.Prebuilt {
Colin Crossec7a0422017-07-07 14:47:12 -07002452 return &j.prebuilt
2453}
2454
Colin Cross74d73e22017-08-02 11:05:49 -07002455func (j *Import) PrebuiltSrcs() []string {
2456 return j.properties.Jars
2457}
2458
2459func (j *Import) Name() string {
Colin Cross5ea9bcc2017-07-27 15:41:32 -07002460 return j.prebuilt.Name(j.ModuleBase.Name())
2461}
2462
Jiyong Park0b238752019-10-29 11:23:10 +09002463func (j *Import) Stem() string {
2464 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2465}
2466
Jiyong Park618922e2020-01-08 13:35:43 +09002467func (a *Import) JacocoReportClassesFile() android.Path {
2468 return nil
2469}
2470
Colin Cross74d73e22017-08-02 11:05:49 -07002471func (j *Import) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross42d48b72018-08-29 14:10:52 -07002472 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Colin Cross1e676be2016-10-12 14:38:15 -07002473}
2474
Colin Cross74d73e22017-08-02 11:05:49 -07002475func (j *Import) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross8a497952019-03-05 22:25:09 -08002476 jars := android.PathsForModuleSrc(ctx, j.properties.Jars)
Colin Crosse1d62a82015-04-03 16:53:05 -07002477
Jiyong Park0b238752019-10-29 11:23:10 +09002478 jarName := j.Stem() + ".jar"
Nan Zhang4c819fb2018-08-27 18:31:46 -07002479 outputFile := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07002480 TransformJarsToJar(ctx, outputFile, "for prebuilts", jars, android.OptionalPath{},
2481 false, j.properties.Exclude_files, j.properties.Exclude_dirs)
Colin Cross1001a792019-03-21 22:21:39 -07002482 if Bool(j.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -07002483 inputFile := outputFile
2484 outputFile = android.PathForModuleOut(ctx, "jetifier", jarName)
2485 TransformJetifier(ctx, outputFile, inputFile)
2486 }
Colin Crosse9a275b2017-10-16 17:09:48 -07002487 j.combinedClasspathFile = outputFile
Jiyong Park1be96912018-05-28 18:02:19 +09002488
Paul Duffin859fe962020-05-15 10:20:31 +01002489 // If this is a component library (impl, stubs, etc.) for a java_sdk_library then
2490 // add the name of that java_sdk_library to the exported sdk libs to make sure
2491 // that, if necessary, a <uses-library> element for that java_sdk_library is
2492 // added to the Android manifest.
2493 j.exportedSdkLibs = append(j.exportedSdkLibs, j.OptionalImplicitSdkLibrary()...)
2494
Jiyong Park1be96912018-05-28 18:02:19 +09002495 ctx.VisitDirectDeps(func(module android.Module) {
2496 otherName := ctx.OtherModuleName(module)
2497 tag := ctx.OtherModuleDependencyTag(module)
2498
2499 switch dep := module.(type) {
2500 case Dependency:
2501 switch tag {
2502 case libTag, staticLibTag:
2503 // sdk lib names from dependencies are re-exported
2504 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
2505 }
2506 case SdkLibraryDependency:
2507 switch tag {
2508 case libTag:
2509 // names of sdk libs that are directly depended are exported
2510 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
2511 }
2512 }
2513 })
2514
2515 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002516 if Bool(j.properties.Installable) {
2517 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Park4c4c0242019-10-21 14:53:15 +09002518 jarName, outputFile)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002519 }
Jiyong Park19604de2020-03-24 16:44:11 +09002520
2521 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.properties.Aidl.Export_include_dirs)
Colin Cross2fe66872015-03-30 17:20:39 -07002522}
2523
Colin Cross74d73e22017-08-02 11:05:49 -07002524var _ Dependency = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002525
Nan Zhanged19fc32017-10-19 13:06:22 -07002526func (j *Import) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002527 if j.combinedClasspathFile == nil {
2528 return nil
2529 }
Colin Cross37f6d792018-07-12 12:28:41 -07002530 return android.Paths{j.combinedClasspathFile}
Nan Zhanged19fc32017-10-19 13:06:22 -07002531}
2532
2533func (j *Import) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08002534 if j.combinedClasspathFile == nil {
2535 return nil
2536 }
Colin Cross37f6d792018-07-12 12:28:41 -07002537 return android.Paths{j.combinedClasspathFile}
Colin Cross2fe66872015-03-30 17:20:39 -07002538}
2539
Colin Cross331a1212018-08-15 20:40:52 -07002540func (j *Import) ResourceJars() android.Paths {
2541 return nil
2542}
2543
2544func (j *Import) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002545 if j.combinedClasspathFile == nil {
2546 return nil
2547 }
Colin Cross331a1212018-08-15 20:40:52 -07002548 return android.Paths{j.combinedClasspathFile}
2549}
2550
Colin Crossf24a22a2019-01-31 14:12:44 -08002551func (j *Import) DexJar() android.Path {
2552 return nil
2553}
2554
Colin Cross74d73e22017-08-02 11:05:49 -07002555func (j *Import) AidlIncludeDirs() android.Paths {
Jiyong Park19604de2020-03-24 16:44:11 +09002556 return j.exportAidlIncludeDirs
Colin Crossc0b06f12015-04-08 13:03:43 -07002557}
2558
Jiyong Park1be96912018-05-28 18:02:19 +09002559func (j *Import) ExportedSdkLibs() []string {
2560 return j.exportedSdkLibs
2561}
2562
Artur Satayev9cf46692019-11-26 18:08:34 +00002563func (j *Import) ExportedPlugins() (android.Paths, []string) {
2564 return nil, nil
2565}
2566
Colin Cross0c4ce212019-05-03 15:28:19 -07002567func (j *Import) SrcJarArgs() ([]string, android.Paths) {
2568 return nil, nil
2569}
2570
Jiyong Park0f80c182020-01-31 02:49:53 +09002571func (j *Import) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Paul Duffin0d3c2e12020-05-17 08:34:50 +01002572 return j.depIsInSameApex(ctx, dep)
Jiyong Park0f80c182020-01-31 02:49:53 +09002573}
2574
albaltai36ff7dc2018-12-25 14:35:23 +08002575// Add compile time check for interface implementation
2576var _ android.IDEInfo = (*Import)(nil)
2577var _ android.IDECustomizedModuleName = (*Import)(nil)
2578
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002579// Collect information for opening IDE project files in java/jdeps.go.
2580const (
2581 removedPrefix = "prebuilt_"
2582)
2583
2584func (j *Import) IDEInfo(dpInfo *android.IdeInfo) {
2585 dpInfo.Jars = append(dpInfo.Jars, j.PrebuiltSrcs()...)
2586}
2587
2588func (j *Import) IDECustomizedModuleName() string {
2589 // TODO(b/113562217): Extract the base module name from the Import name, often the Import name
2590 // has a prefix "prebuilt_". Remove the prefix explicitly if needed until we find a better
2591 // solution to get the Import name.
2592 name := j.Name()
2593 if strings.HasPrefix(name, removedPrefix) {
patricktubb640e02018-10-11 18:33:16 +08002594 name = strings.TrimPrefix(name, removedPrefix)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002595 }
2596 return name
2597}
2598
Colin Cross74d73e22017-08-02 11:05:49 -07002599var _ android.PrebuiltInterface = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002600
Colin Cross1b16b0e2019-02-12 14:41:32 -08002601// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library module.
2602//
2603// By default, a java_import has a single variant that expects a `.jar` file containing `.class` files that were
2604// compiled against an Android classpath.
2605//
2606// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2607// for host modules.
Colin Cross74d73e22017-08-02 11:05:49 -07002608func ImportFactory() android.Module {
2609 module := &Import{}
Colin Cross36242852017-06-23 15:06:31 -07002610
Colin Cross74d73e22017-08-02 11:05:49 -07002611 module.AddProperties(&module.properties)
2612
Paul Duffin859fe962020-05-15 10:20:31 +01002613 module.initModuleAndImport(&module.ModuleBase)
2614
Colin Cross74d73e22017-08-02 11:05:49 -07002615 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002616 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002617 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002618 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross36242852017-06-23 15:06:31 -07002619 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002620}
2621
Colin Cross1b16b0e2019-02-12 14:41:32 -08002622// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library_host
2623// module.
2624//
2625// A java_import_host has a single variant that expects a `.jar` file containing `.class` files that were
2626// compiled against a host bootclasspath.
Colin Cross74d73e22017-08-02 11:05:49 -07002627func ImportFactoryHost() android.Module {
2628 module := &Import{}
2629
2630 module.AddProperties(&module.properties)
2631
2632 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002633 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002634 InitJavaModule(module, android.HostSupported)
Colin Cross74d73e22017-08-02 11:05:49 -07002635 return module
2636}
2637
Colin Cross42be7612019-02-21 18:12:14 -08002638// dex_import module
2639
2640type DexImportProperties struct {
Colin Cross5cfc70d2019-07-15 13:36:55 -07002641 Jars []string `android:"path"`
Jiyong Park4c4c0242019-10-21 14:53:15 +09002642
2643 // set the name of the output
2644 Stem *string
Colin Cross42be7612019-02-21 18:12:14 -08002645}
2646
2647type DexImport struct {
2648 android.ModuleBase
2649 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002650 android.ApexModuleBase
Colin Cross42be7612019-02-21 18:12:14 -08002651 prebuilt android.Prebuilt
2652
2653 properties DexImportProperties
2654
2655 dexJarFile android.Path
2656 maybeStrippedDexJarFile android.Path
2657
2658 dexpreopter
2659}
2660
2661func (j *DexImport) Prebuilt() *android.Prebuilt {
2662 return &j.prebuilt
2663}
2664
2665func (j *DexImport) PrebuiltSrcs() []string {
2666 return j.properties.Jars
2667}
2668
2669func (j *DexImport) Name() string {
2670 return j.prebuilt.Name(j.ModuleBase.Name())
2671}
2672
Jiyong Park0b238752019-10-29 11:23:10 +09002673func (j *DexImport) Stem() string {
2674 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2675}
2676
Martin Stjernholm6d415272020-01-31 17:10:36 +00002677func (j *DexImport) IsInstallable() bool {
2678 return true
2679}
2680
Colin Cross42be7612019-02-21 18:12:14 -08002681func (j *DexImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2682 if len(j.properties.Jars) != 1 {
2683 ctx.PropertyErrorf("jars", "exactly one jar must be provided")
2684 }
2685
Jiyong Park0b238752019-10-29 11:23:10 +09002686 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross42be7612019-02-21 18:12:14 -08002687 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
2688
2689 inputJar := ctx.ExpandSource(j.properties.Jars[0], "jars")
2690 dexOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar")
2691
2692 if j.dexpreopter.uncompressedDex {
2693 rule := android.NewRuleBuilder()
2694
2695 temporary := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar.unaligned")
2696 rule.Temporary(temporary)
2697
2698 // use zip2zip to uncompress classes*.dex files
2699 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002700 BuiltTool(ctx, "zip2zip").
Colin Cross42be7612019-02-21 18:12:14 -08002701 FlagWithInput("-i ", inputJar).
2702 FlagWithOutput("-o ", temporary).
2703 FlagWithArg("-0 ", "'classes*.dex'")
2704
2705 // use zipalign to align uncompressed classes*.dex files
2706 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002707 BuiltTool(ctx, "zipalign").
Colin Cross42be7612019-02-21 18:12:14 -08002708 Flag("-f").
2709 Text("4").
2710 Input(temporary).
2711 Output(dexOutputFile)
2712
2713 rule.DeleteTemporaryFiles()
2714
2715 rule.Build(pctx, ctx, "uncompress_dex", "uncompress dex")
2716 } else {
2717 ctx.Build(pctx, android.BuildParams{
2718 Rule: android.Cp,
2719 Input: inputJar,
2720 Output: dexOutputFile,
2721 })
2722 }
2723
2724 j.dexJarFile = dexOutputFile
2725
2726 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
2727
2728 j.maybeStrippedDexJarFile = dexOutputFile
2729
2730 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
2731 ctx.ModuleName()+".jar", dexOutputFile)
2732}
2733
2734func (j *DexImport) DexJar() android.Path {
2735 return j.dexJarFile
2736}
2737
2738// dex_import imports a `.jar` file containing classes.dex files.
2739//
2740// A dex_import module cannot be used as a dependency of a java_* or android_* module, it can only be installed
2741// to the device.
2742func DexImportFactory() android.Module {
2743 module := &DexImport{}
2744
2745 module.AddProperties(&module.properties)
2746
2747 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002748 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002749 InitJavaModule(module, android.DeviceSupported)
Colin Cross42be7612019-02-21 18:12:14 -08002750 return module
2751}
2752
Colin Cross89536d42017-07-07 14:35:50 -07002753//
2754// Defaults
2755//
2756type Defaults struct {
2757 android.ModuleBase
2758 android.DefaultsModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002759 android.ApexModuleBase
Colin Cross89536d42017-07-07 14:35:50 -07002760}
2761
Colin Cross1b16b0e2019-02-12 14:41:32 -08002762// java_defaults provides a set of properties that can be inherited by other java or android modules.
2763//
2764// A module can use the properties from a java_defaults module using `defaults: ["defaults_module_name"]`. Each
2765// property in the defaults module that exists in the depending module will be prepended to the depending module's
2766// value for that property.
2767//
2768// Example:
2769//
2770// java_defaults {
2771// name: "example_defaults",
2772// srcs: ["common/**/*.java"],
2773// javacflags: ["-Xlint:all"],
2774// aaptflags: ["--auto-add-overlay"],
2775// }
2776//
2777// java_library {
2778// name: "example",
2779// defaults: ["example_defaults"],
2780// srcs: ["example/**/*.java"],
2781// }
2782//
2783// is functionally identical to:
2784//
2785// java_library {
2786// name: "example",
2787// srcs: [
2788// "common/**/*.java",
2789// "example/**/*.java",
2790// ],
2791// javacflags: ["-Xlint:all"],
2792// }
Colin Cross89536d42017-07-07 14:35:50 -07002793func defaultsFactory() android.Module {
2794 return DefaultsFactory()
2795}
2796
Paul Duffin47357662019-12-05 14:07:14 +00002797func DefaultsFactory() android.Module {
Colin Cross89536d42017-07-07 14:35:50 -07002798 module := &Defaults{}
2799
Colin Cross89536d42017-07-07 14:35:50 -07002800 module.AddProperties(
2801 &CompilerProperties{},
2802 &CompilerDeviceProperties{},
Colin Cross43f08db2018-11-12 10:13:39 -08002803 &DexpreoptProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08002804 &android.ProtoProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002805 &aaptProperties{},
2806 &androidLibraryProperties{},
2807 &appProperties{},
2808 &appTestProperties{},
Jaewoong Jung525443a2019-02-28 15:35:54 -08002809 &overridableAppProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002810 &ImportProperties{},
2811 &AARImportProperties{},
2812 &sdkLibraryProperties{},
Paul Duffin1b1e8062020-05-08 13:44:43 +01002813 &commonToSdkLibraryAndImportProperties{},
Colin Cross42be7612019-02-21 18:12:14 -08002814 &DexImportProperties{},
Jooyung Han18020ea2019-11-13 10:50:48 +09002815 &android.ApexProperties{},
Jaewoong Jungbf135462020-04-26 15:10:51 -07002816 &RuntimeResourceOverlayProperties{},
Colin Cross89536d42017-07-07 14:35:50 -07002817 )
2818
2819 android.InitDefaultsModule(module)
Colin Cross89536d42017-07-07 14:35:50 -07002820 return module
2821}
Nan Zhangea568a42017-11-08 21:20:04 -08002822
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002823func kytheExtractJavaFactory() android.Singleton {
2824 return &kytheExtractJavaSingleton{}
2825}
2826
2827type kytheExtractJavaSingleton struct {
2828}
2829
2830func (ks *kytheExtractJavaSingleton) GenerateBuildActions(ctx android.SingletonContext) {
2831 var xrefTargets android.Paths
2832 ctx.VisitAllModules(func(module android.Module) {
2833 if javaModule, ok := module.(xref); ok {
2834 xrefTargets = append(xrefTargets, javaModule.XrefJavaFiles()...)
2835 }
2836 })
2837 // TODO(asmundak): perhaps emit a rule to output a warning if there were no xrefTargets
2838 if len(xrefTargets) > 0 {
2839 ctx.Build(pctx, android.BuildParams{
2840 Rule: blueprint.Phony,
2841 Output: android.PathForPhony(ctx, "xref_java"),
2842 Inputs: xrefTargets,
2843 })
2844 }
2845}
2846
Nan Zhangea568a42017-11-08 21:20:04 -08002847var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07002848var BoolDefault = proptools.BoolDefault
Nan Zhangea568a42017-11-08 21:20:04 -08002849var String = proptools.String
Colin Cross0d0ba592018-02-20 13:33:42 -08002850var inList = android.InList