blob: 22a891ae1ae0e2249cbcbff0428de54b93387cd1 [file] [log] [blame]
Colin Cross2fe66872015-03-30 17:20:39 -07001// Copyright 2015 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
17// This file generates the final rules for compiling all Java. All properties related to
18// compiling should have been translated into javaBuilderFlags or another argument to the Transform*
19// functions.
20
21import (
Nan Zhang61eaedb2017-11-02 13:28:15 -070022 "path/filepath"
23 "strconv"
Colin Cross2fe66872015-03-30 17:20:39 -070024 "strings"
25
Colin Cross2fe66872015-03-30 17:20:39 -070026 "github.com/google/blueprint"
Colin Crossfe4bc362018-09-12 10:02:13 -070027 "github.com/google/blueprint/proptools"
Colin Crossfee57cb2017-09-05 13:16:45 -070028
29 "android/soong/android"
Ramy Medhat1dcc27e2020-04-21 21:36:23 -040030 "android/soong/remoteexec"
Colin Cross2fe66872015-03-30 17:20:39 -070031)
32
33var (
Colin Cross635c3b02016-05-18 15:37:25 -070034 pctx = android.NewPackageContext("android/soong/java")
Colin Cross2fe66872015-03-30 17:20:39 -070035
36 // Compiling java is not conducive to proper dependency tracking. The path-matches-class-name
37 // requirement leads to unpredictable generated source file names, and a single .java file
38 // will get compiled into multiple .class files if it contains inner classes. To work around
Colin Crossf7eac7a2018-02-08 12:48:39 -080039 // this, all java rules write into separate directories and then are combined into a .jar file
40 // (if the rule produces .class files) or a .srcjar file (if the rule produces .java files).
41 // .srcjar files are unzipped into a temporary directory when compiled with javac.
Colin Cross1ec3fce2020-03-05 12:43:14 -080042 // TODO(b/143658984): goma can't handle the --system argument to javac.
Kousik Kumar366afc52020-05-20 11:27:16 -070043 javac, javacRE = remoteexec.MultiCommandStaticRules(pctx, "javac",
Colin Cross2fe66872015-03-30 17:20:39 -070044 blueprint.RuleParams{
Ulf Adams26d19552020-11-25 23:03:28 +010045 Command: `rm -rf "$outDir" "$annoDir" "$srcJarDir" "$out" && mkdir -p "$outDir" "$annoDir" "$srcJarDir" && ` +
Colin Cross436b7652018-03-15 16:24:10 -070046 `${config.ZipSyncCmd} -d $srcJarDir -l $srcJarDir/list -f "*.java" $srcJars && ` +
Sundong Ahn24a099c2018-06-28 14:53:20 +090047 `(if [ -s $srcJarDir/list ] || [ -s $out.rsp ] ; then ` +
Kousik Kumar366afc52020-05-20 11:27:16 -070048 `${config.SoongJavacWrapper} $javaTemplate${config.JavacCmd} ` +
Sasha Smundak26c6d9e2019-06-11 13:30:13 -070049 `${config.JavacHeapFlags} ${config.JavacVmFlags} ${config.CommonJdkFlags} ` +
Colin Crossbe9cdb82019-01-21 21:37:16 -080050 `$processorpath $processor $javacFlags $bootClasspath $classpath ` +
Colin Cross64162712017-08-08 13:17:59 -070051 `-source $javaVersion -target $javaVersion ` +
Sundong Ahn24a099c2018-06-28 14:53:20 +090052 `-d $outDir -s $annoDir @$out.rsp @$srcJarDir/list ; fi ) && ` +
Kousik Kumar366afc52020-05-20 11:27:16 -070053 `$zipTemplate${config.SoongZipCmd} -jar -o $out -C $outDir -D $outDir && ` +
Colin Cross44c29a82019-01-24 16:36:57 -080054 `rm -rf "$srcJarDir"`,
Colin Cross8eadbf02017-10-24 17:46:00 -070055 CommandDeps: []string{
56 "${config.JavacCmd}",
57 "${config.SoongZipCmd}",
Colin Cross436b7652018-03-15 16:24:10 -070058 "${config.ZipSyncCmd}",
Colin Cross8eadbf02017-10-24 17:46:00 -070059 },
Colin Crossa4820652017-10-17 13:56:52 -070060 CommandOrderOnly: []string{"${config.SoongJavacWrapper}"},
61 Rspfile: "$out.rsp",
62 RspfileContent: "$in",
Kousik Kumar366afc52020-05-20 11:27:16 -070063 }, map[string]*remoteexec.REParams{
64 "$javaTemplate": &remoteexec.REParams{
65 Labels: map[string]string{"type": "compile", "lang": "java", "compiler": "javac"},
66 ExecStrategy: "${config.REJavacExecStrategy}",
67 Platform: map[string]string{remoteexec.PoolKey: "${config.REJavaPool}"},
68 },
69 "$zipTemplate": &remoteexec.REParams{
70 Labels: map[string]string{"type": "tool", "name": "soong_zip"},
71 Inputs: []string{"${config.SoongZipCmd}", "$outDir"},
72 OutputFiles: []string{"$out"},
73 ExecStrategy: "${config.REJavacExecStrategy}",
74 Platform: map[string]string{remoteexec.PoolKey: "${config.REJavaPool}"},
75 },
Ramy Medhat1dcc27e2020-04-21 21:36:23 -040076 }, []string{"javacFlags", "bootClasspath", "classpath", "processorpath", "processor", "srcJars", "srcJarDir",
77 "outDir", "annoDir", "javaVersion"}, nil)
Colin Cross2fe66872015-03-30 17:20:39 -070078
Sasha Smundak2a4549e2018-11-05 16:49:08 -080079 _ = pctx.VariableFunc("kytheCorpus",
80 func(ctx android.PackageVarContext) string { return ctx.Config().XrefCorpusName() })
Sasha Smundak6c2d4f92020-01-09 17:34:23 -080081 _ = pctx.VariableFunc("kytheCuEncoding",
82 func(ctx android.PackageVarContext) string { return ctx.Config().XrefCuEncoding() })
Sasha Smundak65143642019-09-26 20:14:28 -070083 _ = pctx.SourcePathVariable("kytheVnames", "build/soong/vnames.json")
Sasha Smundak2a4549e2018-11-05 16:49:08 -080084 // Run it with -add-opens=java.base/java.nio=ALL-UNNAMED to avoid JDK9's warning about
85 // "Illegal reflective access by com.google.protobuf.Utf8$UnsafeProcessor ...
86 // to field java.nio.Buffer.address"
87 kytheExtract = pctx.AndroidStaticRule("kythe",
88 blueprint.RuleParams{
89 Command: `${config.ZipSyncCmd} -d $srcJarDir ` +
90 `-l $srcJarDir/list -f "*.java" $srcJars && ` +
91 `( [ ! -s $srcJarDir/list -a ! -s $out.rsp ] || ` +
92 `KYTHE_ROOT_DIRECTORY=. KYTHE_OUTPUT_FILE=$out ` +
93 `KYTHE_CORPUS=${kytheCorpus} ` +
Sasha Smundak65143642019-09-26 20:14:28 -070094 `KYTHE_VNAMES=${kytheVnames} ` +
Sasha Smundak6c2d4f92020-01-09 17:34:23 -080095 `KYTHE_KZIP_ENCODING=${kytheCuEncoding} ` +
Sasha Smundak2a4549e2018-11-05 16:49:08 -080096 `${config.SoongJavacWrapper} ${config.JavaCmd} ` +
97 `--add-opens=java.base/java.nio=ALL-UNNAMED ` +
98 `-jar ${config.JavaKytheExtractorJar} ` +
99 `${config.JavacHeapFlags} ${config.CommonJdkFlags} ` +
100 `$processorpath $processor $javacFlags $bootClasspath $classpath ` +
101 `-source $javaVersion -target $javaVersion ` +
102 `-d $outDir -s $annoDir @$out.rsp @$srcJarDir/list)`,
103 CommandDeps: []string{
104 "${config.JavaCmd}",
105 "${config.JavaKytheExtractorJar}",
Sasha Smundak65143642019-09-26 20:14:28 -0700106 "${kytheVnames}",
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800107 "${config.ZipSyncCmd}",
108 },
109 CommandOrderOnly: []string{"${config.SoongJavacWrapper}"},
110 Rspfile: "$out.rsp",
111 RspfileContent: "$in",
112 },
113 "javacFlags", "bootClasspath", "classpath", "processorpath", "processor", "srcJars", "srcJarDir",
114 "outDir", "annoDir", "javaVersion")
115
Sasha Smundaka7856c02020-04-23 09:49:59 -0700116 extractMatchingApks = pctx.StaticRule(
117 "extractMatchingApks",
118 blueprint.RuleParams{
119 Command: `rm -rf "$out" && ` +
120 `${config.ExtractApksCmd} -o "${out}" -allow-prereleased=${allow-prereleased} ` +
121 `-sdk-version=${sdk-version} -abis=${abis} ` +
122 `--screen-densities=${screen-densities} --stem=${stem} ` +
Jaewoong Jung11c1e0f2020-06-29 19:18:44 -0700123 `-apkcerts=${apkcerts} -partition=${partition} ` +
Sasha Smundaka7856c02020-04-23 09:49:59 -0700124 `${in}`,
125 CommandDeps: []string{"${config.ExtractApksCmd}"},
126 },
Jaewoong Jung11c1e0f2020-06-29 19:18:44 -0700127 "abis", "allow-prereleased", "screen-densities", "sdk-version", "stem", "apkcerts", "partition")
Sasha Smundaka7856c02020-04-23 09:49:59 -0700128
Kousik Kumar1372c1b2020-05-20 07:55:56 -0700129 turbine, turbineRE = remoteexec.StaticRules(pctx, "turbine",
Nan Zhanged19fc32017-10-19 13:06:22 -0700130 blueprint.RuleParams{
Colin Cross6981f652018-03-07 15:14:50 -0800131 Command: `rm -rf "$outDir" && mkdir -p "$outDir" && ` +
Kousik Kumar1372c1b2020-05-20 07:55:56 -0700132 `$reTemplate${config.JavaCmd} ${config.JavaVmFlags} -jar ${config.TurbineJar} --output $out.tmp ` +
Colin Cross6981f652018-03-07 15:14:50 -0800133 `--temp_dir "$outDir" --sources @$out.rsp --source_jars $srcJars ` +
Nan Zhanged19fc32017-10-19 13:06:22 -0700134 `--javacopts ${config.CommonJdkFlags} ` +
Colin Cross924a0aa2018-03-07 10:51:05 -0800135 `$javacFlags -source $javaVersion -target $javaVersion -- $bootClasspath $classpath && ` +
Nan Zhanged19fc32017-10-19 13:06:22 -0700136 `${config.Ziptime} $out.tmp && ` +
137 `(if cmp -s $out.tmp $out ; then rm $out.tmp ; else mv $out.tmp $out ; fi )`,
Colin Cross8eadbf02017-10-24 17:46:00 -0700138 CommandDeps: []string{
139 "${config.TurbineJar}",
140 "${config.JavaCmd}",
141 "${config.Ziptime}",
Colin Cross8eadbf02017-10-24 17:46:00 -0700142 },
Nan Zhanged19fc32017-10-19 13:06:22 -0700143 Rspfile: "$out.rsp",
144 RspfileContent: "$in",
145 Restat: true,
146 },
Kousik Kumar1372c1b2020-05-20 07:55:56 -0700147 &remoteexec.REParams{Labels: map[string]string{"type": "tool", "name": "turbine"},
148 ExecStrategy: "${config.RETurbineExecStrategy}",
149 Inputs: []string{"${config.TurbineJar}", "${out}.rsp", "$implicits"},
150 RSPFile: "${out}.rsp",
151 OutputFiles: []string{"$out.tmp"},
152 OutputDirectories: []string{"$outDir"},
153 ToolchainInputs: []string{"${config.JavaCmd}"},
154 Platform: map[string]string{remoteexec.PoolKey: "${config.REJavaPool}"},
155 }, []string{"javacFlags", "bootClasspath", "classpath", "srcJars", "outDir", "javaVersion"}, []string{"implicits"})
Nan Zhanged19fc32017-10-19 13:06:22 -0700156
Kousik Kumar366afc52020-05-20 11:27:16 -0700157 jar, jarRE = remoteexec.StaticRules(pctx, "jar",
Colin Cross2fe66872015-03-30 17:20:39 -0700158 blueprint.RuleParams{
Kousik Kumar366afc52020-05-20 11:27:16 -0700159 Command: `$reTemplate${config.SoongZipCmd} -jar -o $out @$out.rsp`,
Nan Zhang674dd932018-01-26 18:30:36 -0800160 CommandDeps: []string{"${config.SoongZipCmd}"},
161 Rspfile: "$out.rsp",
162 RspfileContent: "$jarArgs",
Colin Cross2fe66872015-03-30 17:20:39 -0700163 },
Kousik Kumar366afc52020-05-20 11:27:16 -0700164 &remoteexec.REParams{
165 ExecStrategy: "${config.REJarExecStrategy}",
166 Inputs: []string{"${config.SoongZipCmd}", "${out}.rsp"},
167 RSPFile: "${out}.rsp",
168 OutputFiles: []string{"$out"},
169 Platform: map[string]string{remoteexec.PoolKey: "${config.REJavaPool}"},
170 }, []string{"jarArgs"}, nil)
Colin Cross0a6e0072017-08-30 14:24:55 -0700171
Kousik Kumar366afc52020-05-20 11:27:16 -0700172 zip, zipRE = remoteexec.StaticRules(pctx, "zip",
Colin Crossa4f08812018-10-02 22:03:40 -0700173 blueprint.RuleParams{
174 Command: `${config.SoongZipCmd} -o $out @$out.rsp`,
175 CommandDeps: []string{"${config.SoongZipCmd}"},
176 Rspfile: "$out.rsp",
177 RspfileContent: "$jarArgs",
178 },
Kousik Kumar366afc52020-05-20 11:27:16 -0700179 &remoteexec.REParams{
180 ExecStrategy: "${config.REZipExecStrategy}",
181 Inputs: []string{"${config.SoongZipCmd}", "${out}.rsp", "$implicits"},
182 RSPFile: "${out}.rsp",
183 OutputFiles: []string{"$out"},
184 Platform: map[string]string{remoteexec.PoolKey: "${config.REJavaPool}"},
185 }, []string{"jarArgs"}, []string{"implicits"})
Colin Crossa4f08812018-10-02 22:03:40 -0700186
Colin Cross0a6e0072017-08-30 14:24:55 -0700187 combineJar = pctx.AndroidStaticRule("combineJar",
188 blueprint.RuleParams{
Colin Crossf91a08c2018-02-07 15:41:31 -0800189 Command: `${config.MergeZipsCmd} --ignore-duplicates -j $jarArgs $out $in`,
Colin Cross0a6e0072017-08-30 14:24:55 -0700190 CommandDeps: []string{"${config.MergeZipsCmd}"},
191 },
Colin Cross635acc92017-09-12 22:50:46 -0700192 "jarArgs")
Colin Cross2fe66872015-03-30 17:20:39 -0700193
Colin Cross9d45bb72016-08-29 16:14:13 -0700194 jarjar = pctx.AndroidStaticRule("jarjar",
Colin Cross65bf4f22015-04-03 16:54:17 -0700195 blueprint.RuleParams{
Colin Crossd97cf632021-02-08 10:14:04 -0800196 Command: "" +
197 // Jarjar doesn't exit with an error when the rules file contains a syntax error,
198 // leading to stale or missing files later in the build. Remove the output file
199 // before running jarjar.
200 "rm -f ${out} && " +
201 "${config.JavaCmd} ${config.JavaVmFlags}" +
Artur Satayev762d9f32020-04-15 12:50:04 +0100202 // b/146418363 Enable Android specific jarjar transformer to drop compat annotations
203 // for newly repackaged classes. Dropping @UnsupportedAppUsage on repackaged classes
204 // avoids adding new hiddenapis after jarjar'ing.
205 " -DremoveAndroidCompatAnnotations=true" +
Colin Crossd97cf632021-02-08 10:14:04 -0800206 " -jar ${config.JarjarCmd} process $rulesFile $in $out && " +
207 // Turn a missing output file into a ninja error
208 `[ -e ${out} ] || (echo "Missing output file"; exit 1)`,
Colin Cross64162712017-08-08 13:17:59 -0700209 CommandDeps: []string{"${config.JavaCmd}", "${config.JarjarCmd}", "$rulesFile"},
Colin Cross65bf4f22015-04-03 16:54:17 -0700210 },
211 "rulesFile")
Nan Zhang4c819fb2018-08-27 18:31:46 -0700212
Vladimir Marko0975ee02019-04-02 10:29:55 +0100213 packageCheck = pctx.AndroidStaticRule("packageCheck",
214 blueprint.RuleParams{
215 Command: "rm -f $out && " +
216 "${config.PackageCheckCmd} $in $packages && " +
Colin Crossb549b772020-06-03 17:14:31 +0000217 "touch $out",
Vladimir Marko0975ee02019-04-02 10:29:55 +0100218 CommandDeps: []string{"${config.PackageCheckCmd}"},
219 },
220 "packages")
221
Nan Zhang4c819fb2018-08-27 18:31:46 -0700222 jetifier = pctx.AndroidStaticRule("jetifier",
223 blueprint.RuleParams{
Sasha Smundak26c6d9e2019-06-11 13:30:13 -0700224 Command: "${config.JavaCmd} ${config.JavaVmFlags} -jar ${config.JetifierJar} -l error -o $out -i $in",
Nan Zhang4c819fb2018-08-27 18:31:46 -0700225 CommandDeps: []string{"${config.JavaCmd}", "${config.JetifierJar}"},
226 },
227 )
Colin Cross43f08db2018-11-12 10:13:39 -0800228
229 zipalign = pctx.AndroidStaticRule("zipalign",
230 blueprint.RuleParams{
Colin Crosse4246ab2019-02-05 21:55:21 -0800231 Command: "if ! ${config.ZipAlign} -c -p 4 $in > /dev/null; then " +
232 "${config.ZipAlign} -f -p 4 $in $out; " +
Colin Cross43f08db2018-11-12 10:13:39 -0800233 "else " +
234 "cp -f $in $out; " +
235 "fi",
236 CommandDeps: []string{"${config.ZipAlign}"},
237 },
238 )
Colin Cross2fe66872015-03-30 17:20:39 -0700239)
240
241func init() {
Colin Crosscc0ce802019-04-02 16:14:11 -0700242 pctx.Import("android/soong/android")
Colin Cross64162712017-08-08 13:17:59 -0700243 pctx.Import("android/soong/java/config")
Ramy Medhat1dcc27e2020-04-21 21:36:23 -0400244 pctx.Import("android/soong/remoteexec")
Colin Cross2fe66872015-03-30 17:20:39 -0700245}
246
247type javaBuilderFlags struct {
Colin Cross6cef4812019-10-17 14:23:50 -0700248 javacFlags string
249 bootClasspath classpath
250 classpath classpath
251 java9Classpath classpath
252 processorPath classpath
Colin Cross5a116862020-04-22 11:44:34 -0700253 processors []string
Colin Cross6cef4812019-10-17 14:23:50 -0700254 systemModules *systemModules
255 aidlFlags string
256 aidlDeps android.Paths
257 javaVersion javaVersion
Colin Cross6af17aa2017-09-20 12:59:05 -0700258
Andreas Gampef3e5b552018-01-22 21:27:21 -0800259 errorProneExtraJavacFlags string
Colin Cross66548102018-06-19 22:47:35 -0700260 errorProneProcessorPath classpath
Andreas Gampef3e5b552018-01-22 21:27:21 -0800261
Colin Cross93e85952017-08-15 13:34:18 -0700262 kotlincFlags string
263 kotlincClasspath classpath
264
Colin Cross19878da2019-03-28 14:45:07 -0700265 proto android.ProtoFlags
Colin Cross2fe66872015-03-30 17:20:39 -0700266}
267
Nan Zhang61eaedb2017-11-02 13:28:15 -0700268func TransformJavaToClasses(ctx android.ModuleContext, outputFile android.WritablePath, shardIdx int,
269 srcFiles, srcJars android.Paths, flags javaBuilderFlags, deps android.Paths) {
Colin Cross2fe66872015-03-30 17:20:39 -0700270
Nan Zhang61eaedb2017-11-02 13:28:15 -0700271 // Compile java sources into .class files
272 desc := "javac"
273 if shardIdx >= 0 {
274 desc += strconv.Itoa(shardIdx)
275 }
276
Colin Cross66548102018-06-19 22:47:35 -0700277 transformJavaToClasses(ctx, outputFile, shardIdx, srcFiles, srcJars, flags, deps, "javac", desc)
Colin Cross2fe66872015-03-30 17:20:39 -0700278}
279
Colin Crosse9a275b2017-10-16 17:09:48 -0700280func RunErrorProne(ctx android.ModuleContext, outputFile android.WritablePath,
Colin Cross8eadbf02017-10-24 17:46:00 -0700281 srcFiles, srcJars android.Paths, flags javaBuilderFlags) {
Colin Crossc6bbef32017-08-14 14:16:06 -0700282
Colin Cross66548102018-06-19 22:47:35 -0700283 flags.processorPath = append(flags.errorProneProcessorPath, flags.processorPath...)
Colin Crossfee57cb2017-09-05 13:16:45 -0700284
Andreas Gampef3e5b552018-01-22 21:27:21 -0800285 if len(flags.errorProneExtraJavacFlags) > 0 {
286 if len(flags.javacFlags) > 0 {
Colin Cross66548102018-06-19 22:47:35 -0700287 flags.javacFlags += " " + flags.errorProneExtraJavacFlags
Andreas Gampef3e5b552018-01-22 21:27:21 -0800288 } else {
289 flags.javacFlags = flags.errorProneExtraJavacFlags
290 }
291 }
292
Nan Zhang61eaedb2017-11-02 13:28:15 -0700293 transformJavaToClasses(ctx, outputFile, -1, srcFiles, srcJars, flags, nil,
Colin Cross66548102018-06-19 22:47:35 -0700294 "errorprone", "errorprone")
Colin Cross070879e2017-10-11 11:21:07 -0700295}
296
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800297// Emits the rule to generate Xref input file (.kzip file) for the given set of source files and source jars
298// to compile with given set of builder flags, etc.
Colin Cross3b706fd2019-09-05 16:44:18 -0700299func emitXrefRule(ctx android.ModuleContext, xrefFile android.WritablePath, idx int,
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800300 srcFiles, srcJars android.Paths,
Colin Cross3b706fd2019-09-05 16:44:18 -0700301 flags javaBuilderFlags, deps android.Paths) {
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800302
303 deps = append(deps, srcJars...)
Sasha Smundak09950a42019-11-04 16:29:45 -0800304 classpath := flags.classpath
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800305
306 var bootClasspath string
Colin Cross1e743852019-10-28 11:37:20 -0700307 if flags.javaVersion.usesJavaModules() {
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800308 var systemModuleDeps android.Paths
309 bootClasspath, systemModuleDeps = flags.systemModules.FormJavaSystemModulesPath(ctx.Device())
310 deps = append(deps, systemModuleDeps...)
Sasha Smundak09950a42019-11-04 16:29:45 -0800311 classpath = append(flags.java9Classpath, classpath...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800312 } else {
313 deps = append(deps, flags.bootClasspath...)
314 if len(flags.bootClasspath) == 0 && ctx.Device() {
315 // explicitly specify -bootclasspath "" if the bootclasspath is empty to
316 // ensure java does not fall back to the default bootclasspath.
317 bootClasspath = `-bootclasspath ""`
318 } else {
319 bootClasspath = flags.bootClasspath.FormJavaClassPath("-bootclasspath")
320 }
321 }
322
Sasha Smundak09950a42019-11-04 16:29:45 -0800323 deps = append(deps, classpath...)
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800324 deps = append(deps, flags.processorPath...)
325
326 processor := "-proc:none"
Colin Cross5a116862020-04-22 11:44:34 -0700327 if len(flags.processors) > 0 {
328 processor = "-processor " + strings.Join(flags.processors, ",")
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800329 }
330
Colin Cross3b706fd2019-09-05 16:44:18 -0700331 intermediatesDir := "xref"
332 if idx >= 0 {
333 intermediatesDir += strconv.Itoa(idx)
334 }
335
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800336 ctx.Build(pctx,
337 android.BuildParams{
338 Rule: kytheExtract,
339 Description: "Xref Java extractor",
340 Output: xrefFile,
341 Inputs: srcFiles,
342 Implicits: deps,
343 Args: map[string]string{
344 "annoDir": android.PathForModuleOut(ctx, intermediatesDir, "anno").String(),
345 "bootClasspath": bootClasspath,
Sasha Smundak09950a42019-11-04 16:29:45 -0800346 "classpath": classpath.FormJavaClassPath("-classpath"),
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800347 "javacFlags": flags.javacFlags,
Colin Cross1e743852019-10-28 11:37:20 -0700348 "javaVersion": flags.javaVersion.String(),
Sasha Smundak2a4549e2018-11-05 16:49:08 -0800349 "outDir": android.PathForModuleOut(ctx, "javac", "classes.xref").String(),
350 "processorpath": flags.processorPath.FormJavaClassPath("-processorpath"),
351 "processor": processor,
352 "srcJarDir": android.PathForModuleOut(ctx, intermediatesDir, "srcjars.xref").String(),
353 "srcJars": strings.Join(srcJars.Strings(), " "),
354 },
355 })
356}
357
Nan Zhanged19fc32017-10-19 13:06:22 -0700358func TransformJavaToHeaderClasses(ctx android.ModuleContext, outputFile android.WritablePath,
Colin Cross8eadbf02017-10-24 17:46:00 -0700359 srcFiles, srcJars android.Paths, flags javaBuilderFlags) {
Nan Zhanged19fc32017-10-19 13:06:22 -0700360
361 var deps android.Paths
362 deps = append(deps, srcJars...)
Nan Zhanged19fc32017-10-19 13:06:22 -0700363
Colin Cross6cef4812019-10-17 14:23:50 -0700364 classpath := flags.classpath
365
Nan Zhanged19fc32017-10-19 13:06:22 -0700366 var bootClasspath string
Colin Crossbf3119e2019-10-28 14:25:10 -0700367 if flags.javaVersion.usesJavaModules() {
368 var systemModuleDeps android.Paths
369 bootClasspath, systemModuleDeps = flags.systemModules.FormTurbineSystemModulesPath(ctx.Device())
370 deps = append(deps, systemModuleDeps...)
Colin Cross6cef4812019-10-17 14:23:50 -0700371 classpath = append(flags.java9Classpath, classpath...)
Nan Zhanged19fc32017-10-19 13:06:22 -0700372 } else {
Colin Crossbf3119e2019-10-28 14:25:10 -0700373 deps = append(deps, flags.bootClasspath...)
374 if len(flags.bootClasspath) == 0 && ctx.Device() {
375 // explicitly specify -bootclasspath "" if the bootclasspath is empty to
376 // ensure turbine does not fall back to the default bootclasspath.
377 bootClasspath = `--bootclasspath ""`
378 } else {
Colin Crossc2557d12019-10-31 15:22:57 -0700379 bootClasspath = flags.bootClasspath.FormTurbineClassPath("--bootclasspath ")
Colin Crossbf3119e2019-10-28 14:25:10 -0700380 }
Nan Zhanged19fc32017-10-19 13:06:22 -0700381 }
Colin Cross8eadbf02017-10-24 17:46:00 -0700382
Colin Cross6cef4812019-10-17 14:23:50 -0700383 deps = append(deps, classpath...)
Colin Crossbf3119e2019-10-28 14:25:10 -0700384 deps = append(deps, flags.processorPath...)
385
Kousik Kumar1372c1b2020-05-20 07:55:56 -0700386 rule := turbine
387 args := map[string]string{
388 "javacFlags": flags.javacFlags,
389 "bootClasspath": bootClasspath,
390 "srcJars": strings.Join(srcJars.Strings(), " "),
391 "classpath": classpath.FormTurbineClassPath("--classpath "),
392 "outDir": android.PathForModuleOut(ctx, "turbine", "classes").String(),
393 "javaVersion": flags.javaVersion.String(),
394 }
Ramy Medhat16f23a42020-09-03 01:29:49 -0400395 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_TURBINE") {
Kousik Kumar1372c1b2020-05-20 07:55:56 -0700396 rule = turbineRE
397 args["implicits"] = strings.Join(deps.Strings(), ",")
398 }
Colin Crossae887032017-10-23 17:16:14 -0700399 ctx.Build(pctx, android.BuildParams{
Kousik Kumar1372c1b2020-05-20 07:55:56 -0700400 Rule: rule,
Nan Zhanged19fc32017-10-19 13:06:22 -0700401 Description: "turbine",
402 Output: outputFile,
403 Inputs: srcFiles,
404 Implicits: deps,
Kousik Kumar1372c1b2020-05-20 07:55:56 -0700405 Args: args,
Nan Zhanged19fc32017-10-19 13:06:22 -0700406 })
407}
408
Colin Cross070879e2017-10-11 11:21:07 -0700409// transformJavaToClasses takes source files and converts them to a jar containing .class files.
Colin Cross59149b62017-10-16 18:07:29 -0700410// srcFiles is a list of paths to sources, srcJars is a list of paths to jar files that contain
411// sources. flags contains various command line flags to be passed to the compiler.
Colin Cross070879e2017-10-11 11:21:07 -0700412//
413// This method may be used for different compilers, including javac and Error Prone. The rule
414// argument specifies which command line to use and desc sets the description of the rule that will
415// be printed at build time. The stem argument provides the file name of the output jar, and
416// suffix will be appended to various intermediate files and directories to avoid collisions when
417// this function is called twice in the same module directory.
Colin Crosse9a275b2017-10-16 17:09:48 -0700418func transformJavaToClasses(ctx android.ModuleContext, outputFile android.WritablePath,
Nan Zhang61eaedb2017-11-02 13:28:15 -0700419 shardIdx int, srcFiles, srcJars android.Paths,
Colin Crosse9a275b2017-10-16 17:09:48 -0700420 flags javaBuilderFlags, deps android.Paths,
Colin Cross66548102018-06-19 22:47:35 -0700421 intermediatesDir, desc string) {
Colin Crossc6bbef32017-08-14 14:16:06 -0700422
Colin Cross59149b62017-10-16 18:07:29 -0700423 deps = append(deps, srcJars...)
Colin Cross1369cdb2017-09-29 17:58:17 -0700424
Colin Cross6cef4812019-10-17 14:23:50 -0700425 classpath := flags.classpath
426
Colin Cross1369cdb2017-09-29 17:58:17 -0700427 var bootClasspath string
Colin Cross1e743852019-10-28 11:37:20 -0700428 if flags.javaVersion.usesJavaModules() {
Colin Crossb77043e2019-07-16 13:57:13 -0700429 var systemModuleDeps android.Paths
430 bootClasspath, systemModuleDeps = flags.systemModules.FormJavaSystemModulesPath(ctx.Device())
431 deps = append(deps, systemModuleDeps...)
Colin Cross6cef4812019-10-17 14:23:50 -0700432 classpath = append(flags.java9Classpath, classpath...)
Colin Cross1369cdb2017-09-29 17:58:17 -0700433 } else {
434 deps = append(deps, flags.bootClasspath...)
Nan Zhanged19fc32017-10-19 13:06:22 -0700435 if len(flags.bootClasspath) == 0 && ctx.Device() {
436 // explicitly specify -bootclasspath "" if the bootclasspath is empty to
437 // ensure java does not fall back to the default bootclasspath.
438 bootClasspath = `-bootclasspath ""`
439 } else {
440 bootClasspath = flags.bootClasspath.FormJavaClassPath("-bootclasspath")
441 }
Colin Cross1369cdb2017-09-29 17:58:17 -0700442 }
443
Colin Cross6cef4812019-10-17 14:23:50 -0700444 deps = append(deps, classpath...)
Colin Cross6a77c982018-06-19 22:43:34 -0700445 deps = append(deps, flags.processorPath...)
Colin Crossc6bbef32017-08-14 14:16:06 -0700446
Colin Cross7788c122019-01-23 16:14:02 -0800447 processor := "-proc:none"
Colin Cross5a116862020-04-22 11:44:34 -0700448 if len(flags.processors) > 0 {
449 processor = "-processor " + strings.Join(flags.processors, ",")
Colin Crossbe9cdb82019-01-21 21:37:16 -0800450 }
451
Nan Zhang61eaedb2017-11-02 13:28:15 -0700452 srcJarDir := "srcjars"
453 outDir := "classes"
454 annoDir := "anno"
455 if shardIdx >= 0 {
456 shardDir := "shard" + strconv.Itoa(shardIdx)
457 srcJarDir = filepath.Join(shardDir, srcJarDir)
458 outDir = filepath.Join(shardDir, outDir)
459 annoDir = filepath.Join(shardDir, annoDir)
460 }
Ramy Medhat1dcc27e2020-04-21 21:36:23 -0400461 rule := javac
Ramy Medhat16f23a42020-09-03 01:29:49 -0400462 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_JAVAC") {
Ramy Medhat1dcc27e2020-04-21 21:36:23 -0400463 rule = javacRE
464 }
Colin Crossae887032017-10-23 17:16:14 -0700465 ctx.Build(pctx, android.BuildParams{
Ramy Medhat1dcc27e2020-04-21 21:36:23 -0400466 Rule: rule,
Colin Cross070879e2017-10-11 11:21:07 -0700467 Description: desc,
468 Output: outputFile,
Colin Crossc6bbef32017-08-14 14:16:06 -0700469 Inputs: srcFiles,
470 Implicits: deps,
471 Args: map[string]string{
Colin Cross59149b62017-10-16 18:07:29 -0700472 "javacFlags": flags.javacFlags,
Colin Cross1369cdb2017-09-29 17:58:17 -0700473 "bootClasspath": bootClasspath,
Colin Cross6cef4812019-10-17 14:23:50 -0700474 "classpath": classpath.FormJavaClassPath("-classpath"),
Colin Cross6a77c982018-06-19 22:43:34 -0700475 "processorpath": flags.processorPath.FormJavaClassPath("-processorpath"),
Colin Crossbe9cdb82019-01-21 21:37:16 -0800476 "processor": processor,
Colin Cross8eadbf02017-10-24 17:46:00 -0700477 "srcJars": strings.Join(srcJars.Strings(), " "),
Nan Zhang61eaedb2017-11-02 13:28:15 -0700478 "srcJarDir": android.PathForModuleOut(ctx, intermediatesDir, srcJarDir).String(),
479 "outDir": android.PathForModuleOut(ctx, intermediatesDir, outDir).String(),
480 "annoDir": android.PathForModuleOut(ctx, intermediatesDir, annoDir).String(),
Colin Cross1e743852019-10-28 11:37:20 -0700481 "javaVersion": flags.javaVersion.String(),
Colin Crossc6bbef32017-08-14 14:16:06 -0700482 },
483 })
Colin Crossc6bbef32017-08-14 14:16:06 -0700484}
485
Colin Crosse9a275b2017-10-16 17:09:48 -0700486func TransformResourcesToJar(ctx android.ModuleContext, outputFile android.WritablePath,
487 jarArgs []string, deps android.Paths) {
Colin Cross2fe66872015-03-30 17:20:39 -0700488
Kousik Kumar366afc52020-05-20 11:27:16 -0700489 rule := jar
Ramy Medhat16f23a42020-09-03 01:29:49 -0400490 if ctx.Config().UseRBE() && ctx.Config().IsEnvTrue("RBE_JAR") {
Kousik Kumar366afc52020-05-20 11:27:16 -0700491 rule = jarRE
492 }
Colin Crossae887032017-10-23 17:16:14 -0700493 ctx.Build(pctx, android.BuildParams{
Kousik Kumar366afc52020-05-20 11:27:16 -0700494 Rule: rule,
Colin Cross67a5c132017-05-09 13:45:28 -0700495 Description: "jar",
496 Output: outputFile,
497 Implicits: deps,
Colin Cross2fe66872015-03-30 17:20:39 -0700498 Args: map[string]string{
Colin Cross0b9f31f2019-02-28 11:00:01 -0800499 "jarArgs": strings.Join(proptools.NinjaAndShellEscapeList(jarArgs), " "),
Colin Cross2fe66872015-03-30 17:20:39 -0700500 },
501 })
Colin Cross2fe66872015-03-30 17:20:39 -0700502}
503
Nan Zhanged19fc32017-10-19 13:06:22 -0700504func TransformJarsToJar(ctx android.ModuleContext, outputFile android.WritablePath, desc string,
Colin Cross37f6d792018-07-12 12:28:41 -0700505 jars android.Paths, manifest android.OptionalPath, stripDirEntries bool, filesToStrip []string,
506 dirsToStrip []string) {
Colin Cross0a6e0072017-08-30 14:24:55 -0700507
Colin Cross635acc92017-09-12 22:50:46 -0700508 var deps android.Paths
509
510 var jarArgs []string
511 if manifest.Valid() {
Nan Zhanged19fc32017-10-19 13:06:22 -0700512 jarArgs = append(jarArgs, "-m ", manifest.String())
Colin Cross635acc92017-09-12 22:50:46 -0700513 deps = append(deps, manifest.Path())
514 }
515
Colin Cross37f6d792018-07-12 12:28:41 -0700516 for _, dir := range dirsToStrip {
517 jarArgs = append(jarArgs, "-stripDir ", dir)
518 }
519
520 for _, file := range filesToStrip {
521 jarArgs = append(jarArgs, "-stripFile ", file)
Nan Zhanged19fc32017-10-19 13:06:22 -0700522 }
523
Colin Cross7b60cdd2017-12-21 13:52:58 -0800524 // Remove any module-info.class files that may have come from prebuilt jars, they cause problems
525 // for downstream tools like desugar.
526 jarArgs = append(jarArgs, "-stripFile module-info.class")
527
Colin Cross37f6d792018-07-12 12:28:41 -0700528 if stripDirEntries {
Colin Cross635acc92017-09-12 22:50:46 -0700529 jarArgs = append(jarArgs, "-D")
530 }
531
Colin Crossae887032017-10-23 17:16:14 -0700532 ctx.Build(pctx, android.BuildParams{
Colin Cross0a6e0072017-08-30 14:24:55 -0700533 Rule: combineJar,
Nan Zhanged19fc32017-10-19 13:06:22 -0700534 Description: desc,
Colin Cross0a6e0072017-08-30 14:24:55 -0700535 Output: outputFile,
536 Inputs: jars,
Colin Cross635acc92017-09-12 22:50:46 -0700537 Implicits: deps,
538 Args: map[string]string{
539 "jarArgs": strings.Join(jarArgs, " "),
540 },
Colin Cross0a6e0072017-08-30 14:24:55 -0700541 })
Colin Cross0a6e0072017-08-30 14:24:55 -0700542}
543
Colin Crosse9a275b2017-10-16 17:09:48 -0700544func TransformJarJar(ctx android.ModuleContext, outputFile android.WritablePath,
545 classesJar android.Path, rulesFile android.Path) {
Colin Crossae887032017-10-23 17:16:14 -0700546 ctx.Build(pctx, android.BuildParams{
Colin Cross67a5c132017-05-09 13:45:28 -0700547 Rule: jarjar,
548 Description: "jarjar",
549 Output: outputFile,
550 Input: classesJar,
551 Implicit: rulesFile,
Colin Cross65bf4f22015-04-03 16:54:17 -0700552 Args: map[string]string{
Dan Willemsen34cc69e2015-09-23 15:26:20 -0700553 "rulesFile": rulesFile.String(),
Colin Cross65bf4f22015-04-03 16:54:17 -0700554 },
555 })
Colin Cross65bf4f22015-04-03 16:54:17 -0700556}
Colin Cross6ade34f2017-09-15 13:00:47 -0700557
Colin Crossb549b772020-06-03 17:14:31 +0000558func CheckJarPackages(ctx android.ModuleContext, outputFile android.WritablePath,
559 classesJar android.Path, permittedPackages []string) {
Vladimir Marko0975ee02019-04-02 10:29:55 +0100560 ctx.Build(pctx, android.BuildParams{
561 Rule: packageCheck,
562 Description: "packageCheck",
563 Output: outputFile,
564 Input: classesJar,
565 Args: map[string]string{
566 "packages": strings.Join(permittedPackages, " "),
567 },
568 })
569}
570
Nan Zhang4c819fb2018-08-27 18:31:46 -0700571func TransformJetifier(ctx android.ModuleContext, outputFile android.WritablePath,
572 inputFile android.Path) {
573 ctx.Build(pctx, android.BuildParams{
574 Rule: jetifier,
575 Description: "jetifier",
576 Output: outputFile,
577 Input: inputFile,
578 })
579}
580
Colin Cross094054a2018-10-17 15:10:48 -0700581func GenerateMainClassManifest(ctx android.ModuleContext, outputFile android.WritablePath, mainClass string) {
Colin Crosscf371cc2020-11-13 11:48:42 -0800582 android.WriteFileRule(ctx, outputFile, "Main-Class: "+mainClass+"\n")
Colin Cross094054a2018-10-17 15:10:48 -0700583}
584
Colin Cross43f08db2018-11-12 10:13:39 -0800585func TransformZipAlign(ctx android.ModuleContext, outputFile android.WritablePath, inputFile android.Path) {
586 ctx.Build(pctx, android.BuildParams{
587 Rule: zipalign,
588 Description: "align",
589 Input: inputFile,
590 Output: outputFile,
591 })
592}
593
Colin Cross33961b52019-07-11 11:01:22 -0700594type classpath android.Paths
Colin Cross6ade34f2017-09-15 13:00:47 -0700595
Colin Crossc2557d12019-10-31 15:22:57 -0700596func (x *classpath) formJoinedClassPath(optName string, sep string) string {
Colin Cross81440082018-08-15 20:21:55 -0700597 if optName != "" && !strings.HasSuffix(optName, "=") && !strings.HasSuffix(optName, " ") {
598 optName += " "
599 }
Colin Cross59149b62017-10-16 18:07:29 -0700600 if len(*x) > 0 {
Colin Crossc2557d12019-10-31 15:22:57 -0700601 return optName + strings.Join(x.Strings(), sep)
Colin Cross6ade34f2017-09-15 13:00:47 -0700602 } else {
603 return ""
604 }
605}
Colin Crossc2557d12019-10-31 15:22:57 -0700606func (x *classpath) FormJavaClassPath(optName string) string {
607 return x.formJoinedClassPath(optName, ":")
608}
Colin Cross6ade34f2017-09-15 13:00:47 -0700609
Colin Crossc2557d12019-10-31 15:22:57 -0700610func (x *classpath) FormTurbineClassPath(optName string) string {
611 return x.formJoinedClassPath(optName, " ")
612}
613
614// FormRepeatedClassPath returns a list of arguments with the given optName prefixed to each element of the classpath.
615func (x *classpath) FormRepeatedClassPath(optName string) []string {
Colin Cross6ade34f2017-09-15 13:00:47 -0700616 if x == nil || *x == nil {
617 return nil
618 }
619 flags := make([]string, len(*x))
620 for i, v := range *x {
Colin Crossafbb1732019-01-17 15:42:52 -0800621 flags[i] = optName + v.String()
Colin Cross6ade34f2017-09-15 13:00:47 -0700622 }
623
624 return flags
625}
626
Colin Cross6ade34f2017-09-15 13:00:47 -0700627// Convert a classpath to an android.Paths
628func (x *classpath) Paths() android.Paths {
629 return append(android.Paths(nil), (*x)...)
630}
631
632func (x *classpath) Strings() []string {
633 if x == nil {
634 return nil
635 }
636 ret := make([]string, len(*x))
637 for i, path := range *x {
638 ret[i] = path.String()
639 }
640 return ret
641}
Colin Crossb77043e2019-07-16 13:57:13 -0700642
643type systemModules struct {
644 dir android.Path
645 deps android.Paths
646}
647
Colin Crossbf3119e2019-10-28 14:25:10 -0700648// Returns a --system argument in the form javac expects with -source 1.9 and the list of files to
649// depend on. If forceEmpty is true, returns --system=none if the list is empty to ensure javac
650// does not fall back to the default system modules.
Colin Crossb77043e2019-07-16 13:57:13 -0700651func (x *systemModules) FormJavaSystemModulesPath(forceEmpty bool) (string, android.Paths) {
652 if x != nil {
653 return "--system=" + x.dir.String(), x.deps
654 } else if forceEmpty {
655 return "--system=none", nil
656 } else {
657 return "", nil
658 }
659}
Colin Crossbf3119e2019-10-28 14:25:10 -0700660
661// Returns a --system argument in the form turbine expects with -source 1.9 and the list of files to
662// depend on. If forceEmpty is true, returns --bootclasspath "" if the list is empty to ensure turbine
663// does not fall back to the default bootclasspath.
664func (x *systemModules) FormTurbineSystemModulesPath(forceEmpty bool) (string, android.Paths) {
665 if x != nil {
666 return "--system " + x.dir.String(), x.deps
667 } else if forceEmpty {
668 return `--bootclasspath ""`, nil
669 } else {
670 return "", nil
671 }
672}