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"),
  57            dev_name(dev));
  58       return 0;
  59    }
  60    if (job_cancelled(jcr)) {
  61       Jmsg(jcr, M_FATAL, 0, _("Job cancelled.\n"));
  62       return 0;
  63    }
  64    recycle = ask = autochanger = 0;
  65    if (release) {
  66       Dmsg0(100, "mount_next_volume release=1\n");
  67       /*
  68        * First erase all memory of the current volume
  69        */
  70       dev->block_num = dev->file = 0;
  71       dev->EndBlock = dev->EndFile = 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_cap(dev, CAP_ALWAYSOPEN)) {
  79          if (dev_cap(dev, 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_cap(dev, 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       int vol_label_status;
 130       autochanger = autoload_device(jcr, dev, 1, NULL);
 131       if (autochanger) {
 132          ask = 0;                     /* if autochange no need to ask sysop */
 133       }
 134
 135       if (ask && !dir_ask_sysop_to_mount_next_volume(jcr, dev)) {
 136          Dmsg0(100, "Error return ask_sysop ...\n");
 137          return 0;              /* error return */
 138       }
 139       Dmsg1(100, "want vol=%s\n", jcr->VolumeName);
 140
 141       /* Open device */
 142       for ( ; !(dev->state & ST_OPENED); ) {
 143           int mode;
 144           if (dev_cap(dev, CAP_STREAM)) {
 145              mode = OPEN_WRITE_ONLY;
 146           } else {
 147              mode = OPEN_READ_WRITE;
 148           }
 149           if (open_dev(dev, jcr->VolCatInfo.VolCatName, mode) < 0) {
 150              Jmsg2(jcr, M_FATAL, 0, _("Unable to open device %s. ERR=%s\n"),
 151                 dev_name(dev), strerror_dev(dev));
 152              return 0;
 153           }
 154       }
 155
 156       /*
 157        * Now make sure we have the right tape mounted
 158        */
 159 read_volume:
 160       /*
 161        * If we are writing to a stream device, ASSUME the volume label
 162        *  is correct.
 163        */
 164       if (dev_cap(dev, CAP_STREAM)) {
 165          vol_label_status = VOL_OK;
 166          create_volume_label(dev, jcr->VolumeName);
 167          dev->VolHdr.LabelType = PRE_LABEL;
 168       } else {
 169          vol_label_status = read_dev_volume_label(jcr, dev, block);
 170       }
 171       switch (vol_label_status) {
 172          case VOL_OK:
 173             Dmsg1(100, "Vol OK name=%s\n", jcr->VolumeName);
 174             memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
 175             if (strcmp(dev->VolCatInfo.VolCatStatus, "Recycle") == 0) {
 176                recycle = 1;
 177             }
 178             break;                    /* got it */
 179          case VOL_NAME_ERROR:
 180             Dmsg1(100, "Vol NAME Error Name=%s\n", jcr->VolumeName);
 181             /*
 182              * OK, we got a different volume mounted. First save the
 183              *  requested Volume info in the dev structure, then query if
 184              *  this volume is really OK. If not, put back the desired
 185              *  volume name and continue.
 186              */
 187             memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
 188             /* Check if this is a valid Volume in the pool */
 189             strcpy(jcr->VolumeName, dev->VolHdr.VolName);
 190             if (!dir_get_volume_info(jcr, 1)) {
 191                Mmsg(&jcr->errmsg, _("Wanted Volume \"%s\".\n"
 192                     "    Actual Volume \"%s\" not acceptable because:\n"
 193                     "    %s\n"),
 194                    dev->VolCatInfo.VolCatName, dev->VolHdr.VolName,
 195                    jcr->dir_bsock->msg);
 196                /* Restore desired volume name, note device info out of sync */
 197                memcpy(&jcr->VolCatInfo, &dev->VolCatInfo, sizeof(jcr->VolCatInfo));
 198                goto mount_error;
 199             }
 200             Dmsg1(100, "want new name=%s\n", jcr->VolumeName);
 201             memcpy(&dev->VolCatInfo, &jcr->VolCatInfo, sizeof(jcr->VolCatInfo));
 202             break;
 203
 204          case VOL_NO_LABEL:
 205          case VOL_IO_ERROR:
 206             Dmsg1(500, "Vol NO_LABEL or IO_ERROR name=%s\n", jcr->VolumeName);
 207             /* If permitted, create a label */
 208             if (dev_cap(dev, CAP_LABEL)) {
 209                Dmsg0(100, "Create volume label\n");
 210                if (!write_volume_label_to_dev(jcr, (DEVRES *)dev->device, jcr->VolumeName,
 211                       jcr->pool_name)) {
 212                   Dmsg0(100, "!write_vol_label\n");
 213                   goto mount_next_vol;
 214                }
 215                Jmsg(jcr, M_INFO, 0, _("Created Volume label %s on device %s.\n"),
 216                   jcr->VolumeName, dev_name(dev));
 217                goto read_volume;      /* read label we just wrote */
 218             }
 219             /* NOTE! Fall-through wanted. */
 220          default:
 221 mount_error:
 222             /* Send error message */
 223             Jmsg1(jcr, M_WARNING, 0, "%s", jcr->errmsg);
 224             if (autochanger) {
 225                Jmsg(jcr, M_ERROR, 0, _("Autochanger Volume \"%s\" not found in slot %d.\n\
 226     Setting slot to zero in catalog.\n"),
 227                   jcr->VolCatInfo.VolCatName, jcr->VolCatInfo.Slot);
 228                jcr->VolCatInfo.Slot = 0; /* invalidate slot */
 229                Dmsg0(200, "update vol info in mount\n");
 230                dir_update_volume_info(jcr, &jcr->VolCatInfo, 1);  /* set slot */
 231             }
 232             Dmsg0(100, "Default\n");
 233             goto mount_next_vol;
 234       }
 235       break;
 236    }
 237
 238    /*
 239     * See if we have a fresh tape or tape with data.
 240     *
 241     * Note, if the LabelType is PRE_LABEL, it was labeled
 242     *  but never written. If so, rewrite the label but set as
 243     *  VOL_LABEL.  We rewind and return the label (reconstructed)
 244     *  in the block so that in the case of a new tape, data can
 245     *  be appended just after the block label.  If we are writing
 246     *  an second volume, the calling routine will write the label
 247     *  before writing the overflow block.
 248     *
 249     *  If the tape is marked as Recycle, we rewrite the label.
 250     */
 251    if (dev->VolHdr.LabelType == PRE_LABEL || recycle) {
 252       Dmsg1(190, "ready_for_append found freshly labeled volume. dev=%x\n", dev);
 253       dev->VolHdr.LabelType = VOL_LABEL; /* set Volume label */
 254       write_volume_label_to_block(jcr, dev, block);
 255       /*
 256        * If we are not dealing with a streaming device,
 257        *  write the block now to ensure we have write permission.
 258        *  It is better to find out now rather than later.
 259        */
 260       if (!dev_cap(dev, CAP_STREAM)) {
 261          dev->VolCatInfo.VolCatBytes = 0;
 262          if (!rewind_dev(dev)) {
 263             Jmsg2(jcr, M_WARNING, 0, _("Rewind error on device %s. ERR=%s\n"),
 264                   dev_name(dev), strerror_dev(dev));
 265          }
 266          if (recycle) {
 267             if (!truncate_dev(dev)) {
 268                Jmsg2(jcr, M_WARNING, 0, _("Truncate error on device %s. ERR=%s\n"),
 269                      dev_name(dev), strerror_dev(dev));
 270             }
 271          }
 272          /* Attempt write to check write permission */
 273          if (!write_block_to_dev(jcr, dev, block)) {
 274             Jmsg2(jcr, M_ERROR, 0, _("Unable to write device %s. ERR=%s\n"),
 275                dev_name(dev), strerror_dev(dev));
 276             goto mount_next_vol;
 277          }
 278          if (!rewind_dev(dev)) {
 279             Jmsg2(jcr, M_ERROR, 0, _("Unable to rewind device %s. ERR=%s\n"),
 280                dev_name(dev), strerror_dev(dev));
 281             goto mount_next_vol;
 282          }
 283
 284          /* Recreate a correct volume label and return it in the block */
 285          write_volume_label_to_block(jcr, dev, block);
 286       }
 287       /* Set or reset Volume statistics */
 288       dev->VolCatInfo.VolCatJobs = 0;
 289       dev->VolCatInfo.VolCatFiles = 0;
 290       dev->VolCatInfo.VolCatErrors = 0;
 291       dev->VolCatInfo.VolCatBlocks = 0;
 292       if (recycle) {
 293          dev->VolCatInfo.VolCatMounts++;
 294          dev->VolCatInfo.VolCatRecycles++;
 295       } else {
 296          dev->VolCatInfo.VolCatMounts = 1;
 297          dev->VolCatInfo.VolCatRecycles = 0;
 298          dev->VolCatInfo.VolCatWrites = 1;
 299          dev->VolCatInfo.VolCatReads = 1;
 300       }
 301       strcpy(dev->VolCatInfo.VolCatStatus, "Append");
 302       Dmsg0(200, "dir_update_vol_info. Set Append\n");
 303       dir_update_volume_info(jcr, &dev->VolCatInfo, 1);  /* indicate doing relabel */
 304       if (recycle) {
 305          Jmsg(jcr, M_INFO, 0, _("Recycled volume %s on device %s, all previous data lost.\n"),
 306             jcr->VolumeName, dev_name(dev));
 307       } else {
 308          Jmsg(jcr, M_INFO, 0, _("Wrote label to prelabeled Volume %s on device %s\n"),
 309             jcr->VolumeName, dev_name(dev));
 310       }
 311
 312    } else {
 313       /*
 314        * OK, at this point, we have a valid Bacula label, but
 315        * we need to position to the end of the volume, since we are
 316        * just now putting it into append mode.
 317        */
 318       Dmsg0(200, "Device previously written, moving to end of data\n");
 319       Jmsg(jcr, M_INFO, 0, _("Volume %s previously written, moving to end of data.\n"),
 320          jcr->VolumeName);
 321       if (!eod_dev(dev)) {
 322          Jmsg(jcr, M_ERROR, 0, _("Unable to position to end of data %s. ERR=%s\n"),
 323             dev_name(dev), strerror_dev(dev));
 324          Jmsg(jcr, M_INFO, 0, _("Marking Volume %s in Error in Catalog.\n"),
 325             jcr->VolumeName);
 326          strcpy(dev->VolCatInfo.VolCatStatus, "Error");
 327          Dmsg0(200, "dir_update_vol_info. Set Error.\n");
 328          dir_update_volume_info(jcr, &dev->VolCatInfo, 0);
 329          goto mount_next_vol;
 330       }
 331       /* *****FIXME**** we should do some checking for files too */
 332       if (dev_is_tape(dev)) {
 333          /*
 334           * Check if we are positioned on the tape at the same place
 335           * that the database says we should be.
 336           */
 337          if (dev->VolCatInfo.VolCatFiles == dev_file(dev)) {
 338             Jmsg(jcr, M_INFO, 0, _("Ready to append to end of Volume at file=%d.\n"),
 339                  dev_file(dev));
 340          } else {
 341             Jmsg(jcr, M_ERROR, 0, _("I canot write on this volume because:\n\
 342 The number of files mismatch! Volume=%d Catalog=%d\n"),
 343                  dev_file(dev), dev->VolCatInfo.VolCatFiles);
 344             strcpy(dev->VolCatInfo.VolCatStatus, "Error");
 345             Dmsg0(200, "dir_update_vol_info. Set Error.\n");
 346             dir_update_volume_info(jcr, &dev->VolCatInfo, 0);
 347             goto mount_next_vol;
 348          }
 349       }
 350       dev->VolCatInfo.VolCatMounts++;      /* Update mounts */
 351       Dmsg1(200, "update volinfo mounts=%d\n", dev->VolCatInfo.VolCatMounts);
 352       dir_update_volume_info(jcr, &dev->VolCatInfo, 0);
 353       /* Return an empty block */
 354       empty_block(block);             /* we used it for reading so set for write */
 355    }
 356    dev->state |= ST_APPEND;
 357    Dmsg0(100, "Normal return from read_dev_for_append\n");
 358    return 1;
 359 }
 360
 361
 362 int mount_next_read_volume(JCR *jcr, DEVICE *dev, DEV_BLOCK *block)
 363 {
 364    Dmsg2(90, "NumVolumes=%d CurVolume=%d\n", jcr->NumVolumes, jcr->CurVolume);
 365    /*
 366     * End Of Tape -- mount next Volume (if another specified)
 367     */
 368    if (jcr->NumVolumes > 1 && jcr->CurVolume < jcr->NumVolumes) {
 369       close_dev(dev);
 370       dev->state &= ~ST_READ;
 371       if (!acquire_device_for_read(jcr, dev, block)) {
 372          Emsg2(M_FATAL, 0, "Cannot open Dev=%s, Vol=%s\n", dev_name(dev),
 373                jcr->VolumeName);
 374          return 0;
 375       }
 376       return 1;                       /* next volume mounted */
 377    }
 378    Dmsg0(90, "End of Device reached.\n");
 379    return 0;
 380 }
 381
 382 /*
 383  * Called here to do an autoload using the autochanger, if
 384  *  configured, and if a Slot has been defined for this Volume.
 385  *  On success this routine loads the indicated tape, but the
 386  *  label is not read, so it must be verified.
 387  *
 388  *  Note if dir is not NULL, it is the console requesting the
 389  *   autoload for labeling, so we respond directly to the
 390  *   dir bsock.
 391  *
 392  *  Returns: 1 on success
 393  *           0 on failure
 394  */
 395 int autoload_device(JCR *jcr, DEVICE *dev, int writing, BSOCK *dir)
 396 {
 397    int slot = jcr->VolCatInfo.Slot;
 398    int rtn_stat = 0;
 399
 400    /*
 401     * Handle autoloaders here.  If we cannot autoload it, we
 402     *  will return FALSE to ask the sysop.
 403     */
 404    if (writing && dev_cap(dev, CAP_AUTOCHANGER) && slot <= 0) {
 405       if (dir) {
 406          return 0;                    /* For user, bail out right now */
 407       }
 408       if (dir_find_next_appendable_volume(jcr)) {
 409          slot = jcr->VolCatInfo.Slot;
 410       }
 411    }
 412    Dmsg1(100, "Want changer slot=%d\n", slot);
 413
 414    if (slot > 0 && jcr->device->changer_name && jcr->device->changer_command) {
 415       uint32_t timeout = jcr->device->max_changer_wait;
 416       POOLMEM *changer, *results;
 417       int status, loaded;
 418
 419       results = get_pool_memory(PM_MESSAGE);
 420       changer = get_pool_memory(PM_FNAME);
 421
 422       /* Find out what is loaded, zero means device is unloaded */
 423       changer = edit_device_codes(jcr, changer, jcr->device->changer_command,
 424                    "loaded");
 425       status = run_program(changer, timeout, results);
 426       Dmsg3(100, "run_prog: %s stat=%d result=%s\n", changer, status, results);
 427       if (status == 0) {
 428          loaded = atoi(results);
 429       } else {
 430          loaded = -1;              /* force unload */
 431       }
 432       Dmsg1(100, "loaded=%s\n", results);
 433
 434       /* If bad status or tape we want is not loaded, load it. */
 435       if (status != 0 || loaded != slot) {
 436          if (dev_cap(dev, CAP_OFFLINEUNMOUNT)) {
 437             offline_dev(dev);
 438          }
 439          /* We are going to load a new tape, so close the device */
 440          force_close_dev(dev);
 441          if (loaded != 0) {        /* must unload drive */
 442             Dmsg0(100, "Doing changer unload.\n");
 443             if (dir) {
 444                bnet_fsend(dir, _("3902 Issuing autochanger \"unload\" command.\n"));
 445             } else {
 446                Jmsg(jcr, M_INFO, 0, _("Issuing autochanger \"unload\" command.\n"));
 447             }
 448             changer = edit_device_codes(jcr, changer,
 449                         jcr->device->changer_command, "unload");
 450             status = run_program(changer, timeout, NULL);
 451             Dmsg1(100, "unload status=%d\n", status);
 452          }
 453          /*
 454           * Load the desired cassette
 455           */
 456          Dmsg1(100, "Doing changer load slot %d\n", slot);
 457          if (dir) {
 458             bnet_fsend(dir, _("3903 Issuing autochanger \"load slot %d\" command.\n"),
 459                slot);
 460          } else {
 461             Jmsg(jcr, M_INFO, 0, _("Issuing autochanger \"load slot %d\" command.\n"),
 462                slot);
 463          }
 464          changer = edit_device_codes(jcr, changer,
 465                       jcr->device->changer_command, "load");
 466          status = run_program(changer, timeout, NULL);
 467          if (status == 0) {
 468             Jmsg(jcr, M_INFO, 0, _("Autochanger \"load slot\" status is OK.\n"));
 469          } else {
 470             Jmsg(jcr, M_INFO, 0, _("Bad autochanger \"load slot\" status = %d.\n"),
 471                status);
 472          }
 473          Dmsg2(100, "load slot %d status=%d\n", slot, status);
 474       }
 475       free_pool_memory(changer);
 476       free_pool_memory(results);
 477       Dmsg1(100, "After changer, status=%d\n", status);
 478       if (status == 0) {           /* did we succeed? */
 479          rtn_stat = 1;             /* tape loaded by changer */
 480       }
 481    }
 482    return rtn_stat;
 483 }
 484
 485
 486
 487 /*
 488  * Edit codes into ChangerCommand
 489  *  %% = %
 490  *  %a = archive device name
 491  *  %c = changer device name
 492  *  %f = Client's name
 493  *  %j = Job name
 494  *  %o = command
 495  *  %s = Slot base 0
 496  *  %S = Slot base 1
 497  *  %v = Volume name
 498  *
 499  *
 500  *  omsg = edited output message
 501  *  imsg = input string containing edit codes (%x)
 502  *  cmd = command string (load, unload, ...)
 503  *
 504  */
 505 static char *edit_device_codes(JCR *jcr, char *omsg, char *imsg, char *cmd)
 506 {
 507    char *p;
 508    const char *str;
 509    char add[20];
 510
 511    *omsg = 0;
 512    Dmsg1(200, "edit_device_codes: %s\n", imsg);
 513    for (p=imsg; *p; p++) {
 514       if (*p == '%') {
 515          switch (*++p) {
 516          case '%':
 517             str = "%";
 518             break;
 519          case 'a':
 520             str = jcr->device->dev->dev_name;
 521             break;
 522          case 'c':
 523             str = NPRT(jcr->device->changer_name);
 524             break;
 525          case 'o':
 526             str = NPRT(cmd);
 527             break;
 528          case 's':
 529             sprintf(add, "%d", jcr->VolCatInfo.Slot - 1);
 530             str = add;
 531             break;
 532          case 'S':
 533             sprintf(add, "%d", jcr->VolCatInfo.Slot);
 534             str = add;
 535             break;
 536          case 'j':                    /* Job name */
 537             str = jcr->Job;
 538             break;
 539          case 'v':
 540             str = NPRT(jcr->VolumeName);
 541             break;
 542          case 'f':
 543             str = NPRT(jcr->client_name);
 544             break;
 545
 546          default:
 547             add[0] = '%';
 548             add[1] = *p;
 549             add[2] = 0;
 550             str = add;
 551             break;
 552          }
 553       } else {
 554          add[0] = *p;
 555          add[1] = 0;
 556          str = add;
 557       }
 558       Dmsg1(200, "add_str %s\n", str);
 559       pm_strcat(&omsg, (char *)str);
 560       Dmsg1(200, "omsg=%s\n", omsg);
 561    }
 562    return omsg;
 563 }