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