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