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 SATSOLVER_SOLVER_H
  14 #define SATSOLVER_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 /*
  26  * Callback definitions in order to "overwrite" the policies by an external application.
  27  */
  28
  29 typedef void  (*BestSolvableCb) (Pool *pool, Queue *canditates);
  30 typedef int  (*ArchCheckCb) (Pool *pool, Solvable *solvable1, Solvable *solvable2);
  31 typedef int  (*VendorCheckCb) (Pool *pool, Solvable *solvable1, Solvable *solvable2);
  32 typedef void (*UpdateCandidateCb) (Pool *pool, Solvable *solvable, Queue *canditates);
  33
  34
  35 /* ----------------------------------------------
  36  * Rule
  37  *
  38  *   providerN(B) == Package Id of package providing tag B
  39  *   N = 1, 2, 3, in case of multiple providers
  40  *
  41  * A requires B : !A | provider1(B) | provider2(B)
  42  *
  43  * A conflicts B : (!A | !provider1(B)) & (!A | !provider2(B)) ...
  44  *
  45  * 'not' is encoded as a negative Id
  46  *
  47  * Binary rule: p = first literal, d = 0, w2 = second literal, w1 = p
  48  */
  49
  50 typedef struct rule {
  51   Id p;                 /* first literal in rule */
  52   Id d;                 /* Id offset into 'list of providers terminated by 0' as used by whatprovides; pool->whatprovides + d */
  53                         /* in case of binary rules, d == 0, w1 == p, w2 == other literal */
  54                         /* in case of disabled rules: ~d, aka -d - 1 */
  55   Id w1, w2;            /* watches, literals not-yet-decided */
  56                                        /* if !w2, assertion, not rule */
  57   Id n1, n2;            /* next rules in linked list, corresponding to w1,w2 */
  58 } Rule;
  59
  60 struct solver;
  61
  62 typedef struct solver {
  63   Pool *pool;
  64   Repo *installed;
  65
  66   /* list of rules, ordered
  67    * rpm rules first, then features, updates, jobs, learnt
  68    * see start/end offsets below
  69    */
  70   Rule *rules;                          /* all rules */
  71   Id nrules;                            /* [Offset] index of the last rule */
  72
  73   Queue ruleassertions;                 /* Queue of all assertion rules */
  74
  75   /* start/end offset for rule 'areas' */
  76
  77   Id rpmrules_end;                      /* [Offset] rpm rules end */
  78
  79   Id featurerules;                      /* feature rules start/end */
  80   Id featurerules_end;
  81
  82   Id updaterules;                       /* policy rules, e.g. keep packages installed or update. All literals > 0 */
  83   Id updaterules_end;
  84
  85   Id jobrules;                          /* user rules */
  86   Id jobrules_end;
  87
  88   Id learntrules;                       /* learnt rules, (end == nrules) */
  89
  90   Map noupdate;                         /* don't try to update these
  91                                            installed solvables */
  92   Map noobsoletes;                      /* ignore obsoletes for these
  93                                            (multiinstall) */
  94
  95   Queue weakruleq;                      /* index into 'rules' for weak ones */
  96   Map weakrulemap;                      /* map rule# to '1' for weak rules, 1..learntrules */
  97
  98   Id *watches;                          /* Array of rule offsets
  99                                          * watches has nsolvables*2 entries and is addressed from the middle
 100                                          * middle-solvable : decision to conflict, offset point to linked-list of rules
 101                                          * middle+solvable : decision to install: offset point to linked-list of rules
 102                                          */
 103
 104   Queue ruletojob;                      /* index into job queue: jobs for which a rule exits */
 105
 106   /* our decisions: */
 107   Queue decisionq;                      /* >0:install, <0:remove/conflict */
 108   Queue decisionq_why;                  /* index of rule, Offset into rules */
 109   int directdecisions;                  /* number of decisions with no rule */
 110
 111   Id *decisionmap;                      /* map for all available solvables,
 112                                          * = 0: undecided
 113                                          * > 0: level of decision when installed,
 114                                          * < 0: level of decision when conflict */
 115
 116   /* learnt rule history */
 117   Queue learnt_why;
 118   Queue learnt_pool;
 119
 120   Queue branches;
 121   int (*solution_callback)(struct solver *solv, void *data);
 122   void *solution_callback_data;
 123
 124   int propagate_index;                  /* index into decisionq for non-propagated decisions */
 125
 126   Queue problems;                       /* index of conflicting rules, < 0 for job rules */
 127   Queue recommendations;                /* recommended packages */
 128   Queue suggestions;                    /* suggested packages */
 129   Queue orphaned;                       /* orphaned packages */
 130
 131   int stats_learned;                    /* statistic */
 132   int stats_unsolvable;                 /* statistic */
 133
 134   Map recommendsmap;                    /* recommended packages from decisionmap */
 135   Map suggestsmap;                      /* suggested packages from decisionmap */
 136   int recommends_index;                 /* recommendsmap/suggestsmap is created up to this level */
 137
 138   Id *obsoletes;                        /* obsoletes for each installed solvable */
 139   Id *obsoletes_data;                   /* data area for obsoletes */
 140   Id *multiversionupdaters;             /* updaters for multiversion packages in updatesystem mode */
 141
 142   /*-------------------------------------------------------------------------------------------------------------
 143    * Solver configuration
 144    *-------------------------------------------------------------------------------------------------------------*/
 145
 146   int fixsystem;                        /* repair errors in rpm dependency graph */
 147   int allowdowngrade;                   /* allow to downgrade installed solvable */
 148   int allowarchchange;                  /* allow to change architecture of installed solvables */
 149   int allowvendorchange;                /* allow to change vendor of installed solvables */
 150   int allowuninstall;                   /* allow removal of installed solvables */
 151   int updatesystem;                     /* distupgrade */
 152   int allowvirtualconflicts;            /* false: conflicts on package name, true: conflicts on package provides */
 153   int allowselfconflicts;               /* true: packages wich conflict with itself are installable */
 154   int obsoleteusesprovides;             /* true: obsoletes are matched against provides, not names */
 155   int implicitobsoleteusesprovides;     /* true: implicit obsoletes due to same name are matched against provides, not names */
 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   /* Callbacks for defining the bahaviour of the SAT solver */
 167
 168   /* Finding best candidate
 169    *
 170    * Callback definition:
 171    * void  bestSolvable (Pool *pool, Queue *canditates)
 172    *     candidates       : List of canditates which has to be sorted by the function call
 173    *     return candidates: Sorted list of the candidates(first is the best).
 174    */
 175    BestSolvableCb bestSolvableCb;
 176
 177   /* Checking if two solvables has compatible architectures
 178    *
 179    * Callback definition:
 180    *     int  archCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
 181    *
 182    *     return 0 it the two solvables has compatible architectures
 183    */
 184    ArchCheckCb archCheckCb;
 185
 186   /* Checking if two solvables has compatible vendors
 187    *
 188    * Callback definition:
 189    *     int  vendorCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
 190    *
 191    *     return 0 it the two solvables has compatible architectures
 192    */
 193    VendorCheckCb vendorCheckCb;
 194
 195   /* Evaluate update candidate
 196    *
 197    * Callback definition:
 198    * void pdateCandidateCb (Pool *pool, Solvable *solvable, Queue *canditates)
 199    *     solvable   : for which updates should be search
 200    *     candidates : List of candidates (This list depends on other
 201    *                  restrictions like architecture and vendor policies too)
 202    */
 203    UpdateCandidateCb   updateCandidateCb;
 204
 205
 206   /* some strange queue that doesn't belong here */
 207   Queue covenantq;                      /* Covenants honored by this solver (generic locks) */
 208
 209
 210   Queue *job;                           /* tmp store for job we're working on */
 211 } Solver;
 212
 213 /*
 214  * queue commands
 215  */
 216
 217 #define SOLVER_SOLVABLE                 0x01
 218 #define SOLVER_SOLVABLE_NAME            0x02
 219 #define SOLVER_SOLVABLE_PROVIDES        0x03
 220 #define SOLVER_SOLVABLE_ONE_OF          0x04
 221
 222 #define SOLVER_SELECTMASK               0xff
 223
 224 #define SOLVER_INSTALL                  0x0100
 225 #define SOLVER_ERASE                    0x0200
 226 #define SOLVER_UPDATE                   0x0300
 227 #define SOLVER_WEAKENDEPS               0x0400
 228 #define SOLVER_NOOBSOLETES              0x0500
 229 #define SOLVER_LOCK                     0x0600
 230
 231 #define SOLVER_JOBMASK                  0xff00
 232
 233 #define SOLVER_WEAK                     0x010000
 234 #define SOLVER_ESSENTIAL                0x020000
 235
 236 /* old API compatibility, do not use in new code */
 237 #if 1
 238 #define SOLVER_INSTALL_SOLVABLE (SOLVER_INSTALL|SOLVER_SOLVABLE)
 239 #define SOLVER_ERASE_SOLVABLE (SOLVER_ERASE|SOLVER_SOLVABLE)
 240 #define SOLVER_INSTALL_SOLVABLE_NAME (SOLVER_INSTALL|SOLVER_SOLVABLE_NAME)
 241 #define SOLVER_ERASE_SOLVABLE_NAME (SOLVER_ERASE|SOLVER_SOLVABLE_NAME)
 242 #define SOLVER_INSTALL_SOLVABLE_PROVIDES (SOLVER_INSTALL|SOLVER_SOLVABLE_PROVIDES)
 243 #define SOLVER_ERASE_SOLVABLE_PROVIDES (SOLVER_ERASE|SOLVER_SOLVABLE_PROVIDES)
 244 #define SOLVER_INSTALL_SOLVABLE_UPDATE (SOLVER_UPDATE|SOLVER_SOLVABLE)
 245 #define SOLVER_INSTALL_SOLVABLE_ONE_OF (SOLVER_INSTALL|SOLVER_SOLVABLE_ONE_OF)
 246 #define SOLVER_WEAKEN_SOLVABLE_DEPS (SOLVER_WEAKENDEPS|SOLVER_SOLVABLE)
 247 #define SOLVER_NOOBSOLETES_SOLVABLE (SOLVER_NOOBSOLETES|SOLVER_SOLVABLE)
 248 #define SOLVER_NOOBSOLETES_SOLVABLE_NAME (SOLVER_NOOBSOLETES|SOLVER_SOLVABLE_NAME)
 249 #define SOLVER_NOOBSOLETES_SOLVABLE_PROVIDES (SOLVER_NOOBSOLETES|SOLVER_SOLVABLE_PROVIDES)
 250 #endif
 251
 252 typedef enum {
 253   SOLVER_PROBLEM_UPDATE_RULE,
 254   SOLVER_PROBLEM_JOB_RULE,
 255   SOLVER_PROBLEM_JOB_NOTHING_PROVIDES_DEP,
 256   SOLVER_PROBLEM_NOT_INSTALLABLE,
 257   SOLVER_PROBLEM_NOTHING_PROVIDES_DEP,
 258   SOLVER_PROBLEM_SAME_NAME,
 259   SOLVER_PROBLEM_PACKAGE_CONFLICT,
 260   SOLVER_PROBLEM_PACKAGE_OBSOLETES,
 261   SOLVER_PROBLEM_DEP_PROVIDERS_NOT_INSTALLABLE,
 262   SOLVER_PROBLEM_SELF_CONFLICT,
 263   SOLVER_PROBLEM_RPM_RULE
 264 } SolverProbleminfo;
 265
 266
 267 extern Solver *solver_create(Pool *pool);
 268 extern void solver_free(Solver *solv);
 269 extern void solver_solve(Solver *solv, Queue *job);
 270 extern int solver_dep_installed(Solver *solv, Id dep);
 271 extern int solver_splitprovides(Solver *solv, Id dep);
 272
 273 extern Id solver_next_problem(Solver *solv, Id problem);
 274 extern Id solver_next_solution(Solver *solv, Id problem, Id solution);
 275 extern Id solver_next_solutionelement(Solver *solv, Id problem, Id solution, Id element, Id *p, Id *rp);
 276 extern Id solver_findproblemrule(Solver *solv, Id problem);
 277 extern SolverProbleminfo solver_problemruleinfo(Solver *solv, Queue *job, Id rid, Id *depp, Id *sourcep, Id *targetp);
 278
 279 /* XXX: why is this not static? */
 280 Id *solver_create_decisions_obsoletesmap(Solver *solv);
 281
 282 static inline int
 283 solver_dep_fulfilled(Solver *solv, Id dep)
 284 {
 285   Pool *pool = solv->pool;
 286   Id p, pp;
 287
 288   if (ISRELDEP(dep))
 289     {
 290       Reldep *rd = GETRELDEP(pool, dep);
 291       if (rd->flags == REL_AND)
 292         {
 293           if (!solver_dep_fulfilled(solv, rd->name))
 294             return 0;
 295           return solver_dep_fulfilled(solv, rd->evr);
 296         }
 297       if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_SPLITPROVIDES)
 298         return solver_splitprovides(solv, rd->evr);
 299       if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_INSTALLED)
 300         return solver_dep_installed(solv, rd->evr);
 301     }
 302   FOR_PROVIDES(p, pp, dep)
 303     {
 304       if (solv->decisionmap[p] > 0)
 305         return 1;
 306     }
 307   return 0;
 308 }
 309
 310 static inline int
 311 solver_is_supplementing(Solver *solv, Solvable *s)
 312 {
 313   Id sup, *supp;
 314   if (!s->supplements)
 315     return 0;
 316   supp = s->repo->idarraydata + s->supplements;
 317   while ((sup = *supp++) != 0)
 318     if (solver_dep_fulfilled(solv, sup))
 319       return 1;
 320   return 0;
 321 }
 322
 323 static inline int
 324 solver_is_enhancing(Solver *solv, Solvable *s)
 325 {
 326   Id enh, *enhp;
 327   if (!s->enhances)
 328     return 0;
 329   enhp = s->repo->idarraydata + s->enhances;
 330   while ((enh = *enhp++) != 0)
 331     if (solver_dep_fulfilled(solv, enh))
 332       return 1;
 333   return 0;
 334 }
 335
 336 void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
 337 int solver_calc_installsizechange(Solver *solv);
 338
 339 void solver_find_involved(Solver *solv, Queue *installedq, Solvable *s, Queue *q);
 340
 341 static inline void
 342 solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap)
 343 {
 344   pool_create_state_maps(solv->pool, &solv->decisionq, installedmap, conflictsmap);
 345 }
 346
 347 /* iterate over all literals of a rule */
 348 /* WARNING: loop body must not relocate whatprovidesdata, e.g. by
 349  * looking up the providers of a dependency */
 350 #define FOR_RULELITERALS(l, dp, r)                              \
 351     for (l = r->d < 0 ? -r->d - 1 : r->d,                       \
 352          dp = !l ? &r->w2 : pool->whatprovidesdata + l,         \
 353          l = r->p; l; l = (dp != &r->w2 + 1 ? *dp++ : 0))
 354
 355 /* iterate over all packages selected by a job */
 356 #define FOR_JOB_SELECT(p, pp, select, what) \
 357     for (pp = (select == SOLVER_SOLVABLE ? 0 :  \
 358                select == SOLVER_SOLVABLE_ONE_OF ? what : \
 359                pool_whatprovides(pool, what)),                          \
 360          p = (select == SOLVER_SOLVABLE ? what : pool->whatprovidesdata[pp++]) ; p ; p = pool->whatprovidesdata[pp++]) \
 361       if (select != SOLVER_SOLVABLE_NAME || pool_match_nevr(pool, pool->solvables + p, what))
 362
 363 #ifdef __cplusplus
 364 }
 365 #endif
 366
 367 #endif /* SATSOLVER_SOLVER_H */