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 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_next_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);
136 if (!(dev_state(dev, ST_OPENED))) {
138 if (dev_cap(dev, CAP_STREAM)) {
139 mode = OPEN_WRITE_ONLY;
141 mode = OPEN_READ_WRITE;
143 if (open_dev(dev, jcr->VolCatInfo.VolCatName, mode) < 0) {
144 Jmsg2(jcr, M_FATAL, 0, _("Unable to open device %s. ERR=%s\n"),
145 dev_name(dev), strerror_dev(dev));
151 * Now make sure we have the right tape mounted
155 * If we are writing to a stream device, ASSUME the volume label
158 if (dev_cap(dev, CAP_STREAM)) {
159 vol_label_status = VOL_OK;
160 create_volume_label(dev, jcr->VolumeName, "Default");
161 dev->VolHdr.LabelType = PRE_LABEL;
163 vol_label_status = read_dev_volume_label(jcr, dev, block);
166 Dmsg2(100, "dirVol=%s dirStat=%s\n", jcr->VolumeName,
167 jcr->VolCatInfo.VolCatStatus);
169 * At this point, dev->VolCatInfo has what is in the drive, if anything,
170 * and jcr->VolCatInfo has what the Director wants.
172 switch (vol_label_status) {
174 Dmsg1(100, "Vol OK name=%s\n", jcr->VolumeName);
175 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
176 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
177 break; /* got a Volume */
179 VOLUME_CAT_INFO VolCatInfo;
181 Dmsg1(100, "Vol NAME Error Name=%s\n", jcr->VolumeName);
183 * OK, we got a different volume mounted. First save the
184 * requested Volume info (jcr) structure, then query if
185 * this volume is really OK. If not, put back the desired
186 * volume name and continue.
188 memcpy(&VolCatInfo, &jcr->VolCatInfo, sizeof(VolCatInfo));
189 /* Check if this is a valid Volume in the pool */
190 pm_strcpy(&jcr->VolumeName, dev->VolHdr.VolName);
191 if (!dir_get_volume_info(jcr, GET_VOL_INFO_FOR_WRITE)) {
192 Jmsg(jcr, M_WARNING, 0, _("Director wanted Volume \"%s\".\n"
193 " Current Volume \"%s\" not acceptable because:\n"
195 VolCatInfo.VolCatName, dev->VolHdr.VolName,
196 jcr->dir_bsock->msg);
197 /* Restore desired volume name, note device info out of sync */
198 memcpy(&jcr->VolCatInfo, &VolCatInfo, sizeof(jcr->VolCatInfo));
202 Dmsg1(100, "want new name=%s\n", jcr->VolumeName);
203 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
204 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
205 break; /* got a Volume */
207 * At this point, we assume we have a blank tape mounted.
212 * If permitted, we label the device, make sure we can do
213 * it by checking that the VolCatBytes is zero => not labeled,
214 * once the Volume is labeled we don't want to label another
215 * blank tape with the same name. For disk, we go ahead and
216 * label it anyway, because the OS insures that there is only
217 * one Volume with that name.
218 * As noted above, at this point jcr->VolCatInfo has what
219 * the Director wants and dev->VolCatInfo has info on the
220 * previous tape (or nothing).
222 if (dev_cap(dev, CAP_LABEL) && (jcr->VolCatInfo.VolCatBytes == 0 ||
223 (!dev_is_tape(dev) && strcmp(jcr->VolCatInfo.VolCatStatus,
225 Dmsg0(100, "Create volume label\n");
226 if (!write_volume_label_to_dev(jcr, (DEVRES *)dev->device, jcr->VolumeName,
228 Dmsg0(100, "!write_vol_label\n");
231 Dmsg0(100, "dir_update_vol_info. Set Append\n");
232 /* Copy Director's info into the device info */
233 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
234 dir_update_volume_info(jcr, dev, 1); /* indicate tape labeled */
235 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
236 jcr->VolumeName, dev_name(dev));
237 goto read_volume; /* read label we just wrote */
239 /* NOTE! Fall-through wanted. */
242 /* Send error message */
243 Jmsg(jcr, M_WARNING, 0, "%s", jcr->errmsg);
249 * See if we have a fresh tape or a tape with data.
251 * Note, if the LabelType is PRE_LABEL, it was labeled
252 * but never written. If so, rewrite the label but set as
253 * VOL_LABEL. We rewind and return the label (reconstructed)
254 * in the block so that in the case of a new tape, data can
255 * be appended just after the block label. If we are writing
256 * a second volume, the calling routine will write the label
257 * before writing the overflow block.
259 * If the tape is marked as Recycle, we rewrite the label.
261 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
262 Dmsg1(190, "ready_for_append found freshly labeled volume. dev=%x\n", dev);
263 dev->VolHdr.LabelType = VOL_LABEL; /* set Volume label */
264 write_volume_label_to_block(jcr, dev, block);
266 * If we are not dealing with a streaming device,
267 * write the block now to ensure we have write permission.
268 * It is better to find out now rather than later.
270 if (!dev_cap(dev, CAP_STREAM)) {
271 if (!rewind_dev(dev)) {
272 Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device %s. ERR=%s\n"),
273 dev_name(dev), strerror_dev(dev));
276 if (!truncate_dev(dev)) {
277 Jmsg2(jcr, M_WARNING, 0, _("Truncate error on device %s. ERR=%s\n"),
278 dev_name(dev), strerror_dev(dev));
281 /* Attempt write to check write permission */
282 if (!write_block_to_dev(jcr, dev, block)) {
283 Jmsg2(jcr, M_ERROR, 0, _("Unable to write device %s. ERR=%s\n"),
284 dev_name(dev), strerror_dev(dev));
288 * We do not return the label in the block, because if we are
289 * running multiple simultaneous jobs, once we release the lock
290 * some other thread may write his block over the label. So,
291 * we simply write it definitively now.
294 if (!rewind_dev(dev)) {
295 Jmsg2(jcr, M_ERROR, 0, _("Unable to rewind device %s. ERR=%s\n"),
296 dev_name(dev), strerror_dev(dev));
300 /* Recreate a correct volume label and return it in the block */
301 write_volume_label_to_block(jcr, dev, block);
304 /* Set or reset Volume statistics */
305 dev->VolCatInfo.VolCatJobs = 0;
306 dev->VolCatInfo.VolCatFiles = 0;
307 dev->VolCatInfo.VolCatBytes = 1;
308 dev->VolCatInfo.VolCatErrors = 0;
309 dev->VolCatInfo.VolCatBlocks = 0;
310 dev->VolCatInfo.VolCatRBytes = 0;
312 dev->VolCatInfo.VolCatMounts++;
313 dev->VolCatInfo.VolCatRecycles++;
315 dev->VolCatInfo.VolCatMounts = 1;
316 dev->VolCatInfo.VolCatRecycles = 0;
317 dev->VolCatInfo.VolCatWrites = 1;
318 dev->VolCatInfo.VolCatReads = 1;
320 Dmsg0(100, "dir_update_vol_info. Set Append\n");
321 bstrncpy(dev->VolCatInfo.VolCatStatus, "Append", sizeof(dev->VolCatInfo.VolCatStatus));
322 dir_update_volume_info(jcr, dev, 1); /* indicate doing relabel */
324 Jmsg(jcr, M_INFO, 0, _("Recycled volume \"%s\" on device %s, all previous data lost.\n"),
325 jcr->VolumeName, dev_name(dev));
327 Jmsg(jcr, M_INFO, 0, _("Wrote label to prelabeled Volume \"%s\" on device %s\n"),
328 jcr->VolumeName, dev_name(dev));
331 * End writing real Volume label (from pre-labeled tape), or recycling
337 * OK, at this point, we have a valid Bacula label, but
338 * we need to position to the end of the volume, since we are
339 * just now putting it into append mode.
341 Dmsg0(200, "Device previously written, moving to end of data\n");
342 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
345 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data %s. ERR=%s\n"),
346 dev_name(dev), strerror_dev(dev));
347 mark_volume_in_error(jcr, dev);
350 /* *****FIXME**** we should do some checking for files too */
351 if (dev_is_tape(dev)) {
353 * Check if we are positioned on the tape at the same place
354 * that the database says we should be.
356 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
357 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume at file=%d.\n"),
360 Jmsg(jcr, M_ERROR, 0, _("I canot write on this volume because:\n\
361 The number of files mismatch! Volume=%u Catalog=%u\n"),
362 dev_file(dev), dev->VolCatInfo.VolCatFiles);
363 mark_volume_in_error(jcr, dev);
367 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
368 Dmsg1(100, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
369 dir_update_volume_info(jcr, dev, 0);
370 /* Return an empty block */
371 empty_block(block); /* we used it for reading so set for write */
373 dev->state |= ST_APPEND;
374 Dmsg0(100, "Normal return from read_dev_for_append\n");
378 static void mark_volume_in_error(JCR *jcr, DEVICE *dev)
380 Jmsg(jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
382 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
383 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
384 dir_update_volume_info(jcr, dev, 0);
388 * If we are reading, we come here at the end of the tape
389 * and see if there are more volumes to be mounted.
391 int mount_next_read_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
393 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
395 * End Of Tape -- mount next Volume (if another specified)
397 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
399 dev->state &= ~ST_READ;
400 if (!acquire_device_for_read(jcr, dev, block)) {
401 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev_name(dev),
405 return 1; /* next volume mounted */
407 Dmsg0(90, "End of Device reached.\n");
412 * Either because we are going to hang a new volume, or because
413 * of explicit user request, we release the current volume.
415 void release_volume(JCR *jcr, DEVICE *dev)
418 Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
421 * First erase all memory of the current volume
423 dev->block_num = dev->file = 0;
424 dev->EndBlock = dev->EndFile = 0;
425 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
426 memset(&jcr->VolCatInfo, 0, sizeof(jcr->VolCatInfo));
427 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
428 /* Force re-read of label */
429 dev->state &= ~(ST_LABEL|ST_READ|ST_APPEND);
430 jcr->VolumeName[0] = 0;
432 if ((dev->state & ST_OPENED) &&
433 (!dev_is_tape(dev) || !dev_cap(dev, CAP_ALWAYSOPEN))) {
434 offline_or_rewind_dev(dev);
438 /* If we have not closed the device, then at least rewind the tape */
439 if (dev->state & ST_OPENED) {
440 offline_or_rewind_dev(dev);