2 * Copyright (c) 2007, Novell Inc.
4 * This program is licensed under the BSD license, read LICENSE.BSD
5 * for further information
13 #ifndef LIBSOLV_SOLVER_H
14 #define LIBSOLV_SOLVER_H
20 #include "pooltypes.h"
25 #include "transaction.h"
30 * Callback definitions in order to "overwrite" the policies by an external application.
33 typedef void (*BestSolvableCb) (Pool *pool, Queue *canditates);
34 typedef int (*ArchCheckCb) (Pool *pool, Solvable *solvable1, Solvable *solvable2);
35 typedef int (*VendorCheckCb) (Pool *pool, Solvable *solvable1, Solvable *solvable2);
36 typedef void (*UpdateCandidateCb) (Pool *pool, Solvable *solvable, Queue *canditates);
40 Pool *pool; /* back pointer to pool */
41 Queue job; /* copy of the job we're solving */
43 int (*solution_callback)(struct _Solver *solv, void *data);
44 void *solution_callback_data;
46 /* Callbacks for defining the bahaviour of the solver */
48 /* Finding best candidate
50 * Callback definition:
51 * void bestSolvable (Pool *pool, Queue *canditates)
52 * candidates : List of canditates which has to be sorted by the function call
53 * return candidates: Sorted list of the candidates(first is the best).
55 BestSolvableCb bestSolvableCb;
57 /* Checking if two solvables has compatible architectures
59 * Callback definition:
60 * int archCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
62 * return 0 it the two solvables has compatible architectures
64 ArchCheckCb archCheckCb;
66 /* Checking if two solvables has compatible vendors
68 * Callback definition:
69 * int vendorCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
71 * return 0 it the two solvables has compatible architectures
73 VendorCheckCb vendorCheckCb;
75 /* Evaluate update candidate
77 * Callback definition:
78 * void UpdateCandidateCb (Pool *pool, Solvable *solvable, Queue *canditates)
79 * solvable : for which updates should be search
80 * candidates : List of candidates (This list depends on other
81 * restrictions like architecture and vendor policies too)
83 UpdateCandidateCb updateCandidateCb;
85 #ifdef LIBSOLV_INTERNAL
86 Repo *installed; /* copy of pool->installed */
88 /* list of rules, ordered
89 * rpm rules first, then features, updates, jobs, learnt
90 * see start/end offsets below
92 Rule *rules; /* all rules */
93 Id nrules; /* [Offset] index of the last rule */
95 Queue ruleassertions; /* Queue of all assertion rules */
97 /* start/end offset for rule 'areas' */
99 Id rpmrules_end; /* [Offset] rpm rules end */
101 Id featurerules; /* feature rules start/end */
104 Id updaterules; /* policy rules, e.g. keep packages installed or update. All literals > 0 */
107 Id jobrules; /* user rules */
110 Id infarchrules; /* inferior arch rules */
113 Id duprules; /* dist upgrade rules */
116 Id choicerules; /* choice rules (always weak) */
120 Id learntrules; /* learnt rules, (end == nrules) */
122 Map noupdate; /* don't try to update these
123 installed solvables */
124 Map noobsoletes; /* ignore obsoletes for these (multiinstall) */
126 Map updatemap; /* bring these installed packages to the newest version */
127 int updatemap_all; /* bring all packages to the newest version */
129 Map fixmap; /* fix these packages */
130 int fixmap_all; /* fix all packages */
132 Queue weakruleq; /* index into 'rules' for weak ones */
133 Map weakrulemap; /* map rule# to '1' for weak rules, 1..learntrules */
135 Id *watches; /* Array of rule offsets
136 * watches has nsolvables*2 entries and is addressed from the middle
137 * middle-solvable : decision to conflict, offset point to linked-list of rules
138 * middle+solvable : decision to install: offset point to linked-list of rules
141 Queue ruletojob; /* index into job queue: jobs for which a rule exits */
144 Queue decisionq; /* >0:install, <0:remove/conflict */
145 Queue decisionq_why; /* index of rule, Offset into rules */
147 Id *decisionmap; /* map for all available solvables,
149 * > 0: level of decision when installed,
150 * < 0: level of decision when conflict */
152 int decisioncnt_update;
153 int decisioncnt_keep;
154 int decisioncnt_resolve;
155 int decisioncnt_weak;
156 int decisioncnt_orphan;
158 /* learnt rule history */
163 int propagate_index; /* index into decisionq for non-propagated decisions */
165 Queue problems; /* list of lists of conflicting rules, < 0 for job rules */
166 Queue solutions; /* refined problem storage space */
168 Queue orphaned; /* orphaned packages (to be removed?) */
170 int stats_learned; /* statistic */
171 int stats_unsolvable; /* statistic */
173 Map recommendsmap; /* recommended packages from decisionmap */
174 Map suggestsmap; /* suggested packages from decisionmap */
175 int recommends_index; /* recommendsmap/suggestsmap is created up to this level */
177 Id *obsoletes; /* obsoletes for each installed solvable */
178 Id *obsoletes_data; /* data area for obsoletes */
179 Id *multiversionupdaters; /* updaters for multiversion packages in updatesystem mode */
181 /*-------------------------------------------------------------------------------------------------------------
182 * Solver configuration
183 *-------------------------------------------------------------------------------------------------------------*/
185 int allowdowngrade; /* allow to downgrade installed solvable */
186 int allowarchchange; /* allow to change architecture of installed solvables */
187 int allowvendorchange; /* allow to change vendor of installed solvables */
188 int allowuninstall; /* allow removal of installed solvables */
189 int noupdateprovide; /* true: update packages needs not to provide old package */
190 int dosplitprovides; /* true: consider legacy split provides */
191 int dontinstallrecommended; /* true: do not install recommended packages */
192 int ignorealreadyrecommended; /* true: ignore recommended packages that were already recommended by the installed packages */
193 int dontshowinstalledrecommended; /* true: do not show recommended packages that are already installed */
195 int noinfarchcheck; /* true: do not forbid inferior architectures */
198 Map dupmap; /* dup these packages*/
199 int dupmap_all; /* dup all packages */
200 Map dupinvolvedmap; /* packages involved in dup process */
202 Map droporphanedmap; /* packages to drop in dup mode */
203 int droporphanedmap_all;
205 Map cleandepsmap; /* try to drop these packages as of cleandeps erases */
207 Queue *ruleinfoq; /* tmp space for solver_ruleinfo() */
208 #endif /* LIBSOLV_INTERNAL */
211 typedef struct _Solver Solver;
217 #define SOLVER_SOLVABLE 0x01
218 #define SOLVER_SOLVABLE_NAME 0x02
219 #define SOLVER_SOLVABLE_PROVIDES 0x03
220 #define SOLVER_SOLVABLE_ONE_OF 0x04
221 #define SOLVER_SOLVABLE_REPO 0x05
222 #define SOLVER_SOLVABLE_ALL 0x06
224 #define SOLVER_SELECTMASK 0xff
226 #define SOLVER_NOOP 0x0000
227 #define SOLVER_INSTALL 0x0100
228 #define SOLVER_ERASE 0x0200
229 #define SOLVER_UPDATE 0x0300
230 #define SOLVER_WEAKENDEPS 0x0400
231 #define SOLVER_NOOBSOLETES 0x0500
232 #define SOLVER_LOCK 0x0600
233 #define SOLVER_DISTUPGRADE 0x0700
234 #define SOLVER_VERIFY 0x0800
235 #define SOLVER_DROP_ORPHANED 0x0900
236 #define SOLVER_USERINSTALLED 0x0a00
238 #define SOLVER_JOBMASK 0xff00
240 #define SOLVER_WEAK 0x010000
241 #define SOLVER_ESSENTIAL 0x020000
242 #define SOLVER_CLEANDEPS 0x040000
244 #define SOLVER_SETEV 0x01000000
245 #define SOLVER_SETEVR 0x02000000
246 #define SOLVER_SETARCH 0x04000000
247 #define SOLVER_SETVENDOR 0x08000000
248 #define SOLVER_SETREPO 0x10000000
249 #define SOLVER_NOAUTOSET 0x20000000
251 #define SOLVER_SETMASK 0x2f000000
253 #define SOLVER_REASON_UNRELATED 0
254 #define SOLVER_REASON_UNIT_RULE 1
255 #define SOLVER_REASON_KEEP_INSTALLED 2
256 #define SOLVER_REASON_RESOLVE_JOB 3
257 #define SOLVER_REASON_UPDATE_INSTALLED 4
258 #define SOLVER_REASON_CLEANDEPS_ERASE 5
259 #define SOLVER_REASON_RESOLVE 6
260 #define SOLVER_REASON_WEAKDEP 7
261 #define SOLVER_REASON_RESOLVE_ORPHAN 8
263 #define SOLVER_REASON_RECOMMENDED 16
264 #define SOLVER_REASON_SUPPLEMENTED 17
267 #define SOLVER_FLAG_ALLOW_DOWNGRADE 1
268 #define SOLVER_FLAG_ALLOW_ARCHCHANGE 2
269 #define SOLVER_FLAG_ALLOW_VENDORCHANGE 3
270 #define SOLVER_FLAG_ALLOW_UNINSTALL 4
271 #define SOLVER_FLAG_NO_UPDATEPROVIDE 5
272 #define SOLVER_FLAG_SPLITPROVIDES 6
273 #define SOLVER_FLAG_IGNORE_RECOMMENDED 7
274 #define SOLVER_FLAG_IGNORE_ALREADY_RECOMMENDED 8
275 #define SOLVER_FLAG_NO_INFARCHCHECK 9
277 extern Solver *solver_create(Pool *pool);
278 extern void solver_free(Solver *solv);
279 extern int solver_solve(Solver *solv, Queue *job);
280 extern Transaction *solver_create_transaction(Solver *solv);
281 extern int solver_set_flag(Solver *solv, int flag, int value);
282 extern int solver_get_flag(Solver *solv, int flag);
284 extern int solver_get_decisionlevel(Solver *solv, Id p);
285 extern void solver_get_decisionqueue(Solver *solv, Queue *decisionq);
286 extern int solver_get_lastdecisionblocklevel(Solver *solv);
287 extern void solver_get_decisionblock(Solver *solv, int level, Queue *decisionq);
289 extern void solver_get_orphaned(Solver *solv, Queue *orphanedq);
290 extern void solver_get_recommendations(Solver *solv, Queue *recommendationsq, Queue *suggestionsq, int noselected);
292 extern int solver_describe_decision(Solver *solv, Id p, Id *infop);
293 extern void solver_describe_weakdep_decision(Solver *solv, Id p, Queue *whyq);
296 extern void solver_calculate_noobsmap(Pool *pool, Queue *job, Map *noobsmap);
297 extern void solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap);
299 /* XXX: why is this not static? */
300 Id *solver_create_decisions_obsoletesmap(Solver *solv);
302 void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
303 int solver_calc_installsizechange(Solver *solv);
304 void solver_trivial_installable(Solver *solv, Queue *pkgs, Queue *res);
306 void solver_find_involved(Solver *solv, Queue *installedq, Solvable *s, Queue *q);
308 /* iterate over all literals of a rule */
309 /* WARNING: loop body must not relocate whatprovidesdata, e.g. by
310 * looking up the providers of a dependency */
311 #define FOR_RULELITERALS(l, dp, r) \
312 for (l = r->d < 0 ? -r->d - 1 : r->d, \
313 dp = !l ? &r->w2 : pool->whatprovidesdata + l, \
314 l = r->p; l; l = (dp != &r->w2 + 1 ? *dp++ : 0))
316 /* iterate over all packages selected by a job */
317 #define FOR_JOB_SELECT(p, pp, select, what) \
318 if (select == SOLVER_SOLVABLE_REPO || select == SOLVER_SOLVABLE_ALL) \
320 else for (pp = (select == SOLVER_SOLVABLE ? 0 : \
321 select == SOLVER_SOLVABLE_ONE_OF ? what : \
322 pool_whatprovides(pool, what)), \
323 p = (select == SOLVER_SOLVABLE ? what : pool->whatprovidesdata[pp++]) ; p ; p = pool->whatprovidesdata[pp++]) \
324 if (select != SOLVER_SOLVABLE_NAME || pool_match_nevr(pool, pool->solvables + p, what))
330 #endif /* LIBSOLV_SOLVER_H */