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));
433 if (dev_cap(dev, CAP_FASTFSF) && !dev_cap(dev, CAP_EOM)) {
434 struct mtget mt_stat;
435 Dmsg0(000,"Using FAST FSF for EOM\n");
436 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno <= 0) {
437 if (!rewind_dev(dev)) {
441 mt_com.mt_op = MTFSF;
443 * ***FIXEM*** fix code to handle case that INT16_MAX is
446 mt_com.mt_count = INT16_MAX; /* use big positive number */
447 if (mt_com.mt_count < 0) {
448 mt_com.mt_count = INT16_MAX; /* brain damaged system */
452 if (dev_cap(dev, CAP_EOM)) {
453 Dmsg0(000,"Using EOM for EOM\n");
454 mt_com.mt_op = MTEOM;
457 if (dev_cap(dev, CAP_FASTFSF) || dev_cap(dev, CAP_EOM)) {
458 if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
459 Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
460 clrerror_dev(dev, mt_com.mt_op);
462 Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
463 dev->dev_name, strerror(dev->dev_errno));
467 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
468 dev->dev_errno = errno;
469 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
470 dev->dev_name, strerror(dev->dev_errno));
473 Dmsg2(000, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
474 dev->file = mt_stat.mt_fileno;
477 * Rewind then use FSF until EOT reached
483 if (!rewind_dev(dev)) {
487 * Move file by file to the end of the tape
490 for (file_num=dev->file; !(dev->state & ST_EOT); file_num++) {
491 Dmsg0(200, "eod_dev: doing fsf 1\n");
492 if (!fsf_dev(dev, 1)) {
493 Dmsg0(200, "fsf_dev error.\n");
497 * Avoid infinite loop. ***FIXME*** possibly add code
498 * to set EOD or to turn off CAP_FASTFSF if on.
500 if (file_num == (int)dev->file) {
501 struct mtget mt_stat;
502 Dmsg1(000, "fsf_dev did not advance from file %d\n", file_num);
503 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 &&
504 mt_stat.mt_fileno >= 0) {
505 Dmsg2(000, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
506 dev->file = mt_stat.mt_fileno;
509 break; /* we are not progressing, bail out */
514 * Some drivers leave us after second EOF when doing
515 * MTEOM, so we must backup so that appending overwrites
518 if (dev_cap(dev, CAP_BSFATEOM)) {
519 struct mtget mt_stat;
520 /* Backup over EOF */
521 stat = bsf_dev(dev, 1);
522 /* If BSF worked and fileno is known (not -1), set file */
523 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
524 Dmsg2(000, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
525 dev->file = mt_stat.mt_fileno;
527 dev->file++; /* wing it -- not correct on all OSes */
530 update_pos_dev(dev); /* update position */
533 Dmsg1(200, "EOD dev->file=%d\n", dev->file);
538 * Set the position of the device -- only for files
539 * For other devices, there is no generic way to do it.
540 * Returns: 1 on succes
543 int update_pos_dev(DEVICE *dev)
549 dev->dev_errno = EBADF;
550 Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
551 Emsg0(M_FATAL, 0, dev->errmsg);
555 /* Find out where we are */
556 if (dev->state & ST_FILE) {
559 pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
561 Pmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
562 dev->dev_errno = errno;
563 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
564 dev->dev_name, strerror(dev->dev_errno));
567 dev->file_addr = pos;
576 * Return the status of the device. This was meant
577 * to be a generic routine. Unfortunately, it doesn't
578 * seem possible (at least I do not know how to do it
579 * currently), which means that for the moment, this
580 * routine has very little value.
584 uint32_t status_dev(DEVICE *dev)
586 struct mtget mt_stat;
589 if (dev->state & (ST_EOT | ST_WEOT)) {
593 if (dev->state & ST_EOF) {
597 if (dev->state & ST_TAPE) {
599 Dmsg0(-20," Bacula status:");
600 Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
601 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
602 dev->dev_errno = errno;
603 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
604 dev->dev_name, strerror(dev->dev_errno));
607 Dmsg0(-20, " Device status:");
609 #if defined(HAVE_LINUX_OS)
610 if (GMT_EOF(mt_stat.mt_gstat)) {
614 if (GMT_BOT(mt_stat.mt_gstat)) {
618 if (GMT_EOT(mt_stat.mt_gstat)) {
622 if (GMT_SM(mt_stat.mt_gstat)) {
626 if (GMT_EOD(mt_stat.mt_gstat)) {
630 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
632 Dmsg0(-20, " WR_PROT");
634 if (GMT_ONLINE(mt_stat.mt_gstat)) {
636 Dmsg0(-20, " ONLINE");
638 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
640 Dmsg0(-20, " DR_OPEN");
642 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
643 stat |= BMT_IM_REP_EN;
644 Dmsg0(-20, " IM_REP_EN");
646 #endif /* !SunOS && !OSF */
647 Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
649 stat |= BMT_ONLINE | BMT_BOT;
656 * Load medium in device
657 * Returns: 1 on success
660 int load_dev(DEVICE *dev)
667 dev->dev_errno = EBADF;
668 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
669 Emsg0(M_FATAL, 0, dev->errmsg);
672 if (!(dev->state & ST_TAPE)) {
676 Dmsg0(200, "stored: MTLOAD command not available\n");
677 dev->dev_errno = ENOTTY; /* function not available */
678 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
679 dev->dev_name, strerror(dev->dev_errno)); return 0;
683 dev->block_num = dev->file = 0;
685 mt_com.mt_op = MTLOAD;
687 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
688 dev->dev_errno = errno;
689 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
690 dev->dev_name, strerror(dev->dev_errno)); return 0;
697 * Rewind device and put it offline
698 * Returns: 1 on success
701 int offline_dev(DEVICE *dev)
706 dev->dev_errno = EBADF;
707 Mmsg0(&dev->errmsg, _("Bad call to offline_dev. Archive not open\n"));
708 Emsg0(M_FATAL, 0, dev->errmsg);
711 if (!(dev->state & ST_TAPE)) {
715 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
716 dev->block_num = dev->file = 0;
719 mt_com.mt_op = MTUNLOCK;
721 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
723 mt_com.mt_op = MTOFFL;
725 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
726 dev->dev_errno = errno;
727 Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
728 dev->dev_name, strerror(dev->dev_errno));
731 Dmsg1(100, "Offlined device %s\n", dev->dev_name);
735 int offline_or_rewind_dev(DEVICE *dev)
737 if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
738 return offline_dev(dev);
741 * Note, this rewind probably should not be here (it wasn't
742 * in prior versions of Bacula), but on FreeBSD, this is
743 * needed in the case the tape was "frozen" due to an error
744 * such as backspacing after writing and EOF. If it is not
745 * done, all future references to the drive get and I/O error.
747 return rewind_dev(dev);
752 * Foward space a file
753 * Returns: 1 on success
757 fsf_dev(DEVICE *dev, int num)
759 struct mtget mt_stat;
764 dev->dev_errno = EBADF;
765 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
766 Emsg0(M_FATAL, 0, dev->errmsg);
770 if (!(dev->state & ST_TAPE)) {
773 if (dev->state & ST_EOT) {
775 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
778 if (dev->state & ST_EOF) {
779 Dmsg0(200, "ST_EOF set on entry to FSF\n");
782 Dmsg0(29, "fsf_dev\n");
785 * If Fast forward space file is set, then we
786 * use MTFSF to forward space and MTIOCGET
787 * to get the file position. We assume that
788 * the SCSI driver will ensure that we do not
789 * forward space over the end of data mark.
791 if (dev_cap(dev, CAP_FSF) && dev_cap(dev, CAP_FASTFSF)) {
792 mt_com.mt_op = MTFSF;
793 mt_com.mt_count = num;
794 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
795 if (stat < 0 || ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
796 dev->state |= ST_EOT;
797 Dmsg0(200, "Set ST_EOT\n");
798 clrerror_dev(dev, MTFSF);
799 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
800 dev->dev_name, strerror(dev->dev_errno));
801 Dmsg1(200, "%s", dev->errmsg);
804 Dmsg2(200, "fsf file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
805 dev->file = mt_stat.mt_fileno;
806 dev->state |= ST_EOF; /* just read EOF */
811 * Here if CAP_FSF is set, and virtually all drives
812 * these days support it, we read a record, then forward
813 * space one file. Using this procedure, which is slow,
814 * is the only way we can be sure that we don't read
815 * two consecutive EOF marks, which means End of Data.
817 } else if (dev_cap(dev, CAP_FSF)) {
820 Dmsg0(200, "FSF has cap_fsf\n");
821 if (dev->max_block_size == 0) {
822 rbuf_len = DEFAULT_BLOCK_SIZE;
824 rbuf_len = dev->max_block_size;
826 rbuf = get_memory(rbuf_len);
827 mt_com.mt_op = MTFSF;
829 while (num-- && !(dev->state & ST_EOT)) {
830 Dmsg0(200, "Doing read before fsf\n");
831 if ((stat = read(dev->fd, (char *)rbuf, rbuf_len)) < 0) {
832 if (errno == ENOMEM) { /* tape record exceeds buf len */
833 stat = rbuf_len; /* This is OK */
835 dev->state |= ST_EOT;
836 clrerror_dev(dev, -1);
837 Dmsg2(200, "Set ST_EOT read errno=%d. ERR=%s\n", dev->dev_errno,
838 strerror(dev->dev_errno));
839 Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
840 dev->dev_name, strerror(dev->dev_errno));
841 Dmsg1(200, "%s", dev->errmsg);
845 if (stat == 0) { /* EOF */
847 Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
848 /* Two reads of zero means end of tape */
849 if (dev->state & ST_EOF) {
850 dev->state |= ST_EOT;
851 Dmsg0(200, "Set ST_EOT\n");
854 dev->state |= ST_EOF;
859 } else { /* Got data */
860 dev->state &= ~(ST_EOF|ST_EOT);
863 Dmsg0(200, "Doing MTFSF\n");
864 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
865 if (stat < 0) { /* error => EOT */
866 dev->state |= ST_EOT;
867 Dmsg0(200, "Set ST_EOT\n");
868 clrerror_dev(dev, MTFSF);
869 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
870 dev->dev_name, strerror(dev->dev_errno));
871 Dmsg0(200, "Got < 0 for MTFSF\n");
872 Dmsg1(200, "%s", dev->errmsg);
874 dev->state |= ST_EOF; /* just read EOF */
882 * No FSF, so use FSR to simulate it
885 Dmsg0(200, "Doing FSR for FSF\n");
886 while (num-- && !(dev->state & ST_EOT)) {
887 fsr_dev(dev, INT32_MAX); /* returns -1 on EOF or EOT */
889 if (dev->state & ST_EOT) {
891 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
898 Dmsg1(200, "Return %d from FSF\n", stat);
899 if (dev->state & ST_EOF)
900 Dmsg0(200, "ST_EOF set on exit FSF\n");
901 if (dev->state & ST_EOT)
902 Dmsg0(200, "ST_EOT set on exit FSF\n");
903 Dmsg1(200, "Return from FSF file=%d\n", dev->file);
904 return stat == 0 ? 1 : 0;
908 * Backward space a file
909 * Returns: 0 on failure
913 bsf_dev(DEVICE *dev, int num)
919 dev->dev_errno = EBADF;
920 Mmsg0(&dev->errmsg, _("Bad call to bsf_dev. Archive device not open\n"));
921 Emsg0(M_FATAL, 0, dev->errmsg);
925 if (!(dev_state(dev, ST_TAPE))) {
926 Mmsg1(&dev->errmsg, _("Device %s cannot BSF because it is not a tape.\n"),
930 Dmsg0(29, "bsf_dev\n");
931 dev->state &= ~(ST_EOT|ST_EOF);
934 mt_com.mt_op = MTBSF;
935 mt_com.mt_count = num;
936 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
938 clrerror_dev(dev, MTBSF);
939 Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
940 dev->dev_name, strerror(dev->dev_errno));
943 return stat == 0 ? 1 : 0;
948 * Foward space a record
949 * Returns: 0 on failure
953 fsr_dev(DEVICE *dev, int num)
959 dev->dev_errno = EBADF;
960 Mmsg0(&dev->errmsg, _("Bad call to fsr_dev. Archive not open\n"));
961 Emsg0(M_FATAL, 0, dev->errmsg);
965 if (!(dev_state(dev, ST_TAPE))) {
968 Dmsg0(29, "fsr_dev\n");
969 dev->block_num += num;
970 mt_com.mt_op = MTFSR;
971 mt_com.mt_count = num;
972 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
974 dev->state &= ~ST_EOF;
976 if (dev->state & ST_EOF) {
977 dev->state |= ST_EOT;
979 dev->state |= ST_EOF; /* assume EOF */
983 clrerror_dev(dev, MTFSR);
984 Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
985 dev->dev_name, strerror(dev->dev_errno));
988 return stat == 0 ? 1 : 0;
992 * Backward space a record
993 * Returns: 0 on failure
997 bsr_dev(DEVICE *dev, int num)
1003 dev->dev_errno = EBADF;
1004 Mmsg0(&dev->errmsg, _("Bad call to bsr_dev. Archive not open\n"));
1005 Emsg0(M_FATAL, 0, dev->errmsg);
1009 if (!(dev->state & ST_TAPE)) {
1013 if (!dev_cap(dev, CAP_BSR)) {
1014 Mmsg1(&dev->errmsg, _("ioctl MTBSR not permitted on %s.\n"),
1019 Dmsg0(29, "bsr_dev\n");
1020 dev->block_num -= num;
1021 dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
1022 mt_com.mt_op = MTBSR;
1023 mt_com.mt_count = num;
1024 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1026 clrerror_dev(dev, MTBSR);
1027 Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
1028 dev->dev_name, strerror(dev->dev_errno));
1030 update_pos_dev(dev);
1031 return stat == 0 ? 1 : 0;
1035 * Reposition the device to file, block
1036 * Currently only works for tapes.
1037 * Returns: 0 on failure
1041 reposition_dev(DEVICE *dev, uint32_t file, uint32_t block)
1044 dev->dev_errno = EBADF;
1045 Mmsg0(&dev->errmsg, _("Bad call to reposition_dev. Archive not open\n"));
1046 Emsg0(M_FATAL, 0, dev->errmsg);
1050 if (!(dev_state(dev, ST_TAPE))) {
1053 Dmsg4(100, "reposition_dev from %u:%u to %u:%u\n",
1054 dev->file, dev->block_num, file, block);
1055 if (file < dev->file) {
1056 Dmsg0(100, "Rewind_dev\n");
1057 if (!rewind_dev(dev)) {
1061 if (file > dev->file) {
1062 Dmsg1(100, "fsf %d\n", file-dev->file);
1063 if (!fsf_dev(dev, file-dev->file)) {
1067 if (block < dev->block_num) {
1071 if (block > dev->block_num) {
1072 /* Ignore errors as Bacula can read to the correct block */
1073 Dmsg1(100, "fsr %d\n", block-dev->block_num);
1074 fsr_dev(dev, block-dev->block_num);
1082 * Write an end of file on the device
1083 * Returns: 0 on success
1084 * non-zero on failure
1087 weof_dev(DEVICE *dev, int num)
1093 dev->dev_errno = EBADF;
1094 Mmsg0(&dev->errmsg, _("Bad call to weof_dev. Archive drive not open\n"));
1095 Emsg0(M_FATAL, 0, dev->errmsg);
1099 if (!(dev_state(dev, ST_TAPE))) {
1102 dev->state &= ~(ST_EOT | ST_EOF); /* remove EOF/EOT flags */
1104 Dmsg0(29, "weof_dev\n");
1105 mt_com.mt_op = MTWEOF;
1106 mt_com.mt_count = num;
1107 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1112 clrerror_dev(dev, MTWEOF);
1114 Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
1115 dev->dev_name, strerror(dev->dev_errno));
1122 * Return string message with last error in English
1123 * Be careful not to call this routine from within dev.c
1124 * while editing an Mmsg(&) or you will end up in a recursive
1125 * loop creating a Segmentation Violation.
1128 strerror_dev(DEVICE *dev)
1135 * If implemented in system, clear the tape
1139 clrerror_dev(DEVICE *dev, int func)
1143 dev->dev_errno = errno; /* save errno */
1145 dev->VolCatInfo.VolCatErrors++;
1148 if (!(dev->state & ST_TAPE)) {
1151 if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
1154 Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
1158 dev->capabilities &= ~CAP_EOF; /* turn off feature */
1163 dev->capabilities &= ~CAP_EOM; /* turn off feature */
1168 dev->capabilities &= ~CAP_FSF; /* turn off feature */
1172 dev->capabilities &= ~CAP_BSF; /* turn off feature */
1176 dev->capabilities &= ~CAP_FSR; /* turn off feature */
1180 dev->capabilities &= ~CAP_BSR; /* turn off feature */
1187 dev->dev_errno = ENOSYS;
1188 Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
1189 Emsg0(M_ERROR, 0, dev->errmsg);
1192 /* Found on Linux */
1196 mt_com.mt_op = MTIOCLRERR;
1197 mt_com.mt_count = 1;
1198 /* Clear any error condition on the tape */
1199 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1200 Dmsg0(200, "Did MTIOCLRERR\n");
1204 /* Typically on FreeBSD */
1207 /* Read and clear SCSI error status */
1208 union mterrstat mt_errstat;
1209 Dmsg2(200, "Doing MTIOCERRSTAT errno=%d ERR=%s\n", dev->dev_errno,
1210 strerror(dev->dev_errno));
1211 ioctl(dev->fd, MTIOCERRSTAT, (char *)&mt_errstat);
1217 * Flush buffer contents
1220 int flush_dev(DEVICE *dev)
1225 static void do_close(DEVICE *dev)
1228 Dmsg1(29, "really close_dev %s\n", dev->dev_name);
1232 /* Clean up device packet so it can be reused */
1234 dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1235 dev->file = dev->block_num = 0;
1237 dev->EndFile = dev->EndBlock = 0;
1238 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1239 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1241 stop_thread_timer(dev->tid);
1251 close_dev(DEVICE *dev)
1254 Mmsg0(&dev->errmsg, _("Bad call to close_dev. Archive not open\n"));
1255 Emsg0(M_FATAL, 0, dev->errmsg);
1258 if (dev->fd >= 0 && dev->use_count == 1) {
1260 } else if (dev->use_count > 0) {
1265 ASSERT(dev->use_count >= 0);
1270 * Used when unmounting the device, ignore use_count
1272 void force_close_dev(DEVICE *dev)
1275 Mmsg0(&dev->errmsg, _("Bad call to force_close_dev. Archive not open\n"));
1276 Emsg0(M_FATAL, 0, dev->errmsg);
1279 Dmsg1(29, "Force close_dev %s\n", dev->dev_name);
1283 ASSERT(dev->use_count >= 0);
1287 int truncate_dev(DEVICE *dev)
1289 if (dev->state & ST_TAPE) {
1292 if (ftruncate(dev->fd, 0) != 0) {
1293 Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1300 dev_is_tape(DEVICE *dev)
1302 return (dev->state & ST_TAPE) ? 1 : 0;
1307 * return 1 if the device is read for write, and 0 otherwise
1308 * This is meant for checking at the end of a job to see
1309 * if we still have a tape (perhaps not if at end of tape
1310 * and the job is canceled).
1313 dev_can_write(DEVICE *dev)
1315 if ((dev->state & ST_OPENED) && (dev->state & ST_APPEND) &&
1316 (dev->state & ST_LABEL) && !(dev->state & ST_WEOT)) {
1324 dev_name(DEVICE *dev)
1326 return dev->dev_name;
1330 dev_vol_name(DEVICE *dev)
1332 return dev->VolCatInfo.VolCatName;
1335 uint32_t dev_block(DEVICE *dev)
1337 update_pos_dev(dev);
1338 return dev->block_num;
1341 uint32_t dev_file(DEVICE *dev)
1343 update_pos_dev(dev);
1348 * Free memory allocated for the device
1351 term_dev(DEVICE *dev)
1354 dev->dev_errno = EBADF;
1355 Mmsg0(&dev->errmsg, _("Bad call to term_dev. Archive not open\n"));
1356 Emsg0(M_FATAL, 0, dev->errmsg);
1360 Dmsg0(29, "term_dev\n");
1361 if (dev->dev_name) {
1362 free_memory(dev->dev_name);
1363 dev->dev_name = NULL;
1366 free_pool_memory(dev->errmsg);
1369 pthread_mutex_destroy(&dev->mutex);
1370 pthread_cond_destroy(&dev->wait);
1371 pthread_cond_destroy(&dev->wait_next_vol);
1372 if (dev->state & ST_MALLOC) {
1373 free_pool_memory((POOLMEM *)dev);
1378 * We attach a jcr to the device so that when
1379 * the Volume is full during writing, a
1380 * JobMedia record will be created for this
1383 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1385 jcr->prev_dev = (JCR *)NULL;
1386 jcr->next_dev = dev->attached_jcrs;
1387 if (dev->attached_jcrs) {
1388 dev->attached_jcrs->prev_dev = jcr;
1390 dev->attached_jcrs = jcr;
1391 Dmsg1(100, "Attached Job %s\n", jcr->Job);
1394 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1396 if (!jcr->prev_dev) {
1397 dev->attached_jcrs = jcr->next_dev;
1399 jcr->prev_dev->next_dev = jcr->next_dev;
1401 if (jcr->next_dev) {
1402 jcr->next_dev->prev_dev = jcr->prev_dev;
1404 jcr->next_dev = jcr->prev_dev = NULL;
1405 Dmsg1(100, "Detached Job %s\n", jcr->Job);
1408 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1410 if (jcr == (JCR *)NULL) {
1411 return dev->attached_jcrs;
1413 return jcr->next_dev;
1417 * This routine initializes the device wait timers
1419 void init_dev_wait_timers(DEVICE *dev)
1421 /* ******FIXME******* put these on config variables */
1422 dev->min_wait = 60 * 60;
1423 dev->max_wait = 24 * 60 * 60;
1424 dev->max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
1425 dev->wait_sec = dev->min_wait;
1426 dev->rem_wait_sec = dev->wait_sec;
1429 dev->BadVolName[0] = 0;
1433 * Returns: true if time doubled
1434 * false if max time expired
1436 bool double_dev_wait_time(DEVICE *dev)
1438 dev->wait_sec *= 2; /* double wait time */
1439 if (dev->wait_sec > dev->max_wait) { /* but not longer than maxtime */
1440 dev->wait_sec = dev->max_wait;
1443 dev->rem_wait_sec = dev->wait_sec;
1444 if (dev->num_wait >= dev->max_num_wait) {