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-2005 Kern Sibbald
34 This program is free software; you can redistribute it and/or
35 modify it under the terms of the GNU General Public License
36 version 2 as amended with additional clauses defined in the
37 file LICENSE in the main source directory.
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
42 the file LICENSE for additional details.
47 * Handling I/O errors and end of tape conditions are a bit tricky.
48 * This is how it is currently done when writting.
49 * On either an I/O error or end of tape,
50 * we will stop writing on the physical device (no I/O recovery is
51 * attempted at least in this daemon). The state flag will be sent
52 * to include ST_EOT, which is ephimeral, and ST_WEOT, which is
53 * persistent. Lots of routines clear ST_EOT, but ST_WEOT is
54 * cleared only when the problem goes away. Now when ST_WEOT
55 * is set all calls to write_block_to_device() call the fix_up
56 * routine. In addition, all threads are blocked
57 * from writing on the tape by calling lock_dev(), and thread other
58 * than the first thread to hit the EOT will block on a condition
59 * variable. The first thread to hit the EOT will continue to
60 * be able to read and write the tape (he sort of tunnels through
61 * the locking mechanism -- see lock_dev() for details).
63 * Now presumably somewhere higher in the chain of command
64 * (device.c), someone will notice the EOT condition and
65 * get a new tape up, get the tape label read, and mark
66 * the label for rewriting. Then this higher level routine
67 * will write the unwritten buffer to the new volume.
68 * Finally, he will release
69 * any blocked threads by doing a broadcast on the condition
70 * variable. At that point, we should be totally back in
71 * business with no lost data.
82 /* Forward referenced functions */
83 void set_os_device_parameters(DEVICE *dev);
84 static bool dev_get_os_pos(DEVICE *dev, struct mtget *mt_stat);
85 static char *mode_to_str(int mode);
88 * Allocate and initialize the DEVICE structure
89 * Note, if dev is non-NULL, it is already allocated,
90 * thus we neither allocate it nor free it. This allows
91 * the caller to put the packet in shared memory.
93 * Note, for a tape, the device->device_name is the device name
94 * (e.g. /dev/nst0), and for a file, the device name
95 * is the directory in which the file will be placed.
99 init_dev(JCR *jcr, DEVRES *device)
107 /* Check that device is available */
108 if (stat(device->device_name, &statp) < 0) {
110 Jmsg2(jcr, M_ERROR, 0, _("Unable to stat device %s: ERR=%s\n"),
111 device->device_name, be.strerror());
118 if (S_ISDIR(statp.st_mode)) {
120 } else if (S_ISCHR(statp.st_mode)) {
122 } else if (S_ISFIFO(statp.st_mode)) {
124 } else if (!(device->cap_bits & CAP_REQMOUNT)) {
125 Jmsg2(jcr, M_ERROR, 0, _("%s is an unknown device type. Must be tape or directory\n"
126 " or have RequiresMount=yes for DVD. 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 /* Copy user supplied device parameters from Resource */
136 dev->dev_name = get_memory(strlen(device->device_name)+1);
137 pm_strcpy(dev->dev_name, device->device_name);
138 dev->prt_name = get_memory(strlen(device->device_name) + strlen(device->hdr.name) + 20);
139 /* We edit "Resource-name" (physical-name) */
140 Mmsg(dev->prt_name, "\"%s\" (%s)", device->hdr.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;
153 dev->autoselect = device->autoselect;
154 if (tape) { /* No parts on tapes */
155 dev->max_part_size = 0;
158 dev->max_part_size = device->max_part_size;
161 if (dev->vol_poll_interval && dev->vol_poll_interval < 60) {
162 dev->vol_poll_interval = 60;
164 dev->device = device;
167 dev->state |= ST_TAPE;
169 dev->state |= ST_FIFO;
170 dev->capabilities |= CAP_STREAM; /* set stream device */
172 dev->state |= ST_FILE;
175 /* If the device requires mount :
176 * - Check that the mount point is available
177 * - Check that (un)mount commands are defined
179 if (dev->is_file() && dev->requires_mount()) {
180 if (stat(device->mount_point, &statp) < 0) {
182 dev->dev_errno = errno;
183 Jmsg2(jcr, M_ERROR, 0, _("Unable to stat mount point %s: ERR=%s\n"),
184 device->mount_point, be.strerror());
187 if (!device->mount_command || !device->unmount_command) {
188 Jmsg0(jcr, M_ERROR_TERM, 0, _("Mount and unmount commands must defined for a device which requires mount.\n"));
190 if (!device->write_part_command) {
191 Jmsg0(jcr, M_ERROR_TERM, 0, _("Write part command must be defined for a device which requires mount.\n"));
193 dev->state |= ST_DVD;
196 if (dev->max_block_size > 1000000) {
197 Jmsg3(jcr, M_ERROR, 0, _("Block size %u on device %s is too large, using default %u\n"),
198 dev->max_block_size, dev->print_name(), DEFAULT_BLOCK_SIZE);
199 dev->max_block_size = 0;
201 if (dev->max_block_size % TAPE_BSIZE != 0) {
202 Jmsg2(jcr, M_WARNING, 0, _("Max block size %u not multiple of device %s block size.\n"),
203 dev->max_block_size, dev->print_name());
206 dev->errmsg = get_pool_memory(PM_EMSG);
209 if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
211 dev->dev_errno = errstat;
212 Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
213 Jmsg0(jcr, M_ERROR_TERM, 0, dev->errmsg);
215 if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
217 dev->dev_errno = errstat;
218 Mmsg1(dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), be.strerror(errstat));
219 Jmsg0(jcr, M_ERROR_TERM, 0, dev->errmsg);
221 if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
223 dev->dev_errno = errstat;
224 Mmsg1(dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), be.strerror(errstat));
225 Jmsg0(jcr, M_ERROR_TERM, 0, dev->errmsg);
227 if ((errstat = pthread_mutex_init(&dev->spool_mutex, NULL)) != 0) {
229 dev->dev_errno = errstat;
230 Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
231 Jmsg0(jcr, M_ERROR_TERM, 0, dev->errmsg);
233 if ((errstat = rwl_init(&dev->lock)) != 0) {
235 dev->dev_errno = errstat;
236 Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
237 Jmsg0(jcr, M_ERROR_TERM, 0, dev->errmsg);
241 dev->attached_dcrs = New(dlist(dcr, &dcr->dev_link));
242 Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev->is_tape(), dev->dev_name);
248 * Open the device with the operating system and
249 * initialize buffer pointers.
251 * Returns: -1 on error
254 * Note, for a tape, the VolName is the name we give to the
255 * volume (not really used here), but for a file, the
256 * VolName represents the name of the file to be created/opened.
257 * In the case of a file, the full name is the device name
258 * (archive_name) with the VolName concatenated.
261 DEVICE::open(DCR *dcr, int omode)
264 if (openmode == omode) {
267 ::close(fd); /* use system close so correct mode will be used on open */
269 Dmsg0(100, "Close fd for mode change.\n");
273 bstrncpy(VolCatInfo.VolCatName, dcr->VolumeName, sizeof(VolCatInfo.VolCatName));
276 Dmsg4(29, "open dev: tape=%d dev_name=%s vol=%s mode=%s\n", is_tape(),
277 print_name(), VolCatInfo.VolCatName, mode_to_str(omode));
278 state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
279 label_type = B_BACULA_LABEL;
280 if (is_tape() || is_fifo()) {
281 open_tape_device(dcr, omode);
282 } else if (is_dvd()) {
283 Dmsg1(100, "call open_dvd_device mode=%s\n", mode_to_str(omode));
284 open_dvd_device(dcr, omode);
286 Dmsg1(100, "call open_file_device mode=%s\n", mode_to_str(omode));
287 open_file_device(omode);
292 void DEVICE::set_mode(int new_mode)
295 case CREATE_READ_WRITE:
296 mode = O_CREAT | O_RDWR | O_BINARY;
298 case OPEN_READ_WRITE:
299 if (is_dvd() || is_file()) {
300 mode = O_CREAT | O_RDWR | O_BINARY;
302 mode = O_RDWR | O_BINARY;
306 mode = O_RDONLY | O_BINARY;
308 case OPEN_WRITE_ONLY:
309 mode = O_WRONLY | O_BINARY;
312 Emsg0(M_ABORT, 0, _("Illegal mode given to open dev.\n"));
317 * If the flage open_nowait is set, which is the case
318 * when the daemon is initially trying to open the device,
319 * we open it with O_NONBLOCK set and O_RONLY, which will
320 * allow us to open normal Linux tape drives with no tape
321 * in the drive without blocking. We then immediately
322 * set blocking status so that if we read from the device they
323 * will be normal blocking reads.
325 * If later, we want to write on the device, it will be freed and
326 * reopened, but hopefully there will be a tape in the drive so
329 void DEVICE::open_tape_device(DCR *dcr, int omode)
335 Dmsg0(29, "open dev: device is tape\n");
337 if (is_tape() && is_autochanger()) {
338 get_autochanger_loaded_slot(dcr);
342 timeout = max_open_wait;
346 /* Set wait counters to zero for no wait */
347 timeout = ioerrcnt = 0;
348 /* Open drive in non-block mode */
349 nonblocking = O_NONBLOCK;
352 if (is_fifo() && timeout) {
354 tid = start_thread_timer(pthread_self(), timeout);
356 /* If busy retry each second for max_open_wait seconds */
357 Dmsg3(100, "Try open %s mode=%s nonblocking=%d\n", print_name(),
358 mode_to_str(omode), nonblocking);
359 /* Use system open() */
360 while ((fd = ::open(dev_name, mode+nonblocking, MODE_RW)) < 0) {
362 Dmsg2(100, "Open error errno=%d ERR=%s\n", errno, be.strerror());
363 if (errno == EINTR || errno == EAGAIN) {
364 Dmsg0(100, "Continue open\n");
367 /* Busy wait for specified time (default = 5 mins) */
368 if (errno == EBUSY && timeout-- > 0) {
369 Dmsg2(100, "Device %s busy. ERR=%s\n", print_name(), be.strerror());
373 /* IO error (no volume) try 10 times every 6 seconds */
374 if (errno == EIO && ioerrcnt-- > 0) {
376 Dmsg0(100, "Continue open\n");
380 Mmsg2(errmsg, _("Unable to open device %s: ERR=%s\n"),
381 print_name(), be.strerror(dev_errno));
382 /* Stop any open timer we set */
384 stop_thread_timer(tid);
387 Jmsg0(dcr->jcr, M_FATAL, 0, errmsg);
396 openmode = omode; /* save open mode */
397 Dmsg2(100, "openmode=%d %s\n", openmode, mode_to_str(openmode));
401 update_pos_dev(this); /* update position */
402 set_os_device_parameters(this); /* do system dependent stuff */
405 /* Stop any open() timer we started */
407 stop_thread_timer(tid);
410 Dmsg1(29, "open dev: tape %d opened\n", fd);
413 void DEVICE::set_blocking()
416 /* Try to reset blocking */
417 if ((oflags = fcntl(fd, F_GETFL, 0)) < 0 ||
418 fcntl(fd, F_SETFL, oflags & ~O_NONBLOCK) < 0) {
420 ::close(fd); /* use system close() */
421 fd = ::open(dev_name, mode, MODE_RW);
422 Dmsg2(100, "fcntl error. ERR=%s. Close-reopen fd=%d\n", be.strerror(), fd);
429 void DEVICE::open_file_device(int omode)
431 POOL_MEM archive_name(PM_FNAME);
434 * Handle opening of File Archive (not a tape)
436 Dmsg3(29, "Enter: open_file_dev: %s dev=%s mode=%s\n", is_dvd()?"DVD":"disk",
437 archive_name.c_str(), mode_to_str(omode));
439 if (VolCatInfo.VolCatName[0] == 0) {
440 Mmsg(errmsg, _("Could not open file device %s. No Volume name given.\n"),
446 pm_strcpy(archive_name, dev_name);
447 if (archive_name.c_str()[strlen(archive_name.c_str())-1] != '/') {
448 pm_strcat(archive_name, "/");
450 pm_strcat(archive_name, VolCatInfo.VolCatName);
452 Dmsg3(29, "open dev: %s dev=%s mode=%s\n", is_dvd()?"DVD":"disk",
453 archive_name.c_str(), mode_to_str(omode));
455 Dmsg2(100, "openmode=%d %s\n", openmode, mode_to_str(openmode));
458 /* If creating file, give 0640 permissions */
459 Dmsg3(29, "mode=%s open(%s, 0x%x, 0640)\n", mode_to_str(omode),
460 archive_name.c_str(), mode);
461 /* Use system open() */
462 if ((fd = ::open(archive_name.c_str(), mode, 0640)) < 0) {
465 Mmsg2(errmsg, _("Could not open: %s, ERR=%s\n"), archive_name.c_str(),
467 Dmsg1(29, "open failed: %s", errmsg);
468 Emsg0(M_FATAL, 0, errmsg);
473 update_pos_dev(this); /* update position */
475 Dmsg5(29, "open dev: %s fd=%d opened, part=%d/%d, part_size=%u\n",
476 is_dvd()?"DVD":"disk", fd, part, num_parts,
481 * Open a DVD device. N.B. at this point, dcr->VolCatInfo.VolCatName (NB:??? I think it's VolCatInfo.VolCatName that is right)
482 * has the desired Volume name, but there is NO assurance that
483 * any other field of VolCatInfo is correct.
485 void DEVICE::open_dvd_device(DCR *dcr, int omode)
487 POOL_MEM archive_name(PM_FNAME);
488 struct stat filestat;
491 * Handle opening of DVD Volume
493 Dmsg3(29, "Enter: open_dvd_dev: %s dev=%s mode=%s\n", is_dvd()?"DVD":"disk",
494 archive_name.c_str(), mode_to_str(omode));
496 if (VolCatInfo.VolCatName[0] == 0) {
497 Dmsg1(10, "Could not open file device %s. No Volume name given.\n",
499 Mmsg(errmsg, _("Could not open file device %s. No Volume name given.\n"),
510 Dmsg2(99, "open_dvd_device: num_parts=%d, VolCatInfo.VolCatParts=%d\n",
511 dcr->dev->num_parts, dcr->VolCatInfo.VolCatParts);
512 if (dcr->dev->num_parts < dcr->VolCatInfo.VolCatParts) {
513 Dmsg2(99, "open_dvd_device: num_parts updated to %d (was %d)\n",
514 dcr->VolCatInfo.VolCatParts, dcr->dev->num_parts);
515 dcr->dev->num_parts = dcr->VolCatInfo.VolCatParts;
518 if (mount_dev(this, 1)) {
519 if ((num_parts == 0) && (!truncating)) {
520 /* If we can mount the device, and we are not truncating the DVD, we usually want to abort. */
521 /* There is one exception, if there is only one 0-sized file on the DVD, with the right volume name,
522 * we continue (it's the method used by truncate_dvd_dev to truncate a volume). */
523 if (!check_can_write_on_non_blank_dvd(dcr)) {
524 Mmsg(errmsg, _("The media in the device %s is not empty, please blank it before writing anything to it.\n"), print_name());
525 Emsg0(M_FATAL, 0, errmsg);
526 unmount_dev(this, 1); /* Unmount the device, so the operator can change it. */
533 /* We cannot mount the device */
534 if (num_parts == 0) {
535 /* Run free space, check there is a media. */
536 update_free_space_dev(this);
538 Dmsg1(29, "Could not mount device %s, this is not a problem (num_parts == 0), and have media.\n", print_name());
541 Mmsg(errmsg, _("There is no valid media in the device %s.\n"), print_name());
542 Emsg0(M_FATAL, 0, errmsg);
548 Mmsg(errmsg, _("Could not mount device %s.\n"), print_name());
549 Emsg0(M_FATAL, 0, errmsg);
555 Dmsg6(29, "open dev: %s dev=%s mode=%s part=%d npart=%d volcatnparts=%d\n",
556 is_dvd()?"DVD":"disk", archive_name.c_str(), mode_to_str(omode),
557 part, num_parts, dcr->VolCatInfo.VolCatParts);
559 Dmsg2(100, "openmode=%d %s\n", openmode, mode_to_str(openmode));
562 * If we are not trying to access the last part, set mode to
563 * OPEN_READ_ONLY as writing would be an error.
565 if (part < num_parts) {
566 omode = OPEN_READ_ONLY;
567 make_mounted_dvd_filename(this, archive_name);
570 make_spooled_dvd_filename(this, archive_name);
574 /* If creating file, give 0640 permissions */
575 Dmsg3(29, "mode=%s open(%s, 0x%x, 0640)\n", mode_to_str(omode),
576 archive_name.c_str(), mode);
577 /* Use system open() */
578 if ((fd = ::open(archive_name.c_str(), mode, 0640)) < 0) {
580 Mmsg2(errmsg, _("Could not open: %s, ERR=%s\n"), archive_name.c_str(),
582 dev_errno = EIO; /* Interpreted as no device present by acquire.c:acquire_device_for_read(). */
583 Dmsg1(29, "open failed: %s", errmsg);
585 if ((omode == OPEN_READ_ONLY) && (part == num_parts)) {
586 /* If the last part (on spool), doesn't exists when reading, create it and read from it
587 * (it will report immediately an EOF):
588 * Sometimes it is better to finish with an EOF than with an error. */
589 set_mode(OPEN_READ_WRITE);
590 fd = ::open(archive_name.c_str(), mode, 0640);
591 set_mode(OPEN_READ_ONLY);
594 /* We don't need it. Only the last part is on spool */
595 /*if (omode == OPEN_READ_ONLY) {
596 make_spooled_dvd_filename(this, archive_name);
597 fd = ::open(archive_name.c_str(), mode, 0640); // try on spool
600 Dmsg1(100, "after open fd=%d\n", fd);
602 /* Get size of file */
603 if (fstat(fd, &filestat) < 0) {
606 Mmsg2(errmsg, _("Could not fstat: %s, ERR=%s\n"), archive_name.c_str(),
608 Dmsg1(29, "open failed: %s", errmsg);
609 /* Use system close() */
613 part_size = filestat.st_size;
617 update_pos_dev(this); /* update position */
619 /* NB: It seems this code is wrong... part number is incremented in open_next_part, not here */
621 /* Check if just created Volume part */
622 /* if (omode == OPEN_READ_WRITE && (part == 0 || part_size == 0)) {
625 VolCatInfo.VolCatParts = num_parts;
627 if (part == 0) { // we must have opened the first part
638 bool _rewind_dev(char *file, int line, DEVICE *dev)
640 Dmsg3(100, "rewind_dev fd=%d called from %s:%d\n", dev->fd, file, line);
641 return rewind_dev(dev);
647 * Returns: true on success
650 bool rewind_dev(DEVICE *dev)
655 Dmsg2(29, "rewind_dev fd=%d %s\n", dev->fd, dev->print_name());
657 if (!dev->is_dvd()) { /* In case of major error, the fd is not open on DVD, so we don't want to abort. */
658 dev->dev_errno = EBADF;
659 Mmsg1(dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
661 Emsg0(M_ABORT, 0, dev->errmsg);
665 dev->state &= ~(ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
666 dev->block_num = dev->file = 0;
669 if (dev->is_tape()) {
670 mt_com.mt_op = MTREW;
672 /* If we get an I/O error on rewind, it is probably because
673 * the drive is actually busy. We loop for (about 5 minutes)
674 * retrying every 5 seconds.
676 for (i=dev->max_rewind_wait; ; i -= 5) {
677 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
679 clrerror_dev(dev, MTREW);
680 if (i == dev->max_rewind_wait) {
681 Dmsg1(200, "Rewind error, %s. retrying ...\n", be.strerror());
683 if (dev->dev_errno == EIO && i > 0) {
684 Dmsg0(200, "Sleeping 5 seconds.\n");
688 Mmsg2(dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
689 dev->print_name(), be.strerror());
694 } else if (dev->is_file()) {
695 if (lseek_dev(dev, (off_t)0, SEEK_SET) < 0) {
697 dev->dev_errno = errno;
698 Mmsg2(dev->errmsg, _("lseek_dev error on %s. ERR=%s.\n"),
699 dev->print_name(), be.strerror());
706 void DEVICE::block(int why)
709 block_device(this, why);
713 void DEVICE::unblock()
716 unblock_device(this);
720 const char *DEVICE::print_blocked() const
722 switch (dev_blocked) {
723 case BST_NOT_BLOCKED:
724 return "BST_NOT_BLOCKED";
726 return "BST_UNMOUNTED";
727 case BST_WAITING_FOR_SYSOP:
728 return "BST_WAITING_FOR_SYSOP";
729 case BST_DOING_ACQUIRE:
730 return "BST_DOING_ACQUIRE";
731 case BST_WRITING_LABEL:
732 return "BST_WRITING_LABEL";
733 case BST_UNMOUNTED_WAITING_FOR_SYSOP:
734 return "BST_UNMOUNTED_WAITING_FOR_SYSOP";
738 return _("unknown blocked code");
743 * Called to indicate that we have just read an
744 * EOF from the device.
746 void DEVICE::set_ateof()
758 * Called to indicate we are now at the end of the tape, and
759 * writing is not possible.
761 void DEVICE::set_ateot()
763 /* Make tape effectively read-only */
764 state |= (ST_EOF|ST_EOT|ST_WEOT);
769 * Position device to end of medium (end of data)
770 * Returns: true on succes
777 struct mtget mt_stat;
782 dev->dev_errno = EBADF;
783 Mmsg1(dev->errmsg, _("Bad call to eod_dev. Device %s not open\n"),
788 #if defined (__digital__) && defined (__unix__)
789 return dev->fsf(dev->VolCatInfo.VolCatFiles);
792 Dmsg0(29, "eod_dev\n");
796 dev->state &= ~(ST_EOF); /* remove EOF flags */
797 dev->block_num = dev->file = 0;
800 if (dev->state & (ST_FIFO | ST_PROG)) {
803 if (!dev->is_tape()) {
804 pos = lseek_dev(dev, (off_t)0, SEEK_END);
805 // Dmsg1(100, "====== Seek to %lld\n", pos);
808 dev->state |= ST_EOT;
811 dev->dev_errno = errno;
813 Mmsg2(dev->errmsg, _("lseek_dev error on %s. ERR=%s.\n"),
814 dev->print_name(), be.strerror());
818 if (dev_cap(dev, CAP_FASTFSF) && !dev_cap(dev, CAP_EOM)) {
819 Dmsg0(100,"Using FAST FSF for EOM\n");
820 /* If unknown position, rewind */
821 if (!dev_get_os_pos(dev, &mt_stat)) {
822 if (!rewind_dev(dev)) {
826 mt_com.mt_op = MTFSF;
828 * ***FIXME*** fix code to handle case that INT16_MAX is
831 mt_com.mt_count = INT16_MAX; /* use big positive number */
832 if (mt_com.mt_count < 0) {
833 mt_com.mt_count = INT16_MAX; /* brain damaged system */
837 if (dev_cap(dev, CAP_MTIOCGET) && (dev_cap(dev, CAP_FASTFSF) || dev_cap(dev, CAP_EOM))) {
838 if (dev_cap(dev, CAP_EOM)) {
839 Dmsg0(100,"Using EOM for EOM\n");
840 mt_com.mt_op = MTEOM;
844 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
846 clrerror_dev(dev, mt_com.mt_op);
847 Dmsg1(50, "ioctl error: %s\n", be.strerror());
849 Mmsg2(dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
850 dev->print_name(), be.strerror());
854 if (!dev_get_os_pos(dev, &mt_stat)) {
856 clrerror_dev(dev, -1);
857 Mmsg2(dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
858 dev->print_name(), be.strerror());
861 Dmsg2(100, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
863 dev->file = mt_stat.mt_fileno;
869 * Rewind then use FSF until EOT reached
871 if (!rewind_dev(dev)) {
875 * Move file by file to the end of the tape
878 for (file_num=dev->file; !dev->at_eot(); file_num++) {
879 Dmsg0(200, "eod_dev: doing fsf 1\n");
881 Dmsg0(200, "fsf error.\n");
885 * Avoid infinite loop by ensuring we advance.
887 if (file_num == (int)dev->file) {
888 struct mtget mt_stat;
889 Dmsg1(100, "fsf did not advance from file %d\n", file_num);
891 if (dev_get_os_pos(dev, &mt_stat)) {
892 Dmsg2(100, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
893 dev->file = mt_stat.mt_fileno;
900 * Some drivers leave us after second EOF when doing
901 * MTEOM, so we must backup so that appending overwrites
904 if (dev_cap(dev, CAP_BSFATEOM)) {
905 struct mtget mt_stat;
906 /* Backup over EOF */
907 ok = bsf_dev(dev, 1);
908 /* If BSF worked and fileno is known (not -1), set file */
909 if (dev_get_os_pos(dev, &mt_stat)) {
910 Dmsg2(100, "BSFATEOF adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
911 dev->file = mt_stat.mt_fileno;
913 dev->file++; /* wing it -- not correct on all OSes */
916 update_pos_dev(dev); /* update position */
918 Dmsg1(200, "EOD dev->file=%d\n", dev->file);
923 * Set the position of the device -- only for files and DVD
924 * For other devices, there is no generic way to do it.
925 * Returns: true on succes
928 bool update_pos_dev(DEVICE *dev)
934 dev->dev_errno = EBADF;
935 Mmsg0(dev->errmsg, _("Bad device call. Device not open\n"));
936 Emsg0(M_FATAL, 0, dev->errmsg);
940 /* Find out where we are */
941 if (dev->is_file()) {
944 pos = lseek_dev(dev, (off_t)0, SEEK_CUR);
947 dev->dev_errno = errno;
948 Pmsg1(000, _("Seek error: ERR=%s\n"), be.strerror());
949 Mmsg2(dev->errmsg, _("lseek_dev error on %s. ERR=%s.\n"),
950 dev->print_name(), be.strerror());
953 dev->file_addr = pos;
961 * Return the status of the device. This was meant
962 * to be a generic routine. Unfortunately, it doesn't
963 * seem possible (at least I do not know how to do it
964 * currently), which means that for the moment, this
965 * routine has very little value.
969 uint32_t status_dev(DEVICE *dev)
971 struct mtget mt_stat;
974 if (dev->state & (ST_EOT | ST_WEOT)) {
978 if (dev->state & ST_EOF) {
982 if (dev->is_tape()) {
984 Pmsg0(-20,_(" Bacula status:"));
985 Pmsg2(-20,_(" file=%d block=%d\n"), dev->file, dev->block_num);
986 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
988 dev->dev_errno = errno;
989 Mmsg2(dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
990 dev->print_name(), be.strerror());
993 Pmsg0(-20, _(" Device status:"));
995 #if defined(HAVE_LINUX_OS)
996 if (GMT_EOF(mt_stat.mt_gstat)) {
1000 if (GMT_BOT(mt_stat.mt_gstat)) {
1004 if (GMT_EOT(mt_stat.mt_gstat)) {
1008 if (GMT_SM(mt_stat.mt_gstat)) {
1012 if (GMT_EOD(mt_stat.mt_gstat)) {
1016 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
1017 stat |= BMT_WR_PROT;
1018 Pmsg0(-20, " WR_PROT");
1020 if (GMT_ONLINE(mt_stat.mt_gstat)) {
1022 Pmsg0(-20, " ONLINE");
1024 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
1025 stat |= BMT_DR_OPEN;
1026 Pmsg0(-20, " DR_OPEN");
1028 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
1029 stat |= BMT_IM_REP_EN;
1030 Pmsg0(-20, " IM_REP_EN");
1032 #endif /* !SunOS && !OSF */
1033 if (dev_cap(dev, CAP_MTIOCGET)) {
1034 Pmsg2(-20, _(" file=%d block=%d\n"), mt_stat.mt_fileno, mt_stat.mt_blkno);
1036 Pmsg2(-20, _(" file=%d block=%d\n"), -1, -1);
1039 stat |= BMT_ONLINE | BMT_BOT;
1046 * Load medium in device
1047 * Returns: true on success
1050 bool load_dev(DEVICE *dev)
1057 dev->dev_errno = EBADF;
1058 Mmsg0(dev->errmsg, _("Bad call to load_dev. Device not open\n"));
1059 Emsg0(M_FATAL, 0, dev->errmsg);
1062 if (!(dev->is_tape())) {
1066 Dmsg0(200, "stored: MTLOAD command not available\n");
1068 dev->dev_errno = ENOTTY; /* function not available */
1069 Mmsg2(dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
1070 dev->print_name(), be.strerror());
1074 dev->block_num = dev->file = 0;
1077 mt_com.mt_op = MTLOAD;
1078 mt_com.mt_count = 1;
1079 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1081 dev->dev_errno = errno;
1082 Mmsg2(dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
1083 dev->print_name(), be.strerror());
1091 * Rewind device and put it offline
1092 * Returns: true on success
1095 bool offline_dev(DEVICE *dev)
1099 if (!dev || dev->fd < 0 || !dev->is_tape()) {
1100 return true; /* device not open */
1103 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
1104 dev->block_num = dev->file = 0;
1109 mt_com.mt_op = MTUNLOCK;
1110 mt_com.mt_count = 1;
1111 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1113 mt_com.mt_op = MTOFFL;
1114 mt_com.mt_count = 1;
1115 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1117 dev->dev_errno = errno;
1118 Mmsg2(dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
1119 dev->print_name(), be.strerror());
1122 Dmsg1(100, "Offlined device %s\n", dev->print_name());
1126 bool offline_or_rewind_dev(DEVICE *dev)
1131 if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
1132 return offline_dev(dev);
1135 * Note, this rewind probably should not be here (it wasn't
1136 * in prior versions of Bacula), but on FreeBSD, this is
1137 * needed in the case the tape was "frozen" due to an error
1138 * such as backspacing after writing and EOF. If it is not
1139 * done, all future references to the drive get and I/O error.
1141 clrerror_dev(dev, MTREW);
1142 return rewind_dev(dev);
1147 * Foward space a file
1148 * Returns: true on success
1151 bool DEVICE::fsf(int num)
1153 struct mtget mt_stat;
1159 Mmsg0(errmsg, _("Bad call to fsf_dev. Device not open\n"));
1160 Emsg0(M_FATAL, 0, errmsg);
1169 Mmsg1(errmsg, _("Device %s at End of Tape.\n"), print_name());
1173 Dmsg0(200, "ST_EOF set on entry to FSF\n");
1176 Dmsg0(100, "fsf\n");
1179 * If Fast forward space file is set, then we
1180 * use MTFSF to forward space and MTIOCGET
1181 * to get the file position. We assume that
1182 * the SCSI driver will ensure that we do not
1183 * forward space past the end of the medium.
1185 if (dev_cap(this, CAP_FSF) && dev_cap(this, CAP_MTIOCGET) && dev_cap(this, CAP_FASTFSF)) {
1186 mt_com.mt_op = MTFSF;
1187 mt_com.mt_count = num;
1188 stat = ioctl(fd, MTIOCTOP, (char *)&mt_com);
1189 if (stat < 0 || !dev_get_os_pos(this, &mt_stat)) {
1192 Dmsg0(200, "Set ST_EOT\n");
1193 clrerror_dev(this, MTFSF);
1194 Mmsg2(errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
1195 print_name(), be.strerror());
1196 Dmsg1(200, "%s", errmsg);
1199 Dmsg2(200, "fsf file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
1201 file = mt_stat.mt_fileno;
1205 * Here if CAP_FSF is set, and virtually all drives
1206 * these days support it, we read a record, then forward
1207 * space one file. Using this procedure, which is slow,
1208 * is the only way we can be sure that we don't read
1209 * two consecutive EOF marks, which means End of Data.
1211 } else if (dev_cap(this, CAP_FSF)) {
1214 Dmsg0(200, "FSF has cap_fsf\n");
1215 if (max_block_size == 0) {
1216 rbuf_len = DEFAULT_BLOCK_SIZE;
1218 rbuf_len = max_block_size;
1220 rbuf = get_memory(rbuf_len);
1221 mt_com.mt_op = MTFSF;
1222 mt_com.mt_count = 1;
1223 while (num-- && !at_eot()) {
1224 Dmsg0(100, "Doing read before fsf\n");
1225 if ((stat = read(fd, (char *)rbuf, rbuf_len)) < 0) {
1226 if (errno == ENOMEM) { /* tape record exceeds buf len */
1227 stat = rbuf_len; /* This is OK */
1229 * On IBM drives, they return ENOSPC at EOM
1230 * instead of EOF status
1232 } else if (at_eof() && errno == ENOSPC) {
1237 clrerror_dev(this, -1);
1238 Dmsg2(100, "Set ST_EOT read errno=%d. ERR=%s\n", dev_errno,
1240 Mmsg2(errmsg, _("read error on %s. ERR=%s.\n"),
1241 print_name(), be.strerror());
1242 Dmsg1(100, "%s", errmsg);
1246 if (stat == 0) { /* EOF */
1247 update_pos_dev(this);
1248 Dmsg1(100, "End of File mark from read. File=%d\n", file+1);
1249 /* Two reads of zero means end of tape */
1252 Dmsg0(100, "Set ST_EOT\n");
1258 } else { /* Got data */
1263 Dmsg0(100, "Doing MTFSF\n");
1264 stat = ioctl(fd, MTIOCTOP, (char *)&mt_com);
1265 if (stat < 0) { /* error => EOT */
1268 Dmsg0(100, "Set ST_EOT\n");
1269 clrerror_dev(this, MTFSF);
1270 Mmsg2(errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
1271 print_name(), be.strerror());
1272 Dmsg0(100, "Got < 0 for MTFSF\n");
1273 Dmsg1(100, "%s", errmsg);
1281 * No FSF, so use FSR to simulate it
1284 Dmsg0(200, "Doing FSR for FSF\n");
1285 while (num-- && !at_eot()) {
1286 fsr(INT32_MAX); /* returns -1 on EOF or EOT */
1290 Mmsg1(errmsg, _("Device %s at End of Tape.\n"), print_name());
1296 update_pos_dev(this);
1297 Dmsg1(200, "Return %d from FSF\n", stat);
1299 Dmsg0(200, "ST_EOF set on exit FSF\n");
1301 Dmsg0(200, "ST_EOT set on exit FSF\n");
1302 Dmsg1(200, "Return from FSF file=%d\n", file);
1307 * Backward space a file
1308 * Returns: false on failure
1312 bsf_dev(DEVICE *dev, int num)
1318 dev->dev_errno = EBADF;
1319 Mmsg0(dev->errmsg, _("Bad call to bsf_dev. Device not open\n"));
1320 Emsg0(M_FATAL, 0, dev->errmsg);
1324 if (!dev->is_tape()) {
1325 Mmsg1(dev->errmsg, _("Device %s cannot BSF because it is not a tape.\n"),
1329 Dmsg0(29, "bsf_dev\n");
1330 dev->state &= ~(ST_EOT|ST_EOF);
1334 mt_com.mt_op = MTBSF;
1335 mt_com.mt_count = num;
1336 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1339 clrerror_dev(dev, MTBSF);
1340 Mmsg2(dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
1341 dev->print_name(), be.strerror());
1343 update_pos_dev(dev);
1349 * Foward space num records
1350 * Returns: false on failure
1353 bool DEVICE::fsr(int num)
1360 Mmsg0(errmsg, _("Bad call to fsr. Device not open\n"));
1361 Emsg0(M_FATAL, 0, errmsg);
1368 if (!dev_cap(this, CAP_FSR)) {
1369 Mmsg1(errmsg, _("ioctl MTFSR not permitted on %s.\n"), print_name());
1373 Dmsg1(29, "fsr %d\n", num);
1374 mt_com.mt_op = MTFSR;
1375 mt_com.mt_count = num;
1376 stat = ioctl(fd, MTIOCTOP, (char *)&mt_com);
1382 struct mtget mt_stat;
1383 clrerror_dev(this, MTFSR);
1384 Dmsg1(100, "FSF fail: ERR=%s\n", be.strerror());
1385 if (dev_get_os_pos(this, &mt_stat)) {
1386 Dmsg4(100, "Adjust from %d:%d to %d:%d\n", file,
1387 block_num, mt_stat.mt_fileno, mt_stat.mt_blkno);
1388 file = mt_stat.mt_fileno;
1389 block_num = mt_stat.mt_blkno;
1397 Mmsg3(errmsg, _("ioctl MTFSR %d error on %s. ERR=%s.\n"),
1398 num, print_name(), be.strerror());
1400 update_pos_dev(this);
1405 * Backward space a record
1406 * Returns: false on failure
1410 bsr_dev(DEVICE *dev, int num)
1416 dev->dev_errno = EBADF;
1417 Mmsg0(dev->errmsg, _("Bad call to bsr_dev. Device not open\n"));
1418 Emsg0(M_FATAL, 0, dev->errmsg);
1422 if (!dev->is_tape()) {
1426 if (!dev_cap(dev, CAP_BSR)) {
1427 Mmsg1(dev->errmsg, _("ioctl MTBSR not permitted on %s.\n"), dev->print_name());
1431 Dmsg0(29, "bsr_dev\n");
1432 dev->block_num -= num;
1433 dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
1434 mt_com.mt_op = MTBSR;
1435 mt_com.mt_count = num;
1436 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1439 clrerror_dev(dev, MTBSR);
1440 Mmsg2(dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
1441 dev->print_name(), be.strerror());
1443 update_pos_dev(dev);
1448 * Reposition the device to file, block
1449 * Returns: false on failure
1453 reposition_dev(DEVICE *dev, uint32_t file, uint32_t block)
1456 dev->dev_errno = EBADF;
1457 Mmsg0(dev->errmsg, _("Bad call to reposition_dev. Device not open\n"));
1458 Emsg0(M_FATAL, 0, dev->errmsg);
1462 if (!dev->is_tape()) {
1463 off_t pos = (((off_t)file)<<32) + (off_t)block;
1464 Dmsg1(100, "===== lseek_dev to %d\n", (int)pos);
1465 if (lseek_dev(dev, pos, SEEK_SET) == (off_t)-1) {
1467 dev->dev_errno = errno;
1468 Mmsg2(dev->errmsg, _("lseek_dev error on %s. ERR=%s.\n"),
1469 dev->print_name(), be.strerror());
1473 dev->block_num = block;
1474 dev->file_addr = pos;
1477 Dmsg4(100, "reposition_dev from %u:%u to %u:%u\n",
1478 dev->file, dev->block_num, file, block);
1479 if (file < dev->file) {
1480 Dmsg0(100, "Rewind_dev\n");
1481 if (!rewind_dev(dev)) {
1485 if (file > dev->file) {
1486 Dmsg1(100, "fsf %d\n", file-dev->file);
1487 if (!dev->fsf(file-dev->file)) {
1488 Dmsg1(100, "fsf failed! ERR=%s\n", strerror_dev(dev));
1491 Dmsg2(100, "wanted_file=%d at_file=%d\n", file, dev->file);
1493 if (block < dev->block_num) {
1494 Dmsg2(100, "wanted_blk=%d at_blk=%d\n", block, dev->block_num);
1495 Dmsg0(100, "bsf_dev 1\n");
1497 Dmsg0(100, "fsf_dev 1\n");
1499 Dmsg2(100, "wanted_blk=%d at_blk=%d\n", block, dev->block_num);
1501 if (dev_cap(dev, CAP_POSITIONBLOCKS) && block > dev->block_num) {
1502 /* Ignore errors as Bacula can read to the correct block */
1503 Dmsg1(100, "fsr %d\n", block-dev->block_num);
1504 return dev->fsr(block-dev->block_num);
1512 * Write an end of file on the device
1513 * Returns: 0 on success
1514 * non-zero on failure
1517 weof_dev(DEVICE *dev, int num)
1521 Dmsg0(29, "weof_dev\n");
1524 dev->dev_errno = EBADF;
1525 Mmsg0(dev->errmsg, _("Bad call to weof_dev. Device not open\n"));
1526 Emsg0(M_FATAL, 0, dev->errmsg);
1531 if (!dev->is_tape()) {
1534 if (!dev->can_append()) {
1535 Mmsg0(dev->errmsg, _("Attempt to WEOF on non-appendable Volume\n"));
1536 Emsg0(M_FATAL, 0, dev->errmsg);
1540 dev->state &= ~(ST_EOT | ST_EOF); /* remove EOF/EOT flags */
1541 mt_com.mt_op = MTWEOF;
1542 mt_com.mt_count = num;
1543 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1550 clrerror_dev(dev, MTWEOF);
1552 Mmsg2(dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
1553 dev->print_name(), be.strerror());
1560 * Return string message with last error in English
1561 * Be careful not to call this routine from within dev.c
1562 * while editing an Mmsg() or you will end up in a recursive
1563 * loop creating a Segmentation Violation.
1566 strerror_dev(DEVICE *dev)
1573 * If implemented in system, clear the tape
1577 clrerror_dev(DEVICE *dev, int func)
1579 const char *msg = NULL;
1580 struct mtget mt_stat;
1583 dev->dev_errno = errno; /* save errno */
1585 dev->VolCatInfo.VolCatErrors++;
1588 if (!dev->is_tape()) {
1591 if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
1594 Emsg0(M_ABORT, 0, _("Got ENOTTY on read/write!\n"));
1598 dev->capabilities &= ~CAP_EOF; /* turn off feature */
1603 dev->capabilities &= ~CAP_EOM; /* turn off feature */
1608 dev->capabilities &= ~CAP_FSF; /* turn off feature */
1612 dev->capabilities &= ~CAP_BSF; /* turn off feature */
1616 dev->capabilities &= ~CAP_FSR; /* turn off feature */
1620 dev->capabilities &= ~CAP_BSR; /* turn off feature */
1641 bsnprintf(buf, sizeof(buf), _("unknown func code %d"), func);
1646 dev->dev_errno = ENOSYS;
1647 Mmsg1(dev->errmsg, _("I/O function \"%s\" not supported on this device.\n"), msg);
1648 Emsg0(M_ERROR, 0, dev->errmsg);
1651 /* On some systems such as NetBSD, this clears all errors */
1652 ioctl(dev->fd, MTIOCGET, (char *)&mt_stat);
1654 /* Found on Linux */
1658 mt_com.mt_op = MTIOCLRERR;
1659 mt_com.mt_count = 1;
1660 /* Clear any error condition on the tape */
1661 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1662 Dmsg0(200, "Did MTIOCLRERR\n");
1666 /* Typically on FreeBSD */
1669 /* Read and clear SCSI error status */
1670 union mterrstat mt_errstat;
1671 Dmsg2(200, "Doing MTIOCERRSTAT errno=%d ERR=%s\n", dev->dev_errno,
1672 strerror(dev->dev_errno));
1673 ioctl(dev->fd, MTIOCERRSTAT, (char *)&mt_errstat);
1677 /* Clear Subsystem Exception OSF1 */
1681 mt_com.mt_op = MTCSE;
1682 mt_com.mt_count = 1;
1683 /* Clear any error condition on the tape */
1684 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1685 Dmsg0(200, "Did MTCSE\n");
1691 * Flush buffer contents
1694 int flush_dev(DEVICE *dev)
1699 static void do_close(DEVICE *dev)
1702 Dmsg1(29, "really close_dev %s\n", dev->print_name());
1707 if (!unmount_dev(dev, 1)) {
1708 Dmsg1(0, "Cannot unmount device %s.\n", dev->print_name());
1711 /* Remove the last part file if it is empty */
1712 if (dev->num_parts > 0) {
1714 POOL_MEM archive_name(PM_FNAME);
1715 dev->part = dev->num_parts;
1716 Dmsg1(100, "Call make_dvd_filename. Vol=%s\n", dev->VolCatInfo.VolCatName);
1717 make_spooled_dvd_filename(dev, archive_name);
1718 /* Check that the part file is empty */
1719 if ((stat(archive_name.c_str(), &statp) == 0) && (statp.st_size == 0)) {
1720 Dmsg1(100, "unlink(%s)\n", archive_name.c_str());
1721 unlink(archive_name.c_str());
1725 /* Clean up device packet so it can be reused */
1727 dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1728 dev->label_type = B_BACULA_LABEL;
1729 dev->file = dev->block_num = 0;
1735 dev->part_start = 0;
1736 dev->EndFile = dev->EndBlock = 0;
1737 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1739 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1741 stop_thread_timer(dev->tid);
1751 void DEVICE::close()
1753 /*if (fd >= 0 && use_count == 1) {*/
1754 /* No need to check if fd >= 0: it is checked again
1755 * in do_close, and do_close MUST be called for volumes
1756 * splitted in parts, even if fd == -1. */
1757 if (use_count == 1) {
1759 } else if (use_count > 0) {
1764 ASSERT(use_count >= 0);
1769 bool truncate_dev(DCR *dcr) /* We need the DCR for DVD-writing */
1771 DEVICE *dev = dcr->dev;
1773 Dmsg1(100, "truncate_dev %s\n", dev->print_name());
1774 if (dev->is_tape()) {
1775 return true; /* we don't really truncate tapes */
1776 /* maybe we should rewind and write and eof ???? */
1779 if (dev->is_dvd()) {
1780 return truncate_dvd_dev(dcr);
1783 if (ftruncate(dev->fd, 0) != 0) {
1785 Mmsg2(dev->errmsg, _("Unable to truncate device %s. ERR=%s\n"),
1786 dev->print_name(), be.strerror());
1792 /* Return the resource name for the device */
1793 const char *DEVICE::name() const
1795 return device->hdr.name;
1799 dev_vol_name(DEVICE *dev)
1801 return dev->VolCatInfo.VolCatName;
1804 uint32_t dev_block(DEVICE *dev)
1806 update_pos_dev(dev);
1807 return dev->block_num;
1810 uint32_t dev_file(DEVICE *dev)
1812 update_pos_dev(dev);
1817 * Free memory allocated for the device
1820 term_dev(DEVICE *dev)
1823 dev->dev_errno = EBADF;
1824 Mmsg0(dev->errmsg, _("Bad call to term_dev. Device not open\n"));
1825 Emsg0(M_FATAL, 0, dev->errmsg);
1828 Dmsg1(29, "term_dev: %s\n", dev->print_name());
1830 if (dev->dev_name) {
1831 free_memory(dev->dev_name);
1832 dev->dev_name = NULL;
1834 if (dev->prt_name) {
1835 free_memory(dev->prt_name);
1836 dev->prt_name = NULL;
1839 free_pool_memory(dev->errmsg);
1842 pthread_mutex_destroy(&dev->mutex);
1843 pthread_cond_destroy(&dev->wait);
1844 pthread_cond_destroy(&dev->wait_next_vol);
1845 pthread_mutex_destroy(&dev->spool_mutex);
1846 rwl_destroy(&dev->lock);
1847 if (dev->attached_dcrs) {
1848 delete dev->attached_dcrs;
1849 dev->attached_dcrs = NULL;
1851 if (dev->state & ST_MALLOC) {
1852 free_pool_memory((POOLMEM *)dev);
1857 * This routine initializes the device wait timers
1859 void init_device_wait_timers(DCR *dcr)
1861 DEVICE *dev = dcr->dev;
1862 JCR *jcr = dcr->jcr;
1864 /* ******FIXME******* put these on config variables */
1865 dev->min_wait = 60 * 60;
1866 dev->max_wait = 24 * 60 * 60;
1867 dev->max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
1868 dev->wait_sec = dev->min_wait;
1869 dev->rem_wait_sec = dev->wait_sec;
1872 dev->BadVolName[0] = 0;
1874 jcr->min_wait = 60 * 60;
1875 jcr->max_wait = 24 * 60 * 60;
1876 jcr->max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
1877 jcr->wait_sec = jcr->min_wait;
1878 jcr->rem_wait_sec = jcr->wait_sec;
1883 void init_jcr_device_wait_timers(JCR *jcr)
1885 /* ******FIXME******* put these on config variables */
1886 jcr->min_wait = 60 * 60;
1887 jcr->max_wait = 24 * 60 * 60;
1888 jcr->max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
1889 jcr->wait_sec = jcr->min_wait;
1890 jcr->rem_wait_sec = jcr->wait_sec;
1896 * The dev timers are used for waiting on a particular device
1898 * Returns: true if time doubled
1899 * false if max time expired
1901 bool double_dev_wait_time(DEVICE *dev)
1903 dev->wait_sec *= 2; /* double wait time */
1904 if (dev->wait_sec > dev->max_wait) { /* but not longer than maxtime */
1905 dev->wait_sec = dev->max_wait;
1908 dev->rem_wait_sec = dev->wait_sec;
1909 if (dev->num_wait >= dev->max_num_wait) {
1916 void set_os_device_parameters(DEVICE *dev)
1918 #ifdef HAVE_LINUX_OS
1920 if (dev->min_block_size == dev->max_block_size &&
1921 dev->min_block_size == 0) { /* variable block mode */
1922 mt_com.mt_op = MTSETBLK;
1923 mt_com.mt_count = 0;
1924 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1925 clrerror_dev(dev, MTSETBLK);
1927 mt_com.mt_op = MTSETDRVBUFFER;
1928 mt_com.mt_count = MT_ST_CLEARBOOLEANS;
1929 if (!dev_cap(dev, CAP_TWOEOF)) {
1930 mt_com.mt_count |= MT_ST_TWO_FM;
1932 if (dev_cap(dev, CAP_EOM)) {
1933 mt_com.mt_count |= MT_ST_FAST_MTEOM;
1935 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1936 clrerror_dev(dev, MTSETBLK);
1942 #ifdef HAVE_NETBSD_OS
1944 if (dev->min_block_size == dev->max_block_size &&
1945 dev->min_block_size == 0) { /* variable block mode */
1946 mt_com.mt_op = MTSETBSIZ;
1947 mt_com.mt_count = 0;
1948 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1949 clrerror_dev(dev, MTSETBSIZ);
1951 /* Get notified at logical end of tape */
1952 mt_com.mt_op = MTEWARN;
1953 mt_com.mt_count = 1;
1954 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1955 clrerror_dev(dev, MTEWARN);
1961 #if HAVE_FREEBSD_OS || HAVE_OPENBSD_OS
1963 if (dev->min_block_size == dev->max_block_size &&
1964 dev->min_block_size == 0) { /* variable block mode */
1965 mt_com.mt_op = MTSETBSIZ;
1966 mt_com.mt_count = 0;
1967 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1968 clrerror_dev(dev, MTSETBSIZ);
1976 if (dev->min_block_size == dev->max_block_size &&
1977 dev->min_block_size == 0) { /* variable block mode */
1978 mt_com.mt_op = MTSRSZ;
1979 mt_com.mt_count = 0;
1980 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1981 clrerror_dev(dev, MTSRSZ);
1988 static bool dev_get_os_pos(DEVICE *dev, struct mtget *mt_stat)
1990 return dev_cap(dev, CAP_MTIOCGET) &&
1991 ioctl(dev->fd, MTIOCGET, (char *)mt_stat) == 0 &&
1992 mt_stat->mt_fileno >= 0;
1995 static char *modes[] = {
1996 "CREATE_READ_WRITE",
2003 static char *mode_to_str(int mode)
2005 return modes[mode-1];