git.sur5r.net Git - bacula/bacula/blob - bacula/src/stored/autochanger.c

   1 /*
   2  *
   3  *  Routines for handling the autochanger.
   4  *
   5  *   Kern Sibbald, August MMII
   6  *
   7  *   Version $Id$
   8  */
   9 /*
  10    Copyright (C) 2000-2003 Kern Sibbald and John Walker
  11
  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.
  16
  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.
  21
  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,
  25    MA 02111-1307, USA.
  26
  27  */
  28
  29 #include "bacula.h"                   /* pull in global headers */
  30 #include "stored.h"                   /* pull in Storage Deamon headers */
  31
  32 /* Forward referenced functions */
  33 static char *edit_device_codes(JCR *jcr, char *omsg, char *imsg, char *cmd);
  34
  35
  36 /*
  37  * Called here to do an autoload using the autochanger, if
  38  *  configured, and if a Slot has been defined for this Volume.
  39  *  On success this routine loads the indicated tape, but the
  40  *  label is not read, so it must be verified.
  41  *
  42  *  Note if dir is not NULL, it is the console requesting the
  43  *   autoload for labeling, so we respond directly to the
  44  *   dir bsock.
  45  *
  46  *  Returns: 1 on success
  47  *           0 on failure
  48  */
  49 int autoload_device(JCR *jcr, DEVICE *dev, int writing, BSOCK *dir)
  50 {
  51    int slot = jcr->VolCatInfo.Slot;
  52    int rtn_stat = 0;
  53
  54    /*
  55     * Handle autoloaders here.  If we cannot autoload it, we
  56     *  will return FALSE to ask the sysop.
  57     */
  58    if (writing && dev_cap(dev, CAP_AUTOCHANGER) && slot <= 0) {
  59       if (dir) {
  60          return 0;                    /* For user, bail out right now */
  61       }
  62       if (dir_find_next_appendable_volume(jcr)) {
  63          slot = jcr->VolCatInfo.Slot;
  64       }
  65    }
  66    Dmsg1(100, "Want changer slot=%d\n", slot);
  67
  68    if (slot > 0 && jcr->device->changer_name && jcr->device->changer_command) {
  69       uint32_t timeout = jcr->device->max_changer_wait;
  70       POOLMEM *changer, *results;
  71       int status, loaded;
  72
  73       results = get_pool_memory(PM_MESSAGE);
  74       changer = get_pool_memory(PM_FNAME);
  75
  76       /* Find out what is loaded, zero means device is unloaded */
  77       Jmsg(jcr, M_INFO, 0, _("3301 Issuing autochanger \"loaded\" command.\n"));
  78       changer = edit_device_codes(jcr, changer, jcr->device->changer_command,
  79                    "loaded");
  80       status = run_program(changer, timeout, results);
  81       Dmsg3(100, "run_prog: %s stat=%d result=%s\n", changer, status, results);
  82       if (status == 0) {
  83          loaded = atoi(results);
  84       } else {
  85          Jmsg(jcr, M_INFO, 0, _("3991 Bad autochanger \"load slot\" status=%d.\n"), status);
  86          loaded = -1;              /* force unload */
  87       }
  88       Dmsg1(100, "loaded=%s\n", results);
  89
  90       /* If bad status or tape we want is not loaded, load it. */
  91       if (status != 0 || loaded != slot) {
  92          offline_or_rewind_dev(dev);
  93          /* We are going to load a new tape, so close the device */
  94          force_close_dev(dev);
  95          if (loaded != 0) {        /* must unload drive */
  96             Dmsg0(100, "Doing changer unload.\n");
  97             Jmsg(jcr, M_INFO, 0, _("3302 Issuing autochanger \"unload\" command.\n"));
  98             changer = edit_device_codes(jcr, changer,
  99                         jcr->device->changer_command, "unload");
 100             status = run_program(changer, timeout, NULL);
 101             Dmsg1(100, "unload status=%d\n", status);
 102          }
 103          /*
 104           * Load the desired cassette
 105           */
 106          Dmsg1(100, "Doing changer load slot %d\n", slot);
 107          Jmsg(jcr, M_INFO, 0, _("3303 Issuing autochanger \"load slot %d\" command.\n"),
 108               slot);
 109          changer = edit_device_codes(jcr, changer,
 110                       jcr->device->changer_command, "load");
 111          status = run_program(changer, timeout, NULL);
 112          if (status == 0) {
 113             Jmsg(jcr, M_INFO, 0, _("3304 Autochanger \"load slot %d\" status is OK.\n"),
 114                     slot);
 115          } else {
 116             Jmsg(jcr, M_INFO, 0, _("3992 Bad autochanger \"load slot\" status=%d.\n"),
 117                     status);
 118          }
 119          Dmsg2(100, "load slot %d status=%d\n", slot, status);
 120       }
 121       free_pool_memory(changer);
 122       free_pool_memory(results);
 123       Dmsg1(100, "After changer, status=%d\n", status);
 124       if (status == 0) {           /* did we succeed? */
 125          rtn_stat = 1;             /* tape loaded by changer */
 126       }
 127    }
 128    return rtn_stat;
 129 }
 130
 131 void invalidate_slot_in_catalog(JCR *jcr)
 132 {
 133    Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
 134 "    Setting slot to zero in catalog.\n"),
 135         jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
 136    jcr->VolCatInfo.Slot = 0; /* invalidate slot */
 137    Dmsg0(200, "update vol info in mount\n");
 138    dir_update_volume_info(jcr, &jcr->VolCatInfo, 1);  /* set slot */
 139 }
 140
 141 /*
 142  * List the Volumes that are in the autoloader possibly
 143  *   with their barcodes.
 144  *   We assume that it is always the Console that is calling us.
 145  */
 146 int autochanger_list(JCR *jcr, DEVICE *dev, BSOCK *dir)
 147 {
 148    uint32_t timeout = jcr->device->max_changer_wait;
 149    POOLMEM *changer;
 150    BPIPE *bpipe;
 151    int len = sizeof_pool_memory(dir->msg) - 1;
 152
 153    if (!dev_cap(dev, CAP_AUTOCHANGER) || !jcr->device->changer_name ||
 154        !jcr->device->changer_command) {
 155       bnet_fsend(dir, _("3993 Not a autochanger device.\n"));
 156       return 0;
 157    }
 158
 159    changer = get_pool_memory(PM_FNAME);
 160    offline_or_rewind_dev(dev);
 161    /* We are going to load a new tape, so close the device */
 162    force_close_dev(dev);
 163
 164    /* First unload any tape */
 165    bnet_fsend(dir, _("3305 Issuing autochanger \"unload\" command.\n"));
 166    changer = edit_device_codes(jcr, changer, jcr->device->changer_command, "unload");
 167    run_program(changer, timeout, NULL);
 168
 169    /* Now list slots occupied */
 170    changer = edit_device_codes(jcr, changer, jcr->device->changer_command, "list");
 171    bnet_fsend(dir, _("3306 Issuing autochanger \"list\" command.\n"));
 172    bpipe = open_bpipe(changer, timeout, "r");
 173    if (!bpipe) {
 174       bnet_fsend(dir, _("3993 Open bpipe failed.\n"));
 175       goto bail_out;
 176    }
 177    /* Get output from changer */
 178    while (fgets(dir->msg, len, bpipe->rfd)) {
 179       dir->msglen = strlen(dir->msg);
 180       bnet_send(dir);
 181    }
 182    bnet_sig(dir, BNET_EOD);
 183    close_bpipe(bpipe);
 184
 185 bail_out:
 186    free_pool_memory(changer);
 187    return 1;
 188 }
 189
 190
 191
 192 /*
 193  * Edit codes into ChangerCommand
 194  *  %% = %
 195  *  %a = archive device name
 196  *  %c = changer device name
 197  *  %f = Client's name
 198  *  %j = Job name
 199  *  %o = command
 200  *  %s = Slot base 0
 201  *  %S = Slot base 1
 202  *  %v = Volume name
 203  *
 204  *
 205  *  omsg = edited output message
 206  *  imsg = input string containing edit codes (%x)
 207  *  cmd = command string (load, unload, ...)
 208  *
 209  */
 210 static char *edit_device_codes(JCR *jcr, char *omsg, char *imsg, char *cmd)
 211 {
 212    char *p;
 213    const char *str;
 214    char add[20];
 215
 216    *omsg = 0;
 217    Dmsg1(200, "edit_device_codes: %s\n", imsg);
 218    for (p=imsg; *p; p++) {
 219       if (*p == '%') {
 220          switch (*++p) {
 221          case '%':
 222             str = "%";
 223             break;
 224          case 'a':
 225             str = jcr->device->dev->dev_name;
 226             break;
 227          case 'c':
 228             str = NPRT(jcr->device->changer_name);
 229             break;
 230          case 'o':
 231             str = NPRT(cmd);
 232             break;
 233          case 's':
 234             sprintf(add, "%d", jcr->VolCatInfo.Slot - 1);
 235             str = add;
 236             break;
 237          case 'S':
 238             sprintf(add, "%d", jcr->VolCatInfo.Slot);
 239             str = add;
 240             break;
 241          case 'j':                    /* Job name */
 242             str = jcr->Job;
 243             break;
 244          case 'v':
 245             str = NPRT(jcr->VolumeName);
 246             break;
 247          case 'f':
 248             str = NPRT(jcr->client_name);
 249             break;
 250
 251          default:
 252             add[0] = '%';
 253             add[1] = *p;
 254             add[2] = 0;
 255             str = add;
 256             break;
 257          }
 258       } else {
 259          add[0] = *p;
 260          add[1] = 0;
 261          str = add;
 262       }
 263       Dmsg1(200, "add_str %s\n", str);
 264       pm_strcat(&omsg, (char *)str);
 265       Dmsg1(200, "omsg=%s\n", omsg);
 266    }
 267    return omsg;
 268 }