3 * dev.c -- low level operations on device (storage device)
7 * NOTE!!!! None of these routines are reentrant. You must
8 * use lock_device() and unlock_device() at a higher level,
9 * or use the xxx_device() equivalents. By moving the
10 * thread synchronization to a higher level, we permit
11 * the higher level routines to "seize" the device and
12 * to carry out operations without worrying about who
13 * set what lock (i.e. race conditions).
15 * Note, this is the device dependent code, and my have
16 * to be modified for each system, but is meant to
17 * be as "generic" as possible.
19 * The purpose of this code is to develop a SIMPLE Storage
20 * daemon. More complicated coding (double buffering, writer
21 * thread, ...) is left for a later version.
23 * Unfortunately, I have had to add more and more complication
24 * to this code. This was not foreseen as noted above, and as
25 * a consequence has lead to something more contorted than is
26 * really necessary -- KES. Note, this contortion has been
27 * corrected to a large extent by a rewrite (Apr MMI).
32 Copyright (C) 2000-2003 Kern Sibbald and John Walker
34 This program is free software; you can redistribute it and/or
35 modify it under the terms of the GNU General Public License as
36 published by the Free Software Foundation; either version 2 of
37 the License, or (at your option) any later version.
39 This program is distributed in the hope that it will be useful,
40 but WITHOUT ANY WARRANTY; without even the implied warranty of
41 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
42 General Public License for more details.
44 You should have received a copy of the GNU General Public
45 License along with this program; if not, write to the Free
46 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
52 * Handling I/O errors and end of tape conditions are a bit tricky.
53 * This is how it is currently done when writting.
54 * On either an I/O error or end of tape,
55 * we will stop writing on the physical device (no I/O recovery is
56 * attempted at least in this daemon). The state flag will be sent
57 * to include ST_EOT, which is ephimeral, and ST_WEOT, which is
58 * persistent. Lots of routines clear ST_EOT, but ST_WEOT is
59 * cleared only when the problem goes away. Now when ST_WEOT
60 * is set all calls to write_dev() are handled as usual. However,
61 * in write_block() instead of attempting to write the block to
62 * the physical device, it is chained into a list of blocks written
63 * after the EOT condition. In addition, all threads are blocked
64 * from writing on the tape by calling lock(), and thread other
65 * than the first thread to hit the EOT will block on a condition
66 * variable. The first thread to hit the EOT will continue to
67 * be able to read and write the tape (he sort of tunnels through
68 * the locking mechanism -- see lock() for details).
70 * Now presumably somewhere higher in the chain of command
71 * (device.c), someone will notice the EOT condition and
72 * get a new tape up, get the tape label read, and mark
73 * the label for rewriting. Then this higher level routine
74 * will write the unwritten buffer to the new volume.
75 * Finally, he will release
76 * any blocked threads by doing a broadcast on the condition
77 * variable. At that point, we should be totally back in
78 * business with no lost data.
85 /* Forward referenced functions */
86 int dev_is_tape(DEVICE *dev);
87 void clrerror_dev(DEVICE *dev, int func);
88 int fsr_dev(DEVICE *dev, int num);
90 extern int debug_level;
93 * Allocate and initialize the DEVICE structure
94 * Note, if dev is non-NULL, it is already allocated,
95 * thus we neither allocate it nor free it. This allows
96 * the caller to put the packet in shared memory.
98 * Note, for a tape, the device->device_name is the device name
99 * (e.g. /dev/nst0), and for a file, the device name
100 * is the directory in which the file will be placed.
104 init_dev(DEVICE *dev, DEVRES *device)
110 /* Check that device is available */
111 if (stat(device->device_name, &statp) < 0) {
113 dev->dev_errno = errno;
115 Emsg2(M_FATAL, 0, "Unable to stat device %s : %s\n", device->device_name,
121 if (S_ISDIR(statp.st_mode)) {
123 } else if (S_ISCHR(statp.st_mode)) {
125 } else if (S_ISFIFO(statp.st_mode)) {
129 dev->dev_errno = ENODEV;
131 Emsg2(M_FATAL, 0, _("%s is an unknown device type. Must be tape or directory. st_mode=%x\n"),
132 dev_name, statp.st_mode);
136 dev = (DEVICE *)get_memory(sizeof(DEVICE));
137 memset(dev, 0, sizeof(DEVICE));
138 dev->state = ST_MALLOC;
140 memset(dev, 0, sizeof(DEVICE));
143 /* Copy user supplied device parameters from Resource */
144 dev->dev_name = get_memory(strlen(device->device_name)+1);
145 strcpy(dev->dev_name, device->device_name);
146 dev->capabilities = device->cap_bits;
147 dev->min_block_size = device->min_block_size;
148 dev->max_block_size = device->max_block_size;
149 dev->max_volume_jobs = device->max_volume_jobs;
150 dev->max_volume_files = device->max_volume_files;
151 dev->max_volume_size = device->max_volume_size;
152 dev->max_file_size = device->max_file_size;
153 dev->volume_capacity = device->volume_capacity;
154 dev->max_rewind_wait = device->max_rewind_wait;
155 dev->max_open_wait = device->max_open_wait;
156 dev->max_open_vols = device->max_open_vols;
157 dev->device = device;
160 dev->state |= ST_TAPE;
162 dev->state |= ST_FIFO;
163 dev->capabilities |= CAP_STREAM; /* set stream device */
165 dev->state |= ST_FILE;
168 if (dev->max_block_size > 1000000) {
169 Emsg3(M_ERROR, 0, _("Block size %u on device %s is too large, using default %u\n"),
170 dev->max_block_size, dev->dev_name, DEFAULT_BLOCK_SIZE);
171 dev->max_block_size = 0;
173 if (dev->max_block_size % TAPE_BSIZE != 0) {
174 Emsg2(M_WARNING, 0, _("Max block size %u not multiple of device %s block size.\n"),
175 dev->max_block_size, dev->dev_name);
178 dev->errmsg = get_pool_memory(PM_EMSG);
181 if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
182 dev->dev_errno = errstat;
183 Mmsg1(&dev->errmsg, _("Unable to init mutex: ERR=%s\n"), strerror(errstat));
184 Emsg0(M_FATAL, 0, dev->errmsg);
186 if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
187 dev->dev_errno = errstat;
188 Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
189 Emsg0(M_FATAL, 0, dev->errmsg);
191 if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
192 dev->dev_errno = errstat;
193 Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
194 Emsg0(M_FATAL, 0, dev->errmsg);
197 Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
201 /* Open the device with the operating system and
202 * initialize buffer pointers.
204 * Note, for a tape, the VolName is the name we give to the
205 * volume (not really used here), but for a file, the
206 * VolName represents the name of the file to be created/opened.
207 * In the case of a file, the full name is the device name
208 * (archive_name) with the VolName concatenated.
211 open_dev(DEVICE *dev, char *VolName, int mode)
213 POOLMEM *archive_name;
215 if (dev->state & ST_OPENED) {
217 * *****FIXME***** how to handle two threads wanting
218 * different volumes mounted???? E.g. one is waiting
219 * for the next volume to be mounted, and a new job
220 * starts and snatches up the device.
222 if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
226 Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
227 dev->dev_name, dev->use_count);
228 Emsg1(M_WARNING, 0, "%s", dev->errmsg);
232 strcpy(dev->VolCatInfo.VolCatName, VolName);
235 Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
236 dev->dev_name, dev->VolCatInfo.VolCatName);
237 dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
238 if (dev->state & (ST_TAPE|ST_FIFO)) {
240 Dmsg0(29, "open_dev: device is tape\n");
241 if (mode == OPEN_READ_WRITE) {
242 dev->mode = O_RDWR | O_BINARY;
243 } else if (mode == OPEN_READ_ONLY) {
244 dev->mode = O_RDONLY | O_BINARY;
245 } else if (mode == OPEN_WRITE_ONLY) {
246 dev->mode = O_WRONLY | O_BINARY;
248 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
250 timeout = dev->max_open_wait;
252 if (dev->state & ST_FIFO && timeout) {
254 dev->tid = start_thread_timer(pthread_self(), timeout);
256 /* If busy retry each second for max_open_wait seconds */
257 while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
258 if (errno == EAGAIN) {
261 if (errno == EBUSY && timeout-- > 0) {
262 Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
266 dev->dev_errno = errno;
267 Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
268 dev->dev_name, strerror(dev->dev_errno));
269 /* Stop any open timer we set */
271 stop_thread_timer(dev->tid);
274 Emsg0(M_FATAL, 0, dev->errmsg);
279 dev->state |= ST_OPENED;
281 update_pos_dev(dev); /* update position */
283 /* Stop any open() timer we started */
285 stop_thread_timer(dev->tid);
288 Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
291 * Handle opening of file
293 archive_name = get_pool_memory(PM_FNAME);
294 pm_strcpy(&archive_name, dev->dev_name);
295 if (archive_name[strlen(archive_name)] != '/') {
296 pm_strcat(&archive_name, "/");
298 pm_strcat(&archive_name, VolName);
299 Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
300 if (mode == OPEN_READ_WRITE) {
301 dev->mode = O_CREAT | O_RDWR | O_BINARY;
302 } else if (mode == OPEN_READ_ONLY) {
303 dev->mode = O_RDONLY | O_BINARY;
304 } else if (mode == OPEN_WRITE_ONLY) {
305 dev->mode = O_WRONLY | O_BINARY;
307 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
309 /* If creating file, give 0640 permissions */
310 if ((dev->fd = open(archive_name, dev->mode, 0640)) < 0) {
311 dev->dev_errno = errno;
312 Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
313 Emsg0(M_FATAL, 0, dev->errmsg);
316 dev->state |= ST_OPENED;
318 update_pos_dev(dev); /* update position */
320 Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
321 free_pool_memory(archive_name);
328 * Returns: 1 on success
331 int rewind_dev(DEVICE *dev)
336 Dmsg0(29, "rewind_dev\n");
338 dev->dev_errno = EBADF;
339 Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
341 Emsg0(M_FATAL, 0, dev->errmsg);
344 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT | ST_EOF | ST_WEOT); /* remove EOF/EOT flags */
345 dev->block_num = dev->file = 0;
347 if (dev->state & ST_TAPE) {
348 mt_com.mt_op = MTREW;
350 /* If we get an I/O error on rewind, it is probably because
351 * the drive is actually busy. We loop for (about 5 minutes)
352 * retrying every 5 seconds.
354 for (i=dev->max_rewind_wait; ; i -= 5) {
355 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
356 if (i == dev->max_rewind_wait) {
357 Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
359 clrerror_dev(dev, MTREW);
360 if (dev->dev_errno == EIO && i > 0) {
361 Dmsg0(200, "Sleeping 5 seconds.\n");
365 Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
366 dev->dev_name, strerror(dev->dev_errno));
371 } else if (dev->state & ST_FILE) {
372 if (lseek(dev->fd, (off_t)0, SEEK_SET) < 0) {
373 dev->dev_errno = errno;
374 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
375 dev->dev_name, strerror(dev->dev_errno));
383 * Position device to end of medium (end of data)
384 * Returns: 1 on succes
391 struct mtget mt_stat;
395 Dmsg0(29, "eod_dev\n");
396 if (dev->state & ST_EOT) {
399 dev->state &= ~(ST_EOF); /* remove EOF flags */
400 dev->block_num = dev->file = 0;
402 if (dev->state & (ST_FIFO | ST_PROG)) {
405 if (!(dev->state & ST_TAPE)) {
406 pos = lseek(dev->fd, (off_t)0, SEEK_END);
407 // Dmsg1(000, "====== Seek to %lld\n", pos);
410 dev->state |= ST_EOT;
415 if (dev->capabilities & CAP_EOM) {
416 mt_com.mt_op = MTEOM;
418 if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
419 Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
420 clrerror_dev(dev, mt_com.mt_op);
422 Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
423 dev->dev_name, strerror(dev->dev_errno));
426 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
427 dev->dev_errno = errno;
428 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
429 dev->dev_name, strerror(dev->dev_errno));
432 Dmsg2(200, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
433 dev->file = mt_stat.mt_fileno;
436 * Rewind then use FSF until EOT reached
439 if (!rewind_dev(dev)) {
442 while (!(dev->state & ST_EOT)) {
443 Dmsg0(200, "Do fsf 1\n");
444 if (!fsf_dev(dev, 1)) {
445 Dmsg0(200, "fsf_dev error.\n");
450 update_pos_dev(dev); /* update position */
451 Dmsg1(200, "EOD dev->file=%d\n", dev->file);
456 * Set the position of the device -- only for files
457 * For other devices, there is no generic way to do it.
458 * Returns: 1 on succes
461 int update_pos_dev(DEVICE *dev)
467 dev->dev_errno = EBADF;
468 Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
469 Emsg0(M_FATAL, 0, dev->errmsg);
473 /* Find out where we are */
474 if (dev->state & ST_FILE) {
477 pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
479 Dmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
480 dev->dev_errno = errno;
481 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
482 dev->dev_name, strerror(dev->dev_errno));
485 dev->file_addr = pos;
494 * Return the status of the device. This was meant
495 * to be a generic routine. Unfortunately, it doesn't
496 * seem possible (at least I do not know how to do it
497 * currently), which means that for the moment, this
498 * routine has very little value.
500 * Returns: 1 on success
504 status_dev(DEVICE *dev, uint32_t *status)
506 struct mtget mt_stat;
509 if (dev->state & (ST_EOT | ST_WEOT)) {
513 if (dev->state & ST_EOF) {
517 if (dev->state & ST_TAPE) {
519 Dmsg0(-20," Driver status:");
520 Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
521 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
522 dev->dev_errno = errno;
523 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
524 dev->dev_name, strerror(dev->dev_errno));
527 Dmsg0(-20, " Device status:");
529 #if defined(HAVE_LINUX_OS)
530 if (GMT_EOF(mt_stat.mt_gstat)) {
534 if (GMT_BOT(mt_stat.mt_gstat)) {
538 if (GMT_EOT(mt_stat.mt_gstat)) {
542 if (GMT_SM(mt_stat.mt_gstat)) {
546 if (GMT_EOD(mt_stat.mt_gstat)) {
550 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
552 Dmsg0(-20, " WR_PROT");
554 if (GMT_ONLINE(mt_stat.mt_gstat)) {
556 Dmsg0(-20, " ONLINE");
558 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
560 Dmsg0(-20, " DR_OPEN");
562 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
563 stat |= MT_IM_REP_EN;
564 Dmsg0(-20, " IM_REP_EN");
566 #endif /* !SunOS && !OSF */
567 Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
569 stat |= MT_ONLINE | MT_BOT;
577 * Load medium in device
578 * Returns: 1 on success
581 int load_dev(DEVICE *dev)
588 dev->dev_errno = EBADF;
589 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
590 Emsg0(M_FATAL, 0, dev->errmsg);
593 if (!(dev->state & ST_TAPE)) {
597 Dmsg0(200, "stored: MTLOAD command not available\n");
598 dev->dev_errno = ENOTTY; /* function not available */
599 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
600 dev->dev_name, strerror(dev->dev_errno)); return 0;
604 dev->block_num = dev->file = 0;
606 mt_com.mt_op = MTLOAD;
608 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
609 dev->dev_errno = errno;
610 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
611 dev->dev_name, strerror(dev->dev_errno)); return 0;
618 * Rewind device and put it offline
619 * Returns: 1 on success
622 int offline_dev(DEVICE *dev)
627 dev->dev_errno = EBADF;
628 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
629 Emsg0(M_FATAL, 0, dev->errmsg);
632 if (!(dev->state & ST_TAPE)) {
636 dev->block_num = dev->file = 0;
639 mt_com.mt_op = MTUNLOCK;
641 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
643 mt_com.mt_op = MTOFFL;
645 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
646 dev->dev_errno = errno;
647 Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
648 dev->dev_name, strerror(dev->dev_errno));
651 Dmsg1(100, "Offlined device %s\n", dev->dev_name);
657 * Foward space a file
658 * Returns: 1 on success
662 fsf_dev(DEVICE *dev, int num)
669 dev->dev_errno = EBADF;
670 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
671 Emsg0(M_FATAL, 0, dev->errmsg);
675 if (!(dev->state & ST_TAPE)) {
678 if (dev->state & ST_EOT) {
680 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
683 if (dev->state & ST_EOF)
684 Dmsg0(200, "ST_EOF set on entry to FSF\n");
685 if (dev->state & ST_EOT)
686 Dmsg0(200, "ST_EOT set on entry to FSF\n");
688 Dmsg0(29, "fsf_dev\n");
690 if (dev->capabilities & CAP_FSF) {
691 Dmsg0(200, "FSF has cap_fsf\n");
692 mt_com.mt_op = MTFSF;
694 while (num-- && !(dev->state & ST_EOT)) {
695 Dmsg0(200, "Doing read for fsf\n");
696 if ((stat = read(dev->fd, rbuf, sizeof(rbuf))) < 0) {
697 if (errno == ENOMEM) { /* tape record exceeds buf len */
698 stat = sizeof(rbuf); /* This is OK */
700 dev->state |= ST_EOT;
701 clrerror_dev(dev, -1);
702 Dmsg1(200, "Set ST_EOT read error %d\n", dev->dev_errno);
703 Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
704 dev->dev_name, strerror(dev->dev_errno));
705 Dmsg1(200, "%s", dev->errmsg);
709 if (stat == 0) { /* EOF */
711 Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
712 /* Two reads of zero means end of tape */
713 if (dev->state & ST_EOF) {
714 dev->state |= ST_EOT;
715 Dmsg0(200, "Set ST_EOT\n");
718 dev->state |= ST_EOF;
723 } else { /* Got data */
724 dev->state &= ~(ST_EOF|ST_EOT);
727 Dmsg0(200, "Doing MT_FSF\n");
728 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
729 if (stat < 0) { /* error => EOT */
730 dev->state |= ST_EOT;
731 Dmsg0(200, "Set ST_EOT\n");
732 clrerror_dev(dev, MTFSF);
733 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
734 dev->dev_name, strerror(dev->dev_errno));
735 Dmsg0(200, "Got < 0 for MT_FSF\n");
736 Dmsg1(200, "%s", dev->errmsg);
738 dev->state |= ST_EOF; /* just read EOF */
745 * No FSF, so use FSR to simulate it
748 Dmsg0(200, "Doing FSR for FSF\n");
749 while (num-- && !(dev->state & ST_EOT)) {
750 fsr_dev(dev, INT32_MAX); /* returns -1 on EOF or EOT */
752 if (dev->state & ST_EOT) {
754 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
761 Dmsg1(200, "Return %d from FSF\n", stat);
762 if (dev->state & ST_EOF)
763 Dmsg0(200, "ST_EOF set on exit FSF\n");
764 if (dev->state & ST_EOT)
765 Dmsg0(200, "ST_EOT set on exit FSF\n");
766 Dmsg1(200, "Return from FSF file=%d\n", dev->file);
767 return stat == 0 ? 1 : 0;
771 * Backward space a file
774 bsf_dev(DEVICE *dev, int num)
780 dev->dev_errno = EBADF;
781 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
782 Emsg0(M_FATAL, 0, dev->errmsg);
786 if (!(dev->state & ST_TAPE)) {
789 Dmsg0(29, "bsf_dev\n");
790 dev->state &= ~(ST_EOT|ST_EOF);
793 mt_com.mt_op = MTBSF;
794 mt_com.mt_count = num;
795 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
797 clrerror_dev(dev, MTBSF);
798 Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
799 dev->dev_name, strerror(dev->dev_errno));
807 * Foward space a record
810 fsr_dev(DEVICE *dev, int num)
816 dev->dev_errno = EBADF;
817 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
818 Emsg0(M_FATAL, 0, dev->errmsg);
822 if (!(dev->state & ST_TAPE)) {
825 Dmsg0(29, "fsr_dev\n");
826 dev->block_num += num;
827 mt_com.mt_op = MTFSR;
828 mt_com.mt_count = num;
829 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
831 dev->state &= ~ST_EOF;
833 if (dev->state & ST_EOF) {
834 dev->state |= ST_EOT;
836 dev->state |= ST_EOF; /* assume EOF */
840 clrerror_dev(dev, MTFSR);
841 Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
842 dev->dev_name, strerror(dev->dev_errno));
849 * Backward space a record
850 * Returns: 0 on success
854 bsr_dev(DEVICE *dev, int num)
860 dev->dev_errno = EBADF;
861 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
862 Emsg0(M_FATAL, 0, dev->errmsg);
866 if (!(dev->state & ST_TAPE)) {
869 Dmsg0(29, "bsr_dev\n");
870 dev->block_num -= num;
871 dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
872 mt_com.mt_op = MTBSR;
873 mt_com.mt_count = num;
874 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
876 clrerror_dev(dev, MTBSR);
877 Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
878 dev->dev_name, strerror(dev->dev_errno));
887 * Write an end of file on the device
888 * Returns: 0 on success
889 * non-zero on failure
892 weof_dev(DEVICE *dev, int num)
898 dev->dev_errno = EBADF;
899 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
900 Emsg0(M_FATAL, 0, dev->errmsg);
904 if (!(dev->state & ST_TAPE)) {
907 dev->state &= ~(ST_EOT | ST_EOF); /* remove EOF/EOT flags */
909 Dmsg0(29, "weof_dev\n");
910 mt_com.mt_op = MTWEOF;
911 mt_com.mt_count = num;
912 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
917 clrerror_dev(dev, MTWEOF);
918 Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
919 dev->dev_name, strerror(dev->dev_errno));
925 * Return string message with last error in English
926 * Be careful not to call this routine from within dev.c
927 * while editing an Mmsg(&) or you will end up in a recursive
928 * loop creating a Segmentation Violation.
931 strerror_dev(DEVICE *dev)
938 * If implemented in system, clear the tape
942 clrerror_dev(DEVICE *dev, int func)
946 dev->dev_errno = errno; /* save errno */
948 dev->VolCatInfo.VolCatErrors++;
951 if (!(dev->state & ST_TAPE)) {
954 if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
957 Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
961 dev->capabilities &= ~CAP_EOF; /* turn off feature */
965 dev->capabilities &= ~CAP_EOM; /* turn off feature */
969 dev->capabilities &= ~CAP_FSF; /* turn off feature */
973 dev->capabilities &= ~CAP_BSF; /* turn off feature */
977 dev->capabilities &= ~CAP_FSR; /* turn off feature */
981 dev->capabilities &= ~CAP_BSR; /* turn off feature */
988 dev->dev_errno = ENOSYS;
989 Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
990 Emsg0(M_ERROR, 0, dev->errmsg);
997 mt_com.mt_op = MTIOCLRERR;
999 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1000 Dmsg0(200, "Did MTIOCLRERR\n");
1006 * Flush buffer contents
1009 int flush_dev(DEVICE *dev)
1014 static void do_close(DEVICE *dev)
1017 Dmsg0(29, "really close_dev\n");
1019 /* Clean up device packet so it can be reused */
1021 dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1022 dev->file = dev->block_num = 0;
1024 dev->EndFile = dev->EndBlock = 0;
1025 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1026 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1029 stop_thread_timer(dev->tid);
1038 close_dev(DEVICE *dev)
1041 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1042 Emsg0(M_FATAL, 0, dev->errmsg);
1045 if (dev->fd >= 0 && dev->use_count == 1) {
1048 Dmsg0(29, "close_dev but in use so leave open.\n");
1054 * Used when unmounting the device
1056 void force_close_dev(DEVICE *dev)
1059 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1060 Emsg0(M_FATAL, 0, dev->errmsg);
1063 Dmsg0(29, "really close_dev\n");
1067 int truncate_dev(DEVICE *dev)
1069 if (dev->state & ST_TAPE) {
1072 if (ftruncate(dev->fd, 0) != 0) {
1073 Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1080 dev_is_tape(DEVICE *dev)
1082 return (dev->state & ST_TAPE) ? 1 : 0;
1086 dev_name(DEVICE *dev)
1088 return dev->dev_name;
1092 dev_vol_name(DEVICE *dev)
1094 return dev->VolCatInfo.VolCatName;
1097 uint32_t dev_block(DEVICE *dev)
1099 update_pos_dev(dev);
1100 return dev->block_num;
1103 uint32_t dev_file(DEVICE *dev)
1105 update_pos_dev(dev);
1110 * Free memory allocated for the device
1113 term_dev(DEVICE *dev)
1116 dev->dev_errno = EBADF;
1117 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1118 Emsg0(M_FATAL, 0, dev->errmsg);
1122 Dmsg0(29, "term_dev\n");
1123 if (dev->dev_name) {
1124 free_memory(dev->dev_name);
1125 dev->dev_name = NULL;
1128 free_pool_memory(dev->errmsg);
1131 pthread_mutex_destroy(&dev->mutex);
1132 pthread_cond_destroy(&dev->wait);
1133 pthread_cond_destroy(&dev->wait_next_vol);
1134 if (dev->state & ST_MALLOC) {
1135 free_pool_memory((POOLMEM *)dev);
1140 /* To make following two functions more readable */
1142 #define attached_jcrs ((JCR *)(dev->attached_jcrs))
1144 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1146 jcr->prev_dev = NULL;
1147 jcr->next_dev = attached_jcrs;
1148 if (attached_jcrs) {
1149 attached_jcrs->prev_dev = jcr;
1151 attached_jcrs = jcr;
1152 Dmsg1(100, "Attached Job %s\n", jcr->Job);
1155 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1157 if (!jcr->prev_dev) {
1158 attached_jcrs = jcr->next_dev;
1160 jcr->prev_dev->next_dev = jcr->next_dev;
1162 if (jcr->next_dev) {
1163 jcr->next_dev->prev_dev = jcr->prev_dev;
1165 jcr->next_dev = jcr->prev_dev = NULL;
1166 Dmsg1(100, "Detached Job %s\n", jcr->Job);
1169 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1172 return attached_jcrs;
1174 return jcr->next_dev;