satsolver  0.17.2
solver.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2007, Novell Inc.
3  *
4  * This program is licensed under the BSD license, read LICENSE.BSD
5  * for further information
6  */
7 
8 /*
9  * solver.h
10  *
11  */
12 
13 #ifndef SATSOLVER_SOLVER_H
14 #define SATSOLVER_SOLVER_H
15 
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19 
20 #include "pooltypes.h"
21 #include "pool.h"
22 #include "repo.h"
23 #include "queue.h"
24 #include "bitmap.h"
25 #include "transaction.h"
26 #include "rules.h"
27 #include "problems.h"
28 
29 /*
30  * Callback definitions in order to "overwrite" the policies by an external application.
31  */
32 
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);
37 
38 
39 struct _Solver;
40 
41 typedef struct _Solver {
42  Pool *pool; /* back pointer to pool */
43  Queue job; /* copy of the job we're solving */
44 
45  Transaction trans; /* calculated transaction */
46 
47  Repo *installed; /* copy of pool->installed */
48 
49  /* list of rules, ordered
50  * rpm rules first, then features, updates, jobs, learnt
51  * see start/end offsets below
52  */
53  Rule *rules; /* all rules */
54  Id nrules; /* [Offset] index of the last rule */
55 
56  Queue ruleassertions; /* Queue of all assertion rules */
57 
58  /* start/end offset for rule 'areas' */
59 
60  Id rpmrules_end; /* [Offset] rpm rules end */
61 
62  Id featurerules; /* feature rules start/end */
63  Id featurerules_end;
64 
65  Id updaterules; /* policy rules, e.g. keep packages installed or update. All literals > 0 */
66  Id updaterules_end;
67 
68  Id jobrules; /* user rules */
69  Id jobrules_end;
70 
71  Id infarchrules; /* inferior arch rules */
72  Id infarchrules_end;
73 
74  Id duprules; /* dist upgrade rules */
75  Id duprules_end;
76 
77  Id choicerules; /* choice rules (always weak) */
78  Id choicerules_end;
79  Id *choicerules_ref;
80 
81  Id learntrules; /* learnt rules, (end == nrules) */
82 
83  Map noupdate; /* don't try to update these
84  installed solvables */
85  Map noobsoletes; /* ignore obsoletes for these (multiinstall) */
86 
87  Map updatemap; /* bring these installed packages to the newest version */
88  int updatemap_all; /* bring all packages to the newest version */
89 
90  Map fixmap; /* fix these packages */
91  int fixmap_all; /* fix all packages */
92 
93  Queue weakruleq; /* index into 'rules' for weak ones */
94  Map weakrulemap; /* map rule# to '1' for weak rules, 1..learntrules */
95 
96  Id *watches; /* Array of rule offsets
97  * watches has nsolvables*2 entries and is addressed from the middle
98  * middle-solvable : decision to conflict, offset point to linked-list of rules
99  * middle+solvable : decision to install: offset point to linked-list of rules
100  */
101 
102  Queue ruletojob; /* index into job queue: jobs for which a rule exits */
103 
104  /* our decisions: */
105  Queue decisionq; /* >0:install, <0:remove/conflict */
106  Queue decisionq_why; /* index of rule, Offset into rules */
107 
108  Id *decisionmap; /* map for all available solvables,
109  * = 0: undecided
110  * > 0: level of decision when installed,
111  * < 0: level of decision when conflict */
112 
113  /* learnt rule history */
114  Queue learnt_why;
115  Queue learnt_pool;
116 
117  Queue branches;
118  int (*solution_callback)(struct _Solver *solv, void *data);
119  void *solution_callback_data;
120 
121  int propagate_index; /* index into decisionq for non-propagated decisions */
122 
123  Queue problems; /* list of lists of conflicting rules, < 0 for job rules */
124  Queue solutions; /* refined problem storage space */
125 
126  Queue recommendations; /* recommended packages */
127  Queue suggestions; /* suggested packages */
128  Queue orphaned; /* orphaned packages */
129 
130  int stats_learned; /* statistic */
131  int stats_unsolvable; /* statistic */
132 
133  Map recommendsmap; /* recommended packages from decisionmap */
134  Map suggestsmap; /* suggested packages from decisionmap */
135  int recommends_index; /* recommendsmap/suggestsmap is created up to this level */
136 
137  Id *obsoletes; /* obsoletes for each installed solvable */
138  Id *obsoletes_data; /* data area for obsoletes */
139  Id *multiversionupdaters; /* updaters for multiversion packages in updatesystem mode */
140 
141  /*-------------------------------------------------------------------------------------------------------------
142  * Solver configuration
143  *-------------------------------------------------------------------------------------------------------------*/
144 
145  int fixsystem; /* repair errors in rpm dependency graph */
146  int allowdowngrade; /* allow to downgrade installed solvable */
147  int allowarchchange; /* allow to change architecture of installed solvables */
148  int allowvendorchange; /* allow to change vendor of installed solvables */
149  int allowuninstall; /* allow removal of installed solvables */
150  int updatesystem; /* update all packages to the newest version */
151  int noupdateprovide; /* true: update packages needs not to provide old package */
152  int dosplitprovides; /* true: consider legacy split provides */
153  int dontinstallrecommended; /* true: do not install recommended packages */
154  int ignorealreadyrecommended; /* true: ignore recommended packages that were already recommended by the installed packages */
155  int dontshowinstalledrecommended; /* true: do not show recommended packages that are already installed */
156 
157  /* distupgrade also needs updatesystem and dosplitprovides */
158  int distupgrade;
159  int distupgrade_removeunsupported;
160 
161  int noinfarchcheck; /* true: do not forbid inferior architectures */
162 
163  /* Callbacks for defining the bahaviour of the SAT solver */
164 
165  /* Finding best candidate
166  *
167  * Callback definition:
168  * void bestSolvable (Pool *pool, Queue *canditates)
169  * candidates : List of canditates which has to be sorted by the function call
170  * return candidates: Sorted list of the candidates(first is the best).
171  */
172  BestSolvableCb bestSolvableCb;
173 
174  /* Checking if two solvables has compatible architectures
175  *
176  * Callback definition:
177  * int archCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
178  *
179  * return 0 it the two solvables has compatible architectures
180  */
181  ArchCheckCb archCheckCb;
182 
183  /* Checking if two solvables has compatible vendors
184  *
185  * Callback definition:
186  * int vendorCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
187  *
188  * return 0 it the two solvables has compatible architectures
189  */
190  VendorCheckCb vendorCheckCb;
191 
192  /* Evaluate update candidate
193  *
194  * Callback definition:
195  * void pdateCandidateCb (Pool *pool, Solvable *solvable, Queue *canditates)
196  * solvable : for which updates should be search
197  * candidates : List of candidates (This list depends on other
198  * restrictions like architecture and vendor policies too)
199  */
200  UpdateCandidateCb updateCandidateCb;
201 
202 
203  /* some strange queue that doesn't belong here */
204  Queue covenantq; /* Covenants honored by this solver (generic locks) */
205 
206 
207  Map dupmap; /* dup these packages*/
208  int dupmap_all; /* dup all packages */
209  Map dupinvolvedmap; /* packages involved in dup process */
210 
211  Map droporphanedmap; /* packages to drop in dup mode */
212  int droporphanedmap_all;
213 
214  Map cleandepsmap; /* try to drop these packages as of cleandeps erases */
215 
216  Queue *ruleinfoq; /* tmp space for solver_ruleinfo() */
217 } Solver;
218 
219 /*
220  * queue commands
221  */
222 
223 #define SOLVER_SOLVABLE 0x01
224 #define SOLVER_SOLVABLE_NAME 0x02
225 #define SOLVER_SOLVABLE_PROVIDES 0x03
226 #define SOLVER_SOLVABLE_ONE_OF 0x04
227 #define SOLVER_SOLVABLE_REPO 0x05
228 #define SOLVER_SOLVABLE_ALL 0x06
229 
230 #define SOLVER_SELECTMASK 0xff
231 
232 #define SOLVER_NOOP 0x0000
233 #define SOLVER_INSTALL 0x0100
234 #define SOLVER_ERASE 0x0200
235 #define SOLVER_UPDATE 0x0300
236 #define SOLVER_WEAKENDEPS 0x0400
237 #define SOLVER_NOOBSOLETES 0x0500
238 #define SOLVER_LOCK 0x0600
239 #define SOLVER_DISTUPGRADE 0x0700
240 #define SOLVER_VERIFY 0x0800
241 #define SOLVER_DROP_ORPHANED 0x0900
242 #define SOLVER_USERINSTALLED 0x0a00
243 
244 #define SOLVER_JOBMASK 0xff00
245 
246 #define SOLVER_WEAK 0x010000
247 #define SOLVER_ESSENTIAL 0x020000
248 #define SOLVER_CLEANDEPS 0x040000
249 
250 #define SOLVER_SETEV 0x01000000
251 #define SOLVER_SETEVR 0x02000000
252 #define SOLVER_SETARCH 0x04000000
253 #define SOLVER_SETVENDOR 0x08000000
254 #define SOLVER_SETREPO 0x10000000
255 #define SOLVER_NOAUTOSET 0x20000000
256 
257 #define SOLVER_SETMASK 0x2f000000
258 
259 /* old API compatibility, do not use in new code */
260 #if 1
261 #define SOLVER_INSTALL_SOLVABLE (SOLVER_INSTALL|SOLVER_SOLVABLE)
262 #define SOLVER_ERASE_SOLVABLE (SOLVER_ERASE|SOLVER_SOLVABLE)
263 #define SOLVER_INSTALL_SOLVABLE_NAME (SOLVER_INSTALL|SOLVER_SOLVABLE_NAME)
264 #define SOLVER_ERASE_SOLVABLE_NAME (SOLVER_ERASE|SOLVER_SOLVABLE_NAME)
265 #define SOLVER_INSTALL_SOLVABLE_PROVIDES (SOLVER_INSTALL|SOLVER_SOLVABLE_PROVIDES)
266 #define SOLVER_ERASE_SOLVABLE_PROVIDES (SOLVER_ERASE|SOLVER_SOLVABLE_PROVIDES)
267 #define SOLVER_INSTALL_SOLVABLE_UPDATE (SOLVER_UPDATE|SOLVER_SOLVABLE)
268 #define SOLVER_INSTALL_SOLVABLE_ONE_OF (SOLVER_INSTALL|SOLVER_SOLVABLE_ONE_OF)
269 #define SOLVER_WEAKEN_SOLVABLE_DEPS (SOLVER_WEAKENDEPS|SOLVER_SOLVABLE)
270 #define SOLVER_NOOBSOLETES_SOLVABLE (SOLVER_NOOBSOLETES|SOLVER_SOLVABLE)
271 #define SOLVER_NOOBSOLETES_SOLVABLE_NAME (SOLVER_NOOBSOLETES|SOLVER_SOLVABLE_NAME)
272 #define SOLVER_NOOBSOLETES_SOLVABLE_PROVIDES (SOLVER_NOOBSOLETES|SOLVER_SOLVABLE_PROVIDES)
273 #endif
274 
275 /* backward compatibility */
276 #define SOLVER_PROBLEM_UPDATE_RULE SOLVER_RULE_UPDATE
277 #define SOLVER_PROBLEM_JOB_RULE SOLVER_RULE_JOB
278 #define SOLVER_PROBLEM_JOB_NOTHING_PROVIDES_DEP SOLVER_RULE_JOB_NOTHING_PROVIDES_DEP
279 #define SOLVER_PROBLEM_NOT_INSTALLABLE SOLVER_RULE_RPM_NOT_INSTALLABLE
280 #define SOLVER_PROBLEM_NOTHING_PROVIDES_DEP SOLVER_RULE_RPM_NOTHING_PROVIDES_DEP
281 #define SOLVER_PROBLEM_SAME_NAME SOLVER_RULE_RPM_SAME_NAME
282 #define SOLVER_PROBLEM_PACKAGE_CONFLICT SOLVER_RULE_RPM_PACKAGE_CONFLICT
283 #define SOLVER_PROBLEM_PACKAGE_OBSOLETES SOLVER_RULE_RPM_PACKAGE_OBSOLETES
284 #define SOLVER_PROBLEM_DEP_PROVIDERS_NOT_INSTALLABLE SOLVER_RULE_RPM_PACKAGE_REQUIRES
285 #define SOLVER_PROBLEM_SELF_CONFLICT SOLVER_RULE_RPM_SELF_CONFLICT
286 #define SOLVER_PROBLEM_RPM_RULE SOLVER_RULE_RPM
287 #define SOLVER_PROBLEM_DISTUPGRADE_RULE SOLVER_RULE_DISTUPGRADE
288 #define SOLVER_PROBLEM_INFARCH_RULE SOLVER_RULE_INFARCH
289 
290 
291 extern Solver *solver_create(Pool *pool);
292 extern void solver_free(Solver *solv);
293 extern void solver_solve(Solver *solv, Queue *job);
294 
295 extern void solver_run_sat(Solver *solv, int disablerules, int doweak);
296 extern void solver_reset(Solver *solv);
297 
298 extern int solver_dep_installed(Solver *solv, Id dep);
299 extern int solver_splitprovides(Solver *solv, Id dep);
300 
301 extern void solver_calculate_noobsmap(Pool *pool, Queue *job, Map *noobsmap);
302 
303 /* obsolete */
304 extern SolverRuleinfo solver_problemruleinfo(Solver *solv, Queue *job, Id rid, Id *depp, Id *sourcep, Id *targetp);
305 
306 /* XXX: why is this not static? */
307 Id *solver_create_decisions_obsoletesmap(Solver *solv);
308 
309 static inline int
310 solver_dep_fulfilled(Solver *solv, Id dep)
311 {
312  Pool *pool = solv->pool;
313  Id p, pp;
314 
315  if (ISRELDEP(dep))
316  {
317  Reldep *rd = GETRELDEP(pool, dep);
318  if (rd->flags == REL_AND)
319  {
320  if (!solver_dep_fulfilled(solv, rd->name))
321  return 0;
322  return solver_dep_fulfilled(solv, rd->evr);
323  }
324  if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_SPLITPROVIDES)
325  return solver_splitprovides(solv, rd->evr);
326  if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_INSTALLED)
327  return solver_dep_installed(solv, rd->evr);
328  }
329  FOR_PROVIDES(p, pp, dep)
330  {
331  if (solv->decisionmap[p] > 0)
332  return 1;
333  }
334  return 0;
335 }
336 
337 static inline int
338 solver_is_supplementing(Solver *solv, Solvable *s)
339 {
340  Id sup, *supp;
341  if (!s->supplements)
342  return 0;
343  supp = s->repo->idarraydata + s->supplements;
344  while ((sup = *supp++) != 0)
345  if (solver_dep_fulfilled(solv, sup))
346  return 1;
347  return 0;
348 }
349 
350 static inline int
351 solver_is_enhancing(Solver *solv, Solvable *s)
352 {
353  Id enh, *enhp;
354  if (!s->enhances)
355  return 0;
356  enhp = s->repo->idarraydata + s->enhances;
357  while ((enh = *enhp++) != 0)
358  if (solver_dep_fulfilled(solv, enh))
359  return 1;
360  return 0;
361 }
362 
363 void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
364 int solver_calc_installsizechange(Solver *solv);
365 void solver_trivial_installable(Solver *solv, Queue *pkgs, Queue *res);
366 
367 void solver_find_involved(Solver *solv, Queue *installedq, Solvable *s, Queue *q);
368 
369 static inline void
370 solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap)
371 {
372  pool_create_state_maps(solv->pool, &solv->decisionq, installedmap, conflictsmap);
373 }
374 
375 /* iterate over all literals of a rule */
376 /* WARNING: loop body must not relocate whatprovidesdata, e.g. by
377  * looking up the providers of a dependency */
378 #define FOR_RULELITERALS(l, dp, r) \
379  for (l = r->d < 0 ? -r->d - 1 : r->d, \
380  dp = !l ? &r->w2 : pool->whatprovidesdata + l, \
381  l = r->p; l; l = (dp != &r->w2 + 1 ? *dp++ : 0))
382 
383 /* iterate over all packages selected by a job */
384 #define FOR_JOB_SELECT(p, pp, select, what) \
385  if (select == SOLVER_SOLVABLE_REPO || select == SOLVER_SOLVABLE_ALL) \
386  p = pp = 0; \
387  else for (pp = (select == SOLVER_SOLVABLE ? 0 : \
388  select == SOLVER_SOLVABLE_ONE_OF ? what : \
389  pool_whatprovides(pool, what)), \
390  p = (select == SOLVER_SOLVABLE ? what : pool->whatprovidesdata[pp++]) ; p ; p = pool->whatprovidesdata[pp++]) \
391  if (select != SOLVER_SOLVABLE_NAME || pool_match_nevr(pool, pool->solvables + p, what))
392 
393 #ifdef __cplusplus
394 }
395 #endif
396 
397 #endif /* SATSOLVER_SOLVER_H */
Generated by   doxygen 1.8.4