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) {
363 Dmsg5(050, "Open omode=%d mode=%x nonblock=%d error errno=%d ERR=%s\n",
364 omode, mode, nonblocking, errno, be.strerror());
365 if (dev_errno == EINTR || dev_errno == EAGAIN) {
366 Dmsg0(100, "Continue open\n");
369 /* Busy wait for specified time (default = 5 mins) */
370 if (dev_errno == EBUSY && timeout-- > 0) {
371 Dmsg2(100, "Device %s busy. ERR=%s\n", print_name(), be.strerror());
375 /* IO error (no volume) try 10 times every 6 seconds */
376 if (dev_errno == EIO && ioerrcnt-- > 0) {
378 Dmsg0(100, "Continue open\n");
381 Mmsg2(errmsg, _("Unable to open device %s: ERR=%s\n"),
382 print_name(), be.strerror(dev_errno));
383 /* Stop any open timer we set */
385 stop_thread_timer(tid);
388 Jmsg0(dcr->jcr, M_FATAL, 0, errmsg);
397 openmode = omode; /* save open mode */
398 Dmsg2(100, "openmode=%d %s\n", openmode, mode_to_str(openmode));
402 update_pos_dev(this); /* update position */
403 set_os_device_parameters(this); /* do system dependent stuff */
406 /* Stop any open() timer we started */
408 stop_thread_timer(tid);
411 Dmsg1(29, "open dev: tape %d opened\n", fd);
414 void DEVICE::set_blocking()
417 /* Try to reset blocking */
418 if ((oflags = fcntl(fd, F_GETFL, 0)) < 0 ||
419 fcntl(fd, F_SETFL, oflags & ~O_NONBLOCK) < 0) {
421 ::close(fd); /* use system close() */
422 fd = ::open(dev_name, mode, MODE_RW);
423 Dmsg2(100, "fcntl error. ERR=%s. Close-reopen fd=%d\n", be.strerror(), fd);
430 void DEVICE::open_file_device(int omode)
432 POOL_MEM archive_name(PM_FNAME);
435 * Handle opening of File Archive (not a tape)
437 Dmsg3(29, "Enter: open_file_dev: %s dev=%s mode=%s\n", is_dvd()?"DVD":"disk",
438 archive_name.c_str(), mode_to_str(omode));
440 if (VolCatInfo.VolCatName[0] == 0) {
441 Mmsg(errmsg, _("Could not open file device %s. No Volume name given.\n"),
447 pm_strcpy(archive_name, dev_name);
448 if (archive_name.c_str()[strlen(archive_name.c_str())-1] != '/') {
449 pm_strcat(archive_name, "/");
451 pm_strcat(archive_name, VolCatInfo.VolCatName);
453 Dmsg3(29, "open dev: %s dev=%s mode=%s\n", is_dvd()?"DVD":"disk",
454 archive_name.c_str(), mode_to_str(omode));
456 Dmsg2(100, "openmode=%d %s\n", openmode, mode_to_str(openmode));
459 /* If creating file, give 0640 permissions */
460 Dmsg3(29, "mode=%s open(%s, 0x%x, 0640)\n", mode_to_str(omode),
461 archive_name.c_str(), mode);
462 /* Use system open() */
463 if ((fd = ::open(archive_name.c_str(), mode, 0640)) < 0) {
466 Mmsg2(errmsg, _("Could not open: %s, ERR=%s\n"), archive_name.c_str(),
468 Dmsg1(29, "open failed: %s", errmsg);
469 Emsg0(M_FATAL, 0, errmsg);
474 update_pos_dev(this); /* update position */
476 Dmsg5(29, "open dev: %s fd=%d opened, part=%d/%d, part_size=%u\n",
477 is_dvd()?"DVD":"disk", fd, part, num_parts,
482 * Open a DVD device. N.B. at this point, dcr->VolCatInfo.VolCatName (NB:??? I think it's VolCatInfo.VolCatName that is right)
483 * has the desired Volume name, but there is NO assurance that
484 * any other field of VolCatInfo is correct.
486 void DEVICE::open_dvd_device(DCR *dcr, int omode)
488 POOL_MEM archive_name(PM_FNAME);
489 struct stat filestat;
492 * Handle opening of DVD Volume
494 Dmsg3(29, "Enter: open_dvd_dev: %s dev=%s mode=%s\n", is_dvd()?"DVD":"disk",
495 archive_name.c_str(), mode_to_str(omode));
497 if (VolCatInfo.VolCatName[0] == 0) {
498 Dmsg1(10, "Could not open file device %s. No Volume name given.\n",
500 Mmsg(errmsg, _("Could not open file device %s. No Volume name given.\n"),
511 Dmsg2(99, "open_dvd_device: num_parts=%d, VolCatInfo.VolCatParts=%d\n",
512 dcr->dev->num_parts, dcr->VolCatInfo.VolCatParts);
513 if (dcr->dev->num_parts < dcr->VolCatInfo.VolCatParts) {
514 Dmsg2(99, "open_dvd_device: num_parts updated to %d (was %d)\n",
515 dcr->VolCatInfo.VolCatParts, dcr->dev->num_parts);
516 dcr->dev->num_parts = dcr->VolCatInfo.VolCatParts;
519 if (mount_dev(this, 1)) {
520 if ((num_parts == 0) && (!truncating)) {
521 /* If we can mount the device, and we are not truncating the DVD, we usually want to abort. */
522 /* There is one exception, if there is only one 0-sized file on the DVD, with the right volume name,
523 * we continue (it's the method used by truncate_dvd_dev to truncate a volume). */
524 if (!check_can_write_on_non_blank_dvd(dcr)) {
525 Mmsg(errmsg, _("The media in the device %s is not empty, please blank it before writing anything to it.\n"), print_name());
526 Emsg0(M_FATAL, 0, errmsg);
527 unmount_dev(this, 1); /* Unmount the device, so the operator can change it. */
534 /* We cannot mount the device */
535 if (num_parts == 0) {
536 /* Run free space, check there is a media. */
537 update_free_space_dev(this);
539 Dmsg1(29, "Could not mount device %s, this is not a problem (num_parts == 0), and have media.\n", print_name());
542 Mmsg(errmsg, _("There is no valid media in the device %s.\n"), print_name());
543 Emsg0(M_FATAL, 0, errmsg);
549 Mmsg(errmsg, _("Could not mount device %s.\n"), print_name());
550 Emsg0(M_FATAL, 0, errmsg);
556 Dmsg6(29, "open dev: %s dev=%s mode=%s part=%d npart=%d volcatnparts=%d\n",
557 is_dvd()?"DVD":"disk", archive_name.c_str(), mode_to_str(omode),
558 part, num_parts, dcr->VolCatInfo.VolCatParts);
560 Dmsg2(100, "openmode=%d %s\n", openmode, mode_to_str(openmode));
563 * If we are not trying to access the last part, set mode to
564 * OPEN_READ_ONLY as writing would be an error.
566 if (part < num_parts) {
567 omode = OPEN_READ_ONLY;
568 make_mounted_dvd_filename(this, archive_name);
571 make_spooled_dvd_filename(this, archive_name);
575 /* If creating file, give 0640 permissions */
576 Dmsg3(29, "mode=%s open(%s, 0x%x, 0640)\n", mode_to_str(omode),
577 archive_name.c_str(), mode);
578 /* Use system open() */
579 if ((fd = ::open(archive_name.c_str(), mode, 0640)) < 0) {
581 Mmsg2(errmsg, _("Could not open: %s, ERR=%s\n"), archive_name.c_str(),
583 dev_errno = EIO; /* Interpreted as no device present by acquire.c:acquire_device_for_read(). */
584 Dmsg1(29, "open failed: %s", errmsg);
586 if ((omode == OPEN_READ_ONLY) && (part == num_parts)) {
587 /* If the last part (on spool), doesn't exists when reading, create it and read from it
588 * (it will report immediately an EOF):
589 * Sometimes it is better to finish with an EOF than with an error. */
590 set_mode(OPEN_READ_WRITE);
591 fd = ::open(archive_name.c_str(), mode, 0640);
592 set_mode(OPEN_READ_ONLY);
595 /* We don't need it. Only the last part is on spool */
596 /*if (omode == OPEN_READ_ONLY) {
597 make_spooled_dvd_filename(this, archive_name);
598 fd = ::open(archive_name.c_str(), mode, 0640); // try on spool
601 Dmsg1(100, "after open fd=%d\n", fd);
603 /* Get size of file */
604 if (fstat(fd, &filestat) < 0) {
607 Mmsg2(errmsg, _("Could not fstat: %s, ERR=%s\n"), archive_name.c_str(),
609 Dmsg1(29, "open failed: %s", errmsg);
610 /* Use system close() */
614 part_size = filestat.st_size;
618 update_pos_dev(this); /* update position */
620 /* NB: It seems this code is wrong... part number is incremented in open_next_part, not here */
622 /* Check if just created Volume part */
623 /* if (omode == OPEN_READ_WRITE && (part == 0 || part_size == 0)) {
626 VolCatInfo.VolCatParts = num_parts;
628 if (part == 0) { // we must have opened the first part
639 bool _rewind_dev(char *file, int line, DEVICE *dev)
641 Dmsg3(100, "rewind_dev fd=%d called from %s:%d\n", dev->fd, file, line);
642 return rewind_dev(dev);
648 * Returns: true on success
651 bool rewind_dev(DEVICE *dev)
656 Dmsg2(29, "rewind_dev fd=%d %s\n", dev->fd, dev->print_name());
658 if (!dev->is_dvd()) { /* In case of major error, the fd is not open on DVD, so we don't want to abort. */
659 dev->dev_errno = EBADF;
660 Mmsg1(dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
662 Emsg0(M_ABORT, 0, dev->errmsg);
666 dev->state &= ~(ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
667 dev->block_num = dev->file = 0;
670 if (dev->is_tape()) {
671 mt_com.mt_op = MTREW;
673 /* If we get an I/O error on rewind, it is probably because
674 * the drive is actually busy. We loop for (about 5 minutes)
675 * retrying every 5 seconds.
677 for (i=dev->max_rewind_wait; ; i -= 5) {
678 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
680 clrerror_dev(dev, MTREW);
681 if (i == dev->max_rewind_wait) {
682 Dmsg1(200, "Rewind error, %s. retrying ...\n", be.strerror());
684 if (dev->dev_errno == EIO && i > 0) {
685 Dmsg0(200, "Sleeping 5 seconds.\n");
689 Mmsg2(dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
690 dev->print_name(), be.strerror());
695 } else if (dev->is_file()) {
696 if (lseek_dev(dev, (off_t)0, SEEK_SET) < 0) {
698 dev->dev_errno = errno;
699 Mmsg2(dev->errmsg, _("lseek_dev error on %s. ERR=%s.\n"),
700 dev->print_name(), be.strerror());
707 void DEVICE::block(int why)
710 block_device(this, why);
714 void DEVICE::unblock()
717 unblock_device(this);
721 const char *DEVICE::print_blocked() const
723 switch (dev_blocked) {
724 case BST_NOT_BLOCKED:
725 return "BST_NOT_BLOCKED";
727 return "BST_UNMOUNTED";
728 case BST_WAITING_FOR_SYSOP:
729 return "BST_WAITING_FOR_SYSOP";
730 case BST_DOING_ACQUIRE:
731 return "BST_DOING_ACQUIRE";
732 case BST_WRITING_LABEL:
733 return "BST_WRITING_LABEL";
734 case BST_UNMOUNTED_WAITING_FOR_SYSOP:
735 return "BST_UNMOUNTED_WAITING_FOR_SYSOP";
739 return _("unknown blocked code");
744 * Called to indicate that we have just read an
745 * EOF from the device.
747 void DEVICE::set_ateof()
759 * Called to indicate we are now at the end of the tape, and
760 * writing is not possible.
762 void DEVICE::set_ateot()
764 /* Make tape effectively read-only */
765 state |= (ST_EOF|ST_EOT|ST_WEOT);
770 * Position device to end of medium (end of data)
771 * Returns: true on succes
778 struct mtget mt_stat;
783 dev->dev_errno = EBADF;
784 Mmsg1(dev->errmsg, _("Bad call to eod_dev. Device %s not open\n"),
789 #if defined (__digital__) && defined (__unix__)
790 return dev->fsf(dev->VolCatInfo.VolCatFiles);
793 Dmsg0(29, "eod_dev\n");
797 dev->state &= ~(ST_EOF); /* remove EOF flags */
798 dev->block_num = dev->file = 0;
801 if (dev->state & (ST_FIFO | ST_PROG)) {
804 if (!dev->is_tape()) {
805 pos = lseek_dev(dev, (off_t)0, SEEK_END);
806 // Dmsg1(100, "====== Seek to %lld\n", pos);
809 dev->state |= ST_EOT;
812 dev->dev_errno = errno;
814 Mmsg2(dev->errmsg, _("lseek_dev error on %s. ERR=%s.\n"),
815 dev->print_name(), be.strerror());
819 if (dev_cap(dev, CAP_FASTFSF) && !dev_cap(dev, CAP_EOM)) {
820 Dmsg0(100,"Using FAST FSF for EOM\n");
821 /* If unknown position, rewind */
822 if (!dev_get_os_pos(dev, &mt_stat)) {
823 if (!rewind_dev(dev)) {
827 mt_com.mt_op = MTFSF;
829 * ***FIXME*** fix code to handle case that INT16_MAX is
832 mt_com.mt_count = INT16_MAX; /* use big positive number */
833 if (mt_com.mt_count < 0) {
834 mt_com.mt_count = INT16_MAX; /* brain damaged system */
838 if (dev_cap(dev, CAP_MTIOCGET) && (dev_cap(dev, CAP_FASTFSF) || dev_cap(dev, CAP_EOM))) {
839 if (dev_cap(dev, CAP_EOM)) {
840 Dmsg0(100,"Using EOM for EOM\n");
841 mt_com.mt_op = MTEOM;
845 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
847 clrerror_dev(dev, mt_com.mt_op);
848 Dmsg1(50, "ioctl error: %s\n", be.strerror());
850 Mmsg2(dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
851 dev->print_name(), be.strerror());
855 if (!dev_get_os_pos(dev, &mt_stat)) {
857 clrerror_dev(dev, -1);
858 Mmsg2(dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
859 dev->print_name(), be.strerror());
862 Dmsg2(100, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
864 dev->file = mt_stat.mt_fileno;
870 * Rewind then use FSF until EOT reached
872 if (!rewind_dev(dev)) {
876 * Move file by file to the end of the tape
879 for (file_num=dev->file; !dev->at_eot(); file_num++) {
880 Dmsg0(200, "eod_dev: doing fsf 1\n");
882 Dmsg0(200, "fsf error.\n");
886 * Avoid infinite loop by ensuring we advance.
888 if (file_num == (int)dev->file) {
889 struct mtget mt_stat;
890 Dmsg1(100, "fsf did not advance from file %d\n", file_num);
892 if (dev_get_os_pos(dev, &mt_stat)) {
893 Dmsg2(100, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
894 dev->file = mt_stat.mt_fileno;
901 * Some drivers leave us after second EOF when doing
902 * MTEOM, so we must backup so that appending overwrites
905 if (dev_cap(dev, CAP_BSFATEOM)) {
906 struct mtget mt_stat;
907 /* Backup over EOF */
908 ok = bsf_dev(dev, 1);
909 /* If BSF worked and fileno is known (not -1), set file */
910 if (dev_get_os_pos(dev, &mt_stat)) {
911 Dmsg2(100, "BSFATEOF adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
912 dev->file = mt_stat.mt_fileno;
914 dev->file++; /* wing it -- not correct on all OSes */
917 update_pos_dev(dev); /* update position */
919 Dmsg1(200, "EOD dev->file=%d\n", dev->file);
924 * Set the position of the device -- only for files and DVD
925 * For other devices, there is no generic way to do it.
926 * Returns: true on succes
929 bool update_pos_dev(DEVICE *dev)
935 dev->dev_errno = EBADF;
936 Mmsg0(dev->errmsg, _("Bad device call. Device not open\n"));
937 Emsg0(M_FATAL, 0, dev->errmsg);
941 /* Find out where we are */
942 if (dev->is_file()) {
945 pos = lseek_dev(dev, (off_t)0, SEEK_CUR);
948 dev->dev_errno = errno;
949 Pmsg1(000, _("Seek error: ERR=%s\n"), be.strerror());
950 Mmsg2(dev->errmsg, _("lseek_dev error on %s. ERR=%s.\n"),
951 dev->print_name(), be.strerror());
954 dev->file_addr = pos;
962 * Return the status of the device. This was meant
963 * to be a generic routine. Unfortunately, it doesn't
964 * seem possible (at least I do not know how to do it
965 * currently), which means that for the moment, this
966 * routine has very little value.
970 uint32_t status_dev(DEVICE *dev)
972 struct mtget mt_stat;
975 if (dev->state & (ST_EOT | ST_WEOT)) {
979 if (dev->state & ST_EOF) {
983 if (dev->is_tape()) {
985 Pmsg0(-20,_(" Bacula status:"));
986 Pmsg2(-20,_(" file=%d block=%d\n"), dev->file, dev->block_num);
987 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
989 dev->dev_errno = errno;
990 Mmsg2(dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
991 dev->print_name(), be.strerror());
994 Pmsg0(-20, _(" Device status:"));
996 #if defined(HAVE_LINUX_OS)
997 if (GMT_EOF(mt_stat.mt_gstat)) {
1001 if (GMT_BOT(mt_stat.mt_gstat)) {
1005 if (GMT_EOT(mt_stat.mt_gstat)) {
1009 if (GMT_SM(mt_stat.mt_gstat)) {
1013 if (GMT_EOD(mt_stat.mt_gstat)) {
1017 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
1018 stat |= BMT_WR_PROT;
1019 Pmsg0(-20, " WR_PROT");
1021 if (GMT_ONLINE(mt_stat.mt_gstat)) {
1023 Pmsg0(-20, " ONLINE");
1025 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
1026 stat |= BMT_DR_OPEN;
1027 Pmsg0(-20, " DR_OPEN");
1029 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
1030 stat |= BMT_IM_REP_EN;
1031 Pmsg0(-20, " IM_REP_EN");
1033 #endif /* !SunOS && !OSF */
1034 if (dev_cap(dev, CAP_MTIOCGET)) {
1035 Pmsg2(-20, _(" file=%d block=%d\n"), mt_stat.mt_fileno, mt_stat.mt_blkno);
1037 Pmsg2(-20, _(" file=%d block=%d\n"), -1, -1);
1040 stat |= BMT_ONLINE | BMT_BOT;
1047 * Load medium in device
1048 * Returns: true on success
1051 bool load_dev(DEVICE *dev)
1058 dev->dev_errno = EBADF;
1059 Mmsg0(dev->errmsg, _("Bad call to load_dev. Device not open\n"));
1060 Emsg0(M_FATAL, 0, dev->errmsg);
1063 if (!(dev->is_tape())) {
1067 Dmsg0(200, "stored: MTLOAD command not available\n");
1069 dev->dev_errno = ENOTTY; /* function not available */
1070 Mmsg2(dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
1071 dev->print_name(), be.strerror());
1075 dev->block_num = dev->file = 0;
1078 mt_com.mt_op = MTLOAD;
1079 mt_com.mt_count = 1;
1080 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1082 dev->dev_errno = errno;
1083 Mmsg2(dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
1084 dev->print_name(), be.strerror());
1092 * Rewind device and put it offline
1093 * Returns: true on success
1096 bool offline_dev(DEVICE *dev)
1100 if (!dev || dev->fd < 0 || !dev->is_tape()) {
1101 return true; /* device not open */
1104 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
1105 dev->block_num = dev->file = 0;
1110 mt_com.mt_op = MTUNLOCK;
1111 mt_com.mt_count = 1;
1112 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1114 mt_com.mt_op = MTOFFL;
1115 mt_com.mt_count = 1;
1116 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1118 dev->dev_errno = errno;
1119 Mmsg2(dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
1120 dev->print_name(), be.strerror());
1123 Dmsg1(100, "Offlined device %s\n", dev->print_name());
1127 bool offline_or_rewind_dev(DEVICE *dev)
1132 if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
1133 return offline_dev(dev);
1136 * Note, this rewind probably should not be here (it wasn't
1137 * in prior versions of Bacula), but on FreeBSD, this is
1138 * needed in the case the tape was "frozen" due to an error
1139 * such as backspacing after writing and EOF. If it is not
1140 * done, all future references to the drive get and I/O error.
1142 clrerror_dev(dev, MTREW);
1143 return rewind_dev(dev);
1148 * Foward space a file
1149 * Returns: true on success
1152 bool DEVICE::fsf(int num)
1154 struct mtget mt_stat;
1160 Mmsg0(errmsg, _("Bad call to fsf_dev. Device not open\n"));
1161 Emsg0(M_FATAL, 0, errmsg);
1170 Mmsg1(errmsg, _("Device %s at End of Tape.\n"), print_name());
1174 Dmsg0(200, "ST_EOF set on entry to FSF\n");
1177 Dmsg0(100, "fsf\n");
1180 * If Fast forward space file is set, then we
1181 * use MTFSF to forward space and MTIOCGET
1182 * to get the file position. We assume that
1183 * the SCSI driver will ensure that we do not
1184 * forward space past the end of the medium.
1186 if (dev_cap(this, CAP_FSF) && dev_cap(this, CAP_MTIOCGET) && dev_cap(this, CAP_FASTFSF)) {
1187 mt_com.mt_op = MTFSF;
1188 mt_com.mt_count = num;
1189 stat = ioctl(fd, MTIOCTOP, (char *)&mt_com);
1190 if (stat < 0 || !dev_get_os_pos(this, &mt_stat)) {
1193 Dmsg0(200, "Set ST_EOT\n");
1194 clrerror_dev(this, MTFSF);
1195 Mmsg2(errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
1196 print_name(), be.strerror());
1197 Dmsg1(200, "%s", errmsg);
1200 Dmsg2(200, "fsf file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
1202 file = mt_stat.mt_fileno;
1206 * Here if CAP_FSF is set, and virtually all drives
1207 * these days support it, we read a record, then forward
1208 * space one file. Using this procedure, which is slow,
1209 * is the only way we can be sure that we don't read
1210 * two consecutive EOF marks, which means End of Data.
1212 } else if (dev_cap(this, CAP_FSF)) {
1215 Dmsg0(200, "FSF has cap_fsf\n");
1216 if (max_block_size == 0) {
1217 rbuf_len = DEFAULT_BLOCK_SIZE;
1219 rbuf_len = max_block_size;
1221 rbuf = get_memory(rbuf_len);
1222 mt_com.mt_op = MTFSF;
1223 mt_com.mt_count = 1;
1224 while (num-- && !at_eot()) {
1225 Dmsg0(100, "Doing read before fsf\n");
1226 if ((stat = read(fd, (char *)rbuf, rbuf_len)) < 0) {
1227 if (errno == ENOMEM) { /* tape record exceeds buf len */
1228 stat = rbuf_len; /* This is OK */
1230 * On IBM drives, they return ENOSPC at EOM
1231 * instead of EOF status
1233 } else if (at_eof() && errno == ENOSPC) {
1238 clrerror_dev(this, -1);
1239 Dmsg2(100, "Set ST_EOT read errno=%d. ERR=%s\n", dev_errno,
1241 Mmsg2(errmsg, _("read error on %s. ERR=%s.\n"),
1242 print_name(), be.strerror());
1243 Dmsg1(100, "%s", errmsg);
1247 if (stat == 0) { /* EOF */
1248 update_pos_dev(this);
1249 Dmsg1(100, "End of File mark from read. File=%d\n", file+1);
1250 /* Two reads of zero means end of tape */
1253 Dmsg0(100, "Set ST_EOT\n");
1259 } else { /* Got data */
1264 Dmsg0(100, "Doing MTFSF\n");
1265 stat = ioctl(fd, MTIOCTOP, (char *)&mt_com);
1266 if (stat < 0) { /* error => EOT */
1269 Dmsg0(100, "Set ST_EOT\n");
1270 clrerror_dev(this, MTFSF);
1271 Mmsg2(errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
1272 print_name(), be.strerror());
1273 Dmsg0(100, "Got < 0 for MTFSF\n");
1274 Dmsg1(100, "%s", errmsg);
1282 * No FSF, so use FSR to simulate it
1285 Dmsg0(200, "Doing FSR for FSF\n");
1286 while (num-- && !at_eot()) {
1287 fsr(INT32_MAX); /* returns -1 on EOF or EOT */
1291 Mmsg1(errmsg, _("Device %s at End of Tape.\n"), print_name());
1297 update_pos_dev(this);
1298 Dmsg1(200, "Return %d from FSF\n", stat);
1300 Dmsg0(200, "ST_EOF set on exit FSF\n");
1302 Dmsg0(200, "ST_EOT set on exit FSF\n");
1303 Dmsg1(200, "Return from FSF file=%d\n", file);
1308 * Backward space a file
1309 * Returns: false on failure
1313 bsf_dev(DEVICE *dev, int num)
1319 dev->dev_errno = EBADF;
1320 Mmsg0(dev->errmsg, _("Bad call to bsf_dev. Device not open\n"));
1321 Emsg0(M_FATAL, 0, dev->errmsg);
1325 if (!dev->is_tape()) {
1326 Mmsg1(dev->errmsg, _("Device %s cannot BSF because it is not a tape.\n"),
1330 Dmsg0(29, "bsf_dev\n");
1331 dev->state &= ~(ST_EOT|ST_EOF);
1335 mt_com.mt_op = MTBSF;
1336 mt_com.mt_count = num;
1337 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1340 clrerror_dev(dev, MTBSF);
1341 Mmsg2(dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
1342 dev->print_name(), be.strerror());
1344 update_pos_dev(dev);
1350 * Foward space num records
1351 * Returns: false on failure
1354 bool DEVICE::fsr(int num)
1361 Mmsg0(errmsg, _("Bad call to fsr. Device not open\n"));
1362 Emsg0(M_FATAL, 0, errmsg);
1369 if (!dev_cap(this, CAP_FSR)) {
1370 Mmsg1(errmsg, _("ioctl MTFSR not permitted on %s.\n"), print_name());
1374 Dmsg1(29, "fsr %d\n", num);
1375 mt_com.mt_op = MTFSR;
1376 mt_com.mt_count = num;
1377 stat = ioctl(fd, MTIOCTOP, (char *)&mt_com);
1383 struct mtget mt_stat;
1384 clrerror_dev(this, MTFSR);
1385 Dmsg1(100, "FSF fail: ERR=%s\n", be.strerror());
1386 if (dev_get_os_pos(this, &mt_stat)) {
1387 Dmsg4(100, "Adjust from %d:%d to %d:%d\n", file,
1388 block_num, mt_stat.mt_fileno, mt_stat.mt_blkno);
1389 file = mt_stat.mt_fileno;
1390 block_num = mt_stat.mt_blkno;
1398 Mmsg3(errmsg, _("ioctl MTFSR %d error on %s. ERR=%s.\n"),
1399 num, print_name(), be.strerror());
1401 update_pos_dev(this);
1406 * Backward space a record
1407 * Returns: false on failure
1411 bsr_dev(DEVICE *dev, int num)
1417 dev->dev_errno = EBADF;
1418 Mmsg0(dev->errmsg, _("Bad call to bsr_dev. Device not open\n"));
1419 Emsg0(M_FATAL, 0, dev->errmsg);
1423 if (!dev->is_tape()) {
1427 if (!dev_cap(dev, CAP_BSR)) {
1428 Mmsg1(dev->errmsg, _("ioctl MTBSR not permitted on %s.\n"), dev->print_name());
1432 Dmsg0(29, "bsr_dev\n");
1433 dev->block_num -= num;
1434 dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
1435 mt_com.mt_op = MTBSR;
1436 mt_com.mt_count = num;
1437 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1440 clrerror_dev(dev, MTBSR);
1441 Mmsg2(dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
1442 dev->print_name(), be.strerror());
1444 update_pos_dev(dev);
1449 * Reposition the device to file, block
1450 * Returns: false on failure
1454 reposition_dev(DEVICE *dev, uint32_t file, uint32_t block)
1457 dev->dev_errno = EBADF;
1458 Mmsg0(dev->errmsg, _("Bad call to reposition_dev. Device not open\n"));
1459 Emsg0(M_FATAL, 0, dev->errmsg);
1463 if (!dev->is_tape()) {
1464 off_t pos = (((off_t)file)<<32) + (off_t)block;
1465 Dmsg1(100, "===== lseek_dev to %d\n", (int)pos);
1466 if (lseek_dev(dev, pos, SEEK_SET) == (off_t)-1) {
1468 dev->dev_errno = errno;
1469 Mmsg2(dev->errmsg, _("lseek_dev error on %s. ERR=%s.\n"),
1470 dev->print_name(), be.strerror());
1474 dev->block_num = block;
1475 dev->file_addr = pos;
1478 Dmsg4(100, "reposition_dev from %u:%u to %u:%u\n",
1479 dev->file, dev->block_num, file, block);
1480 if (file < dev->file) {
1481 Dmsg0(100, "Rewind_dev\n");
1482 if (!rewind_dev(dev)) {
1486 if (file > dev->file) {
1487 Dmsg1(100, "fsf %d\n", file-dev->file);
1488 if (!dev->fsf(file-dev->file)) {
1489 Dmsg1(100, "fsf failed! ERR=%s\n", strerror_dev(dev));
1492 Dmsg2(100, "wanted_file=%d at_file=%d\n", file, dev->file);
1494 if (block < dev->block_num) {
1495 Dmsg2(100, "wanted_blk=%d at_blk=%d\n", block, dev->block_num);
1496 Dmsg0(100, "bsf_dev 1\n");
1498 Dmsg0(100, "fsf_dev 1\n");
1500 Dmsg2(100, "wanted_blk=%d at_blk=%d\n", block, dev->block_num);
1502 if (dev_cap(dev, CAP_POSITIONBLOCKS) && block > dev->block_num) {
1503 /* Ignore errors as Bacula can read to the correct block */
1504 Dmsg1(100, "fsr %d\n", block-dev->block_num);
1505 return dev->fsr(block-dev->block_num);
1513 * Write an end of file on the device
1514 * Returns: 0 on success
1515 * non-zero on failure
1518 weof_dev(DEVICE *dev, int num)
1522 Dmsg0(29, "weof_dev\n");
1525 dev->dev_errno = EBADF;
1526 Mmsg0(dev->errmsg, _("Bad call to weof_dev. Device not open\n"));
1527 Emsg0(M_FATAL, 0, dev->errmsg);
1532 if (!dev->is_tape()) {
1535 if (!dev->can_append()) {
1536 Mmsg0(dev->errmsg, _("Attempt to WEOF on non-appendable Volume\n"));
1537 Emsg0(M_FATAL, 0, dev->errmsg);
1541 dev->state &= ~(ST_EOT | ST_EOF); /* remove EOF/EOT flags */
1542 mt_com.mt_op = MTWEOF;
1543 mt_com.mt_count = num;
1544 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1551 clrerror_dev(dev, MTWEOF);
1553 Mmsg2(dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
1554 dev->print_name(), be.strerror());
1561 * Return string message with last error in English
1562 * Be careful not to call this routine from within dev.c
1563 * while editing an Mmsg() or you will end up in a recursive
1564 * loop creating a Segmentation Violation.
1567 strerror_dev(DEVICE *dev)
1574 * If implemented in system, clear the tape
1578 clrerror_dev(DEVICE *dev, int func)
1580 const char *msg = NULL;
1581 struct mtget mt_stat;
1584 dev->dev_errno = errno; /* save errno */
1586 dev->VolCatInfo.VolCatErrors++;
1589 if (!dev->is_tape()) {
1592 if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
1595 Emsg0(M_ABORT, 0, _("Got ENOTTY on read/write!\n"));
1599 dev->capabilities &= ~CAP_EOF; /* turn off feature */
1604 dev->capabilities &= ~CAP_EOM; /* turn off feature */
1609 dev->capabilities &= ~CAP_FSF; /* turn off feature */
1613 dev->capabilities &= ~CAP_BSF; /* turn off feature */
1617 dev->capabilities &= ~CAP_FSR; /* turn off feature */
1621 dev->capabilities &= ~CAP_BSR; /* turn off feature */
1642 bsnprintf(buf, sizeof(buf), _("unknown func code %d"), func);
1647 dev->dev_errno = ENOSYS;
1648 Mmsg1(dev->errmsg, _("I/O function \"%s\" not supported on this device.\n"), msg);
1649 Emsg0(M_ERROR, 0, dev->errmsg);
1652 /* On some systems such as NetBSD, this clears all errors */
1653 ioctl(dev->fd, MTIOCGET, (char *)&mt_stat);
1655 /* Found on Linux */
1659 mt_com.mt_op = MTIOCLRERR;
1660 mt_com.mt_count = 1;
1661 /* Clear any error condition on the tape */
1662 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1663 Dmsg0(200, "Did MTIOCLRERR\n");
1667 /* Typically on FreeBSD */
1670 /* Read and clear SCSI error status */
1671 union mterrstat mt_errstat;
1672 Dmsg2(200, "Doing MTIOCERRSTAT errno=%d ERR=%s\n", dev->dev_errno,
1673 strerror(dev->dev_errno));
1674 ioctl(dev->fd, MTIOCERRSTAT, (char *)&mt_errstat);
1678 /* Clear Subsystem Exception OSF1 */
1682 mt_com.mt_op = MTCSE;
1683 mt_com.mt_count = 1;
1684 /* Clear any error condition on the tape */
1685 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1686 Dmsg0(200, "Did MTCSE\n");
1692 * Flush buffer contents
1695 int flush_dev(DEVICE *dev)
1700 static void do_close(DEVICE *dev)
1703 Dmsg1(29, "really close_dev %s\n", dev->print_name());
1708 if (!unmount_dev(dev, 1)) {
1709 Dmsg1(0, "Cannot unmount device %s.\n", dev->print_name());
1712 /* Remove the last part file if it is empty */
1713 if (dev->num_parts > 0) {
1715 POOL_MEM archive_name(PM_FNAME);
1716 dev->part = dev->num_parts;
1717 Dmsg1(100, "Call make_dvd_filename. Vol=%s\n", dev->VolCatInfo.VolCatName);
1718 make_spooled_dvd_filename(dev, archive_name);
1719 /* Check that the part file is empty */
1720 if ((stat(archive_name.c_str(), &statp) == 0) && (statp.st_size == 0)) {
1721 Dmsg1(100, "unlink(%s)\n", archive_name.c_str());
1722 unlink(archive_name.c_str());
1726 /* Clean up device packet so it can be reused */
1728 dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1729 dev->label_type = B_BACULA_LABEL;
1730 dev->file = dev->block_num = 0;
1736 dev->part_start = 0;
1737 dev->EndFile = dev->EndBlock = 0;
1738 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
1740 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
1742 stop_thread_timer(dev->tid);
1752 void DEVICE::close()
1754 /*if (fd >= 0 && use_count == 1) {*/
1755 /* No need to check if fd >= 0: it is checked again
1756 * in do_close, and do_close MUST be called for volumes
1757 * splitted in parts, even if fd == -1. */
1758 if (use_count == 1) {
1760 } else if (use_count > 0) {
1765 ASSERT(use_count >= 0);
1770 bool truncate_dev(DCR *dcr) /* We need the DCR for DVD-writing */
1772 DEVICE *dev = dcr->dev;
1774 Dmsg1(100, "truncate_dev %s\n", dev->print_name());
1775 if (dev->is_tape()) {
1776 return true; /* we don't really truncate tapes */
1777 /* maybe we should rewind and write and eof ???? */
1780 if (dev->is_dvd()) {
1781 return truncate_dvd_dev(dcr);
1784 if (ftruncate(dev->fd, 0) != 0) {
1786 Mmsg2(dev->errmsg, _("Unable to truncate device %s. ERR=%s\n"),
1787 dev->print_name(), be.strerror());
1793 /* Return the resource name for the device */
1794 const char *DEVICE::name() const
1796 return device->hdr.name;
1800 dev_vol_name(DEVICE *dev)
1802 return dev->VolCatInfo.VolCatName;
1805 uint32_t dev_block(DEVICE *dev)
1807 update_pos_dev(dev);
1808 return dev->block_num;
1811 uint32_t dev_file(DEVICE *dev)
1813 update_pos_dev(dev);
1818 * Free memory allocated for the device
1821 term_dev(DEVICE *dev)
1824 dev->dev_errno = EBADF;
1825 Mmsg0(dev->errmsg, _("Bad call to term_dev. Device not open\n"));
1826 Emsg0(M_FATAL, 0, dev->errmsg);
1829 Dmsg1(29, "term_dev: %s\n", dev->print_name());
1831 if (dev->dev_name) {
1832 free_memory(dev->dev_name);
1833 dev->dev_name = NULL;
1835 if (dev->prt_name) {
1836 free_memory(dev->prt_name);
1837 dev->prt_name = NULL;
1840 free_pool_memory(dev->errmsg);
1843 pthread_mutex_destroy(&dev->mutex);
1844 pthread_cond_destroy(&dev->wait);
1845 pthread_cond_destroy(&dev->wait_next_vol);
1846 pthread_mutex_destroy(&dev->spool_mutex);
1847 rwl_destroy(&dev->lock);
1848 if (dev->attached_dcrs) {
1849 delete dev->attached_dcrs;
1850 dev->attached_dcrs = NULL;
1852 if (dev->state & ST_MALLOC) {
1853 free_pool_memory((POOLMEM *)dev);
1858 * This routine initializes the device wait timers
1860 void init_device_wait_timers(DCR *dcr)
1862 DEVICE *dev = dcr->dev;
1863 JCR *jcr = dcr->jcr;
1865 /* ******FIXME******* put these on config variables */
1866 dev->min_wait = 60 * 60;
1867 dev->max_wait = 24 * 60 * 60;
1868 dev->max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
1869 dev->wait_sec = dev->min_wait;
1870 dev->rem_wait_sec = dev->wait_sec;
1873 dev->BadVolName[0] = 0;
1875 jcr->min_wait = 60 * 60;
1876 jcr->max_wait = 24 * 60 * 60;
1877 jcr->max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
1878 jcr->wait_sec = jcr->min_wait;
1879 jcr->rem_wait_sec = jcr->wait_sec;
1884 void init_jcr_device_wait_timers(JCR *jcr)
1886 /* ******FIXME******* put these on config variables */
1887 jcr->min_wait = 60 * 60;
1888 jcr->max_wait = 24 * 60 * 60;
1889 jcr->max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
1890 jcr->wait_sec = jcr->min_wait;
1891 jcr->rem_wait_sec = jcr->wait_sec;
1897 * The dev timers are used for waiting on a particular device
1899 * Returns: true if time doubled
1900 * false if max time expired
1902 bool double_dev_wait_time(DEVICE *dev)
1904 dev->wait_sec *= 2; /* double wait time */
1905 if (dev->wait_sec > dev->max_wait) { /* but not longer than maxtime */
1906 dev->wait_sec = dev->max_wait;
1909 dev->rem_wait_sec = dev->wait_sec;
1910 if (dev->num_wait >= dev->max_num_wait) {
1917 void set_os_device_parameters(DEVICE *dev)
1919 #ifdef HAVE_LINUX_OS
1921 if (dev->min_block_size == dev->max_block_size &&
1922 dev->min_block_size == 0) { /* variable block mode */
1923 mt_com.mt_op = MTSETBLK;
1924 mt_com.mt_count = 0;
1925 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1926 clrerror_dev(dev, MTSETBLK);
1928 mt_com.mt_op = MTSETDRVBUFFER;
1929 mt_com.mt_count = MT_ST_CLEARBOOLEANS;
1930 if (!dev_cap(dev, CAP_TWOEOF)) {
1931 mt_com.mt_count |= MT_ST_TWO_FM;
1933 if (dev_cap(dev, CAP_EOM)) {
1934 mt_com.mt_count |= MT_ST_FAST_MTEOM;
1936 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1937 clrerror_dev(dev, MTSETBLK);
1943 #ifdef HAVE_NETBSD_OS
1945 if (dev->min_block_size == dev->max_block_size &&
1946 dev->min_block_size == 0) { /* variable block mode */
1947 mt_com.mt_op = MTSETBSIZ;
1948 mt_com.mt_count = 0;
1949 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1950 clrerror_dev(dev, MTSETBSIZ);
1952 /* Get notified at logical end of tape */
1953 mt_com.mt_op = MTEWARN;
1954 mt_com.mt_count = 1;
1955 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1956 clrerror_dev(dev, MTEWARN);
1962 #if HAVE_FREEBSD_OS || HAVE_OPENBSD_OS
1964 if (dev->min_block_size == dev->max_block_size &&
1965 dev->min_block_size == 0) { /* variable block mode */
1966 mt_com.mt_op = MTSETBSIZ;
1967 mt_com.mt_count = 0;
1968 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1969 clrerror_dev(dev, MTSETBSIZ);
1977 if (dev->min_block_size == dev->max_block_size &&
1978 dev->min_block_size == 0) { /* variable block mode */
1979 mt_com.mt_op = MTSRSZ;
1980 mt_com.mt_count = 0;
1981 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1982 clrerror_dev(dev, MTSRSZ);
1989 static bool dev_get_os_pos(DEVICE *dev, struct mtget *mt_stat)
1991 return dev_cap(dev, CAP_MTIOCGET) &&
1992 ioctl(dev->fd, MTIOCGET, (char *)mt_stat) == 0 &&
1993 mt_stat->mt_fileno >= 0;
1996 static char *modes[] = {
1997 "CREATE_READ_WRITE",
2004 static char *mode_to_str(int mode)
2006 return modes[mode-1];