blob: 62767f4e74e303ee78ef212bd7c4fa23dc10175a [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
84 Static_libs []string `android:"arch_variant"`
85
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"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700237}
238
239// Properties that are specific to device modules. Host module factories should not add these when
240// constructing a new module.
241type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000242 // If not blank, set to the version of the sdk to compile against.
Spandan Das1ccf5742022-10-14 16:51:23 +0000243 // Defaults to an empty string, which compiles the module against the private platform APIs.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000244 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000245 // 1) numerical API level, "current", "none", or "core_platform"
246 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
247 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
248 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700249 Sdk_version *string
250
satayev0a420e72021-11-29 17:25:52 +0000251 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
252 // Defaults to empty string "". See sdk_version for possible values.
253 Max_sdk_version *string
254
William Loh5a082f92022-05-17 20:21:50 +0000255 // if not blank, set the maxSdkVersion properties of permission and uses-permission tags.
256 // Defaults to empty string "". See sdk_version for possible values.
257 Replace_max_sdk_version_placeholder *string
258
Jaewoong Jung26342642021-03-17 15:56:23 -0700259 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000260 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700261 Target_sdk_version *string
262
263 // Whether to compile against the platform APIs instead of an SDK.
264 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000265 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700266 Platform_apis *bool
267
268 Aidl struct {
269 // Top level directories to pass to aidl tool
270 Include_dirs []string
271
272 // Directories rooted at the Android.bp file to pass to aidl tool
273 Local_include_dirs []string
274
275 // directories that should be added as include directories for any aidl sources of modules
276 // that depend on this module, as well as to aidl for this module.
277 Export_include_dirs []string
278
279 // whether to generate traces (for systrace) for this interface
280 Generate_traces *bool
281
282 // whether to generate Binder#GetTransaction name method.
283 Generate_get_transaction_name *bool
284
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100285 // whether all interfaces should be annotated with required permissions.
286 Enforce_permissions *bool
287
288 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
289 Enforce_permissions_exceptions []string `android:"path"`
290
Jaewoong Jung26342642021-03-17 15:56:23 -0700291 // list of flags that will be passed to the AIDL compiler
292 Flags []string
293 }
294
295 // If true, export a copy of the module as a -hostdex module for host testing.
296 Hostdex *bool
297
298 Target struct {
299 Hostdex struct {
300 // Additional required dependencies to add to -hostdex modules.
301 Required []string
302 }
303 }
304
305 // When targeting 1.9 and above, override the modules to use with --system,
306 // otherwise provides defaults libraries to add to the bootclasspath.
307 System_modules *string
308
Jaewoong Jung26342642021-03-17 15:56:23 -0700309 IsSDKLibrary bool `blueprint:"mutated"`
310
311 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
312 // Defaults to false.
313 V4_signature *bool
314
315 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
316 // public stubs library.
317 SyspropPublicStub string `blueprint:"mutated"`
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000318
319 HiddenAPIPackageProperties
320 HiddenAPIFlagFileProperties
Jaewoong Jung26342642021-03-17 15:56:23 -0700321}
322
yangbill2af0b6e2024-03-15 09:29:29 +0000323// Properties that can be overridden by overriding module (e.g. override_android_app)
324type OverridableProperties struct {
Jooyung Han01d80d82022-01-08 12:16:32 +0900325 // set the name of the output. If not set, `name` is used.
326 // To override a module with this property set, overriding module might need to set this as well.
327 // Otherwise, both the overridden and the overriding modules will have the same output name, which
328 // can cause the duplicate output error.
329 Stem *string
Spandan Dasb9c58352024-05-13 18:29:45 +0000330
331 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
332 // Defaults to sdk_version if not set. See sdk_version for possible values.
333 Min_sdk_version *string
Jooyung Han01d80d82022-01-08 12:16:32 +0900334}
335
Jaewoong Jung26342642021-03-17 15:56:23 -0700336// Functionality common to Module and Import
337//
338// It is embedded in Module so its functionality can be used by methods in Module
339// but it is currently only initialized by Import and Library.
340type embeddableInModuleAndImport struct {
341
342 // Functionality related to this being used as a component of a java_sdk_library.
343 EmbeddableSdkLibraryComponent
344}
345
Paul Duffin71b33cc2021-06-23 11:39:47 +0100346func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
347 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700348}
349
350// Module/Import's DepIsInSameApex(...) delegates to this method.
351//
352// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
353// the one provided by ApexModuleBase.
354func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
355 // dependencies other than the static linkage are all considered crossing APEX boundary
356 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
357 return true
358 }
359 return false
360}
361
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100362// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
363// or an invalid path describing the reason it is invalid.
364//
365// It is unset if a dex jar isn't applicable, i.e. no build rule has been
366// requested to create one.
367//
368// If a dex jar has been requested to be built then it is set, and it may be
369// either a valid android.Path, or invalid with a reason message. The latter
370// happens if the source that should produce the dex file isn't able to.
371//
372// E.g. it is invalid with a reason message if there is a prebuilt APEX that
373// could produce the dex jar through a deapexer module, but the APEX isn't
374// installable so doing so wouldn't be safe.
375type OptionalDexJarPath struct {
376 isSet bool
377 path android.OptionalPath
378}
379
380// IsSet returns true if a path has been set, either invalid or valid.
381func (o OptionalDexJarPath) IsSet() bool {
382 return o.isSet
383}
384
385// Valid returns true if there is a path that is valid.
386func (o OptionalDexJarPath) Valid() bool {
387 return o.isSet && o.path.Valid()
388}
389
390// Path returns the valid path, or panics if it's either not set or is invalid.
391func (o OptionalDexJarPath) Path() android.Path {
392 if !o.isSet {
393 panic("path isn't set")
394 }
395 return o.path.Path()
396}
397
398// PathOrNil returns the path if it's set and valid, or else nil.
399func (o OptionalDexJarPath) PathOrNil() android.Path {
400 if o.Valid() {
401 return o.Path()
402 }
403 return nil
404}
405
406// InvalidReason returns the reason for an invalid path, which is never "". It
407// returns "" for an unset or valid path.
408func (o OptionalDexJarPath) InvalidReason() string {
409 if !o.isSet {
410 return ""
411 }
412 return o.path.InvalidReason()
413}
414
415func (o OptionalDexJarPath) String() string {
416 if !o.isSet {
417 return "<unset>"
418 }
419 return o.path.String()
420}
421
422// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
423func makeUnsetDexJarPath() OptionalDexJarPath {
424 return OptionalDexJarPath{isSet: false}
425}
426
427// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
428// the given OptionalPath, which may be valid or invalid.
429func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
430 return OptionalDexJarPath{isSet: true, path: path}
431}
432
433// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
434// valid given path. It returns an unset OptionalDexJarPath if the given path is
435// nil.
436func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
437 if path == nil {
438 return makeUnsetDexJarPath()
439 }
440 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
441}
442
Jaewoong Jung26342642021-03-17 15:56:23 -0700443// Module contains the properties and members used by all java module types
444type Module struct {
445 android.ModuleBase
446 android.DefaultableModuleBase
447 android.ApexModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700448
449 // Functionality common to Module and Import.
450 embeddableInModuleAndImport
451
452 properties CommonProperties
453 protoProperties android.ProtoProperties
454 deviceProperties DeviceProperties
455
yangbill2af0b6e2024-03-15 09:29:29 +0000456 overridableProperties OverridableProperties
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700457 sourceProperties android.SourceProperties
Jooyung Han01d80d82022-01-08 12:16:32 +0900458
Jaewoong Jung26342642021-03-17 15:56:23 -0700459 // jar file containing header classes including static library dependencies, suitable for
460 // inserting into the bootclasspath/classpath of another compile
461 headerJarFile android.Path
462
Joe Onorato349ae8d2024-02-05 22:46:00 +0000463 repackagedHeaderJarFile android.Path
464
Jaewoong Jung26342642021-03-17 15:56:23 -0700465 // jar file containing implementation classes including static library dependencies but no
466 // resources
467 implementationJarFile android.Path
468
469 // jar file containing only resources including from static library dependencies
470 resourceJar android.Path
471
472 // args and dependencies to package source files into a srcjar
473 srcJarArgs []string
474 srcJarDeps android.Paths
475
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000476 // the source files of this module and all its static dependencies
477 transitiveSrcFiles *android.DepSet[android.Path]
478
Jaewoong Jung26342642021-03-17 15:56:23 -0700479 // jar file containing implementation classes and resources including static library
480 // dependencies
481 implementationAndResourcesJar android.Path
482
483 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100484 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700485
486 // output file containing uninstrumented classes that will be instrumented by jacoco
487 jacocoReportClassesFile android.Path
488
489 // output file of the module, which may be a classes jar or a dex jar
490 outputFile android.Path
491 extraOutputFiles android.Paths
492
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100493 exportAidlIncludeDirs android.Paths
494 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700495
496 logtagsSrcs android.Paths
497
498 // installed file for binary dependency
499 installFile android.Path
500
Colin Cross3108ce12021-11-10 14:38:50 -0800501 // installed file for hostdex copy
502 hostdexInstallFile android.InstallPath
503
Chaohui Wangdcbe33c2022-10-11 11:13:30 +0800504 // list of unique .java and .kt source files
505 uniqueSrcFiles android.Paths
506
507 // list of srcjars that was passed to javac
508 compiledSrcJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700509
510 // manifest file to use instead of properties.Manifest
511 overrideManifest android.OptionalPath
512
Jaewoong Jung26342642021-03-17 15:56:23 -0700513 // list of plugins that this java module is exporting
514 exportedPluginJars android.Paths
515
516 // list of plugins that this java module is exporting
517 exportedPluginClasses []string
518
519 // if true, the exported plugins generate API and require disabling turbine.
520 exportedDisableTurbine bool
521
522 // list of source files, collected from srcFiles with unique java and all kt files,
523 // will be used by android.IDEInfo struct
524 expandIDEInfoCompiledSrcs []string
525
526 // expanded Jarjar_rules
527 expandJarjarRules android.Path
528
Joe Onorato349ae8d2024-02-05 22:46:00 +0000529 // jarjar rule for inherited jarjar rules
530 repackageJarjarRules android.Path
531
Jaewoong Jung26342642021-03-17 15:56:23 -0700532 // Extra files generated by the module type to be added as java resources.
533 extraResources android.Paths
534
535 hiddenAPI
536 dexer
537 dexpreopter
538 usesLibrary
539 linter
540
541 // list of the xref extraction files
542 kytheFiles android.Paths
543
Jaewoong Jung26342642021-03-17 15:56:23 -0700544 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900545
546 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000547 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000548 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400549
550 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000551
552 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000553
554 // output file name based on Stem property.
555 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
556 // or the module should override Stem().
557 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700558
Joe Onorato349ae8d2024-02-05 22:46:00 +0000559 // Values that will be set in the JarJarProvider data for jarjar repackaging,
560 // and merged with our dependencies' rules.
561 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000562
563 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000564
565 // Paths to the aconfig intermediate cache files that are provided by the
566 // java_aconfig_library or java_library modules that are statically linked
567 // to this module. Does not contain cache files from all transitive dependencies.
568 aconfigCacheFiles android.Paths
Spandan Das8aac9932024-07-18 23:14:13 +0000569
570 // List of soong module dependencies required to compile the current module.
571 // This information is printed out to `Dependencies` field in module_bp_java_deps.json
572 compileDepNames []string
Makoto Onuki7ded3822024-03-28 14:42:20 -0700573
574 ravenizer struct {
575 enabled bool
576 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700577}
578
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000579var _ android.InstallableModule = (*Module)(nil)
580
581// To satisfy the InstallableModule interface
Jihoon Kang224ea082024-08-12 22:38:16 +0000582func (j *Module) StaticDependencyTags() []blueprint.DependencyTag {
583 return []blueprint.DependencyTag{staticLibTag}
584}
585
586// To satisfy the InstallableModule interface
587func (j *Module) DynamicDependencyTags() []blueprint.DependencyTag {
588 return []blueprint.DependencyTag{libTag, sdkLibTag, bootClasspathTag, systemModulesTag,
589 instrumentationForTag, java9LibTag}
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000590}
591
592// Overrides android.ModuleBase.InstallInProduct()
593func (j *Module) InstallInProduct() bool {
594 return j.ProductSpecific()
595}
596
Jihoon Kang85bc1932024-07-01 17:04:46 +0000597var _ android.StubsAvailableModule = (*Module)(nil)
598
599// To safisfy the StubsAvailableModule interface
600func (j *Module) IsStubsModule() bool {
601 return proptools.Bool(j.properties.Is_stubs_module)
602}
603
Jiyong Park92315372021-04-02 08:45:46 +0900604func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
605 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900606 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700607 return nil
608 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900609 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000610 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700611 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
612 } else {
613 // Treat stable core platform as stable.
614 return nil
615 }
616 } else {
617 return fmt.Errorf("non stable SDK %v", sdkVersion)
618 }
619}
620
621// checkSdkVersions enforces restrictions around SDK dependencies.
622func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
623 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900624 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900625 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700626 ctx.PropertyErrorf("sdk_version",
627 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
628 }
629 }
630 }
631
632 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
633 // See rank() for details.
634 ctx.VisitDirectDeps(func(module android.Module) {
635 tag := ctx.OtherModuleDependencyTag(module)
636 switch module.(type) {
637 // TODO(satayev): cover other types as well, e.g. imports
638 case *Library, *AndroidLibrary:
639 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400640 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700641 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
642 }
643 }
644 })
645}
646
647func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900648 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700649 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900650 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700651 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000652 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 -0700653 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000654 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 -0700655 }
656
657 }
658}
659
Mark Whitea15790a2023-08-22 21:28:11 +0000660func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
661 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400662 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000663 installable := proptools.Bool(j.properties.Installable)
664
665 if headersOnly && installable {
666 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.")
667 }
668 }
669}
670
Jaewoong Jung26342642021-03-17 15:56:23 -0700671func (j *Module) addHostProperties() {
672 j.AddProperties(
673 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000674 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700675 &j.protoProperties,
676 &j.usesLibraryProperties,
677 )
678}
679
680func (j *Module) addHostAndDeviceProperties() {
681 j.addHostProperties()
682 j.AddProperties(
683 &j.deviceProperties,
684 &j.dexer.dexProperties,
685 &j.dexpreoptProperties,
686 &j.linter.properties,
687 )
688}
689
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000690// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
691// makes it available through the hiddenAPIPropertyInfoProvider.
692func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
693 hiddenAPIInfo := newHiddenAPIPropertyInfo()
694
695 // Populate with flag file paths from the properties.
696 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
697
698 // Populate with package rules from the properties.
699 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
700
Colin Cross40213022023-12-13 15:19:49 -0800701 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000702}
703
mrziwang9f7b9f42024-07-10 12:18:06 -0700704// helper method for java modules to set OutputFilesProvider
705func setOutputFiles(ctx android.ModuleContext, m Module) {
706 ctx.SetOutputFiles(append(android.Paths{m.outputFile}, m.extraOutputFiles...), "")
707 ctx.SetOutputFiles(android.Paths{m.outputFile}, android.DefaultDistTag)
708 ctx.SetOutputFiles(android.Paths{m.implementationAndResourcesJar}, ".jar")
709 ctx.SetOutputFiles(android.Paths{m.headerJarFile}, ".hjar")
710 if m.dexer.proguardDictionary.Valid() {
711 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
712 }
713 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
714 if m.linter.outputs.xml != nil {
715 ctx.SetOutputFiles(android.Paths{m.linter.outputs.xml}, ".lint")
Jaewoong Jung26342642021-03-17 15:56:23 -0700716 }
717}
718
Jaewoong Jung26342642021-03-17 15:56:23 -0700719func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
720 initJavaModule(module, hod, false)
721}
722
723func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
724 initJavaModule(module, hod, true)
725}
726
727func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
728 multilib := android.MultilibCommon
729 if multiTargets {
730 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
731 } else {
732 android.InitAndroidArchModule(module, hod, multilib)
733 }
734 android.InitDefaultableModule(module)
735}
736
737func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
738 return j.properties.Instrument &&
739 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
740 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
741}
742
743func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000744 return j.properties.Supports_static_instrumentation &&
745 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700746 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
747 ctx.Config().UnbundledBuild())
748}
749
750func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
751 // Force enable the instrumentation for java code that is built for APEXes ...
752 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
753 // 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 -0800754 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700755 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000756
Jihoon Kang46d66de2024-05-22 22:42:39 +0000757 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700758 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
759 return true
760 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
761 return true
762 }
763 }
764 return false
765}
766
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400767func (j *Module) setInstrument(value bool) {
768 j.properties.Instrument = value
769}
770
Jiyong Park92315372021-04-02 08:45:46 +0900771func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
772 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700773}
774
Jiyong Parkf1691d22021-03-29 20:11:58 +0900775func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700776 return proptools.String(j.deviceProperties.System_modules)
777}
778
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000779func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000780 if j.overridableProperties.Min_sdk_version != nil {
781 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700782 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000783 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700784}
785
Yu Liuf2b94012023-09-19 15:09:10 -0700786func (j *Module) GetDeviceProperties() *DeviceProperties {
787 return &j.deviceProperties
788}
789
Spandan Dasa26eda72023-03-02 00:56:06 +0000790func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
791 if j.deviceProperties.Max_sdk_version != nil {
792 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
793 }
794 // Default is PrivateApiLevel
795 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000796}
797
Spandan Dasa26eda72023-03-02 00:56:06 +0000798func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
799 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
800 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
801 }
802 // Default is PrivateApiLevel
803 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000804}
805
Jiyong Parkf1691d22021-03-29 20:11:58 +0900806func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000807 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900808}
809
Spandan Dasca70fc42023-03-01 23:38:49 +0000810func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900811 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000812 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900813 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000814 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700815}
816
817func (j *Module) AvailableFor(what string) bool {
818 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
819 // Exception: for hostdex: true libraries, the platform variant is created
820 // even if it's not marked as available to platform. In that case, the platform
821 // variant is used only for the hostdex and not installed to the device.
822 return true
823 }
824 return j.ApexModuleBase.AvailableFor(what)
825}
826
827func (j *Module) deps(ctx android.BottomUpMutatorContext) {
828 if ctx.Device() {
829 j.linter.deps(ctx)
830
Jiyong Parkf1691d22021-03-29 20:11:58 +0900831 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700832
833 if j.deviceProperties.SyspropPublicStub != "" {
834 // This is a sysprop implementation library that has a corresponding sysprop public
835 // stubs library, and a dependency on it so that dependencies on the implementation can
836 // be forwarded to the public stubs library when necessary.
837 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
838 }
839 }
840
841 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000842
843 j.properties.Static_libs = android.RemoveListFromList(j.properties.Static_libs, j.properties.Exclude_static_libs)
Jaewoong Jung26342642021-03-17 15:56:23 -0700844 ctx.AddVariationDependencies(nil, staticLibTag, j.properties.Static_libs...)
845
846 // Add dependency on libraries that provide additional hidden api annotations.
847 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
848
Kiyoung Kim9743bab2024-03-28 15:44:56 +0900849 if ctx.Config().EnforceInterPartitionJavaSdkLibrary() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700850 // Require java_sdk_library at inter-partition java dependency to ensure stable
851 // interface between partitions. If inter-partition java_library dependency is detected,
852 // raise build error because java_library doesn't have a stable interface.
853 //
854 // Inputs:
855 // PRODUCT_ENFORCE_INTER_PARTITION_JAVA_SDK_LIBRARY
856 // if true, enable enforcement
857 // PRODUCT_INTER_PARTITION_JAVA_LIBRARY_ALLOWLIST
858 // exception list of java_library names to allow inter-partition dependency
859 for idx := range j.properties.Libs {
860 if libDeps[idx] == nil {
861 continue
862 }
863
864 if javaDep, ok := libDeps[idx].(javaSdkLibraryEnforceContext); ok {
865 // java_sdk_library is always allowed at inter-partition dependency.
866 // So, skip check.
867 if _, ok := javaDep.(*SdkLibrary); ok {
868 continue
869 }
870
871 j.checkPartitionsForJavaDependency(ctx, "libs", javaDep)
872 }
873 }
874 }
875
876 // For library dependencies that are component libraries (like stubs), add the implementation
877 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
878 for _, dep := range libDeps {
879 if dep != nil {
880 if component, ok := dep.(SdkLibraryComponentDependency); ok {
881 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000882 // Add library as optional if it's one of the optional compatibility libs or it's
883 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100884 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000885 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
886 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100887 tag = usesLibOptTag
888 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100889 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700890 }
891 }
892 }
893 }
894
895 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
896 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
897 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
898
899 android.ProtoDeps(ctx, &j.protoProperties)
900 if j.hasSrcExt(".proto") {
901 protoDeps(ctx, &j.protoProperties)
902 }
903
904 if j.hasSrcExt(".kt") {
905 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
906 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700907 tag := staticLibTag
908 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
909 tag = libTag
910 }
911 ctx.AddVariationDependencies(nil, tag,
912 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700913 }
914
915 // Framework libraries need special handling in static coverage builds: they should not have
916 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
917 // the same jacoco classes coming from different bootclasspath jars.
918 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
919 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
920 j.properties.Instrument = true
921 }
922 } else if j.shouldInstrumentStatic(ctx) {
923 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
924 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700925
926 if j.useCompose() {
927 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
928 "androidx.compose.compiler_compiler-hosted")
929 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700930}
931
932func hasSrcExt(srcs []string, ext string) bool {
933 for _, src := range srcs {
934 if filepath.Ext(src) == ext {
935 return true
936 }
937 }
938
939 return false
940}
941
942func (j *Module) hasSrcExt(ext string) bool {
943 return hasSrcExt(j.properties.Srcs, ext)
944}
945
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100946func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
947 var flags string
948
949 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
950 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
951 flags = "-Wmissing-permission-annotation -Werror"
952 }
953 }
954 return flags
955}
956
Jaewoong Jung26342642021-03-17 15:56:23 -0700957func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000958 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700959
960 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
961 aidlIncludes = append(aidlIncludes,
962 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
963 aidlIncludes = append(aidlIncludes,
964 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
965
966 var flags []string
967 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000968 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700969
970 flags = append(flags, j.deviceProperties.Aidl.Flags...)
971
972 if aidlPreprocess.Valid() {
973 flags = append(flags, "-p"+aidlPreprocess.String())
974 deps = append(deps, aidlPreprocess.Path())
975 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000976 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700977 }
978
979 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000980 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700981 }
982
983 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000984 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700985 }
986
Sam Delmerico2351eac2022-05-24 17:10:02 +0000987 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700988 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000989 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700990 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000991 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
992 // add flags for dirs containing AIDL srcs that haven't been specified yet
993 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -0700994
Zim8774ae12022-08-17 11:46:34 +0100995 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +0000996 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +0100997 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700998 flags = append(flags, "-t")
999 }
1000
1001 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
1002 flags = append(flags, "--transaction_names")
1003 }
1004
Thiébaud Weksteende8417c2022-02-10 15:41:46 +11001005 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
1006 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
1007 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1008 }
1009
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001010 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001011 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1012
Jaewoong Jung26342642021-03-17 15:56:23 -07001013 return strings.Join(flags, " "), deps
1014}
1015
1016func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1017
1018 var flags javaBuilderFlags
1019
1020 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001021 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001022
Cole Faust2b1536e2021-06-18 12:25:54 -07001023 epEnabled := j.properties.Errorprone.Enabled
1024 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001025 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001026 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1027 }
1028
1029 errorProneFlags := []string{
1030 "-Xplugin:ErrorProne",
1031 "${config.ErrorProneChecks}",
1032 }
1033 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1034
Colin Cross8bf6cad2022-02-28 13:07:03 -08001035 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001036 "'" + strings.Join(errorProneFlags, " ") + "'"
1037 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1038 }
1039
1040 // classpath
1041 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1042 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001043 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001044 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1045 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1046 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1047
1048 flags.processors = append(flags.processors, deps.processorClasses...)
1049 flags.processors = android.FirstUniqueStrings(flags.processors)
1050
1051 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001052 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001053 // Give host-side tools a version of OpenJDK's standard libraries
1054 // close to what they're targeting. As of Dec 2017, AOSP is only
1055 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1056 //
1057 // When building with OpenJDK 8, the following should have no
1058 // effect since those jars would be available by default.
1059 //
1060 // When building with OpenJDK 9 but targeting a version < 1.8,
1061 // putting them on the bootclasspath means that:
1062 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1063 // b) references to existing APIs are not reinterpreted in an
1064 // OpenJDK 9-specific way, eg. calls to subclasses of
1065 // java.nio.Buffer as in http://b/70862583
1066 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1067 flags.bootClasspath = append(flags.bootClasspath,
1068 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1069 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1070 if Bool(j.properties.Use_tools_jar) {
1071 flags.bootClasspath = append(flags.bootClasspath,
1072 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1073 }
1074 }
1075
1076 // systemModules
1077 flags.systemModules = deps.systemModules
1078
Jaewoong Jung26342642021-03-17 15:56:23 -07001079 return flags
1080}
1081
1082func (j *Module) collectJavacFlags(
1083 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1084 // javac flags.
1085 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001086 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001087
Mythri Alle4b9f6182023-10-25 15:17:11 +00001088 needsDebugInfo = false
1089 for _, flag := range javacFlags {
1090 if strings.HasPrefix(flag, "-g") {
1091 needsDebugInfo = true
1092 }
1093 }
1094
1095 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001096 // For non-host binaries, override the -g flag passed globally to remove
1097 // local variable debug info to reduce disk and memory usage.
1098 javacFlags = append(javacFlags, "-g:source,lines")
1099 }
1100 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1101
1102 if flags.javaVersion.usesJavaModules() {
1103 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001104 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1105 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1106 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1107 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001108
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001109 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001110 if j.properties.Patch_module != nil {
1111 // Manually specify build directory in case it is not under the repo root.
1112 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1113 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001114 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001115
Jaewoong Jung26342642021-03-17 15:56:23 -07001116 classPath := flags.classpath.FormJavaClassPath("")
1117 if classPath != "" {
1118 patchPaths = append(patchPaths, classPath)
1119 }
1120 javacFlags = append(
1121 javacFlags,
1122 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1123 }
1124 }
1125
1126 if len(javacFlags) > 0 {
1127 // optimization.
1128 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1129 flags.javacFlags = "$javacFlags"
1130 }
1131
1132 return flags
1133}
1134
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001135func (j *Module) AddJSONData(d *map[string]interface{}) {
1136 (&j.ModuleBase).AddJSONData(d)
1137 (*d)["Java"] = map[string]interface{}{
1138 "SourceExtensions": j.sourceExtensions,
1139 }
1140
1141}
1142
usta0391ca42023-09-19 15:51:59 -04001143func (j *Module) addGeneratedSrcJars(path android.Path) {
1144 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001145}
1146
Colin Cross4eae06d2023-06-20 22:40:02 -07001147func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001148 // Auto-propagating jarjar rules
1149 jarjarProviderData := j.collectJarJarRules(ctx)
1150 if jarjarProviderData != nil {
1151 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wang9bdd4222024-02-26 18:21:01 -08001152 if !proptools.Bool(j.properties.Skip_jarjar_repackage) {
1153 text := getJarJarRuleText(jarjarProviderData)
1154 if text != "" {
1155 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1156 android.WriteFileRule(ctx, ruleTextFile, text)
1157 j.repackageJarjarRules = ruleTextFile
1158 }
Joe Onorato349ae8d2024-02-05 22:46:00 +00001159 }
1160 }
1161
Jaewoong Jung26342642021-03-17 15:56:23 -07001162 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1163
Makoto Onuki7ded3822024-03-28 14:42:20 -07001164 if re := proptools.Bool(j.properties.Ravenizer.Enabled); re {
1165 j.ravenizer.enabled = re
1166 }
1167
Jaewoong Jung26342642021-03-17 15:56:23 -07001168 deps := j.collectDeps(ctx)
1169 flags := j.collectBuilderFlags(ctx, deps)
1170
1171 if flags.javaVersion.usesJavaModules() {
1172 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001173 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1174 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1175 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001176 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001177
Jaewoong Jung26342642021-03-17 15:56:23 -07001178 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001179 j.sourceExtensions = []string{}
1180 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1181 if hasSrcExt(srcFiles.Strings(), ext) {
1182 j.sourceExtensions = append(j.sourceExtensions, ext)
1183 }
1184 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001185 if hasSrcExt(srcFiles.Strings(), ".proto") {
1186 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1187 }
1188
1189 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1190 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1191 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1192 }
1193
Sam Delmerico2351eac2022-05-24 17:10:02 +00001194 aidlSrcs := srcFiles.FilterByExt(".aidl")
1195 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1196
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001197 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001198 srcFiles = j.genSources(ctx, srcFiles, flags)
1199
1200 // Collect javac flags only after computing the full set of srcFiles to
1201 // ensure that the --patch-module lookup paths are complete.
1202 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1203
1204 srcJars := srcFiles.FilterByExt(".srcjar")
1205 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001206 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001207 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001208 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001209
1210 if j.properties.Jarjar_rules != nil {
1211 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1212 }
1213
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001214 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001215
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001216 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001217 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001218 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001219 if _, found := set[v.String()]; !found {
1220 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001221 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001222 }
1223 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001224 var uniqueKtFiles android.Paths
1225 for _, v := range srcFiles.FilterByExt(".kt") {
1226 if _, found := set[v.String()]; !found {
1227 set[v.String()] = true
1228 uniqueKtFiles = append(uniqueKtFiles, v)
1229 }
1230 }
1231
1232 var uniqueSrcFiles android.Paths
1233 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1234 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1235 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001236 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001237
Colin Crossb5db4012022-03-28 17:12:39 -07001238 // We don't currently run annotation processors in turbine, which means we can't use turbine
1239 // generated header jars when an annotation processor that generates API is enabled. One
1240 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1241 // is used to run all of the annotation processors.
1242 disableTurbine := deps.disableTurbine
1243
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001244 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001245 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1246
1247 var kotlinJars android.Paths
Colin Cross220a9a12022-03-28 17:08:01 -07001248 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001249
Colin Cross4eae06d2023-06-20 22:40:02 -07001250 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1251 // any dependencies so that it can override any non-final R classes from dependencies with the
1252 // final R classes from the app.
1253 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1254
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001255 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1256
Mark Whitea15790a2023-08-22 21:28:11 +00001257 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001258 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001259 if srcFiles.HasExt(".kt") {
1260 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1261 }
1262 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1263 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1264 }
1265
Colin Crossedec77c2024-07-26 15:25:40 -07001266 _, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
1267 extraCombinedJars)
1268
1269 combinedHeaderJarFile = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1270 combinedHeaderJarFile = j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
Mark Whitea15790a2023-08-22 21:28:11 +00001271 if ctx.Failed() {
1272 return
1273 }
Colin Crossedec77c2024-07-26 15:25:40 -07001274 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001275
Colin Cross7727c7f2024-07-18 15:36:32 -07001276 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001277 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1278 TransitiveLibsHeaderJars: j.transitiveLibsHeaderJars,
1279 TransitiveStaticLibsHeaderJars: j.transitiveStaticLibsHeaderJars,
1280 AidlIncludeDirs: j.exportAidlIncludeDirs,
1281 ExportedPlugins: j.exportedPluginJars,
1282 ExportedPluginClasses: j.exportedPluginClasses,
1283 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1284 StubsLinkType: j.stubsLinkType,
1285 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001286 })
1287
1288 j.outputFile = j.headerJarFile
1289 return
1290 }
1291
Jaewoong Jung26342642021-03-17 15:56:23 -07001292 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001293 // When using kotlin sources turbine is used to generate annotation processor sources,
1294 // including for annotation processors that generate API, so we can use turbine for
1295 // java sources too.
1296 disableTurbine = false
1297
Jaewoong Jung26342642021-03-17 15:56:23 -07001298 // user defined kotlin flags.
1299 kotlincFlags := j.properties.Kotlincflags
1300 CheckKotlincFlags(ctx, kotlincFlags)
1301
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001302 // Workaround for KT-46512
1303 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001304
1305 // If there are kotlin files, compile them first but pass all the kotlin and java files
1306 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1307 // won't emit any classes for them.
1308 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1309 if ctx.Device() {
1310 kotlincFlags = append(kotlincFlags, "-no-jdk")
1311 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001312
1313 for _, plugin := range deps.kotlinPlugins {
1314 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1315 }
1316 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1317
Jaewoong Jung26342642021-03-17 15:56:23 -07001318 if len(kotlincFlags) > 0 {
1319 // optimization.
1320 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1321 flags.kotlincFlags += "$kotlincFlags"
1322 }
1323
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001324 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001325 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1326
Jaewoong Jung26342642021-03-17 15:56:23 -07001327 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1328 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1329
Isaac Chioua23d9942022-04-06 06:14:38 +00001330 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001331 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001332 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1333 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001334 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001335 srcJars = append(srcJars, kaptSrcJar)
1336 kotlinJars = append(kotlinJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001337 // Disable annotation processing in javac, it's already been handled by kapt
1338 flags.processorPath = nil
1339 flags.processors = nil
1340 }
1341
1342 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001343 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001344 kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001345 if ctx.Failed() {
1346 return
1347 }
1348
Colin Cross7707b242024-07-26 12:02:36 -07001349 kotlinJarPath := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001350
Isaac Chioua23d9942022-04-06 06:14:38 +00001351 // Make javac rule depend on the kotlinc rule
1352 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1353
Zi Wangddb2ee52024-04-02 16:44:02 +00001354 kotlinJars = append(kotlinJars, kotlinJarPath)
Colin Cross220a9a12022-03-28 17:08:01 -07001355 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001356 }
1357
Colin Crossfd620b22024-02-23 10:05:21 -08001358 jars := slices.Clone(kotlinJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001359
Jaewoong Jung26342642021-03-17 15:56:23 -07001360 j.compiledSrcJars = srcJars
1361
1362 enableSharding := false
Colin Cross3d56ed52021-11-18 22:23:12 -08001363 var headerJarFileWithoutDepsOrJarjar android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001364 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001365 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1366 enableSharding = true
1367 // Formerly, there was a check here that prevented annotation processors
1368 // from being used when sharding was enabled, as some annotation processors
1369 // do not function correctly in sharded environments. It was removed to
1370 // allow for the use of annotation processors that do function correctly
1371 // with sharding enabled. See: b/77284273.
1372 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001373 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001374 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001375 var combinedHeaderJarFile android.Path
1376 headerJarFileWithoutDepsOrJarjar, combinedHeaderJarFile =
Colin Cross4eae06d2023-06-20 22:40:02 -07001377 j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
Colin Crossedec77c2024-07-26 15:25:40 -07001378
1379 j.headerJarFile = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1380 j.repackagedHeaderJarFile = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
Jaewoong Jung26342642021-03-17 15:56:23 -07001381 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001382 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001383 hasErrorproneableFiles := false
1384 for _, ext := range j.sourceExtensions {
1385 if ext != ".proto" && ext != ".aidl" {
1386 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1387 // compile, and it's not useful to have warnings on these generated sources.
1388 hasErrorproneableFiles = true
1389 break
1390 }
1391 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001392 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001393 if Bool(j.properties.Errorprone.Enabled) {
1394 // If error-prone is enabled, enable errorprone flags on the regular
1395 // build.
1396 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001397 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001398 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1399 // a new jar file just for compiling with the errorprone compiler to.
1400 // This is because we don't want to cause the java files to get completely
1401 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1402 // We also don't want to run this if errorprone is enabled by default for
1403 // this module, or else we could have duplicated errorprone messages.
1404 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001405 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001406 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001407
Vadim Spivak3c496f02023-06-08 06:14:59 +00001408 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001409 "errorprone", "errorprone")
1410
Jaewoong Jung26342642021-03-17 15:56:23 -07001411 extraJarDeps = append(extraJarDeps, errorprone)
1412 }
1413
1414 if enableSharding {
Colin Cross3d56ed52021-11-18 22:23:12 -08001415 if headerJarFileWithoutDepsOrJarjar != nil {
1416 flags.classpath = append(classpath{headerJarFileWithoutDepsOrJarjar}, flags.classpath...)
1417 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001418 shardSize := int(*(j.properties.Javac_shard_size))
1419 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001420 if len(uniqueJavaFiles) > 0 {
1421 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001422 for idx, shardSrc := range shardSrcs {
1423 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1424 nil, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001425 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
Jaewoong Jung26342642021-03-17 15:56:23 -07001426 jars = append(jars, classes)
1427 }
1428 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001429 // Assume approximately 5 sources per srcjar.
1430 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1431 // 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 -07001432 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001433 startIdx := len(shardSrcs)
1434 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1435 for idx, shardSrcJars := range shardSrcJarsList {
1436 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1437 nil, shardSrcJars, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001438 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
Colin Crossa052ddb2023-09-25 21:46:58 -07001439 jars = append(jars, classes)
1440 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001441 }
1442 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001443 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001444 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
Jaewoong Jung26342642021-03-17 15:56:23 -07001445 jars = append(jars, classes)
1446 }
1447 if ctx.Failed() {
1448 return
1449 }
1450 }
1451
Colin Crossfd620b22024-02-23 10:05:21 -08001452 jars = append(jars, extraCombinedJars...)
1453
Jaewoong Jung26342642021-03-17 15:56:23 -07001454 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1455
1456 var includeSrcJar android.WritablePath
1457 if Bool(j.properties.Include_srcs) {
1458 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1459 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1460 }
1461
1462 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1463 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1464 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1465 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1466
1467 var resArgs []string
1468 var resDeps android.Paths
1469
1470 resArgs = append(resArgs, dirArgs...)
1471 resDeps = append(resDeps, dirDeps...)
1472
1473 resArgs = append(resArgs, fileArgs...)
1474 resDeps = append(resDeps, fileDeps...)
1475
1476 resArgs = append(resArgs, extraArgs...)
1477 resDeps = append(resDeps, extraDeps...)
1478
1479 if len(resArgs) > 0 {
1480 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1481 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
1482 j.resourceJar = resourceJar
1483 if ctx.Failed() {
1484 return
1485 }
1486 }
1487
1488 var resourceJars android.Paths
1489 if j.resourceJar != nil {
1490 resourceJars = append(resourceJars, j.resourceJar)
1491 }
1492 if Bool(j.properties.Include_srcs) {
1493 resourceJars = append(resourceJars, includeSrcJar)
1494 }
1495 resourceJars = append(resourceJars, deps.staticResourceJars...)
1496
1497 if len(resourceJars) > 1 {
1498 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1499 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1500 false, nil, nil)
1501 j.resourceJar = combinedJar
1502 } else if len(resourceJars) == 1 {
1503 j.resourceJar = resourceJars[0]
1504 }
1505
1506 if len(deps.staticJars) > 0 {
1507 jars = append(jars, deps.staticJars...)
1508 }
1509
1510 manifest := j.overrideManifest
1511 if !manifest.Valid() && j.properties.Manifest != nil {
1512 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
1513 }
1514
1515 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1516 if len(services) > 0 {
1517 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1518 var zipargs []string
1519 for _, file := range services {
1520 serviceFile := file.String()
1521 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1522 }
1523 rule := zip
1524 args := map[string]string{
1525 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1526 }
1527 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1528 rule = zipRE
1529 args["implicits"] = strings.Join(services.Strings(), ",")
1530 }
1531 ctx.Build(pctx, android.BuildParams{
1532 Rule: rule,
1533 Output: servicesJar,
1534 Implicits: services,
1535 Args: args,
1536 })
1537 jars = append(jars, servicesJar)
1538 }
1539
1540 // Combine the classes built from sources, any manifests, and any static libraries into
1541 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001542 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001543
1544 if len(jars) == 1 && !manifest.Valid() {
1545 // Optimization: skip the combine step as there is nothing to do
1546 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1547 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1548 // any if len(jars) == 1.
1549
Jihoon Kang1147b312023-06-08 23:25:57 +00001550 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1551 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1552 // either with .from-source or .from-text suffix.
1553 // outputFile should be agnostic to the build configuration,
1554 // thus "combine" the single static lib in order to prevent the static lib from being exposed
1555 // to the copy rules.
Jihoon Kangfa3f0782024-08-21 20:42:18 +00001556 stub, _ := moduleStubLinkType(j)
Jihoon Kang1147b312023-06-08 23:25:57 +00001557
Colin Cross7707b242024-07-26 12:02:36 -07001558 if stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07001559 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1560 ctx.Build(pctx, android.BuildParams{
1561 Rule: android.Cp,
1562 Input: jars[0],
1563 Output: combinedJar,
1564 })
Colin Cross7707b242024-07-26 12:02:36 -07001565 outputFile = combinedJar
1566 } else {
1567 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001568 }
1569 } else {
1570 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1571 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1572 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001573 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001574 }
1575
1576 // jarjar implementation jar if necessary
Colin Crossedec77c2024-07-26 15:25:40 -07001577 jarjarFile := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1578 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001579
Colin Crossedec77c2024-07-26 15:25:40 -07001580 // jarjar resource jar if necessary
1581 if j.resourceJar != nil {
1582 resourceJarJarFile := j.jarjarIfNecessary(ctx, j.resourceJar, jarName, "resource")
1583 j.resourceJar = resourceJarJarFile
1584 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001585
Colin Crossedec77c2024-07-26 15:25:40 -07001586 if ctx.Failed() {
1587 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001588 }
1589
Makoto Onuki7ded3822024-03-28 14:42:20 -07001590 if j.ravenizer.enabled {
1591 ravenizerInput := outputFile
1592 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", jarName)
1593 ctx.Build(pctx, android.BuildParams{
1594 Rule: ravenizer,
1595 Description: "ravenizer",
1596 Input: ravenizerInput,
1597 Output: ravenizerOutput,
1598 })
1599 outputFile = ravenizerOutput
1600 }
1601
Jaewoong Jung26342642021-03-17 15:56:23 -07001602 // Check package restrictions if necessary.
1603 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001604 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001605 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001606
1607 // Create a rule to copy the output jar to another path and add a validate dependency that
1608 // will check that the jar only contains the permitted packages. The new location will become
1609 // the output file of this module.
1610 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001611 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001612 ctx.Build(pctx, android.BuildParams{
1613 Rule: android.Cp,
1614 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001615 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001616 // Make sure that any dependency on the output file will cause ninja to run the package check
1617 // rule.
1618 Validation: pkgckFile,
1619 })
Colin Cross7707b242024-07-26 12:02:36 -07001620 outputFile = packageCheckOutputFile
Paul Duffin08a18bf2021-10-01 13:19:58 +01001621
1622 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001623 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001624
1625 if ctx.Failed() {
1626 return
1627 }
1628 }
1629
1630 j.implementationJarFile = outputFile
1631 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001632 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1633 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1634 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1635 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1636 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1637 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1638 j.headerJarFile = headerJarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001639 }
1640
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001641 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1642 specs := j.jacocoModuleToZipCommand(ctx)
1643 if ctx.Failed() {
1644 return
1645 }
1646
Jaewoong Jung26342642021-03-17 15:56:23 -07001647 if j.shouldInstrument(ctx) {
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001648 outputFile = j.instrument(ctx, flags, outputFile, jarName, specs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001649 }
1650
1651 // merge implementation jar with resources if necessary
1652 implementationAndResourcesJar := outputFile
1653 if j.resourceJar != nil {
1654 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Colin Cross7707b242024-07-26 12:02:36 -07001655 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001656 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
1657 false, nil, nil)
1658 implementationAndResourcesJar = combinedJar
1659 }
1660
1661 j.implementationAndResourcesJar = implementationAndResourcesJar
1662
1663 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001664 compileDex := j.dexProperties.Compile_dex
Colin Crossff694a82023-12-13 15:54:49 -08001665 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -07001666 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001667 if compileDex == nil {
1668 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001669 }
1670 if j.deviceProperties.Hostdex == nil {
1671 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1672 }
1673 }
1674
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001675 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001676 if j.hasCode(ctx) {
1677 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001678 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001679 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1680 }
1681 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001682 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001683 params := &compileDexParams{
1684 flags: flags,
1685 sdkVersion: j.SdkVersion(ctx),
1686 minSdkVersion: j.MinSdkVersion(ctx),
1687 classesJar: implementationAndResourcesJar,
1688 jarName: jarName,
1689 }
Spandan Das15a67112024-05-30 00:07:40 +00001690 if j.GetProfileGuided() && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting() {
1691 ctx.PropertyErrorf("enable_profile_rewriting",
1692 "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.",
1693 )
1694 }
Spandan Das3dbda182024-05-20 22:23:10 +00001695 if j.EnableProfileRewriting() {
1696 profile := j.GetProfile()
1697 if profile == "" || !j.GetProfileGuided() {
1698 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1699 }
1700 params.artProfileInput = &profile
1701 }
1702 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001703 if ctx.Failed() {
1704 return
1705 }
1706
Spandan Das3dbda182024-05-20 22:23:10 +00001707 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1708 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001709 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001710 }
1711
Jaewoong Jung26342642021-03-17 15:56:23 -07001712 // merge dex jar with resources if necessary
1713 if j.resourceJar != nil {
1714 jars := android.Paths{dexOutputFile, j.resourceJar}
Colin Cross7707b242024-07-26 12:02:36 -07001715 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001716 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1717 false, nil, nil)
1718 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001719 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001720 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001721 dexOutputFile = combinedAlignedJar
1722 } else {
1723 dexOutputFile = combinedJar
1724 }
1725 }
1726
Paul Duffin4de94502021-05-16 05:21:16 +01001727 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001728
1729 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001730
1731 // Encode hidden API flags in dex file, if needed.
1732 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1733
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001734 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001735
1736 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001737 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1738 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1739 libName = strings.TrimSuffix(libName, ".impl")
1740 }
1741 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001742
1743 outputFile = dexOutputFile
1744 } else {
1745 // There is no code to compile into a dex jar, make sure the resources are propagated
1746 // to the APK if this is an app.
1747 outputFile = implementationAndResourcesJar
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001748 j.dexJarFile = makeDexJarPathFromPath(j.resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001749 }
1750
1751 if ctx.Failed() {
1752 return
1753 }
1754 } else {
1755 outputFile = implementationAndResourcesJar
1756 }
1757
1758 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001759 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001760 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001761 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001762 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001763 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001764 }
1765 }
1766
1767 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001768 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1769 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001770 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1771 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001772 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001773 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001774 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001775 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001776 j.linter.javaLanguageLevel = flags.javaVersion.String()
1777 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001778 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001779 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1780 j.linter.buildModuleReportZip = true
1781 }
1782 j.linter.lint(ctx)
1783 }
1784
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001785 j.collectTransitiveSrcFiles(ctx, srcFiles)
1786
Jaewoong Jung26342642021-03-17 15:56:23 -07001787 ctx.CheckbuildFile(outputFile)
1788
Colin Cross7727c7f2024-07-18 15:36:32 -07001789 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001790 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1791 RepackagedHeaderJars: android.PathsIfNonNil(j.repackagedHeaderJarFile),
1792 TransitiveLibsHeaderJars: j.transitiveLibsHeaderJars,
1793 TransitiveStaticLibsHeaderJars: j.transitiveStaticLibsHeaderJars,
1794 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1795 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
1796 ResourceJars: android.PathsIfNonNil(j.resourceJar),
1797 AidlIncludeDirs: j.exportAidlIncludeDirs,
1798 SrcJarArgs: j.srcJarArgs,
1799 SrcJarDeps: j.srcJarDeps,
1800 TransitiveSrcFiles: j.transitiveSrcFiles,
1801 ExportedPlugins: j.exportedPluginJars,
1802 ExportedPluginClasses: j.exportedPluginClasses,
1803 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1804 JacocoReportClassesFile: j.jacocoReportClassesFile,
1805 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001806 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001807 })
1808
1809 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1810 j.outputFile = outputFile.WithoutRel()
1811}
1812
Colin Crossa1ff7c62021-09-17 14:11:52 -07001813func (j *Module) useCompose() bool {
1814 return android.InList("androidx.compose.runtime_runtime", j.properties.Static_libs)
1815}
1816
Colin Crosscde55342024-03-27 14:11:51 -07001817func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []*android.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001818 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001819 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001820 depTag := ctx.OtherModuleDependencyTag(m)
1821
1822 if depProguardInfo.UnconditionallyExportedProguardFlags != nil {
1823 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1824 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1825 }
1826
1827 if depTag == staticLibTag && depProguardInfo.ProguardFlagsFiles != nil {
1828 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1829 }
1830 })
1831
Colin Crosscde55342024-03-27 14:11:51 -07001832 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1833}
1834
1835func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1836 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1837
Sam Delmerico95d70942023-08-02 18:00:35 -04001838 directUnconditionalExportedFlags := android.Paths{}
1839 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1840 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1841 if exportUnconditionally {
1842 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1843 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1844 directUnconditionalExportedFlags = proguardFlagsForThisModule
1845 }
1846
1847 return ProguardSpecInfo{
1848 Export_proguard_flags_files: exportUnconditionally,
1849 ProguardFlagsFiles: android.NewDepSet[android.Path](
1850 android.POSTORDER,
1851 proguardFlagsForThisModule,
1852 transitiveProguardFlags,
1853 ),
1854 UnconditionallyExportedProguardFlags: android.NewDepSet[android.Path](
1855 android.POSTORDER,
1856 directUnconditionalExportedFlags,
1857 transitiveUnconditionalExportedFlags,
1858 ),
1859 }
1860
1861}
1862
Cole Faust75fffb12021-06-13 15:23:16 -07001863// Returns a copy of the supplied flags, but with all the errorprone-related
1864// fields copied to the regular build's fields.
1865func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1866 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1867
1868 if len(flags.errorProneExtraJavacFlags) > 0 {
1869 if len(flags.javacFlags) > 0 {
1870 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
1871 } else {
1872 flags.javacFlags = flags.errorProneExtraJavacFlags
1873 }
1874 }
1875 return flags
1876}
1877
Jaewoong Jung26342642021-03-17 15:56:23 -07001878func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07001879 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07001880
1881 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00001882 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001883 if idx >= 0 {
1884 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00001885 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001886 jarName += strconv.Itoa(idx)
1887 }
1888
Colin Cross7707b242024-07-26 12:02:36 -07001889 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001890 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001891
Cole Faust9decf832024-06-11 11:45:53 -07001892 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001893 extractionFile := android.PathForModuleOut(ctx, kzipName)
1894 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1895 j.kytheFiles = append(j.kytheFiles, extractionFile)
1896 }
1897
Vadim Spivak3c496f02023-06-08 06:14:59 +00001898 if len(flags.processorPath) > 0 {
1899 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
1900 }
1901
Jaewoong Jung26342642021-03-17 15:56:23 -07001902 return classes
1903}
1904
1905// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1906// since some of these flags may be used internally.
1907func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1908 for _, flag := range flags {
1909 flag = strings.TrimSpace(flag)
1910
1911 if !strings.HasPrefix(flag, "-") {
1912 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1913 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1914 ctx.PropertyErrorf("kotlincflags",
1915 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1916 } else if inList(flag, config.KotlincIllegalFlags) {
1917 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1918 } else if flag == "-include-runtime" {
1919 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1920 } else {
1921 args := strings.Split(flag, " ")
1922 if args[0] == "-kotlin-home" {
1923 ctx.PropertyErrorf("kotlincflags",
1924 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1925 }
1926 }
1927 }
1928}
1929
1930func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
1931 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossedec77c2024-07-26 15:25:40 -07001932 extraJars android.Paths) (headerJar android.Path, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001933
1934 var jars android.Paths
1935 if len(srcFiles) > 0 || len(srcJars) > 0 {
1936 // Compile java sources into turbine.jar.
1937 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1938 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001939 jars = append(jars, turbineJar)
Colin Cross3d56ed52021-11-18 22:23:12 -08001940 headerJar = turbineJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001941 }
1942
1943 jars = append(jars, extraJars...)
1944
1945 // Combine any static header libraries into classes-header.jar. If there is only
1946 // one input jar this step will be skipped.
1947 jars = append(jars, deps.staticHeaderJars...)
1948
1949 // we cannot skip the combine step for now if there is only one jar
1950 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07001951 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
1952 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001953 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07001954
Colin Crossedec77c2024-07-26 15:25:40 -07001955 return headerJar, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07001956}
1957
1958func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07001959 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07001960
1961 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07001962 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001963
1964 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1965
1966 j.jacocoReportClassesFile = jacocoReportClassesFile
1967
1968 return instrumentedJar
1969}
1970
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001971type providesTransitiveHeaderJars struct {
1972 // set of header jars for all transitive libs deps
Colin Crossc85750b2022-04-21 12:50:51 -07001973 transitiveLibsHeaderJars *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001974 // set of header jars for all transitive static libs deps
Colin Crossc85750b2022-04-21 12:50:51 -07001975 transitiveStaticLibsHeaderJars *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001976}
1977
Colin Crossc85750b2022-04-21 12:50:51 -07001978func (j *providesTransitiveHeaderJars) TransitiveLibsHeaderJars() *android.DepSet[android.Path] {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001979 return j.transitiveLibsHeaderJars
1980}
1981
Colin Crossc85750b2022-04-21 12:50:51 -07001982func (j *providesTransitiveHeaderJars) TransitiveStaticLibsHeaderJars() *android.DepSet[android.Path] {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001983 return j.transitiveStaticLibsHeaderJars
1984}
1985
1986func (j *providesTransitiveHeaderJars) collectTransitiveHeaderJars(ctx android.ModuleContext) {
1987 directLibs := android.Paths{}
1988 directStaticLibs := android.Paths{}
Colin Crossc85750b2022-04-21 12:50:51 -07001989 transitiveLibs := []*android.DepSet[android.Path]{}
1990 transitiveStaticLibs := []*android.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001991 ctx.VisitDirectDeps(func(module android.Module) {
1992 // don't add deps of the prebuilt version of the same library
1993 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
1994 return
1995 }
1996
Colin Cross7727c7f2024-07-18 15:36:32 -07001997 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
1998 tag := ctx.OtherModuleDependencyTag(module)
1999 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
2000 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2001 directLibs = append(directLibs, dep.HeaderJars...)
2002 } else if tag == staticLibTag {
2003 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2004 } else {
2005 // Don't propagate transitive libs for other kinds of dependencies.
2006 return
2007 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002008
Colin Cross7727c7f2024-07-18 15:36:32 -07002009 if dep.TransitiveLibsHeaderJars != nil {
2010 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJars)
2011 }
2012 if dep.TransitiveStaticLibsHeaderJars != nil {
2013 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJars)
2014 }
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002015 }
2016 })
2017 j.transitiveLibsHeaderJars = android.NewDepSet(android.POSTORDER, directLibs, transitiveLibs)
2018 j.transitiveStaticLibsHeaderJars = android.NewDepSet(android.POSTORDER, directStaticLibs, transitiveStaticLibs)
2019}
2020
Jaewoong Jung26342642021-03-17 15:56:23 -07002021func (j *Module) HeaderJars() android.Paths {
2022 if j.headerJarFile == nil {
2023 return nil
2024 }
2025 return android.Paths{j.headerJarFile}
2026}
2027
2028func (j *Module) ImplementationJars() android.Paths {
2029 if j.implementationJarFile == nil {
2030 return nil
2031 }
2032 return android.Paths{j.implementationJarFile}
2033}
2034
Spandan Das59a4a2b2024-01-09 21:35:56 +00002035func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002036 return j.dexJarFile
2037}
2038
2039func (j *Module) DexJarInstallPath() android.Path {
2040 return j.installFile
2041}
2042
2043func (j *Module) ImplementationAndResourcesJars() android.Paths {
2044 if j.implementationAndResourcesJar == nil {
2045 return nil
2046 }
2047 return android.Paths{j.implementationAndResourcesJar}
2048}
2049
2050func (j *Module) AidlIncludeDirs() android.Paths {
2051 // exportAidlIncludeDirs is type android.Paths already
2052 return j.exportAidlIncludeDirs
2053}
2054
2055func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2056 return j.classLoaderContexts
2057}
2058
2059// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002060func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002061 // jarjar rules will repackage the sources. To prevent misleading results, IdeInfo should contain the
2062 // repackaged jar instead of the input sources.
Jaewoong Jung26342642021-03-17 15:56:23 -07002063 if j.expandJarjarRules != nil {
2064 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002065 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
2066 } else {
2067 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2068 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2069 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002070 }
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002071 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2072 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Yikef6282022022-04-13 20:41:01 +08002073 dpInfo.Static_libs = append(dpInfo.Static_libs, j.properties.Static_libs...)
2074 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002075}
2076
2077func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002078 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002079}
2080
2081func (j *Module) hasCode(ctx android.ModuleContext) bool {
2082 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2083 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2084}
2085
2086// Implements android.ApexModule
2087func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2088 return j.depIsInSameApex(ctx, dep)
2089}
2090
2091// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002092func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002093 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002094 minSdkVersion := j.MinSdkVersion(ctx)
2095 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002096 return fmt.Errorf("min_sdk_version is not specified")
2097 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002098 // If the module is compiling against core (via sdk_version), skip comparison check.
2099 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002100 return nil
2101 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002102 if minSdkVersion.GreaterThan(sdkVersion) {
2103 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002104 }
2105 return nil
2106}
2107
2108func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002109 if j.stem == "" {
2110 panic("Stem() called before stem property was set")
2111 }
2112 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002113}
2114
Jaewoong Jung26342642021-03-17 15:56:23 -07002115func (j *Module) JacocoReportClassesFile() android.Path {
2116 return j.jacocoReportClassesFile
2117}
2118
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002119func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
2120 var fromDeps []*android.DepSet[android.Path]
2121 ctx.VisitDirectDeps(func(module android.Module) {
2122 tag := ctx.OtherModuleDependencyTag(module)
2123 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002124 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2125 if depInfo.TransitiveSrcFiles != nil {
2126 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
2127 }
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002128 }
2129 }
2130 })
2131
2132 j.transitiveSrcFiles = android.NewDepSet(android.POSTORDER, mine, fromDeps)
2133}
2134
Jaewoong Jung26342642021-03-17 15:56:23 -07002135func (j *Module) IsInstallable() bool {
2136 return Bool(j.properties.Installable)
2137}
2138
2139type sdkLinkType int
2140
2141const (
2142 // TODO(jiyong) rename these for better readability. Make the allowed
2143 // and disallowed link types explicit
2144 // order is important here. See rank()
2145 javaCore sdkLinkType = iota
2146 javaSdk
2147 javaSystem
2148 javaModule
2149 javaSystemServer
2150 javaPlatform
2151)
2152
2153func (lt sdkLinkType) String() string {
2154 switch lt {
2155 case javaCore:
2156 return "core Java API"
2157 case javaSdk:
2158 return "Android API"
2159 case javaSystem:
2160 return "system API"
2161 case javaModule:
2162 return "module API"
2163 case javaSystemServer:
2164 return "system server API"
2165 case javaPlatform:
2166 return "private API"
2167 default:
2168 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2169 }
2170}
2171
2172// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2173// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2174// can't statically depend on modules that use Platform API.
2175func (lt sdkLinkType) rank() int {
2176 return int(lt)
2177}
2178
2179type moduleWithSdkDep interface {
2180 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002181 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002182}
2183
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002184func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2185 switch k {
2186 case android.SdkCore:
2187 return javaCore
2188 case android.SdkSystem:
2189 return javaSystem
2190 case android.SdkPublic:
2191 return javaSdk
2192 case android.SdkModule:
2193 return javaModule
2194 case android.SdkSystemServer:
2195 return javaSystemServer
2196 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2197 return javaPlatform
2198 default:
2199 return javaSdk
2200 }
2201}
2202
Jiyong Park92315372021-04-02 08:45:46 +09002203func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002204 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002205 case android.SdkCore.DefaultJavaLibraryName(),
2206 "legacy.core.platform.api.stubs",
2207 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002208 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002209 "core-lambda-stubs",
Jihoon Kangb5078312023-03-29 23:25:49 +00002210 "core-generated-annotation-stubs":
Jaewoong Jung26342642021-03-17 15:56:23 -07002211 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002212 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002213 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002214 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002215 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002216 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002217 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002218 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002219 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002220 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002221 return javaSystem, true
2222 }
2223
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002224 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002225 return linkType, true
2226 }
2227
Jiyong Park92315372021-04-02 08:45:46 +09002228 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002229 if !ver.Valid() {
2230 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002231 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002232
2233 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002234}
2235
2236// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2237// this module's. See the comment on rank() for details and an example.
2238func (j *Module) checkSdkLinkType(
2239 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2240 if ctx.Host() {
2241 return
2242 }
2243
Jiyong Park92315372021-04-02 08:45:46 +09002244 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002245 if stubs {
2246 return
2247 }
Jiyong Park92315372021-04-02 08:45:46 +09002248 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002249
2250 if myLinkType.rank() < depLinkType.rank() {
2251 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2252 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2253 "property of the source or target module so that target module is built "+
2254 "with the same or smaller API set when compared to the source.",
2255 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2256 }
2257}
2258
2259func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2260 var deps deps
2261
2262 if ctx.Device() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09002263 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07002264 if sdkDep.invalidVersion {
2265 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2266 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2267 } else if sdkDep.useFiles {
2268 // sdkDep.jar is actually equivalent to turbine header.jar.
2269 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002270 deps.dexClasspath = append(deps.dexClasspath, sdkDep.jars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002271 deps.aidlPreprocess = sdkDep.aidl
Spandan Das6e8bd1c2024-08-09 00:07:03 +00002272 // Add the sdk module dependency to `compileDepNames`.
2273 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2274 // TODO (b/358608607): Move this to decodeSdkDep
2275 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2276 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
Jaewoong Jung26342642021-03-17 15:56:23 -07002277 } else {
2278 deps.aidlPreprocess = sdkDep.aidl
2279 }
2280 }
2281
Jiyong Park92315372021-04-02 08:45:46 +09002282 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002283
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002284 j.collectTransitiveHeaderJars(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07002285 ctx.VisitDirectDeps(func(module android.Module) {
2286 otherName := ctx.OtherModuleName(module)
2287 tag := ctx.OtherModuleDependencyTag(module)
2288
2289 if IsJniDepTag(tag) {
2290 // Handled by AndroidApp.collectAppDeps
2291 return
2292 }
2293 if tag == certificateTag {
2294 // Handled by AndroidApp.collectAppDeps
2295 return
2296 }
2297
2298 if dep, ok := module.(SdkLibraryDependency); ok {
2299 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002300 case sdkLibTag, libTag:
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002301 depHeaderJars := dep.SdkHeaderJars(ctx, j.SdkVersion(ctx))
2302 deps.classpath = append(deps.classpath, depHeaderJars...)
2303 deps.dexClasspath = append(deps.dexClasspath, depHeaderJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002304 case staticLibTag:
2305 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
2306 }
Colin Cross313aa542023-12-13 13:47:44 -08002307 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2308 if sdkLinkType != javaPlatform {
2309 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2310 // dep is a sysprop implementation library, but this module is not linking against
2311 // the platform, so it gets the sysprop public stubs library instead. Replace
2312 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2313 dep = syspropDep.JavaInfo
2314 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002315 }
2316 switch tag {
2317 case bootClasspathTag:
2318 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002319 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002320 if _, ok := module.(*Plugin); ok {
2321 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2322 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002323 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002324 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002325 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2326 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2327 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2328 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002329 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2330 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2331 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
2332 case java9LibTag:
2333 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
2334 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002335 if _, ok := module.(*Plugin); ok {
2336 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2337 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002338 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2339 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2340 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2341 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2342 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2343 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2344 // Turbine doesn't run annotation processors, so any module that uses an
2345 // annotation processor that generates API is incompatible with the turbine
2346 // optimization.
2347 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002348 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002349 case pluginTag:
2350 if plugin, ok := module.(*Plugin); ok {
2351 if plugin.pluginProperties.Processor_class != nil {
2352 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2353 } else {
2354 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2355 }
2356 // Turbine doesn't run annotation processors, so any module that uses an
2357 // annotation processor that generates API is incompatible with the turbine
2358 // optimization.
2359 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2360 } else {
2361 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2362 }
2363 case errorpronePluginTag:
2364 if _, ok := module.(*Plugin); ok {
2365 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2366 } else {
2367 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2368 }
2369 case exportedPluginTag:
2370 if plugin, ok := module.(*Plugin); ok {
2371 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2372 if plugin.pluginProperties.Processor_class != nil {
2373 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2374 }
2375 // Turbine doesn't run annotation processors, so any module that uses an
2376 // annotation processor that generates API is incompatible with the turbine
2377 // optimization.
2378 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2379 } else {
2380 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2381 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002382 case kotlinPluginTag:
2383 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002384 case syspropPublicStubDepTag:
2385 // This is a sysprop implementation library, forward the JavaInfoProvider from
2386 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002387 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002388 JavaInfo: dep,
2389 })
2390 }
2391 } else if dep, ok := module.(android.SourceFileProducer); ok {
2392 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002393 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002394 checkProducesJars(ctx, dep)
2395 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002396 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002397 case staticLibTag:
2398 checkProducesJars(ctx, dep)
2399 deps.classpath = append(deps.classpath, dep.Srcs()...)
2400 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2401 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
2402 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002403 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002404 switch tag {
2405 case staticLibTag:
2406 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2407 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002408 } else {
2409 switch tag {
2410 case bootClasspathTag:
2411 // If a system modules dependency has been added to the bootclasspath
2412 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002413 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2414 depHeaderJars := sm.HeaderJars
2415 deps.bootClasspath = append(deps.bootClasspath, depHeaderJars...)
2416 } else {
2417 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2418 ctx.OtherModuleName(module))
2419 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002420
2421 case systemModulesTag:
2422 if deps.systemModules != nil {
2423 panic("Found two system module dependencies")
2424 }
Colin Crossb61c2262024-08-08 14:04:42 -07002425 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2426 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2427 } else {
2428 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2429 ctx.OtherModuleName(module))
2430 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002431
2432 case instrumentationForTag:
2433 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 -07002434 }
2435 }
2436
Spandan Das8aac9932024-07-18 23:14:13 +00002437 if android.InList(tag, compileDependencyTags) {
2438 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2439 j.compileDepNames = append(j.compileDepNames, otherName)
2440 }
2441
Jaewoong Jung26342642021-03-17 15:56:23 -07002442 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002443 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002444 })
2445
2446 return deps
2447}
2448
Joe Onorato349ae8d2024-02-05 22:46:00 +00002449// Provider for jarjar renaming rules.
2450//
2451// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2452// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2453// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2454// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2455// be renamed from that module.
2456// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002457type DependencyUse int
2458
2459const (
2460 RenameUseInvalid DependencyUse = iota
2461 RenameUseInclude
2462 RenameUseExclude
2463)
2464
2465type RenameUseElement struct {
2466 DepName string
2467 RenameUse DependencyUse
2468 Why string // token for determining where in the logic the decision was made.
2469}
2470
Joe Onorato349ae8d2024-02-05 22:46:00 +00002471type JarJarProviderData struct {
2472 // Mapping of class names: original --> renamed. If the value is "", the class will be
2473 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2474 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002475 Rename map[string]string
2476 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002477}
2478
2479func (this JarJarProviderData) GetDebugString() string {
2480 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002481 for _, k := range android.SortedKeys(this.Rename) {
2482 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002483 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2484 result += k + "--&gt;" + v + ";"
2485 }
2486 }
2487 return result
2488}
2489
2490var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2491
2492var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2493
2494func init() {
2495 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
Yu Liu26a716d2024-08-30 23:40:32 +00002496
2497 gob.Register(BaseJarJarProviderData{})
Joe Onorato349ae8d2024-02-05 22:46:00 +00002498}
2499
2500// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2501// whether they are java modules or not.
2502type BaseJarJarProviderData struct {
2503 JarJarProviderData JarJarProviderData
2504}
2505
2506func (this BaseJarJarProviderData) GetDebugString() string {
2507 return this.JarJarProviderData.GetDebugString()
2508}
2509
2510var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2511
2512// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2513// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2514// either JarJarProvider or BaseJarJarProvider.
2515func mergeJarJarPrefixes(ctx android.ModuleContext) {
2516 mod := ctx.Module()
2517 // Explicitly avoid propagating into some module types.
2518 switch reflect.TypeOf(mod).String() {
2519 case "*java.Droidstubs":
2520 return
2521 }
2522 jarJarData := collectDirectDepsProviders(ctx)
2523 if jarJarData != nil {
2524 providerData := BaseJarJarProviderData{
2525 JarJarProviderData: *jarJarData,
2526 }
2527 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2528 }
2529
2530}
2531
2532// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2533func (module *Module) addJarJarRenameRule(original string, renamed string) {
2534 if module.jarjarRenameRules == nil {
2535 module.jarjarRenameRules = make(map[string]string)
2536 }
2537 module.jarjarRenameRules[original] = renamed
2538}
2539
2540func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2541 // Gather repackage information from deps
2542 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002543
2544 module := ctx.Module()
2545 moduleName := module.Name()
2546
Joe Onorato349ae8d2024-02-05 22:46:00 +00002547 ctx.VisitDirectDepsIgnoreBlueprint(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002548 tag := ctx.OtherModuleDependencyTag(m)
2549 // This logic mirrors that in (*Module).collectDeps above. There are several places
2550 // where we explicitly return RenameUseExclude, even though it is the default, to
2551 // indicate that it has been verified to be the case.
2552 //
2553 // Note well: there are probably cases that are getting to the unconditional return
2554 // and are therefore wrong.
2555 shouldIncludeRenames := func() (DependencyUse, string) {
2556 if moduleName == m.Name() {
2557 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2558 }
2559 if sc, ok := module.(android.SdkContext); ok {
2560 if ctx.Device() {
2561 sdkDep := decodeSdkDep(ctx, sc)
2562 if !sdkDep.invalidVersion && sdkDep.useFiles {
2563 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002564 }
2565 }
LaMont Jones63683e42024-02-08 14:30:45 -08002566 }
2567 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2568 return RenameUseExclude, "tags"
2569 }
2570 if _, ok := m.(SdkLibraryDependency); ok {
2571 switch tag {
2572 case sdkLibTag, libTag:
2573 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2574 }
2575 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2576 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2577 switch ji.StubsLinkType {
2578 case Stubs:
2579 return RenameUseExclude, "info"
2580 case Implementation:
2581 return RenameUseInclude, "info"
2582 default:
LaMont Jones09721862024-06-11 10:30:50 -07002583 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002584 // Fall through to the heuristic logic.
2585 }
2586 switch reflect.TypeOf(m).String() {
2587 case "*java.GeneratedJavaLibraryModule":
2588 // Probably a java_aconfig_library module.
2589 // TODO: make this check better.
2590 return RenameUseInclude, "reflect"
2591 }
2592 switch tag {
2593 case bootClasspathTag:
2594 return RenameUseExclude, "tagswitch"
2595 case sdkLibTag, libTag, instrumentationForTag:
2596 return RenameUseInclude, "tagswitch"
2597 case java9LibTag:
2598 return RenameUseExclude, "tagswitch"
2599 case staticLibTag:
2600 return RenameUseInclude, "tagswitch"
2601 case pluginTag:
2602 return RenameUseInclude, "tagswitch"
2603 case errorpronePluginTag:
2604 return RenameUseInclude, "tagswitch"
2605 case exportedPluginTag:
2606 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002607 case kotlinPluginTag:
2608 return RenameUseInclude, "tagswitch"
2609 default:
2610 return RenameUseExclude, "tagswitch"
2611 }
2612 } else if _, ok := m.(android.SourceFileProducer); ok {
2613 switch tag {
2614 case sdkLibTag, libTag, staticLibTag:
2615 return RenameUseInclude, "srcfile"
2616 default:
2617 return RenameUseExclude, "srcfile"
2618 }
Yu Liu67a28422024-03-05 00:36:31 +00002619 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002620 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002621 } else {
2622 switch tag {
2623 case bootClasspathTag:
2624 return RenameUseExclude, "else"
2625 case systemModulesTag:
2626 return RenameUseInclude, "else"
2627 }
2628 }
2629 // If we got here, choose the safer option, which may lead to a build failure, rather
2630 // than runtime failures on the device.
2631 return RenameUseExclude, "end"
2632 }
2633
2634 if result == nil {
2635 result = &JarJarProviderData{
2636 Rename: make(map[string]string),
2637 RenameUse: make([]RenameUseElement, 0),
2638 }
2639 }
2640 how, why := shouldIncludeRenames()
2641 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2642 if how != RenameUseInclude {
2643 // Nothing to merge.
2644 return
2645 }
2646
2647 merge := func(theirs *JarJarProviderData) {
2648 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002649 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2650 result.Rename[orig] = renamed
2651 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2652 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2653 result.Rename[orig] = renamed
2654 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2655 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2656 continue
2657 }
2658 }
2659 }
2660 }
2661 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2662 merge(&theirs)
2663 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2664 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2665 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2666 // to java.Module.
2667 merge(&theirs.JarJarProviderData)
2668 }
2669 })
2670 return
2671}
2672
2673func (this Module) GetDebugString() string {
2674 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2675}
2676
2677// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2678// us, and if it's been set, apply the jarjar_prefix property to rename them.
2679func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2680 // Gather repackage information from deps
2681 result := collectDirectDepsProviders(ctx)
2682
Joe Onoratoa5d17172024-07-20 17:39:56 -07002683 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002684 if result == nil {
2685 result = &JarJarProviderData{
2686 Rename: make(map[string]string),
2687 }
2688 }
2689 if renamed != "" {
2690 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2691 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002692 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002693 }
2694 }
2695 (*result).Rename[orig] = renamed
2696 }
2697
Joe Onoratoa5d17172024-07-20 17:39:56 -07002698 // Update that with entries we've stored for ourself
2699 for orig, renamed := range module.jarjarRenameRules {
2700 add(orig, renamed)
2701 }
2702
2703 // Update that with entries given in the jarjar_rename property.
2704 for _, orig := range module.properties.Jarjar_rename {
2705 add(orig, "")
2706 }
2707
Joe Onorato349ae8d2024-02-05 22:46:00 +00002708 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2709 if result == nil {
2710 return nil
2711 }
2712
2713 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2714 // that have not yet been renamed.
2715 prefix := proptools.String(module.properties.Jarjar_prefix)
2716 if prefix != "" {
2717 if prefix[0] == '.' {
2718 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2719 return nil
2720 }
2721 if prefix[len(prefix)-1] == '.' {
2722 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2723 return nil
2724 }
2725
2726 var updated map[string]string
2727 for orig, renamed := range (*result).Rename {
2728 if renamed == "" {
2729 if updated == nil {
2730 updated = make(map[string]string)
2731 }
2732 updated[orig] = prefix + "." + orig
2733 }
2734 }
2735 for orig, renamed := range updated {
2736 (*result).Rename[orig] = renamed
2737 }
2738 }
2739
2740 return result
2741}
2742
2743// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2744// to "" won't be in this list because they shouldn't be renamed yet.
2745func getJarJarRuleText(provider *JarJarProviderData) string {
2746 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002747 for _, orig := range android.SortedKeys(provider.Rename) {
2748 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002749 if renamed != "" {
2750 result += "rule " + orig + " " + renamed + "\n"
2751 }
2752 }
2753 return result
2754}
2755
Zi Wangddb2ee52024-04-02 16:44:02 +00002756// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Cross7707b242024-07-26 12:02:36 -07002757func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) android.Path {
Zi Wangddb2ee52024-04-02 16:44:02 +00002758 if j.repackageJarjarRules == nil {
2759 return infile
2760 }
Colin Crossedec77c2024-07-26 15:25:40 -07002761 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002762 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
2763 return repackagedJarjarFile
2764}
2765
Colin Crossedec77c2024-07-26 15:25:40 -07002766func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) android.Path {
2767 if j.expandJarjarRules == nil {
2768 return infile
2769 }
2770 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2771 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
2772 return jarjarFile
2773
2774}
2775
Jaewoong Jung26342642021-03-17 15:56:23 -07002776func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2777 deps.processorPath = append(deps.processorPath, pluginJars...)
2778 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2779}
2780
2781// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2782// this interface.
2783type ProvidesUsesLib interface {
2784 ProvidesUsesLib() *string
2785}
2786
2787func (j *Module) ProvidesUsesLib() *string {
2788 return j.usesLibraryProperties.Provides_uses_lib
2789}
satayev1c564cc2021-05-25 19:50:30 +01002790
2791type ModuleWithStem interface {
2792 Stem() string
2793}
2794
2795var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002796
2797type ModuleWithUsesLibrary interface {
2798 UsesLibrary() *usesLibrary
2799}
2800
2801func (j *Module) UsesLibrary() *usesLibrary {
2802 return &j.usesLibrary
2803}
2804
2805var _ ModuleWithUsesLibrary = (*Module)(nil)