blob: 8807437aa2bc00166b0c4cfa8b3fa177add8adde [file] [log] [blame]
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001// Copyright 2021 Google LLC
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
15// Convert makefile containing device configuration to Starlark file
16// The conversion can handle the following constructs in a makefile:
17// * comments
18// * simple variable assignments
19// * $(call init-product,<file>)
20// * $(call inherit-product-if-exists
21// * if directives
22// All other constructs are carried over to the output starlark file as comments.
23//
24package mk2rbc
25
26import (
27 "bytes"
28 "fmt"
29 "io"
Sasha Smundak6609ba72021-07-22 18:32:56 -070030 "io/fs"
Sasha Smundakb051c4e2020-11-05 20:45:07 -080031 "io/ioutil"
32 "os"
33 "path/filepath"
34 "regexp"
35 "strconv"
36 "strings"
37 "text/scanner"
38
39 mkparser "android/soong/androidmk/parser"
40)
41
42const (
Sasha Smundak6d852dd2021-09-27 20:34:39 -070043 annotationCommentPrefix = "RBC#"
44 baseUri = "//build/make/core:product_config.rbc"
Sasha Smundakb051c4e2020-11-05 20:45:07 -080045 // The name of the struct exported by the product_config.rbc
46 // that contains the functions and variables available to
47 // product configuration Starlark files.
48 baseName = "rblf"
49
Sasha Smundak65b547e2021-09-17 15:35:41 -070050 soongNsPrefix = "SOONG_CONFIG_"
51
Sasha Smundakb051c4e2020-11-05 20:45:07 -080052 // And here are the functions and variables:
Cole Fauste2a37982022-03-09 16:00:17 -080053 cfnGetCfg = baseName + ".cfg"
54 cfnMain = baseName + ".product_configuration"
55 cfnBoardMain = baseName + ".board_configuration"
56 cfnPrintVars = baseName + ".printvars"
57 cfnInherit = baseName + ".inherit"
58 cfnSetListDefault = baseName + ".setdefault"
Sasha Smundakb051c4e2020-11-05 20:45:07 -080059)
60
61const (
Cole Faust9ebf6e42021-12-13 14:08:34 -080062 soongConfigAppend = "soong_config_append"
63 soongConfigAssign = "soong_config_set"
Sasha Smundakb051c4e2020-11-05 20:45:07 -080064)
65
Cole Faust9ebf6e42021-12-13 14:08:34 -080066var knownFunctions = map[string]interface {
67 parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr
Sasha Smundakb051c4e2020-11-05 20:45:07 -080068}{
Cole Faust1cc08852022-02-28 11:12:08 -080069 "abspath": &simpleCallParser{name: baseName + ".abspath", returnType: starlarkTypeString},
70 "add-product-dex-preopt-module-config": &simpleCallParser{name: baseName + ".add_product_dex_preopt_module_config", returnType: starlarkTypeString, addHandle: true},
71 "add_soong_config_namespace": &simpleCallParser{name: baseName + ".soong_config_namespace", returnType: starlarkTypeVoid, addGlobals: true},
72 "add_soong_config_var_value": &simpleCallParser{name: baseName + ".soong_config_set", returnType: starlarkTypeVoid, addGlobals: true},
73 soongConfigAssign: &simpleCallParser{name: baseName + ".soong_config_set", returnType: starlarkTypeVoid, addGlobals: true},
74 soongConfigAppend: &simpleCallParser{name: baseName + ".soong_config_append", returnType: starlarkTypeVoid, addGlobals: true},
75 "soong_config_get": &simpleCallParser{name: baseName + ".soong_config_get", returnType: starlarkTypeString, addGlobals: true},
76 "add-to-product-copy-files-if-exists": &simpleCallParser{name: baseName + ".copy_if_exists", returnType: starlarkTypeList},
77 "addprefix": &simpleCallParser{name: baseName + ".addprefix", returnType: starlarkTypeList},
78 "addsuffix": &simpleCallParser{name: baseName + ".addsuffix", returnType: starlarkTypeList},
79 "copy-files": &simpleCallParser{name: baseName + ".copy_files", returnType: starlarkTypeList},
Cole Faust0e2b2562022-04-01 11:46:50 -070080 "dir": &simpleCallParser{name: baseName + ".dir", returnType: starlarkTypeString},
Cole Faust1cc08852022-02-28 11:12:08 -080081 "dist-for-goals": &simpleCallParser{name: baseName + ".mkdist_for_goals", returnType: starlarkTypeVoid, addGlobals: true},
82 "enforce-product-packages-exist": &simpleCallParser{name: baseName + ".enforce_product_packages_exist", returnType: starlarkTypeVoid},
83 "error": &makeControlFuncParser{name: baseName + ".mkerror"},
84 "findstring": &simpleCallParser{name: baseName + ".findstring", returnType: starlarkTypeInt},
85 "find-copy-subdir-files": &simpleCallParser{name: baseName + ".find_and_copy", returnType: starlarkTypeList},
86 "filter": &simpleCallParser{name: baseName + ".filter", returnType: starlarkTypeList},
87 "filter-out": &simpleCallParser{name: baseName + ".filter_out", returnType: starlarkTypeList},
88 "firstword": &firstOrLastwordCallParser{isLastWord: false},
Cole Faustf035d402022-03-28 14:02:50 -070089 "foreach": &foreachCallParser{},
Cole Faust1cc08852022-02-28 11:12:08 -080090 "if": &ifCallParser{},
91 "info": &makeControlFuncParser{name: baseName + ".mkinfo"},
92 "is-board-platform": &simpleCallParser{name: baseName + ".board_platform_is", returnType: starlarkTypeBool, addGlobals: true},
93 "is-board-platform2": &simpleCallParser{name: baseName + ".board_platform_is", returnType: starlarkTypeBool, addGlobals: true},
94 "is-board-platform-in-list": &simpleCallParser{name: baseName + ".board_platform_in", returnType: starlarkTypeBool, addGlobals: true},
95 "is-board-platform-in-list2": &simpleCallParser{name: baseName + ".board_platform_in", returnType: starlarkTypeBool, addGlobals: true},
96 "is-product-in-list": &isProductInListCallParser{},
97 "is-vendor-board-platform": &isVendorBoardPlatformCallParser{},
98 "is-vendor-board-qcom": &isVendorBoardQcomCallParser{},
99 "lastword": &firstOrLastwordCallParser{isLastWord: true},
100 "notdir": &simpleCallParser{name: baseName + ".notdir", returnType: starlarkTypeString},
101 "math_max": &mathMaxOrMinCallParser{function: "max"},
102 "math_min": &mathMaxOrMinCallParser{function: "min"},
103 "math_gt_or_eq": &mathComparisonCallParser{op: ">="},
104 "math_gt": &mathComparisonCallParser{op: ">"},
105 "math_lt": &mathComparisonCallParser{op: "<"},
106 "my-dir": &myDirCallParser{},
107 "patsubst": &substCallParser{fname: "patsubst"},
108 "product-copy-files-by-pattern": &simpleCallParser{name: baseName + ".product_copy_files_by_pattern", returnType: starlarkTypeList},
109 "require-artifacts-in-path": &simpleCallParser{name: baseName + ".require_artifacts_in_path", returnType: starlarkTypeVoid},
110 "require-artifacts-in-path-relaxed": &simpleCallParser{name: baseName + ".require_artifacts_in_path_relaxed", returnType: starlarkTypeVoid},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800111 // TODO(asmundak): remove it once all calls are removed from configuration makefiles. see b/183161002
Cole Faust9ebf6e42021-12-13 14:08:34 -0800112 "shell": &shellCallParser{},
Cole Faust1cc08852022-02-28 11:12:08 -0800113 "strip": &simpleCallParser{name: baseName + ".mkstrip", returnType: starlarkTypeString},
Cole Faust9ebf6e42021-12-13 14:08:34 -0800114 "subst": &substCallParser{fname: "subst"},
115 "warning": &makeControlFuncParser{name: baseName + ".mkwarning"},
116 "word": &wordCallParser{},
Cole Faust1cc08852022-02-28 11:12:08 -0800117 "wildcard": &simpleCallParser{name: baseName + ".expand_wildcard", returnType: starlarkTypeList},
Cole Faust9ebf6e42021-12-13 14:08:34 -0800118}
119
Cole Faustf035d402022-03-28 14:02:50 -0700120// The same as knownFunctions, but returns a []starlarkNode instead of a starlarkExpr
121var knownNodeFunctions = map[string]interface {
122 parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) []starlarkNode
123}{
124 "eval": &evalNodeParser{},
125 "if": &ifCallNodeParser{},
126 "inherit-product": &inheritProductCallParser{loadAlways: true},
127 "inherit-product-if-exists": &inheritProductCallParser{loadAlways: false},
128 "foreach": &foreachCallNodeParser{},
129}
130
Cole Faust9ebf6e42021-12-13 14:08:34 -0800131// These are functions that we don't implement conversions for, but
132// we allow seeing their definitions in the product config files.
133var ignoredDefines = map[string]bool{
134 "find-word-in-list": true, // internal macro
135 "get-vendor-board-platforms": true, // internal macro, used by is-board-platform, etc.
136 "is-android-codename": true, // unused by product config
137 "is-android-codename-in-list": true, // unused by product config
138 "is-chipset-in-board-platform": true, // unused by product config
139 "is-chipset-prefix-in-board-platform": true, // unused by product config
140 "is-not-board-platform": true, // defined but never used
141 "is-platform-sdk-version-at-least": true, // unused by product config
142 "match-prefix": true, // internal macro
143 "match-word": true, // internal macro
144 "match-word-in-list": true, // internal macro
145 "tb-modules": true, // defined in hardware/amlogic/tb_modules/tb_detect.mk, unused
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800146}
147
Cole Faustb0d32ab2021-12-09 14:00:59 -0800148var identifierFullMatchRegex = regexp.MustCompile("^[a-zA-Z_][a-zA-Z0-9_]*$")
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800149
150// Conversion request parameters
151type Request struct {
Sasha Smundak422b6142021-11-11 18:31:59 -0800152 MkFile string // file to convert
153 Reader io.Reader // if set, read input from this stream instead
Sasha Smundak422b6142021-11-11 18:31:59 -0800154 OutputSuffix string // generated Starlark files suffix
155 OutputDir string // if set, root of the output hierarchy
156 ErrorLogger ErrorLogger
157 TracedVariables []string // trace assignment to these variables
158 TraceCalls bool
159 SourceFS fs.FS
160 MakefileFinder MakefileFinder
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800161}
162
Sasha Smundak7d934b92021-11-10 12:20:01 -0800163// ErrorLogger prints errors and gathers error statistics.
164// Its NewError function is called on every error encountered during the conversion.
165type ErrorLogger interface {
Sasha Smundak422b6142021-11-11 18:31:59 -0800166 NewError(el ErrorLocation, node mkparser.Node, text string, args ...interface{})
167}
168
169type ErrorLocation struct {
170 MkFile string
171 MkLine int
172}
173
174func (el ErrorLocation) String() string {
175 return fmt.Sprintf("%s:%d", el.MkFile, el.MkLine)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800176}
177
178// Derives module name for a given file. It is base name
179// (file name without suffix), with some characters replaced to make it a Starlark identifier
180func moduleNameForFile(mkFile string) string {
181 base := strings.TrimSuffix(filepath.Base(mkFile), filepath.Ext(mkFile))
182 // TODO(asmundak): what else can be in the product file names?
Sasha Smundak6609ba72021-07-22 18:32:56 -0700183 return strings.NewReplacer("-", "_", ".", "_").Replace(base)
184
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800185}
186
187func cloneMakeString(mkString *mkparser.MakeString) *mkparser.MakeString {
188 r := &mkparser.MakeString{StringPos: mkString.StringPos}
189 r.Strings = append(r.Strings, mkString.Strings...)
190 r.Variables = append(r.Variables, mkString.Variables...)
191 return r
192}
193
194func isMakeControlFunc(s string) bool {
195 return s == "error" || s == "warning" || s == "info"
196}
197
198// Starlark output generation context
199type generationContext struct {
200 buf strings.Builder
201 starScript *StarlarkScript
202 indentLevel int
203 inAssignment bool
204 tracedCount int
205}
206
207func NewGenerateContext(ss *StarlarkScript) *generationContext {
208 return &generationContext{starScript: ss}
209}
210
211// emit returns generated script
212func (gctx *generationContext) emit() string {
213 ss := gctx.starScript
214
215 // The emitted code has the following layout:
216 // <initial comments>
217 // preamble, i.e.,
218 // load statement for the runtime support
219 // load statement for each unique submodule pulled in by this one
220 // def init(g, handle):
221 // cfg = rblf.cfg(handle)
222 // <statements>
223 // <warning if conversion was not clean>
224
225 iNode := len(ss.nodes)
226 for i, node := range ss.nodes {
227 if _, ok := node.(*commentNode); !ok {
228 iNode = i
229 break
230 }
231 node.emit(gctx)
232 }
233
234 gctx.emitPreamble()
235
236 gctx.newLine()
237 // The arguments passed to the init function are the global dictionary
238 // ('g') and the product configuration dictionary ('cfg')
239 gctx.write("def init(g, handle):")
240 gctx.indentLevel++
241 if gctx.starScript.traceCalls {
242 gctx.newLine()
243 gctx.writef(`print(">%s")`, gctx.starScript.mkFile)
244 }
245 gctx.newLine()
246 gctx.writef("cfg = %s(handle)", cfnGetCfg)
247 for _, node := range ss.nodes[iNode:] {
248 node.emit(gctx)
249 }
250
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800251 if gctx.starScript.traceCalls {
252 gctx.newLine()
253 gctx.writef(`print("<%s")`, gctx.starScript.mkFile)
254 }
255 gctx.indentLevel--
256 gctx.write("\n")
257 return gctx.buf.String()
258}
259
260func (gctx *generationContext) emitPreamble() {
261 gctx.newLine()
262 gctx.writef("load(%q, %q)", baseUri, baseName)
263 // Emit exactly one load statement for each URI.
264 loadedSubConfigs := make(map[string]string)
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800265 for _, mi := range gctx.starScript.inherited {
266 uri := mi.path
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800267 if m, ok := loadedSubConfigs[uri]; ok {
268 // No need to emit load statement, but fix module name.
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800269 mi.moduleLocalName = m
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800270 continue
271 }
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800272 if mi.optional || mi.missing {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800273 uri += "|init"
274 }
275 gctx.newLine()
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800276 gctx.writef("load(%q, %s = \"init\")", uri, mi.entryName())
277 loadedSubConfigs[uri] = mi.moduleLocalName
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800278 }
279 gctx.write("\n")
280}
281
282func (gctx *generationContext) emitPass() {
283 gctx.newLine()
284 gctx.write("pass")
285}
286
287func (gctx *generationContext) write(ss ...string) {
288 for _, s := range ss {
289 gctx.buf.WriteString(s)
290 }
291}
292
293func (gctx *generationContext) writef(format string, args ...interface{}) {
294 gctx.write(fmt.Sprintf(format, args...))
295}
296
297func (gctx *generationContext) newLine() {
298 if gctx.buf.Len() == 0 {
299 return
300 }
301 gctx.write("\n")
302 gctx.writef("%*s", 2*gctx.indentLevel, "")
303}
304
Sasha Smundak422b6142021-11-11 18:31:59 -0800305func (gctx *generationContext) emitConversionError(el ErrorLocation, message string) {
306 gctx.writef(`rblf.mk2rbc_error("%s", %q)`, el, message)
307}
308
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800309func (gctx *generationContext) emitLoadCheck(im inheritedModule) {
310 if !im.needsLoadCheck() {
311 return
312 }
313 gctx.newLine()
314 gctx.writef("if not %s:", im.entryName())
315 gctx.indentLevel++
316 gctx.newLine()
317 gctx.write(`rblf.mkerror("`, gctx.starScript.mkFile, `", "Cannot find %s" % (`)
318 im.pathExpr().emit(gctx)
319 gctx.write("))")
320 gctx.indentLevel--
321}
322
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800323type knownVariable struct {
324 name string
325 class varClass
326 valueType starlarkType
327}
328
329type knownVariables map[string]knownVariable
330
331func (pcv knownVariables) NewVariable(name string, varClass varClass, valueType starlarkType) {
332 v, exists := pcv[name]
333 if !exists {
334 pcv[name] = knownVariable{name, varClass, valueType}
335 return
336 }
337 // Conflict resolution:
338 // * config class trumps everything
339 // * any type trumps unknown type
340 match := varClass == v.class
341 if !match {
342 if varClass == VarClassConfig {
343 v.class = VarClassConfig
344 match = true
345 } else if v.class == VarClassConfig {
346 match = true
347 }
348 }
349 if valueType != v.valueType {
350 if valueType != starlarkTypeUnknown {
351 if v.valueType == starlarkTypeUnknown {
352 v.valueType = valueType
353 } else {
354 match = false
355 }
356 }
357 }
358 if !match {
359 fmt.Fprintf(os.Stderr, "cannot redefine %s as %v/%v (already defined as %v/%v)\n",
360 name, varClass, valueType, v.class, v.valueType)
361 }
362}
363
364// All known product variables.
365var KnownVariables = make(knownVariables)
366
367func init() {
368 for _, kv := range []string{
369 // Kernel-related variables that we know are lists.
370 "BOARD_VENDOR_KERNEL_MODULES",
371 "BOARD_VENDOR_RAMDISK_KERNEL_MODULES",
372 "BOARD_VENDOR_RAMDISK_KERNEL_MODULES_LOAD",
373 "BOARD_RECOVERY_KERNEL_MODULES",
374 // Other variables we knwo are lists
375 "ART_APEX_JARS",
376 } {
377 KnownVariables.NewVariable(kv, VarClassSoong, starlarkTypeList)
378 }
379}
380
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800381// Information about the generated Starlark script.
382type StarlarkScript struct {
Sasha Smundak422b6142021-11-11 18:31:59 -0800383 mkFile string
384 moduleName string
385 mkPos scanner.Position
386 nodes []starlarkNode
387 inherited []*moduleInfo
388 hasErrors bool
Sasha Smundak422b6142021-11-11 18:31:59 -0800389 traceCalls bool // print enter/exit each init function
390 sourceFS fs.FS
391 makefileFinder MakefileFinder
392 nodeLocator func(pos mkparser.Pos) int
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800393}
394
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800395// varAssignmentScope points to the last assignment for each variable
396// in the current block. It is used during the parsing to chain
397// the assignments to a variable together.
398type varAssignmentScope struct {
399 outer *varAssignmentScope
400 vars map[string]*assignmentNode
401}
402
403// parseContext holds the script we are generating and all the ephemeral data
404// needed during the parsing.
405type parseContext struct {
406 script *StarlarkScript
407 nodes []mkparser.Node // Makefile as parsed by mkparser
408 currentNodeIndex int // Node in it we are processing
409 ifNestLevel int
410 moduleNameCount map[string]int // count of imported modules with given basename
411 fatalError error
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800412 outputSuffix string
Sasha Smundak7d934b92021-11-10 12:20:01 -0800413 errorLogger ErrorLogger
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800414 tracedVariables map[string]bool // variables to be traced in the generated script
415 variables map[string]variable
416 varAssignments *varAssignmentScope
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800417 outputDir string
Sasha Smundak6609ba72021-07-22 18:32:56 -0700418 dependentModules map[string]*moduleInfo
Sasha Smundak3deb9682021-07-26 18:42:25 -0700419 soongNamespaces map[string]map[string]bool
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700420 includeTops []string
Cole Faustf92c9f22022-03-14 14:35:50 -0700421 typeHints map[string]starlarkType
422 atTopOfMakefile bool
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800423}
424
425func newParseContext(ss *StarlarkScript, nodes []mkparser.Node) *parseContext {
426 predefined := []struct{ name, value string }{
427 {"SRC_TARGET_DIR", filepath.Join("build", "make", "target")},
428 {"LOCAL_PATH", filepath.Dir(ss.mkFile)},
Cole Faust9b6111a2022-02-02 15:38:33 -0800429 {"TOPDIR", ""}, // TOPDIR is just set to an empty string in cleanbuild.mk and core.mk
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800430 // TODO(asmundak): maybe read it from build/make/core/envsetup.mk?
431 {"TARGET_COPY_OUT_SYSTEM", "system"},
432 {"TARGET_COPY_OUT_SYSTEM_OTHER", "system_other"},
433 {"TARGET_COPY_OUT_DATA", "data"},
434 {"TARGET_COPY_OUT_ASAN", filepath.Join("data", "asan")},
435 {"TARGET_COPY_OUT_OEM", "oem"},
436 {"TARGET_COPY_OUT_RAMDISK", "ramdisk"},
437 {"TARGET_COPY_OUT_DEBUG_RAMDISK", "debug_ramdisk"},
438 {"TARGET_COPY_OUT_VENDOR_DEBUG_RAMDISK", "vendor_debug_ramdisk"},
439 {"TARGET_COPY_OUT_TEST_HARNESS_RAMDISK", "test_harness_ramdisk"},
440 {"TARGET_COPY_OUT_ROOT", "root"},
441 {"TARGET_COPY_OUT_RECOVERY", "recovery"},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800442 {"TARGET_COPY_OUT_VENDOR_RAMDISK", "vendor_ramdisk"},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800443 // TODO(asmundak): to process internal config files, we need the following variables:
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800444 // TARGET_VENDOR
445 // target_base_product
446 //
447
448 // the following utility variables are set in build/make/common/core.mk:
449 {"empty", ""},
450 {"space", " "},
451 {"comma", ","},
452 {"newline", "\n"},
453 {"pound", "#"},
454 {"backslash", "\\"},
455 }
456 ctx := &parseContext{
457 script: ss,
458 nodes: nodes,
459 currentNodeIndex: 0,
460 ifNestLevel: 0,
461 moduleNameCount: make(map[string]int),
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800462 variables: make(map[string]variable),
Sasha Smundak6609ba72021-07-22 18:32:56 -0700463 dependentModules: make(map[string]*moduleInfo),
Sasha Smundak3deb9682021-07-26 18:42:25 -0700464 soongNamespaces: make(map[string]map[string]bool),
Cole Faust6c934f62022-01-06 15:51:12 -0800465 includeTops: []string{},
Cole Faustf92c9f22022-03-14 14:35:50 -0700466 typeHints: make(map[string]starlarkType),
467 atTopOfMakefile: true,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800468 }
469 ctx.pushVarAssignments()
470 for _, item := range predefined {
471 ctx.variables[item.name] = &predefinedVariable{
472 baseVariable: baseVariable{nam: item.name, typ: starlarkTypeString},
473 value: &stringLiteralExpr{item.value},
474 }
475 }
476
477 return ctx
478}
479
Cole Faust3c4fc992022-02-28 16:05:01 -0800480func (ctx *parseContext) lastAssignment(v variable) *assignmentNode {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800481 for va := ctx.varAssignments; va != nil; va = va.outer {
Cole Faust3c4fc992022-02-28 16:05:01 -0800482 if v, ok := va.vars[v.name()]; ok {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800483 return v
484 }
485 }
486 return nil
487}
488
Cole Faust3c4fc992022-02-28 16:05:01 -0800489func (ctx *parseContext) setLastAssignment(v variable, asgn *assignmentNode) {
490 ctx.varAssignments.vars[v.name()] = asgn
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800491}
492
493func (ctx *parseContext) pushVarAssignments() {
494 va := &varAssignmentScope{
495 outer: ctx.varAssignments,
496 vars: make(map[string]*assignmentNode),
497 }
498 ctx.varAssignments = va
499}
500
501func (ctx *parseContext) popVarAssignments() {
502 ctx.varAssignments = ctx.varAssignments.outer
503}
504
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800505func (ctx *parseContext) hasNodes() bool {
506 return ctx.currentNodeIndex < len(ctx.nodes)
507}
508
509func (ctx *parseContext) getNode() mkparser.Node {
510 if !ctx.hasNodes() {
511 return nil
512 }
513 node := ctx.nodes[ctx.currentNodeIndex]
514 ctx.currentNodeIndex++
515 return node
516}
517
518func (ctx *parseContext) backNode() {
519 if ctx.currentNodeIndex <= 0 {
520 panic("Cannot back off")
521 }
522 ctx.currentNodeIndex--
523}
524
Cole Faustdd569ae2022-01-31 15:48:29 -0800525func (ctx *parseContext) handleAssignment(a *mkparser.Assignment) []starlarkNode {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800526 // Handle only simple variables
527 if !a.Name.Const() {
Cole Faustdd569ae2022-01-31 15:48:29 -0800528 return []starlarkNode{ctx.newBadNode(a, "Only simple variables are handled")}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800529 }
530 name := a.Name.Strings[0]
Sasha Smundakea3bc3a2021-11-10 13:06:42 -0800531 // The `override` directive
532 // override FOO :=
533 // is parsed as an assignment to a variable named `override FOO`.
534 // There are very few places where `override` is used, just flag it.
535 if strings.HasPrefix(name, "override ") {
Cole Faustdd569ae2022-01-31 15:48:29 -0800536 return []starlarkNode{ctx.newBadNode(a, "cannot handle override directive")}
Sasha Smundakea3bc3a2021-11-10 13:06:42 -0800537 }
538
Cole Faustc00184e2021-11-08 12:08:57 -0800539 // Soong configuration
Sasha Smundak3deb9682021-07-26 18:42:25 -0700540 if strings.HasPrefix(name, soongNsPrefix) {
Cole Faustdd569ae2022-01-31 15:48:29 -0800541 return ctx.handleSoongNsAssignment(strings.TrimPrefix(name, soongNsPrefix), a)
Sasha Smundak3deb9682021-07-26 18:42:25 -0700542 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800543 lhs := ctx.addVariable(name)
544 if lhs == nil {
Cole Faustdd569ae2022-01-31 15:48:29 -0800545 return []starlarkNode{ctx.newBadNode(a, "unknown variable %s", name)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800546 }
Cole Faust3c4fc992022-02-28 16:05:01 -0800547 _, isTraced := ctx.tracedVariables[lhs.name()]
Sasha Smundak422b6142021-11-11 18:31:59 -0800548 asgn := &assignmentNode{lhs: lhs, mkValue: a.Value, isTraced: isTraced, location: ctx.errorLocation(a)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800549 if lhs.valueType() == starlarkTypeUnknown {
550 // Try to divine variable type from the RHS
551 asgn.value = ctx.parseMakeString(a, a.Value)
552 if xBad, ok := asgn.value.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800553 return []starlarkNode{&exprNode{xBad}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800554 }
555 inferred_type := asgn.value.typ()
556 if inferred_type != starlarkTypeUnknown {
Sasha Smundak9d011ab2021-07-09 16:00:57 -0700557 lhs.setValueType(inferred_type)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800558 }
559 }
560 if lhs.valueType() == starlarkTypeList {
Cole Faustdd569ae2022-01-31 15:48:29 -0800561 xConcat, xBad := ctx.buildConcatExpr(a)
562 if xBad != nil {
563 return []starlarkNode{&exprNode{expr: xBad}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800564 }
565 switch len(xConcat.items) {
566 case 0:
567 asgn.value = &listExpr{}
568 case 1:
569 asgn.value = xConcat.items[0]
570 default:
571 asgn.value = xConcat
572 }
573 } else {
574 asgn.value = ctx.parseMakeString(a, a.Value)
575 if xBad, ok := asgn.value.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800576 return []starlarkNode{&exprNode{expr: xBad}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800577 }
578 }
579
Cole Faust421a1922022-03-16 14:35:45 -0700580 if asgn.lhs.valueType() == starlarkTypeString &&
581 asgn.value.typ() != starlarkTypeUnknown &&
582 asgn.value.typ() != starlarkTypeString {
583 asgn.value = &toStringExpr{expr: asgn.value}
584 }
585
Cole Faust3c4fc992022-02-28 16:05:01 -0800586 asgn.previous = ctx.lastAssignment(lhs)
587 ctx.setLastAssignment(lhs, asgn)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800588 switch a.Type {
589 case "=", ":=":
590 asgn.flavor = asgnSet
591 case "+=":
Cole Fauste2a37982022-03-09 16:00:17 -0800592 asgn.flavor = asgnAppend
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800593 case "?=":
594 asgn.flavor = asgnMaybeSet
595 default:
596 panic(fmt.Errorf("unexpected assignment type %s", a.Type))
597 }
598
Cole Faustdd569ae2022-01-31 15:48:29 -0800599 return []starlarkNode{asgn}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800600}
601
Cole Faustdd569ae2022-01-31 15:48:29 -0800602func (ctx *parseContext) handleSoongNsAssignment(name string, asgn *mkparser.Assignment) []starlarkNode {
Sasha Smundak3deb9682021-07-26 18:42:25 -0700603 val := ctx.parseMakeString(asgn, asgn.Value)
604 if xBad, ok := val.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800605 return []starlarkNode{&exprNode{expr: xBad}}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700606 }
Sasha Smundak3deb9682021-07-26 18:42:25 -0700607
608 // Unfortunately, Soong namespaces can be set up by directly setting corresponding Make
609 // variables instead of via add_soong_config_namespace + add_soong_config_var_value.
610 // Try to divine the call from the assignment as follows:
611 if name == "NAMESPACES" {
612 // Upon seeng
613 // SOONG_CONFIG_NAMESPACES += foo
614 // remember that there is a namespace `foo` and act as we saw
615 // $(call add_soong_config_namespace,foo)
616 s, ok := maybeString(val)
617 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800618 return []starlarkNode{ctx.newBadNode(asgn, "cannot handle variables in SOONG_CONFIG_NAMESPACES assignment, please use add_soong_config_namespace instead")}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700619 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800620 result := make([]starlarkNode, 0)
Sasha Smundak3deb9682021-07-26 18:42:25 -0700621 for _, ns := range strings.Fields(s) {
622 ctx.addSoongNamespace(ns)
Cole Faustdd569ae2022-01-31 15:48:29 -0800623 result = append(result, &exprNode{&callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -0800624 name: baseName + ".soong_config_namespace",
625 args: []starlarkExpr{&globalsExpr{}, &stringLiteralExpr{ns}},
Sasha Smundak3deb9682021-07-26 18:42:25 -0700626 returnType: starlarkTypeVoid,
627 }})
628 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800629 return result
Sasha Smundak3deb9682021-07-26 18:42:25 -0700630 } else {
631 // Upon seeing
632 // SOONG_CONFIG_x_y = v
633 // find a namespace called `x` and act as if we encountered
Cole Faustc00184e2021-11-08 12:08:57 -0800634 // $(call soong_config_set,x,y,v)
Sasha Smundak3deb9682021-07-26 18:42:25 -0700635 // or check that `x_y` is a namespace, and then add the RHS of this assignment as variables in
636 // it.
637 // Emit an error in the ambiguous situation (namespaces `foo_bar` with a variable `baz`
638 // and `foo` with a variable `bar_baz`.
639 namespaceName := ""
640 if ctx.hasSoongNamespace(name) {
641 namespaceName = name
642 }
643 var varName string
644 for pos, ch := range name {
645 if !(ch == '_' && ctx.hasSoongNamespace(name[0:pos])) {
646 continue
647 }
648 if namespaceName != "" {
Cole Faustdd569ae2022-01-31 15:48:29 -0800649 return []starlarkNode{ctx.newBadNode(asgn, "ambiguous soong namespace (may be either `%s` or `%s`)", namespaceName, name[0:pos])}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700650 }
651 namespaceName = name[0:pos]
652 varName = name[pos+1:]
653 }
654 if namespaceName == "" {
Cole Faustdd569ae2022-01-31 15:48:29 -0800655 return []starlarkNode{ctx.newBadNode(asgn, "cannot figure out Soong namespace, please use add_soong_config_var_value macro instead")}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700656 }
657 if varName == "" {
658 // Remember variables in this namespace
659 s, ok := maybeString(val)
660 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800661 return []starlarkNode{ctx.newBadNode(asgn, "cannot handle variables in SOONG_CONFIG_ assignment, please use add_soong_config_var_value instead")}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700662 }
663 ctx.updateSoongNamespace(asgn.Type != "+=", namespaceName, strings.Fields(s))
Cole Faustdd569ae2022-01-31 15:48:29 -0800664 return []starlarkNode{}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700665 }
666
667 // Finally, handle assignment to a namespace variable
668 if !ctx.hasNamespaceVar(namespaceName, varName) {
Cole Faustdd569ae2022-01-31 15:48:29 -0800669 return []starlarkNode{ctx.newBadNode(asgn, "no %s variable in %s namespace, please use add_soong_config_var_value instead", varName, namespaceName)}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700670 }
Cole Faust9ebf6e42021-12-13 14:08:34 -0800671 fname := baseName + "." + soongConfigAssign
Sasha Smundak65b547e2021-09-17 15:35:41 -0700672 if asgn.Type == "+=" {
Cole Faust9ebf6e42021-12-13 14:08:34 -0800673 fname = baseName + "." + soongConfigAppend
Sasha Smundak65b547e2021-09-17 15:35:41 -0700674 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800675 return []starlarkNode{&exprNode{&callExpr{
Sasha Smundak65b547e2021-09-17 15:35:41 -0700676 name: fname,
Cole Faust9ebf6e42021-12-13 14:08:34 -0800677 args: []starlarkExpr{&globalsExpr{}, &stringLiteralExpr{namespaceName}, &stringLiteralExpr{varName}, val},
Sasha Smundak3deb9682021-07-26 18:42:25 -0700678 returnType: starlarkTypeVoid,
Cole Faustdd569ae2022-01-31 15:48:29 -0800679 }}}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700680 }
681}
682
Cole Faustdd569ae2022-01-31 15:48:29 -0800683func (ctx *parseContext) buildConcatExpr(a *mkparser.Assignment) (*concatExpr, *badExpr) {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800684 xConcat := &concatExpr{}
685 var xItemList *listExpr
686 addToItemList := func(x ...starlarkExpr) {
687 if xItemList == nil {
688 xItemList = &listExpr{[]starlarkExpr{}}
689 }
690 xItemList.items = append(xItemList.items, x...)
691 }
692 finishItemList := func() {
693 if xItemList != nil {
694 xConcat.items = append(xConcat.items, xItemList)
695 xItemList = nil
696 }
697 }
698
699 items := a.Value.Words()
700 for _, item := range items {
701 // A function call in RHS is supposed to return a list, all other item
702 // expressions return individual elements.
703 switch x := ctx.parseMakeString(a, item).(type) {
704 case *badExpr:
Cole Faustdd569ae2022-01-31 15:48:29 -0800705 return nil, x
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800706 case *stringLiteralExpr:
707 addToItemList(maybeConvertToStringList(x).(*listExpr).items...)
708 default:
709 switch x.typ() {
710 case starlarkTypeList:
711 finishItemList()
712 xConcat.items = append(xConcat.items, x)
713 case starlarkTypeString:
714 finishItemList()
715 xConcat.items = append(xConcat.items, &callExpr{
716 object: x,
717 name: "split",
718 args: nil,
719 returnType: starlarkTypeList,
720 })
721 default:
722 addToItemList(x)
723 }
724 }
725 }
726 if xItemList != nil {
727 xConcat.items = append(xConcat.items, xItemList)
728 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800729 return xConcat, nil
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800730}
731
Sasha Smundak6609ba72021-07-22 18:32:56 -0700732func (ctx *parseContext) newDependentModule(path string, optional bool) *moduleInfo {
733 modulePath := ctx.loadedModulePath(path)
734 if mi, ok := ctx.dependentModules[modulePath]; ok {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700735 mi.optional = mi.optional && optional
Sasha Smundak6609ba72021-07-22 18:32:56 -0700736 return mi
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800737 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800738 moduleName := moduleNameForFile(path)
739 moduleLocalName := "_" + moduleName
740 n, found := ctx.moduleNameCount[moduleName]
741 if found {
742 moduleLocalName += fmt.Sprintf("%d", n)
743 }
744 ctx.moduleNameCount[moduleName] = n + 1
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800745 _, err := fs.Stat(ctx.script.sourceFS, path)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700746 mi := &moduleInfo{
747 path: modulePath,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800748 originalPath: path,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800749 moduleLocalName: moduleLocalName,
Sasha Smundak6609ba72021-07-22 18:32:56 -0700750 optional: optional,
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800751 missing: err != nil,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800752 }
Sasha Smundak6609ba72021-07-22 18:32:56 -0700753 ctx.dependentModules[modulePath] = mi
754 ctx.script.inherited = append(ctx.script.inherited, mi)
755 return mi
756}
757
758func (ctx *parseContext) handleSubConfig(
Cole Faustdd569ae2022-01-31 15:48:29 -0800759 v mkparser.Node, pathExpr starlarkExpr, loadAlways bool, processModule func(inheritedModule) starlarkNode) []starlarkNode {
Sasha Smundak6609ba72021-07-22 18:32:56 -0700760
761 // In a simple case, the name of a module to inherit/include is known statically.
762 if path, ok := maybeString(pathExpr); ok {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700763 // Note that even if this directive loads a module unconditionally, a module may be
764 // absent without causing any harm if this directive is inside an if/else block.
765 moduleShouldExist := loadAlways && ctx.ifNestLevel == 0
Sasha Smundak6609ba72021-07-22 18:32:56 -0700766 if strings.Contains(path, "*") {
767 if paths, err := fs.Glob(ctx.script.sourceFS, path); err == nil {
Cole Faustdd569ae2022-01-31 15:48:29 -0800768 result := make([]starlarkNode, 0)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700769 for _, p := range paths {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700770 mi := ctx.newDependentModule(p, !moduleShouldExist)
Cole Faustdd569ae2022-01-31 15:48:29 -0800771 result = append(result, processModule(inheritedStaticModule{mi, loadAlways}))
Sasha Smundak6609ba72021-07-22 18:32:56 -0700772 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800773 return result
Sasha Smundak6609ba72021-07-22 18:32:56 -0700774 } else {
Cole Faustdd569ae2022-01-31 15:48:29 -0800775 return []starlarkNode{ctx.newBadNode(v, "cannot glob wildcard argument")}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700776 }
777 } else {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700778 mi := ctx.newDependentModule(path, !moduleShouldExist)
Cole Faustdd569ae2022-01-31 15:48:29 -0800779 return []starlarkNode{processModule(inheritedStaticModule{mi, loadAlways})}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700780 }
Sasha Smundak6609ba72021-07-22 18:32:56 -0700781 }
782
783 // If module path references variables (e.g., $(v1)/foo/$(v2)/device-config.mk), find all the paths in the
784 // source tree that may be a match and the corresponding variable values. For instance, if the source tree
785 // contains vendor1/foo/abc/dev.mk and vendor2/foo/def/dev.mk, the first one will be inherited when
786 // (v1, v2) == ('vendor1', 'abc'), and the second one when (v1, v2) == ('vendor2', 'def').
787 // We then emit the code that loads all of them, e.g.:
788 // load("//vendor1/foo/abc:dev.rbc", _dev1_init="init")
789 // load("//vendor2/foo/def/dev.rbc", _dev2_init="init")
790 // And then inherit it as follows:
791 // _e = {
792 // "vendor1/foo/abc/dev.mk": ("vendor1/foo/abc/dev", _dev1_init),
793 // "vendor2/foo/def/dev.mk": ("vendor2/foo/def/dev", _dev_init2) }.get("%s/foo/%s/dev.mk" % (v1, v2))
794 // if _e:
795 // rblf.inherit(handle, _e[0], _e[1])
796 //
797 var matchingPaths []string
798 varPath, ok := pathExpr.(*interpolateExpr)
799 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800800 return []starlarkNode{ctx.newBadNode(v, "inherit-product/include argument is too complex")}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700801 }
802
803 pathPattern := []string{varPath.chunks[0]}
804 for _, chunk := range varPath.chunks[1:] {
805 if chunk != "" {
806 pathPattern = append(pathPattern, chunk)
807 }
808 }
Cole Faust069aba62022-01-26 17:47:33 -0800809 if pathPattern[0] == "" && len(ctx.includeTops) > 0 {
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700810 // If pattern starts from the top. restrict it to the directories where
811 // we know inherit-product uses dynamically calculated path.
812 for _, p := range ctx.includeTops {
813 pathPattern[0] = p
814 matchingPaths = append(matchingPaths, ctx.findMatchingPaths(pathPattern)...)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700815 }
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700816 } else {
817 matchingPaths = ctx.findMatchingPaths(pathPattern)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700818 }
819 // Safeguard against $(call inherit-product,$(PRODUCT_PATH))
Sasha Smundak90be8c52021-08-03 11:06:10 -0700820 const maxMatchingFiles = 150
Sasha Smundak6609ba72021-07-22 18:32:56 -0700821 if len(matchingPaths) > maxMatchingFiles {
Cole Faustdd569ae2022-01-31 15:48:29 -0800822 return []starlarkNode{ctx.newBadNode(v, "there are >%d files matching the pattern, please rewrite it", maxMatchingFiles)}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700823 }
Cole Faust93f8d392022-03-02 13:31:30 -0800824
825 needsWarning := pathPattern[0] == "" && len(ctx.includeTops) == 0
826 res := inheritedDynamicModule{*varPath, []*moduleInfo{}, loadAlways, ctx.errorLocation(v), needsWarning}
827 for _, p := range matchingPaths {
828 // A product configuration files discovered dynamically may attempt to inherit
829 // from another one which does not exist in this source tree. Prevent load errors
830 // by always loading the dynamic files as optional.
831 res.candidateModules = append(res.candidateModules, ctx.newDependentModule(p, true))
Sasha Smundak6609ba72021-07-22 18:32:56 -0700832 }
Cole Faust93f8d392022-03-02 13:31:30 -0800833 return []starlarkNode{processModule(res)}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700834}
835
836func (ctx *parseContext) findMatchingPaths(pattern []string) []string {
Cole Faust9b6111a2022-02-02 15:38:33 -0800837 files := ctx.script.makefileFinder.Find(".")
Sasha Smundak6609ba72021-07-22 18:32:56 -0700838 if len(pattern) == 0 {
839 return files
840 }
841
842 // Create regular expression from the pattern
843 s_regexp := "^" + regexp.QuoteMeta(pattern[0])
844 for _, s := range pattern[1:] {
845 s_regexp += ".*" + regexp.QuoteMeta(s)
846 }
847 s_regexp += "$"
848 rex := regexp.MustCompile(s_regexp)
849
850 // Now match
851 var res []string
852 for _, p := range files {
853 if rex.MatchString(p) {
854 res = append(res, p)
855 }
856 }
857 return res
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800858}
859
Cole Faustf035d402022-03-28 14:02:50 -0700860type inheritProductCallParser struct {
861 loadAlways bool
862}
863
864func (p *inheritProductCallParser) parse(ctx *parseContext, v mkparser.Node, args *mkparser.MakeString) []starlarkNode {
Cole Faust9ebf6e42021-12-13 14:08:34 -0800865 args.TrimLeftSpaces()
866 args.TrimRightSpaces()
867 pathExpr := ctx.parseMakeString(v, args)
868 if _, ok := pathExpr.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800869 return []starlarkNode{ctx.newBadNode(v, "Unable to parse argument to inherit")}
Cole Faust9ebf6e42021-12-13 14:08:34 -0800870 }
Cole Faustf035d402022-03-28 14:02:50 -0700871 return ctx.handleSubConfig(v, pathExpr, p.loadAlways, func(im inheritedModule) starlarkNode {
872 return &inheritNode{im, p.loadAlways}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700873 })
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800874}
875
Cole Faustdd569ae2022-01-31 15:48:29 -0800876func (ctx *parseContext) handleInclude(v mkparser.Node, pathExpr starlarkExpr, loadAlways bool) []starlarkNode {
877 return ctx.handleSubConfig(v, pathExpr, loadAlways, func(im inheritedModule) starlarkNode {
878 return &includeNode{im, loadAlways}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700879 })
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800880}
881
Cole Faustdd569ae2022-01-31 15:48:29 -0800882func (ctx *parseContext) handleVariable(v *mkparser.Variable) []starlarkNode {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800883 // Handle:
884 // $(call inherit-product,...)
885 // $(call inherit-product-if-exists,...)
886 // $(info xxx)
887 // $(warning xxx)
888 // $(error xxx)
Cole Faust9ebf6e42021-12-13 14:08:34 -0800889 // $(call other-custom-functions,...)
890
Cole Faustf035d402022-03-28 14:02:50 -0700891 if name, args, ok := ctx.maybeParseFunctionCall(v, v.Name); ok {
892 if kf, ok := knownNodeFunctions[name]; ok {
893 return kf.parse(ctx, v, args)
894 }
Cole Faust9ebf6e42021-12-13 14:08:34 -0800895 }
Cole Faustf035d402022-03-28 14:02:50 -0700896
Cole Faustdd569ae2022-01-31 15:48:29 -0800897 return []starlarkNode{&exprNode{expr: ctx.parseReference(v, v.Name)}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800898}
899
Cole Faustdd569ae2022-01-31 15:48:29 -0800900func (ctx *parseContext) maybeHandleDefine(directive *mkparser.Directive) starlarkNode {
Sasha Smundakf3e072a2021-07-14 12:50:28 -0700901 macro_name := strings.Fields(directive.Args.Strings[0])[0]
902 // Ignore the macros that we handle
Cole Faust9ebf6e42021-12-13 14:08:34 -0800903 _, ignored := ignoredDefines[macro_name]
904 _, known := knownFunctions[macro_name]
905 if !ignored && !known {
Cole Faustdd569ae2022-01-31 15:48:29 -0800906 return ctx.newBadNode(directive, "define is not supported: %s", macro_name)
Sasha Smundakf3e072a2021-07-14 12:50:28 -0700907 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800908 return nil
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800909}
910
Cole Faustdd569ae2022-01-31 15:48:29 -0800911func (ctx *parseContext) handleIfBlock(ifDirective *mkparser.Directive) starlarkNode {
912 ssSwitch := &switchNode{
913 ssCases: []*switchCase{ctx.processBranch(ifDirective)},
914 }
915 for ctx.hasNodes() && ctx.fatalError == nil {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800916 node := ctx.getNode()
917 switch x := node.(type) {
918 case *mkparser.Directive:
919 switch x.Name {
920 case "else", "elifdef", "elifndef", "elifeq", "elifneq":
Cole Faustdd569ae2022-01-31 15:48:29 -0800921 ssSwitch.ssCases = append(ssSwitch.ssCases, ctx.processBranch(x))
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800922 case "endif":
Cole Faustdd569ae2022-01-31 15:48:29 -0800923 return ssSwitch
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800924 default:
Cole Faustdd569ae2022-01-31 15:48:29 -0800925 return ctx.newBadNode(node, "unexpected directive %s", x.Name)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800926 }
927 default:
Cole Faustdd569ae2022-01-31 15:48:29 -0800928 return ctx.newBadNode(ifDirective, "unexpected statement")
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800929 }
930 }
931 if ctx.fatalError == nil {
932 ctx.fatalError = fmt.Errorf("no matching endif for %s", ifDirective.Dump())
933 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800934 return ctx.newBadNode(ifDirective, "no matching endif for %s", ifDirective.Dump())
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800935}
936
937// processBranch processes a single branch (if/elseif/else) until the next directive
938// on the same level.
Cole Faustdd569ae2022-01-31 15:48:29 -0800939func (ctx *parseContext) processBranch(check *mkparser.Directive) *switchCase {
940 block := &switchCase{gate: ctx.parseCondition(check)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800941 defer func() {
942 ctx.popVarAssignments()
943 ctx.ifNestLevel--
944
945 }()
946 ctx.pushVarAssignments()
947 ctx.ifNestLevel++
948
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800949 for ctx.hasNodes() {
950 node := ctx.getNode()
Cole Faust591a1fe2021-11-08 15:37:57 -0800951 if d, ok := node.(*mkparser.Directive); ok {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800952 switch d.Name {
953 case "else", "elifdef", "elifndef", "elifeq", "elifneq", "endif":
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800954 ctx.backNode()
Cole Faustdd569ae2022-01-31 15:48:29 -0800955 return block
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800956 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800957 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800958 block.nodes = append(block.nodes, ctx.handleSimpleStatement(node)...)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800959 }
960 ctx.fatalError = fmt.Errorf("no matching endif for %s", check.Dump())
Cole Faustdd569ae2022-01-31 15:48:29 -0800961 return block
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800962}
963
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800964func (ctx *parseContext) parseCondition(check *mkparser.Directive) starlarkNode {
965 switch check.Name {
966 case "ifdef", "ifndef", "elifdef", "elifndef":
Cole Faust71514c02022-01-27 17:21:41 -0800967 if !check.Args.Const() {
Cole Faustdd569ae2022-01-31 15:48:29 -0800968 return ctx.newBadNode(check, "ifdef variable ref too complex: %s", check.Args.Dump())
Cole Faust71514c02022-01-27 17:21:41 -0800969 }
970 v := NewVariableRefExpr(ctx.addVariable(check.Args.Strings[0]), false)
971 if strings.HasSuffix(check.Name, "ndef") {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800972 v = &notExpr{v}
973 }
974 return &ifNode{
975 isElif: strings.HasPrefix(check.Name, "elif"),
976 expr: v,
977 }
978 case "ifeq", "ifneq", "elifeq", "elifneq":
979 return &ifNode{
980 isElif: strings.HasPrefix(check.Name, "elif"),
981 expr: ctx.parseCompare(check),
982 }
983 case "else":
984 return &elseNode{}
985 default:
986 panic(fmt.Errorf("%s: unknown directive: %s", ctx.script.mkFile, check.Dump()))
987 }
988}
989
990func (ctx *parseContext) newBadExpr(node mkparser.Node, text string, args ...interface{}) starlarkExpr {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800991 if ctx.errorLogger != nil {
Sasha Smundak422b6142021-11-11 18:31:59 -0800992 ctx.errorLogger.NewError(ctx.errorLocation(node), node, text, args...)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800993 }
994 ctx.script.hasErrors = true
Cole Faustdd569ae2022-01-31 15:48:29 -0800995 return &badExpr{errorLocation: ctx.errorLocation(node), message: fmt.Sprintf(text, args...)}
996}
997
998// records that the given node failed to be converted and includes an explanatory message
999func (ctx *parseContext) newBadNode(failedNode mkparser.Node, message string, args ...interface{}) starlarkNode {
1000 return &exprNode{ctx.newBadExpr(failedNode, message, args...)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001001}
1002
1003func (ctx *parseContext) parseCompare(cond *mkparser.Directive) starlarkExpr {
1004 // Strip outer parentheses
1005 mkArg := cloneMakeString(cond.Args)
1006 mkArg.Strings[0] = strings.TrimLeft(mkArg.Strings[0], "( ")
1007 n := len(mkArg.Strings)
1008 mkArg.Strings[n-1] = strings.TrimRight(mkArg.Strings[n-1], ") ")
1009 args := mkArg.Split(",")
1010 // TODO(asmundak): handle the case where the arguments are in quotes and space-separated
1011 if len(args) != 2 {
1012 return ctx.newBadExpr(cond, "ifeq/ifneq len(args) != 2 %s", cond.Dump())
1013 }
1014 args[0].TrimRightSpaces()
1015 args[1].TrimLeftSpaces()
1016
1017 isEq := !strings.HasSuffix(cond.Name, "neq")
Cole Faustf8320212021-11-10 15:05:07 -08001018 xLeft := ctx.parseMakeString(cond, args[0])
1019 xRight := ctx.parseMakeString(cond, args[1])
1020 if bad, ok := xLeft.(*badExpr); ok {
1021 return bad
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001022 }
Cole Faustf8320212021-11-10 15:05:07 -08001023 if bad, ok := xRight.(*badExpr); ok {
1024 return bad
1025 }
1026
1027 if expr, ok := ctx.parseCompareSpecialCases(cond, xLeft, xRight); ok {
1028 return expr
1029 }
1030
Cole Faust9ebf6e42021-12-13 14:08:34 -08001031 var stringOperand string
1032 var otherOperand starlarkExpr
1033 if s, ok := maybeString(xLeft); ok {
1034 stringOperand = s
1035 otherOperand = xRight
1036 } else if s, ok := maybeString(xRight); ok {
1037 stringOperand = s
1038 otherOperand = xLeft
1039 }
1040
Cole Faust9ebf6e42021-12-13 14:08:34 -08001041 // If we've identified one of the operands as being a string literal, check
1042 // for some special cases we can do to simplify the resulting expression.
1043 if otherOperand != nil {
1044 if stringOperand == "" {
1045 if isEq {
Cole Faustf035d402022-03-28 14:02:50 -07001046 return negateExpr(otherOperand)
Cole Faust9ebf6e42021-12-13 14:08:34 -08001047 } else {
1048 return otherOperand
1049 }
1050 }
1051 if stringOperand == "true" && otherOperand.typ() == starlarkTypeBool {
1052 if !isEq {
Cole Faustf035d402022-03-28 14:02:50 -07001053 return negateExpr(otherOperand)
Cole Faust9ebf6e42021-12-13 14:08:34 -08001054 } else {
1055 return otherOperand
1056 }
1057 }
Cole Faustb1103e22022-01-06 15:22:05 -08001058 if intOperand, err := strconv.Atoi(strings.TrimSpace(stringOperand)); err == nil && otherOperand.typ() == starlarkTypeInt {
1059 return &eqExpr{
1060 left: otherOperand,
1061 right: &intLiteralExpr{literal: intOperand},
1062 isEq: isEq,
1063 }
1064 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001065 }
1066
Cole Faustf8320212021-11-10 15:05:07 -08001067 return &eqExpr{left: xLeft, right: xRight, isEq: isEq}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001068}
1069
Cole Faustf8320212021-11-10 15:05:07 -08001070// Given an if statement's directive and the left/right starlarkExprs,
1071// check if the starlarkExprs are one of a few hardcoded special cases
Cole Faust9932f752022-02-08 11:56:25 -08001072// that can be converted to a simpler equality expression than simply comparing
Cole Faustf8320212021-11-10 15:05:07 -08001073// the two.
1074func (ctx *parseContext) parseCompareSpecialCases(directive *mkparser.Directive, left starlarkExpr,
1075 right starlarkExpr) (starlarkExpr, bool) {
1076 isEq := !strings.HasSuffix(directive.Name, "neq")
1077
1078 // All the special cases require a call on one side and a
1079 // string literal/variable on the other. Turn the left/right variables into
1080 // call/value variables, and return false if that's not possible.
1081 var value starlarkExpr = nil
1082 call, ok := left.(*callExpr)
1083 if ok {
1084 switch right.(type) {
1085 case *stringLiteralExpr, *variableRefExpr:
1086 value = right
1087 }
1088 } else {
1089 call, _ = right.(*callExpr)
1090 switch left.(type) {
1091 case *stringLiteralExpr, *variableRefExpr:
1092 value = left
1093 }
1094 }
1095
1096 if call == nil || value == nil {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001097 return nil, false
1098 }
Cole Faustf8320212021-11-10 15:05:07 -08001099
Cole Faustf8320212021-11-10 15:05:07 -08001100 switch call.name {
Cole Faust9932f752022-02-08 11:56:25 -08001101 case baseName + ".filter":
1102 return ctx.parseCompareFilterFuncResult(directive, call, value, isEq)
Cole Faust9ebf6e42021-12-13 14:08:34 -08001103 case baseName + ".expand_wildcard":
Cole Faustf8320212021-11-10 15:05:07 -08001104 return ctx.parseCompareWildcardFuncResult(directive, call, value, !isEq), true
Cole Faust9ebf6e42021-12-13 14:08:34 -08001105 case baseName + ".findstring":
Cole Faustf8320212021-11-10 15:05:07 -08001106 return ctx.parseCheckFindstringFuncResult(directive, call, value, !isEq), true
Cole Faust9ebf6e42021-12-13 14:08:34 -08001107 case baseName + ".strip":
Cole Faustf8320212021-11-10 15:05:07 -08001108 return ctx.parseCompareStripFuncResult(directive, call, value, !isEq), true
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001109 }
Cole Faustf8320212021-11-10 15:05:07 -08001110 return nil, false
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001111}
1112
1113func (ctx *parseContext) parseCompareFilterFuncResult(cond *mkparser.Directive,
Cole Faust9932f752022-02-08 11:56:25 -08001114 filterFuncCall *callExpr, xValue starlarkExpr, negate bool) (starlarkExpr, bool) {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001115 // We handle:
Sasha Smundak0554d762021-07-08 18:26:12 -07001116 // * ifeq/ifneq (,$(filter v1 v2 ..., EXPR) becomes if EXPR not in/in ["v1", "v2", ...]
1117 // * ifeq/ifneq (,$(filter EXPR, v1 v2 ...) becomes if EXPR not in/in ["v1", "v2", ...]
Cole Faust9932f752022-02-08 11:56:25 -08001118 if x, ok := xValue.(*stringLiteralExpr); !ok || x.literal != "" {
1119 return nil, false
1120 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001121 xPattern := filterFuncCall.args[0]
1122 xText := filterFuncCall.args[1]
1123 var xInList *stringLiteralExpr
Sasha Smundak0554d762021-07-08 18:26:12 -07001124 var expr starlarkExpr
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001125 var ok bool
Cole Faust9932f752022-02-08 11:56:25 -08001126 if xInList, ok = xPattern.(*stringLiteralExpr); ok && !strings.ContainsRune(xInList.literal, '%') && xText.typ() == starlarkTypeList {
1127 expr = xText
1128 } else if xInList, ok = xText.(*stringLiteralExpr); ok {
1129 expr = xPattern
1130 } else {
1131 return nil, false
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001132 }
Cole Faust9932f752022-02-08 11:56:25 -08001133 slExpr := newStringListExpr(strings.Fields(xInList.literal))
1134 // Generate simpler code for the common cases:
1135 if expr.typ() == starlarkTypeList {
1136 if len(slExpr.items) == 1 {
1137 // Checking that a string belongs to list
1138 return &inExpr{isNot: negate, list: expr, expr: slExpr.items[0]}, true
Sasha Smundak0554d762021-07-08 18:26:12 -07001139 } else {
Cole Faust9932f752022-02-08 11:56:25 -08001140 return nil, false
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001141 }
Cole Faust9932f752022-02-08 11:56:25 -08001142 } else if len(slExpr.items) == 1 {
1143 return &eqExpr{left: expr, right: slExpr.items[0], isEq: !negate}, true
1144 } else {
1145 return &inExpr{isNot: negate, list: newStringListExpr(strings.Fields(xInList.literal)), expr: expr}, true
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001146 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001147}
1148
1149func (ctx *parseContext) parseCompareWildcardFuncResult(directive *mkparser.Directive,
1150 xCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
Sasha Smundak0554d762021-07-08 18:26:12 -07001151 if !isEmptyString(xValue) {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001152 return ctx.newBadExpr(directive, "wildcard result can be compared only to empty: %s", xValue)
1153 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001154 callFunc := baseName + ".file_wildcard_exists"
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001155 if s, ok := xCall.args[0].(*stringLiteralExpr); ok && !strings.ContainsAny(s.literal, "*?{[") {
Cole Faust9ebf6e42021-12-13 14:08:34 -08001156 callFunc = baseName + ".file_exists"
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001157 }
1158 var cc starlarkExpr = &callExpr{name: callFunc, args: xCall.args, returnType: starlarkTypeBool}
1159 if !negate {
1160 cc = &notExpr{cc}
1161 }
1162 return cc
1163}
1164
1165func (ctx *parseContext) parseCheckFindstringFuncResult(directive *mkparser.Directive,
1166 xCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
Sasha Smundak0554d762021-07-08 18:26:12 -07001167 if isEmptyString(xValue) {
1168 return &eqExpr{
1169 left: &callExpr{
1170 object: xCall.args[1],
1171 name: "find",
1172 args: []starlarkExpr{xCall.args[0]},
1173 returnType: starlarkTypeInt,
1174 },
1175 right: &intLiteralExpr{-1},
1176 isEq: !negate,
1177 }
Cole Faust0e9418c2021-12-13 16:33:25 -08001178 } else if s, ok := maybeString(xValue); ok {
1179 if s2, ok := maybeString(xCall.args[0]); ok && s == s2 {
1180 return &eqExpr{
1181 left: &callExpr{
1182 object: xCall.args[1],
1183 name: "find",
1184 args: []starlarkExpr{xCall.args[0]},
1185 returnType: starlarkTypeInt,
1186 },
1187 right: &intLiteralExpr{-1},
1188 isEq: negate,
1189 }
1190 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001191 }
Cole Faust0e9418c2021-12-13 16:33:25 -08001192 return ctx.newBadExpr(directive, "$(findstring) can only be compared to nothing or its first argument")
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001193}
1194
1195func (ctx *parseContext) parseCompareStripFuncResult(directive *mkparser.Directive,
1196 xCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
1197 if _, ok := xValue.(*stringLiteralExpr); !ok {
1198 return ctx.newBadExpr(directive, "strip result can be compared only to string: %s", xValue)
1199 }
1200 return &eqExpr{
1201 left: &callExpr{
1202 name: "strip",
1203 args: xCall.args,
1204 returnType: starlarkTypeString,
1205 },
1206 right: xValue, isEq: !negate}
1207}
1208
Cole Faustf035d402022-03-28 14:02:50 -07001209func (ctx *parseContext) maybeParseFunctionCall(node mkparser.Node, ref *mkparser.MakeString) (name string, args *mkparser.MakeString, ok bool) {
1210 ref.TrimLeftSpaces()
1211 ref.TrimRightSpaces()
1212
1213 words := ref.SplitN(" ", 2)
1214 if !words[0].Const() {
1215 return "", nil, false
1216 }
1217
1218 name = words[0].Dump()
1219 args = mkparser.SimpleMakeString("", words[0].Pos())
1220 if len(words) >= 2 {
1221 args = words[1]
1222 }
1223 args.TrimLeftSpaces()
1224 if name == "call" {
1225 words = args.SplitN(",", 2)
1226 if words[0].Empty() || !words[0].Const() {
1227 return "", nil, false
1228 }
1229 name = words[0].Dump()
1230 if len(words) < 2 {
1231 args = &mkparser.MakeString{}
1232 } else {
1233 args = words[1]
1234 }
1235 }
1236 ok = true
1237 return
1238}
1239
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001240// parses $(...), returning an expression
1241func (ctx *parseContext) parseReference(node mkparser.Node, ref *mkparser.MakeString) starlarkExpr {
1242 ref.TrimLeftSpaces()
1243 ref.TrimRightSpaces()
1244 refDump := ref.Dump()
1245
1246 // Handle only the case where the first (or only) word is constant
1247 words := ref.SplitN(" ", 2)
1248 if !words[0].Const() {
1249 return ctx.newBadExpr(node, "reference is too complex: %s", refDump)
1250 }
1251
1252 // If it is a single word, it can be a simple variable
1253 // reference or a function call
Cole Faustf035d402022-03-28 14:02:50 -07001254 if len(words) == 1 && !isMakeControlFunc(refDump) && refDump != "shell" && refDump != "eval" {
Sasha Smundak65b547e2021-09-17 15:35:41 -07001255 if strings.HasPrefix(refDump, soongNsPrefix) {
1256 // TODO (asmundak): if we find many, maybe handle them.
Cole Faustc00184e2021-11-08 12:08:57 -08001257 return ctx.newBadExpr(node, "SOONG_CONFIG_ variables cannot be referenced, use soong_config_get instead: %s", refDump)
Sasha Smundak65b547e2021-09-17 15:35:41 -07001258 }
Cole Faustc36c9622021-12-07 15:20:45 -08001259 // Handle substitution references: https://www.gnu.org/software/make/manual/html_node/Substitution-Refs.html
1260 if strings.Contains(refDump, ":") {
1261 parts := strings.SplitN(refDump, ":", 2)
1262 substParts := strings.SplitN(parts[1], "=", 2)
1263 if len(substParts) < 2 || strings.Count(substParts[0], "%") > 1 {
1264 return ctx.newBadExpr(node, "Invalid substitution reference")
1265 }
1266 if !strings.Contains(substParts[0], "%") {
1267 if strings.Contains(substParts[1], "%") {
1268 return ctx.newBadExpr(node, "A substitution reference must have a %% in the \"before\" part of the substitution if it has one in the \"after\" part.")
1269 }
1270 substParts[0] = "%" + substParts[0]
1271 substParts[1] = "%" + substParts[1]
1272 }
1273 v := ctx.addVariable(parts[0])
1274 if v == nil {
1275 return ctx.newBadExpr(node, "unknown variable %s", refDump)
1276 }
1277 return &callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -08001278 name: baseName + ".mkpatsubst",
1279 returnType: starlarkTypeString,
Cole Faustc36c9622021-12-07 15:20:45 -08001280 args: []starlarkExpr{
1281 &stringLiteralExpr{literal: substParts[0]},
1282 &stringLiteralExpr{literal: substParts[1]},
Cole Faust3c4fc992022-02-28 16:05:01 -08001283 NewVariableRefExpr(v, ctx.lastAssignment(v) != nil),
Cole Faustc36c9622021-12-07 15:20:45 -08001284 },
1285 }
1286 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001287 if v := ctx.addVariable(refDump); v != nil {
Cole Faust3c4fc992022-02-28 16:05:01 -08001288 return NewVariableRefExpr(v, ctx.lastAssignment(v) != nil)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001289 }
1290 return ctx.newBadExpr(node, "unknown variable %s", refDump)
1291 }
1292
Cole Faustf035d402022-03-28 14:02:50 -07001293 if name, args, ok := ctx.maybeParseFunctionCall(node, ref); ok {
1294 if kf, found := knownFunctions[name]; found {
1295 return kf.parse(ctx, node, args)
Sasha Smundak6609ba72021-07-22 18:32:56 -07001296 } else {
Cole Faustf035d402022-03-28 14:02:50 -07001297 return ctx.newBadExpr(node, "cannot handle invoking %s", name)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001298 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001299 } else {
Cole Faustf035d402022-03-28 14:02:50 -07001300 return ctx.newBadExpr(node, "cannot handle %s", refDump)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001301 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001302}
1303
1304type simpleCallParser struct {
1305 name string
1306 returnType starlarkType
1307 addGlobals bool
Cole Faust1cc08852022-02-28 11:12:08 -08001308 addHandle bool
Cole Faust9ebf6e42021-12-13 14:08:34 -08001309}
1310
1311func (p *simpleCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1312 expr := &callExpr{name: p.name, returnType: p.returnType}
1313 if p.addGlobals {
1314 expr.args = append(expr.args, &globalsExpr{})
1315 }
Cole Faust1cc08852022-02-28 11:12:08 -08001316 if p.addHandle {
1317 expr.args = append(expr.args, &identifierExpr{name: "handle"})
1318 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001319 for _, arg := range args.Split(",") {
1320 arg.TrimLeftSpaces()
1321 arg.TrimRightSpaces()
1322 x := ctx.parseMakeString(node, arg)
1323 if xBad, ok := x.(*badExpr); ok {
1324 return xBad
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001325 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001326 expr.args = append(expr.args, x)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001327 }
1328 return expr
1329}
1330
Cole Faust9ebf6e42021-12-13 14:08:34 -08001331type makeControlFuncParser struct {
1332 name string
1333}
1334
1335func (p *makeControlFuncParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1336 // Make control functions need special treatment as everything
1337 // after the name is a single text argument
1338 x := ctx.parseMakeString(node, args)
1339 if xBad, ok := x.(*badExpr); ok {
1340 return xBad
1341 }
1342 return &callExpr{
1343 name: p.name,
1344 args: []starlarkExpr{
1345 &stringLiteralExpr{ctx.script.mkFile},
1346 x,
1347 },
1348 returnType: starlarkTypeUnknown,
1349 }
1350}
1351
1352type shellCallParser struct{}
1353
1354func (p *shellCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1355 // Shell functions need special treatment as everything
1356 // after the name is a single text argument
1357 x := ctx.parseMakeString(node, args)
1358 if xBad, ok := x.(*badExpr); ok {
1359 return xBad
1360 }
1361 return &callExpr{
1362 name: baseName + ".shell",
1363 args: []starlarkExpr{x},
1364 returnType: starlarkTypeUnknown,
1365 }
1366}
1367
1368type myDirCallParser struct{}
1369
1370func (p *myDirCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1371 if !args.Empty() {
1372 return ctx.newBadExpr(node, "my-dir function cannot have any arguments passed to it.")
1373 }
Cole Faustf5adedc2022-03-18 14:05:06 -07001374 return &stringLiteralExpr{literal: filepath.Dir(ctx.script.mkFile)}
Cole Faust9ebf6e42021-12-13 14:08:34 -08001375}
1376
Cole Faust9ebf6e42021-12-13 14:08:34 -08001377type isProductInListCallParser struct{}
1378
1379func (p *isProductInListCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1380 if args.Empty() {
1381 return ctx.newBadExpr(node, "is-product-in-list requires an argument")
1382 }
1383 return &inExpr{
1384 expr: &variableRefExpr{ctx.addVariable("TARGET_PRODUCT"), true},
1385 list: maybeConvertToStringList(ctx.parseMakeString(node, args)),
1386 isNot: false,
1387 }
1388}
1389
1390type isVendorBoardPlatformCallParser struct{}
1391
1392func (p *isVendorBoardPlatformCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1393 if args.Empty() || !identifierFullMatchRegex.MatchString(args.Dump()) {
1394 return ctx.newBadExpr(node, "cannot handle non-constant argument to is-vendor-board-platform")
1395 }
1396 return &inExpr{
1397 expr: &variableRefExpr{ctx.addVariable("TARGET_BOARD_PLATFORM"), false},
1398 list: &variableRefExpr{ctx.addVariable(args.Dump() + "_BOARD_PLATFORMS"), true},
1399 isNot: false,
1400 }
1401}
1402
1403type isVendorBoardQcomCallParser struct{}
1404
1405func (p *isVendorBoardQcomCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1406 if !args.Empty() {
1407 return ctx.newBadExpr(node, "is-vendor-board-qcom does not accept any arguments")
1408 }
1409 return &inExpr{
1410 expr: &variableRefExpr{ctx.addVariable("TARGET_BOARD_PLATFORM"), false},
1411 list: &variableRefExpr{ctx.addVariable("QCOM_BOARD_PLATFORMS"), true},
1412 isNot: false,
1413 }
1414}
1415
1416type substCallParser struct {
1417 fname string
1418}
1419
1420func (p *substCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001421 words := args.Split(",")
1422 if len(words) != 3 {
Cole Faust9ebf6e42021-12-13 14:08:34 -08001423 return ctx.newBadExpr(node, "%s function should have 3 arguments", p.fname)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001424 }
Sasha Smundak35434ed2021-11-05 16:29:56 -07001425 from := ctx.parseMakeString(node, words[0])
1426 if xBad, ok := from.(*badExpr); ok {
1427 return xBad
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001428 }
Sasha Smundak35434ed2021-11-05 16:29:56 -07001429 to := ctx.parseMakeString(node, words[1])
1430 if xBad, ok := to.(*badExpr); ok {
1431 return xBad
1432 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001433 words[2].TrimLeftSpaces()
1434 words[2].TrimRightSpaces()
1435 obj := ctx.parseMakeString(node, words[2])
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001436 typ := obj.typ()
Cole Faust9ebf6e42021-12-13 14:08:34 -08001437 if typ == starlarkTypeString && p.fname == "subst" {
Sasha Smundak94b41c72021-07-12 18:30:42 -07001438 // Optimization: if it's $(subst from, to, string), emit string.replace(from, to)
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001439 return &callExpr{
1440 object: obj,
1441 name: "replace",
Sasha Smundak35434ed2021-11-05 16:29:56 -07001442 args: []starlarkExpr{from, to},
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001443 returnType: typ,
1444 }
1445 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001446 return &callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -08001447 name: baseName + ".mk" + p.fname,
Sasha Smundak35434ed2021-11-05 16:29:56 -07001448 args: []starlarkExpr{from, to, obj},
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001449 returnType: obj.typ(),
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001450 }
1451}
1452
Cole Faust9ebf6e42021-12-13 14:08:34 -08001453type ifCallParser struct{}
1454
1455func (p *ifCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Cole Faust4eadba72021-12-07 11:54:52 -08001456 words := args.Split(",")
1457 if len(words) != 2 && len(words) != 3 {
1458 return ctx.newBadExpr(node, "if function should have 2 or 3 arguments, found "+strconv.Itoa(len(words)))
1459 }
1460 condition := ctx.parseMakeString(node, words[0])
1461 ifTrue := ctx.parseMakeString(node, words[1])
1462 var ifFalse starlarkExpr
1463 if len(words) == 3 {
1464 ifFalse = ctx.parseMakeString(node, words[2])
1465 } else {
1466 switch ifTrue.typ() {
1467 case starlarkTypeList:
1468 ifFalse = &listExpr{items: []starlarkExpr{}}
1469 case starlarkTypeInt:
1470 ifFalse = &intLiteralExpr{literal: 0}
1471 case starlarkTypeBool:
1472 ifFalse = &boolLiteralExpr{literal: false}
1473 default:
1474 ifFalse = &stringLiteralExpr{literal: ""}
1475 }
1476 }
1477 return &ifExpr{
1478 condition,
1479 ifTrue,
1480 ifFalse,
1481 }
1482}
1483
Cole Faustf035d402022-03-28 14:02:50 -07001484type ifCallNodeParser struct{}
Cole Faust9ebf6e42021-12-13 14:08:34 -08001485
Cole Faustf035d402022-03-28 14:02:50 -07001486func (p *ifCallNodeParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) []starlarkNode {
1487 words := args.Split(",")
1488 if len(words) != 2 && len(words) != 3 {
1489 return []starlarkNode{ctx.newBadNode(node, "if function should have 2 or 3 arguments, found "+strconv.Itoa(len(words)))}
1490 }
1491
1492 ifn := &ifNode{expr: ctx.parseMakeString(node, words[0])}
1493 cases := []*switchCase{
1494 {
1495 gate: ifn,
1496 nodes: ctx.parseNodeMakeString(node, words[1]),
1497 },
1498 }
1499 if len(words) == 3 {
1500 cases = append(cases, &switchCase{
1501 gate: &elseNode{},
1502 nodes: ctx.parseNodeMakeString(node, words[2]),
1503 })
1504 }
1505 if len(cases) == 2 {
1506 if len(cases[1].nodes) == 0 {
1507 // Remove else branch if it has no contents
1508 cases = cases[:1]
1509 } else if len(cases[0].nodes) == 0 {
1510 // If the if branch has no contents but the else does,
1511 // move them to the if and negate its condition
1512 ifn.expr = negateExpr(ifn.expr)
1513 cases[0].nodes = cases[1].nodes
1514 cases = cases[:1]
1515 }
1516 }
1517
1518 return []starlarkNode{&switchNode{ssCases: cases}}
1519}
1520
1521type foreachCallParser struct{}
1522
1523func (p *foreachCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Cole Faustb0d32ab2021-12-09 14:00:59 -08001524 words := args.Split(",")
1525 if len(words) != 3 {
1526 return ctx.newBadExpr(node, "foreach function should have 3 arguments, found "+strconv.Itoa(len(words)))
1527 }
1528 if !words[0].Const() || words[0].Empty() || !identifierFullMatchRegex.MatchString(words[0].Strings[0]) {
1529 return ctx.newBadExpr(node, "first argument to foreach function must be a simple string identifier")
1530 }
1531 loopVarName := words[0].Strings[0]
1532 list := ctx.parseMakeString(node, words[1])
1533 action := ctx.parseMakeString(node, words[2]).transform(func(expr starlarkExpr) starlarkExpr {
1534 if varRefExpr, ok := expr.(*variableRefExpr); ok && varRefExpr.ref.name() == loopVarName {
1535 return &identifierExpr{loopVarName}
1536 }
1537 return nil
1538 })
1539
1540 if list.typ() != starlarkTypeList {
1541 list = &callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -08001542 name: baseName + ".words",
1543 returnType: starlarkTypeList,
Cole Faustb0d32ab2021-12-09 14:00:59 -08001544 args: []starlarkExpr{list},
1545 }
1546 }
1547
1548 return &foreachExpr{
1549 varName: loopVarName,
1550 list: list,
1551 action: action,
1552 }
1553}
1554
Cole Faustf035d402022-03-28 14:02:50 -07001555func transformNode(node starlarkNode, transformer func(expr starlarkExpr) starlarkExpr) {
1556 switch a := node.(type) {
1557 case *ifNode:
1558 a.expr = a.expr.transform(transformer)
1559 case *switchCase:
1560 transformNode(a.gate, transformer)
1561 for _, n := range a.nodes {
1562 transformNode(n, transformer)
1563 }
1564 case *switchNode:
1565 for _, n := range a.ssCases {
1566 transformNode(n, transformer)
1567 }
1568 case *exprNode:
1569 a.expr = a.expr.transform(transformer)
1570 case *assignmentNode:
1571 a.value = a.value.transform(transformer)
1572 case *foreachNode:
1573 a.list = a.list.transform(transformer)
1574 for _, n := range a.actions {
1575 transformNode(n, transformer)
1576 }
1577 }
1578}
1579
1580type foreachCallNodeParser struct{}
1581
1582func (p *foreachCallNodeParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) []starlarkNode {
1583 words := args.Split(",")
1584 if len(words) != 3 {
1585 return []starlarkNode{ctx.newBadNode(node, "foreach function should have 3 arguments, found "+strconv.Itoa(len(words)))}
1586 }
1587 if !words[0].Const() || words[0].Empty() || !identifierFullMatchRegex.MatchString(words[0].Strings[0]) {
1588 return []starlarkNode{ctx.newBadNode(node, "first argument to foreach function must be a simple string identifier")}
1589 }
1590
1591 loopVarName := words[0].Strings[0]
1592
1593 list := ctx.parseMakeString(node, words[1])
1594 if list.typ() != starlarkTypeList {
1595 list = &callExpr{
1596 name: baseName + ".words",
1597 returnType: starlarkTypeList,
1598 args: []starlarkExpr{list},
1599 }
1600 }
1601
1602 actions := ctx.parseNodeMakeString(node, words[2])
1603 // TODO(colefaust): Replace transforming code with something more elegant
1604 for _, action := range actions {
1605 transformNode(action, func(expr starlarkExpr) starlarkExpr {
1606 if varRefExpr, ok := expr.(*variableRefExpr); ok && varRefExpr.ref.name() == loopVarName {
1607 return &identifierExpr{loopVarName}
1608 }
1609 return nil
1610 })
1611 }
1612
1613 return []starlarkNode{&foreachNode{
1614 varName: loopVarName,
1615 list: list,
1616 actions: actions,
1617 }}
1618}
1619
Cole Faust9ebf6e42021-12-13 14:08:34 -08001620type wordCallParser struct{}
1621
1622func (p *wordCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001623 words := args.Split(",")
1624 if len(words) != 2 {
1625 return ctx.newBadExpr(node, "word function should have 2 arguments")
1626 }
1627 var index uint64 = 0
1628 if words[0].Const() {
1629 index, _ = strconv.ParseUint(strings.TrimSpace(words[0].Strings[0]), 10, 64)
1630 }
1631 if index < 1 {
1632 return ctx.newBadExpr(node, "word index should be constant positive integer")
1633 }
1634 words[1].TrimLeftSpaces()
1635 words[1].TrimRightSpaces()
1636 array := ctx.parseMakeString(node, words[1])
1637 if xBad, ok := array.(*badExpr); ok {
1638 return xBad
1639 }
1640 if array.typ() != starlarkTypeList {
1641 array = &callExpr{object: array, name: "split", returnType: starlarkTypeList}
1642 }
Cole Faustb0d32ab2021-12-09 14:00:59 -08001643 return &indexExpr{array, &intLiteralExpr{int(index - 1)}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001644}
1645
Cole Faust9ebf6e42021-12-13 14:08:34 -08001646type firstOrLastwordCallParser struct {
1647 isLastWord bool
1648}
1649
1650func (p *firstOrLastwordCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Sasha Smundak16e07732021-07-23 11:38:23 -07001651 arg := ctx.parseMakeString(node, args)
1652 if bad, ok := arg.(*badExpr); ok {
1653 return bad
1654 }
1655 index := &intLiteralExpr{0}
Cole Faust9ebf6e42021-12-13 14:08:34 -08001656 if p.isLastWord {
Sasha Smundak16e07732021-07-23 11:38:23 -07001657 if v, ok := arg.(*variableRefExpr); ok && v.ref.name() == "MAKEFILE_LIST" {
1658 return &stringLiteralExpr{ctx.script.mkFile}
1659 }
1660 index.literal = -1
1661 }
1662 if arg.typ() == starlarkTypeList {
1663 return &indexExpr{arg, index}
1664 }
1665 return &indexExpr{&callExpr{object: arg, name: "split", returnType: starlarkTypeList}, index}
1666}
1667
Cole Faustb1103e22022-01-06 15:22:05 -08001668func parseIntegerArguments(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString, expectedArgs int) ([]starlarkExpr, error) {
1669 parsedArgs := make([]starlarkExpr, 0)
1670 for _, arg := range args.Split(",") {
1671 expr := ctx.parseMakeString(node, arg)
1672 if expr.typ() == starlarkTypeList {
1673 return nil, fmt.Errorf("argument to math argument has type list, which cannot be converted to int")
1674 }
1675 if s, ok := maybeString(expr); ok {
1676 intVal, err := strconv.Atoi(strings.TrimSpace(s))
1677 if err != nil {
1678 return nil, err
1679 }
1680 expr = &intLiteralExpr{literal: intVal}
1681 } else if expr.typ() != starlarkTypeInt {
1682 expr = &callExpr{
1683 name: "int",
1684 args: []starlarkExpr{expr},
1685 returnType: starlarkTypeInt,
1686 }
1687 }
1688 parsedArgs = append(parsedArgs, expr)
1689 }
1690 if len(parsedArgs) != expectedArgs {
1691 return nil, fmt.Errorf("function should have %d arguments", expectedArgs)
1692 }
1693 return parsedArgs, nil
1694}
1695
1696type mathComparisonCallParser struct {
1697 op string
1698}
1699
1700func (p *mathComparisonCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1701 parsedArgs, err := parseIntegerArguments(ctx, node, args, 2)
1702 if err != nil {
1703 return ctx.newBadExpr(node, err.Error())
1704 }
1705 return &binaryOpExpr{
1706 left: parsedArgs[0],
1707 right: parsedArgs[1],
1708 op: p.op,
1709 returnType: starlarkTypeBool,
1710 }
1711}
1712
1713type mathMaxOrMinCallParser struct {
1714 function string
1715}
1716
1717func (p *mathMaxOrMinCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1718 parsedArgs, err := parseIntegerArguments(ctx, node, args, 2)
1719 if err != nil {
1720 return ctx.newBadExpr(node, err.Error())
1721 }
1722 return &callExpr{
1723 object: nil,
1724 name: p.function,
1725 args: parsedArgs,
1726 returnType: starlarkTypeInt,
1727 }
1728}
1729
Cole Faustf035d402022-03-28 14:02:50 -07001730type evalNodeParser struct{}
1731
1732func (p *evalNodeParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) []starlarkNode {
1733 parser := mkparser.NewParser("Eval expression", strings.NewReader(args.Dump()))
1734 nodes, errs := parser.Parse()
1735 if errs != nil {
1736 return []starlarkNode{ctx.newBadNode(node, "Unable to parse eval statement")}
1737 }
1738
1739 if len(nodes) == 0 {
1740 return []starlarkNode{}
1741 } else if len(nodes) == 1 {
1742 switch n := nodes[0].(type) {
1743 case *mkparser.Assignment:
1744 if n.Name.Const() {
1745 return ctx.handleAssignment(n)
1746 }
1747 case *mkparser.Comment:
1748 return []starlarkNode{&commentNode{strings.TrimSpace("#" + n.Comment)}}
1749 }
1750 }
1751
1752 return []starlarkNode{ctx.newBadNode(node, "Eval expression too complex; only assignments and comments are supported")}
1753}
1754
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001755func (ctx *parseContext) parseMakeString(node mkparser.Node, mk *mkparser.MakeString) starlarkExpr {
1756 if mk.Const() {
1757 return &stringLiteralExpr{mk.Dump()}
1758 }
1759 if mkRef, ok := mk.SingleVariable(); ok {
1760 return ctx.parseReference(node, mkRef)
1761 }
1762 // If we reached here, it's neither string literal nor a simple variable,
1763 // we need a full-blown interpolation node that will generate
1764 // "a%b%c" % (X, Y) for a$(X)b$(Y)c
Cole Faustfc438682021-12-14 12:46:32 -08001765 parts := make([]starlarkExpr, len(mk.Variables)+len(mk.Strings))
1766 for i := 0; i < len(parts); i++ {
1767 if i%2 == 0 {
1768 parts[i] = &stringLiteralExpr{literal: mk.Strings[i/2]}
1769 } else {
1770 parts[i] = ctx.parseReference(node, mk.Variables[i/2].Name)
1771 if x, ok := parts[i].(*badExpr); ok {
1772 return x
1773 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001774 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001775 }
Cole Faustfc438682021-12-14 12:46:32 -08001776 return NewInterpolateExpr(parts)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001777}
1778
Cole Faustf035d402022-03-28 14:02:50 -07001779func (ctx *parseContext) parseNodeMakeString(node mkparser.Node, mk *mkparser.MakeString) []starlarkNode {
1780 // Discard any constant values in the make string, as they would be top level
1781 // string literals and do nothing.
1782 result := make([]starlarkNode, 0, len(mk.Variables))
1783 for i := range mk.Variables {
1784 result = append(result, ctx.handleVariable(&mk.Variables[i])...)
1785 }
1786 return result
1787}
1788
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001789// Handles the statements whose treatment is the same in all contexts: comment,
1790// assignment, variable (which is a macro call in reality) and all constructs that
1791// do not handle in any context ('define directive and any unrecognized stuff).
Cole Faustdd569ae2022-01-31 15:48:29 -08001792func (ctx *parseContext) handleSimpleStatement(node mkparser.Node) []starlarkNode {
1793 var result []starlarkNode
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001794 switch x := node.(type) {
1795 case *mkparser.Comment:
Cole Faustdd569ae2022-01-31 15:48:29 -08001796 if n, handled := ctx.maybeHandleAnnotation(x); handled && n != nil {
1797 result = []starlarkNode{n}
1798 } else if !handled {
1799 result = []starlarkNode{&commentNode{strings.TrimSpace("#" + x.Comment)}}
Cole Faust7940c6a2022-01-31 15:54:05 -08001800 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001801 case *mkparser.Assignment:
Cole Faustdd569ae2022-01-31 15:48:29 -08001802 result = ctx.handleAssignment(x)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001803 case *mkparser.Variable:
Cole Faustdd569ae2022-01-31 15:48:29 -08001804 result = ctx.handleVariable(x)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001805 case *mkparser.Directive:
1806 switch x.Name {
1807 case "define":
Cole Faustdd569ae2022-01-31 15:48:29 -08001808 if res := ctx.maybeHandleDefine(x); res != nil {
1809 result = []starlarkNode{res}
1810 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001811 case "include", "-include":
Cole Faustdd569ae2022-01-31 15:48:29 -08001812 result = ctx.handleInclude(node, ctx.parseMakeString(node, x.Args), x.Name[0] != '-')
Cole Faust591a1fe2021-11-08 15:37:57 -08001813 case "ifeq", "ifneq", "ifdef", "ifndef":
Cole Faustdd569ae2022-01-31 15:48:29 -08001814 result = []starlarkNode{ctx.handleIfBlock(x)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001815 default:
Cole Faustdd569ae2022-01-31 15:48:29 -08001816 result = []starlarkNode{ctx.newBadNode(x, "unexpected directive %s", x.Name)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001817 }
1818 default:
Cole Faustdd569ae2022-01-31 15:48:29 -08001819 result = []starlarkNode{ctx.newBadNode(x, "unsupported line %s", strings.ReplaceAll(x.Dump(), "\n", "\n#"))}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001820 }
Cole Faust6c934f62022-01-06 15:51:12 -08001821
1822 // Clear the includeTops after each non-comment statement
1823 // so that include annotations placed on certain statements don't apply
1824 // globally for the rest of the makefile was well.
Cole Faustf92c9f22022-03-14 14:35:50 -07001825 if _, wasComment := node.(*mkparser.Comment); !wasComment {
1826 ctx.atTopOfMakefile = false
Cole Faust6c934f62022-01-06 15:51:12 -08001827 ctx.includeTops = []string{}
1828 }
Cole Faustdd569ae2022-01-31 15:48:29 -08001829
1830 if result == nil {
1831 result = []starlarkNode{}
1832 }
Cole Faustf035d402022-03-28 14:02:50 -07001833
Cole Faustdd569ae2022-01-31 15:48:29 -08001834 return result
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001835}
1836
Cole Faustf92c9f22022-03-14 14:35:50 -07001837// The types allowed in a type_hint
1838var typeHintMap = map[string]starlarkType{
1839 "string": starlarkTypeString,
1840 "list": starlarkTypeList,
1841}
1842
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001843// Processes annotation. An annotation is a comment that starts with #RBC# and provides
1844// a conversion hint -- say, where to look for the dynamically calculated inherit/include
Cole Faust7940c6a2022-01-31 15:54:05 -08001845// paths. Returns true if the comment was a successfully-handled annotation.
Cole Faustdd569ae2022-01-31 15:48:29 -08001846func (ctx *parseContext) maybeHandleAnnotation(cnode *mkparser.Comment) (starlarkNode, bool) {
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001847 maybeTrim := func(s, prefix string) (string, bool) {
1848 if strings.HasPrefix(s, prefix) {
1849 return strings.TrimSpace(strings.TrimPrefix(s, prefix)), true
1850 }
1851 return s, false
1852 }
1853 annotation, ok := maybeTrim(cnode.Comment, annotationCommentPrefix)
1854 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -08001855 return nil, false
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001856 }
1857 if p, ok := maybeTrim(annotation, "include_top"); ok {
Cole Faustf7ed5342021-12-21 14:15:12 -08001858 // Don't allow duplicate include tops, because then we will generate
1859 // invalid starlark code. (duplicate keys in the _entry dictionary)
1860 for _, top := range ctx.includeTops {
1861 if top == p {
Cole Faustdd569ae2022-01-31 15:48:29 -08001862 return nil, true
Cole Faustf7ed5342021-12-21 14:15:12 -08001863 }
1864 }
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001865 ctx.includeTops = append(ctx.includeTops, p)
Cole Faustdd569ae2022-01-31 15:48:29 -08001866 return nil, true
Cole Faustf92c9f22022-03-14 14:35:50 -07001867 } else if p, ok := maybeTrim(annotation, "type_hint"); ok {
1868 // Type hints must come at the beginning the file, to avoid confusion
1869 // if a type hint was specified later and thus only takes effect for half
1870 // of the file.
1871 if !ctx.atTopOfMakefile {
1872 return ctx.newBadNode(cnode, "type_hint annotations must come before the first Makefile statement"), true
1873 }
1874
1875 parts := strings.Fields(p)
1876 if len(parts) <= 1 {
1877 return ctx.newBadNode(cnode, "Invalid type_hint annotation: %s. Must be a variable type followed by a list of variables of that type", p), true
1878 }
1879
1880 var varType starlarkType
1881 if varType, ok = typeHintMap[parts[0]]; !ok {
1882 varType = starlarkTypeUnknown
1883 }
1884 if varType == starlarkTypeUnknown {
1885 return ctx.newBadNode(cnode, "Invalid type_hint annotation. Only list/string types are accepted, found %s", parts[0]), true
1886 }
1887
1888 for _, name := range parts[1:] {
1889 // Don't allow duplicate type hints
1890 if _, ok := ctx.typeHints[name]; ok {
1891 return ctx.newBadNode(cnode, "Duplicate type hint for variable %s", name), true
1892 }
1893 ctx.typeHints[name] = varType
1894 }
1895 return nil, true
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001896 }
Cole Faustdd569ae2022-01-31 15:48:29 -08001897 return ctx.newBadNode(cnode, "unsupported annotation %s", cnode.Comment), true
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001898}
1899
1900func (ctx *parseContext) loadedModulePath(path string) string {
1901 // During the transition to Roboleaf some of the product configuration files
1902 // will be converted and checked in while the others will be generated on the fly
1903 // and run. The runner (rbcrun application) accommodates this by allowing three
1904 // different ways to specify the loaded file location:
1905 // 1) load(":<file>",...) loads <file> from the same directory
1906 // 2) load("//path/relative/to/source/root:<file>", ...) loads <file> source tree
1907 // 3) load("/absolute/path/to/<file> absolute path
1908 // If the file being generated and the file it wants to load are in the same directory,
1909 // generate option 1.
1910 // Otherwise, if output directory is not specified, generate 2)
1911 // Finally, if output directory has been specified and the file being generated and
1912 // the file it wants to load from are in the different directories, generate 2) or 3):
1913 // * if the file being loaded exists in the source tree, generate 2)
1914 // * otherwise, generate 3)
1915 // Finally, figure out the loaded module path and name and create a node for it
1916 loadedModuleDir := filepath.Dir(path)
1917 base := filepath.Base(path)
1918 loadedModuleName := strings.TrimSuffix(base, filepath.Ext(base)) + ctx.outputSuffix
1919 if loadedModuleDir == filepath.Dir(ctx.script.mkFile) {
1920 return ":" + loadedModuleName
1921 }
1922 if ctx.outputDir == "" {
1923 return fmt.Sprintf("//%s:%s", loadedModuleDir, loadedModuleName)
1924 }
1925 if _, err := os.Stat(filepath.Join(loadedModuleDir, loadedModuleName)); err == nil {
1926 return fmt.Sprintf("//%s:%s", loadedModuleDir, loadedModuleName)
1927 }
1928 return filepath.Join(ctx.outputDir, loadedModuleDir, loadedModuleName)
1929}
1930
Sasha Smundak3deb9682021-07-26 18:42:25 -07001931func (ctx *parseContext) addSoongNamespace(ns string) {
1932 if _, ok := ctx.soongNamespaces[ns]; ok {
1933 return
1934 }
1935 ctx.soongNamespaces[ns] = make(map[string]bool)
1936}
1937
1938func (ctx *parseContext) hasSoongNamespace(name string) bool {
1939 _, ok := ctx.soongNamespaces[name]
1940 return ok
1941}
1942
1943func (ctx *parseContext) updateSoongNamespace(replace bool, namespaceName string, varNames []string) {
1944 ctx.addSoongNamespace(namespaceName)
1945 vars := ctx.soongNamespaces[namespaceName]
1946 if replace {
1947 vars = make(map[string]bool)
1948 ctx.soongNamespaces[namespaceName] = vars
1949 }
1950 for _, v := range varNames {
1951 vars[v] = true
1952 }
1953}
1954
1955func (ctx *parseContext) hasNamespaceVar(namespaceName string, varName string) bool {
1956 vars, ok := ctx.soongNamespaces[namespaceName]
1957 if ok {
1958 _, ok = vars[varName]
1959 }
1960 return ok
1961}
1962
Sasha Smundak422b6142021-11-11 18:31:59 -08001963func (ctx *parseContext) errorLocation(node mkparser.Node) ErrorLocation {
1964 return ErrorLocation{ctx.script.mkFile, ctx.script.nodeLocator(node.Pos())}
1965}
1966
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001967func (ss *StarlarkScript) String() string {
1968 return NewGenerateContext(ss).emit()
1969}
1970
1971func (ss *StarlarkScript) SubConfigFiles() []string {
Sasha Smundak6609ba72021-07-22 18:32:56 -07001972
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001973 var subs []string
1974 for _, src := range ss.inherited {
1975 subs = append(subs, src.originalPath)
1976 }
1977 return subs
1978}
1979
1980func (ss *StarlarkScript) HasErrors() bool {
1981 return ss.hasErrors
1982}
1983
1984// Convert reads and parses a makefile. If successful, parsed tree
1985// is returned and then can be passed to String() to get the generated
1986// Starlark file.
1987func Convert(req Request) (*StarlarkScript, error) {
1988 reader := req.Reader
1989 if reader == nil {
1990 mkContents, err := ioutil.ReadFile(req.MkFile)
1991 if err != nil {
1992 return nil, err
1993 }
1994 reader = bytes.NewBuffer(mkContents)
1995 }
1996 parser := mkparser.NewParser(req.MkFile, reader)
1997 nodes, errs := parser.Parse()
1998 if len(errs) > 0 {
1999 for _, e := range errs {
2000 fmt.Fprintln(os.Stderr, "ERROR:", e)
2001 }
2002 return nil, fmt.Errorf("bad makefile %s", req.MkFile)
2003 }
2004 starScript := &StarlarkScript{
Sasha Smundak422b6142021-11-11 18:31:59 -08002005 moduleName: moduleNameForFile(req.MkFile),
2006 mkFile: req.MkFile,
Sasha Smundak422b6142021-11-11 18:31:59 -08002007 traceCalls: req.TraceCalls,
2008 sourceFS: req.SourceFS,
2009 makefileFinder: req.MakefileFinder,
2010 nodeLocator: func(pos mkparser.Pos) int { return parser.Unpack(pos).Line },
Cole Faustdd569ae2022-01-31 15:48:29 -08002011 nodes: make([]starlarkNode, 0),
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002012 }
2013 ctx := newParseContext(starScript, nodes)
2014 ctx.outputSuffix = req.OutputSuffix
2015 ctx.outputDir = req.OutputDir
2016 ctx.errorLogger = req.ErrorLogger
2017 if len(req.TracedVariables) > 0 {
2018 ctx.tracedVariables = make(map[string]bool)
2019 for _, v := range req.TracedVariables {
2020 ctx.tracedVariables[v] = true
2021 }
2022 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002023 for ctx.hasNodes() && ctx.fatalError == nil {
Cole Faustdd569ae2022-01-31 15:48:29 -08002024 starScript.nodes = append(starScript.nodes, ctx.handleSimpleStatement(ctx.getNode())...)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002025 }
2026 if ctx.fatalError != nil {
2027 return nil, ctx.fatalError
2028 }
2029 return starScript, nil
2030}
2031
Cole Faust864028a2021-12-01 13:43:17 -08002032func Launcher(mainModuleUri, inputVariablesUri, mainModuleName string) string {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002033 var buf bytes.Buffer
2034 fmt.Fprintf(&buf, "load(%q, %q)\n", baseUri, baseName)
Cole Faust864028a2021-12-01 13:43:17 -08002035 fmt.Fprintf(&buf, "load(%q, input_variables_init = \"init\")\n", inputVariablesUri)
Sasha Smundakd7d07ad2021-09-10 15:42:34 -07002036 fmt.Fprintf(&buf, "load(%q, \"init\")\n", mainModuleUri)
Cole Faust864028a2021-12-01 13:43:17 -08002037 fmt.Fprintf(&buf, "%s(%s(%q, init, input_variables_init))\n", cfnPrintVars, cfnMain, mainModuleName)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002038 return buf.String()
2039}
2040
Cole Faust6ed7cb42021-10-07 17:08:46 -07002041func BoardLauncher(mainModuleUri string, inputVariablesUri string) string {
2042 var buf bytes.Buffer
2043 fmt.Fprintf(&buf, "load(%q, %q)\n", baseUri, baseName)
2044 fmt.Fprintf(&buf, "load(%q, \"init\")\n", mainModuleUri)
2045 fmt.Fprintf(&buf, "load(%q, input_variables_init = \"init\")\n", inputVariablesUri)
Cole Fausta0604662022-02-28 11:53:58 -08002046 fmt.Fprintf(&buf, "%s(%s(init, input_variables_init))\n", cfnPrintVars, cfnBoardMain)
Cole Faust6ed7cb42021-10-07 17:08:46 -07002047 return buf.String()
2048}
2049
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002050func MakePath2ModuleName(mkPath string) string {
2051 return strings.TrimSuffix(mkPath, filepath.Ext(mkPath))
2052}