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 as
36 published by the Free Software Foundation; either version 2 of
37 the License, or (at your option) any later version.
39 This program is distributed in the hope that it will be useful,
40 but WITHOUT ANY WARRANTY; without even the implied warranty of
41 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
42 General Public License for more details.
44 You should have received a copy of the GNU General Public
45 License along with this program; if not, write to the Free
46 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
52 * Handling I/O errors and end of tape conditions are a bit tricky.
53 * This is how it is currently done when writting.
54 * On either an I/O error or end of tape,
55 * we will stop writing on the physical device (no I/O recovery is
56 * attempted at least in this daemon). The state flag will be sent
57 * to include ST_EOT, which is ephimeral, and ST_WEOT, which is
58 * persistent. Lots of routines clear ST_EOT, but ST_WEOT is
59 * cleared only when the problem goes away. Now when ST_WEOT
60 * is set all calls to write_block_to_device() call the fix_up
61 * routine. In addition, all threads are blocked
62 * from writing on the tape by calling lock_dev(), and thread other
63 * than the first thread to hit the EOT will block on a condition
64 * variable. The first thread to hit the EOT will continue to
65 * be able to read and write the tape (he sort of tunnels through
66 * the locking mechanism -- see lock_dev() for details).
68 * Now presumably somewhere higher in the chain of command
69 * (device.c), someone will notice the EOT condition and
70 * get a new tape up, get the tape label read, and mark
71 * the label for rewriting. Then this higher level routine
72 * will write the unwritten buffer to the new volume.
73 * Finally, he will release
74 * any blocked threads by doing a broadcast on the condition
75 * variable. At that point, we should be totally back in
76 * business with no lost data.
83 /* Forward referenced functions */
84 void set_os_device_parameters(DEVICE *dev);
85 int mount_dev(DEVICE* dev, int timeout);
86 int unmount_dev(DEVICE* dev, int timeout);
87 int write_part(DEVICE *dev);
88 char *edit_device_codes_dev(DEVICE* dev, char *omsg, const char *imsg);
89 static void get_filename(DEVICE *dev, char *VolName, POOL_MEM& archive_name);
90 static void update_free_space_dev(DEVICE* dev);
93 * Allocate and initialize the DEVICE structure
94 * Note, if dev is non-NULL, it is already allocated,
95 * thus we neither allocate it nor free it. This allows
96 * the caller to put the packet in shared memory.
98 * Note, for a tape, the device->device_name is the device name
99 * (e.g. /dev/nst0), and for a file, the device name
100 * is the directory in which the file will be placed.
104 init_dev(JCR *jcr, DEVICE *dev, DEVRES *device)
111 /* Check that device is available */
112 if (stat(device->device_name, &statp) < 0) {
115 dev->dev_errno = errno;
117 Jmsg2(jcr, M_FATAL, 0, _("Unable to stat device %s: ERR=%s\n"),
118 device->device_name, be.strerror());
125 if (S_ISDIR(statp.st_mode)) {
127 } else if (S_ISCHR(statp.st_mode)) {
129 } else if (S_ISFIFO(statp.st_mode)) {
133 dev->dev_errno = ENODEV;
135 Jmsg2(jcr, M_FATAL, 0, _("%s is an unknown device type. Must be tape or directory. st_mode=%x\n"),
136 device->device_name, statp.st_mode);
140 dev = (DEVICE *)get_memory(sizeof(DEVICE));
141 memset(dev, 0, sizeof(DEVICE));
142 dev->state = ST_MALLOC;
144 memset(dev, 0, sizeof(DEVICE));
147 /* Copy user supplied device parameters from Resource */
148 dev->dev_name = get_memory(strlen(device->device_name)+1);
149 pm_strcpy(dev->dev_name, device->device_name);
150 dev->capabilities = device->cap_bits;
151 dev->min_block_size = device->min_block_size;
152 dev->max_block_size = device->max_block_size;
153 dev->max_volume_size = device->max_volume_size;
154 dev->max_file_size = device->max_file_size;
155 dev->volume_capacity = device->volume_capacity;
156 dev->max_rewind_wait = device->max_rewind_wait;
157 dev->max_open_wait = device->max_open_wait;
158 dev->max_open_vols = device->max_open_vols;
159 dev->vol_poll_interval = device->vol_poll_interval;
160 dev->max_spool_size = device->max_spool_size;
161 dev->drive_index = device->drive_index;
162 if (tape) { /* No parts on tapes */
163 dev->max_part_size = 0;
166 dev->max_part_size = device->max_part_size;
169 if (dev->vol_poll_interval && dev->vol_poll_interval < 60) {
170 dev->vol_poll_interval = 60;
172 dev->device = device;
175 dev->state |= ST_TAPE;
177 dev->state |= ST_FIFO;
178 dev->capabilities |= CAP_STREAM; /* set stream device */
180 dev->state |= ST_FILE;
183 /* If the device requires mount :
184 * - Check that the mount point is available
185 * - Check that (un)mount commands are defined
187 if (dev->is_file() && device->cap_bits & CAP_REQMOUNT) {
188 if (stat(device->mount_point, &statp) < 0) {
190 dev->dev_errno = errno;
191 Jmsg2(jcr, M_FATAL, 0, _("Unable to stat mount point %s: ERR=%s\n"),
192 device->mount_point, be.strerror());
195 if (!device->mount_command || !device->unmount_command) {
196 Jmsg0(jcr, M_ERROR_TERM, 0, _("Mount and unmount commands must defined for a device which requires mount.\n"));
198 if (!device->write_part_command) {
199 Jmsg0(jcr, M_ERROR_TERM, 0, _("Write part command must be defined for a device which requires mount.\n"));
201 dev->state |= ST_DVD;
204 if (dev->max_block_size > 1000000) {
205 Jmsg3(jcr, M_ERROR, 0, _("Block size %u on device %s is too large, using default %u\n"),
206 dev->max_block_size, dev->dev_name, DEFAULT_BLOCK_SIZE);
207 dev->max_block_size = 0;
209 if (dev->max_block_size % TAPE_BSIZE != 0) {
210 Jmsg2(jcr, M_WARNING, 0, _("Max block size %u not multiple of device %s block size.\n"),
211 dev->max_block_size, dev->dev_name);
214 dev->errmsg = get_pool_memory(PM_EMSG);
217 if ((errstat = pthread_mutex_init(&dev->mutex, NULL)) != 0) {
219 dev->dev_errno = errstat;
220 Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
221 Jmsg0(jcr, M_ERROR_TERM, 0, dev->errmsg);
223 if ((errstat = pthread_cond_init(&dev->wait, NULL)) != 0) {
225 dev->dev_errno = errstat;
226 Mmsg1(dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), be.strerror(errstat));
227 Jmsg0(jcr, M_ERROR_TERM, 0, dev->errmsg);
229 if ((errstat = pthread_cond_init(&dev->wait_next_vol, NULL)) != 0) {
231 dev->dev_errno = errstat;
232 Mmsg1(dev->errmsg, _("Unable to init cond variable: ERR=%s\n"), be.strerror(errstat));
233 Jmsg0(jcr, M_ERROR_TERM, 0, dev->errmsg);
235 if ((errstat = pthread_mutex_init(&dev->spool_mutex, NULL)) != 0) {
237 dev->dev_errno = errstat;
238 Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
239 Jmsg0(jcr, M_ERROR_TERM, 0, dev->errmsg);
241 if ((errstat = rwl_init(&dev->lock)) != 0) {
243 dev->dev_errno = errstat;
244 Mmsg1(dev->errmsg, _("Unable to init mutex: ERR=%s\n"), be.strerror(errstat));
245 Jmsg0(jcr, M_ERROR_TERM, 0, dev->errmsg);
249 dev->attached_dcrs = New(dlist(dcr, &dcr->dev_link));
250 Dmsg2(29, "init_dev: tape=%d dev_name=%s\n", dev_is_tape(dev), dev->dev_name);
256 * Write the current volume/part filename to archive_name.
258 static void get_filename(DEVICE *dev, char *VolName, POOL_MEM& archive_name)
263 /* If we try to open the last part, just open it from disk,
264 * otherwise, open it from the spooling directory */
265 if (dev->part < dev->num_parts) {
266 pm_strcpy(archive_name, dev->device->mount_point);
268 /* Use the working directory if spool directory is not defined */
269 if (dev->device->spool_directory) {
270 pm_strcpy(archive_name, dev->device->spool_directory);
272 pm_strcpy(archive_name, working_directory);
276 pm_strcpy(archive_name, dev->dev_name);
279 if (archive_name.c_str()[strlen(archive_name.c_str())-1] != '/') {
280 pm_strcat(archive_name, "/");
282 pm_strcat(archive_name, VolName);
283 /* if part != 0, append .# to the filename (where # is the part number) */
284 if (dev->is_dvd() && dev->part != 0) {
285 pm_strcat(archive_name, ".");
286 bsnprintf(partnumber, sizeof(partnumber), "%d", dev->part);
287 pm_strcat(archive_name, partnumber);
292 * Open the device with the operating system and
293 * initialize buffer pointers.
295 * Returns: -1 on error
298 * Note, for a tape, the VolName is the name we give to the
299 * volume (not really used here), but for a file, the
300 * VolName represents the name of the file to be created/opened.
301 * In the case of a file, the full name is the device name
302 * (archive_name) with the VolName concatenated.
305 open_dev(DEVICE *dev, char *VolName, int mode)
307 if (dev->is_open()) {
309 * *****FIXME***** how to handle two threads wanting
310 * different volumes mounted???? E.g. one is waiting
311 * for the next volume to be mounted, and a new job
312 * starts and snatches up the device.
314 if (VolName && strcmp(dev->VolCatInfo.VolCatName, VolName) != 0) {
318 Mmsg2(&dev->errmsg, _("WARNING!!!! device %s opened %d times!!!\n"),
319 dev->dev_name, dev->use_count);
320 Emsg1(M_WARNING, 0, "%s", dev->errmsg);
324 bstrncpy(dev->VolCatInfo.VolCatName, VolName, sizeof(dev->VolCatInfo.VolCatName));
327 Dmsg3(29, "open_dev: tape=%d dev_name=%s vol=%s\n", dev_is_tape(dev),
328 dev->dev_name, dev->VolCatInfo.VolCatName);
329 dev->state &= ~(ST_LABEL|ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
330 dev->label_type = B_BACULA_LABEL;
331 if (dev->is_tape() || dev->is_fifo()) {
334 Dmsg0(29, "open_dev: device is tape\n");
335 if (mode == OPEN_READ_WRITE) {
336 dev->mode = O_RDWR | O_BINARY;
337 } else if (mode == OPEN_READ_ONLY) {
338 dev->mode = O_RDONLY | O_BINARY;
339 } else if (mode == OPEN_WRITE_ONLY) {
340 dev->mode = O_WRONLY | O_BINARY;
342 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
344 timeout = dev->max_open_wait;
346 if (dev->is_fifo() && timeout) {
348 dev->tid = start_thread_timer(pthread_self(), timeout);
350 /* If busy retry each second for max_open_wait seconds */
351 while ((dev->fd = open(dev->dev_name, dev->mode, MODE_RW)) < 0) {
353 if (errno == EINTR || errno == EAGAIN) {
356 if (errno == EBUSY && timeout-- > 0) {
357 Dmsg2(100, "Device %s busy. ERR=%s\n", dev->dev_name, be.strerror());
361 dev->dev_errno = errno;
362 Mmsg2(&dev->errmsg, _("stored: unable to open device %s: ERR=%s\n"),
363 dev->dev_name, be.strerror());
364 /* Stop any open timer we set */
366 stop_thread_timer(dev->tid);
369 Emsg0(M_FATAL, 0, dev->errmsg);
374 dev->state |= ST_OPENED;
376 update_pos_dev(dev); /* update position */
377 set_os_device_parameters(dev); /* do system dependent stuff */
379 /* Stop any open() timer we started */
381 stop_thread_timer(dev->tid);
384 Dmsg1(29, "open_dev: tape %d opened\n", dev->fd);
386 POOL_MEM archive_name(PM_FNAME);
387 struct stat filestat;
389 * Handle opening of File Archive (not a tape)
391 if (dev->part == 0) {
396 /* if num_parts has not been set, but VolCatInfo is available, copy
397 * it from the VolCatInfo.VolCatParts */
398 if (dev->num_parts < dev->VolCatInfo.VolCatParts) {
399 dev->num_parts = dev->VolCatInfo.VolCatParts;
402 if (VolName == NULL || *VolName == 0) {
403 Mmsg(dev->errmsg, _("Could not open file device %s. No Volume name given.\n"),
407 get_filename(dev, VolName, archive_name);
410 if (mount_dev(dev, 1) < 0) {
411 Mmsg(dev->errmsg, _("Could not mount archive device %s.\n"),
413 Emsg0(M_FATAL, 0, dev->errmsg);
419 Dmsg2(29, "open_dev: device is disk %s (mode:%d)\n", archive_name.c_str(), mode);
420 dev->openmode = mode;
423 * If we are not trying to access the last part, set mode to
424 * OPEN_READ_ONLY as writing would be an error.
426 if (dev->part < dev->num_parts) {
427 mode = OPEN_READ_ONLY;
430 if (mode == OPEN_READ_WRITE) {
431 dev->mode = O_CREAT | O_RDWR | O_BINARY;
432 } else if (mode == OPEN_READ_ONLY) {
433 dev->mode = O_RDONLY | O_BINARY;
434 } else if (mode == OPEN_WRITE_ONLY) {
435 dev->mode = O_WRONLY | O_BINARY;
437 Emsg0(M_ABORT, 0, _("Illegal mode given to open_dev.\n"));
439 /* If creating file, give 0640 permissions */
440 if ((dev->fd = open(archive_name.c_str(), dev->mode, 0640)) < 0) {
442 dev->dev_errno = errno;
443 Mmsg2(&dev->errmsg, _("Could not open: %s, ERR=%s\n"), archive_name.c_str(), be.strerror());
444 Emsg0(M_FATAL, 0, dev->errmsg);
447 dev->state |= ST_OPENED;
449 update_pos_dev(dev); /* update position */
450 if (fstat(dev->fd, &filestat) < 0) {
452 dev->dev_errno = errno;
453 Mmsg2(&dev->errmsg, _("Could not fstat: %s, ERR=%s\n"), archive_name.c_str(), be.strerror());
454 Emsg0(M_FATAL, 0, dev->errmsg);
456 dev->part_size = filestat.st_size;
459 Dmsg4(29, "open_dev: disk fd=%d opened, part=%d/%d, part_size=%u\n", dev->fd, dev->part, dev->num_parts, dev->part_size);
460 if (dev->is_dvd() && (dev->mode != OPEN_READ_ONLY) &&
461 (dev->free_space_errno == 0 || dev->num_parts == dev->part)) {
462 update_free_space_dev(dev);
468 /* (Un)mount the device */
469 int do_mount_dev(DEVICE* dev, int mount, int dotimeout) {
470 POOL_MEM ocmd(PM_FNAME);
472 results = get_pool_memory(PM_MESSAGE);
477 icmd = dev->device->mount_command;
480 icmd = dev->device->unmount_command;
483 edit_device_codes_dev(dev, ocmd.c_str(), icmd);
485 Dmsg2(29, "do_mount_dev: cmd=%s state=%d\n", ocmd.c_str(), dev->state & ST_MOUNTED);
488 /* Try at most 5 times to (un)mount the device. This should perhaps be configurable. */
494 /* If busy retry each second */
495 while ((status = run_program_full_output(ocmd.c_str(), dev->max_open_wait/2, results)) != 0) {
497 Dmsg2(40, "Device %s cannot be (un)mounted. Retrying... ERR=%s\n", dev->dev_name, results);
498 /* Sometimes the device cannot be mounted because it is already mounted.
499 * Try to unmount it, then remount it */
501 Dmsg1(40, "Trying to unmount the device %s...\n", dev->dev_name);
502 do_mount_dev(dev, 0, 0);
507 free_pool_memory(results);
508 Dmsg2(40, "Device %s cannot be mounted. ERR=%s\n", dev->dev_name, results);
513 dev->state |= ST_MOUNTED;
516 dev->state &= ~ST_MOUNTED;
518 free_pool_memory(results);
520 Dmsg1(29, "do_mount_dev: end_state=%d\n", dev->state & ST_MOUNTED);
524 /* Only for devices that requires mount.
525 * Try to find the volume name of the loaded device, and open the
526 * first part of this volume.
528 * Returns 0 if read_dev_volume_label can now read the label,
529 * -1 if an error occured, and read_dev_volume_label_guess must abort with an IO_ERROR.
531 * To guess the device name, it lists all the files on the DVD, and searches for a
532 * file which has a minimum size (500 bytes). If this file has a numeric extension,
533 * like part files, try to open the file which has no extension (e.g. the first
535 * So, if the DVD does not contains a Bacula volume, a random file is opened,
536 * and no valid label could be read from this file.
538 * It is useful, so the operator can be told that a wrong volume is mounted, with
539 * the label name of the current volume. We can also check that the currently
540 * mounted disk is writable. (See also read_dev_volume_label_guess in label.c).
542 * Note that if the right volume is mounted, open_guess_name_dev returns the same
543 * result as an usual open_dev.
545 int open_guess_name_dev(DEVICE *dev)
547 Dmsg1(29, "open_guess_name_dev: dev=%s\n", dev->dev_name);
548 POOL_MEM guessedname(PM_FNAME);
550 struct dirent *entry, *result;
555 if (!dev->is_dvd()) {
556 Dmsg1(100, "open_guess_name_dev: device does not require mount, returning 0. dev=%s\n", dev->dev_name);
560 #ifndef HAVE_DIRENT_H
561 Dmsg0(29, "open_guess_name_dev: readdir not available, cannot guess volume name\n");
565 update_free_space_dev(dev);
567 if (mount_dev(dev, 1) < 0) {
568 /* If the device cannot be mounted, check if it is writable */
569 if (dev->free_space_errno >= 0) {
570 Dmsg1(100, "open_guess_name_dev: device cannot be mounted, but it seems to be writable, returning 0. dev=%s\n", dev->dev_name);
573 Dmsg1(100, "open_guess_name_dev: device cannot be mounted, and is not writable, returning 0. dev=%s\n", dev->dev_name);
574 /* read_dev_volume_label_guess must now check dev->free_space_errno to understand that the media is not writable. */
579 name_max = pathconf(".", _PC_NAME_MAX);
580 if (name_max < 1024) {
584 if (!(dp = opendir(dev->device->mount_point))) {
586 dev->dev_errno = errno;
587 Dmsg3(29, "open_guess_name_dev: failed to open dir %s (dev=%s), ERR=%s\n", dev->device->mount_point, dev->dev_name, be.strerror());
591 entry = (struct dirent *)malloc(sizeof(struct dirent) + name_max + 100);
593 if ((readdir_r(dp, entry, &result) != 0) || (result == NULL)) {
594 dev->dev_errno = ENOENT;
595 Dmsg2(29, "open_guess_name_dev: failed to find suitable file in dir %s (dev=%s)\n", dev->device->mount_point, dev->dev_name);
600 ASSERT(name_max+1 > (int)sizeof(struct dirent) + (int)NAMELEN(entry));
602 if (strcmp(entry->d_name, ".") == 0 || strcmp(entry->d_name, "..") == 0) {
606 pm_strcpy(guessedname, dev->device->mount_point);
607 if (guessedname.c_str()[strlen(guessedname.c_str())-1] != '/') {
608 pm_strcat(guessedname, "/");
610 pm_strcat(guessedname, entry->d_name);
612 if (stat(guessedname.c_str(), &statp) < 0) {
614 Dmsg3(29, "open_guess_name_dev: failed to stat %s (dev=%s), ERR=%s\n",
615 guessedname.c_str(), dev->dev_name, be.strerror());
619 if (!S_ISREG(statp.st_mode) || (statp.st_size < 500)) {
620 Dmsg2(100, "open_guess_name_dev: %s is not a regular file, or less than 500 bytes (dev=%s)\n",
621 guessedname.c_str(), dev->dev_name);
625 /* Ok, we found a good file, remove the part extension if possible. */
626 for (index = strlen(guessedname.c_str())-1; index >= 0; index--) {
627 if ((guessedname.c_str()[index] == '/') ||
628 (guessedname.c_str()[index] < '0') ||
629 (guessedname.c_str()[index] > '9')) {
632 if (guessedname.c_str()[index] == '.') {
633 guessedname.c_str()[index] = '\0';
638 if ((stat(guessedname.c_str(), &statp) < 0) || (statp.st_size < 500)) {
639 /* The file with extension truncated does not exists or is too small, so use it with its extension. */
641 Dmsg3(100, "open_guess_name_dev: failed to stat %s (dev=%s), using the file with its extension, ERR=%s\n",
642 guessedname.c_str(), dev->dev_name, be.strerror());
643 pm_strcpy(guessedname, dev->device->mount_point);
644 if (guessedname.c_str()[strlen(guessedname.c_str())-1] != '/') {
645 pm_strcat(guessedname, "/");
647 pm_strcat(guessedname, entry->d_name);
659 if ((dev->fd = open(guessedname.c_str(), O_RDONLY | O_BINARY)) < 0) {
661 dev->dev_errno = errno;
662 Dmsg3(29, "open_guess_name_dev: failed to open %s (dev=%s), ERR=%s\n",
663 guessedname.c_str(), dev->dev_name, be.strerror());
664 if (open_first_part(dev) < 0) {
666 dev->dev_errno = errno;
667 Mmsg1(&dev->errmsg, _("Could not open_first_part, ERR=%s\n"), be.strerror());
668 Emsg0(M_FATAL, 0, dev->errmsg);
673 dev->part_size = statp.st_size;
675 dev->state |= ST_OPENED;
678 Dmsg2(29, "open_guess_name_dev: %s opened (dev=%s)\n", guessedname.c_str(), dev->dev_name);
684 * If timeout, wait until the mount command returns 0.
685 * If !timeout, try to mount the device only once.
687 int mount_dev(DEVICE* dev, int timeout)
689 if (dev->state & ST_MOUNTED) {
690 Dmsg0(100, "mount_dev: Device already mounted\n");
693 return do_mount_dev(dev, 1, timeout);
697 /* Unmount the device
698 * If timeout, wait until the unmount command returns 0.
699 * If !timeout, try to unmount the device only once.
701 int unmount_dev(DEVICE* dev, int timeout)
703 if (dev->state & ST_MOUNTED) {
704 return do_mount_dev(dev, 0, timeout);
706 Dmsg0(100, "mount_dev: Device already unmounted\n");
711 /* Update the free space on the device */
712 static void update_free_space_dev(DEVICE* dev)
714 POOL_MEM ocmd(PM_FNAME);
720 icmd = dev->device->free_space_command;
724 dev->free_space_errno = 0;
725 Dmsg2(29, "update_free_space_dev: free_space=%d, free_space_errno=%d (!icmd)\n", dev->free_space, dev->free_space_errno);
729 edit_device_codes_dev(dev, ocmd.c_str(), icmd);
731 Dmsg1(29, "update_free_space_dev: cmd=%s\n", ocmd.c_str());
733 results = get_pool_memory(PM_MESSAGE);
735 /* Try at most 3 times to get the free space on the device. This should perhaps be configurable. */
740 if (run_program_full_output(ocmd.c_str(), dev->max_open_wait/2, results) == 0) {
741 Dmsg1(100, "Free space program run : %s\n", results);
742 free = str_to_int64(results);
744 dev->free_space = free;
745 dev->free_space_errno = 1;
746 Mmsg0(dev->errmsg, "");
751 dev->free_space_errno = -EPIPE;
752 Mmsg1(dev->errmsg, "Cannot run free space command (%s)\n", results);
755 Dmsg4(40, "Cannot get free space on device %s. free_space=%s, "
756 "free_space_errno=%d ERR=%s\n", dev->dev_name,
757 edit_uint64(dev->free_space, ed1), dev->free_space_errno,
763 dev->dev_errno = -dev->free_space_errno;
764 Dmsg4(40, "Cannot get free space on device %s. free_space=%s, "
765 "free_space_errno=%d ERR=%s\n",
766 dev->dev_name, edit_uint64(dev->free_space, ed1),
767 dev->free_space_errno, dev->errmsg);
771 free_pool_memory(results);
772 Dmsg2(29, "update_free_space_dev: free_space=%lld, free_space_errno=%d\n", dev->free_space, dev->free_space_errno);
776 int write_part(DEVICE *dev)
778 Dmsg1(29, "write_part: device is %s\n", dev->dev_name);
780 if (unmount_dev(dev, 1) < 0) {
781 Dmsg0(29, "write_part: unable to unmount the device\n");
784 POOL_MEM ocmd(PM_FNAME);
786 results = get_pool_memory(PM_MESSAGE);
791 icmd = dev->device->write_part_command;
793 edit_device_codes_dev(dev, ocmd.c_str(), icmd);
795 /* Wait at most the time a maximum size part is written in DVD 0.5x speed
796 * FIXME: Minimum speed should be in device configuration
798 timeout = dev->max_open_wait + (dev->max_part_size/(1350*1024/2));
800 Dmsg2(29, "write_part: cmd=%s timeout=%d\n", ocmd.c_str(), timeout);
802 status = run_program_full_output(ocmd.c_str(), timeout, results);
804 Mmsg1(dev->errmsg, "Error while writing current part to the DVD: %s", results);
805 dev->dev_errno = EIO;
806 free_pool_memory(results);
810 Dmsg1(29, "write_part: command output=%s\n", results);
811 POOL_MEM archive_name(PM_FNAME);
812 get_filename(dev, dev->VolCatInfo.VolCatName, archive_name);
813 unlink(archive_name.c_str());
814 free_pool_memory(results);
819 /* Open the next part file.
821 * - Increment part number
822 * - Reopen the device
824 int open_next_part(DEVICE *dev) {
827 Dmsg3(29, "open_next_part %s %s %d\n", dev->dev_name, dev->VolCatInfo.VolCatName, dev->openmode);
828 /* When appending, do not open a new part if the current is empty */
829 if (dev->can_append() && (dev->part == dev->num_parts) &&
830 (dev->part_size == 0)) {
831 Dmsg0(29, "open_next_part exited immediately (dev->part_size == 0).\n");
842 dev->state &= ~ST_OPENED;
844 if (dev->is_dvd() && (dev->part == dev->num_parts) && dev->can_append()) {
845 if (write_part(dev) < 0) {
850 dev->part_start += dev->part_size;
853 if ((dev->num_parts < dev->part) && (dev->state & ST_APPEND)) {
854 dev->num_parts = dev->part;
856 /* Check that the next part file does not exists.
857 * If it does, move it away... */
858 POOL_MEM archive_name(PM_FNAME);
859 POOL_MEM archive_bkp_name(PM_FNAME);
862 get_filename(dev, dev->VolCatInfo.VolCatName, archive_name);
864 /* Check if the next part exists. */
865 if ((stat(archive_name.c_str(), &buf) == 0) || (errno != ENOENT)) {
866 Dmsg1(29, "open_next_part %s is in the way, moving it away...\n", archive_name.c_str());
867 pm_strcpy(archive_bkp_name, archive_name.c_str());
868 pm_strcat(archive_bkp_name, ".bak");
869 unlink(archive_bkp_name.c_str());
871 /* First try to rename it */
872 if (rename(archive_name.c_str(), archive_bkp_name.c_str()) < 0) {
874 Dmsg3(29, "open_next_part can't rename %s to %s, ERR=%s\n",
875 archive_name.c_str(), archive_bkp_name.c_str(), be.strerror());
876 /* Then try to unlink it */
877 if (unlink(archive_name.c_str()) < 0) {
879 dev->dev_errno = errno;
880 Mmsg2(&dev->errmsg, _("open_next_part can't unlink existing part %s, ERR=%s\n"),
881 archive_name.c_str(), be.strerror());
882 Emsg0(M_FATAL, 0, dev->errmsg);
889 if (open_dev(dev, dev->VolCatInfo.VolCatName, dev->openmode) < 0) {
897 /* Open the first part file.
899 * - Reopen the device
901 int open_first_part(DEVICE *dev) {
904 Dmsg3(29, "open_first_part %s %s %d\n", dev->dev_name, dev->VolCatInfo.VolCatName, dev->openmode);
911 dev->state &= ~ST_OPENED;
916 if (open_dev(dev, dev->VolCatInfo.VolCatName, dev->openmode)) {
925 /* Protected version of lseek, which opens the right part if necessary */
926 off_t lseek_dev(DEVICE *dev, off_t offset, int whence)
930 if (dev->num_parts == 0) { /* If there is only one part, simply call lseek. */
931 return lseek(dev->fd, offset, whence);
936 Dmsg1(100, "lseek_dev SEEK_SET called %d\n", offset);
937 if ((uint64_t)offset >= dev->part_start) {
938 if ((uint64_t)(offset - dev->part_start) < dev->part_size) {
939 /* We are staying in the current part, just seek */
940 if ((pos = lseek(dev->fd, (off_t)(offset-dev->part_start), SEEK_SET)) < 0) {
943 return pos + dev->part_start;
946 /* Load next part, and start again */
947 if (open_next_part(dev) < 0) {
948 Dmsg0(100, "lseek_dev failed while trying to open the next part\n");
951 return lseek_dev(dev, offset, SEEK_SET);
954 /* pos < dev->part_start :
955 * We need to access a previous part,
956 * so just load the first one, and seek again
957 * until the right one is loaded */
958 if (open_first_part(dev) < 0) {
959 Dmsg0(100, "lseek_dev failed while trying to open the first part\n");
962 return lseek_dev(dev, offset, SEEK_SET);
966 Dmsg1(100, "lseek_dev SEEK_CUR called %d\n", offset);
967 if ((pos = lseek(dev->fd, (off_t)0, SEEK_CUR)) < 0) {
970 pos += dev->part_start;
974 else { /* Not used in Bacula, but should work */
975 return lseek_dev(dev, pos, SEEK_SET);
979 Dmsg1(100, "lseek_dev SEEK_END called %d\n", offset);
980 if (offset > 0) { /* Not used by bacula */
981 Dmsg1(100, "lseek_dev SEEK_END called with an invalid offset %d\n", offset);
986 if (dev->part == dev->num_parts) { /* The right part is already loaded */
987 if ((pos = lseek(dev->fd, (off_t)0, SEEK_END)) < 0) {
990 return pos + dev->part_start;
993 /* Load the first part, then load the next until we reach the last one.
994 * This is the only way to be sure we compute the right file address. */
995 /* Save previous openmode, and open all but last part read-only (useful for DVDs) */
996 openmode = dev->openmode;
997 dev->openmode = OPEN_READ_ONLY;
999 /* Works because num_parts > 0. */
1000 if (open_first_part(dev) < 0) {
1001 Dmsg0(100, "lseek_dev failed while trying to open the first part\n");
1004 while (dev->part < (dev->num_parts-1)) {
1005 if (open_next_part(dev) < 0) {
1006 Dmsg0(100, "lseek_dev failed while trying to open the next part\n");
1010 dev->openmode = openmode;
1011 if (open_next_part(dev) < 0) {
1012 Dmsg0(100, "lseek_dev failed while trying to open the next part\n");
1015 return lseek_dev(dev, 0, SEEK_END);
1024 #ifdef debug_tracing
1026 bool _rewind_dev(char *file, int line, DEVICE *dev)
1028 Dmsg2(100, "rewind_dev called from %s:%d\n", file, line);
1029 return rewind_dev(dev);
1034 * Rewind the device.
1035 * Returns: true on success
1038 bool rewind_dev(DEVICE *dev)
1043 Dmsg1(29, "rewind_dev %s\n", dev->dev_name);
1045 dev->dev_errno = EBADF;
1046 Mmsg1(&dev->errmsg, _("Bad call to rewind_dev. Device %s not open\n"),
1048 Emsg0(M_ABORT, 0, dev->errmsg);
1051 dev->state &= ~(ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
1052 dev->block_num = dev->file = 0;
1055 if (dev->is_tape()) {
1056 mt_com.mt_op = MTREW;
1057 mt_com.mt_count = 1;
1058 /* If we get an I/O error on rewind, it is probably because
1059 * the drive is actually busy. We loop for (about 5 minutes)
1060 * retrying every 5 seconds.
1062 for (i=dev->max_rewind_wait; ; i -= 5) {
1063 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1065 clrerror_dev(dev, MTREW);
1066 if (i == dev->max_rewind_wait) {
1067 Dmsg1(200, "Rewind error, %s. retrying ...\n", be.strerror());
1069 if (dev->dev_errno == EIO && i > 0) {
1070 Dmsg0(200, "Sleeping 5 seconds.\n");
1074 Mmsg2(&dev->errmsg, _("Rewind error on %s. ERR=%s.\n"),
1075 dev->dev_name, be.strerror());
1080 } else if (dev->is_file()) {
1081 if (lseek_dev(dev, (off_t)0, SEEK_SET) < 0) {
1083 dev->dev_errno = errno;
1084 Mmsg2(&dev->errmsg, _("lseek_dev error on %s. ERR=%s.\n"),
1085 dev->dev_name, be.strerror());
1093 * Called to indicate that we have just read an
1094 * EOF from the device.
1096 void DEVICE::set_eof()
1106 * Called to indicate we are now at the end of the tape, and
1107 * writing is not possible.
1109 void DEVICE::set_eot()
1111 state |= (ST_EOF|ST_EOT|ST_WEOT);
1112 state &= ~ST_APPEND; /* make tape read-only */
1116 * Position device to end of medium (end of data)
1117 * Returns: 1 on succes
1121 eod_dev(DEVICE *dev)
1124 struct mtget mt_stat;
1128 Dmsg0(29, "eod_dev\n");
1129 if (dev->at_eot()) {
1132 dev->state &= ~(ST_EOF); /* remove EOF flags */
1133 dev->block_num = dev->file = 0;
1136 if (dev->state & (ST_FIFO | ST_PROG)) {
1139 if (!dev->is_tape()) {
1140 pos = lseek_dev(dev, (off_t)0, SEEK_END);
1141 // Dmsg1(100, "====== Seek to %lld\n", pos);
1143 update_pos_dev(dev);
1144 dev->state |= ST_EOT;
1147 dev->dev_errno = errno;
1149 Mmsg2(&dev->errmsg, _("lseek_dev error on %s. ERR=%s.\n"),
1150 dev->dev_name, be.strerror());
1155 if (dev_cap(dev, CAP_MTIOCGET) && dev_cap(dev, CAP_FASTFSF) &&
1156 !dev_cap(dev, CAP_EOM)) {
1157 struct mtget mt_stat;
1158 Dmsg0(100,"Using FAST FSF for EOM\n");
1159 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno <= 0) {
1160 if (!rewind_dev(dev)) {
1164 mt_com.mt_op = MTFSF;
1166 * ***FIXME*** fix code to handle case that INT16_MAX is
1169 mt_com.mt_count = INT16_MAX; /* use big positive number */
1170 if (mt_com.mt_count < 0) {
1171 mt_com.mt_count = INT16_MAX; /* brain damaged system */
1175 if (dev_cap(dev, CAP_MTIOCGET) && (dev_cap(dev, CAP_FASTFSF) || dev_cap(dev, CAP_EOM))) {
1176 if (dev_cap(dev, CAP_EOM)) {
1177 Dmsg0(100,"Using EOM for EOM\n");
1178 mt_com.mt_op = MTEOM;
1179 mt_com.mt_count = 1;
1182 if ((stat=ioctl(dev->fd, MTIOCTOP, (char *)&mt_com)) < 0) {
1184 clrerror_dev(dev, mt_com.mt_op);
1185 Dmsg1(50, "ioctl error: %s\n", be.strerror());
1186 update_pos_dev(dev);
1187 Mmsg2(&dev->errmsg, _("ioctl MTEOM error on %s. ERR=%s.\n"),
1188 dev->dev_name, be.strerror());
1192 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
1194 clrerror_dev(dev, -1);
1195 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
1196 dev->dev_name, be.strerror());
1199 Dmsg2(100, "EOD file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
1201 dev->file = mt_stat.mt_fileno;
1204 * Rewind then use FSF until EOT reached
1210 if (!rewind_dev(dev)) {
1214 * Move file by file to the end of the tape
1217 for (file_num=dev->file; !dev->at_eot(); file_num++) {
1218 Dmsg0(200, "eod_dev: doing fsf 1\n");
1219 if (!fsf_dev(dev, 1)) {
1220 Dmsg0(200, "fsf_dev error.\n");
1224 * Avoid infinite loop. ***FIXME*** possibly add code
1225 * to set EOD or to turn off CAP_FASTFSF if on.
1227 if (file_num == (int)dev->file) {
1228 struct mtget mt_stat;
1229 Dmsg1(100, "fsf_dev did not advance from file %d\n", file_num);
1230 if (dev_cap(dev, CAP_MTIOCGET) && ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 &&
1231 mt_stat.mt_fileno >= 0) {
1232 Dmsg2(100, "Adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
1234 dev->file = mt_stat.mt_fileno;
1237 break; /* we are not progressing, bail out */
1242 * Some drivers leave us after second EOF when doing
1243 * MTEOM, so we must backup so that appending overwrites
1246 if (dev_cap(dev, CAP_BSFATEOM)) {
1247 struct mtget mt_stat;
1248 /* Backup over EOF */
1249 stat = bsf_dev(dev, 1);
1250 /* If BSF worked and fileno is known (not -1), set file */
1251 if (dev_cap(dev, CAP_MTIOCGET) && ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
1252 Dmsg2(100, "BSFATEOF adjust file from %d to %d\n", dev->file , mt_stat.mt_fileno);
1253 dev->file = mt_stat.mt_fileno;
1255 dev->file++; /* wing it -- not correct on all OSes */
1258 update_pos_dev(dev); /* update position */
1261 Dmsg1(200, "EOD dev->file=%d\n", dev->file);
1266 * Set the position of the device -- only for files
1267 * For other devices, there is no generic way to do it.
1268 * Returns: true on succes
1271 bool update_pos_dev(DEVICE *dev)
1277 dev->dev_errno = EBADF;
1278 Mmsg0(&dev->errmsg, _("Bad device call. Archive not open\n"));
1279 Emsg0(M_FATAL, 0, dev->errmsg);
1283 /* Find out where we are */
1284 if (dev->is_file()) {
1287 pos = lseek_dev(dev, (off_t)0, SEEK_CUR);
1290 dev->dev_errno = errno;
1291 Pmsg1(000, "Seek error: ERR=%s\n", be.strerror());
1292 Mmsg2(&dev->errmsg, _("lseek_dev error on %s. ERR=%s.\n"),
1293 dev->dev_name, be.strerror());
1296 dev->file_addr = pos;
1304 * Return the status of the device. This was meant
1305 * to be a generic routine. Unfortunately, it doesn't
1306 * seem possible (at least I do not know how to do it
1307 * currently), which means that for the moment, this
1308 * routine has very little value.
1312 uint32_t status_dev(DEVICE *dev)
1314 struct mtget mt_stat;
1317 if (dev->state & (ST_EOT | ST_WEOT)) {
1321 if (dev->state & ST_EOF) {
1325 if (dev->is_tape()) {
1327 Dmsg0(-20," Bacula status:");
1328 Dmsg2(-20," file=%d block=%d\n", dev->file, dev->block_num);
1329 if (ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
1331 dev->dev_errno = errno;
1332 Mmsg2(&dev->errmsg, _("ioctl MTIOCGET error on %s. ERR=%s.\n"),
1333 dev->dev_name, be.strerror());
1336 Dmsg0(-20, " Device status:");
1338 #if defined(HAVE_LINUX_OS)
1339 if (GMT_EOF(mt_stat.mt_gstat)) {
1343 if (GMT_BOT(mt_stat.mt_gstat)) {
1347 if (GMT_EOT(mt_stat.mt_gstat)) {
1351 if (GMT_SM(mt_stat.mt_gstat)) {
1355 if (GMT_EOD(mt_stat.mt_gstat)) {
1359 if (GMT_WR_PROT(mt_stat.mt_gstat)) {
1360 stat |= BMT_WR_PROT;
1361 Dmsg0(-20, " WR_PROT");
1363 if (GMT_ONLINE(mt_stat.mt_gstat)) {
1365 Dmsg0(-20, " ONLINE");
1367 if (GMT_DR_OPEN(mt_stat.mt_gstat)) {
1368 stat |= BMT_DR_OPEN;
1369 Dmsg0(-20, " DR_OPEN");
1371 if (GMT_IM_REP_EN(mt_stat.mt_gstat)) {
1372 stat |= BMT_IM_REP_EN;
1373 Dmsg0(-20, " IM_REP_EN");
1375 #endif /* !SunOS && !OSF */
1376 if (dev_cap(dev, CAP_MTIOCGET)) {
1377 Dmsg2(-20, " file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
1379 Dmsg2(-20, " file=%d block=%d\n", -1, -1);
1382 stat |= BMT_ONLINE | BMT_BOT;
1389 * Load medium in device
1390 * Returns: true on success
1393 bool load_dev(DEVICE *dev)
1400 dev->dev_errno = EBADF;
1401 Mmsg0(&dev->errmsg, _("Bad call to load_dev. Archive not open\n"));
1402 Emsg0(M_FATAL, 0, dev->errmsg);
1405 if (!(dev->is_tape())) {
1409 Dmsg0(200, "stored: MTLOAD command not available\n");
1411 dev->dev_errno = ENOTTY; /* function not available */
1412 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
1413 dev->dev_name, be.strerror());
1417 dev->block_num = dev->file = 0;
1420 mt_com.mt_op = MTLOAD;
1421 mt_com.mt_count = 1;
1422 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1424 dev->dev_errno = errno;
1425 Mmsg2(&dev->errmsg, _("ioctl MTLOAD error on %s. ERR=%s.\n"),
1426 dev->dev_name, be.strerror());
1434 * Rewind device and put it offline
1435 * Returns: true on success
1438 bool offline_dev(DEVICE *dev)
1443 dev->dev_errno = EBADF;
1444 Mmsg0(&dev->errmsg, _("Bad call to offline_dev. Archive not open\n"));
1445 Emsg0(M_FATAL, 0, dev->errmsg);
1448 if (!(dev->is_tape())) {
1452 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_EOF|ST_WEOT); /* remove EOF/EOT flags */
1453 dev->block_num = dev->file = 0;
1458 mt_com.mt_op = MTUNLOCK;
1459 mt_com.mt_count = 1;
1460 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1462 mt_com.mt_op = MTOFFL;
1463 mt_com.mt_count = 1;
1464 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
1466 dev->dev_errno = errno;
1467 Mmsg2(&dev->errmsg, _("ioctl MTOFFL error on %s. ERR=%s.\n"),
1468 dev->dev_name, be.strerror());
1471 Dmsg1(100, "Offlined device %s\n", dev->dev_name);
1475 bool offline_or_rewind_dev(DEVICE *dev)
1480 if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
1481 return offline_dev(dev);
1484 * Note, this rewind probably should not be here (it wasn't
1485 * in prior versions of Bacula), but on FreeBSD, this is
1486 * needed in the case the tape was "frozen" due to an error
1487 * such as backspacing after writing and EOF. If it is not
1488 * done, all future references to the drive get and I/O error.
1490 clrerror_dev(dev, MTREW);
1491 return rewind_dev(dev);
1496 * Foward space a file
1497 * Returns: true on success
1501 fsf_dev(DEVICE *dev, int num)
1503 struct mtget mt_stat;
1508 dev->dev_errno = EBADF;
1509 Mmsg0(&dev->errmsg, _("Bad call to fsf_dev. Archive not open\n"));
1510 Emsg0(M_FATAL, 0, dev->errmsg);
1514 if (!dev->is_tape()) {
1517 if (dev->state & ST_EOT) {
1519 Mmsg1(dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
1522 if (dev->state & ST_EOF) {
1523 Dmsg0(200, "ST_EOF set on entry to FSF\n");
1526 Dmsg0(100, "fsf_dev\n");
1529 * If Fast forward space file is set, then we
1530 * use MTFSF to forward space and MTIOCGET
1531 * to get the file position. We assume that
1532 * the SCSI driver will ensure that we do not
1533 * forward space past the end of the medium.
1535 if (dev_cap(dev, CAP_FSF) && dev_cap(dev, CAP_MTIOCGET) && dev_cap(dev, CAP_FASTFSF)) {
1536 mt_com.mt_op = MTFSF;
1537 mt_com.mt_count = num;
1538 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1539 if (stat < 0 || ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) < 0) {
1541 dev->state |= ST_EOT;
1542 Dmsg0(200, "Set ST_EOT\n");
1543 clrerror_dev(dev, MTFSF);
1544 Mmsg2(dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
1545 dev->dev_name, be.strerror());
1546 Dmsg1(200, "%s", dev->errmsg);
1549 Dmsg2(200, "fsf file=%d block=%d\n", mt_stat.mt_fileno, mt_stat.mt_blkno);
1551 dev->file = mt_stat.mt_fileno;
1555 * Here if CAP_FSF is set, and virtually all drives
1556 * these days support it, we read a record, then forward
1557 * space one file. Using this procedure, which is slow,
1558 * is the only way we can be sure that we don't read
1559 * two consecutive EOF marks, which means End of Data.
1561 } else if (dev_cap(dev, CAP_FSF)) {
1564 Dmsg0(200, "FSF has cap_fsf\n");
1565 if (dev->max_block_size == 0) {
1566 rbuf_len = DEFAULT_BLOCK_SIZE;
1568 rbuf_len = dev->max_block_size;
1570 rbuf = get_memory(rbuf_len);
1571 mt_com.mt_op = MTFSF;
1572 mt_com.mt_count = 1;
1573 while (num-- && !(dev->state & ST_EOT)) {
1574 Dmsg0(100, "Doing read before fsf\n");
1575 if ((stat = read(dev->fd, (char *)rbuf, rbuf_len)) < 0) {
1576 if (errno == ENOMEM) { /* tape record exceeds buf len */
1577 stat = rbuf_len; /* This is OK */
1580 dev->state |= ST_EOT;
1581 clrerror_dev(dev, -1);
1582 Dmsg2(100, "Set ST_EOT read errno=%d. ERR=%s\n", dev->dev_errno,
1584 Mmsg2(dev->errmsg, _("read error on %s. ERR=%s.\n"),
1585 dev->dev_name, be.strerror());
1586 Dmsg1(100, "%s", dev->errmsg);
1590 if (stat == 0) { /* EOF */
1591 update_pos_dev(dev);
1592 Dmsg1(100, "End of File mark from read. File=%d\n", dev->file+1);
1593 /* Two reads of zero means end of tape */
1594 if (dev->state & ST_EOF) {
1595 dev->state |= ST_EOT;
1596 Dmsg0(100, "Set ST_EOT\n");
1602 } else { /* Got data */
1603 dev->state &= ~(ST_EOF|ST_EOT);
1606 Dmsg0(100, "Doing MTFSF\n");
1607 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1608 if (stat < 0) { /* error => EOT */
1610 dev->state |= ST_EOT;
1611 Dmsg0(100, "Set ST_EOT\n");
1612 clrerror_dev(dev, MTFSF);
1613 Mmsg2(&dev->errmsg, _("ioctl MTFSF error on %s. ERR=%s.\n"),
1614 dev->dev_name, be.strerror());
1615 Dmsg0(100, "Got < 0 for MTFSF\n");
1616 Dmsg1(100, "%s", dev->errmsg);
1624 * No FSF, so use FSR to simulate it
1627 Dmsg0(200, "Doing FSR for FSF\n");
1628 while (num-- && !(dev->state & ST_EOT)) {
1629 fsr_dev(dev, INT32_MAX); /* returns -1 on EOF or EOT */
1631 if (dev->state & ST_EOT) {
1633 Mmsg1(dev->errmsg, _("Device %s at End of Tape.\n"), dev->dev_name);
1639 update_pos_dev(dev);
1640 Dmsg1(200, "Return %d from FSF\n", stat);
1641 if (dev->state & ST_EOF)
1642 Dmsg0(200, "ST_EOF set on exit FSF\n");
1643 if (dev->state & ST_EOT)
1644 Dmsg0(200, "ST_EOT set on exit FSF\n");
1645 Dmsg1(200, "Return from FSF file=%d\n", dev->file);
1650 * Backward space a file
1651 * Returns: false on failure
1655 bsf_dev(DEVICE *dev, int num)
1661 dev->dev_errno = EBADF;
1662 Mmsg0(dev->errmsg, _("Bad call to bsf_dev. Archive device not open\n"));
1663 Emsg0(M_FATAL, 0, dev->errmsg);
1667 if (!dev->is_tape()) {
1668 Mmsg1(dev->errmsg, _("Device %s cannot BSF because it is not a tape.\n"),
1672 Dmsg0(29, "bsf_dev\n");
1673 dev->state &= ~(ST_EOT|ST_EOF);
1677 mt_com.mt_op = MTBSF;
1678 mt_com.mt_count = num;
1679 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1682 clrerror_dev(dev, MTBSF);
1683 Mmsg2(dev->errmsg, _("ioctl MTBSF error on %s. ERR=%s.\n"),
1684 dev->dev_name, be.strerror());
1686 update_pos_dev(dev);
1692 * Foward space a record
1693 * Returns: false on failure
1697 fsr_dev(DEVICE *dev, int num)
1703 dev->dev_errno = EBADF;
1704 Mmsg0(dev->errmsg, _("Bad call to fsr_dev. Archive not open\n"));
1705 Emsg0(M_FATAL, 0, dev->errmsg);
1709 if (!dev->is_tape()) {
1712 if (!dev_cap(dev, CAP_FSR)) {
1713 Mmsg1(dev->errmsg, _("ioctl MTFSR not permitted on %s.\n"), dev->dev_name);
1717 Dmsg1(29, "fsr_dev %d\n", num);
1718 mt_com.mt_op = MTFSR;
1719 mt_com.mt_count = num;
1720 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1722 dev->state &= ~ST_EOF;
1723 dev->block_num += num;
1726 struct mtget mt_stat;
1727 clrerror_dev(dev, MTFSR);
1728 Dmsg1(100, "FSF fail: ERR=%s\n", be.strerror());
1729 if (dev_cap(dev, CAP_MTIOCGET) && ioctl(dev->fd, MTIOCGET, (char *)&mt_stat) == 0 && mt_stat.mt_fileno >= 0) {
1730 Dmsg4(100, "Adjust from %d:%d to %d:%d\n", dev->file,
1731 dev->block_num, mt_stat.mt_fileno, mt_stat.mt_blkno);
1732 dev->file = mt_stat.mt_fileno;
1733 dev->block_num = mt_stat.mt_blkno;
1735 if (dev->state & ST_EOF) {
1736 dev->state |= ST_EOT;
1741 Mmsg2(dev->errmsg, _("ioctl MTFSR error on %s. ERR=%s.\n"),
1742 dev->dev_name, be.strerror());
1744 update_pos_dev(dev);
1749 * Backward space a record
1750 * Returns: false on failure
1754 bsr_dev(DEVICE *dev, int num)
1760 dev->dev_errno = EBADF;
1761 Mmsg0(dev->errmsg, _("Bad call to bsr_dev. Archive not open\n"));
1762 Emsg0(M_FATAL, 0, dev->errmsg);
1766 if (!dev->is_tape()) {
1770 if (!dev_cap(dev, CAP_BSR)) {
1771 Mmsg1(dev->errmsg, _("ioctl MTBSR not permitted on %s.\n"), dev->dev_name);
1775 Dmsg0(29, "bsr_dev\n");
1776 dev->block_num -= num;
1777 dev->state &= ~(ST_EOF|ST_EOT|ST_EOF);
1778 mt_com.mt_op = MTBSR;
1779 mt_com.mt_count = num;
1780 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1783 clrerror_dev(dev, MTBSR);
1784 Mmsg2(dev->errmsg, _("ioctl MTBSR error on %s. ERR=%s.\n"),
1785 dev->dev_name, be.strerror());
1787 update_pos_dev(dev);
1792 * Reposition the device to file, block
1793 * Returns: false on failure
1797 reposition_dev(DEVICE *dev, uint32_t file, uint32_t block)
1800 dev->dev_errno = EBADF;
1801 Mmsg0(dev->errmsg, _("Bad call to reposition_dev. Archive not open\n"));
1802 Emsg0(M_FATAL, 0, dev->errmsg);
1806 if (!dev->is_tape()) {
1807 off_t pos = (((off_t)file)<<32) + block;
1808 Dmsg1(100, "===== lseek_dev to %d\n", (int)pos);
1809 if (lseek_dev(dev, pos, SEEK_SET) == (off_t)-1) {
1811 dev->dev_errno = errno;
1812 Mmsg2(dev->errmsg, _("lseek_dev error on %s. ERR=%s.\n"),
1813 dev->dev_name, be.strerror());
1817 dev->block_num = block;
1818 dev->file_addr = pos;
1821 Dmsg4(100, "reposition_dev from %u:%u to %u:%u\n",
1822 dev->file, dev->block_num, file, block);
1823 if (file < dev->file) {
1824 Dmsg0(100, "Rewind_dev\n");
1825 if (!rewind_dev(dev)) {
1829 if (file > dev->file) {
1830 Dmsg1(100, "fsf %d\n", file-dev->file);
1831 if (!fsf_dev(dev, file-dev->file)) {
1832 Dmsg1(100, "fsf failed! ERR=%s\n", strerror_dev(dev));
1835 Dmsg2(100, "wanted_file=%d at_file=%d\n", file, dev->file);
1837 if (block < dev->block_num) {
1838 Dmsg2(100, "wanted_blk=%d at_blk=%d\n", block, dev->block_num);
1839 Dmsg0(100, "bsf_dev 1\n");
1841 Dmsg0(100, "fsf_dev 1\n");
1843 Dmsg2(100, "wanted_blk=%d at_blk=%d\n", block, dev->block_num);
1845 if (dev_cap(dev, CAP_POSITIONBLOCKS) && block > dev->block_num) {
1846 /* Ignore errors as Bacula can read to the correct block */
1847 Dmsg1(100, "fsr %d\n", block-dev->block_num);
1848 return fsr_dev(dev, block-dev->block_num);
1856 * Write an end of file on the device
1857 * Returns: 0 on success
1858 * non-zero on failure
1861 weof_dev(DEVICE *dev, int num)
1865 Dmsg0(29, "weof_dev\n");
1868 dev->dev_errno = EBADF;
1869 Mmsg0(dev->errmsg, _("Bad call to weof_dev. Archive drive not open\n"));
1870 Emsg0(M_FATAL, 0, dev->errmsg);
1875 if (!dev->is_tape()) {
1878 if (!dev->can_append()) {
1879 Mmsg0(dev->errmsg, _("Attempt to WEOF on non-appendable Volume\n"));
1880 Emsg0(M_FATAL, 0, dev->errmsg);
1884 dev->state &= ~(ST_EOT | ST_EOF); /* remove EOF/EOT flags */
1885 mt_com.mt_op = MTWEOF;
1886 mt_com.mt_count = num;
1887 stat = ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
1894 clrerror_dev(dev, MTWEOF);
1896 Mmsg2(dev->errmsg, _("ioctl MTWEOF error on %s. ERR=%s.\n"),
1897 dev->dev_name, be.strerror());
1904 * Return string message with last error in English
1905 * Be careful not to call this routine from within dev.c
1906 * while editing an Mmsg() or you will end up in a recursive
1907 * loop creating a Segmentation Violation.
1910 strerror_dev(DEVICE *dev)
1917 * If implemented in system, clear the tape
1921 clrerror_dev(DEVICE *dev, int func)
1923 const char *msg = NULL;
1924 struct mtget mt_stat;
1927 dev->dev_errno = errno; /* save errno */
1929 dev->VolCatInfo.VolCatErrors++;
1932 if (!dev->is_tape()) {
1935 if (errno == ENOTTY || errno == ENOSYS) { /* Function not implemented */
1938 Emsg0(M_ABORT, 0, "Got ENOTTY on read/write!\n");
1942 dev->capabilities &= ~CAP_EOF; /* turn off feature */
1947 dev->capabilities &= ~CAP_EOM; /* turn off feature */
1952 dev->capabilities &= ~CAP_FSF; /* turn off feature */
1956 dev->capabilities &= ~CAP_BSF; /* turn off feature */
1960 dev->capabilities &= ~CAP_FSR; /* turn off feature */
1964 dev->capabilities &= ~CAP_BSR; /* turn off feature */
1985 bsnprintf(buf, sizeof(buf), "unknown func code %d", func);
1990 dev->dev_errno = ENOSYS;
1991 Mmsg1(dev->errmsg, _("I/O function \"%s\" not supported on this device.\n"), msg);
1992 Emsg0(M_ERROR, 0, dev->errmsg);
1995 /* On some systems such as NetBSD, this clears all errors */
1996 ioctl(dev->fd, MTIOCGET, (char *)&mt_stat);
1998 /* Found on Linux */
2002 mt_com.mt_op = MTIOCLRERR;
2003 mt_com.mt_count = 1;
2004 /* Clear any error condition on the tape */
2005 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
2006 Dmsg0(200, "Did MTIOCLRERR\n");
2010 /* Typically on FreeBSD */
2013 /* Read and clear SCSI error status */
2014 union mterrstat mt_errstat;
2015 Dmsg2(200, "Doing MTIOCERRSTAT errno=%d ERR=%s\n", dev->dev_errno,
2016 strerror(dev->dev_errno));
2017 ioctl(dev->fd, MTIOCERRSTAT, (char *)&mt_errstat);
2021 /* Clear Subsystem Exception OSF1 */
2025 mt_com.mt_op = MTCSE;
2026 mt_com.mt_count = 1;
2027 /* Clear any error condition on the tape */
2028 ioctl(dev->fd, MTIOCTOP, (char *)&mt_com);
2029 Dmsg0(200, "Did MTCSE\n");
2035 * Flush buffer contents
2038 int flush_dev(DEVICE *dev)
2043 static void do_close(DEVICE *dev)
2046 Dmsg1(29, "really close_dev %s\n", dev->dev_name);
2050 if (dev_cap(dev, CAP_REQMOUNT)) {
2051 if (unmount_dev(dev, 1) < 0) {
2052 Dmsg1(0, "Cannot unmount device %s.\n", dev->dev_name);
2056 /* Remove the last part file if it is empty */
2057 if (dev->can_append() && (dev->num_parts > 0)) {
2059 POOL_MEM archive_name(PM_FNAME);
2060 dev->part = dev->num_parts;
2061 get_filename(dev, dev->VolCatInfo.VolCatName, archive_name);
2062 /* Check that the part file is empty */
2063 if ((stat(archive_name.c_str(), &statp) == 0) && (statp.st_size == 0)) {
2064 unlink(archive_name.c_str());
2068 /* Clean up device packet so it can be reused */
2070 dev->state &= ~(ST_OPENED|ST_LABEL|ST_READ|ST_APPEND|ST_EOT|ST_WEOT|ST_EOF);
2071 dev->label_type = B_BACULA_LABEL;
2072 dev->file = dev->block_num = 0;
2077 dev->part_start = 0;
2078 dev->EndFile = dev->EndBlock = 0;
2079 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
2080 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
2082 stop_thread_timer(dev->tid);
2092 close_dev(DEVICE *dev)
2095 Mmsg0(&dev->errmsg, _("Bad call to close_dev. Archive not open\n"));
2096 Emsg0(M_FATAL, 0, dev->errmsg);
2099 /*if (dev->fd >= 0 && dev->use_count == 1) {*/
2100 /* No need to check if dev->fd >= 0: it is checked again
2101 * in do_close, and do_close MUST be called for volumes
2102 * splitted in parts, even if dev->fd == -1. */
2103 if (dev->use_count == 1) {
2105 } else if (dev->use_count > 0) {
2110 ASSERT(dev->use_count >= 0);
2115 * Used when unmounting the device, ignore use_count
2117 void force_close_dev(DEVICE *dev)
2120 Mmsg0(&dev->errmsg, _("Bad call to force_close_dev. Archive not open\n"));
2121 Emsg0(M_FATAL, 0, dev->errmsg);
2124 Dmsg1(29, "Force close_dev %s\n", dev->dev_name);
2128 ASSERT(dev->use_count >= 0);
2132 bool truncate_dev(DEVICE *dev)
2134 Dmsg1(100, "truncate_dev %s\n", dev->dev_name);
2135 if (dev->is_tape()) {
2136 return true; /* we don't really truncate tapes */
2137 /* maybe we should rewind and write and eof ???? */
2140 /* If there is more than one part, open the first one, and then truncate it. */
2141 if (dev->num_parts > 0) {
2143 dev->VolCatInfo.VolCatParts = 0;
2144 if (open_first_part(dev) < 0) {
2146 Mmsg1(&dev->errmsg, "Unable to truncate device, because I'm unable to open the first part. ERR=%s\n", be.strerror());
2150 if (ftruncate(dev->fd, 0) != 0) {
2152 Mmsg1(&dev->errmsg, _("Unable to truncate device. ERR=%s\n"), be.strerror());
2159 dev_is_tape(DEVICE *dev)
2161 return dev->is_tape() ? true : false;
2166 * return 1 if the device is read for write, and 0 otherwise
2167 * This is meant for checking at the end of a job to see
2168 * if we still have a tape (perhaps not if at end of tape
2169 * and the job is canceled).
2172 dev_can_write(DEVICE *dev)
2174 if (dev->is_open() && dev->can_append() &&
2175 dev->is_labeled() && !(dev->state & ST_WEOT)) {
2183 dev_name(DEVICE *dev)
2185 return dev->dev_name;
2189 dev_vol_name(DEVICE *dev)
2191 return dev->VolCatInfo.VolCatName;
2194 uint32_t dev_block(DEVICE *dev)
2196 update_pos_dev(dev);
2197 return dev->block_num;
2200 uint32_t dev_file(DEVICE *dev)
2202 update_pos_dev(dev);
2207 * Free memory allocated for the device
2210 term_dev(DEVICE *dev)
2213 dev->dev_errno = EBADF;
2214 Mmsg0(&dev->errmsg, _("Bad call to term_dev. Archive not open\n"));
2215 Emsg0(M_FATAL, 0, dev->errmsg);
2219 Dmsg0(29, "term_dev\n");
2220 if (dev->dev_name) {
2221 free_memory(dev->dev_name);
2222 dev->dev_name = NULL;
2225 free_pool_memory(dev->errmsg);
2228 pthread_mutex_destroy(&dev->mutex);
2229 pthread_cond_destroy(&dev->wait);
2230 pthread_cond_destroy(&dev->wait_next_vol);
2231 pthread_mutex_destroy(&dev->spool_mutex);
2232 rwl_destroy(&dev->lock);
2233 if (dev->attached_dcrs) {
2234 delete dev->attached_dcrs;
2235 dev->attached_dcrs = NULL;
2237 if (dev->state & ST_MALLOC) {
2238 free_pool_memory((POOLMEM *)dev);
2243 * This routine initializes the device wait timers
2245 void init_dev_wait_timers(DEVICE *dev)
2247 /* ******FIXME******* put these on config variables */
2248 dev->min_wait = 60 * 60;
2249 dev->max_wait = 24 * 60 * 60;
2250 dev->max_num_wait = 9; /* 5 waits =~ 1 day, then 1 day at a time */
2251 dev->wait_sec = dev->min_wait;
2252 dev->rem_wait_sec = dev->wait_sec;
2255 dev->BadVolName[0] = 0;
2259 * Returns: true if time doubled
2260 * false if max time expired
2262 bool double_dev_wait_time(DEVICE *dev)
2264 dev->wait_sec *= 2; /* double wait time */
2265 if (dev->wait_sec > dev->max_wait) { /* but not longer than maxtime */
2266 dev->wait_sec = dev->max_wait;
2269 dev->rem_wait_sec = dev->wait_sec;
2270 if (dev->num_wait >= dev->max_num_wait) {
2276 void set_os_device_parameters(DEVICE *dev)
2278 #ifdef HAVE_LINUX_OS
2280 if (dev->min_block_size == dev->max_block_size &&
2281 dev->min_block_size == 0) { /* variable block mode */
2282 mt_com.mt_op = MTSETBLK;
2283 mt_com.mt_count = 0;
2284 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
2285 clrerror_dev(dev, MTSETBLK);
2287 mt_com.mt_op = MTSETDRVBUFFER;
2288 mt_com.mt_count = MT_ST_CLEARBOOLEANS;
2289 if (!dev_cap(dev, CAP_TWOEOF)) {
2290 mt_com.mt_count |= MT_ST_TWO_FM;
2292 if (dev_cap(dev, CAP_EOM)) {
2293 mt_com.mt_count |= MT_ST_FAST_MTEOM;
2295 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
2296 clrerror_dev(dev, MTSETBLK);
2302 #ifdef HAVE_NETBSD_OS
2304 if (dev->min_block_size == dev->max_block_size &&
2305 dev->min_block_size == 0) { /* variable block mode */
2306 mt_com.mt_op = MTSETBSIZ;
2307 mt_com.mt_count = 0;
2308 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
2309 clrerror_dev(dev, MTSETBSIZ);
2311 /* Get notified at logical end of tape */
2312 mt_com.mt_op = MTEWARN;
2313 mt_com.mt_count = 1;
2314 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
2315 clrerror_dev(dev, MTEWARN);
2321 #if HAVE_FREEBSD_OS || HAVE_OPENBSD_OS
2323 if (dev->min_block_size == dev->max_block_size &&
2324 dev->min_block_size == 0) { /* variable block mode */
2325 mt_com.mt_op = MTSETBSIZ;
2326 mt_com.mt_count = 0;
2327 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
2328 clrerror_dev(dev, MTSETBSIZ);
2336 if (dev->min_block_size == dev->max_block_size &&
2337 dev->min_block_size == 0) { /* variable block mode */
2338 mt_com.mt_op = MTSRSZ;
2339 mt_com.mt_count = 0;
2340 if (ioctl(dev->fd, MTIOCTOP, (char *)&mt_com) < 0) {
2341 clrerror_dev(dev, MTSRSZ);
2349 * Edit codes into (Un)MountCommand, Write(First)PartCommand
2351 * %a = archive device name
2353 * %v = last part name
2355 * omsg = edited output message
2356 * imsg = input string containing edit codes (%x)
2359 char *edit_device_codes_dev(DEVICE* dev, char *omsg, const char *imsg)
2365 POOL_MEM archive_name(PM_FNAME);
2366 get_filename(dev, dev->VolCatInfo.VolCatName, archive_name);
2369 Dmsg1(800, "edit_device_codes: %s\n", imsg);
2370 for (p=imsg; *p; p++) {
2377 bsnprintf(add, sizeof(add), "%d", dev->part);
2381 str = dev->dev_name;
2384 str = dev->device->mount_point;
2387 str = archive_name.c_str();
2401 Dmsg1(900, "add_str %s\n", str);
2402 pm_strcat(&omsg, (char *)str);
2403 Dmsg1(800, "omsg=%s\n", omsg);