# rpmdb/rpmdb.c File Reference

`#include "system.h"`
`#include <sys/file.h>`
`#include <signal.h>`
`#include <sys/signal.h>`
`#include <fnmatch.h>`
`#include <regex.h>`
`#include <rpmcli.h>`
`#include "rpmdb.h"`
`#include "fprint.h"`
`#include "misc.h"`
`#include "debug.h"`

Go to the source code of this file.

## Data Structures

union | _dbswap
struct | miRE_s
struct | _rpmdbMatchIterator

## Defines

#define | INLINE
#define | _DBI_FLAGS 0
#define | _DBI_PERMS 0644
#define | _DBI_MAJOR -1
#define | DB1vec NULL
#define | DB2vec NULL
#define | DB3vec NULL
#define | _DBSWAP(_a)
#define | _DB_ROOT "/"
#define | _DB_HOME "%{_dbpath}"
#define | _DB_FLAGS 0
#define | _DB_MODE 0
#define | _DB_PERMS 0644
#define | _DB_MAJOR -1
#define | _DB_ERRPFX "rpmdb"
#define | _RECNUM rpmdbGetIteratorOffset(mi)

## Typedefs

typedef struct miRE_s * | miRE

## Functions

static int | dbiTagToDbix (int rpmtag)
| Return dbi index used for rpm tag.
static void | dbiTagsInit (void)
| Initialize database (index, tag) tuple from configuration.
int | dbiSync (dbiIndex dbi, unsigned int flags)
| Flush pending operations to disk.
int | dbiByteSwapped (dbiIndex dbi)
| Is database byte swapped?
int | dbiCopen (dbiIndex dbi, DBC **dbcp, unsigned int flags)
int | dbiCclose (dbiIndex dbi, DBC *dbcursor, unsigned int flags)
static int | printable (const void *ptr, size_t len)
int | dbiDel (dbiIndex dbi, DBC *dbcursor, const void *keyp, size_t keylen, unsigned int flags)
| Delete (key,data) pair(s) from index database.
int | dbiGet (dbiIndex dbi, DBC *dbcursor, void **keypp, size_t *keylenp, void **datapp, size_t *datalenp, unsigned int flags)
| Retrieve (key,data) pair from index database.
int | dbiPut (dbiIndex dbi, DBC *dbcursor, const void *keyp, size_t keylen, const void *datap, size_t datalen, unsigned int flags)
| Store (key,data) pair in index database.
int | dbiCount (dbiIndex dbi, DBC *dbcursor, unsigned int *countp, unsigned int flags)
| Retrieve count of (possible) duplicate items.
int | dbiVerify (dbiIndex dbi, unsigned int flags)
| Verify (and close) index database.
int | dbiClose (dbiIndex dbi, unsigned int flags)
| Close index database.
dbiIndex | dbiOpen (rpmdb db, int rpmtag, unsigned int flags)
| Return handle for an index database.
static dbiIndexItem | dbiIndexNewItem (unsigned int hdrNum, unsigned int tagNum)
| Create and initialize item for index database set.
static int | dbiSearch (dbiIndex dbi, DBC *dbcursor, const char *keyp, size_t keylen, dbiIndexSet *setp)
| Return items that match criteria.
static int | dbiUpdateIndex (dbiIndex dbi, DBC *dbcursor, const void *keyp, size_t keylen, dbiIndexSet set)
| Change/delete items that match criteria.
static int | hdrNumCmp (const void *one, const void *two)
static int | dbiAppendSet (dbiIndexSet set, const void *recs, int nrecs, size_t recsize, int sortset)
| Append element(s) to set of index database items.
static int | dbiPruneSet (dbiIndexSet set, void *recs, int nrecs, size_t recsize, int sorted)
| Remove element(s) from set of index database items.
unsigned int | dbiIndexSetCount (dbiIndexSet set)
| Count items in index database set.
unsigned int | dbiIndexRecordOffset (dbiIndexSet set, int recno)
| Return record offset of header from element in index database set.
unsigned int | dbiIndexRecordFileNumber (dbiIndexSet set, int recno)
| Return file index from element in index database set.
dbiIndexSet | dbiFreeIndexSet (dbiIndexSet set)
| Destroy set of index database items.
static int | blockSignals (rpmdb db, sigset_t *oldMask)
| Disable all signals, returning previous signal mask.
static int | unblockSignals (rpmdb db, sigset_t *oldMask)
| Restore signal mask.
int | rpmdbOpenAll (rpmdb db)
| Open all database indices.
int | rpmdbClose (rpmdb db)
| Close all database indices and free rpmdb.
int | rpmdbSync (rpmdb db)
| Sync all database indices.
static rpmdb | newRpmdb (const char *root, const char *home, int mode, int perms, int flags)
static int | openDatabase (const char *prefix, const char *dbpath, int _dbapi, rpmdb *dbp, int mode, int perms, int flags)
int | rpmdbOpen (const char *prefix, rpmdb *dbp, int mode, int perms)
| Open rpm database.
int | rpmdbInit (const char *prefix, int perms)
| Initialize database.
int | rpmdbVerify (const char *prefix)
| Verify database components.
static int | rpmdbFindByFile (rpmdb db, const char *filespec, dbiIndexSet *matches)
int | rpmdbCountPackages (rpmdb db, const char *name)
| Return number of instances of package in rpm database.
static int | dbiFindMatches (dbiIndex dbi, DBC *dbcursor, const char *name, const char *version, const char *release, dbiIndexSet *matches)
| Attempt partial matches on name[-version[-release]] strings.
static int | dbiFindByLabel (dbiIndex dbi, DBC *dbcursor, const char *arg, dbiIndexSet *matches)
| Lookup by name, name-version, and finally by name-version-release.
static int | dbiUpdateRecord (dbiIndex dbi, DBC *dbcursor, int offset, Header h)
| Rewrite a header in the database.
rpmdbMatchIterator | rpmdbFreeIterator (rpmdbMatchIterator mi)
| Destroy rpm database iterator.
rpmdb | rpmdbGetIteratorRpmDB (rpmdbMatchIterator mi)
| Return rpm database used by iterator.
unsigned int | rpmdbGetIteratorOffset (rpmdbMatchIterator mi)
| Return join key for current position of rpm database iterator.
unsigned int | rpmdbGetIteratorFileNum (rpmdbMatchIterator mi)
int | rpmdbGetIteratorCount (rpmdbMatchIterator mi)
| Return number of elements in rpm database iterator.
static int | miregexec (miRE mire, const char *val)
| Return pattern match.
static int | mireCmp (const void *a, const void *b)
| Compare iterator selctors by rpm tag (qsort/bsearch).
static char * | mireDup (rpmTag tag, rpmMireMode *modep, const char *pattern)
| Copy pattern, escaping for appropriate mode.
int | rpmdbSetIteratorRE (rpmdbMatchIterator mi, rpmTag tag, rpmMireMode mode, const char *pattern)
| Add pattern to iterator selector.
static int | mireSkip (const rpmdbMatchIterator mi)
| Return iterator selector match.
int | rpmdbSetIteratorRelease (rpmdbMatchIterator mi, const char *release)
| Modify iterator to filter out headers that do not match release.
int | rpmdbSetIteratorVersion (rpmdbMatchIterator mi, const char *version)
| Modify iterator to filter out headers that do not match version.
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.
Header | XrpmdbNextIterator (rpmdbMatchIterator mi, const char *f, unsigned int l)
Header | rpmdbNextIterator (rpmdbMatchIterator mi)
| Return next package header from iteration.
static void | rpmdbSortIterator (rpmdbMatchIterator mi)
static int | rpmdbGrowIterator (rpmdbMatchIterator mi, const void *keyp, size_t keylen, int fpNum)
int | rpmdbPruneIterator (rpmdbMatchIterator mi, int *hdrNums, int nHdrNums, int sorted)
| Remove items from set of package instances to iterate.
int | rpmdbAppendIterator (rpmdbMatchIterator mi, const int *hdrNums, int nHdrNums)
| Append items to set of package instances to iterate.
rpmdbMatchIterator | rpmdbInitIterator (rpmdb db, int rpmtag, const void *keyp, size_t keylen)
| Return database iterator.
static int | removeIndexEntry (dbiIndex dbi, DBC *dbcursor, const void *keyp, size_t keylen, dbiIndexItem rec)
| Remove entry from database index.
int | rpmdbRemove (rpmdb db, int rid, unsigned int hdrNum)
| Remove package header from rpm database and indices.
static int | addIndexEntry (dbiIndex dbi, DBC *dbcursor, const char *keyp, size_t keylen, dbiIndexItem rec)
| Add entry to database index.
int | rpmdbAdd (rpmdb db, int iid, Header h)
| Add package header to rpm database and indices.
int | rpmdbFindFpList (rpmdb db, fingerPrint *fpList, dbiIndexSet *matchList, int numItems)
| Find fingerprint matches in database.
char * | db1basename (int rpmtag)
| Return base file name for db1 database (legacy).
static int | rpmioFileExists (const char *urlfn)
| Check if file esists using stat(2).
static int | rpmdbRemoveDatabase (const char *prefix, const char *dbpath, int _dbapi)
static int | rpmdbMoveDatabase (const char *prefix, const char *olddbpath, int _olddbapi, const char *newdbpath, int _newdbapi)
int | rpmdbRebuild (const char *prefix)
| Rebuild database indices from package headers.

## Variables

static int | _debug = 0
int | _noDirTokens
| Should version 3 packages be produced?
static int | _rebuildinprogress = 0
static int | _db_filter_dups = 0
int * | dbiTags = NULL
| Tags for which rpmdb indices will be built.
int | dbiTagsMax = 0
static struct _dbiVec * | mydbvecs []
static struct rpmdb_s | dbTemplate

## Detailed Description

Definition in file rpmdb.c.

## Define Documentation

#define _DB_ERRPFX "rpmdb"

Definition at line 786 of file rpmdb.c.

#define _DB_FLAGS 0

Definition at line 781 of file rpmdb.c.

#define _DB_HOME "%{_dbpath}"

Definition at line 780 of file rpmdb.c.

#define _DB_MAJOR -1

Definition at line 785 of file rpmdb.c.

#define _DB_MODE 0

Definition at line 782 of file rpmdb.c.

#define _DB_PERMS 0644

Definition at line 783 of file rpmdb.c.

#define _DB_ROOT "/"

Definition at line 779 of file rpmdb.c.

#define _DBI_FLAGS 0

Definition at line 56 of file rpmdb.c.

#define _DBI_MAJOR -1

Definition at line 58 of file rpmdb.c.

#define _DBI_PERMS 0644

Definition at line 57 of file rpmdb.c.

#define _DBSWAP | ( | _a |  | ) |

Value:

    { unsigned char _b, *_c = (_a).uc; \
        _b = _c[3]; _c[3] = _c[0]; _c[0] = _b; \
        _b = _c[2]; _c[2] = _c[1]; _c[1] = _b; \
      }

Definition at line 462 of file rpmdb.c.

#define _RECNUM rpmdbGetIteratorOffset(mi)

#define DB1vec NULL

Definition at line 149 of file rpmdb.c.

#define DB2vec NULL

Definition at line 157 of file rpmdb.c.

#define DB3vec NULL

Definition at line 165 of file rpmdb.c.

#define INLINE

Definition at line 46 of file rpmdb.c.

## Typedef Documentation

typedef struct miRE_s * miRE

## Function Documentation

static int addIndexEntry | ( | dbiIndex | dbi,
|  | DBC * | dbcursor,
|  | const char * | keyp,
|  | size_t | keylen,
|  | dbiIndexItem | rec |
| ) |  |  | `[static]`

Add entry to database index.

Parameters:

  | dbi | index database handle
  | dbcursor | index database cursor
  | keyp | search key
  | keylen | search key length
  | rec | record to add

Returns:
  0 on success

Definition at line 2558 of file rpmdb.c.

static int blockSignals | ( | rpmdb | db,
|  | sigset_t * | oldMask |
| ) |  |  | `[static]`

Disable all signals, returning previous signal mask.

Definition at line 759 of file rpmdb.c.

static int dbiAppendSet | ( | dbiIndexSet | set,
|  | const void * | recs,
|  | int | nrecs,
|  | size_t | recsize,
|  | int | sortset |
| ) |  |  | `[static]`

Append element(s) to set of index database items.

Parameters:

  | set | set of index database items
  | recs | array of items to append to set
  | nrecs | number of items
  | recsize | size of an array item
  | sortset | should resulting set be sorted?

Returns:
  0 success, 1 failure (bad args)

Definition at line 665 of file rpmdb.c.

static int dbiFindByLabel | ( | dbiIndex | dbi,
|  | DBC * | dbcursor,
|  | const char * | arg,
|  | dbiIndexSet * | matches |
| ) |  |  | `[static]`

Lookup by name, name-version, and finally by name-version-release.

Both version and release can be patterns.

Todo:
  Name must be an exact match, as name is a db key.

Parameters:

  | dbi | index database handle (always RPMTAG_NAME)
  | dbcursor | index database cursor
  | arg | name[-version[-release]] string

Return values:

  | matches | set of header instances that match

Returns:
  0 on match, 1 on no match, 2 on error

Definition at line 1396 of file rpmdb.c.

static int dbiFindMatches | ( | dbiIndex | dbi,
|  | DBC * | dbcursor,
|  | const char * | name,
|  | const char * | version,
|  | const char * | release,
|  | dbiIndexSet * | matches |
| ) |  |  | `[static]`

Attempt partial matches on name[-version[-release]] strings.

Parameters:

  | dbi | index database handle (always RPMTAG_NAME)
  | dbcursor | index database cursor
  | name | package name
  | version | package version (can be a pattern)
  | release | package release (can be a pattern)

Return values:

  | matches | set of header instances that match

Returns:
  0 on match, 1 on no match, 2 on error

< Installed package headers.

Definition at line 1303 of file rpmdb.c.

static dbiIndexItem dbiIndexNewItem | ( | unsigned int | hdrNum,
|  | unsigned int | tagNum |
| ) |  |  | `[static]`

Create and initialize item for index database set.

Parameters:

  | hdrNum | header instance in db
  | tagNum | tag index in header

Returns:
  new item

Definition at line 448 of file rpmdb.c.

static int dbiPruneSet | ( | dbiIndexSet | set,
|  | void * | recs,
|  | int | nrecs,
|  | size_t | recsize,
|  | int | sorted |
| ) |  |  | `[static]`

Remove element(s) from set of index database items.

Parameters:

  | set | set of index database items
  | recs | array of items to remove from set
  | nrecs | number of items
  | recsize | size of an array item
  | sorted | array is already sorted?

Returns:
  0 success, 1 failure (no items found)

Definition at line 706 of file rpmdb.c.

static int dbiSearch | ( | dbiIndex | dbi,
|  | DBC * | dbcursor,
|  | const char * | keyp,
|  | size_t | keylen,
|  | dbiIndexSet * | setp |
| ) |  |  | `[static]`

Return items that match criteria.

Parameters:

  | dbi | index database handle
  | dbcursor | index database cursor
  | keyp | search key
  | keylen | search key length (0 will use strlen(key))

Return values:

  | setp | address of items retrieved from index database

Returns:
  -1 error, 0 success, 1 not found

Definition at line 477 of file rpmdb.c.

static void dbiTagsInit | ( | void |  | ) | `[static]`

Initialize database (index, tag) tuple from configuration.

< Installed package headers.

Definition at line 86 of file rpmdb.c.

static int dbiTagToDbix | ( | int | rpmtag | ) | `[static]`

Return dbi index used for rpm tag.

Parameters:

  | rpmtag | rpm header tag

Returns:
  dbi index, -1 on error

Definition at line 70 of file rpmdb.c.

static int dbiUpdateIndex | ( | dbiIndex | dbi,
|  | DBC * | dbcursor,
|  | const void * | keyp,
|  | size_t | keylen,
|  | dbiIndexSet | set |
| ) |  |  | `[static]`

Change/delete items that match criteria.

Parameters:

  | dbi | index database handle
  | dbcursor | index database cursor
  | keyp | update key
  | keylen | update key length
  | set | items to update in index database

Returns:
  0 success, 1 not found

Definition at line 567 of file rpmdb.c.

static int dbiUpdateRecord | ( | dbiIndex | dbi,
|  | DBC * | dbcursor,
|  | int | offset,
|  | Header | h |
| ) |  |  | `[static]`

Rewrite a header in the database.

Note: this is called from a markReplacedFiles iteration, and *must* preserve the "join key" (i.e. offset) for the header.

Parameters:

  | dbi | index database handle (always RPMDBI_PACKAGES)
  | dbcursor | index database cursor
  | offset | join key
  | h | rpm header

Returns:
  0 on success

Definition at line 1486 of file rpmdb.c.

static int hdrNumCmp | ( | const void * | one,
|  | const void * | two |
| ) |  |  | `[static]`

Definition at line 649 of file rpmdb.c.

static int mireCmp | ( | const void * | a,
|  | const void * | b |
| ) |  |  | `[static]`

Compare iterator selctors by rpm tag (qsort/bsearch).

Parameters:

  | a | 1st iterator selector
  | b | 2nd iterator selector

Returns:
  result of comparison

Definition at line 1673 of file rpmdb.c.

static char* mireDup | ( | rpmTag | tag,
|  | rpmMireMode * | modep,
|  | const char * | pattern |
| ) |  |  | `[static]`

Copy pattern, escaping for appropriate mode.

Parameters:

  | tag | rpm tag

Return values:

  | modep | type of pattern match

Parameters:

  | pattern | pattern to duplicate

Returns:
  duplicated pattern

Definition at line 1687 of file rpmdb.c.

static int miregexec | ( | miRE | mire,
|  | const char * | val |
| ) |  |  | `[static]`

Return pattern match.

Parameters:

  | mi | rpm database iterator

Returns:
  0 if pattern matches

Definition at line 1629 of file rpmdb.c.

static int mireSkip | ( | const rpmdbMatchIterator | mi | ) | `[static]`

Return iterator selector match.

Parameters:

  | mi | rpm database iterator

Returns:
  1 if header should be skipped

Definition at line 1886 of file rpmdb.c.

static rpmdb newRpmdb | ( | const char * | root,
|  | const char * | home,
|  | int | mode,
|  | int | perms,
|  | int | flags |
| ) |  |  | `[static]`

Definition at line 858 of file rpmdb.c.

static int openDatabase | ( | const char * | prefix,
|  | const char * | dbpath,
|  | int | _dbapi,
|  | rpmdb * | dbp,
|  | int | mode,
|  | int | perms,
|  | int | flags |
| ) |  |  | `[static]`

< Available package headers.

< Added package headers.

< Removed package headers.

< Dependency resolution cache.

< Installed package headers.

Definition at line 906 of file rpmdb.c.

static int printable | ( | const void * | ptr,
|  | size_t | len |
| ) |  |  | `[static]`

Definition at line 202 of file rpmdb.c.

static int removeIndexEntry | ( | dbiIndex | dbi,
|  | DBC * | dbcursor,
|  | const void * | keyp,
|  | size_t | keylen,
|  | dbiIndexItem | rec |
| ) |  |  | `[static]`

Remove entry from database index.

Parameters:

  | dbi | index database handle
  | dbcursor | index database cursor
  | keyp | search key
  | keylen | search key length
  | rec | record to remove

Returns:
  0 on success

Definition at line 2339 of file rpmdb.c.

static int rpmdbFindByFile | ( | rpmdb | db,
|  | const char * | filespec,
|  | dbiIndexSet * | matches |
| ) |  |  | `[static]`

< Installed package headers.

Definition at line 1124 of file rpmdb.c.

static int rpmdbGrowIterator | ( | rpmdbMatchIterator | mi,
|  | const void * | keyp,
|  | size_t | keylen,
|  | int | fpNum |
| ) |  |  | `[static]`

Definition at line 2159 of file rpmdb.c.

static int rpmdbMoveDatabase | ( | const char * | prefix,
|  | const char * | olddbpath,
|  | int | _olddbapi,
|  | const char * | newdbpath,
|  | int | _newdbapi |
| ) |  |  | `[static]`

< Available package headers.

< Added package headers.

< Removed package headers.

< Dependency resolution cache.

< Available package headers.

< Added package headers.

< Removed package headers.

< Dependency resolution cache.

Definition at line 3098 of file rpmdb.c.

static int rpmdbRemoveDatabase | ( | const char * | prefix,
|  | const char * | dbpath,
|  | int | _dbapi |
| ) |  |  | `[static]`

Definition at line 3034 of file rpmdb.c.

static void rpmdbSortIterator | ( | rpmdbMatchIterator | mi | ) | `[static]`

Definition at line 2149 of file rpmdb.c.

static int rpmioFileExists | ( | const char * | urlfn | ) | `[static]`

Check if file esists using stat(2).

Parameters:

  | urlfn | file name (may be URL)

Returns:
  1 if file exists, 0 if not

Definition at line 3001 of file rpmdb.c.

static int unblockSignals | ( | rpmdb | db,
|  | sigset_t * | oldMask |
| ) |  |  | `[static]`

Restore signal mask.

Definition at line 772 of file rpmdb.c.

Header XrpmdbNextIterator | ( | rpmdbMatchIterator | mi,
|  | const char * | f,
|  | unsigned int | l |
| ) |  |  |

Todo:
  Remove debugging entry from the ABI.

Definition at line 2013 of file rpmdb.c.

## Variable Documentation

int _db_filter_dups = 0`[static]`

Definition at line 54 of file rpmdb.c.

int _debug = 0`[static]`

Definition at line 45 of file rpmdb.c.

int _rebuildinprogress = 0`[static]`

Definition at line 52 of file rpmdb.c.

int dbiTagsMax = 0

Definition at line 63 of file rpmdb.c.

struct rpmdb_s dbTemplate `[static]`

Initial value:

     {
         "/" ,       "%{_dbpath}" ,  0 ,  0 ,  0644 ,
         -1 ,        "rpmdb"
    }

Definition at line 790 of file rpmdb.c.

struct _dbiVec* mydbvecs[]`[static]`

Initial value:

     {
         NULL ,  NULL ,  NULL ,  NULL , NULL
    }

Definition at line 171 of file rpmdb.c.