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 "pooltypes.h"
  21 #include "poolid.h"
  22 #include "solvable.h"
  23 #include "queue.h"
  24 #include "strpool.h"
  25
  26 // see initpool_data[] in pool.c
  27
  28 /* well known ids */
  29 #define ID_NULL                 STRID_NULL
  30 #define ID_EMPTY                STRID_EMPTY
  31 #define SOLVABLE_NAME           2
  32 #define SOLVABLE_ARCH           3
  33 #define SOLVABLE_EVR            4
  34 #define SOLVABLE_VENDOR         5
  35 #define SOLVABLE_PROVIDES       6
  36 #define SOLVABLE_OBSOLETES      7
  37 #define SOLVABLE_CONFLICTS      8
  38 #define SOLVABLE_REQUIRES       9
  39 #define SOLVABLE_RECOMMENDS     10
  40 #define SOLVABLE_SUGGESTS       11
  41 #define SOLVABLE_SUPPLEMENTS    12
  42 #define SOLVABLE_ENHANCES       13
  43 #define SOLVABLE_FRESHENS       14
  44 #define RPM_RPMDBID             15
  45 #define SOLVABLE_PREREQMARKER   16              // normal requires before this, prereqs after this
  46 #define SOLVABLE_FILEMARKER     17              // normal provides before this, generated file provides after this
  47 #define NAMESPACE_INSTALLED     18
  48 #define NAMESPACE_MODALIAS      19
  49 #define NAMESPACE_SPLITPROVIDES 20
  50 #define SYSTEM_SYSTEM           21
  51 #define ARCH_SRC                22
  52 #define ARCH_NOSRC              23
  53 #define ARCH_NOARCH             24
  54 #define REPODATA_EXTERNAL       25
  55 #define REPODATA_KEYS           26
  56 #define REPODATA_LOCATION       27
  57
  58 #define ID_NUM_INTERNAL         28
  59
  60
  61 /* well known solvable */
  62 #define SYSTEMSOLVABLE          1
  63
  64
  65 /* how many strings to maintain (round robin) */
  66 #define DEP2STRBUF 16
  67
  68 //-----------------------------------------------
  69
  70 struct _Repo;
  71
  72 struct _Pool {
  73   struct _Stringpool ss;
  74
  75   Reldep *rels;               // table of rels: Id -> Reldep
  76   int nrels;                  // number of unique rels
  77   Hashtable relhashtbl;       // hash table: (name,evr,op ->) Hash -> Id
  78   Hashmask relhashmask;
  79
  80   struct _Repo **repos;
  81   int nrepos;
  82
  83   Solvable *solvables;
  84   int nsolvables;
  85
  86   int promoteepoch;             /* 0/1  */
  87
  88   Id *id2arch;                  /* map arch ids to scores */
  89   Id lastarch;                  /* last valid entry in id2arch */
  90   Queue vendormap;              /* map vendor to vendorclasses mask */
  91
  92   /* providers data, as two-step indirect list
  93    * whatprovides[Id] -> Offset into whatprovidesdata for name
  94    * whatprovidesdata[Offset] -> ID_NULL-terminated list of solvables providing Id
  95    */
  96   Offset *whatprovides;         /* Offset to providers of a specific name, Id -> Offset  */
  97   Offset *whatprovides_rel;     /* Offset to providers of a specific relation, Id -> Offset  */
  98
  99   Id *whatprovidesdata;         /* Ids of solvable providing Id */
 100   Offset whatprovidesdataoff;   /* next free slot within whatprovidesdata */
 101   int whatprovidesdataleft;     /* number of 'free slots' within whatprovidesdata */
 102
 103   Id (*nscallback)(struct _Pool *, void *data, Id name, Id evr);
 104   void *nscallbackdata;
 105
 106   /* our dep2str string space */
 107   char *dep2strbuf[DEP2STRBUF];
 108   int   dep2strlen[DEP2STRBUF];
 109   int   dep2strn;
 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
 117 #define SAT_FATAL                       (1<<0)
 118 #define SAT_ERROR                       (1<<1)
 119 #define SAT_WARN                        (1<<2)
 120 #define SAT_DEBUG_STATS                 (1<<3)
 121 #define SAT_DEBUG_RULE_CREATION         (1<<4)
 122 #define SAT_DEBUG_PROPAGATE             (1<<5)
 123 #define SAT_DEBUG_ANALYZE               (1<<6)
 124 #define SAT_DEBUG_UNSOLVABLE            (1<<7)
 125 #define SAT_DEBUG_SOLUTIONS             (1<<8)
 126 #define SAT_DEBUG_POLICY                (1<<9)
 127 #define SAT_DEBUG_RESULT                (1<<10)
 128 #define SAT_DEBUG_JOB                   (1<<11)
 129 #define SAT_DEBUG_SCHUBI                (1<<12)
 130
 131 /* The void type is usable to encode one-valued attributes, they have
 132    no associated data.  This is useful to encode values which many solvables
 133    have in common, and whose overall set is relatively limited.  A prime
 134    example would be the media number.  The actual value is encoded in the
 135    SIZE member of the key structure.  Be warned: careless use of this
 136    leads to combinatoric explosion of number of schemas.  */
 137 #define TYPE_VOID               0
 138 #define TYPE_ID                 1
 139 #define TYPE_IDARRAY            2
 140 #define TYPE_STR                3
 141 #define TYPE_U32                4
 142 #define TYPE_REL_IDARRAY        5
 143
 144 #define TYPE_ATTR_INT           6
 145 #define TYPE_ATTR_CHUNK         7
 146 #define TYPE_ATTR_STRING        8
 147 #define TYPE_ATTR_INTLIST       9
 148 #define TYPE_ATTR_LOCALIDS      10
 149
 150 #define TYPE_COUNT_NAMED        11
 151 #define TYPE_COUNTED            12
 152
 153 #define TYPE_IDVALUEARRAY       13
 154
 155 #define TYPE_DIR                14
 156 #define TYPE_DIRNUMNUMARRAY     15
 157 #define TYPE_DIRSTRARRAY        16
 158
 159 #define TYPE_CONSTANT           17
 160 #define TYPE_NUM                18
 161
 162 #define TYPE_ATTR_TYPE_MAX      18
 163
 164 //-----------------------------------------------
 165
 166
 167 /* mark dependencies with relation by setting bit31 */
 168
 169 #define MAKERELDEP(id) ((id) | 0x80000000)
 170 #define ISRELDEP(id) (((id) & 0x80000000) != 0)
 171 #define GETRELID(id) ((id) ^ 0x80000000)                                /* returns Id */
 172 #define GETRELDEP(pool, id) ((pool)->rels + ((id) ^ 0x80000000))        /* returns Reldep* */
 173
 174 #define REL_GT          1
 175 #define REL_EQ          2
 176 #define REL_LT          4
 177
 178 #define REL_AND         16
 179 #define REL_OR          17
 180 #define REL_WITH        18
 181 #define REL_NAMESPACE   19
 182
 183 #if !defined(__GNUC__) && !defined(__attribute__)
 184 # define __attribute__(x)
 185 #endif
 186
 187 /**
 188  * Creates a new pool
 189  */
 190 extern Pool *pool_create(void);
 191 /**
 192  * Delete a pool
 193  */
 194 extern void pool_free(Pool *pool);
 195
 196 extern void pool_debug(Pool *pool, int type, const char *format, ...) __attribute__((format(printf, 3, 4)));
 197
 198 /**
 199  * Solvable management
 200  */
 201 extern Id pool_add_solvable(Pool *pool);
 202 extern Id pool_add_solvable_block(Pool *pool, int count);
 203
 204 extern void pool_free_solvable_block(Pool *pool, Id start, int count, int reuseids);
 205 static inline Solvable *pool_id2solvable(Pool *pool, Id p)
 206 {
 207   return pool->solvables + p;
 208 }
 209 extern const char *solvable2str(Pool *pool, Solvable *s);
 210
 211
 212 /**
 213  * Prepares a pool for solving
 214  */
 215 extern void pool_createwhatprovides(Pool *pool);
 216 extern void pool_addfileprovides(Pool *pool, struct _Repo *installed);
 217 extern void pool_freewhatprovides(Pool *pool);
 218 extern Id pool_queuetowhatprovides(Pool *pool, Queue *q);
 219
 220 static inline int pool_installable(Pool *pool, Solvable *s)
 221 {
 222   if (!s->arch || s->arch == ARCH_SRC || s->arch == ARCH_NOSRC)
 223     return 0;
 224   if (pool->id2arch && (s->arch > pool->lastarch || !pool->id2arch[s->arch]))
 225     return 0;
 226   return 1;
 227 }
 228
 229 extern Id *pool_addrelproviders(Pool *pool, Id d);
 230
 231 static inline Id *pool_whatprovides(Pool *pool, Id d)
 232 {
 233   Id v;
 234   if (!ISRELDEP(d))
 235     return pool->whatprovidesdata + pool->whatprovides[d];
 236   v = GETRELID(d);
 237   if (pool->whatprovides_rel[v])
 238     return pool->whatprovidesdata + pool->whatprovides_rel[v];
 239   return pool_addrelproviders(pool, d);
 240 }
 241
 242 extern void pool_setdebuglevel(Pool *pool, int level);
 243
 244 static inline void pool_setdebugcallback(Pool *pool, void (*debugcallback)(struct _Pool *, void *data, int type, const char *str), void *debugcallbackdata)
 245 {
 246   pool->debugcallback = debugcallback;
 247   pool->debugcallbackdata = debugcallbackdata;
 248 }
 249
 250 static inline void pool_setdebugmask(Pool *pool, int mask)
 251 {
 252   pool->debugmask = mask;
 253 }
 254
 255 /* loop over all providers of d */
 256 #define FOR_PROVIDES(v, vp, d)                                          \
 257   for (vp = pool_whatprovides(pool, d) ; (v = *vp++) != 0; )
 258
 259 #define POOL_DEBUG(type, ...) do {if ((pool->debugmask & (type)) != 0) pool_debug(pool, (type), __VA_ARGS__);} while (0)
 260 #define IF_POOLDEBUG(type) if ((pool->debugmask & (type)) != 0)
 261
 262 #ifdef __cplusplus
 263 }
 264 #endif
 265
 266
 267 #endif /* SATSOLVER_POOL_H */