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"
26 * Callback definitions in order to "overwrite" the policies by an external application.
29 typedef void (*BestSolvableCb) (Pool *pool, Queue *canditates);
30 typedef int (*ArchCheckCb) (Pool *pool, Solvable *solvable1, Solvable *solvable2);
31 typedef int (*VendorCheckCb) (Pool *pool, Solvable *solvable1, Solvable *solvable2);
32 typedef void (*UpdateCandidateCb) (Pool *pool, Solvable *solvable, Queue *canditates);
35 /* ----------------------------------------------
38 * providerN(B) == Package Id of package providing tag B
39 * N = 1, 2, 3, in case of multiple providers
41 * A requires B : !A | provider1(B) | provider2(B)
43 * A conflicts B : (!A | !provider1(B)) & (!A | !provider2(B)) ...
45 * 'not' is encoded as a negative Id
47 * Binary rule: p = first literal, d = 0, w2 = second literal, w1 = p
51 Id p; /* first literal in rule */
52 Id d; /* Id offset into 'list of providers terminated by 0' as used by whatprovides; pool->whatprovides + d */
53 /* in case of binary rules, d == 0, w1 == p, w2 == other literal */
54 /* in case of disabled rules: ~d, aka -d - 1 */
55 Id w1, w2; /* watches, literals not-yet-decided */
56 /* if !w2, assertion, not rule */
57 Id n1, n2; /* next rules in linked list, corresponding to w1,w2 */
62 typedef struct solver {
66 /* list of rules, ordered
67 * rpm rules first, then features, updates, jobs, learnt
68 * see start/end offsets below
70 Rule *rules; /* all rules */
71 Id nrules; /* [Offset] index of the last rule */
73 Queue ruleassertions; /* Queue of all assertion rules */
75 /* start/end offset for rule 'areas' */
77 Id rpmrules_end; /* [Offset] rpm rules end */
79 Id featurerules; /* feature rules start/end */
82 Id updaterules; /* policy rules, e.g. keep packages installed or update. All literals > 0 */
85 Id jobrules; /* user rules */
88 Id learntrules; /* learnt rules, (end == nrules) */
90 Map noupdate; /* don't try to update these
91 installed solvables */
92 Map noobsoletes; /* ignore obsoletes for these
95 Queue weakruleq; /* index into 'rules' for weak ones */
96 Map weakrulemap; /* map rule# to '1' for weak rules, 1..learntrules */
98 Id *watches; /* Array of rule offsets
99 * watches has nsolvables*2 entries and is addressed from the middle
100 * middle-solvable : decision to conflict, offset point to linked-list of rules
101 * middle+solvable : decision to install: offset point to linked-list of rules
104 Queue ruletojob; /* index into job queue: jobs for which a rule exits */
107 Queue decisionq; /* >0:install, <0:remove/conflict */
108 Queue decisionq_why; /* index of rule, Offset into rules */
109 int directdecisions; /* number of decisions with no rule */
111 Id *decisionmap; /* map for all available solvables,
113 * > 0: level of decision when installed,
114 * < 0: level of decision when conflict */
116 /* learnt rule history */
121 int (*solution_callback)(struct solver *solv, void *data);
122 void *solution_callback_data;
124 int propagate_index; /* index into decisionq for non-propagated decisions */
126 Queue problems; /* index of conflicting rules, < 0 for job rules */
127 Queue recommendations; /* recommended packages */
128 Queue suggestions; /* suggested packages */
130 int stats_learned; /* statistic */
131 int stats_unsolvable; /* statistic */
133 Map recommendsmap; /* recommended packages from decisionmap */
134 Map suggestsmap; /* suggested packages from decisionmap */
135 int recommends_index; /* recommendsmap/suggestsmap is created up to this level */
137 Id *obsoletes; /* obsoletes for each installed solvable */
138 Id *obsoletes_data; /* data area for obsoletes */
140 /*-------------------------------------------------------------------------------------------------------------
141 * Solver configuration
142 *-------------------------------------------------------------------------------------------------------------*/
144 int fixsystem; /* repair errors in rpm dependency graph */
145 int allowdowngrade; /* allow to downgrade installed solvable */
146 int allowarchchange; /* allow to change architecture of installed solvables */
147 int allowvendorchange; /* allow to change vendor of installed solvables */
148 int allowuninstall; /* allow removal of installed solvables */
149 int updatesystem; /* distupgrade */
150 int allowvirtualconflicts; /* false: conflicts on package name, true: conflicts on package provides */
151 int allowselfconflicts; /* true: packages wich conflict with itself are installable */
152 int obsoleteusesprovides; /* true: obsoletes are matched against provides, not names */
153 int implicitobsoleteusesprovides; /* true: implicit obsoletes due to same name are matched against provides, not names */
154 int noupdateprovide; /* true: update packages needs not to provide old package */
155 int dosplitprovides; /* true: consider legacy split provides */
156 int dontinstallrecommended; /* true: do not install recommended packages */
157 int ignorealreadyrecommended; /* true: ignore recommended packages that were already recommended by the installed packages */
158 int dontshowinstalledrecommended; /* true: do not show recommended packages that are already installed */
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 */
202 Queue covenantq; /* Covenants honored by this solver (generic locks) */
213 SOLVER_INSTALL_SOLVABLE,
214 SOLVER_ERASE_SOLVABLE,
215 SOLVER_INSTALL_SOLVABLE_NAME,
216 SOLVER_ERASE_SOLVABLE_NAME,
217 SOLVER_INSTALL_SOLVABLE_PROVIDES,
218 SOLVER_ERASE_SOLVABLE_PROVIDES,
219 SOLVER_INSTALL_SOLVABLE_UPDATE,
220 SOLVER_INSTALL_SOLVABLE_ONE_OF,
221 SOLVER_WEAKEN_SOLVABLE_DEPS,
222 SOLVER_NOOBSOLETES_SOLVABLE,
223 SOLVER_NOOBSOLETES_SOLVABLE_NAME,
224 SOLVER_NOOBSOLETES_SOLVABLE_PROVIDES,
231 SOLVER_PROBLEM_UPDATE_RULE,
232 SOLVER_PROBLEM_JOB_RULE,
233 SOLVER_PROBLEM_JOB_NOTHING_PROVIDES_DEP,
234 SOLVER_PROBLEM_NOT_INSTALLABLE,
235 SOLVER_PROBLEM_NOTHING_PROVIDES_DEP,
236 SOLVER_PROBLEM_SAME_NAME,
237 SOLVER_PROBLEM_PACKAGE_CONFLICT,
238 SOLVER_PROBLEM_PACKAGE_OBSOLETES,
239 SOLVER_PROBLEM_DEP_PROVIDERS_NOT_INSTALLABLE,
240 SOLVER_PROBLEM_SELF_CONFLICT,
241 SOLVER_PROBLEM_RPM_RULE
245 extern Solver *solver_create(Pool *pool, Repo *installed);
246 extern void solver_free(Solver *solv);
247 extern void solver_solve(Solver *solv, Queue *job);
248 extern int solver_dep_installed(Solver *solv, Id dep);
249 extern int solver_splitprovides(Solver *solv, Id dep);
251 extern Id solver_next_problem(Solver *solv, Id problem);
252 extern Id solver_next_solution(Solver *solv, Id problem, Id solution);
253 extern Id solver_next_solutionelement(Solver *solv, Id problem, Id solution, Id element, Id *p, Id *rp);
254 extern Id solver_findproblemrule(Solver *solv, Id problem);
255 extern SolverProbleminfo solver_problemruleinfo(Solver *solv, Queue *job, Id rid, Id *depp, Id *sourcep, Id *targetp);
257 /* XXX: why is this not static? */
258 Id *create_decisions_obsoletesmap(Solver *solv);
261 solver_dep_fulfilled(Solver *solv, Id dep)
263 Pool *pool = solv->pool;
268 Reldep *rd = GETRELDEP(pool, dep);
269 if (rd->flags == REL_AND)
271 if (!solver_dep_fulfilled(solv, rd->name))
273 return solver_dep_fulfilled(solv, rd->evr);
275 if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_SPLITPROVIDES)
276 return solver_splitprovides(solv, rd->evr);
277 if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_INSTALLED)
278 return solver_dep_installed(solv, rd->evr);
280 FOR_PROVIDES(p, pp, dep)
282 if (solv->decisionmap[p] > 0)
289 solver_is_supplementing(Solver *solv, Solvable *s)
292 if (!s->supplements && !s->freshens)
296 supp = s->repo->idarraydata + s->supplements;
297 while ((sup = *supp++) != 0)
298 if (solver_dep_fulfilled(solv, sup))
305 supp = s->repo->idarraydata + s->freshens;
306 while ((sup = *supp++) != 0)
307 if (solver_dep_fulfilled(solv, sup))
316 solver_is_enhancing(Solver *solv, Solvable *s)
321 enhp = s->repo->idarraydata + s->enhances;
322 while ((enh = *enhp++) != 0)
323 if (solver_dep_fulfilled(solv, enh))
328 void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
329 int solver_calc_installsizechange(Solver *solv);
332 solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap)
334 pool_create_state_maps(solv->pool, &solv->decisionq, installedmap, conflictsmap);
337 #define FOR_RULELITERALS(l, dp, r) \
338 for (l = r->d < 0 ? -r->d - 1 : r->d, \
339 dp = !l ? &r->w2 : pool->whatprovidesdata + l, \
340 l = r->p; l; l = (dp != &r->w2 + 1 ? *dp++ : 0))
346 #endif /* SATSOLVER_SOLVER_H */