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
71 dev->LastBlockNumWritten = 0;
72 memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
73 memset(&jcr->VolCatInfo, 0, sizeof(jcr->VolCatInfo));
74 memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
75 dev->state &= ~ST_LABEL; /* label not yet read */
76 jcr->VolumeName[0] = 0;
78 if (!dev_is_tape(dev) || !(dev->capabilities & CAP_ALWAYSOPEN)) {
79 if (dev->capabilities & CAP_OFFLINEUNMOUNT) {
85 /* If we have not closed the device, then at least rewind the tape */
86 if (dev->state & ST_OPENED) {
87 if (dev->capabilities & CAP_OFFLINEUNMOUNT) {
90 if (!rewind_dev(dev)) {
91 Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device %s. ERR=%s\n"),
92 dev_name(dev), strerror_dev(dev));
95 ask = 1; /* ask operator to mount tape */
99 * Get Director's idea of what tape we should have mounted.
101 if (!dir_find_next_appendable_volume(jcr)) {
102 ask = 1; /* we must ask */
103 Dmsg0(100, "did not find next volume. Must ask.\n");
105 Dmsg2(100, "After find_next_append. Vol=%s Slot=%d\n",
106 jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
107 release = 1; /* release if we "recurse" */
110 * Get next volume and ready it for append
111 * This code ensures that the device is ready for
112 * writing. We start from the assumption that there
113 * may not be a tape mounted.
115 * If the device is a file, we create the output
116 * file. If it is a tape, we check the volume name
117 * and move the tape to the end of data.
119 * It assumes that the device is not already in use!
123 Dmsg0(100, "Enter ready_dev_for_append\n");
125 dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
127 jcr->VolFirstFile = jcr->JobFiles; /* first update of Vol FileIndex */
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); ) {
142 if (open_dev(dev, jcr->VolCatInfo.VolCatName, READ_WRITE) < 0) {
143 if (dev->dev_errno == EAGAIN || dev->dev_errno == EBUSY) {
146 Jmsg2(jcr, M_FATAL, 0, _("Unable to open device %s. ERR=%s\n"),
147 dev_name(dev), strerror_dev(dev));
153 * Now make sure we have the right tape mounted
156 switch (read_dev_volume_label(jcr, dev, block)) {
158 Dmsg1(100, "Vol OK name=%s\n", jcr->VolumeName);
159 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
160 if (strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0) {
165 Dmsg1(100, "Vol NAME Error Name=%s\n", jcr->VolumeName);
167 * OK, we got a different volume mounted. First save the
168 * requested Volume info in the dev structure, then query if
169 * this volume is really OK. If not, put back the desired
170 * volume name and continue.
172 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
173 /* Check if this is a valid Volume in the pool */
174 strcpy(jcr->VolumeName, dev->VolHdr.VolName);
175 if (!dir_get_volume_info(jcr, 1)) {
176 Mmsg(&jcr->errmsg, _("Wanted Volume \"%s\".\n\
177 Actual Volume \"%s\" not acceptable.\n"),
178 dev->VolCatInfo.VolCatName, dev->VolHdr.VolName);
179 /* Restore desired volume name, note device info out of sync */
180 memcpy(&jcr->VolCatInfo, &dev->VolCatInfo, sizeof(jcr->VolCatInfo));
183 Dmsg1(100, "want new name=%s\n", jcr->VolumeName);
184 memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
189 Dmsg1(500, "Vol NO_LABEL or IO_ERROR name=%s\n", jcr->VolumeName);
190 /* If permitted, create a label */
191 if (dev->capabilities & CAP_LABEL) {
192 Dmsg0(100, "Create volume label\n");
193 if (!write_volume_label_to_dev(jcr, (DEVRES *)dev->device, jcr->VolumeName,
195 Dmsg0(100, "!write_vol_label\n");
198 Jmsg(jcr, M_INFO, 0, _("Created Volume label %s on device %s.\n"),
199 jcr->VolumeName, dev_name(dev));
200 goto read_volume; /* read label we just wrote */
202 /* NOTE! Fall-through wanted. */
205 /* Send error message */
206 Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
208 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n\
209 Setting slot to zero in catalog.\n"),
210 jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
211 jcr->VolCatInfo.Slot = 0; /* invalidate slot */
212 dir_update_volume_info(jcr, &jcr->VolCatInfo, 1); /* set slot */
214 Dmsg0(100, "Default\n");
221 * See if we have a fresh tape or tape with data.
223 * Note, if the LabelType is PRE_LABEL, it was labeled
224 * but never written. If so, rewrite the label but set as
225 * VOL_LABEL. We rewind and return the label (reconstructed)
226 * in the block so that in the case of a new tape, data can
227 * be appended just after the block label. If we are writing
228 * an second volume, the calling routine will write the label
229 * before writing the overflow block.
231 * If the tape is marked as Recycle, we rewrite the label.
233 if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
234 Dmsg1(190, "ready_for_append found freshly labeled volume. dev=%x\n", dev);
235 dev->VolHdr.LabelType = VOL_LABEL; /* set Volume label */
236 write_volume_label_to_block(jcr, dev, block);
238 * Write the block now to ensure we have write permission.
239 * It is better to find out now rather than later.
241 dev->VolCatInfo.VolCatBytes = 0;
242 if (!rewind_dev(dev)) {
243 Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device %s. ERR=%s\n"),
244 dev_name(dev), strerror_dev(dev));
247 if (!truncate_dev(dev)) {
248 Jmsg2(jcr, M_WARNING, 0, _("Truncate error on device %s. ERR=%s\n"),
249 dev_name(dev), strerror_dev(dev));
252 if (!write_block_to_dev(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));
262 /* Recreate a correct volume label and return it in the block */
263 write_volume_label_to_block(jcr, dev, block);
264 /* Set or reset Volume statistics */
265 dev->VolCatInfo.VolCatJobs = 1;
266 dev->VolCatInfo.VolCatFiles = 1;
267 dev->VolCatInfo.VolCatErrors = 0;
268 dev->VolCatInfo.VolCatBlocks = 1;
270 dev->VolCatInfo.VolCatMounts++;
271 dev->VolCatInfo.VolCatRecycles++;
273 dev->VolCatInfo.VolCatMounts = 1;
274 dev->VolCatInfo.VolCatRecycles = 0;
275 dev->VolCatInfo.VolCatWrites = 1;
276 dev->VolCatInfo.VolCatReads = 1;
278 strcpy(dev->VolCatInfo.VolCatStatus, "Append");
279 Dmsg0(100, "dir_update_vol_info. Set Append\n");
280 dir_update_volume_info(jcr, &dev->VolCatInfo, 1); /* indicate doing relabel */
282 Jmsg(jcr, M_INFO, 0, _("Recycled volume %s on device %s, all previous data lost.\n"),
283 jcr->VolumeName, dev_name(dev));
285 Jmsg(jcr, M_INFO, 0, _("Wrote label to prelabeled Volume %s on device %s\n"),
286 jcr->VolumeName, dev_name(dev));
291 * OK, at this point, we have a valid Bacula label, but
292 * we need to position to the end of the volume, since we are
293 * just now putting it into append mode.
295 Dmsg0(200, "Device previously written, moving to end of data\n");
296 Jmsg(jcr, M_INFO, 0, _("Volume %s previously written, moving to end of data.\n"),
299 Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data %s. ERR=%s\n"),
300 dev_name(dev), strerror_dev(dev));
301 Jmsg(jcr, M_INFO, 0, _("Marking Volume %s in Error in Catalog.\n"),
303 strcpy(dev->VolCatInfo.VolCatStatus, "Error");
304 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
305 dir_update_volume_info(jcr, &dev->VolCatInfo, 0);
308 /* *****FIXME**** we should do some checking for files too */
309 if (dev_is_tape(dev)) {
311 * Check if we are positioned on the tape at the same place
312 * that the database says we should be.
314 if (dev->VolCatInfo.VolCatFiles == dev_file(dev) + 1) {
315 Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume at file=%d.\n"),
318 Jmsg(jcr, M_ERROR, 0, _("I canot write on this volume because:\n\
319 The number of files mismatch! Volume=%d Catalog=%d\n"),
320 dev_file(dev)+1, dev->VolCatInfo.VolCatFiles);
321 strcpy(dev->VolCatInfo.VolCatStatus, "Error");
322 Dmsg0(100, "dir_update_vol_info. Set Error.\n");
323 dir_update_volume_info(jcr, &dev->VolCatInfo, 0);
327 dev->VolCatInfo.VolCatMounts++; /* Update mounts */
328 dir_update_volume_info(jcr, &dev->VolCatInfo, 0);
329 /* Return an empty block */
330 empty_block(block); /* we used it for reading so set for write */
332 dev->state |= ST_APPEND;
333 Dmsg0(100, "Normal return from read_dev_for_append\n");
338 int mount_next_read_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
340 Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
342 * End Of Tape -- mount next Volume (if another specified)
344 if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
346 dev->state &= ~ST_READ;
347 if (!acquire_device_for_read(jcr, dev, block)) {
348 Emsg2(M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev_name(dev),
352 return 1; /* next volume mounted */
354 Dmsg0(90, "End of Device reached.\n");
359 * Called here to do an autoload using the autochanger, if
360 * configured, and if a Slot has been defined for this Volume.
361 * On success this routine loads the indicated tape, but the
362 * label is not read, so it must be verified.
364 * Note if dir is not NULL, it is the console requesting the
365 * autoload for labeling, so we respond directly to the
368 * Returns: 1 on success
371 int autoload_device(JCR *jcr, DEVICE *dev, int writing, BSOCK *dir)
373 int slot = jcr->VolCatInfo.Slot;
377 * Handle autoloaders here. If we cannot autoload it, we
378 * will return FALSE to ask the sysop.
380 if (writing && dev->capabilities && CAP_AUTOCHANGER && slot <= 0) {
382 return 0; /* For user, bail out right now */
384 if (dir_find_next_appendable_volume(jcr)) {
385 slot = jcr->VolCatInfo.Slot;
388 Dmsg1(100, "Want changer slot=%d\n", slot);
390 if (slot > 0 && jcr->device->changer_name && jcr->device->changer_command) {
391 uint32_t timeout = jcr->device->max_changer_wait;
392 POOLMEM *changer, *results;
395 results = get_pool_memory(PM_MESSAGE);
396 changer = get_pool_memory(PM_FNAME);
398 /* Find out what is loaded, zero means device is unloaded */
399 changer = edit_device_codes(jcr, changer, jcr->device->changer_command,
401 status = run_program(changer, timeout, results);
403 loaded = atoi(results);
405 loaded = -1; /* force unload */
407 Dmsg1(100, "loaded=%s\n", results);
409 /* If bad status or tape we want is not loaded, load it. */
410 if (status != 0 || loaded != slot) {
411 if (dev->capabilities & CAP_OFFLINEUNMOUNT) {
414 /* We are going to load a new tape, so close the device */
415 force_close_dev(dev);
416 if (loaded != 0) { /* must unload drive */
417 Dmsg0(100, "Doing changer unload.\n");
419 bnet_fsend(dir, _("3902 Issuing autochanger \"unload\" command.\n"));
421 Jmsg(jcr, M_INFO, 0, _("Issuing autochanger \"unload\" command.\n"));
423 changer = edit_device_codes(jcr, changer,
424 jcr->device->changer_command, "unload");
425 status = run_program(changer, timeout, NULL);
426 Dmsg1(100, "unload status=%d\n", status);
429 * Load the desired cassette
431 Dmsg1(100, "Doing changer load slot %d\n", slot);
433 bnet_fsend(dir, _("3903 Issuing autochanger \"load slot %d\" command.\n"),
436 Jmsg(jcr, M_INFO, 0, _("Issuing autochanger \"load slot %d\" command.\n"),
439 changer = edit_device_codes(jcr, changer,
440 jcr->device->changer_command, "load");
441 status = run_program(changer, timeout, NULL);
442 Dmsg2(100, "load slot %d status=%d\n", slot, status);
444 free_pool_memory(changer);
445 free_pool_memory(results);
446 Dmsg1(100, "After changer, status=%d\n", status);
447 if (status == 0) { /* did we succeed? */
448 rtn_stat = 1; /* tape loaded by changer */
457 * Edit codes into ChangerCommand
459 * %a = archive device name
460 * %c = changer device name
469 * omsg = edited output message
470 * imsg = input string containing edit codes (%x)
471 * cmd = command string (load, unload, ...)
474 static char *edit_device_codes(JCR *jcr, char *omsg, char *imsg, char *cmd)
481 Dmsg1(200, "edit_device_codes: %s\n", imsg);
482 for (p=imsg; *p; p++) {
489 str = jcr->device->dev->dev_name;
492 str = NPRT(jcr->device->changer_name);
498 sprintf(add, "%d", jcr->VolCatInfo.Slot - 1);
502 sprintf(add, "%d", jcr->VolCatInfo.Slot);
505 case 'j': /* Job name */
509 str = NPRT(jcr->VolumeName);
512 str = NPRT(jcr->client_name);
527 Dmsg1(200, "add_str %s\n", str);
528 pm_strcat(&omsg, (char *)str);
529 Dmsg1(200, "omsg=%s\n", omsg);