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 typedef struct _dbiIndex * dbiIndex;
  12
  13 /** \ingroup dbi
  14  * Describes an index database (implemented on Berkeley db functionality).
  15  */
  16 struct _dbiIndex {
  17     char * dbi_file;            /*!< file component of path */
  18
  19     int dbi_ecflags;            /*!< db_env_create flags */
  20     int dbi_cflags;             /*!< db_create flags */
  21     int dbi_oeflags;            /*!< common (db,dbenv}->open flags */
  22     int dbi_eflags;             /*!< dbenv->open flags */
  23     int dbi_oflags;             /*!< db->open flags */
  24     int dbi_tflags;             /*!< dbenv->txn_begin flags */
  25
  26     int dbi_type;               /*!< db index type */
  27     unsigned dbi_mode;          /*!< mode to use on open */
  28     int dbi_perms;              /*!< file permission to use on open */
  29
  30     int dbi_verify_on_close;
  31     int dbi_use_dbenv;          /*!< use db environment? */
  32     int dbi_permit_dups;        /*!< permit duplicate entries? */
  33     int dbi_no_fsync;           /*!< no-op fsync for db */
  34     int dbi_no_dbsync;          /*!< don't call dbiSync */
  35     int dbi_lockdbfd;           /*!< do fcntl lock on db fd */
  36     int dbi_byteswapped;
  37
  38         /* dbenv parameters */
  39     int dbi_lorder;
  40     /* XXX db-4.3.14 adds dbenv as 1st arg. */
  41     int dbi_verbose;
  42         /* mpool sub-system parameters */
  43     int dbi_mmapsize;   /*!< (10Mb) */
  44     int dbi_cachesize;  /*!< (128Kb) */
  45         /* dbinfo parameters */
  46     int dbi_pagesize;           /*!< (fs blksize) */
  47
  48     rpmdb dbi_rpmdb;            /*!< the parent rpm database */
  49     rpmTag dbi_rpmtag;  /*!< rpm tag used for index */
  50     int dbi_jlen;               /*!< size of join key */
  51
  52     DB * dbi_db;                /*!< Berkeley DB * handle */
  53     DB_TXN * dbi_txnid;         /*!< Bekerley DB_TXN * transaction id */
  54     void * dbi_stats;           /*!< Berkeley db statistics */
  55 };
  56
  57 /** \ingroup rpmdb
  58  * Describes the collection of index databases used by rpm.
  59  */
  60 struct rpmdb_s {
  61     char        * db_root;/*!< path prefix */
  62     char        * db_home;/*!< directory path */
  63     char        * db_fullpath;  /*!< full db path including prefix */
  64     int         db_flags;
  65     int         db_mode;        /*!< open mode */
  66     int         db_perms;       /*!< open permissions */
  67     int         db_api;         /*!< Berkeley API type */
  68     int         db_remove_env;
  69     int         db_chrootDone;  /*!< If chroot(2) done, ignore db_root. */
  70     int         db_mkdirDone;   /*!< Has db_home been created? */
  71     unsigned char * db_bits;    /*!< package instance bit mask. */
  72     int         db_nbits;       /*!< no. of bits in mask. */
  73     rpmdb       db_next;
  74     int         db_opens;
  75     void *      db_dbenv;       /*!< Berkeley DB_ENV handle. */
  76     int         db_ndbi;        /*!< No. of tag indices. */
  77     dbiIndex * _dbi;            /*!< Tag indices. */
  78
  79     struct rpmop_s db_getops;
  80     struct rpmop_s db_putops;
  81     struct rpmop_s db_delops;
  82
  83     int nrefs;                  /*!< Reference count. */
  84 };
  85
  86 /* for RPM's internal use only */
  87
  88 /** \ingroup rpmdb
  89  */
  90 enum rpmdbFlags {
  91         RPMDB_FLAG_JUSTCHECK    = (1 << 0),
  92         RPMDB_FLAG_MINIMAL      = (1 << 1),
  93         RPMDB_FLAG_CHROOT       = (1 << 2)
  94 };
  95
  96 #ifdef __cplusplus
  97 extern "C" {
  98 #endif
  99
 100 /** \ingroup dbi
 101  * Return new configured index database handle instance.
 102  * @param rpmdb         rpm database
 103  * @param rpmtag        rpm tag
 104  * @return              index database handle
 105  */
 106 RPM_GNUC_INTERNAL
 107 dbiIndex dbiNew(rpmdb rpmdb, rpmTag rpmtag);
 108
 109 /** \ingroup dbi
 110  * Destroy index database handle instance.
 111  * @param dbi           index database handle
 112  * @return              NULL always
 113  */
 114 RPM_GNUC_INTERNAL
 115 dbiIndex dbiFree( dbiIndex dbi);
 116
 117 /** \ingroup dbi
 118  * Format dbi open flags for debugging print.
 119  * @param dbflags               db open flags
 120  * @param print_dbenv_flags     format db env flags instead?
 121  * @return                      formatted flags (malloced)
 122  */
 123 RPM_GNUC_INTERNAL
 124 char * prDbiOpenFlags(int dbflags, int print_dbenv_flags);
 125
 126 /** \ingroup dbi
 127  * Actually open the database of the index.
 128  * @param db            rpm database
 129  * @param rpmtag        rpm tag
 130  * @param dbiIndex      address of index database handle
 131  * @return              0 on success
 132  */
 133 RPM_GNUC_INTERNAL
 134 int dbiOpenDB(rpmdb rpmdb, rpmTag rpmtag, dbiIndex * dbip);
 135
 136
 137 /* FIX: vector annotations */
 138 /** \ingroup dbi
 139  * Open a database cursor.
 140  * @param dbi           index database handle
 141  * @param txnid         database transaction handle
 142  * @retval dbcp         returned database cursor
 143  * @param flags         DB_WRITECURSOR if writing, or 0
 144  * @return              0 on success
 145  */
 146 RPM_GNUC_INTERNAL
 147 int dbiCopen(dbiIndex dbi, DB_TXN * txnid,
 148              DBC ** dbcp, unsigned int flags);
 149
 150 /** \ingroup dbi
 151  * Close a database cursor.
 152  * @param dbi           index database handle
 153  * @param dbcursor      database cursor
 154  * @param flags         (unused)
 155  * @return              0 on success
 156  */
 157 RPM_GNUC_INTERNAL
 158 int dbiCclose(dbiIndex dbi, DBC * dbcursor, unsigned int flags);
 159
 160 /** \ingroup dbi
 161  * Delete (key,data) pair(s) from index database.
 162  * @param dbi           index database handle
 163  * @param dbcursor      database cursor (NULL will use db->del)
 164  * @param key           delete key value/length/flags
 165  * @param data          delete data value/length/flags
 166  * @param flags         (unused)
 167  * @return              0 on success
 168  */
 169 RPM_GNUC_INTERNAL
 170 int dbiDel(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
 171            unsigned int flags);
 172
 173 /** \ingroup dbi
 174  * Retrieve (key,data) pair from index database.
 175  * @param dbi           index database handle
 176  * @param dbcursor      database cursor (NULL will use db->get)
 177  * @param key           retrieve key value/length/flags
 178  * @param data          retrieve data value/length/flags
 179  * @param flags         (unused)
 180  * @return              0 on success
 181  */
 182 RPM_GNUC_INTERNAL
 183 int dbiGet(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
 184            unsigned int flags);
 185
 186 /** \ingroup dbi
 187  * Store (key,data) pair in index database.
 188  * @param dbi           index database handle
 189  * @param dbcursor      database cursor (NULL will use db->put)
 190  * @param key           store key value/length/flags
 191  * @param data          store data value/length/flags
 192  * @param flags         (unused)
 193  * @return              0 on success
 194  */
 195 RPM_GNUC_INTERNAL
 196 int dbiPut(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
 197            unsigned int flags);
 198
 199 /** \ingroup dbi
 200  * Retrieve count of (possible) duplicate items.
 201  * @param dbi           index database handle
 202  * @param dbcursor      database cursor
 203  * @param countp        address of count
 204  * @param flags         (unused)
 205  * @return              0 on success
 206  */
 207 int dbiCount(dbiIndex dbi, DBC * dbcursor, unsigned int * countp,
 208              unsigned int flags);
 209
 210 /** \ingroup dbi
 211  * Close index database.
 212  * @param dbi           index database handle
 213  * @param flags         (unused)
 214  * @return              0 on success
 215  */
 216 int dbiClose(dbiIndex dbi, unsigned int flags);
 217
 218 /** \ingroup dbi
 219  * Flush pending operations to disk.
 220  * @param dbi           index database handle
 221  * @param flags         (unused)
 222  * @return              0 on success
 223  */
 224 int dbiSync (dbiIndex dbi, unsigned int flags);
 225
 226
 227 /** \ingroup dbi
 228  * Is database byte swapped?
 229  * @param dbi           index database handle
 230  * @return              0 same order, 1 swapped order
 231  */
 232 int dbiByteSwapped(dbiIndex dbi);
 233
 234 /** \ingroup dbi
 235  * Is database byte swapped?
 236  * @param dbi           index database handle
 237  * @param flags         DB_FAST_STAT or 0
 238  * @return              0 on success
 239  */
 240 int dbiStat(dbiIndex dbi, unsigned int flags);
 241
 242 /** \ingroup rpmdb
 243  * Return rpmdb home directory (depending on chroot state)
 244  * param db             rpmdb handle
 245  * return               db home directory (or NULL on error)
 246  */
 247 RPM_GNUC_INTERNAL
 248 const char *rpmdbHome(rpmdb db);
 249
 250 /** \ingroup rpmdb
 251  * Return database iterator.
 252  * @param mi            rpm database iterator
 253  * @param keyp          key data (NULL for sequential access)
 254  * @param keylen        key data length (0 will use strlen(keyp))
 255  * @return              0 on success
 256  */
 257 int rpmdbExtendIterator(rpmdbMatchIterator mi,
 258                         const void * keyp, size_t keylen);
 259
 260 /** \ingroup rpmdb
 261  * sort the iterator by (recnum, filenum)
 262  * Return database iterator.
 263  * @param mi            rpm database iterator
 264  */
 265 void rpmdbSortIterator(rpmdbMatchIterator mi);
 266
 267 #ifndef __APPLE__
 268 /**
 269  *  * Mergesort, same arguments as qsort(2).
 270  *   */
 271 RPM_GNUC_INTERNAL
 272 int mergesort(void *base, size_t nmemb, size_t size,
 273                 int (*cmp) (const void *, const void *));
 274 #else
 275 /* mergesort is defined in stdlib.h on Mac OS X */
 276 #endif /* __APPLE__ */
 277
 278 #endif