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