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   Queue job;                            /* copy of the job we're solving */
  65
  66   Repo *installed;                      /* copy of pool->installed */
  67
  68   /* list of rules, ordered
  69    * rpm rules first, then features, updates, jobs, learnt
  70    * see start/end offsets below
  71    */
  72   Rule *rules;                          /* all rules */
  73   Id nrules;                            /* [Offset] index of the last rule */
  74
  75   Queue ruleassertions;                 /* Queue of all assertion rules */
  76
  77   /* start/end offset for rule 'areas' */
  78
  79   Id rpmrules_end;                      /* [Offset] rpm rules end */
  80
  81   Id featurerules;                      /* feature rules start/end */
  82   Id featurerules_end;
  83
  84   Id updaterules;                       /* policy rules, e.g. keep packages installed or update. All literals > 0 */
  85   Id updaterules_end;
  86
  87   Id jobrules;                          /* user rules */
  88   Id jobrules_end;
  89
  90   Id infarchrules;                      /* inferior arch rules */
  91   Id infarchrules_end;
  92
  93   Id duprules;                          /* dist upgrade rules */
  94   Id duprules_end;
  95
  96   Id learntrules;                       /* learnt rules, (end == nrules) */
  97
  98   Map noupdate;                         /* don't try to update these
  99                                            installed solvables */
 100   Map noobsoletes;                      /* ignore obsoletes for these
 101                                            (multiinstall) */
 102
 103   Map updatemap;                        /* bring those packages to the newest version */
 104   Queue weakruleq;                      /* index into 'rules' for weak ones */
 105   Map weakrulemap;                      /* map rule# to '1' for weak rules, 1..learntrules */
 106
 107   Id *watches;                          /* Array of rule offsets
 108                                          * watches has nsolvables*2 entries and is addressed from the middle
 109                                          * middle-solvable : decision to conflict, offset point to linked-list of rules
 110                                          * middle+solvable : decision to install: offset point to linked-list of rules
 111                                          */
 112
 113   Queue ruletojob;                      /* index into job queue: jobs for which a rule exits */
 114
 115   /* our decisions: */
 116   Queue decisionq;                      /* >0:install, <0:remove/conflict */
 117   Queue decisionq_why;                  /* index of rule, Offset into rules */
 118   int directdecisions;                  /* number of decisions with no rule */
 119
 120   Id *decisionmap;                      /* map for all available solvables,
 121                                          * = 0: undecided
 122                                          * > 0: level of decision when installed,
 123                                          * < 0: level of decision when conflict */
 124
 125   /* learnt rule history */
 126   Queue learnt_why;
 127   Queue learnt_pool;
 128
 129   Queue branches;
 130   int (*solution_callback)(struct solver *solv, void *data);
 131   void *solution_callback_data;
 132
 133   int propagate_index;                  /* index into decisionq for non-propagated decisions */
 134
 135   Queue problems;                       /* index of conflicting rules, < 0 for job rules */
 136   Queue recommendations;                /* recommended packages */
 137   Queue suggestions;                    /* suggested packages */
 138   Queue orphaned;                       /* orphaned packages */
 139
 140   int stats_learned;                    /* statistic */
 141   int stats_unsolvable;                 /* statistic */
 142
 143   Map recommendsmap;                    /* recommended packages from decisionmap */
 144   Map suggestsmap;                      /* suggested packages from decisionmap */
 145   int recommends_index;                 /* recommendsmap/suggestsmap is created up to this level */
 146
 147   Id *obsoletes;                        /* obsoletes for each installed solvable */
 148   Id *obsoletes_data;                   /* data area for obsoletes */
 149   Id *multiversionupdaters;             /* updaters for multiversion packages in updatesystem mode */
 150
 151   /*-------------------------------------------------------------------------------------------------------------
 152    * Solver configuration
 153    *-------------------------------------------------------------------------------------------------------------*/
 154
 155   int fixsystem;                        /* repair errors in rpm dependency graph */
 156   int allowdowngrade;                   /* allow to downgrade installed solvable */
 157   int allowarchchange;                  /* allow to change architecture of installed solvables */
 158   int allowvendorchange;                /* allow to change vendor of installed solvables */
 159   int allowuninstall;                   /* allow removal of installed solvables */
 160   int updatesystem;                     /* distupgrade */
 161   int allowvirtualconflicts;            /* false: conflicts on package name, true: conflicts on package provides */
 162   int allowselfconflicts;               /* true: packages wich conflict with itself are installable */
 163   int obsoleteusesprovides;             /* true: obsoletes are matched against provides, not names */
 164   int implicitobsoleteusesprovides;     /* true: implicit obsoletes due to same name are matched against provides, not names */
 165   int noupdateprovide;                  /* true: update packages needs not to provide old package */
 166   int dosplitprovides;                  /* true: consider legacy split provides */
 167   int dontinstallrecommended;           /* true: do not install recommended packages */
 168   int ignorealreadyrecommended;         /* true: ignore recommended packages that were already recommended by the installed packages */
 169   int dontshowinstalledrecommended;     /* true: do not show recommended packages that are already installed */
 170
 171   /* distupgrade also needs updatesystem and dosplitprovides */
 172   int distupgrade;
 173   int distupgrade_removeunsupported;
 174
 175   int noinfarchcheck;                   /* true: do not forbid inferior architectures */
 176
 177   /* Callbacks for defining the bahaviour of the SAT solver */
 178
 179   /* Finding best candidate
 180    *
 181    * Callback definition:
 182    * void  bestSolvable (Pool *pool, Queue *canditates)
 183    *     candidates       : List of canditates which has to be sorted by the function call
 184    *     return candidates: Sorted list of the candidates(first is the best).
 185    */
 186    BestSolvableCb bestSolvableCb;
 187
 188   /* Checking if two solvables has compatible architectures
 189    *
 190    * Callback definition:
 191    *     int  archCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
 192    *
 193    *     return 0 it the two solvables has compatible architectures
 194    */
 195    ArchCheckCb archCheckCb;
 196
 197   /* Checking if two solvables has compatible vendors
 198    *
 199    * Callback definition:
 200    *     int  vendorCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
 201    *
 202    *     return 0 it the two solvables has compatible architectures
 203    */
 204    VendorCheckCb vendorCheckCb;
 205
 206   /* Evaluate update candidate
 207    *
 208    * Callback definition:
 209    * void pdateCandidateCb (Pool *pool, Solvable *solvable, Queue *canditates)
 210    *     solvable   : for which updates should be search
 211    *     candidates : List of candidates (This list depends on other
 212    *                  restrictions like architecture and vendor policies too)
 213    */
 214    UpdateCandidateCb   updateCandidateCb;
 215
 216
 217   /* some strange queue that doesn't belong here */
 218   Queue covenantq;                      /* Covenants honored by this solver (generic locks) */
 219
 220
 221   Map dupmap;                           /* packages from dup repos */
 222   Map dupinvolvedmap;                   /* packages involved in dup process */
 223
 224   Queue *ruleinfoq;                     /* tmp space for solver_ruleinfo() */
 225 } Solver;
 226
 227 /*
 228  * queue commands
 229  */
 230
 231 #define SOLVER_SOLVABLE                 0x01
 232 #define SOLVER_SOLVABLE_NAME            0x02
 233 #define SOLVER_SOLVABLE_PROVIDES        0x03
 234 #define SOLVER_SOLVABLE_ONE_OF          0x04
 235
 236 #define SOLVER_SELECTMASK               0xff
 237
 238 #define SOLVER_NOOP                     0x0000
 239 #define SOLVER_INSTALL                  0x0100
 240 #define SOLVER_ERASE                    0x0200
 241 #define SOLVER_UPDATE                   0x0300
 242 #define SOLVER_WEAKENDEPS               0x0400
 243 #define SOLVER_NOOBSOLETES              0x0500
 244 #define SOLVER_LOCK                     0x0600
 245 #define SOLVER_DISTUPGRADE              0x0700
 246
 247 #define SOLVER_JOBMASK                  0xff00
 248
 249 #define SOLVER_WEAK                     0x010000
 250 #define SOLVER_ESSENTIAL                0x020000
 251
 252 /* old API compatibility, do not use in new code */
 253 #if 1
 254 #define SOLVER_INSTALL_SOLVABLE (SOLVER_INSTALL|SOLVER_SOLVABLE)
 255 #define SOLVER_ERASE_SOLVABLE (SOLVER_ERASE|SOLVER_SOLVABLE)
 256 #define SOLVER_INSTALL_SOLVABLE_NAME (SOLVER_INSTALL|SOLVER_SOLVABLE_NAME)
 257 #define SOLVER_ERASE_SOLVABLE_NAME (SOLVER_ERASE|SOLVER_SOLVABLE_NAME)
 258 #define SOLVER_INSTALL_SOLVABLE_PROVIDES (SOLVER_INSTALL|SOLVER_SOLVABLE_PROVIDES)
 259 #define SOLVER_ERASE_SOLVABLE_PROVIDES (SOLVER_ERASE|SOLVER_SOLVABLE_PROVIDES)
 260 #define SOLVER_INSTALL_SOLVABLE_UPDATE (SOLVER_UPDATE|SOLVER_SOLVABLE)
 261 #define SOLVER_INSTALL_SOLVABLE_ONE_OF (SOLVER_INSTALL|SOLVER_SOLVABLE_ONE_OF)
 262 #define SOLVER_WEAKEN_SOLVABLE_DEPS (SOLVER_WEAKENDEPS|SOLVER_SOLVABLE)
 263 #define SOLVER_NOOBSOLETES_SOLVABLE (SOLVER_NOOBSOLETES|SOLVER_SOLVABLE)
 264 #define SOLVER_NOOBSOLETES_SOLVABLE_NAME (SOLVER_NOOBSOLETES|SOLVER_SOLVABLE_NAME)
 265 #define SOLVER_NOOBSOLETES_SOLVABLE_PROVIDES (SOLVER_NOOBSOLETES|SOLVER_SOLVABLE_PROVIDES)
 266 #endif
 267
 268 typedef enum {
 269   SOLVER_PROBLEM_UPDATE_RULE,
 270   SOLVER_PROBLEM_JOB_RULE,
 271   SOLVER_PROBLEM_JOB_NOTHING_PROVIDES_DEP,
 272   SOLVER_PROBLEM_NOT_INSTALLABLE,
 273   SOLVER_PROBLEM_NOTHING_PROVIDES_DEP,
 274   SOLVER_PROBLEM_SAME_NAME,
 275   SOLVER_PROBLEM_PACKAGE_CONFLICT,
 276   SOLVER_PROBLEM_PACKAGE_OBSOLETES,
 277   SOLVER_PROBLEM_DEP_PROVIDERS_NOT_INSTALLABLE,
 278   SOLVER_PROBLEM_SELF_CONFLICT,
 279   SOLVER_PROBLEM_RPM_RULE,
 280   SOLVER_PROBLEM_DISTUPGRADE_RULE,
 281   SOLVER_PROBLEM_INFARCH_RULE
 282 } SolverProbleminfo;
 283
 284 typedef enum {
 285   SOLVER_RULE_UNKNOWN = 0,
 286   SOLVER_RULE_RPM = 0x100,
 287   SOLVER_RULE_RPM_NOT_INSTALLABLE,
 288   SOLVER_RULE_RPM_NOTHING_PROVIDES_DEP,
 289   SOLVER_RULE_RPM_PACKAGE_REQUIRES,
 290   SOLVER_RULE_RPM_SELF_CONFLICT,
 291   SOLVER_RULE_RPM_PACKAGE_CONFLICT,
 292   SOLVER_RULE_RPM_SAME_NAME,
 293   SOLVER_RULE_RPM_PACKAGE_OBSOLETES,
 294   SOLVER_RULE_RPM_IMPLICIT_OBSOLETES,
 295   SOLVER_RULE_UPDATE = 0x200,
 296   SOLVER_RULE_FEATURE = 0x300,
 297   SOLVER_RULE_JOB = 0x400,
 298   SOLVER_RULE_JOB_NOTHING_PROVIDES_DEP,
 299   SOLVER_RULE_DISTUPGRADE = 0x500,
 300   SOLVER_RULE_INFARCH = 0x600,
 301   SOLVER_RULE_LEARNT = 0x700
 302 } SolverRuleinfo;
 303
 304 #define SOLVER_RULE_TYPEMASK    0xff00
 305
 306 /* backward compatibility */
 307 #define SOLVER_PROBLEM_UPDATE_RULE              SOLVER_RULE_UPDATE
 308 #define SOLVER_PROBLEM_JOB_RULE                 SOLVER_RULE_JOB
 309 #define SOLVER_PROBLEM_JOB_NOTHING_PROVIDES_DEP SOLVER_RULE_JOB_NOTHING_PROVIDES_DEP
 310 #define SOLVER_PROBLEM_NOT_INSTALLABLE          SOLVER_RULE_RPM_NOT_INSTALLABLE
 311 #define SOLVER_PROBLEM_NOTHING_PROVIDES_DEP     SOLVER_RULE_RPM_NOTHING_PROVIDES_DEP
 312 #define SOLVER_PROBLEM_SAME_NAME                SOLVER_RULE_RPM_SAME_NAME
 313 #define SOLVER_PROBLEM_PACKAGE_CONFLICT         SOLVER_RULE_RPM_PACKAGE_CONFLICT
 314 #define SOLVER_PROBLEM_PACKAGE_OBSOLETES        SOLVER_RULE_RPM_PACKAGE_OBSOLETES
 315 #define SOLVER_PROBLEM_DEP_PROVIDERS_NOT_INSTALLABLE SOLVER_RULE_RPM_PACKAGE_REQUIRES
 316 #define SOLVER_PROBLEM_SELF_CONFLICT            SOLVER_RULE_RPM_SELF_CONFLICT
 317 #define SOLVER_PROBLEM_RPM_RULE                 SOLVER_RULE_RPM
 318 #define SOLVER_PROBLEM_DISTUPGRADE_RULE         SOLVER_RULE_DISTUPGRADE
 319 #define SOLVER_PROBLEM_INFARCH_RULE             SOLVER_RULE_INFARCH
 320
 321
 322 #define SOLVER_SOLUTION_JOB             (0)
 323 #define SOLVER_SOLUTION_DISTUPGRADE     (-1)
 324 #define SOLVER_SOLUTION_INFARCH         (-2)
 325
 326 extern Solver *solver_create(Pool *pool);
 327 extern void solver_free(Solver *solv);
 328 extern void solver_solve(Solver *solv, Queue *job);
 329 extern int solver_dep_installed(Solver *solv, Id dep);
 330 extern int solver_splitprovides(Solver *solv, Id dep);
 331
 332 extern Id solver_next_problem(Solver *solv, Id problem);
 333 extern Id solver_next_solution(Solver *solv, Id problem, Id solution);
 334 extern Id solver_next_solutionelement(Solver *solv, Id problem, Id solution, Id element, Id *p, Id *rp);
 335 extern Id solver_findproblemrule(Solver *solv, Id problem);
 336 extern void solver_findallproblemrules(Solver *solv, Id problem, Queue *rules);
 337
 338 extern SolverRuleinfo solver_problemruleinfo(Solver *solv, Queue *job, Id rid, Id *depp, Id *sourcep, Id *targetp);
 339 extern SolverRuleinfo solver_ruleinfo(Solver *solv, Id rid, Id *fromp, Id *top, Id *depp);
 340 extern int solver_allruleinfos(Solver *solv, Id rid, Queue *rq);
 341
 342 /* XXX: why is this not static? */
 343 Id *solver_create_decisions_obsoletesmap(Solver *solv);
 344
 345 static inline int
 346 solver_dep_fulfilled(Solver *solv, Id dep)
 347 {
 348   Pool *pool = solv->pool;
 349   Id p, pp;
 350
 351   if (ISRELDEP(dep))
 352     {
 353       Reldep *rd = GETRELDEP(pool, dep);
 354       if (rd->flags == REL_AND)
 355         {
 356           if (!solver_dep_fulfilled(solv, rd->name))
 357             return 0;
 358           return solver_dep_fulfilled(solv, rd->evr);
 359         }
 360       if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_SPLITPROVIDES)
 361         return solver_splitprovides(solv, rd->evr);
 362       if (rd->flags == REL_NAMESPACE && rd->name == NAMESPACE_INSTALLED)
 363         return solver_dep_installed(solv, rd->evr);
 364     }
 365   FOR_PROVIDES(p, pp, dep)
 366     {
 367       if (solv->decisionmap[p] > 0)
 368         return 1;
 369     }
 370   return 0;
 371 }
 372
 373 static inline int
 374 solver_is_supplementing(Solver *solv, Solvable *s)
 375 {
 376   Id sup, *supp;
 377   if (!s->supplements)
 378     return 0;
 379   supp = s->repo->idarraydata + s->supplements;
 380   while ((sup = *supp++) != 0)
 381     if (solver_dep_fulfilled(solv, sup))
 382       return 1;
 383   return 0;
 384 }
 385
 386 static inline int
 387 solver_is_enhancing(Solver *solv, Solvable *s)
 388 {
 389   Id enh, *enhp;
 390   if (!s->enhances)
 391     return 0;
 392   enhp = s->repo->idarraydata + s->enhances;
 393   while ((enh = *enhp++) != 0)
 394     if (solver_dep_fulfilled(solv, enh))
 395       return 1;
 396   return 0;
 397 }
 398
 399 void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
 400 int solver_calc_installsizechange(Solver *solv);
 401 void solver_trivial_installable(Solver *solv, Queue *pkgs, Queue *res);
 402
 403 void solver_find_involved(Solver *solv, Queue *installedq, Solvable *s, Queue *q);
 404
 405 static inline void
 406 solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap)
 407 {
 408   pool_create_state_maps(solv->pool, &solv->decisionq, installedmap, conflictsmap);
 409 }
 410
 411 /* iterate over all literals of a rule */
 412 /* WARNING: loop body must not relocate whatprovidesdata, e.g. by
 413  * looking up the providers of a dependency */
 414 #define FOR_RULELITERALS(l, dp, r)                              \
 415     for (l = r->d < 0 ? -r->d - 1 : r->d,                       \
 416          dp = !l ? &r->w2 : pool->whatprovidesdata + l,         \
 417          l = r->p; l; l = (dp != &r->w2 + 1 ? *dp++ : 0))
 418
 419 /* iterate over all packages selected by a job */
 420 #define FOR_JOB_SELECT(p, pp, select, what) \
 421     for (pp = (select == SOLVER_SOLVABLE ? 0 :  \
 422                select == SOLVER_SOLVABLE_ONE_OF ? what : \
 423                pool_whatprovides(pool, what)),                          \
 424          p = (select == SOLVER_SOLVABLE ? what : pool->whatprovidesdata[pp++]) ; p ; p = pool->whatprovidesdata[pp++]) \
 425       if (select != SOLVER_SOLVABLE_NAME || pool_match_nevr(pool, pool->solvables + p, what))
 426
 427 #ifdef __cplusplus
 428 }
 429 #endif
 430
 431 #endif /* SATSOLVER_SOLVER_H */