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-2004 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, const 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 the user has specified a max_block_size, use it as the default */
 111    if (dev->max_block_size == 0) {
 112       block->buf_len = DEFAULT_BLOCK_SIZE;
 113    } else {
 114       block->buf_len = dev->max_block_size;
 115    }
 116    block->dev = dev;
 117    block->block_len = block->buf_len;  /* default block size */
 118    block->buf = get_memory(block->buf_len);
 119    empty_block(block);
 120    block->BlockVer = BLOCK_VER;       /* default write version */
 121    Dmsg1(90, "Returning new block=%x\n", block);
 122    return block;
 123 }
 124
 125
 126 /*
 127  * Duplicate an existing block (eblock)
 128  */
 129 DEV_BLOCK *dup_block(DEV_BLOCK *eblock)
 130 {
 131    DEV_BLOCK *block = (DEV_BLOCK *)get_memory(sizeof(DEV_BLOCK));
 132    int buf_len = sizeof_pool_memory(eblock->buf);
 133
 134    memcpy(block, eblock, sizeof(DEV_BLOCK));
 135    block->buf = get_memory(buf_len);
 136    memcpy(block->buf, eblock->buf, buf_len);
 137    return block;
 138 }
 139
 140
 141 /*
 142  * Only the first block checksum error was reported.
 143  *   If there are more, report it now.
 144  */
 145 void print_block_read_errors(JCR *jcr, DEV_BLOCK *block)
 146 {
 147    if (block->read_errors > 1) {
 148       Jmsg(jcr, M_ERROR, 0, _("%d block read errors not printed.\n"),
 149          block->read_errors);
 150    }
 151 }
 152
 153 /*
 154  * Free block
 155  */
 156 void free_block(DEV_BLOCK *block)
 157 {
 158    Dmsg1(199, "free_block buffer %x\n", block->buf);
 159    free_memory(block->buf);
 160    Dmsg1(199, "free_block block %x\n", block);
 161    free_memory((POOLMEM *)block);
 162 }
 163
 164 /* Empty the block -- for writing */
 165 void empty_block(DEV_BLOCK *block)
 166 {
 167    block->binbuf = WRITE_BLKHDR_LENGTH;
 168    block->bufp = block->buf + block->binbuf;
 169    block->read_len = 0;
 170    block->write_failed = false;
 171    block->block_read = false;
 172    block->FirstIndex = block->LastIndex = 0;
 173 }
 174
 175 /*
 176  * Create block header just before write. The space
 177  * in the buffer should have already been reserved by
 178  * init_block.
 179  */
 180 void ser_block_header(DEV_BLOCK *block)
 181 {
 182    ser_declare;
 183    uint32_t CheckSum = 0;
 184    uint32_t block_len = block->binbuf;
 185
 186    Dmsg1(190, "ser_block_header: block_len=%d\n", block_len);
 187    ser_begin(block->buf, BLKHDR2_LENGTH);
 188    ser_uint32(CheckSum);
 189    ser_uint32(block_len);
 190    ser_uint32(block->BlockNumber);
 191    ser_bytes(WRITE_BLKHDR_ID, BLKHDR_ID_LENGTH);
 192    if (BLOCK_VER >= 2) {
 193       ser_uint32(block->VolSessionId);
 194       ser_uint32(block->VolSessionTime);
 195    }
 196
 197    /* Checksum whole block except for the checksum */
 198    CheckSum = bcrc32((uint8_t *)block->buf+BLKHDR_CS_LENGTH,
 199                  block_len-BLKHDR_CS_LENGTH);
 200    Dmsg1(190, "ser_bloc_header: checksum=%x\n", CheckSum);
 201    ser_begin(block->buf, BLKHDR2_LENGTH);
 202    ser_uint32(CheckSum);              /* now add checksum to block header */
 203 }
 204
 205 /*
 206  * Unserialize the block header for reading block.
 207  *  This includes setting all the buffer pointers correctly.
 208  *
 209  *  Returns: 0 on failure (not a block)
 210  *           1 on success
 211  */
 212 static int unser_block_header(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
 213 {
 214    ser_declare;
 215    char Id[BLKHDR_ID_LENGTH+1];
 216    uint32_t CheckSum, BlockCheckSum;
 217    uint32_t block_len;
 218    uint32_t block_end;
 219    uint32_t BlockNumber;
 220    int bhl;
 221
 222    unser_begin(block->buf, BLKHDR_LENGTH);
 223    unser_uint32(CheckSum);
 224    unser_uint32(block_len);
 225    unser_uint32(BlockNumber);
 226    unser_bytes(Id, BLKHDR_ID_LENGTH);
 227    ASSERT(unser_length(block->buf) == BLKHDR1_LENGTH);
 228
 229    Id[BLKHDR_ID_LENGTH] = 0;
 230    if (Id[3] == '1') {
 231       bhl = BLKHDR1_LENGTH;
 232       block->BlockVer = 1;
 233       block->bufp = block->buf + bhl;
 234       if (strncmp(Id, BLKHDR1_ID, BLKHDR_ID_LENGTH) != 0) {
 235          dev->dev_errno = EIO;
 236          Mmsg2(&dev->errmsg, _("Volume data error! Wanted ID: %s, got %s. Buffer discarded.\n"),
 237             BLKHDR1_ID, Id);
 238          if (block->read_errors == 0 || verbose >= 2) {
 239             Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
 240          }
 241          block->read_errors++;
 242          if (!forge_on) {
 243             return 0;
 244          }
 245       }
 246    } else if (Id[3] == '2') {
 247       unser_uint32(block->VolSessionId);
 248       unser_uint32(block->VolSessionTime);
 249       bhl = BLKHDR2_LENGTH;
 250       block->BlockVer = 2;
 251       block->bufp = block->buf + bhl;
 252       if (strncmp(Id, BLKHDR2_ID, BLKHDR_ID_LENGTH) != 0) {
 253          dev->dev_errno = EIO;
 254          Mmsg2(&dev->errmsg, _("Volume data error! Wanted ID: %s, got %s. Buffer discarded.\n"),
 255             BLKHDR2_ID, Id);
 256          if (block->read_errors == 0 || verbose >= 2) {
 257             Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
 258          }
 259          block->read_errors++;
 260          if (!forge_on) {
 261             return 0;
 262          }
 263       }
 264    } else {
 265       dev->dev_errno = EIO;
 266       Mmsg1(&dev->errmsg, _("Volume data error! Wanted block-id BB02, got %s. Buffer discarded.\n"), Id);
 267       if (block->read_errors == 0 || verbose >= 2) {
 268          Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
 269       }
 270       block->read_errors++;
 271       if (!forge_on) {
 272          return 0;
 273       }
 274       unser_uint32(block->VolSessionId);
 275       unser_uint32(block->VolSessionTime);
 276       bhl = BLKHDR2_LENGTH;
 277       block->BlockVer = 2;
 278       block->bufp = block->buf + bhl;
 279    }
 280
 281    /* Sanity check */
 282    if (block_len > MAX_BLOCK_LENGTH) {
 283       dev->dev_errno = EIO;
 284       Mmsg1(&dev->errmsg,  _("Volume data error! Block length %u is insane (too large), probably due to a bad archive.\n"),
 285          block_len);
 286       if (block->read_errors == 0 || verbose >= 2) {
 287          Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
 288       }
 289       block->read_errors++;
 290       if (!forge_on) {
 291          return 0;
 292       }
 293    }
 294
 295    Dmsg1(190, "unser_block_header block_len=%d\n", block_len);
 296    /* Find end of block or end of buffer whichever is smaller */
 297    if (block_len > block->read_len) {
 298       block_end = block->read_len;
 299    } else {
 300       block_end = block_len;
 301    }
 302    block->binbuf = block_end - bhl;
 303    block->block_len = block_len;
 304    block->BlockNumber = BlockNumber;
 305    Dmsg3(190, "Read binbuf = %d %d block_len=%d\n", block->binbuf,
 306       bhl, block_len);
 307    if (block_len <= block->read_len) {
 308       BlockCheckSum = bcrc32((uint8_t *)block->buf+BLKHDR_CS_LENGTH,
 309                          block_len-BLKHDR_CS_LENGTH);
 310       if (BlockCheckSum != CheckSum) {
 311          dev->dev_errno = EIO;
 312          Mmsg3(&dev->errmsg, _("Volume data error! Block checksum mismatch in block %u: calc=%x blk=%x\n"),
 313             (unsigned)BlockNumber, BlockCheckSum, CheckSum);
 314          if (block->read_errors == 0 || verbose >= 2) {
 315             Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
 316          }
 317          block->read_errors++;
 318          if (!forge_on) {
 319             return 0;
 320          }
 321       }
 322    }
 323    return 1;
 324 }
 325
 326 /*
 327  * Write a block to the device, with locking and unlocking
 328  *
 329  * Returns: 1 on success
 330  *        : 0 on failure
 331  *
 332  */
 333 int write_block_to_device(DCR *dcr, DEV_BLOCK *block)
 334 {
 335    int stat = 1;
 336    DEVICE *dev = dcr->dev;
 337    JCR *jcr = dcr->jcr;
 338
 339
 340    if (dcr->spooling) {
 341       stat = write_block_to_spool_file(dcr, block);
 342       return stat;
 343    }
 344
 345    if (!dcr->dev_locked) {
 346       lock_device(dev);
 347    }
 348
 349    /*
 350     * If a new volume has been mounted since our last write
 351     *   Create a JobMedia record for the previous volume written,
 352     *   and set new parameters to write this volume
 353     * The same applies for if we are in a new file.
 354     */
 355    if (dcr->NewVol || dcr->NewFile) {
 356       /* Create a jobmedia record for this job */
 357       if (!dir_create_jobmedia_record(jcr)) {
 358          dev->dev_errno = EIO;
 359          Jmsg(jcr, M_ERROR, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
 360             jcr->VolCatInfo.VolCatName, jcr->Job);
 361          set_new_volume_parameters(jcr, dev);
 362          stat = 0;
 363          goto bail_out;
 364       }
 365       if (dcr->NewVol) {
 366          /* Note, setting a new volume also handles any pending new file */
 367          set_new_volume_parameters(jcr, dev);
 368          dcr->NewFile = false;        /* this handled for new file too */
 369       } else {
 370          set_new_file_parameters(jcr, dev);
 371       }
 372    }
 373
 374    if (!write_block_to_dev(dcr, block)) {
 375        stat = fixup_device_block_write_error(jcr, dev, block);
 376    }
 377
 378 bail_out:
 379    if (!dcr->dev_locked) {
 380       unlock_device(dev);
 381    }
 382    return stat;
 383 }
 384
 385 /*
 386  * Write a block to the device
 387  *
 388  *  Returns: 1 on success or EOT
 389  *           0 on hard error
 390  */
 391 int write_block_to_dev(DCR *dcr, DEV_BLOCK *block)
 392 {
 393    ssize_t stat = 0;
 394    uint32_t wlen;                     /* length to write */
 395    int hit_max1, hit_max2;
 396    bool ok;
 397    DEVICE *dev = dcr->dev;
 398    JCR *jcr = dcr->jcr;
 399
 400 #ifdef NO_TAPE_WRITE_TEST
 401    empty_block(block);
 402    return 1;
 403 #endif
 404    ASSERT(block->binbuf == ((uint32_t) (block->bufp - block->buf)));
 405
 406    /* dump_block(block, "before write"); */
 407    if (dev->state & ST_WEOT) {
 408       Dmsg0(100, "return write_block_to_dev with ST_WEOT\n");
 409       dev->dev_errno = ENOSPC;
 410       Jmsg(jcr, M_FATAL, 0,  _("Cannot write block. Device at EOM.\n"));
 411       return 0;
 412    }
 413    wlen = block->binbuf;
 414    if (wlen <= WRITE_BLKHDR_LENGTH) {  /* Does block have data in it? */
 415       Dmsg0(100, "return write_block_to_dev no data to write\n");
 416       return 1;
 417    }
 418    /*
 419     * Clear to the end of the buffer if it is not full,
 420     *  and on tape devices, apply min and fixed blocking.
 421     */
 422    if (wlen != block->buf_len) {
 423       uint32_t blen;                  /* current buffer length */
 424
 425       Dmsg2(200, "binbuf=%d buf_len=%d\n", block->binbuf, block->buf_len);
 426       blen = wlen;
 427
 428       /* Adjust write size to min/max for tapes only */
 429       if (dev->state & ST_TAPE) {
 430          /* check for fixed block size */
 431          if (dev->min_block_size == dev->max_block_size) {
 432             wlen = block->buf_len;    /* fixed block size already rounded */
 433          /* Check for min block size */
 434          } else if (wlen < dev->min_block_size) {
 435             wlen =  ((dev->min_block_size + TAPE_BSIZE - 1) / TAPE_BSIZE) * TAPE_BSIZE;
 436          /* Ensure size is rounded */
 437          } else {
 438             wlen = ((wlen + TAPE_BSIZE - 1) / TAPE_BSIZE) * TAPE_BSIZE;
 439          }
 440       }
 441       if (wlen-blen > 0) {
 442          memset(block->bufp, 0, wlen-blen); /* clear garbage */
 443       }
 444    }
 445
 446    ser_block_header(block);
 447
 448    /* Limit maximum Volume size to value specified by user */
 449    hit_max1 = (dev->max_volume_size > 0) &&
 450        ((dev->VolCatInfo.VolCatBytes + block->binbuf)) >= dev->max_volume_size;
 451    hit_max2 = (dev->VolCatInfo.VolCatMaxBytes > 0) &&
 452        ((dev->VolCatInfo.VolCatBytes + block->binbuf)) >= dev->VolCatInfo.VolCatMaxBytes;
 453    if (hit_max1 || hit_max2) {
 454       char ed1[50];
 455       uint64_t max_cap;
 456       Dmsg0(10, "==== Output bytes Triggered medium max capacity.\n");
 457       if (hit_max1) {
 458          max_cap = dev->max_volume_size;
 459       } else {
 460          max_cap = dev->VolCatInfo.VolCatMaxBytes;
 461       }
 462       Jmsg(jcr, M_INFO, 0, _("User defined maximum volume capacity %s exceeded on device %s.\n"),
 463             edit_uint64_with_commas(max_cap, ed1),  dev->dev_name);
 464       block->write_failed = true;
 465       if (weof_dev(dev, 1) != 0) {            /* end tape */
 466          Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
 467          dev->VolCatInfo.VolCatErrors++;
 468       }
 469       /* Don't do update after second EOF or file count will be wrong */
 470       Dmsg0(100, "dir_update_volume_info\n");
 471       dev->VolCatInfo.VolCatFiles = dev->file;
 472       dir_update_volume_info(jcr, dev, 0);
 473       if (dev_cap(dev, CAP_TWOEOF) && weof_dev(dev, 1) != 0) {  /* write eof */
 474          Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
 475          dev->VolCatInfo.VolCatErrors++;
 476       }
 477       dev->state |= (ST_EOF | ST_EOT | ST_WEOT);
 478       dev->dev_errno = ENOSPC;
 479       return 0;
 480    }
 481
 482    /* Limit maximum File size on volume to user specified value */
 483    if ((dev->max_file_size > 0) &&
 484        (dev->file_size+block->binbuf) >= dev->max_file_size) {
 485
 486       if (dev_state(dev, ST_TAPE) && weof_dev(dev, 1) != 0) {            /* write eof */
 487          /* Write EOF */
 488          Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
 489          block->write_failed = true;
 490          dev->VolCatInfo.VolCatErrors++;
 491          dev->state |= (ST_EOF | ST_EOT | ST_WEOT);
 492          Dmsg0(100, "dir_update_volume_info\n");
 493          dev->VolCatInfo.VolCatFiles = dev->file;
 494          dir_update_volume_info(jcr, dev, 0);
 495          dev->dev_errno = ENOSPC;
 496          return 0;
 497       }
 498
 499       /* Create a JobMedia record so restore can seek */
 500       Dmsg0(100, "dir_update_volume_info\n");
 501       dev->VolCatInfo.VolCatFiles = dev->file;
 502       dir_update_volume_info(jcr, dev, 0);
 503       if (!dir_create_jobmedia_record(jcr)) {
 504          dev->dev_errno = EIO;
 505           Jmsg(jcr, M_ERROR, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
 506                dcr->VolCatInfo.VolCatName, jcr->Job);
 507           if (!forge_on) {
 508              return 0;
 509           }
 510       }
 511       dev->file_size = 0;             /* reset file size */
 512       /*
 513        * Walk through all attached jcrs indicating the file has changed
 514        */
 515       Dmsg1(100, "Walk attached jcrs. Volume=%s\n", dev->VolCatInfo.VolCatName);
 516       for (JCR *mjcr=NULL; (mjcr=next_attached_jcr(dev, mjcr)); ) {
 517          if (mjcr->JobId == 0) {
 518             continue;                 /* ignore console */
 519          }
 520          mjcr->dcr->NewFile = true;   /* set reminder to do set_new_file_params */
 521       }
 522       set_new_file_parameters(jcr, dev);
 523    }
 524
 525    dev->VolCatInfo.VolCatWrites++;
 526    Dmsg1(200, "Write block of %u bytes\n", wlen);
 527    stat = write(dev->fd, block->buf, (size_t)wlen);
 528    if (stat != (ssize_t)wlen) {
 529       /* We should check for errno == ENOSPC, BUT many
 530        * devices simply report EIO when the volume is full.
 531        * With a little more thought we may be able to check
 532        * capacity and distinguish real errors and EOT
 533        * conditions.  In any case, we probably want to
 534        * simulate an End of Medium.
 535        */
 536       if (stat == -1) {
 537          /* I have added the ifdefing here because it appears on
 538           * FreeBSD where MTIOCERRSTAT is defined, this not only
 539           * clears the error but clears the residual unwritten
 540           * buffers -> data loss. As a consequence, on those
 541           * systems (FreeBSD like), do the clrerror() only after
 542           * the weof_dev() call.
 543           */
 544          clrerror_dev(dev, -1);
 545          if (dev->dev_errno == 0) {
 546             dev->dev_errno = ENOSPC;        /* out of space */
 547          }
 548          Jmsg4(jcr, M_ERROR, 0, _("Write error at %u:%u on device %s. ERR=%s.\n"),
 549             dev->file, dev->block_num, dev->dev_name, strerror(dev->dev_errno));
 550       } else {
 551         dev->dev_errno = ENOSPC;            /* out of space */
 552          Jmsg(jcr, M_INFO, 0, _("End of medium at %u:%u on device %s. Write of %u bytes got %d.\n"),
 553             dev->file, dev->block_num, dev->dev_name, wlen, stat);
 554       }
 555
 556       Dmsg6(100, "=== Write error. size=%u rtn=%d dev_blk=%d blk_blk=%d errno=%d: ERR=%s\n",
 557          wlen, stat, dev->block_num, block->BlockNumber, dev->dev_errno, strerror(dev->dev_errno));
 558
 559       block->write_failed = true;
 560       if (weof_dev(dev, 1) != 0) {         /* end the tape */
 561          dev->VolCatInfo.VolCatErrors++;
 562          Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
 563       }
 564       Dmsg0(100, "dir_update_volume_info\n");
 565       dev->VolCatInfo.VolCatFiles = dev->file;
 566       dir_update_volume_info(jcr, dev, 0);
 567       if (dev_cap(dev, CAP_TWOEOF) && weof_dev(dev, 1) != 0) {  /* end the tape */
 568          dev->VolCatInfo.VolCatErrors++;
 569          Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
 570       }
 571       dev->state |= (ST_EOF | ST_EOT | ST_WEOT);
 572
 573       ok = true;
 574 #define CHECK_LAST_BLOCK
 575 #ifdef  CHECK_LAST_BLOCK
 576       /*
 577        * If the device is a tape and it supports backspace record,
 578        *   we backspace over one or two eof marks depending on
 579        *   how many we just wrote, then over the last record,
 580        *   then re-read it and verify that the block number is
 581        *   correct.
 582        */
 583       if (dev->state & ST_TAPE && dev_cap(dev, CAP_BSR)) {
 584
 585          /* Now back up over what we wrote and read the last block */
 586          if (!bsf_dev(dev, 1)) {
 587             ok = false;
 588             Jmsg(jcr, M_ERROR, 0, _("Backspace file at EOT failed. ERR=%s\n"), strerror(dev->dev_errno));
 589          }
 590          if (ok && dev_cap(dev, CAP_TWOEOF) && !bsf_dev(dev, 1)) {
 591             ok = false;
 592             Jmsg(jcr, M_ERROR, 0, _("Backspace file at EOT failed. ERR=%s\n"), strerror(dev->dev_errno));
 593          }
 594          /* Backspace over record */
 595          if (ok && !bsr_dev(dev, 1)) {
 596             ok = false;
 597             Jmsg(jcr, M_ERROR, 0, _("Backspace record at EOT failed. ERR=%s\n"), strerror(dev->dev_errno));
 598             /*
 599              *  On FreeBSD systems, if the user got here, it is likely that his/her
 600              *    tape drive is "frozen".  The correct thing to do is a
 601              *    rewind(), but if we do that, higher levels in cleaning up, will
 602              *    most likely write the EOS record over the beginning of the
 603              *    tape.  The rewind *is* done later in mount.c when another
 604              *    tape is requested. Note, the clrerror_dev() call in bsr_dev()
 605              *    calls ioctl(MTCERRSTAT), which *should* fix the problem.
 606              */
 607          }
 608          if (ok) {
 609             DEV_BLOCK *lblock = new_block(dev);
 610             /* Note, this can destroy dev->errmsg */
 611             if (!read_block_from_dev(jcr, dev, lblock, NO_BLOCK_NUMBER_CHECK)) {
 612                Jmsg(jcr, M_ERROR, 0, _("Re-read last block at EOT failed. ERR=%s"), dev->errmsg);
 613             } else {
 614                if (lblock->BlockNumber+1 == block->BlockNumber) {
 615                   Jmsg(jcr, M_INFO, 0, _("Re-read of last block succeeded.\n"));
 616                } else {
 617                   Jmsg(jcr, M_ERROR, 0, _(
 618 "Re-read of last block failed. Last block=%u Current block=%u.\n"),
 619                        lblock->BlockNumber, block->BlockNumber);
 620                }
 621             }
 622             free_block(lblock);
 623          }
 624       }
 625 #endif
 626       return 0;
 627    }
 628
 629    /* We successfully wrote the block, now do housekeeping */
 630
 631    dev->VolCatInfo.VolCatBytes += block->binbuf;
 632    dev->VolCatInfo.VolCatBlocks++;
 633    dev->EndBlock = dev->block_num;
 634    dev->EndFile  = dev->file;
 635    dev->block_num++;
 636    block->BlockNumber++;
 637
 638    /* Update jcr values */
 639    if (dev_state(dev, ST_TAPE)) {
 640       dcr->EndBlock = dev->EndBlock;
 641       dcr->EndFile  = dev->EndFile;
 642    } else {
 643       /* Save address of start of block just written */
 644       dcr->EndBlock = (uint32_t)dev->file_addr;
 645       dcr->EndFile = (uint32_t)(dev->file_addr >> 32);
 646    }
 647    if (dcr->VolFirstIndex == 0 && block->FirstIndex > 0) {
 648       dcr->VolFirstIndex = block->FirstIndex;
 649    }
 650    if (block->LastIndex > 0) {
 651       dcr->VolLastIndex = block->LastIndex;
 652    }
 653    dcr->WroteVol = true;
 654    dev->file_addr += wlen;            /* update file address */
 655    dev->file_size += wlen;
 656
 657    Dmsg2(190, "write_block: wrote block %d bytes=%d\n", dev->block_num,
 658       wlen);
 659    empty_block(block);
 660    return 1;
 661 }
 662
 663 /*
 664  * Read block with locking
 665  *
 666  */
 667 int read_block_from_device(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, bool check_block_numbers)
 668 {
 669    int stat;
 670    Dmsg0(90, "Enter read_block_from_device\n");
 671    lock_device(dev);
 672    stat = read_block_from_dev(jcr, dev, block, check_block_numbers);
 673    unlock_device(dev);
 674    Dmsg0(90, "Leave read_block_from_device\n");
 675    return stat;
 676 }
 677
 678 /*
 679  * Read the next block into the block structure and unserialize
 680  *  the block header.  For a file, the block may be partially
 681  *  or completely in the current buffer.
 682  */
 683 int read_block_from_dev(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, bool check_block_numbers)
 684 {
 685    ssize_t stat;
 686    int looping;
 687    uint32_t BlockNumber;
 688    int retry;
 689    DCR *dcr = jcr->dcr;
 690
 691    if (!dcr) {
 692       Jmsg0(jcr, M_ABORT, 0, _("DCR is NULL!\n"));
 693    }
 694    if (dev_state(dev, ST_EOT)) {
 695       return 0;
 696    }
 697    looping = 0;
 698    Dmsg1(100, "Full read() in read_block_from_device() len=%d\n",
 699          block->buf_len);
 700 reread:
 701    if (looping > 1) {
 702       dev->dev_errno = EIO;
 703       Mmsg1(&dev->errmsg, _("Block buffer size looping problem on device %s\n"),
 704          dev->dev_name);
 705       Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
 706       block->read_len = 0;
 707       return 0;
 708    }
 709    retry = 0;
 710    do {
 711       stat = read(dev->fd, block->buf, (size_t)block->buf_len);
 712       if (retry == 1) {
 713          dev->VolCatInfo.VolCatErrors++;
 714       }
 715    } while (stat == -1 && (errno == EINTR || errno == EIO) && retry++ < 11);
 716 // Dmsg1(100, "read stat = %d\n", stat);
 717    if (stat < 0) {
 718       Dmsg1(90, "Read device got: ERR=%s\n", strerror(errno));
 719       clrerror_dev(dev, -1);
 720       block->read_len = 0;
 721       Mmsg4(&dev->errmsg, _("Read error at file:block %d:%d on device %s. ERR=%s.\n"),
 722          dev->file, dev->block_num, dev->dev_name, strerror(dev->dev_errno));
 723       Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
 724       if (dev->state & ST_EOF) {  /* EOF just seen? */
 725          dev->state |= ST_EOT;    /* yes, error => EOT */
 726       }
 727       return 0;
 728    }
 729    Dmsg1(90, "Read device got %d bytes\n", stat);
 730    if (stat == 0) {             /* Got EOF ! */
 731       dev->block_num = block->read_len = 0;
 732       Mmsg1(&dev->errmsg, _("Read zero bytes on device %s.\n"), dev->dev_name);
 733       if (dev->state & ST_EOF) { /* EOF already read? */
 734          dev->state |= ST_EOT;  /* yes, 2 EOFs => EOT */
 735          block->read_len = 0;
 736          return 0;
 737       }
 738       dev->file++;              /* increment file */
 739       dev->state |= ST_EOF;     /* set EOF read */
 740       block->read_len = 0;
 741       return 0;                 /* return eof */
 742    }
 743    /* Continue here for successful read */
 744    block->read_len = stat;      /* save length read */
 745    if (block->read_len < BLKHDR2_LENGTH) {
 746       dev->dev_errno = EIO;
 747       Mmsg2(&dev->errmsg, _("Volume data error! Very short block of %d bytes on device %s discarded.\n"),
 748          block->read_len, dev->dev_name);
 749       Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
 750       dev->state |= ST_SHORT;   /* set short block */
 751       block->read_len = block->binbuf = 0;
 752       return 0;                 /* return error */
 753    }
 754
 755    BlockNumber = block->BlockNumber + 1;
 756    if (!unser_block_header(jcr, dev, block)) {
 757       block->read_len = 0;
 758       return 0;
 759    }
 760
 761    /*
 762     * If the block is bigger than the buffer, we reposition for
 763     *  re-reading the block, allocate a buffer of the correct size,
 764     *  and go re-read.
 765     */
 766    if (block->block_len > block->buf_len) {
 767       dev->dev_errno = EIO;
 768       Mmsg2(&dev->errmsg,  _("Block length %u is greater than buffer %u. Attempting recovery.\n"),
 769          block->block_len, block->buf_len);
 770       Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
 771       Pmsg1(000, "%s", dev->errmsg);
 772       /* Attempt to reposition to re-read the block */
 773       if (dev->state & ST_TAPE) {
 774          Dmsg0(100, "Backspace record for reread.\n");
 775          if (!bsr_dev(dev, 1)) {
 776             Jmsg(jcr, M_ERROR, 0, "%s", strerror_dev(dev));
 777             block->read_len = 0;
 778             return 0;
 779          }
 780       } else {
 781          Dmsg0(100, "Seek to beginning of block for reread.\n");
 782          off_t pos = lseek(dev->fd, (off_t)0, SEEK_CUR); /* get curr pos */
 783          pos -= block->read_len;
 784          lseek(dev->fd, pos, SEEK_SET);
 785          dev->file_addr = pos;
 786       }
 787       Mmsg1(&dev->errmsg, _("Setting block buffer size to %u bytes.\n"), block->block_len);
 788       Jmsg(jcr, M_INFO, 0, "%s", dev->errmsg);
 789       Pmsg1(000, "%s", dev->errmsg);
 790       /* Set new block length */
 791       dev->max_block_size = block->block_len;
 792       block->buf_len = block->block_len;
 793       free_memory(block->buf);
 794       block->buf = get_memory(block->buf_len);
 795       empty_block(block);
 796       looping++;
 797       goto reread;                    /* re-read block with correct block size */
 798    }
 799
 800    if (block->block_len > block->read_len) {
 801       dev->dev_errno = EIO;
 802       Mmsg3(&dev->errmsg, _("Volume data error! Short block at %u of %d bytes on device %s discarded.\n"),
 803          dev->block_num, block->read_len, dev->dev_name);
 804       Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
 805       dev->state |= ST_SHORT;   /* set short block */
 806       block->read_len = block->binbuf = 0;
 807       return 0;                 /* return error */
 808    }
 809
 810    dev->state &= ~(ST_EOF|ST_SHORT); /* clear EOF and short block */
 811    dev->VolCatInfo.VolCatReads++;
 812    dev->VolCatInfo.VolCatRBytes += block->read_len;
 813
 814    dev->VolCatInfo.VolCatBytes += block->block_len;
 815    dev->VolCatInfo.VolCatBlocks++;
 816    dev->EndBlock = dev->block_num;
 817    dev->EndFile  = dev->file;
 818    dev->block_num++;
 819
 820    /* Update jcr values */
 821    if (dev->state & ST_TAPE) {
 822       dcr->EndBlock = dev->EndBlock;
 823       dcr->EndFile  = dev->EndFile;
 824    } else {
 825       dcr->EndBlock = (uint32_t)dev->file_addr;
 826       dcr->EndFile = (uint32_t)(dev->file_addr >> 32);
 827       dev->block_num = dcr->EndBlock;
 828       dev->file = dcr->EndFile;
 829    }
 830    dev->file_addr += block->block_len;
 831    dev->file_size += block->block_len;
 832
 833    /*
 834     * If we read a short block on disk,
 835     * seek to beginning of next block. This saves us
 836     * from shuffling blocks around in the buffer. Take a
 837     * look at this from an efficiency stand point later, but
 838     * it should only happen once at the end of each job.
 839     *
 840     * I've been lseek()ing negative relative to SEEK_CUR for 30
 841     *   years now. However, it seems that with the new off_t definition,
 842     *   it is not possible to seek negative amounts, so we use two
 843     *   lseek(). One to get the position, then the second to do an
 844     *   absolute positioning -- so much for efficiency.  KES Sep 02.
 845     */
 846    Dmsg0(200, "At end of read block\n");
 847    if (block->read_len > block->block_len && !(dev->state & ST_TAPE)) {
 848       off_t pos = lseek(dev->fd, (off_t)0, SEEK_CUR); /* get curr pos */
 849       pos -= (block->read_len - block->block_len);
 850       lseek(dev->fd, pos, SEEK_SET);
 851       Dmsg2(100, "Did lseek blk_size=%d rdlen=%d\n", block->block_len,
 852             block->read_len);
 853       dev->file_addr = pos;
 854    }
 855    Dmsg2(200, "Exit read_block read_len=%d block_len=%d\n",
 856       block->read_len, block->block_len);
 857    block->block_read = true;
 858    return 1;
 859 }