providers.py: Remove now unused parameter from filterProviders
[bitbake.git] / lib / bb / providers.py
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 # This program is free software; you can redistribute it and/or modify
12 # it under the terms of the GNU General Public License version 2 as
13 # published by the Free Software Foundation.
14 #
15 # This program is distributed in the hope that it will be useful,
16 # but WITHOUT ANY WARRANTY; without even the implied warranty of
17 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 # GNU General Public License for more details.
19 #
20 # You should have received a copy of the GNU General Public License along
21 # with this program; if not, write to the Free Software Foundation, Inc.,
22 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23
24 import os, re
25 from bb import data, utils
26 import bb
27
28 class NoProvider(Exception):
29     """Exception raised when no provider of a build dependency can be found"""
30
31 class NoRProvider(Exception):
32     """Exception raised when no provider of a runtime dependency can be found"""
33
34 def findBestProvider(pn, cfgData, dataCache, pkg_pn = None, item = None):
35     """
36     If there is a PREFERRED_VERSION, find the highest-priority bbfile
37     providing that version.  If not, find the latest version provided by
38     an bbfile in the highest-priority set.
39     """
40     if not pkg_pn:
41         pkg_pn = dataCache.pkg_pn
42
43     files = pkg_pn[pn]
44     priorities = {}
45     for f in files:
46         priority = dataCache.bbfile_priority[f]
47         if priority not in priorities:
48             priorities[priority] = []
49         priorities[priority].append(f)
50     p_list = priorities.keys()
51     p_list.sort(lambda a, b: a - b)
52     tmp_pn = []
53     for p in p_list:
54         tmp_pn = [priorities[p]] + tmp_pn
55
56     preferred_file = None
57
58     localdata = data.createCopy(cfgData)
59     bb.data.setVar('OVERRIDES', "%s:%s" % (pn, data.getVar('OVERRIDES', localdata)), localdata)
60     bb.data.update_data(localdata)
61
62     preferred_v = bb.data.getVar('PREFERRED_VERSION_%s' % pn, localdata, True)
63     if preferred_v:
64         m = re.match('(.*)_(.*)', preferred_v)
65         if m:
66             preferred_v = m.group(1)
67             preferred_r = m.group(2)
68         else:
69             preferred_r = None
70
71         for file_set in tmp_pn:
72             for f in file_set:
73                 pv,pr = dataCache.pkg_pvpr[f]
74                 if preferred_v == pv and (preferred_r == pr or preferred_r == None):
75                     preferred_file = f
76                     preferred_ver = (pv, pr)
77                     break
78             if preferred_file:
79                 break;
80         if preferred_r:
81             pv_str = '%s-%s' % (preferred_v, preferred_r)
82         else:
83             pv_str = preferred_v
84         itemstr = ""
85         if item:
86             itemstr = " (for item %s)" % item
87         if preferred_file is None:
88             bb.msg.note(1, bb.msg.domain.Provider, "preferred version %s of %s not available%s" % (pv_str, pn, itemstr))
89         else:
90             bb.msg.debug(1, bb.msg.domain.Provider, "selecting %s as PREFERRED_VERSION %s of package %s%s" % (preferred_file, pv_str, pn, itemstr))
91
92     del localdata
93
94     # get highest priority file set
95     files = tmp_pn[0]
96     latest = None
97     latest_p = 0
98     latest_f = None
99     for file_name in files:
100         pv,pr = dataCache.pkg_pvpr[file_name]
101         dp = dataCache.pkg_dp[file_name]
102
103         if (latest is None) or ((latest_p == dp) and (utils.vercmp(latest, (pv, pr)) < 0)) or (dp > latest_p):
104             latest = (pv, pr)
105             latest_f = file_name
106             latest_p = dp
107     if preferred_file is None:
108         preferred_file = latest_f
109         preferred_ver = latest
110
111     return (latest,latest_f,preferred_ver, preferred_file)
112
113 def filterProviders(providers, item, cfgData, dataCache):
114     """
115     Take a list of providers and filter/reorder according to the 
116     environment variables and previous build results
117     """
118     eligible = []
119     preferred_versions = {}
120
121     # Collate providers by PN
122     pkg_pn = {}
123     for p in providers:
124         pn = dataCache.pkg_fn[p]
125         if pn not in pkg_pn:
126             pkg_pn[pn] = []
127         pkg_pn[pn].append(p)
128
129     bb.msg.debug(1, bb.msg.domain.Provider, "providers for %s are: %s" % (item, pkg_pn.keys()))
130
131     for pn in pkg_pn.keys():
132         preferred_versions[pn] = bb.providers.findBestProvider(pn, cfgData, dataCache, pkg_pn, item)[2:4]
133         eligible.append(preferred_versions[pn][1])
134
135     if len(eligible) == 0:
136         bb.msg.error(bb.msg.domain.Provider, "no eligible providers for %s" % item)
137         return 0
138
139
140     # If pn == item, give it a slight default preference
141     # This means PREFERRED_PROVIDER_foobar defaults to foobar if available
142     for p in providers:
143         pn = dataCache.pkg_fn[p]
144         if pn != item:
145             continue
146         (newvers, fn) = preferred_versions[pn]
147         if not fn in eligible:
148             continue
149         eligible.remove(fn)
150         eligible = [fn] + eligible
151
152     # look to see if one of them is already staged, or marked as preferred.
153     # if so, bump it to the head of the queue
154     for p in providers:
155         pn = dataCache.pkg_fn[p]
156         pv, pr = dataCache.pkg_pvpr[p]
157
158         stamp = '%s.do_populate_staging' % dataCache.stamp[p]
159         if os.path.exists(stamp):
160             (newvers, fn) = preferred_versions[pn]
161             if not fn in eligible:
162                 # package was made ineligible by already-failed check
163                 continue
164             oldver = "%s-%s" % (pv, pr)
165             newver = '-'.join(newvers)
166             if (newver != oldver):
167                 extra_chat = "%s (%s) already staged but upgrading to %s to satisfy %s" % (pn, oldver, newver, item)
168             else:
169                 extra_chat = "Selecting already-staged %s (%s) to satisfy %s" % (pn, oldver, item)
170
171             bb.msg.note(2, bb.msg.domain.Provider, "%s" % extra_chat)
172             eligible.remove(fn)
173             eligible = [fn] + eligible
174             break
175
176     return eligible
177
178 def getRuntimeProviders(dataCache, rdepend):
179     """
180     Return any providers of runtime dependency
181     """
182     rproviders = []
183
184     if rdepend in dataCache.rproviders:
185        rproviders += dataCache.rproviders[rdepend]
186
187     if rdepend in dataCache.packages:
188         rproviders += dataCache.packages[rdepend]
189
190     if rproviders:
191         return rproviders
192
193     # Only search dynamic packages if we can't find anything in other variables
194     for pattern in dataCache.packages_dynamic:
195         regexp = re.compile(pattern)
196         if regexp.match(rdepend):
197             rproviders += dataCache.packages_dynamic[pattern]
198
199     return rproviders