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 functions */
37 * If release is set, we rewind the current volume,
38 * which we no longer want, and ask the user (console)
39 * to mount the next volume.
41 * Continue trying until we get it, and then ensure
42 * that we can write on it.
44 * This routine returns a 0 only if it is REALLY
45 * impossible to get the requested Volume.
48 int mount_next_write_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, int release)
50 int retry = 0, autochanger;
53 Dmsg0(100, "Enter mount_next_volume()\n");
57 Jmsg(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"),
61 if (job_canceled(jcr)) {
62 Jmsg(jcr, M_FATAL, 0, _("Job canceled.\n"));
66 recycle = ask = false;
68 Dmsg0(100, "mount_next_volume release=1\n");
69 release_volume(jcr, dev);
70 ask = true; /* ask operator to mount tape */
74 * Get Director's idea of what tape we should have mounted.
76 if (!dir_find_next_appendable_volume(jcr) &&
77 !dir_ask_sysop_to_mount_next_volume(jcr, dev)) {
80 Dmsg2(100, "After find_next_append. Vol=%s Slot=%d\n",
81 jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
84 * Get next volume and ready it for append
85 * This code ensures that the device is ready for
86 * writing. We start from the assumption that there
87 * may not be a tape mounted.
89 * If the device is a file, we create the output
90 * file. If it is a tape, we check the volume name
91 * and move the tape to the end of data.
93 * It assumes that the device is not already in use!
97 Dmsg0(100, "Enter ready_dev_for_append\n");
99 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
102 int vol_label_status;
103 autochanger = autoload_device(jcr, dev, 1, NULL);
104 Dmsg1(100, "autoload_dev returns %d\n", autochanger);
107 * If we autochanged to correct Volume or (we have not just
108 * released the Volume AND we can automount) we go ahead
109 * and read the label. If there is no tape in the drive,
110 * we will err, recurse and ask the operator the next time.
112 if (autochanger || (!release && dev_is_tape(dev) && dev_cap(dev, CAP_AUTOMOUNT))) {
113 ask = false; /* don't ask SYSOP this time */
116 release = 1; /* release next time if we "recurse" */
119 if (ask && !dir_ask_sysop_to_mount_next_volume(jcr, dev)) {
120 Dmsg0(100, "Error return ask_sysop ...\n");
121 return 0; /* error return */
123 Dmsg1(100, "want vol=%s\n", jcr->VolumeName);
126 if (!(dev->state & ST_OPENED)) {
128 if (dev_cap(dev, CAP_STREAM)) {
129 mode = OPEN_WRITE_ONLY;
131 mode = OPEN_READ_WRITE;
133 if (open_dev(dev, jcr->VolCatInfo.VolCatName, mode) < 0) {
134 Jmsg2(jcr, M_FATAL, 0, _("Unable to open device %s. ERR=%s\n"),
135 dev_name(dev), strerror_dev(dev));
141 * Now make sure we have the right tape mounted
145 * If we are writing to a stream device, ASSUME the volume label
148 if (dev_cap(dev, CAP_STREAM)) {
149 vol_label_status = VOL_OK;
150 create_volume_label(dev, jcr->VolumeName, "Default");
151 dev->VolHdr.LabelType = PRE_LABEL;
153 vol_label_status = read_dev_volume_label(jcr, dev, block);
155 Dmsg2(100, "dirVol=%s dirStat=%s\n", jcr->VolumeName,
156 jcr->VolCatInfo.VolCatStatus);
158 * At this point, dev->VolCatInfo has what is in the drive, if anything,
159 * and jcr->VolCatInfo has what the Director wants.
161 switch (vol_label_status) {
163 Dmsg1(100, "Vol OK name=%s\n", jcr->VolumeName);
164 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
165 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
166 break; /* got a Volume */
168 VOLUME_CAT_INFO VolCatInfo;
170 Dmsg1(100, "Vol NAME Error Name=%s\n", jcr->VolumeName);
172 * OK, we got a different volume mounted. First save the
173 * requested Volume info (jcr) structure, then query if
174 * this volume is really OK. If not, put back the desired
175 * volume name and continue.
177 memcpy(&VolCatInfo, &jcr->VolCatInfo, sizeof(VolCatInfo));
178 /* Check if this is a valid Volume in the pool */
179 pm_strcpy(&jcr->VolumeName, dev->VolHdr.VolName);
180 if (!dir_get_volume_info(jcr, GET_VOL_INFO_FOR_WRITE)) {
181 Mmsg(&jcr->errmsg, _("Director wanted Volume \"%s\".\n"
182 " Current Volume \"%s\" not acceptable because:\n"
184 VolCatInfo.VolCatName, dev->VolHdr.VolName,
185 jcr->dir_bsock->msg);
186 /* Restore desired volume name, note device info out of sync */
187 memcpy(&jcr->VolCatInfo, &VolCatInfo, sizeof(jcr->VolCatInfo));
190 Dmsg1(100, "want new name=%s\n", jcr->VolumeName);
191 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
192 recycle = strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0;
193 break; /* got a Volume */
195 * At this point, we assume we have a blank tape mounted.
200 * If permitted, we label the device, make sure we can do
201 * it by checking that the VolCatBytes is zero => not labeled.
202 * As noted above, at this point jcr->VolCatInfo has what
203 * the Director wants and dev->VolCatInfo has info on the
204 * previous tape (or nothing).
206 if (dev_cap(dev, CAP_LABEL) && jcr->VolCatInfo.VolCatBytes == 0) {
207 Dmsg0(100, "Create volume label\n");
208 if (!write_volume_label_to_dev(jcr, (DEVRES *)dev->device, jcr->VolumeName,
210 Dmsg0(100, "!write_vol_label\n");
213 Dmsg0(200, "dir_update_vol_info. Set Append\n");
214 /* Copy Director's info into the device info */
215 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(dev->VolCatInfo));
216 dir_update_volume_info(jcr, &dev->VolCatInfo, 1); /* indicate tape labeled */
217 Jmsg(jcr, M_INFO, 0, _("Labeled new Volume \"%s\" on device %s.\n"),
218 jcr->VolumeName, dev_name(dev));
219 goto read_volume; /* read label we just wrote */
221 /* NOTE! Fall-through wanted. */
225 /* Send error message */
226 Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
227 Dmsg0(100, "Default\n");
235 * See if we have a fresh tape or a tape with data.
237 * Note, if the LabelType is PRE_LABEL, it was labeled
238 * but never written. If so, rewrite the label but set as
239 * VOL_LABEL. We rewind and return the label (reconstructed)
240 * in the block so that in the case of a new tape, data can
241 * be appended just after the block label. If we are writing
242 * an second volume, the calling routine will write the label
243 * before writing the overflow block.
245 * If the tape is marked as Recycle, we rewrite the label.
247 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
248 Dmsg1(190, "ready_for_append found freshly labeled volume. dev=%x\n", dev);
249 dev->VolHdr.LabelType = VOL_LABEL; /* set Volume label */
250 write_volume_label_to_block(jcr, dev, block);
252 * If we are not dealing with a streaming device,
253 * write the block now to ensure we have write permission.
254 * It is better to find out now rather than later.
256 if (!dev_cap(dev, CAP_STREAM)) {
257 if (!rewind_dev(dev)) {
258 Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device %s. ERR=%s\n"),
259 dev_name(dev), strerror_dev(dev));
262 if (!truncate_dev(dev)) {
263 Jmsg2(jcr, M_WARNING, 0, _("Truncate error on device %s. ERR=%s\n"),
264 dev_name(dev), strerror_dev(dev));
267 /* Attempt write to check write permission */
268 if (!write_block_to_dev(jcr, dev, block)) {
269 Jmsg2(jcr, M_ERROR, 0, _("Unable to write device %s. ERR=%s\n"),
270 dev_name(dev), strerror_dev(dev));
273 if (!rewind_dev(dev)) {
274 Jmsg2(jcr, M_ERROR, 0, _("Unable to rewind device %s. ERR=%s\n"),
275 dev_name(dev), strerror_dev(dev));
279 /* Recreate a correct volume label and return it in the block */
280 write_volume_label_to_block(jcr, dev, block);
282 /* Set or reset Volume statistics */
283 dev->VolCatInfo.VolCatJobs = 0;
284 dev->VolCatInfo.VolCatFiles = 0;
285 dev->VolCatInfo.VolCatBytes = 1;
286 dev->VolCatInfo.VolCatErrors = 0;
287 dev->VolCatInfo.VolCatBlocks = 0;
288 dev->VolCatInfo.VolCatRBytes = 0;
290 dev->VolCatInfo.VolCatMounts++;
291 dev->VolCatInfo.VolCatRecycles++;
293 dev->VolCatInfo.VolCatMounts = 1;
294 dev->VolCatInfo.VolCatRecycles = 0;
295 dev->VolCatInfo.VolCatWrites = 1;
296 dev->VolCatInfo.VolCatReads = 1;
298 Dmsg0(200, "dir_update_vol_info. Set Append\n");
299 bstrncpy(dev->VolCatInfo.VolCatStatus, "Append", sizeof(dev->VolCatInfo.VolCatStatus));
300 dir_update_volume_info(jcr, &dev->VolCatInfo, 1); /* indicate doing relabel */
302 Jmsg(jcr, M_INFO, 0, _("Recycled volume \"%s\" on device %s, all previous data lost.\n"),
303 jcr->VolumeName, dev_name(dev));
305 Jmsg(jcr, M_INFO, 0, _("Wrote label to prelabeled Volume \"%s\" on device %s\n"),
306 jcr->VolumeName, dev_name(dev));
311 * OK, at this point, we have a valid Bacula label, but
312 * we need to position to the end of the volume, since we are
313 * just now putting it into append mode.
315 Dmsg0(200, "Device previously written, moving to end of data\n");
316 Jmsg(jcr, M_INFO, 0, _("Volume \"%s\" previously written, moving to end of data.\n"),
319 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data %s. ERR=%s\n"),
320 dev_name(dev), strerror_dev(dev));
321 Jmsg(jcr, M_INFO, 0, _("Marking Volume \"%s\" in Error in Catalog.\n"),
323 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
324 Dmsg0(200, "dir_update_vol_info. Set Error.\n");
325 dir_update_volume_info(jcr, &dev->VolCatInfo, 0);
328 /* *****FIXME**** we should do some checking for files too */
329 if (dev_is_tape(dev)) {
331 * Check if we are positioned on the tape at the same place
332 * that the database says we should be.
334 if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
335 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume at file=%d.\n"),
338 Jmsg(jcr, M_ERROR, 0, _("I canot write on this volume because:\n\
339 The number of files mismatch! Volume=%u Catalog=%u\n"),
340 dev_file(dev), dev->VolCatInfo.VolCatFiles);
341 bstrncpy(dev->VolCatInfo.VolCatStatus, "Error", sizeof(dev->VolCatInfo.VolCatStatus));
342 Dmsg0(200, "dir_update_vol_info. Set Error.\n");
343 dir_update_volume_info(jcr, &dev->VolCatInfo, 0);
347 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
348 Dmsg1(200, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
349 dir_update_volume_info(jcr, &dev->VolCatInfo, 0);
350 /* Return an empty block */
351 empty_block(block); /* we used it for reading so set for write */
353 dev->state |= ST_APPEND;
354 Dmsg0(100, "Normal return from read_dev_for_append\n");
359 int mount_next_read_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
361 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
363 * End Of Tape -- mount next Volume (if another specified)
365 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
367 dev->state &= ~ST_READ;
368 if (!acquire_device_for_read(jcr, dev, block)) {
369 Jmsg2(jcr, M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev_name(dev),
373 return 1; /* next volume mounted */
375 Dmsg0(90, "End of Device reached.\n");
380 * Either because we are going to hang a new volume, or because
381 * of explicit user request, we release the current volume.
383 void release_volume(JCR *jcr, DEVICE *dev)
387 Jmsg0(jcr, M_ERROR, 0, "Hey!!!!! WroteVol non-zero !!!!!\n");
390 * First erase all memory of the current volume
392 dev->block_num = dev->file = 0;
393 dev->EndBlock = dev->EndFile = 0;
394 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
395 memset(&jcr->VolCatInfo, 0, sizeof(jcr->VolCatInfo));
396 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
397 dev->state &= ~ST_LABEL; /* label not yet read */
398 jcr->VolumeName[0] = 0;
400 if ((dev->state & ST_OPENED) &&
401 (!dev_is_tape(dev) || !dev_cap(dev, CAP_ALWAYSOPEN))) {
402 offline_or_rewind_dev(dev);
406 /* If we have not closed the device, then at least rewind the tape */
407 if (dev->state & ST_OPENED) {
408 offline_or_rewind_dev(dev);