2 Bacula® - The Network Backup Solution
4 Copyright (C) 2002-2008 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 * Routines for handling mounting tapes for reading and for
33 * Kern Sibbald, August MMII
38 #include "bacula.h" /* pull in global headers */
39 #include "stored.h" /* pull in Storage Deamon headers */
57 * If release is set, we rewind the current volume,
58 * which we no longer want, and ask the user (console)
59 * to mount the next volume.
61 * Continue trying until we get it, and then ensure
62 * that we can write on it.
64 * This routine returns a 0 only if it is REALLY
65 * impossible to get the requested Volume.
68 bool DCR::mount_next_write_volume()
71 bool ask = false, recycle, autochanger;
76 Dmsg2(150, "Enter mount_next_volume(release=%d) dev=%s\n", dev->must_unload(),
79 init_device_wait_timers(dcr);
83 * Attempt to mount the next volume. If something non-fatal goes
84 * wrong, we come back here to re-try (new op messages, re-read
88 Dmsg1(150, "mount_next_vol retry=%d\n", retry);
89 /* Ignore retry if this is poll request */
90 if (!dev->poll && retry++ > 4) {
91 /* Last ditch effort before giving up, force operator to respond */
94 if (!dir_ask_sysop_to_mount_volume(dcr, ST_APPEND)) {
95 Jmsg(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"),
97 goto no_lock_bail_out;
100 Dmsg1(150, "Continue after dir_ask_sysop_to_mount. must_load=%d\n", dev->must_load());
102 if (job_canceled(jcr)) {
103 Jmsg(jcr, M_FATAL, 0, _("Job %d canceled.\n"), jcr->JobId);
112 if (dev->must_unload()) {
113 ask = true; /* ask operator to mount tape */
114 do_find = true; /* re-find a volume after unload */
116 do_swapping(true /*writing*/);
118 if (do_find && !find_a_volume()) {
119 goto no_lock_bail_out;
122 if (job_canceled(jcr)) {
125 Dmsg3(150, "After find_next_append. Vol=%s Slot=%d Parts=%d\n",
126 VolCatInfo.VolCatName, VolCatInfo.Slot, VolCatInfo.VolCatParts);
129 * Get next volume and ready it for append
130 * This code ensures that the device is ready for
131 * writing. We start from the assumption that there
132 * may not be a tape mounted.
134 * If the device is a file, we create the output
135 * file. If it is a tape, we check the volume name
136 * and move the tape to the end of data.
139 if (autoload_device(dcr, true/*writing*/, NULL) > 0) {
147 Dmsg1(150, "autoload_dev returns %d\n", autochanger);
149 * If we autochanged to correct Volume or (we have not just
150 * released the Volume AND we can automount) we go ahead
151 * and read the label. If there is no tape in the drive,
152 * we will fail, recurse and ask the operator the next time.
154 if (!dev->must_unload() && dev->is_tape() && dev->has_cap(CAP_AUTOMOUNT)) {
155 Dmsg0(250, "(1)Ask=0\n");
156 ask = false; /* don't ask SYSOP this time */
158 /* Don't ask if not removable */
159 if (!dev->is_removable()) {
160 Dmsg0(250, "(2)Ask=0\n");
163 Dmsg2(250, "Ask=%d autochanger=%d\n", ask, autochanger);
167 if (!dir_ask_sysop_to_mount_volume(dcr, ST_APPEND)) {
168 Dmsg0(150, "Error return ask_sysop ...\n");
169 goto no_lock_bail_out;
173 if (job_canceled(jcr)) {
176 Dmsg3(150, "want vol=%s devvol=%s dev=%s\n", VolumeName,
177 dev->VolHdr.VolumeName, dev->print_name());
179 if (dev->poll && dev->has_cap(CAP_CLOSEONPOLL)) {
183 /* Ensure the device is open */
184 if (dev->has_cap(CAP_STREAM)) {
185 mode = OPEN_WRITE_ONLY;
187 mode = OPEN_READ_WRITE;
189 /* Try autolabel if enabled */
190 if (dev->open(dcr, mode) < 0) {
191 try_autolabel(false); /* try to create a new volume label */
193 while (dev->open(dcr, mode) < 0) {
194 Dmsg1(150, "open_device failed: ERR=%s\n", dev->bstrerror());
195 if ((dev->is_file() && dev->is_removable()) || dev->is_dvd()) {
197 Dmsg0(150, "call scan_dir_for_vol\n");
199 if (!dev->mount(0)) {
203 if (ok && dev->scan_dir_for_volume(dcr)) {
204 if (dev->open(dcr, mode) >= 0) {
205 break; /* got a valid volume */
208 if (ok && dev->is_dvd()) {
212 if (try_autolabel(false) == try_read_vol) {
213 break; /* created a new volume label */
215 Dmsg0(50, "set_unload\n");
216 dev->set_unload(); /* force ask sysop */
218 Dmsg0(150, "goto mount_next_vol\n");
223 * Now check the volume label to make sure we have the right tape mounted
226 switch (check_volume_label(ask, autochanger)) {
228 Dmsg0(50, "set_unload\n");
229 dev->set_unload(); /* want a different Volume */
230 Dmsg0(150, "goto mount_next_vol\n");
241 * See if we have a fresh tape or a tape with data.
243 * Note, if the LabelType is PRE_LABEL, it was labeled
244 * but never written. If so, rewrite the label but set as
245 * VOL_LABEL. We rewind and return the label (reconstructed)
246 * in the block so that in the case of a new tape, data can
247 * be appended just after the block label. If we are writing
248 * a second volume, the calling routine will write the label
249 * before writing the overflow block.
251 * If the tape is marked as Recycle, we rewrite the label.
253 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
254 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
255 if (!rewrite_volume_label(dcr, recycle)) {
256 mark_volume_in_error();
261 * OK, at this point, we have a valid Bacula label, but
262 * we need to position to the end of the volume, since we are
263 * just now putting it into append mode.
265 Dmsg0(200, "Device previously written, moving to end of data\n");
266 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
269 if (!dev->eod(dcr)) {
270 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device %s: ERR=%s\n"),
271 dev->print_name(), dev->bstrerror());
272 mark_volume_in_error();
275 if (!is_eod_valid()) {
276 Dmsg0(150, "goto mount_next_vol\n");
280 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
281 Dmsg1(150, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
282 if (!dir_update_volume_info(dcr, false, false)) {
286 /* Return an empty block */
287 empty_block(block); /* we used it for reading so set for write */
290 Dmsg1(150, "set APPEND, normal return from mount_next_write_volume. dev=%s\n",
304 * This routine is meant to be called once the first pass
305 * to ensure that we have a candidate volume to mount.
306 * Otherwise, we ask the sysop to created one.
308 bool DCR::find_a_volume()
311 if (!is_suitable_volume_mounted()) {
312 bool have_vol = false;
313 /* Do we have a candidate volume? */
315 bstrncpy(VolumeName, dev->vol->vol_name, sizeof(VolumeName));
316 have_vol = dir_get_volume_info(this, GET_VOL_INFO_FOR_WRITE);
319 * Get Director's idea of what tape we should have mounted.
323 Dmsg0(200, "Before dir_find_next_appendable_volume.\n");
324 while (!dir_find_next_appendable_volume(dcr)) {
325 Dmsg0(200, "not dir_find_next\n");
326 if (job_canceled(jcr)) {
331 if (!dir_ask_sysop_to_create_appendable_volume(dcr)) {
335 Dmsg0(150, "Again dir_find_next_append...\n");
342 int DCR::check_volume_label(bool &ask, bool &autochanger)
344 int vol_label_status;
346 * If we are writing to a stream device, ASSUME the volume label
349 if (dev->has_cap(CAP_STREAM)) {
350 vol_label_status = VOL_OK;
351 create_volume_label(dev, VolumeName, "Default", false /* not DVD */);
352 dev->VolHdr.LabelType = PRE_LABEL;
354 vol_label_status = read_dev_volume_label(this);
356 if (job_canceled(jcr)) {
360 Dmsg2(150, "Want dirVol=%s dirStat=%s\n", VolumeName,
361 VolCatInfo.VolCatStatus);
363 * At this point, dev->VolCatInfo has what is in the drive, if anything,
364 * and dcr->VolCatInfo has what the Director wants.
366 switch (vol_label_status) {
368 Dmsg1(150, "Vol OK name=%s\n", dev->VolHdr.VolumeName);
369 dev->VolCatInfo = VolCatInfo; /* structure assignment */
370 break; /* got a Volume */
372 VOLUME_CAT_INFO dcrVolCatInfo, devVolCatInfo;
373 char saveVolumeName[MAX_NAME_LENGTH];
375 Dmsg2(150, "Vol NAME Error Have=%s, want=%s\n", dev->VolHdr.VolumeName, VolumeName);
376 if (dev->is_volume_to_unload()) {
378 goto check_next_volume;
381 /* If not removable, Volume is broken */
382 if (!dev->is_removable()) {
383 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
384 VolumeName, dev->print_name());
385 mark_volume_in_error();
386 goto check_next_volume;
390 * OK, we got a different volume mounted. First save the
391 * requested Volume info (dcr) structure, then query if
392 * this volume is really OK. If not, put back the desired
393 * volume name, mark it not in changer and continue.
395 dcrVolCatInfo = VolCatInfo; /* structure assignment */
396 devVolCatInfo = dev->VolCatInfo; /* structure assignment */
397 /* Check if this is a valid Volume in the pool */
398 bstrncpy(saveVolumeName, VolumeName, sizeof(saveVolumeName));
399 bstrncpy(VolumeName, dev->VolHdr.VolumeName, sizeof(VolumeName));
400 if (!dir_get_volume_info(this, GET_VOL_INFO_FOR_WRITE)) {
401 POOL_MEM vol_info_msg;
402 pm_strcpy(vol_info_msg, jcr->dir_bsock->msg); /* save error message */
403 /* Restore desired volume name, note device info out of sync */
404 /* This gets the info regardless of the Pool */
405 bstrncpy(VolumeName, dev->VolHdr.VolumeName, sizeof(VolumeName));
406 if (autochanger && !dir_get_volume_info(this, GET_VOL_INFO_FOR_READ)) {
408 * If we get here, we know we cannot write on the Volume,
409 * and we know that we cannot read it either, so it
410 * is not in the autochanger.
412 mark_volume_not_inchanger();
414 dev->VolCatInfo = devVolCatInfo; /* structure assignment */
415 dev->set_unload(); /* unload this volume */
416 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
417 " Current Volume \"%s\" not acceptable because:\n"
419 dcrVolCatInfo.VolCatName, dev->VolHdr.VolumeName,
420 vol_info_msg.c_str());
422 /* Restore saved DCR before continuing */
423 bstrncpy(VolumeName, saveVolumeName, sizeof(VolumeName));
424 VolCatInfo = dcrVolCatInfo; /* structure assignment */
425 goto check_next_volume;
428 * This was not the volume we expected, but it is OK with
429 * the Director, so use it.
431 Dmsg1(150, "Got new Volume name=%s\n", VolumeName);
432 dev->VolCatInfo = VolCatInfo; /* structure assignment */
433 Dmsg1(100, "Call reserve_volume=%s\n", dev->VolHdr.VolumeName);
434 if (reserve_volume(this, dev->VolHdr.VolumeName) == NULL) {
435 Jmsg2(jcr, M_WARNING, 0, _("Could not reserve volume %s on %s\n"),
436 dev->VolHdr.VolumeName, dev->print_name());
438 goto check_next_volume;
440 break; /* got a Volume */
442 * At this point, we assume we have a blank tape mounted.
446 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
447 mark_volume_in_error();
448 goto check_bail_out; /* we could not write on DVD */
450 /* Fall through wanted */
452 switch (try_autolabel(true)) {
454 goto check_next_volume;
456 goto check_read_volume;
463 /* NOTE! Fall-through wanted. */
466 Dmsg0(200, "VOL_NO_MEDIA or default.\n");
467 /* Send error message */
470 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
473 /* Needed, so the medium can be changed */
474 if (dev->requires_mount()) {
477 goto check_next_volume;
482 return check_next_vol;
488 return check_read_vol;
493 bool DCR::is_suitable_volume_mounted()
495 /* Volume mounted? */
496 if (dev->VolHdr.VolumeName[0] == 0 || dev->swap_dev || dev->must_unload()) {
497 return false; /* no */
499 bstrncpy(VolumeName, dev->VolHdr.VolumeName, sizeof(VolumeName));
500 return dir_get_volume_info(this, GET_VOL_INFO_FOR_WRITE);
503 void DCR::do_swapping(bool is_writing)
505 if (dev->must_unload()) {
506 Dmsg1(100, "must_unload release %s\n", dev->print_name());
510 * See if we are asked to swap the Volume from another device
511 * if so, unload the other device here, and attach the
512 * volume to our drive.
515 if (dev->swap_dev->must_unload()) {
517 dev->swap_dev->set_slot(dev->vol->get_slot());
519 Dmsg2(100, "Swap unloading slot=%d %s\n", dev->swap_dev->get_slot(),
520 dev->swap_dev->print_name());
521 unload_dev(this, dev->swap_dev);
524 dev->vol->clear_swapping();
525 Dmsg1(100, "=== set in_use vol=%s\n", dev->vol->vol_name);
526 dev->vol->set_in_use();
527 dev->VolHdr.VolumeName[0] = 0; /* don't yet have right Volume */
529 dev->swap_dev = NULL;
531 if (dev->must_load()) {
532 Dmsg1(100, "Must load %s\n", dev->print_name());
533 if (autoload_device(this, is_writing, NULL) > 0) {
541 * Check if the current position on the volume corresponds to
542 * what is in the catalog.
544 bool DCR::is_eod_valid()
547 char ed1[50], ed2[50];
548 if (dev->VolCatInfo.VolCatBytes == dev->part_start + dev->part_size) {
549 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\""
550 " part=%d size=%s\n"), VolumeName,
551 dev->part, edit_uint64(dev->VolCatInfo.VolCatBytes,ed1));
553 Jmsg(jcr, M_ERROR, 0, _("Bacula cannot write on DVD Volume \"%s\" because: "
554 "The sizes do not match! Volume=%s Catalog=%s\n"),
556 edit_uint64(dev->part_start + dev->part_size, ed1),
557 edit_uint64(dev->VolCatInfo.VolCatBytes, ed2));
558 mark_volume_in_error();
561 } else if (dev->is_tape()) {
563 * Check if we are positioned on the tape at the same place
564 * that the database says we should be.
566 if (dev->VolCatInfo.VolCatFiles == dev->get_file()) {
567 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
568 VolumeName, dev->get_file());
570 Jmsg(jcr, M_ERROR, 0, _("Bacula cannot write on tape Volume \"%s\" because:\n"
571 "The number of files mismatch! Volume=%u Catalog=%u\n"),
572 VolumeName, dev->get_file(), dev->VolCatInfo.VolCatFiles);
573 mark_volume_in_error();
576 } else if (dev->is_file()) {
577 char ed1[50], ed2[50];
579 pos = dev->lseek(this, (boffset_t)0, SEEK_END);
580 if (dev->VolCatInfo.VolCatBytes == (uint64_t)pos) {
581 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\""
582 " size=%s\n"), VolumeName,
583 edit_uint64(dev->VolCatInfo.VolCatBytes, ed1));
585 Jmsg(jcr, M_ERROR, 0, _("Bacula cannot write on disk Volume \"%s\" because: "
586 "The sizes do not match! Volume=%s Catalog=%s\n"),
588 edit_uint64(pos, ed1),
589 edit_uint64(dev->VolCatInfo.VolCatBytes, ed2));
590 mark_volume_in_error();
599 * If permitted, we label the device, make sure we can do
600 * it by checking that the VolCatBytes is zero => not labeled,
601 * once the Volume is labeled we don't want to label another
602 * blank tape with the same name. For disk, we go ahead and
603 * label it anyway, because the OS insures that there is only
604 * one Volume with that name.
605 * As noted above, at this point dcr->VolCatInfo has what
606 * the Director wants and dev->VolCatInfo has info on the
607 * previous tape (or nothing).
610 * try_next_vol label failed, look for another volume
611 * try_read_vol labeled volume, now re-read the label
612 * try_error hard error (catalog update)
613 * try_default I couldn't do anything
615 int DCR::try_autolabel(bool opened)
619 if (dev->poll && !dev->is_tape()) {
620 return try_default; /* if polling, don't try to create new labels */
622 /* For a tape require it to be opened and read before labeling */
623 if (!opened && dev->is_tape()) {
626 if (dev->has_cap(CAP_LABEL) && (VolCatInfo.VolCatBytes == 0 ||
627 (!dev->is_tape() && strcmp(VolCatInfo.VolCatStatus,
629 Dmsg0(150, "Create volume label\n");
630 /* Create a new Volume label and write it to the device */
631 if (!write_new_volume_label_to_dev(dcr, VolumeName,
632 pool_name, false, /* no relabel */ false /* defer DVD label */)) {
633 Dmsg2(150, "write_vol_label failed. vol=%s, pool=%s\n",
634 VolumeName, pool_name);
636 mark_volume_in_error();
640 Dmsg0(150, "dir_update_vol_info. Set Append\n");
641 /* Copy Director's info into the device info */
642 dev->VolCatInfo = VolCatInfo; /* structure assignment */
643 if (!dir_update_volume_info(dcr, true, true)) { /* indicate tape labeled */
646 Jmsg(dcr->jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
647 VolumeName, dev->print_name());
648 return try_read_vol; /* read label we just wrote */
650 if (!dev->has_cap(CAP_LABEL) && VolCatInfo.VolCatBytes == 0) {
651 Jmsg(jcr, M_WARNING, 0, _("Device %s not configured to autolabel Volumes.\n"),
654 /* If not removable, Volume is broken */
655 if (!dev->is_removable()) {
656 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
657 VolumeName, dev->print_name());
658 mark_volume_in_error();
666 * Mark volume in error in catalog
668 void DCR::mark_volume_in_error()
670 Jmsg(jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
672 dev->VolCatInfo = VolCatInfo; /* structure assignment */
673 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
674 Dmsg0(150, "dir_update_vol_info. Set Error.\n");
675 dir_update_volume_info(this, false, false);
677 Dmsg0(50, "set_unload\n");
678 dev->set_unload(); /* must get a new volume */
682 * The Volume is not in the correct slot, so mark this
683 * Volume as not being in the Changer.
685 void DCR::mark_volume_not_inchanger()
687 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
688 " Setting InChanger to zero in catalog.\n"),
689 VolCatInfo.VolCatName, VolCatInfo.Slot);
690 dev->VolCatInfo = VolCatInfo; /* structure assignment */
691 VolCatInfo.InChanger = false;
692 dev->VolCatInfo.InChanger = false;
693 Dmsg0(400, "update vol info in mount\n");
694 dir_update_volume_info(this, true, false); /* set new status */
698 * Either because we are going to hang a new volume, or because
699 * of explicit user request, we release the current volume.
701 void DCR::release_volume()
703 unload_autochanger(this, -1);
706 Jmsg0(jcr, M_ERROR, 0, _("Hey!!!!! WroteVol non-zero !!!!!\n"));
707 Pmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
710 * First erase all memory of the current volume
713 dev->block_num = dev->file = 0;
714 dev->EndBlock = dev->EndFile = 0;
715 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
717 /* Force re-read of label */
718 dev->clear_labeled();
721 dev->label_type = B_BACULA_LABEL;
724 if (dev->is_open() && (!dev->is_tape() || !dev->has_cap(CAP_ALWAYSOPEN))) {
728 /* If we have not closed the device, then at least rewind the tape */
729 if (dev->is_open()) {
730 dev->offline_or_rewind();
732 // Dmsg0(50, "set_unload\n");
733 // dev->set_unload();
734 Dmsg0(190, "release_volume\n");
740 * Check to see if the tape position as defined by the OS is
741 * the same as our concept. If it is not,
742 * it means the user has probably manually rewound the tape.
743 * Note, we check only if num_writers == 0, but this code will
744 * also work fine for any number of writers. If num_writers > 0,
745 * we probably should cancel all jobs using this device, or
746 * perhaps even abort the SD, or at a minimum, mark the tape
747 * in error. Another strategy with num_writers == 0, would be
748 * to rewind the tape and do a new eod() request.
750 bool DCR::is_tape_position_ok()
752 if (dev->is_tape() && dev->num_writers == 0) {
753 int32_t file = dev->get_os_tape_file();
754 if (file >= 0 && file != (int32_t)dev->get_file()) {
755 Jmsg(jcr, M_ERROR, 0, _("Invalid tape position on volume \"%s\""
756 " on device %s. Expected %d, got %d\n"),
757 dev->VolHdr.VolumeName, dev->print_name(), dev->get_file(), file);
759 * If the current file is greater than zero, it means we probably
760 * have some bad count of EOF marks, so mark tape in error. Otherwise
761 * the operator might have moved the tape, so we just release it
765 mark_volume_in_error();
776 * If we are reading, we come here at the end of the tape
777 * and see if there are more volumes to be mounted.
779 bool mount_next_read_volume(DCR *dcr)
781 DEVICE *dev = dcr->dev;
783 Dmsg2(90, "NumReadVolumes=%d CurReadVolume=%d\n", jcr->NumReadVolumes, jcr->CurReadVolume);
785 volume_unused(dcr); /* release current volume */
787 * End Of Tape -- mount next Volume (if another specified)
789 if (jcr->NumReadVolumes > 1 && jcr->CurReadVolume < jcr->NumReadVolumes) {
791 if (!acquire_device_for_read(dcr)) {
792 Jmsg2(jcr, M_FATAL, 0, _("Cannot open Dev=%s, Vol=%s\n"), dev->print_name(),
796 return true; /* next volume mounted */
798 Dmsg0(90, "End of Device reached.\n");