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 * Private methods for accessing an index database.
48 int dbv_major; /*!< Berkeley db version major */
49 int dbv_minor; /*!< Berkeley db version minor */
50 int dbv_patch; /*!< Berkeley db version patch */
53 * Return handle for an index database.
54 * @param rpmdb rpm database
55 * @param rpmtag rpm tag
56 * @return 0 on success
58 int (*open) (rpmdb rpmdb, rpmTag rpmtag, dbiIndex * dbip);
61 * Close index database, and destroy database handle.
62 * @param dbi index database handle
63 * @param flags (unused)
64 * @return 0 on success
66 int (*close) (dbiIndex dbi, unsigned int flags);
69 * Flush pending operations to disk.
70 * @param dbi index database handle
71 * @param flags (unused)
72 * @return 0 on success
74 int (*sync) (dbiIndex dbi, unsigned int flags);
77 * Open database cursor.
78 * @param dbi index database handle
79 * @param txnid database transaction handle
80 * @retval dbcp address of new database cursor
81 * @param dbiflags DB_WRITECURSOR or 0
82 * @return 0 on success
84 int (*copen) (dbiIndex dbi, DB_TXN * txnid,
85 DBC ** dbcp, unsigned int dbiflags);
88 * Close database cursor.
89 * @param dbi index database handle
90 * @param dbcursor database cursor
91 * @param flags (unused)
92 * @return 0 on success
94 int (*cclose) (dbiIndex dbi, DBC * dbcursor, unsigned int flags);
97 * Delete (key,data) pair(s) using db->del or dbcursor->c_del.
98 * @param dbi index database handle
99 * @param dbcursor database cursor (NULL will use db->del)
100 * @param key delete key value/length/flags
101 * @param data delete data value/length/flags
102 * @param flags (unused)
103 * @return 0 on success
105 int (*cdel) (dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
109 * Retrieve (key,data) pair using db->get or dbcursor->c_get.
110 * @param dbi index database handle
111 * @param dbcursor database cursor (NULL will use db->get)
112 * @param key retrieve key value/length/flags
113 * @param data retrieve data value/length/flags
114 * @param flags (unused)
115 * @return 0 on success
117 int (*cget) (dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
121 * Store (key,data) pair using db->put or dbcursor->c_put.
122 * @param dbi index database handle
123 * @param dbcursor database cursor (NULL will use db->put)
124 * @param key store key value/length/flags
125 * @param data store data value/length/flags
126 * @param flags (unused)
127 * @return 0 on success
129 int (*cput) (dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
133 * Retrieve count of (possible) duplicate items using dbcursor->c_count.
134 * @param dbi index database handle
135 * @param dbcursor database cursor
136 * @param countp address of count
137 * @param flags (unused)
138 * @return 0 on success
140 int (*ccount) (dbiIndex dbi, DBC * dbcursor,
141 unsigned int * countp,
145 * Is database byte swapped?
146 * @param dbi index database handle
149 int (*byteswapped) (dbiIndex dbi);
152 * Save statistics in database handle.
153 * @param dbi index database handle
154 * @param flags retrieve statistics that don't require traversal?
155 * @return 0 on success
157 int (*stat) (dbiIndex dbi, unsigned int flags);
161 * Describes an index database (implemented on Berkeley db3 functionality).
164 char * dbi_file; /*!< file component of path */
166 char * dbi_tmpdir; /*!< temporary directory */
168 int dbi_ecflags; /*!< db_env_create flags */
169 int dbi_cflags; /*!< db_create flags */
170 int dbi_oeflags; /*!< common (db,dbenv}->open flags */
171 int dbi_eflags; /*!< dbenv->open flags */
172 int dbi_oflags; /*!< db->open flags */
173 int dbi_tflags; /*!< dbenv->txn_begin flags */
175 int dbi_type; /*!< db index type */
176 unsigned dbi_mode; /*!< mode to use on open */
177 int dbi_perms; /*!< file permission to use on open */
178 long dbi_shmkey; /*!< shared memory base key */
180 int dbi_verify_on_close;
181 int dbi_use_dbenv; /*!< use db environment? */
182 int dbi_permit_dups; /*!< permit duplicate entries? */
183 int dbi_no_fsync; /*!< no-op fsync for db */
184 int dbi_no_dbsync; /*!< don't call dbiSync */
185 int dbi_lockdbfd; /*!< do fcntl lock on db fd */
186 int dbi_temporary; /*!< non-persistent */
190 /* dbenv parameters */
192 /* XXX db-4.3.14 adds dbenv as 1st arg. */
193 void (*db_errcall) (void * dbenv, const char *db_errpfx, char *buffer);
199 /* mpool sub-system parameters */
200 int dbi_mmapsize; /*!< (10Mb) */
201 int dbi_cachesize; /*!< (128Kb) */
202 /* lock sub-system parameters */
203 unsigned int dbi_lk_max;
204 unsigned int dbi_lk_detect;
206 unsigned char * dbi_lk_conflicts;
207 /* log sub-system parameters */
208 unsigned int dbi_lg_max;
209 unsigned int dbi_lg_bsize;
210 /* transaction sub-system parameters */
211 unsigned int dbi_tx_max;
213 int (*dbi_tx_recover) (DB_ENV *dbenv, DBT *log_rec,
214 DB_LSN *lsnp, int redo, void *info);
216 /* dbinfo parameters */
217 int dbi_pagesize; /*!< (fs blksize) */
218 void * (*dbi_malloc) (size_t nbytes);
219 /* hash access parameters */
220 unsigned int dbi_h_ffactor; /*!< */
221 unsigned int (*dbi_h_hash_fcn) (DB *, const void *bytes,
222 unsigned int length);
223 unsigned int dbi_h_nelem; /*!< */
224 unsigned int dbi_h_flags; /*!< DB_DUP, DB_DUPSORT */
225 int (*dbi_h_dup_compare_fcn) (DB *, const DBT *, const DBT *);
226 /* btree access parameters */
229 int (*dbi_bt_compare_fcn) (DB *, const DBT *, const DBT *);
230 int (*dbi_bt_dup_compare_fcn) (DB *, const DBT *, const DBT *);
231 size_t (*dbi_bt_prefix_fcn) (DB *, const DBT *, const DBT *);
232 /* recno access parameters */
235 unsigned int dbi_re_len;
237 char * dbi_re_source;
238 /* queue access parameters */
239 unsigned int dbi_q_extentsize;
241 rpmdb dbi_rpmdb; /*!< the parent rpm database */
242 rpmTag dbi_rpmtag; /*!< rpm tag used for index */
243 int dbi_jlen; /*!< size of join key */
245 DB * dbi_db; /*!< Berkeley DB * handle */
246 DB_TXN * dbi_txnid; /*!< Bekerley DB_TXN * transaction id */
247 void * dbi_stats; /*!< Berkeley db statistics */
249 const struct _dbiVec * dbi_vec; /*!< private methods */
254 * Describes the collection of index databases used by rpm.
257 char * db_root;/*!< path prefix */
258 char * db_home;/*!< directory path */
259 char * db_fullpath; /*!< full db path including prefix */
261 int db_mode; /*!< open mode */
262 int db_perms; /*!< open permissions */
263 int db_api; /*!< Berkeley API type */
266 int db_chrootDone; /*!< If chroot(2) done, ignore db_root. */
267 int db_mkdirDone; /*!< Has db_home been created? */
268 void (*db_errcall) (const char *db_errpfx, char *buffer);
270 void * (*db_malloc) (size_t nbytes);
271 void * (*db_realloc) (void * ptr,
273 void (*db_free) (void * ptr);
274 unsigned char * db_bits; /*!< package instance bit mask. */
275 int db_nbits; /*!< no. of bits in mask. */
278 void * db_dbenv; /*!< Berkeley DB_ENV handle. */
279 int db_ndbi; /*!< No. of tag indices. */
280 dbiIndex * _dbi; /*!< Tag indices. */
282 struct rpmop_s db_getops;
283 struct rpmop_s db_putops;
284 struct rpmop_s db_delops;
286 int nrefs; /*!< Reference count. */
289 /* for RPM's internal use only */
294 RPMDB_FLAG_JUSTCHECK = (1 << 0),
295 RPMDB_FLAG_MINIMAL = (1 << 1),
296 RPMDB_FLAG_CHROOT = (1 << 2)
304 * Return new configured index database handle instance.
305 * @param rpmdb rpm database
306 * @param rpmtag rpm tag
307 * @return index database handle
310 dbiIndex db3New(rpmdb rpmdb, rpmTag rpmtag);
313 * Destroy index database handle instance.
314 * @param dbi index database handle
315 * @return NULL always
318 dbiIndex db3Free( dbiIndex dbi);
321 * Format db3 open flags for debugging print.
322 * @param dbflags db open flags
323 * @param print_dbenv_flags format db env flags instead?
324 * @return formatted flags (malloced)
327 char * prDbiOpenFlags(int dbflags, int print_dbenv_flags);
330 * Return handle for an index database.
331 * @param db rpm database
332 * @param rpmtag rpm tag
333 * @param flags (unused)
334 * @return index database handle
337 dbiIndex dbiOpen(rpmdb db, rpmTag rpmtag,
340 /* FIX: vector annotations */
342 * Open a database cursor.
343 * @param dbi index database handle
344 * @param txnid database transaction handle
345 * @retval dbcp returned database cursor
346 * @param flags DB_WRITECURSOR if writing, or 0
347 * @return 0 on success
350 int dbiCopen(dbiIndex dbi, DB_TXN * txnid,
351 DBC ** dbcp, unsigned int flags)
353 return (*dbi->dbi_vec->copen) (dbi, txnid, dbcp, flags);
357 * Close a database cursor.
358 * @param dbi index database handle
359 * @param dbcursor database cursor
360 * @param flags (unused)
361 * @return 0 on success
364 int dbiCclose(dbiIndex dbi, DBC * dbcursor, unsigned int flags)
366 return (*dbi->dbi_vec->cclose) (dbi, dbcursor, flags);
370 * Delete (key,data) pair(s) from index database.
371 * @param dbi index database handle
372 * @param dbcursor database cursor (NULL will use db->del)
373 * @param key delete key value/length/flags
374 * @param data delete data value/length/flags
375 * @param flags (unused)
376 * @return 0 on success
379 int dbiDel(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
383 assert(key->data != NULL && key->size > 0);
384 (void) rpmswEnter(&dbi->dbi_rpmdb->db_delops, 0);
385 rc = (dbi->dbi_vec->cdel) (dbi, dbcursor, key, data, flags);
386 (void) rpmswExit(&dbi->dbi_rpmdb->db_delops, data->size);
391 * Retrieve (key,data) pair from index database.
392 * @param dbi index database handle
393 * @param dbcursor database cursor (NULL will use db->get)
394 * @param key retrieve key value/length/flags
395 * @param data retrieve data value/length/flags
396 * @param flags (unused)
397 * @return 0 on success
400 int dbiGet(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
404 * Store (key,data) pair in index database.
405 * @param dbi index database handle
406 * @param dbcursor database cursor (NULL will use db->put)
407 * @param key store key value/length/flags
408 * @param data store data value/length/flags
409 * @param flags (unused)
410 * @return 0 on success
413 int dbiPut(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
417 * Retrieve count of (possible) duplicate items.
418 * @param dbi index database handle
419 * @param dbcursor database cursor
420 * @param countp address of count
421 * @param flags (unused)
422 * @return 0 on success
425 int dbiCount(dbiIndex dbi, DBC * dbcursor, unsigned int * countp,
428 return (*dbi->dbi_vec->ccount) (dbi, dbcursor, countp, flags);
432 * Verify (and close) index database.
433 * @param dbi index database handle
434 * @param flags (unused)
435 * @return 0 on success
438 int dbiVerify(dbiIndex dbi, unsigned int flags)
440 dbi->dbi_verify_on_close = 1;
441 return (*dbi->dbi_vec->close) (dbi, flags);
445 * Close index database.
446 * @param dbi index database handle
447 * @param flags (unused)
448 * @return 0 on success
451 int dbiClose(dbiIndex dbi, unsigned int flags)
453 return (*dbi->dbi_vec->close) (dbi, flags);
457 * Flush pending operations to disk.
458 * @param dbi index database handle
459 * @param flags (unused)
460 * @return 0 on success
463 int dbiSync (dbiIndex dbi, unsigned int flags)
465 return (*dbi->dbi_vec->sync) (dbi, flags);
469 * Is database byte swapped?
470 * @param dbi index database handle
471 * @return 0 same order, 1 swapped order
474 int dbiByteSwapped(dbiIndex dbi)
476 if (dbi->dbi_byteswapped == -1)
477 dbi->dbi_byteswapped = (*dbi->dbi_vec->byteswapped) (dbi);
478 return dbi->dbi_byteswapped;
481 * Is database byte swapped?
482 * @param dbi index database handle
483 * @param flags DB_FAST_STAT or 0
484 * @return 0 on success
487 int dbiStat(dbiIndex dbi, unsigned int flags)
489 return (*dbi->dbi_vec->stat) (dbi, flags);
494 * Destroy set of index database items.
495 * @param set set of index database items
496 * @return NULL always
499 dbiIndexSet dbiFreeIndexSet(dbiIndexSet set);
502 * Count items in index database set.
503 * @param set set of index database items
504 * @return number of items
507 unsigned int dbiIndexSetCount(dbiIndexSet set);
510 * Return record offset of header from element in index database set.
511 * @param set set of index database items
512 * @param recno index of item in set
513 * @return record offset of header
516 unsigned int dbiIndexRecordOffset(dbiIndexSet set, int recno);
519 * Return file index from element in index database set.
520 * @param set set of index database items
521 * @param recno index of item in set
525 unsigned int dbiIndexRecordFileNumber(dbiIndexSet set, int recno);
528 * Return rpmdb home directory (depending on chroot state)
529 * param db rpmdb handle
530 * return db home directory (or NULL on error)
533 const char *rpmdbHome(rpmdb db);
536 * Return database iterator.
537 * @param mi rpm database iterator
538 * @param keyp key data (NULL for sequential access)
539 * @param keylen key data length (0 will use strlen(keyp))
540 * @return 0 on success
542 int rpmdbExtendIterator(rpmdbMatchIterator mi,
543 const void * keyp, size_t keylen);
546 * sort the iterator by (recnum, filenum)
547 * Return database iterator.
548 * @param mi rpm database iterator
550 void rpmdbSortIterator(rpmdbMatchIterator mi);
554 * * Mergesort, same arguments as qsort(2).
557 int mergesort(void *base, size_t nmemb, size_t size,
558 int (*cmp) (const void *, const void *));
560 /* mergesort is defined in stdlib.h on Mac OS X */
561 #endif /* __APPLE__ */