blob: 87d23345403d47768f17ca3eace2bb4cf0063845 [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},
Cole Faust6c41b8a2022-04-13 13:53:48 -070083 "enforce-product-packages-exist": &simpleCallParser{name: baseName + ".enforce_product_packages_exist", returnType: starlarkTypeVoid, addHandle: true},
Cole Faust1cc08852022-02-28 11:12:08 -080084 "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},
Cole Faust5a13aaf2022-04-27 17:49:35 -070089 "firstword": &simpleCallParser{name: baseName + ".first_word", returnType: starlarkTypeString},
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{},
Cole Faust5a13aaf2022-04-27 17:49:35 -0700100 "lastword": &simpleCallParser{name: baseName + ".last_word", returnType: starlarkTypeString},
Cole Faust1cc08852022-02-28 11:12:08 -0800101 "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},
Cole Faustea9db582022-03-21 17:50:05 -0700110 "require-artifacts-in-path": &simpleCallParser{name: baseName + ".require_artifacts_in_path", returnType: starlarkTypeVoid, addHandle: true},
111 "require-artifacts-in-path-relaxed": &simpleCallParser{name: baseName + ".require_artifacts_in_path_relaxed", returnType: starlarkTypeVoid, addHandle: true},
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
Cole Faustf0632662022-04-07 13:59:24 -0700200// varAssignmentScope points to the last assignment for each variable
201// in the current block. It is used during the parsing to chain
202// the assignments to a variable together.
203type varAssignmentScope struct {
204 outer *varAssignmentScope
205 vars map[string]bool
206}
207
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800208// Starlark output generation context
209type generationContext struct {
Cole Faustf0632662022-04-07 13:59:24 -0700210 buf strings.Builder
211 starScript *StarlarkScript
212 indentLevel int
213 inAssignment bool
214 tracedCount int
215 varAssignments *varAssignmentScope
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800216}
217
218func NewGenerateContext(ss *StarlarkScript) *generationContext {
Cole Faustf0632662022-04-07 13:59:24 -0700219 return &generationContext{
220 starScript: ss,
221 varAssignments: &varAssignmentScope{
222 outer: nil,
223 vars: make(map[string]bool),
224 },
225 }
226}
227
228func (gctx *generationContext) pushVariableAssignments() {
229 va := &varAssignmentScope{
230 outer: gctx.varAssignments,
231 vars: make(map[string]bool),
232 }
233 gctx.varAssignments = va
234}
235
236func (gctx *generationContext) popVariableAssignments() {
237 gctx.varAssignments = gctx.varAssignments.outer
238}
239
240func (gctx *generationContext) hasBeenAssigned(v variable) bool {
241 for va := gctx.varAssignments; va != nil; va = va.outer {
242 if _, ok := va.vars[v.name()]; ok {
243 return true
244 }
245 }
246 return false
247}
248
249func (gctx *generationContext) setHasBeenAssigned(v variable) {
250 gctx.varAssignments.vars[v.name()] = true
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800251}
252
253// emit returns generated script
254func (gctx *generationContext) emit() string {
255 ss := gctx.starScript
256
257 // The emitted code has the following layout:
258 // <initial comments>
259 // preamble, i.e.,
260 // load statement for the runtime support
261 // load statement for each unique submodule pulled in by this one
262 // def init(g, handle):
263 // cfg = rblf.cfg(handle)
264 // <statements>
265 // <warning if conversion was not clean>
266
267 iNode := len(ss.nodes)
268 for i, node := range ss.nodes {
269 if _, ok := node.(*commentNode); !ok {
270 iNode = i
271 break
272 }
273 node.emit(gctx)
274 }
275
276 gctx.emitPreamble()
277
278 gctx.newLine()
279 // The arguments passed to the init function are the global dictionary
280 // ('g') and the product configuration dictionary ('cfg')
281 gctx.write("def init(g, handle):")
282 gctx.indentLevel++
283 if gctx.starScript.traceCalls {
284 gctx.newLine()
285 gctx.writef(`print(">%s")`, gctx.starScript.mkFile)
286 }
287 gctx.newLine()
288 gctx.writef("cfg = %s(handle)", cfnGetCfg)
289 for _, node := range ss.nodes[iNode:] {
290 node.emit(gctx)
291 }
292
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800293 if gctx.starScript.traceCalls {
294 gctx.newLine()
295 gctx.writef(`print("<%s")`, gctx.starScript.mkFile)
296 }
297 gctx.indentLevel--
298 gctx.write("\n")
299 return gctx.buf.String()
300}
301
302func (gctx *generationContext) emitPreamble() {
303 gctx.newLine()
304 gctx.writef("load(%q, %q)", baseUri, baseName)
305 // Emit exactly one load statement for each URI.
306 loadedSubConfigs := make(map[string]string)
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800307 for _, mi := range gctx.starScript.inherited {
308 uri := mi.path
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800309 if m, ok := loadedSubConfigs[uri]; ok {
310 // No need to emit load statement, but fix module name.
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800311 mi.moduleLocalName = m
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800312 continue
313 }
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800314 if mi.optional || mi.missing {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800315 uri += "|init"
316 }
317 gctx.newLine()
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800318 gctx.writef("load(%q, %s = \"init\")", uri, mi.entryName())
319 loadedSubConfigs[uri] = mi.moduleLocalName
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800320 }
321 gctx.write("\n")
322}
323
324func (gctx *generationContext) emitPass() {
325 gctx.newLine()
326 gctx.write("pass")
327}
328
329func (gctx *generationContext) write(ss ...string) {
330 for _, s := range ss {
331 gctx.buf.WriteString(s)
332 }
333}
334
335func (gctx *generationContext) writef(format string, args ...interface{}) {
336 gctx.write(fmt.Sprintf(format, args...))
337}
338
339func (gctx *generationContext) newLine() {
340 if gctx.buf.Len() == 0 {
341 return
342 }
343 gctx.write("\n")
344 gctx.writef("%*s", 2*gctx.indentLevel, "")
345}
346
Sasha Smundak422b6142021-11-11 18:31:59 -0800347func (gctx *generationContext) emitConversionError(el ErrorLocation, message string) {
348 gctx.writef(`rblf.mk2rbc_error("%s", %q)`, el, message)
349}
350
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800351func (gctx *generationContext) emitLoadCheck(im inheritedModule) {
352 if !im.needsLoadCheck() {
353 return
354 }
355 gctx.newLine()
356 gctx.writef("if not %s:", im.entryName())
357 gctx.indentLevel++
358 gctx.newLine()
359 gctx.write(`rblf.mkerror("`, gctx.starScript.mkFile, `", "Cannot find %s" % (`)
360 im.pathExpr().emit(gctx)
361 gctx.write("))")
362 gctx.indentLevel--
363}
364
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800365type knownVariable struct {
366 name string
367 class varClass
368 valueType starlarkType
369}
370
371type knownVariables map[string]knownVariable
372
373func (pcv knownVariables) NewVariable(name string, varClass varClass, valueType starlarkType) {
374 v, exists := pcv[name]
375 if !exists {
376 pcv[name] = knownVariable{name, varClass, valueType}
377 return
378 }
379 // Conflict resolution:
380 // * config class trumps everything
381 // * any type trumps unknown type
382 match := varClass == v.class
383 if !match {
384 if varClass == VarClassConfig {
385 v.class = VarClassConfig
386 match = true
387 } else if v.class == VarClassConfig {
388 match = true
389 }
390 }
391 if valueType != v.valueType {
392 if valueType != starlarkTypeUnknown {
393 if v.valueType == starlarkTypeUnknown {
394 v.valueType = valueType
395 } else {
396 match = false
397 }
398 }
399 }
400 if !match {
401 fmt.Fprintf(os.Stderr, "cannot redefine %s as %v/%v (already defined as %v/%v)\n",
402 name, varClass, valueType, v.class, v.valueType)
403 }
404}
405
406// All known product variables.
407var KnownVariables = make(knownVariables)
408
409func init() {
410 for _, kv := range []string{
411 // Kernel-related variables that we know are lists.
412 "BOARD_VENDOR_KERNEL_MODULES",
413 "BOARD_VENDOR_RAMDISK_KERNEL_MODULES",
414 "BOARD_VENDOR_RAMDISK_KERNEL_MODULES_LOAD",
415 "BOARD_RECOVERY_KERNEL_MODULES",
416 // Other variables we knwo are lists
417 "ART_APEX_JARS",
418 } {
419 KnownVariables.NewVariable(kv, VarClassSoong, starlarkTypeList)
420 }
421}
422
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800423// Information about the generated Starlark script.
424type StarlarkScript struct {
Sasha Smundak422b6142021-11-11 18:31:59 -0800425 mkFile string
426 moduleName string
427 mkPos scanner.Position
428 nodes []starlarkNode
429 inherited []*moduleInfo
430 hasErrors bool
Sasha Smundak422b6142021-11-11 18:31:59 -0800431 traceCalls bool // print enter/exit each init function
432 sourceFS fs.FS
433 makefileFinder MakefileFinder
434 nodeLocator func(pos mkparser.Pos) int
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800435}
436
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800437// parseContext holds the script we are generating and all the ephemeral data
438// needed during the parsing.
439type parseContext struct {
440 script *StarlarkScript
441 nodes []mkparser.Node // Makefile as parsed by mkparser
442 currentNodeIndex int // Node in it we are processing
443 ifNestLevel int
444 moduleNameCount map[string]int // count of imported modules with given basename
445 fatalError error
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800446 outputSuffix string
Sasha Smundak7d934b92021-11-10 12:20:01 -0800447 errorLogger ErrorLogger
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800448 tracedVariables map[string]bool // variables to be traced in the generated script
449 variables map[string]variable
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800450 outputDir string
Sasha Smundak6609ba72021-07-22 18:32:56 -0700451 dependentModules map[string]*moduleInfo
Sasha Smundak3deb9682021-07-26 18:42:25 -0700452 soongNamespaces map[string]map[string]bool
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700453 includeTops []string
Cole Faustf92c9f22022-03-14 14:35:50 -0700454 typeHints map[string]starlarkType
455 atTopOfMakefile bool
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800456}
457
458func newParseContext(ss *StarlarkScript, nodes []mkparser.Node) *parseContext {
459 predefined := []struct{ name, value string }{
460 {"SRC_TARGET_DIR", filepath.Join("build", "make", "target")},
461 {"LOCAL_PATH", filepath.Dir(ss.mkFile)},
Cole Faust5a13aaf2022-04-27 17:49:35 -0700462 {"MAKEFILE_LIST", ss.mkFile},
Cole Faust9b6111a2022-02-02 15:38:33 -0800463 {"TOPDIR", ""}, // TOPDIR is just set to an empty string in cleanbuild.mk and core.mk
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800464 // TODO(asmundak): maybe read it from build/make/core/envsetup.mk?
465 {"TARGET_COPY_OUT_SYSTEM", "system"},
466 {"TARGET_COPY_OUT_SYSTEM_OTHER", "system_other"},
467 {"TARGET_COPY_OUT_DATA", "data"},
468 {"TARGET_COPY_OUT_ASAN", filepath.Join("data", "asan")},
469 {"TARGET_COPY_OUT_OEM", "oem"},
470 {"TARGET_COPY_OUT_RAMDISK", "ramdisk"},
471 {"TARGET_COPY_OUT_DEBUG_RAMDISK", "debug_ramdisk"},
472 {"TARGET_COPY_OUT_VENDOR_DEBUG_RAMDISK", "vendor_debug_ramdisk"},
473 {"TARGET_COPY_OUT_TEST_HARNESS_RAMDISK", "test_harness_ramdisk"},
474 {"TARGET_COPY_OUT_ROOT", "root"},
475 {"TARGET_COPY_OUT_RECOVERY", "recovery"},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800476 {"TARGET_COPY_OUT_VENDOR_RAMDISK", "vendor_ramdisk"},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800477 // TODO(asmundak): to process internal config files, we need the following variables:
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800478 // TARGET_VENDOR
479 // target_base_product
480 //
481
482 // the following utility variables are set in build/make/common/core.mk:
483 {"empty", ""},
484 {"space", " "},
485 {"comma", ","},
486 {"newline", "\n"},
487 {"pound", "#"},
488 {"backslash", "\\"},
489 }
490 ctx := &parseContext{
491 script: ss,
492 nodes: nodes,
493 currentNodeIndex: 0,
494 ifNestLevel: 0,
495 moduleNameCount: make(map[string]int),
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800496 variables: make(map[string]variable),
Sasha Smundak6609ba72021-07-22 18:32:56 -0700497 dependentModules: make(map[string]*moduleInfo),
Sasha Smundak3deb9682021-07-26 18:42:25 -0700498 soongNamespaces: make(map[string]map[string]bool),
Cole Faust6c934f62022-01-06 15:51:12 -0800499 includeTops: []string{},
Cole Faustf92c9f22022-03-14 14:35:50 -0700500 typeHints: make(map[string]starlarkType),
501 atTopOfMakefile: true,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800502 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800503 for _, item := range predefined {
504 ctx.variables[item.name] = &predefinedVariable{
505 baseVariable: baseVariable{nam: item.name, typ: starlarkTypeString},
506 value: &stringLiteralExpr{item.value},
507 }
508 }
509
510 return ctx
511}
512
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800513func (ctx *parseContext) hasNodes() bool {
514 return ctx.currentNodeIndex < len(ctx.nodes)
515}
516
517func (ctx *parseContext) getNode() mkparser.Node {
518 if !ctx.hasNodes() {
519 return nil
520 }
521 node := ctx.nodes[ctx.currentNodeIndex]
522 ctx.currentNodeIndex++
523 return node
524}
525
526func (ctx *parseContext) backNode() {
527 if ctx.currentNodeIndex <= 0 {
528 panic("Cannot back off")
529 }
530 ctx.currentNodeIndex--
531}
532
Cole Faustdd569ae2022-01-31 15:48:29 -0800533func (ctx *parseContext) handleAssignment(a *mkparser.Assignment) []starlarkNode {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800534 // Handle only simple variables
Cole Faust00afd4f2022-04-26 14:01:56 -0700535 if !a.Name.Const() || a.Target != nil {
Cole Faustdd569ae2022-01-31 15:48:29 -0800536 return []starlarkNode{ctx.newBadNode(a, "Only simple variables are handled")}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800537 }
538 name := a.Name.Strings[0]
Sasha Smundakea3bc3a2021-11-10 13:06:42 -0800539 // The `override` directive
540 // override FOO :=
541 // is parsed as an assignment to a variable named `override FOO`.
542 // There are very few places where `override` is used, just flag it.
543 if strings.HasPrefix(name, "override ") {
Cole Faustdd569ae2022-01-31 15:48:29 -0800544 return []starlarkNode{ctx.newBadNode(a, "cannot handle override directive")}
Sasha Smundakea3bc3a2021-11-10 13:06:42 -0800545 }
Cole Faust5d5fcc32022-04-26 18:02:05 -0700546 if name == ".KATI_READONLY" {
547 // Skip assignments to .KATI_READONLY. If it was in the output file, it
548 // would be an error because it would be sorted before the definition of
549 // the variable it's trying to make readonly.
550 return []starlarkNode{}
551 }
Sasha Smundakea3bc3a2021-11-10 13:06:42 -0800552
Cole Faustc00184e2021-11-08 12:08:57 -0800553 // Soong configuration
Sasha Smundak3deb9682021-07-26 18:42:25 -0700554 if strings.HasPrefix(name, soongNsPrefix) {
Cole Faustdd569ae2022-01-31 15:48:29 -0800555 return ctx.handleSoongNsAssignment(strings.TrimPrefix(name, soongNsPrefix), a)
Sasha Smundak3deb9682021-07-26 18:42:25 -0700556 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800557 lhs := ctx.addVariable(name)
558 if lhs == nil {
Cole Faustdd569ae2022-01-31 15:48:29 -0800559 return []starlarkNode{ctx.newBadNode(a, "unknown variable %s", name)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800560 }
Cole Faust3c4fc992022-02-28 16:05:01 -0800561 _, isTraced := ctx.tracedVariables[lhs.name()]
Sasha Smundak422b6142021-11-11 18:31:59 -0800562 asgn := &assignmentNode{lhs: lhs, mkValue: a.Value, isTraced: isTraced, location: ctx.errorLocation(a)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800563 if lhs.valueType() == starlarkTypeUnknown {
564 // Try to divine variable type from the RHS
565 asgn.value = ctx.parseMakeString(a, a.Value)
566 if xBad, ok := asgn.value.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800567 return []starlarkNode{&exprNode{xBad}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800568 }
569 inferred_type := asgn.value.typ()
570 if inferred_type != starlarkTypeUnknown {
Sasha Smundak9d011ab2021-07-09 16:00:57 -0700571 lhs.setValueType(inferred_type)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800572 }
573 }
574 if lhs.valueType() == starlarkTypeList {
Cole Faustdd569ae2022-01-31 15:48:29 -0800575 xConcat, xBad := ctx.buildConcatExpr(a)
576 if xBad != nil {
577 return []starlarkNode{&exprNode{expr: xBad}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800578 }
579 switch len(xConcat.items) {
580 case 0:
581 asgn.value = &listExpr{}
582 case 1:
583 asgn.value = xConcat.items[0]
584 default:
585 asgn.value = xConcat
586 }
587 } else {
588 asgn.value = ctx.parseMakeString(a, a.Value)
589 if xBad, ok := asgn.value.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800590 return []starlarkNode{&exprNode{expr: xBad}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800591 }
592 }
593
Cole Faust421a1922022-03-16 14:35:45 -0700594 if asgn.lhs.valueType() == starlarkTypeString &&
595 asgn.value.typ() != starlarkTypeUnknown &&
596 asgn.value.typ() != starlarkTypeString {
597 asgn.value = &toStringExpr{expr: asgn.value}
598 }
599
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800600 switch a.Type {
601 case "=", ":=":
602 asgn.flavor = asgnSet
603 case "+=":
Cole Fauste2a37982022-03-09 16:00:17 -0800604 asgn.flavor = asgnAppend
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800605 case "?=":
606 asgn.flavor = asgnMaybeSet
607 default:
608 panic(fmt.Errorf("unexpected assignment type %s", a.Type))
609 }
610
Cole Faustdd569ae2022-01-31 15:48:29 -0800611 return []starlarkNode{asgn}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800612}
613
Cole Faustdd569ae2022-01-31 15:48:29 -0800614func (ctx *parseContext) handleSoongNsAssignment(name string, asgn *mkparser.Assignment) []starlarkNode {
Sasha Smundak3deb9682021-07-26 18:42:25 -0700615 val := ctx.parseMakeString(asgn, asgn.Value)
616 if xBad, ok := val.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800617 return []starlarkNode{&exprNode{expr: xBad}}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700618 }
Sasha Smundak3deb9682021-07-26 18:42:25 -0700619
620 // Unfortunately, Soong namespaces can be set up by directly setting corresponding Make
621 // variables instead of via add_soong_config_namespace + add_soong_config_var_value.
622 // Try to divine the call from the assignment as follows:
623 if name == "NAMESPACES" {
624 // Upon seeng
625 // SOONG_CONFIG_NAMESPACES += foo
626 // remember that there is a namespace `foo` and act as we saw
627 // $(call add_soong_config_namespace,foo)
628 s, ok := maybeString(val)
629 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800630 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 -0700631 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800632 result := make([]starlarkNode, 0)
Sasha Smundak3deb9682021-07-26 18:42:25 -0700633 for _, ns := range strings.Fields(s) {
634 ctx.addSoongNamespace(ns)
Cole Faustdd569ae2022-01-31 15:48:29 -0800635 result = append(result, &exprNode{&callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -0800636 name: baseName + ".soong_config_namespace",
637 args: []starlarkExpr{&globalsExpr{}, &stringLiteralExpr{ns}},
Sasha Smundak3deb9682021-07-26 18:42:25 -0700638 returnType: starlarkTypeVoid,
639 }})
640 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800641 return result
Sasha Smundak3deb9682021-07-26 18:42:25 -0700642 } else {
643 // Upon seeing
644 // SOONG_CONFIG_x_y = v
645 // find a namespace called `x` and act as if we encountered
Cole Faustc00184e2021-11-08 12:08:57 -0800646 // $(call soong_config_set,x,y,v)
Sasha Smundak3deb9682021-07-26 18:42:25 -0700647 // or check that `x_y` is a namespace, and then add the RHS of this assignment as variables in
648 // it.
649 // Emit an error in the ambiguous situation (namespaces `foo_bar` with a variable `baz`
650 // and `foo` with a variable `bar_baz`.
651 namespaceName := ""
652 if ctx.hasSoongNamespace(name) {
653 namespaceName = name
654 }
655 var varName string
656 for pos, ch := range name {
657 if !(ch == '_' && ctx.hasSoongNamespace(name[0:pos])) {
658 continue
659 }
660 if namespaceName != "" {
Cole Faustdd569ae2022-01-31 15:48:29 -0800661 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 -0700662 }
663 namespaceName = name[0:pos]
664 varName = name[pos+1:]
665 }
666 if namespaceName == "" {
Cole Faustdd569ae2022-01-31 15:48:29 -0800667 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 -0700668 }
669 if varName == "" {
670 // Remember variables in this namespace
671 s, ok := maybeString(val)
672 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800673 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 -0700674 }
675 ctx.updateSoongNamespace(asgn.Type != "+=", namespaceName, strings.Fields(s))
Cole Faustdd569ae2022-01-31 15:48:29 -0800676 return []starlarkNode{}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700677 }
678
679 // Finally, handle assignment to a namespace variable
680 if !ctx.hasNamespaceVar(namespaceName, varName) {
Cole Faustdd569ae2022-01-31 15:48:29 -0800681 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 -0700682 }
Cole Faust9ebf6e42021-12-13 14:08:34 -0800683 fname := baseName + "." + soongConfigAssign
Sasha Smundak65b547e2021-09-17 15:35:41 -0700684 if asgn.Type == "+=" {
Cole Faust9ebf6e42021-12-13 14:08:34 -0800685 fname = baseName + "." + soongConfigAppend
Sasha Smundak65b547e2021-09-17 15:35:41 -0700686 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800687 return []starlarkNode{&exprNode{&callExpr{
Sasha Smundak65b547e2021-09-17 15:35:41 -0700688 name: fname,
Cole Faust9ebf6e42021-12-13 14:08:34 -0800689 args: []starlarkExpr{&globalsExpr{}, &stringLiteralExpr{namespaceName}, &stringLiteralExpr{varName}, val},
Sasha Smundak3deb9682021-07-26 18:42:25 -0700690 returnType: starlarkTypeVoid,
Cole Faustdd569ae2022-01-31 15:48:29 -0800691 }}}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700692 }
693}
694
Cole Faustdd569ae2022-01-31 15:48:29 -0800695func (ctx *parseContext) buildConcatExpr(a *mkparser.Assignment) (*concatExpr, *badExpr) {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800696 xConcat := &concatExpr{}
697 var xItemList *listExpr
698 addToItemList := func(x ...starlarkExpr) {
699 if xItemList == nil {
700 xItemList = &listExpr{[]starlarkExpr{}}
701 }
702 xItemList.items = append(xItemList.items, x...)
703 }
704 finishItemList := func() {
705 if xItemList != nil {
706 xConcat.items = append(xConcat.items, xItemList)
707 xItemList = nil
708 }
709 }
710
711 items := a.Value.Words()
712 for _, item := range items {
713 // A function call in RHS is supposed to return a list, all other item
714 // expressions return individual elements.
715 switch x := ctx.parseMakeString(a, item).(type) {
716 case *badExpr:
Cole Faustdd569ae2022-01-31 15:48:29 -0800717 return nil, x
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800718 case *stringLiteralExpr:
719 addToItemList(maybeConvertToStringList(x).(*listExpr).items...)
720 default:
721 switch x.typ() {
722 case starlarkTypeList:
723 finishItemList()
724 xConcat.items = append(xConcat.items, x)
725 case starlarkTypeString:
726 finishItemList()
727 xConcat.items = append(xConcat.items, &callExpr{
728 object: x,
729 name: "split",
730 args: nil,
731 returnType: starlarkTypeList,
732 })
733 default:
734 addToItemList(x)
735 }
736 }
737 }
738 if xItemList != nil {
739 xConcat.items = append(xConcat.items, xItemList)
740 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800741 return xConcat, nil
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800742}
743
Sasha Smundak6609ba72021-07-22 18:32:56 -0700744func (ctx *parseContext) newDependentModule(path string, optional bool) *moduleInfo {
745 modulePath := ctx.loadedModulePath(path)
746 if mi, ok := ctx.dependentModules[modulePath]; ok {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700747 mi.optional = mi.optional && optional
Sasha Smundak6609ba72021-07-22 18:32:56 -0700748 return mi
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800749 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800750 moduleName := moduleNameForFile(path)
751 moduleLocalName := "_" + moduleName
752 n, found := ctx.moduleNameCount[moduleName]
753 if found {
754 moduleLocalName += fmt.Sprintf("%d", n)
755 }
756 ctx.moduleNameCount[moduleName] = n + 1
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800757 _, err := fs.Stat(ctx.script.sourceFS, path)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700758 mi := &moduleInfo{
759 path: modulePath,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800760 originalPath: path,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800761 moduleLocalName: moduleLocalName,
Sasha Smundak6609ba72021-07-22 18:32:56 -0700762 optional: optional,
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800763 missing: err != nil,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800764 }
Sasha Smundak6609ba72021-07-22 18:32:56 -0700765 ctx.dependentModules[modulePath] = mi
766 ctx.script.inherited = append(ctx.script.inherited, mi)
767 return mi
768}
769
770func (ctx *parseContext) handleSubConfig(
Cole Faustdd569ae2022-01-31 15:48:29 -0800771 v mkparser.Node, pathExpr starlarkExpr, loadAlways bool, processModule func(inheritedModule) starlarkNode) []starlarkNode {
Sasha Smundak6609ba72021-07-22 18:32:56 -0700772
Cole Faust62e05112022-04-05 17:56:11 -0700773 // Allow seeing $(sort $(wildcard realPathExpr)) or $(wildcard realPathExpr)
774 // because those are functionally the same as not having the sort/wildcard calls.
775 if ce, ok := pathExpr.(*callExpr); ok && ce.name == "rblf.mksort" && len(ce.args) == 1 {
776 if ce2, ok2 := ce.args[0].(*callExpr); ok2 && ce2.name == "rblf.expand_wildcard" && len(ce2.args) == 1 {
777 pathExpr = ce2.args[0]
778 }
779 } else if ce2, ok2 := pathExpr.(*callExpr); ok2 && ce2.name == "rblf.expand_wildcard" && len(ce2.args) == 1 {
780 pathExpr = ce2.args[0]
781 }
782
Sasha Smundak6609ba72021-07-22 18:32:56 -0700783 // In a simple case, the name of a module to inherit/include is known statically.
784 if path, ok := maybeString(pathExpr); ok {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700785 // Note that even if this directive loads a module unconditionally, a module may be
786 // absent without causing any harm if this directive is inside an if/else block.
787 moduleShouldExist := loadAlways && ctx.ifNestLevel == 0
Sasha Smundak6609ba72021-07-22 18:32:56 -0700788 if strings.Contains(path, "*") {
789 if paths, err := fs.Glob(ctx.script.sourceFS, path); err == nil {
Cole Faust62e05112022-04-05 17:56:11 -0700790 sort.Strings(paths)
Cole Faustdd569ae2022-01-31 15:48:29 -0800791 result := make([]starlarkNode, 0)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700792 for _, p := range paths {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700793 mi := ctx.newDependentModule(p, !moduleShouldExist)
Cole Faustdd569ae2022-01-31 15:48:29 -0800794 result = append(result, processModule(inheritedStaticModule{mi, loadAlways}))
Sasha Smundak6609ba72021-07-22 18:32:56 -0700795 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800796 return result
Sasha Smundak6609ba72021-07-22 18:32:56 -0700797 } else {
Cole Faustdd569ae2022-01-31 15:48:29 -0800798 return []starlarkNode{ctx.newBadNode(v, "cannot glob wildcard argument")}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700799 }
800 } else {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700801 mi := ctx.newDependentModule(path, !moduleShouldExist)
Cole Faustdd569ae2022-01-31 15:48:29 -0800802 return []starlarkNode{processModule(inheritedStaticModule{mi, loadAlways})}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700803 }
Sasha Smundak6609ba72021-07-22 18:32:56 -0700804 }
805
806 // If module path references variables (e.g., $(v1)/foo/$(v2)/device-config.mk), find all the paths in the
807 // source tree that may be a match and the corresponding variable values. For instance, if the source tree
808 // contains vendor1/foo/abc/dev.mk and vendor2/foo/def/dev.mk, the first one will be inherited when
809 // (v1, v2) == ('vendor1', 'abc'), and the second one when (v1, v2) == ('vendor2', 'def').
810 // We then emit the code that loads all of them, e.g.:
811 // load("//vendor1/foo/abc:dev.rbc", _dev1_init="init")
812 // load("//vendor2/foo/def/dev.rbc", _dev2_init="init")
813 // And then inherit it as follows:
814 // _e = {
815 // "vendor1/foo/abc/dev.mk": ("vendor1/foo/abc/dev", _dev1_init),
816 // "vendor2/foo/def/dev.mk": ("vendor2/foo/def/dev", _dev_init2) }.get("%s/foo/%s/dev.mk" % (v1, v2))
817 // if _e:
818 // rblf.inherit(handle, _e[0], _e[1])
819 //
820 var matchingPaths []string
821 varPath, ok := pathExpr.(*interpolateExpr)
822 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800823 return []starlarkNode{ctx.newBadNode(v, "inherit-product/include argument is too complex")}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700824 }
825
826 pathPattern := []string{varPath.chunks[0]}
827 for _, chunk := range varPath.chunks[1:] {
828 if chunk != "" {
829 pathPattern = append(pathPattern, chunk)
830 }
831 }
Cole Faust069aba62022-01-26 17:47:33 -0800832 if pathPattern[0] == "" && len(ctx.includeTops) > 0 {
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700833 // If pattern starts from the top. restrict it to the directories where
834 // we know inherit-product uses dynamically calculated path.
835 for _, p := range ctx.includeTops {
836 pathPattern[0] = p
837 matchingPaths = append(matchingPaths, ctx.findMatchingPaths(pathPattern)...)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700838 }
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700839 } else {
840 matchingPaths = ctx.findMatchingPaths(pathPattern)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700841 }
842 // Safeguard against $(call inherit-product,$(PRODUCT_PATH))
Sasha Smundak90be8c52021-08-03 11:06:10 -0700843 const maxMatchingFiles = 150
Sasha Smundak6609ba72021-07-22 18:32:56 -0700844 if len(matchingPaths) > maxMatchingFiles {
Cole Faustdd569ae2022-01-31 15:48:29 -0800845 return []starlarkNode{ctx.newBadNode(v, "there are >%d files matching the pattern, please rewrite it", maxMatchingFiles)}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700846 }
Cole Faust93f8d392022-03-02 13:31:30 -0800847
848 needsWarning := pathPattern[0] == "" && len(ctx.includeTops) == 0
849 res := inheritedDynamicModule{*varPath, []*moduleInfo{}, loadAlways, ctx.errorLocation(v), needsWarning}
850 for _, p := range matchingPaths {
851 // A product configuration files discovered dynamically may attempt to inherit
852 // from another one which does not exist in this source tree. Prevent load errors
853 // by always loading the dynamic files as optional.
854 res.candidateModules = append(res.candidateModules, ctx.newDependentModule(p, true))
Sasha Smundak6609ba72021-07-22 18:32:56 -0700855 }
Cole Faust93f8d392022-03-02 13:31:30 -0800856 return []starlarkNode{processModule(res)}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700857}
858
859func (ctx *parseContext) findMatchingPaths(pattern []string) []string {
Cole Faust9b6111a2022-02-02 15:38:33 -0800860 files := ctx.script.makefileFinder.Find(".")
Sasha Smundak6609ba72021-07-22 18:32:56 -0700861 if len(pattern) == 0 {
862 return files
863 }
864
865 // Create regular expression from the pattern
866 s_regexp := "^" + regexp.QuoteMeta(pattern[0])
867 for _, s := range pattern[1:] {
868 s_regexp += ".*" + regexp.QuoteMeta(s)
869 }
870 s_regexp += "$"
871 rex := regexp.MustCompile(s_regexp)
872
873 // Now match
874 var res []string
875 for _, p := range files {
876 if rex.MatchString(p) {
877 res = append(res, p)
878 }
879 }
880 return res
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800881}
882
Cole Faustf035d402022-03-28 14:02:50 -0700883type inheritProductCallParser struct {
884 loadAlways bool
885}
886
887func (p *inheritProductCallParser) parse(ctx *parseContext, v mkparser.Node, args *mkparser.MakeString) []starlarkNode {
Cole Faust9ebf6e42021-12-13 14:08:34 -0800888 args.TrimLeftSpaces()
889 args.TrimRightSpaces()
890 pathExpr := ctx.parseMakeString(v, args)
891 if _, ok := pathExpr.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800892 return []starlarkNode{ctx.newBadNode(v, "Unable to parse argument to inherit")}
Cole Faust9ebf6e42021-12-13 14:08:34 -0800893 }
Cole Faustf035d402022-03-28 14:02:50 -0700894 return ctx.handleSubConfig(v, pathExpr, p.loadAlways, func(im inheritedModule) starlarkNode {
895 return &inheritNode{im, p.loadAlways}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700896 })
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800897}
898
Cole Faustdd569ae2022-01-31 15:48:29 -0800899func (ctx *parseContext) handleInclude(v mkparser.Node, pathExpr starlarkExpr, loadAlways bool) []starlarkNode {
900 return ctx.handleSubConfig(v, pathExpr, loadAlways, func(im inheritedModule) starlarkNode {
901 return &includeNode{im, loadAlways}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700902 })
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800903}
904
Cole Faustdd569ae2022-01-31 15:48:29 -0800905func (ctx *parseContext) handleVariable(v *mkparser.Variable) []starlarkNode {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800906 // Handle:
907 // $(call inherit-product,...)
908 // $(call inherit-product-if-exists,...)
909 // $(info xxx)
910 // $(warning xxx)
911 // $(error xxx)
Cole Faust9ebf6e42021-12-13 14:08:34 -0800912 // $(call other-custom-functions,...)
913
Cole Faustf035d402022-03-28 14:02:50 -0700914 if name, args, ok := ctx.maybeParseFunctionCall(v, v.Name); ok {
915 if kf, ok := knownNodeFunctions[name]; ok {
916 return kf.parse(ctx, v, args)
917 }
Cole Faust9ebf6e42021-12-13 14:08:34 -0800918 }
Cole Faustf035d402022-03-28 14:02:50 -0700919
Cole Faustdd569ae2022-01-31 15:48:29 -0800920 return []starlarkNode{&exprNode{expr: ctx.parseReference(v, v.Name)}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800921}
922
Cole Faustdd569ae2022-01-31 15:48:29 -0800923func (ctx *parseContext) maybeHandleDefine(directive *mkparser.Directive) starlarkNode {
Sasha Smundakf3e072a2021-07-14 12:50:28 -0700924 macro_name := strings.Fields(directive.Args.Strings[0])[0]
925 // Ignore the macros that we handle
Cole Faust9ebf6e42021-12-13 14:08:34 -0800926 _, ignored := ignoredDefines[macro_name]
927 _, known := knownFunctions[macro_name]
928 if !ignored && !known {
Cole Faustdd569ae2022-01-31 15:48:29 -0800929 return ctx.newBadNode(directive, "define is not supported: %s", macro_name)
Sasha Smundakf3e072a2021-07-14 12:50:28 -0700930 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800931 return nil
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800932}
933
Cole Faustdd569ae2022-01-31 15:48:29 -0800934func (ctx *parseContext) handleIfBlock(ifDirective *mkparser.Directive) starlarkNode {
935 ssSwitch := &switchNode{
936 ssCases: []*switchCase{ctx.processBranch(ifDirective)},
937 }
938 for ctx.hasNodes() && ctx.fatalError == nil {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800939 node := ctx.getNode()
940 switch x := node.(type) {
941 case *mkparser.Directive:
942 switch x.Name {
943 case "else", "elifdef", "elifndef", "elifeq", "elifneq":
Cole Faustdd569ae2022-01-31 15:48:29 -0800944 ssSwitch.ssCases = append(ssSwitch.ssCases, ctx.processBranch(x))
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800945 case "endif":
Cole Faustdd569ae2022-01-31 15:48:29 -0800946 return ssSwitch
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800947 default:
Cole Faustdd569ae2022-01-31 15:48:29 -0800948 return ctx.newBadNode(node, "unexpected directive %s", x.Name)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800949 }
950 default:
Cole Faustdd569ae2022-01-31 15:48:29 -0800951 return ctx.newBadNode(ifDirective, "unexpected statement")
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800952 }
953 }
954 if ctx.fatalError == nil {
955 ctx.fatalError = fmt.Errorf("no matching endif for %s", ifDirective.Dump())
956 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800957 return ctx.newBadNode(ifDirective, "no matching endif for %s", ifDirective.Dump())
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800958}
959
960// processBranch processes a single branch (if/elseif/else) until the next directive
961// on the same level.
Cole Faustdd569ae2022-01-31 15:48:29 -0800962func (ctx *parseContext) processBranch(check *mkparser.Directive) *switchCase {
963 block := &switchCase{gate: ctx.parseCondition(check)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800964 defer func() {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800965 ctx.ifNestLevel--
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800966 }()
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800967 ctx.ifNestLevel++
968
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800969 for ctx.hasNodes() {
970 node := ctx.getNode()
Cole Faust591a1fe2021-11-08 15:37:57 -0800971 if d, ok := node.(*mkparser.Directive); ok {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800972 switch d.Name {
973 case "else", "elifdef", "elifndef", "elifeq", "elifneq", "endif":
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800974 ctx.backNode()
Cole Faustdd569ae2022-01-31 15:48:29 -0800975 return block
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800976 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800977 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800978 block.nodes = append(block.nodes, ctx.handleSimpleStatement(node)...)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800979 }
980 ctx.fatalError = fmt.Errorf("no matching endif for %s", check.Dump())
Cole Faustdd569ae2022-01-31 15:48:29 -0800981 return block
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800982}
983
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800984func (ctx *parseContext) parseCondition(check *mkparser.Directive) starlarkNode {
985 switch check.Name {
986 case "ifdef", "ifndef", "elifdef", "elifndef":
Cole Faust71514c02022-01-27 17:21:41 -0800987 if !check.Args.Const() {
Cole Faustdd569ae2022-01-31 15:48:29 -0800988 return ctx.newBadNode(check, "ifdef variable ref too complex: %s", check.Args.Dump())
Cole Faust71514c02022-01-27 17:21:41 -0800989 }
Cole Faustf0632662022-04-07 13:59:24 -0700990 v := NewVariableRefExpr(ctx.addVariable(check.Args.Strings[0]))
Cole Faust71514c02022-01-27 17:21:41 -0800991 if strings.HasSuffix(check.Name, "ndef") {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800992 v = &notExpr{v}
993 }
994 return &ifNode{
995 isElif: strings.HasPrefix(check.Name, "elif"),
996 expr: v,
997 }
998 case "ifeq", "ifneq", "elifeq", "elifneq":
999 return &ifNode{
1000 isElif: strings.HasPrefix(check.Name, "elif"),
1001 expr: ctx.parseCompare(check),
1002 }
1003 case "else":
1004 return &elseNode{}
1005 default:
1006 panic(fmt.Errorf("%s: unknown directive: %s", ctx.script.mkFile, check.Dump()))
1007 }
1008}
1009
1010func (ctx *parseContext) newBadExpr(node mkparser.Node, text string, args ...interface{}) starlarkExpr {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001011 if ctx.errorLogger != nil {
Sasha Smundak422b6142021-11-11 18:31:59 -08001012 ctx.errorLogger.NewError(ctx.errorLocation(node), node, text, args...)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001013 }
1014 ctx.script.hasErrors = true
Cole Faustdd569ae2022-01-31 15:48:29 -08001015 return &badExpr{errorLocation: ctx.errorLocation(node), message: fmt.Sprintf(text, args...)}
1016}
1017
1018// records that the given node failed to be converted and includes an explanatory message
1019func (ctx *parseContext) newBadNode(failedNode mkparser.Node, message string, args ...interface{}) starlarkNode {
1020 return &exprNode{ctx.newBadExpr(failedNode, message, args...)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001021}
1022
1023func (ctx *parseContext) parseCompare(cond *mkparser.Directive) starlarkExpr {
1024 // Strip outer parentheses
1025 mkArg := cloneMakeString(cond.Args)
1026 mkArg.Strings[0] = strings.TrimLeft(mkArg.Strings[0], "( ")
1027 n := len(mkArg.Strings)
1028 mkArg.Strings[n-1] = strings.TrimRight(mkArg.Strings[n-1], ") ")
1029 args := mkArg.Split(",")
1030 // TODO(asmundak): handle the case where the arguments are in quotes and space-separated
1031 if len(args) != 2 {
1032 return ctx.newBadExpr(cond, "ifeq/ifneq len(args) != 2 %s", cond.Dump())
1033 }
1034 args[0].TrimRightSpaces()
1035 args[1].TrimLeftSpaces()
1036
1037 isEq := !strings.HasSuffix(cond.Name, "neq")
Cole Faustf8320212021-11-10 15:05:07 -08001038 xLeft := ctx.parseMakeString(cond, args[0])
1039 xRight := ctx.parseMakeString(cond, args[1])
1040 if bad, ok := xLeft.(*badExpr); ok {
1041 return bad
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001042 }
Cole Faustf8320212021-11-10 15:05:07 -08001043 if bad, ok := xRight.(*badExpr); ok {
1044 return bad
1045 }
1046
1047 if expr, ok := ctx.parseCompareSpecialCases(cond, xLeft, xRight); ok {
1048 return expr
1049 }
1050
Cole Faust9ebf6e42021-12-13 14:08:34 -08001051 var stringOperand string
1052 var otherOperand starlarkExpr
1053 if s, ok := maybeString(xLeft); ok {
1054 stringOperand = s
1055 otherOperand = xRight
1056 } else if s, ok := maybeString(xRight); ok {
1057 stringOperand = s
1058 otherOperand = xLeft
1059 }
1060
Cole Faust9ebf6e42021-12-13 14:08:34 -08001061 // If we've identified one of the operands as being a string literal, check
1062 // for some special cases we can do to simplify the resulting expression.
1063 if otherOperand != nil {
1064 if stringOperand == "" {
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 }
1071 if stringOperand == "true" && otherOperand.typ() == starlarkTypeBool {
1072 if !isEq {
Cole Faustf035d402022-03-28 14:02:50 -07001073 return negateExpr(otherOperand)
Cole Faust9ebf6e42021-12-13 14:08:34 -08001074 } else {
1075 return otherOperand
1076 }
1077 }
Cole Faustb1103e22022-01-06 15:22:05 -08001078 if intOperand, err := strconv.Atoi(strings.TrimSpace(stringOperand)); err == nil && otherOperand.typ() == starlarkTypeInt {
1079 return &eqExpr{
1080 left: otherOperand,
1081 right: &intLiteralExpr{literal: intOperand},
1082 isEq: isEq,
1083 }
1084 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001085 }
1086
Cole Faustf8320212021-11-10 15:05:07 -08001087 return &eqExpr{left: xLeft, right: xRight, isEq: isEq}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001088}
1089
Cole Faustf8320212021-11-10 15:05:07 -08001090// Given an if statement's directive and the left/right starlarkExprs,
1091// check if the starlarkExprs are one of a few hardcoded special cases
Cole Faust9932f752022-02-08 11:56:25 -08001092// that can be converted to a simpler equality expression than simply comparing
Cole Faustf8320212021-11-10 15:05:07 -08001093// the two.
1094func (ctx *parseContext) parseCompareSpecialCases(directive *mkparser.Directive, left starlarkExpr,
1095 right starlarkExpr) (starlarkExpr, bool) {
1096 isEq := !strings.HasSuffix(directive.Name, "neq")
1097
1098 // All the special cases require a call on one side and a
1099 // string literal/variable on the other. Turn the left/right variables into
1100 // call/value variables, and return false if that's not possible.
1101 var value starlarkExpr = nil
1102 call, ok := left.(*callExpr)
1103 if ok {
1104 switch right.(type) {
1105 case *stringLiteralExpr, *variableRefExpr:
1106 value = right
1107 }
1108 } else {
1109 call, _ = right.(*callExpr)
1110 switch left.(type) {
1111 case *stringLiteralExpr, *variableRefExpr:
1112 value = left
1113 }
1114 }
1115
1116 if call == nil || value == nil {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001117 return nil, false
1118 }
Cole Faustf8320212021-11-10 15:05:07 -08001119
Cole Faustf8320212021-11-10 15:05:07 -08001120 switch call.name {
Cole Faust9932f752022-02-08 11:56:25 -08001121 case baseName + ".filter":
1122 return ctx.parseCompareFilterFuncResult(directive, call, value, isEq)
Cole Faust9ebf6e42021-12-13 14:08:34 -08001123 case baseName + ".expand_wildcard":
Cole Faustf8320212021-11-10 15:05:07 -08001124 return ctx.parseCompareWildcardFuncResult(directive, call, value, !isEq), true
Cole Faust9ebf6e42021-12-13 14:08:34 -08001125 case baseName + ".findstring":
Cole Faustf8320212021-11-10 15:05:07 -08001126 return ctx.parseCheckFindstringFuncResult(directive, call, value, !isEq), true
Cole Faust9ebf6e42021-12-13 14:08:34 -08001127 case baseName + ".strip":
Cole Faustf8320212021-11-10 15:05:07 -08001128 return ctx.parseCompareStripFuncResult(directive, call, value, !isEq), true
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001129 }
Cole Faustf8320212021-11-10 15:05:07 -08001130 return nil, false
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001131}
1132
1133func (ctx *parseContext) parseCompareFilterFuncResult(cond *mkparser.Directive,
Cole Faust9932f752022-02-08 11:56:25 -08001134 filterFuncCall *callExpr, xValue starlarkExpr, negate bool) (starlarkExpr, bool) {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001135 // We handle:
Sasha Smundak0554d762021-07-08 18:26:12 -07001136 // * ifeq/ifneq (,$(filter v1 v2 ..., EXPR) becomes if EXPR not in/in ["v1", "v2", ...]
1137 // * ifeq/ifneq (,$(filter EXPR, v1 v2 ...) becomes if EXPR not in/in ["v1", "v2", ...]
Cole Faust9932f752022-02-08 11:56:25 -08001138 if x, ok := xValue.(*stringLiteralExpr); !ok || x.literal != "" {
1139 return nil, false
1140 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001141 xPattern := filterFuncCall.args[0]
1142 xText := filterFuncCall.args[1]
1143 var xInList *stringLiteralExpr
Sasha Smundak0554d762021-07-08 18:26:12 -07001144 var expr starlarkExpr
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001145 var ok bool
Cole Faust9932f752022-02-08 11:56:25 -08001146 if xInList, ok = xPattern.(*stringLiteralExpr); ok && !strings.ContainsRune(xInList.literal, '%') && xText.typ() == starlarkTypeList {
1147 expr = xText
1148 } else if xInList, ok = xText.(*stringLiteralExpr); ok {
1149 expr = xPattern
1150 } else {
1151 return nil, false
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001152 }
Cole Faust9932f752022-02-08 11:56:25 -08001153 slExpr := newStringListExpr(strings.Fields(xInList.literal))
1154 // Generate simpler code for the common cases:
1155 if expr.typ() == starlarkTypeList {
1156 if len(slExpr.items) == 1 {
1157 // Checking that a string belongs to list
1158 return &inExpr{isNot: negate, list: expr, expr: slExpr.items[0]}, true
Sasha Smundak0554d762021-07-08 18:26:12 -07001159 } else {
Cole Faust9932f752022-02-08 11:56:25 -08001160 return nil, false
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001161 }
Cole Faust9932f752022-02-08 11:56:25 -08001162 } else if len(slExpr.items) == 1 {
1163 return &eqExpr{left: expr, right: slExpr.items[0], isEq: !negate}, true
1164 } else {
1165 return &inExpr{isNot: negate, list: newStringListExpr(strings.Fields(xInList.literal)), expr: expr}, true
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001166 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001167}
1168
1169func (ctx *parseContext) parseCompareWildcardFuncResult(directive *mkparser.Directive,
1170 xCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
Sasha Smundak0554d762021-07-08 18:26:12 -07001171 if !isEmptyString(xValue) {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001172 return ctx.newBadExpr(directive, "wildcard result can be compared only to empty: %s", xValue)
1173 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001174 callFunc := baseName + ".file_wildcard_exists"
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001175 if s, ok := xCall.args[0].(*stringLiteralExpr); ok && !strings.ContainsAny(s.literal, "*?{[") {
Cole Faust9ebf6e42021-12-13 14:08:34 -08001176 callFunc = baseName + ".file_exists"
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001177 }
1178 var cc starlarkExpr = &callExpr{name: callFunc, args: xCall.args, returnType: starlarkTypeBool}
1179 if !negate {
1180 cc = &notExpr{cc}
1181 }
1182 return cc
1183}
1184
1185func (ctx *parseContext) parseCheckFindstringFuncResult(directive *mkparser.Directive,
1186 xCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
Sasha Smundak0554d762021-07-08 18:26:12 -07001187 if isEmptyString(xValue) {
1188 return &eqExpr{
1189 left: &callExpr{
1190 object: xCall.args[1],
1191 name: "find",
1192 args: []starlarkExpr{xCall.args[0]},
1193 returnType: starlarkTypeInt,
1194 },
1195 right: &intLiteralExpr{-1},
1196 isEq: !negate,
1197 }
Cole Faust0e9418c2021-12-13 16:33:25 -08001198 } else if s, ok := maybeString(xValue); ok {
1199 if s2, ok := maybeString(xCall.args[0]); ok && s == s2 {
1200 return &eqExpr{
1201 left: &callExpr{
1202 object: xCall.args[1],
1203 name: "find",
1204 args: []starlarkExpr{xCall.args[0]},
1205 returnType: starlarkTypeInt,
1206 },
1207 right: &intLiteralExpr{-1},
1208 isEq: negate,
1209 }
1210 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001211 }
Cole Faust0e9418c2021-12-13 16:33:25 -08001212 return ctx.newBadExpr(directive, "$(findstring) can only be compared to nothing or its first argument")
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001213}
1214
1215func (ctx *parseContext) parseCompareStripFuncResult(directive *mkparser.Directive,
1216 xCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
1217 if _, ok := xValue.(*stringLiteralExpr); !ok {
1218 return ctx.newBadExpr(directive, "strip result can be compared only to string: %s", xValue)
1219 }
1220 return &eqExpr{
1221 left: &callExpr{
1222 name: "strip",
1223 args: xCall.args,
1224 returnType: starlarkTypeString,
1225 },
1226 right: xValue, isEq: !negate}
1227}
1228
Cole Faustf035d402022-03-28 14:02:50 -07001229func (ctx *parseContext) maybeParseFunctionCall(node mkparser.Node, ref *mkparser.MakeString) (name string, args *mkparser.MakeString, ok bool) {
1230 ref.TrimLeftSpaces()
1231 ref.TrimRightSpaces()
1232
1233 words := ref.SplitN(" ", 2)
1234 if !words[0].Const() {
1235 return "", nil, false
1236 }
1237
1238 name = words[0].Dump()
1239 args = mkparser.SimpleMakeString("", words[0].Pos())
1240 if len(words) >= 2 {
1241 args = words[1]
1242 }
1243 args.TrimLeftSpaces()
1244 if name == "call" {
1245 words = args.SplitN(",", 2)
1246 if words[0].Empty() || !words[0].Const() {
1247 return "", nil, false
1248 }
1249 name = words[0].Dump()
1250 if len(words) < 2 {
Cole Faust6c41b8a2022-04-13 13:53:48 -07001251 args = mkparser.SimpleMakeString("", words[0].Pos())
Cole Faustf035d402022-03-28 14:02:50 -07001252 } else {
1253 args = words[1]
1254 }
1255 }
1256 ok = true
1257 return
1258}
1259
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001260// parses $(...), returning an expression
1261func (ctx *parseContext) parseReference(node mkparser.Node, ref *mkparser.MakeString) starlarkExpr {
1262 ref.TrimLeftSpaces()
1263 ref.TrimRightSpaces()
1264 refDump := ref.Dump()
1265
1266 // Handle only the case where the first (or only) word is constant
1267 words := ref.SplitN(" ", 2)
1268 if !words[0].Const() {
1269 return ctx.newBadExpr(node, "reference is too complex: %s", refDump)
1270 }
1271
1272 // If it is a single word, it can be a simple variable
1273 // reference or a function call
Cole Faustf035d402022-03-28 14:02:50 -07001274 if len(words) == 1 && !isMakeControlFunc(refDump) && refDump != "shell" && refDump != "eval" {
Sasha Smundak65b547e2021-09-17 15:35:41 -07001275 if strings.HasPrefix(refDump, soongNsPrefix) {
1276 // TODO (asmundak): if we find many, maybe handle them.
Cole Faustc00184e2021-11-08 12:08:57 -08001277 return ctx.newBadExpr(node, "SOONG_CONFIG_ variables cannot be referenced, use soong_config_get instead: %s", refDump)
Sasha Smundak65b547e2021-09-17 15:35:41 -07001278 }
Cole Faustc36c9622021-12-07 15:20:45 -08001279 // Handle substitution references: https://www.gnu.org/software/make/manual/html_node/Substitution-Refs.html
1280 if strings.Contains(refDump, ":") {
1281 parts := strings.SplitN(refDump, ":", 2)
1282 substParts := strings.SplitN(parts[1], "=", 2)
1283 if len(substParts) < 2 || strings.Count(substParts[0], "%") > 1 {
1284 return ctx.newBadExpr(node, "Invalid substitution reference")
1285 }
1286 if !strings.Contains(substParts[0], "%") {
1287 if strings.Contains(substParts[1], "%") {
1288 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.")
1289 }
1290 substParts[0] = "%" + substParts[0]
1291 substParts[1] = "%" + substParts[1]
1292 }
1293 v := ctx.addVariable(parts[0])
1294 if v == nil {
1295 return ctx.newBadExpr(node, "unknown variable %s", refDump)
1296 }
1297 return &callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -08001298 name: baseName + ".mkpatsubst",
1299 returnType: starlarkTypeString,
Cole Faustc36c9622021-12-07 15:20:45 -08001300 args: []starlarkExpr{
1301 &stringLiteralExpr{literal: substParts[0]},
1302 &stringLiteralExpr{literal: substParts[1]},
Cole Faustf0632662022-04-07 13:59:24 -07001303 NewVariableRefExpr(v),
Cole Faustc36c9622021-12-07 15:20:45 -08001304 },
1305 }
1306 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001307 if v := ctx.addVariable(refDump); v != nil {
Cole Faustf0632662022-04-07 13:59:24 -07001308 return NewVariableRefExpr(v)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001309 }
1310 return ctx.newBadExpr(node, "unknown variable %s", refDump)
1311 }
1312
Cole Faustf035d402022-03-28 14:02:50 -07001313 if name, args, ok := ctx.maybeParseFunctionCall(node, ref); ok {
1314 if kf, found := knownFunctions[name]; found {
1315 return kf.parse(ctx, node, args)
Sasha Smundak6609ba72021-07-22 18:32:56 -07001316 } else {
Cole Faustf035d402022-03-28 14:02:50 -07001317 return ctx.newBadExpr(node, "cannot handle invoking %s", name)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001318 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001319 } else {
Cole Faustf035d402022-03-28 14:02:50 -07001320 return ctx.newBadExpr(node, "cannot handle %s", refDump)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001321 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001322}
1323
1324type simpleCallParser struct {
1325 name string
1326 returnType starlarkType
1327 addGlobals bool
Cole Faust1cc08852022-02-28 11:12:08 -08001328 addHandle bool
Cole Faust9ebf6e42021-12-13 14:08:34 -08001329}
1330
1331func (p *simpleCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1332 expr := &callExpr{name: p.name, returnType: p.returnType}
1333 if p.addGlobals {
1334 expr.args = append(expr.args, &globalsExpr{})
1335 }
Cole Faust1cc08852022-02-28 11:12:08 -08001336 if p.addHandle {
1337 expr.args = append(expr.args, &identifierExpr{name: "handle"})
1338 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001339 for _, arg := range args.Split(",") {
1340 arg.TrimLeftSpaces()
1341 arg.TrimRightSpaces()
1342 x := ctx.parseMakeString(node, arg)
1343 if xBad, ok := x.(*badExpr); ok {
1344 return xBad
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001345 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001346 expr.args = append(expr.args, x)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001347 }
1348 return expr
1349}
1350
Cole Faust9ebf6e42021-12-13 14:08:34 -08001351type makeControlFuncParser struct {
1352 name string
1353}
1354
1355func (p *makeControlFuncParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1356 // Make control functions need special treatment as everything
1357 // after the name is a single text argument
1358 x := ctx.parseMakeString(node, args)
1359 if xBad, ok := x.(*badExpr); ok {
1360 return xBad
1361 }
1362 return &callExpr{
1363 name: p.name,
1364 args: []starlarkExpr{
1365 &stringLiteralExpr{ctx.script.mkFile},
1366 x,
1367 },
1368 returnType: starlarkTypeUnknown,
1369 }
1370}
1371
1372type shellCallParser struct{}
1373
1374func (p *shellCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1375 // Shell functions need special treatment as everything
1376 // after the name is a single text argument
1377 x := ctx.parseMakeString(node, args)
1378 if xBad, ok := x.(*badExpr); ok {
1379 return xBad
1380 }
1381 return &callExpr{
1382 name: baseName + ".shell",
1383 args: []starlarkExpr{x},
1384 returnType: starlarkTypeUnknown,
1385 }
1386}
1387
1388type myDirCallParser struct{}
1389
1390func (p *myDirCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1391 if !args.Empty() {
1392 return ctx.newBadExpr(node, "my-dir function cannot have any arguments passed to it.")
1393 }
Cole Faustf5adedc2022-03-18 14:05:06 -07001394 return &stringLiteralExpr{literal: filepath.Dir(ctx.script.mkFile)}
Cole Faust9ebf6e42021-12-13 14:08:34 -08001395}
1396
Cole Faust9ebf6e42021-12-13 14:08:34 -08001397type isProductInListCallParser struct{}
1398
1399func (p *isProductInListCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1400 if args.Empty() {
1401 return ctx.newBadExpr(node, "is-product-in-list requires an argument")
1402 }
1403 return &inExpr{
Cole Faustf0632662022-04-07 13:59:24 -07001404 expr: NewVariableRefExpr(ctx.addVariable("TARGET_PRODUCT")),
Cole Faust9ebf6e42021-12-13 14:08:34 -08001405 list: maybeConvertToStringList(ctx.parseMakeString(node, args)),
1406 isNot: false,
1407 }
1408}
1409
1410type isVendorBoardPlatformCallParser struct{}
1411
1412func (p *isVendorBoardPlatformCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1413 if args.Empty() || !identifierFullMatchRegex.MatchString(args.Dump()) {
1414 return ctx.newBadExpr(node, "cannot handle non-constant argument to is-vendor-board-platform")
1415 }
1416 return &inExpr{
Cole Faustf0632662022-04-07 13:59:24 -07001417 expr: NewVariableRefExpr(ctx.addVariable("TARGET_BOARD_PLATFORM")),
1418 list: NewVariableRefExpr(ctx.addVariable(args.Dump() + "_BOARD_PLATFORMS")),
Cole Faust9ebf6e42021-12-13 14:08:34 -08001419 isNot: false,
1420 }
1421}
1422
1423type isVendorBoardQcomCallParser struct{}
1424
1425func (p *isVendorBoardQcomCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1426 if !args.Empty() {
1427 return ctx.newBadExpr(node, "is-vendor-board-qcom does not accept any arguments")
1428 }
1429 return &inExpr{
Cole Faustf0632662022-04-07 13:59:24 -07001430 expr: NewVariableRefExpr(ctx.addVariable("TARGET_BOARD_PLATFORM")),
1431 list: NewVariableRefExpr(ctx.addVariable("QCOM_BOARD_PLATFORMS")),
Cole Faust9ebf6e42021-12-13 14:08:34 -08001432 isNot: false,
1433 }
1434}
1435
1436type substCallParser struct {
1437 fname string
1438}
1439
1440func (p *substCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001441 words := args.Split(",")
1442 if len(words) != 3 {
Cole Faust9ebf6e42021-12-13 14:08:34 -08001443 return ctx.newBadExpr(node, "%s function should have 3 arguments", p.fname)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001444 }
Sasha Smundak35434ed2021-11-05 16:29:56 -07001445 from := ctx.parseMakeString(node, words[0])
1446 if xBad, ok := from.(*badExpr); ok {
1447 return xBad
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001448 }
Sasha Smundak35434ed2021-11-05 16:29:56 -07001449 to := ctx.parseMakeString(node, words[1])
1450 if xBad, ok := to.(*badExpr); ok {
1451 return xBad
1452 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001453 words[2].TrimLeftSpaces()
1454 words[2].TrimRightSpaces()
1455 obj := ctx.parseMakeString(node, words[2])
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001456 typ := obj.typ()
Cole Faust9ebf6e42021-12-13 14:08:34 -08001457 if typ == starlarkTypeString && p.fname == "subst" {
Sasha Smundak94b41c72021-07-12 18:30:42 -07001458 // Optimization: if it's $(subst from, to, string), emit string.replace(from, to)
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001459 return &callExpr{
1460 object: obj,
1461 name: "replace",
Sasha Smundak35434ed2021-11-05 16:29:56 -07001462 args: []starlarkExpr{from, to},
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001463 returnType: typ,
1464 }
1465 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001466 return &callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -08001467 name: baseName + ".mk" + p.fname,
Sasha Smundak35434ed2021-11-05 16:29:56 -07001468 args: []starlarkExpr{from, to, obj},
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001469 returnType: obj.typ(),
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001470 }
1471}
1472
Cole Faust9ebf6e42021-12-13 14:08:34 -08001473type ifCallParser struct{}
1474
1475func (p *ifCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Cole Faust4eadba72021-12-07 11:54:52 -08001476 words := args.Split(",")
1477 if len(words) != 2 && len(words) != 3 {
1478 return ctx.newBadExpr(node, "if function should have 2 or 3 arguments, found "+strconv.Itoa(len(words)))
1479 }
1480 condition := ctx.parseMakeString(node, words[0])
1481 ifTrue := ctx.parseMakeString(node, words[1])
1482 var ifFalse starlarkExpr
1483 if len(words) == 3 {
1484 ifFalse = ctx.parseMakeString(node, words[2])
1485 } else {
1486 switch ifTrue.typ() {
1487 case starlarkTypeList:
1488 ifFalse = &listExpr{items: []starlarkExpr{}}
1489 case starlarkTypeInt:
1490 ifFalse = &intLiteralExpr{literal: 0}
1491 case starlarkTypeBool:
1492 ifFalse = &boolLiteralExpr{literal: false}
1493 default:
1494 ifFalse = &stringLiteralExpr{literal: ""}
1495 }
1496 }
1497 return &ifExpr{
1498 condition,
1499 ifTrue,
1500 ifFalse,
1501 }
1502}
1503
Cole Faustf035d402022-03-28 14:02:50 -07001504type ifCallNodeParser struct{}
Cole Faust9ebf6e42021-12-13 14:08:34 -08001505
Cole Faustf035d402022-03-28 14:02:50 -07001506func (p *ifCallNodeParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) []starlarkNode {
1507 words := args.Split(",")
1508 if len(words) != 2 && len(words) != 3 {
1509 return []starlarkNode{ctx.newBadNode(node, "if function should have 2 or 3 arguments, found "+strconv.Itoa(len(words)))}
1510 }
1511
1512 ifn := &ifNode{expr: ctx.parseMakeString(node, words[0])}
1513 cases := []*switchCase{
1514 {
1515 gate: ifn,
1516 nodes: ctx.parseNodeMakeString(node, words[1]),
1517 },
1518 }
1519 if len(words) == 3 {
1520 cases = append(cases, &switchCase{
1521 gate: &elseNode{},
1522 nodes: ctx.parseNodeMakeString(node, words[2]),
1523 })
1524 }
1525 if len(cases) == 2 {
1526 if len(cases[1].nodes) == 0 {
1527 // Remove else branch if it has no contents
1528 cases = cases[:1]
1529 } else if len(cases[0].nodes) == 0 {
1530 // If the if branch has no contents but the else does,
1531 // move them to the if and negate its condition
1532 ifn.expr = negateExpr(ifn.expr)
1533 cases[0].nodes = cases[1].nodes
1534 cases = cases[:1]
1535 }
1536 }
1537
1538 return []starlarkNode{&switchNode{ssCases: cases}}
1539}
1540
1541type foreachCallParser struct{}
1542
1543func (p *foreachCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Cole Faustb0d32ab2021-12-09 14:00:59 -08001544 words := args.Split(",")
1545 if len(words) != 3 {
1546 return ctx.newBadExpr(node, "foreach function should have 3 arguments, found "+strconv.Itoa(len(words)))
1547 }
1548 if !words[0].Const() || words[0].Empty() || !identifierFullMatchRegex.MatchString(words[0].Strings[0]) {
1549 return ctx.newBadExpr(node, "first argument to foreach function must be a simple string identifier")
1550 }
1551 loopVarName := words[0].Strings[0]
1552 list := ctx.parseMakeString(node, words[1])
1553 action := ctx.parseMakeString(node, words[2]).transform(func(expr starlarkExpr) starlarkExpr {
1554 if varRefExpr, ok := expr.(*variableRefExpr); ok && varRefExpr.ref.name() == loopVarName {
1555 return &identifierExpr{loopVarName}
1556 }
1557 return nil
1558 })
1559
1560 if list.typ() != starlarkTypeList {
1561 list = &callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -08001562 name: baseName + ".words",
1563 returnType: starlarkTypeList,
Cole Faustb0d32ab2021-12-09 14:00:59 -08001564 args: []starlarkExpr{list},
1565 }
1566 }
1567
1568 return &foreachExpr{
1569 varName: loopVarName,
1570 list: list,
1571 action: action,
1572 }
1573}
1574
Cole Faustf035d402022-03-28 14:02:50 -07001575func transformNode(node starlarkNode, transformer func(expr starlarkExpr) starlarkExpr) {
1576 switch a := node.(type) {
1577 case *ifNode:
1578 a.expr = a.expr.transform(transformer)
1579 case *switchCase:
1580 transformNode(a.gate, transformer)
1581 for _, n := range a.nodes {
1582 transformNode(n, transformer)
1583 }
1584 case *switchNode:
1585 for _, n := range a.ssCases {
1586 transformNode(n, transformer)
1587 }
1588 case *exprNode:
1589 a.expr = a.expr.transform(transformer)
1590 case *assignmentNode:
1591 a.value = a.value.transform(transformer)
1592 case *foreachNode:
1593 a.list = a.list.transform(transformer)
1594 for _, n := range a.actions {
1595 transformNode(n, transformer)
1596 }
1597 }
1598}
1599
1600type foreachCallNodeParser struct{}
1601
1602func (p *foreachCallNodeParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) []starlarkNode {
1603 words := args.Split(",")
1604 if len(words) != 3 {
1605 return []starlarkNode{ctx.newBadNode(node, "foreach function should have 3 arguments, found "+strconv.Itoa(len(words)))}
1606 }
1607 if !words[0].Const() || words[0].Empty() || !identifierFullMatchRegex.MatchString(words[0].Strings[0]) {
1608 return []starlarkNode{ctx.newBadNode(node, "first argument to foreach function must be a simple string identifier")}
1609 }
1610
1611 loopVarName := words[0].Strings[0]
1612
1613 list := ctx.parseMakeString(node, words[1])
1614 if list.typ() != starlarkTypeList {
1615 list = &callExpr{
1616 name: baseName + ".words",
1617 returnType: starlarkTypeList,
1618 args: []starlarkExpr{list},
1619 }
1620 }
1621
1622 actions := ctx.parseNodeMakeString(node, words[2])
1623 // TODO(colefaust): Replace transforming code with something more elegant
1624 for _, action := range actions {
1625 transformNode(action, func(expr starlarkExpr) starlarkExpr {
1626 if varRefExpr, ok := expr.(*variableRefExpr); ok && varRefExpr.ref.name() == loopVarName {
1627 return &identifierExpr{loopVarName}
1628 }
1629 return nil
1630 })
1631 }
1632
1633 return []starlarkNode{&foreachNode{
1634 varName: loopVarName,
1635 list: list,
1636 actions: actions,
1637 }}
1638}
1639
Cole Faust9ebf6e42021-12-13 14:08:34 -08001640type wordCallParser struct{}
1641
1642func (p *wordCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001643 words := args.Split(",")
1644 if len(words) != 2 {
1645 return ctx.newBadExpr(node, "word function should have 2 arguments")
1646 }
1647 var index uint64 = 0
1648 if words[0].Const() {
1649 index, _ = strconv.ParseUint(strings.TrimSpace(words[0].Strings[0]), 10, 64)
1650 }
1651 if index < 1 {
1652 return ctx.newBadExpr(node, "word index should be constant positive integer")
1653 }
1654 words[1].TrimLeftSpaces()
1655 words[1].TrimRightSpaces()
1656 array := ctx.parseMakeString(node, words[1])
1657 if xBad, ok := array.(*badExpr); ok {
1658 return xBad
1659 }
1660 if array.typ() != starlarkTypeList {
1661 array = &callExpr{object: array, name: "split", returnType: starlarkTypeList}
1662 }
Cole Faustb0d32ab2021-12-09 14:00:59 -08001663 return &indexExpr{array, &intLiteralExpr{int(index - 1)}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001664}
1665
Cole Faustb1103e22022-01-06 15:22:05 -08001666func parseIntegerArguments(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString, expectedArgs int) ([]starlarkExpr, error) {
1667 parsedArgs := make([]starlarkExpr, 0)
1668 for _, arg := range args.Split(",") {
1669 expr := ctx.parseMakeString(node, arg)
1670 if expr.typ() == starlarkTypeList {
1671 return nil, fmt.Errorf("argument to math argument has type list, which cannot be converted to int")
1672 }
1673 if s, ok := maybeString(expr); ok {
1674 intVal, err := strconv.Atoi(strings.TrimSpace(s))
1675 if err != nil {
1676 return nil, err
1677 }
1678 expr = &intLiteralExpr{literal: intVal}
1679 } else if expr.typ() != starlarkTypeInt {
1680 expr = &callExpr{
1681 name: "int",
1682 args: []starlarkExpr{expr},
1683 returnType: starlarkTypeInt,
1684 }
1685 }
1686 parsedArgs = append(parsedArgs, expr)
1687 }
1688 if len(parsedArgs) != expectedArgs {
1689 return nil, fmt.Errorf("function should have %d arguments", expectedArgs)
1690 }
1691 return parsedArgs, nil
1692}
1693
1694type mathComparisonCallParser struct {
1695 op string
1696}
1697
1698func (p *mathComparisonCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1699 parsedArgs, err := parseIntegerArguments(ctx, node, args, 2)
1700 if err != nil {
1701 return ctx.newBadExpr(node, err.Error())
1702 }
1703 return &binaryOpExpr{
1704 left: parsedArgs[0],
1705 right: parsedArgs[1],
1706 op: p.op,
1707 returnType: starlarkTypeBool,
1708 }
1709}
1710
1711type mathMaxOrMinCallParser struct {
1712 function string
1713}
1714
1715func (p *mathMaxOrMinCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1716 parsedArgs, err := parseIntegerArguments(ctx, node, args, 2)
1717 if err != nil {
1718 return ctx.newBadExpr(node, err.Error())
1719 }
1720 return &callExpr{
1721 object: nil,
1722 name: p.function,
1723 args: parsedArgs,
1724 returnType: starlarkTypeInt,
1725 }
1726}
1727
Cole Faustf035d402022-03-28 14:02:50 -07001728type evalNodeParser struct{}
1729
1730func (p *evalNodeParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) []starlarkNode {
1731 parser := mkparser.NewParser("Eval expression", strings.NewReader(args.Dump()))
1732 nodes, errs := parser.Parse()
1733 if errs != nil {
1734 return []starlarkNode{ctx.newBadNode(node, "Unable to parse eval statement")}
1735 }
1736
1737 if len(nodes) == 0 {
1738 return []starlarkNode{}
1739 } else if len(nodes) == 1 {
1740 switch n := nodes[0].(type) {
1741 case *mkparser.Assignment:
1742 if n.Name.Const() {
1743 return ctx.handleAssignment(n)
1744 }
1745 case *mkparser.Comment:
1746 return []starlarkNode{&commentNode{strings.TrimSpace("#" + n.Comment)}}
1747 }
1748 }
1749
1750 return []starlarkNode{ctx.newBadNode(node, "Eval expression too complex; only assignments and comments are supported")}
1751}
1752
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001753func (ctx *parseContext) parseMakeString(node mkparser.Node, mk *mkparser.MakeString) starlarkExpr {
1754 if mk.Const() {
1755 return &stringLiteralExpr{mk.Dump()}
1756 }
1757 if mkRef, ok := mk.SingleVariable(); ok {
1758 return ctx.parseReference(node, mkRef)
1759 }
1760 // If we reached here, it's neither string literal nor a simple variable,
1761 // we need a full-blown interpolation node that will generate
1762 // "a%b%c" % (X, Y) for a$(X)b$(Y)c
Cole Faustfc438682021-12-14 12:46:32 -08001763 parts := make([]starlarkExpr, len(mk.Variables)+len(mk.Strings))
1764 for i := 0; i < len(parts); i++ {
1765 if i%2 == 0 {
1766 parts[i] = &stringLiteralExpr{literal: mk.Strings[i/2]}
1767 } else {
1768 parts[i] = ctx.parseReference(node, mk.Variables[i/2].Name)
1769 if x, ok := parts[i].(*badExpr); ok {
1770 return x
1771 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001772 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001773 }
Cole Faustfc438682021-12-14 12:46:32 -08001774 return NewInterpolateExpr(parts)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001775}
1776
Cole Faustf035d402022-03-28 14:02:50 -07001777func (ctx *parseContext) parseNodeMakeString(node mkparser.Node, mk *mkparser.MakeString) []starlarkNode {
1778 // Discard any constant values in the make string, as they would be top level
1779 // string literals and do nothing.
1780 result := make([]starlarkNode, 0, len(mk.Variables))
1781 for i := range mk.Variables {
1782 result = append(result, ctx.handleVariable(&mk.Variables[i])...)
1783 }
1784 return result
1785}
1786
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001787// Handles the statements whose treatment is the same in all contexts: comment,
1788// assignment, variable (which is a macro call in reality) and all constructs that
1789// do not handle in any context ('define directive and any unrecognized stuff).
Cole Faustdd569ae2022-01-31 15:48:29 -08001790func (ctx *parseContext) handleSimpleStatement(node mkparser.Node) []starlarkNode {
1791 var result []starlarkNode
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001792 switch x := node.(type) {
1793 case *mkparser.Comment:
Cole Faustdd569ae2022-01-31 15:48:29 -08001794 if n, handled := ctx.maybeHandleAnnotation(x); handled && n != nil {
1795 result = []starlarkNode{n}
1796 } else if !handled {
1797 result = []starlarkNode{&commentNode{strings.TrimSpace("#" + x.Comment)}}
Cole Faust7940c6a2022-01-31 15:54:05 -08001798 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001799 case *mkparser.Assignment:
Cole Faustdd569ae2022-01-31 15:48:29 -08001800 result = ctx.handleAssignment(x)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001801 case *mkparser.Variable:
Cole Faustdd569ae2022-01-31 15:48:29 -08001802 result = ctx.handleVariable(x)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001803 case *mkparser.Directive:
1804 switch x.Name {
1805 case "define":
Cole Faustdd569ae2022-01-31 15:48:29 -08001806 if res := ctx.maybeHandleDefine(x); res != nil {
1807 result = []starlarkNode{res}
1808 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001809 case "include", "-include":
Cole Faustdd569ae2022-01-31 15:48:29 -08001810 result = ctx.handleInclude(node, ctx.parseMakeString(node, x.Args), x.Name[0] != '-')
Cole Faust591a1fe2021-11-08 15:37:57 -08001811 case "ifeq", "ifneq", "ifdef", "ifndef":
Cole Faustdd569ae2022-01-31 15:48:29 -08001812 result = []starlarkNode{ctx.handleIfBlock(x)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001813 default:
Cole Faustdd569ae2022-01-31 15:48:29 -08001814 result = []starlarkNode{ctx.newBadNode(x, "unexpected directive %s", x.Name)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001815 }
1816 default:
Cole Faustdd569ae2022-01-31 15:48:29 -08001817 result = []starlarkNode{ctx.newBadNode(x, "unsupported line %s", strings.ReplaceAll(x.Dump(), "\n", "\n#"))}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001818 }
Cole Faust6c934f62022-01-06 15:51:12 -08001819
1820 // Clear the includeTops after each non-comment statement
1821 // so that include annotations placed on certain statements don't apply
1822 // globally for the rest of the makefile was well.
Cole Faustf92c9f22022-03-14 14:35:50 -07001823 if _, wasComment := node.(*mkparser.Comment); !wasComment {
1824 ctx.atTopOfMakefile = false
Cole Faust6c934f62022-01-06 15:51:12 -08001825 ctx.includeTops = []string{}
1826 }
Cole Faustdd569ae2022-01-31 15:48:29 -08001827
1828 if result == nil {
1829 result = []starlarkNode{}
1830 }
Cole Faustf035d402022-03-28 14:02:50 -07001831
Cole Faustdd569ae2022-01-31 15:48:29 -08001832 return result
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001833}
1834
Cole Faustf92c9f22022-03-14 14:35:50 -07001835// The types allowed in a type_hint
1836var typeHintMap = map[string]starlarkType{
1837 "string": starlarkTypeString,
1838 "list": starlarkTypeList,
1839}
1840
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001841// Processes annotation. An annotation is a comment that starts with #RBC# and provides
1842// a conversion hint -- say, where to look for the dynamically calculated inherit/include
Cole Faust7940c6a2022-01-31 15:54:05 -08001843// paths. Returns true if the comment was a successfully-handled annotation.
Cole Faustdd569ae2022-01-31 15:48:29 -08001844func (ctx *parseContext) maybeHandleAnnotation(cnode *mkparser.Comment) (starlarkNode, bool) {
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001845 maybeTrim := func(s, prefix string) (string, bool) {
1846 if strings.HasPrefix(s, prefix) {
1847 return strings.TrimSpace(strings.TrimPrefix(s, prefix)), true
1848 }
1849 return s, false
1850 }
1851 annotation, ok := maybeTrim(cnode.Comment, annotationCommentPrefix)
1852 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -08001853 return nil, false
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001854 }
1855 if p, ok := maybeTrim(annotation, "include_top"); ok {
Cole Faustf7ed5342021-12-21 14:15:12 -08001856 // Don't allow duplicate include tops, because then we will generate
1857 // invalid starlark code. (duplicate keys in the _entry dictionary)
1858 for _, top := range ctx.includeTops {
1859 if top == p {
Cole Faustdd569ae2022-01-31 15:48:29 -08001860 return nil, true
Cole Faustf7ed5342021-12-21 14:15:12 -08001861 }
1862 }
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001863 ctx.includeTops = append(ctx.includeTops, p)
Cole Faustdd569ae2022-01-31 15:48:29 -08001864 return nil, true
Cole Faustf92c9f22022-03-14 14:35:50 -07001865 } else if p, ok := maybeTrim(annotation, "type_hint"); ok {
1866 // Type hints must come at the beginning the file, to avoid confusion
1867 // if a type hint was specified later and thus only takes effect for half
1868 // of the file.
1869 if !ctx.atTopOfMakefile {
1870 return ctx.newBadNode(cnode, "type_hint annotations must come before the first Makefile statement"), true
1871 }
1872
1873 parts := strings.Fields(p)
1874 if len(parts) <= 1 {
1875 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
1876 }
1877
1878 var varType starlarkType
1879 if varType, ok = typeHintMap[parts[0]]; !ok {
1880 varType = starlarkTypeUnknown
1881 }
1882 if varType == starlarkTypeUnknown {
1883 return ctx.newBadNode(cnode, "Invalid type_hint annotation. Only list/string types are accepted, found %s", parts[0]), true
1884 }
1885
1886 for _, name := range parts[1:] {
1887 // Don't allow duplicate type hints
1888 if _, ok := ctx.typeHints[name]; ok {
1889 return ctx.newBadNode(cnode, "Duplicate type hint for variable %s", name), true
1890 }
1891 ctx.typeHints[name] = varType
1892 }
1893 return nil, true
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001894 }
Cole Faustdd569ae2022-01-31 15:48:29 -08001895 return ctx.newBadNode(cnode, "unsupported annotation %s", cnode.Comment), true
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001896}
1897
1898func (ctx *parseContext) loadedModulePath(path string) string {
1899 // During the transition to Roboleaf some of the product configuration files
1900 // will be converted and checked in while the others will be generated on the fly
1901 // and run. The runner (rbcrun application) accommodates this by allowing three
1902 // different ways to specify the loaded file location:
1903 // 1) load(":<file>",...) loads <file> from the same directory
1904 // 2) load("//path/relative/to/source/root:<file>", ...) loads <file> source tree
1905 // 3) load("/absolute/path/to/<file> absolute path
1906 // If the file being generated and the file it wants to load are in the same directory,
1907 // generate option 1.
1908 // Otherwise, if output directory is not specified, generate 2)
1909 // Finally, if output directory has been specified and the file being generated and
1910 // the file it wants to load from are in the different directories, generate 2) or 3):
1911 // * if the file being loaded exists in the source tree, generate 2)
1912 // * otherwise, generate 3)
1913 // Finally, figure out the loaded module path and name and create a node for it
1914 loadedModuleDir := filepath.Dir(path)
1915 base := filepath.Base(path)
1916 loadedModuleName := strings.TrimSuffix(base, filepath.Ext(base)) + ctx.outputSuffix
1917 if loadedModuleDir == filepath.Dir(ctx.script.mkFile) {
1918 return ":" + loadedModuleName
1919 }
1920 if ctx.outputDir == "" {
1921 return fmt.Sprintf("//%s:%s", loadedModuleDir, loadedModuleName)
1922 }
1923 if _, err := os.Stat(filepath.Join(loadedModuleDir, loadedModuleName)); err == nil {
1924 return fmt.Sprintf("//%s:%s", loadedModuleDir, loadedModuleName)
1925 }
1926 return filepath.Join(ctx.outputDir, loadedModuleDir, loadedModuleName)
1927}
1928
Sasha Smundak3deb9682021-07-26 18:42:25 -07001929func (ctx *parseContext) addSoongNamespace(ns string) {
1930 if _, ok := ctx.soongNamespaces[ns]; ok {
1931 return
1932 }
1933 ctx.soongNamespaces[ns] = make(map[string]bool)
1934}
1935
1936func (ctx *parseContext) hasSoongNamespace(name string) bool {
1937 _, ok := ctx.soongNamespaces[name]
1938 return ok
1939}
1940
1941func (ctx *parseContext) updateSoongNamespace(replace bool, namespaceName string, varNames []string) {
1942 ctx.addSoongNamespace(namespaceName)
1943 vars := ctx.soongNamespaces[namespaceName]
1944 if replace {
1945 vars = make(map[string]bool)
1946 ctx.soongNamespaces[namespaceName] = vars
1947 }
1948 for _, v := range varNames {
1949 vars[v] = true
1950 }
1951}
1952
1953func (ctx *parseContext) hasNamespaceVar(namespaceName string, varName string) bool {
1954 vars, ok := ctx.soongNamespaces[namespaceName]
1955 if ok {
1956 _, ok = vars[varName]
1957 }
1958 return ok
1959}
1960
Sasha Smundak422b6142021-11-11 18:31:59 -08001961func (ctx *parseContext) errorLocation(node mkparser.Node) ErrorLocation {
1962 return ErrorLocation{ctx.script.mkFile, ctx.script.nodeLocator(node.Pos())}
1963}
1964
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001965func (ss *StarlarkScript) String() string {
1966 return NewGenerateContext(ss).emit()
1967}
1968
1969func (ss *StarlarkScript) SubConfigFiles() []string {
Sasha Smundak6609ba72021-07-22 18:32:56 -07001970
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001971 var subs []string
1972 for _, src := range ss.inherited {
1973 subs = append(subs, src.originalPath)
1974 }
1975 return subs
1976}
1977
1978func (ss *StarlarkScript) HasErrors() bool {
1979 return ss.hasErrors
1980}
1981
1982// Convert reads and parses a makefile. If successful, parsed tree
1983// is returned and then can be passed to String() to get the generated
1984// Starlark file.
1985func Convert(req Request) (*StarlarkScript, error) {
1986 reader := req.Reader
1987 if reader == nil {
1988 mkContents, err := ioutil.ReadFile(req.MkFile)
1989 if err != nil {
1990 return nil, err
1991 }
1992 reader = bytes.NewBuffer(mkContents)
1993 }
1994 parser := mkparser.NewParser(req.MkFile, reader)
1995 nodes, errs := parser.Parse()
1996 if len(errs) > 0 {
1997 for _, e := range errs {
1998 fmt.Fprintln(os.Stderr, "ERROR:", e)
1999 }
2000 return nil, fmt.Errorf("bad makefile %s", req.MkFile)
2001 }
2002 starScript := &StarlarkScript{
Sasha Smundak422b6142021-11-11 18:31:59 -08002003 moduleName: moduleNameForFile(req.MkFile),
2004 mkFile: req.MkFile,
Sasha Smundak422b6142021-11-11 18:31:59 -08002005 traceCalls: req.TraceCalls,
2006 sourceFS: req.SourceFS,
2007 makefileFinder: req.MakefileFinder,
2008 nodeLocator: func(pos mkparser.Pos) int { return parser.Unpack(pos).Line },
Cole Faustdd569ae2022-01-31 15:48:29 -08002009 nodes: make([]starlarkNode, 0),
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002010 }
2011 ctx := newParseContext(starScript, nodes)
2012 ctx.outputSuffix = req.OutputSuffix
2013 ctx.outputDir = req.OutputDir
2014 ctx.errorLogger = req.ErrorLogger
2015 if len(req.TracedVariables) > 0 {
2016 ctx.tracedVariables = make(map[string]bool)
2017 for _, v := range req.TracedVariables {
2018 ctx.tracedVariables[v] = true
2019 }
2020 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002021 for ctx.hasNodes() && ctx.fatalError == nil {
Cole Faustdd569ae2022-01-31 15:48:29 -08002022 starScript.nodes = append(starScript.nodes, ctx.handleSimpleStatement(ctx.getNode())...)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002023 }
2024 if ctx.fatalError != nil {
2025 return nil, ctx.fatalError
2026 }
2027 return starScript, nil
2028}
2029
Cole Faust864028a2021-12-01 13:43:17 -08002030func Launcher(mainModuleUri, inputVariablesUri, mainModuleName string) string {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002031 var buf bytes.Buffer
2032 fmt.Fprintf(&buf, "load(%q, %q)\n", baseUri, baseName)
Cole Faust864028a2021-12-01 13:43:17 -08002033 fmt.Fprintf(&buf, "load(%q, input_variables_init = \"init\")\n", inputVariablesUri)
Sasha Smundakd7d07ad2021-09-10 15:42:34 -07002034 fmt.Fprintf(&buf, "load(%q, \"init\")\n", mainModuleUri)
Cole Faust864028a2021-12-01 13:43:17 -08002035 fmt.Fprintf(&buf, "%s(%s(%q, init, input_variables_init))\n", cfnPrintVars, cfnMain, mainModuleName)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002036 return buf.String()
2037}
2038
Cole Faust6ed7cb42021-10-07 17:08:46 -07002039func BoardLauncher(mainModuleUri string, inputVariablesUri string) string {
2040 var buf bytes.Buffer
2041 fmt.Fprintf(&buf, "load(%q, %q)\n", baseUri, baseName)
2042 fmt.Fprintf(&buf, "load(%q, \"init\")\n", mainModuleUri)
2043 fmt.Fprintf(&buf, "load(%q, input_variables_init = \"init\")\n", inputVariablesUri)
Cole Fausta0604662022-02-28 11:53:58 -08002044 fmt.Fprintf(&buf, "%s(%s(init, input_variables_init))\n", cfnPrintVars, cfnBoardMain)
Cole Faust6ed7cb42021-10-07 17:08:46 -07002045 return buf.String()
2046}
2047
Sasha Smundakb051c4e2020-11-05 20:45:07 -08002048func MakePath2ModuleName(mkPath string) string {
2049 return strings.TrimSuffix(mkPath, filepath.Ext(mkPath))
2050}