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