2 Bacula® - The Network Backup Solution
4 Copyright (C) 2002-2007 Free Software Foundation Europe e.V.
6 The main author of Bacula is Kern Sibbald, with contributions from
7 many others, a complete list can be found in the file AUTHORS.
8 This program is Free Software; you can redistribute it and/or
9 modify it under the terms of version two of the GNU General Public
10 License as published by the Free Software Foundation and included
13 This program is distributed in the hope that it will be useful, but
14 WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with this program; if not, write to the Free Software
20 Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
23 Bacula® is a registered trademark of John Walker.
24 The licensor of Bacula is the Free Software Foundation Europe
25 (FSFE), Fiduciary Program, Sumatrastrasse 25, 8006 Zürich,
26 Switzerland, email:ftf@fsfeurope.org.
30 * Routines for handling the autochanger.
32 * Kern Sibbald, August MMII
37 #include "bacula.h" /* pull in global headers */
38 #include "stored.h" /* pull in Storage Deamon headers */
40 /* Forward referenced functions */
41 static void lock_changer(DCR *dcr);
42 static void unlock_changer(DCR *dcr);
43 static bool unload_other_drive(DCR *dcr, int slot);
45 /* Init all the autochanger resources found */
46 bool init_autochangers()
50 /* Ensure that the media_type for each device is the same */
51 foreach_res(changer, R_AUTOCHANGER) {
53 foreach_alist(device, changer->device) {
55 * If the device does not have a changer name or changer command
56 * defined, used the one from the Autochanger resource
58 if (!device->changer_name && changer->changer_name) {
59 device->changer_name = bstrdup(changer->changer_name);
61 if (!device->changer_command && changer->changer_command) {
62 device->changer_command = bstrdup(changer->changer_command);
64 if (!device->changer_name) {
65 Jmsg(NULL, M_ERROR, 0,
66 _("No Changer Name given for device %s. Cannot continue.\n"),
70 if (!device->changer_command) {
71 Jmsg(NULL, M_ERROR, 0,
72 _("No Changer Command given for device %s. Cannot continue.\n"),
78 if (media_type == NULL) {
79 media_type = device->media_type; /* get Media Type of first device */
82 /* Ensure that other devices Media Types are the same */
83 if (strcmp(media_type, device->media_type) != 0) {
84 Jmsg(NULL, M_ERROR, 0,
85 _("Media Type not the same for all devices in changer %s. Cannot continue.\n"),
98 * Called here to do an autoload using the autochanger, if
99 * configured, and if a Slot has been defined for this Volume.
100 * On success this routine loads the indicated tape, but the
101 * label is not read, so it must be verified.
103 * Note if dir is not NULL, it is the console requesting the
104 * autoload for labeling, so we respond directly to the
107 * Returns: 1 on success
108 * 0 on failure (no changer available)
109 * -1 on error on autochanger
111 int autoload_device(DCR *dcr, int writing, BSOCK *dir)
114 DEVICE *dev = dcr->dev;
116 int drive = dev->drive_index;
117 int rtn_stat = -1; /* error status */
120 if (!dev->is_autochanger()) {
121 Dmsg1(200, "Device %s is not an autochanger\n", dev->print_name());
125 /* An empty ChangerCommand => virtual disk autochanger */
126 if (dcr->device->changer_command && dcr->device->changer_command[0] == 0) {
127 return 1; /* nothing to load */
130 slot = dcr->VolCatInfo.InChanger ? dcr->VolCatInfo.Slot : 0;
132 * Handle autoloaders here. If we cannot autoload it, we
133 * will return 0 so that the sysop will be asked to load it.
135 if (writing && slot <= 0) {
137 return 0; /* For user, bail out right now */
139 if (dir_find_next_appendable_volume(dcr)) {
140 slot = dcr->VolCatInfo.InChanger ? dcr->VolCatInfo.Slot : 0;
145 Dmsg1(400, "Want changer slot=%d\n", slot);
147 changer = get_pool_memory(PM_FNAME);
149 Jmsg(jcr, M_INFO, 0, _("Invalid slot=%d defined in catalog for Volume \"%s\" "
150 "on %s. Manual load my be required.\n"), slot, dcr->VolCatInfo.VolCatName,
153 } else if (!dcr->device->changer_name) {
154 Jmsg(jcr, M_INFO, 0, _("No \"Changer Device\" for %s. Manual load of Volume may be required.\n"),
157 } else if (!dcr->device->changer_command) {
158 Jmsg(jcr, M_INFO, 0, _("No \"Changer Command\" for %s. Manual load of Volume may be requird.\n"),
162 /* Attempt to load the Volume */
164 uint32_t timeout = dcr->device->max_changer_wait;
167 loaded = get_autochanger_loaded_slot(dcr);
169 if (loaded != slot) {
170 POOL_MEM results(PM_MESSAGE);
172 /* Unload anything in our drive */
173 if (!unload_autochanger(dcr, loaded)) {
177 /* Make sure desired slot is unloaded */
178 if (!unload_other_drive(dcr, slot)) {
183 * Load the desired cassette
186 Dmsg1(100, "Doing changer load slot %d\n", slot);
188 _("3304 Issuing autochanger \"load slot %d, drive %d\" command.\n"),
190 dcr->VolCatInfo.Slot = slot; /* slot to be loaded */
191 changer = edit_device_codes(dcr, changer, dcr->device->changer_command, "load");
193 Dmsg1(200, "Run program=%s\n", changer);
194 status = run_program_full_output(changer, timeout, results.c_str());
196 Jmsg(jcr, M_INFO, 0, _("3305 Autochanger \"load slot %d, drive %d\", status is OK.\n"),
198 Dmsg2(100, "load slot %d, drive %d, status is OK.\n", slot, drive);
199 dev->Slot = slot; /* set currently loaded slot */
202 be.set_errno(status);
203 Dmsg3(100, "load slot %d, drive %d, bad stats=%s.\n", slot, drive,
205 Jmsg(jcr, M_FATAL, 0, _("3992 Bad autochanger \"load slot %d, drive %d\": "
206 "ERR=%s.\nResults=%s\n"),
207 slot, drive, be.bstrerror(), results.c_str());
208 rtn_stat = -1; /* hard error */
209 dev->Slot = -1; /* mark unknown */
211 Dmsg2(100, "load slot %d status=%d\n", slot, status);
214 status = 0; /* we got what we want */
215 dev->Slot = slot; /* set currently loaded slot */
217 Dmsg1(100, "After changer, status=%d\n", status);
218 if (status == 0) { /* did we succeed? */
219 rtn_stat = 1; /* tape loaded by changer */
222 free_pool_memory(changer);
226 free_pool_memory(changer);
232 * Returns: -1 if error from changer command
234 * Note, this is safe to do without releasing the drive
235 * since it does not attempt load/unload a slot.
237 int get_autochanger_loaded_slot(DCR *dcr)
240 DEVICE *dev = dcr->dev;
242 uint32_t timeout = dcr->device->max_changer_wait;
243 int drive = dcr->dev->drive_index;
244 POOL_MEM results(PM_MESSAGE);
247 if (!dev->is_autochanger()) {
250 if (!dcr->device->changer_command) {
251 Jmsg(jcr, M_FATAL, 0, _("3992 Missing Changer command.\n"));
257 /* Virtual disk autochanger */
258 if (dcr->device->changer_command[0] == 0) {
262 /* Find out what is loaded, zero means device is unloaded */
263 changer = get_pool_memory(PM_FNAME);
265 Jmsg(jcr, M_INFO, 0, _("3301 Issuing autochanger \"loaded? drive %d\" command.\n"),
267 changer = edit_device_codes(dcr, changer, dcr->device->changer_command, "loaded");
268 *results.c_str() = 0;
269 Dmsg1(100, "Run program=%s\n", changer);
270 status = run_program_full_output(changer, timeout, results.c_str());
271 Dmsg3(100, "run_prog: %s stat=%d result=%s", changer, status, results.c_str());
273 loaded = str_to_int32(results.c_str());
275 Jmsg(jcr, M_INFO, 0, _("3302 Autochanger \"loaded? drive %d\", result is Slot %d.\n"),
279 Jmsg(jcr, M_INFO, 0, _("3302 Autochanger \"loaded? drive %d\", result: nothing loaded.\n"),
281 dev->Slot = -1; /* unknown */
285 be.set_errno(status);
286 Jmsg(jcr, M_INFO, 0, _("3991 Bad autochanger \"loaded? drive %d\" command: "
287 "ERR=%s.\nResults=%s\n"), drive, be.bstrerror(), results.c_str());
288 loaded = -1; /* force unload */
291 free_pool_memory(changer);
295 static void lock_changer(DCR *dcr)
297 AUTOCHANGER *changer_res = dcr->device->changer_res;
299 Dmsg1(200, "Locking changer %s\n", changer_res->hdr.name);
300 P(changer_res->changer_mutex); /* Lock changer script */
304 static void unlock_changer(DCR *dcr)
306 AUTOCHANGER *changer_res = dcr->device->changer_res;
308 Dmsg1(200, "Unlocking changer %s\n", changer_res->hdr.name);
309 V(changer_res->changer_mutex); /* Unlock changer script */
314 * Unload the volume, if any, in this drive
315 * On entry: loaded == 0 -- nothing to do
316 * loaded < 0 -- check if anything to do
317 * loaded > 0 -- load slot == loaded
319 bool unload_autochanger(DCR *dcr, int loaded)
321 DEVICE *dev = dcr->dev;
324 uint32_t timeout = dcr->device->max_changer_wait;
331 if (!dev->is_autochanger() || !dcr->device->changer_name ||
332 !dcr->device->changer_command) {
337 loaded = get_autochanger_loaded_slot(dcr);
341 POOL_MEM results(PM_MESSAGE);
342 POOLMEM *changer = get_pool_memory(PM_FNAME);
345 _("3307 Issuing autochanger \"unload slot %d, drive %d\" command.\n"),
346 loaded, dev->drive_index);
347 slot = dcr->VolCatInfo.Slot;
348 dcr->VolCatInfo.Slot = loaded;
349 changer = edit_device_codes(dcr, changer,
350 dcr->device->changer_command, "unload");
352 Dmsg1(100, "Run program=%s\n", changer);
353 *results.c_str() = 0;
354 int stat = run_program_full_output(changer, timeout, results.c_str());
355 dcr->VolCatInfo.Slot = slot;
359 Jmsg(jcr, M_INFO, 0, _("3995 Bad autochanger \"unload slot %d, drive %d\": "
360 "ERR=%s\nResults=%s\n"),
361 loaded, dev->drive_index, be.bstrerror(), results.c_str());
363 dev->Slot = -1; /* unknown */
365 dev->Slot = 0; /* nothing loaded */
367 free_volume(dev); /* Free any volume associated with this drive */
368 free_pool_memory(changer);
375 * Unload the slot if mounted in a different drive
377 static bool unload_other_drive(DCR *dcr, int slot)
383 uint32_t timeout = dcr->device->max_changer_wait;
385 AUTOCHANGER *changer = dcr->dev->device->changer_res;
388 int retries = 0; /* wait for device retries */
393 if (changer->device->size() == 1) {
397 foreach_alist(device, changer->device) {
398 if (device->dev && device->dev->Slot == slot) {
408 /* The Volume we want is on another device. */
409 if (dev->is_busy()) {
410 Dmsg4(100, "Vol %s for dev=%s in use dev=%s slot=%d\n",
411 dcr->VolumeName, dcr->dev->print_name(),
412 dev->print_name(), slot);
414 for (int i=0; i < 3; i++) {
415 if (dev->is_busy()) {
416 wait_for_device(dcr->jcr, retries);
422 if (dev->is_busy()) {
423 Jmsg(jcr, M_WARNING, 0, _("Volume \"%s\" is in use by device %s\n"),
424 dcr->VolumeName, dev->print_name());
425 Dmsg4(100, "Vol %s for dev=%s is busy dev=%s slot=%d\n",
426 dcr->VolumeName, dcr->dev->print_name(), dev->print_name(), slot);
427 Dmsg2(100, "num_writ=%d reserv=%d\n", dev->num_writers, dev->reserved_device);
432 POOLMEM *changer_cmd = get_pool_memory(PM_FNAME);
433 POOL_MEM results(PM_MESSAGE);
436 _("3307 Issuing autochanger \"unload slot %d, drive %d\" command.\n"),
437 slot, dev->drive_index);
439 Dmsg2(100, "Issuing autochanger \"unload slot %d, drive %d\" command.\n",
440 slot, dev->drive_index);
444 save_slot = dcr->VolCatInfo.Slot;
445 dcr->VolCatInfo.Slot = slot;
446 changer_cmd = edit_device_codes(dcr, changer_cmd,
447 dcr->device->changer_command, "unload");
449 Dmsg2(200, "close dev=%s reserve=%d\n", dev->print_name(),
450 dev->reserved_device);
451 Dmsg1(100, "Run program=%s\n", changer_cmd);
452 int stat = run_program_full_output(changer_cmd, timeout, results.c_str());
453 dcr->VolCatInfo.Slot = save_slot;
458 Jmsg(jcr, M_INFO, 0, _("3995 Bad autochanger \"unload slot %d, drive %d\": ERR=%s.\n"),
459 slot, dev->drive_index, be.bstrerror());
461 Dmsg3(100, "Bad autochanger \"unload slot %d, drive %d\": ERR=%s.\n",
462 slot, dev->drive_index, be.bstrerror());
464 dev->Slot = -1; /* unknown */
466 dev->Slot = 0; /* nothing loaded */
467 Dmsg0(100, "Slot unloaded\n");
469 free_volume(dev); /* Free any volume associated with this drive */
472 free_pool_memory(changer_cmd);
479 * List the Volumes that are in the autoloader possibly
480 * with their barcodes.
481 * We assume that it is always the Console that is calling us.
483 bool autochanger_cmd(DCR *dcr, BSOCK *dir, const char *cmd)
485 DEVICE *dev = dcr->dev;
486 uint32_t timeout = dcr->device->max_changer_wait;
489 int len = sizeof_pool_memory(dir->msg) - 1;
493 if (!dev->is_autochanger() || !dcr->device->changer_name ||
494 !dcr->device->changer_command) {
495 if (strcmp(cmd, "drives") == 0) {
496 dir->fsend("drives=1\n");
498 dir->fsend(_("3993 Device %s not an autochanger device.\n"),
503 if (strcmp(cmd, "drives") == 0) {
504 AUTOCHANGER *changer_res = dcr->device->changer_res;
507 drives = changer_res->device->size();
509 dir->fsend("drives=%d\n", drives);
510 Dmsg1(100, "drives=%d\n", drives);
514 changer = get_pool_memory(PM_FNAME);
516 /* Now issue the command */
517 changer = edit_device_codes(dcr, changer,
518 dcr->device->changer_command, cmd);
519 dir->fsend(_("3306 Issuing autochanger \"%s\" command.\n"), cmd);
520 bpipe = open_bpipe(changer, timeout, "r");
522 dir->fsend(_("3996 Open bpipe failed.\n"));
525 if (strcmp(cmd, "list") == 0) {
526 /* Get output from changer */
527 while (fgets(dir->msg, len, bpipe->rfd)) {
528 dir->msglen = strlen(dir->msg);
529 Dmsg1(100, "<stored: %s\n", dir->msg);
532 } else if (strcmp(cmd, "slots") == 0 ) {
534 /* For slots command, read a single line */
536 fgets(buf, sizeof(buf)-1, bpipe->rfd);
537 buf[sizeof(buf)-1] = 0;
538 /* Strip any leading space in front of # of slots */
539 for (p=buf; B_ISSPACE(*p); p++)
541 dir->fsend("slots=%s", p);
542 Dmsg1(100, "<stored: %s", dir->msg);
545 stat = close_bpipe(bpipe);
549 dir->fsend(_("Autochanger error: ERR=%s\n"), be.bstrerror());
551 bnet_sig(dir, BNET_EOD);
556 free_pool_memory(changer);
562 * Edit codes into ChangerCommand
564 * %a = archive device name
565 * %c = changer device name
566 * %d = changer drive index
575 * omsg = edited output message
576 * imsg = input string containing edit codes (%x)
577 * cmd = command string (load, unload, ...)
580 char *edit_device_codes(DCR *dcr, char *omsg, const char *imsg, const char *cmd)
587 Dmsg1(1800, "edit_device_codes: %s\n", imsg);
588 for (p=imsg; *p; p++) {
595 str = dcr->dev->archive_name();
598 str = NPRT(dcr->device->changer_name);
601 sprintf(add, "%d", dcr->dev->drive_index);
608 sprintf(add, "%d", dcr->VolCatInfo.Slot - 1);
612 sprintf(add, "%d", dcr->VolCatInfo.Slot);
615 case 'j': /* Job name */
619 str = NPRT(dcr->VolumeName);
622 str = NPRT(dcr->jcr->client_name);
637 Dmsg1(1900, "add_str %s\n", str);
638 pm_strcat(&omsg, (char *)str);
639 Dmsg1(1800, "omsg=%s\n", omsg);
641 Dmsg1(800, "omsg=%s\n", omsg);