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);
201 dev->attached_dcrs = new dlist(dcr, &dcr->dev_link);
202 Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
207 /* Open the device with the operating system and
208 * initialize buffer pointers.
210 * Note, for a tape, the VolName is the name we give to the
211 * volume (not really used here), but for a file, the
212 * VolName represents the name of the file to be created/opened.
213 * In the case of a file, the full name is the device name
214 * (archive_name) with the VolName concatenated.
217 open_dev(DEVICE *dev, char *VolName, int mode)
219 POOLMEM *archive_name;
221 if (dev->state & ST_OPENED) {
223 * *****FIXME***** how to handle two threads wanting
224 * different volumes mounted???? E.g. one is waiting
225 * for the next volume to be mounted, and a new job
226 * starts and snatches up the device.
228 if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
232 Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
233 dev->dev_name, dev->use_count);
234 Emsg1(M_WARNING, 0, "%s", dev->errmsg);
238 bstrncpy(dev->VolCatInfo.VolCatName, VolName, sizeof(dev->VolCatInfo.VolCatName));
241 Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
242 dev->dev_name, dev->VolCatInfo.VolCatName);
243 dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
244 if (dev->state & (ST_TAPE|ST_FIFO)) {
246 Dmsg0(29, "open_dev: device is tape\n");
247 if (mode == OPEN_READ_WRITE) {
248 dev->mode = O_RDWR | O_BINARY;
249 } else if (mode == OPEN_READ_ONLY) {
250 dev->mode = O_RDONLY | O_BINARY;
251 } else if (mode == OPEN_WRITE_ONLY) {
252 dev->mode = O_WRONLY | O_BINARY;
254 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
256 timeout = dev->max_open_wait;
258 if (dev->state & ST_FIFO && timeout) {
260 dev->tid = start_thread_timer(pthread_self(), timeout);
262 /* If busy retry each second for max_open_wait seconds */
263 while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
264 if (errno == EINTR || errno == EAGAIN) {
267 if (errno == EBUSY && timeout-- > 0) {
268 Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
272 dev->dev_errno = errno;
273 Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
274 dev->dev_name, strerror(dev->dev_errno));
275 /* Stop any open timer we set */
277 stop_thread_timer(dev->tid);
280 Emsg0(M_FATAL, 0, dev->errmsg);
285 dev->state |= ST_OPENED;
287 update_pos_dev(dev); /* update position */
289 /* Stop any open() timer we started */
291 stop_thread_timer(dev->tid);
294 Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
297 * Handle opening of File Archive (not a tape)
299 if (VolName == NULL || *VolName == 0) {
300 Mmsg(&dev->errmsg, _("Could not open file device %s. No Volume name given.\n"),
304 archive_name = get_pool_memory(PM_FNAME);
305 pm_strcpy(&archive_name, dev->dev_name);
306 if (archive_name[strlen(archive_name)] != '/') {
307 pm_strcat(&archive_name, "/");
309 pm_strcat(&archive_name, VolName);
310 Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
311 if (mode == OPEN_READ_WRITE) {
312 dev->mode = O_CREAT | O_RDWR | O_BINARY;
313 } else if (mode == OPEN_READ_ONLY) {
314 dev->mode = O_RDONLY | O_BINARY;
315 } else if (mode == OPEN_WRITE_ONLY) {
316 dev->mode = O_WRONLY | O_BINARY;
318 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
320 /* If creating file, give 0640 permissions */
321 if ((dev->fd = open(archive_name, dev->mode, 0640)) < 0) {
322 dev->dev_errno = errno;
323 Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
324 Emsg0(M_FATAL, 0, dev->errmsg);
327 dev->state |= ST_OPENED;
329 update_pos_dev(dev); /* update position */
331 Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
332 free_pool_memory(archive_name);
339 int _rewind_dev(char *file, int line, DEVICE *dev)
341 Dmsg2(100, "rewind_dev called from %s:%d\n", file, line);
342 return rewind_dev(dev);
349 * Returns: 1 on success
352 int rewind_dev(DEVICE *dev)
357 Dmsg1(29, "rewind_dev %s\n", dev->dev_name);
359 dev->dev_errno = EBADF;
360 Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
362 Emsg0(M_FATAL, 0, dev->errmsg);
365 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
366 dev->block_num = dev->file = 0;
368 if (dev->state & ST_TAPE) {
369 mt_com.mt_op = MTREW;
371 /* If we get an I/O error on rewind, it is probably because
372 * the drive is actually busy. We loop for (about 5 minutes)
373 * retrying every 5 seconds.
375 for (i=dev->max_rewind_wait; ; i -= 5) {
376 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
377 if (i == dev->max_rewind_wait) {
378 Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
380 clrerror_dev(dev, MTREW);
381 if (dev->dev_errno == EIO && i > 0) {
382 Dmsg0(200, "Sleeping 5 seconds.\n");
386 Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
387 dev->dev_name, strerror(dev->dev_errno));
392 } else if (dev->state & ST_FILE) {
393 if (lseek(dev->fd, (off_t)0, SEEK_SET) < 0) {
394 dev->dev_errno = errno;
395 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
396 dev->dev_name, strerror(dev->dev_errno));
404 * Position device to end of medium (end of data)
405 * Returns: 1 on succes
412 struct mtget mt_stat;
416 Dmsg0(29, "eod_dev\n");
417 if (dev->state & ST_EOT) {
420 dev->state &= ~(ST_EOF); /* remove EOF flags */
421 dev->block_num = dev->file = 0;
423 if (dev->state & (ST_FIFO | ST_PROG)) {
426 if (!(dev->state & ST_TAPE)) {
427 pos = lseek(dev->fd, (off_t)0, SEEK_END);
428 // Dmsg1(100, "====== Seek to %lld\n", pos);
431 dev->state |= ST_EOT;
434 dev->dev_errno = errno;
435 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
436 dev->dev_name, strerror(dev->dev_errno));
441 if (dev_cap(dev, CAP_FASTFSF) && !dev_cap(dev, CAP_EOM)) {
442 struct mtget mt_stat;
443 Dmsg0(100,"Using FAST FSF for EOM\n");
444 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno <= 0) {
445 if (!rewind_dev(dev)) {
449 mt_com.mt_op = MTFSF;
451 * ***FIXEM*** fix code to handle case that INT16_MAX is
454 mt_com.mt_count = INT16_MAX; /* use big positive number */
455 if (mt_com.mt_count < 0) {
456 mt_com.mt_count = INT16_MAX; /* brain damaged system */
460 if (dev_cap(dev, CAP_EOM)) {
461 Dmsg0(100,"Using EOM for EOM\n");
462 mt_com.mt_op = MTEOM;
465 if (dev_cap(dev, CAP_FASTFSF) || dev_cap(dev, CAP_EOM)) {
466 if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
467 Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
468 clrerror_dev(dev, mt_com.mt_op);
470 Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
471 dev->dev_name, strerror(dev->dev_errno));
475 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
476 dev->dev_errno = errno;
477 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
478 dev->dev_name, strerror(dev->dev_errno));
481 Dmsg2(100, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
482 dev->file = mt_stat.mt_fileno;
485 * Rewind then use FSF until EOT reached
491 if (!rewind_dev(dev)) {
495 * Move file by file to the end of the tape
498 for (file_num=dev->file; !(dev->state & ST_EOT); file_num++) {
499 Dmsg0(200, "eod_dev: doing fsf 1\n");
500 if (!fsf_dev(dev, 1)) {
501 Dmsg0(200, "fsf_dev error.\n");
505 * Avoid infinite loop. ***FIXME*** possibly add code
506 * to set EOD or to turn off CAP_FASTFSF if on.
508 if (file_num == (int)dev->file) {
509 struct mtget mt_stat;
510 Dmsg1(100, "fsf_dev did not advance from file %d\n", file_num);
511 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 &&
512 mt_stat.mt_fileno >= 0) {
513 Dmsg2(000, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
514 dev->file = mt_stat.mt_fileno;
517 break; /* we are not progressing, bail out */
522 * Some drivers leave us after second EOF when doing
523 * MTEOM, so we must backup so that appending overwrites
526 if (dev_cap(dev, CAP_BSFATEOM)) {
527 struct mtget mt_stat;
528 /* Backup over EOF */
529 stat = bsf_dev(dev, 1);
530 /* If BSF worked and fileno is known (not -1), set file */
531 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && 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;
535 dev->file++; /* wing it -- not correct on all OSes */
538 update_pos_dev(dev); /* update position */
541 Dmsg1(200, "EOD dev->file=%d\n", dev->file);
546 * Set the position of the device -- only for files
547 * For other devices, there is no generic way to do it.
548 * Returns: 1 on succes
551 int update_pos_dev(DEVICE *dev)
557 dev->dev_errno = EBADF;
558 Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
559 Emsg0(M_FATAL, 0, dev->errmsg);
563 /* Find out where we are */
564 if (dev->state & ST_FILE) {
567 pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
569 Pmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
570 dev->dev_errno = errno;
571 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
572 dev->dev_name, strerror(dev->dev_errno));
575 dev->file_addr = pos;
584 * Return the status of the device. This was meant
585 * to be a generic routine. Unfortunately, it doesn't
586 * seem possible (at least I do not know how to do it
587 * currently), which means that for the moment, this
588 * routine has very little value.
592 uint32_t status_dev(DEVICE *dev)
594 struct mtget mt_stat;
597 if (dev->state & (ST_EOT | ST_WEOT)) {
601 if (dev->state & ST_EOF) {
605 if (dev->state & ST_TAPE) {
607 Dmsg0(-20," Bacula status:");
608 Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
609 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
610 dev->dev_errno = errno;
611 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
612 dev->dev_name, strerror(dev->dev_errno));
615 Dmsg0(-20, " Device status:");
617 #if defined(HAVE_LINUX_OS)
618 if (GMT_EOF(mt_stat.mt_gstat)) {
622 if (GMT_BOT(mt_stat.mt_gstat)) {
626 if (GMT_EOT(mt_stat.mt_gstat)) {
630 if (GMT_SM(mt_stat.mt_gstat)) {
634 if (GMT_EOD(mt_stat.mt_gstat)) {
638 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
640 Dmsg0(-20, " WR_PROT");
642 if (GMT_ONLINE(mt_stat.mt_gstat)) {
644 Dmsg0(-20, " ONLINE");
646 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
648 Dmsg0(-20, " DR_OPEN");
650 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
651 stat |= BMT_IM_REP_EN;
652 Dmsg0(-20, " IM_REP_EN");
654 #endif /* !SunOS && !OSF */
655 Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
657 stat |= BMT_ONLINE | BMT_BOT;
664 * Load medium in device
665 * Returns: 1 on success
668 int load_dev(DEVICE *dev)
675 dev->dev_errno = EBADF;
676 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
677 Emsg0(M_FATAL, 0, dev->errmsg);
680 if (!(dev->state & ST_TAPE)) {
684 Dmsg0(200, "stored: MTLOAD command not available\n");
685 dev->dev_errno = ENOTTY; /* function not available */
686 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
687 dev->dev_name, strerror(dev->dev_errno)); return 0;
691 dev->block_num = dev->file = 0;
693 mt_com.mt_op = MTLOAD;
695 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
696 dev->dev_errno = errno;
697 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
698 dev->dev_name, strerror(dev->dev_errno)); return 0;
705 * Rewind device and put it offline
706 * Returns: 1 on success
709 int offline_dev(DEVICE *dev)
714 dev->dev_errno = EBADF;
715 Mmsg0(&dev->errmsg, _("Bad call to offline_dev. Archive not open\n"));
716 Emsg0(M_FATAL, 0, dev->errmsg);
719 if (!(dev->state & ST_TAPE)) {
723 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
724 dev->block_num = dev->file = 0;
727 mt_com.mt_op = MTUNLOCK;
729 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
731 mt_com.mt_op = MTOFFL;
733 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
734 dev->dev_errno = errno;
735 Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
736 dev->dev_name, strerror(dev->dev_errno));
739 Dmsg1(100, "Offlined device %s\n", dev->dev_name);
743 int offline_or_rewind_dev(DEVICE *dev)
745 if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
746 return offline_dev(dev);
749 * Note, this rewind probably should not be here (it wasn't
750 * in prior versions of Bacula), but on FreeBSD, this is
751 * needed in the case the tape was "frozen" due to an error
752 * such as backspacing after writing and EOF. If it is not
753 * done, all future references to the drive get and I/O error.
755 return rewind_dev(dev);
760 * Foward space a file
761 * Returns: 1 on success
765 fsf_dev(DEVICE *dev, int num)
767 struct mtget mt_stat;
772 dev->dev_errno = EBADF;
773 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
774 Emsg0(M_FATAL, 0, dev->errmsg);
778 if (!(dev->state & ST_TAPE)) {
781 if (dev->state & ST_EOT) {
783 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
786 if (dev->state & ST_EOF) {
787 Dmsg0(200, "ST_EOF set on entry to FSF\n");
790 Dmsg0(29, "fsf_dev\n");
793 * If Fast forward space file is set, then we
794 * use MTFSF to forward space and MTIOCGET
795 * to get the file position. We assume that
796 * the SCSI driver will ensure that we do not
797 * forward space over the end of data mark.
799 if (dev_cap(dev, CAP_FSF) && dev_cap(dev, CAP_FASTFSF)) {
800 mt_com.mt_op = MTFSF;
801 mt_com.mt_count = num;
802 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
803 if (stat < 0 || ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
804 dev->state |= ST_EOT;
805 Dmsg0(200, "Set ST_EOT\n");
806 clrerror_dev(dev, MTFSF);
807 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
808 dev->dev_name, strerror(dev->dev_errno));
809 Dmsg1(200, "%s", dev->errmsg);
812 Dmsg2(200, "fsf file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
813 dev->file = mt_stat.mt_fileno;
814 dev->state |= ST_EOF; /* just read EOF */
819 * Here if CAP_FSF is set, and virtually all drives
820 * these days support it, we read a record, then forward
821 * space one file. Using this procedure, which is slow,
822 * is the only way we can be sure that we don't read
823 * two consecutive EOF marks, which means End of Data.
825 } else if (dev_cap(dev, CAP_FSF)) {
828 Dmsg0(200, "FSF has cap_fsf\n");
829 if (dev->max_block_size == 0) {
830 rbuf_len = DEFAULT_BLOCK_SIZE;
832 rbuf_len = dev->max_block_size;
834 rbuf = get_memory(rbuf_len);
835 mt_com.mt_op = MTFSF;
837 while (num-- && !(dev->state & ST_EOT)) {
838 Dmsg0(200, "Doing read before fsf\n");
839 if ((stat = read(dev->fd, (char *)rbuf, rbuf_len)) < 0) {
840 if (errno == ENOMEM) { /* tape record exceeds buf len */
841 stat = rbuf_len; /* This is OK */
843 dev->state |= ST_EOT;
844 clrerror_dev(dev, -1);
845 Dmsg2(200, "Set ST_EOT read errno=%d. ERR=%s\n", dev->dev_errno,
846 strerror(dev->dev_errno));
847 Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
848 dev->dev_name, strerror(dev->dev_errno));
849 Dmsg1(200, "%s", dev->errmsg);
853 if (stat == 0) { /* EOF */
855 Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
856 /* Two reads of zero means end of tape */
857 if (dev->state & ST_EOF) {
858 dev->state |= ST_EOT;
859 Dmsg0(200, "Set ST_EOT\n");
862 dev->state |= ST_EOF;
867 } else { /* Got data */
868 dev->state &= ~(ST_EOF|ST_EOT);
871 Dmsg0(200, "Doing MTFSF\n");
872 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
873 if (stat < 0) { /* error => EOT */
874 dev->state |= ST_EOT;
875 Dmsg0(200, "Set ST_EOT\n");
876 clrerror_dev(dev, MTFSF);
877 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
878 dev->dev_name, strerror(dev->dev_errno));
879 Dmsg0(200, "Got < 0 for MTFSF\n");
880 Dmsg1(200, "%s", dev->errmsg);
882 dev->state |= ST_EOF; /* just read EOF */
890 * No FSF, so use FSR to simulate it
893 Dmsg0(200, "Doing FSR for FSF\n");
894 while (num-- && !(dev->state & ST_EOT)) {
895 fsr_dev(dev, INT32_MAX); /* returns -1 on EOF or EOT */
897 if (dev->state & ST_EOT) {
899 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
906 Dmsg1(200, "Return %d from FSF\n", stat);
907 if (dev->state & ST_EOF)
908 Dmsg0(200, "ST_EOF set on exit FSF\n");
909 if (dev->state & ST_EOT)
910 Dmsg0(200, "ST_EOT set on exit FSF\n");
911 Dmsg1(200, "Return from FSF file=%d\n", dev->file);
912 return stat == 0 ? 1 : 0;
916 * Backward space a file
917 * Returns: 0 on failure
921 bsf_dev(DEVICE *dev, int num)
927 dev->dev_errno = EBADF;
928 Mmsg0(&dev->errmsg, _("Bad call to bsf_dev. Archive device not open\n"));
929 Emsg0(M_FATAL, 0, dev->errmsg);
933 if (!(dev_state(dev, ST_TAPE))) {
934 Mmsg1(&dev->errmsg, _("Device %s cannot BSF because it is not a tape.\n"),
938 Dmsg0(29, "bsf_dev\n");
939 dev->state &= ~(ST_EOT|ST_EOF);
942 mt_com.mt_op = MTBSF;
943 mt_com.mt_count = num;
944 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
946 clrerror_dev(dev, MTBSF);
947 Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
948 dev->dev_name, strerror(dev->dev_errno));
951 return stat == 0 ? 1 : 0;
956 * Foward space a record
957 * Returns: 0 on failure
961 fsr_dev(DEVICE *dev, int num)
967 dev->dev_errno = EBADF;
968 Mmsg0(&dev->errmsg, _("Bad call to fsr_dev. Archive not open\n"));
969 Emsg0(M_FATAL, 0, dev->errmsg);
973 if (!(dev_state(dev, ST_TAPE))) {
976 Dmsg0(29, "fsr_dev\n");
977 mt_com.mt_op = MTFSR;
978 mt_com.mt_count = num;
979 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
981 dev->state &= ~ST_EOF;
982 dev->block_num += num;
984 struct mtget mt_stat;
985 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
986 Dmsg4(100, "Adjust from %d:%d to %d:%d\n", dev->file,
987 dev->block_num, mt_stat.mt_fileno, mt_stat.mt_blkno);
988 dev->file = mt_stat.mt_fileno;
989 dev->block_num = mt_stat.mt_blkno;
991 if (dev->state & ST_EOF) {
992 dev->state |= ST_EOT;
994 dev->state |= ST_EOF; /* assume EOF */
1000 clrerror_dev(dev, MTFSR);
1001 Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
1002 dev->dev_name, strerror(dev->dev_errno));
1004 update_pos_dev(dev);
1005 return stat == 0 ? 1 : 0;
1009 * Backward space a record
1010 * Returns: 0 on failure
1014 bsr_dev(DEVICE *dev, int num)
1020 dev->dev_errno = EBADF;
1021 Mmsg0(&dev->errmsg, _("Bad call to bsr_dev. Archive not open\n"));
1022 Emsg0(M_FATAL, 0, dev->errmsg);
1026 if (!(dev->state & ST_TAPE)) {
1030 if (!dev_cap(dev, CAP_BSR)) {
1031 Mmsg1(&dev->errmsg, _("ioctl MTBSR not permitted on %s.\n"),
1036 Dmsg0(29, "bsr_dev\n");
1037 dev->block_num -= num;
1038 dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
1039 mt_com.mt_op = MTBSR;
1040 mt_com.mt_count = num;
1041 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1043 clrerror_dev(dev, MTBSR);
1044 Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
1045 dev->dev_name, strerror(dev->dev_errno));
1047 update_pos_dev(dev);
1048 return stat == 0 ? 1 : 0;
1052 * Reposition the device to file, block
1053 * Returns: 0 on failure
1057 reposition_dev(DEVICE *dev, uint32_t file, uint32_t block)
1060 dev->dev_errno = EBADF;
1061 Mmsg0(&dev->errmsg, _("Bad call to reposition_dev. Archive not open\n"));
1062 Emsg0(M_FATAL, 0, dev->errmsg);
1066 if (!(dev_state(dev, ST_TAPE))) {
1067 off_t pos = (((off_t)file)<<32) + block;
1068 Dmsg1(100, "===== lseek to %d\n", (int)pos);
1069 if (lseek(dev->fd, pos, SEEK_SET) == (off_t)-1) {
1070 dev->dev_errno = errno;
1071 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
1072 dev->dev_name, strerror(dev->dev_errno));
1076 dev->block_num = block;
1077 dev->file_addr = pos;
1080 Dmsg4(100, "reposition_dev from %u:%u to %u:%u\n",
1081 dev->file, dev->block_num, file, block);
1082 if (file < dev->file) {
1083 Dmsg0(100, "Rewind_dev\n");
1084 if (!rewind_dev(dev)) {
1088 if (file > dev->file) {
1089 Dmsg1(100, "fsf %d\n", file-dev->file);
1090 if (!fsf_dev(dev, file-dev->file)) {
1094 if (block < dev->block_num) {
1098 if (block > dev->block_num) {
1099 /* Ignore errors as Bacula can read to the correct block */
1100 Dmsg1(100, "fsr %d\n", block-dev->block_num);
1101 fsr_dev(dev, block-dev->block_num);
1109 * Write an end of file on the device
1110 * Returns: 0 on success
1111 * non-zero on failure
1114 weof_dev(DEVICE *dev, int num)
1120 dev->dev_errno = EBADF;
1121 Mmsg0(&dev->errmsg, _("Bad call to weof_dev. Archive drive not open\n"));
1122 Emsg0(M_FATAL, 0, dev->errmsg);
1126 if (!(dev_state(dev, ST_TAPE))) {
1129 dev->state &= ~(ST_EOT | ST_EOF); /* remove EOF/EOT flags */
1131 Dmsg0(29, "weof_dev\n");
1132 mt_com.mt_op = MTWEOF;
1133 mt_com.mt_count = num;
1134 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1139 clrerror_dev(dev, MTWEOF);
1141 Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
1142 dev->dev_name, strerror(dev->dev_errno));
1149 * Return string message with last error in English
1150 * Be careful not to call this routine from within dev.c
1151 * while editing an Mmsg(&) or you will end up in a recursive
1152 * loop creating a Segmentation Violation.
1155 strerror_dev(DEVICE *dev)
1162 * If implemented in system, clear the tape
1166 clrerror_dev(DEVICE *dev, int func)
1170 dev->dev_errno = errno; /* save errno */
1172 dev->VolCatInfo.VolCatErrors++;
1175 if (!(dev->state & ST_TAPE)) {
1178 if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
1181 Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
1185 dev->capabilities &= ~CAP_EOF; /* turn off feature */
1190 dev->capabilities &= ~CAP_EOM; /* turn off feature */
1195 dev->capabilities &= ~CAP_FSF; /* turn off feature */
1199 dev->capabilities &= ~CAP_BSF; /* turn off feature */
1203 dev->capabilities &= ~CAP_FSR; /* turn off feature */
1207 dev->capabilities &= ~CAP_BSR; /* turn off feature */
1214 dev->dev_errno = ENOSYS;
1215 Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
1216 Emsg0(M_ERROR, 0, dev->errmsg);
1219 /* Found on Linux */
1223 mt_com.mt_op = MTIOCLRERR;
1224 mt_com.mt_count = 1;
1225 /* Clear any error condition on the tape */
1226 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1227 Dmsg0(200, "Did MTIOCLRERR\n");
1231 /* Typically on FreeBSD */
1234 /* Read and clear SCSI error status */
1235 union mterrstat mt_errstat;
1236 Dmsg2(200, "Doing MTIOCERRSTAT errno=%d ERR=%s\n", dev->dev_errno,
1237 strerror(dev->dev_errno));
1238 ioctl(dev->fd, MTIOCERRSTAT, (char *)&mt_errstat);
1244 * Flush buffer contents
1247 int flush_dev(DEVICE *dev)
1252 static void do_close(DEVICE *dev)
1255 Dmsg1(29, "really close_dev %s\n", dev->dev_name);
1259 /* Clean up device packet so it can be reused */
1261 dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1262 dev->file = dev->block_num = 0;
1264 dev->EndFile = dev->EndBlock = 0;
1265 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1266 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1268 stop_thread_timer(dev->tid);
1278 close_dev(DEVICE *dev)
1281 Mmsg0(&dev->errmsg, _("Bad call to close_dev. Archive not open\n"));
1282 Emsg0(M_FATAL, 0, dev->errmsg);
1285 if (dev->fd >= 0 && dev->use_count == 1) {
1287 } else if (dev->use_count > 0) {
1292 ASSERT(dev->use_count >= 0);
1297 * Used when unmounting the device, ignore use_count
1299 void force_close_dev(DEVICE *dev)
1302 Mmsg0(&dev->errmsg, _("Bad call to force_close_dev. Archive not open\n"));
1303 Emsg0(M_FATAL, 0, dev->errmsg);
1306 Dmsg1(29, "Force close_dev %s\n", dev->dev_name);
1310 ASSERT(dev->use_count >= 0);
1314 int truncate_dev(DEVICE *dev)
1316 if (dev->state & ST_TAPE) {
1319 if (ftruncate(dev->fd, 0) != 0) {
1320 Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1327 dev_is_tape(DEVICE *dev)
1329 return (dev->state & ST_TAPE) ? 1 : 0;
1334 * return 1 if the device is read for write, and 0 otherwise
1335 * This is meant for checking at the end of a job to see
1336 * if we still have a tape (perhaps not if at end of tape
1337 * and the job is canceled).
1340 dev_can_write(DEVICE *dev)
1342 if ((dev->state & ST_OPENED) && (dev->state & ST_APPEND) &&
1343 (dev->state & ST_LABEL) && !(dev->state & ST_WEOT)) {
1351 dev_name(DEVICE *dev)
1353 return dev->dev_name;
1357 dev_vol_name(DEVICE *dev)
1359 return dev->VolCatInfo.VolCatName;
1362 uint32_t dev_block(DEVICE *dev)
1364 update_pos_dev(dev);
1365 return dev->block_num;
1368 uint32_t dev_file(DEVICE *dev)
1370 update_pos_dev(dev);
1375 * Free memory allocated for the device
1378 term_dev(DEVICE *dev)
1381 dev->dev_errno = EBADF;
1382 Mmsg0(&dev->errmsg, _("Bad call to term_dev. Archive not open\n"));
1383 Emsg0(M_FATAL, 0, dev->errmsg);
1387 Dmsg0(29, "term_dev\n");
1388 if (dev->dev_name) {
1389 free_memory(dev->dev_name);
1390 dev->dev_name = NULL;
1393 free_pool_memory(dev->errmsg);
1396 pthread_mutex_destroy(&dev->mutex);
1397 pthread_cond_destroy(&dev->wait);
1398 pthread_cond_destroy(&dev->wait_next_vol);
1399 pthread_mutex_destroy(&dev->spool_mutex);
1400 if (dev->attached_dcrs) {
1401 delete dev->attached_dcrs;
1402 dev->attached_dcrs = NULL;
1404 if (dev->state & ST_MALLOC) {
1405 free_pool_memory((POOLMEM *)dev);
1410 * We attach a jcr to the device so that when
1411 * the Volume is full during writing, a
1412 * JobMedia record will be created for this
1415 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1417 jcr->prev_dev = (JCR *)NULL;
1418 jcr->next_dev = dev->attached_jcrs;
1419 if (dev->attached_jcrs) {
1420 dev->attached_jcrs->prev_dev = jcr;
1422 dev->attached_jcrs = jcr;
1423 Dmsg1(100, "Attached Job %s\n", jcr->Job);
1426 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1428 if (!jcr->prev_dev) {
1429 dev->attached_jcrs = jcr->next_dev;
1431 jcr->prev_dev->next_dev = jcr->next_dev;
1433 if (jcr->next_dev) {
1434 jcr->next_dev->prev_dev = jcr->prev_dev;
1436 jcr->next_dev = jcr->prev_dev = NULL;
1437 Dmsg1(100, "Detached Job %s\n", jcr->Job);
1440 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1442 if (jcr == (JCR *)NULL) {
1443 return dev->attached_jcrs;
1445 return jcr->next_dev;
1449 * This routine initializes the device wait timers
1451 void init_dev_wait_timers(DEVICE *dev)
1453 /* ******FIXME******* put these on config variables */
1454 dev->min_wait = 60 * 60;
1455 dev->max_wait = 24 * 60 * 60;
1456 dev->max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
1457 dev->wait_sec = dev->min_wait;
1458 dev->rem_wait_sec = dev->wait_sec;
1461 dev->BadVolName[0] = 0;
1465 * Returns: true if time doubled
1466 * false if max time expired
1468 bool double_dev_wait_time(DEVICE *dev)
1470 dev->wait_sec *= 2; /* double wait time */
1471 if (dev->wait_sec > dev->max_wait) { /* but not longer than maxtime */
1472 dev->wait_sec = dev->max_wait;
1475 dev->rem_wait_sec = dev->wait_sec;
1476 if (dev->num_wait >= dev->max_num_wait) {