3 * Routines for handling mounting tapes for reading and for
6 * Kern Sibbald, August MMII
11 Copyright (C) 2002-2006 Kern Sibbald
13 This program is free software; you can redistribute it and/or
14 modify it under the terms of the GNU General Public License
15 version 2 as amended with additional clauses defined in the
16 file LICENSE in the main source directory.
18 This program is distributed in the hope that it will be useful,
19 but WITHOUT ANY WARRANTY; without even the implied warranty of
20 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 the file LICENSE for additional details.
25 #include "bacula.h" /* pull in global headers */
26 #include "stored.h" /* pull in Storage Deamon headers */
28 static void mark_volume_not_inchanger(DCR *dcr);
29 static int try_autolabel(DCR *dcr);
39 * If release is set, we rewind the current volume,
40 * which we no longer want, and ask the user (console)
41 * to mount the next volume.
43 * Continue trying until we get it, and then ensure
44 * that we can write on it.
46 * This routine returns a 0 only if it is REALLY
47 * impossible to get the requested Volume.
50 bool mount_next_write_volume(DCR *dcr, bool release)
53 bool ask = false, recycle, autochanger;
55 DEVICE *dev = dcr->dev;
57 DEV_BLOCK *block = dcr->block;
60 Dmsg2(150, "Enter mount_next_volume(release=%d) dev=%s\n", release,
63 init_device_wait_timers(dcr);
66 * Attempt to mount the next volume. If something non-fatal goes
67 * wrong, we come back here to re-try (new op messages, re-read
71 Dmsg1(150, "mount_next_vol retry=%d\n", retry);
72 /* Ignore retry if this is poll request */
73 if (!dev->poll && retry++ > 4) {
74 /* Last ditch effort before giving up, force operator to respond */
75 dcr->VolCatInfo.Slot = 0;
76 if (!dir_ask_sysop_to_mount_volume(dcr)) {
77 Jmsg(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"),
82 if (job_canceled(jcr)) {
83 Jmsg(jcr, M_FATAL, 0, _("Job %d canceled.\n"), jcr->JobId);
88 Dmsg0(150, "mount_next_volume release=1\n");
90 ask = true; /* ask operator to mount tape */
94 * Get Director's idea of what tape we should have mounted.
97 Dmsg0(200, "Before dir_find_next_appendable_volume.\n");
98 while (!dir_find_next_appendable_volume(dcr)) {
99 Dmsg0(200, "not dir_find_next\n");
100 if (!dir_ask_sysop_to_create_appendable_volume(dcr)) {
103 Dmsg0(200, "Again dir_find_next_append...\n");
105 if (job_canceled(jcr)) {
108 Dmsg3(150, "After find_next_append. Vol=%s Slot=%d Parts=%d\n",
109 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot, dcr->VolCatInfo.VolCatParts);
112 * Get next volume and ready it for append
113 * This code ensures that the device is ready for
114 * writing. We start from the assumption that there
115 * may not be a tape mounted.
117 * If the device is a file, we create the output
118 * file. If it is a tape, we check the volume name
119 * and move the tape to the end of data.
122 if (autoload_device(dcr, 1, NULL) > 0) {
127 dcr->VolCatInfo.Slot = 0;
129 Dmsg1(200, "autoload_dev returns %d\n", autochanger);
131 * If we autochanged to correct Volume or (we have not just
132 * released the Volume AND we can automount) we go ahead
133 * and read the label. If there is no tape in the drive,
134 * we will err, recurse and ask the operator the next time.
136 if (!release && dev->is_tape() && dev->has_cap(CAP_AUTOMOUNT)) {
137 Dmsg0(150, "(1)Ask=0\n");
138 ask = false; /* don't ask SYSOP this time */
140 /* Don't ask if not removable */
141 if (!dev->is_removable()) {
142 Dmsg0(150, "(2)Ask=0\n");
145 Dmsg2(150, "Ask=%d autochanger=%d\n", ask, autochanger);
146 release = true; /* release next time if we "recurse" */
148 if (ask && !dir_ask_sysop_to_mount_volume(dcr)) {
149 Dmsg0(150, "Error return ask_sysop ...\n");
150 return false; /* error return */
152 if (job_canceled(jcr)) {
155 Dmsg1(150, "want vol=%s\n", dcr->VolumeName);
157 if (dev->poll && dev->has_cap(CAP_CLOSEONPOLL)) {
161 /* Ensure the device is open */
162 if (dev_cap(dev, CAP_STREAM)) {
163 mode = OPEN_WRITE_ONLY;
165 mode = OPEN_READ_WRITE;
167 while (dev->open(dcr, mode) < 0) {
168 Dmsg1(150, "open_device failed: ERR=%s\n", dev->bstrerror());
169 if (dev->is_file() && dev->is_removable()) {
170 Dmsg0(150, "call scan_dir_for_vol\n");
171 if (dev->scan_dir_for_volume(dcr)) {
172 break; /* got a valid volume */
175 if (try_autolabel(dcr) == try_read_vol) {
176 break; /* created a new volume label */
178 /* If DVD, ignore the error, very often you cannot open the device
179 * (when there is no DVD, or when the one inserted is a wrong one) */
180 if (dev->poll || dev->is_dvd() || dev->is_removable()) {
183 Jmsg(jcr, M_ERROR, 0, _("Could not open device %s: ERR=%s\n"),
184 dev->print_name(), dev->print_errmsg());
190 * Now make sure we have the right tape mounted
194 * If we are writing to a stream device, ASSUME the volume label
197 if (dev->has_cap(CAP_STREAM)) {
198 vol_label_status = VOL_OK;
199 create_volume_label(dev, dcr->VolumeName, "Default", false /* not DVD */);
200 dev->VolHdr.LabelType = PRE_LABEL;
202 vol_label_status = read_dev_volume_label(dcr);
204 if (job_canceled(jcr)) {
208 Dmsg2(150, "Want dirVol=%s dirStat=%s\n", dcr->VolumeName,
209 dcr->VolCatInfo.VolCatStatus);
211 * At this point, dev->VolCatInfo has what is in the drive, if anything,
212 * and dcr->VolCatInfo has what the Director wants.
214 switch (vol_label_status) {
216 Dmsg1(150, "Vol OK name=%s\n", dcr->VolumeName);
217 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
218 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
219 break; /* got a Volume */
221 VOLUME_CAT_INFO dcrVolCatInfo, devVolCatInfo;
223 /* If not removable, Volume is broken */
224 if (!dev->is_removable()) {
225 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
226 dcr->VolumeName, dev->print_name());
227 mark_volume_in_error(dcr);
231 Dmsg1(150, "Vol NAME Error Name=%s\n", dcr->VolumeName);
232 /* If polling and got a previous bad name, ignore it */
233 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolumeName) == 0) {
235 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n", dcr->VolumeName);
239 * OK, we got a different volume mounted. First save the
240 * requested Volume info (dcr) structure, then query if
241 * this volume is really OK. If not, put back the desired
242 * volume name, mark it not in changer and continue.
244 memcpy(&dcrVolCatInfo, &dcr->VolCatInfo, sizeof(dcrVolCatInfo));
245 memcpy(&devVolCatInfo, &dev->VolCatInfo, sizeof(devVolCatInfo));
246 /* Check if this is a valid Volume in the pool */
247 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
248 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
249 /* Restore desired volume name, note device info out of sync */
250 /* This gets the info regardless of the Pool */
251 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
252 if (autochanger && !dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
254 * If we get here, we know we cannot write on the Volume,
255 * and we know that we cannot read it either, so it
256 * is not in the autochanger.
258 mark_volume_not_inchanger(dcr);
260 memcpy(&dev->VolCatInfo, &devVolCatInfo, sizeof(dev->VolCatInfo));
261 bstrncpy(dev->BadVolName, dev->VolHdr.VolumeName, sizeof(dev->BadVolName));
262 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
263 " Current Volume \"%s\" not acceptable because:\n"
265 dcrVolCatInfo.VolCatName, dev->VolHdr.VolumeName,
266 jcr->dir_bsock->msg);
268 /* Restore saved DCR before continuing */
269 memcpy(&dcr->VolCatInfo, &dcrVolCatInfo, sizeof(dcr->VolCatInfo));
273 * This was not the volume we expected, but it is OK with
274 * the Director, so use it.
276 Dmsg1(150, "want new name=%s\n", dcr->VolumeName);
277 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
278 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
279 break; /* got a Volume */
281 * At this point, we assume we have a blank tape mounted.
285 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
286 mark_volume_in_error(dcr);
287 return false; /* we could not write on DVD */
289 /* Fall through wanted */
291 switch (try_autolabel(dcr)) {
302 /* NOTE! Fall-through wanted. */
305 Dmsg0(200, "VOL_NO_MEDIA or default.\n");
306 /* Send error message */
309 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
312 /* Needed, so the medium can be changed */
313 if (dev->requires_mount()) {
320 * See if we have a fresh tape or a tape with data.
322 * Note, if the LabelType is PRE_LABEL, it was labeled
323 * but never written. If so, rewrite the label but set as
324 * VOL_LABEL. We rewind and return the label (reconstructed)
325 * in the block so that in the case of a new tape, data can
326 * be appended just after the block label. If we are writing
327 * a second volume, the calling routine will write the label
328 * before writing the overflow block.
330 * If the tape is marked as Recycle, we rewrite the label.
332 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
333 if (!rewrite_volume_label(dcr, recycle)) {
334 mark_volume_in_error(dcr);
339 * OK, at this point, we have a valid Bacula label, but
340 * we need to position to the end of the volume, since we are
341 * just now putting it into append mode.
343 Dmsg0(200, "Device previously written, moving to end of data\n");
344 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
346 if (!dev->eod(dcr)) {
347 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device %s: ERR=%s\n"),
348 dev->print_name(), dev->bstrerror());
349 mark_volume_in_error(dcr);
353 char ed1[50], ed2[50];
354 if (dev->VolCatInfo.VolCatBytes == dev->part_start + dev->part_size) {
355 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\""
356 " part=%d size=%s\n"), dcr->VolumeName,
357 dev->part, edit_uint64(dev->VolCatInfo.VolCatBytes,ed1));
359 Jmsg(jcr, M_ERROR, 0, _("I cannot write on Volume \"%s\" because: "
360 "The sizes do not match! Volume=%s Catalog=%s\n"),
362 edit_uint64(dev->part_start + dev->part_size, ed1),
363 edit_uint64(dev->VolCatInfo.VolCatBytes, ed2));
364 mark_volume_in_error(dcr);
368 /* *****FIXME**** we should do some checking for files too */
369 if (dev->is_tape()) {
371 * Check if we are positioned on the tape at the same place
372 * that the database says we should be.
374 if (dev->VolCatInfo.VolCatFiles == dev->get_file()) {
375 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
376 dcr->VolumeName, dev->get_file());
378 Jmsg(jcr, M_ERROR, 0, _("I cannot write on Volume \"%s\" because:\n"
379 "The number of files mismatch! Volume=%u Catalog=%u\n"),
380 dcr->VolumeName, dev->get_file(), dev->VolCatInfo.VolCatFiles);
381 mark_volume_in_error(dcr);
385 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
386 Dmsg1(150, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
387 if (!dir_update_volume_info(dcr, false)) {
392 * DVD : check if the last part was removed or truncated, or if a written
393 * part was overwritten.
394 * We need to do it after dir_update_volume_info, so we have the EndBlock
395 * info. (nb: I don't understand why VolCatFiles is set (used to check
396 * tape file number), but not EndBlock)
397 * Maybe could it be changed "dev->is_file()" (would remove the fixme above)
399 * Disabled: I had problems with this code...
400 * (maybe is it related to the seek bug ?)
404 Dmsg2(150, "DVD/File sanity check addr=%u vs endblock=%u\n", (unsigned int)dev->file_addr, (unsigned int)dev->VolCatInfo.EndBlock);
405 if (dev->file_addr == dev->VolCatInfo.EndBlock+1) {
406 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file address=%u.\n"),
407 dcr->VolumeName, (unsigned int)dev->file_addr);
410 Jmsg(jcr, M_ERROR, 0, _("I cannot write on Volume \"%s\" because:\n"
411 "The EOD file address is wrong: Volume file address=%u != Catalog Endblock=%u(+1)\n"
412 "You probably removed DVD last part in spool directory.\n"),
413 dcr->VolumeName, (unsigned int)dev->file_addr, (unsigned int)dev->VolCatInfo.EndBlock);
414 mark_volume_in_error(dcr);
420 /* Return an empty block */
421 empty_block(block); /* we used it for reading so set for write */
424 Dmsg1(150, "set APPEND, normal return from mount_next_write_volume. dev=%s\n",
431 * If permitted, we label the device, make sure we can do
432 * it by checking that the VolCatBytes is zero => not labeled,
433 * once the Volume is labeled we don't want to label another
434 * blank tape with the same name. For disk, we go ahead and
435 * label it anyway, because the OS insures that there is only
436 * one Volume with that name.
437 * As noted above, at this point dcr->VolCatInfo has what
438 * the Director wants and dev->VolCatInfo has info on the
439 * previous tape (or nothing).
441 static int try_autolabel(DCR *dcr)
443 DEVICE *dev = dcr->dev;
444 if (dev->has_cap(CAP_LABEL) && (dcr->VolCatInfo.VolCatBytes == 0 ||
445 (!dev->is_tape() && strcmp(dcr->VolCatInfo.VolCatStatus,
447 Dmsg0(150, "Create volume label\n");
448 /* Create a new Volume label and write it to the device */
449 if (!write_new_volume_label_to_dev(dcr, dcr->VolumeName,
450 dcr->pool_name, false, /* no relabel */ false /* defer DVD label */)) {
451 Dmsg0(150, "!write_vol_label\n");
452 mark_volume_in_error(dcr);
455 Dmsg0(150, "dir_update_vol_info. Set Append\n");
456 /* Copy Director's info into the device info */
457 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
458 if (!dir_update_volume_info(dcr, true)) { /* indicate tape labeled */
461 Jmsg(dcr->jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
462 dcr->VolumeName, dev->print_name());
463 return try_read_vol; /* read label we just wrote */
465 if (!dev->has_cap(CAP_LABEL) && dcr->VolCatInfo.VolCatBytes == 0) {
466 Jmsg(dcr->jcr, M_INFO, 0, _("Warning device %s not configured to autolabel Volumes.\n"),
469 /* If not removable, Volume is broken */
470 if (!dev->is_removable()) {
471 Jmsg(dcr->jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
472 dcr->VolumeName, dev->print_name());
473 mark_volume_in_error(dcr);
481 * Mark volume in error in catalog
483 void mark_volume_in_error(DCR *dcr)
485 DEVICE *dev = dcr->dev;
486 Jmsg(dcr->jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
488 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
489 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
490 Dmsg0(150, "dir_update_vol_info. Set Error.\n");
491 dir_update_volume_info(dcr, false);
495 * The Volume is not in the correct slot, so mark this
496 * Volume as not being in the Changer.
498 static void mark_volume_not_inchanger(DCR *dcr)
501 DEVICE *dev = dcr->dev;
502 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
503 " Setting InChanger to zero in catalog.\n"),
504 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot);
505 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
506 dcr->VolCatInfo.InChanger = false;
507 dev->VolCatInfo.InChanger = false;
508 Dmsg0(400, "update vol info in mount\n");
509 dir_update_volume_info(dcr, true); /* set new status */
513 * Either because we are going to hang a new volume, or because
514 * of explicit user request, we release the current volume.
516 void release_volume(DCR *dcr)
519 DEVICE *dev = dcr->dev;
521 Jmsg0(jcr, M_ERROR, 0, _("Hey!!!!! WroteVol non-zero !!!!!\n"));
522 Dmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
525 * First erase all memory of the current volume
527 dev->block_num = dev->file = 0;
528 dev->EndBlock = dev->EndFile = 0;
529 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
530 memset(&dcr->VolCatInfo, 0, sizeof(dcr->VolCatInfo));
532 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
533 /* Force re-read of label */
534 dev->clear_labeled();
537 dev->label_type = B_BACULA_LABEL;
538 dcr->VolumeName[0] = 0;
540 if (dev->is_open() && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
544 /* If we have not closed the device, then at least rewind the tape */
545 if (dev->is_open()) {
546 dev->offline_or_rewind();
548 Dmsg0(190, "release_volume\n");
552 * If we are reading, we come here at the end of the tape
553 * and see if there are more volumes to be mounted.
555 bool mount_next_read_volume(DCR *dcr)
557 DEVICE *dev = dcr->dev;
559 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
561 * End Of Tape -- mount next Volume (if another specified)
563 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
565 if (!acquire_device_for_read(dcr)) {
566 Jmsg2(jcr, M_FATAL, 0, _("Cannot open Dev=%s, Vol=%s\n"), dev->print_name(),
570 return true; /* next volume mounted */
572 Dmsg0(90, "End of Device reached.\n");