blob: bc956bda877cc152c9a3422e2bb2e8720f75e74c [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 (
Yu Liu26a716d2024-08-30 23:40:32 +000018 "encoding/gob"
Jaewoong Jung26342642021-03-17 15:56:23 -070019 "fmt"
20 "path/filepath"
Joe Onorato349ae8d2024-02-05 22:46:00 +000021 "reflect"
22 "slices"
Jaewoong Jung26342642021-03-17 15:56:23 -070023 "strconv"
24 "strings"
25
Colin Crossd788b3e2023-11-28 13:14:56 -080026 "github.com/google/blueprint"
Jaewoong Jung26342642021-03-17 15:56:23 -070027 "github.com/google/blueprint/pathtools"
28 "github.com/google/blueprint/proptools"
29
30 "android/soong/android"
31 "android/soong/dexpreopt"
32 "android/soong/java/config"
33)
34
35// This file contains the definition and the implementation of the base module that most
36// source-based Java module structs embed.
37
38// TODO:
39// Autogenerated files:
40// Renderscript
41// Post-jar passes:
42// Proguard
43// Rmtypedefs
44// DroidDoc
45// Findbugs
46
47// Properties that are common to most Java modules, i.e. whether it's a host or device module.
48type CommonProperties struct {
49 // list of source files used to compile the Java module. May be .java, .kt, .logtags, .proto,
50 // or .aidl files.
51 Srcs []string `android:"path,arch_variant"`
52
53 // list Kotlin of source files containing Kotlin code that should be treated as common code in
54 // a codebase that supports Kotlin multiplatform. See
55 // https://kotlinlang.org/docs/reference/multiplatform.html. May be only be .kt files.
56 Common_srcs []string `android:"path,arch_variant"`
57
58 // list of source files that should not be used to build the Java module.
59 // This is most useful in the arch/multilib variants to remove non-common files
60 Exclude_srcs []string `android:"path,arch_variant"`
61
62 // list of directories containing Java resources
63 Java_resource_dirs []string `android:"arch_variant"`
64
65 // list of directories that should be excluded from java_resource_dirs
66 Exclude_java_resource_dirs []string `android:"arch_variant"`
67
68 // list of files to use as Java resources
69 Java_resources []string `android:"path,arch_variant"`
70
71 // list of files that should be excluded from java_resources and java_resource_dirs
72 Exclude_java_resources []string `android:"path,arch_variant"`
73
74 // list of module-specific flags that will be used for javac compiles
75 Javacflags []string `android:"arch_variant"`
76
77 // list of module-specific flags that will be used for kotlinc compiles
78 Kotlincflags []string `android:"arch_variant"`
79
80 // list of java libraries that will be in the classpath
81 Libs []string `android:"arch_variant"`
82
83 // list of java libraries that will be compiled into the resulting jar
Cole Faustb7493472024-08-28 11:55:52 -070084 Static_libs proptools.Configurable[[]string] `android:"arch_variant"`
Jaewoong Jung26342642021-03-17 15:56:23 -070085
Jihoon Kang381c2fa2023-06-01 22:17:32 +000086 // list of java libraries that should not be used to build this module
87 Exclude_static_libs []string `android:"arch_variant"`
88
Jaewoong Jung26342642021-03-17 15:56:23 -070089 // manifest file to be included in resulting jar
90 Manifest *string `android:"path"`
91
92 // if not blank, run jarjar using the specified rules file
93 Jarjar_rules *string `android:"path,arch_variant"`
94
Joe Onoratoa5d17172024-07-20 17:39:56 -070095 // java class names to rename with jarjar when a reverse dependency has a jarjar_prefix
96 // property.
97 Jarjar_rename []string
98
Joe Onorato349ae8d2024-02-05 22:46:00 +000099 // if not blank, used as prefix to generate repackage rule
100 Jarjar_prefix *string
101
Zi Wang9bdd4222024-02-26 18:21:01 -0800102 // if set to true, skip the jarjar repackaging
103 Skip_jarjar_repackage *bool
104
Jaewoong Jung26342642021-03-17 15:56:23 -0700105 // If not blank, set the java version passed to javac as -source and -target
106 Java_version *string
107
108 // If set to true, allow this module to be dexed and installed on devices. Has no
109 // effect on host modules, which are always considered installable.
110 Installable *bool
111
112 // If set to true, include sources used to compile the module in to the final jar
113 Include_srcs *bool
114
115 // If not empty, classes are restricted to the specified packages and their sub-packages.
116 // This restriction is checked after applying jarjar rules and including static libs.
117 Permitted_packages []string
118
119 // List of modules to use as annotation processors
120 Plugins []string
121
122 // List of modules to export to libraries that directly depend on this library as annotation
123 // processors. Note that if the plugins set generates_api: true this will disable the turbine
124 // optimization on modules that depend on this module, which will reduce parallelism and cause
125 // more recompilation.
126 Exported_plugins []string
127
128 // The number of Java source entries each Javac instance can process
129 Javac_shard_size *int64
130
131 // Add host jdk tools.jar to bootclasspath
132 Use_tools_jar *bool
133
134 Openjdk9 struct {
135 // List of source files that should only be used when passing -source 1.9 or higher
136 Srcs []string `android:"path"`
137
138 // List of javac flags that should only be used when passing -source 1.9 or higher
139 Javacflags []string
140 }
141
142 // When compiling language level 9+ .java code in packages that are part of
143 // a system module, patch_module names the module that your sources and
144 // dependencies should be patched into. The Android runtime currently
145 // doesn't implement the JEP 261 module system so this option is only
146 // supported at compile time. It should only be needed to compile tests in
147 // packages that exist in libcore and which are inconvenient to move
148 // elsewhere.
Liz Kammer0a470a32023-10-05 17:02:00 -0400149 Patch_module *string
Jaewoong Jung26342642021-03-17 15:56:23 -0700150
151 Jacoco struct {
152 // List of classes to include for instrumentation with jacoco to collect coverage
153 // information at runtime when building with coverage enabled. If unset defaults to all
154 // classes.
155 // Supports '*' as the last character of an entry in the list as a wildcard match.
156 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
157 // it matches classes in the package that have the class name as a prefix.
158 Include_filter []string
159
160 // List of classes to exclude from instrumentation with jacoco to collect coverage
161 // information at runtime when building with coverage enabled. Overrides classes selected
162 // by the include_filter property.
163 // Supports '*' as the last character of an entry in the list as a wildcard match.
164 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
165 // it matches classes in the package that have the class name as a prefix.
166 Exclude_filter []string
167 }
168
169 Errorprone struct {
170 // List of javac flags that should only be used when running errorprone.
171 Javacflags []string
172
173 // List of java_plugin modules that provide extra errorprone checks.
174 Extra_check_modules []string
Cole Faust75fffb12021-06-13 15:23:16 -0700175
Cole Faust2b1536e2021-06-18 12:25:54 -0700176 // This property can be in 3 states. When set to true, errorprone will
177 // be run during the regular build. When set to false, errorprone will
178 // never be run. When unset, errorprone will be run when the RUN_ERROR_PRONE
179 // environment variable is true. Setting this to false will improve build
180 // performance more than adding -XepDisableAllChecks in javacflags.
Cole Faust75fffb12021-06-13 15:23:16 -0700181 Enabled *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700182 }
183
184 Proto struct {
185 // List of extra options that will be passed to the proto generator.
186 Output_params []string
187 }
188
Sam Delmericoc7593722022-08-31 15:57:52 -0400189 // If true, then jacocoagent is automatically added as a libs dependency so that
190 // r8 will not strip instrumentation classes out of dexed libraries.
Jaewoong Jung26342642021-03-17 15:56:23 -0700191 Instrument bool `blueprint:"mutated"`
Paul Duffin0038a8d2022-05-03 00:28:40 +0000192 // If true, then the module supports statically including the jacocoagent
193 // into the library.
194 Supports_static_instrumentation bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700195
196 // List of files to include in the META-INF/services folder of the resulting jar.
197 Services []string `android:"path,arch_variant"`
198
199 // If true, package the kotlin stdlib into the jar. Defaults to true.
200 Static_kotlin_stdlib *bool `android:"arch_variant"`
201
202 // A list of java_library instances that provide additional hiddenapi annotations for the library.
203 Hiddenapi_additional_annotations []string
Joe Onorato175073c2023-06-01 14:42:59 -0700204
205 // Additional srcJars tacked in by GeneratedJavaLibraryModule
206 Generated_srcjars []android.Path `android:"mutated"`
Mark Whitea15790a2023-08-22 21:28:11 +0000207
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000208 // intermediate aconfig cache file tacked in by GeneratedJavaLibraryModule
209 Aconfig_Cache_files []android.Path `android:"mutated"`
210
Mark Whitea15790a2023-08-22 21:28:11 +0000211 // If true, then only the headers are built and not the implementation jar.
Liz Kammer60772632023-10-05 17:18:44 -0400212 Headers_only *bool
Cole Faust2b64af82023-12-13 18:22:18 -0800213
214 // A list of files or dependencies to make available to the build sandbox. This is
215 // useful if source files are symlinks, the targets of the symlinks must be listed here.
216 // Note that currently not all actions implemented by android_apps are sandboxed, so you
217 // may only see this being necessary in lint builds.
218 Compile_data []string `android:"path"`
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000219
220 // Property signifying whether the module compiles stubs or not.
221 // Should be set to true when srcs of this module are stub files.
222 // This property does not need to be set to true when the module depends on
223 // the stubs via libs, but should be set to true when the module depends on
224 // the stubs via static libs.
225 Is_stubs_module *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700226
227 // If true, enable the "Ravenizer" tool on the output jar.
228 // "Ravenizer" is a tool for Ravenwood tests, but it can also be enabled on other kinds
229 // of java targets.
230 Ravenizer struct {
231 Enabled *bool
232 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +0000233
234 // Contributing api surface of the stub module. Is not visible to bp modules, and should
235 // only be set for stub submodules generated by the java_sdk_library
236 Stub_contributing_api *string `blueprint:"mutated"`
Yihan Dong8be09c22024-08-29 15:32:13 +0800237
238 // If true, enable the "ApiMapper" tool on the output jar. "ApiMapper" is a tool to inject
239 // bytecode to log API calls.
240 ApiMapper bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700241}
242
243// Properties that are specific to device modules. Host module factories should not add these when
244// constructing a new module.
245type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000246 // If not blank, set to the version of the sdk to compile against.
Spandan Das1ccf5742022-10-14 16:51:23 +0000247 // Defaults to an empty string, which compiles the module against the private platform APIs.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000248 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000249 // 1) numerical API level, "current", "none", or "core_platform"
250 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
251 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
252 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700253 Sdk_version *string
254
satayev0a420e72021-11-29 17:25:52 +0000255 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
256 // Defaults to empty string "". See sdk_version for possible values.
257 Max_sdk_version *string
258
William Loh5a082f92022-05-17 20:21:50 +0000259 // if not blank, set the maxSdkVersion properties of permission and uses-permission tags.
260 // Defaults to empty string "". See sdk_version for possible values.
261 Replace_max_sdk_version_placeholder *string
262
Jaewoong Jung26342642021-03-17 15:56:23 -0700263 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000264 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700265 Target_sdk_version *string
266
267 // Whether to compile against the platform APIs instead of an SDK.
268 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000269 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700270 Platform_apis *bool
271
272 Aidl struct {
273 // Top level directories to pass to aidl tool
274 Include_dirs []string
275
276 // Directories rooted at the Android.bp file to pass to aidl tool
277 Local_include_dirs []string
278
279 // directories that should be added as include directories for any aidl sources of modules
280 // that depend on this module, as well as to aidl for this module.
281 Export_include_dirs []string
282
283 // whether to generate traces (for systrace) for this interface
284 Generate_traces *bool
285
286 // whether to generate Binder#GetTransaction name method.
287 Generate_get_transaction_name *bool
288
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100289 // whether all interfaces should be annotated with required permissions.
290 Enforce_permissions *bool
291
292 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
293 Enforce_permissions_exceptions []string `android:"path"`
294
Jaewoong Jung26342642021-03-17 15:56:23 -0700295 // list of flags that will be passed to the AIDL compiler
296 Flags []string
297 }
298
299 // If true, export a copy of the module as a -hostdex module for host testing.
300 Hostdex *bool
301
302 Target struct {
303 Hostdex struct {
304 // Additional required dependencies to add to -hostdex modules.
305 Required []string
306 }
307 }
308
309 // When targeting 1.9 and above, override the modules to use with --system,
310 // otherwise provides defaults libraries to add to the bootclasspath.
311 System_modules *string
312
Jaewoong Jung26342642021-03-17 15:56:23 -0700313 IsSDKLibrary bool `blueprint:"mutated"`
314
315 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
316 // Defaults to false.
317 V4_signature *bool
318
319 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
320 // public stubs library.
321 SyspropPublicStub string `blueprint:"mutated"`
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000322
323 HiddenAPIPackageProperties
324 HiddenAPIFlagFileProperties
Jaewoong Jung26342642021-03-17 15:56:23 -0700325}
326
yangbill2af0b6e2024-03-15 09:29:29 +0000327// Properties that can be overridden by overriding module (e.g. override_android_app)
328type OverridableProperties struct {
Jooyung Han01d80d82022-01-08 12:16:32 +0900329 // set the name of the output. If not set, `name` is used.
330 // To override a module with this property set, overriding module might need to set this as well.
331 // Otherwise, both the overridden and the overriding modules will have the same output name, which
332 // can cause the duplicate output error.
333 Stem *string
Spandan Dasb9c58352024-05-13 18:29:45 +0000334
335 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
336 // Defaults to sdk_version if not set. See sdk_version for possible values.
337 Min_sdk_version *string
Jooyung Han01d80d82022-01-08 12:16:32 +0900338}
339
Jaewoong Jung26342642021-03-17 15:56:23 -0700340// Functionality common to Module and Import
341//
342// It is embedded in Module so its functionality can be used by methods in Module
343// but it is currently only initialized by Import and Library.
344type embeddableInModuleAndImport struct {
345
346 // Functionality related to this being used as a component of a java_sdk_library.
347 EmbeddableSdkLibraryComponent
348}
349
Paul Duffin71b33cc2021-06-23 11:39:47 +0100350func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
351 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700352}
353
354// Module/Import's DepIsInSameApex(...) delegates to this method.
355//
356// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
357// the one provided by ApexModuleBase.
358func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
359 // dependencies other than the static linkage are all considered crossing APEX boundary
360 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
361 return true
362 }
363 return false
364}
365
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100366// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
367// or an invalid path describing the reason it is invalid.
368//
369// It is unset if a dex jar isn't applicable, i.e. no build rule has been
370// requested to create one.
371//
372// If a dex jar has been requested to be built then it is set, and it may be
373// either a valid android.Path, or invalid with a reason message. The latter
374// happens if the source that should produce the dex file isn't able to.
375//
376// E.g. it is invalid with a reason message if there is a prebuilt APEX that
377// could produce the dex jar through a deapexer module, but the APEX isn't
378// installable so doing so wouldn't be safe.
379type OptionalDexJarPath struct {
380 isSet bool
381 path android.OptionalPath
382}
383
384// IsSet returns true if a path has been set, either invalid or valid.
385func (o OptionalDexJarPath) IsSet() bool {
386 return o.isSet
387}
388
389// Valid returns true if there is a path that is valid.
390func (o OptionalDexJarPath) Valid() bool {
391 return o.isSet && o.path.Valid()
392}
393
394// Path returns the valid path, or panics if it's either not set or is invalid.
395func (o OptionalDexJarPath) Path() android.Path {
396 if !o.isSet {
397 panic("path isn't set")
398 }
399 return o.path.Path()
400}
401
402// PathOrNil returns the path if it's set and valid, or else nil.
403func (o OptionalDexJarPath) PathOrNil() android.Path {
404 if o.Valid() {
405 return o.Path()
406 }
407 return nil
408}
409
410// InvalidReason returns the reason for an invalid path, which is never "". It
411// returns "" for an unset or valid path.
412func (o OptionalDexJarPath) InvalidReason() string {
413 if !o.isSet {
414 return ""
415 }
416 return o.path.InvalidReason()
417}
418
419func (o OptionalDexJarPath) String() string {
420 if !o.isSet {
421 return "<unset>"
422 }
423 return o.path.String()
424}
425
426// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
427func makeUnsetDexJarPath() OptionalDexJarPath {
428 return OptionalDexJarPath{isSet: false}
429}
430
431// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
432// the given OptionalPath, which may be valid or invalid.
433func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
434 return OptionalDexJarPath{isSet: true, path: path}
435}
436
437// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
438// valid given path. It returns an unset OptionalDexJarPath if the given path is
439// nil.
440func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
441 if path == nil {
442 return makeUnsetDexJarPath()
443 }
444 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
445}
446
Jaewoong Jung26342642021-03-17 15:56:23 -0700447// Module contains the properties and members used by all java module types
448type Module struct {
449 android.ModuleBase
450 android.DefaultableModuleBase
451 android.ApexModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700452
453 // Functionality common to Module and Import.
454 embeddableInModuleAndImport
455
456 properties CommonProperties
457 protoProperties android.ProtoProperties
458 deviceProperties DeviceProperties
459
yangbill2af0b6e2024-03-15 09:29:29 +0000460 overridableProperties OverridableProperties
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700461 sourceProperties android.SourceProperties
Jooyung Han01d80d82022-01-08 12:16:32 +0900462
Jaewoong Jung26342642021-03-17 15:56:23 -0700463 // jar file containing header classes including static library dependencies, suitable for
464 // inserting into the bootclasspath/classpath of another compile
465 headerJarFile android.Path
466
Joe Onorato349ae8d2024-02-05 22:46:00 +0000467 repackagedHeaderJarFile android.Path
468
Jaewoong Jung26342642021-03-17 15:56:23 -0700469 // jar file containing implementation classes including static library dependencies but no
470 // resources
471 implementationJarFile android.Path
472
473 // jar file containing only resources including from static library dependencies
474 resourceJar android.Path
475
476 // args and dependencies to package source files into a srcjar
477 srcJarArgs []string
478 srcJarDeps android.Paths
479
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000480 // the source files of this module and all its static dependencies
481 transitiveSrcFiles *android.DepSet[android.Path]
482
Jaewoong Jung26342642021-03-17 15:56:23 -0700483 // jar file containing implementation classes and resources including static library
484 // dependencies
485 implementationAndResourcesJar android.Path
486
487 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100488 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700489
490 // output file containing uninstrumented classes that will be instrumented by jacoco
491 jacocoReportClassesFile android.Path
492
493 // output file of the module, which may be a classes jar or a dex jar
494 outputFile android.Path
495 extraOutputFiles android.Paths
496
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100497 exportAidlIncludeDirs android.Paths
498 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700499
500 logtagsSrcs android.Paths
501
502 // installed file for binary dependency
503 installFile android.Path
504
Colin Cross3108ce12021-11-10 14:38:50 -0800505 // installed file for hostdex copy
506 hostdexInstallFile android.InstallPath
507
Chaohui Wangdcbe33c2022-10-11 11:13:30 +0800508 // list of unique .java and .kt source files
509 uniqueSrcFiles android.Paths
510
511 // list of srcjars that was passed to javac
512 compiledSrcJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700513
514 // manifest file to use instead of properties.Manifest
515 overrideManifest android.OptionalPath
516
Jaewoong Jung26342642021-03-17 15:56:23 -0700517 // list of plugins that this java module is exporting
518 exportedPluginJars android.Paths
519
520 // list of plugins that this java module is exporting
521 exportedPluginClasses []string
522
523 // if true, the exported plugins generate API and require disabling turbine.
524 exportedDisableTurbine bool
525
526 // list of source files, collected from srcFiles with unique java and all kt files,
527 // will be used by android.IDEInfo struct
528 expandIDEInfoCompiledSrcs []string
529
530 // expanded Jarjar_rules
531 expandJarjarRules android.Path
532
Joe Onorato349ae8d2024-02-05 22:46:00 +0000533 // jarjar rule for inherited jarjar rules
534 repackageJarjarRules android.Path
535
Jaewoong Jung26342642021-03-17 15:56:23 -0700536 // Extra files generated by the module type to be added as java resources.
537 extraResources android.Paths
538
539 hiddenAPI
540 dexer
541 dexpreopter
542 usesLibrary
543 linter
544
545 // list of the xref extraction files
546 kytheFiles android.Paths
547
Jaewoong Jung26342642021-03-17 15:56:23 -0700548 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900549
550 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000551 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000552 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400553
554 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000555
556 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000557
558 // output file name based on Stem property.
559 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
560 // or the module should override Stem().
561 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700562
Joe Onorato349ae8d2024-02-05 22:46:00 +0000563 // Values that will be set in the JarJarProvider data for jarjar repackaging,
564 // and merged with our dependencies' rules.
565 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000566
567 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000568
569 // Paths to the aconfig intermediate cache files that are provided by the
570 // java_aconfig_library or java_library modules that are statically linked
571 // to this module. Does not contain cache files from all transitive dependencies.
572 aconfigCacheFiles android.Paths
Spandan Das8aac9932024-07-18 23:14:13 +0000573
574 // List of soong module dependencies required to compile the current module.
575 // This information is printed out to `Dependencies` field in module_bp_java_deps.json
576 compileDepNames []string
Makoto Onuki7ded3822024-03-28 14:42:20 -0700577
578 ravenizer struct {
579 enabled bool
580 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700581}
582
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000583var _ android.InstallableModule = (*Module)(nil)
584
585// To satisfy the InstallableModule interface
Jihoon Kang224ea082024-08-12 22:38:16 +0000586func (j *Module) StaticDependencyTags() []blueprint.DependencyTag {
587 return []blueprint.DependencyTag{staticLibTag}
588}
589
590// To satisfy the InstallableModule interface
591func (j *Module) DynamicDependencyTags() []blueprint.DependencyTag {
592 return []blueprint.DependencyTag{libTag, sdkLibTag, bootClasspathTag, systemModulesTag,
593 instrumentationForTag, java9LibTag}
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000594}
595
596// Overrides android.ModuleBase.InstallInProduct()
597func (j *Module) InstallInProduct() bool {
598 return j.ProductSpecific()
599}
600
Jihoon Kang85bc1932024-07-01 17:04:46 +0000601var _ android.StubsAvailableModule = (*Module)(nil)
602
603// To safisfy the StubsAvailableModule interface
604func (j *Module) IsStubsModule() bool {
605 return proptools.Bool(j.properties.Is_stubs_module)
606}
607
Jiyong Park92315372021-04-02 08:45:46 +0900608func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
609 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900610 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700611 return nil
612 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900613 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000614 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700615 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
616 } else {
617 // Treat stable core platform as stable.
618 return nil
619 }
620 } else {
621 return fmt.Errorf("non stable SDK %v", sdkVersion)
622 }
623}
624
625// checkSdkVersions enforces restrictions around SDK dependencies.
626func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
627 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900628 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900629 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700630 ctx.PropertyErrorf("sdk_version",
631 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
632 }
633 }
634 }
635
636 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
637 // See rank() for details.
638 ctx.VisitDirectDeps(func(module android.Module) {
639 tag := ctx.OtherModuleDependencyTag(module)
640 switch module.(type) {
641 // TODO(satayev): cover other types as well, e.g. imports
642 case *Library, *AndroidLibrary:
643 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400644 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700645 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
646 }
647 }
648 })
649}
650
651func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900652 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700653 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900654 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700655 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000656 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 -0700657 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000658 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 -0700659 }
660
661 }
662}
663
Mark Whitea15790a2023-08-22 21:28:11 +0000664func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
665 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400666 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000667 installable := proptools.Bool(j.properties.Installable)
668
669 if headersOnly && installable {
670 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.")
671 }
672 }
673}
674
Jaewoong Jung26342642021-03-17 15:56:23 -0700675func (j *Module) addHostProperties() {
676 j.AddProperties(
677 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000678 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700679 &j.protoProperties,
680 &j.usesLibraryProperties,
681 )
682}
683
684func (j *Module) addHostAndDeviceProperties() {
685 j.addHostProperties()
686 j.AddProperties(
687 &j.deviceProperties,
688 &j.dexer.dexProperties,
689 &j.dexpreoptProperties,
690 &j.linter.properties,
691 )
692}
693
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000694// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
695// makes it available through the hiddenAPIPropertyInfoProvider.
696func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
697 hiddenAPIInfo := newHiddenAPIPropertyInfo()
698
699 // Populate with flag file paths from the properties.
700 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
701
702 // Populate with package rules from the properties.
703 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
704
Colin Cross40213022023-12-13 15:19:49 -0800705 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000706}
707
mrziwang9f7b9f42024-07-10 12:18:06 -0700708// helper method for java modules to set OutputFilesProvider
709func setOutputFiles(ctx android.ModuleContext, m Module) {
710 ctx.SetOutputFiles(append(android.Paths{m.outputFile}, m.extraOutputFiles...), "")
711 ctx.SetOutputFiles(android.Paths{m.outputFile}, android.DefaultDistTag)
712 ctx.SetOutputFiles(android.Paths{m.implementationAndResourcesJar}, ".jar")
713 ctx.SetOutputFiles(android.Paths{m.headerJarFile}, ".hjar")
714 if m.dexer.proguardDictionary.Valid() {
715 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
716 }
717 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
718 if m.linter.outputs.xml != nil {
719 ctx.SetOutputFiles(android.Paths{m.linter.outputs.xml}, ".lint")
Jaewoong Jung26342642021-03-17 15:56:23 -0700720 }
721}
722
Jaewoong Jung26342642021-03-17 15:56:23 -0700723func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
724 initJavaModule(module, hod, false)
725}
726
727func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
728 initJavaModule(module, hod, true)
729}
730
731func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
732 multilib := android.MultilibCommon
733 if multiTargets {
734 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
735 } else {
736 android.InitAndroidArchModule(module, hod, multilib)
737 }
738 android.InitDefaultableModule(module)
739}
740
741func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
742 return j.properties.Instrument &&
743 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
744 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
745}
746
Yihan Dong8be09c22024-08-29 15:32:13 +0800747func (j *Module) shouldApiMapper() bool {
748 return j.properties.ApiMapper
749}
750
Jaewoong Jung26342642021-03-17 15:56:23 -0700751func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000752 return j.properties.Supports_static_instrumentation &&
753 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700754 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
755 ctx.Config().UnbundledBuild())
756}
757
758func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
759 // Force enable the instrumentation for java code that is built for APEXes ...
760 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
761 // 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 -0800762 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700763 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000764
Jihoon Kang46d66de2024-05-22 22:42:39 +0000765 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700766 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
767 return true
768 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
769 return true
770 }
771 }
772 return false
773}
774
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400775func (j *Module) setInstrument(value bool) {
776 j.properties.Instrument = value
777}
778
Yihan Dong8be09c22024-08-29 15:32:13 +0800779func (j *Module) setApiMapper(value bool) {
780 j.properties.ApiMapper = value
781}
782
Jiyong Park92315372021-04-02 08:45:46 +0900783func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
784 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700785}
786
Jiyong Parkf1691d22021-03-29 20:11:58 +0900787func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700788 return proptools.String(j.deviceProperties.System_modules)
789}
790
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000791func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000792 if j.overridableProperties.Min_sdk_version != nil {
793 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700794 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000795 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700796}
797
Yu Liuf2b94012023-09-19 15:09:10 -0700798func (j *Module) GetDeviceProperties() *DeviceProperties {
799 return &j.deviceProperties
800}
801
Spandan Dasa26eda72023-03-02 00:56:06 +0000802func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
803 if j.deviceProperties.Max_sdk_version != nil {
804 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
805 }
806 // Default is PrivateApiLevel
807 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000808}
809
Spandan Dasa26eda72023-03-02 00:56:06 +0000810func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
811 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
812 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
813 }
814 // Default is PrivateApiLevel
815 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000816}
817
Jiyong Parkf1691d22021-03-29 20:11:58 +0900818func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000819 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900820}
821
Spandan Dasca70fc42023-03-01 23:38:49 +0000822func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900823 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000824 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900825 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000826 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700827}
828
829func (j *Module) AvailableFor(what string) bool {
830 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
831 // Exception: for hostdex: true libraries, the platform variant is created
832 // even if it's not marked as available to platform. In that case, the platform
833 // variant is used only for the hostdex and not installed to the device.
834 return true
835 }
836 return j.ApexModuleBase.AvailableFor(what)
837}
838
Cole Faustb7493472024-08-28 11:55:52 -0700839func (j *Module) staticLibs(ctx android.BaseModuleContext) []string {
840 return android.RemoveListFromList(j.properties.Static_libs.GetOrDefault(ctx, nil), j.properties.Exclude_static_libs)
841}
842
Jaewoong Jung26342642021-03-17 15:56:23 -0700843func (j *Module) deps(ctx android.BottomUpMutatorContext) {
844 if ctx.Device() {
845 j.linter.deps(ctx)
846
Jiyong Parkf1691d22021-03-29 20:11:58 +0900847 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700848
849 if j.deviceProperties.SyspropPublicStub != "" {
850 // This is a sysprop implementation library that has a corresponding sysprop public
851 // stubs library, and a dependency on it so that dependencies on the implementation can
852 // be forwarded to the public stubs library when necessary.
853 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
854 }
855 }
856
857 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000858
Cole Faustb7493472024-08-28 11:55:52 -0700859 ctx.AddVariationDependencies(nil, staticLibTag, j.staticLibs(ctx)...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700860
861 // Add dependency on libraries that provide additional hidden api annotations.
862 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
863
Kiyoung Kim9743bab2024-03-28 15:44:56 +0900864 if ctx.Config().EnforceInterPartitionJavaSdkLibrary() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700865 // Require java_sdk_library at inter-partition java dependency to ensure stable
866 // interface between partitions. If inter-partition java_library dependency is detected,
867 // raise build error because java_library doesn't have a stable interface.
868 //
869 // Inputs:
870 // PRODUCT_ENFORCE_INTER_PARTITION_JAVA_SDK_LIBRARY
871 // if true, enable enforcement
872 // PRODUCT_INTER_PARTITION_JAVA_LIBRARY_ALLOWLIST
873 // exception list of java_library names to allow inter-partition dependency
874 for idx := range j.properties.Libs {
875 if libDeps[idx] == nil {
876 continue
877 }
878
879 if javaDep, ok := libDeps[idx].(javaSdkLibraryEnforceContext); ok {
880 // java_sdk_library is always allowed at inter-partition dependency.
881 // So, skip check.
882 if _, ok := javaDep.(*SdkLibrary); ok {
883 continue
884 }
885
886 j.checkPartitionsForJavaDependency(ctx, "libs", javaDep)
887 }
888 }
889 }
890
891 // For library dependencies that are component libraries (like stubs), add the implementation
892 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
893 for _, dep := range libDeps {
894 if dep != nil {
895 if component, ok := dep.(SdkLibraryComponentDependency); ok {
896 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000897 // Add library as optional if it's one of the optional compatibility libs or it's
898 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100899 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000900 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
901 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100902 tag = usesLibOptTag
903 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100904 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700905 }
906 }
907 }
908 }
909
910 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
911 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
912 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
913
914 android.ProtoDeps(ctx, &j.protoProperties)
915 if j.hasSrcExt(".proto") {
916 protoDeps(ctx, &j.protoProperties)
917 }
918
919 if j.hasSrcExt(".kt") {
920 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
921 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700922 tag := staticLibTag
923 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
924 tag = libTag
925 }
926 ctx.AddVariationDependencies(nil, tag,
927 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700928 }
929
930 // Framework libraries need special handling in static coverage builds: they should not have
931 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
932 // the same jacoco classes coming from different bootclasspath jars.
933 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
934 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
935 j.properties.Instrument = true
936 }
937 } else if j.shouldInstrumentStatic(ctx) {
938 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
939 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700940
Cole Faustb7493472024-08-28 11:55:52 -0700941 if j.useCompose(ctx) {
Colin Crossa1ff7c62021-09-17 14:11:52 -0700942 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
943 "androidx.compose.compiler_compiler-hosted")
944 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700945}
946
947func hasSrcExt(srcs []string, ext string) bool {
948 for _, src := range srcs {
949 if filepath.Ext(src) == ext {
950 return true
951 }
952 }
953
954 return false
955}
956
957func (j *Module) hasSrcExt(ext string) bool {
958 return hasSrcExt(j.properties.Srcs, ext)
959}
960
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100961func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
962 var flags string
963
964 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
965 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
966 flags = "-Wmissing-permission-annotation -Werror"
967 }
968 }
969 return flags
970}
971
Jaewoong Jung26342642021-03-17 15:56:23 -0700972func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000973 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700974
975 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
976 aidlIncludes = append(aidlIncludes,
977 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
978 aidlIncludes = append(aidlIncludes,
979 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
980
981 var flags []string
982 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000983 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700984
985 flags = append(flags, j.deviceProperties.Aidl.Flags...)
986
987 if aidlPreprocess.Valid() {
988 flags = append(flags, "-p"+aidlPreprocess.String())
989 deps = append(deps, aidlPreprocess.Path())
990 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000991 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700992 }
993
994 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000995 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700996 }
997
998 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000999 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001000 }
1001
Sam Delmerico2351eac2022-05-24 17:10:02 +00001002 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -07001003 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +00001004 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -07001005 }
Sam Delmerico2351eac2022-05-24 17:10:02 +00001006 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
1007 // add flags for dirs containing AIDL srcs that haven't been specified yet
1008 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -07001009
Zim8774ae12022-08-17 11:46:34 +01001010 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +00001011 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +01001012 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001013 flags = append(flags, "-t")
1014 }
1015
1016 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
1017 flags = append(flags, "--transaction_names")
1018 }
1019
Thiébaud Weksteende8417c2022-02-10 15:41:46 +11001020 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
1021 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
1022 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1023 }
1024
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001025 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001026 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1027
Jaewoong Jung26342642021-03-17 15:56:23 -07001028 return strings.Join(flags, " "), deps
1029}
1030
1031func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1032
1033 var flags javaBuilderFlags
1034
1035 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001036 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001037
Cole Faust2b1536e2021-06-18 12:25:54 -07001038 epEnabled := j.properties.Errorprone.Enabled
1039 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001040 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001041 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1042 }
1043
1044 errorProneFlags := []string{
1045 "-Xplugin:ErrorProne",
1046 "${config.ErrorProneChecks}",
1047 }
1048 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1049
Colin Cross8bf6cad2022-02-28 13:07:03 -08001050 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001051 "'" + strings.Join(errorProneFlags, " ") + "'"
1052 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1053 }
1054
1055 // classpath
1056 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1057 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001058 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001059 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1060 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1061 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1062
1063 flags.processors = append(flags.processors, deps.processorClasses...)
1064 flags.processors = android.FirstUniqueStrings(flags.processors)
1065
1066 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001067 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001068 // Give host-side tools a version of OpenJDK's standard libraries
1069 // close to what they're targeting. As of Dec 2017, AOSP is only
1070 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1071 //
1072 // When building with OpenJDK 8, the following should have no
1073 // effect since those jars would be available by default.
1074 //
1075 // When building with OpenJDK 9 but targeting a version < 1.8,
1076 // putting them on the bootclasspath means that:
1077 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1078 // b) references to existing APIs are not reinterpreted in an
1079 // OpenJDK 9-specific way, eg. calls to subclasses of
1080 // java.nio.Buffer as in http://b/70862583
1081 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1082 flags.bootClasspath = append(flags.bootClasspath,
1083 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1084 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1085 if Bool(j.properties.Use_tools_jar) {
1086 flags.bootClasspath = append(flags.bootClasspath,
1087 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1088 }
1089 }
1090
1091 // systemModules
1092 flags.systemModules = deps.systemModules
1093
Jaewoong Jung26342642021-03-17 15:56:23 -07001094 return flags
1095}
1096
1097func (j *Module) collectJavacFlags(
1098 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1099 // javac flags.
1100 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001101 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001102
Mythri Alle4b9f6182023-10-25 15:17:11 +00001103 needsDebugInfo = false
1104 for _, flag := range javacFlags {
1105 if strings.HasPrefix(flag, "-g") {
1106 needsDebugInfo = true
1107 }
1108 }
1109
1110 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001111 // For non-host binaries, override the -g flag passed globally to remove
1112 // local variable debug info to reduce disk and memory usage.
1113 javacFlags = append(javacFlags, "-g:source,lines")
1114 }
1115 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1116
1117 if flags.javaVersion.usesJavaModules() {
1118 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001119 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1120 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1121 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1122 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001123
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001124 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001125 if j.properties.Patch_module != nil {
1126 // Manually specify build directory in case it is not under the repo root.
1127 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1128 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001129 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001130
Jaewoong Jung26342642021-03-17 15:56:23 -07001131 classPath := flags.classpath.FormJavaClassPath("")
1132 if classPath != "" {
1133 patchPaths = append(patchPaths, classPath)
1134 }
1135 javacFlags = append(
1136 javacFlags,
1137 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1138 }
1139 }
1140
1141 if len(javacFlags) > 0 {
1142 // optimization.
1143 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1144 flags.javacFlags = "$javacFlags"
1145 }
1146
1147 return flags
1148}
1149
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001150func (j *Module) AddJSONData(d *map[string]interface{}) {
1151 (&j.ModuleBase).AddJSONData(d)
1152 (*d)["Java"] = map[string]interface{}{
1153 "SourceExtensions": j.sourceExtensions,
1154 }
1155
1156}
1157
usta0391ca42023-09-19 15:51:59 -04001158func (j *Module) addGeneratedSrcJars(path android.Path) {
1159 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001160}
1161
Colin Cross4eae06d2023-06-20 22:40:02 -07001162func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001163 // Auto-propagating jarjar rules
1164 jarjarProviderData := j.collectJarJarRules(ctx)
1165 if jarjarProviderData != nil {
1166 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wang9bdd4222024-02-26 18:21:01 -08001167 if !proptools.Bool(j.properties.Skip_jarjar_repackage) {
1168 text := getJarJarRuleText(jarjarProviderData)
1169 if text != "" {
1170 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1171 android.WriteFileRule(ctx, ruleTextFile, text)
1172 j.repackageJarjarRules = ruleTextFile
1173 }
Joe Onorato349ae8d2024-02-05 22:46:00 +00001174 }
1175 }
1176
Jaewoong Jung26342642021-03-17 15:56:23 -07001177 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1178
Makoto Onuki7ded3822024-03-28 14:42:20 -07001179 if re := proptools.Bool(j.properties.Ravenizer.Enabled); re {
1180 j.ravenizer.enabled = re
1181 }
1182
Jaewoong Jung26342642021-03-17 15:56:23 -07001183 deps := j.collectDeps(ctx)
1184 flags := j.collectBuilderFlags(ctx, deps)
1185
1186 if flags.javaVersion.usesJavaModules() {
1187 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001188 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1189 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1190 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001191 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001192
Jaewoong Jung26342642021-03-17 15:56:23 -07001193 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001194 j.sourceExtensions = []string{}
1195 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1196 if hasSrcExt(srcFiles.Strings(), ext) {
1197 j.sourceExtensions = append(j.sourceExtensions, ext)
1198 }
1199 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001200 if hasSrcExt(srcFiles.Strings(), ".proto") {
1201 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1202 }
1203
1204 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1205 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1206 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1207 }
1208
Sam Delmerico2351eac2022-05-24 17:10:02 +00001209 aidlSrcs := srcFiles.FilterByExt(".aidl")
1210 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1211
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001212 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001213 srcFiles = j.genSources(ctx, srcFiles, flags)
1214
1215 // Collect javac flags only after computing the full set of srcFiles to
1216 // ensure that the --patch-module lookup paths are complete.
1217 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1218
1219 srcJars := srcFiles.FilterByExt(".srcjar")
1220 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001221 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001222 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001223 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001224
1225 if j.properties.Jarjar_rules != nil {
1226 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1227 }
1228
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001229 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001230
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001231 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001232 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001233 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001234 if _, found := set[v.String()]; !found {
1235 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001236 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001237 }
1238 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001239 var uniqueKtFiles android.Paths
1240 for _, v := range srcFiles.FilterByExt(".kt") {
1241 if _, found := set[v.String()]; !found {
1242 set[v.String()] = true
1243 uniqueKtFiles = append(uniqueKtFiles, v)
1244 }
1245 }
1246
1247 var uniqueSrcFiles android.Paths
1248 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1249 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1250 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001251 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001252
Colin Crossb5db4012022-03-28 17:12:39 -07001253 // We don't currently run annotation processors in turbine, which means we can't use turbine
1254 // generated header jars when an annotation processor that generates API is enabled. One
1255 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1256 // is used to run all of the annotation processors.
1257 disableTurbine := deps.disableTurbine
1258
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001259 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001260 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1261
1262 var kotlinJars android.Paths
Colin Cross220a9a12022-03-28 17:08:01 -07001263 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001264
Colin Cross4eae06d2023-06-20 22:40:02 -07001265 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1266 // any dependencies so that it can override any non-final R classes from dependencies with the
1267 // final R classes from the app.
1268 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1269
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001270 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1271
Mark Whitea15790a2023-08-22 21:28:11 +00001272 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001273 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001274 if srcFiles.HasExt(".kt") {
1275 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1276 }
1277 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1278 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1279 }
1280
Colin Crossedec77c2024-07-26 15:25:40 -07001281 _, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
1282 extraCombinedJars)
1283
1284 combinedHeaderJarFile = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1285 combinedHeaderJarFile = j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
Mark Whitea15790a2023-08-22 21:28:11 +00001286 if ctx.Failed() {
1287 return
1288 }
Colin Crossedec77c2024-07-26 15:25:40 -07001289 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001290
Colin Crossa6182ab2024-08-21 10:47:44 -07001291 ctx.CheckbuildFile(j.headerJarFile)
1292
Colin Cross7727c7f2024-07-18 15:36:32 -07001293 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001294 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
Colin Cross9ffaf282024-08-12 13:50:09 -07001295 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1296 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001297 AidlIncludeDirs: j.exportAidlIncludeDirs,
1298 ExportedPlugins: j.exportedPluginJars,
1299 ExportedPluginClasses: j.exportedPluginClasses,
1300 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1301 StubsLinkType: j.stubsLinkType,
1302 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001303 })
1304
1305 j.outputFile = j.headerJarFile
1306 return
1307 }
1308
Jaewoong Jung26342642021-03-17 15:56:23 -07001309 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001310 // When using kotlin sources turbine is used to generate annotation processor sources,
1311 // including for annotation processors that generate API, so we can use turbine for
1312 // java sources too.
1313 disableTurbine = false
1314
Jaewoong Jung26342642021-03-17 15:56:23 -07001315 // user defined kotlin flags.
1316 kotlincFlags := j.properties.Kotlincflags
1317 CheckKotlincFlags(ctx, kotlincFlags)
1318
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001319 // Workaround for KT-46512
1320 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001321
1322 // If there are kotlin files, compile them first but pass all the kotlin and java files
1323 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1324 // won't emit any classes for them.
1325 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1326 if ctx.Device() {
1327 kotlincFlags = append(kotlincFlags, "-no-jdk")
1328 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001329
1330 for _, plugin := range deps.kotlinPlugins {
1331 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1332 }
1333 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1334
Jaewoong Jung26342642021-03-17 15:56:23 -07001335 if len(kotlincFlags) > 0 {
1336 // optimization.
1337 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1338 flags.kotlincFlags += "$kotlincFlags"
1339 }
1340
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001341 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001342 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1343
Jaewoong Jung26342642021-03-17 15:56:23 -07001344 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1345 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1346
Isaac Chioua23d9942022-04-06 06:14:38 +00001347 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001348 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001349 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1350 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001351 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001352 srcJars = append(srcJars, kaptSrcJar)
1353 kotlinJars = append(kotlinJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001354 // Disable annotation processing in javac, it's already been handled by kapt
1355 flags.processorPath = nil
1356 flags.processors = nil
1357 }
1358
1359 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001360 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001361 kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001362 if ctx.Failed() {
1363 return
1364 }
1365
Colin Cross7707b242024-07-26 12:02:36 -07001366 kotlinJarPath := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001367
Isaac Chioua23d9942022-04-06 06:14:38 +00001368 // Make javac rule depend on the kotlinc rule
1369 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1370
Zi Wangddb2ee52024-04-02 16:44:02 +00001371 kotlinJars = append(kotlinJars, kotlinJarPath)
Colin Cross220a9a12022-03-28 17:08:01 -07001372 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001373 }
1374
Colin Crossfd620b22024-02-23 10:05:21 -08001375 jars := slices.Clone(kotlinJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001376
Jaewoong Jung26342642021-03-17 15:56:23 -07001377 j.compiledSrcJars = srcJars
1378
1379 enableSharding := false
Colin Cross3d56ed52021-11-18 22:23:12 -08001380 var headerJarFileWithoutDepsOrJarjar android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001381 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001382 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1383 enableSharding = true
1384 // Formerly, there was a check here that prevented annotation processors
1385 // from being used when sharding was enabled, as some annotation processors
1386 // do not function correctly in sharded environments. It was removed to
1387 // allow for the use of annotation processors that do function correctly
1388 // with sharding enabled. See: b/77284273.
1389 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001390 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001391 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001392 var combinedHeaderJarFile android.Path
1393 headerJarFileWithoutDepsOrJarjar, combinedHeaderJarFile =
Colin Cross4eae06d2023-06-20 22:40:02 -07001394 j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
Colin Crossedec77c2024-07-26 15:25:40 -07001395
1396 j.headerJarFile = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1397 j.repackagedHeaderJarFile = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
Jaewoong Jung26342642021-03-17 15:56:23 -07001398 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001399 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001400 hasErrorproneableFiles := false
1401 for _, ext := range j.sourceExtensions {
1402 if ext != ".proto" && ext != ".aidl" {
1403 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1404 // compile, and it's not useful to have warnings on these generated sources.
1405 hasErrorproneableFiles = true
1406 break
1407 }
1408 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001409 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001410 if Bool(j.properties.Errorprone.Enabled) {
1411 // If error-prone is enabled, enable errorprone flags on the regular
1412 // build.
1413 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001414 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001415 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1416 // a new jar file just for compiling with the errorprone compiler to.
1417 // This is because we don't want to cause the java files to get completely
1418 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1419 // We also don't want to run this if errorprone is enabled by default for
1420 // this module, or else we could have duplicated errorprone messages.
1421 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001422 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001423 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001424
Vadim Spivak3c496f02023-06-08 06:14:59 +00001425 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001426 "errorprone", "errorprone")
1427
Jaewoong Jung26342642021-03-17 15:56:23 -07001428 extraJarDeps = append(extraJarDeps, errorprone)
1429 }
1430
1431 if enableSharding {
Colin Cross3d56ed52021-11-18 22:23:12 -08001432 if headerJarFileWithoutDepsOrJarjar != nil {
1433 flags.classpath = append(classpath{headerJarFileWithoutDepsOrJarjar}, flags.classpath...)
1434 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001435 shardSize := int(*(j.properties.Javac_shard_size))
1436 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001437 if len(uniqueJavaFiles) > 0 {
1438 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001439 for idx, shardSrc := range shardSrcs {
1440 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1441 nil, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001442 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
Jaewoong Jung26342642021-03-17 15:56:23 -07001443 jars = append(jars, classes)
1444 }
1445 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001446 // Assume approximately 5 sources per srcjar.
1447 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1448 // 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 -07001449 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001450 startIdx := len(shardSrcs)
1451 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1452 for idx, shardSrcJars := range shardSrcJarsList {
1453 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1454 nil, shardSrcJars, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001455 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
Colin Crossa052ddb2023-09-25 21:46:58 -07001456 jars = append(jars, classes)
1457 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001458 }
1459 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001460 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001461 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
Jaewoong Jung26342642021-03-17 15:56:23 -07001462 jars = append(jars, classes)
1463 }
1464 if ctx.Failed() {
1465 return
1466 }
1467 }
1468
Colin Crossfd620b22024-02-23 10:05:21 -08001469 jars = append(jars, extraCombinedJars...)
1470
Jaewoong Jung26342642021-03-17 15:56:23 -07001471 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1472
1473 var includeSrcJar android.WritablePath
1474 if Bool(j.properties.Include_srcs) {
1475 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1476 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1477 }
1478
1479 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1480 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1481 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1482 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1483
1484 var resArgs []string
1485 var resDeps android.Paths
1486
1487 resArgs = append(resArgs, dirArgs...)
1488 resDeps = append(resDeps, dirDeps...)
1489
1490 resArgs = append(resArgs, fileArgs...)
1491 resDeps = append(resDeps, fileDeps...)
1492
1493 resArgs = append(resArgs, extraArgs...)
1494 resDeps = append(resDeps, extraDeps...)
1495
1496 if len(resArgs) > 0 {
1497 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1498 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
1499 j.resourceJar = resourceJar
1500 if ctx.Failed() {
1501 return
1502 }
1503 }
1504
1505 var resourceJars android.Paths
1506 if j.resourceJar != nil {
1507 resourceJars = append(resourceJars, j.resourceJar)
1508 }
1509 if Bool(j.properties.Include_srcs) {
1510 resourceJars = append(resourceJars, includeSrcJar)
1511 }
1512 resourceJars = append(resourceJars, deps.staticResourceJars...)
1513
1514 if len(resourceJars) > 1 {
1515 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1516 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1517 false, nil, nil)
1518 j.resourceJar = combinedJar
1519 } else if len(resourceJars) == 1 {
1520 j.resourceJar = resourceJars[0]
1521 }
1522
1523 if len(deps.staticJars) > 0 {
1524 jars = append(jars, deps.staticJars...)
1525 }
1526
1527 manifest := j.overrideManifest
1528 if !manifest.Valid() && j.properties.Manifest != nil {
1529 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
1530 }
1531
1532 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1533 if len(services) > 0 {
1534 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1535 var zipargs []string
1536 for _, file := range services {
1537 serviceFile := file.String()
1538 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1539 }
1540 rule := zip
1541 args := map[string]string{
1542 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1543 }
1544 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1545 rule = zipRE
1546 args["implicits"] = strings.Join(services.Strings(), ",")
1547 }
1548 ctx.Build(pctx, android.BuildParams{
1549 Rule: rule,
1550 Output: servicesJar,
1551 Implicits: services,
1552 Args: args,
1553 })
1554 jars = append(jars, servicesJar)
1555 }
1556
1557 // Combine the classes built from sources, any manifests, and any static libraries into
1558 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001559 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001560
1561 if len(jars) == 1 && !manifest.Valid() {
1562 // Optimization: skip the combine step as there is nothing to do
1563 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1564 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1565 // any if len(jars) == 1.
1566
Jihoon Kang1147b312023-06-08 23:25:57 +00001567 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1568 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1569 // either with .from-source or .from-text suffix.
1570 // outputFile should be agnostic to the build configuration,
1571 // thus "combine" the single static lib in order to prevent the static lib from being exposed
1572 // to the copy rules.
Jihoon Kangfa3f0782024-08-21 20:42:18 +00001573 stub, _ := moduleStubLinkType(j)
Jihoon Kang1147b312023-06-08 23:25:57 +00001574
Colin Cross7707b242024-07-26 12:02:36 -07001575 if stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07001576 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1577 ctx.Build(pctx, android.BuildParams{
1578 Rule: android.Cp,
1579 Input: jars[0],
1580 Output: combinedJar,
1581 })
Colin Cross7707b242024-07-26 12:02:36 -07001582 outputFile = combinedJar
1583 } else {
1584 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001585 }
1586 } else {
1587 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1588 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1589 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001590 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001591 }
1592
1593 // jarjar implementation jar if necessary
Colin Crossedec77c2024-07-26 15:25:40 -07001594 jarjarFile := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1595 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001596
Colin Crossedec77c2024-07-26 15:25:40 -07001597 // jarjar resource jar if necessary
1598 if j.resourceJar != nil {
1599 resourceJarJarFile := j.jarjarIfNecessary(ctx, j.resourceJar, jarName, "resource")
1600 j.resourceJar = resourceJarJarFile
1601 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001602
Colin Crossedec77c2024-07-26 15:25:40 -07001603 if ctx.Failed() {
1604 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001605 }
1606
Makoto Onuki7ded3822024-03-28 14:42:20 -07001607 if j.ravenizer.enabled {
1608 ravenizerInput := outputFile
1609 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", jarName)
1610 ctx.Build(pctx, android.BuildParams{
1611 Rule: ravenizer,
1612 Description: "ravenizer",
1613 Input: ravenizerInput,
1614 Output: ravenizerOutput,
1615 })
1616 outputFile = ravenizerOutput
1617 }
1618
Yihan Dong8be09c22024-08-29 15:32:13 +08001619 if j.shouldApiMapper() {
1620 inputFile := outputFile
1621 apiMapperFile := android.PathForModuleOut(ctx, "apimapper", jarName)
1622 ctx.Build(pctx, android.BuildParams{
1623 Rule: apimapper,
1624 Description: "apimapper",
1625 Input: inputFile,
1626 Output: apiMapperFile,
1627 })
1628 outputFile = apiMapperFile
1629 }
1630
Jaewoong Jung26342642021-03-17 15:56:23 -07001631 // Check package restrictions if necessary.
1632 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001633 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001634 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001635
1636 // Create a rule to copy the output jar to another path and add a validate dependency that
1637 // will check that the jar only contains the permitted packages. The new location will become
1638 // the output file of this module.
1639 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001640 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001641 ctx.Build(pctx, android.BuildParams{
1642 Rule: android.Cp,
1643 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001644 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001645 // Make sure that any dependency on the output file will cause ninja to run the package check
1646 // rule.
1647 Validation: pkgckFile,
1648 })
Colin Cross7707b242024-07-26 12:02:36 -07001649 outputFile = packageCheckOutputFile
Paul Duffin08a18bf2021-10-01 13:19:58 +01001650
1651 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001652 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001653
1654 if ctx.Failed() {
1655 return
1656 }
1657 }
1658
1659 j.implementationJarFile = outputFile
1660 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001661 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1662 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1663 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1664 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1665 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1666 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1667 j.headerJarFile = headerJarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001668 }
1669
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001670 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1671 specs := j.jacocoModuleToZipCommand(ctx)
1672 if ctx.Failed() {
1673 return
1674 }
1675
Jaewoong Jung26342642021-03-17 15:56:23 -07001676 if j.shouldInstrument(ctx) {
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001677 outputFile = j.instrument(ctx, flags, outputFile, jarName, specs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001678 }
1679
1680 // merge implementation jar with resources if necessary
1681 implementationAndResourcesJar := outputFile
1682 if j.resourceJar != nil {
1683 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Colin Cross7707b242024-07-26 12:02:36 -07001684 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001685 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
1686 false, nil, nil)
1687 implementationAndResourcesJar = combinedJar
1688 }
1689
1690 j.implementationAndResourcesJar = implementationAndResourcesJar
1691
1692 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001693 compileDex := j.dexProperties.Compile_dex
Colin Crossff694a82023-12-13 15:54:49 -08001694 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -07001695 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001696 if compileDex == nil {
1697 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001698 }
1699 if j.deviceProperties.Hostdex == nil {
1700 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1701 }
1702 }
1703
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001704 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001705 if j.hasCode(ctx) {
1706 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001707 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001708 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1709 }
1710 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001711 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001712 params := &compileDexParams{
1713 flags: flags,
1714 sdkVersion: j.SdkVersion(ctx),
1715 minSdkVersion: j.MinSdkVersion(ctx),
1716 classesJar: implementationAndResourcesJar,
1717 jarName: jarName,
1718 }
Spandan Das15a67112024-05-30 00:07:40 +00001719 if j.GetProfileGuided() && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting() {
1720 ctx.PropertyErrorf("enable_profile_rewriting",
1721 "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.",
1722 )
1723 }
Spandan Das3dbda182024-05-20 22:23:10 +00001724 if j.EnableProfileRewriting() {
1725 profile := j.GetProfile()
1726 if profile == "" || !j.GetProfileGuided() {
1727 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1728 }
1729 params.artProfileInput = &profile
1730 }
1731 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001732 if ctx.Failed() {
1733 return
1734 }
1735
Spandan Das3dbda182024-05-20 22:23:10 +00001736 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1737 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001738 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001739 }
1740
Jaewoong Jung26342642021-03-17 15:56:23 -07001741 // merge dex jar with resources if necessary
1742 if j.resourceJar != nil {
1743 jars := android.Paths{dexOutputFile, j.resourceJar}
Colin Cross7707b242024-07-26 12:02:36 -07001744 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001745 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1746 false, nil, nil)
1747 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001748 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001749 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001750 dexOutputFile = combinedAlignedJar
1751 } else {
1752 dexOutputFile = combinedJar
1753 }
1754 }
1755
Paul Duffin4de94502021-05-16 05:21:16 +01001756 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001757
1758 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001759
1760 // Encode hidden API flags in dex file, if needed.
1761 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1762
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001763 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001764
1765 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001766 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1767 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1768 libName = strings.TrimSuffix(libName, ".impl")
1769 }
1770 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001771
1772 outputFile = dexOutputFile
Colin Crossa6182ab2024-08-21 10:47:44 -07001773
1774 ctx.CheckbuildFile(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001775 } else {
1776 // There is no code to compile into a dex jar, make sure the resources are propagated
1777 // to the APK if this is an app.
1778 outputFile = implementationAndResourcesJar
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001779 j.dexJarFile = makeDexJarPathFromPath(j.resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001780 }
1781
1782 if ctx.Failed() {
1783 return
1784 }
1785 } else {
1786 outputFile = implementationAndResourcesJar
1787 }
1788
1789 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001790 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001791 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001792 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001793 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001794 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001795 }
1796 }
1797
1798 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001799 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1800 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001801 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1802 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001803 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001804 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001805 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001806 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001807 j.linter.javaLanguageLevel = flags.javaVersion.String()
1808 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001809 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001810 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1811 j.linter.buildModuleReportZip = true
1812 }
1813 j.linter.lint(ctx)
1814 }
1815
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001816 j.collectTransitiveSrcFiles(ctx, srcFiles)
1817
Colin Crossa6182ab2024-08-21 10:47:44 -07001818 ctx.CheckbuildFile(j.implementationJarFile)
1819 ctx.CheckbuildFile(j.headerJarFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001820
Colin Cross7727c7f2024-07-18 15:36:32 -07001821 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001822 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1823 RepackagedHeaderJars: android.PathsIfNonNil(j.repackagedHeaderJarFile),
Colin Cross9ffaf282024-08-12 13:50:09 -07001824 TransitiveLibsHeaderJarsForR8: j.transitiveLibsHeaderJarsForR8,
1825 TransitiveStaticLibsHeaderJarsForR8: j.transitiveStaticLibsHeaderJarsForR8,
Jihoon Kang705e63e2024-03-13 01:21:16 +00001826 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1827 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
1828 ResourceJars: android.PathsIfNonNil(j.resourceJar),
1829 AidlIncludeDirs: j.exportAidlIncludeDirs,
1830 SrcJarArgs: j.srcJarArgs,
1831 SrcJarDeps: j.srcJarDeps,
1832 TransitiveSrcFiles: j.transitiveSrcFiles,
1833 ExportedPlugins: j.exportedPluginJars,
1834 ExportedPluginClasses: j.exportedPluginClasses,
1835 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1836 JacocoReportClassesFile: j.jacocoReportClassesFile,
1837 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001838 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001839 })
1840
1841 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1842 j.outputFile = outputFile.WithoutRel()
1843}
1844
Cole Faustb7493472024-08-28 11:55:52 -07001845func (j *Module) useCompose(ctx android.BaseModuleContext) bool {
1846 return android.InList("androidx.compose.runtime_runtime", j.staticLibs(ctx))
Colin Crossa1ff7c62021-09-17 14:11:52 -07001847}
1848
Colin Crosscde55342024-03-27 14:11:51 -07001849func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []*android.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001850 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001851 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001852 depTag := ctx.OtherModuleDependencyTag(m)
1853
1854 if depProguardInfo.UnconditionallyExportedProguardFlags != nil {
1855 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1856 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1857 }
1858
1859 if depTag == staticLibTag && depProguardInfo.ProguardFlagsFiles != nil {
1860 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1861 }
1862 })
1863
Colin Crosscde55342024-03-27 14:11:51 -07001864 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1865}
1866
1867func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1868 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1869
Sam Delmerico95d70942023-08-02 18:00:35 -04001870 directUnconditionalExportedFlags := android.Paths{}
1871 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1872 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1873 if exportUnconditionally {
1874 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1875 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1876 directUnconditionalExportedFlags = proguardFlagsForThisModule
1877 }
1878
1879 return ProguardSpecInfo{
1880 Export_proguard_flags_files: exportUnconditionally,
1881 ProguardFlagsFiles: android.NewDepSet[android.Path](
1882 android.POSTORDER,
1883 proguardFlagsForThisModule,
1884 transitiveProguardFlags,
1885 ),
1886 UnconditionallyExportedProguardFlags: android.NewDepSet[android.Path](
1887 android.POSTORDER,
1888 directUnconditionalExportedFlags,
1889 transitiveUnconditionalExportedFlags,
1890 ),
1891 }
1892
1893}
1894
Cole Faust75fffb12021-06-13 15:23:16 -07001895// Returns a copy of the supplied flags, but with all the errorprone-related
1896// fields copied to the regular build's fields.
1897func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1898 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1899
1900 if len(flags.errorProneExtraJavacFlags) > 0 {
1901 if len(flags.javacFlags) > 0 {
1902 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
1903 } else {
1904 flags.javacFlags = flags.errorProneExtraJavacFlags
1905 }
1906 }
1907 return flags
1908}
1909
Jaewoong Jung26342642021-03-17 15:56:23 -07001910func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07001911 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07001912
1913 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00001914 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001915 if idx >= 0 {
1916 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00001917 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001918 jarName += strconv.Itoa(idx)
1919 }
1920
Colin Cross7707b242024-07-26 12:02:36 -07001921 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001922 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001923
Cole Faust9decf832024-06-11 11:45:53 -07001924 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001925 extractionFile := android.PathForModuleOut(ctx, kzipName)
1926 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1927 j.kytheFiles = append(j.kytheFiles, extractionFile)
1928 }
1929
Vadim Spivak3c496f02023-06-08 06:14:59 +00001930 if len(flags.processorPath) > 0 {
1931 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
1932 }
1933
Jaewoong Jung26342642021-03-17 15:56:23 -07001934 return classes
1935}
1936
1937// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1938// since some of these flags may be used internally.
1939func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1940 for _, flag := range flags {
1941 flag = strings.TrimSpace(flag)
1942
1943 if !strings.HasPrefix(flag, "-") {
1944 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1945 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1946 ctx.PropertyErrorf("kotlincflags",
1947 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1948 } else if inList(flag, config.KotlincIllegalFlags) {
1949 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1950 } else if flag == "-include-runtime" {
1951 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1952 } else {
1953 args := strings.Split(flag, " ")
1954 if args[0] == "-kotlin-home" {
1955 ctx.PropertyErrorf("kotlincflags",
1956 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1957 }
1958 }
1959 }
1960}
1961
1962func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
1963 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossedec77c2024-07-26 15:25:40 -07001964 extraJars android.Paths) (headerJar android.Path, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001965
1966 var jars android.Paths
1967 if len(srcFiles) > 0 || len(srcJars) > 0 {
1968 // Compile java sources into turbine.jar.
1969 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1970 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001971 jars = append(jars, turbineJar)
Colin Cross3d56ed52021-11-18 22:23:12 -08001972 headerJar = turbineJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001973 }
1974
1975 jars = append(jars, extraJars...)
1976
1977 // Combine any static header libraries into classes-header.jar. If there is only
1978 // one input jar this step will be skipped.
1979 jars = append(jars, deps.staticHeaderJars...)
1980
1981 // we cannot skip the combine step for now if there is only one jar
1982 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07001983 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
1984 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001985 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07001986
Colin Crossa6182ab2024-08-21 10:47:44 -07001987 ctx.CheckbuildFile(combinedHeaderJarOutputPath)
1988
Colin Crossedec77c2024-07-26 15:25:40 -07001989 return headerJar, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07001990}
1991
1992func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07001993 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07001994
1995 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07001996 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001997
1998 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1999
2000 j.jacocoReportClassesFile = jacocoReportClassesFile
2001
2002 return instrumentedJar
2003}
2004
Colin Cross9ffaf282024-08-12 13:50:09 -07002005type providesTransitiveHeaderJarsForR8 struct {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002006 // set of header jars for all transitive libs deps
Colin Cross9ffaf282024-08-12 13:50:09 -07002007 transitiveLibsHeaderJarsForR8 *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002008 // set of header jars for all transitive static libs deps
Colin Cross9ffaf282024-08-12 13:50:09 -07002009 transitiveStaticLibsHeaderJarsForR8 *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002010}
2011
Colin Cross9ffaf282024-08-12 13:50:09 -07002012// collectTransitiveHeaderJarsForR8 visits direct dependencies and collects all transitive libs and static_libs
2013// header jars. The semantics of the collected jars are odd (it collects combined jars that contain the static
2014// libs, but also the static libs, and it collects transitive libs dependencies of static_libs), so these
2015// are only used to expand the --lib arguments to R8.
2016func (j *providesTransitiveHeaderJarsForR8) collectTransitiveHeaderJarsForR8(ctx android.ModuleContext) {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002017 directLibs := android.Paths{}
2018 directStaticLibs := android.Paths{}
Colin Crossc85750b2022-04-21 12:50:51 -07002019 transitiveLibs := []*android.DepSet[android.Path]{}
2020 transitiveStaticLibs := []*android.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002021 ctx.VisitDirectDeps(func(module android.Module) {
2022 // don't add deps of the prebuilt version of the same library
2023 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
2024 return
2025 }
2026
Colin Cross7727c7f2024-07-18 15:36:32 -07002027 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2028 tag := ctx.OtherModuleDependencyTag(module)
2029 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2030 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2031 directLibs = append(directLibs, dep.HeaderJars...)
2032 } else if tag == staticLibTag {
2033 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2034 } else {
2035 // Don't propagate transitive libs for other kinds of dependencies.
2036 return
2037 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002038
Colin Cross9ffaf282024-08-12 13:50:09 -07002039 if dep.TransitiveLibsHeaderJarsForR8 != nil {
2040 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJarsForR8)
Colin Cross7727c7f2024-07-18 15:36:32 -07002041 }
Colin Cross9ffaf282024-08-12 13:50:09 -07002042 if dep.TransitiveStaticLibsHeaderJarsForR8 != nil {
2043 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJarsForR8)
Colin Cross7727c7f2024-07-18 15:36:32 -07002044 }
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002045 }
2046 })
Colin Cross9ffaf282024-08-12 13:50:09 -07002047 j.transitiveLibsHeaderJarsForR8 = android.NewDepSet(android.POSTORDER, directLibs, transitiveLibs)
2048 j.transitiveStaticLibsHeaderJarsForR8 = android.NewDepSet(android.POSTORDER, directStaticLibs, transitiveStaticLibs)
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002049}
2050
Jaewoong Jung26342642021-03-17 15:56:23 -07002051func (j *Module) HeaderJars() android.Paths {
2052 if j.headerJarFile == nil {
2053 return nil
2054 }
2055 return android.Paths{j.headerJarFile}
2056}
2057
2058func (j *Module) ImplementationJars() android.Paths {
2059 if j.implementationJarFile == nil {
2060 return nil
2061 }
2062 return android.Paths{j.implementationJarFile}
2063}
2064
Spandan Das59a4a2b2024-01-09 21:35:56 +00002065func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002066 return j.dexJarFile
2067}
2068
2069func (j *Module) DexJarInstallPath() android.Path {
2070 return j.installFile
2071}
2072
2073func (j *Module) ImplementationAndResourcesJars() android.Paths {
2074 if j.implementationAndResourcesJar == nil {
2075 return nil
2076 }
2077 return android.Paths{j.implementationAndResourcesJar}
2078}
2079
2080func (j *Module) AidlIncludeDirs() android.Paths {
2081 // exportAidlIncludeDirs is type android.Paths already
2082 return j.exportAidlIncludeDirs
2083}
2084
2085func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2086 return j.classLoaderContexts
2087}
2088
2089// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002090func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002091 // jarjar rules will repackage the sources. To prevent misleading results, IdeInfo should contain the
2092 // repackaged jar instead of the input sources.
Jaewoong Jung26342642021-03-17 15:56:23 -07002093 if j.expandJarjarRules != nil {
2094 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002095 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
2096 } else {
2097 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2098 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2099 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002100 }
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002101 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2102 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Cole Faustb7493472024-08-28 11:55:52 -07002103 dpInfo.Static_libs = append(dpInfo.Static_libs, j.staticLibs(ctx)...)
Yikef6282022022-04-13 20:41:01 +08002104 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002105}
2106
2107func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002108 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002109}
2110
2111func (j *Module) hasCode(ctx android.ModuleContext) bool {
2112 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2113 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2114}
2115
2116// Implements android.ApexModule
2117func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2118 return j.depIsInSameApex(ctx, dep)
2119}
2120
2121// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002122func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002123 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002124 minSdkVersion := j.MinSdkVersion(ctx)
2125 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002126 return fmt.Errorf("min_sdk_version is not specified")
2127 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002128 // If the module is compiling against core (via sdk_version), skip comparison check.
2129 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002130 return nil
2131 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002132 if minSdkVersion.GreaterThan(sdkVersion) {
2133 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002134 }
2135 return nil
2136}
2137
2138func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002139 if j.stem == "" {
2140 panic("Stem() called before stem property was set")
2141 }
2142 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002143}
2144
Jaewoong Jung26342642021-03-17 15:56:23 -07002145func (j *Module) JacocoReportClassesFile() android.Path {
2146 return j.jacocoReportClassesFile
2147}
2148
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002149func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
2150 var fromDeps []*android.DepSet[android.Path]
2151 ctx.VisitDirectDeps(func(module android.Module) {
2152 tag := ctx.OtherModuleDependencyTag(module)
2153 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002154 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2155 if depInfo.TransitiveSrcFiles != nil {
2156 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
2157 }
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002158 }
2159 }
2160 })
2161
2162 j.transitiveSrcFiles = android.NewDepSet(android.POSTORDER, mine, fromDeps)
2163}
2164
Jaewoong Jung26342642021-03-17 15:56:23 -07002165func (j *Module) IsInstallable() bool {
2166 return Bool(j.properties.Installable)
2167}
2168
2169type sdkLinkType int
2170
2171const (
2172 // TODO(jiyong) rename these for better readability. Make the allowed
2173 // and disallowed link types explicit
2174 // order is important here. See rank()
2175 javaCore sdkLinkType = iota
2176 javaSdk
2177 javaSystem
2178 javaModule
2179 javaSystemServer
2180 javaPlatform
2181)
2182
2183func (lt sdkLinkType) String() string {
2184 switch lt {
2185 case javaCore:
2186 return "core Java API"
2187 case javaSdk:
2188 return "Android API"
2189 case javaSystem:
2190 return "system API"
2191 case javaModule:
2192 return "module API"
2193 case javaSystemServer:
2194 return "system server API"
2195 case javaPlatform:
2196 return "private API"
2197 default:
2198 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2199 }
2200}
2201
2202// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2203// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2204// can't statically depend on modules that use Platform API.
2205func (lt sdkLinkType) rank() int {
2206 return int(lt)
2207}
2208
2209type moduleWithSdkDep interface {
2210 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002211 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002212}
2213
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002214func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2215 switch k {
2216 case android.SdkCore:
2217 return javaCore
2218 case android.SdkSystem:
2219 return javaSystem
2220 case android.SdkPublic:
2221 return javaSdk
2222 case android.SdkModule:
2223 return javaModule
2224 case android.SdkSystemServer:
2225 return javaSystemServer
2226 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2227 return javaPlatform
2228 default:
2229 return javaSdk
2230 }
2231}
2232
Jiyong Park92315372021-04-02 08:45:46 +09002233func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002234 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002235 case android.SdkCore.DefaultJavaLibraryName(),
2236 "legacy.core.platform.api.stubs",
2237 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002238 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002239 "core-lambda-stubs",
Jihoon Kangb5078312023-03-29 23:25:49 +00002240 "core-generated-annotation-stubs":
Jaewoong Jung26342642021-03-17 15:56:23 -07002241 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002242 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002243 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002244 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002245 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002246 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002247 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002248 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002249 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002250 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002251 return javaSystem, true
2252 }
2253
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002254 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002255 return linkType, true
2256 }
2257
Jiyong Park92315372021-04-02 08:45:46 +09002258 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002259 if !ver.Valid() {
2260 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002261 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002262
2263 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002264}
2265
2266// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2267// this module's. See the comment on rank() for details and an example.
2268func (j *Module) checkSdkLinkType(
2269 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2270 if ctx.Host() {
2271 return
2272 }
2273
Jiyong Park92315372021-04-02 08:45:46 +09002274 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002275 if stubs {
2276 return
2277 }
Jiyong Park92315372021-04-02 08:45:46 +09002278 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002279
2280 if myLinkType.rank() < depLinkType.rank() {
2281 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2282 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2283 "property of the source or target module so that target module is built "+
2284 "with the same or smaller API set when compared to the source.",
2285 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2286 }
2287}
2288
2289func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2290 var deps deps
2291
2292 if ctx.Device() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09002293 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07002294 if sdkDep.invalidVersion {
2295 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2296 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2297 } else if sdkDep.useFiles {
2298 // sdkDep.jar is actually equivalent to turbine header.jar.
2299 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002300 deps.dexClasspath = append(deps.dexClasspath, sdkDep.jars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002301 deps.aidlPreprocess = sdkDep.aidl
Spandan Das6e8bd1c2024-08-09 00:07:03 +00002302 // Add the sdk module dependency to `compileDepNames`.
2303 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2304 // TODO (b/358608607): Move this to decodeSdkDep
2305 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2306 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
Jaewoong Jung26342642021-03-17 15:56:23 -07002307 } else {
2308 deps.aidlPreprocess = sdkDep.aidl
2309 }
2310 }
2311
Jiyong Park92315372021-04-02 08:45:46 +09002312 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002313
Colin Cross9ffaf282024-08-12 13:50:09 -07002314 j.collectTransitiveHeaderJarsForR8(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07002315 ctx.VisitDirectDeps(func(module android.Module) {
2316 otherName := ctx.OtherModuleName(module)
2317 tag := ctx.OtherModuleDependencyTag(module)
2318
2319 if IsJniDepTag(tag) {
2320 // Handled by AndroidApp.collectAppDeps
2321 return
2322 }
2323 if tag == certificateTag {
2324 // Handled by AndroidApp.collectAppDeps
2325 return
2326 }
2327
2328 if dep, ok := module.(SdkLibraryDependency); ok {
2329 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002330 case sdkLibTag, libTag:
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002331 depHeaderJars := dep.SdkHeaderJars(ctx, j.SdkVersion(ctx))
2332 deps.classpath = append(deps.classpath, depHeaderJars...)
2333 deps.dexClasspath = append(deps.dexClasspath, depHeaderJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002334 case staticLibTag:
2335 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
2336 }
Colin Cross313aa542023-12-13 13:47:44 -08002337 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2338 if sdkLinkType != javaPlatform {
2339 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2340 // dep is a sysprop implementation library, but this module is not linking against
2341 // the platform, so it gets the sysprop public stubs library instead. Replace
2342 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2343 dep = syspropDep.JavaInfo
2344 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002345 }
2346 switch tag {
2347 case bootClasspathTag:
2348 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002349 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002350 if _, ok := module.(*Plugin); ok {
2351 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2352 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002353 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002354 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002355 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2356 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2357 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2358 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002359 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2360 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2361 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
2362 case java9LibTag:
2363 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
2364 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002365 if _, ok := module.(*Plugin); ok {
2366 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2367 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002368 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2369 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2370 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2371 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2372 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2373 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2374 // Turbine doesn't run annotation processors, so any module that uses an
2375 // annotation processor that generates API is incompatible with the turbine
2376 // optimization.
2377 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002378 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002379 case pluginTag:
2380 if plugin, ok := module.(*Plugin); ok {
2381 if plugin.pluginProperties.Processor_class != nil {
2382 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2383 } else {
2384 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2385 }
2386 // Turbine doesn't run annotation processors, so any module that uses an
2387 // annotation processor that generates API is incompatible with the turbine
2388 // optimization.
2389 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2390 } else {
2391 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2392 }
2393 case errorpronePluginTag:
2394 if _, ok := module.(*Plugin); ok {
2395 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2396 } else {
2397 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2398 }
2399 case exportedPluginTag:
2400 if plugin, ok := module.(*Plugin); ok {
2401 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2402 if plugin.pluginProperties.Processor_class != nil {
2403 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2404 }
2405 // Turbine doesn't run annotation processors, so any module that uses an
2406 // annotation processor that generates API is incompatible with the turbine
2407 // optimization.
2408 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2409 } else {
2410 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2411 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002412 case kotlinPluginTag:
2413 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002414 case syspropPublicStubDepTag:
2415 // This is a sysprop implementation library, forward the JavaInfoProvider from
2416 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002417 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002418 JavaInfo: dep,
2419 })
2420 }
2421 } else if dep, ok := module.(android.SourceFileProducer); ok {
2422 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002423 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002424 checkProducesJars(ctx, dep)
2425 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002426 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002427 case staticLibTag:
2428 checkProducesJars(ctx, dep)
2429 deps.classpath = append(deps.classpath, dep.Srcs()...)
2430 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2431 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
2432 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002433 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002434 switch tag {
2435 case staticLibTag:
2436 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2437 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002438 } else {
2439 switch tag {
2440 case bootClasspathTag:
2441 // If a system modules dependency has been added to the bootclasspath
2442 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002443 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2444 depHeaderJars := sm.HeaderJars
2445 deps.bootClasspath = append(deps.bootClasspath, depHeaderJars...)
2446 } else {
2447 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2448 ctx.OtherModuleName(module))
2449 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002450
2451 case systemModulesTag:
2452 if deps.systemModules != nil {
2453 panic("Found two system module dependencies")
2454 }
Colin Crossb61c2262024-08-08 14:04:42 -07002455 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2456 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2457 } else {
2458 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2459 ctx.OtherModuleName(module))
2460 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002461
2462 case instrumentationForTag:
2463 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 -07002464 }
2465 }
2466
Spandan Das8aac9932024-07-18 23:14:13 +00002467 if android.InList(tag, compileDependencyTags) {
2468 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2469 j.compileDepNames = append(j.compileDepNames, otherName)
2470 }
2471
Jaewoong Jung26342642021-03-17 15:56:23 -07002472 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002473 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002474 })
2475
2476 return deps
2477}
2478
Joe Onorato349ae8d2024-02-05 22:46:00 +00002479// Provider for jarjar renaming rules.
2480//
2481// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2482// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2483// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2484// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2485// be renamed from that module.
2486// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002487type DependencyUse int
2488
2489const (
2490 RenameUseInvalid DependencyUse = iota
2491 RenameUseInclude
2492 RenameUseExclude
2493)
2494
2495type RenameUseElement struct {
2496 DepName string
2497 RenameUse DependencyUse
2498 Why string // token for determining where in the logic the decision was made.
2499}
2500
Joe Onorato349ae8d2024-02-05 22:46:00 +00002501type JarJarProviderData struct {
2502 // Mapping of class names: original --> renamed. If the value is "", the class will be
2503 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2504 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002505 Rename map[string]string
2506 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002507}
2508
2509func (this JarJarProviderData) GetDebugString() string {
2510 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002511 for _, k := range android.SortedKeys(this.Rename) {
2512 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002513 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2514 result += k + "--&gt;" + v + ";"
2515 }
2516 }
2517 return result
2518}
2519
2520var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2521
2522var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2523
2524func init() {
2525 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
Yu Liu26a716d2024-08-30 23:40:32 +00002526
2527 gob.Register(BaseJarJarProviderData{})
Joe Onorato349ae8d2024-02-05 22:46:00 +00002528}
2529
2530// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2531// whether they are java modules or not.
2532type BaseJarJarProviderData struct {
2533 JarJarProviderData JarJarProviderData
2534}
2535
2536func (this BaseJarJarProviderData) GetDebugString() string {
2537 return this.JarJarProviderData.GetDebugString()
2538}
2539
2540var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2541
2542// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2543// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2544// either JarJarProvider or BaseJarJarProvider.
2545func mergeJarJarPrefixes(ctx android.ModuleContext) {
2546 mod := ctx.Module()
2547 // Explicitly avoid propagating into some module types.
2548 switch reflect.TypeOf(mod).String() {
2549 case "*java.Droidstubs":
2550 return
2551 }
2552 jarJarData := collectDirectDepsProviders(ctx)
2553 if jarJarData != nil {
2554 providerData := BaseJarJarProviderData{
2555 JarJarProviderData: *jarJarData,
2556 }
2557 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2558 }
2559
2560}
2561
2562// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2563func (module *Module) addJarJarRenameRule(original string, renamed string) {
2564 if module.jarjarRenameRules == nil {
2565 module.jarjarRenameRules = make(map[string]string)
2566 }
2567 module.jarjarRenameRules[original] = renamed
2568}
2569
2570func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2571 // Gather repackage information from deps
2572 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002573
2574 module := ctx.Module()
2575 moduleName := module.Name()
2576
Joe Onorato349ae8d2024-02-05 22:46:00 +00002577 ctx.VisitDirectDepsIgnoreBlueprint(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002578 tag := ctx.OtherModuleDependencyTag(m)
2579 // This logic mirrors that in (*Module).collectDeps above. There are several places
2580 // where we explicitly return RenameUseExclude, even though it is the default, to
2581 // indicate that it has been verified to be the case.
2582 //
2583 // Note well: there are probably cases that are getting to the unconditional return
2584 // and are therefore wrong.
2585 shouldIncludeRenames := func() (DependencyUse, string) {
2586 if moduleName == m.Name() {
2587 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2588 }
2589 if sc, ok := module.(android.SdkContext); ok {
2590 if ctx.Device() {
2591 sdkDep := decodeSdkDep(ctx, sc)
2592 if !sdkDep.invalidVersion && sdkDep.useFiles {
2593 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002594 }
2595 }
LaMont Jones63683e42024-02-08 14:30:45 -08002596 }
2597 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2598 return RenameUseExclude, "tags"
2599 }
2600 if _, ok := m.(SdkLibraryDependency); ok {
2601 switch tag {
2602 case sdkLibTag, libTag:
2603 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2604 }
2605 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2606 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2607 switch ji.StubsLinkType {
2608 case Stubs:
2609 return RenameUseExclude, "info"
2610 case Implementation:
2611 return RenameUseInclude, "info"
2612 default:
LaMont Jones09721862024-06-11 10:30:50 -07002613 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002614 // Fall through to the heuristic logic.
2615 }
2616 switch reflect.TypeOf(m).String() {
2617 case "*java.GeneratedJavaLibraryModule":
2618 // Probably a java_aconfig_library module.
2619 // TODO: make this check better.
2620 return RenameUseInclude, "reflect"
2621 }
2622 switch tag {
2623 case bootClasspathTag:
2624 return RenameUseExclude, "tagswitch"
2625 case sdkLibTag, libTag, instrumentationForTag:
2626 return RenameUseInclude, "tagswitch"
2627 case java9LibTag:
2628 return RenameUseExclude, "tagswitch"
2629 case staticLibTag:
2630 return RenameUseInclude, "tagswitch"
2631 case pluginTag:
2632 return RenameUseInclude, "tagswitch"
2633 case errorpronePluginTag:
2634 return RenameUseInclude, "tagswitch"
2635 case exportedPluginTag:
2636 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002637 case kotlinPluginTag:
2638 return RenameUseInclude, "tagswitch"
2639 default:
2640 return RenameUseExclude, "tagswitch"
2641 }
2642 } else if _, ok := m.(android.SourceFileProducer); ok {
2643 switch tag {
2644 case sdkLibTag, libTag, staticLibTag:
2645 return RenameUseInclude, "srcfile"
2646 default:
2647 return RenameUseExclude, "srcfile"
2648 }
Yu Liu67a28422024-03-05 00:36:31 +00002649 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002650 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002651 } else {
2652 switch tag {
2653 case bootClasspathTag:
2654 return RenameUseExclude, "else"
2655 case systemModulesTag:
2656 return RenameUseInclude, "else"
2657 }
2658 }
2659 // If we got here, choose the safer option, which may lead to a build failure, rather
2660 // than runtime failures on the device.
2661 return RenameUseExclude, "end"
2662 }
2663
2664 if result == nil {
2665 result = &JarJarProviderData{
2666 Rename: make(map[string]string),
2667 RenameUse: make([]RenameUseElement, 0),
2668 }
2669 }
2670 how, why := shouldIncludeRenames()
2671 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2672 if how != RenameUseInclude {
2673 // Nothing to merge.
2674 return
2675 }
2676
2677 merge := func(theirs *JarJarProviderData) {
2678 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002679 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2680 result.Rename[orig] = renamed
2681 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2682 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2683 result.Rename[orig] = renamed
2684 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2685 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2686 continue
2687 }
2688 }
2689 }
2690 }
2691 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2692 merge(&theirs)
2693 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2694 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2695 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2696 // to java.Module.
2697 merge(&theirs.JarJarProviderData)
2698 }
2699 })
2700 return
2701}
2702
2703func (this Module) GetDebugString() string {
2704 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2705}
2706
2707// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2708// us, and if it's been set, apply the jarjar_prefix property to rename them.
2709func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2710 // Gather repackage information from deps
2711 result := collectDirectDepsProviders(ctx)
2712
Joe Onoratoa5d17172024-07-20 17:39:56 -07002713 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002714 if result == nil {
2715 result = &JarJarProviderData{
2716 Rename: make(map[string]string),
2717 }
2718 }
2719 if renamed != "" {
2720 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2721 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002722 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002723 }
2724 }
2725 (*result).Rename[orig] = renamed
2726 }
2727
Joe Onoratoa5d17172024-07-20 17:39:56 -07002728 // Update that with entries we've stored for ourself
2729 for orig, renamed := range module.jarjarRenameRules {
2730 add(orig, renamed)
2731 }
2732
2733 // Update that with entries given in the jarjar_rename property.
2734 for _, orig := range module.properties.Jarjar_rename {
2735 add(orig, "")
2736 }
2737
Joe Onorato349ae8d2024-02-05 22:46:00 +00002738 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2739 if result == nil {
2740 return nil
2741 }
2742
2743 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2744 // that have not yet been renamed.
2745 prefix := proptools.String(module.properties.Jarjar_prefix)
2746 if prefix != "" {
2747 if prefix[0] == '.' {
2748 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2749 return nil
2750 }
2751 if prefix[len(prefix)-1] == '.' {
2752 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2753 return nil
2754 }
2755
2756 var updated map[string]string
2757 for orig, renamed := range (*result).Rename {
2758 if renamed == "" {
2759 if updated == nil {
2760 updated = make(map[string]string)
2761 }
2762 updated[orig] = prefix + "." + orig
2763 }
2764 }
2765 for orig, renamed := range updated {
2766 (*result).Rename[orig] = renamed
2767 }
2768 }
2769
2770 return result
2771}
2772
2773// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2774// to "" won't be in this list because they shouldn't be renamed yet.
2775func getJarJarRuleText(provider *JarJarProviderData) string {
2776 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002777 for _, orig := range android.SortedKeys(provider.Rename) {
2778 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002779 if renamed != "" {
2780 result += "rule " + orig + " " + renamed + "\n"
2781 }
2782 }
2783 return result
2784}
2785
Zi Wangddb2ee52024-04-02 16:44:02 +00002786// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Cross7707b242024-07-26 12:02:36 -07002787func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) android.Path {
Zi Wangddb2ee52024-04-02 16:44:02 +00002788 if j.repackageJarjarRules == nil {
2789 return infile
2790 }
Colin Crossedec77c2024-07-26 15:25:40 -07002791 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002792 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
2793 return repackagedJarjarFile
2794}
2795
Colin Crossedec77c2024-07-26 15:25:40 -07002796func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) android.Path {
2797 if j.expandJarjarRules == nil {
2798 return infile
2799 }
2800 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2801 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
2802 return jarjarFile
2803
2804}
2805
Jaewoong Jung26342642021-03-17 15:56:23 -07002806func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2807 deps.processorPath = append(deps.processorPath, pluginJars...)
2808 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2809}
2810
2811// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2812// this interface.
2813type ProvidesUsesLib interface {
2814 ProvidesUsesLib() *string
2815}
2816
2817func (j *Module) ProvidesUsesLib() *string {
2818 return j.usesLibraryProperties.Provides_uses_lib
2819}
satayev1c564cc2021-05-25 19:50:30 +01002820
2821type ModuleWithStem interface {
2822 Stem() string
2823}
2824
2825var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002826
2827type ModuleWithUsesLibrary interface {
2828 UsesLibrary() *usesLibrary
2829}
2830
2831func (j *Module) UsesLibrary() *usesLibrary {
2832 return &j.usesLibrary
2833}
2834
2835var _ ModuleWithUsesLibrary = (*Module)(nil)