folkslinux
/
rpm
mirror of https://github.com/rpm-software-management/rpm.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
rpm/rpmdb/rpmdb_internal.h

672 lines
20 KiB
C
Raw Blame History

#ifndef H_RPMDB_INTERNAL
#define H_RPMDB_INTERNAL
#include <assert.h>
#include <db.h>
#include <rpm/rpmsw.h>
#include <rpm/rpmtypes.h>
/**
*/
typedef struct _dbiIndexItem * dbiIndexItem;
/** \ingroup rpmdb
* A single element (i.e. inverted list from tag values) of a database.
*/
typedef struct _dbiIndexSet * dbiIndexSet;
/**
*/
typedef struct _dbiIndex * dbiIndex;
/* this will break if sizeof(int) != 4 */
/** \ingroup dbi
* A single item from an index database (i.e. the "data returned").
* Note: In rpm-3.0.4 and earlier, this structure was passed by value,
* and was identical to the "data saved" structure below.
*/
struct _dbiIndexItem {
unsigned int hdrNum; /*!< header instance in db */
unsigned int tagNum; /*!< tag index in header */
unsigned int fpNum; /*!< finger print index */
};
/** \ingroup dbi
* Items retrieved from the index database.
*/
struct _dbiIndexSet {
struct _dbiIndexItem * recs; /*!< array of records */
int count; /*!< number of records */
};
/** \ingroup dbi
* Private methods for accessing an index database.
*/
struct _dbiVec {
int dbv_major; /*!< Berkeley db version major */
int dbv_minor; /*!< Berkeley db version minor */
int dbv_patch; /*!< Berkeley db version patch */
/** \ingroup dbi
* Return handle for an index database.
* @param rpmdb rpm database
* @param rpmtag rpm tag
* @return 0 on success
*/
int (*open) (rpmdb rpmdb, rpm_tag_t rpmtag, dbiIndex * dbip);
/** \ingroup dbi
* Close index database, and destroy database handle.
* @param dbi index database handle
* @param flags (unused)
* @return 0 on success
*/
int (*close) (dbiIndex dbi, unsigned int flags);
/** \ingroup dbi
* Flush pending operations to disk.
* @param dbi index database handle
* @param flags (unused)
* @return 0 on success
*/
int (*sync) (dbiIndex dbi, unsigned int flags);
/** \ingroup dbi
* Associate secondary database with primary.
* @param dbi index database handle
* @param dbisecondary secondary index database handle
* @param callback create secondary key from primary (NULL if DB_RDONLY)
* @param flags DB_CREATE or 0
* @return 0 on success
*/
int (*associate) (dbiIndex dbi, dbiIndex dbisecondary,
int (*callback) (DB *, const DBT *, const DBT *, DBT *),
unsigned int flags);
/** \ingroup dbi
* Return join cursor for list of cursors.
* @param dbi index database handle
* @param curslist NULL terminated list of database cursors
* @retval dbcp address of join database cursor
* @param flags DB_JOIN_NOSORT or 0
* @return 0 on success
*/
int (*join) (dbiIndex dbi, DBC ** curslist, DBC ** dbcp,
unsigned int flags);
/** \ingroup dbi
* Open database cursor.
* @param dbi index database handle
* @param txnid database transaction handle
* @retval dbcp address of new database cursor
* @param dbiflags DB_WRITECURSOR or 0
* @return 0 on success
*/
int (*copen) (dbiIndex dbi, DB_TXN * txnid,
DBC ** dbcp, unsigned int dbiflags);
/** \ingroup dbi
* Close database cursor.
* @param dbi index database handle
* @param dbcursor database cursor
* @param flags (unused)
* @return 0 on success
*/
int (*cclose) (dbiIndex dbi, DBC * dbcursor, unsigned int flags);
/** \ingroup dbi
* Duplicate a database cursor.
* @param dbi index database handle
* @param dbcursor database cursor
* @retval dbcp address of new database cursor
* @param flags DB_POSITION for same position, 0 for uninitialized
* @return 0 on success
*/
int (*cdup) (dbiIndex dbi, DBC * dbcursor, DBC ** dbcp,
unsigned int flags);
/** \ingroup dbi
* Delete (key,data) pair(s) using db->del or dbcursor->c_del.
* @param dbi index database handle
* @param dbcursor database cursor (NULL will use db->del)
* @param key delete key value/length/flags
* @param data delete data value/length/flags
* @param flags (unused)
* @return 0 on success
*/
int (*cdel) (dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
unsigned int flags);
/** \ingroup dbi
* Retrieve (key,data) pair using db->get or dbcursor->c_get.
* @param dbi index database handle
* @param dbcursor database cursor (NULL will use db->get)
* @param key retrieve key value/length/flags
* @param data retrieve data value/length/flags
* @param flags (unused)
* @return 0 on success
*/
int (*cget) (dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
unsigned int flags);
/** \ingroup dbi
* Retrieve (key,data) pair using dbcursor->c_pget.
* @param dbi index database handle
* @param dbcursor database cursor
* @param key secondary retrieve key value/length/flags
* @param pkey primary retrieve key value/length/flags
* @param data primary retrieve data value/length/flags
* @param flags DB_NEXT, DB_SET, or 0
* @return 0 on success
*/
int (*cpget) (dbiIndex dbi, DBC * dbcursor,
DBT * key, DBT * pkey, DBT * data, unsigned int flags);
/** \ingroup dbi
* Store (key,data) pair using db->put or dbcursor->c_put.
* @param dbi index database handle
* @param dbcursor database cursor (NULL will use db->put)
* @param key store key value/length/flags
* @param data store data value/length/flags
* @param flags (unused)
* @return 0 on success
*/
int (*cput) (dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
unsigned int flags);
/** \ingroup dbi
* Retrieve count of (possible) duplicate items using dbcursor->c_count.
* @param dbi index database handle
* @param dbcursor database cursor
* @param countp address of count
* @param flags (unused)
* @return 0 on success
*/
int (*ccount) (dbiIndex dbi, DBC * dbcursor,
unsigned int * countp,
unsigned int flags);
/** \ingroup dbi
* Is database byte swapped?
* @param dbi index database handle
* @return 0 no
*/
int (*byteswapped) (dbiIndex dbi);
/** \ingroup dbi
* Save statistics in database handle.
* @param dbi index database handle
* @param flags retrieve statistics that don't require traversal?
* @return 0 on success
*/
int (*stat) (dbiIndex dbi, unsigned int flags);
};
/** \ingroup dbi
* Describes an index database (implemented on Berkeley db3 functionality).
*/
struct _dbiIndex {
const char * dbi_root; /*!< chroot(2) component of path */
const char * dbi_home; /*!< directory component of path */
const char * dbi_file; /*!< file component of path */
const char * dbi_subfile;
const char * dbi_tmpdir; /*!< temporary directory */
int dbi_ecflags; /*!< db_env_create flags */
int dbi_cflags; /*!< db_create flags */
int dbi_oeflags; /*!< common (db,dbenv}->open flags */
int dbi_eflags; /*!< dbenv->open flags */
int dbi_oflags; /*!< db->open flags */
int dbi_tflags; /*!< dbenv->txn_begin flags */
int dbi_type; /*!< db index type */
unsigned dbi_mode; /*!< mode to use on open */
int dbi_perms; /*!< file permission to use on open */
long dbi_shmkey; /*!< shared memory base key */
int dbi_api; /*!< Berkeley API type */
int dbi_verify_on_close;
int dbi_use_dbenv; /*!< use db environment? */
int dbi_permit_dups; /*!< permit duplicate entries? */
int dbi_no_fsync; /*!< no-op fsync for db */
int dbi_no_dbsync; /*!< don't call dbiSync */
int dbi_lockdbfd; /*!< do fcntl lock on db fd */
int dbi_temporary; /*!< non-persistent */
int dbi_debug;
int dbi_byteswapped;
char * dbi_host;
unsigned long dbi_cl_timeout;
unsigned long dbi_sv_timeout;
/* dbenv parameters */
int dbi_lorder;
/* XXX db-4.3.14 adds dbenv as 1st arg. */
void (*db_errcall) (void * dbenv, const char *db_errpfx, char *buffer);
FILE * dbi_errfile;
const char * dbi_errpfx;
int dbi_verbose;
int dbi_region_init;
int dbi_tas_spins;
/* mpool sub-system parameters */
int dbi_mmapsize; /*!< (10Mb) */
int dbi_cachesize; /*!< (128Kb) */
/* lock sub-system parameters */
unsigned int dbi_lk_max;
unsigned int dbi_lk_detect;
int dbi_lk_nmodes;
unsigned char * dbi_lk_conflicts;
/* log sub-system parameters */
unsigned int dbi_lg_max;
unsigned int dbi_lg_bsize;
/* transaction sub-system parameters */
unsigned int dbi_tx_max;
#if 0
int (*dbi_tx_recover) (DB_ENV *dbenv, DBT *log_rec,
DB_LSN *lsnp, int redo, void *info);
#endif
/* dbinfo parameters */
int dbi_pagesize; /*!< (fs blksize) */
void * (*dbi_malloc) (size_t nbytes);
/* hash access parameters */
unsigned int dbi_h_ffactor; /*!< */
unsigned int (*dbi_h_hash_fcn) (DB *, const void *bytes,
unsigned int length);
unsigned int dbi_h_nelem; /*!< */
unsigned int dbi_h_flags; /*!< DB_DUP, DB_DUPSORT */
int (*dbi_h_dup_compare_fcn) (DB *, const DBT *, const DBT *);
/* btree access parameters */
int dbi_bt_flags;
int dbi_bt_minkey;
int (*dbi_bt_compare_fcn) (DB *, const DBT *, const DBT *);
int (*dbi_bt_dup_compare_fcn) (DB *, const DBT *, const DBT *);
size_t (*dbi_bt_prefix_fcn) (DB *, const DBT *, const DBT *);
/* recno access parameters */
int dbi_re_flags;
int dbi_re_delim;
unsigned int dbi_re_len;
int dbi_re_pad;
const char * dbi_re_source;
/* queue access parameters */
unsigned int dbi_q_extentsize;
rpmdb dbi_rpmdb; /*!< the parent rpm database */
rpm_tag_t dbi_rpmtag; /*!< rpm tag used for index */
int dbi_jlen; /*!< size of join key */
DB * dbi_db; /*!< Berkeley DB * handle */
DB_TXN * dbi_txnid; /*!< Bekerley DB_TXN * transaction id */
void * dbi_stats; /*!< Berkeley db statistics */
const struct _dbiVec * dbi_vec; /*!< private methods */
};
/** \ingroup rpmdb
* Describes the collection of index databases used by rpm.
*/
struct rpmdb_s {
const char * db_root;/*!< path prefix */
const char * db_home;/*!< directory path */
int db_flags;
int db_mode; /*!< open mode */
int db_perms; /*!< open permissions */
int db_api; /*!< Berkeley API type */
const char * db_errpfx;
int db_remove_env;
int db_filter_dups;
int db_chrootDone; /*!< If chroot(2) done, ignore db_root. */
void (*db_errcall) (const char *db_errpfx, char *buffer);
FILE * db_errfile;
void * (*db_malloc) (size_t nbytes);
void * (*db_realloc) (void * ptr,
size_t nbytes);
void (*db_free) (void * ptr);
unsigned char * db_bits; /*!< package instance bit mask. */
int db_nbits; /*!< no. of bits in mask. */
rpmdb db_next;
int db_opens;
void * db_dbenv; /*!< Berkeley DB_ENV handle. */
int db_ndbi; /*!< No. of tag indices. */
dbiIndex * _dbi; /*!< Tag indices. */
struct rpmop_s db_getops;
struct rpmop_s db_putops;
struct rpmop_s db_delops;
int nrefs; /*!< Reference count. */
};
/* for RPM's internal use only */
/** \ingroup rpmdb
*/
enum rpmdbFlags {
RPMDB_FLAG_JUSTCHECK = (1 << 0),
RPMDB_FLAG_MINIMAL = (1 << 1),
RPMDB_FLAG_CHROOT = (1 << 2)
};
#ifdef __cplusplus
extern "C" {
#endif
/** \ingroup db3
* Return new configured index database handle instance.
* @param rpmdb rpm database
* @param rpmtag rpm tag
* @return index database handle
*/
dbiIndex db3New(rpmdb rpmdb, rpm_tag_t rpmtag);
/** \ingroup db3
* Destroy index database handle instance.
* @param dbi index database handle
* @return NULL always
*/
dbiIndex db3Free( dbiIndex dbi);
/** \ingroup db3
* Format db3 open flags for debugging print.
* @param dbflags db open flags
* @param print_dbenv_flags format db env flags instead?
* @return formatted flags (static buffer)
*/
extern const char * prDbiOpenFlags(int dbflags, int print_dbenv_flags);
/** \ingroup dbi
* Return handle for an index database.
* @param db rpm database
* @param rpmtag rpm tag
* @param flags (unused)
* @return index database handle
*/
dbiIndex dbiOpen(rpmdb db, rpm_tag_t rpmtag,
unsigned int flags);
/* FIX: vector annotations */
/** \ingroup dbi
* Open a database cursor.
* @param dbi index database handle
* @param txnid database transaction handle
* @retval dbcp returned database cursor
* @param flags DB_WRITECURSOR if writing, or 0
* @return 0 on success
*/
static inline
int dbiCopen(dbiIndex dbi, DB_TXN * txnid,
DBC ** dbcp, unsigned int flags)
{
return (*dbi->dbi_vec->copen) (dbi, txnid, dbcp, flags);
}
/** \ingroup dbi
* Close a database cursor.
* @param dbi index database handle
* @param dbcursor database cursor
* @param flags (unused)
* @return 0 on success
*/
static inline
int dbiCclose(dbiIndex dbi, DBC * dbcursor, unsigned int flags)
{
return (*dbi->dbi_vec->cclose) (dbi, dbcursor, flags);
}
/** \ingroup dbi
* Duplicate a database cursor.
* @param dbi index database handle
* @param dbcursor database cursor
* @retval dbcp address of new database cursor
* @param flags DB_POSITION for same position, 0 for uninitialized
* @return 0 on success
*/
static inline
int dbiCdup(dbiIndex dbi, DBC * dbcursor, DBC ** dbcp,
unsigned int flags)
{
return (*dbi->dbi_vec->cdup) (dbi, dbcursor, dbcp, flags);
}
/** \ingroup dbi
* Delete (key,data) pair(s) from index database.
* @param dbi index database handle
* @param dbcursor database cursor (NULL will use db->del)
* @param key delete key value/length/flags
* @param data delete data value/length/flags
* @param flags (unused)
* @return 0 on success
*/
static inline
int dbiDel(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
unsigned int flags)
{
int rc;
assert(key->data != NULL && key->size > 0);
(void) rpmswEnter(&dbi->dbi_rpmdb->db_delops, 0);
rc = (dbi->dbi_vec->cdel) (dbi, dbcursor, key, data, flags);
(void) rpmswExit(&dbi->dbi_rpmdb->db_delops, data->size);
return rc;
}
/** \ingroup dbi
* Retrieve (key,data) pair from index database.
* @param dbi index database handle
* @param dbcursor database cursor (NULL will use db->get)
* @param key retrieve key value/length/flags
* @param data retrieve data value/length/flags
* @param flags (unused)
* @return 0 on success
*/
static inline
int dbiGet(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
unsigned int flags)
{
int rc;
assert((flags == DB_NEXT) || (key->data != NULL && key->size > 0));
(void) rpmswEnter(&dbi->dbi_rpmdb->db_getops, 0);
rc = (dbi->dbi_vec->cget) (dbi, dbcursor, key, data, flags);
(void) rpmswExit(&dbi->dbi_rpmdb->db_getops, data->size);
return rc;
}
/** \ingroup dbi
* Retrieve (key,data) pair using dbcursor->c_pget.
* @param dbi index database handle
* @param dbcursor database cursor (NULL will use db->get)
* @param key secondary retrieve key value/length/flags
* @param pkey primary retrieve key value/length/flags
* @param data primary retrieve data value/length/flags
* @param flags DB_NEXT, DB_SET, or 0
* @return 0 on success
*/
static inline
int dbiPget(dbiIndex dbi, DBC * dbcursor,
DBT * key, DBT * pkey, DBT * data, unsigned int flags)
{
int rc;
assert((flags == DB_NEXT) || (key->data != NULL && key->size > 0));
(void) rpmswEnter(&dbi->dbi_rpmdb->db_getops, 0);
rc = (dbi->dbi_vec->cpget) (dbi, dbcursor, key, pkey, data, flags);
(void) rpmswExit(&dbi->dbi_rpmdb->db_getops, (ssize_t) data->size);
return rc;
}
/** \ingroup dbi
* Store (key,data) pair in index database.
* @param dbi index database handle
* @param dbcursor database cursor (NULL will use db->put)
* @param key store key value/length/flags
* @param data store data value/length/flags
* @param flags (unused)
* @return 0 on success
*/
static inline
int dbiPut(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
unsigned int flags)
{
int rc;
assert(key->data != NULL && key->size > 0 && data->data != NULL && data->size > 0);
(void) rpmswEnter(&dbi->dbi_rpmdb->db_putops, (ssize_t) 0);
rc = (dbi->dbi_vec->cput) (dbi, dbcursor, key, data, flags);
(void) rpmswExit(&dbi->dbi_rpmdb->db_putops, (ssize_t) data->size);
return rc;
}
/** \ingroup dbi
* Retrieve count of (possible) duplicate items.
* @param dbi index database handle
* @param dbcursor database cursor
* @param countp address of count
* @param flags (unused)
* @return 0 on success
*/
static inline
int dbiCount(dbiIndex dbi, DBC * dbcursor, unsigned int * countp,
unsigned int flags)
{
return (*dbi->dbi_vec->ccount) (dbi, dbcursor, countp, flags);
}
/** \ingroup dbi
* Verify (and close) index database.
* @param dbi index database handle
* @param flags (unused)
* @return 0 on success
*/
static inline
int dbiVerify(dbiIndex dbi, unsigned int flags)
{
dbi->dbi_verify_on_close = 1;
return (*dbi->dbi_vec->close) (dbi, flags);
}
/** \ingroup dbi
* Close index database.
* @param dbi index database handle
* @param flags (unused)
* @return 0 on success
*/
static inline
int dbiClose(dbiIndex dbi, unsigned int flags)
{
return (*dbi->dbi_vec->close) (dbi, flags);
}
/** \ingroup dbi
* Flush pending operations to disk.
* @param dbi index database handle
* @param flags (unused)
* @return 0 on success
*/
static inline
int dbiSync (dbiIndex dbi, unsigned int flags)
{
return (*dbi->dbi_vec->sync) (dbi, flags);
}
/** \ingroup dbi
* Associate secondary database with primary.
* @param dbi index database handle
* @param dbisecondary secondary index database handle
* @param callback create secondary key from primary (NULL if DB_RDONLY)
* @param flags DB_CREATE or 0
* @return 0 on success
*/
static inline
int dbiAssociate(dbiIndex dbi, dbiIndex dbisecondary,
int (*callback) (DB *, const DBT *, const DBT *, DBT *),
unsigned int flags)
{
return (*dbi->dbi_vec->associate) (dbi, dbisecondary, callback, flags);
}
/** \ingroup dbi
* Return join cursor for list of cursors.
* @param dbi index database handle
* @param curslist NULL terminated list of database cursors
* @retval dbcp address of join database cursor
* @param flags DB_JOIN_NOSORT or 0
* @return 0 on success
*/
static inline
int dbiJoin(dbiIndex dbi, DBC ** curslist, DBC ** dbcp,
unsigned int flags)
{
return (*dbi->dbi_vec->join) (dbi, curslist, dbcp, flags);
}
/** \ingroup dbi
* Is database byte swapped?
* @param dbi index database handle
* @return 0 same order, 1 swapped order
*/
static inline
int dbiByteSwapped(dbiIndex dbi)
{
if (dbi->dbi_byteswapped == -1)
dbi->dbi_byteswapped = (*dbi->dbi_vec->byteswapped) (dbi);
return dbi->dbi_byteswapped;
}
/** \ingroup dbi
* Is database byte swapped?
* @param dbi index database handle
* @param flags DB_FAST_STAT or 0
* @return 0 on success
*/
static inline
int dbiStat(dbiIndex dbi, unsigned int flags)
{
return (*dbi->dbi_vec->stat) (dbi, flags);
}
/** \ingroup dbi
* Destroy set of index database items.
* @param set set of index database items
* @return NULL always
*/
dbiIndexSet dbiFreeIndexSet(dbiIndexSet set);
/** \ingroup dbi
* Count items in index database set.
* @param set set of index database items
* @return number of items
*/
unsigned int dbiIndexSetCount(dbiIndexSet set);
/** \ingroup dbi
* Return record offset of header from element in index database set.
* @param set set of index database items
* @param recno index of item in set
* @return record offset of header
*/
unsigned int dbiIndexRecordOffset(dbiIndexSet set, int recno);
/** \ingroup dbi
* Return file index from element in index database set.
* @param set set of index database items
* @param recno index of item in set
* @return file index
*/
unsigned int dbiIndexRecordFileNumber(dbiIndexSet set, int recno);
/** \ingroup rpmdb
* Tags for which rpmdb indices will be built.
*/
extern rpm_tag_t * dbiTags;
extern rpm_tag_t dbiTagsMax;
#ifndef __APPLE__
/**
* * Mergesort, same arguments as qsort(2).
* */
int mergesort(void *base, size_t nmemb, size_t size,
int (*cmp) (const void *, const void *));
#else
/* mergesort is defined in stdlib.h on Mac OS X */
#endif /* __APPLE__ */
#endif
Reference in New Issue View Git Blame Copy Permalink