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 choicerules; /* choice rules (always weak) */
84 Id *choicerules_info; /* the rule we used to generate the choice rule */
86 Id recommendsrules; /* rules from recommends pkg rules with disfavored literals */
87 Id recommendsrules_end;
88 Id *recommendsrules_info; /* the original pkg rule rule */
90 Id learntrules; /* learnt rules, (end == nrules) */
92 Map noupdate; /* don't try to update these
93 installed solvables */
94 Map multiversion; /* ignore obsoletes for these (multiinstall) */
96 Map updatemap; /* bring these installed packages to the newest version */
97 int updatemap_all; /* bring all packages to the newest version */
99 Map bestupdatemap; /* create best rule for those packages */
100 int bestupdatemap_all; /* bring all packages to the newest version */
102 Map fixmap; /* fix these packages */
103 int fixmap_all; /* fix all packages */
105 Queue weakruleq; /* index into 'rules' for weak ones */
106 Map weakrulemap; /* map rule# to '1' for weak rules, 1..learntrules */
108 Id *watches; /* Array of rule offsets
109 * watches has nsolvables*2 entries and is addressed from the middle
110 * middle-solvable : decision to conflict, offset point to linked-list of rules
111 * middle+solvable : decision to install: offset point to linked-list of rules
114 Queue ruletojob; /* index into job queue: jobs for which a rule exits */
117 Queue decisionq; /* >0:install, <0:remove/conflict */
118 Queue decisionq_why; /* index of rule, Offset into rules */
119 Queue decisionq_reason; /* reason for decision, indexed by level */
121 Id *decisionmap; /* map for all available solvables,
123 * > 0: level of decision when installed,
124 * < 0: level of decision when conflict */
126 /* learnt rule history */
131 int propagate_index; /* index into decisionq for non-propagated decisions */
133 Queue problems; /* list of lists of conflicting rules, < 0 for job rules */
134 Queue solutions; /* refined problem storage space */
136 Queue orphaned; /* orphaned packages (to be removed?) */
138 int stats_learned; /* statistic */
139 int stats_unsolvable; /* statistic */
141 Map recommendsmap; /* recommended packages from decisionmap */
142 Map suggestsmap; /* suggested packages from decisionmap */
143 int recommends_index; /* recommendsmap/suggestsmap is created up to this level */
144 Queue *recommendscplxq;
145 Queue *suggestscplxq;
147 Id *obsoletes; /* obsoletes for each installed solvable */
148 Id *obsoletes_data; /* data area for obsoletes */
149 Id *specialupdaters; /* updaters for packages with a limited update rule */
151 /*-------------------------------------------------------------------------------------------------------------
152 * Solver configuration
153 *-------------------------------------------------------------------------------------------------------------*/
155 int allowdowngrade; /* allow to downgrade installed solvable */
156 int allownamechange; /* allow to change name of installed solvables */
157 int allowarchchange; /* allow to change architecture of installed solvables */
158 int allowvendorchange; /* allow to change vendor of installed solvables */
159 int allowuninstall; /* allow removal of installed solvables */
160 int noupdateprovide; /* true: update packages needs not to provide old package */
161 int needupdateprovide; /* true: update packages must provide old package */
162 int dosplitprovides; /* true: consider legacy split provides */
163 int dontinstallrecommended; /* true: do not install recommended packages */
164 int addalreadyrecommended; /* true: also install recommended packages that were already recommended by the installed packages */
165 int dontshowinstalledrecommended; /* true: do not show recommended packages that are already installed */
167 int noinfarchcheck; /* true: do not forbid inferior architectures */
168 int keepexplicitobsoletes; /* true: honor obsoletes during multiinstall */
169 int bestobeypolicy; /* true: stay in policy with the best rules */
170 int noautotarget; /* true: do not assume targeted for up/dup jobs that contain no installed solvable */
171 int focus_installed; /* true: resolve update rules first */
172 int focus_best; /* true: resolve job dependencies first */
173 int do_yum_obsoletes; /* true: add special yumobs rules */
174 int urpmreorder; /* true: do special urpm package reordering */
175 int strongrecommends; /* true: create weak rules for recommends */
176 int install_also_updates; /* true: do not prune install job rules to installed packages */
177 int only_namespace_recommended; /* true: only install packages recommended by namespace */
179 int process_orphans; /* true: do special orphan processing */
180 Map dupmap; /* dup to those packages */
181 Map dupinvolvedmap; /* packages involved in dup process */
182 int dupinvolvedmap_all; /* all packages are involved */
183 int dup_allowdowngrade; /* dup mode: allow to downgrade installed solvable */
184 int dup_allownamechange; /* dup mode: allow to change name of installed solvable */
185 int dup_allowarchchange; /* dup mode: allow to change architecture of installed solvables */
186 int dup_allowvendorchange; /* dup mode: allow to change vendor of installed solvables */
188 Map droporphanedmap; /* packages to drop in dup mode */
189 int droporphanedmap_all;
191 Map cleandepsmap; /* try to drop these packages as of cleandeps erases */
193 Queue *ruleinfoq; /* tmp space for solver_ruleinfo() */
195 Queue *cleandeps_updatepkgs; /* packages we update in cleandeps mode */
196 Queue *cleandeps_mistakes; /* mistakes we made */
198 Queue *update_targets; /* update to specific packages */
200 Queue *installsuppdepq; /* deps from the install namespace provides hack */
202 Queue addedmap_deduceq; /* deduce addedmap from pkg rules */
203 Id *instbuddy; /* buddies of installed packages */
204 int keep_orphans; /* how to treat orphans */
205 int break_orphans; /* how to treat orphans */
206 Queue *brokenorphanrules; /* broken rules of orphaned packages */
208 Map allowuninstallmap; /* ok to uninstall those */
209 int allowuninstall_all;
211 Map excludefromweakmap; /* remove them from candidates for supplements and recommends */
213 Id *favormap; /* favor job index, > 0: favored, < 0: disfavored */
214 int havedisfavored; /* do we have disfavored packages? */
216 int installedpos; /* for resolve_installed */
217 int do_extra_reordering; /* reorder for future installed packages */
219 Queue *recommendsruleq; /* pkg rules comming from recommends */
220 #endif /* LIBSOLV_INTERNAL */
223 typedef struct s_Solver Solver;
229 #define SOLVER_SOLVABLE 0x01
230 #define SOLVER_SOLVABLE_NAME 0x02
231 #define SOLVER_SOLVABLE_PROVIDES 0x03
232 #define SOLVER_SOLVABLE_ONE_OF 0x04
233 #define SOLVER_SOLVABLE_REPO 0x05
234 #define SOLVER_SOLVABLE_ALL 0x06
236 #define SOLVER_SELECTMASK 0xff
238 #define SOLVER_NOOP 0x0000
239 #define SOLVER_INSTALL 0x0100
240 #define SOLVER_ERASE 0x0200
241 #define SOLVER_UPDATE 0x0300
242 #define SOLVER_WEAKENDEPS 0x0400
243 #define SOLVER_MULTIVERSION 0x0500
244 #define SOLVER_LOCK 0x0600
245 #define SOLVER_DISTUPGRADE 0x0700
246 #define SOLVER_VERIFY 0x0800
247 #define SOLVER_DROP_ORPHANED 0x0900
248 #define SOLVER_USERINSTALLED 0x0a00
249 #define SOLVER_ALLOWUNINSTALL 0x0b00
250 #define SOLVER_FAVOR 0x0c00
251 #define SOLVER_DISFAVOR 0x0d00
252 #define SOLVER_BLACKLIST 0x0e00
253 #define SOLVER_EXCLUDEFROMWEAK 0x1000
255 #define SOLVER_JOBMASK 0xff00
257 #define SOLVER_WEAK 0x010000
258 #define SOLVER_ESSENTIAL 0x020000
259 #define SOLVER_CLEANDEPS 0x040000
260 /* ORUPDATE makes SOLVER_INSTALL not prune to installed
261 * packages, thus updating installed packages */
262 #define SOLVER_ORUPDATE 0x080000
263 /* FORCEBEST makes the solver insist on best packages, so
264 * you will get problem reported if the best package is
265 * not installable. This can be used with INSTALL, UPDATE
267 #define SOLVER_FORCEBEST 0x100000
268 /* TARGETED is used in up/dup jobs to make the solver
269 * treat the specified selection as target packages.
270 * It is automatically assumed if the selection does not
271 * contain an "installed" package unless the
272 * NO_AUTOTARGET solver flag is set */
273 #define SOLVER_TARGETED 0x200000
274 /* This (SOLVER_INSTALL) job was automatically added
275 * and thus does not the add to the userinstalled packages */
276 #define SOLVER_NOTBYUSER 0x400000
278 #define SOLVER_SETEV 0x01000000
279 #define SOLVER_SETEVR 0x02000000
280 #define SOLVER_SETARCH 0x04000000
281 #define SOLVER_SETVENDOR 0x08000000
282 #define SOLVER_SETREPO 0x10000000
283 #define SOLVER_NOAUTOSET 0x20000000
284 #define SOLVER_SETNAME 0x40000000
286 #define SOLVER_SETMASK 0x7f000000
289 #define SOLVER_NOOBSOLETES SOLVER_MULTIVERSION
291 #define SOLVER_REASON_UNRELATED 0
292 #define SOLVER_REASON_UNIT_RULE 1
293 #define SOLVER_REASON_KEEP_INSTALLED 2
294 #define SOLVER_REASON_RESOLVE_JOB 3
295 #define SOLVER_REASON_UPDATE_INSTALLED 4
296 #define SOLVER_REASON_CLEANDEPS_ERASE 5
297 #define SOLVER_REASON_RESOLVE 6
298 #define SOLVER_REASON_WEAKDEP 7
299 #define SOLVER_REASON_RESOLVE_ORPHAN 8
301 #define SOLVER_REASON_RECOMMENDED 16
302 #define SOLVER_REASON_SUPPLEMENTED 17
305 #define SOLVER_FLAG_ALLOW_DOWNGRADE 1
306 #define SOLVER_FLAG_ALLOW_ARCHCHANGE 2
307 #define SOLVER_FLAG_ALLOW_VENDORCHANGE 3
308 #define SOLVER_FLAG_ALLOW_UNINSTALL 4
309 #define SOLVER_FLAG_NO_UPDATEPROVIDE 5
310 #define SOLVER_FLAG_SPLITPROVIDES 6
311 #define SOLVER_FLAG_IGNORE_RECOMMENDED 7
312 #define SOLVER_FLAG_ADD_ALREADY_RECOMMENDED 8
313 #define SOLVER_FLAG_NO_INFARCHCHECK 9
314 #define SOLVER_FLAG_ALLOW_NAMECHANGE 10
315 #define SOLVER_FLAG_KEEP_EXPLICIT_OBSOLETES 11
316 #define SOLVER_FLAG_BEST_OBEY_POLICY 12
317 #define SOLVER_FLAG_NO_AUTOTARGET 13
318 #define SOLVER_FLAG_DUP_ALLOW_DOWNGRADE 14
319 #define SOLVER_FLAG_DUP_ALLOW_ARCHCHANGE 15
320 #define SOLVER_FLAG_DUP_ALLOW_VENDORCHANGE 16
321 #define SOLVER_FLAG_DUP_ALLOW_NAMECHANGE 17
322 #define SOLVER_FLAG_KEEP_ORPHANS 18
323 #define SOLVER_FLAG_BREAK_ORPHANS 19
324 #define SOLVER_FLAG_FOCUS_INSTALLED 20
325 #define SOLVER_FLAG_YUM_OBSOLETES 21
326 #define SOLVER_FLAG_NEED_UPDATEPROVIDE 22
327 #define SOLVER_FLAG_URPM_REORDER 23
328 #define SOLVER_FLAG_FOCUS_BEST 24
329 #define SOLVER_FLAG_STRONG_RECOMMENDS 25
330 #define SOLVER_FLAG_INSTALL_ALSO_UPDATES 26
331 #define SOLVER_FLAG_ONLY_NAMESPACE_RECOMMENDED 27
333 #define GET_USERINSTALLED_NAMES (1 << 0) /* package names instead of ids */
334 #define GET_USERINSTALLED_INVERTED (1 << 1) /* autoinstalled */
335 #define GET_USERINSTALLED_NAMEARCH (1 << 2) /* package/arch tuples instead of ids */
337 #define SOLVER_ALTERNATIVE_TYPE_RULE 1
338 #define SOLVER_ALTERNATIVE_TYPE_RECOMMENDS 2
339 #define SOLVER_ALTERNATIVE_TYPE_SUGGESTS 3
341 extern Solver *solver_create(Pool *pool);
342 extern void solver_free(Solver *solv);
343 extern int solver_solve(Solver *solv, Queue *job);
344 extern Transaction *solver_create_transaction(Solver *solv);
345 extern int solver_set_flag(Solver *solv, int flag, int value);
346 extern int solver_get_flag(Solver *solv, int flag);
348 extern int solver_get_decisionlevel(Solver *solv, Id p);
349 extern void solver_get_decisionqueue(Solver *solv, Queue *decisionq);
350 extern int solver_get_lastdecisionblocklevel(Solver *solv);
351 extern void solver_get_decisionblock(Solver *solv, int level, Queue *decisionq);
353 extern void solver_get_orphaned(Solver *solv, Queue *orphanedq);
354 extern void solver_get_recommendations(Solver *solv, Queue *recommendationsq, Queue *suggestionsq, int noselected);
355 extern void solver_get_unneeded(Solver *solv, Queue *unneededq, int filtered);
356 extern void solver_get_userinstalled(Solver *solv, Queue *q, int flags);
357 extern void pool_add_userinstalled_jobs(Pool *pool, Queue *q, Queue *job, int flags);
358 extern void solver_get_cleandeps(Solver *solv, Queue *cleandepsq);
360 extern int solver_describe_decision(Solver *solv, Id p, Id *infop);
361 extern void solver_describe_weakdep_decision(Solver *solv, Id p, Queue *whyq);
363 extern int solver_alternatives_count(Solver *solv);
364 extern int solver_get_alternative(Solver *solv, Id alternative, Id *idp, Id *fromp, Id *chosenp, Queue *choices, int *levelp);
366 extern void solver_calculate_multiversionmap(Pool *pool, Queue *job, Map *multiversionmap);
367 extern void solver_calculate_noobsmap(Pool *pool, Queue *job, Map *multiversionmap); /* obsolete */
368 extern void solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap);
370 extern void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
371 extern int solver_calc_installsizechange(Solver *solv);
373 extern void pool_job2solvables(Pool *pool, Queue *pkgs, Id how, Id what);
374 extern int pool_isemptyupdatejob(Pool *pool, Id how, Id what);
376 extern const char *solver_select2str(Pool *pool, Id select, Id what);
377 extern const char *pool_job2str(Pool *pool, Id how, Id what, Id flagmask);
378 extern const char *solver_alternative2str(Solver *solv, int type, Id id, Id from);
381 /* iterate over all literals of a rule */
382 #define FOR_RULELITERALS(l, pp, r) \
383 for (pp = r->d < 0 ? -r->d - 1 : r->d, \
384 l = r->p; l; l = (pp <= 0 ? (pp-- ? 0 : r->w2) : \
385 pool->whatprovidesdata[pp++]))
390 /* XXX: this currently doesn't work correctly for SOLVER_SOLVABLE_REPO and
391 SOLVER_SOLVABLE_ALL */
393 /* iterate over all packages selected by a job */
394 #define FOR_JOB_SELECT(p, pp, select, what) \
395 if (select == SOLVER_SOLVABLE_REPO || select == SOLVER_SOLVABLE_ALL) \
397 else for (pp = (select == SOLVER_SOLVABLE ? 0 : \
398 select == SOLVER_SOLVABLE_ONE_OF ? what : \
399 pool_whatprovides(pool, what)), \
400 p = (select == SOLVER_SOLVABLE ? what : pool->whatprovidesdata[pp++]); \
401 p ; p = pool->whatprovidesdata[pp++]) \
402 if (select == SOLVER_SOLVABLE_NAME && \
403 pool_match_nevr(pool, pool->solvables + p, what) == 0) \
407 /* weird suse stuff */
408 extern void solver_trivial_installable(Solver *solv, Queue *pkgs, Queue *res);
414 #endif /* LIBSOLV_SOLVER_H */