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