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