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
16 #include "pooltypes.h"
22 * Callback definitions in order to "overwrite" the policies by an external application.
25 typedef void (*BestSolvableCb) (Pool *pool, Queue *canditates);
26 typedef int (*ArchCheckCb) (Pool *pool, Solvable *solvable1, Solvable *solvable2);
27 typedef int (*VendorCheckCb) (Pool *pool, Solvable *solvable1, Solvable *solvable2);
28 typedef void (*UpdateCandidateCb) (Pool *pool, Solvable *solvable, Queue *canditates);
31 /* ----------------------------------------------
34 * providerN(B) == Package Id of package providing tag B
35 * N = 1, 2, 3, in case of multiple providers
37 * A requires B : !A | provider1(B) | provider2(B)
39 * A conflicts B : (!A | !provider1(B)) & (!A | !provider2(B)) ...
41 * 'not' is encoded as a negative Id
43 * Binary rule: p = first literal, d = 0, w2 = second literal, w1 = p
47 Id p; /* first literal in rule */
48 Id d; /* Id offset into 'list of providers terminated by 0' as used by whatprovides; pool->whatprovides + d */
49 /* in case of binary rules, d == 0, w1 == p, w2 == other literal */
50 Id w1, w2; /* watches, literals not-yet-decided */
51 /* if !w1, disabled */
52 /* if !w2, assertion, not rule */
53 Id n1, n2; /* next rules in linked list, corresponding to w1,w2 */
58 typedef struct solver {
62 Rule *rules; /* all rules */
63 Id nrules; /* index of the last rule */
65 Id jobrules; /* user rules */
66 Id systemrules; /* policy rules, e.g. keep packages installed or update. All literals > 0 */
67 Id learntrules; /* learnt rules */
69 Id *weaksystemrules; /* please try to install (r->d) */
70 Map noupdate; /* don't try to update these
71 installed solvables */
75 Id *watches; /* Array of rule offsets
76 * watches has nsolvables*2 entries and is addressed from the middle
77 * middle-solvable : decision to conflict, offset point to linked-list of rules
78 * middle+solvable : decision to install: offset point to linked-list of rules
85 Queue decisionq_why; /* index of rule, Offset into rules */
86 int directdecisions; /* number of decisions with no rule */
88 Id *decisionmap; /* map for all available solvables, > 0: level of decision when installed, < 0 level of decision when conflict */
90 /* learnt rule history */
95 int (*solution_callback)(struct solver *solv, void *data);
96 void *solution_callback_data;
101 Queue recommendations; /* recommended packages */
102 Queue suggestions; /* suggested packages */
105 Map recommendsmap; /* recommended packages from decisionmap */
106 Map suggestsmap; /* suggested packages from decisionmap */
107 int recommends_index; /* recommendsmap/suggestsmap is created up to this level */
109 Id *obsoletes; /* obsoletes for each installed solvable */
110 Id *obsoletes_data; /* data area for obsoletes */
112 Queue covenantq; /* Covenants honored by this solver (generic locks) */
114 /*-------------------------------------------------------------------------------------------------------------
115 * Solver configuration
116 *-------------------------------------------------------------------------------------------------------------*/
118 int fixsystem; /* repair errors in rpm dependency graph */
119 int allowdowngrade; /* allow to downgrade installed solvable */
120 int allowarchchange; /* allow to change architecture of installed solvables */
121 int allowvendorchange; /* allow to change vendor of installed solvables */
122 int allowuninstall; /* allow removal of installed solvables */
123 int updatesystem; /* distupgrade */
124 int allowvirtualconflicts; /* false: conflicts on package name, true: conflicts on package provides */
125 int noupdateprovide; /* true: update packages needs not to provide old package */
126 int dosplitprovides; /* true: consider legacy split provides */
127 int dontinstallrecommended; /* true: do not install recommended packages */
129 /* Callbacks for defining the bahaviour of the SAT solver */
131 /* Finding best candidate
133 * Callback definition:
134 * void bestSolvable (Pool *pool, Queue *canditates)
135 * candidates : List of canditates which has to be sorted by the function call
136 * return candidates: Sorted list of the candidates(first is the best).
138 BestSolvableCb bestSolvableCb;
140 /* Checking if two solvables has compatible architectures
142 * Callback definition:
143 * int archCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
145 * return 0 it the two solvables has compatible architectures
147 ArchCheckCb archCheckCb;
149 /* Checking if two solvables has compatible vendors
151 * Callback definition:
152 * int vendorCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
154 * return 0 it the two solvables has compatible architectures
156 VendorCheckCb vendorCheckCb;
158 /* Evaluate update candidate
160 * Callback definition:
161 * void pdateCandidateCb (Pool *pool, Solvable *solvable, Queue *canditates)
162 * solvable : for which updates should be search
163 * candidates : List of candidates (This list depends on other
164 * restrictions like architecture and vendor policies too)
166 UpdateCandidateCb updateCandidateCb;
177 SOLVER_INSTALL_SOLVABLE,
178 SOLVER_ERASE_SOLVABLE,
179 SOLVER_INSTALL_SOLVABLE_NAME,
180 SOLVER_ERASE_SOLVABLE_NAME,
181 SOLVER_INSTALL_SOLVABLE_PROVIDES,
182 SOLVER_ERASE_SOLVABLE_PROVIDES,
183 SOLVER_INSTALL_SOLVABLE_UPDATE,
184 SOLVER_INSTALL_SOLVABLE_ONE_OF,
185 SOLVER_WEAKEN_SOLVABLE_DEPS,
190 SOLVER_PROBLEM_UPDATE_RULE,
191 SOLVER_PROBLEM_JOB_RULE,
192 SOLVER_PROBLEM_JOB_NOTHING_PROVIDES_DEP,
193 SOLVER_PROBLEM_NOT_INSTALLABLE,
194 SOLVER_PROBLEM_NOTHING_PROVIDES_DEP,
195 SOLVER_PROBLEM_SAME_NAME,
196 SOLVER_PROBLEM_PACKAGE_CONFLICT,
197 SOLVER_PROBLEM_PACKAGE_OBSOLETES,
198 SOLVER_PROBLEM_DEP_PROVIDERS_NOT_INSTALLABLE
202 extern Solver *solver_create(Pool *pool, Repo *installed);
203 extern void solver_free(Solver *solv);
204 extern void solver_solve(Solver *solv, Queue *job);
205 extern int solver_dep_installed(Solver *solv, Id dep);
206 extern int solver_splitprovides(Solver *solv, Id dep);
208 extern Id solver_next_problem(Solver *solv, Id problem);
209 extern Id solver_next_solution(Solver *solv, Id problem, Id solution);
210 extern Id solver_next_solutionelement(Solver *solv, Id problem, Id solution, Id element, Id *p, Id *rp);
211 extern Id solver_findproblemrule(Solver *solv, Id problem);
212 extern SolverProbleminfo solver_problemruleinfo(Solver *solv, Queue *job, Id rid, Id *depp, Id *sourcep, Id *targetp);
214 /* XXX: why is this not static? */
215 Id *create_decisions_obsoletesmap(Solver *solv);
217 /* debug functions, do not use */
218 void printdecisions(Solver *solv);
219 void printsolutions(Solver *solv, Queue *job);
223 solver_dep_fulfilled(Solver *solv, Id dep)
225 Pool *pool = solv->pool;
230 Reldep *rd = GETRELDEP(pool, dep);
231 if (rd->flags == REL_AND)
233 if (!solver_dep_fulfilled(solv, rd->name))
235 return solver_dep_fulfilled(solv, rd->evr);
237 if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_SPLITPROVIDES)
238 return solver_splitprovides(solv, rd->evr);
239 if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_INSTALLED)
240 return solver_dep_installed(solv, rd->evr);
242 FOR_PROVIDES(p, pp, dep)
244 if (solv->decisionmap[p] > 0)
251 solver_is_supplementing(Solver *solv, Solvable *s)
254 if (!s->supplements && !s->freshens)
258 supp = s->repo->idarraydata + s->supplements;
259 while ((sup = *supp++) != 0)
260 if (solver_dep_fulfilled(solv, sup))
267 supp = s->repo->idarraydata + s->freshens;
268 while ((sup = *supp++) != 0)
269 if (solver_dep_fulfilled(solv, sup))
278 solver_is_enhancing(Solver *solv, Solvable *s)
283 enhp = s->repo->idarraydata + s->enhances;
284 while ((enh = *enhp++) != 0)
285 if (solver_dep_fulfilled(solv, enh))
290 void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
291 int solver_calc_installsizechange(Solver *solv);
294 solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap)
296 pool_create_state_maps(solv->pool, &solv->decisionq, installedmap, conflictsmap);
299 #endif /* SATSOLVER_SOLVER_H */