3 * block.c -- tape block handling functions
5 * Kern Sibbald, March MMI
6 * added BB02 format October MMII
12 Copyright (C) 2000-2003 Kern Sibbald and John Walker
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.
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.
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,
35 extern int debug_level;
38 * Dump the block header, then walk through
39 * the block printing out the record headers.
41 void dump_block(DEV_BLOCK *b, char *msg)
45 char Id[BLKHDR_ID_LENGTH+1];
46 uint32_t CheckSum, BlockCheckSum;
49 uint32_t VolSessionId, VolSessionTime, data_len;
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;
62 unser_uint32(VolSessionId);
63 unser_uint32(VolSessionTime);
67 VolSessionId = VolSessionTime = 0;
72 if (block_len > 100000) {
73 Dmsg3(20, "Dump block %s 0x%x blocksize too big %u\n", msg, b, block_len);
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);
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);
89 unser_int32(FileIndex);
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);
100 * Create a new block structure.
101 * We pass device so that the block can inherit the
102 * min and max block sizes.
104 DEV_BLOCK *new_block(DEVICE *dev)
106 DEV_BLOCK *block = (DEV_BLOCK *)get_memory(sizeof(DEV_BLOCK));
108 memset(block, 0, sizeof(DEV_BLOCK));
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;
114 block->buf_len = dev->max_block_size;
117 block->block_len = block->buf_len; /* default block size */
118 block->buf = get_memory(block->buf_len);
119 if (block->buf == NULL) {
120 Mmsg0(&dev->errmsg, _("Unable to malloc block buffer.\n"));
121 Emsg0(M_FATAL, 0, dev->errmsg);
125 block->BlockVer = BLOCK_VER; /* default write version */
126 Dmsg1(90, "Returning new block=%x\n", block);
133 void free_block(DEV_BLOCK *block)
135 Dmsg1(199, "free_block buffer %x\n", block->buf);
136 free_memory(block->buf);
137 Dmsg1(199, "free_block block %x\n", block);
138 free_memory((POOLMEM *)block);
141 /* Empty the block -- for writing */
142 void empty_block(DEV_BLOCK *block)
144 block->binbuf = WRITE_BLKHDR_LENGTH;
145 block->bufp = block->buf + block->binbuf;
147 block->write_failed = false;
148 block->block_read = false;
152 * Create block header just before write. The space
153 * in the buffer should have already been reserved by
156 static void ser_block_header(DEV_BLOCK *block)
159 uint32_t CheckSum = 0;
160 uint32_t block_len = block->binbuf;
162 Dmsg1(190, "ser_block_header: block_len=%d\n", block_len);
163 ser_begin(block->buf, BLKHDR2_LENGTH);
164 ser_uint32(CheckSum);
165 ser_uint32(block_len);
166 ser_uint32(block->BlockNumber);
167 ser_bytes(WRITE_BLKHDR_ID, BLKHDR_ID_LENGTH);
168 if (BLOCK_VER >= 2) {
169 ser_uint32(block->VolSessionId);
170 ser_uint32(block->VolSessionTime);
173 /* Checksum whole block except for the checksum */
174 CheckSum = bcrc32((uint8_t *)block->buf+BLKHDR_CS_LENGTH,
175 block_len-BLKHDR_CS_LENGTH);
176 Dmsg1(190, "ser_bloc_header: checksum=%x\n", CheckSum);
177 ser_begin(block->buf, BLKHDR2_LENGTH);
178 ser_uint32(CheckSum); /* now add checksum to block header */
182 * Unserialized the block header for reading block.
183 * This includes setting all the buffer pointers correctly.
185 * Returns: 0 on failure (not a block)
188 static int unser_block_header(DEVICE *dev, DEV_BLOCK *block)
191 char Id[BLKHDR_ID_LENGTH+1];
192 uint32_t CheckSum, BlockCheckSum;
195 uint32_t BlockNumber;
198 unser_begin(block->buf, BLKHDR_LENGTH);
199 unser_uint32(CheckSum);
200 unser_uint32(block_len);
201 unser_uint32(BlockNumber);
202 unser_bytes(Id, BLKHDR_ID_LENGTH);
203 ASSERT(unser_length(block->buf) == BLKHDR1_LENGTH);
205 Id[BLKHDR_ID_LENGTH] = 0;
207 bhl = BLKHDR1_LENGTH;
209 block->bufp = block->buf + bhl;
210 if (strncmp(Id, BLKHDR1_ID, BLKHDR_ID_LENGTH) != 0) {
211 Mmsg2(&dev->errmsg, _("Buffer ID error. Wanted: %s, got %s. Buffer discarded.\n"),
213 Emsg0(M_ERROR, 0, dev->errmsg);
216 } else if (Id[3] == '2') {
217 unser_uint32(block->VolSessionId);
218 unser_uint32(block->VolSessionTime);
219 bhl = BLKHDR2_LENGTH;
221 block->bufp = block->buf + bhl;
222 if (strncmp(Id, BLKHDR2_ID, BLKHDR_ID_LENGTH) != 0) {
223 Mmsg2(&dev->errmsg, _("Buffer ID error. Wanted: %s, got %s. Buffer discarded.\n"),
225 Emsg0(M_ERROR, 0, dev->errmsg);
229 Mmsg1(&dev->errmsg, _("Expected block-id BB01 or BB02, got %s. Buffer discarded.\n"), Id);
230 Emsg0(M_ERROR, 0, dev->errmsg);
235 if (block_len > MAX_BLOCK_LENGTH) {
236 Mmsg1(&dev->errmsg, _("Block length %u is insane (too large), probably due to a bad archive.\n"),
238 Emsg0(M_ERROR, 0, dev->errmsg);
242 Dmsg1(190, "unser_block_header block_len=%d\n", block_len);
243 /* Find end of block or end of buffer whichever is smaller */
244 if (block_len > block->read_len) {
245 block_end = block->read_len;
247 block_end = block_len;
249 block->binbuf = block_end - bhl;
250 block->block_len = block_len;
251 block->BlockNumber = BlockNumber;
252 Dmsg3(190, "Read binbuf = %d %d block_len=%d\n", block->binbuf,
254 if (block_len <= block->read_len) {
255 BlockCheckSum = bcrc32((uint8_t *)block->buf+BLKHDR_CS_LENGTH,
256 block_len-BLKHDR_CS_LENGTH);
257 if (BlockCheckSum != CheckSum) {
258 Dmsg2(00, "Block checksum mismatch: calc=%x blk=%x\n", BlockCheckSum,
260 Mmsg3(&dev->errmsg, _("Block checksum mismatch in block %u: calc=%x blk=%x\n"),
261 (unsigned)BlockNumber, BlockCheckSum, CheckSum);
269 * Write a block to the device, with locking and unlocking
271 * Returns: 1 on success
275 int write_block_to_device(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
281 * If a new volume has been mounted since our last write
282 * Create a JobMedia record for the previous volume written,
283 * and set new parameters to write this volume
286 /* Create a jobmedia record for this job */
287 if (!dir_create_jobmedia_record(jcr)) {
288 Jmsg(jcr, M_ERROR, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
289 jcr->VolCatInfo.VolCatName, jcr->Job);
290 set_new_volume_parameters(jcr, dev);
294 set_new_volume_parameters(jcr, dev);
297 if (!write_block_to_dev(jcr, dev, block)) {
298 stat = fixup_device_block_write_error(jcr, dev, block);
306 * Write a block to the device
308 * Returns: 1 on success or EOT
311 int write_block_to_dev(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
314 uint32_t wlen; /* length to write */
315 int hit_max1, hit_max2;
318 #ifdef NO_TAPE_WRITE_TEST
322 ASSERT(block->binbuf == ((uint32_t) (block->bufp - block->buf)));
324 /* dump_block(block, "before write"); */
325 if (dev->state & ST_WEOT) {
326 Dmsg0(100, "return write_block_to_dev with ST_WEOT\n");
327 Jmsg(jcr, M_FATAL, 0, _("Cannot write block. Device at EOM.\n"));
330 wlen = block->binbuf;
331 if (wlen <= WRITE_BLKHDR_LENGTH) { /* Does block have data in it? */
332 Dmsg0(100, "return write_block_to_dev no data to write\n");
336 * Clear to the end of the buffer if it is not full,
337 * and on tape devices, apply min and fixed blocking.
339 if (wlen != block->buf_len) {
340 uint32_t blen; /* current buffer length */
342 Dmsg2(200, "binbuf=%d buf_len=%d\n", block->binbuf, block->buf_len);
345 /* Adjust write size to min/max for tapes only */
346 if (dev->state & ST_TAPE) {
347 if (wlen < dev->min_block_size) {
348 wlen = ((dev->min_block_size + TAPE_BSIZE - 1) / TAPE_BSIZE) * TAPE_BSIZE;
350 /* check for fixed block size */
351 if (dev->min_block_size == dev->max_block_size) {
352 wlen = block->buf_len; /* fixed block size already rounded */
356 memset(block->bufp, 0, wlen-blen); /* clear garbage */
360 ser_block_header(block);
362 /* Limit maximum Volume size to value specified by user */
363 hit_max1 = (dev->max_volume_size > 0) &&
364 ((dev->VolCatInfo.VolCatBytes + block->binbuf)) >= dev->max_volume_size;
365 hit_max2 = (dev->VolCatInfo.VolCatMaxBytes > 0) &&
366 ((dev->VolCatInfo.VolCatBytes + block->binbuf)) >= dev->VolCatInfo.VolCatMaxBytes;
367 if (hit_max1 || hit_max2) {
370 Dmsg0(10, "==== Output bytes Triggered medium max capacity.\n");
372 max_cap = dev->max_volume_size;
374 max_cap = dev->VolCatInfo.VolCatMaxBytes;
376 Jmsg(jcr, M_INFO, 0, _("User defined maximum volume capacity %s exceeded on device %s.\n"),
377 edit_uint64(max_cap, ed1), dev->dev_name);
378 block->write_failed = true;
379 weof_dev(dev, 1); /* end the tape */
380 weof_dev(dev, 1); /* write second eof */
381 dev->state |= (ST_EOF | ST_EOT | ST_WEOT);
385 /* Limit maximum File size on volume to user specified value */
386 if (dev->state & ST_TAPE) {
387 if ((dev->max_file_size > 0) &&
388 (dev->file_addr+block->binbuf) >= dev->max_file_size) {
389 if (weof_dev(dev, 1) != 0) { /* write eof */
390 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
391 /* Plunge on anyway -- if tape is bad we will die on write */
396 dev->VolCatInfo.VolCatWrites++;
397 Dmsg1(300, "Write block of %u bytes\n", wlen);
398 if ((uint32_t)(stat=write(dev->fd, block->buf, (size_t)wlen)) != wlen) {
399 /* We should check for errno == ENOSPC, BUT many
400 * devices simply report EIO when the volume is full.
401 * With a little more thought we may be able to check
402 * capacity and distinguish real errors and EOT
403 * conditions. In any case, we probably want to
404 * simulate an End of Medium.
407 clrerror_dev(dev, -1);
408 if (dev->dev_errno == 0) {
409 dev->dev_errno = ENOSPC; /* out of space */
411 Jmsg(jcr, M_ERROR, 0, _("Write error on device %s. ERR=%s.\n"),
412 dev->dev_name, strerror(dev->dev_errno));
414 dev->dev_errno = ENOSPC; /* out of space */
415 Jmsg3(jcr, M_INFO, 0, _("End of medium on device %s. Write of %u bytes got %d.\n"),
416 dev->dev_name, wlen, stat);
419 Dmsg4(10, "=== Write error. size=%u rtn=%d errno=%d: ERR=%s\n",
420 wlen, stat, dev->dev_errno, strerror(dev->dev_errno));
422 block->write_failed = true;
423 weof_dev(dev, 1); /* end the tape */
424 weof_dev(dev, 1); /* write second eof */
425 dev->state |= (ST_EOF | ST_EOT | ST_WEOT);
428 #define CHECK_LAST_BLOCK
429 #ifdef CHECK_LAST_BLOCK
431 * If the device is a tape and it supports backspace record,
432 * we backspace over two eof marks and over the last record,
433 * then re-read it and verify that the block number is
436 if (dev->state & ST_TAPE && dev_cap(dev, CAP_BSR)) {
438 /* Now back up over what we wrote and read the last block */
439 if (bsf_dev(dev, 1) != 0 || bsf_dev(dev, 1) != 0) {
441 Jmsg(jcr, M_ERROR, 0, _("Back space file at EOT failed. ERR=%s\n"), strerror(dev->dev_errno));
443 /* Backspace over record */
444 if (ok && bsr_dev(dev, 1) != 0) {
446 Jmsg(jcr, M_ERROR, 0, _("Back space record at EOT failed. ERR=%s\n"), strerror(dev->dev_errno));
448 * On FreeBSD systems, if the user got here, it is likely that his/her
449 * tape drive is "frozen". The correct thing to do is a
450 * rewind(), but if we do that, higher levels in cleaning up, will
451 * most likely write the EOS record over the beginning of the
452 * tape. The rewind *is* done later in mount.c when another
453 * tape is requested. Note, the clrerror_dev() call in bsr_dev()
454 * calls ioctl(MTCERRSTAT), which *should* fix the problem.
458 DEV_BLOCK *lblock = new_block(dev);
459 /* Note, this can destroy dev->errmsg */
460 if (!read_block_from_dev(jcr, dev, lblock, NO_BLOCK_NUMBER_CHECK)) {
461 Jmsg(jcr, M_ERROR, 0, _("Re-read last block at EOT failed. ERR=%s"), dev->errmsg);
463 if (lblock->BlockNumber+1 == block->BlockNumber) {
464 Jmsg(jcr, M_INFO, 0, _("Re-read of last block succeeded.\n"));
466 Jmsg(jcr, M_ERROR, 0, _(
467 "Re-read of last block failed. Last block=%u Current block=%u.\n"),
468 lblock->BlockNumber, block->BlockNumber);
478 /* Do housekeeping */
480 dev->VolCatInfo.VolCatBytes += block->binbuf;
481 dev->VolCatInfo.VolCatBlocks++;
482 dev->file_addr += wlen;
483 dev->EndBlock = dev->block_num;
484 dev->EndFile = dev->file;
486 block->BlockNumber++;
488 /* Update jcr values */
489 if (dev->state & ST_TAPE) {
490 jcr->EndBlock = dev->EndBlock;
491 jcr->EndFile = dev->EndFile;
493 jcr->EndBlock = (uint32_t)dev->file_addr;
494 jcr->EndFile = (uint32_t)(dev->file_addr >> 32);
496 jcr->WroteVol = true;
498 Dmsg2(190, "write_block: wrote block %d bytes=%d\n", dev->block_num,
505 * Read block with locking
508 int read_block_from_device(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, bool check_block_numbers)
511 Dmsg0(90, "Enter read_block_from_device\n");
513 stat = read_block_from_dev(jcr, dev, block, check_block_numbers);
515 Dmsg0(90, "Leave read_block_from_device\n");
520 * Read the next block into the block structure and unserialize
521 * the block header. For a file, the block may be partially
522 * or completely in the current buffer.
524 int read_block_from_dev(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, bool check_block_numbers)
528 uint32_t BlockNumber;
532 Dmsg1(100, "Full read() in read_block_from_device() len=%d\n",
536 Mmsg1(&dev->errmsg, _("Block buffer size looping problem on device %s\n"),
538 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
543 stat = read(dev->fd, block->buf, (size_t)block->buf_len);
545 dev->VolCatInfo.VolCatErrors++;
547 } while (stat == -1 && (errno == EINTR || errno == EIO) && retry++ < 11);
549 Dmsg1(90, "Read device got: ERR=%s\n", strerror(errno));
550 clrerror_dev(dev, -1);
552 Mmsg2(&dev->errmsg, _("Read error on device %s. ERR=%s.\n"),
553 dev->dev_name, strerror(dev->dev_errno));
554 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
555 if (dev->state & ST_EOF) { /* EOF just seen? */
556 dev->state |= ST_EOT; /* yes, error => EOT */
560 Dmsg1(90, "Read device got %d bytes\n", stat);
561 if (stat == 0) { /* Got EOF ! */
562 dev->block_num = block->read_len = 0;
563 Mmsg1(&dev->errmsg, _("Read zero bytes on device %s.\n"), dev->dev_name);
564 if (dev->state & ST_EOF) { /* EOF already read? */
565 dev->state |= ST_EOT; /* yes, 2 EOFs => EOT */
569 dev->file++; /* increment file */
570 dev->state |= ST_EOF; /* set EOF read */
572 return 0; /* return eof */
574 /* Continue here for successful read */
575 block->read_len = stat; /* save length read */
576 if (block->read_len < BLKHDR2_LENGTH) {
577 Mmsg2(&dev->errmsg, _("Very short block of %d bytes on device %s discarded.\n"),
578 block->read_len, dev->dev_name);
579 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
580 dev->state |= ST_SHORT; /* set short block */
581 block->read_len = block->binbuf = 0;
582 return 0; /* return error */
585 BlockNumber = block->BlockNumber + 1;
586 if (!unser_block_header(dev, block)) {
592 * If the block is bigger than the buffer, we reposition for
593 * re-reading the block, allocate a buffer of the correct size,
596 if (block->block_len > block->buf_len) {
597 Mmsg2(&dev->errmsg, _("Block length %u is greater than buffer %u. Attempting recovery.\n"),
598 block->block_len, block->buf_len);
599 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
600 Pmsg1(000, "%s", dev->errmsg);
601 /* Attempt to reposition to re-read the block */
602 if (dev->state & ST_TAPE) {
603 Dmsg0(100, "Backspace record for reread.\n");
604 if (bsr_dev(dev, 1) != 0) {
605 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
610 Dmsg0(100, "Seek to beginning of block for reread.\n");
611 off_t pos = lseek(dev->fd, (off_t)0, SEEK_CUR); /* get curr pos */
612 pos -= block->read_len;
613 lseek(dev->fd, pos, SEEK_SET);
615 Mmsg1(&dev->errmsg, _("Setting block buffer size to %u bytes.\n"), block->block_len);
616 Jmsg(jcr, M_INFO, 0, "%s", dev->errmsg);
617 Pmsg1(000, "%s", dev->errmsg);
618 /* Set new block length */
619 dev->max_block_size = block->block_len;
620 block->buf_len = block->block_len;
621 free_memory(block->buf);
622 block->buf = get_memory(block->buf_len);
625 goto reread; /* re-read block with correct block size */
628 if (block->block_len > block->read_len) {
629 Mmsg2(&dev->errmsg, _("Short block of %d bytes on device %s discarded.\n"),
630 block->read_len, dev->dev_name);
631 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
632 dev->state |= ST_SHORT; /* set short block */
633 block->read_len = block->binbuf = 0;
634 return 0; /* return error */
637 dev->state &= ~(ST_EOF|ST_SHORT); /* clear EOF and short block */
639 dev->VolCatInfo.VolCatReads++;
640 dev->VolCatInfo.VolCatRBytes += block->read_len;
643 * If we read a short block on disk,
644 * seek to beginning of next block. This saves us
645 * from shuffling blocks around in the buffer. Take a
646 * look at this from an efficiency stand point later, but
647 * it should only happen once at the end of each job.
649 * I've been lseek()ing negative relative to SEEK_CUR for 30
650 * years now. However, it seems that with the new off_t definition,
651 * it is not possible to seek negative amounts, so we use two
652 * lseek(). One to get the position, then the second to do an
653 * absolute positioning -- so much for efficiency. KES Sep 02.
655 Dmsg0(200, "At end of read block\n");
656 if (block->read_len > block->block_len && !(dev->state & ST_TAPE)) {
657 off_t pos = lseek(dev->fd, (off_t)0, SEEK_CUR); /* get curr pos */
658 pos -= (block->read_len - block->block_len);
659 lseek(dev->fd, pos, SEEK_SET);
660 Dmsg2(100, "Did lseek blk_size=%d rdlen=%d\n", block->block_len,
663 Dmsg2(200, "Exit read_block read_len=%d block_len=%d\n",
664 block->read_len, block->block_len);
665 block->block_read = true;