blob: 5ce031daa9f0abfc86eb0edf4ce202d28e18adc2 [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 Faust95b95cb2022-04-05 16:37:39 -0700113 "sort": &simpleCallParser{name: baseName + ".mksort", returnType: starlarkTypeList},
Cole Faust1cc08852022-02-28 11:12:08 -0800114 "strip": &simpleCallParser{name: baseName + ".mkstrip", returnType: starlarkTypeString},
Cole Faust9ebf6e42021-12-13 14:08:34 -0800115 "subst": &substCallParser{fname: "subst"},
116 "warning": &makeControlFuncParser{name: baseName + ".mkwarning"},
117 "word": &wordCallParser{},
Cole Faust1cc08852022-02-28 11:12:08 -0800118 "wildcard": &simpleCallParser{name: baseName + ".expand_wildcard", returnType: starlarkTypeList},
Cole Faust9ebf6e42021-12-13 14:08:34 -0800119}
120
Cole Faustf035d402022-03-28 14:02:50 -0700121// The same as knownFunctions, but returns a []starlarkNode instead of a starlarkExpr
122var knownNodeFunctions = map[string]interface {
123 parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) []starlarkNode
124}{
125 "eval": &evalNodeParser{},
126 "if": &ifCallNodeParser{},
127 "inherit-product": &inheritProductCallParser{loadAlways: true},
128 "inherit-product-if-exists": &inheritProductCallParser{loadAlways: false},
129 "foreach": &foreachCallNodeParser{},
130}
131
Cole Faust9ebf6e42021-12-13 14:08:34 -0800132// These are functions that we don't implement conversions for, but
133// we allow seeing their definitions in the product config files.
134var ignoredDefines = map[string]bool{
135 "find-word-in-list": true, // internal macro
136 "get-vendor-board-platforms": true, // internal macro, used by is-board-platform, etc.
137 "is-android-codename": true, // unused by product config
138 "is-android-codename-in-list": true, // unused by product config
139 "is-chipset-in-board-platform": true, // unused by product config
140 "is-chipset-prefix-in-board-platform": true, // unused by product config
141 "is-not-board-platform": true, // defined but never used
142 "is-platform-sdk-version-at-least": true, // unused by product config
143 "match-prefix": true, // internal macro
144 "match-word": true, // internal macro
145 "match-word-in-list": true, // internal macro
146 "tb-modules": true, // defined in hardware/amlogic/tb_modules/tb_detect.mk, unused
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800147}
148
Cole Faustb0d32ab2021-12-09 14:00:59 -0800149var identifierFullMatchRegex = regexp.MustCompile("^[a-zA-Z_][a-zA-Z0-9_]*$")
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800150
151// Conversion request parameters
152type Request struct {
Sasha Smundak422b6142021-11-11 18:31:59 -0800153 MkFile string // file to convert
154 Reader io.Reader // if set, read input from this stream instead
Sasha Smundak422b6142021-11-11 18:31:59 -0800155 OutputSuffix string // generated Starlark files suffix
156 OutputDir string // if set, root of the output hierarchy
157 ErrorLogger ErrorLogger
158 TracedVariables []string // trace assignment to these variables
159 TraceCalls bool
160 SourceFS fs.FS
161 MakefileFinder MakefileFinder
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800162}
163
Sasha Smundak7d934b92021-11-10 12:20:01 -0800164// ErrorLogger prints errors and gathers error statistics.
165// Its NewError function is called on every error encountered during the conversion.
166type ErrorLogger interface {
Sasha Smundak422b6142021-11-11 18:31:59 -0800167 NewError(el ErrorLocation, node mkparser.Node, text string, args ...interface{})
168}
169
170type ErrorLocation struct {
171 MkFile string
172 MkLine int
173}
174
175func (el ErrorLocation) String() string {
176 return fmt.Sprintf("%s:%d", el.MkFile, el.MkLine)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800177}
178
179// Derives module name for a given file. It is base name
180// (file name without suffix), with some characters replaced to make it a Starlark identifier
181func moduleNameForFile(mkFile string) string {
182 base := strings.TrimSuffix(filepath.Base(mkFile), filepath.Ext(mkFile))
183 // TODO(asmundak): what else can be in the product file names?
Sasha Smundak6609ba72021-07-22 18:32:56 -0700184 return strings.NewReplacer("-", "_", ".", "_").Replace(base)
185
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800186}
187
188func cloneMakeString(mkString *mkparser.MakeString) *mkparser.MakeString {
189 r := &mkparser.MakeString{StringPos: mkString.StringPos}
190 r.Strings = append(r.Strings, mkString.Strings...)
191 r.Variables = append(r.Variables, mkString.Variables...)
192 return r
193}
194
195func isMakeControlFunc(s string) bool {
196 return s == "error" || s == "warning" || s == "info"
197}
198
199// Starlark output generation context
200type generationContext struct {
201 buf strings.Builder
202 starScript *StarlarkScript
203 indentLevel int
204 inAssignment bool
205 tracedCount int
206}
207
208func NewGenerateContext(ss *StarlarkScript) *generationContext {
209 return &generationContext{starScript: ss}
210}
211
212// emit returns generated script
213func (gctx *generationContext) emit() string {
214 ss := gctx.starScript
215
216 // The emitted code has the following layout:
217 // <initial comments>
218 // preamble, i.e.,
219 // load statement for the runtime support
220 // load statement for each unique submodule pulled in by this one
221 // def init(g, handle):
222 // cfg = rblf.cfg(handle)
223 // <statements>
224 // <warning if conversion was not clean>
225
226 iNode := len(ss.nodes)
227 for i, node := range ss.nodes {
228 if _, ok := node.(*commentNode); !ok {
229 iNode = i
230 break
231 }
232 node.emit(gctx)
233 }
234
235 gctx.emitPreamble()
236
237 gctx.newLine()
238 // The arguments passed to the init function are the global dictionary
239 // ('g') and the product configuration dictionary ('cfg')
240 gctx.write("def init(g, handle):")
241 gctx.indentLevel++
242 if gctx.starScript.traceCalls {
243 gctx.newLine()
244 gctx.writef(`print(">%s")`, gctx.starScript.mkFile)
245 }
246 gctx.newLine()
247 gctx.writef("cfg = %s(handle)", cfnGetCfg)
248 for _, node := range ss.nodes[iNode:] {
249 node.emit(gctx)
250 }
251
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800252 if gctx.starScript.traceCalls {
253 gctx.newLine()
254 gctx.writef(`print("<%s")`, gctx.starScript.mkFile)
255 }
256 gctx.indentLevel--
257 gctx.write("\n")
258 return gctx.buf.String()
259}
260
261func (gctx *generationContext) emitPreamble() {
262 gctx.newLine()
263 gctx.writef("load(%q, %q)", baseUri, baseName)
264 // Emit exactly one load statement for each URI.
265 loadedSubConfigs := make(map[string]string)
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800266 for _, mi := range gctx.starScript.inherited {
267 uri := mi.path
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800268 if m, ok := loadedSubConfigs[uri]; ok {
269 // No need to emit load statement, but fix module name.
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800270 mi.moduleLocalName = m
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800271 continue
272 }
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800273 if mi.optional || mi.missing {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800274 uri += "|init"
275 }
276 gctx.newLine()
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800277 gctx.writef("load(%q, %s = \"init\")", uri, mi.entryName())
278 loadedSubConfigs[uri] = mi.moduleLocalName
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800279 }
280 gctx.write("\n")
281}
282
283func (gctx *generationContext) emitPass() {
284 gctx.newLine()
285 gctx.write("pass")
286}
287
288func (gctx *generationContext) write(ss ...string) {
289 for _, s := range ss {
290 gctx.buf.WriteString(s)
291 }
292}
293
294func (gctx *generationContext) writef(format string, args ...interface{}) {
295 gctx.write(fmt.Sprintf(format, args...))
296}
297
298func (gctx *generationContext) newLine() {
299 if gctx.buf.Len() == 0 {
300 return
301 }
302 gctx.write("\n")
303 gctx.writef("%*s", 2*gctx.indentLevel, "")
304}
305
Sasha Smundak422b6142021-11-11 18:31:59 -0800306func (gctx *generationContext) emitConversionError(el ErrorLocation, message string) {
307 gctx.writef(`rblf.mk2rbc_error("%s", %q)`, el, message)
308}
309
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800310func (gctx *generationContext) emitLoadCheck(im inheritedModule) {
311 if !im.needsLoadCheck() {
312 return
313 }
314 gctx.newLine()
315 gctx.writef("if not %s:", im.entryName())
316 gctx.indentLevel++
317 gctx.newLine()
318 gctx.write(`rblf.mkerror("`, gctx.starScript.mkFile, `", "Cannot find %s" % (`)
319 im.pathExpr().emit(gctx)
320 gctx.write("))")
321 gctx.indentLevel--
322}
323
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800324type knownVariable struct {
325 name string
326 class varClass
327 valueType starlarkType
328}
329
330type knownVariables map[string]knownVariable
331
332func (pcv knownVariables) NewVariable(name string, varClass varClass, valueType starlarkType) {
333 v, exists := pcv[name]
334 if !exists {
335 pcv[name] = knownVariable{name, varClass, valueType}
336 return
337 }
338 // Conflict resolution:
339 // * config class trumps everything
340 // * any type trumps unknown type
341 match := varClass == v.class
342 if !match {
343 if varClass == VarClassConfig {
344 v.class = VarClassConfig
345 match = true
346 } else if v.class == VarClassConfig {
347 match = true
348 }
349 }
350 if valueType != v.valueType {
351 if valueType != starlarkTypeUnknown {
352 if v.valueType == starlarkTypeUnknown {
353 v.valueType = valueType
354 } else {
355 match = false
356 }
357 }
358 }
359 if !match {
360 fmt.Fprintf(os.Stderr, "cannot redefine %s as %v/%v (already defined as %v/%v)\n",
361 name, varClass, valueType, v.class, v.valueType)
362 }
363}
364
365// All known product variables.
366var KnownVariables = make(knownVariables)
367
368func init() {
369 for _, kv := range []string{
370 // Kernel-related variables that we know are lists.
371 "BOARD_VENDOR_KERNEL_MODULES",
372 "BOARD_VENDOR_RAMDISK_KERNEL_MODULES",
373 "BOARD_VENDOR_RAMDISK_KERNEL_MODULES_LOAD",
374 "BOARD_RECOVERY_KERNEL_MODULES",
375 // Other variables we knwo are lists
376 "ART_APEX_JARS",
377 } {
378 KnownVariables.NewVariable(kv, VarClassSoong, starlarkTypeList)
379 }
380}
381
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800382// Information about the generated Starlark script.
383type StarlarkScript struct {
Sasha Smundak422b6142021-11-11 18:31:59 -0800384 mkFile string
385 moduleName string
386 mkPos scanner.Position
387 nodes []starlarkNode
388 inherited []*moduleInfo
389 hasErrors bool
Sasha Smundak422b6142021-11-11 18:31:59 -0800390 traceCalls bool // print enter/exit each init function
391 sourceFS fs.FS
392 makefileFinder MakefileFinder
393 nodeLocator func(pos mkparser.Pos) int
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800394}
395
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800396// varAssignmentScope points to the last assignment for each variable
397// in the current block. It is used during the parsing to chain
398// the assignments to a variable together.
399type varAssignmentScope struct {
400 outer *varAssignmentScope
401 vars map[string]*assignmentNode
402}
403
404// parseContext holds the script we are generating and all the ephemeral data
405// needed during the parsing.
406type parseContext struct {
407 script *StarlarkScript
408 nodes []mkparser.Node // Makefile as parsed by mkparser
409 currentNodeIndex int // Node in it we are processing
410 ifNestLevel int
411 moduleNameCount map[string]int // count of imported modules with given basename
412 fatalError error
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800413 outputSuffix string
Sasha Smundak7d934b92021-11-10 12:20:01 -0800414 errorLogger ErrorLogger
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800415 tracedVariables map[string]bool // variables to be traced in the generated script
416 variables map[string]variable
417 varAssignments *varAssignmentScope
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800418 outputDir string
Sasha Smundak6609ba72021-07-22 18:32:56 -0700419 dependentModules map[string]*moduleInfo
Sasha Smundak3deb9682021-07-26 18:42:25 -0700420 soongNamespaces map[string]map[string]bool
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700421 includeTops []string
Cole Faustf92c9f22022-03-14 14:35:50 -0700422 typeHints map[string]starlarkType
423 atTopOfMakefile bool
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800424}
425
426func newParseContext(ss *StarlarkScript, nodes []mkparser.Node) *parseContext {
427 predefined := []struct{ name, value string }{
428 {"SRC_TARGET_DIR", filepath.Join("build", "make", "target")},
429 {"LOCAL_PATH", filepath.Dir(ss.mkFile)},
Cole Faust9b6111a2022-02-02 15:38:33 -0800430 {"TOPDIR", ""}, // TOPDIR is just set to an empty string in cleanbuild.mk and core.mk
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800431 // TODO(asmundak): maybe read it from build/make/core/envsetup.mk?
432 {"TARGET_COPY_OUT_SYSTEM", "system"},
433 {"TARGET_COPY_OUT_SYSTEM_OTHER", "system_other"},
434 {"TARGET_COPY_OUT_DATA", "data"},
435 {"TARGET_COPY_OUT_ASAN", filepath.Join("data", "asan")},
436 {"TARGET_COPY_OUT_OEM", "oem"},
437 {"TARGET_COPY_OUT_RAMDISK", "ramdisk"},
438 {"TARGET_COPY_OUT_DEBUG_RAMDISK", "debug_ramdisk"},
439 {"TARGET_COPY_OUT_VENDOR_DEBUG_RAMDISK", "vendor_debug_ramdisk"},
440 {"TARGET_COPY_OUT_TEST_HARNESS_RAMDISK", "test_harness_ramdisk"},
441 {"TARGET_COPY_OUT_ROOT", "root"},
442 {"TARGET_COPY_OUT_RECOVERY", "recovery"},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800443 {"TARGET_COPY_OUT_VENDOR_RAMDISK", "vendor_ramdisk"},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800444 // TODO(asmundak): to process internal config files, we need the following variables:
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800445 // TARGET_VENDOR
446 // target_base_product
447 //
448
449 // the following utility variables are set in build/make/common/core.mk:
450 {"empty", ""},
451 {"space", " "},
452 {"comma", ","},
453 {"newline", "\n"},
454 {"pound", "#"},
455 {"backslash", "\\"},
456 }
457 ctx := &parseContext{
458 script: ss,
459 nodes: nodes,
460 currentNodeIndex: 0,
461 ifNestLevel: 0,
462 moduleNameCount: make(map[string]int),
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800463 variables: make(map[string]variable),
Sasha Smundak6609ba72021-07-22 18:32:56 -0700464 dependentModules: make(map[string]*moduleInfo),
Sasha Smundak3deb9682021-07-26 18:42:25 -0700465 soongNamespaces: make(map[string]map[string]bool),
Cole Faust6c934f62022-01-06 15:51:12 -0800466 includeTops: []string{},
Cole Faustf92c9f22022-03-14 14:35:50 -0700467 typeHints: make(map[string]starlarkType),
468 atTopOfMakefile: true,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800469 }
470 ctx.pushVarAssignments()
471 for _, item := range predefined {
472 ctx.variables[item.name] = &predefinedVariable{
473 baseVariable: baseVariable{nam: item.name, typ: starlarkTypeString},
474 value: &stringLiteralExpr{item.value},
475 }
476 }
477
478 return ctx
479}
480
Cole Faust3c4fc992022-02-28 16:05:01 -0800481func (ctx *parseContext) lastAssignment(v variable) *assignmentNode {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800482 for va := ctx.varAssignments; va != nil; va = va.outer {
Cole Faust3c4fc992022-02-28 16:05:01 -0800483 if v, ok := va.vars[v.name()]; ok {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800484 return v
485 }
486 }
487 return nil
488}
489
Cole Faust3c4fc992022-02-28 16:05:01 -0800490func (ctx *parseContext) setLastAssignment(v variable, asgn *assignmentNode) {
491 ctx.varAssignments.vars[v.name()] = asgn
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800492}
493
494func (ctx *parseContext) pushVarAssignments() {
495 va := &varAssignmentScope{
496 outer: ctx.varAssignments,
497 vars: make(map[string]*assignmentNode),
498 }
499 ctx.varAssignments = va
500}
501
502func (ctx *parseContext) popVarAssignments() {
503 ctx.varAssignments = ctx.varAssignments.outer
504}
505
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800506func (ctx *parseContext) hasNodes() bool {
507 return ctx.currentNodeIndex < len(ctx.nodes)
508}
509
510func (ctx *parseContext) getNode() mkparser.Node {
511 if !ctx.hasNodes() {
512 return nil
513 }
514 node := ctx.nodes[ctx.currentNodeIndex]
515 ctx.currentNodeIndex++
516 return node
517}
518
519func (ctx *parseContext) backNode() {
520 if ctx.currentNodeIndex <= 0 {
521 panic("Cannot back off")
522 }
523 ctx.currentNodeIndex--
524}
525
Cole Faustdd569ae2022-01-31 15:48:29 -0800526func (ctx *parseContext) handleAssignment(a *mkparser.Assignment) []starlarkNode {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800527 // Handle only simple variables
528 if !a.Name.Const() {
Cole Faustdd569ae2022-01-31 15:48:29 -0800529 return []starlarkNode{ctx.newBadNode(a, "Only simple variables are handled")}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800530 }
531 name := a.Name.Strings[0]
Sasha Smundakea3bc3a2021-11-10 13:06:42 -0800532 // The `override` directive
533 // override FOO :=
534 // is parsed as an assignment to a variable named `override FOO`.
535 // There are very few places where `override` is used, just flag it.
536 if strings.HasPrefix(name, "override ") {
Cole Faustdd569ae2022-01-31 15:48:29 -0800537 return []starlarkNode{ctx.newBadNode(a, "cannot handle override directive")}
Sasha Smundakea3bc3a2021-11-10 13:06:42 -0800538 }
539
Cole Faustc00184e2021-11-08 12:08:57 -0800540 // Soong configuration
Sasha Smundak3deb9682021-07-26 18:42:25 -0700541 if strings.HasPrefix(name, soongNsPrefix) {
Cole Faustdd569ae2022-01-31 15:48:29 -0800542 return ctx.handleSoongNsAssignment(strings.TrimPrefix(name, soongNsPrefix), a)
Sasha Smundak3deb9682021-07-26 18:42:25 -0700543 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800544 lhs := ctx.addVariable(name)
545 if lhs == nil {
Cole Faustdd569ae2022-01-31 15:48:29 -0800546 return []starlarkNode{ctx.newBadNode(a, "unknown variable %s", name)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800547 }
Cole Faust3c4fc992022-02-28 16:05:01 -0800548 _, isTraced := ctx.tracedVariables[lhs.name()]
Sasha Smundak422b6142021-11-11 18:31:59 -0800549 asgn := &assignmentNode{lhs: lhs, mkValue: a.Value, isTraced: isTraced, location: ctx.errorLocation(a)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800550 if lhs.valueType() == starlarkTypeUnknown {
551 // Try to divine variable type from the RHS
552 asgn.value = ctx.parseMakeString(a, a.Value)
553 if xBad, ok := asgn.value.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800554 return []starlarkNode{&exprNode{xBad}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800555 }
556 inferred_type := asgn.value.typ()
557 if inferred_type != starlarkTypeUnknown {
Sasha Smundak9d011ab2021-07-09 16:00:57 -0700558 lhs.setValueType(inferred_type)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800559 }
560 }
561 if lhs.valueType() == starlarkTypeList {
Cole Faustdd569ae2022-01-31 15:48:29 -0800562 xConcat, xBad := ctx.buildConcatExpr(a)
563 if xBad != nil {
564 return []starlarkNode{&exprNode{expr: xBad}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800565 }
566 switch len(xConcat.items) {
567 case 0:
568 asgn.value = &listExpr{}
569 case 1:
570 asgn.value = xConcat.items[0]
571 default:
572 asgn.value = xConcat
573 }
574 } else {
575 asgn.value = ctx.parseMakeString(a, a.Value)
576 if xBad, ok := asgn.value.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800577 return []starlarkNode{&exprNode{expr: xBad}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800578 }
579 }
580
Cole Faust421a1922022-03-16 14:35:45 -0700581 if asgn.lhs.valueType() == starlarkTypeString &&
582 asgn.value.typ() != starlarkTypeUnknown &&
583 asgn.value.typ() != starlarkTypeString {
584 asgn.value = &toStringExpr{expr: asgn.value}
585 }
586
Cole Faust3c4fc992022-02-28 16:05:01 -0800587 asgn.previous = ctx.lastAssignment(lhs)
588 ctx.setLastAssignment(lhs, asgn)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800589 switch a.Type {
590 case "=", ":=":
591 asgn.flavor = asgnSet
592 case "+=":
Cole Fauste2a37982022-03-09 16:00:17 -0800593 asgn.flavor = asgnAppend
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800594 case "?=":
595 asgn.flavor = asgnMaybeSet
596 default:
597 panic(fmt.Errorf("unexpected assignment type %s", a.Type))
598 }
599
Cole Faustdd569ae2022-01-31 15:48:29 -0800600 return []starlarkNode{asgn}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800601}
602
Cole Faustdd569ae2022-01-31 15:48:29 -0800603func (ctx *parseContext) handleSoongNsAssignment(name string, asgn *mkparser.Assignment) []starlarkNode {
Sasha Smundak3deb9682021-07-26 18:42:25 -0700604 val := ctx.parseMakeString(asgn, asgn.Value)
605 if xBad, ok := val.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800606 return []starlarkNode{&exprNode{expr: xBad}}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700607 }
Sasha Smundak3deb9682021-07-26 18:42:25 -0700608
609 // Unfortunately, Soong namespaces can be set up by directly setting corresponding Make
610 // variables instead of via add_soong_config_namespace + add_soong_config_var_value.
611 // Try to divine the call from the assignment as follows:
612 if name == "NAMESPACES" {
613 // Upon seeng
614 // SOONG_CONFIG_NAMESPACES += foo
615 // remember that there is a namespace `foo` and act as we saw
616 // $(call add_soong_config_namespace,foo)
617 s, ok := maybeString(val)
618 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800619 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 -0700620 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800621 result := make([]starlarkNode, 0)
Sasha Smundak3deb9682021-07-26 18:42:25 -0700622 for _, ns := range strings.Fields(s) {
623 ctx.addSoongNamespace(ns)
Cole Faustdd569ae2022-01-31 15:48:29 -0800624 result = append(result, &exprNode{&callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -0800625 name: baseName + ".soong_config_namespace",
626 args: []starlarkExpr{&globalsExpr{}, &stringLiteralExpr{ns}},
Sasha Smundak3deb9682021-07-26 18:42:25 -0700627 returnType: starlarkTypeVoid,
628 }})
629 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800630 return result
Sasha Smundak3deb9682021-07-26 18:42:25 -0700631 } else {
632 // Upon seeing
633 // SOONG_CONFIG_x_y = v
634 // find a namespace called `x` and act as if we encountered
Cole Faustc00184e2021-11-08 12:08:57 -0800635 // $(call soong_config_set,x,y,v)
Sasha Smundak3deb9682021-07-26 18:42:25 -0700636 // or check that `x_y` is a namespace, and then add the RHS of this assignment as variables in
637 // it.
638 // Emit an error in the ambiguous situation (namespaces `foo_bar` with a variable `baz`
639 // and `foo` with a variable `bar_baz`.
640 namespaceName := ""
641 if ctx.hasSoongNamespace(name) {
642 namespaceName = name
643 }
644 var varName string
645 for pos, ch := range name {
646 if !(ch == '_' && ctx.hasSoongNamespace(name[0:pos])) {
647 continue
648 }
649 if namespaceName != "" {
Cole Faustdd569ae2022-01-31 15:48:29 -0800650 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 -0700651 }
652 namespaceName = name[0:pos]
653 varName = name[pos+1:]
654 }
655 if namespaceName == "" {
Cole Faustdd569ae2022-01-31 15:48:29 -0800656 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 -0700657 }
658 if varName == "" {
659 // Remember variables in this namespace
660 s, ok := maybeString(val)
661 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800662 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 -0700663 }
664 ctx.updateSoongNamespace(asgn.Type != "+=", namespaceName, strings.Fields(s))
Cole Faustdd569ae2022-01-31 15:48:29 -0800665 return []starlarkNode{}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700666 }
667
668 // Finally, handle assignment to a namespace variable
669 if !ctx.hasNamespaceVar(namespaceName, varName) {
Cole Faustdd569ae2022-01-31 15:48:29 -0800670 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 -0700671 }
Cole Faust9ebf6e42021-12-13 14:08:34 -0800672 fname := baseName + "." + soongConfigAssign
Sasha Smundak65b547e2021-09-17 15:35:41 -0700673 if asgn.Type == "+=" {
Cole Faust9ebf6e42021-12-13 14:08:34 -0800674 fname = baseName + "." + soongConfigAppend
Sasha Smundak65b547e2021-09-17 15:35:41 -0700675 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800676 return []starlarkNode{&exprNode{&callExpr{
Sasha Smundak65b547e2021-09-17 15:35:41 -0700677 name: fname,
Cole Faust9ebf6e42021-12-13 14:08:34 -0800678 args: []starlarkExpr{&globalsExpr{}, &stringLiteralExpr{namespaceName}, &stringLiteralExpr{varName}, val},
Sasha Smundak3deb9682021-07-26 18:42:25 -0700679 returnType: starlarkTypeVoid,
Cole Faustdd569ae2022-01-31 15:48:29 -0800680 }}}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700681 }
682}
683
Cole Faustdd569ae2022-01-31 15:48:29 -0800684func (ctx *parseContext) buildConcatExpr(a *mkparser.Assignment) (*concatExpr, *badExpr) {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800685 xConcat := &concatExpr{}
686 var xItemList *listExpr
687 addToItemList := func(x ...starlarkExpr) {
688 if xItemList == nil {
689 xItemList = &listExpr{[]starlarkExpr{}}
690 }
691 xItemList.items = append(xItemList.items, x...)
692 }
693 finishItemList := func() {
694 if xItemList != nil {
695 xConcat.items = append(xConcat.items, xItemList)
696 xItemList = nil
697 }
698 }
699
700 items := a.Value.Words()
701 for _, item := range items {
702 // A function call in RHS is supposed to return a list, all other item
703 // expressions return individual elements.
704 switch x := ctx.parseMakeString(a, item).(type) {
705 case *badExpr:
Cole Faustdd569ae2022-01-31 15:48:29 -0800706 return nil, x
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800707 case *stringLiteralExpr:
708 addToItemList(maybeConvertToStringList(x).(*listExpr).items...)
709 default:
710 switch x.typ() {
711 case starlarkTypeList:
712 finishItemList()
713 xConcat.items = append(xConcat.items, x)
714 case starlarkTypeString:
715 finishItemList()
716 xConcat.items = append(xConcat.items, &callExpr{
717 object: x,
718 name: "split",
719 args: nil,
720 returnType: starlarkTypeList,
721 })
722 default:
723 addToItemList(x)
724 }
725 }
726 }
727 if xItemList != nil {
728 xConcat.items = append(xConcat.items, xItemList)
729 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800730 return xConcat, nil
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800731}
732
Sasha Smundak6609ba72021-07-22 18:32:56 -0700733func (ctx *parseContext) newDependentModule(path string, optional bool) *moduleInfo {
734 modulePath := ctx.loadedModulePath(path)
735 if mi, ok := ctx.dependentModules[modulePath]; ok {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700736 mi.optional = mi.optional && optional
Sasha Smundak6609ba72021-07-22 18:32:56 -0700737 return mi
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800738 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800739 moduleName := moduleNameForFile(path)
740 moduleLocalName := "_" + moduleName
741 n, found := ctx.moduleNameCount[moduleName]
742 if found {
743 moduleLocalName += fmt.Sprintf("%d", n)
744 }
745 ctx.moduleNameCount[moduleName] = n + 1
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800746 _, err := fs.Stat(ctx.script.sourceFS, path)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700747 mi := &moduleInfo{
748 path: modulePath,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800749 originalPath: path,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800750 moduleLocalName: moduleLocalName,
Sasha Smundak6609ba72021-07-22 18:32:56 -0700751 optional: optional,
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800752 missing: err != nil,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800753 }
Sasha Smundak6609ba72021-07-22 18:32:56 -0700754 ctx.dependentModules[modulePath] = mi
755 ctx.script.inherited = append(ctx.script.inherited, mi)
756 return mi
757}
758
759func (ctx *parseContext) handleSubConfig(
Cole Faustdd569ae2022-01-31 15:48:29 -0800760 v mkparser.Node, pathExpr starlarkExpr, loadAlways bool, processModule func(inheritedModule) starlarkNode) []starlarkNode {
Sasha Smundak6609ba72021-07-22 18:32:56 -0700761
762 // In a simple case, the name of a module to inherit/include is known statically.
763 if path, ok := maybeString(pathExpr); ok {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700764 // Note that even if this directive loads a module unconditionally, a module may be
765 // absent without causing any harm if this directive is inside an if/else block.
766 moduleShouldExist := loadAlways && ctx.ifNestLevel == 0
Sasha Smundak6609ba72021-07-22 18:32:56 -0700767 if strings.Contains(path, "*") {
768 if paths, err := fs.Glob(ctx.script.sourceFS, path); err == nil {
Cole Faustdd569ae2022-01-31 15:48:29 -0800769 result := make([]starlarkNode, 0)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700770 for _, p := range paths {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700771 mi := ctx.newDependentModule(p, !moduleShouldExist)
Cole Faustdd569ae2022-01-31 15:48:29 -0800772 result = append(result, processModule(inheritedStaticModule{mi, loadAlways}))
Sasha Smundak6609ba72021-07-22 18:32:56 -0700773 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800774 return result
Sasha Smundak6609ba72021-07-22 18:32:56 -0700775 } else {
Cole Faustdd569ae2022-01-31 15:48:29 -0800776 return []starlarkNode{ctx.newBadNode(v, "cannot glob wildcard argument")}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700777 }
778 } else {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700779 mi := ctx.newDependentModule(path, !moduleShouldExist)
Cole Faustdd569ae2022-01-31 15:48:29 -0800780 return []starlarkNode{processModule(inheritedStaticModule{mi, loadAlways})}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700781 }
Sasha Smundak6609ba72021-07-22 18:32:56 -0700782 }
783
784 // If module path references variables (e.g., $(v1)/foo/$(v2)/device-config.mk), find all the paths in the
785 // source tree that may be a match and the corresponding variable values. For instance, if the source tree
786 // contains vendor1/foo/abc/dev.mk and vendor2/foo/def/dev.mk, the first one will be inherited when
787 // (v1, v2) == ('vendor1', 'abc'), and the second one when (v1, v2) == ('vendor2', 'def').
788 // We then emit the code that loads all of them, e.g.:
789 // load("//vendor1/foo/abc:dev.rbc", _dev1_init="init")
790 // load("//vendor2/foo/def/dev.rbc", _dev2_init="init")
791 // And then inherit it as follows:
792 // _e = {
793 // "vendor1/foo/abc/dev.mk": ("vendor1/foo/abc/dev", _dev1_init),
794 // "vendor2/foo/def/dev.mk": ("vendor2/foo/def/dev", _dev_init2) }.get("%s/foo/%s/dev.mk" % (v1, v2))
795 // if _e:
796 // rblf.inherit(handle, _e[0], _e[1])
797 //
798 var matchingPaths []string
799 varPath, ok := pathExpr.(*interpolateExpr)
800 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800801 return []starlarkNode{ctx.newBadNode(v, "inherit-product/include argument is too complex")}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700802 }
803
804 pathPattern := []string{varPath.chunks[0]}
805 for _, chunk := range varPath.chunks[1:] {
806 if chunk != "" {
807 pathPattern = append(pathPattern, chunk)
808 }
809 }
Cole Faust069aba62022-01-26 17:47:33 -0800810 if pathPattern[0] == "" && len(ctx.includeTops) > 0 {
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700811 // If pattern starts from the top. restrict it to the directories where
812 // we know inherit-product uses dynamically calculated path.
813 for _, p := range ctx.includeTops {
814 pathPattern[0] = p
815 matchingPaths = append(matchingPaths, ctx.findMatchingPaths(pathPattern)...)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700816 }
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700817 } else {
818 matchingPaths = ctx.findMatchingPaths(pathPattern)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700819 }
820 // Safeguard against $(call inherit-product,$(PRODUCT_PATH))
Sasha Smundak90be8c52021-08-03 11:06:10 -0700821 const maxMatchingFiles = 150
Sasha Smundak6609ba72021-07-22 18:32:56 -0700822 if len(matchingPaths) > maxMatchingFiles {
Cole Faustdd569ae2022-01-31 15:48:29 -0800823 return []starlarkNode{ctx.newBadNode(v, "there are >%d files matching the pattern, please rewrite it", maxMatchingFiles)}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700824 }
Cole Faust93f8d392022-03-02 13:31:30 -0800825
826 needsWarning := pathPattern[0] == "" && len(ctx.includeTops) == 0
827 res := inheritedDynamicModule{*varPath, []*moduleInfo{}, loadAlways, ctx.errorLocation(v), needsWarning}
828 for _, p := range matchingPaths {
829 // A product configuration files discovered dynamically may attempt to inherit
830 // from another one which does not exist in this source tree. Prevent load errors
831 // by always loading the dynamic files as optional.
832 res.candidateModules = append(res.candidateModules, ctx.newDependentModule(p, true))
Sasha Smundak6609ba72021-07-22 18:32:56 -0700833 }
Cole Faust93f8d392022-03-02 13:31:30 -0800834 return []starlarkNode{processModule(res)}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700835}
836
837func (ctx *parseContext) findMatchingPaths(pattern []string) []string {
Cole Faust9b6111a2022-02-02 15:38:33 -0800838 files := ctx.script.makefileFinder.Find(".")
Sasha Smundak6609ba72021-07-22 18:32:56 -0700839 if len(pattern) == 0 {
840 return files
841 }
842
843 // Create regular expression from the pattern
844 s_regexp := "^" + regexp.QuoteMeta(pattern[0])
845 for _, s := range pattern[1:] {
846 s_regexp += ".*" + regexp.QuoteMeta(s)
847 }
848 s_regexp += "$"
849 rex := regexp.MustCompile(s_regexp)
850
851 // Now match
852 var res []string
853 for _, p := range files {
854 if rex.MatchString(p) {
855 res = append(res, p)
856 }
857 }
858 return res
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800859}
860
Cole Faustf035d402022-03-28 14:02:50 -0700861type inheritProductCallParser struct {
862 loadAlways bool
863}
864
865func (p *inheritProductCallParser) parse(ctx *parseContext, v mkparser.Node, args *mkparser.MakeString) []starlarkNode {
Cole Faust9ebf6e42021-12-13 14:08:34 -0800866 args.TrimLeftSpaces()
867 args.TrimRightSpaces()
868 pathExpr := ctx.parseMakeString(v, args)
869 if _, ok := pathExpr.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800870 return []starlarkNode{ctx.newBadNode(v, "Unable to parse argument to inherit")}
Cole Faust9ebf6e42021-12-13 14:08:34 -0800871 }
Cole Faustf035d402022-03-28 14:02:50 -0700872 return ctx.handleSubConfig(v, pathExpr, p.loadAlways, func(im inheritedModule) starlarkNode {
873 return &inheritNode{im, p.loadAlways}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700874 })
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800875}
876
Cole Faustdd569ae2022-01-31 15:48:29 -0800877func (ctx *parseContext) handleInclude(v mkparser.Node, pathExpr starlarkExpr, loadAlways bool) []starlarkNode {
878 return ctx.handleSubConfig(v, pathExpr, loadAlways, func(im inheritedModule) starlarkNode {
879 return &includeNode{im, loadAlways}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700880 })
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800881}
882
Cole Faustdd569ae2022-01-31 15:48:29 -0800883func (ctx *parseContext) handleVariable(v *mkparser.Variable) []starlarkNode {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800884 // Handle:
885 // $(call inherit-product,...)
886 // $(call inherit-product-if-exists,...)
887 // $(info xxx)
888 // $(warning xxx)
889 // $(error xxx)
Cole Faust9ebf6e42021-12-13 14:08:34 -0800890 // $(call other-custom-functions,...)
891
Cole Faustf035d402022-03-28 14:02:50 -0700892 if name, args, ok := ctx.maybeParseFunctionCall(v, v.Name); ok {
893 if kf, ok := knownNodeFunctions[name]; ok {
894 return kf.parse(ctx, v, args)
895 }
Cole Faust9ebf6e42021-12-13 14:08:34 -0800896 }
Cole Faustf035d402022-03-28 14:02:50 -0700897
Cole Faustdd569ae2022-01-31 15:48:29 -0800898 return []starlarkNode{&exprNode{expr: ctx.parseReference(v, v.Name)}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800899}
900
Cole Faustdd569ae2022-01-31 15:48:29 -0800901func (ctx *parseContext) maybeHandleDefine(directive *mkparser.Directive) starlarkNode {
Sasha Smundakf3e072a2021-07-14 12:50:28 -0700902 macro_name := strings.Fields(directive.Args.Strings[0])[0]
903 // Ignore the macros that we handle
Cole Faust9ebf6e42021-12-13 14:08:34 -0800904 _, ignored := ignoredDefines[macro_name]
905 _, known := knownFunctions[macro_name]
906 if !ignored && !known {
Cole Faustdd569ae2022-01-31 15:48:29 -0800907 return ctx.newBadNode(directive, "define is not supported: %s", macro_name)
Sasha Smundakf3e072a2021-07-14 12:50:28 -0700908 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800909 return nil
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800910}
911
Cole Faustdd569ae2022-01-31 15:48:29 -0800912func (ctx *parseContext) handleIfBlock(ifDirective *mkparser.Directive) starlarkNode {
913 ssSwitch := &switchNode{
914 ssCases: []*switchCase{ctx.processBranch(ifDirective)},
915 }
916 for ctx.hasNodes() && ctx.fatalError == nil {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800917 node := ctx.getNode()
918 switch x := node.(type) {
919 case *mkparser.Directive:
920 switch x.Name {
921 case "else", "elifdef", "elifndef", "elifeq", "elifneq":
Cole Faustdd569ae2022-01-31 15:48:29 -0800922 ssSwitch.ssCases = append(ssSwitch.ssCases, ctx.processBranch(x))
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800923 case "endif":
Cole Faustdd569ae2022-01-31 15:48:29 -0800924 return ssSwitch
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800925 default:
Cole Faustdd569ae2022-01-31 15:48:29 -0800926 return ctx.newBadNode(node, "unexpected directive %s", x.Name)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800927 }
928 default:
Cole Faustdd569ae2022-01-31 15:48:29 -0800929 return ctx.newBadNode(ifDirective, "unexpected statement")
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800930 }
931 }
932 if ctx.fatalError == nil {
933 ctx.fatalError = fmt.Errorf("no matching endif for %s", ifDirective.Dump())
934 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800935 return ctx.newBadNode(ifDirective, "no matching endif for %s", ifDirective.Dump())
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800936}
937
938// processBranch processes a single branch (if/elseif/else) until the next directive
939// on the same level.
Cole Faustdd569ae2022-01-31 15:48:29 -0800940func (ctx *parseContext) processBranch(check *mkparser.Directive) *switchCase {
941 block := &switchCase{gate: ctx.parseCondition(check)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800942 defer func() {
943 ctx.popVarAssignments()
944 ctx.ifNestLevel--
945
946 }()
947 ctx.pushVarAssignments()
948 ctx.ifNestLevel++
949
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800950 for ctx.hasNodes() {
951 node := ctx.getNode()
Cole Faust591a1fe2021-11-08 15:37:57 -0800952 if d, ok := node.(*mkparser.Directive); ok {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800953 switch d.Name {
954 case "else", "elifdef", "elifndef", "elifeq", "elifneq", "endif":
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800955 ctx.backNode()
Cole Faustdd569ae2022-01-31 15:48:29 -0800956 return block
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800957 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800958 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800959 block.nodes = append(block.nodes, ctx.handleSimpleStatement(node)...)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800960 }
961 ctx.fatalError = fmt.Errorf("no matching endif for %s", check.Dump())
Cole Faustdd569ae2022-01-31 15:48:29 -0800962 return block
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800963}
964
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800965func (ctx *parseContext) parseCondition(check *mkparser.Directive) starlarkNode {
966 switch check.Name {
967 case "ifdef", "ifndef", "elifdef", "elifndef":
Cole Faust71514c02022-01-27 17:21:41 -0800968 if !check.Args.Const() {
Cole Faustdd569ae2022-01-31 15:48:29 -0800969 return ctx.newBadNode(check, "ifdef variable ref too complex: %s", check.Args.Dump())
Cole Faust71514c02022-01-27 17:21:41 -0800970 }
971 v := NewVariableRefExpr(ctx.addVariable(check.Args.Strings[0]), false)
972 if strings.HasSuffix(check.Name, "ndef") {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800973 v = &notExpr{v}
974 }
975 return &ifNode{
976 isElif: strings.HasPrefix(check.Name, "elif"),
977 expr: v,
978 }
979 case "ifeq", "ifneq", "elifeq", "elifneq":
980 return &ifNode{
981 isElif: strings.HasPrefix(check.Name, "elif"),
982 expr: ctx.parseCompare(check),
983 }
984 case "else":
985 return &elseNode{}
986 default:
987 panic(fmt.Errorf("%s: unknown directive: %s", ctx.script.mkFile, check.Dump()))
988 }
989}
990
991func (ctx *parseContext) newBadExpr(node mkparser.Node, text string, args ...interface{}) starlarkExpr {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800992 if ctx.errorLogger != nil {
Sasha Smundak422b6142021-11-11 18:31:59 -0800993 ctx.errorLogger.NewError(ctx.errorLocation(node), node, text, args...)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800994 }
995 ctx.script.hasErrors = true
Cole Faustdd569ae2022-01-31 15:48:29 -0800996 return &badExpr{errorLocation: ctx.errorLocation(node), message: fmt.Sprintf(text, args...)}
997}
998
999// records that the given node failed to be converted and includes an explanatory message
1000func (ctx *parseContext) newBadNode(failedNode mkparser.Node, message string, args ...interface{}) starlarkNode {
1001 return &exprNode{ctx.newBadExpr(failedNode, message, args...)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001002}
1003
1004func (ctx *parseContext) parseCompare(cond *mkparser.Directive) starlarkExpr {
1005 // Strip outer parentheses
1006 mkArg := cloneMakeString(cond.Args)
1007 mkArg.Strings[0] = strings.TrimLeft(mkArg.Strings[0], "( ")
1008 n := len(mkArg.Strings)
1009 mkArg.Strings[n-1] = strings.TrimRight(mkArg.Strings[n-1], ") ")
1010 args := mkArg.Split(",")
1011 // TODO(asmundak): handle the case where the arguments are in quotes and space-separated
1012 if len(args) != 2 {
1013 return ctx.newBadExpr(cond, "ifeq/ifneq len(args) != 2 %s", cond.Dump())
1014 }
1015 args[0].TrimRightSpaces()
1016 args[1].TrimLeftSpaces()
1017
1018 isEq := !strings.HasSuffix(cond.Name, "neq")
Cole Faustf8320212021-11-10 15:05:07 -08001019 xLeft := ctx.parseMakeString(cond, args[0])
1020 xRight := ctx.parseMakeString(cond, args[1])
1021 if bad, ok := xLeft.(*badExpr); ok {
1022 return bad
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001023 }
Cole Faustf8320212021-11-10 15:05:07 -08001024 if bad, ok := xRight.(*badExpr); ok {
1025 return bad
1026 }
1027
1028 if expr, ok := ctx.parseCompareSpecialCases(cond, xLeft, xRight); ok {
1029 return expr
1030 }
1031
Cole Faust9ebf6e42021-12-13 14:08:34 -08001032 var stringOperand string
1033 var otherOperand starlarkExpr
1034 if s, ok := maybeString(xLeft); ok {
1035 stringOperand = s
1036 otherOperand = xRight
1037 } else if s, ok := maybeString(xRight); ok {
1038 stringOperand = s
1039 otherOperand = xLeft
1040 }
1041
Cole Faust9ebf6e42021-12-13 14:08:34 -08001042 // If we've identified one of the operands as being a string literal, check
1043 // for some special cases we can do to simplify the resulting expression.
1044 if otherOperand != nil {
1045 if stringOperand == "" {
1046 if isEq {
Cole Faustf035d402022-03-28 14:02:50 -07001047 return negateExpr(otherOperand)
Cole Faust9ebf6e42021-12-13 14:08:34 -08001048 } else {
1049 return otherOperand
1050 }
1051 }
1052 if stringOperand == "true" && otherOperand.typ() == starlarkTypeBool {
1053 if !isEq {
Cole Faustf035d402022-03-28 14:02:50 -07001054 return negateExpr(otherOperand)
Cole Faust9ebf6e42021-12-13 14:08:34 -08001055 } else {
1056 return otherOperand
1057 }
1058 }
Cole Faustb1103e22022-01-06 15:22:05 -08001059 if intOperand, err := strconv.Atoi(strings.TrimSpace(stringOperand)); err == nil && otherOperand.typ() == starlarkTypeInt {
1060 return &eqExpr{
1061 left: otherOperand,
1062 right: &intLiteralExpr{literal: intOperand},
1063 isEq: isEq,
1064 }
1065 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001066 }
1067
Cole Faustf8320212021-11-10 15:05:07 -08001068 return &eqExpr{left: xLeft, right: xRight, isEq: isEq}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001069}
1070
Cole Faustf8320212021-11-10 15:05:07 -08001071// Given an if statement's directive and the left/right starlarkExprs,
1072// check if the starlarkExprs are one of a few hardcoded special cases
Cole Faust9932f752022-02-08 11:56:25 -08001073// that can be converted to a simpler equality expression than simply comparing
Cole Faustf8320212021-11-10 15:05:07 -08001074// the two.
1075func (ctx *parseContext) parseCompareSpecialCases(directive *mkparser.Directive, left starlarkExpr,
1076 right starlarkExpr) (starlarkExpr, bool) {
1077 isEq := !strings.HasSuffix(directive.Name, "neq")
1078
1079 // All the special cases require a call on one side and a
1080 // string literal/variable on the other. Turn the left/right variables into
1081 // call/value variables, and return false if that's not possible.
1082 var value starlarkExpr = nil
1083 call, ok := left.(*callExpr)
1084 if ok {
1085 switch right.(type) {
1086 case *stringLiteralExpr, *variableRefExpr:
1087 value = right
1088 }
1089 } else {
1090 call, _ = right.(*callExpr)
1091 switch left.(type) {
1092 case *stringLiteralExpr, *variableRefExpr:
1093 value = left
1094 }
1095 }
1096
1097 if call == nil || value == nil {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001098 return nil, false
1099 }
Cole Faustf8320212021-11-10 15:05:07 -08001100
Cole Faustf8320212021-11-10 15:05:07 -08001101 switch call.name {
Cole Faust9932f752022-02-08 11:56:25 -08001102 case baseName + ".filter":
1103 return ctx.parseCompareFilterFuncResult(directive, call, value, isEq)
Cole Faust9ebf6e42021-12-13 14:08:34 -08001104 case baseName + ".expand_wildcard":
Cole Faustf8320212021-11-10 15:05:07 -08001105 return ctx.parseCompareWildcardFuncResult(directive, call, value, !isEq), true
Cole Faust9ebf6e42021-12-13 14:08:34 -08001106 case baseName + ".findstring":
Cole Faustf8320212021-11-10 15:05:07 -08001107 return ctx.parseCheckFindstringFuncResult(directive, call, value, !isEq), true
Cole Faust9ebf6e42021-12-13 14:08:34 -08001108 case baseName + ".strip":
Cole Faustf8320212021-11-10 15:05:07 -08001109 return ctx.parseCompareStripFuncResult(directive, call, value, !isEq), true
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001110 }
Cole Faustf8320212021-11-10 15:05:07 -08001111 return nil, false
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001112}
1113
1114func (ctx *parseContext) parseCompareFilterFuncResult(cond *mkparser.Directive,
Cole Faust9932f752022-02-08 11:56:25 -08001115 filterFuncCall *callExpr, xValue starlarkExpr, negate bool) (starlarkExpr, bool) {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001116 // We handle:
Sasha Smundak0554d762021-07-08 18:26:12 -07001117 // * ifeq/ifneq (,$(filter v1 v2 ..., EXPR) becomes if EXPR not in/in ["v1", "v2", ...]
1118 // * ifeq/ifneq (,$(filter EXPR, v1 v2 ...) becomes if EXPR not in/in ["v1", "v2", ...]
Cole Faust9932f752022-02-08 11:56:25 -08001119 if x, ok := xValue.(*stringLiteralExpr); !ok || x.literal != "" {
1120 return nil, false
1121 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001122 xPattern := filterFuncCall.args[0]
1123 xText := filterFuncCall.args[1]
1124 var xInList *stringLiteralExpr
Sasha Smundak0554d762021-07-08 18:26:12 -07001125 var expr starlarkExpr
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001126 var ok bool
Cole Faust9932f752022-02-08 11:56:25 -08001127 if xInList, ok = xPattern.(*stringLiteralExpr); ok && !strings.ContainsRune(xInList.literal, '%') && xText.typ() == starlarkTypeList {
1128 expr = xText
1129 } else if xInList, ok = xText.(*stringLiteralExpr); ok {
1130 expr = xPattern
1131 } else {
1132 return nil, false
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001133 }
Cole Faust9932f752022-02-08 11:56:25 -08001134 slExpr := newStringListExpr(strings.Fields(xInList.literal))
1135 // Generate simpler code for the common cases:
1136 if expr.typ() == starlarkTypeList {
1137 if len(slExpr.items) == 1 {
1138 // Checking that a string belongs to list
1139 return &inExpr{isNot: negate, list: expr, expr: slExpr.items[0]}, true
Sasha Smundak0554d762021-07-08 18:26:12 -07001140 } else {
Cole Faust9932f752022-02-08 11:56:25 -08001141 return nil, false
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001142 }
Cole Faust9932f752022-02-08 11:56:25 -08001143 } else if len(slExpr.items) == 1 {
1144 return &eqExpr{left: expr, right: slExpr.items[0], isEq: !negate}, true
1145 } else {
1146 return &inExpr{isNot: negate, list: newStringListExpr(strings.Fields(xInList.literal)), expr: expr}, true
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001147 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001148}
1149
1150func (ctx *parseContext) parseCompareWildcardFuncResult(directive *mkparser.Directive,
1151 xCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
Sasha Smundak0554d762021-07-08 18:26:12 -07001152 if !isEmptyString(xValue) {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001153 return ctx.newBadExpr(directive, "wildcard result can be compared only to empty: %s", xValue)
1154 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001155 callFunc := baseName + ".file_wildcard_exists"
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001156 if s, ok := xCall.args[0].(*stringLiteralExpr); ok && !strings.ContainsAny(s.literal, "*?{[") {
Cole Faust9ebf6e42021-12-13 14:08:34 -08001157 callFunc = baseName + ".file_exists"
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001158 }
1159 var cc starlarkExpr = &callExpr{name: callFunc, args: xCall.args, returnType: starlarkTypeBool}
1160 if !negate {
1161 cc = &notExpr{cc}
1162 }
1163 return cc
1164}
1165
1166func (ctx *parseContext) parseCheckFindstringFuncResult(directive *mkparser.Directive,
1167 xCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
Sasha Smundak0554d762021-07-08 18:26:12 -07001168 if isEmptyString(xValue) {
1169 return &eqExpr{
1170 left: &callExpr{
1171 object: xCall.args[1],
1172 name: "find",
1173 args: []starlarkExpr{xCall.args[0]},
1174 returnType: starlarkTypeInt,
1175 },
1176 right: &intLiteralExpr{-1},
1177 isEq: !negate,
1178 }
Cole Faust0e9418c2021-12-13 16:33:25 -08001179 } else if s, ok := maybeString(xValue); ok {
1180 if s2, ok := maybeString(xCall.args[0]); ok && s == s2 {
1181 return &eqExpr{
1182 left: &callExpr{
1183 object: xCall.args[1],
1184 name: "find",
1185 args: []starlarkExpr{xCall.args[0]},
1186 returnType: starlarkTypeInt,
1187 },
1188 right: &intLiteralExpr{-1},
1189 isEq: negate,
1190 }
1191 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001192 }
Cole Faust0e9418c2021-12-13 16:33:25 -08001193 return ctx.newBadExpr(directive, "$(findstring) can only be compared to nothing or its first argument")
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001194}
1195
1196func (ctx *parseContext) parseCompareStripFuncResult(directive *mkparser.Directive,
1197 xCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
1198 if _, ok := xValue.(*stringLiteralExpr); !ok {
1199 return ctx.newBadExpr(directive, "strip result can be compared only to string: %s", xValue)
1200 }
1201 return &eqExpr{
1202 left: &callExpr{
1203 name: "strip",
1204 args: xCall.args,
1205 returnType: starlarkTypeString,
1206 },
1207 right: xValue, isEq: !negate}
1208}
1209
Cole Faustf035d402022-03-28 14:02:50 -07001210func (ctx *parseContext) maybeParseFunctionCall(node mkparser.Node, ref *mkparser.MakeString) (name string, args *mkparser.MakeString, ok bool) {
1211 ref.TrimLeftSpaces()
1212 ref.TrimRightSpaces()
1213
1214 words := ref.SplitN(" ", 2)
1215 if !words[0].Const() {
1216 return "", nil, false
1217 }
1218
1219 name = words[0].Dump()
1220 args = mkparser.SimpleMakeString("", words[0].Pos())
1221 if len(words) >= 2 {
1222 args = words[1]
1223 }
1224 args.TrimLeftSpaces()
1225 if name == "call" {
1226 words = args.SplitN(",", 2)
1227 if words[0].Empty() || !words[0].Const() {
1228 return "", nil, false
1229 }
1230 name = words[0].Dump()
1231 if len(words) < 2 {
1232 args = &mkparser.MakeString{}
1233 } else {
1234 args = words[1]
1235 }
1236 }
1237 ok = true
1238 return
1239}
1240
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001241// parses $(...), returning an expression
1242func (ctx *parseContext) parseReference(node mkparser.Node, ref *mkparser.MakeString) starlarkExpr {
1243 ref.TrimLeftSpaces()
1244 ref.TrimRightSpaces()
1245 refDump := ref.Dump()
1246
1247 // Handle only the case where the first (or only) word is constant
1248 words := ref.SplitN(" ", 2)
1249 if !words[0].Const() {
1250 return ctx.newBadExpr(node, "reference is too complex: %s", refDump)
1251 }
1252
1253 // If it is a single word, it can be a simple variable
1254 // reference or a function call
Cole Faustf035d402022-03-28 14:02:50 -07001255 if len(words) == 1 && !isMakeControlFunc(refDump) && refDump != "shell" && refDump != "eval" {
Sasha Smundak65b547e2021-09-17 15:35:41 -07001256 if strings.HasPrefix(refDump, soongNsPrefix) {
1257 // TODO (asmundak): if we find many, maybe handle them.
Cole Faustc00184e2021-11-08 12:08:57 -08001258 return ctx.newBadExpr(node, "SOONG_CONFIG_ variables cannot be referenced, use soong_config_get instead: %s", refDump)
Sasha Smundak65b547e2021-09-17 15:35:41 -07001259 }
Cole Faustc36c9622021-12-07 15:20:45 -08001260 // Handle substitution references: https://www.gnu.org/software/make/manual/html_node/Substitution-Refs.html
1261 if strings.Contains(refDump, ":") {
1262 parts := strings.SplitN(refDump, ":", 2)
1263 substParts := strings.SplitN(parts[1], "=", 2)
1264 if len(substParts) < 2 || strings.Count(substParts[0], "%") > 1 {
1265 return ctx.newBadExpr(node, "Invalid substitution reference")
1266 }
1267 if !strings.Contains(substParts[0], "%") {
1268 if strings.Contains(substParts[1], "%") {
1269 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.")
1270 }
1271 substParts[0] = "%" + substParts[0]
1272 substParts[1] = "%" + substParts[1]
1273 }
1274 v := ctx.addVariable(parts[0])
1275 if v == nil {
1276 return ctx.newBadExpr(node, "unknown variable %s", refDump)
1277 }
1278 return &callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -08001279 name: baseName + ".mkpatsubst",
1280 returnType: starlarkTypeString,
Cole Faustc36c9622021-12-07 15:20:45 -08001281 args: []starlarkExpr{
1282 &stringLiteralExpr{literal: substParts[0]},
1283 &stringLiteralExpr{literal: substParts[1]},
Cole Faust3c4fc992022-02-28 16:05:01 -08001284 NewVariableRefExpr(v, ctx.lastAssignment(v) != nil),
Cole Faustc36c9622021-12-07 15:20:45 -08001285 },
1286 }
1287 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001288 if v := ctx.addVariable(refDump); v != nil {
Cole Faust3c4fc992022-02-28 16:05:01 -08001289 return NewVariableRefExpr(v, ctx.lastAssignment(v) != nil)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001290 }
1291 return ctx.newBadExpr(node, "unknown variable %s", refDump)
1292 }
1293
Cole Faustf035d402022-03-28 14:02:50 -07001294 if name, args, ok := ctx.maybeParseFunctionCall(node, ref); ok {
1295 if kf, found := knownFunctions[name]; found {
1296 return kf.parse(ctx, node, args)
Sasha Smundak6609ba72021-07-22 18:32:56 -07001297 } else {
Cole Faustf035d402022-03-28 14:02:50 -07001298 return ctx.newBadExpr(node, "cannot handle invoking %s", name)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001299 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001300 } else {
Cole Faustf035d402022-03-28 14:02:50 -07001301 return ctx.newBadExpr(node, "cannot handle %s", refDump)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001302 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001303}
1304
1305type simpleCallParser struct {
1306 name string
1307 returnType starlarkType
1308 addGlobals bool
Cole Faust1cc08852022-02-28 11:12:08 -08001309 addHandle bool
Cole Faust9ebf6e42021-12-13 14:08:34 -08001310}
1311
1312func (p *simpleCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1313 expr := &callExpr{name: p.name, returnType: p.returnType}
1314 if p.addGlobals {
1315 expr.args = append(expr.args, &globalsExpr{})
1316 }
Cole Faust1cc08852022-02-28 11:12:08 -08001317 if p.addHandle {
1318 expr.args = append(expr.args, &identifierExpr{name: "handle"})
1319 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001320 for _, arg := range args.Split(",") {
1321 arg.TrimLeftSpaces()
1322 arg.TrimRightSpaces()
1323 x := ctx.parseMakeString(node, arg)
1324 if xBad, ok := x.(*badExpr); ok {
1325 return xBad
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001326 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001327 expr.args = append(expr.args, x)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001328 }
1329 return expr
1330}
1331
Cole Faust9ebf6e42021-12-13 14:08:34 -08001332type makeControlFuncParser struct {
1333 name string
1334}
1335
1336func (p *makeControlFuncParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1337 // Make control functions need special treatment as everything
1338 // after the name is a single text argument
1339 x := ctx.parseMakeString(node, args)
1340 if xBad, ok := x.(*badExpr); ok {
1341 return xBad
1342 }
1343 return &callExpr{
1344 name: p.name,
1345 args: []starlarkExpr{
1346 &stringLiteralExpr{ctx.script.mkFile},
1347 x,
1348 },
1349 returnType: starlarkTypeUnknown,
1350 }
1351}
1352
1353type shellCallParser struct{}
1354
1355func (p *shellCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1356 // Shell functions need special treatment as everything
1357 // after the name is a single text argument
1358 x := ctx.parseMakeString(node, args)
1359 if xBad, ok := x.(*badExpr); ok {
1360 return xBad
1361 }
1362 return &callExpr{
1363 name: baseName + ".shell",
1364 args: []starlarkExpr{x},
1365 returnType: starlarkTypeUnknown,
1366 }
1367}
1368
1369type myDirCallParser struct{}
1370
1371func (p *myDirCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1372 if !args.Empty() {
1373 return ctx.newBadExpr(node, "my-dir function cannot have any arguments passed to it.")
1374 }
Cole Faustf5adedc2022-03-18 14:05:06 -07001375 return &stringLiteralExpr{literal: filepath.Dir(ctx.script.mkFile)}
Cole Faust9ebf6e42021-12-13 14:08:34 -08001376}
1377
Cole Faust9ebf6e42021-12-13 14:08:34 -08001378type isProductInListCallParser struct{}
1379
1380func (p *isProductInListCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1381 if args.Empty() {
1382 return ctx.newBadExpr(node, "is-product-in-list requires an argument")
1383 }
1384 return &inExpr{
1385 expr: &variableRefExpr{ctx.addVariable("TARGET_PRODUCT"), true},
1386 list: maybeConvertToStringList(ctx.parseMakeString(node, args)),
1387 isNot: false,
1388 }
1389}
1390
1391type isVendorBoardPlatformCallParser struct{}
1392
1393func (p *isVendorBoardPlatformCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1394 if args.Empty() || !identifierFullMatchRegex.MatchString(args.Dump()) {
1395 return ctx.newBadExpr(node, "cannot handle non-constant argument to is-vendor-board-platform")
1396 }
1397 return &inExpr{
1398 expr: &variableRefExpr{ctx.addVariable("TARGET_BOARD_PLATFORM"), false},
1399 list: &variableRefExpr{ctx.addVariable(args.Dump() + "_BOARD_PLATFORMS"), true},
1400 isNot: false,
1401 }
1402}
1403
1404type isVendorBoardQcomCallParser struct{}
1405
1406func (p *isVendorBoardQcomCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1407 if !args.Empty() {
1408 return ctx.newBadExpr(node, "is-vendor-board-qcom does not accept any arguments")
1409 }
1410 return &inExpr{
1411 expr: &variableRefExpr{ctx.addVariable("TARGET_BOARD_PLATFORM"), false},
1412 list: &variableRefExpr{ctx.addVariable("QCOM_BOARD_PLATFORMS"), true},
1413 isNot: false,
1414 }
1415}
1416
1417type substCallParser struct {
1418 fname string
1419}
1420
1421func (p *substCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001422 words := args.Split(",")
1423 if len(words) != 3 {
Cole Faust9ebf6e42021-12-13 14:08:34 -08001424 return ctx.newBadExpr(node, "%s function should have 3 arguments", p.fname)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001425 }
Sasha Smundak35434ed2021-11-05 16:29:56 -07001426 from := ctx.parseMakeString(node, words[0])
1427 if xBad, ok := from.(*badExpr); ok {
1428 return xBad
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001429 }
Sasha Smundak35434ed2021-11-05 16:29:56 -07001430 to := ctx.parseMakeString(node, words[1])
1431 if xBad, ok := to.(*badExpr); ok {
1432 return xBad
1433 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001434 words[2].TrimLeftSpaces()
1435 words[2].TrimRightSpaces()
1436 obj := ctx.parseMakeString(node, words[2])
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001437 typ := obj.typ()
Cole Faust9ebf6e42021-12-13 14:08:34 -08001438 if typ == starlarkTypeString && p.fname == "subst" {
Sasha Smundak94b41c72021-07-12 18:30:42 -07001439 // Optimization: if it's $(subst from, to, string), emit string.replace(from, to)
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001440 return &callExpr{
1441 object: obj,
1442 name: "replace",
Sasha Smundak35434ed2021-11-05 16:29:56 -07001443 args: []starlarkExpr{from, to},
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001444 returnType: typ,
1445 }
1446 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001447 return &callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -08001448 name: baseName + ".mk" + p.fname,
Sasha Smundak35434ed2021-11-05 16:29:56 -07001449 args: []starlarkExpr{from, to, obj},
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001450 returnType: obj.typ(),
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001451 }
1452}
1453
Cole Faust9ebf6e42021-12-13 14:08:34 -08001454type ifCallParser struct{}
1455
1456func (p *ifCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Cole Faust4eadba72021-12-07 11:54:52 -08001457 words := args.Split(",")
1458 if len(words) != 2 && len(words) != 3 {
1459 return ctx.newBadExpr(node, "if function should have 2 or 3 arguments, found "+strconv.Itoa(len(words)))
1460 }
1461 condition := ctx.parseMakeString(node, words[0])
1462 ifTrue := ctx.parseMakeString(node, words[1])
1463 var ifFalse starlarkExpr
1464 if len(words) == 3 {
1465 ifFalse = ctx.parseMakeString(node, words[2])
1466 } else {
1467 switch ifTrue.typ() {
1468 case starlarkTypeList:
1469 ifFalse = &listExpr{items: []starlarkExpr{}}
1470 case starlarkTypeInt:
1471 ifFalse = &intLiteralExpr{literal: 0}
1472 case starlarkTypeBool:
1473 ifFalse = &boolLiteralExpr{literal: false}
1474 default:
1475 ifFalse = &stringLiteralExpr{literal: ""}
1476 }
1477 }
1478 return &ifExpr{
1479 condition,
1480 ifTrue,
1481 ifFalse,
1482 }
1483}
1484
Cole Faustf035d402022-03-28 14:02:50 -07001485type ifCallNodeParser struct{}
Cole Faust9ebf6e42021-12-13 14:08:34 -08001486
Cole Faustf035d402022-03-28 14:02:50 -07001487func (p *ifCallNodeParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) []starlarkNode {
1488 words := args.Split(",")
1489 if len(words) != 2 && len(words) != 3 {
1490 return []starlarkNode{ctx.newBadNode(node, "if function should have 2 or 3 arguments, found "+strconv.Itoa(len(words)))}
1491 }
1492
1493 ifn := &ifNode{expr: ctx.parseMakeString(node, words[0])}
1494 cases := []*switchCase{
1495 {
1496 gate: ifn,
1497 nodes: ctx.parseNodeMakeString(node, words[1]),
1498 },
1499 }
1500 if len(words) == 3 {
1501 cases = append(cases, &switchCase{
1502 gate: &elseNode{},
1503 nodes: ctx.parseNodeMakeString(node, words[2]),
1504 })
1505 }
1506 if len(cases) == 2 {
1507 if len(cases[1].nodes) == 0 {
1508 // Remove else branch if it has no contents
1509 cases = cases[:1]
1510 } else if len(cases[0].nodes) == 0 {
1511 // If the if branch has no contents but the else does,
1512 // move them to the if and negate its condition
1513 ifn.expr = negateExpr(ifn.expr)
1514 cases[0].nodes = cases[1].nodes
1515 cases = cases[:1]
1516 }
1517 }
1518
1519 return []starlarkNode{&switchNode{ssCases: cases}}
1520}
1521
1522type foreachCallParser struct{}
1523
1524func (p *foreachCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Cole Faustb0d32ab2021-12-09 14:00:59 -08001525 words := args.Split(",")
1526 if len(words) != 3 {
1527 return ctx.newBadExpr(node, "foreach function should have 3 arguments, found "+strconv.Itoa(len(words)))
1528 }
1529 if !words[0].Const() || words[0].Empty() || !identifierFullMatchRegex.MatchString(words[0].Strings[0]) {
1530 return ctx.newBadExpr(node, "first argument to foreach function must be a simple string identifier")
1531 }
1532 loopVarName := words[0].Strings[0]
1533 list := ctx.parseMakeString(node, words[1])
1534 action := ctx.parseMakeString(node, words[2]).transform(func(expr starlarkExpr) starlarkExpr {
1535 if varRefExpr, ok := expr.(*variableRefExpr); ok && varRefExpr.ref.name() == loopVarName {
1536 return &identifierExpr{loopVarName}
1537 }
1538 return nil
1539 })
1540
1541 if list.typ() != starlarkTypeList {
1542 list = &callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -08001543 name: baseName + ".words",
1544 returnType: starlarkTypeList,
Cole Faustb0d32ab2021-12-09 14:00:59 -08001545 args: []starlarkExpr{list},
1546 }
1547 }
1548
1549 return &foreachExpr{
1550 varName: loopVarName,
1551 list: list,
1552 action: action,
1553 }
1554}
1555
Cole Faustf035d402022-03-28 14:02:50 -07001556func transformNode(node starlarkNode, transformer func(expr starlarkExpr) starlarkExpr) {
1557 switch a := node.(type) {
1558 case *ifNode:
1559 a.expr = a.expr.transform(transformer)
1560 case *switchCase:
1561 transformNode(a.gate, transformer)
1562 for _, n := range a.nodes {
1563 transformNode(n, transformer)
1564 }
1565 case *switchNode:
1566 for _, n := range a.ssCases {
1567 transformNode(n, transformer)
1568 }
1569 case *exprNode:
1570 a.expr = a.expr.transform(transformer)
1571 case *assignmentNode:
1572 a.value = a.value.transform(transformer)
1573 case *foreachNode:
1574 a.list = a.list.transform(transformer)
1575 for _, n := range a.actions {
1576 transformNode(n, transformer)
1577 }
1578 }
1579}
1580
1581type foreachCallNodeParser struct{}
1582
1583func (p *foreachCallNodeParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) []starlarkNode {
1584 words := args.Split(",")
1585 if len(words) != 3 {
1586 return []starlarkNode{ctx.newBadNode(node, "foreach function should have 3 arguments, found "+strconv.Itoa(len(words)))}
1587 }
1588 if !words[0].Const() || words[0].Empty() || !identifierFullMatchRegex.MatchString(words[0].Strings[0]) {
1589 return []starlarkNode{ctx.newBadNode(node, "first argument to foreach function must be a simple string identifier")}
1590 }
1591
1592 loopVarName := words[0].Strings[0]
1593
1594 list := ctx.parseMakeString(node, words[1])
1595 if list.typ() != starlarkTypeList {
1596 list = &callExpr{
1597 name: baseName + ".words",
1598 returnType: starlarkTypeList,
1599 args: []starlarkExpr{list},
1600 }
1601 }
1602
1603 actions := ctx.parseNodeMakeString(node, words[2])
1604 // TODO(colefaust): Replace transforming code with something more elegant
1605 for _, action := range actions {
1606 transformNode(action, func(expr starlarkExpr) starlarkExpr {
1607 if varRefExpr, ok := expr.(*variableRefExpr); ok && varRefExpr.ref.name() == loopVarName {
1608 return &identifierExpr{loopVarName}
1609 }
1610 return nil
1611 })
1612 }
1613
1614 return []starlarkNode{&foreachNode{
1615 varName: loopVarName,
1616 list: list,
1617 actions: actions,
1618 }}
1619}
1620
Cole Faust9ebf6e42021-12-13 14:08:34 -08001621type wordCallParser struct{}
1622
1623func (p *wordCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001624 words := args.Split(",")
1625 if len(words) != 2 {
1626 return ctx.newBadExpr(node, "word function should have 2 arguments")
1627 }
1628 var index uint64 = 0
1629 if words[0].Const() {
1630 index, _ = strconv.ParseUint(strings.TrimSpace(words[0].Strings[0]), 10, 64)
1631 }
1632 if index < 1 {
1633 return ctx.newBadExpr(node, "word index should be constant positive integer")
1634 }
1635 words[1].TrimLeftSpaces()
1636 words[1].TrimRightSpaces()
1637 array := ctx.parseMakeString(node, words[1])
1638 if xBad, ok := array.(*badExpr); ok {
1639 return xBad
1640 }
1641 if array.typ() != starlarkTypeList {
1642 array = &callExpr{object: array, name: "split", returnType: starlarkTypeList}
1643 }
Cole Faustb0d32ab2021-12-09 14:00:59 -08001644 return &indexExpr{array, &intLiteralExpr{int(index - 1)}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001645}
1646
Cole Faust9ebf6e42021-12-13 14:08:34 -08001647type firstOrLastwordCallParser struct {
1648 isLastWord bool
1649}
1650
1651func (p *firstOrLastwordCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Sasha Smundak16e07732021-07-23 11:38:23 -07001652 arg := ctx.parseMakeString(node, args)
1653 if bad, ok := arg.(*badExpr); ok {
1654 return bad
1655 }
1656 index := &intLiteralExpr{0}
Cole Faust9ebf6e42021-12-13 14:08:34 -08001657 if p.isLastWord {
Sasha Smundak16e07732021-07-23 11:38:23 -07001658 if v, ok := arg.(*variableRefExpr); ok && v.ref.name() == "MAKEFILE_LIST" {
1659 return &stringLiteralExpr{ctx.script.mkFile}
1660 }
1661 index.literal = -1
1662 }
1663 if arg.typ() == starlarkTypeList {
1664 return &indexExpr{arg, index}
1665 }
1666 return &indexExpr{&callExpr{object: arg, name: "split", returnType: starlarkTypeList}, index}
1667}
1668
Cole Faustb1103e22022-01-06 15:22:05 -08001669func parseIntegerArguments(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString, expectedArgs int) ([]starlarkExpr, error) {
1670 parsedArgs := make([]starlarkExpr, 0)
1671 for _, arg := range args.Split(",") {
1672 expr := ctx.parseMakeString(node, arg)
1673 if expr.typ() == starlarkTypeList {
1674 return nil, fmt.Errorf("argument to math argument has type list, which cannot be converted to int")
1675 }
1676 if s, ok := maybeString(expr); ok {
1677 intVal, err := strconv.Atoi(strings.TrimSpace(s))
1678 if err != nil {
1679 return nil, err
1680 }
1681 expr = &intLiteralExpr{literal: intVal}
1682 } else if expr.typ() != starlarkTypeInt {
1683 expr = &callExpr{
1684 name: "int",
1685 args: []starlarkExpr{expr},
1686 returnType: starlarkTypeInt,
1687 }
1688 }
1689 parsedArgs = append(parsedArgs, expr)
1690 }
1691 if len(parsedArgs) != expectedArgs {
1692 return nil, fmt.Errorf("function should have %d arguments", expectedArgs)
1693 }
1694 return parsedArgs, nil
1695}
1696
1697type mathComparisonCallParser struct {
1698 op string
1699}
1700
1701func (p *mathComparisonCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1702 parsedArgs, err := parseIntegerArguments(ctx, node, args, 2)
1703 if err != nil {
1704 return ctx.newBadExpr(node, err.Error())
1705 }
1706 return &binaryOpExpr{
1707 left: parsedArgs[0],
1708 right: parsedArgs[1],
1709 op: p.op,
1710 returnType: starlarkTypeBool,
1711 }
1712}
1713
1714type mathMaxOrMinCallParser struct {
1715 function string
1716}
1717
1718func (p *mathMaxOrMinCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1719 parsedArgs, err := parseIntegerArguments(ctx, node, args, 2)
1720 if err != nil {
1721 return ctx.newBadExpr(node, err.Error())
1722 }
1723 return &callExpr{
1724 object: nil,
1725 name: p.function,
1726 args: parsedArgs,
1727 returnType: starlarkTypeInt,
1728 }
1729}
1730
Cole Faustf035d402022-03-28 14:02:50 -07001731type evalNodeParser struct{}
1732
1733func (p *evalNodeParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) []starlarkNode {
1734 parser := mkparser.NewParser("Eval expression", strings.NewReader(args.Dump()))
1735 nodes, errs := parser.Parse()
1736 if errs != nil {
1737 return []starlarkNode{ctx.newBadNode(node, "Unable to parse eval statement")}
1738 }
1739
1740 if len(nodes) == 0 {
1741 return []starlarkNode{}
1742 } else if len(nodes) == 1 {
1743 switch n := nodes[0].(type) {
1744 case *mkparser.Assignment:
1745 if n.Name.Const() {
1746 return ctx.handleAssignment(n)
1747 }
1748 case *mkparser.Comment:
1749 return []starlarkNode{&commentNode{strings.TrimSpace("#" + n.Comment)}}
1750 }
1751 }
1752
1753 return []starlarkNode{ctx.newBadNode(node, "Eval expression too complex; only assignments and comments are supported")}
1754}
1755
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001756func (ctx *parseContext) parseMakeString(node mkparser.Node, mk *mkparser.MakeString) starlarkExpr {
1757 if mk.Const() {
1758 return &stringLiteralExpr{mk.Dump()}
1759 }
1760 if mkRef, ok := mk.SingleVariable(); ok {
1761 return ctx.parseReference(node, mkRef)
1762 }
1763 // If we reached here, it's neither string literal nor a simple variable,
1764 // we need a full-blown interpolation node that will generate
1765 // "a%b%c" % (X, Y) for a$(X)b$(Y)c
Cole Faustfc438682021-12-14 12:46:32 -08001766 parts := make([]starlarkExpr, len(mk.Variables)+len(mk.Strings))
1767 for i := 0; i < len(parts); i++ {
1768 if i%2 == 0 {
1769 parts[i] = &stringLiteralExpr{literal: mk.Strings[i/2]}
1770 } else {
1771 parts[i] = ctx.parseReference(node, mk.Variables[i/2].Name)
1772 if x, ok := parts[i].(*badExpr); ok {
1773 return x
1774 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001775 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001776 }
Cole Faustfc438682021-12-14 12:46:32 -08001777 return NewInterpolateExpr(parts)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001778}
1779
Cole Faustf035d402022-03-28 14:02:50 -07001780func (ctx *parseContext) parseNodeMakeString(node mkparser.Node, mk *mkparser.MakeString) []starlarkNode {
1781 // Discard any constant values in the make string, as they would be top level
1782 // string literals and do nothing.
1783 result := make([]starlarkNode, 0, len(mk.Variables))
1784 for i := range mk.Variables {
1785 result = append(result, ctx.handleVariable(&mk.Variables[i])...)
1786 }
1787 return result
1788}
1789
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001790// Handles the statements whose treatment is the same in all contexts: comment,
1791// assignment, variable (which is a macro call in reality) and all constructs that
1792// do not handle in any context ('define directive and any unrecognized stuff).
Cole Faustdd569ae2022-01-31 15:48:29 -08001793func (ctx *parseContext) handleSimpleStatement(node mkparser.Node) []starlarkNode {
1794 var result []starlarkNode
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001795 switch x := node.(type) {
1796 case *mkparser.Comment:
Cole Faustdd569ae2022-01-31 15:48:29 -08001797 if n, handled := ctx.maybeHandleAnnotation(x); handled && n != nil {
1798 result = []starlarkNode{n}
1799 } else if !handled {
1800 result = []starlarkNode{&commentNode{strings.TrimSpace("#" + x.Comment)}}
Cole Faust7940c6a2022-01-31 15:54:05 -08001801 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001802 case *mkparser.Assignment:
Cole Faustdd569ae2022-01-31 15:48:29 -08001803 result = ctx.handleAssignment(x)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001804 case *mkparser.Variable:
Cole Faustdd569ae2022-01-31 15:48:29 -08001805 result = ctx.handleVariable(x)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001806 case *mkparser.Directive:
1807 switch x.Name {
1808 case "define":
Cole Faustdd569ae2022-01-31 15:48:29 -08001809 if res := ctx.maybeHandleDefine(x); res != nil {
1810 result = []starlarkNode{res}
1811 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001812 case "include", "-include":
Cole Faustdd569ae2022-01-31 15:48:29 -08001813 result = ctx.handleInclude(node, ctx.parseMakeString(node, x.Args), x.Name[0] != '-')
Cole Faust591a1fe2021-11-08 15:37:57 -08001814 case "ifeq", "ifneq", "ifdef", "ifndef":
Cole Faustdd569ae2022-01-31 15:48:29 -08001815 result = []starlarkNode{ctx.handleIfBlock(x)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001816 default:
Cole Faustdd569ae2022-01-31 15:48:29 -08001817 result = []starlarkNode{ctx.newBadNode(x, "unexpected directive %s", x.Name)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001818 }
1819 default:
Cole Faustdd569ae2022-01-31 15:48:29 -08001820 result = []starlarkNode{ctx.newBadNode(x, "unsupported line %s", strings.ReplaceAll(x.Dump(), "\n", "\n#"))}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001821 }
Cole Faust6c934f62022-01-06 15:51:12 -08001822
1823 // Clear the includeTops after each non-comment statement
1824 // so that include annotations placed on certain statements don't apply
1825 // globally for the rest of the makefile was well.
Cole Faustf92c9f22022-03-14 14:35:50 -07001826 if _, wasComment := node.(*mkparser.Comment); !wasComment {
1827 ctx.atTopOfMakefile = false
Cole Faust6c934f62022-01-06 15:51:12 -08001828 ctx.includeTops = []string{}
1829 }
Cole Faustdd569ae2022-01-31 15:48:29 -08001830
1831 if result == nil {
1832 result = []starlarkNode{}
1833 }
Cole Faustf035d402022-03-28 14:02:50 -07001834
Cole Faustdd569ae2022-01-31 15:48:29 -08001835 return result
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001836}
1837
Cole Faustf92c9f22022-03-14 14:35:50 -07001838// The types allowed in a type_hint
1839var typeHintMap = map[string]starlarkType{
1840 "string": starlarkTypeString,
1841 "list": starlarkTypeList,
1842}
1843
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001844// Processes annotation. An annotation is a comment that starts with #RBC# and provides
1845// a conversion hint -- say, where to look for the dynamically calculated inherit/include
Cole Faust7940c6a2022-01-31 15:54:05 -08001846// paths. Returns true if the comment was a successfully-handled annotation.
Cole Faustdd569ae2022-01-31 15:48:29 -08001847func (ctx *parseContext) maybeHandleAnnotation(cnode *mkparser.Comment) (starlarkNode, bool) {
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001848 maybeTrim := func(s, prefix string) (string, bool) {
1849 if strings.HasPrefix(s, prefix) {
1850 return strings.TrimSpace(strings.TrimPrefix(s, prefix)), true
1851 }
1852 return s, false
1853 }
1854 annotation, ok := maybeTrim(cnode.Comment, annotationCommentPrefix)
1855 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -08001856 return nil, false
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001857 }
1858 if p, ok := maybeTrim(annotation, "include_top"); ok {
Cole Faustf7ed5342021-12-21 14:15:12 -08001859 // Don't allow duplicate include tops, because then we will generate
1860 // invalid starlark code. (duplicate keys in the _entry dictionary)
1861 for _, top := range ctx.includeTops {
1862 if top == p {
Cole Faustdd569ae2022-01-31 15:48:29 -08001863 return nil, true
Cole Faustf7ed5342021-12-21 14:15:12 -08001864 }
1865 }
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001866 ctx.includeTops = append(ctx.includeTops, p)
Cole Faustdd569ae2022-01-31 15:48:29 -08001867 return nil, true
Cole Faustf92c9f22022-03-14 14:35:50 -07001868 } else if p, ok := maybeTrim(annotation, "type_hint"); ok {
1869 // Type hints must come at the beginning the file, to avoid confusion
1870 // if a type hint was specified later and thus only takes effect for half
1871 // of the file.
1872 if !ctx.atTopOfMakefile {
1873 return ctx.newBadNode(cnode, "type_hint annotations must come before the first Makefile statement"), true
1874 }
1875
1876 parts := strings.Fields(p)
1877 if len(parts) <= 1 {
1878 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
1879 }
1880
1881 var varType starlarkType
1882 if varType, ok = typeHintMap[parts[0]]; !ok {
1883 varType = starlarkTypeUnknown
1884 }
1885 if varType == starlarkTypeUnknown {
1886 return ctx.newBadNode(cnode, "Invalid type_hint annotation. Only list/string types are accepted, found %s", parts[0]), true
1887 }
1888
1889 for _, name := range parts[1:] {
1890 // Don't allow duplicate type hints
1891 if _, ok := ctx.typeHints[name]; ok {
1892 return ctx.newBadNode(cnode, "Duplicate type hint for variable %s", name), true
1893 }
1894 ctx.typeHints[name] = varType
1895 }
1896 return nil, true
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001897 }
Cole Faustdd569ae2022-01-31 15:48:29 -08001898 return ctx.newBadNode(cnode, "unsupported annotation %s", cnode.Comment), true
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001899}
1900
1901func (ctx *parseContext) loadedModulePath(path string) string {
1902 // During the transition to Roboleaf some of the product configuration files
1903 // will be converted and checked in while the others will be generated on the fly
1904 // and run. The runner (rbcrun application) accommodates this by allowing three
1905 // different ways to specify the loaded file location:
1906 // 1) load(":<file>",...) loads <file> from the same directory
1907 // 2) load("//path/relative/to/source/root:<file>", ...) loads <file> source tree
1908 // 3) load("/absolute/path/to/<file> absolute path
1909 // If the file being generated and the file it wants to load are in the same directory,
1910 // generate option 1.
1911 // Otherwise, if output directory is not specified, generate 2)
1912 // Finally, if output directory has been specified and the file being generated and
1913 // the file it wants to load from are in the different directories, generate 2) or 3):
1914 // * if the file being loaded exists in the source tree, generate 2)
1915 // * otherwise, generate 3)
1916 // Finally, figure out the loaded module path and name and create a node for it
1917 loadedModuleDir := filepath.Dir(path)
1918 base := filepath.Base(path)
1919 loadedModuleName := strings.TrimSuffix(base, filepath.Ext(base)) + ctx.outputSuffix
1920 if loadedModuleDir == filepath.Dir(ctx.script.mkFile) {
1921 return ":" + loadedModuleName
1922 }
1923 if ctx.outputDir == "" {
1924 return fmt.Sprintf("//%s:%s", loadedModuleDir, loadedModuleName)
1925 }
1926 if _, err := os.Stat(filepath.Join(loadedModuleDir, loadedModuleName)); err == nil {
1927 return fmt.Sprintf("//%s:%s", loadedModuleDir, loadedModuleName)
1928 }
1929 return filepath.Join(ctx.outputDir, loadedModuleDir, loadedModuleName)
1930}
1931
Sasha Smundak3deb9682021-07-26 18:42:25 -07001932func (ctx *parseContext) addSoongNamespace(ns string) {
1933 if _, ok := ctx.soongNamespaces[ns]; ok {
1934 return
1935 }
1936 ctx.soongNamespaces[ns] = make(map[string]bool)
1937}
1938
1939func (ctx *parseContext) hasSoongNamespace(name string) bool {
1940 _, ok := ctx.soongNamespaces[name]
1941 return ok
1942}
1943
1944func (ctx *parseContext) updateSoongNamespace(replace bool, namespaceName string, varNames []string) {
1945 ctx.addSoongNamespace(namespaceName)
1946 vars := ctx.soongNamespaces[namespaceName]
1947 if replace {
1948 vars = make(map[string]bool)
1949 ctx.soongNamespaces[namespaceName] = vars
1950 }
1951 for _, v := range varNames {
1952 vars[v] = true
1953 }
1954}
1955
1956func (ctx *parseContext) hasNamespaceVar(namespaceName string, varName string) bool {
1957 vars, ok := ctx.soongNamespaces[namespaceName]
1958 if ok {
1959 _, ok = vars[varName]
1960 }
1961 return ok
1962}
1963
Sasha Smundak422b6142021-11-11 18:31:59 -08001964func (ctx *parseContext) errorLocation(node mkparser.Node) ErrorLocation {
1965 return ErrorLocation{ctx.script.mkFile, ctx.script.nodeLocator(node.Pos())}
1966}
1967
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001968func (ss *StarlarkScript) String() string {
1969 return NewGenerateContext(ss).emit()
1970}
1971
1972func (ss *StarlarkScript) SubConfigFiles() []string {
Sasha Smundak6609ba72021-07-22 18:32:56 -07001973
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001974 var subs []string
1975 for _, src := range ss.inherited {
1976 subs = append(subs, src.originalPath)
1977 }
1978 return subs
1979}
1980
1981func (ss *StarlarkScript) HasErrors() bool {
1982 return ss.hasErrors
1983}
1984
1985// Convert reads and parses a makefile. If successful, parsed tree
1986// is returned and then can be passed to String() to get the generated
1987// Starlark file.
1988func Convert(req Request) (*StarlarkScript, error) {
1989 reader := req.Reader
1990 if reader == nil {
1991 mkContents, err := ioutil.ReadFile(req.MkFile)
1992 if err != nil {
1993 return nil, err
1994 }
1995 reader = bytes.NewBuffer(mkContents)
1996 }
1997 parser := mkparser.NewParser(req.MkFile, reader)
1998 nodes, errs := parser.Parse()
1999 if len(errs) > 0 {
2000 for _, e := range errs {
2001 fmt.Fprintln(os.Stderr, "ERROR:", e)
2002 }
2003 return nil, fmt.Errorf("bad makefile %s", req.MkFile)
2004 }
2005 starScript := &StarlarkScript{
Sasha Smundak422b6142021-11-11 18:31:59 -08002006 moduleName: moduleNameForFile(req.MkFile),
2007 mkFile: req.MkFile,
Sasha Smundak422b6142021-11-11 18:31:59 -08002008 traceCalls: req.TraceCalls,
2009 sourceFS: req.SourceFS,
2010 makefileFinder: req.MakefileFinder,
2011 nodeLocator: func(pos mkparser.Pos) int { return parser.Unpack(pos).Line },
Cole Faustdd569ae2022-01-31 15:48:29 -08002012 nodes: make([]starlarkNode, 0),
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002013 }
2014 ctx := newParseContext(starScript, nodes)
2015 ctx.outputSuffix = req.OutputSuffix
2016 ctx.outputDir = req.OutputDir
2017 ctx.errorLogger = req.ErrorLogger
2018 if len(req.TracedVariables) > 0 {
2019 ctx.tracedVariables = make(map[string]bool)
2020 for _, v := range req.TracedVariables {
2021 ctx.tracedVariables[v] = true
2022 }
2023 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002024 for ctx.hasNodes() && ctx.fatalError == nil {
Cole Faustdd569ae2022-01-31 15:48:29 -08002025 starScript.nodes = append(starScript.nodes, ctx.handleSimpleStatement(ctx.getNode())...)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002026 }
2027 if ctx.fatalError != nil {
2028 return nil, ctx.fatalError
2029 }
2030 return starScript, nil
2031}
2032
Cole Faust864028a2021-12-01 13:43:17 -08002033func Launcher(mainModuleUri, inputVariablesUri, mainModuleName string) string {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002034 var buf bytes.Buffer
2035 fmt.Fprintf(&buf, "load(%q, %q)\n", baseUri, baseName)
Cole Faust864028a2021-12-01 13:43:17 -08002036 fmt.Fprintf(&buf, "load(%q, input_variables_init = \"init\")\n", inputVariablesUri)
Sasha Smundakd7d07ad2021-09-10 15:42:34 -07002037 fmt.Fprintf(&buf, "load(%q, \"init\")\n", mainModuleUri)
Cole Faust864028a2021-12-01 13:43:17 -08002038 fmt.Fprintf(&buf, "%s(%s(%q, init, input_variables_init))\n", cfnPrintVars, cfnMain, mainModuleName)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002039 return buf.String()
2040}
2041
Cole Faust6ed7cb42021-10-07 17:08:46 -07002042func BoardLauncher(mainModuleUri string, inputVariablesUri string) string {
2043 var buf bytes.Buffer
2044 fmt.Fprintf(&buf, "load(%q, %q)\n", baseUri, baseName)
2045 fmt.Fprintf(&buf, "load(%q, \"init\")\n", mainModuleUri)
2046 fmt.Fprintf(&buf, "load(%q, input_variables_init = \"init\")\n", inputVariablesUri)
Cole Fausta0604662022-02-28 11:53:58 -08002047 fmt.Fprintf(&buf, "%s(%s(init, input_variables_init))\n", cfnPrintVars, cfnBoardMain)
Cole Faust6ed7cb42021-10-07 17:08:46 -07002048 return buf.String()
2049}
2050
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002051func MakePath2ModuleName(mkPath string) string {
2052 return strings.TrimSuffix(mkPath, filepath.Ext(mkPath))
2053}