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 Kern Sibbald.
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 */
117 do_swapping(true /*is_writing*/);
118 do_load(true /*is_writing*/);
120 if (do_find && !find_a_volume()) {
121 goto no_lock_bail_out;
124 if (job_canceled(jcr)) {
127 Dmsg3(150, "After find_next_append. Vol=%s Slot=%d Parts=%d\n",
128 VolCatInfo.VolCatName, VolCatInfo.Slot, VolCatInfo.VolCatParts);
131 * Get next volume and ready it for append
132 * This code ensures that the device is ready for
133 * writing. We start from the assumption that there
134 * may not be a tape mounted.
136 * If the device is a file, we create the output
137 * file. If it is a tape, we check the volume name
138 * and move the tape to the end of data.
141 if (autoload_device(dcr, true/*writing*/, NULL) > 0) {
149 Dmsg1(150, "autoload_dev returns %d\n", autochanger);
151 * If we autochanged to correct Volume or (we have not just
152 * released the Volume AND we can automount) we go ahead
153 * and read the label. If there is no tape in the drive,
154 * we will fail, recurse and ask the operator the next time.
156 if (!dev->must_unload() && dev->is_tape() && dev->has_cap(CAP_AUTOMOUNT)) {
157 Dmsg0(250, "(1)Ask=0\n");
158 ask = false; /* don't ask SYSOP this time */
160 /* Don't ask if not removable */
161 if (!dev->is_removable()) {
162 Dmsg0(250, "(2)Ask=0\n");
165 Dmsg2(250, "Ask=%d autochanger=%d\n", ask, autochanger);
169 if (!dir_ask_sysop_to_mount_volume(dcr, ST_APPEND)) {
170 Dmsg0(150, "Error return ask_sysop ...\n");
171 goto no_lock_bail_out;
175 if (job_canceled(jcr)) {
178 Dmsg3(150, "want vol=%s devvol=%s dev=%s\n", VolumeName,
179 dev->VolHdr.VolumeName, dev->print_name());
181 if (dev->poll && dev->has_cap(CAP_CLOSEONPOLL)) {
185 /* Ensure the device is open */
186 if (dev->has_cap(CAP_STREAM)) {
187 mode = OPEN_WRITE_ONLY;
189 mode = OPEN_READ_WRITE;
191 /* Try autolabel if enabled */
192 if (dev->open(dcr, mode) < 0) {
193 try_autolabel(false); /* try to create a new volume label */
195 while (dev->open(dcr, mode) < 0) {
196 Dmsg1(150, "open_device failed: ERR=%s\n", dev->bstrerror());
197 if ((dev->is_file() && dev->is_removable()) || dev->is_dvd()) {
199 Dmsg0(150, "call scan_dir_for_vol\n");
201 if (!dev->mount(0)) {
205 if (ok && dev->scan_dir_for_volume(dcr)) {
206 if (dev->open(dcr, mode) >= 0) {
207 break; /* got a valid volume */
210 if (ok && dev->is_dvd()) {
214 if (try_autolabel(false) == try_read_vol) {
215 break; /* created a new volume label */
217 Dmsg0(50, "set_unload\n");
218 dev->set_unload(); /* force ask sysop */
220 Dmsg0(150, "goto mount_next_vol\n");
225 * Now check the volume label to make sure we have the right tape mounted
228 switch (check_volume_label(ask, autochanger)) {
230 Dmsg0(50, "set_unload\n");
231 dev->set_unload(); /* want a different Volume */
232 Dmsg0(150, "goto mount_next_vol\n");
243 * See if we have a fresh tape or a tape with data.
245 * Note, if the LabelType is PRE_LABEL, it was labeled
246 * but never written. If so, rewrite the label but set as
247 * VOL_LABEL. We rewind and return the label (reconstructed)
248 * in the block so that in the case of a new tape, data can
249 * be appended just after the block label. If we are writing
250 * a second volume, the calling routine will write the label
251 * before writing the overflow block.
253 * If the tape is marked as Recycle, we rewrite the label.
255 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
256 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
257 if (!rewrite_volume_label(dcr, recycle)) {
258 mark_volume_in_error();
263 * OK, at this point, we have a valid Bacula label, but
264 * we need to position to the end of the volume, since we are
265 * just now putting it into append mode.
267 Dmsg0(200, "Device previously written, moving to end of data\n");
268 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
271 if (!dev->eod(dcr)) {
272 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device %s: ERR=%s\n"),
273 dev->print_name(), dev->bstrerror());
274 mark_volume_in_error();
277 if (!is_eod_valid()) {
278 Dmsg0(150, "goto mount_next_vol\n");
282 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
283 Dmsg1(150, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
284 if (!dir_update_volume_info(dcr, false, false)) {
288 /* Return an empty block */
289 empty_block(block); /* we used it for reading so set for write */
292 Dmsg1(150, "set APPEND, normal return from mount_next_write_volume. dev=%s\n",
306 * This routine is meant to be called once the first pass
307 * to ensure that we have a candidate volume to mount.
308 * Otherwise, we ask the sysop to created one.
310 bool DCR::find_a_volume()
313 if (!is_suitable_volume_mounted()) {
314 bool have_vol = false;
315 /* Do we have a candidate volume? */
317 bstrncpy(VolumeName, dev->vol->vol_name, sizeof(VolumeName));
318 have_vol = dir_get_volume_info(this, GET_VOL_INFO_FOR_WRITE);
321 * Get Director's idea of what tape we should have mounted.
325 Dmsg0(200, "Before dir_find_next_appendable_volume.\n");
326 while (!dir_find_next_appendable_volume(dcr)) {
327 Dmsg0(200, "not dir_find_next\n");
328 if (job_canceled(jcr)) {
333 if (!dir_ask_sysop_to_create_appendable_volume(dcr)) {
337 Dmsg0(150, "Again dir_find_next_append...\n");
344 int DCR::check_volume_label(bool &ask, bool &autochanger)
346 int vol_label_status;
348 * If we are writing to a stream device, ASSUME the volume label
351 if (dev->has_cap(CAP_STREAM)) {
352 vol_label_status = VOL_OK;
353 create_volume_label(dev, VolumeName, "Default", false /* not DVD */);
354 dev->VolHdr.LabelType = PRE_LABEL;
356 vol_label_status = read_dev_volume_label(this);
358 if (job_canceled(jcr)) {
362 Dmsg2(150, "Want dirVol=%s dirStat=%s\n", VolumeName,
363 VolCatInfo.VolCatStatus);
365 * At this point, dev->VolCatInfo has what is in the drive, if anything,
366 * and dcr->VolCatInfo has what the Director wants.
368 switch (vol_label_status) {
370 Dmsg1(150, "Vol OK name=%s\n", dev->VolHdr.VolumeName);
371 dev->VolCatInfo = VolCatInfo; /* structure assignment */
372 break; /* got a Volume */
374 VOLUME_CAT_INFO dcrVolCatInfo, devVolCatInfo;
375 char saveVolumeName[MAX_NAME_LENGTH];
377 Dmsg2(150, "Vol NAME Error Have=%s, want=%s\n", dev->VolHdr.VolumeName, VolumeName);
378 if (dev->is_volume_to_unload()) {
380 goto check_next_volume;
383 /* If not removable, Volume is broken */
384 if (!dev->is_removable()) {
385 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
386 VolumeName, dev->print_name());
387 mark_volume_in_error();
388 goto check_next_volume;
392 * OK, we got a different volume mounted. First save the
393 * requested Volume info (dcr) structure, then query if
394 * this volume is really OK. If not, put back the desired
395 * volume name, mark it not in changer and continue.
397 dcrVolCatInfo = VolCatInfo; /* structure assignment */
398 devVolCatInfo = dev->VolCatInfo; /* structure assignment */
399 /* Check if this is a valid Volume in the pool */
400 bstrncpy(saveVolumeName, VolumeName, sizeof(saveVolumeName));
401 bstrncpy(VolumeName, dev->VolHdr.VolumeName, sizeof(VolumeName));
402 if (!dir_get_volume_info(this, GET_VOL_INFO_FOR_WRITE)) {
403 POOL_MEM vol_info_msg;
404 pm_strcpy(vol_info_msg, jcr->dir_bsock->msg); /* save error message */
405 /* Restore desired volume name, note device info out of sync */
406 /* This gets the info regardless of the Pool */
407 bstrncpy(VolumeName, dev->VolHdr.VolumeName, sizeof(VolumeName));
408 if (autochanger && !dir_get_volume_info(this, GET_VOL_INFO_FOR_READ)) {
410 * If we get here, we know we cannot write on the Volume,
411 * and we know that we cannot read it either, so it
412 * is not in the autochanger.
414 mark_volume_not_inchanger();
416 dev->VolCatInfo = devVolCatInfo; /* structure assignment */
417 dev->set_unload(); /* unload this volume */
418 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
419 " Current Volume \"%s\" not acceptable because:\n"
421 dcrVolCatInfo.VolCatName, dev->VolHdr.VolumeName,
422 vol_info_msg.c_str());
424 /* Restore saved DCR before continuing */
425 bstrncpy(VolumeName, saveVolumeName, sizeof(VolumeName));
426 VolCatInfo = dcrVolCatInfo; /* structure assignment */
427 goto check_next_volume;
430 * This was not the volume we expected, but it is OK with
431 * the Director, so use it.
433 Dmsg1(150, "Got new Volume name=%s\n", VolumeName);
434 dev->VolCatInfo = VolCatInfo; /* structure assignment */
435 Dmsg1(100, "Call reserve_volume=%s\n", dev->VolHdr.VolumeName);
436 if (reserve_volume(this, dev->VolHdr.VolumeName) == NULL) {
437 Jmsg2(jcr, M_WARNING, 0, _("Could not reserve volume %s on %s\n"),
438 dev->VolHdr.VolumeName, dev->print_name());
440 goto check_next_volume;
442 break; /* got a Volume */
444 * At this point, we assume we have a blank tape mounted.
448 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
449 mark_volume_in_error();
450 goto check_bail_out; /* we could not write on DVD */
452 /* Fall through wanted */
454 switch (try_autolabel(true)) {
456 goto check_next_volume;
458 goto check_read_volume;
465 /* NOTE! Fall-through wanted. */
468 Dmsg0(200, "VOL_NO_MEDIA or default.\n");
469 /* Send error message */
472 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
475 /* Needed, so the medium can be changed */
476 if (dev->requires_mount()) {
479 goto check_next_volume;
484 return check_next_vol;
490 return check_read_vol;
495 bool DCR::is_suitable_volume_mounted()
497 /* Volume mounted? */
498 if (dev->VolHdr.VolumeName[0] == 0 || dev->swap_dev || dev->must_unload()) {
499 return false; /* no */
501 bstrncpy(VolumeName, dev->VolHdr.VolumeName, sizeof(VolumeName));
502 return dir_get_volume_info(this, GET_VOL_INFO_FOR_WRITE);
505 bool DCR::do_unload()
507 if (dev->must_unload()) {
508 Dmsg1(100, "must_unload release %s\n", dev->print_name());
514 bool DCR::do_load(bool is_writing)
516 if (dev->must_load()) {
517 Dmsg1(100, "Must load %s\n", dev->print_name());
518 if (autoload_device(this, is_writing, NULL) > 0) {
527 void DCR::do_swapping(bool is_writing)
530 * See if we are asked to swap the Volume from another device
531 * if so, unload the other device here, and attach the
532 * volume to our drive.
535 if (dev->swap_dev->must_unload()) {
537 dev->swap_dev->set_slot(dev->vol->get_slot());
539 Dmsg2(100, "Swap unloading slot=%d %s\n", dev->swap_dev->get_slot(),
540 dev->swap_dev->print_name());
541 unload_dev(this, dev->swap_dev);
544 dev->vol->clear_swapping();
545 Dmsg1(100, "=== set in_use vol=%s\n", dev->vol->vol_name);
546 dev->vol->set_in_use();
547 dev->VolHdr.VolumeName[0] = 0; /* don't yet have right Volume */
549 dev->swap_dev = NULL;
555 * Check if the current position on the volume corresponds to
556 * what is in the catalog.
558 bool DCR::is_eod_valid()
561 char ed1[50], ed2[50];
562 if (dev->VolCatInfo.VolCatBytes == dev->part_start + dev->part_size) {
563 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\""
564 " part=%d size=%s\n"), VolumeName,
565 dev->part, edit_uint64(dev->VolCatInfo.VolCatBytes,ed1));
567 Jmsg(jcr, M_ERROR, 0, _("Bacula cannot write on DVD Volume \"%s\" because: "
568 "The sizes do not match! Volume=%s Catalog=%s\n"),
570 edit_uint64(dev->part_start + dev->part_size, ed1),
571 edit_uint64(dev->VolCatInfo.VolCatBytes, ed2));
572 mark_volume_in_error();
575 } else if (dev->is_tape()) {
577 * Check if we are positioned on the tape at the same place
578 * that the database says we should be.
580 if (dev->VolCatInfo.VolCatFiles == dev->get_file()) {
581 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
582 VolumeName, dev->get_file());
584 Jmsg(jcr, M_ERROR, 0, _("Bacula cannot write on tape Volume \"%s\" because:\n"
585 "The number of files mismatch! Volume=%u Catalog=%u\n"),
586 VolumeName, dev->get_file(), dev->VolCatInfo.VolCatFiles);
587 mark_volume_in_error();
590 } else if (dev->is_file()) {
591 char ed1[50], ed2[50];
593 pos = dev->lseek(this, (boffset_t)0, SEEK_END);
594 if (dev->VolCatInfo.VolCatBytes == (uint64_t)pos) {
595 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\""
596 " size=%s\n"), VolumeName,
597 edit_uint64(dev->VolCatInfo.VolCatBytes, ed1));
599 Jmsg(jcr, M_ERROR, 0, _("Bacula cannot write on disk Volume \"%s\" because: "
600 "The sizes do not match! Volume=%s Catalog=%s\n"),
602 edit_uint64(pos, ed1),
603 edit_uint64(dev->VolCatInfo.VolCatBytes, ed2));
604 mark_volume_in_error();
613 * If permitted, we label the device, make sure we can do
614 * it by checking that the VolCatBytes is zero => not labeled,
615 * once the Volume is labeled we don't want to label another
616 * blank tape with the same name. For disk, we go ahead and
617 * label it anyway, because the OS insures that there is only
618 * one Volume with that name.
619 * As noted above, at this point dcr->VolCatInfo has what
620 * the Director wants and dev->VolCatInfo has info on the
621 * previous tape (or nothing).
624 * try_next_vol label failed, look for another volume
625 * try_read_vol labeled volume, now re-read the label
626 * try_error hard error (catalog update)
627 * try_default I couldn't do anything
629 int DCR::try_autolabel(bool opened)
633 if (dev->poll && !dev->is_tape()) {
634 return try_default; /* if polling, don't try to create new labels */
636 /* For a tape require it to be opened and read before labeling */
637 if (!opened && dev->is_tape()) {
640 if (dev->has_cap(CAP_LABEL) && (VolCatInfo.VolCatBytes == 0 ||
641 (!dev->is_tape() && strcmp(VolCatInfo.VolCatStatus,
643 Dmsg0(150, "Create volume label\n");
644 /* Create a new Volume label and write it to the device */
645 if (!write_new_volume_label_to_dev(dcr, VolumeName,
646 pool_name, false, /* no relabel */ false /* defer DVD label */)) {
647 Dmsg2(150, "write_vol_label failed. vol=%s, pool=%s\n",
648 VolumeName, pool_name);
650 mark_volume_in_error();
654 Dmsg0(150, "dir_update_vol_info. Set Append\n");
655 /* Copy Director's info into the device info */
656 dev->VolCatInfo = VolCatInfo; /* structure assignment */
657 if (!dir_update_volume_info(dcr, true, true)) { /* indicate tape labeled */
660 Jmsg(dcr->jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
661 VolumeName, dev->print_name());
662 return try_read_vol; /* read label we just wrote */
664 if (!dev->has_cap(CAP_LABEL) && VolCatInfo.VolCatBytes == 0) {
665 Jmsg(jcr, M_WARNING, 0, _("Device %s not configured to autolabel Volumes.\n"),
668 /* If not removable, Volume is broken */
669 if (!dev->is_removable()) {
670 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
671 VolumeName, dev->print_name());
672 mark_volume_in_error();
680 * Mark volume in error in catalog
682 void DCR::mark_volume_in_error()
684 Jmsg(jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
686 dev->VolCatInfo = VolCatInfo; /* structure assignment */
687 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
688 Dmsg0(150, "dir_update_vol_info. Set Error.\n");
689 dir_update_volume_info(this, false, false);
691 Dmsg0(50, "set_unload\n");
692 dev->set_unload(); /* must get a new volume */
696 * The Volume is not in the correct slot, so mark this
697 * Volume as not being in the Changer.
699 void DCR::mark_volume_not_inchanger()
701 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
702 " Setting InChanger to zero in catalog.\n"),
703 VolCatInfo.VolCatName, VolCatInfo.Slot);
704 dev->VolCatInfo = VolCatInfo; /* structure assignment */
705 VolCatInfo.InChanger = false;
706 dev->VolCatInfo.InChanger = false;
707 Dmsg0(400, "update vol info in mount\n");
708 dir_update_volume_info(this, true, false); /* set new status */
712 * Either because we are going to hang a new volume, or because
713 * of explicit user request, we release the current volume.
715 void DCR::release_volume()
717 unload_autochanger(this, -1);
720 Jmsg0(jcr, M_ERROR, 0, _("Hey!!!!! WroteVol non-zero !!!!!\n"));
721 Pmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
724 * First erase all memory of the current volume
727 dev->block_num = dev->file = 0;
728 dev->EndBlock = dev->EndFile = 0;
729 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
731 /* Force re-read of label */
732 dev->clear_labeled();
735 dev->label_type = B_BACULA_LABEL;
738 if (dev->is_open() && (!dev->is_tape() || !dev->has_cap(CAP_ALWAYSOPEN))) {
742 /* If we have not closed the device, then at least rewind the tape */
743 if (dev->is_open()) {
744 dev->offline_or_rewind();
746 // Dmsg0(50, "set_unload\n");
747 // dev->set_unload();
748 Dmsg0(190, "release_volume\n");
754 * Check to see if the tape position as defined by the OS is
755 * the same as our concept. If it is not,
756 * it means the user has probably manually rewound the tape.
757 * Note, we check only if num_writers == 0, but this code will
758 * also work fine for any number of writers. If num_writers > 0,
759 * we probably should cancel all jobs using this device, or
760 * perhaps even abort the SD, or at a minimum, mark the tape
761 * in error. Another strategy with num_writers == 0, would be
762 * to rewind the tape and do a new eod() request.
764 bool DCR::is_tape_position_ok()
766 if (dev->is_tape() && dev->num_writers == 0) {
767 int32_t file = dev->get_os_tape_file();
768 if (file >= 0 && file != (int32_t)dev->get_file()) {
769 Jmsg(jcr, M_ERROR, 0, _("Invalid tape position on volume \"%s\""
770 " on device %s. Expected %d, got %d\n"),
771 dev->VolHdr.VolumeName, dev->print_name(), dev->get_file(), file);
773 * If the current file is greater than zero, it means we probably
774 * have some bad count of EOF marks, so mark tape in error. Otherwise
775 * the operator might have moved the tape, so we just release it
779 mark_volume_in_error();
790 * If we are reading, we come here at the end of the tape
791 * and see if there are more volumes to be mounted.
793 bool mount_next_read_volume(DCR *dcr)
795 DEVICE *dev = dcr->dev;
797 Dmsg2(90, "NumReadVolumes=%d CurReadVolume=%d\n", jcr->NumReadVolumes, jcr->CurReadVolume);
799 volume_unused(dcr); /* release current volume */
801 * End Of Tape -- mount next Volume (if another specified)
803 if (jcr->NumReadVolumes > 1 && jcr->CurReadVolume < jcr->NumReadVolumes) {
805 if (!acquire_device_for_read(dcr)) {
806 Jmsg2(jcr, M_FATAL, 0, _("Cannot open Dev=%s, Vol=%s\n"), dev->print_name(),
810 return true; /* next volume mounted */
812 Dmsg0(90, "End of Device reached.\n");