2 Bacula® - The Network Backup Solution
4 Copyright (C) 2002-2010 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 three of the GNU Affero 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 Affero 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 Kern Sibbald.
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
36 #include "bacula.h" /* pull in global headers */
37 #include "stored.h" /* pull in Storage Deamon headers */
39 /* Forward referenced functions */
40 static void lock_changer(DCR *dcr);
41 static void unlock_changer(DCR *dcr);
42 static bool unload_other_drive(DCR *dcr, int slot);
44 /* Init all the autochanger resources found */
45 bool init_autochangers()
49 /* Ensure that the media_type for each device is the same */
50 foreach_res(changer, R_AUTOCHANGER) {
52 foreach_alist(device, changer->device) {
54 * If the device does not have a changer name or changer command
55 * defined, used the one from the Autochanger resource
57 if (!device->changer_name && changer->changer_name) {
58 device->changer_name = bstrdup(changer->changer_name);
60 if (!device->changer_command && changer->changer_command) {
61 device->changer_command = bstrdup(changer->changer_command);
63 if (!device->changer_name) {
64 Jmsg(NULL, M_ERROR, 0,
65 _("No Changer Name given for device %s. Cannot continue.\n"),
69 if (!device->changer_command) {
70 Jmsg(NULL, M_ERROR, 0,
71 _("No Changer Command given for device %s. Cannot continue.\n"),
77 if (media_type == NULL) {
78 media_type = device->media_type; /* get Media Type of first device */
81 /* Ensure that other devices Media Types are the same */
82 if (strcmp(media_type, device->media_type) != 0) {
83 Jmsg(NULL, M_ERROR, 0,
84 _("Media Type not the same for all devices in changer %s. Cannot continue.\n"),
97 * Called here to do an autoload using the autochanger, if
98 * configured, and if a Slot has been defined for this Volume.
99 * On success this routine loads the indicated tape, but the
100 * label is not read, so it must be verified.
102 * Note if dir is not NULL, it is the console requesting the
103 * autoload for labeling, so we respond directly to the
106 * Returns: 1 on success
107 * 0 on failure (no changer available)
108 * -1 on error on autochanger
110 int autoload_device(DCR *dcr, int writing, BSOCK *dir)
113 DEVICE * volatile dev = dcr->dev;
115 int drive = dev->drive_index;
116 int rtn_stat = -1; /* error status */
119 if (!dev->is_autochanger()) {
120 Dmsg1(100, "Device %s is not an autochanger\n", dev->print_name());
124 /* An empty ChangerCommand => virtual disk autochanger */
125 if (dcr->device->changer_command && dcr->device->changer_command[0] == 0) {
126 Dmsg0(100, "ChangerCommand=0, virtual disk changer\n");
127 return 1; /* nothing to load */
130 slot = dcr->VolCatInfo.InChanger ? dcr->VolCatInfo.Slot : 0;
131 Dmsg3(100, "autoload: slot=%d InChgr=%d Vol=%s\n", dcr->VolCatInfo.Slot,
132 dcr->VolCatInfo.InChanger, dcr->getVolCatName());
134 * Handle autoloaders here. If we cannot autoload it, we
135 * will return 0 so that the sysop will be asked to load it.
137 if (writing && slot <= 0) {
139 return 0; /* For user, bail out right now */
141 /* ***FIXME*** this really should not be here */
142 if (dir_find_next_appendable_volume(dcr)) {
143 slot = dcr->VolCatInfo.InChanger ? dcr->VolCatInfo.Slot : 0;
148 Dmsg1(400, "Want changer slot=%d\n", slot);
150 changer = get_pool_memory(PM_FNAME);
152 /* Suppress info when polling */
154 Jmsg(jcr, M_INFO, 0, _("No slot defined in catalog (slot=%d) for Volume \"%s\" on %s.\n"),
155 slot, dcr->getVolCatName(), dev->print_name());
156 Jmsg(jcr, M_INFO, 0, _("Cartridge change or \"update slots\" may be required.\n"));
159 } else if (!dcr->device->changer_name) {
160 /* Suppress info when polling */
162 Jmsg(jcr, M_INFO, 0, _("No \"Changer Device\" for %s. Manual load of Volume may be required.\n"),
166 } else if (!dcr->device->changer_command) {
167 /* Suppress info when polling */
169 Jmsg(jcr, M_INFO, 0, _("No \"Changer Command\" for %s. Manual load of Volume may be requird.\n"),
174 /* Attempt to load the Volume */
176 uint32_t timeout = dcr->device->max_changer_wait;
179 loaded = get_autochanger_loaded_slot(dcr);
181 if (loaded != slot) {
182 POOL_MEM results(PM_MESSAGE);
184 /* Unload anything in our drive */
185 if (!unload_autochanger(dcr, loaded)) {
189 /* Make sure desired slot is unloaded */
190 if (!unload_other_drive(dcr, slot)) {
195 * Load the desired cassette
198 Dmsg2(100, "Doing changer load slot %d %s\n", slot, dev->print_name());
200 _("3304 Issuing autochanger \"load slot %d, drive %d\" command.\n"),
202 dcr->VolCatInfo.Slot = slot; /* slot to be loaded */
203 changer = edit_device_codes(dcr, changer, dcr->device->changer_command, "load");
205 Dmsg1(200, "Run program=%s\n", changer);
206 status = run_program_full_output(changer, timeout, results.addr());
208 Jmsg(jcr, M_INFO, 0, _("3305 Autochanger \"load slot %d, drive %d\", status is OK.\n"),
210 Dmsg2(100, "load slot %d, drive %d, status is OK.\n", slot, drive);
211 dev->set_slot(slot); /* set currently loaded slot */
214 be.set_errno(status);
215 Dmsg3(100, "load slot %d, drive %d, bad stats=%s.\n", slot, drive,
217 Jmsg(jcr, M_FATAL, 0, _("3992 Bad autochanger \"load slot %d, drive %d\": "
218 "ERR=%s.\nResults=%s\n"),
219 slot, drive, be.bstrerror(), results.c_str());
220 rtn_stat = -1; /* hard error */
221 dev->set_slot(-1); /* mark unknown */
223 Dmsg2(100, "load slot %d status=%d\n", slot, status);
226 status = 0; /* we got what we want */
227 dev->set_slot(slot); /* set currently loaded slot */
229 Dmsg1(100, "After changer, status=%d\n", status);
230 if (status == 0) { /* did we succeed? */
231 rtn_stat = 1; /* tape loaded by changer */
234 free_pool_memory(changer);
238 free_pool_memory(changer);
244 * Returns: -1 if error from changer command
246 * Note, this is safe to do without releasing the drive
247 * since it does not attempt load/unload a slot.
249 int get_autochanger_loaded_slot(DCR *dcr)
252 DEVICE *dev = dcr->dev;
254 uint32_t timeout = dcr->device->max_changer_wait;
255 int drive = dcr->dev->drive_index;
256 POOL_MEM results(PM_MESSAGE);
259 if (!dev->is_autochanger()) {
262 if (!dcr->device->changer_command) {
263 // Jmsg(jcr, M_FATAL, 0, _("3992 Missing Changer command.\n"));
266 if (dev->get_slot() > 0) {
267 return dev->get_slot();
270 /* Virtual disk autochanger */
271 if (dcr->device->changer_command[0] == 0) {
275 /* Find out what is loaded, zero means device is unloaded */
276 changer = get_pool_memory(PM_FNAME);
278 /* Suppress info when polling */
280 Jmsg(jcr, M_INFO, 0, _("3301 Issuing autochanger \"loaded? drive %d\" command.\n"),
283 changer = edit_device_codes(dcr, changer, dcr->device->changer_command, "loaded");
284 Dmsg1(100, "Run program=%s\n", changer);
285 status = run_program_full_output(changer, timeout, results.addr());
286 Dmsg3(100, "run_prog: %s stat=%d result=%s", changer, status, results.c_str());
288 loaded = str_to_int32(results.c_str());
290 /* Suppress info when polling */
292 Jmsg(jcr, M_INFO, 0, _("3302 Autochanger \"loaded? drive %d\", result is Slot %d.\n"),
295 dev->set_slot(loaded);
297 /* Suppress info when polling */
299 Jmsg(jcr, M_INFO, 0, _("3302 Autochanger \"loaded? drive %d\", result: nothing loaded.\n"),
302 dev->clear_slot(); /* unknown */
306 be.set_errno(status);
307 Jmsg(jcr, M_INFO, 0, _("3991 Bad autochanger \"loaded? drive %d\" command: "
308 "ERR=%s.\nResults=%s\n"), drive, be.bstrerror(), results.c_str());
309 loaded = -1; /* force unload */
312 free_pool_memory(changer);
316 static void lock_changer(DCR *dcr)
318 AUTOCHANGER *changer_res = dcr->device->changer_res;
320 Dmsg1(200, "Locking changer %s\n", changer_res->hdr.name);
321 P(changer_res->changer_mutex); /* Lock changer script */
325 static void unlock_changer(DCR *dcr)
327 AUTOCHANGER *changer_res = dcr->device->changer_res;
329 Dmsg1(200, "Unlocking changer %s\n", changer_res->hdr.name);
330 V(changer_res->changer_mutex); /* Unlock changer script */
335 * Unload the volume, if any, in this drive
336 * On entry: loaded == 0 -- nothing to do
337 * loaded < 0 -- check if anything to do
338 * loaded > 0 -- load slot == loaded
340 bool unload_autochanger(DCR *dcr, int loaded)
342 DEVICE *dev = dcr->dev;
345 uint32_t timeout = dcr->device->max_changer_wait;
352 if (!dev->is_autochanger() || !dcr->device->changer_name ||
353 !dcr->device->changer_command) {
357 /* Virtual disk autochanger */
358 if (dcr->device->changer_command[0] == 0) {
364 loaded = get_autochanger_loaded_slot(dcr);
368 POOL_MEM results(PM_MESSAGE);
369 POOLMEM *changer = get_pool_memory(PM_FNAME);
372 _("3307 Issuing autochanger \"unload slot %d, drive %d\" command.\n"),
373 loaded, dev->drive_index);
374 slot = dcr->VolCatInfo.Slot;
375 dcr->VolCatInfo.Slot = loaded;
376 changer = edit_device_codes(dcr, changer,
377 dcr->device->changer_command, "unload");
379 Dmsg1(100, "Run program=%s\n", changer);
380 int stat = run_program_full_output(changer, timeout, results.addr());
381 dcr->VolCatInfo.Slot = slot;
385 Jmsg(jcr, M_INFO, 0, _("3995 Bad autochanger \"unload slot %d, drive %d\": "
386 "ERR=%s\nResults=%s\n"),
387 loaded, dev->drive_index, be.bstrerror(), results.c_str());
389 dev->clear_slot(); /* unknown */
391 dev->set_slot(0); /* nothing loaded */
395 free_volume(dev); /* Free any volume associated with this drive */
396 free_pool_memory(changer);
405 * Unload the slot if mounted in a different drive
407 static bool unload_other_drive(DCR *dcr, int slot)
411 AUTOCHANGER *changer = dcr->dev->device->changer_res;
413 int retries = 0; /* wait for device retries */
418 if (changer->device->size() == 1) {
422 foreach_alist(device, changer->device) {
423 if (device->dev && device->dev->get_slot() == slot) {
433 /* The Volume we want is on another device. */
434 if (dev->is_busy()) {
435 Dmsg4(100, "Vol %s for dev=%s in use dev=%s slot=%d\n",
436 dcr->VolumeName, dcr->dev->print_name(),
437 dev->print_name(), slot);
439 for (int i=0; i < 3; i++) {
440 if (dev->is_busy()) {
441 wait_for_device(dcr->jcr, retries);
446 if (dev->is_busy()) {
447 Jmsg(dcr->jcr, M_WARNING, 0, _("Volume \"%s\" wanted on %s is in use by device %s\n"),
448 dcr->VolumeName, dcr->dev->print_name(), dev->print_name());
449 Dmsg4(100, "Vol %s for dev=%s is busy dev=%s slot=%d\n",
450 dcr->VolumeName, dcr->dev->print_name(), dev->print_name(), dev->get_slot());
451 Dmsg2(100, "num_writ=%d reserv=%d\n", dev->num_writers, dev->num_reserved());
455 return unload_dev(dcr, dev);
459 * Unconditionally unload a specified drive
461 bool unload_dev(DCR *dcr, DEVICE *dev)
465 uint32_t timeout = dcr->device->max_changer_wait;
466 AUTOCHANGER *changer = dcr->dev->device->changer_res;
474 save_dev = dcr->dev; /* save dcr device */
475 dcr->dev = dev; /* temporarily point dcr at other device */
477 if (dev->get_slot() <= 0 && get_autochanger_loaded_slot(dcr) <= 0) {
481 save_slot = dcr->VolCatInfo.Slot;
482 dcr->VolCatInfo.Slot = dev->get_slot();
486 POOLMEM *changer_cmd = get_pool_memory(PM_FNAME);
487 POOL_MEM results(PM_MESSAGE);
490 _("3307 Issuing autochanger \"unload slot %d, drive %d\" command.\n"),
491 dev->get_slot(), dev->drive_index);
493 Dmsg2(100, "Issuing autochanger \"unload slot %d, drive %d\" command.\n",
494 dev->get_slot(), dev->drive_index);
496 changer_cmd = edit_device_codes(dcr, changer_cmd,
497 dcr->device->changer_command, "unload");
499 Dmsg2(200, "close dev=%s reserve=%d\n", dev->print_name(),
500 dev->num_reserved());
501 Dmsg1(100, "Run program=%s\n", changer_cmd);
502 int stat = run_program_full_output(changer_cmd, timeout, results.addr());
503 dcr->VolCatInfo.Slot = save_slot;
508 Jmsg(jcr, M_INFO, 0, _("3995 Bad autochanger \"unload slot %d, drive %d\": ERR=%s.\n"),
509 dev->get_slot(), dev->drive_index, be.bstrerror());
511 Dmsg3(100, "Bad autochanger \"unload slot %d, drive %d\": ERR=%s.\n",
512 dev->get_slot(), dev->drive_index, be.bstrerror());
514 dev->clear_slot(); /* unknown */
516 Dmsg2(100, "Slot %d unloaded %s\n", dev->get_slot(), dev->print_name());
517 dev->set_slot(0); /* nothing loaded */
526 free_volume(dev); /* Free any volume associated with this drive */
527 free_pool_memory(changer_cmd);
534 * List the Volumes that are in the autoloader possibly
535 * with their barcodes.
536 * We assume that it is always the Console that is calling us.
538 bool autochanger_cmd(DCR *dcr, BSOCK *dir, const char *cmd)
540 DEVICE *dev = dcr->dev;
541 uint32_t timeout = dcr->device->max_changer_wait;
544 int len = sizeof_pool_memory(dir->msg) - 1;
548 if (!dev->is_autochanger() || !dcr->device->changer_name ||
549 !dcr->device->changer_command) {
550 if (strcmp(cmd, "drives") == 0) {
551 dir->fsend("drives=1\n");
553 dir->fsend(_("3993 Device %s not an autochanger device.\n"),
558 if (strcmp(cmd, "drives") == 0) {
559 AUTOCHANGER *changer_res = dcr->device->changer_res;
562 drives = changer_res->device->size();
564 dir->fsend("drives=%d\n", drives);
565 Dmsg1(100, "drives=%d\n", drives);
569 changer = get_pool_memory(PM_FNAME);
571 /* Now issue the command */
572 changer = edit_device_codes(dcr, changer,
573 dcr->device->changer_command, cmd);
574 dir->fsend(_("3306 Issuing autochanger \"%s\" command.\n"), cmd);
575 bpipe = open_bpipe(changer, timeout, "r");
577 dir->fsend(_("3996 Open bpipe failed.\n"));
580 if (bstrcmp(cmd, "list") || bstrcmp(cmd, "listall")) {
581 /* Get output from changer */
582 while (fgets(dir->msg, len, bpipe->rfd)) {
583 dir->msglen = strlen(dir->msg);
584 Dmsg1(100, "<stored: %s\n", dir->msg);
587 } else if (strcmp(cmd, "slots") == 0 ) {
589 /* For slots command, read a single line */
591 fgets(buf, sizeof(buf)-1, bpipe->rfd);
592 buf[sizeof(buf)-1] = 0;
593 /* Strip any leading space in front of # of slots */
594 for (p=buf; B_ISSPACE(*p); p++)
596 dir->fsend("slots=%s", p);
597 Dmsg1(100, "<stored: %s", dir->msg);
600 stat = close_bpipe(bpipe);
604 dir->fsend(_("Autochanger error: ERR=%s\n"), be.bstrerror());
606 bnet_sig(dir, BNET_EOD);
611 free_pool_memory(changer);
617 * Edit codes into ChangerCommand
619 * %a = archive device name
620 * %c = changer device name
621 * %d = changer drive index
630 * omsg = edited output message
631 * imsg = input string containing edit codes (%x)
632 * cmd = command string (load, unload, ...)
635 char *edit_device_codes(DCR *dcr, char *omsg, const char *imsg, const char *cmd)
642 Dmsg1(1800, "edit_device_codes: %s\n", imsg);
643 for (p=imsg; *p; p++) {
650 str = dcr->dev->archive_name();
653 str = NPRT(dcr->device->changer_name);
656 sprintf(add, "%d", dcr->dev->drive_index);
663 sprintf(add, "%d", dcr->VolCatInfo.Slot - 1);
667 sprintf(add, "%d", dcr->VolCatInfo.Slot);
670 case 'j': /* Job name */
674 if (dcr->VolCatInfo.VolCatName[0]) {
675 str = dcr->VolCatInfo.VolCatName;
676 } else if (dcr->VolumeName[0]) {
677 str = dcr->VolumeName;
678 } else if (dcr->dev->vol && dcr->dev->vol->vol_name) {
679 str = dcr->dev->vol->vol_name;
681 str = dcr->dev->VolHdr.VolumeName;
685 str = NPRT(dcr->jcr->client_name);
700 Dmsg1(1900, "add_str %s\n", str);
701 pm_strcat(&omsg, (char *)str);
702 Dmsg1(1800, "omsg=%s\n", omsg);
704 Dmsg1(800, "omsg=%s\n", omsg);