[backend] more introspection: solver_ruleliterals, solver_rule2jobidx, solver_rule2job
[platform/upstream/libsolv.git] / src / pool.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  * pool.h
10  * 
11  */
12
13 #ifndef LIBSOLV_POOL_H
14 #define LIBSOLV_POOL_H
15
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19
20 #include <stdio.h>
21
22 #include "satversion.h"
23 #include "pooltypes.h"
24 #include "poolid.h"
25 #include "solvable.h"
26 #include "bitmap.h"
27 #include "queue.h"
28 #include "strpool.h"
29
30 /* well known ids */
31 #include "knownid.h"
32
33 /* well known solvable */
34 #define SYSTEMSOLVABLE          1
35
36
37 /* how many strings to maintain (round robin) */
38 #define POOL_TMPSPACEBUF 16
39
40 //-----------------------------------------------
41
42 struct _Repo;
43 struct _Repodata;
44 struct _Repokey;
45 struct _KeyValue;
46
47 typedef struct _Datapos {
48   struct _Repo *repo;
49   Id solvid;
50   Id repodataid;
51   Id schema;
52   Id dp; 
53 } Datapos;
54
55 struct _Pool_tmpspace {
56   char *buf[POOL_TMPSPACEBUF];
57   int   len[POOL_TMPSPACEBUF];
58   int   n;
59 };
60
61 struct _Pool {
62   void *appdata;                /* application private pointer */
63
64   struct _Stringpool ss;
65
66   Reldep *rels;                 /* table of rels: Id -> Reldep */
67   int nrels;                    /* number of unique rels */
68   Hashtable relhashtbl;         /* hashtable: (name,evr,op)Hash -> Id */
69   Hashmask relhashmask;
70
71   struct _Repo **repos;
72   int nrepos;
73
74   struct _Repo *installed;      /* packages considered installed */
75
76   Solvable *solvables;
77   int nsolvables;
78
79   const char **languages;
80   int nlanguages;
81   Id *languagecache;
82   int languagecacheother;
83
84   /* flags to tell the library how the installed rpm works */
85   int promoteepoch;             /* true: missing epoch is replaced by epoch of dependency   */
86   int obsoleteusesprovides;     /* true: obsoletes are matched against provides, not names */
87   int implicitobsoleteusesprovides;     /* true: implicit obsoletes due to same name are matched against provides, not names */
88   int obsoleteusescolors;       /* true: obsoletes check arch color */
89   int noinstalledobsoletes;     /* true: ignore obsoletes of installed packages */
90   int allowselfconflicts;       /* true: packages which conflict with itself are installable */
91
92 #ifdef MULTI_SEMANTICS
93   int disttype;
94 #endif
95
96   Id *id2arch;                  /* map arch ids to scores */
97   unsigned char *id2color;      /* map arch ids to colors */
98   Id lastarch;                  /* last valid entry in id2arch/id2color */
99
100   Queue vendormap;              /* map vendor to vendorclasses mask */
101   const char **vendorclasses;   /* vendor equivalence classes */
102
103   /* providers data, as two-step indirect list
104    * whatprovides[Id] -> Offset into whatprovidesdata for name
105    * whatprovidesdata[Offset] -> ID_NULL-terminated list of solvables providing Id
106    */
107   Offset *whatprovides;         /* Offset to providers of a specific name, Id -> Offset  */
108   Offset *whatprovides_rel;     /* Offset to providers of a specific relation, Id -> Offset  */
109
110   Id *whatprovidesdata;         /* Ids of solvable providing Id */
111   Offset whatprovidesdataoff;   /* next free slot within whatprovidesdata */
112   int whatprovidesdataleft;     /* number of 'free slots' within whatprovidesdata */
113
114   /* If nonzero, then consider only the solvables with Ids set in this
115      bitmap for solving.  If zero, consider all solvables.  */
116   Map *considered;
117
118   Id (*nscallback)(struct _Pool *, void *data, Id name, Id evr);
119   void *nscallbackdata;
120
121   /* our tmp space string space */
122   struct _Pool_tmpspace tmpspace;
123
124   /* debug mask and callback */
125   int  debugmask;
126   void (*debugcallback)(struct _Pool *, void *data, int type, const char *str);
127   void *debugcallbackdata;
128
129   /* load callback */
130   int (*loadcallback)(struct _Pool *, struct _Repodata *, void *);
131   void *loadcallbackdata;
132
133   /* search position */
134   Datapos pos;
135 };
136
137 #ifdef MULTI_SEMANTICS
138 # define DISTTYPE_RPM   0
139 # define DISTTYPE_DEB   1
140 #endif
141
142 #define SAT_FATAL                       (1<<0)
143 #define SAT_ERROR                       (1<<1)
144 #define SAT_WARN                        (1<<2)
145 #define SAT_DEBUG_STATS                 (1<<3)
146 #define SAT_DEBUG_RULE_CREATION         (1<<4)
147 #define SAT_DEBUG_PROPAGATE             (1<<5)
148 #define SAT_DEBUG_ANALYZE               (1<<6)
149 #define SAT_DEBUG_UNSOLVABLE            (1<<7)
150 #define SAT_DEBUG_SOLUTIONS             (1<<8)
151 #define SAT_DEBUG_POLICY                (1<<9)
152 #define SAT_DEBUG_RESULT                (1<<10)
153 #define SAT_DEBUG_JOB                   (1<<11)
154 #define SAT_DEBUG_SOLVER                (1<<12)
155 #define SAT_DEBUG_TRANSACTION           (1<<13)
156
157 #define SAT_DEBUG_TO_STDERR             (1<<30)
158
159 //-----------------------------------------------
160
161
162 /* mark dependencies with relation by setting bit31 */
163
164 #define MAKERELDEP(id) ((id) | 0x80000000)
165 #define ISRELDEP(id) (((id) & 0x80000000) != 0)
166 #define GETRELID(id) ((id) ^ 0x80000000)                                /* returns Id */
167 #define GETRELDEP(pool, id) ((pool)->rels + ((id) ^ 0x80000000))        /* returns Reldep* */
168
169 #define REL_GT          1
170 #define REL_EQ          2
171 #define REL_LT          4
172
173 #define REL_AND         16
174 #define REL_OR          17
175 #define REL_WITH        18
176 #define REL_NAMESPACE   19
177 #define REL_ARCH        20
178 #define REL_FILECONFLICT        21
179
180 #if !defined(__GNUC__) && !defined(__attribute__)
181 # define __attribute__(x)
182 #endif
183
184 /**
185  * Creates a new pool
186  */
187 extern Pool *pool_create(void);
188 /**
189  * Delete a pool
190  */
191 extern void pool_free(Pool *pool);
192
193 extern void pool_setdebuglevel(Pool *pool, int level);
194 #ifdef MULTI_SEMANTICS
195 extern void pool_setdisttype(Pool *pool, int disttype);
196 #endif
197 extern void pool_setvendorclasses(Pool *pool, const char **vendorclasses);
198
199 extern void pool_debug(Pool *pool, int type, const char *format, ...) __attribute__((format(printf, 3, 4)));
200 extern void pool_setdebugcallback(Pool *pool, void (*debugcallback)(struct _Pool *, void *data, int type, const char *str), void *debugcallbackdata);
201 extern void pool_setdebugmask(Pool *pool, int mask);
202 extern void pool_setloadcallback(Pool *pool, int (*cb)(struct _Pool *, struct _Repodata *, void *), void *loadcbdata);
203
204
205 extern char *pool_alloctmpspace(Pool *pool, int len);
206 extern void  pool_freetmpspace(Pool *pool, const char *space);
207 extern char *pool_tmpjoin(Pool *pool, const char *str1, const char *str2, const char *str3);
208 extern char *pool_tmpappend(Pool *pool, const char *str1, const char *str2, const char *str3);
209 extern const char *pool_bin2hex(Pool *pool, const unsigned char *buf, int len);
210
211 extern void pool_set_installed(Pool *pool, struct _Repo *repo);
212
213 /**
214  * Solvable management
215  */
216 extern Id pool_add_solvable(Pool *pool);
217 extern Id pool_add_solvable_block(Pool *pool, int count);
218
219 extern void pool_free_solvable_block(Pool *pool, Id start, int count, int reuseids);
220 static inline Solvable *pool_id2solvable(const Pool *pool, Id p)
221 {
222   return pool->solvables + p;
223 }
224
225 extern const char *pool_solvable2str(Pool *pool, Solvable *s);
226 static inline const char *pool_solvid2str(Pool *pool, Id p)
227 {
228   return pool_solvable2str(pool, pool->solvables + p);
229 }
230
231 void pool_set_languages(Pool *pool, const char **languages, int nlanguages);
232 Id pool_id2langid(Pool *pool, Id id, const char *lang, int create);
233
234 Id solvable_lookup_id(Solvable *s, Id keyname);
235 unsigned int solvable_lookup_num(Solvable *s, Id keyname, unsigned int notfound);
236 const char *solvable_lookup_str(Solvable *s, Id keyname);
237 const char *solvable_lookup_str_poollang(Solvable *s, Id keyname);
238 const char *solvable_lookup_str_lang(Solvable *s, Id keyname, const char *lang, int usebase);
239 int solvable_lookup_bool(Solvable *s, Id keyname);
240 int solvable_lookup_void(Solvable *s, Id keyname);
241 char * solvable_get_location(Solvable *s, unsigned int *medianrp);
242 const unsigned char *solvable_lookup_bin_checksum(Solvable *s, Id keyname, Id *typep);
243 const char *solvable_lookup_checksum(Solvable *s, Id keyname, Id *typep);
244 int solvable_lookup_idarray(Solvable *s, Id keyname, Queue *q);
245 int solvable_identical(Solvable *s1, Solvable *s2);
246 Id solvable_selfprovidedep(Solvable *s);
247
248 int solvable_trivial_installable_map(Solvable *s, Map *installedmap, Map *conflictsmap);
249 int solvable_trivial_installable_repo(Solvable *s, struct _Repo *installed);
250 int solvable_trivial_installable_queue(Solvable *s, Queue *installed);
251
252 void pool_create_state_maps(Pool *pool, Queue *installed, Map *installedmap, Map *conflictsmap);
253
254 int pool_match_nevr_rel(Pool *pool, Solvable *s, Id d);
255 int pool_match_dep(Pool *pool, Id d1, Id d2);
256
257 static inline int pool_match_nevr(Pool *pool, Solvable *s, Id d)
258 {
259   if (!ISRELDEP(d))
260     return d == s->name;
261   else
262     return pool_match_nevr_rel(pool, s, d);
263 }
264
265
266 /**
267  * Prepares a pool for solving
268  */
269 extern void pool_createwhatprovides(Pool *pool);
270 extern void pool_addfileprovides(Pool *pool);
271 extern void pool_addfileprovides_ids(Pool *pool, struct _Repo *installed, Id **idp);
272 extern void pool_freewhatprovides(Pool *pool);
273 extern Id pool_queuetowhatprovides(Pool *pool, Queue *q);
274
275 extern Id pool_addrelproviders(Pool *pool, Id d);
276
277 static inline Id pool_whatprovides(Pool *pool, Id d)
278 {
279   Id v;
280   if (!ISRELDEP(d))
281     return pool->whatprovides[d];
282   v = GETRELID(d);
283   if (pool->whatprovides_rel[v])
284     return pool->whatprovides_rel[v];
285   return pool_addrelproviders(pool, d);
286 }
287
288 static inline Id *pool_whatprovides_ptr(Pool *pool, Id d)
289 {
290   Id off = pool_whatprovides(pool, d);
291   return pool->whatprovidesdata + off;
292 }
293
294 /* search the pool. the following filters are available:
295  *   p     - search just this solvable
296  *   key   - search only this key
297  *   match - key must match this string
298  */
299 void pool_search(Pool *pool, Id p, Id key, const char *match, int flags, int (*callback)(void *cbdata, Solvable *s, struct _Repodata *data, struct _Repokey *key, struct _KeyValue *kv), void *cbdata);
300
301 void pool_clear_pos(Pool *pool);
302
303
304 typedef struct _DUChanges {
305   const char *path;
306   int kbytes;
307   int files;
308 } DUChanges;
309
310 void pool_calc_duchanges(Pool *pool, Map *installedmap, DUChanges *mps, int nmps);
311 int pool_calc_installsizechange(Pool *pool, Map *installedmap);
312 void pool_trivial_installable(Pool *pool, Map *installedmap, Queue *pkgs, Queue *res);
313 void pool_trivial_installable_noobsoletesmap(Pool *pool, Map *installedmap, Queue *pkgs, Queue *res, Map *noobsoletesmap);
314
315 const char *pool_lookup_str(Pool *pool, Id entry, Id keyname);
316 Id pool_lookup_id(Pool *pool, Id entry, Id keyname);
317 unsigned int pool_lookup_num(Pool *pool, Id entry, Id keyname, unsigned int notfound);
318 int pool_lookup_void(Pool *pool, Id entry, Id keyname);
319 const unsigned char *pool_lookup_bin_checksum(Pool *pool, Id entry, Id keyname, Id *typep);
320 const char *pool_lookup_checksum(Pool *pool, Id entry, Id keyname, Id *typep);
321
322 void pool_add_fileconflicts_deps(Pool *pool, Queue *conflicts);
323
324
325
326 /* loop over all providers of d */
327 #define FOR_PROVIDES(v, vp, d)                                          \
328   for (vp = pool_whatprovides(pool, d) ; (v = pool->whatprovidesdata[vp++]) != 0; )
329
330 /* loop over all repositories */
331 /* note that idx is not the repoid */
332 #define FOR_REPOS(idx, r)                                               \
333   for (idx = 0; idx < pool->nrepos; idx++)                              \
334     if ((r = pool->repos[idx]) != 0)
335     
336
337 #define POOL_DEBUG(type, ...) do {if ((pool->debugmask & (type)) != 0) pool_debug(pool, (type), __VA_ARGS__);} while (0)
338 #define IF_POOLDEBUG(type) if ((pool->debugmask & (type)) != 0)
339
340 #ifdef __cplusplus
341 }
342 #endif
343
344
345 #endif /* LIBSOLV_POOL_H */