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