zypp/solver/detail/SATResolver.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 4 -*- */
   2 /* SATResolver.h
   3  *
   4  * Copyright (C) 2000-2002 Ximian, Inc.
   5  * Copyright (C) 2005 SUSE Linux Products GmbH
   6  *
   7  * This program is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License,
   9  * version 2, as published by the Free Software Foundation.
  10  *
  11  * This program is distributed in the hope that it will be useful, but
  12  * WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14  * General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA
  19  * 02111-1307, USA.
  20  */
  21
  22 #ifndef ZYPP_SOLVER_DETAIL_SAT_RESOLVER_H
  23 #define ZYPP_SOLVER_DETAIL_SAT_RESOLVER_H
  24 #ifndef ZYPP_USE_RESOLVER_INTERNALS
  25 #error Do not directly include this file!
  26 #else
  27 extern "C"
  28 {
  29 #include <solv/solver.h>
  30 #include <solv/pool.h>
  31 }
  32
  33 #include <iosfwd>
  34 #include <list>
  35 #include <map>
  36 #include <string>
  37
  38 #include "zypp/base/ReferenceCounted.h"
  39 #include "zypp/base/PtrTypes.h"
  40 #include "zypp/ResPool.h"
  41 #include "zypp/base/SerialNumber.h"
  42 #include "zypp/ProblemTypes.h"
  43 #include "zypp/ResolverProblem.h"
  44 #include "zypp/ProblemSolution.h"
  45 #include "zypp/Capability.h"
  46 #include "zypp/solver/detail/SolverQueueItem.h"
  47
  48 #include "zypp/sat/detail/PoolMember.h"
  49
  50 /////////////////////////////////////////////////////////////////////////
  51 namespace zypp
  52 { ///////////////////////////////////////////////////////////////////////
  53
  54   namespace sat
  55   {
  56     class Transaction;
  57   }
  58
  59   ///////////////////////////////////////////////////////////////////////
  60   namespace solver
  61   { /////////////////////////////////////////////////////////////////////
  62     /////////////////////////////////////////////////////////////////////
  63     namespace detail
  64     { ///////////////////////////////////////////////////////////////////
  65
  66
  67 ///////////////////////////////////////////////////////////////////
  68 //
  69 //      CLASS NAME : SATResolver
  70 /**
  71  * \todo The way solver options are passed as individual booleans from Resolver
  72  * via solver::detail::Resolver to SATResolver is pedestrian and error prone.
  73  * Introdce a dedicated solver option structure which is passed down as a whole.
  74 */
  75 class SATResolver : public base::ReferenceCounted, private base::NonCopyable, private sat::detail::PoolMember
  76 {
  77
  78   private:
  79     ResPool _pool;
  80     sat::detail::CPool *_satPool;
  81     sat::detail::CSolver *_satSolver;
  82     sat::detail::CQueue _jobQueue;
  83
  84     // list of problematic items (orphaned)
  85     PoolItemList _problem_items;
  86
  87     // list populated by calls to addPoolItemTo*()
  88     PoolItemList _items_to_install;
  89     PoolItemList _items_to_remove;
  90     PoolItemList _items_to_lock;
  91     PoolItemList _items_to_keep;
  92
  93     // solve results
  94     PoolItemList _result_items_to_install;
  95     PoolItemList _result_items_to_remove;
  96   public:
  97     bool _fixsystem:1;                  // repair errors in rpm dependency graph
  98     bool _allowdowngrade:1;             // allow to downgrade installed solvable
  99     bool _allownamechange:1;            // allow to change name of installed solvable
 100     bool _allowarchchange:1;            // allow to change architecture of installed solvables
 101     bool _allowvendorchange:1;          // allow to change vendor of installed solvables
 102     bool _allowuninstall:1;             // allow removal of installed solvables
 103     bool _updatesystem:1;               // update
 104     bool _noupdateprovide:1;            // true: update packages needs not to provide old package
 105     bool _dosplitprovides:1;            // true: consider legacy split provides
 106     bool _onlyRequires:1;               // true: consider required packages only (but recommended namespaces)
 107     bool _ignorealreadyrecommended:1;   // true: ignore recommended packages that were already recommended by the installed packages
 108     bool _distupgrade:1;
 109     bool _distupgrade_removeunsupported:1;
 110     bool _dup_allowdowngrade:1;         // dup mode: allow to downgrade installed solvable
 111     bool _dup_allownamechange:1;        // dup mode: allow to change name of installed solvable
 112     bool _dup_allowarchchange:1;        // dup mode: allow to change architecture of installed solvables
 113     bool _dup_allowvendorchange:1;      // dup mode: allow to change vendor of installed solvables
 114     bool _solveSrcPackages:1;           // false: generate no job rule for source packages selected in the pool
 115     bool _cleandepsOnRemove:1;          // whether removing a package should also remove no longer needed requirements
 116
 117   private:
 118     // ---------------------------------- methods
 119     std::string SATprobleminfoString (Id problem, std::string &detail, Id &ignoreId);
 120     std::string SATproblemRuleInfoString (Id rule, std::string &detail, Id &ignoreId);
 121     std::vector<std::string> SATgetCompleteProblemInfoStrings ( Id problem );
 122     void resetItemTransaction (PoolItem item);
 123
 124     // Create a SAT solver and reset solver selection in the pool (Collecting
 125     void solverInit(const PoolItemList & weakItems);
 126     // common solver run with the _jobQueue; Save results back to pool
 127     bool solving(const CapabilitySet & requires_caps = CapabilitySet(),
 128                  const CapabilitySet & conflict_caps = CapabilitySet());
 129     // cleanup solver
 130     void solverEnd();
 131     // set locks for the solver
 132     void setLocks();
 133     // set requirements for a running system
 134     void setSystemRequirements();
 135
 136    // Checking if this solvable/item has a buddy which reflect the real
 137    // user visible description of an item
 138    // e.g. The release package has a buddy to the concerning product item.
 139    // This user want's the message "Product foo conflicts with product bar" and
 140    // NOT "package release-foo conflicts with package release-bar"
 141    // So these functions return the concerning buddy (e.g. product item)
 142     sat::Solvable mapSolvable (const Id &id);
 143     PoolItem mapItem (const PoolItem &item);
 144
 145   public:
 146
 147     SATResolver (const ResPool & pool, sat::detail::CPool *satPool);
 148     virtual ~SATResolver();
 149
 150     // ---------------------------------- I/O
 151
 152     virtual std::ostream & dumpOn( std::ostream & str ) const;
 153     friend std::ostream& operator<<(std::ostream& str, const SATResolver & obj)
 154     { return obj.dumpOn (str); }
 155
 156     ResPool pool (void) const;
 157     void setPool (const ResPool & pool) { _pool = pool; }
 158
 159     // solver run with pool selected items
 160     bool resolvePool(const CapabilitySet & requires_caps,
 161                      const CapabilitySet & conflict_caps,
 162                      const PoolItemList & weakItems,
 163                      const std::set<Repository> & upgradeRepos
 164                      );
 165     // solver run with the given request queue
 166     bool resolveQueue(const SolverQueueItemList &requestQueue,
 167                       const PoolItemList & weakItems
 168                       );
 169     // searching for new packages
 170     void doUpdate();
 171
 172     ResolverProblemList problems ();
 173     void applySolutions (const ProblemSolutionList &solutions);
 174
 175     bool fixsystem () const {return _fixsystem;}
 176     void setFixsystem ( const bool fixsystem) { _fixsystem = fixsystem;}
 177
 178     bool ignorealreadyrecommended () const {return _ignorealreadyrecommended;}
 179     void setIgnorealreadyrecommended ( const bool ignorealreadyrecommended) { _ignorealreadyrecommended = ignorealreadyrecommended;}
 180
 181     bool distupgrade () const {return _distupgrade;}
 182     void setDistupgrade ( const bool distupgrade) { _distupgrade = distupgrade;}
 183
 184     bool distupgrade_removeunsupported () const {return _distupgrade_removeunsupported;}
 185     void setDistupgrade_removeunsupported ( const bool distupgrade_removeunsupported) { _distupgrade_removeunsupported = distupgrade_removeunsupported;}
 186
 187     bool allowdowngrade () const {return _allowdowngrade;}
 188     void setAllowdowngrade ( const bool allowdowngrade) { _allowdowngrade = allowdowngrade;}
 189
 190     bool allowarchchange () const {return _allowarchchange;}
 191     void setAllowarchchange ( const bool allowarchchange) { _allowarchchange = allowarchchange;}
 192
 193     bool allowvendorchange () const {return _allowvendorchange;}
 194     void setAllowvendorchange ( const bool allowvendorchange) { _allowvendorchange = allowvendorchange;}
 195
 196     bool allowuninstall () const {return _allowuninstall;}
 197     void setAllowuninstall ( const bool allowuninstall) { _allowuninstall = allowuninstall;}
 198
 199     bool updatesystem () const {return _updatesystem;}
 200     void setUpdatesystem ( const bool updatesystem) { _updatesystem = updatesystem;}
 201
 202     bool noupdateprovide () const {return _noupdateprovide;}
 203     void setNoupdateprovide ( const bool noupdateprovide) { _noupdateprovide = noupdateprovide;}
 204
 205     bool dosplitprovides () const {return _dosplitprovides;}
 206     void setDosplitprovides ( const bool dosplitprovides) { _dosplitprovides = dosplitprovides;}
 207
 208     bool onlyRequires () const {return _onlyRequires;}
 209     void setOnlyRequires ( const bool onlyRequires) { _onlyRequires = onlyRequires;}
 210
 211     bool solveSrcPackages() const               { return _solveSrcPackages; }
 212     void setSolveSrcPackages( bool state_r )    { _solveSrcPackages = state_r; }
 213
 214     bool cleandepsOnRemove() const              { return _cleandepsOnRemove; }
 215     void setCleandepsOnRemove( bool state_r )   { _cleandepsOnRemove = state_r; }
 216
 217     PoolItemList problematicUpdateItems( void ) const { return _problem_items; }
 218     PoolItemList problematicUpdateItems() { return _problem_items; }
 219
 220     PoolItemList resultItemsToInstall () { return _result_items_to_install; }
 221     PoolItemList resultItemsToRemove () { return _result_items_to_remove; }
 222
 223     sat::StringQueue autoInstalled() const;
 224     sat::StringQueue userInstalled() const;
 225 };
 226
 227 ///////////////////////////////////////////////////////////////////
 228     };// namespace detail
 229     /////////////////////////////////////////////////////////////////////
 230     /////////////////////////////////////////////////////////////////////
 231   };// namespace solver
 232   ///////////////////////////////////////////////////////////////////////
 233   ///////////////////////////////////////////////////////////////////////
 234 };// namespace zypp
 235 /////////////////////////////////////////////////////////////////////////
 236 #endif // ZYPP_USE_RESOLVER_INTERNALS
 237 #endif // ZYPP_SOLVER_DETAIL_SAT_RESOLVER_H