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 */
86 * Allocate and initialize the DEVICE structure
87 * Note, if dev is non-NULL, it is already allocated,
88 * thus we neither allocate it nor free it. This allows
89 * the caller to put the packet in shared memory.
91 * Note, for a tape, the device->device_name is the device name
92 * (e.g. /dev/nst0), and for a file, the device name
93 * is the directory in which the file will be placed.
97 init_dev(DEVICE *dev, DEVRES *device)
104 /* Check that device is available */
105 if (stat(device->device_name, &statp) < 0) {
107 dev->dev_errno = errno;
109 Emsg2(M_FATAL, 0, "Unable to stat device %s : %s\n", device->device_name,
115 if (S_ISDIR(statp.st_mode)) {
117 } else if (S_ISCHR(statp.st_mode)) {
119 } else if (S_ISFIFO(statp.st_mode)) {
123 dev->dev_errno = ENODEV;
125 Emsg2(M_FATAL, 0, _("%s is an unknown device type. Must be tape or directory. st_mode=%x\n"),
126 device->device_name, statp.st_mode);
130 dev = (DEVICE *)get_memory(sizeof(DEVICE));
131 memset(dev, 0, sizeof(DEVICE));
132 dev->state = ST_MALLOC;
134 memset(dev, 0, sizeof(DEVICE));
137 /* Copy user supplied device parameters from Resource */
138 dev->dev_name = get_memory(strlen(device->device_name)+1);
139 strcpy(dev->dev_name, device->device_name);
140 dev->capabilities = device->cap_bits;
141 dev->min_block_size = device->min_block_size;
142 dev->max_block_size = device->max_block_size;
143 dev->max_volume_size = device->max_volume_size;
144 dev->max_file_size = device->max_file_size;
145 dev->volume_capacity = device->volume_capacity;
146 dev->max_rewind_wait = device->max_rewind_wait;
147 dev->max_open_wait = device->max_open_wait;
148 dev->max_open_vols = device->max_open_vols;
149 dev->vol_poll_interval = device->vol_poll_interval;
150 dev->max_spool_size = device->max_spool_size;
151 dev->drive_index = device->drive_index;
153 if (dev->vol_poll_interval && dev->vol_poll_interval < 60) {
154 dev->vol_poll_interval = 60;
156 dev->device = device;
159 dev->state |= ST_TAPE;
161 dev->state |= ST_FIFO;
162 dev->capabilities |= CAP_STREAM; /* set stream device */
164 dev->state |= ST_FILE;
167 if (dev->max_block_size > 1000000) {
168 Emsg3(M_ERROR, 0, _("Block size %u on device %s is too large, using default %u\n"),
169 dev->max_block_size, dev->dev_name, DEFAULT_BLOCK_SIZE);
170 dev->max_block_size = 0;
172 if (dev->max_block_size % TAPE_BSIZE != 0) {
173 Emsg2(M_WARNING, 0, _("Max block size %u not multiple of device %s block size.\n"),
174 dev->max_block_size, dev->dev_name);
177 dev->errmsg = get_pool_memory(PM_EMSG);
180 if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
181 dev->dev_errno = errstat;
182 Mmsg1(&dev->errmsg, _("Unable to init mutex: ERR=%s\n"), strerror(errstat));
183 Emsg0(M_FATAL, 0, dev->errmsg);
185 if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
186 dev->dev_errno = errstat;
187 Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
188 Emsg0(M_FATAL, 0, dev->errmsg);
190 if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
191 dev->dev_errno = errstat;
192 Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
193 Emsg0(M_FATAL, 0, dev->errmsg);
195 if ((errstat = pthread_mutex_init(&dev->spool_mutex, NULL)) != 0) {
196 dev->dev_errno = errstat;
197 Mmsg1(&dev->errmsg, _("Unable to init mutex: ERR=%s\n"), strerror(errstat));
198 Emsg0(M_FATAL, 0, dev->errmsg);
200 if ((errstat = rwl_init(&dev->lock)) != 0) {
201 dev->dev_errno = errstat;
202 Mmsg1(&dev->errmsg, _("Unable to init mutex: ERR=%s\n"), strerror(errstat));
203 Emsg0(M_FATAL, 0, dev->errmsg);
207 dev->attached_dcrs = new dlist(dcr, &dcr->dev_link);
208 Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
213 /* Open the device with the operating system and
214 * initialize buffer pointers.
216 * Note, for a tape, the VolName is the name we give to the
217 * volume (not really used here), but for a file, the
218 * VolName represents the name of the file to be created/opened.
219 * In the case of a file, the full name is the device name
220 * (archive_name) with the VolName concatenated.
223 open_dev(DEVICE *dev, char *VolName, int mode)
225 POOLMEM *archive_name;
227 if (dev->state & ST_OPENED) {
229 * *****FIXME***** how to handle two threads wanting
230 * different volumes mounted???? E.g. one is waiting
231 * for the next volume to be mounted, and a new job
232 * starts and snatches up the device.
234 if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
238 Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
239 dev->dev_name, dev->use_count);
240 Emsg1(M_WARNING, 0, "%s", dev->errmsg);
244 bstrncpy(dev->VolCatInfo.VolCatName, VolName, sizeof(dev->VolCatInfo.VolCatName));
247 Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
248 dev->dev_name, dev->VolCatInfo.VolCatName);
249 dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
250 if (dev->state & (ST_TAPE|ST_FIFO)) {
252 Dmsg0(29, "open_dev: device is tape\n");
253 if (mode == OPEN_READ_WRITE) {
254 dev->mode = O_RDWR | O_BINARY;
255 } else if (mode == OPEN_READ_ONLY) {
256 dev->mode = O_RDONLY | O_BINARY;
257 } else if (mode == OPEN_WRITE_ONLY) {
258 dev->mode = O_WRONLY | O_BINARY;
260 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
262 timeout = dev->max_open_wait;
264 if (dev->state & ST_FIFO && timeout) {
266 dev->tid = start_thread_timer(pthread_self(), timeout);
268 /* If busy retry each second for max_open_wait seconds */
269 while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
270 if (errno == EINTR || errno == EAGAIN) {
273 if (errno == EBUSY && timeout-- > 0) {
274 Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
278 dev->dev_errno = errno;
279 Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
280 dev->dev_name, strerror(dev->dev_errno));
281 /* Stop any open timer we set */
283 stop_thread_timer(dev->tid);
286 Emsg0(M_FATAL, 0, dev->errmsg);
291 dev->state |= ST_OPENED;
293 update_pos_dev(dev); /* update position */
295 /* Stop any open() timer we started */
297 stop_thread_timer(dev->tid);
300 Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
303 * Handle opening of File Archive (not a tape)
305 if (VolName == NULL || *VolName == 0) {
306 Mmsg(&dev->errmsg, _("Could not open file device %s. No Volume name given.\n"),
310 archive_name = get_pool_memory(PM_FNAME);
311 pm_strcpy(&archive_name, dev->dev_name);
312 if (archive_name[strlen(archive_name)] != '/') {
313 pm_strcat(&archive_name, "/");
315 pm_strcat(&archive_name, VolName);
316 Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
317 if (mode == OPEN_READ_WRITE) {
318 dev->mode = O_CREAT | O_RDWR | O_BINARY;
319 } else if (mode == OPEN_READ_ONLY) {
320 dev->mode = O_RDONLY | O_BINARY;
321 } else if (mode == OPEN_WRITE_ONLY) {
322 dev->mode = O_WRONLY | O_BINARY;
324 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
326 /* If creating file, give 0640 permissions */
327 if ((dev->fd = open(archive_name, dev->mode, 0640)) < 0) {
328 dev->dev_errno = errno;
329 Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
330 Emsg0(M_FATAL, 0, dev->errmsg);
333 dev->state |= ST_OPENED;
335 update_pos_dev(dev); /* update position */
337 Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
338 free_pool_memory(archive_name);
345 int _rewind_dev(char *file, int line, DEVICE *dev)
347 Dmsg2(100, "rewind_dev called from %s:%d\n", file, line);
348 return rewind_dev(dev);
355 * Returns: 1 on success
358 int rewind_dev(DEVICE *dev)
363 Dmsg1(29, "rewind_dev %s\n", dev->dev_name);
365 dev->dev_errno = EBADF;
366 Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
368 Emsg0(M_FATAL, 0, dev->errmsg);
371 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
372 dev->block_num = dev->file = 0;
374 if (dev->state & ST_TAPE) {
375 mt_com.mt_op = MTREW;
377 /* If we get an I/O error on rewind, it is probably because
378 * the drive is actually busy. We loop for (about 5 minutes)
379 * retrying every 5 seconds.
381 for (i=dev->max_rewind_wait; ; i -= 5) {
382 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
383 if (i == dev->max_rewind_wait) {
384 Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
386 clrerror_dev(dev, MTREW);
387 if (dev->dev_errno == EIO && i > 0) {
388 Dmsg0(200, "Sleeping 5 seconds.\n");
392 Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
393 dev->dev_name, strerror(dev->dev_errno));
398 } else if (dev->state & ST_FILE) {
399 if (lseek(dev->fd, (off_t)0, SEEK_SET) < 0) {
400 dev->dev_errno = errno;
401 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
402 dev->dev_name, strerror(dev->dev_errno));
410 * Position device to end of medium (end of data)
411 * Returns: 1 on succes
418 struct mtget mt_stat;
422 Dmsg0(29, "eod_dev\n");
423 if (dev->state & ST_EOT) {
426 dev->state &= ~(ST_EOF); /* remove EOF flags */
427 dev->block_num = dev->file = 0;
429 if (dev->state & (ST_FIFO | ST_PROG)) {
432 if (!(dev->state & ST_TAPE)) {
433 pos = lseek(dev->fd, (off_t)0, SEEK_END);
434 // Dmsg1(100, "====== Seek to %lld\n", pos);
437 dev->state |= ST_EOT;
440 dev->dev_errno = errno;
441 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
442 dev->dev_name, strerror(dev->dev_errno));
447 if (dev_cap(dev, CAP_FASTFSF) && !dev_cap(dev, CAP_EOM)) {
448 struct mtget mt_stat;
449 Dmsg0(100,"Using FAST FSF for EOM\n");
450 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno <= 0) {
451 if (!rewind_dev(dev)) {
455 mt_com.mt_op = MTFSF;
457 * ***FIXEM*** fix code to handle case that INT16_MAX is
460 mt_com.mt_count = INT16_MAX; /* use big positive number */
461 if (mt_com.mt_count < 0) {
462 mt_com.mt_count = INT16_MAX; /* brain damaged system */
466 if (dev_cap(dev, CAP_EOM)) {
467 Dmsg0(100,"Using EOM for EOM\n");
468 mt_com.mt_op = MTEOM;
471 if (dev_cap(dev, CAP_FASTFSF) || dev_cap(dev, CAP_EOM)) {
472 if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
473 Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
474 clrerror_dev(dev, mt_com.mt_op);
476 Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
477 dev->dev_name, strerror(dev->dev_errno));
481 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
482 dev->dev_errno = errno;
483 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
484 dev->dev_name, strerror(dev->dev_errno));
487 Dmsg2(100, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
488 dev->file = mt_stat.mt_fileno;
491 * Rewind then use FSF until EOT reached
497 if (!rewind_dev(dev)) {
501 * Move file by file to the end of the tape
504 for (file_num=dev->file; !(dev->state & ST_EOT); file_num++) {
505 Dmsg0(200, "eod_dev: doing fsf 1\n");
506 if (!fsf_dev(dev, 1)) {
507 Dmsg0(200, "fsf_dev error.\n");
511 * Avoid infinite loop. ***FIXME*** possibly add code
512 * to set EOD or to turn off CAP_FASTFSF if on.
514 if (file_num == (int)dev->file) {
515 struct mtget mt_stat;
516 Dmsg1(100, "fsf_dev did not advance from file %d\n", file_num);
517 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 &&
518 mt_stat.mt_fileno >= 0) {
519 Dmsg2(000, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
520 dev->file = mt_stat.mt_fileno;
523 break; /* we are not progressing, bail out */
528 * Some drivers leave us after second EOF when doing
529 * MTEOM, so we must backup so that appending overwrites
532 if (dev_cap(dev, CAP_BSFATEOM)) {
533 struct mtget mt_stat;
534 /* Backup over EOF */
535 stat = bsf_dev(dev, 1);
536 /* If BSF worked and fileno is known (not -1), set file */
537 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
538 Dmsg2(100, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
539 dev->file = mt_stat.mt_fileno;
541 dev->file++; /* wing it -- not correct on all OSes */
544 update_pos_dev(dev); /* update position */
547 Dmsg1(200, "EOD dev->file=%d\n", dev->file);
552 * Set the position of the device -- only for files
553 * For other devices, there is no generic way to do it.
554 * Returns: 1 on succes
557 int update_pos_dev(DEVICE *dev)
563 dev->dev_errno = EBADF;
564 Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
565 Emsg0(M_FATAL, 0, dev->errmsg);
569 /* Find out where we are */
570 if (dev->state & ST_FILE) {
573 pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
575 Pmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
576 dev->dev_errno = errno;
577 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
578 dev->dev_name, strerror(dev->dev_errno));
581 dev->file_addr = pos;
590 * Return the status of the device. This was meant
591 * to be a generic routine. Unfortunately, it doesn't
592 * seem possible (at least I do not know how to do it
593 * currently), which means that for the moment, this
594 * routine has very little value.
598 uint32_t status_dev(DEVICE *dev)
600 struct mtget mt_stat;
603 if (dev->state & (ST_EOT | ST_WEOT)) {
607 if (dev->state & ST_EOF) {
611 if (dev->state & ST_TAPE) {
613 Dmsg0(-20," Bacula status:");
614 Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
615 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
616 dev->dev_errno = errno;
617 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
618 dev->dev_name, strerror(dev->dev_errno));
621 Dmsg0(-20, " Device status:");
623 #if defined(HAVE_LINUX_OS)
624 if (GMT_EOF(mt_stat.mt_gstat)) {
628 if (GMT_BOT(mt_stat.mt_gstat)) {
632 if (GMT_EOT(mt_stat.mt_gstat)) {
636 if (GMT_SM(mt_stat.mt_gstat)) {
640 if (GMT_EOD(mt_stat.mt_gstat)) {
644 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
646 Dmsg0(-20, " WR_PROT");
648 if (GMT_ONLINE(mt_stat.mt_gstat)) {
650 Dmsg0(-20, " ONLINE");
652 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
654 Dmsg0(-20, " DR_OPEN");
656 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
657 stat |= BMT_IM_REP_EN;
658 Dmsg0(-20, " IM_REP_EN");
660 #endif /* !SunOS && !OSF */
661 Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
663 stat |= BMT_ONLINE | BMT_BOT;
670 * Load medium in device
671 * Returns: 1 on success
674 int load_dev(DEVICE *dev)
681 dev->dev_errno = EBADF;
682 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
683 Emsg0(M_FATAL, 0, dev->errmsg);
686 if (!(dev->state & ST_TAPE)) {
690 Dmsg0(200, "stored: MTLOAD command not available\n");
691 dev->dev_errno = ENOTTY; /* function not available */
692 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
693 dev->dev_name, strerror(dev->dev_errno)); return 0;
697 dev->block_num = dev->file = 0;
699 mt_com.mt_op = MTLOAD;
701 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
702 dev->dev_errno = errno;
703 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
704 dev->dev_name, strerror(dev->dev_errno)); return 0;
711 * Rewind device and put it offline
712 * Returns: 1 on success
715 int offline_dev(DEVICE *dev)
720 dev->dev_errno = EBADF;
721 Mmsg0(&dev->errmsg, _("Bad call to offline_dev. Archive not open\n"));
722 Emsg0(M_FATAL, 0, dev->errmsg);
725 if (!(dev->state & ST_TAPE)) {
729 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
730 dev->block_num = dev->file = 0;
733 mt_com.mt_op = MTUNLOCK;
735 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
737 mt_com.mt_op = MTOFFL;
739 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
740 dev->dev_errno = errno;
741 Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
742 dev->dev_name, strerror(dev->dev_errno));
745 Dmsg1(100, "Offlined device %s\n", dev->dev_name);
749 int offline_or_rewind_dev(DEVICE *dev)
751 if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
752 return offline_dev(dev);
755 * Note, this rewind probably should not be here (it wasn't
756 * in prior versions of Bacula), but on FreeBSD, this is
757 * needed in the case the tape was "frozen" due to an error
758 * such as backspacing after writing and EOF. If it is not
759 * done, all future references to the drive get and I/O error.
761 return rewind_dev(dev);
766 * Foward space a file
767 * Returns: 1 on success
771 fsf_dev(DEVICE *dev, int num)
773 struct mtget mt_stat;
778 dev->dev_errno = EBADF;
779 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
780 Emsg0(M_FATAL, 0, dev->errmsg);
784 if (!(dev->state & ST_TAPE)) {
787 if (dev->state & ST_EOT) {
789 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
792 if (dev->state & ST_EOF) {
793 Dmsg0(200, "ST_EOF set on entry to FSF\n");
796 Dmsg0(29, "fsf_dev\n");
799 * If Fast forward space file is set, then we
800 * use MTFSF to forward space and MTIOCGET
801 * to get the file position. We assume that
802 * the SCSI driver will ensure that we do not
803 * forward space over the end of data mark.
805 if (dev_cap(dev, CAP_FSF) && dev_cap(dev, CAP_FASTFSF)) {
806 mt_com.mt_op = MTFSF;
807 mt_com.mt_count = num;
808 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
809 if (stat < 0 || ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
810 dev->state |= ST_EOT;
811 Dmsg0(200, "Set ST_EOT\n");
812 clrerror_dev(dev, MTFSF);
813 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
814 dev->dev_name, strerror(dev->dev_errno));
815 Dmsg1(200, "%s", dev->errmsg);
818 Dmsg2(200, "fsf file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
819 dev->file = mt_stat.mt_fileno;
820 dev->state |= ST_EOF; /* just read EOF */
825 * Here if CAP_FSF is set, and virtually all drives
826 * these days support it, we read a record, then forward
827 * space one file. Using this procedure, which is slow,
828 * is the only way we can be sure that we don't read
829 * two consecutive EOF marks, which means End of Data.
831 } else if (dev_cap(dev, CAP_FSF)) {
834 Dmsg0(200, "FSF has cap_fsf\n");
835 if (dev->max_block_size == 0) {
836 rbuf_len = DEFAULT_BLOCK_SIZE;
838 rbuf_len = dev->max_block_size;
840 rbuf = get_memory(rbuf_len);
841 mt_com.mt_op = MTFSF;
843 while (num-- && !(dev->state & ST_EOT)) {
844 Dmsg0(200, "Doing read before fsf\n");
845 if ((stat = read(dev->fd, (char *)rbuf, rbuf_len)) < 0) {
846 if (errno == ENOMEM) { /* tape record exceeds buf len */
847 stat = rbuf_len; /* This is OK */
849 dev->state |= ST_EOT;
850 clrerror_dev(dev, -1);
851 Dmsg2(200, "Set ST_EOT read errno=%d. ERR=%s\n", dev->dev_errno,
852 strerror(dev->dev_errno));
853 Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
854 dev->dev_name, strerror(dev->dev_errno));
855 Dmsg1(200, "%s", dev->errmsg);
859 if (stat == 0) { /* EOF */
861 Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
862 /* Two reads of zero means end of tape */
863 if (dev->state & ST_EOF) {
864 dev->state |= ST_EOT;
865 Dmsg0(200, "Set ST_EOT\n");
868 dev->state |= ST_EOF;
873 } else { /* Got data */
874 dev->state &= ~(ST_EOF|ST_EOT);
877 Dmsg0(200, "Doing MTFSF\n");
878 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
879 if (stat < 0) { /* error => EOT */
880 dev->state |= ST_EOT;
881 Dmsg0(200, "Set ST_EOT\n");
882 clrerror_dev(dev, MTFSF);
883 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
884 dev->dev_name, strerror(dev->dev_errno));
885 Dmsg0(200, "Got < 0 for MTFSF\n");
886 Dmsg1(200, "%s", dev->errmsg);
888 dev->state |= ST_EOF; /* just read EOF */
896 * No FSF, so use FSR to simulate it
899 Dmsg0(200, "Doing FSR for FSF\n");
900 while (num-- && !(dev->state & ST_EOT)) {
901 fsr_dev(dev, INT32_MAX); /* returns -1 on EOF or EOT */
903 if (dev->state & ST_EOT) {
905 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
912 Dmsg1(200, "Return %d from FSF\n", stat);
913 if (dev->state & ST_EOF)
914 Dmsg0(200, "ST_EOF set on exit FSF\n");
915 if (dev->state & ST_EOT)
916 Dmsg0(200, "ST_EOT set on exit FSF\n");
917 Dmsg1(200, "Return from FSF file=%d\n", dev->file);
918 return stat == 0 ? 1 : 0;
922 * Backward space a file
923 * Returns: 0 on failure
927 bsf_dev(DEVICE *dev, int num)
933 dev->dev_errno = EBADF;
934 Mmsg0(&dev->errmsg, _("Bad call to bsf_dev. Archive device not open\n"));
935 Emsg0(M_FATAL, 0, dev->errmsg);
939 if (!(dev_state(dev, ST_TAPE))) {
940 Mmsg1(&dev->errmsg, _("Device %s cannot BSF because it is not a tape.\n"),
944 Dmsg0(29, "bsf_dev\n");
945 dev->state &= ~(ST_EOT|ST_EOF);
948 mt_com.mt_op = MTBSF;
949 mt_com.mt_count = num;
950 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
952 clrerror_dev(dev, MTBSF);
953 Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
954 dev->dev_name, strerror(dev->dev_errno));
957 return stat == 0 ? 1 : 0;
962 * Foward space a record
963 * Returns: 0 on failure
967 fsr_dev(DEVICE *dev, int num)
973 dev->dev_errno = EBADF;
974 Mmsg0(&dev->errmsg, _("Bad call to fsr_dev. Archive not open\n"));
975 Emsg0(M_FATAL, 0, dev->errmsg);
979 if (!(dev_state(dev, ST_TAPE))) {
982 Dmsg0(29, "fsr_dev\n");
983 mt_com.mt_op = MTFSR;
984 mt_com.mt_count = num;
985 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
987 dev->state &= ~ST_EOF;
988 dev->block_num += num;
990 struct mtget mt_stat;
991 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
992 Dmsg4(100, "Adjust from %d:%d to %d:%d\n", dev->file,
993 dev->block_num, mt_stat.mt_fileno, mt_stat.mt_blkno);
994 dev->file = mt_stat.mt_fileno;
995 dev->block_num = mt_stat.mt_blkno;
997 if (dev->state & ST_EOF) {
998 dev->state |= ST_EOT;
1000 dev->state |= ST_EOF; /* assume EOF */
1006 clrerror_dev(dev, MTFSR);
1007 Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
1008 dev->dev_name, strerror(dev->dev_errno));
1010 update_pos_dev(dev);
1011 return stat == 0 ? 1 : 0;
1015 * Backward space a record
1016 * Returns: 0 on failure
1020 bsr_dev(DEVICE *dev, int num)
1026 dev->dev_errno = EBADF;
1027 Mmsg0(&dev->errmsg, _("Bad call to bsr_dev. Archive not open\n"));
1028 Emsg0(M_FATAL, 0, dev->errmsg);
1032 if (!(dev->state & ST_TAPE)) {
1036 if (!dev_cap(dev, CAP_BSR)) {
1037 Mmsg1(&dev->errmsg, _("ioctl MTBSR not permitted on %s.\n"),
1042 Dmsg0(29, "bsr_dev\n");
1043 dev->block_num -= num;
1044 dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
1045 mt_com.mt_op = MTBSR;
1046 mt_com.mt_count = num;
1047 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1049 clrerror_dev(dev, MTBSR);
1050 Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
1051 dev->dev_name, strerror(dev->dev_errno));
1053 update_pos_dev(dev);
1054 return stat == 0 ? 1 : 0;
1058 * Reposition the device to file, block
1059 * Returns: 0 on failure
1063 reposition_dev(DEVICE *dev, uint32_t file, uint32_t block)
1066 dev->dev_errno = EBADF;
1067 Mmsg0(&dev->errmsg, _("Bad call to reposition_dev. Archive not open\n"));
1068 Emsg0(M_FATAL, 0, dev->errmsg);
1072 if (!(dev_state(dev, ST_TAPE))) {
1073 off_t pos = (((off_t)file)<<32) + block;
1074 Dmsg1(100, "===== lseek to %d\n", (int)pos);
1075 if (lseek(dev->fd, pos, SEEK_SET) == (off_t)-1) {
1076 dev->dev_errno = errno;
1077 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
1078 dev->dev_name, strerror(dev->dev_errno));
1082 dev->block_num = block;
1083 dev->file_addr = pos;
1086 Dmsg4(100, "reposition_dev from %u:%u to %u:%u\n",
1087 dev->file, dev->block_num, file, block);
1088 if (file < dev->file) {
1089 Dmsg0(100, "Rewind_dev\n");
1090 if (!rewind_dev(dev)) {
1094 if (file > dev->file) {
1095 Dmsg1(100, "fsf %d\n", file-dev->file);
1096 if (!fsf_dev(dev, file-dev->file)) {
1100 if (block < dev->block_num) {
1104 if (block > dev->block_num) {
1105 /* Ignore errors as Bacula can read to the correct block */
1106 Dmsg1(100, "fsr %d\n", block-dev->block_num);
1107 fsr_dev(dev, block-dev->block_num);
1115 * Write an end of file on the device
1116 * Returns: 0 on success
1117 * non-zero on failure
1120 weof_dev(DEVICE *dev, int num)
1126 dev->dev_errno = EBADF;
1127 Mmsg0(&dev->errmsg, _("Bad call to weof_dev. Archive drive not open\n"));
1128 Emsg0(M_FATAL, 0, dev->errmsg);
1132 if (!(dev_state(dev, ST_TAPE))) {
1135 dev->state &= ~(ST_EOT | ST_EOF); /* remove EOF/EOT flags */
1137 Dmsg0(29, "weof_dev\n");
1138 mt_com.mt_op = MTWEOF;
1139 mt_com.mt_count = num;
1140 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1145 clrerror_dev(dev, MTWEOF);
1147 Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
1148 dev->dev_name, strerror(dev->dev_errno));
1155 * Return string message with last error in English
1156 * Be careful not to call this routine from within dev.c
1157 * while editing an Mmsg(&) or you will end up in a recursive
1158 * loop creating a Segmentation Violation.
1161 strerror_dev(DEVICE *dev)
1168 * If implemented in system, clear the tape
1172 clrerror_dev(DEVICE *dev, int func)
1174 const char *msg = NULL;
1176 dev->dev_errno = errno; /* save errno */
1178 dev->VolCatInfo.VolCatErrors++;
1181 if (!(dev->state & ST_TAPE)) {
1184 if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
1187 Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
1191 dev->capabilities &= ~CAP_EOF; /* turn off feature */
1196 dev->capabilities &= ~CAP_EOM; /* turn off feature */
1201 dev->capabilities &= ~CAP_FSF; /* turn off feature */
1205 dev->capabilities &= ~CAP_BSF; /* turn off feature */
1209 dev->capabilities &= ~CAP_FSR; /* turn off feature */
1213 dev->capabilities &= ~CAP_BSR; /* turn off feature */
1220 dev->dev_errno = ENOSYS;
1221 Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
1222 Emsg0(M_ERROR, 0, dev->errmsg);
1225 /* Found on Linux */
1229 mt_com.mt_op = MTIOCLRERR;
1230 mt_com.mt_count = 1;
1231 /* Clear any error condition on the tape */
1232 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1233 Dmsg0(200, "Did MTIOCLRERR\n");
1237 /* Typically on FreeBSD */
1240 /* Read and clear SCSI error status */
1241 union mterrstat mt_errstat;
1242 Dmsg2(200, "Doing MTIOCERRSTAT errno=%d ERR=%s\n", dev->dev_errno,
1243 strerror(dev->dev_errno));
1244 ioctl(dev->fd, MTIOCERRSTAT, (char *)&mt_errstat);
1250 * Flush buffer contents
1253 int flush_dev(DEVICE *dev)
1258 static void do_close(DEVICE *dev)
1261 Dmsg1(29, "really close_dev %s\n", dev->dev_name);
1265 /* Clean up device packet so it can be reused */
1267 dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1268 dev->file = dev->block_num = 0;
1270 dev->EndFile = dev->EndBlock = 0;
1271 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1272 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1274 stop_thread_timer(dev->tid);
1284 close_dev(DEVICE *dev)
1287 Mmsg0(&dev->errmsg, _("Bad call to close_dev. Archive not open\n"));
1288 Emsg0(M_FATAL, 0, dev->errmsg);
1291 if (dev->fd >= 0 && dev->use_count == 1) {
1293 } else if (dev->use_count > 0) {
1298 ASSERT(dev->use_count >= 0);
1303 * Used when unmounting the device, ignore use_count
1305 void force_close_dev(DEVICE *dev)
1308 Mmsg0(&dev->errmsg, _("Bad call to force_close_dev. Archive not open\n"));
1309 Emsg0(M_FATAL, 0, dev->errmsg);
1312 Dmsg1(29, "Force close_dev %s\n", dev->dev_name);
1316 ASSERT(dev->use_count >= 0);
1320 int truncate_dev(DEVICE *dev)
1322 if (dev->state & ST_TAPE) {
1325 if (ftruncate(dev->fd, 0) != 0) {
1326 Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1333 dev_is_tape(DEVICE *dev)
1335 return (dev->state & ST_TAPE) ? 1 : 0;
1340 * return 1 if the device is read for write, and 0 otherwise
1341 * This is meant for checking at the end of a job to see
1342 * if we still have a tape (perhaps not if at end of tape
1343 * and the job is canceled).
1346 dev_can_write(DEVICE *dev)
1348 if ((dev->state & ST_OPENED) && (dev->state & ST_APPEND) &&
1349 (dev->state & ST_LABEL) && !(dev->state & ST_WEOT)) {
1357 dev_name(DEVICE *dev)
1359 return dev->dev_name;
1363 dev_vol_name(DEVICE *dev)
1365 return dev->VolCatInfo.VolCatName;
1368 uint32_t dev_block(DEVICE *dev)
1370 update_pos_dev(dev);
1371 return dev->block_num;
1374 uint32_t dev_file(DEVICE *dev)
1376 update_pos_dev(dev);
1381 * Free memory allocated for the device
1384 term_dev(DEVICE *dev)
1387 dev->dev_errno = EBADF;
1388 Mmsg0(&dev->errmsg, _("Bad call to term_dev. Archive not open\n"));
1389 Emsg0(M_FATAL, 0, dev->errmsg);
1393 Dmsg0(29, "term_dev\n");
1394 if (dev->dev_name) {
1395 free_memory(dev->dev_name);
1396 dev->dev_name = NULL;
1399 free_pool_memory(dev->errmsg);
1402 pthread_mutex_destroy(&dev->mutex);
1403 pthread_cond_destroy(&dev->wait);
1404 pthread_cond_destroy(&dev->wait_next_vol);
1405 pthread_mutex_destroy(&dev->spool_mutex);
1406 rwl_destroy(&dev->lock);
1407 if (dev->attached_dcrs) {
1408 delete dev->attached_dcrs;
1409 dev->attached_dcrs = NULL;
1411 if (dev->state & ST_MALLOC) {
1412 free_pool_memory((POOLMEM *)dev);
1417 * We attach a jcr to the device so that when
1418 * the Volume is full during writing, a
1419 * JobMedia record will be created for this
1422 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1424 jcr->prev_dev = (JCR *)NULL;
1425 jcr->next_dev = dev->attached_jcrs;
1426 if (dev->attached_jcrs) {
1427 dev->attached_jcrs->prev_dev = jcr;
1429 dev->attached_jcrs = jcr;
1430 Dmsg1(100, "Attached Job %s\n", jcr->Job);
1433 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1435 if (!jcr->prev_dev) {
1436 dev->attached_jcrs = jcr->next_dev;
1438 jcr->prev_dev->next_dev = jcr->next_dev;
1440 if (jcr->next_dev) {
1441 jcr->next_dev->prev_dev = jcr->prev_dev;
1443 jcr->next_dev = jcr->prev_dev = NULL;
1444 Dmsg1(100, "Detached Job %s\n", jcr->Job);
1447 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1449 if (jcr == (JCR *)NULL) {
1450 return dev->attached_jcrs;
1452 return jcr->next_dev;
1456 * This routine initializes the device wait timers
1458 void init_dev_wait_timers(DEVICE *dev)
1460 /* ******FIXME******* put these on config variables */
1461 dev->min_wait = 60 * 60;
1462 dev->max_wait = 24 * 60 * 60;
1463 dev->max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
1464 dev->wait_sec = dev->min_wait;
1465 dev->rem_wait_sec = dev->wait_sec;
1468 dev->BadVolName[0] = 0;
1472 * Returns: true if time doubled
1473 * false if max time expired
1475 bool double_dev_wait_time(DEVICE *dev)
1477 dev->wait_sec *= 2; /* double wait time */
1478 if (dev->wait_sec > dev->max_wait) { /* but not longer than maxtime */
1479 dev->wait_sec = dev->max_wait;
1482 dev->rem_wait_sec = dev->wait_sec;
1483 if (dev->num_wait >= dev->max_num_wait) {