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 {
43 Queue job; /* copy of the job we're solving */
45 Queue transaction; /* solver result */
46 Queue transaction_info; /* transaction obsoletes info */
47 Id *transaction_installed; /* data for installed packages */
49 Repo *installed; /* copy of pool->installed */
51 /* list of rules, ordered
52 * rpm rules first, then features, updates, jobs, learnt
53 * see start/end offsets below
55 Rule *rules; /* all rules */
56 Id nrules; /* [Offset] index of the last rule */
58 Queue ruleassertions; /* Queue of all assertion rules */
60 /* start/end offset for rule 'areas' */
62 Id rpmrules_end; /* [Offset] rpm rules end */
64 Id featurerules; /* feature rules start/end */
67 Id updaterules; /* policy rules, e.g. keep packages installed or update. All literals > 0 */
70 Id jobrules; /* user rules */
73 Id infarchrules; /* inferior arch rules */
76 Id duprules; /* dist upgrade rules */
79 Id learntrules; /* learnt rules, (end == nrules) */
81 Map noupdate; /* don't try to update these
82 installed solvables */
83 Map noobsoletes; /* ignore obsoletes for these
86 Map updatemap; /* bring those packages to the newest version */
87 Queue weakruleq; /* index into 'rules' for weak ones */
88 Map weakrulemap; /* map rule# to '1' for weak rules, 1..learntrules */
90 Id *watches; /* Array of rule offsets
91 * watches has nsolvables*2 entries and is addressed from the middle
92 * middle-solvable : decision to conflict, offset point to linked-list of rules
93 * middle+solvable : decision to install: offset point to linked-list of rules
96 Queue ruletojob; /* index into job queue: jobs for which a rule exits */
99 Queue decisionq; /* >0:install, <0:remove/conflict */
100 Queue decisionq_why; /* index of rule, Offset into rules */
102 Id *decisionmap; /* map for all available solvables,
104 * > 0: level of decision when installed,
105 * < 0: level of decision when conflict */
107 /* learnt rule history */
112 int (*solution_callback)(struct _Solver *solv, void *data);
113 void *solution_callback_data;
115 int propagate_index; /* index into decisionq for non-propagated decisions */
117 Queue problems; /* list of lists of conflicting rules, < 0 for job rules */
118 Queue solutions; /* refined problem storage space */
120 Queue recommendations; /* recommended packages */
121 Queue suggestions; /* suggested packages */
122 Queue orphaned; /* orphaned packages */
124 int stats_learned; /* statistic */
125 int stats_unsolvable; /* statistic */
127 Map recommendsmap; /* recommended packages from decisionmap */
128 Map suggestsmap; /* suggested packages from decisionmap */
129 int recommends_index; /* recommendsmap/suggestsmap is created up to this level */
131 Id *obsoletes; /* obsoletes for each installed solvable */
132 Id *obsoletes_data; /* data area for obsoletes */
133 Id *multiversionupdaters; /* updaters for multiversion packages in updatesystem mode */
135 /*-------------------------------------------------------------------------------------------------------------
136 * Solver configuration
137 *-------------------------------------------------------------------------------------------------------------*/
139 int fixsystem; /* repair errors in rpm dependency graph */
140 int allowdowngrade; /* allow to downgrade installed solvable */
141 int allowarchchange; /* allow to change architecture of installed solvables */
142 int allowvendorchange; /* allow to change vendor of installed solvables */
143 int allowuninstall; /* allow removal of installed solvables */
144 int updatesystem; /* update all packages to the newest version */
145 int allowvirtualconflicts; /* false: conflicts on package name, true: conflicts on package provides */
146 int allowselfconflicts; /* true: packages wich conflict with itself are installable */
147 int obsoleteusesprovides; /* true: obsoletes are matched against provides, not names */
148 int implicitobsoleteusesprovides; /* true: implicit obsoletes due to same name are matched against provides, not names */
149 int noupdateprovide; /* true: update packages needs not to provide old package */
150 int dosplitprovides; /* true: consider legacy split provides */
151 int dontinstallrecommended; /* true: do not install recommended packages */
152 int ignorealreadyrecommended; /* true: ignore recommended packages that were already recommended by the installed packages */
153 int dontshowinstalledrecommended; /* true: do not show recommended packages that are already installed */
155 /* distupgrade also needs updatesystem and dosplitprovides */
157 int distupgrade_removeunsupported;
159 int noinfarchcheck; /* true: do not forbid inferior architectures */
161 /* Callbacks for defining the bahaviour of the SAT solver */
163 /* Finding best candidate
165 * Callback definition:
166 * void bestSolvable (Pool *pool, Queue *canditates)
167 * candidates : List of canditates which has to be sorted by the function call
168 * return candidates: Sorted list of the candidates(first is the best).
170 BestSolvableCb bestSolvableCb;
172 /* Checking if two solvables has compatible architectures
174 * Callback definition:
175 * int archCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
177 * return 0 it the two solvables has compatible architectures
179 ArchCheckCb archCheckCb;
181 /* Checking if two solvables has compatible vendors
183 * Callback definition:
184 * int vendorCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
186 * return 0 it the two solvables has compatible architectures
188 VendorCheckCb vendorCheckCb;
190 /* Evaluate update candidate
192 * Callback definition:
193 * void pdateCandidateCb (Pool *pool, Solvable *solvable, Queue *canditates)
194 * solvable : for which updates should be search
195 * candidates : List of candidates (This list depends on other
196 * restrictions like architecture and vendor policies too)
198 UpdateCandidateCb updateCandidateCb;
201 /* some strange queue that doesn't belong here */
202 Queue covenantq; /* Covenants honored by this solver (generic locks) */
205 Map dupmap; /* packages from dup repos */
206 Map dupinvolvedmap; /* packages involved in dup process */
208 Queue *ruleinfoq; /* tmp space for solver_ruleinfo() */
215 #define SOLVER_SOLVABLE 0x01
216 #define SOLVER_SOLVABLE_NAME 0x02
217 #define SOLVER_SOLVABLE_PROVIDES 0x03
218 #define SOLVER_SOLVABLE_ONE_OF 0x04
220 #define SOLVER_SELECTMASK 0xff
222 #define SOLVER_NOOP 0x0000
223 #define SOLVER_INSTALL 0x0100
224 #define SOLVER_ERASE 0x0200
225 #define SOLVER_UPDATE 0x0300
226 #define SOLVER_WEAKENDEPS 0x0400
227 #define SOLVER_NOOBSOLETES 0x0500
228 #define SOLVER_LOCK 0x0600
229 #define SOLVER_DISTUPGRADE 0x0700
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);
279 extern SolverRuleinfo solver_problemruleinfo(Solver *solv, Queue *job, Id rid, Id *depp, Id *sourcep, Id *targetp);
281 /* XXX: why is this not static? */
282 Id *solver_create_decisions_obsoletesmap(Solver *solv);
285 solver_dep_fulfilled(Solver *solv, Id dep)
287 Pool *pool = solv->pool;
292 Reldep *rd = GETRELDEP(pool, dep);
293 if (rd->flags == REL_AND)
295 if (!solver_dep_fulfilled(solv, rd->name))
297 return solver_dep_fulfilled(solv, rd->evr);
299 if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_SPLITPROVIDES)
300 return solver_splitprovides(solv, rd->evr);
301 if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_INSTALLED)
302 return solver_dep_installed(solv, rd->evr);
304 FOR_PROVIDES(p, pp, dep)
306 if (solv->decisionmap[p] > 0)
313 solver_is_supplementing(Solver *solv, Solvable *s)
318 supp = s->repo->idarraydata + s->supplements;
319 while ((sup = *supp++) != 0)
320 if (solver_dep_fulfilled(solv, sup))
326 solver_is_enhancing(Solver *solv, Solvable *s)
331 enhp = s->repo->idarraydata + s->enhances;
332 while ((enh = *enhp++) != 0)
333 if (solver_dep_fulfilled(solv, enh))
338 void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
339 int solver_calc_installsizechange(Solver *solv);
340 void solver_trivial_installable(Solver *solv, Queue *pkgs, Queue *res);
342 void solver_find_involved(Solver *solv, Queue *installedq, Solvable *s, Queue *q);
345 solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap)
347 pool_create_state_maps(solv->pool, &solv->decisionq, installedmap, conflictsmap);
350 /* iterate over all literals of a rule */
351 /* WARNING: loop body must not relocate whatprovidesdata, e.g. by
352 * looking up the providers of a dependency */
353 #define FOR_RULELITERALS(l, dp, r) \
354 for (l = r->d < 0 ? -r->d - 1 : r->d, \
355 dp = !l ? &r->w2 : pool->whatprovidesdata + l, \
356 l = r->p; l; l = (dp != &r->w2 + 1 ? *dp++ : 0))
358 /* iterate over all packages selected by a job */
359 #define FOR_JOB_SELECT(p, pp, select, what) \
360 for (pp = (select == SOLVER_SOLVABLE ? 0 : \
361 select == SOLVER_SOLVABLE_ONE_OF ? what : \
362 pool_whatprovides(pool, what)), \
363 p = (select == SOLVER_SOLVABLE ? what : pool->whatprovidesdata[pp++]) ; p ; p = pool->whatprovidesdata[pp++]) \
364 if (select != SOLVER_SOLVABLE_NAME || pool_match_nevr(pool, pool->solvables + p, what))
370 #endif /* SATSOLVER_SOLVER_H */