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 LIBSOLV_POOL_H
  14 #define LIBSOLV_POOL_H
  15
  16 #include <stdio.h>
  17
  18 #include "solvversion.h"
  19 #include "pooltypes.h"
  20 #include "poolid.h"
  21 #include "solvable.h"
  22 #include "bitmap.h"
  23 #include "queue.h"
  24 #include "strpool.h"
  25
  26 /* well known ids */
  27 #include "knownid.h"
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /* well known solvable */
  34 #define SYSTEMSOLVABLE          1
  35
  36
  37 /*----------------------------------------------- */
  38
  39 struct s_Repokey;
  40 struct s_KeyValue;
  41
  42 typedef struct s_Datapos {
  43   Repo *repo;
  44   Id solvid;
  45   Id repodataid;
  46   Id schema;
  47   Id dp;
  48 } Datapos;
  49
  50
  51 #ifdef LIBSOLV_INTERNAL
  52
  53 /* how many strings to maintain (round robin) */
  54 #define POOL_TMPSPACEBUF 16
  55
  56 struct s_Pool_tmpspace {
  57   char *buf[POOL_TMPSPACEBUF];
  58   int   len[POOL_TMPSPACEBUF];
  59   int   n;
  60 };
  61
  62 #endif
  63
  64 struct s_Pool {
  65   void *appdata;                /* application private pointer */
  66
  67   Stringpool ss;
  68
  69   Reldep *rels;                 /* table of rels: Id -> Reldep */
  70   int nrels;                    /* number of unique rels */
  71
  72   Repo **repos;
  73   int nrepos;                   /* repos allocated */
  74   int urepos;                   /* repos in use */
  75
  76   Repo *installed;      /* packages considered installed */
  77
  78   Solvable *solvables;
  79   int nsolvables;               /* solvables allocated */
  80
  81   const char **languages;
  82   int nlanguages;
  83
  84   /* package manager type, deb/rpm */
  85   int disttype;
  86
  87   Id *id2arch;                  /* map arch ids to scores */
  88   unsigned char *id2color;      /* map arch ids to colors */
  89   Id lastarch;                  /* size of the id2arch/id2color arrays */
  90
  91   Queue vendormap;              /* map vendor to vendorclasses mask */
  92   const char **vendorclasses;   /* vendor equivalence classes */
  93
  94   /* providers data, as two-step indirect list
  95    * whatprovides[Id] -> Offset into whatprovidesdata for name
  96    * whatprovidesdata[Offset] -> 0-terminated list of solvables providing Id
  97    */
  98   Offset *whatprovides;         /* Offset to providers of a specific name, Id -> Offset  */
  99   Offset *whatprovides_rel;     /* Offset to providers of a specific relation, Id -> Offset  */
 100
 101   Id *whatprovidesdata;         /* Ids of solvable providing Id */
 102   Offset whatprovidesdataoff;   /* next free slot within whatprovidesdata */
 103   int whatprovidesdataleft;     /* number of 'free slots' within whatprovidesdata */
 104
 105   /* If nonzero, then consider only the solvables with Ids set in this
 106      bitmap for solving.  If zero, consider all solvables.  */
 107   Map *considered;
 108
 109   /* callback for REL_NAMESPACE dependencies handled by the application  */
 110   Id (*nscallback)(Pool *, void *data, Id name, Id evr);
 111   void *nscallbackdata;
 112
 113   /* debug mask and callback */
 114   int  debugmask;
 115   void (*debugcallback)(Pool *, void *data, int type, const char *str);
 116   void *debugcallbackdata;
 117
 118   /* load callback */
 119   int (*loadcallback)(Pool *, Repodata *, void *);
 120   void *loadcallbackdata;
 121
 122   /* search position */
 123   Datapos pos;
 124
 125   Queue pooljobs;               /* fixed jobs, like USERINSTALLED/MULTIVERSION */
 126
 127 #ifdef LIBSOLV_INTERNAL
 128   /* flags to tell the library how the installed package manager works */
 129   int promoteepoch;             /* true: missing epoch is replaced by epoch of dependency   */
 130   int havedistepoch;            /* true: thr release part in the evr may contain a distepoch suffix */
 131   int obsoleteusesprovides;     /* true: obsoletes are matched against provides, not names */
 132   int implicitobsoleteusesprovides;     /* true: implicit obsoletes due to same name are matched against provides, not names */
 133   int obsoleteusescolors;       /* true: obsoletes check arch color */
 134   int implicitobsoleteusescolors;       /* true: implicit obsoletes check arch color */
 135   int noinstalledobsoletes;     /* true: ignore obsoletes of installed packages */
 136   int forbidselfconflicts;      /* true: packages which conflict with itself are not installable */
 137   int noobsoletesmultiversion;  /* true: obsoletes are ignored for multiversion installs */
 138
 139   Id noarchid;                  /* ARCH_NOARCH, ARCH_ALL, ARCH_ANY, ... */
 140
 141   /* hash for rel unification */
 142   Hashtable relhashtbl;         /* hashtable: (name,evr,op)Hash -> Id */
 143   Hashval relhashmask;
 144
 145   Id *languagecache;
 146   int languagecacheother;
 147
 148   /* our tmp space string space */
 149   struct s_Pool_tmpspace tmpspace;
 150
 151   char *errstr;                 /* last error string */
 152   int errstra;                  /* allocated space for errstr */
 153
 154   char *rootdir;
 155
 156   int (*custom_vendorcheck)(Pool *, Solvable *, Solvable *);
 157
 158   int addfileprovidesfiltered;  /* 1: only use filtered file list for addfileprovides */
 159   int addedfileprovides;        /* true: application called addfileprovides */
 160   Queue lazywhatprovidesq;      /* queue to store old whatprovides offsets */
 161   int nowhatprovidesaux;        /* don't allocate and use the whatprovides aux helper */
 162   Offset *whatprovidesaux;
 163   Offset whatprovidesauxoff;
 164   Id *whatprovidesauxdata;
 165   Offset whatprovidesauxdataoff;
 166
 167   int whatprovideswithdisabled;
 168 #endif
 169 };
 170
 171 #define DISTTYPE_RPM    0
 172 #define DISTTYPE_DEB    1
 173 #define DISTTYPE_ARCH   2
 174 #define DISTTYPE_HAIKU  3
 175 #define DISTTYPE_CONDA  4
 176
 177 #define SOLV_FATAL                      (1<<0)
 178 #define SOLV_ERROR                      (1<<1)
 179 #define SOLV_WARN                       (1<<2)
 180 #define SOLV_DEBUG_STATS                (1<<3)
 181 #define SOLV_DEBUG_RULE_CREATION        (1<<4)
 182 #define SOLV_DEBUG_PROPAGATE            (1<<5)
 183 #define SOLV_DEBUG_ANALYZE              (1<<6)
 184 #define SOLV_DEBUG_UNSOLVABLE           (1<<7)
 185 #define SOLV_DEBUG_SOLUTIONS            (1<<8)
 186 #define SOLV_DEBUG_POLICY               (1<<9)
 187 #define SOLV_DEBUG_RESULT               (1<<10)
 188 #define SOLV_DEBUG_JOB                  (1<<11)
 189 #define SOLV_DEBUG_SOLVER               (1<<12)
 190 #define SOLV_DEBUG_TRANSACTION          (1<<13)
 191 #define SOLV_DEBUG_WATCHES              (1<<14)
 192
 193 #define SOLV_DEBUG_TO_STDERR            (1<<30)
 194
 195 #define POOL_FLAG_PROMOTEEPOCH                          1
 196 #define POOL_FLAG_FORBIDSELFCONFLICTS                   2
 197 #define POOL_FLAG_OBSOLETEUSESPROVIDES                  3
 198 #define POOL_FLAG_IMPLICITOBSOLETEUSESPROVIDES          4
 199 #define POOL_FLAG_OBSOLETEUSESCOLORS                    5
 200 #define POOL_FLAG_NOINSTALLEDOBSOLETES                  6
 201 #define POOL_FLAG_HAVEDISTEPOCH                         7
 202 #define POOL_FLAG_NOOBSOLETESMULTIVERSION               8
 203 #define POOL_FLAG_ADDFILEPROVIDESFILTERED               9
 204 #define POOL_FLAG_IMPLICITOBSOLETEUSESCOLORS            10
 205 #define POOL_FLAG_NOWHATPROVIDESAUX                     11
 206 #define POOL_FLAG_WHATPROVIDESWITHDISABLED              12
 207
 208 /* ----------------------------------------------- */
 209
 210
 211 /* mark dependencies with relation by setting bit31 */
 212
 213 #define MAKERELDEP(id) ((id) | 0x80000000)
 214 #define ISRELDEP(id) (((id) & 0x80000000) != 0)
 215 #define GETRELID(id) ((id) ^ 0x80000000)                                /* returns Id */
 216 #define GETRELDEP(pool, id) ((pool)->rels + ((id) ^ 0x80000000))        /* returns Reldep* */
 217
 218 #define REL_GT          1
 219 #define REL_EQ          2
 220 #define REL_LT          4
 221
 222 #define REL_AND         16
 223 #define REL_OR          17
 224 #define REL_WITH        18
 225 #define REL_NAMESPACE   19
 226 #define REL_ARCH        20
 227 #define REL_FILECONFLICT        21
 228 #define REL_COND        22      /* OR_NOT */
 229 #define REL_COMPAT      23
 230 #define REL_KIND        24      /* for filters only */
 231 #define REL_MULTIARCH   25      /* debian multiarch annotation */
 232 #define REL_ELSE        26      /* only as evr part of REL_COND/REL_UNLESS */
 233 #define REL_ERROR       27      /* parse errors and the like */
 234 #define REL_WITHOUT     28
 235 #define REL_UNLESS      29      /* AND_NOT */
 236 #define REL_CONDA       30
 237
 238 #if !defined(__GNUC__) && !defined(__attribute__)
 239 # define __attribute__(x)
 240 #endif
 241
 242 extern Pool *pool_create(void);
 243 extern void pool_free(Pool *pool);
 244 extern void pool_freeallrepos(Pool *pool, int reuseids);
 245
 246 extern void pool_setdebuglevel(Pool *pool, int level);
 247 extern int  pool_setdisttype(Pool *pool, int disttype);
 248 extern int  pool_set_flag(Pool *pool, int flag, int value);
 249 extern int  pool_get_flag(Pool *pool, int flag);
 250
 251 extern void pool_debug(Pool *pool, int type, const char *format, ...) __attribute__((format(printf, 3, 4)));
 252 extern void pool_setdebugcallback(Pool *pool, void (*debugcallback)(Pool *pool, void *data, int type, const char *str), void *debugcallbackdata);
 253 extern void pool_setdebugmask(Pool *pool, int mask);
 254 extern void pool_setloadcallback(Pool *pool, int (*cb)(Pool *, Repodata *, void *), void *loadcbdata);
 255 extern void pool_setnamespacecallback(Pool *pool, Id (*cb)(Pool *, void *, Id, Id), void *nscbdata);
 256 extern void pool_flush_namespaceproviders(Pool *pool, Id ns, Id evr);
 257
 258 extern void pool_set_custom_vendorcheck(Pool *pool, int (*vendorcheck)(Pool *, Solvable *, Solvable *));
 259 extern int (*pool_get_custom_vendorcheck(Pool *pool))(Pool *, Solvable *, Solvable *);
 260
 261 extern char *pool_alloctmpspace(Pool *pool, int len);
 262 extern void  pool_freetmpspace(Pool *pool, const char *space);
 263 extern char *pool_tmpjoin(Pool *pool, const char *str1, const char *str2, const char *str3);
 264 extern char *pool_tmpappend(Pool *pool, const char *str1, const char *str2, const char *str3);
 265 extern const char *pool_bin2hex(Pool *pool, const unsigned char *buf, int len);
 266
 267 extern void pool_set_installed(Pool *pool, Repo *repo);
 268
 269 extern int  pool_error(Pool *pool, int ret, const char *format, ...) __attribute__((format(printf, 3, 4)));
 270 extern char *pool_errstr(Pool *pool);
 271
 272 extern void pool_set_rootdir(Pool *pool, const char *rootdir);
 273 extern const char *pool_get_rootdir(Pool *pool);
 274 extern char *pool_prepend_rootdir(Pool *pool, const char *dir);
 275 extern const char *pool_prepend_rootdir_tmp(Pool *pool, const char *dir);
 276
 277 /**
 278  * Solvable management
 279  */
 280 extern Id pool_add_solvable(Pool *pool);
 281 extern Id pool_add_solvable_block(Pool *pool, int count);
 282
 283 extern void pool_free_solvable_block(Pool *pool, Id start, int count, int reuseids);
 284 static inline Solvable *pool_id2solvable(const Pool *pool, Id p)
 285 {
 286   return pool->solvables + p;
 287 }
 288 static inline Id pool_solvable2id(const Pool *pool, Solvable *s)
 289 {
 290   return s - pool->solvables;
 291 }
 292
 293 extern const char *pool_solvable2str(Pool *pool, Solvable *s);
 294 static inline const char *pool_solvid2str(Pool *pool, Id p)
 295 {
 296   return pool_solvable2str(pool, pool->solvables + p);
 297 }
 298 extern const char *pool_solvidset2str(Pool *pool, Queue *q);
 299
 300 void pool_set_languages(Pool *pool, const char **languages, int nlanguages);
 301 Id pool_id2langid(Pool *pool, Id id, const char *lang, int create);
 302
 303 int pool_intersect_evrs(Pool *pool, int pflags, Id pevr, int flags, Id evr);
 304 int pool_match_dep(Pool *pool, Id d1, Id d2);
 305
 306 /* semi private, used in pool_match_nevr */
 307 int pool_match_nevr_rel(Pool *pool, Solvable *s, Id d);
 308
 309 static inline int pool_match_nevr(Pool *pool, Solvable *s, Id d)
 310 {
 311   if (!ISRELDEP(d))
 312     return d == s->name;
 313   else
 314     return pool_match_nevr_rel(pool, s, d);
 315 }
 316
 317
 318 /**
 319  * Prepares a pool for solving
 320  */
 321 extern void pool_createwhatprovides(Pool *pool);
 322 extern void pool_addfileprovides(Pool *pool);
 323 extern void pool_addfileprovides_queue(Pool *pool, Queue *idq, Queue *idqinst);
 324 extern void pool_freewhatprovides(Pool *pool);
 325 extern Id pool_queuetowhatprovides(Pool *pool, Queue *q);
 326 extern Id pool_ids2whatprovides(Pool *pool, Id *ids, int count);
 327 extern Id pool_searchlazywhatprovidesq(Pool *pool, Id d);
 328
 329 extern Id pool_addrelproviders(Pool *pool, Id d);
 330
 331 static inline Id pool_whatprovides(Pool *pool, Id d)
 332 {
 333   if (!ISRELDEP(d))
 334     {
 335       if (pool->whatprovides[d])
 336         return pool->whatprovides[d];
 337     }
 338   else
 339     {
 340       Id v = GETRELID(d);
 341       if (pool->whatprovides_rel[v])
 342         return pool->whatprovides_rel[v];
 343     }
 344   return pool_addrelproviders(pool, d);
 345 }
 346
 347 static inline Id *pool_whatprovides_ptr(Pool *pool, Id d)
 348 {
 349   Id off = pool_whatprovides(pool, d);
 350   return pool->whatprovidesdata + off;
 351 }
 352
 353 void pool_whatmatchesdep(Pool *pool, Id keyname, Id dep, Queue *q, int marker);
 354 void pool_whatcontainsdep(Pool *pool, Id keyname, Id dep, Queue *q, int marker);
 355 void pool_whatmatchessolvable(Pool *pool, Id keyname, Id solvid, Queue *q, int marker);
 356 void pool_set_whatprovides(Pool *pool, Id id, Id providers);
 357
 358
 359 /* search the pool. the following filters are available:
 360  *   p     - search just this solvable
 361  *   key   - search only this key
 362  *   match - key must match this string
 363  */
 364 void pool_search(Pool *pool, Id p, Id key, const char *match, int flags, int (*callback)(void *cbdata, Solvable *s, Repodata *data, struct s_Repokey *key, struct s_KeyValue *kv), void *cbdata);
 365
 366 void pool_clear_pos(Pool *pool);
 367
 368 /* lookup functions */
 369 const char *pool_lookup_str(Pool *pool, Id entry, Id keyname);
 370 Id pool_lookup_id(Pool *pool, Id entry, Id keyname);
 371 unsigned long long pool_lookup_num(Pool *pool, Id entry, Id keyname, unsigned long long notfound);
 372 int pool_lookup_void(Pool *pool, Id entry, Id keyname);
 373 const unsigned char *pool_lookup_bin_checksum(Pool *pool, Id entry, Id keyname, Id *typep);
 374 int pool_lookup_idarray(Pool *pool, Id entry, Id keyname, Queue *q);
 375 const char *pool_lookup_checksum(Pool *pool, Id entry, Id keyname, Id *typep);
 376 const char *pool_lookup_deltalocation(Pool *pool, Id entry, unsigned int *medianrp);
 377
 378
 379 #define DUCHANGES_ONLYADD       1
 380
 381 typedef struct s_DUChanges {
 382   const char *path;
 383   long long kbytes;
 384   long long files;
 385   int flags;
 386 } DUChanges;
 387
 388
 389 void pool_create_state_maps(Pool *pool, Queue *installed, Map *installedmap, Map *conflictsmap);
 390 void pool_calc_duchanges(Pool *pool, Map *installedmap, DUChanges *mps, int nmps);
 391 long long pool_calc_installsizechange(Pool *pool, Map *installedmap);
 392
 393 void pool_add_fileconflicts_deps(Pool *pool, Queue *conflicts);
 394
 395
 396
 397 /* loop over all providers of d */
 398 #define FOR_PROVIDES(v, vp, d)                                          \
 399   for (vp = pool_whatprovides(pool, d) ; (v = pool->whatprovidesdata[vp++]) != 0; )
 400
 401 /* loop over all repositories */
 402 #define FOR_REPOS(repoid, r)                                            \
 403   for (repoid = 1; repoid < pool->nrepos; repoid++)                     \
 404     if ((r = pool->repos[repoid]) == 0)                                 \
 405       continue;                                                         \
 406     else
 407
 408 #define FOR_POOL_SOLVABLES(p)                                           \
 409   for (p = 2; p < pool->nsolvables; p++)                                \
 410     if (pool->solvables[p].repo == 0)                                   \
 411       continue;                                                         \
 412     else
 413
 414 #define POOL_DEBUG(type, ...) do {if ((pool->debugmask & (type)) != 0) pool_debug(pool, (type), __VA_ARGS__);} while (0)
 415 #define IF_POOLDEBUG(type) if ((pool->debugmask & (type)) != 0)
 416
 417 /* weird suse stuff */
 418 void pool_trivial_installable_multiversionmap(Pool *pool, Map *installedmap, Queue *pkgs, Queue *res, Map *multiversionmap);
 419 void pool_trivial_installable(Pool *pool, Map *installedmap, Queue *pkgs, Queue *res);
 420
 421 #ifdef __cplusplus
 422 }
 423 #endif
 424
 425
 426 #endif /* LIBSOLV_POOL_H */