3 * Routines for handling mounting tapes for reading and for
6 * Kern Sibbald, August MMII
11 Copyright (C) 2000, 2001, 2002 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->capabilities & CAP_ALWAYSOPEN)) {
78 if (dev->capabilities & 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->capabilities & 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 autochanger = autoload_device(jcr, dev, 1, NULL);
130 ask = 0; /* if autochange no need to ask sysop */
133 if (ask && !dir_ask_sysop_to_mount_next_volume(jcr, dev)) {
134 Dmsg0(100, "Error return ask_sysop ...\n");
135 return 0; /* error return */
137 Dmsg1(100, "want vol=%s\n", jcr->VolumeName);
140 for ( ; !(dev->state & ST_OPENED); ) {
141 if (open_dev(dev, jcr->VolCatInfo.VolCatName, READ_WRITE) < 0) {
142 if (dev->dev_errno == EAGAIN || dev->dev_errno == EBUSY) {
145 Jmsg2(jcr, M_FATAL, 0, _("Unable to open device %s. ERR=%s\n"),
146 dev_name(dev), strerror_dev(dev));
152 * Now make sure we have the right tape mounted
155 switch (read_dev_volume_label(jcr, dev, block)) {
157 Dmsg1(100, "Vol OK name=%s\n", jcr->VolumeName);
158 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
159 if (strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0) {
164 Dmsg1(100, "Vol NAME Error Name=%s\n", jcr->VolumeName);
166 * OK, we got a different volume mounted. First save the
167 * requested Volume info in the dev structure, then query if
168 * this volume is really OK. If not, put back the desired
169 * volume name and continue.
171 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
172 /* Check if this is a valid Volume in the pool */
173 strcpy(jcr->VolumeName, dev->VolHdr.VolName);
174 if (!dir_get_volume_info(jcr, 1)) {
175 Mmsg(&jcr->errmsg, _("Wanted Volume \"%s\".\n\
176 Actual Volume \"%s\" not acceptable.\n"),
177 dev->VolCatInfo.VolCatName, dev->VolHdr.VolName);
178 /* Restore desired volume name, note device info out of sync */
179 memcpy(&jcr->VolCatInfo, &dev->VolCatInfo, sizeof(jcr->VolCatInfo));
182 Dmsg1(100, "want new name=%s\n", jcr->VolumeName);
183 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
188 Dmsg1(500, "Vol NO_LABEL or IO_ERROR name=%s\n", jcr->VolumeName);
189 /* If permitted, create a label */
190 if (dev->capabilities & CAP_LABEL) {
191 Dmsg0(100, "Create volume label\n");
192 if (!write_volume_label_to_dev(jcr, (DEVRES *)dev->device, jcr->VolumeName,
194 Dmsg0(100, "!write_vol_label\n");
197 Jmsg(jcr, M_INFO, 0, _("Created Volume label %s on device %s.\n"),
198 jcr->VolumeName, dev_name(dev));
199 goto read_volume; /* read label we just wrote */
201 /* NOTE! Fall-through wanted. */
204 /* Send error message */
205 Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
207 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n\
208 Setting slot to zero in catalog.\n"),
209 jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
210 jcr->VolCatInfo.Slot = 0; /* invalidate slot */
211 dir_update_volume_info(jcr, &jcr->VolCatInfo, 1); /* set slot */
213 Dmsg0(100, "Default\n");
220 * See if we have a fresh tape or tape with data.
222 * Note, if the LabelType is PRE_LABEL, it was labeled
223 * but never written. If so, rewrite the label but set as
224 * VOL_LABEL. We rewind and return the label (reconstructed)
225 * in the block so that in the case of a new tape, data can
226 * be appended just after the block label. If we are writing
227 * an second volume, the calling routine will write the label
228 * before writing the overflow block.
230 * If the tape is marked as Recycle, we rewrite the label.
232 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
233 Dmsg1(190, "ready_for_append found freshly labeled volume. dev=%x\n", dev);
234 dev->VolHdr.LabelType = VOL_LABEL; /* set Volume label */
235 write_volume_label_to_block(jcr, dev, block);
237 * Write the block now to ensure we have write permission.
238 * It is better to find out now rather than later.
240 dev->VolCatInfo.VolCatBytes = 0;
241 if (!rewind_dev(dev)) {
242 Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device %s. ERR=%s\n"),
243 dev_name(dev), strerror_dev(dev));
246 if (!truncate_dev(dev)) {
247 Jmsg2(jcr, M_WARNING, 0, _("Truncate error on device %s. ERR=%s\n"),
248 dev_name(dev), strerror_dev(dev));
251 /* Attempt write to check write permission */
252 if (!write_block_to_dev(jcr, dev, block)) {
253 Jmsg2(jcr, M_ERROR, 0, _("Unable to write device %s. ERR=%s\n"),
254 dev_name(dev), strerror_dev(dev));
257 if (!rewind_dev(dev)) {
258 Jmsg2(jcr, M_ERROR, 0, _("Unable to rewind device %s. ERR=%s\n"),
259 dev_name(dev), strerror_dev(dev));
263 /* Recreate a correct volume label and return it in the block */
264 write_volume_label_to_block(jcr, dev, block);
265 /* Set or reset Volume statistics */
266 dev->VolCatInfo.VolCatJobs = 1;
267 dev->VolCatInfo.VolCatFiles = 1;
268 dev->VolCatInfo.VolCatErrors = 0;
269 dev->VolCatInfo.VolCatBlocks = 1;
271 dev->VolCatInfo.VolCatMounts++;
272 dev->VolCatInfo.VolCatRecycles++;
274 dev->VolCatInfo.VolCatMounts = 1;
275 dev->VolCatInfo.VolCatRecycles = 0;
276 dev->VolCatInfo.VolCatWrites = 1;
277 dev->VolCatInfo.VolCatReads = 1;
279 strcpy(dev->VolCatInfo.VolCatStatus, "Append");
280 Dmsg0(100, "dir_update_vol_info. Set Append\n");
281 dir_update_volume_info(jcr, &dev->VolCatInfo, 1); /* indicate doing relabel */
283 Jmsg(jcr, M_INFO, 0, _("Recycled volume %s on device %s, all previous data lost.\n"),
284 jcr->VolumeName, dev_name(dev));
286 Jmsg(jcr, M_INFO, 0, _("Wrote label to prelabeled Volume %s on device %s\n"),
287 jcr->VolumeName, dev_name(dev));
292 * OK, at this point, we have a valid Bacula label, but
293 * we need to position to the end of the volume, since we are
294 * just now putting it into append mode.
296 Dmsg0(200, "Device previously written, moving to end of data\n");
297 Jmsg(jcr, M_INFO, 0, _("Volume %s previously written, moving to end of data.\n"),
300 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data %s. ERR=%s\n"),
301 dev_name(dev), strerror_dev(dev));
302 Jmsg(jcr, M_INFO, 0, _("Marking Volume %s in Error in Catalog.\n"),
304 strcpy(dev->VolCatInfo.VolCatStatus, "Error");
305 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
306 dir_update_volume_info(jcr, &dev->VolCatInfo, 0);
309 /* *****FIXME**** we should do some checking for files too */
310 if (dev_is_tape(dev)) {
312 * Check if we are positioned on the tape at the same place
313 * that the database says we should be.
315 if (dev->VolCatInfo.VolCatFiles == dev_file(dev) + 1) {
316 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume at file=%d.\n"),
319 Jmsg(jcr, M_ERROR, 0, _("I canot write on this volume because:\n\
320 The number of files mismatch! Volume=%d Catalog=%d\n"),
321 dev_file(dev)+1, dev->VolCatInfo.VolCatFiles);
322 strcpy(dev->VolCatInfo.VolCatStatus, "Error");
323 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
324 dir_update_volume_info(jcr, &dev->VolCatInfo, 0);
328 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
329 dir_update_volume_info(jcr, &dev->VolCatInfo, 0);
330 /* Return an empty block */
331 empty_block(block); /* we used it for reading so set for write */
333 dev->state |= ST_APPEND;
334 Dmsg0(100, "Normal return from read_dev_for_append\n");
339 int mount_next_read_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
341 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
343 * End Of Tape -- mount next Volume (if another specified)
345 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
347 dev->state &= ~ST_READ;
348 if (!acquire_device_for_read(jcr, dev, block)) {
349 Emsg2(M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev_name(dev),
353 return 1; /* next volume mounted */
355 Dmsg0(90, "End of Device reached.\n");
360 * Called here to do an autoload using the autochanger, if
361 * configured, and if a Slot has been defined for this Volume.
362 * On success this routine loads the indicated tape, but the
363 * label is not read, so it must be verified.
365 * Note if dir is not NULL, it is the console requesting the
366 * autoload for labeling, so we respond directly to the
369 * Returns: 1 on success
372 int autoload_device(JCR *jcr, DEVICE *dev, int writing, BSOCK *dir)
374 int slot = jcr->VolCatInfo.Slot;
378 * Handle autoloaders here. If we cannot autoload it, we
379 * will return FALSE to ask the sysop.
381 if (writing && dev->capabilities && CAP_AUTOCHANGER && slot <= 0) {
383 return 0; /* For user, bail out right now */
385 if (dir_find_next_appendable_volume(jcr)) {
386 slot = jcr->VolCatInfo.Slot;
389 Dmsg1(100, "Want changer slot=%d\n", slot);
391 if (slot > 0 && jcr->device->changer_name && jcr->device->changer_command) {
392 uint32_t timeout = jcr->device->max_changer_wait;
393 POOLMEM *changer, *results;
396 results = get_pool_memory(PM_MESSAGE);
397 changer = get_pool_memory(PM_FNAME);
399 /* Find out what is loaded, zero means device is unloaded */
400 changer = edit_device_codes(jcr, changer, jcr->device->changer_command,
402 status = run_program(changer, timeout, results);
404 loaded = atoi(results);
406 loaded = -1; /* force unload */
408 Dmsg1(100, "loaded=%s\n", results);
410 /* If bad status or tape we want is not loaded, load it. */
411 if (status != 0 || loaded != slot) {
412 if (dev->capabilities & CAP_OFFLINEUNMOUNT) {
415 /* We are going to load a new tape, so close the device */
416 force_close_dev(dev);
417 if (loaded != 0) { /* must unload drive */
418 Dmsg0(100, "Doing changer unload.\n");
420 bnet_fsend(dir, _("3902 Issuing autochanger \"unload\" command.\n"));
422 Jmsg(jcr, M_INFO, 0, _("Issuing autochanger \"unload\" command.\n"));
424 changer = edit_device_codes(jcr, changer,
425 jcr->device->changer_command, "unload");
426 status = run_program(changer, timeout, NULL);
427 Dmsg1(100, "unload status=%d\n", status);
430 * Load the desired cassette
432 Dmsg1(100, "Doing changer load slot %d\n", slot);
434 bnet_fsend(dir, _("3903 Issuing autochanger \"load slot %d\" command.\n"),
437 Jmsg(jcr, M_INFO, 0, _("Issuing autochanger \"load slot %d\" command.\n"),
440 changer = edit_device_codes(jcr, changer,
441 jcr->device->changer_command, "load");
442 status = run_program(changer, timeout, NULL);
443 Dmsg2(100, "load slot %d status=%d\n", slot, status);
445 free_pool_memory(changer);
446 free_pool_memory(results);
447 Dmsg1(100, "After changer, status=%d\n", status);
448 if (status == 0) { /* did we succeed? */
449 rtn_stat = 1; /* tape loaded by changer */
458 * Edit codes into ChangerCommand
460 * %a = archive device name
461 * %c = changer device name
470 * omsg = edited output message
471 * imsg = input string containing edit codes (%x)
472 * cmd = command string (load, unload, ...)
475 static char *edit_device_codes(JCR *jcr, char *omsg, char *imsg, char *cmd)
482 Dmsg1(200, "edit_device_codes: %s\n", imsg);
483 for (p=imsg; *p; p++) {
490 str = jcr->device->dev->dev_name;
493 str = NPRT(jcr->device->changer_name);
499 sprintf(add, "%d", jcr->VolCatInfo.Slot - 1);
503 sprintf(add, "%d", jcr->VolCatInfo.Slot);
506 case 'j': /* Job name */
510 str = NPRT(jcr->VolumeName);
513 str = NPRT(jcr->client_name);
528 Dmsg1(200, "add_str %s\n", str);
529 pm_strcat(&omsg, (char *)str);
530 Dmsg1(200, "omsg=%s\n", omsg);