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