<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Libsolv-Pool(3)</title><link rel="stylesheet" type="text/css" href="docbook-xsl.css" /><meta name="generator" content="DocBook XSL Stylesheets V1.79.1" /></head><body><div xml:lang="en" class="article" lang="en"><div class="titlepage"><div><div><h2 class="title"><a id="idm139988935549680"></a>Libsolv-Pool(3)</h2></div></div><hr /></div><div class="toc"><p><strong>Table of Contents</strong></p><dl class="toc"><dt><span class="section"><a href="#_name">1. Name</a></span></dt><dt><span class="section"><a href="#_public_attributes">2. Public Attributes</a></span></dt><dt><span class="section"><a href="#_creation_and_destruction">3. Creation and Destruction</a></span></dt><dt><span class="section"><a href="#_debugging_and_error_reporting">4. Debugging and error reporting</a></span></dt><dd><dl><dt><span class="section"><a href="#_constants">4.1. Constants</a></span></dt><dt><span class="section"><a href="#_functions">4.2. Functions</a></span></dt></dl></dd><dt><span class="section"><a href="#_pool_configuration">5. Pool configuration</a></span></dt><dd><dl><dt><span class="section"><a href="#_constants_2">5.1. Constants</a></span></dt><dt><span class="section"><a href="#_functions_2">5.2. Functions</a></span></dt></dl></dd><dt><span class="section"><a href="#_id_pool_management">6. Id pool management</a></span></dt><dd><dl><dt><span class="section"><a href="#_constants_3">6.1. Constants</a></span></dt><dt><span class="section"><a href="#_functions_3">6.2. Functions</a></span></dt></dl></dd><dt><span class="section"><a href="#_solvable_functions">7. Solvable functions</a></span></dt><dt><span class="section"><a href="#_dependency_matching">8. Dependency matching</a></span></dt><dd><dl><dt><span class="section"><a href="#_constants_4">8.1. Constants</a></span></dt><dt><span class="section"><a href="#_functions_4">8.2. Functions</a></span></dt></dl></dd><dt><span class="section"><a href="#_whatprovides_index">9. Whatprovides Index</a></span></dt><dt><span class="section"><a href="#_utility_functions">10. Utility functions</a></span></dt><dt><span class="section"><a href="#_data_lookup">11. Data lookup</a></span></dt><dd><dl><dt><span class="section"><a href="#_constants_5">11.1. Constants</a></span></dt><dt><span class="section"><a href="#_functions_5">11.2. Functions</a></span></dt></dl></dd><dt><span class="section"><a href="#_job_and_selection_functions">12. Job and Selection functions</a></span></dt><dt><span class="section"><a href="#_odds_and_ends">13. Odds and Ends</a></span></dt><dt><span class="section"><a href="#_architecture_policies">14. Architecture Policies</a></span></dt><dt><span class="section"><a href="#_vendor_policies">15. Vendor Policies</a></span></dt><dt><span class="section"><a href="#_boolean_dependencies">16. Boolean Dependencies</a></span></dt><dt><span class="section"><a href="#_namespace_dependencies">17. Namespace Dependencies</a></span></dt><dt><span class="section"><a href="#_author">18. Author</a></span></dt></dl></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_name"></a>1. Name</h2></div></div></div><p>libsolv-pool - Libsolv’s pool object</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_public_attributes"></a>2. Public Attributes</h2></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term"> <span class="strong"><strong>void *appdata</strong></span> </span></dt><dd> A no-purpose pointer free to use for the library user. Freeing the pool simply discards the pointer. </dd><dt><span class="term"> <span class="strong"><strong>Stringpool ss</strong></span> </span></dt><dd> The pool of unified strings. </dd><dt><span class="term"> <span class="strong"><strong>Reldep *rels</strong></span> </span></dt><dd> The pool of unified relation dependencies. </dd><dt><span class="term"> <span class="strong"><strong>int nrels</strong></span> </span></dt><dd> Number of allocated relation dependencies. </dd><dt><span class="term"> <span class="strong"><strong>Repo **repos</strong></span> </span></dt><dd> The array of repository pointers, indexed by repository Id. </dd><dt><span class="term"> <span class="strong"><strong>int nrepos</strong></span> </span></dt><dd> Number of allocated repository array elements, i.e. the size of the repos array. </dd><dt><span class="term"> <span class="strong"><strong>int urepos</strong></span> </span></dt><dd> Number of used (i.e. non-zero) repository array elements. </dd><dt><span class="term"> <span class="strong"><strong>Repo *installed</strong></span> </span></dt><dd> Pointer to the repo holding the installed packages. You are free to read this attribute, but you should use pool_set_installed() if you want to change it. </dd><dt><span class="term"> <span class="strong"><strong>Solvable *solvables</strong></span> </span></dt><dd> The array of Solvable objects. </dd><dt><span class="term"> <span class="strong"><strong>int nsolvables</strong></span> </span></dt><dd> Number of Solvable objects, i.e. the size of the solvables array. Note that the array may contain freed solvables, in that case the repo pointer of the solvable will be zero. </dd><dt><span class="term"> <span class="strong"><strong>int disttype</strong></span> </span></dt><dd> The distribution type of your system, e.g. DISTTYPE_DEB. You are free to read this attribute, but you should use pool_setdisttype() if you want to change it. </dd><dt><span class="term"> <span class="strong"><strong>Id *whatprovidesdata</strong></span> </span></dt><dd> Multi-purpose Id storage holding zero terminated arrays of Ids. pool_whatprovides() returns an offset into this data. </dd><dt><span class="term"> <span class="strong"><strong>Map *considered</strong></span> </span></dt><dd> Optional bitmap that can make the library ignore solvables. If a bitmap is set, only solvables that have a set bit in the bitmap at their Id are considered usable. </dd><dt><span class="term"> <span class="strong"><strong>int debugmask</strong></span> </span></dt><dd> A mask that defines which debug events should be reported. pool_setdebuglevel() sets this mask. </dd><dt><span class="term"> <span class="strong"><strong>Datapos pos</strong></span> </span></dt><dd> An object storing some position in the repository data. Functions like dataiterator_set_pos() set this object, accessing data with a pseudo solvable Id of SOLVID_POS uses it. </dd><dt><span class="term"> <span class="strong"><strong>Queue pooljobs</strong></span> </span></dt><dd> A queue where fixed solver jobs can be stored. This jobs are automatically added when solver_solve() is called, they are useful to store configuration data like which packages should be multiversion installed. </dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_creation_and_destruction"></a>3. Creation and Destruction</h2></div></div></div><pre class="literallayout">Pool *pool_create();</pre><p>Create a new instance of a pool.</p><pre class="literallayout">void pool_free(Pool *pool);</pre><p>Free a pool and all of the data it contains, e.g. the solvables, repositories, strings.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_debugging_and_error_reporting"></a>4. Debugging and error reporting</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_constants"></a>4.1. Constants</h3></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term"> <span class="strong"><strong>SOLV_FATAL</strong></span> </span></dt><dd> Report the error and call “exit(1)” afterwards. You cannot mask this level. Reports to stderr instead of stdout. </dd><dt><span class="term"> <span class="strong"><strong>SOLV_ERROR</strong></span> </span></dt><dd> Used to report errors. Reports to stderr instead of stdout. </dd><dt><span class="term"> <span class="strong"><strong>SOLV_WARN</strong></span> </span></dt><dd> Used to report warnings. </dd><dt><span class="term"> <span class="strong"><strong>SOLV_DEBUG_STATS</strong></span> </span></dt><dd> Used to report statistical data. </dd><dt><span class="term"> <span class="strong"><strong>SOLV_DEBUG_RULE_CREATION</strong></span> </span></dt><dd> Used to report information about the solver’s creation of rules. </dd><dt><span class="term"> <span class="strong"><strong>SOLV_DEBUG_PROPAGATE</strong></span> </span></dt><dd> Used to report information about the solver’s unit rule propagation process. </dd><dt><span class="term"> <span class="strong"><strong>SOLV_DEBUG_ANALYZE</strong></span> </span></dt><dd> Used to report information about the solver’s learnt rule generation mechanism. </dd><dt><span class="term"> <span class="strong"><strong>SOLV_DEBUG_UNSOLVABLE</strong></span> </span></dt><dd> Used to report information about the solver dealing with conflicting rules. </dd><dt><span class="term"> <span class="strong"><strong>SOLV_DEBUG_SOLUTIONS</strong></span> </span></dt><dd> Used to report information about the solver creating solutions to solve problems. </dd><dt><span class="term"> <span class="strong"><strong>SOLV_DEBUG_POLICY</strong></span> </span></dt><dd> Used to report information about the solver searching for an optimal solution. </dd><dt><span class="term"> <span class="strong"><strong>SOLV_DEBUG_RESULT</strong></span> </span></dt><dd> Used by the debug functions to output results. </dd><dt><span class="term"> <span class="strong"><strong>SOLV_DEBUG_JOB</strong></span> </span></dt><dd> Used to report information about the job rule generation process. </dd><dt><span class="term"> <span class="strong"><strong>SOLV_DEBUG_SOLVER</strong></span> </span></dt><dd> Used to report information about what the solver is currently doing. </dd><dt><span class="term"> <span class="strong"><strong>SOLV_DEBUG_TRANSACTION</strong></span> </span></dt><dd> Used to report information about the transaction generation and ordering process. </dd><dt><span class="term"> <span class="strong"><strong>SOLV_DEBUG_TO_STDERR</strong></span> </span></dt><dd> Write debug messages to stderr instead of stdout. </dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_functions"></a>4.2. Functions</h3></div></div></div><pre class="literallayout">void pool_debug(Pool *pool, int type, const char *format, ...);</pre><p>Report a message of the type <span class="emphasis"><em>type</em></span>. You can filter debug messages by setting a debug mask.</p><pre class="literallayout">void pool_setdebuglevel(Pool *pool, int level);</pre><p>Set a predefined debug mask. A higher level generally means more bits in the mask are set, thus more messages are printed.</p><pre class="literallayout">void pool_setdebugmask(Pool *pool, int mask);</pre><p>Set the debug mask to filter debug messages.</p><pre class="literallayout">int pool_error(Pool *pool, int ret, const char *format, ...);</pre><p>Set the pool’s error string. The <span class="emphasis"><em>ret</em></span> value is simply used as a return value of the function so that you can write code like <code class="literal">return pool_error(…);</code>. If the debug mask contains the <span class="strong"><strong>SOLV_ERROR</strong></span> bit, pool_debug() is also called with the message and type <span class="strong"><strong>SOLV_ERROR</strong></span>.</p><pre class="literallayout">extern char *pool_errstr(Pool *pool);</pre><p>Return the current error string stored in the pool. Like with the libc’s errno value, the string is only meaningful after a function returned an error.</p><pre class="literallayout">void pool_setdebugcallback(Pool *pool, void (*debugcallback)(Pool *, void *data, int type, const char *str), void *debugcallbackdata);</pre><p>Set a custom debug callback function. Instead of writing to stdout or stderr, the callback function will be called.</p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_pool_configuration"></a>5. Pool configuration</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_constants_2"></a>5.1. Constants</h3></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term"> <span class="strong"><strong>DISTTYPE_RPM</strong></span> </span></dt><dd> Used for systems which use rpm as low level package manager. </dd><dt><span class="term"> <span class="strong"><strong>DISTTYPE_DEB</strong></span> </span></dt><dd> Used for systems which use dpkg as low level package manager. </dd><dt><span class="term"> <span class="strong"><strong>DISTTYPE_ARCH</strong></span> </span></dt><dd> Used for systems which use the arch linux package manager. </dd><dt><span class="term"> <span class="strong"><strong>DISTTYPE_HAIKU</strong></span> </span></dt><dd> Used for systems which use haiku packages. </dd><dt><span class="term"> <span class="strong"><strong>POOL_FLAG_PROMOTEEPOCH</strong></span> </span></dt><dd> Promote the epoch of the providing dependency to the requesting dependency if it does not contain an epoch. Used at some time in old rpm versions, modern systems should never need this. </dd><dt><span class="term"> <span class="strong"><strong>POOL_FLAG_FORBIDSELFCONFLICTS</strong></span> </span></dt><dd> Disallow the installation of packages that conflict with themselves. Debian always allows self-conflicting packages, rpm used to forbid them but switched to also allowing them recently. </dd><dt><span class="term"> <span class="strong"><strong>POOL_FLAG_OBSOLETEUSESPROVIDES</strong></span> </span></dt><dd> Make obsolete type dependency match against provides instead of just the name and version of packages. Very old versions of rpm used the name/version, then it got switched to provides and later switched back again to just name/version. </dd><dt><span class="term"> <span class="strong"><strong>POOL_FLAG_IMPLICITOBSOLETEUSESPROVIDES</strong></span> </span></dt><dd> An implicit obsoletes is the internal mechanism to remove the old package on an update. The default is to remove all packages with the same name, rpm-5 switched to also removing packages providing the same name. </dd><dt><span class="term"> <span class="strong"><strong>POOL_FLAG_OBSOLETEUSESCOLORS</strong></span> </span></dt><dd> Rpm’s multilib implementation (used in RedHat and Fedora) distinguishes between 32bit and 64bit packages (the terminology is that they have a different color). If obsoleteusescolors is set, packages with different colors will not obsolete each other. </dd><dt><span class="term"> <span class="strong"><strong>POOL_FLAG_IMPLICITOBSOLETEUSESCOLORS</strong></span> </span></dt><dd> Same as POOL_FLAG_OBSOLETEUSESCOLORS, but used to find out if packages of the same name can be installed in parallel. For current Fedora systems, POOL_FLAG_OBSOLETEUSESCOLORS should be false and POOL_FLAG_IMPLICITOBSOLETEUSESCOLORS should be true (this is the default if FEDORA is defined when libsolv is compiled). </dd><dt><span class="term"> <span class="strong"><strong>POOL_FLAG_NOINSTALLEDOBSOLETES</strong></span> </span></dt><dd> New versions of rpm consider the obsoletes of installed packages when checking for dependency, thus you may not install a package that is obsoleted by some other installed package, unless you also erase the other package. </dd><dt><span class="term"> <span class="strong"><strong>POOL_FLAG_HAVEDISTEPOCH</strong></span> </span></dt><dd> Mandriva added a new field called distepoch that gets checked in version comparison if the epoch/version/release of two packages are the same. </dd><dt><span class="term"> <span class="strong"><strong>POOL_FLAG_NOOBSOLETESMULTIVERSION</strong></span> </span></dt><dd> If a package is installed in multiversionmode, rpm used to ignore both the implicit obsoletes and the obsolete dependency of a package. This was changed to ignoring just the implicit obsoletes, thus you may install multiple versions of the same name, but obsoleted packages still get removed. </dd><dt><span class="term"> <span class="strong"><strong>POOL_FLAG_ADDFILEPROVIDESFILTERED</strong></span> </span></dt><dd> Make the addfileprovides method only add files from the standard locations (i.e. the “bin” and “etc” directories). This is useful if you have only few packages that use non-standard file dependencies, but you still want the fast speed that addfileprovides() generates. </dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_functions_2"></a>5.2. Functions</h3></div></div></div><pre class="literallayout">int pool_setdisttype(Pool *pool, int disttype);</pre><p>Set the package type of your system. The disttype is used for example to define package comparison semantics. Libsolv’s default disttype should match the package manager of your system, so you only need to use this function if you want to use the library to solve packaging problems for different systems. The Function returns the old disttype on success, and -1 if the new disttype is not supported. Note that any pool_setarch and pool_setarchpolicy calls need to come after the pool_setdisttype call, as they make use of the noarch/any/all architecture id.</p><pre class="literallayout">int pool_set_flag(Pool *pool, int flag, int value);</pre><p>Set a flag to a new value. Returns the old value of the flag.</p><pre class="literallayout">int pool_get_flag(Pool *pool, int flag);</pre><p>Get the value of a pool flag. See the constants section about the meaning of the flags.</p><pre class="literallayout">void pool_set_rootdir(Pool *pool, const char *rootdir);</pre><p>Set a specific root directory. Some library functions support a flag that tells the function to prepend the rootdir to file and directory names.</p><pre class="literallayout">const char *pool_get_rootdir(Pool *pool);</pre><p>Return the current value of the root directory.</p><pre class="literallayout">char *pool_prepend_rootdir(Pool *pool, const char *dir);</pre><p>Prepend the root directory to the <span class="emphasis"><em>dir</em></span> argument string. The returned string has been newly allocated and needs to be freed after use.</p><pre class="literallayout">char *pool_prepend_rootdir_tmp(Pool *pool, const char *dir);</pre><p>Same as pool_prepend_rootdir, but uses the pool’s temporary space for allocation.</p><pre class="literallayout">void pool_set_installed(Pool *pool, Repo *repo);</pre><p>Set which repository should be treated as the “installed” repository, i.e. the one that holds information about the installed packages.</p><pre class="literallayout">void pool_set_languages(Pool *pool, const char **languages, int nlanguages);</pre><p>Set the language of your system. The library provides lookup functions that return localized strings, for example for package descriptions. You can set an array of languages to provide a fallback mechanism if one language is not available.</p><pre class="literallayout">void pool_setarch(Pool *pool, const char *arch);</pre><p>Set the architecture of your system. The architecture is used to determine which packages are installable and which packages cannot be installed. The <span class="emphasis"><em>arch</em></span> argument is normally the “machine” value of the “uname” system call.</p><pre class="literallayout">void pool_setarchpolicy(Pool *, const char *);</pre><p>Set the architecture policy for your system. This is the general version of pool_setarch (in fact pool_setarch calls pool_setarchpolicy internally). See the section about architecture policies for more information.</p><pre class="literallayout">void pool_addvendorclass(Pool *pool, const char **vendorclass);</pre><p>Add a new vendor equivalence class to the system. A vendor equivalence class defines if an installed package of one vendor can be replaced by a package coming from a different vendor. The <span class="emphasis"><em>vendorclass</em></span> argument must be a NULL terminated array of strings. See the section about vendor policies for more information.</p><pre class="literallayout">void pool_setvendorclasses(Pool *pool, const char **vendorclasses);</pre><p>Set all allowed vendor equivalences. The vendorclasses argument must be an NULL terminated array consisting of all allowed classes concatenated. Each class itself must be NULL terminated, thus the last class ends with two NULL elements, one to finish the class and one to finish the list of classes.</p><pre class="literallayout">void pool_set_custom_vendorcheck(Pool *pool, int (*vendorcheck)(Pool *, Solvable *, Solvable *));</pre><p>Define a custom vendor check mechanism. You can use this if libsolv’s internal vendor equivalence class mechanism does not match your needs.</p><pre class="literallayout">void pool_setloadcallback(Pool *pool, int (*cb)(Pool *, Repodata *, void *), void *loadcbdata);</pre><p>Define a callback function that gets called when repository metadata needs to be loaded on demand. See the section about on demand loading in the libsolv-repodata manual.</p><pre class="literallayout">void pool_setnamespacecallback(Pool *pool, Id (*cb)(Pool *, void *, Id, Id), void *nscbdata);</pre><p>Define a callback function to implement custom namespace support. See the section about namespace dependencies.</p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_id_pool_management"></a>6. Id pool management</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_constants_3"></a>6.1. Constants</h3></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term"> <span class="strong"><strong>ID_EMPTY</strong></span> </span></dt><dd> The Id of the empty string, it is always Id 1. </dd><dt><span class="term"> <span class="strong"><strong>REL_LT</strong></span> </span></dt><dd> Represents a “<” relation. </dd><dt><span class="term"> <span class="strong"><strong>REL_EQ</strong></span> </span></dt><dd> Represents a “=” relation. </dd><dt><span class="term"> <span class="strong"><strong>REL_GT</strong></span> </span></dt><dd> Represents a “>” relation. You can use combinations of REL_GT, REL_EQ, and REL_LT or-ed together to create any relation you like. </dd><dt><span class="term"> <span class="strong"><strong>REL_AND</strong></span> </span></dt><dd> A boolean AND operation, the “name” and “evr” parts of the relation can be two sub-dependencies. Packages must match both parts of the dependency. </dd><dt><span class="term"> <span class="strong"><strong>REL_OR</strong></span> </span></dt><dd> A boolean OR operation, the “name” and “evr” parts of the relation can be two sub-dependencies. Packages can match any part of the dependency. </dd><dt><span class="term"> <span class="strong"><strong>REL_WITH</strong></span> </span></dt><dd> Like REL_AND, but packages must match both dependencies simultaneously. See the section about boolean dependencies about more information. </dd><dt><span class="term"> <span class="strong"><strong>REL_NAMESPACE</strong></span> </span></dt><dd> A special namespace relation. See the section about namespace dependencies for more information. </dd><dt><span class="term"> <span class="strong"><strong>REL_ARCH</strong></span> </span></dt><dd> An architecture filter dependency. The “name” part of the relation is a sub-dependency, the “evr” part is the Id of an architecture that the matching packages must have (note that this is an exact match ignoring architecture policies). </dd><dt><span class="term"> <span class="strong"><strong>REL_FILECONFLICT</strong></span> </span></dt><dd> An internal file conflict dependency used to represent file conflicts. See the pool_add_fileconflicts_deps() function. </dd><dt><span class="term"> <span class="strong"><strong>REL_COND</strong></span> </span></dt><dd> A conditional dependency, the “name” sub-dependency is only considered if the “evr” sub-dependency is fulfilled. See the section about boolean dependencies about more information. </dd><dt><span class="term"> <span class="strong"><strong>REL_UNLESS</strong></span> </span></dt><dd> A conditional dependency, the “name” sub-dependency is only considered if the “evr” sub-dependency is not fulfilled. See the section about boolean dependencies about more information. </dd><dt><span class="term"> <span class="strong"><strong>REL_COMPAT</strong></span> </span></dt><dd> A compat dependency used in Haiku to represent version ranges. The “name” part is the actual version, the “evr” part is the backwards compatibility version. </dd><dt><span class="term"> <span class="strong"><strong>REL_KIND</strong></span> </span></dt><dd> A pseudo dependency that limits the solvables to a specific kind. The kind is expected to be a prefix of the solvable name, e.g. “patch:foo” would be of kind “patch”. “REL_KIND” is only supported in the selection functions. </dd><dt><span class="term"> <span class="strong"><strong>REL_MULTIARCH</strong></span> </span></dt><dd> A debian multiarch annotation. The most common value for the “evr” part is “any”. </dd><dt><span class="term"> <span class="strong"><strong>REL_ELSE</strong></span> </span></dt><dd> The else part of a “REL_COND” or “REL_UNLESS” dependency. See the section about boolean dependencies. </dd><dt><span class="term"> <span class="strong"><strong>REL_ERROR</strong></span> </span></dt><dd> An illegal dependency. This is useful to encode dependency parse errors. </dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_functions_3"></a>6.2. Functions</h3></div></div></div><pre class="literallayout">Id pool_str2id(Pool *pool, const char *str, int create);</pre><p>Add a string to the pool of unified strings, returning the Id of the string. If <span class="emphasis"><em>create</em></span> is zero, new strings will not be added to the pool, instead Id 0 is returned.</p><pre class="literallayout">Id pool_strn2id(Pool *pool, const char *str, unsigned int len, int create);</pre><p>Same as pool_str2id, but only <span class="emphasis"><em>len</em></span> characters of the string are used. This can be used to add substrings to the pool.</p><pre class="literallayout">Id pool_rel2id(Pool *pool, Id name, Id evr, int flags, int create);</pre><p>Create a relational dependency from to other dependencies, <span class="emphasis"><em>name</em></span> and <span class="emphasis"><em>evr</em></span>, and a <span class="emphasis"><em>flag</em></span>. See the <span class="strong"><strong>REL_</strong></span> constants for the supported flags. As with pool_str2id, <span class="emphasis"><em>create</em></span> defines if new dependencies will get added or Id zero will be returned instead.</p><pre class="literallayout">Id pool_id2langid(Pool *pool, Id id, const char *lang, int create);</pre><p>Attach a language suffix to a string Id. This function can be used to create language keyname Ids from keynames, it is functional equivalent to converting the <span class="emphasis"><em>id</em></span> argument to a string, adding a “:” character and the <span class="emphasis"><em>lang</em></span> argument to the string and then converting the result back into an Id.</p><pre class="literallayout">const char *pool_id2str(const Pool *pool, Id id);</pre><p>Convert an Id back into a string. If the Id is a relational Id, the “name” part will be converted instead.</p><pre class="literallayout">const char *pool_id2rel(const Pool *pool, Id id);</pre><p>Return the relation string of a relational Id. Returns an empty string if the passed Id is not a relation.</p><pre class="literallayout">const char *pool_id2evr(const Pool *pool, Id id);</pre><p>Return the “evr” part of a relational Id as string. Returns an empty string if the passed Id is not a relation.</p><pre class="literallayout">const char *pool_dep2str(Pool *pool, Id id);</pre><p>Convert an Id back into a string. If the passed Id belongs to a relation, a string representing the relation is returned. Note that in that case the string is allocated on the pool’s temporary space.</p><pre class="literallayout">void pool_freeidhashes(Pool *pool);</pre><p>Free the hashes used to unify strings and relations. You can use this function to save memory if you know that you will no longer create new strings and relations.</p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_solvable_functions"></a>7. Solvable functions</h2></div></div></div><pre class="literallayout">Solvable *pool_id2solvable(const Pool *pool, Id p);</pre><p>Convert a solvable Id into a pointer to the solvable data. Note that the pointer may become invalid if new solvables are created or old solvables deleted, because the array storing all solvables may get reallocated.</p><pre class="literallayout">const char *pool_solvid2str(Pool *pool, Id p);</pre><p>Return a string representing the solvable with the Id <span class="emphasis"><em>p</em></span>. The string will be some canonical representation of the solvable, usually a combination of the name, the version, and the architecture.</p><pre class="literallayout">const char *pool_solvable2str(Pool *pool, Solvable *s);</pre><p>Same as pool_solvid2str, but instead of the Id, a pointer to the solvable is passed.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_dependency_matching"></a>8. Dependency matching</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_constants_4"></a>8.1. Constants</h3></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term"> <span class="strong"><strong>EVRCMP_COMPARE</strong></span> </span></dt><dd> Compare all parts of the version, treat missing parts as empty strings. </dd><dt><span class="term"> <span class="strong"><strong>EVRCMP_MATCH_RELEASE</strong></span> </span></dt><dd> A special mode for rpm version string matching. If a version misses a release part, it matches all releases. In that case the special values “-2” and “2” are returned, depending on which of the two versions did not have a release part. </dd><dt><span class="term"> <span class="strong"><strong>EVRCMP_MATCH</strong></span> </span></dt><dd> A generic match, missing parts always match. </dd><dt><span class="term"> <span class="strong"><strong>EVRCMP_COMPARE_EVONLY</strong></span> </span></dt><dd> Only compare the epoch and the version parts, ignore the release part. </dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_functions_4"></a>8.2. Functions</h3></div></div></div><pre class="literallayout">int pool_evrcmp(const Pool *pool, Id evr1id, Id evr2id, int mode);</pre><p>Compare two version Ids, return -1 if the first version is less than the second version, 0 if they are identical, and 1 if the first version is bigger than the second one.</p><pre class="literallayout">int pool_evrcmp_str(const Pool *pool, const char *evr1, const char *evr2, int mode);</pre><p>Same as pool_evrcmp(), but uses strings instead of Ids.</p><pre class="literallayout">int pool_evrmatch(const Pool *pool, Id evrid, const char *epoch, const char *version, const char *release);</pre><p>Match a version Id against an epoch, a version and a release string. Passing NULL means that the part should match everything.</p><pre class="literallayout">int pool_match_dep(Pool *pool, Id d1, Id d2);</pre><p>Returns “1” if the dependency <span class="emphasis"><em>d1</em></span> (the provider) is matched by the dependency <span class="emphasis"><em>d2</em></span>, otherwise “0” is returned. For two dependencies to match, both the “name” parts must match and the version range described by the “evr” parts must overlap.</p><pre class="literallayout">int pool_match_nevr(Pool *pool, Solvable *s, Id d);</pre><p>Like pool_match_dep, but the provider is the "self-provides" dependency of the Solvable <span class="emphasis"><em>s</em></span>, i.e. the dependency “s→name = s→evr”.</p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_whatprovides_index"></a>9. Whatprovides Index</h2></div></div></div><pre class="literallayout">void pool_createwhatprovides(Pool *pool);</pre><p>Create an index that maps dependency Ids to sets of packages that provide the dependency.</p><pre class="literallayout">void pool_freewhatprovides(Pool *pool);</pre><p>Free the whatprovides index to save memory.</p><pre class="literallayout">Id pool_whatprovides(Pool *pool, Id d);</pre><p>Return an offset into the Pool’s whatprovidesdata array. The solvables with the Ids stored starting at that offset provide the dependency <span class="emphasis"><em>d</em></span>. The solvable list is zero terminated.</p><pre class="literallayout">Id *pool_whatprovides_ptr(Pool *pool, Id d);</pre><p>Instead of returning the offset, return the pointer to the Ids stored at that offset. Note that this pointer has a very limit validity time, as any call that adds new values to the whatprovidesdata area may reallocate the array.</p><pre class="literallayout">Id pool_queuetowhatprovides(Pool *pool, Queue *q);</pre><p>Add the contents of the Queue <span class="emphasis"><em>q</em></span> to the end of the whatprovidesdata array, returning the offset into the array.</p><pre class="literallayout">void pool_addfileprovides(Pool *pool);</pre><p>Some package managers like rpm allow dependencies on files contained in other packages. To allow libsolv to deal with those dependencies in an efficient way, you need to call the addfileprovides method after creating and reading all repositories. This method will scan all dependency for file names and then scan all packages for matching files. If a filename has been matched, it will be added to the provides list of the corresponding package.</p><pre class="literallayout">void pool_addfileprovides_queue(Pool *pool, Queue *idq, Queue *idqinst);</pre><p>Same as pool_addfileprovides, but the added Ids are returned in two Queues, <span class="emphasis"><em>idq</em></span> for all repositories except the one containing the “installed” packages, <span class="emphasis"><em>idqinst</em></span> for the latter one. This information can be stored in the meta section of the repositories to speed up the next time the repository is loaded and addfileprovides is called</p><pre class="literallayout">void pool_flush_namespaceproviders(Pool *pool, Id ns, Id evr);</pre><p>Clear the cache of the providers for namespace dependencies matching namespace <span class="emphasis"><em>ns</em></span>. If the <span class="emphasis"><em>evr</em></span> argument is non-zero, the namespace dependency for exactly that dependency is cleared, otherwise all matching namespace dependencies are cleared. See the section about Namespace dependencies for further information.</p><pre class="literallayout">void pool_add_fileconflicts_deps(Pool *pool, Queue *conflicts);</pre><p>Some package managers like rpm report conflicts when a package installation overwrites a file of another installed package with different content. As file content information is not stored in the repository metadata, those conflicts can only be detected after the packages are downloaded. Libsolv provides a function to check for such conflicts, pool_findfileconflicts(). If conflicts are found, they can be added as special <span class="strong"><strong>REL_FILECONFLICT</strong></span> provides dependencies, so that the solver will know about the conflict when it is re-run.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_utility_functions"></a>10. Utility functions</h2></div></div></div><pre class="literallayout">char *pool_alloctmpspace(Pool *pool, int len);</pre><p>Allocate space on the pool’s temporary space area. This space has a limited lifetime, it will be automatically freed after a fixed amount (currently 16) of other pool_alloctmpspace() calls are done.</p><pre class="literallayout">void pool_freetmpspace(Pool *pool, const char *space);</pre><p>Give the space allocated with pool_alloctmpspace back to the system. You do not have to use this function, as the space is automatically reclaimed, but it can be useful to extend the lifetime of other pointers to the pool’s temporary space area.</p><pre class="literallayout">const char *pool_bin2hex(Pool *pool, const unsigned char *buf, int len);</pre><p>Convert some binary data to hexadecimal, returning a string allocated in the pool’s temporary space area.</p><pre class="literallayout">char *pool_tmpjoin(Pool *pool, const char *str1, const char *str2, const char *str3);</pre><p>Join three strings and return the result in the pool’s temporary space area. You can use NULL arguments if you just want to join less strings.</p><pre class="literallayout">char *pool_tmpappend(Pool *pool, const char *str1, const char *str2, const char *str3);</pre><p>Like pool_tmpjoin(), but if the first argument is the last allocated space in the pool’s temporary space area, it will be replaced with the result of the join and no new temporary space slot will be used. Thus you can join more than three strings by a combination of one pool_tmpjoin() and multiple pool_tmpappend() calls. Note that the <span class="emphasis"><em>str1</em></span> pointer is no longer usable after the call.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_data_lookup"></a>11. Data lookup</h2></div></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_constants_5"></a>11.1. Constants</h3></div></div></div><div class="variablelist"><dl class="variablelist"><dt><span class="term"> <span class="strong"><strong>SOLVID_POS</strong></span> </span></dt><dd> Use the data position stored in the pool for the lookup instead of looking up the data of a solvable. </dd><dt><span class="term"> <span class="strong"><strong>SOLVID_META</strong></span> </span></dt><dd> Use the data stored in the meta section of a repository (or repodata area) instead of looking up the data of a solvable. This constant does not work for the pool’s lookup functions, use it for the repo’s or repodata’s lookup functions instead. It’s just listed for completeness. </dd></dl></div></div><div class="section"><div class="titlepage"><div><div><h3 class="title"><a id="_functions_5"></a>11.2. Functions</h3></div></div></div><pre class="literallayout">const char *pool_lookup_str(Pool *pool, Id solvid, Id keyname);</pre><p>Return the string value stored under the attribute <span class="emphasis"><em>keyname</em></span> in solvable <span class="emphasis"><em>solvid</em></span>.</p><pre class="literallayout">unsigned long long pool_lookup_num(Pool *pool, Id solvid, Id keyname, unsigned long long notfound);</pre><p>Return the 64bit unsigned number stored under the attribute <span class="emphasis"><em>keyname</em></span> in solvable <span class="emphasis"><em>solvid</em></span>. If no such number is found, the value of the <span class="emphasis"><em>notfound</em></span> argument is returned instead.</p><pre class="literallayout">Id pool_lookup_id(Pool *pool, Id solvid, Id keyname);</pre><p>Return the Id stored under the attribute <span class="emphasis"><em>keyname</em></span> in solvable <span class="emphasis"><em>solvid</em></span>.</p><pre class="literallayout">int pool_lookup_idarray(Pool *pool, Id solvid, Id keyname, Queue *q);</pre><p>Fill the queue <span class="emphasis"><em>q</em></span> with the content of the Id array stored under the attribute <span class="emphasis"><em>keyname</em></span> in solvable <span class="emphasis"><em>solvid</em></span>. Returns “1” if an array was found, otherwise the queue will be empty and “0” will be returned.</p><pre class="literallayout">int pool_lookup_void(Pool *pool, Id solvid, Id keyname);</pre><p>Returns “1” if a void value is stored under the attribute <span class="emphasis"><em>keyname</em></span> in solvable <span class="emphasis"><em>solvid</em></span>, otherwise “0”.</p><pre class="literallayout">const char *pool_lookup_checksum(Pool *pool, Id solvid, Id keyname, Id *typep);</pre><p>Return the checksum that is stored under the attribute <span class="emphasis"><em>keyname</em></span> in solvable <span class="emphasis"><em>solvid</em></span>. The type of the checksum will be returned over the <span class="emphasis"><em>typep</em></span> pointer. If no such checksum is found, NULL will be returned and the type will be set to zero. Note that the result is stored in the Pool’s temporary space area.</p><pre class="literallayout">const unsigned char *pool_lookup_bin_checksum(Pool *pool, Id solvid, Id keyname, Id *typep);</pre><p>Return the checksum that is stored under the attribute <span class="emphasis"><em>keyname</em></span> in solvable <span class="emphasis"><em>solvid</em></span>. Returns the checksum as binary data, you can use the returned type to calculate the length of the checksum. No temporary space area is needed.</p><pre class="literallayout">const char *pool_lookup_deltalocation(Pool *pool, Id solvid, unsigned int *medianrp);</pre><p>This is a utility lookup function to return the delta location for a delta rpm. As solvables cannot store deltas, you have to use SOLVID_POS as argument and set the Pool’s datapos pointer to point to valid delta rpm data.</p><pre class="literallayout">void pool_search(Pool *pool, Id solvid, Id keyname, const char *match, int flags, int (*callback)(void *cbdata, Solvable *s, Repodata *data, Repokey *key, KeyValue *kv), void *cbdata);</pre><p>Perform a search on all data stored in the pool. You can limit the search area by using the <span class="emphasis"><em>solvid</em></span> and <span class="emphasis"><em>keyname</em></span> arguments. The values can be optionally matched against the <span class="emphasis"><em>match</em></span> argument, use NULL if you do not want this matching. See the Dataiterator manpage about the possible matches modes and the <span class="emphasis"><em>flags</em></span> argument. For all (matching) values, the callback function is called with the <span class="emphasis"><em>cbdata</em></span> callback argument and the data describing the value.</p></div></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_job_and_selection_functions"></a>12. Job and Selection functions</h2></div></div></div><p>A Job consists of two Ids, <span class="emphasis"><em>how</em></span> and <span class="emphasis"><em>what</em></span>. The <span class="emphasis"><em>how</em></span> part describes the action, the job flags, and the selection method while the <span class="emphasis"><em>what</em></span> part is in input for the selection. A Selection is a queue consisting of multiple jobs (thus the number of elements in the queue must be a multiple of two). See the Solver manpage for more information about jobs.</p><pre class="literallayout">const char *pool_job2str(Pool *pool, Id how, Id what, Id flagmask);</pre><p>Convert a job into a string. Useful for debugging purposes. The <span class="emphasis"><em>flagmask</em></span> can be used to mask the flags of the job, use “0” if you do not want to see such flags, “-1” to see all flags, or a combination of the flags you want to see.</p><pre class="literallayout">void pool_job2solvables(Pool *pool, Queue *pkgs, Id how, Id what);</pre><p>Return a list of solvables that the specified job selects.</p><pre class="literallayout">int pool_isemptyupdatejob(Pool *pool, Id how, Id what);</pre><p>Return “1” if the job is an update job that does not work with any installed package, i.e. the job is basically a no-op. You can use this to turn no-op update jobs into install jobs (as done by package managers like “zypper”).</p><pre class="literallayout">const char *pool_selection2str(Pool *pool, Queue *selection, Id flagmask);</pre><p>Convert a selection into a string. Useful for debugging purposes. See the pool_job2str() function for the <span class="emphasis"><em>flagmask</em></span> argument.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_odds_and_ends"></a>13. Odds and Ends</h2></div></div></div><pre class="literallayout">void pool_freeallrepos(Pool *pool, int reuseids);</pre><p>Free all repos from the pool (including all solvables). If <span class="emphasis"><em>reuseids</em></span> is true, all Ids of the solvables are free to be reused the next time solvables are created.</p><pre class="literallayout">void pool_clear_pos(Pool *pool);</pre><p>Clear the data position stored in the pool.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_architecture_policies"></a>14. Architecture Policies</h2></div></div></div><p>An architecture policy defines a list of architectures that can be installed on the system, and also the relationship between them (i.e. the ordering). Architectures can be delimited with three different characters:</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> <span class="strong"><strong>':'</strong></span> </span></dt><dd> No relationship between the architectures. A package of one architecture can not be replaced with one of the other architecture. </dd><dt><span class="term"> <span class="strong"><strong>'>'</strong></span> </span></dt><dd> The first architecture is better than the second one. An installed package of the second architecture may be replaced with one from the first architecture and vice versa. The solver will select the better architecture if the versions are the same. </dd><dt><span class="term"> <span class="strong"><strong>'='</strong></span> </span></dt><dd> The two architectures are freely exchangeable. Used to define aliases for architectures. </dd></dl></div><p>An example would be '<code class="literal">x86_64:i686=athlon>i586</code>'. This means that x86_64 packages can only be replaced by other x86_64 packages, i686 packages can be replaced by i686 and i586 packages (but i686 packages will be preferred) and athlon is another name for the i686 architecture.</p><p>You can turn off the architecture replacement checks with the Solver’s SOLVER_FLAG_ALLOW_ARCHCHANGE flag.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_vendor_policies"></a>15. Vendor Policies</h2></div></div></div><p>Different vendors often compile packages with different features, so Libsolv only replace installed packages of one vendor with packages coming from the same vendor. Also, while the version of a package is normally defined by the upstream project, the release part of the version is set by the vendor’s package maintainer, so it’s not meaningful to do version comparisons for packages coming from different vendors.</p><p>Vendor in this case means the SOLVABLE_VENDOR string stored in each solvable. Sometimes a vendor changes names, or multiple vendors form a group that coordinate their package building, so libsolv offers a way to define that a group of vendors are compatible. You do that be defining vendor equivalence classes, packages from a vendor from one class may be replaced with packages from all the other vendors in the class.</p><p>There can be multiple equivalence classes, the set of allowed vendor changes for an installed package is calculated by building the union of all of the equivalence classes the vendor of the installed package is part of.</p><p>You can turn off the architecture replacement checks with the Solver’s SOLVER_FLAG_ALLOW_VENDORCHANGE flag.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_boolean_dependencies"></a>16. Boolean Dependencies</h2></div></div></div><p>Boolean Dependencies allow to build complex expressions from simple dependencies. Note that depending on the package manager only a subset of those may be useful. For example, debian currently only allows an "OR" expression.</p><div class="variablelist"><dl class="variablelist"><dt><span class="term"> <span class="strong"><strong>REL_OR</strong></span> </span></dt><dd> The expression is true if either the first dependency or the second one is true. This is useful for package dependencies like “Requires”, where you can specify that either one of the packages need to be installed. </dd><dt><span class="term"> <span class="strong"><strong>REL_AND</strong></span> </span></dt><dd> The expression is true if both dependencies are true. The packages fulfilling the dependencies may be different, i.e. “Supplements: perl REL_AND python” is true if both a package providing perl and a package providing python are installed. </dd><dt><span class="term"> <span class="strong"><strong>REL_WITH</strong></span> </span></dt><dd> The expression is true if both dependencies are true and are fulfilled by the same package. Thus “Supplements: perl REL_WITH python” would only be true if a package is installed that provides both dependencies (some kind of multi-language interpreter). </dd><dt><span class="term"> <span class="strong"><strong>REL_COND</strong></span> </span></dt><dd> The expression is true if the first dependency is true or the second dependency is false. “A REL_COND B” is equivalent to “A REL_OR (NOT B)” (except that libsolv does not expose “NOT”). </dd><dt><span class="term"> <span class="strong"><strong>REL_UNLESS</strong></span> </span></dt><dd> The expression is true if the first dependency is true and the second dependency is false. “A REL_UNLESS B” is equivalent to “A REL_AND (NOT B)” (except that libsolv does not expose “NOT”). </dd><dt><span class="term"> <span class="strong"><strong>REL_ELSE</strong></span> </span></dt><dd> The “else” part of a “REL_COND” or “REL_UNLESS” dependency. It has to be directly in the evr part of the condition, e.g. “foo REL_COND (bar REL_ELSE baz)”. For “REL_COND” this is equivalent to writing “(foo REL_COND bar) REL_AND (bar REL_OR baz)”. For “REL_UNLESS” this is equivalent to writing “(foo REL_UNLESS bar) REL_OR (bar REL_AND baz)”. </dd></dl></div><p>Each sub-dependency of a boolean dependency can in turn be a boolean dependency, so you can chain them to create complex dependencies.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_namespace_dependencies"></a>17. Namespace Dependencies</h2></div></div></div><p>Namespace dependencies can be used to implement dependencies on attributes external to libsolv. An example would be a dependency on the language set by the user. This types of dependencies are usually only used for “Conflicts” or “Supplements” dependencies, as the underlying package manager does not know how to deal with them.</p><p>If the library needs to evaluate a namespace dependency, it calls the namespace callback function set in the pool. The callback function can return a set of packages that “provide” the dependency. If the dependency is provided by the system, the returned set should consist of just the system solvable (Solvable Id 1).</p><p>The returned set of packages must be returned as offset into the whatprovidesdata array. You can use the pool_queuetowhatprovides function to convert a queue into such an offset. To ease programming the callback function, the return values “0” and “1” are not interpreted as an offset. “0” means that no package is in the return set, “1” means that just the system solvable is in the set.</p><p>The returned set is cached, so that for each namespace dependency the callback is just called once. If you need to flush the cache (maybe because the user has selected a different language), use the pool_flush_namespaceproviders() function.</p></div><div class="section"><div class="titlepage"><div><div><h2 class="title" style="clear: both"><a id="_author"></a>18. Author</h2></div></div></div><p>Michael Schroeder <<a class="ulink" href="mailto:mls@suse.de" target="_top">mls@suse.de</a>></p></div></div></body></html>
distrib
>
Mageia
>
6
>
x86_64
>
media
>
core-updates
>
by-pkgid
>
a039f46bdecdb20074dc367bcca6e5e9
>
files
>
5
