2 * Copyright (c) 2007, Novell Inc.
4 * This program is licensed under the BSD license, read LICENSE.BSD
5 * for further information
13 #ifndef LIBSOLV_SOLVER_H
14 #define LIBSOLV_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 Pool *pool; /* back pointer to pool */
42 Queue job; /* copy of the job we're solving */
44 Transaction trans; /* calculated transaction */
46 Repo *installed; /* copy of pool->installed */
48 /* list of rules, ordered
49 * rpm rules first, then features, updates, jobs, learnt
50 * see start/end offsets below
52 Rule *rules; /* all rules */
53 Id nrules; /* [Offset] index of the last rule */
55 Queue ruleassertions; /* Queue of all assertion rules */
57 /* start/end offset for rule 'areas' */
59 Id rpmrules_end; /* [Offset] rpm rules end */
61 Id featurerules; /* feature rules start/end */
64 Id updaterules; /* policy rules, e.g. keep packages installed or update. All literals > 0 */
67 Id jobrules; /* user rules */
70 Id infarchrules; /* inferior arch rules */
73 Id duprules; /* dist upgrade rules */
76 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 (multiinstall) */
86 Map updatemap; /* bring these installed packages to the newest version */
87 int updatemap_all; /* bring all packages to the newest version */
89 Map fixmap; /* fix these packages */
90 int fixmap_all; /* fix all packages */
92 Queue weakruleq; /* index into 'rules' for weak ones */
93 Map weakrulemap; /* map rule# to '1' for weak rules, 1..learntrules */
95 Id *watches; /* Array of rule offsets
96 * watches has nsolvables*2 entries and is addressed from the middle
97 * middle-solvable : decision to conflict, offset point to linked-list of rules
98 * middle+solvable : decision to install: offset point to linked-list of rules
101 Queue ruletojob; /* index into job queue: jobs for which a rule exits */
104 Queue decisionq; /* >0:install, <0:remove/conflict */
105 Queue decisionq_why; /* index of rule, Offset into rules */
107 Id *decisionmap; /* map for all available solvables,
109 * > 0: level of decision when installed,
110 * < 0: level of decision when conflict */
112 int decisioncnt_weak;
113 int decisioncnt_orphan;
115 /* learnt rule history */
120 int (*solution_callback)(struct _Solver *solv, void *data);
121 void *solution_callback_data;
123 int propagate_index; /* index into decisionq for non-propagated decisions */
125 Queue problems; /* list of lists of conflicting rules, < 0 for job rules */
126 Queue solutions; /* refined problem storage space */
128 Queue recommendations; /* recommended packages */
129 Queue suggestions; /* suggested packages */
130 Queue orphaned; /* orphaned packages */
132 int stats_learned; /* statistic */
133 int stats_unsolvable; /* statistic */
135 Map recommendsmap; /* recommended packages from decisionmap */
136 Map suggestsmap; /* suggested packages from decisionmap */
137 int recommends_index; /* recommendsmap/suggestsmap is created up to this level */
139 Id *obsoletes; /* obsoletes for each installed solvable */
140 Id *obsoletes_data; /* data area for obsoletes */
141 Id *multiversionupdaters; /* updaters for multiversion packages in updatesystem mode */
143 /*-------------------------------------------------------------------------------------------------------------
144 * Solver configuration
145 *-------------------------------------------------------------------------------------------------------------*/
147 int fixsystem; /* repair errors in rpm dependency graph */
148 int allowdowngrade; /* allow to downgrade installed solvable */
149 int allowarchchange; /* allow to change architecture of installed solvables */
150 int allowvendorchange; /* allow to change vendor of installed solvables */
151 int allowuninstall; /* allow removal of installed solvables */
152 int updatesystem; /* update all packages to the newest version */
153 int noupdateprovide; /* true: update packages needs not to provide old package */
154 int dosplitprovides; /* true: consider legacy split provides */
155 int dontinstallrecommended; /* true: do not install recommended packages */
156 int ignorealreadyrecommended; /* true: ignore recommended packages that were already recommended by the installed packages */
157 int dontshowinstalledrecommended; /* true: do not show recommended packages that are already installed */
159 /* distupgrade also needs updatesystem and dosplitprovides */
161 int distupgrade_removeunsupported;
163 int noinfarchcheck; /* true: do not forbid inferior architectures */
165 /* Callbacks for defining the bahaviour of the SAT solver */
167 /* Finding best candidate
169 * Callback definition:
170 * void bestSolvable (Pool *pool, Queue *canditates)
171 * candidates : List of canditates which has to be sorted by the function call
172 * return candidates: Sorted list of the candidates(first is the best).
174 BestSolvableCb bestSolvableCb;
176 /* Checking if two solvables has compatible architectures
178 * Callback definition:
179 * int archCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
181 * return 0 it the two solvables has compatible architectures
183 ArchCheckCb archCheckCb;
185 /* Checking if two solvables has compatible vendors
187 * Callback definition:
188 * int vendorCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
190 * return 0 it the two solvables has compatible architectures
192 VendorCheckCb vendorCheckCb;
194 /* Evaluate update candidate
196 * Callback definition:
197 * void pdateCandidateCb (Pool *pool, Solvable *solvable, Queue *canditates)
198 * solvable : for which updates should be search
199 * candidates : List of candidates (This list depends on other
200 * restrictions like architecture and vendor policies too)
202 UpdateCandidateCb updateCandidateCb;
204 Map dupmap; /* dup these packages*/
205 int dupmap_all; /* dup all packages */
206 Map dupinvolvedmap; /* packages involved in dup process */
208 Map droporphanedmap; /* packages to drop in dup mode */
209 int droporphanedmap_all;
211 Map cleandepsmap; /* try to drop these packages as of cleandeps erases */
213 Queue *ruleinfoq; /* tmp space for solver_ruleinfo() */
218 typedef struct _Solver Solver;
224 #define SOLVER_SOLVABLE 0x01
225 #define SOLVER_SOLVABLE_NAME 0x02
226 #define SOLVER_SOLVABLE_PROVIDES 0x03
227 #define SOLVER_SOLVABLE_ONE_OF 0x04
228 #define SOLVER_SOLVABLE_REPO 0x05
229 #define SOLVER_SOLVABLE_ALL 0x06
231 #define SOLVER_SELECTMASK 0xff
233 #define SOLVER_NOOP 0x0000
234 #define SOLVER_INSTALL 0x0100
235 #define SOLVER_ERASE 0x0200
236 #define SOLVER_UPDATE 0x0300
237 #define SOLVER_WEAKENDEPS 0x0400
238 #define SOLVER_NOOBSOLETES 0x0500
239 #define SOLVER_LOCK 0x0600
240 #define SOLVER_DISTUPGRADE 0x0700
241 #define SOLVER_VERIFY 0x0800
242 #define SOLVER_DROP_ORPHANED 0x0900
243 #define SOLVER_USERINSTALLED 0x0a00
245 #define SOLVER_JOBMASK 0xff00
247 #define SOLVER_WEAK 0x010000
248 #define SOLVER_ESSENTIAL 0x020000
249 #define SOLVER_CLEANDEPS 0x040000
251 #define SOLVER_SETEV 0x01000000
252 #define SOLVER_SETEVR 0x02000000
253 #define SOLVER_SETARCH 0x04000000
254 #define SOLVER_SETVENDOR 0x08000000
255 #define SOLVER_SETREPO 0x10000000
256 #define SOLVER_NOAUTOSET 0x20000000
258 #define SOLVER_SETMASK 0x2f000000
260 extern Solver *solver_create(Pool *pool);
261 extern void solver_free(Solver *solv);
262 extern int solver_solve(Solver *solv, Queue *job);
264 extern void solver_calculate_noobsmap(Pool *pool, Queue *job, Map *noobsmap);
265 extern void solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap);
267 /* XXX: why is this not static? */
268 Id *solver_create_decisions_obsoletesmap(Solver *solv);
270 void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
271 int solver_calc_installsizechange(Solver *solv);
272 void solver_trivial_installable(Solver *solv, Queue *pkgs, Queue *res);
274 void solver_find_involved(Solver *solv, Queue *installedq, Solvable *s, Queue *q);
276 /* iterate over all literals of a rule */
277 /* WARNING: loop body must not relocate whatprovidesdata, e.g. by
278 * looking up the providers of a dependency */
279 #define FOR_RULELITERALS(l, dp, r) \
280 for (l = r->d < 0 ? -r->d - 1 : r->d, \
281 dp = !l ? &r->w2 : pool->whatprovidesdata + l, \
282 l = r->p; l; l = (dp != &r->w2 + 1 ? *dp++ : 0))
284 /* iterate over all packages selected by a job */
285 #define FOR_JOB_SELECT(p, pp, select, what) \
286 if (select == SOLVER_SOLVABLE_REPO || select == SOLVER_SOLVABLE_ALL) \
288 else for (pp = (select == SOLVER_SOLVABLE ? 0 : \
289 select == SOLVER_SOLVABLE_ONE_OF ? what : \
290 pool_whatprovides(pool, what)), \
291 p = (select == SOLVER_SOLVABLE ? what : pool->whatprovidesdata[pp++]) ; p ; p = pool->whatprovidesdata[pp++]) \
292 if (select != SOLVER_SOLVABLE_NAME || pool_match_nevr(pool, pool->solvables + p, what))
298 #endif /* LIBSOLV_SOLVER_H */