blob: 4eba6187104c1ff9956569df03e6f98b7513e363 [file] [log] [blame]
Jaewoong Jung26342642021-03-17 15:56:23 -07001// Copyright 2021 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
17import (
18 "fmt"
19 "path/filepath"
20 "strconv"
21 "strings"
22
23 "github.com/google/blueprint/pathtools"
24 "github.com/google/blueprint/proptools"
25
26 "android/soong/android"
27 "android/soong/dexpreopt"
28 "android/soong/java/config"
29)
30
31// This file contains the definition and the implementation of the base module that most
32// source-based Java module structs embed.
33
34// TODO:
35// Autogenerated files:
36// Renderscript
37// Post-jar passes:
38// Proguard
39// Rmtypedefs
40// DroidDoc
41// Findbugs
42
43// Properties that are common to most Java modules, i.e. whether it's a host or device module.
44type CommonProperties struct {
45 // list of source files used to compile the Java module. May be .java, .kt, .logtags, .proto,
46 // or .aidl files.
47 Srcs []string `android:"path,arch_variant"`
48
49 // list Kotlin of source files containing Kotlin code that should be treated as common code in
50 // a codebase that supports Kotlin multiplatform. See
51 // https://kotlinlang.org/docs/reference/multiplatform.html. May be only be .kt files.
52 Common_srcs []string `android:"path,arch_variant"`
53
54 // list of source files that should not be used to build the Java module.
55 // This is most useful in the arch/multilib variants to remove non-common files
56 Exclude_srcs []string `android:"path,arch_variant"`
57
58 // list of directories containing Java resources
59 Java_resource_dirs []string `android:"arch_variant"`
60
61 // list of directories that should be excluded from java_resource_dirs
62 Exclude_java_resource_dirs []string `android:"arch_variant"`
63
64 // list of files to use as Java resources
65 Java_resources []string `android:"path,arch_variant"`
66
67 // list of files that should be excluded from java_resources and java_resource_dirs
68 Exclude_java_resources []string `android:"path,arch_variant"`
69
70 // list of module-specific flags that will be used for javac compiles
71 Javacflags []string `android:"arch_variant"`
72
73 // list of module-specific flags that will be used for kotlinc compiles
74 Kotlincflags []string `android:"arch_variant"`
75
76 // list of java libraries that will be in the classpath
77 Libs []string `android:"arch_variant"`
78
79 // list of java libraries that will be compiled into the resulting jar
80 Static_libs []string `android:"arch_variant"`
81
82 // manifest file to be included in resulting jar
83 Manifest *string `android:"path"`
84
85 // if not blank, run jarjar using the specified rules file
86 Jarjar_rules *string `android:"path,arch_variant"`
87
88 // If not blank, set the java version passed to javac as -source and -target
89 Java_version *string
90
91 // If set to true, allow this module to be dexed and installed on devices. Has no
92 // effect on host modules, which are always considered installable.
93 Installable *bool
94
95 // If set to true, include sources used to compile the module in to the final jar
96 Include_srcs *bool
97
98 // If not empty, classes are restricted to the specified packages and their sub-packages.
99 // This restriction is checked after applying jarjar rules and including static libs.
100 Permitted_packages []string
101
102 // List of modules to use as annotation processors
103 Plugins []string
104
105 // List of modules to export to libraries that directly depend on this library as annotation
106 // processors. Note that if the plugins set generates_api: true this will disable the turbine
107 // optimization on modules that depend on this module, which will reduce parallelism and cause
108 // more recompilation.
109 Exported_plugins []string
110
111 // The number of Java source entries each Javac instance can process
112 Javac_shard_size *int64
113
114 // Add host jdk tools.jar to bootclasspath
115 Use_tools_jar *bool
116
117 Openjdk9 struct {
118 // List of source files that should only be used when passing -source 1.9 or higher
119 Srcs []string `android:"path"`
120
121 // List of javac flags that should only be used when passing -source 1.9 or higher
122 Javacflags []string
123 }
124
125 // When compiling language level 9+ .java code in packages that are part of
126 // a system module, patch_module names the module that your sources and
127 // dependencies should be patched into. The Android runtime currently
128 // doesn't implement the JEP 261 module system so this option is only
129 // supported at compile time. It should only be needed to compile tests in
130 // packages that exist in libcore and which are inconvenient to move
131 // elsewhere.
132 Patch_module *string `android:"arch_variant"`
133
134 Jacoco struct {
135 // List of classes to include for instrumentation with jacoco to collect coverage
136 // information at runtime when building with coverage enabled. If unset defaults to all
137 // classes.
138 // Supports '*' as the last character of an entry in the list as a wildcard match.
139 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
140 // it matches classes in the package that have the class name as a prefix.
141 Include_filter []string
142
143 // List of classes to exclude from instrumentation with jacoco to collect coverage
144 // information at runtime when building with coverage enabled. Overrides classes selected
145 // by the include_filter property.
146 // Supports '*' as the last character of an entry in the list as a wildcard match.
147 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
148 // it matches classes in the package that have the class name as a prefix.
149 Exclude_filter []string
150 }
151
152 Errorprone struct {
153 // List of javac flags that should only be used when running errorprone.
154 Javacflags []string
155
156 // List of java_plugin modules that provide extra errorprone checks.
157 Extra_check_modules []string
Cole Faust75fffb12021-06-13 15:23:16 -0700158
Cole Faust2b1536e2021-06-18 12:25:54 -0700159 // This property can be in 3 states. When set to true, errorprone will
160 // be run during the regular build. When set to false, errorprone will
161 // never be run. When unset, errorprone will be run when the RUN_ERROR_PRONE
162 // environment variable is true. Setting this to false will improve build
163 // performance more than adding -XepDisableAllChecks in javacflags.
Cole Faust75fffb12021-06-13 15:23:16 -0700164 Enabled *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700165 }
166
167 Proto struct {
168 // List of extra options that will be passed to the proto generator.
169 Output_params []string
170 }
171
172 Instrument bool `blueprint:"mutated"`
173
174 // List of files to include in the META-INF/services folder of the resulting jar.
175 Services []string `android:"path,arch_variant"`
176
177 // If true, package the kotlin stdlib into the jar. Defaults to true.
178 Static_kotlin_stdlib *bool `android:"arch_variant"`
179
180 // A list of java_library instances that provide additional hiddenapi annotations for the library.
181 Hiddenapi_additional_annotations []string
182}
183
184// Properties that are specific to device modules. Host module factories should not add these when
185// constructing a new module.
186type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000187 // If not blank, set to the version of the sdk to compile against.
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000188 // Defaults to private.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000189 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000190 // 1) numerical API level, "current", "none", or "core_platform"
191 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
192 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
193 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700194 Sdk_version *string
195
196 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000197 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700198 Min_sdk_version *string
199
satayev0a420e72021-11-29 17:25:52 +0000200 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
201 // Defaults to empty string "". See sdk_version for possible values.
202 Max_sdk_version *string
203
Jaewoong Jung26342642021-03-17 15:56:23 -0700204 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000205 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700206 Target_sdk_version *string
207
208 // Whether to compile against the platform APIs instead of an SDK.
209 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000210 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700211 Platform_apis *bool
212
213 Aidl struct {
214 // Top level directories to pass to aidl tool
215 Include_dirs []string
216
217 // Directories rooted at the Android.bp file to pass to aidl tool
218 Local_include_dirs []string
219
220 // directories that should be added as include directories for any aidl sources of modules
221 // that depend on this module, as well as to aidl for this module.
222 Export_include_dirs []string
223
224 // whether to generate traces (for systrace) for this interface
225 Generate_traces *bool
226
227 // whether to generate Binder#GetTransaction name method.
228 Generate_get_transaction_name *bool
229
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100230 // whether all interfaces should be annotated with required permissions.
231 Enforce_permissions *bool
232
233 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
234 Enforce_permissions_exceptions []string `android:"path"`
235
Jaewoong Jung26342642021-03-17 15:56:23 -0700236 // list of flags that will be passed to the AIDL compiler
237 Flags []string
238 }
239
240 // If true, export a copy of the module as a -hostdex module for host testing.
241 Hostdex *bool
242
243 Target struct {
244 Hostdex struct {
245 // Additional required dependencies to add to -hostdex modules.
246 Required []string
247 }
248 }
249
250 // When targeting 1.9 and above, override the modules to use with --system,
251 // otherwise provides defaults libraries to add to the bootclasspath.
252 System_modules *string
253
Jaewoong Jung26342642021-03-17 15:56:23 -0700254 IsSDKLibrary bool `blueprint:"mutated"`
255
256 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
257 // Defaults to false.
258 V4_signature *bool
259
260 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
261 // public stubs library.
262 SyspropPublicStub string `blueprint:"mutated"`
263}
264
Jooyung Han01d80d82022-01-08 12:16:32 +0900265// Device properties that can be overridden by overriding module (e.g. override_android_app)
266type OverridableDeviceProperties struct {
267 // set the name of the output. If not set, `name` is used.
268 // To override a module with this property set, overriding module might need to set this as well.
269 // Otherwise, both the overridden and the overriding modules will have the same output name, which
270 // can cause the duplicate output error.
271 Stem *string
272}
273
Jaewoong Jung26342642021-03-17 15:56:23 -0700274// Functionality common to Module and Import
275//
276// It is embedded in Module so its functionality can be used by methods in Module
277// but it is currently only initialized by Import and Library.
278type embeddableInModuleAndImport struct {
279
280 // Functionality related to this being used as a component of a java_sdk_library.
281 EmbeddableSdkLibraryComponent
282}
283
Paul Duffin71b33cc2021-06-23 11:39:47 +0100284func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
285 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700286}
287
288// Module/Import's DepIsInSameApex(...) delegates to this method.
289//
290// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
291// the one provided by ApexModuleBase.
292func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
293 // dependencies other than the static linkage are all considered crossing APEX boundary
294 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
295 return true
296 }
297 return false
298}
299
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100300// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
301// or an invalid path describing the reason it is invalid.
302//
303// It is unset if a dex jar isn't applicable, i.e. no build rule has been
304// requested to create one.
305//
306// If a dex jar has been requested to be built then it is set, and it may be
307// either a valid android.Path, or invalid with a reason message. The latter
308// happens if the source that should produce the dex file isn't able to.
309//
310// E.g. it is invalid with a reason message if there is a prebuilt APEX that
311// could produce the dex jar through a deapexer module, but the APEX isn't
312// installable so doing so wouldn't be safe.
313type OptionalDexJarPath struct {
314 isSet bool
315 path android.OptionalPath
316}
317
318// IsSet returns true if a path has been set, either invalid or valid.
319func (o OptionalDexJarPath) IsSet() bool {
320 return o.isSet
321}
322
323// Valid returns true if there is a path that is valid.
324func (o OptionalDexJarPath) Valid() bool {
325 return o.isSet && o.path.Valid()
326}
327
328// Path returns the valid path, or panics if it's either not set or is invalid.
329func (o OptionalDexJarPath) Path() android.Path {
330 if !o.isSet {
331 panic("path isn't set")
332 }
333 return o.path.Path()
334}
335
336// PathOrNil returns the path if it's set and valid, or else nil.
337func (o OptionalDexJarPath) PathOrNil() android.Path {
338 if o.Valid() {
339 return o.Path()
340 }
341 return nil
342}
343
344// InvalidReason returns the reason for an invalid path, which is never "". It
345// returns "" for an unset or valid path.
346func (o OptionalDexJarPath) InvalidReason() string {
347 if !o.isSet {
348 return ""
349 }
350 return o.path.InvalidReason()
351}
352
353func (o OptionalDexJarPath) String() string {
354 if !o.isSet {
355 return "<unset>"
356 }
357 return o.path.String()
358}
359
360// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
361func makeUnsetDexJarPath() OptionalDexJarPath {
362 return OptionalDexJarPath{isSet: false}
363}
364
365// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
366// the given OptionalPath, which may be valid or invalid.
367func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
368 return OptionalDexJarPath{isSet: true, path: path}
369}
370
371// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
372// valid given path. It returns an unset OptionalDexJarPath if the given path is
373// nil.
374func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
375 if path == nil {
376 return makeUnsetDexJarPath()
377 }
378 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
379}
380
Jaewoong Jung26342642021-03-17 15:56:23 -0700381// Module contains the properties and members used by all java module types
382type Module struct {
383 android.ModuleBase
384 android.DefaultableModuleBase
385 android.ApexModuleBase
386 android.SdkBase
Wei Libafb6d62021-12-10 03:14:59 -0800387 android.BazelModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700388
389 // Functionality common to Module and Import.
390 embeddableInModuleAndImport
391
392 properties CommonProperties
393 protoProperties android.ProtoProperties
394 deviceProperties DeviceProperties
395
Jooyung Han01d80d82022-01-08 12:16:32 +0900396 overridableDeviceProperties OverridableDeviceProperties
397
Jaewoong Jung26342642021-03-17 15:56:23 -0700398 // jar file containing header classes including static library dependencies, suitable for
399 // inserting into the bootclasspath/classpath of another compile
400 headerJarFile android.Path
401
402 // jar file containing implementation classes including static library dependencies but no
403 // resources
404 implementationJarFile android.Path
405
406 // jar file containing only resources including from static library dependencies
407 resourceJar android.Path
408
409 // args and dependencies to package source files into a srcjar
410 srcJarArgs []string
411 srcJarDeps android.Paths
412
413 // jar file containing implementation classes and resources including static library
414 // dependencies
415 implementationAndResourcesJar android.Path
416
417 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100418 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700419
420 // output file containing uninstrumented classes that will be instrumented by jacoco
421 jacocoReportClassesFile android.Path
422
423 // output file of the module, which may be a classes jar or a dex jar
424 outputFile android.Path
425 extraOutputFiles android.Paths
426
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100427 exportAidlIncludeDirs android.Paths
428 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700429
430 logtagsSrcs android.Paths
431
432 // installed file for binary dependency
433 installFile android.Path
434
Colin Cross3108ce12021-11-10 14:38:50 -0800435 // installed file for hostdex copy
436 hostdexInstallFile android.InstallPath
437
Jaewoong Jung26342642021-03-17 15:56:23 -0700438 // list of .java files and srcjars that was passed to javac
439 compiledJavaSrcs android.Paths
440 compiledSrcJars android.Paths
441
442 // manifest file to use instead of properties.Manifest
443 overrideManifest android.OptionalPath
444
Jaewoong Jung26342642021-03-17 15:56:23 -0700445 // list of plugins that this java module is exporting
446 exportedPluginJars android.Paths
447
448 // list of plugins that this java module is exporting
449 exportedPluginClasses []string
450
451 // if true, the exported plugins generate API and require disabling turbine.
452 exportedDisableTurbine bool
453
454 // list of source files, collected from srcFiles with unique java and all kt files,
455 // will be used by android.IDEInfo struct
456 expandIDEInfoCompiledSrcs []string
457
458 // expanded Jarjar_rules
459 expandJarjarRules android.Path
460
Jaewoong Jung26342642021-03-17 15:56:23 -0700461 // Extra files generated by the module type to be added as java resources.
462 extraResources android.Paths
463
464 hiddenAPI
465 dexer
466 dexpreopter
467 usesLibrary
468 linter
469
470 // list of the xref extraction files
471 kytheFiles android.Paths
472
473 // Collect the module directory for IDE info in java/jdeps.go.
474 modulePaths []string
475
476 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900477
478 sdkVersion android.SdkSpec
479 minSdkVersion android.SdkSpec
satayev0a420e72021-11-29 17:25:52 +0000480 maxSdkVersion android.SdkSpec
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400481
482 sourceExtensions []string
Jaewoong Jung26342642021-03-17 15:56:23 -0700483}
484
Jiyong Park92315372021-04-02 08:45:46 +0900485func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
486 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900487 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700488 return nil
489 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900490 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000491 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700492 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
493 } else {
494 // Treat stable core platform as stable.
495 return nil
496 }
497 } else {
498 return fmt.Errorf("non stable SDK %v", sdkVersion)
499 }
500}
501
502// checkSdkVersions enforces restrictions around SDK dependencies.
503func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
504 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900505 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900506 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700507 ctx.PropertyErrorf("sdk_version",
508 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
509 }
510 }
511 }
512
513 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
514 // See rank() for details.
515 ctx.VisitDirectDeps(func(module android.Module) {
516 tag := ctx.OtherModuleDependencyTag(module)
517 switch module.(type) {
518 // TODO(satayev): cover other types as well, e.g. imports
519 case *Library, *AndroidLibrary:
520 switch tag {
521 case bootClasspathTag, libTag, staticLibTag, java9LibTag:
522 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
523 }
524 }
525 })
526}
527
528func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900529 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700530 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900531 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700532 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000533 ctx.PropertyErrorf("platform_apis", "This module has conflicting settings. sdk_version is not empty, which means this module cannot use platform APIs. However platform_apis is set to true.")
Jaewoong Jung26342642021-03-17 15:56:23 -0700534 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000535 ctx.PropertyErrorf("platform_apis", "This module has conflicting settings. sdk_version is empty, which means that this module is build against platform APIs. However platform_apis is not set to true")
Jaewoong Jung26342642021-03-17 15:56:23 -0700536 }
537
538 }
539}
540
541func (j *Module) addHostProperties() {
542 j.AddProperties(
543 &j.properties,
544 &j.protoProperties,
545 &j.usesLibraryProperties,
546 )
547}
548
549func (j *Module) addHostAndDeviceProperties() {
550 j.addHostProperties()
551 j.AddProperties(
552 &j.deviceProperties,
Jooyung Han01d80d82022-01-08 12:16:32 +0900553 &j.overridableDeviceProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700554 &j.dexer.dexProperties,
555 &j.dexpreoptProperties,
556 &j.linter.properties,
557 )
558}
559
560func (j *Module) OutputFiles(tag string) (android.Paths, error) {
561 switch tag {
562 case "":
563 return append(android.Paths{j.outputFile}, j.extraOutputFiles...), nil
564 case android.DefaultDistTag:
565 return android.Paths{j.outputFile}, nil
566 case ".jar":
567 return android.Paths{j.implementationAndResourcesJar}, nil
568 case ".proguard_map":
569 if j.dexer.proguardDictionary.Valid() {
570 return android.Paths{j.dexer.proguardDictionary.Path()}, nil
571 }
572 return nil, fmt.Errorf("%q was requested, but no output file was found.", tag)
573 default:
574 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
575 }
576}
577
578var _ android.OutputFileProducer = (*Module)(nil)
579
580func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
581 initJavaModule(module, hod, false)
582}
583
584func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
585 initJavaModule(module, hod, true)
586}
587
588func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
589 multilib := android.MultilibCommon
590 if multiTargets {
591 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
592 } else {
593 android.InitAndroidArchModule(module, hod, multilib)
594 }
595 android.InitDefaultableModule(module)
596}
597
598func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
599 return j.properties.Instrument &&
600 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
601 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
602}
603
604func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
605 return j.shouldInstrument(ctx) &&
606 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
607 ctx.Config().UnbundledBuild())
608}
609
610func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
611 // Force enable the instrumentation for java code that is built for APEXes ...
612 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
613 // doesn't make sense) or framework libraries (e.g. libraries found in the InstrumentFrameworkModules list) unless EMMA_INSTRUMENT_FRAMEWORK is true.
614 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
615 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
616 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
617 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
618 return true
619 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
620 return true
621 }
622 }
623 return false
624}
625
Jiyong Park92315372021-04-02 08:45:46 +0900626func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
627 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700628}
629
Jiyong Parkf1691d22021-03-29 20:11:58 +0900630func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700631 return proptools.String(j.deviceProperties.System_modules)
632}
633
Jiyong Park92315372021-04-02 08:45:46 +0900634func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
Jaewoong Jung26342642021-03-17 15:56:23 -0700635 if j.deviceProperties.Min_sdk_version != nil {
Jiyong Park92315372021-04-02 08:45:46 +0900636 return android.SdkSpecFrom(ctx, *j.deviceProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700637 }
Jiyong Park92315372021-04-02 08:45:46 +0900638 return j.SdkVersion(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -0700639}
640
satayev0a420e72021-11-29 17:25:52 +0000641func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
642 maxSdkVersion := proptools.StringDefault(j.deviceProperties.Max_sdk_version, "")
643 // SdkSpecFrom returns SdkSpecPrivate for this, which may be confusing.
644 // TODO(b/208456999): ideally MaxSdkVersion should be an ApiLevel and not SdkSpec.
645 return android.SdkSpecFrom(ctx, maxSdkVersion)
646}
647
Jiyong Parkf1691d22021-03-29 20:11:58 +0900648func (j *Module) MinSdkVersionString() string {
Jiyong Park92315372021-04-02 08:45:46 +0900649 return j.minSdkVersion.Raw
650}
651
652func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
653 if j.deviceProperties.Target_sdk_version != nil {
654 return android.SdkSpecFrom(ctx, *j.deviceProperties.Target_sdk_version)
655 }
656 return j.SdkVersion(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -0700657}
658
659func (j *Module) AvailableFor(what string) bool {
660 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
661 // Exception: for hostdex: true libraries, the platform variant is created
662 // even if it's not marked as available to platform. In that case, the platform
663 // variant is used only for the hostdex and not installed to the device.
664 return true
665 }
666 return j.ApexModuleBase.AvailableFor(what)
667}
668
669func (j *Module) deps(ctx android.BottomUpMutatorContext) {
670 if ctx.Device() {
671 j.linter.deps(ctx)
672
Jiyong Parkf1691d22021-03-29 20:11:58 +0900673 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700674
675 if j.deviceProperties.SyspropPublicStub != "" {
676 // This is a sysprop implementation library that has a corresponding sysprop public
677 // stubs library, and a dependency on it so that dependencies on the implementation can
678 // be forwarded to the public stubs library when necessary.
679 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
680 }
681 }
682
683 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
684 ctx.AddVariationDependencies(nil, staticLibTag, j.properties.Static_libs...)
685
686 // Add dependency on libraries that provide additional hidden api annotations.
687 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
688
689 if ctx.DeviceConfig().VndkVersion() != "" && ctx.Config().EnforceInterPartitionJavaSdkLibrary() {
690 // Require java_sdk_library at inter-partition java dependency to ensure stable
691 // interface between partitions. If inter-partition java_library dependency is detected,
692 // raise build error because java_library doesn't have a stable interface.
693 //
694 // Inputs:
695 // PRODUCT_ENFORCE_INTER_PARTITION_JAVA_SDK_LIBRARY
696 // if true, enable enforcement
697 // PRODUCT_INTER_PARTITION_JAVA_LIBRARY_ALLOWLIST
698 // exception list of java_library names to allow inter-partition dependency
699 for idx := range j.properties.Libs {
700 if libDeps[idx] == nil {
701 continue
702 }
703
704 if javaDep, ok := libDeps[idx].(javaSdkLibraryEnforceContext); ok {
705 // java_sdk_library is always allowed at inter-partition dependency.
706 // So, skip check.
707 if _, ok := javaDep.(*SdkLibrary); ok {
708 continue
709 }
710
711 j.checkPartitionsForJavaDependency(ctx, "libs", javaDep)
712 }
713 }
714 }
715
716 // For library dependencies that are component libraries (like stubs), add the implementation
717 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
718 for _, dep := range libDeps {
719 if dep != nil {
720 if component, ok := dep.(SdkLibraryComponentDependency); ok {
721 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100722 // Add library as optional if it's one of the optional compatibility libs.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100723 tag := usesLibReqTag
724 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) {
725 tag = usesLibOptTag
726 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100727 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700728 }
729 }
730 }
731 }
732
733 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
734 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
735 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
736
737 android.ProtoDeps(ctx, &j.protoProperties)
738 if j.hasSrcExt(".proto") {
739 protoDeps(ctx, &j.protoProperties)
740 }
741
742 if j.hasSrcExt(".kt") {
743 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
744 // Kotlin files
745 ctx.AddVariationDependencies(nil, kotlinStdlibTag,
746 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8")
747 if len(j.properties.Plugins) > 0 {
748 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
749 }
750 }
751
752 // Framework libraries need special handling in static coverage builds: they should not have
753 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
754 // the same jacoco classes coming from different bootclasspath jars.
755 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
756 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
757 j.properties.Instrument = true
758 }
759 } else if j.shouldInstrumentStatic(ctx) {
760 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
761 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700762
763 if j.useCompose() {
764 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
765 "androidx.compose.compiler_compiler-hosted")
766 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700767}
768
769func hasSrcExt(srcs []string, ext string) bool {
770 for _, src := range srcs {
771 if filepath.Ext(src) == ext {
772 return true
773 }
774 }
775
776 return false
777}
778
779func (j *Module) hasSrcExt(ext string) bool {
780 return hasSrcExt(j.properties.Srcs, ext)
781}
782
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100783func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
784 var flags string
785
786 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
787 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
788 flags = "-Wmissing-permission-annotation -Werror"
789 }
790 }
791 return flags
792}
793
Jaewoong Jung26342642021-03-17 15:56:23 -0700794func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
795 aidlIncludeDirs android.Paths) (string, android.Paths) {
796
797 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
798 aidlIncludes = append(aidlIncludes,
799 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
800 aidlIncludes = append(aidlIncludes,
801 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
802
803 var flags []string
804 var deps android.Paths
805
806 flags = append(flags, j.deviceProperties.Aidl.Flags...)
807
808 if aidlPreprocess.Valid() {
809 flags = append(flags, "-p"+aidlPreprocess.String())
810 deps = append(deps, aidlPreprocess.Path())
811 } else if len(aidlIncludeDirs) > 0 {
812 flags = append(flags, android.JoinWithPrefix(aidlIncludeDirs.Strings(), "-I"))
813 }
814
815 if len(j.exportAidlIncludeDirs) > 0 {
816 flags = append(flags, android.JoinWithPrefix(j.exportAidlIncludeDirs.Strings(), "-I"))
817 }
818
819 if len(aidlIncludes) > 0 {
820 flags = append(flags, android.JoinWithPrefix(aidlIncludes.Strings(), "-I"))
821 }
822
823 flags = append(flags, "-I"+android.PathForModuleSrc(ctx).String())
824 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
825 flags = append(flags, "-I"+src.String())
826 }
827
828 if Bool(j.deviceProperties.Aidl.Generate_traces) {
829 flags = append(flags, "-t")
830 }
831
832 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
833 flags = append(flags, "--transaction_names")
834 }
835
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100836 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
837 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
838 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
839 }
840
Jooyung Han07f70c02021-11-06 07:08:45 +0900841 aidlMinSdkVersion := j.MinSdkVersion(ctx).ApiLevel.String()
842 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
843
Jaewoong Jung26342642021-03-17 15:56:23 -0700844 return strings.Join(flags, " "), deps
845}
846
847func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
848
849 var flags javaBuilderFlags
850
851 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +0900852 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -0700853
Cole Faust2b1536e2021-06-18 12:25:54 -0700854 epEnabled := j.properties.Errorprone.Enabled
855 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700856 if config.ErrorProneClasspath == nil && ctx.Config().TestProductVariables == nil {
857 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
858 }
859
860 errorProneFlags := []string{
861 "-Xplugin:ErrorProne",
862 "${config.ErrorProneChecks}",
863 }
864 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
865
Colin Cross8bf6cad2022-02-28 13:07:03 -0800866 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -0700867 "'" + strings.Join(errorProneFlags, " ") + "'"
868 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
869 }
870
871 // classpath
872 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
873 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -0700874 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700875 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
876 flags.processorPath = append(flags.processorPath, deps.processorPath...)
877 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
878
879 flags.processors = append(flags.processors, deps.processorClasses...)
880 flags.processors = android.FirstUniqueStrings(flags.processors)
881
882 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +0900883 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700884 // Give host-side tools a version of OpenJDK's standard libraries
885 // close to what they're targeting. As of Dec 2017, AOSP is only
886 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
887 //
888 // When building with OpenJDK 8, the following should have no
889 // effect since those jars would be available by default.
890 //
891 // When building with OpenJDK 9 but targeting a version < 1.8,
892 // putting them on the bootclasspath means that:
893 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
894 // b) references to existing APIs are not reinterpreted in an
895 // OpenJDK 9-specific way, eg. calls to subclasses of
896 // java.nio.Buffer as in http://b/70862583
897 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
898 flags.bootClasspath = append(flags.bootClasspath,
899 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
900 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
901 if Bool(j.properties.Use_tools_jar) {
902 flags.bootClasspath = append(flags.bootClasspath,
903 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
904 }
905 }
906
907 // systemModules
908 flags.systemModules = deps.systemModules
909
910 // aidl flags.
911 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs)
912
913 return flags
914}
915
916func (j *Module) collectJavacFlags(
917 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
918 // javac flags.
919 javacFlags := j.properties.Javacflags
920
921 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() {
922 // For non-host binaries, override the -g flag passed globally to remove
923 // local variable debug info to reduce disk and memory usage.
924 javacFlags = append(javacFlags, "-g:source,lines")
925 }
926 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
927
928 if flags.javaVersion.usesJavaModules() {
929 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
930
931 if j.properties.Patch_module != nil {
932 // Manually specify build directory in case it is not under the repo root.
933 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
934 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +0200935 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -0700936
937 // b/150878007
938 //
939 // Workaround to support *Bazel-executed* JDK9 javac in Bazel's
940 // execution root for --patch-module. If this javac command line is
941 // invoked within Bazel's execution root working directory, the top
942 // level directories (e.g. libcore/, tools/, frameworks/) are all
943 // symlinks. JDK9 javac does not traverse into symlinks, which causes
944 // --patch-module to fail source file lookups when invoked in the
945 // execution root.
946 //
947 // Short of patching javac or enumerating *all* directories as possible
948 // input dirs, manually add the top level dir of the source files to be
949 // compiled.
950 topLevelDirs := map[string]bool{}
951 for _, srcFilePath := range srcFiles {
952 srcFileParts := strings.Split(srcFilePath.String(), "/")
953 // Ignore source files that are already in the top level directory
954 // as well as generated files in the out directory. The out
955 // directory may be an absolute path, which means srcFileParts[0] is the
956 // empty string, so check that as well. Note that "out" in Bazel's execution
957 // root is *not* a symlink, which doesn't cause problems for --patch-modules
958 // anyway, so it's fine to not apply this workaround for generated
959 // source files.
960 if len(srcFileParts) > 1 &&
961 srcFileParts[0] != "" &&
962 srcFileParts[0] != "out" {
963 topLevelDirs[srcFileParts[0]] = true
964 }
965 }
966 patchPaths = append(patchPaths, android.SortedStringKeys(topLevelDirs)...)
967
968 classPath := flags.classpath.FormJavaClassPath("")
969 if classPath != "" {
970 patchPaths = append(patchPaths, classPath)
971 }
972 javacFlags = append(
973 javacFlags,
974 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
975 }
976 }
977
978 if len(javacFlags) > 0 {
979 // optimization.
980 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
981 flags.javacFlags = "$javacFlags"
982 }
983
984 return flags
985}
986
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400987func (j *Module) AddJSONData(d *map[string]interface{}) {
988 (&j.ModuleBase).AddJSONData(d)
989 (*d)["Java"] = map[string]interface{}{
990 "SourceExtensions": j.sourceExtensions,
991 }
992
993}
994
Jaewoong Jung26342642021-03-17 15:56:23 -0700995func (j *Module) compile(ctx android.ModuleContext, aaptSrcJar android.Path) {
996 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
997
998 deps := j.collectDeps(ctx)
999 flags := j.collectBuilderFlags(ctx, deps)
1000
1001 if flags.javaVersion.usesJavaModules() {
1002 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
1003 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001004
Jaewoong Jung26342642021-03-17 15:56:23 -07001005 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001006 j.sourceExtensions = []string{}
1007 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1008 if hasSrcExt(srcFiles.Strings(), ext) {
1009 j.sourceExtensions = append(j.sourceExtensions, ext)
1010 }
1011 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001012 if hasSrcExt(srcFiles.Strings(), ".proto") {
1013 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1014 }
1015
1016 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1017 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1018 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1019 }
1020
1021 srcFiles = j.genSources(ctx, srcFiles, flags)
1022
1023 // Collect javac flags only after computing the full set of srcFiles to
1024 // ensure that the --patch-module lookup paths are complete.
1025 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1026
1027 srcJars := srcFiles.FilterByExt(".srcjar")
1028 srcJars = append(srcJars, deps.srcJars...)
1029 if aaptSrcJar != nil {
1030 srcJars = append(srcJars, aaptSrcJar)
1031 }
Colin Crossb0ef30a2021-06-29 10:42:00 -07001032 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001033
1034 if j.properties.Jarjar_rules != nil {
1035 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1036 }
1037
1038 jarName := ctx.ModuleName() + ".jar"
1039
1040 javaSrcFiles := srcFiles.FilterByExt(".java")
1041 var uniqueSrcFiles android.Paths
1042 set := make(map[string]bool)
1043 for _, v := range javaSrcFiles {
1044 if _, found := set[v.String()]; !found {
1045 set[v.String()] = true
1046 uniqueSrcFiles = append(uniqueSrcFiles, v)
1047 }
1048 }
1049
Colin Crossb5db4012022-03-28 17:12:39 -07001050 // We don't currently run annotation processors in turbine, which means we can't use turbine
1051 // generated header jars when an annotation processor that generates API is enabled. One
1052 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1053 // is used to run all of the annotation processors.
1054 disableTurbine := deps.disableTurbine
1055
Jaewoong Jung26342642021-03-17 15:56:23 -07001056 // Collect .java files for AIDEGen
1057 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1058
1059 var kotlinJars android.Paths
Colin Cross220a9a12022-03-28 17:08:01 -07001060 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001061
1062 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001063 // When using kotlin sources turbine is used to generate annotation processor sources,
1064 // including for annotation processors that generate API, so we can use turbine for
1065 // java sources too.
1066 disableTurbine = false
1067
Jaewoong Jung26342642021-03-17 15:56:23 -07001068 // user defined kotlin flags.
1069 kotlincFlags := j.properties.Kotlincflags
1070 CheckKotlincFlags(ctx, kotlincFlags)
1071
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001072 // Workaround for KT-46512
1073 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001074
1075 // If there are kotlin files, compile them first but pass all the kotlin and java files
1076 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1077 // won't emit any classes for them.
1078 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1079 if ctx.Device() {
1080 kotlincFlags = append(kotlincFlags, "-no-jdk")
1081 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001082
1083 for _, plugin := range deps.kotlinPlugins {
1084 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1085 }
1086 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1087
Jaewoong Jung26342642021-03-17 15:56:23 -07001088 if len(kotlincFlags) > 0 {
1089 // optimization.
1090 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1091 flags.kotlincFlags += "$kotlincFlags"
1092 }
1093
1094 var kotlinSrcFiles android.Paths
1095 kotlinSrcFiles = append(kotlinSrcFiles, uniqueSrcFiles...)
1096 kotlinSrcFiles = append(kotlinSrcFiles, srcFiles.FilterByExt(".kt")...)
1097
1098 // Collect .kt files for AIDEGen
1099 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, srcFiles.FilterByExt(".kt").Strings()...)
1100 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1101
1102 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1103 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1104
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001105 flags.dexClasspath = append(flags.dexClasspath, deps.kotlinAnnotations...)
1106
Jaewoong Jung26342642021-03-17 15:56:23 -07001107 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1108 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1109
Isaac Chioua23d9942022-04-06 06:14:38 +00001110 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001111 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001112 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1113 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
1114 kotlinKapt(ctx, kaptSrcJar, kaptResJar, kotlinSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
1115 srcJars = append(srcJars, kaptSrcJar)
1116 kotlinJars = append(kotlinJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001117 // Disable annotation processing in javac, it's already been handled by kapt
1118 flags.processorPath = nil
1119 flags.processors = nil
1120 }
1121
1122 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001123 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
1124 kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, kotlinSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001125 if ctx.Failed() {
1126 return
1127 }
1128
Isaac Chioua23d9942022-04-06 06:14:38 +00001129 // Make javac rule depend on the kotlinc rule
1130 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1131
Jaewoong Jung26342642021-03-17 15:56:23 -07001132 kotlinJars = append(kotlinJars, kotlinJar)
Colin Cross220a9a12022-03-28 17:08:01 -07001133 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
1134
Jaewoong Jung26342642021-03-17 15:56:23 -07001135 // Jar kotlin classes into the final jar after javac
1136 if BoolDefault(j.properties.Static_kotlin_stdlib, true) {
1137 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
Colin Cross220a9a12022-03-28 17:08:01 -07001138 kotlinHeaderJars = append(kotlinHeaderJars, deps.kotlinStdlib...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001139 } else {
1140 flags.dexClasspath = append(flags.dexClasspath, deps.kotlinStdlib...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001141 }
1142 }
1143
1144 jars := append(android.Paths(nil), kotlinJars...)
1145
1146 // Store the list of .java files that was passed to javac
1147 j.compiledJavaSrcs = uniqueSrcFiles
1148 j.compiledSrcJars = srcJars
1149
1150 enableSharding := false
Colin Cross3d56ed52021-11-18 22:23:12 -08001151 var headerJarFileWithoutDepsOrJarjar android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001152 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001153 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1154 enableSharding = true
1155 // Formerly, there was a check here that prevented annotation processors
1156 // from being used when sharding was enabled, as some annotation processors
1157 // do not function correctly in sharded environments. It was removed to
1158 // allow for the use of annotation processors that do function correctly
1159 // with sharding enabled. See: b/77284273.
1160 }
Colin Cross3d56ed52021-11-18 22:23:12 -08001161 headerJarFileWithoutDepsOrJarjar, j.headerJarFile =
Colin Cross220a9a12022-03-28 17:08:01 -07001162 j.compileJavaHeader(ctx, uniqueSrcFiles, srcJars, deps, flags, jarName, kotlinHeaderJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001163 if ctx.Failed() {
1164 return
1165 }
1166 }
1167 if len(uniqueSrcFiles) > 0 || len(srcJars) > 0 {
1168 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001169 if Bool(j.properties.Errorprone.Enabled) {
1170 // If error-prone is enabled, enable errorprone flags on the regular
1171 // build.
1172 flags = enableErrorproneFlags(flags)
Cole Faust2b1536e2021-06-18 12:25:54 -07001173 } else if ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001174 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1175 // a new jar file just for compiling with the errorprone compiler to.
1176 // This is because we don't want to cause the java files to get completely
1177 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1178 // We also don't want to run this if errorprone is enabled by default for
1179 // this module, or else we could have duplicated errorprone messages.
1180 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001181 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Cole Faust75fffb12021-06-13 15:23:16 -07001182
1183 transformJavaToClasses(ctx, errorprone, -1, uniqueSrcFiles, srcJars, errorproneFlags, nil,
1184 "errorprone", "errorprone")
1185
Jaewoong Jung26342642021-03-17 15:56:23 -07001186 extraJarDeps = append(extraJarDeps, errorprone)
1187 }
1188
1189 if enableSharding {
Colin Cross3d56ed52021-11-18 22:23:12 -08001190 if headerJarFileWithoutDepsOrJarjar != nil {
1191 flags.classpath = append(classpath{headerJarFileWithoutDepsOrJarjar}, flags.classpath...)
1192 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001193 shardSize := int(*(j.properties.Javac_shard_size))
1194 var shardSrcs []android.Paths
1195 if len(uniqueSrcFiles) > 0 {
1196 shardSrcs = android.ShardPaths(uniqueSrcFiles, shardSize)
1197 for idx, shardSrc := range shardSrcs {
1198 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1199 nil, flags, extraJarDeps)
1200 jars = append(jars, classes)
1201 }
1202 }
1203 if len(srcJars) > 0 {
1204 classes := j.compileJavaClasses(ctx, jarName, len(shardSrcs),
1205 nil, srcJars, flags, extraJarDeps)
1206 jars = append(jars, classes)
1207 }
1208 } else {
1209 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueSrcFiles, srcJars, flags, extraJarDeps)
1210 jars = append(jars, classes)
1211 }
1212 if ctx.Failed() {
1213 return
1214 }
1215 }
1216
1217 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1218
1219 var includeSrcJar android.WritablePath
1220 if Bool(j.properties.Include_srcs) {
1221 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1222 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1223 }
1224
1225 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1226 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1227 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1228 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1229
1230 var resArgs []string
1231 var resDeps android.Paths
1232
1233 resArgs = append(resArgs, dirArgs...)
1234 resDeps = append(resDeps, dirDeps...)
1235
1236 resArgs = append(resArgs, fileArgs...)
1237 resDeps = append(resDeps, fileDeps...)
1238
1239 resArgs = append(resArgs, extraArgs...)
1240 resDeps = append(resDeps, extraDeps...)
1241
1242 if len(resArgs) > 0 {
1243 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1244 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
1245 j.resourceJar = resourceJar
1246 if ctx.Failed() {
1247 return
1248 }
1249 }
1250
1251 var resourceJars android.Paths
1252 if j.resourceJar != nil {
1253 resourceJars = append(resourceJars, j.resourceJar)
1254 }
1255 if Bool(j.properties.Include_srcs) {
1256 resourceJars = append(resourceJars, includeSrcJar)
1257 }
1258 resourceJars = append(resourceJars, deps.staticResourceJars...)
1259
1260 if len(resourceJars) > 1 {
1261 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1262 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1263 false, nil, nil)
1264 j.resourceJar = combinedJar
1265 } else if len(resourceJars) == 1 {
1266 j.resourceJar = resourceJars[0]
1267 }
1268
1269 if len(deps.staticJars) > 0 {
1270 jars = append(jars, deps.staticJars...)
1271 }
1272
1273 manifest := j.overrideManifest
1274 if !manifest.Valid() && j.properties.Manifest != nil {
1275 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
1276 }
1277
1278 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1279 if len(services) > 0 {
1280 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1281 var zipargs []string
1282 for _, file := range services {
1283 serviceFile := file.String()
1284 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1285 }
1286 rule := zip
1287 args := map[string]string{
1288 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1289 }
1290 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1291 rule = zipRE
1292 args["implicits"] = strings.Join(services.Strings(), ",")
1293 }
1294 ctx.Build(pctx, android.BuildParams{
1295 Rule: rule,
1296 Output: servicesJar,
1297 Implicits: services,
1298 Args: args,
1299 })
1300 jars = append(jars, servicesJar)
1301 }
1302
1303 // Combine the classes built from sources, any manifests, and any static libraries into
1304 // classes.jar. If there is only one input jar this step will be skipped.
1305 var outputFile android.OutputPath
1306
1307 if len(jars) == 1 && !manifest.Valid() {
1308 // Optimization: skip the combine step as there is nothing to do
1309 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1310 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1311 // any if len(jars) == 1.
1312
1313 // Transform the single path to the jar into an OutputPath as that is required by the following
1314 // code.
1315 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok {
1316 // The path contains an embedded OutputPath so reuse that.
1317 outputFile = moduleOutPath.OutputPath
1318 } else if outputPath, ok := jars[0].(android.OutputPath); ok {
1319 // The path is an OutputPath so reuse it directly.
1320 outputFile = outputPath
1321 } else {
1322 // The file is not in the out directory so create an OutputPath into which it can be copied
1323 // and which the following code can use to refer to it.
1324 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1325 ctx.Build(pctx, android.BuildParams{
1326 Rule: android.Cp,
1327 Input: jars[0],
1328 Output: combinedJar,
1329 })
1330 outputFile = combinedJar.OutputPath
1331 }
1332 } else {
1333 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1334 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1335 false, nil, nil)
1336 outputFile = combinedJar.OutputPath
1337 }
1338
1339 // jarjar implementation jar if necessary
1340 if j.expandJarjarRules != nil {
1341 // Transform classes.jar into classes-jarjar.jar
1342 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName).OutputPath
1343 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
1344 outputFile = jarjarFile
1345
1346 // jarjar resource jar if necessary
1347 if j.resourceJar != nil {
1348 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
1349 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
1350 j.resourceJar = resourceJarJarFile
1351 }
1352
1353 if ctx.Failed() {
1354 return
1355 }
1356 }
1357
1358 // Check package restrictions if necessary.
1359 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001360 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001361 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001362
1363 // Create a rule to copy the output jar to another path and add a validate dependency that
1364 // will check that the jar only contains the permitted packages. The new location will become
1365 // the output file of this module.
1366 inputFile := outputFile
1367 outputFile = android.PathForModuleOut(ctx, "package-check", jarName).OutputPath
1368 ctx.Build(pctx, android.BuildParams{
1369 Rule: android.Cp,
1370 Input: inputFile,
1371 Output: outputFile,
1372 // Make sure that any dependency on the output file will cause ninja to run the package check
1373 // rule.
1374 Validation: pkgckFile,
1375 })
1376
1377 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001378 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001379
1380 if ctx.Failed() {
1381 return
1382 }
1383 }
1384
1385 j.implementationJarFile = outputFile
1386 if j.headerJarFile == nil {
1387 j.headerJarFile = j.implementationJarFile
1388 }
1389
1390 if j.shouldInstrumentInApex(ctx) {
1391 j.properties.Instrument = true
1392 }
1393
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001394 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1395 specs := j.jacocoModuleToZipCommand(ctx)
1396 if ctx.Failed() {
1397 return
1398 }
1399
Jaewoong Jung26342642021-03-17 15:56:23 -07001400 if j.shouldInstrument(ctx) {
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001401 outputFile = j.instrument(ctx, flags, outputFile, jarName, specs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001402 }
1403
1404 // merge implementation jar with resources if necessary
1405 implementationAndResourcesJar := outputFile
1406 if j.resourceJar != nil {
1407 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
1408 combinedJar := android.PathForModuleOut(ctx, "withres", jarName).OutputPath
1409 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
1410 false, nil, nil)
1411 implementationAndResourcesJar = combinedJar
1412 }
1413
1414 j.implementationAndResourcesJar = implementationAndResourcesJar
1415
1416 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
1417 apexInfo := ctx.Provider(android.ApexInfoProvider).(android.ApexInfo)
1418 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
1419 if j.dexProperties.Compile_dex == nil {
1420 j.dexProperties.Compile_dex = proptools.BoolPtr(true)
1421 }
1422 if j.deviceProperties.Hostdex == nil {
1423 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1424 }
1425 }
1426
1427 if ctx.Device() && (Bool(j.properties.Installable) || Bool(j.dexProperties.Compile_dex)) {
1428 if j.hasCode(ctx) {
1429 if j.shouldInstrumentStatic(ctx) {
1430 j.dexer.extraProguardFlagFiles = append(j.dexer.extraProguardFlagFiles,
1431 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1432 }
1433 // Dex compilation
1434 var dexOutputFile android.OutputPath
Colin Crossa79a52c2021-08-04 10:52:44 -07001435 dexOutputFile = j.dexer.compileDex(ctx, flags, j.MinSdkVersion(ctx), implementationAndResourcesJar, jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001436 if ctx.Failed() {
1437 return
1438 }
1439
Jaewoong Jung26342642021-03-17 15:56:23 -07001440 // merge dex jar with resources if necessary
1441 if j.resourceJar != nil {
1442 jars := android.Paths{dexOutputFile, j.resourceJar}
1443 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName).OutputPath
1444 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1445 false, nil, nil)
1446 if *j.dexProperties.Uncompress_dex {
1447 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName).OutputPath
1448 TransformZipAlign(ctx, combinedAlignedJar, combinedJar)
1449 dexOutputFile = combinedAlignedJar
1450 } else {
1451 dexOutputFile = combinedJar
1452 }
1453 }
1454
Paul Duffin4de94502021-05-16 05:21:16 +01001455 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001456
1457 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001458
1459 // Encode hidden API flags in dex file, if needed.
1460 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1461
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001462 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001463
1464 // Dexpreopting
1465 j.dexpreopt(ctx, dexOutputFile)
1466
1467 outputFile = dexOutputFile
1468 } else {
1469 // There is no code to compile into a dex jar, make sure the resources are propagated
1470 // to the APK if this is an app.
1471 outputFile = implementationAndResourcesJar
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001472 j.dexJarFile = makeDexJarPathFromPath(j.resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001473 }
1474
1475 if ctx.Failed() {
1476 return
1477 }
1478 } else {
1479 outputFile = implementationAndResourcesJar
1480 }
1481
1482 if ctx.Device() {
Cole Faust8b7f6272022-04-20 18:02:42 -07001483 lintSDKVersion := func(sdkSpec android.SdkSpec) int {
Jiyong Park54105c42021-03-31 18:17:53 +09001484 if v := sdkSpec.ApiLevel; !v.IsPreview() {
Cole Faust8b7f6272022-04-20 18:02:42 -07001485 return v.FinalInt()
Jaewoong Jung26342642021-03-17 15:56:23 -07001486 } else {
Cole Faust8b7f6272022-04-20 18:02:42 -07001487 // When running metalava, we pass --version-codename. When that value
1488 // is not REL, metalava will add 1 to the --current-version argument.
1489 // On old branches, PLATFORM_SDK_VERSION is the latest version (for that
1490 // branch) and the codename is REL, except potentially on the most
1491 // recent non-master branch. On that branch, it goes through two other
1492 // phases before it gets to the phase previously described:
1493 // - PLATFORM_SDK_VERSION has not been updated yet, and the codename
1494 // is not rel. This happens for most of the internal branch's life
1495 // while the branch has been cut but is still under active development.
1496 // - PLATFORM_SDK_VERSION has been set, but the codename is still not
1497 // REL. This happens briefly during the release process. During this
1498 // state the code to add --current-version is commented out, and then
1499 // that commenting out is reverted after the codename is set to REL.
1500 // On the master branch, the PLATFORM_SDK_VERSION always represents a
1501 // prior version and the codename is always non-REL.
1502 //
1503 // We need to add one here to match metalava adding 1. Technically
1504 // this means that in the state described in the second bullet point
1505 // above, this number is 1 higher than it should be.
1506 return ctx.Config().PlatformSdkVersion().FinalInt() + 1
Jaewoong Jung26342642021-03-17 15:56:23 -07001507 }
1508 }
1509
1510 j.linter.name = ctx.ModuleName()
1511 j.linter.srcs = srcFiles
1512 j.linter.srcJars = srcJars
1513 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1514 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001515 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
1516 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
1517 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx))
Pedro Loureiro18233a22021-06-08 18:11:21 +00001518 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001519 j.linter.javaLanguageLevel = flags.javaVersion.String()
1520 j.linter.kotlinLanguageLevel = "1.3"
1521 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1522 j.linter.buildModuleReportZip = true
1523 }
1524 j.linter.lint(ctx)
1525 }
1526
1527 ctx.CheckbuildFile(outputFile)
1528
1529 ctx.SetProvider(JavaInfoProvider, JavaInfo{
1530 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1531 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1532 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
1533 ResourceJars: android.PathsIfNonNil(j.resourceJar),
1534 AidlIncludeDirs: j.exportAidlIncludeDirs,
1535 SrcJarArgs: j.srcJarArgs,
1536 SrcJarDeps: j.srcJarDeps,
1537 ExportedPlugins: j.exportedPluginJars,
1538 ExportedPluginClasses: j.exportedPluginClasses,
1539 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1540 JacocoReportClassesFile: j.jacocoReportClassesFile,
1541 })
1542
1543 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1544 j.outputFile = outputFile.WithoutRel()
1545}
1546
Colin Crossa1ff7c62021-09-17 14:11:52 -07001547func (j *Module) useCompose() bool {
1548 return android.InList("androidx.compose.runtime_runtime", j.properties.Static_libs)
1549}
1550
Cole Faust75fffb12021-06-13 15:23:16 -07001551// Returns a copy of the supplied flags, but with all the errorprone-related
1552// fields copied to the regular build's fields.
1553func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1554 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1555
1556 if len(flags.errorProneExtraJavacFlags) > 0 {
1557 if len(flags.javacFlags) > 0 {
1558 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
1559 } else {
1560 flags.javacFlags = flags.errorProneExtraJavacFlags
1561 }
1562 }
1563 return flags
1564}
1565
Jaewoong Jung26342642021-03-17 15:56:23 -07001566func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
1567 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.WritablePath {
1568
1569 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
1570 if idx >= 0 {
1571 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
1572 jarName += strconv.Itoa(idx)
1573 }
1574
1575 classes := android.PathForModuleOut(ctx, "javac", jarName).OutputPath
1576 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, flags, extraJarDeps)
1577
1578 if ctx.Config().EmitXrefRules() {
1579 extractionFile := android.PathForModuleOut(ctx, kzipName)
1580 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1581 j.kytheFiles = append(j.kytheFiles, extractionFile)
1582 }
1583
1584 return classes
1585}
1586
1587// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1588// since some of these flags may be used internally.
1589func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1590 for _, flag := range flags {
1591 flag = strings.TrimSpace(flag)
1592
1593 if !strings.HasPrefix(flag, "-") {
1594 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1595 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1596 ctx.PropertyErrorf("kotlincflags",
1597 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1598 } else if inList(flag, config.KotlincIllegalFlags) {
1599 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1600 } else if flag == "-include-runtime" {
1601 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1602 } else {
1603 args := strings.Split(flag, " ")
1604 if args[0] == "-kotlin-home" {
1605 ctx.PropertyErrorf("kotlincflags",
1606 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1607 }
1608 }
1609 }
1610}
1611
1612func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
1613 deps deps, flags javaBuilderFlags, jarName string,
Colin Cross3d56ed52021-11-18 22:23:12 -08001614 extraJars android.Paths) (headerJar, jarjarAndDepsHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001615
1616 var jars android.Paths
1617 if len(srcFiles) > 0 || len(srcJars) > 0 {
1618 // Compile java sources into turbine.jar.
1619 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1620 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1621 if ctx.Failed() {
1622 return nil, nil
1623 }
1624 jars = append(jars, turbineJar)
Colin Cross3d56ed52021-11-18 22:23:12 -08001625 headerJar = turbineJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001626 }
1627
1628 jars = append(jars, extraJars...)
1629
1630 // Combine any static header libraries into classes-header.jar. If there is only
1631 // one input jar this step will be skipped.
1632 jars = append(jars, deps.staticHeaderJars...)
1633
1634 // we cannot skip the combine step for now if there is only one jar
1635 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1636 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
1637 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
1638 false, nil, []string{"META-INF/TRANSITIVE"})
Colin Cross3d56ed52021-11-18 22:23:12 -08001639 jarjarAndDepsHeaderJar = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001640
1641 if j.expandJarjarRules != nil {
1642 // Transform classes.jar into classes-jarjar.jar
1643 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Colin Cross3d56ed52021-11-18 22:23:12 -08001644 TransformJarJar(ctx, jarjarFile, jarjarAndDepsHeaderJar, j.expandJarjarRules)
1645 jarjarAndDepsHeaderJar = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001646 if ctx.Failed() {
1647 return nil, nil
1648 }
1649 }
1650
Colin Cross3d56ed52021-11-18 22:23:12 -08001651 return headerJar, jarjarAndDepsHeaderJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001652}
1653
1654func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001655 classesJar android.Path, jarName string, specs string) android.OutputPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07001656
1657 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
1658 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName).OutputPath
1659
1660 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1661
1662 j.jacocoReportClassesFile = jacocoReportClassesFile
1663
1664 return instrumentedJar
1665}
1666
1667func (j *Module) HeaderJars() android.Paths {
1668 if j.headerJarFile == nil {
1669 return nil
1670 }
1671 return android.Paths{j.headerJarFile}
1672}
1673
1674func (j *Module) ImplementationJars() android.Paths {
1675 if j.implementationJarFile == nil {
1676 return nil
1677 }
1678 return android.Paths{j.implementationJarFile}
1679}
1680
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001681func (j *Module) DexJarBuildPath() OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07001682 return j.dexJarFile
1683}
1684
1685func (j *Module) DexJarInstallPath() android.Path {
1686 return j.installFile
1687}
1688
1689func (j *Module) ImplementationAndResourcesJars() android.Paths {
1690 if j.implementationAndResourcesJar == nil {
1691 return nil
1692 }
1693 return android.Paths{j.implementationAndResourcesJar}
1694}
1695
1696func (j *Module) AidlIncludeDirs() android.Paths {
1697 // exportAidlIncludeDirs is type android.Paths already
1698 return j.exportAidlIncludeDirs
1699}
1700
1701func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
1702 return j.classLoaderContexts
1703}
1704
1705// Collect information for opening IDE project files in java/jdeps.go.
1706func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
1707 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
1708 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
1709 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
1710 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
1711 if j.expandJarjarRules != nil {
1712 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
1713 }
1714 dpInfo.Paths = append(dpInfo.Paths, j.modulePaths...)
Yikef6282022022-04-13 20:41:01 +08001715 dpInfo.Static_libs = append(dpInfo.Static_libs, j.properties.Static_libs...)
1716 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001717}
1718
1719func (j *Module) CompilerDeps() []string {
1720 jdeps := []string{}
1721 jdeps = append(jdeps, j.properties.Libs...)
1722 jdeps = append(jdeps, j.properties.Static_libs...)
1723 return jdeps
1724}
1725
1726func (j *Module) hasCode(ctx android.ModuleContext) bool {
1727 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
1728 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
1729}
1730
1731// Implements android.ApexModule
1732func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
1733 return j.depIsInSameApex(ctx, dep)
1734}
1735
1736// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00001737func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Jiyong Park92315372021-04-02 08:45:46 +09001738 sdkSpec := j.MinSdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09001739 if !sdkSpec.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001740 return fmt.Errorf("min_sdk_version is not specified")
1741 }
Jiyong Parkf1691d22021-03-29 20:11:58 +09001742 if sdkSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07001743 return nil
1744 }
Jooyung Han4c4da062021-06-23 10:23:16 +09001745 if sdkSpec.ApiLevel.GreaterThan(sdkVersion) {
1746 return fmt.Errorf("newer SDK(%v)", sdkSpec.ApiLevel)
Jaewoong Jung26342642021-03-17 15:56:23 -07001747 }
1748 return nil
1749}
1750
1751func (j *Module) Stem() string {
Jooyung Han01d80d82022-01-08 12:16:32 +09001752 return proptools.StringDefault(j.overridableDeviceProperties.Stem, j.Name())
Jaewoong Jung26342642021-03-17 15:56:23 -07001753}
1754
Jaewoong Jung26342642021-03-17 15:56:23 -07001755func (j *Module) JacocoReportClassesFile() android.Path {
1756 return j.jacocoReportClassesFile
1757}
1758
1759func (j *Module) IsInstallable() bool {
1760 return Bool(j.properties.Installable)
1761}
1762
1763type sdkLinkType int
1764
1765const (
1766 // TODO(jiyong) rename these for better readability. Make the allowed
1767 // and disallowed link types explicit
1768 // order is important here. See rank()
1769 javaCore sdkLinkType = iota
1770 javaSdk
1771 javaSystem
1772 javaModule
1773 javaSystemServer
1774 javaPlatform
1775)
1776
1777func (lt sdkLinkType) String() string {
1778 switch lt {
1779 case javaCore:
1780 return "core Java API"
1781 case javaSdk:
1782 return "Android API"
1783 case javaSystem:
1784 return "system API"
1785 case javaModule:
1786 return "module API"
1787 case javaSystemServer:
1788 return "system server API"
1789 case javaPlatform:
1790 return "private API"
1791 default:
1792 panic(fmt.Errorf("unrecognized linktype: %d", lt))
1793 }
1794}
1795
1796// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
1797// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
1798// can't statically depend on modules that use Platform API.
1799func (lt sdkLinkType) rank() int {
1800 return int(lt)
1801}
1802
1803type moduleWithSdkDep interface {
1804 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09001805 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07001806}
1807
Jiyong Park92315372021-04-02 08:45:46 +09001808func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001809 switch name {
1810 case "core.current.stubs", "legacy.core.platform.api.stubs", "stable.core.platform.api.stubs",
1811 "stub-annotations", "private-stub-annotations-jar",
1812 "core-lambda-stubs", "core-generated-annotation-stubs":
1813 return javaCore, true
1814 case "android_stubs_current":
1815 return javaSdk, true
1816 case "android_system_stubs_current":
1817 return javaSystem, true
1818 case "android_module_lib_stubs_current":
1819 return javaModule, true
1820 case "android_system_server_stubs_current":
1821 return javaSystemServer, true
1822 case "android_test_stubs_current":
1823 return javaSystem, true
1824 }
1825
1826 if stub, linkType := moduleStubLinkType(name); stub {
1827 return linkType, true
1828 }
1829
Jiyong Park92315372021-04-02 08:45:46 +09001830 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09001831 switch ver.Kind {
1832 case android.SdkCore:
Jaewoong Jung26342642021-03-17 15:56:23 -07001833 return javaCore, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09001834 case android.SdkSystem:
Jaewoong Jung26342642021-03-17 15:56:23 -07001835 return javaSystem, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09001836 case android.SdkPublic:
Jaewoong Jung26342642021-03-17 15:56:23 -07001837 return javaSdk, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09001838 case android.SdkModule:
Jaewoong Jung26342642021-03-17 15:56:23 -07001839 return javaModule, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09001840 case android.SdkSystemServer:
Jaewoong Jung26342642021-03-17 15:56:23 -07001841 return javaSystemServer, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09001842 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
Jaewoong Jung26342642021-03-17 15:56:23 -07001843 return javaPlatform, false
1844 }
1845
Jiyong Parkf1691d22021-03-29 20:11:58 +09001846 if !ver.Valid() {
1847 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07001848 }
1849 return javaSdk, false
1850}
1851
1852// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
1853// this module's. See the comment on rank() for details and an example.
1854func (j *Module) checkSdkLinkType(
1855 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
1856 if ctx.Host() {
1857 return
1858 }
1859
Jiyong Park92315372021-04-02 08:45:46 +09001860 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07001861 if stubs {
1862 return
1863 }
Jiyong Park92315372021-04-02 08:45:46 +09001864 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07001865
1866 if myLinkType.rank() < depLinkType.rank() {
1867 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
1868 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
1869 "property of the source or target module so that target module is built "+
1870 "with the same or smaller API set when compared to the source.",
1871 myLinkType, ctx.OtherModuleName(dep), depLinkType)
1872 }
1873}
1874
1875func (j *Module) collectDeps(ctx android.ModuleContext) deps {
1876 var deps deps
1877
1878 if ctx.Device() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09001879 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001880 if sdkDep.invalidVersion {
1881 ctx.AddMissingDependencies(sdkDep.bootclasspath)
1882 ctx.AddMissingDependencies(sdkDep.java9Classpath)
1883 } else if sdkDep.useFiles {
1884 // sdkDep.jar is actually equivalent to turbine header.jar.
1885 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001886 deps.dexClasspath = append(deps.dexClasspath, sdkDep.jars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001887 deps.aidlPreprocess = sdkDep.aidl
1888 } else {
1889 deps.aidlPreprocess = sdkDep.aidl
1890 }
1891 }
1892
Jiyong Park92315372021-04-02 08:45:46 +09001893 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07001894
1895 ctx.VisitDirectDeps(func(module android.Module) {
1896 otherName := ctx.OtherModuleName(module)
1897 tag := ctx.OtherModuleDependencyTag(module)
1898
1899 if IsJniDepTag(tag) {
1900 // Handled by AndroidApp.collectAppDeps
1901 return
1902 }
1903 if tag == certificateTag {
1904 // Handled by AndroidApp.collectAppDeps
1905 return
1906 }
1907
1908 if dep, ok := module.(SdkLibraryDependency); ok {
1909 switch tag {
1910 case libTag:
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001911 depHeaderJars := dep.SdkHeaderJars(ctx, j.SdkVersion(ctx))
1912 deps.classpath = append(deps.classpath, depHeaderJars...)
1913 deps.dexClasspath = append(deps.dexClasspath, depHeaderJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001914 case staticLibTag:
1915 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
1916 }
1917 } else if ctx.OtherModuleHasProvider(module, JavaInfoProvider) {
1918 dep := ctx.OtherModuleProvider(module, JavaInfoProvider).(JavaInfo)
1919 if sdkLinkType != javaPlatform &&
1920 ctx.OtherModuleHasProvider(module, SyspropPublicStubInfoProvider) {
1921 // dep is a sysprop implementation library, but this module is not linking against
1922 // the platform, so it gets the sysprop public stubs library instead. Replace
1923 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
1924 syspropDep := ctx.OtherModuleProvider(module, SyspropPublicStubInfoProvider).(SyspropPublicStubInfo)
1925 dep = syspropDep.JavaInfo
1926 }
1927 switch tag {
1928 case bootClasspathTag:
1929 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
1930 case libTag, instrumentationForTag:
1931 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001932 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001933 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
1934 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
1935 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
1936 case java9LibTag:
1937 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
1938 case staticLibTag:
1939 deps.classpath = append(deps.classpath, dep.HeaderJars...)
1940 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
1941 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
1942 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
1943 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
1944 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
1945 // Turbine doesn't run annotation processors, so any module that uses an
1946 // annotation processor that generates API is incompatible with the turbine
1947 // optimization.
1948 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
1949 case pluginTag:
1950 if plugin, ok := module.(*Plugin); ok {
1951 if plugin.pluginProperties.Processor_class != nil {
1952 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
1953 } else {
1954 addPlugins(&deps, dep.ImplementationAndResourcesJars)
1955 }
1956 // Turbine doesn't run annotation processors, so any module that uses an
1957 // annotation processor that generates API is incompatible with the turbine
1958 // optimization.
1959 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
1960 } else {
1961 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
1962 }
1963 case errorpronePluginTag:
1964 if _, ok := module.(*Plugin); ok {
1965 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
1966 } else {
1967 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
1968 }
1969 case exportedPluginTag:
1970 if plugin, ok := module.(*Plugin); ok {
1971 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
1972 if plugin.pluginProperties.Processor_class != nil {
1973 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
1974 }
1975 // Turbine doesn't run annotation processors, so any module that uses an
1976 // annotation processor that generates API is incompatible with the turbine
1977 // optimization.
1978 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
1979 } else {
1980 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
1981 }
1982 case kotlinStdlibTag:
1983 deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars...)
1984 case kotlinAnnotationsTag:
1985 deps.kotlinAnnotations = dep.HeaderJars
Colin Crossa1ff7c62021-09-17 14:11:52 -07001986 case kotlinPluginTag:
1987 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001988 case syspropPublicStubDepTag:
1989 // This is a sysprop implementation library, forward the JavaInfoProvider from
1990 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
1991 ctx.SetProvider(SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
1992 JavaInfo: dep,
1993 })
1994 }
1995 } else if dep, ok := module.(android.SourceFileProducer); ok {
1996 switch tag {
1997 case libTag:
1998 checkProducesJars(ctx, dep)
1999 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002000 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002001 case staticLibTag:
2002 checkProducesJars(ctx, dep)
2003 deps.classpath = append(deps.classpath, dep.Srcs()...)
2004 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2005 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
2006 }
2007 } else {
2008 switch tag {
2009 case bootClasspathTag:
2010 // If a system modules dependency has been added to the bootclasspath
2011 // then add its libs to the bootclasspath.
2012 sm := module.(SystemModulesProvider)
2013 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars()...)
2014
2015 case systemModulesTag:
2016 if deps.systemModules != nil {
2017 panic("Found two system module dependencies")
2018 }
2019 sm := module.(SystemModulesProvider)
2020 outputDir, outputDeps := sm.OutputDirAndDeps()
2021 deps.systemModules = &systemModules{outputDir, outputDeps}
Paul Duffin53a70a42022-01-11 14:35:55 +00002022
2023 case instrumentationForTag:
2024 ctx.PropertyErrorf("instrumentation_for", "dependency %q of type %q does not provide JavaInfo so is unsuitable for use with this property", ctx.OtherModuleName(module), ctx.OtherModuleType(module))
Jaewoong Jung26342642021-03-17 15:56:23 -07002025 }
2026 }
2027
2028 addCLCFromDep(ctx, module, j.classLoaderContexts)
2029 })
2030
2031 return deps
2032}
2033
2034func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2035 deps.processorPath = append(deps.processorPath, pluginJars...)
2036 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2037}
2038
2039// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2040// this interface.
2041type ProvidesUsesLib interface {
2042 ProvidesUsesLib() *string
2043}
2044
2045func (j *Module) ProvidesUsesLib() *string {
2046 return j.usesLibraryProperties.Provides_uses_lib
2047}
satayev1c564cc2021-05-25 19:50:30 +01002048
2049type ModuleWithStem interface {
2050 Stem() string
2051}
2052
2053var _ ModuleWithStem = (*Module)(nil)
Wei Libafb6d62021-12-10 03:14:59 -08002054
2055func (j *Module) ConvertWithBp2build(ctx android.TopDownMutatorContext) {
2056 switch ctx.ModuleType() {
Sam Delmericofde9fb52022-01-28 20:53:38 +00002057 case "java_library", "java_library_host", "java_library_static":
Wei Libafb6d62021-12-10 03:14:59 -08002058 if lib, ok := ctx.Module().(*Library); ok {
2059 javaLibraryBp2Build(ctx, lib)
2060 }
2061 case "java_binary_host":
2062 if binary, ok := ctx.Module().(*Binary); ok {
2063 javaBinaryHostBp2Build(ctx, binary)
2064 }
2065 }
Wei Libafb6d62021-12-10 03:14:59 -08002066}