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 */
33 unsigned int fpNum; /*!< finger print index */
37 * Items retrieved from the index database.
40 struct _dbiIndexItem * recs; /*!< array of records */
41 int count; /*!< number of records */
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 * Associate secondary database with primary.
78 * @param dbi index database handle
79 * @param dbisecondary secondary index database handle
80 * @param callback create secondary key from primary (NULL if DB_RDONLY)
81 * @param flags DB_CREATE or 0
82 * @return 0 on success
84 int (*associate) (dbiIndex dbi, dbiIndex dbisecondary,
85 int (*callback) (DB *, const DBT *, const DBT *, DBT *),
89 * Return join cursor for list of cursors.
90 * @param dbi index database handle
91 * @param curslist NULL terminated list of database cursors
92 * @retval dbcp address of join database cursor
93 * @param flags DB_JOIN_NOSORT or 0
94 * @return 0 on success
96 int (*join) (dbiIndex dbi, DBC ** curslist, DBC ** dbcp,
100 * Open database cursor.
101 * @param dbi index database handle
102 * @param txnid database transaction handle
103 * @retval dbcp address of new database cursor
104 * @param dbiflags DB_WRITECURSOR or 0
105 * @return 0 on success
107 int (*copen) (dbiIndex dbi, DB_TXN * txnid,
108 DBC ** dbcp, unsigned int dbiflags);
111 * Close database cursor.
112 * @param dbi index database handle
113 * @param dbcursor database cursor
114 * @param flags (unused)
115 * @return 0 on success
117 int (*cclose) (dbiIndex dbi, DBC * dbcursor, unsigned int flags);
120 * Duplicate a database cursor.
121 * @param dbi index database handle
122 * @param dbcursor database cursor
123 * @retval dbcp address of new database cursor
124 * @param flags DB_POSITION for same position, 0 for uninitialized
125 * @return 0 on success
127 int (*cdup) (dbiIndex dbi, DBC * dbcursor, DBC ** dbcp,
131 * Delete (key,data) pair(s) using db->del or dbcursor->c_del.
132 * @param dbi index database handle
133 * @param dbcursor database cursor (NULL will use db->del)
134 * @param key delete key value/length/flags
135 * @param data delete data value/length/flags
136 * @param flags (unused)
137 * @return 0 on success
139 int (*cdel) (dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
143 * Retrieve (key,data) pair using db->get or dbcursor->c_get.
144 * @param dbi index database handle
145 * @param dbcursor database cursor (NULL will use db->get)
146 * @param key retrieve key value/length/flags
147 * @param data retrieve data value/length/flags
148 * @param flags (unused)
149 * @return 0 on success
151 int (*cget) (dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
155 * Retrieve (key,data) pair using dbcursor->c_pget.
156 * @param dbi index database handle
157 * @param dbcursor database cursor
158 * @param key secondary retrieve key value/length/flags
159 * @param pkey primary retrieve key value/length/flags
160 * @param data primary retrieve data value/length/flags
161 * @param flags DB_NEXT, DB_SET, or 0
162 * @return 0 on success
164 int (*cpget) (dbiIndex dbi, DBC * dbcursor,
165 DBT * key, DBT * pkey, DBT * data, unsigned int flags);
168 * Store (key,data) pair using db->put or dbcursor->c_put.
169 * @param dbi index database handle
170 * @param dbcursor database cursor (NULL will use db->put)
171 * @param key store key value/length/flags
172 * @param data store data value/length/flags
173 * @param flags (unused)
174 * @return 0 on success
176 int (*cput) (dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
180 * Retrieve count of (possible) duplicate items using dbcursor->c_count.
181 * @param dbi index database handle
182 * @param dbcursor database cursor
183 * @param countp address of count
184 * @param flags (unused)
185 * @return 0 on success
187 int (*ccount) (dbiIndex dbi, DBC * dbcursor,
188 unsigned int * countp,
192 * Is database byte swapped?
193 * @param dbi index database handle
196 int (*byteswapped) (dbiIndex dbi);
199 * Save statistics in database handle.
200 * @param dbi index database handle
201 * @param flags retrieve statistics that don't require traversal?
202 * @return 0 on success
204 int (*stat) (dbiIndex dbi, unsigned int flags);
208 * Describes an index database (implemented on Berkeley db3 functionality).
211 char * dbi_root; /*!< chroot(2) component of path */
212 char * dbi_home; /*!< directory component of path */
213 char * dbi_file; /*!< file component of path */
215 char * dbi_tmpdir; /*!< temporary directory */
217 int dbi_ecflags; /*!< db_env_create flags */
218 int dbi_cflags; /*!< db_create flags */
219 int dbi_oeflags; /*!< common (db,dbenv}->open flags */
220 int dbi_eflags; /*!< dbenv->open flags */
221 int dbi_oflags; /*!< db->open flags */
222 int dbi_tflags; /*!< dbenv->txn_begin flags */
224 int dbi_type; /*!< db index type */
225 unsigned dbi_mode; /*!< mode to use on open */
226 int dbi_perms; /*!< file permission to use on open */
227 long dbi_shmkey; /*!< shared memory base key */
228 int dbi_api; /*!< Berkeley API type */
230 int dbi_verify_on_close;
231 int dbi_use_dbenv; /*!< use db environment? */
232 int dbi_permit_dups; /*!< permit duplicate entries? */
233 int dbi_no_fsync; /*!< no-op fsync for db */
234 int dbi_no_dbsync; /*!< don't call dbiSync */
235 int dbi_lockdbfd; /*!< do fcntl lock on db fd */
236 int dbi_temporary; /*!< non-persistent */
241 unsigned long dbi_cl_timeout;
242 unsigned long dbi_sv_timeout;
244 /* dbenv parameters */
246 /* XXX db-4.3.14 adds dbenv as 1st arg. */
247 void (*db_errcall) (void * dbenv, const char *db_errpfx, char *buffer);
253 /* mpool sub-system parameters */
254 int dbi_mmapsize; /*!< (10Mb) */
255 int dbi_cachesize; /*!< (128Kb) */
256 /* lock sub-system parameters */
257 unsigned int dbi_lk_max;
258 unsigned int dbi_lk_detect;
260 unsigned char * dbi_lk_conflicts;
261 /* log sub-system parameters */
262 unsigned int dbi_lg_max;
263 unsigned int dbi_lg_bsize;
264 /* transaction sub-system parameters */
265 unsigned int dbi_tx_max;
267 int (*dbi_tx_recover) (DB_ENV *dbenv, DBT *log_rec,
268 DB_LSN *lsnp, int redo, void *info);
270 /* dbinfo parameters */
271 int dbi_pagesize; /*!< (fs blksize) */
272 void * (*dbi_malloc) (size_t nbytes);
273 /* hash access parameters */
274 unsigned int dbi_h_ffactor; /*!< */
275 unsigned int (*dbi_h_hash_fcn) (DB *, const void *bytes,
276 unsigned int length);
277 unsigned int dbi_h_nelem; /*!< */
278 unsigned int dbi_h_flags; /*!< DB_DUP, DB_DUPSORT */
279 int (*dbi_h_dup_compare_fcn) (DB *, const DBT *, const DBT *);
280 /* btree access parameters */
283 int (*dbi_bt_compare_fcn) (DB *, const DBT *, const DBT *);
284 int (*dbi_bt_dup_compare_fcn) (DB *, const DBT *, const DBT *);
285 size_t (*dbi_bt_prefix_fcn) (DB *, const DBT *, const DBT *);
286 /* recno access parameters */
289 unsigned int dbi_re_len;
291 char * dbi_re_source;
292 /* queue access parameters */
293 unsigned int dbi_q_extentsize;
295 rpmdb dbi_rpmdb; /*!< the parent rpm database */
296 rpmTag dbi_rpmtag; /*!< rpm tag used for index */
297 int dbi_jlen; /*!< size of join key */
299 DB * dbi_db; /*!< Berkeley DB * handle */
300 DB_TXN * dbi_txnid; /*!< Bekerley DB_TXN * transaction id */
301 void * dbi_stats; /*!< Berkeley db statistics */
303 const struct _dbiVec * dbi_vec; /*!< private methods */
308 * Describes the collection of index databases used by rpm.
311 char * db_root;/*!< path prefix */
312 char * db_home;/*!< directory path */
314 int db_mode; /*!< open mode */
315 int db_perms; /*!< open permissions */
316 int db_api; /*!< Berkeley API type */
320 int db_chrootDone; /*!< If chroot(2) done, ignore db_root. */
321 void (*db_errcall) (const char *db_errpfx, char *buffer);
323 void * (*db_malloc) (size_t nbytes);
324 void * (*db_realloc) (void * ptr,
326 void (*db_free) (void * ptr);
327 unsigned char * db_bits; /*!< package instance bit mask. */
328 int db_nbits; /*!< no. of bits in mask. */
331 void * db_dbenv; /*!< Berkeley DB_ENV handle. */
332 int db_ndbi; /*!< No. of tag indices. */
333 dbiIndex * _dbi; /*!< Tag indices. */
335 struct rpmop_s db_getops;
336 struct rpmop_s db_putops;
337 struct rpmop_s db_delops;
339 int nrefs; /*!< Reference count. */
342 /* for RPM's internal use only */
347 RPMDB_FLAG_JUSTCHECK = (1 << 0),
348 RPMDB_FLAG_MINIMAL = (1 << 1),
349 RPMDB_FLAG_CHROOT = (1 << 2)
357 * Return new configured index database handle instance.
358 * @param rpmdb rpm database
359 * @param rpmtag rpm tag
360 * @return index database handle
363 dbiIndex db3New(rpmdb rpmdb, rpmTag rpmtag);
366 * Destroy index database handle instance.
367 * @param dbi index database handle
368 * @return NULL always
371 dbiIndex db3Free( dbiIndex dbi);
374 * Format db3 open flags for debugging print.
375 * @param dbflags db open flags
376 * @param print_dbenv_flags format db env flags instead?
377 * @return formatted flags (malloced)
380 char * prDbiOpenFlags(int dbflags, int print_dbenv_flags);
383 * Return handle for an index database.
384 * @param db rpm database
385 * @param rpmtag rpm tag
386 * @param flags (unused)
387 * @return index database handle
390 dbiIndex dbiOpen(rpmdb db, rpmTag rpmtag,
393 /* FIX: vector annotations */
395 * Open a database cursor.
396 * @param dbi index database handle
397 * @param txnid database transaction handle
398 * @retval dbcp returned database cursor
399 * @param flags DB_WRITECURSOR if writing, or 0
400 * @return 0 on success
403 int dbiCopen(dbiIndex dbi, DB_TXN * txnid,
404 DBC ** dbcp, unsigned int flags)
406 return (*dbi->dbi_vec->copen) (dbi, txnid, dbcp, flags);
410 * Close a database cursor.
411 * @param dbi index database handle
412 * @param dbcursor database cursor
413 * @param flags (unused)
414 * @return 0 on success
417 int dbiCclose(dbiIndex dbi, DBC * dbcursor, unsigned int flags)
419 return (*dbi->dbi_vec->cclose) (dbi, dbcursor, flags);
423 * Duplicate a database cursor.
424 * @param dbi index database handle
425 * @param dbcursor database cursor
426 * @retval dbcp address of new database cursor
427 * @param flags DB_POSITION for same position, 0 for uninitialized
428 * @return 0 on success
431 int dbiCdup(dbiIndex dbi, DBC * dbcursor, DBC ** dbcp,
434 return (*dbi->dbi_vec->cdup) (dbi, dbcursor, dbcp, flags);
438 * Delete (key,data) pair(s) from index database.
439 * @param dbi index database handle
440 * @param dbcursor database cursor (NULL will use db->del)
441 * @param key delete key value/length/flags
442 * @param data delete data value/length/flags
443 * @param flags (unused)
444 * @return 0 on success
447 int dbiDel(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
451 assert(key->data != NULL && key->size > 0);
452 (void) rpmswEnter(&dbi->dbi_rpmdb->db_delops, 0);
453 rc = (dbi->dbi_vec->cdel) (dbi, dbcursor, key, data, flags);
454 (void) rpmswExit(&dbi->dbi_rpmdb->db_delops, data->size);
459 * Retrieve (key,data) pair from index database.
460 * @param dbi index database handle
461 * @param dbcursor database cursor (NULL will use db->get)
462 * @param key retrieve key value/length/flags
463 * @param data retrieve data value/length/flags
464 * @param flags (unused)
465 * @return 0 on success
468 int dbiGet(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
472 assert((flags == DB_NEXT) || (key->data != NULL && key->size > 0));
473 (void) rpmswEnter(&dbi->dbi_rpmdb->db_getops, 0);
474 rc = (dbi->dbi_vec->cget) (dbi, dbcursor, key, data, flags);
475 (void) rpmswExit(&dbi->dbi_rpmdb->db_getops, data->size);
480 * Retrieve (key,data) pair using dbcursor->c_pget.
481 * @param dbi index database handle
482 * @param dbcursor database cursor (NULL will use db->get)
483 * @param key secondary retrieve key value/length/flags
484 * @param pkey primary retrieve key value/length/flags
485 * @param data primary retrieve data value/length/flags
486 * @param flags DB_NEXT, DB_SET, or 0
487 * @return 0 on success
490 int dbiPget(dbiIndex dbi, DBC * dbcursor,
491 DBT * key, DBT * pkey, DBT * data, unsigned int flags)
494 assert((flags == DB_NEXT) || (key->data != NULL && key->size > 0));
495 (void) rpmswEnter(&dbi->dbi_rpmdb->db_getops, 0);
496 rc = (dbi->dbi_vec->cpget) (dbi, dbcursor, key, pkey, data, flags);
497 (void) rpmswExit(&dbi->dbi_rpmdb->db_getops, (ssize_t) data->size);
502 * Store (key,data) pair in index database.
503 * @param dbi index database handle
504 * @param dbcursor database cursor (NULL will use db->put)
505 * @param key store key value/length/flags
506 * @param data store data value/length/flags
507 * @param flags (unused)
508 * @return 0 on success
511 int dbiPut(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
515 assert(key->data != NULL && key->size > 0 && data->data != NULL && data->size > 0);
516 (void) rpmswEnter(&dbi->dbi_rpmdb->db_putops, (ssize_t) 0);
517 rc = (dbi->dbi_vec->cput) (dbi, dbcursor, key, data, flags);
518 (void) rpmswExit(&dbi->dbi_rpmdb->db_putops, (ssize_t) data->size);
523 * Retrieve count of (possible) duplicate items.
524 * @param dbi index database handle
525 * @param dbcursor database cursor
526 * @param countp address of count
527 * @param flags (unused)
528 * @return 0 on success
531 int dbiCount(dbiIndex dbi, DBC * dbcursor, unsigned int * countp,
534 return (*dbi->dbi_vec->ccount) (dbi, dbcursor, countp, flags);
538 * Verify (and close) index database.
539 * @param dbi index database handle
540 * @param flags (unused)
541 * @return 0 on success
544 int dbiVerify(dbiIndex dbi, unsigned int flags)
546 dbi->dbi_verify_on_close = 1;
547 return (*dbi->dbi_vec->close) (dbi, flags);
551 * Close index database.
552 * @param dbi index database handle
553 * @param flags (unused)
554 * @return 0 on success
557 int dbiClose(dbiIndex dbi, unsigned int flags)
559 return (*dbi->dbi_vec->close) (dbi, flags);
563 * Flush pending operations to disk.
564 * @param dbi index database handle
565 * @param flags (unused)
566 * @return 0 on success
569 int dbiSync (dbiIndex dbi, unsigned int flags)
571 return (*dbi->dbi_vec->sync) (dbi, flags);
575 * Associate secondary database with primary.
576 * @param dbi index database handle
577 * @param dbisecondary secondary index database handle
578 * @param callback create secondary key from primary (NULL if DB_RDONLY)
579 * @param flags DB_CREATE or 0
580 * @return 0 on success
583 int dbiAssociate(dbiIndex dbi, dbiIndex dbisecondary,
584 int (*callback) (DB *, const DBT *, const DBT *, DBT *),
587 return (*dbi->dbi_vec->associate) (dbi, dbisecondary, callback, flags);
591 * Return join cursor for list of cursors.
592 * @param dbi index database handle
593 * @param curslist NULL terminated list of database cursors
594 * @retval dbcp address of join database cursor
595 * @param flags DB_JOIN_NOSORT or 0
596 * @return 0 on success
599 int dbiJoin(dbiIndex dbi, DBC ** curslist, DBC ** dbcp,
602 return (*dbi->dbi_vec->join) (dbi, curslist, dbcp, flags);
606 * Is database byte swapped?
607 * @param dbi index database handle
608 * @return 0 same order, 1 swapped order
611 int dbiByteSwapped(dbiIndex dbi)
613 if (dbi->dbi_byteswapped == -1)
614 dbi->dbi_byteswapped = (*dbi->dbi_vec->byteswapped) (dbi);
615 return dbi->dbi_byteswapped;
618 * Is database byte swapped?
619 * @param dbi index database handle
620 * @param flags DB_FAST_STAT or 0
621 * @return 0 on success
624 int dbiStat(dbiIndex dbi, unsigned int flags)
626 return (*dbi->dbi_vec->stat) (dbi, flags);
631 * Destroy set of index database items.
632 * @param set set of index database items
633 * @return NULL always
636 dbiIndexSet dbiFreeIndexSet(dbiIndexSet set);
639 * Count items in index database set.
640 * @param set set of index database items
641 * @return number of items
644 unsigned int dbiIndexSetCount(dbiIndexSet set);
647 * Return record offset of header from element in index database set.
648 * @param set set of index database items
649 * @param recno index of item in set
650 * @return record offset of header
653 unsigned int dbiIndexRecordOffset(dbiIndexSet set, int recno);
656 * Return file index from element in index database set.
657 * @param set set of index database items
658 * @param recno index of item in set
662 unsigned int dbiIndexRecordFileNumber(dbiIndexSet set, int recno);
666 * * Mergesort, same arguments as qsort(2).
669 int mergesort(void *base, size_t nmemb, size_t size,
670 int (*cmp) (const void *, const void *));
672 /* mergesort is defined in stdlib.h on Mac OS X */
673 #endif /* __APPLE__ */