add pool_lookup_idarray for completeness
[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 #include <stdio.h>
17
18 #include "solvversion.h"
19 #include "pooltypes.h"
20 #include "poolid.h"
21 #include "solvable.h"
22 #include "bitmap.h"
23 #include "queue.h"
24 #include "strpool.h"
25
26 /* well known ids */
27 #include "knownid.h"
28
29 #ifdef __cplusplus
30 extern "C" {
31 #endif
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
69   struct _Repo **repos;
70   int nrepos;                   /* repos allocated */
71   int urepos;                   /* repos in use */
72
73   struct _Repo *installed;      /* packages considered installed */
74
75   Solvable *solvables;
76   int nsolvables;               /* solvables allocated */
77
78   const char **languages;
79   int nlanguages;
80
81   /* package manager type, deb/rpm */
82   int disttype;
83
84   Id *id2arch;                  /* map arch ids to scores */
85   unsigned char *id2color;      /* map arch ids to colors */
86   Id lastarch;                  /* last valid entry in id2arch/id2color */
87
88   Queue vendormap;              /* map vendor to vendorclasses mask */
89   const char **vendorclasses;   /* vendor equivalence classes */
90
91   /* providers data, as two-step indirect list
92    * whatprovides[Id] -> Offset into whatprovidesdata for name
93    * whatprovidesdata[Offset] -> 0-terminated list of solvables providing Id
94    */
95   Offset *whatprovides;         /* Offset to providers of a specific name, Id -> Offset  */
96   Offset *whatprovides_rel;     /* Offset to providers of a specific relation, Id -> Offset  */
97
98   Id *whatprovidesdata;         /* Ids of solvable providing Id */
99   Offset whatprovidesdataoff;   /* next free slot within whatprovidesdata */
100   int whatprovidesdataleft;     /* number of 'free slots' within whatprovidesdata */
101
102   /* If nonzero, then consider only the solvables with Ids set in this
103      bitmap for solving.  If zero, consider all solvables.  */
104   Map *considered;
105
106   /* callback for REL_NAMESPACE dependencies handled by the application  */
107   Id (*nscallback)(struct _Pool *, void *data, Id name, Id evr);
108   void *nscallbackdata;
109
110   /* debug mask and callback */
111   int  debugmask;
112   void (*debugcallback)(struct _Pool *, void *data, int type, const char *str);
113   void *debugcallbackdata;
114
115   /* load callback */
116   int (*loadcallback)(struct _Pool *, struct _Repodata *, void *);
117   void *loadcallbackdata;
118
119   /* search position */
120   Datapos pos;
121
122   Queue pooljobs;               /* fixed jobs, like USERINSTALLED/MULTIVERSION */
123
124 #ifdef LIBSOLV_INTERNAL
125   /* flags to tell the library how the installed package manager works */
126   int promoteepoch;             /* true: missing epoch is replaced by epoch of dependency   */
127   int havedistepoch;            /* true: thr release part in the evr may contain a distepoch suffix */
128   int obsoleteusesprovides;     /* true: obsoletes are matched against provides, not names */
129   int implicitobsoleteusesprovides;     /* true: implicit obsoletes due to same name are matched against provides, not names */
130   int obsoleteusescolors;       /* true: obsoletes check arch color */
131   int noinstalledobsoletes;     /* true: ignore obsoletes of installed packages */
132   int forbidselfconflicts;      /* true: packages which conflict with itself are not installable */
133   int noobsoletesmultiversion;  /* true: obsoletes are ignored for multiversion installs */
134
135   Id noarchid;                  /* ARCH_NOARCH, ARCH_ALL, ARCH_ANY, ... */
136
137   /* hash for rel unification */
138   Hashtable relhashtbl;         /* hashtable: (name,evr,op)Hash -> Id */
139   Hashval relhashmask;
140
141   Id *languagecache;
142   int languagecacheother;
143
144   /* our tmp space string space */
145   struct _Pool_tmpspace tmpspace;
146
147   char *errstr;                 /* last error string */
148   int errstra;                  /* allocated space for errstr */
149
150   char *rootdir;
151
152   int (*custom_vendorcheck)(struct _Pool *, Solvable *, Solvable *);
153 #endif
154 };
155
156 #define DISTTYPE_RPM    0
157 #define DISTTYPE_DEB    1
158 #define DISTTYPE_ARCH   2
159 #define DISTTYPE_HAIKU  3
160
161 #define SOLV_FATAL                      (1<<0)
162 #define SOLV_ERROR                      (1<<1)
163 #define SOLV_WARN                       (1<<2)
164 #define SOLV_DEBUG_STATS                (1<<3)
165 #define SOLV_DEBUG_RULE_CREATION        (1<<4)
166 #define SOLV_DEBUG_PROPAGATE            (1<<5)
167 #define SOLV_DEBUG_ANALYZE              (1<<6)
168 #define SOLV_DEBUG_UNSOLVABLE           (1<<7)
169 #define SOLV_DEBUG_SOLUTIONS            (1<<8)
170 #define SOLV_DEBUG_POLICY               (1<<9)
171 #define SOLV_DEBUG_RESULT               (1<<10)
172 #define SOLV_DEBUG_JOB                  (1<<11)
173 #define SOLV_DEBUG_SOLVER               (1<<12)
174 #define SOLV_DEBUG_TRANSACTION          (1<<13)
175
176 #define SOLV_DEBUG_TO_STDERR            (1<<30)
177
178 #define POOL_FLAG_PROMOTEEPOCH                          1
179 #define POOL_FLAG_FORBIDSELFCONFLICTS                   2
180 #define POOL_FLAG_OBSOLETEUSESPROVIDES                  3
181 #define POOL_FLAG_IMPLICITOBSOLETEUSESPROVIDES          4
182 #define POOL_FLAG_OBSOLETEUSESCOLORS                    5
183 #define POOL_FLAG_NOINSTALLEDOBSOLETES                  6
184 #define POOL_FLAG_HAVEDISTEPOCH                         7
185 #define POOL_FLAG_NOOBSOLETESMULTIVERSION               8
186
187 /* ----------------------------------------------- */
188
189
190 /* mark dependencies with relation by setting bit31 */
191
192 #define MAKERELDEP(id) ((id) | 0x80000000)
193 #define ISRELDEP(id) (((id) & 0x80000000) != 0)
194 #define GETRELID(id) ((id) ^ 0x80000000)                                /* returns Id */
195 #define GETRELDEP(pool, id) ((pool)->rels + ((id) ^ 0x80000000))        /* returns Reldep* */
196
197 #define REL_GT          1
198 #define REL_EQ          2
199 #define REL_LT          4
200
201 #define REL_AND         16
202 #define REL_OR          17
203 #define REL_WITH        18
204 #define REL_NAMESPACE   19
205 #define REL_ARCH        20
206 #define REL_FILECONFLICT        21
207 #define REL_COND        22
208 #define REL_COMPAT      23
209
210 #if !defined(__GNUC__) && !defined(__attribute__)
211 # define __attribute__(x)
212 #endif
213
214 extern Pool *pool_create(void);
215 extern void pool_free(Pool *pool);
216 extern void pool_freeallrepos(Pool *pool, int reuseids);
217
218 extern void pool_setdebuglevel(Pool *pool, int level);
219 #ifdef MULTI_SEMANTICS
220 extern void pool_setdisttype(Pool *pool, int disttype);
221 #endif
222 extern int  pool_set_flag(Pool *pool, int flag, int value);
223 extern int  pool_get_flag(Pool *pool, int flag);
224 extern void pool_setvendorclasses(Pool *pool, const char **vendorclasses);
225
226 extern void pool_debug(Pool *pool, int type, const char *format, ...) __attribute__((format(printf, 3, 4)));
227 extern void pool_setdebugcallback(Pool *pool, void (*debugcallback)(struct _Pool *, void *data, int type, const char *str), void *debugcallbackdata);
228 extern void pool_setdebugmask(Pool *pool, int mask);
229 extern void pool_setloadcallback(Pool *pool, int (*cb)(struct _Pool *, struct _Repodata *, void *), void *loadcbdata);
230 extern void pool_setnamespacecallback(Pool *pool, Id (*cb)(struct _Pool *, void *, Id, Id), void *nscbdata);
231 extern void pool_flush_namespaceproviders(Pool *pool, Id ns, Id evr);
232
233 extern void pool_set_custom_vendorcheck(Pool *pool, int (*vendorcheck)(struct _Pool *, Solvable *, Solvable *));
234
235
236 extern char *pool_alloctmpspace(Pool *pool, int len);
237 extern void  pool_freetmpspace(Pool *pool, const char *space);
238 extern char *pool_tmpjoin(Pool *pool, const char *str1, const char *str2, const char *str3);
239 extern char *pool_tmpappend(Pool *pool, const char *str1, const char *str2, const char *str3);
240 extern const char *pool_bin2hex(Pool *pool, const unsigned char *buf, int len);
241
242 extern void pool_set_installed(Pool *pool, struct _Repo *repo);
243
244 extern int  pool_error(Pool *pool, int ret, const char *format, ...) __attribute__((format(printf, 3, 4)));
245 extern char *pool_errstr(Pool *pool);
246
247 extern void pool_set_rootdir(Pool *pool, const char *rootdir);
248 extern const char *pool_get_rootdir(Pool *pool);
249 extern char *pool_prepend_rootdir(Pool *pool, const char *dir);
250 extern const char *pool_prepend_rootdir_tmp(Pool *pool, const char *dir);
251
252 /**
253  * Solvable management
254  */
255 extern Id pool_add_solvable(Pool *pool);
256 extern Id pool_add_solvable_block(Pool *pool, int count);
257
258 extern void pool_free_solvable_block(Pool *pool, Id start, int count, int reuseids);
259 static inline Solvable *pool_id2solvable(const Pool *pool, Id p)
260 {
261   return pool->solvables + p;
262 }
263
264 extern const char *pool_solvable2str(Pool *pool, Solvable *s);
265 static inline const char *pool_solvid2str(Pool *pool, Id p)
266 {
267   return pool_solvable2str(pool, pool->solvables + p);
268 }
269
270 void pool_set_languages(Pool *pool, const char **languages, int nlanguages);
271 Id pool_id2langid(Pool *pool, Id id, const char *lang, int create);
272
273 int solvable_trivial_installable_map(Solvable *s, Map *installedmap, Map *conflictsmap, Map *multiversionmap);
274 int solvable_trivial_installable_repo(Solvable *s, struct _Repo *installed, Map *multiversionmap);
275 int solvable_trivial_installable_queue(Solvable *s, Queue *installed, Map *multiversionmap);
276 int solvable_is_irrelevant_patch(Solvable *s, Map *installedmap);
277
278 void pool_create_state_maps(Pool *pool, Queue *installed, Map *installedmap, Map *conflictsmap);
279
280 int pool_match_nevr_rel(Pool *pool, Solvable *s, Id d);
281 int pool_match_dep(Pool *pool, Id d1, Id d2);
282
283 static inline int pool_match_nevr(Pool *pool, Solvable *s, Id d)
284 {
285   if (!ISRELDEP(d))
286     return d == s->name;
287   else
288     return pool_match_nevr_rel(pool, s, d);
289 }
290
291
292 /**
293  * Prepares a pool for solving
294  */
295 extern void pool_createwhatprovides(Pool *pool);
296 extern void pool_addfileprovides(Pool *pool);
297 extern void pool_addfileprovides_queue(Pool *pool, Queue *idq, Queue *idqinst);
298 extern void pool_freewhatprovides(Pool *pool);
299 extern Id pool_queuetowhatprovides(Pool *pool, Queue *q);
300
301 extern Id pool_addrelproviders(Pool *pool, Id d);
302
303 static inline Id pool_whatprovides(Pool *pool, Id d)
304 {
305   Id v;
306   if (!ISRELDEP(d))
307     return pool->whatprovides[d];
308   v = GETRELID(d);
309   if (pool->whatprovides_rel[v])
310     return pool->whatprovides_rel[v];
311   return pool_addrelproviders(pool, d);
312 }
313
314 static inline Id *pool_whatprovides_ptr(Pool *pool, Id d)
315 {
316   Id off = pool_whatprovides(pool, d);
317   return pool->whatprovidesdata + off;
318 }
319
320 /* search the pool. the following filters are available:
321  *   p     - search just this solvable
322  *   key   - search only this key
323  *   match - key must match this string
324  */
325 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);
326
327 void pool_clear_pos(Pool *pool);
328
329
330 typedef struct _DUChanges {
331   const char *path;
332   int kbytes;
333   int files;
334 } DUChanges;
335
336 void pool_calc_duchanges(Pool *pool, Map *installedmap, DUChanges *mps, int nmps);
337 int pool_calc_installsizechange(Pool *pool, Map *installedmap);
338 void pool_trivial_installable(Pool *pool, Map *installedmap, Queue *pkgs, Queue *res);
339 void pool_trivial_installable_multiversionmap(Pool *pool, Map *installedmap, Queue *pkgs, Queue *res, Map *multiversionmap);
340
341 const char *pool_lookup_str(Pool *pool, Id entry, Id keyname);
342 Id pool_lookup_id(Pool *pool, Id entry, Id keyname);
343 unsigned long long pool_lookup_num(Pool *pool, Id entry, Id keyname, unsigned long long notfound);
344 int pool_lookup_void(Pool *pool, Id entry, Id keyname);
345 const unsigned char *pool_lookup_bin_checksum(Pool *pool, Id entry, Id keyname, Id *typep);
346 int pool_lookup_idarray(Pool *pool, Id entry, Id keyname, Queue *q);
347 const char *pool_lookup_checksum(Pool *pool, Id entry, Id keyname, Id *typep);
348 const char *pool_lookup_deltalocation(Pool *pool, Id entry, unsigned int *medianrp);
349
350 void pool_add_fileconflicts_deps(Pool *pool, Queue *conflicts);
351
352
353
354 /* loop over all providers of d */
355 #define FOR_PROVIDES(v, vp, d)                                          \
356   for (vp = pool_whatprovides(pool, d) ; (v = pool->whatprovidesdata[vp++]) != 0; )
357
358 /* loop over all repositories */
359 #define FOR_REPOS(repoid, r)                                            \
360   for (repoid = 1; repoid < pool->nrepos; repoid++)                     \
361     if ((r = pool->repos[repoid]) == 0)                                 \
362       continue;                                                         \
363     else
364
365 #define FOR_POOL_SOLVABLES(p)                                           \
366   for (p = 2; p < pool->nsolvables; p++)                                \
367     if (pool->solvables[p].repo == 0)                                   \
368       continue;                                                         \
369     else
370
371 #ifdef ENABLE_COMPS
372 #define ISCONDDEP(id) (ISRELDEP(id) && (GETRELDEP(pool, id))->flags == REL_COND)
373 #define MODIFYCONDDEP(id, tst) do { Reldep *condrd = GETRELDEP(pool, id); Id condp, condpp; FOR_PROVIDES(condrd->evr, condp, condpp) if (tst) break; id = condp ? condrd->name : 0;} while(0)
374 #endif
375
376 #define POOL_DEBUG(type, ...) do {if ((pool->debugmask & (type)) != 0) pool_debug(pool, (type), __VA_ARGS__);} while (0)
377 #define IF_POOLDEBUG(type) if ((pool->debugmask & (type)) != 0)
378
379 #ifdef __cplusplus
380 }
381 #endif
382
383
384 #endif /* LIBSOLV_POOL_H */