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 ammended 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 we have a dvd that requires mount, we first want to guess
150 * which Volume is loaded, so we continue (if the wrong device is
151 * loaded, open_device just below would fail.
153 if (!dev->is_dvd()) {
154 if (!open_device(dcr)) {
163 * Just copy the VolCatName in the device resource
164 * (usually done by open_dev).
165 * It is necessary so we can open the real files later.
167 bstrncpy(dev->VolCatInfo.VolCatName, dcr->VolCatInfo.VolCatName, sizeof(dev->VolCatInfo.VolCatName));
171 * Now make sure we have the right tape mounted
175 * If we are writing to a stream device, ASSUME the volume label
178 if (dev_cap(dev, CAP_STREAM)) {
179 vol_label_status = VOL_OK;
180 create_volume_label(dev, dcr->VolumeName, "Default");
181 dev->VolHdr.LabelType = PRE_LABEL;
183 vol_label_status = read_dev_volume_label(dcr);
185 if (job_canceled(jcr)) {
189 Dmsg2(100, "Want dirVol=%s dirStat=%s\n", dcr->VolumeName,
190 dcr->VolCatInfo.VolCatStatus);
192 * At this point, dev->VolCatInfo has what is in the drive, if anything,
193 * and dcr->VolCatInfo has what the Director wants.
195 switch (vol_label_status) {
197 Dmsg1(100, "Vol OK name=%s\n", dcr->VolumeName);
198 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
199 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
200 break; /* got a Volume */
202 VOLUME_CAT_INFO VolCatInfo, devVolCatInfo;
204 /* If not removable, Volume is broken */
205 if (!dev_cap(dev, CAP_REM)) {
206 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
207 dcr->VolumeName, dev->print_name());
208 mark_volume_in_error(dcr);
212 Dmsg1(100, "Vol NAME Error Name=%s\n", dcr->VolumeName);
213 /* If polling and got a previous bad name, ignore it */
214 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolumeName) == 0) {
216 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n",
221 * OK, we got a different volume mounted. First save the
222 * requested Volume info (dcr) structure, then query if
223 * this volume is really OK. If not, put back the desired
224 * volume name, mark it not in changer and continue.
226 memcpy(&VolCatInfo, &dcr->VolCatInfo, sizeof(VolCatInfo));
227 memcpy(&devVolCatInfo, &dev->VolCatInfo, sizeof(devVolCatInfo));
228 /* Check if this is a valid Volume in the pool */
229 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
230 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
231 /* Restore desired volume name, note device info out of sync */
232 /* This gets the info regardless of the Pool */
233 bstrncpy(dcr->VolumeName, dev->VolHdr.VolumeName, sizeof(dcr->VolumeName));
234 if (autochanger && dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
235 mark_volume_not_inchanger(dcr);
237 memcpy(&dev->VolCatInfo, &devVolCatInfo, sizeof(dev->VolCatInfo));
238 bstrncpy(dev->BadVolName, dev->VolHdr.VolumeName, sizeof(dev->BadVolName));
239 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
240 " Current Volume \"%s\" not acceptable because:\n"
242 VolCatInfo.VolCatName, dev->VolHdr.VolumeName,
243 jcr->dir_bsock->msg);
247 /* This was not the volume we expected, but it is OK with
248 * the Director, so use it.
250 Dmsg1(100, "want new name=%s\n", dcr->VolumeName);
251 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
252 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
253 break; /* got a Volume */
255 * At this point, we assume we have a blank tape mounted.
259 Jmsg(jcr, M_FATAL, 0, "%s", jcr->errmsg);
260 mark_volume_in_error(dcr);
261 return false; /* we could not write on DVD */
263 /* Fall through wanted */
266 * If permitted, we label the device, make sure we can do
267 * it by checking that the VolCatBytes is zero => not labeled,
268 * once the Volume is labeled we don't want to label another
269 * blank tape with the same name. For disk, we go ahead and
270 * label it anyway, because the OS insures that there is only
271 * one Volume with that name.
272 * As noted above, at this point dcr->VolCatInfo has what
273 * the Director wants and dev->VolCatInfo has info on the
274 * previous tape (or nothing).
276 if (dev_cap(dev, CAP_LABEL) && (dcr->VolCatInfo.VolCatBytes == 0 ||
277 (!dev->is_tape() && strcmp(dcr->VolCatInfo.VolCatStatus,
279 Dmsg0(100, "Create volume label\n");
280 /* Create a new Volume label and write it to the device */
281 if (!write_new_volume_label_to_dev(dcr, dcr->VolumeName,
283 Dmsg0(100, "!write_vol_label\n");
284 mark_volume_in_error(dcr);
287 Dmsg0(100, "dir_update_vol_info. Set Append\n");
288 /* Copy Director's info into the device info */
289 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
290 if (!dir_update_volume_info(dcr, true)) { /* indicate tape labeled */
293 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
294 dcr->VolumeName, dev->print_name());
295 goto read_volume; /* read label we just wrote */
297 /* If not removable, Volume is broken */
298 if (!dev_cap(dev, CAP_REM)) {
299 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
300 dcr->VolumeName, dev->print_name());
301 mark_volume_in_error(dcr);
304 /* NOTE! Fall-through wanted. */
307 /* Send error message */
310 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
313 /* Needed, so the medium can be changed */
314 if (dev->requires_mount()) {
321 * See if we have a fresh tape or a tape with data.
323 * Note, if the LabelType is PRE_LABEL, it was labeled
324 * but never written. If so, rewrite the label but set as
325 * VOL_LABEL. We rewind and return the label (reconstructed)
326 * in the block so that in the case of a new tape, data can
327 * be appended just after the block label. If we are writing
328 * a second volume, the calling routine will write the label
329 * before writing the overflow block.
331 * If the tape is marked as Recycle, we rewrite the label.
333 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
334 if (!rewrite_volume_label(dcr, recycle)) {
335 mark_volume_in_error(dcr);
340 * OK, at this point, we have a valid Bacula label, but
341 * we need to position to the end of the volume, since we are
342 * just now putting it into append mode.
344 Dmsg0(200, "Device previously written, moving to end of data\n");
345 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
348 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device %s: ERR=%s\n"),
349 dev->print_name(), strerror_dev(dev));
350 mark_volume_in_error(dcr);
353 /* *****FIXME**** we should do some checking for files too */
354 if (dev->is_tape()) {
356 * Check if we are positioned on the tape at the same place
357 * that the database says we should be.
359 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
360 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
361 dcr->VolumeName, dev_file(dev));
363 Jmsg(jcr, M_ERROR, 0, _("I cannot write on Volume \"%s\" because:\n"
364 "The number of files mismatch! Volume=%u Catalog=%u\n"),
365 dcr->VolumeName, dev_file(dev), dev->VolCatInfo.VolCatFiles);
366 mark_volume_in_error(dcr);
370 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
371 Dmsg1(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
372 if (!dir_update_volume_info(dcr, false)) {
375 /* Return an empty block */
376 empty_block(block); /* we used it for reading so set for write */
379 Dmsg0(100, "set APPEND, normal return from read_dev_for_append\n");
386 * Mark volume in error in catalog
388 void mark_volume_in_error(DCR *dcr)
390 DEVICE *dev = dcr->dev;
391 Jmsg(dcr->jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
393 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
394 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
395 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
396 dir_update_volume_info(dcr, false);
400 * The Volume is not in the correct slot, so mark this
401 * Volume as not being in the Changer.
403 static void mark_volume_not_inchanger(DCR *dcr)
406 DEVICE *dev = dcr->dev;
407 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
408 " Setting InChanger to zero in catalog.\n"),
409 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot);
410 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
411 dcr->VolCatInfo.InChanger = false;
412 dev->VolCatInfo.InChanger = false;
413 Dmsg0(400, "update vol info in mount\n");
414 dir_update_volume_info(dcr, true); /* set new status */
418 * Either because we are going to hang a new volume, or because
419 * of explicit user request, we release the current volume.
421 void release_volume(DCR *dcr)
424 DEVICE *dev = dcr->dev;
426 Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
427 Dmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
430 * First erase all memory of the current volume
432 dev->block_num = dev->file = 0;
433 dev->EndBlock = dev->EndFile = 0;
434 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
435 memset(&dcr->VolCatInfo, 0, sizeof(dcr->VolCatInfo));
437 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
438 /* Force re-read of label */
439 dev->clear_labeled();
442 dev->label_type = B_BACULA_LABEL;
443 dcr->VolumeName[0] = 0;
445 if (dev->is_open() && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
446 offline_or_rewind_dev(dev);
450 /* If we have not closed the device, then at least rewind the tape */
451 if (dev->is_open()) {
452 offline_or_rewind_dev(dev);
454 Dmsg0(190, "===== release_volume ---");
458 * If we are reading, we come here at the end of the tape
459 * and see if there are more volumes to be mounted.
461 bool mount_next_read_volume(DCR *dcr)
463 DEVICE *dev = dcr->dev;
465 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
467 * End Of Tape -- mount next Volume (if another specified)
469 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
472 if (!acquire_device_for_read(dcr)) {
473 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev->print_name(),
477 return true; /* next volume mounted */
479 Dmsg0(90, "End of Device reached.\n");