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(200, "Before dir_find_next_appendable_volume.\n");
84 while (!dir_find_next_appendable_volume(jcr)) {
85 Dmsg0(200, "not dir_find_next\n");
86 if (!dir_ask_sysop_to_create_appendable_volume(jcr, dev)) {
89 Dmsg0(200, "Again dir_find_next_append...\n");
91 if (job_canceled(jcr)) {
94 Dmsg2(100, "After find_next_append. Vol=%s Slot=%d\n",
95 jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
98 * Get next volume and ready it for append
99 * This code ensures that the device is ready for
100 * writing. We start from the assumption that there
101 * may not be a tape mounted.
103 * If the device is a file, we create the output
104 * file. If it is a tape, we check the volume name
105 * and move the tape to the end of data.
107 * It assumes that the device is not already in use!
110 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
112 autochanger = autoload_device(jcr, dev, 1, NULL);
113 Dmsg1(100, "autoload_dev returns %d\n", autochanger);
115 * If we autochanged to correct Volume or (we have not just
116 * released the Volume AND we can automount) we go ahead
117 * and read the label. If there is no tape in the drive,
118 * we will err, recurse and ask the operator the next time.
120 if (autochanger || (!release && dev_is_tape(dev) && dev_cap(dev, CAP_AUTOMOUNT))) {
121 ask = false; /* don't ask SYSOP this time */
123 Dmsg2(100, "Ask=%d autochanger=%d\n", ask, autochanger);
124 release = true; /* release next time if we "recurse" */
126 if (ask && !dir_ask_sysop_to_mount_volume(jcr, dev)) {
127 Dmsg0(100, "Error return ask_sysop ...\n");
128 return 0; /* error return */
130 if (job_canceled(jcr)) {
133 Dmsg1(100, "want vol=%s\n", jcr->VolumeName);
135 if (dev->poll && dev_cap(dev, CAP_CLOSEONPOLL)) {
136 force_close_dev(dev);
139 /* Ensure the device is open */
140 if (!open_device(jcr, dev)) {
145 * Now make sure we have the right tape mounted
149 * If we are writing to a stream device, ASSUME the volume label
152 if (dev_cap(dev, CAP_STREAM)) {
153 vol_label_status = VOL_OK;
154 create_volume_label(dev, jcr->VolumeName, "Default");
155 dev->VolHdr.LabelType = PRE_LABEL;
157 vol_label_status = read_dev_volume_label(jcr, dev, block);
160 Dmsg2(100, "dirVol=%s dirStat=%s\n", jcr->VolumeName,
161 jcr->VolCatInfo.VolCatStatus);
163 * At this point, dev->VolCatInfo has what is in the drive, if anything,
164 * and jcr->VolCatInfo has what the Director wants.
166 switch (vol_label_status) {
168 Dmsg1(100, "Vol OK name=%s\n", jcr->VolumeName);
169 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
170 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
171 break; /* got a Volume */
173 VOLUME_CAT_INFO VolCatInfo;
175 Dmsg1(100, "Vol NAME Error Name=%s\n", jcr->VolumeName);
176 /* If polling and got a previous bad name, ignore it */
177 if (dev->poll && strcmp(dev->BadVolName, dev->VolHdr.VolName) == 0) {
179 Dmsg1(200, "Vol Name error supress due to poll. Name=%s\n",
184 * OK, we got a different volume mounted. First save the
185 * requested Volume info (jcr) structure, then query if
186 * this volume is really OK. If not, put back the desired
187 * volume name and continue.
189 memcpy(&VolCatInfo, &jcr->VolCatInfo, sizeof(VolCatInfo));
190 /* Check if this is a valid Volume in the pool */
191 pm_strcpy(&jcr->VolumeName, dev->VolHdr.VolName);
192 if (!dir_get_volume_info(jcr, GET_VOL_INFO_FOR_WRITE)) {
193 bstrncpy(dev->BadVolName, dev->VolHdr.VolName, sizeof(dev->BadVolName));
194 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
195 " Current Volume \"%s\" not acceptable because:\n"
197 VolCatInfo.VolCatName, dev->VolHdr.VolName,
198 jcr->dir_bsock->msg);
199 /* Restore desired volume name, note device info out of sync */
200 memcpy(&jcr->VolCatInfo, &VolCatInfo, sizeof(jcr->VolCatInfo));
204 Dmsg1(100, "want new name=%s\n", jcr->VolumeName);
205 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
206 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
207 break; /* got a Volume */
209 * At this point, we assume we have a blank tape mounted.
214 * If permitted, we label the device, make sure we can do
215 * it by checking that the VolCatBytes is zero => not labeled,
216 * once the Volume is labeled we don't want to label another
217 * blank tape with the same name. For disk, we go ahead and
218 * label it anyway, because the OS insures that there is only
219 * one Volume with that name.
220 * As noted above, at this point jcr->VolCatInfo has what
221 * the Director wants and dev->VolCatInfo has info on the
222 * previous tape (or nothing).
224 if (dev_cap(dev, CAP_LABEL) && (jcr->VolCatInfo.VolCatBytes == 0 ||
225 (!dev_is_tape(dev) && strcmp(jcr->VolCatInfo.VolCatStatus,
227 Dmsg0(100, "Create volume label\n");
228 if (!write_volume_label_to_dev(jcr, (DEVRES *)dev->device, jcr->VolumeName,
230 Dmsg0(100, "!write_vol_label\n");
233 Dmsg0(100, "dir_update_vol_info. Set Append\n");
234 /* Copy Director's info into the device info */
235 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
236 dir_update_volume_info(jcr, dev, 1); /* indicate tape labeled */
237 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
238 jcr->VolumeName, dev_name(dev));
239 goto read_volume; /* read label we just wrote */
241 /* NOTE! Fall-through wanted. */
244 /* Send error message */
246 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
248 Dmsg1(200, "Msg suppressed by poll: %s\n", jcr->errmsg);
255 * See if we have a fresh tape or a tape with data.
257 * Note, if the LabelType is PRE_LABEL, it was labeled
258 * but never written. If so, rewrite the label but set as
259 * VOL_LABEL. We rewind and return the label (reconstructed)
260 * in the block so that in the case of a new tape, data can
261 * be appended just after the block label. If we are writing
262 * a second volume, the calling routine will write the label
263 * before writing the overflow block.
265 * If the tape is marked as Recycle, we rewrite the label.
267 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
268 Dmsg1(190, "ready_for_append found freshly labeled volume. dev=%x\n", dev);
269 dev->VolHdr.LabelType = VOL_LABEL; /* set Volume label */
270 write_volume_label_to_block(jcr, dev, block);
272 * If we are not dealing with a streaming device,
273 * write the block now to ensure we have write permission.
274 * It is better to find out now rather than later.
276 if (!dev_cap(dev, CAP_STREAM)) {
277 if (!rewind_dev(dev)) {
278 Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device \"%s\". ERR=%s\n"),
279 dev_name(dev), strerror_dev(dev));
282 if (!truncate_dev(dev)) {
283 Jmsg2(jcr, M_WARNING, 0, _("Truncate error on device \"%s\". ERR=%s\n"),
284 dev_name(dev), strerror_dev(dev));
287 /* Attempt write to check write permission */
288 if (!write_block_to_dev(jcr, dev, block)) {
289 Jmsg2(jcr, M_ERROR, 0, _("Unable to write device \"%s\". ERR=%s\n"),
290 dev_name(dev), strerror_dev(dev));
294 * We do not return the label in the block, because if we are
295 * running multiple simultaneous jobs, once we release the lock
296 * some other thread may write his block over the label. So,
297 * we simply write it definitively now.
300 if (!rewind_dev(dev)) {
301 Jmsg2(jcr, M_ERROR, 0, _("Unable to rewind device %s. ERR=%s\n"),
302 dev_name(dev), strerror_dev(dev));
306 /* Recreate a correct volume label and return it in the block */
307 write_volume_label_to_block(jcr, dev, block);
310 /* Set or reset Volume statistics */
311 dev->VolCatInfo.VolCatJobs = 0;
312 dev->VolCatInfo.VolCatFiles = 0;
313 dev->VolCatInfo.VolCatBytes = 1;
314 dev->VolCatInfo.VolCatErrors = 0;
315 dev->VolCatInfo.VolCatBlocks = 0;
316 dev->VolCatInfo.VolCatRBytes = 0;
318 dev->VolCatInfo.VolCatMounts++;
319 dev->VolCatInfo.VolCatRecycles++;
321 dev->VolCatInfo.VolCatMounts = 1;
322 dev->VolCatInfo.VolCatRecycles = 0;
323 dev->VolCatInfo.VolCatWrites = 1;
324 dev->VolCatInfo.VolCatReads = 1;
326 Dmsg0(100, "dir_update_vol_info. Set Append\n");
327 bstrncpy(dev->VolCatInfo.VolCatStatus, "Append", sizeof(dev->VolCatInfo.VolCatStatus));
328 dir_update_volume_info(jcr, dev, 1); /* indicate doing relabel */
330 Jmsg(jcr, M_INFO, 0, _("Recycled volume \"%s\" on device \"%s\", all previous data lost.\n"),
331 jcr->VolumeName, dev_name(dev));
333 Jmsg(jcr, M_INFO, 0, _("Wrote label to prelabeled Volume \"%s\" on device \"%s\"\n"),
334 jcr->VolumeName, dev_name(dev));
337 * End writing real Volume label (from pre-labeled tape), or recycling
343 * OK, at this point, we have a valid Bacula label, but
344 * we need to position to the end of the volume, since we are
345 * just now putting it into append mode.
347 Dmsg0(200, "Device previously written, moving to end of data\n");
348 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
351 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data on device \"%s\". ERR=%s\n"),
352 dev_name(dev), strerror_dev(dev));
353 mark_volume_in_error(jcr, dev);
356 /* *****FIXME**** we should do some checking for files too */
357 if (dev_is_tape(dev)) {
359 * Check if we are positioned on the tape at the same place
360 * that the database says we should be.
362 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
363 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume \"%s\" at file=%d.\n"),
364 jcr->VolumeName, dev_file(dev));
366 Jmsg(jcr, M_ERROR, 0, _("I canot write on Volume \"%s\" because:\n\
367 The number of files mismatch! Volume=%u Catalog=%u\n"),
368 jcr->VolumeName, dev_file(dev), dev->VolCatInfo.VolCatFiles);
369 mark_volume_in_error(jcr, dev);
373 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
374 Dmsg1(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
375 dir_update_volume_info(jcr, dev, 0);
376 /* Return an empty block */
377 empty_block(block); /* we used it for reading so set for write */
379 dev->state |= ST_APPEND;
380 Dmsg0(100, "Normal return from read_dev_for_append\n");
385 * Mark volume in error in catalog
387 void mark_volume_in_error(JCR *jcr, DEVICE *dev)
389 Jmsg(jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
391 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
392 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
393 dir_update_volume_info(jcr, dev, 0);
397 * If we are reading, we come here at the end of the tape
398 * and see if there are more volumes to be mounted.
400 int mount_next_read_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
402 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
404 * End Of Tape -- mount next Volume (if another specified)
406 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
408 dev->state &= ~ST_READ;
409 if (!acquire_device_for_read(jcr, dev, block)) {
410 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev_name(dev),
414 return 1; /* next volume mounted */
416 Dmsg0(90, "End of Device reached.\n");
421 * Either because we are going to hang a new volume, or because
422 * of explicit user request, we release the current volume.
424 void release_volume(JCR *jcr, DEVICE *dev)
427 Jmsg0(jcr, M_ERROR, 0, "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(&jcr->VolCatInfo, 0, sizeof(jcr->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 jcr->VolumeName[0] = 0;
441 if ((dev->state & ST_OPENED) &&
442 (!dev_is_tape(dev) || !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->state & ST_OPENED) {
449 offline_or_rewind_dev(dev);