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 int dbi_ecflags; /*!< db_env_create flags */
51 int dbi_cflags; /*!< db_create flags */
52 int dbi_oeflags; /*!< common (db,dbenv}->open flags */
53 int dbi_eflags; /*!< dbenv->open flags */
54 int dbi_oflags; /*!< db->open flags */
55 int dbi_tflags; /*!< dbenv->txn_begin flags */
57 int dbi_type; /*!< db index type */
58 unsigned dbi_mode; /*!< mode to use on open */
59 int dbi_perms; /*!< file permission to use on open */
61 int dbi_verify_on_close;
62 int dbi_use_dbenv; /*!< use db environment? */
63 int dbi_permit_dups; /*!< permit duplicate entries? */
64 int dbi_no_fsync; /*!< no-op fsync for db */
65 int dbi_no_dbsync; /*!< don't call dbiSync */
66 int dbi_lockdbfd; /*!< do fcntl lock on db fd */
69 /* dbenv parameters */
71 /* XXX db-4.3.14 adds dbenv as 1st arg. */
73 /* mpool sub-system parameters */
74 int dbi_mmapsize; /*!< (10Mb) */
75 int dbi_cachesize; /*!< (128Kb) */
76 /* dbinfo parameters */
77 int dbi_pagesize; /*!< (fs blksize) */
79 rpmdb dbi_rpmdb; /*!< the parent rpm database */
80 rpmTag dbi_rpmtag; /*!< rpm tag used for index */
81 int dbi_jlen; /*!< size of join key */
83 DB * dbi_db; /*!< Berkeley DB * handle */
84 DB_TXN * dbi_txnid; /*!< Bekerley DB_TXN * transaction id */
85 void * dbi_stats; /*!< Berkeley db statistics */
89 * Describes the collection of index databases used by rpm.
92 char * db_root;/*!< path prefix */
93 char * db_home;/*!< directory path */
94 char * db_fullpath; /*!< full db path including prefix */
96 int db_mode; /*!< open mode */
97 int db_perms; /*!< open permissions */
98 int db_api; /*!< Berkeley API type */
100 int db_chrootDone; /*!< If chroot(2) done, ignore db_root. */
101 int db_mkdirDone; /*!< Has db_home been created? */
102 unsigned char * db_bits; /*!< package instance bit mask. */
103 int db_nbits; /*!< no. of bits in mask. */
106 void * db_dbenv; /*!< Berkeley DB_ENV handle. */
107 int db_ndbi; /*!< No. of tag indices. */
108 dbiIndex * _dbi; /*!< Tag indices. */
110 struct rpmop_s db_getops;
111 struct rpmop_s db_putops;
112 struct rpmop_s db_delops;
114 int nrefs; /*!< Reference count. */
117 /* for RPM's internal use only */
122 RPMDB_FLAG_JUSTCHECK = (1 << 0),
123 RPMDB_FLAG_MINIMAL = (1 << 1),
124 RPMDB_FLAG_CHROOT = (1 << 2)
132 * Return new configured index database handle instance.
133 * @param rpmdb rpm database
134 * @param rpmtag rpm tag
135 * @return index database handle
138 dbiIndex dbiNew(rpmdb rpmdb, rpmTag rpmtag);
141 * Destroy index database handle instance.
142 * @param dbi index database handle
143 * @return NULL always
146 dbiIndex dbiFree( dbiIndex dbi);
149 * Format dbi open flags for debugging print.
150 * @param dbflags db open flags
151 * @param print_dbenv_flags format db env flags instead?
152 * @return formatted flags (malloced)
155 char * prDbiOpenFlags(int dbflags, int print_dbenv_flags);
158 * Return handle for an index database.
159 * @param db rpm database
160 * @param rpmtag rpm tag
161 * @param flags (unused)
162 * @return index database handle
165 dbiIndex dbiOpen(rpmdb db, rpmTag rpmtag,
170 * Actually open the database of the index.
171 * @param db rpm database
172 * @param rpmtag rpm tag
173 * @param dbiIndex address of index database handle
174 * @return 0 on success
177 int dbiOpenDB(rpmdb rpmdb, rpmTag rpmtag, dbiIndex * dbip);
180 /* FIX: vector annotations */
182 * Open a database cursor.
183 * @param dbi index database handle
184 * @param txnid database transaction handle
185 * @retval dbcp returned database cursor
186 * @param flags DB_WRITECURSOR if writing, or 0
187 * @return 0 on success
190 int dbiCopen(dbiIndex dbi, DB_TXN * txnid,
191 DBC ** dbcp, unsigned int flags);
194 * Close a database cursor.
195 * @param dbi index database handle
196 * @param dbcursor database cursor
197 * @param flags (unused)
198 * @return 0 on success
201 int dbiCclose(dbiIndex dbi, DBC * dbcursor, unsigned int flags);
204 * Delete (key,data) pair(s) from index database.
205 * @param dbi index database handle
206 * @param dbcursor database cursor (NULL will use db->del)
207 * @param key delete key value/length/flags
208 * @param data delete data value/length/flags
209 * @param flags (unused)
210 * @return 0 on success
213 int dbiDel(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
217 * Retrieve (key,data) pair from index database.
218 * @param dbi index database handle
219 * @param dbcursor database cursor (NULL will use db->get)
220 * @param key retrieve key value/length/flags
221 * @param data retrieve data value/length/flags
222 * @param flags (unused)
223 * @return 0 on success
226 int dbiGet(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
230 * Store (key,data) pair in index database.
231 * @param dbi index database handle
232 * @param dbcursor database cursor (NULL will use db->put)
233 * @param key store key value/length/flags
234 * @param data store data value/length/flags
235 * @param flags (unused)
236 * @return 0 on success
239 int dbiPut(dbiIndex dbi, DBC * dbcursor, DBT * key, DBT * data,
243 * Retrieve count of (possible) duplicate items.
244 * @param dbi index database handle
245 * @param dbcursor database cursor
246 * @param countp address of count
247 * @param flags (unused)
248 * @return 0 on success
250 int dbiCount(dbiIndex dbi, DBC * dbcursor, unsigned int * countp,
254 * Close index database.
255 * @param dbi index database handle
256 * @param flags (unused)
257 * @return 0 on success
259 int dbiClose(dbiIndex dbi, unsigned int flags);
262 * Flush pending operations to disk.
263 * @param dbi index database handle
264 * @param flags (unused)
265 * @return 0 on success
267 int dbiSync (dbiIndex dbi, unsigned int flags);
270 * Verify (and close) index database.
271 * @param dbi index database handle
272 * @param flags (unused)
273 * @return 0 on success
276 int dbiVerify(dbiIndex dbi, unsigned int flags)
278 dbi->dbi_verify_on_close = 1;
279 return dbiClose(dbi, flags);
284 * Is database byte swapped?
285 * @param dbi index database handle
286 * @return 0 same order, 1 swapped order
288 int dbiByteSwapped(dbiIndex dbi);
291 * Is database byte swapped?
292 * @param dbi index database handle
293 * @param flags DB_FAST_STAT or 0
294 * @return 0 on success
296 int dbiStat(dbiIndex dbi, unsigned int flags);
299 * Destroy set of index database items.
300 * @param set set of index database items
301 * @return NULL always
304 dbiIndexSet dbiFreeIndexSet(dbiIndexSet set);
307 * Count items in index database set.
308 * @param set set of index database items
309 * @return number of items
312 unsigned int dbiIndexSetCount(dbiIndexSet set);
315 * Return record offset of header from element in index database set.
316 * @param set set of index database items
317 * @param recno index of item in set
318 * @return record offset of header
321 unsigned int dbiIndexRecordOffset(dbiIndexSet set, int recno);
324 * Return file index from element in index database set.
325 * @param set set of index database items
326 * @param recno index of item in set
330 unsigned int dbiIndexRecordFileNumber(dbiIndexSet set, int recno);
333 * Return rpmdb home directory (depending on chroot state)
334 * param db rpmdb handle
335 * return db home directory (or NULL on error)
338 const char *rpmdbHome(rpmdb db);
341 * Return database iterator.
342 * @param mi rpm database iterator
343 * @param keyp key data (NULL for sequential access)
344 * @param keylen key data length (0 will use strlen(keyp))
345 * @return 0 on success
347 int rpmdbExtendIterator(rpmdbMatchIterator mi,
348 const void * keyp, size_t keylen);
351 * sort the iterator by (recnum, filenum)
352 * Return database iterator.
353 * @param mi rpm database iterator
355 void rpmdbSortIterator(rpmdbMatchIterator mi);
359 * * Mergesort, same arguments as qsort(2).
362 int mergesort(void *base, size_t nmemb, size_t size,
363 int (*cmp) (const void *, const void *));
365 /* mergesort is defined in stdlib.h on Mac OS X */
366 #endif /* __APPLE__ */