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;
75 Dmsg2(150, "Enter mount_next_volume(release=%d) dev=%s\n", unload_device,
78 init_device_wait_timers(dcr);
82 * Attempt to mount the next volume. If something non-fatal goes
83 * wrong, we come back here to re-try (new op messages, re-read
87 Dmsg1(150, "mount_next_vol retry=%d\n", retry);
88 /* Ignore retry if this is poll request */
89 if (!dev->poll && retry++ > 4) {
90 /* Last ditch effort before giving up, force operator to respond */
92 if (!dir_ask_sysop_to_mount_volume(dcr, ST_APPEND)) {
93 Jmsg(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"),
98 if (job_canceled(jcr)) {
99 Jmsg(jcr, M_FATAL, 0, _("Job %d canceled.\n"), jcr->JobId);
104 Dmsg0(150, "mount_next_volume release=1\n");
106 unload_autochanger(dcr, -1);
107 unload_device = false;
108 ask = true; /* ask operator to mount tape */
112 * See if we are asked to swap the Volume from another device
113 * if so, unload the other device here, and attach the
114 * volume to our drive.
117 dev->vol = swap_dev->vol; /* take its volume */
118 swap_dev->vol = NULL;
119 unload_dev(dcr, swap_dev);
122 if (!is_suitable_volume_mounted()) {
124 * Get Director's idea of what tape we should have mounted.
127 Dmsg0(200, "Before dir_find_next_appendable_volume.\n");
128 while (!dir_find_next_appendable_volume(dcr)) {
129 Dmsg0(200, "not dir_find_next\n");
130 if (!dir_ask_sysop_to_create_appendable_volume(dcr)) {
133 Dmsg0(200, "Again dir_find_next_append...\n");
136 if (job_canceled(jcr)) {
139 Dmsg3(150, "After find_next_append. Vol=%s Slot=%d Parts=%d\n",
140 VolCatInfo.VolCatName, VolCatInfo.Slot, VolCatInfo.VolCatParts);
143 * Get next volume and ready it for append
144 * This code ensures that the device is ready for
145 * writing. We start from the assumption that there
146 * may not be a tape mounted.
148 * If the device is a file, we create the output
149 * file. If it is a tape, we check the volume name
150 * and move the tape to the end of data.
153 if (autoload_device(dcr, 1, NULL) > 0) {
160 Dmsg1(200, "autoload_dev returns %d\n", autochanger);
162 * If we autochanged to correct Volume or (we have not just
163 * released the Volume AND we can automount) we go ahead
164 * and read the label. If there is no tape in the drive,
165 * we will fail, recurse and ask the operator the next time.
167 if (!unload_device && dev->is_tape() && dev->has_cap(CAP_AUTOMOUNT)) {
168 Dmsg0(150, "(1)Ask=0\n");
169 ask = false; /* don't ask SYSOP this time */
171 /* Don't ask if not removable */
172 if (!dev->is_removable()) {
173 Dmsg0(150, "(2)Ask=0\n");
176 Dmsg2(150, "Ask=%d autochanger=%d\n", ask, autochanger);
177 unload_device = true; /* release next time if we "recurse" */
179 if (ask && !dir_ask_sysop_to_mount_volume(dcr, ST_APPEND)) {
180 Dmsg0(150, "Error return ask_sysop ...\n");
181 goto bail_out; /* error return */
183 if (job_canceled(jcr)) {
186 Dmsg3(150, "want vol=%s devvol=%s dev=%s\n", VolumeName,
187 dev->VolHdr.VolumeName, dev->print_name());
189 if (dev->poll && dev->has_cap(CAP_CLOSEONPOLL)) {
193 /* Ensure the device is open */
194 if (dev->has_cap(CAP_STREAM)) {
195 mode = OPEN_WRITE_ONLY;
197 mode = OPEN_READ_WRITE;
199 /* Try autolabel if enabled */
200 if (dev->open(dcr, mode) < 0) {
201 try_autolabel(false); /* try to create a new volume label */
203 while (dev->open(dcr, mode) < 0) {
204 Dmsg1(150, "open_device failed: ERR=%s\n", dev->bstrerror());
205 if ((dev->is_file() && dev->is_removable()) || dev->is_dvd()) {
207 Dmsg0(150, "call scan_dir_for_vol\n");
209 if (!dev->mount(0)) {
213 if (ok && dev->scan_dir_for_volume(dcr)) {
214 if (dev->open(dcr, mode) >= 0) {
215 break; /* got a valid volume */
218 if (ok && dev->is_dvd()) {
222 if (try_autolabel(false) == try_read_vol) {
223 break; /* created a new volume label */
225 /* If DVD, ignore the error, very often you cannot open the device
226 * (when there is no DVD, or when the one inserted is a wrong one) */
227 if (dev->poll || dev->is_dvd() || dev->is_removable()) {
230 Jmsg(jcr, M_ERROR, 0, _("Could not open device %s: ERR=%s\n"),
231 dev->print_name(), dev->print_errmsg());
237 * Now check the volume label to make sure we have the right tape mounted
241 switch (check_volume_label(ask, autochanger)) {
253 * See if we have a fresh tape or a tape with data.
255 * Note, if the LabelType is PRE_LABEL, it was labeled
256 * but never written. If so, rewrite the label but set as
257 * VOL_LABEL. We rewind and return the label (reconstructed)
258 * in the block so that in the case of a new tape, data can
259 * be appended just after the block label. If we are writing
260 * a second volume, the calling routine will write the label
261 * before writing the overflow block.
263 * If the tape is marked as Recycle, we rewrite the label.
265 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
266 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
267 if (!rewrite_volume_label(dcr, recycle)) {
268 mark_volume_in_error();
273 * OK, at this point, we have a valid Bacula label, but
274 * we need to position to the end of the volume, since we are
275 * just now putting it into append mode.
277 Dmsg0(200, "Device previously written, moving to end of data\n");
278 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
281 if (!dev->eod(dcr)) {
282 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device %s: ERR=%s\n"),
283 dev->print_name(), dev->bstrerror());
284 mark_volume_in_error();
287 if (!is_eod_valid()) {
291 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
292 Dmsg1(150, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
293 if (!dir_update_volume_info(dcr, false, false)) {
297 /* Return an empty block */
298 empty_block(block); /* we used it for reading so set for write */
301 Dmsg1(150, "set APPEND, normal return from mount_next_write_volume. dev=%s\n",
312 int DCR::check_volume_label(bool &ask, bool &autochanger)
314 int vol_label_status;
316 * If we are writing to a stream device, ASSUME the volume label
319 if (dev->has_cap(CAP_STREAM)) {
320 vol_label_status = VOL_OK;
321 create_volume_label(dev, VolumeName, "Default", false /* not DVD */);
322 dev->VolHdr.LabelType = PRE_LABEL;
324 vol_label_status = read_dev_volume_label(this);
326 if (job_canceled(jcr)) {
330 Dmsg2(150, "Want dirVol=%s dirStat=%s\n", VolumeName,
331 VolCatInfo.VolCatStatus);
333 * At this point, dev->VolCatInfo has what is in the drive, if anything,
334 * and dcr->VolCatInfo has what the Director wants.
336 switch (vol_label_status) {
338 Dmsg1(150, "Vol OK name=%s\n", VolumeName);
339 dev->VolCatInfo = VolCatInfo; /* structure assignment */
340 break; /* got a Volume */
342 VOLUME_CAT_INFO dcrVolCatInfo, devVolCatInfo;
343 char VolumeName[MAX_NAME_LENGTH];
345 /* If not removable, Volume is broken */
346 if (!dev->is_removable()) {
347 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
348 VolumeName, dev->print_name());
349 mark_volume_in_error();
350 goto check_next_volume;
353 Dmsg1(150, "Vol NAME Error Name=%s\n", VolumeName);
354 /* If polling and got a previous bad name, ignore it */
355 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolumeName) == 0) {
357 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n", VolumeName);
358 goto check_next_volume;
361 * OK, we got a different volume mounted. First save the
362 * requested Volume info (dcr) structure, then query if
363 * this volume is really OK. If not, put back the desired
364 * volume name, mark it not in changer and continue.
366 dcrVolCatInfo = VolCatInfo; /* structure assignment */
367 devVolCatInfo = dev->VolCatInfo; /* structure assignment */
368 /* Check if this is a valid Volume in the pool */
369 bstrncpy(VolumeName, VolumeName, sizeof(VolumeName));
370 bstrncpy(VolumeName, dev->VolHdr.VolumeName, sizeof(VolumeName));
371 if (!dir_get_volume_info(this, GET_VOL_INFO_FOR_WRITE)) {
372 POOL_MEM vol_info_msg;
373 pm_strcpy(vol_info_msg, jcr->dir_bsock->msg); /* save error message */
374 /* Restore desired volume name, note device info out of sync */
375 /* This gets the info regardless of the Pool */
376 bstrncpy(VolumeName, dev->VolHdr.VolumeName, sizeof(VolumeName));
377 if (autochanger && !dir_get_volume_info(this, GET_VOL_INFO_FOR_READ)) {
379 * If we get here, we know we cannot write on the Volume,
380 * and we know that we cannot read it either, so it
381 * is not in the autochanger.
383 mark_volume_not_inchanger();
385 dev->VolCatInfo = devVolCatInfo; /* structure assignment */
386 bstrncpy(dev->BadVolName, dev->VolHdr.VolumeName, sizeof(dev->BadVolName));
387 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
388 " Current Volume \"%s\" not acceptable because:\n"
390 dcrVolCatInfo.VolCatName, dev->VolHdr.VolumeName,
391 vol_info_msg.c_str());
393 /* Restore saved DCR before continuing */
394 bstrncpy(VolumeName, VolumeName, sizeof(VolumeName));
395 VolCatInfo = dcrVolCatInfo; /* structure assignment */
396 goto check_next_volume;
399 * This was not the volume we expected, but it is OK with
400 * the Director, so use it.
402 Dmsg1(150, "want new name=%s\n", VolumeName);
403 dev->VolCatInfo = VolCatInfo; /* structure assignment */
404 break; /* got a Volume */
406 * At this point, we assume we have a blank tape mounted.
410 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
411 mark_volume_in_error();
412 goto check_bail_out; /* we could not write on DVD */
414 /* Fall through wanted */
416 switch (try_autolabel(true)) {
418 goto check_next_volume;
420 goto check_read_volume;
427 /* NOTE! Fall-through wanted. */
430 Dmsg0(200, "VOL_NO_MEDIA or default.\n");
431 /* Send error message */
434 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
437 /* Needed, so the medium can be changed */
438 if (dev->requires_mount()) {
441 goto check_next_volume;
446 return check_next_vol;
452 return check_read_vol;
457 bool DCR::is_suitable_volume_mounted()
460 /* Volume mounted? */
461 if (dev->VolHdr.VolumeName[0] == 0 || swap_dev || unload_device) {
462 return false; /* no */
464 bstrncpy(VolumeName, dev->VolHdr.VolumeName, sizeof(VolumeName));
465 return dir_get_volume_info(this, GET_VOL_INFO_FOR_WRITE);
471 * Check if the current position on the volume corresponds to
472 * what is in the catalog.
474 bool DCR::is_eod_valid()
477 char ed1[50], ed2[50];
478 if (dev->VolCatInfo.VolCatBytes == dev->part_start + dev->part_size) {
479 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\""
480 " part=%d size=%s\n"), VolumeName,
481 dev->part, edit_uint64(dev->VolCatInfo.VolCatBytes,ed1));
483 Jmsg(jcr, M_ERROR, 0, _("Bacula cannot write on DVD Volume \"%s\" because: "
484 "The sizes do not match! Volume=%s Catalog=%s\n"),
486 edit_uint64(dev->part_start + dev->part_size, ed1),
487 edit_uint64(dev->VolCatInfo.VolCatBytes, ed2));
488 mark_volume_in_error();
491 } else if (dev->is_tape()) {
493 * Check if we are positioned on the tape at the same place
494 * that the database says we should be.
496 if (dev->VolCatInfo.VolCatFiles == dev->get_file()) {
497 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
498 VolumeName, dev->get_file());
500 Jmsg(jcr, M_ERROR, 0, _("Bacula cannot write on tape Volume \"%s\" because:\n"
501 "The number of files mismatch! Volume=%u Catalog=%u\n"),
502 VolumeName, dev->get_file(), dev->VolCatInfo.VolCatFiles);
503 mark_volume_in_error();
506 } else if (dev->is_file()) {
507 char ed1[50], ed2[50];
509 pos = dev->lseek(this, (boffset_t)0, SEEK_END);
510 if (dev->VolCatInfo.VolCatBytes == (uint64_t)pos) {
511 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\""
512 " size=%s\n"), VolumeName,
513 edit_uint64(dev->VolCatInfo.VolCatBytes, ed1));
515 Jmsg(jcr, M_ERROR, 0, _("Bacula cannot write on disk Volume \"%s\" because: "
516 "The sizes do not match! Volume=%s Catalog=%s\n"),
518 edit_uint64(pos, ed1),
519 edit_uint64(dev->VolCatInfo.VolCatBytes, ed2));
520 mark_volume_in_error();
529 * If permitted, we label the device, make sure we can do
530 * it by checking that the VolCatBytes is zero => not labeled,
531 * once the Volume is labeled we don't want to label another
532 * blank tape with the same name. For disk, we go ahead and
533 * label it anyway, because the OS insures that there is only
534 * one Volume with that name.
535 * As noted above, at this point dcr->VolCatInfo has what
536 * the Director wants and dev->VolCatInfo has info on the
537 * previous tape (or nothing).
540 * try_next_vol label failed, look for another volume
541 * try_read_vol labeled volume, now re-read the label
542 * try_error hard error (catalog update)
543 * try_default I couldn't do anything
545 int DCR::try_autolabel(bool opened)
549 if (dev->poll && !dev->is_tape()) {
550 return try_default; /* if polling, don't try to create new labels */
552 /* For a tape require it to be opened and read before labeling */
553 if (!opened && dev->is_tape()) {
556 if (dev->has_cap(CAP_LABEL) && (VolCatInfo.VolCatBytes == 0 ||
557 (!dev->is_tape() && strcmp(VolCatInfo.VolCatStatus,
559 Dmsg0(150, "Create volume label\n");
560 /* Create a new Volume label and write it to the device */
561 if (!write_new_volume_label_to_dev(dcr, VolumeName,
562 pool_name, false, /* no relabel */ false /* defer DVD label */)) {
563 Dmsg0(150, "!write_vol_label\n");
565 mark_volume_in_error();
569 Dmsg0(150, "dir_update_vol_info. Set Append\n");
570 /* Copy Director's info into the device info */
571 dev->VolCatInfo = VolCatInfo; /* structure assignment */
572 if (!dir_update_volume_info(dcr, true, true)) { /* indicate tape labeled */
575 Jmsg(dcr->jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
576 VolumeName, dev->print_name());
577 return try_read_vol; /* read label we just wrote */
579 if (!dev->has_cap(CAP_LABEL) && VolCatInfo.VolCatBytes == 0) {
580 Jmsg(jcr, M_WARNING, 0, _("Device %s not configured to autolabel Volumes.\n"),
583 /* If not removable, Volume is broken */
584 if (!dev->is_removable()) {
585 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
586 VolumeName, dev->print_name());
587 mark_volume_in_error();
595 * Mark volume in error in catalog
597 void DCR::mark_volume_in_error()
599 Jmsg(jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
601 dev->VolCatInfo = VolCatInfo; /* structure assignment */
602 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
603 Dmsg0(150, "dir_update_vol_info. Set Error.\n");
604 dir_update_volume_info(this, false, false);
609 * The Volume is not in the correct slot, so mark this
610 * Volume as not being in the Changer.
612 void DCR::mark_volume_not_inchanger()
614 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
615 " Setting InChanger to zero in catalog.\n"),
616 VolCatInfo.VolCatName, VolCatInfo.Slot);
617 dev->VolCatInfo = VolCatInfo; /* structure assignment */
618 VolCatInfo.InChanger = false;
619 dev->VolCatInfo.InChanger = false;
620 Dmsg0(400, "update vol info in mount\n");
621 dir_update_volume_info(this, true, false); /* set new status */
625 * Either because we are going to hang a new volume, or because
626 * of explicit user request, we release the current volume.
628 void release_volume(DCR *dcr)
631 DEVICE *dev = dcr->dev;
633 Jmsg0(jcr, M_ERROR, 0, _("Hey!!!!! WroteVol non-zero !!!!!\n"));
634 Dmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
637 * First erase all memory of the current volume
640 dev->block_num = dev->file = 0;
641 dev->EndBlock = dev->EndFile = 0;
642 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
643 // memset(&dcr->VolCatInfo, 0, sizeof(dcr->VolCatInfo));
645 /* Force re-read of label */
646 dev->clear_labeled();
649 dev->label_type = B_BACULA_LABEL;
650 // dcr->VolumeName[0] = 0;
652 if (dev->is_open() && (!dev->is_tape() || !dev->has_cap(CAP_ALWAYSOPEN))) {
656 /* If we have not closed the device, then at least rewind the tape */
657 if (dev->is_open()) {
658 dev->offline_or_rewind();
660 Dmsg0(190, "release_volume\n");
664 * If we are reading, we come here at the end of the tape
665 * and see if there are more volumes to be mounted.
667 bool mount_next_read_volume(DCR *dcr)
669 DEVICE *dev = dcr->dev;
671 Dmsg2(90, "NumReadVolumes=%d CurReadVolume=%d\n", jcr->NumReadVolumes, jcr->CurReadVolume);
673 volume_unused(dcr); /* release current volume */
675 * End Of Tape -- mount next Volume (if another specified)
677 if (jcr->NumReadVolumes > 1 && jcr->CurReadVolume < jcr->NumReadVolumes) {
679 if (!acquire_device_for_read(dcr)) {
680 Jmsg2(jcr, M_FATAL, 0, _("Cannot open Dev=%s, Vol=%s\n"), dev->print_name(),
684 return true; /* next volume mounted */
686 Dmsg0(90, "End of Device reached.\n");