- add lookup_id function
[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 SATSOLVER_POOL_H
14 #define SATSOLVER_POOL_H
15
16 #ifdef __cplusplus
17 extern "C" {
18 #endif
19
20 #include <stdio.h>
21
22 #include "pooltypes.h"
23 #include "poolid.h"
24 #include "solvable.h"
25 #include "bitmap.h"
26 #include "queue.h"
27 #include "strpool.h"
28
29 /* well known ids */
30 #include "knownid.h"
31
32 /* well known solvable */
33 #define SYSTEMSOLVABLE          1
34
35
36 /* how many strings to maintain (round robin) */
37 #define POOL_TMPSPACEBUF 16
38
39 //-----------------------------------------------
40
41 struct _Repo;
42 struct _Repodata;
43 struct _Repokey;
44 struct _KeyValue;
45
46 struct _Pool {
47   struct _Stringpool ss;
48
49   Reldep *rels;               // table of rels: Id -> Reldep
50   int nrels;                  // number of unique rels
51   Hashtable relhashtbl;       // hash table: (name,evr,op ->) Hash -> Id
52   Hashmask relhashmask;
53
54   struct _Repo **repos;
55   int nrepos;
56
57   Solvable *solvables;
58   int nsolvables;
59
60   const char **languages;
61   int nlanguages;
62   Id *languagecache;
63   int languagecacheother;
64
65   int promoteepoch;             /* 0/1  */
66
67   Id *id2arch;                  /* map arch ids to scores */
68   Id lastarch;                  /* last valid entry in id2arch */
69   Queue vendormap;              /* map vendor to vendorclasses mask */
70
71   /* providers data, as two-step indirect list
72    * whatprovides[Id] -> Offset into whatprovidesdata for name
73    * whatprovidesdata[Offset] -> ID_NULL-terminated list of solvables providing Id
74    */
75   Offset *whatprovides;         /* Offset to providers of a specific name, Id -> Offset  */
76   Offset *whatprovides_rel;     /* Offset to providers of a specific relation, Id -> Offset  */
77
78   Id *whatprovidesdata;         /* Ids of solvable providing Id */
79   Offset whatprovidesdataoff;   /* next free slot within whatprovidesdata */
80   int whatprovidesdataleft;     /* number of 'free slots' within whatprovidesdata */
81
82   /* If nonzero, then consider only the solvables with Ids set in this
83      bitmap for solving.  If zero, consider all solvables.  */
84   Map *considered;
85
86   Id (*nscallback)(struct _Pool *, void *data, Id name, Id evr);
87   void *nscallbackdata;
88
89   /* our tmp space string space */
90   char *tmpspacebuf[POOL_TMPSPACEBUF];
91   int   tmpspacelen[POOL_TMPSPACEBUF];
92   int   tmpspacen;
93
94   /* debug mask and callback */
95   int  debugmask;
96   void (*debugcallback)(struct _Pool *, void *data, int type, const char *str);
97   void *debugcallbackdata;
98
99   /* load callback */
100   FILE * (*loadcallback)(struct _Pool *, struct _Repodata *, void *);
101   void *loadcallbackdata;
102 };
103
104 #define SAT_FATAL                       (1<<0)
105 #define SAT_ERROR                       (1<<1)
106 #define SAT_WARN                        (1<<2)
107 #define SAT_DEBUG_STATS                 (1<<3)
108 #define SAT_DEBUG_RULE_CREATION         (1<<4)
109 #define SAT_DEBUG_PROPAGATE             (1<<5)
110 #define SAT_DEBUG_ANALYZE               (1<<6)
111 #define SAT_DEBUG_UNSOLVABLE            (1<<7)
112 #define SAT_DEBUG_SOLUTIONS             (1<<8)
113 #define SAT_DEBUG_POLICY                (1<<9)
114 #define SAT_DEBUG_RESULT                (1<<10)
115 #define SAT_DEBUG_JOB                   (1<<11)
116 #define SAT_DEBUG_SCHUBI                (1<<12)
117
118 //-----------------------------------------------
119
120
121 /* mark dependencies with relation by setting bit31 */
122
123 #define MAKERELDEP(id) ((id) | 0x80000000)
124 #define ISRELDEP(id) (((id) & 0x80000000) != 0)
125 #define GETRELID(id) ((id) ^ 0x80000000)                                /* returns Id */
126 #define GETRELDEP(pool, id) ((pool)->rels + ((id) ^ 0x80000000))        /* returns Reldep* */
127
128 #define REL_GT          1
129 #define REL_EQ          2
130 #define REL_LT          4
131
132 #define REL_AND         16
133 #define REL_OR          17
134 #define REL_WITH        18
135 #define REL_NAMESPACE   19
136
137 #if !defined(__GNUC__) && !defined(__attribute__)
138 # define __attribute__(x)
139 #endif
140
141 /**
142  * Creates a new pool
143  */
144 extern Pool *pool_create(void);
145 /**
146  * Delete a pool
147  */
148 extern void pool_free(Pool *pool);
149
150 extern void pool_debug(Pool *pool, int type, const char *format, ...) __attribute__((format(printf, 3, 4)));
151
152 extern char *pool_alloctmpspace(Pool *pool, int len);
153
154 /**
155  * Solvable management
156  */
157 extern Id pool_add_solvable(Pool *pool);
158 extern Id pool_add_solvable_block(Pool *pool, int count);
159
160 extern void pool_free_solvable_block(Pool *pool, Id start, int count, int reuseids);
161 static inline Solvable *pool_id2solvable(Pool *pool, Id p)
162 {
163   return pool->solvables + p;
164 }
165 extern const char *solvable2str(Pool *pool, Solvable *s);
166
167 void pool_set_languages(Pool *pool, const char **languages, int nlanguages);
168
169 Id solvable_lookup_id(Solvable *s, Id keyname);
170 unsigned int solvable_lookup_num(Solvable *s, Id keyname, unsigned int notfound);
171 const char *solvable_lookup_str(Solvable *s, Id keyname);
172 const char *solvable_lookup_str_poollang(Solvable *s, Id keyname);
173 const char *solvable_lookup_str_lang(Solvable *s, Id keyname, const char *lang);
174 int solvable_lookup_bool(Solvable *s, Id keyname);
175 char * solvable_get_location(Solvable *s, unsigned int *medianrp);
176 const unsigned char *solvable_lookup_bin_checksum(Solvable *s, Id keyname, Id *typep);
177 const char *solvable_lookup_checksum(Solvable *s, Id keyname, Id *typep);
178
179
180
181
182 /**
183  * Prepares a pool for solving
184  */
185 extern void pool_createwhatprovides(Pool *pool);
186 extern void pool_addfileprovides(Pool *pool, struct _Repo *installed);
187 extern void pool_addfileprovides_ids(Pool *pool, struct _Repo *installed, Id **idp);
188 extern void pool_freewhatprovides(Pool *pool);
189 extern Id pool_queuetowhatprovides(Pool *pool, Queue *q);
190
191 static inline int pool_installable(Pool *pool, Solvable *s)
192 {
193   if (!s->arch || s->arch == ARCH_SRC || s->arch == ARCH_NOSRC)
194     return 0;
195   if (pool->id2arch && (s->arch > pool->lastarch || !pool->id2arch[s->arch]))
196     return 0;
197   if (pool->considered)
198     { 
199       Id id = s - pool->solvables;
200       if (!MAPTST(pool->considered, id))
201         return 0;
202     }
203   return 1;
204 }
205
206 extern Id *pool_addrelproviders(Pool *pool, Id d);
207
208 static inline Id *pool_whatprovides(Pool *pool, Id d)
209 {
210   Id v;
211   if (!ISRELDEP(d))
212     return pool->whatprovidesdata + pool->whatprovides[d];
213   v = GETRELID(d);
214   if (pool->whatprovides_rel[v])
215     return pool->whatprovidesdata + pool->whatprovides_rel[v];
216   return pool_addrelproviders(pool, d);
217 }
218
219 extern void pool_setdebuglevel(Pool *pool, int level);
220
221 static inline void pool_setdebugcallback(Pool *pool, void (*debugcallback)(struct _Pool *, void *data, int type, const char *str), void *debugcallbackdata)
222 {
223   pool->debugcallback = debugcallback;
224   pool->debugcallbackdata = debugcallbackdata;
225 }
226
227 static inline void pool_setdebugmask(Pool *pool, int mask)
228 {
229   pool->debugmask = mask;
230 }
231
232 static inline void pool_setloadcallback(Pool *pool, FILE *(*cb)(struct _Pool *, struct _Repodata *, void *), void *loadcbdata)
233 {
234   pool->loadcallback = cb;
235   pool->loadcallbackdata = loadcbdata;
236 }
237
238 /* search the pool. the following filters are available:
239  *   p     - search just this solvable
240  *   key   - search only this key
241  *   match - key must match this string
242  */
243 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);
244
245 typedef struct _duchanges {
246   const char *path;
247   int kbytes;
248   int files;
249 } DUChanges;
250
251 void pool_calc_duchanges(Pool *pool, Queue *pkgs, DUChanges *mps, int nmps);
252 int pool_calc_installsizechange(Pool *pool, Queue *pkgs);
253
254 /* loop over all providers of d */
255 #define FOR_PROVIDES(v, vp, d)                                          \
256   for (vp = pool_whatprovides(pool, d) ; (v = *vp++) != 0; )
257
258 #define POOL_DEBUG(type, ...) do {if ((pool->debugmask & (type)) != 0) pool_debug(pool, (type), __VA_ARGS__);} while (0)
259 #define IF_POOLDEBUG(type) if ((pool->debugmask & (type)) != 0)
260
261 #ifdef __cplusplus
262 }
263 #endif
264
265
266 #endif /* SATSOLVER_POOL_H */