blob: 0942c28c0faddf405432215e08e4abf48076caf0 [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"
Cole Faust62e05112022-04-05 17:56:11 -070035 "sort"
Sasha Smundakb051c4e2020-11-05 20:45:07 -080036 "strconv"
37 "strings"
38 "text/scanner"
39
40 mkparser "android/soong/androidmk/parser"
41)
42
43const (
Sasha Smundak6d852dd2021-09-27 20:34:39 -070044 annotationCommentPrefix = "RBC#"
45 baseUri = "//build/make/core:product_config.rbc"
Sasha Smundakb051c4e2020-11-05 20:45:07 -080046 // The name of the struct exported by the product_config.rbc
47 // that contains the functions and variables available to
48 // product configuration Starlark files.
49 baseName = "rblf"
50
Sasha Smundak65b547e2021-09-17 15:35:41 -070051 soongNsPrefix = "SOONG_CONFIG_"
52
Sasha Smundakb051c4e2020-11-05 20:45:07 -080053 // And here are the functions and variables:
Cole Fauste2a37982022-03-09 16:00:17 -080054 cfnGetCfg = baseName + ".cfg"
55 cfnMain = baseName + ".product_configuration"
56 cfnBoardMain = baseName + ".board_configuration"
57 cfnPrintVars = baseName + ".printvars"
58 cfnInherit = baseName + ".inherit"
59 cfnSetListDefault = baseName + ".setdefault"
Sasha Smundakb051c4e2020-11-05 20:45:07 -080060)
61
62const (
Cole Faust9ebf6e42021-12-13 14:08:34 -080063 soongConfigAppend = "soong_config_append"
64 soongConfigAssign = "soong_config_set"
Sasha Smundakb051c4e2020-11-05 20:45:07 -080065)
66
Cole Faust9ebf6e42021-12-13 14:08:34 -080067var knownFunctions = map[string]interface {
68 parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr
Sasha Smundakb051c4e2020-11-05 20:45:07 -080069}{
Cole Faust1cc08852022-02-28 11:12:08 -080070 "abspath": &simpleCallParser{name: baseName + ".abspath", returnType: starlarkTypeString},
71 "add-product-dex-preopt-module-config": &simpleCallParser{name: baseName + ".add_product_dex_preopt_module_config", returnType: starlarkTypeString, addHandle: true},
72 "add_soong_config_namespace": &simpleCallParser{name: baseName + ".soong_config_namespace", returnType: starlarkTypeVoid, addGlobals: true},
73 "add_soong_config_var_value": &simpleCallParser{name: baseName + ".soong_config_set", returnType: starlarkTypeVoid, addGlobals: true},
74 soongConfigAssign: &simpleCallParser{name: baseName + ".soong_config_set", returnType: starlarkTypeVoid, addGlobals: true},
75 soongConfigAppend: &simpleCallParser{name: baseName + ".soong_config_append", returnType: starlarkTypeVoid, addGlobals: true},
76 "soong_config_get": &simpleCallParser{name: baseName + ".soong_config_get", returnType: starlarkTypeString, addGlobals: true},
77 "add-to-product-copy-files-if-exists": &simpleCallParser{name: baseName + ".copy_if_exists", returnType: starlarkTypeList},
78 "addprefix": &simpleCallParser{name: baseName + ".addprefix", returnType: starlarkTypeList},
79 "addsuffix": &simpleCallParser{name: baseName + ".addsuffix", returnType: starlarkTypeList},
80 "copy-files": &simpleCallParser{name: baseName + ".copy_files", returnType: starlarkTypeList},
Cole Faust0e2b2562022-04-01 11:46:50 -070081 "dir": &simpleCallParser{name: baseName + ".dir", returnType: starlarkTypeString},
Cole Faust1cc08852022-02-28 11:12:08 -080082 "dist-for-goals": &simpleCallParser{name: baseName + ".mkdist_for_goals", returnType: starlarkTypeVoid, addGlobals: true},
83 "enforce-product-packages-exist": &simpleCallParser{name: baseName + ".enforce_product_packages_exist", returnType: starlarkTypeVoid},
84 "error": &makeControlFuncParser{name: baseName + ".mkerror"},
85 "findstring": &simpleCallParser{name: baseName + ".findstring", returnType: starlarkTypeInt},
86 "find-copy-subdir-files": &simpleCallParser{name: baseName + ".find_and_copy", returnType: starlarkTypeList},
87 "filter": &simpleCallParser{name: baseName + ".filter", returnType: starlarkTypeList},
88 "filter-out": &simpleCallParser{name: baseName + ".filter_out", returnType: starlarkTypeList},
89 "firstword": &firstOrLastwordCallParser{isLastWord: false},
Cole Faustf035d402022-03-28 14:02:50 -070090 "foreach": &foreachCallParser{},
Cole Faust1cc08852022-02-28 11:12:08 -080091 "if": &ifCallParser{},
92 "info": &makeControlFuncParser{name: baseName + ".mkinfo"},
93 "is-board-platform": &simpleCallParser{name: baseName + ".board_platform_is", returnType: starlarkTypeBool, addGlobals: true},
94 "is-board-platform2": &simpleCallParser{name: baseName + ".board_platform_is", returnType: starlarkTypeBool, addGlobals: true},
95 "is-board-platform-in-list": &simpleCallParser{name: baseName + ".board_platform_in", returnType: starlarkTypeBool, addGlobals: true},
96 "is-board-platform-in-list2": &simpleCallParser{name: baseName + ".board_platform_in", returnType: starlarkTypeBool, addGlobals: true},
97 "is-product-in-list": &isProductInListCallParser{},
98 "is-vendor-board-platform": &isVendorBoardPlatformCallParser{},
99 "is-vendor-board-qcom": &isVendorBoardQcomCallParser{},
100 "lastword": &firstOrLastwordCallParser{isLastWord: true},
101 "notdir": &simpleCallParser{name: baseName + ".notdir", returnType: starlarkTypeString},
102 "math_max": &mathMaxOrMinCallParser{function: "max"},
103 "math_min": &mathMaxOrMinCallParser{function: "min"},
104 "math_gt_or_eq": &mathComparisonCallParser{op: ">="},
105 "math_gt": &mathComparisonCallParser{op: ">"},
106 "math_lt": &mathComparisonCallParser{op: "<"},
107 "my-dir": &myDirCallParser{},
108 "patsubst": &substCallParser{fname: "patsubst"},
109 "product-copy-files-by-pattern": &simpleCallParser{name: baseName + ".product_copy_files_by_pattern", returnType: starlarkTypeList},
110 "require-artifacts-in-path": &simpleCallParser{name: baseName + ".require_artifacts_in_path", returnType: starlarkTypeVoid},
111 "require-artifacts-in-path-relaxed": &simpleCallParser{name: baseName + ".require_artifacts_in_path_relaxed", returnType: starlarkTypeVoid},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800112 // TODO(asmundak): remove it once all calls are removed from configuration makefiles. see b/183161002
Cole Faust9ebf6e42021-12-13 14:08:34 -0800113 "shell": &shellCallParser{},
Cole Faust95b95cb2022-04-05 16:37:39 -0700114 "sort": &simpleCallParser{name: baseName + ".mksort", returnType: starlarkTypeList},
Cole Faust1cc08852022-02-28 11:12:08 -0800115 "strip": &simpleCallParser{name: baseName + ".mkstrip", returnType: starlarkTypeString},
Cole Faust9ebf6e42021-12-13 14:08:34 -0800116 "subst": &substCallParser{fname: "subst"},
117 "warning": &makeControlFuncParser{name: baseName + ".mkwarning"},
118 "word": &wordCallParser{},
Cole Faust1cc08852022-02-28 11:12:08 -0800119 "wildcard": &simpleCallParser{name: baseName + ".expand_wildcard", returnType: starlarkTypeList},
Cole Faust9ebf6e42021-12-13 14:08:34 -0800120}
121
Cole Faustf035d402022-03-28 14:02:50 -0700122// The same as knownFunctions, but returns a []starlarkNode instead of a starlarkExpr
123var knownNodeFunctions = map[string]interface {
124 parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) []starlarkNode
125}{
126 "eval": &evalNodeParser{},
127 "if": &ifCallNodeParser{},
128 "inherit-product": &inheritProductCallParser{loadAlways: true},
129 "inherit-product-if-exists": &inheritProductCallParser{loadAlways: false},
130 "foreach": &foreachCallNodeParser{},
131}
132
Cole Faust9ebf6e42021-12-13 14:08:34 -0800133// These are functions that we don't implement conversions for, but
134// we allow seeing their definitions in the product config files.
135var ignoredDefines = map[string]bool{
136 "find-word-in-list": true, // internal macro
137 "get-vendor-board-platforms": true, // internal macro, used by is-board-platform, etc.
138 "is-android-codename": true, // unused by product config
139 "is-android-codename-in-list": true, // unused by product config
140 "is-chipset-in-board-platform": true, // unused by product config
141 "is-chipset-prefix-in-board-platform": true, // unused by product config
142 "is-not-board-platform": true, // defined but never used
143 "is-platform-sdk-version-at-least": true, // unused by product config
144 "match-prefix": true, // internal macro
145 "match-word": true, // internal macro
146 "match-word-in-list": true, // internal macro
147 "tb-modules": true, // defined in hardware/amlogic/tb_modules/tb_detect.mk, unused
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800148}
149
Cole Faustb0d32ab2021-12-09 14:00:59 -0800150var identifierFullMatchRegex = regexp.MustCompile("^[a-zA-Z_][a-zA-Z0-9_]*$")
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800151
152// Conversion request parameters
153type Request struct {
Sasha Smundak422b6142021-11-11 18:31:59 -0800154 MkFile string // file to convert
155 Reader io.Reader // if set, read input from this stream instead
Sasha Smundak422b6142021-11-11 18:31:59 -0800156 OutputSuffix string // generated Starlark files suffix
157 OutputDir string // if set, root of the output hierarchy
158 ErrorLogger ErrorLogger
159 TracedVariables []string // trace assignment to these variables
160 TraceCalls bool
161 SourceFS fs.FS
162 MakefileFinder MakefileFinder
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800163}
164
Sasha Smundak7d934b92021-11-10 12:20:01 -0800165// ErrorLogger prints errors and gathers error statistics.
166// Its NewError function is called on every error encountered during the conversion.
167type ErrorLogger interface {
Sasha Smundak422b6142021-11-11 18:31:59 -0800168 NewError(el ErrorLocation, node mkparser.Node, text string, args ...interface{})
169}
170
171type ErrorLocation struct {
172 MkFile string
173 MkLine int
174}
175
176func (el ErrorLocation) String() string {
177 return fmt.Sprintf("%s:%d", el.MkFile, el.MkLine)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800178}
179
180// Derives module name for a given file. It is base name
181// (file name without suffix), with some characters replaced to make it a Starlark identifier
182func moduleNameForFile(mkFile string) string {
183 base := strings.TrimSuffix(filepath.Base(mkFile), filepath.Ext(mkFile))
184 // TODO(asmundak): what else can be in the product file names?
Sasha Smundak6609ba72021-07-22 18:32:56 -0700185 return strings.NewReplacer("-", "_", ".", "_").Replace(base)
186
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800187}
188
189func cloneMakeString(mkString *mkparser.MakeString) *mkparser.MakeString {
190 r := &mkparser.MakeString{StringPos: mkString.StringPos}
191 r.Strings = append(r.Strings, mkString.Strings...)
192 r.Variables = append(r.Variables, mkString.Variables...)
193 return r
194}
195
196func isMakeControlFunc(s string) bool {
197 return s == "error" || s == "warning" || s == "info"
198}
199
200// Starlark output generation context
201type generationContext struct {
202 buf strings.Builder
203 starScript *StarlarkScript
204 indentLevel int
205 inAssignment bool
206 tracedCount int
207}
208
209func NewGenerateContext(ss *StarlarkScript) *generationContext {
210 return &generationContext{starScript: ss}
211}
212
213// emit returns generated script
214func (gctx *generationContext) emit() string {
215 ss := gctx.starScript
216
217 // The emitted code has the following layout:
218 // <initial comments>
219 // preamble, i.e.,
220 // load statement for the runtime support
221 // load statement for each unique submodule pulled in by this one
222 // def init(g, handle):
223 // cfg = rblf.cfg(handle)
224 // <statements>
225 // <warning if conversion was not clean>
226
227 iNode := len(ss.nodes)
228 for i, node := range ss.nodes {
229 if _, ok := node.(*commentNode); !ok {
230 iNode = i
231 break
232 }
233 node.emit(gctx)
234 }
235
236 gctx.emitPreamble()
237
238 gctx.newLine()
239 // The arguments passed to the init function are the global dictionary
240 // ('g') and the product configuration dictionary ('cfg')
241 gctx.write("def init(g, handle):")
242 gctx.indentLevel++
243 if gctx.starScript.traceCalls {
244 gctx.newLine()
245 gctx.writef(`print(">%s")`, gctx.starScript.mkFile)
246 }
247 gctx.newLine()
248 gctx.writef("cfg = %s(handle)", cfnGetCfg)
249 for _, node := range ss.nodes[iNode:] {
250 node.emit(gctx)
251 }
252
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800253 if gctx.starScript.traceCalls {
254 gctx.newLine()
255 gctx.writef(`print("<%s")`, gctx.starScript.mkFile)
256 }
257 gctx.indentLevel--
258 gctx.write("\n")
259 return gctx.buf.String()
260}
261
262func (gctx *generationContext) emitPreamble() {
263 gctx.newLine()
264 gctx.writef("load(%q, %q)", baseUri, baseName)
265 // Emit exactly one load statement for each URI.
266 loadedSubConfigs := make(map[string]string)
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800267 for _, mi := range gctx.starScript.inherited {
268 uri := mi.path
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800269 if m, ok := loadedSubConfigs[uri]; ok {
270 // No need to emit load statement, but fix module name.
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800271 mi.moduleLocalName = m
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800272 continue
273 }
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800274 if mi.optional || mi.missing {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800275 uri += "|init"
276 }
277 gctx.newLine()
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800278 gctx.writef("load(%q, %s = \"init\")", uri, mi.entryName())
279 loadedSubConfigs[uri] = mi.moduleLocalName
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800280 }
281 gctx.write("\n")
282}
283
284func (gctx *generationContext) emitPass() {
285 gctx.newLine()
286 gctx.write("pass")
287}
288
289func (gctx *generationContext) write(ss ...string) {
290 for _, s := range ss {
291 gctx.buf.WriteString(s)
292 }
293}
294
295func (gctx *generationContext) writef(format string, args ...interface{}) {
296 gctx.write(fmt.Sprintf(format, args...))
297}
298
299func (gctx *generationContext) newLine() {
300 if gctx.buf.Len() == 0 {
301 return
302 }
303 gctx.write("\n")
304 gctx.writef("%*s", 2*gctx.indentLevel, "")
305}
306
Sasha Smundak422b6142021-11-11 18:31:59 -0800307func (gctx *generationContext) emitConversionError(el ErrorLocation, message string) {
308 gctx.writef(`rblf.mk2rbc_error("%s", %q)`, el, message)
309}
310
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800311func (gctx *generationContext) emitLoadCheck(im inheritedModule) {
312 if !im.needsLoadCheck() {
313 return
314 }
315 gctx.newLine()
316 gctx.writef("if not %s:", im.entryName())
317 gctx.indentLevel++
318 gctx.newLine()
319 gctx.write(`rblf.mkerror("`, gctx.starScript.mkFile, `", "Cannot find %s" % (`)
320 im.pathExpr().emit(gctx)
321 gctx.write("))")
322 gctx.indentLevel--
323}
324
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800325type knownVariable struct {
326 name string
327 class varClass
328 valueType starlarkType
329}
330
331type knownVariables map[string]knownVariable
332
333func (pcv knownVariables) NewVariable(name string, varClass varClass, valueType starlarkType) {
334 v, exists := pcv[name]
335 if !exists {
336 pcv[name] = knownVariable{name, varClass, valueType}
337 return
338 }
339 // Conflict resolution:
340 // * config class trumps everything
341 // * any type trumps unknown type
342 match := varClass == v.class
343 if !match {
344 if varClass == VarClassConfig {
345 v.class = VarClassConfig
346 match = true
347 } else if v.class == VarClassConfig {
348 match = true
349 }
350 }
351 if valueType != v.valueType {
352 if valueType != starlarkTypeUnknown {
353 if v.valueType == starlarkTypeUnknown {
354 v.valueType = valueType
355 } else {
356 match = false
357 }
358 }
359 }
360 if !match {
361 fmt.Fprintf(os.Stderr, "cannot redefine %s as %v/%v (already defined as %v/%v)\n",
362 name, varClass, valueType, v.class, v.valueType)
363 }
364}
365
366// All known product variables.
367var KnownVariables = make(knownVariables)
368
369func init() {
370 for _, kv := range []string{
371 // Kernel-related variables that we know are lists.
372 "BOARD_VENDOR_KERNEL_MODULES",
373 "BOARD_VENDOR_RAMDISK_KERNEL_MODULES",
374 "BOARD_VENDOR_RAMDISK_KERNEL_MODULES_LOAD",
375 "BOARD_RECOVERY_KERNEL_MODULES",
376 // Other variables we knwo are lists
377 "ART_APEX_JARS",
378 } {
379 KnownVariables.NewVariable(kv, VarClassSoong, starlarkTypeList)
380 }
381}
382
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800383// Information about the generated Starlark script.
384type StarlarkScript struct {
Sasha Smundak422b6142021-11-11 18:31:59 -0800385 mkFile string
386 moduleName string
387 mkPos scanner.Position
388 nodes []starlarkNode
389 inherited []*moduleInfo
390 hasErrors bool
Sasha Smundak422b6142021-11-11 18:31:59 -0800391 traceCalls bool // print enter/exit each init function
392 sourceFS fs.FS
393 makefileFinder MakefileFinder
394 nodeLocator func(pos mkparser.Pos) int
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800395}
396
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800397// varAssignmentScope points to the last assignment for each variable
398// in the current block. It is used during the parsing to chain
399// the assignments to a variable together.
400type varAssignmentScope struct {
401 outer *varAssignmentScope
402 vars map[string]*assignmentNode
403}
404
405// parseContext holds the script we are generating and all the ephemeral data
406// needed during the parsing.
407type parseContext struct {
408 script *StarlarkScript
409 nodes []mkparser.Node // Makefile as parsed by mkparser
410 currentNodeIndex int // Node in it we are processing
411 ifNestLevel int
412 moduleNameCount map[string]int // count of imported modules with given basename
413 fatalError error
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800414 outputSuffix string
Sasha Smundak7d934b92021-11-10 12:20:01 -0800415 errorLogger ErrorLogger
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800416 tracedVariables map[string]bool // variables to be traced in the generated script
417 variables map[string]variable
418 varAssignments *varAssignmentScope
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800419 outputDir string
Sasha Smundak6609ba72021-07-22 18:32:56 -0700420 dependentModules map[string]*moduleInfo
Sasha Smundak3deb9682021-07-26 18:42:25 -0700421 soongNamespaces map[string]map[string]bool
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700422 includeTops []string
Cole Faustf92c9f22022-03-14 14:35:50 -0700423 typeHints map[string]starlarkType
424 atTopOfMakefile bool
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800425}
426
427func newParseContext(ss *StarlarkScript, nodes []mkparser.Node) *parseContext {
428 predefined := []struct{ name, value string }{
429 {"SRC_TARGET_DIR", filepath.Join("build", "make", "target")},
430 {"LOCAL_PATH", filepath.Dir(ss.mkFile)},
Cole Faust9b6111a2022-02-02 15:38:33 -0800431 {"TOPDIR", ""}, // TOPDIR is just set to an empty string in cleanbuild.mk and core.mk
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800432 // TODO(asmundak): maybe read it from build/make/core/envsetup.mk?
433 {"TARGET_COPY_OUT_SYSTEM", "system"},
434 {"TARGET_COPY_OUT_SYSTEM_OTHER", "system_other"},
435 {"TARGET_COPY_OUT_DATA", "data"},
436 {"TARGET_COPY_OUT_ASAN", filepath.Join("data", "asan")},
437 {"TARGET_COPY_OUT_OEM", "oem"},
438 {"TARGET_COPY_OUT_RAMDISK", "ramdisk"},
439 {"TARGET_COPY_OUT_DEBUG_RAMDISK", "debug_ramdisk"},
440 {"TARGET_COPY_OUT_VENDOR_DEBUG_RAMDISK", "vendor_debug_ramdisk"},
441 {"TARGET_COPY_OUT_TEST_HARNESS_RAMDISK", "test_harness_ramdisk"},
442 {"TARGET_COPY_OUT_ROOT", "root"},
443 {"TARGET_COPY_OUT_RECOVERY", "recovery"},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800444 {"TARGET_COPY_OUT_VENDOR_RAMDISK", "vendor_ramdisk"},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800445 // TODO(asmundak): to process internal config files, we need the following variables:
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800446 // TARGET_VENDOR
447 // target_base_product
448 //
449
450 // the following utility variables are set in build/make/common/core.mk:
451 {"empty", ""},
452 {"space", " "},
453 {"comma", ","},
454 {"newline", "\n"},
455 {"pound", "#"},
456 {"backslash", "\\"},
457 }
458 ctx := &parseContext{
459 script: ss,
460 nodes: nodes,
461 currentNodeIndex: 0,
462 ifNestLevel: 0,
463 moduleNameCount: make(map[string]int),
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800464 variables: make(map[string]variable),
Sasha Smundak6609ba72021-07-22 18:32:56 -0700465 dependentModules: make(map[string]*moduleInfo),
Sasha Smundak3deb9682021-07-26 18:42:25 -0700466 soongNamespaces: make(map[string]map[string]bool),
Cole Faust6c934f62022-01-06 15:51:12 -0800467 includeTops: []string{},
Cole Faustf92c9f22022-03-14 14:35:50 -0700468 typeHints: make(map[string]starlarkType),
469 atTopOfMakefile: true,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800470 }
471 ctx.pushVarAssignments()
472 for _, item := range predefined {
473 ctx.variables[item.name] = &predefinedVariable{
474 baseVariable: baseVariable{nam: item.name, typ: starlarkTypeString},
475 value: &stringLiteralExpr{item.value},
476 }
477 }
478
479 return ctx
480}
481
Cole Faust3c4fc992022-02-28 16:05:01 -0800482func (ctx *parseContext) lastAssignment(v variable) *assignmentNode {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800483 for va := ctx.varAssignments; va != nil; va = va.outer {
Cole Faust3c4fc992022-02-28 16:05:01 -0800484 if v, ok := va.vars[v.name()]; ok {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800485 return v
486 }
487 }
488 return nil
489}
490
Cole Faust3c4fc992022-02-28 16:05:01 -0800491func (ctx *parseContext) setLastAssignment(v variable, asgn *assignmentNode) {
492 ctx.varAssignments.vars[v.name()] = asgn
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800493}
494
495func (ctx *parseContext) pushVarAssignments() {
496 va := &varAssignmentScope{
497 outer: ctx.varAssignments,
498 vars: make(map[string]*assignmentNode),
499 }
500 ctx.varAssignments = va
501}
502
503func (ctx *parseContext) popVarAssignments() {
504 ctx.varAssignments = ctx.varAssignments.outer
505}
506
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800507func (ctx *parseContext) hasNodes() bool {
508 return ctx.currentNodeIndex < len(ctx.nodes)
509}
510
511func (ctx *parseContext) getNode() mkparser.Node {
512 if !ctx.hasNodes() {
513 return nil
514 }
515 node := ctx.nodes[ctx.currentNodeIndex]
516 ctx.currentNodeIndex++
517 return node
518}
519
520func (ctx *parseContext) backNode() {
521 if ctx.currentNodeIndex <= 0 {
522 panic("Cannot back off")
523 }
524 ctx.currentNodeIndex--
525}
526
Cole Faustdd569ae2022-01-31 15:48:29 -0800527func (ctx *parseContext) handleAssignment(a *mkparser.Assignment) []starlarkNode {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800528 // Handle only simple variables
529 if !a.Name.Const() {
Cole Faustdd569ae2022-01-31 15:48:29 -0800530 return []starlarkNode{ctx.newBadNode(a, "Only simple variables are handled")}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800531 }
532 name := a.Name.Strings[0]
Sasha Smundakea3bc3a2021-11-10 13:06:42 -0800533 // The `override` directive
534 // override FOO :=
535 // is parsed as an assignment to a variable named `override FOO`.
536 // There are very few places where `override` is used, just flag it.
537 if strings.HasPrefix(name, "override ") {
Cole Faustdd569ae2022-01-31 15:48:29 -0800538 return []starlarkNode{ctx.newBadNode(a, "cannot handle override directive")}
Sasha Smundakea3bc3a2021-11-10 13:06:42 -0800539 }
540
Cole Faustc00184e2021-11-08 12:08:57 -0800541 // Soong configuration
Sasha Smundak3deb9682021-07-26 18:42:25 -0700542 if strings.HasPrefix(name, soongNsPrefix) {
Cole Faustdd569ae2022-01-31 15:48:29 -0800543 return ctx.handleSoongNsAssignment(strings.TrimPrefix(name, soongNsPrefix), a)
Sasha Smundak3deb9682021-07-26 18:42:25 -0700544 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800545 lhs := ctx.addVariable(name)
546 if lhs == nil {
Cole Faustdd569ae2022-01-31 15:48:29 -0800547 return []starlarkNode{ctx.newBadNode(a, "unknown variable %s", name)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800548 }
Cole Faust3c4fc992022-02-28 16:05:01 -0800549 _, isTraced := ctx.tracedVariables[lhs.name()]
Sasha Smundak422b6142021-11-11 18:31:59 -0800550 asgn := &assignmentNode{lhs: lhs, mkValue: a.Value, isTraced: isTraced, location: ctx.errorLocation(a)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800551 if lhs.valueType() == starlarkTypeUnknown {
552 // Try to divine variable type from the RHS
553 asgn.value = ctx.parseMakeString(a, a.Value)
554 if xBad, ok := asgn.value.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800555 return []starlarkNode{&exprNode{xBad}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800556 }
557 inferred_type := asgn.value.typ()
558 if inferred_type != starlarkTypeUnknown {
Sasha Smundak9d011ab2021-07-09 16:00:57 -0700559 lhs.setValueType(inferred_type)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800560 }
561 }
562 if lhs.valueType() == starlarkTypeList {
Cole Faustdd569ae2022-01-31 15:48:29 -0800563 xConcat, xBad := ctx.buildConcatExpr(a)
564 if xBad != nil {
565 return []starlarkNode{&exprNode{expr: xBad}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800566 }
567 switch len(xConcat.items) {
568 case 0:
569 asgn.value = &listExpr{}
570 case 1:
571 asgn.value = xConcat.items[0]
572 default:
573 asgn.value = xConcat
574 }
575 } else {
576 asgn.value = ctx.parseMakeString(a, a.Value)
577 if xBad, ok := asgn.value.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800578 return []starlarkNode{&exprNode{expr: xBad}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800579 }
580 }
581
Cole Faust421a1922022-03-16 14:35:45 -0700582 if asgn.lhs.valueType() == starlarkTypeString &&
583 asgn.value.typ() != starlarkTypeUnknown &&
584 asgn.value.typ() != starlarkTypeString {
585 asgn.value = &toStringExpr{expr: asgn.value}
586 }
587
Cole Faust3c4fc992022-02-28 16:05:01 -0800588 asgn.previous = ctx.lastAssignment(lhs)
589 ctx.setLastAssignment(lhs, asgn)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800590 switch a.Type {
591 case "=", ":=":
592 asgn.flavor = asgnSet
593 case "+=":
Cole Fauste2a37982022-03-09 16:00:17 -0800594 asgn.flavor = asgnAppend
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800595 case "?=":
596 asgn.flavor = asgnMaybeSet
597 default:
598 panic(fmt.Errorf("unexpected assignment type %s", a.Type))
599 }
600
Cole Faustdd569ae2022-01-31 15:48:29 -0800601 return []starlarkNode{asgn}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800602}
603
Cole Faustdd569ae2022-01-31 15:48:29 -0800604func (ctx *parseContext) handleSoongNsAssignment(name string, asgn *mkparser.Assignment) []starlarkNode {
Sasha Smundak3deb9682021-07-26 18:42:25 -0700605 val := ctx.parseMakeString(asgn, asgn.Value)
606 if xBad, ok := val.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800607 return []starlarkNode{&exprNode{expr: xBad}}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700608 }
Sasha Smundak3deb9682021-07-26 18:42:25 -0700609
610 // Unfortunately, Soong namespaces can be set up by directly setting corresponding Make
611 // variables instead of via add_soong_config_namespace + add_soong_config_var_value.
612 // Try to divine the call from the assignment as follows:
613 if name == "NAMESPACES" {
614 // Upon seeng
615 // SOONG_CONFIG_NAMESPACES += foo
616 // remember that there is a namespace `foo` and act as we saw
617 // $(call add_soong_config_namespace,foo)
618 s, ok := maybeString(val)
619 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800620 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 -0700621 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800622 result := make([]starlarkNode, 0)
Sasha Smundak3deb9682021-07-26 18:42:25 -0700623 for _, ns := range strings.Fields(s) {
624 ctx.addSoongNamespace(ns)
Cole Faustdd569ae2022-01-31 15:48:29 -0800625 result = append(result, &exprNode{&callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -0800626 name: baseName + ".soong_config_namespace",
627 args: []starlarkExpr{&globalsExpr{}, &stringLiteralExpr{ns}},
Sasha Smundak3deb9682021-07-26 18:42:25 -0700628 returnType: starlarkTypeVoid,
629 }})
630 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800631 return result
Sasha Smundak3deb9682021-07-26 18:42:25 -0700632 } else {
633 // Upon seeing
634 // SOONG_CONFIG_x_y = v
635 // find a namespace called `x` and act as if we encountered
Cole Faustc00184e2021-11-08 12:08:57 -0800636 // $(call soong_config_set,x,y,v)
Sasha Smundak3deb9682021-07-26 18:42:25 -0700637 // or check that `x_y` is a namespace, and then add the RHS of this assignment as variables in
638 // it.
639 // Emit an error in the ambiguous situation (namespaces `foo_bar` with a variable `baz`
640 // and `foo` with a variable `bar_baz`.
641 namespaceName := ""
642 if ctx.hasSoongNamespace(name) {
643 namespaceName = name
644 }
645 var varName string
646 for pos, ch := range name {
647 if !(ch == '_' && ctx.hasSoongNamespace(name[0:pos])) {
648 continue
649 }
650 if namespaceName != "" {
Cole Faustdd569ae2022-01-31 15:48:29 -0800651 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 -0700652 }
653 namespaceName = name[0:pos]
654 varName = name[pos+1:]
655 }
656 if namespaceName == "" {
Cole Faustdd569ae2022-01-31 15:48:29 -0800657 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 -0700658 }
659 if varName == "" {
660 // Remember variables in this namespace
661 s, ok := maybeString(val)
662 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800663 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 -0700664 }
665 ctx.updateSoongNamespace(asgn.Type != "+=", namespaceName, strings.Fields(s))
Cole Faustdd569ae2022-01-31 15:48:29 -0800666 return []starlarkNode{}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700667 }
668
669 // Finally, handle assignment to a namespace variable
670 if !ctx.hasNamespaceVar(namespaceName, varName) {
Cole Faustdd569ae2022-01-31 15:48:29 -0800671 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 -0700672 }
Cole Faust9ebf6e42021-12-13 14:08:34 -0800673 fname := baseName + "." + soongConfigAssign
Sasha Smundak65b547e2021-09-17 15:35:41 -0700674 if asgn.Type == "+=" {
Cole Faust9ebf6e42021-12-13 14:08:34 -0800675 fname = baseName + "." + soongConfigAppend
Sasha Smundak65b547e2021-09-17 15:35:41 -0700676 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800677 return []starlarkNode{&exprNode{&callExpr{
Sasha Smundak65b547e2021-09-17 15:35:41 -0700678 name: fname,
Cole Faust9ebf6e42021-12-13 14:08:34 -0800679 args: []starlarkExpr{&globalsExpr{}, &stringLiteralExpr{namespaceName}, &stringLiteralExpr{varName}, val},
Sasha Smundak3deb9682021-07-26 18:42:25 -0700680 returnType: starlarkTypeVoid,
Cole Faustdd569ae2022-01-31 15:48:29 -0800681 }}}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700682 }
683}
684
Cole Faustdd569ae2022-01-31 15:48:29 -0800685func (ctx *parseContext) buildConcatExpr(a *mkparser.Assignment) (*concatExpr, *badExpr) {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800686 xConcat := &concatExpr{}
687 var xItemList *listExpr
688 addToItemList := func(x ...starlarkExpr) {
689 if xItemList == nil {
690 xItemList = &listExpr{[]starlarkExpr{}}
691 }
692 xItemList.items = append(xItemList.items, x...)
693 }
694 finishItemList := func() {
695 if xItemList != nil {
696 xConcat.items = append(xConcat.items, xItemList)
697 xItemList = nil
698 }
699 }
700
701 items := a.Value.Words()
702 for _, item := range items {
703 // A function call in RHS is supposed to return a list, all other item
704 // expressions return individual elements.
705 switch x := ctx.parseMakeString(a, item).(type) {
706 case *badExpr:
Cole Faustdd569ae2022-01-31 15:48:29 -0800707 return nil, x
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800708 case *stringLiteralExpr:
709 addToItemList(maybeConvertToStringList(x).(*listExpr).items...)
710 default:
711 switch x.typ() {
712 case starlarkTypeList:
713 finishItemList()
714 xConcat.items = append(xConcat.items, x)
715 case starlarkTypeString:
716 finishItemList()
717 xConcat.items = append(xConcat.items, &callExpr{
718 object: x,
719 name: "split",
720 args: nil,
721 returnType: starlarkTypeList,
722 })
723 default:
724 addToItemList(x)
725 }
726 }
727 }
728 if xItemList != nil {
729 xConcat.items = append(xConcat.items, xItemList)
730 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800731 return xConcat, nil
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800732}
733
Sasha Smundak6609ba72021-07-22 18:32:56 -0700734func (ctx *parseContext) newDependentModule(path string, optional bool) *moduleInfo {
735 modulePath := ctx.loadedModulePath(path)
736 if mi, ok := ctx.dependentModules[modulePath]; ok {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700737 mi.optional = mi.optional && optional
Sasha Smundak6609ba72021-07-22 18:32:56 -0700738 return mi
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800739 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800740 moduleName := moduleNameForFile(path)
741 moduleLocalName := "_" + moduleName
742 n, found := ctx.moduleNameCount[moduleName]
743 if found {
744 moduleLocalName += fmt.Sprintf("%d", n)
745 }
746 ctx.moduleNameCount[moduleName] = n + 1
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800747 _, err := fs.Stat(ctx.script.sourceFS, path)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700748 mi := &moduleInfo{
749 path: modulePath,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800750 originalPath: path,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800751 moduleLocalName: moduleLocalName,
Sasha Smundak6609ba72021-07-22 18:32:56 -0700752 optional: optional,
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800753 missing: err != nil,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800754 }
Sasha Smundak6609ba72021-07-22 18:32:56 -0700755 ctx.dependentModules[modulePath] = mi
756 ctx.script.inherited = append(ctx.script.inherited, mi)
757 return mi
758}
759
760func (ctx *parseContext) handleSubConfig(
Cole Faustdd569ae2022-01-31 15:48:29 -0800761 v mkparser.Node, pathExpr starlarkExpr, loadAlways bool, processModule func(inheritedModule) starlarkNode) []starlarkNode {
Sasha Smundak6609ba72021-07-22 18:32:56 -0700762
Cole Faust62e05112022-04-05 17:56:11 -0700763 // Allow seeing $(sort $(wildcard realPathExpr)) or $(wildcard realPathExpr)
764 // because those are functionally the same as not having the sort/wildcard calls.
765 if ce, ok := pathExpr.(*callExpr); ok && ce.name == "rblf.mksort" && len(ce.args) == 1 {
766 if ce2, ok2 := ce.args[0].(*callExpr); ok2 && ce2.name == "rblf.expand_wildcard" && len(ce2.args) == 1 {
767 pathExpr = ce2.args[0]
768 }
769 } else if ce2, ok2 := pathExpr.(*callExpr); ok2 && ce2.name == "rblf.expand_wildcard" && len(ce2.args) == 1 {
770 pathExpr = ce2.args[0]
771 }
772
Sasha Smundak6609ba72021-07-22 18:32:56 -0700773 // In a simple case, the name of a module to inherit/include is known statically.
774 if path, ok := maybeString(pathExpr); ok {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700775 // Note that even if this directive loads a module unconditionally, a module may be
776 // absent without causing any harm if this directive is inside an if/else block.
777 moduleShouldExist := loadAlways && ctx.ifNestLevel == 0
Sasha Smundak6609ba72021-07-22 18:32:56 -0700778 if strings.Contains(path, "*") {
779 if paths, err := fs.Glob(ctx.script.sourceFS, path); err == nil {
Cole Faust62e05112022-04-05 17:56:11 -0700780 sort.Strings(paths)
Cole Faustdd569ae2022-01-31 15:48:29 -0800781 result := make([]starlarkNode, 0)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700782 for _, p := range paths {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700783 mi := ctx.newDependentModule(p, !moduleShouldExist)
Cole Faustdd569ae2022-01-31 15:48:29 -0800784 result = append(result, processModule(inheritedStaticModule{mi, loadAlways}))
Sasha Smundak6609ba72021-07-22 18:32:56 -0700785 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800786 return result
Sasha Smundak6609ba72021-07-22 18:32:56 -0700787 } else {
Cole Faustdd569ae2022-01-31 15:48:29 -0800788 return []starlarkNode{ctx.newBadNode(v, "cannot glob wildcard argument")}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700789 }
790 } else {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700791 mi := ctx.newDependentModule(path, !moduleShouldExist)
Cole Faustdd569ae2022-01-31 15:48:29 -0800792 return []starlarkNode{processModule(inheritedStaticModule{mi, loadAlways})}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700793 }
Sasha Smundak6609ba72021-07-22 18:32:56 -0700794 }
795
796 // If module path references variables (e.g., $(v1)/foo/$(v2)/device-config.mk), find all the paths in the
797 // source tree that may be a match and the corresponding variable values. For instance, if the source tree
798 // contains vendor1/foo/abc/dev.mk and vendor2/foo/def/dev.mk, the first one will be inherited when
799 // (v1, v2) == ('vendor1', 'abc'), and the second one when (v1, v2) == ('vendor2', 'def').
800 // We then emit the code that loads all of them, e.g.:
801 // load("//vendor1/foo/abc:dev.rbc", _dev1_init="init")
802 // load("//vendor2/foo/def/dev.rbc", _dev2_init="init")
803 // And then inherit it as follows:
804 // _e = {
805 // "vendor1/foo/abc/dev.mk": ("vendor1/foo/abc/dev", _dev1_init),
806 // "vendor2/foo/def/dev.mk": ("vendor2/foo/def/dev", _dev_init2) }.get("%s/foo/%s/dev.mk" % (v1, v2))
807 // if _e:
808 // rblf.inherit(handle, _e[0], _e[1])
809 //
810 var matchingPaths []string
811 varPath, ok := pathExpr.(*interpolateExpr)
812 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800813 return []starlarkNode{ctx.newBadNode(v, "inherit-product/include argument is too complex")}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700814 }
815
816 pathPattern := []string{varPath.chunks[0]}
817 for _, chunk := range varPath.chunks[1:] {
818 if chunk != "" {
819 pathPattern = append(pathPattern, chunk)
820 }
821 }
Cole Faust069aba62022-01-26 17:47:33 -0800822 if pathPattern[0] == "" && len(ctx.includeTops) > 0 {
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700823 // If pattern starts from the top. restrict it to the directories where
824 // we know inherit-product uses dynamically calculated path.
825 for _, p := range ctx.includeTops {
826 pathPattern[0] = p
827 matchingPaths = append(matchingPaths, ctx.findMatchingPaths(pathPattern)...)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700828 }
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700829 } else {
830 matchingPaths = ctx.findMatchingPaths(pathPattern)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700831 }
832 // Safeguard against $(call inherit-product,$(PRODUCT_PATH))
Sasha Smundak90be8c52021-08-03 11:06:10 -0700833 const maxMatchingFiles = 150
Sasha Smundak6609ba72021-07-22 18:32:56 -0700834 if len(matchingPaths) > maxMatchingFiles {
Cole Faustdd569ae2022-01-31 15:48:29 -0800835 return []starlarkNode{ctx.newBadNode(v, "there are >%d files matching the pattern, please rewrite it", maxMatchingFiles)}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700836 }
Cole Faust93f8d392022-03-02 13:31:30 -0800837
838 needsWarning := pathPattern[0] == "" && len(ctx.includeTops) == 0
839 res := inheritedDynamicModule{*varPath, []*moduleInfo{}, loadAlways, ctx.errorLocation(v), needsWarning}
840 for _, p := range matchingPaths {
841 // A product configuration files discovered dynamically may attempt to inherit
842 // from another one which does not exist in this source tree. Prevent load errors
843 // by always loading the dynamic files as optional.
844 res.candidateModules = append(res.candidateModules, ctx.newDependentModule(p, true))
Sasha Smundak6609ba72021-07-22 18:32:56 -0700845 }
Cole Faust93f8d392022-03-02 13:31:30 -0800846 return []starlarkNode{processModule(res)}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700847}
848
849func (ctx *parseContext) findMatchingPaths(pattern []string) []string {
Cole Faust9b6111a2022-02-02 15:38:33 -0800850 files := ctx.script.makefileFinder.Find(".")
Sasha Smundak6609ba72021-07-22 18:32:56 -0700851 if len(pattern) == 0 {
852 return files
853 }
854
855 // Create regular expression from the pattern
856 s_regexp := "^" + regexp.QuoteMeta(pattern[0])
857 for _, s := range pattern[1:] {
858 s_regexp += ".*" + regexp.QuoteMeta(s)
859 }
860 s_regexp += "$"
861 rex := regexp.MustCompile(s_regexp)
862
863 // Now match
864 var res []string
865 for _, p := range files {
866 if rex.MatchString(p) {
867 res = append(res, p)
868 }
869 }
870 return res
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800871}
872
Cole Faustf035d402022-03-28 14:02:50 -0700873type inheritProductCallParser struct {
874 loadAlways bool
875}
876
877func (p *inheritProductCallParser) parse(ctx *parseContext, v mkparser.Node, args *mkparser.MakeString) []starlarkNode {
Cole Faust9ebf6e42021-12-13 14:08:34 -0800878 args.TrimLeftSpaces()
879 args.TrimRightSpaces()
880 pathExpr := ctx.parseMakeString(v, args)
881 if _, ok := pathExpr.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800882 return []starlarkNode{ctx.newBadNode(v, "Unable to parse argument to inherit")}
Cole Faust9ebf6e42021-12-13 14:08:34 -0800883 }
Cole Faustf035d402022-03-28 14:02:50 -0700884 return ctx.handleSubConfig(v, pathExpr, p.loadAlways, func(im inheritedModule) starlarkNode {
885 return &inheritNode{im, p.loadAlways}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700886 })
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800887}
888
Cole Faustdd569ae2022-01-31 15:48:29 -0800889func (ctx *parseContext) handleInclude(v mkparser.Node, pathExpr starlarkExpr, loadAlways bool) []starlarkNode {
890 return ctx.handleSubConfig(v, pathExpr, loadAlways, func(im inheritedModule) starlarkNode {
891 return &includeNode{im, loadAlways}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700892 })
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800893}
894
Cole Faustdd569ae2022-01-31 15:48:29 -0800895func (ctx *parseContext) handleVariable(v *mkparser.Variable) []starlarkNode {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800896 // Handle:
897 // $(call inherit-product,...)
898 // $(call inherit-product-if-exists,...)
899 // $(info xxx)
900 // $(warning xxx)
901 // $(error xxx)
Cole Faust9ebf6e42021-12-13 14:08:34 -0800902 // $(call other-custom-functions,...)
903
Cole Faustf035d402022-03-28 14:02:50 -0700904 if name, args, ok := ctx.maybeParseFunctionCall(v, v.Name); ok {
905 if kf, ok := knownNodeFunctions[name]; ok {
906 return kf.parse(ctx, v, args)
907 }
Cole Faust9ebf6e42021-12-13 14:08:34 -0800908 }
Cole Faustf035d402022-03-28 14:02:50 -0700909
Cole Faustdd569ae2022-01-31 15:48:29 -0800910 return []starlarkNode{&exprNode{expr: ctx.parseReference(v, v.Name)}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800911}
912
Cole Faustdd569ae2022-01-31 15:48:29 -0800913func (ctx *parseContext) maybeHandleDefine(directive *mkparser.Directive) starlarkNode {
Sasha Smundakf3e072a2021-07-14 12:50:28 -0700914 macro_name := strings.Fields(directive.Args.Strings[0])[0]
915 // Ignore the macros that we handle
Cole Faust9ebf6e42021-12-13 14:08:34 -0800916 _, ignored := ignoredDefines[macro_name]
917 _, known := knownFunctions[macro_name]
918 if !ignored && !known {
Cole Faustdd569ae2022-01-31 15:48:29 -0800919 return ctx.newBadNode(directive, "define is not supported: %s", macro_name)
Sasha Smundakf3e072a2021-07-14 12:50:28 -0700920 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800921 return nil
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800922}
923
Cole Faustdd569ae2022-01-31 15:48:29 -0800924func (ctx *parseContext) handleIfBlock(ifDirective *mkparser.Directive) starlarkNode {
925 ssSwitch := &switchNode{
926 ssCases: []*switchCase{ctx.processBranch(ifDirective)},
927 }
928 for ctx.hasNodes() && ctx.fatalError == nil {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800929 node := ctx.getNode()
930 switch x := node.(type) {
931 case *mkparser.Directive:
932 switch x.Name {
933 case "else", "elifdef", "elifndef", "elifeq", "elifneq":
Cole Faustdd569ae2022-01-31 15:48:29 -0800934 ssSwitch.ssCases = append(ssSwitch.ssCases, ctx.processBranch(x))
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800935 case "endif":
Cole Faustdd569ae2022-01-31 15:48:29 -0800936 return ssSwitch
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800937 default:
Cole Faustdd569ae2022-01-31 15:48:29 -0800938 return ctx.newBadNode(node, "unexpected directive %s", x.Name)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800939 }
940 default:
Cole Faustdd569ae2022-01-31 15:48:29 -0800941 return ctx.newBadNode(ifDirective, "unexpected statement")
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800942 }
943 }
944 if ctx.fatalError == nil {
945 ctx.fatalError = fmt.Errorf("no matching endif for %s", ifDirective.Dump())
946 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800947 return ctx.newBadNode(ifDirective, "no matching endif for %s", ifDirective.Dump())
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800948}
949
950// processBranch processes a single branch (if/elseif/else) until the next directive
951// on the same level.
Cole Faustdd569ae2022-01-31 15:48:29 -0800952func (ctx *parseContext) processBranch(check *mkparser.Directive) *switchCase {
953 block := &switchCase{gate: ctx.parseCondition(check)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800954 defer func() {
955 ctx.popVarAssignments()
956 ctx.ifNestLevel--
957
958 }()
959 ctx.pushVarAssignments()
960 ctx.ifNestLevel++
961
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800962 for ctx.hasNodes() {
963 node := ctx.getNode()
Cole Faust591a1fe2021-11-08 15:37:57 -0800964 if d, ok := node.(*mkparser.Directive); ok {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800965 switch d.Name {
966 case "else", "elifdef", "elifndef", "elifeq", "elifneq", "endif":
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800967 ctx.backNode()
Cole Faustdd569ae2022-01-31 15:48:29 -0800968 return block
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800969 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800970 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800971 block.nodes = append(block.nodes, ctx.handleSimpleStatement(node)...)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800972 }
973 ctx.fatalError = fmt.Errorf("no matching endif for %s", check.Dump())
Cole Faustdd569ae2022-01-31 15:48:29 -0800974 return block
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800975}
976
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800977func (ctx *parseContext) parseCondition(check *mkparser.Directive) starlarkNode {
978 switch check.Name {
979 case "ifdef", "ifndef", "elifdef", "elifndef":
Cole Faust71514c02022-01-27 17:21:41 -0800980 if !check.Args.Const() {
Cole Faustdd569ae2022-01-31 15:48:29 -0800981 return ctx.newBadNode(check, "ifdef variable ref too complex: %s", check.Args.Dump())
Cole Faust71514c02022-01-27 17:21:41 -0800982 }
983 v := NewVariableRefExpr(ctx.addVariable(check.Args.Strings[0]), false)
984 if strings.HasSuffix(check.Name, "ndef") {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800985 v = &notExpr{v}
986 }
987 return &ifNode{
988 isElif: strings.HasPrefix(check.Name, "elif"),
989 expr: v,
990 }
991 case "ifeq", "ifneq", "elifeq", "elifneq":
992 return &ifNode{
993 isElif: strings.HasPrefix(check.Name, "elif"),
994 expr: ctx.parseCompare(check),
995 }
996 case "else":
997 return &elseNode{}
998 default:
999 panic(fmt.Errorf("%s: unknown directive: %s", ctx.script.mkFile, check.Dump()))
1000 }
1001}
1002
1003func (ctx *parseContext) newBadExpr(node mkparser.Node, text string, args ...interface{}) starlarkExpr {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001004 if ctx.errorLogger != nil {
Sasha Smundak422b6142021-11-11 18:31:59 -08001005 ctx.errorLogger.NewError(ctx.errorLocation(node), node, text, args...)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001006 }
1007 ctx.script.hasErrors = true
Cole Faustdd569ae2022-01-31 15:48:29 -08001008 return &badExpr{errorLocation: ctx.errorLocation(node), message: fmt.Sprintf(text, args...)}
1009}
1010
1011// records that the given node failed to be converted and includes an explanatory message
1012func (ctx *parseContext) newBadNode(failedNode mkparser.Node, message string, args ...interface{}) starlarkNode {
1013 return &exprNode{ctx.newBadExpr(failedNode, message, args...)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001014}
1015
1016func (ctx *parseContext) parseCompare(cond *mkparser.Directive) starlarkExpr {
1017 // Strip outer parentheses
1018 mkArg := cloneMakeString(cond.Args)
1019 mkArg.Strings[0] = strings.TrimLeft(mkArg.Strings[0], "( ")
1020 n := len(mkArg.Strings)
1021 mkArg.Strings[n-1] = strings.TrimRight(mkArg.Strings[n-1], ") ")
1022 args := mkArg.Split(",")
1023 // TODO(asmundak): handle the case where the arguments are in quotes and space-separated
1024 if len(args) != 2 {
1025 return ctx.newBadExpr(cond, "ifeq/ifneq len(args) != 2 %s", cond.Dump())
1026 }
1027 args[0].TrimRightSpaces()
1028 args[1].TrimLeftSpaces()
1029
1030 isEq := !strings.HasSuffix(cond.Name, "neq")
Cole Faustf8320212021-11-10 15:05:07 -08001031 xLeft := ctx.parseMakeString(cond, args[0])
1032 xRight := ctx.parseMakeString(cond, args[1])
1033 if bad, ok := xLeft.(*badExpr); ok {
1034 return bad
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001035 }
Cole Faustf8320212021-11-10 15:05:07 -08001036 if bad, ok := xRight.(*badExpr); ok {
1037 return bad
1038 }
1039
1040 if expr, ok := ctx.parseCompareSpecialCases(cond, xLeft, xRight); ok {
1041 return expr
1042 }
1043
Cole Faust9ebf6e42021-12-13 14:08:34 -08001044 var stringOperand string
1045 var otherOperand starlarkExpr
1046 if s, ok := maybeString(xLeft); ok {
1047 stringOperand = s
1048 otherOperand = xRight
1049 } else if s, ok := maybeString(xRight); ok {
1050 stringOperand = s
1051 otherOperand = xLeft
1052 }
1053
Cole Faust9ebf6e42021-12-13 14:08:34 -08001054 // If we've identified one of the operands as being a string literal, check
1055 // for some special cases we can do to simplify the resulting expression.
1056 if otherOperand != nil {
1057 if stringOperand == "" {
1058 if isEq {
Cole Faustf035d402022-03-28 14:02:50 -07001059 return negateExpr(otherOperand)
Cole Faust9ebf6e42021-12-13 14:08:34 -08001060 } else {
1061 return otherOperand
1062 }
1063 }
1064 if stringOperand == "true" && otherOperand.typ() == starlarkTypeBool {
1065 if !isEq {
Cole Faustf035d402022-03-28 14:02:50 -07001066 return negateExpr(otherOperand)
Cole Faust9ebf6e42021-12-13 14:08:34 -08001067 } else {
1068 return otherOperand
1069 }
1070 }
Cole Faustb1103e22022-01-06 15:22:05 -08001071 if intOperand, err := strconv.Atoi(strings.TrimSpace(stringOperand)); err == nil && otherOperand.typ() == starlarkTypeInt {
1072 return &eqExpr{
1073 left: otherOperand,
1074 right: &intLiteralExpr{literal: intOperand},
1075 isEq: isEq,
1076 }
1077 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001078 }
1079
Cole Faustf8320212021-11-10 15:05:07 -08001080 return &eqExpr{left: xLeft, right: xRight, isEq: isEq}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001081}
1082
Cole Faustf8320212021-11-10 15:05:07 -08001083// Given an if statement's directive and the left/right starlarkExprs,
1084// check if the starlarkExprs are one of a few hardcoded special cases
Cole Faust9932f752022-02-08 11:56:25 -08001085// that can be converted to a simpler equality expression than simply comparing
Cole Faustf8320212021-11-10 15:05:07 -08001086// the two.
1087func (ctx *parseContext) parseCompareSpecialCases(directive *mkparser.Directive, left starlarkExpr,
1088 right starlarkExpr) (starlarkExpr, bool) {
1089 isEq := !strings.HasSuffix(directive.Name, "neq")
1090
1091 // All the special cases require a call on one side and a
1092 // string literal/variable on the other. Turn the left/right variables into
1093 // call/value variables, and return false if that's not possible.
1094 var value starlarkExpr = nil
1095 call, ok := left.(*callExpr)
1096 if ok {
1097 switch right.(type) {
1098 case *stringLiteralExpr, *variableRefExpr:
1099 value = right
1100 }
1101 } else {
1102 call, _ = right.(*callExpr)
1103 switch left.(type) {
1104 case *stringLiteralExpr, *variableRefExpr:
1105 value = left
1106 }
1107 }
1108
1109 if call == nil || value == nil {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001110 return nil, false
1111 }
Cole Faustf8320212021-11-10 15:05:07 -08001112
Cole Faustf8320212021-11-10 15:05:07 -08001113 switch call.name {
Cole Faust9932f752022-02-08 11:56:25 -08001114 case baseName + ".filter":
1115 return ctx.parseCompareFilterFuncResult(directive, call, value, isEq)
Cole Faust9ebf6e42021-12-13 14:08:34 -08001116 case baseName + ".expand_wildcard":
Cole Faustf8320212021-11-10 15:05:07 -08001117 return ctx.parseCompareWildcardFuncResult(directive, call, value, !isEq), true
Cole Faust9ebf6e42021-12-13 14:08:34 -08001118 case baseName + ".findstring":
Cole Faustf8320212021-11-10 15:05:07 -08001119 return ctx.parseCheckFindstringFuncResult(directive, call, value, !isEq), true
Cole Faust9ebf6e42021-12-13 14:08:34 -08001120 case baseName + ".strip":
Cole Faustf8320212021-11-10 15:05:07 -08001121 return ctx.parseCompareStripFuncResult(directive, call, value, !isEq), true
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001122 }
Cole Faustf8320212021-11-10 15:05:07 -08001123 return nil, false
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001124}
1125
1126func (ctx *parseContext) parseCompareFilterFuncResult(cond *mkparser.Directive,
Cole Faust9932f752022-02-08 11:56:25 -08001127 filterFuncCall *callExpr, xValue starlarkExpr, negate bool) (starlarkExpr, bool) {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001128 // We handle:
Sasha Smundak0554d762021-07-08 18:26:12 -07001129 // * ifeq/ifneq (,$(filter v1 v2 ..., EXPR) becomes if EXPR not in/in ["v1", "v2", ...]
1130 // * ifeq/ifneq (,$(filter EXPR, v1 v2 ...) becomes if EXPR not in/in ["v1", "v2", ...]
Cole Faust9932f752022-02-08 11:56:25 -08001131 if x, ok := xValue.(*stringLiteralExpr); !ok || x.literal != "" {
1132 return nil, false
1133 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001134 xPattern := filterFuncCall.args[0]
1135 xText := filterFuncCall.args[1]
1136 var xInList *stringLiteralExpr
Sasha Smundak0554d762021-07-08 18:26:12 -07001137 var expr starlarkExpr
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001138 var ok bool
Cole Faust9932f752022-02-08 11:56:25 -08001139 if xInList, ok = xPattern.(*stringLiteralExpr); ok && !strings.ContainsRune(xInList.literal, '%') && xText.typ() == starlarkTypeList {
1140 expr = xText
1141 } else if xInList, ok = xText.(*stringLiteralExpr); ok {
1142 expr = xPattern
1143 } else {
1144 return nil, false
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001145 }
Cole Faust9932f752022-02-08 11:56:25 -08001146 slExpr := newStringListExpr(strings.Fields(xInList.literal))
1147 // Generate simpler code for the common cases:
1148 if expr.typ() == starlarkTypeList {
1149 if len(slExpr.items) == 1 {
1150 // Checking that a string belongs to list
1151 return &inExpr{isNot: negate, list: expr, expr: slExpr.items[0]}, true
Sasha Smundak0554d762021-07-08 18:26:12 -07001152 } else {
Cole Faust9932f752022-02-08 11:56:25 -08001153 return nil, false
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001154 }
Cole Faust9932f752022-02-08 11:56:25 -08001155 } else if len(slExpr.items) == 1 {
1156 return &eqExpr{left: expr, right: slExpr.items[0], isEq: !negate}, true
1157 } else {
1158 return &inExpr{isNot: negate, list: newStringListExpr(strings.Fields(xInList.literal)), expr: expr}, true
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001159 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001160}
1161
1162func (ctx *parseContext) parseCompareWildcardFuncResult(directive *mkparser.Directive,
1163 xCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
Sasha Smundak0554d762021-07-08 18:26:12 -07001164 if !isEmptyString(xValue) {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001165 return ctx.newBadExpr(directive, "wildcard result can be compared only to empty: %s", xValue)
1166 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001167 callFunc := baseName + ".file_wildcard_exists"
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001168 if s, ok := xCall.args[0].(*stringLiteralExpr); ok && !strings.ContainsAny(s.literal, "*?{[") {
Cole Faust9ebf6e42021-12-13 14:08:34 -08001169 callFunc = baseName + ".file_exists"
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001170 }
1171 var cc starlarkExpr = &callExpr{name: callFunc, args: xCall.args, returnType: starlarkTypeBool}
1172 if !negate {
1173 cc = &notExpr{cc}
1174 }
1175 return cc
1176}
1177
1178func (ctx *parseContext) parseCheckFindstringFuncResult(directive *mkparser.Directive,
1179 xCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
Sasha Smundak0554d762021-07-08 18:26:12 -07001180 if isEmptyString(xValue) {
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 }
Cole Faust0e9418c2021-12-13 16:33:25 -08001191 } else if s, ok := maybeString(xValue); ok {
1192 if s2, ok := maybeString(xCall.args[0]); ok && s == s2 {
1193 return &eqExpr{
1194 left: &callExpr{
1195 object: xCall.args[1],
1196 name: "find",
1197 args: []starlarkExpr{xCall.args[0]},
1198 returnType: starlarkTypeInt,
1199 },
1200 right: &intLiteralExpr{-1},
1201 isEq: negate,
1202 }
1203 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001204 }
Cole Faust0e9418c2021-12-13 16:33:25 -08001205 return ctx.newBadExpr(directive, "$(findstring) can only be compared to nothing or its first argument")
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001206}
1207
1208func (ctx *parseContext) parseCompareStripFuncResult(directive *mkparser.Directive,
1209 xCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
1210 if _, ok := xValue.(*stringLiteralExpr); !ok {
1211 return ctx.newBadExpr(directive, "strip result can be compared only to string: %s", xValue)
1212 }
1213 return &eqExpr{
1214 left: &callExpr{
1215 name: "strip",
1216 args: xCall.args,
1217 returnType: starlarkTypeString,
1218 },
1219 right: xValue, isEq: !negate}
1220}
1221
Cole Faustf035d402022-03-28 14:02:50 -07001222func (ctx *parseContext) maybeParseFunctionCall(node mkparser.Node, ref *mkparser.MakeString) (name string, args *mkparser.MakeString, ok bool) {
1223 ref.TrimLeftSpaces()
1224 ref.TrimRightSpaces()
1225
1226 words := ref.SplitN(" ", 2)
1227 if !words[0].Const() {
1228 return "", nil, false
1229 }
1230
1231 name = words[0].Dump()
1232 args = mkparser.SimpleMakeString("", words[0].Pos())
1233 if len(words) >= 2 {
1234 args = words[1]
1235 }
1236 args.TrimLeftSpaces()
1237 if name == "call" {
1238 words = args.SplitN(",", 2)
1239 if words[0].Empty() || !words[0].Const() {
1240 return "", nil, false
1241 }
1242 name = words[0].Dump()
1243 if len(words) < 2 {
1244 args = &mkparser.MakeString{}
1245 } else {
1246 args = words[1]
1247 }
1248 }
1249 ok = true
1250 return
1251}
1252
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001253// parses $(...), returning an expression
1254func (ctx *parseContext) parseReference(node mkparser.Node, ref *mkparser.MakeString) starlarkExpr {
1255 ref.TrimLeftSpaces()
1256 ref.TrimRightSpaces()
1257 refDump := ref.Dump()
1258
1259 // Handle only the case where the first (or only) word is constant
1260 words := ref.SplitN(" ", 2)
1261 if !words[0].Const() {
1262 return ctx.newBadExpr(node, "reference is too complex: %s", refDump)
1263 }
1264
1265 // If it is a single word, it can be a simple variable
1266 // reference or a function call
Cole Faustf035d402022-03-28 14:02:50 -07001267 if len(words) == 1 && !isMakeControlFunc(refDump) && refDump != "shell" && refDump != "eval" {
Sasha Smundak65b547e2021-09-17 15:35:41 -07001268 if strings.HasPrefix(refDump, soongNsPrefix) {
1269 // TODO (asmundak): if we find many, maybe handle them.
Cole Faustc00184e2021-11-08 12:08:57 -08001270 return ctx.newBadExpr(node, "SOONG_CONFIG_ variables cannot be referenced, use soong_config_get instead: %s", refDump)
Sasha Smundak65b547e2021-09-17 15:35:41 -07001271 }
Cole Faustc36c9622021-12-07 15:20:45 -08001272 // Handle substitution references: https://www.gnu.org/software/make/manual/html_node/Substitution-Refs.html
1273 if strings.Contains(refDump, ":") {
1274 parts := strings.SplitN(refDump, ":", 2)
1275 substParts := strings.SplitN(parts[1], "=", 2)
1276 if len(substParts) < 2 || strings.Count(substParts[0], "%") > 1 {
1277 return ctx.newBadExpr(node, "Invalid substitution reference")
1278 }
1279 if !strings.Contains(substParts[0], "%") {
1280 if strings.Contains(substParts[1], "%") {
1281 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.")
1282 }
1283 substParts[0] = "%" + substParts[0]
1284 substParts[1] = "%" + substParts[1]
1285 }
1286 v := ctx.addVariable(parts[0])
1287 if v == nil {
1288 return ctx.newBadExpr(node, "unknown variable %s", refDump)
1289 }
1290 return &callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -08001291 name: baseName + ".mkpatsubst",
1292 returnType: starlarkTypeString,
Cole Faustc36c9622021-12-07 15:20:45 -08001293 args: []starlarkExpr{
1294 &stringLiteralExpr{literal: substParts[0]},
1295 &stringLiteralExpr{literal: substParts[1]},
Cole Faust3c4fc992022-02-28 16:05:01 -08001296 NewVariableRefExpr(v, ctx.lastAssignment(v) != nil),
Cole Faustc36c9622021-12-07 15:20:45 -08001297 },
1298 }
1299 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001300 if v := ctx.addVariable(refDump); v != nil {
Cole Faust3c4fc992022-02-28 16:05:01 -08001301 return NewVariableRefExpr(v, ctx.lastAssignment(v) != nil)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001302 }
1303 return ctx.newBadExpr(node, "unknown variable %s", refDump)
1304 }
1305
Cole Faustf035d402022-03-28 14:02:50 -07001306 if name, args, ok := ctx.maybeParseFunctionCall(node, ref); ok {
1307 if kf, found := knownFunctions[name]; found {
1308 return kf.parse(ctx, node, args)
Sasha Smundak6609ba72021-07-22 18:32:56 -07001309 } else {
Cole Faustf035d402022-03-28 14:02:50 -07001310 return ctx.newBadExpr(node, "cannot handle invoking %s", name)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001311 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001312 } else {
Cole Faustf035d402022-03-28 14:02:50 -07001313 return ctx.newBadExpr(node, "cannot handle %s", refDump)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001314 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001315}
1316
1317type simpleCallParser struct {
1318 name string
1319 returnType starlarkType
1320 addGlobals bool
Cole Faust1cc08852022-02-28 11:12:08 -08001321 addHandle bool
Cole Faust9ebf6e42021-12-13 14:08:34 -08001322}
1323
1324func (p *simpleCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1325 expr := &callExpr{name: p.name, returnType: p.returnType}
1326 if p.addGlobals {
1327 expr.args = append(expr.args, &globalsExpr{})
1328 }
Cole Faust1cc08852022-02-28 11:12:08 -08001329 if p.addHandle {
1330 expr.args = append(expr.args, &identifierExpr{name: "handle"})
1331 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001332 for _, arg := range args.Split(",") {
1333 arg.TrimLeftSpaces()
1334 arg.TrimRightSpaces()
1335 x := ctx.parseMakeString(node, arg)
1336 if xBad, ok := x.(*badExpr); ok {
1337 return xBad
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001338 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001339 expr.args = append(expr.args, x)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001340 }
1341 return expr
1342}
1343
Cole Faust9ebf6e42021-12-13 14:08:34 -08001344type makeControlFuncParser struct {
1345 name string
1346}
1347
1348func (p *makeControlFuncParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1349 // Make control functions need special treatment as everything
1350 // after the name is a single text argument
1351 x := ctx.parseMakeString(node, args)
1352 if xBad, ok := x.(*badExpr); ok {
1353 return xBad
1354 }
1355 return &callExpr{
1356 name: p.name,
1357 args: []starlarkExpr{
1358 &stringLiteralExpr{ctx.script.mkFile},
1359 x,
1360 },
1361 returnType: starlarkTypeUnknown,
1362 }
1363}
1364
1365type shellCallParser struct{}
1366
1367func (p *shellCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1368 // Shell functions need special treatment as everything
1369 // after the name is a single text argument
1370 x := ctx.parseMakeString(node, args)
1371 if xBad, ok := x.(*badExpr); ok {
1372 return xBad
1373 }
1374 return &callExpr{
1375 name: baseName + ".shell",
1376 args: []starlarkExpr{x},
1377 returnType: starlarkTypeUnknown,
1378 }
1379}
1380
1381type myDirCallParser struct{}
1382
1383func (p *myDirCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1384 if !args.Empty() {
1385 return ctx.newBadExpr(node, "my-dir function cannot have any arguments passed to it.")
1386 }
Cole Faustf5adedc2022-03-18 14:05:06 -07001387 return &stringLiteralExpr{literal: filepath.Dir(ctx.script.mkFile)}
Cole Faust9ebf6e42021-12-13 14:08:34 -08001388}
1389
Cole Faust9ebf6e42021-12-13 14:08:34 -08001390type isProductInListCallParser struct{}
1391
1392func (p *isProductInListCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1393 if args.Empty() {
1394 return ctx.newBadExpr(node, "is-product-in-list requires an argument")
1395 }
1396 return &inExpr{
1397 expr: &variableRefExpr{ctx.addVariable("TARGET_PRODUCT"), true},
1398 list: maybeConvertToStringList(ctx.parseMakeString(node, args)),
1399 isNot: false,
1400 }
1401}
1402
1403type isVendorBoardPlatformCallParser struct{}
1404
1405func (p *isVendorBoardPlatformCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1406 if args.Empty() || !identifierFullMatchRegex.MatchString(args.Dump()) {
1407 return ctx.newBadExpr(node, "cannot handle non-constant argument to is-vendor-board-platform")
1408 }
1409 return &inExpr{
1410 expr: &variableRefExpr{ctx.addVariable("TARGET_BOARD_PLATFORM"), false},
1411 list: &variableRefExpr{ctx.addVariable(args.Dump() + "_BOARD_PLATFORMS"), true},
1412 isNot: false,
1413 }
1414}
1415
1416type isVendorBoardQcomCallParser struct{}
1417
1418func (p *isVendorBoardQcomCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1419 if !args.Empty() {
1420 return ctx.newBadExpr(node, "is-vendor-board-qcom does not accept any arguments")
1421 }
1422 return &inExpr{
1423 expr: &variableRefExpr{ctx.addVariable("TARGET_BOARD_PLATFORM"), false},
1424 list: &variableRefExpr{ctx.addVariable("QCOM_BOARD_PLATFORMS"), true},
1425 isNot: false,
1426 }
1427}
1428
1429type substCallParser struct {
1430 fname string
1431}
1432
1433func (p *substCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001434 words := args.Split(",")
1435 if len(words) != 3 {
Cole Faust9ebf6e42021-12-13 14:08:34 -08001436 return ctx.newBadExpr(node, "%s function should have 3 arguments", p.fname)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001437 }
Sasha Smundak35434ed2021-11-05 16:29:56 -07001438 from := ctx.parseMakeString(node, words[0])
1439 if xBad, ok := from.(*badExpr); ok {
1440 return xBad
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001441 }
Sasha Smundak35434ed2021-11-05 16:29:56 -07001442 to := ctx.parseMakeString(node, words[1])
1443 if xBad, ok := to.(*badExpr); ok {
1444 return xBad
1445 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001446 words[2].TrimLeftSpaces()
1447 words[2].TrimRightSpaces()
1448 obj := ctx.parseMakeString(node, words[2])
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001449 typ := obj.typ()
Cole Faust9ebf6e42021-12-13 14:08:34 -08001450 if typ == starlarkTypeString && p.fname == "subst" {
Sasha Smundak94b41c72021-07-12 18:30:42 -07001451 // Optimization: if it's $(subst from, to, string), emit string.replace(from, to)
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001452 return &callExpr{
1453 object: obj,
1454 name: "replace",
Sasha Smundak35434ed2021-11-05 16:29:56 -07001455 args: []starlarkExpr{from, to},
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001456 returnType: typ,
1457 }
1458 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001459 return &callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -08001460 name: baseName + ".mk" + p.fname,
Sasha Smundak35434ed2021-11-05 16:29:56 -07001461 args: []starlarkExpr{from, to, obj},
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001462 returnType: obj.typ(),
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001463 }
1464}
1465
Cole Faust9ebf6e42021-12-13 14:08:34 -08001466type ifCallParser struct{}
1467
1468func (p *ifCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Cole Faust4eadba72021-12-07 11:54:52 -08001469 words := args.Split(",")
1470 if len(words) != 2 && len(words) != 3 {
1471 return ctx.newBadExpr(node, "if function should have 2 or 3 arguments, found "+strconv.Itoa(len(words)))
1472 }
1473 condition := ctx.parseMakeString(node, words[0])
1474 ifTrue := ctx.parseMakeString(node, words[1])
1475 var ifFalse starlarkExpr
1476 if len(words) == 3 {
1477 ifFalse = ctx.parseMakeString(node, words[2])
1478 } else {
1479 switch ifTrue.typ() {
1480 case starlarkTypeList:
1481 ifFalse = &listExpr{items: []starlarkExpr{}}
1482 case starlarkTypeInt:
1483 ifFalse = &intLiteralExpr{literal: 0}
1484 case starlarkTypeBool:
1485 ifFalse = &boolLiteralExpr{literal: false}
1486 default:
1487 ifFalse = &stringLiteralExpr{literal: ""}
1488 }
1489 }
1490 return &ifExpr{
1491 condition,
1492 ifTrue,
1493 ifFalse,
1494 }
1495}
1496
Cole Faustf035d402022-03-28 14:02:50 -07001497type ifCallNodeParser struct{}
Cole Faust9ebf6e42021-12-13 14:08:34 -08001498
Cole Faustf035d402022-03-28 14:02:50 -07001499func (p *ifCallNodeParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) []starlarkNode {
1500 words := args.Split(",")
1501 if len(words) != 2 && len(words) != 3 {
1502 return []starlarkNode{ctx.newBadNode(node, "if function should have 2 or 3 arguments, found "+strconv.Itoa(len(words)))}
1503 }
1504
1505 ifn := &ifNode{expr: ctx.parseMakeString(node, words[0])}
1506 cases := []*switchCase{
1507 {
1508 gate: ifn,
1509 nodes: ctx.parseNodeMakeString(node, words[1]),
1510 },
1511 }
1512 if len(words) == 3 {
1513 cases = append(cases, &switchCase{
1514 gate: &elseNode{},
1515 nodes: ctx.parseNodeMakeString(node, words[2]),
1516 })
1517 }
1518 if len(cases) == 2 {
1519 if len(cases[1].nodes) == 0 {
1520 // Remove else branch if it has no contents
1521 cases = cases[:1]
1522 } else if len(cases[0].nodes) == 0 {
1523 // If the if branch has no contents but the else does,
1524 // move them to the if and negate its condition
1525 ifn.expr = negateExpr(ifn.expr)
1526 cases[0].nodes = cases[1].nodes
1527 cases = cases[:1]
1528 }
1529 }
1530
1531 return []starlarkNode{&switchNode{ssCases: cases}}
1532}
1533
1534type foreachCallParser struct{}
1535
1536func (p *foreachCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Cole Faustb0d32ab2021-12-09 14:00:59 -08001537 words := args.Split(",")
1538 if len(words) != 3 {
1539 return ctx.newBadExpr(node, "foreach function should have 3 arguments, found "+strconv.Itoa(len(words)))
1540 }
1541 if !words[0].Const() || words[0].Empty() || !identifierFullMatchRegex.MatchString(words[0].Strings[0]) {
1542 return ctx.newBadExpr(node, "first argument to foreach function must be a simple string identifier")
1543 }
1544 loopVarName := words[0].Strings[0]
1545 list := ctx.parseMakeString(node, words[1])
1546 action := ctx.parseMakeString(node, words[2]).transform(func(expr starlarkExpr) starlarkExpr {
1547 if varRefExpr, ok := expr.(*variableRefExpr); ok && varRefExpr.ref.name() == loopVarName {
1548 return &identifierExpr{loopVarName}
1549 }
1550 return nil
1551 })
1552
1553 if list.typ() != starlarkTypeList {
1554 list = &callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -08001555 name: baseName + ".words",
1556 returnType: starlarkTypeList,
Cole Faustb0d32ab2021-12-09 14:00:59 -08001557 args: []starlarkExpr{list},
1558 }
1559 }
1560
1561 return &foreachExpr{
1562 varName: loopVarName,
1563 list: list,
1564 action: action,
1565 }
1566}
1567
Cole Faustf035d402022-03-28 14:02:50 -07001568func transformNode(node starlarkNode, transformer func(expr starlarkExpr) starlarkExpr) {
1569 switch a := node.(type) {
1570 case *ifNode:
1571 a.expr = a.expr.transform(transformer)
1572 case *switchCase:
1573 transformNode(a.gate, transformer)
1574 for _, n := range a.nodes {
1575 transformNode(n, transformer)
1576 }
1577 case *switchNode:
1578 for _, n := range a.ssCases {
1579 transformNode(n, transformer)
1580 }
1581 case *exprNode:
1582 a.expr = a.expr.transform(transformer)
1583 case *assignmentNode:
1584 a.value = a.value.transform(transformer)
1585 case *foreachNode:
1586 a.list = a.list.transform(transformer)
1587 for _, n := range a.actions {
1588 transformNode(n, transformer)
1589 }
1590 }
1591}
1592
1593type foreachCallNodeParser struct{}
1594
1595func (p *foreachCallNodeParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) []starlarkNode {
1596 words := args.Split(",")
1597 if len(words) != 3 {
1598 return []starlarkNode{ctx.newBadNode(node, "foreach function should have 3 arguments, found "+strconv.Itoa(len(words)))}
1599 }
1600 if !words[0].Const() || words[0].Empty() || !identifierFullMatchRegex.MatchString(words[0].Strings[0]) {
1601 return []starlarkNode{ctx.newBadNode(node, "first argument to foreach function must be a simple string identifier")}
1602 }
1603
1604 loopVarName := words[0].Strings[0]
1605
1606 list := ctx.parseMakeString(node, words[1])
1607 if list.typ() != starlarkTypeList {
1608 list = &callExpr{
1609 name: baseName + ".words",
1610 returnType: starlarkTypeList,
1611 args: []starlarkExpr{list},
1612 }
1613 }
1614
1615 actions := ctx.parseNodeMakeString(node, words[2])
1616 // TODO(colefaust): Replace transforming code with something more elegant
1617 for _, action := range actions {
1618 transformNode(action, func(expr starlarkExpr) starlarkExpr {
1619 if varRefExpr, ok := expr.(*variableRefExpr); ok && varRefExpr.ref.name() == loopVarName {
1620 return &identifierExpr{loopVarName}
1621 }
1622 return nil
1623 })
1624 }
1625
1626 return []starlarkNode{&foreachNode{
1627 varName: loopVarName,
1628 list: list,
1629 actions: actions,
1630 }}
1631}
1632
Cole Faust9ebf6e42021-12-13 14:08:34 -08001633type wordCallParser struct{}
1634
1635func (p *wordCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001636 words := args.Split(",")
1637 if len(words) != 2 {
1638 return ctx.newBadExpr(node, "word function should have 2 arguments")
1639 }
1640 var index uint64 = 0
1641 if words[0].Const() {
1642 index, _ = strconv.ParseUint(strings.TrimSpace(words[0].Strings[0]), 10, 64)
1643 }
1644 if index < 1 {
1645 return ctx.newBadExpr(node, "word index should be constant positive integer")
1646 }
1647 words[1].TrimLeftSpaces()
1648 words[1].TrimRightSpaces()
1649 array := ctx.parseMakeString(node, words[1])
1650 if xBad, ok := array.(*badExpr); ok {
1651 return xBad
1652 }
1653 if array.typ() != starlarkTypeList {
1654 array = &callExpr{object: array, name: "split", returnType: starlarkTypeList}
1655 }
Cole Faustb0d32ab2021-12-09 14:00:59 -08001656 return &indexExpr{array, &intLiteralExpr{int(index - 1)}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001657}
1658
Cole Faust9ebf6e42021-12-13 14:08:34 -08001659type firstOrLastwordCallParser struct {
1660 isLastWord bool
1661}
1662
1663func (p *firstOrLastwordCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Sasha Smundak16e07732021-07-23 11:38:23 -07001664 arg := ctx.parseMakeString(node, args)
1665 if bad, ok := arg.(*badExpr); ok {
1666 return bad
1667 }
1668 index := &intLiteralExpr{0}
Cole Faust9ebf6e42021-12-13 14:08:34 -08001669 if p.isLastWord {
Sasha Smundak16e07732021-07-23 11:38:23 -07001670 if v, ok := arg.(*variableRefExpr); ok && v.ref.name() == "MAKEFILE_LIST" {
1671 return &stringLiteralExpr{ctx.script.mkFile}
1672 }
1673 index.literal = -1
1674 }
1675 if arg.typ() == starlarkTypeList {
1676 return &indexExpr{arg, index}
1677 }
1678 return &indexExpr{&callExpr{object: arg, name: "split", returnType: starlarkTypeList}, index}
1679}
1680
Cole Faustb1103e22022-01-06 15:22:05 -08001681func parseIntegerArguments(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString, expectedArgs int) ([]starlarkExpr, error) {
1682 parsedArgs := make([]starlarkExpr, 0)
1683 for _, arg := range args.Split(",") {
1684 expr := ctx.parseMakeString(node, arg)
1685 if expr.typ() == starlarkTypeList {
1686 return nil, fmt.Errorf("argument to math argument has type list, which cannot be converted to int")
1687 }
1688 if s, ok := maybeString(expr); ok {
1689 intVal, err := strconv.Atoi(strings.TrimSpace(s))
1690 if err != nil {
1691 return nil, err
1692 }
1693 expr = &intLiteralExpr{literal: intVal}
1694 } else if expr.typ() != starlarkTypeInt {
1695 expr = &callExpr{
1696 name: "int",
1697 args: []starlarkExpr{expr},
1698 returnType: starlarkTypeInt,
1699 }
1700 }
1701 parsedArgs = append(parsedArgs, expr)
1702 }
1703 if len(parsedArgs) != expectedArgs {
1704 return nil, fmt.Errorf("function should have %d arguments", expectedArgs)
1705 }
1706 return parsedArgs, nil
1707}
1708
1709type mathComparisonCallParser struct {
1710 op string
1711}
1712
1713func (p *mathComparisonCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1714 parsedArgs, err := parseIntegerArguments(ctx, node, args, 2)
1715 if err != nil {
1716 return ctx.newBadExpr(node, err.Error())
1717 }
1718 return &binaryOpExpr{
1719 left: parsedArgs[0],
1720 right: parsedArgs[1],
1721 op: p.op,
1722 returnType: starlarkTypeBool,
1723 }
1724}
1725
1726type mathMaxOrMinCallParser struct {
1727 function string
1728}
1729
1730func (p *mathMaxOrMinCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1731 parsedArgs, err := parseIntegerArguments(ctx, node, args, 2)
1732 if err != nil {
1733 return ctx.newBadExpr(node, err.Error())
1734 }
1735 return &callExpr{
1736 object: nil,
1737 name: p.function,
1738 args: parsedArgs,
1739 returnType: starlarkTypeInt,
1740 }
1741}
1742
Cole Faustf035d402022-03-28 14:02:50 -07001743type evalNodeParser struct{}
1744
1745func (p *evalNodeParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) []starlarkNode {
1746 parser := mkparser.NewParser("Eval expression", strings.NewReader(args.Dump()))
1747 nodes, errs := parser.Parse()
1748 if errs != nil {
1749 return []starlarkNode{ctx.newBadNode(node, "Unable to parse eval statement")}
1750 }
1751
1752 if len(nodes) == 0 {
1753 return []starlarkNode{}
1754 } else if len(nodes) == 1 {
1755 switch n := nodes[0].(type) {
1756 case *mkparser.Assignment:
1757 if n.Name.Const() {
1758 return ctx.handleAssignment(n)
1759 }
1760 case *mkparser.Comment:
1761 return []starlarkNode{&commentNode{strings.TrimSpace("#" + n.Comment)}}
1762 }
1763 }
1764
1765 return []starlarkNode{ctx.newBadNode(node, "Eval expression too complex; only assignments and comments are supported")}
1766}
1767
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001768func (ctx *parseContext) parseMakeString(node mkparser.Node, mk *mkparser.MakeString) starlarkExpr {
1769 if mk.Const() {
1770 return &stringLiteralExpr{mk.Dump()}
1771 }
1772 if mkRef, ok := mk.SingleVariable(); ok {
1773 return ctx.parseReference(node, mkRef)
1774 }
1775 // If we reached here, it's neither string literal nor a simple variable,
1776 // we need a full-blown interpolation node that will generate
1777 // "a%b%c" % (X, Y) for a$(X)b$(Y)c
Cole Faustfc438682021-12-14 12:46:32 -08001778 parts := make([]starlarkExpr, len(mk.Variables)+len(mk.Strings))
1779 for i := 0; i < len(parts); i++ {
1780 if i%2 == 0 {
1781 parts[i] = &stringLiteralExpr{literal: mk.Strings[i/2]}
1782 } else {
1783 parts[i] = ctx.parseReference(node, mk.Variables[i/2].Name)
1784 if x, ok := parts[i].(*badExpr); ok {
1785 return x
1786 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001787 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001788 }
Cole Faustfc438682021-12-14 12:46:32 -08001789 return NewInterpolateExpr(parts)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001790}
1791
Cole Faustf035d402022-03-28 14:02:50 -07001792func (ctx *parseContext) parseNodeMakeString(node mkparser.Node, mk *mkparser.MakeString) []starlarkNode {
1793 // Discard any constant values in the make string, as they would be top level
1794 // string literals and do nothing.
1795 result := make([]starlarkNode, 0, len(mk.Variables))
1796 for i := range mk.Variables {
1797 result = append(result, ctx.handleVariable(&mk.Variables[i])...)
1798 }
1799 return result
1800}
1801
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001802// Handles the statements whose treatment is the same in all contexts: comment,
1803// assignment, variable (which is a macro call in reality) and all constructs that
1804// do not handle in any context ('define directive and any unrecognized stuff).
Cole Faustdd569ae2022-01-31 15:48:29 -08001805func (ctx *parseContext) handleSimpleStatement(node mkparser.Node) []starlarkNode {
1806 var result []starlarkNode
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001807 switch x := node.(type) {
1808 case *mkparser.Comment:
Cole Faustdd569ae2022-01-31 15:48:29 -08001809 if n, handled := ctx.maybeHandleAnnotation(x); handled && n != nil {
1810 result = []starlarkNode{n}
1811 } else if !handled {
1812 result = []starlarkNode{&commentNode{strings.TrimSpace("#" + x.Comment)}}
Cole Faust7940c6a2022-01-31 15:54:05 -08001813 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001814 case *mkparser.Assignment:
Cole Faustdd569ae2022-01-31 15:48:29 -08001815 result = ctx.handleAssignment(x)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001816 case *mkparser.Variable:
Cole Faustdd569ae2022-01-31 15:48:29 -08001817 result = ctx.handleVariable(x)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001818 case *mkparser.Directive:
1819 switch x.Name {
1820 case "define":
Cole Faustdd569ae2022-01-31 15:48:29 -08001821 if res := ctx.maybeHandleDefine(x); res != nil {
1822 result = []starlarkNode{res}
1823 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001824 case "include", "-include":
Cole Faustdd569ae2022-01-31 15:48:29 -08001825 result = ctx.handleInclude(node, ctx.parseMakeString(node, x.Args), x.Name[0] != '-')
Cole Faust591a1fe2021-11-08 15:37:57 -08001826 case "ifeq", "ifneq", "ifdef", "ifndef":
Cole Faustdd569ae2022-01-31 15:48:29 -08001827 result = []starlarkNode{ctx.handleIfBlock(x)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001828 default:
Cole Faustdd569ae2022-01-31 15:48:29 -08001829 result = []starlarkNode{ctx.newBadNode(x, "unexpected directive %s", x.Name)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001830 }
1831 default:
Cole Faustdd569ae2022-01-31 15:48:29 -08001832 result = []starlarkNode{ctx.newBadNode(x, "unsupported line %s", strings.ReplaceAll(x.Dump(), "\n", "\n#"))}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001833 }
Cole Faust6c934f62022-01-06 15:51:12 -08001834
1835 // Clear the includeTops after each non-comment statement
1836 // so that include annotations placed on certain statements don't apply
1837 // globally for the rest of the makefile was well.
Cole Faustf92c9f22022-03-14 14:35:50 -07001838 if _, wasComment := node.(*mkparser.Comment); !wasComment {
1839 ctx.atTopOfMakefile = false
Cole Faust6c934f62022-01-06 15:51:12 -08001840 ctx.includeTops = []string{}
1841 }
Cole Faustdd569ae2022-01-31 15:48:29 -08001842
1843 if result == nil {
1844 result = []starlarkNode{}
1845 }
Cole Faustf035d402022-03-28 14:02:50 -07001846
Cole Faustdd569ae2022-01-31 15:48:29 -08001847 return result
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001848}
1849
Cole Faustf92c9f22022-03-14 14:35:50 -07001850// The types allowed in a type_hint
1851var typeHintMap = map[string]starlarkType{
1852 "string": starlarkTypeString,
1853 "list": starlarkTypeList,
1854}
1855
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001856// Processes annotation. An annotation is a comment that starts with #RBC# and provides
1857// a conversion hint -- say, where to look for the dynamically calculated inherit/include
Cole Faust7940c6a2022-01-31 15:54:05 -08001858// paths. Returns true if the comment was a successfully-handled annotation.
Cole Faustdd569ae2022-01-31 15:48:29 -08001859func (ctx *parseContext) maybeHandleAnnotation(cnode *mkparser.Comment) (starlarkNode, bool) {
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001860 maybeTrim := func(s, prefix string) (string, bool) {
1861 if strings.HasPrefix(s, prefix) {
1862 return strings.TrimSpace(strings.TrimPrefix(s, prefix)), true
1863 }
1864 return s, false
1865 }
1866 annotation, ok := maybeTrim(cnode.Comment, annotationCommentPrefix)
1867 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -08001868 return nil, false
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001869 }
1870 if p, ok := maybeTrim(annotation, "include_top"); ok {
Cole Faustf7ed5342021-12-21 14:15:12 -08001871 // Don't allow duplicate include tops, because then we will generate
1872 // invalid starlark code. (duplicate keys in the _entry dictionary)
1873 for _, top := range ctx.includeTops {
1874 if top == p {
Cole Faustdd569ae2022-01-31 15:48:29 -08001875 return nil, true
Cole Faustf7ed5342021-12-21 14:15:12 -08001876 }
1877 }
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001878 ctx.includeTops = append(ctx.includeTops, p)
Cole Faustdd569ae2022-01-31 15:48:29 -08001879 return nil, true
Cole Faustf92c9f22022-03-14 14:35:50 -07001880 } else if p, ok := maybeTrim(annotation, "type_hint"); ok {
1881 // Type hints must come at the beginning the file, to avoid confusion
1882 // if a type hint was specified later and thus only takes effect for half
1883 // of the file.
1884 if !ctx.atTopOfMakefile {
1885 return ctx.newBadNode(cnode, "type_hint annotations must come before the first Makefile statement"), true
1886 }
1887
1888 parts := strings.Fields(p)
1889 if len(parts) <= 1 {
1890 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
1891 }
1892
1893 var varType starlarkType
1894 if varType, ok = typeHintMap[parts[0]]; !ok {
1895 varType = starlarkTypeUnknown
1896 }
1897 if varType == starlarkTypeUnknown {
1898 return ctx.newBadNode(cnode, "Invalid type_hint annotation. Only list/string types are accepted, found %s", parts[0]), true
1899 }
1900
1901 for _, name := range parts[1:] {
1902 // Don't allow duplicate type hints
1903 if _, ok := ctx.typeHints[name]; ok {
1904 return ctx.newBadNode(cnode, "Duplicate type hint for variable %s", name), true
1905 }
1906 ctx.typeHints[name] = varType
1907 }
1908 return nil, true
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001909 }
Cole Faustdd569ae2022-01-31 15:48:29 -08001910 return ctx.newBadNode(cnode, "unsupported annotation %s", cnode.Comment), true
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001911}
1912
1913func (ctx *parseContext) loadedModulePath(path string) string {
1914 // During the transition to Roboleaf some of the product configuration files
1915 // will be converted and checked in while the others will be generated on the fly
1916 // and run. The runner (rbcrun application) accommodates this by allowing three
1917 // different ways to specify the loaded file location:
1918 // 1) load(":<file>",...) loads <file> from the same directory
1919 // 2) load("//path/relative/to/source/root:<file>", ...) loads <file> source tree
1920 // 3) load("/absolute/path/to/<file> absolute path
1921 // If the file being generated and the file it wants to load are in the same directory,
1922 // generate option 1.
1923 // Otherwise, if output directory is not specified, generate 2)
1924 // Finally, if output directory has been specified and the file being generated and
1925 // the file it wants to load from are in the different directories, generate 2) or 3):
1926 // * if the file being loaded exists in the source tree, generate 2)
1927 // * otherwise, generate 3)
1928 // Finally, figure out the loaded module path and name and create a node for it
1929 loadedModuleDir := filepath.Dir(path)
1930 base := filepath.Base(path)
1931 loadedModuleName := strings.TrimSuffix(base, filepath.Ext(base)) + ctx.outputSuffix
1932 if loadedModuleDir == filepath.Dir(ctx.script.mkFile) {
1933 return ":" + loadedModuleName
1934 }
1935 if ctx.outputDir == "" {
1936 return fmt.Sprintf("//%s:%s", loadedModuleDir, loadedModuleName)
1937 }
1938 if _, err := os.Stat(filepath.Join(loadedModuleDir, loadedModuleName)); err == nil {
1939 return fmt.Sprintf("//%s:%s", loadedModuleDir, loadedModuleName)
1940 }
1941 return filepath.Join(ctx.outputDir, loadedModuleDir, loadedModuleName)
1942}
1943
Sasha Smundak3deb9682021-07-26 18:42:25 -07001944func (ctx *parseContext) addSoongNamespace(ns string) {
1945 if _, ok := ctx.soongNamespaces[ns]; ok {
1946 return
1947 }
1948 ctx.soongNamespaces[ns] = make(map[string]bool)
1949}
1950
1951func (ctx *parseContext) hasSoongNamespace(name string) bool {
1952 _, ok := ctx.soongNamespaces[name]
1953 return ok
1954}
1955
1956func (ctx *parseContext) updateSoongNamespace(replace bool, namespaceName string, varNames []string) {
1957 ctx.addSoongNamespace(namespaceName)
1958 vars := ctx.soongNamespaces[namespaceName]
1959 if replace {
1960 vars = make(map[string]bool)
1961 ctx.soongNamespaces[namespaceName] = vars
1962 }
1963 for _, v := range varNames {
1964 vars[v] = true
1965 }
1966}
1967
1968func (ctx *parseContext) hasNamespaceVar(namespaceName string, varName string) bool {
1969 vars, ok := ctx.soongNamespaces[namespaceName]
1970 if ok {
1971 _, ok = vars[varName]
1972 }
1973 return ok
1974}
1975
Sasha Smundak422b6142021-11-11 18:31:59 -08001976func (ctx *parseContext) errorLocation(node mkparser.Node) ErrorLocation {
1977 return ErrorLocation{ctx.script.mkFile, ctx.script.nodeLocator(node.Pos())}
1978}
1979
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001980func (ss *StarlarkScript) String() string {
1981 return NewGenerateContext(ss).emit()
1982}
1983
1984func (ss *StarlarkScript) SubConfigFiles() []string {
Sasha Smundak6609ba72021-07-22 18:32:56 -07001985
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001986 var subs []string
1987 for _, src := range ss.inherited {
1988 subs = append(subs, src.originalPath)
1989 }
1990 return subs
1991}
1992
1993func (ss *StarlarkScript) HasErrors() bool {
1994 return ss.hasErrors
1995}
1996
1997// Convert reads and parses a makefile. If successful, parsed tree
1998// is returned and then can be passed to String() to get the generated
1999// Starlark file.
2000func Convert(req Request) (*StarlarkScript, error) {
2001 reader := req.Reader
2002 if reader == nil {
2003 mkContents, err := ioutil.ReadFile(req.MkFile)
2004 if err != nil {
2005 return nil, err
2006 }
2007 reader = bytes.NewBuffer(mkContents)
2008 }
2009 parser := mkparser.NewParser(req.MkFile, reader)
2010 nodes, errs := parser.Parse()
2011 if len(errs) > 0 {
2012 for _, e := range errs {
2013 fmt.Fprintln(os.Stderr, "ERROR:", e)
2014 }
2015 return nil, fmt.Errorf("bad makefile %s", req.MkFile)
2016 }
2017 starScript := &StarlarkScript{
Sasha Smundak422b6142021-11-11 18:31:59 -08002018 moduleName: moduleNameForFile(req.MkFile),
2019 mkFile: req.MkFile,
Sasha Smundak422b6142021-11-11 18:31:59 -08002020 traceCalls: req.TraceCalls,
2021 sourceFS: req.SourceFS,
2022 makefileFinder: req.MakefileFinder,
2023 nodeLocator: func(pos mkparser.Pos) int { return parser.Unpack(pos).Line },
Cole Faustdd569ae2022-01-31 15:48:29 -08002024 nodes: make([]starlarkNode, 0),
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002025 }
2026 ctx := newParseContext(starScript, nodes)
2027 ctx.outputSuffix = req.OutputSuffix
2028 ctx.outputDir = req.OutputDir
2029 ctx.errorLogger = req.ErrorLogger
2030 if len(req.TracedVariables) > 0 {
2031 ctx.tracedVariables = make(map[string]bool)
2032 for _, v := range req.TracedVariables {
2033 ctx.tracedVariables[v] = true
2034 }
2035 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002036 for ctx.hasNodes() && ctx.fatalError == nil {
Cole Faustdd569ae2022-01-31 15:48:29 -08002037 starScript.nodes = append(starScript.nodes, ctx.handleSimpleStatement(ctx.getNode())...)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002038 }
2039 if ctx.fatalError != nil {
2040 return nil, ctx.fatalError
2041 }
2042 return starScript, nil
2043}
2044
Cole Faust864028a2021-12-01 13:43:17 -08002045func Launcher(mainModuleUri, inputVariablesUri, mainModuleName string) string {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002046 var buf bytes.Buffer
2047 fmt.Fprintf(&buf, "load(%q, %q)\n", baseUri, baseName)
Cole Faust864028a2021-12-01 13:43:17 -08002048 fmt.Fprintf(&buf, "load(%q, input_variables_init = \"init\")\n", inputVariablesUri)
Sasha Smundakd7d07ad2021-09-10 15:42:34 -07002049 fmt.Fprintf(&buf, "load(%q, \"init\")\n", mainModuleUri)
Cole Faust864028a2021-12-01 13:43:17 -08002050 fmt.Fprintf(&buf, "%s(%s(%q, init, input_variables_init))\n", cfnPrintVars, cfnMain, mainModuleName)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002051 return buf.String()
2052}
2053
Cole Faust6ed7cb42021-10-07 17:08:46 -07002054func BoardLauncher(mainModuleUri string, inputVariablesUri string) string {
2055 var buf bytes.Buffer
2056 fmt.Fprintf(&buf, "load(%q, %q)\n", baseUri, baseName)
2057 fmt.Fprintf(&buf, "load(%q, \"init\")\n", mainModuleUri)
2058 fmt.Fprintf(&buf, "load(%q, input_variables_init = \"init\")\n", inputVariablesUri)
Cole Fausta0604662022-02-28 11:53:58 -08002059 fmt.Fprintf(&buf, "%s(%s(init, input_variables_init))\n", cfnPrintVars, cfnBoardMain)
Cole Faust6ed7cb42021-10-07 17:08:46 -07002060 return buf.String()
2061}
2062
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002063func MakePath2ModuleName(mkPath string) string {
2064 return strings.TrimSuffix(mkPath, filepath.Ext(mkPath))
2065}