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