3 * Routines for handling the autochanger.
5 * Kern Sibbald, August MMII
10 Copyright (C) 2000-2004 Kern Sibbald and John Walker
12 This program is free software; you can redistribute it and/or
13 modify it under the terms of the GNU General Public License as
14 published by the Free Software Foundation; either version 2 of
15 the License, or (at your option) any later version.
17 This program is distributed in the hope that it will be useful,
18 but WITHOUT ANY WARRANTY; without even the implied warranty of
19 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
20 General Public License for more details.
22 You should have received a copy of the GNU General Public
23 License along with this program; if not, write to the Free
24 Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
29 #include "bacula.h" /* pull in global headers */
30 #include "stored.h" /* pull in Storage Deamon headers */
32 /* Forward referenced functions */
33 char *edit_device_codes(JCR *jcr, char *omsg, const char *imsg, const char *cmd);
34 static int get_autochanger_loaded_slot(JCR *jcr);
38 * Called here to do an autoload using the autochanger, if
39 * configured, and if a Slot has been defined for this Volume.
40 * On success this routine loads the indicated tape, but the
41 * label is not read, so it must be verified.
43 * Note if dir is not NULL, it is the console requesting the
44 * autoload for labeling, so we respond directly to the
47 * Returns: 1 on success
48 * 0 on failure (no changer available)
49 * -1 on error on autochanger
51 int autoload_device(DCR *dcr, int writing, BSOCK *dir)
54 DEVICE *dev = dcr->dev;
55 int slot = jcr->VolCatInfo.Slot;
56 int drive = jcr->device->drive_index;
57 int rtn_stat = -1; /* error status */
60 * Handle autoloaders here. If we cannot autoload it, we
61 * will return FALSE to ask the sysop.
63 if (writing && dev_cap(dev, CAP_AUTOCHANGER) && slot <= 0) {
65 return 0; /* For user, bail out right now */
67 if (dir_find_next_appendable_volume(dcr)) {
68 slot = jcr->VolCatInfo.Slot;
73 Dmsg1(400, "Want changer slot=%d\n", slot);
75 if (slot > 0 && jcr->device->changer_name && jcr->device->changer_command) {
76 uint32_t timeout = jcr->device->max_changer_wait;
80 changer = get_pool_memory(PM_FNAME);
82 loaded = get_autochanger_loaded_slot(jcr);
84 /* If tape we want is not loaded, load it. */
86 offline_or_rewind_dev(dev);
87 /* We are going to load a new tape, so close the device */
89 if (loaded != 0 && loaded != -1) { /* must unload drive */
90 Dmsg0(400, "Doing changer unload.\n");
92 _("3303 Issuing autochanger \"unload slot %d, drive %d\" command.\n"),
94 jcr->VolCatInfo.Slot = loaded; /* slot to be unloaded */
95 changer = edit_device_codes(jcr, changer,
96 jcr->device->changer_command, "unload");
97 status = run_program(changer, timeout, NULL);
98 Dmsg1(400, "unload status=%d\n", status);
101 * Load the desired cassette
103 Dmsg1(400, "Doing changer load slot %d\n", slot);
105 _("3304 Issuing autochanger \"load slot %d, drive %d\" command.\n"),
107 jcr->VolCatInfo.Slot = slot; /* slot to be loaded */
108 changer = edit_device_codes(jcr, changer,
109 jcr->device->changer_command, "load");
110 status = run_program(changer, timeout, NULL);
112 Jmsg(jcr, M_INFO, 0, _("3305 Autochanger \"load slot %d, drive %d\", status is OK.\n"),
115 Jmsg(jcr, M_INFO, 0, _("3992 Bad autochanger \"load slot %d, drive %d\", status=%d.\n"),
116 slot, drive, status);
118 Dmsg2(400, "load slot %d status=%d\n", slot, status);
120 status = 0; /* we got what we want */
122 free_pool_memory(changer);
123 Dmsg1(400, "After changer, status=%d\n", status);
124 if (status == 0) { /* did we succeed? */
125 rtn_stat = 1; /* tape loaded by changer */
128 rtn_stat = 0; /* no changer found */
133 static int get_autochanger_loaded_slot(JCR *jcr)
135 POOLMEM *changer, *results;
137 uint32_t timeout = jcr->device->max_changer_wait;
138 int drive = jcr->device->drive_index;
140 results = get_pool_memory(PM_MESSAGE);
141 changer = get_pool_memory(PM_FNAME);
143 /* Find out what is loaded, zero means device is unloaded */
144 Jmsg(jcr, M_INFO, 0, _("3301 Issuing autochanger \"loaded drive %d\" command.\n"),
146 changer = edit_device_codes(jcr, changer, jcr->device->changer_command,
148 status = run_program(changer, timeout, results);
149 Dmsg3(100, "run_prog: %s stat=%d result=%s\n", changer, status, results);
151 loaded = atoi(results);
153 Jmsg(jcr, M_INFO, 0, _("3302 Autochanger \"loaded drive %d\", result is Slot %d.\n"),
156 Jmsg(jcr, M_INFO, 0, _("3302 Autochanger \"loaded drive %d\", result: nothing loaded.\n"),
160 Jmsg(jcr, M_INFO, 0, _("3991 Bad autochanger \"loaded drive %d\" command, status=%d.\n"),
162 loaded = -1; /* force unload */
164 free_pool_memory(changer);
165 free_pool_memory(results);
170 * The Volume is not in the correct slot, so mark this
171 * Volume as not being in the Changer.
173 void invalid_slot_in_catalog(DCR *dcr)
176 DEVICE *dev = dcr->dev;
177 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
178 " Setting slot to zero in catalog.\n"),
179 jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
180 jcr->VolCatInfo.InChanger = false;
181 dev->VolCatInfo.InChanger = false;
182 Dmsg0(100, "update vol info in mount\n");
183 dir_update_volume_info(dcr, true); /* set new status */
187 * List the Volumes that are in the autoloader possibly
188 * with their barcodes.
189 * We assume that it is always the Console that is calling us.
191 bool autochanger_list(DCR *dcr, BSOCK *dir)
193 DEVICE *dev = dcr->dev;
195 uint32_t timeout = jcr->device->max_changer_wait;
199 int len = sizeof_pool_memory(dir->msg) - 1;
201 if (!dev_cap(dev, CAP_AUTOCHANGER) || !jcr->device->changer_name ||
202 !jcr->device->changer_command) {
203 bnet_fsend(dir, _("3993 Not a autochanger device.\n"));
207 changer = get_pool_memory(PM_FNAME);
208 offline_or_rewind_dev(dev);
209 /* We are going to load a new tape, so close the device */
210 force_close_dev(dev);
212 /* First unload any tape */
213 loaded = get_autochanger_loaded_slot(jcr);
215 bnet_fsend(dir, _("3305 Issuing autochanger \"unload slot %d\" command.\n"), loaded);
216 slot = jcr->VolCatInfo.Slot;
217 jcr->VolCatInfo.Slot = loaded;
218 changer = edit_device_codes(jcr, changer, jcr->device->changer_command, "unload");
219 run_program(changer, timeout, NULL);
220 jcr->VolCatInfo.Slot = slot;
223 /* Now list slots occupied */
224 changer = edit_device_codes(jcr, changer, jcr->device->changer_command, "list");
225 bnet_fsend(dir, _("3306 Issuing autochanger \"list\" command.\n"));
226 bpipe = open_bpipe(changer, timeout, "r");
228 bnet_fsend(dir, _("3993 Open bpipe failed.\n"));
229 free_pool_memory(changer);
232 /* Get output from changer */
233 while (fgets(dir->msg, len, bpipe->rfd)) {
234 dir->msglen = strlen(dir->msg);
237 bnet_sig(dir, BNET_EOD);
240 free_pool_memory(changer);
246 * Edit codes into ChangerCommand
248 * %a = archive device name
249 * %c = changer device name
250 * %d = changer drive index
259 * omsg = edited output message
260 * imsg = input string containing edit codes (%x)
261 * cmd = command string (load, unload, ...)
264 char *edit_device_codes(JCR *jcr, char *omsg, const char *imsg, const char *cmd)
271 Dmsg1(400, "edit_device_codes: %s\n", imsg);
272 for (p=imsg; *p; p++) {
279 str = dev_name(jcr->device->dev);
282 str = NPRT(jcr->device->changer_name);
285 sprintf(add, "%d", jcr->device->dev->drive_index);
292 sprintf(add, "%d", jcr->VolCatInfo.Slot - 1);
296 sprintf(add, "%d", jcr->VolCatInfo.Slot);
299 case 'j': /* Job name */
303 str = NPRT(jcr->VolumeName);
306 str = NPRT(jcr->client_name);
321 Dmsg1(400, "add_str %s\n", str);
322 pm_strcat(&omsg, (char *)str);
323 Dmsg1(400, "omsg=%s\n", omsg);