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