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 */
34 static char *edit_device_codes(JCR *jcr, char *omsg, char *imsg, char *cmd);
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.
48 int mount_next_write_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, int release)
50 int recycle, ask, retry = 0, autochanger;
52 Dmsg0(100, "Enter mount_next_volume()\n");
56 Jmsg(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"), dev_name(dev));
59 if (job_cancelled(jcr)) {
60 Jmsg(jcr, M_FATAL, 0, _("Job cancelled.\n"));
63 recycle = ask = autochanger = 0;
65 Dmsg0(100, "mount_next_volume release=1\n");
67 * First erase all memory of the current volume
69 dev->block_num = dev->file = 0;
70 dev->EndBlock = dev->EndFile = 0;
71 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
72 memset(&jcr->VolCatInfo, 0, sizeof(jcr->VolCatInfo));
73 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
74 dev->state &= ~ST_LABEL; /* label not yet read */
75 jcr->VolumeName[0] = 0;
77 if (!dev_is_tape(dev) || !dev_cap(dev, CAP_ALWAYSOPEN)) {
78 if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
84 /* If we have not closed the device, then at least rewind the tape */
85 if (dev->state & ST_OPENED) {
86 if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
89 if (!rewind_dev(dev)) {
90 Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device %s. ERR=%s\n"),
91 dev_name(dev), strerror_dev(dev));
94 ask = 1; /* ask operator to mount tape */
98 * Get Director's idea of what tape we should have mounted.
100 if (!dir_find_next_appendable_volume(jcr)) {
101 ask = 1; /* we must ask */
102 Dmsg0(100, "did not find next volume. Must ask.\n");
104 Dmsg2(100, "After find_next_append. Vol=%s Slot=%d\n",
105 jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
106 release = 1; /* release if we "recurse" */
109 * Get next volume and ready it for append
110 * This code ensures that the device is ready for
111 * writing. We start from the assumption that there
112 * may not be a tape mounted.
114 * If the device is a file, we create the output
115 * file. If it is a tape, we check the volume name
116 * and move the tape to the end of data.
118 * It assumes that the device is not already in use!
122 Dmsg0(100, "Enter ready_dev_for_append\n");
124 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
126 jcr->VolFirstFile = jcr->JobFiles; /* first update of Vol FileIndex */
128 int vol_label_status;
129 autochanger = autoload_device(jcr, dev, 1, NULL);
131 ask = 0; /* if autochange no need to ask sysop */
134 if (ask && !dir_ask_sysop_to_mount_next_volume(jcr, dev)) {
135 Dmsg0(100, "Error return ask_sysop ...\n");
136 return 0; /* error return */
138 Dmsg1(100, "want vol=%s\n", jcr->VolumeName);
141 for ( ; !(dev->state & ST_OPENED); ) {
143 if (dev_cap(dev, CAP_STREAM)) {
144 mode = OPEN_WRITE_ONLY;
146 mode = OPEN_READ_WRITE;
148 if (open_dev(dev, jcr->VolCatInfo.VolCatName, mode) < 0) {
149 Jmsg2(jcr, M_FATAL, 0, _("Unable to open device %s. ERR=%s\n"),
150 dev_name(dev), strerror_dev(dev));
156 * Now make sure we have the right tape mounted
160 * If we are writing to a stream device, ASSUME the volume label
163 if (dev_cap(dev, CAP_STREAM)) {
164 vol_label_status = VOL_OK;
165 create_volume_label(dev, jcr->VolumeName);
166 dev->VolHdr.LabelType = PRE_LABEL;
168 vol_label_status = read_dev_volume_label(jcr, dev, block);
170 switch (vol_label_status) {
172 Dmsg1(100, "Vol OK name=%s\n", jcr->VolumeName);
173 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
174 if (strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0) {
179 Dmsg1(100, "Vol NAME Error Name=%s\n", jcr->VolumeName);
181 * OK, we got a different volume mounted. First save the
182 * requested Volume info in the dev structure, then query if
183 * this volume is really OK. If not, put back the desired
184 * volume name and continue.
186 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
187 /* Check if this is a valid Volume in the pool */
188 strcpy(jcr->VolumeName, dev->VolHdr.VolName);
189 if (!dir_get_volume_info(jcr, 1)) {
190 Mmsg(&jcr->errmsg, _("Wanted Volume \"%s\".\n\
191 Actual Volume \"%s\" not acceptable.\n"),
192 dev->VolCatInfo.VolCatName, dev->VolHdr.VolName);
193 /* Restore desired volume name, note device info out of sync */
194 memcpy(&jcr->VolCatInfo, &dev->VolCatInfo, sizeof(jcr->VolCatInfo));
197 Dmsg1(100, "want new name=%s\n", jcr->VolumeName);
198 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
203 Dmsg1(500, "Vol NO_LABEL or IO_ERROR name=%s\n", jcr->VolumeName);
204 /* If permitted, create a label */
205 if (dev_cap(dev, CAP_LABEL)) {
206 Dmsg0(100, "Create volume label\n");
207 if (!write_volume_label_to_dev(jcr, (DEVRES *)dev->device, jcr->VolumeName,
209 Dmsg0(100, "!write_vol_label\n");
212 Jmsg(jcr, M_INFO, 0, _("Created Volume label %s on device %s.\n"),
213 jcr->VolumeName, dev_name(dev));
214 goto read_volume; /* read label we just wrote */
216 /* NOTE! Fall-through wanted. */
219 /* Send error message */
220 Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
222 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n\
223 Setting slot to zero in catalog.\n"),
224 jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
225 jcr->VolCatInfo.Slot = 0; /* invalidate slot */
226 Dmsg0(200, "update vol info in mount\n");
227 dir_update_volume_info(jcr, &jcr->VolCatInfo, 1); /* set slot */
229 Dmsg0(100, "Default\n");
236 * See if we have a fresh tape or tape with data.
238 * Note, if the LabelType is PRE_LABEL, it was labeled
239 * but never written. If so, rewrite the label but set as
240 * VOL_LABEL. We rewind and return the label (reconstructed)
241 * in the block so that in the case of a new tape, data can
242 * be appended just after the block label. If we are writing
243 * an second volume, the calling routine will write the label
244 * before writing the overflow block.
246 * If the tape is marked as Recycle, we rewrite the label.
248 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
249 Dmsg1(190, "ready_for_append found freshly labeled volume. dev=%x\n", dev);
250 dev->VolHdr.LabelType = VOL_LABEL; /* set Volume label */
251 write_volume_label_to_block(jcr, dev, block);
253 * If we are not dealing with a streaming device,
254 * write the block now to ensure we have write permission.
255 * It is better to find out now rather than later.
257 if (!dev_cap(dev, CAP_STREAM)) {
258 dev->VolCatInfo.VolCatBytes = 0;
259 if (!rewind_dev(dev)) {
260 Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device %s. ERR=%s\n"),
261 dev_name(dev), strerror_dev(dev));
264 if (!truncate_dev(dev)) {
265 Jmsg2(jcr, M_WARNING, 0, _("Truncate error on device %s. ERR=%s\n"),
266 dev_name(dev), strerror_dev(dev));
269 /* Attempt write to check write permission */
270 if (!write_block_to_dev(jcr, dev, block)) {
271 Jmsg2(jcr, M_ERROR, 0, _("Unable to write device %s. ERR=%s\n"),
272 dev_name(dev), strerror_dev(dev));
275 if (!rewind_dev(dev)) {
276 Jmsg2(jcr, M_ERROR, 0, _("Unable to rewind device %s. ERR=%s\n"),
277 dev_name(dev), strerror_dev(dev));
281 /* Recreate a correct volume label and return it in the block */
282 write_volume_label_to_block(jcr, dev, block);
284 /* Set or reset Volume statistics */
285 dev->VolCatInfo.VolCatJobs = 0;
286 dev->VolCatInfo.VolCatFiles = 0;
287 dev->VolCatInfo.VolCatErrors = 0;
288 dev->VolCatInfo.VolCatBlocks = 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 strcpy(dev->VolCatInfo.VolCatStatus, "Append");
299 Dmsg0(200, "dir_update_vol_info. Set Append\n");
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 strcpy(dev->VolCatInfo.VolCatStatus, "Error");
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=%d Catalog=%d\n"),
340 dev_file(dev), dev->VolCatInfo.VolCatFiles);
341 strcpy(dev->VolCatInfo.VolCatStatus, "Error");
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 Emsg2(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 * Called here to do an autoload using the autochanger, if
381 * configured, and if a Slot has been defined for this Volume.
382 * On success this routine loads the indicated tape, but the
383 * label is not read, so it must be verified.
385 * Note if dir is not NULL, it is the console requesting the
386 * autoload for labeling, so we respond directly to the
389 * Returns: 1 on success
392 int autoload_device(JCR *jcr, DEVICE *dev, int writing, BSOCK *dir)
394 int slot = jcr->VolCatInfo.Slot;
398 * Handle autoloaders here. If we cannot autoload it, we
399 * will return FALSE to ask the sysop.
401 if (writing && dev_cap(dev, CAP_AUTOCHANGER) && slot <= 0) {
403 return 0; /* For user, bail out right now */
405 if (dir_find_next_appendable_volume(jcr)) {
406 slot = jcr->VolCatInfo.Slot;
409 Dmsg1(100, "Want changer slot=%d\n", slot);
411 if (slot > 0 && jcr->device->changer_name && jcr->device->changer_command) {
412 uint32_t timeout = jcr->device->max_changer_wait;
413 POOLMEM *changer, *results;
416 results = get_pool_memory(PM_MESSAGE);
417 changer = get_pool_memory(PM_FNAME);
419 /* Find out what is loaded, zero means device is unloaded */
420 changer = edit_device_codes(jcr, changer, jcr->device->changer_command,
422 status = run_program(changer, timeout, results);
423 Dmsg3(100, "run_prog: %s stat=%d result=%s\n", changer, status, results);
425 loaded = atoi(results);
427 loaded = -1; /* force unload */
429 Dmsg1(100, "loaded=%s\n", results);
431 /* If bad status or tape we want is not loaded, load it. */
432 if (status != 0 || loaded != slot) {
433 if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
436 /* We are going to load a new tape, so close the device */
437 force_close_dev(dev);
438 if (loaded != 0) { /* must unload drive */
439 Dmsg0(100, "Doing changer unload.\n");
441 bnet_fsend(dir, _("3902 Issuing autochanger \"unload\" command.\n"));
443 Jmsg(jcr, M_INFO, 0, _("Issuing autochanger \"unload\" command.\n"));
445 changer = edit_device_codes(jcr, changer,
446 jcr->device->changer_command, "unload");
447 status = run_program(changer, timeout, NULL);
448 Dmsg1(100, "unload status=%d\n", status);
451 * Load the desired cassette
453 Dmsg1(100, "Doing changer load slot %d\n", slot);
455 bnet_fsend(dir, _("3903 Issuing autochanger \"load slot %d\" command.\n"),
458 Jmsg(jcr, M_INFO, 0, _("Issuing autochanger \"load slot %d\" command.\n"),
461 changer = edit_device_codes(jcr, changer,
462 jcr->device->changer_command, "load");
463 status = run_program(changer, timeout, NULL);
465 Jmsg(jcr, M_INFO, 0, _("Autochanger \"load slot\" status is OK.\n"));
467 Jmsg(jcr, M_INFO, 0, _("Bad autochanger \"load slot\" status = %d.\n"),
470 Dmsg2(100, "load slot %d status=%d\n", slot, status);
472 free_pool_memory(changer);
473 free_pool_memory(results);
474 Dmsg1(100, "After changer, status=%d\n", status);
475 if (status == 0) { /* did we succeed? */
476 rtn_stat = 1; /* tape loaded by changer */
485 * Edit codes into ChangerCommand
487 * %a = archive device name
488 * %c = changer device name
497 * omsg = edited output message
498 * imsg = input string containing edit codes (%x)
499 * cmd = command string (load, unload, ...)
502 static char *edit_device_codes(JCR *jcr, char *omsg, char *imsg, char *cmd)
509 Dmsg1(200, "edit_device_codes: %s\n", imsg);
510 for (p=imsg; *p; p++) {
517 str = jcr->device->dev->dev_name;
520 str = NPRT(jcr->device->changer_name);
526 sprintf(add, "%d", jcr->VolCatInfo.Slot - 1);
530 sprintf(add, "%d", jcr->VolCatInfo.Slot);
533 case 'j': /* Job name */
537 str = NPRT(jcr->VolumeName);
540 str = NPRT(jcr->client_name);
555 Dmsg1(200, "add_str %s\n", str);
556 pm_strcat(&omsg, (char *)str);
557 Dmsg1(200, "omsg=%s\n", omsg);