blob: be0f4d2a56ba951c0fbf951c08d40fa346441b70 [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 Cross76b5f0c2017-08-29 16:02:06 -070028 "github.com/google/blueprint/proptools"
Colin Cross2fe66872015-03-30 17:20:39 -070029
Colin Cross635c3b02016-05-18 15:37:25 -070030 "android/soong/android"
Colin Cross3e3e72d2017-06-22 17:20:19 -070031 "android/soong/java/config"
Colin Cross303e21f2018-08-07 16:49:25 -070032 "android/soong/tradefed"
Colin Cross2fe66872015-03-30 17:20:39 -070033)
34
Colin Cross463a90e2015-06-17 14:20:06 -070035func init() {
Colin Cross89536d42017-07-07 14:35:50 -070036 android.RegisterModuleType("java_defaults", defaultsFactory)
37
Colin Cross9ae1b922018-06-26 17:59:05 -070038 android.RegisterModuleType("java_library", LibraryFactory)
Colin Cross1b16b0e2019-02-12 14:41:32 -080039 android.RegisterModuleType("java_library_static", LibraryStaticFactory)
Colin Crossf506d872017-07-19 15:53:04 -070040 android.RegisterModuleType("java_library_host", LibraryHostFactory)
41 android.RegisterModuleType("java_binary", BinaryFactory)
42 android.RegisterModuleType("java_binary_host", BinaryHostFactory)
Colin Cross05638fc2018-04-09 18:40:24 -070043 android.RegisterModuleType("java_test", TestFactory)
Paul Duffin42df1442019-03-20 12:45:53 +000044 android.RegisterModuleType("java_test_helper_library", TestHelperLibraryFactory)
Colin Cross05638fc2018-04-09 18:40:24 -070045 android.RegisterModuleType("java_test_host", TestHostFactory)
Colin Cross74d73e22017-08-02 11:05:49 -070046 android.RegisterModuleType("java_import", ImportFactory)
47 android.RegisterModuleType("java_import_host", ImportFactoryHost)
Colin Cross3d7c9822019-03-01 13:46:24 -080048 android.RegisterModuleType("java_device_for_host", DeviceForHostFactory)
49 android.RegisterModuleType("java_host_for_device", HostForDeviceFactory)
Colin Cross42be7612019-02-21 18:12:14 -080050 android.RegisterModuleType("dex_import", DexImportFactory)
Colin Cross463a90e2015-06-17 14:20:06 -070051
Colin Cross798bfce2016-10-12 14:28:16 -070052 android.RegisterSingletonType("logtags", LogtagsSingleton)
Colin Cross463a90e2015-06-17 14:20:06 -070053}
54
Colin Cross2fe66872015-03-30 17:20:39 -070055// TODO:
56// Autogenerated files:
Colin Cross2fe66872015-03-30 17:20:39 -070057// Renderscript
58// Post-jar passes:
59// Proguard
Colin Cross2fe66872015-03-30 17:20:39 -070060// Rmtypedefs
Colin Cross2fe66872015-03-30 17:20:39 -070061// DroidDoc
62// Findbugs
63
Colin Cross89536d42017-07-07 14:35:50 -070064type CompilerProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -070065 // list of source files used to compile the Java module. May be .java, .logtags, .proto,
66 // or .aidl files.
Colin Cross27b922f2019-03-04 22:35:41 -080067 Srcs []string `android:"path,arch_variant"`
Dan Willemsen2ef08f42015-06-30 18:15:24 -070068
69 // list of source files that should not be used to build the Java module.
70 // This is most useful in the arch/multilib variants to remove non-common files
Colin Cross27b922f2019-03-04 22:35:41 -080071 Exclude_srcs []string `android:"path,arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -070072
73 // list of directories containing Java resources
Colin Cross86a63ff2017-09-27 17:33:10 -070074 Java_resource_dirs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -070075
Colin Cross86a63ff2017-09-27 17:33:10 -070076 // list of directories that should be excluded from java_resource_dirs
77 Exclude_java_resource_dirs []string `android:"arch_variant"`
Dan Willemsen2ef08f42015-06-30 18:15:24 -070078
Colin Cross0f37af02017-09-27 17:42:05 -070079 // list of files to use as Java resources
Colin Cross27b922f2019-03-04 22:35:41 -080080 Java_resources []string `android:"path,arch_variant"`
Colin Cross0f37af02017-09-27 17:42:05 -070081
Colin Crosscedd4762018-09-13 11:26:19 -070082 // list of files that should be excluded from java_resources and java_resource_dirs
Colin Cross27b922f2019-03-04 22:35:41 -080083 Exclude_java_resources []string `android:"path,arch_variant"`
Colin Cross0f37af02017-09-27 17:42:05 -070084
Paul Duffin2fbbfb82019-02-13 12:49:33 +000085 // don't build against the default libraries (bootclasspath, ext, and framework for device
86 // targets)
Colin Cross76b5f0c2017-08-29 16:02:06 -070087 No_standard_libs *bool
Colin Cross7d5136f2015-05-11 13:39:40 -070088
Paul Duffin2fbbfb82019-02-13 12:49:33 +000089 // don't build against the framework libraries (ext, and framework for device targets)
Colin Crossfa5eb232017-10-01 20:33:03 -070090 No_framework_libs *bool
91
Colin Cross7d5136f2015-05-11 13:39:40 -070092 // list of module-specific flags that will be used for javac compiles
93 Javacflags []string `android:"arch_variant"`
94
Zoran Jovanovic8736ce22018-08-21 17:10:29 +020095 // list of module-specific flags that will be used for kotlinc compiles
96 Kotlincflags []string `android:"arch_variant"`
97
Colin Cross7d5136f2015-05-11 13:39:40 -070098 // list of of java libraries that will be in the classpath
Colin Crosse8dc34a2017-07-19 11:22:16 -070099 Libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700100
101 // list of java libraries that will be compiled into the resulting jar
Colin Crosse8dc34a2017-07-19 11:22:16 -0700102 Static_libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700103
104 // manifest file to be included in resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -0800105 Manifest *string `android:"path"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700106
Colin Cross540eff82017-06-22 17:01:52 -0700107 // if not blank, run jarjar using the specified rules file
Colin Cross27b922f2019-03-04 22:35:41 -0800108 Jarjar_rules *string `android:"path,arch_variant"`
Colin Cross64162712017-08-08 13:17:59 -0700109
110 // If not blank, set the java version passed to javac as -source and -target
111 Java_version *string
Colin Cross2c429dc2017-08-31 16:45:16 -0700112
Colin Cross9ae1b922018-06-26 17:59:05 -0700113 // If set to true, allow this module to be dexed and installed on devices. Has no
114 // effect on host modules, which are always considered installable.
Colin Cross2c429dc2017-08-31 16:45:16 -0700115 Installable *bool
Colin Cross32f676a2017-09-06 13:41:06 -0700116
Colin Cross0f37af02017-09-27 17:42:05 -0700117 // If set to true, include sources used to compile the module in to the final jar
118 Include_srcs *bool
119
Vladimir Marko0975ee02019-04-02 10:29:55 +0100120 // If not empty, classes are restricted to the specified packages and their sub-packages.
121 // This restriction is checked after applying jarjar rules and including static libs.
122 Permitted_packages []string
123
Colin Crossbe9cdb82019-01-21 21:37:16 -0800124 // List of modules to use as annotation processors
125 Plugins []string
Colin Cross1369cdb2017-09-29 17:58:17 -0700126
Nan Zhang61eaedb2017-11-02 13:28:15 -0700127 // The number of Java source entries each Javac instance can process
128 Javac_shard_size *int64
129
Nan Zhang5f8cb422018-02-06 10:34:32 -0800130 // Add host jdk tools.jar to bootclasspath
131 Use_tools_jar *bool
132
Colin Cross1369cdb2017-09-29 17:58:17 -0700133 Openjdk9 struct {
134 // List of source files that should only be used when passing -source 1.9
Colin Cross27b922f2019-03-04 22:35:41 -0800135 Srcs []string `android:"path"`
Colin Cross1369cdb2017-09-29 17:58:17 -0700136
137 // List of javac flags that should only be used when passing -source 1.9
138 Javacflags []string
139 }
Colin Crosscb933592017-11-22 13:49:43 -0800140
Colin Cross81440082018-08-15 20:21:55 -0700141 // When compiling language level 9+ .java code in packages that are part of
142 // a system module, patch_module names the module that your sources and
143 // dependencies should be patched into. The Android runtime currently
144 // doesn't implement the JEP 261 module system so this option is only
145 // supported at compile time. It should only be needed to compile tests in
146 // packages that exist in libcore and which are inconvenient to move
147 // elsewhere.
Tobias Thiererdda713d2018-09-19 16:16:19 +0100148 Patch_module *string `android:"arch_variant"`
Colin Cross81440082018-08-15 20:21:55 -0700149
Colin Crosscb933592017-11-22 13:49:43 -0800150 Jacoco struct {
151 // List of classes to include for instrumentation with jacoco to collect coverage
152 // information at runtime when building with coverage enabled. If unset defaults to all
153 // classes.
154 // Supports '*' as the last character of an entry in the list as a wildcard match.
155 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
156 // it matches classes in the package that have the class name as a prefix.
157 Include_filter []string
158
159 // List of classes to exclude from instrumentation with jacoco to collect coverage
160 // information at runtime when building with coverage enabled. Overrides classes selected
161 // by the include_filter property.
162 // Supports '*' as the last character of an entry in the list as a wildcard match.
163 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
164 // it matches classes in the package that have the class name as a prefix.
165 Exclude_filter []string
166 }
167
Andreas Gampef3e5b552018-01-22 21:27:21 -0800168 Errorprone struct {
169 // List of javac flags that should only be used when running errorprone.
170 Javacflags []string
171 }
172
Colin Cross0f2ee152017-12-14 15:22:43 -0800173 Proto struct {
174 // List of extra options that will be passed to the proto generator.
175 Output_params []string
176 }
177
Colin Crosscb933592017-11-22 13:49:43 -0800178 Instrument bool `blueprint:"mutated"`
Alex Light7f004a72019-02-21 13:27:37 -0800179
180 // List of files to include in the META-INF/services folder of the resulting jar.
Colin Cross27b922f2019-03-04 22:35:41 -0800181 Services []string `android:"path,arch_variant"`
Colin Cross540eff82017-06-22 17:01:52 -0700182}
183
Colin Cross89536d42017-07-07 14:35:50 -0700184type CompilerDeviceProperties struct {
Colin Cross540eff82017-06-22 17:01:52 -0700185 // list of module-specific flags that will be used for dex compiles
186 Dxflags []string `android:"arch_variant"`
187
Colin Cross83bb3162018-06-25 15:48:06 -0700188 // if not blank, set to the version of the sdk to compile against. Defaults to compiling against the current
189 // sdk if platform_apis is not set.
Nan Zhangea568a42017-11-08 21:20:04 -0800190 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700191
Colin Cross83bb3162018-06-25 15:48:06 -0700192 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
193 // Defaults to sdk_version if not set.
194 Min_sdk_version *string
195
Dan Willemsen419290a2018-10-31 15:28:47 -0700196 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
197 // Defaults to sdk_version if not set.
198 Target_sdk_version *string
199
Colin Cross6af2e492018-05-22 11:12:33 -0700200 // if true, compile against the platform APIs instead of an SDK.
201 Platform_apis *bool
202
Colin Crossebe1a512017-11-14 13:12:14 -0800203 Aidl struct {
204 // Top level directories to pass to aidl tool
205 Include_dirs []string
Colin Cross7d5136f2015-05-11 13:39:40 -0700206
Colin Crossebe1a512017-11-14 13:12:14 -0800207 // Directories rooted at the Android.bp file to pass to aidl tool
208 Local_include_dirs []string
209
210 // directories that should be added as include directories for any aidl sources of modules
211 // that depend on this module, as well as to aidl for this module.
212 Export_include_dirs []string
Martijn Coeneneab15642018-03-09 09:29:59 +0100213
214 // whether to generate traces (for systrace) for this interface
215 Generate_traces *bool
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100216
217 // whether to generate Binder#GetTransaction name method.
218 Generate_get_transaction_name *bool
Colin Crossebe1a512017-11-14 13:12:14 -0800219 }
Colin Cross92430102017-10-09 14:59:32 -0700220
221 // If true, export a copy of the module as a -hostdex module for host testing.
222 Hostdex *bool
Colin Cross1369cdb2017-09-29 17:58:17 -0700223
Colin Cross7f87f4f2019-04-24 13:41:45 -0700224 Target struct {
225 Hostdex struct {
226 // Additional required dependencies to add to -hostdex modules.
227 Required []string
228 }
229 }
230
David Brazdil17ef5632018-06-27 10:27:45 +0100231 // If set to true, compile dex regardless of installable. Defaults to false.
232 Compile_dex *bool
233
Colin Cross66dbc0b2017-12-28 12:23:20 -0800234 Optimize struct {
Colin Crossae5caf52018-05-22 11:11:52 -0700235 // If false, disable all optimization. Defaults to true for android_app and android_test
236 // modules, false for java_library and java_test modules.
Colin Cross66dbc0b2017-12-28 12:23:20 -0800237 Enabled *bool
Sasha Smundak2057f822019-04-16 17:16:58 -0700238 // True if the module containing this has it set by default.
239 EnabledByDefault bool `blueprint:"mutated"`
Colin Cross66dbc0b2017-12-28 12:23:20 -0800240
241 // If true, optimize for size by removing unused code. Defaults to true for apps,
242 // false for libraries and tests.
243 Shrink *bool
244
245 // If true, optimize bytecode. Defaults to false.
246 Optimize *bool
247
248 // If true, obfuscate bytecode. Defaults to false.
249 Obfuscate *bool
250
251 // If true, do not use the flag files generated by aapt that automatically keep
252 // classes referenced by the app manifest. Defaults to false.
253 No_aapt_flags *bool
254
255 // Flags to pass to proguard.
256 Proguard_flags []string
257
258 // Specifies the locations of files containing proguard flags.
Colin Cross27b922f2019-03-04 22:35:41 -0800259 Proguard_flags_files []string `android:"path"`
Colin Cross66dbc0b2017-12-28 12:23:20 -0800260 }
261
Colin Cross1369cdb2017-09-29 17:58:17 -0700262 // When targeting 1.9, override the modules to use with --system
263 System_modules *string
Colin Cross5a0dcd52018-10-05 14:20:06 -0700264
265 UncompressDex bool `blueprint:"mutated"`
Colin Cross43f08db2018-11-12 10:13:39 -0800266 IsSDKLibrary bool `blueprint:"mutated"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700267}
268
Sasha Smundak2057f822019-04-16 17:16:58 -0700269func (me *CompilerDeviceProperties) EffectiveOptimizeEnabled() bool {
270 return BoolDefault(me.Optimize.Enabled, me.Optimize.EnabledByDefault)
271}
272
Colin Cross46c9b8b2017-06-22 16:51:17 -0700273// Module contains the properties and members used by all java module types
274type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700275 android.ModuleBase
Colin Cross89536d42017-07-07 14:35:50 -0700276 android.DefaultableModuleBase
Colin Cross2fe66872015-03-30 17:20:39 -0700277
Colin Cross89536d42017-07-07 14:35:50 -0700278 properties CompilerProperties
Colin Cross6af17aa2017-09-20 12:59:05 -0700279 protoProperties android.ProtoProperties
Colin Cross89536d42017-07-07 14:35:50 -0700280 deviceProperties CompilerDeviceProperties
Colin Cross2fe66872015-03-30 17:20:39 -0700281
Colin Cross331a1212018-08-15 20:40:52 -0700282 // jar file containing header classes including static library dependencies, suitable for
283 // inserting into the bootclasspath/classpath of another compile
Nan Zhanged19fc32017-10-19 13:06:22 -0700284 headerJarFile android.Path
285
Colin Cross331a1212018-08-15 20:40:52 -0700286 // jar file containing implementation classes including static library dependencies but no
287 // resources
Nan Zhanged19fc32017-10-19 13:06:22 -0700288 implementationJarFile android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700289
Colin Cross331a1212018-08-15 20:40:52 -0700290 // jar file containing only resources including from static library dependencies
291 resourceJar android.Path
292
293 // jar file containing implementation classes and resources including static library
294 // dependencies
295 implementationAndResourcesJar android.Path
296
297 // output file containing classes.dex and resources
Colin Cross6ade34f2017-09-15 13:00:47 -0700298 dexJarFile android.Path
299
Colin Cross43f08db2018-11-12 10:13:39 -0800300 // output file that contains classes.dex if it should be in the output file
301 maybeStrippedDexJarFile android.Path
302
Colin Crosscb933592017-11-22 13:49:43 -0800303 // output file containing uninstrumented classes that will be instrumented by jacoco
304 jacocoReportClassesFile android.Path
305
Colin Cross66dbc0b2017-12-28 12:23:20 -0800306 // output file containing mapping of obfuscated names
307 proguardDictionary android.Path
308
Colin Cross331a1212018-08-15 20:40:52 -0700309 // output file of the module, which may be a classes jar or a dex jar
Colin Crosse560c4a2019-03-19 16:03:11 -0700310 outputFile android.Path
311 extraOutputFiles android.Paths
Colin Crossb7a63242015-04-16 14:09:14 -0700312
Colin Cross635c3b02016-05-18 15:37:25 -0700313 exportAidlIncludeDirs android.Paths
Colin Crossc0b06f12015-04-08 13:03:43 -0700314
Colin Cross635c3b02016-05-18 15:37:25 -0700315 logtagsSrcs android.Paths
Colin Crossf05fe972015-04-10 17:45:20 -0700316
Colin Cross2fe66872015-03-30 17:20:39 -0700317 // installed file for binary dependency
Colin Cross635c3b02016-05-18 15:37:25 -0700318 installFile android.Path
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800319
320 // list of .java files and srcjars that was passed to javac
321 compiledJavaSrcs android.Paths
322 compiledSrcJars android.Paths
Colin Cross66dbc0b2017-12-28 12:23:20 -0800323
324 // list of extra progurad flag files
325 extraProguardFlagFiles android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900326
Colin Cross094054a2018-10-17 15:10:48 -0700327 // manifest file to use instead of properties.Manifest
328 overrideManifest android.OptionalPath
329
Jiyong Park1be96912018-05-28 18:02:19 +0900330 // list of SDK lib names that this java moudule is exporting
331 exportedSdkLibs []string
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700332
333 // list of source files, collected from compiledJavaSrcs and compiledSrcJars
334 // filter out Exclude_srcs, will be used by android.IDEInfo struct
335 expandIDEInfoCompiledSrcs []string
Colin Cross43f08db2018-11-12 10:13:39 -0800336
Steven Morelandc4efd9c2019-01-18 11:51:25 -0800337 // expanded Jarjar_rules
338 expandJarjarRules android.Path
339
Vladimir Marko0975ee02019-04-02 10:29:55 +0100340 // list of additional targets for checkbuild
341 additionalCheckedModules android.Paths
342
Colin Crossf24a22a2019-01-31 14:12:44 -0800343 hiddenAPI
Colin Cross43f08db2018-11-12 10:13:39 -0800344 dexpreopter
Colin Cross2fe66872015-03-30 17:20:39 -0700345}
346
Colin Cross54250902017-12-05 09:28:08 -0800347func (j *Module) Srcs() android.Paths {
Colin Crosse560c4a2019-03-19 16:03:11 -0700348 return append(android.Paths{j.outputFile}, j.extraOutputFiles...)
Colin Cross54250902017-12-05 09:28:08 -0800349}
350
Jiyong Park8fd61922018-11-08 02:50:25 +0900351func (j *Module) DexJarFile() android.Path {
352 return j.dexJarFile
353}
354
Colin Cross54250902017-12-05 09:28:08 -0800355var _ android.SourceFileProducer = (*Module)(nil)
356
Colin Crossf506d872017-07-19 15:53:04 -0700357type Dependency interface {
Nan Zhanged19fc32017-10-19 13:06:22 -0700358 HeaderJars() android.Paths
359 ImplementationJars() android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700360 ResourceJars() android.Paths
361 ImplementationAndResourcesJars() android.Paths
Colin Crossf24a22a2019-01-31 14:12:44 -0800362 DexJar() android.Path
Colin Cross635c3b02016-05-18 15:37:25 -0700363 AidlIncludeDirs() android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900364 ExportedSdkLibs() []string
Colin Cross2fe66872015-03-30 17:20:39 -0700365}
366
Jiyong Parkc678ad32018-04-10 13:07:10 +0900367type SdkLibraryDependency interface {
Colin Cross897d2ed2019-02-11 14:03:51 -0800368 SdkHeaderJars(ctx android.BaseContext, sdkVersion string) android.Paths
369 SdkImplementationJars(ctx android.BaseContext, sdkVersion string) android.Paths
Jiyong Parkc678ad32018-04-10 13:07:10 +0900370}
371
Nan Zhangb2b33de2018-02-23 11:18:47 -0800372type SrcDependency interface {
373 CompiledSrcs() android.Paths
374 CompiledSrcJars() android.Paths
375}
376
377func (j *Module) CompiledSrcs() android.Paths {
378 return j.compiledJavaSrcs
379}
380
381func (j *Module) CompiledSrcJars() android.Paths {
382 return j.compiledSrcJars
383}
384
385var _ SrcDependency = (*Module)(nil)
386
Colin Cross89536d42017-07-07 14:35:50 -0700387func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
388 android.InitAndroidArchModule(module, hod, android.MultilibCommon)
389 android.InitDefaultableModule(module)
390}
391
Colin Crossbe1da472017-07-07 15:59:46 -0700392type dependencyTag struct {
393 blueprint.BaseDependencyTag
394 name string
Colin Cross2fe66872015-03-30 17:20:39 -0700395}
396
Colin Crossa4f08812018-10-02 22:03:40 -0700397type jniDependencyTag struct {
398 blueprint.BaseDependencyTag
399 target android.Target
400}
401
Colin Crossbe1da472017-07-07 15:59:46 -0700402var (
Colin Cross4b964c02018-10-15 16:18:06 -0700403 staticLibTag = dependencyTag{name: "staticlib"}
404 libTag = dependencyTag{name: "javalib"}
Colin Crossbe9cdb82019-01-21 21:37:16 -0800405 pluginTag = dependencyTag{name: "plugin"}
Colin Cross4b964c02018-10-15 16:18:06 -0700406 bootClasspathTag = dependencyTag{name: "bootclasspath"}
407 systemModulesTag = dependencyTag{name: "system modules"}
408 frameworkResTag = dependencyTag{name: "framework-res"}
409 frameworkApkTag = dependencyTag{name: "framework-apk"}
410 kotlinStdlibTag = dependencyTag{name: "kotlin-stdlib"}
Colin Crossafbb1732019-01-17 15:42:52 -0800411 kotlinAnnotationsTag = dependencyTag{name: "kotlin-annotations"}
Colin Cross4b964c02018-10-15 16:18:06 -0700412 proguardRaiseTag = dependencyTag{name: "proguard-raise"}
413 certificateTag = dependencyTag{name: "certificate"}
414 instrumentationForTag = dependencyTag{name: "instrumentation_for"}
Colin Crossbe1da472017-07-07 15:59:46 -0700415)
Colin Cross2fe66872015-03-30 17:20:39 -0700416
Colin Crossfc3674a2017-09-18 17:41:52 -0700417type sdkDep struct {
Colin Cross47ff2522017-10-02 14:22:08 -0700418 useModule, useFiles, useDefaultLibs, invalidVersion bool
419
Colin Cross86a60ae2018-05-29 14:44:55 -0700420 modules []string
Colin Cross1369cdb2017-09-29 17:58:17 -0700421 systemModules string
422
Colin Crossa97c5d32018-03-28 14:58:31 -0700423 frameworkResModule string
424
Colin Cross86a60ae2018-05-29 14:44:55 -0700425 jars android.Paths
Colin Cross3047fa22019-04-18 10:56:44 -0700426 aidl android.OptionalPath
Colin Cross1369cdb2017-09-29 17:58:17 -0700427}
428
Colin Crossa4f08812018-10-02 22:03:40 -0700429type jniLib struct {
430 name string
431 path android.Path
432 target android.Target
433}
434
Colin Cross3144dfc2018-01-03 15:06:47 -0800435func (j *Module) shouldInstrument(ctx android.BaseContext) bool {
436 return j.properties.Instrument && ctx.Config().IsEnvTrue("EMMA_INSTRUMENT")
437}
438
439func (j *Module) shouldInstrumentStatic(ctx android.BaseContext) bool {
440 return j.shouldInstrument(ctx) &&
441 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
442 ctx.Config().UnbundledBuild())
443}
444
Colin Cross83bb3162018-06-25 15:48:06 -0700445func (j *Module) sdkVersion() string {
446 return String(j.deviceProperties.Sdk_version)
447}
448
449func (j *Module) minSdkVersion() string {
450 if j.deviceProperties.Min_sdk_version != nil {
451 return *j.deviceProperties.Min_sdk_version
452 }
453 return j.sdkVersion()
454}
455
Dan Willemsen419290a2018-10-31 15:28:47 -0700456func (j *Module) targetSdkVersion() string {
457 if j.deviceProperties.Target_sdk_version != nil {
458 return *j.deviceProperties.Target_sdk_version
459 }
460 return j.sdkVersion()
461}
462
Colin Crossbe1da472017-07-07 15:59:46 -0700463func (j *Module) deps(ctx android.BottomUpMutatorContext) {
Colin Cross1369cdb2017-09-29 17:58:17 -0700464 if ctx.Device() {
Colin Crossff3ae9d2018-04-10 16:15:18 -0700465 if !Bool(j.properties.No_standard_libs) {
Colin Cross83bb3162018-06-25 15:48:06 -0700466 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Crossfc3674a2017-09-18 17:41:52 -0700467 if sdkDep.useDefaultLibs {
Colin Cross42d48b72018-08-29 14:10:52 -0700468 ctx.AddVariationDependencies(nil, bootClasspathTag, config.DefaultBootclasspathLibraries...)
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100469 ctx.AddVariationDependencies(nil, systemModulesTag, config.DefaultSystemModules)
Colin Crossff3ae9d2018-04-10 16:15:18 -0700470 if !Bool(j.properties.No_framework_libs) {
Colin Cross42d48b72018-08-29 14:10:52 -0700471 ctx.AddVariationDependencies(nil, libTag, config.DefaultLibraries...)
Colin Crossfa5eb232017-10-01 20:33:03 -0700472 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700473 } else if sdkDep.useModule {
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100474 ctx.AddVariationDependencies(nil, systemModulesTag, sdkDep.systemModules)
Colin Cross42d48b72018-08-29 14:10:52 -0700475 ctx.AddVariationDependencies(nil, bootClasspathTag, sdkDep.modules...)
Sasha Smundak2057f822019-04-16 17:16:58 -0700476 if j.deviceProperties.EffectiveOptimizeEnabled() {
Colin Cross42d48b72018-08-29 14:10:52 -0700477 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultBootclasspathLibraries...)
478 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultLibraries...)
Colin Cross66dbc0b2017-12-28 12:23:20 -0800479 }
Colin Crossbe1da472017-07-07 15:59:46 -0700480 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700481 } else if j.deviceProperties.System_modules == nil {
482 ctx.PropertyErrorf("no_standard_libs",
483 "system_modules is required to be set when no_standard_libs is true, did you mean no_framework_libs?")
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100484 } else if *j.deviceProperties.System_modules != "none" {
Colin Cross42d48b72018-08-29 14:10:52 -0700485 ctx.AddVariationDependencies(nil, systemModulesTag, *j.deviceProperties.System_modules)
Colin Cross2fe66872015-03-30 17:20:39 -0700486 }
Mathew Inwoodebe29ce2018-09-04 14:26:19 +0100487 if (ctx.ModuleName() == "framework") || (ctx.ModuleName() == "framework-annotation-proc") {
Colin Cross42d48b72018-08-29 14:10:52 -0700488 ctx.AddVariationDependencies(nil, frameworkResTag, "framework-res")
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800489 }
Nan Zhangb2b33de2018-02-23 11:18:47 -0800490 if ctx.ModuleName() == "android_stubs_current" ||
491 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -0700492 ctx.ModuleName() == "android_test_stubs_current" {
Colin Cross42d48b72018-08-29 14:10:52 -0700493 ctx.AddVariationDependencies(nil, frameworkApkTag, "framework-res")
Nan Zhangb2b33de2018-02-23 11:18:47 -0800494 }
Colin Cross2fe66872015-03-30 17:20:39 -0700495 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700496
Colin Cross42d48b72018-08-29 14:10:52 -0700497 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
498 ctx.AddVariationDependencies(nil, staticLibTag, j.properties.Static_libs...)
Colin Crossa4f08812018-10-02 22:03:40 -0700499
Colin Crossbe9cdb82019-01-21 21:37:16 -0800500 ctx.AddFarVariationDependencies([]blueprint.Variation{
501 {Mutator: "arch", Variation: ctx.Config().BuildOsCommonVariant},
502 }, pluginTag, j.properties.Plugins...)
503
Colin Crossfe17f6f2019-03-28 19:30:56 -0700504 android.ProtoDeps(ctx, &j.protoProperties)
Colin Cross6af17aa2017-09-20 12:59:05 -0700505 if j.hasSrcExt(".proto") {
506 protoDeps(ctx, &j.protoProperties)
507 }
Colin Cross93e85952017-08-15 13:34:18 -0700508
509 if j.hasSrcExt(".kt") {
510 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
511 // Kotlin files
Colin Cross42d48b72018-08-29 14:10:52 -0700512 ctx.AddVariationDependencies(nil, kotlinStdlibTag, "kotlin-stdlib")
Colin Cross7788c122019-01-23 16:14:02 -0800513 if len(j.properties.Plugins) > 0 {
Colin Crossafbb1732019-01-17 15:42:52 -0800514 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
515 }
Colin Cross93e85952017-08-15 13:34:18 -0700516 }
Colin Cross3144dfc2018-01-03 15:06:47 -0800517
518 if j.shouldInstrumentStatic(ctx) {
Colin Cross42d48b72018-08-29 14:10:52 -0700519 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
Colin Cross3144dfc2018-01-03 15:06:47 -0800520 }
Colin Cross6af17aa2017-09-20 12:59:05 -0700521}
522
523func hasSrcExt(srcs []string, ext string) bool {
524 for _, src := range srcs {
525 if filepath.Ext(src) == ext {
526 return true
527 }
528 }
529
530 return false
531}
532
Nan Zhang61eaedb2017-11-02 13:28:15 -0700533func shardPaths(paths android.Paths, shardSize int) []android.Paths {
534 ret := make([]android.Paths, 0, (len(paths)+shardSize-1)/shardSize)
535 for len(paths) > shardSize {
536 ret = append(ret, paths[0:shardSize])
537 paths = paths[shardSize:]
538 }
539 if len(paths) > 0 {
540 ret = append(ret, paths)
541 }
542 return ret
543}
544
Colin Cross6af17aa2017-09-20 12:59:05 -0700545func (j *Module) hasSrcExt(ext string) bool {
546 return hasSrcExt(j.properties.Srcs, ext)
Colin Cross2fe66872015-03-30 17:20:39 -0700547}
548
Colin Cross46c9b8b2017-06-22 16:51:17 -0700549func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Colin Cross3047fa22019-04-18 10:56:44 -0700550 aidlIncludeDirs android.Paths) (string, android.Paths) {
Colin Crossc0b06f12015-04-08 13:03:43 -0700551
Colin Crossebe1a512017-11-14 13:12:14 -0800552 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
553 aidlIncludes = append(aidlIncludes,
554 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
555 aidlIncludes = append(aidlIncludes,
556 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
Colin Crossc0b06f12015-04-08 13:03:43 -0700557
Colin Cross3047fa22019-04-18 10:56:44 -0700558 var flags []string
559 var deps android.Paths
Steven Moreland667f6882018-07-26 12:55:08 -0700560
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700561 if aidlPreprocess.Valid() {
562 flags = append(flags, "-p"+aidlPreprocess.String())
Colin Cross3047fa22019-04-18 10:56:44 -0700563 deps = append(deps, aidlPreprocess.Path())
564 } else if len(aidlIncludeDirs) > 0 {
Colin Cross635c3b02016-05-18 15:37:25 -0700565 flags = append(flags, android.JoinWithPrefix(aidlIncludeDirs.Strings(), "-I"))
Colin Crossc0b06f12015-04-08 13:03:43 -0700566 }
567
Colin Cross3047fa22019-04-18 10:56:44 -0700568 if len(j.exportAidlIncludeDirs) > 0 {
569 flags = append(flags, android.JoinWithPrefix(j.exportAidlIncludeDirs.Strings(), "-I"))
570 }
571
572 if len(aidlIncludes) > 0 {
573 flags = append(flags, android.JoinWithPrefix(aidlIncludes.Strings(), "-I"))
574 }
575
Colin Cross635c3b02016-05-18 15:37:25 -0700576 flags = append(flags, "-I"+android.PathForModuleSrc(ctx).String())
Colin Cross32f38982018-02-22 11:47:25 -0800577 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Colin Crossd48633a2017-07-13 14:41:17 -0700578 flags = append(flags, "-I"+src.String())
579 }
Colin Crossc0b06f12015-04-08 13:03:43 -0700580
Martijn Coeneneab15642018-03-09 09:29:59 +0100581 if Bool(j.deviceProperties.Aidl.Generate_traces) {
582 flags = append(flags, "-t")
583 }
584
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100585 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
586 flags = append(flags, "--transaction_names")
587 }
588
Colin Cross3047fa22019-04-18 10:56:44 -0700589 return strings.Join(flags, " "), deps
Colin Crossc0b06f12015-04-08 13:03:43 -0700590}
591
Colin Cross32f676a2017-09-06 13:41:06 -0700592type deps struct {
Nan Zhang581fd212018-01-10 16:06:12 -0800593 classpath classpath
594 bootClasspath classpath
Colin Cross6a77c982018-06-19 22:43:34 -0700595 processorPath classpath
Colin Crossbe9cdb82019-01-21 21:37:16 -0800596 processorClasses []string
Colin Cross6ade34f2017-09-15 13:00:47 -0700597 staticJars android.Paths
Nan Zhanged19fc32017-10-19 13:06:22 -0700598 staticHeaderJars android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700599 staticResourceJars android.Paths
Colin Cross6ade34f2017-09-15 13:00:47 -0700600 aidlIncludeDirs android.Paths
Nan Zhangb2b33de2018-02-23 11:18:47 -0800601 srcs android.Paths
Colin Cross59149b62017-10-16 18:07:29 -0700602 srcJars android.Paths
Colin Cross1369cdb2017-09-29 17:58:17 -0700603 systemModules android.Path
Colin Cross6ade34f2017-09-15 13:00:47 -0700604 aidlPreprocess android.OptionalPath
Colin Cross93e85952017-08-15 13:34:18 -0700605 kotlinStdlib android.Paths
Colin Crossafbb1732019-01-17 15:42:52 -0800606 kotlinAnnotations android.Paths
Colin Crossbe9cdb82019-01-21 21:37:16 -0800607
608 disableTurbine bool
Colin Cross32f676a2017-09-06 13:41:06 -0700609}
Colin Cross2fe66872015-03-30 17:20:39 -0700610
Colin Cross54250902017-12-05 09:28:08 -0800611func checkProducesJars(ctx android.ModuleContext, dep android.SourceFileProducer) {
612 for _, f := range dep.Srcs() {
613 if f.Ext() != ".jar" {
614 ctx.ModuleErrorf("genrule %q must generate files ending with .jar to be used as a libs or static_libs dependency",
615 ctx.OtherModuleName(dep.(blueprint.Module)))
616 }
617 }
618}
619
Jiyong Park2d492942018-03-05 17:44:10 +0900620type linkType int
621
622const (
623 javaCore linkType = iota
624 javaSdk
625 javaSystem
626 javaPlatform
627)
628
Jiyong Park46f78fb2018-10-20 16:33:17 +0900629func getLinkType(m *Module, name string) (ret linkType, stubs bool) {
Colin Cross83bb3162018-06-25 15:48:06 -0700630 ver := m.sdkVersion()
Colin Crossf19b9bb2018-03-26 14:42:44 -0700631 switch {
Jiyong Park46f78fb2018-10-20 16:33:17 +0900632 case name == "core.current.stubs" || name == "core.platform.api.stubs" ||
633 name == "stub-annotations" || name == "private-stub-annotations-jar" ||
634 name == "core-lambda-stubs":
635 return javaCore, true
Neil Fuller401eeba2018-10-18 19:48:58 +0100636 case ver == "core_current":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900637 return javaCore, false
638 case name == "android_system_stubs_current":
639 return javaSystem, true
640 case strings.HasPrefix(ver, "system_"):
641 return javaSystem, false
642 case name == "android_test_stubs_current":
643 return javaSystem, true
644 case strings.HasPrefix(ver, "test_"):
645 return javaPlatform, false
646 case name == "android_stubs_current":
647 return javaSdk, true
648 case ver == "current":
649 return javaSdk, false
Colin Crossf19b9bb2018-03-26 14:42:44 -0700650 case ver == "":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900651 return javaPlatform, false
Colin Crossf19b9bb2018-03-26 14:42:44 -0700652 default:
653 if _, err := strconv.Atoi(ver); err != nil {
654 panic(fmt.Errorf("expected sdk_version to be a number, got %q", ver))
655 }
Jiyong Park46f78fb2018-10-20 16:33:17 +0900656 return javaSdk, false
Jiyong Park2d492942018-03-05 17:44:10 +0900657 }
658}
659
Jiyong Park750e5572018-01-31 00:20:13 +0900660func checkLinkType(ctx android.ModuleContext, from *Module, to *Library, tag dependencyTag) {
Colin Crossf19b9bb2018-03-26 14:42:44 -0700661 if ctx.Host() {
662 return
663 }
664
Jiyong Park46f78fb2018-10-20 16:33:17 +0900665 myLinkType, stubs := getLinkType(from, ctx.ModuleName())
666 if stubs {
667 return
668 }
669 otherLinkType, _ := getLinkType(&to.Module, ctx.OtherModuleName(to))
Jiyong Park2d492942018-03-05 17:44:10 +0900670 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."
671
672 switch myLinkType {
673 case javaCore:
674 if otherLinkType != javaCore {
675 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 +0900676 ctx.OtherModuleName(to))
677 }
Jiyong Park2d492942018-03-05 17:44:10 +0900678 break
679 case javaSdk:
680 if otherLinkType != javaCore && otherLinkType != javaSdk {
681 ctx.ModuleErrorf("compiles against Android API, but dependency %q is compiling against non-public Android API."+commonMessage,
682 ctx.OtherModuleName(to))
683 }
684 break
685 case javaSystem:
686 if otherLinkType == javaPlatform {
687 ctx.ModuleErrorf("compiles against system API, but dependency %q is compiling against private API."+commonMessage,
688 ctx.OtherModuleName(to))
689 }
690 break
691 case javaPlatform:
692 // no restriction on link-type
693 break
Jiyong Park750e5572018-01-31 00:20:13 +0900694 }
695}
696
Colin Cross32f676a2017-09-06 13:41:06 -0700697func (j *Module) collectDeps(ctx android.ModuleContext) deps {
698 var deps deps
Colin Crossfc3674a2017-09-18 17:41:52 -0700699
Colin Cross300f0382018-03-06 13:11:51 -0800700 if ctx.Device() {
Colin Cross83bb3162018-06-25 15:48:06 -0700701 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross300f0382018-03-06 13:11:51 -0800702 if sdkDep.invalidVersion {
Colin Cross86a60ae2018-05-29 14:44:55 -0700703 ctx.AddMissingDependencies(sdkDep.modules)
Colin Cross300f0382018-03-06 13:11:51 -0800704 } else if sdkDep.useFiles {
705 // sdkDep.jar is actually equivalent to turbine header.jar.
Colin Cross86a60ae2018-05-29 14:44:55 -0700706 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross3047fa22019-04-18 10:56:44 -0700707 deps.aidlPreprocess = sdkDep.aidl
708 } else {
709 deps.aidlPreprocess = sdkDep.aidl
Colin Cross300f0382018-03-06 13:11:51 -0800710 }
Colin Crossfc3674a2017-09-18 17:41:52 -0700711 }
712
Colin Crossd11fcda2017-10-23 17:59:01 -0700713 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross2fe66872015-03-30 17:20:39 -0700714 otherName := ctx.OtherModuleName(module)
Colin Crossec7a0422017-07-07 14:47:12 -0700715 tag := ctx.OtherModuleDependencyTag(module)
716
Colin Crossa4f08812018-10-02 22:03:40 -0700717 if _, ok := tag.(*jniDependencyTag); ok {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700718 // Handled by AndroidApp.collectAppDeps
719 return
720 }
721 if tag == certificateTag {
722 // Handled by AndroidApp.collectAppDeps
Colin Crossa4f08812018-10-02 22:03:40 -0700723 return
724 }
725
Jiyong Park750e5572018-01-31 00:20:13 +0900726 if to, ok := module.(*Library); ok {
Colin Crossa97c5d32018-03-28 14:58:31 -0700727 switch tag {
728 case bootClasspathTag, libTag, staticLibTag:
729 checkLinkType(ctx, j, to, tag.(dependencyTag))
730 }
Jiyong Park750e5572018-01-31 00:20:13 +0900731 }
Colin Cross54250902017-12-05 09:28:08 -0800732 switch dep := module.(type) {
Colin Cross897d2ed2019-02-11 14:03:51 -0800733 case SdkLibraryDependency:
734 switch tag {
735 case libTag:
736 deps.classpath = append(deps.classpath, dep.SdkHeaderJars(ctx, j.sdkVersion())...)
737 // names of sdk libs that are directly depended are exported
738 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
Colin Cross79c7c262019-04-17 11:11:46 -0700739 case staticLibTag:
Colin Cross897d2ed2019-02-11 14:03:51 -0800740 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
741 }
Colin Cross54250902017-12-05 09:28:08 -0800742 case Dependency:
743 switch tag {
744 case bootClasspathTag:
745 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars()...)
Colin Cross4b964c02018-10-15 16:18:06 -0700746 case libTag, instrumentationForTag:
Colin Cross54250902017-12-05 09:28:08 -0800747 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900748 // sdk lib names from dependencies are re-exported
749 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700750 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Colin Cross54250902017-12-05 09:28:08 -0800751 case staticLibTag:
752 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
753 deps.staticJars = append(deps.staticJars, dep.ImplementationJars()...)
754 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars()...)
Colin Cross331a1212018-08-15 20:40:52 -0700755 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900756 // sdk lib names from dependencies are re-exported
757 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700758 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800759 case pluginTag:
760 if plugin, ok := dep.(*Plugin); ok {
761 deps.processorPath = append(deps.processorPath, dep.ImplementationAndResourcesJars()...)
762 if plugin.pluginProperties.Processor_class != nil {
763 deps.processorClasses = append(deps.processorClasses, *plugin.pluginProperties.Processor_class)
764 }
765 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
766 } else {
767 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
768 }
Colin Cross54250902017-12-05 09:28:08 -0800769 case frameworkResTag:
Mathew Inwoodebe29ce2018-09-04 14:26:19 +0100770 if (ctx.ModuleName() == "framework") || (ctx.ModuleName() == "framework-annotation-proc") {
Colin Cross54250902017-12-05 09:28:08 -0800771 // framework.jar has a one-off dependency on the R.java and Manifest.java files
772 // generated by framework-res.apk
773 deps.srcJars = append(deps.srcJars, dep.(*AndroidApp).aaptSrcJar)
774 }
Nan Zhangb2b33de2018-02-23 11:18:47 -0800775 case frameworkApkTag:
776 if ctx.ModuleName() == "android_stubs_current" ||
777 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -0700778 ctx.ModuleName() == "android_test_stubs_current" {
Nan Zhangb2b33de2018-02-23 11:18:47 -0800779 // framework stubs.jar need to depend on framework-res.apk, in order to pull the
780 // resource files out of there for aapt.
781 //
782 // Normally the package rule runs aapt, which includes the resource,
783 // but we're not running that in our package rule so just copy in the
784 // resource files here.
Colin Cross331a1212018-08-15 20:40:52 -0700785 deps.staticResourceJars = append(deps.staticResourceJars, dep.(*AndroidApp).exportPackage)
Nan Zhangb2b33de2018-02-23 11:18:47 -0800786 }
Colin Cross54250902017-12-05 09:28:08 -0800787 case kotlinStdlibTag:
788 deps.kotlinStdlib = dep.HeaderJars()
Colin Crossafbb1732019-01-17 15:42:52 -0800789 case kotlinAnnotationsTag:
790 deps.kotlinAnnotations = dep.HeaderJars()
Colin Cross54250902017-12-05 09:28:08 -0800791 }
792
Colin Cross54250902017-12-05 09:28:08 -0800793 case android.SourceFileProducer:
794 switch tag {
795 case libTag:
796 checkProducesJars(ctx, dep)
797 deps.classpath = append(deps.classpath, dep.Srcs()...)
798 case staticLibTag:
799 checkProducesJars(ctx, dep)
800 deps.classpath = append(deps.classpath, dep.Srcs()...)
801 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
802 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Cross54250902017-12-05 09:28:08 -0800803 }
804 default:
Colin Crossec7a0422017-07-07 14:47:12 -0700805 switch tag {
806 case android.DefaultsDepTag, android.SourceDepTag:
Dan Willemsend6ba0d52017-09-13 15:46:47 -0700807 // Nothing to do
Colin Cross1369cdb2017-09-29 17:58:17 -0700808 case systemModulesTag:
809 if deps.systemModules != nil {
810 panic("Found two system module dependencies")
811 }
812 sm := module.(*SystemModules)
813 if sm.outputFile == nil {
814 panic("Missing directory for system module dependency")
815 }
816 deps.systemModules = sm.outputFile
Colin Crossec7a0422017-07-07 14:47:12 -0700817 default:
818 ctx.ModuleErrorf("depends on non-java module %q", otherName)
Colin Cross2fe66872015-03-30 17:20:39 -0700819 }
Colin Crossec7a0422017-07-07 14:47:12 -0700820 }
Colin Cross2fe66872015-03-30 17:20:39 -0700821 })
822
Jiyong Park1be96912018-05-28 18:02:19 +0900823 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
824
Colin Cross32f676a2017-09-06 13:41:06 -0700825 return deps
Colin Cross2fe66872015-03-30 17:20:39 -0700826}
827
Colin Cross83bb3162018-06-25 15:48:06 -0700828func getJavaVersion(ctx android.ModuleContext, javaVersion string, sdkContext sdkContext) string {
Nan Zhang357466b2018-04-17 17:38:36 -0700829 var ret string
Colin Cross98fd5742019-01-09 23:04:25 -0800830 v := sdkContext.sdkVersion()
831 // For PDK builds, use the latest SDK version instead of "current"
832 if ctx.Config().IsPdkBuild() && (v == "" || v == "current") {
Colin Cross3047fa22019-04-18 10:56:44 -0700833 sdkVersions := ctx.Config().Get(sdkVersionsKey).([]int)
Colin Cross98fd5742019-01-09 23:04:25 -0800834 latestSdkVersion := 0
835 if len(sdkVersions) > 0 {
836 latestSdkVersion = sdkVersions[len(sdkVersions)-1]
837 }
838 v = strconv.Itoa(latestSdkVersion)
839 }
840
841 sdk, err := sdkVersionToNumber(ctx, v)
Colin Cross83bb3162018-06-25 15:48:06 -0700842 if err != nil {
843 ctx.PropertyErrorf("sdk_version", "%s", err)
844 }
Nan Zhang357466b2018-04-17 17:38:36 -0700845 if javaVersion != "" {
846 ret = javaVersion
847 } else if ctx.Device() && sdk <= 23 {
848 ret = "1.7"
Jiyong Park4584a8a2018-10-03 18:05:04 +0900849 } else if ctx.Device() && sdk <= 28 || !ctx.Config().TargetOpenJDK9() {
Nan Zhang357466b2018-04-17 17:38:36 -0700850 ret = "1.8"
Colin Cross83bb3162018-06-25 15:48:06 -0700851 } else if ctx.Device() && sdkContext.sdkVersion() != "" && sdk == android.FutureApiLevel {
Nan Zhang357466b2018-04-17 17:38:36 -0700852 // TODO(ccross): once we generate stubs we should be able to use 1.9 for sdk_version: "current"
853 ret = "1.8"
854 } else {
855 ret = "1.9"
856 }
857
858 return ret
859}
860
Nan Zhanged19fc32017-10-19 13:06:22 -0700861func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
Colin Crossc0b06f12015-04-08 13:03:43 -0700862
Colin Crossf03c82b2015-04-13 13:53:40 -0700863 var flags javaBuilderFlags
864
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100865 // javaVersion flag.
866 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), sdkContext(j))
867
Nan Zhanged19fc32017-10-19 13:06:22 -0700868 // javac flags.
Colin Crossf03c82b2015-04-13 13:53:40 -0700869 javacFlags := j.properties.Javacflags
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100870 if flags.javaVersion == "1.9" {
Colin Cross1369cdb2017-09-29 17:58:17 -0700871 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Nan Zhanged19fc32017-10-19 13:06:22 -0700872 }
Colin Cross6510f912017-11-29 00:27:14 -0800873 if ctx.Config().MinimizeJavaDebugInfo() {
Colin Cross126a25c2017-10-31 13:55:34 -0700874 // Override the -g flag passed globally to remove local variable debug info to reduce
875 // disk and memory usage.
876 javacFlags = append(javacFlags, "-g:source,lines")
877 }
Colin Cross64162712017-08-08 13:17:59 -0700878
Colin Cross66548102018-06-19 22:47:35 -0700879 if ctx.Config().RunErrorProne() {
880 if config.ErrorProneClasspath == nil {
881 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
882 }
883
884 errorProneFlags := []string{
885 "-Xplugin:ErrorProne",
886 "${config.ErrorProneChecks}",
887 }
888 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
889
890 flags.errorProneExtraJavacFlags = "${config.ErrorProneFlags} " +
891 "'" + strings.Join(errorProneFlags, " ") + "'"
892 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
Andreas Gampef3e5b552018-01-22 21:27:21 -0800893 }
894
Nan Zhanged19fc32017-10-19 13:06:22 -0700895 // classpath
Nan Zhang581fd212018-01-10 16:06:12 -0800896 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
897 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross6a77c982018-06-19 22:43:34 -0700898 flags.processorPath = append(flags.processorPath, deps.processorPath...)
Colin Cross7fdd2b72018-01-02 18:14:25 -0800899
Colin Crossbe9cdb82019-01-21 21:37:16 -0800900 flags.processor = strings.Join(deps.processorClasses, ",")
901
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100902 if len(flags.bootClasspath) == 0 && ctx.Host() && flags.javaVersion != "1.9" &&
Colin Cross7fdd2b72018-01-02 18:14:25 -0800903 !Bool(j.properties.No_standard_libs) &&
904 inList(flags.javaVersion, []string{"1.6", "1.7", "1.8"}) {
905 // Give host-side tools a version of OpenJDK's standard libraries
906 // close to what they're targeting. As of Dec 2017, AOSP is only
907 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
908 //
909 // When building with OpenJDK 8, the following should have no
910 // effect since those jars would be available by default.
911 //
912 // When building with OpenJDK 9 but targeting a version < 1.8,
913 // putting them on the bootclasspath means that:
914 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
915 // b) references to existing APIs are not reinterpreted in an
916 // OpenJDK 9-specific way, eg. calls to subclasses of
917 // java.nio.Buffer as in http://b/70862583
918 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
919 flags.bootClasspath = append(flags.bootClasspath,
920 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
921 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
Nan Zhang5f8cb422018-02-06 10:34:32 -0800922 if Bool(j.properties.Use_tools_jar) {
923 flags.bootClasspath = append(flags.bootClasspath,
924 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
925 }
Colin Cross7fdd2b72018-01-02 18:14:25 -0800926 }
927
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100928 if j.properties.Patch_module != nil && flags.javaVersion == "1.9" {
Jaewoong Jung38e4fb22018-12-12 09:01:34 -0800929 // Manually specify build directory in case it is not under the repo root.
930 // (javac doesn't seem to expand into symbolc links when searching for patch-module targets, so
931 // just adding a symlink under the root doesn't help.)
932 patchPaths := ".:" + ctx.Config().BuildDir()
933 classPath := flags.classpath.FormJavaClassPath("")
934 if classPath != "" {
935 patchPaths += ":" + classPath
936 }
937 javacFlags = append(javacFlags, "--patch-module="+String(j.properties.Patch_module)+"="+patchPaths)
Colin Cross81440082018-08-15 20:21:55 -0700938 }
939
Nan Zhanged19fc32017-10-19 13:06:22 -0700940 // systemModules
Colin Cross1369cdb2017-09-29 17:58:17 -0700941 if deps.systemModules != nil {
942 flags.systemModules = append(flags.systemModules, deps.systemModules)
943 }
944
Nan Zhanged19fc32017-10-19 13:06:22 -0700945 // aidl flags.
Colin Cross3047fa22019-04-18 10:56:44 -0700946 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs)
Colin Cross2fe66872015-03-30 17:20:39 -0700947
Colin Cross81440082018-08-15 20:21:55 -0700948 if len(javacFlags) > 0 {
949 // optimization.
950 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
951 flags.javacFlags = "$javacFlags"
952 }
953
Nan Zhanged19fc32017-10-19 13:06:22 -0700954 return flags
955}
Colin Crossc0b06f12015-04-08 13:03:43 -0700956
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800957func (j *Module) compile(ctx android.ModuleContext, extraSrcJars ...android.Path) {
Nan Zhanged19fc32017-10-19 13:06:22 -0700958
Colin Crossebe1a512017-11-14 13:12:14 -0800959 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
Nan Zhanged19fc32017-10-19 13:06:22 -0700960
961 deps := j.collectDeps(ctx)
962 flags := j.collectBuilderFlags(ctx, deps)
963
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100964 if flags.javaVersion == "1.9" {
Nan Zhanged19fc32017-10-19 13:06:22 -0700965 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
966 }
Colin Cross8a497952019-03-05 22:25:09 -0800967 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Colin Cross6af17aa2017-09-20 12:59:05 -0700968 if hasSrcExt(srcFiles.Strings(), ".proto") {
Colin Cross0f2ee152017-12-14 15:22:43 -0800969 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
Colin Cross6af17aa2017-09-20 12:59:05 -0700970 }
971
Colin Crossaf050172017-11-15 23:01:59 -0800972 srcFiles = j.genSources(ctx, srcFiles, flags)
973
974 srcJars := srcFiles.FilterByExt(".srcjar")
Colin Cross59149b62017-10-16 18:07:29 -0700975 srcJars = append(srcJars, deps.srcJars...)
Colin Cross3bc7ffa2017-11-22 16:19:37 -0800976 srcJars = append(srcJars, extraSrcJars...)
Colin Crossb7a63242015-04-16 14:09:14 -0700977
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700978 // Collect source files from compiledJavaSrcs, compiledSrcJars and filter out Exclude_srcs
979 // that IDEInfo struct will use
980 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, srcFiles.Strings()...)
981
Steven Morelandc4efd9c2019-01-18 11:51:25 -0800982 if j.properties.Jarjar_rules != nil {
Colin Cross8a497952019-03-05 22:25:09 -0800983 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
Steven Morelandc4efd9c2019-01-18 11:51:25 -0800984 }
985
Colin Cross1ee23172017-10-18 14:44:18 -0700986 jarName := ctx.ModuleName() + ".jar"
987
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +0000988 javaSrcFiles := srcFiles.FilterByExt(".java")
989 var uniqueSrcFiles android.Paths
990 set := make(map[string]bool)
991 for _, v := range javaSrcFiles {
992 if _, found := set[v.String()]; !found {
993 set[v.String()] = true
994 uniqueSrcFiles = append(uniqueSrcFiles, v)
995 }
996 }
997
Colin Cross55f63ea2018-08-27 12:37:09 -0700998 var kotlinJars android.Paths
999
Colin Cross93e85952017-08-15 13:34:18 -07001000 if srcFiles.HasExt(".kt") {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001001 // user defined kotlin flags.
1002 kotlincFlags := j.properties.Kotlincflags
1003 CheckKotlincFlags(ctx, kotlincFlags)
1004
Colin Cross93e85952017-08-15 13:34:18 -07001005 // If there are kotlin files, compile them first but pass all the kotlin and java files
1006 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1007 // won't emit any classes for them.
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001008 kotlincFlags = append(kotlincFlags, "-no-stdlib")
Colin Cross93e85952017-08-15 13:34:18 -07001009 if ctx.Device() {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001010 kotlincFlags = append(kotlincFlags, "-no-jdk")
1011 }
1012 if len(kotlincFlags) > 0 {
1013 // optimization.
1014 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1015 flags.kotlincFlags += "$kotlincFlags"
Colin Cross93e85952017-08-15 13:34:18 -07001016 }
1017
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001018 var kotlinSrcFiles android.Paths
1019 kotlinSrcFiles = append(kotlinSrcFiles, uniqueSrcFiles...)
1020 kotlinSrcFiles = append(kotlinSrcFiles, srcFiles.FilterByExt(".kt")...)
1021
Colin Crossafbb1732019-01-17 15:42:52 -08001022 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1023 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1024
1025 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1026 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1027
1028 if len(flags.processorPath) > 0 {
1029 // Use kapt for annotation processing
1030 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1031 kotlinKapt(ctx, kaptSrcJar, kotlinSrcFiles, srcJars, flags)
1032 srcJars = append(srcJars, kaptSrcJar)
1033 // Disable annotation processing in javac, it's already been handled by kapt
1034 flags.processorPath = nil
Colin Cross3a3e94c2019-01-23 15:39:50 -08001035 flags.processor = ""
Colin Crossafbb1732019-01-17 15:42:52 -08001036 }
Colin Cross93e85952017-08-15 13:34:18 -07001037
Colin Cross1ee23172017-10-18 14:44:18 -07001038 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross21fc9bb2019-01-18 15:05:09 -08001039 kotlinCompile(ctx, kotlinJar, kotlinSrcFiles, srcJars, flags)
Colin Cross93e85952017-08-15 13:34:18 -07001040 if ctx.Failed() {
1041 return
1042 }
1043
1044 // Make javac rule depend on the kotlinc rule
1045 flags.classpath = append(flags.classpath, kotlinJar)
Przemyslaw Szczepaniak66c0c402018-03-08 13:21:55 +00001046
Colin Cross93e85952017-08-15 13:34:18 -07001047 // Jar kotlin classes into the final jar after javac
Colin Cross55f63ea2018-08-27 12:37:09 -07001048 kotlinJars = append(kotlinJars, kotlinJar)
Colin Cross9b38aef2018-08-27 15:42:25 -07001049 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
Colin Cross93e85952017-08-15 13:34:18 -07001050 }
1051
Colin Cross55f63ea2018-08-27 12:37:09 -07001052 jars := append(android.Paths(nil), kotlinJars...)
1053
Colin Cross5ab4e6d2017-11-22 16:20:45 -08001054 // Store the list of .java files that was passed to javac
1055 j.compiledJavaSrcs = uniqueSrcFiles
1056 j.compiledSrcJars = srcJars
1057
Nan Zhang61eaedb2017-11-02 13:28:15 -07001058 enable_sharding := false
Colin Crossbe9cdb82019-01-21 21:37:16 -08001059 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !deps.disableTurbine {
Nan Zhang61eaedb2017-11-02 13:28:15 -07001060 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1061 enable_sharding = true
Ashley Rosee36efcf2019-01-16 17:34:08 -05001062 // Formerly, there was a check here that prevented annotation processors
1063 // from being used when sharding was enabled, as some annotation processors
1064 // do not function correctly in sharded environments. It was removed to
1065 // allow for the use of annotation processors that do function correctly
1066 // with sharding enabled. See: b/77284273.
Nan Zhang61eaedb2017-11-02 13:28:15 -07001067 }
Colin Cross55f63ea2018-08-27 12:37:09 -07001068 j.headerJarFile = j.compileJavaHeader(ctx, uniqueSrcFiles, srcJars, deps, flags, jarName, kotlinJars)
Colin Crossf19b9bb2018-03-26 14:42:44 -07001069 if ctx.Failed() {
1070 return
Nan Zhanged19fc32017-10-19 13:06:22 -07001071 }
1072 }
Colin Cross8eadbf02017-10-24 17:46:00 -07001073 if len(uniqueSrcFiles) > 0 || len(srcJars) > 0 {
Colin Crossd6891432017-09-27 17:39:56 -07001074 var extraJarDeps android.Paths
Colin Cross66548102018-06-19 22:47:35 -07001075 if ctx.Config().RunErrorProne() {
Colin Crossc6bbef32017-08-14 14:16:06 -07001076 // If error-prone is enabled, add an additional rule to compile the java files into
1077 // a separate set of classes (so that they don't overwrite the normal ones and require
Colin Crossd6891432017-09-27 17:39:56 -07001078 // a rebuild when error-prone is turned off).
Colin Crossc6bbef32017-08-14 14:16:06 -07001079 // TODO(ccross): Once we always compile with javac9 we may be able to conditionally
1080 // enable error-prone without affecting the output class files.
Colin Cross1ee23172017-10-18 14:44:18 -07001081 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001082 RunErrorProne(ctx, errorprone, uniqueSrcFiles, srcJars, flags)
Colin Crossc6bbef32017-08-14 14:16:06 -07001083 extraJarDeps = append(extraJarDeps, errorprone)
1084 }
1085
Nan Zhang61eaedb2017-11-02 13:28:15 -07001086 if enable_sharding {
Nan Zhang581fd212018-01-10 16:06:12 -08001087 flags.classpath = append(flags.classpath, j.headerJarFile)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001088 shardSize := int(*(j.properties.Javac_shard_size))
1089 var shardSrcs []android.Paths
1090 if len(uniqueSrcFiles) > 0 {
1091 shardSrcs = shardPaths(uniqueSrcFiles, shardSize)
1092 for idx, shardSrc := range shardSrcs {
1093 classes := android.PathForModuleOut(ctx, "javac", jarName+strconv.Itoa(idx))
1094 TransformJavaToClasses(ctx, classes, idx, shardSrc, nil, flags, extraJarDeps)
1095 jars = append(jars, classes)
1096 }
1097 }
1098 if len(srcJars) > 0 {
1099 classes := android.PathForModuleOut(ctx, "javac", jarName+strconv.Itoa(len(shardSrcs)))
1100 TransformJavaToClasses(ctx, classes, len(shardSrcs), nil, srcJars, flags, extraJarDeps)
1101 jars = append(jars, classes)
1102 }
1103 } else {
1104 classes := android.PathForModuleOut(ctx, "javac", jarName)
1105 TransformJavaToClasses(ctx, classes, -1, uniqueSrcFiles, srcJars, flags, extraJarDeps)
1106 jars = append(jars, classes)
1107 }
Colin Crossd6891432017-09-27 17:39:56 -07001108 if ctx.Failed() {
1109 return
1110 }
Colin Cross2fe66872015-03-30 17:20:39 -07001111 }
1112
Colin Crosscedd4762018-09-13 11:26:19 -07001113 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1114 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Colin Cross0f37af02017-09-27 17:42:05 -07001115 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1116
1117 var resArgs []string
1118 var resDeps android.Paths
1119
1120 resArgs = append(resArgs, dirArgs...)
1121 resDeps = append(resDeps, dirDeps...)
1122
1123 resArgs = append(resArgs, fileArgs...)
1124 resDeps = append(resDeps, fileDeps...)
1125
Colin Crossff3ae9d2018-04-10 16:15:18 -07001126 if Bool(j.properties.Include_srcs) {
Colin Cross23729232017-10-03 13:14:07 -07001127 srcArgs, srcDeps := SourceFilesToJarArgs(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Colin Cross0f37af02017-09-27 17:42:05 -07001128 resArgs = append(resArgs, srcArgs...)
1129 resDeps = append(resDeps, srcDeps...)
1130 }
Colin Cross40a36712017-09-27 17:41:35 -07001131
1132 if len(resArgs) > 0 {
Colin Cross1ee23172017-10-18 14:44:18 -07001133 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
Colin Crosse9a275b2017-10-16 17:09:48 -07001134 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Colin Cross331a1212018-08-15 20:40:52 -07001135 j.resourceJar = resourceJar
Colin Cross65bf4f22015-04-03 16:54:17 -07001136 if ctx.Failed() {
1137 return
1138 }
1139 }
1140
Colin Cross331a1212018-08-15 20:40:52 -07001141 if len(deps.staticResourceJars) > 0 {
1142 var jars android.Paths
1143 if j.resourceJar != nil {
1144 jars = append(jars, j.resourceJar)
1145 }
1146 jars = append(jars, deps.staticResourceJars...)
1147
1148 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1149 TransformJarsToJar(ctx, combinedJar, "for resources", jars, android.OptionalPath{},
1150 false, nil, nil)
1151 j.resourceJar = combinedJar
1152 }
1153
Colin Cross32f676a2017-09-06 13:41:06 -07001154 jars = append(jars, deps.staticJars...)
Colin Cross0a6e0072017-08-30 14:24:55 -07001155
Colin Cross094054a2018-10-17 15:10:48 -07001156 manifest := j.overrideManifest
1157 if !manifest.Valid() && j.properties.Manifest != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001158 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Colin Cross366938f2017-12-11 16:29:02 -08001159 }
Colin Cross635acc92017-09-12 22:50:46 -07001160
Colin Cross8a497952019-03-05 22:25:09 -08001161 services := android.PathsForModuleSrc(ctx, j.properties.Services)
Alex Light7f004a72019-02-21 13:27:37 -08001162 if len(services) > 0 {
1163 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1164 var zipargs []string
1165 for _, file := range services {
1166 serviceFile := file.String()
1167 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1168 }
1169 ctx.Build(pctx, android.BuildParams{
1170 Rule: zip,
1171 Output: servicesJar,
1172 Implicits: services,
1173 Args: map[string]string{
Colin Cross0b9f31f2019-02-28 11:00:01 -08001174 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
Alex Light7f004a72019-02-21 13:27:37 -08001175 },
1176 })
1177 jars = append(jars, servicesJar)
1178 }
1179
Colin Cross0a6e0072017-08-30 14:24:55 -07001180 // Combine the classes built from sources, any manifests, and any static libraries into
Nan Zhanged19fc32017-10-19 13:06:22 -07001181 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross3063b782018-08-15 11:19:12 -07001182 var outputFile android.ModuleOutPath
Colin Crosse9a275b2017-10-16 17:09:48 -07001183
1184 if len(jars) == 1 && !manifest.Valid() {
Colin Cross3063b782018-08-15 11:19:12 -07001185 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok {
1186 // Optimization: skip the combine step if there is nothing to do
1187 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1188 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1189 // any if len(jars) == 1.
1190 outputFile = moduleOutPath
1191 } else {
1192 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1193 ctx.Build(pctx, android.BuildParams{
1194 Rule: android.Cp,
1195 Input: jars[0],
1196 Output: combinedJar,
1197 })
1198 outputFile = combinedJar
1199 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001200 } else {
Colin Cross1ee23172017-10-18 14:44:18 -07001201 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001202 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
Colin Cross9b38aef2018-08-27 15:42:25 -07001203 false, nil, nil)
Colin Crosse9a275b2017-10-16 17:09:48 -07001204 outputFile = combinedJar
1205 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001206
Colin Cross331a1212018-08-15 20:40:52 -07001207 // jarjar implementation jar if necessary
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001208 if j.expandJarjarRules != nil {
Colin Cross8649b262017-09-27 18:03:17 -07001209 // Transform classes.jar into classes-jarjar.jar
Colin Cross1ee23172017-10-18 14:44:18 -07001210 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001211 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
Colin Crosse9a275b2017-10-16 17:09:48 -07001212 outputFile = jarjarFile
Colin Cross331a1212018-08-15 20:40:52 -07001213
1214 // jarjar resource jar if necessary
1215 if j.resourceJar != nil {
1216 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001217 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
Colin Cross331a1212018-08-15 20:40:52 -07001218 j.resourceJar = resourceJarJarFile
1219 }
1220
Colin Cross0a6e0072017-08-30 14:24:55 -07001221 if ctx.Failed() {
1222 return
1223 }
1224 }
Vladimir Marko0975ee02019-04-02 10:29:55 +01001225
1226 // Check package restrictions if necessary.
1227 if len(j.properties.Permitted_packages) > 0 {
1228 // Check packages and copy to package-checked file.
1229 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
1230 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
1231 j.additionalCheckedModules = append(j.additionalCheckedModules, pkgckFile)
1232
1233 if ctx.Failed() {
1234 return
1235 }
1236 }
1237
Nan Zhanged19fc32017-10-19 13:06:22 -07001238 j.implementationJarFile = outputFile
1239 if j.headerJarFile == nil {
1240 j.headerJarFile = j.implementationJarFile
1241 }
Colin Cross2fe66872015-03-30 17:20:39 -07001242
Colin Cross6510f912017-11-29 00:27:14 -08001243 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
Colin Crosscb933592017-11-22 13:49:43 -08001244 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
1245 j.properties.Instrument = true
1246 }
1247 }
1248
Colin Cross3144dfc2018-01-03 15:06:47 -08001249 if j.shouldInstrument(ctx) {
Colin Crosscb933592017-11-22 13:49:43 -08001250 outputFile = j.instrument(ctx, flags, outputFile, jarName)
1251 }
1252
Colin Cross331a1212018-08-15 20:40:52 -07001253 // merge implementation jar with resources if necessary
1254 implementationAndResourcesJar := outputFile
1255 if j.resourceJar != nil {
1256 jars := android.Paths{implementationAndResourcesJar, j.resourceJar}
1257 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
1258 TransformJarsToJar(ctx, combinedJar, "for resources", jars, android.OptionalPath{},
1259 false, nil, nil)
1260 implementationAndResourcesJar = combinedJar
1261 }
1262
1263 j.implementationAndResourcesJar = implementationAndResourcesJar
1264
Colin Cross9ae1b922018-06-26 17:59:05 -07001265 if ctx.Device() && (Bool(j.properties.Installable) || Bool(j.deviceProperties.Compile_dex)) {
Colin Cross8faf8fc2019-01-16 15:15:52 -08001266 // Dex compilation
Colin Cross3063b782018-08-15 11:19:12 -07001267 var dexOutputFile android.ModuleOutPath
David Brazdil17ef5632018-06-27 10:27:45 +01001268 dexOutputFile = j.compileDex(ctx, flags, outputFile, jarName)
Colin Cross2fe66872015-03-30 17:20:39 -07001269 if ctx.Failed() {
1270 return
1271 }
Colin Cross331a1212018-08-15 20:40:52 -07001272
Colin Cross8faf8fc2019-01-16 15:15:52 -08001273 // Hidden API CSV generation and dex encoding
Colin Crossf24a22a2019-01-31 14:12:44 -08001274 dexOutputFile = j.hiddenAPI.hiddenAPI(ctx, dexOutputFile, j.implementationJarFile,
1275 j.deviceProperties.UncompressDex)
Colin Cross8faf8fc2019-01-16 15:15:52 -08001276
Colin Cross331a1212018-08-15 20:40:52 -07001277 // merge dex jar with resources if necessary
1278 if j.resourceJar != nil {
1279 jars := android.Paths{dexOutputFile, j.resourceJar}
1280 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
1281 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1282 false, nil, nil)
Nicolas Geoffrayf3438722019-01-23 15:57:21 +00001283 if j.deviceProperties.UncompressDex {
1284 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
1285 TransformZipAlign(ctx, combinedAlignedJar, combinedJar)
1286 dexOutputFile = combinedAlignedJar
1287 } else {
1288 dexOutputFile = combinedJar
1289 }
Colin Cross331a1212018-08-15 20:40:52 -07001290 }
1291
1292 j.dexJarFile = dexOutputFile
1293
Colin Cross8faf8fc2019-01-16 15:15:52 -08001294 // Dexpreopting
Colin Cross43f08db2018-11-12 10:13:39 -08001295 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
1296
1297 j.maybeStrippedDexJarFile = dexOutputFile
1298
Colin Cross3063b782018-08-15 11:19:12 -07001299 outputFile = dexOutputFile
Colin Cross43f08db2018-11-12 10:13:39 -08001300
1301 if ctx.Failed() {
1302 return
1303 }
Colin Cross331a1212018-08-15 20:40:52 -07001304 } else {
1305 outputFile = implementationAndResourcesJar
Colin Cross2fe66872015-03-30 17:20:39 -07001306 }
Colin Cross331a1212018-08-15 20:40:52 -07001307
Colin Crossb7a63242015-04-16 14:09:14 -07001308 ctx.CheckbuildFile(outputFile)
Colin Cross3063b782018-08-15 11:19:12 -07001309
1310 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1311 j.outputFile = outputFile.WithoutRel()
Colin Cross2fe66872015-03-30 17:20:39 -07001312}
1313
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001314// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1315// since some of these flags may be used internally.
1316func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1317 for _, flag := range flags {
1318 flag = strings.TrimSpace(flag)
1319
1320 if !strings.HasPrefix(flag, "-") {
1321 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1322 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1323 ctx.PropertyErrorf("kotlincflags",
1324 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1325 } else if inList(flag, config.KotlincIllegalFlags) {
1326 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1327 } else if flag == "-include-runtime" {
1328 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1329 } else {
1330 args := strings.Split(flag, " ")
1331 if args[0] == "-kotlin-home" {
1332 ctx.PropertyErrorf("kotlincflags",
1333 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1334 }
1335 }
1336 }
1337}
1338
Colin Cross8eadbf02017-10-24 17:46:00 -07001339func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
Colin Cross55f63ea2018-08-27 12:37:09 -07001340 deps deps, flags javaBuilderFlags, jarName string, extraJars android.Paths) android.Path {
Nan Zhanged19fc32017-10-19 13:06:22 -07001341
1342 var jars android.Paths
Colin Cross8eadbf02017-10-24 17:46:00 -07001343 if len(srcFiles) > 0 || len(srcJars) > 0 {
Nan Zhanged19fc32017-10-19 13:06:22 -07001344 // Compile java sources into turbine.jar.
1345 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1346 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1347 if ctx.Failed() {
1348 return nil
1349 }
1350 jars = append(jars, turbineJar)
1351 }
1352
Colin Cross55f63ea2018-08-27 12:37:09 -07001353 jars = append(jars, extraJars...)
1354
Nan Zhanged19fc32017-10-19 13:06:22 -07001355 // Combine any static header libraries into classes-header.jar. If there is only
1356 // one input jar this step will be skipped.
1357 var headerJar android.Path
1358 jars = append(jars, deps.staticHeaderJars...)
1359
Colin Cross5c6ecc12017-10-23 18:12:27 -07001360 // we cannot skip the combine step for now if there is only one jar
1361 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1362 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001363 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
1364 false, nil, []string{"META-INF"})
Colin Cross5c6ecc12017-10-23 18:12:27 -07001365 headerJar = combinedJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001366
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001367 if j.expandJarjarRules != nil {
Nan Zhanged19fc32017-10-19 13:06:22 -07001368 // Transform classes.jar into classes-jarjar.jar
1369 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001370 TransformJarJar(ctx, jarjarFile, headerJar, j.expandJarjarRules)
Nan Zhanged19fc32017-10-19 13:06:22 -07001371 headerJar = jarjarFile
1372 if ctx.Failed() {
1373 return nil
1374 }
1375 }
1376
1377 return headerJar
1378}
1379
Colin Crosscb933592017-11-22 13:49:43 -08001380func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross3063b782018-08-15 11:19:12 -07001381 classesJar android.Path, jarName string) android.ModuleOutPath {
Colin Crosscb933592017-11-22 13:49:43 -08001382
Colin Cross7a3139e2017-12-19 13:57:50 -08001383 specs := j.jacocoModuleToZipCommand(ctx)
Colin Crosscb933592017-11-22 13:49:43 -08001384
Colin Cross84c38822018-01-03 15:59:46 -08001385 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Crosscb933592017-11-22 13:49:43 -08001386 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
1387
1388 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1389
1390 j.jacocoReportClassesFile = jacocoReportClassesFile
1391
1392 return instrumentedJar
1393}
1394
albaltai36ff7dc2018-12-25 14:35:23 +08001395var _ Dependency = (*Module)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001396
Nan Zhanged19fc32017-10-19 13:06:22 -07001397func (j *Module) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001398 if j.headerJarFile == nil {
1399 return nil
1400 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001401 return android.Paths{j.headerJarFile}
1402}
1403
1404func (j *Module) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08001405 if j.implementationJarFile == nil {
1406 return nil
1407 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001408 return android.Paths{j.implementationJarFile}
Colin Cross2fe66872015-03-30 17:20:39 -07001409}
1410
Colin Crossf24a22a2019-01-31 14:12:44 -08001411func (j *Module) DexJar() android.Path {
1412 return j.dexJarFile
1413}
1414
Colin Cross331a1212018-08-15 20:40:52 -07001415func (j *Module) ResourceJars() android.Paths {
1416 if j.resourceJar == nil {
1417 return nil
1418 }
1419 return android.Paths{j.resourceJar}
1420}
1421
1422func (j *Module) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001423 if j.implementationAndResourcesJar == nil {
1424 return nil
1425 }
Colin Cross331a1212018-08-15 20:40:52 -07001426 return android.Paths{j.implementationAndResourcesJar}
1427}
1428
Colin Cross46c9b8b2017-06-22 16:51:17 -07001429func (j *Module) AidlIncludeDirs() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001430 // exportAidlIncludeDirs is type android.Paths already
Colin Crossc0b06f12015-04-08 13:03:43 -07001431 return j.exportAidlIncludeDirs
1432}
1433
Jiyong Park1be96912018-05-28 18:02:19 +09001434func (j *Module) ExportedSdkLibs() []string {
albaltai36ff7dc2018-12-25 14:35:23 +08001435 // exportedSdkLibs is type []string
Jiyong Park1be96912018-05-28 18:02:19 +09001436 return j.exportedSdkLibs
1437}
1438
Colin Cross46c9b8b2017-06-22 16:51:17 -07001439var _ logtagsProducer = (*Module)(nil)
Colin Crossf05fe972015-04-10 17:45:20 -07001440
Colin Cross46c9b8b2017-06-22 16:51:17 -07001441func (j *Module) logtags() android.Paths {
Colin Crossf05fe972015-04-10 17:45:20 -07001442 return j.logtagsSrcs
1443}
1444
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001445// Collect information for opening IDE project files in java/jdeps.go.
1446func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
1447 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
1448 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
1449 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001450 if j.expandJarjarRules != nil {
1451 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001452 }
1453}
1454
1455func (j *Module) CompilerDeps() []string {
1456 jdeps := []string{}
1457 jdeps = append(jdeps, j.properties.Libs...)
1458 jdeps = append(jdeps, j.properties.Static_libs...)
1459 return jdeps
1460}
1461
Colin Cross2fe66872015-03-30 17:20:39 -07001462//
1463// Java libraries (.jar file)
1464//
1465
Colin Crossf506d872017-07-19 15:53:04 -07001466type Library struct {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001467 Module
Colin Cross2fe66872015-03-30 17:20:39 -07001468}
1469
Colin Cross42be7612019-02-21 18:12:14 -08001470func shouldUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter) bool {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001471 // Store uncompressed (and do not strip) dex files from boot class path jars.
1472 if inList(ctx.ModuleName(), ctx.Config().BootJars()) {
1473 return true
1474 }
1475
1476 // Store uncompressed dex files that are preopted on /system.
Colin Cross42be7612019-02-21 18:12:14 -08001477 if !dexpreopter.dexpreoptDisabled(ctx) && (ctx.Host() || !odexOnSystemOther(ctx, dexpreopter.installPath)) {
Vladimir Markoe8b00d62018-12-21 15:54:16 +00001478 return true
1479 }
Colin Cross083a2aa2019-02-06 16:37:12 -08001480 if ctx.Config().UncompressPrivAppDex() &&
1481 inList(ctx.ModuleName(), ctx.Config().ModulesLoadedByPrivilegedModules()) {
1482 return true
1483 }
1484
Colin Cross2fc72f62018-12-21 12:59:54 -08001485 return false
1486}
1487
Colin Crossf506d872017-07-19 15:53:04 -07001488func (j *Library) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross43f08db2018-11-12 10:13:39 -08001489 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", ctx.ModuleName()+".jar")
1490 j.dexpreopter.isSDKLibrary = j.deviceProperties.IsSDKLibrary
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001491 j.dexpreopter.isInstallable = Bool(j.properties.Installable)
Colin Cross42be7612019-02-21 18:12:14 -08001492 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001493 j.deviceProperties.UncompressDex = j.dexpreopter.uncompressedDex
Colin Cross46c9b8b2017-06-22 16:51:17 -07001494 j.compile(ctx)
Colin Crossb7a63242015-04-16 14:09:14 -07001495
Nicolas Geoffray4bdea392019-01-15 11:48:08 +00001496 if (Bool(j.properties.Installable) || ctx.Host()) && !android.DirectlyInAnyApex(ctx, ctx.ModuleName()) {
Colin Cross2c429dc2017-08-31 16:45:16 -07001497 j.installFile = ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
1498 ctx.ModuleName()+".jar", j.outputFile)
1499 }
Colin Crossb7a63242015-04-16 14:09:14 -07001500}
1501
Colin Crossf506d872017-07-19 15:53:04 -07001502func (j *Library) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001503 j.deps(ctx)
1504}
1505
Colin Cross1b16b0e2019-02-12 14:41:32 -08001506// java_library builds and links sources into a `.jar` file for the device, and possibly for the host as well.
1507//
1508// By default, a java_library has a single variant that produces a `.jar` file containing `.class` files that were
1509// compiled against the device bootclasspath. This jar is not suitable for installing on a device, but can be used
1510// as a `static_libs` dependency of another module.
1511//
1512// Specifying `installable: true` will product a `.jar` file containing `classes.dex` files, suitable for installing on
1513// a device.
1514//
1515// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1516// compiled against the host bootclasspath.
Colin Cross9ae1b922018-06-26 17:59:05 -07001517func LibraryFactory() android.Module {
1518 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07001519
Colin Cross9ae1b922018-06-26 17:59:05 -07001520 module.AddProperties(
1521 &module.Module.properties,
1522 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001523 &module.Module.dexpreoptProperties,
Colin Cross9ae1b922018-06-26 17:59:05 -07001524 &module.Module.protoProperties)
Colin Cross2fe66872015-03-30 17:20:39 -07001525
Colin Cross9ae1b922018-06-26 17:59:05 -07001526 InitJavaModule(module, android.HostAndDeviceSupported)
1527 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001528}
1529
Colin Cross1b16b0e2019-02-12 14:41:32 -08001530// java_library_static is an obsolete alias for java_library.
1531func LibraryStaticFactory() android.Module {
1532 return LibraryFactory()
1533}
1534
1535// java_library_host builds and links sources into a `.jar` file for the host.
1536//
1537// A java_library_host has a single variant that produces a `.jar` file containing `.class` files that were
1538// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001539func LibraryHostFactory() android.Module {
1540 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07001541
Colin Cross6af17aa2017-09-20 12:59:05 -07001542 module.AddProperties(
1543 &module.Module.properties,
1544 &module.Module.protoProperties)
Colin Cross36242852017-06-23 15:06:31 -07001545
Colin Cross9ae1b922018-06-26 17:59:05 -07001546 module.Module.properties.Installable = proptools.BoolPtr(true)
1547
Colin Cross89536d42017-07-07 14:35:50 -07001548 InitJavaModule(module, android.HostSupported)
Colin Cross36242852017-06-23 15:06:31 -07001549 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001550}
1551
1552//
Colin Crossb628ea52018-08-14 16:42:33 -07001553// Java Tests
Colin Cross05638fc2018-04-09 18:40:24 -07001554//
1555
1556type testProperties struct {
Colin Cross05638fc2018-04-09 18:40:24 -07001557 // list of compatibility suites (for example "cts", "vts") that the module should be
1558 // installed into.
1559 Test_suites []string `android:"arch_variant"`
Julien Despreze146e392018-08-02 15:00:46 -07001560
1561 // the name of the test configuration (for example "AndroidTest.xml") that should be
1562 // installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08001563 Test_config *string `android:"path,arch_variant"`
Colin Crossd96ca352018-08-10 16:06:24 -07001564
Jack He33338892018-09-19 02:21:28 -07001565 // the name of the test configuration template (for example "AndroidTestTemplate.xml") that
1566 // should be installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08001567 Test_config_template *string `android:"path,arch_variant"`
Jack He33338892018-09-19 02:21:28 -07001568
Colin Crossd96ca352018-08-10 16:06:24 -07001569 // list of files or filegroup modules that provide data that should be installed alongside
1570 // the test
Colin Cross27b922f2019-03-04 22:35:41 -08001571 Data []string `android:"path"`
Colin Cross05638fc2018-04-09 18:40:24 -07001572}
1573
Paul Duffin42df1442019-03-20 12:45:53 +00001574type testHelperLibraryProperties struct {
1575 // list of compatibility suites (for example "cts", "vts") that the module should be
1576 // installed into.
1577 Test_suites []string `android:"arch_variant"`
1578}
1579
Colin Cross05638fc2018-04-09 18:40:24 -07001580type Test struct {
1581 Library
1582
1583 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07001584
1585 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07001586 data android.Paths
Colin Cross303e21f2018-08-07 16:49:25 -07001587}
1588
Paul Duffin42df1442019-03-20 12:45:53 +00001589type TestHelperLibrary struct {
1590 Library
1591
1592 testHelperLibraryProperties testHelperLibraryProperties
1593}
1594
Colin Cross303e21f2018-08-07 16:49:25 -07001595func (j *Test) GenerateAndroidBuildActions(ctx android.ModuleContext) {
yangbill4f41bc22019-02-13 21:45:47 +08001596 j.testConfig = tradefed.AutoGenJavaTestConfig(ctx, j.testProperties.Test_config, j.testProperties.Test_config_template, j.testProperties.Test_suites)
Colin Cross8a497952019-03-05 22:25:09 -08001597 j.data = android.PathsForModuleSrc(ctx, j.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07001598
1599 j.Library.GenerateAndroidBuildActions(ctx)
Colin Cross05638fc2018-04-09 18:40:24 -07001600}
1601
Paul Duffin42df1442019-03-20 12:45:53 +00001602func (j *TestHelperLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1603 j.Library.GenerateAndroidBuildActions(ctx)
1604}
1605
Colin Cross1b16b0e2019-02-12 14:41:32 -08001606// java_test builds a and links sources into a `.jar` file for the device, and possibly for the host as well, and
1607// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
1608//
1609// By default, a java_test has a single variant that produces a `.jar` file containing `classes.dex` files that were
1610// compiled against the device bootclasspath.
1611//
1612// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1613// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07001614func TestFactory() android.Module {
1615 module := &Test{}
1616
1617 module.AddProperties(
1618 &module.Module.properties,
1619 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001620 &module.Module.dexpreoptProperties,
Colin Cross05638fc2018-04-09 18:40:24 -07001621 &module.Module.protoProperties,
1622 &module.testProperties)
1623
Colin Cross9ae1b922018-06-26 17:59:05 -07001624 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse3026872019-01-05 22:30:13 -08001625 module.Module.dexpreopter.isTest = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001626
Colin Cross05638fc2018-04-09 18:40:24 -07001627 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07001628 return module
1629}
1630
Paul Duffin42df1442019-03-20 12:45:53 +00001631// java_test_helper_library creates a java library and makes sure that it is added to the appropriate test suite.
1632func TestHelperLibraryFactory() android.Module {
1633 module := &TestHelperLibrary{}
1634
1635 module.AddProperties(
1636 &module.Module.properties,
1637 &module.Module.deviceProperties,
1638 &module.Module.dexpreoptProperties,
1639 &module.Module.protoProperties,
1640 &module.testHelperLibraryProperties)
1641
1642 InitJavaModule(module, android.HostAndDeviceSupported)
1643 return module
1644}
1645
Colin Cross1b16b0e2019-02-12 14:41:32 -08001646// java_test_host builds a and links sources into a `.jar` file for the host, and creates an `AndroidTest.xml` file to
1647// allow running the test with `atest` or a `TEST_MAPPING` file.
1648//
1649// A java_test_host has a single variant that produces a `.jar` file containing `.class` files that were
1650// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07001651func TestHostFactory() android.Module {
1652 module := &Test{}
1653
1654 module.AddProperties(
1655 &module.Module.properties,
1656 &module.Module.protoProperties,
1657 &module.testProperties)
1658
Colin Cross9ae1b922018-06-26 17:59:05 -07001659 module.Module.properties.Installable = proptools.BoolPtr(true)
1660
Colin Cross05638fc2018-04-09 18:40:24 -07001661 InitJavaModule(module, android.HostSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07001662 return module
1663}
1664
1665//
Colin Cross2fe66872015-03-30 17:20:39 -07001666// Java Binaries (.jar file plus wrapper script)
1667//
1668
Colin Crossf506d872017-07-19 15:53:04 -07001669type binaryProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -07001670 // installable script to execute the resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -08001671 Wrapper *string `android:"path"`
Colin Cross094054a2018-10-17 15:10:48 -07001672
1673 // Name of the class containing main to be inserted into the manifest as Main-Class.
1674 Main_class *string
Colin Cross7d5136f2015-05-11 13:39:40 -07001675}
1676
Colin Crossf506d872017-07-19 15:53:04 -07001677type Binary struct {
1678 Library
Colin Cross2fe66872015-03-30 17:20:39 -07001679
Colin Crossf506d872017-07-19 15:53:04 -07001680 binaryProperties binaryProperties
Colin Cross10a03492017-08-10 17:09:43 -07001681
Colin Cross6b4a32d2017-12-05 13:42:45 -08001682 isWrapperVariant bool
1683
Colin Crossc3315992017-12-08 19:12:36 -08001684 wrapperFile android.Path
Colin Cross10a03492017-08-10 17:09:43 -07001685 binaryFile android.OutputPath
Colin Cross2fe66872015-03-30 17:20:39 -07001686}
1687
Alex Light24237172017-10-26 09:46:21 -07001688func (j *Binary) HostToolPath() android.OptionalPath {
1689 return android.OptionalPathForPath(j.binaryFile)
1690}
1691
Colin Crossf506d872017-07-19 15:53:04 -07001692func (j *Binary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001693 if ctx.Arch().ArchType == android.Common {
1694 // Compile the jar
Colin Cross094054a2018-10-17 15:10:48 -07001695 if j.binaryProperties.Main_class != nil {
1696 if j.properties.Manifest != nil {
1697 ctx.PropertyErrorf("main_class", "main_class cannot be used when manifest is set")
1698 }
1699 manifestFile := android.PathForModuleOut(ctx, "manifest.txt")
1700 GenerateMainClassManifest(ctx, manifestFile, String(j.binaryProperties.Main_class))
1701 j.overrideManifest = android.OptionalPathForPath(manifestFile)
1702 }
1703
Colin Cross6b4a32d2017-12-05 13:42:45 -08001704 j.Library.GenerateAndroidBuildActions(ctx)
Nan Zhang3c807db2017-11-03 14:53:31 -07001705 } else {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001706 // Handle the binary wrapper
1707 j.isWrapperVariant = true
1708
Colin Cross366938f2017-12-11 16:29:02 -08001709 if j.binaryProperties.Wrapper != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001710 j.wrapperFile = android.PathForModuleSrc(ctx, *j.binaryProperties.Wrapper)
Colin Cross6b4a32d2017-12-05 13:42:45 -08001711 } else {
1712 j.wrapperFile = android.PathForSource(ctx, "build/soong/scripts/jar-wrapper.sh")
1713 }
1714
1715 // Depend on the installed jar so that the wrapper doesn't get executed by
1716 // another build rule before the jar has been installed.
1717 jarFile := ctx.PrimaryModule().(*Binary).installFile
1718
1719 j.binaryFile = ctx.InstallExecutable(android.PathForModuleInstall(ctx, "bin"),
1720 ctx.ModuleName(), j.wrapperFile, jarFile)
Nan Zhang3c807db2017-11-03 14:53:31 -07001721 }
Colin Cross2fe66872015-03-30 17:20:39 -07001722}
1723
Colin Crossf506d872017-07-19 15:53:04 -07001724func (j *Binary) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001725 if ctx.Arch().ArchType == android.Common {
1726 j.deps(ctx)
1727 }
Colin Cross46c9b8b2017-06-22 16:51:17 -07001728}
1729
Colin Cross1b16b0e2019-02-12 14:41:32 -08001730// java_binary builds a `.jar` file and a shell script that executes it for the device, and possibly for the host
1731// as well.
1732//
1733// By default, a java_binary has a single variant that produces a `.jar` file containing `classes.dex` files that were
1734// compiled against the device bootclasspath.
1735//
1736// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1737// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001738func BinaryFactory() android.Module {
1739 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07001740
Colin Cross36242852017-06-23 15:06:31 -07001741 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07001742 &module.Module.properties,
1743 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001744 &module.Module.dexpreoptProperties,
Colin Cross6af17aa2017-09-20 12:59:05 -07001745 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07001746 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07001747
Colin Cross9ae1b922018-06-26 17:59:05 -07001748 module.Module.properties.Installable = proptools.BoolPtr(true)
1749
Colin Cross6b4a32d2017-12-05 13:42:45 -08001750 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibCommonFirst)
1751 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07001752 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001753}
1754
Colin Cross1b16b0e2019-02-12 14:41:32 -08001755// java_binary_host builds a `.jar` file and a shell script that executes it for the host.
1756//
1757// A java_binary_host has a single variant that produces a `.jar` file containing `.class` files that were
1758// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001759func BinaryHostFactory() android.Module {
1760 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07001761
Colin Cross36242852017-06-23 15:06:31 -07001762 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07001763 &module.Module.properties,
Colin Cross6af17aa2017-09-20 12:59:05 -07001764 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07001765 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07001766
Colin Cross9ae1b922018-06-26 17:59:05 -07001767 module.Module.properties.Installable = proptools.BoolPtr(true)
1768
Colin Cross6b4a32d2017-12-05 13:42:45 -08001769 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommonFirst)
1770 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07001771 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001772}
1773
1774//
1775// Java prebuilts
1776//
1777
Colin Cross74d73e22017-08-02 11:05:49 -07001778type ImportProperties struct {
Colin Cross27b922f2019-03-04 22:35:41 -08001779 Jars []string `android:"path"`
Colin Cross461bd1a2017-10-20 13:59:18 -07001780
Nan Zhangea568a42017-11-08 21:20:04 -08001781 Sdk_version *string
Colin Cross535e2cf2017-10-20 17:57:49 -07001782
1783 Installable *bool
Jiyong Park1be96912018-05-28 18:02:19 +09001784
1785 // List of shared java libs that this module has dependencies to
1786 Libs []string
Colin Cross37f6d792018-07-12 12:28:41 -07001787
1788 // List of files to remove from the jar file(s)
1789 Exclude_files []string
1790
1791 // List of directories to remove from the jar file(s)
1792 Exclude_dirs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -07001793
1794 // if set to true, run Jetifier against .jar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -07001795 Jetifier *bool
Colin Cross74d73e22017-08-02 11:05:49 -07001796}
1797
1798type Import struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001799 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -07001800 android.DefaultableModuleBase
Colin Crossec7a0422017-07-07 14:47:12 -07001801 prebuilt android.Prebuilt
Colin Cross2fe66872015-03-30 17:20:39 -07001802
Colin Cross74d73e22017-08-02 11:05:49 -07001803 properties ImportProperties
1804
Colin Cross0a6e0072017-08-30 14:24:55 -07001805 combinedClasspathFile android.Path
Jiyong Park1be96912018-05-28 18:02:19 +09001806 exportedSdkLibs []string
Colin Cross2fe66872015-03-30 17:20:39 -07001807}
1808
Colin Cross83bb3162018-06-25 15:48:06 -07001809func (j *Import) sdkVersion() string {
1810 return String(j.properties.Sdk_version)
1811}
1812
1813func (j *Import) minSdkVersion() string {
1814 return j.sdkVersion()
1815}
1816
Colin Cross74d73e22017-08-02 11:05:49 -07001817func (j *Import) Prebuilt() *android.Prebuilt {
Colin Crossec7a0422017-07-07 14:47:12 -07001818 return &j.prebuilt
1819}
1820
Colin Cross74d73e22017-08-02 11:05:49 -07001821func (j *Import) PrebuiltSrcs() []string {
1822 return j.properties.Jars
1823}
1824
1825func (j *Import) Name() string {
Colin Cross5ea9bcc2017-07-27 15:41:32 -07001826 return j.prebuilt.Name(j.ModuleBase.Name())
1827}
1828
Colin Cross74d73e22017-08-02 11:05:49 -07001829func (j *Import) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross42d48b72018-08-29 14:10:52 -07001830 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Colin Cross1e676be2016-10-12 14:38:15 -07001831}
1832
Colin Cross74d73e22017-08-02 11:05:49 -07001833func (j *Import) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross8a497952019-03-05 22:25:09 -08001834 jars := android.PathsForModuleSrc(ctx, j.properties.Jars)
Colin Crosse1d62a82015-04-03 16:53:05 -07001835
Nan Zhang4c819fb2018-08-27 18:31:46 -07001836 jarName := ctx.ModuleName() + ".jar"
1837 outputFile := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001838 TransformJarsToJar(ctx, outputFile, "for prebuilts", jars, android.OptionalPath{},
1839 false, j.properties.Exclude_files, j.properties.Exclude_dirs)
Colin Cross1001a792019-03-21 22:21:39 -07001840 if Bool(j.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -07001841 inputFile := outputFile
1842 outputFile = android.PathForModuleOut(ctx, "jetifier", jarName)
1843 TransformJetifier(ctx, outputFile, inputFile)
1844 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001845 j.combinedClasspathFile = outputFile
Jiyong Park1be96912018-05-28 18:02:19 +09001846
1847 ctx.VisitDirectDeps(func(module android.Module) {
1848 otherName := ctx.OtherModuleName(module)
1849 tag := ctx.OtherModuleDependencyTag(module)
1850
1851 switch dep := module.(type) {
1852 case Dependency:
1853 switch tag {
1854 case libTag, staticLibTag:
1855 // sdk lib names from dependencies are re-exported
1856 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
1857 }
1858 case SdkLibraryDependency:
1859 switch tag {
1860 case libTag:
1861 // names of sdk libs that are directly depended are exported
1862 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
1863 }
1864 }
1865 })
1866
1867 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
Nan Zhang4973ecf2018-08-10 13:42:12 -07001868 if Bool(j.properties.Installable) {
1869 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
1870 ctx.ModuleName()+".jar", outputFile)
1871 }
Colin Cross2fe66872015-03-30 17:20:39 -07001872}
1873
Colin Cross74d73e22017-08-02 11:05:49 -07001874var _ Dependency = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001875
Nan Zhanged19fc32017-10-19 13:06:22 -07001876func (j *Import) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001877 if j.combinedClasspathFile == nil {
1878 return nil
1879 }
Colin Cross37f6d792018-07-12 12:28:41 -07001880 return android.Paths{j.combinedClasspathFile}
Nan Zhanged19fc32017-10-19 13:06:22 -07001881}
1882
1883func (j *Import) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08001884 if j.combinedClasspathFile == nil {
1885 return nil
1886 }
Colin Cross37f6d792018-07-12 12:28:41 -07001887 return android.Paths{j.combinedClasspathFile}
Colin Cross2fe66872015-03-30 17:20:39 -07001888}
1889
Colin Cross331a1212018-08-15 20:40:52 -07001890func (j *Import) ResourceJars() android.Paths {
1891 return nil
1892}
1893
1894func (j *Import) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001895 if j.combinedClasspathFile == nil {
1896 return nil
1897 }
Colin Cross331a1212018-08-15 20:40:52 -07001898 return android.Paths{j.combinedClasspathFile}
1899}
1900
Colin Crossf24a22a2019-01-31 14:12:44 -08001901func (j *Import) DexJar() android.Path {
1902 return nil
1903}
1904
Colin Cross74d73e22017-08-02 11:05:49 -07001905func (j *Import) AidlIncludeDirs() android.Paths {
Colin Crossc0b06f12015-04-08 13:03:43 -07001906 return nil
1907}
1908
Jiyong Park1be96912018-05-28 18:02:19 +09001909func (j *Import) ExportedSdkLibs() []string {
1910 return j.exportedSdkLibs
1911}
1912
albaltai36ff7dc2018-12-25 14:35:23 +08001913// Add compile time check for interface implementation
1914var _ android.IDEInfo = (*Import)(nil)
1915var _ android.IDECustomizedModuleName = (*Import)(nil)
1916
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001917// Collect information for opening IDE project files in java/jdeps.go.
1918const (
1919 removedPrefix = "prebuilt_"
1920)
1921
1922func (j *Import) IDEInfo(dpInfo *android.IdeInfo) {
1923 dpInfo.Jars = append(dpInfo.Jars, j.PrebuiltSrcs()...)
1924}
1925
1926func (j *Import) IDECustomizedModuleName() string {
1927 // TODO(b/113562217): Extract the base module name from the Import name, often the Import name
1928 // has a prefix "prebuilt_". Remove the prefix explicitly if needed until we find a better
1929 // solution to get the Import name.
1930 name := j.Name()
1931 if strings.HasPrefix(name, removedPrefix) {
patricktubb640e02018-10-11 18:33:16 +08001932 name = strings.TrimPrefix(name, removedPrefix)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001933 }
1934 return name
1935}
1936
Colin Cross74d73e22017-08-02 11:05:49 -07001937var _ android.PrebuiltInterface = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001938
Colin Cross1b16b0e2019-02-12 14:41:32 -08001939// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library module.
1940//
1941// By default, a java_import has a single variant that expects a `.jar` file containing `.class` files that were
1942// compiled against an Android classpath.
1943//
1944// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
1945// for host modules.
Colin Cross74d73e22017-08-02 11:05:49 -07001946func ImportFactory() android.Module {
1947 module := &Import{}
Colin Cross36242852017-06-23 15:06:31 -07001948
Colin Cross74d73e22017-08-02 11:05:49 -07001949 module.AddProperties(&module.properties)
1950
1951 android.InitPrebuiltModule(module, &module.properties.Jars)
Colin Cross48de9a42018-10-02 13:53:33 -07001952 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross36242852017-06-23 15:06:31 -07001953 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001954}
1955
Colin Cross1b16b0e2019-02-12 14:41:32 -08001956// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library_host
1957// module.
1958//
1959// A java_import_host has a single variant that expects a `.jar` file containing `.class` files that were
1960// compiled against a host bootclasspath.
Colin Cross74d73e22017-08-02 11:05:49 -07001961func ImportFactoryHost() android.Module {
1962 module := &Import{}
1963
1964 module.AddProperties(&module.properties)
1965
1966 android.InitPrebuiltModule(module, &module.properties.Jars)
Colin Cross48de9a42018-10-02 13:53:33 -07001967 InitJavaModule(module, android.HostSupported)
Colin Cross74d73e22017-08-02 11:05:49 -07001968 return module
1969}
1970
Colin Cross42be7612019-02-21 18:12:14 -08001971// dex_import module
1972
1973type DexImportProperties struct {
1974 Jars []string
1975}
1976
1977type DexImport struct {
1978 android.ModuleBase
1979 android.DefaultableModuleBase
1980 prebuilt android.Prebuilt
1981
1982 properties DexImportProperties
1983
1984 dexJarFile android.Path
1985 maybeStrippedDexJarFile android.Path
1986
1987 dexpreopter
1988}
1989
1990func (j *DexImport) Prebuilt() *android.Prebuilt {
1991 return &j.prebuilt
1992}
1993
1994func (j *DexImport) PrebuiltSrcs() []string {
1995 return j.properties.Jars
1996}
1997
1998func (j *DexImport) Name() string {
1999 return j.prebuilt.Name(j.ModuleBase.Name())
2000}
2001
2002func (j *DexImport) DepsMutator(ctx android.BottomUpMutatorContext) {
2003 android.ExtractSourcesDeps(ctx, j.properties.Jars)
2004}
2005
2006func (j *DexImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2007 if len(j.properties.Jars) != 1 {
2008 ctx.PropertyErrorf("jars", "exactly one jar must be provided")
2009 }
2010
2011 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", ctx.ModuleName()+".jar")
2012 j.dexpreopter.isInstallable = true
2013 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
2014
2015 inputJar := ctx.ExpandSource(j.properties.Jars[0], "jars")
2016 dexOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar")
2017
2018 if j.dexpreopter.uncompressedDex {
2019 rule := android.NewRuleBuilder()
2020
2021 temporary := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar.unaligned")
2022 rule.Temporary(temporary)
2023
2024 // use zip2zip to uncompress classes*.dex files
2025 rule.Command().
2026 Tool(ctx.Config().HostToolPath(ctx, "zip2zip")).
2027 FlagWithInput("-i ", inputJar).
2028 FlagWithOutput("-o ", temporary).
2029 FlagWithArg("-0 ", "'classes*.dex'")
2030
2031 // use zipalign to align uncompressed classes*.dex files
2032 rule.Command().
2033 Tool(ctx.Config().HostToolPath(ctx, "zipalign")).
2034 Flag("-f").
2035 Text("4").
2036 Input(temporary).
2037 Output(dexOutputFile)
2038
2039 rule.DeleteTemporaryFiles()
2040
2041 rule.Build(pctx, ctx, "uncompress_dex", "uncompress dex")
2042 } else {
2043 ctx.Build(pctx, android.BuildParams{
2044 Rule: android.Cp,
2045 Input: inputJar,
2046 Output: dexOutputFile,
2047 })
2048 }
2049
2050 j.dexJarFile = dexOutputFile
2051
2052 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
2053
2054 j.maybeStrippedDexJarFile = dexOutputFile
2055
2056 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
2057 ctx.ModuleName()+".jar", dexOutputFile)
2058}
2059
2060func (j *DexImport) DexJar() android.Path {
2061 return j.dexJarFile
2062}
2063
2064// dex_import imports a `.jar` file containing classes.dex files.
2065//
2066// A dex_import module cannot be used as a dependency of a java_* or android_* module, it can only be installed
2067// to the device.
2068func DexImportFactory() android.Module {
2069 module := &DexImport{}
2070
2071 module.AddProperties(&module.properties)
2072
2073 android.InitPrebuiltModule(module, &module.properties.Jars)
2074 InitJavaModule(module, android.DeviceSupported)
2075 return module
2076}
2077
Colin Cross89536d42017-07-07 14:35:50 -07002078//
2079// Defaults
2080//
2081type Defaults struct {
2082 android.ModuleBase
2083 android.DefaultsModuleBase
2084}
2085
2086func (*Defaults) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2087}
2088
Colin Cross1b16b0e2019-02-12 14:41:32 -08002089// java_defaults provides a set of properties that can be inherited by other java or android modules.
2090//
2091// A module can use the properties from a java_defaults module using `defaults: ["defaults_module_name"]`. Each
2092// property in the defaults module that exists in the depending module will be prepended to the depending module's
2093// value for that property.
2094//
2095// Example:
2096//
2097// java_defaults {
2098// name: "example_defaults",
2099// srcs: ["common/**/*.java"],
2100// javacflags: ["-Xlint:all"],
2101// aaptflags: ["--auto-add-overlay"],
2102// }
2103//
2104// java_library {
2105// name: "example",
2106// defaults: ["example_defaults"],
2107// srcs: ["example/**/*.java"],
2108// }
2109//
2110// is functionally identical to:
2111//
2112// java_library {
2113// name: "example",
2114// srcs: [
2115// "common/**/*.java",
2116// "example/**/*.java",
2117// ],
2118// javacflags: ["-Xlint:all"],
2119// }
Colin Cross89536d42017-07-07 14:35:50 -07002120func defaultsFactory() android.Module {
2121 return DefaultsFactory()
2122}
2123
2124func DefaultsFactory(props ...interface{}) android.Module {
2125 module := &Defaults{}
2126
2127 module.AddProperties(props...)
2128 module.AddProperties(
2129 &CompilerProperties{},
2130 &CompilerDeviceProperties{},
Colin Cross43f08db2018-11-12 10:13:39 -08002131 &DexpreoptProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08002132 &android.ProtoProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002133 &aaptProperties{},
2134 &androidLibraryProperties{},
2135 &appProperties{},
2136 &appTestProperties{},
Jaewoong Jung525443a2019-02-28 15:35:54 -08002137 &overridableAppProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002138 &ImportProperties{},
2139 &AARImportProperties{},
2140 &sdkLibraryProperties{},
Colin Cross42be7612019-02-21 18:12:14 -08002141 &DexImportProperties{},
Colin Cross89536d42017-07-07 14:35:50 -07002142 )
2143
2144 android.InitDefaultsModule(module)
2145
2146 return module
2147}
Nan Zhangea568a42017-11-08 21:20:04 -08002148
2149var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07002150var BoolDefault = proptools.BoolDefault
Nan Zhangea568a42017-11-08 21:20:04 -08002151var String = proptools.String
Colin Cross0d0ba592018-02-20 13:33:42 -08002152var inList = android.InList