3 * Routines for handling mounting tapes for reading and for
6 * Kern Sibbald, August MMII
11 Copyright (C) 2000-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 as
15 published by the Free Software Foundation; either version 2 of
16 the License, or (at your option) any later version.
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 GNU
21 General Public License for more details.
23 You should have received a copy of the GNU General Public
24 License along with this program; if not, write to the Free
25 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 #include "bacula.h" /* pull in global headers */
31 #include "stored.h" /* pull in Storage Deamon headers */
33 static void mark_volume_not_inchanger(DCR *dcr);
37 * If release is set, we rewind the current volume,
38 * which we no longer want, and ask the user (console)
39 * to mount the next volume.
41 * Continue trying until we get it, and then ensure
42 * that we can write on it.
44 * This routine returns a 0 only if it is REALLY
45 * impossible to get the requested Volume.
48 bool mount_next_write_volume(DCR *dcr, bool release)
51 bool ask = false, recycle, autochanger;
53 DEVICE *dev = dcr->dev;
55 DEV_BLOCK *block = dcr->block;
57 Dmsg0(100, "Enter mount_next_volume()\n");
59 init_device_wait_timers(dcr);
62 * Attempt to mount the next volume. If something non-fatal goes
63 * wrong, we come back here to re-try (new op messages, re-read
67 /* Ignore retry if this is poll request */
68 if (!dev->poll && retry++ > 4) {
69 /* Last ditch effort before giving up, force operator to respond */
70 dcr->VolCatInfo.Slot = 0;
71 if (!dir_ask_sysop_to_mount_volume(dcr)) {
72 Jmsg(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"),
77 if (job_canceled(jcr)) {
78 Jmsg(jcr, M_FATAL, 0, _("Job %d canceled.\n"), jcr->JobId);
83 Dmsg0(100, "mount_next_volume release=1\n");
85 ask = true; /* ask operator to mount tape */
89 * Get Director's idea of what tape we should have mounted.
92 Dmsg0(200, "Before dir_find_next_appendable_volume.\n");
93 while (!dir_find_next_appendable_volume(dcr)) {
94 Dmsg0(200, "not dir_find_next\n");
95 if (!dir_ask_sysop_to_create_appendable_volume(dcr)) {
98 Dmsg0(200, "Again dir_find_next_append...\n");
100 if (job_canceled(jcr)) {
103 Dmsg3(100, "After find_next_append. Vol=%s Slot=%d Parts=%d\n",
104 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot, dcr->VolCatInfo.VolCatParts);
106 dev->num_parts = dcr->VolCatInfo.VolCatParts;
109 * Get next volume and ready it for append
110 * This code ensures that the device is ready for
111 * writing. We start from the assumption that there
112 * may not be a tape mounted.
114 * If the device is a file, we create the output
115 * file. If it is a tape, we check the volume name
116 * and move the tape to the end of data.
119 if (autoload_device(dcr, 1, NULL) > 0) {
124 dcr->VolCatInfo.Slot = 0;
126 Dmsg1(100, "autoload_dev returns %d\n", autochanger);
128 * If we autochanged to correct Volume or (we have not just
129 * released the Volume AND we can automount) we go ahead
130 * and read the label. If there is no tape in the drive,
131 * we will err, recurse and ask the operator the next time.
133 if (!release && dev->is_tape() && dev_cap(dev, CAP_AUTOMOUNT)) {
134 ask = false; /* don't ask SYSOP this time */
136 /* Don't ask if not removable */
137 if (!dev_cap(dev, CAP_REM)) {
140 Dmsg2(100, "Ask=%d autochanger=%d\n", ask, autochanger);
141 release = true; /* release next time if we "recurse" */
143 if (ask && !dir_ask_sysop_to_mount_volume(dcr)) {
144 Dmsg0(100, "Error return ask_sysop ...\n");
145 return false; /* error return */
147 if (job_canceled(jcr)) {
150 Dmsg1(100, "want vol=%s\n", dcr->VolumeName);
152 if (dev->poll && dev_cap(dev, CAP_CLOSEONPOLL)) {
153 force_close_dev(dev);
156 /* Ensure the device is open */
157 /* If we have a dvd that requires mount, we first want to guess
158 * which Volume is loaded, so we continue (if the wrong device is
159 * loaded, open_device just below would fail.
161 if (!dev->is_dvd()) {
162 if (!open_device(dcr)) {
171 * Just copy the VolCatName in the device resource
172 * (usually done by open_dev).
173 * It is necessary so we can open the real files later.
175 bstrncpy(dev->VolCatInfo.VolCatName, dcr->VolCatInfo.VolCatName, sizeof(dev->VolCatInfo.VolCatName));
179 * Now make sure we have the right tape mounted
183 * If we are writing to a stream device, ASSUME the volume label
186 if (dev_cap(dev, CAP_STREAM)) {
187 vol_label_status = VOL_OK;
188 create_volume_label(dev, dcr->VolumeName, "Default");
189 dev->VolHdr.LabelType = PRE_LABEL;
190 } else if (dev->is_dvd()) {
191 vol_label_status = read_dev_volume_label_guess(dcr, 1);
193 vol_label_status = read_dev_volume_label(dcr);
195 if (job_canceled(jcr)) {
199 Dmsg2(100, "dirVol=%s dirStat=%s\n", dcr->VolumeName,
200 dcr->VolCatInfo.VolCatStatus);
202 * At this point, dev->VolCatInfo has what is in the drive, if anything,
203 * and dcr->VolCatInfo has what the Director wants.
205 switch (vol_label_status) {
207 Dmsg1(100, "Vol OK name=%s\n", dcr->VolumeName);
208 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
209 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
210 break; /* got a Volume */
212 VOLUME_CAT_INFO VolCatInfo, devVolCatInfo;
214 /* If not removable, Volume is broken */
215 if (!dev_cap(dev, CAP_REM)) {
216 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
217 dcr->VolumeName, dev->print_name());
218 mark_volume_in_error(dcr);
222 Dmsg1(100, "Vol NAME Error Name=%s\n", dcr->VolumeName);
223 /* If polling and got a previous bad name, ignore it */
224 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolName) == 0) {
226 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n",
231 * OK, we got a different volume mounted. First save the
232 * requested Volume info (dcr) structure, then query if
233 * this volume is really OK. If not, put back the desired
234 * volume name, mark it not in changer and continue.
236 memcpy(&VolCatInfo, &dcr->VolCatInfo, sizeof(VolCatInfo));
237 memcpy(&devVolCatInfo, &dev->VolCatInfo, sizeof(devVolCatInfo));
238 /* Check if this is a valid Volume in the pool */
239 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
240 /* Restore desired volume name, note device info out of sync */
241 /* This gets the info regardless of the Pool */
242 bstrncpy(dcr->VolumeName, dev->VolHdr.VolName, sizeof(dcr->VolumeName));
243 if (autochanger && dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
244 mark_volume_not_inchanger(dcr);
246 memcpy(&dev->VolCatInfo, &devVolCatInfo, sizeof(dev->VolCatInfo));
247 bstrncpy(dev->BadVolName, dev->VolHdr.VolName, sizeof(dev->BadVolName));
248 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
249 " Current Volume \"%s\" not acceptable because:\n"
251 VolCatInfo.VolCatName, dev->VolHdr.VolName,
252 jcr->dir_bsock->msg);
256 /* This was not the volume we expected, but it is OK with
257 * the Director, so use it.
259 Dmsg1(100, "want new name=%s\n", dcr->VolumeName);
260 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
261 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
262 break; /* got a Volume */
264 * At this point, we assume we have a blank tape mounted.
269 * If permitted, we label the device, make sure we can do
270 * it by checking that the VolCatBytes is zero => not labeled,
271 * once the Volume is labeled we don't want to label another
272 * blank tape with the same name. For disk, we go ahead and
273 * label it anyway, because the OS insures that there is only
274 * one Volume with that name.
275 * As noted above, at this point dcr->VolCatInfo has what
276 * the Director wants and dev->VolCatInfo has info on the
277 * previous tape (or nothing).
279 if (dev_cap(dev, CAP_LABEL) && (dcr->VolCatInfo.VolCatBytes == 0 ||
280 (!dev->is_tape() && strcmp(dcr->VolCatInfo.VolCatStatus,
282 Dmsg0(100, "Create volume label\n");
283 /* Create a new Volume label and write it to the device */
284 if (!write_new_volume_label_to_dev(dcr, dcr->VolumeName,
286 Dmsg0(100, "!write_vol_label\n");
287 mark_volume_in_error(dcr);
290 Dmsg0(100, "dir_update_vol_info. Set Append\n");
291 /* Copy Director's info into the device info */
292 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
293 if (!dir_update_volume_info(dcr, true)) { /* indicate tape labeled */
296 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
297 dcr->VolumeName, dev->print_name());
298 goto read_volume; /* read label we just wrote */
300 /* If not removable, Volume is broken */
301 if (!dev_cap(dev, CAP_REM)) {
302 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
303 dcr->VolumeName, dev->print_name());
304 mark_volume_in_error(dcr);
307 /* NOTE! Fall-through wanted. */
310 /* Send error message */
312 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
314 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
317 /* Needed, so the medium can be changed */
318 if (dev_cap(dev, CAP_REQMOUNT)) {
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"),
351 #if defined (__digital__) && defined (__unix__)
352 if (!fsf_dev(dev,dev->VolCatInfo.VolCatFiles)) {
356 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device %s: ERR=%s\n"),
357 dev->print_name(), strerror_dev(dev));
358 mark_volume_in_error(dcr);
361 /* *****FIXME**** we should do some checking for files too */
362 if (dev->is_tape()) {
364 * Check if we are positioned on the tape at the same place
365 * that the database says we should be.
367 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
368 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
369 dcr->VolumeName, dev_file(dev));
371 Jmsg(jcr, M_ERROR, 0, _("I cannot write on Volume \"%s\" because:\n"
372 "The number of files mismatch! Volume=%u Catalog=%u\n"),
373 dcr->VolumeName, dev_file(dev), dev->VolCatInfo.VolCatFiles);
374 mark_volume_in_error(dcr);
378 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
379 Dmsg1(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
380 if (!dir_update_volume_info(dcr, false)) {
383 /* Return an empty block */
384 empty_block(block); /* we used it for reading so set for write */
387 Dmsg0(100, "set APPEND, normal return from read_dev_for_append\n");
394 * Mark volume in error in catalog
396 void mark_volume_in_error(DCR *dcr)
398 DEVICE *dev = dcr->dev;
399 Jmsg(dcr->jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
401 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
402 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
403 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
404 dir_update_volume_info(dcr, false);
408 * The Volume is not in the correct slot, so mark this
409 * Volume as not being in the Changer.
411 static void mark_volume_not_inchanger(DCR *dcr)
414 DEVICE *dev = dcr->dev;
415 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
416 " Setting InChanger to zero in catalog.\n"),
417 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot);
418 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
419 dcr->VolCatInfo.InChanger = false;
420 dev->VolCatInfo.InChanger = false;
421 Dmsg0(400, "update vol info in mount\n");
422 dir_update_volume_info(dcr, true); /* set new status */
427 * If we are reading, we come here at the end of the tape
428 * and see if there are more volumes to be mounted.
430 bool mount_next_read_volume(DCR *dcr)
432 DEVICE *dev = dcr->dev;
434 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
436 * End Of Tape -- mount next Volume (if another specified)
438 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
441 if (!acquire_device_for_read(dcr)) {
442 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev->print_name(),
446 return true; /* next volume mounted */
448 Dmsg0(90, "End of Device reached.\n");
453 * Either because we are going to hang a new volume, or because
454 * of explicit user request, we release the current volume.
456 void release_volume(DCR *dcr)
459 DEVICE *dev = dcr->dev;
461 Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
462 Dmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
465 * First erase all memory of the current volume
467 dev->block_num = dev->file = 0;
468 dev->EndBlock = dev->EndFile = 0;
469 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
470 memset(&dcr->VolCatInfo, 0, sizeof(dcr->VolCatInfo));
471 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
472 /* Force re-read of label */
473 dev->state &= ~(ST_LABEL|ST_READ|ST_APPEND);
474 dev->label_type = B_BACULA_LABEL;
475 dcr->VolumeName[0] = 0;
477 if (dev->is_open() && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
478 offline_or_rewind_dev(dev);
482 /* If we have not closed the device, then at least rewind the tape */
483 if (dev->is_open()) {
484 offline_or_rewind_dev(dev);
486 Dmsg0(190, "===== release_volume ---");