lib/bucket.c

   1 /*
   2  *      Sherlock Library -- Object Buckets
   3  *
   4  *      (c) 2001--2004 Martin Mares <mj@ucw.cz>
   5  *
   6  *      This software may be freely distributed and used according to the terms
   7  *      of the GNU Lesser General Public License.
   8  */
   9
  10 #undef LOCAL_DEBUG
  11
  12 #include "lib/lib.h"
  13 #include "lib/bucket.h"
  14 #include "lib/fastbuf.h"
  15 #include "lib/lfs.h"
  16 #include "lib/conf.h"
  17
  18 #include <string.h>
  19 #include <stdlib.h>
  20 #include <fcntl.h>
  21 #include <unistd.h>
  22 #include <sys/file.h>
  23 #include <alloca.h>
  24
  25 static int obuck_fd;
  26 static struct obuck_header obuck_hdr, obuck_create_hdr;
  27 static sh_off_t bucket_find_pos;
  28 static struct fastbuf *obuck_write_fb;
  29
  30 /*** Configuration ***/
  31
  32 byte *obuck_name = "not/configured";
  33 static uns obuck_io_buflen = 65536;
  34 static int obuck_shake_buflen = 1048576;
  35 static uns obuck_shake_security;
  36 static uns obuck_slurp_buflen = 65536;
  37
  38 static struct cfitem obuck_config[] = {
  39   { "Buckets",          CT_SECTION,     NULL },
  40   { "BucketFile",       CT_STRING,      &obuck_name },
  41   { "BufSize",          CT_INT,         &obuck_io_buflen },
  42   { "ShakeBufSize",     CT_INT,         &obuck_shake_buflen },
  43   { "ShakeSecurity",    CT_INT,         &obuck_shake_security },
  44   { "SlurpBufSize",     CT_INT,         &obuck_slurp_buflen },
  45   { NULL,               CT_STOP,        NULL }
  46 };
  47
  48 static void CONSTRUCTOR obuck_init_config(void)
  49 {
  50   cf_register(obuck_config);
  51 }
  52
  53 /*** Internal operations ***/
  54
  55 static void
  56 obuck_broken(char *msg, sh_off_t pos)
  57 {
  58   die("Object pool corrupted: %s (pos=%Lx)", msg, (long long) pos);
  59 }
  60
  61 /*
  62  *  Unfortunately we cannot use flock() here since it happily permits
  63  *  locking a shared fd (e.g., after fork()) multiple times. The fcntl
  64  *  locks are very ugly and they don't support 64-bit offsets, but we
  65  *  can work around the problem by always locking the first header
  66  *  in the file.
  67  */
  68
  69 static inline void
  70 obuck_do_lock(int type)
  71 {
  72   struct flock fl;
  73
  74   fl.l_type = type;
  75   fl.l_whence = SEEK_SET;
  76   fl.l_start = 0;
  77   fl.l_len = sizeof(struct obuck_header);
  78   if (fcntl(obuck_fd, F_SETLKW, &fl) < 0)
  79     die("fcntl lock: %m");
  80 }
  81
  82 inline void
  83 obuck_lock_read(void)
  84 {
  85   obuck_do_lock(F_RDLCK);
  86 }
  87
  88 inline void
  89 obuck_lock_write(void)
  90 {
  91   obuck_do_lock(F_WRLCK);
  92 }
  93
  94 inline void
  95 obuck_unlock(void)
  96 {
  97   obuck_do_lock(F_UNLCK);
  98 }
  99
 100 /*** FastIO emulation ***/
 101
 102 struct fb_bucket {
 103   struct fastbuf fb;
 104   sh_off_t start_pos;
 105   uns bucket_size;
 106   byte buffer[0];
 107 };
 108 #define FB_BUCKET(f) ((struct fb_bucket *)(f)->is_fastbuf)
 109
 110 static int obuck_fb_count;
 111
 112 static void
 113 obuck_fb_close(struct fastbuf *f)
 114 {
 115   obuck_fb_count--;
 116   xfree(f);
 117 }
 118
 119 /* We need to use pread/pwrite since we work on fd's shared between processes */
 120
 121 static int
 122 obuck_fb_refill(struct fastbuf *f)
 123 {
 124   uns remains, bufsize, size, datasize;
 125
 126   remains = FB_BUCKET(f)->bucket_size - (uns)f->pos;
 127   bufsize = f->bufend - f->buffer;
 128   if (!remains)
 129     return 0;
 130   sh_off_t start = FB_BUCKET(f)->start_pos;
 131   sh_off_t pos = start + sizeof(struct obuck_header) + f->pos;
 132   if (remains <= bufsize)
 133     {
 134       datasize = remains;
 135       size = start + obuck_bucket_size(FB_BUCKET(f)->bucket_size) - pos;
 136     }
 137   else
 138     size = datasize = bufsize;
 139   int l = sh_pread(obuck_fd, f->buffer, size, pos);
 140   if (l < 0)
 141     die("Error reading bucket: %m");
 142   if ((unsigned) l != size)
 143     obuck_broken("Short read", FB_BUCKET(f)->start_pos);
 144   f->bptr = f->buffer;
 145   f->bstop = f->buffer + datasize;
 146   f->pos += datasize;
 147   if (datasize < size)
 148     {
 149       if (GET_U32(f->buffer + size - 4) != OBUCK_TRAILER)
 150         obuck_broken("Missing trailer", FB_BUCKET(f)->start_pos);
 151     }
 152   return datasize;
 153 }
 154
 155 static void
 156 obuck_fb_spout(struct fastbuf *f)
 157 {
 158   int l = f->bptr - f->buffer;
 159   char *c = f->buffer;
 160
 161   while (l)
 162     {
 163       int z = sh_pwrite(obuck_fd, c, l, FB_BUCKET(f)->start_pos + sizeof(struct obuck_header) + f->pos);
 164       if (z <= 0)
 165         die("Error writing bucket: %m");
 166       f->pos += z;
 167       l -= z;
 168       c += z;
 169     }
 170   f->bptr = f->buffer;
 171 }
 172
 173 /*** Exported functions ***/
 174
 175 void
 176 obuck_init(int writeable)
 177 {
 178   sh_off_t size;
 179
 180   obuck_fd = sh_open(obuck_name, (writeable ? O_RDWR | O_CREAT : O_RDONLY), 0666);
 181   if (obuck_fd < 0)
 182     die("Unable to open bucket file %s: %m", obuck_name);
 183   obuck_lock_read();
 184   size = sh_seek(obuck_fd, 0, SEEK_END);
 185   if (size)
 186     {
 187       /* If the bucket pool is not empty, check consistency of its end */
 188       u32 check;
 189       if (sh_pread(obuck_fd, &check, 4, size-4) != 4 ||
 190           check != OBUCK_TRAILER)
 191         obuck_broken("Missing trailer of last object", size - 4);
 192     }
 193   obuck_unlock();
 194 }
 195
 196 void
 197 obuck_cleanup(void)
 198 {
 199   close(obuck_fd);
 200   if (obuck_fb_count)
 201     log(L_ERROR, "Bug: Unbalanced bucket opens/closes: %d streams remain", obuck_fb_count);
 202   if (obuck_write_fb)
 203     log(L_ERROR, "Bug: Forgot to close bucket write stream");
 204 }
 205
 206 void
 207 obuck_sync(void)
 208 {
 209   if (obuck_write_fb)
 210     bflush(obuck_write_fb);
 211   fsync(obuck_fd);
 212 }
 213
 214 static void
 215 obuck_get(oid_t oid)
 216 {
 217   bucket_find_pos = obuck_get_pos(oid);
 218   if (sh_pread(obuck_fd, &obuck_hdr, sizeof(obuck_hdr), bucket_find_pos) != sizeof(obuck_hdr))
 219     obuck_broken("Short header read", bucket_find_pos);
 220   if (obuck_hdr.magic != OBUCK_MAGIC)
 221     obuck_broken("Missing magic number", bucket_find_pos);
 222   if (obuck_hdr.oid == OBUCK_OID_DELETED)
 223     obuck_broken("Access to deleted bucket", bucket_find_pos);
 224   if (obuck_hdr.oid != oid)
 225     obuck_broken("Invalid backlink", bucket_find_pos);
 226 }
 227
 228 void
 229 obuck_find_by_oid(struct obuck_header *hdrp)
 230 {
 231   oid_t oid = hdrp->oid;
 232
 233   ASSERT(oid < OBUCK_OID_FIRST_SPECIAL);
 234   obuck_lock_read();
 235   obuck_get(oid);
 236   obuck_unlock();
 237   memcpy(hdrp, &obuck_hdr, sizeof(obuck_hdr));
 238 }
 239
 240 int
 241 obuck_find_first(struct obuck_header *hdrp, int full)
 242 {
 243   bucket_find_pos = 0;
 244   obuck_hdr.magic = 0;
 245   return obuck_find_next(hdrp, full);
 246 }
 247
 248 int
 249 obuck_find_next(struct obuck_header *hdrp, int full)
 250 {
 251   int c;
 252
 253   for(;;)
 254     {
 255       if (obuck_hdr.magic)
 256         bucket_find_pos += obuck_bucket_size(obuck_hdr.length);
 257       obuck_lock_read();
 258       c = sh_pread(obuck_fd, &obuck_hdr, sizeof(obuck_hdr), bucket_find_pos);
 259       obuck_unlock();
 260       if (!c)
 261         return 0;
 262       if (c != sizeof(obuck_hdr))
 263         obuck_broken("Short header read", bucket_find_pos);
 264       if (obuck_hdr.magic != OBUCK_MAGIC)
 265         obuck_broken("Missing magic number", bucket_find_pos);
 266       if (obuck_hdr.oid != OBUCK_OID_DELETED || full)
 267         {
 268           memcpy(hdrp, &obuck_hdr, sizeof(obuck_hdr));
 269           return 1;
 270         }
 271     }
 272 }
 273
 274 struct fastbuf *
 275 obuck_fetch(void)
 276 {
 277   struct fastbuf *b;
 278   uns official_buflen = ALIGN(MIN(obuck_hdr.length, obuck_io_buflen), OBUCK_ALIGN);
 279   uns real_buflen = official_buflen + OBUCK_ALIGN;
 280
 281   b = xmalloc(sizeof(struct fb_bucket) + real_buflen);
 282   b->buffer = b->bptr = b->bstop = FB_BUCKET(b)->buffer;
 283   b->bufend = b->buffer + official_buflen;
 284   b->name = "bucket-read";
 285   b->pos = 0;
 286   b->refill = obuck_fb_refill;
 287   b->spout = NULL;
 288   b->seek = NULL;
 289   b->close = obuck_fb_close;
 290   b->config = NULL;
 291   FB_BUCKET(b)->start_pos = bucket_find_pos;
 292   FB_BUCKET(b)->bucket_size = obuck_hdr.length;
 293   obuck_fb_count++;
 294   return b;
 295 }
 296
 297 oid_t
 298 obuck_predict_last_oid(void)
 299 {
 300   sh_off_t size = sh_seek(obuck_fd, 0, SEEK_END);
 301   return (oid_t)(size >> OBUCK_SHIFT);
 302 }
 303
 304 struct fastbuf *
 305 obuck_create(u32 type)
 306 {
 307   ASSERT(!obuck_write_fb);
 308
 309   obuck_lock_write();
 310   sh_off_t start = sh_seek(obuck_fd, 0, SEEK_END);
 311   if (start & (OBUCK_ALIGN - 1))
 312     obuck_broken("Misaligned file", start);
 313   obuck_create_hdr.magic = OBUCK_INCOMPLETE_MAGIC;
 314   obuck_create_hdr.oid = start >> OBUCK_SHIFT;
 315   obuck_create_hdr.length = 0;
 316   obuck_create_hdr.type = type;
 317
 318   struct fastbuf *b = xmalloc(sizeof(struct fb_bucket) + obuck_io_buflen);
 319   obuck_write_fb = b;
 320   b->buffer = FB_BUCKET(b)->buffer;
 321   b->bptr = b->bstop = b->buffer;
 322   b->bufend = b->buffer + obuck_io_buflen;
 323   b->pos = -(int)sizeof(obuck_create_hdr);
 324   b->name = "bucket-write";
 325   b->refill = NULL;
 326   b->spout = obuck_fb_spout;
 327   b->seek = NULL;
 328   b->close = NULL;
 329   b->config = NULL;
 330   FB_BUCKET(b)->start_pos = start;
 331   FB_BUCKET(b)->bucket_size = 0;
 332   bwrite(b, &obuck_create_hdr, sizeof(obuck_create_hdr));
 333
 334   return b;
 335 }
 336
 337 void
 338 obuck_create_end(struct fastbuf *b, struct obuck_header *hdrp)
 339 {
 340   ASSERT(b == obuck_write_fb);
 341   obuck_write_fb = NULL;
 342
 343   obuck_create_hdr.magic = OBUCK_MAGIC;
 344   obuck_create_hdr.length = btell(b);
 345   int pad = (OBUCK_ALIGN - sizeof(obuck_create_hdr) - obuck_create_hdr.length - 4) & (OBUCK_ALIGN - 1);
 346   while (pad--)
 347     bputc(b, 0);
 348   bputl(b, OBUCK_TRAILER);
 349   bflush(b);
 350   ASSERT(!((FB_BUCKET(b)->start_pos + sizeof(obuck_create_hdr) + b->pos) & (OBUCK_ALIGN - 1)));
 351   if (sh_pwrite(obuck_fd, &obuck_create_hdr, sizeof(obuck_create_hdr), FB_BUCKET(b)->start_pos) != sizeof(obuck_create_hdr))
 352     die("Bucket header update failed: %m");
 353   obuck_unlock();
 354   memcpy(hdrp, &obuck_create_hdr, sizeof(obuck_create_hdr));
 355   xfree(b);
 356 }
 357
 358 void
 359 obuck_delete(oid_t oid)
 360 {
 361   obuck_lock_write();
 362   obuck_get(oid);
 363   obuck_hdr.oid = OBUCK_OID_DELETED;
 364   sh_pwrite(obuck_fd, &obuck_hdr, sizeof(obuck_hdr), bucket_find_pos);
 365   obuck_unlock();
 366 }
 367
 368 /*** Fast reading of the whole pool ***/
 369
 370 static struct fastbuf *obuck_rpf;
 371 static uns slurp_remains;
 372 static sh_off_t slurp_start, slurp_current;
 373
 374 static int
 375 obuck_slurp_refill(struct fastbuf *f)
 376 {
 377   uns l;
 378
 379   if (!slurp_remains)
 380     return 0;
 381   l = bdirect_read_prepare(obuck_rpf, &f->buffer);
 382   if (!l)
 383     obuck_broken("Incomplete object", slurp_start);
 384   l = MIN(l, slurp_remains);
 385   bdirect_read_commit(obuck_rpf, f->buffer + l);
 386   slurp_remains -= l;
 387   f->bptr = f->buffer;
 388   f->bufend = f->bstop = f->buffer + l;
 389   return 1;
 390 }
 391
 392 struct fastbuf *
 393 obuck_slurp_pool(struct obuck_header *hdrp)
 394 {
 395   static struct fastbuf limiter;
 396   uns l;
 397
 398   do
 399     {
 400       if (!obuck_rpf)
 401         {
 402           obuck_lock_read();
 403           obuck_rpf = bopen(obuck_name, O_RDONLY, obuck_slurp_buflen);
 404         }
 405       else
 406         {
 407           bsetpos(obuck_rpf, slurp_current - 4);
 408           if (bgetl(obuck_rpf) != OBUCK_TRAILER)
 409             obuck_broken("Missing trailer", slurp_start);
 410         }
 411       slurp_start = btell(obuck_rpf);
 412       l = bread(obuck_rpf, hdrp, sizeof(struct obuck_header));
 413       if (!l)
 414         {
 415           bclose(obuck_rpf);
 416           obuck_rpf = NULL;
 417           obuck_unlock();
 418           return NULL;
 419         }
 420       if (l != sizeof(struct obuck_header))
 421         obuck_broken("Short header read", slurp_start);
 422       if (hdrp->magic != OBUCK_MAGIC)
 423         obuck_broken("Missing magic number", slurp_start);
 424       slurp_current = slurp_start + obuck_bucket_size(hdrp->length);
 425     }
 426   while (hdrp->oid == OBUCK_OID_DELETED);
 427   if (obuck_get_pos(hdrp->oid) != slurp_start)
 428     obuck_broken("Invalid backlink", slurp_start);
 429   slurp_remains = hdrp->length;
 430   limiter.bptr = limiter.bstop = limiter.buffer = limiter.bufend = NULL;
 431   limiter.name = "Bucket";
 432   limiter.pos = 0;
 433   limiter.refill = obuck_slurp_refill;
 434   return &limiter;
 435 }
 436
 437 /*** Shakedown ***/
 438
 439 static inline void
 440 shake_write(void *addr, int len, sh_off_t pos)
 441 {
 442   int l = sh_pwrite(obuck_fd, addr, len, pos);
 443   if (l != len)
 444     {
 445       if (l < 0)
 446         die("obuck_shakedown write error: %m");
 447       else
 448         die("obuck_shakedown write error: disk full");
 449     }
 450 }
 451
 452 static inline void
 453 shake_sync(void)
 454 {
 455   if (obuck_shake_security > 1)
 456     fdatasync(obuck_fd);
 457 }
 458
 459 static void
 460 shake_write_backup(sh_off_t bpos, byte *norm_buf, int norm_size, byte *fragment, int frag_size, sh_off_t frag_pos, int more_size)
 461 {
 462   struct obuck_header *bhdr;
 463   int boff = 0;
 464   int l;
 465   oid_t old_oid;
 466
 467   /* First of all, the "normal" part -- everything that will be written in this pass */
 468   DBG("Backing up first round of changes at position %Lx + %x", (long long) bpos, norm_size);
 469   while (boff < norm_size)
 470     {
 471       /* This needn't be optimized for speed. */
 472       bhdr = (struct obuck_header *) (norm_buf + boff);
 473       ASSERT(bhdr->magic == OBUCK_MAGIC);
 474       l = obuck_bucket_size(bhdr->length);
 475       old_oid = bhdr->oid;
 476       bhdr->oid = bpos >> OBUCK_SHIFT;
 477       shake_write(bhdr, l, bpos);
 478       bhdr->oid = old_oid;
 479       boff += l;
 480       bpos += l;
 481     }
 482
 483   /* If we have an incomplete bucket at the end of the buffer, we must copy it as well. */
 484   if (more_size)
 485     {
 486       DBG("Backing up fragment of size %x and %x more", frag_size, more_size);
 487
 488       /* First the part we already have in the buffer */
 489       bhdr = (struct obuck_header *) fragment;
 490       ASSERT(bhdr->magic == OBUCK_MAGIC);
 491       old_oid = bhdr->oid;
 492       bhdr->oid = bpos >> OBUCK_SHIFT;
 493       shake_write(bhdr, frag_size, bpos);
 494       bhdr->oid = old_oid;
 495       bpos += frag_size;
 496
 497       /* And then the rest, using a small 64K buffer */
 498       byte *auxbuf = alloca(65536);
 499       l = 0;
 500       while (l < more_size)
 501         {
 502           int j = MIN(more_size-l, 65536);
 503           if (sh_pread(obuck_fd, auxbuf, j, frag_pos + frag_size + l) != j)
 504             die("obuck_shakedown read error: %m");
 505           shake_write(auxbuf, j, bpos);
 506           bpos += j;
 507           l += j;
 508         }
 509     }
 510 }
 511
 512 static void
 513 shake_erase(sh_off_t start, sh_off_t end)
 514 {
 515   if (start > end)
 516     die("shake_erase called with negative length, that's a bug");
 517   ASSERT(!(start & (OBUCK_ALIGN-1)) && !(end & (OBUCK_ALIGN-1)));
 518   while (start < end)
 519     {
 520       u32 check = OBUCK_TRAILER;
 521       obuck_hdr.magic = OBUCK_MAGIC;
 522       obuck_hdr.oid = OBUCK_OID_DELETED;
 523       uns len = MIN(0x40000000, end-start);
 524       obuck_hdr.length = len - sizeof(obuck_hdr) - 4;
 525       DBG("Erasing %08x bytes at %Lx", len, (long long) start);
 526       shake_write(&obuck_hdr, sizeof(obuck_hdr), start);
 527       start += len;
 528       shake_write(&check, 4, start-4);
 529     }
 530 }
 531
 532 void
 533 obuck_shakedown(int (*kibitz)(struct obuck_header *old, oid_t new, byte *buck))
 534 {
 535   byte *buf;                                            /* Shakedown buffer and its size */
 536   int buflen = ALIGN(obuck_shake_buflen, OBUCK_ALIGN);
 537   byte *msg;                                            /* Error message we will print */
 538   sh_off_t rstart, wstart;                              /* Original and new position of buffer start */
 539   sh_off_t r_bucket_start, w_bucket_start;              /* Original and new position of the current bucket */
 540   int roff, woff;                                       /* Orig/new position of the current bucket relative to buffer start */
 541   int rsize;                                            /* Number of original bytes in the buffer */
 542   int l;                                                /* Raw size of the current bucket */
 543   int changed = 0;                                      /* "Something has been altered" flag */
 544   int wrote_anything = 0;                               /* We already did a write to the bucket file */
 545   struct obuck_header *rhdr, *whdr;                     /* Original and new address of header of the current bucket */
 546   sh_off_t r_file_size;                                 /* Original size of the bucket file */
 547   int more;                                             /* How much does the last bucket overlap the buffer */
 548
 549   buf = xmalloc(buflen);
 550   rstart = wstart = 0;
 551   roff = woff = rsize = 0;
 552
 553   /* We need to be the only accessor, all the object ID's are becoming invalid */
 554   obuck_lock_write();
 555   r_file_size = sh_seek(obuck_fd, 0, SEEK_END);
 556   ASSERT(!(r_file_size & (OBUCK_ALIGN - 1)));
 557   if (r_file_size >= (0x100000000 << OBUCK_SHIFT) - buflen)
 558     die("Bucket file is too large for safe shakedown. Shaking down with Bucket.ShakeSecurity=0 will still work.");
 559
 560   DBG("Starting shakedown. Buffer size is %d, original length %Lx", buflen, (long long) r_file_size);
 561
 562   for(;;)
 563     {
 564       r_bucket_start = rstart + roff;
 565       w_bucket_start = wstart + woff;
 566       rhdr = (struct obuck_header *)(buf + roff);
 567       whdr = (struct obuck_header *)(buf + woff);
 568       if (roff == rsize)
 569         {
 570           more = 0;
 571           goto next;
 572         }
 573       if (rhdr->magic != OBUCK_MAGIC ||
 574           rhdr->oid != OBUCK_OID_DELETED && rhdr->oid != (oid_t)(r_bucket_start >> OBUCK_SHIFT))
 575         {
 576           msg = "header mismatch";
 577           goto broken;
 578         }
 579       l = obuck_bucket_size(rhdr->length);
 580       if (l > buflen)
 581         {
 582           if (rhdr->oid != OBUCK_OID_DELETED)
 583             {
 584               msg = "bucket longer than ShakeBufSize";
 585               goto broken;
 586             }
 587           /* Empty buckets are allowed to be large, but we need to handle them extra */
 588           DBG("Tricking around an extra-large empty bucket at %Lx + %x", (long long)r_bucket_start, l);
 589           rsize = roff + l;
 590         }
 591       else
 592         {
 593           if (rsize - roff < l)
 594             {
 595               more = l - (rsize - roff);
 596               goto next;
 597             }
 598           if (GET_U32((byte *)rhdr + l - 4) != OBUCK_TRAILER)
 599             {
 600               msg = "missing trailer";
 601               goto broken;
 602             }
 603         }
 604       if (rhdr->oid != OBUCK_OID_DELETED)
 605         {
 606           int status = kibitz(rhdr, w_bucket_start >> OBUCK_SHIFT, (byte *)(rhdr+1));
 607           if (status)
 608             {
 609               int lnew = l;
 610               if (status > 1)
 611                 {
 612                   /* Changed! Reconstruct the trailer. */
 613                   lnew = obuck_bucket_size(rhdr->length);
 614                   ASSERT(lnew <= l);
 615                   PUT_U32((byte *)rhdr + lnew - 4, OBUCK_TRAILER);
 616                   changed = 1;
 617                 }
 618               whdr = (struct obuck_header *)(buf+woff);
 619               if (rhdr != whdr)
 620                 memmove(whdr, rhdr, lnew);
 621               whdr->oid = w_bucket_start >> OBUCK_SHIFT;
 622               woff += lnew;
 623             }
 624           else
 625             changed = 1;
 626         }
 627       else
 628         {
 629           kibitz(rhdr, OBUCK_OID_DELETED, NULL);
 630           changed = 1;
 631         }
 632       roff += l;
 633       continue;
 634
 635     next:
 636       if (changed)
 637         {
 638           /* Write the new contents of the bucket file */
 639           if (!wrote_anything)
 640             {
 641               if (obuck_shake_security)
 642                 {
 643                   /* But first write a backup at the end of the file to ensure nothing can be lost. */
 644                   shake_write_backup(r_file_size, buf, woff, buf+roff, rsize-roff, rstart+roff, more);
 645                   shake_sync();
 646                 }
 647               wrote_anything = 1;
 648             }
 649           if (woff)
 650             {
 651               DBG("Write %Lx %x", wstart, woff);
 652               shake_write(buf, woff, wstart);
 653               shake_sync();
 654             }
 655         }
 656       else
 657         ASSERT(wstart == rstart);
 658
 659       /* In any case, update the write position */
 660       wstart += woff;
 661       woff = 0;
 662
 663       /* Skip what's been read and if there is any fragment at the end of the buffer, move it to the start */
 664       rstart += roff;
 665       if (more)
 666         {
 667           memmove(buf, buf+roff, rsize-roff);
 668           rsize = rsize-roff;
 669         }
 670       else
 671         rsize = 0;
 672
 673       /* And refill the buffer */
 674       r_bucket_start = rstart+rsize;    /* Also needed for error messages */
 675       l = sh_pread(obuck_fd, buf+rsize, MIN(buflen-rsize, r_file_size - r_bucket_start), r_bucket_start);
 676       DBG("Read  %Lx %x (%x inherited)", (long long)r_bucket_start, l, rsize);
 677       if (l < 0)
 678         die("obuck_shakedown read error: %m");
 679       if (!l)
 680         {
 681           if (!more)
 682             break;
 683           msg = "unexpected EOF";
 684           goto broken;
 685         }
 686       if (l & (OBUCK_ALIGN-1))
 687         {
 688           msg = "garbage at the end of file";
 689           goto broken;
 690         }
 691       rsize += l;
 692       roff = 0;
 693     }
 694
 695   DBG("Finished at position %Lx", (long long) wstart);
 696   sh_ftruncate(obuck_fd, wstart);
 697   shake_sync();
 698
 699   obuck_unlock();
 700   xfree(buf);
 701   return;
 702
 703  broken:
 704   log(L_ERROR, "Error during object pool shakedown: %s (pos=%Ld, id=%x), gathering debris",
 705       msg, (long long) r_bucket_start, (uns)(r_bucket_start >> OBUCK_SHIFT));
 706   /*
 707    * We can attempt to clean up the bucket file by erasing everything between the last
 708    * byte written and the next byte to be read. If the secure mode is switched on, we can
 709    * guarantee that no data are lost, only some might be duplicated.
 710    */
 711   shake_erase(wstart, rstart);
 712   die("Fatal error during object pool shakedown");
 713 }
 714
 715 /*** Testing ***/
 716
 717 #ifdef TEST
 718
 719 #define COUNT 5000
 720 #define MAXLEN 10000
 721 #define KILLPERC 13
 722 #define LEN(i) ((259309*(i))%MAXLEN)
 723
 724 static int test_kibitz(struct obuck_header *h, oid_t new, byte *buck)
 725 {
 726   return 1;
 727 }
 728
 729 int main(int argc, char **argv)
 730 {
 731   int ids[COUNT];
 732   unsigned int i, j, cnt;
 733   struct obuck_header h;
 734   struct fastbuf *b;
 735
 736   log_init(NULL);
 737   if (cf_getopt(argc, argv, CF_SHORT_OPTS, CF_NO_LONG_OPTS, NULL) >= 0 ||
 738       optind < argc)
 739   {
 740     fputs("This program supports only the following command-line arguments:\n" CF_USAGE, stderr);
 741     exit(1);
 742   }
 743
 744   unlink(obuck_name);
 745   obuck_init(1);
 746   for(j=0; j<COUNT; j++)
 747     {
 748       b = obuck_create(BUCKET_TYPE_PLAIN);
 749       for(i=0; i<LEN(j); i++)
 750         bputc(b, (i+j) % 256);
 751       obuck_create_end(b, &h);
 752       printf("Writing %08x %d\n", h.oid, h.length);
 753       ids[j] = h.oid;
 754     }
 755   for(j=0; j<COUNT; j++)
 756     if (j % 100 < KILLPERC)
 757       {
 758         printf("Deleting %08x\n", ids[j]);
 759         obuck_delete(ids[j]);
 760       }
 761   cnt = 0;
 762   for(j=0; j<COUNT; j++)
 763     if (j % 100 >= KILLPERC)
 764       {
 765         cnt++;
 766         h.oid = ids[j];
 767         obuck_find_by_oid(&h);
 768         b = obuck_fetch();
 769         printf("Reading %08x %d\n", h.oid, h.length);
 770         if (h.length != LEN(j))
 771           die("Invalid length");
 772         for(i=0; i<h.length; i++)
 773           if ((unsigned) bgetc(b) != (i+j) % 256)
 774             die("Contents mismatch");
 775         if (bgetc(b) != EOF)
 776           die("EOF mismatch");
 777         bclose(b);
 778       }
 779   obuck_shakedown(test_kibitz);
 780   if (obuck_find_first(&h, 0))
 781     do
 782       {
 783         printf("<<< %08x\t%d\n", h.oid, h.length);
 784         cnt--;
 785       }
 786     while (obuck_find_next(&h, 0));
 787   if (cnt)
 788     die("Walk mismatch");
 789   obuck_cleanup();
 790   return 0;
 791 }
 792
 793 #endif