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);
32 * If release is set, we rewind the current volume,
33 * which we no longer want, and ask the user (console)
34 * to mount the next volume.
36 * Continue trying until we get it, and then ensure
37 * that we can write on it.
39 * This routine returns a 0 only if it is REALLY
40 * impossible to get the requested Volume.
43 bool mount_next_write_volume(DCR *dcr, bool release)
46 bool ask = false, recycle, autochanger;
48 DEVICE *dev = dcr->dev;
50 DEV_BLOCK *block = dcr->block;
52 Dmsg0(100, "Enter mount_next_volume()\n");
54 init_device_wait_timers(dcr);
57 * Attempt to mount the next volume. If something non-fatal goes
58 * wrong, we come back here to re-try (new op messages, re-read
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(100, "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(100, "After find_next_append. Vol=%s Slot=%d Parts=%d\n",
99 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot, dcr->VolCatInfo.VolCatParts);
101 dev->num_parts = dcr->VolCatInfo.VolCatParts;
104 * Get next volume and ready it for append
105 * This code ensures that the device is ready for
106 * writing. We start from the assumption that there
107 * may not be a tape mounted.
109 * If the device is a file, we create the output
110 * file. If it is a tape, we check the volume name
111 * and move the tape to the end of data.
114 if (autoload_device(dcr, 1, NULL) > 0) {
119 dcr->VolCatInfo.Slot = 0;
121 Dmsg1(100, "autoload_dev returns %d\n", autochanger);
123 * If we autochanged to correct Volume or (we have not just
124 * released the Volume AND we can automount) we go ahead
125 * and read the label. If there is no tape in the drive,
126 * we will err, recurse and ask the operator the next time.
128 if (!release && dev->is_tape() && dev_cap(dev, CAP_AUTOMOUNT)) {
129 ask = false; /* don't ask SYSOP this time */
131 /* Don't ask if not removable */
132 if (!dev_cap(dev, CAP_REM)) {
135 Dmsg2(100, "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(100, "Error return ask_sysop ...\n");
140 return false; /* error return */
142 if (job_canceled(jcr)) {
145 Dmsg1(100, "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 we have a dvd that requires mount, we first want to guess
153 * which Volume is loaded, so we continue (if the wrong device is
154 * loaded, open_device just below would fail.
156 if (!dev->is_dvd()) {
157 if (!open_device(dcr)) {
166 * Just copy the VolCatName in the device resource
167 * (usually done by open_dev).
168 * It is necessary so we can open the real files later.
170 bstrncpy(dev->VolCatInfo.VolCatName, dcr->VolCatInfo.VolCatName, sizeof(dev->VolCatInfo.VolCatName));
174 * Now make sure we have the right tape mounted
178 * If we are writing to a stream device, ASSUME the volume label
181 if (dev_cap(dev, CAP_STREAM)) {
182 vol_label_status = VOL_OK;
183 create_volume_label(dev, dcr->VolumeName, "Default");
184 dev->VolHdr.LabelType = PRE_LABEL;
185 } else if (dev->is_dvd()) {
186 vol_label_status = read_dev_volume_label_guess(dcr, 1);
188 vol_label_status = read_dev_volume_label(dcr);
190 if (job_canceled(jcr)) {
194 Dmsg2(100, "dirVol=%s dirStat=%s\n", dcr->VolumeName,
195 dcr->VolCatInfo.VolCatStatus);
197 * At this point, dev->VolCatInfo has what is in the drive, if anything,
198 * and dcr->VolCatInfo has what the Director wants.
200 switch (vol_label_status) {
202 Dmsg1(100, "Vol OK name=%s\n", dcr->VolumeName);
203 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
204 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
205 break; /* got a Volume */
207 VOLUME_CAT_INFO VolCatInfo, devVolCatInfo;
209 /* If not removable, Volume is broken */
210 if (!dev_cap(dev, CAP_REM)) {
211 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
212 dcr->VolumeName, dev->print_name());
213 mark_volume_in_error(dcr);
217 Dmsg1(100, "Vol NAME Error Name=%s\n", dcr->VolumeName);
218 /* If polling and got a previous bad name, ignore it */
219 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolName) == 0) {
221 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n",
226 * OK, we got a different volume mounted. First save the
227 * requested Volume info (dcr) structure, then query if
228 * this volume is really OK. If not, put back the desired
229 * volume name, mark it not in changer and continue.
231 memcpy(&VolCatInfo, &dcr->VolCatInfo, sizeof(VolCatInfo));
232 memcpy(&devVolCatInfo, &dev->VolCatInfo, sizeof(devVolCatInfo));
233 /* Check if this is a valid Volume in the pool */
234 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
235 /* Restore desired volume name, note device info out of sync */
236 /* This gets the info regardless of the Pool */
237 bstrncpy(dcr->VolumeName, dev->VolHdr.VolName, sizeof(dcr->VolumeName));
238 if (autochanger && dir_get_volume_info(dcr, GET_VOL_INFO_FOR_READ)) {
239 mark_volume_not_inchanger(dcr);
241 memcpy(&dev->VolCatInfo, &devVolCatInfo, sizeof(dev->VolCatInfo));
242 bstrncpy(dev->BadVolName, dev->VolHdr.VolName, sizeof(dev->BadVolName));
243 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
244 " Current Volume \"%s\" not acceptable because:\n"
246 VolCatInfo.VolCatName, dev->VolHdr.VolName,
247 jcr->dir_bsock->msg);
251 /* This was not the volume we expected, but it is OK with
252 * the Director, so use it.
254 Dmsg1(100, "want new name=%s\n", dcr->VolumeName);
255 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
256 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
257 break; /* got a Volume */
259 * At this point, we assume we have a blank tape mounted.
264 * If permitted, we label the device, make sure we can do
265 * it by checking that the VolCatBytes is zero => not labeled,
266 * once the Volume is labeled we don't want to label another
267 * blank tape with the same name. For disk, we go ahead and
268 * label it anyway, because the OS insures that there is only
269 * one Volume with that name.
270 * As noted above, at this point dcr->VolCatInfo has what
271 * the Director wants and dev->VolCatInfo has info on the
272 * previous tape (or nothing).
274 if (dev_cap(dev, CAP_LABEL) && (dcr->VolCatInfo.VolCatBytes == 0 ||
275 (!dev->is_tape() && strcmp(dcr->VolCatInfo.VolCatStatus,
277 Dmsg0(100, "Create volume label\n");
278 /* Create a new Volume label and write it to the device */
279 if (!write_new_volume_label_to_dev(dcr, dcr->VolumeName,
281 Dmsg0(100, "!write_vol_label\n");
282 mark_volume_in_error(dcr);
285 Dmsg0(100, "dir_update_vol_info. Set Append\n");
286 /* Copy Director's info into the device info */
287 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
288 if (!dir_update_volume_info(dcr, true)) { /* indicate tape labeled */
291 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
292 dcr->VolumeName, dev->print_name());
293 goto read_volume; /* read label we just wrote */
295 /* If not removable, Volume is broken */
296 if (!dev_cap(dev, CAP_REM)) {
297 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
298 dcr->VolumeName, dev->print_name());
299 mark_volume_in_error(dcr);
302 /* NOTE! Fall-through wanted. */
305 /* Send error message */
307 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
309 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
312 /* Needed, so the medium can be changed */
313 if (dev_cap(dev, CAP_REQMOUNT)) {
320 * See if we have a fresh tape or a tape with data.
322 * Note, if the LabelType is PRE_LABEL, it was labeled
323 * but never written. If so, rewrite the label but set as
324 * VOL_LABEL. We rewind and return the label (reconstructed)
325 * in the block so that in the case of a new tape, data can
326 * be appended just after the block label. If we are writing
327 * a second volume, the calling routine will write the label
328 * before writing the overflow block.
330 * If the tape is marked as Recycle, we rewrite the label.
332 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
333 if (!rewrite_volume_label(dcr, recycle)) {
334 mark_volume_in_error(dcr);
339 * OK, at this point, we have a valid Bacula label, but
340 * we need to position to the end of the volume, since we are
341 * just now putting it into append mode.
343 Dmsg0(200, "Device previously written, moving to end of data\n");
344 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
347 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device %s: ERR=%s\n"),
348 dev->print_name(), strerror_dev(dev));
349 mark_volume_in_error(dcr);
352 /* *****FIXME**** we should do some checking for files too */
353 if (dev->is_tape()) {
355 * Check if we are positioned on the tape at the same place
356 * that the database says we should be.
358 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
359 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
360 dcr->VolumeName, dev_file(dev));
362 Jmsg(jcr, M_ERROR, 0, _("I cannot write on Volume \"%s\" because:\n"
363 "The number of files mismatch! Volume=%u Catalog=%u\n"),
364 dcr->VolumeName, dev_file(dev), dev->VolCatInfo.VolCatFiles);
365 mark_volume_in_error(dcr);
369 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
370 Dmsg1(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
371 if (!dir_update_volume_info(dcr, false)) {
374 /* Return an empty block */
375 empty_block(block); /* we used it for reading so set for write */
378 Dmsg0(100, "set APPEND, normal return from read_dev_for_append\n");
385 * Mark volume in error in catalog
387 void mark_volume_in_error(DCR *dcr)
389 DEVICE *dev = dcr->dev;
390 Jmsg(dcr->jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
392 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
393 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
394 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
395 dir_update_volume_info(dcr, false);
399 * The Volume is not in the correct slot, so mark this
400 * Volume as not being in the Changer.
402 static void mark_volume_not_inchanger(DCR *dcr)
405 DEVICE *dev = dcr->dev;
406 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
407 " Setting InChanger to zero in catalog.\n"),
408 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot);
409 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
410 dcr->VolCatInfo.InChanger = false;
411 dev->VolCatInfo.InChanger = false;
412 Dmsg0(400, "update vol info in mount\n");
413 dir_update_volume_info(dcr, true); /* set new status */
417 * Either because we are going to hang a new volume, or because
418 * of explicit user request, we release the current volume.
420 void release_volume(DCR *dcr)
423 DEVICE *dev = dcr->dev;
425 Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
426 Dmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
429 * First erase all memory of the current volume
431 dev->block_num = dev->file = 0;
432 dev->EndBlock = dev->EndFile = 0;
433 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
434 memset(&dcr->VolCatInfo, 0, sizeof(dcr->VolCatInfo));
436 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
437 /* Force re-read of label */
438 dev->state &= ~(ST_LABEL|ST_READ|ST_APPEND);
439 dev->label_type = B_BACULA_LABEL;
440 dcr->VolumeName[0] = 0;
442 if (dev->is_open() && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
443 offline_or_rewind_dev(dev);
447 /* If we have not closed the device, then at least rewind the tape */
448 if (dev->is_open()) {
449 offline_or_rewind_dev(dev);
451 Dmsg0(190, "===== release_volume ---");
455 * If we are reading, we come here at the end of the tape
456 * and see if there are more volumes to be mounted.
458 bool mount_next_read_volume(DCR *dcr)
460 DEVICE *dev = dcr->dev;
462 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
464 * End Of Tape -- mount next Volume (if another specified)
466 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
469 if (!acquire_device_for_read(dcr)) {
470 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev->print_name(),
474 return true; /* next volume mounted */
476 Dmsg0(90, "End of Device reached.\n");