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;
149 block->FirstIndex = block->LastIndex = 0;
153 * Create block header just before write. The space
154 * in the buffer should have already been reserved by
157 static void ser_block_header(DEV_BLOCK *block)
160 uint32_t CheckSum = 0;
161 uint32_t block_len = block->binbuf;
163 Dmsg1(190, "ser_block_header: block_len=%d\n", block_len);
164 ser_begin(block->buf, BLKHDR2_LENGTH);
165 ser_uint32(CheckSum);
166 ser_uint32(block_len);
167 ser_uint32(block->BlockNumber);
168 ser_bytes(WRITE_BLKHDR_ID, BLKHDR_ID_LENGTH);
169 if (BLOCK_VER >= 2) {
170 ser_uint32(block->VolSessionId);
171 ser_uint32(block->VolSessionTime);
174 /* Checksum whole block except for the checksum */
175 CheckSum = bcrc32((uint8_t *)block->buf+BLKHDR_CS_LENGTH,
176 block_len-BLKHDR_CS_LENGTH);
177 Dmsg1(190, "ser_bloc_header: checksum=%x\n", CheckSum);
178 ser_begin(block->buf, BLKHDR2_LENGTH);
179 ser_uint32(CheckSum); /* now add checksum to block header */
183 * Unserialized the block header for reading block.
184 * This includes setting all the buffer pointers correctly.
186 * Returns: 0 on failure (not a block)
189 static int unser_block_header(DEVICE *dev, DEV_BLOCK *block)
192 char Id[BLKHDR_ID_LENGTH+1];
193 uint32_t CheckSum, BlockCheckSum;
196 uint32_t BlockNumber;
199 unser_begin(block->buf, BLKHDR_LENGTH);
200 unser_uint32(CheckSum);
201 unser_uint32(block_len);
202 unser_uint32(BlockNumber);
203 unser_bytes(Id, BLKHDR_ID_LENGTH);
204 ASSERT(unser_length(block->buf) == BLKHDR1_LENGTH);
206 Id[BLKHDR_ID_LENGTH] = 0;
208 bhl = BLKHDR1_LENGTH;
210 block->bufp = block->buf + bhl;
211 if (strncmp(Id, BLKHDR1_ID, BLKHDR_ID_LENGTH) != 0) {
212 Mmsg2(&dev->errmsg, _("Buffer ID error. Wanted: %s, got %s. Buffer discarded.\n"),
214 Emsg0(M_ERROR, 0, dev->errmsg);
217 } else if (Id[3] == '2') {
218 unser_uint32(block->VolSessionId);
219 unser_uint32(block->VolSessionTime);
220 bhl = BLKHDR2_LENGTH;
222 block->bufp = block->buf + bhl;
223 if (strncmp(Id, BLKHDR2_ID, BLKHDR_ID_LENGTH) != 0) {
224 Mmsg2(&dev->errmsg, _("Buffer ID error. Wanted: %s, got %s. Buffer discarded.\n"),
226 Emsg0(M_ERROR, 0, dev->errmsg);
230 Mmsg1(&dev->errmsg, _("Expected block-id BB01 or BB02, got %s. Buffer discarded.\n"), Id);
231 Emsg0(M_ERROR, 0, dev->errmsg);
236 if (block_len > MAX_BLOCK_LENGTH) {
237 Mmsg1(&dev->errmsg, _("Block length %u is insane (too large), probably due to a bad archive.\n"),
239 Emsg0(M_ERROR, 0, dev->errmsg);
243 Dmsg1(190, "unser_block_header block_len=%d\n", block_len);
244 /* Find end of block or end of buffer whichever is smaller */
245 if (block_len > block->read_len) {
246 block_end = block->read_len;
248 block_end = block_len;
250 block->binbuf = block_end - bhl;
251 block->block_len = block_len;
252 block->BlockNumber = BlockNumber;
253 Dmsg3(190, "Read binbuf = %d %d block_len=%d\n", block->binbuf,
255 if (block_len <= block->read_len) {
256 BlockCheckSum = bcrc32((uint8_t *)block->buf+BLKHDR_CS_LENGTH,
257 block_len-BLKHDR_CS_LENGTH);
258 if (BlockCheckSum != CheckSum) {
259 Dmsg2(00, "Block checksum mismatch: calc=%x blk=%x\n", BlockCheckSum,
261 Mmsg3(&dev->errmsg, _("Block checksum mismatch in block %u: calc=%x blk=%x\n"),
262 (unsigned)BlockNumber, BlockCheckSum, CheckSum);
270 * Write a block to the device, with locking and unlocking
272 * Returns: 1 on success
276 int write_block_to_device(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
282 * If a new volume has been mounted since our last write
283 * Create a JobMedia record for the previous volume written,
284 * and set new parameters to write this volume
287 /* Create a jobmedia record for this job */
288 if (!dir_create_jobmedia_record(jcr)) {
289 Jmsg(jcr, M_ERROR, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
290 jcr->VolCatInfo.VolCatName, jcr->Job);
291 set_new_volume_parameters(jcr, dev);
295 set_new_volume_parameters(jcr, dev);
298 if (!write_block_to_dev(jcr, dev, block)) {
299 stat = fixup_device_block_write_error(jcr, dev, block);
307 * Write a block to the device
309 * Returns: 1 on success or EOT
312 int write_block_to_dev(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
315 uint32_t wlen; /* length to write */
316 int hit_max1, hit_max2;
319 #ifdef NO_TAPE_WRITE_TEST
323 ASSERT(block->binbuf == ((uint32_t) (block->bufp - block->buf)));
325 /* dump_block(block, "before write"); */
326 if (dev->state & ST_WEOT) {
327 Dmsg0(100, "return write_block_to_dev with ST_WEOT\n");
328 Jmsg(jcr, M_FATAL, 0, _("Cannot write block. Device at EOM.\n"));
331 wlen = block->binbuf;
332 if (wlen <= WRITE_BLKHDR_LENGTH) { /* Does block have data in it? */
333 Dmsg0(100, "return write_block_to_dev no data to write\n");
337 * Clear to the end of the buffer if it is not full,
338 * and on tape devices, apply min and fixed blocking.
340 if (wlen != block->buf_len) {
341 uint32_t blen; /* current buffer length */
343 Dmsg2(200, "binbuf=%d buf_len=%d\n", block->binbuf, block->buf_len);
346 /* Adjust write size to min/max for tapes only */
347 if (dev->state & ST_TAPE) {
348 if (wlen < dev->min_block_size) {
349 wlen = ((dev->min_block_size + TAPE_BSIZE - 1) / TAPE_BSIZE) * TAPE_BSIZE;
351 /* check for fixed block size */
352 if (dev->min_block_size == dev->max_block_size) {
353 wlen = block->buf_len; /* fixed block size already rounded */
357 memset(block->bufp, 0, wlen-blen); /* clear garbage */
361 ser_block_header(block);
363 /* Limit maximum Volume size to value specified by user */
364 hit_max1 = (dev->max_volume_size > 0) &&
365 ((dev->VolCatInfo.VolCatBytes + block->binbuf)) >= dev->max_volume_size;
366 hit_max2 = (dev->VolCatInfo.VolCatMaxBytes > 0) &&
367 ((dev->VolCatInfo.VolCatBytes + block->binbuf)) >= dev->VolCatInfo.VolCatMaxBytes;
368 if (hit_max1 || hit_max2) {
371 Dmsg0(10, "==== Output bytes Triggered medium max capacity.\n");
373 max_cap = dev->max_volume_size;
375 max_cap = dev->VolCatInfo.VolCatMaxBytes;
377 Jmsg(jcr, M_INFO, 0, _("User defined maximum volume capacity %s exceeded on device %s.\n"),
378 edit_uint64(max_cap, ed1), dev->dev_name);
379 block->write_failed = true;
380 weof_dev(dev, 1); /* end the tape */
381 weof_dev(dev, 1); /* write second eof */
382 dev->state |= (ST_EOF | ST_EOT | ST_WEOT);
386 /* Limit maximum File size on volume to user specified value */
387 if (dev->state & ST_TAPE) {
388 if ((dev->max_file_size > 0) &&
389 (dev->file_addr+block->binbuf) >= dev->max_file_size) {
390 if (weof_dev(dev, 1) != 0) { /* write eof */
391 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
392 /* Plunge on anyway -- if tape is bad we will die on write */
397 dev->VolCatInfo.VolCatWrites++;
398 Dmsg1(300, "Write block of %u bytes\n", wlen);
399 if ((uint32_t)(stat=write(dev->fd, block->buf, (size_t)wlen)) != wlen) {
400 /* We should check for errno == ENOSPC, BUT many
401 * devices simply report EIO when the volume is full.
402 * With a little more thought we may be able to check
403 * capacity and distinguish real errors and EOT
404 * conditions. In any case, we probably want to
405 * simulate an End of Medium.
408 /* I have added the ifdefing here because it appears on
409 * FreeBSD where MTIOCERRSTAT is defined, this not only
410 * clears the error but clears the residual unwritten
411 * buffers -> data loss. As a consequence, on those
412 * systems (FreeBSD like), do the clrerror() only after
413 * the weof_dev() call.
416 clrerror_dev(dev, -1);
418 dev->dev_errno = errno; /* save errno */
420 if (dev->dev_errno == 0) {
421 dev->dev_errno = ENOSPC; /* out of space */
423 Jmsg(jcr, M_ERROR, 0, _("Write error on device %s. ERR=%s.\n"),
424 dev->dev_name, strerror(dev->dev_errno));
426 dev->dev_errno = ENOSPC; /* out of space */
427 Jmsg3(jcr, M_INFO, 0, _("End of medium on device %s. Write of %u bytes got %d.\n"),
428 dev->dev_name, wlen, stat);
431 Dmsg4(10, "=== Write error. size=%u rtn=%d errno=%d: ERR=%s\n",
432 wlen, stat, dev->dev_errno, strerror(dev->dev_errno));
434 block->write_failed = true;
435 weof_dev(dev, 1); /* end the tape */
436 weof_dev(dev, 1); /* write second eof */
438 clrerror_dev(dev, -1);
440 dev->state |= (ST_EOF | ST_EOT | ST_WEOT);
443 #define CHECK_LAST_BLOCK
444 #ifdef CHECK_LAST_BLOCK
446 * If the device is a tape and it supports backspace record,
447 * we backspace over two eof marks and over the last record,
448 * then re-read it and verify that the block number is
451 if (dev->state & ST_TAPE && dev_cap(dev, CAP_BSR)) {
453 /* Now back up over what we wrote and read the last block */
454 if (bsf_dev(dev, 1) != 0 || bsf_dev(dev, 1) != 0) {
456 Jmsg(jcr, M_ERROR, 0, _("Backspace file at EOT failed. ERR=%s\n"), strerror(dev->dev_errno));
458 /* Backspace over record */
459 if (ok && bsr_dev(dev, 1) != 0) {
461 Jmsg(jcr, M_ERROR, 0, _("Backspace record at EOT failed. ERR=%s\n"), strerror(dev->dev_errno));
463 * On FreeBSD systems, if the user got here, it is likely that his/her
464 * tape drive is "frozen". The correct thing to do is a
465 * rewind(), but if we do that, higher levels in cleaning up, will
466 * most likely write the EOS record over the beginning of the
467 * tape. The rewind *is* done later in mount.c when another
468 * tape is requested. Note, the clrerror_dev() call in bsr_dev()
469 * calls ioctl(MTCERRSTAT), which *should* fix the problem.
473 DEV_BLOCK *lblock = new_block(dev);
474 /* Note, this can destroy dev->errmsg */
475 if (!read_block_from_dev(jcr, dev, lblock, NO_BLOCK_NUMBER_CHECK)) {
476 Jmsg(jcr, M_ERROR, 0, _("Re-read last block at EOT failed. ERR=%s"), dev->errmsg);
478 if (lblock->BlockNumber+1 == block->BlockNumber) {
479 Jmsg(jcr, M_INFO, 0, _("Re-read of last block succeeded.\n"));
481 Jmsg(jcr, M_ERROR, 0, _(
482 "Re-read of last block failed. Last block=%u Current block=%u.\n"),
483 lblock->BlockNumber, block->BlockNumber);
493 /* We successfully wrote the block, now do housekeeping */
495 dev->VolCatInfo.VolCatBytes += block->binbuf;
496 dev->VolCatInfo.VolCatBlocks++;
497 dev->file_addr += wlen;
498 dev->EndBlock = dev->block_num;
499 dev->EndFile = dev->file;
501 block->BlockNumber++;
503 /* Update jcr values */
504 if (dev->state & ST_TAPE) {
505 jcr->EndBlock = dev->EndBlock;
506 jcr->EndFile = dev->EndFile;
508 jcr->EndBlock = (uint32_t)dev->file_addr;
509 jcr->EndFile = (uint32_t)(dev->file_addr >> 32);
511 if (jcr->VolFirstIndex == 0 && block->FirstIndex > 0) {
512 jcr->VolFirstIndex = block->FirstIndex;
514 if (block->LastIndex > 0) {
515 jcr->VolLastIndex = block->LastIndex;
517 jcr->WroteVol = true;
519 Dmsg2(190, "write_block: wrote block %d bytes=%d\n", dev->block_num,
526 * Read block with locking
529 int read_block_from_device(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, bool check_block_numbers)
532 Dmsg0(90, "Enter read_block_from_device\n");
534 stat = read_block_from_dev(jcr, dev, block, check_block_numbers);
536 Dmsg0(90, "Leave read_block_from_device\n");
541 * Read the next block into the block structure and unserialize
542 * the block header. For a file, the block may be partially
543 * or completely in the current buffer.
545 int read_block_from_dev(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, bool check_block_numbers)
549 uint32_t BlockNumber;
553 Dmsg1(100, "Full read() in read_block_from_device() len=%d\n",
557 Mmsg1(&dev->errmsg, _("Block buffer size looping problem on device %s\n"),
559 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
564 stat = read(dev->fd, block->buf, (size_t)block->buf_len);
566 dev->VolCatInfo.VolCatErrors++;
568 } while (stat == -1 && (errno == EINTR || errno == EIO) && retry++ < 11);
570 Dmsg1(90, "Read device got: ERR=%s\n", strerror(errno));
571 clrerror_dev(dev, -1);
573 Mmsg2(&dev->errmsg, _("Read error on device %s. ERR=%s.\n"),
574 dev->dev_name, strerror(dev->dev_errno));
575 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
576 if (dev->state & ST_EOF) { /* EOF just seen? */
577 dev->state |= ST_EOT; /* yes, error => EOT */
581 Dmsg1(90, "Read device got %d bytes\n", stat);
582 if (stat == 0) { /* Got EOF ! */
583 dev->block_num = block->read_len = 0;
584 Mmsg1(&dev->errmsg, _("Read zero bytes on device %s.\n"), dev->dev_name);
585 if (dev->state & ST_EOF) { /* EOF already read? */
586 dev->state |= ST_EOT; /* yes, 2 EOFs => EOT */
590 dev->file++; /* increment file */
591 dev->state |= ST_EOF; /* set EOF read */
593 return 0; /* return eof */
595 /* Continue here for successful read */
596 block->read_len = stat; /* save length read */
597 if (block->read_len < BLKHDR2_LENGTH) {
598 Mmsg2(&dev->errmsg, _("Very short block of %d bytes on device %s discarded.\n"),
599 block->read_len, dev->dev_name);
600 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
601 dev->state |= ST_SHORT; /* set short block */
602 block->read_len = block->binbuf = 0;
603 return 0; /* return error */
606 BlockNumber = block->BlockNumber + 1;
607 if (!unser_block_header(dev, block)) {
613 * If the block is bigger than the buffer, we reposition for
614 * re-reading the block, allocate a buffer of the correct size,
617 if (block->block_len > block->buf_len) {
618 Mmsg2(&dev->errmsg, _("Block length %u is greater than buffer %u. Attempting recovery.\n"),
619 block->block_len, block->buf_len);
620 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
621 Pmsg1(000, "%s", dev->errmsg);
622 /* Attempt to reposition to re-read the block */
623 if (dev->state & ST_TAPE) {
624 Dmsg0(100, "Backspace record for reread.\n");
625 if (bsr_dev(dev, 1) != 0) {
626 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
631 Dmsg0(100, "Seek to beginning of block for reread.\n");
632 off_t pos = lseek(dev->fd, (off_t)0, SEEK_CUR); /* get curr pos */
633 pos -= block->read_len;
634 lseek(dev->fd, pos, SEEK_SET);
636 Mmsg1(&dev->errmsg, _("Setting block buffer size to %u bytes.\n"), block->block_len);
637 Jmsg(jcr, M_INFO, 0, "%s", dev->errmsg);
638 Pmsg1(000, "%s", dev->errmsg);
639 /* Set new block length */
640 dev->max_block_size = block->block_len;
641 block->buf_len = block->block_len;
642 free_memory(block->buf);
643 block->buf = get_memory(block->buf_len);
646 goto reread; /* re-read block with correct block size */
649 if (block->block_len > block->read_len) {
650 Mmsg2(&dev->errmsg, _("Short block of %d bytes on device %s discarded.\n"),
651 block->read_len, dev->dev_name);
652 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
653 dev->state |= ST_SHORT; /* set short block */
654 block->read_len = block->binbuf = 0;
655 return 0; /* return error */
658 dev->state &= ~(ST_EOF|ST_SHORT); /* clear EOF and short block */
659 dev->VolCatInfo.VolCatReads++;
660 dev->VolCatInfo.VolCatRBytes += block->read_len;
662 dev->VolCatInfo.VolCatBytes += block->block_len;
663 dev->VolCatInfo.VolCatBlocks++;
664 dev->file_addr += block->block_len;
665 dev->EndBlock = dev->block_num;
666 dev->EndFile = dev->file;
669 /* Update jcr values */
670 if (dev->state & ST_TAPE) {
671 jcr->EndBlock = dev->EndBlock;
672 jcr->EndFile = dev->EndFile;
674 jcr->EndBlock = (uint32_t)dev->file_addr;
675 jcr->EndFile = (uint32_t)(dev->file_addr >> 32);
679 * If we read a short block on disk,
680 * seek to beginning of next block. This saves us
681 * from shuffling blocks around in the buffer. Take a
682 * look at this from an efficiency stand point later, but
683 * it should only happen once at the end of each job.
685 * I've been lseek()ing negative relative to SEEK_CUR for 30
686 * years now. However, it seems that with the new off_t definition,
687 * it is not possible to seek negative amounts, so we use two
688 * lseek(). One to get the position, then the second to do an
689 * absolute positioning -- so much for efficiency. KES Sep 02.
691 Dmsg0(200, "At end of read block\n");
692 if (block->read_len > block->block_len && !(dev->state & ST_TAPE)) {
693 off_t pos = lseek(dev->fd, (off_t)0, SEEK_CUR); /* get curr pos */
694 pos -= (block->read_len - block->block_len);
695 lseek(dev->fd, pos, SEEK_SET);
696 Dmsg2(100, "Did lseek blk_size=%d rdlen=%d\n", block->block_len,
699 Dmsg2(200, "Exit read_block read_len=%d block_len=%d\n",
700 block->read_len, block->block_len);
701 block->block_read = true;