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   Id w1, w2;            /* watches, literals not-yet-decided */
  55                                        /* if !w1, disabled */
  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   Rule *rules;                          /* all rules */
  67   Id nrules;                            /* index of the last rule */
  68
  69   Id jobrules;                          /* user rules */
  70   Id updaterules;                       /* policy rules, e.g. keep packages installed or update. All literals > 0 */
  71   Id featurerules;                      /* feature rules */
  72   Id learntrules;                       /* learnt rules */
  73
  74   Map noupdate;                         /* don't try to update these
  75                                            installed solvables */
  76   Queue weakruleq;
  77   Map weakrulemap;
  78
  79   Id *watches;                          /* Array of rule offsets
  80                                          * watches has nsolvables*2 entries and is addressed from the middle
  81                                          * middle-solvable : decision to conflict, offset point to linked-list of rules
  82                                          * middle+solvable : decision to install: offset point to linked-list of rules
  83                                          */
  84
  85   Queue ruletojob;
  86
  87   /* our decisions: */
  88   Queue decisionq;
  89   Queue decisionq_why;                  /* index of rule, Offset into rules */
  90   int directdecisions;                  /* number of decisions with no rule */
  91
  92   Id *decisionmap;                      /* map for all available solvables, > 0: level of decision when installed, < 0 level of decision when conflict */
  93
  94   /* learnt rule history */
  95   Queue learnt_why;
  96   Queue learnt_pool;
  97
  98   Queue branches;
  99   int (*solution_callback)(struct solver *solv, void *data);
 100   void *solution_callback_data;
 101
 102   int propagate_index;
 103
 104   Queue problems;
 105   Queue recommendations;                /* recommended packages */
 106   Queue suggestions;                    /* suggested packages */
 107
 108
 109   Map recommendsmap;                    /* recommended packages from decisionmap */
 110   Map suggestsmap;                      /* suggested packages from decisionmap */
 111   int recommends_index;                 /* recommendsmap/suggestsmap is created up to this level */
 112
 113   Id *obsoletes;                        /* obsoletes for each installed solvable */
 114   Id *obsoletes_data;                   /* data area for obsoletes */
 115
 116   /*-------------------------------------------------------------------------------------------------------------
 117    * Solver configuration
 118    *-------------------------------------------------------------------------------------------------------------*/
 119
 120   int fixsystem;                        /* repair errors in rpm dependency graph */
 121   int allowdowngrade;                   /* allow to downgrade installed solvable */
 122   int allowarchchange;                  /* allow to change architecture of installed solvables */
 123   int allowvendorchange;                /* allow to change vendor of installed solvables */
 124   int allowuninstall;                   /* allow removal of installed solvables */
 125   int updatesystem;                     /* distupgrade */
 126   int allowvirtualconflicts;            /* false: conflicts on package name, true: conflicts on package provides */
 127   int allowselfconflicts;               /* true: packages wich conflict with itself are installable */
 128   int noupdateprovide;                  /* true: update packages needs not to provide old package */
 129   int dosplitprovides;                  /* true: consider legacy split provides */
 130   int dontinstallrecommended;           /* true: do not install recommended packages */
 131   int showinstalledrecommended;         /* true: add recommened packages that are already installed to the lists */
 132
 133   /* Callbacks for defining the bahaviour of the SAT solver */
 134
 135   /* Finding best candidate
 136    *
 137    * Callback definition:
 138    * void  bestSolvable (Pool *pool, Queue *canditates)
 139    *     candidates       : List of canditates which has to be sorted by the function call
 140    *     return candidates: Sorted list of the candidates(first is the best).
 141    */
 142    BestSolvableCb bestSolvableCb;
 143
 144   /* Checking if two solvables has compatible architectures
 145    *
 146    * Callback definition:
 147    *     int  archCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
 148    *
 149    *     return 0 it the two solvables has compatible architectures
 150    */
 151    ArchCheckCb archCheckCb;
 152
 153   /* Checking if two solvables has compatible vendors
 154    *
 155    * Callback definition:
 156    *     int  vendorCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
 157    *
 158    *     return 0 it the two solvables has compatible architectures
 159    */
 160    VendorCheckCb vendorCheckCb;
 161
 162   /* Evaluate update candidate
 163    *
 164    * Callback definition:
 165    * void pdateCandidateCb (Pool *pool, Solvable *solvable, Queue *canditates)
 166    *     solvable   : for which updates should be search
 167    *     candidates : List of candidates (This list depends on other
 168    *                  restrictions like architecture and vendor policies too)
 169    */
 170    UpdateCandidateCb   updateCandidateCb;
 171
 172
 173   /* some strange queue that doesn't belong here */
 174
 175   Queue covenantq;                      /* Covenants honored by this solver (generic locks) */
 176
 177
 178 } Solver;
 179
 180 /*
 181  * queue commands
 182  */
 183
 184 typedef enum {
 185   SOLVCMD_NULL=0,
 186   SOLVER_INSTALL_SOLVABLE,
 187   SOLVER_ERASE_SOLVABLE,
 188   SOLVER_INSTALL_SOLVABLE_NAME,
 189   SOLVER_ERASE_SOLVABLE_NAME,
 190   SOLVER_INSTALL_SOLVABLE_PROVIDES,
 191   SOLVER_ERASE_SOLVABLE_PROVIDES,
 192   SOLVER_INSTALL_SOLVABLE_UPDATE,
 193   SOLVER_INSTALL_SOLVABLE_ONE_OF,
 194   SOLVER_WEAKEN_SOLVABLE_DEPS,
 195   SOLVER_WEAK = 0x100,
 196 } SolverCmd;
 197
 198 typedef enum {
 199   SOLVER_PROBLEM_UPDATE_RULE,
 200   SOLVER_PROBLEM_JOB_RULE,
 201   SOLVER_PROBLEM_JOB_NOTHING_PROVIDES_DEP,
 202   SOLVER_PROBLEM_NOT_INSTALLABLE,
 203   SOLVER_PROBLEM_NOTHING_PROVIDES_DEP,
 204   SOLVER_PROBLEM_SAME_NAME,
 205   SOLVER_PROBLEM_PACKAGE_CONFLICT,
 206   SOLVER_PROBLEM_PACKAGE_OBSOLETES,
 207   SOLVER_PROBLEM_DEP_PROVIDERS_NOT_INSTALLABLE,
 208   SOLVER_PROBLEM_SELF_CONFLICT
 209 } SolverProbleminfo;
 210
 211
 212 extern Solver *solver_create(Pool *pool, Repo *installed);
 213 extern void solver_free(Solver *solv);
 214 extern void solver_solve(Solver *solv, Queue *job);
 215 extern int solver_dep_installed(Solver *solv, Id dep);
 216 extern int solver_splitprovides(Solver *solv, Id dep);
 217
 218 extern Id solver_next_problem(Solver *solv, Id problem);
 219 extern Id solver_next_solution(Solver *solv, Id problem, Id solution);
 220 extern Id solver_next_solutionelement(Solver *solv, Id problem, Id solution, Id element, Id *p, Id *rp);
 221 extern Id solver_findproblemrule(Solver *solv, Id problem);
 222 extern SolverProbleminfo solver_problemruleinfo(Solver *solv, Queue *job, Id rid, Id *depp, Id *sourcep, Id *targetp);
 223
 224 /* XXX: why is this not static? */
 225 Id *create_decisions_obsoletesmap(Solver *solv);
 226
 227 static inline int
 228 solver_dep_fulfilled(Solver *solv, Id dep)
 229 {
 230   Pool *pool = solv->pool;
 231   Id p, *pp;
 232
 233   if (ISRELDEP(dep))
 234     {
 235       Reldep *rd = GETRELDEP(pool, dep);
 236       if (rd->flags == REL_AND)
 237         {
 238           if (!solver_dep_fulfilled(solv, rd->name))
 239             return 0;
 240           return solver_dep_fulfilled(solv, rd->evr);
 241         }
 242       if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_SPLITPROVIDES)
 243         return solver_splitprovides(solv, rd->evr);
 244       if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_INSTALLED)
 245         return solver_dep_installed(solv, rd->evr);
 246     }
 247   FOR_PROVIDES(p, pp, dep)
 248     {
 249       if (solv->decisionmap[p] > 0)
 250         return 1;
 251     }
 252   return 0;
 253 }
 254
 255 static inline int
 256 solver_is_supplementing(Solver *solv, Solvable *s)
 257 {
 258   Id sup, *supp;
 259   if (!s->supplements && !s->freshens)
 260     return 0;
 261   if (s->supplements)
 262     {
 263       supp = s->repo->idarraydata + s->supplements;
 264       while ((sup = *supp++) != 0)
 265         if (solver_dep_fulfilled(solv, sup))
 266           break;
 267       if (!sup)
 268         return 0;
 269     }
 270   if (s->freshens)
 271     {
 272       supp = s->repo->idarraydata + s->freshens;
 273       while ((sup = *supp++) != 0)
 274         if (solver_dep_fulfilled(solv, sup))
 275           break;
 276       if (!sup)
 277         return 0;
 278     }
 279   return 1;
 280 }
 281
 282 static inline int
 283 solver_is_enhancing(Solver *solv, Solvable *s)
 284 {
 285   Id enh, *enhp;
 286   if (!s->enhances)
 287     return 0;
 288   enhp = s->repo->idarraydata + s->enhances;
 289   while ((enh = *enhp++) != 0)
 290     if (solver_dep_fulfilled(solv, enh))
 291       return 1;
 292   return 0;
 293 }
 294
 295 void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
 296 int solver_calc_installsizechange(Solver *solv);
 297
 298 static inline void
 299 solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap)
 300 {
 301   pool_create_state_maps(solv->pool, &solv->decisionq, installedmap, conflictsmap);
 302 }
 303
 304 #ifdef __cplusplus
 305 }
 306 #endif
 307
 308 #endif /* SATSOLVER_SOLVER_H */