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