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