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, char *imsg, 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       }
  68    }
  69    Dmsg1(400, "Want changer slot=%d\n", slot);
  70
  71    if (slot > 0 && jcr->device->changer_name && jcr->device->changer_command) {
  72       uint32_t timeout = jcr->device->max_changer_wait;
  73       POOLMEM *changer, *results;
  74       int loaded, status;
  75
  76       results = get_pool_memory(PM_MESSAGE);
  77       changer = get_pool_memory(PM_FNAME);
  78
  79       loaded = get_autochanger_loaded_slot(jcr);
  80
  81       Dmsg1(400, "loaded=%s\n", results);
  82
  83       /* If tape we want is not loaded, load it. */
  84       if (loaded != slot) {
  85          offline_or_rewind_dev(dev);
  86          /* We are going to load a new tape, so close the device */
  87          force_close_dev(dev);
  88          if (loaded != 0) {        /* must unload drive */
  89             Dmsg0(400, "Doing changer unload.\n");
  90             Jmsg(jcr, M_INFO, 0,
  91                  _("3303 Issuing autochanger \"unload slot %d, drive %d\" command.\n"),
  92                  loaded, drive);
  93             jcr->VolCatInfo.Slot = loaded;   /* slot to be unloaded */
  94             changer = edit_device_codes(jcr, changer,
  95                         jcr->device->changer_command, "unload");
  96             status = run_program(changer, timeout, NULL);
  97             Dmsg1(400, "unload status=%d\n", status);
  98          }
  99          /*
 100           * Load the desired cassette
 101           */
 102          Dmsg1(400, "Doing changer load slot %d\n", slot);
 103          Jmsg(jcr, M_INFO, 0,
 104               _("3304 Issuing autochanger \"load slot %d, drive %d\" command.\n"),
 105               slot, drive);
 106          jcr->VolCatInfo.Slot = slot;    /* slot to be loaded */
 107          changer = edit_device_codes(jcr, changer,
 108                       jcr->device->changer_command, "load");
 109          status = run_program(changer, timeout, NULL);
 110          if (status == 0) {
 111             Jmsg(jcr, M_INFO, 0, _("3305 Autochanger \"load slot %d, drive %d\", status is OK.\n"),
 112                     slot, drive);
 113          } else {
 114             Jmsg(jcr, M_INFO, 0, _("3992 Bad autochanger \"load slot %d, drive %d\", status=%d.\n"),
 115                     slot, drive, status);
 116          }
 117          Dmsg2(400, "load slot %d status=%d\n", slot, status);
 118       } else {
 119          status = 0;                  /* we got what we want */
 120       }
 121       free_pool_memory(changer);
 122       free_pool_memory(results);
 123       Dmsg1(400, "After changer, status=%d\n", status);
 124       if (status == 0) {              /* did we succeed? */
 125          rtn_stat = 1;                /* tape loaded by changer */
 126       }
 127    } else {
 128       rtn_stat = 0;                   /* no changer found */
 129    }
 130    return rtn_stat;
 131 }
 132
 133 static int get_autochanger_loaded_slot(JCR *jcr)
 134 {
 135    POOLMEM *changer, *results;
 136    int status, loaded;
 137    uint32_t timeout = jcr->device->max_changer_wait;
 138    int drive = jcr->device->drive_index;
 139
 140    results = get_pool_memory(PM_MESSAGE);
 141    changer = get_pool_memory(PM_FNAME);
 142
 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"),
 145         drive);
 146    changer = edit_device_codes(jcr, changer, jcr->device->changer_command,
 147                 "loaded");
 148    status = run_program(changer, timeout, results);
 149    Dmsg3(100, "run_prog: %s stat=%d result=%s\n", changer, status, results);
 150    if (status == 0) {
 151       loaded = atoi(results);
 152       if (loaded > 0) {
 153          Jmsg(jcr, M_INFO, 0, _("3302 Autochanger \"loaded drive %d\", result is Slot %d.\n"),
 154               drive, loaded);
 155       } else {
 156          Jmsg(jcr, M_INFO, 0, _("3302 Autochanger \"loaded drive %d\", result: nothing loaded.\n"),
 157               drive);
 158       }
 159    } else {
 160       Jmsg(jcr, M_INFO, 0, _("3991 Bad autochanger \"loaded drive %d\" command, status=%d.\n"),
 161            drive, status);
 162       loaded = -1;              /* force unload */
 163    }
 164    free_pool_memory(changer);
 165    free_pool_memory(results);
 166    return loaded;
 167 }
 168
 169 /*
 170  * The Volume is not in the correct slot, so mark this
 171  *   Volume as not being in the Changer.
 172  */
 173 void invalid_slot_in_catalog(JCR *jcr, DEVICE *dev)
 174 {
 175    Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n"
 176 "    Setting slot to zero in catalog.\n"),
 177         jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
 178    jcr->VolCatInfo.InChanger = false;
 179    dev->VolCatInfo.InChanger = false;
 180    Dmsg0(100, "update vol info in mount\n");
 181    dir_update_volume_info(jcr, dev, 1);  /* set new status */
 182 }
 183
 184 /*
 185  * List the Volumes that are in the autoloader possibly
 186  *   with their barcodes.
 187  *   We assume that it is always the Console that is calling us.
 188  */
 189 int autochanger_list(JCR *jcr, DEVICE *dev, BSOCK *dir)
 190 {
 191    uint32_t timeout = jcr->device->max_changer_wait;
 192    POOLMEM *changer;
 193    BPIPE *bpipe;
 194    int slot, loaded;
 195    int len = sizeof_pool_memory(dir->msg) - 1;
 196
 197    if (!dev_cap(dev, CAP_AUTOCHANGER) || !jcr->device->changer_name ||
 198        !jcr->device->changer_command) {
 199       bnet_fsend(dir, _("3993 Not a autochanger device.\n"));
 200       return 0;
 201    }
 202
 203    changer = get_pool_memory(PM_FNAME);
 204    offline_or_rewind_dev(dev);
 205    /* We are going to load a new tape, so close the device */
 206    force_close_dev(dev);
 207
 208    /* First unload any tape */
 209    loaded = get_autochanger_loaded_slot(jcr);
 210    if (loaded > 0) {
 211       bnet_fsend(dir, _("3305 Issuing autochanger \"unload slot %d\" command.\n"), loaded);
 212       slot = jcr->VolCatInfo.Slot;
 213       jcr->VolCatInfo.Slot = loaded;
 214       changer = edit_device_codes(jcr, changer, jcr->device->changer_command, "unload");
 215       run_program(changer, timeout, NULL);
 216       jcr->VolCatInfo.Slot = slot;
 217    }
 218
 219    /* Now list slots occupied */
 220    changer = edit_device_codes(jcr, changer, jcr->device->changer_command, "list");
 221    bnet_fsend(dir, _("3306 Issuing autochanger \"list\" command.\n"));
 222    bpipe = open_bpipe(changer, timeout, "r");
 223    if (!bpipe) {
 224       bnet_fsend(dir, _("3993 Open bpipe failed.\n"));
 225       goto bail_out;
 226    }
 227    /* Get output from changer */
 228    while (fgets(dir->msg, len, bpipe->rfd)) {
 229       dir->msglen = strlen(dir->msg);
 230       bnet_send(dir);
 231    }
 232    bnet_sig(dir, BNET_EOD);
 233    close_bpipe(bpipe);
 234
 235 bail_out:
 236    free_pool_memory(changer);
 237    return 1;
 238 }
 239
 240
 241
 242 /*
 243  * Edit codes into ChangerCommand
 244  *  %% = %
 245  *  %a = archive device name
 246  *  %c = changer device name
 247  *  %d = changer drive index
 248  *  %f = Client's name
 249  *  %j = Job name
 250  *  %o = command
 251  *  %s = Slot base 0
 252  *  %S = Slot base 1
 253  *  %v = Volume name
 254  *
 255  *
 256  *  omsg = edited output message
 257  *  imsg = input string containing edit codes (%x)
 258  *  cmd = command string (load, unload, ...)
 259  *
 260  */
 261 char *edit_device_codes(JCR *jcr, char *omsg, char *imsg, char *cmd)
 262 {
 263    char *p;
 264    const char *str;
 265    char add[20];
 266
 267    *omsg = 0;
 268    Dmsg1(400, "edit_device_codes: %s\n", imsg);
 269    for (p=imsg; *p; p++) {
 270       if (*p == '%') {
 271          switch (*++p) {
 272          case '%':
 273             str = "%";
 274             break;
 275          case 'a':
 276             str = dev_name(jcr->device->dev);
 277             break;
 278          case 'c':
 279             str = NPRT(jcr->device->changer_name);
 280             break;
 281          case 'd':
 282             sprintf(add, "%d", jcr->device->dev->drive_index);
 283             str = add;
 284             break;
 285          case 'o':
 286             str = NPRT(cmd);
 287             break;
 288          case 's':
 289             sprintf(add, "%d", jcr->VolCatInfo.Slot - 1);
 290             str = add;
 291             break;
 292          case 'S':
 293             sprintf(add, "%d", jcr->VolCatInfo.Slot);
 294             str = add;
 295             break;
 296          case 'j':                    /* Job name */
 297             str = jcr->Job;
 298             break;
 299          case 'v':
 300             str = NPRT(jcr->VolumeName);
 301             break;
 302          case 'f':
 303             str = NPRT(jcr->client_name);
 304             break;
 305
 306          default:
 307             add[0] = '%';
 308             add[1] = *p;
 309             add[2] = 0;
 310             str = add;
 311             break;
 312          }
 313       } else {
 314          add[0] = *p;
 315          add[1] = 0;
 316          str = add;
 317       }
 318       Dmsg1(400, "add_str %s\n", str);
 319       pm_strcat(&omsg, (char *)str);
 320       Dmsg1(400, "omsg=%s\n", omsg);
 321    }
 322    return omsg;
 323 }