source/tdb/tdbutil.c

   1 /*
   2    Unix SMB/CIFS implementation.
   3    tdb utility functions
   4    Copyright (C) Andrew Tridgell 1992-1998
   5
   6    This program is free software; you can redistribute it and/or modify
   7    it under the terms of the GNU General Public License as published by
   8    the Free Software Foundation; either version 2 of the License, or
   9    (at your option) any later version.
  10
  11    This program is distributed in the hope that it will be useful,
  12    but WITHOUT ANY WARRANTY; without even the implied warranty of
  13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14    GNU General Public License for more details.
  15
  16    You should have received a copy of the GNU General Public License
  17    along with this program; if not, write to the Free Software
  18    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  19 */
  20
  21 #include "includes.h"
  22
  23 /* these are little tdb utility functions that are meant to make
  24    dealing with a tdb database a little less cumbersome in Samba */
  25
  26 /****************************************************************************
  27  Lock a chain by string.
  28 ****************************************************************************/
  29
  30 int tdb_lock_bystring(TDB_CONTEXT *tdb, char *keyval)
  31 {
  32         TDB_DATA key;
  33
  34         key.dptr = keyval;
  35         key.dsize = strlen(keyval)+1;
  36
  37         return tdb_chainlock(tdb, key);
  38 }
  39
  40 /****************************************************************************
  41  Unlock a chain by string.
  42 ****************************************************************************/
  43
  44 void tdb_unlock_bystring(TDB_CONTEXT *tdb, char *keyval)
  45 {
  46         TDB_DATA key;
  47
  48         key.dptr = keyval;
  49         key.dsize = strlen(keyval)+1;
  50
  51         tdb_chainunlock(tdb, key);
  52 }
  53
  54 /****************************************************************************
  55  Fetch a int32 value by a arbitrary blob key, return -1 if not found.
  56  Output is int32 in native byte order.
  57 ****************************************************************************/
  58
  59 int32 tdb_fetch_int32_byblob(TDB_CONTEXT *tdb, char *keyval, size_t len)
  60 {
  61         TDB_DATA key, data;
  62         int32 ret;
  63
  64         key.dptr = keyval;
  65         key.dsize = len;
  66         data = tdb_fetch(tdb, key);
  67         if (!data.dptr || data.dsize != sizeof(int32))
  68                 return -1;
  69
  70         ret = IVAL(data.dptr,0);
  71         SAFE_FREE(data.dptr);
  72         return ret;
  73 }
  74
  75 /****************************************************************************
  76  Fetch a int32 value by string key, return -1 if not found.
  77  Output is int32 in native byte order.
  78 ****************************************************************************/
  79
  80 int32 tdb_fetch_int32(TDB_CONTEXT *tdb, char *keystr)
  81 {
  82         return tdb_fetch_int32_byblob(tdb, keystr, strlen(keystr) + 1);
  83 }
  84
  85 /****************************************************************************
  86  Store a int32 value by an arbitary blob key, return 0 on success, -1 on failure.
  87  Input is int32 in native byte order. Output in tdb is in little-endian.
  88 ****************************************************************************/
  89
  90 int tdb_store_int32_byblob(TDB_CONTEXT *tdb, char *keystr, size_t len, int32 v)
  91 {
  92         TDB_DATA key, data;
  93         int32 v_store;
  94
  95         key.dptr = keystr;
  96         key.dsize = len;
  97         SIVAL(&v_store,0,v);
  98         data.dptr = (void *)&v_store;
  99         data.dsize = sizeof(int32);
 100
 101         return tdb_store(tdb, key, data, TDB_REPLACE);
 102 }
 103
 104 /****************************************************************************
 105  Store a int32 value by string key, return 0 on success, -1 on failure.
 106  Input is int32 in native byte order. Output in tdb is in little-endian.
 107 ****************************************************************************/
 108
 109 int tdb_store_int32(TDB_CONTEXT *tdb, char *keystr, int32 v)
 110 {
 111         return tdb_store_int32_byblob(tdb, keystr, strlen(keystr) + 1, v);
 112 }
 113
 114 /****************************************************************************
 115  Fetch a uint32 value by a arbitrary blob key, return -1 if not found.
 116  Output is uint32 in native byte order.
 117 ****************************************************************************/
 118
 119 BOOL tdb_fetch_uint32_byblob(TDB_CONTEXT *tdb, char *keyval, size_t len, uint32 *value)
 120 {
 121         TDB_DATA key, data;
 122
 123         key.dptr = keyval;
 124         key.dsize = len;
 125         data = tdb_fetch(tdb, key);
 126         if (!data.dptr || data.dsize != sizeof(uint32))
 127                 return False;
 128
 129         *value = IVAL(data.dptr,0);
 130         SAFE_FREE(data.dptr);
 131         return True;
 132 }
 133
 134 /****************************************************************************
 135  Fetch a uint32 value by string key, return -1 if not found.
 136  Output is uint32 in native byte order.
 137 ****************************************************************************/
 138
 139 BOOL tdb_fetch_uint32(TDB_CONTEXT *tdb, char *keystr, uint32 *value)
 140 {
 141         return tdb_fetch_uint32_byblob(tdb, keystr, strlen(keystr) + 1, value);
 142 }
 143
 144 /****************************************************************************
 145  Store a uint32 value by an arbitary blob key, return 0 on success, -1 on failure.
 146  Input is uint32 in native byte order. Output in tdb is in little-endian.
 147 ****************************************************************************/
 148
 149 BOOL tdb_store_uint32_byblob(TDB_CONTEXT *tdb, char *keystr, size_t len, uint32 value)
 150 {
 151         TDB_DATA key, data;
 152         uint32 v_store;
 153         BOOL ret = True;
 154
 155         key.dptr = keystr;
 156         key.dsize = len;
 157         SIVAL(&v_store, 0, value);
 158         data.dptr = (void *)&v_store;
 159         data.dsize = sizeof(uint32);
 160
 161         if (tdb_store(tdb, key, data, TDB_REPLACE) == -1)
 162                 ret = False;
 163
 164         return ret;
 165 }
 166
 167 /****************************************************************************
 168  Store a uint32 value by string key, return 0 on success, -1 on failure.
 169  Input is uint32 in native byte order. Output in tdb is in little-endian.
 170 ****************************************************************************/
 171
 172 BOOL tdb_store_uint32(TDB_CONTEXT *tdb, char *keystr, uint32 value)
 173 {
 174         return tdb_store_uint32_byblob(tdb, keystr, strlen(keystr) + 1, value);
 175 }
 176 /****************************************************************************
 177  Store a buffer by a null terminated string key.  Return 0 on success, -1
 178  on failure.
 179 ****************************************************************************/
 180
 181 int tdb_store_by_string(TDB_CONTEXT *tdb, char *keystr, void *buffer, int len)
 182 {
 183     TDB_DATA key, data;
 184
 185     key.dptr = keystr;
 186     key.dsize = strlen(keystr) + 1;
 187
 188     data.dptr = buffer;
 189     data.dsize = len;
 190
 191     return tdb_store(tdb, key, data, TDB_REPLACE);
 192 }
 193
 194 /****************************************************************************
 195  Fetch a buffer using a null terminated string key.  Don't forget to call
 196  free() on the result dptr.
 197 ****************************************************************************/
 198
 199 TDB_DATA tdb_fetch_by_string(TDB_CONTEXT *tdb, char *keystr)
 200 {
 201     TDB_DATA key;
 202
 203     key.dptr = keystr;
 204     key.dsize = strlen(keystr) + 1;
 205
 206     return tdb_fetch(tdb, key);
 207 }
 208
 209 /****************************************************************************
 210  Atomic integer change. Returns old value. To create, set initial value in *oldval.
 211 ****************************************************************************/
 212
 213 int32 tdb_change_int32_atomic(TDB_CONTEXT *tdb, char *keystr, int32 *oldval, int32 change_val)
 214 {
 215         int32 val;
 216         int32 ret = -1;
 217
 218         if (tdb_lock_bystring(tdb, keystr) == -1)
 219                 return -1;
 220
 221         if ((val = tdb_fetch_int32(tdb, keystr)) == -1) {
 222                 if (tdb_error(tdb) != TDB_ERR_NOEXIST)
 223                         goto err_out;
 224
 225                 val = *oldval;
 226
 227         } else {
 228                 *oldval = val;
 229                 val += change_val;
 230         }
 231
 232         if (tdb_store_int32(tdb, keystr, val) == -1)
 233                 goto err_out;
 234
 235         ret = 0;
 236
 237   err_out:
 238
 239         tdb_unlock_bystring(tdb, keystr);
 240         return ret;
 241 }
 242
 243 /****************************************************************************
 244  Atomic unsigned integer change. Returns old value. To create, set initial value in *oldval.
 245 ****************************************************************************/
 246
 247 BOOL tdb_change_uint32_atomic(TDB_CONTEXT *tdb, char *keystr, uint32 *oldval, uint32 change_val)
 248 {
 249         uint32 val;
 250         BOOL ret = False;
 251
 252         if (tdb_lock_bystring(tdb, keystr) == -1)
 253                 return False;
 254
 255         if (!tdb_fetch_uint32(tdb, keystr, &val)) {
 256                 if (tdb_error(tdb) != TDB_ERR_NOEXIST)
 257                         goto err_out;
 258
 259                 val = *oldval;
 260
 261         } else {
 262                 *oldval = val;
 263                 val += change_val;
 264         }
 265
 266         if (!tdb_store_uint32(tdb, keystr, val))
 267                 goto err_out;
 268
 269         ret = True;
 270
 271   err_out:
 272
 273         tdb_unlock_bystring(tdb, keystr);
 274         return ret;
 275 }
 276
 277 /****************************************************************************
 278  Useful pair of routines for packing/unpacking data consisting of
 279  integers and strings.
 280 ****************************************************************************/
 281
 282 size_t tdb_pack(char *buf, int bufsize, char *fmt, ...)
 283 {
 284         va_list ap;
 285         uint16 w;
 286         uint32 d;
 287         int i;
 288         void *p;
 289         int len;
 290         char *s;
 291         char c;
 292         char *buf0 = buf;
 293         char *fmt0 = fmt;
 294         int bufsize0 = bufsize;
 295
 296         va_start(ap, fmt);
 297
 298         while (*fmt) {
 299                 switch ((c = *fmt++)) {
 300                 case 'w':
 301                         len = 2;
 302                         w = (uint16)va_arg(ap, int);
 303                         if (bufsize >= len)
 304                                 SSVAL(buf, 0, w);
 305                         break;
 306                 case 'd':
 307                         len = 4;
 308                         d = va_arg(ap, uint32);
 309                         if (bufsize >= len)
 310                                 SIVAL(buf, 0, d);
 311                         break;
 312                 case 'p':
 313                         len = 4;
 314                         p = va_arg(ap, void *);
 315                         d = p?1:0;
 316                         if (bufsize >= len)
 317                                 SIVAL(buf, 0, d);
 318                         break;
 319                 case 'P':
 320                         s = va_arg(ap,char *);
 321                         w = strlen(s);
 322                         len = w + 1;
 323                         if (bufsize >= len)
 324                                 memcpy(buf, s, len);
 325                         break;
 326                 case 'f':
 327                         s = va_arg(ap,char *);
 328                         w = strlen(s);
 329                         len = w + 1;
 330                         if (bufsize >= len)
 331                                 memcpy(buf, s, len);
 332                         break;
 333                 case 'B':
 334                         i = va_arg(ap, int);
 335                         s = va_arg(ap, char *);
 336                         len = 4+i;
 337                         if (bufsize >= len) {
 338                                 SIVAL(buf, 0, i);
 339                                 memcpy(buf+4, s, i);
 340                         }
 341                         break;
 342                 default:
 343                         DEBUG(0,("Unknown tdb_pack format %c in %s\n",
 344                                  c, fmt));
 345                         len = 0;
 346                         break;
 347                 }
 348
 349                 buf += len;
 350                 bufsize -= len;
 351         }
 352
 353         va_end(ap);
 354
 355         DEBUG(18,("tdb_pack(%s, %d) -> %d\n",
 356                  fmt0, bufsize0, (int)PTR_DIFF(buf, buf0)));
 357
 358         return PTR_DIFF(buf, buf0);
 359 }
 360
 361 /****************************************************************************
 362  Useful pair of routines for packing/unpacking data consisting of
 363  integers and strings.
 364 ****************************************************************************/
 365
 366 int tdb_unpack(char *buf, int bufsize, char *fmt, ...)
 367 {
 368         va_list ap;
 369         uint16 *w;
 370         uint32 *d;
 371         int len;
 372         int *i;
 373         void **p;
 374         char *s, **b;
 375         char c;
 376         char *buf0 = buf;
 377         char *fmt0 = fmt;
 378         int bufsize0 = bufsize;
 379
 380         va_start(ap, fmt);
 381
 382         while (*fmt) {
 383                 switch ((c=*fmt++)) {
 384                 case 'w':
 385                         len = 2;
 386                         w = va_arg(ap, uint16 *);
 387                         if (bufsize < len)
 388                                 goto no_space;
 389                         *w = SVAL(buf, 0);
 390                         break;
 391                 case 'd':
 392                         len = 4;
 393                         d = va_arg(ap, uint32 *);
 394                         if (bufsize < len)
 395                                 goto no_space;
 396                         *d = IVAL(buf, 0);
 397                         break;
 398                 case 'p':
 399                         len = 4;
 400                         p = va_arg(ap, void **);
 401                         if (bufsize < len)
 402                                 goto no_space;
 403                         *p = (void *)IVAL(buf, 0);
 404                         break;
 405                 case 'P':
 406                         s = va_arg(ap,char *);
 407                         len = strlen(buf) + 1;
 408                         if (bufsize < len || len > sizeof(pstring))
 409                                 goto no_space;
 410                         memcpy(s, buf, len);
 411                         break;
 412                 case 'f':
 413                         s = va_arg(ap,char *);
 414                         len = strlen(buf) + 1;
 415                         if (bufsize < len || len > sizeof(fstring))
 416                                 goto no_space;
 417                         memcpy(s, buf, len);
 418                         break;
 419                 case 'B':
 420                         i = va_arg(ap, int *);
 421                         b = va_arg(ap, char **);
 422                         len = 4;
 423                         if (bufsize < len)
 424                                 goto no_space;
 425                         *i = IVAL(buf, 0);
 426                         if (! *i) {
 427                                 *b = NULL;
 428                                 break;
 429                         }
 430                         len += *i;
 431                         if (bufsize < len)
 432                                 goto no_space;
 433                         *b = (char *)malloc(*i);
 434                         if (! *b)
 435                                 goto no_space;
 436                         memcpy(*b, buf+4, *i);
 437                         break;
 438                 default:
 439                         DEBUG(0,("Unknown tdb_unpack format %c in %s\n",
 440                                  c, fmt));
 441
 442                         len = 0;
 443                         break;
 444                 }
 445
 446                 buf += len;
 447                 bufsize -= len;
 448         }
 449
 450         va_end(ap);
 451
 452         DEBUG(18,("tdb_unpack(%s, %d) -> %d\n",
 453                  fmt0, bufsize0, (int)PTR_DIFF(buf, buf0)));
 454
 455         return PTR_DIFF(buf, buf0);
 456
 457  no_space:
 458         return -1;
 459 }
 460
 461 /****************************************************************************
 462  Log tdb messages via DEBUG().
 463 ****************************************************************************/
 464
 465 static void tdb_log(TDB_CONTEXT *tdb, int level, const char *format, ...)
 466 {
 467         va_list ap;
 468         char *ptr = NULL;
 469
 470         va_start(ap, format);
 471         vasprintf(&ptr, format, ap);
 472         va_end(ap);
 473
 474         if (!ptr || !*ptr)
 475                 return;
 476
 477         DEBUG(level, ("tdb(%s): %s", tdb->name ? tdb->name : "unnamed", ptr));
 478         SAFE_FREE(ptr);
 479 }
 480
 481 /****************************************************************************
 482  Like tdb_open() but also setup a logging function that redirects to
 483  the samba DEBUG() system.
 484 ****************************************************************************/
 485
 486 TDB_CONTEXT *tdb_open_log(const char *name, int hash_size, int tdb_flags,
 487                           int open_flags, mode_t mode)
 488 {
 489         TDB_CONTEXT *tdb;
 490
 491         if (!lp_use_mmap())
 492                 tdb_flags |= TDB_NOMMAP;
 493
 494         tdb = tdb_open_ex(name, hash_size, tdb_flags,
 495                                     open_flags, mode, tdb_log);
 496         if (!tdb)
 497                 return NULL;
 498
 499         return tdb;
 500 }
 501
 502
 503 /****************************************************************************
 504  Allow tdb_delete to be used as a tdb_traversal_fn.
 505 ****************************************************************************/
 506
 507 int tdb_traverse_delete_fn(TDB_CONTEXT *the_tdb, TDB_DATA key, TDB_DATA dbuf,
 508                      void *state)
 509 {
 510     return tdb_delete(the_tdb, key);
 511 }