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);
100 dev->num_parts = dcr->VolCatInfo.VolCatParts;
103 * Get next volume and ready it for append
104 * This code ensures that the device is ready for
105 * writing. We start from the assumption that there
106 * may not be a tape mounted.
108 * If the device is a file, we create the output
109 * file. If it is a tape, we check the volume name
110 * and move the tape to the end of data.
113 if (autoload_device(dcr, 1, NULL) > 0) {
118 dcr->VolCatInfo.Slot = 0;
120 Dmsg1(100, "autoload_dev returns %d\n", autochanger);
122 * If we autochanged to correct Volume or (we have not just
123 * released the Volume AND we can automount) we go ahead
124 * and read the label. If there is no tape in the drive,
125 * we will err, recurse and ask the operator the next time.
127 if (!release && dev->is_tape() && dev_cap(dev, CAP_AUTOMOUNT)) {
128 ask = false; /* don't ask SYSOP this time */
130 /* Don't ask if not removable */
131 if (!dev_cap(dev, CAP_REM)) {
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 we have a dvd that requires mount, we first want to guess
152 * which Volume is loaded, so we continue (if the wrong device is
153 * loaded, open_device just below would fail.
155 if (!dev->is_dvd()) {
156 if (!open_device(dcr)) {
165 * Just copy the VolCatName in the device resource
166 * (usually done by open_dev).
167 * It is necessary so we can open the real files later.
169 bstrncpy(dev->VolCatInfo.VolCatName, dcr->VolCatInfo.VolCatName, sizeof(dev->VolCatInfo.VolCatName));
173 * Now make sure we have the right tape mounted
177 * If we are writing to a stream device, ASSUME the volume label
180 if (dev_cap(dev, CAP_STREAM)) {
181 vol_label_status = VOL_OK;
182 create_volume_label(dev, dcr->VolumeName, "Default");
183 dev->VolHdr.LabelType = PRE_LABEL;
184 } else if (dev->is_dvd()) {
185 vol_label_status = read_dvd_volume_label(dcr, /*write*/true);
187 vol_label_status = read_dev_volume_label(dcr);
189 if (job_canceled(jcr)) {
193 Dmsg2(100, "dirVol=%s dirStat=%s\n", dcr->VolumeName,
194 dcr->VolCatInfo.VolCatStatus);
196 * At this point, dev->VolCatInfo has what is in the drive, if anything,
197 * and dcr->VolCatInfo has what the Director wants.
199 switch (vol_label_status) {
201 Dmsg1(100, "Vol OK name=%s\n", dcr->VolumeName);
202 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
203 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
204 break; /* got a Volume */
206 VOLUME_CAT_INFO VolCatInfo, devVolCatInfo;
208 /* If not removable, Volume is broken */
209 if (!dev_cap(dev, CAP_REM)) {
210 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
211 dcr->VolumeName, dev->print_name());
212 mark_volume_in_error(dcr);
216 Dmsg1(100, "Vol NAME Error Name=%s\n", dcr->VolumeName);
217 /* If polling and got a previous bad name, ignore it */
218 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolName) == 0) {
220 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n",
225 * OK, we got a different volume mounted. First save the
226 * requested Volume info (dcr) structure, then query if
227 * this volume is really OK. If not, put back the desired
228 * volume name, mark it not in changer and continue.
230 memcpy(&VolCatInfo, &dcr->VolCatInfo, sizeof(VolCatInfo));
231 memcpy(&devVolCatInfo, &dev->VolCatInfo, sizeof(devVolCatInfo));
232 /* Check if this is a valid Volume in the pool */
233 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
234 /* Restore desired volume name, note device info out of sync */
235 /* This gets the info regardless of the Pool */
236 bstrncpy(dcr->VolumeName, dev->VolHdr.VolName, sizeof(dcr->VolumeName));
237 if (autochanger && dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
238 mark_volume_not_inchanger(dcr);
240 memcpy(&dev->VolCatInfo, &devVolCatInfo, sizeof(dev->VolCatInfo));
241 bstrncpy(dev->BadVolName, dev->VolHdr.VolName, sizeof(dev->BadVolName));
242 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
243 " Current Volume \"%s\" not acceptable because:\n"
245 VolCatInfo.VolCatName, dev->VolHdr.VolName,
246 jcr->dir_bsock->msg);
250 /* This was not the volume we expected, but it is OK with
251 * the Director, so use it.
253 Dmsg1(100, "want new name=%s\n", dcr->VolumeName);
254 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
255 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
256 break; /* got a Volume */
258 * At this point, we assume we have a blank tape mounted.
263 * If permitted, we label the device, make sure we can do
264 * it by checking that the VolCatBytes is zero => not labeled,
265 * once the Volume is labeled we don't want to label another
266 * blank tape with the same name. For disk, we go ahead and
267 * label it anyway, because the OS insures that there is only
268 * one Volume with that name.
269 * As noted above, at this point dcr->VolCatInfo has what
270 * the Director wants and dev->VolCatInfo has info on the
271 * previous tape (or nothing).
273 if (dev_cap(dev, CAP_LABEL) && (dcr->VolCatInfo.VolCatBytes == 0 ||
274 (!dev->is_tape() && strcmp(dcr->VolCatInfo.VolCatStatus,
276 Dmsg0(100, "Create volume label\n");
277 /* Create a new Volume label and write it to the device */
278 if (!write_new_volume_label_to_dev(dcr, dcr->VolumeName,
280 Dmsg0(100, "!write_vol_label\n");
281 mark_volume_in_error(dcr);
284 Dmsg0(100, "dir_update_vol_info. Set Append\n");
285 /* Copy Director's info into the device info */
286 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
287 if (!dir_update_volume_info(dcr, true)) { /* indicate tape labeled */
290 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
291 dcr->VolumeName, dev->print_name());
292 goto read_volume; /* read label we just wrote */
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 /* Send error message */
306 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
308 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
311 /* Needed, so the medium can be changed */
312 if (dev_cap(dev, CAP_REQMOUNT)) {
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(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
370 if (!dir_update_volume_info(dcr, false)) {
373 /* Return an empty block */
374 empty_block(block); /* we used it for reading so set for write */
377 Dmsg0(100, "set APPEND, normal return from read_dev_for_append\n");
384 * Mark volume in error in catalog
386 void mark_volume_in_error(DCR *dcr)
388 DEVICE *dev = dcr->dev;
389 Jmsg(dcr->jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
391 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
392 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
393 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
394 dir_update_volume_info(dcr, false);
398 * The Volume is not in the correct slot, so mark this
399 * Volume as not being in the Changer.
401 static void mark_volume_not_inchanger(DCR *dcr)
404 DEVICE *dev = dcr->dev;
405 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
406 " Setting InChanger to zero in catalog.\n"),
407 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot);
408 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
409 dcr->VolCatInfo.InChanger = false;
410 dev->VolCatInfo.InChanger = false;
411 Dmsg0(400, "update vol info in mount\n");
412 dir_update_volume_info(dcr, true); /* set new status */
416 * Either because we are going to hang a new volume, or because
417 * of explicit user request, we release the current volume.
419 void release_volume(DCR *dcr)
422 DEVICE *dev = dcr->dev;
424 Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
425 Dmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
428 * First erase all memory of the current volume
430 dev->block_num = dev->file = 0;
431 dev->EndBlock = dev->EndFile = 0;
432 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
433 memset(&dcr->VolCatInfo, 0, sizeof(dcr->VolCatInfo));
435 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
436 /* Force re-read of label */
437 dev->clear_labeled();
440 dev->label_type = B_BACULA_LABEL;
441 dcr->VolumeName[0] = 0;
443 if (dev->is_open() && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
444 offline_or_rewind_dev(dev);
448 /* If we have not closed the device, then at least rewind the tape */
449 if (dev->is_open()) {
450 offline_or_rewind_dev(dev);
452 Dmsg0(190, "===== release_volume ---");
456 * If we are reading, we come here at the end of the tape
457 * and see if there are more volumes to be mounted.
459 bool mount_next_read_volume(DCR *dcr)
461 DEVICE *dev = dcr->dev;
463 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
465 * End Of Tape -- mount next Volume (if another specified)
467 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
470 if (!acquire_device_for_read(dcr)) {
471 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev->print_name(),
475 return true; /* next volume mounted */
477 Dmsg0(90, "End of Device reached.\n");