4 /** \ingroup rpmdb dbi db1 db3
6 * Access RPM indices using Berkeley DB interface(s).
13 typedef /*@abstract@*/ struct _dbiIndexItem * dbiIndexItem;
14 typedef /*@abstract@*/ struct _dbiIndex * dbiIndex;
16 /* this will break if sizeof(int) != 4 */
18 * A single item from an index database (i.e. the "data returned").
19 * Note: In rpm-3.0.4 and earlier, this structure was passed by value,
20 * and was identical to the "data saved" structure below.
22 struct _dbiIndexItem {
23 unsigned int hdrNum; /*!< header instance in db */
24 unsigned int tagNum; /*!< tag index in header */
25 unsigned int fpNum; /*!< finger print index */
26 unsigned int dbNum; /*!< database index */
30 * A single item in an index database (i.e. the "data saved").
33 unsigned int recOffset; /*!< byte offset of header in db */
34 unsigned int fileNumber; /*!< file array index */
36 typedef struct _dbiIR * DBIR_t;
39 * Items retrieved from the index database.
42 /*@owned@*/ struct _dbiIndexItem * recs; /*!< array of records */
43 int count; /*!< number of records */
46 /* XXX hack to get prototypes correct */
47 #if !defined(DB_VERSION_MAJOR)
55 * Private methods for accessing an index database.
58 int dbv_major; /*!< Berkeley db version major */
59 int dbv_minor; /*!< Berkeley db version minor */
60 int dbv_patch; /*!< Berkeley db version patch */
63 * Return handle for an index database.
64 * @param rpmdb rpm database
65 * @param rpmtag rpm tag
66 * @return 0 on success
68 int (*open) (rpmdb rpmdb, int rpmtag, /*@out@*/ dbiIndex * dbip);
71 * Close index database.
72 * @param dbi index database handle
73 * @param flags (unused)
74 * @return 0 on success
76 int (*close) (/*@only@*/ dbiIndex dbi, unsigned int flags);
79 * Flush pending operations to disk.
80 * @param dbi index database handle
81 * @param flags (unused)
82 * @return 0 on success
84 int (*sync) (dbiIndex dbi, unsigned int flags);
87 * Open database cursor.
88 * @param dbi index database handle
89 * @param dbcp address of database cursor
90 * @param flags (unused)
92 int (*copen) (dbiIndex dbi, /*@out@*/ DBC ** dbcp, unsigned int flags);
95 * Close database cursor.
96 * @param dbi index database handle
97 * @param dbcursor database cursor
98 * @param flags (unused)
100 int (*cclose) (dbiIndex dbi, /*@only@*/ DBC * dbcursor, unsigned int flags);
103 * Delete (key,data) pair(s) using db->del or dbcursor->c_del.
104 * @param dbi index database handle
105 * @param dbcursor database cursor
106 * @param keyp key data
107 * @param keylen key data length
108 * @param flags (unused)
109 * @return 0 on success
111 int (*cdel) (dbiIndex dbi, DBC * dbcursor, const void * keyp, size_t keylen, unsigned int flags);
114 * Retrieve (key,data) pair using db->get or dbcursor->c_get.
115 * @param dbi index database handle
116 * @param dbcursor database cursor
117 * @param keypp address of key data
118 * @param keylenp address of key data length
119 * @param datapp address of data pointer
120 * @param datalenp address of data length
121 * @param flags (unused)
122 * @return 0 on success
124 int (*cget) (dbiIndex dbi, DBC * dbcursor,
125 /*@out@*/ void ** keypp, /*@out@*/ size_t * keylenp,
126 /*@out@*/ void ** datapp, /*@out@*/ size_t * datalenp,
130 * Store (key,data) pair using db->put or dbcursor->c_put.
131 * @param dbi index database handle
132 * @param dbcursor database cursor
133 * @param keyp key data
134 * @param keylen key data length
135 * @param datap data pointer
136 * @param datalen data length
137 * @param flags (unused)
138 * @return 0 on success
140 int (*cput) (dbiIndex dbi, DBC * dbcursor,
141 const void * keyp, size_t keylen,
142 const void * datap, size_t datalen,
146 * Is database byte swapped?
147 * @param dbi index database handle
150 int (*byteswapped) (dbiIndex dbi);
155 * Describes an index database (implemented on Berkeley db[123] API).
158 /*@null@*/ const char * dbi_root;
159 /*@null@*/ const char * dbi_home;
160 /*@null@*/ const char * dbi_file;
161 /*@null@*/ const char * dbi_subfile;
163 int dbi_cflags; /*!< db_create/db_env_create flags */
164 int dbi_oeflags; /*!< common (db,dbenv}->open flags */
165 int dbi_eflags; /*!< dbenv->open flags */
166 int dbi_oflags; /*!< db->open flags */
167 int dbi_tflags; /*!< dbenv->txn_begin flags */
169 int dbi_type; /*!< db index type */
170 unsigned dbi_mode; /*!< mode to use on open */
171 int dbi_perms; /*!< file permission to use on open */
172 int dbi_api; /*!< Berkeley API type */
177 int dbi_get_rmw_cursor;
178 int dbi_no_fsync; /*!< no-op fsync for db */
179 int dbi_no_dbsync; /*!< don't call dbiSync */
180 int dbi_lockdbfd; /*!< do fcntl lock on db fd */
181 int dbi_temporary; /*!< non-persistent */
184 /* dbenv parameters */
186 /*@null@*/ void (*db_errcall) (const char *db_errpfx, char *buffer);
187 /*@shared@*/ FILE * dbi_errfile;
188 const char * dbi_errpfx;
192 /* mpool sub-system parameters */
193 int dbi_mp_mmapsize; /*!< (10Mb) */
194 int dbi_mp_size; /*!< (128Kb) */
195 /* lock sub-system parameters */
196 unsigned int dbi_lk_max;
197 unsigned int dbi_lk_detect;
199 unsigned char *dbi_lk_conflicts;
200 /* log sub-system parameters */
201 unsigned int dbi_lg_max;
202 unsigned int dbi_lg_bsize;
203 /* transaction sub-system parameters */
204 unsigned int dbi_tx_max;
206 int (*dbi_tx_recover) (DB_ENV *dbenv, DBT *log_rec, DB_LSN *lsnp, int redo, void *info);
208 /* dbinfo parameters */
209 int dbi_cachesize; /*!< */
210 int dbi_pagesize; /*!< (fs blksize) */
211 /*@null@*/ void * (*dbi_malloc) (size_t nbytes);
212 /* hash access parameters */
213 unsigned int dbi_h_ffactor; /*!< */
214 /*@null@*/ unsigned int (*dbi_h_hash_fcn) (const void *bytes, unsigned int length);
215 unsigned int dbi_h_nelem; /*!< */
216 unsigned int dbi_h_flags; /*!< DB_DUP, DB_DUPSORT */
217 /*@null@*/ int (*dbi_h_dup_compare_fcn) (const DBT *, const DBT *);
218 /* btree access parameters */
221 /*@null@*/ int (*dbi_bt_compare_fcn)(const DBT *, const DBT *);
222 /*@null@*/ int (*dbi_bt_dup_compare_fcn) (const DBT *, const DBT *);
223 /*@null@*/ size_t (*dbi_bt_prefix_fcn) (const DBT *, const DBT *);
224 /* recno access parameters */
227 unsigned int dbi_re_len;
229 const char * dbi_re_source;
231 /*@kept@*/ rpmdb dbi_rpmdb;
232 int dbi_rpmtag; /*!< rpm tag used for index */
233 int dbi_jlen; /*!< size of join key */
235 unsigned int dbi_lastoffset; /*!< db1 with falloc.c needs this */
237 /*@only@*//*@null@*/ void * dbi_db; /*!< dbi handle */
238 /*@only@*//*@null@*/ void * dbi_dbenv;
239 /*@only@*//*@null@*/ void * dbi_dbinfo;
240 /*@only@*//*@null@*/ void * dbi_rmw; /*!< db cursor (with DB_WRITECURSOR) */
242 /*@observer@*/ const struct _dbiVec * dbi_vec; /*!< private methods */
247 * Describes the collection of index databases used by rpm.
250 /*@owned@*/ const char *db_root; /*!< path prefix */
251 /*@owned@*/ const char *db_home; /*!< directory path */
253 int db_mode; /*!< open mode */
254 int db_perms; /*!< open permissions */
255 int db_api; /*!< Berkeley API type */
258 /*@owned@*/ const char *db_errpfx;
259 void (*db_errcall) (const char *db_errpfx, char *buffer);
260 /*@shared@*/ FILE * db_errfile;
261 /*@observer@*/ void * (*db_malloc) (size_t nbytes);
266 /* for RPM's internal use only */
271 RPMDB_FLAG_JUSTCHECK = (1 << 0),
272 RPMDB_FLAG_MINIMAL = (1 << 1),
273 RPMDB_FLAG_CHROOT = (1 << 2)
282 * Return new configured index database handle instance.
283 * @param rpmdb rpm database
285 /*@only@*/ /*@null@*/ dbiIndex db3New(/*@keep@*/ rpmdb rpmdb, int rpmtag);
288 * Destroy index database handle instance.
289 * @param dbi index database handle
291 void db3Free( /*@only@*/ /*@null@*/ dbiIndex dbi);
294 * Format db3 open flags for debugging print.
295 * @param dbflags db open flags
296 * @param print_dbenv_flags format db env flags instead?
297 * @return formatted flags (static buffer)
299 /*@exposed@*/ extern const char *const prDbiOpenFlags(int dbflags,
300 int print_dbenv_flags);
303 * Return handle for an index database.
304 * @param rpmdb rpm database
305 * @param rpmtag rpm tag
306 * @param flags (unused)
307 * @return index database handle
309 /*@only@*/ /*@null@*/ dbiIndex dbiOpen(/*@null@*/ rpmdb rpmdb, int rpmtag,
313 * @param dbi index database handle
314 * @param flags (unused)
316 int dbiCopen(dbiIndex dbi, /*@out@*/ DBC ** dbcp, unsigned int flags);
317 int XdbiCopen(dbiIndex dbi, /*@out@*/ DBC ** dbcp, unsigned int flags, const char *f, unsigned int l);
318 #define dbiCopen(_a,_b,_c) \
319 XdbiCopen(_a, _b, _c, __FILE__, __LINE__)
322 * @param dbi index database handle
323 * @param flags (unused)
325 int dbiCclose(dbiIndex dbi, /*@only@*/ DBC * dbcursor, unsigned int flags);
326 int XdbiCclose(dbiIndex dbi, /*@only@*/ DBC * dbcursor, unsigned int flags, const char *f, unsigned int l);
327 #define dbiCclose(_a,_b,_c) \
328 XdbiCclose(_a, _b, _c, __FILE__, __LINE__)
331 * Delete (key,data) pair(s) from index database.
332 * @param dbi index database handle
333 * @param keyp key data
334 * @param keylen key data length
335 * @param flags (unused)
336 * @return 0 on success
338 int dbiDel(dbiIndex dbi, DBC * dbcursor, const void * keyp, size_t keylen,
342 * Retrieve (key,data) pair from index database.
343 * @param dbi index database handle
344 * @param keypp address of key data
345 * @param keylenp address of key data length
346 * @param datapp address of data pointer
347 * @param datalenp address of data length
348 * @param flags (unused)
349 * @return 0 on success
351 int dbiGet(dbiIndex dbi, DBC * dbcursor, void ** keypp, size_t * keylenp,
352 void ** datapp, size_t * datalenp, unsigned int flags);
355 * Store (key,data) pair in index database.
356 * @param dbi index database handle
357 * @param keyp key data
358 * @param keylen key data length
359 * @param datap data pointer
360 * @param datalen data length
361 * @param flags (unused)
362 * @return 0 on success
364 int dbiPut(dbiIndex dbi, DBC * dbcursor, const void * keyp, size_t keylen,
365 const void * datap, size_t datalen, unsigned int flags);
368 * Close index database.
369 * @param dbi index database handle
370 * @param flags (unused)
371 * @return 0 on success
373 int dbiClose(/*@only@*/ dbiIndex dbi, unsigned int flags);
376 * Flush pending operations to disk.
377 * @param dbi index database handle
378 * @param flags (unused)
379 * @return 0 on success
381 int dbiSync (dbiIndex dbi, unsigned int flags);
384 * Is database byte swapped?
385 * @param dbi index database handle
388 int dbiByteSwapped(dbiIndex dbi);
391 * Return base file name for db1 database (legacy).
392 * @param rpmtag rpm tag
393 * @return base file name of db1 database
395 char * db1basename(int rpmtag);
400 unsigned int rpmdbGetIteratorFileNum(rpmdbMatchIterator mi);
403 * @param rpmdb rpm database
405 int rpmdbFindFpList(/*@null@*/ rpmdb rpmdb, fingerPrint * fpList,
406 /*@out@*/dbiIndexSet * matchList, int numItems);
409 * Destroy set of index database items.
410 * @param set set of index database items
412 void dbiFreeIndexSet(/*@only@*/ /*@null@*/ dbiIndexSet set);
415 * Count items in index database set.
416 * @param set set of index database items
417 * @return number of items
419 unsigned int dbiIndexSetCount(dbiIndexSet set);
422 * Return record offset of header from element in index database set.
423 * @param set set of index database items
424 * @param recno index of item in set
425 * @return record offset of header
427 unsigned int dbiIndexRecordOffset(dbiIndexSet set, int recno);
430 * Return file index from element in index database set.
431 * @param set set of index database items
432 * @param recno index of item in set
435 unsigned int dbiIndexRecordFileNumber(dbiIndexSet set, int recno);