3 * Routines for handling mounting tapes for reading and for
6 * Kern Sibbald, August MMII
11 Copyright (C) 2000-2004 Kern Sibbald and John Walker
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 Dmsg2(100, "After find_next_append. Vol=%s Slot=%d\n",
104 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot);
107 * Get next volume and ready it for append
108 * This code ensures that the device is ready for
109 * writing. We start from the assumption that there
110 * may not be a tape mounted.
112 * If the device is a file, we create the output
113 * file. If it is a tape, we check the volume name
114 * and move the tape to the end of data.
116 * It assumes that the device is not already in use!
119 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
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 (!open_device(dcr)) {
168 * Now make sure we have the right tape mounted
172 * If we are writing to a stream device, ASSUME the volume label
175 if (dev_cap(dev, CAP_STREAM)) {
176 vol_label_status = VOL_OK;
177 create_volume_label(dev, dcr->VolumeName, "Default");
178 dev->VolHdr.LabelType = PRE_LABEL;
180 vol_label_status = read_dev_volume_label(dcr);
182 if (job_canceled(jcr)) {
186 Dmsg2(100, "dirVol=%s dirStat=%s\n", dcr->VolumeName,
187 dcr->VolCatInfo.VolCatStatus);
189 * At this point, dev->VolCatInfo has what is in the drive, if anything,
190 * and dcr->VolCatInfo has what the Director wants.
192 switch (vol_label_status) {
194 Dmsg1(100, "Vol OK name=%s\n", dcr->VolumeName);
195 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
196 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
197 break; /* got a Volume */
199 VOLUME_CAT_INFO VolCatInfo;
201 /* If not removable, Volume is broken */
202 if (!dev_cap(dev, CAP_REM)) {
203 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
204 dcr->VolumeName, dev_name(dev));
205 mark_volume_in_error(dcr);
209 Dmsg1(100, "Vol NAME Error Name=%s\n", dcr->VolumeName);
210 /* If polling and got a previous bad name, ignore it */
211 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolName) == 0) {
213 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n",
218 * OK, we got a different volume mounted. First save the
219 * requested Volume info (jcr) structure, then query if
220 * this volume is really OK. If not, put back the desired
221 * volume name and continue.
223 memcpy(&VolCatInfo, &dcr->VolCatInfo, sizeof(VolCatInfo));
224 /* Check if this is a valid Volume in the pool */
225 bstrncpy(dcr->VolumeName, dev->VolHdr.VolName, sizeof(dcr->VolumeName));
226 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
227 bstrncpy(dev->BadVolName, dev->VolHdr.VolName, 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.VolName,
232 jcr->dir_bsock->msg);
233 /* Restore desired volume name, note device info out of sync */
234 memcpy(&dcr->VolCatInfo, &VolCatInfo, sizeof(dcr->VolCatInfo));
238 Dmsg1(100, "want new name=%s\n", dcr->VolumeName);
239 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
240 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
241 break; /* got a Volume */
243 * At this point, we assume we have a blank tape mounted.
248 * If permitted, we label the device, make sure we can do
249 * it by checking that the VolCatBytes is zero => not labeled,
250 * once the Volume is labeled we don't want to label another
251 * blank tape with the same name. For disk, we go ahead and
252 * label it anyway, because the OS insures that there is only
253 * one Volume with that name.
254 * As noted above, at this point dcr->VolCatInfo has what
255 * the Director wants and dev->VolCatInfo has info on the
256 * previous tape (or nothing).
258 if (dev_cap(dev, CAP_LABEL) && (dcr->VolCatInfo.VolCatBytes == 0 ||
259 (!dev_is_tape(dev) && strcmp(dcr->VolCatInfo.VolCatStatus,
261 Dmsg0(100, "Create volume label\n");
262 /* Create a new Volume label and write it to the device */
263 if (!write_new_volume_label_to_dev(dcr, dcr->VolumeName,
265 Dmsg0(100, "!write_vol_label\n");
268 Dmsg0(100, "dir_update_vol_info. Set Append\n");
269 /* Copy Director's info into the device info */
270 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
271 dir_update_volume_info(dcr, true); /* indicate tape labeled */
272 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
273 dcr->VolumeName, dev_name(dev));
274 goto read_volume; /* read label we just wrote */
276 /* If not removable, Volume is broken */
277 if (!dev_cap(dev, CAP_REM)) {
278 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
279 dcr->VolumeName, dev_name(dev));
280 mark_volume_in_error(dcr);
283 /* NOTE! Fall-through wanted. */
286 /* Send error message */
288 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
290 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
297 * See if we have a fresh tape or a tape with data.
299 * Note, if the LabelType is PRE_LABEL, it was labeled
300 * but never written. If so, rewrite the label but set as
301 * VOL_LABEL. We rewind and return the label (reconstructed)
302 * in the block so that in the case of a new tape, data can
303 * be appended just after the block label. If we are writing
304 * a second volume, the calling routine will write the label
305 * before writing the overflow block.
307 * If the tape is marked as Recycle, we rewrite the label.
309 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
310 if (!rewrite_volume_label(dcr, recycle)) {
315 * OK, at this point, we have a valid Bacula label, but
316 * we need to position to the end of the volume, since we are
317 * just now putting it into append mode.
319 Dmsg0(200, "Device previously written, moving to end of data\n");
320 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
323 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device \"%s\". ERR=%s\n"),
324 dev_name(dev), strerror_dev(dev));
325 mark_volume_in_error(dcr);
328 /* *****FIXME**** we should do some checking for files too */
329 if (dev_is_tape(dev)) {
331 * Check if we are positioned on the tape at the same place
332 * that the database says we should be.
334 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
335 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
336 dcr->VolumeName, dev_file(dev));
338 Jmsg(jcr, M_ERROR, 0, _("I canot write on Volume \"%s\" because:\n\
339 The number of files mismatch! Volume=%u Catalog=%u\n"),
340 dcr->VolumeName, dev_file(dev), dev->VolCatInfo.VolCatFiles);
341 mark_volume_in_error(dcr);
345 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
346 Dmsg1(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
347 dir_update_volume_info(dcr, false);
348 /* Return an empty block */
349 empty_block(block); /* we used it for reading so set for write */
351 dev->state |= ST_APPEND;
352 Dmsg0(100, "Normal return from read_dev_for_append\n");
357 * Write a volume label.
358 * Returns: true if OK
359 * false if unable to write it
361 static bool rewrite_volume_label(DCR *dcr, bool recycle)
363 DEVICE *dev = dcr->dev;
366 Dmsg1(190, "ready_for_append found freshly labeled volume. dev=%x\n", dev);
367 dev->VolHdr.LabelType = VOL_LABEL; /* set Volume label */
368 if (!write_volume_label_to_block(dcr)) {
372 * If we are not dealing with a streaming device,
373 * write the block now to ensure we have write permission.
374 * It is better to find out now rather than later.
376 if (!dev_cap(dev, CAP_STREAM)) {
377 if (!rewind_dev(dev)) {
378 Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device \"%s\". ERR=%s\n"),
379 dev_name(dev), strerror_dev(dev));
382 if (!truncate_dev(dev)) {
383 Jmsg2(jcr, M_WARNING, 0, _("Truncate error on device \"%s\". ERR=%s\n"),
384 dev_name(dev), strerror_dev(dev));
387 /* Attempt write to check write permission */
388 if (!write_block_to_dev(dcr)) {
389 Jmsg2(jcr, M_ERROR, 0, _("Unable to write device \"%s\". ERR=%s\n"),
390 dev_name(dev), strerror_dev(dev));
394 /* Set or reset Volume statistics */
395 dev->VolCatInfo.VolCatJobs = 0;
396 dev->VolCatInfo.VolCatFiles = 0;
397 dev->VolCatInfo.VolCatBytes = 1;
398 dev->VolCatInfo.VolCatErrors = 0;
399 dev->VolCatInfo.VolCatBlocks = 0;
400 dev->VolCatInfo.VolCatRBytes = 0;
402 dev->VolCatInfo.VolCatMounts++;
403 dev->VolCatInfo.VolCatRecycles++;
405 dev->VolCatInfo.VolCatMounts = 1;
406 dev->VolCatInfo.VolCatRecycles = 0;
407 dev->VolCatInfo.VolCatWrites = 1;
408 dev->VolCatInfo.VolCatReads = 1;
410 Dmsg0(100, "dir_update_vol_info. Set Append\n");
411 bstrncpy(dev->VolCatInfo.VolCatStatus, "Append", sizeof(dev->VolCatInfo.VolCatStatus));
412 dir_update_volume_info(dcr, true); /* indicate doing relabel */
414 Jmsg(jcr, M_INFO, 0, _("Recycled volume \"%s\" on device \"%s\", all previous data lost.\n"),
415 dcr->VolumeName, dev_name(dev));
417 Jmsg(jcr, M_INFO, 0, _("Wrote label to prelabeled Volume \"%s\" on device \"%s\"\n"),
418 dcr->VolumeName, dev_name(dev));
421 * End writing real Volume label (from pre-labeled tape), or recycling
429 * Mark volume in error in catalog
431 void mark_volume_in_error(DCR *dcr)
433 DEVICE *dev = dcr->dev;
434 Jmsg(dcr->jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
436 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
437 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
438 dir_update_volume_info(dcr, false);
442 * If we are reading, we come here at the end of the tape
443 * and see if there are more volumes to be mounted.
445 bool mount_next_read_volume(DCR *dcr)
447 DEVICE *dev = dcr->dev;
449 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
451 * End Of Tape -- mount next Volume (if another specified)
453 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
455 dev->state &= ~ST_READ;
456 if (!acquire_device_for_read(jcr)) {
457 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev_name(dev),
461 return true; /* next volume mounted */
463 Dmsg0(90, "End of Device reached.\n");
468 * Either because we are going to hang a new volume, or because
469 * of explicit user request, we release the current volume.
471 void release_volume(DCR *dcr)
474 DEVICE *dev = dcr->dev;
476 Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
479 * First erase all memory of the current volume
481 dev->block_num = dev->file = 0;
482 dev->EndBlock = dev->EndFile = 0;
483 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
484 memset(&dcr->VolCatInfo, 0, sizeof(dcr->VolCatInfo));
485 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
486 /* Force re-read of label */
487 dev->state &= ~(ST_LABEL|ST_READ|ST_APPEND);
488 dcr->VolumeName[0] = 0;
490 if ((dev->state & ST_OPENED) &&
491 (!dev_is_tape(dev) || !dev_cap(dev, CAP_ALWAYSOPEN))) {
492 offline_or_rewind_dev(dev);
496 /* If we have not closed the device, then at least rewind the tape */
497 if (dev->state & ST_OPENED) {
498 offline_or_rewind_dev(dev);