data_smart.py 37 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065
  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, d):
  301. """
  302. Use variable history to map items added to a list variable and
  303. the files in which they were added.
  304. """
  305. history = self.variable(var)
  306. finalitems = (d.getVar(var) or '').split()
  307. filemap = {}
  308. isset = False
  309. for event in history:
  310. if 'flag' in event:
  311. continue
  312. if event['op'] == '_remove':
  313. continue
  314. if isset and event['op'] == 'set?':
  315. continue
  316. isset = True
  317. items = d.expand(event['detail']).split()
  318. for item in items:
  319. # This is a little crude but is belt-and-braces to avoid us
  320. # having to handle every possible operation type specifically
  321. if item in finalitems and not item in filemap:
  322. filemap[item] = event['file']
  323. return filemap
  324. def del_var_history(self, var, f=None, line=None):
  325. """If file f and line are not given, the entire history of var is deleted"""
  326. if var in self.variables:
  327. if f and line:
  328. self.variables[var] = [ x for x in self.variables[var] if x['file']!=f and x['line']!=line]
  329. else:
  330. self.variables[var] = []
  331. class DataSmart(MutableMapping):
  332. def __init__(self):
  333. self.dict = {}
  334. self.inchistory = IncludeHistory()
  335. self.varhistory = VariableHistory(self)
  336. self._tracking = False
  337. self.expand_cache = {}
  338. # cookie monster tribute
  339. # Need to be careful about writes to overridedata as
  340. # its only a shallow copy, could influence other data store
  341. # copies!
  342. self.overridedata = {}
  343. self.overrides = None
  344. self.overridevars = set(["OVERRIDES", "FILE"])
  345. self.inoverride = False
  346. def enableTracking(self):
  347. self._tracking = True
  348. def disableTracking(self):
  349. self._tracking = False
  350. def expandWithRefs(self, s, varname):
  351. if not isinstance(s, str): # sanity check
  352. return VariableParse(varname, self, s)
  353. varparse = VariableParse(varname, self)
  354. while s.find('${') != -1:
  355. olds = s
  356. try:
  357. s = __expand_var_regexp__.sub(varparse.var_sub, s)
  358. try:
  359. s = __expand_python_regexp__.sub(varparse.python_sub, s)
  360. except SyntaxError as e:
  361. # Likely unmatched brackets, just don't expand the expression
  362. if e.msg != "EOL while scanning string literal":
  363. raise
  364. if s == olds:
  365. break
  366. except ExpansionError:
  367. raise
  368. except bb.parse.SkipRecipe:
  369. raise
  370. except Exception as exc:
  371. tb = sys.exc_info()[2]
  372. raise ExpansionError(varname, s, exc).with_traceback(tb) from exc
  373. varparse.value = s
  374. return varparse
  375. def expand(self, s, varname = None):
  376. return self.expandWithRefs(s, varname).value
  377. def finalize(self, parent = False):
  378. return
  379. def internal_finalize(self, parent = False):
  380. """Performs final steps upon the datastore, including application of overrides"""
  381. self.overrides = None
  382. def need_overrides(self):
  383. if self.overrides is not None:
  384. return
  385. if self.inoverride:
  386. return
  387. for count in range(5):
  388. self.inoverride = True
  389. # Can end up here recursively so setup dummy values
  390. self.overrides = []
  391. self.overridesset = set()
  392. self.overrides = (self.getVar("OVERRIDES") or "").split(":") or []
  393. self.overridesset = set(self.overrides)
  394. self.inoverride = False
  395. self.expand_cache = {}
  396. newoverrides = (self.getVar("OVERRIDES") or "").split(":") or []
  397. if newoverrides == self.overrides:
  398. break
  399. self.overrides = newoverrides
  400. self.overridesset = set(self.overrides)
  401. else:
  402. 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.")
  403. def initVar(self, var):
  404. self.expand_cache = {}
  405. if not var in self.dict:
  406. self.dict[var] = {}
  407. def _findVar(self, var):
  408. dest = self.dict
  409. while dest:
  410. if var in dest:
  411. return dest[var], self.overridedata.get(var, None)
  412. if "_remote_data" in dest:
  413. connector = dest["_remote_data"]["_content"]
  414. return connector.getVar(var)
  415. if "_data" not in dest:
  416. break
  417. dest = dest["_data"]
  418. return None, self.overridedata.get(var, None)
  419. def _makeShadowCopy(self, var):
  420. if var in self.dict:
  421. return
  422. local_var, _ = self._findVar(var)
  423. if local_var:
  424. self.dict[var] = copy.copy(local_var)
  425. else:
  426. self.initVar(var)
  427. def setVar(self, var, value, **loginfo):
  428. #print("var=" + str(var) + " val=" + str(value))
  429. self.expand_cache = {}
  430. parsing=False
  431. if 'parsing' in loginfo:
  432. parsing=True
  433. if '_remote_data' in self.dict:
  434. connector = self.dict["_remote_data"]["_content"]
  435. res = connector.setVar(var, value)
  436. if not res:
  437. return
  438. if 'op' not in loginfo:
  439. loginfo['op'] = "set"
  440. match = __setvar_regexp__.match(var)
  441. if match and match.group("keyword") in __setvar_keyword__:
  442. base = match.group('base')
  443. keyword = match.group("keyword")
  444. override = match.group('add')
  445. l = self.getVarFlag(base, keyword, False) or []
  446. l.append([value, override])
  447. self.setVarFlag(base, keyword, l, ignore=True)
  448. # And cause that to be recorded:
  449. loginfo['detail'] = value
  450. loginfo['variable'] = base
  451. if override:
  452. loginfo['op'] = '%s[%s]' % (keyword, override)
  453. else:
  454. loginfo['op'] = keyword
  455. self.varhistory.record(**loginfo)
  456. # todo make sure keyword is not __doc__ or __module__
  457. # pay the cookie monster
  458. # more cookies for the cookie monster
  459. if '_' in var:
  460. self._setvar_update_overrides(base, **loginfo)
  461. if base in self.overridevars:
  462. self._setvar_update_overridevars(var, value)
  463. return
  464. if not var in self.dict:
  465. self._makeShadowCopy(var)
  466. if not parsing:
  467. if "_append" in self.dict[var]:
  468. del self.dict[var]["_append"]
  469. if "_prepend" in self.dict[var]:
  470. del self.dict[var]["_prepend"]
  471. if "_remove" in self.dict[var]:
  472. del self.dict[var]["_remove"]
  473. if var in self.overridedata:
  474. active = []
  475. self.need_overrides()
  476. for (r, o) in self.overridedata[var]:
  477. if o in self.overridesset:
  478. active.append(r)
  479. elif "_" in o:
  480. if set(o.split("_")).issubset(self.overridesset):
  481. active.append(r)
  482. for a in active:
  483. self.delVar(a)
  484. del self.overridedata[var]
  485. # more cookies for the cookie monster
  486. if '_' in var:
  487. self._setvar_update_overrides(var, **loginfo)
  488. # setting var
  489. self.dict[var]["_content"] = value
  490. self.varhistory.record(**loginfo)
  491. if var in self.overridevars:
  492. self._setvar_update_overridevars(var, value)
  493. def _setvar_update_overridevars(self, var, value):
  494. vardata = self.expandWithRefs(value, var)
  495. new = vardata.references
  496. new.update(vardata.contains.keys())
  497. while not new.issubset(self.overridevars):
  498. nextnew = set()
  499. self.overridevars.update(new)
  500. for i in new:
  501. vardata = self.expandWithRefs(self.getVar(i), i)
  502. nextnew.update(vardata.references)
  503. nextnew.update(vardata.contains.keys())
  504. new = nextnew
  505. self.internal_finalize(True)
  506. def _setvar_update_overrides(self, var, **loginfo):
  507. # aka pay the cookie monster
  508. override = var[var.rfind('_')+1:]
  509. shortvar = var[:var.rfind('_')]
  510. while override and __override_regexp__.match(override):
  511. if shortvar not in self.overridedata:
  512. self.overridedata[shortvar] = []
  513. if [var, override] not in self.overridedata[shortvar]:
  514. # Force CoW by recreating the list first
  515. self.overridedata[shortvar] = list(self.overridedata[shortvar])
  516. self.overridedata[shortvar].append([var, override])
  517. override = None
  518. if "_" in shortvar:
  519. override = var[shortvar.rfind('_')+1:]
  520. shortvar = var[:shortvar.rfind('_')]
  521. if len(shortvar) == 0:
  522. override = None
  523. def getVar(self, var, expand=True, noweakdefault=False, parsing=False):
  524. return self.getVarFlag(var, "_content", expand, noweakdefault, parsing)
  525. def renameVar(self, key, newkey, **loginfo):
  526. """
  527. Rename the variable key to newkey
  528. """
  529. if '_remote_data' in self.dict:
  530. connector = self.dict["_remote_data"]["_content"]
  531. res = connector.renameVar(key, newkey)
  532. if not res:
  533. return
  534. val = self.getVar(key, 0, parsing=True)
  535. if val is not None:
  536. self.varhistory.rename_variable_hist(key, newkey)
  537. loginfo['variable'] = newkey
  538. loginfo['op'] = 'rename from %s' % key
  539. loginfo['detail'] = val
  540. self.varhistory.record(**loginfo)
  541. self.setVar(newkey, val, ignore=True, parsing=True)
  542. for i in (__setvar_keyword__):
  543. src = self.getVarFlag(key, i, False)
  544. if src is None:
  545. continue
  546. dest = self.getVarFlag(newkey, i, False) or []
  547. dest.extend(src)
  548. self.setVarFlag(newkey, i, dest, ignore=True)
  549. if key in self.overridedata:
  550. self.overridedata[newkey] = []
  551. for (v, o) in self.overridedata[key]:
  552. self.overridedata[newkey].append([v.replace(key, newkey), o])
  553. self.renameVar(v, v.replace(key, newkey))
  554. if '_' in newkey and val is None:
  555. self._setvar_update_overrides(newkey, **loginfo)
  556. loginfo['variable'] = key
  557. loginfo['op'] = 'rename (to)'
  558. loginfo['detail'] = newkey
  559. self.varhistory.record(**loginfo)
  560. self.delVar(key, ignore=True)
  561. def appendVar(self, var, value, **loginfo):
  562. loginfo['op'] = 'append'
  563. self.varhistory.record(**loginfo)
  564. self.setVar(var + "_append", value, ignore=True, parsing=True)
  565. def prependVar(self, var, value, **loginfo):
  566. loginfo['op'] = 'prepend'
  567. self.varhistory.record(**loginfo)
  568. self.setVar(var + "_prepend", value, ignore=True, parsing=True)
  569. def delVar(self, var, **loginfo):
  570. self.expand_cache = {}
  571. if '_remote_data' in self.dict:
  572. connector = self.dict["_remote_data"]["_content"]
  573. res = connector.delVar(var)
  574. if not res:
  575. return
  576. loginfo['detail'] = ""
  577. loginfo['op'] = 'del'
  578. self.varhistory.record(**loginfo)
  579. self.dict[var] = {}
  580. if var in self.overridedata:
  581. del self.overridedata[var]
  582. if '_' in var:
  583. override = var[var.rfind('_')+1:]
  584. shortvar = var[:var.rfind('_')]
  585. while override and override.islower():
  586. try:
  587. if shortvar in self.overridedata:
  588. # Force CoW by recreating the list first
  589. self.overridedata[shortvar] = list(self.overridedata[shortvar])
  590. self.overridedata[shortvar].remove([var, override])
  591. except ValueError as e:
  592. pass
  593. override = None
  594. if "_" in shortvar:
  595. override = var[shortvar.rfind('_')+1:]
  596. shortvar = var[:shortvar.rfind('_')]
  597. if len(shortvar) == 0:
  598. override = None
  599. def setVarFlag(self, var, flag, value, **loginfo):
  600. self.expand_cache = {}
  601. if '_remote_data' in self.dict:
  602. connector = self.dict["_remote_data"]["_content"]
  603. res = connector.setVarFlag(var, flag, value)
  604. if not res:
  605. return
  606. if 'op' not in loginfo:
  607. loginfo['op'] = "set"
  608. loginfo['flag'] = flag
  609. self.varhistory.record(**loginfo)
  610. if not var in self.dict:
  611. self._makeShadowCopy(var)
  612. self.dict[var][flag] = value
  613. if flag == "_defaultval" and '_' in var:
  614. self._setvar_update_overrides(var, **loginfo)
  615. if flag == "_defaultval" and var in self.overridevars:
  616. self._setvar_update_overridevars(var, value)
  617. if flag == "unexport" or flag == "export":
  618. if not "__exportlist" in self.dict:
  619. self._makeShadowCopy("__exportlist")
  620. if not "_content" in self.dict["__exportlist"]:
  621. self.dict["__exportlist"]["_content"] = set()
  622. self.dict["__exportlist"]["_content"].add(var)
  623. def getVarFlag(self, var, flag, expand=True, noweakdefault=False, parsing=False, retparser=False):
  624. if flag == "_content":
  625. cachename = var
  626. else:
  627. if not flag:
  628. bb.warn("Calling getVarFlag with flag unset is invalid")
  629. return None
  630. cachename = var + "[" + flag + "]"
  631. if expand and cachename in self.expand_cache:
  632. return self.expand_cache[cachename].value
  633. local_var, overridedata = self._findVar(var)
  634. value = None
  635. removes = set()
  636. if flag == "_content" and overridedata is not None and not parsing:
  637. match = False
  638. active = {}
  639. self.need_overrides()
  640. for (r, o) in overridedata:
  641. # What about double overrides both with "_" in the name?
  642. if o in self.overridesset:
  643. active[o] = r
  644. elif "_" in o:
  645. if set(o.split("_")).issubset(self.overridesset):
  646. active[o] = r
  647. mod = True
  648. while mod:
  649. mod = False
  650. for o in self.overrides:
  651. for a in active.copy():
  652. if a.endswith("_" + o):
  653. t = active[a]
  654. del active[a]
  655. active[a.replace("_" + o, "")] = t
  656. mod = True
  657. elif a == o:
  658. match = active[a]
  659. del active[a]
  660. if match:
  661. value, subparser = self.getVarFlag(match, "_content", False, retparser=True)
  662. if hasattr(subparser, "removes"):
  663. # We have to carry the removes from the overridden variable to apply at the
  664. # end of processing
  665. removes = subparser.removes
  666. if local_var is not None and value is None:
  667. if flag in local_var:
  668. value = copy.copy(local_var[flag])
  669. elif flag == "_content" and "_defaultval" in local_var and not noweakdefault:
  670. value = copy.copy(local_var["_defaultval"])
  671. if flag == "_content" and local_var is not None and "_append" in local_var and not parsing:
  672. if not value:
  673. value = ""
  674. self.need_overrides()
  675. for (r, o) in local_var["_append"]:
  676. match = True
  677. if o:
  678. for o2 in o.split("_"):
  679. if not o2 in self.overrides:
  680. match = False
  681. if match:
  682. value = value + r
  683. if flag == "_content" and local_var is not None and "_prepend" in local_var and not parsing:
  684. if not value:
  685. value = ""
  686. self.need_overrides()
  687. for (r, o) in local_var["_prepend"]:
  688. match = True
  689. if o:
  690. for o2 in o.split("_"):
  691. if not o2 in self.overrides:
  692. match = False
  693. if match:
  694. value = r + value
  695. parser = None
  696. if expand or retparser:
  697. parser = self.expandWithRefs(value, cachename)
  698. if expand:
  699. value = parser.value
  700. if value and flag == "_content" and local_var is not None and "_remove" in local_var and not parsing:
  701. self.need_overrides()
  702. for (r, o) in local_var["_remove"]:
  703. match = True
  704. if o:
  705. for o2 in o.split("_"):
  706. if not o2 in self.overrides:
  707. match = False
  708. if match:
  709. removes.add(r)
  710. if value and flag == "_content" and not parsing:
  711. if removes and parser:
  712. expanded_removes = {}
  713. for r in removes:
  714. expanded_removes[r] = self.expand(r).split()
  715. parser.removes = set()
  716. val = ""
  717. for v in __whitespace_split__.split(parser.value):
  718. skip = False
  719. for r in removes:
  720. if v in expanded_removes[r]:
  721. parser.removes.add(r)
  722. skip = True
  723. if skip:
  724. continue
  725. val = val + v
  726. parser.value = val
  727. if expand:
  728. value = parser.value
  729. if parser:
  730. self.expand_cache[cachename] = parser
  731. if retparser:
  732. return value, parser
  733. return value
  734. def delVarFlag(self, var, flag, **loginfo):
  735. self.expand_cache = {}
  736. if '_remote_data' in self.dict:
  737. connector = self.dict["_remote_data"]["_content"]
  738. res = connector.delVarFlag(var, flag)
  739. if not res:
  740. return
  741. local_var, _ = self._findVar(var)
  742. if not local_var:
  743. return
  744. if not var in self.dict:
  745. self._makeShadowCopy(var)
  746. if var in self.dict and flag in self.dict[var]:
  747. loginfo['detail'] = ""
  748. loginfo['op'] = 'delFlag'
  749. loginfo['flag'] = flag
  750. self.varhistory.record(**loginfo)
  751. del self.dict[var][flag]
  752. def appendVarFlag(self, var, flag, value, **loginfo):
  753. loginfo['op'] = 'append'
  754. loginfo['flag'] = flag
  755. self.varhistory.record(**loginfo)
  756. newvalue = (self.getVarFlag(var, flag, False) or "") + value
  757. self.setVarFlag(var, flag, newvalue, ignore=True)
  758. def prependVarFlag(self, var, flag, value, **loginfo):
  759. loginfo['op'] = 'prepend'
  760. loginfo['flag'] = flag
  761. self.varhistory.record(**loginfo)
  762. newvalue = value + (self.getVarFlag(var, flag, False) or "")
  763. self.setVarFlag(var, flag, newvalue, ignore=True)
  764. def setVarFlags(self, var, flags, **loginfo):
  765. self.expand_cache = {}
  766. infer_caller_details(loginfo)
  767. if not var in self.dict:
  768. self._makeShadowCopy(var)
  769. for i in flags:
  770. if i == "_content":
  771. continue
  772. loginfo['flag'] = i
  773. loginfo['detail'] = flags[i]
  774. self.varhistory.record(**loginfo)
  775. self.dict[var][i] = flags[i]
  776. def getVarFlags(self, var, expand = False, internalflags=False):
  777. local_var, _ = self._findVar(var)
  778. flags = {}
  779. if local_var:
  780. for i in local_var:
  781. if i.startswith("_") and not internalflags:
  782. continue
  783. flags[i] = local_var[i]
  784. if expand and i in expand:
  785. flags[i] = self.expand(flags[i], var + "[" + i + "]")
  786. if len(flags) == 0:
  787. return None
  788. return flags
  789. def delVarFlags(self, var, **loginfo):
  790. self.expand_cache = {}
  791. if not var in self.dict:
  792. self._makeShadowCopy(var)
  793. if var in self.dict:
  794. content = None
  795. loginfo['op'] = 'delete flags'
  796. self.varhistory.record(**loginfo)
  797. # try to save the content
  798. if "_content" in self.dict[var]:
  799. content = self.dict[var]["_content"]
  800. self.dict[var] = {}
  801. self.dict[var]["_content"] = content
  802. else:
  803. del self.dict[var]
  804. def createCopy(self):
  805. """
  806. Create a copy of self by setting _data to self
  807. """
  808. # we really want this to be a DataSmart...
  809. data = DataSmart()
  810. data.dict["_data"] = self.dict
  811. data.varhistory = self.varhistory.copy()
  812. data.varhistory.dataroot = data
  813. data.inchistory = self.inchistory.copy()
  814. data._tracking = self._tracking
  815. data.overrides = None
  816. data.overridevars = copy.copy(self.overridevars)
  817. # Should really be a deepcopy but has heavy overhead.
  818. # Instead, we're careful with writes.
  819. data.overridedata = copy.copy(self.overridedata)
  820. return data
  821. def expandVarref(self, variable, parents=False):
  822. """Find all references to variable in the data and expand it
  823. in place, optionally descending to parent datastores."""
  824. if parents:
  825. keys = iter(self)
  826. else:
  827. keys = self.localkeys()
  828. ref = '${%s}' % variable
  829. value = self.getVar(variable, False)
  830. for key in keys:
  831. referrervalue = self.getVar(key, False)
  832. if referrervalue and ref in referrervalue:
  833. self.setVar(key, referrervalue.replace(ref, value))
  834. def localkeys(self):
  835. for key in self.dict:
  836. if key not in ['_data', '_remote_data']:
  837. yield key
  838. def __iter__(self):
  839. deleted = set()
  840. overrides = set()
  841. def keylist(d):
  842. klist = set()
  843. for key in d:
  844. if key in ["_data", "_remote_data"]:
  845. continue
  846. if key in deleted:
  847. continue
  848. if key in overrides:
  849. continue
  850. if not d[key]:
  851. deleted.add(key)
  852. continue
  853. klist.add(key)
  854. if "_data" in d:
  855. klist |= keylist(d["_data"])
  856. if "_remote_data" in d:
  857. connector = d["_remote_data"]["_content"]
  858. for key in connector.getKeys():
  859. if key in deleted:
  860. continue
  861. klist.add(key)
  862. return klist
  863. self.need_overrides()
  864. for var in self.overridedata:
  865. for (r, o) in self.overridedata[var]:
  866. if o in self.overridesset:
  867. overrides.add(var)
  868. elif "_" in o:
  869. if set(o.split("_")).issubset(self.overridesset):
  870. overrides.add(var)
  871. for k in keylist(self.dict):
  872. yield k
  873. for k in overrides:
  874. yield k
  875. def __len__(self):
  876. return len(frozenset(iter(self)))
  877. def __getitem__(self, item):
  878. value = self.getVar(item, False)
  879. if value is None:
  880. raise KeyError(item)
  881. else:
  882. return value
  883. def __setitem__(self, var, value):
  884. self.setVar(var, value)
  885. def __delitem__(self, var):
  886. self.delVar(var)
  887. def get_hash(self):
  888. data = {}
  889. d = self.createCopy()
  890. bb.data.expandKeys(d)
  891. config_whitelist = set((d.getVar("BB_HASHCONFIG_WHITELIST") or "").split())
  892. keys = set(key for key in iter(d) if not key.startswith("__"))
  893. for key in keys:
  894. if key in config_whitelist:
  895. continue
  896. value = d.getVar(key, False) or ""
  897. data.update({key:value})
  898. varflags = d.getVarFlags(key, internalflags = True)
  899. if not varflags:
  900. continue
  901. for f in varflags:
  902. if f == "_content":
  903. continue
  904. data.update({'%s[%s]' % (key, f):varflags[f]})
  905. for key in ["__BBTASKS", "__BBANONFUNCS", "__BBHANDLERS"]:
  906. bb_list = d.getVar(key, False) or []
  907. data.update({key:str(bb_list)})
  908. if key == "__BBANONFUNCS":
  909. for i in bb_list:
  910. value = d.getVar(i, False) or ""
  911. data.update({i:value})
  912. data_str = str([(k, data[k]) for k in sorted(data.keys())])
  913. return hashlib.sha256(data_str.encode("utf-8")).hexdigest()