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-2003 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->max_open_vols = device->max_open_vols;
157 dev->device = device;
160 dev->state |= ST_TAPE;
162 dev->state |= ST_FIFO;
163 dev->capabilities |= CAP_STREAM; /* set stream device */
165 dev->state |= ST_FILE;
168 if (dev->max_block_size > 1000000) {
169 Emsg3(M_ERROR, 0, _("Block size %u on device %s is too large, using default %u\n"),
170 dev->max_block_size, dev->dev_name, DEFAULT_BLOCK_SIZE);
171 dev->max_block_size = 0;
173 if (dev->max_block_size % TAPE_BSIZE != 0) {
174 Emsg2(M_WARNING, 0, _("Max block size %u not multiple of device %s block size.\n"),
175 dev->max_block_size, dev->dev_name);
178 dev->errmsg = get_pool_memory(PM_EMSG);
181 if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
182 dev->dev_errno = errstat;
183 Mmsg1(&dev->errmsg, _("Unable to init mutex: ERR=%s\n"), strerror(errstat));
184 Emsg0(M_FATAL, 0, dev->errmsg);
186 if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
187 dev->dev_errno = errstat;
188 Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
189 Emsg0(M_FATAL, 0, dev->errmsg);
191 if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
192 dev->dev_errno = errstat;
193 Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
194 Emsg0(M_FATAL, 0, dev->errmsg);
197 Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
201 /* Open the device with the operating system and
202 * initialize buffer pointers.
204 * Note, for a tape, the VolName is the name we give to the
205 * volume (not really used here), but for a file, the
206 * VolName represents the name of the file to be created/opened.
207 * In the case of a file, the full name is the device name
208 * (archive_name) with the VolName concatenated.
211 open_dev(DEVICE *dev, char *VolName, int mode)
213 POOLMEM *archive_name;
215 if (dev->state & ST_OPENED) {
217 * *****FIXME***** how to handle two threads wanting
218 * different volumes mounted???? E.g. one is waiting
219 * for the next volume to be mounted, and a new job
220 * starts and snatches up the device.
222 if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
226 Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
227 dev->dev_name, dev->use_count);
228 Emsg1(M_WARNING, 0, "%s", dev->errmsg);
232 strcpy(dev->VolCatInfo.VolCatName, VolName);
235 Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
236 dev->dev_name, dev->VolCatInfo.VolCatName);
237 dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
238 if (dev->state & (ST_TAPE|ST_FIFO)) {
240 Dmsg0(29, "open_dev: device is tape\n");
241 if (mode == OPEN_READ_WRITE) {
242 dev->mode = O_RDWR | O_BINARY;
243 } else if (mode == OPEN_READ_ONLY) {
244 dev->mode = O_RDONLY | O_BINARY;
245 } else if (mode == OPEN_WRITE_ONLY) {
246 dev->mode = O_WRONLY | O_BINARY;
248 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
250 timeout = dev->max_open_wait;
252 if (dev->state & ST_FIFO && timeout) {
254 dev->tid = start_thread_timer(pthread_self(), timeout);
256 /* If busy retry each second for max_open_wait seconds */
257 while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
258 if (errno == EAGAIN) {
261 if (errno == EBUSY && timeout-- > 0) {
262 Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
266 dev->dev_errno = errno;
267 Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
268 dev->dev_name, strerror(dev->dev_errno));
269 /* Stop any open timer we set */
271 stop_thread_timer(dev->tid);
274 Emsg0(M_FATAL, 0, dev->errmsg);
279 dev->state |= ST_OPENED;
281 update_pos_dev(dev); /* update position */
283 /* Stop any open() timer we started */
285 stop_thread_timer(dev->tid);
288 Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
291 * Handle opening of file
293 archive_name = get_pool_memory(PM_FNAME);
294 pm_strcpy(&archive_name, dev->dev_name);
295 if (archive_name[strlen(archive_name)] != '/') {
296 pm_strcat(&archive_name, "/");
298 pm_strcat(&archive_name, VolName);
299 Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
300 if (mode == OPEN_READ_WRITE) {
301 dev->mode = O_CREAT | O_RDWR | O_BINARY;
302 } else if (mode == OPEN_READ_ONLY) {
303 dev->mode = O_RDONLY | O_BINARY;
304 } else if (mode == OPEN_WRITE_ONLY) {
305 dev->mode = O_WRONLY | O_BINARY;
307 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
309 /* If creating file, give 0640 permissions */
310 if ((dev->fd = open(archive_name, dev->mode, 0640)) < 0) {
311 dev->dev_errno = errno;
312 Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
313 Emsg0(M_FATAL, 0, dev->errmsg);
316 dev->state |= ST_OPENED;
318 update_pos_dev(dev); /* update position */
320 Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
321 free_pool_memory(archive_name);
328 * Returns: 1 on success
331 int rewind_dev(DEVICE *dev)
336 Dmsg0(29, "rewind_dev\n");
338 dev->dev_errno = EBADF;
339 Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
341 Emsg0(M_FATAL, 0, dev->errmsg);
344 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT | ST_EOF | ST_WEOT); /* remove EOF/EOT flags */
345 dev->block_num = dev->file = 0;
347 if (dev->state & ST_TAPE) {
348 mt_com.mt_op = MTREW;
350 /* If we get an I/O error on rewind, it is probably because
351 * the drive is actually busy. We loop for (about 5 minutes)
352 * retrying every 5 seconds.
354 for (i=dev->max_rewind_wait; ; i -= 5) {
355 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
356 if (i == dev->max_rewind_wait) {
357 Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
359 clrerror_dev(dev, MTREW);
360 if (dev->dev_errno == EIO && i > 0) {
361 Dmsg0(200, "Sleeping 5 seconds.\n");
365 Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
366 dev->dev_name, strerror(dev->dev_errno));
371 } else if (dev->state & ST_FILE) {
372 if (lseek(dev->fd, (off_t)0, SEEK_SET) < 0) {
373 dev->dev_errno = errno;
374 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
375 dev->dev_name, strerror(dev->dev_errno));
383 * Position device to end of medium (end of data)
384 * Returns: 1 on succes
391 struct mtget mt_stat;
395 Dmsg0(29, "eod_dev\n");
396 if (dev->state & ST_EOT) {
399 dev->state &= ~(ST_EOF); /* remove EOF flags */
400 dev->block_num = dev->file = 0;
402 if (dev->state & (ST_FIFO | ST_PROG)) {
405 if (!(dev->state & ST_TAPE)) {
406 pos = lseek(dev->fd, (off_t)0, SEEK_END);
407 // Dmsg1(000, "====== Seek to %lld\n", pos);
410 dev->state |= ST_EOT;
415 if (dev_cap(dev, CAP_EOM)) {
416 mt_com.mt_op = MTEOM;
418 if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
419 Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
420 clrerror_dev(dev, mt_com.mt_op);
422 Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
423 dev->dev_name, strerror(dev->dev_errno));
426 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
427 dev->dev_errno = errno;
428 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
429 dev->dev_name, strerror(dev->dev_errno));
432 Dmsg2(200, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
433 dev->file = mt_stat.mt_fileno;
436 * Rewind then use FSF until EOT reached
439 if (!rewind_dev(dev)) {
442 while (!(dev->state & ST_EOT)) {
443 Dmsg0(200, "Do fsf 1\n");
444 if (!fsf_dev(dev, 1)) {
445 Dmsg0(200, "fsf_dev error.\n");
451 * Some drivers leave us after second EOF when doing
452 * MTEOM, so we must backup so that appending overwrites
455 if (dev_cap(dev, CAP_BSFATEOM)) {
456 stat = (bsf_dev(dev, 1) == 0);
457 dev->file++; /* keep same file */
459 update_pos_dev(dev); /* update position */
462 Dmsg1(200, "EOD dev->file=%d\n", dev->file);
467 * Set the position of the device -- only for files
468 * For other devices, there is no generic way to do it.
469 * Returns: 1 on succes
472 int update_pos_dev(DEVICE *dev)
478 dev->dev_errno = EBADF;
479 Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
480 Emsg0(M_FATAL, 0, dev->errmsg);
484 /* Find out where we are */
485 if (dev->state & ST_FILE) {
488 pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
490 Dmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
491 dev->dev_errno = errno;
492 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
493 dev->dev_name, strerror(dev->dev_errno));
496 dev->file_addr = pos;
505 * Return the status of the device. This was meant
506 * to be a generic routine. Unfortunately, it doesn't
507 * seem possible (at least I do not know how to do it
508 * currently), which means that for the moment, this
509 * routine has very little value.
511 * Returns: 1 on success
515 status_dev(DEVICE *dev, uint32_t *status)
517 struct mtget mt_stat;
520 if (dev->state & (ST_EOT | ST_WEOT)) {
524 if (dev->state & ST_EOF) {
528 if (dev->state & ST_TAPE) {
530 Dmsg0(-20," Driver status:");
531 Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
532 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
533 dev->dev_errno = errno;
534 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
535 dev->dev_name, strerror(dev->dev_errno));
538 Dmsg0(-20, " Device status:");
540 #if defined(HAVE_LINUX_OS)
541 if (GMT_EOF(mt_stat.mt_gstat)) {
545 if (GMT_BOT(mt_stat.mt_gstat)) {
549 if (GMT_EOT(mt_stat.mt_gstat)) {
553 if (GMT_SM(mt_stat.mt_gstat)) {
557 if (GMT_EOD(mt_stat.mt_gstat)) {
561 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
563 Dmsg0(-20, " WR_PROT");
565 if (GMT_ONLINE(mt_stat.mt_gstat)) {
567 Dmsg0(-20, " ONLINE");
569 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
571 Dmsg0(-20, " DR_OPEN");
573 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
574 stat |= MT_IM_REP_EN;
575 Dmsg0(-20, " IM_REP_EN");
577 #endif /* !SunOS && !OSF */
578 Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
580 stat |= MT_ONLINE | MT_BOT;
588 * Load medium in device
589 * Returns: 1 on success
592 int load_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 Dmsg0(200, "stored: MTLOAD command not available\n");
609 dev->dev_errno = ENOTTY; /* function not available */
610 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
611 dev->dev_name, strerror(dev->dev_errno)); return 0;
615 dev->block_num = dev->file = 0;
617 mt_com.mt_op = MTLOAD;
619 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
620 dev->dev_errno = errno;
621 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
622 dev->dev_name, strerror(dev->dev_errno)); return 0;
629 * Rewind device and put it offline
630 * Returns: 1 on success
633 int offline_dev(DEVICE *dev)
638 dev->dev_errno = EBADF;
639 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
640 Emsg0(M_FATAL, 0, dev->errmsg);
643 if (!(dev->state & ST_TAPE)) {
647 dev->block_num = dev->file = 0;
650 mt_com.mt_op = MTUNLOCK;
652 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
654 mt_com.mt_op = MTOFFL;
656 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
657 dev->dev_errno = errno;
658 Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
659 dev->dev_name, strerror(dev->dev_errno));
662 Dmsg1(100, "Offlined device %s\n", dev->dev_name);
668 * Foward space a file
669 * Returns: 1 on success
673 fsf_dev(DEVICE *dev, int num)
679 dev->dev_errno = EBADF;
680 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
681 Emsg0(M_FATAL, 0, dev->errmsg);
685 if (!(dev->state & ST_TAPE)) {
688 if (dev->state & ST_EOT) {
690 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
693 if (dev->state & ST_EOF) {
694 Dmsg0(200, "ST_EOF set on entry to FSF\n");
696 if (dev->state & ST_EOT) {
697 Dmsg0(200, "ST_EOT set on entry to FSF\n");
700 Dmsg0(29, "fsf_dev\n");
702 if (dev_cap(dev, CAP_FSF)) {
705 Dmsg0(200, "FSF has cap_fsf\n");
706 if (dev->max_block_size == 0) {
707 rbuf_len = DEFAULT_BLOCK_SIZE;
709 rbuf_len = dev->max_block_size;
711 rbuf = get_memory(rbuf_len);
712 mt_com.mt_op = MTFSF;
714 while (num-- && !(dev->state & ST_EOT)) {
715 Dmsg0(200, "Doing read before fsf\n");
716 if ((stat = read(dev->fd, (char *)rbuf, rbuf_len)) < 0) {
717 if (errno == ENOMEM) { /* tape record exceeds buf len */
718 stat = rbuf_len; /* This is OK */
720 dev->state |= ST_EOT;
721 clrerror_dev(dev, -1);
722 Dmsg2(200, "Set ST_EOT read errno=%d. ERR=%s\n", dev->dev_errno,
723 strerror(dev->dev_errno));
724 Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
725 dev->dev_name, strerror(dev->dev_errno));
726 Dmsg1(200, "%s", dev->errmsg);
730 if (stat == 0) { /* EOF */
732 Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
733 /* Two reads of zero means end of tape */
734 if (dev->state & ST_EOF) {
735 dev->state |= ST_EOT;
736 Dmsg0(200, "Set ST_EOT\n");
739 dev->state |= ST_EOF;
744 } else { /* Got data */
745 dev->state &= ~(ST_EOF|ST_EOT);
748 Dmsg0(200, "Doing MT_FSF\n");
749 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
750 if (stat < 0) { /* error => EOT */
751 dev->state |= ST_EOT;
752 Dmsg0(200, "Set ST_EOT\n");
753 clrerror_dev(dev, MTFSF);
754 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
755 dev->dev_name, strerror(dev->dev_errno));
756 Dmsg0(200, "Got < 0 for MT_FSF\n");
757 Dmsg1(200, "%s", dev->errmsg);
759 dev->state |= ST_EOF; /* just read EOF */
767 * No FSF, so use FSR to simulate it
770 Dmsg0(200, "Doing FSR for FSF\n");
771 while (num-- && !(dev->state & ST_EOT)) {
772 fsr_dev(dev, INT32_MAX); /* returns -1 on EOF or EOT */
774 if (dev->state & ST_EOT) {
776 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
783 Dmsg1(200, "Return %d from FSF\n", stat);
784 if (dev->state & ST_EOF)
785 Dmsg0(200, "ST_EOF set on exit FSF\n");
786 if (dev->state & ST_EOT)
787 Dmsg0(200, "ST_EOT set on exit FSF\n");
788 Dmsg1(200, "Return from FSF file=%d\n", dev->file);
789 return stat == 0 ? 1 : 0;
793 * Backward space a file
796 bsf_dev(DEVICE *dev, int num)
802 dev->dev_errno = EBADF;
803 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
804 Emsg0(M_FATAL, 0, dev->errmsg);
808 if (!(dev->state & ST_TAPE)) {
811 Dmsg0(29, "bsf_dev\n");
812 dev->state &= ~(ST_EOT|ST_EOF);
815 mt_com.mt_op = MTBSF;
816 mt_com.mt_count = num;
817 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
819 clrerror_dev(dev, MTBSF);
820 Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
821 dev->dev_name, strerror(dev->dev_errno));
829 * Foward space a record
832 fsr_dev(DEVICE *dev, int num)
838 dev->dev_errno = EBADF;
839 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
840 Emsg0(M_FATAL, 0, dev->errmsg);
844 if (!(dev->state & ST_TAPE)) {
847 Dmsg0(29, "fsr_dev\n");
848 dev->block_num += num;
849 mt_com.mt_op = MTFSR;
850 mt_com.mt_count = num;
851 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
853 dev->state &= ~ST_EOF;
855 if (dev->state & ST_EOF) {
856 dev->state |= ST_EOT;
858 dev->state |= ST_EOF; /* assume EOF */
862 clrerror_dev(dev, MTFSR);
863 Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
864 dev->dev_name, strerror(dev->dev_errno));
871 * Backward space a record
872 * Returns: 0 on success
876 bsr_dev(DEVICE *dev, int num)
882 dev->dev_errno = EBADF;
883 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
884 Emsg0(M_FATAL, 0, dev->errmsg);
888 if (!(dev->state & ST_TAPE)) {
891 Dmsg0(29, "bsr_dev\n");
892 dev->block_num -= num;
893 dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
894 mt_com.mt_op = MTBSR;
895 mt_com.mt_count = num;
896 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
898 clrerror_dev(dev, MTBSR);
899 Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
900 dev->dev_name, strerror(dev->dev_errno));
909 * Write an end of file on the device
910 * Returns: 0 on success
911 * non-zero on failure
914 weof_dev(DEVICE *dev, int num)
920 dev->dev_errno = EBADF;
921 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
922 Emsg0(M_FATAL, 0, dev->errmsg);
926 if (!(dev->state & ST_TAPE)) {
929 dev->state &= ~(ST_EOT | ST_EOF); /* remove EOF/EOT flags */
931 Dmsg0(29, "weof_dev\n");
932 mt_com.mt_op = MTWEOF;
933 mt_com.mt_count = num;
934 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
939 clrerror_dev(dev, MTWEOF);
940 Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
941 dev->dev_name, strerror(dev->dev_errno));
947 * Return string message with last error in English
948 * Be careful not to call this routine from within dev.c
949 * while editing an Mmsg(&) or you will end up in a recursive
950 * loop creating a Segmentation Violation.
953 strerror_dev(DEVICE *dev)
960 * If implemented in system, clear the tape
964 clrerror_dev(DEVICE *dev, int func)
968 dev->dev_errno = errno; /* save errno */
970 dev->VolCatInfo.VolCatErrors++;
973 if (!(dev->state & ST_TAPE)) {
976 if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
979 Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
983 dev->capabilities &= ~CAP_EOF; /* turn off feature */
987 dev->capabilities &= ~CAP_EOM; /* turn off feature */
991 dev->capabilities &= ~CAP_FSF; /* turn off feature */
995 dev->capabilities &= ~CAP_BSF; /* turn off feature */
999 dev->capabilities &= ~CAP_FSR; /* turn off feature */
1003 dev->capabilities &= ~CAP_BSR; /* turn off feature */
1010 dev->dev_errno = ENOSYS;
1011 Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
1012 Emsg0(M_ERROR, 0, dev->errmsg);
1019 mt_com.mt_op = MTIOCLRERR;
1020 mt_com.mt_count = 1;
1021 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1022 Dmsg0(200, "Did MTIOCLRERR\n");
1028 * Flush buffer contents
1031 int flush_dev(DEVICE *dev)
1036 static void do_close(DEVICE *dev)
1039 Dmsg0(29, "really close_dev\n");
1041 /* Clean up device packet so it can be reused */
1043 dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1044 dev->file = dev->block_num = 0;
1046 dev->EndFile = dev->EndBlock = 0;
1047 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1048 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1051 stop_thread_timer(dev->tid);
1060 close_dev(DEVICE *dev)
1063 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1064 Emsg0(M_FATAL, 0, dev->errmsg);
1067 if (dev->fd >= 0 && dev->use_count == 1) {
1070 Dmsg0(29, "close_dev but in use so leave open.\n");
1076 * Used when unmounting the device
1078 void force_close_dev(DEVICE *dev)
1081 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1082 Emsg0(M_FATAL, 0, dev->errmsg);
1085 Dmsg0(29, "really close_dev\n");
1089 int truncate_dev(DEVICE *dev)
1091 if (dev->state & ST_TAPE) {
1094 if (ftruncate(dev->fd, 0) != 0) {
1095 Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1102 dev_is_tape(DEVICE *dev)
1104 return (dev->state & ST_TAPE) ? 1 : 0;
1108 dev_name(DEVICE *dev)
1110 return dev->dev_name;
1114 dev_vol_name(DEVICE *dev)
1116 return dev->VolCatInfo.VolCatName;
1119 uint32_t dev_block(DEVICE *dev)
1121 update_pos_dev(dev);
1122 return dev->block_num;
1125 uint32_t dev_file(DEVICE *dev)
1127 update_pos_dev(dev);
1132 * Free memory allocated for the device
1135 term_dev(DEVICE *dev)
1138 dev->dev_errno = EBADF;
1139 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1140 Emsg0(M_FATAL, 0, dev->errmsg);
1144 Dmsg0(29, "term_dev\n");
1145 if (dev->dev_name) {
1146 free_memory(dev->dev_name);
1147 dev->dev_name = NULL;
1150 free_pool_memory(dev->errmsg);
1153 pthread_mutex_destroy(&dev->mutex);
1154 pthread_cond_destroy(&dev->wait);
1155 pthread_cond_destroy(&dev->wait_next_vol);
1156 if (dev->state & ST_MALLOC) {
1157 free_pool_memory((POOLMEM *)dev);
1162 /* To make following two functions more readable */
1164 #define attached_jcrs ((JCR *)(dev->attached_jcrs))
1166 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1168 jcr->prev_dev = NULL;
1169 jcr->next_dev = attached_jcrs;
1170 if (attached_jcrs) {
1171 attached_jcrs->prev_dev = jcr;
1173 attached_jcrs = jcr;
1174 Dmsg1(100, "Attached Job %s\n", jcr->Job);
1177 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1179 if (!jcr->prev_dev) {
1180 attached_jcrs = jcr->next_dev;
1182 jcr->prev_dev->next_dev = jcr->next_dev;
1184 if (jcr->next_dev) {
1185 jcr->next_dev->prev_dev = jcr->prev_dev;
1187 jcr->next_dev = jcr->prev_dev = NULL;
1188 Dmsg1(100, "Detached Job %s\n", jcr->Job);
1191 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1194 return attached_jcrs;
1196 return jcr->next_dev;