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 */
34 * If release is set, we rewind the current volume,
35 * which we no longer want, and ask the user (console)
36 * to mount the next volume.
38 * Continue trying until we get it, and then ensure
39 * that we can write on it.
41 * This routine returns a 0 only if it is REALLY
42 * impossible to get the requested Volume.
45 int mount_next_write_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, int release)
48 bool ask = false, recycle, autochanger;
51 Dmsg0(100, "Enter mount_next_volume()\n");
53 init_dev_wait_timers(dev);
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 jcr->VolCatInfo.Slot = 0;
65 if (!dir_ask_sysop_to_mount_volume(jcr, dev)) {
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");
78 release_volume(jcr, dev);
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(jcr)) {
88 Dmsg0(200, "not dir_find_next\n");
89 if (!dir_ask_sysop_to_create_appendable_volume(jcr, dev)) {
92 Dmsg0(200, "Again dir_find_next_append...\n");
94 if (job_canceled(jcr)) {
97 Dmsg2(100, "After find_next_append. Vol=%s Slot=%d\n",
98 jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
101 * Get next volume and ready it for append
102 * This code ensures that the device is ready for
103 * writing. We start from the assumption that there
104 * may not be a tape mounted.
106 * If the device is a file, we create the output
107 * file. If it is a tape, we check the volume name
108 * and move the tape to the end of data.
110 * It assumes that the device is not already in use!
113 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
115 if (autoload_device(jcr, dev, 1, NULL) > 0) {
120 jcr->VolCatInfo.Slot = 0;
122 Dmsg1(100, "autoload_dev returns %d\n", autochanger);
124 * If we autochanged to correct Volume or (we have not just
125 * released the Volume AND we can automount) we go ahead
126 * and read the label. If there is no tape in the drive,
127 * we will err, recurse and ask the operator the next time.
129 if (!release && dev_is_tape(dev) && dev_cap(dev, CAP_AUTOMOUNT)) {
130 ask = false; /* don't ask SYSOP this time */
132 /* Don't ask if not removable */
133 if (!dev_cap(dev, CAP_REM)) {
136 Dmsg2(100, "Ask=%d autochanger=%d\n", ask, autochanger);
137 release = true; /* release next time if we "recurse" */
139 if (ask && !dir_ask_sysop_to_mount_volume(jcr, dev)) {
140 Dmsg0(100, "Error return ask_sysop ...\n");
141 return 0; /* error return */
143 if (job_canceled(jcr)) {
146 Dmsg1(100, "want vol=%s\n", jcr->VolumeName);
148 if (dev->poll && dev_cap(dev, CAP_CLOSEONPOLL)) {
149 force_close_dev(dev);
152 /* Ensure the device is open */
153 if (!open_device(jcr, dev)) {
158 * Now make sure we have the right tape mounted
162 * If we are writing to a stream device, ASSUME the volume label
165 if (dev_cap(dev, CAP_STREAM)) {
166 vol_label_status = VOL_OK;
167 create_volume_label(dev, jcr->VolumeName, "Default");
168 dev->VolHdr.LabelType = PRE_LABEL;
170 vol_label_status = read_dev_volume_label(jcr, dev, block);
173 Dmsg2(100, "dirVol=%s dirStat=%s\n", jcr->VolumeName,
174 jcr->VolCatInfo.VolCatStatus);
176 * At this point, dev->VolCatInfo has what is in the drive, if anything,
177 * and jcr->VolCatInfo has what the Director wants.
179 switch (vol_label_status) {
181 Dmsg1(100, "Vol OK name=%s\n", jcr->VolumeName);
182 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
183 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
184 break; /* got a Volume */
186 VOLUME_CAT_INFO VolCatInfo;
188 /* If not removable, Volume is broken */
189 if (!dev_cap(dev, CAP_REM)) {
190 bstrncpy(jcr->VolCatInfo.VolCatStatus, "Error",
191 sizeof(jcr->VolCatInfo.VolCatStatus));
192 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
193 dir_update_volume_info(jcr, dev, 1); /* indicate tape labeled */
194 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s. Volume marked in error.\n"),
195 jcr->VolumeName, dev_name(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 if (!write_volume_label_to_dev(jcr, (DEVRES *)dev->device, jcr->VolumeName,
254 Dmsg0(100, "!write_vol_label\n");
257 Dmsg0(100, "dir_update_vol_info. Set Append\n");
258 /* Copy Director's info into the device info */
259 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
260 dir_update_volume_info(jcr, dev, 1); /* indicate tape labeled */
261 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
262 jcr->VolumeName, dev_name(dev));
263 goto read_volume; /* read label we just wrote */
265 /* If not removable, Volume is broken */
266 if (!dev_cap(dev, CAP_REM)) {
267 bstrncpy(jcr->VolCatInfo.VolCatStatus, "Error",
268 sizeof(jcr->VolCatInfo.VolCatStatus));
269 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
270 dir_update_volume_info(jcr, dev, 1); /* indicate tape labeled */
271 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s. Volume marked in error.\n"),
272 jcr->VolumeName, dev_name(dev));
275 /* NOTE! Fall-through wanted. */
278 /* Send error message */
280 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
282 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
289 * See if we have a fresh tape or a tape with data.
291 * Note, if the LabelType is PRE_LABEL, it was labeled
292 * but never written. If so, rewrite the label but set as
293 * VOL_LABEL. We rewind and return the label (reconstructed)
294 * in the block so that in the case of a new tape, data can
295 * be appended just after the block label. If we are writing
296 * a second volume, the calling routine will write the label
297 * before writing the overflow block.
299 * If the tape is marked as Recycle, we rewrite the label.
301 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
302 Dmsg1(190, "ready_for_append found freshly labeled volume. dev=%x\n", dev);
303 dev->VolHdr.LabelType = VOL_LABEL; /* set Volume label */
304 write_volume_label_to_block(jcr, dev, block);
306 * If we are not dealing with a streaming device,
307 * write the block now to ensure we have write permission.
308 * It is better to find out now rather than later.
310 if (!dev_cap(dev, CAP_STREAM)) {
311 if (!rewind_dev(dev)) {
312 Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device \"%s\". ERR=%s\n"),
313 dev_name(dev), strerror_dev(dev));
316 if (!truncate_dev(dev)) {
317 Jmsg2(jcr, M_WARNING, 0, _("Truncate error on device \"%s\". ERR=%s\n"),
318 dev_name(dev), strerror_dev(dev));
321 /* Attempt write to check write permission */
322 if (!write_block_to_dev(jcr->dcr, block)) {
323 Jmsg2(jcr, M_ERROR, 0, _("Unable to write device \"%s\". ERR=%s\n"),
324 dev_name(dev), strerror_dev(dev));
328 /* Set or reset Volume statistics */
329 dev->VolCatInfo.VolCatJobs = 0;
330 dev->VolCatInfo.VolCatFiles = 0;
331 dev->VolCatInfo.VolCatBytes = 1;
332 dev->VolCatInfo.VolCatErrors = 0;
333 dev->VolCatInfo.VolCatBlocks = 0;
334 dev->VolCatInfo.VolCatRBytes = 0;
336 dev->VolCatInfo.VolCatMounts++;
337 dev->VolCatInfo.VolCatRecycles++;
339 dev->VolCatInfo.VolCatMounts = 1;
340 dev->VolCatInfo.VolCatRecycles = 0;
341 dev->VolCatInfo.VolCatWrites = 1;
342 dev->VolCatInfo.VolCatReads = 1;
344 Dmsg0(100, "dir_update_vol_info. Set Append\n");
345 bstrncpy(dev->VolCatInfo.VolCatStatus, "Append", sizeof(dev->VolCatInfo.VolCatStatus));
346 dir_update_volume_info(jcr, dev, 1); /* indicate doing relabel */
348 Jmsg(jcr, M_INFO, 0, _("Recycled volume \"%s\" on device \"%s\", all previous data lost.\n"),
349 jcr->VolumeName, dev_name(dev));
351 Jmsg(jcr, M_INFO, 0, _("Wrote label to prelabeled Volume \"%s\" on device \"%s\"\n"),
352 jcr->VolumeName, dev_name(dev));
355 * End writing real Volume label (from pre-labeled tape), or recycling
361 * OK, at this point, we have a valid Bacula label, but
362 * we need to position to the end of the volume, since we are
363 * just now putting it into append mode.
365 Dmsg0(200, "Device previously written, moving to end of data\n");
366 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
369 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device \"%s\". ERR=%s\n"),
370 dev_name(dev), strerror_dev(dev));
371 mark_volume_in_error(jcr, dev);
374 /* *****FIXME**** we should do some checking for files too */
375 if (dev_is_tape(dev)) {
377 * Check if we are positioned on the tape at the same place
378 * that the database says we should be.
380 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
381 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
382 jcr->VolumeName, dev_file(dev));
384 Jmsg(jcr, M_ERROR, 0, _("I canot write on Volume \"%s\" because:\n\
385 The number of files mismatch! Volume=%u Catalog=%u\n"),
386 jcr->VolumeName, dev_file(dev), dev->VolCatInfo.VolCatFiles);
387 mark_volume_in_error(jcr, dev);
391 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
392 Dmsg1(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
393 dir_update_volume_info(jcr, dev, 0);
394 /* Return an empty block */
395 empty_block(block); /* we used it for reading so set for write */
397 dev->state |= ST_APPEND;
398 Dmsg0(100, "Normal return from read_dev_for_append\n");
403 * Mark volume in error in catalog
405 void mark_volume_in_error(JCR *jcr, DEVICE *dev)
407 Jmsg(jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
409 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
410 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
411 dir_update_volume_info(jcr, dev, 0);
415 * If we are reading, we come here at the end of the tape
416 * and see if there are more volumes to be mounted.
418 int mount_next_read_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
420 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
422 * End Of Tape -- mount next Volume (if another specified)
424 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
426 dev->state &= ~ST_READ;
427 if (!acquire_device_for_read(jcr)) {
428 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev_name(dev),
432 return 1; /* next volume mounted */
434 Dmsg0(90, "End of Device reached.\n");
439 * Either because we are going to hang a new volume, or because
440 * of explicit user request, we release the current volume.
442 void release_volume(JCR *jcr, DEVICE *dev)
444 if (jcr->dcr->WroteVol) {
445 Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
448 * First erase all memory of the current volume
450 dev->block_num = dev->file = 0;
451 dev->EndBlock = dev->EndFile = 0;
452 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
453 memset(&jcr->VolCatInfo, 0, sizeof(jcr->VolCatInfo));
454 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
455 /* Force re-read of label */
456 dev->state &= ~(ST_LABEL|ST_READ|ST_APPEND);
457 jcr->VolumeName[0] = 0;
459 if ((dev->state & ST_OPENED) &&
460 (!dev_is_tape(dev) || !dev_cap(dev, CAP_ALWAYSOPEN))) {
461 offline_or_rewind_dev(dev);
465 /* If we have not closed the device, then at least rewind the tape */
466 if (dev->state & ST_OPENED) {
467 offline_or_rewind_dev(dev);