blob: f3e10bebd8aab2e53e80eeb717c2ca863f2eacde [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
Colin Cross7d5136f2015-05-11 13:39:40 -070085 // list of module-specific flags that will be used for javac compiles
86 Javacflags []string `android:"arch_variant"`
87
Zoran Jovanovic8736ce22018-08-21 17:10:29 +020088 // list of module-specific flags that will be used for kotlinc compiles
89 Kotlincflags []string `android:"arch_variant"`
90
Colin Cross7d5136f2015-05-11 13:39:40 -070091 // list of of java libraries that will be in the classpath
Colin Crosse8dc34a2017-07-19 11:22:16 -070092 Libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -070093
94 // list of java libraries that will be compiled into the resulting jar
Colin Crosse8dc34a2017-07-19 11:22:16 -070095 Static_libs []string `android:"arch_variant"`
Colin Cross7d5136f2015-05-11 13:39:40 -070096
97 // manifest file to be included in resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -080098 Manifest *string `android:"path"`
Colin Cross7d5136f2015-05-11 13:39:40 -070099
Colin Cross540eff82017-06-22 17:01:52 -0700100 // if not blank, run jarjar using the specified rules file
Colin Cross27b922f2019-03-04 22:35:41 -0800101 Jarjar_rules *string `android:"path,arch_variant"`
Colin Cross64162712017-08-08 13:17:59 -0700102
103 // If not blank, set the java version passed to javac as -source and -target
104 Java_version *string
Colin Cross2c429dc2017-08-31 16:45:16 -0700105
Colin Cross9ae1b922018-06-26 17:59:05 -0700106 // If set to true, allow this module to be dexed and installed on devices. Has no
107 // effect on host modules, which are always considered installable.
Colin Cross2c429dc2017-08-31 16:45:16 -0700108 Installable *bool
Colin Cross32f676a2017-09-06 13:41:06 -0700109
Colin Cross0f37af02017-09-27 17:42:05 -0700110 // If set to true, include sources used to compile the module in to the final jar
111 Include_srcs *bool
112
Vladimir Marko0975ee02019-04-02 10:29:55 +0100113 // If not empty, classes are restricted to the specified packages and their sub-packages.
114 // This restriction is checked after applying jarjar rules and including static libs.
115 Permitted_packages []string
116
Colin Crossbe9cdb82019-01-21 21:37:16 -0800117 // List of modules to use as annotation processors
118 Plugins []string
Colin Cross1369cdb2017-09-29 17:58:17 -0700119
Nan Zhang61eaedb2017-11-02 13:28:15 -0700120 // The number of Java source entries each Javac instance can process
121 Javac_shard_size *int64
122
Nan Zhang5f8cb422018-02-06 10:34:32 -0800123 // Add host jdk tools.jar to bootclasspath
124 Use_tools_jar *bool
125
Colin Cross1369cdb2017-09-29 17:58:17 -0700126 Openjdk9 struct {
127 // List of source files that should only be used when passing -source 1.9
Colin Cross27b922f2019-03-04 22:35:41 -0800128 Srcs []string `android:"path"`
Colin Cross1369cdb2017-09-29 17:58:17 -0700129
130 // List of javac flags that should only be used when passing -source 1.9
131 Javacflags []string
132 }
Colin Crosscb933592017-11-22 13:49:43 -0800133
Colin Cross81440082018-08-15 20:21:55 -0700134 // When compiling language level 9+ .java code in packages that are part of
135 // a system module, patch_module names the module that your sources and
136 // dependencies should be patched into. The Android runtime currently
137 // doesn't implement the JEP 261 module system so this option is only
138 // supported at compile time. It should only be needed to compile tests in
139 // packages that exist in libcore and which are inconvenient to move
140 // elsewhere.
Tobias Thiererdda713d2018-09-19 16:16:19 +0100141 Patch_module *string `android:"arch_variant"`
Colin Cross81440082018-08-15 20:21:55 -0700142
Colin Crosscb933592017-11-22 13:49:43 -0800143 Jacoco struct {
144 // List of classes to include for instrumentation with jacoco to collect coverage
145 // information at runtime when building with coverage enabled. If unset defaults to all
146 // classes.
147 // Supports '*' as the last character of an entry in the list as a wildcard match.
148 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
149 // it matches classes in the package that have the class name as a prefix.
150 Include_filter []string
151
152 // List of classes to exclude from instrumentation with jacoco to collect coverage
153 // information at runtime when building with coverage enabled. Overrides classes selected
154 // by the include_filter property.
155 // Supports '*' as the last character of an entry in the list as a wildcard match.
156 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
157 // it matches classes in the package that have the class name as a prefix.
158 Exclude_filter []string
159 }
160
Andreas Gampef3e5b552018-01-22 21:27:21 -0800161 Errorprone struct {
162 // List of javac flags that should only be used when running errorprone.
163 Javacflags []string
164 }
165
Colin Cross0f2ee152017-12-14 15:22:43 -0800166 Proto struct {
167 // List of extra options that will be passed to the proto generator.
168 Output_params []string
169 }
170
Colin Crosscb933592017-11-22 13:49:43 -0800171 Instrument bool `blueprint:"mutated"`
Alex Light7f004a72019-02-21 13:27:37 -0800172
173 // List of files to include in the META-INF/services folder of the resulting jar.
Colin Cross27b922f2019-03-04 22:35:41 -0800174 Services []string `android:"path,arch_variant"`
Colin Cross540eff82017-06-22 17:01:52 -0700175}
176
Colin Cross89536d42017-07-07 14:35:50 -0700177type CompilerDeviceProperties struct {
Colin Cross540eff82017-06-22 17:01:52 -0700178 // list of module-specific flags that will be used for dex compiles
179 Dxflags []string `android:"arch_variant"`
180
Colin Cross83bb3162018-06-25 15:48:06 -0700181 // if not blank, set to the version of the sdk to compile against. Defaults to compiling against the current
182 // sdk if platform_apis is not set.
Nan Zhangea568a42017-11-08 21:20:04 -0800183 Sdk_version *string
Colin Cross7d5136f2015-05-11 13:39:40 -0700184
Colin Cross83bb3162018-06-25 15:48:06 -0700185 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
186 // Defaults to sdk_version if not set.
187 Min_sdk_version *string
188
Dan Willemsen419290a2018-10-31 15:28:47 -0700189 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
190 // Defaults to sdk_version if not set.
191 Target_sdk_version *string
192
Colin Cross6af2e492018-05-22 11:12:33 -0700193 // if true, compile against the platform APIs instead of an SDK.
194 Platform_apis *bool
195
Colin Crossebe1a512017-11-14 13:12:14 -0800196 Aidl struct {
197 // Top level directories to pass to aidl tool
198 Include_dirs []string
Colin Cross7d5136f2015-05-11 13:39:40 -0700199
Colin Crossebe1a512017-11-14 13:12:14 -0800200 // Directories rooted at the Android.bp file to pass to aidl tool
201 Local_include_dirs []string
202
203 // directories that should be added as include directories for any aidl sources of modules
204 // that depend on this module, as well as to aidl for this module.
205 Export_include_dirs []string
Martijn Coeneneab15642018-03-09 09:29:59 +0100206
207 // whether to generate traces (for systrace) for this interface
208 Generate_traces *bool
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100209
210 // whether to generate Binder#GetTransaction name method.
211 Generate_get_transaction_name *bool
Colin Crossebe1a512017-11-14 13:12:14 -0800212 }
Colin Cross92430102017-10-09 14:59:32 -0700213
214 // If true, export a copy of the module as a -hostdex module for host testing.
215 Hostdex *bool
Colin Cross1369cdb2017-09-29 17:58:17 -0700216
Colin Cross7f87f4f2019-04-24 13:41:45 -0700217 Target struct {
218 Hostdex struct {
219 // Additional required dependencies to add to -hostdex modules.
220 Required []string
221 }
222 }
223
David Brazdil17ef5632018-06-27 10:27:45 +0100224 // If set to true, compile dex regardless of installable. Defaults to false.
225 Compile_dex *bool
226
Colin Cross66dbc0b2017-12-28 12:23:20 -0800227 Optimize struct {
Colin Crossae5caf52018-05-22 11:11:52 -0700228 // If false, disable all optimization. Defaults to true for android_app and android_test
229 // modules, false for java_library and java_test modules.
Colin Cross66dbc0b2017-12-28 12:23:20 -0800230 Enabled *bool
Sasha Smundak2057f822019-04-16 17:16:58 -0700231 // True if the module containing this has it set by default.
232 EnabledByDefault bool `blueprint:"mutated"`
Colin Cross66dbc0b2017-12-28 12:23:20 -0800233
234 // If true, optimize for size by removing unused code. Defaults to true for apps,
235 // false for libraries and tests.
236 Shrink *bool
237
238 // If true, optimize bytecode. Defaults to false.
239 Optimize *bool
240
241 // If true, obfuscate bytecode. Defaults to false.
242 Obfuscate *bool
243
244 // If true, do not use the flag files generated by aapt that automatically keep
245 // classes referenced by the app manifest. Defaults to false.
246 No_aapt_flags *bool
247
248 // Flags to pass to proguard.
249 Proguard_flags []string
250
251 // Specifies the locations of files containing proguard flags.
Colin Cross27b922f2019-03-04 22:35:41 -0800252 Proguard_flags_files []string `android:"path"`
Colin Cross66dbc0b2017-12-28 12:23:20 -0800253 }
254
Colin Cross1369cdb2017-09-29 17:58:17 -0700255 // When targeting 1.9, override the modules to use with --system
256 System_modules *string
Colin Cross5a0dcd52018-10-05 14:20:06 -0700257
258 UncompressDex bool `blueprint:"mutated"`
Colin Cross43f08db2018-11-12 10:13:39 -0800259 IsSDKLibrary bool `blueprint:"mutated"`
Colin Cross7d5136f2015-05-11 13:39:40 -0700260}
261
Sasha Smundak2057f822019-04-16 17:16:58 -0700262func (me *CompilerDeviceProperties) EffectiveOptimizeEnabled() bool {
263 return BoolDefault(me.Optimize.Enabled, me.Optimize.EnabledByDefault)
264}
265
Colin Cross46c9b8b2017-06-22 16:51:17 -0700266// Module contains the properties and members used by all java module types
267type Module struct {
Colin Cross635c3b02016-05-18 15:37:25 -0700268 android.ModuleBase
Colin Cross89536d42017-07-07 14:35:50 -0700269 android.DefaultableModuleBase
Colin Cross2fe66872015-03-30 17:20:39 -0700270
Colin Cross89536d42017-07-07 14:35:50 -0700271 properties CompilerProperties
Colin Cross6af17aa2017-09-20 12:59:05 -0700272 protoProperties android.ProtoProperties
Colin Cross89536d42017-07-07 14:35:50 -0700273 deviceProperties CompilerDeviceProperties
Colin Cross2fe66872015-03-30 17:20:39 -0700274
Colin Cross331a1212018-08-15 20:40:52 -0700275 // jar file containing header classes including static library dependencies, suitable for
276 // inserting into the bootclasspath/classpath of another compile
Nan Zhanged19fc32017-10-19 13:06:22 -0700277 headerJarFile android.Path
278
Colin Cross331a1212018-08-15 20:40:52 -0700279 // jar file containing implementation classes including static library dependencies but no
280 // resources
Nan Zhanged19fc32017-10-19 13:06:22 -0700281 implementationJarFile android.Path
Colin Cross2fe66872015-03-30 17:20:39 -0700282
Colin Cross331a1212018-08-15 20:40:52 -0700283 // jar file containing only resources including from static library dependencies
284 resourceJar android.Path
285
Colin Cross0c4ce212019-05-03 15:28:19 -0700286 // args and dependencies to package source files into a srcjar
287 srcJarArgs []string
288 srcJarDeps android.Paths
289
Colin Cross331a1212018-08-15 20:40:52 -0700290 // jar file containing implementation classes and resources including static library
291 // dependencies
292 implementationAndResourcesJar android.Path
293
294 // output file containing classes.dex and resources
Colin Cross6ade34f2017-09-15 13:00:47 -0700295 dexJarFile android.Path
296
Colin Cross43f08db2018-11-12 10:13:39 -0800297 // output file that contains classes.dex if it should be in the output file
298 maybeStrippedDexJarFile android.Path
299
Colin Crosscb933592017-11-22 13:49:43 -0800300 // output file containing uninstrumented classes that will be instrumented by jacoco
301 jacocoReportClassesFile android.Path
302
Colin Cross66dbc0b2017-12-28 12:23:20 -0800303 // output file containing mapping of obfuscated names
304 proguardDictionary android.Path
305
Colin Cross331a1212018-08-15 20:40:52 -0700306 // output file of the module, which may be a classes jar or a dex jar
Colin Crosse560c4a2019-03-19 16:03:11 -0700307 outputFile android.Path
308 extraOutputFiles android.Paths
Colin Crossb7a63242015-04-16 14:09:14 -0700309
Colin Cross635c3b02016-05-18 15:37:25 -0700310 exportAidlIncludeDirs android.Paths
Colin Crossc0b06f12015-04-08 13:03:43 -0700311
Colin Cross635c3b02016-05-18 15:37:25 -0700312 logtagsSrcs android.Paths
Colin Crossf05fe972015-04-10 17:45:20 -0700313
Colin Cross2fe66872015-03-30 17:20:39 -0700314 // installed file for binary dependency
Colin Cross635c3b02016-05-18 15:37:25 -0700315 installFile android.Path
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800316
317 // list of .java files and srcjars that was passed to javac
318 compiledJavaSrcs android.Paths
319 compiledSrcJars android.Paths
Colin Cross66dbc0b2017-12-28 12:23:20 -0800320
321 // list of extra progurad flag files
322 extraProguardFlagFiles android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900323
Colin Cross094054a2018-10-17 15:10:48 -0700324 // manifest file to use instead of properties.Manifest
325 overrideManifest android.OptionalPath
326
Jiyong Park1be96912018-05-28 18:02:19 +0900327 // list of SDK lib names that this java moudule is exporting
328 exportedSdkLibs []string
Brandon Lee5d45c6f2018-08-15 15:35:38 -0700329
330 // list of source files, collected from compiledJavaSrcs and compiledSrcJars
331 // filter out Exclude_srcs, will be used by android.IDEInfo struct
332 expandIDEInfoCompiledSrcs []string
Colin Cross43f08db2018-11-12 10:13:39 -0800333
Steven Morelandc4efd9c2019-01-18 11:51:25 -0800334 // expanded Jarjar_rules
335 expandJarjarRules android.Path
336
Vladimir Marko0975ee02019-04-02 10:29:55 +0100337 // list of additional targets for checkbuild
338 additionalCheckedModules android.Paths
339
Colin Cross988708c2019-05-06 14:04:11 -0700340 // Extra files generated by the module type to be added as java resources.
341 extraResources 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 Cross41955e82019-05-29 14:40:35 -0700347func (j *Module) OutputFiles(tag string) (android.Paths, error) {
348 switch tag {
349 case "":
350 return append(android.Paths{j.outputFile}, j.extraOutputFiles...), nil
Colin Cross375ca3c2019-05-29 14:40:58 -0700351 case ".jar":
352 return android.Paths{j.implementationAndResourcesJar}, nil
Colin Cross41955e82019-05-29 14:40:35 -0700353 default:
354 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
355 }
Colin Cross54250902017-12-05 09:28:08 -0800356}
357
Jiyong Park8fd61922018-11-08 02:50:25 +0900358func (j *Module) DexJarFile() android.Path {
359 return j.dexJarFile
360}
361
Colin Cross41955e82019-05-29 14:40:35 -0700362var _ android.OutputFileProducer = (*Module)(nil)
Colin Cross54250902017-12-05 09:28:08 -0800363
Colin Crossf506d872017-07-19 15:53:04 -0700364type Dependency interface {
Nan Zhanged19fc32017-10-19 13:06:22 -0700365 HeaderJars() android.Paths
366 ImplementationJars() android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700367 ResourceJars() android.Paths
368 ImplementationAndResourcesJars() android.Paths
Colin Crossf24a22a2019-01-31 14:12:44 -0800369 DexJar() android.Path
Colin Cross635c3b02016-05-18 15:37:25 -0700370 AidlIncludeDirs() android.Paths
Jiyong Park1be96912018-05-28 18:02:19 +0900371 ExportedSdkLibs() []string
Colin Cross0c4ce212019-05-03 15:28:19 -0700372 SrcJarArgs() ([]string, android.Paths)
Colin Cross2fe66872015-03-30 17:20:39 -0700373}
374
Jiyong Parkc678ad32018-04-10 13:07:10 +0900375type SdkLibraryDependency interface {
Colin Cross0ea8ba82019-06-06 14:33:29 -0700376 SdkHeaderJars(ctx android.BaseModuleContext, sdkVersion string) android.Paths
377 SdkImplementationJars(ctx android.BaseModuleContext, sdkVersion string) android.Paths
Jiyong Parkc678ad32018-04-10 13:07:10 +0900378}
379
Nan Zhangb2b33de2018-02-23 11:18:47 -0800380type SrcDependency interface {
381 CompiledSrcs() android.Paths
382 CompiledSrcJars() android.Paths
383}
384
385func (j *Module) CompiledSrcs() android.Paths {
386 return j.compiledJavaSrcs
387}
388
389func (j *Module) CompiledSrcJars() android.Paths {
390 return j.compiledSrcJars
391}
392
393var _ SrcDependency = (*Module)(nil)
394
Colin Cross89536d42017-07-07 14:35:50 -0700395func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
396 android.InitAndroidArchModule(module, hod, android.MultilibCommon)
397 android.InitDefaultableModule(module)
398}
399
Colin Crossbe1da472017-07-07 15:59:46 -0700400type dependencyTag struct {
401 blueprint.BaseDependencyTag
402 name string
Colin Cross2fe66872015-03-30 17:20:39 -0700403}
404
Colin Crossa4f08812018-10-02 22:03:40 -0700405type jniDependencyTag struct {
406 blueprint.BaseDependencyTag
407 target android.Target
408}
409
Colin Crossbe1da472017-07-07 15:59:46 -0700410var (
Colin Cross4b964c02018-10-15 16:18:06 -0700411 staticLibTag = dependencyTag{name: "staticlib"}
412 libTag = dependencyTag{name: "javalib"}
Colin Crossbe9cdb82019-01-21 21:37:16 -0800413 pluginTag = dependencyTag{name: "plugin"}
Colin Cross4b964c02018-10-15 16:18:06 -0700414 bootClasspathTag = dependencyTag{name: "bootclasspath"}
415 systemModulesTag = dependencyTag{name: "system modules"}
416 frameworkResTag = dependencyTag{name: "framework-res"}
417 frameworkApkTag = dependencyTag{name: "framework-apk"}
418 kotlinStdlibTag = dependencyTag{name: "kotlin-stdlib"}
Colin Crossafbb1732019-01-17 15:42:52 -0800419 kotlinAnnotationsTag = dependencyTag{name: "kotlin-annotations"}
Colin Cross4b964c02018-10-15 16:18:06 -0700420 proguardRaiseTag = dependencyTag{name: "proguard-raise"}
421 certificateTag = dependencyTag{name: "certificate"}
422 instrumentationForTag = dependencyTag{name: "instrumentation_for"}
Colin Cross50ddcc42019-05-16 12:28:22 -0700423 usesLibTag = dependencyTag{name: "uses-library"}
Colin Crossbe1da472017-07-07 15:59:46 -0700424)
Colin Cross2fe66872015-03-30 17:20:39 -0700425
Jeongik Cha6bd33c12019-06-25 16:26:18 +0900426func defaultSdkVersion(ctx checkVendorModuleContext) string {
427 if ctx.SocSpecific() || ctx.DeviceSpecific() {
428 return "system_current"
429 }
430 return ""
431}
432
433type checkVendorModuleContext interface {
434 SocSpecific() bool
435 DeviceSpecific() bool
436}
437
Colin Crossfc3674a2017-09-18 17:41:52 -0700438type sdkDep struct {
Colin Cross47ff2522017-10-02 14:22:08 -0700439 useModule, useFiles, useDefaultLibs, invalidVersion bool
440
Colin Cross86a60ae2018-05-29 14:44:55 -0700441 modules []string
Colin Cross1369cdb2017-09-29 17:58:17 -0700442 systemModules string
443
Colin Crossa97c5d32018-03-28 14:58:31 -0700444 frameworkResModule string
445
Colin Cross86a60ae2018-05-29 14:44:55 -0700446 jars android.Paths
Colin Cross3047fa22019-04-18 10:56:44 -0700447 aidl android.OptionalPath
Paul Duffin250e6192019-06-07 10:44:37 +0100448
449 noStandardLibs, noFrameworksLibs bool
450}
451
452func (s sdkDep) hasStandardLibs() bool {
453 return !s.noStandardLibs
454}
455
456func (s sdkDep) hasFrameworkLibs() bool {
457 return !s.noStandardLibs && !s.noFrameworksLibs
Colin Cross1369cdb2017-09-29 17:58:17 -0700458}
459
Colin Crossa4f08812018-10-02 22:03:40 -0700460type jniLib struct {
461 name string
462 path android.Path
463 target android.Target
464}
465
Colin Cross0ea8ba82019-06-06 14:33:29 -0700466func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800467 return j.properties.Instrument && ctx.Config().IsEnvTrue("EMMA_INSTRUMENT")
468}
469
Colin Cross0ea8ba82019-06-06 14:33:29 -0700470func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Colin Cross3144dfc2018-01-03 15:06:47 -0800471 return j.shouldInstrument(ctx) &&
472 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
473 ctx.Config().UnbundledBuild())
474}
475
Colin Cross83bb3162018-06-25 15:48:06 -0700476func (j *Module) sdkVersion() string {
Jeongik Cha6bd33c12019-06-25 16:26:18 +0900477 return proptools.StringDefault(j.deviceProperties.Sdk_version, defaultSdkVersion(j))
Colin Cross83bb3162018-06-25 15:48:06 -0700478}
479
480func (j *Module) minSdkVersion() string {
481 if j.deviceProperties.Min_sdk_version != nil {
482 return *j.deviceProperties.Min_sdk_version
483 }
484 return j.sdkVersion()
485}
486
Dan Willemsen419290a2018-10-31 15:28:47 -0700487func (j *Module) targetSdkVersion() string {
488 if j.deviceProperties.Target_sdk_version != nil {
489 return *j.deviceProperties.Target_sdk_version
490 }
491 return j.sdkVersion()
492}
493
Colin Crossbe1da472017-07-07 15:59:46 -0700494func (j *Module) deps(ctx android.BottomUpMutatorContext) {
Colin Cross1369cdb2017-09-29 17:58:17 -0700495 if ctx.Device() {
Paul Duffin250e6192019-06-07 10:44:37 +0100496 sdkDep := decodeSdkDep(ctx, sdkContext(j))
497 if sdkDep.hasStandardLibs() {
Colin Crossfc3674a2017-09-18 17:41:52 -0700498 if sdkDep.useDefaultLibs {
Colin Cross42d48b72018-08-29 14:10:52 -0700499 ctx.AddVariationDependencies(nil, bootClasspathTag, config.DefaultBootclasspathLibraries...)
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100500 ctx.AddVariationDependencies(nil, systemModulesTag, config.DefaultSystemModules)
Paul Duffin250e6192019-06-07 10:44:37 +0100501 if sdkDep.hasFrameworkLibs() {
Colin Cross42d48b72018-08-29 14:10:52 -0700502 ctx.AddVariationDependencies(nil, libTag, config.DefaultLibraries...)
Colin Crossfa5eb232017-10-01 20:33:03 -0700503 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700504 } else if sdkDep.useModule {
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100505 ctx.AddVariationDependencies(nil, systemModulesTag, sdkDep.systemModules)
Colin Cross42d48b72018-08-29 14:10:52 -0700506 ctx.AddVariationDependencies(nil, bootClasspathTag, sdkDep.modules...)
Sasha Smundak2057f822019-04-16 17:16:58 -0700507 if j.deviceProperties.EffectiveOptimizeEnabled() {
Colin Cross42d48b72018-08-29 14:10:52 -0700508 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultBootclasspathLibraries...)
509 ctx.AddVariationDependencies(nil, proguardRaiseTag, config.DefaultLibraries...)
Colin Cross66dbc0b2017-12-28 12:23:20 -0800510 }
Colin Crossbe1da472017-07-07 15:59:46 -0700511 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700512 } else if j.deviceProperties.System_modules == nil {
Paul Duffina3d09862019-06-11 13:40:47 +0100513 ctx.PropertyErrorf("sdk_version",
Paul Duffin5c2f9632019-06-12 14:21:31 +0100514 `system_modules is required to be set when sdk_version is "none", did you mean "core_platform"`)
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100515 } else if *j.deviceProperties.System_modules != "none" {
Colin Cross42d48b72018-08-29 14:10:52 -0700516 ctx.AddVariationDependencies(nil, systemModulesTag, *j.deviceProperties.System_modules)
Colin Cross2fe66872015-03-30 17:20:39 -0700517 }
Mathew Inwoodebe29ce2018-09-04 14:26:19 +0100518 if (ctx.ModuleName() == "framework") || (ctx.ModuleName() == "framework-annotation-proc") {
Colin Cross42d48b72018-08-29 14:10:52 -0700519 ctx.AddVariationDependencies(nil, frameworkResTag, "framework-res")
Colin Cross5ab4e6d2017-11-22 16:20:45 -0800520 }
Nan Zhangb2b33de2018-02-23 11:18:47 -0800521 if ctx.ModuleName() == "android_stubs_current" ||
522 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -0700523 ctx.ModuleName() == "android_test_stubs_current" {
Colin Cross42d48b72018-08-29 14:10:52 -0700524 ctx.AddVariationDependencies(nil, frameworkApkTag, "framework-res")
Nan Zhangb2b33de2018-02-23 11:18:47 -0800525 }
Colin Cross2fe66872015-03-30 17:20:39 -0700526 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700527
Colin Cross42d48b72018-08-29 14:10:52 -0700528 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
529 ctx.AddVariationDependencies(nil, staticLibTag, j.properties.Static_libs...)
Colin Crossa4f08812018-10-02 22:03:40 -0700530
Colin Crossbe9cdb82019-01-21 21:37:16 -0800531 ctx.AddFarVariationDependencies([]blueprint.Variation{
532 {Mutator: "arch", Variation: ctx.Config().BuildOsCommonVariant},
533 }, pluginTag, j.properties.Plugins...)
534
Colin Crossfe17f6f2019-03-28 19:30:56 -0700535 android.ProtoDeps(ctx, &j.protoProperties)
Colin Cross6af17aa2017-09-20 12:59:05 -0700536 if j.hasSrcExt(".proto") {
537 protoDeps(ctx, &j.protoProperties)
538 }
Colin Cross93e85952017-08-15 13:34:18 -0700539
540 if j.hasSrcExt(".kt") {
541 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
542 // Kotlin files
Colin Cross0b03d972019-05-13 11:06:25 -0700543 ctx.AddVariationDependencies(nil, kotlinStdlibTag,
544 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8")
Colin Cross7788c122019-01-23 16:14:02 -0800545 if len(j.properties.Plugins) > 0 {
Colin Crossafbb1732019-01-17 15:42:52 -0800546 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
547 }
Colin Cross93e85952017-08-15 13:34:18 -0700548 }
Colin Cross3144dfc2018-01-03 15:06:47 -0800549
550 if j.shouldInstrumentStatic(ctx) {
Colin Cross42d48b72018-08-29 14:10:52 -0700551 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
Colin Cross3144dfc2018-01-03 15:06:47 -0800552 }
Colin Cross6af17aa2017-09-20 12:59:05 -0700553}
554
555func hasSrcExt(srcs []string, ext string) bool {
556 for _, src := range srcs {
557 if filepath.Ext(src) == ext {
558 return true
559 }
560 }
561
562 return false
563}
564
Nan Zhang61eaedb2017-11-02 13:28:15 -0700565func shardPaths(paths android.Paths, shardSize int) []android.Paths {
566 ret := make([]android.Paths, 0, (len(paths)+shardSize-1)/shardSize)
567 for len(paths) > shardSize {
568 ret = append(ret, paths[0:shardSize])
569 paths = paths[shardSize:]
570 }
571 if len(paths) > 0 {
572 ret = append(ret, paths)
573 }
574 return ret
575}
576
Colin Cross6af17aa2017-09-20 12:59:05 -0700577func (j *Module) hasSrcExt(ext string) bool {
578 return hasSrcExt(j.properties.Srcs, ext)
Colin Cross2fe66872015-03-30 17:20:39 -0700579}
580
Colin Cross46c9b8b2017-06-22 16:51:17 -0700581func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Colin Cross3047fa22019-04-18 10:56:44 -0700582 aidlIncludeDirs android.Paths) (string, android.Paths) {
Colin Crossc0b06f12015-04-08 13:03:43 -0700583
Colin Crossebe1a512017-11-14 13:12:14 -0800584 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
585 aidlIncludes = append(aidlIncludes,
586 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
587 aidlIncludes = append(aidlIncludes,
588 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
Colin Crossc0b06f12015-04-08 13:03:43 -0700589
Colin Cross3047fa22019-04-18 10:56:44 -0700590 var flags []string
591 var deps android.Paths
Steven Moreland667f6882018-07-26 12:55:08 -0700592
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700593 if aidlPreprocess.Valid() {
594 flags = append(flags, "-p"+aidlPreprocess.String())
Colin Cross3047fa22019-04-18 10:56:44 -0700595 deps = append(deps, aidlPreprocess.Path())
596 } else if len(aidlIncludeDirs) > 0 {
Colin Cross635c3b02016-05-18 15:37:25 -0700597 flags = append(flags, android.JoinWithPrefix(aidlIncludeDirs.Strings(), "-I"))
Colin Crossc0b06f12015-04-08 13:03:43 -0700598 }
599
Colin Cross3047fa22019-04-18 10:56:44 -0700600 if len(j.exportAidlIncludeDirs) > 0 {
601 flags = append(flags, android.JoinWithPrefix(j.exportAidlIncludeDirs.Strings(), "-I"))
602 }
603
604 if len(aidlIncludes) > 0 {
605 flags = append(flags, android.JoinWithPrefix(aidlIncludes.Strings(), "-I"))
606 }
607
Colin Cross635c3b02016-05-18 15:37:25 -0700608 flags = append(flags, "-I"+android.PathForModuleSrc(ctx).String())
Colin Cross32f38982018-02-22 11:47:25 -0800609 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Colin Crossd48633a2017-07-13 14:41:17 -0700610 flags = append(flags, "-I"+src.String())
611 }
Colin Crossc0b06f12015-04-08 13:03:43 -0700612
Martijn Coeneneab15642018-03-09 09:29:59 +0100613 if Bool(j.deviceProperties.Aidl.Generate_traces) {
614 flags = append(flags, "-t")
615 }
616
Olivier Gaillard0a4cfbc2018-07-16 23:37:03 +0100617 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
618 flags = append(flags, "--transaction_names")
619 }
620
Colin Cross3047fa22019-04-18 10:56:44 -0700621 return strings.Join(flags, " "), deps
Colin Crossc0b06f12015-04-08 13:03:43 -0700622}
623
Colin Cross32f676a2017-09-06 13:41:06 -0700624type deps struct {
Nan Zhang581fd212018-01-10 16:06:12 -0800625 classpath classpath
626 bootClasspath classpath
Colin Cross6a77c982018-06-19 22:43:34 -0700627 processorPath classpath
Colin Crossbe9cdb82019-01-21 21:37:16 -0800628 processorClasses []string
Colin Cross6ade34f2017-09-15 13:00:47 -0700629 staticJars android.Paths
Nan Zhanged19fc32017-10-19 13:06:22 -0700630 staticHeaderJars android.Paths
Colin Cross331a1212018-08-15 20:40:52 -0700631 staticResourceJars android.Paths
Colin Cross6ade34f2017-09-15 13:00:47 -0700632 aidlIncludeDirs android.Paths
Nan Zhangb2b33de2018-02-23 11:18:47 -0800633 srcs android.Paths
Colin Cross59149b62017-10-16 18:07:29 -0700634 srcJars android.Paths
Colin Crossb77043e2019-07-16 13:57:13 -0700635 systemModules *systemModules
Colin Cross6ade34f2017-09-15 13:00:47 -0700636 aidlPreprocess android.OptionalPath
Colin Cross93e85952017-08-15 13:34:18 -0700637 kotlinStdlib android.Paths
Colin Crossafbb1732019-01-17 15:42:52 -0800638 kotlinAnnotations android.Paths
Colin Crossbe9cdb82019-01-21 21:37:16 -0800639
640 disableTurbine bool
Colin Cross32f676a2017-09-06 13:41:06 -0700641}
Colin Cross2fe66872015-03-30 17:20:39 -0700642
Colin Cross54250902017-12-05 09:28:08 -0800643func checkProducesJars(ctx android.ModuleContext, dep android.SourceFileProducer) {
644 for _, f := range dep.Srcs() {
645 if f.Ext() != ".jar" {
646 ctx.ModuleErrorf("genrule %q must generate files ending with .jar to be used as a libs or static_libs dependency",
647 ctx.OtherModuleName(dep.(blueprint.Module)))
648 }
649 }
650}
651
Jiyong Park2d492942018-03-05 17:44:10 +0900652type linkType int
653
654const (
655 javaCore linkType = iota
656 javaSdk
657 javaSystem
658 javaPlatform
659)
660
Jiyong Park46f78fb2018-10-20 16:33:17 +0900661func getLinkType(m *Module, name string) (ret linkType, stubs bool) {
Colin Cross83bb3162018-06-25 15:48:06 -0700662 ver := m.sdkVersion()
Colin Crossf19b9bb2018-03-26 14:42:44 -0700663 switch {
Jiyong Park46f78fb2018-10-20 16:33:17 +0900664 case name == "core.current.stubs" || name == "core.platform.api.stubs" ||
665 name == "stub-annotations" || name == "private-stub-annotations-jar" ||
Pete Gillincbff3262019-05-08 15:10:06 +0100666 name == "core-lambda-stubs" || name == "core-generated-annotation-stubs":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900667 return javaCore, true
Neil Fuller401eeba2018-10-18 19:48:58 +0100668 case ver == "core_current":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900669 return javaCore, false
670 case name == "android_system_stubs_current":
671 return javaSystem, true
672 case strings.HasPrefix(ver, "system_"):
673 return javaSystem, false
674 case name == "android_test_stubs_current":
675 return javaSystem, true
676 case strings.HasPrefix(ver, "test_"):
677 return javaPlatform, false
678 case name == "android_stubs_current":
679 return javaSdk, true
680 case ver == "current":
681 return javaSdk, false
Paul Duffin50c217c2019-06-12 13:25:22 +0100682 case ver == "" || ver == "none" || ver == "core_platform":
Jiyong Park46f78fb2018-10-20 16:33:17 +0900683 return javaPlatform, false
Colin Crossf19b9bb2018-03-26 14:42:44 -0700684 default:
685 if _, err := strconv.Atoi(ver); err != nil {
686 panic(fmt.Errorf("expected sdk_version to be a number, got %q", ver))
687 }
Jiyong Park46f78fb2018-10-20 16:33:17 +0900688 return javaSdk, false
Jiyong Park2d492942018-03-05 17:44:10 +0900689 }
690}
691
Jiyong Park750e5572018-01-31 00:20:13 +0900692func checkLinkType(ctx android.ModuleContext, from *Module, to *Library, tag dependencyTag) {
Colin Crossf19b9bb2018-03-26 14:42:44 -0700693 if ctx.Host() {
694 return
695 }
696
Jiyong Park46f78fb2018-10-20 16:33:17 +0900697 myLinkType, stubs := getLinkType(from, ctx.ModuleName())
698 if stubs {
699 return
700 }
701 otherLinkType, _ := getLinkType(&to.Module, ctx.OtherModuleName(to))
Jiyong Park2d492942018-03-05 17:44:10 +0900702 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."
703
704 switch myLinkType {
705 case javaCore:
706 if otherLinkType != javaCore {
707 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 +0900708 ctx.OtherModuleName(to))
709 }
Jiyong Park2d492942018-03-05 17:44:10 +0900710 break
711 case javaSdk:
712 if otherLinkType != javaCore && otherLinkType != javaSdk {
713 ctx.ModuleErrorf("compiles against Android API, but dependency %q is compiling against non-public Android API."+commonMessage,
714 ctx.OtherModuleName(to))
715 }
716 break
717 case javaSystem:
718 if otherLinkType == javaPlatform {
719 ctx.ModuleErrorf("compiles against system API, but dependency %q is compiling against private API."+commonMessage,
720 ctx.OtherModuleName(to))
721 }
722 break
723 case javaPlatform:
724 // no restriction on link-type
725 break
Jiyong Park750e5572018-01-31 00:20:13 +0900726 }
727}
728
Colin Cross32f676a2017-09-06 13:41:06 -0700729func (j *Module) collectDeps(ctx android.ModuleContext) deps {
730 var deps deps
Colin Crossfc3674a2017-09-18 17:41:52 -0700731
Colin Cross300f0382018-03-06 13:11:51 -0800732 if ctx.Device() {
Colin Cross83bb3162018-06-25 15:48:06 -0700733 sdkDep := decodeSdkDep(ctx, sdkContext(j))
Colin Cross300f0382018-03-06 13:11:51 -0800734 if sdkDep.invalidVersion {
Colin Cross86a60ae2018-05-29 14:44:55 -0700735 ctx.AddMissingDependencies(sdkDep.modules)
Colin Cross300f0382018-03-06 13:11:51 -0800736 } else if sdkDep.useFiles {
737 // sdkDep.jar is actually equivalent to turbine header.jar.
Colin Cross86a60ae2018-05-29 14:44:55 -0700738 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross3047fa22019-04-18 10:56:44 -0700739 deps.aidlPreprocess = sdkDep.aidl
740 } else {
741 deps.aidlPreprocess = sdkDep.aidl
Colin Cross300f0382018-03-06 13:11:51 -0800742 }
Colin Crossfc3674a2017-09-18 17:41:52 -0700743 }
744
Colin Crossd11fcda2017-10-23 17:59:01 -0700745 ctx.VisitDirectDeps(func(module android.Module) {
Colin Cross2fe66872015-03-30 17:20:39 -0700746 otherName := ctx.OtherModuleName(module)
Colin Crossec7a0422017-07-07 14:47:12 -0700747 tag := ctx.OtherModuleDependencyTag(module)
748
Colin Crossa4f08812018-10-02 22:03:40 -0700749 if _, ok := tag.(*jniDependencyTag); ok {
Colin Crossbd01e2a2018-10-04 15:21:03 -0700750 // Handled by AndroidApp.collectAppDeps
751 return
752 }
753 if tag == certificateTag {
754 // Handled by AndroidApp.collectAppDeps
Colin Crossa4f08812018-10-02 22:03:40 -0700755 return
756 }
757
Jiyong Park750e5572018-01-31 00:20:13 +0900758 if to, ok := module.(*Library); ok {
Colin Crossa97c5d32018-03-28 14:58:31 -0700759 switch tag {
760 case bootClasspathTag, libTag, staticLibTag:
761 checkLinkType(ctx, j, to, tag.(dependencyTag))
762 }
Jiyong Park750e5572018-01-31 00:20:13 +0900763 }
Colin Cross54250902017-12-05 09:28:08 -0800764 switch dep := module.(type) {
Colin Cross897d2ed2019-02-11 14:03:51 -0800765 case SdkLibraryDependency:
766 switch tag {
767 case libTag:
768 deps.classpath = append(deps.classpath, dep.SdkHeaderJars(ctx, j.sdkVersion())...)
769 // names of sdk libs that are directly depended are exported
770 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
Colin Cross79c7c262019-04-17 11:11:46 -0700771 case staticLibTag:
Colin Cross897d2ed2019-02-11 14:03:51 -0800772 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
773 }
Colin Cross54250902017-12-05 09:28:08 -0800774 case Dependency:
775 switch tag {
776 case bootClasspathTag:
777 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars()...)
Colin Cross4b964c02018-10-15 16:18:06 -0700778 case libTag, instrumentationForTag:
Colin Cross54250902017-12-05 09:28:08 -0800779 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900780 // sdk lib names from dependencies are re-exported
781 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700782 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Colin Cross54250902017-12-05 09:28:08 -0800783 case staticLibTag:
784 deps.classpath = append(deps.classpath, dep.HeaderJars()...)
785 deps.staticJars = append(deps.staticJars, dep.ImplementationJars()...)
786 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars()...)
Colin Cross331a1212018-08-15 20:40:52 -0700787 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars()...)
Jiyong Park1be96912018-05-28 18:02:19 +0900788 // sdk lib names from dependencies are re-exported
789 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
Colin Cross3047fa22019-04-18 10:56:44 -0700790 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs()...)
Colin Crossbe9cdb82019-01-21 21:37:16 -0800791 case pluginTag:
792 if plugin, ok := dep.(*Plugin); ok {
793 deps.processorPath = append(deps.processorPath, dep.ImplementationAndResourcesJars()...)
794 if plugin.pluginProperties.Processor_class != nil {
795 deps.processorClasses = append(deps.processorClasses, *plugin.pluginProperties.Processor_class)
796 }
797 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
798 } else {
799 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
800 }
Colin Cross54250902017-12-05 09:28:08 -0800801 case frameworkResTag:
Mathew Inwoodebe29ce2018-09-04 14:26:19 +0100802 if (ctx.ModuleName() == "framework") || (ctx.ModuleName() == "framework-annotation-proc") {
Colin Cross54250902017-12-05 09:28:08 -0800803 // framework.jar has a one-off dependency on the R.java and Manifest.java files
804 // generated by framework-res.apk
805 deps.srcJars = append(deps.srcJars, dep.(*AndroidApp).aaptSrcJar)
806 }
Nan Zhangb2b33de2018-02-23 11:18:47 -0800807 case frameworkApkTag:
808 if ctx.ModuleName() == "android_stubs_current" ||
809 ctx.ModuleName() == "android_system_stubs_current" ||
Nan Zhang863f05b2018-08-07 13:41:10 -0700810 ctx.ModuleName() == "android_test_stubs_current" {
Nan Zhangb2b33de2018-02-23 11:18:47 -0800811 // framework stubs.jar need to depend on framework-res.apk, in order to pull the
812 // resource files out of there for aapt.
813 //
814 // Normally the package rule runs aapt, which includes the resource,
815 // but we're not running that in our package rule so just copy in the
816 // resource files here.
Colin Cross331a1212018-08-15 20:40:52 -0700817 deps.staticResourceJars = append(deps.staticResourceJars, dep.(*AndroidApp).exportPackage)
Nan Zhangb2b33de2018-02-23 11:18:47 -0800818 }
Colin Cross54250902017-12-05 09:28:08 -0800819 case kotlinStdlibTag:
Colin Cross0b03d972019-05-13 11:06:25 -0700820 deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars()...)
Colin Crossafbb1732019-01-17 15:42:52 -0800821 case kotlinAnnotationsTag:
822 deps.kotlinAnnotations = dep.HeaderJars()
Colin Cross54250902017-12-05 09:28:08 -0800823 }
824
Colin Cross54250902017-12-05 09:28:08 -0800825 case android.SourceFileProducer:
826 switch tag {
827 case libTag:
828 checkProducesJars(ctx, dep)
829 deps.classpath = append(deps.classpath, dep.Srcs()...)
830 case staticLibTag:
831 checkProducesJars(ctx, dep)
832 deps.classpath = append(deps.classpath, dep.Srcs()...)
833 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
834 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
Colin Cross54250902017-12-05 09:28:08 -0800835 }
836 default:
Colin Crossec7a0422017-07-07 14:47:12 -0700837 switch tag {
Colin Cross1369cdb2017-09-29 17:58:17 -0700838 case systemModulesTag:
839 if deps.systemModules != nil {
840 panic("Found two system module dependencies")
841 }
842 sm := module.(*SystemModules)
Dan Willemsenff60a732019-06-13 16:52:01 +0000843 if sm.outputDir == nil || len(sm.outputDeps) == 0 {
Colin Cross1369cdb2017-09-29 17:58:17 -0700844 panic("Missing directory for system module dependency")
845 }
Colin Crossb77043e2019-07-16 13:57:13 -0700846 deps.systemModules = &systemModules{sm.outputDir, sm.outputDeps}
Colin Cross2fe66872015-03-30 17:20:39 -0700847 }
Colin Crossec7a0422017-07-07 14:47:12 -0700848 }
Colin Cross2fe66872015-03-30 17:20:39 -0700849 })
850
Jiyong Park1be96912018-05-28 18:02:19 +0900851 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
852
Colin Cross32f676a2017-09-06 13:41:06 -0700853 return deps
Colin Cross2fe66872015-03-30 17:20:39 -0700854}
855
Colin Cross83bb3162018-06-25 15:48:06 -0700856func getJavaVersion(ctx android.ModuleContext, javaVersion string, sdkContext sdkContext) string {
Nan Zhang357466b2018-04-17 17:38:36 -0700857 var ret string
Colin Cross98fd5742019-01-09 23:04:25 -0800858 v := sdkContext.sdkVersion()
859 // For PDK builds, use the latest SDK version instead of "current"
Paul Duffin50c217c2019-06-12 13:25:22 +0100860 if ctx.Config().IsPdkBuild() &&
861 (v == "" || v == "none" || v == "core_platform" || v == "current") {
Colin Cross3047fa22019-04-18 10:56:44 -0700862 sdkVersions := ctx.Config().Get(sdkVersionsKey).([]int)
Colin Cross98fd5742019-01-09 23:04:25 -0800863 latestSdkVersion := 0
864 if len(sdkVersions) > 0 {
865 latestSdkVersion = sdkVersions[len(sdkVersions)-1]
866 }
867 v = strconv.Itoa(latestSdkVersion)
868 }
869
870 sdk, err := sdkVersionToNumber(ctx, v)
Colin Cross83bb3162018-06-25 15:48:06 -0700871 if err != nil {
872 ctx.PropertyErrorf("sdk_version", "%s", err)
873 }
Nan Zhang357466b2018-04-17 17:38:36 -0700874 if javaVersion != "" {
875 ret = javaVersion
876 } else if ctx.Device() && sdk <= 23 {
877 ret = "1.7"
Pete Gillin9c640142019-05-20 15:44:53 +0100878 } else if ctx.Device() && sdk <= 29 || !ctx.Config().TargetOpenJDK9() {
Nan Zhang357466b2018-04-17 17:38:36 -0700879 ret = "1.8"
Paul Duffin50c217c2019-06-12 13:25:22 +0100880 } else if ctx.Device() &&
881 sdkContext.sdkVersion() != "" &&
882 sdkContext.sdkVersion() != "none" &&
883 sdkContext.sdkVersion() != "core_platform" &&
884 sdk == android.FutureApiLevel {
Nan Zhang357466b2018-04-17 17:38:36 -0700885 // TODO(ccross): once we generate stubs we should be able to use 1.9 for sdk_version: "current"
886 ret = "1.8"
887 } else {
888 ret = "1.9"
889 }
890
891 return ret
892}
893
Nan Zhanged19fc32017-10-19 13:06:22 -0700894func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
Colin Crossc0b06f12015-04-08 13:03:43 -0700895
Colin Crossf03c82b2015-04-13 13:53:40 -0700896 var flags javaBuilderFlags
897
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100898 // javaVersion flag.
899 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), sdkContext(j))
900
Nan Zhanged19fc32017-10-19 13:06:22 -0700901 // javac flags.
Colin Crossf03c82b2015-04-13 13:53:40 -0700902 javacFlags := j.properties.Javacflags
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100903 if flags.javaVersion == "1.9" {
Colin Cross1369cdb2017-09-29 17:58:17 -0700904 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Nan Zhanged19fc32017-10-19 13:06:22 -0700905 }
Colin Cross6510f912017-11-29 00:27:14 -0800906 if ctx.Config().MinimizeJavaDebugInfo() {
Colin Cross126a25c2017-10-31 13:55:34 -0700907 // Override the -g flag passed globally to remove local variable debug info to reduce
908 // disk and memory usage.
909 javacFlags = append(javacFlags, "-g:source,lines")
910 }
Colin Cross64162712017-08-08 13:17:59 -0700911
Colin Cross66548102018-06-19 22:47:35 -0700912 if ctx.Config().RunErrorProne() {
913 if config.ErrorProneClasspath == nil {
914 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
915 }
916
917 errorProneFlags := []string{
918 "-Xplugin:ErrorProne",
919 "${config.ErrorProneChecks}",
920 }
921 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
922
923 flags.errorProneExtraJavacFlags = "${config.ErrorProneFlags} " +
924 "'" + strings.Join(errorProneFlags, " ") + "'"
925 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
Andreas Gampef3e5b552018-01-22 21:27:21 -0800926 }
927
Nan Zhanged19fc32017-10-19 13:06:22 -0700928 // classpath
Nan Zhang581fd212018-01-10 16:06:12 -0800929 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
930 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross6a77c982018-06-19 22:43:34 -0700931 flags.processorPath = append(flags.processorPath, deps.processorPath...)
Colin Cross7fdd2b72018-01-02 18:14:25 -0800932
Colin Crossbe9cdb82019-01-21 21:37:16 -0800933 flags.processor = strings.Join(deps.processorClasses, ",")
934
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100935 if len(flags.bootClasspath) == 0 && ctx.Host() && flags.javaVersion != "1.9" &&
Paul Duffin250e6192019-06-07 10:44:37 +0100936 decodeSdkDep(ctx, sdkContext(j)).hasStandardLibs() &&
Colin Cross7fdd2b72018-01-02 18:14:25 -0800937 inList(flags.javaVersion, []string{"1.6", "1.7", "1.8"}) {
938 // Give host-side tools a version of OpenJDK's standard libraries
939 // close to what they're targeting. As of Dec 2017, AOSP is only
940 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
941 //
942 // When building with OpenJDK 8, the following should have no
943 // effect since those jars would be available by default.
944 //
945 // When building with OpenJDK 9 but targeting a version < 1.8,
946 // putting them on the bootclasspath means that:
947 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
948 // b) references to existing APIs are not reinterpreted in an
949 // OpenJDK 9-specific way, eg. calls to subclasses of
950 // java.nio.Buffer as in http://b/70862583
951 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
952 flags.bootClasspath = append(flags.bootClasspath,
953 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
954 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
Nan Zhang5f8cb422018-02-06 10:34:32 -0800955 if Bool(j.properties.Use_tools_jar) {
956 flags.bootClasspath = append(flags.bootClasspath,
957 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
958 }
Colin Cross7fdd2b72018-01-02 18:14:25 -0800959 }
960
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100961 if j.properties.Patch_module != nil && flags.javaVersion == "1.9" {
Jaewoong Jung38e4fb22018-12-12 09:01:34 -0800962 // Manually specify build directory in case it is not under the repo root.
963 // (javac doesn't seem to expand into symbolc links when searching for patch-module targets, so
964 // just adding a symlink under the root doesn't help.)
965 patchPaths := ".:" + ctx.Config().BuildDir()
966 classPath := flags.classpath.FormJavaClassPath("")
967 if classPath != "" {
968 patchPaths += ":" + classPath
969 }
970 javacFlags = append(javacFlags, "--patch-module="+String(j.properties.Patch_module)+"="+patchPaths)
Colin Cross81440082018-08-15 20:21:55 -0700971 }
972
Nan Zhanged19fc32017-10-19 13:06:22 -0700973 // systemModules
Colin Crossb77043e2019-07-16 13:57:13 -0700974 flags.systemModules = deps.systemModules
Colin Cross1369cdb2017-09-29 17:58:17 -0700975
Nan Zhanged19fc32017-10-19 13:06:22 -0700976 // aidl flags.
Colin Cross3047fa22019-04-18 10:56:44 -0700977 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs)
Colin Cross2fe66872015-03-30 17:20:39 -0700978
Colin Cross81440082018-08-15 20:21:55 -0700979 if len(javacFlags) > 0 {
980 // optimization.
981 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
982 flags.javacFlags = "$javacFlags"
983 }
984
Nan Zhanged19fc32017-10-19 13:06:22 -0700985 return flags
986}
Colin Crossc0b06f12015-04-08 13:03:43 -0700987
Jaewoong Junga24af3b2019-05-13 09:23:20 -0700988func (j *Module) compile(ctx android.ModuleContext, aaptSrcJar android.Path) {
989
Colin Crossebe1a512017-11-14 13:12:14 -0800990 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
Nan Zhanged19fc32017-10-19 13:06:22 -0700991
992 deps := j.collectDeps(ctx)
993 flags := j.collectBuilderFlags(ctx, deps)
994
Tobias Thierer06dd04f2018-09-11 16:21:05 +0100995 if flags.javaVersion == "1.9" {
Nan Zhanged19fc32017-10-19 13:06:22 -0700996 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
997 }
Colin Cross8a497952019-03-05 22:25:09 -0800998 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Colin Cross6af17aa2017-09-20 12:59:05 -0700999 if hasSrcExt(srcFiles.Strings(), ".proto") {
Colin Cross0f2ee152017-12-14 15:22:43 -08001000 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
Colin Cross6af17aa2017-09-20 12:59:05 -07001001 }
1002
Colin Crossaf050172017-11-15 23:01:59 -08001003 srcFiles = j.genSources(ctx, srcFiles, flags)
1004
1005 srcJars := srcFiles.FilterByExt(".srcjar")
Colin Cross59149b62017-10-16 18:07:29 -07001006 srcJars = append(srcJars, deps.srcJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001007 if aaptSrcJar != nil {
1008 srcJars = append(srcJars, aaptSrcJar)
1009 }
Colin Crossb7a63242015-04-16 14:09:14 -07001010
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001011 // Collect source files from compiledJavaSrcs, compiledSrcJars and filter out Exclude_srcs
1012 // that IDEInfo struct will use
1013 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, srcFiles.Strings()...)
1014
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001015 if j.properties.Jarjar_rules != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001016 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001017 }
1018
Colin Cross1ee23172017-10-18 14:44:18 -07001019 jarName := ctx.ModuleName() + ".jar"
1020
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001021 javaSrcFiles := srcFiles.FilterByExt(".java")
1022 var uniqueSrcFiles android.Paths
1023 set := make(map[string]bool)
1024 for _, v := range javaSrcFiles {
1025 if _, found := set[v.String()]; !found {
1026 set[v.String()] = true
1027 uniqueSrcFiles = append(uniqueSrcFiles, v)
1028 }
1029 }
1030
Colin Cross55f63ea2018-08-27 12:37:09 -07001031 var kotlinJars android.Paths
1032
Colin Cross93e85952017-08-15 13:34:18 -07001033 if srcFiles.HasExt(".kt") {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001034 // user defined kotlin flags.
1035 kotlincFlags := j.properties.Kotlincflags
1036 CheckKotlincFlags(ctx, kotlincFlags)
1037
Colin Cross93e85952017-08-15 13:34:18 -07001038 // If there are kotlin files, compile them first but pass all the kotlin and java files
1039 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1040 // won't emit any classes for them.
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001041 kotlincFlags = append(kotlincFlags, "-no-stdlib")
Colin Cross93e85952017-08-15 13:34:18 -07001042 if ctx.Device() {
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001043 kotlincFlags = append(kotlincFlags, "-no-jdk")
1044 }
1045 if len(kotlincFlags) > 0 {
1046 // optimization.
1047 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1048 flags.kotlincFlags += "$kotlincFlags"
Colin Cross93e85952017-08-15 13:34:18 -07001049 }
1050
Przemyslaw Szczepaniak4b5fe9d2018-02-13 14:32:54 +00001051 var kotlinSrcFiles android.Paths
1052 kotlinSrcFiles = append(kotlinSrcFiles, uniqueSrcFiles...)
1053 kotlinSrcFiles = append(kotlinSrcFiles, srcFiles.FilterByExt(".kt")...)
1054
Colin Crossafbb1732019-01-17 15:42:52 -08001055 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1056 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1057
1058 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1059 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1060
1061 if len(flags.processorPath) > 0 {
1062 // Use kapt for annotation processing
1063 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1064 kotlinKapt(ctx, kaptSrcJar, kotlinSrcFiles, srcJars, flags)
1065 srcJars = append(srcJars, kaptSrcJar)
1066 // Disable annotation processing in javac, it's already been handled by kapt
1067 flags.processorPath = nil
Colin Cross3a3e94c2019-01-23 15:39:50 -08001068 flags.processor = ""
Colin Crossafbb1732019-01-17 15:42:52 -08001069 }
Colin Cross93e85952017-08-15 13:34:18 -07001070
Colin Cross1ee23172017-10-18 14:44:18 -07001071 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross21fc9bb2019-01-18 15:05:09 -08001072 kotlinCompile(ctx, kotlinJar, kotlinSrcFiles, srcJars, flags)
Colin Cross93e85952017-08-15 13:34:18 -07001073 if ctx.Failed() {
1074 return
1075 }
1076
1077 // Make javac rule depend on the kotlinc rule
1078 flags.classpath = append(flags.classpath, kotlinJar)
Przemyslaw Szczepaniak66c0c402018-03-08 13:21:55 +00001079
Colin Cross93e85952017-08-15 13:34:18 -07001080 // Jar kotlin classes into the final jar after javac
Colin Cross55f63ea2018-08-27 12:37:09 -07001081 kotlinJars = append(kotlinJars, kotlinJar)
Colin Cross9b38aef2018-08-27 15:42:25 -07001082 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
Colin Cross93e85952017-08-15 13:34:18 -07001083 }
1084
Colin Cross55f63ea2018-08-27 12:37:09 -07001085 jars := append(android.Paths(nil), kotlinJars...)
1086
Colin Cross5ab4e6d2017-11-22 16:20:45 -08001087 // Store the list of .java files that was passed to javac
1088 j.compiledJavaSrcs = uniqueSrcFiles
1089 j.compiledSrcJars = srcJars
1090
Nan Zhang61eaedb2017-11-02 13:28:15 -07001091 enable_sharding := false
Colin Crossbe9cdb82019-01-21 21:37:16 -08001092 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !deps.disableTurbine {
Nan Zhang61eaedb2017-11-02 13:28:15 -07001093 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1094 enable_sharding = true
Ashley Rosee36efcf2019-01-16 17:34:08 -05001095 // Formerly, there was a check here that prevented annotation processors
1096 // from being used when sharding was enabled, as some annotation processors
1097 // do not function correctly in sharded environments. It was removed to
1098 // allow for the use of annotation processors that do function correctly
1099 // with sharding enabled. See: b/77284273.
Nan Zhang61eaedb2017-11-02 13:28:15 -07001100 }
Colin Cross55f63ea2018-08-27 12:37:09 -07001101 j.headerJarFile = j.compileJavaHeader(ctx, uniqueSrcFiles, srcJars, deps, flags, jarName, kotlinJars)
Colin Crossf19b9bb2018-03-26 14:42:44 -07001102 if ctx.Failed() {
1103 return
Nan Zhanged19fc32017-10-19 13:06:22 -07001104 }
1105 }
Colin Cross8eadbf02017-10-24 17:46:00 -07001106 if len(uniqueSrcFiles) > 0 || len(srcJars) > 0 {
Colin Crossd6891432017-09-27 17:39:56 -07001107 var extraJarDeps android.Paths
Colin Cross66548102018-06-19 22:47:35 -07001108 if ctx.Config().RunErrorProne() {
Colin Crossc6bbef32017-08-14 14:16:06 -07001109 // If error-prone is enabled, add an additional rule to compile the java files into
1110 // a separate set of classes (so that they don't overwrite the normal ones and require
Colin Crossd6891432017-09-27 17:39:56 -07001111 // a rebuild when error-prone is turned off).
Colin Crossc6bbef32017-08-14 14:16:06 -07001112 // TODO(ccross): Once we always compile with javac9 we may be able to conditionally
1113 // enable error-prone without affecting the output class files.
Colin Cross1ee23172017-10-18 14:44:18 -07001114 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001115 RunErrorProne(ctx, errorprone, uniqueSrcFiles, srcJars, flags)
Colin Crossc6bbef32017-08-14 14:16:06 -07001116 extraJarDeps = append(extraJarDeps, errorprone)
1117 }
1118
Nan Zhang61eaedb2017-11-02 13:28:15 -07001119 if enable_sharding {
Nan Zhang581fd212018-01-10 16:06:12 -08001120 flags.classpath = append(flags.classpath, j.headerJarFile)
Nan Zhang61eaedb2017-11-02 13:28:15 -07001121 shardSize := int(*(j.properties.Javac_shard_size))
1122 var shardSrcs []android.Paths
1123 if len(uniqueSrcFiles) > 0 {
1124 shardSrcs = shardPaths(uniqueSrcFiles, shardSize)
1125 for idx, shardSrc := range shardSrcs {
1126 classes := android.PathForModuleOut(ctx, "javac", jarName+strconv.Itoa(idx))
1127 TransformJavaToClasses(ctx, classes, idx, shardSrc, nil, flags, extraJarDeps)
1128 jars = append(jars, classes)
1129 }
1130 }
1131 if len(srcJars) > 0 {
1132 classes := android.PathForModuleOut(ctx, "javac", jarName+strconv.Itoa(len(shardSrcs)))
1133 TransformJavaToClasses(ctx, classes, len(shardSrcs), nil, srcJars, flags, extraJarDeps)
1134 jars = append(jars, classes)
1135 }
1136 } else {
1137 classes := android.PathForModuleOut(ctx, "javac", jarName)
1138 TransformJavaToClasses(ctx, classes, -1, uniqueSrcFiles, srcJars, flags, extraJarDeps)
1139 jars = append(jars, classes)
1140 }
Colin Crossd6891432017-09-27 17:39:56 -07001141 if ctx.Failed() {
1142 return
1143 }
Colin Cross2fe66872015-03-30 17:20:39 -07001144 }
1145
Colin Cross0c4ce212019-05-03 15:28:19 -07001146 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1147
1148 var includeSrcJar android.WritablePath
1149 if Bool(j.properties.Include_srcs) {
1150 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1151 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1152 }
1153
Colin Crosscedd4762018-09-13 11:26:19 -07001154 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1155 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
Colin Cross0f37af02017-09-27 17:42:05 -07001156 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
Colin Cross988708c2019-05-06 14:04:11 -07001157 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
Colin Cross0f37af02017-09-27 17:42:05 -07001158
1159 var resArgs []string
1160 var resDeps android.Paths
1161
1162 resArgs = append(resArgs, dirArgs...)
1163 resDeps = append(resDeps, dirDeps...)
1164
1165 resArgs = append(resArgs, fileArgs...)
1166 resDeps = append(resDeps, fileDeps...)
1167
Colin Cross988708c2019-05-06 14:04:11 -07001168 resArgs = append(resArgs, extraArgs...)
1169 resDeps = append(resDeps, extraDeps...)
1170
Colin Cross40a36712017-09-27 17:41:35 -07001171 if len(resArgs) > 0 {
Colin Cross1ee23172017-10-18 14:44:18 -07001172 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
Colin Crosse9a275b2017-10-16 17:09:48 -07001173 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
Colin Cross331a1212018-08-15 20:40:52 -07001174 j.resourceJar = resourceJar
Colin Cross65bf4f22015-04-03 16:54:17 -07001175 if ctx.Failed() {
1176 return
1177 }
1178 }
1179
Colin Cross0c4ce212019-05-03 15:28:19 -07001180 var resourceJars android.Paths
1181 if j.resourceJar != nil {
1182 resourceJars = append(resourceJars, j.resourceJar)
1183 }
1184 if Bool(j.properties.Include_srcs) {
1185 resourceJars = append(resourceJars, includeSrcJar)
1186 }
1187 resourceJars = append(resourceJars, deps.staticResourceJars...)
Colin Cross331a1212018-08-15 20:40:52 -07001188
Colin Cross0c4ce212019-05-03 15:28:19 -07001189 if len(resourceJars) > 1 {
Colin Cross331a1212018-08-15 20:40:52 -07001190 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
Colin Cross0c4ce212019-05-03 15:28:19 -07001191 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
Colin Cross331a1212018-08-15 20:40:52 -07001192 false, nil, nil)
1193 j.resourceJar = combinedJar
Colin Cross0c4ce212019-05-03 15:28:19 -07001194 } else if len(resourceJars) == 1 {
1195 j.resourceJar = resourceJars[0]
Colin Cross331a1212018-08-15 20:40:52 -07001196 }
1197
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001198 if len(deps.staticJars) > 0 {
1199 jars = append(jars, deps.staticJars...)
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001200 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001201
Colin Cross094054a2018-10-17 15:10:48 -07001202 manifest := j.overrideManifest
1203 if !manifest.Valid() && j.properties.Manifest != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001204 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
Colin Cross366938f2017-12-11 16:29:02 -08001205 }
Colin Cross635acc92017-09-12 22:50:46 -07001206
Colin Cross8a497952019-03-05 22:25:09 -08001207 services := android.PathsForModuleSrc(ctx, j.properties.Services)
Alex Light7f004a72019-02-21 13:27:37 -08001208 if len(services) > 0 {
1209 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1210 var zipargs []string
1211 for _, file := range services {
1212 serviceFile := file.String()
1213 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1214 }
1215 ctx.Build(pctx, android.BuildParams{
1216 Rule: zip,
1217 Output: servicesJar,
1218 Implicits: services,
1219 Args: map[string]string{
Colin Cross0b9f31f2019-02-28 11:00:01 -08001220 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
Alex Light7f004a72019-02-21 13:27:37 -08001221 },
1222 })
1223 jars = append(jars, servicesJar)
1224 }
1225
Colin Cross0a6e0072017-08-30 14:24:55 -07001226 // Combine the classes built from sources, any manifests, and any static libraries into
Nan Zhanged19fc32017-10-19 13:06:22 -07001227 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross3063b782018-08-15 11:19:12 -07001228 var outputFile android.ModuleOutPath
Colin Crosse9a275b2017-10-16 17:09:48 -07001229
1230 if len(jars) == 1 && !manifest.Valid() {
Colin Cross3063b782018-08-15 11:19:12 -07001231 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok {
1232 // Optimization: skip the combine step if there is nothing to do
1233 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1234 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1235 // any if len(jars) == 1.
1236 outputFile = moduleOutPath
1237 } else {
1238 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1239 ctx.Build(pctx, android.BuildParams{
1240 Rule: android.Cp,
1241 Input: jars[0],
1242 Output: combinedJar,
1243 })
1244 outputFile = combinedJar
1245 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001246 } else {
Colin Cross1ee23172017-10-18 14:44:18 -07001247 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001248 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
Colin Cross9b38aef2018-08-27 15:42:25 -07001249 false, nil, nil)
Colin Crosse9a275b2017-10-16 17:09:48 -07001250 outputFile = combinedJar
1251 }
Colin Cross0a6e0072017-08-30 14:24:55 -07001252
Colin Cross331a1212018-08-15 20:40:52 -07001253 // jarjar implementation jar if necessary
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001254 if j.expandJarjarRules != nil {
Colin Cross8649b262017-09-27 18:03:17 -07001255 // Transform classes.jar into classes-jarjar.jar
Colin Cross1ee23172017-10-18 14:44:18 -07001256 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001257 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
Colin Crosse9a275b2017-10-16 17:09:48 -07001258 outputFile = jarjarFile
Colin Cross331a1212018-08-15 20:40:52 -07001259
1260 // jarjar resource jar if necessary
1261 if j.resourceJar != nil {
1262 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001263 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
Colin Cross331a1212018-08-15 20:40:52 -07001264 j.resourceJar = resourceJarJarFile
1265 }
1266
Colin Cross0a6e0072017-08-30 14:24:55 -07001267 if ctx.Failed() {
1268 return
1269 }
1270 }
Vladimir Marko0975ee02019-04-02 10:29:55 +01001271
1272 // Check package restrictions if necessary.
1273 if len(j.properties.Permitted_packages) > 0 {
1274 // Check packages and copy to package-checked file.
1275 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
1276 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
1277 j.additionalCheckedModules = append(j.additionalCheckedModules, pkgckFile)
1278
1279 if ctx.Failed() {
1280 return
1281 }
1282 }
1283
Nan Zhanged19fc32017-10-19 13:06:22 -07001284 j.implementationJarFile = outputFile
1285 if j.headerJarFile == nil {
1286 j.headerJarFile = j.implementationJarFile
1287 }
Colin Cross2fe66872015-03-30 17:20:39 -07001288
Colin Cross6510f912017-11-29 00:27:14 -08001289 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
Colin Crosscb933592017-11-22 13:49:43 -08001290 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
1291 j.properties.Instrument = true
1292 }
1293 }
1294
Colin Cross3144dfc2018-01-03 15:06:47 -08001295 if j.shouldInstrument(ctx) {
Colin Crosscb933592017-11-22 13:49:43 -08001296 outputFile = j.instrument(ctx, flags, outputFile, jarName)
1297 }
1298
Colin Cross331a1212018-08-15 20:40:52 -07001299 // merge implementation jar with resources if necessary
1300 implementationAndResourcesJar := outputFile
1301 if j.resourceJar != nil {
Colin Cross08a409d2019-04-29 10:22:44 -07001302 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Colin Cross331a1212018-08-15 20:40:52 -07001303 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Colin Cross08a409d2019-04-29 10:22:44 -07001304 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
Colin Cross331a1212018-08-15 20:40:52 -07001305 false, nil, nil)
1306 implementationAndResourcesJar = combinedJar
1307 }
1308
1309 j.implementationAndResourcesJar = implementationAndResourcesJar
1310
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001311 if ctx.Device() && j.hasCode(ctx) &&
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001312 (Bool(j.properties.Installable) || Bool(j.deviceProperties.Compile_dex)) {
Colin Cross8faf8fc2019-01-16 15:15:52 -08001313 // Dex compilation
Colin Cross3063b782018-08-15 11:19:12 -07001314 var dexOutputFile android.ModuleOutPath
David Brazdil17ef5632018-06-27 10:27:45 +01001315 dexOutputFile = j.compileDex(ctx, flags, outputFile, jarName)
Colin Cross2fe66872015-03-30 17:20:39 -07001316 if ctx.Failed() {
1317 return
1318 }
Colin Cross331a1212018-08-15 20:40:52 -07001319
Jiyong Park09cb6292019-07-15 15:29:23 +09001320 // Hidden API CSV generation and dex encoding
1321 dexOutputFile = j.hiddenAPI.hiddenAPI(ctx, dexOutputFile, j.implementationJarFile,
1322 j.deviceProperties.UncompressDex)
Colin Cross8faf8fc2019-01-16 15:15:52 -08001323
Colin Cross331a1212018-08-15 20:40:52 -07001324 // merge dex jar with resources if necessary
1325 if j.resourceJar != nil {
1326 jars := android.Paths{dexOutputFile, j.resourceJar}
1327 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
1328 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1329 false, nil, nil)
Nicolas Geoffrayf3438722019-01-23 15:57:21 +00001330 if j.deviceProperties.UncompressDex {
1331 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
1332 TransformZipAlign(ctx, combinedAlignedJar, combinedJar)
1333 dexOutputFile = combinedAlignedJar
1334 } else {
1335 dexOutputFile = combinedJar
1336 }
Colin Cross331a1212018-08-15 20:40:52 -07001337 }
1338
1339 j.dexJarFile = dexOutputFile
1340
Colin Cross8faf8fc2019-01-16 15:15:52 -08001341 // Dexpreopting
Colin Cross43f08db2018-11-12 10:13:39 -08001342 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
1343
1344 j.maybeStrippedDexJarFile = dexOutputFile
1345
Colin Cross3063b782018-08-15 11:19:12 -07001346 outputFile = dexOutputFile
Colin Cross43f08db2018-11-12 10:13:39 -08001347
1348 if ctx.Failed() {
1349 return
1350 }
Colin Cross331a1212018-08-15 20:40:52 -07001351 } else {
1352 outputFile = implementationAndResourcesJar
Colin Cross2fe66872015-03-30 17:20:39 -07001353 }
Colin Cross331a1212018-08-15 20:40:52 -07001354
Colin Crossb7a63242015-04-16 14:09:14 -07001355 ctx.CheckbuildFile(outputFile)
Colin Cross3063b782018-08-15 11:19:12 -07001356
1357 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1358 j.outputFile = outputFile.WithoutRel()
Colin Cross2fe66872015-03-30 17:20:39 -07001359}
1360
Zoran Jovanovic8736ce22018-08-21 17:10:29 +02001361// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1362// since some of these flags may be used internally.
1363func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1364 for _, flag := range flags {
1365 flag = strings.TrimSpace(flag)
1366
1367 if !strings.HasPrefix(flag, "-") {
1368 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1369 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1370 ctx.PropertyErrorf("kotlincflags",
1371 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1372 } else if inList(flag, config.KotlincIllegalFlags) {
1373 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1374 } else if flag == "-include-runtime" {
1375 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1376 } else {
1377 args := strings.Split(flag, " ")
1378 if args[0] == "-kotlin-home" {
1379 ctx.PropertyErrorf("kotlincflags",
1380 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1381 }
1382 }
1383 }
1384}
1385
Colin Cross8eadbf02017-10-24 17:46:00 -07001386func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
Colin Cross55f63ea2018-08-27 12:37:09 -07001387 deps deps, flags javaBuilderFlags, jarName string, extraJars android.Paths) android.Path {
Nan Zhanged19fc32017-10-19 13:06:22 -07001388
1389 var jars android.Paths
Colin Cross8eadbf02017-10-24 17:46:00 -07001390 if len(srcFiles) > 0 || len(srcJars) > 0 {
Nan Zhanged19fc32017-10-19 13:06:22 -07001391 // Compile java sources into turbine.jar.
1392 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1393 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1394 if ctx.Failed() {
1395 return nil
1396 }
1397 jars = append(jars, turbineJar)
1398 }
1399
Colin Cross55f63ea2018-08-27 12:37:09 -07001400 jars = append(jars, extraJars...)
1401
Nan Zhanged19fc32017-10-19 13:06:22 -07001402 // Combine any static header libraries into classes-header.jar. If there is only
1403 // one input jar this step will be skipped.
1404 var headerJar android.Path
1405 jars = append(jars, deps.staticHeaderJars...)
1406
Colin Cross5c6ecc12017-10-23 18:12:27 -07001407 // we cannot skip the combine step for now if there is only one jar
1408 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1409 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001410 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
Colin Cross6c6e6cd2019-05-08 14:30:12 -07001411 false, nil, []string{"META-INF/TRANSITIVE"})
Colin Cross5c6ecc12017-10-23 18:12:27 -07001412 headerJar = combinedJar
Nan Zhanged19fc32017-10-19 13:06:22 -07001413
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001414 if j.expandJarjarRules != nil {
Nan Zhanged19fc32017-10-19 13:06:22 -07001415 // Transform classes.jar into classes-jarjar.jar
1416 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001417 TransformJarJar(ctx, jarjarFile, headerJar, j.expandJarjarRules)
Nan Zhanged19fc32017-10-19 13:06:22 -07001418 headerJar = jarjarFile
1419 if ctx.Failed() {
1420 return nil
1421 }
1422 }
1423
1424 return headerJar
1425}
1426
Colin Crosscb933592017-11-22 13:49:43 -08001427func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross3063b782018-08-15 11:19:12 -07001428 classesJar android.Path, jarName string) android.ModuleOutPath {
Colin Crosscb933592017-11-22 13:49:43 -08001429
Colin Cross7a3139e2017-12-19 13:57:50 -08001430 specs := j.jacocoModuleToZipCommand(ctx)
Colin Crosscb933592017-11-22 13:49:43 -08001431
Colin Cross84c38822018-01-03 15:59:46 -08001432 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Crosscb933592017-11-22 13:49:43 -08001433 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
1434
1435 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1436
1437 j.jacocoReportClassesFile = jacocoReportClassesFile
1438
1439 return instrumentedJar
1440}
1441
albaltai36ff7dc2018-12-25 14:35:23 +08001442var _ Dependency = (*Module)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001443
Nan Zhanged19fc32017-10-19 13:06:22 -07001444func (j *Module) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001445 if j.headerJarFile == nil {
1446 return nil
1447 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001448 return android.Paths{j.headerJarFile}
1449}
1450
1451func (j *Module) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08001452 if j.implementationJarFile == nil {
1453 return nil
1454 }
Nan Zhanged19fc32017-10-19 13:06:22 -07001455 return android.Paths{j.implementationJarFile}
Colin Cross2fe66872015-03-30 17:20:39 -07001456}
1457
Colin Crossf24a22a2019-01-31 14:12:44 -08001458func (j *Module) DexJar() android.Path {
1459 return j.dexJarFile
1460}
1461
Colin Cross331a1212018-08-15 20:40:52 -07001462func (j *Module) ResourceJars() android.Paths {
1463 if j.resourceJar == nil {
1464 return nil
1465 }
1466 return android.Paths{j.resourceJar}
1467}
1468
1469func (j *Module) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001470 if j.implementationAndResourcesJar == nil {
1471 return nil
1472 }
Colin Cross331a1212018-08-15 20:40:52 -07001473 return android.Paths{j.implementationAndResourcesJar}
1474}
1475
Colin Cross46c9b8b2017-06-22 16:51:17 -07001476func (j *Module) AidlIncludeDirs() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001477 // exportAidlIncludeDirs is type android.Paths already
Colin Crossc0b06f12015-04-08 13:03:43 -07001478 return j.exportAidlIncludeDirs
1479}
1480
Jiyong Park1be96912018-05-28 18:02:19 +09001481func (j *Module) ExportedSdkLibs() []string {
albaltai36ff7dc2018-12-25 14:35:23 +08001482 // exportedSdkLibs is type []string
Jiyong Park1be96912018-05-28 18:02:19 +09001483 return j.exportedSdkLibs
1484}
1485
Colin Cross0c4ce212019-05-03 15:28:19 -07001486func (j *Module) SrcJarArgs() ([]string, android.Paths) {
1487 return j.srcJarArgs, j.srcJarDeps
1488}
1489
Colin Cross46c9b8b2017-06-22 16:51:17 -07001490var _ logtagsProducer = (*Module)(nil)
Colin Crossf05fe972015-04-10 17:45:20 -07001491
Colin Cross46c9b8b2017-06-22 16:51:17 -07001492func (j *Module) logtags() android.Paths {
Colin Crossf05fe972015-04-10 17:45:20 -07001493 return j.logtagsSrcs
1494}
1495
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001496// Collect information for opening IDE project files in java/jdeps.go.
1497func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
1498 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
1499 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
patricktu18c82ff2019-05-10 15:48:50 +08001500 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001501 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Steven Morelandc4efd9c2019-01-18 11:51:25 -08001502 if j.expandJarjarRules != nil {
1503 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001504 }
1505}
1506
1507func (j *Module) CompilerDeps() []string {
1508 jdeps := []string{}
1509 jdeps = append(jdeps, j.properties.Libs...)
1510 jdeps = append(jdeps, j.properties.Static_libs...)
1511 return jdeps
1512}
1513
Jaewoong Jungc27ab662019-05-30 15:51:14 -07001514func (j *Module) hasCode(ctx android.ModuleContext) bool {
1515 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
1516 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
1517}
1518
Colin Cross2fe66872015-03-30 17:20:39 -07001519//
1520// Java libraries (.jar file)
1521//
1522
Colin Crossf506d872017-07-19 15:53:04 -07001523type Library struct {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001524 Module
Colin Cross2fe66872015-03-30 17:20:39 -07001525}
1526
Colin Cross42be7612019-02-21 18:12:14 -08001527func shouldUncompressDex(ctx android.ModuleContext, dexpreopter *dexpreopter) bool {
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001528 // Store uncompressed (and do not strip) dex files from boot class path jars.
1529 if inList(ctx.ModuleName(), ctx.Config().BootJars()) {
1530 return true
1531 }
1532
1533 // Store uncompressed dex files that are preopted on /system.
Colin Cross42be7612019-02-21 18:12:14 -08001534 if !dexpreopter.dexpreoptDisabled(ctx) && (ctx.Host() || !odexOnSystemOther(ctx, dexpreopter.installPath)) {
Vladimir Markoe8b00d62018-12-21 15:54:16 +00001535 return true
1536 }
Colin Cross083a2aa2019-02-06 16:37:12 -08001537 if ctx.Config().UncompressPrivAppDex() &&
1538 inList(ctx.ModuleName(), ctx.Config().ModulesLoadedByPrivilegedModules()) {
1539 return true
1540 }
1541
Colin Cross2fc72f62018-12-21 12:59:54 -08001542 return false
1543}
1544
Colin Crossf506d872017-07-19 15:53:04 -07001545func (j *Library) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross43f08db2018-11-12 10:13:39 -08001546 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", ctx.ModuleName()+".jar")
1547 j.dexpreopter.isSDKLibrary = j.deviceProperties.IsSDKLibrary
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001548 j.dexpreopter.isInstallable = Bool(j.properties.Installable)
Colin Cross42be7612019-02-21 18:12:14 -08001549 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
Nicolas Geoffrayfa6e9ec2019-02-12 13:12:16 +00001550 j.deviceProperties.UncompressDex = j.dexpreopter.uncompressedDex
Jaewoong Junga24af3b2019-05-13 09:23:20 -07001551 j.compile(ctx, nil)
Colin Crossb7a63242015-04-16 14:09:14 -07001552
Nicolas Geoffray4bdea392019-01-15 11:48:08 +00001553 if (Bool(j.properties.Installable) || ctx.Host()) && !android.DirectlyInAnyApex(ctx, ctx.ModuleName()) {
Colin Cross2c429dc2017-08-31 16:45:16 -07001554 j.installFile = ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
1555 ctx.ModuleName()+".jar", j.outputFile)
1556 }
Colin Crossb7a63242015-04-16 14:09:14 -07001557}
1558
Colin Crossf506d872017-07-19 15:53:04 -07001559func (j *Library) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross46c9b8b2017-06-22 16:51:17 -07001560 j.deps(ctx)
1561}
1562
Colin Cross1b16b0e2019-02-12 14:41:32 -08001563// java_library builds and links sources into a `.jar` file for the device, and possibly for the host as well.
1564//
1565// By default, a java_library has a single variant that produces a `.jar` file containing `.class` files that were
1566// compiled against the device bootclasspath. This jar is not suitable for installing on a device, but can be used
1567// as a `static_libs` dependency of another module.
1568//
1569// Specifying `installable: true` will product a `.jar` file containing `classes.dex` files, suitable for installing on
1570// a device.
1571//
1572// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1573// compiled against the host bootclasspath.
Colin Cross9ae1b922018-06-26 17:59:05 -07001574func LibraryFactory() android.Module {
1575 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07001576
Colin Cross9ae1b922018-06-26 17:59:05 -07001577 module.AddProperties(
1578 &module.Module.properties,
1579 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001580 &module.Module.dexpreoptProperties,
Colin Cross9ae1b922018-06-26 17:59:05 -07001581 &module.Module.protoProperties)
Colin Cross2fe66872015-03-30 17:20:39 -07001582
Colin Cross9ae1b922018-06-26 17:59:05 -07001583 InitJavaModule(module, android.HostAndDeviceSupported)
1584 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001585}
1586
Colin Cross1b16b0e2019-02-12 14:41:32 -08001587// java_library_static is an obsolete alias for java_library.
1588func LibraryStaticFactory() android.Module {
1589 return LibraryFactory()
1590}
1591
1592// java_library_host builds and links sources into a `.jar` file for the host.
1593//
1594// A java_library_host has a single variant that produces a `.jar` file containing `.class` files that were
1595// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001596func LibraryHostFactory() android.Module {
1597 module := &Library{}
Colin Cross2fe66872015-03-30 17:20:39 -07001598
Colin Cross6af17aa2017-09-20 12:59:05 -07001599 module.AddProperties(
1600 &module.Module.properties,
1601 &module.Module.protoProperties)
Colin Cross36242852017-06-23 15:06:31 -07001602
Colin Cross9ae1b922018-06-26 17:59:05 -07001603 module.Module.properties.Installable = proptools.BoolPtr(true)
1604
Colin Cross89536d42017-07-07 14:35:50 -07001605 InitJavaModule(module, android.HostSupported)
Colin Cross36242852017-06-23 15:06:31 -07001606 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001607}
1608
1609//
Colin Crossb628ea52018-08-14 16:42:33 -07001610// Java Tests
Colin Cross05638fc2018-04-09 18:40:24 -07001611//
1612
1613type testProperties struct {
Colin Cross05638fc2018-04-09 18:40:24 -07001614 // list of compatibility suites (for example "cts", "vts") that the module should be
1615 // installed into.
1616 Test_suites []string `android:"arch_variant"`
Julien Despreze146e392018-08-02 15:00:46 -07001617
1618 // the name of the test configuration (for example "AndroidTest.xml") that should be
1619 // installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08001620 Test_config *string `android:"path,arch_variant"`
Colin Crossd96ca352018-08-10 16:06:24 -07001621
Jack He33338892018-09-19 02:21:28 -07001622 // the name of the test configuration template (for example "AndroidTestTemplate.xml") that
1623 // should be installed with the module.
Colin Cross27b922f2019-03-04 22:35:41 -08001624 Test_config_template *string `android:"path,arch_variant"`
Jack He33338892018-09-19 02:21:28 -07001625
Colin Crossd96ca352018-08-10 16:06:24 -07001626 // list of files or filegroup modules that provide data that should be installed alongside
1627 // the test
Colin Cross27b922f2019-03-04 22:35:41 -08001628 Data []string `android:"path"`
Colin Cross05638fc2018-04-09 18:40:24 -07001629}
1630
Paul Duffin42df1442019-03-20 12:45:53 +00001631type testHelperLibraryProperties struct {
1632 // list of compatibility suites (for example "cts", "vts") that the module should be
1633 // installed into.
1634 Test_suites []string `android:"arch_variant"`
1635}
1636
Colin Cross05638fc2018-04-09 18:40:24 -07001637type Test struct {
1638 Library
1639
1640 testProperties testProperties
Colin Cross303e21f2018-08-07 16:49:25 -07001641
1642 testConfig android.Path
Colin Crossd96ca352018-08-10 16:06:24 -07001643 data android.Paths
Colin Cross303e21f2018-08-07 16:49:25 -07001644}
1645
Paul Duffin42df1442019-03-20 12:45:53 +00001646type TestHelperLibrary struct {
1647 Library
1648
1649 testHelperLibraryProperties testHelperLibraryProperties
1650}
1651
Colin Cross303e21f2018-08-07 16:49:25 -07001652func (j *Test) GenerateAndroidBuildActions(ctx android.ModuleContext) {
yangbill4f41bc22019-02-13 21:45:47 +08001653 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 -08001654 j.data = android.PathsForModuleSrc(ctx, j.testProperties.Data)
Colin Cross303e21f2018-08-07 16:49:25 -07001655
1656 j.Library.GenerateAndroidBuildActions(ctx)
Colin Cross05638fc2018-04-09 18:40:24 -07001657}
1658
Paul Duffin42df1442019-03-20 12:45:53 +00001659func (j *TestHelperLibrary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
1660 j.Library.GenerateAndroidBuildActions(ctx)
1661}
1662
Colin Cross1b16b0e2019-02-12 14:41:32 -08001663// java_test builds a and links sources into a `.jar` file for the device, and possibly for the host as well, and
1664// creates an `AndroidTest.xml` file to allow running the test with `atest` or a `TEST_MAPPING` file.
1665//
1666// By default, a java_test has a single variant that produces a `.jar` file containing `classes.dex` files that were
1667// compiled against the device bootclasspath.
1668//
1669// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1670// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07001671func TestFactory() android.Module {
1672 module := &Test{}
1673
1674 module.AddProperties(
1675 &module.Module.properties,
1676 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001677 &module.Module.dexpreoptProperties,
Colin Cross05638fc2018-04-09 18:40:24 -07001678 &module.Module.protoProperties,
1679 &module.testProperties)
1680
Colin Cross9ae1b922018-06-26 17:59:05 -07001681 module.Module.properties.Installable = proptools.BoolPtr(true)
Colin Crosse3026872019-01-05 22:30:13 -08001682 module.Module.dexpreopter.isTest = true
Colin Cross9ae1b922018-06-26 17:59:05 -07001683
Colin Cross05638fc2018-04-09 18:40:24 -07001684 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07001685 return module
1686}
1687
Paul Duffin42df1442019-03-20 12:45:53 +00001688// java_test_helper_library creates a java library and makes sure that it is added to the appropriate test suite.
1689func TestHelperLibraryFactory() android.Module {
1690 module := &TestHelperLibrary{}
1691
1692 module.AddProperties(
1693 &module.Module.properties,
1694 &module.Module.deviceProperties,
1695 &module.Module.dexpreoptProperties,
1696 &module.Module.protoProperties,
1697 &module.testHelperLibraryProperties)
1698
Colin Cross9a4abed2019-04-24 13:19:28 -07001699 module.Module.properties.Installable = proptools.BoolPtr(true)
1700 module.Module.dexpreopter.isTest = true
1701
Paul Duffin42df1442019-03-20 12:45:53 +00001702 InitJavaModule(module, android.HostAndDeviceSupported)
1703 return module
1704}
1705
Colin Cross1b16b0e2019-02-12 14:41:32 -08001706// java_test_host builds a and links sources into a `.jar` file for the host, and creates an `AndroidTest.xml` file to
1707// allow running the test with `atest` or a `TEST_MAPPING` file.
1708//
1709// A java_test_host has a single variant that produces a `.jar` file containing `.class` files that were
1710// compiled against the host bootclasspath.
Colin Cross05638fc2018-04-09 18:40:24 -07001711func TestHostFactory() android.Module {
1712 module := &Test{}
1713
1714 module.AddProperties(
1715 &module.Module.properties,
1716 &module.Module.protoProperties,
1717 &module.testProperties)
1718
Colin Cross9ae1b922018-06-26 17:59:05 -07001719 module.Module.properties.Installable = proptools.BoolPtr(true)
1720
Colin Cross05638fc2018-04-09 18:40:24 -07001721 InitJavaModule(module, android.HostSupported)
Colin Cross05638fc2018-04-09 18:40:24 -07001722 return module
1723}
1724
1725//
Colin Cross2fe66872015-03-30 17:20:39 -07001726// Java Binaries (.jar file plus wrapper script)
1727//
1728
Colin Crossf506d872017-07-19 15:53:04 -07001729type binaryProperties struct {
Colin Cross7d5136f2015-05-11 13:39:40 -07001730 // installable script to execute the resulting jar
Colin Cross27b922f2019-03-04 22:35:41 -08001731 Wrapper *string `android:"path"`
Colin Cross094054a2018-10-17 15:10:48 -07001732
1733 // Name of the class containing main to be inserted into the manifest as Main-Class.
1734 Main_class *string
Colin Cross7d5136f2015-05-11 13:39:40 -07001735}
1736
Colin Crossf506d872017-07-19 15:53:04 -07001737type Binary struct {
1738 Library
Colin Cross2fe66872015-03-30 17:20:39 -07001739
Colin Crossf506d872017-07-19 15:53:04 -07001740 binaryProperties binaryProperties
Colin Cross10a03492017-08-10 17:09:43 -07001741
Colin Cross6b4a32d2017-12-05 13:42:45 -08001742 isWrapperVariant bool
1743
Colin Crossc3315992017-12-08 19:12:36 -08001744 wrapperFile android.Path
Colin Cross10a03492017-08-10 17:09:43 -07001745 binaryFile android.OutputPath
Colin Cross2fe66872015-03-30 17:20:39 -07001746}
1747
Alex Light24237172017-10-26 09:46:21 -07001748func (j *Binary) HostToolPath() android.OptionalPath {
1749 return android.OptionalPathForPath(j.binaryFile)
1750}
1751
Colin Crossf506d872017-07-19 15:53:04 -07001752func (j *Binary) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001753 if ctx.Arch().ArchType == android.Common {
1754 // Compile the jar
Colin Cross094054a2018-10-17 15:10:48 -07001755 if j.binaryProperties.Main_class != nil {
1756 if j.properties.Manifest != nil {
1757 ctx.PropertyErrorf("main_class", "main_class cannot be used when manifest is set")
1758 }
1759 manifestFile := android.PathForModuleOut(ctx, "manifest.txt")
1760 GenerateMainClassManifest(ctx, manifestFile, String(j.binaryProperties.Main_class))
1761 j.overrideManifest = android.OptionalPathForPath(manifestFile)
1762 }
1763
Colin Cross6b4a32d2017-12-05 13:42:45 -08001764 j.Library.GenerateAndroidBuildActions(ctx)
Nan Zhang3c807db2017-11-03 14:53:31 -07001765 } else {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001766 // Handle the binary wrapper
1767 j.isWrapperVariant = true
1768
Colin Cross366938f2017-12-11 16:29:02 -08001769 if j.binaryProperties.Wrapper != nil {
Colin Cross8a497952019-03-05 22:25:09 -08001770 j.wrapperFile = android.PathForModuleSrc(ctx, *j.binaryProperties.Wrapper)
Colin Cross6b4a32d2017-12-05 13:42:45 -08001771 } else {
1772 j.wrapperFile = android.PathForSource(ctx, "build/soong/scripts/jar-wrapper.sh")
1773 }
1774
1775 // Depend on the installed jar so that the wrapper doesn't get executed by
1776 // another build rule before the jar has been installed.
1777 jarFile := ctx.PrimaryModule().(*Binary).installFile
1778
1779 j.binaryFile = ctx.InstallExecutable(android.PathForModuleInstall(ctx, "bin"),
1780 ctx.ModuleName(), j.wrapperFile, jarFile)
Nan Zhang3c807db2017-11-03 14:53:31 -07001781 }
Colin Cross2fe66872015-03-30 17:20:39 -07001782}
1783
Colin Crossf506d872017-07-19 15:53:04 -07001784func (j *Binary) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross6b4a32d2017-12-05 13:42:45 -08001785 if ctx.Arch().ArchType == android.Common {
1786 j.deps(ctx)
1787 }
Colin Cross46c9b8b2017-06-22 16:51:17 -07001788}
1789
Colin Cross1b16b0e2019-02-12 14:41:32 -08001790// java_binary builds a `.jar` file and a shell script that executes it for the device, and possibly for the host
1791// as well.
1792//
1793// By default, a java_binary has a single variant that produces a `.jar` file containing `classes.dex` files that were
1794// compiled against the device bootclasspath.
1795//
1796// Specifying `host_supported: true` will produce two variants, one compiled against the device bootclasspath and one
1797// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001798func BinaryFactory() android.Module {
1799 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07001800
Colin Cross36242852017-06-23 15:06:31 -07001801 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07001802 &module.Module.properties,
1803 &module.Module.deviceProperties,
Colin Cross43f08db2018-11-12 10:13:39 -08001804 &module.Module.dexpreoptProperties,
Colin Cross6af17aa2017-09-20 12:59:05 -07001805 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07001806 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07001807
Colin Cross9ae1b922018-06-26 17:59:05 -07001808 module.Module.properties.Installable = proptools.BoolPtr(true)
1809
Colin Cross6b4a32d2017-12-05 13:42:45 -08001810 android.InitAndroidArchModule(module, android.HostAndDeviceSupported, android.MultilibCommonFirst)
1811 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07001812 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001813}
1814
Colin Cross1b16b0e2019-02-12 14:41:32 -08001815// java_binary_host builds a `.jar` file and a shell script that executes it for the host.
1816//
1817// A java_binary_host has a single variant that produces a `.jar` file containing `.class` files that were
1818// compiled against the host bootclasspath.
Colin Crossf506d872017-07-19 15:53:04 -07001819func BinaryHostFactory() android.Module {
1820 module := &Binary{}
Colin Cross2fe66872015-03-30 17:20:39 -07001821
Colin Cross36242852017-06-23 15:06:31 -07001822 module.AddProperties(
Colin Cross540eff82017-06-22 17:01:52 -07001823 &module.Module.properties,
Colin Cross6af17aa2017-09-20 12:59:05 -07001824 &module.Module.protoProperties,
Colin Cross540eff82017-06-22 17:01:52 -07001825 &module.binaryProperties)
Colin Cross36242852017-06-23 15:06:31 -07001826
Colin Cross9ae1b922018-06-26 17:59:05 -07001827 module.Module.properties.Installable = proptools.BoolPtr(true)
1828
Colin Cross6b4a32d2017-12-05 13:42:45 -08001829 android.InitAndroidArchModule(module, android.HostSupported, android.MultilibCommonFirst)
1830 android.InitDefaultableModule(module)
Colin Cross36242852017-06-23 15:06:31 -07001831 return module
Colin Cross2fe66872015-03-30 17:20:39 -07001832}
1833
1834//
1835// Java prebuilts
1836//
1837
Colin Cross74d73e22017-08-02 11:05:49 -07001838type ImportProperties struct {
Colin Cross27b922f2019-03-04 22:35:41 -08001839 Jars []string `android:"path"`
Colin Cross461bd1a2017-10-20 13:59:18 -07001840
Nan Zhangea568a42017-11-08 21:20:04 -08001841 Sdk_version *string
Colin Cross535e2cf2017-10-20 17:57:49 -07001842
1843 Installable *bool
Jiyong Park1be96912018-05-28 18:02:19 +09001844
1845 // List of shared java libs that this module has dependencies to
1846 Libs []string
Colin Cross37f6d792018-07-12 12:28:41 -07001847
1848 // List of files to remove from the jar file(s)
1849 Exclude_files []string
1850
1851 // List of directories to remove from the jar file(s)
1852 Exclude_dirs []string
Nan Zhang4c819fb2018-08-27 18:31:46 -07001853
1854 // if set to true, run Jetifier against .jar file. Defaults to false.
Colin Cross1001a792019-03-21 22:21:39 -07001855 Jetifier *bool
Colin Cross74d73e22017-08-02 11:05:49 -07001856}
1857
1858type Import struct {
Colin Cross635c3b02016-05-18 15:37:25 -07001859 android.ModuleBase
Colin Cross48de9a42018-10-02 13:53:33 -07001860 android.DefaultableModuleBase
Colin Crossec7a0422017-07-07 14:47:12 -07001861 prebuilt android.Prebuilt
Colin Cross2fe66872015-03-30 17:20:39 -07001862
Colin Cross74d73e22017-08-02 11:05:49 -07001863 properties ImportProperties
1864
Colin Cross0a6e0072017-08-30 14:24:55 -07001865 combinedClasspathFile android.Path
Jiyong Park1be96912018-05-28 18:02:19 +09001866 exportedSdkLibs []string
Colin Cross2fe66872015-03-30 17:20:39 -07001867}
1868
Colin Cross83bb3162018-06-25 15:48:06 -07001869func (j *Import) sdkVersion() string {
Jeongik Cha6bd33c12019-06-25 16:26:18 +09001870 return proptools.StringDefault(j.properties.Sdk_version, defaultSdkVersion(j))
Colin Cross83bb3162018-06-25 15:48:06 -07001871}
1872
1873func (j *Import) minSdkVersion() string {
1874 return j.sdkVersion()
1875}
1876
Colin Cross74d73e22017-08-02 11:05:49 -07001877func (j *Import) Prebuilt() *android.Prebuilt {
Colin Crossec7a0422017-07-07 14:47:12 -07001878 return &j.prebuilt
1879}
1880
Colin Cross74d73e22017-08-02 11:05:49 -07001881func (j *Import) PrebuiltSrcs() []string {
1882 return j.properties.Jars
1883}
1884
1885func (j *Import) Name() string {
Colin Cross5ea9bcc2017-07-27 15:41:32 -07001886 return j.prebuilt.Name(j.ModuleBase.Name())
1887}
1888
Colin Cross74d73e22017-08-02 11:05:49 -07001889func (j *Import) DepsMutator(ctx android.BottomUpMutatorContext) {
Colin Cross42d48b72018-08-29 14:10:52 -07001890 ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Colin Cross1e676be2016-10-12 14:38:15 -07001891}
1892
Colin Cross74d73e22017-08-02 11:05:49 -07001893func (j *Import) GenerateAndroidBuildActions(ctx android.ModuleContext) {
Colin Cross8a497952019-03-05 22:25:09 -08001894 jars := android.PathsForModuleSrc(ctx, j.properties.Jars)
Colin Crosse1d62a82015-04-03 16:53:05 -07001895
Nan Zhang4c819fb2018-08-27 18:31:46 -07001896 jarName := ctx.ModuleName() + ".jar"
1897 outputFile := android.PathForModuleOut(ctx, "combined", jarName)
Colin Cross37f6d792018-07-12 12:28:41 -07001898 TransformJarsToJar(ctx, outputFile, "for prebuilts", jars, android.OptionalPath{},
1899 false, j.properties.Exclude_files, j.properties.Exclude_dirs)
Colin Cross1001a792019-03-21 22:21:39 -07001900 if Bool(j.properties.Jetifier) {
Nan Zhang4c819fb2018-08-27 18:31:46 -07001901 inputFile := outputFile
1902 outputFile = android.PathForModuleOut(ctx, "jetifier", jarName)
1903 TransformJetifier(ctx, outputFile, inputFile)
1904 }
Colin Crosse9a275b2017-10-16 17:09:48 -07001905 j.combinedClasspathFile = outputFile
Jiyong Park1be96912018-05-28 18:02:19 +09001906
1907 ctx.VisitDirectDeps(func(module android.Module) {
1908 otherName := ctx.OtherModuleName(module)
1909 tag := ctx.OtherModuleDependencyTag(module)
1910
1911 switch dep := module.(type) {
1912 case Dependency:
1913 switch tag {
1914 case libTag, staticLibTag:
1915 // sdk lib names from dependencies are re-exported
1916 j.exportedSdkLibs = append(j.exportedSdkLibs, dep.ExportedSdkLibs()...)
1917 }
1918 case SdkLibraryDependency:
1919 switch tag {
1920 case libTag:
1921 // names of sdk libs that are directly depended are exported
1922 j.exportedSdkLibs = append(j.exportedSdkLibs, otherName)
1923 }
1924 }
1925 })
1926
1927 j.exportedSdkLibs = android.FirstUniqueStrings(j.exportedSdkLibs)
Nan Zhang4973ecf2018-08-10 13:42:12 -07001928 if Bool(j.properties.Installable) {
1929 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
1930 ctx.ModuleName()+".jar", outputFile)
1931 }
Colin Cross2fe66872015-03-30 17:20:39 -07001932}
1933
Colin Cross74d73e22017-08-02 11:05:49 -07001934var _ Dependency = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07001935
Nan Zhanged19fc32017-10-19 13:06:22 -07001936func (j *Import) HeaderJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001937 if j.combinedClasspathFile == nil {
1938 return nil
1939 }
Colin Cross37f6d792018-07-12 12:28:41 -07001940 return android.Paths{j.combinedClasspathFile}
Nan Zhanged19fc32017-10-19 13:06:22 -07001941}
1942
1943func (j *Import) ImplementationJars() android.Paths {
shinwang9e4c07a2018-12-24 15:41:04 +08001944 if j.combinedClasspathFile == nil {
1945 return nil
1946 }
Colin Cross37f6d792018-07-12 12:28:41 -07001947 return android.Paths{j.combinedClasspathFile}
Colin Cross2fe66872015-03-30 17:20:39 -07001948}
1949
Colin Cross331a1212018-08-15 20:40:52 -07001950func (j *Import) ResourceJars() android.Paths {
1951 return nil
1952}
1953
1954func (j *Import) ImplementationAndResourcesJars() android.Paths {
albaltai36ff7dc2018-12-25 14:35:23 +08001955 if j.combinedClasspathFile == nil {
1956 return nil
1957 }
Colin Cross331a1212018-08-15 20:40:52 -07001958 return android.Paths{j.combinedClasspathFile}
1959}
1960
Colin Crossf24a22a2019-01-31 14:12:44 -08001961func (j *Import) DexJar() android.Path {
1962 return nil
1963}
1964
Colin Cross74d73e22017-08-02 11:05:49 -07001965func (j *Import) AidlIncludeDirs() android.Paths {
Colin Crossc0b06f12015-04-08 13:03:43 -07001966 return nil
1967}
1968
Jiyong Park1be96912018-05-28 18:02:19 +09001969func (j *Import) ExportedSdkLibs() []string {
1970 return j.exportedSdkLibs
1971}
1972
Colin Cross0c4ce212019-05-03 15:28:19 -07001973func (j *Import) SrcJarArgs() ([]string, android.Paths) {
1974 return nil, nil
1975}
1976
albaltai36ff7dc2018-12-25 14:35:23 +08001977// Add compile time check for interface implementation
1978var _ android.IDEInfo = (*Import)(nil)
1979var _ android.IDECustomizedModuleName = (*Import)(nil)
1980
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001981// Collect information for opening IDE project files in java/jdeps.go.
1982const (
1983 removedPrefix = "prebuilt_"
1984)
1985
1986func (j *Import) IDEInfo(dpInfo *android.IdeInfo) {
1987 dpInfo.Jars = append(dpInfo.Jars, j.PrebuiltSrcs()...)
1988}
1989
1990func (j *Import) IDECustomizedModuleName() string {
1991 // TODO(b/113562217): Extract the base module name from the Import name, often the Import name
1992 // has a prefix "prebuilt_". Remove the prefix explicitly if needed until we find a better
1993 // solution to get the Import name.
1994 name := j.Name()
1995 if strings.HasPrefix(name, removedPrefix) {
patricktubb640e02018-10-11 18:33:16 +08001996 name = strings.TrimPrefix(name, removedPrefix)
Brandon Lee5d45c6f2018-08-15 15:35:38 -07001997 }
1998 return name
1999}
2000
Colin Cross74d73e22017-08-02 11:05:49 -07002001var _ android.PrebuiltInterface = (*Import)(nil)
Colin Cross2fe66872015-03-30 17:20:39 -07002002
Colin Cross1b16b0e2019-02-12 14:41:32 -08002003// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library module.
2004//
2005// By default, a java_import has a single variant that expects a `.jar` file containing `.class` files that were
2006// compiled against an Android classpath.
2007//
2008// Specifying `host_supported: true` will produce two variants, one for use as a dependency of device modules and one
2009// for host modules.
Colin Cross74d73e22017-08-02 11:05:49 -07002010func ImportFactory() android.Module {
2011 module := &Import{}
Colin Cross36242852017-06-23 15:06:31 -07002012
Colin Cross74d73e22017-08-02 11:05:49 -07002013 module.AddProperties(&module.properties)
2014
2015 android.InitPrebuiltModule(module, &module.properties.Jars)
Colin Cross48de9a42018-10-02 13:53:33 -07002016 InitJavaModule(module, android.HostAndDeviceSupported)
Colin Cross36242852017-06-23 15:06:31 -07002017 return module
Colin Cross2fe66872015-03-30 17:20:39 -07002018}
2019
Colin Cross1b16b0e2019-02-12 14:41:32 -08002020// java_import imports one or more `.jar` files into the build graph as if they were built by a java_library_host
2021// module.
2022//
2023// A java_import_host has a single variant that expects a `.jar` file containing `.class` files that were
2024// compiled against a host bootclasspath.
Colin Cross74d73e22017-08-02 11:05:49 -07002025func ImportFactoryHost() android.Module {
2026 module := &Import{}
2027
2028 module.AddProperties(&module.properties)
2029
2030 android.InitPrebuiltModule(module, &module.properties.Jars)
Colin Cross48de9a42018-10-02 13:53:33 -07002031 InitJavaModule(module, android.HostSupported)
Colin Cross74d73e22017-08-02 11:05:49 -07002032 return module
2033}
2034
Colin Cross42be7612019-02-21 18:12:14 -08002035// dex_import module
2036
2037type DexImportProperties struct {
Colin Cross5cfc70d2019-07-15 13:36:55 -07002038 Jars []string `android:"path"`
Colin Cross42be7612019-02-21 18:12:14 -08002039}
2040
2041type DexImport struct {
2042 android.ModuleBase
2043 android.DefaultableModuleBase
2044 prebuilt android.Prebuilt
2045
2046 properties DexImportProperties
2047
2048 dexJarFile android.Path
2049 maybeStrippedDexJarFile android.Path
2050
2051 dexpreopter
2052}
2053
2054func (j *DexImport) Prebuilt() *android.Prebuilt {
2055 return &j.prebuilt
2056}
2057
2058func (j *DexImport) PrebuiltSrcs() []string {
2059 return j.properties.Jars
2060}
2061
2062func (j *DexImport) Name() string {
2063 return j.prebuilt.Name(j.ModuleBase.Name())
2064}
2065
Colin Cross42be7612019-02-21 18:12:14 -08002066func (j *DexImport) GenerateAndroidBuildActions(ctx android.ModuleContext) {
2067 if len(j.properties.Jars) != 1 {
2068 ctx.PropertyErrorf("jars", "exactly one jar must be provided")
2069 }
2070
2071 j.dexpreopter.installPath = android.PathForModuleInstall(ctx, "framework", ctx.ModuleName()+".jar")
2072 j.dexpreopter.isInstallable = true
2073 j.dexpreopter.uncompressedDex = shouldUncompressDex(ctx, &j.dexpreopter)
2074
2075 inputJar := ctx.ExpandSource(j.properties.Jars[0], "jars")
2076 dexOutputFile := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar")
2077
2078 if j.dexpreopter.uncompressedDex {
2079 rule := android.NewRuleBuilder()
2080
2081 temporary := android.PathForModuleOut(ctx, ctx.ModuleName()+".jar.unaligned")
2082 rule.Temporary(temporary)
2083
2084 // use zip2zip to uncompress classes*.dex files
2085 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002086 BuiltTool(ctx, "zip2zip").
Colin Cross42be7612019-02-21 18:12:14 -08002087 FlagWithInput("-i ", inputJar).
2088 FlagWithOutput("-o ", temporary).
2089 FlagWithArg("-0 ", "'classes*.dex'")
2090
2091 // use zipalign to align uncompressed classes*.dex files
2092 rule.Command().
Colin Crossee94d6a2019-07-08 17:08:34 -07002093 BuiltTool(ctx, "zipalign").
Colin Cross42be7612019-02-21 18:12:14 -08002094 Flag("-f").
2095 Text("4").
2096 Input(temporary).
2097 Output(dexOutputFile)
2098
2099 rule.DeleteTemporaryFiles()
2100
2101 rule.Build(pctx, ctx, "uncompress_dex", "uncompress dex")
2102 } else {
2103 ctx.Build(pctx, android.BuildParams{
2104 Rule: android.Cp,
2105 Input: inputJar,
2106 Output: dexOutputFile,
2107 })
2108 }
2109
2110 j.dexJarFile = dexOutputFile
2111
2112 dexOutputFile = j.dexpreopt(ctx, dexOutputFile)
2113
2114 j.maybeStrippedDexJarFile = dexOutputFile
2115
2116 ctx.InstallFile(android.PathForModuleInstall(ctx, "framework"),
2117 ctx.ModuleName()+".jar", dexOutputFile)
2118}
2119
2120func (j *DexImport) DexJar() android.Path {
2121 return j.dexJarFile
2122}
2123
2124// dex_import imports a `.jar` file containing classes.dex files.
2125//
2126// A dex_import module cannot be used as a dependency of a java_* or android_* module, it can only be installed
2127// to the device.
2128func DexImportFactory() android.Module {
2129 module := &DexImport{}
2130
2131 module.AddProperties(&module.properties)
2132
2133 android.InitPrebuiltModule(module, &module.properties.Jars)
2134 InitJavaModule(module, android.DeviceSupported)
2135 return module
2136}
2137
Colin Cross89536d42017-07-07 14:35:50 -07002138//
2139// Defaults
2140//
2141type Defaults struct {
2142 android.ModuleBase
2143 android.DefaultsModuleBase
2144}
2145
Colin Cross1b16b0e2019-02-12 14:41:32 -08002146// java_defaults provides a set of properties that can be inherited by other java or android modules.
2147//
2148// A module can use the properties from a java_defaults module using `defaults: ["defaults_module_name"]`. Each
2149// property in the defaults module that exists in the depending module will be prepended to the depending module's
2150// value for that property.
2151//
2152// Example:
2153//
2154// java_defaults {
2155// name: "example_defaults",
2156// srcs: ["common/**/*.java"],
2157// javacflags: ["-Xlint:all"],
2158// aaptflags: ["--auto-add-overlay"],
2159// }
2160//
2161// java_library {
2162// name: "example",
2163// defaults: ["example_defaults"],
2164// srcs: ["example/**/*.java"],
2165// }
2166//
2167// is functionally identical to:
2168//
2169// java_library {
2170// name: "example",
2171// srcs: [
2172// "common/**/*.java",
2173// "example/**/*.java",
2174// ],
2175// javacflags: ["-Xlint:all"],
2176// }
Colin Cross89536d42017-07-07 14:35:50 -07002177func defaultsFactory() android.Module {
2178 return DefaultsFactory()
2179}
2180
2181func DefaultsFactory(props ...interface{}) android.Module {
2182 module := &Defaults{}
2183
2184 module.AddProperties(props...)
2185 module.AddProperties(
2186 &CompilerProperties{},
2187 &CompilerDeviceProperties{},
Colin Cross43f08db2018-11-12 10:13:39 -08002188 &DexpreoptProperties{},
Dan Willemsen6424d172018-03-08 13:27:59 -08002189 &android.ProtoProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002190 &aaptProperties{},
2191 &androidLibraryProperties{},
2192 &appProperties{},
2193 &appTestProperties{},
Jaewoong Jung525443a2019-02-28 15:35:54 -08002194 &overridableAppProperties{},
Colin Cross48de9a42018-10-02 13:53:33 -07002195 &ImportProperties{},
2196 &AARImportProperties{},
2197 &sdkLibraryProperties{},
Colin Cross42be7612019-02-21 18:12:14 -08002198 &DexImportProperties{},
Colin Cross89536d42017-07-07 14:35:50 -07002199 )
2200
2201 android.InitDefaultsModule(module)
2202
2203 return module
2204}
Nan Zhangea568a42017-11-08 21:20:04 -08002205
2206var Bool = proptools.Bool
Colin Cross38b40df2018-04-10 16:14:46 -07002207var BoolDefault = proptools.BoolDefault
Nan Zhangea568a42017-11-08 21:20:04 -08002208var String = proptools.String
Colin Cross0d0ba592018-02-20 13:33:42 -08002209var inList = android.InList