lib/rpmdb_internal.h

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