Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 1 | package bp2build |
| 2 | |
| 3 | import ( |
Jingwen Chen | 0ee88a6 | 2022-01-07 14:55:29 +0000 | [diff] [blame] | 4 | "encoding/json" |
Rupert Shuttleworth | 2a4fc3e | 2021-04-21 07:10:09 -0400 | [diff] [blame] | 5 | "fmt" |
Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 6 | "reflect" |
Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 7 | "strings" |
| 8 | |
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux | 447f6c9 | 2021-08-31 20:30:36 +0000 | [diff] [blame] | 9 | "android/soong/android" |
Sam Delmerico | 932c01c | 2022-03-25 16:33:26 +0000 | [diff] [blame] | 10 | cc_config "android/soong/cc/config" |
| 11 | java_config "android/soong/java/config" |
Alex Márquez Pérez Muñíz Díaz Púras Thaureaux | 447f6c9 | 2021-08-31 20:30:36 +0000 | [diff] [blame] | 12 | |
Jingwen Chen | 7810e17 | 2022-07-29 02:25:34 +0000 | [diff] [blame^] | 13 | "android/soong/apex" |
| 14 | |
Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 15 | "github.com/google/blueprint/proptools" |
| 16 | ) |
| 17 | |
| 18 | type BazelFile struct { |
| 19 | Dir string |
| 20 | Basename string |
| 21 | Contents string |
| 22 | } |
| 23 | |
Chris Parsons | 3b1f83d | 2021-10-14 14:08:38 -0400 | [diff] [blame] | 24 | func CreateSoongInjectionFiles(cfg android.Config, metrics CodegenMetrics) []BazelFile { |
Jingwen Chen | bf61afb | 2021-05-06 13:31:18 +0000 | [diff] [blame] | 25 | var files []BazelFile |
| 26 | |
Jingwen Chen | c63677b | 2021-06-17 05:43:19 +0000 | [diff] [blame] | 27 | files = append(files, newFile("cc_toolchain", GeneratedBuildFileName, "")) // Creates a //cc_toolchain package. |
Sam Delmerico | 932c01c | 2022-03-25 16:33:26 +0000 | [diff] [blame] | 28 | files = append(files, newFile("cc_toolchain", "constants.bzl", cc_config.BazelCcToolchainVars(cfg))) |
| 29 | |
| 30 | files = append(files, newFile("java_toolchain", GeneratedBuildFileName, "")) // Creates a //java_toolchain package. |
| 31 | files = append(files, newFile("java_toolchain", "constants.bzl", java_config.BazelJavaToolchainVars(cfg))) |
Jingwen Chen | bf61afb | 2021-05-06 13:31:18 +0000 | [diff] [blame] | 32 | |
Jingwen Chen | 7810e17 | 2022-07-29 02:25:34 +0000 | [diff] [blame^] | 33 | files = append(files, newFile("apex_toolchain", GeneratedBuildFileName, "")) // Creates a //apex_toolchain package. |
| 34 | files = append(files, newFile("apex_toolchain", "constants.bzl", apex.BazelApexToolchainVars())) |
| 35 | |
Jingwen Chen | 6117450 | 2021-09-17 08:40:45 +0000 | [diff] [blame] | 36 | files = append(files, newFile("metrics", "converted_modules.txt", strings.Join(metrics.convertedModules, "\n"))) |
Jingwen Chen | c63677b | 2021-06-17 05:43:19 +0000 | [diff] [blame] | 37 | |
Jingwen Chen | 0181202 | 2021-11-19 14:29:43 +0000 | [diff] [blame] | 38 | files = append(files, newFile("product_config", "soong_config_variables.bzl", cfg.Bp2buildSoongConfigDefinitions.String())) |
| 39 | |
Liz Kammer | e8303bd | 2022-02-16 09:02:48 -0500 | [diff] [blame] | 40 | files = append(files, newFile("product_config", "arch_configuration.bzl", android.StarlarkArchConfigurations())) |
| 41 | |
Jingwen Chen | 0ee88a6 | 2022-01-07 14:55:29 +0000 | [diff] [blame] | 42 | apiLevelsContent, err := json.Marshal(android.GetApiLevelsMap(cfg)) |
| 43 | if err != nil { |
| 44 | panic(err) |
| 45 | } |
| 46 | files = append(files, newFile("api_levels", GeneratedBuildFileName, `exports_files(["api_levels.json"])`)) |
| 47 | files = append(files, newFile("api_levels", "api_levels.json", string(apiLevelsContent))) |
Yu Liu | fc60316 | 2022-03-01 15:44:08 -0800 | [diff] [blame] | 48 | files = append(files, newFile("api_levels", "api_levels.bzl", android.StarlarkApiLevelConfigs(cfg))) |
Jingwen Chen | 0ee88a6 | 2022-01-07 14:55:29 +0000 | [diff] [blame] | 49 | |
Jingwen Chen | bf61afb | 2021-05-06 13:31:18 +0000 | [diff] [blame] | 50 | return files |
| 51 | } |
| 52 | |
Jingwen Chen | 6117450 | 2021-09-17 08:40:45 +0000 | [diff] [blame] | 53 | func convertedModules(convertedModules []string) string { |
| 54 | return strings.Join(convertedModules, "\n") |
Jingwen Chen | c63677b | 2021-06-17 05:43:19 +0000 | [diff] [blame] | 55 | } |
| 56 | |
Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 57 | func CreateBazelFiles( |
Sasha Smundak | 0fd93e0 | 2022-05-19 19:34:31 -0700 | [diff] [blame] | 58 | cfg android.Config, |
Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 59 | ruleShims map[string]RuleShim, |
Jingwen Chen | 40067de | 2021-01-26 21:58:43 -0500 | [diff] [blame] | 60 | buildToTargets map[string]BazelTargets, |
Jingwen Chen | 33832f9 | 2021-01-24 22:55:54 -0500 | [diff] [blame] | 61 | mode CodegenMode) []BazelFile { |
Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 62 | |
Jingwen Chen | 6c309cd | 2021-04-01 07:11:11 +0000 | [diff] [blame] | 63 | var files []BazelFile |
Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 64 | |
Jingwen Chen | 33832f9 | 2021-01-24 22:55:54 -0500 | [diff] [blame] | 65 | if mode == QueryView { |
Jingwen Chen | 6c309cd | 2021-04-01 07:11:11 +0000 | [diff] [blame] | 66 | // Write top level WORKSPACE. |
| 67 | files = append(files, newFile("", "WORKSPACE", "")) |
| 68 | |
Jingwen Chen | 12b4c27 | 2021-03-10 02:05:59 -0500 | [diff] [blame] | 69 | // Used to denote that the top level directory is a package. |
| 70 | files = append(files, newFile("", GeneratedBuildFileName, "")) |
| 71 | |
| 72 | files = append(files, newFile(bazelRulesSubDir, GeneratedBuildFileName, "")) |
| 73 | |
Jingwen Chen | 7385067 | 2020-12-14 08:25:34 -0500 | [diff] [blame] | 74 | // These files are only used for queryview. |
| 75 | files = append(files, newFile(bazelRulesSubDir, "providers.bzl", providersBzl)) |
| 76 | |
| 77 | for bzlFileName, ruleShim := range ruleShims { |
| 78 | files = append(files, newFile(bazelRulesSubDir, bzlFileName+".bzl", ruleShim.content)) |
| 79 | } |
| 80 | files = append(files, newFile(bazelRulesSubDir, "soong_module.bzl", generateSoongModuleBzl(ruleShims))) |
Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 81 | } |
Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 82 | |
Sasha Smundak | 0fd93e0 | 2022-05-19 19:34:31 -0700 | [diff] [blame] | 83 | files = append(files, createBuildFiles(cfg, buildToTargets, mode)...) |
Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 84 | |
| 85 | return files |
| 86 | } |
| 87 | |
Sasha Smundak | 0fd93e0 | 2022-05-19 19:34:31 -0700 | [diff] [blame] | 88 | func createBuildFiles(cfg android.Config, buildToTargets map[string]BazelTargets, mode CodegenMode) []BazelFile { |
Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 89 | files := make([]BazelFile, 0, len(buildToTargets)) |
Sasha Smundak | 0fd93e0 | 2022-05-19 19:34:31 -0700 | [diff] [blame] | 90 | warnNotWriting := cfg.IsEnvTrue("BP2BUILD_VERBOSE") |
Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 91 | for _, dir := range android.SortedStringKeys(buildToTargets) { |
Rupert Shuttleworth | 0096079 | 2021-05-12 21:20:13 -0400 | [diff] [blame] | 92 | if mode == Bp2Build && android.ShouldKeepExistingBuildFileForDir(dir) { |
Sasha Smundak | 0fd93e0 | 2022-05-19 19:34:31 -0700 | [diff] [blame] | 93 | if warnNotWriting { |
| 94 | fmt.Printf("[bp2build] Not writing generated BUILD file for dir: '%s'\n", dir) |
| 95 | } |
Rupert Shuttleworth | 2a4fc3e | 2021-04-21 07:10:09 -0400 | [diff] [blame] | 96 | continue |
| 97 | } |
Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 98 | targets := buildToTargets[dir] |
Jingwen Chen | 4910976 | 2021-05-25 05:16:48 +0000 | [diff] [blame] | 99 | targets.sort() |
| 100 | |
| 101 | var content string |
Jingwen Chen | 40067de | 2021-01-26 21:58:43 -0500 | [diff] [blame] | 102 | if mode == Bp2Build { |
Jingwen Chen | 4910976 | 2021-05-25 05:16:48 +0000 | [diff] [blame] | 103 | content = `# READ THIS FIRST: |
| 104 | # This file was automatically generated by bp2build for the Bazel migration project. |
| 105 | # Feel free to edit or test it, but do *not* check it into your version control system. |
| 106 | ` |
| 107 | if targets.hasHandcraftedTargets() { |
| 108 | // For BUILD files with both handcrafted and generated targets, |
| 109 | // don't hardcode actual content, like package() declarations. |
| 110 | // Leave that responsibility to the checked-in BUILD file |
| 111 | // instead. |
| 112 | content += `# This file contains generated targets and handcrafted targets that are manually managed in the source tree.` |
| 113 | } else { |
| 114 | // For fully-generated BUILD files, hardcode the default visibility. |
| 115 | content += "package(default_visibility = [\"//visibility:public\"])" |
| 116 | } |
| 117 | content += "\n" |
Jingwen Chen | 1c23173 | 2021-02-05 09:38:15 -0500 | [diff] [blame] | 118 | content += targets.LoadStatements() |
Jingwen Chen | 4910976 | 2021-05-25 05:16:48 +0000 | [diff] [blame] | 119 | } else if mode == QueryView { |
| 120 | content = soongModuleLoad |
Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 121 | } |
Jingwen Chen | 40067de | 2021-01-26 21:58:43 -0500 | [diff] [blame] | 122 | if content != "" { |
| 123 | // If there are load statements, add a couple of newlines. |
| 124 | content += "\n\n" |
| 125 | } |
| 126 | content += targets.String() |
Liz Kammer | ba3ea16 | 2021-02-17 13:22:03 -0500 | [diff] [blame] | 127 | files = append(files, newFile(dir, GeneratedBuildFileName, content)) |
Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 128 | } |
| 129 | return files |
| 130 | } |
| 131 | |
| 132 | func newFile(dir, basename, content string) BazelFile { |
| 133 | return BazelFile{ |
| 134 | Dir: dir, |
| 135 | Basename: basename, |
| 136 | Contents: content, |
| 137 | } |
| 138 | } |
| 139 | |
| 140 | const ( |
| 141 | bazelRulesSubDir = "build/bazel/queryview_rules" |
| 142 | |
| 143 | // additional files: |
| 144 | // * workspace file |
| 145 | // * base BUILD file |
| 146 | // * rules BUILD file |
| 147 | // * rules providers.bzl file |
| 148 | // * rules soong_module.bzl file |
| 149 | numAdditionalFiles = 5 |
| 150 | ) |
| 151 | |
| 152 | var ( |
| 153 | // Certain module property names are blocklisted/ignored here, for the reasons commented. |
| 154 | ignoredPropNames = map[string]bool{ |
| 155 | "name": true, // redundant, since this is explicitly generated for every target |
| 156 | "from": true, // reserved keyword |
| 157 | "in": true, // reserved keyword |
Jingwen Chen | 88ae408 | 2021-02-24 19:55:50 -0500 | [diff] [blame] | 158 | "size": true, // reserved for tests |
Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 159 | "arch": true, // interface prop type is not supported yet. |
| 160 | "multilib": true, // interface prop type is not supported yet. |
| 161 | "target": true, // interface prop type is not supported yet. |
| 162 | "visibility": true, // Bazel has native visibility semantics. Handle later. |
| 163 | "features": true, // There is already a built-in attribute 'features' which cannot be overridden. |
Jingwen Chen | d9d096e | 2022-05-23 09:38:39 +0000 | [diff] [blame] | 164 | "for": true, // reserved keyword, b/233579439 |
Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 165 | } |
| 166 | ) |
| 167 | |
| 168 | func shouldGenerateAttribute(prop string) bool { |
| 169 | return !ignoredPropNames[prop] |
| 170 | } |
| 171 | |
| 172 | func shouldSkipStructField(field reflect.StructField) bool { |
Liz Kammer | 7a210ac | 2021-09-22 15:52:58 -0400 | [diff] [blame] | 173 | if field.PkgPath != "" && !field.Anonymous { |
Liz Kammer | 2dd9ca4 | 2020-11-25 16:06:39 -0800 | [diff] [blame] | 174 | // Skip unexported fields. Some properties are |
| 175 | // internal to Soong only, and these fields do not have PkgPath. |
| 176 | return true |
| 177 | } |
| 178 | // fields with tag `blueprint:"mutated"` are exported to enable modification in mutators, etc |
| 179 | // but cannot be set in a .bp file |
| 180 | if proptools.HasTag(field, "blueprint", "mutated") { |
| 181 | return true |
| 182 | } |
| 183 | return false |
| 184 | } |
| 185 | |
| 186 | // FIXME(b/168089390): In Bazel, rules ending with "_test" needs to be marked as |
| 187 | // testonly = True, forcing other rules that depend on _test rules to also be |
| 188 | // marked as testonly = True. This semantic constraint is not present in Soong. |
| 189 | // To work around, rename "*_test" rules to "*_test_". |
| 190 | func canonicalizeModuleType(moduleName string) string { |
| 191 | if strings.HasSuffix(moduleName, "_test") { |
| 192 | return moduleName + "_" |
| 193 | } |
| 194 | |
| 195 | return moduleName |
| 196 | } |