rpmdb/rpmdb.h

   1 #ifndef H_RPMDB
   2 #define H_RPMDB
   3
   4 /** \ingroup rpmdb dbi db1 db3
   5  * \file rpmdb/rpmdb.h
   6  * Access RPM indices using Berkeley DB interface(s).
   7  */
   8
   9 #include <rpmlib.h>
  10
  11 #include "fprint.h"
  12
  13 typedef /*@abstract@*/ struct _dbiIndexItem * dbiIndexItem;
  14 typedef /*@abstract@*/ struct _dbiIndex * dbiIndex;
  15
  16 /* this will break if sizeof(int) != 4 */
  17 /** \ingroup dbi
  18  * A single item from an index database (i.e. the "data returned").
  19  * Note: In rpm-3.0.4 and earlier, this structure was passed by value,
  20  * and was identical to the "data saved" structure below.
  21  */
  22 struct _dbiIndexItem {
  23     unsigned int hdrNum;                /*!< header instance in db */
  24     unsigned int tagNum;                /*!< tag index in header */
  25     unsigned int fpNum;                 /*!< finger print index */
  26     unsigned int dbNum;                 /*!< database index */
  27 };
  28
  29 /** \ingroup dbi
  30  * A single item in an index database (i.e. the "data saved").
  31  */
  32 struct _dbiIR {
  33     unsigned int recOffset;             /*!< byte offset of header in db */
  34     unsigned int fileNumber;            /*!< file array index */
  35 };
  36 typedef struct _dbiIR * DBIR_t;
  37
  38 /** \ingroup dbi
  39  * Items retrieved from the index database.
  40  */
  41 struct _dbiIndexSet {
  42 /*@owned@*/ struct _dbiIndexItem * recs; /*!< array of records */
  43     int count;                          /*!< number of records */
  44 };
  45
  46 /* XXX hack to get prototypes correct */
  47 #if !defined(DB_VERSION_MAJOR)
  48 #define DB_ENV  void
  49 #define DBC     void
  50 #define DBT     void
  51 #define DB_LSN  void
  52 #endif
  53
  54 /** \ingroup dbi
  55  * Private methods for accessing an index database.
  56  */
  57 struct _dbiVec {
  58     int dbv_major;                      /*!< Berkeley db version major */
  59     int dbv_minor;                      /*!< Berkeley db version minor */
  60     int dbv_patch;                      /*!< Berkeley db version patch */
  61
  62 /** \ingroup dbi
  63  * Return handle for an index database.
  64  * @param rpmdb         rpm database
  65  * @param rpmtag        rpm tag
  66  * @return              0 on success
  67  */
  68     int (*open) (rpmdb rpmdb, int rpmtag, /*@out@*/ dbiIndex * dbip);
  69
  70 /** \ingroup dbi
  71  * Close index database.
  72  * @param dbi           index database handle
  73  * @param flags         (unused)
  74  * @return              0 on success
  75  */
  76     int (*close) (/*@only@*/ dbiIndex dbi, unsigned int flags);
  77
  78 /** \ingroup dbi
  79  * Flush pending operations to disk.
  80  * @param dbi           index database handle
  81  * @param flags         (unused)
  82  * @return              0 on success
  83  */
  84     int (*sync) (dbiIndex dbi, unsigned int flags);
  85
  86 /** \ingroup dbi
  87  * Open database cursor.
  88  * @param dbi           index database handle
  89  * @param dbcp          address of database cursor
  90  * @param flags         (unused)
  91  */
  92     int (*copen) (dbiIndex dbi, /*@out@*/ DBC ** dbcp, unsigned int flags);
  93
  94 /** \ingroup dbi
  95  * Close database cursor.
  96  * @param dbi           index database handle
  97  * @param dbcursor      database cursor
  98  * @param flags         (unused)
  99  */
 100     int (*cclose) (dbiIndex dbi, /*@only@*/ DBC * dbcursor, unsigned int flags);
 101
 102 /** \ingroup dbi
 103  * Delete (key,data) pair(s) using db->del or dbcursor->c_del.
 104  * @param dbi           index database handle
 105  * @param dbcursor      database cursor
 106  * @param keyp          key data
 107  * @param keylen        key data length
 108  * @param flags         (unused)
 109  * @return              0 on success
 110  */
 111     int (*cdel) (dbiIndex dbi, DBC * dbcursor, const void * keyp, size_t keylen, unsigned int flags);
 112
 113 /** \ingroup dbi
 114  * Retrieve (key,data) pair using db->get or dbcursor->c_get.
 115  * @param dbi           index database handle
 116  * @param dbcursor      database cursor
 117  * @param keypp         address of key data
 118  * @param keylenp       address of key data length
 119  * @param datapp        address of data pointer
 120  * @param datalenp      address of data length
 121  * @param flags         (unused)
 122  * @return              0 on success
 123  */
 124     int (*cget) (dbiIndex dbi, DBC * dbcursor,
 125                         /*@out@*/ void ** keypp, /*@out@*/ size_t * keylenp,
 126                         /*@out@*/ void ** datapp, /*@out@*/ size_t * datalenp,
 127                         unsigned int flags);
 128
 129 /** \ingroup dbi
 130  * Store (key,data) pair using db->put or dbcursor->c_put.
 131  * @param dbi           index database handle
 132  * @param dbcursor      database cursor
 133  * @param keyp          key data
 134  * @param keylen        key data length
 135  * @param datap         data pointer
 136  * @param datalen       data length
 137  * @param flags         (unused)
 138  * @return              0 on success
 139  */
 140     int (*cput) (dbiIndex dbi, DBC * dbcursor,
 141                         const void * keyp, size_t keylen,
 142                         const void * datap, size_t datalen,
 143                         unsigned int flags);
 144
 145 /** \ingroup dbi
 146  * Is database byte swapped?
 147  * @param dbi           index database handle
 148  * @return              0 no
 149  */
 150     int (*byteswapped) (dbiIndex dbi);
 151
 152 };
 153
 154 /** \ingroup dbi
 155  * Describes an index database (implemented on Berkeley db[123] API).
 156  */
 157 struct _dbiIndex {
 158 /*@null@*/ const char * dbi_root;
 159 /*@null@*/ const char * dbi_home;
 160 /*@null@*/ const char * dbi_file;
 161 /*@null@*/ const char * dbi_subfile;
 162
 163     int                 dbi_ecflags;    /*!< db_env_create flags */
 164     int                 dbi_cflags;     /*!< db_create flags */
 165     int                 dbi_oeflags;    /*!< common (db,dbenv}->open flags */
 166     int                 dbi_eflags;     /*!< dbenv->open flags */
 167     int                 dbi_oflags;     /*!< db->open flags */
 168     int                 dbi_tflags;     /*!< dbenv->txn_begin flags */
 169
 170     int                 dbi_type;       /*!< db index type */
 171     unsigned            dbi_mode;       /*!< mode to use on open */
 172     int                 dbi_perms;      /*!< file permission to use on open */
 173     long                dbi_shmkey;     /*!< shared memory base key */
 174     int                 dbi_api;        /*!< Berkeley API type */
 175
 176     int                 dbi_tear_down;  /*!< tear down dbenv on close */
 177     int                 dbi_use_cursors;/*!< access with cursors? (always) */
 178     int                 dbi_use_dbenv;  /*!< use db environment? */
 179     int                 dbi_get_rmw_cursor;
 180     int                 dbi_no_fsync;   /*!< no-op fsync for db */
 181     int                 dbi_no_dbsync;  /*!< don't call dbiSync */
 182     int                 dbi_lockdbfd;   /*!< do fcntl lock on db fd */
 183     int                 dbi_temporary;  /*!< non-persistent */
 184     int                 dbi_debug;
 185
 186 /*@null@*/ char *       dbi_host;
 187     long                dbi_cl_timeout;
 188     long                dbi_sv_timeout;
 189
 190         /* dbenv parameters */
 191     int                 dbi_lorder;
 192 /*@null@*/ void         (*db_errcall) (const char *db_errpfx, char *buffer);
 193 /*@shared@*/ FILE *     dbi_errfile;
 194     const char *        dbi_errpfx;
 195     int                 dbi_verbose;
 196     int                 dbi_region_init;
 197     int                 dbi_tas_spins;
 198         /* mpool sub-system parameters */
 199     int                 dbi_mp_mmapsize;        /*!< (10Mb) */
 200     int                 dbi_mp_size;    /*!< (128Kb) */
 201         /* lock sub-system parameters */
 202     unsigned int        dbi_lk_max;
 203     unsigned int        dbi_lk_detect;
 204     int                 dbi_lk_nmodes;
 205     unsigned char       *dbi_lk_conflicts;
 206         /* log sub-system parameters */
 207     unsigned int        dbi_lg_max;
 208     unsigned int        dbi_lg_bsize;
 209         /* transaction sub-system parameters */
 210     unsigned int        dbi_tx_max;
 211 #if 0
 212     int                 (*dbi_tx_recover) (DB_ENV *dbenv, DBT *log_rec, DB_LSN *lsnp, int redo, void *info);
 213 #endif
 214         /* dbinfo parameters */
 215     int                 dbi_cachesize;  /*!< */
 216     int                 dbi_pagesize;   /*!< (fs blksize) */
 217 /*@null@*/ void *       (*dbi_malloc) (size_t nbytes);
 218         /* hash access parameters */
 219     unsigned int        dbi_h_ffactor;  /*!< */
 220 /*@null@*/ unsigned int (*dbi_h_hash_fcn) (const void *bytes, unsigned int length);
 221     unsigned int        dbi_h_nelem;    /*!< */
 222     unsigned int        dbi_h_flags;    /*!< DB_DUP, DB_DUPSORT */
 223 /*@null@*/ int          (*dbi_h_dup_compare_fcn) (const DBT *, const DBT *);
 224         /* btree access parameters */
 225     int                 dbi_bt_flags;
 226     int                 dbi_bt_minkey;
 227 /*@null@*/ int          (*dbi_bt_compare_fcn) (const DBT *, const DBT *);
 228 /*@null@*/ int          (*dbi_bt_dup_compare_fcn) (const DBT *, const DBT *);
 229 /*@null@*/ size_t       (*dbi_bt_prefix_fcn) (const DBT *, const DBT *);
 230         /* recno access parameters */
 231     int                 dbi_re_flags;
 232     int                 dbi_re_delim;
 233     unsigned int        dbi_re_len;
 234     int                 dbi_re_pad;
 235     const char *        dbi_re_source;
 236         /* queue access parameters */
 237     unsigned int        dbi_q_extentsize;
 238
 239 /*@kept@*/ rpmdb        dbi_rpmdb;
 240     int         dbi_rpmtag;             /*!< rpm tag used for index */
 241     int         dbi_jlen;               /*!< size of join key */
 242
 243     unsigned int dbi_lastoffset;        /*!< db1 with falloc.c needs this */
 244
 245 /*@only@*//*@null@*/ void * dbi_db;     /*!< dbi handle */
 246 /*@only@*//*@null@*/ void * dbi_dbenv;
 247 /*@only@*//*@null@*/ void * dbi_dbinfo;
 248 /*@only@*//*@null@*/ void * dbi_rmw;    /*!< db cursor (with DB_WRITECURSOR) */
 249
 250 /*@observer@*/ const struct _dbiVec * dbi_vec;  /*!< private methods */
 251
 252 };
 253
 254 /** \ingroup rpmdb
 255  * Describes the collection of index databases used by rpm.
 256  */
 257 struct rpmdb_s {
 258 /*@owned@*/ const char *db_root;        /*!< path prefix */
 259 /*@owned@*/ const char *db_home;        /*!< directory path */
 260     int                 db_flags;
 261     int                 db_mode;        /*!< open mode */
 262     int                 db_perms;       /*!< open permissions */
 263     int                 db_api;         /*!< Berkeley API type */
 264     int                 db_remove_env;
 265     int                 db_filter_dups;
 266 /*@owned@*/ const char *db_errpfx;
 267     void                (*db_errcall) (const char *db_errpfx, char *buffer);
 268 /*@shared@*/ FILE *     db_errfile;
 269 /*@only@*/ void *       (*db_malloc) (size_t nbytes);
 270 /*@only@*/ void *       (*db_realloc) (/*@only@*//*@null@*/ void * ptr,
 271                                                 size_t nbytes);
 272     void                (*db_free) (/*@only@*/ void * ptr);
 273     int                 db_ndbi;
 274     dbiIndex            *_dbi;
 275 };
 276
 277 /* for RPM's internal use only */
 278
 279 /** \ingroup rpmdb
 280  */
 281 enum rpmdbFlags {
 282         RPMDB_FLAG_JUSTCHECK    = (1 << 0),
 283         RPMDB_FLAG_MINIMAL      = (1 << 1),
 284         RPMDB_FLAG_CHROOT       = (1 << 2)
 285 };
 286
 287 #ifdef __cplusplus
 288 extern "C" {
 289 #endif
 290
 291 /*@-exportlocal@*/
 292 /** \ingroup db3
 293  * Return new configured index database handle instance.
 294  * @param rpmdb         rpm database
 295  */
 296 /*@only@*/ /*@null@*/ dbiIndex db3New(/*@keep@*/ rpmdb rpmdb, int rpmtag);
 297
 298 /** \ingroup db3
 299  * Destroy index database handle instance.
 300  * @param dbi           index database handle
 301  */
 302 void db3Free( /*@only@*/ /*@null@*/ dbiIndex dbi);
 303
 304 /** \ingroup db3
 305  * Format db3 open flags for debugging print.
 306  * @param dbflags               db open flags
 307  * @param print_dbenv_flags     format db env flags instead?
 308  * @return                      formatted flags (static buffer)
 309  */
 310 /*@exposed@*/ extern const char *const prDbiOpenFlags(int dbflags,
 311                                                 int print_dbenv_flags);
 312
 313 /** \ingroup dbi
 314  * Return handle for an index database.
 315  * @param rpmdb         rpm database
 316  * @param rpmtag        rpm tag
 317  * @param flags         (unused)
 318  * @return              index database handle
 319  */
 320 /*@only@*/ /*@null@*/ dbiIndex dbiOpen(/*@null@*/ rpmdb rpmdb, int rpmtag,
 321                 unsigned int flags);
 322
 323 /** \ingroup dbi
 324  * @param dbi           index database handle
 325  * @param dbiflags      DBI_WRITECURSOR or DBI_ITERATOR
 326  */
 327 int dbiCopen(dbiIndex dbi, /*@out@*/ DBC ** dbcp, unsigned int dbiflags);
 328 int XdbiCopen(dbiIndex dbi, /*@out@*/ DBC ** dbcp, unsigned int dbiflags, const char *f, unsigned int l);
 329 #define dbiCopen(_a,_b,_c) \
 330         XdbiCopen(_a, _b, _c, __FILE__, __LINE__)
 331
 332 #define DBI_WRITECURSOR         (1 << 0)
 333 #define DBI_ITERATOR            (1 << 1)
 334
 335 /** \ingroup dbi
 336  * @param dbi           index database handle
 337  * @param flags         (unused)
 338  */
 339 int dbiCclose(dbiIndex dbi, /*@only@*/ DBC * dbcursor, unsigned int flags);
 340 int XdbiCclose(dbiIndex dbi, /*@only@*/ DBC * dbcursor, unsigned int flags, const char *f, unsigned int l);
 341 #define dbiCclose(_a,_b,_c) \
 342         XdbiCclose(_a, _b, _c, __FILE__, __LINE__)
 343
 344 /** \ingroup dbi
 345  * Delete (key,data) pair(s) from index database.
 346  * @param dbi           index database handle
 347  * @param keyp          key data
 348  * @param keylen        key data length
 349  * @param flags         (unused)
 350  * @return              0 on success
 351  */
 352 int dbiDel(dbiIndex dbi, DBC * dbcursor, const void * keyp, size_t keylen,
 353         unsigned int flags);
 354
 355 /** \ingroup dbi
 356  * Retrieve (key,data) pair from index database.
 357  * @param dbi           index database handle
 358  * @param keypp         address of key data
 359  * @param keylenp       address of key data length
 360  * @param datapp        address of data pointer
 361  * @param datalenp      address of data length
 362  * @param flags         (unused)
 363  * @return              0 on success
 364  */
 365 int dbiGet(dbiIndex dbi, DBC * dbcursor, void ** keypp,
 366         /*@null@*/ size_t * keylenp,
 367         /*@null@*/ void ** datapp,
 368         /*@null@*/ size_t * datalenp,
 369         unsigned int flags);
 370
 371 /** \ingroup dbi
 372  * Store (key,data) pair in index database.
 373  * @param dbi           index database handle
 374  * @param keyp          key data
 375  * @param keylen        key data length
 376  * @param datap         data pointer
 377  * @param datalen       data length
 378  * @param flags         (unused)
 379  * @return              0 on success
 380  */
 381 int dbiPut(dbiIndex dbi, DBC * dbcursor, const void * keyp, size_t keylen,
 382         const void * datap, size_t datalen, unsigned int flags);
 383
 384 /** \ingroup dbi
 385  * Close index database.
 386  * @param dbi           index database handle
 387  * @param flags         (unused)
 388  * @return              0 on success
 389  */
 390 int dbiClose(/*@only@*/ dbiIndex dbi, unsigned int flags);
 391
 392 /** \ingroup dbi
 393  * Flush pending operations to disk.
 394  * @param dbi           index database handle
 395  * @param flags         (unused)
 396  * @return              0 on success
 397  */
 398 int dbiSync (dbiIndex dbi, unsigned int flags);
 399
 400 /** \ingroup dbi
 401  * Is database byte swapped?
 402  * @param dbi           index database handle
 403  * @return              0 no
 404  */
 405 int dbiByteSwapped(dbiIndex dbi);
 406
 407 /** \ingroup db1
 408  * Return base file name for db1 database (legacy).
 409  * @param rpmtag        rpm tag
 410  * @return              base file name of db1 database
 411  */
 412 char * db1basename(int rpmtag);
 413 /*@=exportlocal@*/
 414
 415 /** \ingroup rpmdb
 416  */
 417 unsigned int rpmdbGetIteratorFileNum(rpmdbMatchIterator mi);
 418
 419 /** \ingroup rpmdb
 420  * @param rpmdb         rpm database
 421  */
 422 int rpmdbFindFpList(/*@null@*/ rpmdb rpmdb, fingerPrint * fpList,
 423                 /*@out@*/dbiIndexSet * matchList, int numItems);
 424
 425 /** \ingroup dbi
 426  * Destroy set of index database items.
 427  * @param set   set of index database items
 428  */
 429 void dbiFreeIndexSet(/*@only@*/ /*@null@*/ dbiIndexSet set);
 430
 431 /** \ingroup dbi
 432  * Count items in index database set.
 433  * @param set   set of index database items
 434  * @return      number of items
 435  */
 436 unsigned int dbiIndexSetCount(dbiIndexSet set);
 437
 438 /** \ingroup dbi
 439  * Return record offset of header from element in index database set.
 440  * @param set   set of index database items
 441  * @param recno index of item in set
 442  * @return      record offset of header
 443  */
 444 unsigned int dbiIndexRecordOffset(dbiIndexSet set, int recno);
 445
 446 /** \ingroup dbi
 447  * Return file index from element in index database set.
 448  * @param set   set of index database items
 449  * @param recno index of item in set
 450  * @return      file index
 451  */
 452 unsigned int dbiIndexRecordFileNumber(dbiIndexSet set, int recno);
 453
 454 #ifdef __cplusplus
 455 }
 456 #endif
 457
 458 #endif  /* H_RPMDB */