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 ((dev->poll) || (dev->is_dvd())) {
160 * Now make sure we have the right tape mounted
164 * If we are writing to a stream device, ASSUME the volume label
167 if (dev_cap(dev, CAP_STREAM)) {
168 vol_label_status = VOL_OK;
169 create_volume_label(dev, dcr->VolumeName, "Default");
170 dev->VolHdr.LabelType = PRE_LABEL;
172 vol_label_status = read_dev_volume_label(dcr);
174 if (job_canceled(jcr)) {
178 Dmsg2(100, "Want dirVol=%s dirStat=%s\n", dcr->VolumeName,
179 dcr->VolCatInfo.VolCatStatus);
181 * At this point, dev->VolCatInfo has what is in the drive, if anything,
182 * and dcr->VolCatInfo has what the Director wants.
184 switch (vol_label_status) {
186 Dmsg1(100, "Vol OK name=%s\n", dcr->VolumeName);
187 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
188 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
189 break; /* got a Volume */
191 VOLUME_CAT_INFO VolCatInfo, devVolCatInfo;
193 /* If not removable, Volume is broken */
194 if (!dev_cap(dev, CAP_REM)) {
195 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
196 dcr->VolumeName, dev->print_name());
197 mark_volume_in_error(dcr);
201 Dmsg1(100, "Vol NAME Error Name=%s\n", dcr->VolumeName);
202 /* If polling and got a previous bad name, ignore it */
203 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolumeName) == 0) {
205 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n",
210 * OK, we got a different volume mounted. First save the
211 * requested Volume info (dcr) structure, then query if
212 * this volume is really OK. If not, put back the desired
213 * volume name, mark it not in changer and continue.
215 memcpy(&VolCatInfo, &dcr->VolCatInfo, sizeof(VolCatInfo));
216 memcpy(&devVolCatInfo, &dev->VolCatInfo, sizeof(devVolCatInfo));
217 /* Check if this is a valid Volume in the pool */
218 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
219 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
220 /* Restore desired volume name, note device info out of sync */
221 /* This gets the info regardless of the Pool */
222 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
223 if (autochanger && !dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
224 mark_volume_not_inchanger(dcr);
226 memcpy(&dev->VolCatInfo, &devVolCatInfo, sizeof(dev->VolCatInfo));
227 bstrncpy(dev->BadVolName, dev->VolHdr.VolumeName, sizeof(dev->BadVolName));
228 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
229 " Current Volume \"%s\" not acceptable because:\n"
231 VolCatInfo.VolCatName, dev->VolHdr.VolumeName,
232 jcr->dir_bsock->msg);
236 /* This was not the volume we expected, but it is OK with
237 * the Director, so use it.
239 Dmsg1(100, "want new name=%s\n", dcr->VolumeName);
240 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
241 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
242 break; /* got a Volume */
244 * At this point, we assume we have a blank tape mounted.
248 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
249 mark_volume_in_error(dcr);
250 return false; /* we could not write on DVD */
252 /* Fall through wanted */
255 * If permitted, we label the device, make sure we can do
256 * it by checking that the VolCatBytes is zero => not labeled,
257 * once the Volume is labeled we don't want to label another
258 * blank tape with the same name. For disk, we go ahead and
259 * label it anyway, because the OS insures that there is only
260 * one Volume with that name.
261 * As noted above, at this point dcr->VolCatInfo has what
262 * the Director wants and dev->VolCatInfo has info on the
263 * previous tape (or nothing).
265 if (dev_cap(dev, CAP_LABEL) && (dcr->VolCatInfo.VolCatBytes == 0 ||
266 (!dev->is_tape() && strcmp(dcr->VolCatInfo.VolCatStatus,
268 Dmsg0(100, "Create volume label\n");
269 /* Create a new Volume label and write it to the device */
270 if (!write_new_volume_label_to_dev(dcr, dcr->VolumeName,
272 Dmsg0(100, "!write_vol_label\n");
273 mark_volume_in_error(dcr);
276 Dmsg0(100, "dir_update_vol_info. Set Append\n");
277 /* Copy Director's info into the device info */
278 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
279 if (!dir_update_volume_info(dcr, true)) { /* indicate tape labeled */
282 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
283 dcr->VolumeName, dev->print_name());
284 goto read_volume; /* read label we just wrote */
286 if (!dev_cap(dev, CAP_LABEL) && dcr->VolCatInfo.VolCatBytes == 0) {
287 Jmsg(jcr, M_INFO, 0, _("Warning device %s not configured to autolabel Volumes.\n"),
290 /* If not removable, Volume is broken */
291 if (!dev_cap(dev, CAP_REM)) {
292 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
293 dcr->VolumeName, dev->print_name());
294 mark_volume_in_error(dcr);
297 /* NOTE! Fall-through wanted. */
300 /* Send error message */
303 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
306 /* Needed, so the medium can be changed */
307 if (dev->requires_mount()) {
314 * See if we have a fresh tape or a tape with data.
316 * Note, if the LabelType is PRE_LABEL, it was labeled
317 * but never written. If so, rewrite the label but set as
318 * VOL_LABEL. We rewind and return the label (reconstructed)
319 * in the block so that in the case of a new tape, data can
320 * be appended just after the block label. If we are writing
321 * a second volume, the calling routine will write the label
322 * before writing the overflow block.
324 * If the tape is marked as Recycle, we rewrite the label.
326 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
327 if (!rewrite_volume_label(dcr, recycle)) {
328 mark_volume_in_error(dcr);
333 * OK, at this point, we have a valid Bacula label, but
334 * we need to position to the end of the volume, since we are
335 * just now putting it into append mode.
337 Dmsg0(200, "Device previously written, moving to end of data\n");
338 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
341 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device %s: ERR=%s\n"),
342 dev->print_name(), strerror_dev(dev));
343 mark_volume_in_error(dcr);
346 /* *****FIXME**** we should do some checking for files too */
347 if (dev->is_tape()) {
349 * Check if we are positioned on the tape at the same place
350 * that the database says we should be.
352 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
353 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
354 dcr->VolumeName, dev_file(dev));
356 Jmsg(jcr, M_ERROR, 0, _("I cannot write on Volume \"%s\" because:\n"
357 "The number of files mismatch! Volume=%u Catalog=%u\n"),
358 dcr->VolumeName, dev_file(dev), dev->VolCatInfo.VolCatFiles);
359 mark_volume_in_error(dcr);
363 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
364 Dmsg1(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
365 if (!dir_update_volume_info(dcr, false)) {
368 /* Return an empty block */
369 empty_block(block); /* we used it for reading so set for write */
372 Dmsg0(100, "set APPEND, normal return from read_dev_for_append\n");
379 * Mark volume in error in catalog
381 void mark_volume_in_error(DCR *dcr)
383 DEVICE *dev = dcr->dev;
384 Jmsg(dcr->jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
386 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
387 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
388 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
389 dir_update_volume_info(dcr, false);
393 * The Volume is not in the correct slot, so mark this
394 * Volume as not being in the Changer.
396 static void mark_volume_not_inchanger(DCR *dcr)
399 DEVICE *dev = dcr->dev;
400 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
401 " Setting InChanger to zero in catalog.\n"),
402 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot);
403 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
404 dcr->VolCatInfo.InChanger = false;
405 dev->VolCatInfo.InChanger = false;
406 Dmsg0(400, "update vol info in mount\n");
407 dir_update_volume_info(dcr, true); /* set new status */
411 * Either because we are going to hang a new volume, or because
412 * of explicit user request, we release the current volume.
414 void release_volume(DCR *dcr)
417 DEVICE *dev = dcr->dev;
419 Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
420 Dmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
423 * First erase all memory of the current volume
425 dev->block_num = dev->file = 0;
426 dev->EndBlock = dev->EndFile = 0;
427 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
428 memset(&dcr->VolCatInfo, 0, sizeof(dcr->VolCatInfo));
430 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
431 /* Force re-read of label */
432 dev->clear_labeled();
435 dev->label_type = B_BACULA_LABEL;
436 dcr->VolumeName[0] = 0;
438 if (dev->is_open() && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
439 offline_or_rewind_dev(dev);
443 /* If we have not closed the device, then at least rewind the tape */
444 if (dev->is_open()) {
445 offline_or_rewind_dev(dev);
447 Dmsg0(190, "release_volume\n");
451 * If we are reading, we come here at the end of the tape
452 * and see if there are more volumes to be mounted.
454 bool mount_next_read_volume(DCR *dcr)
456 DEVICE *dev = dcr->dev;
458 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
460 * End Of Tape -- mount next Volume (if another specified)
462 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
465 if (!acquire_device_for_read(dcr)) {
466 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev->print_name(),
470 return true; /* next volume mounted */
472 Dmsg0(90, "End of Device reached.\n");