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);
40 Pool *pool; /* back pointer to pool */
41 Queue job; /* copy of the job we're solving */
43 int (*solution_callback)(struct _Solver *solv, void *data);
44 void *solution_callback_data;
46 /* Callbacks for defining the bahaviour of the solver */
48 /* Finding best candidate
50 * Callback definition:
51 * void bestSolvable (Pool *pool, Queue *canditates)
52 * candidates : List of canditates which has to be sorted by the function call
53 * return candidates: Sorted list of the candidates(first is the best).
55 BestSolvableCb bestSolvableCb;
57 /* Checking if two solvables has compatible architectures
59 * Callback definition:
60 * int archCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
62 * return 0 it the two solvables has compatible architectures
64 ArchCheckCb archCheckCb;
66 /* Checking if two solvables has compatible vendors
68 * Callback definition:
69 * int vendorCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
71 * return 0 it the two solvables has compatible architectures
73 VendorCheckCb vendorCheckCb;
75 /* Evaluate update candidate
77 * Callback definition:
78 * void UpdateCandidateCb (Pool *pool, Solvable *solvable, Queue *canditates)
79 * solvable : for which updates should be search
80 * candidates : List of candidates (This list depends on other
81 * restrictions like architecture and vendor policies too)
83 UpdateCandidateCb updateCandidateCb;
85 int pooljobcnt; /* number of pooljob entries in job queue */
87 #ifdef LIBSOLV_INTERNAL
88 Repo *installed; /* copy of pool->installed */
90 /* list of rules, ordered
91 * rpm rules first, then features, updates, jobs, learnt
92 * see start/end offsets below
94 Rule *rules; /* all rules */
95 Id nrules; /* [Offset] index of the last rule */
97 Queue ruleassertions; /* Queue of all assertion rules */
99 /* start/end offset for rule 'areas' */
101 Id rpmrules_end; /* [Offset] rpm rules end */
103 Id featurerules; /* feature rules start/end */
106 Id updaterules; /* policy rules, e.g. keep packages installed or update. All literals > 0 */
109 Id jobrules; /* user rules */
112 Id infarchrules; /* inferior arch rules */
115 Id duprules; /* dist upgrade rules */
118 Id bestrules; /* rules from SOLVER_FORCEBEST */
122 Id choicerules; /* choice rules (always weak) */
126 Id learntrules; /* learnt rules, (end == nrules) */
128 Map noupdate; /* don't try to update these
129 installed solvables */
130 Map noobsoletes; /* ignore obsoletes for these (multiinstall) */
132 Map updatemap; /* bring these installed packages to the newest version */
133 int updatemap_all; /* bring all packages to the newest version */
135 Map bestupdatemap; /* create best rule for those packages */
136 int bestupdatemap_all; /* bring all packages to the newest version */
138 Map fixmap; /* fix these packages */
139 int fixmap_all; /* fix all packages */
141 Queue weakruleq; /* index into 'rules' for weak ones */
142 Map weakrulemap; /* map rule# to '1' for weak rules, 1..learntrules */
144 Id *watches; /* Array of rule offsets
145 * watches has nsolvables*2 entries and is addressed from the middle
146 * middle-solvable : decision to conflict, offset point to linked-list of rules
147 * middle+solvable : decision to install: offset point to linked-list of rules
150 Queue ruletojob; /* index into job queue: jobs for which a rule exits */
153 Queue decisionq; /* >0:install, <0:remove/conflict */
154 Queue decisionq_why; /* index of rule, Offset into rules */
156 Id *decisionmap; /* map for all available solvables,
158 * > 0: level of decision when installed,
159 * < 0: level of decision when conflict */
161 int decisioncnt_update;
162 int decisioncnt_keep;
163 int decisioncnt_resolve;
164 int decisioncnt_weak;
165 int decisioncnt_orphan;
167 /* learnt rule history */
172 int propagate_index; /* index into decisionq for non-propagated decisions */
174 Queue problems; /* list of lists of conflicting rules, < 0 for job rules */
175 Queue solutions; /* refined problem storage space */
177 Queue orphaned; /* orphaned packages (to be removed?) */
179 int stats_learned; /* statistic */
180 int stats_unsolvable; /* statistic */
182 Map recommendsmap; /* recommended packages from decisionmap */
183 Map suggestsmap; /* suggested packages from decisionmap */
184 int recommends_index; /* recommendsmap/suggestsmap is created up to this level */
186 Id *obsoletes; /* obsoletes for each installed solvable */
187 Id *obsoletes_data; /* data area for obsoletes */
188 Id *multiversionupdaters; /* updaters for multiversion packages in updatesystem mode */
190 /*-------------------------------------------------------------------------------------------------------------
191 * Solver configuration
192 *-------------------------------------------------------------------------------------------------------------*/
194 int allowdowngrade; /* allow to downgrade installed solvable */
195 int allownamechange; /* allow to change name of installed solvables */
196 int allowarchchange; /* allow to change architecture of installed solvables */
197 int allowvendorchange; /* allow to change vendor of installed solvables */
198 int allowuninstall; /* allow removal of installed solvables */
199 int noupdateprovide; /* true: update packages needs not to provide old package */
200 int dosplitprovides; /* true: consider legacy split provides */
201 int dontinstallrecommended; /* true: do not install recommended packages */
202 int addalreadyrecommended; /* true: also install recommended packages that were already recommended by the installed packages */
203 int dontshowinstalledrecommended; /* true: do not show recommended packages that are already installed */
205 int noinfarchcheck; /* true: do not forbid inferior architectures */
206 int keepexplicitobsoletes; /* true: honor obsoletes during multiinstall */
207 int bestobeypolicy; /* true: stay in policy with the best rules */
208 int noautotarget; /* true: do not assume targeted for up/dup jobs that contain no installed solvable */
211 Map dupmap; /* dup these packages*/
212 int dupmap_all; /* dup all packages */
213 Map dupinvolvedmap; /* packages involved in dup process */
214 int dup_allowdowngrade; /* dup mode: allow to downgrade installed solvable */
215 int dup_allownamechange; /* dup mode: allow to change name of installed solvable */
216 int dup_allowarchchange; /* dup mode: allow to change architecture of installed solvables */
217 int dup_allowvendorchange; /* dup mode: allow to change vendor of installed solvables */
219 Map droporphanedmap; /* packages to drop in dup mode */
220 int droporphanedmap_all;
222 Map cleandepsmap; /* try to drop these packages as of cleandeps erases */
224 Queue *ruleinfoq; /* tmp space for solver_ruleinfo() */
226 Queue *cleandeps_updatepkgs; /* packages we update in cleandeps mode */
227 Queue *cleandeps_mistakes; /* mistakes we made */
229 Queue *update_targets; /* update to specific packages */
231 Queue *installsuppdepq; /* deps from the install namespace provides hack */
233 Queue addedmap_deduceq; /* deduce addedmap from rpm rules */
234 #endif /* LIBSOLV_INTERNAL */
237 typedef struct _Solver Solver;
243 #define SOLVER_SOLVABLE 0x01
244 #define SOLVER_SOLVABLE_NAME 0x02
245 #define SOLVER_SOLVABLE_PROVIDES 0x03
246 #define SOLVER_SOLVABLE_ONE_OF 0x04
247 #define SOLVER_SOLVABLE_REPO 0x05
248 #define SOLVER_SOLVABLE_ALL 0x06
250 #define SOLVER_SELECTMASK 0xff
252 #define SOLVER_NOOP 0x0000
253 #define SOLVER_INSTALL 0x0100
254 #define SOLVER_ERASE 0x0200
255 #define SOLVER_UPDATE 0x0300
256 #define SOLVER_WEAKENDEPS 0x0400
257 #define SOLVER_NOOBSOLETES 0x0500
258 #define SOLVER_LOCK 0x0600
259 #define SOLVER_DISTUPGRADE 0x0700
260 #define SOLVER_VERIFY 0x0800
261 #define SOLVER_DROP_ORPHANED 0x0900
262 #define SOLVER_USERINSTALLED 0x0a00
264 #define SOLVER_JOBMASK 0xff00
266 #define SOLVER_WEAK 0x010000
267 #define SOLVER_ESSENTIAL 0x020000
268 #define SOLVER_CLEANDEPS 0x040000
269 /* ORUPDATE makes SOLVER_INSTALL not prune to installed
270 * packages, thus updating installed packages */
271 #define SOLVER_ORUPDATE 0x080000
272 /* FORCEBEST makes the solver insist on best packages, so
273 * you will get problem reported if the best package is
274 * not installable. This can be used with INSTALL, UPDATE
276 #define SOLVER_FORCEBEST 0x100000
277 /* TARGETED is used in up/dup jobs to make the solver
278 * treat the specified selection as target packages.
279 * It is automatically assumed if the selection does not
280 * contain an "installed" package unless the
281 * NO_AUTOTARGET solver flag is set */
282 #define SOLVER_TARGETED 0x200000
284 #define SOLVER_SETEV 0x01000000
285 #define SOLVER_SETEVR 0x02000000
286 #define SOLVER_SETARCH 0x04000000
287 #define SOLVER_SETVENDOR 0x08000000
288 #define SOLVER_SETREPO 0x10000000
289 #define SOLVER_NOAUTOSET 0x20000000
290 #define SOLVER_SETNAME 0x40000000
292 #define SOLVER_SETMASK 0x7f000000
294 #define SOLVER_REASON_UNRELATED 0
295 #define SOLVER_REASON_UNIT_RULE 1
296 #define SOLVER_REASON_KEEP_INSTALLED 2
297 #define SOLVER_REASON_RESOLVE_JOB 3
298 #define SOLVER_REASON_UPDATE_INSTALLED 4
299 #define SOLVER_REASON_CLEANDEPS_ERASE 5
300 #define SOLVER_REASON_RESOLVE 6
301 #define SOLVER_REASON_WEAKDEP 7
302 #define SOLVER_REASON_RESOLVE_ORPHAN 8
304 #define SOLVER_REASON_RECOMMENDED 16
305 #define SOLVER_REASON_SUPPLEMENTED 17
308 #define SOLVER_FLAG_ALLOW_DOWNGRADE 1
309 #define SOLVER_FLAG_ALLOW_ARCHCHANGE 2
310 #define SOLVER_FLAG_ALLOW_VENDORCHANGE 3
311 #define SOLVER_FLAG_ALLOW_UNINSTALL 4
312 #define SOLVER_FLAG_NO_UPDATEPROVIDE 5
313 #define SOLVER_FLAG_SPLITPROVIDES 6
314 #define SOLVER_FLAG_IGNORE_RECOMMENDED 7
315 #define SOLVER_FLAG_ADD_ALREADY_RECOMMENDED 8
316 #define SOLVER_FLAG_NO_INFARCHCHECK 9
317 #define SOLVER_FLAG_ALLOW_NAMECHANGE 10
318 #define SOLVER_FLAG_KEEP_EXPLICIT_OBSOLETES 11
319 #define SOLVER_FLAG_BEST_OBEY_POLICY 12
320 #define SOLVER_FLAG_NO_AUTOTARGET 13
322 extern Solver *solver_create(Pool *pool);
323 extern void solver_free(Solver *solv);
324 extern int solver_solve(Solver *solv, Queue *job);
325 extern Transaction *solver_create_transaction(Solver *solv);
326 extern int solver_set_flag(Solver *solv, int flag, int value);
327 extern int solver_get_flag(Solver *solv, int flag);
329 extern int solver_get_decisionlevel(Solver *solv, Id p);
330 extern void solver_get_decisionqueue(Solver *solv, Queue *decisionq);
331 extern int solver_get_lastdecisionblocklevel(Solver *solv);
332 extern void solver_get_decisionblock(Solver *solv, int level, Queue *decisionq);
334 extern void solver_get_orphaned(Solver *solv, Queue *orphanedq);
335 extern void solver_get_recommendations(Solver *solv, Queue *recommendationsq, Queue *suggestionsq, int noselected);
336 extern void solver_get_unneeded(Solver *solv, Queue *unneededq, int filtered);
338 extern int solver_describe_decision(Solver *solv, Id p, Id *infop);
339 extern void solver_describe_weakdep_decision(Solver *solv, Id p, Queue *whyq);
342 extern void solver_calculate_noobsmap(Pool *pool, Queue *job, Map *noobsmap);
343 extern void solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap);
345 /* XXX: why is this not static? */
346 Id *solver_create_decisions_obsoletesmap(Solver *solv);
348 void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
349 int solver_calc_installsizechange(Solver *solv);
350 void solver_trivial_installable(Solver *solv, Queue *pkgs, Queue *res);
352 void pool_job2solvables(Pool *pool, Queue *pkgs, Id how, Id what);
353 int pool_isemptyupdatejob(Pool *pool, Id how, Id what);
355 /* iterate over all literals of a rule */
356 #define FOR_RULELITERALS(l, pp, r) \
357 for (pp = r->d < 0 ? -r->d - 1 : r->d, \
358 l = r->p; l; l = (pp <= 0 ? (pp-- ? 0 : r->w2) : \
359 pool->whatprovidesdata[pp++]))
364 /* XXX: this currently doesn't work correctly for SOLVER_SOLVABLE_REPO and
365 SOLVER_SOLVABLE_ALL */
367 /* iterate over all packages selected by a job */
368 #define FOR_JOB_SELECT(p, pp, select, what) \
369 if (select == SOLVER_SOLVABLE_REPO || select == SOLVER_SOLVABLE_ALL) \
371 else for (pp = (select == SOLVER_SOLVABLE ? 0 : \
372 select == SOLVER_SOLVABLE_ONE_OF ? what : \
373 pool_whatprovides(pool, what)), \
374 p = (select == SOLVER_SOLVABLE ? what : pool->whatprovidesdata[pp++]); \
375 p ; p = pool->whatprovidesdata[pp++]) \
376 if (select == SOLVER_SOLVABLE_NAME && \
377 pool_match_nevr(pool, pool->solvables + p, what) == 0) \
385 #endif /* LIBSOLV_SOLVER_H */