lib/db.c

   1 /*
   2  *      Sherlock Library -- Fast Database Management Routines
   3  *
   4  *      (c) 1999 Martin Mares <mj@atrey.karlin.mff.cuni.cz>
   5  */
   6
   7 /*
   8  *  This library uses the standard algorithm for external hashing (page directory
   9  *  mapping topmost K bits of hash value to page address, directory splits and
  10  *  so on). Peculiarities of this implementation (aka design decisions):
  11  *
  12  *   o  We allow both fixed and variable length keys and values (this includes
  13  *      zero size values for cases you want to represent only a set of keys).
  14  *   o  We assume that key_size + val_size < page_size.
  15  *   o  We never shrink the directory nor free empty pages. (The reason is that
  16  *      if the database was once large, it's likely it will again become large soon.)
  17  *   o  The only pages which can be freed are those of the directory (during
  18  *      directory split), so we keep only a simple 32-entry free block list
  19  *      and we assume it's sorted.
  20  */
  21
  22 #include <stdio.h>
  23 #include <stdlib.h>
  24 #include <string.h>
  25 #include <fcntl.h>
  26 #include <unistd.h>
  27
  28 #include "lib.h"
  29 #include "pagecache.h"
  30 #include "db.h"
  31 #include "db_internal.h"
  32
  33 struct sdbm *
  34 sdbm_open(struct sdbm_options *o)
  35 {
  36   struct sdbm *d;
  37   struct sdbm_root root, *r;
  38   uns cache_size = o->cache_size ? o->cache_size : 16;
  39
  40   d = xmalloc(sizeof(struct sdbm));
  41   bzero(d, sizeof(*d));
  42   d->flags = o->flags;
  43   d->fd = open(o->name, ((d->flags & SDBM_WRITE) ? O_RDWR : O_RDONLY), 0666);
  44   if (d->fd >= 0)                       /* Already exists, let's check it */
  45     {
  46       if (read(d->fd, &root, sizeof(root)) != sizeof(root))
  47         goto bad;
  48       if (root.magic != SDBM_MAGIC || root.version != SDBM_VERSION)
  49         goto bad;
  50       d->file_size = lseek(d->fd, 0, SEEK_END);
  51       d->page_size = 1 << root.page_order;
  52       d->cache = pgc_open(d->page_size, cache_size);
  53       d->root_page = pgc_read(d->cache, d->fd, 0);
  54       d->root = (void *) d->root_page->data;
  55       /* FIXME: Should we do some locking? */
  56     }
  57   else if ((d->flags & SDBM_CREAT) && (d->fd = open(o->name, O_RDWR | O_CREAT, 0666)) >= 0)
  58     {
  59       struct page *q;
  60       uns page_order = o->page_order;
  61       if (page_order < 10)
  62         page_order = 10;
  63       d->page_size = 1 << page_order;
  64       d->cache = pgc_open(d->page_size, cache_size);
  65       d->root_page = pgc_get_zero(d->cache, d->fd, 0);
  66       r = d->root = (void *) d->root_page->data;                 /* Build root page */
  67       r->magic = SDBM_MAGIC;
  68       r->version = SDBM_VERSION;
  69       r->page_order = page_order;
  70       r->key_size = o->key_size;
  71       r->val_size = o->val_size;
  72       r->dir_start = d->page_size;
  73       r->dir_order = 0;
  74       d->file_size = 3*d->page_size;
  75       q = pgc_get_zero(d->cache, d->fd, d->page_size);          /* Build page directory */
  76       ((u32 *)q->data)[0] = 2*d->page_size;
  77       pgc_put(d->cache, q);
  78       q = pgc_get_zero(d->cache, d->fd, 2*d->page_size);        /* Build single data page */
  79       pgc_put(d->cache, q);
  80     }
  81   else
  82     goto bad;
  83   d->dir_size = 1 << d->root->dir_order;
  84   d->dir_shift = 32 - d->root->dir_order;
  85   d->page_order = d->root->page_order;
  86   d->page_mask = d->page_size - 1;
  87   d->key_size = d->root->key_size;
  88   d->val_size = d->root->val_size;
  89   return d;
  90
  91 bad:
  92   sdbm_close(d);
  93   return NULL;
  94 }
  95
  96 void
  97 sdbm_close(struct sdbm *d)
  98 {
  99   if (d->root_page)
 100     pgc_put(d->cache, d->root_page);
 101   if (d->cache)
 102     pgc_close(d->cache);
 103   if (d->fd >= 0)
 104     close(d->fd);
 105   free(d);
 106 }
 107
 108 static uns
 109 sdbm_alloc_pages(struct sdbm *d, uns number)
 110 {
 111   uns where = d->file_size;
 112   d->file_size += number << d->page_order;
 113   return where;
 114 }
 115
 116 static uns
 117 sdbm_alloc_page(struct sdbm *d)
 118 {
 119   uns pos;
 120
 121   if (!d->root->free_pool[0].count)
 122     return sdbm_alloc_pages(d, 1);
 123   pos = d->root->free_pool[0].first;
 124   d->root->free_pool[0].first += d->page_size;
 125   if (!--d->root->free_pool[0].count)
 126     {
 127       memmove(d->root->free_pool, d->root->free_pool+1, SDBM_NUM_FREE_PAGE_POOLS * sizeof(d->root->free_pool[0]));
 128       d->root->free_pool[SDBM_NUM_FREE_PAGE_POOLS-1].count = 0;
 129     }
 130   pgc_mark_dirty(d->cache, d->root_page);
 131   return pos;
 132 }
 133
 134 static void
 135 sdbm_free_pages(struct sdbm *d, uns start, uns number)
 136 {
 137   uns i = 0;
 138
 139   while (d->root->free_pool[i].count)
 140     i++;
 141   d->root->free_pool[i].first = start;
 142   d->root->free_pool[i].count = number;
 143   pgc_mark_dirty(d->cache, d->root_page);
 144 }
 145
 146 static u32
 147 sdbm_hash(byte *key, uns keylen)
 148 {
 149   /*
 150    *  This is the same hash function as GDBM uses.
 151    *  FIXME: Use a faster one?
 152    */
 153   u32 value;
 154   int index;
 155
 156   /* Set the initial value from key. */
 157   value = 0x238F13AF * keylen;
 158   for (index = 0; index < keylen; index++)
 159     value = value + (key[index] << (index*5 % 24));
 160   return (1103515243 * value + 12345);
 161 }
 162
 163 static int
 164 sdbm_get_entry(struct sdbm *d, byte *pos, byte **key, uns *keylen, byte **val, uns *vallen)
 165 {
 166   byte *p = pos;
 167
 168   if (d->key_size >= 0)
 169     *keylen = d->key_size;
 170   else
 171     {
 172       *keylen = (p[0] << 8) | p[1];
 173       p += 2;
 174     }
 175   *key = p;
 176   p += *keylen;
 177   if (d->val_size >= 0)
 178     *vallen = d->val_size;
 179   else
 180     {
 181       *vallen = (p[0] << 8) | p[1];
 182       p += 2;
 183     }
 184   *val = p;
 185   p += *vallen;
 186   return p - pos;
 187 }
 188
 189 static int
 190 sdbm_entry_len(struct sdbm *d, uns keylen, uns vallen)
 191 {
 192   uns len = keylen + vallen;
 193   if (d->key_size < 0)
 194     len += 2;
 195   if (d->val_size < 0)
 196     len += 2;
 197   return len;
 198 }
 199
 200 static void
 201 sdbm_store_entry(struct sdbm *d, byte *pos, byte *key, uns keylen, byte *val, uns vallen)
 202 {
 203   if (d->key_size < 0)
 204     {
 205       *pos++ = keylen >> 8;
 206       *pos++ = keylen;
 207     }
 208   memmove(pos, key, keylen);
 209   pos += keylen;
 210   if (d->val_size < 0)
 211     {
 212       *pos++ = vallen >> 8;
 213       *pos++ = vallen;
 214     }
 215   memmove(pos, val, vallen);
 216 }
 217
 218 static uns
 219 sdbm_page_rank(struct sdbm *d, uns dirpos)
 220 {
 221   struct page *b;
 222   u32 pg, x;
 223   uns l, r;
 224   uns pm = d->page_mask;
 225
 226   b = pgc_read(d->cache, d->fd, d->root->dir_start + (dirpos & ~pm));
 227   pg = GET32(b->data, dirpos & pm);
 228   l = dirpos;
 229   while ((l & pm) && GET32(b->data, (l - 4) & pm) == pg)
 230     l -= 4;
 231   r = dirpos + 4;
 232   /* We heavily depend on unused directory entries being zero */
 233   while ((r & pm) && GET32(b->data, r & pm) == pg)
 234     r += 4;
 235   pgc_put(d->cache, b);
 236
 237   if (!(l & pm) && !(r & pm))
 238     {
 239       /* Note that if it spans page boundary, it must contain an integer number of pages */
 240       while (l)
 241         {
 242           b = pgc_read(d->cache, d->fd, d->root->dir_start + ((l - 4) & ~pm));
 243           x = GET32(b->data, 0);
 244           pgc_put(d->cache, b);
 245           if (x != pg)
 246             break;
 247           l -= d->page_size;
 248         }
 249       while (r < 4*d->dir_size)
 250         {
 251           b = pgc_read(d->cache, d->fd, d->root->dir_start + (r & ~pm));
 252           x = GET32(b->data, 0);
 253           pgc_put(d->cache, b);
 254           if (x != pg)
 255             break;
 256           r += d->page_size;
 257         }
 258     }
 259   return (r - l) >> 2;
 260 }
 261
 262 static void
 263 sdbm_expand_directory(struct sdbm *d)
 264 {
 265   struct page *b, *c;
 266   int i;
 267   u32 *dir, *t;
 268
 269   if (4*d->dir_size < d->page_size)
 270     {
 271       /* It still fits within single page */
 272       b = pgc_read(d->cache, d->fd, d->root->dir_start);
 273       dir = (u32 *) b->data;
 274       for(i=d->dir_size-1; i>=0; i--)
 275         dir[2*i] = dir[2*i+1] = dir[i];
 276       pgc_mark_dirty(d->cache, b);
 277       pgc_put(d->cache, b);
 278     }
 279   else
 280     {
 281       uns old_dir = d->root->dir_start;
 282       uns old_dir_pages = 1 << (d->root->dir_order + 2 - d->page_order);
 283       uns page, ent, new_dir;
 284       new_dir = d->root->dir_start = sdbm_alloc_pages(d, 2*old_dir_pages);
 285       ent = 1 << (d->page_order - 3);
 286       for(page=0; page < old_dir_pages; page++)
 287         {
 288           b = pgc_read(d->cache, d->fd, old_dir + (page << d->page_order));
 289           dir = (u32 *) b->data;
 290           c = pgc_get(d->cache, d->fd, new_dir + (page << (d->page_order + 1)));
 291           t = (u32 *) c->data;
 292           for(i=0; i<ent; i++)
 293             t[2*i] = t[2*i+1] = dir[i];
 294           pgc_put(d->cache, c);
 295           c = pgc_get(d->cache, d->fd, new_dir + (page << (d->page_order + 1)) + d->page_size);
 296           t = (u32 *) c->data;
 297           for(i=0; i<ent; i++)
 298             t[2*i] = t[2*i+1] = dir[ent+i];
 299           pgc_put(d->cache, c);
 300           pgc_put(d->cache, b);
 301         }
 302       if (!(d->flags & SDBM_FAST))
 303         {
 304           /*
 305            *  Unless in super-fast mode, fill old directory pages with zeroes.
 306            *  This slows us down a bit, but allows database reconstruction after
 307            *  the free list is lost.
 308            */
 309           for(page=0; page < old_dir_pages; page++)
 310             {
 311               b = pgc_get_zero(d->cache, d->fd, old_dir + (page << d->page_order));
 312               pgc_put(d->cache, b);
 313             }
 314         }
 315       sdbm_free_pages(d, old_dir, old_dir_pages);
 316     }
 317
 318   d->root->dir_order++;
 319   d->dir_size = 1 << d->root->dir_order;
 320   d->dir_shift = 32 - d->root->dir_order;
 321   pgc_mark_dirty(d->cache, d->root_page);
 322   if (!(d->flags & SDBM_FAST))
 323     sdbm_sync(d);
 324 }
 325
 326 static void
 327 sdbm_split_data(struct sdbm *d, struct sdbm_bucket *s, struct sdbm_bucket *d0, struct sdbm_bucket *d1, uns sigbit)
 328 {
 329   byte *sp = s->data;
 330   byte *dp[2] = { d0->data, d1->data };
 331   byte *K, *D;
 332   uns Kl, Dl, sz, i;
 333
 334   while (sp < s->data + s->used)
 335     {
 336       sz = sdbm_get_entry(d, sp, &K, &Kl, &D, &Dl);
 337       sp += sz;
 338       i = (sdbm_hash(K, Kl) & (1 << sigbit)) ? 1 : 0;
 339       sdbm_store_entry(d, dp[i], K, Kl, D, Dl);
 340       dp[i] += sz;
 341     }
 342   d0->used = dp[0] - d0->data;
 343   d1->used = dp[1] - d1->data;
 344 }
 345
 346 static void
 347 sdbm_split_dir(struct sdbm *d, uns dirpos, uns count, uns pos)
 348 {
 349   struct page *b;
 350   uns i;
 351
 352   count *= 4;
 353   while (count)
 354     {
 355       b = pgc_read(d->cache, d->fd, d->root->dir_start + (dirpos & ~d->page_mask));
 356       i = d->page_size - (dirpos & d->page_mask);
 357       if (i > count)
 358         i = count;
 359       count -= i;
 360       while (i)
 361         {
 362           GET32(b->data, dirpos & d->page_mask) = pos;
 363           dirpos += 4;
 364           i -= 4;
 365         }
 366       pgc_mark_dirty(d->cache, b);
 367       pgc_put(d->cache, b);
 368     }
 369 }
 370
 371 static struct page *
 372 sdbm_split_page(struct sdbm *d, struct page *b, u32 hash, uns dirpos)
 373 {
 374   struct page *p[2];
 375   uns i, rank, sigbit, rank_log;
 376
 377   rank = sdbm_page_rank(d, dirpos);     /* rank = # of pointers to this page */
 378   if (rank == 1)
 379     {
 380       sdbm_expand_directory(d);
 381       rank = 2;
 382       dirpos *= 2;
 383     }
 384   rank_log = 1;                         /* rank_log = log2(rank) */
 385   while ((1 << rank_log) < rank)
 386     rank_log++;
 387   sigbit = d->dir_shift + rank_log - 1; /* sigbit = bit we split on */
 388   p[0] = b;
 389   p[1] = pgc_get_zero(d->cache, d->fd, sdbm_alloc_page(d));
 390   sdbm_split_data(d, (void *) b->data, (void *) p[0]->data, (void *) p[1]->data, sigbit);
 391   sdbm_split_dir(d, (dirpos & ~(4*rank - 1))+2*rank, rank/2, pgc_page_pos(d->cache, p[1]));
 392   pgc_mark_dirty(d->cache, p[0]);
 393   i = (hash & (1 << sigbit)) ? 1 : 0;
 394   pgc_put(d->cache, p[!i]);
 395   return p[i];
 396 }
 397
 398 static int
 399 sdbm_access(struct sdbm *d, byte *key, uns keylen, byte *val, uns *vallen, uns mode)    /* 0=read, 1=store, 2=replace */
 400 {
 401   struct page *p, *q;
 402   u32 hash, h, pos, size;
 403   struct sdbm_bucket *b;
 404   byte *c, *e;
 405   int rc;
 406
 407   if ((d->key_size >= 0 && keylen != d->key_size) || keylen > 65535)
 408     return SDBM_ERROR_BAD_KEY_SIZE;
 409   if (val && ((d->val_size >= 0 && *vallen != d->val_size) || *vallen >= 65535))
 410     return SDBM_ERROR_BAD_VAL_SIZE;
 411   if (!mode && !(d->flags & SDBM_WRITE))
 412     return SDBM_ERROR_READ_ONLY;
 413   hash = sdbm_hash(key, keylen);
 414   if (d->dir_shift != 32)               /* avoid shifting by 32 bits */
 415     h = (hash >> d->dir_shift) << 2;    /* offset in the directory */
 416   else
 417     h = 0;
 418   p = pgc_read(d->cache, d->fd, d->root->dir_start + (h & ~d->page_mask));
 419   pos = GET32(p->data, h & d->page_mask);
 420   pgc_put(d->cache, p);
 421   q = pgc_read(d->cache, d->fd, pos);
 422   b = (void *) q->data;
 423   c = b->data;
 424   e = c + b->used;
 425   while (c < e)
 426     {
 427       byte *K, *D;
 428       uns Kl, Dl, s;
 429       s = sdbm_get_entry(d, c, &K, &Kl, &D, &Dl);
 430       if (Kl == keylen && !memcmp(K, key, Kl))
 431         {
 432           /* Gotcha! */
 433           switch (mode)
 434             {
 435             case 0:                     /* fetch: found */
 436               rc = 1;
 437               if (vallen)
 438                 {
 439                   if (*vallen < Dl)
 440                     rc = -3;
 441                   *vallen = Dl;
 442                 }
 443               if (val)
 444                 memcpy(val, D, Dl);
 445               pgc_put(d->cache, q);
 446               return rc;
 447             case 1:                     /* store: already present */
 448               pgc_put(d->cache, q);
 449               return 0;
 450             default:                    /* replace: delete the old one */
 451               memmove(c, c+s, e-(c+s));
 452               b->used -= s;
 453               goto insert;
 454             }
 455         }
 456       c += s;
 457     }
 458   if (!mode || !val)            /* fetch or delete: no success */
 459     {
 460       pgc_put(d->cache, q);
 461       return 0;
 462     }
 463
 464 insert:
 465   if (val)
 466     {
 467       size = sdbm_entry_len(d, keylen, *vallen);
 468       while (b->used + size > d->page_size - sizeof(struct sdbm_bucket))
 469         {
 470           /* Page overflow, need to split */
 471           q = sdbm_split_page(d, q, hash, h);
 472           b = (void *) q->data;
 473         }
 474       sdbm_store_entry(d, b->data + b->used, key, keylen, val, *vallen);
 475       b->used += size;
 476     }
 477   pgc_mark_dirty(d->cache, q);
 478   pgc_put(d->cache, q);
 479   if (d->flags & SDBM_SYNC)
 480     sdbm_sync(d);
 481   return 1;
 482 }
 483
 484 int
 485 sdbm_store(struct sdbm *d, byte *key, uns keylen, byte *val, uns vallen)
 486 {
 487   return sdbm_access(d, key, keylen, val, &vallen, 1);
 488 }
 489
 490 int
 491 sdbm_replace(struct sdbm *d, byte *key, uns keylen, byte *val, uns vallen)
 492 {
 493   return sdbm_access(d, key, keylen, val, &vallen, 2);
 494 }
 495
 496 int
 497 sdbm_delete(struct sdbm *d, byte *key, uns keylen)
 498 {
 499   return sdbm_access(d, key, keylen, NULL, NULL, 2);
 500 }
 501
 502 int
 503 sdbm_fetch(struct sdbm *d, byte *key, uns keylen, byte *val, uns *vallen)
 504 {
 505   return sdbm_access(d, key, keylen, val, vallen, 0);
 506 }
 507
 508 void
 509 sdbm_rewind(struct sdbm *d)
 510 {
 511 }
 512
 513 int
 514 sdbm_get_next(struct sdbm *d, byte *key, uns *keylen, byte *val, uns *vallen)
 515 {
 516   return 0;
 517 }
 518
 519 void
 520 sdbm_sync(struct sdbm *d)
 521 {
 522   pgc_flush(d->cache);
 523   if (d->flags & SDBM_FSYNC)
 524     fsync(d->fd);
 525 }
 526
 527 #ifdef TEST
 528
 529 int main(void)
 530 {
 531   struct sdbm *d;
 532   struct sdbm_options o = {
 533     name: "db.test",
 534     flags: SDBM_CREAT | SDBM_WRITE,
 535     page_order: 10,
 536     cache_size: 1024,
 537     key_size: -1,
 538     val_size: -1
 539   };
 540   byte buf[256];
 541   int i, j, k;
 542
 543   puts("OPEN");
 544   d = sdbm_open(&o);
 545   if (!d)
 546     die("failed: %m");
 547
 548   puts("WRITE");
 549   for(i=0; i<1000000; i++)
 550     {
 551       sprintf(buf, "%d", i);
 552       k = sdbm_store(d, buf, strlen(buf), (byte *) &i, sizeof(i));
 553 //      printf("%s:%d\r", buf, k);
 554       fflush(stdout);
 555     }
 556   sdbm_sync(d);
 557
 558   puts("READ");
 559   for(i=0; i<1000000; i++)
 560     {
 561       sprintf(buf, "%d", i);
 562       j = sdbm_fetch(d, buf, strlen(buf), NULL, NULL);
 563 //      printf("%s:%d\r", buf, j);
 564       fflush(stdout);
 565       if (!j)
 566         { printf("\nERR: %s %d %x %d\n", buf, j, sdbm_hash(buf, strlen(buf)), d->dir_shift); return 1; }
 567     }
 568   puts("");
 569
 570   puts("CLOSE");
 571   sdbm_close(d);
 572   puts("DONE");
 573   return 0;
 574 }
 575
 576 #endif