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 */
84 void set_os_device_parameters(DEVICE *dev);
87 * Allocate and initialize the DEVICE structure
88 * Note, if dev is non-NULL, it is already allocated,
89 * thus we neither allocate it nor free it. This allows
90 * the caller to put the packet in shared memory.
92 * Note, for a tape, the device->device_name is the device name
93 * (e.g. /dev/nst0), and for a file, the device name
94 * is the directory in which the file will be placed.
98 init_dev(DEVICE *dev, DEVRES *device)
105 /* Check that device is available */
106 if (stat(device->device_name, &statp) < 0) {
109 dev->dev_errno = errno;
111 Emsg2(M_FATAL, 0, "Unable to stat device %s : %s\n", device->device_name,
117 if (S_ISDIR(statp.st_mode)) {
119 } else if (S_ISCHR(statp.st_mode)) {
121 } else if (S_ISFIFO(statp.st_mode)) {
125 dev->dev_errno = ENODEV;
127 Emsg2(M_FATAL, 0, _("%s is an unknown device type. Must be tape or directory. st_mode=%x\n"),
128 device->device_name, statp.st_mode);
132 dev = (DEVICE *)get_memory(sizeof(DEVICE));
133 memset(dev, 0, sizeof(DEVICE));
134 dev->state = ST_MALLOC;
136 memset(dev, 0, sizeof(DEVICE));
139 /* Copy user supplied device parameters from Resource */
140 dev->dev_name = get_memory(strlen(device->device_name)+1);
141 strcpy(dev->dev_name, device->device_name);
142 dev->capabilities = device->cap_bits;
143 dev->min_block_size = device->min_block_size;
144 dev->max_block_size = device->max_block_size;
145 dev->max_volume_size = device->max_volume_size;
146 dev->max_file_size = device->max_file_size;
147 dev->volume_capacity = device->volume_capacity;
148 dev->max_rewind_wait = device->max_rewind_wait;
149 dev->max_open_wait = device->max_open_wait;
150 dev->max_open_vols = device->max_open_vols;
151 dev->vol_poll_interval = device->vol_poll_interval;
152 dev->max_spool_size = device->max_spool_size;
153 dev->drive_index = device->drive_index;
155 if (dev->vol_poll_interval && dev->vol_poll_interval < 60) {
156 dev->vol_poll_interval = 60;
158 dev->device = device;
161 dev->state |= ST_TAPE;
163 dev->state |= ST_FIFO;
164 dev->capabilities |= CAP_STREAM; /* set stream device */
166 dev->state |= ST_FILE;
169 if (dev->max_block_size > 1000000) {
170 Emsg3(M_ERROR, 0, _("Block size %u on device %s is too large, using default %u\n"),
171 dev->max_block_size, dev->dev_name, DEFAULT_BLOCK_SIZE);
172 dev->max_block_size = 0;
174 if (dev->max_block_size % TAPE_BSIZE != 0) {
175 Emsg2(M_WARNING, 0, _("Max block size %u not multiple of device %s block size.\n"),
176 dev->max_block_size, dev->dev_name);
179 dev->errmsg = get_pool_memory(PM_EMSG);
182 if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
184 dev->dev_errno = errstat;
185 Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
186 Emsg0(M_FATAL, 0, dev->errmsg);
188 if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
190 dev->dev_errno = errstat;
191 Mmsg1(dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), be.strerror(errstat));
192 Emsg0(M_FATAL, 0, dev->errmsg);
194 if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
196 dev->dev_errno = errstat;
197 Mmsg1(dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), be.strerror(errstat));
198 Emsg0(M_FATAL, 0, dev->errmsg);
200 if ((errstat = pthread_mutex_init(&dev->spool_mutex, NULL)) != 0) {
202 dev->dev_errno = errstat;
203 Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
204 Emsg0(M_FATAL, 0, dev->errmsg);
206 if ((errstat = rwl_init(&dev->lock)) != 0) {
208 dev->dev_errno = errstat;
209 Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
210 Emsg0(M_FATAL, 0, dev->errmsg);
214 dev->attached_dcrs = New(dlist(dcr, &dcr->dev_link));
215 Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
220 /* Open the device with the operating system and
221 * initialize buffer pointers.
223 * Note, for a tape, the VolName is the name we give to the
224 * volume (not really used here), but for a file, the
225 * VolName represents the name of the file to be created/opened.
226 * In the case of a file, the full name is the device name
227 * (archive_name) with the VolName concatenated.
230 open_dev(DEVICE *dev, char *VolName, int mode)
232 POOLMEM *archive_name;
234 if (dev->state & ST_OPENED) {
236 * *****FIXME***** how to handle two threads wanting
237 * different volumes mounted???? E.g. one is waiting
238 * for the next volume to be mounted, and a new job
239 * starts and snatches up the device.
241 if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
245 Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
246 dev->dev_name, dev->use_count);
247 Emsg1(M_WARNING, 0, "%s", dev->errmsg);
251 bstrncpy(dev->VolCatInfo.VolCatName, VolName, sizeof(dev->VolCatInfo.VolCatName));
254 Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
255 dev->dev_name, dev->VolCatInfo.VolCatName);
256 dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
257 if (dev->state & (ST_TAPE|ST_FIFO)) {
259 Dmsg0(29, "open_dev: device is tape\n");
260 if (mode == OPEN_READ_WRITE) {
261 dev->mode = O_RDWR | O_BINARY;
262 } else if (mode == OPEN_READ_ONLY) {
263 dev->mode = O_RDONLY | O_BINARY;
264 } else if (mode == OPEN_WRITE_ONLY) {
265 dev->mode = O_WRONLY | O_BINARY;
267 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
269 timeout = dev->max_open_wait;
271 if (dev->state & ST_FIFO && timeout) {
273 dev->tid = start_thread_timer(pthread_self(), timeout);
275 /* If busy retry each second for max_open_wait seconds */
276 while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
277 if (errno == EINTR || errno == EAGAIN) {
280 if (errno == EBUSY && timeout-- > 0) {
281 Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
285 dev->dev_errno = errno;
286 Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
287 dev->dev_name, strerror(dev->dev_errno));
288 /* Stop any open timer we set */
290 stop_thread_timer(dev->tid);
293 Emsg0(M_FATAL, 0, dev->errmsg);
298 dev->state |= ST_OPENED;
300 update_pos_dev(dev); /* update position */
301 set_os_device_parameters(dev); /* do system dependent stuff */
303 /* Stop any open() timer we started */
305 stop_thread_timer(dev->tid);
308 Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
311 * Handle opening of File Archive (not a tape)
313 if (VolName == NULL || *VolName == 0) {
314 Mmsg(dev->errmsg, _("Could not open file device %s. No Volume name given.\n"),
318 archive_name = get_pool_memory(PM_FNAME);
319 pm_strcpy(archive_name, dev->dev_name);
320 if (archive_name[strlen(archive_name)] != '/') {
321 pm_strcat(archive_name, "/");
323 pm_strcat(archive_name, VolName);
324 Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
325 if (mode == OPEN_READ_WRITE) {
326 dev->mode = O_CREAT | O_RDWR | O_BINARY;
327 } else if (mode == OPEN_READ_ONLY) {
328 dev->mode = O_RDONLY | O_BINARY;
329 } else if (mode == OPEN_WRITE_ONLY) {
330 dev->mode = O_WRONLY | O_BINARY;
332 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
334 /* If creating file, give 0640 permissions */
335 if ((dev->fd = open(archive_name, dev->mode, 0640)) < 0) {
336 dev->dev_errno = errno;
337 Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
338 Emsg0(M_FATAL, 0, dev->errmsg);
341 dev->state |= ST_OPENED;
343 update_pos_dev(dev); /* update position */
345 Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
346 free_pool_memory(archive_name);
353 int _rewind_dev(char *file, int line, DEVICE *dev)
355 Dmsg2(100, "rewind_dev called from %s:%d\n", file, line);
356 return rewind_dev(dev);
363 * Returns: 1 on success
366 int rewind_dev(DEVICE *dev)
371 Dmsg1(29, "rewind_dev %s\n", dev->dev_name);
373 dev->dev_errno = EBADF;
374 Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
376 Emsg0(M_FATAL, 0, dev->errmsg);
379 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
380 dev->block_num = dev->file = 0;
382 if (dev->state & ST_TAPE) {
383 mt_com.mt_op = MTREW;
385 /* If we get an I/O error on rewind, it is probably because
386 * the drive is actually busy. We loop for (about 5 minutes)
387 * retrying every 5 seconds.
389 for (i=dev->max_rewind_wait; ; i -= 5) {
390 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
391 if (i == dev->max_rewind_wait) {
392 Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
394 clrerror_dev(dev, MTREW);
395 if (dev->dev_errno == EIO && i > 0) {
396 Dmsg0(200, "Sleeping 5 seconds.\n");
400 Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
401 dev->dev_name, strerror(dev->dev_errno));
406 } else if (dev->state & ST_FILE) {
407 if (lseek(dev->fd, (off_t)0, SEEK_SET) < 0) {
408 dev->dev_errno = errno;
409 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
410 dev->dev_name, strerror(dev->dev_errno));
418 * Position device to end of medium (end of data)
419 * Returns: 1 on succes
426 struct mtget mt_stat;
430 Dmsg0(29, "eod_dev\n");
431 if (dev->state & ST_EOT) {
434 dev->state &= ~(ST_EOF); /* remove EOF flags */
435 dev->block_num = dev->file = 0;
437 if (dev->state & (ST_FIFO | ST_PROG)) {
440 if (!(dev->state & ST_TAPE)) {
441 pos = lseek(dev->fd, (off_t)0, SEEK_END);
442 // Dmsg1(100, "====== Seek to %lld\n", pos);
445 dev->state |= ST_EOT;
448 dev->dev_errno = errno;
449 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
450 dev->dev_name, strerror(dev->dev_errno));
455 if (dev_cap(dev, CAP_FASTFSF) && !dev_cap(dev, CAP_EOM)) {
456 struct mtget mt_stat;
457 Dmsg0(100,"Using FAST FSF for EOM\n");
458 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno <= 0) {
459 if (!rewind_dev(dev)) {
463 mt_com.mt_op = MTFSF;
465 * ***FIXEM*** fix code to handle case that INT16_MAX is
468 mt_com.mt_count = INT16_MAX; /* use big positive number */
469 if (mt_com.mt_count < 0) {
470 mt_com.mt_count = INT16_MAX; /* brain damaged system */
474 if (dev_cap(dev, CAP_EOM)) {
475 Dmsg0(100,"Using EOM for EOM\n");
476 mt_com.mt_op = MTEOM;
479 if (dev_cap(dev, CAP_FASTFSF) || dev_cap(dev, CAP_EOM)) {
480 if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
481 Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
482 clrerror_dev(dev, mt_com.mt_op);
484 Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
485 dev->dev_name, strerror(dev->dev_errno));
489 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
490 dev->dev_errno = errno;
491 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
492 dev->dev_name, strerror(dev->dev_errno));
495 Dmsg2(100, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
496 dev->file = mt_stat.mt_fileno;
499 * Rewind then use FSF until EOT reached
505 if (!rewind_dev(dev)) {
509 * Move file by file to the end of the tape
512 for (file_num=dev->file; !(dev->state & ST_EOT); file_num++) {
513 Dmsg0(200, "eod_dev: doing fsf 1\n");
514 if (!fsf_dev(dev, 1)) {
515 Dmsg0(200, "fsf_dev error.\n");
519 * Avoid infinite loop. ***FIXME*** possibly add code
520 * to set EOD or to turn off CAP_FASTFSF if on.
522 if (file_num == (int)dev->file) {
523 struct mtget mt_stat;
524 Dmsg1(100, "fsf_dev did not advance from file %d\n", file_num);
525 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 &&
526 mt_stat.mt_fileno >= 0) {
527 Dmsg2(100, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
528 dev->file = mt_stat.mt_fileno;
531 break; /* we are not progressing, bail out */
536 * Some drivers leave us after second EOF when doing
537 * MTEOM, so we must backup so that appending overwrites
540 if (dev_cap(dev, CAP_BSFATEOM)) {
541 struct mtget mt_stat;
542 /* Backup over EOF */
543 stat = bsf_dev(dev, 1);
544 /* If BSF worked and fileno is known (not -1), set file */
545 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
546 Dmsg2(100, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
547 dev->file = mt_stat.mt_fileno;
549 dev->file++; /* wing it -- not correct on all OSes */
552 update_pos_dev(dev); /* update position */
555 Dmsg1(200, "EOD dev->file=%d\n", dev->file);
560 * Set the position of the device -- only for files
561 * For other devices, there is no generic way to do it.
562 * Returns: true on succes
565 bool update_pos_dev(DEVICE *dev)
571 dev->dev_errno = EBADF;
572 Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
573 Emsg0(M_FATAL, 0, dev->errmsg);
577 /* Find out where we are */
578 if (dev->state & ST_FILE) {
581 pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
583 Pmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
584 dev->dev_errno = errno;
585 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
586 dev->dev_name, strerror(dev->dev_errno));
589 dev->file_addr = pos;
597 * Return the status of the device. This was meant
598 * to be a generic routine. Unfortunately, it doesn't
599 * seem possible (at least I do not know how to do it
600 * currently), which means that for the moment, this
601 * routine has very little value.
605 uint32_t status_dev(DEVICE *dev)
607 struct mtget mt_stat;
610 if (dev->state & (ST_EOT | ST_WEOT)) {
614 if (dev->state & ST_EOF) {
618 if (dev->state & ST_TAPE) {
620 Dmsg0(-20," Bacula status:");
621 Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
622 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
623 dev->dev_errno = errno;
624 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
625 dev->dev_name, strerror(dev->dev_errno));
628 Dmsg0(-20, " Device status:");
630 #if defined(HAVE_LINUX_OS)
631 if (GMT_EOF(mt_stat.mt_gstat)) {
635 if (GMT_BOT(mt_stat.mt_gstat)) {
639 if (GMT_EOT(mt_stat.mt_gstat)) {
643 if (GMT_SM(mt_stat.mt_gstat)) {
647 if (GMT_EOD(mt_stat.mt_gstat)) {
651 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
653 Dmsg0(-20, " WR_PROT");
655 if (GMT_ONLINE(mt_stat.mt_gstat)) {
657 Dmsg0(-20, " ONLINE");
659 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
661 Dmsg0(-20, " DR_OPEN");
663 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
664 stat |= BMT_IM_REP_EN;
665 Dmsg0(-20, " IM_REP_EN");
667 #endif /* !SunOS && !OSF */
668 Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
670 stat |= BMT_ONLINE | BMT_BOT;
677 * Load medium in device
678 * Returns: true on success
681 bool load_dev(DEVICE *dev)
688 dev->dev_errno = EBADF;
689 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
690 Emsg0(M_FATAL, 0, dev->errmsg);
693 if (!(dev->state & ST_TAPE)) {
697 Dmsg0(200, "stored: MTLOAD command not available\n");
698 dev->dev_errno = ENOTTY; /* function not available */
699 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
700 dev->dev_name, strerror(dev->dev_errno)); return 0;
704 dev->block_num = dev->file = 0;
706 mt_com.mt_op = MTLOAD;
708 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
709 dev->dev_errno = errno;
710 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
711 dev->dev_name, strerror(dev->dev_errno)); return 0;
719 * Rewind device and put it offline
720 * Returns: true on success
723 bool offline_dev(DEVICE *dev)
728 dev->dev_errno = EBADF;
729 Mmsg0(&dev->errmsg, _("Bad call to offline_dev. Archive not open\n"));
730 Emsg0(M_FATAL, 0, dev->errmsg);
733 if (!(dev->state & ST_TAPE)) {
737 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
738 dev->block_num = dev->file = 0;
741 mt_com.mt_op = MTUNLOCK;
743 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
745 mt_com.mt_op = MTOFFL;
747 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
748 dev->dev_errno = errno;
749 Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
750 dev->dev_name, strerror(dev->dev_errno));
753 Dmsg1(100, "Offlined device %s\n", dev->dev_name);
757 int offline_or_rewind_dev(DEVICE *dev)
759 if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
760 return offline_dev(dev);
763 * Note, this rewind probably should not be here (it wasn't
764 * in prior versions of Bacula), but on FreeBSD, this is
765 * needed in the case the tape was "frozen" due to an error
766 * such as backspacing after writing and EOF. If it is not
767 * done, all future references to the drive get and I/O error.
769 return rewind_dev(dev);
774 * Foward space a file
775 * Returns: true on success
779 fsf_dev(DEVICE *dev, int num)
781 struct mtget mt_stat;
786 dev->dev_errno = EBADF;
787 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
788 Emsg0(M_FATAL, 0, dev->errmsg);
792 if (!(dev->state & ST_TAPE)) {
795 if (dev->state & ST_EOT) {
797 Mmsg1(dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
800 if (dev->state & ST_EOF) {
801 Dmsg0(200, "ST_EOF set on entry to FSF\n");
804 Dmsg0(29, "fsf_dev\n");
807 * If Fast forward space file is set, then we
808 * use MTFSF to forward space and MTIOCGET
809 * to get the file position. We assume that
810 * the SCSI driver will ensure that we do not
811 * forward space over the end of data mark.
813 if (dev_cap(dev, CAP_FSF) && dev_cap(dev, CAP_FASTFSF)) {
814 mt_com.mt_op = MTFSF;
815 mt_com.mt_count = num;
816 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
817 if (stat < 0 || ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
819 dev->state |= ST_EOT;
820 Dmsg0(200, "Set ST_EOT\n");
821 clrerror_dev(dev, MTFSF);
822 Mmsg2(dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
823 dev->dev_name, be.strerror());
824 Dmsg1(200, "%s", dev->errmsg);
827 Dmsg2(200, "fsf file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
828 dev->file = mt_stat.mt_fileno;
829 dev->state |= ST_EOF; /* just read EOF */
834 * Here if CAP_FSF is set, and virtually all drives
835 * these days support it, we read a record, then forward
836 * space one file. Using this procedure, which is slow,
837 * is the only way we can be sure that we don't read
838 * two consecutive EOF marks, which means End of Data.
840 } else if (dev_cap(dev, CAP_FSF)) {
843 Dmsg0(200, "FSF has cap_fsf\n");
844 if (dev->max_block_size == 0) {
845 rbuf_len = DEFAULT_BLOCK_SIZE;
847 rbuf_len = dev->max_block_size;
849 rbuf = get_memory(rbuf_len);
850 mt_com.mt_op = MTFSF;
852 while (num-- && !(dev->state & ST_EOT)) {
853 Dmsg0(200, "Doing read before fsf\n");
854 if ((stat = read(dev->fd, (char *)rbuf, rbuf_len)) < 0) {
855 if (errno == ENOMEM) { /* tape record exceeds buf len */
856 stat = rbuf_len; /* This is OK */
859 dev->state |= ST_EOT;
860 clrerror_dev(dev, -1);
861 Dmsg2(200, "Set ST_EOT read errno=%d. ERR=%s\n", dev->dev_errno,
863 Mmsg2(dev->errmsg, _("read error on %s. ERR=%s.\n"),
864 dev->dev_name, be.strerror(dev->dev_errno));
865 Dmsg1(200, "%s", dev->errmsg);
869 if (stat == 0) { /* EOF */
871 Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
872 /* Two reads of zero means end of tape */
873 if (dev->state & ST_EOF) {
874 dev->state |= ST_EOT;
875 Dmsg0(200, "Set ST_EOT\n");
878 dev->state |= ST_EOF;
883 } else { /* Got data */
884 dev->state &= ~(ST_EOF|ST_EOT);
887 Dmsg0(200, "Doing MTFSF\n");
888 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
889 if (stat < 0) { /* error => EOT */
890 dev->state |= ST_EOT;
891 Dmsg0(200, "Set ST_EOT\n");
892 clrerror_dev(dev, MTFSF);
893 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
894 dev->dev_name, strerror(dev->dev_errno));
895 Dmsg0(200, "Got < 0 for MTFSF\n");
896 Dmsg1(200, "%s", dev->errmsg);
898 dev->state |= ST_EOF; /* just read EOF */
906 * No FSF, so use FSR to simulate it
909 Dmsg0(200, "Doing FSR for FSF\n");
910 while (num-- && !(dev->state & ST_EOT)) {
911 fsr_dev(dev, INT32_MAX); /* returns -1 on EOF or EOT */
913 if (dev->state & ST_EOT) {
915 Mmsg1(dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
922 Dmsg1(200, "Return %d from FSF\n", stat);
923 if (dev->state & ST_EOF)
924 Dmsg0(200, "ST_EOF set on exit FSF\n");
925 if (dev->state & ST_EOT)
926 Dmsg0(200, "ST_EOT set on exit FSF\n");
927 Dmsg1(200, "Return from FSF file=%d\n", dev->file);
932 * Backward space a file
933 * Returns: false on failure
937 bsf_dev(DEVICE *dev, int num)
943 dev->dev_errno = EBADF;
944 Mmsg0(dev->errmsg, _("Bad call to bsf_dev. Archive device not open\n"));
945 Emsg0(M_FATAL, 0, dev->errmsg);
949 if (!(dev_state(dev, ST_TAPE))) {
950 Mmsg1(dev->errmsg, _("Device %s cannot BSF because it is not a tape.\n"),
954 Dmsg0(29, "bsf_dev\n");
955 dev->state &= ~(ST_EOT|ST_EOF);
958 mt_com.mt_op = MTBSF;
959 mt_com.mt_count = num;
960 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
962 clrerror_dev(dev, MTBSF);
963 Mmsg2(dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
964 dev->dev_name, strerror(dev->dev_errno));
972 * Foward space a record
973 * Returns: false on failure
977 fsr_dev(DEVICE *dev, int num)
983 dev->dev_errno = EBADF;
984 Mmsg0(dev->errmsg, _("Bad call to fsr_dev. Archive not open\n"));
985 Emsg0(M_FATAL, 0, dev->errmsg);
989 if (!(dev_state(dev, ST_TAPE))) {
992 if (!dev_cap(dev, CAP_FSR)) {
993 Mmsg1(dev->errmsg, _("ioctl MTFSR not permitted on %s.\n"), dev->dev_name);
997 Dmsg0(29, "fsr_dev\n");
998 mt_com.mt_op = MTFSR;
999 mt_com.mt_count = num;
1000 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1002 dev->state &= ~ST_EOF;
1003 dev->block_num += num;
1005 struct mtget mt_stat;
1006 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
1007 Dmsg4(100, "Adjust from %d:%d to %d:%d\n", dev->file,
1008 dev->block_num, mt_stat.mt_fileno, mt_stat.mt_blkno);
1009 dev->file = mt_stat.mt_fileno;
1010 dev->block_num = mt_stat.mt_blkno;
1012 if (dev->state & ST_EOF) {
1013 dev->state |= ST_EOT;
1015 dev->state |= ST_EOF; /* assume EOF */
1021 clrerror_dev(dev, MTFSR);
1022 Mmsg2(dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
1023 dev->dev_name, strerror(dev->dev_errno));
1025 update_pos_dev(dev);
1030 * Backward space a record
1031 * Returns: false on failure
1035 bsr_dev(DEVICE *dev, int num)
1041 dev->dev_errno = EBADF;
1042 Mmsg0(dev->errmsg, _("Bad call to bsr_dev. Archive not open\n"));
1043 Emsg0(M_FATAL, 0, dev->errmsg);
1047 if (!(dev->state & ST_TAPE)) {
1051 if (!dev_cap(dev, CAP_BSR)) {
1052 Mmsg1(dev->errmsg, _("ioctl MTBSR not permitted on %s.\n"), dev->dev_name);
1056 Dmsg0(29, "bsr_dev\n");
1057 dev->block_num -= num;
1058 dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
1059 mt_com.mt_op = MTBSR;
1060 mt_com.mt_count = num;
1061 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1063 clrerror_dev(dev, MTBSR);
1064 Mmsg2(dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
1065 dev->dev_name, strerror(dev->dev_errno));
1067 update_pos_dev(dev);
1072 * Reposition the device to file, block
1073 * Returns: false on failure
1077 reposition_dev(DEVICE *dev, uint32_t file, uint32_t block)
1080 dev->dev_errno = EBADF;
1081 Mmsg0(dev->errmsg, _("Bad call to reposition_dev. Archive not open\n"));
1082 Emsg0(M_FATAL, 0, dev->errmsg);
1086 if (!(dev_state(dev, ST_TAPE))) {
1087 off_t pos = (((off_t)file)<<32) + block;
1088 Dmsg1(100, "===== lseek to %d\n", (int)pos);
1089 if (lseek(dev->fd, pos, SEEK_SET) == (off_t)-1) {
1090 dev->dev_errno = errno;
1091 Mmsg2(dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
1092 dev->dev_name, strerror(dev->dev_errno));
1096 dev->block_num = block;
1097 dev->file_addr = pos;
1100 Dmsg4(100, "reposition_dev from %u:%u to %u:%u\n",
1101 dev->file, dev->block_num, file, block);
1102 if (file < dev->file) {
1103 Dmsg0(100, "Rewind_dev\n");
1104 if (!rewind_dev(dev)) {
1108 if (file > dev->file) {
1109 Dmsg1(100, "fsf %d\n", file-dev->file);
1110 if (!fsf_dev(dev, file-dev->file)) {
1114 if (block < dev->block_num) {
1118 if (dev_cap(dev, CAP_POSITIONBLOCKS) && block > dev->block_num) {
1119 /* Ignore errors as Bacula can read to the correct block */
1120 Dmsg1(100, "fsr %d\n", block-dev->block_num);
1121 return fsr_dev(dev, block-dev->block_num);
1129 * Write an end of file on the device
1130 * Returns: 0 on success
1131 * non-zero on failure
1134 weof_dev(DEVICE *dev, int num)
1140 dev->dev_errno = EBADF;
1141 Mmsg0(dev->errmsg, _("Bad call to weof_dev. Archive drive not open\n"));
1142 Emsg0(M_FATAL, 0, dev->errmsg);
1146 if (!(dev_state(dev, ST_TAPE))) {
1149 dev->state &= ~(ST_EOT | ST_EOF); /* remove EOF/EOT flags */
1151 Dmsg0(29, "weof_dev\n");
1152 mt_com.mt_op = MTWEOF;
1153 mt_com.mt_count = num;
1154 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1160 clrerror_dev(dev, MTWEOF);
1162 Mmsg2(dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
1163 dev->dev_name, be.strerror());
1170 * Return string message with last error in English
1171 * Be careful not to call this routine from within dev.c
1172 * while editing an Mmsg() or you will end up in a recursive
1173 * loop creating a Segmentation Violation.
1176 strerror_dev(DEVICE *dev)
1183 * If implemented in system, clear the tape
1187 clrerror_dev(DEVICE *dev, int func)
1189 const char *msg = NULL;
1190 struct mtget mt_stat;
1192 dev->dev_errno = errno; /* save errno */
1194 dev->VolCatInfo.VolCatErrors++;
1197 if (!(dev->state & ST_TAPE)) {
1200 if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
1203 Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
1207 dev->capabilities &= ~CAP_EOF; /* turn off feature */
1212 dev->capabilities &= ~CAP_EOM; /* turn off feature */
1217 dev->capabilities &= ~CAP_FSF; /* turn off feature */
1221 dev->capabilities &= ~CAP_BSF; /* turn off feature */
1225 dev->capabilities &= ~CAP_FSR; /* turn off feature */
1229 dev->capabilities &= ~CAP_BSR; /* turn off feature */
1236 dev->dev_errno = ENOSYS;
1237 Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
1238 Emsg0(M_ERROR, 0, dev->errmsg);
1241 /* On some systems such as NetBSD, this clears all errors */
1242 ioctl(dev->fd, MTIOCGET, (char *)&mt_stat);
1244 /* Found on Linux */
1248 mt_com.mt_op = MTIOCLRERR;
1249 mt_com.mt_count = 1;
1250 /* Clear any error condition on the tape */
1251 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1252 Dmsg0(200, "Did MTIOCLRERR\n");
1256 /* Typically on FreeBSD */
1259 /* Read and clear SCSI error status */
1260 union mterrstat mt_errstat;
1261 Dmsg2(200, "Doing MTIOCERRSTAT errno=%d ERR=%s\n", dev->dev_errno,
1262 strerror(dev->dev_errno));
1263 ioctl(dev->fd, MTIOCERRSTAT, (char *)&mt_errstat);
1267 /* Clear Subsystem Exception OSF1 */
1271 mt_com.mt_op = MTCSE;
1272 mt_com.mt_count = 1;
1273 /* Clear any error condition on the tape */
1274 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1275 Dmsg0(200, "Did MTCSE\n");
1281 * Flush buffer contents
1284 int flush_dev(DEVICE *dev)
1289 static void do_close(DEVICE *dev)
1292 Dmsg1(29, "really close_dev %s\n", dev->dev_name);
1296 /* Clean up device packet so it can be reused */
1298 dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1299 dev->file = dev->block_num = 0;
1301 dev->EndFile = dev->EndBlock = 0;
1302 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1303 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1305 stop_thread_timer(dev->tid);
1315 close_dev(DEVICE *dev)
1318 Mmsg0(&dev->errmsg, _("Bad call to close_dev. Archive not open\n"));
1319 Emsg0(M_FATAL, 0, dev->errmsg);
1322 if (dev->fd >= 0 && dev->use_count == 1) {
1324 } else if (dev->use_count > 0) {
1329 ASSERT(dev->use_count >= 0);
1334 * Used when unmounting the device, ignore use_count
1336 void force_close_dev(DEVICE *dev)
1339 Mmsg0(&dev->errmsg, _("Bad call to force_close_dev. Archive not open\n"));
1340 Emsg0(M_FATAL, 0, dev->errmsg);
1343 Dmsg1(29, "Force close_dev %s\n", dev->dev_name);
1347 ASSERT(dev->use_count >= 0);
1351 bool truncate_dev(DEVICE *dev)
1353 if (dev->state & ST_TAPE) {
1354 return true; /* we don't really truncate tapes */
1355 /* maybe we should rewind and write and eof ???? */
1357 if (ftruncate(dev->fd, 0) != 0) {
1358 Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1365 dev_is_tape(DEVICE *dev)
1367 return (dev->state & ST_TAPE) ? true : false;
1372 * return 1 if the device is read for write, and 0 otherwise
1373 * This is meant for checking at the end of a job to see
1374 * if we still have a tape (perhaps not if at end of tape
1375 * and the job is canceled).
1378 dev_can_write(DEVICE *dev)
1380 if ((dev->state & ST_OPENED) && (dev->state & ST_APPEND) &&
1381 (dev->state & ST_LABEL) && !(dev->state & ST_WEOT)) {
1389 dev_name(DEVICE *dev)
1391 return dev->dev_name;
1395 dev_vol_name(DEVICE *dev)
1397 return dev->VolCatInfo.VolCatName;
1400 uint32_t dev_block(DEVICE *dev)
1402 update_pos_dev(dev);
1403 return dev->block_num;
1406 uint32_t dev_file(DEVICE *dev)
1408 update_pos_dev(dev);
1413 * Free memory allocated for the device
1416 term_dev(DEVICE *dev)
1419 dev->dev_errno = EBADF;
1420 Mmsg0(&dev->errmsg, _("Bad call to term_dev. Archive not open\n"));
1421 Emsg0(M_FATAL, 0, dev->errmsg);
1425 Dmsg0(29, "term_dev\n");
1426 if (dev->dev_name) {
1427 free_memory(dev->dev_name);
1428 dev->dev_name = NULL;
1431 free_pool_memory(dev->errmsg);
1434 pthread_mutex_destroy(&dev->mutex);
1435 pthread_cond_destroy(&dev->wait);
1436 pthread_cond_destroy(&dev->wait_next_vol);
1437 pthread_mutex_destroy(&dev->spool_mutex);
1438 rwl_destroy(&dev->lock);
1439 if (dev->attached_dcrs) {
1440 delete dev->attached_dcrs;
1441 dev->attached_dcrs = NULL;
1443 if (dev->state & ST_MALLOC) {
1444 free_pool_memory((POOLMEM *)dev);
1449 * This routine initializes the device wait timers
1451 void init_dev_wait_timers(DEVICE *dev)
1453 /* ******FIXME******* put these on config variables */
1454 dev->min_wait = 60 * 60;
1455 dev->max_wait = 24 * 60 * 60;
1456 dev->max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
1457 dev->wait_sec = dev->min_wait;
1458 dev->rem_wait_sec = dev->wait_sec;
1461 dev->BadVolName[0] = 0;
1465 * Returns: true if time doubled
1466 * false if max time expired
1468 bool double_dev_wait_time(DEVICE *dev)
1470 dev->wait_sec *= 2; /* double wait time */
1471 if (dev->wait_sec > dev->max_wait) { /* but not longer than maxtime */
1472 dev->wait_sec = dev->max_wait;
1475 dev->rem_wait_sec = dev->wait_sec;
1476 if (dev->num_wait >= dev->max_num_wait) {
1482 void set_os_device_parameters(DEVICE *dev)
1484 #ifdef HAVE_LINUX_OS
1486 if (dev->min_block_size == dev->max_block_size &&
1487 dev->min_block_size == 0) { /* variable block mode */
1488 mt_com.mt_op = MTSETBLK;
1489 mt_com.mt_count = 0;
1490 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1491 clrerror_dev(dev, MTSETBLK);
1493 mt_com.mt_op = MTSETDRVBUFFER;
1494 mt_com.mt_count = MT_ST_CLEARBOOLEANS;
1495 if (!dev_cap(dev, CAP_TWOEOF)) {
1496 mt_com.mt_count |= MT_ST_TWO_FM;
1498 if (dev_cap(dev, CAP_EOM)) {
1499 mt_com.mt_count |= MT_ST_FAST_MTEOM;
1501 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1502 clrerror_dev(dev, MTSETBLK);
1508 #ifdef HAVE_NETBSD_OS
1510 if (dev->min_block_size == dev->max_block_size &&
1511 dev->min_block_size == 0) { /* variable block mode */
1512 mt_com.mt_op = MTSETBSIZ;
1513 mt_com.mt_count = 0;
1514 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1515 clrerror_dev(dev, MTSETBSIZ);
1517 /* Get notified at logical end of tape */
1518 mt_com.mt_op = MTEWARN;
1519 mt_com.mt_count = 1;
1520 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1521 clrerror_dev(dev, MTEWARN);
1527 #if HAVE_FREEBSD_OS || HAVE_OPENBSD_OS
1529 if (dev->min_block_size == dev->max_block_size &&
1530 dev->min_block_size == 0) { /* variable block mode */
1531 mt_com.mt_op = MTSETBSIZ;
1532 mt_com.mt_count = 0;
1533 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1534 clrerror_dev(dev, MTSETBSIZ);
1542 if (dev->min_block_size == dev->max_block_size &&
1543 dev->min_block_size == 0) { /* variable block mode */
1544 mt_com.mt_op = MTSRSZ;
1545 mt_com.mt_count = 0;
1546 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1547 clrerror_dev(dev, MTSRSZ);