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 Dmsg2(100, "Ask=%d autochanger=%d\n", ask, autochanger);
133 release = true; /* release next time if we "recurse" */
135 if (ask && !dir_ask_sysop_to_mount_volume(jcr, dev)) {
136 Dmsg0(100, "Error return ask_sysop ...\n");
137 return 0; /* error return */
139 if (job_canceled(jcr)) {
142 Dmsg1(100, "want vol=%s\n", jcr->VolumeName);
144 if (dev->poll && dev_cap(dev, CAP_CLOSEONPOLL)) {
145 force_close_dev(dev);
148 /* Ensure the device is open */
149 if (!open_device(jcr, dev)) {
154 * Now make sure we have the right tape mounted
158 * If we are writing to a stream device, ASSUME the volume label
161 if (dev_cap(dev, CAP_STREAM)) {
162 vol_label_status = VOL_OK;
163 create_volume_label(dev, jcr->VolumeName, "Default");
164 dev->VolHdr.LabelType = PRE_LABEL;
166 vol_label_status = read_dev_volume_label(jcr, dev, block);
169 Dmsg2(100, "dirVol=%s dirStat=%s\n", jcr->VolumeName,
170 jcr->VolCatInfo.VolCatStatus);
172 * At this point, dev->VolCatInfo has what is in the drive, if anything,
173 * and jcr->VolCatInfo has what the Director wants.
175 switch (vol_label_status) {
177 Dmsg1(100, "Vol OK name=%s\n", jcr->VolumeName);
178 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
179 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
180 break; /* got a Volume */
182 VOLUME_CAT_INFO VolCatInfo;
184 Dmsg1(100, "Vol NAME Error Name=%s\n", jcr->VolumeName);
185 /* If polling and got a previous bad name, ignore it */
186 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolName) == 0) {
188 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n",
193 * OK, we got a different volume mounted. First save the
194 * requested Volume info (jcr) structure, then query if
195 * this volume is really OK. If not, put back the desired
196 * volume name and continue.
198 memcpy(&VolCatInfo, &jcr->VolCatInfo, sizeof(VolCatInfo));
199 /* Check if this is a valid Volume in the pool */
200 pm_strcpy(&jcr->VolumeName, dev->VolHdr.VolName);
201 if (!dir_get_volume_info(jcr, GET_VOL_INFO_FOR_WRITE)) {
202 bstrncpy(dev->BadVolName, dev->VolHdr.VolName, sizeof(dev->BadVolName));
203 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
204 " Current Volume \"%s\" not acceptable because:\n"
206 VolCatInfo.VolCatName, dev->VolHdr.VolName,
207 jcr->dir_bsock->msg);
208 /* Restore desired volume name, note device info out of sync */
209 memcpy(&jcr->VolCatInfo, &VolCatInfo, sizeof(jcr->VolCatInfo));
213 Dmsg1(100, "want new name=%s\n", jcr->VolumeName);
214 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
215 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
216 break; /* got a Volume */
218 * At this point, we assume we have a blank tape mounted.
223 * If permitted, we label the device, make sure we can do
224 * it by checking that the VolCatBytes is zero => not labeled,
225 * once the Volume is labeled we don't want to label another
226 * blank tape with the same name. For disk, we go ahead and
227 * label it anyway, because the OS insures that there is only
228 * one Volume with that name.
229 * As noted above, at this point jcr->VolCatInfo has what
230 * the Director wants and dev->VolCatInfo has info on the
231 * previous tape (or nothing).
233 if (dev_cap(dev, CAP_LABEL) && (jcr->VolCatInfo.VolCatBytes == 0 ||
234 (!dev_is_tape(dev) && strcmp(jcr->VolCatInfo.VolCatStatus,
236 Dmsg0(100, "Create volume label\n");
237 if (!write_volume_label_to_dev(jcr, (DEVRES *)dev->device, jcr->VolumeName,
239 Dmsg0(100, "!write_vol_label\n");
242 Dmsg0(100, "dir_update_vol_info. Set Append\n");
243 /* Copy Director's info into the device info */
244 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
245 dir_update_volume_info(jcr, dev, 1); /* indicate tape labeled */
246 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
247 jcr->VolumeName, dev_name(dev));
248 goto read_volume; /* read label we just wrote */
250 /* NOTE! Fall-through wanted. */
253 /* Send error message */
255 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
257 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
264 * See if we have a fresh tape or a tape with data.
266 * Note, if the LabelType is PRE_LABEL, it was labeled
267 * but never written. If so, rewrite the label but set as
268 * VOL_LABEL. We rewind and return the label (reconstructed)
269 * in the block so that in the case of a new tape, data can
270 * be appended just after the block label. If we are writing
271 * a second volume, the calling routine will write the label
272 * before writing the overflow block.
274 * If the tape is marked as Recycle, we rewrite the label.
276 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
277 Dmsg1(190, "ready_for_append found freshly labeled volume. dev=%x\n", dev);
278 dev->VolHdr.LabelType = VOL_LABEL; /* set Volume label */
279 write_volume_label_to_block(jcr, dev, block);
281 * If we are not dealing with a streaming device,
282 * write the block now to ensure we have write permission.
283 * It is better to find out now rather than later.
285 if (!dev_cap(dev, CAP_STREAM)) {
286 if (!rewind_dev(dev)) {
287 Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device \"%s\". ERR=%s\n"),
288 dev_name(dev), strerror_dev(dev));
291 if (!truncate_dev(dev)) {
292 Jmsg2(jcr, M_WARNING, 0, _("Truncate error on device \"%s\". ERR=%s\n"),
293 dev_name(dev), strerror_dev(dev));
296 /* Attempt write to check write permission */
297 if (!write_block_to_dev(jcr->dcr, block)) {
298 Jmsg2(jcr, M_ERROR, 0, _("Unable to write device \"%s\". ERR=%s\n"),
299 dev_name(dev), strerror_dev(dev));
303 /* Set or reset Volume statistics */
304 dev->VolCatInfo.VolCatJobs = 0;
305 dev->VolCatInfo.VolCatFiles = 0;
306 dev->VolCatInfo.VolCatBytes = 1;
307 dev->VolCatInfo.VolCatErrors = 0;
308 dev->VolCatInfo.VolCatBlocks = 0;
309 dev->VolCatInfo.VolCatRBytes = 0;
311 dev->VolCatInfo.VolCatMounts++;
312 dev->VolCatInfo.VolCatRecycles++;
314 dev->VolCatInfo.VolCatMounts = 1;
315 dev->VolCatInfo.VolCatRecycles = 0;
316 dev->VolCatInfo.VolCatWrites = 1;
317 dev->VolCatInfo.VolCatReads = 1;
319 Dmsg0(100, "dir_update_vol_info. Set Append\n");
320 bstrncpy(dev->VolCatInfo.VolCatStatus, "Append", sizeof(dev->VolCatInfo.VolCatStatus));
321 dir_update_volume_info(jcr, dev, 1); /* indicate doing relabel */
323 Jmsg(jcr, M_INFO, 0, _("Recycled volume \"%s\" on device \"%s\", all previous data lost.\n"),
324 jcr->VolumeName, dev_name(dev));
326 Jmsg(jcr, M_INFO, 0, _("Wrote label to prelabeled Volume \"%s\" on device \"%s\"\n"),
327 jcr->VolumeName, dev_name(dev));
330 * End writing real Volume label (from pre-labeled tape), or recycling
336 * OK, at this point, we have a valid Bacula label, but
337 * we need to position to the end of the volume, since we are
338 * just now putting it into append mode.
340 Dmsg0(200, "Device previously written, moving to end of data\n");
341 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
344 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device \"%s\". ERR=%s\n"),
345 dev_name(dev), strerror_dev(dev));
346 mark_volume_in_error(jcr, dev);
349 /* *****FIXME**** we should do some checking for files too */
350 if (dev_is_tape(dev)) {
352 * Check if we are positioned on the tape at the same place
353 * that the database says we should be.
355 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
356 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
357 jcr->VolumeName, dev_file(dev));
359 Jmsg(jcr, M_ERROR, 0, _("I canot write on Volume \"%s\" because:\n\
360 The number of files mismatch! Volume=%u Catalog=%u\n"),
361 jcr->VolumeName, dev_file(dev), dev->VolCatInfo.VolCatFiles);
362 mark_volume_in_error(jcr, dev);
366 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
367 Dmsg1(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
368 dir_update_volume_info(jcr, dev, 0);
369 /* Return an empty block */
370 empty_block(block); /* we used it for reading so set for write */
372 dev->state |= ST_APPEND;
373 Dmsg0(100, "Normal return from read_dev_for_append\n");
378 * Mark volume in error in catalog
380 void mark_volume_in_error(JCR *jcr, DEVICE *dev)
382 Jmsg(jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
384 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
385 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
386 dir_update_volume_info(jcr, dev, 0);
390 * If we are reading, we come here at the end of the tape
391 * and see if there are more volumes to be mounted.
393 int mount_next_read_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
395 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
397 * End Of Tape -- mount next Volume (if another specified)
399 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
401 dev->state &= ~ST_READ;
402 if (!acquire_device_for_read(jcr)) {
403 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev_name(dev),
407 return 1; /* next volume mounted */
409 Dmsg0(90, "End of Device reached.\n");
414 * Either because we are going to hang a new volume, or because
415 * of explicit user request, we release the current volume.
417 void release_volume(JCR *jcr, DEVICE *dev)
419 if (jcr->dcr->WroteVol) {
420 Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
423 * First erase all memory of the current volume
425 dev->block_num = dev->file = 0;
426 dev->EndBlock = dev->EndFile = 0;
427 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
428 memset(&jcr->VolCatInfo, 0, sizeof(jcr->VolCatInfo));
429 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
430 /* Force re-read of label */
431 dev->state &= ~(ST_LABEL|ST_READ|ST_APPEND);
432 jcr->VolumeName[0] = 0;
434 if ((dev->state & ST_OPENED) &&
435 (!dev_is_tape(dev) || !dev_cap(dev, CAP_ALWAYSOPEN))) {
436 offline_or_rewind_dev(dev);
440 /* If we have not closed the device, then at least rewind the tape */
441 if (dev->state & ST_OPENED) {
442 offline_or_rewind_dev(dev);