providers.py 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420
  1. # ex:ts=4:sw=4:sts=4:et
  2. # -*- tab-width: 4; c-basic-offset: 4; indent-tabs-mode: nil -*-
  3. #
  4. # Copyright (C) 2003, 2004 Chris Larson
  5. # Copyright (C) 2003, 2004 Phil Blundell
  6. # Copyright (C) 2003 - 2005 Michael 'Mickey' Lauer
  7. # Copyright (C) 2005 Holger Hans Peter Freyther
  8. # Copyright (C) 2005 ROAD GmbH
  9. # Copyright (C) 2006 Richard Purdie
  10. #
  11. # SPDX-License-Identifier: GPL-2.0-only
  12. #
  13. import re
  14. import logging
  15. from bb import data, utils
  16. from collections import defaultdict
  17. import bb
  18. logger = logging.getLogger("BitBake.Provider")
  19. class NoProvider(bb.BBHandledException):
  20. """Exception raised when no provider of a build dependency can be found"""
  21. class NoRProvider(bb.BBHandledException):
  22. """Exception raised when no provider of a runtime dependency can be found"""
  23. class MultipleRProvider(bb.BBHandledException):
  24. """Exception raised when multiple providers of a runtime dependency can be found"""
  25. def findProviders(cfgData, dataCache, pkg_pn = None):
  26. """
  27. Convenience function to get latest and preferred providers in pkg_pn
  28. """
  29. if not pkg_pn:
  30. pkg_pn = dataCache.pkg_pn
  31. # Need to ensure data store is expanded
  32. localdata = data.createCopy(cfgData)
  33. bb.data.expandKeys(localdata)
  34. preferred_versions = {}
  35. latest_versions = {}
  36. for pn in pkg_pn:
  37. (last_ver, last_file, pref_ver, pref_file) = findBestProvider(pn, localdata, dataCache, pkg_pn)
  38. preferred_versions[pn] = (pref_ver, pref_file)
  39. latest_versions[pn] = (last_ver, last_file)
  40. return (latest_versions, preferred_versions)
  41. def allProviders(dataCache):
  42. """
  43. Find all providers for each pn
  44. """
  45. all_providers = defaultdict(list)
  46. for (fn, pn) in dataCache.pkg_fn.items():
  47. ver = dataCache.pkg_pepvpr[fn]
  48. all_providers[pn].append((ver, fn))
  49. return all_providers
  50. def sortPriorities(pn, dataCache, pkg_pn = None):
  51. """
  52. Reorder pkg_pn by file priority and default preference
  53. """
  54. if not pkg_pn:
  55. pkg_pn = dataCache.pkg_pn
  56. files = pkg_pn[pn]
  57. priorities = {}
  58. for f in files:
  59. priority = dataCache.bbfile_priority[f]
  60. preference = dataCache.pkg_dp[f]
  61. if priority not in priorities:
  62. priorities[priority] = {}
  63. if preference not in priorities[priority]:
  64. priorities[priority][preference] = []
  65. priorities[priority][preference].append(f)
  66. tmp_pn = []
  67. for pri in sorted(priorities):
  68. tmp_pref = []
  69. for pref in sorted(priorities[pri]):
  70. tmp_pref.extend(priorities[pri][pref])
  71. tmp_pn = [tmp_pref] + tmp_pn
  72. return tmp_pn
  73. def preferredVersionMatch(pe, pv, pr, preferred_e, preferred_v, preferred_r):
  74. """
  75. Check if the version pe,pv,pr is the preferred one.
  76. If there is preferred version defined and ends with '%', then pv has to start with that version after removing the '%'
  77. """
  78. if (pr == preferred_r or preferred_r == None):
  79. if (pe == preferred_e or preferred_e == None):
  80. if preferred_v == pv:
  81. return True
  82. if preferred_v != None and preferred_v.endswith('%') and pv.startswith(preferred_v[:len(preferred_v)-1]):
  83. return True
  84. return False
  85. def findPreferredProvider(pn, cfgData, dataCache, pkg_pn = None, item = None):
  86. """
  87. Find the first provider in pkg_pn with a PREFERRED_VERSION set.
  88. """
  89. preferred_file = None
  90. preferred_ver = None
  91. # pn can contain '_', e.g. gcc-cross-x86_64 and an override cannot
  92. # hence we do this manually rather than use OVERRIDES
  93. preferred_v = cfgData.getVar("PREFERRED_VERSION_pn-%s" % pn)
  94. if not preferred_v:
  95. preferred_v = cfgData.getVar("PREFERRED_VERSION_%s" % pn)
  96. if not preferred_v:
  97. preferred_v = cfgData.getVar("PREFERRED_VERSION")
  98. if preferred_v:
  99. m = re.match(r'(\d+:)*(.*)(_.*)*', preferred_v)
  100. if m:
  101. if m.group(1):
  102. preferred_e = m.group(1)[:-1]
  103. else:
  104. preferred_e = None
  105. preferred_v = m.group(2)
  106. if m.group(3):
  107. preferred_r = m.group(3)[1:]
  108. else:
  109. preferred_r = None
  110. else:
  111. preferred_e = None
  112. preferred_r = None
  113. for file_set in pkg_pn:
  114. for f in file_set:
  115. pe, pv, pr = dataCache.pkg_pepvpr[f]
  116. if preferredVersionMatch(pe, pv, pr, preferred_e, preferred_v, preferred_r):
  117. preferred_file = f
  118. preferred_ver = (pe, pv, pr)
  119. break
  120. if preferred_file:
  121. break;
  122. if preferred_r:
  123. pv_str = '%s-%s' % (preferred_v, preferred_r)
  124. else:
  125. pv_str = preferred_v
  126. if not (preferred_e is None):
  127. pv_str = '%s:%s' % (preferred_e, pv_str)
  128. itemstr = ""
  129. if item:
  130. itemstr = " (for item %s)" % item
  131. if preferred_file is None:
  132. logger.info("preferred version %s of %s not available%s", pv_str, pn, itemstr)
  133. available_vers = []
  134. for file_set in pkg_pn:
  135. for f in file_set:
  136. pe, pv, pr = dataCache.pkg_pepvpr[f]
  137. ver_str = pv
  138. if pe:
  139. ver_str = "%s:%s" % (pe, ver_str)
  140. if not ver_str in available_vers:
  141. available_vers.append(ver_str)
  142. if available_vers:
  143. available_vers.sort()
  144. logger.info("versions of %s available: %s", pn, ' '.join(available_vers))
  145. else:
  146. logger.debug(1, "selecting %s as PREFERRED_VERSION %s of package %s%s", preferred_file, pv_str, pn, itemstr)
  147. return (preferred_ver, preferred_file)
  148. def findLatestProvider(pn, cfgData, dataCache, file_set):
  149. """
  150. Return the highest version of the providers in file_set.
  151. Take default preferences into account.
  152. """
  153. latest = None
  154. latest_p = 0
  155. latest_f = None
  156. for file_name in file_set:
  157. pe, pv, pr = dataCache.pkg_pepvpr[file_name]
  158. dp = dataCache.pkg_dp[file_name]
  159. if (latest is None) or ((latest_p == dp) and (utils.vercmp(latest, (pe, pv, pr)) < 0)) or (dp > latest_p):
  160. latest = (pe, pv, pr)
  161. latest_f = file_name
  162. latest_p = dp
  163. return (latest, latest_f)
  164. def findBestProvider(pn, cfgData, dataCache, pkg_pn = None, item = None):
  165. """
  166. If there is a PREFERRED_VERSION, find the highest-priority bbfile
  167. providing that version. If not, find the latest version provided by
  168. an bbfile in the highest-priority set.
  169. """
  170. sortpkg_pn = sortPriorities(pn, dataCache, pkg_pn)
  171. # Find the highest priority provider with a PREFERRED_VERSION set
  172. (preferred_ver, preferred_file) = findPreferredProvider(pn, cfgData, dataCache, sortpkg_pn, item)
  173. # Find the latest version of the highest priority provider
  174. (latest, latest_f) = findLatestProvider(pn, cfgData, dataCache, sortpkg_pn[0])
  175. if preferred_file is None:
  176. preferred_file = latest_f
  177. preferred_ver = latest
  178. return (latest, latest_f, preferred_ver, preferred_file)
  179. def _filterProviders(providers, item, cfgData, dataCache):
  180. """
  181. Take a list of providers and filter/reorder according to the
  182. environment variables
  183. """
  184. eligible = []
  185. preferred_versions = {}
  186. sortpkg_pn = {}
  187. # The order of providers depends on the order of the files on the disk
  188. # up to here. Sort pkg_pn to make dependency issues reproducible rather
  189. # than effectively random.
  190. providers.sort()
  191. # Collate providers by PN
  192. pkg_pn = {}
  193. for p in providers:
  194. pn = dataCache.pkg_fn[p]
  195. if pn not in pkg_pn:
  196. pkg_pn[pn] = []
  197. pkg_pn[pn].append(p)
  198. logger.debug(1, "providers for %s are: %s", item, list(sorted(pkg_pn.keys())))
  199. # First add PREFERRED_VERSIONS
  200. for pn in sorted(pkg_pn):
  201. sortpkg_pn[pn] = sortPriorities(pn, dataCache, pkg_pn)
  202. preferred_versions[pn] = findPreferredProvider(pn, cfgData, dataCache, sortpkg_pn[pn], item)
  203. if preferred_versions[pn][1]:
  204. eligible.append(preferred_versions[pn][1])
  205. # Now add latest versions
  206. for pn in sorted(sortpkg_pn):
  207. if pn in preferred_versions and preferred_versions[pn][1]:
  208. continue
  209. preferred_versions[pn] = findLatestProvider(pn, cfgData, dataCache, sortpkg_pn[pn][0])
  210. eligible.append(preferred_versions[pn][1])
  211. if len(eligible) == 0:
  212. logger.error("no eligible providers for %s", item)
  213. return 0
  214. # If pn == item, give it a slight default preference
  215. # This means PREFERRED_PROVIDER_foobar defaults to foobar if available
  216. for p in providers:
  217. pn = dataCache.pkg_fn[p]
  218. if pn != item:
  219. continue
  220. (newvers, fn) = preferred_versions[pn]
  221. if not fn in eligible:
  222. continue
  223. eligible.remove(fn)
  224. eligible = [fn] + eligible
  225. return eligible
  226. def filterProviders(providers, item, cfgData, dataCache):
  227. """
  228. Take a list of providers and filter/reorder according to the
  229. environment variables
  230. Takes a "normal" target item
  231. """
  232. eligible = _filterProviders(providers, item, cfgData, dataCache)
  233. prefervar = cfgData.getVar('PREFERRED_PROVIDER_%s' % item)
  234. if prefervar:
  235. dataCache.preferred[item] = prefervar
  236. foundUnique = False
  237. if item in dataCache.preferred:
  238. for p in eligible:
  239. pn = dataCache.pkg_fn[p]
  240. if dataCache.preferred[item] == pn:
  241. logger.verbose("selecting %s to satisfy %s due to PREFERRED_PROVIDERS", pn, item)
  242. eligible.remove(p)
  243. eligible = [p] + eligible
  244. foundUnique = True
  245. break
  246. logger.debug(1, "sorted providers for %s are: %s", item, eligible)
  247. return eligible, foundUnique
  248. def filterProvidersRunTime(providers, item, cfgData, dataCache):
  249. """
  250. Take a list of providers and filter/reorder according to the
  251. environment variables
  252. Takes a "runtime" target item
  253. """
  254. eligible = _filterProviders(providers, item, cfgData, dataCache)
  255. # First try and match any PREFERRED_RPROVIDER entry
  256. prefervar = cfgData.getVar('PREFERRED_RPROVIDER_%s' % item)
  257. foundUnique = False
  258. if prefervar:
  259. for p in eligible:
  260. pn = dataCache.pkg_fn[p]
  261. if prefervar == pn:
  262. logger.verbose("selecting %s to satisfy %s due to PREFERRED_RPROVIDER", pn, item)
  263. eligible.remove(p)
  264. eligible = [p] + eligible
  265. foundUnique = True
  266. numberPreferred = 1
  267. break
  268. # If we didn't find an RPROVIDER entry, try and infer the provider from PREFERRED_PROVIDER entries
  269. # by looking through the provides of each eligible recipe and seeing if a PREFERRED_PROVIDER was set.
  270. # This is most useful for virtual/ entries rather than having a RPROVIDER per entry.
  271. if not foundUnique:
  272. # Should use dataCache.preferred here?
  273. preferred = []
  274. preferred_vars = []
  275. pns = {}
  276. for p in eligible:
  277. pns[dataCache.pkg_fn[p]] = p
  278. for p in eligible:
  279. pn = dataCache.pkg_fn[p]
  280. provides = dataCache.pn_provides[pn]
  281. for provide in provides:
  282. prefervar = cfgData.getVar('PREFERRED_PROVIDER_%s' % provide)
  283. #logger.debug(1, "checking PREFERRED_PROVIDER_%s (value %s) against %s", provide, prefervar, pns.keys())
  284. if prefervar in pns and pns[prefervar] not in preferred:
  285. var = "PREFERRED_PROVIDER_%s = %s" % (provide, prefervar)
  286. logger.verbose("selecting %s to satisfy runtime %s due to %s", prefervar, item, var)
  287. preferred_vars.append(var)
  288. pref = pns[prefervar]
  289. eligible.remove(pref)
  290. eligible = [pref] + eligible
  291. preferred.append(pref)
  292. break
  293. numberPreferred = len(preferred)
  294. if numberPreferred > 1:
  295. logger.error("Trying to resolve runtime dependency %s resulted in conflicting PREFERRED_PROVIDER entries being found.\nThe providers found were: %s\nThe PREFERRED_PROVIDER entries resulting in this conflict were: %s. You could set PREFERRED_RPROVIDER_%s" % (item, preferred, preferred_vars, item))
  296. logger.debug(1, "sorted runtime providers for %s are: %s", item, eligible)
  297. return eligible, numberPreferred
  298. regexp_cache = {}
  299. def getRuntimeProviders(dataCache, rdepend):
  300. """
  301. Return any providers of runtime dependency
  302. """
  303. rproviders = []
  304. if rdepend in dataCache.rproviders:
  305. rproviders += dataCache.rproviders[rdepend]
  306. if rdepend in dataCache.packages:
  307. rproviders += dataCache.packages[rdepend]
  308. if rproviders:
  309. return rproviders
  310. # Only search dynamic packages if we can't find anything in other variables
  311. for pattern in dataCache.packages_dynamic:
  312. pattern = pattern.replace(r'+', r"\+")
  313. if pattern in regexp_cache:
  314. regexp = regexp_cache[pattern]
  315. else:
  316. try:
  317. regexp = re.compile(pattern)
  318. except:
  319. logger.error("Error parsing regular expression '%s'", pattern)
  320. raise
  321. regexp_cache[pattern] = regexp
  322. if regexp.match(rdepend):
  323. rproviders += dataCache.packages_dynamic[pattern]
  324. logger.debug(1, "Assuming %s is a dynamic package, but it may not exist" % rdepend)
  325. return rproviders
  326. def buildWorldTargetList(dataCache, task=None):
  327. """
  328. Build package list for "bitbake world"
  329. """
  330. if dataCache.world_target:
  331. return
  332. logger.debug(1, "collating packages for \"world\"")
  333. for f in dataCache.possible_world:
  334. terminal = True
  335. pn = dataCache.pkg_fn[f]
  336. if task and task not in dataCache.task_deps[f]['tasks']:
  337. logger.debug(2, "World build skipping %s as task %s doesn't exist", f, task)
  338. terminal = False
  339. for p in dataCache.pn_provides[pn]:
  340. if p.startswith('virtual/'):
  341. logger.debug(2, "World build skipping %s due to %s provider starting with virtual/", f, p)
  342. terminal = False
  343. break
  344. for pf in dataCache.providers[p]:
  345. if dataCache.pkg_fn[pf] != pn:
  346. logger.debug(2, "World build skipping %s due to both us and %s providing %s", f, pf, p)
  347. terminal = False
  348. break
  349. if terminal:
  350. dataCache.world_target.add(pn)