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(JCR *jcr, DEVICE *dev, DEV_BLOCK *bloc, 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(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, bool release)
51 bool ask = false, recycle, autochanger;
54 Dmsg0(100, "Enter mount_next_volume()\n");
56 init_dev_wait_timers(dev);
59 * Attempt to mount the next volume. If something non-fatal goes
60 * wrong, we come back here to re-try (new op messages, re-read
64 /* Ignore retry if this is poll request */
65 if (!dev->poll && retry++ > 4) {
66 /* Last ditch effort before giving up, force operator to respond */
67 jcr->VolCatInfo.Slot = 0;
68 if (!dir_ask_sysop_to_mount_volume(jcr)) {
69 Jmsg(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"),
74 if (job_canceled(jcr)) {
75 Jmsg(jcr, M_FATAL, 0, _("Job %d canceled.\n"), jcr->JobId);
80 Dmsg0(100, "mount_next_volume release=1\n");
81 release_volume(jcr, dev);
82 ask = true; /* ask operator to mount tape */
86 * Get Director's idea of what tape we should have mounted.
89 Dmsg0(200, "Before dir_find_next_appendable_volume.\n");
90 while (!dir_find_next_appendable_volume(jcr)) {
91 Dmsg0(200, "not dir_find_next\n");
92 if (!dir_ask_sysop_to_create_appendable_volume(jcr)) {
95 Dmsg0(200, "Again dir_find_next_append...\n");
97 if (job_canceled(jcr)) {
100 Dmsg2(100, "After find_next_append. Vol=%s Slot=%d\n",
101 jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
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.
113 * It assumes that the device is not already in use!
116 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
118 if (autoload_device(jcr, dev, 1, NULL) > 0) {
123 jcr->VolCatInfo.Slot = 0;
125 Dmsg1(100, "autoload_dev returns %d\n", autochanger);
127 * If we autochanged to correct Volume or (we have not just
128 * released the Volume AND we can automount) we go ahead
129 * and read the label. If there is no tape in the drive,
130 * we will err, recurse and ask the operator the next time.
132 if (!release && dev_is_tape(dev) && dev_cap(dev, CAP_AUTOMOUNT)) {
133 ask = false; /* don't ask SYSOP this time */
135 /* Don't ask if not removable */
136 if (!dev_cap(dev, CAP_REM)) {
139 Dmsg2(100, "Ask=%d autochanger=%d\n", ask, autochanger);
140 release = true; /* release next time if we "recurse" */
142 if (ask && !dir_ask_sysop_to_mount_volume(jcr)) {
143 Dmsg0(100, "Error return ask_sysop ...\n");
144 return false; /* error return */
146 if (job_canceled(jcr)) {
149 Dmsg1(100, "want vol=%s\n", jcr->VolumeName);
151 if (dev->poll && dev_cap(dev, CAP_CLOSEONPOLL)) {
152 force_close_dev(dev);
155 /* Ensure the device is open */
156 if (!open_device(jcr, dev)) {
161 * Now make sure we have the right tape mounted
165 * If we are writing to a stream device, ASSUME the volume label
168 if (dev_cap(dev, CAP_STREAM)) {
169 vol_label_status = VOL_OK;
170 create_volume_label(dev, jcr->VolumeName, "Default");
171 dev->VolHdr.LabelType = PRE_LABEL;
173 vol_label_status = read_dev_volume_label(jcr, dev, block);
176 Dmsg2(100, "dirVol=%s dirStat=%s\n", jcr->VolumeName,
177 jcr->VolCatInfo.VolCatStatus);
179 * At this point, dev->VolCatInfo has what is in the drive, if anything,
180 * and jcr->VolCatInfo has what the Director wants.
182 switch (vol_label_status) {
184 Dmsg1(100, "Vol OK name=%s\n", jcr->VolumeName);
185 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
186 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
187 break; /* got a Volume */
189 VOLUME_CAT_INFO VolCatInfo;
191 /* If not removable, Volume is broken */
192 if (!dev_cap(dev, CAP_REM)) {
193 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
194 jcr->VolumeName, dev_name(dev));
195 mark_volume_in_error(jcr, dev);
199 Dmsg1(100, "Vol NAME Error Name=%s\n", jcr->VolumeName);
200 /* If polling and got a previous bad name, ignore it */
201 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolName) == 0) {
203 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n",
208 * OK, we got a different volume mounted. First save the
209 * requested Volume info (jcr) structure, then query if
210 * this volume is really OK. If not, put back the desired
211 * volume name and continue.
213 memcpy(&VolCatInfo, &jcr->VolCatInfo, sizeof(VolCatInfo));
214 /* Check if this is a valid Volume in the pool */
215 pm_strcpy(&jcr->VolumeName, dev->VolHdr.VolName);
216 if (!dir_get_volume_info(jcr, GET_VOL_INFO_FOR_WRITE)) {
217 bstrncpy(dev->BadVolName, dev->VolHdr.VolName, sizeof(dev->BadVolName));
218 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
219 " Current Volume \"%s\" not acceptable because:\n"
221 VolCatInfo.VolCatName, dev->VolHdr.VolName,
222 jcr->dir_bsock->msg);
223 /* Restore desired volume name, note device info out of sync */
224 memcpy(&jcr->VolCatInfo, &VolCatInfo, sizeof(jcr->VolCatInfo));
228 Dmsg1(100, "want new name=%s\n", jcr->VolumeName);
229 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
230 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
231 break; /* got a Volume */
233 * At this point, we assume we have a blank tape mounted.
238 * If permitted, we label the device, make sure we can do
239 * it by checking that the VolCatBytes is zero => not labeled,
240 * once the Volume is labeled we don't want to label another
241 * blank tape with the same name. For disk, we go ahead and
242 * label it anyway, because the OS insures that there is only
243 * one Volume with that name.
244 * As noted above, at this point jcr->VolCatInfo has what
245 * the Director wants and dev->VolCatInfo has info on the
246 * previous tape (or nothing).
248 if (dev_cap(dev, CAP_LABEL) && (jcr->VolCatInfo.VolCatBytes == 0 ||
249 (!dev_is_tape(dev) && strcmp(jcr->VolCatInfo.VolCatStatus,
251 Dmsg0(100, "Create volume label\n");
252 /* Create a new Volume label and write it to the device */
253 if (!write_new_volume_label_to_dev(jcr, dev, jcr->VolumeName,
255 Dmsg0(100, "!write_vol_label\n");
258 Dmsg0(100, "dir_update_vol_info. Set Append\n");
259 /* Copy Director's info into the device info */
260 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
261 dir_update_volume_info(jcr, true); /* indicate tape labeled */
262 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
263 jcr->VolumeName, dev_name(dev));
264 goto read_volume; /* read label we just wrote */
266 /* If not removable, Volume is broken */
267 if (!dev_cap(dev, CAP_REM)) {
268 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
269 jcr->VolumeName, dev_name(dev));
270 mark_volume_in_error(jcr, dev);
273 /* NOTE! Fall-through wanted. */
276 /* Send error message */
278 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
280 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
287 * See if we have a fresh tape or a tape with data.
289 * Note, if the LabelType is PRE_LABEL, it was labeled
290 * but never written. If so, rewrite the label but set as
291 * VOL_LABEL. We rewind and return the label (reconstructed)
292 * in the block so that in the case of a new tape, data can
293 * be appended just after the block label. If we are writing
294 * a second volume, the calling routine will write the label
295 * before writing the overflow block.
297 * If the tape is marked as Recycle, we rewrite the label.
299 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
300 if (!rewrite_volume_label(jcr, dev, block, recycle)) {
305 * OK, at this point, we have a valid Bacula label, but
306 * we need to position to the end of the volume, since we are
307 * just now putting it into append mode.
309 Dmsg0(200, "Device previously written, moving to end of data\n");
310 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
313 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device \"%s\". ERR=%s\n"),
314 dev_name(dev), strerror_dev(dev));
315 mark_volume_in_error(jcr, dev);
318 /* *****FIXME**** we should do some checking for files too */
319 if (dev_is_tape(dev)) {
321 * Check if we are positioned on the tape at the same place
322 * that the database says we should be.
324 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
325 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
326 jcr->VolumeName, dev_file(dev));
328 Jmsg(jcr, M_ERROR, 0, _("I canot write on Volume \"%s\" because:\n\
329 The number of files mismatch! Volume=%u Catalog=%u\n"),
330 jcr->VolumeName, dev_file(dev), dev->VolCatInfo.VolCatFiles);
331 mark_volume_in_error(jcr, dev);
335 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
336 Dmsg1(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
337 dir_update_volume_info(jcr, false);
338 /* Return an empty block */
339 empty_block(block); /* we used it for reading so set for write */
341 dev->state |= ST_APPEND;
342 Dmsg0(100, "Normal return from read_dev_for_append\n");
347 * Write a volume label.
348 * Returns: true if OK
349 * false if unable to write it
351 static bool rewrite_volume_label(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, bool recycle)
353 Dmsg1(190, "ready_for_append found freshly labeled volume. dev=%x\n", dev);
354 dev->VolHdr.LabelType = VOL_LABEL; /* set Volume label */
355 if (!write_volume_label_to_block(jcr, dev, block)) {
359 * If we are not dealing with a streaming device,
360 * write the block now to ensure we have write permission.
361 * It is better to find out now rather than later.
363 if (!dev_cap(dev, CAP_STREAM)) {
364 if (!rewind_dev(dev)) {
365 Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device \"%s\". ERR=%s\n"),
366 dev_name(dev), strerror_dev(dev));
369 if (!truncate_dev(dev)) {
370 Jmsg2(jcr, M_WARNING, 0, _("Truncate error on device \"%s\". ERR=%s\n"),
371 dev_name(dev), strerror_dev(dev));
374 /* Attempt write to check write permission */
375 if (!write_block_to_dev(jcr->dcr, block)) {
376 Jmsg2(jcr, M_ERROR, 0, _("Unable to write device \"%s\". ERR=%s\n"),
377 dev_name(dev), strerror_dev(dev));
381 /* Set or reset Volume statistics */
382 dev->VolCatInfo.VolCatJobs = 0;
383 dev->VolCatInfo.VolCatFiles = 0;
384 dev->VolCatInfo.VolCatBytes = 1;
385 dev->VolCatInfo.VolCatErrors = 0;
386 dev->VolCatInfo.VolCatBlocks = 0;
387 dev->VolCatInfo.VolCatRBytes = 0;
389 dev->VolCatInfo.VolCatMounts++;
390 dev->VolCatInfo.VolCatRecycles++;
392 dev->VolCatInfo.VolCatMounts = 1;
393 dev->VolCatInfo.VolCatRecycles = 0;
394 dev->VolCatInfo.VolCatWrites = 1;
395 dev->VolCatInfo.VolCatReads = 1;
397 Dmsg0(100, "dir_update_vol_info. Set Append\n");
398 bstrncpy(dev->VolCatInfo.VolCatStatus, "Append", sizeof(dev->VolCatInfo.VolCatStatus));
399 dir_update_volume_info(jcr, true); /* indicate doing relabel */
401 Jmsg(jcr, M_INFO, 0, _("Recycled volume \"%s\" on device \"%s\", all previous data lost.\n"),
402 jcr->VolumeName, dev_name(dev));
404 Jmsg(jcr, M_INFO, 0, _("Wrote label to prelabeled Volume \"%s\" on device \"%s\"\n"),
405 jcr->VolumeName, dev_name(dev));
408 * End writing real Volume label (from pre-labeled tape), or recycling
416 * Mark volume in error in catalog
418 void mark_volume_in_error(JCR *jcr, DEVICE *dev)
420 Jmsg(jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
422 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
423 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
424 dir_update_volume_info(jcr, false);
428 * If we are reading, we come here at the end of the tape
429 * and see if there are more volumes to be mounted.
431 bool mount_next_read_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
433 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
435 * End Of Tape -- mount next Volume (if another specified)
437 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
439 dev->state &= ~ST_READ;
440 if (!acquire_device_for_read(jcr)) {
441 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev_name(dev),
445 return true; /* next volume mounted */
447 Dmsg0(90, "End of Device reached.\n");
452 * Either because we are going to hang a new volume, or because
453 * of explicit user request, we release the current volume.
455 void release_volume(JCR *jcr, DEVICE *dev)
457 if (jcr->dcr->WroteVol) {
458 Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
461 * First erase all memory of the current volume
463 dev->block_num = dev->file = 0;
464 dev->EndBlock = dev->EndFile = 0;
465 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
466 memset(&jcr->VolCatInfo, 0, sizeof(jcr->VolCatInfo));
467 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
468 /* Force re-read of label */
469 dev->state &= ~(ST_LABEL|ST_READ|ST_APPEND);
470 jcr->VolumeName[0] = 0;
472 if ((dev->state & ST_OPENED) &&
473 (!dev_is_tape(dev) || !dev_cap(dev, CAP_ALWAYSOPEN))) {
474 offline_or_rewind_dev(dev);
478 /* If we have not closed the device, then at least rewind the tape */
479 if (dev->state & ST_OPENED) {
480 offline_or_rewind_dev(dev);