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 */
35 * If release is set, we rewind the current volume,
36 * which we no longer want, and ask the user (console)
37 * to mount the next volume.
39 * Continue trying until we get it, and then ensure
40 * that we can write on it.
42 * This routine returns a 0 only if it is REALLY
43 * impossible to get the requested Volume.
46 bool mount_next_write_volume(DCR *dcr, bool release)
49 bool ask = false, recycle, autochanger;
51 DEVICE *dev = dcr->dev;
53 DEV_BLOCK *block = dcr->block;
55 Dmsg0(100, "Enter mount_next_volume()\n");
57 init_dev_wait_timers(dev);
60 * Attempt to mount the next volume. If something non-fatal goes
61 * wrong, we come back here to re-try (new op messages, re-read
65 /* Ignore retry if this is poll request */
66 if (!dev->poll && retry++ > 4) {
67 /* Last ditch effort before giving up, force operator to respond */
68 dcr->VolCatInfo.Slot = 0;
69 if (!dir_ask_sysop_to_mount_volume(dcr)) {
70 Jmsg(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"),
75 if (job_canceled(jcr)) {
76 Jmsg(jcr, M_FATAL, 0, _("Job %d canceled.\n"), jcr->JobId);
81 Dmsg0(100, "mount_next_volume release=1\n");
83 ask = true; /* ask operator to mount tape */
87 * Get Director's idea of what tape we should have mounted.
90 Dmsg0(200, "Before dir_find_next_appendable_volume.\n");
91 while (!dir_find_next_appendable_volume(dcr)) {
92 Dmsg0(200, "not dir_find_next\n");
93 if (!dir_ask_sysop_to_create_appendable_volume(dcr)) {
96 Dmsg0(200, "Again dir_find_next_append...\n");
98 if (job_canceled(jcr)) {
101 Dmsg3(100, "After find_next_append. Vol=%s Slot=%d Parts=%d\n",
102 dcr->VolCatInfo.VolCatName, dcr->VolCatInfo.Slot, dcr->VolCatInfo.VolCatParts);
104 dev->num_parts = dcr->VolCatInfo.VolCatParts;
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 if (autoload_device(dcr, 1, NULL) > 0) {
124 dcr->VolCatInfo.Slot = 0;
126 Dmsg1(100, "autoload_dev returns %d\n", autochanger);
128 * If we autochanged to correct Volume or (we have not just
129 * released the Volume AND we can automount) we go ahead
130 * and read the label. If there is no tape in the drive,
131 * we will err, recurse and ask the operator the next time.
133 if (!release && dev_is_tape(dev) && dev_cap(dev, CAP_AUTOMOUNT)) {
134 ask = false; /* don't ask SYSOP this time */
136 /* Don't ask if not removable */
137 if (!dev_cap(dev, CAP_REM)) {
140 Dmsg2(100, "Ask=%d autochanger=%d\n", ask, autochanger);
141 release = true; /* release next time if we "recurse" */
143 if (ask && !dir_ask_sysop_to_mount_volume(dcr)) {
144 Dmsg0(100, "Error return ask_sysop ...\n");
145 return false; /* error return */
147 if (job_canceled(jcr)) {
150 Dmsg1(100, "want vol=%s\n", dcr->VolumeName);
152 if (dev->poll && dev_cap(dev, CAP_CLOSEONPOLL)) {
153 force_close_dev(dev);
156 /* Ensure the device is open */
157 /* If we have a dvd that requires mount, we first want to guess
158 * which Volume is loaded, so we continue (if the wrong device is
159 * loaded, open_device would fail). */
160 if (!dev->is_dvd()) {
161 if (!open_device(dcr)) {
170 * Just copy the VolCatName in the device resource
171 * (usually done by open_dev).
172 * It is necessary so we can open the real files later.
174 bstrncpy(dev->VolCatInfo.VolCatName, dcr->VolCatInfo.VolCatName, sizeof(dev->VolCatInfo.VolCatName));
178 * Now make sure we have the right tape mounted
182 * If we are writing to a stream device, ASSUME the volume label
185 if (dev_cap(dev, CAP_STREAM)) {
186 vol_label_status = VOL_OK;
187 create_volume_label(dev, dcr->VolumeName, "Default");
188 dev->VolHdr.LabelType = PRE_LABEL;
189 } else if (dev->is_dvd()) {
190 vol_label_status = read_dev_volume_label_guess(dcr, 1);
192 vol_label_status = read_dev_volume_label(dcr);
194 if (job_canceled(jcr)) {
198 Dmsg2(100, "dirVol=%s dirStat=%s\n", dcr->VolumeName,
199 dcr->VolCatInfo.VolCatStatus);
201 * At this point, dev->VolCatInfo has what is in the drive, if anything,
202 * and dcr->VolCatInfo has what the Director wants.
204 switch (vol_label_status) {
206 Dmsg1(100, "Vol OK name=%s\n", dcr->VolumeName);
207 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
208 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
209 break; /* got a Volume */
211 VOLUME_CAT_INFO VolCatInfo;
213 /* If not removable, Volume is broken */
214 if (!dev_cap(dev, CAP_REM)) {
215 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
216 dcr->VolumeName, dev_name(dev));
217 mark_volume_in_error(dcr);
221 Dmsg1(100, "Vol NAME Error Name=%s\n", dcr->VolumeName);
222 /* If polling and got a previous bad name, ignore it */
223 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolName) == 0) {
225 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n",
230 * OK, we got a different volume mounted. First save the
231 * requested Volume info (jcr) structure, then query if
232 * this volume is really OK. If not, put back the desired
233 * volume name and continue.
235 memcpy(&VolCatInfo, &dcr->VolCatInfo, sizeof(VolCatInfo));
236 /* Check if this is a valid Volume in the pool */
237 bstrncpy(dcr->VolumeName, dev->VolHdr.VolName, sizeof(dcr->VolumeName));
238 if (!dir_get_volume_info(dcr, GET_VOL_INFO_FOR_WRITE)) {
239 bstrncpy(dev->BadVolName, dev->VolHdr.VolName, sizeof(dev->BadVolName));
240 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
241 " Current Volume \"%s\" not acceptable because:\n"
243 VolCatInfo.VolCatName, dev->VolHdr.VolName,
244 jcr->dir_bsock->msg);
245 /* Restore desired volume name, note device info out of sync */
246 memcpy(&dcr->VolCatInfo, &VolCatInfo, sizeof(dcr->VolCatInfo));
250 Dmsg1(100, "want new name=%s\n", dcr->VolumeName);
251 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
252 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
253 break; /* got a Volume */
255 * At this point, we assume we have a blank tape mounted.
260 * If permitted, we label the device, make sure we can do
261 * it by checking that the VolCatBytes is zero => not labeled,
262 * once the Volume is labeled we don't want to label another
263 * blank tape with the same name. For disk, we go ahead and
264 * label it anyway, because the OS insures that there is only
265 * one Volume with that name.
266 * As noted above, at this point dcr->VolCatInfo has what
267 * the Director wants and dev->VolCatInfo has info on the
268 * previous tape (or nothing).
270 if (dev_cap(dev, CAP_LABEL) && (dcr->VolCatInfo.VolCatBytes == 0 ||
271 (!dev->is_tape() && strcmp(dcr->VolCatInfo.VolCatStatus,
273 Dmsg0(100, "Create volume label\n");
274 /* Create a new Volume label and write it to the device */
275 if (!write_new_volume_label_to_dev(dcr, dcr->VolumeName,
277 Dmsg0(100, "!write_vol_label\n");
280 Dmsg0(100, "dir_update_vol_info. Set Append\n");
281 /* Copy Director's info into the device info */
282 memcpy(&dev->VolCatInfo, &dcr->VolCatInfo, sizeof(dev->VolCatInfo));
283 if (!dir_update_volume_info(dcr, true)) { /* indicate tape labeled */
286 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
287 dcr->VolumeName, dev_name(dev));
288 goto read_volume; /* read label we just wrote */
290 /* If not removable, Volume is broken */
291 if (!dev_cap(dev, CAP_REM)) {
292 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" not on device %s.\n"),
293 dcr->VolumeName, dev_name(dev));
294 mark_volume_in_error(dcr);
297 /* NOTE! Fall-through wanted. */
300 /* Send error message */
302 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
304 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
307 /* Needed, so the medium can be changed */
308 if (dev_cap(dev, CAP_REQMOUNT)) {
315 * See if we have a fresh tape or a tape with data.
317 * Note, if the LabelType is PRE_LABEL, it was labeled
318 * but never written. If so, rewrite the label but set as
319 * VOL_LABEL. We rewind and return the label (reconstructed)
320 * in the block so that in the case of a new tape, data can
321 * be appended just after the block label. If we are writing
322 * a second volume, the calling routine will write the label
323 * before writing the overflow block.
325 * If the tape is marked as Recycle, we rewrite the label.
327 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
328 if (!rewrite_volume_label(dcr, recycle)) {
333 * OK, at this point, we have a valid Bacula label, but
334 * we need to position to the end of the volume, since we are
335 * just now putting it into append mode.
337 Dmsg0(200, "Device previously written, moving to end of data\n");
338 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
341 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device \"%s\". ERR=%s\n"),
342 dev_name(dev), strerror_dev(dev));
343 mark_volume_in_error(dcr);
346 /* *****FIXME**** we should do some checking for files too */
347 if (dev_is_tape(dev)) {
349 * Check if we are positioned on the tape at the same place
350 * that the database says we should be.
352 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
353 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
354 dcr->VolumeName, dev_file(dev));
356 Jmsg(jcr, M_ERROR, 0, _("I canot write on Volume \"%s\" because:\n"
357 "The number of files mismatch! Volume=%u Catalog=%u\n"),
358 dcr->VolumeName, dev_file(dev), dev->VolCatInfo.VolCatFiles);
359 mark_volume_in_error(dcr);
363 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
364 Dmsg1(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
365 if (!dir_update_volume_info(dcr, false)) {
368 /* Return an empty block */
369 empty_block(block); /* we used it for reading so set for write */
371 dev->state |= ST_APPEND;
372 Dmsg0(100, "set APPEND, normal return from read_dev_for_append\n");
379 * Mark volume in error in catalog
381 void mark_volume_in_error(DCR *dcr)
383 DEVICE *dev = dcr->dev;
384 Jmsg(dcr->jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
386 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
387 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
388 dir_update_volume_info(dcr, false);
392 * If we are reading, we come here at the end of the tape
393 * and see if there are more volumes to be mounted.
395 bool mount_next_read_volume(DCR *dcr)
397 DEVICE *dev = dcr->dev;
399 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
401 * End Of Tape -- mount next Volume (if another specified)
403 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
405 dev->state &= ~ST_READ;
406 if (!acquire_device_for_read(jcr, dev)) {
407 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev_name(dev),
411 return true; /* next volume mounted */
413 Dmsg0(90, "End of Device reached.\n");
418 * Either because we are going to hang a new volume, or because
419 * of explicit user request, we release the current volume.
421 void release_volume(DCR *dcr)
424 DEVICE *dev = dcr->dev;
426 Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
427 Dmsg0(190, "Hey!!!!! WroteVol non-zero !!!!!\n");
430 * First erase all memory of the current volume
432 dev->block_num = dev->file = 0;
433 dev->EndBlock = dev->EndFile = 0;
434 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
435 memset(&dcr->VolCatInfo, 0, sizeof(dcr->VolCatInfo));
436 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
437 /* Force re-read of label */
438 dev->state &= ~(ST_LABEL|ST_READ|ST_APPEND);
439 dev->label_type = B_BACULA_LABEL;
440 dcr->VolumeName[0] = 0;
442 if (dev->is_open() && (!dev->is_tape() || !dev_cap(dev, CAP_ALWAYSOPEN))) {
443 offline_or_rewind_dev(dev);
447 /* If we have not closed the device, then at least rewind the tape */
448 if (dev->is_open()) {
449 offline_or_rewind_dev(dev);
451 Dmsg0(190, "===== release_volume ---");