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 LIBSOLV_SOLVER_H
  14 #define LIBSOLV_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   Pool *pool;                           /* back pointer to pool */
  41   Queue job;                            /* copy of the job we're solving */
  42
  43   int (*solution_callback)(struct _Solver *solv, void *data);
  44   void *solution_callback_data;
  45
  46   /* Callbacks for defining the bahaviour of the solver */
  47
  48   /* Finding best candidate
  49    *
  50    * Callback definition:
  51    * void  bestSolvable (Pool *pool, Queue *canditates)
  52    *     candidates       : List of canditates which has to be sorted by the function call
  53    *     return candidates: Sorted list of the candidates(first is the best).
  54    */
  55   BestSolvableCb bestSolvableCb;
  56
  57   /* Checking if two solvables has compatible architectures
  58    *
  59    * Callback definition:
  60    *     int  archCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
  61    *
  62    *     return 0 it the two solvables has compatible architectures
  63    */
  64   ArchCheckCb archCheckCb;
  65
  66   /* Checking if two solvables has compatible vendors
  67    *
  68    * Callback definition:
  69    *     int  vendorCheck (Pool *pool, Solvable *solvable1, Solvable *solvable2);
  70    *
  71    *     return 0 it the two solvables has compatible architectures
  72    */
  73   VendorCheckCb vendorCheckCb;
  74
  75   /* Evaluate update candidate
  76    *
  77    * Callback definition:
  78    * void UpdateCandidateCb (Pool *pool, Solvable *solvable, Queue *canditates)
  79    *     solvable   : for which updates should be search
  80    *     candidates : List of candidates (This list depends on other
  81    *                  restrictions like architecture and vendor policies too)
  82    */
  83   UpdateCandidateCb   updateCandidateCb;
  84
  85 #ifdef LIBSOLV_INTERNAL
  86   Repo *installed;                      /* copy of pool->installed */
  87
  88   /* list of rules, ordered
  89    * rpm rules first, then features, updates, jobs, learnt
  90    * see start/end offsets below
  91    */
  92   Rule *rules;                          /* all rules */
  93   Id nrules;                            /* [Offset] index of the last rule */
  94
  95   Queue ruleassertions;                 /* Queue of all assertion rules */
  96
  97   /* start/end offset for rule 'areas' */
  98
  99   Id rpmrules_end;                      /* [Offset] rpm rules end */
 100
 101   Id featurerules;                      /* feature rules start/end */
 102   Id featurerules_end;
 103
 104   Id updaterules;                       /* policy rules, e.g. keep packages installed or update. All literals > 0 */
 105   Id updaterules_end;
 106
 107   Id jobrules;                          /* user rules */
 108   Id jobrules_end;
 109
 110   Id infarchrules;                      /* inferior arch rules */
 111   Id infarchrules_end;
 112
 113   Id duprules;                          /* dist upgrade rules */
 114   Id duprules_end;
 115
 116   Id choicerules;                       /* choice rules (always weak) */
 117   Id choicerules_end;
 118   Id *choicerules_ref;
 119
 120   Id learntrules;                       /* learnt rules, (end == nrules) */
 121
 122   Map noupdate;                         /* don't try to update these
 123                                            installed solvables */
 124   Map noobsoletes;                      /* ignore obsoletes for these (multiinstall) */
 125
 126   Map updatemap;                        /* bring these installed packages to the newest version */
 127   int updatemap_all;                    /* bring all packages to the newest version */
 128
 129   Map fixmap;                           /* fix these packages */
 130   int fixmap_all;                       /* fix all packages */
 131
 132   Queue weakruleq;                      /* index into 'rules' for weak ones */
 133   Map weakrulemap;                      /* map rule# to '1' for weak rules, 1..learntrules */
 134
 135   Id *watches;                          /* Array of rule offsets
 136                                          * watches has nsolvables*2 entries and is addressed from the middle
 137                                          * middle-solvable : decision to conflict, offset point to linked-list of rules
 138                                          * middle+solvable : decision to install: offset point to linked-list of rules
 139                                          */
 140
 141   Queue ruletojob;                      /* index into job queue: jobs for which a rule exits */
 142
 143   /* our decisions: */
 144   Queue decisionq;                      /* >0:install, <0:remove/conflict */
 145   Queue decisionq_why;                  /* index of rule, Offset into rules */
 146
 147   Id *decisionmap;                      /* map for all available solvables,
 148                                          * = 0: undecided
 149                                          * > 0: level of decision when installed,
 150                                          * < 0: level of decision when conflict */
 151
 152   int decisioncnt_update;
 153   int decisioncnt_keep;
 154   int decisioncnt_resolve;
 155   int decisioncnt_weak;
 156   int decisioncnt_orphan;
 157
 158   /* learnt rule history */
 159   Queue learnt_why;
 160   Queue learnt_pool;
 161
 162   Queue branches;
 163   int propagate_index;                  /* index into decisionq for non-propagated decisions */
 164
 165   Queue problems;                       /* list of lists of conflicting rules, < 0 for job rules */
 166   Queue solutions;                      /* refined problem storage space */
 167
 168   Queue orphaned;                       /* orphaned packages (to be removed?) */
 169
 170   int stats_learned;                    /* statistic */
 171   int stats_unsolvable;                 /* statistic */
 172
 173   Map recommendsmap;                    /* recommended packages from decisionmap */
 174   Map suggestsmap;                      /* suggested packages from decisionmap */
 175   int recommends_index;                 /* recommendsmap/suggestsmap is created up to this level */
 176
 177   Id *obsoletes;                        /* obsoletes for each installed solvable */
 178   Id *obsoletes_data;                   /* data area for obsoletes */
 179   Id *multiversionupdaters;             /* updaters for multiversion packages in updatesystem mode */
 180
 181   /*-------------------------------------------------------------------------------------------------------------
 182    * Solver configuration
 183    *-------------------------------------------------------------------------------------------------------------*/
 184
 185   int allowdowngrade;                   /* allow to downgrade installed solvable */
 186   int allowarchchange;                  /* allow to change architecture of installed solvables */
 187   int allowvendorchange;                /* allow to change vendor of installed solvables */
 188   int allowuninstall;                   /* allow removal of installed solvables */
 189   int noupdateprovide;                  /* true: update packages needs not to provide old package */
 190   int dosplitprovides;                  /* true: consider legacy split provides */
 191   int dontinstallrecommended;           /* true: do not install recommended packages */
 192   int addalreadyrecommended;            /* true: also install recommended packages that were already recommended by the installed packages */
 193   int dontshowinstalledrecommended;     /* true: do not show recommended packages that are already installed */
 194
 195   int noinfarchcheck;                   /* true: do not forbid inferior architectures */
 196
 197
 198   Map dupmap;                           /* dup these packages*/
 199   int dupmap_all;                       /* dup all packages */
 200   Map dupinvolvedmap;                   /* packages involved in dup process */
 201   int dup_allowdowngrade;               /* dup mode: allow to downgrade installed solvable */
 202   int dup_allowarchchange;              /* dup mode: allow to change architecture of installed solvables */
 203   int dup_allowvendorchange;            /* dup mode: allow to change vendor of installed solvables */
 204
 205   Map droporphanedmap;                  /* packages to drop in dup mode */
 206   int droporphanedmap_all;
 207
 208   Map cleandepsmap;                     /* try to drop these packages as of cleandeps erases */
 209
 210   Queue *ruleinfoq;                     /* tmp space for solver_ruleinfo() */
 211
 212   Queue *cleandeps_updatepkgs;          /* packages we update in cleandeps mode */
 213   Queue *cleandeps_mistakes;            /* mistakes we made */
 214 #endif  /* LIBSOLV_INTERNAL */
 215 };
 216
 217 typedef struct _Solver Solver;
 218
 219 /*
 220  * queue commands
 221  */
 222
 223 #define SOLVER_SOLVABLE                 0x01
 224 #define SOLVER_SOLVABLE_NAME            0x02
 225 #define SOLVER_SOLVABLE_PROVIDES        0x03
 226 #define SOLVER_SOLVABLE_ONE_OF          0x04
 227 #define SOLVER_SOLVABLE_REPO            0x05
 228 #define SOLVER_SOLVABLE_ALL             0x06
 229
 230 #define SOLVER_SELECTMASK               0xff
 231
 232 #define SOLVER_NOOP                     0x0000
 233 #define SOLVER_INSTALL                  0x0100
 234 #define SOLVER_ERASE                    0x0200
 235 #define SOLVER_UPDATE                   0x0300
 236 #define SOLVER_WEAKENDEPS               0x0400
 237 #define SOLVER_NOOBSOLETES              0x0500
 238 #define SOLVER_LOCK                     0x0600
 239 #define SOLVER_DISTUPGRADE              0x0700
 240 #define SOLVER_VERIFY                   0x0800
 241 #define SOLVER_DROP_ORPHANED            0x0900
 242 #define SOLVER_USERINSTALLED            0x0a00
 243
 244 #define SOLVER_JOBMASK                  0xff00
 245
 246 #define SOLVER_WEAK                     0x010000
 247 #define SOLVER_ESSENTIAL                0x020000
 248 #define SOLVER_CLEANDEPS                0x040000
 249
 250 #define SOLVER_SETEV                    0x01000000
 251 #define SOLVER_SETEVR                   0x02000000
 252 #define SOLVER_SETARCH                  0x04000000
 253 #define SOLVER_SETVENDOR                0x08000000
 254 #define SOLVER_SETREPO                  0x10000000
 255 #define SOLVER_NOAUTOSET                0x20000000
 256
 257 #define SOLVER_SETMASK                  0x2f000000
 258
 259 #define SOLVER_REASON_UNRELATED         0
 260 #define SOLVER_REASON_UNIT_RULE         1
 261 #define SOLVER_REASON_KEEP_INSTALLED    2
 262 #define SOLVER_REASON_RESOLVE_JOB       3
 263 #define SOLVER_REASON_UPDATE_INSTALLED  4
 264 #define SOLVER_REASON_CLEANDEPS_ERASE   5
 265 #define SOLVER_REASON_RESOLVE           6
 266 #define SOLVER_REASON_WEAKDEP           7
 267 #define SOLVER_REASON_RESOLVE_ORPHAN    8
 268
 269 #define SOLVER_REASON_RECOMMENDED       16
 270 #define SOLVER_REASON_SUPPLEMENTED      17
 271
 272
 273 #define SOLVER_FLAG_ALLOW_DOWNGRADE             1
 274 #define SOLVER_FLAG_ALLOW_ARCHCHANGE            2
 275 #define SOLVER_FLAG_ALLOW_VENDORCHANGE          3
 276 #define SOLVER_FLAG_ALLOW_UNINSTALL             4
 277 #define SOLVER_FLAG_NO_UPDATEPROVIDE            5
 278 #define SOLVER_FLAG_SPLITPROVIDES               6
 279 #define SOLVER_FLAG_IGNORE_RECOMMENDED          7
 280 #define SOLVER_FLAG_ADD_ALREADY_RECOMMENDED     8
 281 #define SOLVER_FLAG_NO_INFARCHCHECK             9
 282
 283 extern Solver *solver_create(Pool *pool);
 284 extern void solver_free(Solver *solv);
 285 extern int  solver_solve(Solver *solv, Queue *job);
 286 extern Transaction *solver_create_transaction(Solver *solv);
 287 extern int solver_set_flag(Solver *solv, int flag, int value);
 288 extern int solver_get_flag(Solver *solv, int flag);
 289
 290 extern int  solver_get_decisionlevel(Solver *solv, Id p);
 291 extern void solver_get_decisionqueue(Solver *solv, Queue *decisionq);
 292 extern int  solver_get_lastdecisionblocklevel(Solver *solv);
 293 extern void solver_get_decisionblock(Solver *solv, int level, Queue *decisionq);
 294
 295 extern void solver_get_orphaned(Solver *solv, Queue *orphanedq);
 296 extern void solver_get_recommendations(Solver *solv, Queue *recommendationsq, Queue *suggestionsq, int noselected);
 297
 298 extern int  solver_describe_decision(Solver *solv, Id p, Id *infop);
 299 extern void solver_describe_weakdep_decision(Solver *solv, Id p, Queue *whyq);
 300
 301
 302 extern void solver_calculate_noobsmap(Pool *pool, Queue *job, Map *noobsmap);
 303 extern void solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap);
 304
 305 /* XXX: why is this not static? */
 306 Id *solver_create_decisions_obsoletesmap(Solver *solv);
 307
 308 void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
 309 int solver_calc_installsizechange(Solver *solv);
 310 void solver_trivial_installable(Solver *solv, Queue *pkgs, Queue *res);
 311
 312 void solver_find_involved(Solver *solv, Queue *installedq, Solvable *s, Queue *q);
 313
 314 /* iterate over all literals of a rule */
 315 /* WARNING: loop body must not relocate whatprovidesdata, e.g. by
 316  * looking up the providers of a dependency */
 317 #define FOR_RULELITERALS(l, dp, r)                              \
 318     for (l = r->d < 0 ? -r->d - 1 : r->d,                       \
 319          dp = !l ? &r->w2 : pool->whatprovidesdata + l,         \
 320          l = r->p; l; l = (dp != &r->w2 + 1 ? *dp++ : 0))
 321
 322 /* iterate over all packages selected by a job */
 323 #define FOR_JOB_SELECT(p, pp, select, what)                                     \
 324     if (select == SOLVER_SOLVABLE_REPO || select == SOLVER_SOLVABLE_ALL)        \
 325         p = pp = 0;                                                             \
 326     else for (pp = (select == SOLVER_SOLVABLE ? 0 :                             \
 327                select == SOLVER_SOLVABLE_ONE_OF ? what :                        \
 328                pool_whatprovides(pool, what)),                                  \
 329          p = (select == SOLVER_SOLVABLE ? what : pool->whatprovidesdata[pp++]) ; p ; p = pool->whatprovidesdata[pp++]) \
 330       if (select != SOLVER_SOLVABLE_NAME || pool_match_nevr(pool, pool->solvables + p, what))
 331
 332 #ifdef __cplusplus
 333 }
 334 #endif
 335
 336 #endif /* LIBSOLV_SOLVER_H */