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-2004 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_block_to_device() call the fix_up
61 * routine. In addition, all threads are blocked
62 * from writing on the tape by calling lock_dev(), and thread other
63 * than the first thread to hit the EOT will block on a condition
64 * variable. The first thread to hit the EOT will continue to
65 * be able to read and write the tape (he sort of tunnels through
66 * the locking mechanism -- see lock_dev() for details).
68 * Now presumably somewhere higher in the chain of command
69 * (device.c), someone will notice the EOT condition and
70 * get a new tape up, get the tape label read, and mark
71 * the label for rewriting. Then this higher level routine
72 * will write the unwritten buffer to the new volume.
73 * Finally, he will release
74 * any blocked threads by doing a broadcast on the condition
75 * variable. At that point, we should be totally back in
76 * business with no lost data.
83 /* Forward referenced functions */
86 * Allocate and initialize the DEVICE structure
87 * Note, if dev is non-NULL, it is already allocated,
88 * thus we neither allocate it nor free it. This allows
89 * the caller to put the packet in shared memory.
91 * Note, for a tape, the device->device_name is the device name
92 * (e.g. /dev/nst0), and for a file, the device name
93 * is the directory in which the file will be placed.
97 init_dev(DEVICE *dev, DEVRES *device)
104 /* Check that device is available */
105 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 device->device_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->vol_poll_interval = device->vol_poll_interval;
151 dev->max_spool_size = device->max_spool_size;
152 dev->drive_index = device->drive_index;
154 if (dev->vol_poll_interval && dev->vol_poll_interval < 60) {
155 dev->vol_poll_interval = 60;
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) {
183 dev->dev_errno = errstat;
184 Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
185 Emsg0(M_FATAL, 0, dev->errmsg);
187 if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
189 dev->dev_errno = errstat;
190 Mmsg1(dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), be.strerror(errstat));
191 Emsg0(M_FATAL, 0, dev->errmsg);
193 if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
195 dev->dev_errno = errstat;
196 Mmsg1(dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), be.strerror(errstat));
197 Emsg0(M_FATAL, 0, dev->errmsg);
199 if ((errstat = pthread_mutex_init(&dev->spool_mutex, NULL)) != 0) {
201 dev->dev_errno = errstat;
202 Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
203 Emsg0(M_FATAL, 0, dev->errmsg);
205 if ((errstat = rwl_init(&dev->lock)) != 0) {
207 dev->dev_errno = errstat;
208 Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
209 Emsg0(M_FATAL, 0, dev->errmsg);
213 dev->attached_dcrs = New(dlist(dcr, &dcr->dev_link));
214 Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
219 /* Open the device with the operating system and
220 * initialize buffer pointers.
222 * Note, for a tape, the VolName is the name we give to the
223 * volume (not really used here), but for a file, the
224 * VolName represents the name of the file to be created/opened.
225 * In the case of a file, the full name is the device name
226 * (archive_name) with the VolName concatenated.
229 open_dev(DEVICE *dev, char *VolName, int mode)
231 POOLMEM *archive_name;
233 if (dev->state & ST_OPENED) {
235 * *****FIXME***** how to handle two threads wanting
236 * different volumes mounted???? E.g. one is waiting
237 * for the next volume to be mounted, and a new job
238 * starts and snatches up the device.
240 if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
244 Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
245 dev->dev_name, dev->use_count);
246 Emsg1(M_WARNING, 0, "%s", dev->errmsg);
250 bstrncpy(dev->VolCatInfo.VolCatName, VolName, sizeof(dev->VolCatInfo.VolCatName));
253 Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
254 dev->dev_name, dev->VolCatInfo.VolCatName);
255 dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
256 if (dev->state & (ST_TAPE|ST_FIFO)) {
258 Dmsg0(29, "open_dev: device is tape\n");
259 if (mode == OPEN_READ_WRITE) {
260 dev->mode = O_RDWR | O_BINARY;
261 } else if (mode == OPEN_READ_ONLY) {
262 dev->mode = O_RDONLY | O_BINARY;
263 } else if (mode == OPEN_WRITE_ONLY) {
264 dev->mode = O_WRONLY | O_BINARY;
266 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
268 timeout = dev->max_open_wait;
270 if (dev->state & ST_FIFO && timeout) {
272 dev->tid = start_thread_timer(pthread_self(), timeout);
274 /* If busy retry each second for max_open_wait seconds */
275 while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
276 if (errno == EINTR || errno == EAGAIN) {
279 if (errno == EBUSY && timeout-- > 0) {
280 Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
284 dev->dev_errno = errno;
285 Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
286 dev->dev_name, strerror(dev->dev_errno));
287 /* Stop any open timer we set */
289 stop_thread_timer(dev->tid);
292 Emsg0(M_FATAL, 0, dev->errmsg);
297 dev->state |= ST_OPENED;
299 update_pos_dev(dev); /* update position */
301 /* Stop any open() timer we started */
303 stop_thread_timer(dev->tid);
306 Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
309 * Handle opening of File Archive (not a tape)
311 if (VolName == NULL || *VolName == 0) {
312 Mmsg(dev->errmsg, _("Could not open file device %s. No Volume name given.\n"),
316 archive_name = get_pool_memory(PM_FNAME);
317 pm_strcpy(&archive_name, dev->dev_name);
318 if (archive_name[strlen(archive_name)] != '/') {
319 pm_strcat(&archive_name, "/");
321 pm_strcat(&archive_name, VolName);
322 Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
323 if (mode == OPEN_READ_WRITE) {
324 dev->mode = O_CREAT | O_RDWR | O_BINARY;
325 } else if (mode == OPEN_READ_ONLY) {
326 dev->mode = O_RDONLY | O_BINARY;
327 } else if (mode == OPEN_WRITE_ONLY) {
328 dev->mode = O_WRONLY | O_BINARY;
330 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
332 /* If creating file, give 0640 permissions */
333 if ((dev->fd = open(archive_name, dev->mode, 0640)) < 0) {
334 dev->dev_errno = errno;
335 Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
336 Emsg0(M_FATAL, 0, dev->errmsg);
339 dev->state |= ST_OPENED;
341 update_pos_dev(dev); /* update position */
343 Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
344 free_pool_memory(archive_name);
351 int _rewind_dev(char *file, int line, DEVICE *dev)
353 Dmsg2(100, "rewind_dev called from %s:%d\n", file, line);
354 return rewind_dev(dev);
361 * Returns: 1 on success
364 int rewind_dev(DEVICE *dev)
369 Dmsg1(29, "rewind_dev %s\n", dev->dev_name);
371 dev->dev_errno = EBADF;
372 Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
374 Emsg0(M_FATAL, 0, dev->errmsg);
377 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
378 dev->block_num = dev->file = 0;
380 if (dev->state & ST_TAPE) {
381 mt_com.mt_op = MTREW;
383 /* If we get an I/O error on rewind, it is probably because
384 * the drive is actually busy. We loop for (about 5 minutes)
385 * retrying every 5 seconds.
387 for (i=dev->max_rewind_wait; ; i -= 5) {
388 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
389 if (i == dev->max_rewind_wait) {
390 Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
392 clrerror_dev(dev, MTREW);
393 if (dev->dev_errno == EIO && i > 0) {
394 Dmsg0(200, "Sleeping 5 seconds.\n");
398 Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
399 dev->dev_name, strerror(dev->dev_errno));
404 } else if (dev->state & ST_FILE) {
405 if (lseek(dev->fd, (off_t)0, SEEK_SET) < 0) {
406 dev->dev_errno = errno;
407 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
408 dev->dev_name, strerror(dev->dev_errno));
416 * Position device to end of medium (end of data)
417 * Returns: 1 on succes
424 struct mtget mt_stat;
428 Dmsg0(29, "eod_dev\n");
429 if (dev->state & ST_EOT) {
432 dev->state &= ~(ST_EOF); /* remove EOF flags */
433 dev->block_num = dev->file = 0;
435 if (dev->state & (ST_FIFO | ST_PROG)) {
438 if (!(dev->state & ST_TAPE)) {
439 pos = lseek(dev->fd, (off_t)0, SEEK_END);
440 // Dmsg1(100, "====== Seek to %lld\n", pos);
443 dev->state |= ST_EOT;
446 dev->dev_errno = errno;
447 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
448 dev->dev_name, strerror(dev->dev_errno));
453 if (dev_cap(dev, CAP_FASTFSF) && !dev_cap(dev, CAP_EOM)) {
454 struct mtget mt_stat;
455 Dmsg0(100,"Using FAST FSF for EOM\n");
456 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno <= 0) {
457 if (!rewind_dev(dev)) {
461 mt_com.mt_op = MTFSF;
463 * ***FIXEM*** fix code to handle case that INT16_MAX is
466 mt_com.mt_count = INT16_MAX; /* use big positive number */
467 if (mt_com.mt_count < 0) {
468 mt_com.mt_count = INT16_MAX; /* brain damaged system */
472 if (dev_cap(dev, CAP_EOM)) {
473 Dmsg0(100,"Using EOM for EOM\n");
474 mt_com.mt_op = MTEOM;
477 if (dev_cap(dev, CAP_FASTFSF) || dev_cap(dev, CAP_EOM)) {
478 if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
479 Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
480 clrerror_dev(dev, mt_com.mt_op);
482 Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
483 dev->dev_name, strerror(dev->dev_errno));
487 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
488 dev->dev_errno = errno;
489 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
490 dev->dev_name, strerror(dev->dev_errno));
493 Dmsg2(100, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
494 dev->file = mt_stat.mt_fileno;
497 * Rewind then use FSF until EOT reached
503 if (!rewind_dev(dev)) {
507 * Move file by file to the end of the tape
510 for (file_num=dev->file; !(dev->state & ST_EOT); file_num++) {
511 Dmsg0(200, "eod_dev: doing fsf 1\n");
512 if (!fsf_dev(dev, 1)) {
513 Dmsg0(200, "fsf_dev error.\n");
517 * Avoid infinite loop. ***FIXME*** possibly add code
518 * to set EOD or to turn off CAP_FASTFSF if on.
520 if (file_num == (int)dev->file) {
521 struct mtget mt_stat;
522 Dmsg1(100, "fsf_dev did not advance from file %d\n", file_num);
523 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 &&
524 mt_stat.mt_fileno >= 0) {
525 Dmsg2(100, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
526 dev->file = mt_stat.mt_fileno;
529 break; /* we are not progressing, bail out */
534 * Some drivers leave us after second EOF when doing
535 * MTEOM, so we must backup so that appending overwrites
538 if (dev_cap(dev, CAP_BSFATEOM)) {
539 struct mtget mt_stat;
540 /* Backup over EOF */
541 stat = bsf_dev(dev, 1);
542 /* If BSF worked and fileno is known (not -1), set file */
543 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
544 Dmsg2(100, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
545 dev->file = mt_stat.mt_fileno;
547 dev->file++; /* wing it -- not correct on all OSes */
550 update_pos_dev(dev); /* update position */
553 Dmsg1(200, "EOD dev->file=%d\n", dev->file);
558 * Set the position of the device -- only for files
559 * For other devices, there is no generic way to do it.
560 * Returns: true on succes
563 bool update_pos_dev(DEVICE *dev)
569 dev->dev_errno = EBADF;
570 Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
571 Emsg0(M_FATAL, 0, dev->errmsg);
575 /* Find out where we are */
576 if (dev->state & ST_FILE) {
579 pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
581 Pmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
582 dev->dev_errno = errno;
583 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
584 dev->dev_name, strerror(dev->dev_errno));
587 dev->file_addr = pos;
595 * Return the status of the device. This was meant
596 * to be a generic routine. Unfortunately, it doesn't
597 * seem possible (at least I do not know how to do it
598 * currently), which means that for the moment, this
599 * routine has very little value.
603 uint32_t status_dev(DEVICE *dev)
605 struct mtget mt_stat;
608 if (dev->state & (ST_EOT | ST_WEOT)) {
612 if (dev->state & ST_EOF) {
616 if (dev->state & ST_TAPE) {
618 Dmsg0(-20," Bacula status:");
619 Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
620 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
621 dev->dev_errno = errno;
622 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
623 dev->dev_name, strerror(dev->dev_errno));
626 Dmsg0(-20, " Device status:");
628 #if defined(HAVE_LINUX_OS)
629 if (GMT_EOF(mt_stat.mt_gstat)) {
633 if (GMT_BOT(mt_stat.mt_gstat)) {
637 if (GMT_EOT(mt_stat.mt_gstat)) {
641 if (GMT_SM(mt_stat.mt_gstat)) {
645 if (GMT_EOD(mt_stat.mt_gstat)) {
649 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
651 Dmsg0(-20, " WR_PROT");
653 if (GMT_ONLINE(mt_stat.mt_gstat)) {
655 Dmsg0(-20, " ONLINE");
657 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
659 Dmsg0(-20, " DR_OPEN");
661 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
662 stat |= BMT_IM_REP_EN;
663 Dmsg0(-20, " IM_REP_EN");
665 #endif /* !SunOS && !OSF */
666 Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
668 stat |= BMT_ONLINE | BMT_BOT;
675 * Load medium in device
676 * Returns: true on success
679 bool load_dev(DEVICE *dev)
686 dev->dev_errno = EBADF;
687 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
688 Emsg0(M_FATAL, 0, dev->errmsg);
691 if (!(dev->state & ST_TAPE)) {
695 Dmsg0(200, "stored: MTLOAD command not available\n");
696 dev->dev_errno = ENOTTY; /* function not available */
697 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
698 dev->dev_name, strerror(dev->dev_errno)); return 0;
702 dev->block_num = dev->file = 0;
704 mt_com.mt_op = MTLOAD;
706 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
707 dev->dev_errno = errno;
708 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
709 dev->dev_name, strerror(dev->dev_errno)); return 0;
717 * Rewind device and put it offline
718 * Returns: true on success
721 bool offline_dev(DEVICE *dev)
726 dev->dev_errno = EBADF;
727 Mmsg0(&dev->errmsg, _("Bad call to offline_dev. Archive not open\n"));
728 Emsg0(M_FATAL, 0, dev->errmsg);
731 if (!(dev->state & ST_TAPE)) {
735 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
736 dev->block_num = dev->file = 0;
739 mt_com.mt_op = MTUNLOCK;
741 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
743 mt_com.mt_op = MTOFFL;
745 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
746 dev->dev_errno = errno;
747 Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
748 dev->dev_name, strerror(dev->dev_errno));
751 Dmsg1(100, "Offlined device %s\n", dev->dev_name);
755 int offline_or_rewind_dev(DEVICE *dev)
757 if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
758 return offline_dev(dev);
761 * Note, this rewind probably should not be here (it wasn't
762 * in prior versions of Bacula), but on FreeBSD, this is
763 * needed in the case the tape was "frozen" due to an error
764 * such as backspacing after writing and EOF. If it is not
765 * done, all future references to the drive get and I/O error.
767 return rewind_dev(dev);
772 * Foward space a file
773 * Returns: true on success
777 fsf_dev(DEVICE *dev, int num)
779 struct mtget mt_stat;
784 dev->dev_errno = EBADF;
785 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
786 Emsg0(M_FATAL, 0, dev->errmsg);
790 if (!(dev->state & ST_TAPE)) {
793 if (dev->state & ST_EOT) {
795 Mmsg1(dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
798 if (dev->state & ST_EOF) {
799 Dmsg0(200, "ST_EOF set on entry to FSF\n");
802 Dmsg0(29, "fsf_dev\n");
805 * If Fast forward space file is set, then we
806 * use MTFSF to forward space and MTIOCGET
807 * to get the file position. We assume that
808 * the SCSI driver will ensure that we do not
809 * forward space over the end of data mark.
811 if (dev_cap(dev, CAP_FSF) && dev_cap(dev, CAP_FASTFSF)) {
812 mt_com.mt_op = MTFSF;
813 mt_com.mt_count = num;
814 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
815 if (stat < 0 || ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
817 dev->state |= ST_EOT;
818 Dmsg0(200, "Set ST_EOT\n");
819 clrerror_dev(dev, MTFSF);
820 Mmsg2(dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
821 dev->dev_name, be.strerror());
822 Dmsg1(200, "%s", dev->errmsg);
825 Dmsg2(200, "fsf file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
826 dev->file = mt_stat.mt_fileno;
827 dev->state |= ST_EOF; /* just read EOF */
832 * Here if CAP_FSF is set, and virtually all drives
833 * these days support it, we read a record, then forward
834 * space one file. Using this procedure, which is slow,
835 * is the only way we can be sure that we don't read
836 * two consecutive EOF marks, which means End of Data.
838 } else if (dev_cap(dev, CAP_FSF)) {
841 Dmsg0(200, "FSF has cap_fsf\n");
842 if (dev->max_block_size == 0) {
843 rbuf_len = DEFAULT_BLOCK_SIZE;
845 rbuf_len = dev->max_block_size;
847 rbuf = get_memory(rbuf_len);
848 mt_com.mt_op = MTFSF;
850 while (num-- && !(dev->state & ST_EOT)) {
851 Dmsg0(200, "Doing read before fsf\n");
852 if ((stat = read(dev->fd, (char *)rbuf, rbuf_len)) < 0) {
853 if (errno == ENOMEM) { /* tape record exceeds buf len */
854 stat = rbuf_len; /* This is OK */
857 dev->state |= ST_EOT;
858 clrerror_dev(dev, -1);
859 Dmsg2(200, "Set ST_EOT read errno=%d. ERR=%s\n", dev->dev_errno,
861 Mmsg2(dev->errmsg, _("read error on %s. ERR=%s.\n"),
862 dev->dev_name, be.strerror(dev->dev_errno));
863 Dmsg1(200, "%s", dev->errmsg);
867 if (stat == 0) { /* EOF */
869 Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
870 /* Two reads of zero means end of tape */
871 if (dev->state & ST_EOF) {
872 dev->state |= ST_EOT;
873 Dmsg0(200, "Set ST_EOT\n");
876 dev->state |= ST_EOF;
881 } else { /* Got data */
882 dev->state &= ~(ST_EOF|ST_EOT);
885 Dmsg0(200, "Doing MTFSF\n");
886 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
887 if (stat < 0) { /* error => EOT */
888 dev->state |= ST_EOT;
889 Dmsg0(200, "Set ST_EOT\n");
890 clrerror_dev(dev, MTFSF);
891 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
892 dev->dev_name, strerror(dev->dev_errno));
893 Dmsg0(200, "Got < 0 for MTFSF\n");
894 Dmsg1(200, "%s", dev->errmsg);
896 dev->state |= ST_EOF; /* just read EOF */
904 * No FSF, so use FSR to simulate it
907 Dmsg0(200, "Doing FSR for FSF\n");
908 while (num-- && !(dev->state & ST_EOT)) {
909 fsr_dev(dev, INT32_MAX); /* returns -1 on EOF or EOT */
911 if (dev->state & ST_EOT) {
913 Mmsg1(dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
920 Dmsg1(200, "Return %d from FSF\n", stat);
921 if (dev->state & ST_EOF)
922 Dmsg0(200, "ST_EOF set on exit FSF\n");
923 if (dev->state & ST_EOT)
924 Dmsg0(200, "ST_EOT set on exit FSF\n");
925 Dmsg1(200, "Return from FSF file=%d\n", dev->file);
930 * Backward space a file
931 * Returns: false on failure
935 bsf_dev(DEVICE *dev, int num)
941 dev->dev_errno = EBADF;
942 Mmsg0(dev->errmsg, _("Bad call to bsf_dev. Archive device not open\n"));
943 Emsg0(M_FATAL, 0, dev->errmsg);
947 if (!(dev_state(dev, ST_TAPE))) {
948 Mmsg1(dev->errmsg, _("Device %s cannot BSF because it is not a tape.\n"),
952 Dmsg0(29, "bsf_dev\n");
953 dev->state &= ~(ST_EOT|ST_EOF);
956 mt_com.mt_op = MTBSF;
957 mt_com.mt_count = num;
958 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
960 clrerror_dev(dev, MTBSF);
961 Mmsg2(dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
962 dev->dev_name, strerror(dev->dev_errno));
970 * Foward space a record
971 * Returns: false on failure
975 fsr_dev(DEVICE *dev, int num)
981 dev->dev_errno = EBADF;
982 Mmsg0(dev->errmsg, _("Bad call to fsr_dev. Archive not open\n"));
983 Emsg0(M_FATAL, 0, dev->errmsg);
987 if (!(dev_state(dev, ST_TAPE))) {
990 if (!dev_cap(dev, CAP_FSR)) {
991 Mmsg1(dev->errmsg, _("ioctl MTFSR not permitted on %s.\n"), dev->dev_name);
995 Dmsg0(29, "fsr_dev\n");
996 mt_com.mt_op = MTFSR;
997 mt_com.mt_count = num;
998 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1000 dev->state &= ~ST_EOF;
1001 dev->block_num += num;
1003 struct mtget mt_stat;
1004 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
1005 Dmsg4(100, "Adjust from %d:%d to %d:%d\n", dev->file,
1006 dev->block_num, mt_stat.mt_fileno, mt_stat.mt_blkno);
1007 dev->file = mt_stat.mt_fileno;
1008 dev->block_num = mt_stat.mt_blkno;
1010 if (dev->state & ST_EOF) {
1011 dev->state |= ST_EOT;
1013 dev->state |= ST_EOF; /* assume EOF */
1019 clrerror_dev(dev, MTFSR);
1020 Mmsg2(dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
1021 dev->dev_name, strerror(dev->dev_errno));
1023 update_pos_dev(dev);
1028 * Backward space a record
1029 * Returns: false on failure
1033 bsr_dev(DEVICE *dev, int num)
1039 dev->dev_errno = EBADF;
1040 Mmsg0(dev->errmsg, _("Bad call to bsr_dev. Archive not open\n"));
1041 Emsg0(M_FATAL, 0, dev->errmsg);
1045 if (!(dev->state & ST_TAPE)) {
1049 if (!dev_cap(dev, CAP_BSR)) {
1050 Mmsg1(dev->errmsg, _("ioctl MTBSR not permitted on %s.\n"), dev->dev_name);
1054 Dmsg0(29, "bsr_dev\n");
1055 dev->block_num -= num;
1056 dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
1057 mt_com.mt_op = MTBSR;
1058 mt_com.mt_count = num;
1059 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1061 clrerror_dev(dev, MTBSR);
1062 Mmsg2(dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
1063 dev->dev_name, strerror(dev->dev_errno));
1065 update_pos_dev(dev);
1070 * Reposition the device to file, block
1071 * Returns: false on failure
1075 reposition_dev(DEVICE *dev, uint32_t file, uint32_t block)
1078 dev->dev_errno = EBADF;
1079 Mmsg0(dev->errmsg, _("Bad call to reposition_dev. Archive not open\n"));
1080 Emsg0(M_FATAL, 0, dev->errmsg);
1084 if (!(dev_state(dev, ST_TAPE))) {
1085 off_t pos = (((off_t)file)<<32) + block;
1086 Dmsg1(100, "===== lseek to %d\n", (int)pos);
1087 if (lseek(dev->fd, pos, SEEK_SET) == (off_t)-1) {
1088 dev->dev_errno = errno;
1089 Mmsg2(dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
1090 dev->dev_name, strerror(dev->dev_errno));
1094 dev->block_num = block;
1095 dev->file_addr = pos;
1098 Dmsg4(100, "reposition_dev from %u:%u to %u:%u\n",
1099 dev->file, dev->block_num, file, block);
1100 if (file < dev->file) {
1101 Dmsg0(100, "Rewind_dev\n");
1102 if (!rewind_dev(dev)) {
1106 if (file > dev->file) {
1107 Dmsg1(100, "fsf %d\n", file-dev->file);
1108 if (!fsf_dev(dev, file-dev->file)) {
1112 if (block < dev->block_num) {
1116 if (dev_cap(dev, CAP_POSITIONBLOCKS) && block > dev->block_num) {
1117 /* Ignore errors as Bacula can read to the correct block */
1118 Dmsg1(100, "fsr %d\n", block-dev->block_num);
1119 return fsr_dev(dev, block-dev->block_num);
1127 * Write an end of file on the device
1128 * Returns: 0 on success
1129 * non-zero on failure
1132 weof_dev(DEVICE *dev, int num)
1138 dev->dev_errno = EBADF;
1139 Mmsg0(dev->errmsg, _("Bad call to weof_dev. Archive drive not open\n"));
1140 Emsg0(M_FATAL, 0, dev->errmsg);
1144 if (!(dev_state(dev, ST_TAPE))) {
1147 dev->state &= ~(ST_EOT | ST_EOF); /* remove EOF/EOT flags */
1149 Dmsg0(29, "weof_dev\n");
1150 mt_com.mt_op = MTWEOF;
1151 mt_com.mt_count = num;
1152 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1158 clrerror_dev(dev, MTWEOF);
1160 Mmsg2(dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
1161 dev->dev_name, be.strerror());
1168 * Return string message with last error in English
1169 * Be careful not to call this routine from within dev.c
1170 * while editing an Mmsg() or you will end up in a recursive
1171 * loop creating a Segmentation Violation.
1174 strerror_dev(DEVICE *dev)
1181 * If implemented in system, clear the tape
1185 clrerror_dev(DEVICE *dev, int func)
1187 const char *msg = NULL;
1188 struct mtget mt_stat;
1190 dev->dev_errno = errno; /* save errno */
1192 dev->VolCatInfo.VolCatErrors++;
1195 if (!(dev->state & ST_TAPE)) {
1198 if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
1201 Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
1205 dev->capabilities &= ~CAP_EOF; /* turn off feature */
1210 dev->capabilities &= ~CAP_EOM; /* turn off feature */
1215 dev->capabilities &= ~CAP_FSF; /* turn off feature */
1219 dev->capabilities &= ~CAP_BSF; /* turn off feature */
1223 dev->capabilities &= ~CAP_FSR; /* turn off feature */
1227 dev->capabilities &= ~CAP_BSR; /* turn off feature */
1234 dev->dev_errno = ENOSYS;
1235 Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
1236 Emsg0(M_ERROR, 0, dev->errmsg);
1239 /* On some systems such as NetBSD, this clears all errors */
1240 ioctl(dev->fd, MTIOCGET, (char *)&mt_stat);
1242 /* Found on Linux */
1246 mt_com.mt_op = MTIOCLRERR;
1247 mt_com.mt_count = 1;
1248 /* Clear any error condition on the tape */
1249 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1250 Dmsg0(200, "Did MTIOCLRERR\n");
1254 /* Typically on FreeBSD */
1257 /* Read and clear SCSI error status */
1258 union mterrstat mt_errstat;
1259 Dmsg2(200, "Doing MTIOCERRSTAT errno=%d ERR=%s\n", dev->dev_errno,
1260 strerror(dev->dev_errno));
1261 ioctl(dev->fd, MTIOCERRSTAT, (char *)&mt_errstat);
1267 * Flush buffer contents
1270 int flush_dev(DEVICE *dev)
1275 static void do_close(DEVICE *dev)
1278 Dmsg1(29, "really close_dev %s\n", dev->dev_name);
1282 /* Clean up device packet so it can be reused */
1284 dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1285 dev->file = dev->block_num = 0;
1287 dev->EndFile = dev->EndBlock = 0;
1288 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1289 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1291 stop_thread_timer(dev->tid);
1301 close_dev(DEVICE *dev)
1304 Mmsg0(&dev->errmsg, _("Bad call to close_dev. Archive not open\n"));
1305 Emsg0(M_FATAL, 0, dev->errmsg);
1308 if (dev->fd >= 0 && dev->use_count == 1) {
1310 } else if (dev->use_count > 0) {
1315 ASSERT(dev->use_count >= 0);
1320 * Used when unmounting the device, ignore use_count
1322 void force_close_dev(DEVICE *dev)
1325 Mmsg0(&dev->errmsg, _("Bad call to force_close_dev. Archive not open\n"));
1326 Emsg0(M_FATAL, 0, dev->errmsg);
1329 Dmsg1(29, "Force close_dev %s\n", dev->dev_name);
1333 ASSERT(dev->use_count >= 0);
1337 bool truncate_dev(DEVICE *dev)
1339 if (dev->state & ST_TAPE) {
1340 return true; /* we don't really truncate tapes */
1341 /* maybe we should rewind and write and eof ???? */
1343 if (ftruncate(dev->fd, 0) != 0) {
1344 Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1351 dev_is_tape(DEVICE *dev)
1353 return (dev->state & ST_TAPE) ? true : false;
1358 * return 1 if the device is read for write, and 0 otherwise
1359 * This is meant for checking at the end of a job to see
1360 * if we still have a tape (perhaps not if at end of tape
1361 * and the job is canceled).
1364 dev_can_write(DEVICE *dev)
1366 if ((dev->state & ST_OPENED) && (dev->state & ST_APPEND) &&
1367 (dev->state & ST_LABEL) && !(dev->state & ST_WEOT)) {
1375 dev_name(DEVICE *dev)
1377 return dev->dev_name;
1381 dev_vol_name(DEVICE *dev)
1383 return dev->VolCatInfo.VolCatName;
1386 uint32_t dev_block(DEVICE *dev)
1388 update_pos_dev(dev);
1389 return dev->block_num;
1392 uint32_t dev_file(DEVICE *dev)
1394 update_pos_dev(dev);
1399 * Free memory allocated for the device
1402 term_dev(DEVICE *dev)
1405 dev->dev_errno = EBADF;
1406 Mmsg0(&dev->errmsg, _("Bad call to term_dev. Archive not open\n"));
1407 Emsg0(M_FATAL, 0, dev->errmsg);
1411 Dmsg0(29, "term_dev\n");
1412 if (dev->dev_name) {
1413 free_memory(dev->dev_name);
1414 dev->dev_name = NULL;
1417 free_pool_memory(dev->errmsg);
1420 pthread_mutex_destroy(&dev->mutex);
1421 pthread_cond_destroy(&dev->wait);
1422 pthread_cond_destroy(&dev->wait_next_vol);
1423 pthread_mutex_destroy(&dev->spool_mutex);
1424 rwl_destroy(&dev->lock);
1425 if (dev->attached_dcrs) {
1426 delete dev->attached_dcrs;
1427 dev->attached_dcrs = NULL;
1429 if (dev->state & ST_MALLOC) {
1430 free_pool_memory((POOLMEM *)dev);
1435 * This routine initializes the device wait timers
1437 void init_dev_wait_timers(DEVICE *dev)
1439 /* ******FIXME******* put these on config variables */
1440 dev->min_wait = 60 * 60;
1441 dev->max_wait = 24 * 60 * 60;
1442 dev->max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
1443 dev->wait_sec = dev->min_wait;
1444 dev->rem_wait_sec = dev->wait_sec;
1447 dev->BadVolName[0] = 0;
1451 * Returns: true if time doubled
1452 * false if max time expired
1454 bool double_dev_wait_time(DEVICE *dev)
1456 dev->wait_sec *= 2; /* double wait time */
1457 if (dev->wait_sec > dev->max_wait) { /* but not longer than maxtime */
1458 dev->wait_sec = dev->max_wait;
1461 dev->rem_wait_sec = dev->wait_sec;
1462 if (dev->num_wait >= dev->max_num_wait) {