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 Rule *rules; /* all rules */
67 Id nrules; /* index of the last rule */
69 Queue ruleassertions; /* index of all assertion rules */
72 Id featurerules; /* feature rules */
74 Id updaterules; /* policy rules, e.g. keep packages installed or update. All literals > 0 */
76 Id jobrules; /* user rules */
78 Id learntrules; /* learnt rules */
80 Map noupdate; /* don't try to update these
81 installed solvables */
85 Id *watches; /* Array of rule offsets
86 * watches has nsolvables*2 entries and is addressed from the middle
87 * middle-solvable : decision to conflict, offset point to linked-list of rules
88 * middle+solvable : decision to install: offset point to linked-list of rules
95 Queue decisionq_why; /* index of rule, Offset into rules */
96 int directdecisions; /* number of decisions with no rule */
98 Id *decisionmap; /* map for all available solvables, > 0: level of decision when installed, < 0 level of decision when conflict */
100 /* learnt rule history */
105 int (*solution_callback)(struct solver *solv, void *data);
106 void *solution_callback_data;
111 Queue recommendations; /* recommended packages */
112 Queue suggestions; /* suggested packages */
114 int stats_learned; /* statistic */
115 int stats_unsolvable; /* statistic */
117 Map recommendsmap; /* recommended packages from decisionmap */
118 Map suggestsmap; /* suggested packages from decisionmap */
119 int recommends_index; /* recommendsmap/suggestsmap is created up to this level */
121 Id *obsoletes; /* obsoletes for each installed solvable */
122 Id *obsoletes_data; /* data area for obsoletes */
124 /*-------------------------------------------------------------------------------------------------------------
125 * Solver configuration
126 *-------------------------------------------------------------------------------------------------------------*/
128 int fixsystem; /* repair errors in rpm dependency graph */
129 int allowdowngrade; /* allow to downgrade installed solvable */
130 int allowarchchange; /* allow to change architecture of installed solvables */
131 int allowvendorchange; /* allow to change vendor of installed solvables */
132 int allowuninstall; /* allow removal of installed solvables */
133 int updatesystem; /* distupgrade */
134 int allowvirtualconflicts; /* false: conflicts on package name, true: conflicts on package provides */
135 int allowselfconflicts; /* true: packages wich conflict with itself are installable */
136 int obsoleteusesprovides; /* true: obsoletes are matched against provides, not names */
137 int implicitobsoleteusesprovides; /* true: implicit obsoletes due to same name are matched against provides, not names */
138 int noupdateprovide; /* true: update packages needs not to provide old package */
139 int dosplitprovides; /* true: consider legacy split provides */
140 int dontinstallrecommended; /* true: do not install recommended packages */
141 int dontshowinstalledrecommended; /* true: do not show recommended packages that are already installed */
143 /* Callbacks for defining the bahaviour of the SAT solver */
145 /* Finding best candidate
147 * Callback definition:
148 * void bestSolvable (Pool *pool, Queue *canditates)
149 * candidates : List of canditates which has to be sorted by the function call
150 * return candidates: Sorted list of the candidates(first is the best).
152 BestSolvableCb bestSolvableCb;
154 /* Checking if two solvables has compatible architectures
156 * Callback definition:
157 * int archCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
159 * return 0 it the two solvables has compatible architectures
161 ArchCheckCb archCheckCb;
163 /* Checking if two solvables has compatible vendors
165 * Callback definition:
166 * int vendorCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
168 * return 0 it the two solvables has compatible architectures
170 VendorCheckCb vendorCheckCb;
172 /* Evaluate update candidate
174 * Callback definition:
175 * void pdateCandidateCb (Pool *pool, Solvable *solvable, Queue *canditates)
176 * solvable : for which updates should be search
177 * candidates : List of candidates (This list depends on other
178 * restrictions like architecture and vendor policies too)
180 UpdateCandidateCb updateCandidateCb;
183 /* some strange queue that doesn't belong here */
185 Queue covenantq; /* Covenants honored by this solver (generic locks) */
196 SOLVER_INSTALL_SOLVABLE,
197 SOLVER_ERASE_SOLVABLE,
198 SOLVER_INSTALL_SOLVABLE_NAME,
199 SOLVER_ERASE_SOLVABLE_NAME,
200 SOLVER_INSTALL_SOLVABLE_PROVIDES,
201 SOLVER_ERASE_SOLVABLE_PROVIDES,
202 SOLVER_INSTALL_SOLVABLE_UPDATE,
203 SOLVER_INSTALL_SOLVABLE_ONE_OF,
204 SOLVER_WEAKEN_SOLVABLE_DEPS,
209 SOLVER_PROBLEM_UPDATE_RULE,
210 SOLVER_PROBLEM_JOB_RULE,
211 SOLVER_PROBLEM_JOB_NOTHING_PROVIDES_DEP,
212 SOLVER_PROBLEM_NOT_INSTALLABLE,
213 SOLVER_PROBLEM_NOTHING_PROVIDES_DEP,
214 SOLVER_PROBLEM_SAME_NAME,
215 SOLVER_PROBLEM_PACKAGE_CONFLICT,
216 SOLVER_PROBLEM_PACKAGE_OBSOLETES,
217 SOLVER_PROBLEM_DEP_PROVIDERS_NOT_INSTALLABLE,
218 SOLVER_PROBLEM_SELF_CONFLICT
222 extern Solver *solver_create(Pool *pool, Repo *installed);
223 extern void solver_free(Solver *solv);
224 extern void solver_solve(Solver *solv, Queue *job);
225 extern int solver_dep_installed(Solver *solv, Id dep);
226 extern int solver_splitprovides(Solver *solv, Id dep);
228 extern Id solver_next_problem(Solver *solv, Id problem);
229 extern Id solver_next_solution(Solver *solv, Id problem, Id solution);
230 extern Id solver_next_solutionelement(Solver *solv, Id problem, Id solution, Id element, Id *p, Id *rp);
231 extern Id solver_findproblemrule(Solver *solv, Id problem);
232 extern SolverProbleminfo solver_problemruleinfo(Solver *solv, Queue *job, Id rid, Id *depp, Id *sourcep, Id *targetp);
234 /* XXX: why is this not static? */
235 Id *create_decisions_obsoletesmap(Solver *solv);
238 solver_dep_fulfilled(Solver *solv, Id dep)
240 Pool *pool = solv->pool;
245 Reldep *rd = GETRELDEP(pool, dep);
246 if (rd->flags == REL_AND)
248 if (!solver_dep_fulfilled(solv, rd->name))
250 return solver_dep_fulfilled(solv, rd->evr);
252 if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_SPLITPROVIDES)
253 return solver_splitprovides(solv, rd->evr);
254 if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_INSTALLED)
255 return solver_dep_installed(solv, rd->evr);
257 FOR_PROVIDES(p, pp, dep)
259 if (solv->decisionmap[p] > 0)
266 solver_is_supplementing(Solver *solv, Solvable *s)
269 if (!s->supplements && !s->freshens)
273 supp = s->repo->idarraydata + s->supplements;
274 while ((sup = *supp++) != 0)
275 if (solver_dep_fulfilled(solv, sup))
282 supp = s->repo->idarraydata + s->freshens;
283 while ((sup = *supp++) != 0)
284 if (solver_dep_fulfilled(solv, sup))
293 solver_is_enhancing(Solver *solv, Solvable *s)
298 enhp = s->repo->idarraydata + s->enhances;
299 while ((enh = *enhp++) != 0)
300 if (solver_dep_fulfilled(solv, enh))
305 void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
306 int solver_calc_installsizechange(Solver *solv);
309 solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap)
311 pool_create_state_maps(solv->pool, &solv->decisionq, installedmap, conflictsmap);
314 #define FOR_RULELITERALS(l, dp, r) \
315 for (l = r->d < 0 ? -r->d - 1 : r->d, \
316 dp = !l ? &r->w2 : pool->whatprovidesdata + l, \
317 l = r->p; l; l = (dp != &r->w2 + 1 ? *dp++ : 0))
323 #endif /* SATSOLVER_SOLVER_H */