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 device->device_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, DEVRES *device)
110 /* Check that device is available */
111 if (stat(device->device_name, &statp) < 0) {
113 dev->dev_errno = errno;
115 Emsg2(M_FATAL, 0, "Unable to stat device %s : %s\n", device->device_name,
121 if (S_ISDIR(statp.st_mode)) {
123 } else if (S_ISCHR(statp.st_mode)) {
125 } else if (S_ISFIFO(statp.st_mode)) {
129 dev->dev_errno = ENODEV;
131 Emsg2(M_FATAL, 0, _("%s is an unknown device type. Must be tape or directory. st_mode=%x\n"),
132 dev_name, statp.st_mode);
136 dev = (DEVICE *)get_memory(sizeof(DEVICE));
137 memset(dev, 0, sizeof(DEVICE));
138 dev->state = ST_MALLOC;
140 memset(dev, 0, sizeof(DEVICE));
143 /* Copy user supplied device parameters from Resource */
144 dev->dev_name = get_memory(strlen(device->device_name)+1);
145 strcpy(dev->dev_name, device->device_name);
146 dev->capabilities = device->cap_bits;
147 dev->min_block_size = device->min_block_size;
148 dev->max_block_size = device->max_block_size;
149 dev->max_volume_jobs = device->max_volume_jobs;
150 dev->max_volume_files = device->max_volume_files;
151 dev->max_volume_size = device->max_volume_size;
152 dev->max_file_size = device->max_file_size;
153 dev->volume_capacity = device->volume_capacity;
154 dev->max_rewind_wait = device->max_rewind_wait;
155 dev->max_open_wait = device->max_open_wait;
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);
196 Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
200 /* Open the device with the operating system and
201 * initialize buffer pointers.
203 * Note, for a tape, the VolName is the name we give to the
204 * volume (not really used here), but for a file, the
205 * VolName represents the name of the file to be created/opened.
206 * In the case of a file, the full name is the device name
207 * (archive_name) with the VolName concatenated.
210 open_dev(DEVICE *dev, char *VolName, int mode)
212 POOLMEM *archive_name;
214 if (dev->state & ST_OPENED) {
216 * *****FIXME***** how to handle two threads wanting
217 * different volumes mounted???? E.g. one is waiting
218 * for the next volume to be mounted, and a new job
219 * starts and snatches up the device.
221 if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
225 Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
226 dev->dev_name, dev->use_count);
227 Emsg0(M_WARNING, 0, dev->errmsg);
231 strcpy(dev->VolCatInfo.VolCatName, VolName);
234 Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
235 dev->dev_name, dev->VolCatInfo.VolCatName);
236 dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
237 if (dev->state & (ST_TAPE|ST_FIFO)) {
239 Dmsg0(29, "open_dev: device is tape\n");
240 if (mode == READ_WRITE) {
241 dev->mode = O_RDWR | O_BINARY;
243 dev->mode = O_RDONLY | O_BINARY;
245 timeout = dev->max_open_wait;
247 while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
248 if (errno == EBUSY && timeout-- > 0) {
249 Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
253 dev->dev_errno = errno;
254 Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
255 dev->dev_name, strerror(dev->dev_errno));
256 Emsg0(M_FATAL, 0, dev->errmsg);
261 dev->state |= ST_OPENED;
263 update_pos_dev(dev); /* update position */
265 Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
268 * Handle opening of file
270 archive_name = get_pool_memory(PM_FNAME);
271 pm_strcpy(&archive_name, dev->dev_name);
272 if (archive_name[strlen(archive_name)] != '/') {
273 pm_strcat(&archive_name, "/");
275 pm_strcat(&archive_name, VolName);
276 Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
277 if (mode == READ_WRITE) {
278 dev->mode = O_CREAT | O_RDWR | O_BINARY;
280 dev->mode = O_RDONLY | O_BINARY;
282 if ((dev->fd = open(archive_name, dev->mode, MODE_RW)) < 0) {
283 dev->dev_errno = errno;
284 Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
285 Emsg0(M_FATAL, 0, dev->errmsg);
288 dev->state |= ST_OPENED;
290 update_pos_dev(dev); /* update position */
292 Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
293 free_pool_memory(archive_name);
300 * Returns: 1 on success
303 int rewind_dev(DEVICE *dev)
308 Dmsg0(29, "rewind_dev\n");
310 dev->dev_errno = EBADF;
311 Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
313 Emsg0(M_FATAL, 0, dev->errmsg);
316 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT | ST_EOF | ST_WEOT); /* remove EOF/EOT flags */
317 dev->block_num = dev->file = 0;
319 if (dev->state & ST_TAPE) {
320 mt_com.mt_op = MTREW;
322 /* If we get an I/O error on rewind, it is probably because
323 * the drive is actually busy. We loop for (about 5 minutes)
324 * retrying every 5 seconds.
326 for (i=dev->max_rewind_wait; ; i -= 5) {
327 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
328 if (i == dev->max_rewind_wait) {
329 Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
331 clrerror_dev(dev, MTREW);
332 if (dev->dev_errno == EIO && i > 0) {
333 Dmsg0(200, "Sleeping 5 seconds.\n");
337 Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
338 dev->dev_name, strerror(dev->dev_errno));
343 } else if (dev->state & ST_FILE) {
344 if (lseek(dev->fd, (off_t)0, SEEK_SET) < 0) {
345 dev->dev_errno = errno;
346 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
347 dev->dev_name, strerror(dev->dev_errno));
355 * Position device to end of medium (end of data)
356 * Returns: 1 on succes
363 struct mtget mt_stat;
367 Dmsg0(29, "eod_dev\n");
368 if (dev->state & ST_EOT) {
371 dev->state &= ~(ST_EOF); /* remove EOF flags */
372 dev->block_num = dev->file = 0;
374 if (dev->state & (ST_FIFO | ST_PROG)) {
377 if (!(dev->state & ST_TAPE)) {
378 pos = lseek(dev->fd, (off_t)0, SEEK_END);
379 // Dmsg1(000, "====== Seek to %lld\n", pos);
382 dev->state |= ST_EOT;
387 if (dev->capabilities & CAP_EOM) {
388 mt_com.mt_op = MTEOM;
390 if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
391 Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
392 clrerror_dev(dev, mt_com.mt_op);
394 Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
395 dev->dev_name, strerror(dev->dev_errno));
398 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
399 dev->dev_errno = errno;
400 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
401 dev->dev_name, strerror(dev->dev_errno));
404 Dmsg2(200, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
405 dev->file = mt_stat.mt_fileno;
408 * Rewind then use FSF until EOT reached
411 if (!rewind_dev(dev)) {
414 while (!(dev->state & ST_EOT)) {
415 Dmsg0(200, "Do fsf 1\n");
416 if (!fsf_dev(dev, 1)) {
417 Dmsg0(200, "fsf_dev error.\n");
422 update_pos_dev(dev); /* update position */
423 Dmsg1(200, "EOD dev->file=%d\n", dev->file);
428 * Set the position of the device -- only for files
429 * For other devices, there is no generic way to do it.
430 * Returns: 1 on succes
433 int update_pos_dev(DEVICE *dev)
439 dev->dev_errno = EBADF;
440 Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
441 Emsg0(M_FATAL, 0, dev->errmsg);
445 /* Find out where we are */
446 if (dev->state & ST_FILE) {
449 pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
451 Dmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
452 dev->dev_errno = errno;
453 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
454 dev->dev_name, strerror(dev->dev_errno));
457 dev->file_addr = pos;
466 * Return the status of the device. This was meant
467 * to be a generic routine. Unfortunately, it doesn't
468 * seem possible (at least I do not know how to do it
469 * currently), which means that for the moment, this
470 * routine has very little value.
472 * Returns: 1 on success
476 status_dev(DEVICE *dev, uint32_t *status)
478 struct mtget mt_stat;
481 if (dev->state & (ST_EOT | ST_WEOT)) {
485 if (dev->state & ST_EOF) {
489 if (dev->state & ST_TAPE) {
491 Dmsg0(-20," Driver status:");
492 Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
493 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
494 dev->dev_errno = errno;
495 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
496 dev->dev_name, strerror(dev->dev_errno));
499 Dmsg0(-20, " Device status:");
501 #if defined(HAVE_LINUX_OS)
502 if (GMT_EOF(mt_stat.mt_gstat)) {
506 if (GMT_BOT(mt_stat.mt_gstat)) {
510 if (GMT_EOT(mt_stat.mt_gstat)) {
514 if (GMT_SM(mt_stat.mt_gstat)) {
518 if (GMT_EOD(mt_stat.mt_gstat)) {
522 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
524 Dmsg0(-20, " WR_PROT");
526 if (GMT_ONLINE(mt_stat.mt_gstat)) {
528 Dmsg0(-20, " ONLINE");
530 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
532 Dmsg0(-20, " DR_OPEN");
534 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
535 stat |= MT_IM_REP_EN;
536 Dmsg0(-20, " IM_REP_EN");
538 #endif /* !SunOS && !OSF */
539 Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
541 stat |= MT_ONLINE | MT_BOT;
549 * Load medium in device
550 * Returns: 1 on success
553 int load_dev(DEVICE *dev)
560 dev->dev_errno = EBADF;
561 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
562 Emsg0(M_FATAL, 0, dev->errmsg);
565 if (!(dev->state & ST_TAPE)) {
569 Dmsg0(200, "stored: MTLOAD command not available\n");
570 dev->dev_errno = ENOTTY; /* function not available */
571 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
572 dev->dev_name, strerror(dev->dev_errno)); return 0;
576 dev->block_num = dev->file = 0;
578 mt_com.mt_op = MTLOAD;
580 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
581 dev->dev_errno = errno;
582 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
583 dev->dev_name, strerror(dev->dev_errno)); return 0;
590 * Rewind device and put it offline
591 * Returns: 1 on success
594 int offline_dev(DEVICE *dev)
599 dev->dev_errno = EBADF;
600 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
601 Emsg0(M_FATAL, 0, dev->errmsg);
604 if (!(dev->state & ST_TAPE)) {
608 dev->block_num = dev->file = 0;
611 mt_com.mt_op = MTUNLOCK;
613 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
615 mt_com.mt_op = MTOFFL;
617 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
618 dev->dev_errno = errno;
619 Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
620 dev->dev_name, strerror(dev->dev_errno));
623 Dmsg1(100, "Offlined device %s\n", dev->dev_name);
629 * Foward space a file
630 * Returns: 1 on success
634 fsf_dev(DEVICE *dev, int num)
641 dev->dev_errno = EBADF;
642 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
643 Emsg0(M_FATAL, 0, dev->errmsg);
647 if (!(dev->state & ST_TAPE)) {
650 if (dev->state & ST_EOT) {
652 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
655 if (dev->state & ST_EOF)
656 Dmsg0(200, "ST_EOF set on entry to FSF\n");
657 if (dev->state & ST_EOT)
658 Dmsg0(200, "ST_EOT set on entry to FSF\n");
660 Dmsg0(29, "fsf_dev\n");
662 if (dev->capabilities & CAP_FSF) {
663 Dmsg0(200, "FSF has cap_fsf\n");
664 mt_com.mt_op = MTFSF;
666 while (num-- && !(dev->state & ST_EOT)) {
667 Dmsg0(200, "Doing read for fsf\n");
668 if ((stat = read(dev->fd, rbuf, sizeof(rbuf))) < 0) {
669 if (errno == ENOMEM) { /* tape record exceeds buf len */
670 stat = sizeof(rbuf); /* This is OK */
672 dev->state |= ST_EOT;
673 clrerror_dev(dev, -1);
674 Dmsg1(200, "Set ST_EOT read error %d\n", dev->dev_errno);
675 Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
676 dev->dev_name, strerror(dev->dev_errno));
677 Dmsg1(200, "%s", dev->errmsg);
681 if (stat == 0) { /* EOF */
683 Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
684 /* Two reads of zero means end of tape */
685 if (dev->state & ST_EOF) {
686 dev->state |= ST_EOT;
687 Dmsg0(200, "Set ST_EOT\n");
690 dev->state |= ST_EOF;
695 } else { /* Got data */
696 dev->state &= ~(ST_EOF|ST_EOT);
699 Dmsg0(200, "Doing MT_FSF\n");
700 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
701 if (stat < 0) { /* error => EOT */
702 dev->state |= ST_EOT;
703 Dmsg0(200, "Set ST_EOT\n");
704 clrerror_dev(dev, MTFSF);
705 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
706 dev->dev_name, strerror(dev->dev_errno));
707 Dmsg0(200, "Got < 0 for MT_FSF\n");
708 Dmsg1(200, "%s", dev->errmsg);
710 dev->state |= ST_EOF; /* just read EOF */
717 * No FSF, so use FSR to simulate it
720 Dmsg0(200, "Doing FSR for FSF\n");
721 while (num-- && !(dev->state & ST_EOT)) {
722 fsr_dev(dev, INT32_MAX); /* returns -1 on EOF or EOT */
724 if (dev->state & ST_EOT) {
726 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
733 Dmsg1(200, "Return %d from FSF\n", stat);
734 if (dev->state & ST_EOF)
735 Dmsg0(200, "ST_EOF set on exit FSF\n");
736 if (dev->state & ST_EOT)
737 Dmsg0(200, "ST_EOT set on exit FSF\n");
738 Dmsg1(200, "Return from FSF file=%d\n", dev->file);
739 return stat == 0 ? 1 : 0;
743 * Backward space a file
746 bsf_dev(DEVICE *dev, int num)
752 dev->dev_errno = EBADF;
753 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
754 Emsg0(M_FATAL, 0, dev->errmsg);
758 if (!(dev->state & ST_TAPE)) {
761 Dmsg0(29, "bsf_dev\n");
762 dev->state &= ~(ST_EOT|ST_EOF);
765 mt_com.mt_op = MTBSF;
766 mt_com.mt_count = num;
767 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
769 clrerror_dev(dev, MTBSF);
770 Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
771 dev->dev_name, strerror(dev->dev_errno));
779 * Foward space a record
782 fsr_dev(DEVICE *dev, int num)
788 dev->dev_errno = EBADF;
789 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
790 Emsg0(M_FATAL, 0, dev->errmsg);
794 if (!(dev->state & ST_TAPE)) {
797 Dmsg0(29, "fsr_dev\n");
798 dev->block_num += num;
799 mt_com.mt_op = MTFSR;
800 mt_com.mt_count = num;
801 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
803 dev->state &= ~ST_EOF;
805 if (dev->state & ST_EOF) {
806 dev->state |= ST_EOT;
808 dev->state |= ST_EOF; /* assume EOF */
812 clrerror_dev(dev, MTFSR);
813 Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
814 dev->dev_name, strerror(dev->dev_errno));
821 * Backward space a record
822 * Returns: 0 on success
826 bsr_dev(DEVICE *dev, int num)
832 dev->dev_errno = EBADF;
833 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
834 Emsg0(M_FATAL, 0, dev->errmsg);
838 if (!(dev->state & ST_TAPE)) {
841 Dmsg0(29, "bsr_dev\n");
842 dev->block_num -= num;
843 dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
844 mt_com.mt_op = MTBSR;
845 mt_com.mt_count = num;
846 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
848 clrerror_dev(dev, MTBSR);
849 Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
850 dev->dev_name, strerror(dev->dev_errno));
859 * Write an end of file on the device
862 weof_dev(DEVICE *dev, int num)
868 dev->dev_errno = EBADF;
869 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
870 Emsg0(M_FATAL, 0, dev->errmsg);
874 if (!(dev->state & ST_TAPE)) {
877 dev->state &= ~(ST_EOT | ST_EOF); /* remove EOF/EOT flags */
879 Dmsg0(29, "weof_dev\n");
880 mt_com.mt_op = MTWEOF;
881 mt_com.mt_count = num;
882 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
887 clrerror_dev(dev, MTWEOF);
888 Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
889 dev->dev_name, strerror(dev->dev_errno));
895 * Return string message with last error in English
896 * Be careful not to call this routine from within dev.c
897 * while editing an Mmsg(&) or you will end up in a recursive
898 * loop creating a Segmentation Violation.
901 strerror_dev(DEVICE *dev)
908 * If implemented in system, clear the tape
912 clrerror_dev(DEVICE *dev, int func)
916 dev->dev_errno = errno; /* save errno */
918 dev->VolCatInfo.VolCatErrors++;
921 if (!(dev->state & ST_TAPE)) {
924 if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
927 Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
931 dev->capabilities &= ~CAP_EOF; /* turn off feature */
935 dev->capabilities &= ~CAP_EOM; /* turn off feature */
939 dev->capabilities &= ~CAP_FSF; /* turn off feature */
943 dev->capabilities &= ~CAP_BSF; /* turn off feature */
947 dev->capabilities &= ~CAP_FSR; /* turn off feature */
951 dev->capabilities &= ~CAP_BSR; /* turn off feature */
958 dev->dev_errno = ENOSYS;
959 Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
960 Emsg0(M_ERROR, 0, dev->errmsg);
967 mt_com.mt_op = MTIOCLRERR;
969 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
970 Dmsg0(200, "Did MTIOCLRERR\n");
976 * Flush buffer contents
979 int flush_dev(DEVICE *dev)
984 static void do_close(DEVICE *dev)
987 Dmsg0(29, "really close_dev\n");
989 /* Clean up device packet so it can be reused */
991 dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
992 dev->file = dev->block_num = 0;
994 dev->EndFile = dev->EndBlock = 0;
995 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
996 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1004 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 if (dev->fd >= 0 && dev->use_count == 1) {
1014 Dmsg0(29, "close_dev but in use so leave open.\n");
1020 * Used when unmounting the device
1022 void force_close_dev(DEVICE *dev)
1025 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1026 Emsg0(M_FATAL, 0, dev->errmsg);
1029 Dmsg0(29, "really close_dev\n");
1033 int truncate_dev(DEVICE *dev)
1035 if (dev->state & ST_TAPE) {
1038 if (ftruncate(dev->fd, 0) != 0) {
1039 Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1046 dev_is_tape(DEVICE *dev)
1048 return (dev->state & ST_TAPE) ? 1 : 0;
1052 dev_name(DEVICE *dev)
1054 return dev->dev_name;
1058 dev_vol_name(DEVICE *dev)
1060 return dev->VolCatInfo.VolCatName;
1063 uint32_t dev_block(DEVICE *dev)
1065 update_pos_dev(dev);
1066 return dev->block_num;
1069 uint32_t dev_file(DEVICE *dev)
1071 update_pos_dev(dev);
1076 * Free memory allocated for the device
1079 term_dev(DEVICE *dev)
1082 dev->dev_errno = EBADF;
1083 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1084 Emsg0(M_FATAL, 0, dev->errmsg);
1088 Dmsg0(29, "term_dev\n");
1089 if (dev->dev_name) {
1090 free_memory(dev->dev_name);
1091 dev->dev_name = NULL;
1094 free_pool_memory(dev->errmsg);
1097 pthread_mutex_destroy(&dev->mutex);
1098 pthread_cond_destroy(&dev->wait);
1099 pthread_cond_destroy(&dev->wait_next_vol);
1100 if (dev->state & ST_MALLOC) {
1101 free_pool_memory((POOLMEM *)dev);
1106 /* To make following two functions more readable */
1108 #define attached_jcrs ((JCR *)(dev->attached_jcrs))
1110 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1112 jcr->prev_dev = NULL;
1113 jcr->next_dev = attached_jcrs;
1114 if (attached_jcrs) {
1115 attached_jcrs->prev_dev = jcr;
1117 attached_jcrs = jcr;
1118 Dmsg1(100, "Attached Job %s\n", jcr->Job);
1121 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1123 if (!jcr->prev_dev) {
1124 attached_jcrs = jcr->next_dev;
1126 jcr->prev_dev->next_dev = jcr->next_dev;
1128 if (jcr->next_dev) {
1129 jcr->next_dev->prev_dev = jcr->prev_dev;
1131 jcr->next_dev = jcr->prev_dev = NULL;
1132 Dmsg1(100, "Detached Job %s\n", jcr->Job);
1135 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1138 return attached_jcrs;
1140 return jcr->next_dev;