data_smart.py 37 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067
  1. # ex:ts=4:sw=4:sts=4:et
  2. # -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
  3. """
  4. BitBake Smart Dictionary Implementation
  5. Functions for interacting with the data structure used by the
  6. BitBake build tools.
  7. """
  8. # Copyright (C) 2003, 2004 Chris Larson
  9. # Copyright (C) 2004, 2005 Seb Frankengul
  10. # Copyright (C) 2005, 2006 Holger Hans Peter Freyther
  11. # Copyright (C) 2005 Uli Luckas
  12. # Copyright (C) 2005 ROAD GmbH
  13. #
  14. # SPDX-License-Identifier: GPL-2.0-only
  15. #
  16. # Based on functions from the base bb module, Copyright 2003 Holger Schurig
  17. import copy, re, sys, traceback
  18. from collections import MutableMapping
  19. import logging
  20. import hashlib
  21. import bb, bb.codeparser
  22. from bb import utils
  23. from bb.COW import COWDictBase
  24. logger = logging.getLogger("BitBake.Data")
  25. __setvar_keyword__ = ["_append", "_prepend", "_remove"]
  26. __setvar_regexp__ = re.compile(r'(?P<base>.*?)(?P<keyword>_append|_prepend|_remove)(_(?P<add>[^A-Z]*))?$')
  27. __expand_var_regexp__ = re.compile(r"\${[a-zA-Z0-9\-_+./~]+?}")
  28. __expand_python_regexp__ = re.compile(r"\${@.+?}")
  29. __whitespace_split__ = re.compile(r'(\s)')
  30. __override_regexp__ = re.compile(r'[a-z0-9]+')
  31. def infer_caller_details(loginfo, parent = False, varval = True):
  32. """Save the caller the trouble of specifying everything."""
  33. # Save effort.
  34. if 'ignore' in loginfo and loginfo['ignore']:
  35. return
  36. # If nothing was provided, mark this as possibly unneeded.
  37. if not loginfo:
  38. loginfo['ignore'] = True
  39. return
  40. # Infer caller's likely values for variable (var) and value (value),
  41. # to reduce clutter in the rest of the code.
  42. above = None
  43. def set_above():
  44. try:
  45. raise Exception
  46. except Exception:
  47. tb = sys.exc_info()[2]
  48. if parent:
  49. return tb.tb_frame.f_back.f_back.f_back
  50. else:
  51. return tb.tb_frame.f_back.f_back
  52. if varval and ('variable' not in loginfo or 'detail' not in loginfo):
  53. if not above:
  54. above = set_above()
  55. lcls = above.f_locals.items()
  56. for k, v in lcls:
  57. if k == 'value' and 'detail' not in loginfo:
  58. loginfo['detail'] = v
  59. if k == 'var' and 'variable' not in loginfo:
  60. loginfo['variable'] = v
  61. # Infer file/line/function from traceback
  62. # Don't use traceback.extract_stack() since it fills the line contents which
  63. # we don't need and that hits stat syscalls
  64. if 'file' not in loginfo:
  65. if not above:
  66. above = set_above()
  67. f = above.f_back
  68. line = f.f_lineno
  69. file = f.f_code.co_filename
  70. func = f.f_code.co_name
  71. loginfo['file'] = file
  72. loginfo['line'] = line
  73. if func not in loginfo:
  74. loginfo['func'] = func
  75. class VariableParse:
  76. def __init__(self, varname, d, val = None):
  77. self.varname = varname
  78. self.d = d
  79. self.value = val
  80. self.references = set()
  81. self.execs = set()
  82. self.contains = {}
  83. def var_sub(self, match):
  84. key = match.group()[2:-1]
  85. if self.varname and key:
  86. if self.varname == key:
  87. raise Exception("variable %s references itself!" % self.varname)
  88. var = self.d.getVarFlag(key, "_content")
  89. self.references.add(key)
  90. if var is not None:
  91. return var
  92. else:
  93. return match.group()
  94. def python_sub(self, match):
  95. if isinstance(match, str):
  96. code = match
  97. else:
  98. code = match.group()[3:-1]
  99. if "_remote_data" in self.d:
  100. connector = self.d["_remote_data"]
  101. return connector.expandPythonRef(self.varname, code, self.d)
  102. if self.varname:
  103. varname = 'Var <%s>' % self.varname
  104. else:
  105. varname = '<expansion>'
  106. codeobj = compile(code.strip(), varname, "eval")
  107. parser = bb.codeparser.PythonParser(self.varname, logger)
  108. parser.parse_python(code)
  109. if self.varname:
  110. vardeps = self.d.getVarFlag(self.varname, "vardeps")
  111. if vardeps is None:
  112. parser.log.flush()
  113. else:
  114. parser.log.flush()
  115. self.references |= parser.references
  116. self.execs |= parser.execs
  117. for k in parser.contains:
  118. if k not in self.contains:
  119. self.contains[k] = parser.contains[k].copy()
  120. else:
  121. self.contains[k].update(parser.contains[k])
  122. value = utils.better_eval(codeobj, DataContext(self.d), {'d' : self.d})
  123. return str(value)
  124. class DataContext(dict):
  125. def __init__(self, metadata, **kwargs):
  126. self.metadata = metadata
  127. dict.__init__(self, **kwargs)
  128. self['d'] = metadata
  129. def __missing__(self, key):
  130. value = self.metadata.getVar(key)
  131. if value is None or self.metadata.getVarFlag(key, 'func', False):
  132. raise KeyError(key)
  133. else:
  134. return value
  135. class ExpansionError(Exception):
  136. def __init__(self, varname, expression, exception):
  137. self.expression = expression
  138. self.variablename = varname
  139. self.exception = exception
  140. if varname:
  141. if expression:
  142. self.msg = "Failure expanding variable %s, expression was %s which triggered exception %s: %s" % (varname, expression, type(exception).__name__, exception)
  143. else:
  144. self.msg = "Failure expanding variable %s: %s: %s" % (varname, type(exception).__name__, exception)
  145. else:
  146. self.msg = "Failure expanding expression %s which triggered exception %s: %s" % (expression, type(exception).__name__, exception)
  147. Exception.__init__(self, self.msg)
  148. self.args = (varname, expression, exception)
  149. def __str__(self):
  150. return self.msg
  151. class IncludeHistory(object):
  152. def __init__(self, parent = None, filename = '[TOP LEVEL]'):
  153. self.parent = parent
  154. self.filename = filename
  155. self.children = []
  156. self.current = self
  157. def copy(self):
  158. new = IncludeHistory(self.parent, self.filename)
  159. for c in self.children:
  160. new.children.append(c)
  161. return new
  162. def include(self, filename):
  163. newfile = IncludeHistory(self.current, filename)
  164. self.current.children.append(newfile)
  165. self.current = newfile
  166. return self
  167. def __enter__(self):
  168. pass
  169. def __exit__(self, a, b, c):
  170. if self.current.parent:
  171. self.current = self.current.parent
  172. else:
  173. bb.warn("Include log: Tried to finish '%s' at top level." % filename)
  174. return False
  175. def emit(self, o, level = 0):
  176. """Emit an include history file, and its children."""
  177. if level:
  178. spaces = " " * (level - 1)
  179. o.write("# %s%s" % (spaces, self.filename))
  180. if len(self.children) > 0:
  181. o.write(" includes:")
  182. else:
  183. o.write("#\n# INCLUDE HISTORY:\n#")
  184. level = level + 1
  185. for child in self.children:
  186. o.write("\n")
  187. child.emit(o, level)
  188. class VariableHistory(object):
  189. def __init__(self, dataroot):
  190. self.dataroot = dataroot
  191. self.variables = COWDictBase.copy()
  192. def copy(self):
  193. new = VariableHistory(self.dataroot)
  194. new.variables = self.variables.copy()
  195. return new
  196. def __getstate__(self):
  197. vardict = {}
  198. for k, v in self.variables.iteritems():
  199. vardict[k] = v
  200. return {'dataroot': self.dataroot,
  201. 'variables': vardict}
  202. def __setstate__(self, state):
  203. self.dataroot = state['dataroot']
  204. self.variables = COWDictBase.copy()
  205. for k, v in state['variables'].items():
  206. self.variables[k] = v
  207. def record(self, *kwonly, **loginfo):
  208. if not self.dataroot._tracking:
  209. return
  210. if len(kwonly) > 0:
  211. raise TypeError
  212. infer_caller_details(loginfo, parent = True)
  213. if 'ignore' in loginfo and loginfo['ignore']:
  214. return
  215. if 'op' not in loginfo or not loginfo['op']:
  216. loginfo['op'] = 'set'
  217. if 'detail' in loginfo:
  218. loginfo['detail'] = str(loginfo['detail'])
  219. if 'variable' not in loginfo or 'file' not in loginfo:
  220. raise ValueError("record() missing variable or file.")
  221. var = loginfo['variable']
  222. if var not in self.variables:
  223. self.variables[var] = []
  224. if not isinstance(self.variables[var], list):
  225. return
  226. if 'nodups' in loginfo and loginfo in self.variables[var]:
  227. return
  228. self.variables[var].append(loginfo.copy())
  229. def rename_variable_hist(self, oldvar, newvar):
  230. if not self.dataroot._tracking:
  231. return
  232. if oldvar not in self.variables:
  233. return
  234. if newvar not in self.variables:
  235. self.variables[newvar] = []
  236. for i in self.variables[oldvar]:
  237. self.variables[newvar].append(i.copy())
  238. def variable(self, var):
  239. remote_connector = self.dataroot.getVar('_remote_data', False)
  240. if remote_connector:
  241. varhistory = remote_connector.getVarHistory(var)
  242. else:
  243. varhistory = []
  244. if var in self.variables:
  245. varhistory.extend(self.variables[var])
  246. return varhistory
  247. def emit(self, var, oval, val, o, d):
  248. history = self.variable(var)
  249. # Append override history
  250. if var in d.overridedata:
  251. for (r, override) in d.overridedata[var]:
  252. for event in self.variable(r):
  253. loginfo = event.copy()
  254. if 'flag' in loginfo and not loginfo['flag'].startswith("_"):
  255. continue
  256. loginfo['variable'] = var
  257. loginfo['op'] = 'override[%s]:%s' % (override, loginfo['op'])
  258. history.append(loginfo)
  259. commentVal = re.sub('\n', '\n#', str(oval))
  260. if history:
  261. if len(history) == 1:
  262. o.write("#\n# $%s\n" % var)
  263. else:
  264. o.write("#\n# $%s [%d operations]\n" % (var, len(history)))
  265. for event in history:
  266. # o.write("# %s\n" % str(event))
  267. if 'func' in event:
  268. # If we have a function listed, this is internal
  269. # code, not an operation in a config file, and the
  270. # full path is distracting.
  271. event['file'] = re.sub('.*/', '', event['file'])
  272. display_func = ' [%s]' % event['func']
  273. else:
  274. display_func = ''
  275. if 'flag' in event:
  276. flag = '[%s] ' % (event['flag'])
  277. else:
  278. flag = ''
  279. o.write("# %s %s:%s%s\n# %s\"%s\"\n" % (event['op'], event['file'], event['line'], display_func, flag, re.sub('\n', '\n# ', event['detail'])))
  280. if len(history) > 1:
  281. o.write("# pre-expansion value:\n")
  282. o.write('# "%s"\n' % (commentVal))
  283. else:
  284. o.write("#\n# $%s\n# [no history recorded]\n#\n" % var)
  285. o.write('# "%s"\n' % (commentVal))
  286. def get_variable_files(self, var):
  287. """Get the files where operations are made on a variable"""
  288. var_history = self.variable(var)
  289. files = []
  290. for event in var_history:
  291. files.append(event['file'])
  292. return files
  293. def get_variable_lines(self, var, f):
  294. """Get the line where a operation is made on a variable in file f"""
  295. var_history = self.variable(var)
  296. lines = []
  297. for event in var_history:
  298. if f== event['file']:
  299. line = event['line']
  300. lines.append(line)
  301. return lines
  302. def get_variable_items_files(self, var, d):
  303. """
  304. Use variable history to map items added to a list variable and
  305. the files in which they were added.
  306. """
  307. history = self.variable(var)
  308. finalitems = (d.getVar(var) or '').split()
  309. filemap = {}
  310. isset = False
  311. for event in history:
  312. if 'flag' in event:
  313. continue
  314. if event['op'] == '_remove':
  315. continue
  316. if isset and event['op'] == 'set?':
  317. continue
  318. isset = True
  319. items = d.expand(event['detail']).split()
  320. for item in items:
  321. # This is a little crude but is belt-and-braces to avoid us
  322. # having to handle every possible operation type specifically
  323. if item in finalitems and not item in filemap:
  324. filemap[item] = event['file']
  325. return filemap
  326. def del_var_history(self, var, f=None, line=None):
  327. """If file f and line are not given, the entire history of var is deleted"""
  328. if var in self.variables:
  329. if f and line:
  330. self.variables[var] = [ x for x in self.variables[var] if x['file']!=f and x['line']!=line]
  331. else:
  332. self.variables[var] = []
  333. class DataSmart(MutableMapping):
  334. def __init__(self):
  335. self.dict = {}
  336. self.inchistory = IncludeHistory()
  337. self.varhistory = VariableHistory(self)
  338. self._tracking = False
  339. self.expand_cache = {}
  340. # cookie monster tribute
  341. # Need to be careful about writes to overridedata as
  342. # its only a shallow copy, could influence other data store
  343. # copies!
  344. self.overridedata = {}
  345. self.overrides = None
  346. self.overridevars = set(["OVERRIDES", "FILE"])
  347. self.inoverride = False
  348. def enableTracking(self):
  349. self._tracking = True
  350. def disableTracking(self):
  351. self._tracking = False
  352. def expandWithRefs(self, s, varname):
  353. if not isinstance(s, str): # sanity check
  354. return VariableParse(varname, self, s)
  355. varparse = VariableParse(varname, self)
  356. while s.find('${') != -1:
  357. olds = s
  358. try:
  359. s = __expand_var_regexp__.sub(varparse.var_sub, s)
  360. try:
  361. s = __expand_python_regexp__.sub(varparse.python_sub, s)
  362. except SyntaxError as e:
  363. # Likely unmatched brackets, just don't expand the expression
  364. if e.msg != "EOL while scanning string literal":
  365. raise
  366. if s == olds:
  367. break
  368. except ExpansionError:
  369. raise
  370. except bb.parse.SkipRecipe:
  371. raise
  372. except Exception as exc:
  373. tb = sys.exc_info()[2]
  374. raise ExpansionError(varname, s, exc).with_traceback(tb) from exc
  375. varparse.value = s
  376. return varparse
  377. def expand(self, s, varname = None):
  378. return self.expandWithRefs(s, varname).value
  379. def finalize(self, parent = False):
  380. return
  381. def internal_finalize(self, parent = False):
  382. """Performs final steps upon the datastore, including application of overrides"""
  383. self.overrides = None
  384. def need_overrides(self):
  385. if self.overrides is not None:
  386. return
  387. if self.inoverride:
  388. return
  389. for count in range(5):
  390. self.inoverride = True
  391. # Can end up here recursively so setup dummy values
  392. self.overrides = []
  393. self.overridesset = set()
  394. self.overrides = (self.getVar("OVERRIDES") or "").split(":") or []
  395. self.overridesset = set(self.overrides)
  396. self.inoverride = False
  397. self.expand_cache = {}
  398. newoverrides = (self.getVar("OVERRIDES") or "").split(":") or []
  399. if newoverrides == self.overrides:
  400. break
  401. self.overrides = newoverrides
  402. self.overridesset = set(self.overrides)
  403. else:
  404. bb.fatal("Overrides could not be expanded into a stable state after 5 iterations, overrides must be being referenced by other overridden variables in some recursive fashion. Please provide your configuration to bitbake-devel so we can laugh, er, I mean try and understand how to make it work.")
  405. def initVar(self, var):
  406. self.expand_cache = {}
  407. if not var in self.dict:
  408. self.dict[var] = {}
  409. def _findVar(self, var):
  410. dest = self.dict
  411. while dest:
  412. if var in dest:
  413. return dest[var], self.overridedata.get(var, None)
  414. if "_remote_data" in dest:
  415. connector = dest["_remote_data"]["_content"]
  416. return connector.getVar(var)
  417. if "_data" not in dest:
  418. break
  419. dest = dest["_data"]
  420. return None, self.overridedata.get(var, None)
  421. def _makeShadowCopy(self, var):
  422. if var in self.dict:
  423. return
  424. local_var, _ = self._findVar(var)
  425. if local_var:
  426. self.dict[var] = copy.copy(local_var)
  427. else:
  428. self.initVar(var)
  429. def setVar(self, var, value, **loginfo):
  430. #print("var=" + str(var) + " val=" + str(value))
  431. self.expand_cache = {}
  432. parsing=False
  433. if 'parsing' in loginfo:
  434. parsing=True
  435. if '_remote_data' in self.dict:
  436. connector = self.dict["_remote_data"]["_content"]
  437. res = connector.setVar(var, value)
  438. if not res:
  439. return
  440. if 'op' not in loginfo:
  441. loginfo['op'] = "set"
  442. match = __setvar_regexp__.match(var)
  443. if match and match.group("keyword") in __setvar_keyword__:
  444. base = match.group('base')
  445. keyword = match.group("keyword")
  446. override = match.group('add')
  447. l = self.getVarFlag(base, keyword, False) or []
  448. l.append([value, override])
  449. self.setVarFlag(base, keyword, l, ignore=True)
  450. # And cause that to be recorded:
  451. loginfo['detail'] = value
  452. loginfo['variable'] = base
  453. if override:
  454. loginfo['op'] = '%s[%s]' % (keyword, override)
  455. else:
  456. loginfo['op'] = keyword
  457. self.varhistory.record(**loginfo)
  458. # todo make sure keyword is not __doc__ or __module__
  459. # pay the cookie monster
  460. # more cookies for the cookie monster
  461. if '_' in var:
  462. self._setvar_update_overrides(base, **loginfo)
  463. if base in self.overridevars:
  464. self._setvar_update_overridevars(var, value)
  465. return
  466. if not var in self.dict:
  467. self._makeShadowCopy(var)
  468. if not parsing:
  469. if "_append" in self.dict[var]:
  470. del self.dict[var]["_append"]
  471. if "_prepend" in self.dict[var]:
  472. del self.dict[var]["_prepend"]
  473. if "_remove" in self.dict[var]:
  474. del self.dict[var]["_remove"]
  475. if var in self.overridedata:
  476. active = []
  477. self.need_overrides()
  478. for (r, o) in self.overridedata[var]:
  479. if o in self.overridesset:
  480. active.append(r)
  481. elif "_" in o:
  482. if set(o.split("_")).issubset(self.overridesset):
  483. active.append(r)
  484. for a in active:
  485. self.delVar(a)
  486. del self.overridedata[var]
  487. # more cookies for the cookie monster
  488. if '_' in var:
  489. self._setvar_update_overrides(var, **loginfo)
  490. # setting var
  491. self.dict[var]["_content"] = value
  492. self.varhistory.record(**loginfo)
  493. if var in self.overridevars:
  494. self._setvar_update_overridevars(var, value)
  495. def _setvar_update_overridevars(self, var, value):
  496. vardata = self.expandWithRefs(value, var)
  497. new = vardata.references
  498. new.update(vardata.contains.keys())
  499. while not new.issubset(self.overridevars):
  500. nextnew = set()
  501. self.overridevars.update(new)
  502. for i in new:
  503. vardata = self.expandWithRefs(self.getVar(i), i)
  504. nextnew.update(vardata.references)
  505. nextnew.update(vardata.contains.keys())
  506. new = nextnew
  507. self.internal_finalize(True)
  508. def _setvar_update_overrides(self, var, **loginfo):
  509. # aka pay the cookie monster
  510. override = var[var.rfind('_')+1:]
  511. shortvar = var[:var.rfind('_')]
  512. while override and __override_regexp__.match(override):
  513. if shortvar not in self.overridedata:
  514. self.overridedata[shortvar] = []
  515. if [var, override] not in self.overridedata[shortvar]:
  516. # Force CoW by recreating the list first
  517. self.overridedata[shortvar] = list(self.overridedata[shortvar])
  518. self.overridedata[shortvar].append([var, override])
  519. override = None
  520. if "_" in shortvar:
  521. override = var[shortvar.rfind('_')+1:]
  522. shortvar = var[:shortvar.rfind('_')]
  523. if len(shortvar) == 0:
  524. override = None
  525. def getVar(self, var, expand=True, noweakdefault=False, parsing=False):
  526. return self.getVarFlag(var, "_content", expand, noweakdefault, parsing)
  527. def renameVar(self, key, newkey, **loginfo):
  528. """
  529. Rename the variable key to newkey
  530. """
  531. if '_remote_data' in self.dict:
  532. connector = self.dict["_remote_data"]["_content"]
  533. res = connector.renameVar(key, newkey)
  534. if not res:
  535. return
  536. val = self.getVar(key, 0, parsing=True)
  537. if val is not None:
  538. self.varhistory.rename_variable_hist(key, newkey)
  539. loginfo['variable'] = newkey
  540. loginfo['op'] = 'rename from %s' % key
  541. loginfo['detail'] = val
  542. self.varhistory.record(**loginfo)
  543. self.setVar(newkey, val, ignore=True, parsing=True)
  544. for i in (__setvar_keyword__):
  545. src = self.getVarFlag(key, i, False)
  546. if src is None:
  547. continue
  548. dest = self.getVarFlag(newkey, i, False) or []
  549. dest.extend(src)
  550. self.setVarFlag(newkey, i, dest, ignore=True)
  551. if key in self.overridedata:
  552. self.overridedata[newkey] = []
  553. for (v, o) in self.overridedata[key]:
  554. self.overridedata[newkey].append([v.replace(key, newkey), o])
  555. self.renameVar(v, v.replace(key, newkey))
  556. if '_' in newkey and val is None:
  557. self._setvar_update_overrides(newkey, **loginfo)
  558. loginfo['variable'] = key
  559. loginfo['op'] = 'rename (to)'
  560. loginfo['detail'] = newkey
  561. self.varhistory.record(**loginfo)
  562. self.delVar(key, ignore=True)
  563. def appendVar(self, var, value, **loginfo):
  564. loginfo['op'] = 'append'
  565. self.varhistory.record(**loginfo)
  566. self.setVar(var + "_append", value, ignore=True, parsing=True)
  567. def prependVar(self, var, value, **loginfo):
  568. loginfo['op'] = 'prepend'
  569. self.varhistory.record(**loginfo)
  570. self.setVar(var + "_prepend", value, ignore=True, parsing=True)
  571. def delVar(self, var, **loginfo):
  572. self.expand_cache = {}
  573. if '_remote_data' in self.dict:
  574. connector = self.dict["_remote_data"]["_content"]
  575. res = connector.delVar(var)
  576. if not res:
  577. return
  578. loginfo['detail'] = ""
  579. loginfo['op'] = 'del'
  580. self.varhistory.record(**loginfo)
  581. self.dict[var] = {}
  582. if var in self.overridedata:
  583. del self.overridedata[var]
  584. if '_' in var:
  585. override = var[var.rfind('_')+1:]
  586. shortvar = var[:var.rfind('_')]
  587. while override and override.islower():
  588. try:
  589. if shortvar in self.overridedata:
  590. # Force CoW by recreating the list first
  591. self.overridedata[shortvar] = list(self.overridedata[shortvar])
  592. self.overridedata[shortvar].remove([var, override])
  593. except ValueError as e:
  594. pass
  595. override = None
  596. if "_" in shortvar:
  597. override = var[shortvar.rfind('_')+1:]
  598. shortvar = var[:shortvar.rfind('_')]
  599. if len(shortvar) == 0:
  600. override = None
  601. def setVarFlag(self, var, flag, value, **loginfo):
  602. self.expand_cache = {}
  603. if '_remote_data' in self.dict:
  604. connector = self.dict["_remote_data"]["_content"]
  605. res = connector.setVarFlag(var, flag, value)
  606. if not res:
  607. return
  608. if 'op' not in loginfo:
  609. loginfo['op'] = "set"
  610. loginfo['flag'] = flag
  611. self.varhistory.record(**loginfo)
  612. if not var in self.dict:
  613. self._makeShadowCopy(var)
  614. self.dict[var][flag] = value
  615. if flag == "_defaultval" and '_' in var:
  616. self._setvar_update_overrides(var, **loginfo)
  617. if flag == "_defaultval" and var in self.overridevars:
  618. self._setvar_update_overridevars(var, value)
  619. if flag == "unexport" or flag == "export":
  620. if not "__exportlist" in self.dict:
  621. self._makeShadowCopy("__exportlist")
  622. if not "_content" in self.dict["__exportlist"]:
  623. self.dict["__exportlist"]["_content"] = set()
  624. self.dict["__exportlist"]["_content"].add(var)
  625. def getVarFlag(self, var, flag, expand=True, noweakdefault=False, parsing=False, retparser=False):
  626. if flag == "_content":
  627. cachename = var
  628. else:
  629. if not flag:
  630. bb.warn("Calling getVarFlag with flag unset is invalid")
  631. return None
  632. cachename = var + "[" + flag + "]"
  633. if expand and cachename in self.expand_cache:
  634. return self.expand_cache[cachename].value
  635. local_var, overridedata = self._findVar(var)
  636. value = None
  637. removes = set()
  638. if flag == "_content" and overridedata is not None and not parsing:
  639. match = False
  640. active = {}
  641. self.need_overrides()
  642. for (r, o) in overridedata:
  643. # What about double overrides both with "_" in the name?
  644. if o in self.overridesset:
  645. active[o] = r
  646. elif "_" in o:
  647. if set(o.split("_")).issubset(self.overridesset):
  648. active[o] = r
  649. mod = True
  650. while mod:
  651. mod = False
  652. for o in self.overrides:
  653. for a in active.copy():
  654. if a.endswith("_" + o):
  655. t = active[a]
  656. del active[a]
  657. active[a.replace("_" + o, "")] = t
  658. mod = True
  659. elif a == o:
  660. match = active[a]
  661. del active[a]
  662. if match:
  663. value, subparser = self.getVarFlag(match, "_content", False, retparser=True)
  664. if hasattr(subparser, "removes"):
  665. # We have to carry the removes from the overridden variable to apply at the
  666. # end of processing
  667. removes = subparser.removes
  668. if local_var is not None and value is None:
  669. if flag in local_var:
  670. value = copy.copy(local_var[flag])
  671. elif flag == "_content" and "_defaultval" in local_var and not noweakdefault:
  672. value = copy.copy(local_var["_defaultval"])
  673. if flag == "_content" and local_var is not None and "_append" in local_var and not parsing:
  674. if not value:
  675. value = ""
  676. self.need_overrides()
  677. for (r, o) in local_var["_append"]:
  678. match = True
  679. if o:
  680. for o2 in o.split("_"):
  681. if not o2 in self.overrides:
  682. match = False
  683. if match:
  684. value = value + r
  685. if flag == "_content" and local_var is not None and "_prepend" in local_var and not parsing:
  686. if not value:
  687. value = ""
  688. self.need_overrides()
  689. for (r, o) in local_var["_prepend"]:
  690. match = True
  691. if o:
  692. for o2 in o.split("_"):
  693. if not o2 in self.overrides:
  694. match = False
  695. if match:
  696. value = r + value
  697. parser = None
  698. if expand or retparser:
  699. parser = self.expandWithRefs(value, cachename)
  700. if expand:
  701. value = parser.value
  702. if value and flag == "_content" and local_var is not None and "_remove" in local_var and not parsing:
  703. self.need_overrides()
  704. for (r, o) in local_var["_remove"]:
  705. match = True
  706. if o:
  707. for o2 in o.split("_"):
  708. if not o2 in self.overrides:
  709. match = False
  710. if match:
  711. removes.add(r)
  712. if value and flag == "_content" and not parsing:
  713. if removes and parser:
  714. expanded_removes = {}
  715. for r in removes:
  716. expanded_removes[r] = self.expand(r).split()
  717. parser.removes = set()
  718. val = ""
  719. for v in __whitespace_split__.split(parser.value):
  720. skip = False
  721. for r in removes:
  722. if v in expanded_removes[r]:
  723. parser.removes.add(r)
  724. skip = True
  725. if skip:
  726. continue
  727. val = val + v
  728. parser.value = val
  729. if expand:
  730. value = parser.value
  731. if parser:
  732. self.expand_cache[cachename] = parser
  733. if retparser:
  734. return value, parser
  735. return value
  736. def delVarFlag(self, var, flag, **loginfo):
  737. self.expand_cache = {}
  738. if '_remote_data' in self.dict:
  739. connector = self.dict["_remote_data"]["_content"]
  740. res = connector.delVarFlag(var, flag)
  741. if not res:
  742. return
  743. local_var, _ = self._findVar(var)
  744. if not local_var:
  745. return
  746. if not var in self.dict:
  747. self._makeShadowCopy(var)
  748. if var in self.dict and flag in self.dict[var]:
  749. loginfo['detail'] = ""
  750. loginfo['op'] = 'delFlag'
  751. loginfo['flag'] = flag
  752. self.varhistory.record(**loginfo)
  753. del self.dict[var][flag]
  754. def appendVarFlag(self, var, flag, value, **loginfo):
  755. loginfo['op'] = 'append'
  756. loginfo['flag'] = flag
  757. self.varhistory.record(**loginfo)
  758. newvalue = (self.getVarFlag(var, flag, False) or "") + value
  759. self.setVarFlag(var, flag, newvalue, ignore=True)
  760. def prependVarFlag(self, var, flag, value, **loginfo):
  761. loginfo['op'] = 'prepend'
  762. loginfo['flag'] = flag
  763. self.varhistory.record(**loginfo)
  764. newvalue = value + (self.getVarFlag(var, flag, False) or "")
  765. self.setVarFlag(var, flag, newvalue, ignore=True)
  766. def setVarFlags(self, var, flags, **loginfo):
  767. self.expand_cache = {}
  768. infer_caller_details(loginfo)
  769. if not var in self.dict:
  770. self._makeShadowCopy(var)
  771. for i in flags:
  772. if i == "_content":
  773. continue
  774. loginfo['flag'] = i
  775. loginfo['detail'] = flags[i]
  776. self.varhistory.record(**loginfo)
  777. self.dict[var][i] = flags[i]
  778. def getVarFlags(self, var, expand = False, internalflags=False):
  779. local_var, _ = self._findVar(var)
  780. flags = {}
  781. if local_var:
  782. for i in local_var:
  783. if i.startswith("_") and not internalflags:
  784. continue
  785. flags[i] = local_var[i]
  786. if expand and i in expand:
  787. flags[i] = self.expand(flags[i], var + "[" + i + "]")
  788. if len(flags) == 0:
  789. return None
  790. return flags
  791. def delVarFlags(self, var, **loginfo):
  792. self.expand_cache = {}
  793. if not var in self.dict:
  794. self._makeShadowCopy(var)
  795. if var in self.dict:
  796. content = None
  797. loginfo['op'] = 'delete flags'
  798. self.varhistory.record(**loginfo)
  799. # try to save the content
  800. if "_content" in self.dict[var]:
  801. content = self.dict[var]["_content"]
  802. self.dict[var] = {}
  803. self.dict[var]["_content"] = content
  804. else:
  805. del self.dict[var]
  806. def createCopy(self):
  807. """
  808. Create a copy of self by setting _data to self
  809. """
  810. # we really want this to be a DataSmart...
  811. data = DataSmart()
  812. data.dict["_data"] = self.dict
  813. data.varhistory = self.varhistory.copy()
  814. data.varhistory.dataroot = data
  815. data.inchistory = self.inchistory.copy()
  816. data._tracking = self._tracking
  817. data.overrides = None
  818. data.overridevars = copy.copy(self.overridevars)
  819. # Should really be a deepcopy but has heavy overhead.
  820. # Instead, we're careful with writes.
  821. data.overridedata = copy.copy(self.overridedata)
  822. return data
  823. def expandVarref(self, variable, parents=False):
  824. """Find all references to variable in the data and expand it
  825. in place, optionally descending to parent datastores."""
  826. if parents:
  827. keys = iter(self)
  828. else:
  829. keys = self.localkeys()
  830. ref = '${%s}' % variable
  831. value = self.getVar(variable, False)
  832. for key in keys:
  833. referrervalue = self.getVar(key, False)
  834. if referrervalue and ref in referrervalue:
  835. self.setVar(key, referrervalue.replace(ref, value))
  836. def localkeys(self):
  837. for key in self.dict:
  838. if key not in ['_data', '_remote_data']:
  839. yield key
  840. def __iter__(self):
  841. deleted = set()
  842. overrides = set()
  843. def keylist(d):
  844. klist = set()
  845. for key in d:
  846. if key in ["_data", "_remote_data"]:
  847. continue
  848. if key in deleted:
  849. continue
  850. if key in overrides:
  851. continue
  852. if not d[key]:
  853. deleted.add(key)
  854. continue
  855. klist.add(key)
  856. if "_data" in d:
  857. klist |= keylist(d["_data"])
  858. if "_remote_data" in d:
  859. connector = d["_remote_data"]["_content"]
  860. for key in connector.getKeys():
  861. if key in deleted:
  862. continue
  863. klist.add(key)
  864. return klist
  865. self.need_overrides()
  866. for var in self.overridedata:
  867. for (r, o) in self.overridedata[var]:
  868. if o in self.overridesset:
  869. overrides.add(var)
  870. elif "_" in o:
  871. if set(o.split("_")).issubset(self.overridesset):
  872. overrides.add(var)
  873. for k in keylist(self.dict):
  874. yield k
  875. for k in overrides:
  876. yield k
  877. def __len__(self):
  878. return len(frozenset(iter(self)))
  879. def __getitem__(self, item):
  880. value = self.getVar(item, False)
  881. if value is None:
  882. raise KeyError(item)
  883. else:
  884. return value
  885. def __setitem__(self, var, value):
  886. self.setVar(var, value)
  887. def __delitem__(self, var):
  888. self.delVar(var)
  889. def get_hash(self):
  890. data = {}
  891. d = self.createCopy()
  892. bb.data.expandKeys(d)
  893. config_whitelist = set((d.getVar("BB_HASHCONFIG_WHITELIST") or "").split())
  894. keys = set(key for key in iter(d) if not key.startswith("__"))
  895. for key in keys:
  896. if key in config_whitelist:
  897. continue
  898. value = d.getVar(key, False) or ""
  899. data.update({key:value})
  900. varflags = d.getVarFlags(key, internalflags = True)
  901. if not varflags:
  902. continue
  903. for f in varflags:
  904. if f == "_content":
  905. continue
  906. data.update({'%s[%s]' % (key, f):varflags[f]})
  907. for key in ["__BBTASKS", "__BBANONFUNCS", "__BBHANDLERS"]:
  908. bb_list = d.getVar(key, False) or []
  909. data.update({key:str(bb_list)})
  910. if key == "__BBANONFUNCS":
  911. for i in bb_list:
  912. value = d.getVar(i, False) or ""
  913. data.update({i:value})
  914. data_str = str([(k, data[k]) for k in sorted(data.keys())])
  915. return hashlib.sha256(data_str.encode("utf-8")).hexdigest()