4 * GDBM database driver for Citadel/UX
9 * Note that each call to a GDBM function is wrapped in an S_DATABASE critical
10 * section. This is done because GDBM is not threadsafe. This is the ONLY
11 * place in the entire Citadel server where any code enters two different
12 * classes of critical sections at the same time; this is why the GDBM calls
13 * are *tightly* wrapped in S_DATABASE. Opening multiple concurrent critical
14 * sections elsewhere in the code can, and probably will, cause deadlock
15 * conditions to occur. (Deadlock is bad. Eliminate.)
27 #if TIME_WITH_SYS_TIME
28 # include <sys/time.h>
32 # include <sys/time.h>
45 #include "sysdep_decls.h"
49 * This array holds one gdbm handle for each Citadel database.
51 GDBM_FILE gdbms[MAXCDB];
54 * We also keep these around, for sequential searches (one per session slot)
61 * Reclaim unused space in the databases. We need to do each one of
62 * these discretely, rather than in a loop.
64 void defrag_databases(void)
67 /* defrag the message base */
68 lprintf(7, "Defragmenting message base\n");
69 begin_critical_section(S_DATABASE);
70 gdbm_reorganize(gdbms[CDB_MSGMAIN]);
71 end_critical_section(S_DATABASE);
73 /* defrag the user file, mailboxes, and user/room relationships */
74 lprintf(7, "Defragmenting user file\n");
75 begin_critical_section(S_USERSUPP);
76 begin_critical_section(S_DATABASE);
77 gdbm_reorganize(gdbms[CDB_USERSUPP]);
78 gdbm_reorganize(gdbms[CDB_VISIT]);
79 end_critical_section(S_DATABASE);
80 end_critical_section(S_USERSUPP);
82 /* defrag the room files and message lists */
83 lprintf(7, "Defragmenting room files and message lists\n");
84 begin_critical_section(S_QUICKROOM);
85 begin_critical_section(S_DATABASE);
86 gdbm_reorganize(gdbms[CDB_QUICKROOM]);
87 gdbm_reorganize(gdbms[CDB_MSGLISTS]);
88 end_critical_section(S_DATABASE);
89 end_critical_section(S_QUICKROOM);
91 /* defrag the floor table */
92 lprintf(7, "Defragmenting floor table\n");
93 begin_critical_section(S_FLOORTAB);
94 begin_critical_section(S_DATABASE);
95 gdbm_reorganize(gdbms[CDB_FLOORTAB]);
96 end_critical_section(S_DATABASE);
97 end_critical_section(S_FLOORTAB);
99 /* defrag the directory */
100 lprintf(7, "Defragmenting the directory\n");
101 begin_critical_section(S_DIRECTORY);
102 gdbm_reorganize(gdbms[CDB_DIRECTORY]);
103 end_critical_section(S_DIRECTORY);
108 * Open the various gdbm databases we'll be using. Any database which
109 * does not exist should be created.
111 void open_databases(void)
113 lprintf(7, "%s\n", gdbm_version);
116 * Silently try to create the database subdirectory. If it's
117 * already there, no problem.
119 system("exec mkdir data 2>/dev/null");
121 /* a critical section is unnecessary, as this function is called before
122 any other threads are created. and it causes problems on BSDI.
124 begin_critical_section(S_DATABASE);
128 gdbms[CDB_MSGMAIN] = gdbm_open("data/msgmain.gdbm", 8192,
129 GDBM_WRCREAT, 0600, NULL);
130 if (gdbms[CDB_MSGMAIN] == NULL) {
131 lprintf(2, "Cannot open msgmain: %s\n",
132 gdbm_strerror(gdbm_errno));
135 gdbms[CDB_USERSUPP] = gdbm_open("data/usersupp.gdbm", 0,
136 GDBM_WRCREAT, 0600, NULL);
137 if (gdbms[CDB_USERSUPP] == NULL) {
138 lprintf(2, "Cannot open usersupp: %s\n",
139 gdbm_strerror(gdbm_errno));
142 gdbms[CDB_VISIT] = gdbm_open("data/visit.gdbm", 0,
143 GDBM_WRCREAT, 0600, NULL);
144 if (gdbms[CDB_VISIT] == NULL) {
145 lprintf(2, "Cannot open visit file: %s\n",
146 gdbm_strerror(gdbm_errno));
149 gdbms[CDB_QUICKROOM] = gdbm_open("data/quickroom.gdbm", 0,
150 GDBM_WRCREAT, 0600, NULL);
151 if (gdbms[CDB_QUICKROOM] == NULL) {
152 lprintf(2, "Cannot open quickroom: %s\n",
153 gdbm_strerror(gdbm_errno));
156 gdbms[CDB_FLOORTAB] = gdbm_open("data/floortab.gdbm", 0,
157 GDBM_WRCREAT, 0600, NULL);
158 if (gdbms[CDB_FLOORTAB] == NULL) {
159 lprintf(2, "Cannot open floortab: %s\n",
160 gdbm_strerror(gdbm_errno));
163 gdbms[CDB_MSGLISTS] = gdbm_open("data/msglists.gdbm", 0,
164 GDBM_WRCREAT, 0600, NULL);
165 if (gdbms[CDB_MSGLISTS] == NULL) {
166 lprintf(2, "Cannot open msglists: %s\n",
167 gdbm_strerror(gdbm_errno));
170 gdbms[CDB_DIRECTORY] = gdbm_open("data/directory.gdbm", 0,
171 GDBM_WRCREAT, 0600, NULL);
172 if (gdbms[CDB_DIRECTORY] == NULL) {
173 lprintf(2, "Cannot open directory: %s\n",
174 gdbm_strerror(gdbm_errno));
178 end_critical_section(S_DATABASE);
185 * Close all of the gdbm database files we've opened. This can be done
186 * in a loop, since it's just a bunch of closes.
188 void close_databases(void)
192 begin_critical_section(S_DATABASE);
193 for (a = 0; a < MAXCDB; ++a) {
194 lprintf(7, "Closing database %d\n", a);
195 gdbm_close(gdbms[a]);
197 end_critical_section(S_DATABASE);
199 for (a = 0; a < max_keys; ++a) {
200 if (dtkey[a].dptr != NULL) {
201 phree(dtkey[a].dptr);
209 * Store a piece of data. Returns 0 if the operation was successful. If a
210 * datum already exists it should be overwritten.
212 int cdb_store(int cdb,
213 void *key, int keylen,
214 void *data, int datalen)
222 ddata.dsize = datalen;
225 begin_critical_section(S_DATABASE);
226 retval = gdbm_store(gdbms[cdb], dkey, ddata, GDBM_REPLACE);
227 end_critical_section(S_DATABASE);
229 lprintf(2, "gdbm error: %s\n", gdbm_strerror(gdbm_errno));
237 * Delete a piece of data. Returns 0 if the operation was successful.
239 int cdb_delete(int cdb, void *key, int keylen)
248 begin_critical_section(S_DATABASE);
249 retval = gdbm_delete(gdbms[cdb], dkey);
250 end_critical_section(S_DATABASE);
259 * Fetch a piece of data. If not found, returns NULL. Otherwise, it returns
260 * a struct cdbdata which it is the caller's responsibility to free later on
261 * using the cdb_free() routine.
263 struct cdbdata *cdb_fetch(int cdb, void *key, int keylen)
266 struct cdbdata *tempcdb;
272 begin_critical_section(S_DATABASE);
273 dret = gdbm_fetch(gdbms[cdb], dkey);
274 end_critical_section(S_DATABASE);
275 if (dret.dptr == NULL) {
278 tempcdb = (struct cdbdata *) mallok(sizeof(struct cdbdata));
279 if (tempcdb == NULL) {
280 lprintf(2, "Cannot allocate memory!\n");
282 tempcdb->len = dret.dsize;
283 tempcdb->ptr = dret.dptr;
289 * Free a cdbdata item (ok, this is really no big deal, but we might need to do
290 * more complex stuff with other database managers in the future).
292 void cdb_free(struct cdbdata *cdb)
298 void cdb_close_cursor(cdb)
300 while (max_keys <= CC->cs_pid) {
304 mallok((sizeof(datum) * max_keys));
307 reallok(dtkey, (sizeof(datum) * max_keys));
309 dtkey[max_keys - 1].dsize = 0;
310 dtkey[max_keys - 1].dptr = NULL;
313 if (dtkey[CC->cs_pid].dptr != NULL) {
314 phree(dtkey[CC->cs_pid].dptr);
316 dtkey[CC->cs_pid].dptr = NULL;
317 dtkey[CC->cs_pid].dsize = 0;
322 * Prepare for a sequential search of an entire database. (In the gdbm model,
323 * we do this by keeping an array dtkey[] of "the next" key for each session
324 * that is open. There is guaranteed to be no more than one traversal in
325 * progress per session at any given time.)
327 void cdb_rewind(int cdb)
330 while (max_keys <= CC->cs_pid) {
334 mallok((sizeof(datum) * max_keys));
337 reallok(dtkey, (sizeof(datum) * max_keys));
339 dtkey[max_keys - 1].dsize = 0;
340 dtkey[max_keys - 1].dptr = NULL;
343 if (dtkey[CC->cs_pid].dptr != NULL) {
344 phree(dtkey[CC->cs_pid].dptr);
346 begin_critical_section(S_DATABASE);
347 dtkey[CC->cs_pid] = gdbm_firstkey(gdbms[cdb]);
348 end_critical_section(S_DATABASE);
353 * Fetch the next item in a sequential search. Returns a pointer to a
354 * cdbdata structure, or NULL if we've hit the end.
356 struct cdbdata *cdb_next_item(int cdb)
359 struct cdbdata *cdbret;
363 if (dtkey[CC->cs_pid].dptr == NULL) { /* end of file */
366 begin_critical_section(S_DATABASE);
367 dret = gdbm_fetch(gdbms[cdb], dtkey[CC->cs_pid]);
368 end_critical_section(S_DATABASE);
369 if (dret.dptr == NULL) { /* bad read */
370 phree(dtkey[CC->cs_pid].dptr);
373 cdbret = (struct cdbdata *) mallok(sizeof(struct cdbdata));
374 cdbret->len = dret.dsize;
375 cdbret->ptr = dret.dptr;
377 ptr = dtkey[CC->cs_pid].dptr;
378 begin_critical_section(S_DATABASE);
379 dtkey[CC->cs_pid] = gdbm_nextkey(gdbms[cdb], dtkey[CC->cs_pid]);
380 end_critical_section(S_DATABASE);
382 if (ptr != NULL) { /* Free the previous key. */
391 * Truncate (delete every record)
393 void cdb_trunc(int cdb) {
396 begin_critical_section(S_DATABASE);
397 key = gdbm_firstkey ( dbf );
398 while (key = gdbm_firstkey(gdbms[cdb], key.dptr != NULL) {
399 gdbm_delete(gdbms[cdb], key);
401 end_critical_section(S_DATABASE);
407 * empty functions because GDBM doesn't have transaction support
410 void cdb_begin_transaction(void) {
413 void cdb_end_transaction(void) {
416 void cdb_allocate_tsd(void) {
419 void cdb_free_tsd(void) {
422 void cdb_check_handles(void) {