blob: e516891a33ced8264767a80305fa4f77e987e1f9 [file] [log] [blame]
Jaewoong Jung26342642021-03-17 15:56:23 -07001// Copyright 2021 Google Inc. All rights reserved.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15package java
16
17import (
18 "fmt"
19 "path/filepath"
Joe Onorato349ae8d2024-02-05 22:46:00 +000020 "reflect"
21 "slices"
Jaewoong Jung26342642021-03-17 15:56:23 -070022 "strconv"
23 "strings"
24
Colin Crossd788b3e2023-11-28 13:14:56 -080025 "github.com/google/blueprint"
Jaewoong Jung26342642021-03-17 15:56:23 -070026 "github.com/google/blueprint/pathtools"
27 "github.com/google/blueprint/proptools"
28
29 "android/soong/android"
30 "android/soong/dexpreopt"
31 "android/soong/java/config"
32)
33
34// This file contains the definition and the implementation of the base module that most
35// source-based Java module structs embed.
36
37// TODO:
38// Autogenerated files:
39// Renderscript
40// Post-jar passes:
41// Proguard
42// Rmtypedefs
43// DroidDoc
44// Findbugs
45
46// Properties that are common to most Java modules, i.e. whether it's a host or device module.
47type CommonProperties struct {
48 // list of source files used to compile the Java module. May be .java, .kt, .logtags, .proto,
49 // or .aidl files.
50 Srcs []string `android:"path,arch_variant"`
51
52 // list Kotlin of source files containing Kotlin code that should be treated as common code in
53 // a codebase that supports Kotlin multiplatform. See
54 // https://kotlinlang.org/docs/reference/multiplatform.html. May be only be .kt files.
55 Common_srcs []string `android:"path,arch_variant"`
56
57 // list of source files that should not be used to build the Java module.
58 // This is most useful in the arch/multilib variants to remove non-common files
59 Exclude_srcs []string `android:"path,arch_variant"`
60
61 // list of directories containing Java resources
62 Java_resource_dirs []string `android:"arch_variant"`
63
64 // list of directories that should be excluded from java_resource_dirs
65 Exclude_java_resource_dirs []string `android:"arch_variant"`
66
67 // list of files to use as Java resources
68 Java_resources []string `android:"path,arch_variant"`
69
70 // list of files that should be excluded from java_resources and java_resource_dirs
71 Exclude_java_resources []string `android:"path,arch_variant"`
72
73 // list of module-specific flags that will be used for javac compiles
74 Javacflags []string `android:"arch_variant"`
75
76 // list of module-specific flags that will be used for kotlinc compiles
77 Kotlincflags []string `android:"arch_variant"`
78
79 // list of java libraries that will be in the classpath
80 Libs []string `android:"arch_variant"`
81
82 // list of java libraries that will be compiled into the resulting jar
83 Static_libs []string `android:"arch_variant"`
84
Jihoon Kang381c2fa2023-06-01 22:17:32 +000085 // list of java libraries that should not be used to build this module
86 Exclude_static_libs []string `android:"arch_variant"`
87
Jaewoong Jung26342642021-03-17 15:56:23 -070088 // manifest file to be included in resulting jar
89 Manifest *string `android:"path"`
90
91 // if not blank, run jarjar using the specified rules file
92 Jarjar_rules *string `android:"path,arch_variant"`
93
Joe Onoratoa5d17172024-07-20 17:39:56 -070094 // java class names to rename with jarjar when a reverse dependency has a jarjar_prefix
95 // property.
96 Jarjar_rename []string
97
Joe Onorato349ae8d2024-02-05 22:46:00 +000098 // if not blank, used as prefix to generate repackage rule
99 Jarjar_prefix *string
100
Zi Wang9bdd4222024-02-26 18:21:01 -0800101 // if set to true, skip the jarjar repackaging
102 Skip_jarjar_repackage *bool
103
Jaewoong Jung26342642021-03-17 15:56:23 -0700104 // If not blank, set the java version passed to javac as -source and -target
105 Java_version *string
106
107 // If set to true, allow this module to be dexed and installed on devices. Has no
108 // effect on host modules, which are always considered installable.
109 Installable *bool
110
111 // If set to true, include sources used to compile the module in to the final jar
112 Include_srcs *bool
113
114 // If not empty, classes are restricted to the specified packages and their sub-packages.
115 // This restriction is checked after applying jarjar rules and including static libs.
116 Permitted_packages []string
117
118 // List of modules to use as annotation processors
119 Plugins []string
120
121 // List of modules to export to libraries that directly depend on this library as annotation
122 // processors. Note that if the plugins set generates_api: true this will disable the turbine
123 // optimization on modules that depend on this module, which will reduce parallelism and cause
124 // more recompilation.
125 Exported_plugins []string
126
127 // The number of Java source entries each Javac instance can process
128 Javac_shard_size *int64
129
130 // Add host jdk tools.jar to bootclasspath
131 Use_tools_jar *bool
132
133 Openjdk9 struct {
134 // List of source files that should only be used when passing -source 1.9 or higher
135 Srcs []string `android:"path"`
136
137 // List of javac flags that should only be used when passing -source 1.9 or higher
138 Javacflags []string
139 }
140
141 // When compiling language level 9+ .java code in packages that are part of
142 // a system module, patch_module names the module that your sources and
143 // dependencies should be patched into. The Android runtime currently
144 // doesn't implement the JEP 261 module system so this option is only
145 // supported at compile time. It should only be needed to compile tests in
146 // packages that exist in libcore and which are inconvenient to move
147 // elsewhere.
Liz Kammer0a470a32023-10-05 17:02:00 -0400148 Patch_module *string
Jaewoong Jung26342642021-03-17 15:56:23 -0700149
150 Jacoco struct {
151 // List of classes to include for instrumentation with jacoco to collect coverage
152 // information at runtime when building with coverage enabled. If unset defaults to all
153 // classes.
154 // Supports '*' as the last character of an entry in the list as a wildcard match.
155 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
156 // it matches classes in the package that have the class name as a prefix.
157 Include_filter []string
158
159 // List of classes to exclude from instrumentation with jacoco to collect coverage
160 // information at runtime when building with coverage enabled. Overrides classes selected
161 // by the include_filter property.
162 // Supports '*' as the last character of an entry in the list as a wildcard match.
163 // If preceded by '.' it matches all classes in the package and subpackages, otherwise
164 // it matches classes in the package that have the class name as a prefix.
165 Exclude_filter []string
166 }
167
168 Errorprone struct {
169 // List of javac flags that should only be used when running errorprone.
170 Javacflags []string
171
172 // List of java_plugin modules that provide extra errorprone checks.
173 Extra_check_modules []string
Cole Faust75fffb12021-06-13 15:23:16 -0700174
Cole Faust2b1536e2021-06-18 12:25:54 -0700175 // This property can be in 3 states. When set to true, errorprone will
176 // be run during the regular build. When set to false, errorprone will
177 // never be run. When unset, errorprone will be run when the RUN_ERROR_PRONE
178 // environment variable is true. Setting this to false will improve build
179 // performance more than adding -XepDisableAllChecks in javacflags.
Cole Faust75fffb12021-06-13 15:23:16 -0700180 Enabled *bool
Jaewoong Jung26342642021-03-17 15:56:23 -0700181 }
182
183 Proto struct {
184 // List of extra options that will be passed to the proto generator.
185 Output_params []string
186 }
187
Sam Delmericoc7593722022-08-31 15:57:52 -0400188 // If true, then jacocoagent is automatically added as a libs dependency so that
189 // r8 will not strip instrumentation classes out of dexed libraries.
Jaewoong Jung26342642021-03-17 15:56:23 -0700190 Instrument bool `blueprint:"mutated"`
Paul Duffin0038a8d2022-05-03 00:28:40 +0000191 // If true, then the module supports statically including the jacocoagent
192 // into the library.
193 Supports_static_instrumentation bool `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700194
195 // List of files to include in the META-INF/services folder of the resulting jar.
196 Services []string `android:"path,arch_variant"`
197
198 // If true, package the kotlin stdlib into the jar. Defaults to true.
199 Static_kotlin_stdlib *bool `android:"arch_variant"`
200
201 // A list of java_library instances that provide additional hiddenapi annotations for the library.
202 Hiddenapi_additional_annotations []string
Joe Onorato175073c2023-06-01 14:42:59 -0700203
204 // Additional srcJars tacked in by GeneratedJavaLibraryModule
205 Generated_srcjars []android.Path `android:"mutated"`
Mark Whitea15790a2023-08-22 21:28:11 +0000206
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000207 // intermediate aconfig cache file tacked in by GeneratedJavaLibraryModule
208 Aconfig_Cache_files []android.Path `android:"mutated"`
209
Mark Whitea15790a2023-08-22 21:28:11 +0000210 // If true, then only the headers are built and not the implementation jar.
Liz Kammer60772632023-10-05 17:18:44 -0400211 Headers_only *bool
Cole Faust2b64af82023-12-13 18:22:18 -0800212
213 // A list of files or dependencies to make available to the build sandbox. This is
214 // useful if source files are symlinks, the targets of the symlinks must be listed here.
215 // Note that currently not all actions implemented by android_apps are sandboxed, so you
216 // may only see this being necessary in lint builds.
217 Compile_data []string `android:"path"`
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000218
219 // Property signifying whether the module compiles stubs or not.
220 // Should be set to true when srcs of this module are stub files.
221 // This property does not need to be set to true when the module depends on
222 // the stubs via libs, but should be set to true when the module depends on
223 // the stubs via static libs.
224 Is_stubs_module *bool
Makoto Onuki7ded3822024-03-28 14:42:20 -0700225
226 // If true, enable the "Ravenizer" tool on the output jar.
227 // "Ravenizer" is a tool for Ravenwood tests, but it can also be enabled on other kinds
228 // of java targets.
229 Ravenizer struct {
230 Enabled *bool
231 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +0000232
233 // Contributing api surface of the stub module. Is not visible to bp modules, and should
234 // only be set for stub submodules generated by the java_sdk_library
235 Stub_contributing_api *string `blueprint:"mutated"`
Jaewoong Jung26342642021-03-17 15:56:23 -0700236}
237
238// Properties that are specific to device modules. Host module factories should not add these when
239// constructing a new module.
240type DeviceProperties struct {
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000241 // If not blank, set to the version of the sdk to compile against.
Spandan Das1ccf5742022-10-14 16:51:23 +0000242 // Defaults to an empty string, which compiles the module against the private platform APIs.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000243 // Values are of one of the following forms:
Vinh Trana9c8f7d2022-04-14 20:18:47 +0000244 // 1) numerical API level, "current", "none", or "core_platform"
245 // 2) An SDK kind with an API level: "<sdk kind>_<API level>"
246 // See build/soong/android/sdk_version.go for the complete and up to date list of SDK kinds.
247 // If the SDK kind is empty, it will be set to public.
Jaewoong Jung26342642021-03-17 15:56:23 -0700248 Sdk_version *string
249
satayev0a420e72021-11-29 17:25:52 +0000250 // if not blank, set the maximum version of the sdk that the compiled artifacts will run against.
251 // Defaults to empty string "". See sdk_version for possible values.
252 Max_sdk_version *string
253
William Loh5a082f92022-05-17 20:21:50 +0000254 // if not blank, set the maxSdkVersion properties of permission and uses-permission tags.
255 // Defaults to empty string "". See sdk_version for possible values.
256 Replace_max_sdk_version_placeholder *string
257
Jaewoong Jung26342642021-03-17 15:56:23 -0700258 // if not blank, set the targetSdkVersion in the AndroidManifest.xml.
Trevor Radcliffe347e5e42021-11-05 19:30:24 +0000259 // Defaults to sdk_version if not set. See sdk_version for possible values.
Jaewoong Jung26342642021-03-17 15:56:23 -0700260 Target_sdk_version *string
261
262 // Whether to compile against the platform APIs instead of an SDK.
263 // If true, then sdk_version must be empty. The value of this field
Vinh Trand91939e2022-04-18 19:27:17 +0000264 // is ignored when module's type isn't android_app, android_test, or android_test_helper_app.
Jaewoong Jung26342642021-03-17 15:56:23 -0700265 Platform_apis *bool
266
267 Aidl struct {
268 // Top level directories to pass to aidl tool
269 Include_dirs []string
270
271 // Directories rooted at the Android.bp file to pass to aidl tool
272 Local_include_dirs []string
273
274 // directories that should be added as include directories for any aidl sources of modules
275 // that depend on this module, as well as to aidl for this module.
276 Export_include_dirs []string
277
278 // whether to generate traces (for systrace) for this interface
279 Generate_traces *bool
280
281 // whether to generate Binder#GetTransaction name method.
282 Generate_get_transaction_name *bool
283
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100284 // whether all interfaces should be annotated with required permissions.
285 Enforce_permissions *bool
286
287 // allowlist for interfaces that (temporarily) do not require annotation for permissions.
288 Enforce_permissions_exceptions []string `android:"path"`
289
Jaewoong Jung26342642021-03-17 15:56:23 -0700290 // list of flags that will be passed to the AIDL compiler
291 Flags []string
292 }
293
294 // If true, export a copy of the module as a -hostdex module for host testing.
295 Hostdex *bool
296
297 Target struct {
298 Hostdex struct {
299 // Additional required dependencies to add to -hostdex modules.
300 Required []string
301 }
302 }
303
304 // When targeting 1.9 and above, override the modules to use with --system,
305 // otherwise provides defaults libraries to add to the bootclasspath.
306 System_modules *string
307
Jaewoong Jung26342642021-03-17 15:56:23 -0700308 IsSDKLibrary bool `blueprint:"mutated"`
309
310 // If true, generate the signature file of APK Signing Scheme V4, along side the signed APK file.
311 // Defaults to false.
312 V4_signature *bool
313
314 // Only for libraries created by a sysprop_library module, SyspropPublicStub is the name of the
315 // public stubs library.
316 SyspropPublicStub string `blueprint:"mutated"`
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000317
318 HiddenAPIPackageProperties
319 HiddenAPIFlagFileProperties
Jaewoong Jung26342642021-03-17 15:56:23 -0700320}
321
yangbill2af0b6e2024-03-15 09:29:29 +0000322// Properties that can be overridden by overriding module (e.g. override_android_app)
323type OverridableProperties struct {
Jooyung Han01d80d82022-01-08 12:16:32 +0900324 // set the name of the output. If not set, `name` is used.
325 // To override a module with this property set, overriding module might need to set this as well.
326 // Otherwise, both the overridden and the overriding modules will have the same output name, which
327 // can cause the duplicate output error.
328 Stem *string
Spandan Dasb9c58352024-05-13 18:29:45 +0000329
330 // if not blank, set the minimum version of the sdk that the compiled artifacts will run against.
331 // Defaults to sdk_version if not set. See sdk_version for possible values.
332 Min_sdk_version *string
Jooyung Han01d80d82022-01-08 12:16:32 +0900333}
334
Jaewoong Jung26342642021-03-17 15:56:23 -0700335// Functionality common to Module and Import
336//
337// It is embedded in Module so its functionality can be used by methods in Module
338// but it is currently only initialized by Import and Library.
339type embeddableInModuleAndImport struct {
340
341 // Functionality related to this being used as a component of a java_sdk_library.
342 EmbeddableSdkLibraryComponent
343}
344
Paul Duffin71b33cc2021-06-23 11:39:47 +0100345func (e *embeddableInModuleAndImport) initModuleAndImport(module android.Module) {
346 e.initSdkLibraryComponent(module)
Jaewoong Jung26342642021-03-17 15:56:23 -0700347}
348
349// Module/Import's DepIsInSameApex(...) delegates to this method.
350//
351// This cannot implement DepIsInSameApex(...) directly as that leads to ambiguity with
352// the one provided by ApexModuleBase.
353func (e *embeddableInModuleAndImport) depIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
354 // dependencies other than the static linkage are all considered crossing APEX boundary
355 if staticLibTag == ctx.OtherModuleDependencyTag(dep) {
356 return true
357 }
358 return false
359}
360
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100361// OptionalDexJarPath can be either unset, hold a valid path to a dex jar file,
362// or an invalid path describing the reason it is invalid.
363//
364// It is unset if a dex jar isn't applicable, i.e. no build rule has been
365// requested to create one.
366//
367// If a dex jar has been requested to be built then it is set, and it may be
368// either a valid android.Path, or invalid with a reason message. The latter
369// happens if the source that should produce the dex file isn't able to.
370//
371// E.g. it is invalid with a reason message if there is a prebuilt APEX that
372// could produce the dex jar through a deapexer module, but the APEX isn't
373// installable so doing so wouldn't be safe.
374type OptionalDexJarPath struct {
375 isSet bool
376 path android.OptionalPath
377}
378
379// IsSet returns true if a path has been set, either invalid or valid.
380func (o OptionalDexJarPath) IsSet() bool {
381 return o.isSet
382}
383
384// Valid returns true if there is a path that is valid.
385func (o OptionalDexJarPath) Valid() bool {
386 return o.isSet && o.path.Valid()
387}
388
389// Path returns the valid path, or panics if it's either not set or is invalid.
390func (o OptionalDexJarPath) Path() android.Path {
391 if !o.isSet {
392 panic("path isn't set")
393 }
394 return o.path.Path()
395}
396
397// PathOrNil returns the path if it's set and valid, or else nil.
398func (o OptionalDexJarPath) PathOrNil() android.Path {
399 if o.Valid() {
400 return o.Path()
401 }
402 return nil
403}
404
405// InvalidReason returns the reason for an invalid path, which is never "". It
406// returns "" for an unset or valid path.
407func (o OptionalDexJarPath) InvalidReason() string {
408 if !o.isSet {
409 return ""
410 }
411 return o.path.InvalidReason()
412}
413
414func (o OptionalDexJarPath) String() string {
415 if !o.isSet {
416 return "<unset>"
417 }
418 return o.path.String()
419}
420
421// makeUnsetDexJarPath returns an unset OptionalDexJarPath.
422func makeUnsetDexJarPath() OptionalDexJarPath {
423 return OptionalDexJarPath{isSet: false}
424}
425
426// makeDexJarPathFromOptionalPath returns an OptionalDexJarPath that is set with
427// the given OptionalPath, which may be valid or invalid.
428func makeDexJarPathFromOptionalPath(path android.OptionalPath) OptionalDexJarPath {
429 return OptionalDexJarPath{isSet: true, path: path}
430}
431
432// makeDexJarPathFromPath returns an OptionalDexJarPath that is set with the
433// valid given path. It returns an unset OptionalDexJarPath if the given path is
434// nil.
435func makeDexJarPathFromPath(path android.Path) OptionalDexJarPath {
436 if path == nil {
437 return makeUnsetDexJarPath()
438 }
439 return makeDexJarPathFromOptionalPath(android.OptionalPathForPath(path))
440}
441
Jaewoong Jung26342642021-03-17 15:56:23 -0700442// Module contains the properties and members used by all java module types
443type Module struct {
444 android.ModuleBase
445 android.DefaultableModuleBase
446 android.ApexModuleBase
Jaewoong Jung26342642021-03-17 15:56:23 -0700447
448 // Functionality common to Module and Import.
449 embeddableInModuleAndImport
450
451 properties CommonProperties
452 protoProperties android.ProtoProperties
453 deviceProperties DeviceProperties
454
yangbill2af0b6e2024-03-15 09:29:29 +0000455 overridableProperties OverridableProperties
Ronald Braunsteincdc66f42024-04-12 11:23:19 -0700456 sourceProperties android.SourceProperties
Jooyung Han01d80d82022-01-08 12:16:32 +0900457
Jaewoong Jung26342642021-03-17 15:56:23 -0700458 // jar file containing header classes including static library dependencies, suitable for
459 // inserting into the bootclasspath/classpath of another compile
460 headerJarFile android.Path
461
Joe Onorato349ae8d2024-02-05 22:46:00 +0000462 repackagedHeaderJarFile android.Path
463
Jaewoong Jung26342642021-03-17 15:56:23 -0700464 // jar file containing implementation classes including static library dependencies but no
465 // resources
466 implementationJarFile android.Path
467
468 // jar file containing only resources including from static library dependencies
469 resourceJar android.Path
470
471 // args and dependencies to package source files into a srcjar
472 srcJarArgs []string
473 srcJarDeps android.Paths
474
Anton Hansson0e73f9e2023-09-20 13:39:57 +0000475 // the source files of this module and all its static dependencies
476 transitiveSrcFiles *android.DepSet[android.Path]
477
Jaewoong Jung26342642021-03-17 15:56:23 -0700478 // jar file containing implementation classes and resources including static library
479 // dependencies
480 implementationAndResourcesJar android.Path
481
482 // output file containing classes.dex and resources
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +0100483 dexJarFile OptionalDexJarPath
Jaewoong Jung26342642021-03-17 15:56:23 -0700484
485 // output file containing uninstrumented classes that will be instrumented by jacoco
486 jacocoReportClassesFile android.Path
487
488 // output file of the module, which may be a classes jar or a dex jar
489 outputFile android.Path
490 extraOutputFiles android.Paths
491
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100492 exportAidlIncludeDirs android.Paths
493 ignoredAidlPermissionList android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700494
495 logtagsSrcs android.Paths
496
497 // installed file for binary dependency
498 installFile android.Path
499
Colin Cross3108ce12021-11-10 14:38:50 -0800500 // installed file for hostdex copy
501 hostdexInstallFile android.InstallPath
502
Chaohui Wangdcbe33c2022-10-11 11:13:30 +0800503 // list of unique .java and .kt source files
504 uniqueSrcFiles android.Paths
505
506 // list of srcjars that was passed to javac
507 compiledSrcJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700508
509 // manifest file to use instead of properties.Manifest
510 overrideManifest android.OptionalPath
511
Jaewoong Jung26342642021-03-17 15:56:23 -0700512 // list of plugins that this java module is exporting
513 exportedPluginJars android.Paths
514
515 // list of plugins that this java module is exporting
516 exportedPluginClasses []string
517
518 // if true, the exported plugins generate API and require disabling turbine.
519 exportedDisableTurbine bool
520
521 // list of source files, collected from srcFiles with unique java and all kt files,
522 // will be used by android.IDEInfo struct
523 expandIDEInfoCompiledSrcs []string
524
525 // expanded Jarjar_rules
526 expandJarjarRules android.Path
527
Joe Onorato349ae8d2024-02-05 22:46:00 +0000528 // jarjar rule for inherited jarjar rules
529 repackageJarjarRules android.Path
530
Jaewoong Jung26342642021-03-17 15:56:23 -0700531 // Extra files generated by the module type to be added as java resources.
532 extraResources android.Paths
533
534 hiddenAPI
535 dexer
536 dexpreopter
537 usesLibrary
538 linter
539
540 // list of the xref extraction files
541 kytheFiles android.Paths
542
Jaewoong Jung26342642021-03-17 15:56:23 -0700543 hideApexVariantFromMake bool
Jiyong Park92315372021-04-02 08:45:46 +0900544
545 sdkVersion android.SdkSpec
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000546 minSdkVersion android.ApiLevel
Spandan Dasa26eda72023-03-02 00:56:06 +0000547 maxSdkVersion android.ApiLevel
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -0400548
549 sourceExtensions []string
Vadim Spivak3c496f02023-06-08 06:14:59 +0000550
551 annoSrcJars android.Paths
Jihoon Kang1bfb6f22023-07-01 00:13:47 +0000552
553 // output file name based on Stem property.
554 // This should be set in every ModuleWithStem's GenerateAndroidBuildActions
555 // or the module should override Stem().
556 stem string
Joe Onorato6fe59eb2023-07-16 13:20:33 -0700557
Joe Onorato349ae8d2024-02-05 22:46:00 +0000558 // Values that will be set in the JarJarProvider data for jarjar repackaging,
559 // and merged with our dependencies' rules.
560 jarjarRenameRules map[string]string
Jihoon Kangfe914ed2024-02-12 22:49:21 +0000561
562 stubsLinkType StubsLinkType
Jihoon Kang3921f0b2024-03-12 23:51:37 +0000563
564 // Paths to the aconfig intermediate cache files that are provided by the
565 // java_aconfig_library or java_library modules that are statically linked
566 // to this module. Does not contain cache files from all transitive dependencies.
567 aconfigCacheFiles android.Paths
Spandan Das8aac9932024-07-18 23:14:13 +0000568
569 // List of soong module dependencies required to compile the current module.
570 // This information is printed out to `Dependencies` field in module_bp_java_deps.json
571 compileDepNames []string
Makoto Onuki7ded3822024-03-28 14:42:20 -0700572
573 ravenizer struct {
574 enabled bool
575 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700576}
577
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000578var _ android.InstallableModule = (*Module)(nil)
579
580// To satisfy the InstallableModule interface
Jihoon Kang224ea082024-08-12 22:38:16 +0000581func (j *Module) StaticDependencyTags() []blueprint.DependencyTag {
582 return []blueprint.DependencyTag{staticLibTag}
583}
584
585// To satisfy the InstallableModule interface
586func (j *Module) DynamicDependencyTags() []blueprint.DependencyTag {
587 return []blueprint.DependencyTag{libTag, sdkLibTag, bootClasspathTag, systemModulesTag,
588 instrumentationForTag, java9LibTag}
Jihoon Kangf86fe9a2024-06-26 22:18:10 +0000589}
590
591// Overrides android.ModuleBase.InstallInProduct()
592func (j *Module) InstallInProduct() bool {
593 return j.ProductSpecific()
594}
595
Jihoon Kang85bc1932024-07-01 17:04:46 +0000596var _ android.StubsAvailableModule = (*Module)(nil)
597
598// To safisfy the StubsAvailableModule interface
599func (j *Module) IsStubsModule() bool {
600 return proptools.Bool(j.properties.Is_stubs_module)
601}
602
Jiyong Park92315372021-04-02 08:45:46 +0900603func (j *Module) CheckStableSdkVersion(ctx android.BaseModuleContext) error {
604 sdkVersion := j.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +0900605 if sdkVersion.Stable() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700606 return nil
607 }
Jiyong Parkf1691d22021-03-29 20:11:58 +0900608 if sdkVersion.Kind == android.SdkCorePlatform {
Paul Duffin1ea7c9f2021-03-15 09:39:13 +0000609 if useLegacyCorePlatformApi(ctx, j.BaseModuleName()) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700610 return fmt.Errorf("non stable SDK %v - uses legacy core platform", sdkVersion)
611 } else {
612 // Treat stable core platform as stable.
613 return nil
614 }
615 } else {
616 return fmt.Errorf("non stable SDK %v", sdkVersion)
617 }
618}
619
620// checkSdkVersions enforces restrictions around SDK dependencies.
621func (j *Module) checkSdkVersions(ctx android.ModuleContext) {
622 if j.RequiresStableAPIs(ctx) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900623 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jiyong Park92315372021-04-02 08:45:46 +0900624 if !sc.SdkVersion(ctx).Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700625 ctx.PropertyErrorf("sdk_version",
626 "sdk_version must have a value when the module is located at vendor or product(only if PRODUCT_ENFORCE_PRODUCT_PARTITION_INTERFACE is set).")
627 }
628 }
629 }
630
631 // Make sure this module doesn't statically link to modules with lower-ranked SDK link type.
632 // See rank() for details.
633 ctx.VisitDirectDeps(func(module android.Module) {
634 tag := ctx.OtherModuleDependencyTag(module)
635 switch module.(type) {
636 // TODO(satayev): cover other types as well, e.g. imports
637 case *Library, *AndroidLibrary:
638 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -0400639 case bootClasspathTag, sdkLibTag, libTag, staticLibTag, java9LibTag:
Jaewoong Jung26342642021-03-17 15:56:23 -0700640 j.checkSdkLinkType(ctx, module.(moduleWithSdkDep), tag.(dependencyTag))
641 }
642 }
643 })
644}
645
646func (j *Module) checkPlatformAPI(ctx android.ModuleContext) {
Jiyong Parkf1691d22021-03-29 20:11:58 +0900647 if sc, ok := ctx.Module().(android.SdkContext); ok {
Jaewoong Jung26342642021-03-17 15:56:23 -0700648 usePlatformAPI := proptools.Bool(j.deviceProperties.Platform_apis)
Jiyong Park92315372021-04-02 08:45:46 +0900649 sdkVersionSpecified := sc.SdkVersion(ctx).Specified()
Jaewoong Jung26342642021-03-17 15:56:23 -0700650 if usePlatformAPI && sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000651 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 -0700652 } else if !usePlatformAPI && !sdkVersionSpecified {
Spandan Das60999342021-11-16 04:15:33 +0000653 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 -0700654 }
655
656 }
657}
658
Mark Whitea15790a2023-08-22 21:28:11 +0000659func (j *Module) checkHeadersOnly(ctx android.ModuleContext) {
660 if _, ok := ctx.Module().(android.SdkContext); ok {
Liz Kammer60772632023-10-05 17:18:44 -0400661 headersOnly := proptools.Bool(j.properties.Headers_only)
Mark Whitea15790a2023-08-22 21:28:11 +0000662 installable := proptools.Bool(j.properties.Installable)
663
664 if headersOnly && installable {
665 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.")
666 }
667 }
668}
669
Jaewoong Jung26342642021-03-17 15:56:23 -0700670func (j *Module) addHostProperties() {
671 j.AddProperties(
672 &j.properties,
yangbill2af0b6e2024-03-15 09:29:29 +0000673 &j.overridableProperties,
Jaewoong Jung26342642021-03-17 15:56:23 -0700674 &j.protoProperties,
675 &j.usesLibraryProperties,
676 )
677}
678
679func (j *Module) addHostAndDeviceProperties() {
680 j.addHostProperties()
681 j.AddProperties(
682 &j.deviceProperties,
683 &j.dexer.dexProperties,
684 &j.dexpreoptProperties,
685 &j.linter.properties,
686 )
687}
688
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000689// provideHiddenAPIPropertyInfo populates a HiddenAPIPropertyInfo from hidden API properties and
690// makes it available through the hiddenAPIPropertyInfoProvider.
691func (j *Module) provideHiddenAPIPropertyInfo(ctx android.ModuleContext) {
692 hiddenAPIInfo := newHiddenAPIPropertyInfo()
693
694 // Populate with flag file paths from the properties.
695 hiddenAPIInfo.extractFlagFilesFromProperties(ctx, &j.deviceProperties.HiddenAPIFlagFileProperties)
696
697 // Populate with package rules from the properties.
698 hiddenAPIInfo.extractPackageRulesFromProperties(&j.deviceProperties.HiddenAPIPackageProperties)
699
Colin Cross40213022023-12-13 15:19:49 -0800700 android.SetProvider(ctx, hiddenAPIPropertyInfoProvider, hiddenAPIInfo)
Paul Duffin3f1ae0b2022-07-27 16:27:42 +0000701}
702
mrziwang9f7b9f42024-07-10 12:18:06 -0700703// helper method for java modules to set OutputFilesProvider
704func setOutputFiles(ctx android.ModuleContext, m Module) {
705 ctx.SetOutputFiles(append(android.Paths{m.outputFile}, m.extraOutputFiles...), "")
706 ctx.SetOutputFiles(android.Paths{m.outputFile}, android.DefaultDistTag)
707 ctx.SetOutputFiles(android.Paths{m.implementationAndResourcesJar}, ".jar")
708 ctx.SetOutputFiles(android.Paths{m.headerJarFile}, ".hjar")
709 if m.dexer.proguardDictionary.Valid() {
710 ctx.SetOutputFiles(android.Paths{m.dexer.proguardDictionary.Path()}, ".proguard_map")
711 }
712 ctx.SetOutputFiles(m.properties.Generated_srcjars, ".generated_srcjars")
713 if m.linter.outputs.xml != nil {
714 ctx.SetOutputFiles(android.Paths{m.linter.outputs.xml}, ".lint")
Jaewoong Jung26342642021-03-17 15:56:23 -0700715 }
716}
717
Jaewoong Jung26342642021-03-17 15:56:23 -0700718func InitJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
719 initJavaModule(module, hod, false)
720}
721
722func InitJavaModuleMultiTargets(module android.DefaultableModule, hod android.HostOrDeviceSupported) {
723 initJavaModule(module, hod, true)
724}
725
726func initJavaModule(module android.DefaultableModule, hod android.HostOrDeviceSupported, multiTargets bool) {
727 multilib := android.MultilibCommon
728 if multiTargets {
729 android.InitAndroidMultiTargetsArchModule(module, hod, multilib)
730 } else {
731 android.InitAndroidArchModule(module, hod, multilib)
732 }
733 android.InitDefaultableModule(module)
734}
735
736func (j *Module) shouldInstrument(ctx android.BaseModuleContext) bool {
737 return j.properties.Instrument &&
738 ctx.Config().IsEnvTrue("EMMA_INSTRUMENT") &&
739 ctx.DeviceConfig().JavaCoverageEnabledForPath(ctx.ModuleDir())
740}
741
742func (j *Module) shouldInstrumentStatic(ctx android.BaseModuleContext) bool {
Paul Duffin0038a8d2022-05-03 00:28:40 +0000743 return j.properties.Supports_static_instrumentation &&
744 j.shouldInstrument(ctx) &&
Jaewoong Jung26342642021-03-17 15:56:23 -0700745 (ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_STATIC") ||
746 ctx.Config().UnbundledBuild())
747}
748
749func (j *Module) shouldInstrumentInApex(ctx android.BaseModuleContext) bool {
750 // Force enable the instrumentation for java code that is built for APEXes ...
751 // except for the jacocoagent itself (because instrumenting jacocoagent using jacocoagent
752 // 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 -0800753 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -0700754 isJacocoAgent := ctx.ModuleName() == "jacocoagent"
Jihoon Kang690df2e2024-05-22 04:27:38 +0000755
Jihoon Kang46d66de2024-05-22 22:42:39 +0000756 if j.DirectlyInAnyApex() && !isJacocoAgent && !apexInfo.IsForPlatform() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700757 if !inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
758 return true
759 } else if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
760 return true
761 }
762 }
763 return false
764}
765
Sam Delmerico1e3f78f2022-09-07 12:07:07 -0400766func (j *Module) setInstrument(value bool) {
767 j.properties.Instrument = value
768}
769
Jiyong Park92315372021-04-02 08:45:46 +0900770func (j *Module) SdkVersion(ctx android.EarlyModuleContext) android.SdkSpec {
771 return android.SdkSpecFrom(ctx, String(j.deviceProperties.Sdk_version))
Jaewoong Jung26342642021-03-17 15:56:23 -0700772}
773
Jiyong Parkf1691d22021-03-29 20:11:58 +0900774func (j *Module) SystemModules() string {
Jaewoong Jung26342642021-03-17 15:56:23 -0700775 return proptools.String(j.deviceProperties.System_modules)
776}
777
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000778func (j *Module) MinSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Spandan Dasb9c58352024-05-13 18:29:45 +0000779 if j.overridableProperties.Min_sdk_version != nil {
780 return android.ApiLevelFrom(ctx, *j.overridableProperties.Min_sdk_version)
Jaewoong Jung26342642021-03-17 15:56:23 -0700781 }
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000782 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700783}
784
Yu Liuf2b94012023-09-19 15:09:10 -0700785func (j *Module) GetDeviceProperties() *DeviceProperties {
786 return &j.deviceProperties
787}
788
Spandan Dasa26eda72023-03-02 00:56:06 +0000789func (j *Module) MaxSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
790 if j.deviceProperties.Max_sdk_version != nil {
791 return android.ApiLevelFrom(ctx, *j.deviceProperties.Max_sdk_version)
792 }
793 // Default is PrivateApiLevel
794 return android.SdkSpecPrivate.ApiLevel
satayev0a420e72021-11-29 17:25:52 +0000795}
796
Spandan Dasa26eda72023-03-02 00:56:06 +0000797func (j *Module) ReplaceMaxSdkVersionPlaceholder(ctx android.EarlyModuleContext) android.ApiLevel {
798 if j.deviceProperties.Replace_max_sdk_version_placeholder != nil {
799 return android.ApiLevelFrom(ctx, *j.deviceProperties.Replace_max_sdk_version_placeholder)
800 }
801 // Default is PrivateApiLevel
802 return android.SdkSpecPrivate.ApiLevel
William Loh5a082f92022-05-17 20:21:50 +0000803}
804
Jiyong Parkf1691d22021-03-29 20:11:58 +0900805func (j *Module) MinSdkVersionString() string {
Spandan Das8c9ae7e2023-03-03 21:20:36 +0000806 return j.minSdkVersion.String()
Jiyong Park92315372021-04-02 08:45:46 +0900807}
808
Spandan Dasca70fc42023-03-01 23:38:49 +0000809func (j *Module) TargetSdkVersion(ctx android.EarlyModuleContext) android.ApiLevel {
Jiyong Park92315372021-04-02 08:45:46 +0900810 if j.deviceProperties.Target_sdk_version != nil {
Spandan Dasca70fc42023-03-01 23:38:49 +0000811 return android.ApiLevelFrom(ctx, *j.deviceProperties.Target_sdk_version)
Jiyong Park92315372021-04-02 08:45:46 +0900812 }
Spandan Dasca70fc42023-03-01 23:38:49 +0000813 return j.SdkVersion(ctx).ApiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -0700814}
815
816func (j *Module) AvailableFor(what string) bool {
817 if what == android.AvailableToPlatform && Bool(j.deviceProperties.Hostdex) {
818 // Exception: for hostdex: true libraries, the platform variant is created
819 // even if it's not marked as available to platform. In that case, the platform
820 // variant is used only for the hostdex and not installed to the device.
821 return true
822 }
823 return j.ApexModuleBase.AvailableFor(what)
824}
825
826func (j *Module) deps(ctx android.BottomUpMutatorContext) {
827 if ctx.Device() {
828 j.linter.deps(ctx)
829
Jiyong Parkf1691d22021-03-29 20:11:58 +0900830 sdkDeps(ctx, android.SdkContext(j), j.dexer)
Jaewoong Jung26342642021-03-17 15:56:23 -0700831
832 if j.deviceProperties.SyspropPublicStub != "" {
833 // This is a sysprop implementation library that has a corresponding sysprop public
834 // stubs library, and a dependency on it so that dependencies on the implementation can
835 // be forwarded to the public stubs library when necessary.
836 ctx.AddVariationDependencies(nil, syspropPublicStubDepTag, j.deviceProperties.SyspropPublicStub)
837 }
838 }
839
840 libDeps := ctx.AddVariationDependencies(nil, libTag, j.properties.Libs...)
Jihoon Kang381c2fa2023-06-01 22:17:32 +0000841
842 j.properties.Static_libs = android.RemoveListFromList(j.properties.Static_libs, j.properties.Exclude_static_libs)
Jaewoong Jung26342642021-03-17 15:56:23 -0700843 ctx.AddVariationDependencies(nil, staticLibTag, j.properties.Static_libs...)
844
845 // Add dependency on libraries that provide additional hidden api annotations.
846 ctx.AddVariationDependencies(nil, hiddenApiAnnotationsTag, j.properties.Hiddenapi_additional_annotations...)
847
Kiyoung Kim9743bab2024-03-28 15:44:56 +0900848 if ctx.Config().EnforceInterPartitionJavaSdkLibrary() {
Jaewoong Jung26342642021-03-17 15:56:23 -0700849 // Require java_sdk_library at inter-partition java dependency to ensure stable
850 // interface between partitions. If inter-partition java_library dependency is detected,
851 // raise build error because java_library doesn't have a stable interface.
852 //
853 // Inputs:
854 // PRODUCT_ENFORCE_INTER_PARTITION_JAVA_SDK_LIBRARY
855 // if true, enable enforcement
856 // PRODUCT_INTER_PARTITION_JAVA_LIBRARY_ALLOWLIST
857 // exception list of java_library names to allow inter-partition dependency
858 for idx := range j.properties.Libs {
859 if libDeps[idx] == nil {
860 continue
861 }
862
863 if javaDep, ok := libDeps[idx].(javaSdkLibraryEnforceContext); ok {
864 // java_sdk_library is always allowed at inter-partition dependency.
865 // So, skip check.
866 if _, ok := javaDep.(*SdkLibrary); ok {
867 continue
868 }
869
870 j.checkPartitionsForJavaDependency(ctx, "libs", javaDep)
871 }
872 }
873 }
874
875 // For library dependencies that are component libraries (like stubs), add the implementation
876 // as a dependency (dexpreopt needs to be against the implementation library, not stubs).
877 for _, dep := range libDeps {
878 if dep != nil {
879 if component, ok := dep.(SdkLibraryComponentDependency); ok {
880 if lib := component.OptionalSdkLibraryImplementation(); lib != nil {
Jiakai Zhangf98da192024-04-15 11:15:41 +0000881 // Add library as optional if it's one of the optional compatibility libs or it's
882 // explicitly listed in the optional_uses_libs property.
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100883 tag := usesLibReqTag
Jiakai Zhangf98da192024-04-15 11:15:41 +0000884 if android.InList(*lib, dexpreopt.OptionalCompatUsesLibs) ||
885 android.InList(*lib, j.usesLibrary.usesLibraryProperties.Optional_uses_libs) {
Ulya Trafimovichf5d91bb2022-05-04 12:00:02 +0100886 tag = usesLibOptTag
887 }
Ulya Trafimovichfc0f6e32021-08-12 16:16:11 +0100888 ctx.AddVariationDependencies(nil, tag, *lib)
Jaewoong Jung26342642021-03-17 15:56:23 -0700889 }
890 }
891 }
892 }
893
894 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), pluginTag, j.properties.Plugins...)
895 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), errorpronePluginTag, j.properties.Errorprone.Extra_check_modules...)
896 ctx.AddFarVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), exportedPluginTag, j.properties.Exported_plugins...)
897
898 android.ProtoDeps(ctx, &j.protoProperties)
899 if j.hasSrcExt(".proto") {
900 protoDeps(ctx, &j.protoProperties)
901 }
902
903 if j.hasSrcExt(".kt") {
904 // TODO(ccross): move this to a mutator pass that can tell if generated sources contain
905 // Kotlin files
Colin Cross882d6002024-08-14 10:24:06 -0700906 tag := staticLibTag
907 if !BoolDefault(j.properties.Static_kotlin_stdlib, true) {
908 tag = libTag
909 }
910 ctx.AddVariationDependencies(nil, tag,
911 "kotlin-stdlib", "kotlin-stdlib-jdk7", "kotlin-stdlib-jdk8", "kotlin-annotations")
Jaewoong Jung26342642021-03-17 15:56:23 -0700912 }
913
914 // Framework libraries need special handling in static coverage builds: they should not have
915 // static dependency on jacoco, otherwise there would be multiple conflicting definitions of
916 // the same jacoco classes coming from different bootclasspath jars.
917 if inList(ctx.ModuleName(), config.InstrumentFrameworkModules) {
918 if ctx.Config().IsEnvTrue("EMMA_INSTRUMENT_FRAMEWORK") {
919 j.properties.Instrument = true
920 }
921 } else if j.shouldInstrumentStatic(ctx) {
922 ctx.AddVariationDependencies(nil, staticLibTag, "jacocoagent")
923 }
Colin Crossa1ff7c62021-09-17 14:11:52 -0700924
925 if j.useCompose() {
926 ctx.AddVariationDependencies(ctx.Config().BuildOSCommonTarget.Variations(), kotlinPluginTag,
927 "androidx.compose.compiler_compiler-hosted")
928 }
Jaewoong Jung26342642021-03-17 15:56:23 -0700929}
930
931func hasSrcExt(srcs []string, ext string) bool {
932 for _, src := range srcs {
933 if filepath.Ext(src) == ext {
934 return true
935 }
936 }
937
938 return false
939}
940
941func (j *Module) hasSrcExt(ext string) bool {
942 return hasSrcExt(j.properties.Srcs, ext)
943}
944
Thiébaud Weksteende8417c2022-02-10 15:41:46 +1100945func (j *Module) individualAidlFlags(ctx android.ModuleContext, aidlFile android.Path) string {
946 var flags string
947
948 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
949 if !android.InList(aidlFile.String(), j.ignoredAidlPermissionList.Strings()) {
950 flags = "-Wmissing-permission-annotation -Werror"
951 }
952 }
953 return flags
954}
955
Jaewoong Jung26342642021-03-17 15:56:23 -0700956func (j *Module) aidlFlags(ctx android.ModuleContext, aidlPreprocess android.OptionalPath,
Sam Delmerico2351eac2022-05-24 17:10:02 +0000957 aidlIncludeDirs android.Paths, aidlSrcs android.Paths) (string, android.Paths) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700958
959 aidlIncludes := android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Local_include_dirs)
960 aidlIncludes = append(aidlIncludes,
961 android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)...)
962 aidlIncludes = append(aidlIncludes,
963 android.PathsForSource(ctx, j.deviceProperties.Aidl.Include_dirs)...)
964
965 var flags []string
966 var deps android.Paths
Sam Delmerico2351eac2022-05-24 17:10:02 +0000967 var includeDirs android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -0700968
969 flags = append(flags, j.deviceProperties.Aidl.Flags...)
970
971 if aidlPreprocess.Valid() {
972 flags = append(flags, "-p"+aidlPreprocess.String())
973 deps = append(deps, aidlPreprocess.Path())
974 } else if len(aidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000975 includeDirs = append(includeDirs, aidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700976 }
977
978 if len(j.exportAidlIncludeDirs) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000979 includeDirs = append(includeDirs, j.exportAidlIncludeDirs...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700980 }
981
982 if len(aidlIncludes) > 0 {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000983 includeDirs = append(includeDirs, aidlIncludes...)
Jaewoong Jung26342642021-03-17 15:56:23 -0700984 }
985
Sam Delmerico2351eac2022-05-24 17:10:02 +0000986 includeDirs = append(includeDirs, android.PathForModuleSrc(ctx))
Jaewoong Jung26342642021-03-17 15:56:23 -0700987 if src := android.ExistentPathForSource(ctx, ctx.ModuleDir(), "src"); src.Valid() {
Sam Delmerico2351eac2022-05-24 17:10:02 +0000988 includeDirs = append(includeDirs, src.Path())
Jaewoong Jung26342642021-03-17 15:56:23 -0700989 }
Sam Delmerico2351eac2022-05-24 17:10:02 +0000990 flags = append(flags, android.JoinWithPrefix(includeDirs.Strings(), "-I"))
991 // add flags for dirs containing AIDL srcs that haven't been specified yet
992 flags = append(flags, genAidlIncludeFlags(ctx, aidlSrcs, includeDirs))
Jaewoong Jung26342642021-03-17 15:56:23 -0700993
Zim8774ae12022-08-17 11:46:34 +0100994 sdkVersion := (j.SdkVersion(ctx)).Kind
Parth Sane000cbe02022-11-22 13:01:22 +0000995 defaultTrace := ((sdkVersion == android.SdkSystemServer) || (sdkVersion == android.SdkCore) || (sdkVersion == android.SdkCorePlatform) || (sdkVersion == android.SdkModule) || (sdkVersion == android.SdkSystem))
Zim8774ae12022-08-17 11:46:34 +0100996 if proptools.BoolDefault(j.deviceProperties.Aidl.Generate_traces, defaultTrace) {
Jaewoong Jung26342642021-03-17 15:56:23 -0700997 flags = append(flags, "-t")
998 }
999
1000 if Bool(j.deviceProperties.Aidl.Generate_get_transaction_name) {
1001 flags = append(flags, "--transaction_names")
1002 }
1003
Thiébaud Weksteende8417c2022-02-10 15:41:46 +11001004 if Bool(j.deviceProperties.Aidl.Enforce_permissions) {
1005 exceptions := j.deviceProperties.Aidl.Enforce_permissions_exceptions
1006 j.ignoredAidlPermissionList = android.PathsForModuleSrcExcludes(ctx, exceptions, nil)
1007 }
1008
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001009 aidlMinSdkVersion := j.MinSdkVersion(ctx).String()
Jooyung Han07f70c02021-11-06 07:08:45 +09001010 flags = append(flags, "--min_sdk_version="+aidlMinSdkVersion)
1011
Jaewoong Jung26342642021-03-17 15:56:23 -07001012 return strings.Join(flags, " "), deps
1013}
1014
1015func (j *Module) collectBuilderFlags(ctx android.ModuleContext, deps deps) javaBuilderFlags {
1016
1017 var flags javaBuilderFlags
1018
1019 // javaVersion flag.
Jiyong Parkf1691d22021-03-29 20:11:58 +09001020 flags.javaVersion = getJavaVersion(ctx, String(j.properties.Java_version), android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07001021
Cole Faust2b1536e2021-06-18 12:25:54 -07001022 epEnabled := j.properties.Errorprone.Enabled
1023 if (ctx.Config().RunErrorProne() && epEnabled == nil) || Bool(epEnabled) {
Paul Duffin74135582022-10-06 11:01:59 +01001024 if config.ErrorProneClasspath == nil && !ctx.Config().RunningInsideUnitTest() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001025 ctx.ModuleErrorf("cannot build with Error Prone, missing external/error_prone?")
1026 }
1027
1028 errorProneFlags := []string{
1029 "-Xplugin:ErrorProne",
1030 "${config.ErrorProneChecks}",
1031 }
1032 errorProneFlags = append(errorProneFlags, j.properties.Errorprone.Javacflags...)
1033
Colin Cross8bf6cad2022-02-28 13:07:03 -08001034 flags.errorProneExtraJavacFlags = "${config.ErrorProneHeapFlags} ${config.ErrorProneFlags} " +
Jaewoong Jung26342642021-03-17 15:56:23 -07001035 "'" + strings.Join(errorProneFlags, " ") + "'"
1036 flags.errorProneProcessorPath = classpath(android.PathsForSource(ctx, config.ErrorProneClasspath))
1037 }
1038
1039 // classpath
1040 flags.bootClasspath = append(flags.bootClasspath, deps.bootClasspath...)
1041 flags.classpath = append(flags.classpath, deps.classpath...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07001042 flags.dexClasspath = append(flags.dexClasspath, deps.dexClasspath...)
Jaewoong Jung26342642021-03-17 15:56:23 -07001043 flags.java9Classpath = append(flags.java9Classpath, deps.java9Classpath...)
1044 flags.processorPath = append(flags.processorPath, deps.processorPath...)
1045 flags.errorProneProcessorPath = append(flags.errorProneProcessorPath, deps.errorProneProcessorPath...)
1046
1047 flags.processors = append(flags.processors, deps.processorClasses...)
1048 flags.processors = android.FirstUniqueStrings(flags.processors)
1049
1050 if len(flags.bootClasspath) == 0 && ctx.Host() && !flags.javaVersion.usesJavaModules() &&
Jiyong Parkf1691d22021-03-29 20:11:58 +09001051 decodeSdkDep(ctx, android.SdkContext(j)).hasStandardLibs() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001052 // Give host-side tools a version of OpenJDK's standard libraries
1053 // close to what they're targeting. As of Dec 2017, AOSP is only
1054 // bundling OpenJDK 8 and 9, so nothing < 8 is available.
1055 //
1056 // When building with OpenJDK 8, the following should have no
1057 // effect since those jars would be available by default.
1058 //
1059 // When building with OpenJDK 9 but targeting a version < 1.8,
1060 // putting them on the bootclasspath means that:
1061 // a) code can't (accidentally) refer to OpenJDK 9 specific APIs
1062 // b) references to existing APIs are not reinterpreted in an
1063 // OpenJDK 9-specific way, eg. calls to subclasses of
1064 // java.nio.Buffer as in http://b/70862583
1065 java8Home := ctx.Config().Getenv("ANDROID_JAVA8_HOME")
1066 flags.bootClasspath = append(flags.bootClasspath,
1067 android.PathForSource(ctx, java8Home, "jre/lib/jce.jar"),
1068 android.PathForSource(ctx, java8Home, "jre/lib/rt.jar"))
1069 if Bool(j.properties.Use_tools_jar) {
1070 flags.bootClasspath = append(flags.bootClasspath,
1071 android.PathForSource(ctx, java8Home, "lib/tools.jar"))
1072 }
1073 }
1074
1075 // systemModules
1076 flags.systemModules = deps.systemModules
1077
Jaewoong Jung26342642021-03-17 15:56:23 -07001078 return flags
1079}
1080
1081func (j *Module) collectJavacFlags(
1082 ctx android.ModuleContext, flags javaBuilderFlags, srcFiles android.Paths) javaBuilderFlags {
1083 // javac flags.
1084 javacFlags := j.properties.Javacflags
Mythri Alle4b9f6182023-10-25 15:17:11 +00001085 var needsDebugInfo bool
Jaewoong Jung26342642021-03-17 15:56:23 -07001086
Mythri Alle4b9f6182023-10-25 15:17:11 +00001087 needsDebugInfo = false
1088 for _, flag := range javacFlags {
1089 if strings.HasPrefix(flag, "-g") {
1090 needsDebugInfo = true
1091 }
1092 }
1093
1094 if ctx.Config().MinimizeJavaDebugInfo() && !ctx.Host() && !needsDebugInfo {
Jaewoong Jung26342642021-03-17 15:56:23 -07001095 // For non-host binaries, override the -g flag passed globally to remove
1096 // local variable debug info to reduce disk and memory usage.
1097 javacFlags = append(javacFlags, "-g:source,lines")
1098 }
1099 javacFlags = append(javacFlags, "-Xlint:-dep-ann")
1100
1101 if flags.javaVersion.usesJavaModules() {
1102 javacFlags = append(javacFlags, j.properties.Openjdk9.Javacflags...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001103 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1104 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1105 ctx.PropertyErrorf("openjdk9.javacflags", "JDK version defaults to higher than 9")
1106 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001107
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001108 if flags.javaVersion.usesJavaModules() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001109 if j.properties.Patch_module != nil {
1110 // Manually specify build directory in case it is not under the repo root.
1111 // (javac doesn't seem to expand into symbolic links when searching for patch-module targets, so
1112 // just adding a symlink under the root doesn't help.)
Lukacs T. Berki9f6c24a2021-08-26 15:07:24 +02001113 patchPaths := []string{".", ctx.Config().SoongOutDir()}
Jaewoong Jung26342642021-03-17 15:56:23 -07001114
Jaewoong Jung26342642021-03-17 15:56:23 -07001115 classPath := flags.classpath.FormJavaClassPath("")
1116 if classPath != "" {
1117 patchPaths = append(patchPaths, classPath)
1118 }
1119 javacFlags = append(
1120 javacFlags,
1121 "--patch-module="+String(j.properties.Patch_module)+"="+strings.Join(patchPaths, ":"))
1122 }
1123 }
1124
1125 if len(javacFlags) > 0 {
1126 // optimization.
1127 ctx.Variable(pctx, "javacFlags", strings.Join(javacFlags, " "))
1128 flags.javacFlags = "$javacFlags"
1129 }
1130
1131 return flags
1132}
1133
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001134func (j *Module) AddJSONData(d *map[string]interface{}) {
1135 (&j.ModuleBase).AddJSONData(d)
1136 (*d)["Java"] = map[string]interface{}{
1137 "SourceExtensions": j.sourceExtensions,
1138 }
1139
1140}
1141
usta0391ca42023-09-19 15:51:59 -04001142func (j *Module) addGeneratedSrcJars(path android.Path) {
1143 j.properties.Generated_srcjars = append(j.properties.Generated_srcjars, path)
Joe Onorato175073c2023-06-01 14:42:59 -07001144}
1145
Colin Cross4eae06d2023-06-20 22:40:02 -07001146func (j *Module) compile(ctx android.ModuleContext, extraSrcJars, extraClasspathJars, extraCombinedJars android.Paths) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00001147 // Auto-propagating jarjar rules
1148 jarjarProviderData := j.collectJarJarRules(ctx)
1149 if jarjarProviderData != nil {
1150 android.SetProvider(ctx, JarJarProvider, *jarjarProviderData)
Zi Wang9bdd4222024-02-26 18:21:01 -08001151 if !proptools.Bool(j.properties.Skip_jarjar_repackage) {
1152 text := getJarJarRuleText(jarjarProviderData)
1153 if text != "" {
1154 ruleTextFile := android.PathForModuleOut(ctx, "repackaged-jarjar", "repackaging.txt")
1155 android.WriteFileRule(ctx, ruleTextFile, text)
1156 j.repackageJarjarRules = ruleTextFile
1157 }
Joe Onorato349ae8d2024-02-05 22:46:00 +00001158 }
1159 }
1160
Jaewoong Jung26342642021-03-17 15:56:23 -07001161 j.exportAidlIncludeDirs = android.PathsForModuleSrc(ctx, j.deviceProperties.Aidl.Export_include_dirs)
1162
Makoto Onuki7ded3822024-03-28 14:42:20 -07001163 if re := proptools.Bool(j.properties.Ravenizer.Enabled); re {
1164 j.ravenizer.enabled = re
1165 }
1166
Jaewoong Jung26342642021-03-17 15:56:23 -07001167 deps := j.collectDeps(ctx)
1168 flags := j.collectBuilderFlags(ctx, deps)
1169
1170 if flags.javaVersion.usesJavaModules() {
1171 j.properties.Srcs = append(j.properties.Srcs, j.properties.Openjdk9.Srcs...)
Liz Kammer9f52f6b2023-10-06 16:47:00 -04001172 } else if len(j.properties.Openjdk9.Javacflags) > 0 {
1173 // java version defaults higher than openjdk 9, these conditionals should no longer be necessary
1174 ctx.PropertyErrorf("openjdk9.srcs", "JDK version defaults to higher than 9")
Jaewoong Jung26342642021-03-17 15:56:23 -07001175 }
Sorin Basca9347ae32021-12-20 11:51:24 +00001176
Jaewoong Jung26342642021-03-17 15:56:23 -07001177 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
Romain Jobredeaux3ec36ad42021-10-29 13:08:48 -04001178 j.sourceExtensions = []string{}
1179 for _, ext := range []string{".kt", ".proto", ".aidl", ".java", ".logtags"} {
1180 if hasSrcExt(srcFiles.Strings(), ext) {
1181 j.sourceExtensions = append(j.sourceExtensions, ext)
1182 }
1183 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001184 if hasSrcExt(srcFiles.Strings(), ".proto") {
1185 flags = protoFlags(ctx, &j.properties, &j.protoProperties, flags)
1186 }
1187
1188 kotlinCommonSrcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Common_srcs, nil)
1189 if len(kotlinCommonSrcFiles.FilterOutByExt(".kt")) > 0 {
1190 ctx.PropertyErrorf("common_srcs", "common_srcs must be .kt files")
1191 }
1192
Sam Delmerico2351eac2022-05-24 17:10:02 +00001193 aidlSrcs := srcFiles.FilterByExt(".aidl")
1194 flags.aidlFlags, flags.aidlDeps = j.aidlFlags(ctx, deps.aidlPreprocess, deps.aidlIncludeDirs, aidlSrcs)
1195
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001196 nonGeneratedSrcJars := srcFiles.FilterByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001197 srcFiles = j.genSources(ctx, srcFiles, flags)
1198
1199 // Collect javac flags only after computing the full set of srcFiles to
1200 // ensure that the --patch-module lookup paths are complete.
1201 flags = j.collectJavacFlags(ctx, flags, srcFiles)
1202
1203 srcJars := srcFiles.FilterByExt(".srcjar")
1204 srcJars = append(srcJars, deps.srcJars...)
Colin Cross4eae06d2023-06-20 22:40:02 -07001205 srcJars = append(srcJars, extraSrcJars...)
Joe Onorato175073c2023-06-01 14:42:59 -07001206 srcJars = append(srcJars, j.properties.Generated_srcjars...)
Colin Crossb0ef30a2021-06-29 10:42:00 -07001207 srcFiles = srcFiles.FilterOutByExt(".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001208
1209 if j.properties.Jarjar_rules != nil {
1210 j.expandJarjarRules = android.PathForModuleSrc(ctx, *j.properties.Jarjar_rules)
1211 }
1212
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00001213 jarName := j.Stem() + ".jar"
Jaewoong Jung26342642021-03-17 15:56:23 -07001214
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001215 var uniqueJavaFiles android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001216 set := make(map[string]bool)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001217 for _, v := range srcFiles.FilterByExt(".java") {
Jaewoong Jung26342642021-03-17 15:56:23 -07001218 if _, found := set[v.String()]; !found {
1219 set[v.String()] = true
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001220 uniqueJavaFiles = append(uniqueJavaFiles, v)
Jaewoong Jung26342642021-03-17 15:56:23 -07001221 }
1222 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001223 var uniqueKtFiles android.Paths
1224 for _, v := range srcFiles.FilterByExt(".kt") {
1225 if _, found := set[v.String()]; !found {
1226 set[v.String()] = true
1227 uniqueKtFiles = append(uniqueKtFiles, v)
1228 }
1229 }
1230
1231 var uniqueSrcFiles android.Paths
1232 uniqueSrcFiles = append(uniqueSrcFiles, uniqueJavaFiles...)
1233 uniqueSrcFiles = append(uniqueSrcFiles, uniqueKtFiles...)
1234 j.uniqueSrcFiles = uniqueSrcFiles
Colin Cross40213022023-12-13 15:19:49 -08001235 android.SetProvider(ctx, blueprint.SrcsFileProviderKey, blueprint.SrcsFileProviderData{SrcPaths: uniqueSrcFiles.Strings()})
Jaewoong Jung26342642021-03-17 15:56:23 -07001236
Colin Crossb5db4012022-03-28 17:12:39 -07001237 // We don't currently run annotation processors in turbine, which means we can't use turbine
1238 // generated header jars when an annotation processor that generates API is enabled. One
1239 // exception (handled further below) is when kotlin sources are enabled, in which case turbine
1240 // is used to run all of the annotation processors.
1241 disableTurbine := deps.disableTurbine
1242
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001243 // Collect .java and .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001244 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, uniqueSrcFiles.Strings()...)
1245
1246 var kotlinJars android.Paths
Colin Cross220a9a12022-03-28 17:08:01 -07001247 var kotlinHeaderJars android.Paths
Jaewoong Jung26342642021-03-17 15:56:23 -07001248
Colin Cross4eae06d2023-06-20 22:40:02 -07001249 // Prepend extraClasspathJars to classpath so that the resource processor R.jar comes before
1250 // any dependencies so that it can override any non-final R classes from dependencies with the
1251 // final R classes from the app.
1252 flags.classpath = append(android.CopyOf(extraClasspathJars), flags.classpath...)
1253
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001254 j.aconfigCacheFiles = append(deps.aconfigProtoFiles, j.properties.Aconfig_Cache_files...)
1255
Mark Whitea15790a2023-08-22 21:28:11 +00001256 // If compiling headers then compile them and skip the rest
Liz Kammer60772632023-10-05 17:18:44 -04001257 if proptools.Bool(j.properties.Headers_only) {
Mark Whitea15790a2023-08-22 21:28:11 +00001258 if srcFiles.HasExt(".kt") {
1259 ctx.ModuleErrorf("Compiling headers_only with .kt not supported")
1260 }
1261 if ctx.Config().IsEnvFalse("TURBINE_ENABLED") || disableTurbine {
1262 ctx.ModuleErrorf("headers_only is enabled but Turbine is disabled.")
1263 }
1264
Colin Crossedec77c2024-07-26 15:25:40 -07001265 _, combinedHeaderJarFile := j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName,
1266 extraCombinedJars)
1267
1268 combinedHeaderJarFile = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1269 combinedHeaderJarFile = j.repackageFlagsIfNecessary(ctx, combinedHeaderJarFile, jarName, "repackage-turbine")
Mark Whitea15790a2023-08-22 21:28:11 +00001270 if ctx.Failed() {
1271 return
1272 }
Colin Crossedec77c2024-07-26 15:25:40 -07001273 j.headerJarFile = combinedHeaderJarFile
Mark Whitea15790a2023-08-22 21:28:11 +00001274
Colin Cross7727c7f2024-07-18 15:36:32 -07001275 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001276 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1277 TransitiveLibsHeaderJars: j.transitiveLibsHeaderJars,
1278 TransitiveStaticLibsHeaderJars: j.transitiveStaticLibsHeaderJars,
1279 AidlIncludeDirs: j.exportAidlIncludeDirs,
1280 ExportedPlugins: j.exportedPluginJars,
1281 ExportedPluginClasses: j.exportedPluginClasses,
1282 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1283 StubsLinkType: j.stubsLinkType,
1284 AconfigIntermediateCacheOutputPaths: deps.aconfigProtoFiles,
Mark Whitea15790a2023-08-22 21:28:11 +00001285 })
1286
1287 j.outputFile = j.headerJarFile
1288 return
1289 }
1290
Jaewoong Jung26342642021-03-17 15:56:23 -07001291 if srcFiles.HasExt(".kt") {
Colin Crossb5db4012022-03-28 17:12:39 -07001292 // When using kotlin sources turbine is used to generate annotation processor sources,
1293 // including for annotation processors that generate API, so we can use turbine for
1294 // java sources too.
1295 disableTurbine = false
1296
Jaewoong Jung26342642021-03-17 15:56:23 -07001297 // user defined kotlin flags.
1298 kotlincFlags := j.properties.Kotlincflags
1299 CheckKotlincFlags(ctx, kotlincFlags)
1300
Aurimas Liutikas24a987f2021-05-17 17:47:10 +00001301 // Workaround for KT-46512
1302 kotlincFlags = append(kotlincFlags, "-Xsam-conversions=class")
Jaewoong Jung26342642021-03-17 15:56:23 -07001303
1304 // If there are kotlin files, compile them first but pass all the kotlin and java files
1305 // kotlinc will use the java files to resolve types referenced by the kotlin files, but
1306 // won't emit any classes for them.
1307 kotlincFlags = append(kotlincFlags, "-no-stdlib")
1308 if ctx.Device() {
1309 kotlincFlags = append(kotlincFlags, "-no-jdk")
1310 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07001311
1312 for _, plugin := range deps.kotlinPlugins {
1313 kotlincFlags = append(kotlincFlags, "-Xplugin="+plugin.String())
1314 }
1315 flags.kotlincDeps = append(flags.kotlincDeps, deps.kotlinPlugins...)
1316
Jaewoong Jung26342642021-03-17 15:56:23 -07001317 if len(kotlincFlags) > 0 {
1318 // optimization.
1319 ctx.Variable(pctx, "kotlincFlags", strings.Join(kotlincFlags, " "))
1320 flags.kotlincFlags += "$kotlincFlags"
1321 }
1322
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001323 // Collect common .kt files for AIDEGen
Jaewoong Jung26342642021-03-17 15:56:23 -07001324 j.expandIDEInfoCompiledSrcs = append(j.expandIDEInfoCompiledSrcs, kotlinCommonSrcFiles.Strings()...)
1325
Jaewoong Jung26342642021-03-17 15:56:23 -07001326 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.bootClasspath...)
1327 flags.kotlincClasspath = append(flags.kotlincClasspath, flags.classpath...)
1328
Isaac Chioua23d9942022-04-06 06:14:38 +00001329 if len(flags.processorPath) > 0 {
Jaewoong Jung26342642021-03-17 15:56:23 -07001330 // Use kapt for annotation processing
Isaac Chioua23d9942022-04-06 06:14:38 +00001331 kaptSrcJar := android.PathForModuleOut(ctx, "kapt", "kapt-sources.jar")
1332 kaptResJar := android.PathForModuleOut(ctx, "kapt", "kapt-res.jar")
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001333 kotlinKapt(ctx, kaptSrcJar, kaptResJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Isaac Chioua23d9942022-04-06 06:14:38 +00001334 srcJars = append(srcJars, kaptSrcJar)
1335 kotlinJars = append(kotlinJars, kaptResJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001336 // Disable annotation processing in javac, it's already been handled by kapt
1337 flags.processorPath = nil
1338 flags.processors = nil
1339 }
1340
1341 kotlinJar := android.PathForModuleOut(ctx, "kotlin", jarName)
Colin Cross220a9a12022-03-28 17:08:01 -07001342 kotlinHeaderJar := android.PathForModuleOut(ctx, "kotlin_headers", jarName)
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001343 kotlinCompile(ctx, kotlinJar, kotlinHeaderJar, uniqueSrcFiles, kotlinCommonSrcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001344 if ctx.Failed() {
1345 return
1346 }
1347
Colin Cross7707b242024-07-26 12:02:36 -07001348 kotlinJarPath := j.repackageFlagsIfNecessary(ctx, kotlinJar, jarName, "kotlinc")
Zi Wangddb2ee52024-04-02 16:44:02 +00001349
Isaac Chioua23d9942022-04-06 06:14:38 +00001350 // Make javac rule depend on the kotlinc rule
1351 flags.classpath = append(classpath{kotlinHeaderJar}, flags.classpath...)
1352
Zi Wangddb2ee52024-04-02 16:44:02 +00001353 kotlinJars = append(kotlinJars, kotlinJarPath)
Colin Cross220a9a12022-03-28 17:08:01 -07001354 kotlinHeaderJars = append(kotlinHeaderJars, kotlinHeaderJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001355 }
1356
Colin Crossfd620b22024-02-23 10:05:21 -08001357 jars := slices.Clone(kotlinJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001358
Jaewoong Jung26342642021-03-17 15:56:23 -07001359 j.compiledSrcJars = srcJars
1360
1361 enableSharding := false
Colin Cross3d56ed52021-11-18 22:23:12 -08001362 var headerJarFileWithoutDepsOrJarjar android.Path
Colin Crossb5db4012022-03-28 17:12:39 -07001363 if ctx.Device() && !ctx.Config().IsEnvFalse("TURBINE_ENABLED") && !disableTurbine {
Jaewoong Jung26342642021-03-17 15:56:23 -07001364 if j.properties.Javac_shard_size != nil && *(j.properties.Javac_shard_size) > 0 {
1365 enableSharding = true
1366 // Formerly, there was a check here that prevented annotation processors
1367 // from being used when sharding was enabled, as some annotation processors
1368 // do not function correctly in sharded environments. It was removed to
1369 // allow for the use of annotation processors that do function correctly
1370 // with sharding enabled. See: b/77284273.
1371 }
Colin Crossd1d8f172024-07-29 11:30:29 -07001372 extraJars := slices.Clone(kotlinHeaderJars)
Colin Crossd1d8f172024-07-29 11:30:29 -07001373 extraJars = append(extraJars, extraCombinedJars...)
Colin Crossedec77c2024-07-26 15:25:40 -07001374 var combinedHeaderJarFile android.Path
1375 headerJarFileWithoutDepsOrJarjar, combinedHeaderJarFile =
Colin Cross4eae06d2023-06-20 22:40:02 -07001376 j.compileJavaHeader(ctx, uniqueJavaFiles, srcJars, deps, flags, jarName, extraJars)
Colin Crossedec77c2024-07-26 15:25:40 -07001377
1378 j.headerJarFile = j.jarjarIfNecessary(ctx, combinedHeaderJarFile, jarName, "turbine")
1379 j.repackagedHeaderJarFile = j.repackageFlagsIfNecessary(ctx, j.headerJarFile, jarName, "turbine")
Jaewoong Jung26342642021-03-17 15:56:23 -07001380 }
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001381 if len(uniqueJavaFiles) > 0 || len(srcJars) > 0 {
Cole Faust2d516df2022-08-24 11:22:52 -07001382 hasErrorproneableFiles := false
1383 for _, ext := range j.sourceExtensions {
1384 if ext != ".proto" && ext != ".aidl" {
1385 // Skip running errorprone on pure proto or pure aidl modules. Some modules take a long time to
1386 // compile, and it's not useful to have warnings on these generated sources.
1387 hasErrorproneableFiles = true
1388 break
1389 }
1390 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001391 var extraJarDeps android.Paths
Cole Faust75fffb12021-06-13 15:23:16 -07001392 if Bool(j.properties.Errorprone.Enabled) {
1393 // If error-prone is enabled, enable errorprone flags on the regular
1394 // build.
1395 flags = enableErrorproneFlags(flags)
Cole Faust2d516df2022-08-24 11:22:52 -07001396 } else if hasErrorproneableFiles && ctx.Config().RunErrorProne() && j.properties.Errorprone.Enabled == nil {
Cole Faust75fffb12021-06-13 15:23:16 -07001397 // Otherwise, if the RUN_ERROR_PRONE environment variable is set, create
1398 // a new jar file just for compiling with the errorprone compiler to.
1399 // This is because we don't want to cause the java files to get completely
1400 // rebuilt every time the state of the RUN_ERROR_PRONE variable changes.
1401 // We also don't want to run this if errorprone is enabled by default for
1402 // this module, or else we could have duplicated errorprone messages.
1403 errorproneFlags := enableErrorproneFlags(flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001404 errorprone := android.PathForModuleOut(ctx, "errorprone", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001405 errorproneAnnoSrcJar := android.PathForModuleOut(ctx, "errorprone", "anno.srcjar")
Cole Faust75fffb12021-06-13 15:23:16 -07001406
Vadim Spivak3c496f02023-06-08 06:14:59 +00001407 transformJavaToClasses(ctx, errorprone, -1, uniqueJavaFiles, srcJars, errorproneAnnoSrcJar, errorproneFlags, nil,
Cole Faust75fffb12021-06-13 15:23:16 -07001408 "errorprone", "errorprone")
1409
Jaewoong Jung26342642021-03-17 15:56:23 -07001410 extraJarDeps = append(extraJarDeps, errorprone)
1411 }
1412
1413 if enableSharding {
Colin Cross3d56ed52021-11-18 22:23:12 -08001414 if headerJarFileWithoutDepsOrJarjar != nil {
1415 flags.classpath = append(classpath{headerJarFileWithoutDepsOrJarjar}, flags.classpath...)
1416 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001417 shardSize := int(*(j.properties.Javac_shard_size))
1418 var shardSrcs []android.Paths
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001419 if len(uniqueJavaFiles) > 0 {
1420 shardSrcs = android.ShardPaths(uniqueJavaFiles, shardSize)
Jaewoong Jung26342642021-03-17 15:56:23 -07001421 for idx, shardSrc := range shardSrcs {
1422 classes := j.compileJavaClasses(ctx, jarName, idx, shardSrc,
1423 nil, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001424 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(idx))
Jaewoong Jung26342642021-03-17 15:56:23 -07001425 jars = append(jars, classes)
1426 }
1427 }
Colin Crossa052ddb2023-09-25 21:46:58 -07001428 // Assume approximately 5 sources per srcjar.
1429 // For framework-minus-apex in AOSP at the time this was written, there are 266 srcjars, with a mean
1430 // 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 -07001431 if len(srcJars) > 0 {
Colin Crossa052ddb2023-09-25 21:46:58 -07001432 startIdx := len(shardSrcs)
1433 shardSrcJarsList := android.ShardPaths(srcJars, shardSize/5)
1434 for idx, shardSrcJars := range shardSrcJarsList {
1435 classes := j.compileJavaClasses(ctx, jarName, startIdx+idx,
1436 nil, shardSrcJars, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001437 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac-"+strconv.Itoa(startIdx+idx))
Colin Crossa052ddb2023-09-25 21:46:58 -07001438 jars = append(jars, classes)
1439 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001440 }
1441 } else {
Chaohui Wangdcbe33c2022-10-11 11:13:30 +08001442 classes := j.compileJavaClasses(ctx, jarName, -1, uniqueJavaFiles, srcJars, flags, extraJarDeps)
Zi Wangddb2ee52024-04-02 16:44:02 +00001443 classes = j.repackageFlagsIfNecessary(ctx, classes, jarName, "javac")
Jaewoong Jung26342642021-03-17 15:56:23 -07001444 jars = append(jars, classes)
1445 }
1446 if ctx.Failed() {
1447 return
1448 }
1449 }
1450
Colin Crossfd620b22024-02-23 10:05:21 -08001451 jars = append(jars, extraCombinedJars...)
1452
Jaewoong Jung26342642021-03-17 15:56:23 -07001453 j.srcJarArgs, j.srcJarDeps = resourcePathsToJarArgs(srcFiles), srcFiles
1454
1455 var includeSrcJar android.WritablePath
1456 if Bool(j.properties.Include_srcs) {
1457 includeSrcJar = android.PathForModuleOut(ctx, ctx.ModuleName()+".srcjar")
1458 TransformResourcesToJar(ctx, includeSrcJar, j.srcJarArgs, j.srcJarDeps)
1459 }
1460
1461 dirArgs, dirDeps := ResourceDirsToJarArgs(ctx, j.properties.Java_resource_dirs,
1462 j.properties.Exclude_java_resource_dirs, j.properties.Exclude_java_resources)
1463 fileArgs, fileDeps := ResourceFilesToJarArgs(ctx, j.properties.Java_resources, j.properties.Exclude_java_resources)
1464 extraArgs, extraDeps := resourcePathsToJarArgs(j.extraResources), j.extraResources
1465
1466 var resArgs []string
1467 var resDeps android.Paths
1468
1469 resArgs = append(resArgs, dirArgs...)
1470 resDeps = append(resDeps, dirDeps...)
1471
1472 resArgs = append(resArgs, fileArgs...)
1473 resDeps = append(resDeps, fileDeps...)
1474
1475 resArgs = append(resArgs, extraArgs...)
1476 resDeps = append(resDeps, extraDeps...)
1477
1478 if len(resArgs) > 0 {
1479 resourceJar := android.PathForModuleOut(ctx, "res", jarName)
1480 TransformResourcesToJar(ctx, resourceJar, resArgs, resDeps)
1481 j.resourceJar = resourceJar
1482 if ctx.Failed() {
1483 return
1484 }
1485 }
1486
1487 var resourceJars android.Paths
1488 if j.resourceJar != nil {
1489 resourceJars = append(resourceJars, j.resourceJar)
1490 }
1491 if Bool(j.properties.Include_srcs) {
1492 resourceJars = append(resourceJars, includeSrcJar)
1493 }
1494 resourceJars = append(resourceJars, deps.staticResourceJars...)
1495
1496 if len(resourceJars) > 1 {
1497 combinedJar := android.PathForModuleOut(ctx, "res-combined", jarName)
1498 TransformJarsToJar(ctx, combinedJar, "for resources", resourceJars, android.OptionalPath{},
1499 false, nil, nil)
1500 j.resourceJar = combinedJar
1501 } else if len(resourceJars) == 1 {
1502 j.resourceJar = resourceJars[0]
1503 }
1504
1505 if len(deps.staticJars) > 0 {
1506 jars = append(jars, deps.staticJars...)
1507 }
1508
1509 manifest := j.overrideManifest
1510 if !manifest.Valid() && j.properties.Manifest != nil {
1511 manifest = android.OptionalPathForPath(android.PathForModuleSrc(ctx, *j.properties.Manifest))
1512 }
1513
1514 services := android.PathsForModuleSrc(ctx, j.properties.Services)
1515 if len(services) > 0 {
1516 servicesJar := android.PathForModuleOut(ctx, "services", jarName)
1517 var zipargs []string
1518 for _, file := range services {
1519 serviceFile := file.String()
1520 zipargs = append(zipargs, "-C", filepath.Dir(serviceFile), "-f", serviceFile)
1521 }
1522 rule := zip
1523 args := map[string]string{
1524 "jarArgs": "-P META-INF/services/ " + strings.Join(proptools.NinjaAndShellEscapeList(zipargs), " "),
1525 }
1526 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_ZIP") {
1527 rule = zipRE
1528 args["implicits"] = strings.Join(services.Strings(), ",")
1529 }
1530 ctx.Build(pctx, android.BuildParams{
1531 Rule: rule,
1532 Output: servicesJar,
1533 Implicits: services,
1534 Args: args,
1535 })
1536 jars = append(jars, servicesJar)
1537 }
1538
1539 // Combine the classes built from sources, any manifests, and any static libraries into
1540 // classes.jar. If there is only one input jar this step will be skipped.
Colin Cross7707b242024-07-26 12:02:36 -07001541 var outputFile android.Path
Jaewoong Jung26342642021-03-17 15:56:23 -07001542
1543 if len(jars) == 1 && !manifest.Valid() {
1544 // Optimization: skip the combine step as there is nothing to do
1545 // TODO(ccross): this leaves any module-info.class files, but those should only come from
1546 // prebuilt dependencies until we support modules in the platform build, so there shouldn't be
1547 // any if len(jars) == 1.
1548
Jihoon Kang1147b312023-06-08 23:25:57 +00001549 // moduleStubLinkType determines if the module is the TopLevelStubLibrary generated
1550 // from sdk_library. The TopLevelStubLibrary contains only one static lib,
1551 // either with .from-source or .from-text suffix.
1552 // outputFile should be agnostic to the build configuration,
1553 // thus "combine" the single static lib in order to prevent the static lib from being exposed
1554 // to the copy rules.
Jihoon Kangfa3f0782024-08-21 20:42:18 +00001555 stub, _ := moduleStubLinkType(j)
Jihoon Kang1147b312023-06-08 23:25:57 +00001556
Colin Cross7707b242024-07-26 12:02:36 -07001557 if stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07001558 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1559 ctx.Build(pctx, android.BuildParams{
1560 Rule: android.Cp,
1561 Input: jars[0],
1562 Output: combinedJar,
1563 })
Colin Cross7707b242024-07-26 12:02:36 -07001564 outputFile = combinedJar
1565 } else {
1566 outputFile = jars[0]
Jaewoong Jung26342642021-03-17 15:56:23 -07001567 }
1568 } else {
1569 combinedJar := android.PathForModuleOut(ctx, "combined", jarName)
1570 TransformJarsToJar(ctx, combinedJar, "for javac", jars, manifest,
1571 false, nil, nil)
Colin Cross7707b242024-07-26 12:02:36 -07001572 outputFile = combinedJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001573 }
1574
1575 // jarjar implementation jar if necessary
Colin Crossedec77c2024-07-26 15:25:40 -07001576 jarjarFile := j.jarjarIfNecessary(ctx, outputFile, jarName, "")
1577 outputFile = jarjarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001578
Colin Crossedec77c2024-07-26 15:25:40 -07001579 // jarjar resource jar if necessary
1580 if j.resourceJar != nil {
1581 resourceJarJarFile := j.jarjarIfNecessary(ctx, j.resourceJar, jarName, "resource")
1582 j.resourceJar = resourceJarJarFile
1583 }
Jaewoong Jung26342642021-03-17 15:56:23 -07001584
Colin Crossedec77c2024-07-26 15:25:40 -07001585 if ctx.Failed() {
1586 return
Jaewoong Jung26342642021-03-17 15:56:23 -07001587 }
1588
Makoto Onuki7ded3822024-03-28 14:42:20 -07001589 if j.ravenizer.enabled {
1590 ravenizerInput := outputFile
1591 ravenizerOutput := android.PathForModuleOut(ctx, "ravenizer", jarName)
1592 ctx.Build(pctx, android.BuildParams{
1593 Rule: ravenizer,
1594 Description: "ravenizer",
1595 Input: ravenizerInput,
1596 Output: ravenizerOutput,
1597 })
1598 outputFile = ravenizerOutput
1599 }
1600
Jaewoong Jung26342642021-03-17 15:56:23 -07001601 // Check package restrictions if necessary.
1602 if len(j.properties.Permitted_packages) > 0 {
Paul Duffin08a18bf2021-10-01 13:19:58 +01001603 // Time stamp file created by the package check rule.
Jaewoong Jung26342642021-03-17 15:56:23 -07001604 pkgckFile := android.PathForModuleOut(ctx, "package-check.stamp")
Paul Duffin08a18bf2021-10-01 13:19:58 +01001605
1606 // Create a rule to copy the output jar to another path and add a validate dependency that
1607 // will check that the jar only contains the permitted packages. The new location will become
1608 // the output file of this module.
1609 inputFile := outputFile
Colin Cross7707b242024-07-26 12:02:36 -07001610 packageCheckOutputFile := android.PathForModuleOut(ctx, "package-check", jarName)
Paul Duffin08a18bf2021-10-01 13:19:58 +01001611 ctx.Build(pctx, android.BuildParams{
1612 Rule: android.Cp,
1613 Input: inputFile,
Colin Cross7707b242024-07-26 12:02:36 -07001614 Output: packageCheckOutputFile,
Paul Duffin08a18bf2021-10-01 13:19:58 +01001615 // Make sure that any dependency on the output file will cause ninja to run the package check
1616 // rule.
1617 Validation: pkgckFile,
1618 })
Colin Cross7707b242024-07-26 12:02:36 -07001619 outputFile = packageCheckOutputFile
Paul Duffin08a18bf2021-10-01 13:19:58 +01001620
1621 // Check packages and create a timestamp file when complete.
Jaewoong Jung26342642021-03-17 15:56:23 -07001622 CheckJarPackages(ctx, pkgckFile, outputFile, j.properties.Permitted_packages)
Jaewoong Jung26342642021-03-17 15:56:23 -07001623
1624 if ctx.Failed() {
1625 return
1626 }
1627 }
1628
1629 j.implementationJarFile = outputFile
1630 if j.headerJarFile == nil {
Colin Crossf06d8dc2023-07-18 22:11:07 -07001631 // If this module couldn't generate a header jar (for example due to api generating annotation processors)
1632 // then use the implementation jar. Run it through zip2zip first to remove any files in META-INF/services
1633 // so that javac on modules that depend on this module don't pick up annotation processors (which may be
1634 // missing their implementations) from META-INF/services/javax.annotation.processing.Processor.
1635 headerJarFile := android.PathForModuleOut(ctx, "javac-header", jarName)
1636 convertImplementationJarToHeaderJar(ctx, j.implementationJarFile, headerJarFile)
1637 j.headerJarFile = headerJarFile
Jaewoong Jung26342642021-03-17 15:56:23 -07001638 }
1639
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001640 // enforce syntax check to jacoco filters for any build (http://b/183622051)
1641 specs := j.jacocoModuleToZipCommand(ctx)
1642 if ctx.Failed() {
1643 return
1644 }
1645
Jaewoong Jung26342642021-03-17 15:56:23 -07001646 if j.shouldInstrument(ctx) {
Yuntao Xu5b009ae2021-05-13 12:42:24 -07001647 outputFile = j.instrument(ctx, flags, outputFile, jarName, specs)
Jaewoong Jung26342642021-03-17 15:56:23 -07001648 }
1649
1650 // merge implementation jar with resources if necessary
1651 implementationAndResourcesJar := outputFile
1652 if j.resourceJar != nil {
1653 jars := android.Paths{j.resourceJar, implementationAndResourcesJar}
Colin Cross7707b242024-07-26 12:02:36 -07001654 combinedJar := android.PathForModuleOut(ctx, "withres", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001655 TransformJarsToJar(ctx, combinedJar, "for resources", jars, manifest,
1656 false, nil, nil)
1657 implementationAndResourcesJar = combinedJar
1658 }
1659
1660 j.implementationAndResourcesJar = implementationAndResourcesJar
1661
1662 // Enable dex compilation for the APEX variants, unless it is disabled explicitly
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001663 compileDex := j.dexProperties.Compile_dex
Colin Crossff694a82023-12-13 15:54:49 -08001664 apexInfo, _ := android.ModuleProvider(ctx, android.ApexInfoProvider)
Jaewoong Jung26342642021-03-17 15:56:23 -07001665 if j.DirectlyInAnyApex() && !apexInfo.IsForPlatform() {
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001666 if compileDex == nil {
1667 compileDex = proptools.BoolPtr(true)
Jaewoong Jung26342642021-03-17 15:56:23 -07001668 }
1669 if j.deviceProperties.Hostdex == nil {
1670 j.deviceProperties.Hostdex = proptools.BoolPtr(true)
1671 }
1672 }
1673
Paul Duffine7b1f5b2022-06-29 10:15:52 +00001674 if ctx.Device() && (Bool(j.properties.Installable) || Bool(compileDex)) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001675 if j.hasCode(ctx) {
1676 if j.shouldInstrumentStatic(ctx) {
Colin Cross312634e2023-11-21 15:13:56 -08001677 j.dexer.extraProguardFlagsFiles = append(j.dexer.extraProguardFlagsFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001678 android.PathForSource(ctx, "build/make/core/proguard.jacoco.flags"))
1679 }
1680 // Dex compilation
Colin Cross7707b242024-07-26 12:02:36 -07001681 var dexOutputFile android.Path
Spandan Dasc404cc72023-02-23 18:05:05 +00001682 params := &compileDexParams{
1683 flags: flags,
1684 sdkVersion: j.SdkVersion(ctx),
1685 minSdkVersion: j.MinSdkVersion(ctx),
1686 classesJar: implementationAndResourcesJar,
1687 jarName: jarName,
1688 }
Spandan Das15a67112024-05-30 00:07:40 +00001689 if j.GetProfileGuided() && j.optimizeOrObfuscateEnabled() && !j.EnableProfileRewriting() {
1690 ctx.PropertyErrorf("enable_profile_rewriting",
1691 "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.",
1692 )
1693 }
Spandan Das3dbda182024-05-20 22:23:10 +00001694 if j.EnableProfileRewriting() {
1695 profile := j.GetProfile()
1696 if profile == "" || !j.GetProfileGuided() {
1697 ctx.PropertyErrorf("enable_profile_rewriting", "Profile and Profile_guided must be set when enable_profile_rewriting is true")
1698 }
1699 params.artProfileInput = &profile
1700 }
1701 dexOutputFile, dexArtProfileOutput := j.dexer.compileDex(ctx, params)
Jaewoong Jung26342642021-03-17 15:56:23 -07001702 if ctx.Failed() {
1703 return
1704 }
1705
Spandan Das3dbda182024-05-20 22:23:10 +00001706 // If r8/d8 provides a profile that matches the optimized dex, use that for dexpreopt.
1707 if dexArtProfileOutput != nil {
Colin Cross7707b242024-07-26 12:02:36 -07001708 j.dexpreopter.SetRewrittenProfile(dexArtProfileOutput)
Spandan Das3dbda182024-05-20 22:23:10 +00001709 }
1710
Jaewoong Jung26342642021-03-17 15:56:23 -07001711 // merge dex jar with resources if necessary
1712 if j.resourceJar != nil {
1713 jars := android.Paths{dexOutputFile, j.resourceJar}
Colin Cross7707b242024-07-26 12:02:36 -07001714 combinedJar := android.PathForModuleOut(ctx, "dex-withres", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001715 TransformJarsToJar(ctx, combinedJar, "for dex resources", jars, android.OptionalPath{},
1716 false, nil, nil)
1717 if *j.dexProperties.Uncompress_dex {
Colin Cross7707b242024-07-26 12:02:36 -07001718 combinedAlignedJar := android.PathForModuleOut(ctx, "dex-withres-aligned", jarName)
Cole Faust51d7bfd2023-09-07 05:31:32 +00001719 TransformZipAlign(ctx, combinedAlignedJar, combinedJar, nil)
Jaewoong Jung26342642021-03-17 15:56:23 -07001720 dexOutputFile = combinedAlignedJar
1721 } else {
1722 dexOutputFile = combinedJar
1723 }
1724 }
1725
Paul Duffin4de94502021-05-16 05:21:16 +01001726 // Initialize the hiddenapi structure.
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001727
1728 j.initHiddenAPI(ctx, makeDexJarPathFromPath(dexOutputFile), j.implementationJarFile, j.dexProperties.Uncompress_dex)
Paul Duffin4de94502021-05-16 05:21:16 +01001729
1730 // Encode hidden API flags in dex file, if needed.
1731 dexOutputFile = j.hiddenAPIEncodeDex(ctx, dexOutputFile)
1732
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001733 j.dexJarFile = makeDexJarPathFromPath(dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001734
1735 // Dexpreopting
Jihoon Kanga3a05462024-04-05 00:36:44 +00001736 libName := android.RemoveOptionalPrebuiltPrefix(ctx.ModuleName())
1737 if j.SdkLibraryName() != nil && strings.HasSuffix(ctx.ModuleName(), ".impl") {
1738 libName = strings.TrimSuffix(libName, ".impl")
1739 }
1740 j.dexpreopt(ctx, libName, dexOutputFile)
Jaewoong Jung26342642021-03-17 15:56:23 -07001741
1742 outputFile = dexOutputFile
1743 } else {
1744 // There is no code to compile into a dex jar, make sure the resources are propagated
1745 // to the APK if this is an app.
1746 outputFile = implementationAndResourcesJar
Martin Stjernholm8be1e6d2021-09-15 03:34:04 +01001747 j.dexJarFile = makeDexJarPathFromPath(j.resourceJar)
Jaewoong Jung26342642021-03-17 15:56:23 -07001748 }
1749
1750 if ctx.Failed() {
1751 return
1752 }
1753 } else {
1754 outputFile = implementationAndResourcesJar
1755 }
1756
1757 if ctx.Device() {
Zi Wange1166f02023-11-06 11:43:17 -08001758 lintSDKVersion := func(apiLevel android.ApiLevel) android.ApiLevel {
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001759 if !apiLevel.IsPreview() {
Zi Wange1166f02023-11-06 11:43:17 -08001760 return apiLevel
Jaewoong Jung26342642021-03-17 15:56:23 -07001761 } else {
Zi Wange1166f02023-11-06 11:43:17 -08001762 return ctx.Config().DefaultAppTargetSdk(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07001763 }
1764 }
1765
1766 j.linter.name = ctx.ModuleName()
Thiébaud Weksteen5c26f812022-05-05 14:49:02 +10001767 j.linter.srcs = append(srcFiles, nonGeneratedSrcJars...)
1768 j.linter.srcJars, _ = android.FilterPathList(srcJars, nonGeneratedSrcJars)
Jaewoong Jung26342642021-03-17 15:56:23 -07001769 j.linter.classpath = append(append(android.Paths(nil), flags.bootClasspath...), flags.classpath...)
1770 j.linter.classes = j.implementationJarFile
Spandan Dasba7e5322022-04-22 17:28:25 +00001771 j.linter.minSdkVersion = lintSDKVersion(j.MinSdkVersion(ctx))
Spandan Dasca70fc42023-03-01 23:38:49 +00001772 j.linter.targetSdkVersion = lintSDKVersion(j.TargetSdkVersion(ctx))
Spandan Das8c9ae7e2023-03-03 21:20:36 +00001773 j.linter.compileSdkVersion = lintSDKVersion(j.SdkVersion(ctx).ApiLevel)
Pedro Loureiro18233a22021-06-08 18:11:21 +00001774 j.linter.compileSdkKind = j.SdkVersion(ctx).Kind
Jaewoong Jung26342642021-03-17 15:56:23 -07001775 j.linter.javaLanguageLevel = flags.javaVersion.String()
1776 j.linter.kotlinLanguageLevel = "1.3"
Cole Faust2b64af82023-12-13 18:22:18 -08001777 j.linter.compile_data = android.PathsForModuleSrc(ctx, j.properties.Compile_data)
Jaewoong Jung26342642021-03-17 15:56:23 -07001778 if !apexInfo.IsForPlatform() && ctx.Config().UnbundledBuildApps() {
1779 j.linter.buildModuleReportZip = true
1780 }
1781 j.linter.lint(ctx)
1782 }
1783
Anton Hansson0e73f9e2023-09-20 13:39:57 +00001784 j.collectTransitiveSrcFiles(ctx, srcFiles)
1785
Jaewoong Jung26342642021-03-17 15:56:23 -07001786 ctx.CheckbuildFile(outputFile)
1787
Colin Cross7727c7f2024-07-18 15:36:32 -07001788 android.SetProvider(ctx, JavaInfoProvider, &JavaInfo{
Jihoon Kang705e63e2024-03-13 01:21:16 +00001789 HeaderJars: android.PathsIfNonNil(j.headerJarFile),
1790 RepackagedHeaderJars: android.PathsIfNonNil(j.repackagedHeaderJarFile),
1791 TransitiveLibsHeaderJars: j.transitiveLibsHeaderJars,
1792 TransitiveStaticLibsHeaderJars: j.transitiveStaticLibsHeaderJars,
1793 ImplementationAndResourcesJars: android.PathsIfNonNil(j.implementationAndResourcesJar),
1794 ImplementationJars: android.PathsIfNonNil(j.implementationJarFile),
1795 ResourceJars: android.PathsIfNonNil(j.resourceJar),
1796 AidlIncludeDirs: j.exportAidlIncludeDirs,
1797 SrcJarArgs: j.srcJarArgs,
1798 SrcJarDeps: j.srcJarDeps,
1799 TransitiveSrcFiles: j.transitiveSrcFiles,
1800 ExportedPlugins: j.exportedPluginJars,
1801 ExportedPluginClasses: j.exportedPluginClasses,
1802 ExportedPluginDisableTurbine: j.exportedDisableTurbine,
1803 JacocoReportClassesFile: j.jacocoReportClassesFile,
1804 StubsLinkType: j.stubsLinkType,
Jihoon Kang3921f0b2024-03-12 23:51:37 +00001805 AconfigIntermediateCacheOutputPaths: j.aconfigCacheFiles,
Jaewoong Jung26342642021-03-17 15:56:23 -07001806 })
1807
1808 // Save the output file with no relative path so that it doesn't end up in a subdirectory when used as a resource
1809 j.outputFile = outputFile.WithoutRel()
1810}
1811
Colin Crossa1ff7c62021-09-17 14:11:52 -07001812func (j *Module) useCompose() bool {
1813 return android.InList("androidx.compose.runtime_runtime", j.properties.Static_libs)
1814}
1815
Colin Crosscde55342024-03-27 14:11:51 -07001816func collectDepProguardSpecInfo(ctx android.ModuleContext) (transitiveProguardFlags, transitiveUnconditionalExportedFlags []*android.DepSet[android.Path]) {
Sam Delmerico95d70942023-08-02 18:00:35 -04001817 ctx.VisitDirectDeps(func(m android.Module) {
Colin Cross313aa542023-12-13 13:47:44 -08001818 depProguardInfo, _ := android.OtherModuleProvider(ctx, m, ProguardSpecInfoProvider)
Sam Delmerico95d70942023-08-02 18:00:35 -04001819 depTag := ctx.OtherModuleDependencyTag(m)
1820
1821 if depProguardInfo.UnconditionallyExportedProguardFlags != nil {
1822 transitiveUnconditionalExportedFlags = append(transitiveUnconditionalExportedFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1823 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.UnconditionallyExportedProguardFlags)
1824 }
1825
1826 if depTag == staticLibTag && depProguardInfo.ProguardFlagsFiles != nil {
1827 transitiveProguardFlags = append(transitiveProguardFlags, depProguardInfo.ProguardFlagsFiles)
1828 }
1829 })
1830
Colin Crosscde55342024-03-27 14:11:51 -07001831 return transitiveProguardFlags, transitiveUnconditionalExportedFlags
1832}
1833
1834func (j *Module) collectProguardSpecInfo(ctx android.ModuleContext) ProguardSpecInfo {
1835 transitiveProguardFlags, transitiveUnconditionalExportedFlags := collectDepProguardSpecInfo(ctx)
1836
Sam Delmerico95d70942023-08-02 18:00:35 -04001837 directUnconditionalExportedFlags := android.Paths{}
1838 proguardFlagsForThisModule := android.PathsForModuleSrc(ctx, j.dexProperties.Optimize.Proguard_flags_files)
1839 exportUnconditionally := proptools.Bool(j.dexProperties.Optimize.Export_proguard_flags_files)
1840 if exportUnconditionally {
1841 // if we explicitly export, then our unconditional exports are the same as our transitive flags
1842 transitiveUnconditionalExportedFlags = transitiveProguardFlags
1843 directUnconditionalExportedFlags = proguardFlagsForThisModule
1844 }
1845
1846 return ProguardSpecInfo{
1847 Export_proguard_flags_files: exportUnconditionally,
1848 ProguardFlagsFiles: android.NewDepSet[android.Path](
1849 android.POSTORDER,
1850 proguardFlagsForThisModule,
1851 transitiveProguardFlags,
1852 ),
1853 UnconditionallyExportedProguardFlags: android.NewDepSet[android.Path](
1854 android.POSTORDER,
1855 directUnconditionalExportedFlags,
1856 transitiveUnconditionalExportedFlags,
1857 ),
1858 }
1859
1860}
1861
Cole Faust75fffb12021-06-13 15:23:16 -07001862// Returns a copy of the supplied flags, but with all the errorprone-related
1863// fields copied to the regular build's fields.
1864func enableErrorproneFlags(flags javaBuilderFlags) javaBuilderFlags {
1865 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
1866
1867 if len(flags.errorProneExtraJavacFlags) > 0 {
1868 if len(flags.javacFlags) > 0 {
1869 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
1870 } else {
1871 flags.javacFlags = flags.errorProneExtraJavacFlags
1872 }
1873 }
1874 return flags
1875}
1876
Jaewoong Jung26342642021-03-17 15:56:23 -07001877func (j *Module) compileJavaClasses(ctx android.ModuleContext, jarName string, idx int,
Colin Cross7707b242024-07-26 12:02:36 -07001878 srcFiles, srcJars android.Paths, flags javaBuilderFlags, extraJarDeps android.Paths) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07001879
1880 kzipName := pathtools.ReplaceExtension(jarName, "kzip")
Vadim Spivak3c496f02023-06-08 06:14:59 +00001881 annoSrcJar := android.PathForModuleOut(ctx, "javac", "anno.srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001882 if idx >= 0 {
1883 kzipName = strings.TrimSuffix(jarName, filepath.Ext(jarName)) + strconv.Itoa(idx) + ".kzip"
Vadim Spivak3c496f02023-06-08 06:14:59 +00001884 annoSrcJar = android.PathForModuleOut(ctx, "javac", "anno-"+strconv.Itoa(idx)+".srcjar")
Jaewoong Jung26342642021-03-17 15:56:23 -07001885 jarName += strconv.Itoa(idx)
1886 }
1887
Colin Cross7707b242024-07-26 12:02:36 -07001888 classes := android.PathForModuleOut(ctx, "javac", jarName)
Vadim Spivak3c496f02023-06-08 06:14:59 +00001889 TransformJavaToClasses(ctx, classes, idx, srcFiles, srcJars, annoSrcJar, flags, extraJarDeps)
Jaewoong Jung26342642021-03-17 15:56:23 -07001890
Cole Faust9decf832024-06-11 11:45:53 -07001891 if ctx.Config().EmitXrefRules() && ctx.Module() == ctx.PrimaryModule() {
Jaewoong Jung26342642021-03-17 15:56:23 -07001892 extractionFile := android.PathForModuleOut(ctx, kzipName)
1893 emitXrefRule(ctx, extractionFile, idx, srcFiles, srcJars, flags, extraJarDeps)
1894 j.kytheFiles = append(j.kytheFiles, extractionFile)
1895 }
1896
Vadim Spivak3c496f02023-06-08 06:14:59 +00001897 if len(flags.processorPath) > 0 {
1898 j.annoSrcJars = append(j.annoSrcJars, annoSrcJar)
1899 }
1900
Jaewoong Jung26342642021-03-17 15:56:23 -07001901 return classes
1902}
1903
1904// Check for invalid kotlinc flags. Only use this for flags explicitly passed by the user,
1905// since some of these flags may be used internally.
1906func CheckKotlincFlags(ctx android.ModuleContext, flags []string) {
1907 for _, flag := range flags {
1908 flag = strings.TrimSpace(flag)
1909
1910 if !strings.HasPrefix(flag, "-") {
1911 ctx.PropertyErrorf("kotlincflags", "Flag `%s` must start with `-`", flag)
1912 } else if strings.HasPrefix(flag, "-Xintellij-plugin-root") {
1913 ctx.PropertyErrorf("kotlincflags",
1914 "Bad flag: `%s`, only use internal compiler for consistency.", flag)
1915 } else if inList(flag, config.KotlincIllegalFlags) {
1916 ctx.PropertyErrorf("kotlincflags", "Flag `%s` already used by build system", flag)
1917 } else if flag == "-include-runtime" {
1918 ctx.PropertyErrorf("kotlincflags", "Bad flag: `%s`, do not include runtime.", flag)
1919 } else {
1920 args := strings.Split(flag, " ")
1921 if args[0] == "-kotlin-home" {
1922 ctx.PropertyErrorf("kotlincflags",
1923 "Bad flag: `%s`, kotlin home already set to default (path to kotlinc in the repo).", flag)
1924 }
1925 }
1926 }
1927}
1928
1929func (j *Module) compileJavaHeader(ctx android.ModuleContext, srcFiles, srcJars android.Paths,
1930 deps deps, flags javaBuilderFlags, jarName string,
Colin Crossedec77c2024-07-26 15:25:40 -07001931 extraJars android.Paths) (headerJar android.Path, combinedHeaderJar android.Path) {
Jaewoong Jung26342642021-03-17 15:56:23 -07001932
1933 var jars android.Paths
1934 if len(srcFiles) > 0 || len(srcJars) > 0 {
1935 // Compile java sources into turbine.jar.
1936 turbineJar := android.PathForModuleOut(ctx, "turbine", jarName)
1937 TransformJavaToHeaderClasses(ctx, turbineJar, srcFiles, srcJars, flags)
Jaewoong Jung26342642021-03-17 15:56:23 -07001938 jars = append(jars, turbineJar)
Colin Cross3d56ed52021-11-18 22:23:12 -08001939 headerJar = turbineJar
Jaewoong Jung26342642021-03-17 15:56:23 -07001940 }
1941
1942 jars = append(jars, extraJars...)
1943
1944 // Combine any static header libraries into classes-header.jar. If there is only
1945 // one input jar this step will be skipped.
1946 jars = append(jars, deps.staticHeaderJars...)
1947
1948 // we cannot skip the combine step for now if there is only one jar
1949 // since we have to strip META-INF/TRANSITIVE dir from turbine.jar
Colin Crossedec77c2024-07-26 15:25:40 -07001950 combinedHeaderJarOutputPath := android.PathForModuleOut(ctx, "turbine-combined", jarName)
1951 TransformJarsToJar(ctx, combinedHeaderJarOutputPath, "for turbine", jars, android.OptionalPath{},
Jaewoong Jung26342642021-03-17 15:56:23 -07001952 false, nil, []string{"META-INF/TRANSITIVE"})
Jaewoong Jung26342642021-03-17 15:56:23 -07001953
Colin Crossedec77c2024-07-26 15:25:40 -07001954 return headerJar, combinedHeaderJarOutputPath
Jaewoong Jung26342642021-03-17 15:56:23 -07001955}
1956
1957func (j *Module) instrument(ctx android.ModuleContext, flags javaBuilderFlags,
Colin Cross7707b242024-07-26 12:02:36 -07001958 classesJar android.Path, jarName string, specs string) android.Path {
Jaewoong Jung26342642021-03-17 15:56:23 -07001959
1960 jacocoReportClassesFile := android.PathForModuleOut(ctx, "jacoco-report-classes", jarName)
Colin Cross7707b242024-07-26 12:02:36 -07001961 instrumentedJar := android.PathForModuleOut(ctx, "jacoco", jarName)
Jaewoong Jung26342642021-03-17 15:56:23 -07001962
1963 jacocoInstrumentJar(ctx, instrumentedJar, jacocoReportClassesFile, classesJar, specs)
1964
1965 j.jacocoReportClassesFile = jacocoReportClassesFile
1966
1967 return instrumentedJar
1968}
1969
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001970type providesTransitiveHeaderJars struct {
1971 // set of header jars for all transitive libs deps
Colin Crossc85750b2022-04-21 12:50:51 -07001972 transitiveLibsHeaderJars *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001973 // set of header jars for all transitive static libs deps
Colin Crossc85750b2022-04-21 12:50:51 -07001974 transitiveStaticLibsHeaderJars *android.DepSet[android.Path]
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001975}
1976
Colin Crossc85750b2022-04-21 12:50:51 -07001977func (j *providesTransitiveHeaderJars) TransitiveLibsHeaderJars() *android.DepSet[android.Path] {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001978 return j.transitiveLibsHeaderJars
1979}
1980
Colin Crossc85750b2022-04-21 12:50:51 -07001981func (j *providesTransitiveHeaderJars) TransitiveStaticLibsHeaderJars() *android.DepSet[android.Path] {
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001982 return j.transitiveStaticLibsHeaderJars
1983}
1984
1985func (j *providesTransitiveHeaderJars) collectTransitiveHeaderJars(ctx android.ModuleContext) {
1986 directLibs := android.Paths{}
1987 directStaticLibs := android.Paths{}
Colin Crossc85750b2022-04-21 12:50:51 -07001988 transitiveLibs := []*android.DepSet[android.Path]{}
1989 transitiveStaticLibs := []*android.DepSet[android.Path]{}
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05001990 ctx.VisitDirectDeps(func(module android.Module) {
1991 // don't add deps of the prebuilt version of the same library
1992 if ctx.ModuleName() == android.RemoveOptionalPrebuiltPrefix(module.Name()) {
1993 return
1994 }
1995
Colin Cross7727c7f2024-07-18 15:36:32 -07001996 if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
1997 tag := ctx.OtherModuleDependencyTag(module)
1998 _, isUsesLibDep := tag.(usesLibraryDependencyTag)
1999 if tag == libTag || tag == r8LibraryJarTag || isUsesLibDep {
2000 directLibs = append(directLibs, dep.HeaderJars...)
2001 } else if tag == staticLibTag {
2002 directStaticLibs = append(directStaticLibs, dep.HeaderJars...)
2003 } else {
2004 // Don't propagate transitive libs for other kinds of dependencies.
2005 return
2006 }
Jared Dukeefb6d602023-10-27 18:47:10 +00002007
Colin Cross7727c7f2024-07-18 15:36:32 -07002008 if dep.TransitiveLibsHeaderJars != nil {
2009 transitiveLibs = append(transitiveLibs, dep.TransitiveLibsHeaderJars)
2010 }
2011 if dep.TransitiveStaticLibsHeaderJars != nil {
2012 transitiveStaticLibs = append(transitiveStaticLibs, dep.TransitiveStaticLibsHeaderJars)
2013 }
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002014 }
2015 })
2016 j.transitiveLibsHeaderJars = android.NewDepSet(android.POSTORDER, directLibs, transitiveLibs)
2017 j.transitiveStaticLibsHeaderJars = android.NewDepSet(android.POSTORDER, directStaticLibs, transitiveStaticLibs)
2018}
2019
Jaewoong Jung26342642021-03-17 15:56:23 -07002020func (j *Module) HeaderJars() android.Paths {
2021 if j.headerJarFile == nil {
2022 return nil
2023 }
2024 return android.Paths{j.headerJarFile}
2025}
2026
2027func (j *Module) ImplementationJars() android.Paths {
2028 if j.implementationJarFile == nil {
2029 return nil
2030 }
2031 return android.Paths{j.implementationJarFile}
2032}
2033
Spandan Das59a4a2b2024-01-09 21:35:56 +00002034func (j *Module) DexJarBuildPath(ctx android.ModuleErrorfContext) OptionalDexJarPath {
Jaewoong Jung26342642021-03-17 15:56:23 -07002035 return j.dexJarFile
2036}
2037
2038func (j *Module) DexJarInstallPath() android.Path {
2039 return j.installFile
2040}
2041
2042func (j *Module) ImplementationAndResourcesJars() android.Paths {
2043 if j.implementationAndResourcesJar == nil {
2044 return nil
2045 }
2046 return android.Paths{j.implementationAndResourcesJar}
2047}
2048
2049func (j *Module) AidlIncludeDirs() android.Paths {
2050 // exportAidlIncludeDirs is type android.Paths already
2051 return j.exportAidlIncludeDirs
2052}
2053
2054func (j *Module) ClassLoaderContexts() dexpreopt.ClassLoaderContextMap {
2055 return j.classLoaderContexts
2056}
2057
2058// Collect information for opening IDE project files in java/jdeps.go.
Cole Faustb36d31d2024-08-27 16:04:28 -07002059func (j *Module) IDEInfo(ctx android.BaseModuleContext, dpInfo *android.IdeInfo) {
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002060 // jarjar rules will repackage the sources. To prevent misleading results, IdeInfo should contain the
2061 // repackaged jar instead of the input sources.
Jaewoong Jung26342642021-03-17 15:56:23 -07002062 if j.expandJarjarRules != nil {
2063 dpInfo.Jarjar_rules = append(dpInfo.Jarjar_rules, j.expandJarjarRules.String())
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002064 dpInfo.Jars = append(dpInfo.Jars, j.headerJarFile.String())
2065 } else {
2066 dpInfo.Srcs = append(dpInfo.Srcs, j.expandIDEInfoCompiledSrcs...)
2067 dpInfo.SrcJars = append(dpInfo.SrcJars, j.compiledSrcJars.Strings()...)
2068 dpInfo.SrcJars = append(dpInfo.SrcJars, j.annoSrcJars.Strings()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002069 }
Spandan Dasb4cd5df2024-08-08 21:57:22 +00002070 dpInfo.Deps = append(dpInfo.Deps, j.CompilerDeps()...)
2071 dpInfo.Aidl_include_dirs = append(dpInfo.Aidl_include_dirs, j.deviceProperties.Aidl.Include_dirs...)
Yikef6282022022-04-13 20:41:01 +08002072 dpInfo.Static_libs = append(dpInfo.Static_libs, j.properties.Static_libs...)
2073 dpInfo.Libs = append(dpInfo.Libs, j.properties.Libs...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002074}
2075
2076func (j *Module) CompilerDeps() []string {
Spandan Das8aac9932024-07-18 23:14:13 +00002077 return j.compileDepNames
Jaewoong Jung26342642021-03-17 15:56:23 -07002078}
2079
2080func (j *Module) hasCode(ctx android.ModuleContext) bool {
2081 srcFiles := android.PathsForModuleSrcExcludes(ctx, j.properties.Srcs, j.properties.Exclude_srcs)
2082 return len(srcFiles) > 0 || len(ctx.GetDirectDepsWithTag(staticLibTag)) > 0
2083}
2084
2085// Implements android.ApexModule
2086func (j *Module) DepIsInSameApex(ctx android.BaseModuleContext, dep android.Module) bool {
2087 return j.depIsInSameApex(ctx, dep)
2088}
2089
2090// Implements android.ApexModule
satayev758968a2021-12-06 11:42:40 +00002091func (j *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, sdkVersion android.ApiLevel) error {
Spandan Das7fa982c2023-02-24 18:38:56 +00002092 sdkVersionSpec := j.SdkVersion(ctx)
Spandan Das8c9ae7e2023-03-03 21:20:36 +00002093 minSdkVersion := j.MinSdkVersion(ctx)
2094 if !minSdkVersion.Specified() {
Jaewoong Jung26342642021-03-17 15:56:23 -07002095 return fmt.Errorf("min_sdk_version is not specified")
2096 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002097 // If the module is compiling against core (via sdk_version), skip comparison check.
2098 if sdkVersionSpec.Kind == android.SdkCore {
Jaewoong Jung26342642021-03-17 15:56:23 -07002099 return nil
2100 }
Spandan Das7fa982c2023-02-24 18:38:56 +00002101 if minSdkVersion.GreaterThan(sdkVersion) {
2102 return fmt.Errorf("newer SDK(%v)", minSdkVersion)
Jaewoong Jung26342642021-03-17 15:56:23 -07002103 }
2104 return nil
2105}
2106
2107func (j *Module) Stem() string {
Jihoon Kang1bfb6f22023-07-01 00:13:47 +00002108 if j.stem == "" {
2109 panic("Stem() called before stem property was set")
2110 }
2111 return j.stem
Jaewoong Jung26342642021-03-17 15:56:23 -07002112}
2113
Jaewoong Jung26342642021-03-17 15:56:23 -07002114func (j *Module) JacocoReportClassesFile() android.Path {
2115 return j.jacocoReportClassesFile
2116}
2117
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002118func (j *Module) collectTransitiveSrcFiles(ctx android.ModuleContext, mine android.Paths) {
2119 var fromDeps []*android.DepSet[android.Path]
2120 ctx.VisitDirectDeps(func(module android.Module) {
2121 tag := ctx.OtherModuleDependencyTag(module)
2122 if tag == staticLibTag {
Colin Cross7727c7f2024-07-18 15:36:32 -07002123 if depInfo, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2124 if depInfo.TransitiveSrcFiles != nil {
2125 fromDeps = append(fromDeps, depInfo.TransitiveSrcFiles)
2126 }
Anton Hansson0e73f9e2023-09-20 13:39:57 +00002127 }
2128 }
2129 })
2130
2131 j.transitiveSrcFiles = android.NewDepSet(android.POSTORDER, mine, fromDeps)
2132}
2133
Jaewoong Jung26342642021-03-17 15:56:23 -07002134func (j *Module) IsInstallable() bool {
2135 return Bool(j.properties.Installable)
2136}
2137
2138type sdkLinkType int
2139
2140const (
2141 // TODO(jiyong) rename these for better readability. Make the allowed
2142 // and disallowed link types explicit
2143 // order is important here. See rank()
2144 javaCore sdkLinkType = iota
2145 javaSdk
2146 javaSystem
2147 javaModule
2148 javaSystemServer
2149 javaPlatform
2150)
2151
2152func (lt sdkLinkType) String() string {
2153 switch lt {
2154 case javaCore:
2155 return "core Java API"
2156 case javaSdk:
2157 return "Android API"
2158 case javaSystem:
2159 return "system API"
2160 case javaModule:
2161 return "module API"
2162 case javaSystemServer:
2163 return "system server API"
2164 case javaPlatform:
2165 return "private API"
2166 default:
2167 panic(fmt.Errorf("unrecognized linktype: %d", lt))
2168 }
2169}
2170
2171// rank determines the total order among sdkLinkType. An SDK link type of rank A can link to
2172// another SDK link type of rank B only when B <= A. For example, a module linking to Android SDK
2173// can't statically depend on modules that use Platform API.
2174func (lt sdkLinkType) rank() int {
2175 return int(lt)
2176}
2177
2178type moduleWithSdkDep interface {
2179 android.Module
Jiyong Park92315372021-04-02 08:45:46 +09002180 getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool)
Jaewoong Jung26342642021-03-17 15:56:23 -07002181}
2182
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002183func sdkLinkTypeFromSdkKind(k android.SdkKind) sdkLinkType {
2184 switch k {
2185 case android.SdkCore:
2186 return javaCore
2187 case android.SdkSystem:
2188 return javaSystem
2189 case android.SdkPublic:
2190 return javaSdk
2191 case android.SdkModule:
2192 return javaModule
2193 case android.SdkSystemServer:
2194 return javaSystemServer
2195 case android.SdkPrivate, android.SdkNone, android.SdkCorePlatform, android.SdkTest:
2196 return javaPlatform
2197 default:
2198 return javaSdk
2199 }
2200}
2201
Jiyong Park92315372021-04-02 08:45:46 +09002202func (m *Module) getSdkLinkType(ctx android.BaseModuleContext, name string) (ret sdkLinkType, stubs bool) {
Jaewoong Jung26342642021-03-17 15:56:23 -07002203 switch name {
Jihoon Kang91c83952023-05-30 19:12:28 +00002204 case android.SdkCore.DefaultJavaLibraryName(),
2205 "legacy.core.platform.api.stubs",
2206 "stable.core.platform.api.stubs",
Jaewoong Jung26342642021-03-17 15:56:23 -07002207 "stub-annotations", "private-stub-annotations-jar",
Jihoon Kang91c83952023-05-30 19:12:28 +00002208 "core-lambda-stubs",
Jihoon Kangb5078312023-03-29 23:25:49 +00002209 "core-generated-annotation-stubs":
Jaewoong Jung26342642021-03-17 15:56:23 -07002210 return javaCore, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002211 case android.SdkPublic.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002212 return javaSdk, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002213 case android.SdkSystem.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002214 return javaSystem, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002215 case android.SdkModule.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002216 return javaModule, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002217 case android.SdkSystemServer.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002218 return javaSystemServer, true
Jihoon Kang91c83952023-05-30 19:12:28 +00002219 case android.SdkTest.DefaultJavaLibraryName():
Jaewoong Jung26342642021-03-17 15:56:23 -07002220 return javaSystem, true
2221 }
2222
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002223 if stub, linkType := moduleStubLinkType(m); stub {
Jaewoong Jung26342642021-03-17 15:56:23 -07002224 return linkType, true
2225 }
2226
Jiyong Park92315372021-04-02 08:45:46 +09002227 ver := m.SdkVersion(ctx)
Jiyong Parkf1691d22021-03-29 20:11:58 +09002228 if !ver.Valid() {
2229 panic(fmt.Errorf("sdk_version is invalid. got %q", ver.Raw))
Jaewoong Jung26342642021-03-17 15:56:23 -07002230 }
Jihoon Kangfa3f0782024-08-21 20:42:18 +00002231
2232 return sdkLinkTypeFromSdkKind(ver.Kind), false
Jaewoong Jung26342642021-03-17 15:56:23 -07002233}
2234
2235// checkSdkLinkType make sures the given dependency doesn't have a lower SDK link type rank than
2236// this module's. See the comment on rank() for details and an example.
2237func (j *Module) checkSdkLinkType(
2238 ctx android.ModuleContext, dep moduleWithSdkDep, tag dependencyTag) {
2239 if ctx.Host() {
2240 return
2241 }
2242
Jiyong Park92315372021-04-02 08:45:46 +09002243 myLinkType, stubs := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002244 if stubs {
2245 return
2246 }
Jiyong Park92315372021-04-02 08:45:46 +09002247 depLinkType, _ := dep.getSdkLinkType(ctx, ctx.OtherModuleName(dep))
Jaewoong Jung26342642021-03-17 15:56:23 -07002248
2249 if myLinkType.rank() < depLinkType.rank() {
2250 ctx.ModuleErrorf("compiles against %v, but dependency %q is compiling against %v. "+
2251 "In order to fix this, consider adjusting sdk_version: OR platform_apis: "+
2252 "property of the source or target module so that target module is built "+
2253 "with the same or smaller API set when compared to the source.",
2254 myLinkType, ctx.OtherModuleName(dep), depLinkType)
2255 }
2256}
2257
2258func (j *Module) collectDeps(ctx android.ModuleContext) deps {
2259 var deps deps
2260
2261 if ctx.Device() {
Jiyong Parkf1691d22021-03-29 20:11:58 +09002262 sdkDep := decodeSdkDep(ctx, android.SdkContext(j))
Jaewoong Jung26342642021-03-17 15:56:23 -07002263 if sdkDep.invalidVersion {
2264 ctx.AddMissingDependencies(sdkDep.bootclasspath)
2265 ctx.AddMissingDependencies(sdkDep.java9Classpath)
2266 } else if sdkDep.useFiles {
2267 // sdkDep.jar is actually equivalent to turbine header.jar.
2268 deps.classpath = append(deps.classpath, sdkDep.jars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002269 deps.dexClasspath = append(deps.dexClasspath, sdkDep.jars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002270 deps.aidlPreprocess = sdkDep.aidl
Spandan Das6e8bd1c2024-08-09 00:07:03 +00002271 // Add the sdk module dependency to `compileDepNames`.
2272 // This ensures that the dependency is reported in `module_bp_java_deps.json`
2273 // TODO (b/358608607): Move this to decodeSdkDep
2274 sdkSpec := android.SdkContext(j).SdkVersion(ctx)
2275 j.compileDepNames = append(j.compileDepNames, fmt.Sprintf("sdk_%s_%s_android", sdkSpec.Kind.String(), sdkSpec.ApiLevel.String()))
Jaewoong Jung26342642021-03-17 15:56:23 -07002276 } else {
2277 deps.aidlPreprocess = sdkDep.aidl
2278 }
2279 }
2280
Jiyong Park92315372021-04-02 08:45:46 +09002281 sdkLinkType, _ := j.getSdkLinkType(ctx, ctx.ModuleName())
Jaewoong Jung26342642021-03-17 15:56:23 -07002282
Sam Delmerico9f9c0a22022-11-29 11:19:37 -05002283 j.collectTransitiveHeaderJars(ctx)
Jaewoong Jung26342642021-03-17 15:56:23 -07002284 ctx.VisitDirectDeps(func(module android.Module) {
2285 otherName := ctx.OtherModuleName(module)
2286 tag := ctx.OtherModuleDependencyTag(module)
2287
2288 if IsJniDepTag(tag) {
2289 // Handled by AndroidApp.collectAppDeps
2290 return
2291 }
2292 if tag == certificateTag {
2293 // Handled by AndroidApp.collectAppDeps
2294 return
2295 }
2296
2297 if dep, ok := module.(SdkLibraryDependency); ok {
2298 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002299 case sdkLibTag, libTag:
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002300 depHeaderJars := dep.SdkHeaderJars(ctx, j.SdkVersion(ctx))
2301 deps.classpath = append(deps.classpath, depHeaderJars...)
2302 deps.dexClasspath = append(deps.dexClasspath, depHeaderJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002303 case staticLibTag:
2304 ctx.ModuleErrorf("dependency on java_sdk_library %q can only be in libs", otherName)
2305 }
Colin Cross313aa542023-12-13 13:47:44 -08002306 } else if dep, ok := android.OtherModuleProvider(ctx, module, JavaInfoProvider); ok {
2307 if sdkLinkType != javaPlatform {
2308 if syspropDep, ok := android.OtherModuleProvider(ctx, module, SyspropPublicStubInfoProvider); ok {
2309 // dep is a sysprop implementation library, but this module is not linking against
2310 // the platform, so it gets the sysprop public stubs library instead. Replace
2311 // dep with the JavaInfo from the SyspropPublicStubInfoProvider.
2312 dep = syspropDep.JavaInfo
2313 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002314 }
2315 switch tag {
2316 case bootClasspathTag:
2317 deps.bootClasspath = append(deps.bootClasspath, dep.HeaderJars...)
Liz Kammeref28a4c2022-09-23 16:50:56 -04002318 case sdkLibTag, libTag, instrumentationForTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002319 if _, ok := module.(*Plugin); ok {
2320 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a libs dependency", otherName)
2321 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002322 deps.classpath = append(deps.classpath, dep.HeaderJars...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002323 deps.dexClasspath = append(deps.dexClasspath, dep.HeaderJars...)
Joe Onorato349ae8d2024-02-05 22:46:00 +00002324 if len(dep.RepackagedHeaderJars) == 1 && !slices.Contains(dep.HeaderJars, dep.RepackagedHeaderJars[0]) {
2325 deps.classpath = append(deps.classpath, dep.RepackagedHeaderJars...)
2326 deps.dexClasspath = append(deps.dexClasspath, dep.RepackagedHeaderJars...)
2327 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002328 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2329 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2330 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
2331 case java9LibTag:
2332 deps.java9Classpath = append(deps.java9Classpath, dep.HeaderJars...)
2333 case staticLibTag:
Sam Delmerico0d1c4a02022-04-26 18:34:55 +00002334 if _, ok := module.(*Plugin); ok {
2335 ctx.ModuleErrorf("a java_plugin (%s) cannot be used as a static_libs dependency", otherName)
2336 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002337 deps.classpath = append(deps.classpath, dep.HeaderJars...)
2338 deps.staticJars = append(deps.staticJars, dep.ImplementationJars...)
2339 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.HeaderJars...)
2340 deps.staticResourceJars = append(deps.staticResourceJars, dep.ResourceJars...)
2341 deps.aidlIncludeDirs = append(deps.aidlIncludeDirs, dep.AidlIncludeDirs...)
2342 addPlugins(&deps, dep.ExportedPlugins, dep.ExportedPluginClasses...)
2343 // Turbine doesn't run annotation processors, so any module that uses an
2344 // annotation processor that generates API is incompatible with the turbine
2345 // optimization.
2346 deps.disableTurbine = deps.disableTurbine || dep.ExportedPluginDisableTurbine
Jihoon Kang705e63e2024-03-13 01:21:16 +00002347 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.AconfigIntermediateCacheOutputPaths...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002348 case pluginTag:
2349 if plugin, ok := module.(*Plugin); ok {
2350 if plugin.pluginProperties.Processor_class != nil {
2351 addPlugins(&deps, dep.ImplementationAndResourcesJars, *plugin.pluginProperties.Processor_class)
2352 } else {
2353 addPlugins(&deps, dep.ImplementationAndResourcesJars)
2354 }
2355 // Turbine doesn't run annotation processors, so any module that uses an
2356 // annotation processor that generates API is incompatible with the turbine
2357 // optimization.
2358 deps.disableTurbine = deps.disableTurbine || Bool(plugin.pluginProperties.Generates_api)
2359 } else {
2360 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2361 }
2362 case errorpronePluginTag:
2363 if _, ok := module.(*Plugin); ok {
2364 deps.errorProneProcessorPath = append(deps.errorProneProcessorPath, dep.ImplementationAndResourcesJars...)
2365 } else {
2366 ctx.PropertyErrorf("plugins", "%q is not a java_plugin module", otherName)
2367 }
2368 case exportedPluginTag:
2369 if plugin, ok := module.(*Plugin); ok {
2370 j.exportedPluginJars = append(j.exportedPluginJars, dep.ImplementationAndResourcesJars...)
2371 if plugin.pluginProperties.Processor_class != nil {
2372 j.exportedPluginClasses = append(j.exportedPluginClasses, *plugin.pluginProperties.Processor_class)
2373 }
2374 // Turbine doesn't run annotation processors, so any module that uses an
2375 // annotation processor that generates API is incompatible with the turbine
2376 // optimization.
2377 j.exportedDisableTurbine = Bool(plugin.pluginProperties.Generates_api)
2378 } else {
2379 ctx.PropertyErrorf("exported_plugins", "%q is not a java_plugin module", otherName)
2380 }
Colin Crossa1ff7c62021-09-17 14:11:52 -07002381 case kotlinPluginTag:
2382 deps.kotlinPlugins = append(deps.kotlinPlugins, dep.ImplementationAndResourcesJars...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002383 case syspropPublicStubDepTag:
2384 // This is a sysprop implementation library, forward the JavaInfoProvider from
2385 // the corresponding sysprop public stub library as SyspropPublicStubInfoProvider.
Colin Cross40213022023-12-13 15:19:49 -08002386 android.SetProvider(ctx, SyspropPublicStubInfoProvider, SyspropPublicStubInfo{
Jaewoong Jung26342642021-03-17 15:56:23 -07002387 JavaInfo: dep,
2388 })
2389 }
2390 } else if dep, ok := module.(android.SourceFileProducer); ok {
2391 switch tag {
Liz Kammeref28a4c2022-09-23 16:50:56 -04002392 case sdkLibTag, libTag:
Jaewoong Jung26342642021-03-17 15:56:23 -07002393 checkProducesJars(ctx, dep)
2394 deps.classpath = append(deps.classpath, dep.Srcs()...)
Colin Cross9bb9bfb2022-03-17 11:12:32 -07002395 deps.dexClasspath = append(deps.classpath, dep.Srcs()...)
Jaewoong Jung26342642021-03-17 15:56:23 -07002396 case staticLibTag:
2397 checkProducesJars(ctx, dep)
2398 deps.classpath = append(deps.classpath, dep.Srcs()...)
2399 deps.staticJars = append(deps.staticJars, dep.Srcs()...)
2400 deps.staticHeaderJars = append(deps.staticHeaderJars, dep.Srcs()...)
2401 }
Jihoon Kang705e63e2024-03-13 01:21:16 +00002402 } else if dep, ok := android.OtherModuleProvider(ctx, module, android.CodegenInfoProvider); ok {
Jihoon Kang3921f0b2024-03-12 23:51:37 +00002403 switch tag {
2404 case staticLibTag:
2405 deps.aconfigProtoFiles = append(deps.aconfigProtoFiles, dep.IntermediateCacheOutputPaths...)
2406 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002407 } else {
2408 switch tag {
2409 case bootClasspathTag:
2410 // If a system modules dependency has been added to the bootclasspath
2411 // then add its libs to the bootclasspath.
Colin Crossb61c2262024-08-08 14:04:42 -07002412 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2413 depHeaderJars := sm.HeaderJars
2414 deps.bootClasspath = append(deps.bootClasspath, depHeaderJars...)
2415 } else {
2416 ctx.PropertyErrorf("boot classpath dependency %q does not provide SystemModulesProvider",
2417 ctx.OtherModuleName(module))
2418 }
Jaewoong Jung26342642021-03-17 15:56:23 -07002419
2420 case systemModulesTag:
2421 if deps.systemModules != nil {
2422 panic("Found two system module dependencies")
2423 }
Colin Crossb61c2262024-08-08 14:04:42 -07002424 if sm, ok := android.OtherModuleProvider(ctx, module, SystemModulesProvider); ok {
2425 deps.systemModules = &systemModules{sm.OutputDir, sm.OutputDirDeps}
2426 } else {
2427 ctx.PropertyErrorf("system modules dependency %q does not provide SystemModulesProvider",
2428 ctx.OtherModuleName(module))
2429 }
Paul Duffin53a70a42022-01-11 14:35:55 +00002430
2431 case instrumentationForTag:
2432 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 -07002433 }
2434 }
2435
Spandan Das8aac9932024-07-18 23:14:13 +00002436 if android.InList(tag, compileDependencyTags) {
2437 // Add the dependency name to compileDepNames so that it can be recorded in module_bp_java_deps.json
2438 j.compileDepNames = append(j.compileDepNames, otherName)
2439 }
2440
Jaewoong Jung26342642021-03-17 15:56:23 -07002441 addCLCFromDep(ctx, module, j.classLoaderContexts)
Jiakai Zhang36937082024-04-15 11:15:50 +00002442 addMissingOptionalUsesLibsFromDep(ctx, module, &j.usesLibrary)
Jaewoong Jung26342642021-03-17 15:56:23 -07002443 })
2444
2445 return deps
2446}
2447
Joe Onorato349ae8d2024-02-05 22:46:00 +00002448// Provider for jarjar renaming rules.
2449//
2450// Modules can set their jarjar renaming rules with addJarJarRenameRule, and those renamings will be
2451// passed to all rdeps. The typical way that these renamings will NOT be inherited is when a module
2452// links against stubs -- these are not passed through stubs. The classes will remain unrenamed on
2453// classes until a module with jarjar_prefix is reached, and all as yet unrenamed classes will then
2454// be renamed from that module.
2455// TODO: Add another property to suppress the forwarding of
LaMont Jones63683e42024-02-08 14:30:45 -08002456type DependencyUse int
2457
2458const (
2459 RenameUseInvalid DependencyUse = iota
2460 RenameUseInclude
2461 RenameUseExclude
2462)
2463
2464type RenameUseElement struct {
2465 DepName string
2466 RenameUse DependencyUse
2467 Why string // token for determining where in the logic the decision was made.
2468}
2469
Joe Onorato349ae8d2024-02-05 22:46:00 +00002470type JarJarProviderData struct {
2471 // Mapping of class names: original --> renamed. If the value is "", the class will be
2472 // renamed by the next rdep that has the jarjar_prefix attribute (or this module if it has
2473 // attribute). Rdeps of that module will inherit the renaming.
LaMont Jones63683e42024-02-08 14:30:45 -08002474 Rename map[string]string
2475 RenameUse []RenameUseElement
Joe Onorato349ae8d2024-02-05 22:46:00 +00002476}
2477
2478func (this JarJarProviderData) GetDebugString() string {
2479 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002480 for _, k := range android.SortedKeys(this.Rename) {
2481 v := this.Rename[k]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002482 if strings.Contains(k, "android.companion.virtual.flags.FakeFeatureFlagsImpl") {
2483 result += k + "--&gt;" + v + ";"
2484 }
2485 }
2486 return result
2487}
2488
2489var JarJarProvider = blueprint.NewProvider[JarJarProviderData]()
2490
2491var overridableJarJarPrefix = "com.android.internal.hidden_from_bootclasspath"
2492
2493func init() {
2494 android.SetJarJarPrefixHandler(mergeJarJarPrefixes)
2495}
2496
2497// BaseJarJarProviderData contains information that will propagate across dependencies regardless of
2498// whether they are java modules or not.
2499type BaseJarJarProviderData struct {
2500 JarJarProviderData JarJarProviderData
2501}
2502
2503func (this BaseJarJarProviderData) GetDebugString() string {
2504 return this.JarJarProviderData.GetDebugString()
2505}
2506
2507var BaseJarJarProvider = blueprint.NewProvider[BaseJarJarProviderData]()
2508
2509// mergeJarJarPrefixes is called immediately before module.GenerateAndroidBuildActions is called.
2510// Since there won't be a JarJarProvider, we create the BaseJarJarProvider if any of our deps have
2511// either JarJarProvider or BaseJarJarProvider.
2512func mergeJarJarPrefixes(ctx android.ModuleContext) {
2513 mod := ctx.Module()
2514 // Explicitly avoid propagating into some module types.
2515 switch reflect.TypeOf(mod).String() {
2516 case "*java.Droidstubs":
2517 return
2518 }
2519 jarJarData := collectDirectDepsProviders(ctx)
2520 if jarJarData != nil {
2521 providerData := BaseJarJarProviderData{
2522 JarJarProviderData: *jarJarData,
2523 }
2524 android.SetProvider(ctx, BaseJarJarProvider, providerData)
2525 }
2526
2527}
2528
2529// Add a jarjar renaming rule to this module, to be inherited to all dependent modules.
2530func (module *Module) addJarJarRenameRule(original string, renamed string) {
2531 if module.jarjarRenameRules == nil {
2532 module.jarjarRenameRules = make(map[string]string)
2533 }
2534 module.jarjarRenameRules[original] = renamed
2535}
2536
2537func collectDirectDepsProviders(ctx android.ModuleContext) (result *JarJarProviderData) {
2538 // Gather repackage information from deps
2539 // If the dep jas a JarJarProvider, it is used. Otherwise, any BaseJarJarProvider is used.
LaMont Jones63683e42024-02-08 14:30:45 -08002540
2541 module := ctx.Module()
2542 moduleName := module.Name()
2543
Joe Onorato349ae8d2024-02-05 22:46:00 +00002544 ctx.VisitDirectDepsIgnoreBlueprint(func(m android.Module) {
LaMont Jones63683e42024-02-08 14:30:45 -08002545 tag := ctx.OtherModuleDependencyTag(m)
2546 // This logic mirrors that in (*Module).collectDeps above. There are several places
2547 // where we explicitly return RenameUseExclude, even though it is the default, to
2548 // indicate that it has been verified to be the case.
2549 //
2550 // Note well: there are probably cases that are getting to the unconditional return
2551 // and are therefore wrong.
2552 shouldIncludeRenames := func() (DependencyUse, string) {
2553 if moduleName == m.Name() {
2554 return RenameUseInclude, "name" // If we have the same module name, include the renames.
2555 }
2556 if sc, ok := module.(android.SdkContext); ok {
2557 if ctx.Device() {
2558 sdkDep := decodeSdkDep(ctx, sc)
2559 if !sdkDep.invalidVersion && sdkDep.useFiles {
2560 return RenameUseExclude, "useFiles"
Joe Onorato349ae8d2024-02-05 22:46:00 +00002561 }
2562 }
LaMont Jones63683e42024-02-08 14:30:45 -08002563 }
2564 if IsJniDepTag(tag) || tag == certificateTag || tag == proguardRaiseTag {
2565 return RenameUseExclude, "tags"
2566 }
2567 if _, ok := m.(SdkLibraryDependency); ok {
2568 switch tag {
2569 case sdkLibTag, libTag:
2570 return RenameUseExclude, "sdklibdep" // matches collectDeps()
2571 }
2572 return RenameUseInvalid, "sdklibdep" // dep is not used in collectDeps()
2573 } else if ji, ok := android.OtherModuleProvider(ctx, m, JavaInfoProvider); ok {
2574 switch ji.StubsLinkType {
2575 case Stubs:
2576 return RenameUseExclude, "info"
2577 case Implementation:
2578 return RenameUseInclude, "info"
2579 default:
LaMont Jones09721862024-06-11 10:30:50 -07002580 //fmt.Printf("collectDirectDepsProviders: %v -> %v StubsLinkType unknown\n", module, m)
LaMont Jones63683e42024-02-08 14:30:45 -08002581 // Fall through to the heuristic logic.
2582 }
2583 switch reflect.TypeOf(m).String() {
2584 case "*java.GeneratedJavaLibraryModule":
2585 // Probably a java_aconfig_library module.
2586 // TODO: make this check better.
2587 return RenameUseInclude, "reflect"
2588 }
2589 switch tag {
2590 case bootClasspathTag:
2591 return RenameUseExclude, "tagswitch"
2592 case sdkLibTag, libTag, instrumentationForTag:
2593 return RenameUseInclude, "tagswitch"
2594 case java9LibTag:
2595 return RenameUseExclude, "tagswitch"
2596 case staticLibTag:
2597 return RenameUseInclude, "tagswitch"
2598 case pluginTag:
2599 return RenameUseInclude, "tagswitch"
2600 case errorpronePluginTag:
2601 return RenameUseInclude, "tagswitch"
2602 case exportedPluginTag:
2603 return RenameUseInclude, "tagswitch"
LaMont Jones63683e42024-02-08 14:30:45 -08002604 case kotlinPluginTag:
2605 return RenameUseInclude, "tagswitch"
2606 default:
2607 return RenameUseExclude, "tagswitch"
2608 }
2609 } else if _, ok := m.(android.SourceFileProducer); ok {
2610 switch tag {
2611 case sdkLibTag, libTag, staticLibTag:
2612 return RenameUseInclude, "srcfile"
2613 default:
2614 return RenameUseExclude, "srcfile"
2615 }
Yu Liu67a28422024-03-05 00:36:31 +00002616 } else if _, ok := android.OtherModuleProvider(ctx, m, android.CodegenInfoProvider); ok {
Jihoon Kang03d014f2024-02-16 22:22:18 +00002617 return RenameUseInclude, "aconfig_declarations_group"
LaMont Jones63683e42024-02-08 14:30:45 -08002618 } else {
2619 switch tag {
2620 case bootClasspathTag:
2621 return RenameUseExclude, "else"
2622 case systemModulesTag:
2623 return RenameUseInclude, "else"
2624 }
2625 }
2626 // If we got here, choose the safer option, which may lead to a build failure, rather
2627 // than runtime failures on the device.
2628 return RenameUseExclude, "end"
2629 }
2630
2631 if result == nil {
2632 result = &JarJarProviderData{
2633 Rename: make(map[string]string),
2634 RenameUse: make([]RenameUseElement, 0),
2635 }
2636 }
2637 how, why := shouldIncludeRenames()
2638 result.RenameUse = append(result.RenameUse, RenameUseElement{DepName: m.Name(), RenameUse: how, Why: why})
2639 if how != RenameUseInclude {
2640 // Nothing to merge.
2641 return
2642 }
2643
2644 merge := func(theirs *JarJarProviderData) {
2645 for orig, renamed := range theirs.Rename {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002646 if preexisting, exists := (*result).Rename[orig]; !exists || preexisting == "" {
2647 result.Rename[orig] = renamed
2648 } else if preexisting != "" && renamed != "" && preexisting != renamed {
2649 if strings.HasPrefix(preexisting, overridableJarJarPrefix) {
2650 result.Rename[orig] = renamed
2651 } else if !strings.HasPrefix(renamed, overridableJarJarPrefix) {
2652 ctx.ModuleErrorf("1. Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting, ctx.ModuleName(), m.Name())
2653 continue
2654 }
2655 }
2656 }
2657 }
2658 if theirs, ok := android.OtherModuleProvider(ctx, m, JarJarProvider); ok {
2659 merge(&theirs)
2660 } else if theirs, ok := android.OtherModuleProvider(ctx, m, BaseJarJarProvider); ok {
2661 // TODO: if every java.Module should have a JarJarProvider, and we find only the
2662 // BaseJarJarProvider, then there is a bug. Consider seeing if m can be cast
2663 // to java.Module.
2664 merge(&theirs.JarJarProviderData)
2665 }
2666 })
2667 return
2668}
2669
2670func (this Module) GetDebugString() string {
2671 return "sdk_version=" + proptools.String(this.deviceProperties.Sdk_version)
2672}
2673
2674// Merge the jarjar rules we inherit from our dependencies, any that have been added directly to
2675// us, and if it's been set, apply the jarjar_prefix property to rename them.
2676func (module *Module) collectJarJarRules(ctx android.ModuleContext) *JarJarProviderData {
2677 // Gather repackage information from deps
2678 result := collectDirectDepsProviders(ctx)
2679
Joe Onoratoa5d17172024-07-20 17:39:56 -07002680 add := func(orig string, renamed string) {
Joe Onorato349ae8d2024-02-05 22:46:00 +00002681 if result == nil {
2682 result = &JarJarProviderData{
2683 Rename: make(map[string]string),
2684 }
2685 }
2686 if renamed != "" {
2687 if preexisting, exists := (*result).Rename[orig]; exists && preexisting != renamed {
2688 ctx.ModuleErrorf("Conflicting jarjar rules inherited for class: %s (%s and %s)", orig, renamed, preexisting)
Joe Onoratoa5d17172024-07-20 17:39:56 -07002689 return
Joe Onorato349ae8d2024-02-05 22:46:00 +00002690 }
2691 }
2692 (*result).Rename[orig] = renamed
2693 }
2694
Joe Onoratoa5d17172024-07-20 17:39:56 -07002695 // Update that with entries we've stored for ourself
2696 for orig, renamed := range module.jarjarRenameRules {
2697 add(orig, renamed)
2698 }
2699
2700 // Update that with entries given in the jarjar_rename property.
2701 for _, orig := range module.properties.Jarjar_rename {
2702 add(orig, "")
2703 }
2704
Joe Onorato349ae8d2024-02-05 22:46:00 +00002705 // If there are no renamings, then jarjar_prefix does nothing, so skip the extra work.
2706 if result == nil {
2707 return nil
2708 }
2709
2710 // If they've given us a jarjar_prefix property, then we will use that to rename any classes
2711 // that have not yet been renamed.
2712 prefix := proptools.String(module.properties.Jarjar_prefix)
2713 if prefix != "" {
2714 if prefix[0] == '.' {
2715 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not start with '.'")
2716 return nil
2717 }
2718 if prefix[len(prefix)-1] == '.' {
2719 ctx.PropertyErrorf("jarjar_prefix", "jarjar_prefix can not end with '.'")
2720 return nil
2721 }
2722
2723 var updated map[string]string
2724 for orig, renamed := range (*result).Rename {
2725 if renamed == "" {
2726 if updated == nil {
2727 updated = make(map[string]string)
2728 }
2729 updated[orig] = prefix + "." + orig
2730 }
2731 }
2732 for orig, renamed := range updated {
2733 (*result).Rename[orig] = renamed
2734 }
2735 }
2736
2737 return result
2738}
2739
2740// Get the jarjar rule text for a given provider for the fully resolved rules. Classes that map
2741// to "" won't be in this list because they shouldn't be renamed yet.
2742func getJarJarRuleText(provider *JarJarProviderData) string {
2743 result := ""
Inseob Kim3c0c9d72024-02-28 14:28:59 +09002744 for _, orig := range android.SortedKeys(provider.Rename) {
2745 renamed := provider.Rename[orig]
Joe Onorato349ae8d2024-02-05 22:46:00 +00002746 if renamed != "" {
2747 result += "rule " + orig + " " + renamed + "\n"
2748 }
2749 }
2750 return result
2751}
2752
Zi Wangddb2ee52024-04-02 16:44:02 +00002753// Repackage the flags if the jarjar rule txt for the flags is generated
Colin Cross7707b242024-07-26 12:02:36 -07002754func (j *Module) repackageFlagsIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) android.Path {
Zi Wangddb2ee52024-04-02 16:44:02 +00002755 if j.repackageJarjarRules == nil {
2756 return infile
2757 }
Colin Crossedec77c2024-07-26 15:25:40 -07002758 repackagedJarjarFile := android.PathForModuleOut(ctx, "repackaged-jarjar", info, jarName)
Zi Wangddb2ee52024-04-02 16:44:02 +00002759 TransformJarJar(ctx, repackagedJarjarFile, infile, j.repackageJarjarRules)
2760 return repackagedJarjarFile
2761}
2762
Colin Crossedec77c2024-07-26 15:25:40 -07002763func (j *Module) jarjarIfNecessary(ctx android.ModuleContext, infile android.Path, jarName, info string) android.Path {
2764 if j.expandJarjarRules == nil {
2765 return infile
2766 }
2767 jarjarFile := android.PathForModuleOut(ctx, "jarjar", info, jarName)
2768 TransformJarJar(ctx, jarjarFile, infile, j.expandJarjarRules)
2769 return jarjarFile
2770
2771}
2772
Jaewoong Jung26342642021-03-17 15:56:23 -07002773func addPlugins(deps *deps, pluginJars android.Paths, pluginClasses ...string) {
2774 deps.processorPath = append(deps.processorPath, pluginJars...)
2775 deps.processorClasses = append(deps.processorClasses, pluginClasses...)
2776}
2777
2778// TODO(b/132357300) Generalize SdkLibrarComponentDependency to non-SDK libraries and merge with
2779// this interface.
2780type ProvidesUsesLib interface {
2781 ProvidesUsesLib() *string
2782}
2783
2784func (j *Module) ProvidesUsesLib() *string {
2785 return j.usesLibraryProperties.Provides_uses_lib
2786}
satayev1c564cc2021-05-25 19:50:30 +01002787
2788type ModuleWithStem interface {
2789 Stem() string
2790}
2791
2792var _ ModuleWithStem = (*Module)(nil)
Jiakai Zhangf98da192024-04-15 11:15:41 +00002793
2794type ModuleWithUsesLibrary interface {
2795 UsesLibrary() *usesLibrary
2796}
2797
2798func (j *Module) UsesLibrary() *usesLibrary {
2799 return &j.usesLibrary
2800}
2801
2802var _ ModuleWithUsesLibrary = (*Module)(nil)