providers.py 15 KB

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