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(100, "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 /* 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 Dmsg0(100, "(1)Ask=0");
127 ask = false; /* don't ask SYSOP this time */
129 /* Don't ask if not removable */
130 if (!dev_cap(dev, CAP_REM)) {
131 Dmsg0(100, "(2)Ask=0");
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 (!open_device(dcr)) {
152 /* If DVD, ignore the error, very often you cannot open the device
153 * (when there is no DVD, or when the one inserted is a wrong one) */
154 if ((dev->poll) || (dev->is_dvd())) {
162 * Now make sure we have the right tape mounted
166 * If we are writing to a stream device, ASSUME the volume label
169 if (dev_cap(dev, CAP_STREAM)) {
170 vol_label_status = VOL_OK;
171 create_volume_label(dev, dcr->VolumeName, "Default");
172 dev->VolHdr.LabelType = PRE_LABEL;
174 vol_label_status = read_dev_volume_label(dcr);
176 if (job_canceled(jcr)) {
180 Dmsg2(100, "Want dirVol=%s dirStat=%s\n", dcr->VolumeName,
181 dcr->VolCatInfo.VolCatStatus);
183 * At this point, dev->VolCatInfo has what is in the drive, if anything,
184 * and dcr->VolCatInfo has what the Director wants.
186 switch (vol_label_status) {
188 Dmsg1(100, "Vol OK name=%s\n", dcr->VolumeName);
189 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
190 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
191 break; /* got a Volume */
193 VOLUME_CAT_INFO VolCatInfo, devVolCatInfo;
195 /* If not removable, Volume is broken */
196 if (!dev_cap(dev, CAP_REM)) {
197 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
198 dcr->VolumeName, dev->print_name());
199 mark_volume_in_error(dcr);
203 Dmsg1(100, "Vol NAME Error Name=%s\n", dcr->VolumeName);
204 /* If polling and got a previous bad name, ignore it */
205 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolumeName) == 0) {
207 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n",
212 * OK, we got a different volume mounted. First save the
213 * requested Volume info (dcr) structure, then query if
214 * this volume is really OK. If not, put back the desired
215 * volume name, mark it not in changer and continue.
217 memcpy(&VolCatInfo, &dcr->VolCatInfo, sizeof(VolCatInfo));
218 memcpy(&devVolCatInfo, &dev->VolCatInfo, sizeof(devVolCatInfo));
219 /* Check if this is a valid Volume in the pool */
220 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
221 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
222 /* Restore desired volume name, note device info out of sync */
223 /* This gets the info regardless of the Pool */
224 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
225 if (autochanger && !dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
226 mark_volume_not_inchanger(dcr);
228 memcpy(&dev->VolCatInfo, &devVolCatInfo, sizeof(dev->VolCatInfo));
229 bstrncpy(dev->BadVolName, dev->VolHdr.VolumeName, sizeof(dev->BadVolName));
230 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
231 " Current Volume \"%s\" not acceptable because:\n"
233 VolCatInfo.VolCatName, dev->VolHdr.VolumeName,
234 jcr->dir_bsock->msg);
238 /* This was not the volume we expected, but it is OK with
239 * the Director, so use it.
241 Dmsg1(100, "want new name=%s\n", dcr->VolumeName);
242 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
243 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
244 break; /* got a Volume */
246 * At this point, we assume we have a blank tape mounted.
250 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
251 mark_volume_in_error(dcr);
252 return false; /* we could not write on DVD */
254 /* Fall through wanted */
257 * If permitted, we label the device, make sure we can do
258 * it by checking that the VolCatBytes is zero => not labeled,
259 * once the Volume is labeled we don't want to label another
260 * blank tape with the same name. For disk, we go ahead and
261 * label it anyway, because the OS insures that there is only
262 * one Volume with that name.
263 * As noted above, at this point dcr->VolCatInfo has what
264 * the Director wants and dev->VolCatInfo has info on the
265 * previous tape (or nothing).
267 if (dev_cap(dev, CAP_LABEL) && (dcr->VolCatInfo.VolCatBytes == 0 ||
268 (!dev->is_tape() && strcmp(dcr->VolCatInfo.VolCatStatus,
270 Dmsg0(100, "Create volume label\n");
271 /* Create a new Volume label and write it to the device */
272 if (!write_new_volume_label_to_dev(dcr, dcr->VolumeName,
274 Dmsg0(100, "!write_vol_label\n");
275 mark_volume_in_error(dcr);
278 Dmsg0(100, "dir_update_vol_info. Set Append\n");
279 /* Copy Director's info into the device info */
280 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
281 if (!dir_update_volume_info(dcr, true)) { /* indicate tape labeled */
284 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
285 dcr->VolumeName, dev->print_name());
286 goto read_volume; /* read label we just wrote */
288 if (!dev_cap(dev, CAP_LABEL) && dcr->VolCatInfo.VolCatBytes == 0) {
289 Jmsg(jcr, M_INFO, 0, _("Warning device %s not configured to autolabel Volumes.\n"),
292 /* If not removable, Volume is broken */
293 if (!dev_cap(dev, CAP_REM)) {
294 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
295 dcr->VolumeName, dev->print_name());
296 mark_volume_in_error(dcr);
299 /* NOTE! Fall-through wanted. */
302 /* Send error message */
305 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
308 /* Needed, so the medium can be changed */
309 if (dev->requires_mount()) {
316 * See if we have a fresh tape or a tape with data.
318 * Note, if the LabelType is PRE_LABEL, it was labeled
319 * but never written. If so, rewrite the label but set as
320 * VOL_LABEL. We rewind and return the label (reconstructed)
321 * in the block so that in the case of a new tape, data can
322 * be appended just after the block label. If we are writing
323 * a second volume, the calling routine will write the label
324 * before writing the overflow block.
326 * If the tape is marked as Recycle, we rewrite the label.
328 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
329 if (!rewrite_volume_label(dcr, recycle)) {
330 mark_volume_in_error(dcr);
335 * OK, at this point, we have a valid Bacula label, but
336 * we need to position to the end of the volume, since we are
337 * just now putting it into append mode.
339 Dmsg0(200, "Device previously written, moving to end of data\n");
340 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
343 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device %s: ERR=%s\n"),
344 dev->print_name(), strerror_dev(dev));
345 mark_volume_in_error(dcr);
348 /* *****FIXME**** we should do some checking for files too */
349 if (dev->is_tape()) {
351 * Check if we are positioned on the tape at the same place
352 * that the database says we should be.
354 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
355 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
356 dcr->VolumeName, dev_file(dev));
358 Jmsg(jcr, M_ERROR, 0, _("I cannot write on Volume \"%s\" because:\n"
359 "The number of files mismatch! Volume=%u Catalog=%u\n"),
360 dcr->VolumeName, dev_file(dev), dev->VolCatInfo.VolCatFiles);
361 mark_volume_in_error(dcr);
365 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
366 Dmsg1(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
367 if (!dir_update_volume_info(dcr, false)) {
371 /* DVD : check if the last part was removed or truncated, or if a written
372 * part was overwritten. */
373 /* We need to do it after dir_update_volume_info, so we have the EndBlock
374 * info. (nb: I don't understand why VolCatFiles is set (used to check
375 * tape file number), but not EndBlock) */
376 /* Maybe could it be changed "dev->is_file()" (would remove the fixme above) */
378 /* Disabled: I had problems with this code... (maybe is it related to the seek bug ?) */
379 /*if (dev->is_dvd()) {
380 Dmsg2(100, "DVD/File sanity check addr=%u vs endblock=%u\n", (unsigned int)dev->file_addr, (unsigned int)dev->VolCatInfo.EndBlock);
381 if (dev->file_addr == dev->VolCatInfo.EndBlock+1) {
382 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file address=%u.\n"),
383 dcr->VolumeName, (unsigned int)dev->file_addr);
386 Jmsg(jcr, M_ERROR, 0, _("I cannot write on Volume \"%s\" because:\n"
387 "The EOD file address is wrong: Volume file address=%u != Catalog Endblock=%u(+1)\n"
388 "You probably removed DVD last part in spool directory.\n"),
389 dcr->VolumeName, (unsigned int)dev->file_addr, (unsigned int)dev->VolCatInfo.EndBlock);
390 mark_volume_in_error(dcr);
395 /* Return an empty block */
396 empty_block(block); /* we used it for reading so set for write */
399 Dmsg0(100, "set APPEND, normal return from read_dev_for_append\n");
406 * Mark volume in error in catalog
408 void mark_volume_in_error(DCR *dcr)
410 DEVICE *dev = dcr->dev;
411 Jmsg(dcr->jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
413 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
414 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
415 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
416 dir_update_volume_info(dcr, false);
420 * The Volume is not in the correct slot, so mark this
421 * Volume as not being in the Changer.
423 static void mark_volume_not_inchanger(DCR *dcr)
426 DEVICE *dev = dcr->dev;
427 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
428 " Setting InChanger to zero in catalog.\n"),
429 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot);
430 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
431 dcr->VolCatInfo.InChanger = false;
432 dev->VolCatInfo.InChanger = false;
433 Dmsg0(400, "update vol info in mount\n");
434 dir_update_volume_info(dcr, true); /* set new status */
438 * Either because we are going to hang a new volume, or because
439 * of explicit user request, we release the current volume.
441 void release_volume(DCR *dcr)
444 DEVICE *dev = dcr->dev;
446 Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
447 Dmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
450 * First erase all memory of the current volume
452 dev->block_num = dev->file = 0;
453 dev->EndBlock = dev->EndFile = 0;
454 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
455 memset(&dcr->VolCatInfo, 0, sizeof(dcr->VolCatInfo));
457 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
458 /* Force re-read of label */
459 dev->clear_labeled();
462 dev->label_type = B_BACULA_LABEL;
463 dcr->VolumeName[0] = 0;
465 if (dev->is_open() && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
466 offline_or_rewind_dev(dev);
470 /* If we have not closed the device, then at least rewind the tape */
471 if (dev->is_open()) {
472 offline_or_rewind_dev(dev);
474 Dmsg0(190, "release_volume\n");
478 * If we are reading, we come here at the end of the tape
479 * and see if there are more volumes to be mounted.
481 bool mount_next_read_volume(DCR *dcr)
483 DEVICE *dev = dcr->dev;
485 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
487 * End Of Tape -- mount next Volume (if another specified)
489 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
492 if (!acquire_device_for_read(dcr)) {
493 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev->print_name(),
497 return true; /* next volume mounted */
499 Dmsg0(90, "End of Device reached.\n");