lib/bucket.c

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