Colin Cross | 5049f02 | 2015-03-18 13:28:46 -0700 | [diff] [blame] | 1 | // 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 | |
Alex Humesky | 29e3bbe | 2020-11-20 21:30:13 -0500 | [diff] [blame] | 15 | // A genrule module takes a list of source files ("srcs" property), an optional |
| 16 | // list of tools ("tools" property), and a command line ("cmd" property), to |
| 17 | // generate output files ("out" property). |
| 18 | |
Colin Cross | 5049f02 | 2015-03-18 13:28:46 -0700 | [diff] [blame] | 19 | package genrule |
| 20 | |
| 21 | import ( |
Colin Cross | 6f080df | 2016-11-04 15:32:58 -0700 | [diff] [blame] | 22 | "fmt" |
Colin Cross | a4ad2b0 | 2019-03-18 22:15:32 -0700 | [diff] [blame] | 23 | "io" |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 24 | "path/filepath" |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 25 | "strconv" |
Colin Cross | 6f080df | 2016-11-04 15:32:58 -0700 | [diff] [blame] | 26 | "strings" |
Dan Willemsen | 3f4539b | 2016-09-28 16:19:10 -0700 | [diff] [blame] | 27 | |
Colin Cross | 70b4059 | 2015-03-23 12:57:34 -0700 | [diff] [blame] | 28 | "github.com/google/blueprint" |
Dan Willemsen | 8eded0a | 2017-09-13 16:07:44 -0700 | [diff] [blame] | 29 | "github.com/google/blueprint/bootstrap" |
Nan Zhang | ea568a4 | 2017-11-08 21:20:04 -0800 | [diff] [blame] | 30 | "github.com/google/blueprint/proptools" |
Colin Cross | 5049f02 | 2015-03-18 13:28:46 -0700 | [diff] [blame] | 31 | |
Colin Cross | 635c3b0 | 2016-05-18 15:37:25 -0700 | [diff] [blame] | 32 | "android/soong/android" |
Jingwen Chen | 30f5aaa | 2020-11-19 05:38:02 -0500 | [diff] [blame] | 33 | "android/soong/bazel" |
Colin Cross | 5049f02 | 2015-03-18 13:28:46 -0700 | [diff] [blame] | 34 | ) |
| 35 | |
Colin Cross | 463a90e | 2015-06-17 14:20:06 -0700 | [diff] [blame] | 36 | func init() { |
Colin Cross | e9fe294 | 2020-11-10 18:12:15 -0800 | [diff] [blame] | 37 | RegisterGenruleBuildComponents(android.InitRegistrationContext) |
Martin Stjernholm | 710ec3a | 2020-01-16 15:12:04 +0000 | [diff] [blame] | 38 | } |
Jaewoong Jung | 98716bd | 2018-12-10 08:13:18 -0800 | [diff] [blame] | 39 | |
Colin Cross | e9fe294 | 2020-11-10 18:12:15 -0800 | [diff] [blame] | 40 | func RegisterGenruleBuildComponents(ctx android.RegistrationContext) { |
Martin Stjernholm | 710ec3a | 2020-01-16 15:12:04 +0000 | [diff] [blame] | 41 | ctx.RegisterModuleType("genrule_defaults", defaultsFactory) |
| 42 | |
| 43 | ctx.RegisterModuleType("gensrcs", GenSrcsFactory) |
| 44 | ctx.RegisterModuleType("genrule", GenRuleFactory) |
| 45 | |
| 46 | ctx.FinalDepsMutators(func(ctx android.RegisterMutatorsContext) { |
| 47 | ctx.BottomUp("genrule_tool_deps", toolDepsMutator).Parallel() |
| 48 | }) |
Jingwen Chen | 316e07c | 2020-12-14 09:09:52 -0500 | [diff] [blame] | 49 | |
Jingwen Chen | a42d641 | 2021-01-26 21:57:27 -0500 | [diff] [blame^] | 50 | android.RegisterBp2BuildMutator("genrule", GenruleBp2Build) |
Colin Cross | 463a90e | 2015-06-17 14:20:06 -0700 | [diff] [blame] | 51 | } |
| 52 | |
Colin Cross | 5049f02 | 2015-03-18 13:28:46 -0700 | [diff] [blame] | 53 | var ( |
Colin Cross | 635c3b0 | 2016-05-18 15:37:25 -0700 | [diff] [blame] | 54 | pctx = android.NewPackageContext("android/soong/genrule") |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 55 | |
Alex Humesky | 29e3bbe | 2020-11-20 21:30:13 -0500 | [diff] [blame] | 56 | // Used by gensrcs when there is more than 1 shard to merge the outputs |
| 57 | // of each shard into a zip file. |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 58 | gensrcsMerge = pctx.AndroidStaticRule("gensrcsMerge", blueprint.RuleParams{ |
| 59 | Command: "${soongZip} -o ${tmpZip} @${tmpZip}.rsp && ${zipSync} -d ${genDir} ${tmpZip}", |
| 60 | CommandDeps: []string{"${soongZip}", "${zipSync}"}, |
| 61 | Rspfile: "${tmpZip}.rsp", |
| 62 | RspfileContent: "${zipArgs}", |
| 63 | }, "tmpZip", "genDir", "zipArgs") |
Colin Cross | 5049f02 | 2015-03-18 13:28:46 -0700 | [diff] [blame] | 64 | ) |
| 65 | |
Jeff Gaston | efc1b41 | 2017-03-29 17:29:06 -0700 | [diff] [blame] | 66 | func init() { |
Dan Willemsen | ddf504c | 2019-08-09 16:21:29 -0700 | [diff] [blame] | 67 | pctx.Import("android/soong/android") |
Jeff Gaston | efc1b41 | 2017-03-29 17:29:06 -0700 | [diff] [blame] | 68 | pctx.HostBinToolVariable("sboxCmd", "sbox") |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 69 | |
| 70 | pctx.HostBinToolVariable("soongZip", "soong_zip") |
| 71 | pctx.HostBinToolVariable("zipSync", "zipsync") |
Jeff Gaston | efc1b41 | 2017-03-29 17:29:06 -0700 | [diff] [blame] | 72 | } |
| 73 | |
Colin Cross | 5049f02 | 2015-03-18 13:28:46 -0700 | [diff] [blame] | 74 | type SourceFileGenerator interface { |
Colin Cross | 635c3b0 | 2016-05-18 15:37:25 -0700 | [diff] [blame] | 75 | GeneratedSourceFiles() android.Paths |
Colin Cross | 5ed99c6 | 2016-11-22 12:55:55 -0800 | [diff] [blame] | 76 | GeneratedHeaderDirs() android.Paths |
Dan Willemsen | 9da9d49 | 2018-02-21 18:28:18 -0800 | [diff] [blame] | 77 | GeneratedDeps() android.Paths |
Colin Cross | 5049f02 | 2015-03-18 13:28:46 -0700 | [diff] [blame] | 78 | } |
| 79 | |
Colin Cross | fe17f6f | 2019-03-28 19:30:56 -0700 | [diff] [blame] | 80 | // Alias for android.HostToolProvider |
| 81 | // Deprecated: use android.HostToolProvider instead. |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 82 | type HostToolProvider interface { |
Colin Cross | fe17f6f | 2019-03-28 19:30:56 -0700 | [diff] [blame] | 83 | android.HostToolProvider |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 84 | } |
Colin Cross | 5049f02 | 2015-03-18 13:28:46 -0700 | [diff] [blame] | 85 | |
Dan Willemsen | d6ba0d5 | 2017-09-13 15:46:47 -0700 | [diff] [blame] | 86 | type hostToolDependencyTag struct { |
| 87 | blueprint.BaseDependencyTag |
Colin Cross | 08f15ab | 2018-10-04 23:29:14 -0700 | [diff] [blame] | 88 | label string |
Dan Willemsen | d6ba0d5 | 2017-09-13 15:46:47 -0700 | [diff] [blame] | 89 | } |
Colin Cross | 7d5136f | 2015-05-11 13:39:40 -0700 | [diff] [blame] | 90 | type generatorProperties struct { |
Jeff Gaston | efc1b41 | 2017-03-29 17:29:06 -0700 | [diff] [blame] | 91 | // The command to run on one or more input files. Cmd supports substitution of a few variables |
Jeff Gaston | efc1b41 | 2017-03-29 17:29:06 -0700 | [diff] [blame] | 92 | // |
| 93 | // Available variables for substitution: |
| 94 | // |
Colin Cross | 2296f5b | 2017-10-17 21:38:14 -0700 | [diff] [blame] | 95 | // $(location): the path to the first entry in tools or tool_files |
Colin Cross | 08f15ab | 2018-10-04 23:29:14 -0700 | [diff] [blame] | 96 | // $(location <label>): the path to the tool, tool_file, input or output with name <label> |
Colin Cross | 2296f5b | 2017-10-17 21:38:14 -0700 | [diff] [blame] | 97 | // $(in): one or more input files |
| 98 | // $(out): a single output file |
| 99 | // $(depfile): a file to which dependencies will be written, if the depfile property is set to true |
| 100 | // $(genDir): the sandbox directory for this tool; contains $(out) |
| 101 | // $$: a literal $ |
Nan Zhang | ea568a4 | 2017-11-08 21:20:04 -0800 | [diff] [blame] | 102 | Cmd *string |
Colin Cross | 7d5136f | 2015-05-11 13:39:40 -0700 | [diff] [blame] | 103 | |
Colin Cross | 33bfb0a | 2016-11-21 17:23:08 -0800 | [diff] [blame] | 104 | // Enable reading a file containing dependencies in gcc format after the command completes |
Nan Zhang | ea568a4 | 2017-11-08 21:20:04 -0800 | [diff] [blame] | 105 | Depfile *bool |
Colin Cross | 33bfb0a | 2016-11-21 17:23:08 -0800 | [diff] [blame] | 106 | |
Colin Cross | 6f080df | 2016-11-04 15:32:58 -0700 | [diff] [blame] | 107 | // name of the modules (if any) that produces the host executable. Leave empty for |
Colin Cross | 7d5136f | 2015-05-11 13:39:40 -0700 | [diff] [blame] | 108 | // prebuilts or scripts that do not need a module to build them. |
Colin Cross | 6f080df | 2016-11-04 15:32:58 -0700 | [diff] [blame] | 109 | Tools []string |
Dan Willemsen | f7f3d69 | 2016-04-20 14:54:32 -0700 | [diff] [blame] | 110 | |
| 111 | // Local file that is used as the tool |
Colin Cross | 27b922f | 2019-03-04 22:35:41 -0800 | [diff] [blame] | 112 | Tool_files []string `android:"path"` |
Colin Cross | 5ed99c6 | 2016-11-22 12:55:55 -0800 | [diff] [blame] | 113 | |
| 114 | // List of directories to export generated headers from |
| 115 | Export_include_dirs []string |
Colin Cross | 708c424 | 2017-01-13 18:05:49 -0800 | [diff] [blame] | 116 | |
| 117 | // list of input files |
Colin Cross | 27b922f | 2019-03-04 22:35:41 -0800 | [diff] [blame] | 118 | Srcs []string `android:"path,arch_variant"` |
Dan Willemsen | eefa026 | 2018-11-17 14:01:18 -0800 | [diff] [blame] | 119 | |
| 120 | // input files to exclude |
Colin Cross | 27b922f | 2019-03-04 22:35:41 -0800 | [diff] [blame] | 121 | Exclude_srcs []string `android:"path,arch_variant"` |
Colin Cross | 7d5136f | 2015-05-11 13:39:40 -0700 | [diff] [blame] | 122 | |
Jingwen Chen | 30f5aaa | 2020-11-19 05:38:02 -0500 | [diff] [blame] | 123 | // Properties for Bazel migration purposes. |
| 124 | bazel.Properties |
Chris Parsons | f3c96ef | 2020-09-29 02:23:17 -0400 | [diff] [blame] | 125 | } |
Alex Humesky | 29e3bbe | 2020-11-20 21:30:13 -0500 | [diff] [blame] | 126 | |
Dan Willemsen | 3e5bdf2 | 2017-09-13 18:37:08 -0700 | [diff] [blame] | 127 | type Module struct { |
Colin Cross | 635c3b0 | 2016-05-18 15:37:25 -0700 | [diff] [blame] | 128 | android.ModuleBase |
Jaewoong Jung | 98716bd | 2018-12-10 08:13:18 -0800 | [diff] [blame] | 129 | android.DefaultableModuleBase |
Jiyong Park | fc752ca | 2019-06-12 13:27:29 +0900 | [diff] [blame] | 130 | android.ApexModuleBase |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 131 | |
Dan Willemsen | 3e5bdf2 | 2017-09-13 18:37:08 -0700 | [diff] [blame] | 132 | // For other packages to make their own genrules with extra |
| 133 | // properties |
| 134 | Extra interface{} |
Colin Cross | 7228ecd | 2019-11-18 16:00:16 -0800 | [diff] [blame] | 135 | android.ImageInterface |
Dan Willemsen | 3e5bdf2 | 2017-09-13 18:37:08 -0700 | [diff] [blame] | 136 | |
Colin Cross | 7d5136f | 2015-05-11 13:39:40 -0700 | [diff] [blame] | 137 | properties generatorProperties |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 138 | |
Alex Humesky | 29e3bbe | 2020-11-20 21:30:13 -0500 | [diff] [blame] | 139 | // For the different tasks that genrule and gensrc generate. genrule will |
| 140 | // generate 1 task, and gensrc will generate 1 or more tasks based on the |
| 141 | // number of shards the input files are sharded into. |
Jeff Gaston | 437d23c | 2017-11-08 12:38:00 -0800 | [diff] [blame] | 142 | taskGenerator taskFunc |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 143 | |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 144 | rule blueprint.Rule |
| 145 | rawCommands []string |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 146 | |
Colin Cross | 5ed99c6 | 2016-11-22 12:55:55 -0800 | [diff] [blame] | 147 | exportedIncludeDirs android.Paths |
Dan Willemsen | b40aab6 | 2016-04-20 14:21:14 -0700 | [diff] [blame] | 148 | |
Colin Cross | 635c3b0 | 2016-05-18 15:37:25 -0700 | [diff] [blame] | 149 | outputFiles android.Paths |
Dan Willemsen | 9da9d49 | 2018-02-21 18:28:18 -0800 | [diff] [blame] | 150 | outputDeps android.Paths |
Colin Cross | a4ad2b0 | 2019-03-18 22:15:32 -0700 | [diff] [blame] | 151 | |
| 152 | subName string |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 153 | subDir string |
bralee | 1fbf440 | 2020-05-21 10:11:59 +0800 | [diff] [blame] | 154 | |
| 155 | // Collect the module directory for IDE info in java/jdeps.go. |
| 156 | modulePaths []string |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 157 | } |
| 158 | |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 159 | type taskFunc func(ctx android.ModuleContext, rawCommand string, srcFiles android.Paths) []generateTask |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 160 | |
| 161 | type generateTask struct { |
Colin Cross | 3ea4eb8 | 2020-11-24 13:07:27 -0800 | [diff] [blame] | 162 | in android.Paths |
| 163 | out android.WritablePaths |
| 164 | depFile android.WritablePath |
Alex Humesky | 29e3bbe | 2020-11-20 21:30:13 -0500 | [diff] [blame] | 165 | copyTo android.WritablePaths // For gensrcs to set on gensrcsMerge rule. |
Colin Cross | 3ea4eb8 | 2020-11-24 13:07:27 -0800 | [diff] [blame] | 166 | genDir android.WritablePath |
| 167 | extraTools android.Paths // dependencies on tools used by the generator |
| 168 | |
Alex Humesky | 29e3bbe | 2020-11-20 21:30:13 -0500 | [diff] [blame] | 169 | cmd string |
| 170 | // For gensrsc sharding. |
Colin Cross | 3ea4eb8 | 2020-11-24 13:07:27 -0800 | [diff] [blame] | 171 | shard int |
| 172 | shards int |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 173 | } |
| 174 | |
Dan Willemsen | 3e5bdf2 | 2017-09-13 18:37:08 -0700 | [diff] [blame] | 175 | func (g *Module) GeneratedSourceFiles() android.Paths { |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 176 | return g.outputFiles |
| 177 | } |
| 178 | |
Dan Willemsen | 3e5bdf2 | 2017-09-13 18:37:08 -0700 | [diff] [blame] | 179 | func (g *Module) Srcs() android.Paths { |
Nan Zhang | e42777a | 2018-03-27 16:19:42 -0700 | [diff] [blame] | 180 | return append(android.Paths{}, g.outputFiles...) |
Colin Cross | 068e0fe | 2016-12-13 15:23:47 -0800 | [diff] [blame] | 181 | } |
| 182 | |
Dan Willemsen | 3e5bdf2 | 2017-09-13 18:37:08 -0700 | [diff] [blame] | 183 | func (g *Module) GeneratedHeaderDirs() android.Paths { |
Colin Cross | 5ed99c6 | 2016-11-22 12:55:55 -0800 | [diff] [blame] | 184 | return g.exportedIncludeDirs |
Dan Willemsen | b40aab6 | 2016-04-20 14:21:14 -0700 | [diff] [blame] | 185 | } |
| 186 | |
Dan Willemsen | 9da9d49 | 2018-02-21 18:28:18 -0800 | [diff] [blame] | 187 | func (g *Module) GeneratedDeps() android.Paths { |
| 188 | return g.outputDeps |
| 189 | } |
| 190 | |
Martin Stjernholm | 710ec3a | 2020-01-16 15:12:04 +0000 | [diff] [blame] | 191 | func toolDepsMutator(ctx android.BottomUpMutatorContext) { |
Dan Willemsen | 3e5bdf2 | 2017-09-13 18:37:08 -0700 | [diff] [blame] | 192 | if g, ok := ctx.Module().(*Module); ok { |
Colin Cross | 08f15ab | 2018-10-04 23:29:14 -0700 | [diff] [blame] | 193 | for _, tool := range g.properties.Tools { |
| 194 | tag := hostToolDependencyTag{label: tool} |
| 195 | if m := android.SrcIsModule(tool); m != "" { |
| 196 | tool = m |
| 197 | } |
Colin Cross | 0f7d2ef | 2019-10-16 11:03:10 -0700 | [diff] [blame] | 198 | ctx.AddFarVariationDependencies(ctx.Config().BuildOSTarget.Variations(), tag, tool) |
Colin Cross | 6362e27 | 2015-10-29 15:25:03 -0700 | [diff] [blame] | 199 | } |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 200 | } |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 201 | } |
| 202 | |
Chris Parsons | f3c96ef | 2020-09-29 02:23:17 -0400 | [diff] [blame] | 203 | // Returns true if information was available from Bazel, false if bazel invocation still needs to occur. |
| 204 | func (c *Module) generateBazelBuildActions(ctx android.ModuleContext, label string) bool { |
| 205 | bazelCtx := ctx.Config().BazelContext |
| 206 | filePaths, ok := bazelCtx.GetAllFiles(label) |
| 207 | if ok { |
| 208 | var bazelOutputFiles android.Paths |
| 209 | for _, bazelOutputFile := range filePaths { |
Chris Parsons | dbcb1ff | 2020-12-10 17:19:18 -0500 | [diff] [blame] | 210 | bazelOutputFiles = append(bazelOutputFiles, android.PathForBazelOut(ctx, bazelOutputFile)) |
Chris Parsons | f3c96ef | 2020-09-29 02:23:17 -0400 | [diff] [blame] | 211 | } |
| 212 | c.outputFiles = bazelOutputFiles |
| 213 | c.outputDeps = bazelOutputFiles |
| 214 | } |
| 215 | return ok |
| 216 | } |
Colin Cross | f188596 | 2020-11-20 15:28:30 -0800 | [diff] [blame] | 217 | |
Dan Willemsen | 3e5bdf2 | 2017-09-13 18:37:08 -0700 | [diff] [blame] | 218 | func (g *Module) GenerateAndroidBuildActions(ctx android.ModuleContext) { |
Colin Cross | a4ad2b0 | 2019-03-18 22:15:32 -0700 | [diff] [blame] | 219 | g.subName = ctx.ModuleSubDir() |
| 220 | |
bralee | 1fbf440 | 2020-05-21 10:11:59 +0800 | [diff] [blame] | 221 | // Collect the module directory for IDE info in java/jdeps.go. |
| 222 | g.modulePaths = append(g.modulePaths, ctx.ModuleDir()) |
| 223 | |
Colin Cross | 5ed99c6 | 2016-11-22 12:55:55 -0800 | [diff] [blame] | 224 | if len(g.properties.Export_include_dirs) > 0 { |
| 225 | for _, dir := range g.properties.Export_include_dirs { |
| 226 | g.exportedIncludeDirs = append(g.exportedIncludeDirs, |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 227 | android.PathForModuleGen(ctx, g.subDir, ctx.ModuleDir(), dir)) |
Colin Cross | 5ed99c6 | 2016-11-22 12:55:55 -0800 | [diff] [blame] | 228 | } |
| 229 | } else { |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 230 | g.exportedIncludeDirs = append(g.exportedIncludeDirs, android.PathForModuleGen(ctx, g.subDir)) |
Colin Cross | 5ed99c6 | 2016-11-22 12:55:55 -0800 | [diff] [blame] | 231 | } |
Dan Willemsen | 3f4539b | 2016-09-28 16:19:10 -0700 | [diff] [blame] | 232 | |
Colin Cross | 08f15ab | 2018-10-04 23:29:14 -0700 | [diff] [blame] | 233 | locationLabels := map[string][]string{} |
| 234 | firstLabel := "" |
| 235 | |
| 236 | addLocationLabel := func(label string, paths []string) { |
| 237 | if firstLabel == "" { |
| 238 | firstLabel = label |
| 239 | } |
| 240 | if _, exists := locationLabels[label]; !exists { |
| 241 | locationLabels[label] = paths |
| 242 | } else { |
| 243 | ctx.ModuleErrorf("multiple labels for %q, %q and %q", |
| 244 | label, strings.Join(locationLabels[label], " "), strings.Join(paths, " ")) |
| 245 | } |
| 246 | } |
Dan Willemsen | 3f4539b | 2016-09-28 16:19:10 -0700 | [diff] [blame] | 247 | |
Colin Cross | ba9e403 | 2020-11-24 16:32:22 -0800 | [diff] [blame] | 248 | var tools android.Paths |
| 249 | var packagedTools []android.PackagingSpec |
Colin Cross | 6f080df | 2016-11-04 15:32:58 -0700 | [diff] [blame] | 250 | if len(g.properties.Tools) > 0 { |
Colin Cross | ba71a3f | 2019-03-18 12:12:48 -0700 | [diff] [blame] | 251 | seenTools := make(map[string]bool) |
| 252 | |
Colin Cross | 35143d0 | 2017-11-16 00:11:20 -0800 | [diff] [blame] | 253 | ctx.VisitDirectDepsBlueprint(func(module blueprint.Module) { |
Colin Cross | 08f15ab | 2018-10-04 23:29:14 -0700 | [diff] [blame] | 254 | switch tag := ctx.OtherModuleDependencyTag(module).(type) { |
| 255 | case hostToolDependencyTag: |
Dan Willemsen | d6ba0d5 | 2017-09-13 15:46:47 -0700 | [diff] [blame] | 256 | tool := ctx.OtherModuleName(module) |
| 257 | |
Colin Cross | ba9e403 | 2020-11-24 16:32:22 -0800 | [diff] [blame] | 258 | switch t := module.(type) { |
| 259 | case android.HostToolProvider: |
| 260 | // A HostToolProvider provides the path to a tool, which will be copied |
| 261 | // into the sandbox. |
Colin Cross | 35143d0 | 2017-11-16 00:11:20 -0800 | [diff] [blame] | 262 | if !t.(android.Module).Enabled() { |
Colin Cross | 6510f91 | 2017-11-29 00:27:14 -0800 | [diff] [blame] | 263 | if ctx.Config().AllowMissingDependencies() { |
Colin Cross | 35143d0 | 2017-11-16 00:11:20 -0800 | [diff] [blame] | 264 | ctx.AddMissingDependencies([]string{tool}) |
| 265 | } else { |
| 266 | ctx.ModuleErrorf("depends on disabled module %q", tool) |
| 267 | } |
Colin Cross | ba9e403 | 2020-11-24 16:32:22 -0800 | [diff] [blame] | 268 | return |
Colin Cross | 35143d0 | 2017-11-16 00:11:20 -0800 | [diff] [blame] | 269 | } |
Colin Cross | ba9e403 | 2020-11-24 16:32:22 -0800 | [diff] [blame] | 270 | path := t.HostToolPath() |
| 271 | if !path.Valid() { |
| 272 | ctx.ModuleErrorf("host tool %q missing output file", tool) |
| 273 | return |
| 274 | } |
| 275 | if specs := t.TransitivePackagingSpecs(); specs != nil { |
| 276 | // If the HostToolProvider has PackgingSpecs, which are definitions of the |
| 277 | // required relative locations of the tool and its dependencies, use those |
| 278 | // instead. They will be copied to those relative locations in the sbox |
| 279 | // sandbox. |
| 280 | packagedTools = append(packagedTools, specs...) |
| 281 | // Assume that the first PackagingSpec of the module is the tool. |
| 282 | addLocationLabel(tag.label, []string{android.SboxPathForPackagedTool(specs[0])}) |
| 283 | } else { |
| 284 | tools = append(tools, path.Path()) |
| 285 | addLocationLabel(tag.label, []string{android.SboxPathForTool(ctx, path.Path())}) |
| 286 | } |
| 287 | case bootstrap.GoBinaryTool: |
| 288 | // A GoBinaryTool provides the install path to a tool, which will be copied. |
Dan Willemsen | 8eded0a | 2017-09-13 16:07:44 -0700 | [diff] [blame] | 289 | if s, err := filepath.Rel(android.PathForOutput(ctx).String(), t.InstallPath()); err == nil { |
Colin Cross | ba9e403 | 2020-11-24 16:32:22 -0800 | [diff] [blame] | 290 | toolPath := android.PathForOutput(ctx, s) |
| 291 | tools = append(tools, toolPath) |
| 292 | addLocationLabel(tag.label, []string{android.SboxPathForTool(ctx, toolPath)}) |
Colin Cross | 6f080df | 2016-11-04 15:32:58 -0700 | [diff] [blame] | 293 | } else { |
Dan Willemsen | 8eded0a | 2017-09-13 16:07:44 -0700 | [diff] [blame] | 294 | ctx.ModuleErrorf("cannot find path for %q: %v", tool, err) |
Colin Cross | ba9e403 | 2020-11-24 16:32:22 -0800 | [diff] [blame] | 295 | return |
Colin Cross | 6f080df | 2016-11-04 15:32:58 -0700 | [diff] [blame] | 296 | } |
Colin Cross | ba9e403 | 2020-11-24 16:32:22 -0800 | [diff] [blame] | 297 | default: |
Dan Willemsen | d6ba0d5 | 2017-09-13 15:46:47 -0700 | [diff] [blame] | 298 | ctx.ModuleErrorf("%q is not a host tool provider", tool) |
Colin Cross | ba9e403 | 2020-11-24 16:32:22 -0800 | [diff] [blame] | 299 | return |
Dan Willemsen | 8eded0a | 2017-09-13 16:07:44 -0700 | [diff] [blame] | 300 | } |
| 301 | |
Colin Cross | ba9e403 | 2020-11-24 16:32:22 -0800 | [diff] [blame] | 302 | seenTools[tag.label] = true |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 303 | } |
Dan Willemsen | f7f3d69 | 2016-04-20 14:54:32 -0700 | [diff] [blame] | 304 | }) |
Colin Cross | ba71a3f | 2019-03-18 12:12:48 -0700 | [diff] [blame] | 305 | |
| 306 | // If AllowMissingDependencies is enabled, the build will not have stopped when |
| 307 | // AddFarVariationDependencies was called on a missing tool, which will result in nonsensical |
Liz Kammer | 20ebfb4 | 2020-07-28 11:32:07 -0700 | [diff] [blame] | 308 | // "cmd: unknown location label ..." errors later. Add a placeholder file to the local label. |
| 309 | // The command that uses this placeholder file will never be executed because the rule will be |
| 310 | // replaced with an android.Error rule reporting the missing dependencies. |
Colin Cross | ba71a3f | 2019-03-18 12:12:48 -0700 | [diff] [blame] | 311 | if ctx.Config().AllowMissingDependencies() { |
| 312 | for _, tool := range g.properties.Tools { |
| 313 | if !seenTools[tool] { |
| 314 | addLocationLabel(tool, []string{"***missing tool " + tool + "***"}) |
| 315 | } |
| 316 | } |
| 317 | } |
Dan Willemsen | f7f3d69 | 2016-04-20 14:54:32 -0700 | [diff] [blame] | 318 | } |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 319 | |
Dan Willemsen | d6ba0d5 | 2017-09-13 15:46:47 -0700 | [diff] [blame] | 320 | if ctx.Failed() { |
| 321 | return |
| 322 | } |
| 323 | |
Colin Cross | 08f15ab | 2018-10-04 23:29:14 -0700 | [diff] [blame] | 324 | for _, toolFile := range g.properties.Tool_files { |
Colin Cross | 8a49795 | 2019-03-05 22:25:09 -0800 | [diff] [blame] | 325 | paths := android.PathsForModuleSrc(ctx, []string{toolFile}) |
Colin Cross | ba9e403 | 2020-11-24 16:32:22 -0800 | [diff] [blame] | 326 | tools = append(tools, paths...) |
| 327 | var sandboxPaths []string |
| 328 | for _, path := range paths { |
| 329 | sandboxPaths = append(sandboxPaths, android.SboxPathForTool(ctx, path)) |
| 330 | } |
| 331 | addLocationLabel(toolFile, sandboxPaths) |
Colin Cross | 08f15ab | 2018-10-04 23:29:14 -0700 | [diff] [blame] | 332 | } |
| 333 | |
| 334 | var srcFiles android.Paths |
| 335 | for _, in := range g.properties.Srcs { |
Colin Cross | ba71a3f | 2019-03-18 12:12:48 -0700 | [diff] [blame] | 336 | paths, missingDeps := android.PathsAndMissingDepsForModuleSrcExcludes(ctx, []string{in}, g.properties.Exclude_srcs) |
| 337 | if len(missingDeps) > 0 { |
| 338 | if !ctx.Config().AllowMissingDependencies() { |
| 339 | panic(fmt.Errorf("should never get here, the missing dependencies %q should have been reported in DepsMutator", |
| 340 | missingDeps)) |
| 341 | } |
| 342 | |
| 343 | // If AllowMissingDependencies is enabled, the build will not have stopped when |
| 344 | // the dependency was added on a missing SourceFileProducer module, which will result in nonsensical |
Liz Kammer | 20ebfb4 | 2020-07-28 11:32:07 -0700 | [diff] [blame] | 345 | // "cmd: label ":..." has no files" errors later. Add a placeholder file to the local label. |
| 346 | // The command that uses this placeholder file will never be executed because the rule will be |
| 347 | // replaced with an android.Error rule reporting the missing dependencies. |
Colin Cross | ba71a3f | 2019-03-18 12:12:48 -0700 | [diff] [blame] | 348 | ctx.AddMissingDependencies(missingDeps) |
| 349 | addLocationLabel(in, []string{"***missing srcs " + in + "***"}) |
| 350 | } else { |
| 351 | srcFiles = append(srcFiles, paths...) |
| 352 | addLocationLabel(in, paths.Strings()) |
| 353 | } |
Colin Cross | 08f15ab | 2018-10-04 23:29:14 -0700 | [diff] [blame] | 354 | } |
| 355 | |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 356 | var copyFrom android.Paths |
| 357 | var outputFiles android.WritablePaths |
| 358 | var zipArgs strings.Builder |
Colin Cross | 08f15ab | 2018-10-04 23:29:14 -0700 | [diff] [blame] | 359 | |
Alex Humesky | 29e3bbe | 2020-11-20 21:30:13 -0500 | [diff] [blame] | 360 | // Generate tasks, either from genrule or gensrcs. |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 361 | for _, task := range g.taskGenerator(ctx, String(g.properties.Cmd), srcFiles) { |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 362 | if len(task.out) == 0 { |
| 363 | ctx.ModuleErrorf("must have at least one output file") |
| 364 | return |
Colin Cross | 85a2e89 | 2018-07-09 09:45:06 -0700 | [diff] [blame] | 365 | } |
| 366 | |
Colin Cross | f1a035e | 2020-11-16 17:32:30 -0800 | [diff] [blame] | 367 | // Pick a unique path outside the task.genDir for the sbox manifest textproto, |
| 368 | // a unique rule name, and the user-visible description. |
| 369 | manifestName := "genrule.sbox.textproto" |
| 370 | desc := "generate" |
| 371 | name := "generator" |
| 372 | if task.shards > 0 { |
| 373 | manifestName = "genrule_" + strconv.Itoa(task.shard) + ".sbox.textproto" |
| 374 | desc += " " + strconv.Itoa(task.shard) |
| 375 | name += strconv.Itoa(task.shard) |
| 376 | } else if len(task.out) == 1 { |
| 377 | desc += " " + task.out[0].Base() |
| 378 | } |
| 379 | |
| 380 | manifestPath := android.PathForModuleOut(ctx, manifestName) |
| 381 | |
| 382 | // Use a RuleBuilder to create a rule that runs the command inside an sbox sandbox. |
Colin Cross | ba9e403 | 2020-11-24 16:32:22 -0800 | [diff] [blame] | 383 | rule := android.NewRuleBuilder(pctx, ctx).Sbox(task.genDir, manifestPath).SandboxTools() |
Colin Cross | f1a035e | 2020-11-16 17:32:30 -0800 | [diff] [blame] | 384 | cmd := rule.Command() |
| 385 | |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 386 | for _, out := range task.out { |
Colin Cross | f1a035e | 2020-11-16 17:32:30 -0800 | [diff] [blame] | 387 | addLocationLabel(out.Rel(), []string{cmd.PathForOutput(out)}) |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 388 | } |
| 389 | |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 390 | referencedDepfile := false |
| 391 | |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 392 | rawCommand, err := android.Expand(task.cmd, func(name string) (string, error) { |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 393 | // report the error directly without returning an error to android.Expand to catch multiple errors in a |
| 394 | // single run |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 395 | reportError := func(fmt string, args ...interface{}) (string, error) { |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 396 | ctx.PropertyErrorf("cmd", fmt, args...) |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 397 | return "SOONG_ERROR", nil |
Colin Cross | 6f080df | 2016-11-04 15:32:58 -0700 | [diff] [blame] | 398 | } |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 399 | |
| 400 | switch name { |
| 401 | case "location": |
| 402 | if len(g.properties.Tools) == 0 && len(g.properties.Tool_files) == 0 { |
| 403 | return reportError("at least one `tools` or `tool_files` is required if $(location) is used") |
Colin Cross | 6f080df | 2016-11-04 15:32:58 -0700 | [diff] [blame] | 404 | } |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 405 | paths := locationLabels[firstLabel] |
| 406 | if len(paths) == 0 { |
| 407 | return reportError("default label %q has no files", firstLabel) |
| 408 | } else if len(paths) > 1 { |
| 409 | return reportError("default label %q has multiple files, use $(locations %s) to reference it", |
| 410 | firstLabel, firstLabel) |
Colin Cross | 08f15ab | 2018-10-04 23:29:14 -0700 | [diff] [blame] | 411 | } |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 412 | return locationLabels[firstLabel][0], nil |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 413 | case "in": |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 414 | return strings.Join(srcFiles.Strings(), " "), nil |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 415 | case "out": |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 416 | var sandboxOuts []string |
| 417 | for _, out := range task.out { |
Colin Cross | f1a035e | 2020-11-16 17:32:30 -0800 | [diff] [blame] | 418 | sandboxOuts = append(sandboxOuts, cmd.PathForOutput(out)) |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 419 | } |
| 420 | return strings.Join(sandboxOuts, " "), nil |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 421 | case "depfile": |
| 422 | referencedDepfile = true |
| 423 | if !Bool(g.properties.Depfile) { |
| 424 | return reportError("$(depfile) used without depfile property") |
| 425 | } |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 426 | return "__SBOX_DEPFILE__", nil |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 427 | case "genDir": |
Colin Cross | f1a035e | 2020-11-16 17:32:30 -0800 | [diff] [blame] | 428 | return cmd.PathForOutput(task.genDir), nil |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 429 | default: |
| 430 | if strings.HasPrefix(name, "location ") { |
| 431 | label := strings.TrimSpace(strings.TrimPrefix(name, "location ")) |
| 432 | if paths, ok := locationLabels[label]; ok { |
| 433 | if len(paths) == 0 { |
| 434 | return reportError("label %q has no files", label) |
| 435 | } else if len(paths) > 1 { |
| 436 | return reportError("label %q has multiple files, use $(locations %s) to reference it", |
| 437 | label, label) |
| 438 | } |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 439 | return paths[0], nil |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 440 | } else { |
| 441 | return reportError("unknown location label %q", label) |
| 442 | } |
| 443 | } else if strings.HasPrefix(name, "locations ") { |
| 444 | label := strings.TrimSpace(strings.TrimPrefix(name, "locations ")) |
| 445 | if paths, ok := locationLabels[label]; ok { |
| 446 | if len(paths) == 0 { |
| 447 | return reportError("label %q has no files", label) |
| 448 | } |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 449 | return strings.Join(paths, " "), nil |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 450 | } else { |
| 451 | return reportError("unknown locations label %q", label) |
| 452 | } |
| 453 | } else { |
| 454 | return reportError("unknown variable '$(%s)'", name) |
| 455 | } |
Colin Cross | 6f080df | 2016-11-04 15:32:58 -0700 | [diff] [blame] | 456 | } |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 457 | }) |
| 458 | |
| 459 | if err != nil { |
| 460 | ctx.PropertyErrorf("cmd", "%s", err.Error()) |
| 461 | return |
Colin Cross | 6f080df | 2016-11-04 15:32:58 -0700 | [diff] [blame] | 462 | } |
Colin Cross | 6f080df | 2016-11-04 15:32:58 -0700 | [diff] [blame] | 463 | |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 464 | if Bool(g.properties.Depfile) && !referencedDepfile { |
| 465 | ctx.PropertyErrorf("cmd", "specified depfile=true but did not include a reference to '${depfile}' in cmd") |
| 466 | return |
| 467 | } |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 468 | g.rawCommands = append(g.rawCommands, rawCommand) |
Bill Peckham | c087be1 | 2020-02-13 15:55:10 -0800 | [diff] [blame] | 469 | |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 470 | cmd.Text(rawCommand) |
| 471 | cmd.ImplicitOutputs(task.out) |
| 472 | cmd.Implicits(task.in) |
Colin Cross | ba9e403 | 2020-11-24 16:32:22 -0800 | [diff] [blame] | 473 | cmd.ImplicitTools(tools) |
| 474 | cmd.ImplicitTools(task.extraTools) |
| 475 | cmd.ImplicitPackagedTools(packagedTools) |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 476 | if Bool(g.properties.Depfile) { |
| 477 | cmd.ImplicitDepFile(task.depFile) |
| 478 | } |
| 479 | |
| 480 | // Create the rule to run the genrule command inside sbox. |
Colin Cross | f1a035e | 2020-11-16 17:32:30 -0800 | [diff] [blame] | 481 | rule.Build(name, desc) |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 482 | |
| 483 | if len(task.copyTo) > 0 { |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 484 | // If copyTo is set, multiple shards need to be copied into a single directory. |
| 485 | // task.out contains the per-shard paths, and copyTo contains the corresponding |
| 486 | // final path. The files need to be copied into the final directory by a |
| 487 | // single rule so it can remove the directory before it starts to ensure no |
| 488 | // old files remain. zipsync already does this, so build up zipArgs that |
| 489 | // zip all the per-shard directories into a single zip. |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 490 | outputFiles = append(outputFiles, task.copyTo...) |
| 491 | copyFrom = append(copyFrom, task.out.Paths()...) |
| 492 | zipArgs.WriteString(" -C " + task.genDir.String()) |
| 493 | zipArgs.WriteString(android.JoinWithPrefix(task.out.Strings(), " -f ")) |
| 494 | } else { |
| 495 | outputFiles = append(outputFiles, task.out...) |
| 496 | } |
Colin Cross | 6f080df | 2016-11-04 15:32:58 -0700 | [diff] [blame] | 497 | } |
| 498 | |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 499 | if len(copyFrom) > 0 { |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 500 | // Create a rule that zips all the per-shard directories into a single zip and then |
| 501 | // uses zipsync to unzip it into the final directory. |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 502 | ctx.Build(pctx, android.BuildParams{ |
Colin Cross | f188596 | 2020-11-20 15:28:30 -0800 | [diff] [blame] | 503 | Rule: gensrcsMerge, |
| 504 | Implicits: copyFrom, |
| 505 | Outputs: outputFiles, |
| 506 | Description: "merge shards", |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 507 | Args: map[string]string{ |
| 508 | "zipArgs": zipArgs.String(), |
| 509 | "tmpZip": android.PathForModuleGen(ctx, g.subDir+".zip").String(), |
| 510 | "genDir": android.PathForModuleGen(ctx, g.subDir).String(), |
| 511 | }, |
| 512 | }) |
Colin Cross | 85a2e89 | 2018-07-09 09:45:06 -0700 | [diff] [blame] | 513 | } |
| 514 | |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 515 | g.outputFiles = outputFiles.Paths() |
Jeff Gaston | efc1b41 | 2017-03-29 17:29:06 -0700 | [diff] [blame] | 516 | |
Chris Parsons | aa8be05 | 2020-10-14 16:22:37 -0400 | [diff] [blame] | 517 | bazelModuleLabel := g.properties.Bazel_module.Label |
Chris Parsons | f3c96ef | 2020-09-29 02:23:17 -0400 | [diff] [blame] | 518 | bazelActionsUsed := false |
| 519 | if ctx.Config().BazelContext.BazelEnabled() && len(bazelModuleLabel) > 0 { |
| 520 | bazelActionsUsed = g.generateBazelBuildActions(ctx, bazelModuleLabel) |
Jeff Gaston | 02a684b | 2017-10-27 14:59:27 -0700 | [diff] [blame] | 521 | } |
Chris Parsons | f3c96ef | 2020-09-29 02:23:17 -0400 | [diff] [blame] | 522 | if !bazelActionsUsed { |
| 523 | // For <= 6 outputs, just embed those directly in the users. Right now, that covers >90% of |
| 524 | // the genrules on AOSP. That will make things simpler to look at the graph in the common |
| 525 | // case. For larger sets of outputs, inject a phony target in between to limit ninja file |
| 526 | // growth. |
| 527 | if len(g.outputFiles) <= 6 { |
| 528 | g.outputDeps = g.outputFiles |
| 529 | } else { |
| 530 | phonyFile := android.PathForModuleGen(ctx, "genrule-phony") |
| 531 | ctx.Build(pctx, android.BuildParams{ |
| 532 | Rule: blueprint.Phony, |
| 533 | Output: phonyFile, |
| 534 | Inputs: g.outputFiles, |
| 535 | }) |
| 536 | g.outputDeps = android.Paths{phonyFile} |
| 537 | } |
| 538 | } |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 539 | } |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 540 | |
Brandon Lee | 5d45c6f | 2018-08-15 15:35:38 -0700 | [diff] [blame] | 541 | // Collect information for opening IDE project files in java/jdeps.go. |
| 542 | func (g *Module) IDEInfo(dpInfo *android.IdeInfo) { |
| 543 | dpInfo.Srcs = append(dpInfo.Srcs, g.Srcs().Strings()...) |
| 544 | for _, src := range g.properties.Srcs { |
| 545 | if strings.HasPrefix(src, ":") { |
| 546 | src = strings.Trim(src, ":") |
| 547 | dpInfo.Deps = append(dpInfo.Deps, src) |
| 548 | } |
| 549 | } |
bralee | 1fbf440 | 2020-05-21 10:11:59 +0800 | [diff] [blame] | 550 | dpInfo.Paths = append(dpInfo.Paths, g.modulePaths...) |
Brandon Lee | 5d45c6f | 2018-08-15 15:35:38 -0700 | [diff] [blame] | 551 | } |
| 552 | |
Colin Cross | a4ad2b0 | 2019-03-18 22:15:32 -0700 | [diff] [blame] | 553 | func (g *Module) AndroidMk() android.AndroidMkData { |
| 554 | return android.AndroidMkData{ |
Anton Hansson | 72f1849 | 2020-10-30 16:34:45 +0000 | [diff] [blame] | 555 | Class: "ETC", |
Colin Cross | a4ad2b0 | 2019-03-18 22:15:32 -0700 | [diff] [blame] | 556 | OutputFile: android.OptionalPathForPath(g.outputFiles[0]), |
| 557 | SubName: g.subName, |
| 558 | Extra: []android.AndroidMkExtraFunc{ |
| 559 | func(w io.Writer, outputFile android.Path) { |
Anton Hansson | 72f1849 | 2020-10-30 16:34:45 +0000 | [diff] [blame] | 560 | fmt.Fprintln(w, "LOCAL_UNINSTALLABLE_MODULE := true") |
Colin Cross | a4ad2b0 | 2019-03-18 22:15:32 -0700 | [diff] [blame] | 561 | }, |
| 562 | }, |
| 563 | Custom: func(w io.Writer, name, prefix, moduleDir string, data android.AndroidMkData) { |
| 564 | android.WriteAndroidMkData(w, data) |
| 565 | if data.SubName != "" { |
| 566 | fmt.Fprintln(w, ".PHONY:", name) |
| 567 | fmt.Fprintln(w, name, ":", name+g.subName) |
| 568 | } |
| 569 | }, |
| 570 | } |
| 571 | } |
| 572 | |
Jiyong Park | 45bf82e | 2020-12-15 22:29:02 +0900 | [diff] [blame] | 573 | var _ android.ApexModule = (*Module)(nil) |
| 574 | |
| 575 | // Implements android.ApexModule |
Dan Albert | c806053 | 2020-07-22 22:32:17 -0700 | [diff] [blame] | 576 | func (g *Module) ShouldSupportSdkVersion(ctx android.BaseModuleContext, |
| 577 | sdkVersion android.ApiLevel) error { |
Jooyung Han | 749dc69 | 2020-04-15 11:03:39 +0900 | [diff] [blame] | 578 | // Because generated outputs are checked by client modules(e.g. cc_library, ...) |
| 579 | // we can safely ignore the check here. |
| 580 | return nil |
| 581 | } |
| 582 | |
Jeff Gaston | 437d23c | 2017-11-08 12:38:00 -0800 | [diff] [blame] | 583 | func generatorFactory(taskGenerator taskFunc, props ...interface{}) *Module { |
Dan Willemsen | 3e5bdf2 | 2017-09-13 18:37:08 -0700 | [diff] [blame] | 584 | module := &Module{ |
Jeff Gaston | 437d23c | 2017-11-08 12:38:00 -0800 | [diff] [blame] | 585 | taskGenerator: taskGenerator, |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 586 | } |
| 587 | |
Colin Cross | 3624285 | 2017-06-23 15:06:31 -0700 | [diff] [blame] | 588 | module.AddProperties(props...) |
| 589 | module.AddProperties(&module.properties) |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 590 | |
Colin Cross | 7228ecd | 2019-11-18 16:00:16 -0800 | [diff] [blame] | 591 | module.ImageInterface = noopImageInterface{} |
| 592 | |
Colin Cross | 3624285 | 2017-06-23 15:06:31 -0700 | [diff] [blame] | 593 | return module |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 594 | } |
| 595 | |
Colin Cross | 7228ecd | 2019-11-18 16:00:16 -0800 | [diff] [blame] | 596 | type noopImageInterface struct{} |
| 597 | |
| 598 | func (x noopImageInterface) ImageMutatorBegin(android.BaseModuleContext) {} |
| 599 | func (x noopImageInterface) CoreVariantNeeded(android.BaseModuleContext) bool { return false } |
Yifan Hong | 1b3348d | 2020-01-21 15:53:22 -0800 | [diff] [blame] | 600 | func (x noopImageInterface) RamdiskVariantNeeded(android.BaseModuleContext) bool { return false } |
Yifan Hong | 60e0cfb | 2020-10-21 15:17:56 -0700 | [diff] [blame] | 601 | func (x noopImageInterface) VendorRamdiskVariantNeeded(android.BaseModuleContext) bool { return false } |
Colin Cross | 7228ecd | 2019-11-18 16:00:16 -0800 | [diff] [blame] | 602 | func (x noopImageInterface) RecoveryVariantNeeded(android.BaseModuleContext) bool { return false } |
| 603 | func (x noopImageInterface) ExtraImageVariations(ctx android.BaseModuleContext) []string { return nil } |
| 604 | func (x noopImageInterface) SetImageVariation(ctx android.BaseModuleContext, variation string, module android.Module) { |
| 605 | } |
| 606 | |
Dan Willemsen | 3e5bdf2 | 2017-09-13 18:37:08 -0700 | [diff] [blame] | 607 | func NewGenSrcs() *Module { |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 608 | properties := &genSrcsProperties{} |
| 609 | |
Colin Cross | f188596 | 2020-11-20 15:28:30 -0800 | [diff] [blame] | 610 | // finalSubDir is the name of the subdirectory that output files will be generated into. |
| 611 | // It is used so that per-shard directories can be placed alongside it an then finally |
| 612 | // merged into it. |
| 613 | const finalSubDir = "gensrcs" |
| 614 | |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 615 | taskGenerator := func(ctx android.ModuleContext, rawCommand string, srcFiles android.Paths) []generateTask { |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 616 | shardSize := defaultShardSize |
| 617 | if s := properties.Shard_size; s != nil { |
| 618 | shardSize = int(*s) |
| 619 | } |
Jeff Gaston | 437d23c | 2017-11-08 12:38:00 -0800 | [diff] [blame] | 620 | |
Colin Cross | f188596 | 2020-11-20 15:28:30 -0800 | [diff] [blame] | 621 | // gensrcs rules can easily hit command line limits by repeating the command for |
| 622 | // every input file. Shard the input files into groups. |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 623 | shards := android.ShardPaths(srcFiles, shardSize) |
| 624 | var generateTasks []generateTask |
Colin Cross | baccf5b | 2018-02-21 14:07:48 -0800 | [diff] [blame] | 625 | |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 626 | for i, shard := range shards { |
| 627 | var commands []string |
| 628 | var outFiles android.WritablePaths |
Colin Cross | 3ea4eb8 | 2020-11-24 13:07:27 -0800 | [diff] [blame] | 629 | var commandDepFiles []string |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 630 | var copyTo android.WritablePaths |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 631 | |
Colin Cross | f188596 | 2020-11-20 15:28:30 -0800 | [diff] [blame] | 632 | // When sharding is enabled (i.e. len(shards) > 1), the sbox rules for each |
| 633 | // shard will be write to their own directories and then be merged together |
| 634 | // into finalSubDir. If sharding is not enabled (i.e. len(shards) == 1), |
| 635 | // the sbox rule will write directly to finalSubDir. |
| 636 | genSubDir := finalSubDir |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 637 | if len(shards) > 1 { |
Colin Cross | f188596 | 2020-11-20 15:28:30 -0800 | [diff] [blame] | 638 | genSubDir = strconv.Itoa(i) |
Jeff Gaston | 437d23c | 2017-11-08 12:38:00 -0800 | [diff] [blame] | 639 | } |
| 640 | |
Colin Cross | f188596 | 2020-11-20 15:28:30 -0800 | [diff] [blame] | 641 | genDir := android.PathForModuleGen(ctx, genSubDir) |
Colin Cross | f1a035e | 2020-11-16 17:32:30 -0800 | [diff] [blame] | 642 | // TODO(ccross): this RuleBuilder is a hack to be able to call |
| 643 | // rule.Command().PathForOutput. Replace this with passing the rule into the |
| 644 | // generator. |
Colin Cross | ba9e403 | 2020-11-24 16:32:22 -0800 | [diff] [blame] | 645 | rule := android.NewRuleBuilder(pctx, ctx).Sbox(genDir, nil).SandboxTools() |
Jeff Gaston | 437d23c | 2017-11-08 12:38:00 -0800 | [diff] [blame] | 646 | |
Colin Cross | 3ea4eb8 | 2020-11-24 13:07:27 -0800 | [diff] [blame] | 647 | for _, in := range shard { |
Colin Cross | f188596 | 2020-11-20 15:28:30 -0800 | [diff] [blame] | 648 | outFile := android.GenPathWithExt(ctx, finalSubDir, in, String(properties.Output_extension)) |
| 649 | |
| 650 | // If sharding is enabled, then outFile is the path to the output file in |
| 651 | // the shard directory, and copyTo is the path to the output file in the |
| 652 | // final directory. |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 653 | if len(shards) > 1 { |
Colin Cross | f188596 | 2020-11-20 15:28:30 -0800 | [diff] [blame] | 654 | shardFile := android.GenPathWithExt(ctx, genSubDir, in, String(properties.Output_extension)) |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 655 | copyTo = append(copyTo, outFile) |
| 656 | outFile = shardFile |
| 657 | } |
| 658 | |
| 659 | outFiles = append(outFiles, outFile) |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 660 | |
Colin Cross | f188596 | 2020-11-20 15:28:30 -0800 | [diff] [blame] | 661 | // pre-expand the command line to replace $in and $out with references to |
| 662 | // a single input and output file. |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 663 | command, err := android.Expand(rawCommand, func(name string) (string, error) { |
| 664 | switch name { |
| 665 | case "in": |
| 666 | return in.String(), nil |
| 667 | case "out": |
Colin Cross | f1a035e | 2020-11-16 17:32:30 -0800 | [diff] [blame] | 668 | return rule.Command().PathForOutput(outFile), nil |
Colin Cross | 3ea4eb8 | 2020-11-24 13:07:27 -0800 | [diff] [blame] | 669 | case "depfile": |
| 670 | // Generate a depfile for each output file. Store the list for |
| 671 | // later in order to combine them all into a single depfile. |
Colin Cross | f1a035e | 2020-11-16 17:32:30 -0800 | [diff] [blame] | 672 | depFile := rule.Command().PathForOutput(outFile.ReplaceExtension(ctx, "d")) |
Colin Cross | 3ea4eb8 | 2020-11-24 13:07:27 -0800 | [diff] [blame] | 673 | commandDepFiles = append(commandDepFiles, depFile) |
| 674 | return depFile, nil |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 675 | default: |
| 676 | return "$(" + name + ")", nil |
| 677 | } |
| 678 | }) |
| 679 | if err != nil { |
| 680 | ctx.PropertyErrorf("cmd", err.Error()) |
| 681 | } |
| 682 | |
| 683 | // escape the command in case for example it contains '#', an odd number of '"', etc |
| 684 | command = fmt.Sprintf("bash -c %v", proptools.ShellEscape(command)) |
| 685 | commands = append(commands, command) |
| 686 | } |
| 687 | fullCommand := strings.Join(commands, " && ") |
| 688 | |
Colin Cross | 3ea4eb8 | 2020-11-24 13:07:27 -0800 | [diff] [blame] | 689 | var outputDepfile android.WritablePath |
| 690 | var extraTools android.Paths |
| 691 | if len(commandDepFiles) > 0 { |
| 692 | // Each command wrote to a depfile, but ninja can only handle one |
| 693 | // depfile per rule. Use the dep_fixer tool at the end of the |
| 694 | // command to combine all the depfiles into a single output depfile. |
| 695 | outputDepfile = android.PathForModuleGen(ctx, genSubDir, "gensrcs.d") |
| 696 | depFixerTool := ctx.Config().HostToolPath(ctx, "dep_fixer") |
| 697 | fullCommand += fmt.Sprintf(" && %s -o $(depfile) %s", |
Colin Cross | ba9e403 | 2020-11-24 16:32:22 -0800 | [diff] [blame] | 698 | android.SboxPathForTool(ctx, depFixerTool), |
| 699 | strings.Join(commandDepFiles, " ")) |
Colin Cross | 3ea4eb8 | 2020-11-24 13:07:27 -0800 | [diff] [blame] | 700 | extraTools = append(extraTools, depFixerTool) |
| 701 | } |
| 702 | |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 703 | generateTasks = append(generateTasks, generateTask{ |
Colin Cross | 3ea4eb8 | 2020-11-24 13:07:27 -0800 | [diff] [blame] | 704 | in: shard, |
| 705 | out: outFiles, |
| 706 | depFile: outputDepfile, |
| 707 | copyTo: copyTo, |
| 708 | genDir: genDir, |
| 709 | cmd: fullCommand, |
| 710 | shard: i, |
| 711 | shards: len(shards), |
| 712 | extraTools: extraTools, |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 713 | }) |
Jeff Gaston | 437d23c | 2017-11-08 12:38:00 -0800 | [diff] [blame] | 714 | } |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 715 | |
| 716 | return generateTasks |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 717 | } |
| 718 | |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 719 | g := generatorFactory(taskGenerator, properties) |
Colin Cross | f188596 | 2020-11-20 15:28:30 -0800 | [diff] [blame] | 720 | g.subDir = finalSubDir |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 721 | return g |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 722 | } |
| 723 | |
Colin Cross | 54190b3 | 2017-10-09 15:34:10 -0700 | [diff] [blame] | 724 | func GenSrcsFactory() android.Module { |
Dan Willemsen | 3e5bdf2 | 2017-09-13 18:37:08 -0700 | [diff] [blame] | 725 | m := NewGenSrcs() |
| 726 | android.InitAndroidModule(m) |
| 727 | return m |
| 728 | } |
| 729 | |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 730 | type genSrcsProperties struct { |
Colin Cross | 7d5136f | 2015-05-11 13:39:40 -0700 | [diff] [blame] | 731 | // extension that will be substituted for each output file |
Nan Zhang | a5e7cb4 | 2017-11-09 22:42:32 -0800 | [diff] [blame] | 732 | Output_extension *string |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 733 | |
| 734 | // maximum number of files that will be passed on a single command line. |
| 735 | Shard_size *int64 |
Colin Cross | 5049f02 | 2015-03-18 13:28:46 -0700 | [diff] [blame] | 736 | } |
| 737 | |
Evgenii Stepanov | f47c90d | 2020-12-02 18:55:09 -0800 | [diff] [blame] | 738 | const defaultShardSize = 50 |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 739 | |
Dan Willemsen | 3e5bdf2 | 2017-09-13 18:37:08 -0700 | [diff] [blame] | 740 | func NewGenRule() *Module { |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 741 | properties := &genRuleProperties{} |
Colin Cross | 5049f02 | 2015-03-18 13:28:46 -0700 | [diff] [blame] | 742 | |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 743 | taskGenerator := func(ctx android.ModuleContext, rawCommand string, srcFiles android.Paths) []generateTask { |
Dan Willemsen | 9c8681f | 2016-09-28 16:21:00 -0700 | [diff] [blame] | 744 | outs := make(android.WritablePaths, len(properties.Out)) |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 745 | var depFile android.WritablePath |
Dan Willemsen | 9c8681f | 2016-09-28 16:21:00 -0700 | [diff] [blame] | 746 | for i, out := range properties.Out { |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 747 | outPath := android.PathForModuleGen(ctx, out) |
| 748 | if i == 0 { |
| 749 | depFile = outPath.ReplaceExtension(ctx, "d") |
| 750 | } |
| 751 | outs[i] = outPath |
Dan Willemsen | 9c8681f | 2016-09-28 16:21:00 -0700 | [diff] [blame] | 752 | } |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 753 | return []generateTask{{ |
Colin Cross | 3d68051 | 2020-11-13 16:23:53 -0800 | [diff] [blame] | 754 | in: srcFiles, |
| 755 | out: outs, |
| 756 | depFile: depFile, |
| 757 | genDir: android.PathForModuleGen(ctx), |
| 758 | cmd: rawCommand, |
Colin Cross | 1a52768 | 2019-09-23 15:55:30 -0700 | [diff] [blame] | 759 | }} |
Colin Cross | 5049f02 | 2015-03-18 13:28:46 -0700 | [diff] [blame] | 760 | } |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 761 | |
Jeff Gaston | 437d23c | 2017-11-08 12:38:00 -0800 | [diff] [blame] | 762 | return generatorFactory(taskGenerator, properties) |
Colin Cross | 5049f02 | 2015-03-18 13:28:46 -0700 | [diff] [blame] | 763 | } |
| 764 | |
Colin Cross | 54190b3 | 2017-10-09 15:34:10 -0700 | [diff] [blame] | 765 | func GenRuleFactory() android.Module { |
Dan Willemsen | 3e5bdf2 | 2017-09-13 18:37:08 -0700 | [diff] [blame] | 766 | m := NewGenRule() |
| 767 | android.InitAndroidModule(m) |
Jaewoong Jung | 98716bd | 2018-12-10 08:13:18 -0800 | [diff] [blame] | 768 | android.InitDefaultableModule(m) |
Dan Willemsen | 3e5bdf2 | 2017-09-13 18:37:08 -0700 | [diff] [blame] | 769 | return m |
| 770 | } |
| 771 | |
Colin Cross | d350ecd | 2015-04-28 13:25:36 -0700 | [diff] [blame] | 772 | type genRuleProperties struct { |
Dan Willemsen | 9c8681f | 2016-09-28 16:21:00 -0700 | [diff] [blame] | 773 | // names of the output files that will be generated |
Colin Cross | ef35448 | 2018-10-23 11:27:50 -0700 | [diff] [blame] | 774 | Out []string `android:"arch_variant"` |
Colin Cross | 5049f02 | 2015-03-18 13:28:46 -0700 | [diff] [blame] | 775 | } |
Nan Zhang | ea568a4 | 2017-11-08 21:20:04 -0800 | [diff] [blame] | 776 | |
Jingwen Chen | 316e07c | 2020-12-14 09:09:52 -0500 | [diff] [blame] | 777 | type bazelGenruleAttributes struct { |
| 778 | Name *string |
| 779 | Srcs []string |
| 780 | Outs []string |
| 781 | Tools []string |
| 782 | Cmd string |
| 783 | } |
| 784 | |
| 785 | type bazelGenrule struct { |
| 786 | android.BazelTargetModuleBase |
| 787 | bazelGenruleAttributes |
| 788 | } |
| 789 | |
| 790 | func BazelGenruleFactory() android.Module { |
| 791 | module := &bazelGenrule{} |
| 792 | module.AddProperties(&module.bazelGenruleAttributes) |
| 793 | android.InitBazelTargetModule(module) |
| 794 | return module |
| 795 | } |
| 796 | |
Jingwen Chen | a42d641 | 2021-01-26 21:57:27 -0500 | [diff] [blame^] | 797 | func GenruleBp2Build(ctx android.TopDownMutatorContext) { |
Jingwen Chen | 316e07c | 2020-12-14 09:09:52 -0500 | [diff] [blame] | 798 | if m, ok := ctx.Module().(*Module); ok { |
| 799 | name := "__bp2build__" + m.Name() |
Jingwen Chen | 885ee7a | 2021-01-26 03:16:49 -0500 | [diff] [blame] | 800 | // Bazel only has the "tools" attribute. |
| 801 | tools := append(m.properties.Tools, m.properties.Tool_files...) |
| 802 | |
Jingwen Chen | 316e07c | 2020-12-14 09:09:52 -0500 | [diff] [blame] | 803 | // Replace in and out variables with $< and $@ |
| 804 | var cmd string |
| 805 | if m.properties.Cmd != nil { |
| 806 | cmd = strings.Replace(*m.properties.Cmd, "$(in)", "$(SRCS)", -1) |
| 807 | cmd = strings.Replace(cmd, "$(out)", "$(OUTS)", -1) |
| 808 | cmd = strings.Replace(cmd, "$(genDir)", "$(GENDIR)", -1) |
Jingwen Chen | 885ee7a | 2021-01-26 03:16:49 -0500 | [diff] [blame] | 809 | if len(tools) > 0 { |
| 810 | cmd = strings.Replace(cmd, "$(location)", fmt.Sprintf("$(location %s)", tools[0]), -1) |
| 811 | cmd = strings.Replace(cmd, "$(locations)", fmt.Sprintf("$(locations %s)", tools[0]), -1) |
| 812 | } |
Jingwen Chen | 316e07c | 2020-12-14 09:09:52 -0500 | [diff] [blame] | 813 | } |
| 814 | |
| 815 | // The Out prop is not in an immediately accessible field |
| 816 | // in the Module struct, so use GetProperties and cast it |
| 817 | // to the known struct prop. |
| 818 | var outs []string |
| 819 | for _, propIntf := range m.GetProperties() { |
| 820 | if props, ok := propIntf.(*genRuleProperties); ok { |
| 821 | outs = props.Out |
| 822 | break |
| 823 | } |
| 824 | } |
| 825 | |
Jingwen Chen | 316e07c | 2020-12-14 09:09:52 -0500 | [diff] [blame] | 826 | // Create the BazelTargetModule. |
| 827 | ctx.CreateModule(BazelGenruleFactory, &bazelGenruleAttributes{ |
| 828 | Name: proptools.StringPtr(name), |
| 829 | Srcs: m.properties.Srcs, |
| 830 | Outs: outs, |
| 831 | Cmd: cmd, |
| 832 | Tools: tools, |
| 833 | }, &bazel.BazelTargetModuleProperties{ |
| 834 | Rule_class: "genrule", |
| 835 | }) |
| 836 | } |
| 837 | } |
| 838 | |
| 839 | func (m *bazelGenrule) Name() string { |
| 840 | return m.BaseModuleName() |
| 841 | } |
| 842 | |
| 843 | func (m *bazelGenrule) GenerateAndroidBuildActions(ctx android.ModuleContext) {} |
| 844 | |
Nan Zhang | ea568a4 | 2017-11-08 21:20:04 -0800 | [diff] [blame] | 845 | var Bool = proptools.Bool |
| 846 | var String = proptools.String |
Jaewoong Jung | 98716bd | 2018-12-10 08:13:18 -0800 | [diff] [blame] | 847 | |
| 848 | // |
| 849 | // Defaults |
| 850 | // |
| 851 | type Defaults struct { |
| 852 | android.ModuleBase |
| 853 | android.DefaultsModuleBase |
| 854 | } |
| 855 | |
Jaewoong Jung | 98716bd | 2018-12-10 08:13:18 -0800 | [diff] [blame] | 856 | func defaultsFactory() android.Module { |
| 857 | return DefaultsFactory() |
| 858 | } |
| 859 | |
| 860 | func DefaultsFactory(props ...interface{}) android.Module { |
| 861 | module := &Defaults{} |
| 862 | |
| 863 | module.AddProperties(props...) |
| 864 | module.AddProperties( |
| 865 | &generatorProperties{}, |
| 866 | &genRuleProperties{}, |
| 867 | ) |
| 868 | |
| 869 | android.InitDefaultsModule(module) |
| 870 | |
| 871 | return module |
| 872 | } |