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  * Describes an index database (implemented on Berkeley db functionality).
  46  */
  47 struct _dbiIndex {
  48     char * dbi_file;            /*!< file component of path */
  49     char * dbi_subfile;
  50     char * dbi_tmpdir;          /*!< temporary directory */
  51
  52     int dbi_ecflags;            /*!< db_env_create flags */
  53     int dbi_cflags;             /*!< db_create flags */
  54     int dbi_oeflags;            /*!< common (db,dbenv}->open flags */
  55     int dbi_eflags;             /*!< dbenv->open flags */
  56     int dbi_oflags;             /*!< db->open flags */
  57     int dbi_tflags;             /*!< dbenv->txn_begin flags */
  58
  59     int dbi_type;               /*!< db index type */
  60     unsigned dbi_mode;          /*!< mode to use on open */
  61     int dbi_perms;              /*!< file permission to use on open */
  62     long dbi_shmkey;            /*!< shared memory base key */
  63
  64     int dbi_verify_on_close;
  65     int dbi_use_dbenv;          /*!< use db environment? */
  66     int dbi_permit_dups;        /*!< permit duplicate entries? */
  67     int dbi_no_fsync;           /*!< no-op fsync for db */
  68     int dbi_no_dbsync;          /*!< don't call dbiSync */
  69     int dbi_lockdbfd;           /*!< do fcntl lock on db fd */
  70     int dbi_temporary;          /*!< non-persistent */
  71     int dbi_debug;
  72     int dbi_byteswapped;
  73
  74         /* dbenv parameters */
  75     int dbi_lorder;
  76     /* XXX db-4.3.14 adds dbenv as 1st arg. */
  77     void (*db_errcall) (void * dbenv, const char *db_errpfx, char *buffer);
  78     FILE *      dbi_errfile;
  79     char * dbi_errpfx;
  80     int dbi_verbose;
  81     int dbi_region_init;
  82     int dbi_tas_spins;
  83         /* mpool sub-system parameters */
  84     int dbi_mmapsize;   /*!< (10Mb) */
  85     int dbi_cachesize;  /*!< (128Kb) */
  86         /* lock sub-system parameters */
  87     unsigned int dbi_lk_max;
  88     unsigned int dbi_lk_detect;
  89 int dbi_lk_nmodes;
  90 unsigned char * dbi_lk_conflicts;
  91         /* log sub-system parameters */
  92     unsigned int dbi_lg_max;
  93     unsigned int dbi_lg_bsize;
  94         /* transaction sub-system parameters */
  95     unsigned int dbi_tx_max;
  96 #if 0
  97     int (*dbi_tx_recover) (DB_ENV *dbenv, DBT *log_rec,
  98                                 DB_LSN *lsnp, int redo, void *info);
  99 #endif
 100         /* dbinfo parameters */
 101     int dbi_pagesize;           /*!< (fs blksize) */
 102     void * (*dbi_malloc) (size_t nbytes);
 103         /* hash access parameters */
 104     unsigned int dbi_h_ffactor; /*!< */
 105     unsigned int (*dbi_h_hash_fcn) (DB *, const void *bytes,
 106                                 unsigned int length);
 107     unsigned int dbi_h_nelem;   /*!< */
 108     unsigned int dbi_h_flags;   /*!< DB_DUP, DB_DUPSORT */
 109     int (*dbi_h_dup_compare_fcn) (DB *, const DBT *, const DBT *);
 110         /* btree access parameters */
 111     int dbi_bt_flags;
 112     int dbi_bt_minkey;
 113     int (*dbi_bt_compare_fcn) (DB *, const DBT *, const DBT *);
 114     int (*dbi_bt_dup_compare_fcn) (DB *, const DBT *, const DBT *);
 115     size_t (*dbi_bt_prefix_fcn) (DB *, const DBT *, const DBT *);
 116         /* recno access parameters */
 117     int dbi_re_flags;
 118     int dbi_re_delim;
 119     unsigned int dbi_re_len;
 120     int dbi_re_pad;
 121     char * dbi_re_source;
 122         /* queue access parameters */
 123     unsigned int dbi_q_extentsize;
 124
 125     rpmdb dbi_rpmdb;            /*!< the parent rpm database */
 126     rpmTag dbi_rpmtag;  /*!< rpm tag used for index */
 127     int dbi_jlen;               /*!< size of join key */
 128
 129     DB * dbi_db;                /*!< Berkeley DB * handle */
 130     DB_TXN * dbi_txnid;         /*!< Bekerley DB_TXN * transaction id */
 131     void * dbi_stats;           /*!< Berkeley db statistics */
 132 };
 133
 134 /** \ingroup rpmdb
 135  * Describes the collection of index databases used by rpm.
 136  */
 137 struct rpmdb_s {
 138     char        * db_root;/*!< path prefix */
 139     char        * db_home;/*!< directory path */
 140     char        * db_fullpath;  /*!< full db path including prefix */
 141     int         db_flags;
 142     int         db_mode;        /*!< open mode */
 143     int         db_perms;       /*!< open permissions */
 144     int         db_api;         /*!< Berkeley API type */
 145     char        * db_errpfx;
 146     int         db_remove_env;
 147     int         db_chrootDone;  /*!< If chroot(2) done, ignore db_root. */
 148     int         db_mkdirDone;   /*!< Has db_home been created? */
 149     void (*db_errcall) (const char *db_errpfx, char *buffer);
 150     FILE *      db_errfile;
 151     void * (*db_malloc) (size_t nbytes);
 152     void * (*db_realloc) (void * ptr,
 153                                                 size_t nbytes);
 154     void (*db_free) (void * ptr);
 155     unsigned char * db_bits;    /*!< package instance bit mask. */
 156     int         db_nbits;       /*!< no. of bits in mask. */
 157     rpmdb       db_next;
 158     int         db_opens;
 159     void *      db_dbenv;       /*!< Berkeley DB_ENV handle. */
 160     dbiIndex * _dbi;            /*!< Tag indices. */
 161
 162     struct rpmop_s db_getops;
 163     struct rpmop_s db_putops;
 164     struct rpmop_s db_delops;
 165
 166     int nrefs;                  /*!< Reference count. */
 167 };
 168
 169 /* for RPM's internal use only */
 170
 171 /** \ingroup rpmdb
 172  */
 173 enum rpmdbFlags {
 174         RPMDB_FLAG_JUSTCHECK    = (1 << 0),
 175         RPMDB_FLAG_MINIMAL      = (1 << 1),
 176         RPMDB_FLAG_CHROOT       = (1 << 2)
 177 };
 178
 179 #ifdef __cplusplus
 180 extern "C" {
 181 #endif
 182
 183 /** \ingroup dbi
 184  * Return new configured index database handle instance.
 185  * @param rpmdb         rpm database
 186  * @param rpmtag        rpm tag
 187  * @return              index database handle
 188  */
 189 RPM_GNUC_INTERNAL
 190 dbiIndex dbiNew(rpmdb rpmdb, rpmTag rpmtag);
 191
 192 /** \ingroup dbi
 193  * Destroy index database handle instance.
 194  * @param dbi           index database handle
 195  * @return              NULL always
 196  */
 197 RPM_GNUC_INTERNAL
 198 dbiIndex dbiFree( dbiIndex dbi);
 199
 200 /** \ingroup dbi
 201  * Format dbi open flags for debugging print.
 202  * @param dbflags               db open flags
 203  * @param print_dbenv_flags     format db env flags instead?
 204  * @return                      formatted flags (malloced)
 205  */
 206 RPM_GNUC_INTERNAL
 207 char * prDbiOpenFlags(int dbflags, int print_dbenv_flags);
 208
 209 /** \ingroup dbi
 210  * Return handle for an index database.
 211  * @param db            rpm database
 212  * @param rpmtag        rpm tag
 213  * @param flags         (unused)
 214  * @return              index database handle
 215  */
 216 RPM_GNUC_INTERNAL
 217 dbiIndex dbiOpen(rpmdb db, rpmTag rpmtag,
 218                 unsigned int flags);
 219
 220
 221 /** \ingroup dbi
 222  * Actually open the database of the index.
 223  * @param db            rpm database
 224  * @param rpmtag        rpm tag
 225  * @param dbiIndex      address of index database handle
 226  * @return              0 on success
 227  */
 228 RPM_GNUC_INTERNAL
 229 int dbiOpenDB(rpmdb rpmdb, rpmTag rpmtag, dbiIndex * dbip);
 230
 231
 232 /* FIX: vector annotations */
 233 /** \ingroup dbi
 234  * Open a database cursor.
 235  * @param dbi           index database handle
 236  * @param txnid         database transaction handle
 237  * @retval dbcp         returned database cursor
 238  * @param flags         DB_WRITECURSOR if writing, or 0
 239  * @return              0 on success
 240  */
 241 RPM_GNUC_INTERNAL
 242 int dbiCopen(dbiIndex dbi, DB_TXN * txnid,
 243              DBC ** dbcp, unsigned int flags);
 244
 245 /** \ingroup dbi
 246  * Close a database cursor.
 247  * @param dbi           index database handle
 248  * @param dbcursor      database cursor
 249  * @param flags         (unused)
 250  * @return              0 on success
 251  */
 252 RPM_GNUC_INTERNAL
 253 int dbiCclose(dbiIndex dbi, DBC * dbcursor, unsigned int flags);
 254
 255 /** \ingroup dbi
 256  * Delete (key,data) pair(s) from index database.
 257  * @param dbi           index database handle
 258  * @param dbcursor      database cursor (NULL will use db->del)
 259  * @param key           delete key value/length/flags
 260  * @param data          delete data value/length/flags
 261  * @param flags         (unused)
 262  * @return              0 on success
 263  */
 264 RPM_GNUC_INTERNAL
 265 int dbiDel(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
 266            unsigned int flags);
 267
 268 /** \ingroup dbi
 269  * Retrieve (key,data) pair from index database.
 270  * @param dbi           index database handle
 271  * @param dbcursor      database cursor (NULL will use db->get)
 272  * @param key           retrieve key value/length/flags
 273  * @param data          retrieve data value/length/flags
 274  * @param flags         (unused)
 275  * @return              0 on success
 276  */
 277 RPM_GNUC_INTERNAL
 278 int dbiGet(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
 279            unsigned int flags);
 280
 281 /** \ingroup dbi
 282  * Store (key,data) pair in index database.
 283  * @param dbi           index database handle
 284  * @param dbcursor      database cursor (NULL will use db->put)
 285  * @param key           store key value/length/flags
 286  * @param data          store data value/length/flags
 287  * @param flags         (unused)
 288  * @return              0 on success
 289  */
 290 RPM_GNUC_INTERNAL
 291 int dbiPut(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
 292            unsigned int flags);
 293
 294 /** \ingroup dbi
 295  * Retrieve count of (possible) duplicate items.
 296  * @param dbi           index database handle
 297  * @param dbcursor      database cursor
 298  * @param countp        address of count
 299  * @param flags         (unused)
 300  * @return              0 on success
 301  */
 302 int dbiCount(dbiIndex dbi, DBC * dbcursor, unsigned int * countp,
 303              unsigned int flags);
 304
 305 /** \ingroup dbi
 306  * Close index database.
 307  * @param dbi           index database handle
 308  * @param flags         (unused)
 309  * @return              0 on success
 310  */
 311 int dbiClose(dbiIndex dbi, unsigned int flags);
 312
 313 /** \ingroup dbi
 314  * Flush pending operations to disk.
 315  * @param dbi           index database handle
 316  * @param flags         (unused)
 317  * @return              0 on success
 318  */
 319 int dbiSync (dbiIndex dbi, unsigned int flags);
 320
 321 /** \ingroup dbi
 322  * Verify (and close) index database.
 323  * @param dbi           index database handle
 324  * @param flags         (unused)
 325  * @return              0 on success
 326  */
 327 static inline
 328 int dbiVerify(dbiIndex dbi, unsigned int flags)
 329 {
 330     dbi->dbi_verify_on_close = 1;
 331     return dbiClose(dbi, flags);
 332 }
 333
 334
 335 /** \ingroup dbi
 336  * Is database byte swapped?
 337  * @param dbi           index database handle
 338  * @return              0 same order, 1 swapped order
 339  */
 340 int dbiByteSwapped(dbiIndex dbi);
 341
 342 /** \ingroup dbi
 343  * Is database byte swapped?
 344  * @param dbi           index database handle
 345  * @param flags         DB_FAST_STAT or 0
 346  * @return              0 on success
 347  */
 348 int dbiStat(dbiIndex dbi, unsigned int flags);
 349
 350 /** \ingroup dbi
 351  * Destroy set of index database items.
 352  * @param set   set of index database items
 353  * @return      NULL always
 354  */
 355 RPM_GNUC_INTERNAL
 356 dbiIndexSet dbiFreeIndexSet(dbiIndexSet set);
 357
 358 /** \ingroup dbi
 359  * Count items in index database set.
 360  * @param set   set of index database items
 361  * @return      number of items
 362  */
 363 RPM_GNUC_INTERNAL
 364 unsigned int dbiIndexSetCount(dbiIndexSet set);
 365
 366 /** \ingroup dbi
 367  * Return record offset of header from element in index database set.
 368  * @param set   set of index database items
 369  * @param recno index of item in set
 370  * @return      record offset of header
 371  */
 372 RPM_GNUC_INTERNAL
 373 unsigned int dbiIndexRecordOffset(dbiIndexSet set, int recno);
 374
 375 /** \ingroup dbi
 376  * Return file index from element in index database set.
 377  * @param set   set of index database items
 378  * @param recno index of item in set
 379  * @return      file index
 380  */
 381 RPM_GNUC_INTERNAL
 382 unsigned int dbiIndexRecordFileNumber(dbiIndexSet set, int recno);
 383
 384 /** \ingroup rpmdb
 385  * Return rpmdb home directory (depending on chroot state)
 386  * param db             rpmdb handle
 387  * return               db home directory (or NULL on error)
 388  */
 389 RPM_GNUC_INTERNAL
 390 const char *rpmdbHome(rpmdb db);
 391
 392 /** \ingroup rpmdb
 393  * Return database iterator.
 394  * @param mi            rpm database iterator
 395  * @param keyp          key data (NULL for sequential access)
 396  * @param keylen        key data length (0 will use strlen(keyp))
 397  * @return              0 on success
 398  */
 399 int rpmdbExtendIterator(rpmdbMatchIterator mi,
 400                         const void * keyp, size_t keylen);
 401
 402 /** \ingroup rpmdb
 403  * sort the iterator by (recnum, filenum)
 404  * Return database iterator.
 405  * @param mi            rpm database iterator
 406  */
 407 void rpmdbSortIterator(rpmdbMatchIterator mi);
 408
 409 #ifndef __APPLE__
 410 /**
 411  *  * Mergesort, same arguments as qsort(2).
 412  *   */
 413 RPM_GNUC_INTERNAL
 414 int mergesort(void *base, size_t nmemb, size_t size,
 415                 int (*cmp) (const void *, const void *));
 416 #else
 417 /* mergesort is defined in stdlib.h on Mac OS X */
 418 #endif /* __APPLE__ */
 419
 420 #endif