rpm  4.5
Files | Typedefs | Enumerations | Functions
RPMDB Database API.
Collaboration diagram for RPMDB Database API.:

Files

file  rpmlib.h
 In Memoriam: Steve Taylor stayl.nosp@m.or@r.nosp@m.edhat.nosp@m..com was here, now he's not.
 
file  dbconfig.c
 
file  hdrNVR.c
 
file  rpmdb.c
 
file  rpmdb.h
 Access RPM indices using Berkeley DB interface(s).
 

Typedefs

typedef struct rpmdb_s * rpmdb
 Database of headers and tag value indices.
 
typedef struct
_rpmdbMatchIterator
rpmdbMatchIterator
 Database iterator.
 
typedef struct _dbiIndexSet * dbiIndexSet
 A single element (i.e.
 

Enumerations

enum  rpmdbFlags { RPMDB_FLAG_JUSTCHECK = (1 << 0), RPMDB_FLAG_MINIMAL = (1 << 1), RPMDB_FLAG_CHROOT = (1 << 2) }
 

Functions

int rpmdbFindFpList (rpmdb db, fingerPrint *fpList, dbiIndexSet *matchList, int numItems, unsigned int exclude)
 Find fingerprint matches in database.
 
rpmdb rpmdbUnlink (rpmdb db, const char *msg)
 Unreference a database instance.
 
rpmdb rpmdbLink (rpmdb db, const char *msg)
 Reference a database instance.
 
int rpmdbOpen (const char *prefix, rpmdb *dbp, int mode, int perms)
 Open rpm database.
 
int rpmdbInit (const char *prefix, int perms)
 Initialize database.
 
int rpmdbVerifyAllDBI (rpmdb db)
 Verify all database components.
 
int rpmdbVerify (const char *prefix)
 Open and verify all database components.
 
int rpmdbClose (rpmdb db)
 Close all database indices and free rpmdb.
 
int rpmdbSync (rpmdb db)
 Sync all database indices.
 
int rpmdbOpenAll (rpmdb db)
 Open all database indices.
 
int rpmdbCount (rpmdb db, rpmTag tag, const void *keyp, size_t keylen)
 Return number of instances of key in a tag index.
 
int rpmdbCountPackages (rpmdb db, const char *name)
 Return number of instances of package in Name index.
 
unsigned int rpmdbGetIteratorOffset (rpmdbMatchIterator mi)
 Return header join key for current position of rpm database iterator.
 
int rpmdbGetIteratorCount (rpmdbMatchIterator mi)
 Return number of elements in rpm database iterator.
 
int rpmdbAppendIterator (rpmdbMatchIterator mi, const int *hdrNums, int nHdrNums)
 Append items to set of package instances to iterate.
 
int rpmdbPruneIterator (rpmdbMatchIterator mi, int *hdrNums, int nHdrNums, int sorted)
 Remove items from set of package instances to iterate.
 
int rpmdbSetIteratorRE (rpmdbMatchIterator mi, rpmTag tag, rpmMireMode mode, const char *pattern)
 Add pattern to iterator selector.
 
int rpmdbSetIteratorRewrite (rpmdbMatchIterator mi, int rewrite)
 Prepare iterator for lazy writes.
 
int rpmdbSetIteratorModified (rpmdbMatchIterator mi, int modified)
 Modify iterator to mark header for lazy write on release.
 
int rpmdbSetHdrChk (rpmdbMatchIterator mi, rpmts ts, rpmRC(*hdrchk)(rpmts ts, const void *uh, size_t uc, const char **msg))
 Modify iterator to verify retrieved header blobs.
 
rpmdbMatchIterator rpmdbInitIterator (rpmdb db, rpmTag rpmtag, const void *keyp, size_t keylen)
 Return database iterator.
 
Header rpmdbNextIterator (rpmdbMatchIterator mi)
 Return next package header from iteration.
 
int rpmdbCheckTerminate (int terminate)
 Check rpmdb signal handler for trapped signal and/or requested exit.
 
int rpmdbCheckSignals (void)
 Check for and exit on termination signals.
 
rpmdbMatchIterator rpmdbFreeIterator (rpmdbMatchIterator mi)
 Destroy rpm database iterator.
 
int rpmdbAdd (rpmdb db, int iid, Header h, rpmts ts, rpmRC(*hdrchk)(rpmts ts, const void *uh, size_t uc, const char **msg))
 Add package header to rpm database and indices.
 
int rpmdbRemove (rpmdb db, int rid, unsigned int hdrNum, rpmts ts, rpmRC(*hdrchk)(rpmts ts, const void *uh, size_t uc, const char **msg))
 Remove package header from rpm database and indices.
 
int rpmdbRebuild (const char *prefix, rpmts ts, rpmRC(*hdrchk)(rpmts ts, const void *uh, size_t uc, const char **msg))
 Rebuild database indices from package headers.
 

Detailed Description

Typedef Documentation

typedef struct _dbiIndexSet* dbiIndexSet

A single element (i.e.

inverted list from tag values) of a database.

Definition at line 39 of file rpmdb.h.

typedef struct rpmdb_s* rpmdb

Database of headers and tag value indices.

Definition at line 104 of file rpmlib.h.

Database iterator.

Definition at line 109 of file rpmlib.h.

Enumeration Type Documentation

enum rpmdbFlags
Enumerator:
RPMDB_FLAG_JUSTCHECK 
RPMDB_FLAG_MINIMAL 
RPMDB_FLAG_CHROOT 

Definition at line 467 of file rpmdb.h.

Function Documentation

int rpmdbAdd ( rpmdb  db,
int  iid,
Header  h,
rpmts  ts,
rpmRC(*)(rpmts ts, const void *uh, size_t uc, const char **msg)  hdrchk 
)
int rpmdbAppendIterator ( rpmdbMatchIterator  mi,
const int *  hdrNums,
int  nHdrNums 
)

Append items to set of package instances to iterate.

Parameters
mirpm database iterator
hdrNumsarray of package instances
nHdrNumsnumber of elements in array
Returns
0 on success, 1 on failure (bad args)

Definition at line 2627 of file rpmdb.c.

References dbiAppendSet(), _rpmdbMatchIterator::mi_set, and xcalloc().

Referenced by markReplacedFiles().

int rpmdbCheckSignals ( void  )

Check for and exit on termination signals.

Definition at line 741 of file rpmdb.c.

References D_, EXIT_FAILURE, rpmdbCheckTerminate(), RPMMESS_DEBUG, rpmMessage, and rpmsqCaught.

Referenced by checkSignals(), rpmdbFreeIterator(), rpmdbInitIterator(), rpmQueryVerify(), rpmtsRun(), and unblockSignals().

int rpmdbCheckTerminate ( int  terminate)

Check rpmdb signal handler for trapped signal and/or requested exit.

Clean up any open iterators and databases on termination condition. On non-zero exit any open references to rpmdb are invalid and cannot be accessed anymore, calling process should terminate immediately.

Parameters
terminate0 to only check for signals, 1 to terminate anyway
Returns
0 to continue, 1 if termination cleanup was done.

Definition at line 697 of file rpmdb.c.

References _rpmdbMatchIterator::mi_next, rpmdbClose(), rpmdbFreeIterator(), and rpmsqCaught.

Referenced by rpm_exithook(), and rpmdbCheckSignals().

int rpmdbClose ( rpmdb  db)

Close all database indices and free rpmdb.

Parameters
dbrpm database
Returns
0 on success

Definition at line 959 of file rpmdb.c.

References _free(), next, PBM_FREE, rpmdbRock, rpmdbUnlink(), and rpmsqEnable().

Referenced by rpmdb_dealloc(), rpmdbCheckTerminate(), rpmdbInit(), rpmdbOpenDatabase(), rpmdbRebuild(), rpmdbVerifyAllDBI(), rpmtsCloseDB(), and rpmtsCloseSDB().

int rpmdbCount ( rpmdb  db,
rpmTag  tag,
const void *  keyp,
size_t  keylen 
)

Return number of instances of key in a tag index.

Parameters
dbrpm database
tagrpm tag
keypkey data
keylenkey data length (0 will use strlen(keyp))
Returns
number of instances

Definition at line 1537 of file rpmdb.c.

References _, alloca(), dbiFreeIndexSet(), dbiIndexSetCount(), dbiOpen(), dbt2set(), mapTagName(), RPMERR_DBGETINDEX, and rpmError.

Referenced by rpmdbCountPackages().

int rpmdbCountPackages ( rpmdb  db,
const char *  name 
)

Return number of instances of package in Name index.

Parameters
dbrpm database
namerpm package name
Returns
number of instances

Definition at line 1600 of file rpmdb.c.

References rpmdbCount(), and RPMTAG_NAME.

Referenced by handleOneTrigger(), rpmpsmStage(), and runTriggers().

int rpmdbFindFpList ( rpmdb  db,
fingerPrint fpList,
dbiIndexSet matchList,
int  numItems,
unsigned int  exclude 
)

Find fingerprint matches in database.

Parameters
dbrpm database
fpListfingerprint array
Return values
matchListreturned fingerprint matches
Parameters
numItemsnumber of fingerprint items
excludeexcluded header instance (0 to disable)
Returns
0 always

Definition at line 3547 of file rpmdb.c.

References _db_tagged_file_indices, _free(), dbiAppendSet(), FP_EQUAL, fpCacheCreate(), fpCacheFree(), fpLookupList(), headerFreeData(), headerGetEntryMinMemory(), _rpmdbMatchIterator::mi_data, _rpmdbMatchIterator::mi_key, _rpmdbMatchIterator::mi_set, _rpmdbMatchIterator::mi_setx, rpmdbFreeIterator(), rpmdbGetIteratorCount(), rpmdbGrowIterator(), rpmdbInitIterator(), rpmdbNextIterator(), rpmdbSortIterator(), RPMTAG_BASENAMES, RPMTAG_DIRINDEXES, RPMTAG_DIRNAMES, taghash(), and xcalloc().

Referenced by rpmtsRun().

rpmdbMatchIterator rpmdbFreeIterator ( rpmdbMatchIterator  mi)
int rpmdbGetIteratorCount ( rpmdbMatchIterator  mi)

Return number of elements in rpm database iterator.

Parameters
mirpm database iterator
Returns
number of elements

Definition at line 1941 of file rpmdb.c.

References _rpmdbMatchIterator::mi_set.

Referenced by rpmdbFindFpList(), rpmfcFindRequiredPackages(), rpmInstall(), rpmmi_Count(), rpmts_AddErase(), and runImmedTriggers().

unsigned int rpmdbGetIteratorOffset ( rpmdbMatchIterator  mi)

Return header join key for current position of rpm database iterator.

Parameters
mirpm database iterator
Returns
current header join key

Definition at line 1933 of file rpmdb.c.

References _rpmdbMatchIterator::mi_offset.

Referenced by IDTXload(), markReplacedFiles(), rpmErase(), rpmgiNext(), rpmmi_Instance(), rpmpsmStage(), rpmts_AddErase(), rpmtsAddObsoletes(), rpmtsAddUpgrades(), and rpmtsFindPubkey().

int rpmdbInit ( const char *  prefix,
int  perms 
)

Initialize database.

Parameters
prefixpath to top of install tree
permsdatabase permissions
Returns
0 on success

Definition at line 1296 of file rpmdb.c.

References RPMDB_FLAG_JUSTCHECK, rpmdbClose(), rpmdbOpenAll(), rpmdbOpenDatabase(), and rpmExpandNumeric().

Referenced by rpmtsInitDB().

rpmdbMatchIterator rpmdbInitIterator ( rpmdb  db,
rpmTag  rpmtag,
const void *  keyp,
size_t  keylen 
)
rpmdb rpmdbLink ( rpmdb  db,
const char *  msg 
)

Reference a database instance.

Parameters
dbrpm database
msg
Returns
new rpm database reference

Referenced by db3open(), rpmdbInitIterator(), and rpmdbNew().

Header rpmdbNextIterator ( rpmdbMatchIterator  mi)

Return next package header from iteration.

Parameters
mirpm database iterator
Returns
NULL on end of iteration.

Definition at line 2281 of file rpmdb.c.

References _, _DBSWAP, _free(), _USE_COPY_LOAD, dbiIndexRecordFileNumber(), dbiIndexRecordOffset(), dbiOpen(), headerToken_s::flags, headerCopyLoad(), HEADERFLAG_ALLOCATED, headerIsEntry(), headerLoad(), headerSetInstance(), headerSetOrigin(), _rpmdbMatchIterator::mi_cflags, _rpmdbMatchIterator::mi_data, _rpmdbMatchIterator::mi_db, _rpmdbMatchIterator::mi_dbc, _rpmdbMatchIterator::mi_filenum, _rpmdbMatchIterator::mi_h, _rpmdbMatchIterator::mi_hdrchk, _rpmdbMatchIterator::mi_key, _rpmdbMatchIterator::mi_keylen, _rpmdbMatchIterator::mi_keyp, _rpmdbMatchIterator::mi_modified, _rpmdbMatchIterator::mi_offset, _rpmdbMatchIterator::mi_prevoffset, _rpmdbMatchIterator::mi_set, _rpmdbMatchIterator::mi_setx, _rpmdbMatchIterator::mi_ts, miFreeHeader(), mireSkip(), PBM_ISSET, PBM_REALLOC(), PBM_SET, RPMDBI_PACKAGES, RPMERR_BADHEADER, rpmError, RPMMESS_DEBUG, RPMMESS_ERROR, rpmMessage, RPMRC_FAIL, RPMRC_NOTFOUND, RPMRC_OK, RPMTAG_NAME, and _dbswap::ui.

Referenced by checkPackageSet(), dbiFindMatches(), handleInstInstalledFiles(), handleRmvdInstalledFiles(), IDTXload(), markReplacedFiles(), rpmcliShowMatches(), rpmdb_length(), rpmdb_subscript(), rpmdbFindByFile(), rpmdbFindFpList(), rpmdbRebuild(), rpmdbRemove(), rpmErase(), rpmfcFindRequiredPackages(), rpmgiNext(), rpmInstall(), rpmmi_iternext(), rpmpsmStage(), rpmts_AddErase(), rpmtsAddObsoletes(), rpmtsAddUpgrades(), rpmtsFindPubkey(), rpmtsRun(), rpmtsSolve(), runImmedTriggers(), runTriggers(), and unsatisfiedDepend().

int rpmdbOpen ( const char *  prefix,
rpmdb dbp,
int  mode,
int  perms 
)

Open rpm database.

Parameters
prefixpath to top of install tree
Return values
dbpaddress of rpm database
Parameters
modeopen(2) flags: O_RDWR or O_RDONLY (O_CREAT also)
permsdatabase permissions
Returns
0 on success

Definition at line 1288 of file rpmdb.c.

References rpmdbOpenDatabase(), and rpmExpandNumeric().

Referenced by rpmtsOpenDB(), and rpmtsOpenSDB().

int rpmdbOpenAll ( rpmdb  db)

Open all database indices.

Parameters
dbrpm database
Returns
0 on success

Definition at line 884 of file rpmdb.c.

References dbiOpen(), RPMDBI_ADDED, RPMDBI_AVAILABLE, RPMDBI_DEPENDS, and RPMDBI_REMOVED.

Referenced by rpmdbInit(), rpmdbVerifyAllDBI(), and rpmtsRun().

int rpmdbPruneIterator ( rpmdbMatchIterator  mi,
int *  hdrNums,
int  nHdrNums,
int  sorted 
)

Remove items from set of package instances to iterate.

Note
Sorted hdrNums are always passed in rpmlib.
Parameters
mirpm database iterator
hdrNumsarray of package instances
nHdrNumsnumber of elements in array
sortedis the array sorted? (array will be sorted on return)
Returns
0 on success, 1 on failure (bad args)

Definition at line 2616 of file rpmdb.c.

References dbiPruneSet(), and _rpmdbMatchIterator::mi_set.

Referenced by checkPackageSet(), rpmtsAddObsoletes(), and unsatisfiedDepend().

int rpmdbRebuild ( const char *  prefix,
rpmts  ts,
rpmRC(*)(rpmts ts, const void *uh, size_t uc, const char **msg)  hdrchk 
)
int rpmdbRemove ( rpmdb  db,
int  rid,
unsigned int  hdrNum,
rpmts  ts,
rpmRC(*)(rpmts ts, const void *uh, size_t uc, const char **msg)  hdrchk 
)
int rpmdbSetHdrChk ( rpmdbMatchIterator  mi,
rpmts  ts,
rpmRC(*)(rpmts ts, const void *uh, size_t uc, const char **msg)  hdrchk 
)

Modify iterator to verify retrieved header blobs.

Parameters
mirpm database iterator
tstransaction set
(*hdrchk)headerCheck() vector
Returns
0 always

Definition at line 2266 of file rpmdb.c.

References _rpmdbMatchIterator::mi_hdrchk, and _rpmdbMatchIterator::mi_ts.

Referenced by rpmdbRebuild(), and rpmtsInitIterator().

int rpmdbSetIteratorModified ( rpmdbMatchIterator  mi,
int  modified 
)

Modify iterator to mark header for lazy write on release.

Parameters
mirpm database iterator
modifiednew value of modified
Returns
previous value

Definition at line 2256 of file rpmdb.c.

References _rpmdbMatchIterator::mi_modified.

Referenced by markReplacedFiles().

int rpmdbSetIteratorRE ( rpmdbMatchIterator  mi,
rpmTag  tag,
rpmMireMode  mode,
const char *  pattern 
)

Add pattern to iterator selector.

Parameters
mirpm database iterator
tagrpm tag
modetype of pattern match
patternpattern to match
Returns
0 on success

Definition at line 2057 of file rpmdb.c.

References _free(), _rpmdbMatchIterator::mi_nre, _rpmdbMatchIterator::mi_re, mireCmp(), mireDup(), rpmExpand(), and xrealloc().

Referenced by dbiFindMatches(), IDTXload(), rpmdbRebuild(), rpmgiInitFilter(), rpmmi_Pattern(), rpmpsmStage(), rpmtsInitIterator(), and rpmtsRun().

int rpmdbSetIteratorRewrite ( rpmdbMatchIterator  mi,
int  rewrite 
)

Prepare iterator for lazy writes.

Note
Must be called before rpmdbNextIterator() with CDB model database.
Parameters
mirpm database iterator
rewritenew value of rewrite
Returns
previous value

Definition at line 2243 of file rpmdb.c.

References _rpmdbMatchIterator::mi_cflags.

Referenced by markReplacedFiles().

int rpmdbSync ( rpmdb  db)

Sync all database indices.

Parameters
dbrpm database
Returns
0 on success

Definition at line 1018 of file rpmdb.c.

Referenced by rpmtsRun().

rpmdb rpmdbUnlink ( rpmdb  db,
const char *  msg 
)

Unreference a database instance.

Parameters
dbrpm database
msg
Returns
NULL always

Referenced by rpmdbClose(), and rpmdbFreeIterator().

int rpmdbVerify ( const char *  prefix)

Open and verify all database components.

Parameters
prefixpath to top of install tree
Returns
0 on success

Definition at line 1346 of file rpmdb.c.

References rpmdbOpenDatabase(), rpmdbVerifyAllDBI(), and rpmExpandNumeric().

Referenced by rpmtsVerifyDB().

int rpmdbVerifyAllDBI ( rpmdb  db)

Verify all database components.

Parameters
dbrpm database
Returns
0 on success

Definition at line 1317 of file rpmdb.c.

References rpmdbClose(), and rpmdbOpenAll().

Referenced by db3open(), and rpmdbVerify().