2 Bacula® - The Network Backup Solution
4 Copyright (C) 2002-2008 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 * volatile dev = dcr->dev;
116 int drive = dev->drive_index;
117 int rtn_stat = -1; /* error status */
120 if (!dev->is_autochanger()) {
121 Dmsg1(100, "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 Dmsg0(100, "ChangerCommand=0, virtual disk changer\n");
128 return 1; /* nothing to load */
131 slot = dcr->VolCatInfo.InChanger ? dcr->VolCatInfo.Slot : 0;
132 Dmsg3(100, "autoload: slot=%d InChgr=%d Vol=%s\n", dcr->VolCatInfo.Slot,
133 dcr->VolCatInfo.InChanger, dcr->VolCatInfo.VolCatName);
135 * Handle autoloaders here. If we cannot autoload it, we
136 * will return 0 so that the sysop will be asked to load it.
138 if (writing && slot <= 0) {
140 return 0; /* For user, bail out right now */
142 /* ***FIXME*** this really should not be here */
143 if (dir_find_next_appendable_volume(dcr)) {
144 slot = dcr->VolCatInfo.InChanger ? dcr->VolCatInfo.Slot : 0;
149 Dmsg1(400, "Want changer slot=%d\n", slot);
151 changer = get_pool_memory(PM_FNAME);
153 Jmsg(jcr, M_INFO, 0, _("Invalid slot=%d defined in catalog for Volume \"%s\" "
154 "on %s. Manual load may be required.\n"), slot, dcr->VolCatInfo.VolCatName,
157 } else if (!dcr->device->changer_name) {
158 Jmsg(jcr, M_INFO, 0, _("No \"Changer Device\" for %s. Manual load of Volume may be required.\n"),
161 } else if (!dcr->device->changer_command) {
162 Jmsg(jcr, M_INFO, 0, _("No \"Changer Command\" for %s. Manual load of Volume may be requird.\n"),
166 /* Attempt to load the Volume */
168 uint32_t timeout = dcr->device->max_changer_wait;
171 loaded = get_autochanger_loaded_slot(dcr);
173 if (loaded != slot) {
174 POOL_MEM results(PM_MESSAGE);
176 /* Unload anything in our drive */
177 if (!unload_autochanger(dcr, loaded)) {
181 /* Make sure desired slot is unloaded */
182 if (!unload_other_drive(dcr, slot)) {
187 * Load the desired cassette
190 Dmsg2(100, "Doing changer load slot %d %s\n", slot, dev->print_name());
192 _("3304 Issuing autochanger \"load slot %d, drive %d\" command.\n"),
194 dcr->VolCatInfo.Slot = slot; /* slot to be loaded */
195 changer = edit_device_codes(dcr, changer, dcr->device->changer_command, "load");
197 Dmsg1(200, "Run program=%s\n", changer);
198 status = run_program_full_output(changer, timeout, results.addr());
200 Jmsg(jcr, M_INFO, 0, _("3305 Autochanger \"load slot %d, drive %d\", status is OK.\n"),
202 Dmsg2(100, "load slot %d, drive %d, status is OK.\n", slot, drive);
203 dev->Slot = slot; /* set currently loaded slot */
206 be.set_errno(status);
207 Dmsg3(100, "load slot %d, drive %d, bad stats=%s.\n", slot, drive,
209 Jmsg(jcr, M_FATAL, 0, _("3992 Bad autochanger \"load slot %d, drive %d\": "
210 "ERR=%s.\nResults=%s\n"),
211 slot, drive, be.bstrerror(), results.c_str());
212 rtn_stat = -1; /* hard error */
213 dev->Slot = -1; /* mark unknown */
215 Dmsg2(100, "load slot %d status=%d\n", slot, status);
218 status = 0; /* we got what we want */
219 dev->Slot = slot; /* set currently loaded slot */
221 Dmsg1(100, "After changer, status=%d\n", status);
222 if (status == 0) { /* did we succeed? */
223 rtn_stat = 1; /* tape loaded by changer */
226 free_pool_memory(changer);
230 free_pool_memory(changer);
236 * Returns: -1 if error from changer command
238 * Note, this is safe to do without releasing the drive
239 * since it does not attempt load/unload a slot.
241 int get_autochanger_loaded_slot(DCR *dcr)
244 DEVICE *dev = dcr->dev;
246 uint32_t timeout = dcr->device->max_changer_wait;
247 int drive = dcr->dev->drive_index;
248 POOL_MEM results(PM_MESSAGE);
251 if (!dev->is_autochanger()) {
254 if (!dcr->device->changer_command) {
255 // Jmsg(jcr, M_FATAL, 0, _("3992 Missing Changer command.\n"));
261 /* Virtual disk autochanger */
262 if (dcr->device->changer_command[0] == 0) {
266 /* Find out what is loaded, zero means device is unloaded */
267 changer = get_pool_memory(PM_FNAME);
269 Jmsg(jcr, M_INFO, 0, _("3301 Issuing autochanger \"loaded? drive %d\" command.\n"),
271 changer = edit_device_codes(dcr, changer, dcr->device->changer_command, "loaded");
272 Dmsg1(100, "Run program=%s\n", changer);
273 status = run_program_full_output(changer, timeout, results.addr());
274 Dmsg3(100, "run_prog: %s stat=%d result=%s", changer, status, results.c_str());
276 loaded = str_to_int32(results.c_str());
278 Jmsg(jcr, M_INFO, 0, _("3302 Autochanger \"loaded? drive %d\", result is Slot %d.\n"),
282 Jmsg(jcr, M_INFO, 0, _("3302 Autochanger \"loaded? drive %d\", result: nothing loaded.\n"),
284 dev->Slot = -1; /* unknown */
288 be.set_errno(status);
289 Jmsg(jcr, M_INFO, 0, _("3991 Bad autochanger \"loaded? drive %d\" command: "
290 "ERR=%s.\nResults=%s\n"), drive, be.bstrerror(), results.c_str());
291 loaded = -1; /* force unload */
294 free_pool_memory(changer);
298 static void lock_changer(DCR *dcr)
300 AUTOCHANGER *changer_res = dcr->device->changer_res;
302 Dmsg1(200, "Locking changer %s\n", changer_res->hdr.name);
303 P(changer_res->changer_mutex); /* Lock changer script */
307 static void unlock_changer(DCR *dcr)
309 AUTOCHANGER *changer_res = dcr->device->changer_res;
311 Dmsg1(200, "Unlocking changer %s\n", changer_res->hdr.name);
312 V(changer_res->changer_mutex); /* Unlock changer script */
317 * Unload the volume, if any, in this drive
318 * On entry: loaded == 0 -- nothing to do
319 * loaded < 0 -- check if anything to do
320 * loaded > 0 -- load slot == loaded
322 bool unload_autochanger(DCR *dcr, int loaded)
324 DEVICE *dev = dcr->dev;
327 uint32_t timeout = dcr->device->max_changer_wait;
334 if (!dev->is_autochanger() || !dcr->device->changer_name ||
335 !dcr->device->changer_command) {
339 /* Virtual disk autochanger */
340 if (dcr->device->changer_command[0] == 0) {
346 loaded = get_autochanger_loaded_slot(dcr);
350 POOL_MEM results(PM_MESSAGE);
351 POOLMEM *changer = get_pool_memory(PM_FNAME);
354 _("3307 Issuing autochanger \"unload slot %d, drive %d\" command.\n"),
355 loaded, dev->drive_index);
356 slot = dcr->VolCatInfo.Slot;
357 dcr->VolCatInfo.Slot = loaded;
358 changer = edit_device_codes(dcr, changer,
359 dcr->device->changer_command, "unload");
361 Dmsg1(100, "Run program=%s\n", changer);
362 int stat = run_program_full_output(changer, timeout, results.addr());
363 dcr->VolCatInfo.Slot = slot;
367 Jmsg(jcr, M_INFO, 0, _("3995 Bad autochanger \"unload slot %d, drive %d\": "
368 "ERR=%s\nResults=%s\n"),
369 loaded, dev->drive_index, be.bstrerror(), results.c_str());
371 dev->Slot = -1; /* unknown */
373 dev->Slot = 0; /* nothing loaded */
377 free_volume(dev); /* Free any volume associated with this drive */
378 free_pool_memory(changer);
385 * Unload the slot if mounted in a different drive
387 static bool unload_other_drive(DCR *dcr, int slot)
391 AUTOCHANGER *changer = dcr->dev->device->changer_res;
393 int retries = 0; /* wait for device retries */
398 if (changer->device->size() == 1) {
402 foreach_alist(device, changer->device) {
403 if (device->dev && device->dev->Slot == slot) {
413 /* The Volume we want is on another device. */
414 if (dev->is_busy()) {
415 Dmsg4(100, "Vol %s for dev=%s in use dev=%s slot=%d\n",
416 dcr->VolumeName, dcr->dev->print_name(),
417 dev->print_name(), slot);
419 for (int i=0; i < 3; i++) {
420 if (dev->is_busy()) {
421 wait_for_device(dcr->jcr, retries);
426 if (dev->is_busy()) {
427 Jmsg(dcr->jcr, M_WARNING, 0, _("Volume \"%s\" is in use by device %s\n"),
428 dcr->VolumeName, dev->print_name());
429 Dmsg4(100, "Vol %s for dev=%s is busy dev=%s slot=%d\n",
430 dcr->VolumeName, dcr->dev->print_name(), dev->print_name(), dev->Slot);
431 Dmsg2(100, "num_writ=%d reserv=%d\n", dev->num_writers, dev->num_reserved());
434 return unload_dev(dcr, dev);
437 bool unload_dev(DCR *dcr, DEVICE *dev)
441 uint32_t timeout = dcr->device->max_changer_wait;
442 AUTOCHANGER *changer = dcr->dev->device->changer_res;
446 if (!changer || dev->Slot <= 0) {
451 POOLMEM *changer_cmd = get_pool_memory(PM_FNAME);
452 POOL_MEM results(PM_MESSAGE);
455 _("3307 Issuing autochanger \"unload slot %d, drive %d\" command.\n"),
456 dev->Slot, dev->drive_index);
458 Dmsg2(100, "Issuing autochanger \"unload slot %d, drive %d\" command.\n",
459 dev->Slot, dev->drive_index);
463 save_slot = dcr->VolCatInfo.Slot;
464 dcr->VolCatInfo.Slot = dev->Slot;
465 changer_cmd = edit_device_codes(dcr, changer_cmd,
466 dcr->device->changer_command, "unload");
468 Dmsg2(200, "close dev=%s reserve=%d\n", dev->print_name(),
469 dev->num_reserved());
470 Dmsg1(100, "Run program=%s\n", changer_cmd);
471 int stat = run_program_full_output(changer_cmd, timeout, results.addr());
472 dcr->VolCatInfo.Slot = save_slot;
477 Jmsg(jcr, M_INFO, 0, _("3995 Bad autochanger \"unload slot %d, drive %d\": ERR=%s.\n"),
478 dev->Slot, dev->drive_index, be.bstrerror());
480 Dmsg3(100, "Bad autochanger \"unload slot %d, drive %d\": ERR=%s.\n",
481 dev->Slot, dev->drive_index, be.bstrerror());
483 dev->Slot = -1; /* unknown */
485 Dmsg2(100, "Slot %d unloaded %s\n", dev->Slot, dev->print_name());
486 dev->Slot = 0; /* nothing loaded */
493 free_volume(dev); /* Free any volume associated with this drive */
494 free_pool_memory(changer_cmd);
501 * List the Volumes that are in the autoloader possibly
502 * with their barcodes.
503 * We assume that it is always the Console that is calling us.
505 bool autochanger_cmd(DCR *dcr, BSOCK *dir, const char *cmd)
507 DEVICE *dev = dcr->dev;
508 uint32_t timeout = dcr->device->max_changer_wait;
511 int len = sizeof_pool_memory(dir->msg) - 1;
515 if (!dev->is_autochanger() || !dcr->device->changer_name ||
516 !dcr->device->changer_command) {
517 if (strcmp(cmd, "drives") == 0) {
518 dir->fsend("drives=1\n");
520 dir->fsend(_("3993 Device %s not an autochanger device.\n"),
525 if (strcmp(cmd, "drives") == 0) {
526 AUTOCHANGER *changer_res = dcr->device->changer_res;
529 drives = changer_res->device->size();
531 dir->fsend("drives=%d\n", drives);
532 Dmsg1(100, "drives=%d\n", drives);
536 changer = get_pool_memory(PM_FNAME);
538 /* Now issue the command */
539 changer = edit_device_codes(dcr, changer,
540 dcr->device->changer_command, cmd);
541 dir->fsend(_("3306 Issuing autochanger \"%s\" command.\n"), cmd);
542 bpipe = open_bpipe(changer, timeout, "r");
544 dir->fsend(_("3996 Open bpipe failed.\n"));
547 if (strcmp(cmd, "list") == 0) {
548 /* Get output from changer */
549 while (fgets(dir->msg, len, bpipe->rfd)) {
550 dir->msglen = strlen(dir->msg);
551 Dmsg1(100, "<stored: %s\n", dir->msg);
554 } else if (strcmp(cmd, "slots") == 0 ) {
556 /* For slots command, read a single line */
558 fgets(buf, sizeof(buf)-1, bpipe->rfd);
559 buf[sizeof(buf)-1] = 0;
560 /* Strip any leading space in front of # of slots */
561 for (p=buf; B_ISSPACE(*p); p++)
563 dir->fsend("slots=%s", p);
564 Dmsg1(100, "<stored: %s", dir->msg);
567 stat = close_bpipe(bpipe);
571 dir->fsend(_("Autochanger error: ERR=%s\n"), be.bstrerror());
573 bnet_sig(dir, BNET_EOD);
578 free_pool_memory(changer);
584 * Edit codes into ChangerCommand
586 * %a = archive device name
587 * %c = changer device name
588 * %d = changer drive index
597 * omsg = edited output message
598 * imsg = input string containing edit codes (%x)
599 * cmd = command string (load, unload, ...)
602 char *edit_device_codes(DCR *dcr, char *omsg, const char *imsg, const char *cmd)
609 Dmsg1(1800, "edit_device_codes: %s\n", imsg);
610 for (p=imsg; *p; p++) {
617 str = dcr->dev->archive_name();
620 str = NPRT(dcr->device->changer_name);
623 sprintf(add, "%d", dcr->dev->drive_index);
630 sprintf(add, "%d", dcr->VolCatInfo.Slot - 1);
634 sprintf(add, "%d", dcr->VolCatInfo.Slot);
637 case 'j': /* Job name */
641 str = NPRT(dcr->VolumeName);
644 str = NPRT(dcr->jcr->client_name);
659 Dmsg1(1900, "add_str %s\n", str);
660 pm_strcat(&omsg, (char *)str);
661 Dmsg1(1800, "omsg=%s\n", omsg);
663 Dmsg1(800, "omsg=%s\n", omsg);