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