3 * Routines for handling mounting tapes for reading and for
6 * Kern Sibbald, August MMII
11 Copyright (C) 2000-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 as
15 published by the Free Software Foundation; either version 2 of
16 the License, or (at your option) any later version.
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 GNU
21 General Public License for more details.
23 You should have received a copy of the GNU General Public
24 License along with this program; if not, write to the Free
25 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 #include "bacula.h" /* pull in global headers */
31 #include "stored.h" /* pull in Storage Deamon headers */
33 static bool rewrite_volume_label(DCR *dcr, bool recycle);
37 * If release is set, we rewind the current volume,
38 * which we no longer want, and ask the user (console)
39 * to mount the next volume.
41 * Continue trying until we get it, and then ensure
42 * that we can write on it.
44 * This routine returns a 0 only if it is REALLY
45 * impossible to get the requested Volume.
48 bool mount_next_write_volume(DCR *dcr, bool release)
51 bool ask = false, recycle, autochanger;
53 DEVICE *dev = dcr->dev;
55 DEV_BLOCK *block = dcr->block;
57 Dmsg0(100, "Enter mount_next_volume()\n");
59 init_dev_wait_timers(dev);
62 * Attempt to mount the next volume. If something non-fatal goes
63 * wrong, we come back here to re-try (new op messages, re-read
67 /* Ignore retry if this is poll request */
68 if (!dev->poll && retry++ > 4) {
69 /* Last ditch effort before giving up, force operator to respond */
70 dcr->VolCatInfo.Slot = 0;
71 if (!dir_ask_sysop_to_mount_volume(dcr)) {
72 Jmsg(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"),
77 if (job_canceled(jcr)) {
78 Jmsg(jcr, M_FATAL, 0, _("Job %d canceled.\n"), jcr->JobId);
83 Dmsg0(100, "mount_next_volume release=1\n");
85 ask = true; /* ask operator to mount tape */
89 * Get Director's idea of what tape we should have mounted.
92 Dmsg0(200, "Before dir_find_next_appendable_volume.\n");
93 while (!dir_find_next_appendable_volume(dcr)) {
94 Dmsg0(200, "not dir_find_next\n");
95 if (!dir_ask_sysop_to_create_appendable_volume(dcr)) {
98 Dmsg0(200, "Again dir_find_next_append...\n");
100 if (job_canceled(jcr)) {
103 Dmsg3(100, "After find_next_append. Vol=%s Slot=%d Parts=%d\n",
104 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot, dcr->VolCatInfo.VolCatParts);
106 dev->num_parts = dcr->VolCatInfo.VolCatParts;
109 * Get next volume and ready it for append
110 * This code ensures that the device is ready for
111 * writing. We start from the assumption that there
112 * may not be a tape mounted.
114 * If the device is a file, we create the output
115 * file. If it is a tape, we check the volume name
116 * and move the tape to the end of data.
118 * It assumes that the device is not already in use!
121 if (autoload_device(dcr, 1, NULL) > 0) {
126 dcr->VolCatInfo.Slot = 0;
128 Dmsg1(100, "autoload_dev returns %d\n", autochanger);
130 * If we autochanged to correct Volume or (we have not just
131 * released the Volume AND we can automount) we go ahead
132 * and read the label. If there is no tape in the drive,
133 * we will err, recurse and ask the operator the next time.
135 if (!release && dev_is_tape(dev) && dev_cap(dev, CAP_AUTOMOUNT)) {
136 ask = false; /* don't ask SYSOP this time */
138 /* Don't ask if not removable */
139 if (!dev_cap(dev, CAP_REM)) {
142 Dmsg2(100, "Ask=%d autochanger=%d\n", ask, autochanger);
143 release = true; /* release next time if we "recurse" */
145 if (ask && !dir_ask_sysop_to_mount_volume(dcr)) {
146 Dmsg0(100, "Error return ask_sysop ...\n");
147 return false; /* error return */
149 if (job_canceled(jcr)) {
152 Dmsg1(100, "want vol=%s\n", dcr->VolumeName);
154 if (dev->poll && dev_cap(dev, CAP_CLOSEONPOLL)) {
155 force_close_dev(dev);
158 /* Ensure the device is open */
159 /* If we have a dvd that requires mount, we first want to guess
160 * which Volume is loaded, so we continue (if the wrong device is
161 * loaded, open_device would fail). */
162 if (!dev->is_dvd()) {
163 if (!open_device(dcr)) {
172 * Just copy the VolCatName in the device resource
173 * (usually done by open_dev).
174 * It is necessary so we can open the real files later.
176 bstrncpy(dev->VolCatInfo.VolCatName, dcr->VolCatInfo.VolCatName, sizeof(dev->VolCatInfo.VolCatName));
180 * Now make sure we have the right tape mounted
184 * If we are writing to a stream device, ASSUME the volume label
187 if (dev_cap(dev, CAP_STREAM)) {
188 vol_label_status = VOL_OK;
189 create_volume_label(dev, dcr->VolumeName, "Default");
190 dev->VolHdr.LabelType = PRE_LABEL;
191 } else if (dev->is_dvd()) {
192 vol_label_status = read_dev_volume_label_guess(dcr, 1);
194 vol_label_status = read_dev_volume_label(dcr);
196 if (job_canceled(jcr)) {
200 Dmsg2(100, "dirVol=%s dirStat=%s\n", dcr->VolumeName,
201 dcr->VolCatInfo.VolCatStatus);
203 * At this point, dev->VolCatInfo has what is in the drive, if anything,
204 * and dcr->VolCatInfo has what the Director wants.
206 switch (vol_label_status) {
208 Dmsg1(100, "Vol OK name=%s\n", dcr->VolumeName);
209 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
210 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
211 break; /* got a Volume */
213 VOLUME_CAT_INFO VolCatInfo;
215 /* If not removable, Volume is broken */
216 if (!dev_cap(dev, CAP_REM)) {
217 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
218 dcr->VolumeName, dev_name(dev));
219 mark_volume_in_error(dcr);
223 Dmsg1(100, "Vol NAME Error Name=%s\n", dcr->VolumeName);
224 /* If polling and got a previous bad name, ignore it */
225 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolName) == 0) {
227 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n",
232 * OK, we got a different volume mounted. First save the
233 * requested Volume info (jcr) structure, then query if
234 * this volume is really OK. If not, put back the desired
235 * volume name and continue.
237 memcpy(&VolCatInfo, &dcr->VolCatInfo, sizeof(VolCatInfo));
238 /* Check if this is a valid Volume in the pool */
239 bstrncpy(dcr->VolumeName, dev->VolHdr.VolName, sizeof(dcr->VolumeName));
240 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
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);
247 /* Restore desired volume name, note device info out of sync */
248 memcpy(&dcr->VolCatInfo, &VolCatInfo, sizeof(dcr->VolCatInfo));
252 Dmsg1(100, "want new name=%s\n", dcr->VolumeName);
253 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
254 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
255 break; /* got a Volume */
257 * At this point, we assume we have a blank tape mounted.
262 * If permitted, we label the device, make sure we can do
263 * it by checking that the VolCatBytes is zero => not labeled,
264 * once the Volume is labeled we don't want to label another
265 * blank tape with the same name. For disk, we go ahead and
266 * label it anyway, because the OS insures that there is only
267 * one Volume with that name.
268 * As noted above, at this point dcr->VolCatInfo has what
269 * the Director wants and dev->VolCatInfo has info on the
270 * previous tape (or nothing).
272 if (dev_cap(dev, CAP_LABEL) && (dcr->VolCatInfo.VolCatBytes == 0 ||
273 (!dev->is_tape() && strcmp(dcr->VolCatInfo.VolCatStatus,
275 Dmsg0(100, "Create volume label\n");
276 /* Create a new Volume label and write it to the device */
277 if (!write_new_volume_label_to_dev(dcr, dcr->VolumeName,
279 Dmsg0(100, "!write_vol_label\n");
282 Dmsg0(100, "dir_update_vol_info. Set Append\n");
283 /* Copy Director's info into the device info */
284 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
285 if (!dir_update_volume_info(dcr, true)) { /* indicate tape labeled */
288 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
289 dcr->VolumeName, dev_name(dev));
290 goto read_volume; /* read label we just wrote */
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_name(dev));
296 mark_volume_in_error(dcr);
299 /* NOTE! Fall-through wanted. */
302 /* Send error message */
304 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
306 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
309 /* Needed, so the medium can be changed */
310 if (dev_cap(dev, CAP_REQMOUNT)) {
317 * See if we have a fresh tape or a tape with data.
319 * Note, if the LabelType is PRE_LABEL, it was labeled
320 * but never written. If so, rewrite the label but set as
321 * VOL_LABEL. We rewind and return the label (reconstructed)
322 * in the block so that in the case of a new tape, data can
323 * be appended just after the block label. If we are writing
324 * a second volume, the calling routine will write the label
325 * before writing the overflow block.
327 * If the tape is marked as Recycle, we rewrite the label.
329 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
330 if (!rewrite_volume_label(dcr, recycle)) {
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_name(dev), strerror_dev(dev));
345 mark_volume_in_error(dcr);
348 /* *****FIXME**** we should do some checking for files too */
349 if (dev_is_tape(dev)) {
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 canot 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)) {
370 /* Return an empty block */
371 empty_block(block); /* we used it for reading so set for write */
373 dev->state |= ST_APPEND;
374 Dmsg0(100, "set APPEND, normal return from read_dev_for_append\n");
379 * Write a volume label.
380 * Returns: true if OK
381 * false if unable to write it
383 static bool rewrite_volume_label(DCR *dcr, bool recycle)
385 DEVICE *dev = dcr->dev;
388 Dmsg1(190, "set append found freshly labeled volume. dev=%x\n", dev);
389 dev->VolHdr.LabelType = VOL_LABEL; /* set Volume label */
390 dev->state |= ST_APPEND;
391 if (!write_volume_label_to_block(dcr)) {
392 Dmsg0(200, "Error from write volume label.\n");
396 * If we are not dealing with a streaming device,
397 * write the block now to ensure we have write permission.
398 * It is better to find out now rather than later.
400 if (!dev_cap(dev, CAP_STREAM)) {
401 if (!rewind_dev(dev)) {
402 Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device \"%s\". ERR=%s\n"),
403 dev_name(dev), strerror_dev(dev));
406 if (!truncate_dev(dev)) {
407 Jmsg2(jcr, M_WARNING, 0, _("Truncate error on device \"%s\". ERR=%s\n"),
408 dev_name(dev), strerror_dev(dev));
411 /* Attempt write to check write permission */
412 Dmsg0(200, "Attempt to write to device.\n");
413 if (!write_ansi_ibm_label(dcr, dev->VolHdr.VolName)) {
416 if (!write_block_to_dev(dcr)) {
417 Jmsg2(jcr, M_ERROR, 0, _("Unable to write device \"%s\". ERR=%s\n"),
418 dev_name(dev), strerror_dev(dev));
419 Dmsg0(200, "===ERROR write block to dev\n");
423 /* Set or reset Volume statistics */
424 dev->VolCatInfo.VolCatJobs = 0;
425 dev->VolCatInfo.VolCatFiles = 0;
426 dev->VolCatInfo.VolCatBytes = 1;
427 dev->VolCatInfo.VolCatErrors = 0;
428 dev->VolCatInfo.VolCatBlocks = 0;
429 dev->VolCatInfo.VolCatRBytes = 0;
431 dev->VolCatInfo.VolCatMounts++;
432 dev->VolCatInfo.VolCatRecycles++;
434 dev->VolCatInfo.VolCatMounts = 1;
435 dev->VolCatInfo.VolCatRecycles = 0;
436 dev->VolCatInfo.VolCatWrites = 1;
437 dev->VolCatInfo.VolCatReads = 1;
439 Dmsg0(100, "dir_update_vol_info. Set Append\n");
440 bstrncpy(dev->VolCatInfo.VolCatStatus, "Append", sizeof(dev->VolCatInfo.VolCatStatus));
441 if (!dir_update_volume_info(dcr, true)) { /* indicate doing relabel */
445 Jmsg(jcr, M_INFO, 0, _("Recycled volume \"%s\" on device \"%s\", all previous data lost.\n"),
446 dcr->VolumeName, dev_name(dev));
448 Jmsg(jcr, M_INFO, 0, _("Wrote label to prelabeled Volume \"%s\" on device \"%s\"\n"),
449 dcr->VolumeName, dev_name(dev));
452 * End writing real Volume label (from pre-labeled tape), or recycling
455 Dmsg0(200, "OK from rewite vol label.\n");
461 * Mark volume in error in catalog
463 void mark_volume_in_error(DCR *dcr)
465 DEVICE *dev = dcr->dev;
466 Jmsg(dcr->jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
468 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
469 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
470 dir_update_volume_info(dcr, false);
474 * If we are reading, we come here at the end of the tape
475 * and see if there are more volumes to be mounted.
477 bool mount_next_read_volume(DCR *dcr)
479 DEVICE *dev = dcr->dev;
481 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
483 * End Of Tape -- mount next Volume (if another specified)
485 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
487 dev->state &= ~ST_READ;
488 if (!acquire_device_for_read(jcr, dev)) {
489 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev_name(dev),
493 return true; /* next volume mounted */
495 Dmsg0(90, "End of Device reached.\n");
500 * Either because we are going to hang a new volume, or because
501 * of explicit user request, we release the current volume.
503 void release_volume(DCR *dcr)
506 DEVICE *dev = dcr->dev;
508 Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
509 Dmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
512 * First erase all memory of the current volume
514 dev->block_num = dev->file = 0;
515 dev->EndBlock = dev->EndFile = 0;
516 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
517 memset(&dcr->VolCatInfo, 0, sizeof(dcr->VolCatInfo));
518 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
519 /* Force re-read of label */
520 dev->state &= ~(ST_LABEL|ST_READ|ST_APPEND);
521 dcr->VolumeName[0] = 0;
523 if (dev->is_open() && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
524 offline_or_rewind_dev(dev);
528 /* If we have not closed the device, then at least rewind the tape */
529 if (dev->is_open()) {
530 offline_or_rewind_dev(dev);
532 Dmsg0(190, "===== release_volume ---");