2 Bacula® - The Network Backup Solution
4 Copyright (C) 2002-2007 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version two of the GNU General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of John Walker.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
30 * 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 */
41 static void mark_volume_not_inchanger(DCR *dcr);
42 static int try_autolabel(DCR *dcr, bool opened);
52 * If release is set, we rewind the current volume,
53 * which we no longer want, and ask the user (console)
54 * to mount the next volume.
56 * Continue trying until we get it, and then ensure
57 * that we can write on it.
59 * This routine returns a 0 only if it is REALLY
60 * impossible to get the requested Volume.
63 bool mount_next_write_volume(DCR *dcr, bool release)
66 bool ask = false, recycle, autochanger;
68 DEVICE *dev = dcr->dev;
70 DEV_BLOCK *block = dcr->block;
73 Dmsg2(150, "Enter mount_next_volume(release=%d) dev=%s\n", release,
76 init_device_wait_timers(dcr);
79 * Attempt to mount the next volume. If something non-fatal goes
80 * wrong, we come back here to re-try (new op messages, re-read
84 Dmsg1(150, "mount_next_vol retry=%d\n", retry);
85 /* Ignore retry if this is poll request */
86 if (!dev->poll && retry++ > 4) {
87 /* Last ditch effort before giving up, force operator to respond */
88 dcr->VolCatInfo.Slot = 0;
89 if (!dir_ask_sysop_to_mount_volume(dcr)) {
90 Jmsg(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"),
95 if (job_canceled(jcr)) {
96 Jmsg(jcr, M_FATAL, 0, _("Job %d canceled.\n"), jcr->JobId);
101 Dmsg0(150, "mount_next_volume release=1\n");
103 ask = true; /* ask operator to mount tape */
107 * Get Director's idea of what tape we should have mounted.
110 Dmsg0(200, "Before dir_find_next_appendable_volume.\n");
111 while (!dir_find_next_appendable_volume(dcr)) {
112 Dmsg0(200, "not dir_find_next\n");
113 if (!dir_ask_sysop_to_create_appendable_volume(dcr)) {
116 Dmsg0(200, "Again dir_find_next_append...\n");
118 if (job_canceled(jcr)) {
121 Dmsg3(150, "After find_next_append. Vol=%s Slot=%d Parts=%d\n",
122 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot, dcr->VolCatInfo.VolCatParts);
125 * Get next volume and ready it for append
126 * This code ensures that the device is ready for
127 * writing. We start from the assumption that there
128 * may not be a tape mounted.
130 * If the device is a file, we create the output
131 * file. If it is a tape, we check the volume name
132 * and move the tape to the end of data.
135 if (autoload_device(dcr, 1, NULL) > 0) {
140 dcr->VolCatInfo.Slot = 0;
142 Dmsg1(200, "autoload_dev returns %d\n", autochanger);
144 * If we autochanged to correct Volume or (we have not just
145 * released the Volume AND we can automount) we go ahead
146 * and read the label. If there is no tape in the drive,
147 * we will err, recurse and ask the operator the next time.
149 if (!release && dev->is_tape() && dev->has_cap(CAP_AUTOMOUNT)) {
150 Dmsg0(150, "(1)Ask=0\n");
151 ask = false; /* don't ask SYSOP this time */
153 /* Don't ask if not removable */
154 if (!dev->is_removable()) {
155 Dmsg0(150, "(2)Ask=0\n");
158 Dmsg2(150, "Ask=%d autochanger=%d\n", ask, autochanger);
159 release = true; /* release next time if we "recurse" */
161 if (ask && !dir_ask_sysop_to_mount_volume(dcr)) {
162 Dmsg0(150, "Error return ask_sysop ...\n");
163 return false; /* error return */
165 if (job_canceled(jcr)) {
168 Dmsg1(150, "want vol=%s\n", dcr->VolumeName);
170 if (dev->poll && dev->has_cap(CAP_CLOSEONPOLL)) {
174 /* Ensure the device is open */
175 if (dev->has_cap(CAP_STREAM)) {
176 mode = OPEN_WRITE_ONLY;
178 mode = OPEN_READ_WRITE;
180 /* Try autolabel if enabled */
181 if (dev->open(dcr, mode) < 0) {
182 try_autolabel(dcr, false); /* try to create a new volume label */
184 while (dev->open(dcr, mode) < 0) {
185 Dmsg1(150, "open_device failed: ERR=%s\n", dev->bstrerror());
186 if ((dev->is_file() && dev->is_removable()) || dev->is_dvd()) {
188 Dmsg0(150, "call scan_dir_for_vol\n");
190 if (!dev->mount(0)) {
194 if (ok && dev->scan_dir_for_volume(dcr)) {
195 if (dev->open(dcr, mode) >= 0) {
196 break; /* got a valid volume */
199 if (ok && dev->is_dvd()) {
203 if (try_autolabel(dcr, false) == try_read_vol) {
204 break; /* created a new volume label */
206 /* If DVD, ignore the error, very often you cannot open the device
207 * (when there is no DVD, or when the one inserted is a wrong one) */
208 if (dev->poll || dev->is_dvd() || dev->is_removable()) {
211 Jmsg(jcr, M_ERROR, 0, _("Could not open device %s: ERR=%s\n"),
212 dev->print_name(), dev->print_errmsg());
218 * Now make sure we have the right tape mounted
222 * If we are writing to a stream device, ASSUME the volume label
225 if (dev->has_cap(CAP_STREAM)) {
226 vol_label_status = VOL_OK;
227 create_volume_label(dev, dcr->VolumeName, "Default", false /* not DVD */);
228 dev->VolHdr.LabelType = PRE_LABEL;
230 vol_label_status = read_dev_volume_label(dcr);
232 if (job_canceled(jcr)) {
236 Dmsg2(150, "Want dirVol=%s dirStat=%s\n", dcr->VolumeName,
237 dcr->VolCatInfo.VolCatStatus);
239 * At this point, dev->VolCatInfo has what is in the drive, if anything,
240 * and dcr->VolCatInfo has what the Director wants.
242 switch (vol_label_status) {
244 Dmsg1(150, "Vol OK name=%s\n", dcr->VolumeName);
245 dev->VolCatInfo = dcr->VolCatInfo; /* structure assignment */
246 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
247 break; /* got a Volume */
249 VOLUME_CAT_INFO dcrVolCatInfo, devVolCatInfo;
250 char VolumeName[MAX_NAME_LENGTH];
252 /* If not removable, Volume is broken */
253 if (!dev->is_removable()) {
254 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
255 dcr->VolumeName, dev->print_name());
256 mark_volume_in_error(dcr);
260 Dmsg1(150, "Vol NAME Error Name=%s\n", dcr->VolumeName);
261 /* If polling and got a previous bad name, ignore it */
262 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolumeName) == 0) {
264 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n", dcr->VolumeName);
268 * OK, we got a different volume mounted. First save the
269 * requested Volume info (dcr) structure, then query if
270 * this volume is really OK. If not, put back the desired
271 * volume name, mark it not in changer and continue.
273 dcrVolCatInfo = dcr->VolCatInfo; /* structure assignment */
274 devVolCatInfo = dev->VolCatInfo; /* structure assignment */
275 /* Check if this is a valid Volume in the pool */
276 bstrncpy(VolumeName, dcr->VolumeName, sizeof(VolumeName));
277 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
278 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
279 POOL_MEM vol_info_msg;
280 pm_strcpy(vol_info_msg, jcr->dir_bsock->msg); /* save error message */
281 /* Restore desired volume name, note device info out of sync */
282 /* This gets the info regardless of the Pool */
283 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
284 if (autochanger && !dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
286 * If we get here, we know we cannot write on the Volume,
287 * and we know that we cannot read it either, so it
288 * is not in the autochanger.
290 mark_volume_not_inchanger(dcr);
292 dev->VolCatInfo = devVolCatInfo; /* structure assignment */
293 bstrncpy(dev->BadVolName, dev->VolHdr.VolumeName, sizeof(dev->BadVolName));
294 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
295 " Current Volume \"%s\" not acceptable because:\n"
297 dcrVolCatInfo.VolCatName, dev->VolHdr.VolumeName,
298 vol_info_msg.c_str());
300 /* Restore saved DCR before continuing */
301 bstrncpy(dcr->VolumeName, VolumeName, sizeof(dcr->VolumeName));
302 dcr->VolCatInfo = dcrVolCatInfo; /* structure assignment */
306 * This was not the volume we expected, but it is OK with
307 * the Director, so use it.
309 Dmsg1(150, "want new name=%s\n", dcr->VolumeName);
310 dev->VolCatInfo = dcr->VolCatInfo; /* structure assignment */
311 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
312 break; /* got a Volume */
314 * At this point, we assume we have a blank tape mounted.
318 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
319 mark_volume_in_error(dcr);
320 return false; /* we could not write on DVD */
322 /* Fall through wanted */
324 switch (try_autolabel(dcr, true)) {
335 /* NOTE! Fall-through wanted. */
338 Dmsg0(200, "VOL_NO_MEDIA or default.\n");
339 /* Send error message */
342 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
345 /* Needed, so the medium can be changed */
346 if (dev->requires_mount()) {
353 * See if we have a fresh tape or a tape with data.
355 * Note, if the LabelType is PRE_LABEL, it was labeled
356 * but never written. If so, rewrite the label but set as
357 * VOL_LABEL. We rewind and return the label (reconstructed)
358 * in the block so that in the case of a new tape, data can
359 * be appended just after the block label. If we are writing
360 * a second volume, the calling routine will write the label
361 * before writing the overflow block.
363 * If the tape is marked as Recycle, we rewrite the label.
365 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
366 if (!rewrite_volume_label(dcr, recycle)) {
367 mark_volume_in_error(dcr);
372 * OK, at this point, we have a valid Bacula label, but
373 * we need to position to the end of the volume, since we are
374 * just now putting it into append mode.
376 Dmsg0(200, "Device previously written, moving to end of data\n");
377 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
379 if (!dev->eod(dcr)) {
380 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device %s: ERR=%s\n"),
381 dev->print_name(), dev->bstrerror());
382 mark_volume_in_error(dcr);
386 char ed1[50], ed2[50];
387 if (dev->VolCatInfo.VolCatBytes == dev->part_start + dev->part_size) {
388 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\""
389 " part=%d size=%s\n"), dcr->VolumeName,
390 dev->part, edit_uint64(dev->VolCatInfo.VolCatBytes,ed1));
392 Jmsg(jcr, M_ERROR, 0, _("Bacula cannot write on DVD Volume \"%s\" because: "
393 "The sizes do not match! Volume=%s Catalog=%s\n"),
395 edit_uint64(dev->part_start + dev->part_size, ed1),
396 edit_uint64(dev->VolCatInfo.VolCatBytes, ed2));
397 mark_volume_in_error(dcr);
400 } else if (dev->is_tape()) {
402 * Check if we are positioned on the tape at the same place
403 * that the database says we should be.
405 if (dev->VolCatInfo.VolCatFiles == dev->get_file()) {
406 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
407 dcr->VolumeName, dev->get_file());
409 Jmsg(jcr, M_ERROR, 0, _("Bacula cannot write on tape Volume \"%s\" because:\n"
410 "The number of files mismatch! Volume=%u Catalog=%u\n"),
411 dcr->VolumeName, dev->get_file(), dev->VolCatInfo.VolCatFiles);
412 mark_volume_in_error(dcr);
415 } else if (dev->is_file()) {
416 char ed1[50], ed2[50];
418 pos = dev->lseek(dcr, (boffset_t)0, SEEK_END);
419 if (dev->VolCatInfo.VolCatBytes == (uint64_t)pos) {
420 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\""
421 " size=%s\n"), dcr->VolumeName,
422 edit_uint64(dev->VolCatInfo.VolCatBytes, ed1));
424 Jmsg(jcr, M_ERROR, 0, _("Bacula cannot write on disk Volume \"%s\" because: "
425 "The sizes do not match! Volume=%s Catalog=%s\n"),
427 edit_uint64(pos, ed1),
428 edit_uint64(dev->VolCatInfo.VolCatBytes, ed2));
429 mark_volume_in_error(dcr);
433 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
434 Dmsg1(150, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
435 if (!dir_update_volume_info(dcr, false)) {
440 * DVD : check if the last part was removed or truncated, or if a written
441 * part was overwritten.
442 * We need to do it after dir_update_volume_info, so we have the EndBlock
443 * info. (nb: I don't understand why VolCatFiles is set (used to check
444 * tape file number), but not EndBlock)
445 * Maybe could it be changed "dev->is_file()" (would remove the fixme above)
447 * Disabled: I had problems with this code...
448 * (maybe is it related to the seek bug ?)
452 Dmsg2(150, "DVD/File sanity check addr=%u vs endblock=%u\n", (unsigned int)dev->file_addr, (unsigned int)dev->VolCatInfo.EndBlock);
453 if (dev->file_addr == dev->VolCatInfo.EndBlock+1) {
454 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file address=%u.\n"),
455 dcr->VolumeName, (unsigned int)dev->file_addr);
458 Jmsg(jcr, M_ERROR, 0, _("Bacula cannot write on Volume \"%s\" because:\n"
459 "The EOD file address is wrong: Volume file address=%u != Catalog Endblock=%u(+1)\n"
460 "Perhaps You removed the DVD last part in spool directory.\n"),
461 dcr->VolumeName, (unsigned int)dev->file_addr, (unsigned int)dev->VolCatInfo.EndBlock);
462 mark_volume_in_error(dcr);
468 /* Return an empty block */
469 empty_block(block); /* we used it for reading so set for write */
472 Dmsg1(150, "set APPEND, normal return from mount_next_write_volume. dev=%s\n",
479 * If permitted, we label the device, make sure we can do
480 * it by checking that the VolCatBytes is zero => not labeled,
481 * once the Volume is labeled we don't want to label another
482 * blank tape with the same name. For disk, we go ahead and
483 * label it anyway, because the OS insures that there is only
484 * one Volume with that name.
485 * As noted above, at this point dcr->VolCatInfo has what
486 * the Director wants and dev->VolCatInfo has info on the
487 * previous tape (or nothing).
490 * try_next_vol label failed, look for another volume
491 * try_read_vol labeled volume, now re-read the label
492 * try_error hard error (catalog update)
493 * try_default I couldn't do anything
495 static int try_autolabel(DCR *dcr, bool opened)
497 DEVICE *dev = dcr->dev;
499 if (dev->poll && !dev->is_tape()) {
500 return try_default; /* if polling, don't try to create new labels */
502 /* For a tape require it to be opened and read before labeling */
503 if (!opened && dev->is_tape()) {
506 if (dev->has_cap(CAP_LABEL) && (dcr->VolCatInfo.VolCatBytes == 0 ||
507 (!dev->is_tape() && strcmp(dcr->VolCatInfo.VolCatStatus,
509 Dmsg0(150, "Create volume label\n");
510 /* Create a new Volume label and write it to the device */
511 if (!write_new_volume_label_to_dev(dcr, dcr->VolumeName,
512 dcr->pool_name, false, /* no relabel */ false /* defer DVD label */)) {
513 Dmsg0(150, "!write_vol_label\n");
515 mark_volume_in_error(dcr);
519 Dmsg0(150, "dir_update_vol_info. Set Append\n");
520 /* Copy Director's info into the device info */
521 dev->VolCatInfo = dcr->VolCatInfo; /* structure assignment */
522 if (!dir_update_volume_info(dcr, true)) { /* indicate tape labeled */
525 Jmsg(dcr->jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
526 dcr->VolumeName, dev->print_name());
527 return try_read_vol; /* read label we just wrote */
529 if (!dev->has_cap(CAP_LABEL) && dcr->VolCatInfo.VolCatBytes == 0) {
530 Jmsg(dcr->jcr, M_WARNING, 0, _("Device %s not configured to autolabel Volumes.\n"),
533 /* If not removable, Volume is broken */
534 if (!dev->is_removable()) {
535 Jmsg(dcr->jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
536 dcr->VolumeName, dev->print_name());
537 mark_volume_in_error(dcr);
545 * Mark volume in error in catalog
547 void mark_volume_in_error(DCR *dcr)
549 DEVICE *dev = dcr->dev;
550 Jmsg(dcr->jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
552 dev->VolCatInfo = dcr->VolCatInfo; /* structure assignment */
553 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
554 Dmsg0(150, "dir_update_vol_info. Set Error.\n");
555 dir_update_volume_info(dcr, false);
559 * The Volume is not in the correct slot, so mark this
560 * Volume as not being in the Changer.
562 static void mark_volume_not_inchanger(DCR *dcr)
565 DEVICE *dev = dcr->dev;
566 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
567 " Setting InChanger to zero in catalog.\n"),
568 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot);
569 dev->VolCatInfo = dcr->VolCatInfo; /* structure assignment */
570 dcr->VolCatInfo.InChanger = false;
571 dev->VolCatInfo.InChanger = false;
572 Dmsg0(400, "update vol info in mount\n");
573 dir_update_volume_info(dcr, true); /* set new status */
577 * Either because we are going to hang a new volume, or because
578 * of explicit user request, we release the current volume.
580 void release_volume(DCR *dcr)
583 DEVICE *dev = dcr->dev;
585 Jmsg0(jcr, M_ERROR, 0, _("Hey!!!!! WroteVol non-zero !!!!!\n"));
586 Dmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
589 * First erase all memory of the current volume
591 dev->block_num = dev->file = 0;
592 dev->EndBlock = dev->EndFile = 0;
593 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
594 memset(&dcr->VolCatInfo, 0, sizeof(dcr->VolCatInfo));
596 /* Force re-read of label */
597 dev->clear_labeled();
600 dev->label_type = B_BACULA_LABEL;
601 dcr->VolumeName[0] = 0;
603 if (dev->is_open() && (!dev->is_tape() || !dev->has_cap(CAP_ALWAYSOPEN))) {
607 /* If we have not closed the device, then at least rewind the tape */
608 if (dev->is_open()) {
609 dev->offline_or_rewind();
611 Dmsg0(190, "release_volume\n");
615 * If we are reading, we come here at the end of the tape
616 * and see if there are more volumes to be mounted.
618 bool mount_next_read_volume(DCR *dcr)
620 DEVICE *dev = dcr->dev;
622 Dmsg2(90, "NumReadVolumes=%d CurReadVolume=%d\n", jcr->NumReadVolumes, jcr->CurReadVolume);
624 * End Of Tape -- mount next Volume (if another specified)
626 if (jcr->NumReadVolumes > 1 && jcr->CurReadVolume < jcr->NumReadVolumes) {
628 if (!acquire_device_for_read(dcr)) {
629 Jmsg2(jcr, M_FATAL, 0, _("Cannot open Dev=%s, Vol=%s\n"), dev->print_name(),
633 return true; /* next volume mounted */
635 Dmsg0(90, "End of Device reached.\n");