ast.py 16 KB

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