blob: ad79e986d71df43d1036b93af8a080580e33b577 [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"
Joe Onorato349ae8d2024-02-05 22:46:00 +000020 "reflect"
21 "slices"
Jaewoong Jung26342642021-03-17 15:56:23 -070022 "strconv"
23 "strings"
24
Colin Crossd788b3e2023-11-28 13:14:56 -080025 "github.com/google/blueprint"
Jaewoong Jung26342642021-03-17 15:56:23 -070026 "github.com/google/blueprint/pathtools"
27 "github.com/google/blueprint/proptools"
28
29 "android/soong/android"
30 "android/soong/dexpreopt"
31 "android/soong/java/config"
32)
33
34// This file contains the definition and the implementation of the base module that most
35// source-based Java module structs embed.
36
37// TODO:
38// Autogenerated files:
39// Renderscript
40// Post-jar passes:
41// Proguard
42// Rmtypedefs
43// DroidDoc
44// Findbugs
45
46// Properties that are common to most Java modules, i.e. whether it's a host or device module.
47type CommonProperties struct {
48 // list of source files used to compile the Java module. May be .java, .kt, .logtags, .proto,
49 // or .aidl files.
50 Srcs []string `android:"path,arch_variant"`
51
52 // list Kotlin of source files containing Kotlin code that should be treated as common code in
53 // a codebase that supports Kotlin multiplatform. See
54 // https://kotlinlang.org/docs/reference/multiplatform.html. May be only be .kt files.
55 Common_srcs []string `android:"path,arch_variant"`
56
57 // list of source files that should not be used to build the Java module.
58 // This is most useful in the arch/multilib variants to remove non-common files
59 Exclude_srcs []string `android:"path,arch_variant"`
60
61 // list of directories containing Java resources
62 Java_resource_dirs []string `android:"arch_variant"`
63
64 // list of directories that should be excluded from java_resource_dirs
65 Exclude_java_resource_dirs []string `android:"arch_variant"`
66
67 // list of files to use as Java resources
68 Java_resources []string `android:"path,arch_variant"`
69
70 // list of files that should be excluded from java_resources and java_resource_dirs
71 Exclude_java_resources []string `android:"path,arch_variant"`
72
73 // list of module-specific flags that will be used for javac compiles
74 Javacflags []string `android:"arch_variant"`
75
76 // list of module-specific flags that will be used for kotlinc compiles
77 Kotlincflags []string `android:"arch_variant"`
78
79 // list of java libraries that will be in the classpath
80 Libs []string `android:"arch_variant"`
81
82 // list of java libraries that will be compiled into the resulting jar
83 Static_libs []string `android:"arch_variant"`
84
Jihoon Kang381c2fa2023-06-01 22:17:32 +000085 // list of java libraries that should not be used to build this module
86 Exclude_static_libs []string `android:"arch_variant"`
87
Jaewoong Jung26342642021-03-17 15:56:23 -070088 // manifest file to be included in resulting jar
89 Manifest *string `android:"path"`
90
91 // if not blank, run jarjar using the specified rules file
92 Jarjar_rules *string `android:"path,arch_variant"`
93
Joe Onorato349ae8d2024-02-05 22:46:00 +000094 // if not blank, used as prefix to generate repackage rule
95 Jarjar_prefix *string
96
Zi Wang9bdd4222024-02-26 18:21:01 -080097 // if set to true, skip the jarjar repackaging
98 Skip_jarjar_repackage *bool
99
Jaewoong Jung26342642021-03-17 15:56:23 -0700100 // If not blank, set the java version passed to javac as -source and -target
101 Java_version *string
102
103 // If set to true, allow this module to be dexed and installed on devices. Has no
104 // effect on host modules, which are always considered installable.
105 Installable *bool
106
107 // If set to true, include sources used to compile the module in to the final jar
108 Include_srcs *bool
109
110 // If not empty, classes are restricted to the specified packages and their sub-packages.
111 // This restriction is checked after applying jarjar rules and including static libs.
112 Permitted_packages []string
113
114 // List of modules to use as annotation processors
115 Plugins []string
116
117 // List of modules to export to libraries that directly depend on this library as annotation
118 // processors. Note that if the plugins set generates_api: true this will disable the turbine
119 // optimization on modules that depend on this module, which will reduce parallelism and cause
120 // more recompilation.
121 Exported_plugins []string
122
123 // The number of Java source entries each Javac instance can process
124 Javac_shard_size *int64
125
126 // Add host jdk tools.jar to bootclasspath
127 Use_tools_jar *bool
128
129 Openjdk9 struct {
130 // List of source files that should only be used when passing -source 1.9 or higher
131 Srcs []string `android:"path"`
132
133 // List of javac flags that should only be used when passing -source 1.9 or higher
134 Javacflags []string
135 }
136
137 // When compiling language level 9+ .java code in packages that are part of
138 // a system module, patch_module names the module that your sources and
139 // dependencies should be patched into. The Android runtime currently
140 // doesn't implement the JEP 261 module system so this option is only
141 // supported at compile time. It should only be needed to compile tests in
142 // packages that exist in libcore and which are inconvenient to move
143 // elsewhere.
Liz Kammer0a470a32023-10-05 17:02:00 -0400144 Patch_module *string
Jaewoong Jung26342642021-03-17 15:56:23 -0700145
146 Jacoco struct {
147 // List of classes to include for instrumentation with jacoco to collect coverage
148 // information at runtime when building with coverage enabled. If unset defaults to all
149 // classes.
150 // Supports '*' as the last character of an entry in the list as a wildcard match.
151 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
152 // it matches classes in the package that have the class name as a prefix.
153 Include_filter []string
154
155 // List of classes to exclude from instrumentation with jacoco to collect coverage
156 // information at runtime when building with coverage enabled. Overrides classes selected
157 // by the include_filter property.
158 // Supports '*' as the last character of an entry in the list as a wildcard match.
159 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
160 // it matches classes in the package that have the class name as a prefix.
161 Exclude_filter []string
162 }
163
164 Errorprone struct {
165 // List of javac flags that should only be used when running errorprone.
166 Javacflags []string
167
168 // List of java_plugin modules that provide extra errorprone checks.
169 Extra_check_modules []string
Cole Faust75fffb12021-06-13 15:23:16 -0700170
Cole Faust2b1536e2021-06-18 12:25:54 -0700171 // This property can be in 3 states. When set to true, errorprone will
172 // be run during the regular build. When set to false, errorprone will
173 // never be run. When unset, errorprone will be run when the RUN_ERROR_PRONE
174 // environment variable is true. Setting this to false will improve build
175 // performance more than adding -XepDisableAllChecks in javacflags.
Cole Faust75fffb12021-06-13 15:23:16 -0700176 Enabled *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700177 }
178
179 Proto struct {
180 // List of extra options that will be passed to the proto generator.
181 Output_params []string
182 }
183
Sam Delmericoc7593722022-08-31 15:57:52 -0400184 // If true, then jacocoagent is automatically added as a libs dependency so that
185 // r8 will not strip instrumentation classes out of dexed libraries.
Jaewoong Jung26342642021-03-17 15:56:23 -0700186 Instrument bool `blueprint:"mutated"`
Paul Duffin0038a8d2022-05-03 00:28:40 +0000187 // If true, then the module supports statically including the jacocoagent
188 // into the library.
189 Supports_static_instrumentation bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700190
191 // List of files to include in the META-INF/services folder of the resulting jar.
192 Services []string `android:"path,arch_variant"`
193
194 // If true, package the kotlin stdlib into the jar. Defaults to true.
195 Static_kotlin_stdlib *bool `android:"arch_variant"`
196
197 // A list of java_library instances that provide additional hiddenapi annotations for the library.
198 Hiddenapi_additional_annotations []string
Joe Onorato175073c2023-06-01 14:42:59 -0700199
200 // Additional srcJars tacked in by GeneratedJavaLibraryModule
201 Generated_srcjars []android.Path `android:"mutated"`
Mark Whitea15790a2023-08-22 21:28:11 +0000202
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000203 // intermediate aconfig cache file tacked in by GeneratedJavaLibraryModule
204 Aconfig_Cache_files []android.Path `android:"mutated"`
205
Mark Whitea15790a2023-08-22 21:28:11 +0000206 // If true, then only the headers are built and not the implementation jar.
Liz Kammer60772632023-10-05 17:18:44 -0400207 Headers_only *bool
Cole Faust2b64af82023-12-13 18:22:18 -0800208
209 // A list of files or dependencies to make available to the build sandbox. This is
210 // useful if source files are symlinks, the targets of the symlinks must be listed here.
211 // Note that currently not all actions implemented by android_apps are sandboxed, so you
212 // may only see this being necessary in lint builds.
213 Compile_data []string `android:"path"`
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000214
215 // Property signifying whether the module compiles stubs or not.
216 // Should be set to true when srcs of this module are stub files.
217 // This property does not need to be set to true when the module depends on
218 // the stubs via libs, but should be set to true when the module depends on
219 // the stubs via static libs.
220 Is_stubs_module *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700221}
222
223// Properties that are specific to device modules. Host module factories should not add these when
224// constructing a new module.
225type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000226 // If not blank, set to the version of the sdk to compile against.
Spandan Das1ccf5742022-10-14 16:51:23 +0000227 // Defaults to an empty string, which compiles the module against the private platform APIs.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000228 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000229 // 1) numerical API level, "current", "none", or "core_platform"
230 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
231 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
232 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700233 Sdk_version *string
234
satayev0a420e72021-11-29 17:25:52 +0000235 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
236 // Defaults to empty string "". See sdk_version for possible values.
237 Max_sdk_version *string
238
William Loh5a082f92022-05-17 20:21:50 +0000239 // if not blank, set the maxSdkVersion properties of permission and uses-permission tags.
240 // Defaults to empty string "". See sdk_version for possible values.
241 Replace_max_sdk_version_placeholder *string
242
Jaewoong Jung26342642021-03-17 15:56:23 -0700243 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000244 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700245 Target_sdk_version *string
246
247 // Whether to compile against the platform APIs instead of an SDK.
248 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000249 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700250 Platform_apis *bool
251
252 Aidl struct {
253 // Top level directories to pass to aidl tool
254 Include_dirs []string
255
256 // Directories rooted at the Android.bp file to pass to aidl tool
257 Local_include_dirs []string
258
259 // directories that should be added as include directories for any aidl sources of modules
260 // that depend on this module, as well as to aidl for this module.
261 Export_include_dirs []string
262
263 // whether to generate traces (for systrace) for this interface
264 Generate_traces *bool
265
266 // whether to generate Binder#GetTransaction name method.
267 Generate_get_transaction_name *bool
268
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100269 // whether all interfaces should be annotated with required permissions.
270 Enforce_permissions *bool
271
272 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
273 Enforce_permissions_exceptions []string `android:"path"`
274
Jaewoong Jung26342642021-03-17 15:56:23 -0700275 // list of flags that will be passed to the AIDL compiler
276 Flags []string
277 }
278
279 // If true, export a copy of the module as a -hostdex module for host testing.
280 Hostdex *bool
281
282 Target struct {
283 Hostdex struct {
284 // Additional required dependencies to add to -hostdex modules.
285 Required []string
286 }
287 }
288
289 // When targeting 1.9 and above, override the modules to use with --system,
290 // otherwise provides defaults libraries to add to the bootclasspath.
291 System_modules *string
292
Jaewoong Jung26342642021-03-17 15:56:23 -0700293 IsSDKLibrary bool `blueprint:"mutated"`
294
295 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
296 // Defaults to false.
297 V4_signature *bool
298
299 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
300 // public stubs library.
301 SyspropPublicStub string `blueprint:"mutated"`
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000302
303 HiddenAPIPackageProperties
304 HiddenAPIFlagFileProperties
Jaewoong Jung26342642021-03-17 15:56:23 -0700305}
306
yangbill2af0b6e2024-03-15 09:29:29 +0000307// Properties that can be overridden by overriding module (e.g. override_android_app)
308type OverridableProperties struct {
Jooyung Han01d80d82022-01-08 12:16:32 +0900309 // set the name of the output. If not set, `name` is used.
310 // To override a module with this property set, overriding module might need to set this as well.
311 // Otherwise, both the overridden and the overriding modules will have the same output name, which
312 // can cause the duplicate output error.
313 Stem *string
Spandan Dasb9c58352024-05-13 18:29:45 +0000314
315 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
316 // Defaults to sdk_version if not set. See sdk_version for possible values.
317 Min_sdk_version *string
Jooyung Han01d80d82022-01-08 12:16:32 +0900318}
319
Jaewoong Jung26342642021-03-17 15:56:23 -0700320// Functionality common to Module and Import
321//
322// It is embedded in Module so its functionality can be used by methods in Module
323// but it is currently only initialized by Import and Library.
324type embeddableInModuleAndImport struct {
325
326 // Functionality related to this being used as a component of a java_sdk_library.
327 EmbeddableSdkLibraryComponent
328}
329
Paul Duffin71b33cc2021-06-23 11:39:47 +0100330func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
331 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700332}
333
334// Module/Import's DepIsInSameApex(...) delegates to this method.
335//
336// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
337// the one provided by ApexModuleBase.
338func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
339 // dependencies other than the static linkage are all considered crossing APEX boundary
340 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
341 return true
342 }
343 return false
344}
345
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100346// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
347// or an invalid path describing the reason it is invalid.
348//
349// It is unset if a dex jar isn't applicable, i.e. no build rule has been
350// requested to create one.
351//
352// If a dex jar has been requested to be built then it is set, and it may be
353// either a valid android.Path, or invalid with a reason message. The latter
354// happens if the source that should produce the dex file isn't able to.
355//
356// E.g. it is invalid with a reason message if there is a prebuilt APEX that
357// could produce the dex jar through a deapexer module, but the APEX isn't
358// installable so doing so wouldn't be safe.
359type OptionalDexJarPath struct {
360 isSet bool
361 path android.OptionalPath
362}
363
364// IsSet returns true if a path has been set, either invalid or valid.
365func (o OptionalDexJarPath) IsSet() bool {
366 return o.isSet
367}
368
369// Valid returns true if there is a path that is valid.
370func (o OptionalDexJarPath) Valid() bool {
371 return o.isSet && o.path.Valid()
372}
373
374// Path returns the valid path, or panics if it's either not set or is invalid.
375func (o OptionalDexJarPath) Path() android.Path {
376 if !o.isSet {
377 panic("path isn't set")
378 }
379 return o.path.Path()
380}
381
382// PathOrNil returns the path if it's set and valid, or else nil.
383func (o OptionalDexJarPath) PathOrNil() android.Path {
384 if o.Valid() {
385 return o.Path()
386 }
387 return nil
388}
389
390// InvalidReason returns the reason for an invalid path, which is never "". It
391// returns "" for an unset or valid path.
392func (o OptionalDexJarPath) InvalidReason() string {
393 if !o.isSet {
394 return ""
395 }
396 return o.path.InvalidReason()
397}
398
399func (o OptionalDexJarPath) String() string {
400 if !o.isSet {
401 return "<unset>"
402 }
403 return o.path.String()
404}
405
406// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
407func makeUnsetDexJarPath() OptionalDexJarPath {
408 return OptionalDexJarPath{isSet: false}
409}
410
411// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
412// the given OptionalPath, which may be valid or invalid.
413func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
414 return OptionalDexJarPath{isSet: true, path: path}
415}
416
417// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
418// valid given path. It returns an unset OptionalDexJarPath if the given path is
419// nil.
420func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
421 if path == nil {
422 return makeUnsetDexJarPath()
423 }
424 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
425}
426
Jaewoong Jung26342642021-03-17 15:56:23 -0700427// Module contains the properties and members used by all java module types
428type Module struct {
429 android.ModuleBase
430 android.DefaultableModuleBase
431 android.ApexModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700432
433 // Functionality common to Module and Import.
434 embeddableInModuleAndImport
435
436 properties CommonProperties
437 protoProperties android.ProtoProperties
438 deviceProperties DeviceProperties
439
yangbill2af0b6e2024-03-15 09:29:29 +0000440 overridableProperties OverridableProperties
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700441 sourceProperties android.SourceProperties
Jooyung Han01d80d82022-01-08 12:16:32 +0900442
Jaewoong Jung26342642021-03-17 15:56:23 -0700443 // jar file containing header classes including static library dependencies, suitable for
444 // inserting into the bootclasspath/classpath of another compile
445 headerJarFile android.Path
446
Joe Onorato349ae8d2024-02-05 22:46:00 +0000447 repackagedHeaderJarFile android.Path
448
Jaewoong Jung26342642021-03-17 15:56:23 -0700449 // jar file containing implementation classes including static library dependencies but no
450 // resources
451 implementationJarFile android.Path
452
453 // jar file containing only resources including from static library dependencies
454 resourceJar android.Path
455
456 // args and dependencies to package source files into a srcjar
457 srcJarArgs []string
458 srcJarDeps android.Paths
459
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000460 // the source files of this module and all its static dependencies
461 transitiveSrcFiles *android.DepSet[android.Path]
462
Jaewoong Jung26342642021-03-17 15:56:23 -0700463 // jar file containing implementation classes and resources including static library
464 // dependencies
465 implementationAndResourcesJar android.Path
466
467 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100468 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700469
470 // output file containing uninstrumented classes that will be instrumented by jacoco
471 jacocoReportClassesFile android.Path
472
473 // output file of the module, which may be a classes jar or a dex jar
474 outputFile android.Path
475 extraOutputFiles android.Paths
476
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100477 exportAidlIncludeDirs android.Paths
478 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700479
480 logtagsSrcs android.Paths
481
482 // installed file for binary dependency
483 installFile android.Path
484
Colin Cross3108ce12021-11-10 14:38:50 -0800485 // installed file for hostdex copy
486 hostdexInstallFile android.InstallPath
487
Chaohui Wangdcbe33c2022-10-11 11:13:30 +0800488 // list of unique .java and .kt source files
489 uniqueSrcFiles android.Paths
490
491 // list of srcjars that was passed to javac
492 compiledSrcJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700493
494 // manifest file to use instead of properties.Manifest
495 overrideManifest android.OptionalPath
496
Jaewoong Jung26342642021-03-17 15:56:23 -0700497 // list of plugins that this java module is exporting
498 exportedPluginJars android.Paths
499
500 // list of plugins that this java module is exporting
501 exportedPluginClasses []string
502
503 // if true, the exported plugins generate API and require disabling turbine.
504 exportedDisableTurbine bool
505
506 // list of source files, collected from srcFiles with unique java and all kt files,
507 // will be used by android.IDEInfo struct
508 expandIDEInfoCompiledSrcs []string
509
510 // expanded Jarjar_rules
511 expandJarjarRules android.Path
512
Joe Onorato349ae8d2024-02-05 22:46:00 +0000513 // jarjar rule for inherited jarjar rules
514 repackageJarjarRules android.Path
515
Jaewoong Jung26342642021-03-17 15:56:23 -0700516 // Extra files generated by the module type to be added as java resources.
517 extraResources android.Paths
518
519 hiddenAPI
520 dexer
521 dexpreopter
522 usesLibrary
523 linter
524
525 // list of the xref extraction files
526 kytheFiles android.Paths
527
Jaewoong Jung26342642021-03-17 15:56:23 -0700528 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900529
530 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000531 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000532 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400533
534 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000535
536 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000537
538 // output file name based on Stem property.
539 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
540 // or the module should override Stem().
541 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700542
Joe Onorato349ae8d2024-02-05 22:46:00 +0000543 // Values that will be set in the JarJarProvider data for jarjar repackaging,
544 // and merged with our dependencies' rules.
545 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000546
547 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000548
549 // Paths to the aconfig intermediate cache files that are provided by the
550 // java_aconfig_library or java_library modules that are statically linked
551 // to this module. Does not contain cache files from all transitive dependencies.
552 aconfigCacheFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700553}
554
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000555var _ android.InstallableModule = (*Module)(nil)
556
557// To satisfy the InstallableModule interface
558func (j *Module) EnforceApiContainerChecks() bool {
559 return true
560}
561
562// Overrides android.ModuleBase.InstallInProduct()
563func (j *Module) InstallInProduct() bool {
564 return j.ProductSpecific()
565}
566
Jiyong Park92315372021-04-02 08:45:46 +0900567func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
568 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900569 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700570 return nil
571 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900572 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000573 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700574 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
575 } else {
576 // Treat stable core platform as stable.
577 return nil
578 }
579 } else {
580 return fmt.Errorf("non stable SDK %v", sdkVersion)
581 }
582}
583
584// checkSdkVersions enforces restrictions around SDK dependencies.
585func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
586 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900587 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900588 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700589 ctx.PropertyErrorf("sdk_version",
590 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
591 }
592 }
593 }
594
595 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
596 // See rank() for details.
597 ctx.VisitDirectDeps(func(module android.Module) {
598 tag := ctx.OtherModuleDependencyTag(module)
599 switch module.(type) {
600 // TODO(satayev): cover other types as well, e.g. imports
601 case *Library, *AndroidLibrary:
602 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400603 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700604 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
605 }
606 }
607 })
608}
609
610func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900611 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700612 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900613 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700614 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000615 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 -0700616 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000617 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 -0700618 }
619
620 }
621}
622
Mark Whitea15790a2023-08-22 21:28:11 +0000623func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
624 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400625 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000626 installable := proptools.Bool(j.properties.Installable)
627
628 if headersOnly && installable {
629 ctx.PropertyErrorf("headers_only", "This module has conflicting settings. headers_only is true which, which means this module doesn't generate an implementation jar. However installable is set to true.")
630 }
631 }
632}
633
Jaewoong Jung26342642021-03-17 15:56:23 -0700634func (j *Module) addHostProperties() {
635 j.AddProperties(
636 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000637 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700638 &j.protoProperties,
639 &j.usesLibraryProperties,
640 )
641}
642
643func (j *Module) addHostAndDeviceProperties() {
644 j.addHostProperties()
645 j.AddProperties(
646 &j.deviceProperties,
647 &j.dexer.dexProperties,
648 &j.dexpreoptProperties,
649 &j.linter.properties,
650 )
651}
652
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000653// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
654// makes it available through the hiddenAPIPropertyInfoProvider.
655func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
656 hiddenAPIInfo := newHiddenAPIPropertyInfo()
657
658 // Populate with flag file paths from the properties.
659 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
660
661 // Populate with package rules from the properties.
662 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
663
Colin Cross40213022023-12-13 15:19:49 -0800664 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000665}
666
Jaewoong Jung26342642021-03-17 15:56:23 -0700667func (j *Module) OutputFiles(tag string) (android.Paths, error) {
668 switch tag {
669 case "":
670 return append(android.Paths{j.outputFile}, j.extraOutputFiles...), nil
671 case android.DefaultDistTag:
672 return android.Paths{j.outputFile}, nil
673 case ".jar":
674 return android.Paths{j.implementationAndResourcesJar}, nil
Colin Crossab50dea2022-10-14 11:45:44 -0700675 case ".hjar":
676 return android.Paths{j.headerJarFile}, nil
Jaewoong Jung26342642021-03-17 15:56:23 -0700677 case ".proguard_map":
678 if j.dexer.proguardDictionary.Valid() {
679 return android.Paths{j.dexer.proguardDictionary.Path()}, nil
680 }
681 return nil, fmt.Errorf("%q was requested, but no output file was found.", tag)
Joe Onoratoffac9be2023-08-19 19:48:34 -0700682 case ".generated_srcjars":
683 return j.properties.Generated_srcjars, nil
Thiébaud Weksteend0544362023-09-29 10:26:43 +1000684 case ".lint":
685 if j.linter.outputs.xml != nil {
686 return android.Paths{j.linter.outputs.xml}, nil
687 }
688 return nil, fmt.Errorf("%q was requested, but no output file was found.", tag)
Jaewoong Jung26342642021-03-17 15:56:23 -0700689 default:
690 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
691 }
692}
693
694var _ android.OutputFileProducer = (*Module)(nil)
695
696func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
697 initJavaModule(module, hod, false)
698}
699
700func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
701 initJavaModule(module, hod, true)
702}
703
704func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
705 multilib := android.MultilibCommon
706 if multiTargets {
707 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
708 } else {
709 android.InitAndroidArchModule(module, hod, multilib)
710 }
711 android.InitDefaultableModule(module)
712}
713
714func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
715 return j.properties.Instrument &&
716 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
717 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
718}
719
720func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000721 return j.properties.Supports_static_instrumentation &&
722 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700723 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
724 ctx.Config().UnbundledBuild())
725}
726
727func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
728 // Force enable the instrumentation for java code that is built for APEXes ...
729 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
730 // doesn't make sense) or framework libraries (e.g. libraries found in the InstrumentFrameworkModules list) unless EMMA_INSTRUMENT_FRAMEWORK is true.
Colin Crossff694a82023-12-13 15:54:49 -0800731 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700732 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000733
Jihoon Kang46d66de2024-05-22 22:42:39 +0000734 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700735 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
736 return true
737 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
738 return true
739 }
740 }
741 return false
742}
743
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400744func (j *Module) setInstrument(value bool) {
745 j.properties.Instrument = value
746}
747
Jiyong Park92315372021-04-02 08:45:46 +0900748func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
749 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700750}
751
Jiyong Parkf1691d22021-03-29 20:11:58 +0900752func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700753 return proptools.String(j.deviceProperties.System_modules)
754}
755
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000756func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000757 if j.overridableProperties.Min_sdk_version != nil {
758 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700759 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000760 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700761}
762
Yu Liuf2b94012023-09-19 15:09:10 -0700763func (j *Module) GetDeviceProperties() *DeviceProperties {
764 return &j.deviceProperties
765}
766
Spandan Dasa26eda72023-03-02 00:56:06 +0000767func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
768 if j.deviceProperties.Max_sdk_version != nil {
769 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
770 }
771 // Default is PrivateApiLevel
772 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000773}
774
Spandan Dasa26eda72023-03-02 00:56:06 +0000775func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
776 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
777 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
778 }
779 // Default is PrivateApiLevel
780 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000781}
782
Jiyong Parkf1691d22021-03-29 20:11:58 +0900783func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000784 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900785}
786
Spandan Dasca70fc42023-03-01 23:38:49 +0000787func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900788 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000789 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900790 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000791 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700792}
793
794func (j *Module) AvailableFor(what string) bool {
795 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
796 // Exception: for hostdex: true libraries, the platform variant is created
797 // even if it's not marked as available to platform. In that case, the platform
798 // variant is used only for the hostdex and not installed to the device.
799 return true
800 }
801 return j.ApexModuleBase.AvailableFor(what)
802}
803
804func (j *Module) deps(ctx android.BottomUpMutatorContext) {
805 if ctx.Device() {
806 j.linter.deps(ctx)
807
Jiyong Parkf1691d22021-03-29 20:11:58 +0900808 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700809
810 if j.deviceProperties.SyspropPublicStub != "" {
811 // This is a sysprop implementation library that has a corresponding sysprop public
812 // stubs library, and a dependency on it so that dependencies on the implementation can
813 // be forwarded to the public stubs library when necessary.
814 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
815 }
816 }
817
818 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000819
820 j.properties.Static_libs = android.RemoveListFromList(j.properties.Static_libs, j.properties.Exclude_static_libs)
Jaewoong Jung26342642021-03-17 15:56:23 -0700821 ctx.AddVariationDependencies(nil, staticLibTag, j.properties.Static_libs...)
822
823 // Add dependency on libraries that provide additional hidden api annotations.
824 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
825
Kiyoung Kim9743bab2024-03-28 15:44:56 +0900826 if ctx.Config().EnforceInterPartitionJavaSdkLibrary() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700827 // Require java_sdk_library at inter-partition java dependency to ensure stable
828 // interface between partitions. If inter-partition java_library dependency is detected,
829 // raise build error because java_library doesn't have a stable interface.
830 //
831 // Inputs:
832 // PRODUCT_ENFORCE_INTER_PARTITION_JAVA_SDK_LIBRARY
833 // if true, enable enforcement
834 // PRODUCT_INTER_PARTITION_JAVA_LIBRARY_ALLOWLIST
835 // exception list of java_library names to allow inter-partition dependency
836 for idx := range j.properties.Libs {
837 if libDeps[idx] == nil {
838 continue
839 }
840
841 if javaDep, ok := libDeps[idx].(javaSdkLibraryEnforceContext); ok {
842 // java_sdk_library is always allowed at inter-partition dependency.
843 // So, skip check.
844 if _, ok := javaDep.(*SdkLibrary); ok {
845 continue
846 }
847
848 j.checkPartitionsForJavaDependency(ctx, "libs", javaDep)
849 }
850 }
851 }
852
853 // For library dependencies that are component libraries (like stubs), add the implementation
854 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
855 for _, dep := range libDeps {
856 if dep != nil {
857 if component, ok := dep.(SdkLibraryComponentDependency); ok {
858 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000859 // Add library as optional if it's one of the optional compatibility libs or it's
860 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100861 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000862 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
863 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100864 tag = usesLibOptTag
865 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100866 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700867 }
868 }
869 }
870 }
871
872 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
873 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
874 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
875
876 android.ProtoDeps(ctx, &j.protoProperties)
877 if j.hasSrcExt(".proto") {
878 protoDeps(ctx, &j.protoProperties)
879 }
880
881 if j.hasSrcExt(".kt") {
882 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
883 // Kotlin files
884 ctx.AddVariationDependencies(nil, kotlinStdlibTag,
885 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8")
Colin Cross06354472022-05-03 14:20:24 -0700886 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700887 }
888
889 // Framework libraries need special handling in static coverage builds: they should not have
890 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
891 // the same jacoco classes coming from different bootclasspath jars.
892 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
893 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
894 j.properties.Instrument = true
895 }
896 } else if j.shouldInstrumentStatic(ctx) {
897 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
898 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700899
900 if j.useCompose() {
901 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
902 "androidx.compose.compiler_compiler-hosted")
903 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700904}
905
906func hasSrcExt(srcs []string, ext string) bool {
907 for _, src := range srcs {
908 if filepath.Ext(src) == ext {
909 return true
910 }
911 }
912
913 return false
914}
915
916func (j *Module) hasSrcExt(ext string) bool {
917 return hasSrcExt(j.properties.Srcs, ext)
918}
919
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100920func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
921 var flags string
922
923 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
924 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
925 flags = "-Wmissing-permission-annotation -Werror"
926 }
927 }
928 return flags
929}
930
Jaewoong Jung26342642021-03-17 15:56:23 -0700931func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000932 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700933
934 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
935 aidlIncludes = append(aidlIncludes,
936 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
937 aidlIncludes = append(aidlIncludes,
938 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
939
940 var flags []string
941 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000942 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700943
944 flags = append(flags, j.deviceProperties.Aidl.Flags...)
945
946 if aidlPreprocess.Valid() {
947 flags = append(flags, "-p"+aidlPreprocess.String())
948 deps = append(deps, aidlPreprocess.Path())
949 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000950 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700951 }
952
953 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000954 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700955 }
956
957 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000958 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700959 }
960
Sam Delmerico2351eac2022-05-24 17:10:02 +0000961 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700962 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000963 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700964 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000965 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
966 // add flags for dirs containing AIDL srcs that haven't been specified yet
967 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -0700968
Zim8774ae12022-08-17 11:46:34 +0100969 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +0000970 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +0100971 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700972 flags = append(flags, "-t")
973 }
974
975 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
976 flags = append(flags, "--transaction_names")
977 }
978
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100979 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
980 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
981 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
982 }
983
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000984 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +0900985 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
986
Jaewoong Jung26342642021-03-17 15:56:23 -0700987 return strings.Join(flags, " "), deps
988}
989
990func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
991
992 var flags javaBuilderFlags
993
994 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +0900995 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -0700996
Cole Faust2b1536e2021-06-18 12:25:54 -0700997 epEnabled := j.properties.Errorprone.Enabled
998 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +0100999 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001000 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1001 }
1002
1003 errorProneFlags := []string{
1004 "-Xplugin:ErrorProne",
1005 "${config.ErrorProneChecks}",
1006 }
1007 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1008
Colin Cross8bf6cad2022-02-28 13:07:03 -08001009 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001010 "'" + strings.Join(errorProneFlags, " ") + "'"
1011 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1012 }
1013
1014 // classpath
1015 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1016 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001017 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001018 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1019 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1020 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1021
1022 flags.processors = append(flags.processors, deps.processorClasses...)
1023 flags.processors = android.FirstUniqueStrings(flags.processors)
1024
1025 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001026 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001027 // Give host-side tools a version of OpenJDK's standard libraries
1028 // close to what they're targeting. As of Dec 2017, AOSP is only
1029 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1030 //
1031 // When building with OpenJDK 8, the following should have no
1032 // effect since those jars would be available by default.
1033 //
1034 // When building with OpenJDK 9 but targeting a version < 1.8,
1035 // putting them on the bootclasspath means that:
1036 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1037 // b) references to existing APIs are not reinterpreted in an
1038 // OpenJDK 9-specific way, eg. calls to subclasses of
1039 // java.nio.Buffer as in http://b/70862583
1040 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1041 flags.bootClasspath = append(flags.bootClasspath,
1042 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1043 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1044 if Bool(j.properties.Use_tools_jar) {
1045 flags.bootClasspath = append(flags.bootClasspath,
1046 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1047 }
1048 }
1049
1050 // systemModules
1051 flags.systemModules = deps.systemModules
1052
Jaewoong Jung26342642021-03-17 15:56:23 -07001053 return flags
1054}
1055
1056func (j *Module) collectJavacFlags(
1057 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1058 // javac flags.
1059 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001060 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001061
Mythri Alle4b9f6182023-10-25 15:17:11 +00001062 needsDebugInfo = false
1063 for _, flag := range javacFlags {
1064 if strings.HasPrefix(flag, "-g") {
1065 needsDebugInfo = true
1066 }
1067 }
1068
1069 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001070 // For non-host binaries, override the -g flag passed globally to remove
1071 // local variable debug info to reduce disk and memory usage.
1072 javacFlags = append(javacFlags, "-g:source,lines")
1073 }
1074 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1075
1076 if flags.javaVersion.usesJavaModules() {
1077 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001078 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1079 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1080 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1081 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001082
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001083 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001084 if j.properties.Patch_module != nil {
1085 // Manually specify build directory in case it is not under the repo root.
1086 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1087 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001088 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001089
Jaewoong Jung26342642021-03-17 15:56:23 -07001090 classPath := flags.classpath.FormJavaClassPath("")
1091 if classPath != "" {
1092 patchPaths = append(patchPaths, classPath)
1093 }
1094 javacFlags = append(
1095 javacFlags,
1096 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1097 }
1098 }
1099
1100 if len(javacFlags) > 0 {
1101 // optimization.
1102 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1103 flags.javacFlags = "$javacFlags"
1104 }
1105
1106 return flags
1107}
1108
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001109func (j *Module) AddJSONData(d *map[string]interface{}) {
1110 (&j.ModuleBase).AddJSONData(d)
1111 (*d)["Java"] = map[string]interface{}{
1112 "SourceExtensions": j.sourceExtensions,
1113 }
1114
1115}
1116
usta0391ca42023-09-19 15:51:59 -04001117func (j *Module) addGeneratedSrcJars(path android.Path) {
1118 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001119}
1120
Colin Cross4eae06d2023-06-20 22:40:02 -07001121func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001122
1123 // Auto-propagating jarjar rules
1124 jarjarProviderData := j.collectJarJarRules(ctx)
1125 if jarjarProviderData != nil {
1126 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wang9bdd4222024-02-26 18:21:01 -08001127 if !proptools.Bool(j.properties.Skip_jarjar_repackage) {
1128 text := getJarJarRuleText(jarjarProviderData)
1129 if text != "" {
1130 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1131 android.WriteFileRule(ctx, ruleTextFile, text)
1132 j.repackageJarjarRules = ruleTextFile
1133 }
Joe Onorato349ae8d2024-02-05 22:46:00 +00001134 }
1135 }
1136
Jaewoong Jung26342642021-03-17 15:56:23 -07001137 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1138
1139 deps := j.collectDeps(ctx)
1140 flags := j.collectBuilderFlags(ctx, deps)
1141
1142 if flags.javaVersion.usesJavaModules() {
1143 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001144 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1145 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1146 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001147 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001148
Jaewoong Jung26342642021-03-17 15:56:23 -07001149 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001150 j.sourceExtensions = []string{}
1151 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1152 if hasSrcExt(srcFiles.Strings(), ext) {
1153 j.sourceExtensions = append(j.sourceExtensions, ext)
1154 }
1155 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001156 if hasSrcExt(srcFiles.Strings(), ".proto") {
1157 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1158 }
1159
1160 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1161 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1162 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1163 }
1164
Sam Delmerico2351eac2022-05-24 17:10:02 +00001165 aidlSrcs := srcFiles.FilterByExt(".aidl")
1166 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1167
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001168 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001169 srcFiles = j.genSources(ctx, srcFiles, flags)
1170
1171 // Collect javac flags only after computing the full set of srcFiles to
1172 // ensure that the --patch-module lookup paths are complete.
1173 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1174
1175 srcJars := srcFiles.FilterByExt(".srcjar")
1176 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001177 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001178 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001179 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001180
1181 if j.properties.Jarjar_rules != nil {
1182 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1183 }
1184
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001185 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001186
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001187 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001188 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001189 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001190 if _, found := set[v.String()]; !found {
1191 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001192 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001193 }
1194 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001195 var uniqueKtFiles android.Paths
1196 for _, v := range srcFiles.FilterByExt(".kt") {
1197 if _, found := set[v.String()]; !found {
1198 set[v.String()] = true
1199 uniqueKtFiles = append(uniqueKtFiles, v)
1200 }
1201 }
1202
1203 var uniqueSrcFiles android.Paths
1204 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1205 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1206 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001207 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001208
Colin Crossb5db4012022-03-28 17:12:39 -07001209 // We don't currently run annotation processors in turbine, which means we can't use turbine
1210 // generated header jars when an annotation processor that generates API is enabled. One
1211 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1212 // is used to run all of the annotation processors.
1213 disableTurbine := deps.disableTurbine
1214
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001215 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001216 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1217
1218 var kotlinJars android.Paths
Colin Cross220a9a12022-03-28 17:08:01 -07001219 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001220
Colin Cross4eae06d2023-06-20 22:40:02 -07001221 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1222 // any dependencies so that it can override any non-final R classes from dependencies with the
1223 // final R classes from the app.
1224 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1225
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001226 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1227
Mark Whitea15790a2023-08-22 21:28:11 +00001228 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001229 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001230 if srcFiles.HasExt(".kt") {
1231 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1232 }
1233 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1234 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1235 }
1236
Joe Onorato349ae8d2024-02-05 22:46:00 +00001237 _, j.headerJarFile, _ =
Mark Whitea15790a2023-08-22 21:28:11 +00001238 j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
1239 extraCombinedJars)
1240 if ctx.Failed() {
1241 return
1242 }
1243
Colin Cross40213022023-12-13 15:19:49 -08001244 android.SetProvider(ctx, JavaInfoProvider, JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001245 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1246 TransitiveLibsHeaderJars: j.transitiveLibsHeaderJars,
1247 TransitiveStaticLibsHeaderJars: j.transitiveStaticLibsHeaderJars,
1248 AidlIncludeDirs: j.exportAidlIncludeDirs,
1249 ExportedPlugins: j.exportedPluginJars,
1250 ExportedPluginClasses: j.exportedPluginClasses,
1251 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1252 StubsLinkType: j.stubsLinkType,
1253 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001254 })
1255
1256 j.outputFile = j.headerJarFile
1257 return
1258 }
1259
Jaewoong Jung26342642021-03-17 15:56:23 -07001260 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001261 // When using kotlin sources turbine is used to generate annotation processor sources,
1262 // including for annotation processors that generate API, so we can use turbine for
1263 // java sources too.
1264 disableTurbine = false
1265
Jaewoong Jung26342642021-03-17 15:56:23 -07001266 // user defined kotlin flags.
1267 kotlincFlags := j.properties.Kotlincflags
1268 CheckKotlincFlags(ctx, kotlincFlags)
1269
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001270 // Workaround for KT-46512
1271 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001272
1273 // If there are kotlin files, compile them first but pass all the kotlin and java files
1274 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1275 // won't emit any classes for them.
1276 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1277 if ctx.Device() {
1278 kotlincFlags = append(kotlincFlags, "-no-jdk")
1279 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001280
1281 for _, plugin := range deps.kotlinPlugins {
1282 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1283 }
1284 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1285
Jaewoong Jung26342642021-03-17 15:56:23 -07001286 if len(kotlincFlags) > 0 {
1287 // optimization.
1288 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1289 flags.kotlincFlags += "$kotlincFlags"
1290 }
1291
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001292 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001293 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1294
1295 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1296 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1297
1298 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1299 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1300
Isaac Chioua23d9942022-04-06 06:14:38 +00001301 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001302 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001303 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1304 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001305 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001306 srcJars = append(srcJars, kaptSrcJar)
1307 kotlinJars = append(kotlinJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001308 // Disable annotation processing in javac, it's already been handled by kapt
1309 flags.processorPath = nil
1310 flags.processors = nil
1311 }
1312
1313 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001314 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001315 kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001316 if ctx.Failed() {
1317 return
1318 }
1319
Zi Wangddb2ee52024-04-02 16:44:02 +00001320 kotlinJarPath := j.repackageFlagsIfNecessary(ctx, kotlinJar.OutputPath, jarName, "kotlinc")
1321
Isaac Chioua23d9942022-04-06 06:14:38 +00001322 // Make javac rule depend on the kotlinc rule
1323 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1324
Zi Wangddb2ee52024-04-02 16:44:02 +00001325 kotlinJars = append(kotlinJars, kotlinJarPath)
Colin Cross220a9a12022-03-28 17:08:01 -07001326 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
1327
Jaewoong Jung26342642021-03-17 15:56:23 -07001328 // Jar kotlin classes into the final jar after javac
1329 if BoolDefault(j.properties.Static_kotlin_stdlib, true) {
1330 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
Colin Cross06354472022-05-03 14:20:24 -07001331 kotlinJars = append(kotlinJars, deps.kotlinAnnotations...)
Colin Cross220a9a12022-03-28 17:08:01 -07001332 kotlinHeaderJars = append(kotlinHeaderJars, deps.kotlinStdlib...)
Colin Cross06354472022-05-03 14:20:24 -07001333 kotlinHeaderJars = append(kotlinHeaderJars, deps.kotlinAnnotations...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001334 } else {
1335 flags.dexClasspath = append(flags.dexClasspath, deps.kotlinStdlib...)
Colin Cross06354472022-05-03 14:20:24 -07001336 flags.dexClasspath = append(flags.dexClasspath, deps.kotlinAnnotations...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001337 }
1338 }
1339
Colin Crossfd620b22024-02-23 10:05:21 -08001340 jars := slices.Clone(kotlinJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001341
Jaewoong Jung26342642021-03-17 15:56:23 -07001342 j.compiledSrcJars = srcJars
1343
1344 enableSharding := false
Colin Cross3d56ed52021-11-18 22:23:12 -08001345 var headerJarFileWithoutDepsOrJarjar android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001346 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001347 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1348 enableSharding = true
1349 // Formerly, there was a check here that prevented annotation processors
1350 // from being used when sharding was enabled, as some annotation processors
1351 // do not function correctly in sharded environments. It was removed to
1352 // allow for the use of annotation processors that do function correctly
1353 // with sharding enabled. See: b/77284273.
1354 }
Colin Crossfd620b22024-02-23 10:05:21 -08001355 extraJars := append(slices.Clone(kotlinHeaderJars), extraCombinedJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00001356 headerJarFileWithoutDepsOrJarjar, j.headerJarFile, j.repackagedHeaderJarFile =
Colin Cross4eae06d2023-06-20 22:40:02 -07001357 j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001358 if ctx.Failed() {
1359 return
1360 }
1361 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001362 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001363 hasErrorproneableFiles := false
1364 for _, ext := range j.sourceExtensions {
1365 if ext != ".proto" && ext != ".aidl" {
1366 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1367 // compile, and it's not useful to have warnings on these generated sources.
1368 hasErrorproneableFiles = true
1369 break
1370 }
1371 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001372 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001373 if Bool(j.properties.Errorprone.Enabled) {
1374 // If error-prone is enabled, enable errorprone flags on the regular
1375 // build.
1376 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001377 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001378 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1379 // a new jar file just for compiling with the errorprone compiler to.
1380 // This is because we don't want to cause the java files to get completely
1381 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1382 // We also don't want to run this if errorprone is enabled by default for
1383 // this module, or else we could have duplicated errorprone messages.
1384 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001385 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001386 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001387
Vadim Spivak3c496f02023-06-08 06:14:59 +00001388 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001389 "errorprone", "errorprone")
1390
Jaewoong Jung26342642021-03-17 15:56:23 -07001391 extraJarDeps = append(extraJarDeps, errorprone)
1392 }
1393
1394 if enableSharding {
Colin Cross3d56ed52021-11-18 22:23:12 -08001395 if headerJarFileWithoutDepsOrJarjar != nil {
1396 flags.classpath = append(classpath{headerJarFileWithoutDepsOrJarjar}, flags.classpath...)
1397 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001398 shardSize := int(*(j.properties.Javac_shard_size))
1399 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001400 if len(uniqueJavaFiles) > 0 {
1401 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001402 for idx, shardSrc := range shardSrcs {
1403 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1404 nil, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001405 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
Jaewoong Jung26342642021-03-17 15:56:23 -07001406 jars = append(jars, classes)
1407 }
1408 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001409 // Assume approximately 5 sources per srcjar.
1410 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1411 // of 5.8 sources per srcjar, but a median of 1, a standard deviation of 10, and a max of 48 source files.
Jaewoong Jung26342642021-03-17 15:56:23 -07001412 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001413 startIdx := len(shardSrcs)
1414 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1415 for idx, shardSrcJars := range shardSrcJarsList {
1416 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1417 nil, shardSrcJars, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001418 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
Colin Crossa052ddb2023-09-25 21:46:58 -07001419 jars = append(jars, classes)
1420 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001421 }
1422 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001423 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001424 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
Jaewoong Jung26342642021-03-17 15:56:23 -07001425 jars = append(jars, classes)
1426 }
1427 if ctx.Failed() {
1428 return
1429 }
1430 }
1431
Colin Crossfd620b22024-02-23 10:05:21 -08001432 jars = append(jars, extraCombinedJars...)
1433
Jaewoong Jung26342642021-03-17 15:56:23 -07001434 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1435
1436 var includeSrcJar android.WritablePath
1437 if Bool(j.properties.Include_srcs) {
1438 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1439 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1440 }
1441
1442 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1443 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1444 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1445 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1446
1447 var resArgs []string
1448 var resDeps android.Paths
1449
1450 resArgs = append(resArgs, dirArgs...)
1451 resDeps = append(resDeps, dirDeps...)
1452
1453 resArgs = append(resArgs, fileArgs...)
1454 resDeps = append(resDeps, fileDeps...)
1455
1456 resArgs = append(resArgs, extraArgs...)
1457 resDeps = append(resDeps, extraDeps...)
1458
1459 if len(resArgs) > 0 {
1460 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1461 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
1462 j.resourceJar = resourceJar
1463 if ctx.Failed() {
1464 return
1465 }
1466 }
1467
1468 var resourceJars android.Paths
1469 if j.resourceJar != nil {
1470 resourceJars = append(resourceJars, j.resourceJar)
1471 }
1472 if Bool(j.properties.Include_srcs) {
1473 resourceJars = append(resourceJars, includeSrcJar)
1474 }
1475 resourceJars = append(resourceJars, deps.staticResourceJars...)
1476
1477 if len(resourceJars) > 1 {
1478 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1479 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1480 false, nil, nil)
1481 j.resourceJar = combinedJar
1482 } else if len(resourceJars) == 1 {
1483 j.resourceJar = resourceJars[0]
1484 }
1485
1486 if len(deps.staticJars) > 0 {
1487 jars = append(jars, deps.staticJars...)
1488 }
1489
1490 manifest := j.overrideManifest
1491 if !manifest.Valid() && j.properties.Manifest != nil {
1492 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
1493 }
1494
1495 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1496 if len(services) > 0 {
1497 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1498 var zipargs []string
1499 for _, file := range services {
1500 serviceFile := file.String()
1501 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1502 }
1503 rule := zip
1504 args := map[string]string{
1505 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1506 }
1507 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1508 rule = zipRE
1509 args["implicits"] = strings.Join(services.Strings(), ",")
1510 }
1511 ctx.Build(pctx, android.BuildParams{
1512 Rule: rule,
1513 Output: servicesJar,
1514 Implicits: services,
1515 Args: args,
1516 })
1517 jars = append(jars, servicesJar)
1518 }
1519
1520 // Combine the classes built from sources, any manifests, and any static libraries into
1521 // classes.jar. If there is only one input jar this step will be skipped.
1522 var outputFile android.OutputPath
1523
1524 if len(jars) == 1 && !manifest.Valid() {
1525 // Optimization: skip the combine step as there is nothing to do
1526 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1527 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1528 // any if len(jars) == 1.
1529
Jihoon Kang1147b312023-06-08 23:25:57 +00001530 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1531 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1532 // either with .from-source or .from-text suffix.
1533 // outputFile should be agnostic to the build configuration,
1534 // thus "combine" the single static lib in order to prevent the static lib from being exposed
1535 // to the copy rules.
1536 stub, _ := moduleStubLinkType(ctx.ModuleName())
1537
Jaewoong Jung26342642021-03-17 15:56:23 -07001538 // Transform the single path to the jar into an OutputPath as that is required by the following
1539 // code.
Jihoon Kang1147b312023-06-08 23:25:57 +00001540 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok && !stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07001541 // The path contains an embedded OutputPath so reuse that.
1542 outputFile = moduleOutPath.OutputPath
Jihoon Kang1147b312023-06-08 23:25:57 +00001543 } else if outputPath, ok := jars[0].(android.OutputPath); ok && !stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07001544 // The path is an OutputPath so reuse it directly.
1545 outputFile = outputPath
1546 } else {
1547 // The file is not in the out directory so create an OutputPath into which it can be copied
1548 // and which the following code can use to refer to it.
1549 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1550 ctx.Build(pctx, android.BuildParams{
1551 Rule: android.Cp,
1552 Input: jars[0],
1553 Output: combinedJar,
1554 })
1555 outputFile = combinedJar.OutputPath
1556 }
1557 } else {
1558 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1559 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1560 false, nil, nil)
1561 outputFile = combinedJar.OutputPath
1562 }
1563
1564 // jarjar implementation jar if necessary
1565 if j.expandJarjarRules != nil {
1566 // Transform classes.jar into classes-jarjar.jar
1567 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName).OutputPath
1568 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
1569 outputFile = jarjarFile
1570
1571 // jarjar resource jar if necessary
1572 if j.resourceJar != nil {
1573 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
1574 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
1575 j.resourceJar = resourceJarJarFile
1576 }
1577
1578 if ctx.Failed() {
1579 return
1580 }
1581 }
1582
1583 // Check package restrictions if necessary.
1584 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001585 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001586 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001587
1588 // Create a rule to copy the output jar to another path and add a validate dependency that
1589 // will check that the jar only contains the permitted packages. The new location will become
1590 // the output file of this module.
1591 inputFile := outputFile
1592 outputFile = android.PathForModuleOut(ctx, "package-check", jarName).OutputPath
1593 ctx.Build(pctx, android.BuildParams{
1594 Rule: android.Cp,
1595 Input: inputFile,
1596 Output: outputFile,
1597 // Make sure that any dependency on the output file will cause ninja to run the package check
1598 // rule.
1599 Validation: pkgckFile,
1600 })
1601
1602 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001603 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001604
1605 if ctx.Failed() {
1606 return
1607 }
1608 }
1609
1610 j.implementationJarFile = outputFile
1611 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001612 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1613 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1614 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1615 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1616 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1617 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1618 j.headerJarFile = headerJarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001619 }
1620
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001621 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1622 specs := j.jacocoModuleToZipCommand(ctx)
1623 if ctx.Failed() {
1624 return
1625 }
1626
Jaewoong Jung26342642021-03-17 15:56:23 -07001627 if j.shouldInstrument(ctx) {
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001628 outputFile = j.instrument(ctx, flags, outputFile, jarName, specs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001629 }
1630
1631 // merge implementation jar with resources if necessary
1632 implementationAndResourcesJar := outputFile
1633 if j.resourceJar != nil {
1634 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
1635 combinedJar := android.PathForModuleOut(ctx, "withres", jarName).OutputPath
1636 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
1637 false, nil, nil)
1638 implementationAndResourcesJar = combinedJar
1639 }
1640
1641 j.implementationAndResourcesJar = implementationAndResourcesJar
1642
1643 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001644 compileDex := j.dexProperties.Compile_dex
Colin Crossff694a82023-12-13 15:54:49 -08001645 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -07001646 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001647 if compileDex == nil {
1648 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001649 }
1650 if j.deviceProperties.Hostdex == nil {
1651 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1652 }
1653 }
1654
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001655 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001656 if j.hasCode(ctx) {
1657 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001658 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001659 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1660 }
1661 // Dex compilation
1662 var dexOutputFile android.OutputPath
Spandan Dasc404cc72023-02-23 18:05:05 +00001663 params := &compileDexParams{
1664 flags: flags,
1665 sdkVersion: j.SdkVersion(ctx),
1666 minSdkVersion: j.MinSdkVersion(ctx),
1667 classesJar: implementationAndResourcesJar,
1668 jarName: jarName,
1669 }
Spandan Das15a67112024-05-30 00:07:40 +00001670 if j.GetProfileGuided() && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting() {
1671 ctx.PropertyErrorf("enable_profile_rewriting",
1672 "Enable_profile_rewriting must be true when profile_guided dexpreopt and R8 optimization/obfuscation is turned on. The attached profile should be sourced from an unoptimized/unobfuscated APK.",
1673 )
1674 }
Spandan Das3dbda182024-05-20 22:23:10 +00001675 if j.EnableProfileRewriting() {
1676 profile := j.GetProfile()
1677 if profile == "" || !j.GetProfileGuided() {
1678 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1679 }
1680 params.artProfileInput = &profile
1681 }
1682 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001683 if ctx.Failed() {
1684 return
1685 }
1686
Spandan Das3dbda182024-05-20 22:23:10 +00001687 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1688 if dexArtProfileOutput != nil {
1689 j.dexpreopter.SetRewrittenProfile(*dexArtProfileOutput)
1690 }
1691
Jaewoong Jung26342642021-03-17 15:56:23 -07001692 // merge dex jar with resources if necessary
1693 if j.resourceJar != nil {
1694 jars := android.Paths{dexOutputFile, j.resourceJar}
1695 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName).OutputPath
1696 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1697 false, nil, nil)
1698 if *j.dexProperties.Uncompress_dex {
1699 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName).OutputPath
Cole Faust51d7bfd2023-09-07 05:31:32 +00001700 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001701 dexOutputFile = combinedAlignedJar
1702 } else {
1703 dexOutputFile = combinedJar
1704 }
1705 }
1706
Paul Duffin4de94502021-05-16 05:21:16 +01001707 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001708
1709 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001710
1711 // Encode hidden API flags in dex file, if needed.
1712 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1713
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001714 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001715
1716 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001717 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1718 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1719 libName = strings.TrimSuffix(libName, ".impl")
1720 }
1721 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001722
1723 outputFile = dexOutputFile
1724 } else {
1725 // There is no code to compile into a dex jar, make sure the resources are propagated
1726 // to the APK if this is an app.
1727 outputFile = implementationAndResourcesJar
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001728 j.dexJarFile = makeDexJarPathFromPath(j.resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001729 }
1730
1731 if ctx.Failed() {
1732 return
1733 }
1734 } else {
1735 outputFile = implementationAndResourcesJar
1736 }
1737
1738 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001739 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001740 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001741 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001742 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001743 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001744 }
1745 }
1746
1747 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001748 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1749 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001750 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1751 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001752 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001753 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001754 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001755 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001756 j.linter.javaLanguageLevel = flags.javaVersion.String()
1757 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001758 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001759 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1760 j.linter.buildModuleReportZip = true
1761 }
1762 j.linter.lint(ctx)
1763 }
1764
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001765 j.collectTransitiveSrcFiles(ctx, srcFiles)
1766
Jaewoong Jung26342642021-03-17 15:56:23 -07001767 ctx.CheckbuildFile(outputFile)
1768
Colin Cross40213022023-12-13 15:19:49 -08001769 android.SetProvider(ctx, JavaInfoProvider, JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001770 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1771 RepackagedHeaderJars: android.PathsIfNonNil(j.repackagedHeaderJarFile),
1772 TransitiveLibsHeaderJars: j.transitiveLibsHeaderJars,
1773 TransitiveStaticLibsHeaderJars: j.transitiveStaticLibsHeaderJars,
1774 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1775 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
1776 ResourceJars: android.PathsIfNonNil(j.resourceJar),
1777 AidlIncludeDirs: j.exportAidlIncludeDirs,
1778 SrcJarArgs: j.srcJarArgs,
1779 SrcJarDeps: j.srcJarDeps,
1780 TransitiveSrcFiles: j.transitiveSrcFiles,
1781 ExportedPlugins: j.exportedPluginJars,
1782 ExportedPluginClasses: j.exportedPluginClasses,
1783 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1784 JacocoReportClassesFile: j.jacocoReportClassesFile,
1785 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001786 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001787 })
1788
1789 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1790 j.outputFile = outputFile.WithoutRel()
1791}
1792
Colin Crossa1ff7c62021-09-17 14:11:52 -07001793func (j *Module) useCompose() bool {
1794 return android.InList("androidx.compose.runtime_runtime", j.properties.Static_libs)
1795}
1796
Colin Crosscde55342024-03-27 14:11:51 -07001797func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []*android.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001798 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001799 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001800 depTag := ctx.OtherModuleDependencyTag(m)
1801
1802 if depProguardInfo.UnconditionallyExportedProguardFlags != nil {
1803 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1804 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1805 }
1806
1807 if depTag == staticLibTag && depProguardInfo.ProguardFlagsFiles != nil {
1808 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1809 }
1810 })
1811
Colin Crosscde55342024-03-27 14:11:51 -07001812 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1813}
1814
1815func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1816 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1817
Sam Delmerico95d70942023-08-02 18:00:35 -04001818 directUnconditionalExportedFlags := android.Paths{}
1819 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1820 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1821 if exportUnconditionally {
1822 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1823 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1824 directUnconditionalExportedFlags = proguardFlagsForThisModule
1825 }
1826
1827 return ProguardSpecInfo{
1828 Export_proguard_flags_files: exportUnconditionally,
1829 ProguardFlagsFiles: android.NewDepSet[android.Path](
1830 android.POSTORDER,
1831 proguardFlagsForThisModule,
1832 transitiveProguardFlags,
1833 ),
1834 UnconditionallyExportedProguardFlags: android.NewDepSet[android.Path](
1835 android.POSTORDER,
1836 directUnconditionalExportedFlags,
1837 transitiveUnconditionalExportedFlags,
1838 ),
1839 }
1840
1841}
1842
Cole Faust75fffb12021-06-13 15:23:16 -07001843// Returns a copy of the supplied flags, but with all the errorprone-related
1844// fields copied to the regular build's fields.
1845func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1846 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1847
1848 if len(flags.errorProneExtraJavacFlags) > 0 {
1849 if len(flags.javacFlags) > 0 {
1850 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
1851 } else {
1852 flags.javacFlags = flags.errorProneExtraJavacFlags
1853 }
1854 }
1855 return flags
1856}
1857
Jaewoong Jung26342642021-03-17 15:56:23 -07001858func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
1859 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.WritablePath {
1860
1861 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00001862 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001863 if idx >= 0 {
1864 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00001865 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001866 jarName += strconv.Itoa(idx)
1867 }
1868
1869 classes := android.PathForModuleOut(ctx, "javac", jarName).OutputPath
Vadim Spivak3c496f02023-06-08 06:14:59 +00001870 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001871
Cole Faust9decf832024-06-11 11:45:53 -07001872 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001873 extractionFile := android.PathForModuleOut(ctx, kzipName)
1874 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1875 j.kytheFiles = append(j.kytheFiles, extractionFile)
1876 }
1877
Vadim Spivak3c496f02023-06-08 06:14:59 +00001878 if len(flags.processorPath) > 0 {
1879 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
1880 }
1881
Jaewoong Jung26342642021-03-17 15:56:23 -07001882 return classes
1883}
1884
1885// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1886// since some of these flags may be used internally.
1887func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1888 for _, flag := range flags {
1889 flag = strings.TrimSpace(flag)
1890
1891 if !strings.HasPrefix(flag, "-") {
1892 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1893 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1894 ctx.PropertyErrorf("kotlincflags",
1895 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1896 } else if inList(flag, config.KotlincIllegalFlags) {
1897 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1898 } else if flag == "-include-runtime" {
1899 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1900 } else {
1901 args := strings.Split(flag, " ")
1902 if args[0] == "-kotlin-home" {
1903 ctx.PropertyErrorf("kotlincflags",
1904 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1905 }
1906 }
1907 }
1908}
1909
1910func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
1911 deps deps, flags javaBuilderFlags, jarName string,
Joe Onorato349ae8d2024-02-05 22:46:00 +00001912 extraJars android.Paths) (headerJar, jarjarAndDepsHeaderJar, jarjarAndDepsRepackagedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001913
1914 var jars android.Paths
1915 if len(srcFiles) > 0 || len(srcJars) > 0 {
1916 // Compile java sources into turbine.jar.
1917 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1918 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1919 if ctx.Failed() {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001920 return nil, nil, nil
Jaewoong Jung26342642021-03-17 15:56:23 -07001921 }
1922 jars = append(jars, turbineJar)
Colin Cross3d56ed52021-11-18 22:23:12 -08001923 headerJar = turbineJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001924 }
1925
1926 jars = append(jars, extraJars...)
1927
1928 // Combine any static header libraries into classes-header.jar. If there is only
1929 // one input jar this step will be skipped.
1930 jars = append(jars, deps.staticHeaderJars...)
1931
1932 // we cannot skip the combine step for now if there is only one jar
1933 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1934 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
1935 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
1936 false, nil, []string{"META-INF/TRANSITIVE"})
Colin Cross3d56ed52021-11-18 22:23:12 -08001937 jarjarAndDepsHeaderJar = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001938
1939 if j.expandJarjarRules != nil {
1940 // Transform classes.jar into classes-jarjar.jar
1941 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Colin Cross3d56ed52021-11-18 22:23:12 -08001942 TransformJarJar(ctx, jarjarFile, jarjarAndDepsHeaderJar, j.expandJarjarRules)
1943 jarjarAndDepsHeaderJar = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001944 if ctx.Failed() {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001945 return nil, nil, nil
Jaewoong Jung26342642021-03-17 15:56:23 -07001946 }
1947 }
1948
Joe Onorato349ae8d2024-02-05 22:46:00 +00001949 if j.repackageJarjarRules != nil {
1950 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-turbine-jarjar", jarName)
1951 TransformJarJar(ctx, repackagedJarjarFile, jarjarAndDepsHeaderJar, j.repackageJarjarRules)
1952 jarjarAndDepsRepackagedHeaderJar = repackagedJarjarFile
1953 if ctx.Failed() {
1954 return nil, nil, nil
1955 }
1956 } else {
1957 jarjarAndDepsRepackagedHeaderJar = jarjarAndDepsHeaderJar
1958 }
1959
1960 return headerJar, jarjarAndDepsHeaderJar, jarjarAndDepsRepackagedHeaderJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001961}
1962
1963func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001964 classesJar android.Path, jarName string, specs string) android.OutputPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07001965
1966 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
1967 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName).OutputPath
1968
1969 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1970
1971 j.jacocoReportClassesFile = jacocoReportClassesFile
1972
1973 return instrumentedJar
1974}
1975
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001976type providesTransitiveHeaderJars struct {
1977 // set of header jars for all transitive libs deps
Colin Crossc85750b2022-04-21 12:50:51 -07001978 transitiveLibsHeaderJars *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001979 // set of header jars for all transitive static libs deps
Colin Crossc85750b2022-04-21 12:50:51 -07001980 transitiveStaticLibsHeaderJars *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001981}
1982
Colin Crossc85750b2022-04-21 12:50:51 -07001983func (j *providesTransitiveHeaderJars) TransitiveLibsHeaderJars() *android.DepSet[android.Path] {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001984 return j.transitiveLibsHeaderJars
1985}
1986
Colin Crossc85750b2022-04-21 12:50:51 -07001987func (j *providesTransitiveHeaderJars) TransitiveStaticLibsHeaderJars() *android.DepSet[android.Path] {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001988 return j.transitiveStaticLibsHeaderJars
1989}
1990
1991func (j *providesTransitiveHeaderJars) collectTransitiveHeaderJars(ctx android.ModuleContext) {
1992 directLibs := android.Paths{}
1993 directStaticLibs := android.Paths{}
Colin Crossc85750b2022-04-21 12:50:51 -07001994 transitiveLibs := []*android.DepSet[android.Path]{}
1995 transitiveStaticLibs := []*android.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001996 ctx.VisitDirectDeps(func(module android.Module) {
1997 // don't add deps of the prebuilt version of the same library
1998 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
1999 return
2000 }
2001
Colin Cross313aa542023-12-13 13:47:44 -08002002 dep, _ := android.OtherModuleProvider(ctx, module, JavaInfoProvider)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002003 tag := ctx.OtherModuleDependencyTag(module)
2004 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2005 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2006 directLibs = append(directLibs, dep.HeaderJars...)
2007 } else if tag == staticLibTag {
2008 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
Jared Dukeefb6d602023-10-27 18:47:10 +00002009 } else {
2010 // Don't propagate transitive libs for other kinds of dependencies.
2011 return
2012 }
2013
2014 if dep.TransitiveLibsHeaderJars != nil {
2015 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJars)
2016 }
2017 if dep.TransitiveStaticLibsHeaderJars != nil {
2018 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJars)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002019 }
2020 })
2021 j.transitiveLibsHeaderJars = android.NewDepSet(android.POSTORDER, directLibs, transitiveLibs)
2022 j.transitiveStaticLibsHeaderJars = android.NewDepSet(android.POSTORDER, directStaticLibs, transitiveStaticLibs)
2023}
2024
Jaewoong Jung26342642021-03-17 15:56:23 -07002025func (j *Module) HeaderJars() android.Paths {
2026 if j.headerJarFile == nil {
2027 return nil
2028 }
2029 return android.Paths{j.headerJarFile}
2030}
2031
2032func (j *Module) ImplementationJars() android.Paths {
2033 if j.implementationJarFile == nil {
2034 return nil
2035 }
2036 return android.Paths{j.implementationJarFile}
2037}
2038
Spandan Das59a4a2b2024-01-09 21:35:56 +00002039func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002040 return j.dexJarFile
2041}
2042
2043func (j *Module) DexJarInstallPath() android.Path {
2044 return j.installFile
2045}
2046
2047func (j *Module) ImplementationAndResourcesJars() android.Paths {
2048 if j.implementationAndResourcesJar == nil {
2049 return nil
2050 }
2051 return android.Paths{j.implementationAndResourcesJar}
2052}
2053
2054func (j *Module) AidlIncludeDirs() android.Paths {
2055 // exportAidlIncludeDirs is type android.Paths already
2056 return j.exportAidlIncludeDirs
2057}
2058
2059func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2060 return j.classLoaderContexts
2061}
2062
2063// Collect information for opening IDE project files in java/jdeps.go.
2064func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
2065 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2066 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2067 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2068 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
2069 if j.expandJarjarRules != nil {
2070 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
2071 }
Yikef6282022022-04-13 20:41:01 +08002072 dpInfo.Static_libs = append(dpInfo.Static_libs, j.properties.Static_libs...)
2073 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Vadim Spivak3c496f02023-06-08 06:14:59 +00002074 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002075}
2076
2077func (j *Module) CompilerDeps() []string {
2078 jdeps := []string{}
2079 jdeps = append(jdeps, j.properties.Libs...)
2080 jdeps = append(jdeps, j.properties.Static_libs...)
2081 return jdeps
2082}
2083
2084func (j *Module) hasCode(ctx android.ModuleContext) bool {
2085 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2086 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2087}
2088
2089// Implements android.ApexModule
2090func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2091 return j.depIsInSameApex(ctx, dep)
2092}
2093
2094// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002095func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002096 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002097 minSdkVersion := j.MinSdkVersion(ctx)
2098 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002099 return fmt.Errorf("min_sdk_version is not specified")
2100 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002101 // If the module is compiling against core (via sdk_version), skip comparison check.
2102 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002103 return nil
2104 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002105 if minSdkVersion.GreaterThan(sdkVersion) {
2106 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002107 }
2108 return nil
2109}
2110
2111func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002112 if j.stem == "" {
2113 panic("Stem() called before stem property was set")
2114 }
2115 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002116}
2117
Jaewoong Jung26342642021-03-17 15:56:23 -07002118func (j *Module) JacocoReportClassesFile() android.Path {
2119 return j.jacocoReportClassesFile
2120}
2121
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002122func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
2123 var fromDeps []*android.DepSet[android.Path]
2124 ctx.VisitDirectDeps(func(module android.Module) {
2125 tag := ctx.OtherModuleDependencyTag(module)
2126 if tag == staticLibTag {
Colin Cross313aa542023-12-13 13:47:44 -08002127 depInfo, _ := android.OtherModuleProvider(ctx, module, JavaInfoProvider)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002128 if depInfo.TransitiveSrcFiles != nil {
2129 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
2130 }
2131 }
2132 })
2133
2134 j.transitiveSrcFiles = android.NewDepSet(android.POSTORDER, mine, fromDeps)
2135}
2136
Jaewoong Jung26342642021-03-17 15:56:23 -07002137func (j *Module) IsInstallable() bool {
2138 return Bool(j.properties.Installable)
2139}
2140
2141type sdkLinkType int
2142
2143const (
2144 // TODO(jiyong) rename these for better readability. Make the allowed
2145 // and disallowed link types explicit
2146 // order is important here. See rank()
2147 javaCore sdkLinkType = iota
2148 javaSdk
2149 javaSystem
2150 javaModule
2151 javaSystemServer
2152 javaPlatform
2153)
2154
2155func (lt sdkLinkType) String() string {
2156 switch lt {
2157 case javaCore:
2158 return "core Java API"
2159 case javaSdk:
2160 return "Android API"
2161 case javaSystem:
2162 return "system API"
2163 case javaModule:
2164 return "module API"
2165 case javaSystemServer:
2166 return "system server API"
2167 case javaPlatform:
2168 return "private API"
2169 default:
2170 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2171 }
2172}
2173
2174// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2175// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2176// can't statically depend on modules that use Platform API.
2177func (lt sdkLinkType) rank() int {
2178 return int(lt)
2179}
2180
2181type moduleWithSdkDep interface {
2182 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002183 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002184}
2185
Jiyong Park92315372021-04-02 08:45:46 +09002186func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002187 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002188 case android.SdkCore.DefaultJavaLibraryName(),
2189 "legacy.core.platform.api.stubs",
2190 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002191 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002192 "core-lambda-stubs",
Jihoon Kangb5078312023-03-29 23:25:49 +00002193 "core-generated-annotation-stubs":
Jaewoong Jung26342642021-03-17 15:56:23 -07002194 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002195 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002196 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002197 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002198 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002199 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002200 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002201 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002202 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002203 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002204 return javaSystem, true
2205 }
2206
2207 if stub, linkType := moduleStubLinkType(name); stub {
2208 return linkType, true
2209 }
2210
Jiyong Park92315372021-04-02 08:45:46 +09002211 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002212 switch ver.Kind {
2213 case android.SdkCore:
Jaewoong Jung26342642021-03-17 15:56:23 -07002214 return javaCore, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09002215 case android.SdkSystem:
Jaewoong Jung26342642021-03-17 15:56:23 -07002216 return javaSystem, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09002217 case android.SdkPublic:
Jaewoong Jung26342642021-03-17 15:56:23 -07002218 return javaSdk, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09002219 case android.SdkModule:
Jaewoong Jung26342642021-03-17 15:56:23 -07002220 return javaModule, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09002221 case android.SdkSystemServer:
Jaewoong Jung26342642021-03-17 15:56:23 -07002222 return javaSystemServer, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09002223 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
Jaewoong Jung26342642021-03-17 15:56:23 -07002224 return javaPlatform, false
2225 }
2226
Jiyong Parkf1691d22021-03-29 20:11:58 +09002227 if !ver.Valid() {
2228 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002229 }
2230 return javaSdk, false
2231}
2232
2233// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2234// this module's. See the comment on rank() for details and an example.
2235func (j *Module) checkSdkLinkType(
2236 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2237 if ctx.Host() {
2238 return
2239 }
2240
Jiyong Park92315372021-04-02 08:45:46 +09002241 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002242 if stubs {
2243 return
2244 }
Jiyong Park92315372021-04-02 08:45:46 +09002245 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002246
2247 if myLinkType.rank() < depLinkType.rank() {
2248 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2249 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2250 "property of the source or target module so that target module is built "+
2251 "with the same or smaller API set when compared to the source.",
2252 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2253 }
2254}
2255
2256func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2257 var deps deps
2258
2259 if ctx.Device() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09002260 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07002261 if sdkDep.invalidVersion {
2262 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2263 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2264 } else if sdkDep.useFiles {
2265 // sdkDep.jar is actually equivalent to turbine header.jar.
2266 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002267 deps.dexClasspath = append(deps.dexClasspath, sdkDep.jars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002268 deps.aidlPreprocess = sdkDep.aidl
2269 } else {
2270 deps.aidlPreprocess = sdkDep.aidl
2271 }
2272 }
2273
Jiyong Park92315372021-04-02 08:45:46 +09002274 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002275
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002276 j.collectTransitiveHeaderJars(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07002277 ctx.VisitDirectDeps(func(module android.Module) {
2278 otherName := ctx.OtherModuleName(module)
2279 tag := ctx.OtherModuleDependencyTag(module)
2280
2281 if IsJniDepTag(tag) {
2282 // Handled by AndroidApp.collectAppDeps
2283 return
2284 }
2285 if tag == certificateTag {
2286 // Handled by AndroidApp.collectAppDeps
2287 return
2288 }
2289
2290 if dep, ok := module.(SdkLibraryDependency); ok {
2291 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002292 case sdkLibTag, libTag:
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002293 depHeaderJars := dep.SdkHeaderJars(ctx, j.SdkVersion(ctx))
2294 deps.classpath = append(deps.classpath, depHeaderJars...)
2295 deps.dexClasspath = append(deps.dexClasspath, depHeaderJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002296 case staticLibTag:
2297 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
2298 }
Colin Cross313aa542023-12-13 13:47:44 -08002299 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2300 if sdkLinkType != javaPlatform {
2301 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2302 // dep is a sysprop implementation library, but this module is not linking against
2303 // the platform, so it gets the sysprop public stubs library instead. Replace
2304 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2305 dep = syspropDep.JavaInfo
2306 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002307 }
2308 switch tag {
2309 case bootClasspathTag:
2310 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002311 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002312 if _, ok := module.(*Plugin); ok {
2313 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2314 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002315 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002316 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002317 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2318 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2319 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2320 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002321 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2322 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2323 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
2324 case java9LibTag:
2325 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
2326 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002327 if _, ok := module.(*Plugin); ok {
2328 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2329 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002330 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2331 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2332 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2333 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2334 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2335 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2336 // Turbine doesn't run annotation processors, so any module that uses an
2337 // annotation processor that generates API is incompatible with the turbine
2338 // optimization.
2339 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002340 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002341 case pluginTag:
2342 if plugin, ok := module.(*Plugin); ok {
2343 if plugin.pluginProperties.Processor_class != nil {
2344 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2345 } else {
2346 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2347 }
2348 // Turbine doesn't run annotation processors, so any module that uses an
2349 // annotation processor that generates API is incompatible with the turbine
2350 // optimization.
2351 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2352 } else {
2353 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2354 }
2355 case errorpronePluginTag:
2356 if _, ok := module.(*Plugin); ok {
2357 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2358 } else {
2359 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2360 }
2361 case exportedPluginTag:
2362 if plugin, ok := module.(*Plugin); ok {
2363 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2364 if plugin.pluginProperties.Processor_class != nil {
2365 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2366 }
2367 // Turbine doesn't run annotation processors, so any module that uses an
2368 // annotation processor that generates API is incompatible with the turbine
2369 // optimization.
2370 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2371 } else {
2372 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2373 }
2374 case kotlinStdlibTag:
2375 deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars...)
2376 case kotlinAnnotationsTag:
2377 deps.kotlinAnnotations = dep.HeaderJars
Colin Crossa1ff7c62021-09-17 14:11:52 -07002378 case kotlinPluginTag:
2379 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002380 case syspropPublicStubDepTag:
2381 // This is a sysprop implementation library, forward the JavaInfoProvider from
2382 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002383 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002384 JavaInfo: dep,
2385 })
2386 }
2387 } else if dep, ok := module.(android.SourceFileProducer); ok {
2388 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002389 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002390 checkProducesJars(ctx, dep)
2391 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002392 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002393 case staticLibTag:
2394 checkProducesJars(ctx, dep)
2395 deps.classpath = append(deps.classpath, dep.Srcs()...)
2396 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2397 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
2398 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002399 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002400 switch tag {
2401 case staticLibTag:
2402 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2403 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002404 } else {
2405 switch tag {
2406 case bootClasspathTag:
2407 // If a system modules dependency has been added to the bootclasspath
2408 // then add its libs to the bootclasspath.
2409 sm := module.(SystemModulesProvider)
2410 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars()...)
2411
2412 case systemModulesTag:
2413 if deps.systemModules != nil {
2414 panic("Found two system module dependencies")
2415 }
2416 sm := module.(SystemModulesProvider)
2417 outputDir, outputDeps := sm.OutputDirAndDeps()
2418 deps.systemModules = &systemModules{outputDir, outputDeps}
Paul Duffin53a70a42022-01-11 14:35:55 +00002419
2420 case instrumentationForTag:
2421 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 -07002422 }
2423 }
2424
2425 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002426 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002427 })
2428
2429 return deps
2430}
2431
Joe Onorato349ae8d2024-02-05 22:46:00 +00002432// Provider for jarjar renaming rules.
2433//
2434// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2435// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2436// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2437// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2438// be renamed from that module.
2439// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002440type DependencyUse int
2441
2442const (
2443 RenameUseInvalid DependencyUse = iota
2444 RenameUseInclude
2445 RenameUseExclude
2446)
2447
2448type RenameUseElement struct {
2449 DepName string
2450 RenameUse DependencyUse
2451 Why string // token for determining where in the logic the decision was made.
2452}
2453
Joe Onorato349ae8d2024-02-05 22:46:00 +00002454type JarJarProviderData struct {
2455 // Mapping of class names: original --> renamed. If the value is "", the class will be
2456 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2457 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002458 Rename map[string]string
2459 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002460}
2461
2462func (this JarJarProviderData) GetDebugString() string {
2463 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002464 for _, k := range android.SortedKeys(this.Rename) {
2465 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002466 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2467 result += k + "--&gt;" + v + ";"
2468 }
2469 }
2470 return result
2471}
2472
2473var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2474
2475var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2476
2477func init() {
2478 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
2479}
2480
2481// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2482// whether they are java modules or not.
2483type BaseJarJarProviderData struct {
2484 JarJarProviderData JarJarProviderData
2485}
2486
2487func (this BaseJarJarProviderData) GetDebugString() string {
2488 return this.JarJarProviderData.GetDebugString()
2489}
2490
2491var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2492
2493// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2494// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2495// either JarJarProvider or BaseJarJarProvider.
2496func mergeJarJarPrefixes(ctx android.ModuleContext) {
2497 mod := ctx.Module()
2498 // Explicitly avoid propagating into some module types.
2499 switch reflect.TypeOf(mod).String() {
2500 case "*java.Droidstubs":
2501 return
2502 }
2503 jarJarData := collectDirectDepsProviders(ctx)
2504 if jarJarData != nil {
2505 providerData := BaseJarJarProviderData{
2506 JarJarProviderData: *jarJarData,
2507 }
2508 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2509 }
2510
2511}
2512
2513// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2514func (module *Module) addJarJarRenameRule(original string, renamed string) {
2515 if module.jarjarRenameRules == nil {
2516 module.jarjarRenameRules = make(map[string]string)
2517 }
2518 module.jarjarRenameRules[original] = renamed
2519}
2520
2521func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2522 // Gather repackage information from deps
2523 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002524
2525 module := ctx.Module()
2526 moduleName := module.Name()
2527
Joe Onorato349ae8d2024-02-05 22:46:00 +00002528 ctx.VisitDirectDepsIgnoreBlueprint(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002529 tag := ctx.OtherModuleDependencyTag(m)
2530 // This logic mirrors that in (*Module).collectDeps above. There are several places
2531 // where we explicitly return RenameUseExclude, even though it is the default, to
2532 // indicate that it has been verified to be the case.
2533 //
2534 // Note well: there are probably cases that are getting to the unconditional return
2535 // and are therefore wrong.
2536 shouldIncludeRenames := func() (DependencyUse, string) {
2537 if moduleName == m.Name() {
2538 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2539 }
2540 if sc, ok := module.(android.SdkContext); ok {
2541 if ctx.Device() {
2542 sdkDep := decodeSdkDep(ctx, sc)
2543 if !sdkDep.invalidVersion && sdkDep.useFiles {
2544 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002545 }
2546 }
LaMont Jones63683e42024-02-08 14:30:45 -08002547 }
2548 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2549 return RenameUseExclude, "tags"
2550 }
2551 if _, ok := m.(SdkLibraryDependency); ok {
2552 switch tag {
2553 case sdkLibTag, libTag:
2554 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2555 }
2556 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2557 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2558 switch ji.StubsLinkType {
2559 case Stubs:
2560 return RenameUseExclude, "info"
2561 case Implementation:
2562 return RenameUseInclude, "info"
2563 default:
LaMont Jones09721862024-06-11 10:30:50 -07002564 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002565 // Fall through to the heuristic logic.
2566 }
2567 switch reflect.TypeOf(m).String() {
2568 case "*java.GeneratedJavaLibraryModule":
2569 // Probably a java_aconfig_library module.
2570 // TODO: make this check better.
2571 return RenameUseInclude, "reflect"
2572 }
2573 switch tag {
2574 case bootClasspathTag:
2575 return RenameUseExclude, "tagswitch"
2576 case sdkLibTag, libTag, instrumentationForTag:
2577 return RenameUseInclude, "tagswitch"
2578 case java9LibTag:
2579 return RenameUseExclude, "tagswitch"
2580 case staticLibTag:
2581 return RenameUseInclude, "tagswitch"
2582 case pluginTag:
2583 return RenameUseInclude, "tagswitch"
2584 case errorpronePluginTag:
2585 return RenameUseInclude, "tagswitch"
2586 case exportedPluginTag:
2587 return RenameUseInclude, "tagswitch"
2588 case kotlinStdlibTag, kotlinAnnotationsTag:
2589 return RenameUseExclude, "tagswitch"
2590 case kotlinPluginTag:
2591 return RenameUseInclude, "tagswitch"
2592 default:
2593 return RenameUseExclude, "tagswitch"
2594 }
2595 } else if _, ok := m.(android.SourceFileProducer); ok {
2596 switch tag {
2597 case sdkLibTag, libTag, staticLibTag:
2598 return RenameUseInclude, "srcfile"
2599 default:
2600 return RenameUseExclude, "srcfile"
2601 }
Yu Liu67a28422024-03-05 00:36:31 +00002602 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002603 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002604 } else {
2605 switch tag {
2606 case bootClasspathTag:
2607 return RenameUseExclude, "else"
2608 case systemModulesTag:
2609 return RenameUseInclude, "else"
2610 }
2611 }
2612 // If we got here, choose the safer option, which may lead to a build failure, rather
2613 // than runtime failures on the device.
2614 return RenameUseExclude, "end"
2615 }
2616
2617 if result == nil {
2618 result = &JarJarProviderData{
2619 Rename: make(map[string]string),
2620 RenameUse: make([]RenameUseElement, 0),
2621 }
2622 }
2623 how, why := shouldIncludeRenames()
2624 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2625 if how != RenameUseInclude {
2626 // Nothing to merge.
2627 return
2628 }
2629
2630 merge := func(theirs *JarJarProviderData) {
2631 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002632 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2633 result.Rename[orig] = renamed
2634 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2635 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2636 result.Rename[orig] = renamed
2637 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2638 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2639 continue
2640 }
2641 }
2642 }
2643 }
2644 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2645 merge(&theirs)
2646 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2647 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2648 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2649 // to java.Module.
2650 merge(&theirs.JarJarProviderData)
2651 }
2652 })
2653 return
2654}
2655
2656func (this Module) GetDebugString() string {
2657 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2658}
2659
2660// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2661// us, and if it's been set, apply the jarjar_prefix property to rename them.
2662func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2663 // Gather repackage information from deps
2664 result := collectDirectDepsProviders(ctx)
2665
2666 // Update that with entries we've stored for ourself
2667 for orig, renamed := range module.jarjarRenameRules {
2668 if result == nil {
2669 result = &JarJarProviderData{
2670 Rename: make(map[string]string),
2671 }
2672 }
2673 if renamed != "" {
2674 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2675 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
2676 continue
2677 }
2678 }
2679 (*result).Rename[orig] = renamed
2680 }
2681
2682 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2683 if result == nil {
2684 return nil
2685 }
2686
2687 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2688 // that have not yet been renamed.
2689 prefix := proptools.String(module.properties.Jarjar_prefix)
2690 if prefix != "" {
2691 if prefix[0] == '.' {
2692 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2693 return nil
2694 }
2695 if prefix[len(prefix)-1] == '.' {
2696 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2697 return nil
2698 }
2699
2700 var updated map[string]string
2701 for orig, renamed := range (*result).Rename {
2702 if renamed == "" {
2703 if updated == nil {
2704 updated = make(map[string]string)
2705 }
2706 updated[orig] = prefix + "." + orig
2707 }
2708 }
2709 for orig, renamed := range updated {
2710 (*result).Rename[orig] = renamed
2711 }
2712 }
2713
2714 return result
2715}
2716
2717// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2718// to "" won't be in this list because they shouldn't be renamed yet.
2719func getJarJarRuleText(provider *JarJarProviderData) string {
2720 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002721 for _, orig := range android.SortedKeys(provider.Rename) {
2722 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002723 if renamed != "" {
2724 result += "rule " + orig + " " + renamed + "\n"
2725 }
2726 }
2727 return result
2728}
2729
Zi Wangddb2ee52024-04-02 16:44:02 +00002730// Repackage the flags if the jarjar rule txt for the flags is generated
2731func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.WritablePath, jarName, info string) android.WritablePath {
2732 if j.repackageJarjarRules == nil {
2733 return infile
2734 }
2735 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info+jarName)
2736 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
2737 return repackagedJarjarFile
2738}
2739
Jaewoong Jung26342642021-03-17 15:56:23 -07002740func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2741 deps.processorPath = append(deps.processorPath, pluginJars...)
2742 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2743}
2744
2745// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2746// this interface.
2747type ProvidesUsesLib interface {
2748 ProvidesUsesLib() *string
2749}
2750
2751func (j *Module) ProvidesUsesLib() *string {
2752 return j.usesLibraryProperties.Provides_uses_lib
2753}
satayev1c564cc2021-05-25 19:50:30 +01002754
2755type ModuleWithStem interface {
2756 Stem() string
2757}
2758
2759var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002760
2761type ModuleWithUsesLibrary interface {
2762 UsesLibrary() *usesLibrary
2763}
2764
2765func (j *Module) UsesLibrary() *usesLibrary {
2766 return &j.usesLibrary
2767}
2768
2769var _ ModuleWithUsesLibrary = (*Module)(nil)