2 * Copyright (c) 2007, Novell Inc.
4 * This program is licensed under the BSD license, read LICENSE.BSD
5 * for further information
13 #ifndef SATSOLVER_SOLVER_H
14 #define SATSOLVER_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);
41 typedef struct _Solver {
42 Pool *pool; /* back pointer to pool */
43 Queue job; /* copy of the job we're solving */
45 Transaction trans; /* calculated transaction */
47 Repo *installed; /* copy of pool->installed */
49 /* list of rules, ordered
50 * rpm rules first, then features, updates, jobs, learnt
51 * see start/end offsets below
53 Rule *rules; /* all rules */
54 Id nrules; /* [Offset] index of the last rule */
56 Queue ruleassertions; /* Queue of all assertion rules */
58 /* start/end offset for rule 'areas' */
60 Id rpmrules_end; /* [Offset] rpm rules end */
62 Id featurerules; /* feature rules start/end */
65 Id updaterules; /* policy rules, e.g. keep packages installed or update. All literals > 0 */
68 Id jobrules; /* user rules */
71 Id infarchrules; /* inferior arch rules */
74 Id duprules; /* dist upgrade rules */
77 Id choicerules; /* choice rules (always weak) */
80 Id learntrules; /* learnt rules, (end == nrules) */
82 Map noupdate; /* don't try to update these
83 installed solvables */
84 Map noobsoletes; /* ignore obsoletes for these
87 Map updatemap; /* bring those installed packages to the newest version */
88 Map fixmap; /* fix those packages */
90 Queue weakruleq; /* index into 'rules' for weak ones */
91 Map weakrulemap; /* map rule# to '1' for weak rules, 1..learntrules */
93 Id *watches; /* Array of rule offsets
94 * watches has nsolvables*2 entries and is addressed from the middle
95 * middle-solvable : decision to conflict, offset point to linked-list of rules
96 * middle+solvable : decision to install: offset point to linked-list of rules
99 Queue ruletojob; /* index into job queue: jobs for which a rule exits */
102 Queue decisionq; /* >0:install, <0:remove/conflict */
103 Queue decisionq_why; /* index of rule, Offset into rules */
105 Id *decisionmap; /* map for all available solvables,
107 * > 0: level of decision when installed,
108 * < 0: level of decision when conflict */
110 /* learnt rule history */
115 int (*solution_callback)(struct _Solver *solv, void *data);
116 void *solution_callback_data;
118 int propagate_index; /* index into decisionq for non-propagated decisions */
120 Queue problems; /* list of lists of conflicting rules, < 0 for job rules */
121 Queue solutions; /* refined problem storage space */
123 Queue recommendations; /* recommended packages */
124 Queue suggestions; /* suggested packages */
125 Queue orphaned; /* orphaned packages */
127 int stats_learned; /* statistic */
128 int stats_unsolvable; /* statistic */
130 Map recommendsmap; /* recommended packages from decisionmap */
131 Map suggestsmap; /* suggested packages from decisionmap */
132 int recommends_index; /* recommendsmap/suggestsmap is created up to this level */
134 Id *obsoletes; /* obsoletes for each installed solvable */
135 Id *obsoletes_data; /* data area for obsoletes */
136 Id *multiversionupdaters; /* updaters for multiversion packages in updatesystem mode */
138 /*-------------------------------------------------------------------------------------------------------------
139 * Solver configuration
140 *-------------------------------------------------------------------------------------------------------------*/
142 int fixsystem; /* repair errors in rpm dependency graph */
143 int allowdowngrade; /* allow to downgrade installed solvable */
144 int allowarchchange; /* allow to change architecture of installed solvables */
145 int allowvendorchange; /* allow to change vendor of installed solvables */
146 int allowuninstall; /* allow removal of installed solvables */
147 int updatesystem; /* update all packages to the newest version */
148 int noupdateprovide; /* true: update packages needs not to provide old package */
149 int dosplitprovides; /* true: consider legacy split provides */
150 int dontinstallrecommended; /* true: do not install recommended packages */
151 int ignorealreadyrecommended; /* true: ignore recommended packages that were already recommended by the installed packages */
152 int dontshowinstalledrecommended; /* true: do not show recommended packages that are already installed */
154 /* distupgrade also needs updatesystem and dosplitprovides */
156 int distupgrade_removeunsupported;
158 int noinfarchcheck; /* true: do not forbid inferior architectures */
160 /* Callbacks for defining the bahaviour of the SAT solver */
162 /* Finding best candidate
164 * Callback definition:
165 * void bestSolvable (Pool *pool, Queue *canditates)
166 * candidates : List of canditates which has to be sorted by the function call
167 * return candidates: Sorted list of the candidates(first is the best).
169 BestSolvableCb bestSolvableCb;
171 /* Checking if two solvables has compatible architectures
173 * Callback definition:
174 * int archCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
176 * return 0 it the two solvables has compatible architectures
178 ArchCheckCb archCheckCb;
180 /* Checking if two solvables has compatible vendors
182 * Callback definition:
183 * int vendorCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
185 * return 0 it the two solvables has compatible architectures
187 VendorCheckCb vendorCheckCb;
189 /* Evaluate update candidate
191 * Callback definition:
192 * void pdateCandidateCb (Pool *pool, Solvable *solvable, Queue *canditates)
193 * solvable : for which updates should be search
194 * candidates : List of candidates (This list depends on other
195 * restrictions like architecture and vendor policies too)
197 UpdateCandidateCb updateCandidateCb;
200 /* some strange queue that doesn't belong here */
201 Queue covenantq; /* Covenants honored by this solver (generic locks) */
204 Map dupmap; /* packages from dup repos */
205 Map dupinvolvedmap; /* packages involved in dup process */
207 Queue *ruleinfoq; /* tmp space for solver_ruleinfo() */
214 #define SOLVER_SOLVABLE 0x01
215 #define SOLVER_SOLVABLE_NAME 0x02
216 #define SOLVER_SOLVABLE_PROVIDES 0x03
217 #define SOLVER_SOLVABLE_ONE_OF 0x04
219 #define SOLVER_SELECTMASK 0xff
221 #define SOLVER_NOOP 0x0000
222 #define SOLVER_INSTALL 0x0100
223 #define SOLVER_ERASE 0x0200
224 #define SOLVER_UPDATE 0x0300
225 #define SOLVER_WEAKENDEPS 0x0400
226 #define SOLVER_NOOBSOLETES 0x0500
227 #define SOLVER_LOCK 0x0600
228 #define SOLVER_DISTUPGRADE 0x0700
229 #define SOLVER_VERIFY 0x0800
231 #define SOLVER_JOBMASK 0xff00
233 #define SOLVER_WEAK 0x010000
234 #define SOLVER_ESSENTIAL 0x020000
236 /* old API compatibility, do not use in new code */
238 #define SOLVER_INSTALL_SOLVABLE (SOLVER_INSTALL|SOLVER_SOLVABLE)
239 #define SOLVER_ERASE_SOLVABLE (SOLVER_ERASE|SOLVER_SOLVABLE)
240 #define SOLVER_INSTALL_SOLVABLE_NAME (SOLVER_INSTALL|SOLVER_SOLVABLE_NAME)
241 #define SOLVER_ERASE_SOLVABLE_NAME (SOLVER_ERASE|SOLVER_SOLVABLE_NAME)
242 #define SOLVER_INSTALL_SOLVABLE_PROVIDES (SOLVER_INSTALL|SOLVER_SOLVABLE_PROVIDES)
243 #define SOLVER_ERASE_SOLVABLE_PROVIDES (SOLVER_ERASE|SOLVER_SOLVABLE_PROVIDES)
244 #define SOLVER_INSTALL_SOLVABLE_UPDATE (SOLVER_UPDATE|SOLVER_SOLVABLE)
245 #define SOLVER_INSTALL_SOLVABLE_ONE_OF (SOLVER_INSTALL|SOLVER_SOLVABLE_ONE_OF)
246 #define SOLVER_WEAKEN_SOLVABLE_DEPS (SOLVER_WEAKENDEPS|SOLVER_SOLVABLE)
247 #define SOLVER_NOOBSOLETES_SOLVABLE (SOLVER_NOOBSOLETES|SOLVER_SOLVABLE)
248 #define SOLVER_NOOBSOLETES_SOLVABLE_NAME (SOLVER_NOOBSOLETES|SOLVER_SOLVABLE_NAME)
249 #define SOLVER_NOOBSOLETES_SOLVABLE_PROVIDES (SOLVER_NOOBSOLETES|SOLVER_SOLVABLE_PROVIDES)
252 /* backward compatibility */
253 #define SOLVER_PROBLEM_UPDATE_RULE SOLVER_RULE_UPDATE
254 #define SOLVER_PROBLEM_JOB_RULE SOLVER_RULE_JOB
255 #define SOLVER_PROBLEM_JOB_NOTHING_PROVIDES_DEP SOLVER_RULE_JOB_NOTHING_PROVIDES_DEP
256 #define SOLVER_PROBLEM_NOT_INSTALLABLE SOLVER_RULE_RPM_NOT_INSTALLABLE
257 #define SOLVER_PROBLEM_NOTHING_PROVIDES_DEP SOLVER_RULE_RPM_NOTHING_PROVIDES_DEP
258 #define SOLVER_PROBLEM_SAME_NAME SOLVER_RULE_RPM_SAME_NAME
259 #define SOLVER_PROBLEM_PACKAGE_CONFLICT SOLVER_RULE_RPM_PACKAGE_CONFLICT
260 #define SOLVER_PROBLEM_PACKAGE_OBSOLETES SOLVER_RULE_RPM_PACKAGE_OBSOLETES
261 #define SOLVER_PROBLEM_DEP_PROVIDERS_NOT_INSTALLABLE SOLVER_RULE_RPM_PACKAGE_REQUIRES
262 #define SOLVER_PROBLEM_SELF_CONFLICT SOLVER_RULE_RPM_SELF_CONFLICT
263 #define SOLVER_PROBLEM_RPM_RULE SOLVER_RULE_RPM
264 #define SOLVER_PROBLEM_DISTUPGRADE_RULE SOLVER_RULE_DISTUPGRADE
265 #define SOLVER_PROBLEM_INFARCH_RULE SOLVER_RULE_INFARCH
268 extern Solver *solver_create(Pool *pool);
269 extern void solver_free(Solver *solv);
270 extern void solver_solve(Solver *solv, Queue *job);
272 extern void solver_run_sat(Solver *solv, int disablerules, int doweak);
273 extern void solver_reset(Solver *solv);
275 extern int solver_dep_installed(Solver *solv, Id dep);
276 extern int solver_splitprovides(Solver *solv, Id dep);
278 extern void solver_calculate_noobsmap(Pool *pool, Queue *job, Map *noobsmap);
281 extern SolverRuleinfo solver_problemruleinfo(Solver *solv, Queue *job, Id rid, Id *depp, Id *sourcep, Id *targetp);
283 /* XXX: why is this not static? */
284 Id *solver_create_decisions_obsoletesmap(Solver *solv);
287 solver_dep_fulfilled(Solver *solv, Id dep)
289 Pool *pool = solv->pool;
294 Reldep *rd = GETRELDEP(pool, dep);
295 if (rd->flags == REL_AND)
297 if (!solver_dep_fulfilled(solv, rd->name))
299 return solver_dep_fulfilled(solv, rd->evr);
301 if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_SPLITPROVIDES)
302 return solver_splitprovides(solv, rd->evr);
303 if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_INSTALLED)
304 return solver_dep_installed(solv, rd->evr);
306 FOR_PROVIDES(p, pp, dep)
308 if (solv->decisionmap[p] > 0)
315 solver_is_supplementing(Solver *solv, Solvable *s)
320 supp = s->repo->idarraydata + s->supplements;
321 while ((sup = *supp++) != 0)
322 if (solver_dep_fulfilled(solv, sup))
328 solver_is_enhancing(Solver *solv, Solvable *s)
333 enhp = s->repo->idarraydata + s->enhances;
334 while ((enh = *enhp++) != 0)
335 if (solver_dep_fulfilled(solv, enh))
340 void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
341 int solver_calc_installsizechange(Solver *solv);
342 void solver_trivial_installable(Solver *solv, Queue *pkgs, Queue *res);
344 void solver_find_involved(Solver *solv, Queue *installedq, Solvable *s, Queue *q);
347 solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap)
349 pool_create_state_maps(solv->pool, &solv->decisionq, installedmap, conflictsmap);
352 /* iterate over all literals of a rule */
353 /* WARNING: loop body must not relocate whatprovidesdata, e.g. by
354 * looking up the providers of a dependency */
355 #define FOR_RULELITERALS(l, dp, r) \
356 for (l = r->d < 0 ? -r->d - 1 : r->d, \
357 dp = !l ? &r->w2 : pool->whatprovidesdata + l, \
358 l = r->p; l; l = (dp != &r->w2 + 1 ? *dp++ : 0))
360 /* iterate over all packages selected by a job */
361 #define FOR_JOB_SELECT(p, pp, select, what) \
362 for (pp = (select == SOLVER_SOLVABLE ? 0 : \
363 select == SOLVER_SOLVABLE_ONE_OF ? what : \
364 pool_whatprovides(pool, what)), \
365 p = (select == SOLVER_SOLVABLE ? what : pool->whatprovidesdata[pp++]) ; p ; p = pool->whatprovidesdata[pp++]) \
366 if (select != SOLVER_SOLVABLE_NAME || pool_match_nevr(pool, pool->solvables + p, what))
372 #endif /* SATSOLVER_SOLVER_H */