3 * block.c -- tape block handling functions
5 * Kern Sibbald, March MMI
6 * added BB02 format October MMII
12 Copyright (C) 2001-2006 Kern Sibbald
14 This program is free software; you can redistribute it and/or
15 modify it under the terms of the GNU General Public License
16 version 2 as amended with additional clauses defined in the
17 file LICENSE in the main source directory.
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
22 the file LICENSE for additional details.
30 static bool terminate_writing_volume(DCR *dcr);
31 static bool do_new_file_bookkeeping(DCR *dcr);
32 static bool do_dvd_size_checks(DCR *dcr);
33 static void reread_last_block(DCR *dcr);
36 * Dump the block header, then walk through
37 * the block printing out the record headers.
39 void dump_block(DEV_BLOCK *b, const char *msg)
43 char Id[BLKHDR_ID_LENGTH+1];
44 uint32_t CheckSum, BlockCheckSum;
47 uint32_t VolSessionId, VolSessionTime, data_len;
51 char buf1[100], buf2[100];
53 unser_begin(b->buf, BLKHDR1_LENGTH);
54 unser_uint32(CheckSum);
55 unser_uint32(block_len);
56 unser_uint32(BlockNumber);
57 unser_bytes(Id, BLKHDR_ID_LENGTH);
58 ASSERT(unser_length(b->buf) == BLKHDR1_LENGTH);
59 Id[BLKHDR_ID_LENGTH] = 0;
61 unser_uint32(VolSessionId);
62 unser_uint32(VolSessionTime);
66 VolSessionId = VolSessionTime = 0;
71 if (block_len > 100000) {
72 Dmsg3(20, "Dump block %s 0x%x blocksize too big %u\n", msg, b, block_len);
76 BlockCheckSum = bcrc32((uint8_t *)b->buf+BLKHDR_CS_LENGTH,
77 block_len-BLKHDR_CS_LENGTH);
78 Pmsg6(000, _("Dump block %s %x: size=%d BlkNum=%d\n"
79 " Hdrcksum=%x cksum=%x\n"),
80 msg, b, block_len, BlockNumber, CheckSum, BlockCheckSum);
82 while (p < (b->buf + block_len+WRITE_RECHDR_LENGTH)) {
83 unser_begin(p, WRITE_RECHDR_LENGTH);
84 if (rhl == RECHDR1_LENGTH) {
85 unser_uint32(VolSessionId);
86 unser_uint32(VolSessionTime);
88 unser_int32(FileIndex);
90 unser_uint32(data_len);
91 Pmsg6(000, _(" Rec: VId=%u VT=%u FI=%s Strm=%s len=%d p=%x\n"),
92 VolSessionId, VolSessionTime, FI_to_ascii(buf1, FileIndex),
93 stream_to_ascii(buf2, Stream, FileIndex), data_len, p);
99 * Create a new block structure.
100 * We pass device so that the block can inherit the
101 * min and max block sizes.
103 DEV_BLOCK *new_block(DEVICE *dev)
105 DEV_BLOCK *block = (DEV_BLOCK *)get_memory(sizeof(DEV_BLOCK));
107 memset(block, 0, sizeof(DEV_BLOCK));
109 /* If the user has specified a max_block_size, use it as the default */
110 if (dev->max_block_size == 0) {
111 block->buf_len = DEFAULT_BLOCK_SIZE;
113 block->buf_len = dev->max_block_size;
116 block->block_len = block->buf_len; /* default block size */
117 block->buf = get_memory(block->buf_len);
119 block->BlockVer = BLOCK_VER; /* default write version */
120 Dmsg1(650, "Returning new block=%x\n", block);
126 * Duplicate an existing block (eblock)
128 DEV_BLOCK *dup_block(DEV_BLOCK *eblock)
130 DEV_BLOCK *block = (DEV_BLOCK *)get_memory(sizeof(DEV_BLOCK));
131 int buf_len = sizeof_pool_memory(eblock->buf);
133 memcpy(block, eblock, sizeof(DEV_BLOCK));
134 block->buf = get_memory(buf_len);
135 memcpy(block->buf, eblock->buf, buf_len);
141 * Only the first block checksum error was reported.
142 * If there are more, report it now.
144 void print_block_read_errors(JCR *jcr, DEV_BLOCK *block)
146 if (block->read_errors > 1) {
147 Jmsg(jcr, M_ERROR, 0, _("%d block read errors not printed.\n"),
155 void free_block(DEV_BLOCK *block)
157 Dmsg1(999, "free_block buffer %x\n", block->buf);
158 free_memory(block->buf);
159 Dmsg1(999, "free_block block %x\n", block);
160 free_memory((POOLMEM *)block);
163 /* Empty the block -- for writing */
164 void empty_block(DEV_BLOCK *block)
166 block->binbuf = WRITE_BLKHDR_LENGTH;
167 block->bufp = block->buf + block->binbuf;
169 block->write_failed = false;
170 block->block_read = false;
171 block->FirstIndex = block->LastIndex = 0;
175 * Create block header just before write. The space
176 * in the buffer should have already been reserved by
179 void ser_block_header(DEV_BLOCK *block)
182 uint32_t CheckSum = 0;
183 uint32_t block_len = block->binbuf;
185 Dmsg1(1390, "ser_block_header: block_len=%d\n", block_len);
186 ser_begin(block->buf, BLKHDR2_LENGTH);
187 ser_uint32(CheckSum);
188 ser_uint32(block_len);
189 ser_uint32(block->BlockNumber);
190 ser_bytes(WRITE_BLKHDR_ID, BLKHDR_ID_LENGTH);
191 if (BLOCK_VER >= 2) {
192 ser_uint32(block->VolSessionId);
193 ser_uint32(block->VolSessionTime);
196 /* Checksum whole block except for the checksum */
197 CheckSum = bcrc32((uint8_t *)block->buf+BLKHDR_CS_LENGTH,
198 block_len-BLKHDR_CS_LENGTH);
199 Dmsg1(1390, "ser_bloc_header: checksum=%x\n", CheckSum);
200 ser_begin(block->buf, BLKHDR2_LENGTH);
201 ser_uint32(CheckSum); /* now add checksum to block header */
205 * Unserialize the block header for reading block.
206 * This includes setting all the buffer pointers correctly.
208 * Returns: false on failure (not a block)
211 static bool unser_block_header(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
214 char Id[BLKHDR_ID_LENGTH+1];
215 uint32_t CheckSum, BlockCheckSum;
218 uint32_t BlockNumber;
221 unser_begin(block->buf, BLKHDR_LENGTH);
222 unser_uint32(CheckSum);
223 unser_uint32(block_len);
224 unser_uint32(BlockNumber);
225 unser_bytes(Id, BLKHDR_ID_LENGTH);
226 ASSERT(unser_length(block->buf) == BLKHDR1_LENGTH);
228 Id[BLKHDR_ID_LENGTH] = 0;
230 bhl = BLKHDR1_LENGTH;
232 block->bufp = block->buf + bhl;
233 if (strncmp(Id, BLKHDR1_ID, BLKHDR_ID_LENGTH) != 0) {
234 dev->dev_errno = EIO;
235 Mmsg4(dev->errmsg, _("Volume data error at %u:%u! Wanted ID: \"%s\", got \"%s\". Buffer discarded.\n"),
236 dev->file, dev->block_num, BLKHDR1_ID, Id);
237 if (block->read_errors == 0 || verbose >= 2) {
238 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
240 block->read_errors++;
243 } else if (Id[3] == '2') {
244 unser_uint32(block->VolSessionId);
245 unser_uint32(block->VolSessionTime);
246 bhl = BLKHDR2_LENGTH;
248 block->bufp = block->buf + bhl;
249 if (strncmp(Id, BLKHDR2_ID, BLKHDR_ID_LENGTH) != 0) {
250 dev->dev_errno = EIO;
251 Mmsg4(dev->errmsg, _("Volume data error at %u:%u! Wanted ID: \"%s\", got \"%s\". Buffer discarded.\n"),
252 dev->file, dev->block_num, BLKHDR2_ID, Id);
253 if (block->read_errors == 0 || verbose >= 2) {
254 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
256 block->read_errors++;
260 dev->dev_errno = EIO;
261 Mmsg4(dev->errmsg, _("Volume data error at %u:%u! Wanted ID: \"%s\", got \"%s\". Buffer discarded.\n"),
262 dev->file, dev->block_num, BLKHDR2_ID, Id);
263 if (block->read_errors == 0 || verbose >= 2) {
264 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
266 block->read_errors++;
267 unser_uint32(block->VolSessionId);
268 unser_uint32(block->VolSessionTime);
273 if (block_len > MAX_BLOCK_LENGTH) {
274 dev->dev_errno = EIO;
275 Mmsg3(dev->errmsg, _("Volume data error at %u:%u! Block length %u is insane (too large), probably due to a bad archive.\n"),
276 dev->file, dev->block_num, block_len);
277 if (block->read_errors == 0 || verbose >= 2) {
278 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
280 block->read_errors++;
284 Dmsg1(390, "unser_block_header block_len=%d\n", block_len);
285 /* Find end of block or end of buffer whichever is smaller */
286 if (block_len > block->read_len) {
287 block_end = block->read_len;
289 block_end = block_len;
291 block->binbuf = block_end - bhl;
292 block->block_len = block_len;
293 block->BlockNumber = BlockNumber;
294 Dmsg3(390, "Read binbuf = %d %d block_len=%d\n", block->binbuf,
296 if (block_len <= block->read_len) {
297 BlockCheckSum = bcrc32((uint8_t *)block->buf+BLKHDR_CS_LENGTH,
298 block_len-BLKHDR_CS_LENGTH);
299 if (BlockCheckSum != CheckSum) {
300 dev->dev_errno = EIO;
301 Mmsg6(dev->errmsg, _("Volume data error at %u:%u!\n"
302 "Block checksum mismatch in block=%u len=%d: calc=%x blk=%x\n"),
303 dev->file, dev->block_num, (unsigned)BlockNumber,
304 block_len, BlockCheckSum, CheckSum);
305 if (block->read_errors == 0 || verbose >= 2) {
306 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
308 block->read_errors++;
318 * Write a block to the device, with locking and unlocking
320 * Returns: true on success
324 bool write_block_to_device(DCR *dcr)
327 DEVICE *dev = dcr->dev;
331 stat = write_block_to_spool_file(dcr);
335 if (!dcr->dev_locked) {
340 * If a new volume has been mounted since our last write
341 * Create a JobMedia record for the previous volume written,
342 * and set new parameters to write this volume
343 * The same applies for if we are in a new file.
345 if (dcr->NewVol || dcr->NewFile) {
346 if (job_canceled(jcr)) {
350 /* Create a jobmedia record for this job */
351 if (!dir_create_jobmedia_record(dcr)) {
352 dev->dev_errno = EIO;
353 Jmsg(jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
354 dcr->VolCatInfo.VolCatName, jcr->Job);
355 set_new_volume_parameters(dcr);
360 /* Note, setting a new volume also handles any pending new file */
361 set_new_volume_parameters(dcr);
362 dcr->NewFile = false; /* this handled for new file too */
364 set_new_file_parameters(dcr);
368 if (!write_block_to_dev(dcr)) {
369 if (job_canceled(jcr) || jcr->JobType == JT_SYSTEM) {
372 stat = fixup_device_block_write_error(dcr);
377 if (!dcr->dev_locked) {
384 * Write a block to the device
386 * Returns: true on success or EOT
387 * false on hard error
389 bool write_block_to_dev(DCR *dcr)
392 uint32_t wlen; /* length to write */
393 int hit_max1, hit_max2;
395 DEVICE *dev = dcr->dev;
397 DEV_BLOCK *block = dcr->block;
399 #ifdef NO_TAPE_WRITE_TEST
403 ASSERT(block->binbuf == ((uint32_t) (block->bufp - block->buf)));
405 /* dump_block(block, "before write"); */
406 if (dev->at_weot()) {
407 Dmsg0(100, "return write_block_to_dev with ST_WEOT\n");
408 dev->dev_errno = ENOSPC;
409 Jmsg(jcr, M_FATAL, 0, _("Cannot write block. Device at EOM.\n"));
412 if (!dev->can_append()) {
413 dev->dev_errno = EIO;
414 Jmsg(jcr, M_FATAL, 0, _("Attempt to write on read-only Volume.\n"));
417 wlen = block->binbuf;
418 if (wlen <= WRITE_BLKHDR_LENGTH) { /* Does block have data in it? */
419 Dmsg0(100, "return write_block_to_dev no data to write\n");
423 * Clear to the end of the buffer if it is not full,
424 * and on tape devices, apply min and fixed blocking.
426 if (wlen != block->buf_len) {
427 uint32_t blen; /* current buffer length */
429 Dmsg2(200, "binbuf=%d buf_len=%d\n", block->binbuf, block->buf_len);
432 /* Adjust write size to min/max for tapes only */
433 if (dev->is_tape()) {
434 /* check for fixed block size */
435 if (dev->min_block_size == dev->max_block_size) {
436 wlen = block->buf_len; /* fixed block size already rounded */
437 /* Check for min block size */
438 } else if (wlen < dev->min_block_size) {
439 wlen = ((dev->min_block_size + TAPE_BSIZE - 1) / TAPE_BSIZE) * TAPE_BSIZE;
440 /* Ensure size is rounded */
442 wlen = ((wlen + TAPE_BSIZE - 1) / TAPE_BSIZE) * TAPE_BSIZE;
446 memset(block->bufp, 0, wlen-blen); /* clear garbage */
450 ser_block_header(block);
452 /* Limit maximum Volume size to value specified by user */
453 hit_max1 = (dev->max_volume_size > 0) &&
454 ((dev->VolCatInfo.VolCatBytes + block->binbuf)) >= dev->max_volume_size;
455 hit_max2 = (dev->VolCatInfo.VolCatMaxBytes > 0) &&
456 ((dev->VolCatInfo.VolCatBytes + block->binbuf)) >= dev->VolCatInfo.VolCatMaxBytes;
457 if (hit_max1 || hit_max2) {
460 Dmsg0(10, "==== Output bytes Triggered medium max capacity.\n");
462 max_cap = dev->max_volume_size;
464 max_cap = dev->VolCatInfo.VolCatMaxBytes;
466 Jmsg(jcr, M_INFO, 0, _("User defined maximum volume capacity %s exceeded on device %s.\n"),
467 edit_uint64_with_commas(max_cap, ed1), dev->print_name());
468 terminate_writing_volume(dcr);
469 reread_last_block(dcr); /* DEBUG */
470 dev->dev_errno = ENOSPC;
474 /* Limit maximum File size on volume to user specified value */
475 if ((dev->max_file_size > 0) &&
476 (dev->file_size+block->binbuf) >= dev->max_file_size) {
477 dev->file_size = 0; /* reset file size */
479 if (!dev->weof(1)) { /* write eof */
480 Dmsg0(190, "WEOF error in max file size.\n");
481 Jmsg(jcr, M_FATAL, 0, _("Unable to write EOF. ERR=%s\n"),
483 terminate_writing_volume(dcr);
484 dev->dev_errno = ENOSPC;
487 if (!write_ansi_ibm_labels(dcr, ANSI_EOF_LABEL, dev->VolHdr.VolumeName)) {
491 if (!do_new_file_bookkeeping(dcr)) {
492 /* Error message already sent */
497 if (!do_dvd_size_checks(dcr)) {
498 /* Error message already sent */
502 dev->VolCatInfo.VolCatWrites++;
503 Dmsg1(1300, "Write block of %u bytes\n", wlen);
504 #ifdef DEBUG_BLOCK_ZEROING
505 uint32_t *bp = (uint32_t *)block->buf;
506 if (bp[0] == 0 && bp[1] == 0 && bp[2] == 0 && block->buf[12] == 0) {
507 Jmsg0(jcr, M_ABORT, 0, _("Write block header zeroed.\n"));
512 * Do write here, make a somewhat feeble attempt to recover from
513 * I/O errors, or from the OS telling us it is busy.
517 if (dev->is_tape()) {
518 stat = tape_write(dev->fd, block->buf, (size_t)wlen);
520 stat = write(dev->fd, block->buf, (size_t)wlen);
523 bmicrosleep(0, 100000); /* pause a bit if lots of errors */
525 } while (stat == -1 && (errno == EBUSY || errno == EIO) && retry++ < 30);
527 #ifdef DEBUG_BLOCK_ZEROING
528 if (bp[0] == 0 && bp[1] == 0 && bp[2] == 0 && block->buf[12] == 0) {
529 Jmsg0(jcr, M_ABORT, 0, _("Write block header zeroed.\n"));
533 if (stat != (ssize_t)wlen) {
534 /* Some devices simply report EIO when the volume is full.
535 * With a little more thought we may be able to check
536 * capacity and distinguish real errors and EOT
537 * conditions. In any case, we probably want to
538 * simulate an End of Medium.
543 if (dev->dev_errno == 0) {
544 dev->dev_errno = ENOSPC; /* out of space */
546 if (dev->dev_errno != ENOSPC) {
547 Jmsg4(jcr, M_ERROR, 0, _("Write error at %u:%u on device %s. ERR=%s.\n"),
548 dev->file, dev->block_num, dev->print_name(), be.strerror());
551 dev->dev_errno = ENOSPC; /* out of space */
553 if (dev->dev_errno == ENOSPC) {
554 Jmsg(jcr, M_INFO, 0, _("End of Volume \"%s\" at %u:%u on device %s. Write of %u bytes got %d.\n"),
555 dev->VolCatInfo.VolCatName,
556 dev->file, dev->block_num, dev->print_name(), wlen, stat);
558 Dmsg7(100, "=== Write error. fd=%d size=%u rtn=%d dev_blk=%d blk_blk=%d errno=%d: ERR=%s\n",
559 dev->fd, wlen, stat, dev->block_num, block->BlockNumber,
560 dev->dev_errno, strerror(dev->dev_errno));
562 ok = terminate_writing_volume(dcr);
563 if (!ok && !forge_on) {
567 reread_last_block(dcr);
572 /* We successfully wrote the block, now do housekeeping */
574 dev->VolCatInfo.VolCatBytes += block->binbuf;
575 dev->VolCatInfo.VolCatBlocks++;
576 dev->EndBlock = dev->block_num;
577 dev->EndFile = dev->file;
578 block->BlockNumber++;
580 /* Update dcr values */
581 if (dev->is_tape()) {
582 dcr->EndBlock = dev->EndBlock;
583 dcr->EndFile = dev->EndFile;
586 /* Save address of block just written */
587 uint64_t addr = dev->file_addr + wlen - 1;
588 dcr->EndBlock = (uint32_t)addr;
589 dcr->EndFile = (uint32_t)(addr >> 32);
590 dev->block_num = dcr->EndBlock;
591 dev->file = dcr->EndFile;
593 if (dcr->VolFirstIndex == 0 && block->FirstIndex > 0) {
594 dcr->VolFirstIndex = block->FirstIndex;
596 if (block->LastIndex > 0) {
597 dcr->VolLastIndex = block->LastIndex;
599 dcr->WroteVol = true;
600 dev->file_addr += wlen; /* update file address */
601 dev->file_size += wlen;
602 dev->part_size += wlen;
604 Dmsg2(1300, "write_block: wrote block %d bytes=%d\n", dev->block_num, wlen);
609 static void reread_last_block(DCR *dcr)
611 #define CHECK_LAST_BLOCK
612 #ifdef CHECK_LAST_BLOCK
614 DEVICE *dev = dcr->dev;
616 DEV_BLOCK *block = dcr->block;
618 * If the device is a tape and it supports backspace record,
619 * we backspace over one or two eof marks depending on
620 * how many we just wrote, then over the last record,
621 * then re-read it and verify that the block number is
624 if (dev->is_tape() && dev_cap(dev, CAP_BSR)) {
625 /* Now back up over what we wrote and read the last block */
629 Jmsg(jcr, M_ERROR, 0, _("Backspace file at EOT failed. ERR=%s\n"),
630 be.strerror(dev->dev_errno));
632 if (ok && dev->has_cap(CAP_TWOEOF) && !dev->bsf(1)) {
635 Jmsg(jcr, M_ERROR, 0, _("Backspace file at EOT failed. ERR=%s\n"),
636 be.strerror(dev->dev_errno));
638 /* Backspace over record */
639 if (ok && !dev->bsr(1)) {
642 Jmsg(jcr, M_ERROR, 0, _("Backspace record at EOT failed. ERR=%s\n"),
643 be.strerror(dev->dev_errno));
645 * On FreeBSD systems, if the user got here, it is likely that his/her
646 * tape drive is "frozen". The correct thing to do is a
647 * rewind(), but if we do that, higher levels in cleaning up, will
648 * most likely write the EOS record over the beginning of the
649 * tape. The rewind *is* done later in mount.c when another
650 * tape is requested. Note, the clrerror_dev() call in bsr()
651 * calls ioctl(MTCERRSTAT), which *should* fix the problem.
655 DEV_BLOCK *lblock = new_block(dev);
656 /* Note, this can destroy dev->errmsg */
658 if (!read_block_from_dev(dcr, NO_BLOCK_NUMBER_CHECK)) {
659 Jmsg(jcr, M_ERROR, 0, _("Re-read last block at EOT failed. ERR=%s"),
663 * If we wrote block and the block numbers don't agree
664 * we have a possible problem.
666 if (lblock->VolSessionId == block->VolSessionId &&
667 lblock->BlockNumber+1 != block->BlockNumber) {
668 Jmsg(jcr, M_ERROR, 0, _(
669 "Re-read of last block OK, but block numbers differ. Last block=%u Current block=%u.\n"),
670 lblock->BlockNumber, block->BlockNumber);
672 Jmsg(jcr, M_INFO, 0, _("Re-read of last block succeeded.\n"));
682 static bool terminate_writing_volume(DCR *dcr)
684 DEVICE *dev = dcr->dev;
687 /* Create a JobMedia record to indicated end of tape */
688 dev->VolCatInfo.VolCatFiles = dev->file;
689 if (!dir_create_jobmedia_record(dcr)) {
690 Dmsg0(190, "Error from create JobMedia\n");
691 dev->dev_errno = EIO;
692 Jmsg(dcr->jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
693 dcr->VolCatInfo.VolCatName, dcr->jcr->Job);
697 dcr->block->write_failed = true;
698 if (!dev->weof(1)) { /* end the tape */
699 dev->VolCatInfo.VolCatErrors++;
700 Jmsg(dcr->jcr, M_ERROR, 0, _("Error writing final EOF to tape. This Volume may not be readable.\n"
703 Dmsg0(100, "WEOF error.\n");
706 ok = write_ansi_ibm_labels(dcr, ANSI_EOV_LABEL, dev->VolHdr.VolumeName);
708 bstrncpy(dev->VolCatInfo.VolCatStatus, "Full", sizeof(dev->VolCatInfo.VolCatStatus));
709 dev->VolCatInfo.VolCatFiles = dev->file; /* set number of files */
710 dev->VolCatInfo.VolCatJobs++; /* increment number of jobs */
713 if (!dvd_write_part(dcr)) { /* write last part */
716 dev->VolCatInfo.VolCatParts = dev->num_dvd_parts;
719 if (!dir_update_volume_info(dcr, false)) {
722 Dmsg1(100, "dir_update_volume_info terminate writing -- %s\n", ok?"OK":"ERROR");
725 * Walk through all attached dcrs setting flag to call
726 * set_new_file_parameters() when that dcr is next used.
729 foreach_dlist(mdcr, dev->attached_dcrs) {
730 if (mdcr->jcr->JobId == 0) {
733 mdcr->NewFile = true; /* set reminder to do set_new_file_params */
735 /* Set new file/block parameters for current dcr */
736 set_new_file_parameters(dcr);
738 if (ok && dev_cap(dev, CAP_TWOEOF) && !dev->weof(1)) { /* end the tape */
739 dev->VolCatInfo.VolCatErrors++;
740 /* This may not be fatal since we already wrote an EOF */
741 Jmsg(dcr->jcr, M_ERROR, 0, "%s", dev->errmsg);
744 dev->set_ateot(); /* no more writing this tape */
745 Dmsg1(100, "Leave terminate_writing_volume -- %s\n", ok?"OK":"ERROR");
750 * Do bookkeeping when a new file is created on a Volume. This is
751 * also done for disk files to generate the jobmedia records for
754 static bool do_new_file_bookkeeping(DCR *dcr)
756 DEVICE *dev = dcr->dev;
759 /* Create a JobMedia record so restore can seek */
760 if (!dir_create_jobmedia_record(dcr)) {
761 Dmsg0(190, "Error from create_job_media.\n");
762 dev->dev_errno = EIO;
763 Jmsg(jcr, M_FATAL, 0, _("Could not create JobMedia record for Volume=\"%s\" Job=%s\n"),
764 dcr->VolCatInfo.VolCatName, jcr->Job);
765 terminate_writing_volume(dcr);
766 dev->dev_errno = EIO;
769 dev->VolCatInfo.VolCatFiles = dev->file;
770 if (!dir_update_volume_info(dcr, false)) {
771 Dmsg0(190, "Error from update_vol_info.\n");
772 terminate_writing_volume(dcr);
773 dev->dev_errno = EIO;
776 Dmsg0(100, "dir_update_volume_info max file size -- OK\n");
779 * Walk through all attached dcrs setting flag to call
780 * set_new_file_parameters() when that dcr is next used.
783 foreach_dlist(mdcr, dev->attached_dcrs) {
784 if (mdcr->jcr->JobId == 0) {
787 mdcr->NewFile = true; /* set reminder to do set_new_file_params */
789 /* Set new file/block parameters for current dcr */
790 set_new_file_parameters(dcr);
795 * Do all checks for DVD sizes during writing.
797 static bool do_dvd_size_checks(DCR *dcr)
799 DEVICE *dev = dcr->dev;
801 DEV_BLOCK *block = dcr->block;
803 /* Don't go further if the device is not a dvd */
804 if (!dev->is_dvd()) {
808 /* Limit maximum part size to value specified by user
810 if (dev->max_part_size > 0 && ((dev->part_size + block->binbuf) >= dev->max_part_size)) {
811 if (dev->part < dev->num_dvd_parts) {
812 Jmsg3(dcr->jcr, M_FATAL, 0, _("Error while writing, current part number"
813 " is less than the total number of parts (%d/%d, device=%s)\n"),
814 dev->part, dev->num_dvd_parts, dev->print_name());
815 dev->dev_errno = EIO;
819 if (dvd_open_next_part(dcr) < 0) {
820 Jmsg2(dcr->jcr, M_FATAL, 0, _("Unable to open device next part %s: ERR=%s\n"),
821 dev->print_name(), dev->bstrerror());
822 dev->dev_errno = EIO;
826 dev->VolCatInfo.VolCatParts = dev->num_dvd_parts;
828 if (!dir_update_volume_info(dcr, false)) {
829 Dmsg0(190, "Error from update_vol_info.\n");
830 dev->dev_errno = EIO;
835 if (!dev->is_freespace_ok()) { /* Error while getting free space */
836 char ed1[50], ed2[50];
837 Dmsg1(10, "Cannot get free space on the device ERR=%s.\n", dev->errmsg);
838 Jmsg(jcr, M_FATAL, 0, _("End of Volume \"%s\" at %u:%u on device %s "
839 "(part_size=%s, free_space=%s, free_space_errno=%d, errmsg=%s).\n"),
840 dev->VolCatInfo.VolCatName,
841 dev->file, dev->block_num, dev->print_name(),
842 edit_uint64_with_commas(dev->part_size, ed1), edit_uint64_with_commas(dev->free_space, ed2),
843 dev->free_space_errno, dev->errmsg);
844 dev->dev_errno = dev->free_space_errno;
848 if ((dev->is_freespace_ok() && (dev->part_size + block->binbuf) >= dev->free_space)) {
849 char ed1[50], ed2[50];
850 Dmsg0(10, "==== Just enough free space on the device to write the current part...\n");
851 Jmsg(jcr, M_INFO, 0, _("End of Volume \"%s\" at %u:%u on device %s "
852 "(part_size=%s, free_space=%s, free_space_errno=%d).\n"),
853 dev->VolCatInfo.VolCatName,
854 dev->file, dev->block_num, dev->print_name(),
855 edit_uint64_with_commas(dev->part_size, ed1), edit_uint64_with_commas(dev->free_space, ed2),
856 dev->free_space_errno);
857 terminate_writing_volume(dcr);
858 dev->dev_errno = ENOSPC;
866 * Read block with locking
869 bool read_block_from_device(DCR *dcr, bool check_block_numbers)
872 DEVICE *dev = dcr->dev;
873 Dmsg0(200, "Enter read_block_from_device\n");
875 ok = read_block_from_dev(dcr, check_block_numbers);
877 Dmsg0(200, "Leave read_block_from_device\n");
882 * Read the next block into the block structure and unserialize
883 * the block header. For a file, the block may be partially
884 * or completely in the current buffer.
886 bool read_block_from_dev(DCR *dcr, bool check_block_numbers)
890 uint32_t BlockNumber;
893 DEVICE *dev = dcr->dev;
894 DEV_BLOCK *block = dcr->block;
900 Dmsg1(200, "Full read() in read_block_from_device() len=%d\n",
904 dev->dev_errno = EIO;
905 Mmsg1(dev->errmsg, _("Block buffer size looping problem on device %s\n"),
907 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
912 /*Dmsg1(100, "dev->file_size=%u\n",(unsigned int)dev->file_size);
913 Dmsg1(100, "dev->file_addr=%u\n",(unsigned int)dev->file_addr);
914 Dmsg1(100, "lseek=%u\n",(unsigned int)lseek(dev->fd, 0, SEEK_CUR));
915 Dmsg1(100, "dev->part_start=%u\n",(unsigned int)dev->part_start);
916 Dmsg1(100, "dev->file_addr-dev->part_start=%u\n",(unsigned int)dev->file_addr-dev->part_start);
917 Dmsg1(100, "dev->file_size-dev->part_start=%u\n",(unsigned int)dev->file_size-dev->part_start);
918 Dmsg1(100, "dev->part_size=%u\n", (unsigned int)dev->part_size);
919 Dmsg1(100, "dev->part=%u\n", (unsigned int)dev->part);
920 Dmsg1(100, "dev->num_dvd_parts=%u\n", (unsigned int)dev->num_dvd_parts);
921 Dmsg1(100, "dev->VolCatInfo.VolCatParts=%u\n", (unsigned int)dev->VolCatInfo.VolCatParts);
922 Dmsg3(100, "Tests : %d %d %d\n", (dev->VolCatInfo.VolCatParts > 0),
923 ((dev->file_addr-dev->part_start) == dev->part_size),
924 (dev->part <= dev->VolCatInfo.VolCatParts));*/
925 /* Check for DVD part file end */
926 if (dev->at_eof() && dev->is_dvd() && dev->num_dvd_parts > 0 &&
927 dev->part < dev->num_dvd_parts) {
928 if (dvd_open_next_part(dcr) < 0) {
929 Jmsg3(dcr->jcr, M_FATAL, 0, _("Unable to open device part=%d %s: ERR=%s\n"),
930 dev->part, dev->print_name(), dev->bstrerror());
931 dev->dev_errno = EIO;
938 // uint32_t *bp = (uint32_t *)block->buf;
939 // Pmsg3(000, "Read %p %u at %llu\n", block->buf, block->buf_len, lseek(dev->fd, 0, SEEK_CUR));
941 if (dev->is_tape()) {
942 stat = tape_read(dev->fd, block->buf, (size_t)block->buf_len);
944 stat = read(dev->fd, block->buf, (size_t)block->buf_len);
947 // Pmsg8(000, "stat=%d Csum=%u blen=%u bnum=%u %c%c%c%c\n",stat, bp[0],bp[1],bp[2],
948 // block->buf[12],block->buf[13],block->buf[14],block->buf[15]);
951 dev->VolCatInfo.VolCatErrors++;
953 } while (stat == -1 && (errno == EINTR || errno == EIO) && retry++ < 11);
957 Dmsg1(200, "Read device got: ERR=%s\n", be.strerror());
959 Mmsg4(dev->errmsg, _("Read error at file:blk %u:%u on device %s. ERR=%s.\n"),
960 dev->file, dev->block_num, dev->print_name(), be.strerror());
961 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
962 if (dev->at_eof()) { /* EOF just seen? */
963 dev->set_eot(); /* yes, error => EOT */
967 Dmsg3(200, "Read device got %d bytes at %u:%u\n", stat,
968 dev->file, dev->block_num);
969 if (stat == 0) { /* Got EOF ! */
972 Mmsg3(dev->errmsg, _("Read zero bytes at %u:%u on device %s.\n"),
973 dev->file, dev->block_num, dev->print_name());
974 if (dev->at_eof()) { /* EOF already read? */
975 dev->set_eot(); /* yes, 2 EOFs => EOT */
979 return false; /* return eof */
981 /* Continue here for successful read */
982 block->read_len = stat; /* save length read */
983 if (block->read_len < BLKHDR2_LENGTH) {
984 dev->dev_errno = EIO;
985 Mmsg4(dev->errmsg, _("Volume data error at %u:%u! Very short block of %d bytes on device %s discarded.\n"),
986 dev->file, dev->block_num, block->read_len, dev->print_name());
987 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
988 dev->set_short_block();
989 block->read_len = block->binbuf = 0;
990 return false; /* return error */
993 BlockNumber = block->BlockNumber + 1;
994 if (!unser_block_header(jcr, dev, block)) {
996 dev->file_addr += block->read_len;
997 dev->file_size += block->read_len;
1004 * If the block is bigger than the buffer, we reposition for
1005 * re-reading the block, allocate a buffer of the correct size,
1008 if (block->block_len > block->buf_len) {
1009 dev->dev_errno = EIO;
1010 Mmsg2(dev->errmsg, _("Block length %u is greater than buffer %u. Attempting recovery.\n"),
1011 block->block_len, block->buf_len);
1012 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
1013 Pmsg1(000, "%s", dev->errmsg);
1014 /* Attempt to reposition to re-read the block */
1015 if (dev->is_tape()) {
1016 Dmsg0(200, "BSR for reread; block too big for buffer.\n");
1018 Jmsg(jcr, M_ERROR, 0, "%s", dev->bstrerror());
1019 block->read_len = 0;
1023 Dmsg0(200, "Seek to beginning of block for reread.\n");
1024 off_t pos = lseek_dev(dev, (off_t)0, SEEK_CUR); /* get curr pos */
1025 pos -= block->read_len;
1026 lseek_dev(dev, pos, SEEK_SET);
1027 dev->file_addr = pos;
1029 Mmsg1(dev->errmsg, _("Setting block buffer size to %u bytes.\n"), block->block_len);
1030 Jmsg(jcr, M_INFO, 0, "%s", dev->errmsg);
1031 Pmsg1(000, "%s", dev->errmsg);
1032 /* Set new block length */
1033 dev->max_block_size = block->block_len;
1034 block->buf_len = block->block_len;
1035 free_memory(block->buf);
1036 block->buf = get_memory(block->buf_len);
1039 goto reread; /* re-read block with correct block size */
1042 if (block->block_len > block->read_len) {
1043 dev->dev_errno = EIO;
1044 Mmsg4(dev->errmsg, _("Volume data error at %u:%u! Short block of %d bytes on device %s discarded.\n"),
1045 dev->file, dev->block_num, block->read_len, dev->print_name());
1046 Jmsg(jcr, M_ERROR, 0, "%s", dev->errmsg);
1047 dev->set_short_block();
1048 block->read_len = block->binbuf = 0;
1049 return false; /* return error */
1052 dev->clear_short_block();
1054 dev->VolCatInfo.VolCatReads++;
1055 dev->VolCatInfo.VolCatRBytes += block->read_len;
1057 dev->VolCatInfo.VolCatBytes += block->block_len;
1058 dev->VolCatInfo.VolCatBlocks++;
1059 dev->EndBlock = dev->block_num;
1060 dev->EndFile = dev->file;
1063 /* Update dcr values */
1064 if (dev->is_tape()) {
1065 dcr->EndBlock = dev->EndBlock;
1066 dcr->EndFile = dev->EndFile;
1068 uint64_t addr = dev->file_addr + block->read_len - 1;
1069 dcr->EndBlock = (uint32_t)addr;
1070 dcr->EndFile = (uint32_t)(addr >> 32);
1071 dev->block_num = dcr->EndBlock;
1072 dev->file = dcr->EndFile;
1074 dev->file_addr += block->read_len;
1075 dev->file_size += block->read_len;
1078 * If we read a short block on disk,
1079 * seek to beginning of next block. This saves us
1080 * from shuffling blocks around in the buffer. Take a
1081 * look at this from an efficiency stand point later, but
1082 * it should only happen once at the end of each job.
1084 * I've been lseek()ing negative relative to SEEK_CUR for 30
1085 * years now. However, it seems that with the new off_t definition,
1086 * it is not possible to seek negative amounts, so we use two
1087 * lseek(). One to get the position, then the second to do an
1088 * absolute positioning -- so much for efficiency. KES Sep 02.
1090 Dmsg0(200, "At end of read block\n");
1091 if (block->read_len > block->block_len && !dev->is_tape()) {
1093 off_t pos = lseek_dev(dev, (off_t)0, SEEK_CUR); /* get curr pos */
1094 pos -= (block->read_len - block->block_len);
1095 lseek_dev(dev, pos, SEEK_SET);
1096 Dmsg3(200, "Did lseek pos=%s blk_size=%d rdlen=%d\n",
1097 edit_uint64(pos, ed1), block->block_len,
1099 dev->file_addr = pos;
1100 dev->file_size = pos;
1102 Dmsg2(200, "Exit read_block read_len=%d block_len=%d\n",
1103 block->read_len, block->block_len);
1104 block->block_read = true;