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_block_to_device() call the fix_up
61 * routine. In addition, all threads are blocked
62 * from writing on the tape by calling lock_dev(), and thread other
63 * than the first thread to hit the EOT will block on a condition
64 * variable. The first thread to hit the EOT will continue to
65 * be able to read and write the tape (he sort of tunnels through
66 * the locking mechanism -- see lock_dev() for details).
68 * Now presumably somewhere higher in the chain of command
69 * (device.c), someone will notice the EOT condition and
70 * get a new tape up, get the tape label read, and mark
71 * the label for rewriting. Then this higher level routine
72 * will write the unwritten buffer to the new volume.
73 * Finally, he will release
74 * any blocked threads by doing a broadcast on the condition
75 * variable. At that point, we should be totally back in
76 * business with no lost data.
83 /* Forward referenced functions */
84 void set_os_device_parameters(DEVICE *dev);
87 * Allocate and initialize the DEVICE structure
88 * Note, if dev is non-NULL, it is already allocated,
89 * thus we neither allocate it nor free it. This allows
90 * the caller to put the packet in shared memory.
92 * Note, for a tape, the device->device_name is the device name
93 * (e.g. /dev/nst0), and for a file, the device name
94 * is the directory in which the file will be placed.
98 init_dev(DEVICE *dev, DEVRES *device)
105 /* Check that device is available */
106 if (stat(device->device_name, &statp) < 0) {
109 dev->dev_errno = errno;
111 Emsg2(M_FATAL, 0, "Unable to stat device %s : %s\n", device->device_name,
117 if (S_ISDIR(statp.st_mode)) {
119 } else if (S_ISCHR(statp.st_mode)) {
121 } else if (S_ISFIFO(statp.st_mode)) {
125 dev->dev_errno = ENODEV;
127 Emsg2(M_FATAL, 0, _("%s is an unknown device type. Must be tape or directory. st_mode=%x\n"),
128 device->device_name, statp.st_mode);
132 dev = (DEVICE *)get_memory(sizeof(DEVICE));
133 memset(dev, 0, sizeof(DEVICE));
134 dev->state = ST_MALLOC;
136 memset(dev, 0, sizeof(DEVICE));
139 /* Copy user supplied device parameters from Resource */
140 dev->dev_name = get_memory(strlen(device->device_name)+1);
141 strcpy(dev->dev_name, device->device_name);
142 dev->capabilities = device->cap_bits;
143 dev->min_block_size = device->min_block_size;
144 dev->max_block_size = device->max_block_size;
145 dev->max_volume_size = device->max_volume_size;
146 dev->max_file_size = device->max_file_size;
147 dev->volume_capacity = device->volume_capacity;
148 dev->max_rewind_wait = device->max_rewind_wait;
149 dev->max_open_wait = device->max_open_wait;
150 dev->max_open_vols = device->max_open_vols;
151 dev->vol_poll_interval = device->vol_poll_interval;
152 dev->max_spool_size = device->max_spool_size;
153 dev->drive_index = device->drive_index;
155 if (dev->vol_poll_interval && dev->vol_poll_interval < 60) {
156 dev->vol_poll_interval = 60;
158 dev->device = device;
161 dev->state |= ST_TAPE;
163 dev->state |= ST_FIFO;
164 dev->capabilities |= CAP_STREAM; /* set stream device */
166 dev->state |= ST_FILE;
169 if (dev->max_block_size > 1000000) {
170 Emsg3(M_ERROR, 0, _("Block size %u on device %s is too large, using default %u\n"),
171 dev->max_block_size, dev->dev_name, DEFAULT_BLOCK_SIZE);
172 dev->max_block_size = 0;
174 if (dev->max_block_size % TAPE_BSIZE != 0) {
175 Emsg2(M_WARNING, 0, _("Max block size %u not multiple of device %s block size.\n"),
176 dev->max_block_size, dev->dev_name);
179 dev->errmsg = get_pool_memory(PM_EMSG);
182 if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
184 dev->dev_errno = errstat;
185 Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
186 Emsg0(M_FATAL, 0, dev->errmsg);
188 if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
190 dev->dev_errno = errstat;
191 Mmsg1(dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), be.strerror(errstat));
192 Emsg0(M_FATAL, 0, dev->errmsg);
194 if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
196 dev->dev_errno = errstat;
197 Mmsg1(dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), be.strerror(errstat));
198 Emsg0(M_FATAL, 0, dev->errmsg);
200 if ((errstat = pthread_mutex_init(&dev->spool_mutex, NULL)) != 0) {
202 dev->dev_errno = errstat;
203 Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
204 Emsg0(M_FATAL, 0, dev->errmsg);
206 if ((errstat = rwl_init(&dev->lock)) != 0) {
208 dev->dev_errno = errstat;
209 Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
210 Emsg0(M_FATAL, 0, dev->errmsg);
214 dev->attached_dcrs = New(dlist(dcr, &dcr->dev_link));
215 Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
220 /* Open the device with the operating system and
221 * initialize buffer pointers.
223 * Note, for a tape, the VolName is the name we give to the
224 * volume (not really used here), but for a file, the
225 * VolName represents the name of the file to be created/opened.
226 * In the case of a file, the full name is the device name
227 * (archive_name) with the VolName concatenated.
230 open_dev(DEVICE *dev, char *VolName, int mode)
232 POOLMEM *archive_name;
234 if (dev->state & ST_OPENED) {
236 * *****FIXME***** how to handle two threads wanting
237 * different volumes mounted???? E.g. one is waiting
238 * for the next volume to be mounted, and a new job
239 * starts and snatches up the device.
241 if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
245 Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
246 dev->dev_name, dev->use_count);
247 Emsg1(M_WARNING, 0, "%s", dev->errmsg);
251 bstrncpy(dev->VolCatInfo.VolCatName, VolName, sizeof(dev->VolCatInfo.VolCatName));
254 Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
255 dev->dev_name, dev->VolCatInfo.VolCatName);
256 dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
257 if (dev->state & (ST_TAPE|ST_FIFO)) {
259 Dmsg0(29, "open_dev: device is tape\n");
260 if (mode == OPEN_READ_WRITE) {
261 dev->mode = O_RDWR | O_BINARY;
262 } else if (mode == OPEN_READ_ONLY) {
263 dev->mode = O_RDONLY | O_BINARY;
264 } else if (mode == OPEN_WRITE_ONLY) {
265 dev->mode = O_WRONLY | O_BINARY;
267 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
269 timeout = dev->max_open_wait;
271 if (dev->state & ST_FIFO && timeout) {
273 dev->tid = start_thread_timer(pthread_self(), timeout);
275 /* If busy retry each second for max_open_wait seconds */
276 while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
277 if (errno == EINTR || errno == EAGAIN) {
280 if (errno == EBUSY && timeout-- > 0) {
281 Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
285 dev->dev_errno = errno;
286 Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
287 dev->dev_name, strerror(dev->dev_errno));
288 /* Stop any open timer we set */
290 stop_thread_timer(dev->tid);
293 Emsg0(M_FATAL, 0, dev->errmsg);
298 dev->state |= ST_OPENED;
300 update_pos_dev(dev); /* update position */
301 set_os_device_parameters(dev); /* do system dependent stuff */
303 /* Stop any open() timer we started */
305 stop_thread_timer(dev->tid);
308 Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
311 * Handle opening of File Archive (not a tape)
313 if (VolName == NULL || *VolName == 0) {
314 Mmsg(dev->errmsg, _("Could not open file device %s. No Volume name given.\n"),
318 archive_name = get_pool_memory(PM_FNAME);
319 pm_strcpy(archive_name, dev->dev_name);
320 if (archive_name[strlen(archive_name)] != '/') {
321 pm_strcat(archive_name, "/");
323 pm_strcat(archive_name, VolName);
324 Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
325 if (mode == OPEN_READ_WRITE) {
326 dev->mode = O_CREAT | O_RDWR | O_BINARY;
327 } else if (mode == OPEN_READ_ONLY) {
328 dev->mode = O_RDONLY | O_BINARY;
329 } else if (mode == OPEN_WRITE_ONLY) {
330 dev->mode = O_WRONLY | O_BINARY;
332 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
334 /* If creating file, give 0640 permissions */
335 if ((dev->fd = open(archive_name, dev->mode, 0640)) < 0) {
336 dev->dev_errno = errno;
337 Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
338 Emsg0(M_FATAL, 0, dev->errmsg);
341 dev->state |= ST_OPENED;
343 update_pos_dev(dev); /* update position */
345 Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
346 free_pool_memory(archive_name);
353 int _rewind_dev(char *file, int line, DEVICE *dev)
355 Dmsg2(100, "rewind_dev called from %s:%d\n", file, line);
356 return rewind_dev(dev);
363 * Returns: true on success
366 bool rewind_dev(DEVICE *dev)
371 Dmsg1(29, "rewind_dev %s\n", dev->dev_name);
373 dev->dev_errno = EBADF;
374 Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
376 Emsg0(M_ABORT, 0, dev->errmsg);
379 dev->state &= ~(ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
380 dev->block_num = dev->file = 0;
382 if (dev->state & ST_TAPE) {
383 mt_com.mt_op = MTREW;
385 /* If we get an I/O error on rewind, it is probably because
386 * the drive is actually busy. We loop for (about 5 minutes)
387 * retrying every 5 seconds.
389 for (i=dev->max_rewind_wait; ; i -= 5) {
390 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
392 if (i == dev->max_rewind_wait) {
393 Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
395 clrerror_dev(dev, MTREW);
396 if (dev->dev_errno == EIO && i > 0) {
397 Dmsg0(200, "Sleeping 5 seconds.\n");
401 Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
402 dev->dev_name, be.strerror(dev->dev_errno));
407 } else if (dev->state & ST_FILE) {
408 if (lseek(dev->fd, (off_t)0, SEEK_SET) < 0) {
410 dev->dev_errno = errno;
411 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
412 dev->dev_name, be.strerror(dev->dev_errno));
420 * Position device to end of medium (end of data)
421 * Returns: 1 on succes
428 struct mtget mt_stat;
432 Dmsg0(29, "eod_dev\n");
433 if (dev->state & ST_EOT) {
436 dev->state &= ~(ST_EOF); /* remove EOF flags */
437 dev->block_num = dev->file = 0;
439 if (dev->state & (ST_FIFO | ST_PROG)) {
442 if (!(dev->state & ST_TAPE)) {
443 pos = lseek(dev->fd, (off_t)0, SEEK_END);
444 // Dmsg1(100, "====== Seek to %lld\n", pos);
447 dev->state |= ST_EOT;
450 dev->dev_errno = errno;
452 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
453 dev->dev_name, be.strerror(dev->dev_errno));
458 if (dev_cap(dev, CAP_FASTFSF) && !dev_cap(dev, CAP_EOM)) {
459 struct mtget mt_stat;
460 Dmsg0(100,"Using FAST FSF for EOM\n");
461 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno <= 0) {
462 if (!rewind_dev(dev)) {
466 mt_com.mt_op = MTFSF;
468 * ***FIXEM*** fix code to handle case that INT16_MAX is
471 mt_com.mt_count = INT16_MAX; /* use big positive number */
472 if (mt_com.mt_count < 0) {
473 mt_com.mt_count = INT16_MAX; /* brain damaged system */
477 if (dev_cap(dev, CAP_EOM)) {
478 Dmsg0(100,"Using EOM for EOM\n");
479 mt_com.mt_op = MTEOM;
482 if (dev_cap(dev, CAP_FASTFSF) || dev_cap(dev, CAP_EOM)) {
483 if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
485 clrerror_dev(dev, mt_com.mt_op);
486 Dmsg1(50, "ioctl error: %s\n", be.strerror(dev->dev_errno));
488 Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
489 dev->dev_name, be.strerror(dev->dev_errno));
493 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
495 clrerror_dev(dev, -1);
496 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
497 dev->dev_name, be.strerror(dev->dev_errno));
500 Dmsg2(100, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
501 dev->file = mt_stat.mt_fileno;
504 * Rewind then use FSF until EOT reached
510 if (!rewind_dev(dev)) {
514 * Move file by file to the end of the tape
517 for (file_num=dev->file; !(dev->state & ST_EOT); file_num++) {
518 Dmsg0(200, "eod_dev: doing fsf 1\n");
519 if (!fsf_dev(dev, 1)) {
520 Dmsg0(200, "fsf_dev error.\n");
524 * Avoid infinite loop. ***FIXME*** possibly add code
525 * to set EOD or to turn off CAP_FASTFSF if on.
527 if (file_num == (int)dev->file) {
528 struct mtget mt_stat;
529 Dmsg1(100, "fsf_dev did not advance from file %d\n", file_num);
530 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 &&
531 mt_stat.mt_fileno >= 0) {
532 Dmsg2(100, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
533 dev->file = mt_stat.mt_fileno;
536 break; /* we are not progressing, bail out */
541 * Some drivers leave us after second EOF when doing
542 * MTEOM, so we must backup so that appending overwrites
545 if (dev_cap(dev, CAP_BSFATEOM)) {
546 struct mtget mt_stat;
547 /* Backup over EOF */
548 stat = bsf_dev(dev, 1);
549 /* If BSF worked and fileno is known (not -1), set file */
550 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
551 Dmsg2(100, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
552 dev->file = mt_stat.mt_fileno;
554 dev->file++; /* wing it -- not correct on all OSes */
557 update_pos_dev(dev); /* update position */
560 Dmsg1(200, "EOD dev->file=%d\n", dev->file);
565 * Set the position of the device -- only for files
566 * For other devices, there is no generic way to do it.
567 * Returns: true on succes
570 bool update_pos_dev(DEVICE *dev)
576 dev->dev_errno = EBADF;
577 Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
578 Emsg0(M_FATAL, 0, dev->errmsg);
582 /* Find out where we are */
583 if (dev->state & ST_FILE) {
586 pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
588 Pmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
589 dev->dev_errno = errno;
590 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
591 dev->dev_name, strerror(dev->dev_errno));
594 dev->file_addr = pos;
602 * Return the status of the device. This was meant
603 * to be a generic routine. Unfortunately, it doesn't
604 * seem possible (at least I do not know how to do it
605 * currently), which means that for the moment, this
606 * routine has very little value.
610 uint32_t status_dev(DEVICE *dev)
612 struct mtget mt_stat;
615 if (dev->state & (ST_EOT | ST_WEOT)) {
619 if (dev->state & ST_EOF) {
623 if (dev->state & ST_TAPE) {
625 Dmsg0(-20," Bacula status:");
626 Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
627 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
629 dev->dev_errno = errno;
630 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
631 dev->dev_name, be.strerror(dev->dev_errno));
634 Dmsg0(-20, " Device status:");
636 #if defined(HAVE_LINUX_OS)
637 if (GMT_EOF(mt_stat.mt_gstat)) {
641 if (GMT_BOT(mt_stat.mt_gstat)) {
645 if (GMT_EOT(mt_stat.mt_gstat)) {
649 if (GMT_SM(mt_stat.mt_gstat)) {
653 if (GMT_EOD(mt_stat.mt_gstat)) {
657 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
659 Dmsg0(-20, " WR_PROT");
661 if (GMT_ONLINE(mt_stat.mt_gstat)) {
663 Dmsg0(-20, " ONLINE");
665 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
667 Dmsg0(-20, " DR_OPEN");
669 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
670 stat |= BMT_IM_REP_EN;
671 Dmsg0(-20, " IM_REP_EN");
673 #endif /* !SunOS && !OSF */
674 Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
676 stat |= BMT_ONLINE | BMT_BOT;
683 * Load medium in device
684 * Returns: true on success
687 bool load_dev(DEVICE *dev)
694 dev->dev_errno = EBADF;
695 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
696 Emsg0(M_FATAL, 0, dev->errmsg);
699 if (!(dev->state & ST_TAPE)) {
703 Dmsg0(200, "stored: MTLOAD command not available\n");
705 dev->dev_errno = ENOTTY; /* function not available */
706 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
707 dev->dev_name, be.strerror(dev->dev_errno)); return 0;
711 dev->block_num = dev->file = 0;
713 mt_com.mt_op = MTLOAD;
715 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
717 dev->dev_errno = errno;
718 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
719 dev->dev_name, be.strerror(dev->dev_errno)); return 0;
727 * Rewind device and put it offline
728 * Returns: true on success
731 bool offline_dev(DEVICE *dev)
736 dev->dev_errno = EBADF;
737 Mmsg0(&dev->errmsg, _("Bad call to offline_dev. Archive not open\n"));
738 Emsg0(M_FATAL, 0, dev->errmsg);
741 if (!(dev->state & ST_TAPE)) {
745 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
746 dev->block_num = dev->file = 0;
749 mt_com.mt_op = MTUNLOCK;
751 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
753 mt_com.mt_op = MTOFFL;
755 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
757 dev->dev_errno = errno;
758 Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
759 dev->dev_name, be.strerror(dev->dev_errno));
762 Dmsg1(100, "Offlined device %s\n", dev->dev_name);
766 int offline_or_rewind_dev(DEVICE *dev)
768 if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
769 return offline_dev(dev);
772 * Note, this rewind probably should not be here (it wasn't
773 * in prior versions of Bacula), but on FreeBSD, this is
774 * needed in the case the tape was "frozen" due to an error
775 * such as backspacing after writing and EOF. If it is not
776 * done, all future references to the drive get and I/O error.
778 clrerror_dev(dev, MTREW);
779 return rewind_dev(dev);
784 * Foward space a file
785 * Returns: true on success
789 fsf_dev(DEVICE *dev, int num)
791 struct mtget mt_stat;
796 dev->dev_errno = EBADF;
797 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
798 Emsg0(M_FATAL, 0, dev->errmsg);
802 if (!(dev->state & ST_TAPE)) {
805 if (dev->state & ST_EOT) {
807 Mmsg1(dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
810 if (dev->state & ST_EOF) {
811 Dmsg0(200, "ST_EOF set on entry to FSF\n");
814 Dmsg0(29, "fsf_dev\n");
817 * If Fast forward space file is set, then we
818 * use MTFSF to forward space and MTIOCGET
819 * to get the file position. We assume that
820 * the SCSI driver will ensure that we do not
821 * forward space over the end of data mark.
823 if (dev_cap(dev, CAP_FSF) && dev_cap(dev, CAP_FASTFSF)) {
824 mt_com.mt_op = MTFSF;
825 mt_com.mt_count = num;
826 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
827 if (stat < 0 || ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
829 dev->state |= ST_EOT;
830 Dmsg0(200, "Set ST_EOT\n");
831 clrerror_dev(dev, MTFSF);
832 Mmsg2(dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
833 dev->dev_name, be.strerror());
834 Dmsg1(200, "%s", dev->errmsg);
837 Dmsg2(200, "fsf file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
838 dev->file = mt_stat.mt_fileno;
839 dev->state |= ST_EOF; /* just read EOF */
844 * Here if CAP_FSF is set, and virtually all drives
845 * these days support it, we read a record, then forward
846 * space one file. Using this procedure, which is slow,
847 * is the only way we can be sure that we don't read
848 * two consecutive EOF marks, which means End of Data.
850 } else if (dev_cap(dev, CAP_FSF)) {
853 Dmsg0(200, "FSF has cap_fsf\n");
854 if (dev->max_block_size == 0) {
855 rbuf_len = DEFAULT_BLOCK_SIZE;
857 rbuf_len = dev->max_block_size;
859 rbuf = get_memory(rbuf_len);
860 mt_com.mt_op = MTFSF;
862 while (num-- && !(dev->state & ST_EOT)) {
863 Dmsg0(200, "Doing read before fsf\n");
864 if ((stat = read(dev->fd, (char *)rbuf, rbuf_len)) < 0) {
865 if (errno == ENOMEM) { /* tape record exceeds buf len */
866 stat = rbuf_len; /* This is OK */
869 dev->state |= ST_EOT;
870 clrerror_dev(dev, -1);
871 Dmsg2(200, "Set ST_EOT read errno=%d. ERR=%s\n", dev->dev_errno,
873 Mmsg2(dev->errmsg, _("read error on %s. ERR=%s.\n"),
874 dev->dev_name, be.strerror(dev->dev_errno));
875 Dmsg1(200, "%s", dev->errmsg);
879 if (stat == 0) { /* EOF */
881 Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
882 /* Two reads of zero means end of tape */
883 if (dev->state & ST_EOF) {
884 dev->state |= ST_EOT;
885 Dmsg0(200, "Set ST_EOT\n");
888 dev->state |= ST_EOF;
893 } else { /* Got data */
894 dev->state &= ~(ST_EOF|ST_EOT);
897 Dmsg0(200, "Doing MTFSF\n");
898 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
899 if (stat < 0) { /* error => EOT */
901 dev->state |= ST_EOT;
902 Dmsg0(200, "Set ST_EOT\n");
903 clrerror_dev(dev, MTFSF);
904 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
905 dev->dev_name, be.strerror(dev->dev_errno));
906 Dmsg0(200, "Got < 0 for MTFSF\n");
907 Dmsg1(200, "%s", dev->errmsg);
909 dev->state |= ST_EOF; /* just read EOF */
917 * No FSF, so use FSR to simulate it
920 Dmsg0(200, "Doing FSR for FSF\n");
921 while (num-- && !(dev->state & ST_EOT)) {
922 fsr_dev(dev, INT32_MAX); /* returns -1 on EOF or EOT */
924 if (dev->state & ST_EOT) {
926 Mmsg1(dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
933 Dmsg1(200, "Return %d from FSF\n", stat);
934 if (dev->state & ST_EOF)
935 Dmsg0(200, "ST_EOF set on exit FSF\n");
936 if (dev->state & ST_EOT)
937 Dmsg0(200, "ST_EOT set on exit FSF\n");
938 Dmsg1(200, "Return from FSF file=%d\n", dev->file);
943 * Backward space a file
944 * Returns: false on failure
948 bsf_dev(DEVICE *dev, int num)
954 dev->dev_errno = EBADF;
955 Mmsg0(dev->errmsg, _("Bad call to bsf_dev. Archive device not open\n"));
956 Emsg0(M_FATAL, 0, dev->errmsg);
960 if (!(dev_state(dev, ST_TAPE))) {
961 Mmsg1(dev->errmsg, _("Device %s cannot BSF because it is not a tape.\n"),
965 Dmsg0(29, "bsf_dev\n");
966 dev->state &= ~(ST_EOT|ST_EOF);
969 mt_com.mt_op = MTBSF;
970 mt_com.mt_count = num;
971 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
974 clrerror_dev(dev, MTBSF);
975 Mmsg2(dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
976 dev->dev_name, be.strerror(dev->dev_errno));
984 * Foward space a record
985 * Returns: false on failure
989 fsr_dev(DEVICE *dev, int num)
995 dev->dev_errno = EBADF;
996 Mmsg0(dev->errmsg, _("Bad call to fsr_dev. Archive not open\n"));
997 Emsg0(M_FATAL, 0, dev->errmsg);
1001 if (!(dev_state(dev, ST_TAPE))) {
1004 if (!dev_cap(dev, CAP_FSR)) {
1005 Mmsg1(dev->errmsg, _("ioctl MTFSR not permitted on %s.\n"), dev->dev_name);
1009 Dmsg1(29, "fsr_dev %d\n", num);
1010 mt_com.mt_op = MTFSR;
1011 mt_com.mt_count = num;
1012 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1014 dev->state &= ~ST_EOF;
1015 dev->block_num += num;
1018 struct mtget mt_stat;
1019 clrerror_dev(dev, MTFSR);
1020 Dmsg1(100, "FSF fail: ERR=%s\n", be.strerror());
1021 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
1022 Dmsg4(100, "Adjust from %d:%d to %d:%d\n", dev->file,
1023 dev->block_num, mt_stat.mt_fileno, mt_stat.mt_blkno);
1024 dev->file = mt_stat.mt_fileno;
1025 dev->block_num = mt_stat.mt_blkno;
1027 if (dev->state & ST_EOF) {
1028 dev->state |= ST_EOT;
1030 dev->state |= ST_EOF; /* assume EOF */
1036 Mmsg2(dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
1037 dev->dev_name, be.strerror(dev->dev_errno));
1039 update_pos_dev(dev);
1044 * Backward space a record
1045 * Returns: false on failure
1049 bsr_dev(DEVICE *dev, int num)
1055 dev->dev_errno = EBADF;
1056 Mmsg0(dev->errmsg, _("Bad call to bsr_dev. Archive not open\n"));
1057 Emsg0(M_FATAL, 0, dev->errmsg);
1061 if (!(dev->state & ST_TAPE)) {
1065 if (!dev_cap(dev, CAP_BSR)) {
1066 Mmsg1(dev->errmsg, _("ioctl MTBSR not permitted on %s.\n"), dev->dev_name);
1070 Dmsg0(29, "bsr_dev\n");
1071 dev->block_num -= num;
1072 dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
1073 mt_com.mt_op = MTBSR;
1074 mt_com.mt_count = num;
1075 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1078 clrerror_dev(dev, MTBSR);
1079 Mmsg2(dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
1080 dev->dev_name, be.strerror(dev->dev_errno));
1082 update_pos_dev(dev);
1087 * Reposition the device to file, block
1088 * Returns: false on failure
1092 reposition_dev(DEVICE *dev, uint32_t file, uint32_t block)
1095 dev->dev_errno = EBADF;
1096 Mmsg0(dev->errmsg, _("Bad call to reposition_dev. Archive not open\n"));
1097 Emsg0(M_FATAL, 0, dev->errmsg);
1101 if (!(dev_state(dev, ST_TAPE))) {
1102 off_t pos = (((off_t)file)<<32) + block;
1103 Dmsg1(100, "===== lseek to %d\n", (int)pos);
1104 if (lseek(dev->fd, pos, SEEK_SET) == (off_t)-1) {
1105 dev->dev_errno = errno;
1106 Mmsg2(dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
1107 dev->dev_name, strerror(dev->dev_errno));
1111 dev->block_num = block;
1112 dev->file_addr = pos;
1115 Dmsg4(100, "reposition_dev from %u:%u to %u:%u\n",
1116 dev->file, dev->block_num, file, block);
1117 if (file < dev->file) {
1118 Dmsg0(100, "Rewind_dev\n");
1119 if (!rewind_dev(dev)) {
1123 if (file > dev->file) {
1124 Dmsg1(100, "fsf %d\n", file-dev->file);
1125 if (!fsf_dev(dev, file-dev->file)) {
1129 if (block < dev->block_num) {
1133 if (dev_cap(dev, CAP_POSITIONBLOCKS) && block > dev->block_num) {
1134 /* Ignore errors as Bacula can read to the correct block */
1135 Dmsg1(100, "fsr %d\n", block-dev->block_num);
1136 return fsr_dev(dev, block-dev->block_num);
1144 * Write an end of file on the device
1145 * Returns: 0 on success
1146 * non-zero on failure
1149 weof_dev(DEVICE *dev, int num)
1155 dev->dev_errno = EBADF;
1156 Mmsg0(dev->errmsg, _("Bad call to weof_dev. Archive drive not open\n"));
1157 Emsg0(M_FATAL, 0, dev->errmsg);
1161 if (!(dev_state(dev, ST_TAPE))) {
1164 dev->state &= ~(ST_EOT | ST_EOF); /* remove EOF/EOT flags */
1165 Dmsg0(29, "weof_dev\n");
1166 mt_com.mt_op = MTWEOF;
1167 mt_com.mt_count = num;
1168 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1175 clrerror_dev(dev, MTWEOF);
1177 Mmsg2(dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
1178 dev->dev_name, be.strerror());
1185 * Return string message with last error in English
1186 * Be careful not to call this routine from within dev.c
1187 * while editing an Mmsg() or you will end up in a recursive
1188 * loop creating a Segmentation Violation.
1191 strerror_dev(DEVICE *dev)
1198 * If implemented in system, clear the tape
1202 clrerror_dev(DEVICE *dev, int func)
1204 const char *msg = NULL;
1205 struct mtget mt_stat;
1207 dev->dev_errno = errno; /* save errno */
1209 dev->VolCatInfo.VolCatErrors++;
1212 if (!(dev->state & ST_TAPE)) {
1215 if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
1218 Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
1222 dev->capabilities &= ~CAP_EOF; /* turn off feature */
1227 dev->capabilities &= ~CAP_EOM; /* turn off feature */
1232 dev->capabilities &= ~CAP_FSF; /* turn off feature */
1236 dev->capabilities &= ~CAP_BSF; /* turn off feature */
1240 dev->capabilities &= ~CAP_FSR; /* turn off feature */
1244 dev->capabilities &= ~CAP_BSR; /* turn off feature */
1251 dev->dev_errno = ENOSYS;
1252 Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
1253 Emsg0(M_ERROR, 0, dev->errmsg);
1256 /* On some systems such as NetBSD, this clears all errors */
1257 ioctl(dev->fd, MTIOCGET, (char *)&mt_stat);
1259 /* Found on Linux */
1263 mt_com.mt_op = MTIOCLRERR;
1264 mt_com.mt_count = 1;
1265 /* Clear any error condition on the tape */
1266 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1267 Dmsg0(200, "Did MTIOCLRERR\n");
1271 /* Typically on FreeBSD */
1274 /* Read and clear SCSI error status */
1275 union mterrstat mt_errstat;
1276 Dmsg2(200, "Doing MTIOCERRSTAT errno=%d ERR=%s\n", dev->dev_errno,
1277 strerror(dev->dev_errno));
1278 ioctl(dev->fd, MTIOCERRSTAT, (char *)&mt_errstat);
1282 /* Clear Subsystem Exception OSF1 */
1286 mt_com.mt_op = MTCSE;
1287 mt_com.mt_count = 1;
1288 /* Clear any error condition on the tape */
1289 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1290 Dmsg0(200, "Did MTCSE\n");
1296 * Flush buffer contents
1299 int flush_dev(DEVICE *dev)
1304 static void do_close(DEVICE *dev)
1307 Dmsg1(29, "really close_dev %s\n", dev->dev_name);
1311 /* Clean up device packet so it can be reused */
1313 dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1314 dev->file = dev->block_num = 0;
1316 dev->EndFile = dev->EndBlock = 0;
1317 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1318 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1320 stop_thread_timer(dev->tid);
1330 close_dev(DEVICE *dev)
1333 Mmsg0(&dev->errmsg, _("Bad call to close_dev. Archive not open\n"));
1334 Emsg0(M_FATAL, 0, dev->errmsg);
1337 if (dev->fd >= 0 && dev->use_count == 1) {
1339 } else if (dev->use_count > 0) {
1344 ASSERT(dev->use_count >= 0);
1349 * Used when unmounting the device, ignore use_count
1351 void force_close_dev(DEVICE *dev)
1354 Mmsg0(&dev->errmsg, _("Bad call to force_close_dev. Archive not open\n"));
1355 Emsg0(M_FATAL, 0, dev->errmsg);
1358 Dmsg1(29, "Force close_dev %s\n", dev->dev_name);
1362 ASSERT(dev->use_count >= 0);
1366 bool truncate_dev(DEVICE *dev)
1368 if (dev->state & ST_TAPE) {
1369 return true; /* we don't really truncate tapes */
1370 /* maybe we should rewind and write and eof ???? */
1372 if (ftruncate(dev->fd, 0) != 0) {
1373 Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1380 dev_is_tape(DEVICE *dev)
1382 return (dev->state & ST_TAPE) ? true : false;
1387 * return 1 if the device is read for write, and 0 otherwise
1388 * This is meant for checking at the end of a job to see
1389 * if we still have a tape (perhaps not if at end of tape
1390 * and the job is canceled).
1393 dev_can_write(DEVICE *dev)
1395 if ((dev->state & ST_OPENED) && (dev->state & ST_APPEND) &&
1396 (dev->state & ST_LABEL) && !(dev->state & ST_WEOT)) {
1404 dev_name(DEVICE *dev)
1406 return dev->dev_name;
1410 dev_vol_name(DEVICE *dev)
1412 return dev->VolCatInfo.VolCatName;
1415 uint32_t dev_block(DEVICE *dev)
1417 update_pos_dev(dev);
1418 return dev->block_num;
1421 uint32_t dev_file(DEVICE *dev)
1423 update_pos_dev(dev);
1428 * Free memory allocated for the device
1431 term_dev(DEVICE *dev)
1434 dev->dev_errno = EBADF;
1435 Mmsg0(&dev->errmsg, _("Bad call to term_dev. Archive not open\n"));
1436 Emsg0(M_FATAL, 0, dev->errmsg);
1440 Dmsg0(29, "term_dev\n");
1441 if (dev->dev_name) {
1442 free_memory(dev->dev_name);
1443 dev->dev_name = NULL;
1446 free_pool_memory(dev->errmsg);
1449 pthread_mutex_destroy(&dev->mutex);
1450 pthread_cond_destroy(&dev->wait);
1451 pthread_cond_destroy(&dev->wait_next_vol);
1452 pthread_mutex_destroy(&dev->spool_mutex);
1453 rwl_destroy(&dev->lock);
1454 if (dev->attached_dcrs) {
1455 delete dev->attached_dcrs;
1456 dev->attached_dcrs = NULL;
1458 if (dev->state & ST_MALLOC) {
1459 free_pool_memory((POOLMEM *)dev);
1464 * This routine initializes the device wait timers
1466 void init_dev_wait_timers(DEVICE *dev)
1468 /* ******FIXME******* put these on config variables */
1469 dev->min_wait = 60 * 60;
1470 dev->max_wait = 24 * 60 * 60;
1471 dev->max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
1472 dev->wait_sec = dev->min_wait;
1473 dev->rem_wait_sec = dev->wait_sec;
1476 dev->BadVolName[0] = 0;
1480 * Returns: true if time doubled
1481 * false if max time expired
1483 bool double_dev_wait_time(DEVICE *dev)
1485 dev->wait_sec *= 2; /* double wait time */
1486 if (dev->wait_sec > dev->max_wait) { /* but not longer than maxtime */
1487 dev->wait_sec = dev->max_wait;
1490 dev->rem_wait_sec = dev->wait_sec;
1491 if (dev->num_wait >= dev->max_num_wait) {
1497 void set_os_device_parameters(DEVICE *dev)
1499 #ifdef HAVE_LINUX_OS
1501 if (dev->min_block_size == dev->max_block_size &&
1502 dev->min_block_size == 0) { /* variable block mode */
1503 mt_com.mt_op = MTSETBLK;
1504 mt_com.mt_count = 0;
1505 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1506 clrerror_dev(dev, MTSETBLK);
1508 mt_com.mt_op = MTSETDRVBUFFER;
1509 mt_com.mt_count = MT_ST_CLEARBOOLEANS;
1510 if (!dev_cap(dev, CAP_TWOEOF)) {
1511 mt_com.mt_count |= MT_ST_TWO_FM;
1513 if (dev_cap(dev, CAP_EOM)) {
1514 mt_com.mt_count |= MT_ST_FAST_MTEOM;
1516 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1517 clrerror_dev(dev, MTSETBLK);
1523 #ifdef HAVE_NETBSD_OS
1525 if (dev->min_block_size == dev->max_block_size &&
1526 dev->min_block_size == 0) { /* variable block mode */
1527 mt_com.mt_op = MTSETBSIZ;
1528 mt_com.mt_count = 0;
1529 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1530 clrerror_dev(dev, MTSETBSIZ);
1532 /* Get notified at logical end of tape */
1533 mt_com.mt_op = MTEWARN;
1534 mt_com.mt_count = 1;
1535 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1536 clrerror_dev(dev, MTEWARN);
1542 #if HAVE_FREEBSD_OS || HAVE_OPENBSD_OS
1544 if (dev->min_block_size == dev->max_block_size &&
1545 dev->min_block_size == 0) { /* variable block mode */
1546 mt_com.mt_op = MTSETBSIZ;
1547 mt_com.mt_count = 0;
1548 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1549 clrerror_dev(dev, MTSETBSIZ);
1557 if (dev->min_block_size == dev->max_block_size &&
1558 dev->min_block_size == 0) { /* variable block mode */
1559 mt_com.mt_op = MTSRSZ;
1560 mt_com.mt_count = 0;
1561 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1562 clrerror_dev(dev, MTSRSZ);