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