blob: 019a65fd8979619ce90c40d29e9dbd41d71855d3 [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
Jaewoong Jung26342642021-03-17 15:56:23 -070097 // If not blank, set the java version passed to javac as -source and -target
98 Java_version *string
99
100 // If set to true, allow this module to be dexed and installed on devices. Has no
101 // effect on host modules, which are always considered installable.
102 Installable *bool
103
104 // If set to true, include sources used to compile the module in to the final jar
105 Include_srcs *bool
106
107 // If not empty, classes are restricted to the specified packages and their sub-packages.
108 // This restriction is checked after applying jarjar rules and including static libs.
109 Permitted_packages []string
110
111 // List of modules to use as annotation processors
112 Plugins []string
113
Luca Stefani41029752024-10-12 17:55:31 +0200114 // List of modules to use as kotlin plugin
115 Kotlin_plugins []string
116
Jaewoong Jung26342642021-03-17 15:56:23 -0700117 // 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
Jiyong Park92315372021-04-02 08:45:46 +0900555func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
556 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900557 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700558 return nil
559 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900560 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000561 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700562 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
563 } else {
564 // Treat stable core platform as stable.
565 return nil
566 }
567 } else {
568 return fmt.Errorf("non stable SDK %v", sdkVersion)
569 }
570}
571
572// checkSdkVersions enforces restrictions around SDK dependencies.
573func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
574 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900575 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900576 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700577 ctx.PropertyErrorf("sdk_version",
578 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
579 }
580 }
581 }
582
583 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
584 // See rank() for details.
585 ctx.VisitDirectDeps(func(module android.Module) {
586 tag := ctx.OtherModuleDependencyTag(module)
587 switch module.(type) {
588 // TODO(satayev): cover other types as well, e.g. imports
589 case *Library, *AndroidLibrary:
590 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400591 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700592 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
593 }
594 }
595 })
596}
597
598func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900599 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700600 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900601 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700602 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000603 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 -0700604 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000605 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 -0700606 }
607
608 }
609}
610
Mark Whitea15790a2023-08-22 21:28:11 +0000611func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
612 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400613 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000614 installable := proptools.Bool(j.properties.Installable)
615
616 if headersOnly && installable {
617 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.")
618 }
619 }
620}
621
Jaewoong Jung26342642021-03-17 15:56:23 -0700622func (j *Module) addHostProperties() {
623 j.AddProperties(
624 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000625 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700626 &j.protoProperties,
627 &j.usesLibraryProperties,
628 )
629}
630
631func (j *Module) addHostAndDeviceProperties() {
632 j.addHostProperties()
633 j.AddProperties(
634 &j.deviceProperties,
635 &j.dexer.dexProperties,
636 &j.dexpreoptProperties,
637 &j.linter.properties,
638 )
639}
640
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000641// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
642// makes it available through the hiddenAPIPropertyInfoProvider.
643func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
644 hiddenAPIInfo := newHiddenAPIPropertyInfo()
645
646 // Populate with flag file paths from the properties.
647 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
648
649 // Populate with package rules from the properties.
650 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
651
Colin Cross40213022023-12-13 15:19:49 -0800652 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000653}
654
Jaewoong Jung26342642021-03-17 15:56:23 -0700655func (j *Module) OutputFiles(tag string) (android.Paths, error) {
656 switch tag {
657 case "":
658 return append(android.Paths{j.outputFile}, j.extraOutputFiles...), nil
659 case android.DefaultDistTag:
660 return android.Paths{j.outputFile}, nil
661 case ".jar":
662 return android.Paths{j.implementationAndResourcesJar}, nil
Colin Crossab50dea2022-10-14 11:45:44 -0700663 case ".hjar":
664 return android.Paths{j.headerJarFile}, nil
Jaewoong Jung26342642021-03-17 15:56:23 -0700665 case ".proguard_map":
666 if j.dexer.proguardDictionary.Valid() {
667 return android.Paths{j.dexer.proguardDictionary.Path()}, nil
668 }
669 return nil, fmt.Errorf("%q was requested, but no output file was found.", tag)
Joe Onoratoffac9be2023-08-19 19:48:34 -0700670 case ".generated_srcjars":
671 return j.properties.Generated_srcjars, nil
Thiébaud Weksteend0544362023-09-29 10:26:43 +1000672 case ".lint":
673 if j.linter.outputs.xml != nil {
674 return android.Paths{j.linter.outputs.xml}, nil
675 }
676 return nil, fmt.Errorf("%q was requested, but no output file was found.", tag)
Jaewoong Jung26342642021-03-17 15:56:23 -0700677 default:
678 return nil, fmt.Errorf("unsupported module reference tag %q", tag)
679 }
680}
681
682var _ android.OutputFileProducer = (*Module)(nil)
683
684func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
685 initJavaModule(module, hod, false)
686}
687
688func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
689 initJavaModule(module, hod, true)
690}
691
692func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
693 multilib := android.MultilibCommon
694 if multiTargets {
695 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
696 } else {
697 android.InitAndroidArchModule(module, hod, multilib)
698 }
699 android.InitDefaultableModule(module)
700}
701
702func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
703 return j.properties.Instrument &&
704 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
705 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
706}
707
708func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000709 return j.properties.Supports_static_instrumentation &&
710 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700711 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
712 ctx.Config().UnbundledBuild())
713}
714
715func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
716 // Force enable the instrumentation for java code that is built for APEXes ...
717 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
718 // 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 -0800719 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700720 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000721
Jihoon Kang46d66de2024-05-22 22:42:39 +0000722 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700723 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
724 return true
725 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
726 return true
727 }
728 }
729 return false
730}
731
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400732func (j *Module) setInstrument(value bool) {
733 j.properties.Instrument = value
734}
735
Jiyong Park92315372021-04-02 08:45:46 +0900736func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
737 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700738}
739
Jiyong Parkf1691d22021-03-29 20:11:58 +0900740func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700741 return proptools.String(j.deviceProperties.System_modules)
742}
743
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000744func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000745 if j.overridableProperties.Min_sdk_version != nil {
746 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700747 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000748 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700749}
750
Yu Liuf2b94012023-09-19 15:09:10 -0700751func (j *Module) GetDeviceProperties() *DeviceProperties {
752 return &j.deviceProperties
753}
754
Spandan Dasa26eda72023-03-02 00:56:06 +0000755func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
756 if j.deviceProperties.Max_sdk_version != nil {
757 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
758 }
759 // Default is PrivateApiLevel
760 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000761}
762
Spandan Dasa26eda72023-03-02 00:56:06 +0000763func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
764 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
765 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
766 }
767 // Default is PrivateApiLevel
768 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000769}
770
Jiyong Parkf1691d22021-03-29 20:11:58 +0900771func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000772 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900773}
774
Spandan Dasca70fc42023-03-01 23:38:49 +0000775func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900776 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000777 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900778 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000779 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700780}
781
782func (j *Module) AvailableFor(what string) bool {
783 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
784 // Exception: for hostdex: true libraries, the platform variant is created
785 // even if it's not marked as available to platform. In that case, the platform
786 // variant is used only for the hostdex and not installed to the device.
787 return true
788 }
789 return j.ApexModuleBase.AvailableFor(what)
790}
791
792func (j *Module) deps(ctx android.BottomUpMutatorContext) {
793 if ctx.Device() {
794 j.linter.deps(ctx)
795
Jiyong Parkf1691d22021-03-29 20:11:58 +0900796 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700797
798 if j.deviceProperties.SyspropPublicStub != "" {
799 // This is a sysprop implementation library that has a corresponding sysprop public
800 // stubs library, and a dependency on it so that dependencies on the implementation can
801 // be forwarded to the public stubs library when necessary.
802 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
803 }
804 }
805
806 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000807
808 j.properties.Static_libs = android.RemoveListFromList(j.properties.Static_libs, j.properties.Exclude_static_libs)
Jaewoong Jung26342642021-03-17 15:56:23 -0700809 ctx.AddVariationDependencies(nil, staticLibTag, j.properties.Static_libs...)
810
811 // Add dependency on libraries that provide additional hidden api annotations.
812 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
813
Kiyoung Kim9743bab2024-03-28 15:44:56 +0900814 if ctx.Config().EnforceInterPartitionJavaSdkLibrary() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700815 // Require java_sdk_library at inter-partition java dependency to ensure stable
816 // interface between partitions. If inter-partition java_library dependency is detected,
817 // raise build error because java_library doesn't have a stable interface.
818 //
819 // Inputs:
820 // PRODUCT_ENFORCE_INTER_PARTITION_JAVA_SDK_LIBRARY
821 // if true, enable enforcement
822 // PRODUCT_INTER_PARTITION_JAVA_LIBRARY_ALLOWLIST
823 // exception list of java_library names to allow inter-partition dependency
824 for idx := range j.properties.Libs {
825 if libDeps[idx] == nil {
826 continue
827 }
828
829 if javaDep, ok := libDeps[idx].(javaSdkLibraryEnforceContext); ok {
830 // java_sdk_library is always allowed at inter-partition dependency.
831 // So, skip check.
832 if _, ok := javaDep.(*SdkLibrary); ok {
833 continue
834 }
835
836 j.checkPartitionsForJavaDependency(ctx, "libs", javaDep)
837 }
838 }
839 }
840
841 // For library dependencies that are component libraries (like stubs), add the implementation
842 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
843 for _, dep := range libDeps {
844 if dep != nil {
845 if component, ok := dep.(SdkLibraryComponentDependency); ok {
846 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000847 // Add library as optional if it's one of the optional compatibility libs or it's
848 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100849 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000850 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
851 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100852 tag = usesLibOptTag
853 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100854 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700855 }
856 }
857 }
858 }
859
860 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
Luca Stefani41029752024-10-12 17:55:31 +0200861 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag, j.properties.Kotlin_plugins...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700862 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
863 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
864
865 android.ProtoDeps(ctx, &j.protoProperties)
866 if j.hasSrcExt(".proto") {
867 protoDeps(ctx, &j.protoProperties)
868 }
869
870 if j.hasSrcExt(".kt") {
871 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
872 // Kotlin files
873 ctx.AddVariationDependencies(nil, kotlinStdlibTag,
874 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8")
Colin Cross06354472022-05-03 14:20:24 -0700875 ctx.AddVariationDependencies(nil, kotlinAnnotationsTag, "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700876 }
877
878 // Framework libraries need special handling in static coverage builds: they should not have
879 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
880 // the same jacoco classes coming from different bootclasspath jars.
881 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
882 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
883 j.properties.Instrument = true
884 }
885 } else if j.shouldInstrumentStatic(ctx) {
886 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
887 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700888
889 if j.useCompose() {
890 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
Luca Stefani41029752024-10-12 17:55:31 +0200891 "androidx.compose.compiler_compiler-hosted-plugin")
Colin Crossa1ff7c62021-09-17 14:11:52 -0700892 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700893}
894
895func hasSrcExt(srcs []string, ext string) bool {
896 for _, src := range srcs {
897 if filepath.Ext(src) == ext {
898 return true
899 }
900 }
901
902 return false
903}
904
905func (j *Module) hasSrcExt(ext string) bool {
906 return hasSrcExt(j.properties.Srcs, ext)
907}
908
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100909func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
910 var flags string
911
912 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
913 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
914 flags = "-Wmissing-permission-annotation -Werror"
915 }
916 }
917 return flags
918}
919
Jaewoong Jung26342642021-03-17 15:56:23 -0700920func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000921 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700922
923 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
924 aidlIncludes = append(aidlIncludes,
925 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
926 aidlIncludes = append(aidlIncludes,
927 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
928
929 var flags []string
930 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000931 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700932
933 flags = append(flags, j.deviceProperties.Aidl.Flags...)
934
935 if aidlPreprocess.Valid() {
936 flags = append(flags, "-p"+aidlPreprocess.String())
937 deps = append(deps, aidlPreprocess.Path())
938 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000939 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700940 }
941
942 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000943 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700944 }
945
946 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000947 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700948 }
949
Sam Delmerico2351eac2022-05-24 17:10:02 +0000950 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700951 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000952 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700953 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000954 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
955 // add flags for dirs containing AIDL srcs that haven't been specified yet
956 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -0700957
Zim8774ae12022-08-17 11:46:34 +0100958 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +0000959 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +0100960 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700961 flags = append(flags, "-t")
962 }
963
964 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
965 flags = append(flags, "--transaction_names")
966 }
967
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100968 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
969 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
970 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
971 }
972
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000973 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +0900974 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
975
Jaewoong Jung26342642021-03-17 15:56:23 -0700976 return strings.Join(flags, " "), deps
977}
978
979func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
980
981 var flags javaBuilderFlags
982
983 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +0900984 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -0700985
Cole Faust2b1536e2021-06-18 12:25:54 -0700986 epEnabled := j.properties.Errorprone.Enabled
987 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +0100988 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700989 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
990 }
991
992 errorProneFlags := []string{
993 "-Xplugin:ErrorProne",
994 "${config.ErrorProneChecks}",
995 }
996 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
997
Colin Cross8bf6cad2022-02-28 13:07:03 -0800998 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -0700999 "'" + strings.Join(errorProneFlags, " ") + "'"
1000 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1001 }
1002
1003 // classpath
1004 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1005 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001006 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001007 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1008 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1009 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1010
1011 flags.processors = append(flags.processors, deps.processorClasses...)
1012 flags.processors = android.FirstUniqueStrings(flags.processors)
1013
1014 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001015 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001016 // Give host-side tools a version of OpenJDK's standard libraries
1017 // close to what they're targeting. As of Dec 2017, AOSP is only
1018 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1019 //
1020 // When building with OpenJDK 8, the following should have no
1021 // effect since those jars would be available by default.
1022 //
1023 // When building with OpenJDK 9 but targeting a version < 1.8,
1024 // putting them on the bootclasspath means that:
1025 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1026 // b) references to existing APIs are not reinterpreted in an
1027 // OpenJDK 9-specific way, eg. calls to subclasses of
1028 // java.nio.Buffer as in http://b/70862583
1029 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1030 flags.bootClasspath = append(flags.bootClasspath,
1031 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1032 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1033 if Bool(j.properties.Use_tools_jar) {
1034 flags.bootClasspath = append(flags.bootClasspath,
1035 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1036 }
1037 }
1038
1039 // systemModules
1040 flags.systemModules = deps.systemModules
1041
Jaewoong Jung26342642021-03-17 15:56:23 -07001042 return flags
1043}
1044
1045func (j *Module) collectJavacFlags(
1046 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1047 // javac flags.
1048 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001049 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001050
Mythri Alle4b9f6182023-10-25 15:17:11 +00001051 needsDebugInfo = false
1052 for _, flag := range javacFlags {
1053 if strings.HasPrefix(flag, "-g") {
1054 needsDebugInfo = true
1055 }
1056 }
1057
1058 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001059 // For non-host binaries, override the -g flag passed globally to remove
1060 // local variable debug info to reduce disk and memory usage.
1061 javacFlags = append(javacFlags, "-g:source,lines")
1062 }
1063 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1064
1065 if flags.javaVersion.usesJavaModules() {
1066 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001067 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1068 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1069 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1070 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001071
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001072 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001073 if j.properties.Patch_module != nil {
1074 // Manually specify build directory in case it is not under the repo root.
1075 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1076 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001077 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001078
Jaewoong Jung26342642021-03-17 15:56:23 -07001079 classPath := flags.classpath.FormJavaClassPath("")
1080 if classPath != "" {
1081 patchPaths = append(patchPaths, classPath)
1082 }
1083 javacFlags = append(
1084 javacFlags,
1085 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1086 }
1087 }
1088
1089 if len(javacFlags) > 0 {
1090 // optimization.
1091 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1092 flags.javacFlags = "$javacFlags"
1093 }
1094
1095 return flags
1096}
1097
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001098func (j *Module) AddJSONData(d *map[string]interface{}) {
1099 (&j.ModuleBase).AddJSONData(d)
1100 (*d)["Java"] = map[string]interface{}{
1101 "SourceExtensions": j.sourceExtensions,
1102 }
1103
1104}
1105
usta0391ca42023-09-19 15:51:59 -04001106func (j *Module) addGeneratedSrcJars(path android.Path) {
1107 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001108}
1109
Colin Cross4eae06d2023-06-20 22:40:02 -07001110func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001111
1112 // Auto-propagating jarjar rules
1113 jarjarProviderData := j.collectJarJarRules(ctx)
1114 if jarjarProviderData != nil {
1115 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wangddb2ee52024-04-02 16:44:02 +00001116 text := getJarJarRuleText(jarjarProviderData)
1117 if text != "" {
1118 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1119 android.WriteFileRule(ctx, ruleTextFile, text)
1120 j.repackageJarjarRules = ruleTextFile
Joe Onorato349ae8d2024-02-05 22:46:00 +00001121 }
1122 }
1123
Jaewoong Jung26342642021-03-17 15:56:23 -07001124 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1125
1126 deps := j.collectDeps(ctx)
1127 flags := j.collectBuilderFlags(ctx, deps)
1128
1129 if flags.javaVersion.usesJavaModules() {
1130 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001131 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1132 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1133 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001134 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001135
Jaewoong Jung26342642021-03-17 15:56:23 -07001136 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001137 j.sourceExtensions = []string{}
1138 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1139 if hasSrcExt(srcFiles.Strings(), ext) {
1140 j.sourceExtensions = append(j.sourceExtensions, ext)
1141 }
1142 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001143 if hasSrcExt(srcFiles.Strings(), ".proto") {
1144 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1145 }
1146
1147 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1148 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1149 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1150 }
1151
Sam Delmerico2351eac2022-05-24 17:10:02 +00001152 aidlSrcs := srcFiles.FilterByExt(".aidl")
1153 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1154
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001155 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001156 srcFiles = j.genSources(ctx, srcFiles, flags)
1157
1158 // Collect javac flags only after computing the full set of srcFiles to
1159 // ensure that the --patch-module lookup paths are complete.
1160 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1161
1162 srcJars := srcFiles.FilterByExt(".srcjar")
1163 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001164 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001165 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001166 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001167
1168 if j.properties.Jarjar_rules != nil {
1169 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1170 }
1171
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001172 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001173
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001174 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001175 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001176 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001177 if _, found := set[v.String()]; !found {
1178 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001179 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001180 }
1181 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001182 var uniqueKtFiles android.Paths
1183 for _, v := range srcFiles.FilterByExt(".kt") {
1184 if _, found := set[v.String()]; !found {
1185 set[v.String()] = true
1186 uniqueKtFiles = append(uniqueKtFiles, v)
1187 }
1188 }
1189
1190 var uniqueSrcFiles android.Paths
1191 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1192 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1193 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001194 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001195
Colin Crossb5db4012022-03-28 17:12:39 -07001196 // We don't currently run annotation processors in turbine, which means we can't use turbine
1197 // generated header jars when an annotation processor that generates API is enabled. One
1198 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1199 // is used to run all of the annotation processors.
1200 disableTurbine := deps.disableTurbine
1201
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001202 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001203 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1204
1205 var kotlinJars android.Paths
Colin Cross220a9a12022-03-28 17:08:01 -07001206 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001207
Colin Cross4eae06d2023-06-20 22:40:02 -07001208 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1209 // any dependencies so that it can override any non-final R classes from dependencies with the
1210 // final R classes from the app.
1211 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1212
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001213 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1214
Mark Whitea15790a2023-08-22 21:28:11 +00001215 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001216 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001217 if srcFiles.HasExt(".kt") {
1218 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1219 }
1220 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1221 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1222 }
1223
Joe Onorato349ae8d2024-02-05 22:46:00 +00001224 _, j.headerJarFile, _ =
Mark Whitea15790a2023-08-22 21:28:11 +00001225 j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
1226 extraCombinedJars)
1227 if ctx.Failed() {
1228 return
1229 }
1230
Colin Cross40213022023-12-13 15:19:49 -08001231 android.SetProvider(ctx, JavaInfoProvider, JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001232 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1233 TransitiveLibsHeaderJars: j.transitiveLibsHeaderJars,
1234 TransitiveStaticLibsHeaderJars: j.transitiveStaticLibsHeaderJars,
1235 AidlIncludeDirs: j.exportAidlIncludeDirs,
1236 ExportedPlugins: j.exportedPluginJars,
1237 ExportedPluginClasses: j.exportedPluginClasses,
1238 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1239 StubsLinkType: j.stubsLinkType,
1240 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001241 })
1242
1243 j.outputFile = j.headerJarFile
1244 return
1245 }
1246
Jaewoong Jung26342642021-03-17 15:56:23 -07001247 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001248 // When using kotlin sources turbine is used to generate annotation processor sources,
1249 // including for annotation processors that generate API, so we can use turbine for
1250 // java sources too.
1251 disableTurbine = false
1252
Jaewoong Jung26342642021-03-17 15:56:23 -07001253 // user defined kotlin flags.
1254 kotlincFlags := j.properties.Kotlincflags
1255 CheckKotlincFlags(ctx, kotlincFlags)
1256
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001257 // Workaround for KT-46512
1258 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001259
1260 // If there are kotlin files, compile them first but pass all the kotlin and java files
1261 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1262 // won't emit any classes for them.
1263 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1264 if ctx.Device() {
1265 kotlincFlags = append(kotlincFlags, "-no-jdk")
1266 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001267
1268 for _, plugin := range deps.kotlinPlugins {
1269 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1270 }
1271 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1272
Jaewoong Jung26342642021-03-17 15:56:23 -07001273 if len(kotlincFlags) > 0 {
1274 // optimization.
1275 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1276 flags.kotlincFlags += "$kotlincFlags"
1277 }
1278
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001279 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001280 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1281
1282 flags.classpath = append(flags.classpath, deps.kotlinStdlib...)
1283 flags.classpath = append(flags.classpath, deps.kotlinAnnotations...)
1284
1285 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1286 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1287
Isaac Chioua23d9942022-04-06 06:14:38 +00001288 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001289 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001290 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1291 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001292 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001293 srcJars = append(srcJars, kaptSrcJar)
1294 kotlinJars = append(kotlinJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001295 // Disable annotation processing in javac, it's already been handled by kapt
1296 flags.processorPath = nil
1297 flags.processors = nil
1298 }
1299
1300 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001301 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001302 kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001303 if ctx.Failed() {
1304 return
1305 }
1306
Zi Wangddb2ee52024-04-02 16:44:02 +00001307 kotlinJarPath := j.repackageFlagsIfNecessary(ctx, kotlinJar.OutputPath, jarName, "kotlinc")
1308
Isaac Chioua23d9942022-04-06 06:14:38 +00001309 // Make javac rule depend on the kotlinc rule
1310 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1311
Zi Wangddb2ee52024-04-02 16:44:02 +00001312 kotlinJars = append(kotlinJars, kotlinJarPath)
Colin Cross220a9a12022-03-28 17:08:01 -07001313 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
1314
Jaewoong Jung26342642021-03-17 15:56:23 -07001315 // Jar kotlin classes into the final jar after javac
1316 if BoolDefault(j.properties.Static_kotlin_stdlib, true) {
1317 kotlinJars = append(kotlinJars, deps.kotlinStdlib...)
Colin Cross06354472022-05-03 14:20:24 -07001318 kotlinJars = append(kotlinJars, deps.kotlinAnnotations...)
Colin Cross220a9a12022-03-28 17:08:01 -07001319 kotlinHeaderJars = append(kotlinHeaderJars, deps.kotlinStdlib...)
Colin Cross06354472022-05-03 14:20:24 -07001320 kotlinHeaderJars = append(kotlinHeaderJars, deps.kotlinAnnotations...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001321 } else {
1322 flags.dexClasspath = append(flags.dexClasspath, deps.kotlinStdlib...)
Colin Cross06354472022-05-03 14:20:24 -07001323 flags.dexClasspath = append(flags.dexClasspath, deps.kotlinAnnotations...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001324 }
1325 }
1326
Colin Crossfd620b22024-02-23 10:05:21 -08001327 jars := slices.Clone(kotlinJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001328
Jaewoong Jung26342642021-03-17 15:56:23 -07001329 j.compiledSrcJars = srcJars
1330
1331 enableSharding := false
Colin Cross3d56ed52021-11-18 22:23:12 -08001332 var headerJarFileWithoutDepsOrJarjar android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001333 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001334 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1335 enableSharding = true
1336 // Formerly, there was a check here that prevented annotation processors
1337 // from being used when sharding was enabled, as some annotation processors
1338 // do not function correctly in sharded environments. It was removed to
1339 // allow for the use of annotation processors that do function correctly
1340 // with sharding enabled. See: b/77284273.
1341 }
Colin Crossfd620b22024-02-23 10:05:21 -08001342 extraJars := append(slices.Clone(kotlinHeaderJars), extraCombinedJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00001343 headerJarFileWithoutDepsOrJarjar, j.headerJarFile, j.repackagedHeaderJarFile =
Colin Cross4eae06d2023-06-20 22:40:02 -07001344 j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001345 if ctx.Failed() {
1346 return
1347 }
1348 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001349 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001350 hasErrorproneableFiles := false
1351 for _, ext := range j.sourceExtensions {
1352 if ext != ".proto" && ext != ".aidl" {
1353 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1354 // compile, and it's not useful to have warnings on these generated sources.
1355 hasErrorproneableFiles = true
1356 break
1357 }
1358 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001359 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001360 if Bool(j.properties.Errorprone.Enabled) {
1361 // If error-prone is enabled, enable errorprone flags on the regular
1362 // build.
1363 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001364 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001365 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1366 // a new jar file just for compiling with the errorprone compiler to.
1367 // This is because we don't want to cause the java files to get completely
1368 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1369 // We also don't want to run this if errorprone is enabled by default for
1370 // this module, or else we could have duplicated errorprone messages.
1371 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001372 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001373 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001374
Vadim Spivak3c496f02023-06-08 06:14:59 +00001375 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001376 "errorprone", "errorprone")
1377
Jaewoong Jung26342642021-03-17 15:56:23 -07001378 extraJarDeps = append(extraJarDeps, errorprone)
1379 }
1380
1381 if enableSharding {
Colin Cross3d56ed52021-11-18 22:23:12 -08001382 if headerJarFileWithoutDepsOrJarjar != nil {
1383 flags.classpath = append(classpath{headerJarFileWithoutDepsOrJarjar}, flags.classpath...)
1384 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001385 shardSize := int(*(j.properties.Javac_shard_size))
1386 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001387 if len(uniqueJavaFiles) > 0 {
1388 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001389 for idx, shardSrc := range shardSrcs {
1390 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1391 nil, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001392 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
Jaewoong Jung26342642021-03-17 15:56:23 -07001393 jars = append(jars, classes)
1394 }
1395 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001396 // Assume approximately 5 sources per srcjar.
1397 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1398 // 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 -07001399 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001400 startIdx := len(shardSrcs)
1401 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1402 for idx, shardSrcJars := range shardSrcJarsList {
1403 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1404 nil, shardSrcJars, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001405 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
Colin Crossa052ddb2023-09-25 21:46:58 -07001406 jars = append(jars, classes)
1407 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001408 }
1409 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001410 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001411 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
Jaewoong Jung26342642021-03-17 15:56:23 -07001412 jars = append(jars, classes)
1413 }
1414 if ctx.Failed() {
1415 return
1416 }
1417 }
1418
Colin Crossfd620b22024-02-23 10:05:21 -08001419 jars = append(jars, extraCombinedJars...)
1420
Jaewoong Jung26342642021-03-17 15:56:23 -07001421 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1422
1423 var includeSrcJar android.WritablePath
1424 if Bool(j.properties.Include_srcs) {
1425 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1426 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1427 }
1428
1429 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1430 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1431 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1432 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1433
1434 var resArgs []string
1435 var resDeps android.Paths
1436
1437 resArgs = append(resArgs, dirArgs...)
1438 resDeps = append(resDeps, dirDeps...)
1439
1440 resArgs = append(resArgs, fileArgs...)
1441 resDeps = append(resDeps, fileDeps...)
1442
1443 resArgs = append(resArgs, extraArgs...)
1444 resDeps = append(resDeps, extraDeps...)
1445
1446 if len(resArgs) > 0 {
1447 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1448 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
1449 j.resourceJar = resourceJar
1450 if ctx.Failed() {
1451 return
1452 }
1453 }
1454
1455 var resourceJars android.Paths
1456 if j.resourceJar != nil {
1457 resourceJars = append(resourceJars, j.resourceJar)
1458 }
1459 if Bool(j.properties.Include_srcs) {
1460 resourceJars = append(resourceJars, includeSrcJar)
1461 }
1462 resourceJars = append(resourceJars, deps.staticResourceJars...)
1463
1464 if len(resourceJars) > 1 {
1465 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1466 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1467 false, nil, nil)
1468 j.resourceJar = combinedJar
1469 } else if len(resourceJars) == 1 {
1470 j.resourceJar = resourceJars[0]
1471 }
1472
1473 if len(deps.staticJars) > 0 {
1474 jars = append(jars, deps.staticJars...)
1475 }
1476
1477 manifest := j.overrideManifest
1478 if !manifest.Valid() && j.properties.Manifest != nil {
1479 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
1480 }
1481
1482 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1483 if len(services) > 0 {
1484 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1485 var zipargs []string
1486 for _, file := range services {
1487 serviceFile := file.String()
1488 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1489 }
1490 rule := zip
1491 args := map[string]string{
1492 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1493 }
1494 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1495 rule = zipRE
1496 args["implicits"] = strings.Join(services.Strings(), ",")
1497 }
1498 ctx.Build(pctx, android.BuildParams{
1499 Rule: rule,
1500 Output: servicesJar,
1501 Implicits: services,
1502 Args: args,
1503 })
1504 jars = append(jars, servicesJar)
1505 }
1506
1507 // Combine the classes built from sources, any manifests, and any static libraries into
1508 // classes.jar. If there is only one input jar this step will be skipped.
1509 var outputFile android.OutputPath
1510
1511 if len(jars) == 1 && !manifest.Valid() {
1512 // Optimization: skip the combine step as there is nothing to do
1513 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1514 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1515 // any if len(jars) == 1.
1516
Jihoon Kang1147b312023-06-08 23:25:57 +00001517 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1518 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1519 // either with .from-source or .from-text suffix.
1520 // outputFile should be agnostic to the build configuration,
1521 // thus "combine" the single static lib in order to prevent the static lib from being exposed
1522 // to the copy rules.
1523 stub, _ := moduleStubLinkType(ctx.ModuleName())
1524
Jaewoong Jung26342642021-03-17 15:56:23 -07001525 // Transform the single path to the jar into an OutputPath as that is required by the following
1526 // code.
Jihoon Kang1147b312023-06-08 23:25:57 +00001527 if moduleOutPath, ok := jars[0].(android.ModuleOutPath); ok && !stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07001528 // The path contains an embedded OutputPath so reuse that.
1529 outputFile = moduleOutPath.OutputPath
Jihoon Kang1147b312023-06-08 23:25:57 +00001530 } else if outputPath, ok := jars[0].(android.OutputPath); ok && !stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07001531 // The path is an OutputPath so reuse it directly.
1532 outputFile = outputPath
1533 } else {
1534 // The file is not in the out directory so create an OutputPath into which it can be copied
1535 // and which the following code can use to refer to it.
1536 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1537 ctx.Build(pctx, android.BuildParams{
1538 Rule: android.Cp,
1539 Input: jars[0],
1540 Output: combinedJar,
1541 })
1542 outputFile = combinedJar.OutputPath
1543 }
1544 } else {
1545 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1546 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1547 false, nil, nil)
1548 outputFile = combinedJar.OutputPath
1549 }
1550
1551 // jarjar implementation jar if necessary
1552 if j.expandJarjarRules != nil {
1553 // Transform classes.jar into classes-jarjar.jar
1554 jarjarFile := android.PathForModuleOut(ctx, "jarjar", jarName).OutputPath
1555 TransformJarJar(ctx, jarjarFile, outputFile, j.expandJarjarRules)
1556 outputFile = jarjarFile
1557
1558 // jarjar resource jar if necessary
1559 if j.resourceJar != nil {
1560 resourceJarJarFile := android.PathForModuleOut(ctx, "res-jarjar", jarName)
1561 TransformJarJar(ctx, resourceJarJarFile, j.resourceJar, j.expandJarjarRules)
1562 j.resourceJar = resourceJarJarFile
1563 }
1564
1565 if ctx.Failed() {
1566 return
1567 }
1568 }
1569
1570 // Check package restrictions if necessary.
1571 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001572 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001573 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001574
1575 // Create a rule to copy the output jar to another path and add a validate dependency that
1576 // will check that the jar only contains the permitted packages. The new location will become
1577 // the output file of this module.
1578 inputFile := outputFile
1579 outputFile = android.PathForModuleOut(ctx, "package-check", jarName).OutputPath
1580 ctx.Build(pctx, android.BuildParams{
1581 Rule: android.Cp,
1582 Input: inputFile,
1583 Output: outputFile,
1584 // Make sure that any dependency on the output file will cause ninja to run the package check
1585 // rule.
1586 Validation: pkgckFile,
1587 })
1588
1589 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001590 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001591
1592 if ctx.Failed() {
1593 return
1594 }
1595 }
1596
1597 j.implementationJarFile = outputFile
1598 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001599 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1600 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1601 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1602 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1603 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1604 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1605 j.headerJarFile = headerJarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001606 }
1607
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001608 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1609 specs := j.jacocoModuleToZipCommand(ctx)
1610 if ctx.Failed() {
1611 return
1612 }
1613
Jaewoong Jung26342642021-03-17 15:56:23 -07001614 if j.shouldInstrument(ctx) {
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001615 outputFile = j.instrument(ctx, flags, outputFile, jarName, specs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001616 }
1617
1618 // merge implementation jar with resources if necessary
1619 implementationAndResourcesJar := outputFile
1620 if j.resourceJar != nil {
1621 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
1622 combinedJar := android.PathForModuleOut(ctx, "withres", jarName).OutputPath
1623 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
1624 false, nil, nil)
1625 implementationAndResourcesJar = combinedJar
1626 }
1627
1628 j.implementationAndResourcesJar = implementationAndResourcesJar
1629
1630 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001631 compileDex := j.dexProperties.Compile_dex
Colin Crossff694a82023-12-13 15:54:49 -08001632 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -07001633 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001634 if compileDex == nil {
1635 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001636 }
1637 if j.deviceProperties.Hostdex == nil {
1638 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1639 }
1640 }
1641
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001642 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001643 if j.hasCode(ctx) {
1644 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001645 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001646 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1647 }
1648 // Dex compilation
1649 var dexOutputFile android.OutputPath
Spandan Dasc404cc72023-02-23 18:05:05 +00001650 params := &compileDexParams{
1651 flags: flags,
1652 sdkVersion: j.SdkVersion(ctx),
1653 minSdkVersion: j.MinSdkVersion(ctx),
1654 classesJar: implementationAndResourcesJar,
1655 jarName: jarName,
1656 }
Spandan Das15a67112024-05-30 00:07:40 +00001657 if j.GetProfileGuided() && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting() {
1658 ctx.PropertyErrorf("enable_profile_rewriting",
1659 "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.",
1660 )
1661 }
Spandan Das3dbda182024-05-20 22:23:10 +00001662 if j.EnableProfileRewriting() {
1663 profile := j.GetProfile()
1664 if profile == "" || !j.GetProfileGuided() {
1665 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1666 }
1667 params.artProfileInput = &profile
1668 }
1669 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001670 if ctx.Failed() {
1671 return
1672 }
1673
Spandan Das3dbda182024-05-20 22:23:10 +00001674 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1675 if dexArtProfileOutput != nil {
1676 j.dexpreopter.SetRewrittenProfile(*dexArtProfileOutput)
1677 }
1678
Jaewoong Jung26342642021-03-17 15:56:23 -07001679 // merge dex jar with resources if necessary
1680 if j.resourceJar != nil {
1681 jars := android.Paths{dexOutputFile, j.resourceJar}
1682 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName).OutputPath
1683 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1684 false, nil, nil)
1685 if *j.dexProperties.Uncompress_dex {
1686 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName).OutputPath
Cole Faust51d7bfd2023-09-07 05:31:32 +00001687 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001688 dexOutputFile = combinedAlignedJar
1689 } else {
1690 dexOutputFile = combinedJar
1691 }
1692 }
1693
Paul Duffin4de94502021-05-16 05:21:16 +01001694 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001695
1696 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001697
1698 // Encode hidden API flags in dex file, if needed.
1699 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1700
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001701 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001702
1703 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001704 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1705 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1706 libName = strings.TrimSuffix(libName, ".impl")
1707 }
1708 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001709
1710 outputFile = dexOutputFile
1711 } else {
1712 // There is no code to compile into a dex jar, make sure the resources are propagated
1713 // to the APK if this is an app.
1714 outputFile = implementationAndResourcesJar
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001715 j.dexJarFile = makeDexJarPathFromPath(j.resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001716 }
1717
1718 if ctx.Failed() {
1719 return
1720 }
1721 } else {
1722 outputFile = implementationAndResourcesJar
1723 }
1724
1725 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001726 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001727 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001728 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001729 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001730 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001731 }
1732 }
1733
1734 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001735 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1736 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001737 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1738 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001739 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001740 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001741 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001742 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001743 j.linter.javaLanguageLevel = flags.javaVersion.String()
1744 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001745 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001746 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1747 j.linter.buildModuleReportZip = true
1748 }
1749 j.linter.lint(ctx)
1750 }
1751
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001752 j.collectTransitiveSrcFiles(ctx, srcFiles)
1753
Jaewoong Jung26342642021-03-17 15:56:23 -07001754 ctx.CheckbuildFile(outputFile)
1755
Colin Cross40213022023-12-13 15:19:49 -08001756 android.SetProvider(ctx, JavaInfoProvider, JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001757 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1758 RepackagedHeaderJars: android.PathsIfNonNil(j.repackagedHeaderJarFile),
1759 TransitiveLibsHeaderJars: j.transitiveLibsHeaderJars,
1760 TransitiveStaticLibsHeaderJars: j.transitiveStaticLibsHeaderJars,
1761 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1762 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
1763 ResourceJars: android.PathsIfNonNil(j.resourceJar),
1764 AidlIncludeDirs: j.exportAidlIncludeDirs,
1765 SrcJarArgs: j.srcJarArgs,
1766 SrcJarDeps: j.srcJarDeps,
1767 TransitiveSrcFiles: j.transitiveSrcFiles,
1768 ExportedPlugins: j.exportedPluginJars,
1769 ExportedPluginClasses: j.exportedPluginClasses,
1770 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1771 JacocoReportClassesFile: j.jacocoReportClassesFile,
1772 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001773 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001774 })
1775
1776 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1777 j.outputFile = outputFile.WithoutRel()
1778}
1779
Colin Crossa1ff7c62021-09-17 14:11:52 -07001780func (j *Module) useCompose() bool {
1781 return android.InList("androidx.compose.runtime_runtime", j.properties.Static_libs)
1782}
1783
Colin Crosscde55342024-03-27 14:11:51 -07001784func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []*android.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001785 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001786 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001787 depTag := ctx.OtherModuleDependencyTag(m)
1788
1789 if depProguardInfo.UnconditionallyExportedProguardFlags != nil {
1790 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1791 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1792 }
1793
1794 if depTag == staticLibTag && depProguardInfo.ProguardFlagsFiles != nil {
1795 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1796 }
1797 })
1798
Colin Crosscde55342024-03-27 14:11:51 -07001799 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1800}
1801
1802func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1803 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1804
Sam Delmerico95d70942023-08-02 18:00:35 -04001805 directUnconditionalExportedFlags := android.Paths{}
1806 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1807 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1808 if exportUnconditionally {
1809 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1810 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1811 directUnconditionalExportedFlags = proguardFlagsForThisModule
1812 }
1813
1814 return ProguardSpecInfo{
1815 Export_proguard_flags_files: exportUnconditionally,
1816 ProguardFlagsFiles: android.NewDepSet[android.Path](
1817 android.POSTORDER,
1818 proguardFlagsForThisModule,
1819 transitiveProguardFlags,
1820 ),
1821 UnconditionallyExportedProguardFlags: android.NewDepSet[android.Path](
1822 android.POSTORDER,
1823 directUnconditionalExportedFlags,
1824 transitiveUnconditionalExportedFlags,
1825 ),
1826 }
1827
1828}
1829
Cole Faust75fffb12021-06-13 15:23:16 -07001830// Returns a copy of the supplied flags, but with all the errorprone-related
1831// fields copied to the regular build's fields.
1832func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1833 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1834
1835 if len(flags.errorProneExtraJavacFlags) > 0 {
1836 if len(flags.javacFlags) > 0 {
1837 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
1838 } else {
1839 flags.javacFlags = flags.errorProneExtraJavacFlags
1840 }
1841 }
1842 return flags
1843}
1844
Jaewoong Jung26342642021-03-17 15:56:23 -07001845func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
1846 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.WritablePath {
1847
1848 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00001849 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001850 if idx >= 0 {
1851 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00001852 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001853 jarName += strconv.Itoa(idx)
1854 }
1855
1856 classes := android.PathForModuleOut(ctx, "javac", jarName).OutputPath
Vadim Spivak3c496f02023-06-08 06:14:59 +00001857 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001858
Cole Faust9decf832024-06-11 11:45:53 -07001859 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001860 extractionFile := android.PathForModuleOut(ctx, kzipName)
1861 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1862 j.kytheFiles = append(j.kytheFiles, extractionFile)
1863 }
1864
Vadim Spivak3c496f02023-06-08 06:14:59 +00001865 if len(flags.processorPath) > 0 {
1866 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
1867 }
1868
Jaewoong Jung26342642021-03-17 15:56:23 -07001869 return classes
1870}
1871
1872// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1873// since some of these flags may be used internally.
1874func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1875 for _, flag := range flags {
1876 flag = strings.TrimSpace(flag)
1877
1878 if !strings.HasPrefix(flag, "-") {
1879 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1880 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1881 ctx.PropertyErrorf("kotlincflags",
1882 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1883 } else if inList(flag, config.KotlincIllegalFlags) {
1884 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1885 } else if flag == "-include-runtime" {
1886 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1887 } else {
1888 args := strings.Split(flag, " ")
1889 if args[0] == "-kotlin-home" {
1890 ctx.PropertyErrorf("kotlincflags",
1891 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1892 }
1893 }
1894 }
1895}
1896
1897func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
1898 deps deps, flags javaBuilderFlags, jarName string,
Joe Onorato349ae8d2024-02-05 22:46:00 +00001899 extraJars android.Paths) (headerJar, jarjarAndDepsHeaderJar, jarjarAndDepsRepackagedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001900
1901 var jars android.Paths
1902 if len(srcFiles) > 0 || len(srcJars) > 0 {
1903 // Compile java sources into turbine.jar.
1904 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1905 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
1906 if ctx.Failed() {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001907 return nil, nil, nil
Jaewoong Jung26342642021-03-17 15:56:23 -07001908 }
1909 jars = append(jars, turbineJar)
Colin Cross3d56ed52021-11-18 22:23:12 -08001910 headerJar = turbineJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001911 }
1912
1913 jars = append(jars, extraJars...)
1914
1915 // Combine any static header libraries into classes-header.jar. If there is only
1916 // one input jar this step will be skipped.
1917 jars = append(jars, deps.staticHeaderJars...)
1918
1919 // we cannot skip the combine step for now if there is only one jar
1920 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
1921 combinedJar := android.PathForModuleOut(ctx, "turbine-combined", jarName)
1922 TransformJarsToJar(ctx, combinedJar, "for turbine", jars, android.OptionalPath{},
1923 false, nil, []string{"META-INF/TRANSITIVE"})
Colin Cross3d56ed52021-11-18 22:23:12 -08001924 jarjarAndDepsHeaderJar = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001925
1926 if j.expandJarjarRules != nil {
1927 // Transform classes.jar into classes-jarjar.jar
1928 jarjarFile := android.PathForModuleOut(ctx, "turbine-jarjar", jarName)
Colin Cross3d56ed52021-11-18 22:23:12 -08001929 TransformJarJar(ctx, jarjarFile, jarjarAndDepsHeaderJar, j.expandJarjarRules)
1930 jarjarAndDepsHeaderJar = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001931 if ctx.Failed() {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001932 return nil, nil, nil
Jaewoong Jung26342642021-03-17 15:56:23 -07001933 }
1934 }
1935
Joe Onorato349ae8d2024-02-05 22:46:00 +00001936 if j.repackageJarjarRules != nil {
1937 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-turbine-jarjar", jarName)
1938 TransformJarJar(ctx, repackagedJarjarFile, jarjarAndDepsHeaderJar, j.repackageJarjarRules)
1939 jarjarAndDepsRepackagedHeaderJar = repackagedJarjarFile
1940 if ctx.Failed() {
1941 return nil, nil, nil
1942 }
1943 } else {
1944 jarjarAndDepsRepackagedHeaderJar = jarjarAndDepsHeaderJar
1945 }
1946
1947 return headerJar, jarjarAndDepsHeaderJar, jarjarAndDepsRepackagedHeaderJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001948}
1949
1950func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001951 classesJar android.Path, jarName string, specs string) android.OutputPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07001952
1953 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
1954 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName).OutputPath
1955
1956 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1957
1958 j.jacocoReportClassesFile = jacocoReportClassesFile
1959
1960 return instrumentedJar
1961}
1962
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001963type providesTransitiveHeaderJars struct {
1964 // set of header jars for all transitive libs deps
Colin Crossc85750b2022-04-21 12:50:51 -07001965 transitiveLibsHeaderJars *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001966 // set of header jars for all transitive static libs deps
Colin Crossc85750b2022-04-21 12:50:51 -07001967 transitiveStaticLibsHeaderJars *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001968}
1969
Colin Crossc85750b2022-04-21 12:50:51 -07001970func (j *providesTransitiveHeaderJars) TransitiveLibsHeaderJars() *android.DepSet[android.Path] {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001971 return j.transitiveLibsHeaderJars
1972}
1973
Colin Crossc85750b2022-04-21 12:50:51 -07001974func (j *providesTransitiveHeaderJars) TransitiveStaticLibsHeaderJars() *android.DepSet[android.Path] {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001975 return j.transitiveStaticLibsHeaderJars
1976}
1977
1978func (j *providesTransitiveHeaderJars) collectTransitiveHeaderJars(ctx android.ModuleContext) {
1979 directLibs := android.Paths{}
1980 directStaticLibs := android.Paths{}
Colin Crossc85750b2022-04-21 12:50:51 -07001981 transitiveLibs := []*android.DepSet[android.Path]{}
1982 transitiveStaticLibs := []*android.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001983 ctx.VisitDirectDeps(func(module android.Module) {
1984 // don't add deps of the prebuilt version of the same library
1985 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
1986 return
1987 }
1988
Colin Cross313aa542023-12-13 13:47:44 -08001989 dep, _ := android.OtherModuleProvider(ctx, module, JavaInfoProvider)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001990 tag := ctx.OtherModuleDependencyTag(module)
1991 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
1992 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
1993 directLibs = append(directLibs, dep.HeaderJars...)
1994 } else if tag == staticLibTag {
1995 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
Jared Dukeefb6d602023-10-27 18:47:10 +00001996 } else {
1997 // Don't propagate transitive libs for other kinds of dependencies.
1998 return
1999 }
2000
2001 if dep.TransitiveLibsHeaderJars != nil {
2002 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJars)
2003 }
2004 if dep.TransitiveStaticLibsHeaderJars != nil {
2005 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJars)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002006 }
2007 })
2008 j.transitiveLibsHeaderJars = android.NewDepSet(android.POSTORDER, directLibs, transitiveLibs)
2009 j.transitiveStaticLibsHeaderJars = android.NewDepSet(android.POSTORDER, directStaticLibs, transitiveStaticLibs)
2010}
2011
Jaewoong Jung26342642021-03-17 15:56:23 -07002012func (j *Module) HeaderJars() android.Paths {
2013 if j.headerJarFile == nil {
2014 return nil
2015 }
2016 return android.Paths{j.headerJarFile}
2017}
2018
2019func (j *Module) ImplementationJars() android.Paths {
2020 if j.implementationJarFile == nil {
2021 return nil
2022 }
2023 return android.Paths{j.implementationJarFile}
2024}
2025
Spandan Das59a4a2b2024-01-09 21:35:56 +00002026func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002027 return j.dexJarFile
2028}
2029
2030func (j *Module) DexJarInstallPath() android.Path {
2031 return j.installFile
2032}
2033
2034func (j *Module) ImplementationAndResourcesJars() android.Paths {
2035 if j.implementationAndResourcesJar == nil {
2036 return nil
2037 }
2038 return android.Paths{j.implementationAndResourcesJar}
2039}
2040
2041func (j *Module) AidlIncludeDirs() android.Paths {
2042 // exportAidlIncludeDirs is type android.Paths already
2043 return j.exportAidlIncludeDirs
2044}
2045
2046func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2047 return j.classLoaderContexts
2048}
2049
2050// Collect information for opening IDE project files in java/jdeps.go.
2051func (j *Module) IDEInfo(dpInfo *android.IdeInfo) {
2052 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2053 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2054 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2055 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
2056 if j.expandJarjarRules != nil {
2057 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
2058 }
Yikef6282022022-04-13 20:41:01 +08002059 dpInfo.Static_libs = append(dpInfo.Static_libs, j.properties.Static_libs...)
2060 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Vadim Spivak3c496f02023-06-08 06:14:59 +00002061 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002062}
2063
2064func (j *Module) CompilerDeps() []string {
2065 jdeps := []string{}
2066 jdeps = append(jdeps, j.properties.Libs...)
2067 jdeps = append(jdeps, j.properties.Static_libs...)
2068 return jdeps
2069}
2070
2071func (j *Module) hasCode(ctx android.ModuleContext) bool {
2072 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2073 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2074}
2075
2076// Implements android.ApexModule
2077func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2078 return j.depIsInSameApex(ctx, dep)
2079}
2080
2081// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002082func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002083 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002084 minSdkVersion := j.MinSdkVersion(ctx)
2085 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002086 return fmt.Errorf("min_sdk_version is not specified")
2087 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002088 // If the module is compiling against core (via sdk_version), skip comparison check.
2089 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002090 return nil
2091 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002092 if minSdkVersion.GreaterThan(sdkVersion) {
2093 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002094 }
2095 return nil
2096}
2097
2098func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002099 if j.stem == "" {
2100 panic("Stem() called before stem property was set")
2101 }
2102 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002103}
2104
Jaewoong Jung26342642021-03-17 15:56:23 -07002105func (j *Module) JacocoReportClassesFile() android.Path {
2106 return j.jacocoReportClassesFile
2107}
2108
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002109func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
2110 var fromDeps []*android.DepSet[android.Path]
2111 ctx.VisitDirectDeps(func(module android.Module) {
2112 tag := ctx.OtherModuleDependencyTag(module)
2113 if tag == staticLibTag {
Colin Cross313aa542023-12-13 13:47:44 -08002114 depInfo, _ := android.OtherModuleProvider(ctx, module, JavaInfoProvider)
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002115 if depInfo.TransitiveSrcFiles != nil {
2116 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
2117 }
2118 }
2119 })
2120
2121 j.transitiveSrcFiles = android.NewDepSet(android.POSTORDER, mine, fromDeps)
2122}
2123
Jaewoong Jung26342642021-03-17 15:56:23 -07002124func (j *Module) IsInstallable() bool {
2125 return Bool(j.properties.Installable)
2126}
2127
2128type sdkLinkType int
2129
2130const (
2131 // TODO(jiyong) rename these for better readability. Make the allowed
2132 // and disallowed link types explicit
2133 // order is important here. See rank()
2134 javaCore sdkLinkType = iota
2135 javaSdk
2136 javaSystem
2137 javaModule
2138 javaSystemServer
2139 javaPlatform
2140)
2141
2142func (lt sdkLinkType) String() string {
2143 switch lt {
2144 case javaCore:
2145 return "core Java API"
2146 case javaSdk:
2147 return "Android API"
2148 case javaSystem:
2149 return "system API"
2150 case javaModule:
2151 return "module API"
2152 case javaSystemServer:
2153 return "system server API"
2154 case javaPlatform:
2155 return "private API"
2156 default:
2157 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2158 }
2159}
2160
2161// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2162// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2163// can't statically depend on modules that use Platform API.
2164func (lt sdkLinkType) rank() int {
2165 return int(lt)
2166}
2167
2168type moduleWithSdkDep interface {
2169 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002170 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002171}
2172
Jiyong Park92315372021-04-02 08:45:46 +09002173func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002174 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002175 case android.SdkCore.DefaultJavaLibraryName(),
2176 "legacy.core.platform.api.stubs",
2177 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002178 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002179 "core-lambda-stubs",
Jihoon Kangb5078312023-03-29 23:25:49 +00002180 "core-generated-annotation-stubs":
Jaewoong Jung26342642021-03-17 15:56:23 -07002181 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002182 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002183 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002184 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002185 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002186 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002187 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002188 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002189 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002190 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002191 return javaSystem, true
2192 }
2193
2194 if stub, linkType := moduleStubLinkType(name); stub {
2195 return linkType, true
2196 }
2197
Jiyong Park92315372021-04-02 08:45:46 +09002198 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002199 switch ver.Kind {
2200 case android.SdkCore:
Jaewoong Jung26342642021-03-17 15:56:23 -07002201 return javaCore, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09002202 case android.SdkSystem:
Jaewoong Jung26342642021-03-17 15:56:23 -07002203 return javaSystem, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09002204 case android.SdkPublic:
Jaewoong Jung26342642021-03-17 15:56:23 -07002205 return javaSdk, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09002206 case android.SdkModule:
Jaewoong Jung26342642021-03-17 15:56:23 -07002207 return javaModule, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09002208 case android.SdkSystemServer:
Jaewoong Jung26342642021-03-17 15:56:23 -07002209 return javaSystemServer, false
Jiyong Parkf1691d22021-03-29 20:11:58 +09002210 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
Jaewoong Jung26342642021-03-17 15:56:23 -07002211 return javaPlatform, false
2212 }
2213
Jiyong Parkf1691d22021-03-29 20:11:58 +09002214 if !ver.Valid() {
2215 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002216 }
2217 return javaSdk, false
2218}
2219
2220// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2221// this module's. See the comment on rank() for details and an example.
2222func (j *Module) checkSdkLinkType(
2223 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2224 if ctx.Host() {
2225 return
2226 }
2227
Jiyong Park92315372021-04-02 08:45:46 +09002228 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002229 if stubs {
2230 return
2231 }
Jiyong Park92315372021-04-02 08:45:46 +09002232 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002233
2234 if myLinkType.rank() < depLinkType.rank() {
2235 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2236 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2237 "property of the source or target module so that target module is built "+
2238 "with the same or smaller API set when compared to the source.",
2239 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2240 }
2241}
2242
2243func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2244 var deps deps
2245
2246 if ctx.Device() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09002247 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07002248 if sdkDep.invalidVersion {
2249 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2250 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2251 } else if sdkDep.useFiles {
2252 // sdkDep.jar is actually equivalent to turbine header.jar.
2253 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002254 deps.dexClasspath = append(deps.dexClasspath, sdkDep.jars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002255 deps.aidlPreprocess = sdkDep.aidl
2256 } else {
2257 deps.aidlPreprocess = sdkDep.aidl
2258 }
2259 }
2260
Jiyong Park92315372021-04-02 08:45:46 +09002261 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002262
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002263 j.collectTransitiveHeaderJars(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07002264 ctx.VisitDirectDeps(func(module android.Module) {
2265 otherName := ctx.OtherModuleName(module)
2266 tag := ctx.OtherModuleDependencyTag(module)
2267
2268 if IsJniDepTag(tag) {
2269 // Handled by AndroidApp.collectAppDeps
2270 return
2271 }
2272 if tag == certificateTag {
2273 // Handled by AndroidApp.collectAppDeps
2274 return
2275 }
2276
2277 if dep, ok := module.(SdkLibraryDependency); ok {
2278 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002279 case sdkLibTag, libTag:
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002280 depHeaderJars := dep.SdkHeaderJars(ctx, j.SdkVersion(ctx))
2281 deps.classpath = append(deps.classpath, depHeaderJars...)
2282 deps.dexClasspath = append(deps.dexClasspath, depHeaderJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002283 case staticLibTag:
2284 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
2285 }
Colin Cross313aa542023-12-13 13:47:44 -08002286 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2287 if sdkLinkType != javaPlatform {
2288 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2289 // dep is a sysprop implementation library, but this module is not linking against
2290 // the platform, so it gets the sysprop public stubs library instead. Replace
2291 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2292 dep = syspropDep.JavaInfo
2293 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002294 }
2295 switch tag {
2296 case bootClasspathTag:
2297 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002298 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002299 if _, ok := module.(*Plugin); ok {
2300 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2301 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002302 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002303 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002304 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2305 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2306 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2307 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002308 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2309 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2310 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
2311 case java9LibTag:
2312 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
2313 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002314 if _, ok := module.(*Plugin); ok {
2315 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2316 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002317 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2318 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2319 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2320 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2321 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2322 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2323 // Turbine doesn't run annotation processors, so any module that uses an
2324 // annotation processor that generates API is incompatible with the turbine
2325 // optimization.
2326 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002327 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002328 case pluginTag:
2329 if plugin, ok := module.(*Plugin); ok {
2330 if plugin.pluginProperties.Processor_class != nil {
2331 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2332 } else {
2333 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2334 }
2335 // Turbine doesn't run annotation processors, so any module that uses an
2336 // annotation processor that generates API is incompatible with the turbine
2337 // optimization.
2338 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2339 } else {
2340 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2341 }
2342 case errorpronePluginTag:
2343 if _, ok := module.(*Plugin); ok {
2344 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2345 } else {
2346 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2347 }
2348 case exportedPluginTag:
2349 if plugin, ok := module.(*Plugin); ok {
2350 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2351 if plugin.pluginProperties.Processor_class != nil {
2352 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2353 }
2354 // Turbine doesn't run annotation processors, so any module that uses an
2355 // annotation processor that generates API is incompatible with the turbine
2356 // optimization.
2357 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2358 } else {
2359 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2360 }
2361 case kotlinStdlibTag:
2362 deps.kotlinStdlib = append(deps.kotlinStdlib, dep.HeaderJars...)
2363 case kotlinAnnotationsTag:
2364 deps.kotlinAnnotations = dep.HeaderJars
Colin Crossa1ff7c62021-09-17 14:11:52 -07002365 case kotlinPluginTag:
Luca Stefani41029752024-10-12 17:55:31 +02002366 if _, ok := module.(*KotlinPlugin); ok {
2367 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
2368 } else {
2369 ctx.PropertyErrorf("kotlin_plugins", "%q is not a kotlin_plugin module", otherName)
2370 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002371 case syspropPublicStubDepTag:
2372 // This is a sysprop implementation library, forward the JavaInfoProvider from
2373 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002374 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002375 JavaInfo: dep,
2376 })
2377 }
2378 } else if dep, ok := module.(android.SourceFileProducer); ok {
2379 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002380 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002381 checkProducesJars(ctx, dep)
2382 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002383 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002384 case staticLibTag:
2385 checkProducesJars(ctx, dep)
2386 deps.classpath = append(deps.classpath, dep.Srcs()...)
2387 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2388 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
2389 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002390 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002391 switch tag {
2392 case staticLibTag:
2393 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2394 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002395 } else {
2396 switch tag {
2397 case bootClasspathTag:
2398 // If a system modules dependency has been added to the bootclasspath
2399 // then add its libs to the bootclasspath.
2400 sm := module.(SystemModulesProvider)
2401 deps.bootClasspath = append(deps.bootClasspath, sm.HeaderJars()...)
2402
2403 case systemModulesTag:
2404 if deps.systemModules != nil {
2405 panic("Found two system module dependencies")
2406 }
2407 sm := module.(SystemModulesProvider)
2408 outputDir, outputDeps := sm.OutputDirAndDeps()
2409 deps.systemModules = &systemModules{outputDir, outputDeps}
Paul Duffin53a70a42022-01-11 14:35:55 +00002410
2411 case instrumentationForTag:
2412 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 -07002413 }
2414 }
2415
2416 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002417 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002418 })
2419
2420 return deps
2421}
2422
Joe Onorato349ae8d2024-02-05 22:46:00 +00002423// Provider for jarjar renaming rules.
2424//
2425// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2426// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2427// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2428// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2429// be renamed from that module.
2430// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002431type DependencyUse int
2432
2433const (
2434 RenameUseInvalid DependencyUse = iota
2435 RenameUseInclude
2436 RenameUseExclude
2437)
2438
2439type RenameUseElement struct {
2440 DepName string
2441 RenameUse DependencyUse
2442 Why string // token for determining where in the logic the decision was made.
2443}
2444
Joe Onorato349ae8d2024-02-05 22:46:00 +00002445type JarJarProviderData struct {
2446 // Mapping of class names: original --> renamed. If the value is "", the class will be
2447 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2448 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002449 Rename map[string]string
2450 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002451}
2452
2453func (this JarJarProviderData) GetDebugString() string {
2454 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002455 for _, k := range android.SortedKeys(this.Rename) {
2456 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002457 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2458 result += k + "--&gt;" + v + ";"
2459 }
2460 }
2461 return result
2462}
2463
2464var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2465
2466var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2467
2468func init() {
2469 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
2470}
2471
2472// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2473// whether they are java modules or not.
2474type BaseJarJarProviderData struct {
2475 JarJarProviderData JarJarProviderData
2476}
2477
2478func (this BaseJarJarProviderData) GetDebugString() string {
2479 return this.JarJarProviderData.GetDebugString()
2480}
2481
2482var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2483
2484// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2485// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2486// either JarJarProvider or BaseJarJarProvider.
2487func mergeJarJarPrefixes(ctx android.ModuleContext) {
2488 mod := ctx.Module()
2489 // Explicitly avoid propagating into some module types.
2490 switch reflect.TypeOf(mod).String() {
2491 case "*java.Droidstubs":
2492 return
2493 }
2494 jarJarData := collectDirectDepsProviders(ctx)
2495 if jarJarData != nil {
2496 providerData := BaseJarJarProviderData{
2497 JarJarProviderData: *jarJarData,
2498 }
2499 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2500 }
2501
2502}
2503
2504// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2505func (module *Module) addJarJarRenameRule(original string, renamed string) {
2506 if module.jarjarRenameRules == nil {
2507 module.jarjarRenameRules = make(map[string]string)
2508 }
2509 module.jarjarRenameRules[original] = renamed
2510}
2511
2512func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2513 // Gather repackage information from deps
2514 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002515
2516 module := ctx.Module()
2517 moduleName := module.Name()
2518
Joe Onorato349ae8d2024-02-05 22:46:00 +00002519 ctx.VisitDirectDepsIgnoreBlueprint(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002520 tag := ctx.OtherModuleDependencyTag(m)
2521 // This logic mirrors that in (*Module).collectDeps above. There are several places
2522 // where we explicitly return RenameUseExclude, even though it is the default, to
2523 // indicate that it has been verified to be the case.
2524 //
2525 // Note well: there are probably cases that are getting to the unconditional return
2526 // and are therefore wrong.
2527 shouldIncludeRenames := func() (DependencyUse, string) {
2528 if moduleName == m.Name() {
2529 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2530 }
2531 if sc, ok := module.(android.SdkContext); ok {
2532 if ctx.Device() {
2533 sdkDep := decodeSdkDep(ctx, sc)
2534 if !sdkDep.invalidVersion && sdkDep.useFiles {
2535 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002536 }
2537 }
LaMont Jones63683e42024-02-08 14:30:45 -08002538 }
2539 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2540 return RenameUseExclude, "tags"
2541 }
2542 if _, ok := m.(SdkLibraryDependency); ok {
2543 switch tag {
2544 case sdkLibTag, libTag:
2545 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2546 }
2547 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2548 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2549 switch ji.StubsLinkType {
2550 case Stubs:
2551 return RenameUseExclude, "info"
2552 case Implementation:
2553 return RenameUseInclude, "info"
2554 default:
LaMont Jones09721862024-06-11 10:30:50 -07002555 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002556 // Fall through to the heuristic logic.
2557 }
2558 switch reflect.TypeOf(m).String() {
2559 case "*java.GeneratedJavaLibraryModule":
2560 // Probably a java_aconfig_library module.
2561 // TODO: make this check better.
2562 return RenameUseInclude, "reflect"
2563 }
2564 switch tag {
2565 case bootClasspathTag:
2566 return RenameUseExclude, "tagswitch"
2567 case sdkLibTag, libTag, instrumentationForTag:
2568 return RenameUseInclude, "tagswitch"
2569 case java9LibTag:
2570 return RenameUseExclude, "tagswitch"
2571 case staticLibTag:
2572 return RenameUseInclude, "tagswitch"
2573 case pluginTag:
2574 return RenameUseInclude, "tagswitch"
2575 case errorpronePluginTag:
2576 return RenameUseInclude, "tagswitch"
2577 case exportedPluginTag:
2578 return RenameUseInclude, "tagswitch"
2579 case kotlinStdlibTag, kotlinAnnotationsTag:
2580 return RenameUseExclude, "tagswitch"
2581 case kotlinPluginTag:
2582 return RenameUseInclude, "tagswitch"
2583 default:
2584 return RenameUseExclude, "tagswitch"
2585 }
2586 } else if _, ok := m.(android.SourceFileProducer); ok {
2587 switch tag {
2588 case sdkLibTag, libTag, staticLibTag:
2589 return RenameUseInclude, "srcfile"
2590 default:
2591 return RenameUseExclude, "srcfile"
2592 }
Yu Liu67a28422024-03-05 00:36:31 +00002593 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002594 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002595 } else {
2596 switch tag {
2597 case bootClasspathTag:
2598 return RenameUseExclude, "else"
2599 case systemModulesTag:
2600 return RenameUseInclude, "else"
2601 }
2602 }
2603 // If we got here, choose the safer option, which may lead to a build failure, rather
2604 // than runtime failures on the device.
2605 return RenameUseExclude, "end"
2606 }
2607
2608 if result == nil {
2609 result = &JarJarProviderData{
2610 Rename: make(map[string]string),
2611 RenameUse: make([]RenameUseElement, 0),
2612 }
2613 }
2614 how, why := shouldIncludeRenames()
2615 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2616 if how != RenameUseInclude {
2617 // Nothing to merge.
2618 return
2619 }
2620
2621 merge := func(theirs *JarJarProviderData) {
2622 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002623 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2624 result.Rename[orig] = renamed
2625 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2626 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2627 result.Rename[orig] = renamed
2628 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2629 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2630 continue
2631 }
2632 }
2633 }
2634 }
2635 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2636 merge(&theirs)
2637 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2638 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2639 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2640 // to java.Module.
2641 merge(&theirs.JarJarProviderData)
2642 }
2643 })
2644 return
2645}
2646
2647func (this Module) GetDebugString() string {
2648 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2649}
2650
2651// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2652// us, and if it's been set, apply the jarjar_prefix property to rename them.
2653func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2654 // Gather repackage information from deps
2655 result := collectDirectDepsProviders(ctx)
2656
2657 // Update that with entries we've stored for ourself
2658 for orig, renamed := range module.jarjarRenameRules {
2659 if result == nil {
2660 result = &JarJarProviderData{
2661 Rename: make(map[string]string),
2662 }
2663 }
2664 if renamed != "" {
2665 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2666 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
2667 continue
2668 }
2669 }
2670 (*result).Rename[orig] = renamed
2671 }
2672
2673 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2674 if result == nil {
2675 return nil
2676 }
2677
2678 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2679 // that have not yet been renamed.
2680 prefix := proptools.String(module.properties.Jarjar_prefix)
2681 if prefix != "" {
2682 if prefix[0] == '.' {
2683 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2684 return nil
2685 }
2686 if prefix[len(prefix)-1] == '.' {
2687 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2688 return nil
2689 }
2690
2691 var updated map[string]string
2692 for orig, renamed := range (*result).Rename {
2693 if renamed == "" {
2694 if updated == nil {
2695 updated = make(map[string]string)
2696 }
2697 updated[orig] = prefix + "." + orig
2698 }
2699 }
2700 for orig, renamed := range updated {
2701 (*result).Rename[orig] = renamed
2702 }
2703 }
2704
2705 return result
2706}
2707
2708// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2709// to "" won't be in this list because they shouldn't be renamed yet.
2710func getJarJarRuleText(provider *JarJarProviderData) string {
2711 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002712 for _, orig := range android.SortedKeys(provider.Rename) {
2713 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002714 if renamed != "" {
2715 result += "rule " + orig + " " + renamed + "\n"
2716 }
2717 }
2718 return result
2719}
2720
Zi Wangddb2ee52024-04-02 16:44:02 +00002721// Repackage the flags if the jarjar rule txt for the flags is generated
2722func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.WritablePath, jarName, info string) android.WritablePath {
2723 if j.repackageJarjarRules == nil {
2724 return infile
2725 }
2726 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info+jarName)
2727 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
2728 return repackagedJarjarFile
2729}
2730
Jaewoong Jung26342642021-03-17 15:56:23 -07002731func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2732 deps.processorPath = append(deps.processorPath, pluginJars...)
2733 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2734}
2735
2736// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2737// this interface.
2738type ProvidesUsesLib interface {
2739 ProvidesUsesLib() *string
2740}
2741
2742func (j *Module) ProvidesUsesLib() *string {
2743 return j.usesLibraryProperties.Provides_uses_lib
2744}
satayev1c564cc2021-05-25 19:50:30 +01002745
2746type ModuleWithStem interface {
2747 Stem() string
2748}
2749
2750var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002751
2752type ModuleWithUsesLibrary interface {
2753 UsesLibrary() *usesLibrary
2754}
2755
2756func (j *Module) UsesLibrary() *usesLibrary {
2757 return &j.usesLibrary
2758}
2759
2760var _ ModuleWithUsesLibrary = (*Module)(nil)