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 char *edit_device_codes(JCR *jcr, char *omsg, const char *imsg, const char *cmd);
  34 static int get_autochanger_loaded_slot(JCR *jcr);
  35
  36
  37 /*
  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.
  42  *
  43  *  Note if dir is not NULL, it is the console requesting the
  44  *   autoload for labeling, so we respond directly to the
  45  *   dir bsock.
  46  *
  47  *  Returns: 1 on success
  48  *           0 on failure (no changer available)
  49  *          -1 on error on autochanger
  50  */
  51 int autoload_device(JCR *jcr, DEVICE *dev, int writing, BSOCK *dir)
  52 {
  53    int slot = jcr->VolCatInfo.Slot;
  54    int drive = jcr->device->drive_index;
  55    int rtn_stat = -1;                 /* error status */
  56
  57    /*
  58     * Handle autoloaders here.  If we cannot autoload it, we
  59     *  will return FALSE to ask the sysop.
  60     */
  61    if (writing && dev_cap(dev, CAP_AUTOCHANGER) && slot <= 0) {
  62       if (dir) {
  63          return 0;                    /* For user, bail out right now */
  64       }
  65       if (dir_find_next_appendable_volume(jcr)) {
  66          slot = jcr->VolCatInfo.Slot;
  67       } else {
  68          slot = 0;
  69       }
  70    }
  71    Dmsg1(400, "Want changer slot=%d\n", slot);
  72
  73    if (slot > 0 && jcr->device->changer_name && jcr->device->changer_command) {
  74       uint32_t timeout = jcr->device->max_changer_wait;
  75       POOLMEM *changer;
  76       int loaded, status;
  77
  78       changer = get_pool_memory(PM_FNAME);
  79
  80       loaded = get_autochanger_loaded_slot(jcr);
  81
  82       /* If tape we want is not loaded, load it. */
  83       if (loaded != slot) {
  84          offline_or_rewind_dev(dev);
  85          /* We are going to load a new tape, so close the device */
  86          force_close_dev(dev);
  87          if (loaded != 0 && loaded != -1) {        /* must unload drive */
  88             Dmsg0(400, "Doing changer unload.\n");
  89             Jmsg(jcr, M_INFO, 0,
  90                  _("3303 Issuing autochanger \"unload slot %d, drive %d\" command.\n"),
  91                  loaded, drive);
  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);
  97          }
  98          /*
  99           * Load the desired cassette
 100           */
 101          Dmsg1(400, "Doing changer load slot %d\n", slot);
 102          Jmsg(jcr, M_INFO, 0,
 103               _("3304 Issuing autochanger \"load slot %d, drive %d\" command.\n"),
 104               slot, drive);
 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);
 109          if (status == 0) {
 110             Jmsg(jcr, M_INFO, 0, _("3305 Autochanger \"load slot %d, drive %d\", status is OK.\n"),
 111                     slot, drive);
 112          } else {
 113             Jmsg(jcr, M_INFO, 0, _("3992 Bad autochanger \"load slot %d, drive %d\", status=%d.\n"),
 114                     slot, drive, status);
 115          }
 116          Dmsg2(400, "load slot %d status=%d\n", slot, status);
 117       } else {
 118          status = 0;                  /* we got what we want */
 119       }
 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 */
 124       }
 125    } else {
 126       rtn_stat = 0;                   /* no changer found */
 127    }
 128    return rtn_stat;
 129 }
 130
 131 static int get_autochanger_loaded_slot(JCR *jcr)
 132 {
 133    POOLMEM *changer, *results;
 134    int status, loaded;
 135    uint32_t timeout = jcr->device->max_changer_wait;
 136    int drive = jcr->device->drive_index;
 137
 138    results = get_pool_memory(PM_MESSAGE);
 139    changer = get_pool_memory(PM_FNAME);
 140
 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"),
 143         drive);
 144    changer = edit_device_codes(jcr, changer, jcr->device->changer_command,
 145                 "loaded");
 146    status = run_program(changer, timeout, results);
 147    Dmsg3(100, "run_prog: %s stat=%d result=%s\n", changer, status, results);
 148    if (status == 0) {
 149       loaded = atoi(results);
 150       if (loaded > 0) {
 151          Jmsg(jcr, M_INFO, 0, _("3302 Autochanger \"loaded drive %d\", result is Slot %d.\n"),
 152               drive, loaded);
 153       } else {
 154          Jmsg(jcr, M_INFO, 0, _("3302 Autochanger \"loaded drive %d\", result: nothing loaded.\n"),
 155               drive);
 156       }
 157    } else {
 158       Jmsg(jcr, M_INFO, 0, _("3991 Bad autochanger \"loaded drive %d\" command, status=%d.\n"),
 159            drive, status);
 160       loaded = -1;              /* force unload */
 161    }
 162    free_pool_memory(changer);
 163    free_pool_memory(results);
 164    return loaded;
 165 }
 166
 167 /*
 168  * The Volume is not in the correct slot, so mark this
 169  *   Volume as not being in the Changer.
 170  */
 171 void invalid_slot_in_catalog(JCR *jcr, DEVICE *dev)
 172 {
 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 */
 180 }
 181
 182 /*
 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.
 186  */
 187 int autochanger_list(JCR *jcr, DEVICE *dev, BSOCK *dir)
 188 {
 189    uint32_t timeout = jcr->device->max_changer_wait;
 190    POOLMEM *changer;
 191    BPIPE *bpipe;
 192    int slot, loaded;
 193    int len = sizeof_pool_memory(dir->msg) - 1;
 194
 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"));
 198       return 0;
 199    }
 200
 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);
 205
 206    /* First unload any tape */
 207    loaded = get_autochanger_loaded_slot(jcr);
 208    if (loaded > 0) {
 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;
 215    }
 216
 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");
 221    if (!bpipe) {
 222       bnet_fsend(dir, _("3993 Open bpipe failed.\n"));
 223       goto bail_out;
 224    }
 225    /* Get output from changer */
 226    while (fgets(dir->msg, len, bpipe->rfd)) {
 227       dir->msglen = strlen(dir->msg);
 228       bnet_send(dir);
 229    }
 230    bnet_sig(dir, BNET_EOD);
 231    close_bpipe(bpipe);
 232
 233 bail_out:
 234    free_pool_memory(changer);
 235    return 1;
 236 }
 237
 238
 239
 240 /*
 241  * Edit codes into ChangerCommand
 242  *  %% = %
 243  *  %a = archive device name
 244  *  %c = changer device name
 245  *  %d = changer drive index
 246  *  %f = Client's name
 247  *  %j = Job name
 248  *  %o = command
 249  *  %s = Slot base 0
 250  *  %S = Slot base 1
 251  *  %v = Volume name
 252  *
 253  *
 254  *  omsg = edited output message
 255  *  imsg = input string containing edit codes (%x)
 256  *  cmd = command string (load, unload, ...)
 257  *
 258  */
 259 char *edit_device_codes(JCR *jcr, char *omsg, const char *imsg, const char *cmd)
 260 {
 261    const char *p;
 262    const char *str;
 263    char add[20];
 264
 265    *omsg = 0;
 266    Dmsg1(400, "edit_device_codes: %s\n", imsg);
 267    for (p=imsg; *p; p++) {
 268       if (*p == '%') {
 269          switch (*++p) {
 270          case '%':
 271             str = "%";
 272             break;
 273          case 'a':
 274             str = dev_name(jcr->device->dev);
 275             break;
 276          case 'c':
 277             str = NPRT(jcr->device->changer_name);
 278             break;
 279          case 'd':
 280             sprintf(add, "%d", jcr->device->dev->drive_index);
 281             str = add;
 282             break;
 283          case 'o':
 284             str = NPRT(cmd);
 285             break;
 286          case 's':
 287             sprintf(add, "%d", jcr->VolCatInfo.Slot - 1);
 288             str = add;
 289             break;
 290          case 'S':
 291             sprintf(add, "%d", jcr->VolCatInfo.Slot);
 292             str = add;
 293             break;
 294          case 'j':                    /* Job name */
 295             str = jcr->Job;
 296             break;
 297          case 'v':
 298             str = NPRT(jcr->VolumeName);
 299             break;
 300          case 'f':
 301             str = NPRT(jcr->client_name);
 302             break;
 303
 304          default:
 305             add[0] = '%';
 306             add[1] = *p;
 307             add[2] = 0;
 308             str = add;
 309             break;
 310          }
 311       } else {
 312          add[0] = *p;
 313          add[1] = 0;
 314          str = add;
 315       }
 316       Dmsg1(400, "add_str %s\n", str);
 317       pm_strcat(&omsg, (char *)str);
 318       Dmsg1(400, "omsg=%s\n", omsg);
 319    }
 320    return omsg;
 321 }