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     int         db_mkdirDone;   /*!< Has db_home been created? */
 269     void (*db_errcall) (const char *db_errpfx, char *buffer);
 270     FILE *      db_errfile;
 271     void * (*db_malloc) (size_t nbytes);
 272     void * (*db_realloc) (void * ptr,
 273                                                 size_t nbytes);
 274     void (*db_free) (void * ptr);
 275     unsigned char * db_bits;    /*!< package instance bit mask. */
 276     int         db_nbits;       /*!< no. of bits in mask. */
 277     rpmdb       db_next;
 278     int         db_opens;
 279     void *      db_dbenv;       /*!< Berkeley DB_ENV handle. */
 280     int         db_ndbi;        /*!< No. of tag indices. */
 281     dbiIndex * _dbi;            /*!< Tag indices. */
 282
 283     struct rpmop_s db_getops;
 284     struct rpmop_s db_putops;
 285     struct rpmop_s db_delops;
 286
 287     int nrefs;                  /*!< Reference count. */
 288 };
 289
 290 /* for RPM's internal use only */
 291
 292 /** \ingroup rpmdb
 293  */
 294 enum rpmdbFlags {
 295         RPMDB_FLAG_JUSTCHECK    = (1 << 0),
 296         RPMDB_FLAG_MINIMAL      = (1 << 1),
 297         RPMDB_FLAG_CHROOT       = (1 << 2)
 298 };
 299
 300 #ifdef __cplusplus
 301 extern "C" {
 302 #endif
 303
 304 /** \ingroup db3
 305  * Return new configured index database handle instance.
 306  * @param rpmdb         rpm database
 307  * @param rpmtag        rpm tag
 308  * @return              index database handle
 309  */
 310 RPM_GNUC_INTERNAL
 311 dbiIndex db3New(rpmdb rpmdb, rpmTag rpmtag);
 312
 313 /** \ingroup db3
 314  * Destroy index database handle instance.
 315  * @param dbi           index database handle
 316  * @return              NULL always
 317  */
 318 RPM_GNUC_INTERNAL
 319 dbiIndex db3Free( dbiIndex dbi);
 320
 321 /** \ingroup db3
 322  * Format db3 open flags for debugging print.
 323  * @param dbflags               db open flags
 324  * @param print_dbenv_flags     format db env flags instead?
 325  * @return                      formatted flags (malloced)
 326  */
 327 RPM_GNUC_INTERNAL
 328 char * prDbiOpenFlags(int dbflags, int print_dbenv_flags);
 329
 330 /** \ingroup dbi
 331  * Return handle for an index database.
 332  * @param db            rpm database
 333  * @param rpmtag        rpm tag
 334  * @param flags         (unused)
 335  * @return              index database handle
 336  */
 337 RPM_GNUC_INTERNAL
 338 dbiIndex dbiOpen(rpmdb db, rpmTag rpmtag,
 339                 unsigned int flags);
 340
 341 /* FIX: vector annotations */
 342 /** \ingroup dbi
 343  * Open a database cursor.
 344  * @param dbi           index database handle
 345  * @param txnid         database transaction handle
 346  * @retval dbcp         returned database cursor
 347  * @param flags         DB_WRITECURSOR if writing, or 0
 348  * @return              0 on success
 349  */
 350 static inline
 351 int dbiCopen(dbiIndex dbi, DB_TXN * txnid,
 352                 DBC ** dbcp, unsigned int flags)
 353 {
 354     return (*dbi->dbi_vec->copen) (dbi, txnid, dbcp, flags);
 355 }
 356
 357 /** \ingroup dbi
 358  * Close a database cursor.
 359  * @param dbi           index database handle
 360  * @param dbcursor      database cursor
 361  * @param flags         (unused)
 362  * @return              0 on success
 363  */
 364 static inline
 365 int dbiCclose(dbiIndex dbi, DBC * dbcursor, unsigned int flags)
 366 {
 367     return (*dbi->dbi_vec->cclose) (dbi, dbcursor, flags);
 368 }
 369
 370 /** \ingroup dbi
 371  * Delete (key,data) pair(s) from index database.
 372  * @param dbi           index database handle
 373  * @param dbcursor      database cursor (NULL will use db->del)
 374  * @param key           delete key value/length/flags
 375  * @param data          delete data value/length/flags
 376  * @param flags         (unused)
 377  * @return              0 on success
 378  */
 379 static inline
 380 int dbiDel(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
 381                 unsigned int flags)
 382 {
 383     int rc;
 384     assert(key->data != NULL && key->size > 0);
 385     (void) rpmswEnter(&dbi->dbi_rpmdb->db_delops, 0);
 386     rc = (dbi->dbi_vec->cdel) (dbi, dbcursor, key, data, flags);
 387     (void) rpmswExit(&dbi->dbi_rpmdb->db_delops, data->size);
 388     return rc;
 389 }
 390
 391 /** \ingroup dbi
 392  * Retrieve (key,data) pair from index database.
 393  * @param dbi           index database handle
 394  * @param dbcursor      database cursor (NULL will use db->get)
 395  * @param key           retrieve key value/length/flags
 396  * @param data          retrieve data value/length/flags
 397  * @param flags         (unused)
 398  * @return              0 on success
 399  */
 400 RPM_GNUC_INTERNAL
 401 int dbiGet(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
 402            unsigned int flags);
 403
 404 /** \ingroup dbi
 405  * Store (key,data) pair in index database.
 406  * @param dbi           index database handle
 407  * @param dbcursor      database cursor (NULL will use db->put)
 408  * @param key           store key value/length/flags
 409  * @param data          store data value/length/flags
 410  * @param flags         (unused)
 411  * @return              0 on success
 412  */
 413 RPM_GNUC_INTERNAL
 414 int dbiPut(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
 415            unsigned int flags);
 416
 417 /** \ingroup dbi
 418  * Retrieve count of (possible) duplicate items.
 419  * @param dbi           index database handle
 420  * @param dbcursor      database cursor
 421  * @param countp        address of count
 422  * @param flags         (unused)
 423  * @return              0 on success
 424  */
 425 static inline
 426 int dbiCount(dbiIndex dbi, DBC * dbcursor, unsigned int * countp,
 427                 unsigned int flags)
 428 {
 429     return (*dbi->dbi_vec->ccount) (dbi, dbcursor, countp, flags);
 430 }
 431
 432 /** \ingroup dbi
 433  * Verify (and close) index database.
 434  * @param dbi           index database handle
 435  * @param flags         (unused)
 436  * @return              0 on success
 437  */
 438 static inline
 439 int dbiVerify(dbiIndex dbi, unsigned int flags)
 440 {
 441     dbi->dbi_verify_on_close = 1;
 442     return (*dbi->dbi_vec->close) (dbi, flags);
 443 }
 444
 445 /** \ingroup dbi
 446  * Close index database.
 447  * @param dbi           index database handle
 448  * @param flags         (unused)
 449  * @return              0 on success
 450  */
 451 static inline
 452 int dbiClose(dbiIndex dbi, unsigned int flags)
 453 {
 454     return (*dbi->dbi_vec->close) (dbi, flags);
 455 }
 456
 457 /** \ingroup dbi
 458  * Flush pending operations to disk.
 459  * @param dbi           index database handle
 460  * @param flags         (unused)
 461  * @return              0 on success
 462  */
 463 static inline
 464 int dbiSync (dbiIndex dbi, unsigned int flags)
 465 {
 466     return (*dbi->dbi_vec->sync) (dbi, flags);
 467 }
 468
 469 /** \ingroup dbi
 470  * Is database byte swapped?
 471  * @param dbi           index database handle
 472  * @return              0 same order, 1 swapped order
 473  */
 474 static inline
 475 int dbiByteSwapped(dbiIndex dbi)
 476 {
 477     if (dbi->dbi_byteswapped == -1)
 478         dbi->dbi_byteswapped = (*dbi->dbi_vec->byteswapped) (dbi);
 479     return dbi->dbi_byteswapped;
 480 }
 481 /** \ingroup dbi
 482  * Is database byte swapped?
 483  * @param dbi           index database handle
 484  * @param flags         DB_FAST_STAT or 0
 485  * @return              0 on success
 486  */
 487 static inline
 488 int dbiStat(dbiIndex dbi, unsigned int flags)
 489 {
 490     return (*dbi->dbi_vec->stat) (dbi, flags);
 491 }
 492
 493
 494 /** \ingroup dbi
 495  * Destroy set of index database items.
 496  * @param set   set of index database items
 497  * @return      NULL always
 498  */
 499 RPM_GNUC_INTERNAL
 500 dbiIndexSet dbiFreeIndexSet(dbiIndexSet set);
 501
 502 /** \ingroup dbi
 503  * Count items in index database set.
 504  * @param set   set of index database items
 505  * @return      number of items
 506  */
 507 RPM_GNUC_INTERNAL
 508 unsigned int dbiIndexSetCount(dbiIndexSet set);
 509
 510 /** \ingroup dbi
 511  * Return record offset of header from element in index database set.
 512  * @param set   set of index database items
 513  * @param recno index of item in set
 514  * @return      record offset of header
 515  */
 516 RPM_GNUC_INTERNAL
 517 unsigned int dbiIndexRecordOffset(dbiIndexSet set, int recno);
 518
 519 /** \ingroup dbi
 520  * Return file index from element in index database set.
 521  * @param set   set of index database items
 522  * @param recno index of item in set
 523  * @return      file index
 524  */
 525 RPM_GNUC_INTERNAL
 526 unsigned int dbiIndexRecordFileNumber(dbiIndexSet set, int recno);
 527
 528 /** \ingroup rpmdb
 529  * Return rpmdb home directory (depending on chroot state)
 530  * param db             rpmdb handle
 531  * return               db home directory (or NULL on error)
 532  */
 533 RPM_GNUC_INTERNAL
 534 const char *rpmdbHome(rpmdb db);
 535
 536 /** \ingroup rpmdb
 537  * Return database iterator.
 538  * @param mi            rpm database iterator
 539  * @param keyp          key data (NULL for sequential access)
 540  * @param keylen        key data length (0 will use strlen(keyp))
 541  * @return              0 on success
 542  */
 543 int rpmdbExtendIterator(rpmdbMatchIterator mi,
 544                         const void * keyp, size_t keylen);
 545
 546 /** \ingroup rpmdb
 547  * sort the iterator by (recnum, filenum)
 548  * Return database iterator.
 549  * @param mi            rpm database iterator
 550  */
 551 void rpmdbSortIterator(rpmdbMatchIterator mi);
 552
 553 #ifndef __APPLE__
 554 /**
 555  *  * Mergesort, same arguments as qsort(2).
 556  *   */
 557 RPM_GNUC_INTERNAL
 558 int mergesort(void *base, size_t nmemb, size_t size,
 559                 int (*cmp) (const void *, const void *));
 560 #else
 561 /* mergesort is defined in stdlib.h on Mac OS X */
 562 #endif /* __APPLE__ */
 563
 564 #endif