ast.py 15 KB

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