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