xref: /openbmc/openbmc/poky/bitbake/lib/bb/parse/ast.py (revision 4ed12e16) 
1"""
2 AbstractSyntaxTree classes for the Bitbake language
3"""
4
5# Copyright (C) 2003, 2004 Chris Larson
6# Copyright (C) 2003, 2004 Phil Blundell
7# Copyright (C) 2009 Holger Hans Peter Freyther
8#
9# SPDX-License-Identifier: GPL-2.0-only
10#
11
12import bb
13from bb import methodpool
14from bb.parse import logger
15
16class StatementGroup(list):
17    def eval(self, data):
18        for statement in self:
19            statement.eval(data)
20
21class AstNode(object):
22    def __init__(self, filename, lineno):
23        self.filename = filename
24        self.lineno = lineno
25
26class IncludeNode(AstNode):
27    def __init__(self, filename, lineno, what_file, force):
28        AstNode.__init__(self, filename, lineno)
29        self.what_file = what_file
30        self.force = force
31
32    def eval(self, data):
33        """
34        Include the file and evaluate the statements
35        """
36        s = data.expand(self.what_file)
37        logger.debug(2, "CONF %s:%s: including %s", self.filename, self.lineno, s)
38
39        # TODO: Cache those includes... maybe not here though
40        if self.force:
41            bb.parse.ConfHandler.include(self.filename, s, self.lineno, data, "include required")
42        else:
43            bb.parse.ConfHandler.include(self.filename, s, self.lineno, data, False)
44
45class ExportNode(AstNode):
46    def __init__(self, filename, lineno, var):
47        AstNode.__init__(self, filename, lineno)
48        self.var = var
49
50    def eval(self, data):
51        data.setVarFlag(self.var, "export", 1, op = 'exported')
52
53class UnsetNode(AstNode):
54    def __init__(self, filename, lineno, var):
55        AstNode.__init__(self, filename, lineno)
56        self.var = var
57
58    def eval(self, data):
59        loginfo = {
60            'variable': self.var,
61            'file': self.filename,
62            'line': self.lineno,
63        }
64        data.delVar(self.var,**loginfo)
65
66class UnsetFlagNode(AstNode):
67    def __init__(self, filename, lineno, var, flag):
68        AstNode.__init__(self, filename, lineno)
69        self.var = var
70        self.flag = flag
71
72    def eval(self, data):
73        loginfo = {
74            'variable': self.var,
75            'file': self.filename,
76            'line': self.lineno,
77        }
78        data.delVarFlag(self.var, self.flag, **loginfo)
79
80class DataNode(AstNode):
81    """
82    Various data related updates. For the sake of sanity
83    we have one class doing all this. This means that all
84    this need to be re-evaluated... we might be able to do
85    that faster with multiple classes.
86    """
87    def __init__(self, filename, lineno, groupd):
88        AstNode.__init__(self, filename, lineno)
89        self.groupd = groupd
90
91    def getFunc(self, key, data):
92        if 'flag' in self.groupd and self.groupd['flag'] is not None:
93            return data.getVarFlag(key, self.groupd['flag'], expand=False, noweakdefault=True)
94        else:
95            return data.getVar(key, False, noweakdefault=True, parsing=True)
96
97    def eval(self, data):
98        groupd = self.groupd
99        key = groupd["var"]
100        loginfo = {
101            'variable': key,
102            'file': self.filename,
103            'line': self.lineno,
104        }
105        if "exp" in groupd and groupd["exp"] is not None:
106            data.setVarFlag(key, "export", 1, op = 'exported', **loginfo)
107
108        op = "set"
109        if "ques" in groupd and groupd["ques"] is not None:
110            val = self.getFunc(key, data)
111            op = "set?"
112            if val is None:
113                val = groupd["value"]
114        elif "colon" in groupd and groupd["colon"] is not None:
115            e = data.createCopy()
116            op = "immediate"
117            val = e.expand(groupd["value"], key + "[:=]")
118        elif "append" in groupd and groupd["append"] is not None:
119            op = "append"
120            val = "%s %s" % ((self.getFunc(key, data) or ""), groupd["value"])
121        elif "prepend" in groupd and groupd["prepend"] is not None:
122            op = "prepend"
123            val = "%s %s" % (groupd["value"], (self.getFunc(key, data) or ""))
124        elif "postdot" in groupd and groupd["postdot"] is not None:
125            op = "postdot"
126            val = "%s%s" % ((self.getFunc(key, data) or ""), groupd["value"])
127        elif "predot" in groupd and groupd["predot"] is not None:
128            op = "predot"
129            val = "%s%s" % (groupd["value"], (self.getFunc(key, data) or ""))
130        else:
131            val = groupd["value"]
132
133        flag = None
134        if 'flag' in groupd and groupd['flag'] is not None:
135            flag = groupd['flag']
136        elif groupd["lazyques"]:
137            flag = "_defaultval"
138
139        loginfo['op'] = op
140        loginfo['detail'] = groupd["value"]
141
142        if flag:
143            data.setVarFlag(key, flag, val, **loginfo)
144        else:
145            data.setVar(key, val, parsing=True, **loginfo)
146
147class MethodNode(AstNode):
148    tr_tbl = str.maketrans('/.+-@%&', '_______')
149
150    def __init__(self, filename, lineno, func_name, body, python, fakeroot):
151        AstNode.__init__(self, filename, lineno)
152        self.func_name = func_name
153        self.body = body
154        self.python = python
155        self.fakeroot = fakeroot
156
157    def eval(self, data):
158        text = '\n'.join(self.body)
159        funcname = self.func_name
160        if self.func_name == "__anonymous":
161            funcname = ("__anon_%s_%s" % (self.lineno, self.filename.translate(MethodNode.tr_tbl)))
162            self.python = True
163            text = "def %s(d):\n" % (funcname) + text
164            bb.methodpool.insert_method(funcname, text, self.filename, self.lineno - len(self.body) - 1)
165            anonfuncs = data.getVar('__BBANONFUNCS', False) or []
166            anonfuncs.append(funcname)
167            data.setVar('__BBANONFUNCS', anonfuncs)
168        if data.getVar(funcname, False):
169            # clean up old version of this piece of metadata, as its
170            # flags could cause problems
171            data.delVarFlag(funcname, 'python')
172            data.delVarFlag(funcname, 'fakeroot')
173        if self.python:
174            data.setVarFlag(funcname, "python", "1")
175        if self.fakeroot:
176            data.setVarFlag(funcname, "fakeroot", "1")
177        data.setVarFlag(funcname, "func", 1)
178        data.setVar(funcname, text, parsing=True)
179        data.setVarFlag(funcname, 'filename', self.filename)
180        data.setVarFlag(funcname, 'lineno', str(self.lineno - len(self.body)))
181
182class PythonMethodNode(AstNode):
183    def __init__(self, filename, lineno, function, modulename, body):
184        AstNode.__init__(self, filename, lineno)
185        self.function = function
186        self.modulename = modulename
187        self.body = body
188
189    def eval(self, data):
190        # Note we will add root to parsedmethods after having parse
191        # 'this' file. This means we will not parse methods from
192        # bb classes twice
193        text = '\n'.join(self.body)
194        bb.methodpool.insert_method(self.modulename, text, self.filename, self.lineno - len(self.body) - 1)
195        data.setVarFlag(self.function, "func", 1)
196        data.setVarFlag(self.function, "python", 1)
197        data.setVar(self.function, text, parsing=True)
198        data.setVarFlag(self.function, 'filename', self.filename)
199        data.setVarFlag(self.function, 'lineno', str(self.lineno - len(self.body) - 1))
200
201class ExportFuncsNode(AstNode):
202    def __init__(self, filename, lineno, fns, classname):
203        AstNode.__init__(self, filename, lineno)
204        self.n = fns.split()
205        self.classname = classname
206
207    def eval(self, data):
208
209        for func in self.n:
210            calledfunc = self.classname + "_" + func
211
212            if data.getVar(func, False) and not data.getVarFlag(func, 'export_func', False):
213                continue
214
215            if data.getVar(func, False):
216                data.setVarFlag(func, 'python', None)
217                data.setVarFlag(func, 'func', None)
218
219            for flag in [ "func", "python" ]:
220                if data.getVarFlag(calledfunc, flag, False):
221                    data.setVarFlag(func, flag, data.getVarFlag(calledfunc, flag, False))
222            for flag in [ "dirs" ]:
223                if data.getVarFlag(func, flag, False):
224                    data.setVarFlag(calledfunc, flag, data.getVarFlag(func, flag, False))
225            data.setVarFlag(func, "filename", "autogenerated")
226            data.setVarFlag(func, "lineno", 1)
227
228            if data.getVarFlag(calledfunc, "python", False):
229                data.setVar(func, "    bb.build.exec_func('" + calledfunc + "', d)\n", parsing=True)
230            else:
231                if "-" in self.classname:
232                   bb.fatal("The classname %s contains a dash character and is calling an sh function %s using EXPORT_FUNCTIONS. Since a dash is illegal in sh function names, this cannot work, please rename the class or don't use EXPORT_FUNCTIONS." % (self.classname, calledfunc))
233                data.setVar(func, "    " + calledfunc + "\n", parsing=True)
234            data.setVarFlag(func, 'export_func', '1')
235
236class AddTaskNode(AstNode):
237    def __init__(self, filename, lineno, func, before, after):
238        AstNode.__init__(self, filename, lineno)
239        self.func = func
240        self.before = before
241        self.after = after
242
243    def eval(self, data):
244        bb.build.addtask(self.func, self.before, self.after, data)
245
246class DelTaskNode(AstNode):
247    def __init__(self, filename, lineno, func):
248        AstNode.__init__(self, filename, lineno)
249        self.func = func
250
251    def eval(self, data):
252        bb.build.deltask(self.func, data)
253
254class BBHandlerNode(AstNode):
255    def __init__(self, filename, lineno, fns):
256        AstNode.__init__(self, filename, lineno)
257        self.hs = fns.split()
258
259    def eval(self, data):
260        bbhands = data.getVar('__BBHANDLERS', False) or []
261        for h in self.hs:
262            bbhands.append(h)
263            data.setVarFlag(h, "handler", 1)
264        data.setVar('__BBHANDLERS', bbhands)
265
266class InheritNode(AstNode):
267    def __init__(self, filename, lineno, classes):
268        AstNode.__init__(self, filename, lineno)
269        self.classes = classes
270
271    def eval(self, data):
272        bb.parse.BBHandler.inherit(self.classes, self.filename, self.lineno, data)
273
274def handleInclude(statements, filename, lineno, m, force):
275    statements.append(IncludeNode(filename, lineno, m.group(1), force))
276
277def handleExport(statements, filename, lineno, m):
278    statements.append(ExportNode(filename, lineno, m.group(1)))
279
280def handleUnset(statements, filename, lineno, m):
281    statements.append(UnsetNode(filename, lineno, m.group(1)))
282
283def handleUnsetFlag(statements, filename, lineno, m):
284    statements.append(UnsetFlagNode(filename, lineno, m.group(1), m.group(2)))
285
286def handleData(statements, filename, lineno, groupd):
287    statements.append(DataNode(filename, lineno, groupd))
288
289def handleMethod(statements, filename, lineno, func_name, body, python, fakeroot):
290    statements.append(MethodNode(filename, lineno, func_name, body, python, fakeroot))
291
292def handlePythonMethod(statements, filename, lineno, funcname, modulename, body):
293    statements.append(PythonMethodNode(filename, lineno, funcname, modulename, body))
294
295def handleExportFuncs(statements, filename, lineno, m, classname):
296    statements.append(ExportFuncsNode(filename, lineno, m.group(1), classname))
297
298def handleAddTask(statements, filename, lineno, m):
299    func = m.group("func")
300    before = m.group("before")
301    after = m.group("after")
302    if func is None:
303        return
304
305    statements.append(AddTaskNode(filename, lineno, func, before, after))
306
307def handleDelTask(statements, filename, lineno, m):
308    func = m.group("func")
309    if func is None:
310        return
311
312    statements.append(DelTaskNode(filename, lineno, func))
313
314def handleBBHandlers(statements, filename, lineno, m):
315    statements.append(BBHandlerNode(filename, lineno, m.group(1)))
316
317def handleInherit(statements, filename, lineno, m):
318    classes = m.group(1)
319    statements.append(InheritNode(filename, lineno, classes))
320
321def runAnonFuncs(d):
322    code = []
323    for funcname in d.getVar("__BBANONFUNCS", False) or []:
324        code.append("%s(d)" % funcname)
325    bb.utils.better_exec("\n".join(code), {"d": d})
326
327def finalize(fn, d, variant = None):
328    saved_handlers = bb.event.get_handlers().copy()
329    try:
330        for var in d.getVar('__BBHANDLERS', False) or []:
331            # try to add the handler
332            handlerfn = d.getVarFlag(var, "filename", False)
333            if not handlerfn:
334                bb.fatal("Undefined event handler function '%s'" % var)
335            handlerln = int(d.getVarFlag(var, "lineno", False))
336            bb.event.register(var, d.getVar(var, False), (d.getVarFlag(var, "eventmask") or "").split(), handlerfn, handlerln)
337
338        bb.event.fire(bb.event.RecipePreFinalise(fn), d)
339
340        bb.data.expandKeys(d)
341
342        bb.event.fire(bb.event.RecipePostKeyExpansion(fn), d)
343
344        runAnonFuncs(d)
345
346        tasklist = d.getVar('__BBTASKS', False) or []
347        bb.event.fire(bb.event.RecipeTaskPreProcess(fn, list(tasklist)), d)
348        bb.build.add_tasks(tasklist, d)
349
350        bb.parse.siggen.finalise(fn, d, variant)
351
352        d.setVar('BBINCLUDED', bb.parse.get_file_depends(d))
353
354        bb.event.fire(bb.event.RecipeParsed(fn), d)
355    finally:
356        bb.event.set_handlers(saved_handlers)
357
358def _create_variants(datastores, names, function, onlyfinalise):
359    def create_variant(name, orig_d, arg = None):
360        if onlyfinalise and name not in onlyfinalise:
361            return
362        new_d = bb.data.createCopy(orig_d)
363        function(arg or name, new_d)
364        datastores[name] = new_d
365
366    for variant in list(datastores.keys()):
367        for name in names:
368            if not variant:
369                # Based on main recipe
370                create_variant(name, datastores[""])
371            else:
372                create_variant("%s-%s" % (variant, name), datastores[variant], name)
373
374def multi_finalize(fn, d):
375    appends = (d.getVar("__BBAPPEND") or "").split()
376    for append in appends:
377        logger.debug(1, "Appending .bbappend file %s to %s", append, fn)
378        bb.parse.BBHandler.handle(append, d, True)
379
380    onlyfinalise = d.getVar("__ONLYFINALISE", False)
381
382    safe_d = d
383    d = bb.data.createCopy(safe_d)
384    try:
385        finalize(fn, d)
386    except bb.parse.SkipRecipe as e:
387        d.setVar("__SKIPPED", e.args[0])
388    datastores = {"": safe_d}
389
390    extended = d.getVar("BBCLASSEXTEND") or ""
391    if extended:
392        # the following is to support bbextends with arguments, for e.g. multilib
393        # an example is as follows:
394        #   BBCLASSEXTEND = "multilib:lib32"
395        # it will create foo-lib32, inheriting multilib.bbclass and set
396        # BBEXTENDCURR to "multilib" and BBEXTENDVARIANT to "lib32"
397        extendedmap = {}
398        variantmap = {}
399
400        for ext in extended.split():
401            eext = ext.split(':', 2)
402            if len(eext) > 1:
403                extendedmap[ext] = eext[0]
404                variantmap[ext] = eext[1]
405            else:
406                extendedmap[ext] = ext
407
408        pn = d.getVar("PN")
409        def extendfunc(name, d):
410            if name != extendedmap[name]:
411                d.setVar("BBEXTENDCURR", extendedmap[name])
412                d.setVar("BBEXTENDVARIANT", variantmap[name])
413            else:
414                d.setVar("PN", "%s-%s" % (pn, name))
415            bb.parse.BBHandler.inherit(extendedmap[name], fn, 0, d)
416
417        safe_d.setVar("BBCLASSEXTEND", extended)
418        _create_variants(datastores, extendedmap.keys(), extendfunc, onlyfinalise)
419
420    for variant in datastores.keys():
421        if variant:
422            try:
423                if not onlyfinalise or variant in onlyfinalise:
424                    finalize(fn, datastores[variant], variant)
425            except bb.parse.SkipRecipe as e:
426                datastores[variant].setVar("__SKIPPED", e.args[0])
427
428    datastores[""] = d
429    return datastores
430