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
16 #include "pooltypes.h"
21 #include "transaction.h"
30 Pool *pool; /* back pointer to pool */
31 Queue job; /* copy of the job we're solving */
33 int (*solution_callback)(struct s_Solver *solv, void *data);
34 void *solution_callback_data;
36 int pooljobcnt; /* number of pooljob entries in job queue */
38 #ifdef LIBSOLV_INTERNAL
39 Repo *installed; /* copy of pool->installed */
41 /* list of rules, ordered
42 * pkg rules first, then features, updates, jobs, learnt
43 * see start/end offsets below
45 Rule *rules; /* all rules */
46 Id nrules; /* [Offset] index of the last rule */
47 Id lastpkgrule; /* last package rule we added */
49 Queue ruleassertions; /* Queue of all assertion rules */
51 /* start/end offset for rule 'areas' */
53 Id pkgrules_end; /* [Offset] dep rules end */
55 Id featurerules; /* feature rules start/end */
58 Id updaterules; /* policy rules, e.g. keep packages installed or update. All literals > 0 */
61 Id jobrules; /* user rules */
64 Id infarchrules; /* inferior arch rules */
67 Id duprules; /* dist upgrade rules */
70 Id bestrules; /* rules from SOLVER_FORCEBEST */
71 Id bestrules_up; /* update rule part starts here*/
73 Id *bestrules_info; /* < 0 : install rule, > 0 : pkg that needs to be updated */
75 Id yumobsrules; /* rules from yum obsoletes handling */
77 Id *yumobsrules_info; /* the dependency for each rule */
79 Id blackrules; /* rules from blacklisted packages */
82 Id strictrepopriorules; /* rules from strict priority repositories */
83 Id strictrepopriorules_end;
85 Id choicerules; /* choice rules (always weak) */
87 Id *choicerules_info; /* the rule we used to generate the choice rule */
89 Id recommendsrules; /* rules from recommends pkg rules with disfavored literals */
90 Id recommendsrules_end;
91 Id *recommendsrules_info; /* the original pkg rule rule */
93 Id learntrules; /* learnt rules, (end == nrules) */
95 Map noupdate; /* don't try to update these
96 installed solvables */
97 Map multiversion; /* ignore obsoletes for these (multiinstall) */
99 Map updatemap; /* bring these installed packages to the newest version */
100 int updatemap_all; /* bring all packages to the newest version */
102 Map bestupdatemap; /* create best rule for those packages */
103 int bestupdatemap_all; /* bring all packages to the newest version */
105 Map fixmap; /* fix these packages */
106 int fixmap_all; /* fix all packages */
108 Queue weakruleq; /* index into 'rules' for weak ones */
109 Map weakrulemap; /* map rule# to '1' for weak rules, 1..learntrules */
111 Id *watches; /* Array of rule offsets
112 * watches has nsolvables*2 entries and is addressed from the middle
113 * middle-solvable : decision to conflict, offset point to linked-list of rules
114 * middle+solvable : decision to install: offset point to linked-list of rules
117 Queue ruletojob; /* index into job queue: jobs for which a rule exits */
120 Queue decisionq; /* >0:install, <0:remove/conflict */
121 Queue decisionq_why; /* index of rule, Offset into rules */
122 Queue decisionq_reason; /* reason for decision, indexed by level */
124 Id *decisionmap; /* map for all available solvables,
126 * > 0: level of decision when installed,
127 * < 0: level of decision when conflict */
129 /* learnt rule history */
134 int propagate_index; /* index into decisionq for non-propagated decisions */
136 Queue problems; /* list of lists of conflicting rules, < 0 for job rules */
137 Queue solutions; /* refined problem storage space */
139 Queue orphaned; /* orphaned packages (to be removed?) */
141 int stats_learned; /* statistic */
142 int stats_unsolvable; /* statistic */
144 Map recommendsmap; /* recommended packages from decisionmap */
145 Map suggestsmap; /* suggested packages from decisionmap */
146 int recommends_index; /* recommendsmap/suggestsmap is created up to this level */
147 Queue *recommendscplxq;
148 Queue *suggestscplxq;
150 Id *obsoletes; /* obsoletes for each installed solvable */
151 Id *obsoletes_data; /* data area for obsoletes */
152 Id *specialupdaters; /* updaters for packages with a limited update rule */
154 /*-------------------------------------------------------------------------------------------------------------
155 * Solver configuration
156 *-------------------------------------------------------------------------------------------------------------*/
158 int allowdowngrade; /* allow to downgrade installed solvable */
159 int allownamechange; /* allow to change name of installed solvables */
160 int allowarchchange; /* allow to change architecture of installed solvables */
161 int allowvendorchange; /* allow to change vendor of installed solvables */
162 int allowuninstall; /* allow removal of installed solvables */
163 int noupdateprovide; /* true: update packages needs not to provide old package */
164 int needupdateprovide; /* true: update packages must provide old package */
165 int dosplitprovides; /* true: consider legacy split provides */
166 int dontinstallrecommended; /* true: do not install recommended packages */
167 int addalreadyrecommended; /* true: also install recommended packages that were already recommended by the installed packages */
168 int dontshowinstalledrecommended; /* true: do not show recommended packages that are already installed */
170 int noinfarchcheck; /* true: do not forbid inferior architectures */
171 int keepexplicitobsoletes; /* true: honor obsoletes during multiinstall */
172 int bestobeypolicy; /* true: stay in policy with the best rules */
173 int noautotarget; /* true: do not assume targeted for up/dup jobs that contain no installed solvable */
174 int focus_installed; /* true: resolve update rules first */
175 int focus_best; /* true: resolve job dependencies first */
176 int do_yum_obsoletes; /* true: add special yumobs rules */
177 int urpmreorder; /* true: do special urpm package reordering */
178 int strongrecommends; /* true: create weak rules for recommends */
179 int install_also_updates; /* true: do not prune install job rules to installed packages */
180 int only_namespace_recommended; /* true: only install packages recommended by namespace */
181 int strict_repo_priority; /* true: only use packages from highest precedence/priority */
183 int process_orphans; /* true: do special orphan processing */
184 Map dupmap; /* dup to those packages */
185 Map dupinvolvedmap; /* packages involved in dup process */
186 int dupinvolvedmap_all; /* all packages are involved */
187 int dup_allowdowngrade; /* dup mode: allow to downgrade installed solvable */
188 int dup_allownamechange; /* dup mode: allow to change name of installed solvable */
189 int dup_allowarchchange; /* dup mode: allow to change architecture of installed solvables */
190 int dup_allowvendorchange; /* dup mode: allow to change vendor of installed solvables */
192 Map droporphanedmap; /* packages to drop in dup mode */
193 int droporphanedmap_all;
195 Map cleandepsmap; /* try to drop these packages as of cleandeps erases */
197 Queue *ruleinfoq; /* tmp space for solver_ruleinfo() */
199 Queue *cleandeps_updatepkgs; /* packages we update in cleandeps mode */
200 Queue *cleandeps_mistakes; /* mistakes we made */
202 Queue *update_targets; /* update to specific packages */
204 Queue *installsuppdepq; /* deps from the install namespace provides hack */
206 Queue addedmap_deduceq; /* deduce addedmap from pkg rules */
207 Id *instbuddy; /* buddies of installed packages */
208 int keep_orphans; /* how to treat orphans */
209 int break_orphans; /* how to treat orphans */
210 Queue *brokenorphanrules; /* broken rules of orphaned packages */
212 Map allowuninstallmap; /* ok to uninstall those */
213 int allowuninstall_all;
215 Map excludefromweakmap; /* remove them from candidates for supplements and recommends */
217 Id *favormap; /* favor job index, > 0: favored, < 0: disfavored */
218 int havedisfavored; /* do we have disfavored packages? */
220 int installedpos; /* for resolve_installed */
221 int do_extra_reordering; /* reorder for future installed packages */
223 Queue *recommendsruleq; /* pkg rules comming from recommends */
224 #endif /* LIBSOLV_INTERNAL */
227 typedef struct s_Solver Solver;
233 #define SOLVER_SOLVABLE 0x01
234 #define SOLVER_SOLVABLE_NAME 0x02
235 #define SOLVER_SOLVABLE_PROVIDES 0x03
236 #define SOLVER_SOLVABLE_ONE_OF 0x04
237 #define SOLVER_SOLVABLE_REPO 0x05
238 #define SOLVER_SOLVABLE_ALL 0x06
240 #define SOLVER_SELECTMASK 0xff
242 #define SOLVER_NOOP 0x0000
243 #define SOLVER_INSTALL 0x0100
244 #define SOLVER_ERASE 0x0200
245 #define SOLVER_UPDATE 0x0300
246 #define SOLVER_WEAKENDEPS 0x0400
247 #define SOLVER_MULTIVERSION 0x0500
248 #define SOLVER_LOCK 0x0600
249 #define SOLVER_DISTUPGRADE 0x0700
250 #define SOLVER_VERIFY 0x0800
251 #define SOLVER_DROP_ORPHANED 0x0900
252 #define SOLVER_USERINSTALLED 0x0a00
253 #define SOLVER_ALLOWUNINSTALL 0x0b00
254 #define SOLVER_FAVOR 0x0c00
255 #define SOLVER_DISFAVOR 0x0d00
256 #define SOLVER_BLACKLIST 0x0e00
257 #define SOLVER_EXCLUDEFROMWEAK 0x1000
259 #define SOLVER_JOBMASK 0xff00
261 #define SOLVER_WEAK 0x010000
262 #define SOLVER_ESSENTIAL 0x020000
263 #define SOLVER_CLEANDEPS 0x040000
264 /* ORUPDATE makes SOLVER_INSTALL not prune to installed
265 * packages, thus updating installed packages */
266 #define SOLVER_ORUPDATE 0x080000
267 /* FORCEBEST makes the solver insist on best packages, so
268 * you will get problem reported if the best package is
269 * not installable. This can be used with INSTALL, UPDATE
271 #define SOLVER_FORCEBEST 0x100000
272 /* TARGETED is used in up/dup jobs to make the solver
273 * treat the specified selection as target packages.
274 * It is automatically assumed if the selection does not
275 * contain an "installed" package unless the
276 * NO_AUTOTARGET solver flag is set */
277 #define SOLVER_TARGETED 0x200000
278 /* This (SOLVER_INSTALL) job was automatically added
279 * and thus does not the add to the userinstalled packages */
280 #define SOLVER_NOTBYUSER 0x400000
282 #define SOLVER_SETEV 0x01000000
283 #define SOLVER_SETEVR 0x02000000
284 #define SOLVER_SETARCH 0x04000000
285 #define SOLVER_SETVENDOR 0x08000000
286 #define SOLVER_SETREPO 0x10000000
287 #define SOLVER_NOAUTOSET 0x20000000
288 #define SOLVER_SETNAME 0x40000000
290 #define SOLVER_SETMASK 0x7f000000
293 #define SOLVER_NOOBSOLETES SOLVER_MULTIVERSION
295 #define SOLVER_REASON_UNRELATED 0
296 #define SOLVER_REASON_UNIT_RULE 1
297 #define SOLVER_REASON_KEEP_INSTALLED 2
298 #define SOLVER_REASON_RESOLVE_JOB 3
299 #define SOLVER_REASON_UPDATE_INSTALLED 4
300 #define SOLVER_REASON_CLEANDEPS_ERASE 5
301 #define SOLVER_REASON_RESOLVE 6
302 #define SOLVER_REASON_WEAKDEP 7
303 #define SOLVER_REASON_RESOLVE_ORPHAN 8
305 #define SOLVER_REASON_RECOMMENDED 16 /* deprecated */
306 #define SOLVER_REASON_SUPPLEMENTED 17 /* deprecated */
308 #define SOLVER_REASON_UNSOLVABLE 18
309 #define SOLVER_REASON_PREMISE 19
312 #define SOLVER_FLAG_ALLOW_DOWNGRADE 1
313 #define SOLVER_FLAG_ALLOW_ARCHCHANGE 2
314 #define SOLVER_FLAG_ALLOW_VENDORCHANGE 3
315 #define SOLVER_FLAG_ALLOW_UNINSTALL 4
316 #define SOLVER_FLAG_NO_UPDATEPROVIDE 5
317 #define SOLVER_FLAG_SPLITPROVIDES 6
318 #define SOLVER_FLAG_IGNORE_RECOMMENDED 7
319 #define SOLVER_FLAG_ADD_ALREADY_RECOMMENDED 8
320 #define SOLVER_FLAG_NO_INFARCHCHECK 9
321 #define SOLVER_FLAG_ALLOW_NAMECHANGE 10
322 #define SOLVER_FLAG_KEEP_EXPLICIT_OBSOLETES 11
323 #define SOLVER_FLAG_BEST_OBEY_POLICY 12
324 #define SOLVER_FLAG_NO_AUTOTARGET 13
325 #define SOLVER_FLAG_DUP_ALLOW_DOWNGRADE 14
326 #define SOLVER_FLAG_DUP_ALLOW_ARCHCHANGE 15
327 #define SOLVER_FLAG_DUP_ALLOW_VENDORCHANGE 16
328 #define SOLVER_FLAG_DUP_ALLOW_NAMECHANGE 17
329 #define SOLVER_FLAG_KEEP_ORPHANS 18
330 #define SOLVER_FLAG_BREAK_ORPHANS 19
331 #define SOLVER_FLAG_FOCUS_INSTALLED 20
332 #define SOLVER_FLAG_YUM_OBSOLETES 21
333 #define SOLVER_FLAG_NEED_UPDATEPROVIDE 22
334 #define SOLVER_FLAG_URPM_REORDER 23
335 #define SOLVER_FLAG_FOCUS_BEST 24
336 #define SOLVER_FLAG_STRONG_RECOMMENDS 25
337 #define SOLVER_FLAG_INSTALL_ALSO_UPDATES 26
338 #define SOLVER_FLAG_ONLY_NAMESPACE_RECOMMENDED 27
339 #define SOLVER_FLAG_STRICT_REPO_PRIORITY 28
341 #define GET_USERINSTALLED_NAMES (1 << 0) /* package names instead of ids */
342 #define GET_USERINSTALLED_INVERTED (1 << 1) /* autoinstalled */
343 #define GET_USERINSTALLED_NAMEARCH (1 << 2) /* package/arch tuples instead of ids */
345 #define SOLVER_ALTERNATIVE_TYPE_RULE 1
346 #define SOLVER_ALTERNATIVE_TYPE_RECOMMENDS 2
347 #define SOLVER_ALTERNATIVE_TYPE_SUGGESTS 3
349 /* solver_get_decisionlist / solver_get_learnt flags */
350 #define SOLVER_DECISIONLIST_SOLVABLE (1 << 1)
351 #define SOLVER_DECISIONLIST_PROBLEM (1 << 2)
352 #define SOLVER_DECISIONLIST_LEARNTRULE (1 << 3)
353 #define SOLVER_DECISIONLIST_WITHINFO (1 << 8)
354 #define SOLVER_DECISIONLIST_SORTED (1 << 9)
355 #define SOLVER_DECISIONLIST_MERGEDINFO (1 << 10)
357 #define SOLVER_DECISIONLIST_TYPEMASK (0xff)
359 extern Solver *solver_create(Pool *pool);
360 extern void solver_free(Solver *solv);
361 extern int solver_solve(Solver *solv, Queue *job);
362 extern Transaction *solver_create_transaction(Solver *solv);
363 extern int solver_set_flag(Solver *solv, int flag, int value);
364 extern int solver_get_flag(Solver *solv, int flag);
366 extern int solver_get_decisionlevel(Solver *solv, Id p);
367 extern void solver_get_decisionqueue(Solver *solv, Queue *decisionq);
368 extern int solver_get_lastdecisionblocklevel(Solver *solv);
369 extern void solver_get_decisionblock(Solver *solv, int level, Queue *decisionq);
371 extern void solver_get_orphaned(Solver *solv, Queue *orphanedq);
372 extern void solver_get_recommendations(Solver *solv, Queue *recommendationsq, Queue *suggestionsq, int noselected);
373 extern void solver_get_unneeded(Solver *solv, Queue *unneededq, int filtered);
374 extern void solver_get_userinstalled(Solver *solv, Queue *q, int flags);
375 extern void pool_add_userinstalled_jobs(Pool *pool, Queue *q, Queue *job, int flags);
376 extern void solver_get_cleandeps(Solver *solv, Queue *cleandepsq);
378 extern int solver_describe_decision(Solver *solv, Id p, Id *infop);
380 extern void solver_get_decisionlist(Solver *solv, Id p, int flags, Queue *decisionlistq);
381 extern void solver_get_decisionlist_multiple(Solver *solv, Queue *pq, int flags, Queue *decisionlistq);
382 extern void solver_get_learnt(Solver *solv, Id id, int flags, Queue *q);
383 extern void solver_decisionlist_solvables(Solver *solv, Queue *decisionlistq, int pos, Queue *q);
384 extern int solver_decisionlist_merged(Solver *solv, Queue *decisionlistq, int pos);
386 extern int solver_alternatives_count(Solver *solv);
387 extern int solver_get_alternative(Solver *solv, Id alternative, Id *idp, Id *fromp, Id *chosenp, Queue *choices, int *levelp);
388 extern int solver_alternativeinfo(Solver *solv, int type, Id id, Id from, Id *fromp, Id *top, Id *depp);
390 extern void solver_calculate_multiversionmap(Pool *pool, Queue *job, Map *multiversionmap);
391 extern void solver_calculate_noobsmap(Pool *pool, Queue *job, Map *multiversionmap); /* obsolete */
392 extern void solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap);
394 extern void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
395 extern int solver_calc_installsizechange(Solver *solv);
397 extern void pool_job2solvables(Pool *pool, Queue *pkgs, Id how, Id what);
398 extern int pool_isemptyupdatejob(Pool *pool, Id how, Id what);
400 /* decisioninfo merging */
401 extern int solver_calc_decisioninfo_bits(Solver *solv, Id decision, int type, Id from, Id to, Id dep);
402 extern int solver_merge_decisioninfo_bits(Solver *solv, int state1, int type1, Id from1, Id to1, Id dep1, int state2, int type2, Id from2, Id to2, Id dep2);
404 extern const char *solver_select2str(Pool *pool, Id select, Id what);
405 extern const char *pool_job2str(Pool *pool, Id how, Id what, Id flagmask);
406 extern const char *solver_alternative2str(Solver *solv, int type, Id id, Id from);
407 extern const char *solver_reason2str(Solver *solv, int reason);
408 extern const char *solver_decisionreason2str(Solver *solv, Id decision, int reason, Id info);
409 extern const char *solver_decisioninfo2str(Solver *solv, int bits, int type, Id from, Id to, Id dep);
412 /* deprecated, use solver_allweakdepinfos/solver_weakdepinfo instead */
413 extern void solver_describe_weakdep_decision(Solver *solv, Id p, Queue *whyq);
415 /* iterate over all literals of a rule */
416 #define FOR_RULELITERALS(l, pp, r) \
417 for (pp = r->d < 0 ? -r->d - 1 : r->d, \
418 l = r->p; l; l = (pp <= 0 ? (pp-- ? 0 : r->w2) : \
419 pool->whatprovidesdata[pp++]))
424 /* XXX: this currently doesn't work correctly for SOLVER_SOLVABLE_REPO and
425 SOLVER_SOLVABLE_ALL */
427 /* iterate over all packages selected by a job */
428 #define FOR_JOB_SELECT(p, pp, select, what) \
429 if (select == SOLVER_SOLVABLE_REPO || select == SOLVER_SOLVABLE_ALL) \
431 else for (pp = (select == SOLVER_SOLVABLE ? 0 : \
432 select == SOLVER_SOLVABLE_ONE_OF ? what : \
433 pool_whatprovides(pool, what)), \
434 p = (select == SOLVER_SOLVABLE ? what : pool->whatprovidesdata[pp++]); \
435 p ; p = pool->whatprovidesdata[pp++]) \
436 if (select == SOLVER_SOLVABLE_NAME && \
437 pool_match_nevr(pool, pool->solvables + p, what) == 0) \
441 /* weird suse stuff */
442 extern void solver_trivial_installable(Solver *solv, Queue *pkgs, Queue *res);
448 #endif /* LIBSOLV_SOLVER_H */