added pool to arguments
[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 #include "pooltypes.h"
17 #include "pool.h"
18 #include "repo.h"
19 #include "queue.h"
20 #include "bitmap.h"
21 /*
22  * Callback definitions in order to "overwrite" the policies by an external application.
23  */
24  
25 typedef void  (*BestSolvableCb) (Pool *pool, Queue *canditates);
26 typedef int  (*ArchCheckCb) (Pool *pool, Solvable *solvable1, Solvable *solvable2);
27 typedef int  (*VendorCheckCb) (Pool *pool, Solvable *solvable1, Solvable *solvable2);
28 typedef void (*UpdateCandidateCb) (Pool *pool, Solvable *solvable, Queue *canditates);
29
30
31 /* ----------------------------------------------
32  * Rule
33  *
34  *   providerN(B) == Package Id of package providing tag B
35  *   N = 1, 2, 3, in case of multiple providers
36  *
37  * A requires B : !A | provider1(B) | provider2(B)
38  *
39  * A conflicts B : (!A | !provider1(B)) & (!A | !provider2(B)) ...
40  *
41  * 'not' is encoded as a negative Id
42  * 
43  * Binary rule: p = first literal, d = 0, w2 = second literal, w1 = p
44  */
45
46 typedef struct rule {
47   Id p;                 /* first literal in rule */
48   Id d;                 /* Id offset into 'list of providers terminated by 0' as used by whatprovides; pool->whatprovides + d */
49                         /* in case of binary rules, d == 0, w1 == p, w2 == other literal */
50   Id w1, w2;            /* watches, literals not-yet-decided */
51                                        /* if !w1, disabled */
52                                        /* if !w2, assertion, not rule */
53   Id n1, n2;            /* next rules in linked list, corresponding to w1,w2 */
54 } Rule;
55
56 struct solver;
57
58 typedef struct solver {
59   Pool *pool;
60   Repo *installed;
61   
62   Rule *rules;                          /* all rules */
63   Id nrules;                            /* index of the last rule */
64
65   Id jobrules;                          /* user rules */
66   Id systemrules;                       /* policy rules, e.g. keep packages installed or update. All literals > 0 */
67   Id weakrules;                         /* rules that can be autodisabled */
68   Id learntrules;                       /* learnt rules */
69
70   Id *weaksystemrules;                  /* please try to install (r->d) */
71   Map noupdate;                         /* don't try to update these
72                                            installed solvables */
73
74   Id *watches;                          /* Array of rule offsets
75                                          * watches has nsolvables*2 entries and is addressed from the middle
76                                          * middle-solvable : decision to conflict, offset point to linked-list of rules
77                                          * middle+solvable : decision to install: offset point to linked-list of rules
78                                          */
79
80   Queue ruletojob;
81
82   /* our decisions: */
83   Queue decisionq;
84   Queue decisionq_why;                  /* index of rule, Offset into rules */
85   int directdecisions;                  /* number of decisions with no rule */
86
87   Id *decisionmap;                      /* map for all available solvables, > 0: level of decision when installed, < 0 level of decision when conflict */
88
89   /* learnt rule history */
90   Queue learnt_why;
91   Queue learnt_pool;
92
93   Queue branches;
94   int (*solution_callback)(struct solver *solv, void *data);
95   void *solution_callback_data;
96
97   int propagate_index;
98
99   Queue problems;
100   Queue suggestions;                    /* suggested packages */
101
102   Map recommendsmap;                    /* recommended packages from decisionmap */
103   Map suggestsmap;                      /* suggested packages from decisionmap */
104   int recommends_index;                 /* recommended level */
105
106   Id *obsoletes;                        /* obsoletes for each installed solvable */
107   Id *obsoletes_data;                   /* data area for obsoletes */
108
109   Queue covenantq;                      /* Covenants honored by this solver (generic locks) */
110
111   /*-------------------------------------------------------------------------------------------------------------
112    * Solver configuration
113    *-------------------------------------------------------------------------------------------------------------*/
114
115   int fixsystem;                        /* repair errors in rpm dependency graph */
116   int allowdowngrade;                   /* allow to downgrade installed solvable */
117   int allowarchchange;                  /* allow to change architecture of installed solvables */
118   int allowvendorchange;                /* allow to change vendor of installed solvables */
119   int allowuninstall;                   /* allow removal of installed solvables */
120   int updatesystem;                     /* distupgrade */
121   int allowvirtualconflicts;            /* false: conflicts on package name, true: conflicts on package provides */
122   int noupdateprovide;                  /* true: update packages needs not to provide old package */
123   int dosplitprovides;                  /* true: consider legacy split provides */
124
125   /* Callbacks for defining the bahaviour of the SAT solver */
126
127   /* Finding best candidate
128    *
129    * Callback definition:
130    * void  bestSolvable (Pool *pool, Queue *canditates)
131    *     candidates       : List of canditates which has to be sorted by the function call
132    *     return candidates: Sorted list of the candidates(first is the best).
133    */
134    BestSolvableCb bestSolvableCb;
135
136   /* Checking if two solvables has compatible architectures
137    *
138    * Callback definition:
139    *     int  archCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
140    *     
141    *     return 0 it the two solvables has compatible architectures
142    */
143    ArchCheckCb archCheckCb;
144
145   /* Checking if two solvables has compatible vendors
146    *
147    * Callback definition:
148    *     int  vendorCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
149    *     
150    *     return 0 it the two solvables has compatible architectures
151    */
152    VendorCheckCb vendorCheckCb;
153     
154   /* Evaluate update candidate
155    *
156    * Callback definition:
157    * void pdateCandidateCb (Pool *pool, Solvable *solvable, Queue *canditates)
158    *     solvable   : for which updates should be search
159    *     candidates : List of candidates (This list depends on other
160    *                  restrictions like architecture and vendor policies too)
161    */
162    UpdateCandidateCb   updateCandidateCb;
163     
164   
165 } Solver;
166
167 /*
168  * queue commands
169  */
170
171 typedef enum {
172   SOLVCMD_NULL=0,
173   SOLVER_INSTALL_SOLVABLE,
174   SOLVER_ERASE_SOLVABLE,
175   SOLVER_INSTALL_SOLVABLE_NAME,
176   SOLVER_ERASE_SOLVABLE_NAME,
177   SOLVER_INSTALL_SOLVABLE_PROVIDES,
178   SOLVER_ERASE_SOLVABLE_PROVIDES,
179   SOLVER_INSTALL_SOLVABLE_UPDATE
180 } SolverCmd;
181
182 typedef enum {
183   SOLVER_PROBLEM_UPDATE_RULE,
184   SOLVER_PROBLEM_JOB_RULE,
185   SOLVER_PROBLEM_JOB_NOTHING_PROVIDES_DEP,
186   SOLVER_PROBLEM_NOT_INSTALLABLE,
187   SOLVER_PROBLEM_NOTHING_PROVIDES_DEP,
188   SOLVER_PROBLEM_SAME_NAME,
189   SOLVER_PROBLEM_PACKAGE_CONFLICT,
190   SOLVER_PROBLEM_PACKAGE_OBSOLETES,
191   SOLVER_PROBLEM_DEP_PROVIDERS_NOT_INSTALLABLE
192 } SolverProbleminfo;
193
194
195 extern Solver *solver_create(Pool *pool, Repo *installed);
196 extern void solver_free(Solver *solv);
197 extern void solver_solve(Solver *solv, Queue *job);
198 extern int solver_dep_installed(Solver *solv, Id dep);
199 extern int solver_splitprovides(Solver *solv, Id dep);
200
201 extern Id solver_next_problem(Solver *solv, Id problem);
202 extern Id solver_next_solution(Solver *solv, Id problem, Id solution);
203 extern Id solver_next_solutionelement(Solver *solv, Id problem, Id solution, Id element, Id *p, Id *rp);
204 extern Id solver_findproblemrule(Solver *solv, Id problem);
205 extern SolverProbleminfo solver_problemruleinfo(Solver *solv, Queue *job, Id rid, Id *depp, Id *sourcep, Id *targetp);
206
207 Id *create_obsoletesmap(Solver *solv);
208
209 /* debug functions, do not use */
210 void printdecisions(Solver *solv);
211 void printsolutions(Solver *solv, Queue *job);
212
213
214 static inline int
215 solver_dep_fulfilled(Solver *solv, Id dep)
216 {
217   Pool *pool = solv->pool;
218   Id p, *pp;
219
220   if (ISRELDEP(dep))
221     {
222       Reldep *rd = GETRELDEP(pool, dep);
223       if (rd->flags == REL_AND)
224         {
225           if (!solver_dep_fulfilled(solv, rd->name))
226             return 0;
227           return solver_dep_fulfilled(solv, rd->evr);
228         }
229       if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_SPLITPROVIDES)
230         return solver_splitprovides(solv, rd->evr);
231       if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_INSTALLED)
232         return solver_dep_installed(solv, rd->evr);
233     }
234   FOR_PROVIDES(p, pp, dep)
235     {
236       if (solv->decisionmap[p] > 0)
237         return 1;
238     }
239   return 0;
240 }
241
242 static inline int
243 solver_is_supplementing(Solver *solv, Solvable *s)
244 {
245   Id sup, *supp;
246   if (!s->supplements && !s->freshens)
247     return 0;
248   if (s->supplements)
249     {
250       supp = s->repo->idarraydata + s->supplements;
251       while ((sup = *supp++) != 0)
252         if (solver_dep_fulfilled(solv, sup))
253           break;
254       if (!sup)
255         return 0;
256     }
257   if (s->freshens)
258     {
259       supp = s->repo->idarraydata + s->freshens;
260       while ((sup = *supp++) != 0)
261         if (solver_dep_fulfilled(solv, sup))
262           break;
263       if (!sup)
264         return 0;
265     }
266   return 1;
267 }
268
269 static inline int
270 solver_is_enhancing(Solver *solv, Solvable *s)
271 {
272   Id enh, *enhp;
273   if (!s->enhances)
274     return 0;
275   enhp = s->repo->idarraydata + s->enhances;
276   while ((enh = *enhp++) != 0)
277     if (solver_dep_fulfilled(solv, enh))
278       return 1;
279   return 0;
280 }
281
282 #endif /* SATSOLVER_SOLVER_H */