3 * Routines for handling mounting tapes for reading and for
6 * Kern Sibbald, August MMII
11 Copyright (C) 2000-2003 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 */
33 /* Forward referenced routines */
34 static void mark_volume_in_error(JCR *jcr, DEVICE *dev);
38 * If release is set, we rewind the current volume,
39 * which we no longer want, and ask the user (console)
40 * to mount the next volume.
42 * Continue trying until we get it, and then ensure
43 * that we can write on it.
45 * This routine returns a 0 only if it is REALLY
46 * impossible to get the requested Volume.
49 int mount_next_write_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, int release)
52 bool ask = false, recycle, autochanger;
55 Dmsg0(100, "Enter mount_next_volume()\n");
58 * Attempt to mount the next volume. If something non-fatal goes
59 * wrong, we come back here to re-try (new op messages, re-read
64 Jmsg(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"),
68 if (job_canceled(jcr)) {
69 Jmsg(jcr, M_FATAL, 0, _("Job %d canceled.\n"), jcr->JobId);
72 autochanger = false; /* Assume no autochanger */
75 Dmsg0(100, "mount_next_volume release=1\n");
76 release_volume(jcr, dev);
77 ask = true; /* ask operator to mount tape */
81 * Get Director's idea of what tape we should have mounted.
84 Dmsg0(100, "Before dir_find_next\n");
85 if (!dir_find_next_appendable_volume(jcr)) {
86 Dmsg0(100, "not dir_find_next\n");
87 if (!dir_ask_sysop_to_mount_next_volume(jcr, dev)) {
91 Dmsg2(100, "After find_next_append. Vol=%s Slot=%d\n",
92 jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
95 * Get next volume and ready it for append
96 * This code ensures that the device is ready for
97 * writing. We start from the assumption that there
98 * may not be a tape mounted.
100 * If the device is a file, we create the output
101 * file. If it is a tape, we check the volume name
102 * and move the tape to the end of data.
104 * It assumes that the device is not already in use!
107 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
109 autochanger = autoload_device(jcr, dev, 1, NULL);
110 Dmsg1(100, "autoload_dev returns %d\n", autochanger);
112 * If we autochanged to correct Volume or (we have not just
113 * released the Volume AND we can automount) we go ahead
114 * and read the label. If there is no tape in the drive,
115 * we will err, recurse and ask the operator the next time.
117 if (autochanger || (!release && dev_is_tape(dev) && dev_cap(dev, CAP_AUTOMOUNT))) {
118 ask = false; /* don't ask SYSOP this time */
120 Dmsg2(100, "Ask=%d autochanger=%d\n", ask, autochanger);
121 release = true; /* release next time if we "recurse" */
123 if (ask && !dir_ask_sysop_to_mount_next_volume(jcr, dev)) {
124 Dmsg0(100, "Error return ask_sysop ...\n");
125 return 0; /* error return */
127 Dmsg1(100, "want vol=%s\n", jcr->VolumeName);
130 if (!(dev_state(dev, ST_OPENED))) {
132 if (dev_cap(dev, CAP_STREAM)) {
133 mode = OPEN_WRITE_ONLY;
135 mode = OPEN_READ_WRITE;
137 if (open_dev(dev, jcr->VolCatInfo.VolCatName, mode) < 0) {
138 Jmsg2(jcr, M_FATAL, 0, _("Unable to open device %s. ERR=%s\n"),
139 dev_name(dev), strerror_dev(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);
177 * OK, we got a different volume mounted. First save the
178 * requested Volume info (jcr) structure, then query if
179 * this volume is really OK. If not, put back the desired
180 * volume name and continue.
182 memcpy(&VolCatInfo, &jcr->VolCatInfo, sizeof(VolCatInfo));
183 /* Check if this is a valid Volume in the pool */
184 pm_strcpy(&jcr->VolumeName, dev->VolHdr.VolName);
185 if (!dir_get_volume_info(jcr, GET_VOL_INFO_FOR_WRITE)) {
186 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
187 " Current Volume \"%s\" not acceptable because:\n"
189 VolCatInfo.VolCatName, dev->VolHdr.VolName,
190 jcr->dir_bsock->msg);
191 /* Restore desired volume name, note device info out of sync */
192 memcpy(&jcr->VolCatInfo, &VolCatInfo, sizeof(jcr->VolCatInfo));
196 Dmsg1(100, "want new name=%s\n", jcr->VolumeName);
197 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
198 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
199 break; /* got a Volume */
201 * At this point, we assume we have a blank tape mounted.
206 * If permitted, we label the device, make sure we can do
207 * it by checking that the VolCatBytes is zero => not labeled,
208 * once the Volume is labeled we don't want to label another
209 * blank tape with the same name. For disk, we go ahead and
210 * label it anyway, because the OS insures that there is only
211 * one Volume with that name.
212 * As noted above, at this point jcr->VolCatInfo has what
213 * the Director wants and dev->VolCatInfo has info on the
214 * previous tape (or nothing).
216 if (dev_cap(dev, CAP_LABEL) && (jcr->VolCatInfo.VolCatBytes == 0 ||
217 (!dev_is_tape(dev) && strcmp(jcr->VolCatInfo.VolCatStatus,
219 Dmsg0(100, "Create volume label\n");
220 if (!write_volume_label_to_dev(jcr, (DEVRES *)dev->device, jcr->VolumeName,
222 Dmsg0(100, "!write_vol_label\n");
225 Dmsg0(100, "dir_update_vol_info. Set Append\n");
226 /* Copy Director's info into the device info */
227 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
228 dir_update_volume_info(jcr, dev, 1); /* indicate tape labeled */
229 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
230 jcr->VolumeName, dev_name(dev));
231 goto read_volume; /* read label we just wrote */
233 /* NOTE! Fall-through wanted. */
236 /* Send error message */
237 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
243 * See if we have a fresh tape or a tape with data.
245 * Note, if the LabelType is PRE_LABEL, it was labeled
246 * but never written. If so, rewrite the label but set as
247 * VOL_LABEL. We rewind and return the label (reconstructed)
248 * in the block so that in the case of a new tape, data can
249 * be appended just after the block label. If we are writing
250 * a second volume, the calling routine will write the label
251 * before writing the overflow block.
253 * If the tape is marked as Recycle, we rewrite the label.
255 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
256 Dmsg1(190, "ready_for_append found freshly labeled volume. dev=%x\n", dev);
257 dev->VolHdr.LabelType = VOL_LABEL; /* set Volume label */
258 write_volume_label_to_block(jcr, dev, block);
260 * If we are not dealing with a streaming device,
261 * write the block now to ensure we have write permission.
262 * It is better to find out now rather than later.
264 if (!dev_cap(dev, CAP_STREAM)) {
265 if (!rewind_dev(dev)) {
266 Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device %s. ERR=%s\n"),
267 dev_name(dev), strerror_dev(dev));
270 if (!truncate_dev(dev)) {
271 Jmsg2(jcr, M_WARNING, 0, _("Truncate error on device %s. ERR=%s\n"),
272 dev_name(dev), strerror_dev(dev));
275 /* Attempt write to check write permission */
276 if (!write_block_to_dev(jcr, dev, block)) {
277 Jmsg2(jcr, M_ERROR, 0, _("Unable to write device %s. ERR=%s\n"),
278 dev_name(dev), strerror_dev(dev));
282 * We do not return the label in the block, because if we are
283 * running multiple simultaneous jobs, once we release the lock
284 * some other thread may write his block over the label. So,
285 * we simply write it definitively now.
288 if (!rewind_dev(dev)) {
289 Jmsg2(jcr, M_ERROR, 0, _("Unable to rewind device %s. ERR=%s\n"),
290 dev_name(dev), strerror_dev(dev));
294 /* Recreate a correct volume label and return it in the block */
295 write_volume_label_to_block(jcr, dev, block);
298 /* Set or reset Volume statistics */
299 dev->VolCatInfo.VolCatJobs = 0;
300 dev->VolCatInfo.VolCatFiles = 0;
301 dev->VolCatInfo.VolCatBytes = 1;
302 dev->VolCatInfo.VolCatErrors = 0;
303 dev->VolCatInfo.VolCatBlocks = 0;
304 dev->VolCatInfo.VolCatRBytes = 0;
306 dev->VolCatInfo.VolCatMounts++;
307 dev->VolCatInfo.VolCatRecycles++;
309 dev->VolCatInfo.VolCatMounts = 1;
310 dev->VolCatInfo.VolCatRecycles = 0;
311 dev->VolCatInfo.VolCatWrites = 1;
312 dev->VolCatInfo.VolCatReads = 1;
314 Dmsg0(100, "dir_update_vol_info. Set Append\n");
315 bstrncpy(dev->VolCatInfo.VolCatStatus, "Append", sizeof(dev->VolCatInfo.VolCatStatus));
316 dir_update_volume_info(jcr, dev, 1); /* indicate doing relabel */
318 Jmsg(jcr, M_INFO, 0, _("Recycled volume \"%s\" on device %s, all previous data lost.\n"),
319 jcr->VolumeName, dev_name(dev));
321 Jmsg(jcr, M_INFO, 0, _("Wrote label to prelabeled Volume \"%s\" on device %s\n"),
322 jcr->VolumeName, dev_name(dev));
325 * End writing real Volume label (from pre-labeled tape), or recycling
331 * OK, at this point, we have a valid Bacula label, but
332 * we need to position to the end of the volume, since we are
333 * just now putting it into append mode.
335 Dmsg0(200, "Device previously written, moving to end of data\n");
336 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
339 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data %s. ERR=%s\n"),
340 dev_name(dev), strerror_dev(dev));
341 mark_volume_in_error(jcr, dev);
344 /* *****FIXME**** we should do some checking for files too */
345 if (dev_is_tape(dev)) {
347 * Check if we are positioned on the tape at the same place
348 * that the database says we should be.
350 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
351 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume at file=%d.\n"),
354 Jmsg(jcr, M_ERROR, 0, _("I canot write on this volume because:\n\
355 The number of files mismatch! Volume=%u Catalog=%u\n"),
356 dev_file(dev), dev->VolCatInfo.VolCatFiles);
357 mark_volume_in_error(jcr, dev);
361 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
362 Dmsg1(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
363 dir_update_volume_info(jcr, dev, 0);
364 /* Return an empty block */
365 empty_block(block); /* we used it for reading so set for write */
367 dev->state |= ST_APPEND;
368 Dmsg0(100, "Normal return from read_dev_for_append\n");
372 static void mark_volume_in_error(JCR *jcr, DEVICE *dev)
374 Jmsg(jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
376 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
377 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
378 dir_update_volume_info(jcr, dev, 0);
382 * If we are reading, we come here at the end of the tape
383 * and see if there are more volumes to be mounted.
385 int mount_next_read_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
387 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
389 * End Of Tape -- mount next Volume (if another specified)
391 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
393 dev->state &= ~ST_READ;
394 if (!acquire_device_for_read(jcr, dev, block)) {
395 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev_name(dev),
399 return 1; /* next volume mounted */
401 Dmsg0(90, "End of Device reached.\n");
406 * Either because we are going to hang a new volume, or because
407 * of explicit user request, we release the current volume.
409 void release_volume(JCR *jcr, DEVICE *dev)
412 Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
415 * First erase all memory of the current volume
417 dev->block_num = dev->file = 0;
418 dev->EndBlock = dev->EndFile = 0;
419 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
420 memset(&jcr->VolCatInfo, 0, sizeof(jcr->VolCatInfo));
421 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
422 /* Force re-read of label */
423 dev->state &= ~(ST_LABEL|ST_READ|ST_APPEND);
424 jcr->VolumeName[0] = 0;
426 if ((dev->state & ST_OPENED) &&
427 (!dev_is_tape(dev) || !dev_cap(dev, CAP_ALWAYSOPEN))) {
428 offline_or_rewind_dev(dev);
432 /* If we have not closed the device, then at least rewind the tape */
433 if (dev->state & ST_OPENED) {
434 offline_or_rewind_dev(dev);