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