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, 2001, 2002 Kern Sibbald and John Walker
34 This program is free software; you can redistribute it and/or
35 modify it under the terms of the GNU General Public License as
36 published by the Free Software Foundation; either version 2 of
37 the License, or (at your option) any later version.
39 This program is distributed in the hope that it will be useful,
40 but WITHOUT ANY WARRANTY; without even the implied warranty of
41 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
42 General Public License for more details.
44 You should have received a copy of the GNU General Public
45 License along with this program; if not, write to the Free
46 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
52 * Handling I/O errors and end of tape conditions are a bit tricky.
53 * This is how it is currently done when writting.
54 * On either an I/O error or end of tape,
55 * we will stop writing on the physical device (no I/O recovery is
56 * attempted at least in this daemon). The state flag will be sent
57 * to include ST_EOT, which is ephimeral, and ST_WEOT, which is
58 * persistent. Lots of routines clear ST_EOT, but ST_WEOT is
59 * cleared only when the problem goes away. Now when ST_WEOT
60 * is set all calls to write_dev() are handled as usual. However,
61 * in write_block() instead of attempting to write the block to
62 * the physical device, it is chained into a list of blocks written
63 * after the EOT condition. In addition, all threads are blocked
64 * from writing on the tape by calling lock(), and thread other
65 * than the first thread to hit the EOT will block on a condition
66 * variable. The first thread to hit the EOT will continue to
67 * be able to read and write the tape (he sort of tunnels through
68 * the locking mechanism -- see lock() for details).
70 * Now presumably somewhere higher in the chain of command
71 * (device.c), someone will notice the EOT condition and
72 * get a new tape up, get the tape label read, and mark
73 * the label for rewriting. Then this higher level routine
74 * will write the unwritten buffer to the new volume.
75 * Finally, he will release
76 * any blocked threads by doing a broadcast on the condition
77 * variable. At that point, we should be totally back in
78 * business with no lost data.
85 /* Forward referenced functions */
86 int dev_is_tape(DEVICE *dev);
87 void clrerror_dev(DEVICE *dev, int func);
88 int fsr_dev(DEVICE *dev, int num);
90 extern int debug_level;
93 * Allocate and initialize the DEVICE structure
94 * Note, if dev is non-NULL, it is already allocated,
95 * thus we neither allocate it nor free it. This allows
96 * the caller to put the packet in shared memory.
98 * Note, for a tape, the dev_name is the device name
99 * (e.g. /dev/nst0), and for a file, the device name
100 * is the directory in which the file will be placed.
104 init_dev(DEVICE *dev, char *dev_name)
110 /* Check that device is available */
111 if (stat(dev_name, &statp) < 0) {
113 dev->dev_errno = errno;
115 Emsg2(M_FATAL, 0, "Unable to stat device %s : %s\n", dev_name, strerror(errno));
119 if (S_ISDIR(statp.st_mode)) {
121 } else if (S_ISCHR(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 dev_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 dev->state |= ST_TAPE;
141 dev->dev_name = (char *) get_memory(strlen(dev_name)+1);
142 strcpy(dev->dev_name, dev_name);
144 dev->errmsg = (char *) get_pool_memory(PM_EMSG);
147 if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
148 dev->dev_errno = errstat;
149 Mmsg1(&dev->errmsg, _("Unable to init mutex: ERR=%s\n"), strerror(errstat));
150 Emsg0(M_FATAL, 0, dev->errmsg);
152 if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
153 dev->dev_errno = errstat;
154 Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
155 Emsg0(M_FATAL, 0, dev->errmsg);
157 if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
158 dev->dev_errno = errstat;
159 Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
160 Emsg0(M_FATAL, 0, dev->errmsg);
163 Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
167 /* Open the device with the operating system and
168 * initialize buffer pointers.
170 * Note, for a tape, the VolName is the name we give to the
171 * volume (not really used here), but for a file, the
172 * VolName represents the name of the file to be created/opened.
173 * In the case of a file, the full name is the device name
174 * (archive_name) with the VolName concatenated.
177 open_dev(DEVICE *dev, char *VolName, int mode)
179 POOLMEM *archive_name;
181 if (dev->state & ST_OPENED) {
183 * *****FIXME***** how to handle two threads wanting
184 * different volumes mounted???? E.g. one is waiting
185 * for the next volume to be mounted, and a new job
186 * starts and snatches up the device.
188 if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
192 Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
193 dev->dev_name, dev->use_count);
194 Emsg0(M_WARNING, 0, dev->errmsg);
198 strcpy(dev->VolCatInfo.VolCatName, VolName);
201 Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
202 dev->dev_name, dev->VolCatInfo.VolCatName);
203 dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
204 if (dev->state & ST_TAPE) {
206 Dmsg0(29, "open_dev: device is tape\n");
207 if (mode == READ_WRITE) {
208 dev->mode = O_RDWR | O_BINARY;
210 dev->mode = O_RDONLY | O_BINARY;
212 timeout = dev->max_open_wait;
214 while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
215 if (errno == EBUSY && timeout-- > 0) {
216 Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
220 dev->dev_errno = errno;
221 Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
222 dev->dev_name, strerror(dev->dev_errno));
223 Emsg0(M_FATAL, 0, dev->errmsg);
228 dev->state |= ST_OPENED;
230 update_pos_dev(dev); /* update position */
232 Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
235 * Handle opening of file
237 archive_name = get_pool_memory(PM_FNAME);
238 strcpy(archive_name, dev->dev_name);
239 if (archive_name[strlen(archive_name)] != '/') {
240 strcat(archive_name, "/");
242 strcat(archive_name, VolName);
243 Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
244 if (mode == READ_WRITE) {
245 dev->mode = O_CREAT | O_RDWR | O_BINARY;
247 dev->mode = O_RDONLY | O_BINARY;
249 if ((dev->fd = open(archive_name, dev->mode, MODE_RW)) < 0) {
250 dev->dev_errno = errno;
251 Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
252 Emsg0(M_FATAL, 0, dev->errmsg);
255 dev->state |= ST_OPENED;
257 update_pos_dev(dev); /* update position */
259 Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
260 free_pool_memory(archive_name);
267 * Returns: 1 on success
270 int rewind_dev(DEVICE *dev)
275 Dmsg0(29, "rewind_dev\n");
277 dev->dev_errno = EBADF;
278 Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
280 Emsg0(M_FATAL, 0, dev->errmsg);
283 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT | ST_EOF | ST_WEOT); /* remove EOF/EOT flags */
284 dev->block_num = dev->file = 0;
286 if (dev->state & ST_TAPE) {
287 mt_com.mt_op = MTREW;
289 /* If we get an I/O error on rewind, it is probably because
290 * the drive is actually busy. We loop for (about 5 minutes)
291 * retrying every 5 seconds.
293 for (i=dev->max_rewind_wait; ; i -= 5) {
294 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
295 if (i == dev->max_rewind_wait) {
296 Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
298 clrerror_dev(dev, MTREW);
299 if (dev->dev_errno == EIO && i > 0) {
300 Dmsg0(200, "Sleeping 5 seconds.\n");
304 Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
305 dev->dev_name, strerror(dev->dev_errno));
311 if (lseek(dev->fd, 0, SEEK_SET) < 0) {
312 dev->dev_errno = errno;
313 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
314 dev->dev_name, strerror(dev->dev_errno));
322 * Position device to end of medium (end of data)
323 * Returns: 1 on succes
330 struct mtget mt_stat;
334 Dmsg0(29, "eod_dev\n");
335 if (dev->state & ST_EOT) {
338 dev->state &= ~(ST_EOF); /* remove EOF flags */
339 dev->block_num = dev->file = 0;
341 if (!(dev->state & ST_TAPE)) {
342 pos = lseek(dev->fd, 0, SEEK_END);
345 dev->state |= ST_EOT;
350 if (dev->capabilities & CAP_EOM) {
351 mt_com.mt_op = MTEOM;
353 if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
354 Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
355 clrerror_dev(dev, mt_com.mt_op);
357 Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
358 dev->dev_name, strerror(dev->dev_errno));
361 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
362 dev->dev_errno = errno;
363 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
364 dev->dev_name, strerror(dev->dev_errno));
367 Dmsg2(200, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
368 dev->file = mt_stat.mt_fileno;
371 * Rewind then use FSF until EOT reached
374 if (!rewind_dev(dev)) {
377 while (!(dev->state & ST_EOT)) {
378 Dmsg0(200, "Do fsf 1\n");
379 if (fsf_dev(dev, 1) < 0) {
380 Dmsg0(200, "fsf_dev return < 0\n");
385 update_pos_dev(dev); /* update position */
386 Dmsg1(200, "EOD dev->file=%d\n", dev->file);
391 * Set the position of the device.
392 * Returns: 1 on succes
395 int update_pos_dev(DEVICE *dev)
398 struct mtget mt_stat;
404 dev->dev_errno = EBADF;
405 Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
406 Emsg0(M_FATAL, 0, dev->errmsg);
410 /* Find out where we are */
411 if (!(dev->state & ST_TAPE)) {
414 pos = lseek(dev->fd, 0, SEEK_CUR);
416 Dmsg1(200, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
418 dev->dev_errno = errno;
419 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
420 dev->dev_name, strerror(dev->dev_errno));
427 #ifdef REALLY_IMPLEMENTED
428 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
429 Dmsg1(50, "MTIOCGET error: %s\n", strerror(dev->dev_errno));
430 dev->dev_errno = errno;
431 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
432 dev->dev_name, strerror(dev->dev_errno));
443 * Return the status of the device. This was meant
444 * to be a generic routine. Unfortunately, it doesn't
445 * seem possible (at least I do not know how to do it
446 * currently), which means that for the moment, this
447 * routine has very little value.
449 * Returns: 1 on success
453 status_dev(DEVICE *dev, uint32_t *status)
455 struct mtget mt_stat;
458 if (dev->state & (ST_EOT | ST_WEOT)) {
462 if (dev->state & ST_EOF) {
466 if (dev->state & ST_TAPE) {
468 Dmsg0(-20," Driver status:");
469 Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
470 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
471 dev->dev_errno = errno;
472 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
473 dev->dev_name, strerror(dev->dev_errno));
476 Dmsg0(-20, " Device status:");
478 #if defined(HAVE_LINUX_OS)
479 if (GMT_EOF(mt_stat.mt_gstat)) {
483 if (GMT_BOT(mt_stat.mt_gstat)) {
487 if (GMT_EOT(mt_stat.mt_gstat)) {
491 if (GMT_SM(mt_stat.mt_gstat)) {
495 if (GMT_EOD(mt_stat.mt_gstat)) {
499 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
501 Dmsg0(-20, " WR_PROT");
503 if (GMT_ONLINE(mt_stat.mt_gstat)) {
505 Dmsg0(-20, " ONLINE");
507 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
509 Dmsg0(-20, " DR_OPEN");
511 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
512 stat |= MT_IM_REP_EN;
513 Dmsg0(-20, " IM_REP_EN");
515 #endif /* !SunOS && !OSF */
516 Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
518 stat |= MT_ONLINE | MT_BOT;
526 * Load medium in device
527 * Returns: 1 on success
530 int load_dev(DEVICE *dev)
537 dev->dev_errno = EBADF;
538 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
539 Emsg0(M_FATAL, 0, dev->errmsg);
542 if (!(dev->state & ST_TAPE)) {
546 Dmsg0(200, "stored: MTLOAD command not available\n");
547 dev->dev_errno = ENOTTY; /* function not available */
548 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
549 dev->dev_name, strerror(dev->dev_errno)); return 0;
553 dev->block_num = dev->file = 0;
555 mt_com.mt_op = MTLOAD;
557 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
558 dev->dev_errno = errno;
559 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
560 dev->dev_name, strerror(dev->dev_errno)); return 0;
567 * Rewind device and put it offline
568 * Returns: 1 on success
571 int offline_dev(DEVICE *dev)
576 dev->dev_errno = EBADF;
577 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
578 Emsg0(M_FATAL, 0, dev->errmsg);
581 if (!(dev->state & ST_TAPE)) {
585 dev->block_num = dev->file = 0;
588 mt_com.mt_op = MTUNLOCK;
590 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
592 mt_com.mt_op = MTOFFL;
594 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
595 dev->dev_errno = errno;
596 Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
597 dev->dev_name, strerror(dev->dev_errno));
600 Dmsg1(100, "Offlined device %s\n", dev->dev_name);
606 * Foward space a file
609 fsf_dev(DEVICE *dev, int num)
616 dev->dev_errno = EBADF;
617 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
618 Emsg0(M_FATAL, 0, dev->errmsg);
622 if (!(dev->state & ST_TAPE)) {
625 if (dev->state & ST_EOT) {
627 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
630 if (dev->state & ST_EOF)
631 Dmsg0(200, "ST_EOF set on entry to FSF\n");
632 if (dev->state & ST_EOT)
633 Dmsg0(200, "ST_EOT set on entry to FSF\n");
635 Dmsg0(29, "fsf_dev\n");
637 if (dev->capabilities & CAP_FSF) {
638 Dmsg0(200, "FSF has cap_fsf\n");
639 mt_com.mt_op = MTFSF;
641 while (num-- && !(dev->state & ST_EOT)) {
642 Dmsg0(200, "Doing read for fsf\n");
643 if ((stat = read(dev->fd, rbuf, sizeof(rbuf))) < 0) {
644 if (errno == ENOMEM) { /* tape record exceeds buf len */
645 stat = sizeof(rbuf); /* This is OK */
647 dev->state |= ST_EOT;
648 clrerror_dev(dev, -1);
649 Dmsg1(200, "Set ST_EOT read error %d\n", dev->dev_errno);
650 Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
651 dev->dev_name, strerror(dev->dev_errno));
652 Dmsg1(200, "%s", dev->errmsg);
656 if (stat == 0) { /* EOF */
658 Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
659 /* Two reads of zero means end of tape */
660 if (dev->state & ST_EOF) {
661 dev->state |= ST_EOT;
662 Dmsg0(200, "Set ST_EOT\n");
665 dev->state |= ST_EOF;
670 } else { /* Got data */
671 dev->state &= ~(ST_EOF|ST_EOT);
674 Dmsg0(200, "Doing MT_FSF\n");
675 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
676 if (stat < 0) { /* error => EOT */
677 dev->state |= ST_EOT;
678 Dmsg0(200, "Set ST_EOT\n");
679 clrerror_dev(dev, MTFSF);
680 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
681 dev->dev_name, strerror(dev->dev_errno));
682 Dmsg0(200, "Got < 0 for MT_FSF\n");
683 Dmsg1(200, "%s", dev->errmsg);
685 dev->state |= ST_EOF; /* just read EOF */
692 * No FSF, so use FSR to simulate it
695 Dmsg0(200, "Doing FSR for FSF\n");
696 while (num-- && !(dev->state & ST_EOT)) {
697 fsr_dev(dev, INT32_MAX); /* returns -1 on EOF or EOT */
699 if (dev->state & ST_EOT) {
701 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
708 Dmsg1(200, "Return %d from FSF\n", stat);
709 if (dev->state & ST_EOF)
710 Dmsg0(200, "ST_EOF set on exit FSF\n");
711 if (dev->state & ST_EOT)
712 Dmsg0(200, "ST_EOT set on exit FSF\n");
713 Dmsg1(200, "Return from FSF file=%d\n", dev->file);
718 * Backward space a file
721 bsf_dev(DEVICE *dev, int num)
727 dev->dev_errno = EBADF;
728 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
729 Emsg0(M_FATAL, 0, dev->errmsg);
733 if (!(dev->state & ST_TAPE)) {
736 Dmsg0(29, "bsf_dev\n");
737 dev->state &= ~(ST_EOT|ST_EOF);
740 mt_com.mt_op = MTBSF;
741 mt_com.mt_count = num;
742 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
744 clrerror_dev(dev, MTBSF);
745 Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
746 dev->dev_name, strerror(dev->dev_errno));
754 * Foward space a record
757 fsr_dev(DEVICE *dev, int num)
763 dev->dev_errno = EBADF;
764 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
765 Emsg0(M_FATAL, 0, dev->errmsg);
769 if (!(dev->state & ST_TAPE)) {
772 Dmsg0(29, "fsr_dev\n");
773 dev->block_num += num;
774 mt_com.mt_op = MTFSR;
775 mt_com.mt_count = num;
776 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
778 dev->state &= ~ST_EOF;
780 if (dev->state & ST_EOF) {
781 dev->state |= ST_EOT;
783 dev->state |= ST_EOF; /* assume EOF */
787 clrerror_dev(dev, MTFSR);
788 Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
789 dev->dev_name, strerror(dev->dev_errno));
796 * Backward space a record
799 bsr_dev(DEVICE *dev, int num)
805 dev->dev_errno = EBADF;
806 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
807 Emsg0(M_FATAL, 0, dev->errmsg);
811 if (!(dev->state & ST_TAPE)) {
814 Dmsg0(29, "bsr_dev\n");
815 dev->block_num -= num;
816 dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
817 mt_com.mt_op = MTBSR;
818 mt_com.mt_count = num;
819 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
821 clrerror_dev(dev, MTBSR);
822 Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
823 dev->dev_name, strerror(dev->dev_errno));
832 * Write an end of file on the device
835 weof_dev(DEVICE *dev, int num)
841 dev->dev_errno = EBADF;
842 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
843 Emsg0(M_FATAL, 0, dev->errmsg);
847 if (!(dev->state & ST_TAPE)) {
850 dev->state &= ~(ST_EOT | ST_EOF); /* remove EOF/EOT flags */
852 Dmsg0(29, "weof_dev\n");
853 mt_com.mt_op = MTWEOF;
854 mt_com.mt_count = num;
855 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
860 clrerror_dev(dev, MTWEOF);
861 Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
862 dev->dev_name, strerror(dev->dev_errno));
868 * Return string message with last error in English
869 * Be careful not to call this routine from within dev.c
870 * while editing an Mmsg(&) or you will end up in a recursive
871 * loop creating a Segmentation Violation.
874 strerror_dev(DEVICE *dev)
881 * If implemented in system, clear the tape
885 clrerror_dev(DEVICE *dev, int func)
889 dev->dev_errno = errno; /* save errno */
891 dev->VolCatInfo.VolCatErrors++;
894 if (!(dev->state & ST_TAPE)) {
897 if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
900 Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
904 dev->capabilities &= ~CAP_EOF; /* turn off feature */
908 dev->capabilities &= ~CAP_EOM; /* turn off feature */
912 dev->capabilities &= ~CAP_FSF; /* turn off feature */
916 dev->capabilities &= ~CAP_BSF; /* turn off feature */
920 dev->capabilities &= ~CAP_FSR; /* turn off feature */
924 dev->capabilities &= ~CAP_BSR; /* turn off feature */
931 dev->dev_errno = ENOSYS;
932 Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
933 Emsg0(M_ERROR, 0, dev->errmsg);
940 mt_com.mt_op = MTIOCLRERR;
942 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
943 Dmsg0(200, "Did MTIOCLRERR\n");
949 * Flush buffer contents
952 int flush_dev(DEVICE *dev)
957 static void do_close(DEVICE *dev)
960 Dmsg0(29, "really close_dev\n");
962 /* Clean up device packet so it can be reused */
964 dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
968 dev->LastBlockNumWritten = 0;
969 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
970 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
978 close_dev(DEVICE *dev)
981 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
982 Emsg0(M_FATAL, 0, dev->errmsg);
985 if (dev->fd >= 0 && dev->use_count == 1) {
988 Dmsg0(29, "close_dev but in use so leave open.\n");
994 * Used when unmounting the device
996 void force_close_dev(DEVICE *dev)
999 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1000 Emsg0(M_FATAL, 0, dev->errmsg);
1003 Dmsg0(29, "really close_dev\n");
1007 int truncate_dev(DEVICE *dev)
1009 if (dev->state & ST_TAPE) {
1012 if (ftruncate(dev->fd, 0) != 0) {
1013 Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1020 dev_is_tape(DEVICE *dev)
1022 return (dev->state & ST_TAPE) ? 1 : 0;
1026 dev_name(DEVICE *dev)
1028 return dev->dev_name;
1032 dev_vol_name(DEVICE *dev)
1034 return dev->VolCatInfo.VolCatName;
1037 uint32_t dev_block(DEVICE *dev)
1039 update_pos_dev(dev);
1040 return dev->block_num;
1043 uint32_t dev_file(DEVICE *dev)
1045 update_pos_dev(dev);
1050 * Free memory allocated for the device
1053 term_dev(DEVICE *dev)
1056 dev->dev_errno = EBADF;
1057 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1058 Emsg0(M_FATAL, 0, dev->errmsg);
1062 Dmsg0(29, "term_dev\n");
1063 if (dev->dev_name) {
1064 free_memory(dev->dev_name);
1065 dev->dev_name = NULL;
1068 free_pool_memory(dev->errmsg);
1071 pthread_mutex_destroy(&dev->mutex);
1072 pthread_cond_destroy(&dev->wait);
1073 pthread_cond_destroy(&dev->wait_next_vol);
1074 if (dev->state & ST_MALLOC) {
1075 free_pool_memory((POOLMEM *)dev);
1080 /* To make following two functions more readable */
1082 #define attached_jcrs ((JCR *)(dev->attached_jcrs))
1084 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1086 jcr->prev_dev = NULL;
1087 jcr->next_dev = attached_jcrs;
1088 if (attached_jcrs) {
1089 attached_jcrs->prev_dev = jcr;
1091 attached_jcrs = jcr;
1092 Dmsg1(000, "Attached Job %s\n", jcr->Job);
1095 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1097 if (!jcr->prev_dev) {
1098 attached_jcrs = jcr->next_dev;
1100 jcr->prev_dev->next_dev = jcr->next_dev;
1102 if (jcr->next_dev) {
1103 jcr->next_dev->prev_dev = jcr->prev_dev;
1105 jcr->next_dev = jcr->prev_dev = NULL;
1106 Dmsg1(000, "Detached Job %s\n", jcr->Job);
1109 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1112 return attached_jcrs;
1114 return jcr->next_dev;