blob: d8b88b2cdb33231410f20bf0527cd8bf36fa46e3 [file] [log] [blame]
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001// Copyright 2021 Google LLC
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15// Convert makefile containing device configuration to Starlark file
16// The conversion can handle the following constructs in a makefile:
17// * comments
18// * simple variable assignments
19// * $(call init-product,<file>)
20// * $(call inherit-product-if-exists
21// * if directives
22// All other constructs are carried over to the output starlark file as comments.
23//
24package mk2rbc
25
26import (
27 "bytes"
28 "fmt"
29 "io"
Sasha Smundak6609ba72021-07-22 18:32:56 -070030 "io/fs"
Sasha Smundakb051c4e2020-11-05 20:45:07 -080031 "io/ioutil"
32 "os"
33 "path/filepath"
34 "regexp"
35 "strconv"
36 "strings"
37 "text/scanner"
38
39 mkparser "android/soong/androidmk/parser"
40)
41
42const (
Sasha Smundak6d852dd2021-09-27 20:34:39 -070043 annotationCommentPrefix = "RBC#"
44 baseUri = "//build/make/core:product_config.rbc"
Sasha Smundakb051c4e2020-11-05 20:45:07 -080045 // The name of the struct exported by the product_config.rbc
46 // that contains the functions and variables available to
47 // product configuration Starlark files.
48 baseName = "rblf"
49
Sasha Smundak65b547e2021-09-17 15:35:41 -070050 soongNsPrefix = "SOONG_CONFIG_"
51
Sasha Smundakb051c4e2020-11-05 20:45:07 -080052 // And here are the functions and variables:
Cole Fauste2a37982022-03-09 16:00:17 -080053 cfnGetCfg = baseName + ".cfg"
54 cfnMain = baseName + ".product_configuration"
55 cfnBoardMain = baseName + ".board_configuration"
56 cfnPrintVars = baseName + ".printvars"
57 cfnInherit = baseName + ".inherit"
58 cfnSetListDefault = baseName + ".setdefault"
Sasha Smundakb051c4e2020-11-05 20:45:07 -080059)
60
61const (
Cole Faust9ebf6e42021-12-13 14:08:34 -080062 soongConfigAppend = "soong_config_append"
63 soongConfigAssign = "soong_config_set"
Sasha Smundakb051c4e2020-11-05 20:45:07 -080064)
65
Cole Faust9ebf6e42021-12-13 14:08:34 -080066var knownFunctions = map[string]interface {
67 parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr
Sasha Smundakb051c4e2020-11-05 20:45:07 -080068}{
Cole Faust1cc08852022-02-28 11:12:08 -080069 "abspath": &simpleCallParser{name: baseName + ".abspath", returnType: starlarkTypeString},
70 "add-product-dex-preopt-module-config": &simpleCallParser{name: baseName + ".add_product_dex_preopt_module_config", returnType: starlarkTypeString, addHandle: true},
71 "add_soong_config_namespace": &simpleCallParser{name: baseName + ".soong_config_namespace", returnType: starlarkTypeVoid, addGlobals: true},
72 "add_soong_config_var_value": &simpleCallParser{name: baseName + ".soong_config_set", returnType: starlarkTypeVoid, addGlobals: true},
73 soongConfigAssign: &simpleCallParser{name: baseName + ".soong_config_set", returnType: starlarkTypeVoid, addGlobals: true},
74 soongConfigAppend: &simpleCallParser{name: baseName + ".soong_config_append", returnType: starlarkTypeVoid, addGlobals: true},
75 "soong_config_get": &simpleCallParser{name: baseName + ".soong_config_get", returnType: starlarkTypeString, addGlobals: true},
76 "add-to-product-copy-files-if-exists": &simpleCallParser{name: baseName + ".copy_if_exists", returnType: starlarkTypeList},
77 "addprefix": &simpleCallParser{name: baseName + ".addprefix", returnType: starlarkTypeList},
78 "addsuffix": &simpleCallParser{name: baseName + ".addsuffix", returnType: starlarkTypeList},
79 "copy-files": &simpleCallParser{name: baseName + ".copy_files", returnType: starlarkTypeList},
80 "dir": &simpleCallParser{name: baseName + ".dir", returnType: starlarkTypeList},
81 "dist-for-goals": &simpleCallParser{name: baseName + ".mkdist_for_goals", returnType: starlarkTypeVoid, addGlobals: true},
82 "enforce-product-packages-exist": &simpleCallParser{name: baseName + ".enforce_product_packages_exist", returnType: starlarkTypeVoid},
83 "error": &makeControlFuncParser{name: baseName + ".mkerror"},
84 "findstring": &simpleCallParser{name: baseName + ".findstring", returnType: starlarkTypeInt},
85 "find-copy-subdir-files": &simpleCallParser{name: baseName + ".find_and_copy", returnType: starlarkTypeList},
86 "filter": &simpleCallParser{name: baseName + ".filter", returnType: starlarkTypeList},
87 "filter-out": &simpleCallParser{name: baseName + ".filter_out", returnType: starlarkTypeList},
88 "firstword": &firstOrLastwordCallParser{isLastWord: false},
89 "foreach": &foreachCallPaser{},
90 "if": &ifCallParser{},
91 "info": &makeControlFuncParser{name: baseName + ".mkinfo"},
92 "is-board-platform": &simpleCallParser{name: baseName + ".board_platform_is", returnType: starlarkTypeBool, addGlobals: true},
93 "is-board-platform2": &simpleCallParser{name: baseName + ".board_platform_is", returnType: starlarkTypeBool, addGlobals: true},
94 "is-board-platform-in-list": &simpleCallParser{name: baseName + ".board_platform_in", returnType: starlarkTypeBool, addGlobals: true},
95 "is-board-platform-in-list2": &simpleCallParser{name: baseName + ".board_platform_in", returnType: starlarkTypeBool, addGlobals: true},
96 "is-product-in-list": &isProductInListCallParser{},
97 "is-vendor-board-platform": &isVendorBoardPlatformCallParser{},
98 "is-vendor-board-qcom": &isVendorBoardQcomCallParser{},
99 "lastword": &firstOrLastwordCallParser{isLastWord: true},
100 "notdir": &simpleCallParser{name: baseName + ".notdir", returnType: starlarkTypeString},
101 "math_max": &mathMaxOrMinCallParser{function: "max"},
102 "math_min": &mathMaxOrMinCallParser{function: "min"},
103 "math_gt_or_eq": &mathComparisonCallParser{op: ">="},
104 "math_gt": &mathComparisonCallParser{op: ">"},
105 "math_lt": &mathComparisonCallParser{op: "<"},
106 "my-dir": &myDirCallParser{},
107 "patsubst": &substCallParser{fname: "patsubst"},
108 "product-copy-files-by-pattern": &simpleCallParser{name: baseName + ".product_copy_files_by_pattern", returnType: starlarkTypeList},
109 "require-artifacts-in-path": &simpleCallParser{name: baseName + ".require_artifacts_in_path", returnType: starlarkTypeVoid},
110 "require-artifacts-in-path-relaxed": &simpleCallParser{name: baseName + ".require_artifacts_in_path_relaxed", returnType: starlarkTypeVoid},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800111 // TODO(asmundak): remove it once all calls are removed from configuration makefiles. see b/183161002
Cole Faust9ebf6e42021-12-13 14:08:34 -0800112 "shell": &shellCallParser{},
Cole Faust1cc08852022-02-28 11:12:08 -0800113 "strip": &simpleCallParser{name: baseName + ".mkstrip", returnType: starlarkTypeString},
Cole Faust9ebf6e42021-12-13 14:08:34 -0800114 "subst": &substCallParser{fname: "subst"},
115 "warning": &makeControlFuncParser{name: baseName + ".mkwarning"},
116 "word": &wordCallParser{},
Cole Faust1cc08852022-02-28 11:12:08 -0800117 "wildcard": &simpleCallParser{name: baseName + ".expand_wildcard", returnType: starlarkTypeList},
Cole Faust9ebf6e42021-12-13 14:08:34 -0800118}
119
120// These are functions that we don't implement conversions for, but
121// we allow seeing their definitions in the product config files.
122var ignoredDefines = map[string]bool{
123 "find-word-in-list": true, // internal macro
124 "get-vendor-board-platforms": true, // internal macro, used by is-board-platform, etc.
125 "is-android-codename": true, // unused by product config
126 "is-android-codename-in-list": true, // unused by product config
127 "is-chipset-in-board-platform": true, // unused by product config
128 "is-chipset-prefix-in-board-platform": true, // unused by product config
129 "is-not-board-platform": true, // defined but never used
130 "is-platform-sdk-version-at-least": true, // unused by product config
131 "match-prefix": true, // internal macro
132 "match-word": true, // internal macro
133 "match-word-in-list": true, // internal macro
134 "tb-modules": true, // defined in hardware/amlogic/tb_modules/tb_detect.mk, unused
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800135}
136
Cole Faustb0d32ab2021-12-09 14:00:59 -0800137var identifierFullMatchRegex = regexp.MustCompile("^[a-zA-Z_][a-zA-Z0-9_]*$")
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800138
139// Conversion request parameters
140type Request struct {
Sasha Smundak422b6142021-11-11 18:31:59 -0800141 MkFile string // file to convert
142 Reader io.Reader // if set, read input from this stream instead
Sasha Smundak422b6142021-11-11 18:31:59 -0800143 OutputSuffix string // generated Starlark files suffix
144 OutputDir string // if set, root of the output hierarchy
145 ErrorLogger ErrorLogger
146 TracedVariables []string // trace assignment to these variables
147 TraceCalls bool
148 SourceFS fs.FS
149 MakefileFinder MakefileFinder
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800150}
151
Sasha Smundak7d934b92021-11-10 12:20:01 -0800152// ErrorLogger prints errors and gathers error statistics.
153// Its NewError function is called on every error encountered during the conversion.
154type ErrorLogger interface {
Sasha Smundak422b6142021-11-11 18:31:59 -0800155 NewError(el ErrorLocation, node mkparser.Node, text string, args ...interface{})
156}
157
158type ErrorLocation struct {
159 MkFile string
160 MkLine int
161}
162
163func (el ErrorLocation) String() string {
164 return fmt.Sprintf("%s:%d", el.MkFile, el.MkLine)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800165}
166
167// Derives module name for a given file. It is base name
168// (file name without suffix), with some characters replaced to make it a Starlark identifier
169func moduleNameForFile(mkFile string) string {
170 base := strings.TrimSuffix(filepath.Base(mkFile), filepath.Ext(mkFile))
171 // TODO(asmundak): what else can be in the product file names?
Sasha Smundak6609ba72021-07-22 18:32:56 -0700172 return strings.NewReplacer("-", "_", ".", "_").Replace(base)
173
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800174}
175
176func cloneMakeString(mkString *mkparser.MakeString) *mkparser.MakeString {
177 r := &mkparser.MakeString{StringPos: mkString.StringPos}
178 r.Strings = append(r.Strings, mkString.Strings...)
179 r.Variables = append(r.Variables, mkString.Variables...)
180 return r
181}
182
183func isMakeControlFunc(s string) bool {
184 return s == "error" || s == "warning" || s == "info"
185}
186
187// Starlark output generation context
188type generationContext struct {
189 buf strings.Builder
190 starScript *StarlarkScript
191 indentLevel int
192 inAssignment bool
193 tracedCount int
194}
195
196func NewGenerateContext(ss *StarlarkScript) *generationContext {
197 return &generationContext{starScript: ss}
198}
199
200// emit returns generated script
201func (gctx *generationContext) emit() string {
202 ss := gctx.starScript
203
204 // The emitted code has the following layout:
205 // <initial comments>
206 // preamble, i.e.,
207 // load statement for the runtime support
208 // load statement for each unique submodule pulled in by this one
209 // def init(g, handle):
210 // cfg = rblf.cfg(handle)
211 // <statements>
212 // <warning if conversion was not clean>
213
214 iNode := len(ss.nodes)
215 for i, node := range ss.nodes {
216 if _, ok := node.(*commentNode); !ok {
217 iNode = i
218 break
219 }
220 node.emit(gctx)
221 }
222
223 gctx.emitPreamble()
224
225 gctx.newLine()
226 // The arguments passed to the init function are the global dictionary
227 // ('g') and the product configuration dictionary ('cfg')
228 gctx.write("def init(g, handle):")
229 gctx.indentLevel++
230 if gctx.starScript.traceCalls {
231 gctx.newLine()
232 gctx.writef(`print(">%s")`, gctx.starScript.mkFile)
233 }
234 gctx.newLine()
235 gctx.writef("cfg = %s(handle)", cfnGetCfg)
236 for _, node := range ss.nodes[iNode:] {
237 node.emit(gctx)
238 }
239
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800240 if gctx.starScript.traceCalls {
241 gctx.newLine()
242 gctx.writef(`print("<%s")`, gctx.starScript.mkFile)
243 }
244 gctx.indentLevel--
245 gctx.write("\n")
246 return gctx.buf.String()
247}
248
249func (gctx *generationContext) emitPreamble() {
250 gctx.newLine()
251 gctx.writef("load(%q, %q)", baseUri, baseName)
252 // Emit exactly one load statement for each URI.
253 loadedSubConfigs := make(map[string]string)
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800254 for _, mi := range gctx.starScript.inherited {
255 uri := mi.path
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800256 if m, ok := loadedSubConfigs[uri]; ok {
257 // No need to emit load statement, but fix module name.
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800258 mi.moduleLocalName = m
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800259 continue
260 }
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800261 if mi.optional || mi.missing {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800262 uri += "|init"
263 }
264 gctx.newLine()
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800265 gctx.writef("load(%q, %s = \"init\")", uri, mi.entryName())
266 loadedSubConfigs[uri] = mi.moduleLocalName
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800267 }
268 gctx.write("\n")
269}
270
271func (gctx *generationContext) emitPass() {
272 gctx.newLine()
273 gctx.write("pass")
274}
275
276func (gctx *generationContext) write(ss ...string) {
277 for _, s := range ss {
278 gctx.buf.WriteString(s)
279 }
280}
281
282func (gctx *generationContext) writef(format string, args ...interface{}) {
283 gctx.write(fmt.Sprintf(format, args...))
284}
285
286func (gctx *generationContext) newLine() {
287 if gctx.buf.Len() == 0 {
288 return
289 }
290 gctx.write("\n")
291 gctx.writef("%*s", 2*gctx.indentLevel, "")
292}
293
Sasha Smundak422b6142021-11-11 18:31:59 -0800294func (gctx *generationContext) emitConversionError(el ErrorLocation, message string) {
295 gctx.writef(`rblf.mk2rbc_error("%s", %q)`, el, message)
296}
297
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800298func (gctx *generationContext) emitLoadCheck(im inheritedModule) {
299 if !im.needsLoadCheck() {
300 return
301 }
302 gctx.newLine()
303 gctx.writef("if not %s:", im.entryName())
304 gctx.indentLevel++
305 gctx.newLine()
306 gctx.write(`rblf.mkerror("`, gctx.starScript.mkFile, `", "Cannot find %s" % (`)
307 im.pathExpr().emit(gctx)
308 gctx.write("))")
309 gctx.indentLevel--
310}
311
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800312type knownVariable struct {
313 name string
314 class varClass
315 valueType starlarkType
316}
317
318type knownVariables map[string]knownVariable
319
320func (pcv knownVariables) NewVariable(name string, varClass varClass, valueType starlarkType) {
321 v, exists := pcv[name]
322 if !exists {
323 pcv[name] = knownVariable{name, varClass, valueType}
324 return
325 }
326 // Conflict resolution:
327 // * config class trumps everything
328 // * any type trumps unknown type
329 match := varClass == v.class
330 if !match {
331 if varClass == VarClassConfig {
332 v.class = VarClassConfig
333 match = true
334 } else if v.class == VarClassConfig {
335 match = true
336 }
337 }
338 if valueType != v.valueType {
339 if valueType != starlarkTypeUnknown {
340 if v.valueType == starlarkTypeUnknown {
341 v.valueType = valueType
342 } else {
343 match = false
344 }
345 }
346 }
347 if !match {
348 fmt.Fprintf(os.Stderr, "cannot redefine %s as %v/%v (already defined as %v/%v)\n",
349 name, varClass, valueType, v.class, v.valueType)
350 }
351}
352
353// All known product variables.
354var KnownVariables = make(knownVariables)
355
356func init() {
357 for _, kv := range []string{
358 // Kernel-related variables that we know are lists.
359 "BOARD_VENDOR_KERNEL_MODULES",
360 "BOARD_VENDOR_RAMDISK_KERNEL_MODULES",
361 "BOARD_VENDOR_RAMDISK_KERNEL_MODULES_LOAD",
362 "BOARD_RECOVERY_KERNEL_MODULES",
363 // Other variables we knwo are lists
364 "ART_APEX_JARS",
365 } {
366 KnownVariables.NewVariable(kv, VarClassSoong, starlarkTypeList)
367 }
368}
369
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800370// Information about the generated Starlark script.
371type StarlarkScript struct {
Sasha Smundak422b6142021-11-11 18:31:59 -0800372 mkFile string
373 moduleName string
374 mkPos scanner.Position
375 nodes []starlarkNode
376 inherited []*moduleInfo
377 hasErrors bool
Sasha Smundak422b6142021-11-11 18:31:59 -0800378 traceCalls bool // print enter/exit each init function
379 sourceFS fs.FS
380 makefileFinder MakefileFinder
381 nodeLocator func(pos mkparser.Pos) int
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800382}
383
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800384// varAssignmentScope points to the last assignment for each variable
385// in the current block. It is used during the parsing to chain
386// the assignments to a variable together.
387type varAssignmentScope struct {
388 outer *varAssignmentScope
389 vars map[string]*assignmentNode
390}
391
392// parseContext holds the script we are generating and all the ephemeral data
393// needed during the parsing.
394type parseContext struct {
395 script *StarlarkScript
396 nodes []mkparser.Node // Makefile as parsed by mkparser
397 currentNodeIndex int // Node in it we are processing
398 ifNestLevel int
399 moduleNameCount map[string]int // count of imported modules with given basename
400 fatalError error
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800401 outputSuffix string
Sasha Smundak7d934b92021-11-10 12:20:01 -0800402 errorLogger ErrorLogger
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800403 tracedVariables map[string]bool // variables to be traced in the generated script
404 variables map[string]variable
405 varAssignments *varAssignmentScope
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800406 outputDir string
Sasha Smundak6609ba72021-07-22 18:32:56 -0700407 dependentModules map[string]*moduleInfo
Sasha Smundak3deb9682021-07-26 18:42:25 -0700408 soongNamespaces map[string]map[string]bool
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700409 includeTops []string
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800410}
411
412func newParseContext(ss *StarlarkScript, nodes []mkparser.Node) *parseContext {
413 predefined := []struct{ name, value string }{
414 {"SRC_TARGET_DIR", filepath.Join("build", "make", "target")},
415 {"LOCAL_PATH", filepath.Dir(ss.mkFile)},
Cole Faust9b6111a2022-02-02 15:38:33 -0800416 {"TOPDIR", ""}, // TOPDIR is just set to an empty string in cleanbuild.mk and core.mk
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800417 // TODO(asmundak): maybe read it from build/make/core/envsetup.mk?
418 {"TARGET_COPY_OUT_SYSTEM", "system"},
419 {"TARGET_COPY_OUT_SYSTEM_OTHER", "system_other"},
420 {"TARGET_COPY_OUT_DATA", "data"},
421 {"TARGET_COPY_OUT_ASAN", filepath.Join("data", "asan")},
422 {"TARGET_COPY_OUT_OEM", "oem"},
423 {"TARGET_COPY_OUT_RAMDISK", "ramdisk"},
424 {"TARGET_COPY_OUT_DEBUG_RAMDISK", "debug_ramdisk"},
425 {"TARGET_COPY_OUT_VENDOR_DEBUG_RAMDISK", "vendor_debug_ramdisk"},
426 {"TARGET_COPY_OUT_TEST_HARNESS_RAMDISK", "test_harness_ramdisk"},
427 {"TARGET_COPY_OUT_ROOT", "root"},
428 {"TARGET_COPY_OUT_RECOVERY", "recovery"},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800429 {"TARGET_COPY_OUT_VENDOR_RAMDISK", "vendor_ramdisk"},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800430 // TODO(asmundak): to process internal config files, we need the following variables:
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800431 // TARGET_VENDOR
432 // target_base_product
433 //
434
435 // the following utility variables are set in build/make/common/core.mk:
436 {"empty", ""},
437 {"space", " "},
438 {"comma", ","},
439 {"newline", "\n"},
440 {"pound", "#"},
441 {"backslash", "\\"},
442 }
443 ctx := &parseContext{
444 script: ss,
445 nodes: nodes,
446 currentNodeIndex: 0,
447 ifNestLevel: 0,
448 moduleNameCount: make(map[string]int),
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800449 variables: make(map[string]variable),
Sasha Smundak6609ba72021-07-22 18:32:56 -0700450 dependentModules: make(map[string]*moduleInfo),
Sasha Smundak3deb9682021-07-26 18:42:25 -0700451 soongNamespaces: make(map[string]map[string]bool),
Cole Faust6c934f62022-01-06 15:51:12 -0800452 includeTops: []string{},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800453 }
454 ctx.pushVarAssignments()
455 for _, item := range predefined {
456 ctx.variables[item.name] = &predefinedVariable{
457 baseVariable: baseVariable{nam: item.name, typ: starlarkTypeString},
458 value: &stringLiteralExpr{item.value},
459 }
460 }
461
462 return ctx
463}
464
Cole Faust3c4fc992022-02-28 16:05:01 -0800465func (ctx *parseContext) lastAssignment(v variable) *assignmentNode {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800466 for va := ctx.varAssignments; va != nil; va = va.outer {
Cole Faust3c4fc992022-02-28 16:05:01 -0800467 if v, ok := va.vars[v.name()]; ok {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800468 return v
469 }
470 }
471 return nil
472}
473
Cole Faust3c4fc992022-02-28 16:05:01 -0800474func (ctx *parseContext) setLastAssignment(v variable, asgn *assignmentNode) {
475 ctx.varAssignments.vars[v.name()] = asgn
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800476}
477
478func (ctx *parseContext) pushVarAssignments() {
479 va := &varAssignmentScope{
480 outer: ctx.varAssignments,
481 vars: make(map[string]*assignmentNode),
482 }
483 ctx.varAssignments = va
484}
485
486func (ctx *parseContext) popVarAssignments() {
487 ctx.varAssignments = ctx.varAssignments.outer
488}
489
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800490func (ctx *parseContext) hasNodes() bool {
491 return ctx.currentNodeIndex < len(ctx.nodes)
492}
493
494func (ctx *parseContext) getNode() mkparser.Node {
495 if !ctx.hasNodes() {
496 return nil
497 }
498 node := ctx.nodes[ctx.currentNodeIndex]
499 ctx.currentNodeIndex++
500 return node
501}
502
503func (ctx *parseContext) backNode() {
504 if ctx.currentNodeIndex <= 0 {
505 panic("Cannot back off")
506 }
507 ctx.currentNodeIndex--
508}
509
Cole Faustdd569ae2022-01-31 15:48:29 -0800510func (ctx *parseContext) handleAssignment(a *mkparser.Assignment) []starlarkNode {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800511 // Handle only simple variables
512 if !a.Name.Const() {
Cole Faustdd569ae2022-01-31 15:48:29 -0800513 return []starlarkNode{ctx.newBadNode(a, "Only simple variables are handled")}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800514 }
515 name := a.Name.Strings[0]
Sasha Smundakea3bc3a2021-11-10 13:06:42 -0800516 // The `override` directive
517 // override FOO :=
518 // is parsed as an assignment to a variable named `override FOO`.
519 // There are very few places where `override` is used, just flag it.
520 if strings.HasPrefix(name, "override ") {
Cole Faustdd569ae2022-01-31 15:48:29 -0800521 return []starlarkNode{ctx.newBadNode(a, "cannot handle override directive")}
Sasha Smundakea3bc3a2021-11-10 13:06:42 -0800522 }
523
Cole Faustc00184e2021-11-08 12:08:57 -0800524 // Soong configuration
Sasha Smundak3deb9682021-07-26 18:42:25 -0700525 if strings.HasPrefix(name, soongNsPrefix) {
Cole Faustdd569ae2022-01-31 15:48:29 -0800526 return ctx.handleSoongNsAssignment(strings.TrimPrefix(name, soongNsPrefix), a)
Sasha Smundak3deb9682021-07-26 18:42:25 -0700527 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800528 lhs := ctx.addVariable(name)
529 if lhs == nil {
Cole Faustdd569ae2022-01-31 15:48:29 -0800530 return []starlarkNode{ctx.newBadNode(a, "unknown variable %s", name)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800531 }
Cole Faust3c4fc992022-02-28 16:05:01 -0800532 _, isTraced := ctx.tracedVariables[lhs.name()]
Sasha Smundak422b6142021-11-11 18:31:59 -0800533 asgn := &assignmentNode{lhs: lhs, mkValue: a.Value, isTraced: isTraced, location: ctx.errorLocation(a)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800534 if lhs.valueType() == starlarkTypeUnknown {
535 // Try to divine variable type from the RHS
536 asgn.value = ctx.parseMakeString(a, a.Value)
537 if xBad, ok := asgn.value.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800538 return []starlarkNode{&exprNode{xBad}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800539 }
540 inferred_type := asgn.value.typ()
541 if inferred_type != starlarkTypeUnknown {
Sasha Smundak9d011ab2021-07-09 16:00:57 -0700542 lhs.setValueType(inferred_type)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800543 }
544 }
545 if lhs.valueType() == starlarkTypeList {
Cole Faustdd569ae2022-01-31 15:48:29 -0800546 xConcat, xBad := ctx.buildConcatExpr(a)
547 if xBad != nil {
548 return []starlarkNode{&exprNode{expr: xBad}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800549 }
550 switch len(xConcat.items) {
551 case 0:
552 asgn.value = &listExpr{}
553 case 1:
554 asgn.value = xConcat.items[0]
555 default:
556 asgn.value = xConcat
557 }
558 } else {
559 asgn.value = ctx.parseMakeString(a, a.Value)
560 if xBad, ok := asgn.value.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800561 return []starlarkNode{&exprNode{expr: xBad}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800562 }
563 }
564
Cole Faust3c4fc992022-02-28 16:05:01 -0800565 asgn.previous = ctx.lastAssignment(lhs)
566 ctx.setLastAssignment(lhs, asgn)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800567 switch a.Type {
568 case "=", ":=":
569 asgn.flavor = asgnSet
570 case "+=":
Cole Fauste2a37982022-03-09 16:00:17 -0800571 asgn.flavor = asgnAppend
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800572 case "?=":
573 asgn.flavor = asgnMaybeSet
574 default:
575 panic(fmt.Errorf("unexpected assignment type %s", a.Type))
576 }
577
Cole Faustdd569ae2022-01-31 15:48:29 -0800578 return []starlarkNode{asgn}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800579}
580
Cole Faustdd569ae2022-01-31 15:48:29 -0800581func (ctx *parseContext) handleSoongNsAssignment(name string, asgn *mkparser.Assignment) []starlarkNode {
Sasha Smundak3deb9682021-07-26 18:42:25 -0700582 val := ctx.parseMakeString(asgn, asgn.Value)
583 if xBad, ok := val.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800584 return []starlarkNode{&exprNode{expr: xBad}}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700585 }
Sasha Smundak3deb9682021-07-26 18:42:25 -0700586
587 // Unfortunately, Soong namespaces can be set up by directly setting corresponding Make
588 // variables instead of via add_soong_config_namespace + add_soong_config_var_value.
589 // Try to divine the call from the assignment as follows:
590 if name == "NAMESPACES" {
591 // Upon seeng
592 // SOONG_CONFIG_NAMESPACES += foo
593 // remember that there is a namespace `foo` and act as we saw
594 // $(call add_soong_config_namespace,foo)
595 s, ok := maybeString(val)
596 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800597 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 -0700598 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800599 result := make([]starlarkNode, 0)
Sasha Smundak3deb9682021-07-26 18:42:25 -0700600 for _, ns := range strings.Fields(s) {
601 ctx.addSoongNamespace(ns)
Cole Faustdd569ae2022-01-31 15:48:29 -0800602 result = append(result, &exprNode{&callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -0800603 name: baseName + ".soong_config_namespace",
604 args: []starlarkExpr{&globalsExpr{}, &stringLiteralExpr{ns}},
Sasha Smundak3deb9682021-07-26 18:42:25 -0700605 returnType: starlarkTypeVoid,
606 }})
607 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800608 return result
Sasha Smundak3deb9682021-07-26 18:42:25 -0700609 } else {
610 // Upon seeing
611 // SOONG_CONFIG_x_y = v
612 // find a namespace called `x` and act as if we encountered
Cole Faustc00184e2021-11-08 12:08:57 -0800613 // $(call soong_config_set,x,y,v)
Sasha Smundak3deb9682021-07-26 18:42:25 -0700614 // or check that `x_y` is a namespace, and then add the RHS of this assignment as variables in
615 // it.
616 // Emit an error in the ambiguous situation (namespaces `foo_bar` with a variable `baz`
617 // and `foo` with a variable `bar_baz`.
618 namespaceName := ""
619 if ctx.hasSoongNamespace(name) {
620 namespaceName = name
621 }
622 var varName string
623 for pos, ch := range name {
624 if !(ch == '_' && ctx.hasSoongNamespace(name[0:pos])) {
625 continue
626 }
627 if namespaceName != "" {
Cole Faustdd569ae2022-01-31 15:48:29 -0800628 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 -0700629 }
630 namespaceName = name[0:pos]
631 varName = name[pos+1:]
632 }
633 if namespaceName == "" {
Cole Faustdd569ae2022-01-31 15:48:29 -0800634 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 -0700635 }
636 if varName == "" {
637 // Remember variables in this namespace
638 s, ok := maybeString(val)
639 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800640 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 -0700641 }
642 ctx.updateSoongNamespace(asgn.Type != "+=", namespaceName, strings.Fields(s))
Cole Faustdd569ae2022-01-31 15:48:29 -0800643 return []starlarkNode{}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700644 }
645
646 // Finally, handle assignment to a namespace variable
647 if !ctx.hasNamespaceVar(namespaceName, varName) {
Cole Faustdd569ae2022-01-31 15:48:29 -0800648 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 -0700649 }
Cole Faust9ebf6e42021-12-13 14:08:34 -0800650 fname := baseName + "." + soongConfigAssign
Sasha Smundak65b547e2021-09-17 15:35:41 -0700651 if asgn.Type == "+=" {
Cole Faust9ebf6e42021-12-13 14:08:34 -0800652 fname = baseName + "." + soongConfigAppend
Sasha Smundak65b547e2021-09-17 15:35:41 -0700653 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800654 return []starlarkNode{&exprNode{&callExpr{
Sasha Smundak65b547e2021-09-17 15:35:41 -0700655 name: fname,
Cole Faust9ebf6e42021-12-13 14:08:34 -0800656 args: []starlarkExpr{&globalsExpr{}, &stringLiteralExpr{namespaceName}, &stringLiteralExpr{varName}, val},
Sasha Smundak3deb9682021-07-26 18:42:25 -0700657 returnType: starlarkTypeVoid,
Cole Faustdd569ae2022-01-31 15:48:29 -0800658 }}}
Sasha Smundak3deb9682021-07-26 18:42:25 -0700659 }
660}
661
Cole Faustdd569ae2022-01-31 15:48:29 -0800662func (ctx *parseContext) buildConcatExpr(a *mkparser.Assignment) (*concatExpr, *badExpr) {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800663 xConcat := &concatExpr{}
664 var xItemList *listExpr
665 addToItemList := func(x ...starlarkExpr) {
666 if xItemList == nil {
667 xItemList = &listExpr{[]starlarkExpr{}}
668 }
669 xItemList.items = append(xItemList.items, x...)
670 }
671 finishItemList := func() {
672 if xItemList != nil {
673 xConcat.items = append(xConcat.items, xItemList)
674 xItemList = nil
675 }
676 }
677
678 items := a.Value.Words()
679 for _, item := range items {
680 // A function call in RHS is supposed to return a list, all other item
681 // expressions return individual elements.
682 switch x := ctx.parseMakeString(a, item).(type) {
683 case *badExpr:
Cole Faustdd569ae2022-01-31 15:48:29 -0800684 return nil, x
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800685 case *stringLiteralExpr:
686 addToItemList(maybeConvertToStringList(x).(*listExpr).items...)
687 default:
688 switch x.typ() {
689 case starlarkTypeList:
690 finishItemList()
691 xConcat.items = append(xConcat.items, x)
692 case starlarkTypeString:
693 finishItemList()
694 xConcat.items = append(xConcat.items, &callExpr{
695 object: x,
696 name: "split",
697 args: nil,
698 returnType: starlarkTypeList,
699 })
700 default:
701 addToItemList(x)
702 }
703 }
704 }
705 if xItemList != nil {
706 xConcat.items = append(xConcat.items, xItemList)
707 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800708 return xConcat, nil
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800709}
710
Sasha Smundak6609ba72021-07-22 18:32:56 -0700711func (ctx *parseContext) newDependentModule(path string, optional bool) *moduleInfo {
712 modulePath := ctx.loadedModulePath(path)
713 if mi, ok := ctx.dependentModules[modulePath]; ok {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700714 mi.optional = mi.optional && optional
Sasha Smundak6609ba72021-07-22 18:32:56 -0700715 return mi
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800716 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800717 moduleName := moduleNameForFile(path)
718 moduleLocalName := "_" + moduleName
719 n, found := ctx.moduleNameCount[moduleName]
720 if found {
721 moduleLocalName += fmt.Sprintf("%d", n)
722 }
723 ctx.moduleNameCount[moduleName] = n + 1
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800724 _, err := fs.Stat(ctx.script.sourceFS, path)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700725 mi := &moduleInfo{
726 path: modulePath,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800727 originalPath: path,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800728 moduleLocalName: moduleLocalName,
Sasha Smundak6609ba72021-07-22 18:32:56 -0700729 optional: optional,
Sasha Smundak6bc132a2022-01-10 17:02:16 -0800730 missing: err != nil,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800731 }
Sasha Smundak6609ba72021-07-22 18:32:56 -0700732 ctx.dependentModules[modulePath] = mi
733 ctx.script.inherited = append(ctx.script.inherited, mi)
734 return mi
735}
736
737func (ctx *parseContext) handleSubConfig(
Cole Faustdd569ae2022-01-31 15:48:29 -0800738 v mkparser.Node, pathExpr starlarkExpr, loadAlways bool, processModule func(inheritedModule) starlarkNode) []starlarkNode {
Sasha Smundak6609ba72021-07-22 18:32:56 -0700739
740 // In a simple case, the name of a module to inherit/include is known statically.
741 if path, ok := maybeString(pathExpr); ok {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700742 // Note that even if this directive loads a module unconditionally, a module may be
743 // absent without causing any harm if this directive is inside an if/else block.
744 moduleShouldExist := loadAlways && ctx.ifNestLevel == 0
Sasha Smundak6609ba72021-07-22 18:32:56 -0700745 if strings.Contains(path, "*") {
746 if paths, err := fs.Glob(ctx.script.sourceFS, path); err == nil {
Cole Faustdd569ae2022-01-31 15:48:29 -0800747 result := make([]starlarkNode, 0)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700748 for _, p := range paths {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700749 mi := ctx.newDependentModule(p, !moduleShouldExist)
Cole Faustdd569ae2022-01-31 15:48:29 -0800750 result = append(result, processModule(inheritedStaticModule{mi, loadAlways}))
Sasha Smundak6609ba72021-07-22 18:32:56 -0700751 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800752 return result
Sasha Smundak6609ba72021-07-22 18:32:56 -0700753 } else {
Cole Faustdd569ae2022-01-31 15:48:29 -0800754 return []starlarkNode{ctx.newBadNode(v, "cannot glob wildcard argument")}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700755 }
756 } else {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700757 mi := ctx.newDependentModule(path, !moduleShouldExist)
Cole Faustdd569ae2022-01-31 15:48:29 -0800758 return []starlarkNode{processModule(inheritedStaticModule{mi, loadAlways})}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700759 }
Sasha Smundak6609ba72021-07-22 18:32:56 -0700760 }
761
762 // If module path references variables (e.g., $(v1)/foo/$(v2)/device-config.mk), find all the paths in the
763 // source tree that may be a match and the corresponding variable values. For instance, if the source tree
764 // contains vendor1/foo/abc/dev.mk and vendor2/foo/def/dev.mk, the first one will be inherited when
765 // (v1, v2) == ('vendor1', 'abc'), and the second one when (v1, v2) == ('vendor2', 'def').
766 // We then emit the code that loads all of them, e.g.:
767 // load("//vendor1/foo/abc:dev.rbc", _dev1_init="init")
768 // load("//vendor2/foo/def/dev.rbc", _dev2_init="init")
769 // And then inherit it as follows:
770 // _e = {
771 // "vendor1/foo/abc/dev.mk": ("vendor1/foo/abc/dev", _dev1_init),
772 // "vendor2/foo/def/dev.mk": ("vendor2/foo/def/dev", _dev_init2) }.get("%s/foo/%s/dev.mk" % (v1, v2))
773 // if _e:
774 // rblf.inherit(handle, _e[0], _e[1])
775 //
776 var matchingPaths []string
777 varPath, ok := pathExpr.(*interpolateExpr)
778 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800779 return []starlarkNode{ctx.newBadNode(v, "inherit-product/include argument is too complex")}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700780 }
781
782 pathPattern := []string{varPath.chunks[0]}
783 for _, chunk := range varPath.chunks[1:] {
784 if chunk != "" {
785 pathPattern = append(pathPattern, chunk)
786 }
787 }
Cole Faust069aba62022-01-26 17:47:33 -0800788 if pathPattern[0] == "" && len(ctx.includeTops) > 0 {
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700789 // If pattern starts from the top. restrict it to the directories where
790 // we know inherit-product uses dynamically calculated path.
791 for _, p := range ctx.includeTops {
792 pathPattern[0] = p
793 matchingPaths = append(matchingPaths, ctx.findMatchingPaths(pathPattern)...)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700794 }
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700795 } else {
796 matchingPaths = ctx.findMatchingPaths(pathPattern)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700797 }
798 // Safeguard against $(call inherit-product,$(PRODUCT_PATH))
Sasha Smundak90be8c52021-08-03 11:06:10 -0700799 const maxMatchingFiles = 150
Sasha Smundak6609ba72021-07-22 18:32:56 -0700800 if len(matchingPaths) > maxMatchingFiles {
Cole Faustdd569ae2022-01-31 15:48:29 -0800801 return []starlarkNode{ctx.newBadNode(v, "there are >%d files matching the pattern, please rewrite it", maxMatchingFiles)}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700802 }
Cole Faust93f8d392022-03-02 13:31:30 -0800803
804 needsWarning := pathPattern[0] == "" && len(ctx.includeTops) == 0
805 res := inheritedDynamicModule{*varPath, []*moduleInfo{}, loadAlways, ctx.errorLocation(v), needsWarning}
806 for _, p := range matchingPaths {
807 // A product configuration files discovered dynamically may attempt to inherit
808 // from another one which does not exist in this source tree. Prevent load errors
809 // by always loading the dynamic files as optional.
810 res.candidateModules = append(res.candidateModules, ctx.newDependentModule(p, true))
Sasha Smundak6609ba72021-07-22 18:32:56 -0700811 }
Cole Faust93f8d392022-03-02 13:31:30 -0800812 return []starlarkNode{processModule(res)}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700813}
814
815func (ctx *parseContext) findMatchingPaths(pattern []string) []string {
Cole Faust9b6111a2022-02-02 15:38:33 -0800816 files := ctx.script.makefileFinder.Find(".")
Sasha Smundak6609ba72021-07-22 18:32:56 -0700817 if len(pattern) == 0 {
818 return files
819 }
820
821 // Create regular expression from the pattern
822 s_regexp := "^" + regexp.QuoteMeta(pattern[0])
823 for _, s := range pattern[1:] {
824 s_regexp += ".*" + regexp.QuoteMeta(s)
825 }
826 s_regexp += "$"
827 rex := regexp.MustCompile(s_regexp)
828
829 // Now match
830 var res []string
831 for _, p := range files {
832 if rex.MatchString(p) {
833 res = append(res, p)
834 }
835 }
836 return res
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800837}
838
Cole Faustdd569ae2022-01-31 15:48:29 -0800839func (ctx *parseContext) handleInheritModule(v mkparser.Node, args *mkparser.MakeString, loadAlways bool) []starlarkNode {
Cole Faust9ebf6e42021-12-13 14:08:34 -0800840 args.TrimLeftSpaces()
841 args.TrimRightSpaces()
842 pathExpr := ctx.parseMakeString(v, args)
843 if _, ok := pathExpr.(*badExpr); ok {
Cole Faustdd569ae2022-01-31 15:48:29 -0800844 return []starlarkNode{ctx.newBadNode(v, "Unable to parse argument to inherit")}
Cole Faust9ebf6e42021-12-13 14:08:34 -0800845 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800846 return ctx.handleSubConfig(v, pathExpr, loadAlways, func(im inheritedModule) starlarkNode {
847 return &inheritNode{im, loadAlways}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700848 })
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800849}
850
Cole Faustdd569ae2022-01-31 15:48:29 -0800851func (ctx *parseContext) handleInclude(v mkparser.Node, pathExpr starlarkExpr, loadAlways bool) []starlarkNode {
852 return ctx.handleSubConfig(v, pathExpr, loadAlways, func(im inheritedModule) starlarkNode {
853 return &includeNode{im, loadAlways}
Sasha Smundak6609ba72021-07-22 18:32:56 -0700854 })
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800855}
856
Cole Faustdd569ae2022-01-31 15:48:29 -0800857func (ctx *parseContext) handleVariable(v *mkparser.Variable) []starlarkNode {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800858 // Handle:
859 // $(call inherit-product,...)
860 // $(call inherit-product-if-exists,...)
861 // $(info xxx)
862 // $(warning xxx)
863 // $(error xxx)
Cole Faust9ebf6e42021-12-13 14:08:34 -0800864 // $(call other-custom-functions,...)
865
866 // inherit-product(-if-exists) gets converted to a series of statements,
867 // not just a single expression like parseReference returns. So handle it
868 // separately at the beginning here.
869 if strings.HasPrefix(v.Name.Dump(), "call inherit-product,") {
870 args := v.Name.Clone()
871 args.ReplaceLiteral("call inherit-product,", "")
Cole Faustdd569ae2022-01-31 15:48:29 -0800872 return ctx.handleInheritModule(v, args, true)
Cole Faust9ebf6e42021-12-13 14:08:34 -0800873 }
874 if strings.HasPrefix(v.Name.Dump(), "call inherit-product-if-exists,") {
875 args := v.Name.Clone()
876 args.ReplaceLiteral("call inherit-product-if-exists,", "")
Cole Faustdd569ae2022-01-31 15:48:29 -0800877 return ctx.handleInheritModule(v, args, false)
Cole Faust9ebf6e42021-12-13 14:08:34 -0800878 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800879 return []starlarkNode{&exprNode{expr: ctx.parseReference(v, v.Name)}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800880}
881
Cole Faustdd569ae2022-01-31 15:48:29 -0800882func (ctx *parseContext) maybeHandleDefine(directive *mkparser.Directive) starlarkNode {
Sasha Smundakf3e072a2021-07-14 12:50:28 -0700883 macro_name := strings.Fields(directive.Args.Strings[0])[0]
884 // Ignore the macros that we handle
Cole Faust9ebf6e42021-12-13 14:08:34 -0800885 _, ignored := ignoredDefines[macro_name]
886 _, known := knownFunctions[macro_name]
887 if !ignored && !known {
Cole Faustdd569ae2022-01-31 15:48:29 -0800888 return ctx.newBadNode(directive, "define is not supported: %s", macro_name)
Sasha Smundakf3e072a2021-07-14 12:50:28 -0700889 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800890 return nil
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800891}
892
Cole Faustdd569ae2022-01-31 15:48:29 -0800893func (ctx *parseContext) handleIfBlock(ifDirective *mkparser.Directive) starlarkNode {
894 ssSwitch := &switchNode{
895 ssCases: []*switchCase{ctx.processBranch(ifDirective)},
896 }
897 for ctx.hasNodes() && ctx.fatalError == nil {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800898 node := ctx.getNode()
899 switch x := node.(type) {
900 case *mkparser.Directive:
901 switch x.Name {
902 case "else", "elifdef", "elifndef", "elifeq", "elifneq":
Cole Faustdd569ae2022-01-31 15:48:29 -0800903 ssSwitch.ssCases = append(ssSwitch.ssCases, ctx.processBranch(x))
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800904 case "endif":
Cole Faustdd569ae2022-01-31 15:48:29 -0800905 return ssSwitch
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800906 default:
Cole Faustdd569ae2022-01-31 15:48:29 -0800907 return ctx.newBadNode(node, "unexpected directive %s", x.Name)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800908 }
909 default:
Cole Faustdd569ae2022-01-31 15:48:29 -0800910 return ctx.newBadNode(ifDirective, "unexpected statement")
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800911 }
912 }
913 if ctx.fatalError == nil {
914 ctx.fatalError = fmt.Errorf("no matching endif for %s", ifDirective.Dump())
915 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800916 return ctx.newBadNode(ifDirective, "no matching endif for %s", ifDirective.Dump())
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800917}
918
919// processBranch processes a single branch (if/elseif/else) until the next directive
920// on the same level.
Cole Faustdd569ae2022-01-31 15:48:29 -0800921func (ctx *parseContext) processBranch(check *mkparser.Directive) *switchCase {
922 block := &switchCase{gate: ctx.parseCondition(check)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800923 defer func() {
924 ctx.popVarAssignments()
925 ctx.ifNestLevel--
926
927 }()
928 ctx.pushVarAssignments()
929 ctx.ifNestLevel++
930
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800931 for ctx.hasNodes() {
932 node := ctx.getNode()
Cole Faust591a1fe2021-11-08 15:37:57 -0800933 if d, ok := node.(*mkparser.Directive); ok {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800934 switch d.Name {
935 case "else", "elifdef", "elifndef", "elifeq", "elifneq", "endif":
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800936 ctx.backNode()
Cole Faustdd569ae2022-01-31 15:48:29 -0800937 return block
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800938 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800939 }
Cole Faustdd569ae2022-01-31 15:48:29 -0800940 block.nodes = append(block.nodes, ctx.handleSimpleStatement(node)...)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800941 }
942 ctx.fatalError = fmt.Errorf("no matching endif for %s", check.Dump())
Cole Faustdd569ae2022-01-31 15:48:29 -0800943 return block
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800944}
945
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800946func (ctx *parseContext) parseCondition(check *mkparser.Directive) starlarkNode {
947 switch check.Name {
948 case "ifdef", "ifndef", "elifdef", "elifndef":
Cole Faust71514c02022-01-27 17:21:41 -0800949 if !check.Args.Const() {
Cole Faustdd569ae2022-01-31 15:48:29 -0800950 return ctx.newBadNode(check, "ifdef variable ref too complex: %s", check.Args.Dump())
Cole Faust71514c02022-01-27 17:21:41 -0800951 }
952 v := NewVariableRefExpr(ctx.addVariable(check.Args.Strings[0]), false)
953 if strings.HasSuffix(check.Name, "ndef") {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800954 v = &notExpr{v}
955 }
956 return &ifNode{
957 isElif: strings.HasPrefix(check.Name, "elif"),
958 expr: v,
959 }
960 case "ifeq", "ifneq", "elifeq", "elifneq":
961 return &ifNode{
962 isElif: strings.HasPrefix(check.Name, "elif"),
963 expr: ctx.parseCompare(check),
964 }
965 case "else":
966 return &elseNode{}
967 default:
968 panic(fmt.Errorf("%s: unknown directive: %s", ctx.script.mkFile, check.Dump()))
969 }
970}
971
972func (ctx *parseContext) newBadExpr(node mkparser.Node, text string, args ...interface{}) starlarkExpr {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800973 if ctx.errorLogger != nil {
Sasha Smundak422b6142021-11-11 18:31:59 -0800974 ctx.errorLogger.NewError(ctx.errorLocation(node), node, text, args...)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800975 }
976 ctx.script.hasErrors = true
Cole Faustdd569ae2022-01-31 15:48:29 -0800977 return &badExpr{errorLocation: ctx.errorLocation(node), message: fmt.Sprintf(text, args...)}
978}
979
980// records that the given node failed to be converted and includes an explanatory message
981func (ctx *parseContext) newBadNode(failedNode mkparser.Node, message string, args ...interface{}) starlarkNode {
982 return &exprNode{ctx.newBadExpr(failedNode, message, args...)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800983}
984
985func (ctx *parseContext) parseCompare(cond *mkparser.Directive) starlarkExpr {
986 // Strip outer parentheses
987 mkArg := cloneMakeString(cond.Args)
988 mkArg.Strings[0] = strings.TrimLeft(mkArg.Strings[0], "( ")
989 n := len(mkArg.Strings)
990 mkArg.Strings[n-1] = strings.TrimRight(mkArg.Strings[n-1], ") ")
991 args := mkArg.Split(",")
992 // TODO(asmundak): handle the case where the arguments are in quotes and space-separated
993 if len(args) != 2 {
994 return ctx.newBadExpr(cond, "ifeq/ifneq len(args) != 2 %s", cond.Dump())
995 }
996 args[0].TrimRightSpaces()
997 args[1].TrimLeftSpaces()
998
999 isEq := !strings.HasSuffix(cond.Name, "neq")
Cole Faustf8320212021-11-10 15:05:07 -08001000 xLeft := ctx.parseMakeString(cond, args[0])
1001 xRight := ctx.parseMakeString(cond, args[1])
1002 if bad, ok := xLeft.(*badExpr); ok {
1003 return bad
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001004 }
Cole Faustf8320212021-11-10 15:05:07 -08001005 if bad, ok := xRight.(*badExpr); ok {
1006 return bad
1007 }
1008
1009 if expr, ok := ctx.parseCompareSpecialCases(cond, xLeft, xRight); ok {
1010 return expr
1011 }
1012
Cole Faust9ebf6e42021-12-13 14:08:34 -08001013 var stringOperand string
1014 var otherOperand starlarkExpr
1015 if s, ok := maybeString(xLeft); ok {
1016 stringOperand = s
1017 otherOperand = xRight
1018 } else if s, ok := maybeString(xRight); ok {
1019 stringOperand = s
1020 otherOperand = xLeft
1021 }
1022
1023 not := func(expr starlarkExpr) starlarkExpr {
1024 switch typedExpr := expr.(type) {
1025 case *inExpr:
1026 typedExpr.isNot = !typedExpr.isNot
1027 return typedExpr
1028 case *eqExpr:
1029 typedExpr.isEq = !typedExpr.isEq
1030 return typedExpr
Cole Faustb1103e22022-01-06 15:22:05 -08001031 case *binaryOpExpr:
1032 switch typedExpr.op {
1033 case ">":
1034 typedExpr.op = "<="
1035 return typedExpr
1036 case "<":
1037 typedExpr.op = ">="
1038 return typedExpr
1039 case ">=":
1040 typedExpr.op = "<"
1041 return typedExpr
1042 case "<=":
1043 typedExpr.op = ">"
1044 return typedExpr
1045 default:
1046 return &notExpr{expr: expr}
1047 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001048 default:
1049 return &notExpr{expr: expr}
1050 }
1051 }
1052
1053 // If we've identified one of the operands as being a string literal, check
1054 // for some special cases we can do to simplify the resulting expression.
1055 if otherOperand != nil {
1056 if stringOperand == "" {
1057 if isEq {
1058 return not(otherOperand)
1059 } else {
1060 return otherOperand
1061 }
1062 }
1063 if stringOperand == "true" && otherOperand.typ() == starlarkTypeBool {
1064 if !isEq {
1065 return not(otherOperand)
1066 } else {
1067 return otherOperand
1068 }
1069 }
Cole Faustb1103e22022-01-06 15:22:05 -08001070 if intOperand, err := strconv.Atoi(strings.TrimSpace(stringOperand)); err == nil && otherOperand.typ() == starlarkTypeInt {
1071 return &eqExpr{
1072 left: otherOperand,
1073 right: &intLiteralExpr{literal: intOperand},
1074 isEq: isEq,
1075 }
1076 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001077 }
1078
Cole Faustf8320212021-11-10 15:05:07 -08001079 return &eqExpr{left: xLeft, right: xRight, isEq: isEq}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001080}
1081
Cole Faustf8320212021-11-10 15:05:07 -08001082// Given an if statement's directive and the left/right starlarkExprs,
1083// check if the starlarkExprs are one of a few hardcoded special cases
Cole Faust9932f752022-02-08 11:56:25 -08001084// that can be converted to a simpler equality expression than simply comparing
Cole Faustf8320212021-11-10 15:05:07 -08001085// the two.
1086func (ctx *parseContext) parseCompareSpecialCases(directive *mkparser.Directive, left starlarkExpr,
1087 right starlarkExpr) (starlarkExpr, bool) {
1088 isEq := !strings.HasSuffix(directive.Name, "neq")
1089
1090 // All the special cases require a call on one side and a
1091 // string literal/variable on the other. Turn the left/right variables into
1092 // call/value variables, and return false if that's not possible.
1093 var value starlarkExpr = nil
1094 call, ok := left.(*callExpr)
1095 if ok {
1096 switch right.(type) {
1097 case *stringLiteralExpr, *variableRefExpr:
1098 value = right
1099 }
1100 } else {
1101 call, _ = right.(*callExpr)
1102 switch left.(type) {
1103 case *stringLiteralExpr, *variableRefExpr:
1104 value = left
1105 }
1106 }
1107
1108 if call == nil || value == nil {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001109 return nil, false
1110 }
Cole Faustf8320212021-11-10 15:05:07 -08001111
Cole Faustf8320212021-11-10 15:05:07 -08001112 switch call.name {
Cole Faust9932f752022-02-08 11:56:25 -08001113 case baseName + ".filter":
1114 return ctx.parseCompareFilterFuncResult(directive, call, value, isEq)
Cole Faust9ebf6e42021-12-13 14:08:34 -08001115 case baseName + ".expand_wildcard":
Cole Faustf8320212021-11-10 15:05:07 -08001116 return ctx.parseCompareWildcardFuncResult(directive, call, value, !isEq), true
Cole Faust9ebf6e42021-12-13 14:08:34 -08001117 case baseName + ".findstring":
Cole Faustf8320212021-11-10 15:05:07 -08001118 return ctx.parseCheckFindstringFuncResult(directive, call, value, !isEq), true
Cole Faust9ebf6e42021-12-13 14:08:34 -08001119 case baseName + ".strip":
Cole Faustf8320212021-11-10 15:05:07 -08001120 return ctx.parseCompareStripFuncResult(directive, call, value, !isEq), true
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001121 }
Cole Faustf8320212021-11-10 15:05:07 -08001122 return nil, false
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001123}
1124
1125func (ctx *parseContext) parseCompareFilterFuncResult(cond *mkparser.Directive,
Cole Faust9932f752022-02-08 11:56:25 -08001126 filterFuncCall *callExpr, xValue starlarkExpr, negate bool) (starlarkExpr, bool) {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001127 // We handle:
Sasha Smundak0554d762021-07-08 18:26:12 -07001128 // * ifeq/ifneq (,$(filter v1 v2 ..., EXPR) becomes if EXPR not in/in ["v1", "v2", ...]
1129 // * ifeq/ifneq (,$(filter EXPR, v1 v2 ...) becomes if EXPR not in/in ["v1", "v2", ...]
Cole Faust9932f752022-02-08 11:56:25 -08001130 if x, ok := xValue.(*stringLiteralExpr); !ok || x.literal != "" {
1131 return nil, false
1132 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001133 xPattern := filterFuncCall.args[0]
1134 xText := filterFuncCall.args[1]
1135 var xInList *stringLiteralExpr
Sasha Smundak0554d762021-07-08 18:26:12 -07001136 var expr starlarkExpr
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001137 var ok bool
Cole Faust9932f752022-02-08 11:56:25 -08001138 if xInList, ok = xPattern.(*stringLiteralExpr); ok && !strings.ContainsRune(xInList.literal, '%') && xText.typ() == starlarkTypeList {
1139 expr = xText
1140 } else if xInList, ok = xText.(*stringLiteralExpr); ok {
1141 expr = xPattern
1142 } else {
1143 return nil, false
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001144 }
Cole Faust9932f752022-02-08 11:56:25 -08001145 slExpr := newStringListExpr(strings.Fields(xInList.literal))
1146 // Generate simpler code for the common cases:
1147 if expr.typ() == starlarkTypeList {
1148 if len(slExpr.items) == 1 {
1149 // Checking that a string belongs to list
1150 return &inExpr{isNot: negate, list: expr, expr: slExpr.items[0]}, true
Sasha Smundak0554d762021-07-08 18:26:12 -07001151 } else {
Cole Faust9932f752022-02-08 11:56:25 -08001152 return nil, false
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001153 }
Cole Faust9932f752022-02-08 11:56:25 -08001154 } else if len(slExpr.items) == 1 {
1155 return &eqExpr{left: expr, right: slExpr.items[0], isEq: !negate}, true
1156 } else {
1157 return &inExpr{isNot: negate, list: newStringListExpr(strings.Fields(xInList.literal)), expr: expr}, true
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001158 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001159}
1160
1161func (ctx *parseContext) parseCompareWildcardFuncResult(directive *mkparser.Directive,
1162 xCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
Sasha Smundak0554d762021-07-08 18:26:12 -07001163 if !isEmptyString(xValue) {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001164 return ctx.newBadExpr(directive, "wildcard result can be compared only to empty: %s", xValue)
1165 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001166 callFunc := baseName + ".file_wildcard_exists"
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001167 if s, ok := xCall.args[0].(*stringLiteralExpr); ok && !strings.ContainsAny(s.literal, "*?{[") {
Cole Faust9ebf6e42021-12-13 14:08:34 -08001168 callFunc = baseName + ".file_exists"
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001169 }
1170 var cc starlarkExpr = &callExpr{name: callFunc, args: xCall.args, returnType: starlarkTypeBool}
1171 if !negate {
1172 cc = &notExpr{cc}
1173 }
1174 return cc
1175}
1176
1177func (ctx *parseContext) parseCheckFindstringFuncResult(directive *mkparser.Directive,
1178 xCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
Sasha Smundak0554d762021-07-08 18:26:12 -07001179 if isEmptyString(xValue) {
1180 return &eqExpr{
1181 left: &callExpr{
1182 object: xCall.args[1],
1183 name: "find",
1184 args: []starlarkExpr{xCall.args[0]},
1185 returnType: starlarkTypeInt,
1186 },
1187 right: &intLiteralExpr{-1},
1188 isEq: !negate,
1189 }
Cole Faust0e9418c2021-12-13 16:33:25 -08001190 } else if s, ok := maybeString(xValue); ok {
1191 if s2, ok := maybeString(xCall.args[0]); ok && s == s2 {
1192 return &eqExpr{
1193 left: &callExpr{
1194 object: xCall.args[1],
1195 name: "find",
1196 args: []starlarkExpr{xCall.args[0]},
1197 returnType: starlarkTypeInt,
1198 },
1199 right: &intLiteralExpr{-1},
1200 isEq: negate,
1201 }
1202 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001203 }
Cole Faust0e9418c2021-12-13 16:33:25 -08001204 return ctx.newBadExpr(directive, "$(findstring) can only be compared to nothing or its first argument")
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001205}
1206
1207func (ctx *parseContext) parseCompareStripFuncResult(directive *mkparser.Directive,
1208 xCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
1209 if _, ok := xValue.(*stringLiteralExpr); !ok {
1210 return ctx.newBadExpr(directive, "strip result can be compared only to string: %s", xValue)
1211 }
1212 return &eqExpr{
1213 left: &callExpr{
1214 name: "strip",
1215 args: xCall.args,
1216 returnType: starlarkTypeString,
1217 },
1218 right: xValue, isEq: !negate}
1219}
1220
1221// parses $(...), returning an expression
1222func (ctx *parseContext) parseReference(node mkparser.Node, ref *mkparser.MakeString) starlarkExpr {
1223 ref.TrimLeftSpaces()
1224 ref.TrimRightSpaces()
1225 refDump := ref.Dump()
1226
1227 // Handle only the case where the first (or only) word is constant
1228 words := ref.SplitN(" ", 2)
1229 if !words[0].Const() {
1230 return ctx.newBadExpr(node, "reference is too complex: %s", refDump)
1231 }
1232
1233 // If it is a single word, it can be a simple variable
1234 // reference or a function call
Cole Faust9ebf6e42021-12-13 14:08:34 -08001235 if len(words) == 1 && !isMakeControlFunc(refDump) && refDump != "shell" {
Sasha Smundak65b547e2021-09-17 15:35:41 -07001236 if strings.HasPrefix(refDump, soongNsPrefix) {
1237 // TODO (asmundak): if we find many, maybe handle them.
Cole Faustc00184e2021-11-08 12:08:57 -08001238 return ctx.newBadExpr(node, "SOONG_CONFIG_ variables cannot be referenced, use soong_config_get instead: %s", refDump)
Sasha Smundak65b547e2021-09-17 15:35:41 -07001239 }
Cole Faustc36c9622021-12-07 15:20:45 -08001240 // Handle substitution references: https://www.gnu.org/software/make/manual/html_node/Substitution-Refs.html
1241 if strings.Contains(refDump, ":") {
1242 parts := strings.SplitN(refDump, ":", 2)
1243 substParts := strings.SplitN(parts[1], "=", 2)
1244 if len(substParts) < 2 || strings.Count(substParts[0], "%") > 1 {
1245 return ctx.newBadExpr(node, "Invalid substitution reference")
1246 }
1247 if !strings.Contains(substParts[0], "%") {
1248 if strings.Contains(substParts[1], "%") {
1249 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.")
1250 }
1251 substParts[0] = "%" + substParts[0]
1252 substParts[1] = "%" + substParts[1]
1253 }
1254 v := ctx.addVariable(parts[0])
1255 if v == nil {
1256 return ctx.newBadExpr(node, "unknown variable %s", refDump)
1257 }
1258 return &callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -08001259 name: baseName + ".mkpatsubst",
1260 returnType: starlarkTypeString,
Cole Faustc36c9622021-12-07 15:20:45 -08001261 args: []starlarkExpr{
1262 &stringLiteralExpr{literal: substParts[0]},
1263 &stringLiteralExpr{literal: substParts[1]},
Cole Faust3c4fc992022-02-28 16:05:01 -08001264 NewVariableRefExpr(v, ctx.lastAssignment(v) != nil),
Cole Faustc36c9622021-12-07 15:20:45 -08001265 },
1266 }
1267 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001268 if v := ctx.addVariable(refDump); v != nil {
Cole Faust3c4fc992022-02-28 16:05:01 -08001269 return NewVariableRefExpr(v, ctx.lastAssignment(v) != nil)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001270 }
1271 return ctx.newBadExpr(node, "unknown variable %s", refDump)
1272 }
1273
1274 expr := &callExpr{name: words[0].Dump(), returnType: starlarkTypeUnknown}
Cole Faust9ebf6e42021-12-13 14:08:34 -08001275 args := mkparser.SimpleMakeString("", words[0].Pos())
1276 if len(words) >= 2 {
1277 args = words[1]
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001278 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001279 args.TrimLeftSpaces()
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001280 if expr.name == "call" {
1281 words = args.SplitN(",", 2)
1282 if words[0].Empty() || !words[0].Const() {
Sasha Smundakf2c9f8b2021-07-27 10:44:48 -07001283 return ctx.newBadExpr(node, "cannot handle %s", refDump)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001284 }
1285 expr.name = words[0].Dump()
1286 if len(words) < 2 {
Sasha Smundak6609ba72021-07-22 18:32:56 -07001287 args = &mkparser.MakeString{}
1288 } else {
1289 args = words[1]
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001290 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001291 }
1292 if kf, found := knownFunctions[expr.name]; found {
Cole Faust9ebf6e42021-12-13 14:08:34 -08001293 return kf.parse(ctx, node, args)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001294 } else {
1295 return ctx.newBadExpr(node, "cannot handle invoking %s", expr.name)
1296 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001297}
1298
1299type simpleCallParser struct {
1300 name string
1301 returnType starlarkType
1302 addGlobals bool
Cole Faust1cc08852022-02-28 11:12:08 -08001303 addHandle bool
Cole Faust9ebf6e42021-12-13 14:08:34 -08001304}
1305
1306func (p *simpleCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1307 expr := &callExpr{name: p.name, returnType: p.returnType}
1308 if p.addGlobals {
1309 expr.args = append(expr.args, &globalsExpr{})
1310 }
Cole Faust1cc08852022-02-28 11:12:08 -08001311 if p.addHandle {
1312 expr.args = append(expr.args, &identifierExpr{name: "handle"})
1313 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001314 for _, arg := range args.Split(",") {
1315 arg.TrimLeftSpaces()
1316 arg.TrimRightSpaces()
1317 x := ctx.parseMakeString(node, arg)
1318 if xBad, ok := x.(*badExpr); ok {
1319 return xBad
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001320 }
Cole Faust9ebf6e42021-12-13 14:08:34 -08001321 expr.args = append(expr.args, x)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001322 }
1323 return expr
1324}
1325
Cole Faust9ebf6e42021-12-13 14:08:34 -08001326type makeControlFuncParser struct {
1327 name string
1328}
1329
1330func (p *makeControlFuncParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1331 // Make control functions need special treatment as everything
1332 // after the name is a single text argument
1333 x := ctx.parseMakeString(node, args)
1334 if xBad, ok := x.(*badExpr); ok {
1335 return xBad
1336 }
1337 return &callExpr{
1338 name: p.name,
1339 args: []starlarkExpr{
1340 &stringLiteralExpr{ctx.script.mkFile},
1341 x,
1342 },
1343 returnType: starlarkTypeUnknown,
1344 }
1345}
1346
1347type shellCallParser struct{}
1348
1349func (p *shellCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1350 // Shell functions need special treatment as everything
1351 // after the name is a single text argument
1352 x := ctx.parseMakeString(node, args)
1353 if xBad, ok := x.(*badExpr); ok {
1354 return xBad
1355 }
1356 return &callExpr{
1357 name: baseName + ".shell",
1358 args: []starlarkExpr{x},
1359 returnType: starlarkTypeUnknown,
1360 }
1361}
1362
1363type myDirCallParser struct{}
1364
1365func (p *myDirCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1366 if !args.Empty() {
1367 return ctx.newBadExpr(node, "my-dir function cannot have any arguments passed to it.")
1368 }
1369 return &variableRefExpr{ctx.addVariable("LOCAL_PATH"), true}
1370}
1371
Cole Faust9ebf6e42021-12-13 14:08:34 -08001372type isProductInListCallParser struct{}
1373
1374func (p *isProductInListCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1375 if args.Empty() {
1376 return ctx.newBadExpr(node, "is-product-in-list requires an argument")
1377 }
1378 return &inExpr{
1379 expr: &variableRefExpr{ctx.addVariable("TARGET_PRODUCT"), true},
1380 list: maybeConvertToStringList(ctx.parseMakeString(node, args)),
1381 isNot: false,
1382 }
1383}
1384
1385type isVendorBoardPlatformCallParser struct{}
1386
1387func (p *isVendorBoardPlatformCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1388 if args.Empty() || !identifierFullMatchRegex.MatchString(args.Dump()) {
1389 return ctx.newBadExpr(node, "cannot handle non-constant argument to is-vendor-board-platform")
1390 }
1391 return &inExpr{
1392 expr: &variableRefExpr{ctx.addVariable("TARGET_BOARD_PLATFORM"), false},
1393 list: &variableRefExpr{ctx.addVariable(args.Dump() + "_BOARD_PLATFORMS"), true},
1394 isNot: false,
1395 }
1396}
1397
1398type isVendorBoardQcomCallParser struct{}
1399
1400func (p *isVendorBoardQcomCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1401 if !args.Empty() {
1402 return ctx.newBadExpr(node, "is-vendor-board-qcom does not accept any arguments")
1403 }
1404 return &inExpr{
1405 expr: &variableRefExpr{ctx.addVariable("TARGET_BOARD_PLATFORM"), false},
1406 list: &variableRefExpr{ctx.addVariable("QCOM_BOARD_PLATFORMS"), true},
1407 isNot: false,
1408 }
1409}
1410
1411type substCallParser struct {
1412 fname string
1413}
1414
1415func (p *substCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001416 words := args.Split(",")
1417 if len(words) != 3 {
Cole Faust9ebf6e42021-12-13 14:08:34 -08001418 return ctx.newBadExpr(node, "%s function should have 3 arguments", p.fname)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001419 }
Sasha Smundak35434ed2021-11-05 16:29:56 -07001420 from := ctx.parseMakeString(node, words[0])
1421 if xBad, ok := from.(*badExpr); ok {
1422 return xBad
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001423 }
Sasha Smundak35434ed2021-11-05 16:29:56 -07001424 to := ctx.parseMakeString(node, words[1])
1425 if xBad, ok := to.(*badExpr); ok {
1426 return xBad
1427 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001428 words[2].TrimLeftSpaces()
1429 words[2].TrimRightSpaces()
1430 obj := ctx.parseMakeString(node, words[2])
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001431 typ := obj.typ()
Cole Faust9ebf6e42021-12-13 14:08:34 -08001432 if typ == starlarkTypeString && p.fname == "subst" {
Sasha Smundak94b41c72021-07-12 18:30:42 -07001433 // Optimization: if it's $(subst from, to, string), emit string.replace(from, to)
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001434 return &callExpr{
1435 object: obj,
1436 name: "replace",
Sasha Smundak35434ed2021-11-05 16:29:56 -07001437 args: []starlarkExpr{from, to},
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001438 returnType: typ,
1439 }
1440 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001441 return &callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -08001442 name: baseName + ".mk" + p.fname,
Sasha Smundak35434ed2021-11-05 16:29:56 -07001443 args: []starlarkExpr{from, to, obj},
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001444 returnType: obj.typ(),
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001445 }
1446}
1447
Cole Faust9ebf6e42021-12-13 14:08:34 -08001448type ifCallParser struct{}
1449
1450func (p *ifCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Cole Faust4eadba72021-12-07 11:54:52 -08001451 words := args.Split(",")
1452 if len(words) != 2 && len(words) != 3 {
1453 return ctx.newBadExpr(node, "if function should have 2 or 3 arguments, found "+strconv.Itoa(len(words)))
1454 }
1455 condition := ctx.parseMakeString(node, words[0])
1456 ifTrue := ctx.parseMakeString(node, words[1])
1457 var ifFalse starlarkExpr
1458 if len(words) == 3 {
1459 ifFalse = ctx.parseMakeString(node, words[2])
1460 } else {
1461 switch ifTrue.typ() {
1462 case starlarkTypeList:
1463 ifFalse = &listExpr{items: []starlarkExpr{}}
1464 case starlarkTypeInt:
1465 ifFalse = &intLiteralExpr{literal: 0}
1466 case starlarkTypeBool:
1467 ifFalse = &boolLiteralExpr{literal: false}
1468 default:
1469 ifFalse = &stringLiteralExpr{literal: ""}
1470 }
1471 }
1472 return &ifExpr{
1473 condition,
1474 ifTrue,
1475 ifFalse,
1476 }
1477}
1478
Cole Faust9ebf6e42021-12-13 14:08:34 -08001479type foreachCallPaser struct{}
1480
1481func (p *foreachCallPaser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Cole Faustb0d32ab2021-12-09 14:00:59 -08001482 words := args.Split(",")
1483 if len(words) != 3 {
1484 return ctx.newBadExpr(node, "foreach function should have 3 arguments, found "+strconv.Itoa(len(words)))
1485 }
1486 if !words[0].Const() || words[0].Empty() || !identifierFullMatchRegex.MatchString(words[0].Strings[0]) {
1487 return ctx.newBadExpr(node, "first argument to foreach function must be a simple string identifier")
1488 }
1489 loopVarName := words[0].Strings[0]
1490 list := ctx.parseMakeString(node, words[1])
1491 action := ctx.parseMakeString(node, words[2]).transform(func(expr starlarkExpr) starlarkExpr {
1492 if varRefExpr, ok := expr.(*variableRefExpr); ok && varRefExpr.ref.name() == loopVarName {
1493 return &identifierExpr{loopVarName}
1494 }
1495 return nil
1496 })
1497
1498 if list.typ() != starlarkTypeList {
1499 list = &callExpr{
Cole Faust9ebf6e42021-12-13 14:08:34 -08001500 name: baseName + ".words",
1501 returnType: starlarkTypeList,
Cole Faustb0d32ab2021-12-09 14:00:59 -08001502 args: []starlarkExpr{list},
1503 }
1504 }
1505
1506 return &foreachExpr{
1507 varName: loopVarName,
1508 list: list,
1509 action: action,
1510 }
1511}
1512
Cole Faust9ebf6e42021-12-13 14:08:34 -08001513type wordCallParser struct{}
1514
1515func (p *wordCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001516 words := args.Split(",")
1517 if len(words) != 2 {
1518 return ctx.newBadExpr(node, "word function should have 2 arguments")
1519 }
1520 var index uint64 = 0
1521 if words[0].Const() {
1522 index, _ = strconv.ParseUint(strings.TrimSpace(words[0].Strings[0]), 10, 64)
1523 }
1524 if index < 1 {
1525 return ctx.newBadExpr(node, "word index should be constant positive integer")
1526 }
1527 words[1].TrimLeftSpaces()
1528 words[1].TrimRightSpaces()
1529 array := ctx.parseMakeString(node, words[1])
1530 if xBad, ok := array.(*badExpr); ok {
1531 return xBad
1532 }
1533 if array.typ() != starlarkTypeList {
1534 array = &callExpr{object: array, name: "split", returnType: starlarkTypeList}
1535 }
Cole Faustb0d32ab2021-12-09 14:00:59 -08001536 return &indexExpr{array, &intLiteralExpr{int(index - 1)}}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001537}
1538
Cole Faust9ebf6e42021-12-13 14:08:34 -08001539type firstOrLastwordCallParser struct {
1540 isLastWord bool
1541}
1542
1543func (p *firstOrLastwordCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
Sasha Smundak16e07732021-07-23 11:38:23 -07001544 arg := ctx.parseMakeString(node, args)
1545 if bad, ok := arg.(*badExpr); ok {
1546 return bad
1547 }
1548 index := &intLiteralExpr{0}
Cole Faust9ebf6e42021-12-13 14:08:34 -08001549 if p.isLastWord {
Sasha Smundak16e07732021-07-23 11:38:23 -07001550 if v, ok := arg.(*variableRefExpr); ok && v.ref.name() == "MAKEFILE_LIST" {
1551 return &stringLiteralExpr{ctx.script.mkFile}
1552 }
1553 index.literal = -1
1554 }
1555 if arg.typ() == starlarkTypeList {
1556 return &indexExpr{arg, index}
1557 }
1558 return &indexExpr{&callExpr{object: arg, name: "split", returnType: starlarkTypeList}, index}
1559}
1560
Cole Faustb1103e22022-01-06 15:22:05 -08001561func parseIntegerArguments(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString, expectedArgs int) ([]starlarkExpr, error) {
1562 parsedArgs := make([]starlarkExpr, 0)
1563 for _, arg := range args.Split(",") {
1564 expr := ctx.parseMakeString(node, arg)
1565 if expr.typ() == starlarkTypeList {
1566 return nil, fmt.Errorf("argument to math argument has type list, which cannot be converted to int")
1567 }
1568 if s, ok := maybeString(expr); ok {
1569 intVal, err := strconv.Atoi(strings.TrimSpace(s))
1570 if err != nil {
1571 return nil, err
1572 }
1573 expr = &intLiteralExpr{literal: intVal}
1574 } else if expr.typ() != starlarkTypeInt {
1575 expr = &callExpr{
1576 name: "int",
1577 args: []starlarkExpr{expr},
1578 returnType: starlarkTypeInt,
1579 }
1580 }
1581 parsedArgs = append(parsedArgs, expr)
1582 }
1583 if len(parsedArgs) != expectedArgs {
1584 return nil, fmt.Errorf("function should have %d arguments", expectedArgs)
1585 }
1586 return parsedArgs, nil
1587}
1588
1589type mathComparisonCallParser struct {
1590 op string
1591}
1592
1593func (p *mathComparisonCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1594 parsedArgs, err := parseIntegerArguments(ctx, node, args, 2)
1595 if err != nil {
1596 return ctx.newBadExpr(node, err.Error())
1597 }
1598 return &binaryOpExpr{
1599 left: parsedArgs[0],
1600 right: parsedArgs[1],
1601 op: p.op,
1602 returnType: starlarkTypeBool,
1603 }
1604}
1605
1606type mathMaxOrMinCallParser struct {
1607 function string
1608}
1609
1610func (p *mathMaxOrMinCallParser) parse(ctx *parseContext, node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1611 parsedArgs, err := parseIntegerArguments(ctx, node, args, 2)
1612 if err != nil {
1613 return ctx.newBadExpr(node, err.Error())
1614 }
1615 return &callExpr{
1616 object: nil,
1617 name: p.function,
1618 args: parsedArgs,
1619 returnType: starlarkTypeInt,
1620 }
1621}
1622
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001623func (ctx *parseContext) parseMakeString(node mkparser.Node, mk *mkparser.MakeString) starlarkExpr {
1624 if mk.Const() {
1625 return &stringLiteralExpr{mk.Dump()}
1626 }
1627 if mkRef, ok := mk.SingleVariable(); ok {
1628 return ctx.parseReference(node, mkRef)
1629 }
1630 // If we reached here, it's neither string literal nor a simple variable,
1631 // we need a full-blown interpolation node that will generate
1632 // "a%b%c" % (X, Y) for a$(X)b$(Y)c
Cole Faustfc438682021-12-14 12:46:32 -08001633 parts := make([]starlarkExpr, len(mk.Variables)+len(mk.Strings))
1634 for i := 0; i < len(parts); i++ {
1635 if i%2 == 0 {
1636 parts[i] = &stringLiteralExpr{literal: mk.Strings[i/2]}
1637 } else {
1638 parts[i] = ctx.parseReference(node, mk.Variables[i/2].Name)
1639 if x, ok := parts[i].(*badExpr); ok {
1640 return x
1641 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001642 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001643 }
Cole Faustfc438682021-12-14 12:46:32 -08001644 return NewInterpolateExpr(parts)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001645}
1646
1647// Handles the statements whose treatment is the same in all contexts: comment,
1648// assignment, variable (which is a macro call in reality) and all constructs that
1649// do not handle in any context ('define directive and any unrecognized stuff).
Cole Faustdd569ae2022-01-31 15:48:29 -08001650func (ctx *parseContext) handleSimpleStatement(node mkparser.Node) []starlarkNode {
1651 var result []starlarkNode
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001652 switch x := node.(type) {
1653 case *mkparser.Comment:
Cole Faustdd569ae2022-01-31 15:48:29 -08001654 if n, handled := ctx.maybeHandleAnnotation(x); handled && n != nil {
1655 result = []starlarkNode{n}
1656 } else if !handled {
1657 result = []starlarkNode{&commentNode{strings.TrimSpace("#" + x.Comment)}}
Cole Faust7940c6a2022-01-31 15:54:05 -08001658 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001659 case *mkparser.Assignment:
Cole Faustdd569ae2022-01-31 15:48:29 -08001660 result = ctx.handleAssignment(x)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001661 case *mkparser.Variable:
Cole Faustdd569ae2022-01-31 15:48:29 -08001662 result = ctx.handleVariable(x)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001663 case *mkparser.Directive:
1664 switch x.Name {
1665 case "define":
Cole Faustdd569ae2022-01-31 15:48:29 -08001666 if res := ctx.maybeHandleDefine(x); res != nil {
1667 result = []starlarkNode{res}
1668 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001669 case "include", "-include":
Cole Faustdd569ae2022-01-31 15:48:29 -08001670 result = ctx.handleInclude(node, ctx.parseMakeString(node, x.Args), x.Name[0] != '-')
Cole Faust591a1fe2021-11-08 15:37:57 -08001671 case "ifeq", "ifneq", "ifdef", "ifndef":
Cole Faustdd569ae2022-01-31 15:48:29 -08001672 result = []starlarkNode{ctx.handleIfBlock(x)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001673 default:
Cole Faustdd569ae2022-01-31 15:48:29 -08001674 result = []starlarkNode{ctx.newBadNode(x, "unexpected directive %s", x.Name)}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001675 }
1676 default:
Cole Faustdd569ae2022-01-31 15:48:29 -08001677 result = []starlarkNode{ctx.newBadNode(x, "unsupported line %s", strings.ReplaceAll(x.Dump(), "\n", "\n#"))}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001678 }
Cole Faust6c934f62022-01-06 15:51:12 -08001679
1680 // Clear the includeTops after each non-comment statement
1681 // so that include annotations placed on certain statements don't apply
1682 // globally for the rest of the makefile was well.
1683 if _, wasComment := node.(*mkparser.Comment); !wasComment && len(ctx.includeTops) > 0 {
1684 ctx.includeTops = []string{}
1685 }
Cole Faustdd569ae2022-01-31 15:48:29 -08001686
1687 if result == nil {
1688 result = []starlarkNode{}
1689 }
1690 return result
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001691}
1692
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001693// Processes annotation. An annotation is a comment that starts with #RBC# and provides
1694// a conversion hint -- say, where to look for the dynamically calculated inherit/include
Cole Faust7940c6a2022-01-31 15:54:05 -08001695// paths. Returns true if the comment was a successfully-handled annotation.
Cole Faustdd569ae2022-01-31 15:48:29 -08001696func (ctx *parseContext) maybeHandleAnnotation(cnode *mkparser.Comment) (starlarkNode, bool) {
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001697 maybeTrim := func(s, prefix string) (string, bool) {
1698 if strings.HasPrefix(s, prefix) {
1699 return strings.TrimSpace(strings.TrimPrefix(s, prefix)), true
1700 }
1701 return s, false
1702 }
1703 annotation, ok := maybeTrim(cnode.Comment, annotationCommentPrefix)
1704 if !ok {
Cole Faustdd569ae2022-01-31 15:48:29 -08001705 return nil, false
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001706 }
1707 if p, ok := maybeTrim(annotation, "include_top"); ok {
Cole Faustf7ed5342021-12-21 14:15:12 -08001708 // Don't allow duplicate include tops, because then we will generate
1709 // invalid starlark code. (duplicate keys in the _entry dictionary)
1710 for _, top := range ctx.includeTops {
1711 if top == p {
Cole Faustdd569ae2022-01-31 15:48:29 -08001712 return nil, true
Cole Faustf7ed5342021-12-21 14:15:12 -08001713 }
1714 }
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001715 ctx.includeTops = append(ctx.includeTops, p)
Cole Faustdd569ae2022-01-31 15:48:29 -08001716 return nil, true
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001717 }
Cole Faustdd569ae2022-01-31 15:48:29 -08001718 return ctx.newBadNode(cnode, "unsupported annotation %s", cnode.Comment), true
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001719}
1720
1721func (ctx *parseContext) loadedModulePath(path string) string {
1722 // During the transition to Roboleaf some of the product configuration files
1723 // will be converted and checked in while the others will be generated on the fly
1724 // and run. The runner (rbcrun application) accommodates this by allowing three
1725 // different ways to specify the loaded file location:
1726 // 1) load(":<file>",...) loads <file> from the same directory
1727 // 2) load("//path/relative/to/source/root:<file>", ...) loads <file> source tree
1728 // 3) load("/absolute/path/to/<file> absolute path
1729 // If the file being generated and the file it wants to load are in the same directory,
1730 // generate option 1.
1731 // Otherwise, if output directory is not specified, generate 2)
1732 // Finally, if output directory has been specified and the file being generated and
1733 // the file it wants to load from are in the different directories, generate 2) or 3):
1734 // * if the file being loaded exists in the source tree, generate 2)
1735 // * otherwise, generate 3)
1736 // Finally, figure out the loaded module path and name and create a node for it
1737 loadedModuleDir := filepath.Dir(path)
1738 base := filepath.Base(path)
1739 loadedModuleName := strings.TrimSuffix(base, filepath.Ext(base)) + ctx.outputSuffix
1740 if loadedModuleDir == filepath.Dir(ctx.script.mkFile) {
1741 return ":" + loadedModuleName
1742 }
1743 if ctx.outputDir == "" {
1744 return fmt.Sprintf("//%s:%s", loadedModuleDir, loadedModuleName)
1745 }
1746 if _, err := os.Stat(filepath.Join(loadedModuleDir, loadedModuleName)); err == nil {
1747 return fmt.Sprintf("//%s:%s", loadedModuleDir, loadedModuleName)
1748 }
1749 return filepath.Join(ctx.outputDir, loadedModuleDir, loadedModuleName)
1750}
1751
Sasha Smundak3deb9682021-07-26 18:42:25 -07001752func (ctx *parseContext) addSoongNamespace(ns string) {
1753 if _, ok := ctx.soongNamespaces[ns]; ok {
1754 return
1755 }
1756 ctx.soongNamespaces[ns] = make(map[string]bool)
1757}
1758
1759func (ctx *parseContext) hasSoongNamespace(name string) bool {
1760 _, ok := ctx.soongNamespaces[name]
1761 return ok
1762}
1763
1764func (ctx *parseContext) updateSoongNamespace(replace bool, namespaceName string, varNames []string) {
1765 ctx.addSoongNamespace(namespaceName)
1766 vars := ctx.soongNamespaces[namespaceName]
1767 if replace {
1768 vars = make(map[string]bool)
1769 ctx.soongNamespaces[namespaceName] = vars
1770 }
1771 for _, v := range varNames {
1772 vars[v] = true
1773 }
1774}
1775
1776func (ctx *parseContext) hasNamespaceVar(namespaceName string, varName string) bool {
1777 vars, ok := ctx.soongNamespaces[namespaceName]
1778 if ok {
1779 _, ok = vars[varName]
1780 }
1781 return ok
1782}
1783
Sasha Smundak422b6142021-11-11 18:31:59 -08001784func (ctx *parseContext) errorLocation(node mkparser.Node) ErrorLocation {
1785 return ErrorLocation{ctx.script.mkFile, ctx.script.nodeLocator(node.Pos())}
1786}
1787
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001788func (ss *StarlarkScript) String() string {
1789 return NewGenerateContext(ss).emit()
1790}
1791
1792func (ss *StarlarkScript) SubConfigFiles() []string {
Sasha Smundak6609ba72021-07-22 18:32:56 -07001793
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001794 var subs []string
1795 for _, src := range ss.inherited {
1796 subs = append(subs, src.originalPath)
1797 }
1798 return subs
1799}
1800
1801func (ss *StarlarkScript) HasErrors() bool {
1802 return ss.hasErrors
1803}
1804
1805// Convert reads and parses a makefile. If successful, parsed tree
1806// is returned and then can be passed to String() to get the generated
1807// Starlark file.
1808func Convert(req Request) (*StarlarkScript, error) {
1809 reader := req.Reader
1810 if reader == nil {
1811 mkContents, err := ioutil.ReadFile(req.MkFile)
1812 if err != nil {
1813 return nil, err
1814 }
1815 reader = bytes.NewBuffer(mkContents)
1816 }
1817 parser := mkparser.NewParser(req.MkFile, reader)
1818 nodes, errs := parser.Parse()
1819 if len(errs) > 0 {
1820 for _, e := range errs {
1821 fmt.Fprintln(os.Stderr, "ERROR:", e)
1822 }
1823 return nil, fmt.Errorf("bad makefile %s", req.MkFile)
1824 }
1825 starScript := &StarlarkScript{
Sasha Smundak422b6142021-11-11 18:31:59 -08001826 moduleName: moduleNameForFile(req.MkFile),
1827 mkFile: req.MkFile,
Sasha Smundak422b6142021-11-11 18:31:59 -08001828 traceCalls: req.TraceCalls,
1829 sourceFS: req.SourceFS,
1830 makefileFinder: req.MakefileFinder,
1831 nodeLocator: func(pos mkparser.Pos) int { return parser.Unpack(pos).Line },
Cole Faustdd569ae2022-01-31 15:48:29 -08001832 nodes: make([]starlarkNode, 0),
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001833 }
1834 ctx := newParseContext(starScript, nodes)
1835 ctx.outputSuffix = req.OutputSuffix
1836 ctx.outputDir = req.OutputDir
1837 ctx.errorLogger = req.ErrorLogger
1838 if len(req.TracedVariables) > 0 {
1839 ctx.tracedVariables = make(map[string]bool)
1840 for _, v := range req.TracedVariables {
1841 ctx.tracedVariables[v] = true
1842 }
1843 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001844 for ctx.hasNodes() && ctx.fatalError == nil {
Cole Faustdd569ae2022-01-31 15:48:29 -08001845 starScript.nodes = append(starScript.nodes, ctx.handleSimpleStatement(ctx.getNode())...)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001846 }
1847 if ctx.fatalError != nil {
1848 return nil, ctx.fatalError
1849 }
1850 return starScript, nil
1851}
1852
Cole Faust864028a2021-12-01 13:43:17 -08001853func Launcher(mainModuleUri, inputVariablesUri, mainModuleName string) string {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001854 var buf bytes.Buffer
1855 fmt.Fprintf(&buf, "load(%q, %q)\n", baseUri, baseName)
Cole Faust864028a2021-12-01 13:43:17 -08001856 fmt.Fprintf(&buf, "load(%q, input_variables_init = \"init\")\n", inputVariablesUri)
Sasha Smundakd7d07ad2021-09-10 15:42:34 -07001857 fmt.Fprintf(&buf, "load(%q, \"init\")\n", mainModuleUri)
Cole Faust864028a2021-12-01 13:43:17 -08001858 fmt.Fprintf(&buf, "%s(%s(%q, init, input_variables_init))\n", cfnPrintVars, cfnMain, mainModuleName)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001859 return buf.String()
1860}
1861
Cole Faust6ed7cb42021-10-07 17:08:46 -07001862func BoardLauncher(mainModuleUri string, inputVariablesUri string) string {
1863 var buf bytes.Buffer
1864 fmt.Fprintf(&buf, "load(%q, %q)\n", baseUri, baseName)
1865 fmt.Fprintf(&buf, "load(%q, \"init\")\n", mainModuleUri)
1866 fmt.Fprintf(&buf, "load(%q, input_variables_init = \"init\")\n", inputVariablesUri)
Cole Fausta0604662022-02-28 11:53:58 -08001867 fmt.Fprintf(&buf, "%s(%s(init, input_variables_init))\n", cfnPrintVars, cfnBoardMain)
Cole Faust6ed7cb42021-10-07 17:08:46 -07001868 return buf.String()
1869}
1870
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001871func MakePath2ModuleName(mkPath string) string {
1872 return strings.TrimSuffix(mkPath, filepath.Ext(mkPath))
1873}