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 Dmsg1(150, "Enter mount_next_volume(release=%d)\n", release);
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 Dmsg1(150, "mount_next_vol retry=%d\n", retry);
62 /* Ignore retry if this is poll request */
63 if (!dev->poll && retry++ > 4) {
64 /* Last ditch effort before giving up, force operator to respond */
65 dcr->VolCatInfo.Slot = 0;
66 if (!dir_ask_sysop_to_mount_volume(dcr)) {
67 Jmsg(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"),
72 if (job_canceled(jcr)) {
73 Jmsg(jcr, M_FATAL, 0, _("Job %d canceled.\n"), jcr->JobId);
78 Dmsg0(150, "mount_next_volume release=1\n");
80 ask = true; /* ask operator to mount tape */
84 * Get Director's idea of what tape we should have mounted.
87 Dmsg0(200, "Before dir_find_next_appendable_volume.\n");
88 while (!dir_find_next_appendable_volume(dcr)) {
89 Dmsg0(200, "not dir_find_next\n");
90 if (!dir_ask_sysop_to_create_appendable_volume(dcr)) {
93 Dmsg0(200, "Again dir_find_next_append...\n");
95 if (job_canceled(jcr)) {
98 Dmsg3(150, "After find_next_append. Vol=%s Slot=%d Parts=%d\n",
99 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot, dcr->VolCatInfo.VolCatParts);
102 * Get next volume and ready it for append
103 * This code ensures that the device is ready for
104 * writing. We start from the assumption that there
105 * may not be a tape mounted.
107 * If the device is a file, we create the output
108 * file. If it is a tape, we check the volume name
109 * and move the tape to the end of data.
112 if (autoload_device(dcr, 1, NULL) > 0) {
117 dcr->VolCatInfo.Slot = 0;
119 Dmsg1(200, "autoload_dev returns %d\n", autochanger);
121 * If we autochanged to correct Volume or (we have not just
122 * released the Volume AND we can automount) we go ahead
123 * and read the label. If there is no tape in the drive,
124 * we will err, recurse and ask the operator the next time.
126 if (!release && dev->is_tape() && dev_cap(dev, CAP_AUTOMOUNT)) {
127 Dmsg0(150, "(1)Ask=0\n");
128 ask = false; /* don't ask SYSOP this time */
130 /* Don't ask if not removable */
131 if (!dev_cap(dev, CAP_REM)) {
132 Dmsg0(150, "(2)Ask=0\n");
135 Dmsg2(150, "Ask=%d autochanger=%d\n", ask, autochanger);
136 release = true; /* release next time if we "recurse" */
138 if (ask && !dir_ask_sysop_to_mount_volume(dcr)) {
139 Dmsg0(150, "Error return ask_sysop ...\n");
140 return false; /* error return */
142 if (job_canceled(jcr)) {
145 Dmsg1(150, "want vol=%s\n", dcr->VolumeName);
147 if (dev->poll && dev_cap(dev, CAP_CLOSEONPOLL)) {
148 force_close_device(dev);
151 /* Ensure the device is open */
152 if (!open_device(dcr)) {
153 /* If DVD, ignore the error, very often you cannot open the device
154 * (when there is no DVD, or when the one inserted is a wrong one) */
155 if ((dev->poll) || (dev->is_dvd())) {
163 * Now make sure we have the right tape mounted
167 * If we are writing to a stream device, ASSUME the volume label
170 if (dev_cap(dev, CAP_STREAM)) {
171 vol_label_status = VOL_OK;
172 create_volume_label(dev, dcr->VolumeName, "Default");
173 dev->VolHdr.LabelType = PRE_LABEL;
175 vol_label_status = read_dev_volume_label(dcr);
177 if (job_canceled(jcr)) {
181 Dmsg2(150, "Want dirVol=%s dirStat=%s\n", dcr->VolumeName,
182 dcr->VolCatInfo.VolCatStatus);
184 * At this point, dev->VolCatInfo has what is in the drive, if anything,
185 * and dcr->VolCatInfo has what the Director wants.
187 switch (vol_label_status) {
189 Dmsg1(150, "Vol OK name=%s\n", dcr->VolumeName);
190 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
191 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
192 break; /* got a Volume */
194 VOLUME_CAT_INFO VolCatInfo, devVolCatInfo;
196 /* If not removable, Volume is broken */
197 if (!dev_cap(dev, CAP_REM)) {
198 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
199 dcr->VolumeName, dev->print_name());
200 mark_volume_in_error(dcr);
204 Dmsg1(150, "Vol NAME Error Name=%s\n", dcr->VolumeName);
205 /* If polling and got a previous bad name, ignore it */
206 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolumeName) == 0) {
208 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n",
213 * OK, we got a different volume mounted. First save the
214 * requested Volume info (dcr) structure, then query if
215 * this volume is really OK. If not, put back the desired
216 * volume name, mark it not in changer and continue.
218 memcpy(&VolCatInfo, &dcr->VolCatInfo, sizeof(VolCatInfo));
219 memcpy(&devVolCatInfo, &dev->VolCatInfo, sizeof(devVolCatInfo));
220 /* Check if this is a valid Volume in the pool */
221 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
222 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
223 /* Saved bad volume name */
224 bstrncpy(dev->BadVolName, dev->VolHdr.VolumeName, sizeof(dev->BadVolName));
225 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\" for device %s.\n"
226 " Current Volume \"%s\" not acceptable because:\n"
228 VolCatInfo.VolCatName, dev->print_name(),
229 dev->VolHdr.VolumeName, jcr->dir_bsock->msg);
230 /* This gets the info regardless of the Pool so we can change chgr status */
231 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
232 if (autochanger && !dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
233 mark_volume_not_inchanger(dcr);
235 /* Restore original info */
236 memcpy(&dev->VolCatInfo, &devVolCatInfo, sizeof(dev->VolCatInfo));
240 /* This was not the volume we expected, but it is OK with
241 * the Director, so use it.
243 Dmsg1(150, "want new name=%s\n", dcr->VolumeName);
244 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
245 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
246 break; /* got a Volume */
248 * At this point, we assume we have a blank tape mounted.
252 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
253 mark_volume_in_error(dcr);
254 return false; /* we could not write on DVD */
256 /* Fall through wanted */
259 * If permitted, we label the device, make sure we can do
260 * it by checking that the VolCatBytes is zero => not labeled,
261 * once the Volume is labeled we don't want to label another
262 * blank tape with the same name. For disk, we go ahead and
263 * label it anyway, because the OS insures that there is only
264 * one Volume with that name.
265 * As noted above, at this point dcr->VolCatInfo has what
266 * the Director wants and dev->VolCatInfo has info on the
267 * previous tape (or nothing).
269 if (dev_cap(dev, CAP_LABEL) && (dcr->VolCatInfo.VolCatBytes == 0 ||
270 (!dev->is_tape() && strcmp(dcr->VolCatInfo.VolCatStatus,
272 Dmsg0(150, "Create volume label\n");
273 /* Create a new Volume label and write it to the device */
274 if (!write_new_volume_label_to_dev(dcr, dcr->VolumeName,
276 Dmsg0(150, "!write_vol_label\n");
277 mark_volume_in_error(dcr);
280 Dmsg0(150, "dir_update_vol_info. Set Append\n");
281 /* Copy Director's info into the device info */
282 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
283 if (!dir_update_volume_info(dcr, true)) { /* indicate tape labeled */
286 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
287 dcr->VolumeName, dev->print_name());
288 goto read_volume; /* read label we just wrote */
290 if (!dev_cap(dev, CAP_LABEL) && dcr->VolCatInfo.VolCatBytes == 0) {
291 Jmsg(jcr, M_INFO, 0, _("Warning device %s not configured to autolabel Volumes.\n"),
294 /* If not removable, Volume is broken */
295 if (!dev_cap(dev, CAP_REM)) {
296 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
297 dcr->VolumeName, dev->print_name());
298 mark_volume_in_error(dcr);
301 /* NOTE! Fall-through wanted. */
304 Dmsg0(200, "VOL_NO_MEDIA or default.\n");
305 /* Send error message */
308 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
311 /* Needed, so the medium can be changed */
312 if (dev->requires_mount()) {
319 * See if we have a fresh tape or a tape with data.
321 * Note, if the LabelType is PRE_LABEL, it was labeled
322 * but never written. If so, rewrite the label but set as
323 * VOL_LABEL. We rewind and return the label (reconstructed)
324 * in the block so that in the case of a new tape, data can
325 * be appended just after the block label. If we are writing
326 * a second volume, the calling routine will write the label
327 * before writing the overflow block.
329 * If the tape is marked as Recycle, we rewrite the label.
331 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
332 if (!rewrite_volume_label(dcr, recycle)) {
333 mark_volume_in_error(dcr);
338 * OK, at this point, we have a valid Bacula label, but
339 * we need to position to the end of the volume, since we are
340 * just now putting it into append mode.
342 Dmsg0(200, "Device previously written, moving to end of data\n");
343 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
346 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device %s: ERR=%s\n"),
347 dev->print_name(), strerror_dev(dev));
348 mark_volume_in_error(dcr);
351 /* *****FIXME**** we should do some checking for files too */
352 if (dev->is_tape()) {
354 * Check if we are positioned on the tape at the same place
355 * that the database says we should be.
357 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
358 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
359 dcr->VolumeName, dev_file(dev));
361 Jmsg(jcr, M_ERROR, 0, _("I cannot write on Volume \"%s\" because:\n"
362 "The number of files mismatch! Volume=%u Catalog=%u\n"),
363 dcr->VolumeName, dev_file(dev), dev->VolCatInfo.VolCatFiles);
364 mark_volume_in_error(dcr);
368 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
369 Dmsg1(150, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
370 if (!dir_update_volume_info(dcr, false)) {
375 * DVD : check if the last part was removed or truncated, or if a written
376 * part was overwritten.
377 * We need to do it after dir_update_volume_info, so we have the EndBlock
378 * info. (nb: I don't understand why VolCatFiles is set (used to check
379 * tape file number), but not EndBlock)
380 * Maybe could it be changed "dev->is_file()" (would remove the fixme above)
382 * Disabled: I had problems with this code...
383 * (maybe is it related to the seek bug ?)
387 Dmsg2(150, "DVD/File sanity check addr=%u vs endblock=%u\n", (unsigned int)dev->file_addr, (unsigned int)dev->VolCatInfo.EndBlock);
388 if (dev->file_addr == dev->VolCatInfo.EndBlock+1) {
389 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file address=%u.\n"),
390 dcr->VolumeName, (unsigned int)dev->file_addr);
393 Jmsg(jcr, M_ERROR, 0, _("I cannot write on Volume \"%s\" because:\n"
394 "The EOD file address is wrong: Volume file address=%u != Catalog Endblock=%u(+1)\n"
395 "You probably removed DVD last part in spool directory.\n"),
396 dcr->VolumeName, (unsigned int)dev->file_addr, (unsigned int)dev->VolCatInfo.EndBlock);
397 mark_volume_in_error(dcr);
403 /* Return an empty block */
404 empty_block(block); /* we used it for reading so set for write */
407 Dmsg0(150, "set APPEND, normal return from read_dev_for_append\n");
414 * Mark volume in error in catalog
416 void mark_volume_in_error(DCR *dcr)
418 DEVICE *dev = dcr->dev;
419 Jmsg(dcr->jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
421 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
422 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
423 Dmsg0(150, "dir_update_vol_info. Set Error.\n");
424 dir_update_volume_info(dcr, false);
428 * The Volume is not in the correct slot, so mark this
429 * Volume as not being in the Changer.
431 static void mark_volume_not_inchanger(DCR *dcr)
434 DEVICE *dev = dcr->dev;
435 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
436 " Setting InChanger to zero in catalog.\n"),
437 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot);
438 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
439 dcr->VolCatInfo.InChanger = false;
440 dev->VolCatInfo.InChanger = false;
441 Dmsg0(400, "update vol info in mount\n");
442 dir_update_volume_info(dcr, true); /* set new status */
446 * Either because we are going to hang a new volume, or because
447 * of explicit user request, we release the current volume.
449 void release_volume(DCR *dcr)
452 DEVICE *dev = dcr->dev;
454 Jmsg0(jcr, M_ERROR, 0, _("Hey!!!!! WroteVol non-zero !!!!!\n"));
455 Dmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
458 * First erase all memory of the current volume
460 dev->block_num = dev->file = 0;
461 dev->EndBlock = dev->EndFile = 0;
462 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
463 memset(&dcr->VolCatInfo, 0, sizeof(dcr->VolCatInfo));
465 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
466 /* Force re-read of label */
467 dev->clear_labeled();
470 dev->label_type = B_BACULA_LABEL;
471 dcr->VolumeName[0] = 0;
473 if (dev->is_open() && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
474 offline_or_rewind_dev(dev);
478 /* If we have not closed the device, then at least rewind the tape */
479 if (dev->is_open()) {
480 offline_or_rewind_dev(dev);
482 Dmsg0(190, "release_volume\n");
486 * If we are reading, we come here at the end of the tape
487 * and see if there are more volumes to be mounted.
489 bool mount_next_read_volume(DCR *dcr)
491 DEVICE *dev = dcr->dev;
493 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
495 * End Of Tape -- mount next Volume (if another specified)
497 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
500 if (!acquire_device_for_read(dcr)) {
501 Jmsg2(jcr, M_FATAL, 0, _("Cannot open Dev=%s, Vol=%s\n"), dev->print_name(),
505 return true; /* next volume mounted */
507 Dmsg0(90, "End of Device reached.\n");