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 + ALIGN(FB_BUCKET(f)->bucket_size + sizeof(struct obuck_header) + 4, OBUCK_ALIGN) - 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 = (bucket_find_pos + sizeof(obuck_hdr) + obuck_hdr.length +
 257                            4 + OBUCK_ALIGN - 1) & ~((sh_off_t)(OBUCK_ALIGN - 1));
 258       obuck_lock_read();
 259       c = sh_pread(obuck_fd, &obuck_hdr, sizeof(obuck_hdr), bucket_find_pos);
 260       obuck_unlock();
 261       if (!c)
 262         return 0;
 263       if (c != sizeof(obuck_hdr))
 264         obuck_broken("Short header read", bucket_find_pos);
 265       if (obuck_hdr.magic != OBUCK_MAGIC)
 266         obuck_broken("Missing magic number", bucket_find_pos);
 267       if (obuck_hdr.oid != OBUCK_OID_DELETED || full)
 268         {
 269           memcpy(hdrp, &obuck_hdr, sizeof(obuck_hdr));
 270           return 1;
 271         }
 272     }
 273 }
 274
 275 struct fastbuf *
 276 obuck_fetch(void)
 277 {
 278   struct fastbuf *b;
 279   uns official_buflen = ALIGN(MIN(obuck_hdr.length, obuck_io_buflen), OBUCK_ALIGN);
 280   uns real_buflen = official_buflen + OBUCK_ALIGN;
 281
 282   b = xmalloc(sizeof(struct fb_bucket) + real_buflen);
 283   b->buffer = b->bptr = b->bstop = FB_BUCKET(b)->buffer;
 284   b->bufend = b->buffer + official_buflen;
 285   b->name = "bucket-read";
 286   b->pos = 0;
 287   b->refill = obuck_fb_refill;
 288   b->spout = NULL;
 289   b->seek = NULL;
 290   b->close = obuck_fb_close;
 291   b->config = NULL;
 292   FB_BUCKET(b)->start_pos = bucket_find_pos;
 293   FB_BUCKET(b)->bucket_size = obuck_hdr.length;
 294   obuck_fb_count++;
 295   return b;
 296 }
 297
 298 oid_t
 299 obuck_predict_last_oid(void)
 300 {
 301   /* BEWARE: This is not fork-safe. */
 302   sh_off_t size = sh_seek(obuck_fd, 0, SEEK_END);
 303   return size >> OBUCK_SHIFT;
 304 }
 305
 306 struct fastbuf *
 307 obuck_create(u32 type)
 308 {
 309   ASSERT(!obuck_write_fb);
 310
 311   obuck_lock_write();
 312   sh_off_t start = sh_seek(obuck_fd, 0, SEEK_END);
 313   if (start & (OBUCK_ALIGN - 1))
 314     obuck_broken("Misaligned file", start);
 315   obuck_create_hdr.magic = OBUCK_INCOMPLETE_MAGIC;
 316   obuck_create_hdr.oid = start >> OBUCK_SHIFT;
 317   obuck_create_hdr.length = 0;
 318   obuck_create_hdr.type = type;
 319
 320   struct fastbuf *b = xmalloc(sizeof(struct fb_bucket) + obuck_io_buflen);
 321   obuck_write_fb = b;
 322   b->buffer = FB_BUCKET(b)->buffer;
 323   b->bptr = b->bstop = b->buffer;
 324   b->bufend = b->buffer + obuck_io_buflen;
 325   b->pos = -(int)sizeof(obuck_create_hdr);
 326   b->name = "bucket-write";
 327   b->refill = NULL;
 328   b->spout = obuck_fb_spout;
 329   b->seek = NULL;
 330   b->close = NULL;
 331   b->config = NULL;
 332   FB_BUCKET(b)->start_pos = start;
 333   FB_BUCKET(b)->bucket_size = 0;
 334   bwrite(b, &obuck_create_hdr, sizeof(obuck_create_hdr));
 335
 336   return b;
 337 }
 338
 339 void
 340 obuck_create_end(struct fastbuf *b, struct obuck_header *hdrp)
 341 {
 342   ASSERT(b == obuck_write_fb);
 343   obuck_write_fb = NULL;
 344
 345   obuck_create_hdr.magic = OBUCK_MAGIC;
 346   obuck_create_hdr.length = btell(b);
 347   int pad = (OBUCK_ALIGN - sizeof(obuck_create_hdr) - obuck_create_hdr.length - 4) & (OBUCK_ALIGN - 1);
 348   while (pad--)
 349     bputc(b, 0);
 350   bputl(b, OBUCK_TRAILER);
 351   bflush(b);
 352   ASSERT(!((FB_BUCKET(b)->start_pos + sizeof(obuck_create_hdr) + b->pos) & (OBUCK_ALIGN - 1)));
 353   if (sh_pwrite(obuck_fd, &obuck_create_hdr, sizeof(obuck_create_hdr), FB_BUCKET(b)->start_pos) != sizeof(obuck_create_hdr))
 354     die("Bucket header update failed: %m");
 355   obuck_unlock();
 356   memcpy(hdrp, &obuck_create_hdr, sizeof(obuck_create_hdr));
 357   xfree(b);
 358 }
 359
 360 void
 361 obuck_delete(oid_t oid)
 362 {
 363   obuck_lock_write();
 364   obuck_get(oid);
 365   obuck_hdr.oid = OBUCK_OID_DELETED;
 366   sh_pwrite(obuck_fd, &obuck_hdr, sizeof(obuck_hdr), bucket_find_pos);
 367   obuck_unlock();
 368 }
 369
 370 /*** Fast reading of the whole pool ***/
 371
 372 static struct fastbuf *obuck_rpf;
 373 static uns slurp_remains;
 374 static sh_off_t slurp_start, slurp_current;
 375
 376 static int
 377 obuck_slurp_refill(struct fastbuf *f)
 378 {
 379   uns l;
 380
 381   if (!slurp_remains)
 382     return 0;
 383   l = bdirect_read_prepare(obuck_rpf, &f->buffer);
 384   if (!l)
 385     obuck_broken("Incomplete object", slurp_start);
 386   l = MIN(l, slurp_remains);
 387   bdirect_read_commit(obuck_rpf, f->buffer + l);
 388   slurp_remains -= l;
 389   f->bptr = f->buffer;
 390   f->bufend = f->bstop = f->buffer + l;
 391   return 1;
 392 }
 393
 394 struct fastbuf *
 395 obuck_slurp_pool(struct obuck_header *hdrp)
 396 {
 397   static struct fastbuf limiter;
 398   uns l;
 399
 400   do
 401     {
 402       if (!obuck_rpf)
 403         {
 404           obuck_lock_read();
 405           obuck_rpf = bopen(obuck_name, O_RDONLY, obuck_slurp_buflen);
 406         }
 407       else
 408         {
 409           bsetpos(obuck_rpf, slurp_current - 4);
 410           if (bgetl(obuck_rpf) != OBUCK_TRAILER)
 411             obuck_broken("Missing trailer", slurp_start);
 412         }
 413       slurp_start = btell(obuck_rpf);
 414       l = bread(obuck_rpf, hdrp, sizeof(struct obuck_header));
 415       if (!l)
 416         {
 417           bclose(obuck_rpf);
 418           obuck_rpf = NULL;
 419           obuck_unlock();
 420           return NULL;
 421         }
 422       if (l != sizeof(struct obuck_header))
 423         obuck_broken("Short header read", slurp_start);
 424       if (hdrp->magic != OBUCK_MAGIC)
 425         obuck_broken("Missing magic number", slurp_start);
 426       slurp_current = (slurp_start + sizeof(obuck_hdr) + hdrp->length +
 427                        4 + OBUCK_ALIGN - 1) & ~((sh_off_t)(OBUCK_ALIGN - 1));
 428     }
 429   while (hdrp->oid == OBUCK_OID_DELETED);
 430   if (obuck_get_pos(hdrp->oid) != slurp_start)
 431     obuck_broken("Invalid backlink", slurp_start);
 432   slurp_remains = hdrp->length;
 433   limiter.bptr = limiter.bstop = limiter.buffer = limiter.bufend = NULL;
 434   limiter.name = "Bucket";
 435   limiter.pos = 0;
 436   limiter.refill = obuck_slurp_refill;
 437   return &limiter;
 438 }
 439
 440 /*** Shakedown ***/
 441
 442 static inline void
 443 shake_write(void *addr, int len, sh_off_t pos)
 444 {
 445   int l = sh_pwrite(obuck_fd, addr, len, pos);
 446   if (l != len)
 447     {
 448       if (l < 0)
 449         die("obuck_shakedown write error: %m");
 450       else
 451         die("obuck_shakedown write error: disk full");
 452     }
 453 }
 454
 455 static inline void
 456 shake_sync(void)
 457 {
 458   if (obuck_shake_security > 1)
 459     fdatasync(obuck_fd);
 460 }
 461
 462 static void
 463 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)
 464 {
 465   struct obuck_header *bhdr;
 466   int boff = 0;
 467   int l;
 468   oid_t old_oid;
 469
 470   /* First of all, the "normal" part -- everything that will be written in this pass */
 471   DBG("Backing up first round of changes at position %Lx + %x", (long long) bpos, norm_size);
 472   while (boff < norm_size)
 473     {
 474       /* This needn't be optimized for speed. */
 475       bhdr = (struct obuck_header *) (norm_buf + boff);
 476       ASSERT(bhdr->magic == OBUCK_MAGIC);
 477       l = ALIGN(sizeof(struct obuck_header) + bhdr->length + 4, OBUCK_ALIGN);
 478       old_oid = bhdr->oid;
 479       bhdr->oid = bpos >> OBUCK_SHIFT;
 480       shake_write(bhdr, l, bpos);
 481       bhdr->oid = old_oid;
 482       boff += l;
 483       bpos += l;
 484     }
 485
 486   /* If we have an incomplete bucket at the end of the buffer, we must copy it as well. */
 487   if (more_size)
 488     {
 489       DBG("Backing up fragment of size %x and %x more", frag_size, more_size);
 490
 491       /* First the part we already have in the buffer */
 492       bhdr = (struct obuck_header *) fragment;
 493       ASSERT(bhdr->magic == OBUCK_MAGIC);
 494       old_oid = bhdr->oid;
 495       bhdr->oid = bpos >> OBUCK_SHIFT;
 496       shake_write(bhdr, frag_size, bpos);
 497       bhdr->oid = old_oid;
 498       bpos += frag_size;
 499
 500       /* And then the rest, using a small 64K buffer */
 501       byte *auxbuf = alloca(65536);
 502       l = 0;
 503       while (l < more_size)
 504         {
 505           int j = MIN(more_size-l, 65536);
 506           if (sh_pread(obuck_fd, auxbuf, j, frag_pos + frag_size + l) != j)
 507             die("obuck_shakedown read error: %m");
 508           shake_write(auxbuf, j, bpos);
 509           bpos += j;
 510           l += j;
 511         }
 512     }
 513 }
 514
 515 static void
 516 shake_erase(sh_off_t start, sh_off_t end)
 517 {
 518   if (start > end)
 519     die("shake_erase called with negative length, that's a bug");
 520   ASSERT(!(start & (OBUCK_ALIGN-1)) && !(end & (OBUCK_ALIGN-1)));
 521   while (start < end)
 522     {
 523       u32 check = OBUCK_TRAILER;
 524       obuck_hdr.magic = OBUCK_MAGIC;
 525       obuck_hdr.oid = OBUCK_OID_DELETED;
 526       uns len = MIN(0x40000000, end-start);
 527       obuck_hdr.length = len - sizeof(obuck_hdr) - 4;
 528       DBG("Erasing %08x bytes at %Lx", len, (long long) start);
 529       shake_write(&obuck_hdr, sizeof(obuck_hdr), start);
 530       start += len;
 531       shake_write(&check, 4, start-4);
 532     }
 533 }
 534
 535 void
 536 obuck_shakedown(int (*kibitz)(struct obuck_header *old, oid_t new, byte *buck))
 537 {
 538   byte *buf;                                            /* Shakedown buffer and its size */
 539   int buflen = ALIGN(obuck_shake_buflen, OBUCK_ALIGN);
 540   byte *msg;                                            /* Error message we will print */
 541   sh_off_t rstart, wstart;                              /* Original and new position of buffer start */
 542   sh_off_t r_bucket_start, w_bucket_start;              /* Original and new position of the current bucket */
 543   int roff, woff;                                       /* Orig/new position of the current bucket relative to buffer start */
 544   int rsize;                                            /* Number of original bytes in the buffer */
 545   int l;                                                /* Raw size of the current bucket */
 546   int changed = 0;                                      /* "Something has been altered" flag */
 547   int wrote_anything = 0;                               /* We already did a write to the bucket file */
 548   struct obuck_header *rhdr, *whdr;                     /* Original and new address of header of the current bucket */
 549   sh_off_t r_file_size;                                 /* Original size of the bucket file */
 550   int more;                                             /* How much does the last bucket overlap the buffer */
 551
 552   buf = xmalloc(buflen);
 553   rstart = wstart = 0;
 554   roff = woff = rsize = 0;
 555
 556   /* We need to be the only accessor, all the object ID's are becoming invalid */
 557   obuck_lock_write();
 558   r_file_size = sh_seek(obuck_fd, 0, SEEK_END);
 559   ASSERT(!(r_file_size & (OBUCK_ALIGN - 1)));
 560   if (r_file_size >= (0x100000000 << OBUCK_SHIFT) - buflen)
 561     die("Bucket file is too large for safe shakedown. Shaking down with Bucket.ShakeSecurity=0 will still work.");
 562
 563   DBG("Starting shakedown. Buffer size is %d, original length %Lx", buflen, (long long) r_file_size);
 564
 565   for(;;)
 566     {
 567       r_bucket_start = rstart + roff;
 568       w_bucket_start = wstart + woff;
 569       rhdr = (struct obuck_header *)(buf + roff);
 570       whdr = (struct obuck_header *)(buf + woff);
 571       if (roff == rsize)
 572         {
 573           more = 0;
 574           goto next;
 575         }
 576       if (rhdr->magic != OBUCK_MAGIC ||
 577           rhdr->oid != OBUCK_OID_DELETED && rhdr->oid != (oid_t)(r_bucket_start >> OBUCK_SHIFT))
 578         {
 579           msg = "header mismatch";
 580           goto broken;
 581         }
 582       l = ALIGN(sizeof(struct obuck_header) + rhdr->length + 4, OBUCK_ALIGN);
 583       if (l > buflen)
 584         {
 585           if (rhdr->oid != OBUCK_OID_DELETED)
 586             {
 587               msg = "bucket longer than ShakeBufSize";
 588               goto broken;
 589             }
 590           /* Empty buckets are allowed to be large, but we need to handle them extra */
 591           DBG("Tricking around an extra-large empty bucket at %Lx + %x", (long long)r_bucket_start, l);
 592           rsize = roff + l;
 593         }
 594       else
 595         {
 596           if (rsize - roff < l)
 597             {
 598               more = l - (rsize - roff);
 599               goto next;
 600             }
 601           if (GET_U32((byte *)rhdr + l - 4) != OBUCK_TRAILER)
 602             {
 603               msg = "missing trailer";
 604               goto broken;
 605             }
 606         }
 607       if (rhdr->oid != OBUCK_OID_DELETED)
 608         {
 609           int status = kibitz(rhdr, w_bucket_start >> OBUCK_SHIFT, (byte *)(rhdr+1));
 610           if (status)
 611             {
 612               if (status > 1)
 613                 {
 614                   /* Changed! Reconstruct the trailer. */
 615                   int l2 = ALIGN(sizeof(struct obuck_header) + rhdr->length + 4, OBUCK_ALIGN);
 616                   ASSERT(l2 <= l);
 617                   PUT_U32((byte *)rhdr + l2 - 4, OBUCK_TRAILER);
 618                   l = l2;
 619                   changed = 1;
 620                 }
 621               whdr = (struct obuck_header *)(buf+woff);
 622               if (rhdr != whdr)
 623                 memmove(whdr, rhdr, l);
 624               whdr->oid = w_bucket_start >> OBUCK_SHIFT;
 625               woff += l;
 626             }
 627           else
 628             changed = 1;
 629         }
 630       else
 631         {
 632           kibitz(rhdr, OBUCK_OID_DELETED, NULL);
 633           changed = 1;
 634         }
 635       roff += l;
 636       continue;
 637
 638     next:
 639       if (changed)
 640         {
 641           /* Write the new contents of the bucket file */
 642           if (!wrote_anything)
 643             {
 644               if (obuck_shake_security)
 645                 {
 646                   /* But first write a backup at the end of the file to ensure nothing can be lost. */
 647                   shake_write_backup(r_file_size, buf, woff, buf+roff, rsize-roff, rstart+roff, more);
 648                   shake_sync();
 649                 }
 650               wrote_anything = 1;
 651             }
 652           if (woff)
 653             {
 654               DBG("Write %Lx %x", wstart, woff);
 655               shake_write(buf, woff, wstart);
 656               shake_sync();
 657             }
 658         }
 659       else
 660         ASSERT(wstart == rstart);
 661
 662       /* In any case, update the write position */
 663       wstart += woff;
 664       woff = 0;
 665
 666       /* Skip what's been read and if there is any fragment at the end of the buffer, move it to the start */
 667       rstart += roff;
 668       if (more)
 669         {
 670           memmove(buf, buf+roff, rsize-roff);
 671           rsize = rsize-roff;
 672         }
 673       else
 674         rsize = 0;
 675
 676       /* And refill the buffer */
 677       r_bucket_start = rstart+rsize;    /* Also needed for error messages */
 678       l = sh_pread(obuck_fd, buf+rsize, MIN(buflen-rsize, r_file_size - r_bucket_start), r_bucket_start);
 679       DBG("Read  %Lx %x (%x inherited)", (long long)r_bucket_start, l, rsize);
 680       if (l < 0)
 681         die("obuck_shakedown read error: %m");
 682       if (!l)
 683         {
 684           if (!more)
 685             break;
 686           msg = "unexpected EOF";
 687           goto broken;
 688         }
 689       if (l & (OBUCK_ALIGN-1))
 690         {
 691           msg = "garbage at the end of file";
 692           goto broken;
 693         }
 694       rsize += l;
 695       roff = 0;
 696     }
 697
 698   DBG("Finished at position %Lx", (long long) wstart);
 699   sh_ftruncate(obuck_fd, wstart);
 700   shake_sync();
 701
 702   obuck_unlock();
 703   xfree(buf);
 704   return;
 705
 706  broken:
 707   log(L_ERROR, "Error during object pool shakedown: %s (pos=%Ld, id=%x), gathering debris",
 708       msg, (long long) r_bucket_start, (uns)(r_bucket_start >> OBUCK_SHIFT));
 709   /*
 710    * We can attempt to clean up the bucket file by erasing everything between the last
 711    * byte written and the next byte to be read. If the secure mode is switched on, we can
 712    * guarantee that no data are lost, only some might be duplicated.
 713    */
 714   shake_erase(wstart, rstart);
 715   die("Fatal error during object pool shakedown");
 716 }
 717
 718 /*** Testing ***/
 719
 720 #ifdef TEST
 721
 722 #define COUNT 5000
 723 #define MAXLEN 10000
 724 #define KILLPERC 13
 725 #define LEN(i) ((259309*(i))%MAXLEN)
 726
 727 static int test_kibitz(struct obuck_header *h, oid_t new, byte *buck)
 728 {
 729   return 1;
 730 }
 731
 732 int main(int argc, char **argv)
 733 {
 734   int ids[COUNT];
 735   unsigned int i, j, cnt;
 736   struct obuck_header h;
 737   struct fastbuf *b;
 738
 739   log_init(NULL);
 740   if (cf_getopt(argc, argv, CF_SHORT_OPTS, CF_NO_LONG_OPTS, NULL) >= 0 ||
 741       optind < argc)
 742   {
 743     fputs("This program supports only the following command-line arguments:\n" CF_USAGE, stderr);
 744     exit(1);
 745   }
 746
 747   unlink(obuck_name);
 748   obuck_init(1);
 749   for(j=0; j<COUNT; j++)
 750     {
 751       b = obuck_create(BUCKET_TYPE_PLAIN);
 752       for(i=0; i<LEN(j); i++)
 753         bputc(b, (i+j) % 256);
 754       obuck_create_end(b, &h);
 755       printf("Writing %08x %d\n", h.oid, h.length);
 756       ids[j] = h.oid;
 757     }
 758   for(j=0; j<COUNT; j++)
 759     if (j % 100 < KILLPERC)
 760       {
 761         printf("Deleting %08x\n", ids[j]);
 762         obuck_delete(ids[j]);
 763       }
 764   cnt = 0;
 765   for(j=0; j<COUNT; j++)
 766     if (j % 100 >= KILLPERC)
 767       {
 768         cnt++;
 769         h.oid = ids[j];
 770         obuck_find_by_oid(&h);
 771         b = obuck_fetch();
 772         printf("Reading %08x %d\n", h.oid, h.length);
 773         if (h.length != LEN(j))
 774           die("Invalid length");
 775         for(i=0; i<h.length; i++)
 776           if ((unsigned) bgetc(b) != (i+j) % 256)
 777             die("Contents mismatch");
 778         if (bgetc(b) != EOF)
 779           die("EOF mismatch");
 780         bclose(b);
 781       }
 782   obuck_shakedown(test_kibitz);
 783   if (obuck_find_first(&h, 0))
 784     do
 785       {
 786         printf("<<< %08x\t%d\n", h.oid, h.length);
 787         cnt--;
 788       }
 789     while (obuck_find_next(&h, 0));
 790   if (cnt)
 791     die("Walk mismatch");
 792   obuck_cleanup();
 793   return 0;
 794 }
 795
 796 #endif