blob: 7d31f669d678cf55ab42d3d1050df811610f189f [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) {
Jeongik Cha2cc570d2019-10-29 15:44:45 +090098 if j.SocSpecific() || j.DeviceSpecific() ||
99 (j.ProductSpecific() && ctx.Config().EnforceProductPartitionInterface()) {
100 if sc, ok := ctx.Module().(sdkContext); ok {
Jiyong Park6a927c42020-01-21 02:03:43 +0900101 if !sc.sdkVersion().specified() {
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900102 ctx.PropertyErrorf("sdk_version",
103 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
104 }
105 }
106 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100107
108 ctx.VisitDirectDeps(func(module android.Module) {
109 tag := ctx.OtherModuleDependencyTag(module)
110 switch module.(type) {
111 // TODO(satayev): cover other types as well, e.g. imports
112 case *Library, *AndroidLibrary:
113 switch tag {
114 case bootClasspathTag, libTag, staticLibTag, java9LibTag:
115 checkLinkType(ctx, j, module.(linkTypeContext), tag.(dependencyTag))
116 }
117 }
118 })
Jeongik Cha2cc570d2019-10-29 15:44:45 +0900119}
120
Jeongik Cha538c0d02019-07-11 15:54:27 +0900121func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
122 if sc, ok := ctx.Module().(sdkContext); ok {
123 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park6a927c42020-01-21 02:03:43 +0900124 sdkVersionSpecified := sc.sdkVersion().specified()
125 if usePlatformAPI && sdkVersionSpecified {
126 ctx.PropertyErrorf("platform_apis", "platform_apis must be false when sdk_version is not empty.")
127 } else if !usePlatformAPI && !sdkVersionSpecified {
128 ctx.PropertyErrorf("platform_apis", "platform_apis must be true when sdk_version is empty.")
Jeongik Cha538c0d02019-07-11 15:54:27 +0900129 }
130
131 }
132}
133
Colin Cross2fe66872015-03-30 17:20:39 -0700134// TODO:
135// Autogenerated files:
Colin Cross2fe66872015-03-30 17:20:39 -0700136// Renderscript
137// Post-jar passes:
138// Proguard
Colin Cross2fe66872015-03-30 17:20:39 -0700139// Rmtypedefs
Colin Cross2fe66872015-03-30 17:20:39 -0700140// DroidDoc
141// Findbugs
142
Colin Cross89536d42017-07-07 14:35:50 -0700143type CompilerProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -0700144 // list of source files used to compile the Java module. May be .java, .logtags, .proto,
145 // or .aidl files.
Colin Cross27b922f2019-03-04 22:35:41 -0800146 Srcs []string `android:"path,arch_variant"`
Dan Willemsen2ef08f42015-06-30 18:15:24 -0700147
148 // list of source files that should not be used to build the Java module.
149 // This is most useful in the arch/multilib variants to remove non-common files
Colin Cross27b922f2019-03-04 22:35:41 -0800150 Exclude_srcs []string `android:"path,arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700151
152 // list of directories containing Java resources
Colin Cross86a63ff2017-09-27 17:33:10 -0700153 Java_resource_dirs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700154
Colin Cross86a63ff2017-09-27 17:33:10 -0700155 // list of directories that should be excluded from java_resource_dirs
156 Exclude_java_resource_dirs []string `android:"arch_variant"`
Dan Willemsen2ef08f42015-06-30 18:15:24 -0700157
Colin Cross0f37af02017-09-27 17:42:05 -0700158 // list of files to use as Java resources
Colin Cross27b922f2019-03-04 22:35:41 -0800159 Java_resources []string `android:"path,arch_variant"`
Colin Cross0f37af02017-09-27 17:42:05 -0700160
Colin Crosscedd4762018-09-13 11:26:19 -0700161 // list of files that should be excluded from java_resources and java_resource_dirs
Colin Cross27b922f2019-03-04 22:35:41 -0800162 Exclude_java_resources []string `android:"path,arch_variant"`
Colin Cross0f37af02017-09-27 17:42:05 -0700163
Colin Cross7d5136f2015-05-11 13:39:40 -0700164 // list of module-specific flags that will be used for javac compiles
165 Javacflags []string `android:"arch_variant"`
166
Zoran Jovanovic8736ce22018-08-21 17:10:29 +0200167 // list of module-specific flags that will be used for kotlinc compiles
168 Kotlincflags []string `android:"arch_variant"`
169
Colin Cross7d5136f2015-05-11 13:39:40 -0700170 // list of of java libraries that will be in the classpath
Colin Crosse8dc34a2017-07-19 11:22:16 -0700171 Libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700172
173 // list of java libraries that will be compiled into the resulting jar
Colin Crosse8dc34a2017-07-19 11:22:16 -0700174 Static_libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700175
176 // manifest file to be included in resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -0800177 Manifest *string `android:"path"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700178
Colin Cross540eff82017-06-22 17:01:52 -0700179 // if not blank, run jarjar using the specified rules file
Colin Cross27b922f2019-03-04 22:35:41 -0800180 Jarjar_rules *string `android:"path,arch_variant"`
Colin Cross64162712017-08-08 13:17:59 -0700181
182 // If not blank, set the java version passed to javac as -source and -target
183 Java_version *string
Colin Cross2c429dc2017-08-31 16:45:16 -0700184
Colin Cross9ae1b922018-06-26 17:59:05 -0700185 // If set to true, allow this module to be dexed and installed on devices. Has no
186 // effect on host modules, which are always considered installable.
Colin Cross2c429dc2017-08-31 16:45:16 -0700187 Installable *bool
Colin Cross32f676a2017-09-06 13:41:06 -0700188
Colin Cross0f37af02017-09-27 17:42:05 -0700189 // If set to true, include sources used to compile the module in to the final jar
190 Include_srcs *bool
191
Vladimir Marko0975ee02019-04-02 10:29:55 +0100192 // If not empty, classes are restricted to the specified packages and their sub-packages.
193 // This restriction is checked after applying jarjar rules and including static libs.
194 Permitted_packages []string
195
Colin Crossbe9cdb82019-01-21 21:37:16 -0800196 // List of modules to use as annotation processors
197 Plugins []string
Colin Cross1369cdb2017-09-29 17:58:17 -0700198
Artur Satayev9cf46692019-11-26 18:08:34 +0000199 // List of modules to export to libraries that directly depend on this library as annotation processors
200 Exported_plugins []string
201
Nan Zhang61eaedb2017-11-02 13:28:15 -0700202 // The number of Java source entries each Javac instance can process
203 Javac_shard_size *int64
204
Nan Zhang5f8cb422018-02-06 10:34:32 -0800205 // Add host jdk tools.jar to bootclasspath
206 Use_tools_jar *bool
207
Colin Cross1369cdb2017-09-29 17:58:17 -0700208 Openjdk9 struct {
Colin Cross6cef4812019-10-17 14:23:50 -0700209 // List of source files that should only be used when passing -source 1.9 or higher
Colin Cross27b922f2019-03-04 22:35:41 -0800210 Srcs []string `android:"path"`
Colin Cross1369cdb2017-09-29 17:58:17 -0700211
Colin Cross6cef4812019-10-17 14:23:50 -0700212 // List of javac flags that should only be used when passing -source 1.9 or higher
Colin Cross1369cdb2017-09-29 17:58:17 -0700213 Javacflags []string
214 }
Colin Crosscb933592017-11-22 13:49:43 -0800215
Colin Cross81440082018-08-15 20:21:55 -0700216 // When compiling language level 9+ .java code in packages that are part of
217 // a system module, patch_module names the module that your sources and
218 // dependencies should be patched into. The Android runtime currently
219 // doesn't implement the JEP 261 module system so this option is only
220 // supported at compile time. It should only be needed to compile tests in
221 // packages that exist in libcore and which are inconvenient to move
222 // elsewhere.
Tobias Thiererdda713d2018-09-19 16:16:19 +0100223 Patch_module *string `android:"arch_variant"`
Colin Cross81440082018-08-15 20:21:55 -0700224
Colin Crosscb933592017-11-22 13:49:43 -0800225 Jacoco struct {
226 // List of classes to include for instrumentation with jacoco to collect coverage
227 // information at runtime when building with coverage enabled. If unset defaults to all
228 // classes.
229 // Supports '*' as the last character of an entry in the list as a wildcard match.
230 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
231 // it matches classes in the package that have the class name as a prefix.
232 Include_filter []string
233
234 // List of classes to exclude from instrumentation with jacoco to collect coverage
235 // information at runtime when building with coverage enabled. Overrides classes selected
236 // by the include_filter property.
237 // Supports '*' as the last character of an entry in the list as a wildcard match.
238 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
239 // it matches classes in the package that have the class name as a prefix.
240 Exclude_filter []string
241 }
242
Andreas Gampef3e5b552018-01-22 21:27:21 -0800243 Errorprone struct {
244 // List of javac flags that should only be used when running errorprone.
245 Javacflags []string
246 }
247
Colin Cross0f2ee152017-12-14 15:22:43 -0800248 Proto struct {
249 // List of extra options that will be passed to the proto generator.
250 Output_params []string
251 }
252
Colin Crosscb933592017-11-22 13:49:43 -0800253 Instrument bool `blueprint:"mutated"`
Alex Light7f004a72019-02-21 13:27:37 -0800254
255 // List of files to include in the META-INF/services folder of the resulting jar.
Colin Cross27b922f2019-03-04 22:35:41 -0800256 Services []string `android:"path,arch_variant"`
Colin Cross540eff82017-06-22 17:01:52 -0700257}
258
Colin Cross89536d42017-07-07 14:35:50 -0700259type CompilerDeviceProperties struct {
Colin Cross540eff82017-06-22 17:01:52 -0700260 // list of module-specific flags that will be used for dex compiles
261 Dxflags []string `android:"arch_variant"`
262
Jeongik Cha538c0d02019-07-11 15:54:27 +0900263 // if not blank, set to the version of the sdk to compile against.
264 // Defaults to compiling against the current platform.
Nan Zhangea568a42017-11-08 21:20:04 -0800265 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700266
Colin Cross83bb3162018-06-25 15:48:06 -0700267 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
268 // Defaults to sdk_version if not set.
269 Min_sdk_version *string
270
Dan Willemsen419290a2018-10-31 15:28:47 -0700271 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
272 // Defaults to sdk_version if not set.
273 Target_sdk_version *string
274
Jeongik Cha356dac42019-08-19 14:09:52 +0900275 // Whether to compile against the platform APIs instead of an SDK.
276 // If true, then sdk_version must be empty. The value of this field
277 // is ignored when module's type isn't android_app.
Colin Cross6af2e492018-05-22 11:12:33 -0700278 Platform_apis *bool
279
Colin Crossebe1a512017-11-14 13:12:14 -0800280 Aidl struct {
281 // Top level directories to pass to aidl tool
282 Include_dirs []string
Colin Cross7d5136f2015-05-11 13:39:40 -0700283
Colin Crossebe1a512017-11-14 13:12:14 -0800284 // Directories rooted at the Android.bp file to pass to aidl tool
285 Local_include_dirs []string
286
287 // directories that should be added as include directories for any aidl sources of modules
288 // that depend on this module, as well as to aidl for this module.
289 Export_include_dirs []string
Martijn Coeneneab15642018-03-09 09:29:59 +0100290
291 // whether to generate traces (for systrace) for this interface
292 Generate_traces *bool
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100293
294 // whether to generate Binder#GetTransaction name method.
295 Generate_get_transaction_name *bool
Colin Crossebe1a512017-11-14 13:12:14 -0800296 }
Colin Cross92430102017-10-09 14:59:32 -0700297
298 // If true, export a copy of the module as a -hostdex module for host testing.
299 Hostdex *bool
Colin Cross1369cdb2017-09-29 17:58:17 -0700300
Colin Cross7f87f4f2019-04-24 13:41:45 -0700301 Target struct {
302 Hostdex struct {
303 // Additional required dependencies to add to -hostdex modules.
304 Required []string
305 }
306 }
307
David Brazdil17ef5632018-06-27 10:27:45 +0100308 // If set to true, compile dex regardless of installable. Defaults to false.
309 Compile_dex *bool
310
Colin Cross66dbc0b2017-12-28 12:23:20 -0800311 Optimize struct {
Colin Crossae5caf52018-05-22 11:11:52 -0700312 // If false, disable all optimization. Defaults to true for android_app and android_test
313 // modules, false for java_library and java_test modules.
Colin Cross66dbc0b2017-12-28 12:23:20 -0800314 Enabled *bool
Sasha Smundak2057f822019-04-16 17:16:58 -0700315 // True if the module containing this has it set by default.
316 EnabledByDefault bool `blueprint:"mutated"`
Colin Cross66dbc0b2017-12-28 12:23:20 -0800317
318 // If true, optimize for size by removing unused code. Defaults to true for apps,
319 // false for libraries and tests.
320 Shrink *bool
321
322 // If true, optimize bytecode. Defaults to false.
323 Optimize *bool
324
325 // If true, obfuscate bytecode. Defaults to false.
326 Obfuscate *bool
327
328 // If true, do not use the flag files generated by aapt that automatically keep
329 // classes referenced by the app manifest. Defaults to false.
330 No_aapt_flags *bool
331
332 // Flags to pass to proguard.
333 Proguard_flags []string
334
335 // Specifies the locations of files containing proguard flags.
Colin Cross27b922f2019-03-04 22:35:41 -0800336 Proguard_flags_files []string `android:"path"`
Colin Cross66dbc0b2017-12-28 12:23:20 -0800337 }
338
Paul Duffine25c6442019-10-11 13:50:28 +0100339 // When targeting 1.9 and above, override the modules to use with --system,
340 // otherwise provides defaults libraries to add to the bootclasspath.
Colin Cross1369cdb2017-09-29 17:58:17 -0700341 System_modules *string
Colin Cross5a0dcd52018-10-05 14:20:06 -0700342
Jiyong Park4c4c0242019-10-21 14:53:15 +0900343 // set the name of the output
344 Stem *string
345
Colin Cross5a0dcd52018-10-05 14:20:06 -0700346 UncompressDex bool `blueprint:"mutated"`
Colin Cross43f08db2018-11-12 10:13:39 -0800347 IsSDKLibrary bool `blueprint:"mutated"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700348}
349
Sasha Smundak2057f822019-04-16 17:16:58 -0700350func (me *CompilerDeviceProperties) EffectiveOptimizeEnabled() bool {
351 return BoolDefault(me.Optimize.Enabled, me.Optimize.EnabledByDefault)
352}
353
Colin Cross46c9b8b2017-06-22 16:51:17 -0700354// Module contains the properties and members used by all java module types
355type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700356 android.ModuleBase
Colin Cross89536d42017-07-07 14:35:50 -0700357 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +0900358 android.ApexModuleBase
Jiyong Parkd1063c12019-07-17 20:08:41 +0900359 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -0700360
Colin Cross89536d42017-07-07 14:35:50 -0700361 properties CompilerProperties
Colin Cross6af17aa2017-09-20 12:59:05 -0700362 protoProperties android.ProtoProperties
Colin Cross89536d42017-07-07 14:35:50 -0700363 deviceProperties CompilerDeviceProperties
Colin Cross2fe66872015-03-30 17:20:39 -0700364
Colin Cross331a1212018-08-15 20:40:52 -0700365 // jar file containing header classes including static library dependencies, suitable for
366 // inserting into the bootclasspath/classpath of another compile
Nan Zhanged19fc32017-10-19 13:06:22 -0700367 headerJarFile android.Path
368
Colin Cross331a1212018-08-15 20:40:52 -0700369 // jar file containing implementation classes including static library dependencies but no
370 // resources
Nan Zhanged19fc32017-10-19 13:06:22 -0700371 implementationJarFile android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700372
Colin Cross331a1212018-08-15 20:40:52 -0700373 // jar file containing only resources including from static library dependencies
374 resourceJar android.Path
375
Colin Cross0c4ce212019-05-03 15:28:19 -0700376 // args and dependencies to package source files into a srcjar
377 srcJarArgs []string
378 srcJarDeps android.Paths
379
Colin Cross331a1212018-08-15 20:40:52 -0700380 // jar file containing implementation classes and resources including static library
381 // dependencies
382 implementationAndResourcesJar android.Path
383
384 // output file containing classes.dex and resources
Colin Cross6ade34f2017-09-15 13:00:47 -0700385 dexJarFile android.Path
386
Colin Cross43f08db2018-11-12 10:13:39 -0800387 // output file that contains classes.dex if it should be in the output file
388 maybeStrippedDexJarFile android.Path
389
Colin Crosscb933592017-11-22 13:49:43 -0800390 // output file containing uninstrumented classes that will be instrumented by jacoco
391 jacocoReportClassesFile android.Path
392
Colin Cross66dbc0b2017-12-28 12:23:20 -0800393 // output file containing mapping of obfuscated names
394 proguardDictionary android.Path
395
Colin Cross331a1212018-08-15 20:40:52 -0700396 // output file of the module, which may be a classes jar or a dex jar
Colin Crosse560c4a2019-03-19 16:03:11 -0700397 outputFile android.Path
398 extraOutputFiles android.Paths
Colin Crossb7a63242015-04-16 14:09:14 -0700399
Colin Cross635c3b02016-05-18 15:37:25 -0700400 exportAidlIncludeDirs android.Paths
Colin Crossc0b06f12015-04-08 13:03:43 -0700401
Colin Cross635c3b02016-05-18 15:37:25 -0700402 logtagsSrcs android.Paths
Colin Crossf05fe972015-04-10 17:45:20 -0700403
Colin Cross2fe66872015-03-30 17:20:39 -0700404 // installed file for binary dependency
Colin Cross635c3b02016-05-18 15:37:25 -0700405 installFile android.Path
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800406
407 // list of .java files and srcjars that was passed to javac
408 compiledJavaSrcs android.Paths
409 compiledSrcJars android.Paths
Colin Cross66dbc0b2017-12-28 12:23:20 -0800410
411 // list of extra progurad flag files
412 extraProguardFlagFiles android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900413
Colin Cross094054a2018-10-17 15:10:48 -0700414 // manifest file to use instead of properties.Manifest
415 overrideManifest android.OptionalPath
416
Artur Satayev9cf46692019-11-26 18:08:34 +0000417 // list of SDK lib names that this java module is exporting
Jiyong Park1be96912018-05-28 18:02:19 +0900418 exportedSdkLibs []string
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700419
Artur Satayev9cf46692019-11-26 18:08:34 +0000420 // list of plugins that this java module is exporting
421 exportedPluginJars android.Paths
422
423 // list of plugins that this java module is exporting
424 exportedPluginClasses []string
425
426 // list of source files, collected from srcFiles with unique java and all kt files,
patricktu242faad2019-09-24 15:41:30 +0800427 // will be used by android.IDEInfo struct
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700428 expandIDEInfoCompiledSrcs []string
Colin Cross43f08db2018-11-12 10:13:39 -0800429
Steven Morelandc4efd9c2019-01-18 11:51:25 -0800430 // expanded Jarjar_rules
431 expandJarjarRules android.Path
432
Vladimir Marko0975ee02019-04-02 10:29:55 +0100433 // list of additional targets for checkbuild
434 additionalCheckedModules android.Paths
435
Colin Cross988708c2019-05-06 14:04:11 -0700436 // Extra files generated by the module type to be added as java resources.
437 extraResources android.Paths
438
Colin Crossf24a22a2019-01-31 14:12:44 -0800439 hiddenAPI
Colin Cross43f08db2018-11-12 10:13:39 -0800440 dexpreopter
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800441
442 // list of the xref extraction files
443 kytheFiles android.Paths
Anton Hansson78156ef2020-03-27 19:39:48 +0000444
445 distFile android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700446}
447
Colin Cross41955e82019-05-29 14:40:35 -0700448func (j *Module) OutputFiles(tag string) (android.Paths, error) {
449 switch tag {
450 case "":
451 return append(android.Paths{j.outputFile}, j.extraOutputFiles...), nil
Colin Cross375ca3c2019-05-29 14:40:58 -0700452 case ".jar":
453 return android.Paths{j.implementationAndResourcesJar}, nil
Colin Cross2d975b12019-07-29 16:47:42 -0700454 case ".proguard_map":
455 return android.Paths{j.proguardDictionary}, nil
Colin Cross41955e82019-05-29 14:40:35 -0700456 default:
457 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
458 }
Colin Cross54250902017-12-05 09:28:08 -0800459}
460
Colin Cross41955e82019-05-29 14:40:35 -0700461var _ android.OutputFileProducer = (*Module)(nil)
Colin Cross54250902017-12-05 09:28:08 -0800462
Colin Crossf506d872017-07-19 15:53:04 -0700463type Dependency interface {
Nan Zhanged19fc32017-10-19 13:06:22 -0700464 HeaderJars() android.Paths
465 ImplementationJars() android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700466 ResourceJars() android.Paths
467 ImplementationAndResourcesJars() android.Paths
Colin Crossf24a22a2019-01-31 14:12:44 -0800468 DexJar() android.Path
Colin Cross635c3b02016-05-18 15:37:25 -0700469 AidlIncludeDirs() android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900470 ExportedSdkLibs() []string
Artur Satayev9cf46692019-11-26 18:08:34 +0000471 ExportedPlugins() (android.Paths, []string)
Colin Cross0c4ce212019-05-03 15:28:19 -0700472 SrcJarArgs() ([]string, android.Paths)
Colin Crosse323f3c2019-09-17 15:34:09 -0700473 BaseModuleName() string
Jiyong Park618922e2020-01-08 13:35:43 +0900474 JacocoReportClassesFile() android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700475}
476
Jiyong Parkc678ad32018-04-10 13:07:10 +0900477type SdkLibraryDependency interface {
Jiyong Park6a927c42020-01-21 02:03:43 +0900478 SdkHeaderJars(ctx android.BaseModuleContext, sdkVersion sdkSpec) android.Paths
479 SdkImplementationJars(ctx android.BaseModuleContext, sdkVersion sdkSpec) android.Paths
Jiyong Parkc678ad32018-04-10 13:07:10 +0900480}
481
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800482type xref interface {
483 XrefJavaFiles() android.Paths
484}
485
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800486func (j *Module) XrefJavaFiles() android.Paths {
487 return j.kytheFiles
488}
489
Colin Cross89536d42017-07-07 14:35:50 -0700490func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
491 android.InitAndroidArchModule(module, hod, android.MultilibCommon)
492 android.InitDefaultableModule(module)
493}
494
Colin Crossbe1da472017-07-07 15:59:46 -0700495type dependencyTag struct {
496 blueprint.BaseDependencyTag
497 name string
Colin Cross2fe66872015-03-30 17:20:39 -0700498}
499
Colin Crossa4f08812018-10-02 22:03:40 -0700500type jniDependencyTag struct {
501 blueprint.BaseDependencyTag
Colin Crossa4f08812018-10-02 22:03:40 -0700502}
503
Jiyong Park8be103b2019-11-08 15:53:48 +0900504func IsJniDepTag(depTag blueprint.DependencyTag) bool {
505 _, ok := depTag.(*jniDependencyTag)
506 return ok
507}
508
Colin Crossbe1da472017-07-07 15:59:46 -0700509var (
Colin Cross4b964c02018-10-15 16:18:06 -0700510 staticLibTag = dependencyTag{name: "staticlib"}
511 libTag = dependencyTag{name: "javalib"}
Colin Cross6cef4812019-10-17 14:23:50 -0700512 java9LibTag = dependencyTag{name: "java9lib"}
Colin Crossbe9cdb82019-01-21 21:37:16 -0800513 pluginTag = dependencyTag{name: "plugin"}
Artur Satayev9cf46692019-11-26 18:08:34 +0000514 exportedPluginTag = dependencyTag{name: "exported-plugin"}
Colin Cross4b964c02018-10-15 16:18:06 -0700515 bootClasspathTag = dependencyTag{name: "bootclasspath"}
516 systemModulesTag = dependencyTag{name: "system modules"}
517 frameworkResTag = dependencyTag{name: "framework-res"}
518 frameworkApkTag = dependencyTag{name: "framework-apk"}
519 kotlinStdlibTag = dependencyTag{name: "kotlin-stdlib"}
Colin Crossafbb1732019-01-17 15:42:52 -0800520 kotlinAnnotationsTag = dependencyTag{name: "kotlin-annotations"}
Colin Cross4b964c02018-10-15 16:18:06 -0700521 proguardRaiseTag = dependencyTag{name: "proguard-raise"}
522 certificateTag = dependencyTag{name: "certificate"}
523 instrumentationForTag = dependencyTag{name: "instrumentation_for"}
Colin Cross50ddcc42019-05-16 12:28:22 -0700524 usesLibTag = dependencyTag{name: "uses-library"}
Colin Crossbe1da472017-07-07 15:59:46 -0700525)
Colin Cross2fe66872015-03-30 17:20:39 -0700526
Jiyong Park83dc74b2020-01-14 18:38:44 +0900527func IsLibDepTag(depTag blueprint.DependencyTag) bool {
528 return depTag == libTag
529}
530
531func IsStaticLibDepTag(depTag blueprint.DependencyTag) bool {
532 return depTag == staticLibTag
533}
534
Colin Crossfc3674a2017-09-18 17:41:52 -0700535type sdkDep struct {
Colin Cross47ff2522017-10-02 14:22:08 -0700536 useModule, useFiles, useDefaultLibs, invalidVersion bool
537
Colin Cross6cef4812019-10-17 14:23:50 -0700538 // The modules that will be added to the bootclasspath when targeting 1.8 or lower
539 bootclasspath []string
Paul Duffine25c6442019-10-11 13:50:28 +0100540
541 // The default system modules to use. Will be an empty string if no system
542 // modules are to be used.
Colin Cross1369cdb2017-09-29 17:58:17 -0700543 systemModules string
544
Colin Cross6cef4812019-10-17 14:23:50 -0700545 // The modules that will be added ot the classpath when targeting 1.9 or higher
546 java9Classpath []string
547
Colin Crossa97c5d32018-03-28 14:58:31 -0700548 frameworkResModule string
549
Colin Cross86a60ae2018-05-29 14:44:55 -0700550 jars android.Paths
Colin Cross3047fa22019-04-18 10:56:44 -0700551 aidl android.OptionalPath
Paul Duffin250e6192019-06-07 10:44:37 +0100552
553 noStandardLibs, noFrameworksLibs bool
554}
555
556func (s sdkDep) hasStandardLibs() bool {
557 return !s.noStandardLibs
558}
559
560func (s sdkDep) hasFrameworkLibs() bool {
561 return !s.noStandardLibs && !s.noFrameworksLibs
Colin Cross1369cdb2017-09-29 17:58:17 -0700562}
563
Colin Crossa4f08812018-10-02 22:03:40 -0700564type jniLib struct {
Jaewoong Jung87a33e72020-03-26 14:01:48 -0700565 name string
566 path android.Path
567 target android.Target
568 coverageFile android.OptionalPath
Colin Crossa4f08812018-10-02 22:03:40 -0700569}
570
Colin Cross0ea8ba82019-06-06 14:33:29 -0700571func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800572 return j.properties.Instrument && ctx.Config().IsEnvTrue("EMMA_INSTRUMENT")
573}
574
Colin Cross0ea8ba82019-06-06 14:33:29 -0700575func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800576 return j.shouldInstrument(ctx) &&
577 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
578 ctx.Config().UnbundledBuild())
579}
580
Jiyong Park6a927c42020-01-21 02:03:43 +0900581func (j *Module) sdkVersion() sdkSpec {
582 return sdkSpecFrom(String(j.deviceProperties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -0700583}
584
Paul Duffine25c6442019-10-11 13:50:28 +0100585func (j *Module) systemModules() string {
586 return proptools.String(j.deviceProperties.System_modules)
587}
588
Jiyong Park6a927c42020-01-21 02:03:43 +0900589func (j *Module) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -0700590 if j.deviceProperties.Min_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900591 return sdkSpecFrom(*j.deviceProperties.Min_sdk_version)
Colin Cross83bb3162018-06-25 15:48:06 -0700592 }
593 return j.sdkVersion()
594}
595
Jiyong Park6a927c42020-01-21 02:03:43 +0900596func (j *Module) targetSdkVersion() sdkSpec {
Dan Willemsen419290a2018-10-31 15:28:47 -0700597 if j.deviceProperties.Target_sdk_version != nil {
Jiyong Park6a927c42020-01-21 02:03:43 +0900598 return sdkSpecFrom(*j.deviceProperties.Target_sdk_version)
Dan Willemsen419290a2018-10-31 15:28:47 -0700599 }
600 return j.sdkVersion()
601}
602
Artur Satayev480e25b2020-04-27 18:53:18 +0100603func (j *Module) MinSdkVersion() string {
604 return j.minSdkVersion().version.String()
605}
606
Jiyong Parkb02bb402019-12-03 00:43:57 +0900607func (j *Module) AvailableFor(what string) bool {
608 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
609 // Exception: for hostdex: true libraries, the platform variant is created
610 // even if it's not marked as available to platform. In that case, the platform
611 // variant is used only for the hostdex and not installed to the device.
612 return true
613 }
614 return j.ApexModuleBase.AvailableFor(what)
615}
616
Colin Crossbe1da472017-07-07 15:59:46 -0700617func (j *Module) deps(ctx android.BottomUpMutatorContext) {
Colin Cross1369cdb2017-09-29 17:58:17 -0700618 if ctx.Device() {
Paul Duffin250e6192019-06-07 10:44:37 +0100619 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross6d8d8c62019-10-28 15:10:03 -0700620 if sdkDep.useDefaultLibs {
621 ctx.AddVariationDependencies(nil, bootClasspathTag, config.DefaultBootclasspathLibraries...)
622 ctx.AddVariationDependencies(nil, systemModulesTag, config.DefaultSystemModules)
623 if sdkDep.hasFrameworkLibs() {
624 ctx.AddVariationDependencies(nil, libTag, config.DefaultLibraries...)
Colin Crossbe1da472017-07-07 15:59:46 -0700625 }
Colin Cross6d8d8c62019-10-28 15:10:03 -0700626 } else if sdkDep.useModule {
Colin Cross6cef4812019-10-17 14:23:50 -0700627 ctx.AddVariationDependencies(nil, bootClasspathTag, sdkDep.bootclasspath...)
Paul Duffine25c6442019-10-11 13:50:28 +0100628 ctx.AddVariationDependencies(nil, systemModulesTag, sdkDep.systemModules)
Colin Cross6cef4812019-10-17 14:23:50 -0700629 ctx.AddVariationDependencies(nil, java9LibTag, sdkDep.java9Classpath...)
Colin Cross6d8d8c62019-10-28 15:10:03 -0700630 if j.deviceProperties.EffectiveOptimizeEnabled() && sdkDep.hasStandardLibs() {
631 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultBootclasspathLibraries...)
632 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultLibraries...)
633 }
Colin Cross2fe66872015-03-30 17:20:39 -0700634 }
Colin Cross6d8d8c62019-10-28 15:10:03 -0700635
Nan Zhangb2b33de2018-02-23 11:18:47 -0800636 if ctx.ModuleName() == "android_stubs_current" ||
637 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -0700638 ctx.ModuleName() == "android_test_stubs_current" {
Colin Cross42d48b72018-08-29 14:10:52 -0700639 ctx.AddVariationDependencies(nil, frameworkApkTag, "framework-res")
Nan Zhangb2b33de2018-02-23 11:18:47 -0800640 }
Colin Cross2fe66872015-03-30 17:20:39 -0700641 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700642
Inseob Kimac1e9862019-12-09 18:15:47 +0900643 syspropPublicStubs := syspropPublicStubs(ctx.Config())
644
645 // rewriteSyspropLibs validates if a java module can link against platform's sysprop_library,
646 // and redirects dependency to public stub depending on the link type.
647 rewriteSyspropLibs := func(libs []string, prop string) []string {
648 // make a copy
649 ret := android.CopyOf(libs)
650
651 for idx, lib := range libs {
652 stub, ok := syspropPublicStubs[lib]
653
654 if !ok {
655 continue
656 }
657
658 linkType, _ := j.getLinkType(ctx.ModuleName())
Inseob Kimc5239512020-01-14 15:36:21 +0900659 // only platform modules can use internal props
660 if linkType != javaPlatform {
Inseob Kimac1e9862019-12-09 18:15:47 +0900661 ret[idx] = stub
Inseob Kimac1e9862019-12-09 18:15:47 +0900662 }
663 }
664
665 return ret
666 }
667
668 ctx.AddVariationDependencies(nil, libTag, rewriteSyspropLibs(j.properties.Libs, "libs")...)
669 ctx.AddVariationDependencies(nil, staticLibTag, rewriteSyspropLibs(j.properties.Static_libs, "static_libs")...)
Colin Crossa4f08812018-10-02 22:03:40 -0700670
Colin Cross0f7d2ef2019-10-16 11:03:10 -0700671 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000672 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800673
Colin Crossfe17f6f2019-03-28 19:30:56 -0700674 android.ProtoDeps(ctx, &j.protoProperties)
Colin Cross6af17aa2017-09-20 12:59:05 -0700675 if j.hasSrcExt(".proto") {
676 protoDeps(ctx, &j.protoProperties)
677 }
Colin Cross93e85952017-08-15 13:34:18 -0700678
679 if j.hasSrcExt(".kt") {
680 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
681 // Kotlin files
Colin Cross0b03d972019-05-13 11:06:25 -0700682 ctx.AddVariationDependencies(nil, kotlinStdlibTag,
683 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8")
Colin Cross7788c122019-01-23 16:14:02 -0800684 if len(j.properties.Plugins) > 0 {
Colin Crossafbb1732019-01-17 15:42:52 -0800685 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
686 }
Colin Cross93e85952017-08-15 13:34:18 -0700687 }
Colin Cross3144dfc2018-01-03 15:06:47 -0800688
Ulya Trafimovich38dfa0f2020-01-07 16:37:02 +0000689 // Framework libraries need special handling in static coverage builds: they should not have
690 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
691 // the same jacoco classes coming from different bootclasspath jars.
692 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
693 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
694 j.properties.Instrument = true
695 }
696 } else if j.shouldInstrumentStatic(ctx) {
Colin Cross42d48b72018-08-29 14:10:52 -0700697 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
Colin Cross3144dfc2018-01-03 15:06:47 -0800698 }
Colin Cross6af17aa2017-09-20 12:59:05 -0700699}
700
701func hasSrcExt(srcs []string, ext string) bool {
702 for _, src := range srcs {
703 if filepath.Ext(src) == ext {
704 return true
705 }
706 }
707
708 return false
709}
710
711func (j *Module) hasSrcExt(ext string) bool {
712 return hasSrcExt(j.properties.Srcs, ext)
Colin Cross2fe66872015-03-30 17:20:39 -0700713}
714
Colin Cross46c9b8b2017-06-22 16:51:17 -0700715func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Colin Cross3047fa22019-04-18 10:56:44 -0700716 aidlIncludeDirs android.Paths) (string, android.Paths) {
Colin Crossc0b06f12015-04-08 13:03:43 -0700717
Colin Crossebe1a512017-11-14 13:12:14 -0800718 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
719 aidlIncludes = append(aidlIncludes,
720 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
721 aidlIncludes = append(aidlIncludes,
722 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
Colin Crossc0b06f12015-04-08 13:03:43 -0700723
Colin Cross3047fa22019-04-18 10:56:44 -0700724 var flags []string
725 var deps android.Paths
Steven Moreland667f6882018-07-26 12:55:08 -0700726
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700727 if aidlPreprocess.Valid() {
728 flags = append(flags, "-p"+aidlPreprocess.String())
Colin Cross3047fa22019-04-18 10:56:44 -0700729 deps = append(deps, aidlPreprocess.Path())
730 } else if len(aidlIncludeDirs) > 0 {
Colin Cross635c3b02016-05-18 15:37:25 -0700731 flags = append(flags, android.JoinWithPrefix(aidlIncludeDirs.Strings(), "-I"))
Colin Crossc0b06f12015-04-08 13:03:43 -0700732 }
733
Colin Cross3047fa22019-04-18 10:56:44 -0700734 if len(j.exportAidlIncludeDirs) > 0 {
735 flags = append(flags, android.JoinWithPrefix(j.exportAidlIncludeDirs.Strings(), "-I"))
736 }
737
738 if len(aidlIncludes) > 0 {
739 flags = append(flags, android.JoinWithPrefix(aidlIncludes.Strings(), "-I"))
740 }
741
Colin Cross635c3b02016-05-18 15:37:25 -0700742 flags = append(flags, "-I"+android.PathForModuleSrc(ctx).String())
Colin Cross32f38982018-02-22 11:47:25 -0800743 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Colin Crossd48633a2017-07-13 14:41:17 -0700744 flags = append(flags, "-I"+src.String())
745 }
Colin Crossc0b06f12015-04-08 13:03:43 -0700746
Martijn Coeneneab15642018-03-09 09:29:59 +0100747 if Bool(j.deviceProperties.Aidl.Generate_traces) {
748 flags = append(flags, "-t")
749 }
750
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100751 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
752 flags = append(flags, "--transaction_names")
753 }
754
Colin Cross3047fa22019-04-18 10:56:44 -0700755 return strings.Join(flags, " "), deps
Colin Crossc0b06f12015-04-08 13:03:43 -0700756}
757
Colin Cross32f676a2017-09-06 13:41:06 -0700758type deps struct {
Nan Zhang581fd212018-01-10 16:06:12 -0800759 classpath classpath
Colin Cross6cef4812019-10-17 14:23:50 -0700760 java9Classpath classpath
Nan Zhang581fd212018-01-10 16:06:12 -0800761 bootClasspath classpath
Colin Cross6a77c982018-06-19 22:43:34 -0700762 processorPath classpath
Colin Crossbe9cdb82019-01-21 21:37:16 -0800763 processorClasses []string
Colin Cross6ade34f2017-09-15 13:00:47 -0700764 staticJars android.Paths
Nan Zhanged19fc32017-10-19 13:06:22 -0700765 staticHeaderJars android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700766 staticResourceJars android.Paths
Colin Cross6ade34f2017-09-15 13:00:47 -0700767 aidlIncludeDirs android.Paths
Nan Zhangb2b33de2018-02-23 11:18:47 -0800768 srcs android.Paths
Colin Cross59149b62017-10-16 18:07:29 -0700769 srcJars android.Paths
Colin Crossb77043e2019-07-16 13:57:13 -0700770 systemModules *systemModules
Colin Cross6ade34f2017-09-15 13:00:47 -0700771 aidlPreprocess android.OptionalPath
Colin Cross93e85952017-08-15 13:34:18 -0700772 kotlinStdlib android.Paths
Colin Crossafbb1732019-01-17 15:42:52 -0800773 kotlinAnnotations android.Paths
Colin Crossbe9cdb82019-01-21 21:37:16 -0800774
775 disableTurbine bool
Colin Cross32f676a2017-09-06 13:41:06 -0700776}
Colin Cross2fe66872015-03-30 17:20:39 -0700777
Colin Cross54250902017-12-05 09:28:08 -0800778func checkProducesJars(ctx android.ModuleContext, dep android.SourceFileProducer) {
779 for _, f := range dep.Srcs() {
780 if f.Ext() != ".jar" {
781 ctx.ModuleErrorf("genrule %q must generate files ending with .jar to be used as a libs or static_libs dependency",
782 ctx.OtherModuleName(dep.(blueprint.Module)))
783 }
784 }
785}
786
Jiyong Park2d492942018-03-05 17:44:10 +0900787type linkType int
788
789const (
Jiyong Park50146e92020-01-30 18:00:15 +0900790 // TODO(jiyong) rename these for better readability. Make the allowed
791 // and disallowed link types explicit
Jiyong Park2d492942018-03-05 17:44:10 +0900792 javaCore linkType = iota
793 javaSdk
794 javaSystem
Jiyong Park50146e92020-01-30 18:00:15 +0900795 javaModule
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900796 javaSystemServer
Jiyong Park2d492942018-03-05 17:44:10 +0900797 javaPlatform
798)
799
Jeongik Cha75b83b02019-11-01 15:28:00 +0900800type linkTypeContext interface {
801 android.Module
802 getLinkType(name string) (ret linkType, stubs bool)
803}
804
805func (m *Module) getLinkType(name string) (ret linkType, stubs bool) {
Colin Cross83bb3162018-06-25 15:48:06 -0700806 ver := m.sdkVersion()
Colin Crossf19b9bb2018-03-26 14:42:44 -0700807 switch {
Jiyong Park46f78fb2018-10-20 16:33:17 +0900808 case name == "core.current.stubs" || name == "core.platform.api.stubs" ||
809 name == "stub-annotations" || name == "private-stub-annotations-jar" ||
Pete Gillincbff3262019-05-08 15:10:06 +0100810 name == "core-lambda-stubs" || name == "core-generated-annotation-stubs":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900811 return javaCore, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900812 case ver.kind == sdkCore:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900813 return javaCore, false
814 case name == "android_system_stubs_current":
815 return javaSystem, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900816 case ver.kind == sdkSystem:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900817 return javaSystem, false
818 case name == "android_test_stubs_current":
819 return javaSystem, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900820 case ver.kind == sdkTest:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900821 return javaPlatform, false
822 case name == "android_stubs_current":
823 return javaSdk, true
Jiyong Park6a927c42020-01-21 02:03:43 +0900824 case ver.kind == sdkPublic:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900825 return javaSdk, false
Jiyong Park50146e92020-01-30 18:00:15 +0900826 case name == "android_module_lib_stubs_current":
827 return javaModule, true
828 case ver.kind == sdkModule:
829 return javaModule, false
Anton Hanssonba6ab2e2020-03-19 15:23:38 +0000830 case name == "android_system_server_stubs_current":
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900831 return javaSystemServer, true
832 case ver.kind == sdkSystemServer:
833 return javaSystemServer, false
Jiyong Park6a927c42020-01-21 02:03:43 +0900834 case ver.kind == sdkPrivate || ver.kind == sdkNone || ver.kind == sdkCorePlatform:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900835 return javaPlatform, false
Jiyong Park6a927c42020-01-21 02:03:43 +0900836 case !ver.valid():
837 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.raw))
Colin Crossf19b9bb2018-03-26 14:42:44 -0700838 default:
Jiyong Park46f78fb2018-10-20 16:33:17 +0900839 return javaSdk, false
Jiyong Park2d492942018-03-05 17:44:10 +0900840 }
841}
842
Jeongik Cha75b83b02019-11-01 15:28:00 +0900843func checkLinkType(ctx android.ModuleContext, from *Module, to linkTypeContext, tag dependencyTag) {
Colin Crossf19b9bb2018-03-26 14:42:44 -0700844 if ctx.Host() {
845 return
846 }
847
Jeongik Cha75b83b02019-11-01 15:28:00 +0900848 myLinkType, stubs := from.getLinkType(ctx.ModuleName())
Jiyong Park46f78fb2018-10-20 16:33:17 +0900849 if stubs {
850 return
851 }
Jeongik Cha75b83b02019-11-01 15:28:00 +0900852 otherLinkType, _ := to.getLinkType(ctx.OtherModuleName(to))
Jiyong Park2d492942018-03-05 17:44:10 +0900853 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."
854
855 switch myLinkType {
856 case javaCore:
857 if otherLinkType != javaCore {
858 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 +0900859 ctx.OtherModuleName(to))
860 }
Jiyong Park2d492942018-03-05 17:44:10 +0900861 break
862 case javaSdk:
863 if otherLinkType != javaCore && otherLinkType != javaSdk {
864 ctx.ModuleErrorf("compiles against Android API, but dependency %q is compiling against non-public Android API."+commonMessage,
865 ctx.OtherModuleName(to))
866 }
867 break
868 case javaSystem:
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900869 if otherLinkType == javaPlatform || otherLinkType == javaModule || otherLinkType == javaSystemServer {
Jiyong Park2d492942018-03-05 17:44:10 +0900870 ctx.ModuleErrorf("compiles against system API, but dependency %q is compiling against private API."+commonMessage,
871 ctx.OtherModuleName(to))
872 }
873 break
Jiyong Park50146e92020-01-30 18:00:15 +0900874 case javaModule:
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900875 if otherLinkType == javaPlatform || otherLinkType == javaSystemServer {
Jiyong Park50146e92020-01-30 18:00:15 +0900876 ctx.ModuleErrorf("compiles against module API, but dependency %q is compiling against private API."+commonMessage,
877 ctx.OtherModuleName(to))
878 }
879 break
Jiyong Parkaae9bd12020-02-12 04:36:43 +0900880 case javaSystemServer:
881 if otherLinkType == javaPlatform {
882 ctx.ModuleErrorf("compiles against system server API, but dependency %q is compiling against private API."+commonMessage,
883 ctx.OtherModuleName(to))
884 }
885 break
Jiyong Park2d492942018-03-05 17:44:10 +0900886 case javaPlatform:
887 // no restriction on link-type
888 break
Jiyong Park750e5572018-01-31 00:20:13 +0900889 }
890}
891
Colin Cross32f676a2017-09-06 13:41:06 -0700892func (j *Module) collectDeps(ctx android.ModuleContext) deps {
893 var deps deps
Colin Crossfc3674a2017-09-18 17:41:52 -0700894
Colin Cross300f0382018-03-06 13:11:51 -0800895 if ctx.Device() {
Colin Cross83bb3162018-06-25 15:48:06 -0700896 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross300f0382018-03-06 13:11:51 -0800897 if sdkDep.invalidVersion {
Colin Cross6cef4812019-10-17 14:23:50 -0700898 ctx.AddMissingDependencies(sdkDep.bootclasspath)
899 ctx.AddMissingDependencies(sdkDep.java9Classpath)
Colin Cross300f0382018-03-06 13:11:51 -0800900 } else if sdkDep.useFiles {
901 // sdkDep.jar is actually equivalent to turbine header.jar.
Colin Cross86a60ae2018-05-29 14:44:55 -0700902 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross3047fa22019-04-18 10:56:44 -0700903 deps.aidlPreprocess = sdkDep.aidl
904 } else {
905 deps.aidlPreprocess = sdkDep.aidl
Colin Cross300f0382018-03-06 13:11:51 -0800906 }
Colin Crossfc3674a2017-09-18 17:41:52 -0700907 }
908
Colin Crossd11fcda2017-10-23 17:59:01 -0700909 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross2fe66872015-03-30 17:20:39 -0700910 otherName := ctx.OtherModuleName(module)
Colin Crossec7a0422017-07-07 14:47:12 -0700911 tag := ctx.OtherModuleDependencyTag(module)
912
Colin Crossa4f08812018-10-02 22:03:40 -0700913 if _, ok := tag.(*jniDependencyTag); ok {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700914 // Handled by AndroidApp.collectAppDeps
915 return
916 }
917 if tag == certificateTag {
918 // Handled by AndroidApp.collectAppDeps
Colin Crossa4f08812018-10-02 22:03:40 -0700919 return
920 }
Artur Satayev2db1c3f2020-04-08 19:09:30 +0100921
Colin Cross54250902017-12-05 09:28:08 -0800922 switch dep := module.(type) {
Colin Cross897d2ed2019-02-11 14:03:51 -0800923 case SdkLibraryDependency:
924 switch tag {
925 case libTag:
926 deps.classpath = append(deps.classpath, dep.SdkHeaderJars(ctx, j.sdkVersion())...)
927 // names of sdk libs that are directly depended are exported
928 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
Colin Cross79c7c262019-04-17 11:11:46 -0700929 case staticLibTag:
Colin Cross897d2ed2019-02-11 14:03:51 -0800930 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
931 }
Colin Cross54250902017-12-05 09:28:08 -0800932 case Dependency:
933 switch tag {
934 case bootClasspathTag:
935 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars()...)
Colin Cross4b964c02018-10-15 16:18:06 -0700936 case libTag, instrumentationForTag:
Colin Cross54250902017-12-05 09:28:08 -0800937 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900938 // sdk lib names from dependencies are re-exported
939 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700940 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000941 pluginJars, pluginClasses := dep.ExportedPlugins()
942 addPlugins(&deps, pluginJars, pluginClasses...)
Colin Cross6cef4812019-10-17 14:23:50 -0700943 case java9LibTag:
944 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars()...)
Colin Cross54250902017-12-05 09:28:08 -0800945 case staticLibTag:
946 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
947 deps.staticJars = append(deps.staticJars, dep.ImplementationJars()...)
948 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars()...)
Colin Cross331a1212018-08-15 20:40:52 -0700949 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900950 // sdk lib names from dependencies are re-exported
951 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700952 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Artur Satayev9cf46692019-11-26 18:08:34 +0000953 pluginJars, pluginClasses := dep.ExportedPlugins()
954 addPlugins(&deps, pluginJars, pluginClasses...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800955 case pluginTag:
956 if plugin, ok := dep.(*Plugin); ok {
Colin Crossbe9cdb82019-01-21 21:37:16 -0800957 if plugin.pluginProperties.Processor_class != nil {
Artur Satayev9cf46692019-11-26 18:08:34 +0000958 addPlugins(&deps, plugin.ImplementationAndResourcesJars(), *plugin.pluginProperties.Processor_class)
959 } else {
960 addPlugins(&deps, plugin.ImplementationAndResourcesJars())
Colin Crossbe9cdb82019-01-21 21:37:16 -0800961 }
962 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
963 } else {
964 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
965 }
Artur Satayev9cf46692019-11-26 18:08:34 +0000966 case exportedPluginTag:
967 if plugin, ok := dep.(*Plugin); ok {
968 if plugin.pluginProperties.Generates_api != nil && *plugin.pluginProperties.Generates_api {
969 ctx.PropertyErrorf("exported_plugins", "Cannot export plugins with generates_api = true, found %v", otherName)
970 }
971 j.exportedPluginJars = append(j.exportedPluginJars, plugin.ImplementationAndResourcesJars()...)
972 if plugin.pluginProperties.Processor_class != nil {
973 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
974 }
975 } else {
976 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
977 }
Nan Zhangb2b33de2018-02-23 11:18:47 -0800978 case frameworkApkTag:
979 if ctx.ModuleName() == "android_stubs_current" ||
980 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -0700981 ctx.ModuleName() == "android_test_stubs_current" {
Nan Zhangb2b33de2018-02-23 11:18:47 -0800982 // framework stubs.jar need to depend on framework-res.apk, in order to pull the
983 // resource files out of there for aapt.
984 //
985 // Normally the package rule runs aapt, which includes the resource,
986 // but we're not running that in our package rule so just copy in the
987 // resource files here.
Colin Cross331a1212018-08-15 20:40:52 -0700988 deps.staticResourceJars = append(deps.staticResourceJars, dep.(*AndroidApp).exportPackage)
Nan Zhangb2b33de2018-02-23 11:18:47 -0800989 }
Colin Cross54250902017-12-05 09:28:08 -0800990 case kotlinStdlibTag:
Colin Cross0b03d972019-05-13 11:06:25 -0700991 deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars()...)
Colin Crossafbb1732019-01-17 15:42:52 -0800992 case kotlinAnnotationsTag:
993 deps.kotlinAnnotations = dep.HeaderJars()
Colin Cross54250902017-12-05 09:28:08 -0800994 }
995
Colin Cross54250902017-12-05 09:28:08 -0800996 case android.SourceFileProducer:
997 switch tag {
998 case libTag:
999 checkProducesJars(ctx, dep)
1000 deps.classpath = append(deps.classpath, dep.Srcs()...)
1001 case staticLibTag:
1002 checkProducesJars(ctx, dep)
1003 deps.classpath = append(deps.classpath, dep.Srcs()...)
1004 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
1005 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Cross54250902017-12-05 09:28:08 -08001006 }
1007 default:
Colin Crossec7a0422017-07-07 14:47:12 -07001008 switch tag {
Paul Duffin68289b02019-09-20 13:50:52 +01001009 case bootClasspathTag:
1010 // If a system modules dependency has been added to the bootclasspath
1011 // then add its libs to the bootclasspath.
Paul Duffin83a2d962019-11-19 19:44:10 +00001012 sm := module.(SystemModulesProvider)
1013 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars()...)
Paul Duffin68289b02019-09-20 13:50:52 +01001014
Colin Cross1369cdb2017-09-29 17:58:17 -07001015 case systemModulesTag:
1016 if deps.systemModules != nil {
1017 panic("Found two system module dependencies")
1018 }
Paul Duffin83a2d962019-11-19 19:44:10 +00001019 sm := module.(SystemModulesProvider)
1020 outputDir, outputDeps := sm.OutputDirAndDeps()
1021 deps.systemModules = &systemModules{outputDir, outputDeps}
Colin Cross2fe66872015-03-30 17:20:39 -07001022 }
Colin Crossec7a0422017-07-07 14:47:12 -07001023 }
Colin Cross2fe66872015-03-30 17:20:39 -07001024 })
1025
Jiyong Park1be96912018-05-28 18:02:19 +09001026 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
1027
Colin Cross32f676a2017-09-06 13:41:06 -07001028 return deps
Colin Cross2fe66872015-03-30 17:20:39 -07001029}
1030
Artur Satayev9cf46692019-11-26 18:08:34 +00001031func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
1032 deps.processorPath = append(deps.processorPath, pluginJars...)
1033 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
1034}
1035
Colin Cross1e743852019-10-28 11:37:20 -07001036func getJavaVersion(ctx android.ModuleContext, javaVersion string, sdkContext sdkContext) javaVersion {
Jiyong Park6a927c42020-01-21 02:03:43 +09001037 sdk, err := sdkContext.sdkVersion().effectiveVersion(ctx)
Colin Cross83bb3162018-06-25 15:48:06 -07001038 if err != nil {
1039 ctx.PropertyErrorf("sdk_version", "%s", err)
1040 }
Nan Zhang357466b2018-04-17 17:38:36 -07001041 if javaVersion != "" {
Colin Cross1e743852019-10-28 11:37:20 -07001042 return normalizeJavaVersion(ctx, javaVersion)
Nan Zhang357466b2018-04-17 17:38:36 -07001043 } else if ctx.Device() && sdk <= 23 {
Colin Cross1e743852019-10-28 11:37:20 -07001044 return JAVA_VERSION_7
Pete Gillina1c9e9d2019-10-17 14:52:07 +01001045 } else if ctx.Device() && sdk <= 29 {
Colin Cross1e743852019-10-28 11:37:20 -07001046 return JAVA_VERSION_8
Colin Cross6cef4812019-10-17 14:23:50 -07001047 } else if ctx.Device() && ctx.Config().UnbundledBuildUsePrebuiltSdks() {
1048 // TODO(b/142896162): once we have prebuilt system modules we can use 1.9 for unbundled builds
Colin Cross1e743852019-10-28 11:37:20 -07001049 return JAVA_VERSION_8
Nan Zhang357466b2018-04-17 17:38:36 -07001050 } else {
Colin Cross1e743852019-10-28 11:37:20 -07001051 return JAVA_VERSION_9
Nan Zhang357466b2018-04-17 17:38:36 -07001052 }
Nan Zhang357466b2018-04-17 17:38:36 -07001053}
1054
Colin Cross1e743852019-10-28 11:37:20 -07001055type javaVersion int
1056
1057const (
1058 JAVA_VERSION_UNSUPPORTED = 0
1059 JAVA_VERSION_6 = 6
1060 JAVA_VERSION_7 = 7
1061 JAVA_VERSION_8 = 8
1062 JAVA_VERSION_9 = 9
1063)
1064
1065func (v javaVersion) String() string {
1066 switch v {
1067 case JAVA_VERSION_6:
1068 return "1.6"
1069 case JAVA_VERSION_7:
1070 return "1.7"
1071 case JAVA_VERSION_8:
1072 return "1.8"
1073 case JAVA_VERSION_9:
1074 return "1.9"
1075 default:
1076 return "unsupported"
1077 }
1078}
1079
1080// Returns true if javac targeting this version uses system modules instead of a bootclasspath.
1081func (v javaVersion) usesJavaModules() bool {
1082 return v >= 9
1083}
1084
1085func normalizeJavaVersion(ctx android.BaseModuleContext, javaVersion string) javaVersion {
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001086 switch javaVersion {
1087 case "1.6", "6":
Colin Cross1e743852019-10-28 11:37:20 -07001088 return JAVA_VERSION_6
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001089 case "1.7", "7":
Colin Cross1e743852019-10-28 11:37:20 -07001090 return JAVA_VERSION_7
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001091 case "1.8", "8":
Colin Cross1e743852019-10-28 11:37:20 -07001092 return JAVA_VERSION_8
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001093 case "1.9", "9":
Colin Cross1e743852019-10-28 11:37:20 -07001094 return JAVA_VERSION_9
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001095 case "10", "11":
1096 ctx.PropertyErrorf("java_version", "Java language levels above 9 are not supported")
Colin Cross1e743852019-10-28 11:37:20 -07001097 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001098 default:
1099 ctx.PropertyErrorf("java_version", "Unrecognized Java language level")
Colin Cross1e743852019-10-28 11:37:20 -07001100 return JAVA_VERSION_UNSUPPORTED
Pete Gillin4e8b48a2019-07-12 13:16:17 +01001101 }
1102}
1103
Nan Zhanged19fc32017-10-19 13:06:22 -07001104func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
Colin Crossc0b06f12015-04-08 13:03:43 -07001105
Colin Crossf03c82b2015-04-13 13:53:40 -07001106 var flags javaBuilderFlags
1107
Tobias Thierer06dd04f2018-09-11 16:21:05 +01001108 // javaVersion flag.
1109 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), sdkContext(j))
1110
Nan Zhanged19fc32017-10-19 13:06:22 -07001111 // javac flags.
Colin Crossf03c82b2015-04-13 13:53:40 -07001112 javacFlags := j.properties.Javacflags
Colin Cross1e743852019-10-28 11:37:20 -07001113 if flags.javaVersion.usesJavaModules() {
Colin Cross1369cdb2017-09-29 17:58:17 -07001114 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Nan Zhanged19fc32017-10-19 13:06:22 -07001115 }
Colin Cross6510f912017-11-29 00:27:14 -08001116 if ctx.Config().MinimizeJavaDebugInfo() {
Colin Cross126a25c2017-10-31 13:55:34 -07001117 // Override the -g flag passed globally to remove local variable debug info to reduce
1118 // disk and memory usage.
1119 javacFlags = append(javacFlags, "-g:source,lines")
1120 }
Colin Crossc228a702019-11-06 16:18:05 -08001121 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
Colin Cross64162712017-08-08 13:17:59 -07001122
Colin Cross66548102018-06-19 22:47:35 -07001123 if ctx.Config().RunErrorProne() {
1124 if config.ErrorProneClasspath == nil {
1125 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1126 }
1127
1128 errorProneFlags := []string{
1129 "-Xplugin:ErrorProne",
1130 "${config.ErrorProneChecks}",
1131 }
1132 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1133
1134 flags.errorProneExtraJavacFlags = "${config.ErrorProneFlags} " +
1135 "'" + strings.Join(errorProneFlags, " ") + "'"
1136 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
Andreas Gampef3e5b552018-01-22 21:27:21 -08001137 }
1138
Nan Zhanged19fc32017-10-19 13:06:22 -07001139 // classpath
Nan Zhang581fd212018-01-10 16:06:12 -08001140 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1141 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross6cef4812019-10-17 14:23:50 -07001142 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
Colin Cross6a77c982018-06-19 22:43:34 -07001143 flags.processorPath = append(flags.processorPath, deps.processorPath...)
Colin Cross7fdd2b72018-01-02 18:14:25 -08001144
Colin Cross5a116862020-04-22 11:44:34 -07001145 flags.processors = append(flags.processors, deps.processorClasses...)
1146 flags.processors = android.FirstUniqueStrings(flags.processors)
Colin Crossbe9cdb82019-01-21 21:37:16 -08001147
Colin Cross1e743852019-10-28 11:37:20 -07001148 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
1149 decodeSdkDep(ctx, sdkContext(j)).hasStandardLibs() {
Colin Cross7fdd2b72018-01-02 18:14:25 -08001150 // Give host-side tools a version of OpenJDK's standard libraries
1151 // close to what they're targeting. As of Dec 2017, AOSP is only
1152 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1153 //
1154 // When building with OpenJDK 8, the following should have no
1155 // effect since those jars would be available by default.
1156 //
1157 // When building with OpenJDK 9 but targeting a version < 1.8,
1158 // putting them on the bootclasspath means that:
1159 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1160 // b) references to existing APIs are not reinterpreted in an
1161 // OpenJDK 9-specific way, eg. calls to subclasses of
1162 // java.nio.Buffer as in http://b/70862583
1163 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1164 flags.bootClasspath = append(flags.bootClasspath,
1165 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1166 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
Nan Zhang5f8cb422018-02-06 10:34:32 -08001167 if Bool(j.properties.Use_tools_jar) {
1168 flags.bootClasspath = append(flags.bootClasspath,
1169 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1170 }
Colin Cross7fdd2b72018-01-02 18:14:25 -08001171 }
1172
Colin Cross1e743852019-10-28 11:37:20 -07001173 if j.properties.Patch_module != nil && flags.javaVersion.usesJavaModules() {
Jaewoong Jung38e4fb22018-12-12 09:01:34 -08001174 // Manually specify build directory in case it is not under the repo root.
1175 // (javac doesn't seem to expand into symbolc links when searching for patch-module targets, so
1176 // just adding a symlink under the root doesn't help.)
1177 patchPaths := ".:" + ctx.Config().BuildDir()
1178 classPath := flags.classpath.FormJavaClassPath("")
1179 if classPath != "" {
1180 patchPaths += ":" + classPath
1181 }
1182 javacFlags = append(javacFlags, "--patch-module="+String(j.properties.Patch_module)+"="+patchPaths)
Colin Cross81440082018-08-15 20:21:55 -07001183 }
1184
Nan Zhanged19fc32017-10-19 13:06:22 -07001185 // systemModules
Colin Crossb77043e2019-07-16 13:57:13 -07001186 flags.systemModules = deps.systemModules
Colin Cross1369cdb2017-09-29 17:58:17 -07001187
Nan Zhanged19fc32017-10-19 13:06:22 -07001188 // aidl flags.
Colin Cross3047fa22019-04-18 10:56:44 -07001189 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs)
Colin Cross2fe66872015-03-30 17:20:39 -07001190
Colin Cross81440082018-08-15 20:21:55 -07001191 if len(javacFlags) > 0 {
1192 // optimization.
1193 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1194 flags.javacFlags = "$javacFlags"
1195 }
1196
Nan Zhanged19fc32017-10-19 13:06:22 -07001197 return flags
1198}
Colin Crossc0b06f12015-04-08 13:03:43 -07001199
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001200func (j *Module) compile(ctx android.ModuleContext, aaptSrcJar android.Path) {
Colin Crossebe1a512017-11-14 13:12:14 -08001201 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
Nan Zhanged19fc32017-10-19 13:06:22 -07001202
1203 deps := j.collectDeps(ctx)
1204 flags := j.collectBuilderFlags(ctx, deps)
1205
Colin Cross1e743852019-10-28 11:37:20 -07001206 if flags.javaVersion.usesJavaModules() {
Nan Zhanged19fc32017-10-19 13:06:22 -07001207 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
1208 }
Colin Cross8a497952019-03-05 22:25:09 -08001209 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Colin Cross6af17aa2017-09-20 12:59:05 -07001210 if hasSrcExt(srcFiles.Strings(), ".proto") {
Colin Cross0f2ee152017-12-14 15:22:43 -08001211 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
Colin Cross6af17aa2017-09-20 12:59:05 -07001212 }
1213
Colin Crossaf050172017-11-15 23:01:59 -08001214 srcFiles = j.genSources(ctx, srcFiles, flags)
1215
1216 srcJars := srcFiles.FilterByExt(".srcjar")
Colin Cross59149b62017-10-16 18:07:29 -07001217 srcJars = append(srcJars, deps.srcJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001218 if aaptSrcJar != nil {
1219 srcJars = append(srcJars, aaptSrcJar)
1220 }
Colin Crossb7a63242015-04-16 14:09:14 -07001221
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001222 if j.properties.Jarjar_rules != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001223 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001224 }
1225
Colin Cross1ee23172017-10-18 14:44:18 -07001226 jarName := ctx.ModuleName() + ".jar"
1227
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001228 javaSrcFiles := srcFiles.FilterByExt(".java")
1229 var uniqueSrcFiles android.Paths
1230 set := make(map[string]bool)
1231 for _, v := range javaSrcFiles {
1232 if _, found := set[v.String()]; !found {
1233 set[v.String()] = true
1234 uniqueSrcFiles = append(uniqueSrcFiles, v)
1235 }
1236 }
1237
patricktu242faad2019-09-24 15:41:30 +08001238 // Collect .java files for AIDEGen
1239 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1240
Colin Cross55f63ea2018-08-27 12:37:09 -07001241 var kotlinJars android.Paths
1242
Colin Cross93e85952017-08-15 13:34:18 -07001243 if srcFiles.HasExt(".kt") {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001244 // user defined kotlin flags.
1245 kotlincFlags := j.properties.Kotlincflags
1246 CheckKotlincFlags(ctx, kotlincFlags)
1247
Colin Cross93e85952017-08-15 13:34:18 -07001248 // If there are kotlin files, compile them first but pass all the kotlin and java files
1249 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1250 // won't emit any classes for them.
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001251 kotlincFlags = append(kotlincFlags, "-no-stdlib")
Colin Cross93e85952017-08-15 13:34:18 -07001252 if ctx.Device() {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001253 kotlincFlags = append(kotlincFlags, "-no-jdk")
1254 }
1255 if len(kotlincFlags) > 0 {
1256 // optimization.
1257 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1258 flags.kotlincFlags += "$kotlincFlags"
Colin Cross93e85952017-08-15 13:34:18 -07001259 }
1260
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001261 var kotlinSrcFiles android.Paths
1262 kotlinSrcFiles = append(kotlinSrcFiles, uniqueSrcFiles...)
1263 kotlinSrcFiles = append(kotlinSrcFiles, srcFiles.FilterByExt(".kt")...)
1264
patricktu242faad2019-09-24 15:41:30 +08001265 // Collect .kt files for AIDEGen
1266 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, srcFiles.FilterByExt(".kt").Strings()...)
1267
Colin Crossafbb1732019-01-17 15:42:52 -08001268 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1269 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1270
1271 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1272 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1273
1274 if len(flags.processorPath) > 0 {
1275 // Use kapt for annotation processing
1276 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1277 kotlinKapt(ctx, kaptSrcJar, kotlinSrcFiles, srcJars, flags)
1278 srcJars = append(srcJars, kaptSrcJar)
1279 // Disable annotation processing in javac, it's already been handled by kapt
1280 flags.processorPath = nil
Colin Cross5a116862020-04-22 11:44:34 -07001281 flags.processors = nil
Colin Crossafbb1732019-01-17 15:42:52 -08001282 }
Colin Cross93e85952017-08-15 13:34:18 -07001283
Colin Cross1ee23172017-10-18 14:44:18 -07001284 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross21fc9bb2019-01-18 15:05:09 -08001285 kotlinCompile(ctx, kotlinJar, kotlinSrcFiles, srcJars, flags)
Colin Cross93e85952017-08-15 13:34:18 -07001286 if ctx.Failed() {
1287 return
1288 }
1289
1290 // Make javac rule depend on the kotlinc rule
1291 flags.classpath = append(flags.classpath, kotlinJar)
Przemyslaw Szczepaniak66c0c402018-03-08 13:21:55 +00001292
Colin Cross93e85952017-08-15 13:34:18 -07001293 // Jar kotlin classes into the final jar after javac
Colin Cross55f63ea2018-08-27 12:37:09 -07001294 kotlinJars = append(kotlinJars, kotlinJar)
Colin Cross9b38aef2018-08-27 15:42:25 -07001295 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
Colin Cross93e85952017-08-15 13:34:18 -07001296 }
1297
Colin Cross55f63ea2018-08-27 12:37:09 -07001298 jars := append(android.Paths(nil), kotlinJars...)
1299
Colin Cross5ab4e6d2017-11-22 16:20:45 -08001300 // Store the list of .java files that was passed to javac
1301 j.compiledJavaSrcs = uniqueSrcFiles
1302 j.compiledSrcJars = srcJars
1303
Nan Zhang61eaedb2017-11-02 13:28:15 -07001304 enable_sharding := false
Colin Crossf7d84012020-02-21 08:16:41 -08001305 var headerJarFileWithoutJarjar android.Path
Colin Crossbe9cdb82019-01-21 21:37:16 -08001306 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !deps.disableTurbine {
Nan Zhang61eaedb2017-11-02 13:28:15 -07001307 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1308 enable_sharding = true
Ashley Rosee36efcf2019-01-16 17:34:08 -05001309 // Formerly, there was a check here that prevented annotation processors
1310 // from being used when sharding was enabled, as some annotation processors
1311 // do not function correctly in sharded environments. It was removed to
1312 // allow for the use of annotation processors that do function correctly
1313 // with sharding enabled. See: b/77284273.
Nan Zhang61eaedb2017-11-02 13:28:15 -07001314 }
Colin Crossf7d84012020-02-21 08:16:41 -08001315 headerJarFileWithoutJarjar, j.headerJarFile =
1316 j.compileJavaHeader(ctx, uniqueSrcFiles, srcJars, deps, flags, jarName, kotlinJars)
Colin Crossf19b9bb2018-03-26 14:42:44 -07001317 if ctx.Failed() {
1318 return
Nan Zhanged19fc32017-10-19 13:06:22 -07001319 }
1320 }
Colin Cross8eadbf02017-10-24 17:46:00 -07001321 if len(uniqueSrcFiles) > 0 || len(srcJars) > 0 {
Colin Crossd6891432017-09-27 17:39:56 -07001322 var extraJarDeps android.Paths
Colin Cross66548102018-06-19 22:47:35 -07001323 if ctx.Config().RunErrorProne() {
Colin Crossc6bbef32017-08-14 14:16:06 -07001324 // If error-prone is enabled, add an additional rule to compile the java files into
1325 // a separate set of classes (so that they don't overwrite the normal ones and require
Colin Crossd6891432017-09-27 17:39:56 -07001326 // a rebuild when error-prone is turned off).
Colin Crossc6bbef32017-08-14 14:16:06 -07001327 // TODO(ccross): Once we always compile with javac9 we may be able to conditionally
1328 // enable error-prone without affecting the output class files.
Colin Cross1ee23172017-10-18 14:44:18 -07001329 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001330 RunErrorProne(ctx, errorprone, uniqueSrcFiles, srcJars, flags)
Colin Crossc6bbef32017-08-14 14:16:06 -07001331 extraJarDeps = append(extraJarDeps, errorprone)
1332 }
1333
Nan Zhang61eaedb2017-11-02 13:28:15 -07001334 if enable_sharding {
Colin Crossf7d84012020-02-21 08:16:41 -08001335 flags.classpath = append(flags.classpath, headerJarFileWithoutJarjar)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001336 shardSize := int(*(j.properties.Javac_shard_size))
1337 var shardSrcs []android.Paths
1338 if len(uniqueSrcFiles) > 0 {
Colin Cross0a2f7192019-09-23 14:33:09 -07001339 shardSrcs = android.ShardPaths(uniqueSrcFiles, shardSize)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001340 for idx, shardSrc := range shardSrcs {
Colin Cross3b706fd2019-09-05 16:44:18 -07001341 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1342 nil, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001343 jars = append(jars, classes)
1344 }
1345 }
1346 if len(srcJars) > 0 {
Colin Cross3b706fd2019-09-05 16:44:18 -07001347 classes := j.compileJavaClasses(ctx, jarName, len(shardSrcs),
1348 nil, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001349 jars = append(jars, classes)
1350 }
1351 } else {
Colin Cross3b706fd2019-09-05 16:44:18 -07001352 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueSrcFiles, srcJars, flags, extraJarDeps)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001353 jars = append(jars, classes)
1354 }
Colin Crossd6891432017-09-27 17:39:56 -07001355 if ctx.Failed() {
1356 return
1357 }
Colin Cross2fe66872015-03-30 17:20:39 -07001358 }
1359
Colin Cross0c4ce212019-05-03 15:28:19 -07001360 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1361
1362 var includeSrcJar android.WritablePath
1363 if Bool(j.properties.Include_srcs) {
1364 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1365 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1366 }
1367
Colin Crosscedd4762018-09-13 11:26:19 -07001368 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1369 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Colin Cross0f37af02017-09-27 17:42:05 -07001370 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
Colin Cross988708c2019-05-06 14:04:11 -07001371 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
Colin Cross0f37af02017-09-27 17:42:05 -07001372
1373 var resArgs []string
1374 var resDeps android.Paths
1375
1376 resArgs = append(resArgs, dirArgs...)
1377 resDeps = append(resDeps, dirDeps...)
1378
1379 resArgs = append(resArgs, fileArgs...)
1380 resDeps = append(resDeps, fileDeps...)
1381
Colin Cross988708c2019-05-06 14:04:11 -07001382 resArgs = append(resArgs, extraArgs...)
1383 resDeps = append(resDeps, extraDeps...)
1384
Colin Cross40a36712017-09-27 17:41:35 -07001385 if len(resArgs) > 0 {
Colin Cross1ee23172017-10-18 14:44:18 -07001386 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
Colin Crosse9a275b2017-10-16 17:09:48 -07001387 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Colin Cross331a1212018-08-15 20:40:52 -07001388 j.resourceJar = resourceJar
Colin Cross65bf4f22015-04-03 16:54:17 -07001389 if ctx.Failed() {
1390 return
1391 }
1392 }
1393
Colin Cross0c4ce212019-05-03 15:28:19 -07001394 var resourceJars android.Paths
1395 if j.resourceJar != nil {
1396 resourceJars = append(resourceJars, j.resourceJar)
1397 }
1398 if Bool(j.properties.Include_srcs) {
1399 resourceJars = append(resourceJars, includeSrcJar)
1400 }
1401 resourceJars = append(resourceJars, deps.staticResourceJars...)
Colin Cross331a1212018-08-15 20:40:52 -07001402
Colin Cross0c4ce212019-05-03 15:28:19 -07001403 if len(resourceJars) > 1 {
Colin Cross331a1212018-08-15 20:40:52 -07001404 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
Colin Cross0c4ce212019-05-03 15:28:19 -07001405 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
Colin Cross331a1212018-08-15 20:40:52 -07001406 false, nil, nil)
1407 j.resourceJar = combinedJar
Colin Cross0c4ce212019-05-03 15:28:19 -07001408 } else if len(resourceJars) == 1 {
1409 j.resourceJar = resourceJars[0]
Colin Cross331a1212018-08-15 20:40:52 -07001410 }
1411
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001412 if len(deps.staticJars) > 0 {
1413 jars = append(jars, deps.staticJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001414 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001415
Colin Cross094054a2018-10-17 15:10:48 -07001416 manifest := j.overrideManifest
1417 if !manifest.Valid() && j.properties.Manifest != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001418 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Colin Cross366938f2017-12-11 16:29:02 -08001419 }
Colin Cross635acc92017-09-12 22:50:46 -07001420
Colin Cross8a497952019-03-05 22:25:09 -08001421 services := android.PathsForModuleSrc(ctx, j.properties.Services)
Alex Light7f004a72019-02-21 13:27:37 -08001422 if len(services) > 0 {
1423 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1424 var zipargs []string
1425 for _, file := range services {
1426 serviceFile := file.String()
1427 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1428 }
1429 ctx.Build(pctx, android.BuildParams{
1430 Rule: zip,
1431 Output: servicesJar,
1432 Implicits: services,
1433 Args: map[string]string{
Colin Cross0b9f31f2019-02-28 11:00:01 -08001434 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
Alex Light7f004a72019-02-21 13:27:37 -08001435 },
1436 })
1437 jars = append(jars, servicesJar)
1438 }
1439
Colin Cross0a6e0072017-08-30 14:24:55 -07001440 // Combine the classes built from sources, any manifests, and any static libraries into
Nan Zhanged19fc32017-10-19 13:06:22 -07001441 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross3063b782018-08-15 11:19:12 -07001442 var outputFile android.ModuleOutPath
Colin Crosse9a275b2017-10-16 17:09:48 -07001443
1444 if len(jars) == 1 && !manifest.Valid() {
Colin Cross3063b782018-08-15 11:19:12 -07001445 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok {
1446 // Optimization: skip the combine step if there is nothing to do
1447 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1448 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1449 // any if len(jars) == 1.
1450 outputFile = moduleOutPath
1451 } else {
1452 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1453 ctx.Build(pctx, android.BuildParams{
1454 Rule: android.Cp,
1455 Input: jars[0],
1456 Output: combinedJar,
1457 })
1458 outputFile = combinedJar
1459 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001460 } else {
Colin Cross1ee23172017-10-18 14:44:18 -07001461 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001462 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
Colin Cross9b38aef2018-08-27 15:42:25 -07001463 false, nil, nil)
Colin Crosse9a275b2017-10-16 17:09:48 -07001464 outputFile = combinedJar
1465 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001466
Colin Cross331a1212018-08-15 20:40:52 -07001467 // jarjar implementation jar if necessary
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001468 if j.expandJarjarRules != nil {
Colin Cross8649b262017-09-27 18:03:17 -07001469 // Transform classes.jar into classes-jarjar.jar
Colin Cross1ee23172017-10-18 14:44:18 -07001470 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001471 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
Colin Crosse9a275b2017-10-16 17:09:48 -07001472 outputFile = jarjarFile
Colin Cross331a1212018-08-15 20:40:52 -07001473
1474 // jarjar resource jar if necessary
1475 if j.resourceJar != nil {
1476 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001477 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
Colin Cross331a1212018-08-15 20:40:52 -07001478 j.resourceJar = resourceJarJarFile
1479 }
1480
Colin Cross0a6e0072017-08-30 14:24:55 -07001481 if ctx.Failed() {
1482 return
1483 }
1484 }
Vladimir Marko0975ee02019-04-02 10:29:55 +01001485
1486 // Check package restrictions if necessary.
1487 if len(j.properties.Permitted_packages) > 0 {
1488 // Check packages and copy to package-checked file.
1489 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
1490 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
1491 j.additionalCheckedModules = append(j.additionalCheckedModules, pkgckFile)
1492
1493 if ctx.Failed() {
1494 return
1495 }
1496 }
1497
Nan Zhanged19fc32017-10-19 13:06:22 -07001498 j.implementationJarFile = outputFile
1499 if j.headerJarFile == nil {
1500 j.headerJarFile = j.implementationJarFile
1501 }
Colin Cross2fe66872015-03-30 17:20:39 -07001502
Jiyong Park93e57a02020-02-21 16:04:53 +09001503 // Force enable the instrumentation for java code that is built for APEXes ...
1504 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
1505 // doesn't make sense)
1506 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
1507 if android.DirectlyInAnyApex(ctx, ctx.ModuleName()) && !isJacocoAgent && !j.IsForPlatform() {
Jiyong Park00cae1c2020-02-18 12:50:44 +00001508 j.properties.Instrument = true
1509 }
1510
Colin Cross3144dfc2018-01-03 15:06:47 -08001511 if j.shouldInstrument(ctx) {
Colin Crosscb933592017-11-22 13:49:43 -08001512 outputFile = j.instrument(ctx, flags, outputFile, jarName)
1513 }
1514
Colin Cross331a1212018-08-15 20:40:52 -07001515 // merge implementation jar with resources if necessary
1516 implementationAndResourcesJar := outputFile
1517 if j.resourceJar != nil {
Colin Cross08a409d2019-04-29 10:22:44 -07001518 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Colin Cross331a1212018-08-15 20:40:52 -07001519 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Colin Cross08a409d2019-04-29 10:22:44 -07001520 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
Colin Cross331a1212018-08-15 20:40:52 -07001521 false, nil, nil)
1522 implementationAndResourcesJar = combinedJar
1523 }
1524
1525 j.implementationAndResourcesJar = implementationAndResourcesJar
1526
Jiyong Park6b21c7d2020-02-11 09:16:01 +09001527 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
1528 if android.DirectlyInAnyApex(ctx, ctx.ModuleName()) && !j.IsForPlatform() {
1529 if j.deviceProperties.Compile_dex == nil {
1530 j.deviceProperties.Compile_dex = proptools.BoolPtr(true)
1531 }
1532 if j.deviceProperties.Hostdex == nil {
1533 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1534 }
1535 }
1536
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001537 if ctx.Device() && j.hasCode(ctx) &&
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001538 (Bool(j.properties.Installable) || Bool(j.deviceProperties.Compile_dex)) {
Colin Cross8faf8fc2019-01-16 15:15:52 -08001539 // Dex compilation
Colin Cross3063b782018-08-15 11:19:12 -07001540 var dexOutputFile android.ModuleOutPath
David Brazdil17ef5632018-06-27 10:27:45 +01001541 dexOutputFile = j.compileDex(ctx, flags, outputFile, jarName)
Colin Cross2fe66872015-03-30 17:20:39 -07001542 if ctx.Failed() {
1543 return
1544 }
Colin Cross331a1212018-08-15 20:40:52 -07001545
Jiyong Park09cb6292019-07-15 15:29:23 +09001546 // Hidden API CSV generation and dex encoding
1547 dexOutputFile = j.hiddenAPI.hiddenAPI(ctx, dexOutputFile, j.implementationJarFile,
1548 j.deviceProperties.UncompressDex)
Colin Cross8faf8fc2019-01-16 15:15:52 -08001549
Colin Cross331a1212018-08-15 20:40:52 -07001550 // merge dex jar with resources if necessary
1551 if j.resourceJar != nil {
1552 jars := android.Paths{dexOutputFile, j.resourceJar}
1553 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
1554 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1555 false, nil, nil)
Nicolas Geoffrayf3438722019-01-23 15:57:21 +00001556 if j.deviceProperties.UncompressDex {
1557 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
1558 TransformZipAlign(ctx, combinedAlignedJar, combinedJar)
1559 dexOutputFile = combinedAlignedJar
1560 } else {
1561 dexOutputFile = combinedJar
1562 }
Colin Cross331a1212018-08-15 20:40:52 -07001563 }
1564
1565 j.dexJarFile = dexOutputFile
1566
Colin Cross8faf8fc2019-01-16 15:15:52 -08001567 // Dexpreopting
Colin Cross43f08db2018-11-12 10:13:39 -08001568 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
1569
1570 j.maybeStrippedDexJarFile = dexOutputFile
1571
Colin Cross3063b782018-08-15 11:19:12 -07001572 outputFile = dexOutputFile
Colin Cross43f08db2018-11-12 10:13:39 -08001573
1574 if ctx.Failed() {
1575 return
1576 }
Colin Cross331a1212018-08-15 20:40:52 -07001577 } else {
1578 outputFile = implementationAndResourcesJar
Colin Cross2fe66872015-03-30 17:20:39 -07001579 }
Colin Cross331a1212018-08-15 20:40:52 -07001580
Colin Crossb7a63242015-04-16 14:09:14 -07001581 ctx.CheckbuildFile(outputFile)
Colin Cross3063b782018-08-15 11:19:12 -07001582
1583 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1584 j.outputFile = outputFile.WithoutRel()
Colin Cross2fe66872015-03-30 17:20:39 -07001585}
1586
Colin Cross3b706fd2019-09-05 16:44:18 -07001587func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
1588 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.WritablePath {
1589
1590 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
1591 if idx >= 0 {
1592 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
1593 jarName += strconv.Itoa(idx)
1594 }
1595
1596 classes := android.PathForModuleOut(ctx, "javac", jarName)
1597 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, flags, extraJarDeps)
1598
1599 if ctx.Config().EmitXrefRules() {
1600 extractionFile := android.PathForModuleOut(ctx, kzipName)
1601 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1602 j.kytheFiles = append(j.kytheFiles, extractionFile)
1603 }
1604
1605 return classes
1606}
1607
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001608// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1609// since some of these flags may be used internally.
1610func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1611 for _, flag := range flags {
1612 flag = strings.TrimSpace(flag)
1613
1614 if !strings.HasPrefix(flag, "-") {
1615 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1616 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1617 ctx.PropertyErrorf("kotlincflags",
1618 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1619 } else if inList(flag, config.KotlincIllegalFlags) {
1620 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1621 } else if flag == "-include-runtime" {
1622 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1623 } else {
1624 args := strings.Split(flag, " ")
1625 if args[0] == "-kotlin-home" {
1626 ctx.PropertyErrorf("kotlincflags",
1627 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1628 }
1629 }
1630 }
1631}
1632
Colin Cross8eadbf02017-10-24 17:46:00 -07001633func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
Colin Crossf7d84012020-02-21 08:16:41 -08001634 deps deps, flags javaBuilderFlags, jarName string,
1635 extraJars android.Paths) (headerJar, jarjarHeaderJar android.Path) {
Nan Zhanged19fc32017-10-19 13:06:22 -07001636
1637 var jars android.Paths
Colin Cross8eadbf02017-10-24 17:46:00 -07001638 if len(srcFiles) > 0 || len(srcJars) > 0 {
Nan Zhanged19fc32017-10-19 13:06:22 -07001639 // Compile java sources into turbine.jar.
1640 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1641 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1642 if ctx.Failed() {
Colin Crossf7d84012020-02-21 08:16:41 -08001643 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001644 }
1645 jars = append(jars, turbineJar)
1646 }
1647
Colin Cross55f63ea2018-08-27 12:37:09 -07001648 jars = append(jars, extraJars...)
1649
Nan Zhanged19fc32017-10-19 13:06:22 -07001650 // Combine any static header libraries into classes-header.jar. If there is only
1651 // one input jar this step will be skipped.
Nan Zhanged19fc32017-10-19 13:06:22 -07001652 jars = append(jars, deps.staticHeaderJars...)
1653
Colin Cross5c6ecc12017-10-23 18:12:27 -07001654 // we cannot skip the combine step for now if there is only one jar
1655 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1656 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001657 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
Colin Cross6c6e6cd2019-05-08 14:30:12 -07001658 false, nil, []string{"META-INF/TRANSITIVE"})
Colin Cross5c6ecc12017-10-23 18:12:27 -07001659 headerJar = combinedJar
Colin Crossf7d84012020-02-21 08:16:41 -08001660 jarjarHeaderJar = combinedJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001661
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001662 if j.expandJarjarRules != nil {
Nan Zhanged19fc32017-10-19 13:06:22 -07001663 // Transform classes.jar into classes-jarjar.jar
1664 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001665 TransformJarJar(ctx, jarjarFile, headerJar, j.expandJarjarRules)
Colin Crossf7d84012020-02-21 08:16:41 -08001666 jarjarHeaderJar = jarjarFile
Nan Zhanged19fc32017-10-19 13:06:22 -07001667 if ctx.Failed() {
Colin Crossf7d84012020-02-21 08:16:41 -08001668 return nil, nil
Nan Zhanged19fc32017-10-19 13:06:22 -07001669 }
1670 }
1671
Colin Crossf7d84012020-02-21 08:16:41 -08001672 return headerJar, jarjarHeaderJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001673}
1674
Colin Crosscb933592017-11-22 13:49:43 -08001675func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross3063b782018-08-15 11:19:12 -07001676 classesJar android.Path, jarName string) android.ModuleOutPath {
Colin Crosscb933592017-11-22 13:49:43 -08001677
Colin Cross7a3139e2017-12-19 13:57:50 -08001678 specs := j.jacocoModuleToZipCommand(ctx)
Colin Crosscb933592017-11-22 13:49:43 -08001679
Colin Cross84c38822018-01-03 15:59:46 -08001680 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Crosscb933592017-11-22 13:49:43 -08001681 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
1682
1683 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1684
1685 j.jacocoReportClassesFile = jacocoReportClassesFile
1686
1687 return instrumentedJar
1688}
1689
albaltai36ff7dc2018-12-25 14:35:23 +08001690var _ Dependency = (*Module)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001691
Nan Zhanged19fc32017-10-19 13:06:22 -07001692func (j *Module) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001693 if j.headerJarFile == nil {
1694 return nil
1695 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001696 return android.Paths{j.headerJarFile}
1697}
1698
1699func (j *Module) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08001700 if j.implementationJarFile == nil {
1701 return nil
1702 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001703 return android.Paths{j.implementationJarFile}
Colin Cross2fe66872015-03-30 17:20:39 -07001704}
1705
Colin Crossf24a22a2019-01-31 14:12:44 -08001706func (j *Module) DexJar() android.Path {
1707 return j.dexJarFile
1708}
1709
Colin Cross331a1212018-08-15 20:40:52 -07001710func (j *Module) ResourceJars() android.Paths {
1711 if j.resourceJar == nil {
1712 return nil
1713 }
1714 return android.Paths{j.resourceJar}
1715}
1716
1717func (j *Module) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001718 if j.implementationAndResourcesJar == nil {
1719 return nil
1720 }
Colin Cross331a1212018-08-15 20:40:52 -07001721 return android.Paths{j.implementationAndResourcesJar}
1722}
1723
Colin Cross46c9b8b2017-06-22 16:51:17 -07001724func (j *Module) AidlIncludeDirs() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001725 // exportAidlIncludeDirs is type android.Paths already
Colin Crossc0b06f12015-04-08 13:03:43 -07001726 return j.exportAidlIncludeDirs
1727}
1728
Jiyong Park1be96912018-05-28 18:02:19 +09001729func (j *Module) ExportedSdkLibs() []string {
albaltai36ff7dc2018-12-25 14:35:23 +08001730 // exportedSdkLibs is type []string
Jiyong Park1be96912018-05-28 18:02:19 +09001731 return j.exportedSdkLibs
1732}
1733
Artur Satayev9cf46692019-11-26 18:08:34 +00001734func (j *Module) ExportedPlugins() (android.Paths, []string) {
1735 return j.exportedPluginJars, j.exportedPluginClasses
1736}
1737
Colin Cross0c4ce212019-05-03 15:28:19 -07001738func (j *Module) SrcJarArgs() ([]string, android.Paths) {
1739 return j.srcJarArgs, j.srcJarDeps
1740}
1741
Colin Cross46c9b8b2017-06-22 16:51:17 -07001742var _ logtagsProducer = (*Module)(nil)
Colin Crossf05fe972015-04-10 17:45:20 -07001743
Colin Cross46c9b8b2017-06-22 16:51:17 -07001744func (j *Module) logtags() android.Paths {
Colin Crossf05fe972015-04-10 17:45:20 -07001745 return j.logtagsSrcs
1746}
1747
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001748// Collect information for opening IDE project files in java/jdeps.go.
1749func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
1750 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
1751 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
patricktu18c82ff2019-05-10 15:48:50 +08001752 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001753 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001754 if j.expandJarjarRules != nil {
1755 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001756 }
1757}
1758
1759func (j *Module) CompilerDeps() []string {
1760 jdeps := []string{}
1761 jdeps = append(jdeps, j.properties.Libs...)
1762 jdeps = append(jdeps, j.properties.Static_libs...)
1763 return jdeps
1764}
1765
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001766func (j *Module) hasCode(ctx android.ModuleContext) bool {
1767 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
1768 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
1769}
1770
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001771func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Jiyong Park0f80c182020-01-31 02:49:53 +09001772 // Dependencies other than the static linkage are all considered crossing APEX boundary
Jooyung Han5e9013b2020-03-10 06:23:13 +09001773 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
1774 return true
1775 }
Jooyung Han5e9013b2020-03-10 06:23:13 +09001776 return false
Jiyong Parka7bc8ad2019-10-15 15:20:07 +09001777}
1778
Jiyong Park0b238752019-10-29 11:23:10 +09001779func (j *Module) Stem() string {
1780 return proptools.StringDefault(j.deviceProperties.Stem, j.Name())
1781}
1782
Jiyong Park618922e2020-01-08 13:35:43 +09001783func (j *Module) JacocoReportClassesFile() android.Path {
1784 return j.jacocoReportClassesFile
1785}
1786
Martin Stjernholm6d415272020-01-31 17:10:36 +00001787func (j *Module) IsInstallable() bool {
1788 return Bool(j.properties.Installable)
1789}
1790
Colin Cross2fe66872015-03-30 17:20:39 -07001791//
1792// Java libraries (.jar file)
1793//
1794
Anton Hansson78156ef2020-03-27 19:39:48 +00001795type LibraryProperties struct {
1796 Dist struct {
1797 // The tag of the output of this module that should be output.
1798 Tag *string `android:"arch_variant"`
1799 } `android:"arch_variant"`
1800}
1801
Colin Crossf506d872017-07-19 15:53:04 -07001802type Library struct {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001803 Module
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001804
Anton Hansson78156ef2020-03-27 19:39:48 +00001805 libraryProperties LibraryProperties
1806
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001807 InstallMixin func(ctx android.ModuleContext, installPath android.Path) (extraInstallDeps android.Paths)
Colin Cross2fe66872015-03-30 17:20:39 -07001808}
1809
Colin Cross42be7612019-02-21 18:12:14 -08001810func shouldUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter) bool {
Ulya Trafimovichf491dde2020-01-24 12:19:45 +00001811 // Store uncompressed (and aligned) any dex files from jars in APEXes.
1812 if am, ok := ctx.Module().(android.ApexModule); ok && !am.IsForPlatform() {
1813 return true
1814 }
1815
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001816 // Store uncompressed (and do not strip) dex files from boot class path jars.
1817 if inList(ctx.ModuleName(), ctx.Config().BootJars()) {
1818 return true
1819 }
1820
1821 // Store uncompressed dex files that are preopted on /system.
Colin Cross42be7612019-02-21 18:12:14 -08001822 if !dexpreopter.dexpreoptDisabled(ctx) && (ctx.Host() || !odexOnSystemOther(ctx, dexpreopter.installPath)) {
Vladimir Markoe8b00d62018-12-21 15:54:16 +00001823 return true
1824 }
Colin Cross083a2aa2019-02-06 16:37:12 -08001825 if ctx.Config().UncompressPrivAppDex() &&
1826 inList(ctx.ModuleName(), ctx.Config().ModulesLoadedByPrivilegedModules()) {
1827 return true
1828 }
1829
Colin Cross2fc72f62018-12-21 12:59:54 -08001830 return false
1831}
1832
Colin Crossf506d872017-07-19 15:53:04 -07001833func (j *Library) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Artur Satayev2db1c3f2020-04-08 19:09:30 +01001834 j.checkSdkVersions(ctx)
Jiyong Park0b238752019-10-29 11:23:10 +09001835 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross43f08db2018-11-12 10:13:39 -08001836 j.dexpreopter.isSDKLibrary = j.deviceProperties.IsSDKLibrary
Colin Cross42be7612019-02-21 18:12:14 -08001837 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001838 j.deviceProperties.UncompressDex = j.dexpreopter.uncompressedDex
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001839 j.compile(ctx, nil)
Colin Crossb7a63242015-04-16 14:09:14 -07001840
Jiyong Park7f7766d2019-07-25 22:02:35 +09001841 exclusivelyForApex := android.InAnyApex(ctx.ModuleName()) && !j.IsForPlatform()
1842 if (Bool(j.properties.Installable) || ctx.Host()) && !exclusivelyForApex {
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001843 var extraInstallDeps android.Paths
1844 if j.InstallMixin != nil {
1845 extraInstallDeps = j.InstallMixin(ctx, j.outputFile)
1846 }
Colin Cross2c429dc2017-08-31 16:45:16 -07001847 j.installFile = ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Colin Crossf0f2e2c2019-10-15 16:36:40 -07001848 ctx.ModuleName()+".jar", j.outputFile, extraInstallDeps...)
Colin Cross2c429dc2017-08-31 16:45:16 -07001849 }
Anton Hansson78156ef2020-03-27 19:39:48 +00001850
1851 // Verify Dist.Tag is set to a supported output
1852 if j.libraryProperties.Dist.Tag != nil {
1853 distFiles, err := j.OutputFiles(*j.libraryProperties.Dist.Tag)
1854 if err != nil {
1855 ctx.PropertyErrorf("dist.tag", "%s", err.Error())
1856 }
1857 j.distFile = distFiles[0]
1858 }
Colin Crossb7a63242015-04-16 14:09:14 -07001859}
1860
Colin Crossf506d872017-07-19 15:53:04 -07001861func (j *Library) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001862 j.deps(ctx)
1863}
1864
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001865const (
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001866 aidlIncludeDir = "aidl"
1867 javaDir = "java"
1868 jarFileSuffix = ".jar"
1869 testConfigSuffix = "-AndroidTest.xml"
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001870)
1871
Paul Duffina0dbf432019-12-05 11:25:53 +00001872// path to the jar file of a java library. Relative to <sdk_root>/<api_dir>
Paul Duffina04c1072020-03-02 10:16:35 +00001873func sdkSnapshotFilePathForJar(osPrefix, name string) string {
1874 return sdkSnapshotFilePathForMember(osPrefix, name, jarFileSuffix)
Paul Duffin1b82e6a2019-12-03 18:06:47 +00001875}
1876
Paul Duffina04c1072020-03-02 10:16:35 +00001877func sdkSnapshotFilePathForMember(osPrefix, name string, suffix string) string {
1878 return filepath.Join(javaDir, osPrefix, name+suffix)
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001879}
1880
Paul Duffin13879572019-11-28 14:31:38 +00001881type librarySdkMemberType struct {
Paul Duffin255f18e2019-12-13 11:22:16 +00001882 android.SdkMemberTypeBase
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00001883
1884 // Function to retrieve the appropriate output jar (implementation or header) from
1885 // the library.
1886 jarToExportGetter func(j *Library) android.Path
Paul Duffin13879572019-11-28 14:31:38 +00001887}
1888
1889func (mt *librarySdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
1890 mctx.AddVariationDependencies(nil, dependencyTag, names...)
1891}
1892
1893func (mt *librarySdkMemberType) IsInstance(module android.Module) bool {
1894 _, ok := module.(*Library)
1895 return ok
1896}
1897
Paul Duffin3a4eb502020-03-19 16:11:18 +00001898func (mt *librarySdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
1899 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_import")
Paul Duffin14eb4672020-03-02 11:33:02 +00001900}
Paul Duffina0dbf432019-12-05 11:25:53 +00001901
Paul Duffin14eb4672020-03-02 11:33:02 +00001902func (mt *librarySdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
Paul Duffina551a1c2020-03-17 21:04:24 +00001903 return &librarySdkMemberProperties{}
Paul Duffin14eb4672020-03-02 11:33:02 +00001904}
1905
1906type librarySdkMemberProperties struct {
1907 android.SdkMemberPropertiesBase
1908
Paul Duffin864e1b42020-05-06 10:23:19 +01001909 JarToExport android.Path `android:"arch_variant"`
Paul Duffina551a1c2020-03-17 21:04:24 +00001910 AidlIncludeDirs android.Paths
Paul Duffin14eb4672020-03-02 11:33:02 +00001911}
1912
Paul Duffin3a4eb502020-03-19 16:11:18 +00001913func (p *librarySdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin13879572019-11-28 14:31:38 +00001914 j := variant.(*Library)
1915
Paul Duffina551a1c2020-03-17 21:04:24 +00001916 p.JarToExport = ctx.MemberType().(*librarySdkMemberType).jarToExportGetter(j)
1917 p.AidlIncludeDirs = j.AidlIncludeDirs()
Paul Duffin14eb4672020-03-02 11:33:02 +00001918}
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001919
Paul Duffin3a4eb502020-03-19 16:11:18 +00001920func (p *librarySdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffina551a1c2020-03-17 21:04:24 +00001921 builder := ctx.SnapshotBuilder()
Paul Duffin3a4eb502020-03-19 16:11:18 +00001922
Paul Duffina551a1c2020-03-17 21:04:24 +00001923 exportedJar := p.JarToExport
1924 if exportedJar != nil {
1925 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
Paul Duffin14eb4672020-03-02 11:33:02 +00001926 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
1927
Paul Duffina551a1c2020-03-17 21:04:24 +00001928 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
1929 }
1930
1931 aidlIncludeDirs := p.AidlIncludeDirs
1932 if len(aidlIncludeDirs) != 0 {
1933 sdkModuleContext := ctx.SdkModuleContext()
1934 for _, dir := range aidlIncludeDirs {
Paul Duffin14eb4672020-03-02 11:33:02 +00001935 // TODO(jiyong): copy parcelable declarations only
1936 aidlFiles, _ := sdkModuleContext.GlobWithDeps(dir.String()+"/**/*.aidl", nil)
1937 for _, file := range aidlFiles {
1938 builder.CopyToSnapshot(android.PathForSource(sdkModuleContext, file), filepath.Join(aidlIncludeDir, file))
1939 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001940 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001941
Paul Duffina551a1c2020-03-17 21:04:24 +00001942 // TODO(b/151933053) - add aidl include dirs property
Paul Duffin14eb4672020-03-02 11:33:02 +00001943 }
Paul Duffin0e0cf1d2019-11-12 19:39:25 +00001944}
1945
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00001946var javaHeaderLibsSdkMemberType android.SdkMemberType = &librarySdkMemberType{
1947 android.SdkMemberTypeBase{
1948 PropertyName: "java_header_libs",
1949 SupportsSdk: true,
Paul Duffin7b81f5e2020-01-13 21:03:22 +00001950 },
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00001951 func(j *Library) android.Path {
Paul Duffina0dbf432019-12-05 11:25:53 +00001952 headerJars := j.HeaderJars()
1953 if len(headerJars) != 1 {
1954 panic(fmt.Errorf("there must be only one header jar from %q", j.Name()))
1955 }
1956
1957 return headerJars[0]
Paul Duffinf5c0a9c2020-02-28 14:39:53 +00001958 },
Paul Duffina0dbf432019-12-05 11:25:53 +00001959}
1960
Colin Cross1b16b0e2019-02-12 14:41:32 -08001961// java_library builds and links sources into a `.jar` file for the device, and possibly for the host as well.
1962//
1963// By default, a java_library has a single variant that produces a `.jar` file containing `.class` files that were
1964// compiled against the device bootclasspath. This jar is not suitable for installing on a device, but can be used
1965// as a `static_libs` dependency of another module.
1966//
1967// Specifying `installable: true` will product a `.jar` file containing `classes.dex` files, suitable for installing on
1968// a device.
1969//
1970// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1971// compiled against the host bootclasspath.
Colin Cross9ae1b922018-06-26 17:59:05 -07001972func LibraryFactory() android.Module {
1973 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07001974
Colin Cross9ae1b922018-06-26 17:59:05 -07001975 module.AddProperties(
1976 &module.Module.properties,
1977 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001978 &module.Module.dexpreoptProperties,
Anton Hansson78156ef2020-03-27 19:39:48 +00001979 &module.Module.protoProperties,
1980 &module.libraryProperties)
Colin Cross2fe66872015-03-30 17:20:39 -07001981
Jiyong Park7f7766d2019-07-25 22:02:35 +09001982 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09001983 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09001984 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross9ae1b922018-06-26 17:59:05 -07001985 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001986}
1987
Colin Cross1b16b0e2019-02-12 14:41:32 -08001988// java_library_static is an obsolete alias for java_library.
1989func LibraryStaticFactory() android.Module {
1990 return LibraryFactory()
1991}
1992
1993// java_library_host builds and links sources into a `.jar` file for the host.
1994//
1995// A java_library_host has a single variant that produces a `.jar` file containing `.class` files that were
1996// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001997func LibraryHostFactory() android.Module {
1998 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07001999
Colin Cross6af17aa2017-09-20 12:59:05 -07002000 module.AddProperties(
2001 &module.Module.properties,
2002 &module.Module.protoProperties)
Colin Cross36242852017-06-23 15:06:31 -07002003
Colin Cross9ae1b922018-06-26 17:59:05 -07002004 module.Module.properties.Installable = proptools.BoolPtr(true)
2005
Jiyong Park7f7766d2019-07-25 22:02:35 +09002006 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002007 InitJavaModule(module, android.HostSupported)
Colin Cross36242852017-06-23 15:06:31 -07002008 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002009}
2010
2011//
Colin Crossb628ea52018-08-14 16:42:33 -07002012// Java Tests
Colin Cross05638fc2018-04-09 18:40:24 -07002013//
2014
2015type testProperties struct {
Colin Cross05638fc2018-04-09 18:40:24 -07002016 // list of compatibility suites (for example "cts", "vts") that the module should be
2017 // installed into.
2018 Test_suites []string `android:"arch_variant"`
Julien Despreze146e392018-08-02 15:00:46 -07002019
2020 // the name of the test configuration (for example "AndroidTest.xml") that should be
2021 // installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002022 Test_config *string `android:"path,arch_variant"`
Colin Crossd96ca352018-08-10 16:06:24 -07002023
Jack He33338892018-09-19 02:21:28 -07002024 // the name of the test configuration template (for example "AndroidTestTemplate.xml") that
2025 // should be installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08002026 Test_config_template *string `android:"path,arch_variant"`
Jack He33338892018-09-19 02:21:28 -07002027
Colin Crossd96ca352018-08-10 16:06:24 -07002028 // list of files or filegroup modules that provide data that should be installed alongside
2029 // the test
Colin Cross27b922f2019-03-04 22:35:41 -08002030 Data []string `android:"path"`
Dan Shi6ffaaa82019-09-26 11:41:36 -07002031
2032 // Flag to indicate whether or not to create test config automatically. If AndroidTest.xml
2033 // doesn't exist next to the Android.bp, this attribute doesn't need to be set to true
2034 // explicitly.
2035 Auto_gen_config *bool
easoncylee5bcff5d2020-04-30 14:57:06 +08002036
2037 // Add parameterized mainline modules to auto generated test config. The options will be
2038 // handled by TradeFed to do downloading and installing the specified modules on the device.
2039 Test_mainline_modules []string
Colin Cross05638fc2018-04-09 18:40:24 -07002040}
2041
Paul Duffin42df1442019-03-20 12:45:53 +00002042type testHelperLibraryProperties struct {
2043 // list of compatibility suites (for example "cts", "vts") that the module should be
2044 // installed into.
2045 Test_suites []string `android:"arch_variant"`
2046}
2047
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002048type prebuiltTestProperties struct {
2049 // list of compatibility suites (for example "cts", "vts") that the module should be
2050 // installed into.
2051 Test_suites []string `android:"arch_variant"`
2052
2053 // the name of the test configuration (for example "AndroidTest.xml") that should be
2054 // installed with the module.
2055 Test_config *string `android:"path,arch_variant"`
2056}
2057
Colin Cross05638fc2018-04-09 18:40:24 -07002058type Test struct {
2059 Library
2060
2061 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07002062
2063 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07002064 data android.Paths
Colin Cross303e21f2018-08-07 16:49:25 -07002065}
2066
Paul Duffin42df1442019-03-20 12:45:53 +00002067type TestHelperLibrary struct {
2068 Library
2069
2070 testHelperLibraryProperties testHelperLibraryProperties
2071}
2072
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002073type JavaTestImport struct {
2074 Import
2075
2076 prebuiltTestProperties prebuiltTestProperties
2077
2078 testConfig android.Path
2079}
2080
Colin Cross303e21f2018-08-07 16:49:25 -07002081func (j *Test) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Dan Shi6ffaaa82019-09-26 11:41:36 -07002082 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.testProperties.Test_config, j.testProperties.Test_config_template,
2083 j.testProperties.Test_suites, j.testProperties.Auto_gen_config)
Colin Cross8a497952019-03-05 22:25:09 -08002084 j.data = android.PathsForModuleSrc(ctx, j.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07002085
2086 j.Library.GenerateAndroidBuildActions(ctx)
Colin Cross05638fc2018-04-09 18:40:24 -07002087}
2088
Paul Duffin42df1442019-03-20 12:45:53 +00002089func (j *TestHelperLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2090 j.Library.GenerateAndroidBuildActions(ctx)
2091}
2092
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002093func (j *JavaTestImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2094 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.prebuiltTestProperties.Test_config, nil,
2095 j.prebuiltTestProperties.Test_suites, nil)
2096
2097 j.Import.GenerateAndroidBuildActions(ctx)
2098}
2099
2100type testSdkMemberType struct {
2101 android.SdkMemberTypeBase
2102}
2103
2104func (mt *testSdkMemberType) AddDependencies(mctx android.BottomUpMutatorContext, dependencyTag blueprint.DependencyTag, names []string) {
2105 mctx.AddVariationDependencies(nil, dependencyTag, names...)
2106}
2107
2108func (mt *testSdkMemberType) IsInstance(module android.Module) bool {
2109 _, ok := module.(*Test)
2110 return ok
2111}
2112
Paul Duffin3a4eb502020-03-19 16:11:18 +00002113func (mt *testSdkMemberType) AddPrebuiltModule(ctx android.SdkMemberContext, member android.SdkMember) android.BpModule {
2114 return ctx.SnapshotBuilder().AddPrebuiltModule(member, "java_test_import")
Paul Duffin14eb4672020-03-02 11:33:02 +00002115}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002116
Paul Duffin14eb4672020-03-02 11:33:02 +00002117func (mt *testSdkMemberType) CreateVariantPropertiesStruct() android.SdkMemberProperties {
2118 return &testSdkMemberProperties{}
2119}
2120
2121type testSdkMemberProperties struct {
2122 android.SdkMemberPropertiesBase
2123
Paul Duffina551a1c2020-03-17 21:04:24 +00002124 JarToExport android.Path
2125 TestConfig android.Path
Paul Duffin14eb4672020-03-02 11:33:02 +00002126}
2127
Paul Duffin3a4eb502020-03-19 16:11:18 +00002128func (p *testSdkMemberProperties) PopulateFromVariant(ctx android.SdkMemberContext, variant android.Module) {
Paul Duffin14eb4672020-03-02 11:33:02 +00002129 test := variant.(*Test)
2130
2131 implementationJars := test.ImplementationJars()
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002132 if len(implementationJars) != 1 {
Paul Duffin14eb4672020-03-02 11:33:02 +00002133 panic(fmt.Errorf("there must be only one implementation jar from %q", test.Name()))
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002134 }
2135
Paul Duffina551a1c2020-03-17 21:04:24 +00002136 p.JarToExport = implementationJars[0]
2137 p.TestConfig = test.testConfig
Paul Duffin14eb4672020-03-02 11:33:02 +00002138}
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002139
Paul Duffin3a4eb502020-03-19 16:11:18 +00002140func (p *testSdkMemberProperties) AddToPropertySet(ctx android.SdkMemberContext, propertySet android.BpPropertySet) {
Paul Duffina551a1c2020-03-17 21:04:24 +00002141 builder := ctx.SnapshotBuilder()
Paul Duffin3a4eb502020-03-19 16:11:18 +00002142
Paul Duffina551a1c2020-03-17 21:04:24 +00002143 exportedJar := p.JarToExport
2144 if exportedJar != nil {
2145 snapshotRelativeJavaLibPath := sdkSnapshotFilePathForJar(p.OsPrefix(), ctx.Name())
2146 builder.CopyToSnapshot(exportedJar, snapshotRelativeJavaLibPath)
Paul Duffin14eb4672020-03-02 11:33:02 +00002147
2148 propertySet.AddProperty("jars", []string{snapshotRelativeJavaLibPath})
Paul Duffina551a1c2020-03-17 21:04:24 +00002149 }
2150
2151 testConfig := p.TestConfig
2152 if testConfig != nil {
2153 snapshotRelativeTestConfigPath := sdkSnapshotFilePathForMember(p.OsPrefix(), ctx.Name(), testConfigSuffix)
2154 builder.CopyToSnapshot(testConfig, snapshotRelativeTestConfigPath)
Paul Duffin14eb4672020-03-02 11:33:02 +00002155 propertySet.AddProperty("test_config", snapshotRelativeTestConfigPath)
2156 }
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002157}
2158
Colin Cross1b16b0e2019-02-12 14:41:32 -08002159// java_test builds a and links sources into a `.jar` file for the device, and possibly for the host as well, and
2160// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
2161//
2162// By default, a java_test has a single variant that produces a `.jar` file containing `classes.dex` files that were
2163// compiled against the device bootclasspath.
2164//
2165// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2166// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002167func TestFactory() android.Module {
2168 module := &Test{}
2169
2170 module.AddProperties(
2171 &module.Module.properties,
2172 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002173 &module.Module.dexpreoptProperties,
Colin Cross05638fc2018-04-09 18:40:24 -07002174 &module.Module.protoProperties,
2175 &module.testProperties)
2176
Colin Cross9ae1b922018-06-26 17:59:05 -07002177 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse3026872019-01-05 22:30:13 -08002178 module.Module.dexpreopter.isTest = true
Colin Cross9ae1b922018-06-26 17:59:05 -07002179
Colin Cross05638fc2018-04-09 18:40:24 -07002180 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002181 return module
2182}
2183
Paul Duffin42df1442019-03-20 12:45:53 +00002184// java_test_helper_library creates a java library and makes sure that it is added to the appropriate test suite.
2185func TestHelperLibraryFactory() android.Module {
2186 module := &TestHelperLibrary{}
2187
2188 module.AddProperties(
2189 &module.Module.properties,
2190 &module.Module.deviceProperties,
2191 &module.Module.dexpreoptProperties,
2192 &module.Module.protoProperties,
2193 &module.testHelperLibraryProperties)
2194
Colin Cross9a4abed2019-04-24 13:19:28 -07002195 module.Module.properties.Installable = proptools.BoolPtr(true)
2196 module.Module.dexpreopter.isTest = true
2197
Paul Duffin42df1442019-03-20 12:45:53 +00002198 InitJavaModule(module, android.HostAndDeviceSupported)
2199 return module
2200}
2201
Paul Duffin1b82e6a2019-12-03 18:06:47 +00002202// java_test_import imports one or more `.jar` files into the build graph as if they were built by a java_test module
2203// and makes sure that it is added to the appropriate test suite.
2204//
2205// By default, a java_test_import has a single variant that expects a `.jar` file containing `.class` files that were
2206// compiled against an Android classpath.
2207//
2208// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2209// for host modules.
2210func JavaTestImportFactory() android.Module {
2211 module := &JavaTestImport{}
2212
2213 module.AddProperties(
2214 &module.Import.properties,
2215 &module.prebuiltTestProperties)
2216
2217 module.Import.properties.Installable = proptools.BoolPtr(true)
2218
2219 android.InitPrebuiltModule(module, &module.properties.Jars)
2220 android.InitApexModule(module)
2221 android.InitSdkAwareModule(module)
2222 InitJavaModule(module, android.HostAndDeviceSupported)
2223 return module
2224}
2225
Colin Cross1b16b0e2019-02-12 14:41:32 -08002226// java_test_host builds a and links sources into a `.jar` file for the host, and creates an `AndroidTest.xml` file to
2227// allow running the test with `atest` or a `TEST_MAPPING` file.
2228//
2229// A java_test_host has a single variant that produces a `.jar` file containing `.class` files that were
2230// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07002231func TestHostFactory() android.Module {
2232 module := &Test{}
2233
2234 module.AddProperties(
2235 &module.Module.properties,
2236 &module.Module.protoProperties,
2237 &module.testProperties)
2238
Colin Cross9ae1b922018-06-26 17:59:05 -07002239 module.Module.properties.Installable = proptools.BoolPtr(true)
2240
Colin Cross05638fc2018-04-09 18:40:24 -07002241 InitJavaModule(module, android.HostSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07002242 return module
2243}
2244
2245//
Colin Cross2fe66872015-03-30 17:20:39 -07002246// Java Binaries (.jar file plus wrapper script)
2247//
2248
Colin Crossf506d872017-07-19 15:53:04 -07002249type binaryProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -07002250 // installable script to execute the resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -08002251 Wrapper *string `android:"path"`
Colin Cross094054a2018-10-17 15:10:48 -07002252
2253 // Name of the class containing main to be inserted into the manifest as Main-Class.
2254 Main_class *string
Colin Cross7d5136f2015-05-11 13:39:40 -07002255}
2256
Colin Crossf506d872017-07-19 15:53:04 -07002257type Binary struct {
2258 Library
Colin Cross2fe66872015-03-30 17:20:39 -07002259
Colin Crossf506d872017-07-19 15:53:04 -07002260 binaryProperties binaryProperties
Colin Cross10a03492017-08-10 17:09:43 -07002261
Colin Cross6b4a32d2017-12-05 13:42:45 -08002262 isWrapperVariant bool
2263
Colin Crossc3315992017-12-08 19:12:36 -08002264 wrapperFile android.Path
Colin Cross70dda7e2019-10-01 22:05:35 -07002265 binaryFile android.InstallPath
Colin Cross2fe66872015-03-30 17:20:39 -07002266}
2267
Alex Light24237172017-10-26 09:46:21 -07002268func (j *Binary) HostToolPath() android.OptionalPath {
2269 return android.OptionalPathForPath(j.binaryFile)
2270}
2271
Colin Crossf506d872017-07-19 15:53:04 -07002272func (j *Binary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002273 if ctx.Arch().ArchType == android.Common {
2274 // Compile the jar
Colin Cross094054a2018-10-17 15:10:48 -07002275 if j.binaryProperties.Main_class != nil {
2276 if j.properties.Manifest != nil {
2277 ctx.PropertyErrorf("main_class", "main_class cannot be used when manifest is set")
2278 }
2279 manifestFile := android.PathForModuleOut(ctx, "manifest.txt")
2280 GenerateMainClassManifest(ctx, manifestFile, String(j.binaryProperties.Main_class))
2281 j.overrideManifest = android.OptionalPathForPath(manifestFile)
2282 }
2283
Colin Cross6b4a32d2017-12-05 13:42:45 -08002284 j.Library.GenerateAndroidBuildActions(ctx)
Nan Zhang3c807db2017-11-03 14:53:31 -07002285 } else {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002286 // Handle the binary wrapper
2287 j.isWrapperVariant = true
2288
Colin Cross366938f2017-12-11 16:29:02 -08002289 if j.binaryProperties.Wrapper != nil {
Colin Cross8a497952019-03-05 22:25:09 -08002290 j.wrapperFile = android.PathForModuleSrc(ctx, *j.binaryProperties.Wrapper)
Colin Cross6b4a32d2017-12-05 13:42:45 -08002291 } else {
2292 j.wrapperFile = android.PathForSource(ctx, "build/soong/scripts/jar-wrapper.sh")
2293 }
2294
2295 // Depend on the installed jar so that the wrapper doesn't get executed by
2296 // another build rule before the jar has been installed.
2297 jarFile := ctx.PrimaryModule().(*Binary).installFile
2298
2299 j.binaryFile = ctx.InstallExecutable(android.PathForModuleInstall(ctx, "bin"),
2300 ctx.ModuleName(), j.wrapperFile, jarFile)
Nan Zhang3c807db2017-11-03 14:53:31 -07002301 }
Colin Cross2fe66872015-03-30 17:20:39 -07002302}
2303
Colin Crossf506d872017-07-19 15:53:04 -07002304func (j *Binary) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08002305 if ctx.Arch().ArchType == android.Common {
2306 j.deps(ctx)
2307 }
Colin Cross46c9b8b2017-06-22 16:51:17 -07002308}
2309
Colin Cross1b16b0e2019-02-12 14:41:32 -08002310// java_binary builds a `.jar` file and a shell script that executes it for the device, and possibly for the host
2311// as well.
2312//
2313// By default, a java_binary has a single variant that produces a `.jar` file containing `classes.dex` files that were
2314// compiled against the device bootclasspath.
2315//
2316// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
2317// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002318func BinaryFactory() android.Module {
2319 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002320
Colin Cross36242852017-06-23 15:06:31 -07002321 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07002322 &module.Module.properties,
2323 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08002324 &module.Module.dexpreoptProperties,
Colin Cross6af17aa2017-09-20 12:59:05 -07002325 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07002326 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002327
Colin Cross9ae1b922018-06-26 17:59:05 -07002328 module.Module.properties.Installable = proptools.BoolPtr(true)
2329
Colin Cross6b4a32d2017-12-05 13:42:45 -08002330 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibCommonFirst)
2331 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002332 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002333}
2334
Colin Cross1b16b0e2019-02-12 14:41:32 -08002335// java_binary_host builds a `.jar` file and a shell script that executes it for the host.
2336//
2337// A java_binary_host has a single variant that produces a `.jar` file containing `.class` files that were
2338// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07002339func BinaryHostFactory() android.Module {
2340 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07002341
Colin Cross36242852017-06-23 15:06:31 -07002342 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07002343 &module.Module.properties,
Colin Cross6af17aa2017-09-20 12:59:05 -07002344 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07002345 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07002346
Colin Cross9ae1b922018-06-26 17:59:05 -07002347 module.Module.properties.Installable = proptools.BoolPtr(true)
2348
Colin Cross6b4a32d2017-12-05 13:42:45 -08002349 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommonFirst)
2350 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07002351 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002352}
2353
2354//
2355// Java prebuilts
2356//
2357
Colin Cross74d73e22017-08-02 11:05:49 -07002358type ImportProperties struct {
Paul Duffina04c1072020-03-02 10:16:35 +00002359 Jars []string `android:"path,arch_variant"`
Colin Cross461bd1a2017-10-20 13:59:18 -07002360
Nan Zhangea568a42017-11-08 21:20:04 -08002361 Sdk_version *string
Colin Cross535e2cf2017-10-20 17:57:49 -07002362
2363 Installable *bool
Jiyong Park1be96912018-05-28 18:02:19 +09002364
2365 // List of shared java libs that this module has dependencies to
2366 Libs []string
Colin Cross37f6d792018-07-12 12:28:41 -07002367
2368 // List of files to remove from the jar file(s)
2369 Exclude_files []string
2370
2371 // List of directories to remove from the jar file(s)
2372 Exclude_dirs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -07002373
2374 // if set to true, run Jetifier against .jar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -07002375 Jetifier *bool
Jiyong Park4c4c0242019-10-21 14:53:15 +09002376
2377 // set the name of the output
2378 Stem *string
Jiyong Park19604de2020-03-24 16:44:11 +09002379
2380 Aidl struct {
2381 // directories that should be added as include directories for any aidl sources of modules
2382 // that depend on this module, as well as to aidl for this module.
2383 Export_include_dirs []string
2384 }
Colin Cross74d73e22017-08-02 11:05:49 -07002385}
2386
2387type Import struct {
Colin Cross635c3b02016-05-18 15:37:25 -07002388 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -07002389 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002390 android.ApexModuleBase
Colin Crossec7a0422017-07-07 14:47:12 -07002391 prebuilt android.Prebuilt
Jiyong Parkd1063c12019-07-17 20:08:41 +09002392 android.SdkBase
Colin Cross2fe66872015-03-30 17:20:39 -07002393
Colin Cross74d73e22017-08-02 11:05:49 -07002394 properties ImportProperties
2395
Colin Cross0a6e0072017-08-30 14:24:55 -07002396 combinedClasspathFile android.Path
Jiyong Park1be96912018-05-28 18:02:19 +09002397 exportedSdkLibs []string
Jiyong Park19604de2020-03-24 16:44:11 +09002398 exportAidlIncludeDirs android.Paths
Colin Cross2fe66872015-03-30 17:20:39 -07002399}
2400
Jiyong Park6a927c42020-01-21 02:03:43 +09002401func (j *Import) sdkVersion() sdkSpec {
2402 return sdkSpecFrom(String(j.properties.Sdk_version))
Colin Cross83bb3162018-06-25 15:48:06 -07002403}
2404
Jiyong Park6a927c42020-01-21 02:03:43 +09002405func (j *Import) minSdkVersion() sdkSpec {
Colin Cross83bb3162018-06-25 15:48:06 -07002406 return j.sdkVersion()
2407}
2408
Artur Satayev480e25b2020-04-27 18:53:18 +01002409func (j *Import) MinSdkVersion() string {
2410 return j.minSdkVersion().version.String()
2411}
2412
Colin Cross74d73e22017-08-02 11:05:49 -07002413func (j *Import) Prebuilt() *android.Prebuilt {
Colin Crossec7a0422017-07-07 14:47:12 -07002414 return &j.prebuilt
2415}
2416
Colin Cross74d73e22017-08-02 11:05:49 -07002417func (j *Import) PrebuiltSrcs() []string {
2418 return j.properties.Jars
2419}
2420
2421func (j *Import) Name() string {
Colin Cross5ea9bcc2017-07-27 15:41:32 -07002422 return j.prebuilt.Name(j.ModuleBase.Name())
2423}
2424
Jiyong Park0b238752019-10-29 11:23:10 +09002425func (j *Import) Stem() string {
2426 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2427}
2428
Jiyong Park618922e2020-01-08 13:35:43 +09002429func (a *Import) JacocoReportClassesFile() android.Path {
2430 return nil
2431}
2432
Colin Cross74d73e22017-08-02 11:05:49 -07002433func (j *Import) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross42d48b72018-08-29 14:10:52 -07002434 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Colin Cross1e676be2016-10-12 14:38:15 -07002435}
2436
Colin Cross74d73e22017-08-02 11:05:49 -07002437func (j *Import) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross8a497952019-03-05 22:25:09 -08002438 jars := android.PathsForModuleSrc(ctx, j.properties.Jars)
Colin Crosse1d62a82015-04-03 16:53:05 -07002439
Jiyong Park0b238752019-10-29 11:23:10 +09002440 jarName := j.Stem() + ".jar"
Nan Zhang4c819fb2018-08-27 18:31:46 -07002441 outputFile := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07002442 TransformJarsToJar(ctx, outputFile, "for prebuilts", jars, android.OptionalPath{},
2443 false, j.properties.Exclude_files, j.properties.Exclude_dirs)
Colin Cross1001a792019-03-21 22:21:39 -07002444 if Bool(j.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -07002445 inputFile := outputFile
2446 outputFile = android.PathForModuleOut(ctx, "jetifier", jarName)
2447 TransformJetifier(ctx, outputFile, inputFile)
2448 }
Colin Crosse9a275b2017-10-16 17:09:48 -07002449 j.combinedClasspathFile = outputFile
Jiyong Park1be96912018-05-28 18:02:19 +09002450
2451 ctx.VisitDirectDeps(func(module android.Module) {
2452 otherName := ctx.OtherModuleName(module)
2453 tag := ctx.OtherModuleDependencyTag(module)
2454
2455 switch dep := module.(type) {
2456 case Dependency:
2457 switch tag {
2458 case libTag, staticLibTag:
2459 // sdk lib names from dependencies are re-exported
2460 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
2461 }
2462 case SdkLibraryDependency:
2463 switch tag {
2464 case libTag:
2465 // names of sdk libs that are directly depended are exported
2466 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
2467 }
2468 }
2469 })
2470
2471 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002472 if Bool(j.properties.Installable) {
2473 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
Jiyong Park4c4c0242019-10-21 14:53:15 +09002474 jarName, outputFile)
Nan Zhang4973ecf2018-08-10 13:42:12 -07002475 }
Jiyong Park19604de2020-03-24 16:44:11 +09002476
2477 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.properties.Aidl.Export_include_dirs)
Colin Cross2fe66872015-03-30 17:20:39 -07002478}
2479
Colin Cross74d73e22017-08-02 11:05:49 -07002480var _ Dependency = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002481
Nan Zhanged19fc32017-10-19 13:06:22 -07002482func (j *Import) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002483 if j.combinedClasspathFile == nil {
2484 return nil
2485 }
Colin Cross37f6d792018-07-12 12:28:41 -07002486 return android.Paths{j.combinedClasspathFile}
Nan Zhanged19fc32017-10-19 13:06:22 -07002487}
2488
2489func (j *Import) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08002490 if j.combinedClasspathFile == nil {
2491 return nil
2492 }
Colin Cross37f6d792018-07-12 12:28:41 -07002493 return android.Paths{j.combinedClasspathFile}
Colin Cross2fe66872015-03-30 17:20:39 -07002494}
2495
Colin Cross331a1212018-08-15 20:40:52 -07002496func (j *Import) ResourceJars() android.Paths {
2497 return nil
2498}
2499
2500func (j *Import) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08002501 if j.combinedClasspathFile == nil {
2502 return nil
2503 }
Colin Cross331a1212018-08-15 20:40:52 -07002504 return android.Paths{j.combinedClasspathFile}
2505}
2506
Colin Crossf24a22a2019-01-31 14:12:44 -08002507func (j *Import) DexJar() android.Path {
2508 return nil
2509}
2510
Colin Cross74d73e22017-08-02 11:05:49 -07002511func (j *Import) AidlIncludeDirs() android.Paths {
Jiyong Park19604de2020-03-24 16:44:11 +09002512 return j.exportAidlIncludeDirs
Colin Crossc0b06f12015-04-08 13:03:43 -07002513}
2514
Jiyong Park1be96912018-05-28 18:02:19 +09002515func (j *Import) ExportedSdkLibs() []string {
2516 return j.exportedSdkLibs
2517}
2518
Artur Satayev9cf46692019-11-26 18:08:34 +00002519func (j *Import) ExportedPlugins() (android.Paths, []string) {
2520 return nil, nil
2521}
2522
Colin Cross0c4ce212019-05-03 15:28:19 -07002523func (j *Import) SrcJarArgs() ([]string, android.Paths) {
2524 return nil, nil
2525}
2526
Jiyong Park0f80c182020-01-31 02:49:53 +09002527func (j *Import) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
Jiyong Park0f80c182020-01-31 02:49:53 +09002528 // dependencies other than the static linkage are all considered crossing APEX boundary
Jooyung Han5e9013b2020-03-10 06:23:13 +09002529 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
2530 return true
2531 }
Jooyung Han5e9013b2020-03-10 06:23:13 +09002532 return false
Jiyong Park0f80c182020-01-31 02:49:53 +09002533}
2534
albaltai36ff7dc2018-12-25 14:35:23 +08002535// Add compile time check for interface implementation
2536var _ android.IDEInfo = (*Import)(nil)
2537var _ android.IDECustomizedModuleName = (*Import)(nil)
2538
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002539// Collect information for opening IDE project files in java/jdeps.go.
2540const (
2541 removedPrefix = "prebuilt_"
2542)
2543
2544func (j *Import) IDEInfo(dpInfo *android.IdeInfo) {
2545 dpInfo.Jars = append(dpInfo.Jars, j.PrebuiltSrcs()...)
2546}
2547
2548func (j *Import) IDECustomizedModuleName() string {
2549 // TODO(b/113562217): Extract the base module name from the Import name, often the Import name
2550 // has a prefix "prebuilt_". Remove the prefix explicitly if needed until we find a better
2551 // solution to get the Import name.
2552 name := j.Name()
2553 if strings.HasPrefix(name, removedPrefix) {
patricktubb640e02018-10-11 18:33:16 +08002554 name = strings.TrimPrefix(name, removedPrefix)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07002555 }
2556 return name
2557}
2558
Colin Cross74d73e22017-08-02 11:05:49 -07002559var _ android.PrebuiltInterface = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002560
Colin Cross1b16b0e2019-02-12 14:41:32 -08002561// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library module.
2562//
2563// By default, a java_import has a single variant that expects a `.jar` file containing `.class` files that were
2564// compiled against an Android classpath.
2565//
2566// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2567// for host modules.
Colin Cross74d73e22017-08-02 11:05:49 -07002568func ImportFactory() android.Module {
2569 module := &Import{}
Colin Cross36242852017-06-23 15:06:31 -07002570
Colin Cross74d73e22017-08-02 11:05:49 -07002571 module.AddProperties(&module.properties)
2572
2573 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002574 android.InitApexModule(module)
Jiyong Parkd1063c12019-07-17 20:08:41 +09002575 android.InitSdkAwareModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002576 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross36242852017-06-23 15:06:31 -07002577 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002578}
2579
Colin Cross1b16b0e2019-02-12 14:41:32 -08002580// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library_host
2581// module.
2582//
2583// A java_import_host has a single variant that expects a `.jar` file containing `.class` files that were
2584// compiled against a host bootclasspath.
Colin Cross74d73e22017-08-02 11:05:49 -07002585func ImportFactoryHost() android.Module {
2586 module := &Import{}
2587
2588 module.AddProperties(&module.properties)
2589
2590 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002591 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002592 InitJavaModule(module, android.HostSupported)
Colin Cross74d73e22017-08-02 11:05:49 -07002593 return module
2594}
2595
Colin Cross42be7612019-02-21 18:12:14 -08002596// dex_import module
2597
2598type DexImportProperties struct {
Colin Cross5cfc70d2019-07-15 13:36:55 -07002599 Jars []string `android:"path"`
Jiyong Park4c4c0242019-10-21 14:53:15 +09002600
2601 // set the name of the output
2602 Stem *string
Colin Cross42be7612019-02-21 18:12:14 -08002603}
2604
2605type DexImport struct {
2606 android.ModuleBase
2607 android.DefaultableModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002608 android.ApexModuleBase
Colin Cross42be7612019-02-21 18:12:14 -08002609 prebuilt android.Prebuilt
2610
2611 properties DexImportProperties
2612
2613 dexJarFile android.Path
2614 maybeStrippedDexJarFile android.Path
2615
2616 dexpreopter
2617}
2618
2619func (j *DexImport) Prebuilt() *android.Prebuilt {
2620 return &j.prebuilt
2621}
2622
2623func (j *DexImport) PrebuiltSrcs() []string {
2624 return j.properties.Jars
2625}
2626
2627func (j *DexImport) Name() string {
2628 return j.prebuilt.Name(j.ModuleBase.Name())
2629}
2630
Jiyong Park0b238752019-10-29 11:23:10 +09002631func (j *DexImport) Stem() string {
2632 return proptools.StringDefault(j.properties.Stem, j.ModuleBase.Name())
2633}
2634
Martin Stjernholm6d415272020-01-31 17:10:36 +00002635func (j *DexImport) IsInstallable() bool {
2636 return true
2637}
2638
Colin Cross42be7612019-02-21 18:12:14 -08002639func (j *DexImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2640 if len(j.properties.Jars) != 1 {
2641 ctx.PropertyErrorf("jars", "exactly one jar must be provided")
2642 }
2643
Jiyong Park0b238752019-10-29 11:23:10 +09002644 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", j.Stem()+".jar")
Colin Cross42be7612019-02-21 18:12:14 -08002645 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
2646
2647 inputJar := ctx.ExpandSource(j.properties.Jars[0], "jars")
2648 dexOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar")
2649
2650 if j.dexpreopter.uncompressedDex {
2651 rule := android.NewRuleBuilder()
2652
2653 temporary := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar.unaligned")
2654 rule.Temporary(temporary)
2655
2656 // use zip2zip to uncompress classes*.dex files
2657 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002658 BuiltTool(ctx, "zip2zip").
Colin Cross42be7612019-02-21 18:12:14 -08002659 FlagWithInput("-i ", inputJar).
2660 FlagWithOutput("-o ", temporary).
2661 FlagWithArg("-0 ", "'classes*.dex'")
2662
2663 // use zipalign to align uncompressed classes*.dex files
2664 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002665 BuiltTool(ctx, "zipalign").
Colin Cross42be7612019-02-21 18:12:14 -08002666 Flag("-f").
2667 Text("4").
2668 Input(temporary).
2669 Output(dexOutputFile)
2670
2671 rule.DeleteTemporaryFiles()
2672
2673 rule.Build(pctx, ctx, "uncompress_dex", "uncompress dex")
2674 } else {
2675 ctx.Build(pctx, android.BuildParams{
2676 Rule: android.Cp,
2677 Input: inputJar,
2678 Output: dexOutputFile,
2679 })
2680 }
2681
2682 j.dexJarFile = dexOutputFile
2683
2684 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
2685
2686 j.maybeStrippedDexJarFile = dexOutputFile
2687
2688 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
2689 ctx.ModuleName()+".jar", dexOutputFile)
2690}
2691
2692func (j *DexImport) DexJar() android.Path {
2693 return j.dexJarFile
2694}
2695
2696// dex_import imports a `.jar` file containing classes.dex files.
2697//
2698// A dex_import module cannot be used as a dependency of a java_* or android_* module, it can only be installed
2699// to the device.
2700func DexImportFactory() android.Module {
2701 module := &DexImport{}
2702
2703 module.AddProperties(&module.properties)
2704
2705 android.InitPrebuiltModule(module, &module.properties.Jars)
Jiyong Park7f7766d2019-07-25 22:02:35 +09002706 android.InitApexModule(module)
Jooyung Han18020ea2019-11-13 10:50:48 +09002707 InitJavaModule(module, android.DeviceSupported)
Colin Cross42be7612019-02-21 18:12:14 -08002708 return module
2709}
2710
Colin Cross89536d42017-07-07 14:35:50 -07002711//
2712// Defaults
2713//
2714type Defaults struct {
2715 android.ModuleBase
2716 android.DefaultsModuleBase
Jiyong Park7f7766d2019-07-25 22:02:35 +09002717 android.ApexModuleBase
Colin Cross89536d42017-07-07 14:35:50 -07002718}
2719
Colin Cross1b16b0e2019-02-12 14:41:32 -08002720// java_defaults provides a set of properties that can be inherited by other java or android modules.
2721//
2722// A module can use the properties from a java_defaults module using `defaults: ["defaults_module_name"]`. Each
2723// property in the defaults module that exists in the depending module will be prepended to the depending module's
2724// value for that property.
2725//
2726// Example:
2727//
2728// java_defaults {
2729// name: "example_defaults",
2730// srcs: ["common/**/*.java"],
2731// javacflags: ["-Xlint:all"],
2732// aaptflags: ["--auto-add-overlay"],
2733// }
2734//
2735// java_library {
2736// name: "example",
2737// defaults: ["example_defaults"],
2738// srcs: ["example/**/*.java"],
2739// }
2740//
2741// is functionally identical to:
2742//
2743// java_library {
2744// name: "example",
2745// srcs: [
2746// "common/**/*.java",
2747// "example/**/*.java",
2748// ],
2749// javacflags: ["-Xlint:all"],
2750// }
Colin Cross89536d42017-07-07 14:35:50 -07002751func defaultsFactory() android.Module {
2752 return DefaultsFactory()
2753}
2754
Paul Duffin47357662019-12-05 14:07:14 +00002755func DefaultsFactory() android.Module {
Colin Cross89536d42017-07-07 14:35:50 -07002756 module := &Defaults{}
2757
Colin Cross89536d42017-07-07 14:35:50 -07002758 module.AddProperties(
2759 &CompilerProperties{},
2760 &CompilerDeviceProperties{},
Colin Cross43f08db2018-11-12 10:13:39 -08002761 &DexpreoptProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08002762 &android.ProtoProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002763 &aaptProperties{},
2764 &androidLibraryProperties{},
2765 &appProperties{},
2766 &appTestProperties{},
Jaewoong Jung525443a2019-02-28 15:35:54 -08002767 &overridableAppProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002768 &ImportProperties{},
2769 &AARImportProperties{},
2770 &sdkLibraryProperties{},
Colin Cross42be7612019-02-21 18:12:14 -08002771 &DexImportProperties{},
Jooyung Han18020ea2019-11-13 10:50:48 +09002772 &android.ApexProperties{},
Jaewoong Jungbf135462020-04-26 15:10:51 -07002773 &RuntimeResourceOverlayProperties{},
Colin Cross89536d42017-07-07 14:35:50 -07002774 )
2775
2776 android.InitDefaultsModule(module)
Colin Cross89536d42017-07-07 14:35:50 -07002777 return module
2778}
Nan Zhangea568a42017-11-08 21:20:04 -08002779
Sasha Smundak2a4549e2018-11-05 16:49:08 -08002780func kytheExtractJavaFactory() android.Singleton {
2781 return &kytheExtractJavaSingleton{}
2782}
2783
2784type kytheExtractJavaSingleton struct {
2785}
2786
2787func (ks *kytheExtractJavaSingleton) GenerateBuildActions(ctx android.SingletonContext) {
2788 var xrefTargets android.Paths
2789 ctx.VisitAllModules(func(module android.Module) {
2790 if javaModule, ok := module.(xref); ok {
2791 xrefTargets = append(xrefTargets, javaModule.XrefJavaFiles()...)
2792 }
2793 })
2794 // TODO(asmundak): perhaps emit a rule to output a warning if there were no xrefTargets
2795 if len(xrefTargets) > 0 {
2796 ctx.Build(pctx, android.BuildParams{
2797 Rule: blueprint.Phony,
2798 Output: android.PathForPhony(ctx, "xref_java"),
2799 Inputs: xrefTargets,
2800 })
2801 }
2802}
2803
Nan Zhangea568a42017-11-08 21:20:04 -08002804var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07002805var BoolDefault = proptools.BoolDefault
Nan Zhangea568a42017-11-08 21:20:04 -08002806var String = proptools.String
Colin Cross0d0ba592018-02-20 13:33:42 -08002807var inList = android.InList