3 * block.c -- tape block handling functions
5 * Kern Sibbald, March MMI
6 * added BB02 format October MMII
12 Bacula® - The Network Backup Solution
14 Copyright (C) 2001-2007 Free Software Foundation Europe e.V.
16 The main author of Bacula is Kern Sibbald, with contributions from
17 many others, a complete list can be found in the file AUTHORS.
18 This program is Free Software; you can redistribute it and/or
19 modify it under the terms of version two of the GNU General Public
20 License as published by the Free Software Foundation plus additions
21 that are listed in the file LICENSE.
23 This program is distributed in the hope that it will be useful, but
24 WITHOUT ANY WARRANTY; without even the implied warranty of
25 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
26 General Public License for more details.
28 You should have received a copy of the GNU General Public License
29 along with this program; if not, write to the Free Software
30 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
33 Bacula® is a registered trademark of John Walker.
34 The licensor of Bacula is the Free Software Foundation Europe
35 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
36 Switzerland, email:ftf@fsfeurope.org.
43 static bool terminate_writing_volume(DCR *dcr);
44 static bool do_new_file_bookkeeping(DCR *dcr);
45 static bool do_dvd_size_checks(DCR *dcr);
46 static void reread_last_block(DCR *dcr);
49 * Dump the block header, then walk through
50 * the block printing out the record headers.
52 void dump_block(DEV_BLOCK *b, const char *msg)
56 char Id[BLKHDR_ID_LENGTH+1];
57 uint32_t CheckSum, BlockCheckSum;
60 uint32_t VolSessionId, VolSessionTime, data_len;
64 char buf1[100], buf2[100];
66 unser_begin(b->buf, BLKHDR1_LENGTH);
67 unser_uint32(CheckSum);
68 unser_uint32(block_len);
69 unser_uint32(BlockNumber);
70 unser_bytes(Id, BLKHDR_ID_LENGTH);
71 ASSERT(unser_length(b->buf) == BLKHDR1_LENGTH);
72 Id[BLKHDR_ID_LENGTH] = 0;
74 unser_uint32(VolSessionId);
75 unser_uint32(VolSessionTime);
79 VolSessionId = VolSessionTime = 0;
84 if (block_len > 100000) {
85 Dmsg3(20, "Dump block %s 0x%x blocksize too big %u\n", msg, b, block_len);
89 BlockCheckSum = bcrc32((uint8_t *)b->buf+BLKHDR_CS_LENGTH,
90 block_len-BLKHDR_CS_LENGTH);
91 Pmsg6(000, _("Dump block %s %x: size=%d BlkNum=%d\n"
92 " Hdrcksum=%x cksum=%x\n"),
93 msg, b, block_len, BlockNumber, CheckSum, BlockCheckSum);
95 while (p < (b->buf + block_len+WRITE_RECHDR_LENGTH)) {
96 unser_begin(p, WRITE_RECHDR_LENGTH);
97 if (rhl == RECHDR1_LENGTH) {
98 unser_uint32(VolSessionId);
99 unser_uint32(VolSessionTime);
101 unser_int32(FileIndex);
103 unser_uint32(data_len);
104 Pmsg6(000, _(" Rec: VId=%u VT=%u FI=%s Strm=%s len=%d p=%x\n"),
105 VolSessionId, VolSessionTime, FI_to_ascii(buf1, FileIndex),
106 stream_to_ascii(buf2, Stream, FileIndex), data_len, p);
112 * Create a new block structure.
113 * We pass device so that the block can inherit the
114 * min and max block sizes.
116 DEV_BLOCK *new_block(DEVICE *dev)
118 DEV_BLOCK *block = (DEV_BLOCK *)get_memory(sizeof(DEV_BLOCK));
120 memset(block, 0, sizeof(DEV_BLOCK));
122 /* If the user has specified a max_block_size, use it as the default */
123 if (dev->max_block_size == 0) {
124 block->buf_len = DEFAULT_BLOCK_SIZE;
126 block->buf_len = dev->max_block_size;
129 block->block_len = block->buf_len; /* default block size */
130 block->buf = get_memory(block->buf_len);
132 block->BlockVer = BLOCK_VER; /* default write version */
133 Dmsg1(650, "Returning new block=%x\n", block);
139 * Duplicate an existing block (eblock)
141 DEV_BLOCK *dup_block(DEV_BLOCK *eblock)
143 DEV_BLOCK *block = (DEV_BLOCK *)get_memory(sizeof(DEV_BLOCK));
144 int buf_len = sizeof_pool_memory(eblock->buf);
146 memcpy(block, eblock, sizeof(DEV_BLOCK));
147 block->buf = get_memory(buf_len);
148 memcpy(block->buf, eblock->buf, buf_len);
154 * Only the first block checksum error was reported.
155 * If there are more, report it now.
157 void print_block_read_errors(JCR *jcr, DEV_BLOCK *block)
159 if (block->read_errors > 1) {
160 Jmsg(jcr, M_ERROR, 0, _("%d block read errors not printed.\n"),
168 void free_block(DEV_BLOCK *block)
170 Dmsg1(999, "free_block buffer %x\n", block->buf);
171 free_memory(block->buf);
172 Dmsg1(999, "free_block block %x\n", block);
173 free_memory((POOLMEM *)block);
176 /* Empty the block -- for writing */
177 void empty_block(DEV_BLOCK *block)
179 block->binbuf = WRITE_BLKHDR_LENGTH;
180 block->bufp = block->buf + block->binbuf;
182 block->write_failed = false;
183 block->block_read = false;
184 block->FirstIndex = block->LastIndex = 0;
188 * Create block header just before write. The space
189 * in the buffer should have already been reserved by
192 void ser_block_header(DEV_BLOCK *block)
195 uint32_t CheckSum = 0;
196 uint32_t block_len = block->binbuf;
198 Dmsg1(1390, "ser_block_header: block_len=%d\n", block_len);
199 ser_begin(block->buf, BLKHDR2_LENGTH);
200 ser_uint32(CheckSum);
201 ser_uint32(block_len);
202 ser_uint32(block->BlockNumber);
203 ser_bytes(WRITE_BLKHDR_ID, BLKHDR_ID_LENGTH);
204 if (BLOCK_VER >= 2) {
205 ser_uint32(block->VolSessionId);
206 ser_uint32(block->VolSessionTime);
209 /* Checksum whole block except for the checksum */
210 CheckSum = bcrc32((uint8_t *)block->buf+BLKHDR_CS_LENGTH,
211 block_len-BLKHDR_CS_LENGTH);
212 Dmsg1(1390, "ser_bloc_header: checksum=%x\n", CheckSum);
213 ser_begin(block->buf, BLKHDR2_LENGTH);
214 ser_uint32(CheckSum); /* now add checksum to block header */
218 * Unserialize the block header for reading block.
219 * This includes setting all the buffer pointers correctly.
221 * Returns: false on failure (not a block)
224 static bool unser_block_header(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
227 char Id[BLKHDR_ID_LENGTH+1];
228 uint32_t CheckSum, BlockCheckSum;
231 uint32_t BlockNumber;
234 unser_begin(block->buf, BLKHDR_LENGTH);
235 unser_uint32(CheckSum);
236 unser_uint32(block_len);
237 unser_uint32(BlockNumber);
238 unser_bytes(Id, BLKHDR_ID_LENGTH);
239 ASSERT(unser_length(block->buf) == BLKHDR1_LENGTH);
241 Id[BLKHDR_ID_LENGTH] = 0;
243 bhl = BLKHDR1_LENGTH;
245 block->bufp = block->buf + bhl;
246 if (strncmp(Id, BLKHDR1_ID, BLKHDR_ID_LENGTH) != 0) {
247 dev->dev_errno = EIO;
248 Mmsg4(dev->errmsg, _("Volume data error at %u:%u! Wanted ID: \"%s\", got \"%s\". Buffer discarded.\n"),
249 dev->file, dev->block_num, BLKHDR1_ID, Id);
250 if (block->read_errors == 0 || verbose >= 2) {
251 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
253 block->read_errors++;
256 } else if (Id[3] == '2') {
257 unser_uint32(block->VolSessionId);
258 unser_uint32(block->VolSessionTime);
259 bhl = BLKHDR2_LENGTH;
261 block->bufp = block->buf + bhl;
262 if (strncmp(Id, BLKHDR2_ID, BLKHDR_ID_LENGTH) != 0) {
263 dev->dev_errno = EIO;
264 Mmsg4(dev->errmsg, _("Volume data error at %u:%u! Wanted ID: \"%s\", got \"%s\". Buffer discarded.\n"),
265 dev->file, dev->block_num, BLKHDR2_ID, Id);
266 if (block->read_errors == 0 || verbose >= 2) {
267 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
269 block->read_errors++;
273 dev->dev_errno = EIO;
274 Mmsg4(dev->errmsg, _("Volume data error at %u:%u! Wanted ID: \"%s\", got \"%s\". Buffer discarded.\n"),
275 dev->file, dev->block_num, BLKHDR2_ID, Id);
276 if (block->read_errors == 0 || verbose >= 2) {
277 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
279 block->read_errors++;
280 unser_uint32(block->VolSessionId);
281 unser_uint32(block->VolSessionTime);
286 if (block_len > MAX_BLOCK_LENGTH) {
287 dev->dev_errno = EIO;
288 Mmsg3(dev->errmsg, _("Volume data error at %u:%u! Block length %u is insane (too large), probably due to a bad archive.\n"),
289 dev->file, dev->block_num, block_len);
290 if (block->read_errors == 0 || verbose >= 2) {
291 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
293 block->read_errors++;
297 Dmsg1(390, "unser_block_header block_len=%d\n", block_len);
298 /* Find end of block or end of buffer whichever is smaller */
299 if (block_len > block->read_len) {
300 block_end = block->read_len;
302 block_end = block_len;
304 block->binbuf = block_end - bhl;
305 block->block_len = block_len;
306 block->BlockNumber = BlockNumber;
307 Dmsg3(390, "Read binbuf = %d %d block_len=%d\n", block->binbuf,
309 if (block_len <= block->read_len) {
310 BlockCheckSum = bcrc32((uint8_t *)block->buf+BLKHDR_CS_LENGTH,
311 block_len-BLKHDR_CS_LENGTH);
312 if (BlockCheckSum != CheckSum) {
313 dev->dev_errno = EIO;
314 Mmsg6(dev->errmsg, _("Volume data error at %u:%u!\n"
315 "Block checksum mismatch in block=%u len=%d: calc=%x blk=%x\n"),
316 dev->file, dev->block_num, (unsigned)BlockNumber,
317 block_len, BlockCheckSum, CheckSum);
318 if (block->read_errors == 0 || verbose >= 2) {
319 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
321 block->read_errors++;
331 * Write a block to the device, with locking and unlocking
333 * Returns: true on success
337 bool write_block_to_device(DCR *dcr)
340 DEVICE *dev = dcr->dev;
344 stat = write_block_to_spool_file(dcr);
348 if (!dcr->dev_locked) { /* device already locked? */
349 lock_device(dev); /* no, lock it */
353 * If a new volume has been mounted since our last write
354 * Create a JobMedia record for the previous volume written,
355 * and set new parameters to write this volume
356 * The same applies for if we are in a new file.
358 if (dcr->NewVol || dcr->NewFile) {
359 if (job_canceled(jcr)) {
363 /* Create a jobmedia record for this job */
364 if (!dir_create_jobmedia_record(dcr)) {
365 dev->dev_errno = EIO;
366 Jmsg(jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
367 dcr->VolCatInfo.VolCatName, jcr->Job);
368 set_new_volume_parameters(dcr);
373 /* Note, setting a new volume also handles any pending new file */
374 set_new_volume_parameters(dcr);
375 dcr->NewFile = false; /* this handled for new file too */
377 set_new_file_parameters(dcr);
381 if (!write_block_to_dev(dcr)) {
382 if (job_canceled(jcr) || jcr->JobType == JT_SYSTEM) {
385 stat = fixup_device_block_write_error(dcr);
390 if (!dcr->dev_locked) { /* did we lock dev above? */
391 unlock_device(dev); /* unlock it now */
397 * Write a block to the device
399 * Returns: true on success or EOT
400 * false on hard error
402 bool write_block_to_dev(DCR *dcr)
405 uint32_t wlen; /* length to write */
406 int hit_max1, hit_max2;
408 DEVICE *dev = dcr->dev;
410 DEV_BLOCK *block = dcr->block;
412 #ifdef NO_TAPE_WRITE_TEST
416 ASSERT(block->binbuf == ((uint32_t) (block->bufp - block->buf)));
417 ASSERT(dev->is_open());
419 /* dump_block(block, "before write"); */
420 if (dev->at_weot()) {
421 Dmsg0(100, "return write_block_to_dev with ST_WEOT\n");
422 dev->dev_errno = ENOSPC;
423 Jmsg(jcr, M_FATAL, 0, _("Cannot write block. Device at EOM.\n"));
426 if (!dev->can_append()) {
427 dev->dev_errno = EIO;
428 Jmsg(jcr, M_FATAL, 0, _("Attempt to write on read-only Volume.\n"));
431 wlen = block->binbuf;
432 if (wlen <= WRITE_BLKHDR_LENGTH) { /* Does block have data in it? */
433 Dmsg0(100, "return write_block_to_dev no data to write\n");
437 * Clear to the end of the buffer if it is not full,
438 * and on tape devices, apply min and fixed blocking.
440 if (wlen != block->buf_len) {
441 uint32_t blen; /* current buffer length */
443 Dmsg2(200, "binbuf=%d buf_len=%d\n", block->binbuf, block->buf_len);
446 /* Adjust write size to min/max for tapes only */
447 if (dev->is_tape()) {
448 /* check for fixed block size */
449 if (dev->min_block_size == dev->max_block_size) {
450 wlen = block->buf_len; /* fixed block size already rounded */
451 /* Check for min block size */
452 } else if (wlen < dev->min_block_size) {
453 wlen = ((dev->min_block_size + TAPE_BSIZE - 1) / TAPE_BSIZE) * TAPE_BSIZE;
454 /* Ensure size is rounded */
456 wlen = ((wlen + TAPE_BSIZE - 1) / TAPE_BSIZE) * TAPE_BSIZE;
460 memset(block->bufp, 0, wlen-blen); /* clear garbage */
464 ser_block_header(block);
466 /* Limit maximum Volume size to value specified by user */
467 hit_max1 = (dev->max_volume_size > 0) &&
468 ((dev->VolCatInfo.VolCatBytes + block->binbuf)) >= dev->max_volume_size;
469 hit_max2 = (dev->VolCatInfo.VolCatMaxBytes > 0) &&
470 ((dev->VolCatInfo.VolCatBytes + block->binbuf)) >= dev->VolCatInfo.VolCatMaxBytes;
471 if (hit_max1 || hit_max2) {
474 Dmsg0(10, "==== Output bytes Triggered medium max capacity.\n");
476 max_cap = dev->max_volume_size;
478 max_cap = dev->VolCatInfo.VolCatMaxBytes;
480 Jmsg(jcr, M_INFO, 0, _("User defined maximum volume capacity %s exceeded on device %s.\n"),
481 edit_uint64_with_commas(max_cap, ed1), dev->print_name());
482 terminate_writing_volume(dcr);
483 reread_last_block(dcr); /* DEBUG */
484 dev->dev_errno = ENOSPC;
488 /* Limit maximum File size on volume to user specified value */
489 if ((dev->max_file_size > 0) &&
490 (dev->file_size+block->binbuf) >= dev->max_file_size) {
491 dev->file_size = 0; /* reset file size */
493 if (!dev->weof(1)) { /* write eof */
494 Dmsg0(190, "WEOF error in max file size.\n");
495 Jmsg(jcr, M_FATAL, 0, _("Unable to write EOF. ERR=%s\n"),
497 terminate_writing_volume(dcr);
498 dev->dev_errno = ENOSPC;
501 if (!write_ansi_ibm_labels(dcr, ANSI_EOF_LABEL, dev->VolHdr.VolumeName)) {
505 if (!do_new_file_bookkeeping(dcr)) {
506 /* Error message already sent */
511 if (!do_dvd_size_checks(dcr)) {
512 /* Error message already sent */
516 dev->VolCatInfo.VolCatWrites++;
517 Dmsg1(1300, "Write block of %u bytes\n", wlen);
518 #ifdef DEBUG_BLOCK_ZEROING
519 uint32_t *bp = (uint32_t *)block->buf;
520 if (bp[0] == 0 && bp[1] == 0 && bp[2] == 0 && block->buf[12] == 0) {
521 Jmsg0(jcr, M_ABORT, 0, _("Write block header zeroed.\n"));
526 * Do write here, make a somewhat feeble attempt to recover from
527 * I/O errors, or from the OS telling us it is busy.
533 if (retry > 0 && stat == -1 && errno == EBUSY) {
535 Dmsg4(100, "===== write retry=%d stat=%d errno=%d: ERR=%s\n",
536 retry, stat, errno, be.strerror());
537 bmicrosleep(5, 0); /* pause a bit if busy or lots of errors */
540 if (dev->is_tape()) {
541 stat = tape_write(dev->fd, block->buf, (size_t)wlen);
543 stat = write(dev->fd, block->buf, (size_t)wlen);
545 } while (stat == -1 && (errno == EBUSY || errno == EIO) && retry++ < 3);
547 #ifdef DEBUG_BLOCK_ZEROING
548 if (bp[0] == 0 && bp[1] == 0 && bp[2] == 0 && block->buf[12] == 0) {
549 Jmsg0(jcr, M_ABORT, 0, _("Write block header zeroed.\n"));
553 if (stat != (ssize_t)wlen) {
554 /* Some devices simply report EIO when the volume is full.
555 * With a little more thought we may be able to check
556 * capacity and distinguish real errors and EOT
557 * conditions. In any case, we probably want to
558 * simulate an End of Medium.
563 if (dev->dev_errno == 0) {
564 dev->dev_errno = ENOSPC; /* out of space */
566 if (dev->dev_errno != ENOSPC) {
567 dev->VolCatInfo.VolCatErrors++;
568 Jmsg4(jcr, M_ERROR, 0, _("Write error at %u:%u on device %s. ERR=%s.\n"),
569 dev->file, dev->block_num, dev->print_name(), be.strerror());
572 dev->dev_errno = ENOSPC; /* out of space */
574 if (dev->dev_errno == ENOSPC) {
575 Jmsg(jcr, M_INFO, 0, _("End of Volume \"%s\" at %u:%u on device %s. Write of %u bytes got %d.\n"),
576 dev->VolCatInfo.VolCatName,
577 dev->file, dev->block_num, dev->print_name(), wlen, stat);
579 Dmsg7(100, "=== Write error. fd=%d size=%u rtn=%d dev_blk=%d blk_blk=%d errno=%d: ERR=%s\n",
580 dev->fd, wlen, stat, dev->block_num, block->BlockNumber,
581 dev->dev_errno, strerror(dev->dev_errno));
583 ok = terminate_writing_volume(dcr);
584 if (!ok && !forge_on) {
588 reread_last_block(dcr);
593 /* We successfully wrote the block, now do housekeeping */
594 Dmsg2(1300, "VolCatBytes=%d newVolCatBytes=%d\n", (int)dev->VolCatInfo.VolCatBytes,
595 (int)(dev->VolCatInfo.VolCatBytes+wlen));
596 dev->VolCatInfo.VolCatBytes += wlen;
597 dev->VolCatInfo.VolCatBlocks++;
598 dev->EndBlock = dev->block_num;
599 dev->EndFile = dev->file;
600 block->BlockNumber++;
602 /* Update dcr values */
603 if (dev->is_tape()) {
604 dcr->EndBlock = dev->EndBlock;
605 dcr->EndFile = dev->EndFile;
608 /* Save address of block just written */
609 uint64_t addr = dev->file_addr + wlen - 1;
610 dcr->EndBlock = (uint32_t)addr;
611 dcr->EndFile = (uint32_t)(addr >> 32);
612 dev->block_num = dcr->EndBlock;
613 dev->file = dcr->EndFile;
615 if (dcr->VolFirstIndex == 0 && block->FirstIndex > 0) {
616 dcr->VolFirstIndex = block->FirstIndex;
618 if (block->LastIndex > 0) {
619 dcr->VolLastIndex = block->LastIndex;
621 dcr->WroteVol = true;
622 dev->file_addr += wlen; /* update file address */
623 dev->file_size += wlen;
624 dev->part_size += wlen;
626 Dmsg2(1300, "write_block: wrote block %d bytes=%d\n", dev->block_num, wlen);
631 static void reread_last_block(DCR *dcr)
633 #define CHECK_LAST_BLOCK
634 #ifdef CHECK_LAST_BLOCK
636 DEVICE *dev = dcr->dev;
638 DEV_BLOCK *block = dcr->block;
640 * If the device is a tape and it supports backspace record,
641 * we backspace over one or two eof marks depending on
642 * how many we just wrote, then over the last record,
643 * then re-read it and verify that the block number is
646 if (dev->is_tape() && dev->has_cap(CAP_BSR)) {
647 /* Now back up over what we wrote and read the last block */
651 Jmsg(jcr, M_ERROR, 0, _("Backspace file at EOT failed. ERR=%s\n"),
652 be.strerror(dev->dev_errno));
654 if (ok && dev->has_cap(CAP_TWOEOF) && !dev->bsf(1)) {
657 Jmsg(jcr, M_ERROR, 0, _("Backspace file at EOT failed. ERR=%s\n"),
658 be.strerror(dev->dev_errno));
660 /* Backspace over record */
661 if (ok && !dev->bsr(1)) {
664 Jmsg(jcr, M_ERROR, 0, _("Backspace record at EOT failed. ERR=%s\n"),
665 be.strerror(dev->dev_errno));
667 * On FreeBSD systems, if the user got here, it is likely that his/her
668 * tape drive is "frozen". The correct thing to do is a
669 * rewind(), but if we do that, higher levels in cleaning up, will
670 * most likely write the EOS record over the beginning of the
671 * tape. The rewind *is* done later in mount.c when another
672 * tape is requested. Note, the clrerror() call in bsr()
673 * calls ioctl(MTCERRSTAT), which *should* fix the problem.
677 DEV_BLOCK *lblock = new_block(dev);
678 /* Note, this can destroy dev->errmsg */
680 if (!read_block_from_dev(dcr, NO_BLOCK_NUMBER_CHECK)) {
681 Jmsg(jcr, M_ERROR, 0, _("Re-read last block at EOT failed. ERR=%s"),
685 * If we wrote block and the block numbers don't agree
686 * we have a possible problem.
688 if (lblock->VolSessionId == block->VolSessionId &&
689 lblock->BlockNumber+1 != block->BlockNumber) {
690 Jmsg(jcr, M_ERROR, 0, _(
691 "Re-read of last block OK, but block numbers differ. Last block=%u Current block=%u.\n"),
692 lblock->BlockNumber, block->BlockNumber);
694 Jmsg(jcr, M_INFO, 0, _("Re-read of last block succeeded.\n"));
704 static bool terminate_writing_volume(DCR *dcr)
706 DEVICE *dev = dcr->dev;
709 /* Create a JobMedia record to indicated end of tape */
710 dev->VolCatInfo.VolCatFiles = dev->file;
711 if (!dir_create_jobmedia_record(dcr)) {
712 Dmsg0(190, "Error from create JobMedia\n");
713 dev->dev_errno = EIO;
714 Jmsg(dcr->jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
715 dcr->VolCatInfo.VolCatName, dcr->jcr->Job);
719 dcr->block->write_failed = true;
720 if (!dev->weof(1)) { /* end the tape */
721 dev->VolCatInfo.VolCatErrors++;
722 Jmsg(dcr->jcr, M_ERROR, 0, _("Error writing final EOF to tape. This Volume may not be readable.\n"
725 Dmsg0(100, "WEOF error.\n");
728 ok = write_ansi_ibm_labels(dcr, ANSI_EOV_LABEL, dev->VolHdr.VolumeName);
730 bstrncpy(dev->VolCatInfo.VolCatStatus, "Full", sizeof(dev->VolCatInfo.VolCatStatus));
731 dev->VolCatInfo.VolCatFiles = dev->file; /* set number of files */
734 if (!dvd_write_part(dcr)) { /* write last part */
735 dev->VolCatInfo.VolCatErrors++;
736 Jmsg(dcr->jcr, M_FATAL, 0, _("Error writing final part to DVD. "
737 "This Volume may not be readable.\n%s"),
740 Dmsg0(100, "dvd_write_part error.\n");
742 dev->VolCatInfo.VolCatParts = dev->num_dvd_parts;
745 if (!dir_update_volume_info(dcr, false)) {
748 Dmsg1(100, "dir_update_volume_info terminate writing -- %s\n", ok?"OK":"ERROR");
751 * Walk through all attached dcrs setting flag to call
752 * set_new_file_parameters() when that dcr is next used.
755 foreach_dlist(mdcr, dev->attached_dcrs) {
756 if (mdcr->jcr->JobId == 0) {
759 mdcr->NewFile = true; /* set reminder to do set_new_file_params */
761 /* Set new file/block parameters for current dcr */
762 set_new_file_parameters(dcr);
764 if (ok && dev->has_cap(CAP_TWOEOF) && !dev->weof(1)) { /* end the tape */
765 dev->VolCatInfo.VolCatErrors++;
766 /* This may not be fatal since we already wrote an EOF */
767 Jmsg(dcr->jcr, M_ERROR, 0, "%s", dev->errmsg);
770 dev->set_ateot(); /* no more writing this tape */
771 Dmsg1(100, "Leave terminate_writing_volume -- %s\n", ok?"OK":"ERROR");
776 * Do bookkeeping when a new file is created on a Volume. This is
777 * also done for disk files to generate the jobmedia records for
780 static bool do_new_file_bookkeeping(DCR *dcr)
782 DEVICE *dev = dcr->dev;
785 /* Create a JobMedia record so restore can seek */
786 if (!dir_create_jobmedia_record(dcr)) {
787 Dmsg0(190, "Error from create_job_media.\n");
788 dev->dev_errno = EIO;
789 Jmsg(jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
790 dcr->VolCatInfo.VolCatName, jcr->Job);
791 terminate_writing_volume(dcr);
792 dev->dev_errno = EIO;
795 dev->VolCatInfo.VolCatFiles = dev->file;
796 if (!dir_update_volume_info(dcr, false)) {
797 Dmsg0(190, "Error from update_vol_info.\n");
798 terminate_writing_volume(dcr);
799 dev->dev_errno = EIO;
802 Dmsg0(100, "dir_update_volume_info max file size -- OK\n");
805 * Walk through all attached dcrs setting flag to call
806 * set_new_file_parameters() when that dcr is next used.
809 foreach_dlist(mdcr, dev->attached_dcrs) {
810 if (mdcr->jcr->JobId == 0) {
813 mdcr->NewFile = true; /* set reminder to do set_new_file_params */
815 /* Set new file/block parameters for current dcr */
816 set_new_file_parameters(dcr);
821 * Do all checks for DVD sizes during writing.
823 static bool do_dvd_size_checks(DCR *dcr)
825 DEVICE *dev = dcr->dev;
827 DEV_BLOCK *block = dcr->block;
829 /* Don't go further if the device is not a dvd */
830 if (!dev->is_dvd()) {
834 /* Limit maximum part size to value specified by user
836 if (dev->max_part_size > 0 && ((dev->part_size + block->binbuf) >= dev->max_part_size)) {
837 if (dev->part < dev->num_dvd_parts) {
838 Jmsg3(dcr->jcr, M_FATAL, 0, _("Error while writing, current part number"
839 " is less than the total number of parts (%d/%d, device=%s)\n"),
840 dev->part, dev->num_dvd_parts, dev->print_name());
841 dev->dev_errno = EIO;
845 if (dvd_open_next_part(dcr) < 0) {
846 Jmsg2(dcr->jcr, M_FATAL, 0, _("Unable to open device next part %s: ERR=%s\n"),
847 dev->print_name(), dev->bstrerror());
848 dev->dev_errno = EIO;
852 dev->VolCatInfo.VolCatParts = dev->num_dvd_parts;
854 if (!dir_update_volume_info(dcr, false)) {
855 Dmsg0(190, "Error from update_vol_info.\n");
856 dev->dev_errno = EIO;
861 dev->update_freespace();
863 if (!dev->is_freespace_ok()) { /* Error while getting free space */
864 char ed1[50], ed2[50];
865 Dmsg1(10, "Cannot get free space on the device ERR=%s.\n", dev->errmsg);
866 Jmsg(jcr, M_FATAL, 0, _("End of Volume \"%s\" at %u:%u on device %s "
867 "(part_size=%s, free_space=%s, free_space_errno=%d, errmsg=%s).\n"),
868 dev->VolCatInfo.VolCatName,
869 dev->file, dev->block_num, dev->print_name(),
870 edit_uint64_with_commas(dev->part_size, ed1), edit_uint64_with_commas(dev->free_space, ed2),
871 dev->free_space_errno, dev->errmsg);
872 dev->dev_errno = dev->free_space_errno;
876 if ((dev->is_freespace_ok() && (dev->part_size + block->binbuf) >= dev->free_space)) {
877 char ed1[50], ed2[50];
878 Dmsg0(10, "==== Just enough free space on the device to write the current part...\n");
879 Jmsg(jcr, M_INFO, 0, _("End of Volume \"%s\" at %u:%u on device %s "
880 "(part_size=%s, free_space=%s, free_space_errno=%d).\n"),
881 dev->VolCatInfo.VolCatName,
882 dev->file, dev->block_num, dev->print_name(),
883 edit_uint64_with_commas(dev->part_size, ed1), edit_uint64_with_commas(dev->free_space, ed2),
884 dev->free_space_errno);
885 terminate_writing_volume(dcr);
886 dev->dev_errno = ENOSPC;
894 * Read block with locking
897 bool read_block_from_device(DCR *dcr, bool check_block_numbers)
900 DEVICE *dev = dcr->dev;
901 Dmsg0(200, "Enter read_block_from_device\n");
903 ok = read_block_from_dev(dcr, check_block_numbers);
905 Dmsg0(200, "Leave read_block_from_device\n");
910 * Read the next block into the block structure and unserialize
911 * the block header. For a file, the block may be partially
912 * or completely in the current buffer.
914 bool read_block_from_dev(DCR *dcr, bool check_block_numbers)
918 uint32_t BlockNumber;
921 DEVICE *dev = dcr->dev;
922 DEV_BLOCK *block = dcr->block;
924 ASSERT(dev->is_open());
930 Dmsg1(200, "Full read in read_block_from_device() len=%d\n",
934 dev->dev_errno = EIO;
935 Mmsg1(dev->errmsg, _("Block buffer size looping problem on device %s\n"),
937 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
942 // #define lots_of_debug
944 if (dev->at_eof() && dev->is_dvd()) {
945 Dmsg1(100, "file_size=%u\n",(unsigned int)dev->file_size);
946 Dmsg1(100, "file_addr=%u\n",(unsigned int)dev->file_addr);
947 Dmsg1(100, "lseek=%u\n",(unsigned int)lseek(dev->fd, 0, SEEK_CUR));
948 Dmsg1(100, "part_start=%u\n",(unsigned int)dev->part_start);
949 Dmsg1(100, "part_size=%u\n", (unsigned int)dev->part_size);
950 Dmsg2(100, "part=%u num_dvd_parts=%u\n", dev->part, dev->num_dvd_parts);
951 Dmsg1(100, "VolCatInfo.VolCatParts=%u\n", (unsigned int)dev->VolCatInfo.VolCatParts);
952 Dmsg3(100, "Tests : %d %d %d\n", (dev->VolCatInfo.VolCatParts > 0),
953 ((dev->file_addr-dev->part_start) == dev->part_size),
954 (dev->part <= dev->VolCatInfo.VolCatParts));
958 /* Check for DVD part file end */
959 if (dev->at_eof() && dev->is_dvd() && dev->num_dvd_parts > 0 &&
960 dev->part <= dev->num_dvd_parts) {
961 Dmsg0(400, "Call dvd_open_next_part\n");
962 if (dvd_open_next_part(dcr) < 0) {
963 Jmsg3(dcr->jcr, M_FATAL, 0, _("Unable to open device part=%d %s: ERR=%s\n"),
964 dev->part, dev->print_name(), dev->bstrerror());
965 dev->dev_errno = EIO;
974 if ((retry > 0 && stat == -1 && errno == EBUSY)) {
976 Dmsg4(100, "===== read retry=%d stat=%d errno=%d: ERR=%s\n",
977 retry, stat, errno, be.strerror());
978 bmicrosleep(10, 0); /* pause a bit if busy or lots of errors */
981 if (dev->is_tape()) {
982 stat = tape_read(dev->fd, block->buf, (size_t)block->buf_len);
984 stat = read(dev->fd, block->buf, (size_t)block->buf_len);
986 } while (stat == -1 && (errno == EBUSY || errno == EINTR || errno == EIO) && retry++ < 3);
990 Dmsg1(200, "Read device got: ERR=%s\n", be.strerror());
992 Mmsg5(dev->errmsg, _("Read error on fd=%d at file:blk %u:%u on device %s. ERR=%s.\n"),
993 dev->fd, dev->file, dev->block_num, dev->print_name(), be.strerror());
994 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
995 if (dev->at_eof()) { /* EOF just seen? */
996 dev->set_eot(); /* yes, error => EOT */
1000 Dmsg3(200, "Read device got %d bytes at %u:%u\n", stat,
1001 dev->file, dev->block_num);
1002 if (stat == 0) { /* Got EOF ! */
1004 block->read_len = 0;
1005 Mmsg3(dev->errmsg, _("Read zero bytes at %u:%u on device %s.\n"),
1006 dev->file, dev->block_num, dev->print_name());
1007 if (dev->at_eof()) { /* EOF already read? */
1008 dev->set_eot(); /* yes, 2 EOFs => EOT */
1012 return false; /* return eof */
1014 /* Continue here for successful read */
1015 block->read_len = stat; /* save length read */
1016 if (block->read_len < BLKHDR2_LENGTH) {
1017 dev->dev_errno = EIO;
1018 Mmsg4(dev->errmsg, _("Volume data error at %u:%u! Very short block of %d bytes on device %s discarded.\n"),
1019 dev->file, dev->block_num, block->read_len, dev->print_name());
1020 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
1021 dev->set_short_block();
1022 block->read_len = block->binbuf = 0;
1023 return false; /* return error */
1026 BlockNumber = block->BlockNumber + 1;
1027 if (!unser_block_header(jcr, dev, block)) {
1029 dev->file_addr += block->read_len;
1030 dev->file_size += block->read_len;
1037 * If the block is bigger than the buffer, we reposition for
1038 * re-reading the block, allocate a buffer of the correct size,
1041 if (block->block_len > block->buf_len) {
1042 dev->dev_errno = EIO;
1043 Mmsg2(dev->errmsg, _("Block length %u is greater than buffer %u. Attempting recovery.\n"),
1044 block->block_len, block->buf_len);
1045 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
1046 Pmsg1(000, "%s", dev->errmsg);
1047 /* Attempt to reposition to re-read the block */
1048 if (dev->is_tape()) {
1049 Dmsg0(200, "BSR for reread; block too big for buffer.\n");
1051 Jmsg(jcr, M_ERROR, 0, "%s", dev->bstrerror());
1052 block->read_len = 0;
1056 Dmsg0(200, "Seek to beginning of block for reread.\n");
1057 boffset_t pos = dev->lseek(dcr, (boffset_t)0, SEEK_CUR); /* get curr pos */
1058 pos -= block->read_len;
1059 dev->lseek(dcr, pos, SEEK_SET);
1060 dev->file_addr = pos;
1062 Mmsg1(dev->errmsg, _("Setting block buffer size to %u bytes.\n"), block->block_len);
1063 Jmsg(jcr, M_INFO, 0, "%s", dev->errmsg);
1064 Pmsg1(000, "%s", dev->errmsg);
1065 /* Set new block length */
1066 dev->max_block_size = block->block_len;
1067 block->buf_len = block->block_len;
1068 free_memory(block->buf);
1069 block->buf = get_memory(block->buf_len);
1072 goto reread; /* re-read block with correct block size */
1075 if (block->block_len > block->read_len) {
1076 dev->dev_errno = EIO;
1077 Mmsg4(dev->errmsg, _("Volume data error at %u:%u! Short block of %d bytes on device %s discarded.\n"),
1078 dev->file, dev->block_num, block->read_len, dev->print_name());
1079 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
1080 dev->set_short_block();
1081 block->read_len = block->binbuf = 0;
1082 return false; /* return error */
1085 dev->clear_short_block();
1087 dev->VolCatInfo.VolCatReads++;
1088 dev->VolCatInfo.VolCatRBytes += block->read_len;
1090 dev->VolCatInfo.VolCatBytes += block->block_len;
1091 dev->VolCatInfo.VolCatBlocks++;
1092 if (dev->VolCatInfo.VolFirstWritten == 0) {
1093 dev->VolCatInfo.VolFirstWritten = (utime_t)time(NULL); /* Set first written time */
1095 dev->EndBlock = dev->block_num;
1096 dev->EndFile = dev->file;
1099 /* Update dcr values */
1100 if (dev->is_tape()) {
1101 dcr->EndBlock = dev->EndBlock;
1102 dcr->EndFile = dev->EndFile;
1104 uint64_t addr = dev->file_addr + block->read_len - 1;
1105 dcr->EndBlock = (uint32_t)addr;
1106 dcr->EndFile = (uint32_t)(addr >> 32);
1107 dev->block_num = dcr->EndBlock;
1108 dev->file = dcr->EndFile;
1110 dev->file_addr += block->read_len;
1111 dev->file_size += block->read_len;
1114 * If we read a short block on disk,
1115 * seek to beginning of next block. This saves us
1116 * from shuffling blocks around in the buffer. Take a
1117 * look at this from an efficiency stand point later, but
1118 * it should only happen once at the end of each job.
1120 * I've been lseek()ing negative relative to SEEK_CUR for 30
1121 * years now. However, it seems that with the new off_t definition,
1122 * it is not possible to seek negative amounts, so we use two
1123 * lseek(). One to get the position, then the second to do an
1124 * absolute positioning -- so much for efficiency. KES Sep 02.
1126 Dmsg0(200, "At end of read block\n");
1127 if (block->read_len > block->block_len && !dev->is_tape()) {
1129 boffset_t pos = dev->lseek(dcr, (boffset_t)0, SEEK_CUR); /* get curr pos */
1130 Dmsg1(200, "Current lseek pos=%s\n", edit_int64(pos, ed1));
1131 pos -= (block->read_len - block->block_len);
1132 dev->lseek(dcr, pos, SEEK_SET);
1133 Dmsg3(200, "Did lseek pos=%s blk_size=%d rdlen=%d\n",
1134 edit_int64(pos, ed1), block->block_len,
1136 dev->file_addr = pos;
1137 dev->file_size = pos;
1139 Dmsg2(200, "Exit read_block read_len=%d block_len=%d\n",
1140 block->read_len, block->block_len);
1141 block->block_read = true;