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