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           bseek(obuck_rpf, 0, SEEK_END);
 439           slurp_end = btell(obuck_rpf);
 440           bsetpos(obuck_rpf, 0);
 441           obuck_lock_read_to_scan();
 442         }
 443       else
 444         {
 445           bsetpos(obuck_rpf, slurp_current - 4);
 446           if (bgetl(obuck_rpf) != OBUCK_TRAILER)
 447             obuck_broken("Missing trailer", slurp_start);
 448         }
 449       slurp_start = btell(obuck_rpf);
 450       if (slurp_start < slurp_end)
 451         l = bread(obuck_rpf, hdrp, sizeof(struct obuck_header));
 452       else
 453         l = 0;
 454       if (!l)
 455         {
 456           bclose(obuck_rpf);
 457           obuck_rpf = NULL;
 458           obuck_unlock();
 459           return NULL;
 460         }
 461       if (l != sizeof(struct obuck_header))
 462         obuck_broken("Short header read", slurp_start);
 463       if (hdrp->magic != OBUCK_MAGIC)
 464         obuck_broken("Missing magic number", slurp_start);
 465       slurp_current = slurp_start + obuck_bucket_size(hdrp->length);
 466     }
 467   while (hdrp->oid == OBUCK_OID_DELETED);
 468   if (obuck_get_pos(hdrp->oid) != slurp_start)
 469     obuck_broken("Invalid backlink", slurp_start);
 470   slurp_remains = hdrp->length;
 471   limiter.bptr = limiter.bstop = limiter.buffer = limiter.bufend = NULL;
 472   limiter.name = "Bucket";
 473   limiter.pos = 0;
 474   limiter.refill = obuck_slurp_refill;
 475   limiter.can_overwrite_buffer = obuck_rpf->can_overwrite_buffer;
 476   return &limiter;
 477 }
 478
 479 /*** Shakedown ***/
 480
 481 static inline void
 482 shake_write(void *addr, int len, sh_off_t pos)
 483 {
 484   int l = sh_pwrite(obuck_fd, addr, len, pos);
 485   if (l != len)
 486     {
 487       if (l < 0)
 488         die("obuck_shakedown write error: %m");
 489       else
 490         die("obuck_shakedown write error: disk full");
 491     }
 492 }
 493
 494 static inline void
 495 shake_sync(void)
 496 {
 497   if (obuck_shake_security > 1)
 498     fdatasync(obuck_fd);
 499 }
 500
 501 static void
 502 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)
 503 {
 504   struct obuck_header *bhdr;
 505   int boff = 0;
 506   int l;
 507   oid_t old_oid;
 508
 509   /* First of all, the "normal" part -- everything that will be written in this pass */
 510   DBG("Backing up first round of changes at position %Lx + %x", (long long) bpos, norm_size);
 511   while (boff < norm_size)
 512     {
 513       /* This needn't be optimized for speed. */
 514       bhdr = (struct obuck_header *) (norm_buf + boff);
 515       ASSERT(bhdr->magic == OBUCK_MAGIC);
 516       l = obuck_bucket_size(bhdr->length);
 517       old_oid = bhdr->oid;
 518       bhdr->oid = bpos >> OBUCK_SHIFT;
 519       shake_write(bhdr, l, bpos);
 520       bhdr->oid = old_oid;
 521       boff += l;
 522       bpos += l;
 523     }
 524
 525   /* If we have an incomplete bucket at the end of the buffer, we must copy it as well. */
 526   if (more_size)
 527     {
 528       DBG("Backing up fragment of size %x and %x more", frag_size, more_size);
 529
 530       /* First the part we already have in the buffer */
 531       bhdr = (struct obuck_header *) fragment;
 532       ASSERT(bhdr->magic == OBUCK_MAGIC);
 533       old_oid = bhdr->oid;
 534       bhdr->oid = bpos >> OBUCK_SHIFT;
 535       shake_write(bhdr, frag_size, bpos);
 536       bhdr->oid = old_oid;
 537       bpos += frag_size;
 538
 539       /* And then the rest, using a small 64K buffer */
 540       byte *auxbuf = alloca(65536);
 541       l = 0;
 542       while (l < more_size)
 543         {
 544           int j = MIN(more_size-l, 65536);
 545           if (sh_pread(obuck_fd, auxbuf, j, frag_pos + frag_size + l) != j)
 546             die("obuck_shakedown read error: %m");
 547           shake_write(auxbuf, j, bpos);
 548           bpos += j;
 549           l += j;
 550         }
 551     }
 552 }
 553
 554 static void
 555 shake_erase(sh_off_t start, sh_off_t end)
 556 {
 557   if (start > end)
 558     die("shake_erase called with negative length, that's a bug");
 559   ASSERT(!(start & (OBUCK_ALIGN-1)) && !(end & (OBUCK_ALIGN-1)));
 560   while (start < end)
 561     {
 562       u32 check = OBUCK_TRAILER;
 563       obuck_hdr.magic = OBUCK_MAGIC;
 564       obuck_hdr.oid = OBUCK_OID_DELETED;
 565       uns len = MIN(0x40000000, end-start);
 566       obuck_hdr.length = len - sizeof(obuck_hdr) - 4;
 567       DBG("Erasing %08x bytes at %Lx", len, (long long) start);
 568       shake_write(&obuck_hdr, sizeof(obuck_hdr), start);
 569       start += len;
 570       shake_write(&check, 4, start-4);
 571     }
 572 }
 573
 574 void
 575 obuck_shakedown(int (*kibitz)(struct obuck_header *old, oid_t new, byte *buck))
 576 {
 577   byte *buf;                                            /* Shakedown buffer and its size */
 578   int buflen = ALIGN(obuck_shake_buflen, OBUCK_ALIGN);
 579   byte *msg;                                            /* Error message we will print */
 580   sh_off_t rstart, wstart;                              /* Original and new position of buffer start */
 581   sh_off_t r_bucket_start, w_bucket_start;              /* Original and new position of the current bucket */
 582   int roff, woff;                                       /* Orig/new position of the current bucket relative to buffer start */
 583   int rsize;                                            /* Number of original bytes in the buffer */
 584   int l;                                                /* Raw size of the current bucket */
 585   int changed = 0;                                      /* "Something has been altered" flag */
 586   int wrote_anything = 0;                               /* We already did a write to the bucket file */
 587   struct obuck_header *rhdr, *whdr;                     /* Original and new address of header of the current bucket */
 588   sh_off_t r_file_size;                                 /* Original size of the bucket file */
 589   int more;                                             /* How much does the last bucket overlap the buffer */
 590
 591   buf = xmalloc(buflen);
 592   rstart = wstart = 0;
 593   roff = woff = rsize = 0;
 594
 595   /* We need to be the only accessor, all the object ID's are becoming invalid */
 596   obuck_lock_write();
 597   r_file_size = sh_seek(obuck_fd, 0, SEEK_END);
 598   ASSERT(!(r_file_size & (OBUCK_ALIGN - 1)));
 599   if (r_file_size >= (0x100000000 << OBUCK_SHIFT) - buflen)
 600     die("Bucket file is too large for safe shakedown. Shaking down with Bucket.ShakeSecurity=0 will still work.");
 601
 602   DBG("Starting shakedown. Buffer size is %d, original length %Lx", buflen, (long long) r_file_size);
 603
 604   for(;;)
 605     {
 606       r_bucket_start = rstart + roff;
 607       w_bucket_start = wstart + woff;
 608       rhdr = (struct obuck_header *)(buf + roff);
 609       whdr = (struct obuck_header *)(buf + woff);
 610       if (roff == rsize)
 611         {
 612           more = 0;
 613           goto next;
 614         }
 615       if (rhdr->magic != OBUCK_MAGIC ||
 616           rhdr->oid != OBUCK_OID_DELETED && rhdr->oid != (oid_t)(r_bucket_start >> OBUCK_SHIFT))
 617         {
 618           msg = "header mismatch";
 619           goto broken;
 620         }
 621       l = obuck_bucket_size(rhdr->length);
 622       if (l > buflen)
 623         {
 624           if (rhdr->oid != OBUCK_OID_DELETED)
 625             {
 626               msg = "bucket longer than ShakeBufSize";
 627               goto broken;
 628             }
 629           /* Empty buckets are allowed to be large, but we need to handle them extra */
 630           DBG("Tricking around an extra-large empty bucket at %Lx + %x", (long long)r_bucket_start, l);
 631           rsize = roff + l;
 632         }
 633       else
 634         {
 635           if (rsize - roff < l)
 636             {
 637               more = l - (rsize - roff);
 638               goto next;
 639             }
 640           if (GET_U32((byte *)rhdr + l - 4) != OBUCK_TRAILER)
 641             {
 642               msg = "missing trailer";
 643               goto broken;
 644             }
 645         }
 646       if (rhdr->oid != OBUCK_OID_DELETED)
 647         {
 648           int status = kibitz(rhdr, w_bucket_start >> OBUCK_SHIFT, (byte *)(rhdr+1));
 649           if (status)
 650             {
 651               int lnew = l;
 652               if (status > 1)
 653                 {
 654                   /* Changed! Reconstruct the trailer. */
 655                   lnew = obuck_bucket_size(rhdr->length);
 656                   ASSERT(lnew <= l);
 657                   PUT_U32((byte *)rhdr + lnew - 4, OBUCK_TRAILER);
 658                   changed = 1;
 659                 }
 660               whdr = (struct obuck_header *)(buf+woff);
 661               if (rhdr != whdr)
 662                 memmove(whdr, rhdr, lnew);
 663               whdr->oid = w_bucket_start >> OBUCK_SHIFT;
 664               woff += lnew;
 665             }
 666           else
 667             changed = 1;
 668         }
 669       else
 670         {
 671           kibitz(rhdr, OBUCK_OID_DELETED, NULL);
 672           changed = 1;
 673         }
 674       roff += l;
 675       continue;
 676
 677     next:
 678       if (changed)
 679         {
 680           /* Write the new contents of the bucket file */
 681           if (!wrote_anything)
 682             {
 683               if (obuck_shake_security)
 684                 {
 685                   /* But first write a backup at the end of the file to ensure nothing can be lost. */
 686                   shake_write_backup(r_file_size, buf, woff, buf+roff, rsize-roff, rstart+roff, more);
 687                   shake_sync();
 688                 }
 689               wrote_anything = 1;
 690             }
 691           if (woff)
 692             {
 693               DBG("Write %Lx %x", wstart, woff);
 694               shake_write(buf, woff, wstart);
 695               shake_sync();
 696             }
 697         }
 698       else
 699         ASSERT(wstart == rstart);
 700
 701       /* In any case, update the write position */
 702       wstart += woff;
 703       woff = 0;
 704
 705       /* Skip what's been read and if there is any fragment at the end of the buffer, move it to the start */
 706       rstart += roff;
 707       if (more)
 708         {
 709           memmove(buf, buf+roff, rsize-roff);
 710           rsize = rsize-roff;
 711         }
 712       else
 713         rsize = 0;
 714
 715       /* And refill the buffer */
 716       r_bucket_start = rstart+rsize;    /* Also needed for error messages */
 717       l = sh_pread(obuck_fd, buf+rsize, MIN(buflen-rsize, r_file_size - r_bucket_start), r_bucket_start);
 718       DBG("Read  %Lx %x (%x inherited)", (long long)r_bucket_start, l, rsize);
 719       if (l < 0)
 720         die("obuck_shakedown read error: %m");
 721       if (!l)
 722         {
 723           if (!more)
 724             break;
 725           msg = "unexpected EOF";
 726           goto broken;
 727         }
 728       if (l & (OBUCK_ALIGN-1))
 729         {
 730           msg = "garbage at the end of file";
 731           goto broken;
 732         }
 733       rsize += l;
 734       roff = 0;
 735     }
 736
 737   DBG("Finished at position %Lx", (long long) wstart);
 738   sh_ftruncate(obuck_fd, wstart);
 739   shake_sync();
 740
 741   obuck_unlock();
 742   xfree(buf);
 743   return;
 744
 745  broken:
 746   log(L_ERROR, "Error during object pool shakedown: %s (pos=%Ld, id=%x), gathering debris",
 747       msg, (long long) r_bucket_start, (uns)(r_bucket_start >> OBUCK_SHIFT));
 748   /*
 749    * We can attempt to clean up the bucket file by erasing everything between the last
 750    * byte written and the next byte to be read. If the secure mode is switched on, we can
 751    * guarantee that no data are lost, only some might be duplicated.
 752    */
 753   shake_erase(wstart, rstart);
 754   die("Fatal error during object pool shakedown");
 755 }
 756
 757 /*** Testing ***/
 758
 759 #ifdef TEST
 760
 761 #define COUNT 5000
 762 #define MAXLEN 10000
 763 #define KILLPERC 13
 764 #define LEN(i) ((259309*(i))%MAXLEN)
 765
 766 static int test_kibitz(struct obuck_header *h, oid_t new, byte *buck)
 767 {
 768   return 1;
 769 }
 770
 771 int main(int argc, char **argv)
 772 {
 773   int ids[COUNT];
 774   unsigned int i, j, cnt;
 775   struct obuck_header h;
 776   struct fastbuf *b;
 777
 778   log_init(NULL);
 779   if (cf_getopt(argc, argv, CF_SHORT_OPTS, CF_NO_LONG_OPTS, NULL) >= 0 ||
 780       optind < argc)
 781   {
 782     fputs("This program supports only the following command-line arguments:\n" CF_USAGE, stderr);
 783     exit(1);
 784   }
 785
 786   unlink(obuck_name);
 787   obuck_init(1);
 788   for(j=0; j<COUNT; j++)
 789     {
 790       b = obuck_create(BUCKET_TYPE_PLAIN);
 791       for(i=0; i<LEN(j); i++)
 792         bputc(b, (i+j) % 256);
 793       obuck_create_end(b, &h);
 794       printf("Writing %08x %d\n", h.oid, h.length);
 795       ids[j] = h.oid;
 796     }
 797   for(j=0; j<COUNT; j++)
 798     if (j % 100 < KILLPERC)
 799       {
 800         printf("Deleting %08x\n", ids[j]);
 801         obuck_delete(ids[j]);
 802       }
 803   cnt = 0;
 804   for(j=0; j<COUNT; j++)
 805     if (j % 100 >= KILLPERC)
 806       {
 807         cnt++;
 808         h.oid = ids[j];
 809         obuck_find_by_oid(&h);
 810         b = obuck_fetch();
 811         printf("Reading %08x %d\n", h.oid, h.length);
 812         if (h.length != LEN(j))
 813           die("Invalid length");
 814         for(i=0; i<h.length; i++)
 815           if ((unsigned) bgetc(b) != (i+j) % 256)
 816             die("Contents mismatch");
 817         if (bgetc(b) != EOF)
 818           die("EOF mismatch");
 819         bclose(b);
 820       }
 821   obuck_shakedown(test_kibitz);
 822   if (obuck_find_first(&h, 0))
 823     do
 824       {
 825         printf("<<< %08x\t%d\n", h.oid, h.length);
 826         cnt--;
 827       }
 828     while (obuck_find_next(&h, 0));
 829   if (cnt)
 830     die("Walk mismatch");
 831   obuck_cleanup();
 832   return 0;
 833 }
 834
 835 #endif