3 * Routines for handling mounting tapes for reading and for
6 * Kern Sibbald, August MMII
11 Copyright (C) 2002-2005 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 ammended 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);
31 * If release is set, we rewind the current volume,
32 * which we no longer want, and ask the user (console)
33 * to mount the next volume.
35 * Continue trying until we get it, and then ensure
36 * that we can write on it.
38 * This routine returns a 0 only if it is REALLY
39 * impossible to get the requested Volume.
42 bool mount_next_write_volume(DCR *dcr, bool release)
45 bool ask = false, recycle, autochanger;
47 DEVICE *dev = dcr->dev;
49 DEV_BLOCK *block = dcr->block;
51 Dmsg0(100, "Enter mount_next_volume()\n");
53 init_device_wait_timers(dcr);
56 * Attempt to mount the next volume. If something non-fatal goes
57 * wrong, we come back here to re-try (new op messages, re-read
61 /* Ignore retry if this is poll request */
62 if (!dev->poll && retry++ > 4) {
63 /* Last ditch effort before giving up, force operator to respond */
64 dcr->VolCatInfo.Slot = 0;
65 if (!dir_ask_sysop_to_mount_volume(dcr)) {
66 Jmsg(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"),
71 if (job_canceled(jcr)) {
72 Jmsg(jcr, M_FATAL, 0, _("Job %d canceled.\n"), jcr->JobId);
77 Dmsg0(100, "mount_next_volume release=1\n");
79 ask = true; /* ask operator to mount tape */
83 * Get Director's idea of what tape we should have mounted.
86 Dmsg0(200, "Before dir_find_next_appendable_volume.\n");
87 while (!dir_find_next_appendable_volume(dcr)) {
88 Dmsg0(200, "not dir_find_next\n");
89 if (!dir_ask_sysop_to_create_appendable_volume(dcr)) {
92 Dmsg0(200, "Again dir_find_next_append...\n");
94 if (job_canceled(jcr)) {
97 Dmsg3(100, "After find_next_append. Vol=%s Slot=%d Parts=%d\n",
98 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot, dcr->VolCatInfo.VolCatParts);
100 dev->num_parts = dcr->VolCatInfo.VolCatParts;
103 * Get next volume and ready it for append
104 * This code ensures that the device is ready for
105 * writing. We start from the assumption that there
106 * may not be a tape mounted.
108 * If the device is a file, we create the output
109 * file. If it is a tape, we check the volume name
110 * and move the tape to the end of data.
113 if (autoload_device(dcr, 1, NULL) > 0) {
118 dcr->VolCatInfo.Slot = 0;
120 Dmsg1(100, "autoload_dev returns %d\n", autochanger);
122 * If we autochanged to correct Volume or (we have not just
123 * released the Volume AND we can automount) we go ahead
124 * and read the label. If there is no tape in the drive,
125 * we will err, recurse and ask the operator the next time.
127 if (!release && dev->is_tape() && dev_cap(dev, CAP_AUTOMOUNT)) {
128 ask = false; /* don't ask SYSOP this time */
130 /* Don't ask if not removable */
131 if (!dev_cap(dev, CAP_REM)) {
134 Dmsg2(100, "Ask=%d autochanger=%d\n", ask, autochanger);
135 release = true; /* release next time if we "recurse" */
137 if (ask && !dir_ask_sysop_to_mount_volume(dcr)) {
138 Dmsg0(100, "Error return ask_sysop ...\n");
139 return false; /* error return */
141 if (job_canceled(jcr)) {
144 Dmsg1(100, "want vol=%s\n", dcr->VolumeName);
146 if (dev->poll && dev_cap(dev, CAP_CLOSEONPOLL)) {
147 force_close_device(dev);
150 /* Ensure the device is open */
151 /* If we have a dvd that requires mount, we first want to guess
152 * which Volume is loaded, so we continue (if the wrong device is
153 * loaded, open_device just below would fail.
155 if (!dev->is_dvd()) {
156 if (!open_device(dcr)) {
165 * Just copy the VolCatName in the device resource
166 * (usually done by open_dev).
167 * It is necessary so we can open the real files later.
169 bstrncpy(dev->VolCatInfo.VolCatName, dcr->VolCatInfo.VolCatName, sizeof(dev->VolCatInfo.VolCatName));
173 * Now make sure we have the right tape mounted
177 * If we are writing to a stream device, ASSUME the volume label
180 if (dev_cap(dev, CAP_STREAM)) {
181 vol_label_status = VOL_OK;
182 create_volume_label(dev, dcr->VolumeName, "Default");
183 dev->VolHdr.LabelType = PRE_LABEL;
184 } else if (dev->is_dvd()) {
185 vol_label_status = read_dvd_volume_label(dcr, /*write*/true);
187 vol_label_status = read_dev_volume_label(dcr);
189 if (job_canceled(jcr)) {
193 Dmsg2(100, "Want dirVol=%s dirStat=%s\n", dcr->VolumeName,
194 dcr->VolCatInfo.VolCatStatus);
196 * At this point, dev->VolCatInfo has what is in the drive, if anything,
197 * and dcr->VolCatInfo has what the Director wants.
199 switch (vol_label_status) {
201 Dmsg1(100, "Vol OK name=%s\n", dcr->VolumeName);
202 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
203 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
204 break; /* got a Volume */
206 VOLUME_CAT_INFO VolCatInfo, devVolCatInfo;
208 /* If not removable, Volume is broken */
209 if (!dev_cap(dev, CAP_REM)) {
210 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
211 dcr->VolumeName, dev->print_name());
212 mark_volume_in_error(dcr);
216 Dmsg1(100, "Vol NAME Error Name=%s\n", dcr->VolumeName);
217 /* If polling and got a previous bad name, ignore it */
218 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolumeName) == 0) {
220 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n",
225 * OK, we got a different volume mounted. First save the
226 * requested Volume info (dcr) structure, then query if
227 * this volume is really OK. If not, put back the desired
228 * volume name, mark it not in changer and continue.
230 memcpy(&VolCatInfo, &dcr->VolCatInfo, sizeof(VolCatInfo));
231 memcpy(&devVolCatInfo, &dev->VolCatInfo, sizeof(devVolCatInfo));
232 /* Check if this is a valid Volume in the pool */
233 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
234 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
235 /* Restore desired volume name, note device info out of sync */
236 /* This gets the info regardless of the Pool */
237 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
238 if (autochanger && dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
239 mark_volume_not_inchanger(dcr);
241 memcpy(&dev->VolCatInfo, &devVolCatInfo, sizeof(dev->VolCatInfo));
242 bstrncpy(dev->BadVolName, dev->VolHdr.VolumeName, sizeof(dev->BadVolName));
243 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
244 " Current Volume \"%s\" not acceptable because:\n"
246 VolCatInfo.VolCatName, dev->VolHdr.VolumeName,
247 jcr->dir_bsock->msg);
251 /* This was not the volume we expected, but it is OK with
252 * the Director, so use it.
254 Dmsg1(100, "want new name=%s\n", dcr->VolumeName);
255 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
256 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
257 break; /* got a Volume */
259 * At this point, we assume we have a blank tape mounted.
263 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
264 mark_volume_in_error(dcr);
265 return false; /* we could not write on DVD */
267 /* Fall through wanted */
270 * If permitted, we label the device, make sure we can do
271 * it by checking that the VolCatBytes is zero => not labeled,
272 * once the Volume is labeled we don't want to label another
273 * blank tape with the same name. For disk, we go ahead and
274 * label it anyway, because the OS insures that there is only
275 * one Volume with that name.
276 * As noted above, at this point dcr->VolCatInfo has what
277 * the Director wants and dev->VolCatInfo has info on the
278 * previous tape (or nothing).
280 if (dev_cap(dev, CAP_LABEL) && (dcr->VolCatInfo.VolCatBytes == 0 ||
281 (!dev->is_tape() && strcmp(dcr->VolCatInfo.VolCatStatus,
283 Dmsg0(100, "Create volume label\n");
284 /* Create a new Volume label and write it to the device */
285 if (!write_new_volume_label_to_dev(dcr, dcr->VolumeName,
287 Dmsg0(100, "!write_vol_label\n");
288 mark_volume_in_error(dcr);
291 Dmsg0(100, "dir_update_vol_info. Set Append\n");
292 /* Copy Director's info into the device info */
293 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
294 if (!dir_update_volume_info(dcr, true)) { /* indicate tape labeled */
297 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
298 dcr->VolumeName, dev->print_name());
299 goto read_volume; /* read label we just wrote */
301 /* If not removable, Volume is broken */
302 if (!dev_cap(dev, CAP_REM)) {
303 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
304 dcr->VolumeName, dev->print_name());
305 mark_volume_in_error(dcr);
308 /* NOTE! Fall-through wanted. */
311 /* Send error message */
314 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
317 /* Needed, so the medium can be changed */
318 if (dev->requires_mount()) {
325 * See if we have a fresh tape or a tape with data.
327 * Note, if the LabelType is PRE_LABEL, it was labeled
328 * but never written. If so, rewrite the label but set as
329 * VOL_LABEL. We rewind and return the label (reconstructed)
330 * in the block so that in the case of a new tape, data can
331 * be appended just after the block label. If we are writing
332 * a second volume, the calling routine will write the label
333 * before writing the overflow block.
335 * If the tape is marked as Recycle, we rewrite the label.
337 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
338 if (!rewrite_volume_label(dcr, recycle)) {
339 mark_volume_in_error(dcr);
344 * OK, at this point, we have a valid Bacula label, but
345 * we need to position to the end of the volume, since we are
346 * just now putting it into append mode.
348 Dmsg0(200, "Device previously written, moving to end of data\n");
349 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
352 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device %s: ERR=%s\n"),
353 dev->print_name(), strerror_dev(dev));
354 mark_volume_in_error(dcr);
357 /* *****FIXME**** we should do some checking for files too */
358 if (dev->is_tape()) {
360 * Check if we are positioned on the tape at the same place
361 * that the database says we should be.
363 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
364 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
365 dcr->VolumeName, dev_file(dev));
367 Jmsg(jcr, M_ERROR, 0, _("I cannot write on Volume \"%s\" because:\n"
368 "The number of files mismatch! Volume=%u Catalog=%u\n"),
369 dcr->VolumeName, dev_file(dev), dev->VolCatInfo.VolCatFiles);
370 mark_volume_in_error(dcr);
374 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
375 Dmsg1(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
376 if (!dir_update_volume_info(dcr, false)) {
379 /* Return an empty block */
380 empty_block(block); /* we used it for reading so set for write */
383 Dmsg0(100, "set APPEND, normal return from read_dev_for_append\n");
390 * Mark volume in error in catalog
392 void mark_volume_in_error(DCR *dcr)
394 DEVICE *dev = dcr->dev;
395 Jmsg(dcr->jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
397 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
398 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
399 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
400 dir_update_volume_info(dcr, false);
404 * The Volume is not in the correct slot, so mark this
405 * Volume as not being in the Changer.
407 static void mark_volume_not_inchanger(DCR *dcr)
410 DEVICE *dev = dcr->dev;
411 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
412 " Setting InChanger to zero in catalog.\n"),
413 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot);
414 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
415 dcr->VolCatInfo.InChanger = false;
416 dev->VolCatInfo.InChanger = false;
417 Dmsg0(400, "update vol info in mount\n");
418 dir_update_volume_info(dcr, true); /* set new status */
422 * Either because we are going to hang a new volume, or because
423 * of explicit user request, we release the current volume.
425 void release_volume(DCR *dcr)
428 DEVICE *dev = dcr->dev;
430 Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
431 Dmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
434 * First erase all memory of the current volume
436 dev->block_num = dev->file = 0;
437 dev->EndBlock = dev->EndFile = 0;
438 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
439 memset(&dcr->VolCatInfo, 0, sizeof(dcr->VolCatInfo));
441 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
442 /* Force re-read of label */
443 dev->clear_labeled();
446 dev->label_type = B_BACULA_LABEL;
447 dcr->VolumeName[0] = 0;
449 if (dev->is_open() && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
450 offline_or_rewind_dev(dev);
454 /* If we have not closed the device, then at least rewind the tape */
455 if (dev->is_open()) {
456 offline_or_rewind_dev(dev);
458 Dmsg0(190, "===== release_volume ---");
462 * If we are reading, we come here at the end of the tape
463 * and see if there are more volumes to be mounted.
465 bool mount_next_read_volume(DCR *dcr)
467 DEVICE *dev = dcr->dev;
469 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
471 * End Of Tape -- mount next Volume (if another specified)
473 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
476 if (!acquire_device_for_read(dcr)) {
477 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev->print_name(),
481 return true; /* next volume mounted */
483 Dmsg0(90, "End of Device reached.\n");