1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398
|
/*
* This file implements wrappers for persistent gdbm storage for the
* shared variable arrays.
*
* See the file "license.terms" for information on usage and redistribution
* of this file, and for a DISCLAIMER OF ALL WARRANTIES.
* ----------------------------------------------------------------------------
*/
#ifdef HAVE_GDBM
#include "threadSvCmd.h"
#include <gdbm.h>
#include <stdlib.h> /* For free() */
/*
* Functions implementing the persistent store interface
*/
static ps_open_proc ps_gdbm_open;
static ps_close_proc ps_gdbm_close;
static ps_get_proc ps_gdbm_get;
static ps_put_proc ps_gdbm_put;
static ps_first_proc ps_gdbm_first;
static ps_next_proc ps_gdbm_next;
static ps_delete_proc ps_gdbm_delete;
static ps_free_proc ps_gdbm_free;
static ps_geterr_proc ps_gdbm_geterr;
/*
* This structure collects all the various pointers
* to the functions implementing the gdbm store.
*/
const PsStore GdbmStore = {
"gdbm",
NULL,
ps_gdbm_open,
ps_gdbm_get,
ps_gdbm_put,
ps_gdbm_first,
ps_gdbm_next,
ps_gdbm_delete,
ps_gdbm_close,
ps_gdbm_free,
ps_gdbm_geterr,
NULL
};
/*
*-----------------------------------------------------------------------------
*
* Sv_RegisterGdbmStore --
*
* Register the gdbm store with shared variable implementation.
*
* Results:
* None.
*
* Side effects:
* None.
*
*-----------------------------------------------------------------------------
*/
void
Sv_RegisterGdbmStore(void)
{
Sv_RegisterPsStore(&GdbmStore);
}
/*
*-----------------------------------------------------------------------------
*
* ps_gdbm_open --
*
* Opens the dbm-based persistent storage.
*
* Results:
* Opaque handle of the opened dbm storage.
*
* Side effects:
* The gdbm file might be created if not found.
*
*-----------------------------------------------------------------------------
*/
static void *
ps_gdbm_open(
const char *path)
{
GDBM_FILE dbf;
char *ext;
Tcl_DString toext;
Tcl_DStringInit(&toext);
ext = Tcl_UtfToExternalDString(NULL, path, strlen(path), &toext);
dbf = gdbm_open(ext, 512, GDBM_WRCREAT|GDBM_SYNC|GDBM_NOLOCK, 0666, NULL);
Tcl_DStringFree(&toext);
return dbf;
}
/*
*-----------------------------------------------------------------------------
*
* ps_gdbm_close --
*
* Closes the gdbm-based persistent storage.
*
* Results:
* 0 - ok
*
* Side effects:
* None.
*
*-----------------------------------------------------------------------------
*/
static int
ps_gdbm_close(
void *handle)
{
gdbm_close((GDBM_FILE)handle);
return 0;
}
/*
*-----------------------------------------------------------------------------
*
* ps_gdbm_get --
*
* Retrieves data for the key from the dbm storage.
*
* Results:
* 1 - no such key
* 0 - ok
*
* Side effects:
* Data returned must be freed by the caller.
*
*-----------------------------------------------------------------------------
*/
static int
ps_gdbm_get(
void *handle,
const char *key,
char **dataptrptr,
Tcl_Size *lenptr)
{
GDBM_FILE dbf = (GDBM_FILE)handle;
datum drec, dkey;
dkey.dptr = (char*)key;
dkey.dsize = strlen(key) + 1;
drec = gdbm_fetch(dbf, dkey);
if (drec.dptr == NULL) {
return 1;
}
*dataptrptr = drec.dptr;
*lenptr = drec.dsize;
return 0;
}
/*
*-----------------------------------------------------------------------------
*
* ps_gdbm_first --
*
* Starts the iterator over the dbm file and returns the first record.
*
* Results:
* 1 - no more records in the iterator
* 0 - ok
*
* Side effects:
* Data returned must be freed by the caller.
*
*-----------------------------------------------------------------------------
*/
static int
ps_gdbm_first(
void *handle,
char **keyptrptr,
char **dataptrptr,
Tcl_Size *lenptr)
{
GDBM_FILE dbf = (GDBM_FILE)handle;
datum drec, dkey;
dkey = gdbm_firstkey(dbf);
if (dkey.dptr == NULL) {
return 1;
}
drec = gdbm_fetch(dbf, dkey);
if (drec.dptr == NULL) {
return 1;
}
*dataptrptr = drec.dptr;
*lenptr = drec.dsize;
*keyptrptr = dkey.dptr;
return 0;
}
/*
*-----------------------------------------------------------------------------
*
* ps_gdbm_next --
*
* Uses the iterator over the dbm file and returns the next record.
*
* Results:
* 1 - no more records in the iterator
* 0 - ok
*
* Side effects:
* Data returned must be freed by the caller.
*
*-----------------------------------------------------------------------------
*/
static int ps_gdbm_next(
void *handle,
char **keyptrptr,
char **dataptrptr,
Tcl_Size *lenptr)
{
GDBM_FILE dbf = (GDBM_FILE)handle;
datum drec, dkey, dnext;
dkey.dptr = *keyptrptr;
dkey.dsize = strlen(*keyptrptr) + 1;
dnext = gdbm_nextkey(dbf, dkey);
free(*keyptrptr), *keyptrptr = NULL;
if (dnext.dptr == NULL) {
return 1;
}
drec = gdbm_fetch(dbf, dnext);
if (drec.dptr == NULL) {
return 1;
}
*dataptrptr = drec.dptr;
*lenptr = drec.dsize;
*keyptrptr = dnext.dptr;
return 0;
}
/*
*-----------------------------------------------------------------------------
*
* ps_gdbm_put --
*
* Stores used data bound to a key in dbm storage.
*
* Results:
* 0 - ok
* -1 - error; use ps_dbm_geterr to retrieve the error message
*
* Side effects:
* If the key is already associated with some user data, this will
* be replaced by the new data chunk.
*
*-----------------------------------------------------------------------------
*/
static int
ps_gdbm_put(
void *handle,
const char *key,
char *dataptr,
Tcl_Size len)
{
GDBM_FILE dbf = (GDBM_FILE)handle;
datum drec, dkey;
int ret;
dkey.dptr = (char*)key;
dkey.dsize = strlen(key) + 1;
drec.dptr = dataptr;
drec.dsize = len;
ret = gdbm_store(dbf, dkey, drec, GDBM_REPLACE);
if (ret == -1) {
return -1;
}
return 0;
}
/*
*-----------------------------------------------------------------------------
*
* ps_gdbm_delete --
*
* Deletes the key and associated data from the dbm storage.
*
* Results:
* 0 - ok
* -1 - error; use ps_dbm_geterr to retrieve the error message
*
* Side effects:
* If the key is already associated with some user data, this will
* be replaced by the new data chunk.
*
*-----------------------------------------------------------------------------
*/
static int
ps_gdbm_delete(
void *handle,
const char *key)
{
GDBM_FILE dbf = (GDBM_FILE)handle;
datum dkey;
int ret;
dkey.dptr = (char*)key;
dkey.dsize = strlen(key) + 1;
ret = gdbm_delete(dbf, dkey);
if (ret == -1) {
return -1;
}
return 0;
}
/*
*-----------------------------------------------------------------------------
*
* ps_gdbm_free --
*
* Frees memory allocated by the gdbm implementation.
*
* Results:
* None.
*
* Side effects:
* Memory gets reclaimed.
*
*-----------------------------------------------------------------------------
*/
static void
ps_gdbm_free(
TCL_UNUSED(void *),
void *data)
{
free(data);
}
/*
*-----------------------------------------------------------------------------
*
* ps_gdbm_geterr --
*
* Retrieves the textual representation of the error caused
* by the last dbm command.
*
* Results:
* Pointer to the strimg message.
*
* Side effects:
* None.
*
*-----------------------------------------------------------------------------
*/
static const char*
ps_gdbm_geterr(
TCL_UNUSED(void *))
{
/*
* The problem with gdbm interface is that it uses the global
* gdbm_errno variable which is not per-thread nor mutex
* protected. This variable is used to reference array of gdbm
* error text strings. It is very dangerous to use this in the
* MT-program without proper locking. For this kind of app
* we should not be concerned with that, since all ps_gdbm_xxx
* operations are performed under shared variable lock anyway.
*/
return gdbm_strerror(gdbm_errno);
}
#endif /* HAVE_GDBM */
/* EOF $RCSfile*/
/* Emacs Setup Variables */
/* Local Variables: */
/* mode: C */
/* indent-tabs-mode: nil */
/* c-basic-offset: 4 */
/* End: */
|