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