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 Dmsg0(150, "open_device failed\n");
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()) {
188 * Now make sure we have the right tape mounted
192 * If we are writing to a stream device, ASSUME the volume label
195 if (dev->has_cap(CAP_STREAM)) {
196 vol_label_status = VOL_OK;
197 create_volume_label(dev, dcr->VolumeName, "Default", false /* not DVD */);
198 dev->VolHdr.LabelType = PRE_LABEL;
200 vol_label_status = read_dev_volume_label(dcr);
202 if (job_canceled(jcr)) {
206 Dmsg2(150, "Want dirVol=%s dirStat=%s\n", dcr->VolumeName,
207 dcr->VolCatInfo.VolCatStatus);
209 * At this point, dev->VolCatInfo has what is in the drive, if anything,
210 * and dcr->VolCatInfo has what the Director wants.
212 switch (vol_label_status) {
214 Dmsg1(150, "Vol OK name=%s\n", dcr->VolumeName);
215 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
216 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
217 break; /* got a Volume */
219 VOLUME_CAT_INFO VolCatInfo, devVolCatInfo;
221 /* If not removable, Volume is broken */
222 if (!dev->is_removable()) {
223 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
224 dcr->VolumeName, dev->print_name());
225 mark_volume_in_error(dcr);
229 Dmsg1(150, "Vol NAME Error Name=%s\n", dcr->VolumeName);
230 /* If polling and got a previous bad name, ignore it */
231 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolumeName) == 0) {
233 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n", dcr->VolumeName);
237 * OK, we got a different volume mounted. First save the
238 * requested Volume info (dcr) structure, then query if
239 * this volume is really OK. If not, put back the desired
240 * volume name, mark it not in changer and continue.
242 memcpy(&VolCatInfo, &dcr->VolCatInfo, sizeof(VolCatInfo));
243 memcpy(&devVolCatInfo, &dev->VolCatInfo, sizeof(devVolCatInfo));
244 /* Check if this is a valid Volume in the pool */
245 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
246 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
247 /* Restore desired volume name, note device info out of sync */
248 /* This gets the info regardless of the Pool */
249 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
250 if (autochanger && !dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
251 mark_volume_not_inchanger(dcr);
253 memcpy(&dev->VolCatInfo, &devVolCatInfo, sizeof(dev->VolCatInfo));
254 bstrncpy(dev->BadVolName, dev->VolHdr.VolumeName, sizeof(dev->BadVolName));
255 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
256 " Current Volume \"%s\" not acceptable because:\n"
258 VolCatInfo.VolCatName, dev->VolHdr.VolumeName,
259 jcr->dir_bsock->msg);
263 /* This was not the volume we expected, but it is OK with
264 * the Director, so use it.
266 Dmsg1(150, "want new name=%s\n", dcr->VolumeName);
267 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
268 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
269 break; /* got a Volume */
271 * At this point, we assume we have a blank tape mounted.
275 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
276 mark_volume_in_error(dcr);
277 return false; /* we could not write on DVD */
279 /* Fall through wanted */
281 switch (try_autolabel(dcr)) {
292 /* NOTE! Fall-through wanted. */
295 Dmsg0(200, "VOL_NO_MEDIA or default.\n");
296 /* Send error message */
299 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
302 /* Needed, so the medium can be changed */
303 if (dev->requires_mount()) {
310 * See if we have a fresh tape or a tape with data.
312 * Note, if the LabelType is PRE_LABEL, it was labeled
313 * but never written. If so, rewrite the label but set as
314 * VOL_LABEL. We rewind and return the label (reconstructed)
315 * in the block so that in the case of a new tape, data can
316 * be appended just after the block label. If we are writing
317 * a second volume, the calling routine will write the label
318 * before writing the overflow block.
320 * If the tape is marked as Recycle, we rewrite the label.
322 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
323 if (!rewrite_volume_label(dcr, recycle)) {
324 mark_volume_in_error(dcr);
329 * OK, at this point, we have a valid Bacula label, but
330 * we need to position to the end of the volume, since we are
331 * just now putting it into append mode.
333 Dmsg0(200, "Device previously written, moving to end of data\n");
334 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
337 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device %s: ERR=%s\n"),
338 dev->print_name(), dev->bstrerror());
339 mark_volume_in_error(dcr);
343 char ed1[50], ed2[50];
344 if (dev->VolCatInfo.VolCatBytes == dev->part_start + dev->part_size) {
345 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\""
346 " part=%d size=%s\n"), dcr->VolumeName,
347 dev->part, edit_uint64(dev->VolCatInfo.VolCatBytes,ed1));
349 Jmsg(jcr, M_ERROR, 0, _("I cannot write on Volume \"%s\" because: "
350 "The sizes do not match! Volume=%s Catalog=%s\n"),
352 edit_uint64(dev->part_start + dev->part_size, ed1),
353 edit_uint64(dev->VolCatInfo.VolCatBytes, ed2));
354 mark_volume_in_error(dcr);
358 /* *****FIXME**** we should do some checking for files too */
359 if (dev->is_tape()) {
361 * Check if we are positioned on the tape at the same place
362 * that the database says we should be.
364 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
365 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
366 dcr->VolumeName, dev_file(dev));
368 Jmsg(jcr, M_ERROR, 0, _("I cannot write on Volume \"%s\" because:\n"
369 "The number of files mismatch! Volume=%u Catalog=%u\n"),
370 dcr->VolumeName, dev_file(dev), dev->VolCatInfo.VolCatFiles);
371 mark_volume_in_error(dcr);
375 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
376 Dmsg1(150, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
377 if (!dir_update_volume_info(dcr, false)) {
382 * DVD : check if the last part was removed or truncated, or if a written
383 * part was overwritten.
384 * We need to do it after dir_update_volume_info, so we have the EndBlock
385 * info. (nb: I don't understand why VolCatFiles is set (used to check
386 * tape file number), but not EndBlock)
387 * Maybe could it be changed "dev->is_file()" (would remove the fixme above)
389 * Disabled: I had problems with this code...
390 * (maybe is it related to the seek bug ?)
394 Dmsg2(150, "DVD/File sanity check addr=%u vs endblock=%u\n", (unsigned int)dev->file_addr, (unsigned int)dev->VolCatInfo.EndBlock);
395 if (dev->file_addr == dev->VolCatInfo.EndBlock+1) {
396 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file address=%u.\n"),
397 dcr->VolumeName, (unsigned int)dev->file_addr);
400 Jmsg(jcr, M_ERROR, 0, _("I cannot write on Volume \"%s\" because:\n"
401 "The EOD file address is wrong: Volume file address=%u != Catalog Endblock=%u(+1)\n"
402 "You probably removed DVD last part in spool directory.\n"),
403 dcr->VolumeName, (unsigned int)dev->file_addr, (unsigned int)dev->VolCatInfo.EndBlock);
404 mark_volume_in_error(dcr);
410 /* Return an empty block */
411 empty_block(block); /* we used it for reading so set for write */
414 Dmsg1(150, "set APPEND, normal return from mount_next_write_volume. dev=%s\n",
421 * If permitted, we label the device, make sure we can do
422 * it by checking that the VolCatBytes is zero => not labeled,
423 * once the Volume is labeled we don't want to label another
424 * blank tape with the same name. For disk, we go ahead and
425 * label it anyway, because the OS insures that there is only
426 * one Volume with that name.
427 * As noted above, at this point dcr->VolCatInfo has what
428 * the Director wants and dev->VolCatInfo has info on the
429 * previous tape (or nothing).
431 static int try_autolabel(DCR *dcr)
433 DEVICE *dev = dcr->dev;
434 if (dev->has_cap(CAP_LABEL) && (dcr->VolCatInfo.VolCatBytes == 0 ||
435 (!dev->is_tape() && strcmp(dcr->VolCatInfo.VolCatStatus,
437 Dmsg0(150, "Create volume label\n");
438 /* Create a new Volume label and write it to the device */
439 if (!write_new_volume_label_to_dev(dcr, dcr->VolumeName,
440 dcr->pool_name, false /* defer DVD label */)) {
441 Dmsg0(150, "!write_vol_label\n");
442 mark_volume_in_error(dcr);
445 Dmsg0(150, "dir_update_vol_info. Set Append\n");
446 /* Copy Director's info into the device info */
447 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
448 if (!dir_update_volume_info(dcr, true)) { /* indicate tape labeled */
451 Jmsg(dcr->jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
452 dcr->VolumeName, dev->print_name());
453 return try_read_vol; /* read label we just wrote */
455 if (!dev->has_cap(CAP_LABEL) && dcr->VolCatInfo.VolCatBytes == 0) {
456 Jmsg(dcr->jcr, M_INFO, 0, _("Warning device %s not configured to autolabel Volumes.\n"),
459 /* If not removable, Volume is broken */
460 if (!dev->is_removable()) {
461 Jmsg(dcr->jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
462 dcr->VolumeName, dev->print_name());
463 mark_volume_in_error(dcr);
471 * Mark volume in error in catalog
473 void mark_volume_in_error(DCR *dcr)
475 DEVICE *dev = dcr->dev;
476 Jmsg(dcr->jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
478 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
479 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
480 Dmsg0(150, "dir_update_vol_info. Set Error.\n");
481 dir_update_volume_info(dcr, false);
485 * The Volume is not in the correct slot, so mark this
486 * Volume as not being in the Changer.
488 static void mark_volume_not_inchanger(DCR *dcr)
491 DEVICE *dev = dcr->dev;
492 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
493 " Setting InChanger to zero in catalog.\n"),
494 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot);
495 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
496 dcr->VolCatInfo.InChanger = false;
497 dev->VolCatInfo.InChanger = false;
498 Dmsg0(400, "update vol info in mount\n");
499 dir_update_volume_info(dcr, true); /* set new status */
503 * Either because we are going to hang a new volume, or because
504 * of explicit user request, we release the current volume.
506 void release_volume(DCR *dcr)
509 DEVICE *dev = dcr->dev;
511 Jmsg0(jcr, M_ERROR, 0, _("Hey!!!!! WroteVol non-zero !!!!!\n"));
512 Dmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
515 * First erase all memory of the current volume
517 dev->block_num = dev->file = 0;
518 dev->EndBlock = dev->EndFile = 0;
519 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
520 memset(&dcr->VolCatInfo, 0, sizeof(dcr->VolCatInfo));
522 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
523 /* Force re-read of label */
524 dev->clear_labeled();
527 dev->label_type = B_BACULA_LABEL;
528 dcr->VolumeName[0] = 0;
530 if (dev->is_open() && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
534 /* If we have not closed the device, then at least rewind the tape */
535 if (dev->is_open()) {
536 dev->offline_or_rewind();
538 Dmsg0(190, "release_volume\n");
542 * If we are reading, we come here at the end of the tape
543 * and see if there are more volumes to be mounted.
545 bool mount_next_read_volume(DCR *dcr)
547 DEVICE *dev = dcr->dev;
549 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
551 * End Of Tape -- mount next Volume (if another specified)
553 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
555 if (!acquire_device_for_read(dcr)) {
556 Jmsg2(jcr, M_FATAL, 0, _("Cannot open Dev=%s, Vol=%s\n"), dev->print_name(),
560 return true; /* next volume mounted */
562 Dmsg0(90, "End of Device reached.\n");