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 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);
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);
101 * Get next volume and ready it for append
102 * This code ensures that the device is ready for
103 * writing. We start from the assumption that there
104 * may not be a tape mounted.
106 * If the device is a file, we create the output
107 * file. If it is a tape, we check the volume name
108 * and move the tape to the end of data.
111 if (autoload_device(dcr, 1, NULL) > 0) {
116 dcr->VolCatInfo.Slot = 0;
118 Dmsg1(100, "autoload_dev returns %d\n", autochanger);
120 * If we autochanged to correct Volume or (we have not just
121 * released the Volume AND we can automount) we go ahead
122 * and read the label. If there is no tape in the drive,
123 * we will err, recurse and ask the operator the next time.
125 if (!release && dev->is_tape() && dev_cap(dev, CAP_AUTOMOUNT)) {
126 ask = false; /* don't ask SYSOP this time */
128 /* Don't ask if not removable */
129 if (!dev_cap(dev, CAP_REM)) {
132 Dmsg2(100, "Ask=%d autochanger=%d\n", ask, autochanger);
133 release = true; /* release next time if we "recurse" */
135 if (ask && !dir_ask_sysop_to_mount_volume(dcr)) {
136 Dmsg0(100, "Error return ask_sysop ...\n");
137 return false; /* error return */
139 if (job_canceled(jcr)) {
142 Dmsg1(100, "want vol=%s\n", dcr->VolumeName);
144 if (dev->poll && dev_cap(dev, CAP_CLOSEONPOLL)) {
145 force_close_device(dev);
148 /* Ensure the device is open */
149 if (!open_device(dcr)) {
158 * Now make sure we have the right tape mounted
162 * If we are writing to a stream device, ASSUME the volume label
165 if (dev_cap(dev, CAP_STREAM)) {
166 vol_label_status = VOL_OK;
167 create_volume_label(dev, dcr->VolumeName, "Default");
168 dev->VolHdr.LabelType = PRE_LABEL;
170 vol_label_status = read_dev_volume_label(dcr);
172 if (job_canceled(jcr)) {
176 Dmsg2(100, "Want dirVol=%s dirStat=%s\n", dcr->VolumeName,
177 dcr->VolCatInfo.VolCatStatus);
179 * At this point, dev->VolCatInfo has what is in the drive, if anything,
180 * and dcr->VolCatInfo has what the Director wants.
182 switch (vol_label_status) {
184 Dmsg1(100, "Vol OK name=%s\n", dcr->VolumeName);
185 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
186 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
187 break; /* got a Volume */
189 VOLUME_CAT_INFO VolCatInfo, devVolCatInfo;
191 /* If not removable, Volume is broken */
192 if (!dev_cap(dev, CAP_REM)) {
193 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
194 dcr->VolumeName, dev->print_name());
195 mark_volume_in_error(dcr);
199 Dmsg1(100, "Vol NAME Error Name=%s\n", dcr->VolumeName);
200 /* If polling and got a previous bad name, ignore it */
201 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolumeName) == 0) {
203 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n",
208 * OK, we got a different volume mounted. First save the
209 * requested Volume info (dcr) structure, then query if
210 * this volume is really OK. If not, put back the desired
211 * volume name, mark it not in changer and continue.
213 memcpy(&VolCatInfo, &dcr->VolCatInfo, sizeof(VolCatInfo));
214 memcpy(&devVolCatInfo, &dev->VolCatInfo, sizeof(devVolCatInfo));
215 /* Check if this is a valid Volume in the pool */
216 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
217 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
218 /* Restore desired volume name, note device info out of sync */
219 /* This gets the info regardless of the Pool */
220 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
221 if (autochanger && !dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
222 mark_volume_not_inchanger(dcr);
224 memcpy(&dev->VolCatInfo, &devVolCatInfo, sizeof(dev->VolCatInfo));
225 bstrncpy(dev->BadVolName, dev->VolHdr.VolumeName, sizeof(dev->BadVolName));
226 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
227 " Current Volume \"%s\" not acceptable because:\n"
229 VolCatInfo.VolCatName, dev->VolHdr.VolumeName,
230 jcr->dir_bsock->msg);
234 /* This was not the volume we expected, but it is OK with
235 * the Director, so use it.
237 Dmsg1(100, "want new name=%s\n", dcr->VolumeName);
238 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
239 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
240 break; /* got a Volume */
242 * At this point, we assume we have a blank tape mounted.
246 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
247 mark_volume_in_error(dcr);
248 return false; /* we could not write on DVD */
250 /* Fall through wanted */
253 * If permitted, we label the device, make sure we can do
254 * it by checking that the VolCatBytes is zero => not labeled,
255 * once the Volume is labeled we don't want to label another
256 * blank tape with the same name. For disk, we go ahead and
257 * label it anyway, because the OS insures that there is only
258 * one Volume with that name.
259 * As noted above, at this point dcr->VolCatInfo has what
260 * the Director wants and dev->VolCatInfo has info on the
261 * previous tape (or nothing).
263 if (dev_cap(dev, CAP_LABEL) && (dcr->VolCatInfo.VolCatBytes == 0 ||
264 (!dev->is_tape() && strcmp(dcr->VolCatInfo.VolCatStatus,
266 Dmsg0(100, "Create volume label\n");
267 /* Create a new Volume label and write it to the device */
268 if (!write_new_volume_label_to_dev(dcr, dcr->VolumeName,
270 Dmsg0(100, "!write_vol_label\n");
271 mark_volume_in_error(dcr);
274 Dmsg0(100, "dir_update_vol_info. Set Append\n");
275 /* Copy Director's info into the device info */
276 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
277 if (!dir_update_volume_info(dcr, true)) { /* indicate tape labeled */
280 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
281 dcr->VolumeName, dev->print_name());
282 goto read_volume; /* read label we just wrote */
284 if (!dev_cap(dev, CAP_LABEL) && dcr->VolCatInfo.VolCatBytes == 0) {
285 Jmsg(jcr, M_INFO, 0, _("Warning device %s not configured to autolabel Volumes.\n"),
288 /* If not removable, Volume is broken */
289 if (!dev_cap(dev, CAP_REM)) {
290 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
291 dcr->VolumeName, dev->print_name());
292 mark_volume_in_error(dcr);
295 /* NOTE! Fall-through wanted. */
298 /* Send error message */
301 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
304 /* Needed, so the medium can be changed */
305 if (dev->requires_mount()) {
312 * See if we have a fresh tape or a tape with data.
314 * Note, if the LabelType is PRE_LABEL, it was labeled
315 * but never written. If so, rewrite the label but set as
316 * VOL_LABEL. We rewind and return the label (reconstructed)
317 * in the block so that in the case of a new tape, data can
318 * be appended just after the block label. If we are writing
319 * a second volume, the calling routine will write the label
320 * before writing the overflow block.
322 * If the tape is marked as Recycle, we rewrite the label.
324 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
325 if (!rewrite_volume_label(dcr, recycle)) {
326 mark_volume_in_error(dcr);
331 * OK, at this point, we have a valid Bacula label, but
332 * we need to position to the end of the volume, since we are
333 * just now putting it into append mode.
335 Dmsg0(200, "Device previously written, moving to end of data\n");
336 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
339 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device %s: ERR=%s\n"),
340 dev->print_name(), strerror_dev(dev));
341 mark_volume_in_error(dcr);
344 /* *****FIXME**** we should do some checking for files too */
345 if (dev->is_tape()) {
347 * Check if we are positioned on the tape at the same place
348 * that the database says we should be.
350 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
351 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
352 dcr->VolumeName, dev_file(dev));
354 Jmsg(jcr, M_ERROR, 0, _("I cannot write on Volume \"%s\" because:\n"
355 "The number of files mismatch! Volume=%u Catalog=%u\n"),
356 dcr->VolumeName, dev_file(dev), dev->VolCatInfo.VolCatFiles);
357 mark_volume_in_error(dcr);
361 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
362 Dmsg1(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
363 if (!dir_update_volume_info(dcr, false)) {
366 /* Return an empty block */
367 empty_block(block); /* we used it for reading so set for write */
370 Dmsg0(100, "set APPEND, normal return from read_dev_for_append\n");
377 * Mark volume in error in catalog
379 void mark_volume_in_error(DCR *dcr)
381 DEVICE *dev = dcr->dev;
382 Jmsg(dcr->jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
384 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
385 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
386 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
387 dir_update_volume_info(dcr, false);
391 * The Volume is not in the correct slot, so mark this
392 * Volume as not being in the Changer.
394 static void mark_volume_not_inchanger(DCR *dcr)
397 DEVICE *dev = dcr->dev;
398 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
399 " Setting InChanger to zero in catalog.\n"),
400 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot);
401 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
402 dcr->VolCatInfo.InChanger = false;
403 dev->VolCatInfo.InChanger = false;
404 Dmsg0(400, "update vol info in mount\n");
405 dir_update_volume_info(dcr, true); /* set new status */
409 * Either because we are going to hang a new volume, or because
410 * of explicit user request, we release the current volume.
412 void release_volume(DCR *dcr)
415 DEVICE *dev = dcr->dev;
417 Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
418 Dmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
421 * First erase all memory of the current volume
423 dev->block_num = dev->file = 0;
424 dev->EndBlock = dev->EndFile = 0;
425 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
426 memset(&dcr->VolCatInfo, 0, sizeof(dcr->VolCatInfo));
428 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
429 /* Force re-read of label */
430 dev->clear_labeled();
433 dev->label_type = B_BACULA_LABEL;
434 dcr->VolumeName[0] = 0;
436 if (dev->is_open() && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
437 offline_or_rewind_dev(dev);
441 /* If we have not closed the device, then at least rewind the tape */
442 if (dev->is_open()) {
443 offline_or_rewind_dev(dev);
445 Dmsg0(190, "release_volume\n");
449 * If we are reading, we come here at the end of the tape
450 * and see if there are more volumes to be mounted.
452 bool mount_next_read_volume(DCR *dcr)
454 DEVICE *dev = dcr->dev;
456 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
458 * End Of Tape -- mount next Volume (if another specified)
460 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
463 if (!acquire_device_for_read(dcr)) {
464 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev->print_name(),
468 return true; /* next volume mounted */
470 Dmsg0(90, "End of Device reached.\n");