3 * Routines for handling the autochanger.
5 * Kern Sibbald, August MMII
10 Copyright (C) 2000-2003 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(JCR *jcr, DEVICE *dev, int writing, BSOCK *dir)
53 int slot = jcr->VolCatInfo.Slot;
54 int drive = jcr->device->drive_index;
55 int rtn_stat = -1; /* error status */
58 * Handle autoloaders here. If we cannot autoload it, we
59 * will return FALSE to ask the sysop.
61 if (writing && dev_cap(dev, CAP_AUTOCHANGER) && slot <= 0) {
63 return 0; /* For user, bail out right now */
65 if (dir_find_next_appendable_volume(jcr)) {
66 slot = jcr->VolCatInfo.Slot;
71 Dmsg1(400, "Want changer slot=%d\n", slot);
73 if (slot > 0 && jcr->device->changer_name && jcr->device->changer_command) {
74 uint32_t timeout = jcr->device->max_changer_wait;
78 changer = get_pool_memory(PM_FNAME);
80 loaded = get_autochanger_loaded_slot(jcr);
82 /* If tape we want is not loaded, load it. */
84 offline_or_rewind_dev(dev);
85 /* We are going to load a new tape, so close the device */
87 if (loaded != 0 && loaded != -1) { /* must unload drive */
88 Dmsg0(400, "Doing changer unload.\n");
90 _("3303 Issuing autochanger \"unload slot %d, drive %d\" command.\n"),
92 jcr->VolCatInfo.Slot = loaded; /* slot to be unloaded */
93 changer = edit_device_codes(jcr, changer,
94 jcr->device->changer_command, "unload");
95 status = run_program(changer, timeout, NULL);
96 Dmsg1(400, "unload status=%d\n", status);
99 * Load the desired cassette
101 Dmsg1(400, "Doing changer load slot %d\n", slot);
103 _("3304 Issuing autochanger \"load slot %d, drive %d\" command.\n"),
105 jcr->VolCatInfo.Slot = slot; /* slot to be loaded */
106 changer = edit_device_codes(jcr, changer,
107 jcr->device->changer_command, "load");
108 status = run_program(changer, timeout, NULL);
110 Jmsg(jcr, M_INFO, 0, _("3305 Autochanger \"load slot %d, drive %d\", status is OK.\n"),
113 Jmsg(jcr, M_INFO, 0, _("3992 Bad autochanger \"load slot %d, drive %d\", status=%d.\n"),
114 slot, drive, status);
116 Dmsg2(400, "load slot %d status=%d\n", slot, status);
118 status = 0; /* we got what we want */
120 free_pool_memory(changer);
121 Dmsg1(400, "After changer, status=%d\n", status);
122 if (status == 0) { /* did we succeed? */
123 rtn_stat = 1; /* tape loaded by changer */
126 rtn_stat = 0; /* no changer found */
131 static int get_autochanger_loaded_slot(JCR *jcr)
133 POOLMEM *changer, *results;
135 uint32_t timeout = jcr->device->max_changer_wait;
136 int drive = jcr->device->drive_index;
138 results = get_pool_memory(PM_MESSAGE);
139 changer = get_pool_memory(PM_FNAME);
141 /* Find out what is loaded, zero means device is unloaded */
142 Jmsg(jcr, M_INFO, 0, _("3301 Issuing autochanger \"loaded drive %d\" command.\n"),
144 changer = edit_device_codes(jcr, changer, jcr->device->changer_command,
146 status = run_program(changer, timeout, results);
147 Dmsg3(100, "run_prog: %s stat=%d result=%s\n", changer, status, results);
149 loaded = atoi(results);
151 Jmsg(jcr, M_INFO, 0, _("3302 Autochanger \"loaded drive %d\", result is Slot %d.\n"),
154 Jmsg(jcr, M_INFO, 0, _("3302 Autochanger \"loaded drive %d\", result: nothing loaded.\n"),
158 Jmsg(jcr, M_INFO, 0, _("3991 Bad autochanger \"loaded drive %d\" command, status=%d.\n"),
160 loaded = -1; /* force unload */
162 free_pool_memory(changer);
163 free_pool_memory(results);
168 * The Volume is not in the correct slot, so mark this
169 * Volume as not being in the Changer.
171 void invalid_slot_in_catalog(JCR *jcr, DEVICE *dev)
173 Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
174 " Setting slot to zero in catalog.\n"),
175 jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
176 jcr->VolCatInfo.InChanger = false;
177 dev->VolCatInfo.InChanger = false;
178 Dmsg0(100, "update vol info in mount\n");
179 dir_update_volume_info(jcr, dev, 1); /* set new status */
183 * List the Volumes that are in the autoloader possibly
184 * with their barcodes.
185 * We assume that it is always the Console that is calling us.
187 int autochanger_list(JCR *jcr, DEVICE *dev, BSOCK *dir)
189 uint32_t timeout = jcr->device->max_changer_wait;
193 int len = sizeof_pool_memory(dir->msg) - 1;
195 if (!dev_cap(dev, CAP_AUTOCHANGER) || !jcr->device->changer_name ||
196 !jcr->device->changer_command) {
197 bnet_fsend(dir, _("3993 Not a autochanger device.\n"));
201 changer = get_pool_memory(PM_FNAME);
202 offline_or_rewind_dev(dev);
203 /* We are going to load a new tape, so close the device */
204 force_close_dev(dev);
206 /* First unload any tape */
207 loaded = get_autochanger_loaded_slot(jcr);
209 bnet_fsend(dir, _("3305 Issuing autochanger \"unload slot %d\" command.\n"), loaded);
210 slot = jcr->VolCatInfo.Slot;
211 jcr->VolCatInfo.Slot = loaded;
212 changer = edit_device_codes(jcr, changer, jcr->device->changer_command, "unload");
213 run_program(changer, timeout, NULL);
214 jcr->VolCatInfo.Slot = slot;
217 /* Now list slots occupied */
218 changer = edit_device_codes(jcr, changer, jcr->device->changer_command, "list");
219 bnet_fsend(dir, _("3306 Issuing autochanger \"list\" command.\n"));
220 bpipe = open_bpipe(changer, timeout, "r");
222 bnet_fsend(dir, _("3993 Open bpipe failed.\n"));
225 /* Get output from changer */
226 while (fgets(dir->msg, len, bpipe->rfd)) {
227 dir->msglen = strlen(dir->msg);
230 bnet_sig(dir, BNET_EOD);
234 free_pool_memory(changer);
241 * Edit codes into ChangerCommand
243 * %a = archive device name
244 * %c = changer device name
245 * %d = changer drive index
254 * omsg = edited output message
255 * imsg = input string containing edit codes (%x)
256 * cmd = command string (load, unload, ...)
259 char *edit_device_codes(JCR *jcr, char *omsg, const char *imsg, const char *cmd)
266 Dmsg1(400, "edit_device_codes: %s\n", imsg);
267 for (p=imsg; *p; p++) {
274 str = dev_name(jcr->device->dev);
277 str = NPRT(jcr->device->changer_name);
280 sprintf(add, "%d", jcr->device->dev->drive_index);
287 sprintf(add, "%d", jcr->VolCatInfo.Slot - 1);
291 sprintf(add, "%d", jcr->VolCatInfo.Slot);
294 case 'j': /* Job name */
298 str = NPRT(jcr->VolumeName);
301 str = NPRT(jcr->client_name);
316 Dmsg1(400, "add_str %s\n", str);
317 pm_strcat(&omsg, (char *)str);
318 Dmsg1(400, "omsg=%s\n", omsg);