]> git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/autochanger.c
Eliminate unused statement
[bacula/bacula] / bacula / src / stored / autochanger.c
1 /*
2    Bacula® - The Network Backup Solution
3
4    Copyright (C) 2002-2008 Free Software Foundation Europe e.V.
5
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
11    in the file LICENSE.
12
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.
17
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
21    02110-1301, USA.
22
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.
27 */
28 /*
29  *
30  *  Routines for handling the autochanger.
31  *
32  *   Kern Sibbald, August MMII
33  *                            
34  *   Version $Id$
35  */
36
37 #include "bacula.h"                   /* pull in global headers */
38 #include "stored.h"                   /* pull in Storage Deamon headers */
39
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);
44
45 /* Init all the autochanger resources found */
46 bool init_autochangers()
47 {
48    bool OK = true;
49    AUTOCHANGER *changer;
50    /* Ensure that the media_type for each device is the same */
51    foreach_res(changer, R_AUTOCHANGER) {
52       DEVRES *device;
53       foreach_alist(device, changer->device) {
54          /*
55           * If the device does not have a changer name or changer command
56           *   defined, used the one from the Autochanger resource 
57           */
58          if (!device->changer_name && changer->changer_name) {
59             device->changer_name = bstrdup(changer->changer_name);
60          }
61          if (!device->changer_command && changer->changer_command) {
62             device->changer_command = bstrdup(changer->changer_command);
63          }
64          if (!device->changer_name) {
65             Jmsg(NULL, M_ERROR, 0, 
66                _("No Changer Name given for device %s. Cannot continue.\n"),
67                device->hdr.name);
68             OK = false;
69          }   
70          if (!device->changer_command) {
71             Jmsg(NULL, M_ERROR, 0, 
72                _("No Changer Command given for device %s. Cannot continue.\n"),
73                device->hdr.name);
74             OK = false;
75          }   
76
77 #ifdef xxx_needed
78          if (media_type == NULL) {
79             media_type = device->media_type;     /* get Media Type of first device */
80             continue;
81          }     
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"),
86                changer->hdr.name);
87             OK = false;
88             continue;
89          }
90 #endif
91       }
92    }
93    return OK;
94 }
95
96
97 /*
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.
102  *
103  *  Note if dir is not NULL, it is the console requesting the
104  *   autoload for labeling, so we respond directly to the
105  *   dir bsock.
106  *
107  *  Returns: 1 on success
108  *           0 on failure (no changer available)
109  *          -1 on error on autochanger
110  */
111 int autoload_device(DCR *dcr, int writing, BSOCK *dir)
112 {
113    JCR *jcr = dcr->jcr;
114    DEVICE * volatile dev = dcr->dev;
115    int slot;
116    int drive = dev->drive_index;
117    int rtn_stat = -1;                 /* error status */
118    POOLMEM *changer;
119
120    if (!dev->is_autochanger()) {
121       Dmsg0(100, "ChangerCommand=0, virtual disk changer\n");
122       return 0;
123    }
124
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 */
128    }
129
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->VolCatInfo.VolCatName);
133    /*
134     * Handle autoloaders here.  If we cannot autoload it, we
135     *  will return 0 so that the sysop will be asked to load it.
136     */
137    if (writing && slot <= 0) {
138       if (dir) {
139          return 0;                    /* For user, bail out right now */
140       }
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;
144       } else {
145          slot = 0;
146       }
147    }
148    Dmsg1(400, "Want changer slot=%d\n", slot);
149
150    changer = get_pool_memory(PM_FNAME);
151    if (slot <= 0) {
152       Jmsg(jcr, M_INFO, 0, _("Invalid slot=%d defined in catalog for Volume \"%s\" "
153            "on %s. Manual load may be required.\n"), slot, dcr->VolCatInfo.VolCatName,
154            dev->print_name());
155       rtn_stat = 0;
156    } else if (!dcr->device->changer_name) {
157       Jmsg(jcr, M_INFO, 0, _("No \"Changer Device\" for %s. Manual load of Volume may be required.\n"),
158            dev->print_name());
159       rtn_stat = 0;
160   } else if (!dcr->device->changer_command) {
161       Jmsg(jcr, M_INFO, 0, _("No \"Changer Command\" for %s. Manual load of Volume may be requird.\n"),
162            dev->print_name());
163       rtn_stat = 0;
164   } else {
165       /* Attempt to load the Volume */
166
167       uint32_t timeout = dcr->device->max_changer_wait;
168       int loaded, status;
169
170       loaded = get_autochanger_loaded_slot(dcr);
171
172       if (loaded != slot) {
173          POOL_MEM results(PM_MESSAGE);
174
175          /* Unload anything in our drive */
176          if (!unload_autochanger(dcr, loaded)) {
177             goto bail_out;
178          }
179             
180          /* Make sure desired slot is unloaded */
181          if (!unload_other_drive(dcr, slot)) {
182             goto bail_out;
183          }
184
185          /*
186           * Load the desired cassette
187           */
188          lock_changer(dcr);
189          Dmsg2(100, "Doing changer load slot %d %s\n", slot, dev->print_name());
190          Jmsg(jcr, M_INFO, 0,
191               _("3304 Issuing autochanger \"load slot %d, drive %d\" command.\n"),
192               slot, drive);
193          dcr->VolCatInfo.Slot = slot;    /* slot to be loaded */
194          changer = edit_device_codes(dcr, changer, dcr->device->changer_command, "load");
195          dev->close();
196          Dmsg1(200, "Run program=%s\n", changer);
197          status = run_program_full_output(changer, timeout, results.c_str());
198          if (status == 0) {
199             Jmsg(jcr, M_INFO, 0, _("3305 Autochanger \"load slot %d, drive %d\", status is OK.\n"),
200                     slot, drive);
201             Dmsg2(100, "load slot %d, drive %d, status is OK.\n", slot, drive);
202             dev->set_slot(slot);      /* set currently loaded slot */
203          } else {
204             berrno be;
205             be.set_errno(status);
206             Dmsg4(100, "load slot %d, drive %d, ERR=%s Result=%s\n", slot, drive,
207                be.bstrerror(), results.c_str());
208             Jmsg(jcr, M_FATAL, 0, _("3992 Bad autochanger \"load slot %d, drive %d\": "
209                  "ERR=%s.\nResults=%s\n"),
210                     slot, drive, be.bstrerror(), results.c_str());
211             rtn_stat = -1;            /* hard error */
212             dev->set_slot(-1);        /* mark unknown */
213          }
214          Dmsg2(100, "load slot %d status=%d\n", slot, status);
215          unlock_changer(dcr);
216       } else {
217          status = 0;                  /* we got what we want */
218          dev->set_slot(slot);         /* set currently loaded slot */
219       }
220       Dmsg1(100, "After changer, status=%d\n", status);
221       if (status == 0) {              /* did we succeed? */
222          rtn_stat = 1;                /* tape loaded by changer */
223       }
224    }
225    free_pool_memory(changer);
226    return rtn_stat;
227
228 bail_out:
229    free_pool_memory(changer);
230    return -1;
231
232 }
233
234 /*
235  * Returns: -1 if error from changer command
236  *          slot otherwise
237  *  Note, this is safe to do without releasing the drive
238  *   since it does not attempt load/unload a slot.
239  */
240 int get_autochanger_loaded_slot(DCR *dcr)
241 {
242    JCR *jcr = dcr->jcr;
243    DEVICE *dev = dcr->dev;
244    int status, loaded;
245    uint32_t timeout = dcr->device->max_changer_wait;
246    int drive = dcr->dev->drive_index;
247    POOL_MEM results(PM_MESSAGE);
248    POOLMEM *changer;
249
250    if (!dev->is_autochanger()) {
251       return -1;
252    }
253    if (!dcr->device->changer_command) {
254 //    Jmsg(jcr, M_FATAL, 0, _("3992 Missing Changer command.\n"));
255       return -1;
256    }
257    if (dev->get_slot() > 0) {
258       return dev->get_slot();
259    }
260
261    /* Virtual disk autochanger */
262    if (dcr->device->changer_command[0] == 0) {
263       return 1;
264    }
265
266    /* Find out what is loaded, zero means device is unloaded */
267    changer = get_pool_memory(PM_FNAME);
268    lock_changer(dcr);
269    Jmsg(jcr, M_INFO, 0, _("3301 Issuing autochanger \"loaded? drive %d\" command.\n"),
270         drive);
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.c_str());
274    Dmsg3(100, "run_prog: %s stat=%d result=%s", changer, status, results.c_str());
275    if (status == 0) {
276       loaded = str_to_int32(results.c_str());
277       if (loaded > 0) {
278          Jmsg(jcr, M_INFO, 0, _("3302 Autochanger \"loaded? drive %d\", result is Slot %d.\n"),
279               drive, loaded);
280          dev->set_slot(loaded);
281       } else {
282          Jmsg(jcr, M_INFO, 0, _("3302 Autochanger \"loaded? drive %d\", result: nothing loaded.\n"),
283               drive);
284          dev->clear_slot();   /* unknown */
285       }
286    } else {
287       berrno be;
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 */
292    }
293    unlock_changer(dcr);
294    free_pool_memory(changer);
295    return loaded;
296 }
297
298 static void lock_changer(DCR *dcr)
299 {
300    AUTOCHANGER *changer_res = dcr->device->changer_res;
301    if (changer_res) {
302       Dmsg1(200, "Locking changer %s\n", changer_res->hdr.name);
303       P(changer_res->changer_mutex);  /* Lock changer script */
304    }
305 }
306
307 static void unlock_changer(DCR *dcr)
308 {
309    AUTOCHANGER *changer_res = dcr->device->changer_res;
310    if (changer_res) {
311       Dmsg1(200, "Unlocking changer %s\n", changer_res->hdr.name);
312       V(changer_res->changer_mutex);  /* Unlock changer script */
313    }
314 }
315
316 /*
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
321  */
322 bool unload_autochanger(DCR *dcr, int loaded)
323 {
324    DEVICE *dev = dcr->dev;
325    JCR *jcr = dcr->jcr;
326    int slot;
327    uint32_t timeout = dcr->device->max_changer_wait;
328    bool ok = true;
329
330    if (loaded == 0) {
331       return true;
332    }
333
334    if (!dev->is_autochanger() || !dcr->device->changer_name ||
335        !dcr->device->changer_command) {
336       return false;
337    }
338
339    /* Virtual disk autochanger */
340    if (dcr->device->changer_command[0] == 0) {
341       dev->clear_unload();
342       return true;
343    }
344
345    if (loaded < 0) {
346       loaded = get_autochanger_loaded_slot(dcr);
347    }
348
349    if (loaded > 0) {
350       POOL_MEM results(PM_MESSAGE);
351       POOLMEM *changer = get_pool_memory(PM_FNAME);
352       lock_changer(dcr);
353       Jmsg(jcr, M_INFO, 0,
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");
360       dev->close();
361       Dmsg1(100, "Run program=%s\n", changer);
362       int stat = run_program_full_output(changer, timeout, results.c_str());
363       dcr->VolCatInfo.Slot = slot;
364       if (stat != 0) {
365          berrno be;
366          be.set_errno(stat);
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());
370          ok = false;
371          dev->clear_slot();        /* unknown */
372       } else {
373          dev->set_slot(0);         /* nothing loaded */
374       }
375       unlock_changer(dcr);
376
377       free_volume(dev);            /* Free any volume associated with this drive */
378       free_pool_memory(changer);
379    }
380    dev->clear_unload();
381    return ok;
382 }
383
384 /*
385  * Unload the slot if mounted in a different drive
386  */
387 static bool unload_other_drive(DCR *dcr, int slot)
388 {
389    DEVICE *dev = NULL;
390    bool found = false;
391    AUTOCHANGER *changer = dcr->dev->device->changer_res;
392    DEVRES *device;
393    int retries = 0;                /* wait for device retries */
394
395    if (!changer) {
396       return false;
397    }
398    if (changer->device->size() == 1) {
399       return true;
400    }
401
402    foreach_alist(device, changer->device) {
403       if (device->dev && device->dev->get_slot() == slot) {
404          found = true;
405          dev = device->dev;
406          break;
407       }
408    }
409    if (!found) {
410       return true;
411    }
412
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);
418    }   
419    for (int i=0; i < 3; i++) {
420       if (dev->is_busy()) {
421          wait_for_device(dcr->jcr, retries);
422          continue;
423       }
424       break;
425    }
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->get_slot());
431       Dmsg2(100, "num_writ=%d reserv=%d\n", dev->num_writers, dev->num_reserved());
432       return false;
433    }
434    return unload_dev(dcr, dev);
435 }
436
437 /*
438  * Unconditionally unload a specified drive
439  */
440 bool unload_dev(DCR *dcr, DEVICE *dev)
441 {
442    JCR *jcr = dcr->jcr;
443    bool ok = true;
444    uint32_t timeout = dcr->device->max_changer_wait;
445    AUTOCHANGER *changer = dcr->dev->device->changer_res;
446    DEVICE *save_dev;
447    int save_slot;
448
449    if (!changer) {
450       return false;
451    }
452
453    save_dev = dcr->dev;               /* save dcr device */
454    dcr->dev = dev;                    /* temporarily point dcr at other device */
455
456    if (dev->get_slot() <= 0 && get_autochanger_loaded_slot(dcr) <= 0) {
457       dcr->dev = save_dev;
458       return false;
459    }
460    save_slot = dcr->VolCatInfo.Slot;
461    dcr->VolCatInfo.Slot = dev->get_slot();
462
463    dev->dlock();
464
465    POOLMEM *changer_cmd = get_pool_memory(PM_FNAME);
466    POOL_MEM results(PM_MESSAGE);
467    lock_changer(dcr);
468    Jmsg(jcr, M_INFO, 0,
469         _("3307 Issuing autochanger \"unload slot %d, drive %d\" command.\n"),
470         dev->get_slot(), dev->drive_index);
471
472    Dmsg2(100, "Issuing autochanger \"unload slot %d, drive %d\" command.\n",
473         dev->get_slot(), dev->drive_index);
474
475    changer_cmd = edit_device_codes(dcr, changer_cmd, 
476                 dcr->device->changer_command, "unload");
477    dev->close();
478    Dmsg2(200, "close dev=%s reserve=%d\n", dev->print_name(), 
479       dev->num_reserved());
480    Dmsg1(100, "Run program=%s\n", changer_cmd);
481    int stat = run_program_full_output(changer_cmd, timeout, results.c_str());
482    dcr->VolCatInfo.Slot = save_slot;
483    dcr->dev = save_dev;
484    if (stat != 0) {
485       berrno be;
486       be.set_errno(stat);
487       Jmsg(jcr, M_INFO, 0, _("3995 Bad autochanger \"unload slot %d, drive %d\": ERR=%s.\n"),
488               dev->get_slot(), dev->drive_index, be.bstrerror());
489
490       Dmsg3(100, "Bad autochanger \"unload slot %d, drive %d\": ERR=%s.\n",
491               dev->get_slot(), dev->drive_index, be.bstrerror());
492       ok = false;
493       dev->clear_slot();          /* unknown */
494    } else {
495       Dmsg2(100, "Slot %d unloaded %s\n", dev->get_slot(), dev->print_name());
496       dev->set_slot(0);           /* nothing loaded */
497    }
498    dev->clear_unload();
499    unlock_changer(dcr);
500
501    dev->dunlock();
502
503    free_volume(dev);               /* Free any volume associated with this drive */
504    free_pool_memory(changer_cmd);
505    return ok;
506 }
507
508
509
510 /*
511  * List the Volumes that are in the autoloader possibly
512  *   with their barcodes.
513  *   We assume that it is always the Console that is calling us.
514  */
515 bool autochanger_cmd(DCR *dcr, BSOCK *dir, const char *cmd)  
516 {
517    DEVICE *dev = dcr->dev;
518    uint32_t timeout = dcr->device->max_changer_wait;
519    POOLMEM *changer;
520    BPIPE *bpipe;
521    int len = sizeof_pool_memory(dir->msg) - 1;
522    bool ok = false;
523    int stat;
524
525    if (!dev->is_autochanger() || !dcr->device->changer_name ||
526        !dcr->device->changer_command) {
527       if (strcmp(cmd, "drives") == 0) {
528          dir->fsend("drives=1\n");
529       }
530       dir->fsend(_("3993 Device %s not an autochanger device.\n"),
531          dev->print_name());
532       return false;
533    }
534
535    if (strcmp(cmd, "drives") == 0) {
536       AUTOCHANGER *changer_res = dcr->device->changer_res;
537       int drives = 1;
538       if (changer_res) {
539          drives = changer_res->device->size();
540       }
541       dir->fsend("drives=%d\n", drives);
542       Dmsg1(100, "drives=%d\n", drives);
543       return true;
544    }
545
546    changer = get_pool_memory(PM_FNAME);
547    lock_changer(dcr);
548    /* Now issue the command */
549    changer = edit_device_codes(dcr, changer, 
550                  dcr->device->changer_command, cmd);
551    dir->fsend(_("3306 Issuing autochanger \"%s\" command.\n"), cmd);
552    bpipe = open_bpipe(changer, timeout, "r");
553    if (!bpipe) {
554       dir->fsend(_("3996 Open bpipe failed.\n"));
555       goto bail_out;
556    }
557    if (strcmp(cmd, "list") == 0) {
558       /* Get output from changer */
559       while (fgets(dir->msg, len, bpipe->rfd)) {
560          dir->msglen = strlen(dir->msg);
561          Dmsg1(100, "<stored: %s\n", dir->msg);
562          bnet_send(dir);
563       }
564    } else if (strcmp(cmd, "slots") == 0 ) {
565       char buf[100], *p;
566       /* For slots command, read a single line */
567       buf[0] = 0;
568       fgets(buf, sizeof(buf)-1, bpipe->rfd);
569       buf[sizeof(buf)-1] = 0;
570       /* Strip any leading space in front of # of slots */
571       for (p=buf; B_ISSPACE(*p); p++)
572         { }
573       dir->fsend("slots=%s", p);
574       Dmsg1(100, "<stored: %s", dir->msg);
575    } 
576                  
577    stat = close_bpipe(bpipe);
578    if (stat != 0) {
579       berrno be;
580       be.set_errno(stat);
581       dir->fsend(_("Autochanger error: ERR=%s\n"), be.bstrerror());
582    }
583    bnet_sig(dir, BNET_EOD);
584    ok = true;
585
586 bail_out:
587    unlock_changer(dcr);
588    free_pool_memory(changer);
589    return true;
590 }
591
592
593 /*
594  * Edit codes into ChangerCommand
595  *  %% = %
596  *  %a = archive device name
597  *  %c = changer device name
598  *  %d = changer drive index
599  *  %f = Client's name
600  *  %j = Job name
601  *  %o = command
602  *  %s = Slot base 0
603  *  %S = Slot base 1
604  *  %v = Volume name
605  *
606  *
607  *  omsg = edited output message
608  *  imsg = input string containing edit codes (%x)
609  *  cmd = command string (load, unload, ...)
610  *
611  */
612 char *edit_device_codes(DCR *dcr, char *omsg, const char *imsg, const char *cmd)
613 {
614    const char *p;
615    const char *str;
616    char add[20];
617
618    *omsg = 0;
619    Dmsg1(1800, "edit_device_codes: %s\n", imsg);
620    for (p=imsg; *p; p++) {
621       if (*p == '%') {
622          switch (*++p) {
623          case '%':
624             str = "%";
625             break;
626          case 'a':
627             str = dcr->dev->archive_name();
628             break;
629          case 'c':
630             str = NPRT(dcr->device->changer_name);
631             break;
632          case 'd':
633             sprintf(add, "%d", dcr->dev->drive_index);
634             str = add;
635             break;
636          case 'o':
637             str = NPRT(cmd);
638             break;
639          case 's':
640             sprintf(add, "%d", dcr->VolCatInfo.Slot - 1);
641             str = add;
642             break;
643          case 'S':
644             sprintf(add, "%d", dcr->VolCatInfo.Slot);
645             str = add;
646             break;
647          case 'j':                    /* Job name */
648             str = dcr->jcr->Job;
649             break;
650          case 'v':
651             str = NPRT(dcr->VolumeName);
652             break;
653          case 'f':
654             str = NPRT(dcr->jcr->client_name);
655             break;
656
657          default:
658             add[0] = '%';
659             add[1] = *p;
660             add[2] = 0;
661             str = add;
662             break;
663          }
664       } else {
665          add[0] = *p;
666          add[1] = 0;
667          str = add;
668       }
669       Dmsg1(1900, "add_str %s\n", str);
670       pm_strcat(&omsg, (char *)str);
671       Dmsg1(1800, "omsg=%s\n", omsg);
672    }
673    Dmsg1(800, "omsg=%s\n", omsg);
674    return omsg;
675 }