ast.py 15 KB

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