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, 2001, 2002 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 = 0;
  70       dev->file = 0;
  71       dev->LastBlockNumWritten = 0;
  72       memset(&dev->VolCatInfo, 0, sizeof(dev->VolCatInfo));
  73       memset(&jcr->VolCatInfo, 0, sizeof(jcr->VolCatInfo));
  74       memset(&dev->VolHdr, 0, sizeof(dev->VolHdr));
  75       dev->state &= ~ST_LABEL;        /* label not yet read */
  76       jcr->VolumeName[0] = 0;
  77
  78       if (!dev_is_tape(dev) || !(dev->capabilities & CAP_ALWAYSOPEN)) {
  79          if (dev->capabilities & CAP_OFFLINEUNMOUNT) {
  80             offline_dev(dev);
  81          }
  82          close_dev(dev);
  83       }
  84
  85       /* If we have not closed the device, then at least rewind the tape */
  86       if (dev->state & ST_OPENED) {
  87          if (dev->capabilities & CAP_OFFLINEUNMOUNT) {
  88             offline_dev(dev);
  89          }
  90          if (!rewind_dev(dev)) {
  91             Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device %s. ERR=%s\n"),
  92                   dev_name(dev), strerror_dev(dev));
  93          }
  94       }
  95       ask = 1;                        /* ask operator to mount tape */
  96    }
  97
  98    /*
  99     * Get Director's idea of what tape we should have mounted.
 100     */
 101    if (!dir_find_next_appendable_volume(jcr)) {
 102       ask = 1;                     /* we must ask */
 103       Dmsg0(100, "did not find next volume. Must ask.\n");
 104    }
 105    Dmsg2(100, "After find_next_append. Vol=%s Slot=%d\n",
 106       jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
 107    release = 1;                       /* release if we "recurse" */
 108
 109    /*
 110     * Get next volume and ready it for append
 111     * This code ensures that the device is ready for
 112     * writing. We start from the assumption that there
 113     * may not be a tape mounted.
 114     *
 115     * If the device is a file, we create the output
 116     * file. If it is a tape, we check the volume name
 117     * and move the tape to the end of data.
 118     *
 119     * It assumes that the device is not already in use!
 120     *
 121     */
 122
 123    Dmsg0(100, "Enter ready_dev_for_append\n");
 124
 125    dev->state &= ~(ST_APPEND|ST_READ|ST_EOT|ST_WEOT|ST_EOF);
 126
 127    jcr->VolFirstFile = jcr->JobFiles; /* first update of Vol FileIndex */
 128    for ( ;; ) {
 129       autochanger = autoload_device(jcr, dev, 1, NULL);
 130       if (autochanger) {
 131          ask = 0;                     /* if autochange no need to ask sysop */
 132       }
 133
 134       if (ask && !dir_ask_sysop_to_mount_next_volume(jcr, dev)) {
 135          Dmsg0(100, "Error return ask_sysop ...\n");
 136          return 0;              /* error return */
 137       }
 138       Dmsg1(100, "want vol=%s\n", jcr->VolumeName);
 139
 140       /* Open device */
 141       for ( ; !(dev->state & ST_OPENED); ) {
 142           if (open_dev(dev, jcr->VolCatInfo.VolCatName, READ_WRITE) < 0) {
 143              if (dev->dev_errno == EAGAIN || dev->dev_errno == EBUSY) {
 144                 sleep(30);
 145              }
 146              Jmsg2(jcr, M_FATAL, 0, _("Unable to open device %s. ERR=%s\n"),
 147                 dev_name(dev), strerror_dev(dev));
 148              return 0;
 149           }
 150       }
 151
 152       /*
 153        * Now make sure we have the right tape mounted
 154        */
 155 read_volume:
 156       switch (read_dev_volume_label(jcr, dev, block)) {
 157          case VOL_OK:
 158             Dmsg1(100, "Vol OK name=%s\n", jcr->VolumeName);
 159             memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
 160             if (strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0) {
 161                recycle = 1;
 162             }
 163             break;                    /* got it */
 164          case VOL_NAME_ERROR:
 165             Dmsg1(100, "Vol NAME Error Name=%s\n", jcr->VolumeName);
 166             /*
 167              * OK, we got a different volume mounted. First save the
 168              *  requested Volume info in the dev structure, then query if
 169              *  this volume is really OK. If not, put back the desired
 170              *  volume name and continue.
 171              */
 172             memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
 173             /* Check if this is a valid Volume in the pool */
 174             strcpy(jcr->VolumeName, dev->VolHdr.VolName);
 175             if (!dir_get_volume_info(jcr, 1)) {
 176                Mmsg(&jcr->errmsg, _("Wanted Volume \"%s\".\n\
 177     Actual Volume \"%s\" not acceptable.\n"),
 178                   dev->VolCatInfo.VolCatName, dev->VolHdr.VolName);
 179                /* Restore desired volume name, note device info out of sync */
 180                memcpy(&jcr->VolCatInfo, &dev->VolCatInfo, sizeof(jcr->VolCatInfo));
 181                goto mount_error;
 182             }
 183             Dmsg1(100, "want new name=%s\n", jcr->VolumeName);
 184             memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
 185             break;
 186
 187          case VOL_NO_LABEL:
 188          case VOL_IO_ERROR:
 189             Dmsg1(500, "Vol NO_LABEL or IO_ERROR name=%s\n", jcr->VolumeName);
 190             /* If permitted, create a label */
 191             if (dev->capabilities & CAP_LABEL) {
 192                Dmsg0(100, "Create volume label\n");
 193                if (!write_volume_label_to_dev(jcr, (DEVRES *)dev->device, jcr->VolumeName,
 194                       jcr->pool_name)) {
 195                   Dmsg0(100, "!write_vol_label\n");
 196                   goto mount_next_vol;
 197                }
 198                Jmsg(jcr, M_INFO, 0, _("Created Volume label %s on device %s.\n"),
 199                   jcr->VolumeName, dev_name(dev));
 200                goto read_volume;      /* read label we just wrote */
 201             }
 202             /* NOTE! Fall-through wanted. */
 203          default:
 204 mount_error:
 205             /* Send error message */
 206             Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
 207             if (autochanger) {
 208                Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n\
 209     Setting slot to zero in catalog.\n"),
 210                   jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
 211                jcr->VolCatInfo.Slot = 0; /* invalidate slot */
 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       if (!write_block_to_dev(dev, block)) {
 253          Jmsg2(jcr, M_ERROR, 0, _("Unable to write device %s. ERR=%s\n"),
 254             dev_name(dev), strerror_dev(dev));
 255          goto mount_next_vol;
 256       }
 257       if (!rewind_dev(dev)) {
 258          Jmsg2(jcr, M_ERROR, 0, _("Unable to rewind device %s. ERR=%s\n"),
 259             dev_name(dev), strerror_dev(dev));
 260          goto mount_next_vol;
 261       }
 262       /* Recreate a correct volume label and return it in the block */
 263       write_volume_label_to_block(jcr, dev, block);
 264       dev->VolCatInfo.VolCatJobs = 1;
 265       dev->VolCatInfo.VolCatFiles = 1;
 266       dev->VolCatInfo.VolCatErrors = 0;
 267       dev->VolCatInfo.VolCatBlocks = 1;
 268       if (recycle) {
 269          dev->VolCatInfo.VolCatMounts++;
 270          dev->VolCatInfo.VolCatRecycles++;
 271       } else {
 272          dev->VolCatInfo.VolCatMounts = 1;
 273          dev->VolCatInfo.VolCatRecycles = 0;
 274          dev->VolCatInfo.VolCatWrites = 1;
 275          dev->VolCatInfo.VolCatReads = 1;
 276       }
 277       strcpy(dev->VolCatInfo.VolCatStatus, "Append");
 278       Dmsg0(100, "dir_update_vol_info. Set Append\n");
 279       dir_update_volume_info(jcr, &dev->VolCatInfo, 1);  /* indicate doing relabel */
 280       if (recycle) {
 281          Jmsg(jcr, M_INFO, 0, _("Recycled volume %s on device %s, all previous data lost.\n"),
 282             jcr->VolumeName, dev_name(dev));
 283       } else {
 284          Jmsg(jcr, M_INFO, 0, _("Wrote label to prelabeled Volume %s on device %s\n"),
 285             jcr->VolumeName, dev_name(dev));
 286       }
 287
 288    } else {
 289       /*
 290        * OK, at this point, we have a valid Bacula label, but
 291        * we need to position to the end of the volume, since we are
 292        * just now putting it into append mode.
 293        */
 294       Dmsg0(200, "Device previously written, moving to end of data\n");
 295       Jmsg(jcr, M_INFO, 0, _("Volume %s previously written, moving to end of data.\n"),
 296          jcr->VolumeName);
 297       if (!eod_dev(dev)) {
 298          Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data %s. ERR=%s\n"),
 299             dev_name(dev), strerror_dev(dev));
 300          Jmsg(jcr, M_INFO, 0, _("Marking Volume %s in Error in Catalog.\n"),
 301             jcr->VolumeName);
 302          strcpy(dev->VolCatInfo.VolCatStatus, "Error");
 303          Dmsg0(100, "dir_update_vol_info. Set Error.\n");
 304          dir_update_volume_info(jcr, &dev->VolCatInfo, 0);
 305          goto mount_next_vol;
 306       }
 307       /* *****FIXME**** we should do some checking for files too */
 308       if (dev_is_tape(dev)) {
 309          /*
 310           * Check if we are positioned on the tape at the same place
 311           * that the database says we should be.
 312           */
 313          if (dev->VolCatInfo.VolCatFiles == dev_file(dev) + 1) {
 314             Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume at file=%d.\n"),
 315                  dev_file(dev));
 316          } else {
 317             Jmsg(jcr, M_ERROR, 0, _("I canot write on this volume because:\n\
 318 The number of files mismatch! Volume=%d Catalog=%d\n"),
 319                  dev_file(dev)+1, dev->VolCatInfo.VolCatFiles);
 320             strcpy(dev->VolCatInfo.VolCatStatus, "Error");
 321             Dmsg0(100, "dir_update_vol_info. Set Error.\n");
 322             dir_update_volume_info(jcr, &dev->VolCatInfo, 0);
 323             goto mount_next_vol;
 324          }
 325       }
 326       /* Update Volume Info -- will be written at end of Job */
 327       dev->VolCatInfo.VolCatMounts++;      /* Update mounts */
 328       dev->VolCatInfo.VolCatJobs++;
 329       /* Return an empty block */
 330       empty_block(block);             /* we used it for reading so set for write */
 331    }
 332    dev->state |= ST_APPEND;
 333    Dmsg0(100, "Normal return from read_dev_for_append\n");
 334    return 1;
 335 }
 336
 337
 338 int mount_next_read_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
 339 {
 340    Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
 341    /*
 342     * End Of Tape -- mount next Volume (if another specified)
 343     */
 344    if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
 345       VOL_LIST *vol = jcr->VolList;
 346       /* Find next Volume */
 347       jcr->CurVolume++;
 348       for (int i=1; i<jcr->CurVolume; i++) {
 349          vol = vol->next;
 350       }
 351       pm_strcpy(&jcr->VolumeName, vol->VolumeName);
 352       Dmsg1(400, "There is another volume %s.\n", jcr->VolumeName);
 353
 354       close_dev(dev);
 355       dev->state &= ~ST_READ;
 356       if (!acquire_device_for_read(jcr, dev, block)) {
 357          Emsg2(M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev_name(dev),
 358                jcr->VolumeName);
 359          return 0;
 360       }
 361       return 1;                       /* next volume mounted */
 362    }
 363    Dmsg0(90, "End of Device reached.\n");
 364    return 0;
 365 }
 366
 367 /*
 368  * Called here to do an autoload using the autochanger, if
 369  *  configured, and if a Slot has been defined for this Volume.
 370  *  On success this routine loads the indicated tape, but the
 371  *  label is not read, so it must be verified.
 372  *
 373  *  Note if dir is not NULL, it is the console requesting the
 374  *   autoload for labeling, so we respond directly to the
 375  *   dir bsock.
 376  *
 377  *  Returns: 1 on success
 378  *           0 on failure
 379  */
 380 int autoload_device(JCR *jcr, DEVICE *dev, int writing, BSOCK *dir)
 381 {
 382    int slot = jcr->VolCatInfo.Slot;
 383    int rtn_stat = 0;
 384
 385    /*
 386     * Handle autoloaders here.  If we cannot autoload it, we
 387     *  will return FALSE to ask the sysop.
 388     */
 389    if (writing && dev->capabilities && CAP_AUTOCHANGER && slot <= 0) {
 390       if (dir) {
 391          return 0;                    /* For user, bail out right now */
 392       }
 393       if (dir_find_next_appendable_volume(jcr)) {
 394          slot = jcr->VolCatInfo.Slot;
 395       }
 396    }
 397    Dmsg1(100, "Want changer slot=%d\n", slot);
 398
 399    if (slot > 0 && jcr->device->changer_name && jcr->device->changer_command) {
 400       uint32_t timeout = jcr->device->max_changer_wait;
 401       POOLMEM *changer, *results;
 402       int status, loaded;
 403
 404       results = get_pool_memory(PM_MESSAGE);
 405       changer = get_pool_memory(PM_FNAME);
 406
 407       /* Find out what is loaded, zero means device is unloaded */
 408       changer = edit_device_codes(jcr, changer, jcr->device->changer_command,
 409                    "loaded");
 410       status = run_program(changer, timeout, results);
 411       if (status == 0) {
 412          loaded = atoi(results);
 413       } else {
 414          loaded = -1;              /* force unload */
 415       }
 416       Dmsg1(100, "loaded=%s\n", results);
 417
 418       /* If bad status or tape we want is not loaded, load it. */
 419       if (status != 0 || loaded != slot) {
 420          if (dev->capabilities & CAP_OFFLINEUNMOUNT) {
 421             offline_dev(dev);
 422          }
 423          /* We are going to load a new tape, so close the device */
 424          force_close_dev(dev);
 425          if (loaded != 0) {        /* must unload drive */
 426             Dmsg0(100, "Doing changer unload.\n");
 427             if (dir) {
 428                bnet_fsend(dir, _("3902 Issuing autochanger \"unload\" command.\n"));
 429             } else {
 430                Jmsg(jcr, M_INFO, 0, _("Issuing autochanger \"unload\" command.\n"));
 431             }
 432             changer = edit_device_codes(jcr, changer,
 433                         jcr->device->changer_command, "unload");
 434             status = run_program(changer, timeout, NULL);
 435             Dmsg1(100, "unload status=%d\n", status);
 436          }
 437          /*
 438           * Load the desired cassette
 439           */
 440          Dmsg1(100, "Doing changer load slot %d\n", slot);
 441          if (dir) {
 442             bnet_fsend(dir, _("3903 Issuing autochanger \"load slot %d\" command.\n"),
 443                slot);
 444          } else {
 445             Jmsg(jcr, M_INFO, 0, _("Issuing autochanger \"load slot %d\" command.\n"),
 446                slot);
 447          }
 448          changer = edit_device_codes(jcr, changer,
 449                       jcr->device->changer_command, "load");
 450          status = run_program(changer, timeout, NULL);
 451          Dmsg2(100, "load slot %d status=%d\n", slot, status);
 452       }
 453       free_pool_memory(changer);
 454       free_pool_memory(results);
 455       Dmsg1(100, "After changer, status=%d\n", status);
 456       if (status == 0) {           /* did we succeed? */
 457          rtn_stat = 1;             /* tape loaded by changer */
 458       }
 459    }
 460    return rtn_stat;
 461 }
 462
 463
 464
 465 /*
 466  * Edit codes into ChangerCommand
 467  *  %% = %
 468  *  %a = archive device name
 469  *  %c = changer device name
 470  *  %f = Client's name
 471  *  %j = Job name
 472  *  %o = command
 473  *  %s = Slot base 0
 474  *  %S = Slot base 1
 475  *  %v = Volume name
 476  *
 477  *
 478  *  omsg = edited output message
 479  *  imsg = input string containing edit codes (%x)
 480  *  cmd = command string (load, unload, ...)
 481  *
 482  */
 483 static char *edit_device_codes(JCR *jcr, char *omsg, char *imsg, char *cmd)
 484 {
 485    char *p;
 486    const char *str;
 487    char add[20];
 488
 489    *omsg = 0;
 490    Dmsg1(200, "edit_device_codes: %s\n", imsg);
 491    for (p=imsg; *p; p++) {
 492       if (*p == '%') {
 493          switch (*++p) {
 494          case '%':
 495             str = "%";
 496             break;
 497          case 'a':
 498             str = jcr->device->dev->dev_name;
 499             break;
 500          case 'c':
 501             str = NPRT(jcr->device->changer_name);
 502             break;
 503          case 'o':
 504             str = NPRT(cmd);
 505             break;
 506          case 's':
 507             sprintf(add, "%d", jcr->VolCatInfo.Slot - 1);
 508             str = add;
 509             break;
 510          case 'S':
 511             sprintf(add, "%d", jcr->VolCatInfo.Slot);
 512             str = add;
 513             break;
 514          case 'j':                    /* Job name */
 515             str = jcr->Job;
 516             break;
 517          case 'v':
 518             str = NPRT(jcr->VolumeName);
 519             break;
 520          case 'f':
 521             str = NPRT(jcr->client_name);
 522             break;
 523
 524          default:
 525             add[0] = '%';
 526             add[1] = *p;
 527             add[2] = 0;
 528             str = add;
 529             break;
 530          }
 531       } else {
 532          add[0] = *p;
 533          add[1] = 0;
 534          str = add;
 535       }
 536       Dmsg1(200, "add_str %s\n", str);
 537       pm_strcat(&omsg, (char *)str);
 538       Dmsg1(200, "omsg=%s\n", omsg);
 539    }
 540    return omsg;
 541 }