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