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

   1 /*
   2  *
   3  *  Routines for handling mounting tapes for reading and for
   4  *    writing.
   5  *
   6  *   Kern Sibbald, August MMII
   7  *
   8  *   Version $Id$
   9  */
  10 /*
  11    Copyright (C) 2000-2003 Kern Sibbald and John Walker
  12
  13    This program is free software; you can redistribute it and/or
  14    modify it under the terms of the GNU General Public License as
  15    published by the Free Software Foundation; either version 2 of
  16    the License, or (at your option) any later version.
  17
  18    This program is distributed in the hope that it will be useful,
  19    but WITHOUT ANY WARRANTY; without even the implied warranty of
  20    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  21    General Public License for more details.
  22
  23    You should have received a copy of the GNU General Public
  24    License along with this program; if not, write to the Free
  25    Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  26    MA 02111-1307, USA.
  27
  28  */
  29
  30 #include "bacula.h"                   /* pull in global headers */
  31 #include "stored.h"                   /* pull in Storage Deamon headers */
  32
  33 /* Forward referenced functions */
  34 static char *edit_device_codes(JCR *jcr, char *omsg, char *imsg, char *cmd);
  35
  36
  37 /*
  38  * If release is set, we rewind the current volume,
  39  * which we no longer want, and ask the user (console)
  40  * to mount the next volume.
  41  *
  42  *  Continue trying until we get it, and then ensure
  43  *  that we can write on it.
  44  *
  45  * This routine returns a 0 only if it is REALLY
  46  *  impossible to get the requested Volume.
  47  */
  48 int mount_next_write_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block, int release)
  49 {
  50    int recycle, ask, retry = 0, autochanger;
  51
  52    Dmsg0(100, "Enter mount_next_volume()\n");
  53
  54 mount_next_vol:
  55    if (retry++ > 5) {
  56       Jmsg(jcr, M_FATAL, 0, _("Too many errors trying to mount device %s.\n"), dev_name(dev));
  57       return 0;
  58    }
  59    if (job_cancelled(jcr)) {
  60       Jmsg(jcr, M_FATAL, 0, _("Job cancelled.\n"));
  61       return 0;
  62    }
  63    recycle = ask = autochanger = 0;
  64    if (release) {
  65       Dmsg0(100, "mount_next_volume release=1\n");
  66       /*
  67        * First erase all memory of the current volume
  68        */
  69       dev->block_num = dev->file = 0;
  70       dev->EndBlock = dev->EndFile = 0;
  71       memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
  72       memset(&jcr->VolCatInfo, 0, sizeof(jcr->VolCatInfo));
  73       memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
  74       dev->state &= ~ST_LABEL;        /* label not yet read */
  75       jcr->VolumeName[0] = 0;
  76
  77       if (!dev_is_tape(dev) || !(dev->capabilities & CAP_ALWAYSOPEN)) {
  78          if (dev->capabilities & CAP_OFFLINEUNMOUNT) {
  79             offline_dev(dev);
  80          }
  81          close_dev(dev);
  82       }
  83
  84       /* If we have not closed the device, then at least rewind the tape */
  85       if (dev->state & ST_OPENED) {
  86          if (dev->capabilities & CAP_OFFLINEUNMOUNT) {
  87             offline_dev(dev);
  88          }
  89          if (!rewind_dev(dev)) {
  90             Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device %s. ERR=%s\n"),
  91                   dev_name(dev), strerror_dev(dev));
  92          }
  93       }
  94       ask = 1;                        /* ask operator to mount tape */
  95    }
  96
  97    /*
  98     * Get Director's idea of what tape we should have mounted.
  99     */
 100    if (!dir_find_next_appendable_volume(jcr)) {
 101       ask = 1;                     /* we must ask */
 102       Dmsg0(100, "did not find next volume. Must ask.\n");
 103    }
 104    Dmsg2(100, "After find_next_append. Vol=%s Slot=%d\n",
 105       jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
 106    release = 1;                       /* release if we "recurse" */
 107
 108    /*
 109     * Get next volume and ready it for append
 110     * This code ensures that the device is ready for
 111     * writing. We start from the assumption that there
 112     * may not be a tape mounted.
 113     *
 114     * If the device is a file, we create the output
 115     * file. If it is a tape, we check the volume name
 116     * and move the tape to the end of data.
 117     *
 118     * It assumes that the device is not already in use!
 119     *
 120     */
 121
 122    Dmsg0(100, "Enter ready_dev_for_append\n");
 123
 124    dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
 125
 126    jcr->VolFirstFile = jcr->JobFiles; /* first update of Vol FileIndex */
 127    for ( ;; ) {
 128       autochanger = autoload_device(jcr, dev, 1, NULL);
 129       if (autochanger) {
 130          ask = 0;                     /* if autochange no need to ask sysop */
 131       }
 132
 133       if (ask && !dir_ask_sysop_to_mount_next_volume(jcr, dev)) {
 134          Dmsg0(100, "Error return ask_sysop ...\n");
 135          return 0;              /* error return */
 136       }
 137       Dmsg1(100, "want vol=%s\n", jcr->VolumeName);
 138
 139       /* Open device */
 140       for ( ; !(dev->state & ST_OPENED); ) {
 141           if (open_dev(dev, jcr->VolCatInfo.VolCatName, READ_WRITE) < 0) {
 142              if (dev->dev_errno == EAGAIN || dev->dev_errno == EBUSY) {
 143                 sleep(30);
 144              }
 145              Jmsg2(jcr, M_FATAL, 0, _("Unable to open device %s. ERR=%s\n"),
 146                 dev_name(dev), strerror_dev(dev));
 147              return 0;
 148           }
 149       }
 150
 151       /*
 152        * Now make sure we have the right tape mounted
 153        */
 154 read_volume:
 155       switch (read_dev_volume_label(jcr, dev, block)) {
 156          case VOL_OK:
 157             Dmsg1(100, "Vol OK name=%s\n", jcr->VolumeName);
 158             memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
 159             if (strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0) {
 160                recycle = 1;
 161             }
 162             break;                    /* got it */
 163          case VOL_NAME_ERROR:
 164             Dmsg1(100, "Vol NAME Error Name=%s\n", jcr->VolumeName);
 165             /*
 166              * OK, we got a different volume mounted. First save the
 167              *  requested Volume info in the dev structure, then query if
 168              *  this volume is really OK. If not, put back the desired
 169              *  volume name and continue.
 170              */
 171             memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
 172             /* Check if this is a valid Volume in the pool */
 173             strcpy(jcr->VolumeName, dev->VolHdr.VolName);
 174             if (!dir_get_volume_info(jcr, 1)) {
 175                Mmsg(&jcr->errmsg, _("Wanted Volume \"%s\".\n\
 176     Actual Volume \"%s\" not acceptable.\n"),
 177                   dev->VolCatInfo.VolCatName, dev->VolHdr.VolName);
 178                /* Restore desired volume name, note device info out of sync */
 179                memcpy(&jcr->VolCatInfo, &dev->VolCatInfo, sizeof(jcr->VolCatInfo));
 180                goto mount_error;
 181             }
 182             Dmsg1(100, "want new name=%s\n", jcr->VolumeName);
 183             memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
 184             break;
 185
 186          case VOL_NO_LABEL:
 187          case VOL_IO_ERROR:
 188             Dmsg1(500, "Vol NO_LABEL or IO_ERROR name=%s\n", jcr->VolumeName);
 189             /* If permitted, create a label */
 190             if (dev->capabilities & CAP_LABEL) {
 191                Dmsg0(100, "Create volume label\n");
 192                if (!write_volume_label_to_dev(jcr, (DEVRES *)dev->device, jcr->VolumeName,
 193                       jcr->pool_name)) {
 194                   Dmsg0(100, "!write_vol_label\n");
 195                   goto mount_next_vol;
 196                }
 197                Jmsg(jcr, M_INFO, 0, _("Created Volume label %s on device %s.\n"),
 198                   jcr->VolumeName, dev_name(dev));
 199                goto read_volume;      /* read label we just wrote */
 200             }
 201             /* NOTE! Fall-through wanted. */
 202          default:
 203 mount_error:
 204             /* Send error message */
 205             Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
 206             if (autochanger) {
 207                Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n\
 208     Setting slot to zero in catalog.\n"),
 209                   jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
 210                jcr->VolCatInfo.Slot = 0; /* invalidate slot */
 211                Dmsg0(200, "update vol info in mount\n");
 212                dir_update_volume_info(jcr, &jcr->VolCatInfo, 1);  /* set slot */
 213             }
 214             Dmsg0(100, "Default\n");
 215             goto mount_next_vol;
 216       }
 217       break;
 218    }
 219
 220    /*
 221     * See if we have a fresh tape or tape with data.
 222     *
 223     * Note, if the LabelType is PRE_LABEL, it was labeled
 224     *  but never written. If so, rewrite the label but set as
 225     *  VOL_LABEL.  We rewind and return the label (reconstructed)
 226     *  in the block so that in the case of a new tape, data can
 227     *  be appended just after the block label.  If we are writing
 228     *  an second volume, the calling routine will write the label
 229     *  before writing the overflow block.
 230     *
 231     *  If the tape is marked as Recycle, we rewrite the label.
 232     */
 233    if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
 234       Dmsg1(190, "ready_for_append found freshly labeled volume. dev=%x\n", dev);
 235       dev->VolHdr.LabelType = VOL_LABEL; /* set Volume label */
 236       write_volume_label_to_block(jcr, dev, block);
 237       /*
 238        * Write the block now to ensure we have write permission.
 239        *  It is better to find out now rather than later.
 240        */
 241       dev->VolCatInfo.VolCatBytes = 0;
 242       if (!rewind_dev(dev)) {
 243          Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device %s. ERR=%s\n"),
 244                dev_name(dev), strerror_dev(dev));
 245       }
 246       if (recycle) {
 247          if (!truncate_dev(dev)) {
 248             Jmsg2(jcr, M_WARNING, 0, _("Truncate error on device %s. ERR=%s\n"),
 249                   dev_name(dev), strerror_dev(dev));
 250          }
 251       }
 252       /* Attempt write to check write permission */
 253       if (!write_block_to_dev(jcr, dev, block)) {
 254          Jmsg2(jcr, M_ERROR, 0, _("Unable to write device %s. ERR=%s\n"),
 255             dev_name(dev), strerror_dev(dev));
 256          goto mount_next_vol;
 257       }
 258       if (!rewind_dev(dev)) {
 259          Jmsg2(jcr, M_ERROR, 0, _("Unable to rewind device %s. ERR=%s\n"),
 260             dev_name(dev), strerror_dev(dev));
 261          goto mount_next_vol;
 262       }
 263
 264       /* Recreate a correct volume label and return it in the block */
 265       write_volume_label_to_block(jcr, dev, block);
 266       /* Set or reset Volume statistics */
 267       dev->VolCatInfo.VolCatJobs = 0;
 268       dev->VolCatInfo.VolCatFiles = 0;
 269       dev->VolCatInfo.VolCatErrors = 0;
 270       dev->VolCatInfo.VolCatBlocks = 0;
 271       if (recycle) {
 272          dev->VolCatInfo.VolCatMounts++;
 273          dev->VolCatInfo.VolCatRecycles++;
 274       } else {
 275          dev->VolCatInfo.VolCatMounts = 1;
 276          dev->VolCatInfo.VolCatRecycles = 0;
 277          dev->VolCatInfo.VolCatWrites = 1;
 278          dev->VolCatInfo.VolCatReads = 1;
 279       }
 280       strcpy(dev->VolCatInfo.VolCatStatus, "Append");
 281       Dmsg0(200, "dir_update_vol_info. Set Append\n");
 282       dir_update_volume_info(jcr, &dev->VolCatInfo, 1);  /* indicate doing relabel */
 283       if (recycle) {
 284          Jmsg(jcr, M_INFO, 0, _("Recycled volume %s on device %s, all previous data lost.\n"),
 285             jcr->VolumeName, dev_name(dev));
 286       } else {
 287          Jmsg(jcr, M_INFO, 0, _("Wrote label to prelabeled Volume %s on device %s\n"),
 288             jcr->VolumeName, dev_name(dev));
 289       }
 290
 291    } else {
 292       /*
 293        * OK, at this point, we have a valid Bacula label, but
 294        * we need to position to the end of the volume, since we are
 295        * just now putting it into append mode.
 296        */
 297       Dmsg0(200, "Device previously written, moving to end of data\n");
 298       Jmsg(jcr, M_INFO, 0, _("Volume %s previously written, moving to end of data.\n"),
 299          jcr->VolumeName);
 300       if (!eod_dev(dev)) {
 301          Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data %s. ERR=%s\n"),
 302             dev_name(dev), strerror_dev(dev));
 303          Jmsg(jcr, M_INFO, 0, _("Marking Volume %s in Error in Catalog.\n"),
 304             jcr->VolumeName);
 305          strcpy(dev->VolCatInfo.VolCatStatus, "Error");
 306          Dmsg0(200, "dir_update_vol_info. Set Error.\n");
 307          dir_update_volume_info(jcr, &dev->VolCatInfo, 0);
 308          goto mount_next_vol;
 309       }
 310       /* *****FIXME**** we should do some checking for files too */
 311       if (dev_is_tape(dev)) {
 312          /*
 313           * Check if we are positioned on the tape at the same place
 314           * that the database says we should be.
 315           */
 316          if (dev->VolCatInfo.VolCatFiles == dev_file(dev) + 1) {
 317             Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume at file=%d.\n"),
 318                  dev_file(dev));
 319          } else {
 320             Jmsg(jcr, M_ERROR, 0, _("I canot write on this volume because:\n\
 321 The number of files mismatch! Volume=%d Catalog=%d\n"),
 322                  dev_file(dev)+1, dev->VolCatInfo.VolCatFiles);
 323             strcpy(dev->VolCatInfo.VolCatStatus, "Error");
 324             Dmsg0(200, "dir_update_vol_info. Set Error.\n");
 325             dir_update_volume_info(jcr, &dev->VolCatInfo, 0);
 326             goto mount_next_vol;
 327          }
 328       }
 329       dev->VolCatInfo.VolCatMounts++;      /* Update mounts */
 330       Dmsg1(200, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
 331       dir_update_volume_info(jcr, &dev->VolCatInfo, 0);
 332       /* Return an empty block */
 333       empty_block(block);             /* we used it for reading so set for write */
 334    }
 335    dev->state |= ST_APPEND;
 336    Dmsg0(100, "Normal return from read_dev_for_append\n");
 337    return 1;
 338 }
 339
 340
 341 int mount_next_read_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
 342 {
 343    Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
 344    /*
 345     * End Of Tape -- mount next Volume (if another specified)
 346     */
 347    if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
 348       close_dev(dev);
 349       dev->state &= ~ST_READ;
 350       if (!acquire_device_for_read(jcr, dev, block)) {
 351          Emsg2(M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev_name(dev),
 352                jcr->VolumeName);
 353          return 0;
 354       }
 355       return 1;                       /* next volume mounted */
 356    }
 357    Dmsg0(90, "End of Device reached.\n");
 358    return 0;
 359 }
 360
 361 /*
 362  * Called here to do an autoload using the autochanger, if
 363  *  configured, and if a Slot has been defined for this Volume.
 364  *  On success this routine loads the indicated tape, but the
 365  *  label is not read, so it must be verified.
 366  *
 367  *  Note if dir is not NULL, it is the console requesting the
 368  *   autoload for labeling, so we respond directly to the
 369  *   dir bsock.
 370  *
 371  *  Returns: 1 on success
 372  *           0 on failure
 373  */
 374 int autoload_device(JCR *jcr, DEVICE *dev, int writing, BSOCK *dir)
 375 {
 376    int slot = jcr->VolCatInfo.Slot;
 377    int rtn_stat = 0;
 378
 379    /*
 380     * Handle autoloaders here.  If we cannot autoload it, we
 381     *  will return FALSE to ask the sysop.
 382     */
 383    if (writing && dev->capabilities && CAP_AUTOCHANGER && slot <= 0) {
 384       if (dir) {
 385          return 0;                    /* For user, bail out right now */
 386       }
 387       if (dir_find_next_appendable_volume(jcr)) {
 388          slot = jcr->VolCatInfo.Slot;
 389       }
 390    }
 391    Dmsg1(100, "Want changer slot=%d\n", slot);
 392
 393    if (slot > 0 && jcr->device->changer_name && jcr->device->changer_command) {
 394       uint32_t timeout = jcr->device->max_changer_wait;
 395       POOLMEM *changer, *results;
 396       int status, loaded;
 397
 398       results = get_pool_memory(PM_MESSAGE);
 399       changer = get_pool_memory(PM_FNAME);
 400
 401       /* Find out what is loaded, zero means device is unloaded */
 402       changer = edit_device_codes(jcr, changer, jcr->device->changer_command,
 403                    "loaded");
 404       status = run_program(changer, timeout, results);
 405       if (status == 0) {
 406          loaded = atoi(results);
 407       } else {
 408          loaded = -1;              /* force unload */
 409       }
 410       Dmsg1(100, "loaded=%s\n", results);
 411
 412       /* If bad status or tape we want is not loaded, load it. */
 413       if (status != 0 || loaded != slot) {
 414          if (dev->capabilities & CAP_OFFLINEUNMOUNT) {
 415             offline_dev(dev);
 416          }
 417          /* We are going to load a new tape, so close the device */
 418          force_close_dev(dev);
 419          if (loaded != 0) {        /* must unload drive */
 420             Dmsg0(100, "Doing changer unload.\n");
 421             if (dir) {
 422                bnet_fsend(dir, _("3902 Issuing autochanger \"unload\" command.\n"));
 423             } else {
 424                Jmsg(jcr, M_INFO, 0, _("Issuing autochanger \"unload\" command.\n"));
 425             }
 426             changer = edit_device_codes(jcr, changer,
 427                         jcr->device->changer_command, "unload");
 428             status = run_program(changer, timeout, NULL);
 429             Dmsg1(100, "unload status=%d\n", status);
 430          }
 431          /*
 432           * Load the desired cassette
 433           */
 434          Dmsg1(100, "Doing changer load slot %d\n", slot);
 435          if (dir) {
 436             bnet_fsend(dir, _("3903 Issuing autochanger \"load slot %d\" command.\n"),
 437                slot);
 438          } else {
 439             Jmsg(jcr, M_INFO, 0, _("Issuing autochanger \"load slot %d\" command.\n"),
 440                slot);
 441          }
 442          changer = edit_device_codes(jcr, changer,
 443                       jcr->device->changer_command, "load");
 444          status = run_program(changer, timeout, NULL);
 445          Dmsg2(100, "load slot %d status=%d\n", slot, status);
 446       }
 447       free_pool_memory(changer);
 448       free_pool_memory(results);
 449       Dmsg1(100, "After changer, status=%d\n", status);
 450       if (status == 0) {           /* did we succeed? */
 451          rtn_stat = 1;             /* tape loaded by changer */
 452       }
 453    }
 454    return rtn_stat;
 455 }
 456
 457
 458
 459 /*
 460  * Edit codes into ChangerCommand
 461  *  %% = %
 462  *  %a = archive device name
 463  *  %c = changer device name
 464  *  %f = Client's name
 465  *  %j = Job name
 466  *  %o = command
 467  *  %s = Slot base 0
 468  *  %S = Slot base 1
 469  *  %v = Volume name
 470  *
 471  *
 472  *  omsg = edited output message
 473  *  imsg = input string containing edit codes (%x)
 474  *  cmd = command string (load, unload, ...)
 475  *
 476  */
 477 static char *edit_device_codes(JCR *jcr, char *omsg, char *imsg, char *cmd)
 478 {
 479    char *p;
 480    const char *str;
 481    char add[20];
 482
 483    *omsg = 0;
 484    Dmsg1(200, "edit_device_codes: %s\n", imsg);
 485    for (p=imsg; *p; p++) {
 486       if (*p == '%') {
 487          switch (*++p) {
 488          case '%':
 489             str = "%";
 490             break;
 491          case 'a':
 492             str = jcr->device->dev->dev_name;
 493             break;
 494          case 'c':
 495             str = NPRT(jcr->device->changer_name);
 496             break;
 497          case 'o':
 498             str = NPRT(cmd);
 499             break;
 500          case 's':
 501             sprintf(add, "%d", jcr->VolCatInfo.Slot - 1);
 502             str = add;
 503             break;
 504          case 'S':
 505             sprintf(add, "%d", jcr->VolCatInfo.Slot);
 506             str = add;
 507             break;
 508          case 'j':                    /* Job name */
 509             str = jcr->Job;
 510             break;
 511          case 'v':
 512             str = NPRT(jcr->VolumeName);
 513             break;
 514          case 'f':
 515             str = NPRT(jcr->client_name);
 516             break;
 517
 518          default:
 519             add[0] = '%';
 520             add[1] = *p;
 521             add[2] = 0;
 522             str = add;
 523             break;
 524          }
 525       } else {
 526          add[0] = *p;
 527          add[1] = 0;
 528          str = add;
 529       }
 530       Dmsg1(200, "add_str %s\n", str);
 531       pm_strcat(&omsg, (char *)str);
 532       Dmsg1(200, "omsg=%s\n", omsg);
 533    }
 534    return omsg;
 535 }