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     int dbi_api;                /*!< Berkeley API type */
 180
 181     int dbi_verify_on_close;
 182     int dbi_use_dbenv;          /*!< use db environment? */
 183     int dbi_permit_dups;        /*!< permit duplicate entries? */
 184     int dbi_no_fsync;           /*!< no-op fsync for db */
 185     int dbi_no_dbsync;          /*!< don't call dbiSync */
 186     int dbi_lockdbfd;           /*!< do fcntl lock on db fd */
 187     int dbi_temporary;          /*!< non-persistent */
 188     int dbi_debug;
 189     int dbi_byteswapped;
 190
 191     char * dbi_host;
 192     unsigned long dbi_cl_timeout;
 193     unsigned long dbi_sv_timeout;
 194
 195         /* dbenv parameters */
 196     int dbi_lorder;
 197     /* XXX db-4.3.14 adds dbenv as 1st arg. */
 198     void (*db_errcall) (void * dbenv, const char *db_errpfx, char *buffer);
 199     FILE *      dbi_errfile;
 200     char * dbi_errpfx;
 201     int dbi_verbose;
 202     int dbi_region_init;
 203     int dbi_tas_spins;
 204         /* mpool sub-system parameters */
 205     int dbi_mmapsize;   /*!< (10Mb) */
 206     int dbi_cachesize;  /*!< (128Kb) */
 207         /* lock sub-system parameters */
 208     unsigned int dbi_lk_max;
 209     unsigned int dbi_lk_detect;
 210 int dbi_lk_nmodes;
 211 unsigned char * dbi_lk_conflicts;
 212         /* log sub-system parameters */
 213     unsigned int dbi_lg_max;
 214     unsigned int dbi_lg_bsize;
 215         /* transaction sub-system parameters */
 216     unsigned int dbi_tx_max;
 217 #if 0
 218     int (*dbi_tx_recover) (DB_ENV *dbenv, DBT *log_rec,
 219                                 DB_LSN *lsnp, int redo, void *info);
 220 #endif
 221         /* dbinfo parameters */
 222     int dbi_pagesize;           /*!< (fs blksize) */
 223     void * (*dbi_malloc) (size_t nbytes);
 224         /* hash access parameters */
 225     unsigned int dbi_h_ffactor; /*!< */
 226     unsigned int (*dbi_h_hash_fcn) (DB *, const void *bytes,
 227                                 unsigned int length);
 228     unsigned int dbi_h_nelem;   /*!< */
 229     unsigned int dbi_h_flags;   /*!< DB_DUP, DB_DUPSORT */
 230     int (*dbi_h_dup_compare_fcn) (DB *, const DBT *, const DBT *);
 231         /* btree access parameters */
 232     int dbi_bt_flags;
 233     int dbi_bt_minkey;
 234     int (*dbi_bt_compare_fcn) (DB *, const DBT *, const DBT *);
 235     int (*dbi_bt_dup_compare_fcn) (DB *, const DBT *, const DBT *);
 236     size_t (*dbi_bt_prefix_fcn) (DB *, const DBT *, const DBT *);
 237         /* recno access parameters */
 238     int dbi_re_flags;
 239     int dbi_re_delim;
 240     unsigned int dbi_re_len;
 241     int dbi_re_pad;
 242     char * dbi_re_source;
 243         /* queue access parameters */
 244     unsigned int dbi_q_extentsize;
 245
 246     rpmdb dbi_rpmdb;            /*!< the parent rpm database */
 247     rpmTag dbi_rpmtag;  /*!< rpm tag used for index */
 248     int dbi_jlen;               /*!< size of join key */
 249
 250     DB * dbi_db;                /*!< Berkeley DB * handle */
 251     DB_TXN * dbi_txnid;         /*!< Bekerley DB_TXN * transaction id */
 252     void * dbi_stats;           /*!< Berkeley db statistics */
 253
 254     const struct _dbiVec * dbi_vec;     /*!< private methods */
 255
 256 };
 257
 258 /** \ingroup rpmdb
 259  * Describes the collection of index databases used by rpm.
 260  */
 261 struct rpmdb_s {
 262     char        * db_root;/*!< path prefix */
 263     char        * db_home;/*!< directory path */
 264     int         db_flags;
 265     int         db_mode;        /*!< open mode */
 266     int         db_perms;       /*!< open permissions */
 267     int         db_api;         /*!< Berkeley API type */
 268     char        * db_errpfx;
 269     int         db_remove_env;
 270     int         db_filter_dups;
 271     int         db_chrootDone;  /*!< If chroot(2) done, ignore db_root. */
 272     void (*db_errcall) (const char *db_errpfx, char *buffer);
 273     FILE *      db_errfile;
 274     void * (*db_malloc) (size_t nbytes);
 275     void * (*db_realloc) (void * ptr,
 276                                                 size_t nbytes);
 277     void (*db_free) (void * ptr);
 278     unsigned char * db_bits;    /*!< package instance bit mask. */
 279     int         db_nbits;       /*!< no. of bits in mask. */
 280     rpmdb       db_next;
 281     int         db_opens;
 282     void *      db_dbenv;       /*!< Berkeley DB_ENV handle. */
 283     int         db_ndbi;        /*!< No. of tag indices. */
 284     dbiIndex * _dbi;            /*!< Tag indices. */
 285
 286     struct rpmop_s db_getops;
 287     struct rpmop_s db_putops;
 288     struct rpmop_s db_delops;
 289
 290     int nrefs;                  /*!< Reference count. */
 291 };
 292
 293 /* for RPM's internal use only */
 294
 295 /** \ingroup rpmdb
 296  */
 297 enum rpmdbFlags {
 298         RPMDB_FLAG_JUSTCHECK    = (1 << 0),
 299         RPMDB_FLAG_MINIMAL      = (1 << 1),
 300         RPMDB_FLAG_CHROOT       = (1 << 2)
 301 };
 302
 303 #ifdef __cplusplus
 304 extern "C" {
 305 #endif
 306
 307 /** \ingroup db3
 308  * Return new configured index database handle instance.
 309  * @param rpmdb         rpm database
 310  * @param rpmtag        rpm tag
 311  * @return              index database handle
 312  */
 313 RPM_GNUC_INTERNAL
 314 dbiIndex db3New(rpmdb rpmdb, rpmTag rpmtag);
 315
 316 /** \ingroup db3
 317  * Destroy index database handle instance.
 318  * @param dbi           index database handle
 319  * @return              NULL always
 320  */
 321 RPM_GNUC_INTERNAL
 322 dbiIndex db3Free( dbiIndex dbi);
 323
 324 /** \ingroup db3
 325  * Format db3 open flags for debugging print.
 326  * @param dbflags               db open flags
 327  * @param print_dbenv_flags     format db env flags instead?
 328  * @return                      formatted flags (malloced)
 329  */
 330 RPM_GNUC_INTERNAL
 331 char * prDbiOpenFlags(int dbflags, int print_dbenv_flags);
 332
 333 /** \ingroup dbi
 334  * Return handle for an index database.
 335  * @param db            rpm database
 336  * @param rpmtag        rpm tag
 337  * @param flags         (unused)
 338  * @return              index database handle
 339  */
 340 RPM_GNUC_INTERNAL
 341 dbiIndex dbiOpen(rpmdb db, rpmTag rpmtag,
 342                 unsigned int flags);
 343
 344 /* FIX: vector annotations */
 345 /** \ingroup dbi
 346  * Open a database cursor.
 347  * @param dbi           index database handle
 348  * @param txnid         database transaction handle
 349  * @retval dbcp         returned database cursor
 350  * @param flags         DB_WRITECURSOR if writing, or 0
 351  * @return              0 on success
 352  */
 353 static inline
 354 int dbiCopen(dbiIndex dbi, DB_TXN * txnid,
 355                 DBC ** dbcp, unsigned int flags)
 356 {
 357     return (*dbi->dbi_vec->copen) (dbi, txnid, dbcp, flags);
 358 }
 359
 360 /** \ingroup dbi
 361  * Close a database cursor.
 362  * @param dbi           index database handle
 363  * @param dbcursor      database cursor
 364  * @param flags         (unused)
 365  * @return              0 on success
 366  */
 367 static inline
 368 int dbiCclose(dbiIndex dbi, DBC * dbcursor, unsigned int flags)
 369 {
 370     return (*dbi->dbi_vec->cclose) (dbi, dbcursor, flags);
 371 }
 372
 373 /** \ingroup dbi
 374  * Delete (key,data) pair(s) from index database.
 375  * @param dbi           index database handle
 376  * @param dbcursor      database cursor (NULL will use db->del)
 377  * @param key           delete key value/length/flags
 378  * @param data          delete data value/length/flags
 379  * @param flags         (unused)
 380  * @return              0 on success
 381  */
 382 static inline
 383 int dbiDel(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
 384                 unsigned int flags)
 385 {
 386     int rc;
 387     assert(key->data != NULL && key->size > 0);
 388     (void) rpmswEnter(&dbi->dbi_rpmdb->db_delops, 0);
 389     rc = (dbi->dbi_vec->cdel) (dbi, dbcursor, key, data, flags);
 390     (void) rpmswExit(&dbi->dbi_rpmdb->db_delops, data->size);
 391     return rc;
 392 }
 393
 394 /** \ingroup dbi
 395  * Retrieve (key,data) pair from index database.
 396  * @param dbi           index database handle
 397  * @param dbcursor      database cursor (NULL will use db->get)
 398  * @param key           retrieve key value/length/flags
 399  * @param data          retrieve data value/length/flags
 400  * @param flags         (unused)
 401  * @return              0 on success
 402  */
 403 RPM_GNUC_INTERNAL
 404 int dbiGet(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
 405            unsigned int flags);
 406
 407 /** \ingroup dbi
 408  * Store (key,data) pair in index database.
 409  * @param dbi           index database handle
 410  * @param dbcursor      database cursor (NULL will use db->put)
 411  * @param key           store key value/length/flags
 412  * @param data          store data value/length/flags
 413  * @param flags         (unused)
 414  * @return              0 on success
 415  */
 416 RPM_GNUC_INTERNAL
 417 int dbiPut(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
 418            unsigned int flags);
 419
 420 /** \ingroup dbi
 421  * Retrieve count of (possible) duplicate items.
 422  * @param dbi           index database handle
 423  * @param dbcursor      database cursor
 424  * @param countp        address of count
 425  * @param flags         (unused)
 426  * @return              0 on success
 427  */
 428 static inline
 429 int dbiCount(dbiIndex dbi, DBC * dbcursor, unsigned int * countp,
 430                 unsigned int flags)
 431 {
 432     return (*dbi->dbi_vec->ccount) (dbi, dbcursor, countp, flags);
 433 }
 434
 435 /** \ingroup dbi
 436  * Verify (and close) index database.
 437  * @param dbi           index database handle
 438  * @param flags         (unused)
 439  * @return              0 on success
 440  */
 441 static inline
 442 int dbiVerify(dbiIndex dbi, unsigned int flags)
 443 {
 444     dbi->dbi_verify_on_close = 1;
 445     return (*dbi->dbi_vec->close) (dbi, flags);
 446 }
 447
 448 /** \ingroup dbi
 449  * Close index database.
 450  * @param dbi           index database handle
 451  * @param flags         (unused)
 452  * @return              0 on success
 453  */
 454 static inline
 455 int dbiClose(dbiIndex dbi, unsigned int flags)
 456 {
 457     return (*dbi->dbi_vec->close) (dbi, flags);
 458 }
 459
 460 /** \ingroup dbi
 461  * Flush pending operations to disk.
 462  * @param dbi           index database handle
 463  * @param flags         (unused)
 464  * @return              0 on success
 465  */
 466 static inline
 467 int dbiSync (dbiIndex dbi, unsigned int flags)
 468 {
 469     return (*dbi->dbi_vec->sync) (dbi, flags);
 470 }
 471
 472 /** \ingroup dbi
 473  * Is database byte swapped?
 474  * @param dbi           index database handle
 475  * @return              0 same order, 1 swapped order
 476  */
 477 static inline
 478 int dbiByteSwapped(dbiIndex dbi)
 479 {
 480     if (dbi->dbi_byteswapped == -1)
 481         dbi->dbi_byteswapped = (*dbi->dbi_vec->byteswapped) (dbi);
 482     return dbi->dbi_byteswapped;
 483 }
 484 /** \ingroup dbi
 485  * Is database byte swapped?
 486  * @param dbi           index database handle
 487  * @param flags         DB_FAST_STAT or 0
 488  * @return              0 on success
 489  */
 490 static inline
 491 int dbiStat(dbiIndex dbi, unsigned int flags)
 492 {
 493     return (*dbi->dbi_vec->stat) (dbi, flags);
 494 }
 495
 496
 497 /** \ingroup dbi
 498  * Destroy set of index database items.
 499  * @param set   set of index database items
 500  * @return      NULL always
 501  */
 502 RPM_GNUC_INTERNAL
 503 dbiIndexSet dbiFreeIndexSet(dbiIndexSet set);
 504
 505 /** \ingroup dbi
 506  * Count items in index database set.
 507  * @param set   set of index database items
 508  * @return      number of items
 509  */
 510 RPM_GNUC_INTERNAL
 511 unsigned int dbiIndexSetCount(dbiIndexSet set);
 512
 513 /** \ingroup dbi
 514  * Return record offset of header from element in index database set.
 515  * @param set   set of index database items
 516  * @param recno index of item in set
 517  * @return      record offset of header
 518  */
 519 RPM_GNUC_INTERNAL
 520 unsigned int dbiIndexRecordOffset(dbiIndexSet set, int recno);
 521
 522 /** \ingroup dbi
 523  * Return file index from element in index database set.
 524  * @param set   set of index database items
 525  * @param recno index of item in set
 526  * @return      file index
 527  */
 528 RPM_GNUC_INTERNAL
 529 unsigned int dbiIndexRecordFileNumber(dbiIndexSet set, int recno);
 530
 531 /** \ingroup rpmdb
 532  * Return database iterator.
 533  * @param mi            rpm database iterator
 534  * @param keyp          key data (NULL for sequential access)
 535  * @param keylen        key data length (0 will use strlen(keyp))
 536  * @return              0 on success
 537  */
 538 int rpmdbExtendIterator(rpmdbMatchIterator mi,
 539                         const void * keyp, size_t keylen);
 540
 541 /** \ingroup rpmdb
 542  * sort the iterator by (recnum, filenum)
 543  * Return database iterator.
 544  * @param mi            rpm database iterator
 545  */
 546 void rpmdbSortIterator(rpmdbMatchIterator mi);
 547
 548 #ifndef __APPLE__
 549 /**
 550  *  * Mergesort, same arguments as qsort(2).
 551  *   */
 552 RPM_GNUC_INTERNAL
 553 int mergesort(void *base, size_t nmemb, size_t size,
 554                 int (*cmp) (const void *, const void *));
 555 #else
 556 /* mergesort is defined in stdlib.h on Mac OS X */
 557 #endif /* __APPLE__ */
 558
 559 #endif