blob: 0e39c32222429079294957acea43c03f02e6c5e1 [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:
53 cfnGetCfg = baseName + ".cfg"
54 cfnMain = baseName + ".product_configuration"
Cole Faust6ed7cb42021-10-07 17:08:46 -070055 cfnBoardMain = baseName + ".board_configuration"
Sasha Smundakb051c4e2020-11-05 20:45:07 -080056 cfnPrintVars = baseName + ".printvars"
Cole Faust6ed7cb42021-10-07 17:08:46 -070057 cfnPrintGlobals = baseName + ".printglobals"
Sasha Smundakb051c4e2020-11-05 20:45:07 -080058 cfnWarning = baseName + ".warning"
59 cfnLocalAppend = baseName + ".local_append"
60 cfnLocalSetDefault = baseName + ".local_set_default"
61 cfnInherit = baseName + ".inherit"
62 cfnSetListDefault = baseName + ".setdefault"
63)
64
65const (
66 // Phony makefile functions, they are eventually rewritten
67 // according to knownFunctions map
Sasha Smundak65b547e2021-09-17 15:35:41 -070068 fileExistsPhony = "$file_exists"
69 // The following two macros are obsolete, and will we deleted once
70 // there are deleted from the makefiles:
71 soongConfigNamespaceOld = "add_soong_config_namespace"
72 soongConfigVarSetOld = "add_soong_config_var_value"
73 soongConfigAppend = "soong_config_append"
74 soongConfigAssign = "soong_config_set"
Cole Faustc00184e2021-11-08 12:08:57 -080075 soongConfigGet = "soong_config_get"
Sasha Smundak65b547e2021-09-17 15:35:41 -070076 wildcardExistsPhony = "$wildcard_exists"
Sasha Smundakb051c4e2020-11-05 20:45:07 -080077)
78
79const (
80 callLoadAlways = "inherit-product"
81 callLoadIf = "inherit-product-if-exists"
82)
83
84var knownFunctions = map[string]struct {
85 // The name of the runtime function this function call in makefiles maps to.
86 // If it starts with !, then this makefile function call is rewritten to
87 // something else.
88 runtimeName string
89 returnType starlarkType
Sasha Smundak3deb9682021-07-26 18:42:25 -070090 hiddenArg hiddenArgType
Sasha Smundakb051c4e2020-11-05 20:45:07 -080091}{
Sasha Smundak3deb9682021-07-26 18:42:25 -070092 "abspath": {baseName + ".abspath", starlarkTypeString, hiddenArgNone},
93 fileExistsPhony: {baseName + ".file_exists", starlarkTypeBool, hiddenArgNone},
94 wildcardExistsPhony: {baseName + ".file_wildcard_exists", starlarkTypeBool, hiddenArgNone},
Sasha Smundak65b547e2021-09-17 15:35:41 -070095 soongConfigNamespaceOld: {baseName + ".soong_config_namespace", starlarkTypeVoid, hiddenArgGlobal},
96 soongConfigVarSetOld: {baseName + ".soong_config_set", starlarkTypeVoid, hiddenArgGlobal},
97 soongConfigAssign: {baseName + ".soong_config_set", starlarkTypeVoid, hiddenArgGlobal},
98 soongConfigAppend: {baseName + ".soong_config_append", starlarkTypeVoid, hiddenArgGlobal},
Cole Faustc00184e2021-11-08 12:08:57 -080099 soongConfigGet: {baseName + ".soong_config_get", starlarkTypeString, hiddenArgGlobal},
Sasha Smundak3deb9682021-07-26 18:42:25 -0700100 "add-to-product-copy-files-if-exists": {baseName + ".copy_if_exists", starlarkTypeList, hiddenArgNone},
101 "addprefix": {baseName + ".addprefix", starlarkTypeList, hiddenArgNone},
102 "addsuffix": {baseName + ".addsuffix", starlarkTypeList, hiddenArgNone},
103 "copy-files": {baseName + ".copy_files", starlarkTypeList, hiddenArgNone},
104 "dir": {baseName + ".dir", starlarkTypeList, hiddenArgNone},
105 "enforce-product-packages-exist": {baseName + ".enforce_product_packages_exist", starlarkTypeVoid, hiddenArgNone},
106 "error": {baseName + ".mkerror", starlarkTypeVoid, hiddenArgNone},
107 "findstring": {"!findstring", starlarkTypeInt, hiddenArgNone},
108 "find-copy-subdir-files": {baseName + ".find_and_copy", starlarkTypeList, hiddenArgNone},
109 "find-word-in-list": {"!find-word-in-list", starlarkTypeUnknown, hiddenArgNone}, // internal macro
110 "filter": {baseName + ".filter", starlarkTypeList, hiddenArgNone},
111 "filter-out": {baseName + ".filter_out", starlarkTypeList, hiddenArgNone},
112 "firstword": {"!firstword", starlarkTypeString, hiddenArgNone},
113 "get-vendor-board-platforms": {"!get-vendor-board-platforms", starlarkTypeList, hiddenArgNone}, // internal macro, used by is-board-platform, etc.
114 "info": {baseName + ".mkinfo", starlarkTypeVoid, hiddenArgNone},
115 "is-android-codename": {"!is-android-codename", starlarkTypeBool, hiddenArgNone}, // unused by product config
116 "is-android-codename-in-list": {"!is-android-codename-in-list", starlarkTypeBool, hiddenArgNone}, // unused by product config
117 "is-board-platform": {"!is-board-platform", starlarkTypeBool, hiddenArgNone},
Sasha Smundak3a9b8e82021-08-25 14:11:04 -0700118 "is-board-platform2": {baseName + ".board_platform_is", starlarkTypeBool, hiddenArgGlobal},
Sasha Smundak3deb9682021-07-26 18:42:25 -0700119 "is-board-platform-in-list": {"!is-board-platform-in-list", starlarkTypeBool, hiddenArgNone},
Sasha Smundak3a9b8e82021-08-25 14:11:04 -0700120 "is-board-platform-in-list2": {baseName + ".board_platform_in", starlarkTypeBool, hiddenArgGlobal},
Sasha Smundak3deb9682021-07-26 18:42:25 -0700121 "is-chipset-in-board-platform": {"!is-chipset-in-board-platform", starlarkTypeUnknown, hiddenArgNone}, // unused by product config
122 "is-chipset-prefix-in-board-platform": {"!is-chipset-prefix-in-board-platform", starlarkTypeBool, hiddenArgNone}, // unused by product config
123 "is-not-board-platform": {"!is-not-board-platform", starlarkTypeBool, hiddenArgNone}, // defined but never used
124 "is-platform-sdk-version-at-least": {"!is-platform-sdk-version-at-least", starlarkTypeBool, hiddenArgNone}, // unused by product config
125 "is-product-in-list": {"!is-product-in-list", starlarkTypeBool, hiddenArgNone},
126 "is-vendor-board-platform": {"!is-vendor-board-platform", starlarkTypeBool, hiddenArgNone},
Sasha Smundak3a9b8e82021-08-25 14:11:04 -0700127 "is-vendor-board-qcom": {"!is-vendor-board-qcom", starlarkTypeBool, hiddenArgNone},
Sasha Smundak3deb9682021-07-26 18:42:25 -0700128 callLoadAlways: {"!inherit-product", starlarkTypeVoid, hiddenArgNone},
129 callLoadIf: {"!inherit-product-if-exists", starlarkTypeVoid, hiddenArgNone},
130 "lastword": {"!lastword", starlarkTypeString, hiddenArgNone},
131 "match-prefix": {"!match-prefix", starlarkTypeUnknown, hiddenArgNone}, // internal macro
132 "match-word": {"!match-word", starlarkTypeUnknown, hiddenArgNone}, // internal macro
133 "match-word-in-list": {"!match-word-in-list", starlarkTypeUnknown, hiddenArgNone}, // internal macro
134 "notdir": {baseName + ".notdir", starlarkTypeString, hiddenArgNone},
135 "my-dir": {"!my-dir", starlarkTypeString, hiddenArgNone},
136 "patsubst": {baseName + ".mkpatsubst", starlarkTypeString, hiddenArgNone},
Sasha Smundak04453082021-08-17 18:14:41 -0700137 "product-copy-files-by-pattern": {baseName + ".product_copy_files_by_pattern", starlarkTypeList, hiddenArgNone},
Sasha Smundak3deb9682021-07-26 18:42:25 -0700138 "require-artifacts-in-path": {baseName + ".require_artifacts_in_path", starlarkTypeVoid, hiddenArgNone},
139 "require-artifacts-in-path-relaxed": {baseName + ".require_artifacts_in_path_relaxed", starlarkTypeVoid, hiddenArgNone},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800140 // TODO(asmundak): remove it once all calls are removed from configuration makefiles. see b/183161002
Sasha Smundak3deb9682021-07-26 18:42:25 -0700141 "shell": {baseName + ".shell", starlarkTypeString, hiddenArgNone},
142 "strip": {baseName + ".mkstrip", starlarkTypeString, hiddenArgNone},
143 "tb-modules": {"!tb-modules", starlarkTypeUnknown, hiddenArgNone}, // defined in hardware/amlogic/tb_modules/tb_detect.mk, unused
144 "subst": {baseName + ".mksubst", starlarkTypeString, hiddenArgNone},
145 "warning": {baseName + ".mkwarning", starlarkTypeVoid, hiddenArgNone},
146 "word": {baseName + "!word", starlarkTypeString, hiddenArgNone},
147 "wildcard": {baseName + ".expand_wildcard", starlarkTypeList, hiddenArgNone},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800148}
149
150var builtinFuncRex = regexp.MustCompile(
151 "^(addprefix|addsuffix|abspath|and|basename|call|dir|error|eval" +
152 "|flavor|foreach|file|filter|filter-out|findstring|firstword|guile" +
153 "|if|info|join|lastword|notdir|or|origin|patsubst|realpath" +
154 "|shell|sort|strip|subst|suffix|value|warning|word|wordlist|words" +
155 "|wildcard)")
156
157// Conversion request parameters
158type Request struct {
159 MkFile string // file to convert
160 Reader io.Reader // if set, read input from this stream instead
161 RootDir string // root directory path used to resolve included files
162 OutputSuffix string // generated Starlark files suffix
163 OutputDir string // if set, root of the output hierarchy
164 ErrorLogger ErrorMonitorCB
165 TracedVariables []string // trace assignment to these variables
166 TraceCalls bool
167 WarnPartialSuccess bool
Sasha Smundak6609ba72021-07-22 18:32:56 -0700168 SourceFS fs.FS
169 MakefileFinder MakefileFinder
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800170}
171
172// An error sink allowing to gather error statistics.
173// NewError is called on every error encountered during processing.
174type ErrorMonitorCB interface {
175 NewError(s string, node mkparser.Node, args ...interface{})
176}
177
178// Derives module name for a given file. It is base name
179// (file name without suffix), with some characters replaced to make it a Starlark identifier
180func moduleNameForFile(mkFile string) string {
181 base := strings.TrimSuffix(filepath.Base(mkFile), filepath.Ext(mkFile))
182 // TODO(asmundak): what else can be in the product file names?
Sasha Smundak6609ba72021-07-22 18:32:56 -0700183 return strings.NewReplacer("-", "_", ".", "_").Replace(base)
184
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800185}
186
187func cloneMakeString(mkString *mkparser.MakeString) *mkparser.MakeString {
188 r := &mkparser.MakeString{StringPos: mkString.StringPos}
189 r.Strings = append(r.Strings, mkString.Strings...)
190 r.Variables = append(r.Variables, mkString.Variables...)
191 return r
192}
193
194func isMakeControlFunc(s string) bool {
195 return s == "error" || s == "warning" || s == "info"
196}
197
198// Starlark output generation context
199type generationContext struct {
200 buf strings.Builder
201 starScript *StarlarkScript
202 indentLevel int
203 inAssignment bool
204 tracedCount int
205}
206
207func NewGenerateContext(ss *StarlarkScript) *generationContext {
208 return &generationContext{starScript: ss}
209}
210
211// emit returns generated script
212func (gctx *generationContext) emit() string {
213 ss := gctx.starScript
214
215 // The emitted code has the following layout:
216 // <initial comments>
217 // preamble, i.e.,
218 // load statement for the runtime support
219 // load statement for each unique submodule pulled in by this one
220 // def init(g, handle):
221 // cfg = rblf.cfg(handle)
222 // <statements>
223 // <warning if conversion was not clean>
224
225 iNode := len(ss.nodes)
226 for i, node := range ss.nodes {
227 if _, ok := node.(*commentNode); !ok {
228 iNode = i
229 break
230 }
231 node.emit(gctx)
232 }
233
234 gctx.emitPreamble()
235
236 gctx.newLine()
237 // The arguments passed to the init function are the global dictionary
238 // ('g') and the product configuration dictionary ('cfg')
239 gctx.write("def init(g, handle):")
240 gctx.indentLevel++
241 if gctx.starScript.traceCalls {
242 gctx.newLine()
243 gctx.writef(`print(">%s")`, gctx.starScript.mkFile)
244 }
245 gctx.newLine()
246 gctx.writef("cfg = %s(handle)", cfnGetCfg)
247 for _, node := range ss.nodes[iNode:] {
248 node.emit(gctx)
249 }
250
251 if ss.hasErrors && ss.warnPartialSuccess {
252 gctx.newLine()
253 gctx.writef("%s(%q, %q)", cfnWarning, filepath.Base(ss.mkFile), "partially successful conversion")
254 }
255 if gctx.starScript.traceCalls {
256 gctx.newLine()
257 gctx.writef(`print("<%s")`, gctx.starScript.mkFile)
258 }
259 gctx.indentLevel--
260 gctx.write("\n")
261 return gctx.buf.String()
262}
263
264func (gctx *generationContext) emitPreamble() {
265 gctx.newLine()
266 gctx.writef("load(%q, %q)", baseUri, baseName)
267 // Emit exactly one load statement for each URI.
268 loadedSubConfigs := make(map[string]string)
269 for _, sc := range gctx.starScript.inherited {
270 uri := sc.path
271 if m, ok := loadedSubConfigs[uri]; ok {
272 // No need to emit load statement, but fix module name.
273 sc.moduleLocalName = m
274 continue
275 }
Sasha Smundak6609ba72021-07-22 18:32:56 -0700276 if sc.optional {
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800277 uri += "|init"
278 }
279 gctx.newLine()
280 gctx.writef("load(%q, %s = \"init\")", uri, sc.entryName())
281 loadedSubConfigs[uri] = sc.moduleLocalName
282 }
283 gctx.write("\n")
284}
285
286func (gctx *generationContext) emitPass() {
287 gctx.newLine()
288 gctx.write("pass")
289}
290
291func (gctx *generationContext) write(ss ...string) {
292 for _, s := range ss {
293 gctx.buf.WriteString(s)
294 }
295}
296
297func (gctx *generationContext) writef(format string, args ...interface{}) {
298 gctx.write(fmt.Sprintf(format, args...))
299}
300
301func (gctx *generationContext) newLine() {
302 if gctx.buf.Len() == 0 {
303 return
304 }
305 gctx.write("\n")
306 gctx.writef("%*s", 2*gctx.indentLevel, "")
307}
308
309type knownVariable struct {
310 name string
311 class varClass
312 valueType starlarkType
313}
314
315type knownVariables map[string]knownVariable
316
317func (pcv knownVariables) NewVariable(name string, varClass varClass, valueType starlarkType) {
318 v, exists := pcv[name]
319 if !exists {
320 pcv[name] = knownVariable{name, varClass, valueType}
321 return
322 }
323 // Conflict resolution:
324 // * config class trumps everything
325 // * any type trumps unknown type
326 match := varClass == v.class
327 if !match {
328 if varClass == VarClassConfig {
329 v.class = VarClassConfig
330 match = true
331 } else if v.class == VarClassConfig {
332 match = true
333 }
334 }
335 if valueType != v.valueType {
336 if valueType != starlarkTypeUnknown {
337 if v.valueType == starlarkTypeUnknown {
338 v.valueType = valueType
339 } else {
340 match = false
341 }
342 }
343 }
344 if !match {
345 fmt.Fprintf(os.Stderr, "cannot redefine %s as %v/%v (already defined as %v/%v)\n",
346 name, varClass, valueType, v.class, v.valueType)
347 }
348}
349
350// All known product variables.
351var KnownVariables = make(knownVariables)
352
353func init() {
354 for _, kv := range []string{
355 // Kernel-related variables that we know are lists.
356 "BOARD_VENDOR_KERNEL_MODULES",
357 "BOARD_VENDOR_RAMDISK_KERNEL_MODULES",
358 "BOARD_VENDOR_RAMDISK_KERNEL_MODULES_LOAD",
359 "BOARD_RECOVERY_KERNEL_MODULES",
360 // Other variables we knwo are lists
361 "ART_APEX_JARS",
362 } {
363 KnownVariables.NewVariable(kv, VarClassSoong, starlarkTypeList)
364 }
365}
366
367type nodeReceiver interface {
368 newNode(node starlarkNode)
369}
370
371// Information about the generated Starlark script.
372type StarlarkScript struct {
373 mkFile string
374 moduleName string
375 mkPos scanner.Position
376 nodes []starlarkNode
Sasha Smundak6609ba72021-07-22 18:32:56 -0700377 inherited []*moduleInfo
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800378 hasErrors bool
379 topDir string
380 traceCalls bool // print enter/exit each init function
381 warnPartialSuccess bool
Sasha Smundak6609ba72021-07-22 18:32:56 -0700382 sourceFS fs.FS
383 makefileFinder MakefileFinder
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800384}
385
386func (ss *StarlarkScript) newNode(node starlarkNode) {
387 ss.nodes = append(ss.nodes, node)
388}
389
390// varAssignmentScope points to the last assignment for each variable
391// in the current block. It is used during the parsing to chain
392// the assignments to a variable together.
393type varAssignmentScope struct {
394 outer *varAssignmentScope
395 vars map[string]*assignmentNode
396}
397
398// parseContext holds the script we are generating and all the ephemeral data
399// needed during the parsing.
400type parseContext struct {
401 script *StarlarkScript
402 nodes []mkparser.Node // Makefile as parsed by mkparser
403 currentNodeIndex int // Node in it we are processing
404 ifNestLevel int
405 moduleNameCount map[string]int // count of imported modules with given basename
406 fatalError error
407 builtinMakeVars map[string]starlarkExpr
408 outputSuffix string
409 errorLogger ErrorMonitorCB
410 tracedVariables map[string]bool // variables to be traced in the generated script
411 variables map[string]variable
412 varAssignments *varAssignmentScope
413 receiver nodeReceiver // receptacle for the generated starlarkNode's
414 receiverStack []nodeReceiver
415 outputDir string
Sasha Smundak6609ba72021-07-22 18:32:56 -0700416 dependentModules map[string]*moduleInfo
Sasha Smundak3deb9682021-07-26 18:42:25 -0700417 soongNamespaces map[string]map[string]bool
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700418 includeTops []string
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800419}
420
421func newParseContext(ss *StarlarkScript, nodes []mkparser.Node) *parseContext {
Sasha Smundak6609ba72021-07-22 18:32:56 -0700422 topdir, _ := filepath.Split(filepath.Join(ss.topDir, "foo"))
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800423 predefined := []struct{ name, value string }{
424 {"SRC_TARGET_DIR", filepath.Join("build", "make", "target")},
425 {"LOCAL_PATH", filepath.Dir(ss.mkFile)},
Sasha Smundak6609ba72021-07-22 18:32:56 -0700426 {"TOPDIR", topdir},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800427 // TODO(asmundak): maybe read it from build/make/core/envsetup.mk?
428 {"TARGET_COPY_OUT_SYSTEM", "system"},
429 {"TARGET_COPY_OUT_SYSTEM_OTHER", "system_other"},
430 {"TARGET_COPY_OUT_DATA", "data"},
431 {"TARGET_COPY_OUT_ASAN", filepath.Join("data", "asan")},
432 {"TARGET_COPY_OUT_OEM", "oem"},
433 {"TARGET_COPY_OUT_RAMDISK", "ramdisk"},
434 {"TARGET_COPY_OUT_DEBUG_RAMDISK", "debug_ramdisk"},
435 {"TARGET_COPY_OUT_VENDOR_DEBUG_RAMDISK", "vendor_debug_ramdisk"},
436 {"TARGET_COPY_OUT_TEST_HARNESS_RAMDISK", "test_harness_ramdisk"},
437 {"TARGET_COPY_OUT_ROOT", "root"},
438 {"TARGET_COPY_OUT_RECOVERY", "recovery"},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800439 {"TARGET_COPY_OUT_VENDOR_RAMDISK", "vendor_ramdisk"},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800440 // TODO(asmundak): to process internal config files, we need the following variables:
441 // BOARD_CONFIG_VENDOR_PATH
442 // TARGET_VENDOR
443 // target_base_product
444 //
445
446 // the following utility variables are set in build/make/common/core.mk:
447 {"empty", ""},
448 {"space", " "},
449 {"comma", ","},
450 {"newline", "\n"},
451 {"pound", "#"},
452 {"backslash", "\\"},
453 }
454 ctx := &parseContext{
455 script: ss,
456 nodes: nodes,
457 currentNodeIndex: 0,
458 ifNestLevel: 0,
459 moduleNameCount: make(map[string]int),
460 builtinMakeVars: map[string]starlarkExpr{},
461 variables: make(map[string]variable),
Sasha Smundak6609ba72021-07-22 18:32:56 -0700462 dependentModules: make(map[string]*moduleInfo),
Sasha Smundak3deb9682021-07-26 18:42:25 -0700463 soongNamespaces: make(map[string]map[string]bool),
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700464 includeTops: []string{"vendor/google-devices"},
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800465 }
466 ctx.pushVarAssignments()
467 for _, item := range predefined {
468 ctx.variables[item.name] = &predefinedVariable{
469 baseVariable: baseVariable{nam: item.name, typ: starlarkTypeString},
470 value: &stringLiteralExpr{item.value},
471 }
472 }
473
474 return ctx
475}
476
477func (ctx *parseContext) lastAssignment(name string) *assignmentNode {
478 for va := ctx.varAssignments; va != nil; va = va.outer {
479 if v, ok := va.vars[name]; ok {
480 return v
481 }
482 }
483 return nil
484}
485
486func (ctx *parseContext) setLastAssignment(name string, asgn *assignmentNode) {
487 ctx.varAssignments.vars[name] = asgn
488}
489
490func (ctx *parseContext) pushVarAssignments() {
491 va := &varAssignmentScope{
492 outer: ctx.varAssignments,
493 vars: make(map[string]*assignmentNode),
494 }
495 ctx.varAssignments = va
496}
497
498func (ctx *parseContext) popVarAssignments() {
499 ctx.varAssignments = ctx.varAssignments.outer
500}
501
502func (ctx *parseContext) pushReceiver(rcv nodeReceiver) {
503 ctx.receiverStack = append(ctx.receiverStack, ctx.receiver)
504 ctx.receiver = rcv
505}
506
507func (ctx *parseContext) popReceiver() {
508 last := len(ctx.receiverStack) - 1
509 if last < 0 {
510 panic(fmt.Errorf("popReceiver: receiver stack empty"))
511 }
512 ctx.receiver = ctx.receiverStack[last]
513 ctx.receiverStack = ctx.receiverStack[0:last]
514}
515
516func (ctx *parseContext) hasNodes() bool {
517 return ctx.currentNodeIndex < len(ctx.nodes)
518}
519
520func (ctx *parseContext) getNode() mkparser.Node {
521 if !ctx.hasNodes() {
522 return nil
523 }
524 node := ctx.nodes[ctx.currentNodeIndex]
525 ctx.currentNodeIndex++
526 return node
527}
528
529func (ctx *parseContext) backNode() {
530 if ctx.currentNodeIndex <= 0 {
531 panic("Cannot back off")
532 }
533 ctx.currentNodeIndex--
534}
535
536func (ctx *parseContext) handleAssignment(a *mkparser.Assignment) {
537 // Handle only simple variables
538 if !a.Name.Const() {
539 ctx.errorf(a, "Only simple variables are handled")
540 return
541 }
542 name := a.Name.Strings[0]
Sasha Smundakea3bc3a2021-11-10 13:06:42 -0800543 // The `override` directive
544 // override FOO :=
545 // is parsed as an assignment to a variable named `override FOO`.
546 // There are very few places where `override` is used, just flag it.
547 if strings.HasPrefix(name, "override ") {
548 ctx.errorf(a, "cannot handle override directive")
549 }
550
Cole Faustc00184e2021-11-08 12:08:57 -0800551 // Soong configuration
Sasha Smundak3deb9682021-07-26 18:42:25 -0700552 if strings.HasPrefix(name, soongNsPrefix) {
553 ctx.handleSoongNsAssignment(strings.TrimPrefix(name, soongNsPrefix), a)
554 return
555 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800556 lhs := ctx.addVariable(name)
557 if lhs == nil {
558 ctx.errorf(a, "unknown variable %s", name)
559 return
560 }
561 _, isTraced := ctx.tracedVariables[name]
562 asgn := &assignmentNode{lhs: lhs, mkValue: a.Value, isTraced: isTraced}
563 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 {
567 ctx.wrapBadExpr(xBad)
568 return
569 }
570 inferred_type := asgn.value.typ()
571 if inferred_type != starlarkTypeUnknown {
Sasha Smundak9d011ab2021-07-09 16:00:57 -0700572 lhs.setValueType(inferred_type)
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800573 }
574 }
575 if lhs.valueType() == starlarkTypeList {
576 xConcat := ctx.buildConcatExpr(a)
577 if xConcat == nil {
578 return
579 }
580 switch len(xConcat.items) {
581 case 0:
582 asgn.value = &listExpr{}
583 case 1:
584 asgn.value = xConcat.items[0]
585 default:
586 asgn.value = xConcat
587 }
588 } else {
589 asgn.value = ctx.parseMakeString(a, a.Value)
590 if xBad, ok := asgn.value.(*badExpr); ok {
591 ctx.wrapBadExpr(xBad)
592 return
593 }
594 }
595
596 // TODO(asmundak): move evaluation to a separate pass
597 asgn.value, _ = asgn.value.eval(ctx.builtinMakeVars)
598
599 asgn.previous = ctx.lastAssignment(name)
600 ctx.setLastAssignment(name, asgn)
601 switch a.Type {
602 case "=", ":=":
603 asgn.flavor = asgnSet
604 case "+=":
605 if asgn.previous == nil && !asgn.lhs.isPreset() {
606 asgn.flavor = asgnMaybeAppend
607 } else {
608 asgn.flavor = asgnAppend
609 }
610 case "?=":
611 asgn.flavor = asgnMaybeSet
612 default:
613 panic(fmt.Errorf("unexpected assignment type %s", a.Type))
614 }
615
616 ctx.receiver.newNode(asgn)
617}
618
Sasha Smundak3deb9682021-07-26 18:42:25 -0700619func (ctx *parseContext) handleSoongNsAssignment(name string, asgn *mkparser.Assignment) {
620 val := ctx.parseMakeString(asgn, asgn.Value)
621 if xBad, ok := val.(*badExpr); ok {
622 ctx.wrapBadExpr(xBad)
623 return
624 }
625 val, _ = val.eval(ctx.builtinMakeVars)
626
627 // Unfortunately, Soong namespaces can be set up by directly setting corresponding Make
628 // variables instead of via add_soong_config_namespace + add_soong_config_var_value.
629 // Try to divine the call from the assignment as follows:
630 if name == "NAMESPACES" {
631 // Upon seeng
632 // SOONG_CONFIG_NAMESPACES += foo
633 // remember that there is a namespace `foo` and act as we saw
634 // $(call add_soong_config_namespace,foo)
635 s, ok := maybeString(val)
636 if !ok {
637 ctx.errorf(asgn, "cannot handle variables in SOONG_CONFIG_NAMESPACES assignment, please use add_soong_config_namespace instead")
638 return
639 }
640 for _, ns := range strings.Fields(s) {
641 ctx.addSoongNamespace(ns)
642 ctx.receiver.newNode(&exprNode{&callExpr{
Sasha Smundak65b547e2021-09-17 15:35:41 -0700643 name: soongConfigNamespaceOld,
Sasha Smundak3deb9682021-07-26 18:42:25 -0700644 args: []starlarkExpr{&stringLiteralExpr{ns}},
645 returnType: starlarkTypeVoid,
646 }})
647 }
648 } else {
649 // Upon seeing
650 // SOONG_CONFIG_x_y = v
651 // find a namespace called `x` and act as if we encountered
Cole Faustc00184e2021-11-08 12:08:57 -0800652 // $(call soong_config_set,x,y,v)
Sasha Smundak3deb9682021-07-26 18:42:25 -0700653 // or check that `x_y` is a namespace, and then add the RHS of this assignment as variables in
654 // it.
655 // Emit an error in the ambiguous situation (namespaces `foo_bar` with a variable `baz`
656 // and `foo` with a variable `bar_baz`.
657 namespaceName := ""
658 if ctx.hasSoongNamespace(name) {
659 namespaceName = name
660 }
661 var varName string
662 for pos, ch := range name {
663 if !(ch == '_' && ctx.hasSoongNamespace(name[0:pos])) {
664 continue
665 }
666 if namespaceName != "" {
667 ctx.errorf(asgn, "ambiguous soong namespace (may be either `%s` or `%s`)", namespaceName, name[0:pos])
668 return
669 }
670 namespaceName = name[0:pos]
671 varName = name[pos+1:]
672 }
673 if namespaceName == "" {
674 ctx.errorf(asgn, "cannot figure out Soong namespace, please use add_soong_config_var_value macro instead")
675 return
676 }
677 if varName == "" {
678 // Remember variables in this namespace
679 s, ok := maybeString(val)
680 if !ok {
681 ctx.errorf(asgn, "cannot handle variables in SOONG_CONFIG_ assignment, please use add_soong_config_var_value instead")
682 return
683 }
684 ctx.updateSoongNamespace(asgn.Type != "+=", namespaceName, strings.Fields(s))
685 return
686 }
687
688 // Finally, handle assignment to a namespace variable
689 if !ctx.hasNamespaceVar(namespaceName, varName) {
690 ctx.errorf(asgn, "no %s variable in %s namespace, please use add_soong_config_var_value instead", varName, namespaceName)
691 return
692 }
Cole Faustc00184e2021-11-08 12:08:57 -0800693 fname := soongConfigAssign
Sasha Smundak65b547e2021-09-17 15:35:41 -0700694 if asgn.Type == "+=" {
695 fname = soongConfigAppend
696 }
Sasha Smundak3deb9682021-07-26 18:42:25 -0700697 ctx.receiver.newNode(&exprNode{&callExpr{
Sasha Smundak65b547e2021-09-17 15:35:41 -0700698 name: fname,
Sasha Smundak3deb9682021-07-26 18:42:25 -0700699 args: []starlarkExpr{&stringLiteralExpr{namespaceName}, &stringLiteralExpr{varName}, val},
700 returnType: starlarkTypeVoid,
701 }})
702 }
703}
704
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800705func (ctx *parseContext) buildConcatExpr(a *mkparser.Assignment) *concatExpr {
706 xConcat := &concatExpr{}
707 var xItemList *listExpr
708 addToItemList := func(x ...starlarkExpr) {
709 if xItemList == nil {
710 xItemList = &listExpr{[]starlarkExpr{}}
711 }
712 xItemList.items = append(xItemList.items, x...)
713 }
714 finishItemList := func() {
715 if xItemList != nil {
716 xConcat.items = append(xConcat.items, xItemList)
717 xItemList = nil
718 }
719 }
720
721 items := a.Value.Words()
722 for _, item := range items {
723 // A function call in RHS is supposed to return a list, all other item
724 // expressions return individual elements.
725 switch x := ctx.parseMakeString(a, item).(type) {
726 case *badExpr:
727 ctx.wrapBadExpr(x)
728 return nil
729 case *stringLiteralExpr:
730 addToItemList(maybeConvertToStringList(x).(*listExpr).items...)
731 default:
732 switch x.typ() {
733 case starlarkTypeList:
734 finishItemList()
735 xConcat.items = append(xConcat.items, x)
736 case starlarkTypeString:
737 finishItemList()
738 xConcat.items = append(xConcat.items, &callExpr{
739 object: x,
740 name: "split",
741 args: nil,
742 returnType: starlarkTypeList,
743 })
744 default:
745 addToItemList(x)
746 }
747 }
748 }
749 if xItemList != nil {
750 xConcat.items = append(xConcat.items, xItemList)
751 }
752 return xConcat
753}
754
Sasha Smundak6609ba72021-07-22 18:32:56 -0700755func (ctx *parseContext) newDependentModule(path string, optional bool) *moduleInfo {
756 modulePath := ctx.loadedModulePath(path)
757 if mi, ok := ctx.dependentModules[modulePath]; ok {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700758 mi.optional = mi.optional && optional
Sasha Smundak6609ba72021-07-22 18:32:56 -0700759 return mi
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800760 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800761 moduleName := moduleNameForFile(path)
762 moduleLocalName := "_" + moduleName
763 n, found := ctx.moduleNameCount[moduleName]
764 if found {
765 moduleLocalName += fmt.Sprintf("%d", n)
766 }
767 ctx.moduleNameCount[moduleName] = n + 1
Sasha Smundak6609ba72021-07-22 18:32:56 -0700768 mi := &moduleInfo{
769 path: modulePath,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800770 originalPath: path,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800771 moduleLocalName: moduleLocalName,
Sasha Smundak6609ba72021-07-22 18:32:56 -0700772 optional: optional,
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800773 }
Sasha Smundak6609ba72021-07-22 18:32:56 -0700774 ctx.dependentModules[modulePath] = mi
775 ctx.script.inherited = append(ctx.script.inherited, mi)
776 return mi
777}
778
779func (ctx *parseContext) handleSubConfig(
780 v mkparser.Node, pathExpr starlarkExpr, loadAlways bool, processModule func(inheritedModule)) {
781 pathExpr, _ = pathExpr.eval(ctx.builtinMakeVars)
782
783 // 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 {
790 for _, p := range paths {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700791 mi := ctx.newDependentModule(p, !moduleShouldExist)
792 processModule(inheritedStaticModule{mi, loadAlways})
Sasha Smundak6609ba72021-07-22 18:32:56 -0700793 }
794 } else {
795 ctx.errorf(v, "cannot glob wildcard argument")
796 }
797 } else {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700798 mi := ctx.newDependentModule(path, !moduleShouldExist)
799 processModule(inheritedStaticModule{mi, loadAlways})
Sasha Smundak6609ba72021-07-22 18:32:56 -0700800 }
801 return
802 }
803
804 // If module path references variables (e.g., $(v1)/foo/$(v2)/device-config.mk), find all the paths in the
805 // source tree that may be a match and the corresponding variable values. For instance, if the source tree
806 // contains vendor1/foo/abc/dev.mk and vendor2/foo/def/dev.mk, the first one will be inherited when
807 // (v1, v2) == ('vendor1', 'abc'), and the second one when (v1, v2) == ('vendor2', 'def').
808 // We then emit the code that loads all of them, e.g.:
809 // load("//vendor1/foo/abc:dev.rbc", _dev1_init="init")
810 // load("//vendor2/foo/def/dev.rbc", _dev2_init="init")
811 // And then inherit it as follows:
812 // _e = {
813 // "vendor1/foo/abc/dev.mk": ("vendor1/foo/abc/dev", _dev1_init),
814 // "vendor2/foo/def/dev.mk": ("vendor2/foo/def/dev", _dev_init2) }.get("%s/foo/%s/dev.mk" % (v1, v2))
815 // if _e:
816 // rblf.inherit(handle, _e[0], _e[1])
817 //
818 var matchingPaths []string
819 varPath, ok := pathExpr.(*interpolateExpr)
820 if !ok {
821 ctx.errorf(v, "inherit-product/include argument is too complex")
822 return
823 }
824
825 pathPattern := []string{varPath.chunks[0]}
826 for _, chunk := range varPath.chunks[1:] {
827 if chunk != "" {
828 pathPattern = append(pathPattern, chunk)
829 }
830 }
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700831 if pathPattern[0] == "" {
832 // If pattern starts from the top. restrict it to the directories where
833 // we know inherit-product uses dynamically calculated path.
834 for _, p := range ctx.includeTops {
835 pathPattern[0] = p
836 matchingPaths = append(matchingPaths, ctx.findMatchingPaths(pathPattern)...)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700837 }
Sasha Smundak6d852dd2021-09-27 20:34:39 -0700838 } else {
839 matchingPaths = ctx.findMatchingPaths(pathPattern)
Sasha Smundak6609ba72021-07-22 18:32:56 -0700840 }
841 // Safeguard against $(call inherit-product,$(PRODUCT_PATH))
Sasha Smundak90be8c52021-08-03 11:06:10 -0700842 const maxMatchingFiles = 150
Sasha Smundak6609ba72021-07-22 18:32:56 -0700843 if len(matchingPaths) > maxMatchingFiles {
844 ctx.errorf(v, "there are >%d files matching the pattern, please rewrite it", maxMatchingFiles)
845 return
846 }
847 res := inheritedDynamicModule{*varPath, []*moduleInfo{}, loadAlways}
848 for _, p := range matchingPaths {
849 // A product configuration files discovered dynamically may attempt to inherit
850 // from another one which does not exist in this source tree. Prevent load errors
851 // by always loading the dynamic files as optional.
852 res.candidateModules = append(res.candidateModules, ctx.newDependentModule(p, true))
853 }
854 processModule(res)
855}
856
857func (ctx *parseContext) findMatchingPaths(pattern []string) []string {
858 files := ctx.script.makefileFinder.Find(ctx.script.topDir)
859 if len(pattern) == 0 {
860 return files
861 }
862
863 // Create regular expression from the pattern
864 s_regexp := "^" + regexp.QuoteMeta(pattern[0])
865 for _, s := range pattern[1:] {
866 s_regexp += ".*" + regexp.QuoteMeta(s)
867 }
868 s_regexp += "$"
869 rex := regexp.MustCompile(s_regexp)
870
871 // Now match
872 var res []string
873 for _, p := range files {
874 if rex.MatchString(p) {
875 res = append(res, p)
876 }
877 }
878 return res
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800879}
880
881func (ctx *parseContext) handleInheritModule(v mkparser.Node, pathExpr starlarkExpr, loadAlways bool) {
Sasha Smundak6609ba72021-07-22 18:32:56 -0700882 ctx.handleSubConfig(v, pathExpr, loadAlways, func(im inheritedModule) {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700883 ctx.receiver.newNode(&inheritNode{im, loadAlways})
Sasha Smundak6609ba72021-07-22 18:32:56 -0700884 })
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800885}
886
887func (ctx *parseContext) handleInclude(v mkparser.Node, pathExpr starlarkExpr, loadAlways bool) {
Sasha Smundak6609ba72021-07-22 18:32:56 -0700888 ctx.handleSubConfig(v, pathExpr, loadAlways, func(im inheritedModule) {
Sasha Smundak868c5e32021-09-23 16:20:58 -0700889 ctx.receiver.newNode(&includeNode{im, loadAlways})
Sasha Smundak6609ba72021-07-22 18:32:56 -0700890 })
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800891}
892
893func (ctx *parseContext) handleVariable(v *mkparser.Variable) {
894 // Handle:
895 // $(call inherit-product,...)
896 // $(call inherit-product-if-exists,...)
897 // $(info xxx)
898 // $(warning xxx)
899 // $(error xxx)
900 expr := ctx.parseReference(v, v.Name)
901 switch x := expr.(type) {
902 case *callExpr:
903 if x.name == callLoadAlways || x.name == callLoadIf {
904 ctx.handleInheritModule(v, x.args[0], x.name == callLoadAlways)
905 } else if isMakeControlFunc(x.name) {
906 // File name is the first argument
907 args := []starlarkExpr{
908 &stringLiteralExpr{ctx.script.mkFile},
909 x.args[0],
910 }
911 ctx.receiver.newNode(&exprNode{
912 &callExpr{name: x.name, args: args, returnType: starlarkTypeUnknown},
913 })
914 } else {
915 ctx.receiver.newNode(&exprNode{expr})
916 }
917 case *badExpr:
918 ctx.wrapBadExpr(x)
919 return
920 default:
921 ctx.errorf(v, "cannot handle %s", v.Dump())
922 return
923 }
924}
925
926func (ctx *parseContext) handleDefine(directive *mkparser.Directive) {
Sasha Smundakf3e072a2021-07-14 12:50:28 -0700927 macro_name := strings.Fields(directive.Args.Strings[0])[0]
928 // Ignore the macros that we handle
929 if _, ok := knownFunctions[macro_name]; !ok {
930 ctx.errorf(directive, "define is not supported: %s", macro_name)
931 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -0800932}
933
934func (ctx *parseContext) handleIfBlock(ifDirective *mkparser.Directive) {
935 ssSwitch := &switchNode{}
936 ctx.pushReceiver(ssSwitch)
937 for ctx.processBranch(ifDirective); ctx.hasNodes() && ctx.fatalError == nil; {
938 node := ctx.getNode()
939 switch x := node.(type) {
940 case *mkparser.Directive:
941 switch x.Name {
942 case "else", "elifdef", "elifndef", "elifeq", "elifneq":
943 ctx.processBranch(x)
944 case "endif":
945 ctx.popReceiver()
946 ctx.receiver.newNode(ssSwitch)
947 return
948 default:
949 ctx.errorf(node, "unexpected directive %s", x.Name)
950 }
951 default:
952 ctx.errorf(ifDirective, "unexpected statement")
953 }
954 }
955 if ctx.fatalError == nil {
956 ctx.fatalError = fmt.Errorf("no matching endif for %s", ifDirective.Dump())
957 }
958 ctx.popReceiver()
959}
960
961// processBranch processes a single branch (if/elseif/else) until the next directive
962// on the same level.
963func (ctx *parseContext) processBranch(check *mkparser.Directive) {
964 block := switchCase{gate: ctx.parseCondition(check)}
965 defer func() {
966 ctx.popVarAssignments()
967 ctx.ifNestLevel--
968
969 }()
970 ctx.pushVarAssignments()
971 ctx.ifNestLevel++
972
973 ctx.pushReceiver(&block)
974 for ctx.hasNodes() {
975 node := ctx.getNode()
976 if ctx.handleSimpleStatement(node) {
977 continue
978 }
979 switch d := node.(type) {
980 case *mkparser.Directive:
981 switch d.Name {
982 case "else", "elifdef", "elifndef", "elifeq", "elifneq", "endif":
983 ctx.popReceiver()
984 ctx.receiver.newNode(&block)
985 ctx.backNode()
986 return
987 case "ifdef", "ifndef", "ifeq", "ifneq":
988 ctx.handleIfBlock(d)
989 default:
990 ctx.errorf(d, "unexpected directive %s", d.Name)
991 }
992 default:
993 ctx.errorf(node, "unexpected statement")
994 }
995 }
996 ctx.fatalError = fmt.Errorf("no matching endif for %s", check.Dump())
997 ctx.popReceiver()
998}
999
1000func (ctx *parseContext) newIfDefinedNode(check *mkparser.Directive) (starlarkExpr, bool) {
1001 if !check.Args.Const() {
1002 return ctx.newBadExpr(check, "ifdef variable ref too complex: %s", check.Args.Dump()), false
1003 }
1004 v := ctx.addVariable(check.Args.Strings[0])
1005 return &variableDefinedExpr{v}, true
1006}
1007
1008func (ctx *parseContext) parseCondition(check *mkparser.Directive) starlarkNode {
1009 switch check.Name {
1010 case "ifdef", "ifndef", "elifdef", "elifndef":
1011 v, ok := ctx.newIfDefinedNode(check)
1012 if ok && strings.HasSuffix(check.Name, "ndef") {
1013 v = &notExpr{v}
1014 }
1015 return &ifNode{
1016 isElif: strings.HasPrefix(check.Name, "elif"),
1017 expr: v,
1018 }
1019 case "ifeq", "ifneq", "elifeq", "elifneq":
1020 return &ifNode{
1021 isElif: strings.HasPrefix(check.Name, "elif"),
1022 expr: ctx.parseCompare(check),
1023 }
1024 case "else":
1025 return &elseNode{}
1026 default:
1027 panic(fmt.Errorf("%s: unknown directive: %s", ctx.script.mkFile, check.Dump()))
1028 }
1029}
1030
1031func (ctx *parseContext) newBadExpr(node mkparser.Node, text string, args ...interface{}) starlarkExpr {
1032 message := fmt.Sprintf(text, args...)
1033 if ctx.errorLogger != nil {
1034 ctx.errorLogger.NewError(text, node, args)
1035 }
1036 ctx.script.hasErrors = true
1037 return &badExpr{node, message}
1038}
1039
1040func (ctx *parseContext) parseCompare(cond *mkparser.Directive) starlarkExpr {
1041 // Strip outer parentheses
1042 mkArg := cloneMakeString(cond.Args)
1043 mkArg.Strings[0] = strings.TrimLeft(mkArg.Strings[0], "( ")
1044 n := len(mkArg.Strings)
1045 mkArg.Strings[n-1] = strings.TrimRight(mkArg.Strings[n-1], ") ")
1046 args := mkArg.Split(",")
1047 // TODO(asmundak): handle the case where the arguments are in quotes and space-separated
1048 if len(args) != 2 {
1049 return ctx.newBadExpr(cond, "ifeq/ifneq len(args) != 2 %s", cond.Dump())
1050 }
1051 args[0].TrimRightSpaces()
1052 args[1].TrimLeftSpaces()
1053
1054 isEq := !strings.HasSuffix(cond.Name, "neq")
1055 switch xLeft := ctx.parseMakeString(cond, args[0]).(type) {
1056 case *stringLiteralExpr, *variableRefExpr:
1057 switch xRight := ctx.parseMakeString(cond, args[1]).(type) {
1058 case *stringLiteralExpr, *variableRefExpr:
1059 return &eqExpr{left: xLeft, right: xRight, isEq: isEq}
1060 case *badExpr:
1061 return xRight
1062 default:
1063 expr, ok := ctx.parseCheckFunctionCallResult(cond, xLeft, args[1])
1064 if ok {
1065 return expr
1066 }
1067 return ctx.newBadExpr(cond, "right operand is too complex: %s", args[1].Dump())
1068 }
1069 case *badExpr:
1070 return xLeft
1071 default:
1072 switch xRight := ctx.parseMakeString(cond, args[1]).(type) {
1073 case *stringLiteralExpr, *variableRefExpr:
1074 expr, ok := ctx.parseCheckFunctionCallResult(cond, xRight, args[0])
1075 if ok {
1076 return expr
1077 }
1078 return ctx.newBadExpr(cond, "left operand is too complex: %s", args[0].Dump())
1079 case *badExpr:
1080 return xRight
1081 default:
1082 return ctx.newBadExpr(cond, "operands are too complex: (%s,%s)", args[0].Dump(), args[1].Dump())
1083 }
1084 }
1085}
1086
1087func (ctx *parseContext) parseCheckFunctionCallResult(directive *mkparser.Directive, xValue starlarkExpr,
1088 varArg *mkparser.MakeString) (starlarkExpr, bool) {
1089 mkSingleVar, ok := varArg.SingleVariable()
1090 if !ok {
1091 return nil, false
1092 }
1093 expr := ctx.parseReference(directive, mkSingleVar)
1094 negate := strings.HasSuffix(directive.Name, "neq")
1095 checkIsSomethingFunction := func(xCall *callExpr) starlarkExpr {
1096 s, ok := maybeString(xValue)
1097 if !ok || s != "true" {
1098 return ctx.newBadExpr(directive,
1099 fmt.Sprintf("the result of %s can be compared only to 'true'", xCall.name))
1100 }
1101 if len(xCall.args) < 1 {
1102 return ctx.newBadExpr(directive, "%s requires an argument", xCall.name)
1103 }
1104 return nil
1105 }
1106 switch x := expr.(type) {
1107 case *callExpr:
1108 switch x.name {
1109 case "filter":
1110 return ctx.parseCompareFilterFuncResult(directive, x, xValue, !negate), true
1111 case "filter-out":
1112 return ctx.parseCompareFilterFuncResult(directive, x, xValue, negate), true
1113 case "wildcard":
1114 return ctx.parseCompareWildcardFuncResult(directive, x, xValue, negate), true
1115 case "findstring":
1116 return ctx.parseCheckFindstringFuncResult(directive, x, xValue, negate), true
1117 case "strip":
1118 return ctx.parseCompareStripFuncResult(directive, x, xValue, negate), true
1119 case "is-board-platform":
1120 if xBad := checkIsSomethingFunction(x); xBad != nil {
1121 return xBad, true
1122 }
1123 return &eqExpr{
1124 left: &variableRefExpr{ctx.addVariable("TARGET_BOARD_PLATFORM"), false},
1125 right: x.args[0],
1126 isEq: !negate,
1127 }, true
1128 case "is-board-platform-in-list":
1129 if xBad := checkIsSomethingFunction(x); xBad != nil {
1130 return xBad, true
1131 }
1132 return &inExpr{
1133 expr: &variableRefExpr{ctx.addVariable("TARGET_BOARD_PLATFORM"), false},
1134 list: maybeConvertToStringList(x.args[0]),
1135 isNot: negate,
1136 }, true
1137 case "is-product-in-list":
1138 if xBad := checkIsSomethingFunction(x); xBad != nil {
1139 return xBad, true
1140 }
1141 return &inExpr{
1142 expr: &variableRefExpr{ctx.addVariable("TARGET_PRODUCT"), true},
1143 list: maybeConvertToStringList(x.args[0]),
1144 isNot: negate,
1145 }, true
1146 case "is-vendor-board-platform":
1147 if xBad := checkIsSomethingFunction(x); xBad != nil {
1148 return xBad, true
1149 }
1150 s, ok := maybeString(x.args[0])
1151 if !ok {
1152 return ctx.newBadExpr(directive, "cannot handle non-constant argument to is-vendor-board-platform"), true
1153 }
1154 return &inExpr{
1155 expr: &variableRefExpr{ctx.addVariable("TARGET_BOARD_PLATFORM"), false},
1156 list: &variableRefExpr{ctx.addVariable(s + "_BOARD_PLATFORMS"), true},
1157 isNot: negate,
1158 }, true
Sasha Smundak3a9b8e82021-08-25 14:11:04 -07001159
1160 case "is-board-platform2", "is-board-platform-in-list2":
1161 if s, ok := maybeString(xValue); !ok || s != "" {
1162 return ctx.newBadExpr(directive,
1163 fmt.Sprintf("the result of %s can be compared only to empty", x.name)), true
1164 }
1165 if len(x.args) != 1 {
1166 return ctx.newBadExpr(directive, "%s requires an argument", x.name), true
1167 }
1168 cc := &callExpr{
1169 name: x.name,
1170 args: []starlarkExpr{x.args[0]},
1171 returnType: starlarkTypeBool,
1172 }
1173 if !negate {
1174 return &notExpr{cc}, true
1175 }
1176 return cc, true
1177 case "is-vendor-board-qcom":
1178 if s, ok := maybeString(xValue); !ok || s != "" {
1179 return ctx.newBadExpr(directive,
1180 fmt.Sprintf("the result of %s can be compared only to empty", x.name)), true
1181 }
Sasha Smundak4f1f1182021-11-04 17:57:39 -07001182 // if the expression is ifneq (,$(call is-vendor-board-platform,...)), negate==true,
1183 // so we should set inExpr.isNot to false
Sasha Smundak3a9b8e82021-08-25 14:11:04 -07001184 return &inExpr{
1185 expr: &variableRefExpr{ctx.addVariable("TARGET_BOARD_PLATFORM"), false},
1186 list: &variableRefExpr{ctx.addVariable("QCOM_BOARD_PLATFORMS"), true},
Sasha Smundak4f1f1182021-11-04 17:57:39 -07001187 isNot: !negate,
Sasha Smundak3a9b8e82021-08-25 14:11:04 -07001188 }, true
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001189 default:
1190 return ctx.newBadExpr(directive, "Unknown function in ifeq: %s", x.name), true
1191 }
1192 case *badExpr:
1193 return x, true
1194 default:
1195 return nil, false
1196 }
1197}
1198
1199func (ctx *parseContext) parseCompareFilterFuncResult(cond *mkparser.Directive,
1200 filterFuncCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
1201 // We handle:
Sasha Smundak0554d762021-07-08 18:26:12 -07001202 // * ifeq/ifneq (,$(filter v1 v2 ..., EXPR) becomes if EXPR not in/in ["v1", "v2", ...]
1203 // * ifeq/ifneq (,$(filter EXPR, v1 v2 ...) becomes if EXPR not in/in ["v1", "v2", ...]
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001204 // * ifeq/ifneq ($(VAR),$(filter $(VAR), v1 v2 ...) becomes if VAR in/not in ["v1", "v2"]
1205 // TODO(Asmundak): check the last case works for filter-out, too.
1206 xPattern := filterFuncCall.args[0]
1207 xText := filterFuncCall.args[1]
1208 var xInList *stringLiteralExpr
Sasha Smundak0554d762021-07-08 18:26:12 -07001209 var expr starlarkExpr
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001210 var ok bool
1211 switch x := xValue.(type) {
1212 case *stringLiteralExpr:
1213 if x.literal != "" {
1214 return ctx.newBadExpr(cond, "filter comparison to non-empty value: %s", xValue)
1215 }
1216 // Either pattern or text should be const, and the
1217 // non-const one should be varRefExpr
Sasha Smundak5f463be2021-09-15 18:43:36 -07001218 if xInList, ok = xPattern.(*stringLiteralExpr); ok && !strings.ContainsRune(xInList.literal, '%') && xText.typ() == starlarkTypeList {
Sasha Smundak0554d762021-07-08 18:26:12 -07001219 expr = xText
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001220 } else if xInList, ok = xText.(*stringLiteralExpr); ok {
Sasha Smundak0554d762021-07-08 18:26:12 -07001221 expr = xPattern
1222 } else {
Sasha Smundak5f463be2021-09-15 18:43:36 -07001223 expr = &callExpr{
Sasha Smundak0554d762021-07-08 18:26:12 -07001224 object: nil,
1225 name: filterFuncCall.name,
1226 args: filterFuncCall.args,
1227 returnType: starlarkTypeBool,
1228 }
Sasha Smundak5f463be2021-09-15 18:43:36 -07001229 if negate {
1230 expr = &notExpr{expr: expr}
1231 }
1232 return expr
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001233 }
1234 case *variableRefExpr:
1235 if v, ok := xPattern.(*variableRefExpr); ok {
1236 if xInList, ok = xText.(*stringLiteralExpr); ok && v.ref.name() == x.ref.name() {
1237 // ifeq/ifneq ($(VAR),$(filter $(VAR), v1 v2 ...), flip negate,
1238 // it's the opposite to what is done when comparing to empty.
Sasha Smundak0554d762021-07-08 18:26:12 -07001239 expr = xPattern
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001240 negate = !negate
1241 }
1242 }
1243 }
Sasha Smundak0554d762021-07-08 18:26:12 -07001244 if expr != nil && xInList != nil {
1245 slExpr := newStringListExpr(strings.Fields(xInList.literal))
1246 // Generate simpler code for the common cases:
1247 if expr.typ() == starlarkTypeList {
1248 if len(slExpr.items) == 1 {
1249 // Checking that a string belongs to list
1250 return &inExpr{isNot: negate, list: expr, expr: slExpr.items[0]}
1251 } else {
1252 // TODO(asmundak):
1253 panic("TBD")
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001254 }
Sasha Smundak0554d762021-07-08 18:26:12 -07001255 } else if len(slExpr.items) == 1 {
1256 return &eqExpr{left: expr, right: slExpr.items[0], isEq: !negate}
1257 } else {
1258 return &inExpr{isNot: negate, list: newStringListExpr(strings.Fields(xInList.literal)), expr: expr}
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001259 }
1260 }
1261 return ctx.newBadExpr(cond, "filter arguments are too complex: %s", cond.Dump())
1262}
1263
1264func (ctx *parseContext) parseCompareWildcardFuncResult(directive *mkparser.Directive,
1265 xCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
Sasha Smundak0554d762021-07-08 18:26:12 -07001266 if !isEmptyString(xValue) {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001267 return ctx.newBadExpr(directive, "wildcard result can be compared only to empty: %s", xValue)
1268 }
1269 callFunc := wildcardExistsPhony
1270 if s, ok := xCall.args[0].(*stringLiteralExpr); ok && !strings.ContainsAny(s.literal, "*?{[") {
1271 callFunc = fileExistsPhony
1272 }
1273 var cc starlarkExpr = &callExpr{name: callFunc, args: xCall.args, returnType: starlarkTypeBool}
1274 if !negate {
1275 cc = &notExpr{cc}
1276 }
1277 return cc
1278}
1279
1280func (ctx *parseContext) parseCheckFindstringFuncResult(directive *mkparser.Directive,
1281 xCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
Sasha Smundak0554d762021-07-08 18:26:12 -07001282 if isEmptyString(xValue) {
1283 return &eqExpr{
1284 left: &callExpr{
1285 object: xCall.args[1],
1286 name: "find",
1287 args: []starlarkExpr{xCall.args[0]},
1288 returnType: starlarkTypeInt,
1289 },
1290 right: &intLiteralExpr{-1},
1291 isEq: !negate,
1292 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001293 }
Sasha Smundak0554d762021-07-08 18:26:12 -07001294 return ctx.newBadExpr(directive, "findstring result can be compared only to empty: %s", xValue)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001295}
1296
1297func (ctx *parseContext) parseCompareStripFuncResult(directive *mkparser.Directive,
1298 xCall *callExpr, xValue starlarkExpr, negate bool) starlarkExpr {
1299 if _, ok := xValue.(*stringLiteralExpr); !ok {
1300 return ctx.newBadExpr(directive, "strip result can be compared only to string: %s", xValue)
1301 }
1302 return &eqExpr{
1303 left: &callExpr{
1304 name: "strip",
1305 args: xCall.args,
1306 returnType: starlarkTypeString,
1307 },
1308 right: xValue, isEq: !negate}
1309}
1310
1311// parses $(...), returning an expression
1312func (ctx *parseContext) parseReference(node mkparser.Node, ref *mkparser.MakeString) starlarkExpr {
1313 ref.TrimLeftSpaces()
1314 ref.TrimRightSpaces()
1315 refDump := ref.Dump()
1316
1317 // Handle only the case where the first (or only) word is constant
1318 words := ref.SplitN(" ", 2)
1319 if !words[0].Const() {
1320 return ctx.newBadExpr(node, "reference is too complex: %s", refDump)
1321 }
1322
1323 // If it is a single word, it can be a simple variable
1324 // reference or a function call
1325 if len(words) == 1 {
1326 if isMakeControlFunc(refDump) || refDump == "shell" {
1327 return &callExpr{
1328 name: refDump,
1329 args: []starlarkExpr{&stringLiteralExpr{""}},
1330 returnType: starlarkTypeUnknown,
1331 }
1332 }
Sasha Smundak65b547e2021-09-17 15:35:41 -07001333 if strings.HasPrefix(refDump, soongNsPrefix) {
1334 // TODO (asmundak): if we find many, maybe handle them.
Cole Faustc00184e2021-11-08 12:08:57 -08001335 return ctx.newBadExpr(node, "SOONG_CONFIG_ variables cannot be referenced, use soong_config_get instead: %s", refDump)
Sasha Smundak65b547e2021-09-17 15:35:41 -07001336 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001337 if v := ctx.addVariable(refDump); v != nil {
1338 return &variableRefExpr{v, ctx.lastAssignment(v.name()) != nil}
1339 }
1340 return ctx.newBadExpr(node, "unknown variable %s", refDump)
1341 }
1342
1343 expr := &callExpr{name: words[0].Dump(), returnType: starlarkTypeUnknown}
1344 args := words[1]
1345 args.TrimLeftSpaces()
1346 // Make control functions and shell need special treatment as everything
1347 // after the name is a single text argument
1348 if isMakeControlFunc(expr.name) || expr.name == "shell" {
1349 x := ctx.parseMakeString(node, args)
1350 if xBad, ok := x.(*badExpr); ok {
1351 return xBad
1352 }
1353 expr.args = []starlarkExpr{x}
1354 return expr
1355 }
1356 if expr.name == "call" {
1357 words = args.SplitN(",", 2)
1358 if words[0].Empty() || !words[0].Const() {
Sasha Smundakf2c9f8b2021-07-27 10:44:48 -07001359 return ctx.newBadExpr(node, "cannot handle %s", refDump)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001360 }
1361 expr.name = words[0].Dump()
1362 if len(words) < 2 {
Sasha Smundak6609ba72021-07-22 18:32:56 -07001363 args = &mkparser.MakeString{}
1364 } else {
1365 args = words[1]
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001366 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001367 }
1368 if kf, found := knownFunctions[expr.name]; found {
1369 expr.returnType = kf.returnType
1370 } else {
1371 return ctx.newBadExpr(node, "cannot handle invoking %s", expr.name)
1372 }
1373 switch expr.name {
1374 case "word":
1375 return ctx.parseWordFunc(node, args)
Sasha Smundak16e07732021-07-23 11:38:23 -07001376 case "firstword", "lastword":
1377 return ctx.parseFirstOrLastwordFunc(node, expr.name, args)
Sasha Smundak6609ba72021-07-22 18:32:56 -07001378 case "my-dir":
1379 return &variableRefExpr{ctx.addVariable("LOCAL_PATH"), true}
Sasha Smundak94b41c72021-07-12 18:30:42 -07001380 case "subst", "patsubst":
1381 return ctx.parseSubstFunc(node, expr.name, args)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001382 default:
1383 for _, arg := range args.Split(",") {
1384 arg.TrimLeftSpaces()
1385 arg.TrimRightSpaces()
1386 x := ctx.parseMakeString(node, arg)
1387 if xBad, ok := x.(*badExpr); ok {
1388 return xBad
1389 }
1390 expr.args = append(expr.args, x)
1391 }
1392 }
1393 return expr
1394}
1395
Sasha Smundak94b41c72021-07-12 18:30:42 -07001396func (ctx *parseContext) parseSubstFunc(node mkparser.Node, fname string, args *mkparser.MakeString) starlarkExpr {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001397 words := args.Split(",")
1398 if len(words) != 3 {
Sasha Smundak94b41c72021-07-12 18:30:42 -07001399 return ctx.newBadExpr(node, "%s function should have 3 arguments", fname)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001400 }
Sasha Smundak35434ed2021-11-05 16:29:56 -07001401 from := ctx.parseMakeString(node, words[0])
1402 if xBad, ok := from.(*badExpr); ok {
1403 return xBad
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001404 }
Sasha Smundak35434ed2021-11-05 16:29:56 -07001405 to := ctx.parseMakeString(node, words[1])
1406 if xBad, ok := to.(*badExpr); ok {
1407 return xBad
1408 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001409 words[2].TrimLeftSpaces()
1410 words[2].TrimRightSpaces()
1411 obj := ctx.parseMakeString(node, words[2])
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001412 typ := obj.typ()
Sasha Smundak94b41c72021-07-12 18:30:42 -07001413 if typ == starlarkTypeString && fname == "subst" {
1414 // Optimization: if it's $(subst from, to, string), emit string.replace(from, to)
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001415 return &callExpr{
1416 object: obj,
1417 name: "replace",
Sasha Smundak35434ed2021-11-05 16:29:56 -07001418 args: []starlarkExpr{from, to},
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001419 returnType: typ,
1420 }
1421 }
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001422 return &callExpr{
Sasha Smundak94b41c72021-07-12 18:30:42 -07001423 name: fname,
Sasha Smundak35434ed2021-11-05 16:29:56 -07001424 args: []starlarkExpr{from, to, obj},
Sasha Smundak9d011ab2021-07-09 16:00:57 -07001425 returnType: obj.typ(),
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001426 }
1427}
1428
1429func (ctx *parseContext) parseWordFunc(node mkparser.Node, args *mkparser.MakeString) starlarkExpr {
1430 words := args.Split(",")
1431 if len(words) != 2 {
1432 return ctx.newBadExpr(node, "word function should have 2 arguments")
1433 }
1434 var index uint64 = 0
1435 if words[0].Const() {
1436 index, _ = strconv.ParseUint(strings.TrimSpace(words[0].Strings[0]), 10, 64)
1437 }
1438 if index < 1 {
1439 return ctx.newBadExpr(node, "word index should be constant positive integer")
1440 }
1441 words[1].TrimLeftSpaces()
1442 words[1].TrimRightSpaces()
1443 array := ctx.parseMakeString(node, words[1])
1444 if xBad, ok := array.(*badExpr); ok {
1445 return xBad
1446 }
1447 if array.typ() != starlarkTypeList {
1448 array = &callExpr{object: array, name: "split", returnType: starlarkTypeList}
1449 }
1450 return indexExpr{array, &intLiteralExpr{int(index - 1)}}
1451}
1452
Sasha Smundak16e07732021-07-23 11:38:23 -07001453func (ctx *parseContext) parseFirstOrLastwordFunc(node mkparser.Node, name string, args *mkparser.MakeString) starlarkExpr {
1454 arg := ctx.parseMakeString(node, args)
1455 if bad, ok := arg.(*badExpr); ok {
1456 return bad
1457 }
1458 index := &intLiteralExpr{0}
1459 if name == "lastword" {
1460 if v, ok := arg.(*variableRefExpr); ok && v.ref.name() == "MAKEFILE_LIST" {
1461 return &stringLiteralExpr{ctx.script.mkFile}
1462 }
1463 index.literal = -1
1464 }
1465 if arg.typ() == starlarkTypeList {
1466 return &indexExpr{arg, index}
1467 }
1468 return &indexExpr{&callExpr{object: arg, name: "split", returnType: starlarkTypeList}, index}
1469}
1470
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001471func (ctx *parseContext) parseMakeString(node mkparser.Node, mk *mkparser.MakeString) starlarkExpr {
1472 if mk.Const() {
1473 return &stringLiteralExpr{mk.Dump()}
1474 }
1475 if mkRef, ok := mk.SingleVariable(); ok {
1476 return ctx.parseReference(node, mkRef)
1477 }
1478 // If we reached here, it's neither string literal nor a simple variable,
1479 // we need a full-blown interpolation node that will generate
1480 // "a%b%c" % (X, Y) for a$(X)b$(Y)c
1481 xInterp := &interpolateExpr{args: make([]starlarkExpr, len(mk.Variables))}
1482 for i, ref := range mk.Variables {
1483 arg := ctx.parseReference(node, ref.Name)
1484 if x, ok := arg.(*badExpr); ok {
1485 return x
1486 }
1487 xInterp.args[i] = arg
1488 }
1489 xInterp.chunks = append(xInterp.chunks, mk.Strings...)
1490 return xInterp
1491}
1492
1493// Handles the statements whose treatment is the same in all contexts: comment,
1494// assignment, variable (which is a macro call in reality) and all constructs that
1495// do not handle in any context ('define directive and any unrecognized stuff).
1496// Return true if we handled it.
1497func (ctx *parseContext) handleSimpleStatement(node mkparser.Node) bool {
1498 handled := true
1499 switch x := node.(type) {
1500 case *mkparser.Comment:
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001501 ctx.maybeHandleAnnotation(x)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001502 ctx.insertComment("#" + x.Comment)
1503 case *mkparser.Assignment:
1504 ctx.handleAssignment(x)
1505 case *mkparser.Variable:
1506 ctx.handleVariable(x)
1507 case *mkparser.Directive:
1508 switch x.Name {
1509 case "define":
1510 ctx.handleDefine(x)
1511 case "include", "-include":
1512 ctx.handleInclude(node, ctx.parseMakeString(node, x.Args), x.Name[0] != '-')
1513 default:
1514 handled = false
1515 }
1516 default:
Sasha Smundak2afb9d72021-10-24 15:16:59 -07001517 ctx.errorf(x, "unsupported line %s", strings.ReplaceAll(x.Dump(), "\n", "\n#"))
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001518 }
1519 return handled
1520}
1521
Sasha Smundak6d852dd2021-09-27 20:34:39 -07001522// Processes annotation. An annotation is a comment that starts with #RBC# and provides
1523// a conversion hint -- say, where to look for the dynamically calculated inherit/include
1524// paths.
1525func (ctx *parseContext) maybeHandleAnnotation(cnode *mkparser.Comment) {
1526 maybeTrim := func(s, prefix string) (string, bool) {
1527 if strings.HasPrefix(s, prefix) {
1528 return strings.TrimSpace(strings.TrimPrefix(s, prefix)), true
1529 }
1530 return s, false
1531 }
1532 annotation, ok := maybeTrim(cnode.Comment, annotationCommentPrefix)
1533 if !ok {
1534 return
1535 }
1536 if p, ok := maybeTrim(annotation, "include_top"); ok {
1537 ctx.includeTops = append(ctx.includeTops, p)
1538 return
1539 }
1540 ctx.errorf(cnode, "unsupported annotation %s", cnode.Comment)
1541
1542}
1543
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001544func (ctx *parseContext) insertComment(s string) {
1545 ctx.receiver.newNode(&commentNode{strings.TrimSpace(s)})
1546}
1547
1548func (ctx *parseContext) carryAsComment(failedNode mkparser.Node) {
1549 for _, line := range strings.Split(failedNode.Dump(), "\n") {
1550 ctx.insertComment("# " + line)
1551 }
1552}
1553
1554// records that the given node failed to be converted and includes an explanatory message
1555func (ctx *parseContext) errorf(failedNode mkparser.Node, message string, args ...interface{}) {
1556 if ctx.errorLogger != nil {
1557 ctx.errorLogger.NewError(message, failedNode, args...)
1558 }
1559 message = fmt.Sprintf(message, args...)
1560 ctx.insertComment(fmt.Sprintf("# MK2RBC TRANSLATION ERROR: %s", message))
1561 ctx.carryAsComment(failedNode)
1562 ctx.script.hasErrors = true
1563}
1564
1565func (ctx *parseContext) wrapBadExpr(xBad *badExpr) {
1566 ctx.insertComment(fmt.Sprintf("# MK2RBC TRANSLATION ERROR: %s", xBad.message))
1567 ctx.carryAsComment(xBad.node)
1568}
1569
1570func (ctx *parseContext) loadedModulePath(path string) string {
1571 // During the transition to Roboleaf some of the product configuration files
1572 // will be converted and checked in while the others will be generated on the fly
1573 // and run. The runner (rbcrun application) accommodates this by allowing three
1574 // different ways to specify the loaded file location:
1575 // 1) load(":<file>",...) loads <file> from the same directory
1576 // 2) load("//path/relative/to/source/root:<file>", ...) loads <file> source tree
1577 // 3) load("/absolute/path/to/<file> absolute path
1578 // If the file being generated and the file it wants to load are in the same directory,
1579 // generate option 1.
1580 // Otherwise, if output directory is not specified, generate 2)
1581 // Finally, if output directory has been specified and the file being generated and
1582 // the file it wants to load from are in the different directories, generate 2) or 3):
1583 // * if the file being loaded exists in the source tree, generate 2)
1584 // * otherwise, generate 3)
1585 // Finally, figure out the loaded module path and name and create a node for it
1586 loadedModuleDir := filepath.Dir(path)
1587 base := filepath.Base(path)
1588 loadedModuleName := strings.TrimSuffix(base, filepath.Ext(base)) + ctx.outputSuffix
1589 if loadedModuleDir == filepath.Dir(ctx.script.mkFile) {
1590 return ":" + loadedModuleName
1591 }
1592 if ctx.outputDir == "" {
1593 return fmt.Sprintf("//%s:%s", loadedModuleDir, loadedModuleName)
1594 }
1595 if _, err := os.Stat(filepath.Join(loadedModuleDir, loadedModuleName)); err == nil {
1596 return fmt.Sprintf("//%s:%s", loadedModuleDir, loadedModuleName)
1597 }
1598 return filepath.Join(ctx.outputDir, loadedModuleDir, loadedModuleName)
1599}
1600
Sasha Smundak3deb9682021-07-26 18:42:25 -07001601func (ctx *parseContext) addSoongNamespace(ns string) {
1602 if _, ok := ctx.soongNamespaces[ns]; ok {
1603 return
1604 }
1605 ctx.soongNamespaces[ns] = make(map[string]bool)
1606}
1607
1608func (ctx *parseContext) hasSoongNamespace(name string) bool {
1609 _, ok := ctx.soongNamespaces[name]
1610 return ok
1611}
1612
1613func (ctx *parseContext) updateSoongNamespace(replace bool, namespaceName string, varNames []string) {
1614 ctx.addSoongNamespace(namespaceName)
1615 vars := ctx.soongNamespaces[namespaceName]
1616 if replace {
1617 vars = make(map[string]bool)
1618 ctx.soongNamespaces[namespaceName] = vars
1619 }
1620 for _, v := range varNames {
1621 vars[v] = true
1622 }
1623}
1624
1625func (ctx *parseContext) hasNamespaceVar(namespaceName string, varName string) bool {
1626 vars, ok := ctx.soongNamespaces[namespaceName]
1627 if ok {
1628 _, ok = vars[varName]
1629 }
1630 return ok
1631}
1632
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001633func (ss *StarlarkScript) String() string {
1634 return NewGenerateContext(ss).emit()
1635}
1636
1637func (ss *StarlarkScript) SubConfigFiles() []string {
Sasha Smundak6609ba72021-07-22 18:32:56 -07001638
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001639 var subs []string
1640 for _, src := range ss.inherited {
1641 subs = append(subs, src.originalPath)
1642 }
1643 return subs
1644}
1645
1646func (ss *StarlarkScript) HasErrors() bool {
1647 return ss.hasErrors
1648}
1649
1650// Convert reads and parses a makefile. If successful, parsed tree
1651// is returned and then can be passed to String() to get the generated
1652// Starlark file.
1653func Convert(req Request) (*StarlarkScript, error) {
1654 reader := req.Reader
1655 if reader == nil {
1656 mkContents, err := ioutil.ReadFile(req.MkFile)
1657 if err != nil {
1658 return nil, err
1659 }
1660 reader = bytes.NewBuffer(mkContents)
1661 }
1662 parser := mkparser.NewParser(req.MkFile, reader)
1663 nodes, errs := parser.Parse()
1664 if len(errs) > 0 {
1665 for _, e := range errs {
1666 fmt.Fprintln(os.Stderr, "ERROR:", e)
1667 }
1668 return nil, fmt.Errorf("bad makefile %s", req.MkFile)
1669 }
1670 starScript := &StarlarkScript{
1671 moduleName: moduleNameForFile(req.MkFile),
1672 mkFile: req.MkFile,
1673 topDir: req.RootDir,
1674 traceCalls: req.TraceCalls,
1675 warnPartialSuccess: req.WarnPartialSuccess,
Sasha Smundak6609ba72021-07-22 18:32:56 -07001676 sourceFS: req.SourceFS,
1677 makefileFinder: req.MakefileFinder,
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001678 }
1679 ctx := newParseContext(starScript, nodes)
1680 ctx.outputSuffix = req.OutputSuffix
1681 ctx.outputDir = req.OutputDir
1682 ctx.errorLogger = req.ErrorLogger
1683 if len(req.TracedVariables) > 0 {
1684 ctx.tracedVariables = make(map[string]bool)
1685 for _, v := range req.TracedVariables {
1686 ctx.tracedVariables[v] = true
1687 }
1688 }
1689 ctx.pushReceiver(starScript)
1690 for ctx.hasNodes() && ctx.fatalError == nil {
1691 node := ctx.getNode()
1692 if ctx.handleSimpleStatement(node) {
1693 continue
1694 }
1695 switch x := node.(type) {
1696 case *mkparser.Directive:
1697 switch x.Name {
1698 case "ifeq", "ifneq", "ifdef", "ifndef":
1699 ctx.handleIfBlock(x)
1700 default:
1701 ctx.errorf(x, "unexpected directive %s", x.Name)
1702 }
1703 default:
1704 ctx.errorf(x, "unsupported line")
1705 }
1706 }
1707 if ctx.fatalError != nil {
1708 return nil, ctx.fatalError
1709 }
1710 return starScript, nil
1711}
1712
Sasha Smundakd7d07ad2021-09-10 15:42:34 -07001713func Launcher(mainModuleUri, versionDefaultsUri, mainModuleName string) string {
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001714 var buf bytes.Buffer
1715 fmt.Fprintf(&buf, "load(%q, %q)\n", baseUri, baseName)
Sasha Smundakd7d07ad2021-09-10 15:42:34 -07001716 fmt.Fprintf(&buf, "load(%q, \"version_defaults\")\n", versionDefaultsUri)
1717 fmt.Fprintf(&buf, "load(%q, \"init\")\n", mainModuleUri)
1718 fmt.Fprintf(&buf, "%s(%s(%q, init, version_defaults))\n", cfnPrintVars, cfnMain, mainModuleName)
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001719 return buf.String()
1720}
1721
Cole Faust6ed7cb42021-10-07 17:08:46 -07001722func BoardLauncher(mainModuleUri string, inputVariablesUri string) string {
1723 var buf bytes.Buffer
1724 fmt.Fprintf(&buf, "load(%q, %q)\n", baseUri, baseName)
1725 fmt.Fprintf(&buf, "load(%q, \"init\")\n", mainModuleUri)
1726 fmt.Fprintf(&buf, "load(%q, input_variables_init = \"init\")\n", inputVariablesUri)
1727 fmt.Fprintf(&buf, "globals, cfg, globals_base = %s(init, input_variables_init)\n", cfnBoardMain)
1728 fmt.Fprintf(&buf, "# TODO: Some product config variables need to be printed, but most are readonly so we can't just print cfg here.\n")
1729 fmt.Fprintf(&buf, "%s(globals, globals_base)\n", cfnPrintGlobals)
1730 return buf.String()
1731}
1732
Sasha Smundakb051c4e2020-11-05 20:45:07 -08001733func MakePath2ModuleName(mkPath string) string {
1734 return strings.TrimSuffix(mkPath, filepath.Ext(mkPath))
1735}