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 bestrules;                         /* rules from SOLVER_FORCEBEST */
 117   Id bestrules_end;
 118   Id *bestrules_pkg;
 119
 120   Id choicerules;                       /* choice rules (always weak) */
 121   Id choicerules_end;
 122   Id *choicerules_ref;
 123
 124   Id learntrules;                       /* learnt rules, (end == nrules) */
 125
 126   Map noupdate;                         /* don't try to update these
 127                                            installed solvables */
 128   Map noobsoletes;                      /* ignore obsoletes for these (multiinstall) */
 129
 130   Map updatemap;                        /* bring these installed packages to the newest version */
 131   int updatemap_all;                    /* bring all packages to the newest version */
 132
 133   Map bestupdatemap;                    /* create best rule for those packages */
 134   int bestupdatemap_all;                /* bring all packages to the newest version */
 135
 136   Map fixmap;                           /* fix these packages */
 137   int fixmap_all;                       /* fix all packages */
 138
 139   Queue weakruleq;                      /* index into 'rules' for weak ones */
 140   Map weakrulemap;                      /* map rule# to '1' for weak rules, 1..learntrules */
 141
 142   Id *watches;                          /* Array of rule offsets
 143                                          * watches has nsolvables*2 entries and is addressed from the middle
 144                                          * middle-solvable : decision to conflict, offset point to linked-list of rules
 145                                          * middle+solvable : decision to install: offset point to linked-list of rules
 146                                          */
 147
 148   Queue ruletojob;                      /* index into job queue: jobs for which a rule exits */
 149
 150   /* our decisions: */
 151   Queue decisionq;                      /* >0:install, <0:remove/conflict */
 152   Queue decisionq_why;                  /* index of rule, Offset into rules */
 153
 154   Id *decisionmap;                      /* map for all available solvables,
 155                                          * = 0: undecided
 156                                          * > 0: level of decision when installed,
 157                                          * < 0: level of decision when conflict */
 158
 159   int decisioncnt_update;
 160   int decisioncnt_keep;
 161   int decisioncnt_resolve;
 162   int decisioncnt_weak;
 163   int decisioncnt_orphan;
 164
 165   /* learnt rule history */
 166   Queue learnt_why;
 167   Queue learnt_pool;
 168
 169   Queue branches;
 170   int propagate_index;                  /* index into decisionq for non-propagated decisions */
 171
 172   Queue problems;                       /* list of lists of conflicting rules, < 0 for job rules */
 173   Queue solutions;                      /* refined problem storage space */
 174
 175   Queue orphaned;                       /* orphaned packages (to be removed?) */
 176
 177   int stats_learned;                    /* statistic */
 178   int stats_unsolvable;                 /* statistic */
 179
 180   Map recommendsmap;                    /* recommended packages from decisionmap */
 181   Map suggestsmap;                      /* suggested packages from decisionmap */
 182   int recommends_index;                 /* recommendsmap/suggestsmap is created up to this level */
 183
 184   Id *obsoletes;                        /* obsoletes for each installed solvable */
 185   Id *obsoletes_data;                   /* data area for obsoletes */
 186   Id *multiversionupdaters;             /* updaters for multiversion packages in updatesystem mode */
 187
 188   /*-------------------------------------------------------------------------------------------------------------
 189    * Solver configuration
 190    *-------------------------------------------------------------------------------------------------------------*/
 191
 192   int allowdowngrade;                   /* allow to downgrade installed solvable */
 193   int allownamechange;                  /* allow to change name of installed solvables */
 194   int allowarchchange;                  /* allow to change architecture of installed solvables */
 195   int allowvendorchange;                /* allow to change vendor of installed solvables */
 196   int allowuninstall;                   /* allow removal of installed solvables */
 197   int noupdateprovide;                  /* true: update packages needs not to provide old package */
 198   int dosplitprovides;                  /* true: consider legacy split provides */
 199   int dontinstallrecommended;           /* true: do not install recommended packages */
 200   int addalreadyrecommended;            /* true: also install recommended packages that were already recommended by the installed packages */
 201   int dontshowinstalledrecommended;     /* true: do not show recommended packages that are already installed */
 202
 203   int noinfarchcheck;                   /* true: do not forbid inferior architectures */
 204   int keepexplicitobsoletes;            /* true: honor obsoletes during multiinstall */
 205   int bestobeypolicy;                   /* true: stay in policy with the best rules */
 206
 207
 208   Map dupmap;                           /* dup these packages*/
 209   int dupmap_all;                       /* dup all packages */
 210   Map dupinvolvedmap;                   /* packages involved in dup process */
 211   int dup_allowdowngrade;               /* dup mode: allow to downgrade installed solvable */
 212   int dup_allownamechange;              /* dup mode: allow to change name of installed solvable */
 213   int dup_allowarchchange;              /* dup mode: allow to change architecture of installed solvables */
 214   int dup_allowvendorchange;            /* dup mode: allow to change vendor of installed solvables */
 215
 216   Map droporphanedmap;                  /* packages to drop in dup mode */
 217   int droporphanedmap_all;
 218
 219   Map cleandepsmap;                     /* try to drop these packages as of cleandeps erases */
 220
 221   Queue *ruleinfoq;                     /* tmp space for solver_ruleinfo() */
 222
 223   Queue *cleandeps_updatepkgs;          /* packages we update in cleandeps mode */
 224   Queue *cleandeps_mistakes;            /* mistakes we made */
 225
 226   Queue *update_targets;                /* update to specific packages */
 227 #endif  /* LIBSOLV_INTERNAL */
 228 };
 229
 230 typedef struct _Solver Solver;
 231
 232 /*
 233  * queue commands
 234  */
 235
 236 #define SOLVER_SOLVABLE                 0x01
 237 #define SOLVER_SOLVABLE_NAME            0x02
 238 #define SOLVER_SOLVABLE_PROVIDES        0x03
 239 #define SOLVER_SOLVABLE_ONE_OF          0x04
 240 #define SOLVER_SOLVABLE_REPO            0x05
 241 #define SOLVER_SOLVABLE_ALL             0x06
 242
 243 #define SOLVER_SELECTMASK               0xff
 244
 245 #define SOLVER_NOOP                     0x0000
 246 #define SOLVER_INSTALL                  0x0100
 247 #define SOLVER_ERASE                    0x0200
 248 #define SOLVER_UPDATE                   0x0300
 249 #define SOLVER_WEAKENDEPS               0x0400
 250 #define SOLVER_NOOBSOLETES              0x0500
 251 #define SOLVER_LOCK                     0x0600
 252 #define SOLVER_DISTUPGRADE              0x0700
 253 #define SOLVER_VERIFY                   0x0800
 254 #define SOLVER_DROP_ORPHANED            0x0900
 255 #define SOLVER_USERINSTALLED            0x0a00
 256
 257 #define SOLVER_JOBMASK                  0xff00
 258
 259 #define SOLVER_WEAK                     0x010000
 260 #define SOLVER_ESSENTIAL                0x020000
 261 #define SOLVER_CLEANDEPS                0x040000
 262 /* ORUPDATE makes SOLVER_INSTALL not prune to installed
 263  * packages, thus updating installed packages */
 264 #define SOLVER_ORUPDATE                 0x080000
 265 /* FORCEBEST makes the solver insist on best packages, so
 266  * you will get problem reported if the best package is
 267  * not installable. This can be used with INSTALL, UPDATE
 268  * and DISTUPGRADE */
 269 /* Also, it's not implemented yet ;) */
 270 #define SOLVER_FORCEBEST                0x100000
 271
 272 #define SOLVER_SETEV                    0x01000000
 273 #define SOLVER_SETEVR                   0x02000000
 274 #define SOLVER_SETARCH                  0x04000000
 275 #define SOLVER_SETVENDOR                0x08000000
 276 #define SOLVER_SETREPO                  0x10000000
 277 #define SOLVER_NOAUTOSET                0x20000000
 278 #define SOLVER_SETNAME                  0x40000000
 279
 280 #define SOLVER_SETMASK                  0x7f000000
 281
 282 #define SOLVER_REASON_UNRELATED         0
 283 #define SOLVER_REASON_UNIT_RULE         1
 284 #define SOLVER_REASON_KEEP_INSTALLED    2
 285 #define SOLVER_REASON_RESOLVE_JOB       3
 286 #define SOLVER_REASON_UPDATE_INSTALLED  4
 287 #define SOLVER_REASON_CLEANDEPS_ERASE   5
 288 #define SOLVER_REASON_RESOLVE           6
 289 #define SOLVER_REASON_WEAKDEP           7
 290 #define SOLVER_REASON_RESOLVE_ORPHAN    8
 291
 292 #define SOLVER_REASON_RECOMMENDED       16
 293 #define SOLVER_REASON_SUPPLEMENTED      17
 294
 295
 296 #define SOLVER_FLAG_ALLOW_DOWNGRADE             1
 297 #define SOLVER_FLAG_ALLOW_ARCHCHANGE            2
 298 #define SOLVER_FLAG_ALLOW_VENDORCHANGE          3
 299 #define SOLVER_FLAG_ALLOW_UNINSTALL             4
 300 #define SOLVER_FLAG_NO_UPDATEPROVIDE            5
 301 #define SOLVER_FLAG_SPLITPROVIDES               6
 302 #define SOLVER_FLAG_IGNORE_RECOMMENDED          7
 303 #define SOLVER_FLAG_ADD_ALREADY_RECOMMENDED     8
 304 #define SOLVER_FLAG_NO_INFARCHCHECK             9
 305 #define SOLVER_FLAG_ALLOW_NAMECHANGE            10
 306 #define SOLVER_FLAG_KEEP_EXPLICIT_OBSOLETES     11
 307 #define SOLVER_FLAG_BEST_OBEY_POLICY            12
 308
 309 extern Solver *solver_create(Pool *pool);
 310 extern void solver_free(Solver *solv);
 311 extern int  solver_solve(Solver *solv, Queue *job);
 312 extern Transaction *solver_create_transaction(Solver *solv);
 313 extern int solver_set_flag(Solver *solv, int flag, int value);
 314 extern int solver_get_flag(Solver *solv, int flag);
 315
 316 extern int  solver_get_decisionlevel(Solver *solv, Id p);
 317 extern void solver_get_decisionqueue(Solver *solv, Queue *decisionq);
 318 extern int  solver_get_lastdecisionblocklevel(Solver *solv);
 319 extern void solver_get_decisionblock(Solver *solv, int level, Queue *decisionq);
 320
 321 extern void solver_get_orphaned(Solver *solv, Queue *orphanedq);
 322 extern void solver_get_recommendations(Solver *solv, Queue *recommendationsq, Queue *suggestionsq, int noselected);
 323 extern void solver_get_unneeded(Solver *solv, Queue *unneededq, int filtered);
 324
 325 extern int  solver_describe_decision(Solver *solv, Id p, Id *infop);
 326 extern void solver_describe_weakdep_decision(Solver *solv, Id p, Queue *whyq);
 327
 328
 329 extern void solver_calculate_noobsmap(Pool *pool, Queue *job, Map *noobsmap);
 330 extern void solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap);
 331
 332 /* XXX: why is this not static? */
 333 Id *solver_create_decisions_obsoletesmap(Solver *solv);
 334
 335 void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
 336 int solver_calc_installsizechange(Solver *solv);
 337 void solver_trivial_installable(Solver *solv, Queue *pkgs, Queue *res);
 338
 339 void pool_job2solvables(Pool *pool, Queue *pkgs, Id how, Id what);
 340 int  pool_isemptyupdatejob(Pool *pool, Id how, Id what);
 341
 342 /* iterate over all literals of a rule */
 343 /* WARNING: loop body must not relocate whatprovidesdata, e.g. by
 344  * looking up the providers of a dependency */
 345 #define FOR_RULELITERALS(l, dp, r)                              \
 346     for (l = r->d < 0 ? -r->d - 1 : r->d,                       \
 347          dp = !l ? &r->w2 : pool->whatprovidesdata + l,         \
 348          l = r->p; l; l = (dp != &r->w2 + 1 ? *dp++ : 0))
 349
 350 /* XXX: this currently doesn't work correctly for SOLVER_SOLVABLE_REPO and
 351    SOLVER_SOLVABLE_ALL */
 352
 353 /* iterate over all packages selected by a job */
 354 #define FOR_JOB_SELECT(p, pp, select, what)                                     \
 355     if (select == SOLVER_SOLVABLE_REPO || select == SOLVER_SOLVABLE_ALL)        \
 356         p = pp = 0;                                                             \
 357     else for (pp = (select == SOLVER_SOLVABLE ? 0 :                             \
 358                select == SOLVER_SOLVABLE_ONE_OF ? what :                        \
 359                pool_whatprovides(pool, what)),                                  \
 360          p = (select == SOLVER_SOLVABLE ? what : pool->whatprovidesdata[pp++]); \
 361                                          p ; p = pool->whatprovidesdata[pp++])  \
 362       if (select == SOLVER_SOLVABLE_NAME &&                                     \
 363                         pool_match_nevr(pool, pool->solvables + p, what) == 0)  \
 364         continue;                                                               \
 365       else
 366
 367 #ifdef __cplusplus
 368 }
 369 #endif
 370
 371 #endif /* LIBSOLV_SOLVER_H */