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++ > 8) {
63 Jmsg(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"),
67 if (job_canceled(jcr)) {
68 Jmsg(jcr, M_FATAL, 0, _("Job %d canceled.\n"), jcr->JobId);
71 autochanger = false; /* Assume no autochanger */
74 Dmsg0(100, "mount_next_volume release=1\n");
75 release_volume(jcr, dev);
76 ask = true; /* ask operator to mount tape */
80 * Get Director's idea of what tape we should have mounted.
83 Dmsg0(100, "Before dir_find_next\n");
84 while (!dir_find_next_appendable_volume(jcr)) {
85 Dmsg0(100, "not dir_find_next\n");
86 if (!dir_ask_sysop_to_create_appendable_volume(jcr, dev)) {
90 if (job_canceled(jcr)) {
93 Dmsg2(100, "After find_next_append. Vol=%s Slot=%d\n",
94 jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
97 * Get next volume and ready it for append
98 * This code ensures that the device is ready for
99 * writing. We start from the assumption that there
100 * may not be a tape mounted.
102 * If the device is a file, we create the output
103 * file. If it is a tape, we check the volume name
104 * and move the tape to the end of data.
106 * It assumes that the device is not already in use!
109 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
111 autochanger = autoload_device(jcr, dev, 1, NULL);
112 Dmsg1(100, "autoload_dev returns %d\n", autochanger);
114 * If we autochanged to correct Volume or (we have not just
115 * released the Volume AND we can automount) we go ahead
116 * and read the label. If there is no tape in the drive,
117 * we will err, recurse and ask the operator the next time.
119 if (autochanger || (!release && dev_is_tape(dev) && dev_cap(dev, CAP_AUTOMOUNT))) {
120 ask = false; /* don't ask SYSOP this time */
122 Dmsg2(100, "Ask=%d autochanger=%d\n", ask, autochanger);
123 release = true; /* release next time if we "recurse" */
125 if (ask && !dir_ask_sysop_to_mount_volume(jcr, dev)) {
126 Dmsg0(100, "Error return ask_sysop ...\n");
127 return 0; /* error return */
129 if (job_canceled(jcr)) {
132 Dmsg1(100, "want vol=%s\n", jcr->VolumeName);
135 if (!(dev_state(dev, ST_OPENED))) {
137 if (dev_cap(dev, CAP_STREAM)) {
138 mode = OPEN_WRITE_ONLY;
140 mode = OPEN_READ_WRITE;
142 if (open_dev(dev, jcr->VolCatInfo.VolCatName, mode) < 0) {
143 Jmsg2(jcr, M_FATAL, 0, _("Unable to open device %s. ERR=%s\n"),
144 dev_name(dev), strerror_dev(dev));
150 * Now make sure we have the right tape mounted
154 * If we are writing to a stream device, ASSUME the volume label
157 if (dev_cap(dev, CAP_STREAM)) {
158 vol_label_status = VOL_OK;
159 create_volume_label(dev, jcr->VolumeName, "Default");
160 dev->VolHdr.LabelType = PRE_LABEL;
162 vol_label_status = read_dev_volume_label(jcr, dev, block);
165 Dmsg2(100, "dirVol=%s dirStat=%s\n", jcr->VolumeName,
166 jcr->VolCatInfo.VolCatStatus);
168 * At this point, dev->VolCatInfo has what is in the drive, if anything,
169 * and jcr->VolCatInfo has what the Director wants.
171 switch (vol_label_status) {
173 Dmsg1(100, "Vol OK name=%s\n", jcr->VolumeName);
174 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
175 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
176 break; /* got a Volume */
178 VOLUME_CAT_INFO VolCatInfo;
180 Dmsg1(100, "Vol NAME Error Name=%s\n", jcr->VolumeName);
181 /* If polling and got a previous bad name, ignore it */
182 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolName) == 0) {
184 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n",
189 * OK, we got a different volume mounted. First save the
190 * requested Volume info (jcr) structure, then query if
191 * this volume is really OK. If not, put back the desired
192 * volume name and continue.
194 memcpy(&VolCatInfo, &jcr->VolCatInfo, sizeof(VolCatInfo));
195 /* Check if this is a valid Volume in the pool */
196 pm_strcpy(&jcr->VolumeName, dev->VolHdr.VolName);
197 if (!dir_get_volume_info(jcr, GET_VOL_INFO_FOR_WRITE)) {
198 bstrncpy(dev->BadVolName, dev->VolHdr.VolName, sizeof(dev->BadVolName));
199 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
200 " Current Volume \"%s\" not acceptable because:\n"
202 VolCatInfo.VolCatName, dev->VolHdr.VolName,
203 jcr->dir_bsock->msg);
204 /* Restore desired volume name, note device info out of sync */
205 memcpy(&jcr->VolCatInfo, &VolCatInfo, sizeof(jcr->VolCatInfo));
209 Dmsg1(100, "want new name=%s\n", jcr->VolumeName);
210 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
211 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
212 break; /* got a Volume */
214 * At this point, we assume we have a blank tape mounted.
219 * If permitted, we label the device, make sure we can do
220 * it by checking that the VolCatBytes is zero => not labeled,
221 * once the Volume is labeled we don't want to label another
222 * blank tape with the same name. For disk, we go ahead and
223 * label it anyway, because the OS insures that there is only
224 * one Volume with that name.
225 * As noted above, at this point jcr->VolCatInfo has what
226 * the Director wants and dev->VolCatInfo has info on the
227 * previous tape (or nothing).
229 if (dev_cap(dev, CAP_LABEL) && (jcr->VolCatInfo.VolCatBytes == 0 ||
230 (!dev_is_tape(dev) && strcmp(jcr->VolCatInfo.VolCatStatus,
232 Dmsg0(100, "Create volume label\n");
233 if (!write_volume_label_to_dev(jcr, (DEVRES *)dev->device, jcr->VolumeName,
235 Dmsg0(100, "!write_vol_label\n");
238 Dmsg0(100, "dir_update_vol_info. Set Append\n");
239 /* Copy Director's info into the device info */
240 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
241 dir_update_volume_info(jcr, dev, 1); /* indicate tape labeled */
242 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
243 jcr->VolumeName, dev_name(dev));
244 goto read_volume; /* read label we just wrote */
246 /* NOTE! Fall-through wanted. */
249 /* Send error message */
251 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
253 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
260 * See if we have a fresh tape or a tape with data.
262 * Note, if the LabelType is PRE_LABEL, it was labeled
263 * but never written. If so, rewrite the label but set as
264 * VOL_LABEL. We rewind and return the label (reconstructed)
265 * in the block so that in the case of a new tape, data can
266 * be appended just after the block label. If we are writing
267 * a second volume, the calling routine will write the label
268 * before writing the overflow block.
270 * If the tape is marked as Recycle, we rewrite the label.
272 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
273 Dmsg1(190, "ready_for_append found freshly labeled volume. dev=%x\n", dev);
274 dev->VolHdr.LabelType = VOL_LABEL; /* set Volume label */
275 write_volume_label_to_block(jcr, dev, block);
277 * If we are not dealing with a streaming device,
278 * write the block now to ensure we have write permission.
279 * It is better to find out now rather than later.
281 if (!dev_cap(dev, CAP_STREAM)) {
282 if (!rewind_dev(dev)) {
283 Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device \"%s\". ERR=%s\n"),
284 dev_name(dev), strerror_dev(dev));
287 if (!truncate_dev(dev)) {
288 Jmsg2(jcr, M_WARNING, 0, _("Truncate error on device \"%s\". ERR=%s\n"),
289 dev_name(dev), strerror_dev(dev));
292 /* Attempt write to check write permission */
293 if (!write_block_to_dev(jcr, dev, block)) {
294 Jmsg2(jcr, M_ERROR, 0, _("Unable to write device \"%s\". ERR=%s\n"),
295 dev_name(dev), strerror_dev(dev));
299 * We do not return the label in the block, because if we are
300 * running multiple simultaneous jobs, once we release the lock
301 * some other thread may write his block over the label. So,
302 * we simply write it definitively now.
305 if (!rewind_dev(dev)) {
306 Jmsg2(jcr, M_ERROR, 0, _("Unable to rewind device %s. ERR=%s\n"),
307 dev_name(dev), strerror_dev(dev));
311 /* Recreate a correct volume label and return it in the block */
312 write_volume_label_to_block(jcr, dev, block);
315 /* Set or reset Volume statistics */
316 dev->VolCatInfo.VolCatJobs = 0;
317 dev->VolCatInfo.VolCatFiles = 0;
318 dev->VolCatInfo.VolCatBytes = 1;
319 dev->VolCatInfo.VolCatErrors = 0;
320 dev->VolCatInfo.VolCatBlocks = 0;
321 dev->VolCatInfo.VolCatRBytes = 0;
323 dev->VolCatInfo.VolCatMounts++;
324 dev->VolCatInfo.VolCatRecycles++;
326 dev->VolCatInfo.VolCatMounts = 1;
327 dev->VolCatInfo.VolCatRecycles = 0;
328 dev->VolCatInfo.VolCatWrites = 1;
329 dev->VolCatInfo.VolCatReads = 1;
331 Dmsg0(100, "dir_update_vol_info. Set Append\n");
332 bstrncpy(dev->VolCatInfo.VolCatStatus, "Append", sizeof(dev->VolCatInfo.VolCatStatus));
333 dir_update_volume_info(jcr, dev, 1); /* indicate doing relabel */
335 Jmsg(jcr, M_INFO, 0, _("Recycled volume \"%s\" on device \"%s\", all previous data lost.\n"),
336 jcr->VolumeName, dev_name(dev));
338 Jmsg(jcr, M_INFO, 0, _("Wrote label to prelabeled Volume \"%s\" on device \"%s\"\n"),
339 jcr->VolumeName, dev_name(dev));
342 * End writing real Volume label (from pre-labeled tape), or recycling
348 * OK, at this point, we have a valid Bacula label, but
349 * we need to position to the end of the volume, since we are
350 * just now putting it into append mode.
352 Dmsg0(200, "Device previously written, moving to end of data\n");
353 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
356 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device \"%s\". ERR=%s\n"),
357 dev_name(dev), strerror_dev(dev));
358 mark_volume_in_error(jcr, dev);
361 /* *****FIXME**** we should do some checking for files too */
362 if (dev_is_tape(dev)) {
364 * Check if we are positioned on the tape at the same place
365 * that the database says we should be.
367 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
368 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
369 jcr->VolumeName, dev_file(dev));
371 Jmsg(jcr, M_ERROR, 0, _("I canot write on Volume \"%s\" because:\n\
372 The number of files mismatch! Volume=%u Catalog=%u\n"),
373 jcr->VolumeName, dev_file(dev), dev->VolCatInfo.VolCatFiles);
374 mark_volume_in_error(jcr, dev);
378 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
379 Dmsg1(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
380 dir_update_volume_info(jcr, dev, 0);
381 /* Return an empty block */
382 empty_block(block); /* we used it for reading so set for write */
384 dev->state |= ST_APPEND;
385 Dmsg0(100, "Normal return from read_dev_for_append\n");
390 * Mark volume in error in catalog
392 void mark_volume_in_error(JCR *jcr, DEVICE *dev)
394 Jmsg(jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
396 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
397 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
398 dir_update_volume_info(jcr, dev, 0);
402 * If we are reading, we come here at the end of the tape
403 * and see if there are more volumes to be mounted.
405 int mount_next_read_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
407 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
409 * End Of Tape -- mount next Volume (if another specified)
411 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
413 dev->state &= ~ST_READ;
414 if (!acquire_device_for_read(jcr, dev, block)) {
415 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev_name(dev),
419 return 1; /* next volume mounted */
421 Dmsg0(90, "End of Device reached.\n");
426 * Either because we are going to hang a new volume, or because
427 * of explicit user request, we release the current volume.
429 void release_volume(JCR *jcr, DEVICE *dev)
432 Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
435 * First erase all memory of the current volume
437 dev->block_num = dev->file = 0;
438 dev->EndBlock = dev->EndFile = 0;
439 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
440 memset(&jcr->VolCatInfo, 0, sizeof(jcr->VolCatInfo));
441 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
442 /* Force re-read of label */
443 dev->state &= ~(ST_LABEL|ST_READ|ST_APPEND);
444 jcr->VolumeName[0] = 0;
446 if ((dev->state & ST_OPENED) &&
447 (!dev_is_tape(dev) || !dev_cap(dev, CAP_ALWAYSOPEN))) {
448 offline_or_rewind_dev(dev);
452 /* If we have not closed the device, then at least rewind the tape */
453 if (dev->state & ST_OPENED) {
454 offline_or_rewind_dev(dev);