- add appdata application private pointer to Pool/Repo
[platform/upstream/libsolv.git] / src / solver.h
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 learntrules;                       /* learnt rules, (end == nrules) */
78
79   Map noupdate;                         /* don't try to update these
80                                            installed solvables */
81   Map noobsoletes;                      /* ignore obsoletes for these
82                                            (multiinstall) */
83
84   Map updatemap;                        /* bring those packages to the newest version */
85   Queue weakruleq;                      /* index into 'rules' for weak ones */
86   Map weakrulemap;                      /* map rule# to '1' for weak rules, 1..learntrules */
87
88   Id *watches;                          /* Array of rule offsets
89                                          * watches has nsolvables*2 entries and is addressed from the middle
90                                          * middle-solvable : decision to conflict, offset point to linked-list of rules
91                                          * middle+solvable : decision to install: offset point to linked-list of rules
92                                          */
93
94   Queue ruletojob;                      /* index into job queue: jobs for which a rule exits */
95
96   /* our decisions: */
97   Queue decisionq;                      /* >0:install, <0:remove/conflict */
98   Queue decisionq_why;                  /* index of rule, Offset into rules */
99
100   Id *decisionmap;                      /* map for all available solvables,
101                                          * = 0: undecided
102                                          * > 0: level of decision when installed,
103                                          * < 0: level of decision when conflict */
104
105   /* learnt rule history */
106   Queue learnt_why;
107   Queue learnt_pool;
108
109   Queue branches;
110   int (*solution_callback)(struct _Solver *solv, void *data);
111   void *solution_callback_data;
112
113   int propagate_index;                  /* index into decisionq for non-propagated decisions */
114
115   Queue problems;                       /* list of lists of conflicting rules, < 0 for job rules */
116   Queue solutions;                      /* refined problem storage space */
117
118   Queue recommendations;                /* recommended packages */
119   Queue suggestions;                    /* suggested packages */
120   Queue orphaned;                       /* orphaned packages */
121
122   int stats_learned;                    /* statistic */
123   int stats_unsolvable;                 /* statistic */
124
125   Map recommendsmap;                    /* recommended packages from decisionmap */
126   Map suggestsmap;                      /* suggested packages from decisionmap */
127   int recommends_index;                 /* recommendsmap/suggestsmap is created up to this level */
128
129   Id *obsoletes;                        /* obsoletes for each installed solvable */
130   Id *obsoletes_data;                   /* data area for obsoletes */
131   Id *multiversionupdaters;             /* updaters for multiversion packages in updatesystem mode */
132
133   /*-------------------------------------------------------------------------------------------------------------
134    * Solver configuration
135    *-------------------------------------------------------------------------------------------------------------*/
136
137   int fixsystem;                        /* repair errors in rpm dependency graph */
138   int allowdowngrade;                   /* allow to downgrade installed solvable */
139   int allowarchchange;                  /* allow to change architecture of installed solvables */
140   int allowvendorchange;                /* allow to change vendor of installed solvables */
141   int allowuninstall;                   /* allow removal of installed solvables */
142   int updatesystem;                     /* update all packages to the newest version */
143   int noupdateprovide;                  /* true: update packages needs not to provide old package */
144   int dosplitprovides;                  /* true: consider legacy split provides */
145   int dontinstallrecommended;           /* true: do not install recommended packages */
146   int ignorealreadyrecommended;         /* true: ignore recommended packages that were already recommended by the installed packages */
147   int dontshowinstalledrecommended;     /* true: do not show recommended packages that are already installed */
148   
149   /* distupgrade also needs updatesystem and dosplitprovides */
150   int distupgrade;
151   int distupgrade_removeunsupported;
152
153   int noinfarchcheck;                   /* true: do not forbid inferior architectures */
154
155   /* Callbacks for defining the bahaviour of the SAT solver */
156
157   /* Finding best candidate
158    *
159    * Callback definition:
160    * void  bestSolvable (Pool *pool, Queue *canditates)
161    *     candidates       : List of canditates which has to be sorted by the function call
162    *     return candidates: Sorted list of the candidates(first is the best).
163    */
164    BestSolvableCb bestSolvableCb;
165
166   /* Checking if two solvables has compatible architectures
167    *
168    * Callback definition:
169    *     int  archCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
170    *     
171    *     return 0 it the two solvables has compatible architectures
172    */
173    ArchCheckCb archCheckCb;
174
175   /* Checking if two solvables has compatible vendors
176    *
177    * Callback definition:
178    *     int  vendorCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
179    *     
180    *     return 0 it the two solvables has compatible architectures
181    */
182    VendorCheckCb vendorCheckCb;
183     
184   /* Evaluate update candidate
185    *
186    * Callback definition:
187    * void pdateCandidateCb (Pool *pool, Solvable *solvable, Queue *canditates)
188    *     solvable   : for which updates should be search
189    *     candidates : List of candidates (This list depends on other
190    *                  restrictions like architecture and vendor policies too)
191    */
192    UpdateCandidateCb   updateCandidateCb;
193     
194
195   /* some strange queue that doesn't belong here */
196   Queue covenantq;                      /* Covenants honored by this solver (generic locks) */
197
198   
199   Map dupmap;                           /* packages from dup repos */
200   Map dupinvolvedmap;                   /* packages involved in dup process */
201
202   Queue *ruleinfoq;                     /* tmp space for solver_ruleinfo() */
203 } Solver;
204
205 /*
206  * queue commands
207  */
208
209 #define SOLVER_SOLVABLE                 0x01
210 #define SOLVER_SOLVABLE_NAME            0x02
211 #define SOLVER_SOLVABLE_PROVIDES        0x03
212 #define SOLVER_SOLVABLE_ONE_OF          0x04
213
214 #define SOLVER_SELECTMASK               0xff
215
216 #define SOLVER_NOOP                     0x0000
217 #define SOLVER_INSTALL                  0x0100
218 #define SOLVER_ERASE                    0x0200
219 #define SOLVER_UPDATE                   0x0300
220 #define SOLVER_WEAKENDEPS               0x0400
221 #define SOLVER_NOOBSOLETES              0x0500
222 #define SOLVER_LOCK                     0x0600
223 #define SOLVER_DISTUPGRADE              0x0700
224
225 #define SOLVER_JOBMASK                  0xff00
226
227 #define SOLVER_WEAK                     0x010000
228 #define SOLVER_ESSENTIAL                0x020000
229
230 /* old API compatibility, do not use in new code */
231 #if 1
232 #define SOLVER_INSTALL_SOLVABLE (SOLVER_INSTALL|SOLVER_SOLVABLE)
233 #define SOLVER_ERASE_SOLVABLE (SOLVER_ERASE|SOLVER_SOLVABLE)
234 #define SOLVER_INSTALL_SOLVABLE_NAME (SOLVER_INSTALL|SOLVER_SOLVABLE_NAME)
235 #define SOLVER_ERASE_SOLVABLE_NAME (SOLVER_ERASE|SOLVER_SOLVABLE_NAME)
236 #define SOLVER_INSTALL_SOLVABLE_PROVIDES (SOLVER_INSTALL|SOLVER_SOLVABLE_PROVIDES)
237 #define SOLVER_ERASE_SOLVABLE_PROVIDES (SOLVER_ERASE|SOLVER_SOLVABLE_PROVIDES)
238 #define SOLVER_INSTALL_SOLVABLE_UPDATE (SOLVER_UPDATE|SOLVER_SOLVABLE)
239 #define SOLVER_INSTALL_SOLVABLE_ONE_OF (SOLVER_INSTALL|SOLVER_SOLVABLE_ONE_OF)
240 #define SOLVER_WEAKEN_SOLVABLE_DEPS (SOLVER_WEAKENDEPS|SOLVER_SOLVABLE)
241 #define SOLVER_NOOBSOLETES_SOLVABLE (SOLVER_NOOBSOLETES|SOLVER_SOLVABLE)
242 #define SOLVER_NOOBSOLETES_SOLVABLE_NAME (SOLVER_NOOBSOLETES|SOLVER_SOLVABLE_NAME)
243 #define SOLVER_NOOBSOLETES_SOLVABLE_PROVIDES (SOLVER_NOOBSOLETES|SOLVER_SOLVABLE_PROVIDES)
244 #endif
245
246 /* backward compatibility */
247 #define SOLVER_PROBLEM_UPDATE_RULE              SOLVER_RULE_UPDATE
248 #define SOLVER_PROBLEM_JOB_RULE                 SOLVER_RULE_JOB
249 #define SOLVER_PROBLEM_JOB_NOTHING_PROVIDES_DEP SOLVER_RULE_JOB_NOTHING_PROVIDES_DEP
250 #define SOLVER_PROBLEM_NOT_INSTALLABLE          SOLVER_RULE_RPM_NOT_INSTALLABLE
251 #define SOLVER_PROBLEM_NOTHING_PROVIDES_DEP     SOLVER_RULE_RPM_NOTHING_PROVIDES_DEP
252 #define SOLVER_PROBLEM_SAME_NAME                SOLVER_RULE_RPM_SAME_NAME
253 #define SOLVER_PROBLEM_PACKAGE_CONFLICT         SOLVER_RULE_RPM_PACKAGE_CONFLICT
254 #define SOLVER_PROBLEM_PACKAGE_OBSOLETES        SOLVER_RULE_RPM_PACKAGE_OBSOLETES
255 #define SOLVER_PROBLEM_DEP_PROVIDERS_NOT_INSTALLABLE SOLVER_RULE_RPM_PACKAGE_REQUIRES
256 #define SOLVER_PROBLEM_SELF_CONFLICT            SOLVER_RULE_RPM_SELF_CONFLICT
257 #define SOLVER_PROBLEM_RPM_RULE                 SOLVER_RULE_RPM
258 #define SOLVER_PROBLEM_DISTUPGRADE_RULE         SOLVER_RULE_DISTUPGRADE
259 #define SOLVER_PROBLEM_INFARCH_RULE             SOLVER_RULE_INFARCH
260
261
262 extern Solver *solver_create(Pool *pool);
263 extern void solver_free(Solver *solv);
264 extern void solver_solve(Solver *solv, Queue *job);
265
266 extern void solver_run_sat(Solver *solv, int disablerules, int doweak);
267 extern void solver_reset(Solver *solv);
268
269 extern int solver_dep_installed(Solver *solv, Id dep);
270 extern int solver_splitprovides(Solver *solv, Id dep);
271
272 extern void solver_calculate_noobsmap(Pool *pool, Queue *job, Map *noobsmap);
273
274 /* obsolete */
275 extern SolverRuleinfo solver_problemruleinfo(Solver *solv, Queue *job, Id rid, Id *depp, Id *sourcep, Id *targetp);
276
277 /* XXX: why is this not static? */
278 Id *solver_create_decisions_obsoletesmap(Solver *solv);
279
280 static inline int
281 solver_dep_fulfilled(Solver *solv, Id dep)
282 {
283   Pool *pool = solv->pool;
284   Id p, pp;
285
286   if (ISRELDEP(dep))
287     {
288       Reldep *rd = GETRELDEP(pool, dep);
289       if (rd->flags == REL_AND)
290         {
291           if (!solver_dep_fulfilled(solv, rd->name))
292             return 0;
293           return solver_dep_fulfilled(solv, rd->evr);
294         }
295       if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_SPLITPROVIDES)
296         return solver_splitprovides(solv, rd->evr);
297       if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_INSTALLED)
298         return solver_dep_installed(solv, rd->evr);
299     }
300   FOR_PROVIDES(p, pp, dep)
301     {
302       if (solv->decisionmap[p] > 0)
303         return 1;
304     }
305   return 0;
306 }
307
308 static inline int
309 solver_is_supplementing(Solver *solv, Solvable *s)
310 {
311   Id sup, *supp;
312   if (!s->supplements)
313     return 0;
314   supp = s->repo->idarraydata + s->supplements;
315   while ((sup = *supp++) != 0)
316     if (solver_dep_fulfilled(solv, sup))
317       return 1;
318   return 0;
319 }
320
321 static inline int
322 solver_is_enhancing(Solver *solv, Solvable *s)
323 {
324   Id enh, *enhp;
325   if (!s->enhances)
326     return 0;
327   enhp = s->repo->idarraydata + s->enhances;
328   while ((enh = *enhp++) != 0)
329     if (solver_dep_fulfilled(solv, enh))
330       return 1;
331   return 0;
332 }
333
334 void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
335 int solver_calc_installsizechange(Solver *solv);
336 void solver_trivial_installable(Solver *solv, Queue *pkgs, Queue *res);
337
338 void solver_find_involved(Solver *solv, Queue *installedq, Solvable *s, Queue *q);
339
340 static inline void
341 solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap)
342 {
343   pool_create_state_maps(solv->pool, &solv->decisionq, installedmap, conflictsmap);
344 }
345
346 /* iterate over all literals of a rule */
347 /* WARNING: loop body must not relocate whatprovidesdata, e.g. by
348  * looking up the providers of a dependency */
349 #define FOR_RULELITERALS(l, dp, r)                              \
350     for (l = r->d < 0 ? -r->d - 1 : r->d,                       \
351          dp = !l ? &r->w2 : pool->whatprovidesdata + l,         \
352          l = r->p; l; l = (dp != &r->w2 + 1 ? *dp++ : 0))
353
354 /* iterate over all packages selected by a job */
355 #define FOR_JOB_SELECT(p, pp, select, what) \
356     for (pp = (select == SOLVER_SOLVABLE ? 0 :  \
357                select == SOLVER_SOLVABLE_ONE_OF ? what : \
358                pool_whatprovides(pool, what)),                          \
359          p = (select == SOLVER_SOLVABLE ? what : pool->whatprovidesdata[pp++]) ; p ; p = pool->whatprovidesdata[pp++]) \
360       if (select != SOLVER_SOLVABLE_NAME || pool_match_nevr(pool, pool->solvables + p, what))
361
362 #ifdef __cplusplus
363 }
364 #endif
365
366 #endif /* SATSOLVER_SOLVER_H */