git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/block.c

   1 /*
   2  *
   3  *   block.c -- tape block handling functions
   4  *
   5  *              Kern Sibbald, March MMI
   6  *                 added BB02 format October MMII
   7  *
   8  *   Version $Id$
   9  *
  10  */
  11 /*
  12    Copyright (C) 2000, 2001, 2002 Kern Sibbald and John Walker
  13
  14    This program is free software; you can redistribute it and/or
  15    modify it under the terms of the GNU General Public License as
  16    published by the Free Software Foundation; either version 2 of
  17    the License, or (at your option) any later version.
  18
  19    This program is distributed in the hope that it will be useful,
  20    but WITHOUT ANY WARRANTY; without even the implied warranty of
  21    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  22    General Public License for more details.
  23
  24    You should have received a copy of the GNU General Public
  25    License along with this program; if not, write to the Free
  26    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  27    MA 02111-1307, USA.
  28
  29  */
  30
  31
  32 #include "bacula.h"
  33 #include "stored.h"
  34
  35 extern int debug_level;
  36
  37 /*
  38  * Dump the block header, then walk through
  39  * the block printing out the record headers.
  40  */
  41 void dump_block(DEV_BLOCK *b, char *msg)
  42 {
  43    ser_declare;
  44    char *p;
  45    char Id[BLKHDR_ID_LENGTH+1];
  46    uint32_t CheckSum, BlockCheckSum;
  47    uint32_t block_len;
  48    uint32_t BlockNumber;
  49    uint32_t VolSessionId, VolSessionTime, data_len;
  50    int32_t  FileIndex;
  51    int32_t  Stream;
  52    int bhl, rhl;
  53
  54    unser_begin(b->buf, BLKHDR1_LENGTH);
  55    unser_uint32(CheckSum);
  56    unser_uint32(block_len);
  57    unser_uint32(BlockNumber);
  58    unser_bytes(Id, BLKHDR_ID_LENGTH);
  59    ASSERT(unser_length(b->buf) == BLKHDR1_LENGTH);
  60    Id[BLKHDR_ID_LENGTH] = 0;
  61    if (Id[3] == '2') {
  62       unser_uint32(VolSessionId);
  63       unser_uint32(VolSessionTime);
  64       bhl = BLKHDR2_LENGTH;
  65       rhl = RECHDR2_LENGTH;
  66    } else {
  67       VolSessionId = VolSessionTime = 0;
  68       bhl = BLKHDR1_LENGTH;
  69       rhl = RECHDR1_LENGTH;
  70    }
  71
  72    if (block_len > 100000) {
  73       Dmsg3(20, "Dump block %s 0x%x blocksize too big %u\n", msg, b, block_len);
  74       return;
  75    }
  76
  77    BlockCheckSum = bcrc32((uint8_t *)b->buf+BLKHDR_CS_LENGTH,
  78                          block_len-BLKHDR_CS_LENGTH);
  79    Pmsg6(000, "Dump block %s %x: size=%d BlkNum=%d\n\
  80                Hdrcksum=%x cksum=%x\n",
  81       msg, b, block_len, BlockNumber, CheckSum, BlockCheckSum);
  82    p = b->buf + bhl;
  83    while (p < (b->buf + block_len+WRITE_RECHDR_LENGTH)) {
  84       unser_begin(p, WRITE_RECHDR_LENGTH);
  85       if (rhl == RECHDR1_LENGTH) {
  86          unser_uint32(VolSessionId);
  87          unser_uint32(VolSessionTime);
  88       }
  89       unser_int32(FileIndex);
  90       unser_int32(Stream);
  91       unser_uint32(data_len);
  92       Pmsg6(000, "   Rec: VId=%u VT=%u FI=%s Strm=%s len=%d p=%x\n",
  93            VolSessionId, VolSessionTime, FI_to_ascii(FileIndex),
  94            stream_to_ascii(Stream, FileIndex), data_len, p);
  95       p += data_len + rhl;
  96   }
  97 }
  98
  99 /*
 100  * Create a new block structure.
 101  * We pass device so that the block can inherit the
 102  * min and max block sizes.
 103  */
 104 DEV_BLOCK *new_block(DEVICE *dev)
 105 {
 106    DEV_BLOCK *block = (DEV_BLOCK *)get_memory(sizeof(DEV_BLOCK));
 107
 108    memset(block, 0, sizeof(DEV_BLOCK));
 109
 110    if (dev->max_block_size == 0) {
 111       block->buf_len = DEFAULT_BLOCK_SIZE;
 112    } else {
 113       block->buf_len = dev->max_block_size;
 114    }
 115    block->block_len = block->buf_len;  /* default block size */
 116    block->buf = get_memory(block->buf_len);
 117    if (block->buf == NULL) {
 118       Mmsg0(&dev->errmsg, _("Unable to malloc block buffer.\n"));
 119       Emsg0(M_FATAL, 0, dev->errmsg);
 120       return NULL;
 121    }
 122    empty_block(block);
 123    block->BlockVer = BLOCK_VER;       /* default write version */
 124    Dmsg1(90, "Returning new block=%x\n", block);
 125    return block;
 126 }
 127
 128 /*
 129  * Free block
 130  */
 131 void free_block(DEV_BLOCK *block)
 132 {
 133    Dmsg1(199, "free_block buffer %x\n", block->buf);
 134    free_memory(block->buf);
 135    Dmsg1(199, "free_block block %x\n", block);
 136    free_memory((POOLMEM *)block);
 137 }
 138
 139 /* Empty the block -- for writing */
 140 void empty_block(DEV_BLOCK *block)
 141 {
 142    block->binbuf = WRITE_BLKHDR_LENGTH;
 143    block->bufp = block->buf + block->binbuf;
 144    block->read_len = 0;
 145    block->failed_write = FALSE;
 146 }
 147
 148 /*
 149  * Create block header just before write. The space
 150  * in the buffer should have already been reserved by
 151  * init_block.
 152  */
 153 static void ser_block_header(DEV_BLOCK *block)
 154 {
 155    ser_declare;
 156    uint32_t CheckSum = 0;
 157    uint32_t block_len = block->binbuf;
 158
 159    Dmsg1(190, "ser_block_header: block_len=%d\n", block_len);
 160    ser_begin(block->buf, BLKHDR2_LENGTH);
 161    ser_uint32(CheckSum);
 162    ser_uint32(block_len);
 163    ser_uint32(block->BlockNumber);
 164    ser_bytes(WRITE_BLKHDR_ID, BLKHDR_ID_LENGTH);
 165    if (BLOCK_VER >= 2) {
 166       ser_uint32(block->VolSessionId);
 167       ser_uint32(block->VolSessionTime);
 168    }
 169
 170    /* Checksum whole block except for the checksum */
 171    CheckSum = bcrc32((uint8_t *)block->buf+BLKHDR_CS_LENGTH,
 172                  block_len-BLKHDR_CS_LENGTH);
 173    Dmsg1(190, "ser_bloc_header: checksum=%x\n", CheckSum);
 174    ser_begin(block->buf, BLKHDR2_LENGTH);
 175    ser_uint32(CheckSum);              /* now add checksum to block header */
 176 }
 177
 178 /*
 179  * Unserialized the block header for reading block.
 180  *  This includes setting all the buffer pointers correctly.
 181  *
 182  *  Returns: 0 on failure (not a block)
 183  *           1 on success
 184  */
 185 static int unser_block_header(DEVICE *dev, DEV_BLOCK *block)
 186 {
 187    ser_declare;
 188    char Id[BLKHDR_ID_LENGTH+1];
 189    uint32_t CheckSum, BlockCheckSum;
 190    uint32_t block_len;
 191    uint32_t EndBlock;
 192    uint32_t BlockNumber;
 193    int bhl;
 194
 195    unser_begin(block->buf, BLKHDR_LENGTH);
 196    unser_uint32(CheckSum);
 197    unser_uint32(block_len);
 198    unser_uint32(BlockNumber);
 199    unser_bytes(Id, BLKHDR_ID_LENGTH);
 200    ASSERT(unser_length(block->buf) == BLKHDR1_LENGTH);
 201
 202    Id[BLKHDR_ID_LENGTH] = 0;
 203    if (Id[3] == '1') {
 204       bhl = BLKHDR1_LENGTH;
 205       block->BlockVer = 1;
 206       block->bufp = block->buf + bhl;
 207       if (strncmp(Id, BLKHDR1_ID, BLKHDR_ID_LENGTH) != 0) {
 208       Mmsg2(&dev->errmsg, _("Buffer ID error. Wanted: %s, got %s. Buffer discarded.\n"),
 209             BLKHDR1_ID, Id);
 210       Emsg0(M_ERROR, 0, dev->errmsg);
 211       return 0;
 212    }
 213    } else {
 214       unser_uint32(block->VolSessionId);
 215       unser_uint32(block->VolSessionTime);
 216       bhl = BLKHDR2_LENGTH;
 217       block->BlockVer = 2;
 218       block->bufp = block->buf + bhl;
 219       if (strncmp(Id, BLKHDR2_ID, BLKHDR_ID_LENGTH) != 0) {
 220          Mmsg2(&dev->errmsg, _("Buffer ID error. Wanted: %s, got %s. Buffer discarded.\n"),
 221             BLKHDR2_ID, Id);
 222          Emsg0(M_ERROR, 0, dev->errmsg);
 223          return 0;
 224       }
 225    }
 226
 227    ASSERT(block_len < MAX_BLOCK_LENGTH);    /* temp sanity check */
 228
 229    Dmsg1(190, "unser_block_header block_len=%d\n", block_len);
 230    /* Find end of block or end of buffer whichever is smaller */
 231    if (block_len > block->read_len) {
 232       EndBlock = block->read_len;
 233    } else {
 234       EndBlock = block_len;
 235    }
 236    block->binbuf = EndBlock - bhl;
 237    block->block_len = block_len;
 238    block->BlockNumber = BlockNumber;
 239    Dmsg3(190, "Read binbuf = %d %d block_len=%d\n", block->binbuf,
 240       bhl, block_len);
 241    if (block_len > block->buf_len) {
 242       Mmsg2(&dev->errmsg,  _("Block length %u is greater than buffer %u\n"),
 243          block_len, block->buf_len);
 244       Emsg0(M_ERROR, 0, dev->errmsg);
 245       return 0;
 246    }
 247    if (block_len <= block->read_len) {
 248       BlockCheckSum = bcrc32((uint8_t *)block->buf+BLKHDR_CS_LENGTH,
 249                          block_len-BLKHDR_CS_LENGTH);
 250       if (BlockCheckSum != CheckSum) {
 251          Dmsg2(00, "Block checksum mismatch: calc=%x blk=%x\n", BlockCheckSum,
 252             CheckSum);
 253          Mmsg2(&dev->errmsg, _("Block checksum mismatch: calc=%x blk=%x\n"), BlockCheckSum,
 254             CheckSum);
 255          return 0;
 256       }
 257    }
 258    return 1;
 259 }
 260
 261 /*
 262  * Write a block to the device, with locking and unlocking
 263  *
 264  * Returns: 1 on success
 265  *        : 0 on failure
 266  *
 267  */
 268 int write_block_to_device(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
 269 {
 270    int stat = 1;
 271    lock_device(dev);
 272    if (!write_block_to_dev(dev, block)) {
 273        stat = fixup_device_block_write_error(jcr, dev, block);
 274    }
 275    unlock_device(dev);
 276    return stat;
 277 }
 278
 279 /*
 280  * Write a block to the device
 281  *
 282  *  Returns: 1 on success or EOT
 283  *           0 on hard error
 284  */
 285 int write_block_to_dev(DEVICE *dev, DEV_BLOCK *block)
 286 {
 287    size_t stat = 0;
 288    uint32_t wlen;                     /* length to write */
 289
 290 #ifdef NO_TAPE_WRITE_TEST
 291    empty_block(block);
 292    return 1;
 293 #endif
 294    ASSERT(block->binbuf == ((uint32_t) (block->bufp - block->buf)));
 295
 296    /* dump_block(block, "before write"); */
 297    if (dev->state & ST_WEOT) {
 298       Dmsg0(100, "return write_block_to_dev with ST_WEOT\n");
 299       return 0;
 300    }
 301    wlen = block->binbuf;
 302    if (wlen <= WRITE_BLKHDR_LENGTH) {  /* Does block have data in it? */
 303       Dmsg0(100, "return write_block_to_dev no data to write\n");
 304       return 1;
 305    }
 306    /*
 307     * Clear to the end of the buffer if it is not full,
 308     *  and on tape devices, apply min and fixed blocking.
 309     */
 310    if (wlen != block->buf_len) {
 311       uint32_t blen;                  /* current buffer length */
 312
 313       Dmsg2(200, "binbuf=%d buf_len=%d\n", block->binbuf, block->buf_len);
 314       blen = wlen;
 315
 316       /* Adjust write size to min/max for tapes only */
 317       if (dev->state & ST_TAPE) {
 318          if (wlen < dev->min_block_size) {
 319             wlen =  ((dev->min_block_size + TAPE_BSIZE - 1) / TAPE_BSIZE) * TAPE_BSIZE;
 320          }
 321          /* check for fixed block size */
 322          if (dev->min_block_size == dev->max_block_size) {
 323             wlen = block->buf_len;    /* fixed block size already rounded */
 324          }
 325       }
 326       if (wlen-blen > 0) {
 327          memset(block->bufp, 0, wlen-blen); /* clear garbage */
 328       }
 329    }
 330
 331    ser_block_header(block);
 332
 333    /* Limit maximum Volume size to value specified by user */
 334    if ((dev->max_volume_size > 0) &&
 335        ((dev->VolCatInfo.VolCatBytes + block->binbuf)) >= dev->max_volume_size) {
 336       dev->state |= ST_WEOT;
 337       Dmsg0(10, "==== Output bytes Triggered medium max capacity.\n");
 338       Mmsg2(&dev->errmsg, _("Max. Volume capacity %" lld " exceeded on device %s.\n"),
 339          dev->max_volume_size, dev->dev_name);
 340       block->failed_write = TRUE;
 341 /* ****FIXME**** write EOD record here */
 342       weof_dev(dev, 1);               /* end the tape */
 343       weof_dev(dev, 1);               /* write second eof */
 344       return 0;
 345    }
 346
 347    dev->VolCatInfo.VolCatWrites++;
 348    Dmsg1(500, "Write block of %u bytes\n", wlen);
 349    if ((uint32_t) (stat=write(dev->fd, block->buf, (size_t)wlen)) != wlen) {
 350       /* We should check for errno == ENOSPC, BUT many
 351        * devices simply report EIO when it is full.
 352        * with a little more thought we may be able to check
 353        * capacity and distinguish real errors and EOT
 354        * conditions.  In any case, we probably want to
 355        * simulate an End of Medium.
 356        */
 357 /***FIXME**** if we wrote a partial record, back up over it */
 358       dev->state |= ST_EOF | ST_EOT | ST_WEOT;
 359       clrerror_dev(dev, -1);
 360
 361       if (dev->dev_errno == 0) {
 362          dev->dev_errno = ENOSPC;        /* out of space */
 363       }
 364
 365       Dmsg4(10, "=== Write error. size=%u rtn=%d  errno=%d: ERR=%s\n",
 366          wlen, stat, dev->dev_errno, strerror(dev->dev_errno));
 367
 368       Mmsg4(&dev->errmsg, _("Write error on device %s. Write of %u bytes got %d. ERR=%s.\n"),
 369          dev->dev_name, wlen, stat, strerror(dev->dev_errno));
 370       block->failed_write = TRUE;
 371       weof_dev(dev, 1);               /* end the tape */
 372       weof_dev(dev, 1);               /* write second eof */
 373       return 0;
 374    }
 375 // Dmsg1(000, "Pos after write=%lld\n", lseek(dev->fd, (off_t)0, SEEK_CUR));
 376    dev->VolCatInfo.VolCatBytes += block->binbuf;
 377    dev->VolCatInfo.VolCatBlocks++;
 378    dev->file_addr += wlen;
 379
 380    /* Limit maximum File size on volume to user specified value */
 381    if (dev->state & ST_TAPE) {
 382       if ((dev->max_file_size > 0) && dev->file_addr >= dev->max_file_size) {
 383          weof_dev(dev, 1);               /* write eof */
 384       }
 385    }
 386
 387    dev->block_num++;
 388    block->BlockNumber++;
 389    Dmsg2(190, "write_block: wrote block %d bytes=%d\n", dev->block_num,
 390       wlen);
 391    empty_block(block);
 392    return 1;
 393 }
 394
 395 /*
 396  * Read block with locking
 397  *
 398  */
 399 int read_block_from_device(DEVICE *dev, DEV_BLOCK *block)
 400 {
 401    int stat;
 402    Dmsg0(90, "Enter read_block_from_device\n");
 403    lock_device(dev);
 404    stat = read_block_from_dev(dev, block);
 405    unlock_device(dev);
 406    Dmsg0(90, "Leave read_block_from_device\n");
 407    return stat;
 408 }
 409
 410 /*
 411  * Read the next block into the block structure and unserialize
 412  *  the block header.  For a file, the block may be partially
 413  *  or completely in the current buffer.
 414  */
 415 int read_block_from_dev(DEVICE *dev, DEV_BLOCK *block)
 416 {
 417    size_t stat;
 418
 419    Dmsg1(100, "Full read() in read_block_from_device() len=%d\n",
 420          block->buf_len);
 421 // Dmsg1(000, "Pos before read=%lld\n", lseek(dev->fd, (off_t)0, SEEK_CUR));
 422    if ((stat=read(dev->fd, block->buf, (size_t)block->buf_len)) < 0) {
 423
 424 /* ***FIXME****  add code to detect buffer too small, and
 425    reallocate buffer, backspace, and reread.
 426    ENOMEM
 427  */
 428
 429       Dmsg1(90, "Read device got: ERR=%s\n", strerror(errno));
 430       clrerror_dev(dev, -1);
 431       block->read_len = 0;
 432       Mmsg2(&dev->errmsg, _("Read error on device %s. ERR=%s.\n"),
 433          dev->dev_name, strerror(dev->dev_errno));
 434       return 0;
 435    }
 436 // Dmsg1(000, "Pos after read=%lld\n", lseek(dev->fd, (off_t)0, SEEK_CUR));
 437    Dmsg1(90, "Read device got %d bytes\n", stat);
 438    if (stat == 0) {             /* Got EOF ! */
 439       dev->block_num = block->read_len = 0;
 440       Mmsg1(&dev->errmsg, _("Read zero bytes on device %s.\n"), dev->dev_name);
 441       if (dev->state & ST_EOF) { /* EOF alread read? */
 442          dev->state |= ST_EOT;  /* yes, 2 EOFs => EOT */
 443          return 0;
 444       }
 445       dev->file++;              /* increment file */
 446       dev->state |= ST_EOF;     /* set EOF read */
 447       return 0;                 /* return eof */
 448    }
 449    /* Continue here for successful read */
 450    block->read_len = stat;      /* save length read */
 451    if (block->read_len < BLKHDR2_LENGTH) {
 452       Mmsg2(&dev->errmsg, _("Very short block of %d bytes on device %s discarded.\n"),
 453          block->read_len, dev->dev_name);
 454       dev->state |= ST_SHORT;   /* set short block */
 455       block->read_len = block->binbuf = 0;
 456       return 0;                 /* return error */
 457    }
 458    if (!unser_block_header(dev, block)) {
 459       return 0;
 460    }
 461
 462    if (block->block_len > block->read_len) {
 463       Mmsg2(&dev->errmsg, _("Short block of %d bytes on device %s discarded.\n"),
 464          block->read_len, dev->dev_name);
 465       dev->state |= ST_SHORT;   /* set short block */
 466       block->read_len = block->binbuf = 0;
 467       return 0;                 /* return error */
 468    }
 469
 470    /* Make sure block size is not too big (temporary
 471     * sanity check) and that we read the full block.
 472     */
 473    ASSERT(block->block_len < MAX_BLOCK_LENGTH);
 474
 475    dev->state &= ~(ST_EOF|ST_SHORT); /* clear EOF and short block */
 476    dev->block_num++;
 477
 478    /*
 479     * If we read a short block on disk,
 480     * seek to beginning of next block. This saves us
 481     * from shuffling blocks around in the buffer. Take a
 482     * look at this from an efficiency stand point later, but
 483     * it should only happen once at the end of each job.
 484     *
 485     * I've been lseek()ing negative relative to SEEK_CUR for 30
 486     *   years now. However, it seems that with the new off_t definition,
 487     *   it is not possible to seek negative amounts, so we use two
 488     *   lseek(). One to get the position, then the second to do an
 489     *   absolute positioning -- so much for efficiency.  KES Sep 02.
 490     */
 491    Dmsg0(200, "At end of read block\n");
 492    if (block->read_len > block->block_len && !(dev->state & ST_TAPE)) {
 493       off_t pos = lseek(dev->fd, (off_t)0, SEEK_CUR); /* get curr pos */
 494       pos -= (block->read_len - block->block_len);
 495       lseek(dev->fd, pos, SEEK_SET);
 496       Dmsg2(100, "Did lseek blk_size=%d rdlen=%d\n", block->block_len,
 497             block->read_len);
 498    }
 499    Dmsg2(200, "Exit read_block read_len=%d block_len=%d\n",
 500       block->read_len, block->block_len);
 501    return 1;
 502 }