src/solver.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  * solver.h
  10  *
  11  */
  12
  13 #ifndef LIBSOLV_SOLVER_H
  14 #define LIBSOLV_SOLVER_H
  15
  16 #ifdef __cplusplus
  17 extern "C" {
  18 #endif
  19
  20 #include "pooltypes.h"
  21 #include "pool.h"
  22 #include "repo.h"
  23 #include "queue.h"
  24 #include "bitmap.h"
  25 #include "transaction.h"
  26 #include "rules.h"
  27 #include "problems.h"
  28
  29 /*
  30  * Callback definitions in order to "overwrite" the policies by an external application.
  31  */
  32
  33 typedef void  (*BestSolvableCb) (Pool *pool, Queue *canditates);
  34 typedef int  (*ArchCheckCb) (Pool *pool, Solvable *solvable1, Solvable *solvable2);
  35 typedef int  (*VendorCheckCb) (Pool *pool, Solvable *solvable1, Solvable *solvable2);
  36 typedef void (*UpdateCandidateCb) (Pool *pool, Solvable *solvable, Queue *canditates);
  37
  38
  39 #if 1
  40 struct _Solver {
  41   Pool *pool;                           /* back pointer to pool */
  42   Queue job;                            /* copy of the job we're solving */
  43
  44   Transaction trans;                    /* calculated transaction */
  45
  46   Repo *installed;                      /* copy of pool->installed */
  47
  48   /* list of rules, ordered
  49    * rpm rules first, then features, updates, jobs, learnt
  50    * see start/end offsets below
  51    */
  52   Rule *rules;                          /* all rules */
  53   Id nrules;                            /* [Offset] index of the last rule */
  54
  55   Queue ruleassertions;                 /* Queue of all assertion rules */
  56
  57   /* start/end offset for rule 'areas' */
  58
  59   Id rpmrules_end;                      /* [Offset] rpm rules end */
  60
  61   Id featurerules;                      /* feature rules start/end */
  62   Id featurerules_end;
  63
  64   Id updaterules;                       /* policy rules, e.g. keep packages installed or update. All literals > 0 */
  65   Id updaterules_end;
  66
  67   Id jobrules;                          /* user rules */
  68   Id jobrules_end;
  69
  70   Id infarchrules;                      /* inferior arch rules */
  71   Id infarchrules_end;
  72
  73   Id duprules;                          /* dist upgrade rules */
  74   Id duprules_end;
  75
  76   Id choicerules;                       /* choice rules (always weak) */
  77   Id choicerules_end;
  78   Id *choicerules_ref;
  79
  80   Id learntrules;                       /* learnt rules, (end == nrules) */
  81
  82   Map noupdate;                         /* don't try to update these
  83                                            installed solvables */
  84   Map noobsoletes;                      /* ignore obsoletes for these (multiinstall) */
  85
  86   Map updatemap;                        /* bring these installed packages to the newest version */
  87   int updatemap_all;                    /* bring all packages to the newest version */
  88
  89   Map fixmap;                           /* fix these packages */
  90   int fixmap_all;                       /* fix all packages */
  91
  92   Queue weakruleq;                      /* index into 'rules' for weak ones */
  93   Map weakrulemap;                      /* map rule# to '1' for weak rules, 1..learntrules */
  94
  95   Id *watches;                          /* Array of rule offsets
  96                                          * watches has nsolvables*2 entries and is addressed from the middle
  97                                          * middle-solvable : decision to conflict, offset point to linked-list of rules
  98                                          * middle+solvable : decision to install: offset point to linked-list of rules
  99                                          */
 100
 101   Queue ruletojob;                      /* index into job queue: jobs for which a rule exits */
 102
 103   /* our decisions: */
 104   Queue decisionq;                      /* >0:install, <0:remove/conflict */
 105   Queue decisionq_why;                  /* index of rule, Offset into rules */
 106
 107   Id *decisionmap;                      /* map for all available solvables,
 108                                          * = 0: undecided
 109                                          * > 0: level of decision when installed,
 110                                          * < 0: level of decision when conflict */
 111
 112   int decisioncnt_update;
 113   int decisioncnt_keep;
 114   int decisioncnt_resolve;
 115   int decisioncnt_weak;
 116   int decisioncnt_orphan;
 117
 118   /* learnt rule history */
 119   Queue learnt_why;
 120   Queue learnt_pool;
 121
 122   Queue branches;
 123   int (*solution_callback)(struct _Solver *solv, void *data);
 124   void *solution_callback_data;
 125
 126   int propagate_index;                  /* index into decisionq for non-propagated decisions */
 127
 128   Queue problems;                       /* list of lists of conflicting rules, < 0 for job rules */
 129   Queue solutions;                      /* refined problem storage space */
 130
 131   Queue recommendations;                /* recommended packages */
 132   Queue suggestions;                    /* suggested packages */
 133   Queue orphaned;                       /* orphaned packages */
 134
 135   int stats_learned;                    /* statistic */
 136   int stats_unsolvable;                 /* statistic */
 137
 138   Map recommendsmap;                    /* recommended packages from decisionmap */
 139   Map suggestsmap;                      /* suggested packages from decisionmap */
 140   int recommends_index;                 /* recommendsmap/suggestsmap is created up to this level */
 141
 142   Id *obsoletes;                        /* obsoletes for each installed solvable */
 143   Id *obsoletes_data;                   /* data area for obsoletes */
 144   Id *multiversionupdaters;             /* updaters for multiversion packages in updatesystem mode */
 145
 146   /*-------------------------------------------------------------------------------------------------------------
 147    * Solver configuration
 148    *-------------------------------------------------------------------------------------------------------------*/
 149
 150   int fixsystem;                        /* repair errors in rpm dependency graph */
 151   int allowdowngrade;                   /* allow to downgrade installed solvable */
 152   int allowarchchange;                  /* allow to change architecture of installed solvables */
 153   int allowvendorchange;                /* allow to change vendor of installed solvables */
 154   int allowuninstall;                   /* allow removal of installed solvables */
 155   int updatesystem;                     /* update all packages to the newest version */
 156   int noupdateprovide;                  /* true: update packages needs not to provide old package */
 157   int dosplitprovides;                  /* true: consider legacy split provides */
 158   int dontinstallrecommended;           /* true: do not install recommended packages */
 159   int ignorealreadyrecommended;         /* true: ignore recommended packages that were already recommended by the installed packages */
 160   int dontshowinstalledrecommended;     /* true: do not show recommended packages that are already installed */
 161
 162   /* distupgrade also needs updatesystem and dosplitprovides */
 163   int distupgrade;
 164   int distupgrade_removeunsupported;
 165
 166   int noinfarchcheck;                   /* true: do not forbid inferior architectures */
 167
 168   /* Callbacks for defining the bahaviour of the SAT solver */
 169
 170   /* Finding best candidate
 171    *
 172    * Callback definition:
 173    * void  bestSolvable (Pool *pool, Queue *canditates)
 174    *     candidates       : List of canditates which has to be sorted by the function call
 175    *     return candidates: Sorted list of the candidates(first is the best).
 176    */
 177   BestSolvableCb bestSolvableCb;
 178
 179   /* Checking if two solvables has compatible architectures
 180    *
 181    * Callback definition:
 182    *     int  archCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
 183    *
 184    *     return 0 it the two solvables has compatible architectures
 185    */
 186   ArchCheckCb archCheckCb;
 187
 188   /* Checking if two solvables has compatible vendors
 189    *
 190    * Callback definition:
 191    *     int  vendorCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
 192    *
 193    *     return 0 it the two solvables has compatible architectures
 194    */
 195   VendorCheckCb vendorCheckCb;
 196
 197   /* Evaluate update candidate
 198    *
 199    * Callback definition:
 200    * void pdateCandidateCb (Pool *pool, Solvable *solvable, Queue *canditates)
 201    *     solvable   : for which updates should be search
 202    *     candidates : List of candidates (This list depends on other
 203    *                  restrictions like architecture and vendor policies too)
 204    */
 205   UpdateCandidateCb   updateCandidateCb;
 206
 207   Map dupmap;                           /* dup these packages*/
 208   int dupmap_all;                       /* dup all packages */
 209   Map dupinvolvedmap;                   /* packages involved in dup process */
 210
 211   Map droporphanedmap;                  /* packages to drop in dup mode */
 212   int droporphanedmap_all;
 213
 214   Map cleandepsmap;                     /* try to drop these packages as of cleandeps erases */
 215
 216   Queue *ruleinfoq;                     /* tmp space for solver_ruleinfo() */
 217 };
 218
 219 #endif
 220
 221 typedef struct _Solver Solver;
 222
 223 /*
 224  * queue commands
 225  */
 226
 227 #define SOLVER_SOLVABLE                 0x01
 228 #define SOLVER_SOLVABLE_NAME            0x02
 229 #define SOLVER_SOLVABLE_PROVIDES        0x03
 230 #define SOLVER_SOLVABLE_ONE_OF          0x04
 231 #define SOLVER_SOLVABLE_REPO            0x05
 232 #define SOLVER_SOLVABLE_ALL             0x06
 233
 234 #define SOLVER_SELECTMASK               0xff
 235
 236 #define SOLVER_NOOP                     0x0000
 237 #define SOLVER_INSTALL                  0x0100
 238 #define SOLVER_ERASE                    0x0200
 239 #define SOLVER_UPDATE                   0x0300
 240 #define SOLVER_WEAKENDEPS               0x0400
 241 #define SOLVER_NOOBSOLETES              0x0500
 242 #define SOLVER_LOCK                     0x0600
 243 #define SOLVER_DISTUPGRADE              0x0700
 244 #define SOLVER_VERIFY                   0x0800
 245 #define SOLVER_DROP_ORPHANED            0x0900
 246 #define SOLVER_USERINSTALLED            0x0a00
 247
 248 #define SOLVER_JOBMASK                  0xff00
 249
 250 #define SOLVER_WEAK                     0x010000
 251 #define SOLVER_ESSENTIAL                0x020000
 252 #define SOLVER_CLEANDEPS                0x040000
 253
 254 #define SOLVER_SETEV                    0x01000000
 255 #define SOLVER_SETEVR                   0x02000000
 256 #define SOLVER_SETARCH                  0x04000000
 257 #define SOLVER_SETVENDOR                0x08000000
 258 #define SOLVER_SETREPO                  0x10000000
 259 #define SOLVER_NOAUTOSET                0x20000000
 260
 261 #define SOLVER_SETMASK                  0x2f000000
 262
 263 #define SOLVER_REASON_UNRELATED         0
 264 #define SOLVER_REASON_UNIT_RULE         1
 265 #define SOLVER_REASON_KEEP_INSTALLED    2
 266 #define SOLVER_REASON_RESOLVE_JOB       3
 267 #define SOLVER_REASON_UPDATE_INSTALLED  4
 268 #define SOLVER_REASON_CLEANDEPS_ERASE   5
 269 #define SOLVER_REASON_RESOLVE           6
 270 #define SOLVER_REASON_WEAKDEP           7
 271 #define SOLVER_REASON_RESOLVE_ORPHAN    8
 272
 273 #define SOLVER_REASON_RECOMMENDED       16
 274 #define SOLVER_REASON_SUPPLEMENTED      17
 275
 276 extern Solver *solver_create(Pool *pool);
 277 extern void solver_free(Solver *solv);
 278 extern int  solver_solve(Solver *solv, Queue *job);
 279
 280 extern int  solver_get_decisionlevel(Solver *solv, Id p);
 281 extern void solver_get_decisionqueue(Solver *solv, Queue *decisionq);
 282 extern int  solver_get_lastdecisionblocklevel(Solver *solv);
 283 extern void solver_get_decisionblock(Solver *solv, int level, Queue *decisionq);
 284 extern int  solver_describe_decision(Solver *solv, Id p, Id *infop);
 285 extern void solver_describe_weakdep_decision(Solver *solv, Id p, Queue *whyq);
 286
 287
 288 extern void solver_calculate_noobsmap(Pool *pool, Queue *job, Map *noobsmap);
 289 extern void solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap);
 290
 291 /* XXX: why is this not static? */
 292 Id *solver_create_decisions_obsoletesmap(Solver *solv);
 293
 294 void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
 295 int solver_calc_installsizechange(Solver *solv);
 296 void solver_trivial_installable(Solver *solv, Queue *pkgs, Queue *res);
 297
 298 void solver_find_involved(Solver *solv, Queue *installedq, Solvable *s, Queue *q);
 299
 300 /* iterate over all literals of a rule */
 301 /* WARNING: loop body must not relocate whatprovidesdata, e.g. by
 302  * looking up the providers of a dependency */
 303 #define FOR_RULELITERALS(l, dp, r)                              \
 304     for (l = r->d < 0 ? -r->d - 1 : r->d,                       \
 305          dp = !l ? &r->w2 : pool->whatprovidesdata + l,         \
 306          l = r->p; l; l = (dp != &r->w2 + 1 ? *dp++ : 0))
 307
 308 /* iterate over all packages selected by a job */
 309 #define FOR_JOB_SELECT(p, pp, select, what)                                     \
 310     if (select == SOLVER_SOLVABLE_REPO || select == SOLVER_SOLVABLE_ALL)        \
 311         p = pp = 0;                                                             \
 312     else for (pp = (select == SOLVER_SOLVABLE ? 0 :                             \
 313                select == SOLVER_SOLVABLE_ONE_OF ? what :                        \
 314                pool_whatprovides(pool, what)),                                  \
 315          p = (select == SOLVER_SOLVABLE ? what : pool->whatprovidesdata[pp++]) ; p ; p = pool->whatprovidesdata[pp++]) \
 316       if (select != SOLVER_SOLVABLE_NAME || pool_match_nevr(pool, pool->solvables + p, what))
 317
 318 #ifdef __cplusplus
 319 }
 320 #endif
 321
 322 #endif /* LIBSOLV_SOLVER_H */