3 * dev.c -- low level operations on device (storage device)
7 * NOTE!!!! None of these routines are reentrant. You must
8 * use lock_device() and unlock_device() at a higher level,
9 * or use the xxx_device() equivalents. By moving the
10 * thread synchronization to a higher level, we permit
11 * the higher level routines to "seize" the device and
12 * to carry out operations without worrying about who
13 * set what lock (i.e. race conditions).
15 * Note, this is the device dependent code, and my have
16 * to be modified for each system, but is meant to
17 * be as "generic" as possible.
19 * The purpose of this code is to develop a SIMPLE Storage
20 * daemon. More complicated coding (double buffering, writer
21 * thread, ...) is left for a later version.
23 * Unfortunately, I have had to add more and more complication
24 * to this code. This was not foreseen as noted above, and as
25 * a consequence has lead to something more contorted than is
26 * really necessary -- KES. Note, this contortion has been
27 * corrected to a large extent by a rewrite (Apr MMI).
32 Copyright (C) 2000-2004 Kern Sibbald and John Walker
34 This program is free software; you can redistribute it and/or
35 modify it under the terms of the GNU General Public License as
36 published by the Free Software Foundation; either version 2 of
37 the License, or (at your option) any later version.
39 This program is distributed in the hope that it will be useful,
40 but WITHOUT ANY WARRANTY; without even the implied warranty of
41 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
42 General Public License for more details.
44 You should have received a copy of the GNU General Public
45 License along with this program; if not, write to the Free
46 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
52 * Handling I/O errors and end of tape conditions are a bit tricky.
53 * This is how it is currently done when writting.
54 * On either an I/O error or end of tape,
55 * we will stop writing on the physical device (no I/O recovery is
56 * attempted at least in this daemon). The state flag will be sent
57 * to include ST_EOT, which is ephimeral, and ST_WEOT, which is
58 * persistent. Lots of routines clear ST_EOT, but ST_WEOT is
59 * cleared only when the problem goes away. Now when ST_WEOT
60 * is set all calls to write_dev() are handled as usual. However,
61 * in write_block() instead of attempting to write the block to
62 * the physical device, it is chained into a list of blocks written
63 * after the EOT condition. In addition, all threads are blocked
64 * from writing on the tape by calling lock(), and thread other
65 * than the first thread to hit the EOT will block on a condition
66 * variable. The first thread to hit the EOT will continue to
67 * be able to read and write the tape (he sort of tunnels through
68 * the locking mechanism -- see lock() for details).
70 * Now presumably somewhere higher in the chain of command
71 * (device.c), someone will notice the EOT condition and
72 * get a new tape up, get the tape label read, and mark
73 * the label for rewriting. Then this higher level routine
74 * will write the unwritten buffer to the new volume.
75 * Finally, he will release
76 * any blocked threads by doing a broadcast on the condition
77 * variable. At that point, we should be totally back in
78 * business with no lost data.
85 /* Forward referenced functions */
88 * Allocate and initialize the DEVICE structure
89 * Note, if dev is non-NULL, it is already allocated,
90 * thus we neither allocate it nor free it. This allows
91 * the caller to put the packet in shared memory.
93 * Note, for a tape, the device->device_name is the device name
94 * (e.g. /dev/nst0), and for a file, the device name
95 * is the directory in which the file will be placed.
99 init_dev(DEVICE *dev, DEVRES *device)
105 /* Check that device is available */
106 if (stat(device->device_name, &statp) < 0) {
108 dev->dev_errno = errno;
110 Emsg2(M_FATAL, 0, "Unable to stat device %s : %s\n", device->device_name,
116 if (S_ISDIR(statp.st_mode)) {
118 } else if (S_ISCHR(statp.st_mode)) {
120 } else if (S_ISFIFO(statp.st_mode)) {
124 dev->dev_errno = ENODEV;
126 Emsg2(M_FATAL, 0, _("%s is an unknown device type. Must be tape or directory. st_mode=%x\n"),
127 dev_name, statp.st_mode);
131 dev = (DEVICE *)get_memory(sizeof(DEVICE));
132 memset(dev, 0, sizeof(DEVICE));
133 dev->state = ST_MALLOC;
135 memset(dev, 0, sizeof(DEVICE));
138 /* Copy user supplied device parameters from Resource */
139 dev->dev_name = get_memory(strlen(device->device_name)+1);
140 strcpy(dev->dev_name, device->device_name);
141 dev->capabilities = device->cap_bits;
142 dev->min_block_size = device->min_block_size;
143 dev->max_block_size = device->max_block_size;
144 dev->max_volume_size = device->max_volume_size;
145 dev->max_file_size = device->max_file_size;
146 dev->volume_capacity = device->volume_capacity;
147 dev->max_rewind_wait = device->max_rewind_wait;
148 dev->max_open_wait = device->max_open_wait;
149 dev->max_open_vols = device->max_open_vols;
150 dev->vol_poll_interval = device->vol_poll_interval;
152 if (dev->vol_poll_interval && dev->vol_poll_interval < 60) {
153 dev->vol_poll_interval = 60;
155 dev->device = device;
158 dev->state |= ST_TAPE;
160 dev->state |= ST_FIFO;
161 dev->capabilities |= CAP_STREAM; /* set stream device */
163 dev->state |= ST_FILE;
166 if (dev->max_block_size > 1000000) {
167 Emsg3(M_ERROR, 0, _("Block size %u on device %s is too large, using default %u\n"),
168 dev->max_block_size, dev->dev_name, DEFAULT_BLOCK_SIZE);
169 dev->max_block_size = 0;
171 if (dev->max_block_size % TAPE_BSIZE != 0) {
172 Emsg2(M_WARNING, 0, _("Max block size %u not multiple of device %s block size.\n"),
173 dev->max_block_size, dev->dev_name);
176 dev->errmsg = get_pool_memory(PM_EMSG);
179 if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
180 dev->dev_errno = errstat;
181 Mmsg1(&dev->errmsg, _("Unable to init mutex: ERR=%s\n"), strerror(errstat));
182 Emsg0(M_FATAL, 0, dev->errmsg);
184 if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
185 dev->dev_errno = errstat;
186 Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
187 Emsg0(M_FATAL, 0, dev->errmsg);
189 if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
190 dev->dev_errno = errstat;
191 Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
192 Emsg0(M_FATAL, 0, dev->errmsg);
195 Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
199 /* Open the device with the operating system and
200 * initialize buffer pointers.
202 * Note, for a tape, the VolName is the name we give to the
203 * volume (not really used here), but for a file, the
204 * VolName represents the name of the file to be created/opened.
205 * In the case of a file, the full name is the device name
206 * (archive_name) with the VolName concatenated.
209 open_dev(DEVICE *dev, char *VolName, int mode)
211 POOLMEM *archive_name;
213 if (dev->state & ST_OPENED) {
215 * *****FIXME***** how to handle two threads wanting
216 * different volumes mounted???? E.g. one is waiting
217 * for the next volume to be mounted, and a new job
218 * starts and snatches up the device.
220 if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
224 Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
225 dev->dev_name, dev->use_count);
226 Emsg1(M_WARNING, 0, "%s", dev->errmsg);
230 bstrncpy(dev->VolCatInfo.VolCatName, VolName, sizeof(dev->VolCatInfo.VolCatName));
233 Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
234 dev->dev_name, dev->VolCatInfo.VolCatName);
235 dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
236 if (dev->state & (ST_TAPE|ST_FIFO)) {
238 Dmsg0(29, "open_dev: device is tape\n");
239 if (mode == OPEN_READ_WRITE) {
240 dev->mode = O_RDWR | O_BINARY;
241 } else if (mode == OPEN_READ_ONLY) {
242 dev->mode = O_RDONLY | O_BINARY;
243 } else if (mode == OPEN_WRITE_ONLY) {
244 dev->mode = O_WRONLY | O_BINARY;
246 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
248 timeout = dev->max_open_wait;
250 if (dev->state & ST_FIFO && timeout) {
252 dev->tid = start_thread_timer(pthread_self(), timeout);
254 /* If busy retry each second for max_open_wait seconds */
255 while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
256 if (errno == EINTR || errno == EAGAIN) {
259 if (errno == EBUSY && timeout-- > 0) {
260 Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
264 dev->dev_errno = errno;
265 Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
266 dev->dev_name, strerror(dev->dev_errno));
267 /* Stop any open timer we set */
269 stop_thread_timer(dev->tid);
272 Emsg0(M_FATAL, 0, dev->errmsg);
277 dev->state |= ST_OPENED;
279 update_pos_dev(dev); /* update position */
281 /* Stop any open() timer we started */
283 stop_thread_timer(dev->tid);
286 Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
289 * Handle opening of File Archive (not a tape)
291 if (VolName == NULL || *VolName == 0) {
292 Mmsg(&dev->errmsg, _("Could not open file device %s. No Volume name given.\n"),
296 archive_name = get_pool_memory(PM_FNAME);
297 pm_strcpy(&archive_name, dev->dev_name);
298 if (archive_name[strlen(archive_name)] != '/') {
299 pm_strcat(&archive_name, "/");
301 pm_strcat(&archive_name, VolName);
302 Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
303 if (mode == OPEN_READ_WRITE) {
304 dev->mode = O_CREAT | O_RDWR | O_BINARY;
305 } else if (mode == OPEN_READ_ONLY) {
306 dev->mode = O_RDONLY | O_BINARY;
307 } else if (mode == OPEN_WRITE_ONLY) {
308 dev->mode = O_WRONLY | O_BINARY;
310 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
312 /* If creating file, give 0640 permissions */
313 if ((dev->fd = open(archive_name, dev->mode, 0640)) < 0) {
314 dev->dev_errno = errno;
315 Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
316 Emsg0(M_FATAL, 0, dev->errmsg);
319 dev->state |= ST_OPENED;
321 update_pos_dev(dev); /* update position */
323 Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
324 free_pool_memory(archive_name);
331 int _rewind_dev(char *file, int line, DEVICE *dev)
333 Dmsg2(100, "rewind_dev called from %s:%d\n", file, line);
334 return rewind_dev(dev);
341 * Returns: 1 on success
344 int rewind_dev(DEVICE *dev)
349 Dmsg1(29, "rewind_dev %s\n", dev->dev_name);
351 dev->dev_errno = EBADF;
352 Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
354 Emsg0(M_FATAL, 0, dev->errmsg);
357 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
358 dev->block_num = dev->file = 0;
360 if (dev->state & ST_TAPE) {
361 mt_com.mt_op = MTREW;
363 /* If we get an I/O error on rewind, it is probably because
364 * the drive is actually busy. We loop for (about 5 minutes)
365 * retrying every 5 seconds.
367 for (i=dev->max_rewind_wait; ; i -= 5) {
368 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
369 if (i == dev->max_rewind_wait) {
370 Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
372 clrerror_dev(dev, MTREW);
373 if (dev->dev_errno == EIO && i > 0) {
374 Dmsg0(200, "Sleeping 5 seconds.\n");
378 Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
379 dev->dev_name, strerror(dev->dev_errno));
384 } else if (dev->state & ST_FILE) {
385 if (lseek(dev->fd, (off_t)0, SEEK_SET) < 0) {
386 dev->dev_errno = errno;
387 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
388 dev->dev_name, strerror(dev->dev_errno));
396 * Position device to end of medium (end of data)
397 * Returns: 1 on succes
404 struct mtget mt_stat;
408 Dmsg0(29, "eod_dev\n");
409 if (dev->state & ST_EOT) {
412 dev->state &= ~(ST_EOF); /* remove EOF flags */
413 dev->block_num = dev->file = 0;
415 if (dev->state & (ST_FIFO | ST_PROG)) {
418 if (!(dev->state & ST_TAPE)) {
419 pos = lseek(dev->fd, (off_t)0, SEEK_END);
420 // Dmsg1(100, "====== Seek to %lld\n", pos);
423 dev->state |= ST_EOT;
426 dev->dev_errno = errno;
427 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
428 dev->dev_name, strerror(dev->dev_errno));
432 if (dev_cap(dev, CAP_EOM)) {
433 mt_com.mt_op = MTEOM;
435 if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
436 Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
437 clrerror_dev(dev, mt_com.mt_op);
439 Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
440 dev->dev_name, strerror(dev->dev_errno));
443 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
444 dev->dev_errno = errno;
445 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
446 dev->dev_name, strerror(dev->dev_errno));
449 Dmsg2(200, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
450 dev->file = mt_stat.mt_fileno;
453 * Rewind then use FSF until EOT reached
459 if (!rewind_dev(dev)) {
463 * Move file by file to the end of the tape
466 for (file_num=dev->file; !(dev->state & ST_EOT); file_num++) {
467 Dmsg0(200, "eod_dev: doing fsf 1\n");
468 if (!fsf_dev(dev, 1)) {
469 Dmsg0(200, "fsf_dev error.\n");
473 * Avoid infinite loop. ***FIXME*** possibly add code
474 * to set EOD or to turn off CAP_FASTFSF if on.
476 if (file_num == (int)dev->file) {
477 struct mtget mt_stat;
478 Dmsg1(000, "fsf_dev did not advance from file %d\n", file_num);
479 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 &&
480 mt_stat.mt_fileno >= 0) {
481 Dmsg2(000, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
482 dev->file = mt_stat.mt_fileno;
485 break; /* we are not progressing, bail out */
490 * Some drivers leave us after second EOF when doing
491 * MTEOM, so we must backup so that appending overwrites
494 if (dev_cap(dev, CAP_BSFATEOM)) {
495 struct mtget mt_stat;
496 /* Backup over EOF */
497 stat = bsf_dev(dev, 1);
498 /* If BSF worked and fileno is known (not -1), set file */
499 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
500 Dmsg2(000, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
501 dev->file = mt_stat.mt_fileno;
503 dev->file++; /* wing it -- not correct on all OSes */
506 update_pos_dev(dev); /* update position */
509 Dmsg1(200, "EOD dev->file=%d\n", dev->file);
514 * Set the position of the device -- only for files
515 * For other devices, there is no generic way to do it.
516 * Returns: 1 on succes
519 int update_pos_dev(DEVICE *dev)
525 dev->dev_errno = EBADF;
526 Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
527 Emsg0(M_FATAL, 0, dev->errmsg);
531 /* Find out where we are */
532 if (dev->state & ST_FILE) {
535 pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
537 Pmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
538 dev->dev_errno = errno;
539 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
540 dev->dev_name, strerror(dev->dev_errno));
543 dev->file_addr = pos;
552 * Return the status of the device. This was meant
553 * to be a generic routine. Unfortunately, it doesn't
554 * seem possible (at least I do not know how to do it
555 * currently), which means that for the moment, this
556 * routine has very little value.
558 * Returns: 1 on success
562 status_dev(DEVICE *dev, uint32_t *status)
564 struct mtget mt_stat;
567 if (dev->state & (ST_EOT | ST_WEOT)) {
571 if (dev->state & ST_EOF) {
575 if (dev->state & ST_TAPE) {
577 Dmsg0(-20," Bacula status:");
578 Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
579 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
580 dev->dev_errno = errno;
581 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
582 dev->dev_name, strerror(dev->dev_errno));
585 Dmsg0(-20, " Device status:");
587 #if defined(HAVE_LINUX_OS)
588 if (GMT_EOF(mt_stat.mt_gstat)) {
592 if (GMT_BOT(mt_stat.mt_gstat)) {
596 if (GMT_EOT(mt_stat.mt_gstat)) {
600 if (GMT_SM(mt_stat.mt_gstat)) {
604 if (GMT_EOD(mt_stat.mt_gstat)) {
608 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
610 Dmsg0(-20, " WR_PROT");
612 if (GMT_ONLINE(mt_stat.mt_gstat)) {
614 Dmsg0(-20, " ONLINE");
616 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
618 Dmsg0(-20, " DR_OPEN");
620 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
621 stat |= BMT_IM_REP_EN;
622 Dmsg0(-20, " IM_REP_EN");
624 #endif /* !SunOS && !OSF */
625 Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
627 stat |= BMT_ONLINE | BMT_BOT;
635 * Load medium in device
636 * Returns: 1 on success
639 int load_dev(DEVICE *dev)
646 dev->dev_errno = EBADF;
647 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
648 Emsg0(M_FATAL, 0, dev->errmsg);
651 if (!(dev->state & ST_TAPE)) {
655 Dmsg0(200, "stored: MTLOAD command not available\n");
656 dev->dev_errno = ENOTTY; /* function not available */
657 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
658 dev->dev_name, strerror(dev->dev_errno)); return 0;
662 dev->block_num = dev->file = 0;
664 mt_com.mt_op = MTLOAD;
666 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
667 dev->dev_errno = errno;
668 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
669 dev->dev_name, strerror(dev->dev_errno)); return 0;
676 * Rewind device and put it offline
677 * Returns: 1 on success
680 int offline_dev(DEVICE *dev)
685 dev->dev_errno = EBADF;
686 Mmsg0(&dev->errmsg, _("Bad call to offline_dev. Archive not open\n"));
687 Emsg0(M_FATAL, 0, dev->errmsg);
690 if (!(dev->state & ST_TAPE)) {
694 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
695 dev->block_num = dev->file = 0;
698 mt_com.mt_op = MTUNLOCK;
700 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
702 mt_com.mt_op = MTOFFL;
704 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
705 dev->dev_errno = errno;
706 Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
707 dev->dev_name, strerror(dev->dev_errno));
710 Dmsg1(100, "Offlined device %s\n", dev->dev_name);
714 int offline_or_rewind_dev(DEVICE *dev)
716 if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
717 return offline_dev(dev);
720 * Note, this rewind probably should not be here (it wasn't
721 * in prior versions of Bacula), but on FreeBSD, this is
722 * needed in the case the tape was "frozen" due to an error
723 * such as backspacing after writing and EOF. If it is not
724 * done, all future references to the drive get and I/O error.
726 return rewind_dev(dev);
731 * Foward space a file
732 * Returns: 1 on success
736 fsf_dev(DEVICE *dev, int num)
738 struct mtget mt_stat;
743 dev->dev_errno = EBADF;
744 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
745 Emsg0(M_FATAL, 0, dev->errmsg);
749 if (!(dev->state & ST_TAPE)) {
752 if (dev->state & ST_EOT) {
754 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
757 if (dev->state & ST_EOF) {
758 Dmsg0(200, "ST_EOF set on entry to FSF\n");
761 Dmsg0(29, "fsf_dev\n");
764 * If Fast forward space file is set, then we
765 * use MTFSF to forward space and MTIOCGET
766 * to get the file position. We assume that
767 * the SCSI driver will ensure that we do not
768 * forward space over the end of data mark.
770 if (dev_cap(dev, CAP_FSF) && dev_cap(dev, CAP_FASTFSF)) {
771 mt_com.mt_op = MTFSF;
772 mt_com.mt_count = num;
773 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
774 if (stat < 0 || ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
775 dev->state |= ST_EOT;
776 Dmsg0(200, "Set ST_EOT\n");
777 clrerror_dev(dev, MTFSF);
778 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
779 dev->dev_name, strerror(dev->dev_errno));
780 Dmsg1(200, "%s", dev->errmsg);
783 Dmsg2(200, "fsf file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
784 dev->file = mt_stat.mt_fileno;
785 dev->state |= ST_EOF; /* just read EOF */
790 * Here if CAP_FSF is set, and virtually all drives
791 * these days support it, we read a record, then forward
792 * space one file. Using this procedure, which is slow,
793 * is the only way we can be sure that we don't read
794 * two consecutive EOF marks, which means End of Data.
796 } else if (dev_cap(dev, CAP_FSF)) {
799 Dmsg0(200, "FSF has cap_fsf\n");
800 if (dev->max_block_size == 0) {
801 rbuf_len = DEFAULT_BLOCK_SIZE;
803 rbuf_len = dev->max_block_size;
805 rbuf = get_memory(rbuf_len);
806 mt_com.mt_op = MTFSF;
808 while (num-- && !(dev->state & ST_EOT)) {
809 Dmsg0(200, "Doing read before fsf\n");
810 if ((stat = read(dev->fd, (char *)rbuf, rbuf_len)) < 0) {
811 if (errno == ENOMEM) { /* tape record exceeds buf len */
812 stat = rbuf_len; /* This is OK */
814 dev->state |= ST_EOT;
815 clrerror_dev(dev, -1);
816 Dmsg2(200, "Set ST_EOT read errno=%d. ERR=%s\n", dev->dev_errno,
817 strerror(dev->dev_errno));
818 Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
819 dev->dev_name, strerror(dev->dev_errno));
820 Dmsg1(200, "%s", dev->errmsg);
824 if (stat == 0) { /* EOF */
826 Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
827 /* Two reads of zero means end of tape */
828 if (dev->state & ST_EOF) {
829 dev->state |= ST_EOT;
830 Dmsg0(200, "Set ST_EOT\n");
833 dev->state |= ST_EOF;
838 } else { /* Got data */
839 dev->state &= ~(ST_EOF|ST_EOT);
842 Dmsg0(200, "Doing MTFSF\n");
843 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
844 if (stat < 0) { /* error => EOT */
845 dev->state |= ST_EOT;
846 Dmsg0(200, "Set ST_EOT\n");
847 clrerror_dev(dev, MTFSF);
848 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
849 dev->dev_name, strerror(dev->dev_errno));
850 Dmsg0(200, "Got < 0 for MTFSF\n");
851 Dmsg1(200, "%s", dev->errmsg);
853 dev->state |= ST_EOF; /* just read EOF */
861 * No FSF, so use FSR to simulate it
864 Dmsg0(200, "Doing FSR for FSF\n");
865 while (num-- && !(dev->state & ST_EOT)) {
866 fsr_dev(dev, INT32_MAX); /* returns -1 on EOF or EOT */
868 if (dev->state & ST_EOT) {
870 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
877 Dmsg1(200, "Return %d from FSF\n", stat);
878 if (dev->state & ST_EOF)
879 Dmsg0(200, "ST_EOF set on exit FSF\n");
880 if (dev->state & ST_EOT)
881 Dmsg0(200, "ST_EOT set on exit FSF\n");
882 Dmsg1(200, "Return from FSF file=%d\n", dev->file);
883 return stat == 0 ? 1 : 0;
887 * Backward space a file
888 * Returns: 0 on failure
892 bsf_dev(DEVICE *dev, int num)
898 dev->dev_errno = EBADF;
899 Mmsg0(&dev->errmsg, _("Bad call to bsf_dev. Archive device not open\n"));
900 Emsg0(M_FATAL, 0, dev->errmsg);
904 if (!(dev_state(dev, ST_TAPE))) {
905 Mmsg1(&dev->errmsg, _("Device %s cannot BSF because it is not a tape.\n"),
909 Dmsg0(29, "bsf_dev\n");
910 dev->state &= ~(ST_EOT|ST_EOF);
913 mt_com.mt_op = MTBSF;
914 mt_com.mt_count = num;
915 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
917 clrerror_dev(dev, MTBSF);
918 Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
919 dev->dev_name, strerror(dev->dev_errno));
922 return stat == 0 ? 1 : 0;
927 * Foward space a record
928 * Returns: 0 on failure
932 fsr_dev(DEVICE *dev, int num)
938 dev->dev_errno = EBADF;
939 Mmsg0(&dev->errmsg, _("Bad call to fsr_dev. Archive not open\n"));
940 Emsg0(M_FATAL, 0, dev->errmsg);
944 if (!(dev_state(dev, ST_TAPE))) {
947 Dmsg0(29, "fsr_dev\n");
948 dev->block_num += num;
949 mt_com.mt_op = MTFSR;
950 mt_com.mt_count = num;
951 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
953 dev->state &= ~ST_EOF;
955 if (dev->state & ST_EOF) {
956 dev->state |= ST_EOT;
958 dev->state |= ST_EOF; /* assume EOF */
962 clrerror_dev(dev, MTFSR);
963 Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
964 dev->dev_name, strerror(dev->dev_errno));
967 return stat == 0 ? 1 : 0;
971 * Backward space a record
972 * Returns: 0 on failure
976 bsr_dev(DEVICE *dev, int num)
982 dev->dev_errno = EBADF;
983 Mmsg0(&dev->errmsg, _("Bad call to bsr_dev. Archive not open\n"));
984 Emsg0(M_FATAL, 0, dev->errmsg);
988 if (!(dev->state & ST_TAPE)) {
992 if (!dev_cap(dev, CAP_BSR)) {
993 Mmsg1(&dev->errmsg, _("ioctl MTBSR not permitted on %s.\n"),
998 Dmsg0(29, "bsr_dev\n");
999 dev->block_num -= num;
1000 dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
1001 mt_com.mt_op = MTBSR;
1002 mt_com.mt_count = num;
1003 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1005 clrerror_dev(dev, MTBSR);
1006 Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
1007 dev->dev_name, strerror(dev->dev_errno));
1009 update_pos_dev(dev);
1010 return stat == 0 ? 1 : 0;
1014 * Reposition the device to file, block
1015 * Currently only works for tapes.
1016 * Returns: 0 on failure
1020 reposition_dev(DEVICE *dev, uint32_t file, uint32_t block)
1023 dev->dev_errno = EBADF;
1024 Mmsg0(&dev->errmsg, _("Bad call to reposition_dev. Archive not open\n"));
1025 Emsg0(M_FATAL, 0, dev->errmsg);
1029 if (!(dev_state(dev, ST_TAPE))) {
1032 Dmsg4(100, "reposition_dev from %u:%u to %u:%u\n",
1033 dev->file, dev->block_num, file, block);
1034 if (file < dev->file) {
1035 Dmsg0(100, "Rewind_dev\n");
1036 if (!rewind_dev(dev)) {
1040 if (file > dev->file) {
1041 Dmsg1(100, "fsf %d\n", file-dev->file);
1042 if (!fsf_dev(dev, file-dev->file)) {
1046 if (block < dev->block_num) {
1050 if (block > dev->block_num) {
1051 /* Ignore errors as Bacula can read to the correct block */
1052 Dmsg1(100, "fsr %d\n", block-dev->block_num);
1053 fsr_dev(dev, block-dev->block_num);
1061 * Write an end of file on the device
1062 * Returns: 0 on success
1063 * non-zero on failure
1066 weof_dev(DEVICE *dev, int num)
1072 dev->dev_errno = EBADF;
1073 Mmsg0(&dev->errmsg, _("Bad call to weof_dev. Archive drive not open\n"));
1074 Emsg0(M_FATAL, 0, dev->errmsg);
1078 if (!(dev_state(dev, ST_TAPE))) {
1081 dev->state &= ~(ST_EOT | ST_EOF); /* remove EOF/EOT flags */
1083 Dmsg0(29, "weof_dev\n");
1084 mt_com.mt_op = MTWEOF;
1085 mt_com.mt_count = num;
1086 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1091 clrerror_dev(dev, MTWEOF);
1093 Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
1094 dev->dev_name, strerror(dev->dev_errno));
1101 * Return string message with last error in English
1102 * Be careful not to call this routine from within dev.c
1103 * while editing an Mmsg(&) or you will end up in a recursive
1104 * loop creating a Segmentation Violation.
1107 strerror_dev(DEVICE *dev)
1114 * If implemented in system, clear the tape
1118 clrerror_dev(DEVICE *dev, int func)
1122 dev->dev_errno = errno; /* save errno */
1124 dev->VolCatInfo.VolCatErrors++;
1127 if (!(dev->state & ST_TAPE)) {
1130 if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
1133 Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
1137 dev->capabilities &= ~CAP_EOF; /* turn off feature */
1142 dev->capabilities &= ~CAP_EOM; /* turn off feature */
1147 dev->capabilities &= ~CAP_FSF; /* turn off feature */
1151 dev->capabilities &= ~CAP_BSF; /* turn off feature */
1155 dev->capabilities &= ~CAP_FSR; /* turn off feature */
1159 dev->capabilities &= ~CAP_BSR; /* turn off feature */
1166 dev->dev_errno = ENOSYS;
1167 Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
1168 Emsg0(M_ERROR, 0, dev->errmsg);
1171 /* Found on Linux */
1175 mt_com.mt_op = MTIOCLRERR;
1176 mt_com.mt_count = 1;
1177 /* Clear any error condition on the tape */
1178 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1179 Dmsg0(200, "Did MTIOCLRERR\n");
1183 /* Typically on FreeBSD */
1186 /* Read and clear SCSI error status */
1187 union mterrstat mt_errstat;
1188 Dmsg2(200, "Doing MTIOCERRSTAT errno=%d ERR=%s\n", dev->dev_errno,
1189 strerror(dev->dev_errno));
1190 ioctl(dev->fd, MTIOCERRSTAT, (char *)&mt_errstat);
1196 * Flush buffer contents
1199 int flush_dev(DEVICE *dev)
1204 static void do_close(DEVICE *dev)
1207 Dmsg1(29, "really close_dev %s\n", dev->dev_name);
1211 /* Clean up device packet so it can be reused */
1213 dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1214 dev->file = dev->block_num = 0;
1216 dev->EndFile = dev->EndBlock = 0;
1217 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1218 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1220 stop_thread_timer(dev->tid);
1230 close_dev(DEVICE *dev)
1233 Mmsg0(&dev->errmsg, _("Bad call to close_dev. Archive not open\n"));
1234 Emsg0(M_FATAL, 0, dev->errmsg);
1237 if (dev->fd >= 0 && dev->use_count == 1) {
1239 } else if (dev->use_count > 0) {
1244 ASSERT(dev->use_count >= 0);
1249 * Used when unmounting the device, ignore use_count
1251 void force_close_dev(DEVICE *dev)
1254 Mmsg0(&dev->errmsg, _("Bad call to force_close_dev. Archive not open\n"));
1255 Emsg0(M_FATAL, 0, dev->errmsg);
1258 Dmsg1(29, "Force close_dev %s\n", dev->dev_name);
1262 ASSERT(dev->use_count >= 0);
1266 int truncate_dev(DEVICE *dev)
1268 if (dev->state & ST_TAPE) {
1271 if (ftruncate(dev->fd, 0) != 0) {
1272 Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1279 dev_is_tape(DEVICE *dev)
1281 return (dev->state & ST_TAPE) ? 1 : 0;
1286 * return 1 if the device is read for write, and 0 otherwise
1287 * This is meant for checking at the end of a job to see
1288 * if we still have a tape (perhaps not if at end of tape
1289 * and the job is canceled).
1292 dev_can_write(DEVICE *dev)
1294 if ((dev->state & ST_OPENED) && (dev->state & ST_APPEND) &&
1295 (dev->state & ST_LABEL) && !(dev->state & ST_WEOT)) {
1303 dev_name(DEVICE *dev)
1305 return dev->dev_name;
1309 dev_vol_name(DEVICE *dev)
1311 return dev->VolCatInfo.VolCatName;
1314 uint32_t dev_block(DEVICE *dev)
1316 update_pos_dev(dev);
1317 return dev->block_num;
1320 uint32_t dev_file(DEVICE *dev)
1322 update_pos_dev(dev);
1327 * Free memory allocated for the device
1330 term_dev(DEVICE *dev)
1333 dev->dev_errno = EBADF;
1334 Mmsg0(&dev->errmsg, _("Bad call to term_dev. Archive not open\n"));
1335 Emsg0(M_FATAL, 0, dev->errmsg);
1339 Dmsg0(29, "term_dev\n");
1340 if (dev->dev_name) {
1341 free_memory(dev->dev_name);
1342 dev->dev_name = NULL;
1345 free_pool_memory(dev->errmsg);
1348 pthread_mutex_destroy(&dev->mutex);
1349 pthread_cond_destroy(&dev->wait);
1350 pthread_cond_destroy(&dev->wait_next_vol);
1351 if (dev->state & ST_MALLOC) {
1352 free_pool_memory((POOLMEM *)dev);
1357 * We attach a jcr to the device so that when
1358 * the Volume is full during writing, a
1359 * JobMedia record will be created for this
1362 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1364 jcr->prev_dev = (JCR *)NULL;
1365 jcr->next_dev = dev->attached_jcrs;
1366 if (dev->attached_jcrs) {
1367 dev->attached_jcrs->prev_dev = jcr;
1369 dev->attached_jcrs = jcr;
1370 Dmsg1(100, "Attached Job %s\n", jcr->Job);
1373 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1375 if (!jcr->prev_dev) {
1376 dev->attached_jcrs = jcr->next_dev;
1378 jcr->prev_dev->next_dev = jcr->next_dev;
1380 if (jcr->next_dev) {
1381 jcr->next_dev->prev_dev = jcr->prev_dev;
1383 jcr->next_dev = jcr->prev_dev = NULL;
1384 Dmsg1(100, "Detached Job %s\n", jcr->Job);
1387 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1389 if (jcr == (JCR *)NULL) {
1390 return dev->attached_jcrs;
1392 return jcr->next_dev;
1396 * This routine initializes the device wait timers
1398 void init_dev_wait_timers(DEVICE *dev)
1400 /* ******FIXME******* put these on config variables */
1401 dev->min_wait = 60 * 60;
1402 dev->max_wait = 24 * 60 * 60;
1403 dev->max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
1404 dev->wait_sec = dev->min_wait;
1405 dev->rem_wait_sec = dev->wait_sec;
1408 dev->BadVolName[0] = 0;
1412 * Returns: true if time doubled
1413 * false if max time expired
1415 bool double_dev_wait_time(DEVICE *dev)
1417 dev->wait_sec *= 2; /* double wait time */
1418 if (dev->wait_sec > dev->max_wait) { /* but not longer than maxtime */
1419 dev->wait_sec = dev->max_wait;
1422 dev->rem_wait_sec = dev->wait_sec;
1423 if (dev->num_wait >= dev->max_num_wait) {