4a2089d8b89f30085c25249fbaffdb53d3bddf00
[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 implicitobsoleteusescolors;       /* true: implicit obsoletes check arch color */
132   int noinstalledobsoletes;     /* true: ignore obsoletes of installed packages */
133   int forbidselfconflicts;      /* true: packages which conflict with itself are not installable */
134   int noobsoletesmultiversion;  /* true: obsoletes are ignored for multiversion installs */
135
136   Id noarchid;                  /* ARCH_NOARCH, ARCH_ALL, ARCH_ANY, ... */
137
138   /* hash for rel unification */
139   Hashtable relhashtbl;         /* hashtable: (name,evr,op)Hash -> Id */
140   Hashval relhashmask;
141
142   Id *languagecache;
143   int languagecacheother;
144
145   /* our tmp space string space */
146   struct _Pool_tmpspace tmpspace;
147
148   char *errstr;                 /* last error string */
149   int errstra;                  /* allocated space for errstr */
150
151   char *rootdir;
152
153   int (*custom_vendorcheck)(struct _Pool *, Solvable *, Solvable *);
154
155   int addfileprovidesfiltered;  /* 1: only use filtered file list for addfileprovides */
156   int addedfileprovides;        /* true: application called addfileprovides */
157   Queue lazywhatprovidesq;      /* queue to store old whatprovides offsets */
158   int nowhatprovidesaux;        /* don't allocate and use the whatprovides aux helper */
159   Offset *whatprovidesaux;
160   Offset whatprovidesauxoff;
161   Id *whatprovidesauxdata;
162   Offset whatprovidesauxdataoff;
163
164 #endif
165 };
166
167 #define DISTTYPE_RPM    0
168 #define DISTTYPE_DEB    1
169 #define DISTTYPE_ARCH   2
170 #define DISTTYPE_HAIKU  3
171
172 #define SOLV_FATAL                      (1<<0)
173 #define SOLV_ERROR                      (1<<1)
174 #define SOLV_WARN                       (1<<2)
175 #define SOLV_DEBUG_STATS                (1<<3)
176 #define SOLV_DEBUG_RULE_CREATION        (1<<4)
177 #define SOLV_DEBUG_PROPAGATE            (1<<5)
178 #define SOLV_DEBUG_ANALYZE              (1<<6)
179 #define SOLV_DEBUG_UNSOLVABLE           (1<<7)
180 #define SOLV_DEBUG_SOLUTIONS            (1<<8)
181 #define SOLV_DEBUG_POLICY               (1<<9)
182 #define SOLV_DEBUG_RESULT               (1<<10)
183 #define SOLV_DEBUG_JOB                  (1<<11)
184 #define SOLV_DEBUG_SOLVER               (1<<12)
185 #define SOLV_DEBUG_TRANSACTION          (1<<13)
186
187 #define SOLV_DEBUG_TO_STDERR            (1<<30)
188
189 #define POOL_FLAG_PROMOTEEPOCH                          1
190 #define POOL_FLAG_FORBIDSELFCONFLICTS                   2
191 #define POOL_FLAG_OBSOLETEUSESPROVIDES                  3
192 #define POOL_FLAG_IMPLICITOBSOLETEUSESPROVIDES          4
193 #define POOL_FLAG_OBSOLETEUSESCOLORS                    5
194 #define POOL_FLAG_NOINSTALLEDOBSOLETES                  6
195 #define POOL_FLAG_HAVEDISTEPOCH                         7
196 #define POOL_FLAG_NOOBSOLETESMULTIVERSION               8
197 #define POOL_FLAG_ADDFILEPROVIDESFILTERED               9
198 #define POOL_FLAG_IMPLICITOBSOLETEUSESCOLORS            10
199 #define POOL_FLAG_NOWHATPROVIDESAUX                     11
200
201 /* ----------------------------------------------- */
202
203
204 /* mark dependencies with relation by setting bit31 */
205
206 #define MAKERELDEP(id) ((id) | 0x80000000)
207 #define ISRELDEP(id) (((id) & 0x80000000) != 0)
208 #define GETRELID(id) ((id) ^ 0x80000000)                                /* returns Id */
209 #define GETRELDEP(pool, id) ((pool)->rels + ((id) ^ 0x80000000))        /* returns Reldep* */
210
211 #define REL_GT          1
212 #define REL_EQ          2
213 #define REL_LT          4
214
215 #define REL_AND         16
216 #define REL_OR          17
217 #define REL_WITH        18
218 #define REL_NAMESPACE   19
219 #define REL_ARCH        20
220 #define REL_FILECONFLICT        21
221 #define REL_COND        22
222 #define REL_COMPAT      23
223 #define REL_KIND        24      /* for filters only */
224 #define REL_MULTIARCH   25      /* debian multiarch annotation */
225 #define REL_ELSE        26      /* only as evr part of REL_COND */
226
227 #if !defined(__GNUC__) && !defined(__attribute__)
228 # define __attribute__(x)
229 #endif
230
231 extern Pool *pool_create(void);
232 extern void pool_free(Pool *pool);
233 extern void pool_freeallrepos(Pool *pool, int reuseids);
234
235 extern void pool_setdebuglevel(Pool *pool, int level);
236 extern int  pool_setdisttype(Pool *pool, int disttype);
237 extern int  pool_set_flag(Pool *pool, int flag, int value);
238 extern int  pool_get_flag(Pool *pool, int flag);
239
240 extern void pool_debug(Pool *pool, int type, const char *format, ...) __attribute__((format(printf, 3, 4)));
241 extern void pool_setdebugcallback(Pool *pool, void (*debugcallback)(struct _Pool *, void *data, int type, const char *str), void *debugcallbackdata);
242 extern void pool_setdebugmask(Pool *pool, int mask);
243 extern void pool_setloadcallback(Pool *pool, int (*cb)(struct _Pool *, struct _Repodata *, void *), void *loadcbdata);
244 extern void pool_setnamespacecallback(Pool *pool, Id (*cb)(struct _Pool *, void *, Id, Id), void *nscbdata);
245 extern void pool_flush_namespaceproviders(Pool *pool, Id ns, Id evr);
246
247 extern void pool_set_custom_vendorcheck(Pool *pool, int (*vendorcheck)(struct _Pool *, Solvable *, Solvable *));
248
249
250 extern char *pool_alloctmpspace(Pool *pool, int len);
251 extern void  pool_freetmpspace(Pool *pool, const char *space);
252 extern char *pool_tmpjoin(Pool *pool, const char *str1, const char *str2, const char *str3);
253 extern char *pool_tmpappend(Pool *pool, const char *str1, const char *str2, const char *str3);
254 extern const char *pool_bin2hex(Pool *pool, const unsigned char *buf, int len);
255
256 extern void pool_set_installed(Pool *pool, struct _Repo *repo);
257
258 extern int  pool_error(Pool *pool, int ret, const char *format, ...) __attribute__((format(printf, 3, 4)));
259 extern char *pool_errstr(Pool *pool);
260
261 extern void pool_set_rootdir(Pool *pool, const char *rootdir);
262 extern const char *pool_get_rootdir(Pool *pool);
263 extern char *pool_prepend_rootdir(Pool *pool, const char *dir);
264 extern const char *pool_prepend_rootdir_tmp(Pool *pool, const char *dir);
265
266 /**
267  * Solvable management
268  */
269 extern Id pool_add_solvable(Pool *pool);
270 extern Id pool_add_solvable_block(Pool *pool, int count);
271
272 extern void pool_free_solvable_block(Pool *pool, Id start, int count, int reuseids);
273 static inline Solvable *pool_id2solvable(const Pool *pool, Id p)
274 {
275   return pool->solvables + p;
276 }
277
278 extern const char *pool_solvable2str(Pool *pool, Solvable *s);
279 static inline const char *pool_solvid2str(Pool *pool, Id p)
280 {
281   return pool_solvable2str(pool, pool->solvables + p);
282 }
283
284 void pool_set_languages(Pool *pool, const char **languages, int nlanguages);
285 Id pool_id2langid(Pool *pool, Id id, const char *lang, int create);
286
287 int solvable_trivial_installable_map(Solvable *s, Map *installedmap, Map *conflictsmap, Map *multiversionmap);
288 int solvable_trivial_installable_repo(Solvable *s, struct _Repo *installed, Map *multiversionmap);
289 int solvable_trivial_installable_queue(Solvable *s, Queue *installed, Map *multiversionmap);
290 int solvable_is_irrelevant_patch(Solvable *s, Map *installedmap);
291
292 void pool_create_state_maps(Pool *pool, Queue *installed, Map *installedmap, Map *conflictsmap);
293
294 int pool_intersect_evrs(Pool *pool, int pflags, Id pevr, int flags, int evr);
295 int pool_match_dep(Pool *pool, Id d1, Id d2);
296
297 /* semi private, used in pool_match_nevr */
298 int pool_match_nevr_rel(Pool *pool, Solvable *s, Id d);
299
300 static inline int pool_match_nevr(Pool *pool, Solvable *s, Id d)
301 {
302   if (!ISRELDEP(d))
303     return d == s->name;
304   else
305     return pool_match_nevr_rel(pool, s, d);
306 }
307
308
309 /**
310  * Prepares a pool for solving
311  */
312 extern void pool_createwhatprovides(Pool *pool);
313 extern void pool_addfileprovides(Pool *pool);
314 extern void pool_addfileprovides_queue(Pool *pool, Queue *idq, Queue *idqinst);
315 extern void pool_freewhatprovides(Pool *pool);
316 extern Id pool_queuetowhatprovides(Pool *pool, Queue *q);
317 extern Id pool_ids2whatprovides(Pool *pool, Id *ids, int count);
318 extern Id pool_searchlazywhatprovidesq(Pool *pool, Id d);
319
320 extern Id pool_addrelproviders(Pool *pool, Id d);
321
322 static inline Id pool_whatprovides(Pool *pool, Id d)
323 {
324   if (!ISRELDEP(d))
325     {
326       if (pool->whatprovides[d])
327         return pool->whatprovides[d];
328     }
329   else
330     {
331       Id v = GETRELID(d);
332       if (pool->whatprovides_rel[v])
333         return pool->whatprovides_rel[v];
334     }
335   return pool_addrelproviders(pool, d);
336 }
337
338 static inline Id *pool_whatprovides_ptr(Pool *pool, Id d)
339 {
340   Id off = pool_whatprovides(pool, d);
341   return pool->whatprovidesdata + off;
342 }
343
344 void pool_whatmatchesdep(Pool *pool, Id keyname, Id dep, Queue *q, int marker);
345
346 /* search the pool. the following filters are available:
347  *   p     - search just this solvable
348  *   key   - search only this key
349  *   match - key must match this string
350  */
351 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);
352
353 void pool_clear_pos(Pool *pool);
354
355
356 #define DUCHANGES_ONLYADD       1
357
358 typedef struct _DUChanges {
359   const char *path;
360   int kbytes;
361   int files;
362   int flags;
363 } DUChanges;
364
365 void pool_calc_duchanges(Pool *pool, Map *installedmap, DUChanges *mps, int nmps);
366 int pool_calc_installsizechange(Pool *pool, Map *installedmap);
367 void pool_trivial_installable(Pool *pool, Map *installedmap, Queue *pkgs, Queue *res);
368 void pool_trivial_installable_multiversionmap(Pool *pool, Map *installedmap, Queue *pkgs, Queue *res, Map *multiversionmap);
369
370 const char *pool_lookup_str(Pool *pool, Id entry, Id keyname);
371 Id pool_lookup_id(Pool *pool, Id entry, Id keyname);
372 unsigned long long pool_lookup_num(Pool *pool, Id entry, Id keyname, unsigned long long notfound);
373 int pool_lookup_void(Pool *pool, Id entry, Id keyname);
374 const unsigned char *pool_lookup_bin_checksum(Pool *pool, Id entry, Id keyname, Id *typep);
375 int pool_lookup_idarray(Pool *pool, Id entry, Id keyname, Queue *q);
376 const char *pool_lookup_checksum(Pool *pool, Id entry, Id keyname, Id *typep);
377 const char *pool_lookup_deltalocation(Pool *pool, Id entry, unsigned int *medianrp);
378
379 void pool_add_fileconflicts_deps(Pool *pool, Queue *conflicts);
380
381
382
383 /* loop over all providers of d */
384 #define FOR_PROVIDES(v, vp, d)                                          \
385   for (vp = pool_whatprovides(pool, d) ; (v = pool->whatprovidesdata[vp++]) != 0; )
386
387 /* loop over all repositories */
388 #define FOR_REPOS(repoid, r)                                            \
389   for (repoid = 1; repoid < pool->nrepos; repoid++)                     \
390     if ((r = pool->repos[repoid]) == 0)                                 \
391       continue;                                                         \
392     else
393
394 #define FOR_POOL_SOLVABLES(p)                                           \
395   for (p = 2; p < pool->nsolvables; p++)                                \
396     if (pool->solvables[p].repo == 0)                                   \
397       continue;                                                         \
398     else
399
400 #ifdef ENABLE_COMPS
401 #define ISCONDDEP(id) (ISRELDEP(id) && (GETRELDEP(pool, id))->flags == REL_COND)
402 #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)
403 #endif
404
405 #define POOL_DEBUG(type, ...) do {if ((pool->debugmask & (type)) != 0) pool_debug(pool, (type), __VA_ARGS__);} while (0)
406 #define IF_POOLDEBUG(type) if ((pool->debugmask & (type)) != 0)
407
408 #ifdef __cplusplus
409 }
410 #endif
411
412
413 #endif /* LIBSOLV_POOL_H */