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, 2001, 2002 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,
120 if (S_ISDIR(statp.st_mode)) {
122 } else if (S_ISCHR(statp.st_mode)) {
126 dev->dev_errno = ENODEV;
128 Emsg2(M_FATAL, 0, _("%s is an unknown device type. Must be tape or directory. st_mode=%x\n"),
129 dev_name, statp.st_mode);
133 dev = (DEVICE *)get_memory(sizeof(DEVICE));
134 memset(dev, 0, sizeof(DEVICE));
135 dev->state = ST_MALLOC;
137 memset(dev, 0, sizeof(DEVICE));
140 dev->state |= ST_TAPE;
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->device = device;
158 if (dev->max_block_size > 1000000) {
159 Emsg3(M_ERROR, 0, _("Block size %u on device %s is too large, using default %u\n"),
160 dev->max_block_size, dev->dev_name, DEFAULT_BLOCK_SIZE);
161 dev->max_block_size = 0;
163 if (dev->max_block_size % TAPE_BSIZE != 0) {
164 Emsg2(M_WARNING, 0, _("Max block size %u not multiple of device %s block size.\n"),
165 dev->max_block_size, dev->dev_name);
168 dev->errmsg = get_pool_memory(PM_EMSG);
171 if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
172 dev->dev_errno = errstat;
173 Mmsg1(&dev->errmsg, _("Unable to init mutex: ERR=%s\n"), strerror(errstat));
174 Emsg0(M_FATAL, 0, dev->errmsg);
176 if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
177 dev->dev_errno = errstat;
178 Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
179 Emsg0(M_FATAL, 0, dev->errmsg);
181 if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
182 dev->dev_errno = errstat;
183 Mmsg1(&dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), strerror(errstat));
184 Emsg0(M_FATAL, 0, dev->errmsg);
187 Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
191 /* Open the device with the operating system and
192 * initialize buffer pointers.
194 * Note, for a tape, the VolName is the name we give to the
195 * volume (not really used here), but for a file, the
196 * VolName represents the name of the file to be created/opened.
197 * In the case of a file, the full name is the device name
198 * (archive_name) with the VolName concatenated.
201 open_dev(DEVICE *dev, char *VolName, int mode)
203 POOLMEM *archive_name;
205 if (dev->state & ST_OPENED) {
207 * *****FIXME***** how to handle two threads wanting
208 * different volumes mounted???? E.g. one is waiting
209 * for the next volume to be mounted, and a new job
210 * starts and snatches up the device.
212 if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
216 Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
217 dev->dev_name, dev->use_count);
218 Emsg0(M_WARNING, 0, dev->errmsg);
222 strcpy(dev->VolCatInfo.VolCatName, VolName);
225 Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
226 dev->dev_name, dev->VolCatInfo.VolCatName);
227 dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
228 if (dev->state & ST_TAPE) {
230 Dmsg0(29, "open_dev: device is tape\n");
231 if (mode == READ_WRITE) {
232 dev->mode = O_RDWR | O_BINARY;
234 dev->mode = O_RDONLY | O_BINARY;
236 timeout = dev->max_open_wait;
238 while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
239 if (errno == EBUSY && timeout-- > 0) {
240 Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, strerror(errno));
244 dev->dev_errno = errno;
245 Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
246 dev->dev_name, strerror(dev->dev_errno));
247 Emsg0(M_FATAL, 0, dev->errmsg);
252 dev->state |= ST_OPENED;
254 update_pos_dev(dev); /* update position */
256 Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
259 * Handle opening of file
261 archive_name = get_pool_memory(PM_FNAME);
262 pm_strcpy(&archive_name, dev->dev_name);
263 if (archive_name[strlen(archive_name)] != '/') {
264 pm_strcat(&archive_name, "/");
266 pm_strcat(&archive_name, VolName);
267 Dmsg1(29, "open_dev: device is disk %s\n", archive_name);
268 if (mode == READ_WRITE) {
269 dev->mode = O_CREAT | O_RDWR | O_BINARY;
271 dev->mode = O_RDONLY | O_BINARY;
273 if ((dev->fd = open(archive_name, dev->mode, MODE_RW)) < 0) {
274 dev->dev_errno = errno;
275 Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name, strerror(dev->dev_errno));
276 Emsg0(M_FATAL, 0, dev->errmsg);
279 dev->state |= ST_OPENED;
281 update_pos_dev(dev); /* update position */
283 Dmsg1(29, "open_dev: disk fd=%d opened\n", dev->fd);
284 free_pool_memory(archive_name);
291 * Returns: 1 on success
294 int rewind_dev(DEVICE *dev)
299 Dmsg0(29, "rewind_dev\n");
301 dev->dev_errno = EBADF;
302 Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
304 Emsg0(M_FATAL, 0, dev->errmsg);
307 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT | ST_EOF | ST_WEOT); /* remove EOF/EOT flags */
308 dev->block_num = dev->file = 0;
310 if (dev->state & ST_TAPE) {
311 mt_com.mt_op = MTREW;
313 /* If we get an I/O error on rewind, it is probably because
314 * the drive is actually busy. We loop for (about 5 minutes)
315 * retrying every 5 seconds.
317 for (i=dev->max_rewind_wait; ; i -= 5) {
318 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
319 if (i == dev->max_rewind_wait) {
320 Dmsg1(200, "Rewind error, %s. retrying ...\n", strerror(errno));
322 clrerror_dev(dev, MTREW);
323 if (dev->dev_errno == EIO && i > 0) {
324 Dmsg0(200, "Sleeping 5 seconds.\n");
328 Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
329 dev->dev_name, strerror(dev->dev_errno));
335 if (lseek(dev->fd, (off_t)0, SEEK_SET) < 0) {
336 dev->dev_errno = errno;
337 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
338 dev->dev_name, strerror(dev->dev_errno));
346 * Position device to end of medium (end of data)
347 * Returns: 1 on succes
354 struct mtget mt_stat;
358 Dmsg0(29, "eod_dev\n");
359 if (dev->state & ST_EOT) {
362 dev->state &= ~(ST_EOF); /* remove EOF flags */
363 dev->block_num = dev->file = 0;
365 if (!(dev->state & ST_TAPE)) {
366 pos = lseek(dev->fd, (off_t)0, SEEK_END);
367 // Dmsg1(000, "====== Seek to %lld\n", pos);
370 dev->state |= ST_EOT;
375 if (dev->capabilities & CAP_EOM) {
376 mt_com.mt_op = MTEOM;
378 if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
379 Dmsg1(50, "ioctl error: %s\n", strerror(dev->dev_errno));
380 clrerror_dev(dev, mt_com.mt_op);
382 Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
383 dev->dev_name, strerror(dev->dev_errno));
386 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
387 dev->dev_errno = errno;
388 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
389 dev->dev_name, strerror(dev->dev_errno));
392 Dmsg2(200, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
393 dev->file = mt_stat.mt_fileno;
396 * Rewind then use FSF until EOT reached
399 if (!rewind_dev(dev)) {
402 while (!(dev->state & ST_EOT)) {
403 Dmsg0(200, "Do fsf 1\n");
404 if (!fsf_dev(dev, 1)) {
405 Dmsg0(200, "fsf_dev error.\n");
410 update_pos_dev(dev); /* update position */
411 Dmsg1(200, "EOD dev->file=%d\n", dev->file);
416 * Set the position of the device.
417 * Returns: 1 on succes
420 int update_pos_dev(DEVICE *dev)
423 struct mtget mt_stat;
429 dev->dev_errno = EBADF;
430 Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
431 Emsg0(M_FATAL, 0, dev->errmsg);
435 /* Find out where we are */
436 if (!(dev->state & ST_TAPE)) {
439 pos = lseek(dev->fd, (off_t)0, SEEK_CUR);
441 Dmsg1(000, "Seek error: ERR=%s\n", strerror(dev->dev_errno));
442 dev->dev_errno = errno;
443 Mmsg2(&dev->errmsg, _("lseek error on %s. ERR=%s.\n"),
444 dev->dev_name, strerror(dev->dev_errno));
447 dev->file_addr = pos;
452 #ifdef REALLY_IMPLEMENTED
453 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
454 Dmsg1(50, "MTIOCGET error: %s\n", strerror(dev->dev_errno));
455 dev->dev_errno = errno;
456 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
457 dev->dev_name, strerror(dev->dev_errno));
468 * Return the status of the device. This was meant
469 * to be a generic routine. Unfortunately, it doesn't
470 * seem possible (at least I do not know how to do it
471 * currently), which means that for the moment, this
472 * routine has very little value.
474 * Returns: 1 on success
478 status_dev(DEVICE *dev, uint32_t *status)
480 struct mtget mt_stat;
483 if (dev->state & (ST_EOT | ST_WEOT)) {
487 if (dev->state & ST_EOF) {
491 if (dev->state & ST_TAPE) {
493 Dmsg0(-20," Driver status:");
494 Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
495 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
496 dev->dev_errno = errno;
497 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
498 dev->dev_name, strerror(dev->dev_errno));
501 Dmsg0(-20, " Device status:");
503 #if defined(HAVE_LINUX_OS)
504 if (GMT_EOF(mt_stat.mt_gstat)) {
508 if (GMT_BOT(mt_stat.mt_gstat)) {
512 if (GMT_EOT(mt_stat.mt_gstat)) {
516 if (GMT_SM(mt_stat.mt_gstat)) {
520 if (GMT_EOD(mt_stat.mt_gstat)) {
524 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
526 Dmsg0(-20, " WR_PROT");
528 if (GMT_ONLINE(mt_stat.mt_gstat)) {
530 Dmsg0(-20, " ONLINE");
532 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
534 Dmsg0(-20, " DR_OPEN");
536 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
537 stat |= MT_IM_REP_EN;
538 Dmsg0(-20, " IM_REP_EN");
540 #endif /* !SunOS && !OSF */
541 Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
543 stat |= MT_ONLINE | MT_BOT;
551 * Load medium in device
552 * Returns: 1 on success
555 int load_dev(DEVICE *dev)
562 dev->dev_errno = EBADF;
563 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
564 Emsg0(M_FATAL, 0, dev->errmsg);
567 if (!(dev->state & ST_TAPE)) {
571 Dmsg0(200, "stored: MTLOAD command not available\n");
572 dev->dev_errno = ENOTTY; /* function not available */
573 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
574 dev->dev_name, strerror(dev->dev_errno)); return 0;
578 dev->block_num = dev->file = 0;
580 mt_com.mt_op = MTLOAD;
582 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
583 dev->dev_errno = errno;
584 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
585 dev->dev_name, strerror(dev->dev_errno)); return 0;
592 * Rewind device and put it offline
593 * Returns: 1 on success
596 int offline_dev(DEVICE *dev)
601 dev->dev_errno = EBADF;
602 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
603 Emsg0(M_FATAL, 0, dev->errmsg);
606 if (!(dev->state & ST_TAPE)) {
610 dev->block_num = dev->file = 0;
613 mt_com.mt_op = MTUNLOCK;
615 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
617 mt_com.mt_op = MTOFFL;
619 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
620 dev->dev_errno = errno;
621 Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
622 dev->dev_name, strerror(dev->dev_errno));
625 Dmsg1(100, "Offlined device %s\n", dev->dev_name);
631 * Foward space a file
632 * Returns: 1 on success
636 fsf_dev(DEVICE *dev, int num)
643 dev->dev_errno = EBADF;
644 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
645 Emsg0(M_FATAL, 0, dev->errmsg);
649 if (!(dev->state & ST_TAPE)) {
652 if (dev->state & ST_EOT) {
654 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
657 if (dev->state & ST_EOF)
658 Dmsg0(200, "ST_EOF set on entry to FSF\n");
659 if (dev->state & ST_EOT)
660 Dmsg0(200, "ST_EOT set on entry to FSF\n");
662 Dmsg0(29, "fsf_dev\n");
664 if (dev->capabilities & CAP_FSF) {
665 Dmsg0(200, "FSF has cap_fsf\n");
666 mt_com.mt_op = MTFSF;
668 while (num-- && !(dev->state & ST_EOT)) {
669 Dmsg0(200, "Doing read for fsf\n");
670 if ((stat = read(dev->fd, rbuf, sizeof(rbuf))) < 0) {
671 if (errno == ENOMEM) { /* tape record exceeds buf len */
672 stat = sizeof(rbuf); /* This is OK */
674 dev->state |= ST_EOT;
675 clrerror_dev(dev, -1);
676 Dmsg1(200, "Set ST_EOT read error %d\n", dev->dev_errno);
677 Mmsg2(&dev->errmsg, _("read error on %s. ERR=%s.\n"),
678 dev->dev_name, strerror(dev->dev_errno));
679 Dmsg1(200, "%s", dev->errmsg);
683 if (stat == 0) { /* EOF */
685 Dmsg1(200, "End of File mark from read. File=%d\n", dev->file+1);
686 /* Two reads of zero means end of tape */
687 if (dev->state & ST_EOF) {
688 dev->state |= ST_EOT;
689 Dmsg0(200, "Set ST_EOT\n");
692 dev->state |= ST_EOF;
697 } else { /* Got data */
698 dev->state &= ~(ST_EOF|ST_EOT);
701 Dmsg0(200, "Doing MT_FSF\n");
702 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
703 if (stat < 0) { /* error => EOT */
704 dev->state |= ST_EOT;
705 Dmsg0(200, "Set ST_EOT\n");
706 clrerror_dev(dev, MTFSF);
707 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
708 dev->dev_name, strerror(dev->dev_errno));
709 Dmsg0(200, "Got < 0 for MT_FSF\n");
710 Dmsg1(200, "%s", dev->errmsg);
712 dev->state |= ST_EOF; /* just read EOF */
719 * No FSF, so use FSR to simulate it
722 Dmsg0(200, "Doing FSR for FSF\n");
723 while (num-- && !(dev->state & ST_EOT)) {
724 fsr_dev(dev, INT32_MAX); /* returns -1 on EOF or EOT */
726 if (dev->state & ST_EOT) {
728 Mmsg1(&dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
735 Dmsg1(200, "Return %d from FSF\n", stat);
736 if (dev->state & ST_EOF)
737 Dmsg0(200, "ST_EOF set on exit FSF\n");
738 if (dev->state & ST_EOT)
739 Dmsg0(200, "ST_EOT set on exit FSF\n");
740 Dmsg1(200, "Return from FSF file=%d\n", dev->file);
741 return stat == 0 ? 1 : 0;
745 * Backward space a file
748 bsf_dev(DEVICE *dev, int num)
754 dev->dev_errno = EBADF;
755 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
756 Emsg0(M_FATAL, 0, dev->errmsg);
760 if (!(dev->state & ST_TAPE)) {
763 Dmsg0(29, "bsf_dev\n");
764 dev->state &= ~(ST_EOT|ST_EOF);
767 mt_com.mt_op = MTBSF;
768 mt_com.mt_count = num;
769 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
771 clrerror_dev(dev, MTBSF);
772 Mmsg2(&dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
773 dev->dev_name, strerror(dev->dev_errno));
781 * Foward space a record
784 fsr_dev(DEVICE *dev, int num)
790 dev->dev_errno = EBADF;
791 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
792 Emsg0(M_FATAL, 0, dev->errmsg);
796 if (!(dev->state & ST_TAPE)) {
799 Dmsg0(29, "fsr_dev\n");
800 dev->block_num += num;
801 mt_com.mt_op = MTFSR;
802 mt_com.mt_count = num;
803 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
805 dev->state &= ~ST_EOF;
807 if (dev->state & ST_EOF) {
808 dev->state |= ST_EOT;
810 dev->state |= ST_EOF; /* assume EOF */
814 clrerror_dev(dev, MTFSR);
815 Mmsg2(&dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
816 dev->dev_name, strerror(dev->dev_errno));
823 * Backward space a record
824 * Returns: 0 on success
828 bsr_dev(DEVICE *dev, int num)
834 dev->dev_errno = EBADF;
835 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
836 Emsg0(M_FATAL, 0, dev->errmsg);
840 if (!(dev->state & ST_TAPE)) {
843 Dmsg0(29, "bsr_dev\n");
844 dev->block_num -= num;
845 dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
846 mt_com.mt_op = MTBSR;
847 mt_com.mt_count = num;
848 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
850 clrerror_dev(dev, MTBSR);
851 Mmsg2(&dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
852 dev->dev_name, strerror(dev->dev_errno));
861 * Write an end of file on the device
864 weof_dev(DEVICE *dev, int num)
870 dev->dev_errno = EBADF;
871 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
872 Emsg0(M_FATAL, 0, dev->errmsg);
876 if (!(dev->state & ST_TAPE)) {
879 dev->state &= ~(ST_EOT | ST_EOF); /* remove EOF/EOT flags */
881 Dmsg0(29, "weof_dev\n");
882 mt_com.mt_op = MTWEOF;
883 mt_com.mt_count = num;
884 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
889 clrerror_dev(dev, MTWEOF);
890 Mmsg2(&dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
891 dev->dev_name, strerror(dev->dev_errno));
897 * Return string message with last error in English
898 * Be careful not to call this routine from within dev.c
899 * while editing an Mmsg(&) or you will end up in a recursive
900 * loop creating a Segmentation Violation.
903 strerror_dev(DEVICE *dev)
910 * If implemented in system, clear the tape
914 clrerror_dev(DEVICE *dev, int func)
918 dev->dev_errno = errno; /* save errno */
920 dev->VolCatInfo.VolCatErrors++;
923 if (!(dev->state & ST_TAPE)) {
926 if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
929 Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
933 dev->capabilities &= ~CAP_EOF; /* turn off feature */
937 dev->capabilities &= ~CAP_EOM; /* turn off feature */
941 dev->capabilities &= ~CAP_FSF; /* turn off feature */
945 dev->capabilities &= ~CAP_BSF; /* turn off feature */
949 dev->capabilities &= ~CAP_FSR; /* turn off feature */
953 dev->capabilities &= ~CAP_BSR; /* turn off feature */
960 dev->dev_errno = ENOSYS;
961 Mmsg1(&dev->errmsg, _("This device does not support %s.\n"), msg);
962 Emsg0(M_ERROR, 0, dev->errmsg);
969 mt_com.mt_op = MTIOCLRERR;
971 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
972 Dmsg0(200, "Did MTIOCLRERR\n");
978 * Flush buffer contents
981 int flush_dev(DEVICE *dev)
986 static void do_close(DEVICE *dev)
989 Dmsg0(29, "really close_dev\n");
991 /* Clean up device packet so it can be reused */
993 dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
994 dev->file = dev->block_num = 0;
996 dev->EndFile = dev->EndBlock = 0;
997 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
998 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1006 close_dev(DEVICE *dev)
1009 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1010 Emsg0(M_FATAL, 0, dev->errmsg);
1013 if (dev->fd >= 0 && dev->use_count == 1) {
1016 Dmsg0(29, "close_dev but in use so leave open.\n");
1022 * Used when unmounting the device
1024 void force_close_dev(DEVICE *dev)
1027 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1028 Emsg0(M_FATAL, 0, dev->errmsg);
1031 Dmsg0(29, "really close_dev\n");
1035 int truncate_dev(DEVICE *dev)
1037 if (dev->state & ST_TAPE) {
1040 if (ftruncate(dev->fd, 0) != 0) {
1041 Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), strerror(errno));
1048 dev_is_tape(DEVICE *dev)
1050 return (dev->state & ST_TAPE) ? 1 : 0;
1054 dev_name(DEVICE *dev)
1056 return dev->dev_name;
1060 dev_vol_name(DEVICE *dev)
1062 return dev->VolCatInfo.VolCatName;
1065 uint32_t dev_block(DEVICE *dev)
1067 update_pos_dev(dev);
1068 return dev->block_num;
1071 uint32_t dev_file(DEVICE *dev)
1073 update_pos_dev(dev);
1078 * Free memory allocated for the device
1081 term_dev(DEVICE *dev)
1084 dev->dev_errno = EBADF;
1085 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1086 Emsg0(M_FATAL, 0, dev->errmsg);
1090 Dmsg0(29, "term_dev\n");
1091 if (dev->dev_name) {
1092 free_memory(dev->dev_name);
1093 dev->dev_name = NULL;
1096 free_pool_memory(dev->errmsg);
1100 rwl_destroy(&dev->lock);
1102 pthread_mutex_destroy(&dev->mutex);
1103 pthread_cond_destroy(&dev->wait);
1104 pthread_cond_destroy(&dev->wait_next_vol);
1105 if (dev->state & ST_MALLOC) {
1106 free_pool_memory((POOLMEM *)dev);
1111 /* To make following two functions more readable */
1113 #define attached_jcrs ((JCR *)(dev->attached_jcrs))
1115 void attach_jcr_to_device(DEVICE *dev, JCR *jcr)
1117 jcr->prev_dev = NULL;
1118 jcr->next_dev = attached_jcrs;
1119 if (attached_jcrs) {
1120 attached_jcrs->prev_dev = jcr;
1122 attached_jcrs = jcr;
1123 Dmsg1(100, "Attached Job %s\n", jcr->Job);
1126 void detach_jcr_from_device(DEVICE *dev, JCR *jcr)
1128 if (!jcr->prev_dev) {
1129 attached_jcrs = jcr->next_dev;
1131 jcr->prev_dev->next_dev = jcr->next_dev;
1133 if (jcr->next_dev) {
1134 jcr->next_dev->prev_dev = jcr->prev_dev;
1136 jcr->next_dev = jcr->prev_dev = NULL;
1137 Dmsg1(100, "Detached Job %s\n", jcr->Job);
1140 JCR *next_attached_jcr(DEVICE *dev, JCR *jcr)
1143 return attached_jcrs;
1145 return jcr->next_dev;