2 Bacula® - The Network Backup Solution
4 Copyright (C) 2000-2007 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version two of the GNU General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of John Walker.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
30 * dev.c -- low level operations on device (storage device)
34 * NOTE!!!! None of these routines are reentrant. You must
35 * use dev->r_dlock() and dev->unlock() at a higher level,
36 * or use the xxx_device() equivalents. By moving the
37 * thread synchronization to a higher level, we permit
38 * the higher level routines to "seize" the device and
39 * to carry out operations without worrying about who
40 * set what lock (i.e. race conditions).
42 * Note, this is the device dependent code, and may have
43 * to be modified for each system, but is meant to
44 * be as "generic" as possible.
46 * The purpose of this code is to develop a SIMPLE Storage
47 * daemon. More complicated coding (double buffering, writer
48 * thread, ...) is left for a later version.
50 * Unfortunately, I have had to add more and more complication
51 * to this code. This was not foreseen as noted above, and as
52 * a consequence has lead to something more contorted than is
53 * really necessary -- KES. Note, this contortion has been
54 * corrected to a large extent by a rewrite (Apr MMI).
60 * Handling I/O errors and end of tape conditions are a bit tricky.
61 * This is how it is currently done when writting.
62 * On either an I/O error or end of tape,
63 * we will stop writing on the physical device (no I/O recovery is
64 * attempted at least in this daemon). The state flag will be sent
65 * to include ST_EOT, which is ephemeral, and ST_WEOT, which is
66 * persistent. Lots of routines clear ST_EOT, but ST_WEOT is
67 * cleared only when the problem goes away. Now when ST_WEOT
68 * is set all calls to write_block_to_device() call the fix_up
69 * routine. In addition, all threads are blocked
70 * from writing on the tape by calling lock_dev(), and thread other
71 * than the first thread to hit the EOT will block on a condition
72 * variable. The first thread to hit the EOT will continue to
73 * be able to read and write the tape (he sort of tunnels through
74 * the locking mechanism -- see lock_dev() for details).
76 * Now presumably somewhere higher in the chain of command
77 * (device.c), someone will notice the EOT condition and
78 * get a new tape up, get the tape label read, and mark
79 * the label for rewriting. Then this higher level routine
80 * will write the unwritten buffer to the new volume.
81 * Finally, he will release
82 * any blocked threads by doing a broadcast on the condition
83 * variable. At that point, we should be totally back in
84 * business with no lost data.
95 /* Forward referenced functions */
96 void set_os_device_parameters(DCR *dcr);
97 static bool dev_get_os_pos(DEVICE *dev, struct mtget *mt_stat);
98 static char *mode_to_str(int mode);
101 * Allocate and initialize the DEVICE structure
102 * Note, if dev is non-NULL, it is already allocated,
103 * thus we neither allocate it nor free it. This allows
104 * the caller to put the packet in shared memory.
106 * Note, for a tape, the device->device_name is the device name
107 * (e.g. /dev/nst0), and for a file, the device name
108 * is the directory in which the file will be placed.
112 init_dev(JCR *jcr, DEVRES *device)
120 /* If no device type specified, try to guess */
121 if (!device->dev_type) {
122 /* Check that device is available */
123 if (stat(device->device_name, &statp) < 0) {
125 Jmsg2(jcr, M_ERROR, 0, _("Unable to stat device %s: ERR=%s\n"),
126 device->device_name, be.bstrerror());
129 if (S_ISDIR(statp.st_mode)) {
130 device->dev_type = B_FILE_DEV;
131 } else if (S_ISCHR(statp.st_mode)) {
132 device->dev_type = B_TAPE_DEV;
133 } else if (S_ISFIFO(statp.st_mode)) {
134 device->dev_type = B_FIFO_DEV;
135 } else if (!(device->cap_bits & CAP_REQMOUNT)) {
136 Jmsg2(jcr, M_ERROR, 0, _("%s is an unknown device type. Must be tape or directory\n"
137 " or have RequiresMount=yes for DVD. st_mode=%x\n"),
138 device->device_name, statp.st_mode);
141 device->dev_type = B_DVD_DEV;
145 dev = (DEVICE *)malloc(sizeof(DEVICE));
146 memset(dev, 0, sizeof(DEVICE));
147 dev->Slot = -1; /* unknown */
149 /* Copy user supplied device parameters from Resource */
150 dev->dev_name = get_memory(strlen(device->device_name)+1);
151 pm_strcpy(dev->dev_name, device->device_name);
152 dev->prt_name = get_memory(strlen(device->device_name) + strlen(device->hdr.name) + 20);
153 /* We edit "Resource-name" (physical-name) */
154 Mmsg(dev->prt_name, "\"%s\" (%s)", device->hdr.name, device->device_name);
155 Dmsg1(400, "Allocate dev=%s\n", dev->print_name());
156 dev->capabilities = device->cap_bits;
157 dev->min_block_size = device->min_block_size;
158 dev->max_block_size = device->max_block_size;
159 dev->max_volume_size = device->max_volume_size;
160 dev->max_file_size = device->max_file_size;
161 dev->volume_capacity = device->volume_capacity;
162 dev->max_rewind_wait = device->max_rewind_wait;
163 dev->max_open_wait = device->max_open_wait;
164 dev->max_open_vols = device->max_open_vols;
165 dev->vol_poll_interval = device->vol_poll_interval;
166 dev->max_spool_size = device->max_spool_size;
167 dev->drive_index = device->drive_index;
168 dev->autoselect = device->autoselect;
169 dev->dev_type = device->dev_type;
170 if (dev->is_tape()) { /* No parts on tapes */
171 dev->max_part_size = 0;
173 dev->max_part_size = device->max_part_size;
176 if (dev->vol_poll_interval && dev->vol_poll_interval < 60) {
177 dev->vol_poll_interval = 60;
179 /* Link the dev and device structures together */
180 dev->device = device;
183 if (dev->is_fifo()) {
184 dev->capabilities |= CAP_STREAM; /* set stream device */
187 /* If the device requires mount :
188 * - Check that the mount point is available
189 * - Check that (un)mount commands are defined
191 if ((dev->is_file() || dev->is_dvd()) && dev->requires_mount()) {
192 if (!device->mount_point || stat(device->mount_point, &statp) < 0) {
194 dev->dev_errno = errno;
195 Jmsg2(jcr, M_ERROR_TERM, 0, _("Unable to stat mount point %s: ERR=%s\n"),
196 device->mount_point, be.bstrerror());
200 if (!device->mount_command || !device->unmount_command) {
201 Jmsg0(jcr, M_ERROR_TERM, 0, _("Mount and unmount commands must defined for a device which requires mount.\n"));
203 if (!device->write_part_command) {
204 Jmsg0(jcr, M_ERROR_TERM, 0, _("Write part command must be defined for a device which requires mount.\n"));
208 if (dev->max_block_size > 1000000) {
209 Jmsg3(jcr, M_ERROR, 0, _("Block size %u on device %s is too large, using default %u\n"),
210 dev->max_block_size, dev->print_name(), DEFAULT_BLOCK_SIZE);
211 dev->max_block_size = 0;
213 if (dev->max_block_size % TAPE_BSIZE != 0) {
214 Jmsg2(jcr, M_WARNING, 0, _("Max block size %u not multiple of device %s block size.\n"),
215 dev->max_block_size, dev->print_name());
218 dev->errmsg = get_pool_memory(PM_EMSG);
221 if ((errstat = pthread_mutex_init(&dev->m_mutex, NULL)) != 0) {
223 dev->dev_errno = errstat;
224 Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.bstrerror(errstat));
225 Jmsg0(jcr, M_ERROR_TERM, 0, dev->errmsg);
227 if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
229 dev->dev_errno = errstat;
230 Mmsg1(dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), be.bstrerror(errstat));
231 Jmsg0(jcr, M_ERROR_TERM, 0, dev->errmsg);
233 if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
235 dev->dev_errno = errstat;
236 Mmsg1(dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), be.bstrerror(errstat));
237 Jmsg0(jcr, M_ERROR_TERM, 0, dev->errmsg);
239 if ((errstat = pthread_mutex_init(&dev->spool_mutex, NULL)) != 0) {
241 dev->dev_errno = errstat;
242 Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.bstrerror(errstat));
243 Jmsg0(jcr, M_ERROR_TERM, 0, dev->errmsg);
246 if ((errstat = rwl_init(&dev->lock)) != 0) {
248 dev->dev_errno = errstat;
249 Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.bstrerror(errstat));
250 Jmsg0(jcr, M_ERROR_TERM, 0, dev->errmsg);
255 dev->attached_dcrs = New(dlist(dcr, &dcr->dev_link));
256 Dmsg2(100, "init_dev: tape=%d dev_name=%s\n", dev->is_tape(), dev->dev_name);
257 dev->initiated = true;
263 * Open the device with the operating system and
264 * initialize buffer pointers.
266 * Returns: -1 on error
269 * Note, for a tape, the VolName is the name we give to the
270 * volume (not really used here), but for a file, the
271 * VolName represents the name of the file to be created/opened.
272 * In the case of a file, the full name is the device name
273 * (archive_name) with the VolName concatenated.
276 DEVICE::open(DCR *dcr, int omode)
280 if (openmode == omode) {
289 Dmsg0(100, "Close fd for mode change.\n");
290 preserve = state & (ST_LABEL|ST_APPEND|ST_READ);
294 bstrncpy(VolCatInfo.VolCatName, dcr->VolumeName, sizeof(VolCatInfo.VolCatName));
297 Dmsg4(100, "open dev: type=%d dev_name=%s vol=%s mode=%s\n", dev_type,
298 print_name(), VolCatInfo.VolCatName, mode_to_str(omode));
299 state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
300 Slot = -1; /* unknown slot */
301 label_type = B_BACULA_LABEL;
302 if (is_tape() || is_fifo()) {
303 open_tape_device(dcr, omode);
304 } else if (is_dvd()) {
305 Dmsg1(100, "call open_dvd_device mode=%s\n", mode_to_str(omode));
306 open_dvd_device(dcr, omode);
308 Dmsg1(100, "call open_file_device mode=%s\n", mode_to_str(omode));
309 open_file_device(dcr, omode);
311 state |= preserve; /* reset any important state info */
312 Dmsg2(100, "preserve=0x%x fd=%d\n", preserve, m_fd);
316 void DEVICE::set_mode(int new_mode)
319 case CREATE_READ_WRITE:
320 mode = O_CREAT | O_RDWR | O_BINARY;
322 case OPEN_READ_WRITE:
323 mode = O_RDWR | O_BINARY;
326 mode = O_RDONLY | O_BINARY;
328 case OPEN_WRITE_ONLY:
329 mode = O_WRONLY | O_BINARY;
332 Emsg0(M_ABORT, 0, _("Illegal mode given to open dev.\n"));
338 void DEVICE::open_tape_device(DCR *dcr, int omode)
341 int timeout = max_open_wait;
342 #if !defined(HAVE_WIN32)
344 utime_t start_time = time(NULL);
348 Dmsg0(100, "Open dev: device is tape\n");
350 get_autochanger_loaded_slot(dcr);
359 if (is_fifo() && timeout) {
361 tid = start_thread_timer(pthread_self(), timeout);
363 Dmsg2(100, "Try open %s mode=%s\n", print_name(), mode_to_str(omode));
364 #if defined(HAVE_WIN32)
367 if ((m_fd = tape_open(dev_name, mode)) < 0) {
374 /* If busy retry each second for max_open_wait seconds */
376 /* Try non-blocking open */
377 m_fd = ::open(dev_name, mode+O_NONBLOCK);
381 Dmsg5(100, "Open error on %s omode=%d mode=%x errno=%d: ERR=%s\n",
382 print_name(), omode, mode, errno, be.bstrerror());
384 /* Tape open, now rewind it */
385 Dmsg0(100, "Rewind after open\n");
386 mt_com.mt_op = MTREW;
388 /* rewind only if dev is a tape */
389 if (is_tape() && (ioctl(m_fd, MTIOCTOP, (char *)&mt_com) < 0)) {
391 dev_errno = errno; /* set error status from rewind */
394 Dmsg2(100, "Rewind error on %s close: ERR=%s\n", print_name(),
395 be.bstrerror(dev_errno));
396 /* If we get busy, device is probably rewinding, try again */
397 if (dev_errno != EBUSY) {
398 break; /* error -- no medium */
401 /* Got fd and rewind worked, so we must have medium in drive */
403 m_fd = ::open(dev_name, mode); /* open normally */
407 Dmsg5(100, "Open error on %s omode=%d mode=%x errno=%d: ERR=%s\n",
408 print_name(), omode, mode, errno, be.bstrerror());
413 set_os_device_parameters(dcr); /* do system dependent stuff */
414 break; /* Successfully opened and rewound */
418 /* Exceed wait time ? */
419 if (time(NULL) - start_time >= max_open_wait) {
420 break; /* yes, get out */
427 Mmsg2(errmsg, _("Unable to open device %s: ERR=%s\n"),
428 print_name(), be.bstrerror(dev_errno));
429 Dmsg1(100, "%s", errmsg);
432 /* Stop any open() timer we started */
434 stop_thread_timer(tid);
437 Dmsg1(100, "open dev: tape %d opened\n", m_fd);
444 void DEVICE::open_file_device(DCR *dcr, int omode)
446 POOL_MEM archive_name(PM_FNAME);
448 get_autochanger_loaded_slot(dcr);
451 * Handle opening of File Archive (not a tape)
454 pm_strcpy(archive_name, dev_name);
456 * If this is a virtual autochanger (i.e. changer_res != NULL)
457 * we simply use the device name, assuming it has been
458 * appropriately setup by the "autochanger".
460 if (!device->changer_res || device->changer_command[0] == 0) {
461 if (VolCatInfo.VolCatName[0] == 0) {
462 Mmsg(errmsg, _("Could not open file device %s. No Volume name given.\n"),
468 if (!IsPathSeparator(archive_name.c_str()[strlen(archive_name.c_str())-1])) {
469 pm_strcat(archive_name, "/");
471 pm_strcat(archive_name, VolCatInfo.VolCatName);
474 mount(1); /* do mount if required */
478 /* If creating file, give 0640 permissions */
479 Dmsg3(100, "open disk: mode=%s open(%s, 0x%x, 0640)\n", mode_to_str(omode),
480 archive_name.c_str(), mode);
481 /* Use system open() */
482 if ((m_fd = ::open(archive_name.c_str(), mode, 0640)) < 0) {
485 Mmsg2(errmsg, _("Could not open: %s, ERR=%s\n"), archive_name.c_str(),
487 Dmsg1(100, "open failed: %s", errmsg);
488 Emsg0(M_FATAL, 0, errmsg);
494 Dmsg4(100, "open dev: disk fd=%d opened, part=%d/%d, part_size=%u\n",
495 m_fd, part, num_dvd_parts, part_size);
499 * Open a DVD device. N.B. at this point, dcr->VolCatInfo.VolCatName
500 * (NB:??? I think it's VolCatInfo.VolCatName that is right)
501 * has the desired Volume name, but there is NO assurance that
502 * any other field of VolCatInfo is correct.
504 void DEVICE::open_dvd_device(DCR *dcr, int omode)
506 POOL_MEM archive_name(PM_FNAME);
507 struct stat filestat;
510 * Handle opening of DVD Volume
512 Dmsg2(100, "Enter: open_dvd_dev: DVD vol=%s mode=%s\n",
513 &dcr->VolCatInfo, mode_to_str(omode));
516 * For a DVD we must always pull the state info from dcr->VolCatInfo
517 * This is a bit ugly, but is necessary because we need to open/close/re-open
518 * the dvd file in order to properly mount/unmount and access the
519 * DVD. So we store the state of the DVD as far as is known in the
520 * catalog in dcr->VolCatInfo, and thus we refresh the dev->VolCatInfo
521 * copy here, when opening.
523 VolCatInfo = dcr->VolCatInfo; /* structure assignment */
524 Dmsg1(100, "Volume=%s\n", VolCatInfo.VolCatName);
526 if (VolCatInfo.VolCatName[0] == 0) {
527 Dmsg1(10, "Could not open DVD device %s. No Volume name given.\n",
529 Mmsg(errmsg, _("Could not open DVD device %s. No Volume name given.\n"),
536 Dmsg0(100, "Set part=1\n");
537 part = 1; /* count from 1 */
541 if (num_dvd_parts != VolCatInfo.VolCatParts) {
542 num_dvd_parts = VolCatInfo.VolCatParts;
546 * If we are not trying to access the last part, set mode to
547 * OPEN_READ_ONLY as writing would be an error.
549 Dmsg2(100, "open DVD part=%d num_dvd_parts=%d\n", part, num_dvd_parts);
550 /* Now find the name of the part that we want to access */
551 if (part <= num_dvd_parts) {
552 omode = OPEN_READ_ONLY;
553 make_mounted_dvd_filename(this, archive_name);
554 set_part_spooled(false);
556 omode = OPEN_READ_WRITE;
557 make_spooled_dvd_filename(this, archive_name);
558 set_part_spooled(true);
562 // Clear any previous blank_dvd status - we will recalculate it here
565 Dmsg3(99, "open_dvd_device: part=%d num_dvd_parts=%d, VolCatInfo.VolCatParts=%d\n",
566 part, num_dvd_parts, dcr->VolCatInfo.VolCatParts);
569 Dmsg0(99, "DVD device mounted.\n");
570 if (num_dvd_parts == 0 && !truncating) {
572 * If we can mount the device, and we are not truncating the DVD,
573 * we usually want to abort. There is one exception, if there is
574 * only one 0-sized file on the DVD, with the right volume name,
575 * we continue (it's the method used by truncate_dvd to truncate a volume).
577 if (!check_can_write_on_non_blank_dvd(dcr)) {
578 Mmsg(errmsg, _("The DVD in device %s contains data, please blank it before writing.\n"), print_name());
579 Emsg0(M_FATAL, 0, errmsg);
580 unmount(1); /* Unmount the device, so the operator can change it. */
587 * Ensure that we have the correct DVD loaded by looking for part1.
588 * We only succeed the open if it exists. Failure to do this could
589 * leave us trying to add a part to a different DVD!
591 uint32_t oldpart = part;
593 POOL_MEM part1_name(PM_FNAME);
595 make_mounted_dvd_filename(this, part1_name);
597 if (stat(part1_name.c_str(), &statp) < 0) {
599 Mmsg(errmsg, _("Unable to stat DVD part 1 file %s: ERR=%s\n"),
600 part1_name.c_str(), be.bstrerror());
601 Emsg0(M_FATAL, 0, errmsg);
605 if (!S_ISREG(statp.st_mode)) {
606 /* It is not a regular file */
607 Mmsg(errmsg, _("DVD part 1 is not a regular file %s.\n"),
609 Emsg0(M_FATAL, 0, errmsg);
615 Dmsg0(99, "DVD device mount failed.\n");
616 /* We cannot mount the device */
617 if (num_dvd_parts == 0) {
618 /* Run free space, check there is a media. */
619 if (!update_freespace()) {
620 Emsg0(M_FATAL, 0, errmsg);
625 Dmsg1(100, "Could not mount device %s, this is not a problem (num_dvd_parts == 0), and have media.\n", print_name());
627 Mmsg(errmsg, _("There is no valid DVD in device %s.\n"), print_name());
628 Emsg0(M_FATAL, 0, errmsg);
633 Mmsg(errmsg, _("Could not mount DVD device %s.\n"), print_name());
634 Emsg0(M_FATAL, 0, errmsg);
640 Dmsg5(100, "open dev: DVD dev=%s mode=%s part=%d npart=%d volcatnparts=%d\n",
641 archive_name.c_str(), mode_to_str(omode),
642 part, num_dvd_parts, dcr->VolCatInfo.VolCatParts);
644 Dmsg2(100, "openmode=%d %s\n", openmode, mode_to_str(openmode));
647 /* If creating file, give 0640 permissions */
648 Dmsg3(100, "mode=%s open(%s, 0x%x, 0640)\n", mode_to_str(omode),
649 archive_name.c_str(), mode);
650 /* Use system open() */
651 if ((m_fd = ::open(archive_name.c_str(), mode, 0640)) < 0) {
653 Mmsg2(errmsg, _("Could not open: %s, ERR=%s\n"), archive_name.c_str(),
655 // Should this be set if we try the create/open below
656 dev_errno = EIO; /* Interpreted as no device present by acquire.c:acquire_device_for_read(). */
657 Dmsg1(100, "open failed: %s", errmsg);
659 /* Previous open failed. See if we can recover */
660 if ((omode == OPEN_READ_ONLY || omode == OPEN_READ_WRITE) &&
661 (part > num_dvd_parts)) {
662 /* If the last part (on spool), doesn't exist when accessing,
663 * create it. In read/write mode a write will be allowed (higher
664 * level software thinks that we are extending a pre-existing
665 * media. Reads for READ_ONLY will report immediately an EOF
666 * Sometimes it is better to finish with an EOF than with an error. */
667 Dmsg1(100, "Creating last part on spool: %s\n", archive_name.c_str());
668 omode = CREATE_READ_WRITE;
669 set_mode(CREATE_READ_WRITE);
670 m_fd = ::open(archive_name.c_str(), mode, 0640);
674 Dmsg1(100, "after open fd=%d\n", m_fd);
676 if (omode == OPEN_READ_WRITE || omode == CREATE_READ_WRITE) {
679 /* Get size of file */
680 if (fstat(m_fd, &filestat) < 0) {
683 Mmsg2(errmsg, _("Could not fstat: %s, ERR=%s\n"), archive_name.c_str(),
685 Dmsg1(100, "open failed: %s", errmsg);
686 /* Use system close() */
690 part_size = filestat.st_size;
692 update_pos(dcr); /* update position */
700 * Returns: true on success
703 bool DEVICE::rewind(DCR *dcr)
709 Dmsg3(400, "rewind res=%d fd=%d %s\n", reserved_device, m_fd, print_name());
710 state &= ~(ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
711 block_num = file = 0;
715 if (!is_dvd()) { /* In case of major error, the fd is not open on DVD, so we don't want to abort. */
717 Mmsg1(errmsg, _("Bad call to rewind. Device %s not open\n"),
719 Emsg0(M_ABORT, 0, errmsg);
724 mt_com.mt_op = MTREW;
726 /* If we get an I/O error on rewind, it is probably because
727 * the drive is actually busy. We loop for (about 5 minutes)
728 * retrying every 5 seconds.
730 for (i=max_rewind_wait; ; i -= 5) {
731 if (tape_ioctl(m_fd, MTIOCTOP, (char *)&mt_com) < 0) {
734 if (i == max_rewind_wait) {
735 Dmsg1(200, "Rewind error, %s. retrying ...\n", be.bstrerror());
738 * This is a gross hack, because if the user has the
739 * device mounted (i.e. open), then uses mtx to load
740 * a tape, the current open file descriptor is invalid.
741 * So, we close the drive and re-open it.
744 int open_mode = openmode;
747 open(dcr, open_mode);
755 if (dev_errno == EIO) {
756 Mmsg1(errmsg, _("No tape loaded or drive offline on %s.\n"), print_name());
760 if (dev_errno == EIO && i > 0) {
761 Dmsg0(200, "Sleeping 5 seconds.\n");
766 Mmsg2(errmsg, _("Rewind error on %s. ERR=%s.\n"),
767 print_name(), be.bstrerror());
772 } else if (is_file() || is_dvd()) {
773 if (lseek(dcr, (boffset_t)0, SEEK_SET) < 0) {
776 Mmsg2(errmsg, _("lseek error on %s. ERR=%s.\n"),
777 print_name(), be.bstrerror());
786 * Called to indicate that we have just read an
787 * EOF from the device.
789 void DEVICE::set_ateof()
801 * Called to indicate we are now at the end of the tape, and
802 * writing is not possible.
804 void DEVICE::set_ateot()
806 /* Make tape effectively read-only */
807 state |= (ST_EOF|ST_EOT|ST_WEOT);
812 * Position device to end of medium (end of data)
813 * Returns: true on succes
816 bool DEVICE::eod(DCR *dcr)
825 Mmsg1(errmsg, _("Bad call to eod. Device %s not open\n"), print_name());
829 #if defined (__digital__) && defined (__unix__)
830 return fsf(VolCatInfo.VolCatFiles);
837 clear_eof(); /* remove EOF flag */
838 block_num = file = 0;
841 if (is_fifo() || is_prog()) {
845 pos = lseek(dcr, (boffset_t)0, SEEK_END);
846 // Dmsg1(100, "====== Seek to %lld\n", pos);
854 Mmsg2(errmsg, _("lseek error on %s. ERR=%s.\n"),
855 print_name(), be.bstrerror());
859 if (has_cap(CAP_FASTFSF) && !has_cap(CAP_EOM)) {
860 Dmsg0(100,"Using FAST FSF for EOM\n");
861 /* If unknown position, rewind */
862 if (get_os_tape_file() < 0) {
867 mt_com.mt_op = MTFSF;
869 * ***FIXME*** fix code to handle case that INT16_MAX is
872 mt_com.mt_count = INT16_MAX; /* use big positive number */
873 if (mt_com.mt_count < 0) {
874 mt_com.mt_count = INT16_MAX; /* brain damaged system */
878 if (has_cap(CAP_MTIOCGET) && (has_cap(CAP_FASTFSF) || has_cap(CAP_EOM))) {
879 if (has_cap(CAP_EOM)) {
880 Dmsg0(100,"Using EOM for EOM\n");
881 mt_com.mt_op = MTEOM;
885 if (tape_ioctl(m_fd, MTIOCTOP, (char *)&mt_com) < 0) {
887 clrerror(mt_com.mt_op);
888 Dmsg1(50, "ioctl error: %s\n", be.bstrerror());
890 Mmsg2(errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
891 print_name(), be.bstrerror());
895 os_file = get_os_tape_file();
899 Mmsg2(errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
900 print_name(), be.bstrerror());
903 Dmsg1(100, "EOD file=%d\n", os_file);
911 * Rewind then use FSF until EOT reached
917 * Move file by file to the end of the tape
920 for (file_num=file; !at_eot(); file_num++) {
921 Dmsg0(200, "eod: doing fsf 1\n");
923 Dmsg0(200, "fsf error.\n");
927 * Avoid infinite loop by ensuring we advance.
929 if (!at_eot() && file_num == (int)file) {
930 Dmsg1(100, "fsf did not advance from file %d\n", file_num);
932 os_file = get_os_tape_file();
934 Dmsg2(100, "Adjust file from %d to %d\n", file_num, os_file);
942 * Some drivers leave us after second EOF when doing
943 * MTEOM, so we must backup so that appending overwrites
946 if (has_cap(CAP_BSFATEOM)) {
947 /* Backup over EOF */
949 /* If BSF worked and fileno is known (not -1), set file */
950 os_file = get_os_tape_file();
952 Dmsg2(100, "BSFATEOF adjust file from %d to %d\n", file , os_file);
955 file++; /* wing it -- not correct on all OSes */
958 update_pos(dcr); /* update position */
960 Dmsg1(200, "EOD dev->file=%d\n", file);
965 * Set the position of the device -- only for files and DVD
966 * For other devices, there is no generic way to do it.
967 * Returns: true on succes
970 bool DEVICE::update_pos(DCR *dcr)
977 Mmsg0(errmsg, _("Bad device call. Device not open\n"));
978 Emsg1(M_FATAL, 0, "%s", errmsg);
982 /* Find out where we are */
983 if (is_file() || is_dvd()) {
986 pos = lseek(dcr, (boffset_t)0, SEEK_CUR);
990 Pmsg1(000, _("Seek error: ERR=%s\n"), be.bstrerror());
991 Mmsg2(errmsg, _("lseek error on %s. ERR=%s.\n"),
992 print_name(), be.bstrerror());
996 block_num = (uint32_t)pos;
997 file = (uint32_t)(pos >> 32);
1004 * Return the status of the device. This was meant
1005 * to be a generic routine. Unfortunately, it doesn't
1006 * seem possible (at least I do not know how to do it
1007 * currently), which means that for the moment, this
1008 * routine has very little value.
1012 uint32_t status_dev(DEVICE *dev)
1014 struct mtget mt_stat;
1017 if (dev->state & (ST_EOT | ST_WEOT)) {
1021 if (dev->state & ST_EOF) {
1025 if (dev->is_tape()) {
1027 Pmsg0(-20,_(" Bacula status:"));
1028 Pmsg2(-20,_(" file=%d block=%d\n"), dev->file, dev->block_num);
1029 if (tape_ioctl(dev->fd(), MTIOCGET, (char *)&mt_stat) < 0) {
1031 dev->dev_errno = errno;
1032 Mmsg2(dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
1033 dev->print_name(), be.bstrerror());
1036 Pmsg0(-20, _(" Device status:"));
1038 #if defined(HAVE_LINUX_OS)
1039 if (GMT_EOF(mt_stat.mt_gstat)) {
1043 if (GMT_BOT(mt_stat.mt_gstat)) {
1047 if (GMT_EOT(mt_stat.mt_gstat)) {
1051 if (GMT_SM(mt_stat.mt_gstat)) {
1055 if (GMT_EOD(mt_stat.mt_gstat)) {
1059 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
1060 stat |= BMT_WR_PROT;
1061 Pmsg0(-20, " WR_PROT");
1063 if (GMT_ONLINE(mt_stat.mt_gstat)) {
1065 Pmsg0(-20, " ONLINE");
1067 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
1068 stat |= BMT_DR_OPEN;
1069 Pmsg0(-20, " DR_OPEN");
1071 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
1072 stat |= BMT_IM_REP_EN;
1073 Pmsg0(-20, " IM_REP_EN");
1075 #elif defined(HAVE_WIN32)
1076 if (GMT_EOF(mt_stat.mt_gstat)) {
1080 if (GMT_BOT(mt_stat.mt_gstat)) {
1084 if (GMT_EOT(mt_stat.mt_gstat)) {
1088 if (GMT_EOD(mt_stat.mt_gstat)) {
1092 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
1093 stat |= BMT_WR_PROT;
1094 Pmsg0(-20, " WR_PROT");
1096 if (GMT_ONLINE(mt_stat.mt_gstat)) {
1098 Pmsg0(-20, " ONLINE");
1100 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
1101 stat |= BMT_DR_OPEN;
1102 Pmsg0(-20, " DR_OPEN");
1104 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
1105 stat |= BMT_IM_REP_EN;
1106 Pmsg0(-20, " IM_REP_EN");
1109 #endif /* !SunOS && !OSF */
1110 if (dev->has_cap(CAP_MTIOCGET)) {
1111 Pmsg2(-20, _(" file=%d block=%d\n"), mt_stat.mt_fileno, mt_stat.mt_blkno);
1113 Pmsg2(-20, _(" file=%d block=%d\n"), -1, -1);
1116 stat |= BMT_ONLINE | BMT_BOT;
1123 * Load medium in device
1124 * Returns: true on success
1127 bool load_dev(DEVICE *dev)
1133 if (dev->fd() < 0) {
1134 dev->dev_errno = EBADF;
1135 Mmsg0(dev->errmsg, _("Bad call to load_dev. Device not open\n"));
1136 Emsg0(M_FATAL, 0, dev->errmsg);
1139 if (!(dev->is_tape())) {
1143 Dmsg0(200, "stored: MTLOAD command not available\n");
1145 dev->dev_errno = ENOTTY; /* function not available */
1146 Mmsg2(dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
1147 dev->print_name(), be.bstrerror());
1151 dev->block_num = dev->file = 0;
1154 mt_com.mt_op = MTLOAD;
1155 mt_com.mt_count = 1;
1156 if (tape_ioctl(dev->fd(), MTIOCTOP, (char *)&mt_com) < 0) {
1158 dev->dev_errno = errno;
1159 Mmsg2(dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
1160 dev->print_name(), be.bstrerror());
1168 * Rewind device and put it offline
1169 * Returns: true on success
1172 bool DEVICE::offline()
1177 return true; /* device not open */
1180 state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
1181 block_num = file = 0;
1185 mt_com.mt_op = MTOFFL;
1186 mt_com.mt_count = 1;
1187 if (tape_ioctl(m_fd, MTIOCTOP, (char *)&mt_com) < 0) {
1190 Mmsg2(errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
1191 print_name(), be.bstrerror());
1194 Dmsg1(100, "Offlined device %s\n", print_name());
1198 bool DEVICE::offline_or_rewind()
1203 if (has_cap(CAP_OFFLINEUNMOUNT)) {
1207 * Note, this rewind probably should not be here (it wasn't
1208 * in prior versions of Bacula), but on FreeBSD, this is
1209 * needed in the case the tape was "frozen" due to an error
1210 * such as backspacing after writing and EOF. If it is not
1211 * done, all future references to the drive get and I/O error.
1214 return rewind(NULL);
1219 * Foward space a file
1220 * Returns: true on success
1223 bool DEVICE::fsf(int num)
1225 int32_t os_file = 0;
1231 Mmsg0(errmsg, _("Bad call to fsf. Device not open\n"));
1232 Emsg0(M_FATAL, 0, errmsg);
1242 Mmsg1(errmsg, _("Device %s at End of Tape.\n"), print_name());
1246 Dmsg0(200, "ST_EOF set on entry to FSF\n");
1249 Dmsg0(100, "fsf\n");
1252 * If Fast forward space file is set, then we
1253 * use MTFSF to forward space and MTIOCGET
1254 * to get the file position. We assume that
1255 * the SCSI driver will ensure that we do not
1256 * forward space past the end of the medium.
1258 if (has_cap(CAP_FSF) && has_cap(CAP_MTIOCGET) && has_cap(CAP_FASTFSF)) {
1260 mt_com.mt_op = MTFSF;
1261 mt_com.mt_count = num;
1262 stat = tape_ioctl(m_fd, MTIOCTOP, (char *)&mt_com);
1264 my_errno = errno; /* save errno */
1265 } else if ((os_file=get_os_tape_file()) < 0) {
1266 my_errno = errno; /* save errno */
1268 if (my_errno != 0) {
1271 Dmsg0(200, "Set ST_EOT\n");
1273 Mmsg2(errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
1274 print_name(), be.bstrerror(my_errno));
1275 Dmsg1(200, "%s", errmsg);
1279 Dmsg1(200, "fsf file=%d\n", os_file);
1285 * Here if CAP_FSF is set, and virtually all drives
1286 * these days support it, we read a record, then forward
1287 * space one file. Using this procedure, which is slow,
1288 * is the only way we can be sure that we don't read
1289 * two consecutive EOF marks, which means End of Data.
1291 } else if (has_cap(CAP_FSF)) {
1294 Dmsg0(200, "FSF has cap_fsf\n");
1295 if (max_block_size == 0) {
1296 rbuf_len = DEFAULT_BLOCK_SIZE;
1298 rbuf_len = max_block_size;
1300 rbuf = get_memory(rbuf_len);
1301 mt_com.mt_op = MTFSF;
1302 mt_com.mt_count = 1;
1303 while (num-- && !at_eot()) {
1304 Dmsg0(100, "Doing read before fsf\n");
1305 if ((stat = this->read((char *)rbuf, rbuf_len)) < 0) {
1306 if (errno == ENOMEM) { /* tape record exceeds buf len */
1307 stat = rbuf_len; /* This is OK */
1309 * On IBM drives, they return ENOSPC at EOM
1310 * instead of EOF status
1312 } else if (at_eof() && errno == ENOSPC) {
1318 Dmsg2(100, "Set ST_EOT read errno=%d. ERR=%s\n", dev_errno,
1320 Mmsg2(errmsg, _("read error on %s. ERR=%s.\n"),
1321 print_name(), be.bstrerror());
1322 Dmsg1(100, "%s", errmsg);
1326 if (stat == 0) { /* EOF */
1327 Dmsg1(100, "End of File mark from read. File=%d\n", file+1);
1328 /* Two reads of zero means end of tape */
1331 Dmsg0(100, "Set ST_EOT\n");
1337 } else { /* Got data */
1342 Dmsg0(100, "Doing MTFSF\n");
1343 stat = tape_ioctl(m_fd, MTIOCTOP, (char *)&mt_com);
1344 if (stat < 0) { /* error => EOT */
1347 Dmsg0(100, "Set ST_EOT\n");
1349 Mmsg2(errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
1350 print_name(), be.bstrerror());
1351 Dmsg0(100, "Got < 0 for MTFSF\n");
1352 Dmsg1(100, "%s", errmsg);
1360 * No FSF, so use FSR to simulate it
1363 Dmsg0(200, "Doing FSR for FSF\n");
1364 while (num-- && !at_eot()) {
1365 fsr(INT32_MAX); /* returns -1 on EOF or EOT */
1369 Mmsg1(errmsg, _("Device %s at End of Tape.\n"), print_name());
1375 Dmsg1(200, "Return %d from FSF\n", stat);
1377 Dmsg0(200, "ST_EOF set on exit FSF\n");
1380 Dmsg0(200, "ST_EOT set on exit FSF\n");
1382 Dmsg1(200, "Return from FSF file=%d\n", file);
1387 * Backward space a file
1388 * Returns: false on failure
1391 bool DEVICE::bsf(int num)
1398 Mmsg0(errmsg, _("Bad call to bsf. Device not open\n"));
1399 Emsg0(M_FATAL, 0, errmsg);
1404 Mmsg1(errmsg, _("Device %s cannot BSF because it is not a tape.\n"),
1409 Dmsg0(100, "bsf\n");
1415 mt_com.mt_op = MTBSF;
1416 mt_com.mt_count = num;
1417 stat = tape_ioctl(m_fd, MTIOCTOP, (char *)&mt_com);
1421 Mmsg2(errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
1422 print_name(), be.bstrerror());
1429 * Foward space num records
1430 * Returns: false on failure
1433 bool DEVICE::fsr(int num)
1440 Mmsg0(errmsg, _("Bad call to fsr. Device not open\n"));
1441 Emsg0(M_FATAL, 0, errmsg);
1449 if (!has_cap(CAP_FSR)) {
1450 Mmsg1(errmsg, _("ioctl MTFSR not permitted on %s.\n"), print_name());
1454 Dmsg1(100, "fsr %d\n", num);
1455 mt_com.mt_op = MTFSR;
1456 mt_com.mt_count = num;
1457 stat = tape_ioctl(m_fd, MTIOCTOP, (char *)&mt_com);
1463 struct mtget mt_stat;
1465 Dmsg1(100, "FSF fail: ERR=%s\n", be.bstrerror());
1466 if (dev_get_os_pos(this, &mt_stat)) {
1467 Dmsg4(100, "Adjust from %d:%d to %d:%d\n", file,
1468 block_num, mt_stat.mt_fileno, mt_stat.mt_blkno);
1469 file = mt_stat.mt_fileno;
1470 block_num = mt_stat.mt_blkno;
1478 Mmsg3(errmsg, _("ioctl MTFSR %d error on %s. ERR=%s.\n"),
1479 num, print_name(), be.bstrerror());
1485 * Backward space a record
1486 * Returns: false on failure
1489 bool DEVICE::bsr(int num)
1496 Mmsg0(errmsg, _("Bad call to bsr_dev. Device not open\n"));
1497 Emsg0(M_FATAL, 0, errmsg);
1505 if (!has_cap(CAP_BSR)) {
1506 Mmsg1(errmsg, _("ioctl MTBSR not permitted on %s.\n"), print_name());
1510 Dmsg0(100, "bsr_dev\n");
1514 mt_com.mt_op = MTBSR;
1515 mt_com.mt_count = num;
1516 stat = tape_ioctl(m_fd, MTIOCTOP, (char *)&mt_com);
1520 Mmsg2(errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
1521 print_name(), be.bstrerror());
1526 void DEVICE::lock_door()
1530 mt_com.mt_op = MTLOCK;
1531 mt_com.mt_count = 1;
1532 tape_ioctl(m_fd, MTIOCTOP, (char *)&mt_com);
1536 void DEVICE::unlock_door()
1540 mt_com.mt_op = MTUNLOCK;
1541 mt_com.mt_count = 1;
1542 tape_ioctl(m_fd, MTIOCTOP, (char *)&mt_com);
1548 * Reposition the device to file, block
1549 * Returns: false on failure
1552 bool DEVICE::reposition(DCR *dcr, uint32_t rfile, uint32_t rblock)
1556 Mmsg0(errmsg, _("Bad call to reposition. Device not open\n"));
1557 Emsg0(M_FATAL, 0, errmsg);
1562 boffset_t pos = (((boffset_t)rfile)<<32) | rblock;
1563 Dmsg1(100, "===== lseek to %d\n", (int)pos);
1564 if (lseek(dcr, pos, SEEK_SET) == (boffset_t)-1) {
1567 Mmsg2(errmsg, _("lseek error on %s. ERR=%s.\n"),
1568 print_name(), be.bstrerror());
1577 /* After this point, we are tape only */
1578 Dmsg4(100, "reposition from %u:%u to %u:%u\n", file, block_num, rfile, rblock);
1580 Dmsg0(100, "Rewind\n");
1581 if (!rewind(NULL)) {
1586 Dmsg1(100, "fsf %d\n", rfile-file);
1587 if (!fsf(rfile-file)) {
1588 Dmsg1(100, "fsf failed! ERR=%s\n", bstrerror());
1591 Dmsg2(100, "wanted_file=%d at_file=%d\n", rfile, file);
1593 if (rblock < block_num) {
1594 Dmsg2(100, "wanted_blk=%d at_blk=%d\n", rblock, block_num);
1595 Dmsg0(100, "bsf 1\n");
1597 Dmsg0(100, "fsf 1\n");
1599 Dmsg2(100, "wanted_blk=%d at_blk=%d\n", rblock, block_num);
1601 if (has_cap(CAP_POSITIONBLOCKS) && rblock > block_num) {
1602 /* Ignore errors as Bacula can read to the correct block */
1603 Dmsg1(100, "fsr %d\n", rblock-block_num);
1604 return fsr(rblock-block_num);
1606 while (rblock > block_num) {
1607 if (!read_block_from_dev(dcr, NO_BLOCK_NUMBER_CHECK)) {
1610 Dmsg2(30, "Failed to find requested block on %s: ERR=%s",
1611 print_name(), be.bstrerror());
1614 Dmsg2(300, "moving forward wanted_blk=%d at_blk=%d\n", rblock, block_num);
1623 * Write an end of file on the device
1624 * Returns: true on success
1627 bool DEVICE::weof(int num)
1631 Dmsg0(129, "weof_dev\n");
1635 Mmsg0(errmsg, _("Bad call to weof_dev. Device not open\n"));
1636 Emsg0(M_FATAL, 0, errmsg);
1644 if (!can_append()) {
1645 Mmsg0(errmsg, _("Attempt to WEOF on non-appendable Volume\n"));
1646 Emsg0(M_FATAL, 0, errmsg);
1652 mt_com.mt_op = MTWEOF;
1653 mt_com.mt_count = num;
1654 stat = tape_ioctl(m_fd, MTIOCTOP, (char *)&mt_com);
1663 Mmsg2(errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
1664 print_name(), be.bstrerror());
1672 * If implemented in system, clear the tape
1675 void DEVICE::clrerror(int func)
1677 const char *msg = NULL;
1680 dev_errno = errno; /* save errno */
1682 VolCatInfo.VolCatErrors++;
1689 if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
1692 break; /* ignore message printed later */
1695 clear_cap(CAP_EOF); /* turn off feature */
1700 clear_cap(CAP_EOM); /* turn off feature */
1705 clear_cap(CAP_FSF); /* turn off feature */
1709 clear_cap(CAP_BSF); /* turn off feature */
1713 clear_cap(CAP_FSR); /* turn off feature */
1717 clear_cap(CAP_BSR); /* turn off feature */
1727 #ifdef MTSETDRVBUFFER
1728 case MTSETDRVBUFFER:
1729 msg = "MTSETDRVBUFFER";
1762 bsnprintf(buf, sizeof(buf), _("unknown func code %d"), func);
1768 Mmsg1(errmsg, _("I/O function \"%s\" not supported on this device.\n"), msg);
1769 Emsg0(M_ERROR, 0, errmsg);
1774 * Now we try different methods of clearing the error
1775 * status on the drive so that it is not locked for
1776 * further operations.
1779 /* On some systems such as NetBSD, this clears all errors */
1782 /* Found on Solaris */
1785 tape_ioctl(m_fd, MTIOCLRERR);
1786 Dmsg0(200, "Did MTIOCLRERR\n");
1790 /* Typically on FreeBSD */
1794 /* Read and clear SCSI error status */
1795 union mterrstat mt_errstat;
1796 Dmsg2(200, "Doing MTIOCERRSTAT errno=%d ERR=%s\n", dev_errno,
1797 be.bstrerror(dev_errno));
1798 tape_ioctl(m_fd, MTIOCERRSTAT, (char *)&mt_errstat);
1802 /* Clear Subsystem Exception OSF1 */
1806 mt_com.mt_op = MTCSE;
1807 mt_com.mt_count = 1;
1808 /* Clear any error condition on the tape */
1809 tape_ioctl(m_fd, MTIOCTOP, (char *)&mt_com);
1810 Dmsg0(200, "Did MTCSE\n");
1817 * Clear volume header
1819 void DEVICE::clear_volhdr()
1821 Dmsg1(100, "Clear volhdr vol=%s\n", VolHdr.VolumeName);
1822 memset(&VolHdr, 0, sizeof(VolHdr));
1829 void DEVICE::close()
1831 Dmsg1(100, "close_dev %s\n", print_name());
1832 if (has_cap(CAP_OFFLINEUNMOUNT)) {
1837 Dmsg2(100, "device %s already closed vol=%s\n", print_name(),
1839 return; /* already closed */
1851 /* Clean up device packet so it can be reused */
1853 state &= ~(ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
1854 label_type = B_BACULA_LABEL;
1855 file = block_num = 0;
1858 EndFile = EndBlock = 0;
1860 Slot = -1; /* unknown slot */
1862 memset(&VolCatInfo, 0, sizeof(VolCatInfo));
1864 stop_thread_timer(tid);
1870 * This call closes the device, but it is used in DVD handling
1871 * where we close one part and then open the next part. The
1872 * difference between close_part() and close() is that close_part()
1873 * saves the state information of the device (e.g. the Volume lable,
1874 * the Volume Catalog record, ... This permits opening and closing
1875 * the Volume parts multiple times without losing track of what the
1876 * main Volume parameters are.
1878 void DEVICE::close_part(DCR *dcr)
1880 VOLUME_LABEL saveVolHdr;
1881 VOLUME_CAT_INFO saveVolCatInfo; /* Volume Catalog Information */
1884 saveVolHdr = VolHdr; /* structure assignment */
1885 saveVolCatInfo = VolCatInfo; /* structure assignment */
1886 close(); /* close current part */
1887 VolHdr = saveVolHdr; /* structure assignment */
1888 VolCatInfo = saveVolCatInfo; /* structure assignment */
1889 dcr->VolCatInfo = saveVolCatInfo; /* structure assignment */
1892 boffset_t DEVICE::lseek(DCR *dcr, boffset_t offset, int whence)
1896 return lseek_dvd(dcr, offset, whence);
1898 #if defined(HAVE_WIN32)
1899 return ::_lseeki64(m_fd, (__int64)offset, whence);
1901 return ::lseek(m_fd, (off_t)offset, whence);
1908 bool DEVICE::truncate(DCR *dcr) /* We need the DCR for DVD-writing */
1910 Dmsg1(100, "truncate %s\n", print_name());
1913 /* maybe we should rewind and write and eof ???? */
1914 return true; /* we don't really truncate tapes */
1916 return truncate_dvd(dcr);
1918 /* ***FIXME*** we really need to unlink() the file so that
1919 * its name can be changed for a relabel.
1921 if (ftruncate(m_fd, 0) != 0) {
1923 Mmsg2(errmsg, _("Unable to truncate device %s. ERR=%s\n"),
1924 print_name(), be.bstrerror());
1932 /* Mount the device.
1933 * If timeout, wait until the mount command returns 0.
1934 * If !timeout, try to mount the device only once.
1936 bool DEVICE::mount(int timeout)
1938 Dmsg0(190, "Enter mount\n");
1941 } else if (requires_mount()) {
1942 return do_mount(1, timeout);
1947 /* Unmount the device
1948 * If timeout, wait until the unmount command returns 0.
1949 * If !timeout, try to unmount the device only once.
1951 bool DEVICE::unmount(int timeout)
1953 Dmsg0(100, "Enter unmount\n");
1955 return do_mount(0, timeout);
1960 /* (Un)mount the device */
1961 bool DEVICE::do_mount(int mount, int dotimeout)
1963 POOL_MEM ocmd(PM_FNAME);
1966 int status, timeout;
1971 Dmsg0(200, "======= mount=1\n");
1974 icmd = device->mount_command;
1976 if (!is_mounted()) {
1977 Dmsg0(200, "======= mount=0\n");
1980 icmd = device->unmount_command;
1983 clear_freespace_ok();
1984 edit_mount_codes(ocmd, icmd);
1986 Dmsg2(100, "do_mount: cmd=%s mounted=%d\n", ocmd.c_str(), !!is_mounted());
1989 /* Try at most 1 time to (un)mount the device. This should perhaps be configurable. */
1994 results = get_memory(4000);
1997 /* If busy retry each second */
1998 Dmsg1(100, "do_mount run_prog=%s\n", ocmd.c_str());
1999 while ((status = run_program_full_output(ocmd.c_str(),
2000 max_open_wait/2, results)) != 0) {
2001 /* Doesn't work with internationalization (This is not a problem) */
2002 if (mount && fnmatch("*is already mounted on*", results, 0) == 0) {
2005 if (!mount && fnmatch("* not mounted*", results, 0) == 0) {
2008 if (timeout-- > 0) {
2009 /* Sometimes the device cannot be mounted because it is already mounted.
2010 * Try to unmount it, then remount it */
2012 Dmsg1(400, "Trying to unmount the device %s...\n", print_name());
2020 Dmsg5(100, "Device %s cannot be %smounted. stat=%d result=%s ERR=%s\n", print_name(),
2021 (mount ? "" : "un"), status, results, be.bstrerror(status));
2022 Mmsg(errmsg, _("Device %s cannot be %smounted. ERR=%s\n"),
2023 print_name(), (mount ? "" : "un"), be.bstrerror(status));
2025 Dmsg4(100, "Device %s cannot be %smounted. stat=%d ERR=%s\n", print_name(),
2026 (mount ? "" : "un"), status, results);
2027 Mmsg(errmsg, _("Device %s cannot be %smounted. ERR=%s\n"),
2028 print_name(), (mount ? "" : "un"), results);
2031 * Now, just to be sure it is not mounted, try to read the
2035 struct dirent *entry, *result;
2039 name_max = pathconf(".", _PC_NAME_MAX);
2040 if (name_max < 1024) {
2044 if (!(dp = opendir(device->mount_point))) {
2047 Dmsg3(100, "do_mount: failed to open dir %s (dev=%s), ERR=%s\n",
2048 device->mount_point, print_name(), be.bstrerror());
2052 entry = (struct dirent *)malloc(sizeof(struct dirent) + name_max + 1000);
2055 if ((readdir_r(dp, entry, &result) != 0) || (result == NULL)) {
2057 Dmsg2(129, "do_mount: failed to find suitable file in dir %s (dev=%s)\n",
2058 device->mount_point, print_name());
2061 if ((strcmp(result->d_name, ".")) && (strcmp(result->d_name, "..")) && (strcmp(result->d_name, ".keep"))) {
2062 count++; /* result->d_name != ., .. or .keep (Gentoo-specific) */
2065 Dmsg2(129, "do_mount: ignoring %s in %s\n", result->d_name, device->mount_point);
2071 Dmsg1(100, "do_mount: got %d files in the mount point (not counting ., .. and .keep)\n", count);
2074 /* If we got more than ., .. and .keep */
2075 /* there must be something mounted */
2077 Dmsg1(100, "Did Mount by count=%d\n", count);
2080 /* An unmount request. We failed to unmount - report an error */
2082 free_pool_memory(results);
2083 Dmsg0(200, "== error mount=1 wanted unmount\n");
2089 free_pool_memory(results);
2090 Dmsg0(200, "============ mount=0\n");
2095 set_mounted(mount); /* set/clear mounted flag */
2096 free_pool_memory(results);
2097 /* Do not check free space when unmounting */
2098 if (mount && !update_freespace()) {
2101 Dmsg1(200, "============ mount=%d\n", mount);
2106 * Edit codes into (Un)MountCommand, Write(First)PartCommand
2108 * %a = archive device name
2109 * %e = erase (set if cannot mount and first part)
2112 * %v = last part name
2114 * omsg = edited output message
2115 * imsg = input string containing edit codes (%x)
2118 void DEVICE::edit_mount_codes(POOL_MEM &omsg, const char *imsg)
2124 POOL_MEM archive_name(PM_FNAME);
2126 omsg.c_str()[0] = 0;
2127 Dmsg1(800, "edit_mount_codes: %s\n", imsg);
2128 for (p=imsg; *p; p++) {
2138 if (num_dvd_parts == 0) {
2139 if (truncating || blank_dvd) {
2149 bsnprintf(add, sizeof(add), "%d", part);
2153 str = device->mount_point;
2156 make_spooled_dvd_filename(this, archive_name);
2157 str = archive_name.c_str();
2171 Dmsg1(1900, "add_str %s\n", str);
2172 pm_strcat(omsg, (char *)str);
2173 Dmsg1(1800, "omsg=%s\n", omsg.c_str());
2177 /* return the last timer interval (ms) */
2178 btime_t DEVICE::get_timer_count()
2180 btime_t old = last_timer;
2181 last_timer = get_current_btime();
2182 return last_timer - old;
2186 ssize_t DEVICE::read(void *buf, size_t len)
2192 if (this->is_tape()) {
2193 read_len = tape_read(m_fd, buf, len);
2195 read_len = ::read(m_fd, buf, len);
2198 last_tick = get_timer_count();
2200 DevReadTime += last_tick;
2201 VolCatInfo.VolReadTime += last_tick;
2203 if (read_len > 0) { /* skip error */
2204 DevReadBytes += read_len;
2211 ssize_t DEVICE::write(const void *buf, size_t len)
2217 if (this->is_tape()) {
2218 write_len = tape_write(m_fd, buf, len);
2220 write_len = ::write(m_fd, buf, len);
2223 last_tick = get_timer_count();
2225 DevWriteTime += last_tick;
2226 VolCatInfo.VolWriteTime += last_tick;
2228 if (write_len > 0) { /* skip error */
2229 DevWriteBytes += write_len;
2235 /* Return the resource name for the device */
2236 const char *DEVICE::name() const
2238 return device->hdr.name;
2241 /* Returns file position on tape or -1 */
2242 int32_t DEVICE::get_os_tape_file()
2244 struct mtget mt_stat;
2246 if (has_cap(CAP_MTIOCGET) &&
2247 tape_ioctl(m_fd, MTIOCGET, (char *)&mt_stat) == 0) {
2248 return mt_stat.mt_fileno;
2254 dev_vol_name(DEVICE *dev)
2256 return dev->VolCatInfo.VolCatName;
2261 * Free memory allocated for the device
2263 void DEVICE::term(void)
2265 Dmsg1(900, "term dev: %s\n", print_name());
2268 free_memory(dev_name);
2272 free_memory(prt_name);
2276 free_pool_memory(errmsg);
2279 pthread_mutex_destroy(&m_mutex);
2280 pthread_cond_destroy(&wait);
2281 pthread_cond_destroy(&wait_next_vol);
2282 pthread_mutex_destroy(&spool_mutex);
2283 // rwl_destroy(&lock);
2284 if (attached_dcrs) {
2285 delete attached_dcrs;
2286 attached_dcrs = NULL;
2295 * This routine initializes the device wait timers
2297 void init_device_wait_timers(DCR *dcr)
2299 DEVICE *dev = dcr->dev;
2300 JCR *jcr = dcr->jcr;
2302 /* ******FIXME******* put these on config variables */
2303 dev->min_wait = 60 * 60;
2304 dev->max_wait = 24 * 60 * 60;
2305 dev->max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
2306 dev->wait_sec = dev->min_wait;
2307 dev->rem_wait_sec = dev->wait_sec;
2310 dev->BadVolName[0] = 0;
2312 jcr->min_wait = 60 * 60;
2313 jcr->max_wait = 24 * 60 * 60;
2314 jcr->max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
2315 jcr->wait_sec = jcr->min_wait;
2316 jcr->rem_wait_sec = jcr->wait_sec;
2321 void init_jcr_device_wait_timers(JCR *jcr)
2323 /* ******FIXME******* put these on config variables */
2324 jcr->min_wait = 60 * 60;
2325 jcr->max_wait = 24 * 60 * 60;
2326 jcr->max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
2327 jcr->wait_sec = jcr->min_wait;
2328 jcr->rem_wait_sec = jcr->wait_sec;
2334 * The dev timers are used for waiting on a particular device
2336 * Returns: true if time doubled
2337 * false if max time expired
2339 bool double_dev_wait_time(DEVICE *dev)
2341 dev->wait_sec *= 2; /* double wait time */
2342 if (dev->wait_sec > dev->max_wait) { /* but not longer than maxtime */
2343 dev->wait_sec = dev->max_wait;
2346 dev->rem_wait_sec = dev->wait_sec;
2347 if (dev->num_wait >= dev->max_num_wait) {
2354 void set_os_device_parameters(DCR *dcr)
2356 DEVICE *dev = dcr->dev;
2358 if (strcmp(dev->dev_name, "/dev/null") == 0) {
2359 return; /* no use trying to set /dev/null */
2362 #if defined(HAVE_LINUX_OS) || defined(HAVE_WIN32)
2365 Dmsg0(100, "In set_os_device_parameters\n");
2366 #if defined(MTSETBLK)
2367 if (dev->min_block_size == dev->max_block_size &&
2368 dev->min_block_size == 0) { /* variable block mode */
2369 mt_com.mt_op = MTSETBLK;
2370 mt_com.mt_count = 0;
2371 Dmsg0(100, "Set block size to zero\n");
2372 if (tape_ioctl(dev->fd(), MTIOCTOP, (char *)&mt_com) < 0) {
2373 dev->clrerror(MTSETBLK);
2377 #if defined(MTSETDRVBUFFER)
2378 if (getpid() == 0) { /* Only root can do this */
2379 mt_com.mt_op = MTSETDRVBUFFER;
2380 mt_com.mt_count = MT_ST_CLEARBOOLEANS;
2381 if (!dev->has_cap(CAP_TWOEOF)) {
2382 mt_com.mt_count |= MT_ST_TWO_FM;
2384 if (dev->has_cap(CAP_EOM)) {
2385 mt_com.mt_count |= MT_ST_FAST_MTEOM;
2387 Dmsg0(100, "MTSETDRVBUFFER\n");
2388 if (tape_ioctl(dev->fd(), MTIOCTOP, (char *)&mt_com) < 0) {
2389 dev->clrerror(MTSETDRVBUFFER);
2396 #ifdef HAVE_NETBSD_OS
2398 if (dev->min_block_size == dev->max_block_size &&
2399 dev->min_block_size == 0) { /* variable block mode */
2400 mt_com.mt_op = MTSETBSIZ;
2401 mt_com.mt_count = 0;
2402 if (tape_ioctl(dev->fd(), MTIOCTOP, (char *)&mt_com) < 0) {
2403 dev->clrerror(MTSETBSIZ);
2405 /* Get notified at logical end of tape */
2406 mt_com.mt_op = MTEWARN;
2407 mt_com.mt_count = 1;
2408 if (tape_ioctl(dev->fd(), MTIOCTOP, (char *)&mt_com) < 0) {
2409 dev->clrerror(MTEWARN);
2415 #if HAVE_FREEBSD_OS || HAVE_OPENBSD_OS
2417 if (dev->min_block_size == dev->max_block_size &&
2418 dev->min_block_size == 0) { /* variable block mode */
2419 mt_com.mt_op = MTSETBSIZ;
2420 mt_com.mt_count = 0;
2421 if (tape_ioctl(dev->fd(), MTIOCTOP, (char *)&mt_com) < 0) {
2422 dev->clrerror(MTSETBSIZ);
2425 #if defined(MTIOCSETEOTMODEL)
2427 if (dev->has_cap(CAP_TWOEOF)) {
2432 if (ioctl(dev->fd(), MTIOCSETEOTMODEL, (caddr_t)&neof) < 0) {
2434 dev->dev_errno = errno; /* save errno */
2435 Mmsg2(dev->errmsg, _("Unable to set eotmodel on device %s: ERR=%s\n"),
2436 dev->print_name(), be.bstrerror(dev->dev_errno));
2437 Jmsg(dcr->jcr, M_FATAL, 0, dev->errmsg);
2445 if (dev->min_block_size == dev->max_block_size &&
2446 dev->min_block_size == 0) { /* variable block mode */
2447 mt_com.mt_op = MTSRSZ;
2448 mt_com.mt_count = 0;
2449 if (tape_ioctl(dev->fd(), MTIOCTOP, (char *)&mt_com) < 0) {
2450 dev->clrerror(MTSRSZ);
2457 static bool dev_get_os_pos(DEVICE *dev, struct mtget *mt_stat)
2459 Dmsg0(100, "dev_get_os_pos\n");
2460 return dev->has_cap(CAP_MTIOCGET) &&
2461 tape_ioctl(dev->fd(), MTIOCGET, (char *)mt_stat) == 0 &&
2462 mt_stat->mt_fileno >= 0;
2465 static char *modes[] = {
2466 "CREATE_READ_WRITE",
2473 static char *mode_to_str(int mode)
2475 static char buf[100];
2476 if (mode < 1 || mode > 4) {
2477 bsnprintf(buf, sizeof(buf), "BAD mode=%d", mode);
2480 return modes[mode-1];