1 #ifndef H_RPMDB_INTERNAL
2 #define H_RPMDB_INTERNAL
8 #include <rpm/rpmtypes.h>
9 #include <rpm/rpmutil.h>
13 typedef struct _dbiIndexItem * dbiIndexItem;
16 * A single element (i.e. inverted list from tag values) of a database.
18 typedef struct _dbiIndexSet * dbiIndexSet;
22 typedef struct _dbiIndex * dbiIndex;
24 /* this will break if sizeof(int) != 4 */
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.
30 struct _dbiIndexItem {
31 unsigned int hdrNum; /*!< header instance in db */
32 unsigned int tagNum; /*!< tag index in header */
36 * Items retrieved from the index database.
39 struct _dbiIndexItem * recs; /*!< array of records */
40 unsigned int count; /*!< number of records */
41 size_t alloced; /*!< alloced size */
45 * Describes an index database (implemented on Berkeley db functionality).
48 char * dbi_file; /*!< file component of path */
50 char * dbi_tmpdir; /*!< temporary directory */
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 */
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 */
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 */
74 /* dbenv parameters */
76 /* XXX db-4.3.14 adds dbenv as 1st arg. */
77 void (*db_errcall) (void * dbenv, const char *db_errpfx, char *buffer);
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;
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;
97 int (*dbi_tx_recover) (DB_ENV *dbenv, DBT *log_rec,
98 DB_LSN *lsnp, int redo, void *info);
100 /* dbinfo parameters */
101 int dbi_pagesize; /*!< (fs blksize) */
102 void * (*dbi_malloc) (size_t nbytes);
103 /* hash access parameters */
104 unsigned int dbi_h_ffactor; /*!< */
105 unsigned int (*dbi_h_hash_fcn) (DB *, const void *bytes,
106 unsigned int length);
107 unsigned int dbi_h_nelem; /*!< */
108 unsigned int dbi_h_flags; /*!< DB_DUP, DB_DUPSORT */
109 int (*dbi_h_dup_compare_fcn) (DB *, const DBT *, const DBT *);
110 /* btree access parameters */
113 int (*dbi_bt_compare_fcn) (DB *, const DBT *, const DBT *);
114 int (*dbi_bt_dup_compare_fcn) (DB *, const DBT *, const DBT *);
115 size_t (*dbi_bt_prefix_fcn) (DB *, const DBT *, const DBT *);
116 /* recno access parameters */
119 unsigned int dbi_re_len;
121 char * dbi_re_source;
122 /* queue access parameters */
123 unsigned int dbi_q_extentsize;
125 rpmdb dbi_rpmdb; /*!< the parent rpm database */
126 rpmTag dbi_rpmtag; /*!< rpm tag used for index */
127 int dbi_jlen; /*!< size of join key */
129 DB * dbi_db; /*!< Berkeley DB * handle */
130 DB_TXN * dbi_txnid; /*!< Bekerley DB_TXN * transaction id */
131 void * dbi_stats; /*!< Berkeley db statistics */
135 * Describes the collection of index databases used by rpm.
138 char * db_root;/*!< path prefix */
139 char * db_home;/*!< directory path */
140 char * db_fullpath; /*!< full db path including prefix */
142 int db_mode; /*!< open mode */
143 int db_perms; /*!< open permissions */
144 int db_api; /*!< Berkeley API type */
147 int db_chrootDone; /*!< If chroot(2) done, ignore db_root. */
148 int db_mkdirDone; /*!< Has db_home been created? */
149 void (*db_errcall) (const char *db_errpfx, char *buffer);
151 void * (*db_malloc) (size_t nbytes);
152 void * (*db_realloc) (void * ptr,
154 void (*db_free) (void * ptr);
155 unsigned char * db_bits; /*!< package instance bit mask. */
156 int db_nbits; /*!< no. of bits in mask. */
159 void * db_dbenv; /*!< Berkeley DB_ENV handle. */
160 int db_ndbi; /*!< No. of tag indices. */
161 dbiIndex * _dbi; /*!< Tag indices. */
163 struct rpmop_s db_getops;
164 struct rpmop_s db_putops;
165 struct rpmop_s db_delops;
167 int nrefs; /*!< Reference count. */
170 /* for RPM's internal use only */
175 RPMDB_FLAG_JUSTCHECK = (1 << 0),
176 RPMDB_FLAG_MINIMAL = (1 << 1),
177 RPMDB_FLAG_CHROOT = (1 << 2)
185 * Return new configured index database handle instance.
186 * @param rpmdb rpm database
187 * @param rpmtag rpm tag
188 * @return index database handle
191 dbiIndex dbiNew(rpmdb rpmdb, rpmTag rpmtag);
194 * Destroy index database handle instance.
195 * @param dbi index database handle
196 * @return NULL always
199 dbiIndex dbiFree( dbiIndex dbi);
202 * Format dbi open flags for debugging print.
203 * @param dbflags db open flags
204 * @param print_dbenv_flags format db env flags instead?
205 * @return formatted flags (malloced)
208 char * prDbiOpenFlags(int dbflags, int print_dbenv_flags);
211 * Return handle for an index database.
212 * @param db rpm database
213 * @param rpmtag rpm tag
214 * @param flags (unused)
215 * @return index database handle
218 dbiIndex dbiOpen(rpmdb db, rpmTag rpmtag,
223 * Actually open the database of the index.
224 * @param db rpm database
225 * @param rpmtag rpm tag
226 * @param dbiIndex address of index database handle
227 * @return 0 on success
230 int dbiOpenDB(rpmdb rpmdb, rpmTag rpmtag, dbiIndex * dbip);
233 /* FIX: vector annotations */
235 * Open a database cursor.
236 * @param dbi index database handle
237 * @param txnid database transaction handle
238 * @retval dbcp returned database cursor
239 * @param flags DB_WRITECURSOR if writing, or 0
240 * @return 0 on success
243 int dbiCopen(dbiIndex dbi, DB_TXN * txnid,
244 DBC ** dbcp, unsigned int flags);
247 * Close a database cursor.
248 * @param dbi index database handle
249 * @param dbcursor database cursor
250 * @param flags (unused)
251 * @return 0 on success
254 int dbiCclose(dbiIndex dbi, DBC * dbcursor, unsigned int flags);
257 * Delete (key,data) pair(s) from index database.
258 * @param dbi index database handle
259 * @param dbcursor database cursor (NULL will use db->del)
260 * @param key delete key value/length/flags
261 * @param data delete data value/length/flags
262 * @param flags (unused)
263 * @return 0 on success
266 int dbiDel(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
270 * Retrieve (key,data) pair from index database.
271 * @param dbi index database handle
272 * @param dbcursor database cursor (NULL will use db->get)
273 * @param key retrieve key value/length/flags
274 * @param data retrieve data value/length/flags
275 * @param flags (unused)
276 * @return 0 on success
279 int dbiGet(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
283 * Store (key,data) pair in index database.
284 * @param dbi index database handle
285 * @param dbcursor database cursor (NULL will use db->put)
286 * @param key store key value/length/flags
287 * @param data store data value/length/flags
288 * @param flags (unused)
289 * @return 0 on success
292 int dbiPut(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
296 * Retrieve count of (possible) duplicate items.
297 * @param dbi index database handle
298 * @param dbcursor database cursor
299 * @param countp address of count
300 * @param flags (unused)
301 * @return 0 on success
303 int dbiCount(dbiIndex dbi, DBC * dbcursor, unsigned int * countp,
307 * Close index database.
308 * @param dbi index database handle
309 * @param flags (unused)
310 * @return 0 on success
312 int dbiClose(dbiIndex dbi, unsigned int flags);
315 * Flush pending operations to disk.
316 * @param dbi index database handle
317 * @param flags (unused)
318 * @return 0 on success
320 int dbiSync (dbiIndex dbi, unsigned int flags);
323 * Verify (and close) index database.
324 * @param dbi index database handle
325 * @param flags (unused)
326 * @return 0 on success
329 int dbiVerify(dbiIndex dbi, unsigned int flags)
331 dbi->dbi_verify_on_close = 1;
332 return dbiClose(dbi, flags);
337 * Is database byte swapped?
338 * @param dbi index database handle
339 * @return 0 same order, 1 swapped order
341 int dbiByteSwapped(dbiIndex dbi);
344 * Is database byte swapped?
345 * @param dbi index database handle
346 * @param flags DB_FAST_STAT or 0
347 * @return 0 on success
349 int dbiStat(dbiIndex dbi, unsigned int flags);
352 * Destroy set of index database items.
353 * @param set set of index database items
354 * @return NULL always
357 dbiIndexSet dbiFreeIndexSet(dbiIndexSet set);
360 * Count items in index database set.
361 * @param set set of index database items
362 * @return number of items
365 unsigned int dbiIndexSetCount(dbiIndexSet set);
368 * Return record offset of header from element in index database set.
369 * @param set set of index database items
370 * @param recno index of item in set
371 * @return record offset of header
374 unsigned int dbiIndexRecordOffset(dbiIndexSet set, int recno);
377 * Return file index from element in index database set.
378 * @param set set of index database items
379 * @param recno index of item in set
383 unsigned int dbiIndexRecordFileNumber(dbiIndexSet set, int recno);
386 * Return rpmdb home directory (depending on chroot state)
387 * param db rpmdb handle
388 * return db home directory (or NULL on error)
391 const char *rpmdbHome(rpmdb db);
394 * Return database iterator.
395 * @param mi rpm database iterator
396 * @param keyp key data (NULL for sequential access)
397 * @param keylen key data length (0 will use strlen(keyp))
398 * @return 0 on success
400 int rpmdbExtendIterator(rpmdbMatchIterator mi,
401 const void * keyp, size_t keylen);
404 * sort the iterator by (recnum, filenum)
405 * Return database iterator.
406 * @param mi rpm database iterator
408 void rpmdbSortIterator(rpmdbMatchIterator mi);
412 * * Mergesort, same arguments as qsort(2).
415 int mergesort(void *base, size_t nmemb, size_t size,
416 int (*cmp) (const void *, const void *));
418 /* mergesort is defined in stdlib.h on Mac OS X */
419 #endif /* __APPLE__ */