3 * block.c -- tape block handling functions
5 * Kern Sibbald, March MMI
6 * added BB02 format October MMII
12 Copyright (C) 2000, 2001, 2002 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->failed_write = FALSE;
151 * Create block header just before write. The space
152 * in the buffer should have already been reserved by
155 static void ser_block_header(DEV_BLOCK *block)
158 uint32_t CheckSum = 0;
159 uint32_t block_len = block->binbuf;
161 Dmsg1(190, "ser_block_header: block_len=%d\n", block_len);
162 ser_begin(block->buf, BLKHDR2_LENGTH);
163 ser_uint32(CheckSum);
164 ser_uint32(block_len);
165 ser_uint32(block->BlockNumber);
166 ser_bytes(WRITE_BLKHDR_ID, BLKHDR_ID_LENGTH);
167 if (BLOCK_VER >= 2) {
168 ser_uint32(block->VolSessionId);
169 ser_uint32(block->VolSessionTime);
172 /* Checksum whole block except for the checksum */
173 CheckSum = bcrc32((uint8_t *)block->buf+BLKHDR_CS_LENGTH,
174 block_len-BLKHDR_CS_LENGTH);
175 Dmsg1(190, "ser_bloc_header: checksum=%x\n", CheckSum);
176 ser_begin(block->buf, BLKHDR2_LENGTH);
177 ser_uint32(CheckSum); /* now add checksum to block header */
181 * Unserialized the block header for reading block.
182 * This includes setting all the buffer pointers correctly.
184 * Returns: 0 on failure (not a block)
187 static int unser_block_header(DEVICE *dev, DEV_BLOCK *block)
190 char Id[BLKHDR_ID_LENGTH+1];
191 uint32_t CheckSum, BlockCheckSum;
194 uint32_t BlockNumber;
197 unser_begin(block->buf, BLKHDR_LENGTH);
198 unser_uint32(CheckSum);
199 unser_uint32(block_len);
200 unser_uint32(BlockNumber);
201 unser_bytes(Id, BLKHDR_ID_LENGTH);
202 ASSERT(unser_length(block->buf) == BLKHDR1_LENGTH);
204 Id[BLKHDR_ID_LENGTH] = 0;
206 bhl = BLKHDR1_LENGTH;
208 block->bufp = block->buf + bhl;
209 if (strncmp(Id, BLKHDR1_ID, BLKHDR_ID_LENGTH) != 0) {
210 Mmsg2(&dev->errmsg, _("Buffer ID error. Wanted: %s, got %s. Buffer discarded.\n"),
212 Emsg0(M_ERROR, 0, dev->errmsg);
215 } else if (Id[3] == '2') {
216 unser_uint32(block->VolSessionId);
217 unser_uint32(block->VolSessionTime);
218 bhl = BLKHDR2_LENGTH;
220 block->bufp = block->buf + bhl;
221 if (strncmp(Id, BLKHDR2_ID, BLKHDR_ID_LENGTH) != 0) {
222 Mmsg2(&dev->errmsg, _("Buffer ID error. Wanted: %s, got %s. Buffer discarded.\n"),
224 Emsg0(M_ERROR, 0, dev->errmsg);
228 Mmsg1(&dev->errmsg, _("Expected block-id BB01 or BB02, got %s. Buffer discarded.\n"), Id);
229 Emsg0(M_ERROR, 0, dev->errmsg);
234 if (block_len > MAX_BLOCK_LENGTH) {
235 Mmsg1(&dev->errmsg, _("Block length %u is insane (too large), probably due to a bad archive.\n"),
237 Emsg0(M_ERROR, 0, dev->errmsg);
241 Dmsg1(190, "unser_block_header block_len=%d\n", block_len);
242 /* Find end of block or end of buffer whichever is smaller */
243 if (block_len > block->read_len) {
244 block_end = block->read_len;
246 block_end = block_len;
248 block->binbuf = block_end - bhl;
249 block->block_len = block_len;
250 block->BlockNumber = BlockNumber;
251 Dmsg3(190, "Read binbuf = %d %d block_len=%d\n", block->binbuf,
253 if (block_len <= block->read_len) {
254 BlockCheckSum = bcrc32((uint8_t *)block->buf+BLKHDR_CS_LENGTH,
255 block_len-BLKHDR_CS_LENGTH);
256 if (BlockCheckSum != CheckSum) {
257 Dmsg2(00, "Block checksum mismatch: calc=%x blk=%x\n", BlockCheckSum,
259 Mmsg2(&dev->errmsg, _("Block checksum mismatch: calc=%x blk=%x\n"), BlockCheckSum,
268 * Write a block to the device, with locking and unlocking
270 * Returns: 1 on success
274 int write_block_to_device(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
278 if (!write_block_to_dev(jcr, dev, block)) {
279 stat = fixup_device_block_write_error(jcr, dev, block);
286 * Write a block to the device
288 * Returns: 1 on success or EOT
291 int write_block_to_dev(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
294 uint32_t wlen; /* length to write */
295 int hit_max1, hit_max2;
298 #ifdef NO_TAPE_WRITE_TEST
302 ASSERT(block->binbuf == ((uint32_t) (block->bufp - block->buf)));
304 /* dump_block(block, "before write"); */
305 if (dev->state & ST_WEOT) {
306 Dmsg0(100, "return write_block_to_dev with ST_WEOT\n");
309 wlen = block->binbuf;
310 if (wlen <= WRITE_BLKHDR_LENGTH) { /* Does block have data in it? */
311 Dmsg0(100, "return write_block_to_dev no data to write\n");
315 * Clear to the end of the buffer if it is not full,
316 * and on tape devices, apply min and fixed blocking.
318 if (wlen != block->buf_len) {
319 uint32_t blen; /* current buffer length */
321 Dmsg2(200, "binbuf=%d buf_len=%d\n", block->binbuf, block->buf_len);
324 /* Adjust write size to min/max for tapes only */
325 if (dev->state & ST_TAPE) {
326 if (wlen < dev->min_block_size) {
327 wlen = ((dev->min_block_size + TAPE_BSIZE - 1) / TAPE_BSIZE) * TAPE_BSIZE;
329 /* check for fixed block size */
330 if (dev->min_block_size == dev->max_block_size) {
331 wlen = block->buf_len; /* fixed block size already rounded */
335 memset(block->bufp, 0, wlen-blen); /* clear garbage */
339 ser_block_header(block);
341 /* Limit maximum Volume size to value specified by user */
342 hit_max1 = (dev->max_volume_size > 0) &&
343 ((dev->VolCatInfo.VolCatBytes + block->binbuf)) >= dev->max_volume_size;
344 hit_max2 = (dev->VolCatInfo.VolCatMaxBytes > 0) &&
345 ((dev->VolCatInfo.VolCatBytes + block->binbuf)) >= dev->VolCatInfo.VolCatMaxBytes;
346 if (hit_max1 || hit_max2) {
348 dev->state |= ST_WEOT;
349 Dmsg0(10, "==== Output bytes Triggered medium max capacity.\n");
351 Mmsg2(&dev->errmsg, _("Max. Volume capacity %s exceeded on device %s.\n"),
352 edit_uint64(dev->max_volume_size, ed1), dev->dev_name);
354 Mmsg2(&dev->errmsg, _("Max. Volume capacity %s exceeded on device %s.\n"),
355 edit_uint64(dev->VolCatInfo.VolCatMaxBytes, ed1), dev->dev_name);
357 block->failed_write = TRUE;
358 dev->EndBlock = dev->block_num;
359 dev->EndFile = dev->file;
360 weof_dev(dev, 1); /* end the tape */
361 weof_dev(dev, 1); /* write second eof */
365 dev->VolCatInfo.VolCatWrites++;
366 Dmsg1(500, "Write block of %u bytes\n", wlen);
367 if ((uint32_t) (stat=write(dev->fd, block->buf, (size_t)wlen)) != wlen) {
368 /* We should check for errno == ENOSPC, BUT many
369 * devices simply report EIO when it is full.
370 * with a little more thought we may be able to check
371 * capacity and distinguish real errors and EOT
372 * conditions. In any case, we probably want to
373 * simulate an End of Medium.
375 dev->state |= ST_EOF | ST_EOT | ST_WEOT;
376 clrerror_dev(dev, -1);
378 if (dev->dev_errno == 0) {
379 dev->dev_errno = ENOSPC; /* out of space */
382 Dmsg4(10, "=== Write error. size=%u rtn=%d errno=%d: ERR=%s\n",
383 wlen, stat, dev->dev_errno, strerror(dev->dev_errno));
385 Mmsg4(&dev->errmsg, _("Write error on device %s. Write of %u bytes got %d. ERR=%s.\n"),
386 dev->dev_name, wlen, stat, strerror(dev->dev_errno));
387 block->failed_write = TRUE;
388 dev->EndBlock = dev->block_num;
389 dev->EndFile = dev->file;
390 weof_dev(dev, 1); /* end the tape */
391 weof_dev(dev, 1); /* write second eof */
394 #define CHECK_LAST_BLOCK
395 #ifdef CHECK_LAST_BLOCK
397 * If the device is a tape and it supports backspace record,
398 * we backspace over two eof marks and over the last record,
399 * then re-read it and verify that the block number is
402 if (dev->state & ST_TAPE && dev->capabilities & CAP_BSR) {
404 /* Now back up over what we wrote and read the last block */
405 if (bsf_dev(dev, 1) != 0 || bsf_dev(dev, 1) != 0) {
407 Jmsg(jcr, M_ERROR, 0, _("Back space file at EOT failed. ERR=%s\n"), strerror(dev->dev_errno));
409 /* Backspace over record */
410 if (ok && bsr_dev(dev, 1) != 0) {
412 Jmsg(jcr, M_ERROR, 0, _("Back space record at EOT failed. ERR=%s\n"), strerror(dev->dev_errno));
415 DEV_BLOCK *lblock = new_block(dev);
416 /* Note, this can destroy dev->errmsg */
417 if (!read_block_from_dev(dev, lblock)) {
418 Jmsg(jcr, M_ERROR, 0, _("Re-read last block at EOT failed. ERR=%s"), dev->errmsg);
420 if (lblock->BlockNumber+1 == block->BlockNumber) {
421 Jmsg(jcr, M_INFO, 0, _("Re-read of last block succeeded.\n"));
423 Jmsg(jcr, M_ERROR, 0, _(
424 "Re-read of last block failed. Last block=%u Current block=%u.\n"),
425 lblock->BlockNumber, block->BlockNumber);
434 dev->VolCatInfo.VolCatBytes += block->binbuf;
435 dev->VolCatInfo.VolCatBlocks++;
436 dev->file_addr += wlen;
437 dev->EndBlock = dev->block_num;
438 dev->EndFile = dev->file;
440 /* Limit maximum File size on volume to user specified value */
441 if (dev->state & ST_TAPE) {
442 if ((dev->max_file_size > 0) && dev->file_addr >= dev->max_file_size) {
443 weof_dev(dev, 1); /* write eof */
448 block->BlockNumber++;
449 Dmsg2(190, "write_block: wrote block %d bytes=%d\n", dev->block_num,
456 * Read block with locking
459 int read_block_from_device(DEVICE *dev, DEV_BLOCK *block)
462 Dmsg0(90, "Enter read_block_from_device\n");
464 stat = read_block_from_dev(dev, block);
466 Dmsg0(90, "Leave read_block_from_device\n");
471 * Read the next block into the block structure and unserialize
472 * the block header. For a file, the block may be partially
473 * or completely in the current buffer.
475 int read_block_from_dev(DEVICE *dev, DEV_BLOCK *block)
481 Dmsg1(100, "Full read() in read_block_from_device() len=%d\n",
485 Mmsg1(&dev->errmsg, _("Block buffer size looping problem on device %s\n"),
490 if ((stat=read(dev->fd, block->buf, (size_t)block->buf_len)) < 0) {
491 Dmsg1(90, "Read device got: ERR=%s\n", strerror(errno));
492 clrerror_dev(dev, -1);
494 Mmsg2(&dev->errmsg, _("Read error on device %s. ERR=%s.\n"),
495 dev->dev_name, strerror(dev->dev_errno));
498 Dmsg1(90, "Read device got %d bytes\n", stat);
499 if (stat == 0) { /* Got EOF ! */
500 dev->block_num = block->read_len = 0;
501 Mmsg1(&dev->errmsg, _("Read zero bytes on device %s.\n"), dev->dev_name);
502 if (dev->state & ST_EOF) { /* EOF alread read? */
503 dev->state |= ST_EOT; /* yes, 2 EOFs => EOT */
506 dev->file++; /* increment file */
507 dev->state |= ST_EOF; /* set EOF read */
508 return 0; /* return eof */
510 /* Continue here for successful read */
511 block->read_len = stat; /* save length read */
512 if (block->read_len < BLKHDR2_LENGTH) {
513 Mmsg2(&dev->errmsg, _("Very short block of %d bytes on device %s discarded.\n"),
514 block->read_len, dev->dev_name);
515 dev->state |= ST_SHORT; /* set short block */
516 block->read_len = block->binbuf = 0;
517 return 0; /* return error */
520 if (!unser_block_header(dev, block)) {
525 * If the block is bigger than the buffer, we reposition for
526 * re-reading the block, allocate a buffer of the correct size,
529 if (block->block_len > block->buf_len) {
530 Mmsg2(&dev->errmsg, _("Block length %u is greater than buffer %u. Attempting recovery.\n"),
531 block->block_len, block->buf_len);
532 Emsg0(M_WARNING, 0, dev->errmsg);
533 Dmsg1(000, "%s", dev->errmsg);
534 /* Attempt to reposition to re-read the block */
535 if (dev->state & ST_TAPE) {
536 Dmsg0(100, "Backspace record for reread.\n");
537 if (bsf_dev(dev, 1) != 0) {
538 Emsg0(M_ERROR, 0, dev->errmsg);
542 Dmsg0(100, "Seek to beginning of block for reread.\n");
543 off_t pos = lseek(dev->fd, (off_t)0, SEEK_CUR); /* get curr pos */
544 pos -= block->read_len;
545 lseek(dev->fd, pos, SEEK_SET);
547 Mmsg1(&dev->errmsg, _("Resetting buffer size to %u bytes.\n"), block->block_len);
548 Emsg0(M_WARNING, 0, dev->errmsg);
549 Dmsg1(000, "%s", dev->errmsg);
550 /* Set new block length */
551 dev->max_block_size = block->block_len;
552 block->buf_len = block->block_len;
553 free_memory(block->buf);
554 block->buf = get_memory(block->buf_len);
557 goto reread; /* re-read block with correct block size */
560 if (block->block_len > block->read_len) {
561 Mmsg2(&dev->errmsg, _("Short block of %d bytes on device %s discarded.\n"),
562 block->read_len, dev->dev_name);
563 dev->state |= ST_SHORT; /* set short block */
564 block->read_len = block->binbuf = 0;
565 return 0; /* return error */
568 dev->state &= ~(ST_EOF|ST_SHORT); /* clear EOF and short block */
572 * If we read a short block on disk,
573 * seek to beginning of next block. This saves us
574 * from shuffling blocks around in the buffer. Take a
575 * look at this from an efficiency stand point later, but
576 * it should only happen once at the end of each job.
578 * I've been lseek()ing negative relative to SEEK_CUR for 30
579 * years now. However, it seems that with the new off_t definition,
580 * it is not possible to seek negative amounts, so we use two
581 * lseek(). One to get the position, then the second to do an
582 * absolute positioning -- so much for efficiency. KES Sep 02.
584 Dmsg0(200, "At end of read block\n");
585 if (block->read_len > block->block_len && !(dev->state & ST_TAPE)) {
586 off_t pos = lseek(dev->fd, (off_t)0, SEEK_CUR); /* get curr pos */
587 pos -= (block->read_len - block->block_len);
588 lseek(dev->fd, pos, SEEK_SET);
589 Dmsg2(100, "Did lseek blk_size=%d rdlen=%d\n", block->block_len,
592 Dmsg2(200, "Exit read_block read_len=%d block_len=%d\n",
593 block->read_len, block->block_len);