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 = get_memory(strlen(dev_name)+1);
142 strcpy(dev->dev_name, dev_name);
144 dev->errmsg = get_pool_memory(PM_EMSG);
148 if ((errstat=rwl_init(&dev->lock)) != 0) {
149 Mmsg1(&dev->errmsg, _("Unable to initialize dev lock. ERR=%s\n"), strerror(errstat));
150 Emsg0(M_FATAL, 0, dev->errmsg);
154 if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
155 dev->dev_errno = errstat;
156 Mmsg1(&dev->errmsg, _("Unable to init mutex: ERR=%s\n"), strerror(errstat));
157 Emsg0(M_FATAL, 0, dev->errmsg);
159 if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
160 dev->dev_errno = errstat;
161 Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
162 Emsg0(M_FATAL, 0, dev->errmsg);
164 if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
165 dev->dev_errno = errstat;
166 Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
167 Emsg0(M_FATAL, 0, dev->errmsg);
170 Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
174 /* Open the device with the operating system and
175 * initialize buffer pointers.
177 * Note, for a tape, the VolName is the name we give to the
178 * volume (not really used here), but for a file, the
179 * VolName represents the name of the file to be created/opened.
180 * In the case of a file, the full name is the device name
181 * (archive_name) with the VolName concatenated.
184 open_dev(DEVICE *dev, char *VolName, int mode)
186 POOLMEM *archive_name;
188 if (dev->state & ST_OPENED) {
190 * *****FIXME***** how to handle two threads wanting
191 * different volumes mounted???? E.g. one is waiting
192 * for the next volume to be mounted, and a new job
193 * starts and snatches up the device.
195 if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
199 Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
200 dev->dev_name, dev->use_count);
201 Emsg0(M_WARNING, 0, dev->errmsg);
205 strcpy(dev->VolCatInfo.VolCatName, VolName);
208 Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
209 dev->dev_name, dev->VolCatInfo.VolCatName);
210 dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
211 if (dev->state & ST_TAPE) {
213 Dmsg0(29, "open_dev: device is tape\n");
214 if (mode == READ_WRITE) {
215 dev->mode = O_RDWR | O_BINARY;
217 dev->mode = O_RDONLY | O_BINARY;
219 timeout = dev->max_open_wait;
221 while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
222 if (errno == EBUSY && timeout-- > 0) {
223 Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
227 dev->dev_errno = errno;
228 Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
229 dev->dev_name, strerror(dev->dev_errno));
230 Emsg0(M_FATAL, 0, dev->errmsg);
235 dev->state |= ST_OPENED;
237 update_pos_dev(dev); /* update position */
239 Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
242 * Handle opening of file
244 archive_name = get_pool_memory(PM_FNAME);
245 strcpy(archive_name, dev->dev_name);
246 if (archive_name[strlen(archive_name)] != '/') {
247 strcat(archive_name, "/");
249 strcat(archive_name, VolName);
250 Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
251 if (mode == READ_WRITE) {
252 dev->mode = O_CREAT | O_RDWR | O_BINARY;
254 dev->mode = O_RDONLY | O_BINARY;
256 if ((dev->fd = open(archive_name, dev->mode, MODE_RW)) < 0) {
257 dev->dev_errno = errno;
258 Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
259 Emsg0(M_FATAL, 0, dev->errmsg);
262 dev->state |= ST_OPENED;
264 update_pos_dev(dev); /* update position */
266 Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
267 free_pool_memory(archive_name);
274 * Returns: 1 on success
277 int rewind_dev(DEVICE *dev)
282 Dmsg0(29, "rewind_dev\n");
284 dev->dev_errno = EBADF;
285 Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
287 Emsg0(M_FATAL, 0, dev->errmsg);
290 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT | ST_EOF | ST_WEOT); /* remove EOF/EOT flags */
291 dev->block_num = dev->file = 0;
293 if (dev->state & ST_TAPE) {
294 mt_com.mt_op = MTREW;
296 /* If we get an I/O error on rewind, it is probably because
297 * the drive is actually busy. We loop for (about 5 minutes)
298 * retrying every 5 seconds.
300 for (i=dev->max_rewind_wait; ; i -= 5) {
301 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
302 if (i == dev->max_rewind_wait) {
303 Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
305 clrerror_dev(dev, MTREW);
306 if (dev->dev_errno == EIO && i > 0) {
307 Dmsg0(200, "Sleeping 5 seconds.\n");
311 Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
312 dev->dev_name, strerror(dev->dev_errno));
318 if (lseek(dev->fd, (off_t)0, SEEK_SET) < 0) {
319 dev->dev_errno = errno;
320 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
321 dev->dev_name, strerror(dev->dev_errno));
329 * Position device to end of medium (end of data)
330 * Returns: 1 on succes
337 struct mtget mt_stat;
341 Dmsg0(29, "eod_dev\n");
342 if (dev->state & ST_EOT) {
345 dev->state &= ~(ST_EOF); /* remove EOF flags */
346 dev->block_num = dev->file = 0;
348 if (!(dev->state & ST_TAPE)) {
349 pos = lseek(dev->fd, (off_t)0, SEEK_END);
350 // Dmsg1(000, "====== Seek to %lld\n", pos);
353 dev->state |= ST_EOT;
358 if (dev->capabilities & CAP_EOM) {
359 mt_com.mt_op = MTEOM;
361 if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
362 Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
363 clrerror_dev(dev, mt_com.mt_op);
365 Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
366 dev->dev_name, strerror(dev->dev_errno));
369 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
370 dev->dev_errno = errno;
371 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
372 dev->dev_name, strerror(dev->dev_errno));
375 Dmsg2(200, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
376 dev->file = mt_stat.mt_fileno;
379 * Rewind then use FSF until EOT reached
382 if (!rewind_dev(dev)) {
385 while (!(dev->state & ST_EOT)) {
386 Dmsg0(200, "Do fsf 1\n");
387 if (fsf_dev(dev, 1) < 0) {
388 Dmsg0(200, "fsf_dev return < 0\n");
393 update_pos_dev(dev); /* update position */
394 Dmsg1(200, "EOD dev->file=%d\n", dev->file);
399 * Set the position of the device.
400 * Returns: 1 on succes
403 int update_pos_dev(DEVICE *dev)
406 struct mtget mt_stat;
412 dev->dev_errno = EBADF;
413 Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
414 Emsg0(M_FATAL, 0, dev->errmsg);
418 /* Find out where we are */
419 if (!(dev->state & ST_TAPE)) {
422 pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
424 Dmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
425 dev->dev_errno = errno;
426 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
427 dev->dev_name, strerror(dev->dev_errno));
430 dev->file_bytes = pos;
435 #ifdef REALLY_IMPLEMENTED
436 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
437 Dmsg1(50, "MTIOCGET error: %s\n", strerror(dev->dev_errno));
438 dev->dev_errno = errno;
439 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
440 dev->dev_name, strerror(dev->dev_errno));
451 * Return the status of the device. This was meant
452 * to be a generic routine. Unfortunately, it doesn't
453 * seem possible (at least I do not know how to do it
454 * currently), which means that for the moment, this
455 * routine has very little value.
457 * Returns: 1 on success
461 status_dev(DEVICE *dev, uint32_t *status)
463 struct mtget mt_stat;
466 if (dev->state & (ST_EOT | ST_WEOT)) {
470 if (dev->state & ST_EOF) {
474 if (dev->state & ST_TAPE) {
476 Dmsg0(-20," Driver status:");
477 Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
478 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
479 dev->dev_errno = errno;
480 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
481 dev->dev_name, strerror(dev->dev_errno));
484 Dmsg0(-20, " Device status:");
486 #if defined(HAVE_LINUX_OS)
487 if (GMT_EOF(mt_stat.mt_gstat)) {
491 if (GMT_BOT(mt_stat.mt_gstat)) {
495 if (GMT_EOT(mt_stat.mt_gstat)) {
499 if (GMT_SM(mt_stat.mt_gstat)) {
503 if (GMT_EOD(mt_stat.mt_gstat)) {
507 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
509 Dmsg0(-20, " WR_PROT");
511 if (GMT_ONLINE(mt_stat.mt_gstat)) {
513 Dmsg0(-20, " ONLINE");
515 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
517 Dmsg0(-20, " DR_OPEN");
519 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
520 stat |= MT_IM_REP_EN;
521 Dmsg0(-20, " IM_REP_EN");
523 #endif /* !SunOS && !OSF */
524 Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
526 stat |= MT_ONLINE | MT_BOT;
534 * Load medium in device
535 * Returns: 1 on success
538 int load_dev(DEVICE *dev)
545 dev->dev_errno = EBADF;
546 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
547 Emsg0(M_FATAL, 0, dev->errmsg);
550 if (!(dev->state & ST_TAPE)) {
554 Dmsg0(200, "stored: MTLOAD command not available\n");
555 dev->dev_errno = ENOTTY; /* function not available */
556 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
557 dev->dev_name, strerror(dev->dev_errno)); return 0;
561 dev->block_num = dev->file = 0;
563 mt_com.mt_op = MTLOAD;
565 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
566 dev->dev_errno = errno;
567 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
568 dev->dev_name, strerror(dev->dev_errno)); return 0;
575 * Rewind device and put it offline
576 * Returns: 1 on success
579 int offline_dev(DEVICE *dev)
584 dev->dev_errno = EBADF;
585 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
586 Emsg0(M_FATAL, 0, dev->errmsg);
589 if (!(dev->state & ST_TAPE)) {
593 dev->block_num = dev->file = 0;
596 mt_com.mt_op = MTUNLOCK;
598 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
600 mt_com.mt_op = MTOFFL;
602 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
603 dev->dev_errno = errno;
604 Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
605 dev->dev_name, strerror(dev->dev_errno));
608 Dmsg1(100, "Offlined device %s\n", dev->dev_name);
614 * Foward space a file
617 fsf_dev(DEVICE *dev, int num)
624 dev->dev_errno = EBADF;
625 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
626 Emsg0(M_FATAL, 0, dev->errmsg);
630 if (!(dev->state & ST_TAPE)) {
633 if (dev->state & ST_EOT) {
635 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
638 if (dev->state & ST_EOF)
639 Dmsg0(200, "ST_EOF set on entry to FSF\n");
640 if (dev->state & ST_EOT)
641 Dmsg0(200, "ST_EOT set on entry to FSF\n");
643 Dmsg0(29, "fsf_dev\n");
645 if (dev->capabilities & CAP_FSF) {
646 Dmsg0(200, "FSF has cap_fsf\n");
647 mt_com.mt_op = MTFSF;
649 while (num-- && !(dev->state & ST_EOT)) {
650 Dmsg0(200, "Doing read for fsf\n");
651 if ((stat = read(dev->fd, rbuf, sizeof(rbuf))) < 0) {
652 if (errno == ENOMEM) { /* tape record exceeds buf len */
653 stat = sizeof(rbuf); /* This is OK */
655 dev->state |= ST_EOT;
656 clrerror_dev(dev, -1);
657 Dmsg1(200, "Set ST_EOT read error %d\n", dev->dev_errno);
658 Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
659 dev->dev_name, strerror(dev->dev_errno));
660 Dmsg1(200, "%s", dev->errmsg);
664 if (stat == 0) { /* EOF */
666 Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
667 /* Two reads of zero means end of tape */
668 if (dev->state & ST_EOF) {
669 dev->state |= ST_EOT;
670 Dmsg0(200, "Set ST_EOT\n");
673 dev->state |= ST_EOF;
678 } else { /* Got data */
679 dev->state &= ~(ST_EOF|ST_EOT);
682 Dmsg0(200, "Doing MT_FSF\n");
683 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
684 if (stat < 0) { /* error => EOT */
685 dev->state |= ST_EOT;
686 Dmsg0(200, "Set ST_EOT\n");
687 clrerror_dev(dev, MTFSF);
688 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
689 dev->dev_name, strerror(dev->dev_errno));
690 Dmsg0(200, "Got < 0 for MT_FSF\n");
691 Dmsg1(200, "%s", dev->errmsg);
693 dev->state |= ST_EOF; /* just read EOF */
700 * No FSF, so use FSR to simulate it
703 Dmsg0(200, "Doing FSR for FSF\n");
704 while (num-- && !(dev->state & ST_EOT)) {
705 fsr_dev(dev, INT32_MAX); /* returns -1 on EOF or EOT */
707 if (dev->state & ST_EOT) {
709 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
716 Dmsg1(200, "Return %d from FSF\n", stat);
717 if (dev->state & ST_EOF)
718 Dmsg0(200, "ST_EOF set on exit FSF\n");
719 if (dev->state & ST_EOT)
720 Dmsg0(200, "ST_EOT set on exit FSF\n");
721 Dmsg1(200, "Return from FSF file=%d\n", dev->file);
726 * Backward space a file
729 bsf_dev(DEVICE *dev, int num)
735 dev->dev_errno = EBADF;
736 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
737 Emsg0(M_FATAL, 0, dev->errmsg);
741 if (!(dev->state & ST_TAPE)) {
744 Dmsg0(29, "bsf_dev\n");
745 dev->state &= ~(ST_EOT|ST_EOF);
748 mt_com.mt_op = MTBSF;
749 mt_com.mt_count = num;
750 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
752 clrerror_dev(dev, MTBSF);
753 Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
754 dev->dev_name, strerror(dev->dev_errno));
762 * Foward space a record
765 fsr_dev(DEVICE *dev, int num)
771 dev->dev_errno = EBADF;
772 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
773 Emsg0(M_FATAL, 0, dev->errmsg);
777 if (!(dev->state & ST_TAPE)) {
780 Dmsg0(29, "fsr_dev\n");
781 dev->block_num += num;
782 mt_com.mt_op = MTFSR;
783 mt_com.mt_count = num;
784 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
786 dev->state &= ~ST_EOF;
788 if (dev->state & ST_EOF) {
789 dev->state |= ST_EOT;
791 dev->state |= ST_EOF; /* assume EOF */
795 clrerror_dev(dev, MTFSR);
796 Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
797 dev->dev_name, strerror(dev->dev_errno));
804 * Backward space a record
807 bsr_dev(DEVICE *dev, int num)
813 dev->dev_errno = EBADF;
814 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
815 Emsg0(M_FATAL, 0, dev->errmsg);
819 if (!(dev->state & ST_TAPE)) {
822 Dmsg0(29, "bsr_dev\n");
823 dev->block_num -= num;
824 dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
825 mt_com.mt_op = MTBSR;
826 mt_com.mt_count = num;
827 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
829 clrerror_dev(dev, MTBSR);
830 Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
831 dev->dev_name, strerror(dev->dev_errno));
840 * Write an end of file on the device
843 weof_dev(DEVICE *dev, int num)
849 dev->dev_errno = EBADF;
850 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
851 Emsg0(M_FATAL, 0, dev->errmsg);
855 if (!(dev->state & ST_TAPE)) {
858 dev->state &= ~(ST_EOT | ST_EOF); /* remove EOF/EOT flags */
860 Dmsg0(29, "weof_dev\n");
861 mt_com.mt_op = MTWEOF;
862 mt_com.mt_count = num;
863 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
868 clrerror_dev(dev, MTWEOF);
869 Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
870 dev->dev_name, strerror(dev->dev_errno));
876 * Return string message with last error in English
877 * Be careful not to call this routine from within dev.c
878 * while editing an Mmsg(&) or you will end up in a recursive
879 * loop creating a Segmentation Violation.
882 strerror_dev(DEVICE *dev)
889 * If implemented in system, clear the tape
893 clrerror_dev(DEVICE *dev, int func)
897 dev->dev_errno = errno; /* save errno */
899 dev->VolCatInfo.VolCatErrors++;
902 if (!(dev->state & ST_TAPE)) {
905 if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
908 Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
912 dev->capabilities &= ~CAP_EOF; /* turn off feature */
916 dev->capabilities &= ~CAP_EOM; /* turn off feature */
920 dev->capabilities &= ~CAP_FSF; /* turn off feature */
924 dev->capabilities &= ~CAP_BSF; /* turn off feature */
928 dev->capabilities &= ~CAP_FSR; /* turn off feature */
932 dev->capabilities &= ~CAP_BSR; /* turn off feature */
939 dev->dev_errno = ENOSYS;
940 Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
941 Emsg0(M_ERROR, 0, dev->errmsg);
948 mt_com.mt_op = MTIOCLRERR;
950 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
951 Dmsg0(200, "Did MTIOCLRERR\n");
957 * Flush buffer contents
960 int flush_dev(DEVICE *dev)
965 static void do_close(DEVICE *dev)
968 Dmsg0(29, "really close_dev\n");
970 /* Clean up device packet so it can be reused */
972 dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
976 dev->LastBlockNumWritten = 0;
977 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
978 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
986 close_dev(DEVICE *dev)
989 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
990 Emsg0(M_FATAL, 0, dev->errmsg);
993 if (dev->fd >= 0 && dev->use_count == 1) {
996 Dmsg0(29, "close_dev but in use so leave open.\n");
1002 * Used when unmounting the device
1004 void force_close_dev(DEVICE *dev)
1007 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1008 Emsg0(M_FATAL, 0, dev->errmsg);
1011 Dmsg0(29, "really close_dev\n");
1015 int truncate_dev(DEVICE *dev)
1017 if (dev->state & ST_TAPE) {
1020 if (ftruncate(dev->fd, 0) != 0) {
1021 Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1028 dev_is_tape(DEVICE *dev)
1030 return (dev->state & ST_TAPE) ? 1 : 0;
1034 dev_name(DEVICE *dev)
1036 return dev->dev_name;
1040 dev_vol_name(DEVICE *dev)
1042 return dev->VolCatInfo.VolCatName;
1045 uint32_t dev_block(DEVICE *dev)
1047 update_pos_dev(dev);
1048 return dev->block_num;
1051 uint32_t dev_file(DEVICE *dev)
1053 update_pos_dev(dev);
1058 * Free memory allocated for the device
1061 term_dev(DEVICE *dev)
1064 dev->dev_errno = EBADF;
1065 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1066 Emsg0(M_FATAL, 0, dev->errmsg);
1070 Dmsg0(29, "term_dev\n");
1071 if (dev->dev_name) {
1072 free_memory(dev->dev_name);
1073 dev->dev_name = NULL;
1076 free_pool_memory(dev->errmsg);
1080 rwl_destroy(&dev->lock);
1082 pthread_mutex_destroy(&dev->mutex);
1083 pthread_cond_destroy(&dev->wait);
1084 pthread_cond_destroy(&dev->wait_next_vol);
1085 if (dev->state & ST_MALLOC) {
1086 free_pool_memory((POOLMEM *)dev);
1091 /* To make following two functions more readable */
1093 #define attached_jcrs ((JCR *)(dev->attached_jcrs))
1095 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1097 jcr->prev_dev = NULL;
1098 jcr->next_dev = attached_jcrs;
1099 if (attached_jcrs) {
1100 attached_jcrs->prev_dev = jcr;
1102 attached_jcrs = jcr;
1103 Dmsg1(100, "Attached Job %s\n", jcr->Job);
1106 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1108 if (!jcr->prev_dev) {
1109 attached_jcrs = jcr->next_dev;
1111 jcr->prev_dev->next_dev = jcr->next_dev;
1113 if (jcr->next_dev) {
1114 jcr->next_dev->prev_dev = jcr->prev_dev;
1116 jcr->next_dev = jcr->prev_dev = NULL;
1117 Dmsg1(100, "Detached Job %s\n", jcr->Job);
1120 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1123 return attached_jcrs;
1125 return jcr->next_dev;