data_smart.py 37 KB

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