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 */
88 * Allocate and initialize the DEVICE structure
89 * Note, if dev is non-NULL, it is already allocated,
90 * thus we neither allocate it nor free it. This allows
91 * the caller to put the packet in shared memory.
93 * Note, for a tape, the device->device_name is the device name
94 * (e.g. /dev/nst0), and for a file, the device name
95 * is the directory in which the file will be placed.
99 init_dev(DEVICE *dev, DEVRES *device)
105 /* Check that device is available */
106 if (stat(device->device_name, &statp) < 0) {
108 dev->dev_errno = errno;
110 Emsg2(M_FATAL, 0, "Unable to stat device %s : %s\n", device->device_name,
116 if (S_ISDIR(statp.st_mode)) {
118 } else if (S_ISCHR(statp.st_mode)) {
120 } else if (S_ISFIFO(statp.st_mode)) {
124 dev->dev_errno = ENODEV;
126 Emsg2(M_FATAL, 0, _("%s is an unknown device type. Must be tape or directory. st_mode=%x\n"),
127 dev_name, statp.st_mode);
131 dev = (DEVICE *)get_memory(sizeof(DEVICE));
132 memset(dev, 0, sizeof(DEVICE));
133 dev->state = ST_MALLOC;
135 memset(dev, 0, sizeof(DEVICE));
138 /* Copy user supplied device parameters from Resource */
139 dev->dev_name = get_memory(strlen(device->device_name)+1);
140 strcpy(dev->dev_name, device->device_name);
141 dev->capabilities = device->cap_bits;
142 dev->min_block_size = device->min_block_size;
143 dev->max_block_size = device->max_block_size;
144 dev->max_volume_size = device->max_volume_size;
145 dev->max_file_size = device->max_file_size;
146 dev->volume_capacity = device->volume_capacity;
147 dev->max_rewind_wait = device->max_rewind_wait;
148 dev->max_open_wait = device->max_open_wait;
149 dev->max_open_vols = device->max_open_vols;
150 dev->device = device;
153 dev->state |= ST_TAPE;
155 dev->state |= ST_FIFO;
156 dev->capabilities |= CAP_STREAM; /* set stream device */
158 dev->state |= ST_FILE;
161 if (dev->max_block_size > 1000000) {
162 Emsg3(M_ERROR, 0, _("Block size %u on device %s is too large, using default %u\n"),
163 dev->max_block_size, dev->dev_name, DEFAULT_BLOCK_SIZE);
164 dev->max_block_size = 0;
166 if (dev->max_block_size % TAPE_BSIZE != 0) {
167 Emsg2(M_WARNING, 0, _("Max block size %u not multiple of device %s block size.\n"),
168 dev->max_block_size, dev->dev_name);
171 dev->errmsg = get_pool_memory(PM_EMSG);
174 if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
175 dev->dev_errno = errstat;
176 Mmsg1(&dev->errmsg, _("Unable to init mutex: ERR=%s\n"), strerror(errstat));
177 Emsg0(M_FATAL, 0, dev->errmsg);
179 if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
180 dev->dev_errno = errstat;
181 Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
182 Emsg0(M_FATAL, 0, dev->errmsg);
184 if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
185 dev->dev_errno = errstat;
186 Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
187 Emsg0(M_FATAL, 0, dev->errmsg);
190 Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
194 /* Open the device with the operating system and
195 * initialize buffer pointers.
197 * Note, for a tape, the VolName is the name we give to the
198 * volume (not really used here), but for a file, the
199 * VolName represents the name of the file to be created/opened.
200 * In the case of a file, the full name is the device name
201 * (archive_name) with the VolName concatenated.
204 open_dev(DEVICE *dev, char *VolName, int mode)
206 POOLMEM *archive_name;
208 if (dev->state & ST_OPENED) {
210 * *****FIXME***** how to handle two threads wanting
211 * different volumes mounted???? E.g. one is waiting
212 * for the next volume to be mounted, and a new job
213 * starts and snatches up the device.
215 if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
219 Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
220 dev->dev_name, dev->use_count);
221 Emsg1(M_WARNING, 0, "%s", dev->errmsg);
225 bstrncpy(dev->VolCatInfo.VolCatName, VolName, sizeof(dev->VolCatInfo.VolCatName));
228 Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
229 dev->dev_name, dev->VolCatInfo.VolCatName);
230 dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
231 if (dev->state & (ST_TAPE|ST_FIFO)) {
233 Dmsg0(29, "open_dev: device is tape\n");
234 if (mode == OPEN_READ_WRITE) {
235 dev->mode = O_RDWR | O_BINARY;
236 } else if (mode == OPEN_READ_ONLY) {
237 dev->mode = O_RDONLY | O_BINARY;
238 } else if (mode == OPEN_WRITE_ONLY) {
239 dev->mode = O_WRONLY | O_BINARY;
241 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
243 timeout = dev->max_open_wait;
245 if (dev->state & ST_FIFO && timeout) {
247 dev->tid = start_thread_timer(pthread_self(), timeout);
249 /* If busy retry each second for max_open_wait seconds */
250 while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
251 if (errno == EAGAIN) {
254 if (errno == EBUSY && timeout-- > 0) {
255 Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
259 dev->dev_errno = errno;
260 Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
261 dev->dev_name, strerror(dev->dev_errno));
262 /* Stop any open timer we set */
264 stop_thread_timer(dev->tid);
267 Emsg0(M_FATAL, 0, dev->errmsg);
272 dev->state |= ST_OPENED;
274 update_pos_dev(dev); /* update position */
276 /* Stop any open() timer we started */
278 stop_thread_timer(dev->tid);
281 Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
284 * Handle opening of File Archive (not a tape)
286 if (VolName == NULL || *VolName == 0) {
287 Mmsg(&dev->errmsg, _("Could not open file device %s. No Volume name given.\n"),
291 archive_name = get_pool_memory(PM_FNAME);
292 pm_strcpy(&archive_name, dev->dev_name);
293 if (archive_name[strlen(archive_name)] != '/') {
294 pm_strcat(&archive_name, "/");
296 pm_strcat(&archive_name, VolName);
297 Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
298 if (mode == OPEN_READ_WRITE) {
299 dev->mode = O_CREAT | O_RDWR | O_BINARY;
300 } else if (mode == OPEN_READ_ONLY) {
301 dev->mode = O_RDONLY | O_BINARY;
302 } else if (mode == OPEN_WRITE_ONLY) {
303 dev->mode = O_WRONLY | O_BINARY;
305 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
307 /* If creating file, give 0640 permissions */
308 if ((dev->fd = open(archive_name, dev->mode, 0640)) < 0) {
309 dev->dev_errno = errno;
310 Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
311 Emsg0(M_FATAL, 0, dev->errmsg);
314 dev->state |= ST_OPENED;
316 update_pos_dev(dev); /* update position */
318 Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
319 free_pool_memory(archive_name);
326 * Returns: 1 on success
329 int rewind_dev(DEVICE *dev)
334 Dmsg0(29, "rewind_dev\n");
336 dev->dev_errno = EBADF;
337 Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
339 Emsg0(M_FATAL, 0, dev->errmsg);
342 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
343 dev->block_num = dev->file = 0;
345 if (dev->state & ST_TAPE) {
346 mt_com.mt_op = MTREW;
348 /* If we get an I/O error on rewind, it is probably because
349 * the drive is actually busy. We loop for (about 5 minutes)
350 * retrying every 5 seconds.
352 for (i=dev->max_rewind_wait; ; i -= 5) {
353 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
354 if (i == dev->max_rewind_wait) {
355 Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
357 clrerror_dev(dev, MTREW);
358 if (dev->dev_errno == EIO && i > 0) {
359 Dmsg0(200, "Sleeping 5 seconds.\n");
363 Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
364 dev->dev_name, strerror(dev->dev_errno));
369 } else if (dev->state & ST_FILE) {
370 if (lseek(dev->fd, (off_t)0, SEEK_SET) < 0) {
371 dev->dev_errno = errno;
372 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
373 dev->dev_name, strerror(dev->dev_errno));
381 * Position device to end of medium (end of data)
382 * Returns: 1 on succes
389 struct mtget mt_stat;
393 Dmsg0(29, "eod_dev\n");
394 if (dev->state & ST_EOT) {
397 dev->state &= ~(ST_EOF); /* remove EOF flags */
398 dev->block_num = dev->file = 0;
400 if (dev->state & (ST_FIFO | ST_PROG)) {
403 if (!(dev->state & ST_TAPE)) {
404 pos = lseek(dev->fd, (off_t)0, SEEK_END);
405 // Dmsg1(000, "====== Seek to %lld\n", pos);
408 dev->state |= ST_EOT;
414 if (dev_cap(dev, CAP_EOM)) {
415 mt_com.mt_op = MTEOM;
417 if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
418 Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
419 clrerror_dev(dev, mt_com.mt_op);
421 Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
422 dev->dev_name, strerror(dev->dev_errno));
425 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
426 dev->dev_errno = errno;
427 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
428 dev->dev_name, strerror(dev->dev_errno));
431 Dmsg2(200, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
432 dev->file = mt_stat.mt_fileno;
435 * Rewind then use FSF until EOT reached
441 if (!rewind_dev(dev)) {
444 while (!(dev->state & ST_EOT)) {
445 Dmsg0(200, "Do fsf 1\n");
446 if (!fsf_dev(dev, 1)) {
447 Dmsg0(200, "fsf_dev error.\n");
453 * Some drivers leave us after second EOF when doing
454 * MTEOM, so we must backup so that appending overwrites
457 if (dev_cap(dev, CAP_BSFATEOM)) {
458 stat = (bsf_dev(dev, 1) == 0);
459 dev->file++; /* keep same file */
461 update_pos_dev(dev); /* update position */
464 Dmsg1(200, "EOD dev->file=%d\n", dev->file);
469 * Set the position of the device -- only for files
470 * For other devices, there is no generic way to do it.
471 * Returns: 1 on succes
474 int update_pos_dev(DEVICE *dev)
480 dev->dev_errno = EBADF;
481 Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
482 Emsg0(M_FATAL, 0, dev->errmsg);
486 /* Find out where we are */
487 if (dev->state & ST_FILE) {
490 pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
492 Pmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
493 dev->dev_errno = errno;
494 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
495 dev->dev_name, strerror(dev->dev_errno));
498 dev->file_addr = pos;
507 * Return the status of the device. This was meant
508 * to be a generic routine. Unfortunately, it doesn't
509 * seem possible (at least I do not know how to do it
510 * currently), which means that for the moment, this
511 * routine has very little value.
513 * Returns: 1 on success
517 status_dev(DEVICE *dev, uint32_t *status)
519 struct mtget mt_stat;
522 if (dev->state & (ST_EOT | ST_WEOT)) {
526 if (dev->state & ST_EOF) {
530 if (dev->state & ST_TAPE) {
532 Dmsg0(-20," Driver status:");
533 Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
534 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
535 dev->dev_errno = errno;
536 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
537 dev->dev_name, strerror(dev->dev_errno));
540 Dmsg0(-20, " Device status:");
542 #if defined(HAVE_LINUX_OS)
543 if (GMT_EOF(mt_stat.mt_gstat)) {
547 if (GMT_BOT(mt_stat.mt_gstat)) {
551 if (GMT_EOT(mt_stat.mt_gstat)) {
555 if (GMT_SM(mt_stat.mt_gstat)) {
559 if (GMT_EOD(mt_stat.mt_gstat)) {
563 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
565 Dmsg0(-20, " WR_PROT");
567 if (GMT_ONLINE(mt_stat.mt_gstat)) {
569 Dmsg0(-20, " ONLINE");
571 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
573 Dmsg0(-20, " DR_OPEN");
575 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
576 stat |= BMT_IM_REP_EN;
577 Dmsg0(-20, " IM_REP_EN");
579 #endif /* !SunOS && !OSF */
580 Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
582 stat |= BMT_ONLINE | BMT_BOT;
590 * Load medium in device
591 * Returns: 1 on success
594 int load_dev(DEVICE *dev)
601 dev->dev_errno = EBADF;
602 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
603 Emsg0(M_FATAL, 0, dev->errmsg);
606 if (!(dev->state & ST_TAPE)) {
610 Dmsg0(200, "stored: MTLOAD command not available\n");
611 dev->dev_errno = ENOTTY; /* function not available */
612 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
613 dev->dev_name, strerror(dev->dev_errno)); return 0;
617 dev->block_num = dev->file = 0;
619 mt_com.mt_op = MTLOAD;
621 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
622 dev->dev_errno = errno;
623 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
624 dev->dev_name, strerror(dev->dev_errno)); return 0;
631 * Rewind device and put it offline
632 * Returns: 1 on success
635 int offline_dev(DEVICE *dev)
640 dev->dev_errno = EBADF;
641 Mmsg0(&dev->errmsg, _("Bad call to offline_dev. Archive not open\n"));
642 Emsg0(M_FATAL, 0, dev->errmsg);
645 if (!(dev->state & ST_TAPE)) {
649 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
650 dev->block_num = dev->file = 0;
653 mt_com.mt_op = MTUNLOCK;
655 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
657 mt_com.mt_op = MTOFFL;
659 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
660 dev->dev_errno = errno;
661 Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
662 dev->dev_name, strerror(dev->dev_errno));
665 Dmsg1(100, "Offlined device %s\n", dev->dev_name);
669 int offline_or_rewind_dev(DEVICE *dev)
671 if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
672 return offline_dev(dev);
675 * Note, this rewind probably should not be here (it wasn't
676 * in prior versions of Bacula), but on FreeBSD, this is
677 * needed in the case the tape was "frozen" due to an error
678 * such as backspacing after writing and EOF. If it is not
679 * done, all future references to the drive get and I/O error.
681 return rewind_dev(dev);
686 * Foward space a file
687 * Returns: 1 on success
691 fsf_dev(DEVICE *dev, int num)
697 dev->dev_errno = EBADF;
698 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
699 Emsg0(M_FATAL, 0, dev->errmsg);
703 if (!(dev->state & ST_TAPE)) {
706 if (dev->state & ST_EOT) {
708 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
711 if (dev->state & ST_EOF) {
712 Dmsg0(200, "ST_EOF set on entry to FSF\n");
714 if (dev->state & ST_EOT) {
715 Dmsg0(200, "ST_EOT set on entry to FSF\n");
718 Dmsg0(29, "fsf_dev\n");
720 if (dev_cap(dev, CAP_FSF)) {
723 Dmsg0(200, "FSF has cap_fsf\n");
724 if (dev->max_block_size == 0) {
725 rbuf_len = DEFAULT_BLOCK_SIZE;
727 rbuf_len = dev->max_block_size;
729 rbuf = get_memory(rbuf_len);
730 mt_com.mt_op = MTFSF;
732 while (num-- && !(dev->state & ST_EOT)) {
733 Dmsg0(200, "Doing read before fsf\n");
734 if ((stat = read(dev->fd, (char *)rbuf, rbuf_len)) < 0) {
735 if (errno == ENOMEM) { /* tape record exceeds buf len */
736 stat = rbuf_len; /* This is OK */
738 dev->state |= ST_EOT;
739 clrerror_dev(dev, -1);
740 Dmsg2(200, "Set ST_EOT read errno=%d. ERR=%s\n", dev->dev_errno,
741 strerror(dev->dev_errno));
742 Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
743 dev->dev_name, strerror(dev->dev_errno));
744 Dmsg1(200, "%s", dev->errmsg);
748 if (stat == 0) { /* EOF */
750 Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
751 /* Two reads of zero means end of tape */
752 if (dev->state & ST_EOF) {
753 dev->state |= ST_EOT;
754 Dmsg0(200, "Set ST_EOT\n");
757 dev->state |= ST_EOF;
762 } else { /* Got data */
763 dev->state &= ~(ST_EOF|ST_EOT);
766 Dmsg0(200, "Doing MTFSF\n");
767 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
768 if (stat < 0) { /* error => EOT */
769 dev->state |= ST_EOT;
770 Dmsg0(200, "Set ST_EOT\n");
771 clrerror_dev(dev, MTFSF);
772 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
773 dev->dev_name, strerror(dev->dev_errno));
774 Dmsg0(200, "Got < 0 for MTFSF\n");
775 Dmsg1(200, "%s", dev->errmsg);
777 dev->state |= ST_EOF; /* just read EOF */
785 * No FSF, so use FSR to simulate it
788 Dmsg0(200, "Doing FSR for FSF\n");
789 while (num-- && !(dev->state & ST_EOT)) {
790 fsr_dev(dev, INT32_MAX); /* returns -1 on EOF or EOT */
792 if (dev->state & ST_EOT) {
794 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
801 Dmsg1(200, "Return %d from FSF\n", stat);
802 if (dev->state & ST_EOF)
803 Dmsg0(200, "ST_EOF set on exit FSF\n");
804 if (dev->state & ST_EOT)
805 Dmsg0(200, "ST_EOT set on exit FSF\n");
806 Dmsg1(200, "Return from FSF file=%d\n", dev->file);
807 return stat == 0 ? 1 : 0;
811 * Backward space a file
812 * Returns: 0 on failure
816 bsf_dev(DEVICE *dev, int num)
822 dev->dev_errno = EBADF;
823 Mmsg0(&dev->errmsg, _("Bad call to bsf_dev. Archive not open\n"));
824 Emsg0(M_FATAL, 0, dev->errmsg);
828 if (!(dev_state(dev, ST_TAPE))) {
831 Dmsg0(29, "bsf_dev\n");
832 dev->state &= ~(ST_EOT|ST_EOF);
835 mt_com.mt_op = MTBSF;
836 mt_com.mt_count = num;
837 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
839 clrerror_dev(dev, MTBSF);
840 Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
841 dev->dev_name, strerror(dev->dev_errno));
844 return stat == 0 ? 1 : 0;
849 * Foward space a record
850 * Returns: 0 on failure
854 fsr_dev(DEVICE *dev, int num)
860 dev->dev_errno = EBADF;
861 Mmsg0(&dev->errmsg, _("Bad call to fsr_dev. Archive not open\n"));
862 Emsg0(M_FATAL, 0, dev->errmsg);
866 if (!(dev_state(dev, ST_TAPE))) {
869 Dmsg0(29, "fsr_dev\n");
870 dev->block_num += num;
871 mt_com.mt_op = MTFSR;
872 mt_com.mt_count = num;
873 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
875 dev->state &= ~ST_EOF;
877 if (dev->state & ST_EOF) {
878 dev->state |= ST_EOT;
880 dev->state |= ST_EOF; /* assume EOF */
884 clrerror_dev(dev, MTFSR);
885 Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
886 dev->dev_name, strerror(dev->dev_errno));
889 return stat == 0 ? 1 : 0;
893 * Backward space a record
894 * Returns: 0 on failure
898 bsr_dev(DEVICE *dev, int num)
904 dev->dev_errno = EBADF;
905 Mmsg0(&dev->errmsg, _("Bad call to bsr_dev. Archive not open\n"));
906 Emsg0(M_FATAL, 0, dev->errmsg);
910 if (!(dev->state & ST_TAPE)) {
914 if (!dev_cap(dev, CAP_BSR)) {
915 Mmsg1(&dev->errmsg, _("ioctl MTBSR not permitted on %s.\n"),
920 Dmsg0(29, "bsr_dev\n");
921 dev->block_num -= num;
922 dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
923 mt_com.mt_op = MTBSR;
924 mt_com.mt_count = num;
925 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
927 clrerror_dev(dev, MTBSR);
928 Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
929 dev->dev_name, strerror(dev->dev_errno));
932 return stat == 0 ? 1 : 0;
936 * Reposition the device to file, block
937 * Currently only works for tapes.
938 * Returns: 0 on failure
942 reposition_dev(DEVICE *dev, uint32_t file, uint32_t block)
945 dev->dev_errno = EBADF;
946 Mmsg0(&dev->errmsg, _("Bad call to reposition_dev. Archive not open\n"));
947 Emsg0(M_FATAL, 0, dev->errmsg);
951 if (!(dev_state(dev, ST_TAPE))) {
954 Dmsg4(100, "reposition_dev from %u:%u to %u:%u\n",
955 dev->file, dev->block_num, file, block);
956 if (file < dev->file) {
957 Dmsg0(100, "Rewind_dev\n");
958 if (!rewind_dev(dev)) {
962 if (file > dev->file) {
963 Dmsg1(100, "fsf %d\n", file-dev->file);
964 if (!fsf_dev(dev, file-dev->file)) {
968 if (block < dev->block_num) {
972 if (block > dev->block_num) {
973 /* Ignore errors as Bacula can read to the correct block */
974 Dmsg1(100, "fsr %d\n", block-dev->block_num);
975 fsr_dev(dev, block-dev->block_num);
983 * Write an end of file on the device
984 * Returns: 0 on success
985 * non-zero on failure
988 weof_dev(DEVICE *dev, int num)
994 dev->dev_errno = EBADF;
995 Mmsg0(&dev->errmsg, _("Bad call to weof_dev. Archive not open\n"));
996 Emsg0(M_FATAL, 0, dev->errmsg);
1000 if (!(dev->state & ST_TAPE)) {
1003 dev->state &= ~(ST_EOT | ST_EOF); /* remove EOF/EOT flags */
1005 Dmsg0(29, "weof_dev\n");
1006 mt_com.mt_op = MTWEOF;
1007 mt_com.mt_count = num;
1008 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1013 clrerror_dev(dev, MTWEOF);
1014 Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
1015 dev->dev_name, strerror(dev->dev_errno));
1021 * Return string message with last error in English
1022 * Be careful not to call this routine from within dev.c
1023 * while editing an Mmsg(&) or you will end up in a recursive
1024 * loop creating a Segmentation Violation.
1027 strerror_dev(DEVICE *dev)
1034 * If implemented in system, clear the tape
1038 clrerror_dev(DEVICE *dev, int func)
1042 dev->dev_errno = errno; /* save errno */
1044 dev->VolCatInfo.VolCatErrors++;
1047 if (!(dev->state & ST_TAPE)) {
1050 if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
1053 Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
1057 dev->capabilities &= ~CAP_EOF; /* turn off feature */
1062 dev->capabilities &= ~CAP_EOM; /* turn off feature */
1067 dev->capabilities &= ~CAP_FSF; /* turn off feature */
1071 dev->capabilities &= ~CAP_BSF; /* turn off feature */
1075 dev->capabilities &= ~CAP_FSR; /* turn off feature */
1079 dev->capabilities &= ~CAP_BSR; /* turn off feature */
1086 dev->dev_errno = ENOSYS;
1087 Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
1088 Emsg0(M_ERROR, 0, dev->errmsg);
1091 /* Found on Linux */
1095 mt_com.mt_op = MTIOCLRERR;
1096 mt_com.mt_count = 1;
1097 /* Clear any error condition on the tape */
1098 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1099 Dmsg0(200, "Did MTIOCLRERR\n");
1103 /* Typically on FreeBSD */
1106 /* Read and clear SCSI error status */
1107 union mterrstat mt_errstat;
1108 Pmsg2(000, "Doing MTIOCERRSTAT errno=%d ERR=%s\n", dev->dev_errno,
1109 strerror(dev->dev_errno));
1110 ioctl(dev->fd, MTIOCERRSTAT, (char *)&mt_errstat);
1116 * Flush buffer contents
1119 int flush_dev(DEVICE *dev)
1124 static void do_close(DEVICE *dev)
1127 Dmsg1(29, "really close_dev %s\n", dev->dev_name);
1129 /* Clean up device packet so it can be reused */
1131 dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1132 dev->file = dev->block_num = 0;
1134 dev->EndFile = dev->EndBlock = 0;
1135 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1136 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1138 stop_thread_timer(dev->tid);
1148 close_dev(DEVICE *dev)
1151 Mmsg0(&dev->errmsg, _("Bad call to close_dev. Archive not open\n"));
1152 Emsg0(M_FATAL, 0, dev->errmsg);
1155 if (dev->fd >= 0 && dev->use_count == 1) {
1157 } else if (dev->use_count > 0) {
1162 ASSERT(dev->use_count >= 0);
1167 * Used when unmounting the device
1169 void force_close_dev(DEVICE *dev)
1172 Mmsg0(&dev->errmsg, _("Bad call to force_close_dev. Archive not open\n"));
1173 Emsg0(M_FATAL, 0, dev->errmsg);
1176 Dmsg1(29, "Force close_dev %s\n", dev->dev_name);
1180 ASSERT(dev->use_count >= 0);
1184 int truncate_dev(DEVICE *dev)
1186 if (dev->state & ST_TAPE) {
1189 if (ftruncate(dev->fd, 0) != 0) {
1190 Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1197 dev_is_tape(DEVICE *dev)
1199 return (dev->state & ST_TAPE) ? 1 : 0;
1204 * return 1 if the device is read for write, and 0 otherwise
1205 * This is meant for checking at the end of a job to see
1206 * if we still have a tape (perhaps not if at end of tape
1207 * and the job is canceled).
1210 dev_can_write(DEVICE *dev)
1212 if ((dev->state & ST_OPENED) && (dev->state & ST_APPEND) &&
1213 (dev->state & ST_LABEL) && !(dev->state & ST_WEOT)) {
1221 dev_name(DEVICE *dev)
1223 return dev->dev_name;
1227 dev_vol_name(DEVICE *dev)
1229 return dev->VolCatInfo.VolCatName;
1232 uint32_t dev_block(DEVICE *dev)
1234 update_pos_dev(dev);
1235 return dev->block_num;
1238 uint32_t dev_file(DEVICE *dev)
1240 update_pos_dev(dev);
1245 * Free memory allocated for the device
1248 term_dev(DEVICE *dev)
1251 dev->dev_errno = EBADF;
1252 Mmsg0(&dev->errmsg, _("Bad call to term_dev. Archive not open\n"));
1253 Emsg0(M_FATAL, 0, dev->errmsg);
1257 Dmsg0(29, "term_dev\n");
1258 if (dev->dev_name) {
1259 free_memory(dev->dev_name);
1260 dev->dev_name = NULL;
1263 free_pool_memory(dev->errmsg);
1266 pthread_mutex_destroy(&dev->mutex);
1267 pthread_cond_destroy(&dev->wait);
1268 pthread_cond_destroy(&dev->wait_next_vol);
1269 if (dev->state & ST_MALLOC) {
1270 free_pool_memory((POOLMEM *)dev);
1275 * We attach a jcr to the device so that when
1276 * the Volume is full during writing, a
1277 * JobMedia record will be created for this
1280 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1282 jcr->prev_dev = (JCR *)NULL;
1283 jcr->next_dev = dev->attached_jcrs;
1284 if (dev->attached_jcrs) {
1285 dev->attached_jcrs->prev_dev = jcr;
1287 dev->attached_jcrs = jcr;
1288 Dmsg1(100, "Attached Job %s\n", jcr->Job);
1291 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1293 if (!jcr->prev_dev) {
1294 dev->attached_jcrs = jcr->next_dev;
1296 jcr->prev_dev->next_dev = jcr->next_dev;
1298 if (jcr->next_dev) {
1299 jcr->next_dev->prev_dev = jcr->prev_dev;
1301 jcr->next_dev = jcr->prev_dev = NULL;
1302 Dmsg1(100, "Detached Job %s\n", jcr->Job);
1305 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1307 if (jcr == (JCR *)NULL) {
1308 return dev->attached_jcrs;
1310 return jcr->next_dev;