---

rpmdb/rpmdb.h

Go to the documentation of this file.

#ifndef H_RPMDB
#define H_RPMDB

#include <rpmlib.h>

typedef /*@abstract@*/ struct _dbiIndexItem * dbiIndexItem;

typedef /*@abstract@*/ struct _dbiIndex * dbiIndex;

/* this will break if sizeof(int) != 4 */
struct _dbiIndexItem {
    unsigned int hdrNum;                
    unsigned int tagNum;                
    unsigned int fpNum;                 
    unsigned int dbNum;                 
};

struct _dbiIndexSet {
/*@owned@*/ struct _dbiIndexItem * recs; 
    int count;                          
};

/* XXX hack to get prototypes correct */
#if !defined(DB_VERSION_MAJOR)
#define DB      void
#define DB_ENV  void
#define DBC     void
#define DBT     void
#define DB_LSN  void
#endif

struct _dbiVec {
    int dbv_major;                      
    int dbv_minor;                      
    int dbv_patch;                      
    int (*open) (rpmdb rpmdb, int rpmtag, /*@out@*/ dbiIndex * dbip)
        /*@globals fileSystem@*/
        /*@modifies *dbip, fileSystem @*/;

    int (*close) (/*@only@*/ dbiIndex dbi, unsigned int flags)
        /*@globals fileSystem@*/
        /*@modifies dbi, fileSystem @*/;

    int (*sync) (dbiIndex dbi, unsigned int flags)
        /*@globals fileSystem@*/
        /*@modifies fileSystem @*/;

    int (*copen) (dbiIndex dbi, /*@out@*/ DBC ** dbcp, unsigned int flags)
        /*@globals fileSystem@*/
        /*@modifies dbi, *dbcp, fileSystem @*/;

    int (*cclose) (dbiIndex dbi, /*@only@*/ DBC * dbcursor, unsigned int flags)
        /*@globals fileSystem@*/
        /*@modifies dbi, *dbcursor, fileSystem @*/;

    int (*cdel) (dbiIndex dbi, DBC * dbcursor,
                        const void * keyp, size_t keylen, unsigned int flags)
        /*@globals fileSystem@*/
        /*@modifies *dbcursor, fileSystem @*/;

    int (*cget) (dbiIndex dbi, DBC * dbcursor,
                        /*@null@*/ void ** keypp, /*@null@*/ size_t * keylenp,
                        /*@null@*/ void ** datapp, /*@null@*/ size_t * datalenp,
                        unsigned int flags)
        /*@globals fileSystem@*/
        /*@modifies *dbcursor, *keypp, *keylenp, *datapp, *datalenp,
                fileSystem @*/;

    int (*cput) (dbiIndex dbi, DBC * dbcursor,
                        const void * keyp, size_t keylen,
                        const void * datap, size_t datalen,
                        unsigned int flags)
        /*@globals fileSystem@*/
        /*@modifies *dbcursor, fileSystem @*/;

    int (*ccount) (dbiIndex dbi, DBC * dbcursor,
                        /*@out@*/ unsigned int * countp,
                        unsigned int flags)
        /*@globals fileSystem@*/
        /*@modifies *dbcursor, fileSystem @*/;

    int (*byteswapped) (dbiIndex dbi)
        /*@globals fileSystem@*/
        /*@modifies fileSystem@*/;

    int (*stat) (dbiIndex dbi, unsigned int flags)
        /*@globals fileSystem@*/
        /*@modifies dbi, fileSystem @*/;

};

struct _dbiIndex {
/*@null@*/ const char * dbi_root;       
/*@null@*/ const char * dbi_home;       
/*@null@*/ const char * dbi_file;       
/*@null@*/ const char * dbi_subfile;
/*@null@*/ const char * dbi_tmpdir;     
    int                 dbi_ecflags;    
    int                 dbi_cflags;     
    int                 dbi_oeflags;    
    int                 dbi_eflags;     
    int                 dbi_oflags;     
    int                 dbi_tflags;     
    int                 dbi_type;       
    unsigned            dbi_mode;       
    int                 dbi_perms;      
    long                dbi_shmkey;     
    int                 dbi_api;        
    int                 dbi_verify_on_close;
    int                 dbi_tear_down;  
    int                 dbi_use_cursors;
    int                 dbi_use_dbenv;  
    int                 dbi_permit_dups;
    int                 dbi_get_rmw_cursor;
    int                 dbi_no_fsync;   
    int                 dbi_no_dbsync;  
    int                 dbi_lockdbfd;   
    int                 dbi_temporary;  
    int                 dbi_debug;
    int                 dbi_byteswapped;

/*@null@*/ char *       dbi_host;
    long                dbi_cl_timeout;
    long                dbi_sv_timeout;

        /* dbenv parameters */
    int                 dbi_lorder;
/*@unused@*/ /*@null@*/ void            (*db_errcall) (const char *db_errpfx, char *buffer)
        /*@globals fileSystem@*/
        /*@modifies fileSystem @*/;
/*@unused@*/ /*@shared@*/ FILE *        dbi_errfile;
    const char *        dbi_errpfx;
    int                 dbi_verbose;
    int                 dbi_region_init;
    int                 dbi_tas_spins;
        /* mpool sub-system parameters */
    int                 dbi_mp_mmapsize;        
    int                 dbi_mp_size;    
        /* lock sub-system parameters */
    unsigned int        dbi_lk_max;
    unsigned int        dbi_lk_detect;
/*@unused@*/ int        dbi_lk_nmodes;
/*@unused@*/ 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)
        /*@globals fileSystem@*/
        /*@modifies fileSystem @*/;
#endif
        /* dbinfo parameters */
    int                 dbi_cachesize;  
    int                 dbi_pagesize;   
/*@unused@*/ /*@null@*/ void *  (*dbi_malloc) (size_t nbytes)
        /*@*/;
        /* hash access parameters */
    unsigned int        dbi_h_ffactor;  
/*@null@*/ unsigned int (*dbi_h_hash_fcn) (DB *, const void *bytes, unsigned int length) /*@*/;
    unsigned int        dbi_h_nelem;    
    unsigned int        dbi_h_flags;    
/*@null@*/ int          (*dbi_h_dup_compare_fcn) (DB *, const DBT *, const DBT *) /*@*/;
        /* btree access parameters */
    int                 dbi_bt_flags;
    int                 dbi_bt_minkey;
/*@null@*/ int          (*dbi_bt_compare_fcn) (DB *, const DBT *, const DBT *) /*@*/;
/*@null@*/ int          (*dbi_bt_dup_compare_fcn) (DB *, const DBT *, const DBT *) /*@*/;
/*@null@*/ 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;

/*@kept@*/ rpmdb        dbi_rpmdb;
    rpmTag      dbi_rpmtag;             
    int         dbi_jlen;               
    unsigned int dbi_lastoffset;        
/*@only@*//*@null@*/ void * dbi_db;     
/*@only@*//*@null@*/ void * dbi_rmw;    
/*@only@*//*@null@*/ void * dbi_stats;  
/*@observer@*/ const struct _dbiVec * dbi_vec;  
};

struct rpmdb_s {
/*@owned@*/ const char * db_root;
/*@owned@*/ const char * db_home;
    int         db_flags;
    int         db_mode;        
    int         db_perms;       
    int         db_api;         
/*@owned@*/ const char * db_errpfx;
    int         db_remove_env;
    int         db_filter_dups;
    int         db_chrootDone;  
    void (*db_errcall) (const char *db_errpfx, char *buffer)
        /*@*/;
/*@shared@*/ FILE *     db_errfile;
/*@only@*/ void * (*db_malloc) (size_t nbytes)
        /*@*/;
/*@only@*/ void * (*db_realloc) (/*@only@*//*@null@*/ void * ptr,
                                                size_t nbytes)
        /*@*/;
    void (*db_free) (/*@only@*/ void * ptr)
        /*@modifies *ptr @*/;
    int         db_opens;
/*@only@*//*@null@*/ void * db_dbenv;   
    int         db_ndbi;        
    dbiIndex *  _dbi;           
    int nrefs;                  
};

/* for RPM's internal use only */

enum rpmdbFlags {
        RPMDB_FLAG_JUSTCHECK    = (1 << 0),
        RPMDB_FLAG_MINIMAL      = (1 << 1),
/*@-enummemuse@*/
        RPMDB_FLAG_CHROOT       = (1 << 2)
/*@=enummemuse@*/
};

#ifdef __cplusplus
extern "C" {
#endif

/*@-exportlocal@*/
/*@only@*/ /*@null@*/ dbiIndex db3New(rpmdb rpmdb, int rpmtag)
        /*@globals rpmGlobalMacroContext @*/
        /*@modifies rpmGlobalMacroContext @*/;

/*@null@*/ dbiIndex db3Free( /*@only@*/ /*@null@*/ dbiIndex dbi)
        /*@*/;

/*@-redecl@*/
/*@exposed@*/ extern const char *const prDbiOpenFlags(int dbflags,
                                                int print_dbenv_flags)
        /*@*/;
/*@=redecl@*/

/*@only@*/ /*@null@*/ dbiIndex dbiOpen(/*@null@*/ rpmdb db, int rpmtag,
                unsigned int flags)
        /*@modifies db @*/;

int dbiCopen(dbiIndex dbi, /*@out@*/ DBC ** dbcp, unsigned int flags)
        /*@globals fileSystem@*/
        /*@modifies dbi, *dbcp, fileSystem @*/;

#define DBI_WRITECURSOR         (1 << 0)
#define DBI_ITERATOR            (1 << 1)

int dbiCclose(dbiIndex dbi, /*@only@*/ DBC * dbcursor, unsigned int flags)
        /*@globals fileSystem@*/
        /*@modifies dbi, *dbcursor, fileSystem @*/;

int dbiDel(dbiIndex dbi, DBC * dbcursor, const void * keyp, size_t keylen,
                unsigned int flags)
        /*@globals fileSystem@*/
        /*@modifies *dbcursor, fileSystem @*/;

int dbiGet(dbiIndex dbi, DBC * dbcursor, void ** keypp,
                /*@null@*/ size_t * keylenp,
                /*@null@*/ void ** datapp, 
                /*@null@*/ size_t * datalenp,
                unsigned int flags)
        /*@globals fileSystem@*/
        /*@modifies *dbcursor, **keypp, *keylenp, **datapp, *datalenp,
                fileSystem @*/;

int dbiPut(dbiIndex dbi, DBC * dbcursor, const void * keyp, size_t keylen,
                const void * datap, size_t datalen, unsigned int flags)
        /*@globals fileSystem@*/
        /*@modifies *dbcursor, fileSystem @*/;

/*@unused@*/
int dbiCount(dbiIndex dbi, DBC * dbcursor, /*@out@*/ unsigned int * countp,
                unsigned int flags)
        /*@globals fileSystem@*/
        /*@modifies *dbcursor, fileSystem @*/;

int dbiVerify(/*@only@*/ dbiIndex dbi, unsigned int flags)
        /*@globals fileSystem@*/
        /*@modifies dbi, fileSystem @*/;

int dbiClose(/*@only@*/ dbiIndex dbi, unsigned int flags)
        /*@globals fileSystem@*/
        /*@modifies dbi, fileSystem @*/;

int dbiSync (dbiIndex dbi, unsigned int flags)
        /*@globals fileSystem@*/
        /*@modifies fileSystem @*/;

int dbiByteSwapped(dbiIndex dbi)
        /*@*/;

char * db1basename(int rpmtag)
        /*@*/;
/*@=exportlocal@*/

/*@unused@*/
unsigned int rpmdbGetIteratorFileNum(rpmdbMatchIterator mi)
        /*@*/;

/*@null@*/ dbiIndexSet dbiFreeIndexSet(/*@only@*/ /*@null@*/ dbiIndexSet set)
        /*@modifies set @*/;

unsigned int dbiIndexSetCount(dbiIndexSet set)
        /*@*/;

unsigned int dbiIndexRecordOffset(dbiIndexSet set, int recno)
        /*@*/;

unsigned int dbiIndexRecordFileNumber(dbiIndexSet set, int recno)
        /*@*/;

int mergesort(void *base, size_t nmemb, size_t size,
                int (*cmp) (const void *, const void *));

#ifdef __cplusplus
}
#endif

#endif  /* H_RPMDB */

---