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 #include "pooltypes.h"
  17 #include "pool.h"
  18 #include "repo.h"
  19 #include "queue.h"
  20 #include "bitmap.h"
  21 #include "transaction.h"
  22 #include "rules.h"
  23 #include "problems.h"
  24
  25 #ifdef __cplusplus
  26 extern "C" {
  27 #endif
  28
  29 struct _Solver {
  30   Pool *pool;                           /* back pointer to pool */
  31   Queue job;                            /* copy of the job we're solving */
  32
  33   int (*solution_callback)(struct _Solver *solv, void *data);
  34   void *solution_callback_data;
  35
  36   int pooljobcnt;                       /* number of pooljob entries in job queue */
  37
  38 #ifdef LIBSOLV_INTERNAL
  39   Repo *installed;                      /* copy of pool->installed */
  40
  41   /* list of rules, ordered
  42    * pkg rules first, then features, updates, jobs, learnt
  43    * see start/end offsets below
  44    */
  45   Rule *rules;                          /* all rules */
  46   Id nrules;                            /* [Offset] index of the last rule */
  47
  48   Queue ruleassertions;                 /* Queue of all assertion rules */
  49
  50   /* start/end offset for rule 'areas' */
  51
  52   Id pkgrules_end;                      /* [Offset] dep rules end */
  53
  54   Id featurerules;                      /* feature rules start/end */
  55   Id featurerules_end;
  56
  57   Id updaterules;                       /* policy rules, e.g. keep packages installed or update. All literals > 0 */
  58   Id updaterules_end;
  59
  60   Id jobrules;                          /* user rules */
  61   Id jobrules_end;
  62
  63   Id infarchrules;                      /* inferior arch rules */
  64   Id infarchrules_end;
  65
  66   Id duprules;                          /* dist upgrade rules */
  67   Id duprules_end;
  68
  69   Id bestrules;                         /* rules from SOLVER_FORCEBEST */
  70   Id bestrules_end;
  71   Id *bestrules_pkg;
  72
  73   Id yumobsrules;                       /* rules from yum obsoletes handling */
  74   Id yumobsrules_end;
  75   Id *yumobsrules_info;                 /* the dependency for each rule */
  76
  77   Id choicerules;                       /* choice rules (always weak) */
  78   Id choicerules_end;
  79   Id *choicerules_ref;
  80
  81   Id learntrules;                       /* learnt rules, (end == nrules) */
  82
  83   Map noupdate;                         /* don't try to update these
  84                                            installed solvables */
  85   Map multiversion;                     /* ignore obsoletes for these (multiinstall) */
  86
  87   Map updatemap;                        /* bring these installed packages to the newest version */
  88   int updatemap_all;                    /* bring all packages to the newest version */
  89
  90   Map bestupdatemap;                    /* create best rule for those packages */
  91   int bestupdatemap_all;                /* bring all packages to the newest version */
  92
  93   Map fixmap;                           /* fix these packages */
  94   int fixmap_all;                       /* fix all packages */
  95
  96   Queue weakruleq;                      /* index into 'rules' for weak ones */
  97   Map weakrulemap;                      /* map rule# to '1' for weak rules, 1..learntrules */
  98
  99   Id *watches;                          /* Array of rule offsets
 100                                          * watches has nsolvables*2 entries and is addressed from the middle
 101                                          * middle-solvable : decision to conflict, offset point to linked-list of rules
 102                                          * middle+solvable : decision to install: offset point to linked-list of rules
 103                                          */
 104
 105   Queue ruletojob;                      /* index into job queue: jobs for which a rule exits */
 106
 107   /* our decisions: */
 108   Queue decisionq;                      /* >0:install, <0:remove/conflict */
 109   Queue decisionq_why;                  /* index of rule, Offset into rules */
 110
 111   Id *decisionmap;                      /* map for all available solvables,
 112                                          * = 0: undecided
 113                                          * > 0: level of decision when installed,
 114                                          * < 0: level of decision when conflict */
 115
 116   int decisioncnt_jobs;
 117   int decisioncnt_update;
 118   int decisioncnt_keep;
 119   int decisioncnt_resolve;
 120   int decisioncnt_weak;
 121   int decisioncnt_orphan;
 122
 123   /* learnt rule history */
 124   Queue learnt_why;
 125   Queue learnt_pool;
 126
 127   Queue branches;
 128   int propagate_index;                  /* index into decisionq for non-propagated decisions */
 129
 130   Queue problems;                       /* list of lists of conflicting rules, < 0 for job rules */
 131   Queue solutions;                      /* refined problem storage space */
 132
 133   Queue orphaned;                       /* orphaned packages (to be removed?) */
 134
 135   int stats_learned;                    /* statistic */
 136   int stats_unsolvable;                 /* statistic */
 137
 138   Map recommendsmap;                    /* recommended packages from decisionmap */
 139   Map suggestsmap;                      /* suggested packages from decisionmap */
 140   int recommends_index;                 /* recommendsmap/suggestsmap is created up to this level */
 141   Queue *recommendscplxq;
 142   Queue *suggestscplxq;
 143
 144   Id *obsoletes;                        /* obsoletes for each installed solvable */
 145   Id *obsoletes_data;                   /* data area for obsoletes */
 146   Id *specialupdaters;                  /* updaters for packages with a limited update rule */
 147
 148   /*-------------------------------------------------------------------------------------------------------------
 149    * Solver configuration
 150    *-------------------------------------------------------------------------------------------------------------*/
 151
 152   int allowdowngrade;                   /* allow to downgrade installed solvable */
 153   int allownamechange;                  /* allow to change name of installed solvables */
 154   int allowarchchange;                  /* allow to change architecture of installed solvables */
 155   int allowvendorchange;                /* allow to change vendor of installed solvables */
 156   int allowuninstall;                   /* allow removal of installed solvables */
 157   int noupdateprovide;                  /* true: update packages needs not to provide old package */
 158   int needupdateprovide;                /* true: update packages must provide old package */
 159   int dosplitprovides;                  /* true: consider legacy split provides */
 160   int dontinstallrecommended;           /* true: do not install recommended packages */
 161   int addalreadyrecommended;            /* true: also install recommended packages that were already recommended by the installed packages */
 162   int dontshowinstalledrecommended;     /* true: do not show recommended packages that are already installed */
 163
 164   int noinfarchcheck;                   /* true: do not forbid inferior architectures */
 165   int keepexplicitobsoletes;            /* true: honor obsoletes during multiinstall */
 166   int bestobeypolicy;                   /* true: stay in policy with the best rules */
 167   int noautotarget;                     /* true: do not assume targeted for up/dup jobs that contain no installed solvable */
 168   int focus_installed;                  /* true: resolve update rules first */
 169   int do_yum_obsoletes;                 /* true: add special yumobs rules */
 170
 171   Map dupmap;                           /* dup these packages*/
 172   int dupmap_all;                       /* dup all packages */
 173   Map dupinvolvedmap;                   /* packages involved in dup process */
 174   int dup_allowdowngrade;               /* dup mode: allow to downgrade installed solvable */
 175   int dup_allownamechange;              /* dup mode: allow to change name of installed solvable */
 176   int dup_allowarchchange;              /* dup mode: allow to change architecture of installed solvables */
 177   int dup_allowvendorchange;            /* dup mode: allow to change vendor of installed solvables */
 178
 179   Map droporphanedmap;                  /* packages to drop in dup mode */
 180   int droporphanedmap_all;
 181
 182   Map cleandepsmap;                     /* try to drop these packages as of cleandeps erases */
 183
 184   Queue *ruleinfoq;                     /* tmp space for solver_ruleinfo() */
 185
 186   Queue *cleandeps_updatepkgs;          /* packages we update in cleandeps mode */
 187   Queue *cleandeps_mistakes;            /* mistakes we made */
 188
 189   Queue *update_targets;                /* update to specific packages */
 190
 191   Queue *installsuppdepq;               /* deps from the install namespace provides hack */
 192
 193   Queue addedmap_deduceq;               /* deduce addedmap from pkg rules */
 194   Id *instbuddy;                        /* buddies of installed packages */
 195   int keep_orphans;                     /* how to treat orphans */
 196   int break_orphans;                    /* how to treat orphans */
 197   Queue *brokenorphanrules;             /* broken rules of orphaned packages */
 198 #endif  /* LIBSOLV_INTERNAL */
 199 };
 200
 201 typedef struct _Solver Solver;
 202
 203 /*
 204  * queue commands
 205  */
 206
 207 #define SOLVER_SOLVABLE                 0x01
 208 #define SOLVER_SOLVABLE_NAME            0x02
 209 #define SOLVER_SOLVABLE_PROVIDES        0x03
 210 #define SOLVER_SOLVABLE_ONE_OF          0x04
 211 #define SOLVER_SOLVABLE_REPO            0x05
 212 #define SOLVER_SOLVABLE_ALL             0x06
 213
 214 #define SOLVER_SELECTMASK               0xff
 215
 216 #define SOLVER_NOOP                     0x0000
 217 #define SOLVER_INSTALL                  0x0100
 218 #define SOLVER_ERASE                    0x0200
 219 #define SOLVER_UPDATE                   0x0300
 220 #define SOLVER_WEAKENDEPS               0x0400
 221 #define SOLVER_MULTIVERSION             0x0500
 222 #define SOLVER_LOCK                     0x0600
 223 #define SOLVER_DISTUPGRADE              0x0700
 224 #define SOLVER_VERIFY                   0x0800
 225 #define SOLVER_DROP_ORPHANED            0x0900
 226 #define SOLVER_USERINSTALLED            0x0a00
 227
 228 #define SOLVER_JOBMASK                  0xff00
 229
 230 #define SOLVER_WEAK                     0x010000
 231 #define SOLVER_ESSENTIAL                0x020000
 232 #define SOLVER_CLEANDEPS                0x040000
 233 /* ORUPDATE makes SOLVER_INSTALL not prune to installed
 234  * packages, thus updating installed packages */
 235 #define SOLVER_ORUPDATE                 0x080000
 236 /* FORCEBEST makes the solver insist on best packages, so
 237  * you will get problem reported if the best package is
 238  * not installable. This can be used with INSTALL, UPDATE
 239  * and DISTUPGRADE */
 240 #define SOLVER_FORCEBEST                0x100000
 241 /* TARGETED is used in up/dup jobs to make the solver
 242  * treat the specified selection as target packages.
 243  * It is automatically assumed if the selection does not
 244  * contain an "installed" package unless the
 245  * NO_AUTOTARGET solver flag is set */
 246 #define SOLVER_TARGETED                 0x200000
 247 /* This (SOLVER_INSTALL) job was automatically added
 248  * and thus does not the add to the userinstalled packages */
 249 #define SOLVER_NOTBYUSER                0x400000
 250
 251 #define SOLVER_SETEV                    0x01000000
 252 #define SOLVER_SETEVR                   0x02000000
 253 #define SOLVER_SETARCH                  0x04000000
 254 #define SOLVER_SETVENDOR                0x08000000
 255 #define SOLVER_SETREPO                  0x10000000
 256 #define SOLVER_NOAUTOSET                0x20000000
 257 #define SOLVER_SETNAME                  0x40000000
 258
 259 #define SOLVER_SETMASK                  0x7f000000
 260
 261 /* legacy */
 262 #define SOLVER_NOOBSOLETES              SOLVER_MULTIVERSION
 263
 264 #define SOLVER_REASON_UNRELATED         0
 265 #define SOLVER_REASON_UNIT_RULE         1
 266 #define SOLVER_REASON_KEEP_INSTALLED    2
 267 #define SOLVER_REASON_RESOLVE_JOB       3
 268 #define SOLVER_REASON_UPDATE_INSTALLED  4
 269 #define SOLVER_REASON_CLEANDEPS_ERASE   5
 270 #define SOLVER_REASON_RESOLVE           6
 271 #define SOLVER_REASON_WEAKDEP           7
 272 #define SOLVER_REASON_RESOLVE_ORPHAN    8
 273
 274 #define SOLVER_REASON_RECOMMENDED       16
 275 #define SOLVER_REASON_SUPPLEMENTED      17
 276
 277
 278 #define SOLVER_FLAG_ALLOW_DOWNGRADE             1
 279 #define SOLVER_FLAG_ALLOW_ARCHCHANGE            2
 280 #define SOLVER_FLAG_ALLOW_VENDORCHANGE          3
 281 #define SOLVER_FLAG_ALLOW_UNINSTALL             4
 282 #define SOLVER_FLAG_NO_UPDATEPROVIDE            5
 283 #define SOLVER_FLAG_SPLITPROVIDES               6
 284 #define SOLVER_FLAG_IGNORE_RECOMMENDED          7
 285 #define SOLVER_FLAG_ADD_ALREADY_RECOMMENDED     8
 286 #define SOLVER_FLAG_NO_INFARCHCHECK             9
 287 #define SOLVER_FLAG_ALLOW_NAMECHANGE            10
 288 #define SOLVER_FLAG_KEEP_EXPLICIT_OBSOLETES     11
 289 #define SOLVER_FLAG_BEST_OBEY_POLICY            12
 290 #define SOLVER_FLAG_NO_AUTOTARGET               13
 291 #define SOLVER_FLAG_DUP_ALLOW_DOWNGRADE         14
 292 #define SOLVER_FLAG_DUP_ALLOW_ARCHCHANGE        15
 293 #define SOLVER_FLAG_DUP_ALLOW_VENDORCHANGE      16
 294 #define SOLVER_FLAG_DUP_ALLOW_NAMECHANGE        17
 295 #define SOLVER_FLAG_KEEP_ORPHANS                18
 296 #define SOLVER_FLAG_BREAK_ORPHANS               19
 297 #define SOLVER_FLAG_FOCUS_INSTALLED             20
 298 #define SOLVER_FLAG_YUM_OBSOLETES               21
 299 #define SOLVER_FLAG_NEED_UPDATEPROVIDE          22
 300
 301 #define GET_USERINSTALLED_NAMES                 (1 << 0)        /* package names instead of ids */
 302 #define GET_USERINSTALLED_INVERTED              (1 << 1)        /* autoinstalled */
 303 #define GET_USERINSTALLED_NAMEARCH              (1 << 2)        /* package/arch tuples instead of ids */
 304
 305 #define SOLVER_ALTERNATIVE_TYPE_RULE            1
 306 #define SOLVER_ALTERNATIVE_TYPE_RECOMMENDS      2
 307 #define SOLVER_ALTERNATIVE_TYPE_SUGGESTS        3
 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 extern void solver_get_userinstalled(Solver *solv, Queue *q, int flags);
 325 extern void pool_add_userinstalled_jobs(Pool *pool, Queue *q, Queue *job, int flags);
 326
 327 extern int  solver_describe_decision(Solver *solv, Id p, Id *infop);
 328 extern void solver_describe_weakdep_decision(Solver *solv, Id p, Queue *whyq);
 329
 330 extern int solver_alternatives_count(Solver *solv);
 331 extern int solver_get_alternative(Solver *solv, Id alternative, Id *idp, Id *fromp, Id *chosenp, Queue *choices, int *levelp);
 332
 333 extern void solver_calculate_multiversionmap(Pool *pool, Queue *job, Map *multiversionmap);
 334 extern void solver_calculate_noobsmap(Pool *pool, Queue *job, Map *multiversionmap);    /* obsolete */
 335 extern void solver_create_state_maps(Solver *solv, Map *installedmap, Map *conflictsmap);
 336
 337 extern void solver_calc_duchanges(Solver *solv, DUChanges *mps, int nmps);
 338 extern int solver_calc_installsizechange(Solver *solv);
 339 extern void solver_trivial_installable(Solver *solv, Queue *pkgs, Queue *res);
 340
 341 extern void pool_job2solvables(Pool *pool, Queue *pkgs, Id how, Id what);
 342 extern int  pool_isemptyupdatejob(Pool *pool, Id how, Id what);
 343
 344 extern const char *solver_select2str(Pool *pool, Id select, Id what);
 345 extern const char *pool_job2str(Pool *pool, Id how, Id what, Id flagmask);
 346 extern const char *solver_alternative2str(Solver *solv, int type, Id id, Id from);
 347
 348
 349 /* iterate over all literals of a rule */
 350 #define FOR_RULELITERALS(l, pp, r)                              \
 351     for (pp = r->d < 0 ? -r->d - 1 : r->d,                      \
 352          l = r->p; l; l = (pp <= 0 ? (pp-- ? 0 : r->w2) :       \
 353          pool->whatprovidesdata[pp++]))
 354
 355
 356
 357
 358 /* XXX: this currently doesn't work correctly for SOLVER_SOLVABLE_REPO and
 359    SOLVER_SOLVABLE_ALL */
 360
 361 /* iterate over all packages selected by a job */
 362 #define FOR_JOB_SELECT(p, pp, select, what)                                     \
 363     if (select == SOLVER_SOLVABLE_REPO || select == SOLVER_SOLVABLE_ALL)        \
 364         p = pp = 0;                                                             \
 365     else for (pp = (select == SOLVER_SOLVABLE ? 0 :                             \
 366                select == SOLVER_SOLVABLE_ONE_OF ? what :                        \
 367                pool_whatprovides(pool, what)),                                  \
 368          p = (select == SOLVER_SOLVABLE ? what : pool->whatprovidesdata[pp++]); \
 369                                          p ; p = pool->whatprovidesdata[pp++])  \
 370       if (select == SOLVER_SOLVABLE_NAME &&                                     \
 371                         pool_match_nevr(pool, pool->solvables + p, what) == 0)  \
 372         continue;                                                               \
 373       else
 374
 375 #ifdef __cplusplus
 376 }
 377 #endif
 378
 379 #endif /* LIBSOLV_SOLVER_H */